VirtualBox

Changeset 63905 in vbox


Ignore:
Timestamp:
Sep 20, 2016 8:31:05 AM (9 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
110782
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
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/vd-cache-backend.h

    r62476 r63905  
    2828
    2929#include <VBox/vd.h>
     30#include <VBox/vd-common.h>
    3031#include <VBox/vd-ifs-internal.h>
    3132
    … …  
    3536typedef struct VDCACHEBACKEND
    3637{
    37     /**
    38      * The name of the backend (constant string).
    39      */
    40     const char *pszBackendName;
    41 
    42     /**
    43      * The size of the structure.
    44      */
    45     uint32_t cbSize;
    46 
    47     /**
    48      * The capabilities of the backend.
    49      */
    50     uint64_t uBackendCaps;
     38    /** Structure version. VD_CACHEBACKEND_VERSION defines the current version. */
     39    uint32_t            u32Version;
     40    /** The name of the backend (constant string). */
     41    const char          *pszBackendName;
     42    /** The capabilities of the backend. */
     43    uint64_t            uBackendCaps;
    5144
    5245    /**
    … …  
    6356     * Mandatory if the backend sets VD_CAP_CONFIG.
    6457     */
    65     PCVDCONFIGINFO paConfigInfo;
     58    PCVDCONFIGINFO      paConfigInfo;
    6659
    6760    /**
    … …  
    312305    DECLR3CALLBACKMEMBER(int, pfnComposeName, (PVDINTERFACE pConfig, char **pszName));
    313306
     307    /** Initialization safty marker. */
     308    uint32_t            u32VersionEnd;
     309
    314310} VDCACHEBACKEND;
    315311/** Pointer to VD cache backend. */
    … …  
    318314typedef const VDCACHEBACKEND *PCVDCACHEBACKEND;
    319315
     316/** The current version of the VDCACHEBACKEND structure. */
     317#define VD_CACHEBACKEND_VERSION                 VD_VERSION_MAKE(0xff03, 1, 0)
     318
    320319#endif

  • trunk/include/VBox/vd-filter-backend.h

    r62476 r63905  
    2828
    2929#include <VBox/vd.h>
     30#include <VBox/vd-common.h>
    3031#include <VBox/vd-ifs-internal.h>
    3132
    … …  
    3536typedef struct VDFILTERBACKEND
    3637{
    37     /**
    38      * The name of the backend (constant string).
    39      */
    40     const char *pszBackendName;
    41 
    42     /**
    43      * The size of the structure.
    44      */
    45     uint32_t cbSize;
     38    /** Structure version. VD_FLTBACKEND_VERSION defines the current version. */
     39    uint32_t            u32Version;
     40    /** The name of the backend (constant string). */
     41    const char          *pszBackendName;
    4642
    4743    /**
    … …  
    5147     * Mandatory if the backend sets VD_CAP_CONFIG.
    5248     */
    53     PCVDCONFIGINFO paConfigInfo;
     49    PCVDCONFIGINFO      paConfigInfo;
    5450
    5551    /**
    … …  
    10096                                               PVDIOCTX pIoCtx));
    10197
     98    /** Initialization safty marker. */
     99    uint32_t            u32VersionEnd;
    102100} VDFILTERBACKEND;
    103101/** Pointer to VD filter backend. */
    … …  
    106104typedef const VDFILTERBACKEND *PCVDFILTERBACKEND;
    107105
     106/** The current version of the VDFILTERBACKEND structure. */
     107#define VD_FLTBACKEND_VERSION                   VD_VERSION_MAKE(0xff02, 1, 0)
     108
    108109#endif

  • trunk/include/VBox/vd-image-backend.h

    r63802 r63905  
    2828
    2929#include <VBox/vd.h>
     30#include <VBox/vd-common.h>
    3031#include <VBox/vd-ifs-internal.h>
    3132
    … …  
    6364typedef struct VDIMAGEBACKEND
    6465{
    65     /**
    66      * The name of the backend (constant string).
    67      */
    68     const char *pszBackendName;
    69 
    70     /**
    71      * The size of the structure.
    72      */
    73     uint32_t cbSize;
    74 
    75     /**
    76      * The capabilities of the backend.
    77      */
    78     uint64_t uBackendCaps;
     66    /** Structure version. VD_IMGBACKEND_VERSION defines the current version. */
     67    uint32_t            u32Version;
     68    /** The name of the backend (constant string). */
     69    const char          *pszBackendName;
     70    /** The capabilities of the backend. */
     71    uint64_t            uBackendCaps;
    7972
    8073    /**
    … …  
    8376     * pointer may just contain NULL.
    8477     */
    85     PCVDFILEEXTENSION paFileExtensions;
     78    PCVDFILEEXTENSION   paFileExtensions;
    8679
    8780    /**
    … …  
    9184     * Mandatory if the backend sets VD_CAP_CONFIG.
    9285     */
    93     PCVDCONFIGINFO paConfigInfo;
     86    PCVDCONFIGINFO      paConfigInfo;
    9487
    9588    /**
    … …  
    585578                                                    PVDINTERFACE pVDIfsOperation));
    586579
     580    /** Initialization safty marker. */
     581    uint32_t            u32VersionEnd;
     582
    587583} VDIMAGEBACKEND;
    588584
    … …  
    592588typedef const VDIMAGEBACKEND *PCVDIMAGEBACKEND;
    593589
     590/** The current version of the VDIMAGEBACKEND structure. */
     591#define VD_IMGBACKEND_VERSION                   VD_VERSION_MAKE(0xff01, 1, 0)
     592
    594593/** @copydoc VDIMAGEBACKEND::pfnComposeLocation */
    595594DECLCALLBACK(int) genericFileComposeLocation(PVDINTERFACE pConfig, char **pszLocation);

  • trunk/include/VBox/vd-plugin.h

    r63781 r63905  
    2828
    2929#include <VBox/vd.h>
     30#include <VBox/vd-common.h>
    3031#include <VBox/vd-image-backend.h>
    3132#include <VBox/vd-cache-backend.h>
    … …  
    3738typedef struct VDBACKENDREGISTER
    3839{
     40    /** Interface version.
     41     * This is set to VD_BACKENDREG_CB_VERSION. */
     42    uint32_t                    u32Version;
     43
    3944    /**
    4045     * Registers a new image backend.
    … …  
    6671typedef VDBACKENDREGISTER *PVDBACKENDREGISTER;
    6772
     73/** Current version of the VDBACKENDREGISTER structure.  */
     74#define VD_BACKENDREG_CB_VERSION                VD_VERSION_MAKE(0xff00, 1, 0)
     75
    6876/**
    6977 * Initialization entry point called by the generic VD layer when

  • trunk/src/VBox/Storage/DMG.cpp

    r63802 r63905  
    24062406const VDIMAGEBACKEND g_DmgBackend =
    24072407{
     2408    /* u32Version */
     2409    VD_IMGBACKEND_VERSION,
    24082410    /* pszBackendName */
    24092411    "DMG",
    2410     /* cbSize */
    2411     sizeof(VDIMAGEBACKEND),
    24122412    /* uBackendCaps */
    24132413    VD_CAP_FILE | VD_CAP_VFS,
    … …  
    24992499    NULL,
    25002500    /* pfnTraverseMetadata */
    2501     NULL
     2501    NULL,
     2502    /* u32VersionEnd */
     2503    VD_IMGBACKEND_VERSION
    25022504};
    25032505

  • trunk/src/VBox/Storage/ISCSI.cpp

    r63880 r63905  
    54975497const VDIMAGEBACKEND g_ISCSIBackend =
    54985498{
     5499    /* u32Version */
     5500    VD_IMGBACKEND_VERSION,
    54995501    /* pszBackendName */
    55005502    "iSCSI",
    5501     /* cbSize */
    5502     sizeof(VDIMAGEBACKEND),
    55035503    /* uBackendCaps */
    55045504    VD_CAP_CONFIG | VD_CAP_TCPNET | VD_CAP_ASYNC,
    … …  
    55905590    NULL,
    55915591    /* pfnTraverseMetadata */
    5592     NULL
     5592    NULL,
     5593    /* u32VersionEnd */
     5594    VD_IMGBACKEND_VERSION
    55935595};

  • trunk/src/VBox/Storage/Parallels.cpp

    r63802 r63905  
    10691069const VDIMAGEBACKEND g_ParallelsBackend =
    10701070{
     1071    /* u32Version */
     1072    VD_IMGBACKEND_VERSION,
    10711073    /* pszBackendName */
    10721074    "Parallels",
    1073     /* cbSize */
    1074     sizeof(VDIMAGEBACKEND),
    10751075    /* uBackendCaps */
    10761076    VD_CAP_FILE | VD_CAP_ASYNC | VD_CAP_VFS | VD_CAP_CREATE_DYNAMIC | VD_CAP_DIFF,
    … …  
    11621162    NULL,
    11631163    /* pfnTraverseMetadata */
    1164     NULL
     1164    NULL,
     1165    /* u32VersionEnd */
     1166    VD_IMGBACKEND_VERSION
    11651167};

  • trunk/src/VBox/Storage/QCOW.cpp

    r63802 r63905  
    23172317const VDIMAGEBACKEND g_QCowBackend =
    23182318{
     2319    /* u32Version */
     2320    VD_IMGBACKEND_VERSION,
    23192321    /* pszBackendName */
    23202322    "QCOW",
    2321     /* cbSize */
    2322     sizeof(VDIMAGEBACKEND),
    23232323    /* uBackendCaps */
    23242324    VD_CAP_FILE | VD_CAP_VFS | VD_CAP_CREATE_DYNAMIC | VD_CAP_DIFF | VD_CAP_ASYNC,
    … …  
    24102410    NULL,
    24112411    /* pfnTraverseMetadata */
    2412     NULL
     2412    NULL,
     2413    /* u32VersionEnd */
     2414    VD_IMGBACKEND_VERSION
    24132415};

  • trunk/src/VBox/Storage/QED.cpp

    r63811 r63905  
    23732373const VDIMAGEBACKEND g_QedBackend =
    23742374{
     2375    /* u32Version */
     2376    VD_IMGBACKEND_VERSION,
    23752377    /* pszBackendName */
    23762378    "QED",
    2377     /* cbSize */
    2378     sizeof(VDIMAGEBACKEND),
    23792379    /* uBackendCaps */
    23802380    VD_CAP_FILE | VD_CAP_VFS | VD_CAP_CREATE_DYNAMIC | VD_CAP_DIFF | VD_CAP_ASYNC,
    … …  
    24662466    NULL,
    24672467    /* pfnTraverseMetadata */
    2468     NULL
     2468    NULL,
     2469    /* u32Version */
     2470    VD_IMGBACKEND_VERSION
    24692471};

  • trunk/src/VBox/Storage/RAW.cpp

    r63811 r63905  
    957957const VDIMAGEBACKEND g_RawBackend =
    958958{
     959    /* u32Version */
     960    VD_IMGBACKEND_VERSION,
    959961    /* pszBackendName */
    960962    "RAW",
    961     /* cbSize */
    962     sizeof(VDIMAGEBACKEND),
    963963    /* uBackendCaps */
    964964    VD_CAP_CREATE_FIXED | VD_CAP_FILE | VD_CAP_ASYNC | VD_CAP_VFS,
    … …  
    10501050    NULL,
    10511051    /* pfnTraverseMetadata */
    1052     NULL
     1052    NULL,
     1053    /* u32VersionEnd */
     1054    VD_IMGBACKEND_VERSION
    10531055};

  • trunk/src/VBox/Storage/VCICache.cpp

    r63567 r63905  
    19831983const VDCACHEBACKEND g_VciCacheBackend =
    19841984{
     1985    /* u32Version */
     1986    VD_CACHEBACKEND_VERSION,
    19851987    /* pszBackendName */
    19861988    "vci",
    1987     /* cbSize */
    1988     sizeof(VDCACHEBACKEND),
    19891989    /* uBackendCaps */
    19901990    VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC | VD_CAP_FILE | VD_CAP_VFS,
    … …  
    20382038    NULL,
    20392039    /* pfnComposeName */
    2040     NULL
     2040    NULL,
     2041    /* u32VersionEnd */
     2042    VD_CACHEBACKEND_VERSION
    20412043};
    20422044

  • trunk/src/VBox/Storage/VD.cpp

    r63830 r63905  
    35473547    int rc = VINF_SUCCESS;
    35483548
    3549     if (pBackend->cbSize == sizeof(VDIMAGEBACKEND))
     3549    if (VD_VERSION_ARE_COMPATIBLE(VD_IMGBACKEND_VERSION, pBackend->u32Version))
    35503550        vdAddBackend((RTLDRMOD)pvUser, pBackend);
    35513551    else
    35523552    {
    3553         LogFunc(("ignored plugin: pBackend->cbSize=%d rc=%Rrc\n", pBackend->cbSize, rc));
     3553        LogFunc(("ignored plugin: pBackend->u32Version=%u rc=%Rrc\n", pBackend->u32Version, rc));
    35543554        rc = VERR_IGNORED;
    35553555    }
    … …  
    35653565    int rc = VINF_SUCCESS;
    35663566
    3567     if (pBackend->cbSize == sizeof(VDCACHEBACKEND))
     3567    if (VD_VERSION_ARE_COMPATIBLE(VD_CACHEBACKEND_VERSION, pBackend->u32Version))
    35683568        vdAddCacheBackend((RTLDRMOD)pvUser, pBackend);
    35693569    else
    35703570    {
    3571         LogFunc(("ignored plugin: pBackend->cbSize=%d rc=%Rrc\n", pBackend->cbSize, rc));
     3571        LogFunc(("ignored plugin: pBackend->u32Version=%u rc=%Rrc\n", pBackend->u32Version, rc));
    35723572        rc = VERR_IGNORED;
    35733573    }
    … …  
    35833583    int rc = VINF_SUCCESS;
    35843584
    3585     if (pBackend->cbSize == sizeof(VDFILTERBACKEND))
     3585    if (VD_VERSION_ARE_COMPATIBLE(VD_FLTBACKEND_VERSION, pBackend->u32Version))
    35863586        vdAddFilterBackend((RTLDRMOD)pvUser, pBackend);
    35873587    else
    35883588    {
    3589         LogFunc(("ignored plugin: pBackend->cbSize=%d rc=%Rrc\n", pBackend->cbSize, rc));
     3589        LogFunc(("ignored plugin: pBackend->u32Version=%u rc=%Rrc\n", pBackend->u32Version, rc));
    35903590        rc = VERR_IGNORED;
    35913591    }
    … …  
    37203720        PFNVDPLUGINLOAD pfnVDPluginLoad = NULL;
    37213721
     3722        BackendRegister.u32Version        = VD_BACKENDREG_CB_VERSION;
    37223723        BackendRegister.pfnRegisterImage  = vdPluginRegisterImage;
    37233724        BackendRegister.pfnRegisterCache  = vdPluginRegisterCache;

  • trunk/src/VBox/Storage/VDI.cpp

    r63887 r63905  
    30003000const VDIMAGEBACKEND g_VDIBackend =
    30013001{
     3002    /* u32Version */
     3003    VD_IMGBACKEND_VERSION,
    30023004    /* pszBackendName */
    30033005    "VDI",
    3004     /* cbSize */
    3005     sizeof(VDIMAGEBACKEND),
    30063006    /* uBackendCaps */
    30073007      VD_CAP_UUID | VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC
    … …  
    30953095    vdiRepair,
    30963096    /* pfnTraverseMetadata */
    3097     NULL
     3097    NULL,
     3098    /* u32VersionEnd */
     3099    VD_IMGBACKEND_VERSION
    30983100};

  • trunk/src/VBox/Storage/VHD.cpp

    r63811 r63905  
    30113011const VDIMAGEBACKEND g_VhdBackend =
    30123012{
     3013    /* u32Version */
     3014    VD_IMGBACKEND_VERSION,
    30133015    /* pszBackendName */
    30143016    "VHD",
    3015     /* cbSize */
    3016     sizeof(VDIMAGEBACKEND),
    30173017    /* uBackendCaps */
    30183018    VD_CAP_UUID | VD_CAP_DIFF | VD_CAP_FILE |
    … …  
    31063106    vhdRepair,
    31073107    /* pfnTraverseMetadata */
    3108     NULL
     3108    NULL,
     3109    /* u32VersionEnd */
     3110    VD_IMGBACKEND_VERSION
    31093111};

  • trunk/src/VBox/Storage/VHDX.cpp

    r63802 r63905  
    24892489const VDIMAGEBACKEND g_VhdxBackend =
    24902490{
     2491    /* u32Version */
     2492    VD_IMGBACKEND_VERSION,
    24912493    /* pszBackendName */
    24922494    "VHDX",
    2493     /* cbSize */
    2494     sizeof(VDIMAGEBACKEND),
    24952495    /* uBackendCaps */
    24962496    VD_CAP_FILE | VD_CAP_VFS,
    … …  
    25822582    NULL,
    25832583    /* pfnTraverseMetadata */
    2584     NULL
     2584    NULL,
     2585    /* u32VersionEnd */
     2586    VD_IMGBACKEND_VERSION
    25852587};

  • trunk/src/VBox/Storage/VMDK.cpp

    r63840 r63905  
    63476347const VDIMAGEBACKEND g_VmdkBackend =
    63486348{
     6349    /* u32Version */
     6350    VD_IMGBACKEND_VERSION,
    63496351    /* pszBackendName */
    63506352    "VMDK",
    6351     /* cbSize */
    6352     sizeof(VDIMAGEBACKEND),
    63536353    /* uBackendCaps */
    63546354      VD_CAP_UUID | VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC
    … …  
    64426442    NULL,
    64436443    /* pfnTraverseMetadata */
    6444     NULL
     6444    NULL,
     6445    /* u32VersionEnd */
     6446    VD_IMGBACKEND_VERSION
    64456447};
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette