| 1 | /** @file
|
|---|
| 2 | * PDM - Pluggable Device Manager, Block cache.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2007-2010 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_vmm_pdmblkcache_h
|
|---|
| 27 | #define ___VBox_vmm_pdmblkcache_h
|
|---|
| 28 |
|
|---|
| 29 | #include <VBox/types.h>
|
|---|
| 30 | #include <VBox/err.h>
|
|---|
| 31 | #include <iprt/assert.h>
|
|---|
| 32 | #include <iprt/sg.h>
|
|---|
| 33 |
|
|---|
| 34 |
|
|---|
| 35 | RT_C_DECLS_BEGIN
|
|---|
| 36 |
|
|---|
| 37 | /** @defgroup grp_pdm_blk_cache The PDM Block Cache API
|
|---|
| 38 | * @ingroup grp_pdm
|
|---|
| 39 | * @{
|
|---|
| 40 | */
|
|---|
| 41 |
|
|---|
| 42 | /** Pointer to a PDM block cache. */
|
|---|
| 43 | typedef struct PDMBLKCACHE *PPDMBLKCACHE;
|
|---|
| 44 | /** Pointer to a PDM block cache pointer. */
|
|---|
| 45 | typedef PPDMBLKCACHE *PPPDMBLKCACHE;
|
|---|
| 46 |
|
|---|
| 47 | /** I/O transfer handle. */
|
|---|
| 48 | typedef struct PDMBLKCACHEIOXFER *PPDMBLKCACHEIOXFER;
|
|---|
| 49 |
|
|---|
| 50 | /**
|
|---|
| 51 | * Block cache I/O request transfer direction.
|
|---|
| 52 | */
|
|---|
| 53 | typedef enum PDMBLKCACHEXFERDIR
|
|---|
| 54 | {
|
|---|
| 55 | /** Read */
|
|---|
| 56 | PDMBLKCACHEXFERDIR_READ = 0,
|
|---|
| 57 | /** Write */
|
|---|
| 58 | PDMBLKCACHEXFERDIR_WRITE,
|
|---|
| 59 | /** FLush */
|
|---|
| 60 | PDMBLKCACHEXFERDIR_FLUSH
|
|---|
| 61 | } PDMBLKCACHEXFERDIR;
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Completion callback for drivers.
|
|---|
| 65 | *
|
|---|
| 66 | * @param pDrvIns The driver instance.
|
|---|
| 67 | * @param pvUser User argument given during request initiation.
|
|---|
| 68 | * @param rc The status code of the completed request.
|
|---|
| 69 | */
|
|---|
| 70 | typedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEDRV(PPDMDRVINS pDrvIns, void *pvUser, int rc);
|
|---|
| 71 | /** Pointer to a FNPDMBLKCACHEXFERCOMPLETEDRV(). */
|
|---|
| 72 | typedef FNPDMBLKCACHEXFERCOMPLETEDRV *PFNPDMBLKCACHEXFERCOMPLETEDRV;
|
|---|
| 73 |
|
|---|
| 74 | /**
|
|---|
| 75 | * I/O enqueue callback for drivers.
|
|---|
| 76 | *
|
|---|
| 77 | * @param pDrvIns The driver instance.
|
|---|
| 78 | * @param pvUser User argument given during request initiation.
|
|---|
| 79 | * @param rc The status code of the completed request.
|
|---|
| 80 | */
|
|---|
| 81 | typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDRV(PPDMDRVINS pDrvIns,
|
|---|
| 82 | PDMBLKCACHEXFERDIR enmXferDir,
|
|---|
| 83 | uint64_t off, size_t cbXfer,
|
|---|
| 84 | PCRTSGBUF pcSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
|
|---|
| 85 | /** Pointer to a FNPDMBLKCACHEXFERENQUEUEDRV(). */
|
|---|
| 86 | typedef FNPDMBLKCACHEXFERENQUEUEDRV *PFNPDMBLKCACHEXFERENQUEUEDRV;
|
|---|
| 87 |
|
|---|
| 88 | /**
|
|---|
| 89 | * Completion callback for devices.
|
|---|
| 90 | *
|
|---|
| 91 | * @param pDrvIns The driver instance.
|
|---|
| 92 | * @param pvUser User argument given during request initiation.
|
|---|
| 93 | * @param rc The status code of the completed request.
|
|---|
| 94 | */
|
|---|
| 95 | typedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEDEV(PPDMDEVINS pDevIns, void *pvUser, int rc);
|
|---|
| 96 | /** Pointer to a FNPDMBLKCACHEXFERCOMPLETEDEV(). */
|
|---|
| 97 | typedef FNPDMBLKCACHEXFERCOMPLETEDEV *PFNPDMBLKCACHEXFERCOMPLETEDEV;
|
|---|
| 98 |
|
|---|
| 99 | /**
|
|---|
| 100 | * I/O enqueue callback for devices.
|
|---|
| 101 | *
|
|---|
| 102 | * @param pDrvIns The driver instance.
|
|---|
| 103 | * @param pvUser User argument given during request initiation.
|
|---|
| 104 | * @param rc The status code of the completed request.
|
|---|
| 105 | */
|
|---|
| 106 | typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEDEV(PPDMDEVINS pDevIns,
|
|---|
| 107 | PDMBLKCACHEXFERDIR enmXferDir,
|
|---|
| 108 | uint64_t off, size_t cbXfer,
|
|---|
| 109 | PCRTSGBUF pcSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
|
|---|
| 110 | /** Pointer to a FNPDMBLKCACHEXFERENQUEUEDEV(). */
|
|---|
| 111 | typedef FNPDMBLKCACHEXFERENQUEUEDEV *PFNPDMBLKCACHEXFERENQUEUEDEV;
|
|---|
| 112 |
|
|---|
| 113 | /**
|
|---|
| 114 | * Completion callback for drivers.
|
|---|
| 115 | *
|
|---|
| 116 | * @param pDrvIns The driver instance.
|
|---|
| 117 | * @param pvUser User argument given during request initiation.
|
|---|
| 118 | * @param rc The status code of the completed request.
|
|---|
| 119 | */
|
|---|
| 120 | typedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEINT(void *pvUserInt, void *pvUser, int rc);
|
|---|
| 121 | /** Pointer to a FNPDMBLKCACHEXFERCOMPLETEINT(). */
|
|---|
| 122 | typedef FNPDMBLKCACHEXFERCOMPLETEINT *PFNPDMBLKCACHEXFERCOMPLETEINT;
|
|---|
| 123 |
|
|---|
| 124 | /**
|
|---|
| 125 | * I/O enqueue callback for drivers.
|
|---|
| 126 | *
|
|---|
| 127 | * @param pDrvIns The driver instance.
|
|---|
| 128 | * @param pvUser User argument given during request initiation.
|
|---|
| 129 | * @param rc The status code of the completed request.
|
|---|
| 130 | */
|
|---|
| 131 | typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEINT(void *pvUser,
|
|---|
| 132 | PDMBLKCACHEXFERDIR enmXferDir,
|
|---|
| 133 | uint64_t off, size_t cbXfer,
|
|---|
| 134 | PCRTSGBUF pcSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
|
|---|
| 135 | /** Pointer to a FNPDMBLKCACHEXFERENQUEUEINT(). */
|
|---|
| 136 | typedef FNPDMBLKCACHEXFERENQUEUEINT *PFNPDMBLKCACHEXFERENQUEUEINT;
|
|---|
| 137 |
|
|---|
| 138 | /**
|
|---|
| 139 | * Completion callback for USB.
|
|---|
| 140 | *
|
|---|
| 141 | * @param pDrvIns The driver instance.
|
|---|
| 142 | * @param pvUser User argument given during request initiation.
|
|---|
| 143 | * @param rc The status code of the completed request.
|
|---|
| 144 | */
|
|---|
| 145 | typedef DECLCALLBACK(void) FNPDMBLKCACHEXFERCOMPLETEUSB(PPDMUSBINS pUsbIns, void *pvUser, int rc);
|
|---|
| 146 | /** Pointer to a FNPDMBLKCACHEXFERCOMPLETEUSB(). */
|
|---|
| 147 | typedef FNPDMBLKCACHEXFERCOMPLETEUSB *PFNPDMBLKCACHEXFERCOMPLETEUSB;
|
|---|
| 148 |
|
|---|
| 149 | /**
|
|---|
| 150 | * I/O enqueue callback for drivers.
|
|---|
| 151 | *
|
|---|
| 152 | * @param pDrvIns The driver instance.
|
|---|
| 153 | * @param pvUser User argument given during request initiation.
|
|---|
| 154 | * @param rc The status code of the completed request.
|
|---|
| 155 | */
|
|---|
| 156 | typedef DECLCALLBACK(int) FNPDMBLKCACHEXFERENQUEUEUSB(PPDMUSBINS pUsbIns,
|
|---|
| 157 | PDMBLKCACHEXFERDIR enmXferDir,
|
|---|
| 158 | uint64_t off, size_t cbXfer,
|
|---|
| 159 | PCRTSGBUF pcSgBuf, PPDMBLKCACHEIOXFER hIoXfer);
|
|---|
| 160 | /** Pointer to a FNPDMBLKCACHEXFERENQUEUEUSB(). */
|
|---|
| 161 | typedef FNPDMBLKCACHEXFERENQUEUEUSB *PFNPDMBLKCACHEXFERENQUEUEUSB;
|
|---|
| 162 |
|
|---|
| 163 | /**
|
|---|
| 164 | * Create a block cache user for a driver instance.
|
|---|
| 165 | *
|
|---|
| 166 | * @returns VBox status code.
|
|---|
| 167 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 168 | * @param pDrvIns The driver instance.
|
|---|
| 169 | * @param ppBlkCache Where to store the handle to the block cache.
|
|---|
| 170 | * @param pfnXferComplete The I/O transfer complete callback.
|
|---|
| 171 | * @param pfnXferEnqueue The I/O request enqueue callback.
|
|---|
| 172 | * @param pcszId Unique ID used to identify the user.
|
|---|
| 173 | */
|
|---|
| 174 | VMMR3DECL(int) PDMR3BlkCacheRetainDriver(PVM pVM, PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
|
|---|
| 175 | PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
|
|---|
| 176 | PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
|
|---|
| 177 | const char *pcszId);
|
|---|
| 178 |
|
|---|
| 179 | /**
|
|---|
| 180 | * Create a block cache user for a device instance.
|
|---|
| 181 | *
|
|---|
| 182 | * @returns VBox status code.
|
|---|
| 183 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 184 | * @param pDevIns The device instance.
|
|---|
| 185 | * @param ppBlkCache Where to store the handle to the block cache.
|
|---|
| 186 | * @param pfnXferComplete The I/O transfer complete callback.
|
|---|
| 187 | * @param pfnXferEnqueue The I/O request enqueue callback.
|
|---|
| 188 | * @param pcszId Unique ID used to identify the user.
|
|---|
| 189 | */
|
|---|
| 190 | VMMR3DECL(int) PDMR3BlkCacheRetainDevice(PVM pVM, PPDMDEVINS pDevIns, PPPDMBLKCACHE ppBlkCache,
|
|---|
| 191 | PFNPDMBLKCACHEXFERCOMPLETEDEV pfnXferComplete,
|
|---|
| 192 | PFNPDMBLKCACHEXFERENQUEUEDEV pfnXferEnqueue,
|
|---|
| 193 | const char *pcszId);
|
|---|
| 194 |
|
|---|
| 195 | /**
|
|---|
| 196 | * Create a block cache user for a USB instance.
|
|---|
| 197 | *
|
|---|
| 198 | * @returns VBox status code.
|
|---|
| 199 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 200 | * @param pUsbIns The USB device instance.
|
|---|
| 201 | * @param ppBlkCache Where to store the handle to the block cache.
|
|---|
| 202 | * @param pfnXferComplete The I/O transfer complete callback.
|
|---|
| 203 | * @param pfnXferEnqueue The I/O request enqueue callback.
|
|---|
| 204 | * @param pcszId Unique ID used to identify the user.
|
|---|
| 205 | */
|
|---|
| 206 | VMMR3DECL(int) PDMR3BlkCacheRetainUsb(PVM pVM, PPDMUSBINS pUsbIns, PPPDMBLKCACHE ppBlkCache,
|
|---|
| 207 | PFNPDMBLKCACHEXFERCOMPLETEUSB pfnXferComplete,
|
|---|
| 208 | PFNPDMBLKCACHEXFERENQUEUEUSB pfnXferEnqueue,
|
|---|
| 209 | const char *pcszId);
|
|---|
| 210 |
|
|---|
| 211 | /**
|
|---|
| 212 | * Create a block cache user for internal use by VMM.
|
|---|
| 213 | *
|
|---|
| 214 | * @returns VBox status code.
|
|---|
| 215 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 216 | * @param pvUser Opaque user data.
|
|---|
| 217 | * @param ppBlkCache Where to store the handle to the block cache.
|
|---|
| 218 | * @param pfnXferComplete The I/O transfer complete callback.
|
|---|
| 219 | * @param pfnXferEnqueue The I/O request enqueue callback.
|
|---|
| 220 | * @param pcszId Unique ID used to identify the user.
|
|---|
| 221 | */
|
|---|
| 222 | VMMR3DECL(int) PDMR3BlkCacheRetainInt(PVM pVM, void *pvUser, PPPDMBLKCACHE ppBlkCache,
|
|---|
| 223 | PFNPDMBLKCACHEXFERCOMPLETEINT pfnXferComplete,
|
|---|
| 224 | PFNPDMBLKCACHEXFERENQUEUEINT pfnXferEnqueue,
|
|---|
| 225 | const char *pcszId);
|
|---|
| 226 |
|
|---|
| 227 | /**
|
|---|
| 228 | * Releases a block cache handle.
|
|---|
| 229 | *
|
|---|
| 230 | * @returns nothing.
|
|---|
| 231 | * @param pBlkCache Block cache handle.
|
|---|
| 232 | */
|
|---|
| 233 | VMMR3DECL(void) PDMR3BlkCacheRelease(PPDMBLKCACHE pBlkCache);
|
|---|
| 234 |
|
|---|
| 235 | /**
|
|---|
| 236 | * Releases all block cache handles for a device instance.
|
|---|
| 237 | *
|
|---|
| 238 | * @returns nothing.
|
|---|
| 239 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 240 | * @param pDevIns The device instance.
|
|---|
| 241 | */
|
|---|
| 242 | VMMR3DECL(void) PDMR3BlkCacheReleaseDevice(PVM pVM, PPDMDEVINS pDevIns);
|
|---|
| 243 |
|
|---|
| 244 | /**
|
|---|
| 245 | * Releases all block cache handles for a driver instance.
|
|---|
| 246 | *
|
|---|
| 247 | * @returns nothing.
|
|---|
| 248 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 249 | * @param pDrvIns The driver instance.
|
|---|
| 250 | */
|
|---|
| 251 | VMMR3DECL(void) PDMR3BlkCacheReleaseDriver(PVM pVM, PPDMDRVINS pDrvIns);
|
|---|
| 252 |
|
|---|
| 253 | /**
|
|---|
| 254 | * Releases all block cache handles for a USB device instance.
|
|---|
| 255 | *
|
|---|
| 256 | * @returns nothing.
|
|---|
| 257 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 258 | * @param pUsbIns The USB device instance.
|
|---|
| 259 | */
|
|---|
| 260 | VMMR3DECL(void) PDMR3BlkCacheReleaseUsb(PVM pVM, PPDMUSBINS pUsbIns);
|
|---|
| 261 |
|
|---|
| 262 | /**
|
|---|
| 263 | * Creates a read task on the given endpoint.
|
|---|
| 264 | *
|
|---|
| 265 | * @returns VBox status code.
|
|---|
| 266 | * @param pEndpoint The file endpoint to read from.
|
|---|
| 267 | * @param off Where to start reading from.
|
|---|
| 268 | * @param paSegments Scatter gather list to store the data in.
|
|---|
| 269 | * @param cSegments Number of segments in the list.
|
|---|
| 270 | * @param cbRead The overall number of bytes to read.
|
|---|
| 271 | * @param pvUser Opaque user data returned in the completion callback
|
|---|
| 272 | * upon completion of the read.
|
|---|
| 273 | */
|
|---|
| 274 | VMMR3DECL(int) PDMR3BlkCacheRead(PPDMBLKCACHE pBlkCache, uint64_t off,
|
|---|
| 275 | PCRTSGBUF pcSgBuf, size_t cbRead, void *pvUser);
|
|---|
| 276 |
|
|---|
| 277 | /**
|
|---|
| 278 | * Creates a write task on the given endpoint.
|
|---|
| 279 | *
|
|---|
| 280 | * @returns VBox status code.
|
|---|
| 281 | * @param pEndpoint The file endpoint to write to.
|
|---|
| 282 | * @param off Where to start writing at.
|
|---|
| 283 | * @param paSegments Scatter gather list of the data to write.
|
|---|
| 284 | * @param cSegments Number of segments in the list.
|
|---|
| 285 | * @param cbWrite The overall number of bytes to write.
|
|---|
| 286 | * @param pvUser Opaque user data returned in the completion callback
|
|---|
| 287 | * upon completion of the task.
|
|---|
| 288 | */
|
|---|
| 289 | VMMR3DECL(int) PDMR3BlkCacheWrite(PPDMBLKCACHE pBlkCache, uint64_t off,
|
|---|
| 290 | PCRTSGBUF pcSgBuf, size_t cbWrite, void *pvUser);
|
|---|
| 291 |
|
|---|
| 292 | /**
|
|---|
| 293 | * Creates a flush task on the given endpoint.
|
|---|
| 294 | *
|
|---|
| 295 | * @returns VBox status code.
|
|---|
| 296 | * @param pEndpoint The file endpoint to flush.
|
|---|
| 297 | * @param pvUser Opaque user data returned in the completion callback
|
|---|
| 298 | * upon completion of the task.
|
|---|
| 299 | * @param ppTask Where to store the task handle on success.
|
|---|
| 300 | */
|
|---|
| 301 | VMMR3DECL(int) PDMR3BlkCacheFlush(PPDMBLKCACHE pBlkCache, void *pvUser);
|
|---|
| 302 |
|
|---|
| 303 | /**
|
|---|
| 304 | * Notify the cache of a complete I/O transfer.
|
|---|
| 305 | *
|
|---|
| 306 | * @returns nothing.
|
|---|
| 307 | * @param pBlkCache The cache instance.
|
|---|
| 308 | * @param hIoXfer The I/O transfer handle which completed.
|
|---|
| 309 | * @param rcIoXfer The status code of the completed request.
|
|---|
| 310 | */
|
|---|
| 311 | VMMR3DECL(void) PDMR3BlkCacheIoXferComplete(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEIOXFER hIoXfer, int rcIoXfer);
|
|---|
| 312 |
|
|---|
| 313 | /**
|
|---|
| 314 | * Suspends the block cache. The cache waits until all I/O transfers completed
|
|---|
| 315 | * and stops to enqueue new requests after the call returned but will not accept
|
|---|
| 316 | * reads, write or flushes either.
|
|---|
| 317 | *
|
|---|
| 318 | * @returns VBox status code.
|
|---|
| 319 | * @param pBlkCache The cache instance.
|
|---|
| 320 | */
|
|---|
| 321 | VMMR3DECL(int) PDMR3BlkCacheSuspend(PPDMBLKCACHE pBlkCache);
|
|---|
| 322 |
|
|---|
| 323 | /**
|
|---|
| 324 | * Resumes operation of the block cache.
|
|---|
| 325 | *
|
|---|
| 326 | * @returns VBox status code.
|
|---|
| 327 | * @param pBlkCache The cache instance.
|
|---|
| 328 | */
|
|---|
| 329 | VMMR3DECL(int) PDMR3BlkCacheResume(PPDMBLKCACHE pBlkCache);
|
|---|
| 330 |
|
|---|
| 331 | /** @} */
|
|---|
| 332 |
|
|---|
| 333 | RT_C_DECLS_END
|
|---|
| 334 |
|
|---|
| 335 | #endif
|
|---|
| 336 |
|
|---|
