[50989] | 1 | /** @file
|
---|
| 2 | * VD: Plugin support API.
|
---|
| 3 | */
|
---|
| 4 |
|
---|
| 5 | /*
|
---|
[69107] | 6 | * Copyright (C) 2006-2017 Oracle Corporation
|
---|
[50989] | 7 | *
|
---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
| 11 | * General Public License (GPL) as published by the Free Software
|
---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
| 15 | *
|
---|
| 16 | * The contents of this file may alternatively be used under the terms
|
---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
---|
| 21 | *
|
---|
| 22 | * You may elect to license modified versions of this file under the
|
---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
| 24 | */
|
---|
| 25 |
|
---|
[63912] | 26 | #ifndef ___VBox_vd_plugin_h
|
---|
| 27 | #define ___VBox_vd_plugin_h
|
---|
[50989] | 28 |
|
---|
| 29 | #include <VBox/vd.h>
|
---|
[63905] | 30 | #include <VBox/vd-common.h>
|
---|
[50989] | 31 | #include <VBox/vd-image-backend.h>
|
---|
| 32 | #include <VBox/vd-cache-backend.h>
|
---|
[50992] | 33 | #include <VBox/vd-filter-backend.h>
|
---|
[50989] | 34 |
|
---|
| 35 | /**
|
---|
| 36 | * Backend register callbacks structure.
|
---|
| 37 | */
|
---|
| 38 | typedef struct VDBACKENDREGISTER
|
---|
| 39 | {
|
---|
[63905] | 40 | /** Interface version.
|
---|
| 41 | * This is set to VD_BACKENDREG_CB_VERSION. */
|
---|
| 42 | uint32_t u32Version;
|
---|
| 43 |
|
---|
[50989] | 44 | /**
|
---|
| 45 | * Registers a new image backend.
|
---|
| 46 | *
|
---|
| 47 | * @returns VBox status code.
|
---|
| 48 | * @param pvUser Opaque user data given in the plugin load callback.
|
---|
| 49 | * @param pBackend The image backend to register.
|
---|
| 50 | */
|
---|
[63781] | 51 | DECLR3CALLBACKMEMBER(int, pfnRegisterImage, (void *pvUser, PCVDIMAGEBACKEND pBackend));
|
---|
[50989] | 52 |
|
---|
| 53 | /**
|
---|
| 54 | * Registers a new cache backend.
|
---|
| 55 | *
|
---|
| 56 | * @returns VBox status code.
|
---|
| 57 | * @param pvUser Opaque user data given in the plugin load callback.
|
---|
| 58 | * @param pBackend The cache backend to register.
|
---|
| 59 | */
|
---|
| 60 | DECLR3CALLBACKMEMBER(int, pfnRegisterCache, (void *pvUser, PCVDCACHEBACKEND pBackend));
|
---|
| 61 |
|
---|
| 62 | /**
|
---|
[50992] | 63 | * Registers a new filter plugin.
|
---|
| 64 | * @param pvUser Opaque user data given in the plugin load callback.
|
---|
| 65 | * @param pBackend The filter backend to register.
|
---|
[50989] | 66 | */
|
---|
[50992] | 67 | DECLR3CALLBACKMEMBER(int, pfnRegisterFilter, (void *pvUser, PCVDFILTERBACKEND pBackend));
|
---|
[50989] | 68 |
|
---|
| 69 | } VDBACKENDREGISTER;
|
---|
| 70 | /** Pointer to a backend register callbacks structure. */
|
---|
| 71 | typedef VDBACKENDREGISTER *PVDBACKENDREGISTER;
|
---|
| 72 |
|
---|
[63905] | 73 | /** Current version of the VDBACKENDREGISTER structure. */
|
---|
| 74 | #define VD_BACKENDREG_CB_VERSION VD_VERSION_MAKE(0xff00, 1, 0)
|
---|
| 75 |
|
---|
[50989] | 76 | /**
|
---|
| 77 | * Initialization entry point called by the generic VD layer when
|
---|
| 78 | * a plugin is loaded.
|
---|
| 79 | *
|
---|
| 80 | * @returns VBox status code.
|
---|
| 81 | * @param pvUser Opaque user data passed in the register callbacks.
|
---|
| 82 | * @param pRegisterCallbacks Pointer to the register callbacks structure.
|
---|
| 83 | */
|
---|
| 84 | typedef DECLCALLBACK(int) FNVDPLUGINLOAD(void *pvUser, PVDBACKENDREGISTER pRegisterCallbacks);
|
---|
| 85 | typedef FNVDPLUGINLOAD *PFNVDPLUGINLOAD;
|
---|
| 86 | #define VD_PLUGIN_LOAD_NAME "VDPluginLoad"
|
---|
| 87 |
|
---|
| 88 | /** The prefix to identify Storage Plugins. */
|
---|
| 89 | #define VD_PLUGIN_PREFIX "VDPlugin"
|
---|
| 90 | /** The size of the prefix excluding the '\\0' terminator. */
|
---|
| 91 | #define VD_PLUGIN_PREFIX_LENGTH (sizeof(VD_PLUGIN_PREFIX)-1)
|
---|
| 92 |
|
---|
| 93 | #endif
|
---|