VirtualBox

source: vbox/trunk/include/VBox/vd-filter-backend.h@ 93115

Last change on this file since 93115 was 93115, checked in by vboxsync, 3 years ago

scm --update-copyright-year

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.3 KB
Line 
1/** @file
2 * Internal VD filter backend interface.
3 */
4
5/*
6 * Copyright (C) 2014-2022 Oracle Corporation
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
26#ifndef VBOX_INCLUDED_vd_filter_backend_h
27#define VBOX_INCLUDED_vd_filter_backend_h
28#ifndef RT_WITHOUT_PRAGMA_ONCE
29# pragma once
30#endif
31
32#include <VBox/vd.h>
33#include <VBox/vd-common.h>
34#include <VBox/vd-ifs-internal.h>
35
36/**
37 * VD filter backend interface.
38 */
39typedef struct VDFILTERBACKEND
40{
41 /** Structure version. VD_FLTBACKEND_VERSION defines the current version. */
42 uint32_t u32Version;
43 /** The name of the backend (constant string). */
44 const char *pszBackendName;
45
46 /**
47 * Pointer to an array of structs describing each supported config key.
48 * Terminated by a NULL config key. Note that some backends do not support
49 * the configuration interface, so this pointer may just contain NULL.
50 * Mandatory if the backend sets VD_CAP_CONFIG.
51 */
52 PCVDCONFIGINFO paConfigInfo;
53
54 /**
55 * Creates a new filter instance.
56 *
57 * @returns VBox status code.
58 * @param pVDIfsDisk Pointer to the per-disk VD interface list.
59 * @param fFlags Subset of VD_FILTER_FLAGS_*.
60 * @param pVDIfsFilter Pointer to the per-filter VD interface list.
61 * @param ppvBackendData Opaque state data for this filter instance.
62 */
63 DECLR3CALLBACKMEMBER(int, pfnCreate, (PVDINTERFACE pVDIfsDisk, uint32_t fFlags,
64 PVDINTERFACE pVDIfsFilter,
65 void **ppvBackendData));
66
67 /**
68 * Destroys a filter instance.
69 *
70 * @returns VBox status code.
71 * @param pvBackendData Opaque state data for the filter instance to destroy.
72 */
73 DECLR3CALLBACKMEMBER(int, pfnDestroy, (void *pvBackendData));
74
75 /**
76 * Filters the data of a read from the image chain. The filter is applied
77 * after everything was read.
78 *
79 * @returns VBox status code.
80 * @param pvBackendData Opaque state data for the filter instance.
81 * @param uOffset Start offset of the read.
82 * @param cbRead Number of bytes read.
83 * @param pIoCtx The I/O context holding the read data.
84 */
85 DECLR3CALLBACKMEMBER(int, pfnFilterRead, (void *pvBackendData, uint64_t uOffset, size_t cbRead,
86 PVDIOCTX pIoCtx));
87
88 /**
89 * Filters the data of a write to the image chain. The filter is applied
90 * before everything is written.
91 *
92 * @returns VBox status code.
93 * @param pvBackendData Opaque state data for the filter instance.
94 * @param uOffset Start offset of the write.
95 * @param cbWrite Number of bytes to be written.
96 * @param pIoCtx The I/O context holding the data to write.
97 */
98 DECLR3CALLBACKMEMBER(int, pfnFilterWrite, (void *pvBackendData, uint64_t uOffset, size_t cbWrite,
99 PVDIOCTX pIoCtx));
100
101 /** Initialization safty marker. */
102 uint32_t u32VersionEnd;
103} VDFILTERBACKEND;
104/** Pointer to VD filter backend. */
105typedef VDFILTERBACKEND *PVDFILTERBACKEND;
106/** Constant pointer to a VD filter backend. */
107typedef const VDFILTERBACKEND *PCVDFILTERBACKEND;
108
109/** The current version of the VDFILTERBACKEND structure. */
110#define VD_FLTBACKEND_VERSION VD_VERSION_MAKE(0xff02, 1, 0)
111
112#endif /* !VBOX_INCLUDED_vd_filter_backend_h */
Note: See TracBrowser for help on using the repository browser.

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