675ee1b20dfaa861529fab93257045edfdfb812dvboxsync/** @file
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Internal VD filter backend interface.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync/*
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Copyright (C) 2014 Oracle Corporation
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync *
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * available from http://www.virtualbox.org. This file is free software;
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * General Public License (GPL) as published by the Free Software
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync *
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * The contents of this file may alternatively be used under the terms
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * of the Common Development and Distribution License Version 1.0
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * VirtualBox OSE distribution, in which case the provisions of the
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * CDDL are applicable instead of those of the GPL.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync *
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * You may elect to license modified versions of this file under the
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * terms and conditions of either the GPL or the CDDL or both.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync#ifndef __vd_filter_backend_h__
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync#define __vd_filter_backend_h__
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync#include <VBox/vd.h>
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync#include <VBox/vd-ifs-internal.h>
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync/**
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * VD filter backend interface.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsynctypedef struct VDFILTERBACKEND
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync{
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync /**
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * The name of the backend (constant string).
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync const char *pszBackendName;
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync /**
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * The size of the structure.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync uint32_t cbSize;
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync /**
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Pointer to an array of structs describing each supported config key.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Terminated by a NULL config key. Note that some backends do not support
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * the configuration interface, so this pointer may just contain NULL.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Mandatory if the backend sets VD_CAP_CONFIG.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync PCVDCONFIGINFO paConfigInfo;
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync /**
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Creates a new filter instance.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync *
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @returns VBox status code.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param pVDIfsDisk Pointer to the per-disk VD interface list.
01ada958d2e36535af7048aadda8c0b4a8942f60vboxsync * @param fFlags Subset of VD_FILTER_FLAGS_*.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param pVDIfsFilter Pointer to the per-filter VD interface list.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param ppvBackendData Opaque state data for this filter instance.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
01ada958d2e36535af7048aadda8c0b4a8942f60vboxsync DECLR3CALLBACKMEMBER(int, pfnCreate, (PVDINTERFACE pVDIfsDisk, uint32_t fFlags,
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync PVDINTERFACE pVDIfsFilter,
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync void **ppvBackendData));
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync /**
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Destroys a filter instance.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync *
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @returns VBox status code.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param pvBackendData Opaque state data for the filter instance to destroy.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync DECLR3CALLBACKMEMBER(int, pfnDestroy, (void *pvBackendData));
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync /**
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Filters the data of a read from the image chain. The filter is applied
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * after everything was read.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync *
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @returns VBox status code.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param pvBackendData Opaque state data for the filter instance.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param uOffset Start offset of the read.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param cbRead Number of bytes read.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param pIoCtx The I/O context holding the read data.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync DECLR3CALLBACKMEMBER(int, pfnFilterRead, (void *pvBackendData, uint64_t uOffset, size_t cbRead,
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync PVDIOCTX pIoCtx));
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync /**
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * Filters the data of a write to the image chain. The filter is applied
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * before everything is written.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync *
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @returns VBox status code.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param pvBackendData Opaque state data for the filter instance.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param uOffset Start offset of the write.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param cbWrite Number of bytes to be written.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync * @param pIoCtx The I/O context holding the data to write.
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync DECLR3CALLBACKMEMBER(int, pfnFilterWrite, (void *pvBackendData, uint64_t uOffset, size_t cbWrite,
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync PVDIOCTX pIoCtx));
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync} VDFILTERBACKEND;
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync/** Pointer to VD filter backend. */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsynctypedef VDFILTERBACKEND *PVDFILTERBACKEND;
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync/** Constant pointer to a VD filter backend. */
675ee1b20dfaa861529fab93257045edfdfb812dvboxsynctypedef const VDFILTERBACKEND *PCVDFILTERBACKEND;
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync
675ee1b20dfaa861529fab93257045edfdfb812dvboxsync#endif