0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * PDM - Pluggable Device Manager, Block cache.
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2007-2011 Oracle Corporation
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * available from http://www.virtualbox.org. This file is free software;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * you can redistribute it and/or modify it under the terms of the GNU
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * General Public License (GPL) as published by the Free Software
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The contents of this file may alternatively be used under the terms
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * of the Common Development and Distribution License Version 1.0
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VirtualBox OSE distribution, in which case the provisions of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * CDDL are applicable instead of those of the GPL.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * You may elect to license modified versions of this file under the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * terms and conditions of either the GPL or the CDDL or both.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @defgroup grp_pdm_blk_cache The PDM Block Cache API
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @ingroup grp_pdm
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a PDM block cache. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a PDM block cache pointer. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** I/O transfer handle. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef struct PDMBLKCACHEIOXFER *PPDMBLKCACHEIOXFER;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Block cache I/O request transfer direction.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** Read */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** Write */
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync /** Flush */
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync /** Discard */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Completion callback for drivers.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pDrvIns The driver instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser User argument given during request initiation.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param rc The status code of the completed request.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEDRV(PPDMDRVINS pDrvIns, void *pvUser, int rc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a FNPDMBLKCACHEXFERCOMPLETEDRV(). */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef FNPDMBLKCACHEXFERCOMPLETEDRV *PFNPDMBLKCACHEXFERCOMPLETEDRV;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * I/O enqueue callback for drivers.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pDrvIns The driver instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser User argument given during request initiation.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param rc The status code of the completed request.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDRV(PPDMDRVINS pDrvIns,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDRV(). */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef FNPDMBLKCACHEXFERENQUEUEDRV *PFNPDMBLKCACHEXFERENQUEUEDRV;
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * Discard enqueue callback for drivers.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pDrvIns The driver instance.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param paRanges Ranges to discard.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param cRanges Number of range entries.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param hIoXfer I/O handle to return on completion.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsynctypedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDDRV(PPDMDRVINS pDrvIns,
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDISCARDDRV(). */
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsynctypedef FNPDMBLKCACHEXFERENQUEUEDISCARDDRV *PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV;
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * Completion callback for devices.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pDrvIns The device instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser User argument given during request initiation.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param rc The status code of the completed request.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEDEV(PPDMDEVINS pDevIns, void *pvUser, int rc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a FNPDMBLKCACHEXFERCOMPLETEDEV(). */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef FNPDMBLKCACHEXFERCOMPLETEDEV *PFNPDMBLKCACHEXFERCOMPLETEDEV;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * I/O enqueue callback for devices.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pDevIns The device instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser User argument given during request initiation.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param rc The status code of the completed request.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDEV(PPDMDEVINS pDevIns,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDEV(). */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef FNPDMBLKCACHEXFERENQUEUEDEV *PFNPDMBLKCACHEXFERENQUEUEDEV;
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * Discard enqueue callback for devices.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pDrvIns The driver instance.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param paRanges Ranges to discard.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param cRanges Number of range entries.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param hIoXfer I/O handle to return on completion.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsynctypedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDDEV(PPDMDEVINS pDevIns,
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDISCARDDEV(). */
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsynctypedef FNPDMBLKCACHEXFERENQUEUEDISCARDDEV *PFNPDMBLKCACHEXFERENQUEUEDISCARDDEV;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Completion callback for drivers.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pDrvIns The driver instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser User argument given during request initiation.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param rc The status code of the completed request.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEINT(void *pvUserInt, void *pvUser, int rc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a FNPDMBLKCACHEXFERCOMPLETEINT(). */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef FNPDMBLKCACHEXFERCOMPLETEINT *PFNPDMBLKCACHEXFERCOMPLETEINT;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * I/O enqueue callback for drivers.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pDrvIns The driver instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser User argument given during request initiation.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param rc The status code of the completed request.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEINT(void *pvUser,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a FNPDMBLKCACHEXFERENQUEUEINT(). */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef FNPDMBLKCACHEXFERENQUEUEINT *PFNPDMBLKCACHEXFERENQUEUEINT;
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * Discard enqueue callback for VMM internal users.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pDrvIns The driver instance.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param paRanges Ranges to discard.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param cRanges Number of range entries.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param hIoXfer I/O handle to return on completion.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsynctypedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDINT(void *pvUser,
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDISCARDINT(). */
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsynctypedef FNPDMBLKCACHEXFERENQUEUEDISCARDINT *PFNPDMBLKCACHEXFERENQUEUEDISCARDINT;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Completion callback for USB.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pDrvIns The driver instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser User argument given during request initiation.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param rc The status code of the completed request.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEUSB(PPDMUSBINS pUsbIns, void *pvUser, int rc);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a FNPDMBLKCACHEXFERCOMPLETEUSB(). */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef FNPDMBLKCACHEXFERCOMPLETEUSB *PFNPDMBLKCACHEXFERCOMPLETEUSB;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * I/O enqueue callback for drivers.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pDrvIns The driver instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser User argument given during request initiation.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param rc The status code of the completed request.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEUSB(PPDMUSBINS pUsbIns,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a FNPDMBLKCACHEXFERENQUEUEUSB(). */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef FNPDMBLKCACHEXFERENQUEUEUSB *PFNPDMBLKCACHEXFERENQUEUEUSB;
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * Discard enqueue callback for USB devices.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pUsbIns The USB device instance.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param paRanges Ranges to discard.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param cRanges Number of range entries.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param hIoXfer I/O handle to return on completion.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsynctypedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDISCARDUSB(PPDMUSBINS pUsbIns,
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync/** Pointer to a FNPDMBLKCACHEXFERENQUEUEDISCARDUSB(). */
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsynctypedef FNPDMBLKCACHEXFERENQUEUEDISCARDUSB *PFNPDMBLKCACHEXFERENQUEUEDISCARDUSB;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Create a block cache user for a driver instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pVM Pointer to the shared VM structure.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pDrvIns The driver instance.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param ppBlkCache Where to store the handle to the block cache.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferComplete The I/O transfer complete callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferEnqueue The I/O request enqueue callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferEnqueueDiscard The discard request enqueue callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pcszId Unique ID used to identify the user.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) PDMR3BlkCacheRetainDriver(PVM pVM, PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync const char *pcszId);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Create a block cache user for a device instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pVM Pointer to the shared VM structure.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pDevIns The device instance.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param ppBlkCache Where to store the handle to the block cache.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferComplete The I/O transfer complete callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferEnqueue The I/O request enqueue callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferEnqueueDiscard The discard request enqueue callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pcszId Unique ID used to identify the user.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) PDMR3BlkCacheRetainDevice(PVM pVM, PPDMDEVINS pDevIns, PPPDMBLKCACHE ppBlkCache,
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync PFNPDMBLKCACHEXFERENQUEUEDISCARDDEV pfnXferEnqueueDiscard,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync const char *pcszId);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Create a block cache user for a USB instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pVM Pointer to the shared VM structure.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pUsbIns The USB device instance.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param ppBlkCache Where to store the handle to the block cache.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferComplete The I/O transfer complete callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferEnqueue The I/O request enqueue callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferEnqueueDiscard The discard request enqueue callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pcszId Unique ID used to identify the user.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) PDMR3BlkCacheRetainUsb(PVM pVM, PPDMUSBINS pUsbIns, PPPDMBLKCACHE ppBlkCache,
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync PFNPDMBLKCACHEXFERENQUEUEDISCARDUSB pfnXferEnqueueDiscard,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync const char *pcszId);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Create a block cache user for internal use by VMM.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pVM Pointer to the shared VM structure.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pvUser Opaque user data.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param ppBlkCache Where to store the handle to the block cache.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferComplete The I/O transfer complete callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferEnqueue The I/O request enqueue callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pfnXferEnqueueDiscard The discard request enqueue callback.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pcszId Unique ID used to identify the user.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) PDMR3BlkCacheRetainInt(PVM pVM, void *pvUser, PPPDMBLKCACHE ppBlkCache,
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync PFNPDMBLKCACHEXFERENQUEUEDISCARDINT pfnXferEnqueueDiscard,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync const char *pcszId);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Releases a block cache handle.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns nothing.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pBlkCache Block cache handle.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void) PDMR3BlkCacheRelease(PPDMBLKCACHE pBlkCache);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Releases all block cache handles for a device instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns nothing.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pVM Pointer to the shared VM structure.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pDevIns The device instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void) PDMR3BlkCacheReleaseDevice(PVM pVM, PPDMDEVINS pDevIns);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Releases all block cache handles for a driver instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns nothing.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pVM Pointer to the shared VM structure.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pDrvIns The driver instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void) PDMR3BlkCacheReleaseDriver(PVM pVM, PPDMDRVINS pDrvIns);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Releases all block cache handles for a USB device instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns nothing.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pVM Pointer to the shared VM structure.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pUsbIns The USB device instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void) PDMR3BlkCacheReleaseUsb(PVM pVM, PPDMUSBINS pUsbIns);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Creates a read task on the given endpoint.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pEndpoint The file endpoint to read from.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param off Where to start reading from.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param paSegments Scatter gather list to store the data in.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cSegments Number of segments in the list.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cbRead The overall number of bytes to read.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser Opaque user data returned in the completion callback
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * upon completion of the read.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) PDMR3BlkCacheRead(PPDMBLKCACHE pBlkCache, uint64_t off,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Creates a write task on the given endpoint.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pEndpoint The file endpoint to write to.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param off Where to start writing at.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param paSegments Scatter gather list of the data to write.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cSegments Number of segments in the list.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cbWrite The overall number of bytes to write.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser Opaque user data returned in the completion callback
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * upon completion of the task.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) PDMR3BlkCacheWrite(PPDMBLKCACHE pBlkCache, uint64_t off,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Creates a flush task on the given endpoint.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pEndpoint The file endpoint to flush.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvUser Opaque user data returned in the completion callback
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * upon completion of the task.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) PDMR3BlkCacheFlush(PPDMBLKCACHE pBlkCache, void *pvUser);
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * Discards the given ranges from the cache.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @returns VBox status code.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pEndpoint The file endpoint to flush.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param paRanges Array of ranges to discard.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param cRanges Number of ranges in the array.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * @param pvUser Opaque user data returned in the completion callback
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsync * upon completion of the task.
7fbf40d9570bf4f3172bb97a0ff13d44a8d5b4c3vboxsyncVMMR3DECL(int) PDMR3BlkCacheDiscard(PPDMBLKCACHE pBlkCache, PCRTRANGE paRanges, unsigned cRanges, void *pvUser);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Notify the cache of a complete I/O transfer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns nothing.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pBlkCache The cache instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param hIoXfer The I/O transfer handle which completed.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param rcIoXfer The status code of the completed request.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(void) PDMR3BlkCacheIoXferComplete(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEIOXFER hIoXfer, int rcIoXfer);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Suspends the block cache. The cache waits until all I/O transfers completed
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * and stops to enqueue new requests after the call returned but will not accept
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * reads, write or flushes either.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pBlkCache The cache instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) PDMR3BlkCacheSuspend(PPDMBLKCACHE pBlkCache);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Resumes operation of the block cache.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pBlkCache The cache instance.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVMMR3DECL(int) PDMR3BlkCacheResume(PPDMBLKCACHE pBlkCache);
ff5f52502d5dff6a8f353c85702ef49cc25c2f6bvboxsync * Clears the block cache and removes all entries. The cache waits until all
ff5f52502d5dff6a8f353c85702ef49cc25c2f6bvboxsync * I/O transfers completed.
ff5f52502d5dff6a8f353c85702ef49cc25c2f6bvboxsync * @returns VBox status code.
ff5f52502d5dff6a8f353c85702ef49cc25c2f6bvboxsync * @param pBlkCache The cache instance.