| 1 | /* $Id: pdmasynccompletion.h 31173 2010-07-28 16:17:36Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * PDM - Pluggable Device Manager, Async I/O Completion. (VMM)
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2007-2009 Oracle Corporation
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * The contents of this file may alternatively be used under the terms
|
|---|
| 18 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 20 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 21 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 22 | *
|
|---|
| 23 | * You may elect to license modified versions of this file under the
|
|---|
| 24 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 25 | */
|
|---|
| 26 |
|
|---|
| 27 | #ifndef ___VBox_pdmasynccompletion_h
|
|---|
| 28 | #define ___VBox_pdmasynccompletion_h
|
|---|
| 29 |
|
|---|
| 30 | #include <VBox/types.h>
|
|---|
| 31 | #include <VBox/err.h>
|
|---|
| 32 | #include <iprt/assert.h>
|
|---|
| 33 | #include <iprt/sg.h>
|
|---|
| 34 |
|
|---|
| 35 | RT_C_DECLS_BEGIN
|
|---|
| 36 |
|
|---|
| 37 | /** @defgroup grp_pdm_async_completion The PDM Async I/O Completion API
|
|---|
| 38 | * @ingroup grp_pdm
|
|---|
| 39 | * @{
|
|---|
| 40 | */
|
|---|
| 41 |
|
|---|
| 42 | /** Pointer to a PDM async completion template handle. */
|
|---|
| 43 | typedef struct PDMASYNCCOMPLETIONTEMPLATE *PPDMASYNCCOMPLETIONTEMPLATE;
|
|---|
| 44 | /** Pointer to a PDM async completion template handle pointer. */
|
|---|
| 45 | typedef PPDMASYNCCOMPLETIONTEMPLATE *PPPDMASYNCCOMPLETIONTEMPLATE;
|
|---|
| 46 |
|
|---|
| 47 | /** Pointer to a PDM async completion task handle. */
|
|---|
| 48 | typedef struct PDMASYNCCOMPLETIONTASK *PPDMASYNCCOMPLETIONTASK;
|
|---|
| 49 | /** Pointer to a PDM async completion task handle pointer. */
|
|---|
| 50 | typedef PPDMASYNCCOMPLETIONTASK *PPPDMASYNCCOMPLETIONTASK;
|
|---|
| 51 |
|
|---|
| 52 | /** Pointer to a PDM async completion endpoint handle. */
|
|---|
| 53 | typedef struct PDMASYNCCOMPLETIONENDPOINT *PPDMASYNCCOMPLETIONENDPOINT;
|
|---|
| 54 | /** Pointer to a PDM async completion endpoint handle pointer. */
|
|---|
| 55 | typedef PPDMASYNCCOMPLETIONENDPOINT *PPPDMASYNCCOMPLETIONENDPOINT;
|
|---|
| 56 |
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * Completion callback for devices.
|
|---|
| 60 | *
|
|---|
| 61 | * @param pDevIns The device instance.
|
|---|
| 62 | * @param pvUser User argument.
|
|---|
| 63 | * @param rc The status code of the completed request.
|
|---|
| 64 | */
|
|---|
| 65 | typedef DECLCALLBACK(void) FNPDMASYNCCOMPLETEDEV(PPDMDEVINS pDevIns, void *pvUser, int rc);
|
|---|
| 66 | /** Pointer to a FNPDMASYNCCOMPLETEDEV(). */
|
|---|
| 67 | typedef FNPDMASYNCCOMPLETEDEV *PFNPDMASYNCCOMPLETEDEV;
|
|---|
| 68 |
|
|---|
| 69 |
|
|---|
| 70 | /**
|
|---|
| 71 | * Completion callback for drivers.
|
|---|
| 72 | *
|
|---|
| 73 | * @param pDrvIns The driver instance.
|
|---|
| 74 | * @param pvTemplateUser User argument given when creating the template.
|
|---|
| 75 | * @param pvUser User argument given during request initiation.
|
|---|
| 76 | * @param rc The status code of the completed request.
|
|---|
| 77 | */
|
|---|
| 78 | typedef DECLCALLBACK(void) FNPDMASYNCCOMPLETEDRV(PPDMDRVINS pDrvIns, void *pvTemplateUser, void *pvUser, int rc);
|
|---|
| 79 | /** Pointer to a FNPDMASYNCCOMPLETEDRV(). */
|
|---|
| 80 | typedef FNPDMASYNCCOMPLETEDRV *PFNPDMASYNCCOMPLETEDRV;
|
|---|
| 81 |
|
|---|
| 82 |
|
|---|
| 83 | /**
|
|---|
| 84 | * Completion callback for USB devices.
|
|---|
| 85 | *
|
|---|
| 86 | * @param pUsbIns The USB device instance.
|
|---|
| 87 | * @param pvUser User argument.
|
|---|
| 88 | * @param rc The status code of the completed request.
|
|---|
| 89 | */
|
|---|
| 90 | typedef DECLCALLBACK(void) FNPDMASYNCCOMPLETEUSB(PPDMUSBINS pUsbIns, void *pvUser, int rc);
|
|---|
| 91 | /** Pointer to a FNPDMASYNCCOMPLETEUSB(). */
|
|---|
| 92 | typedef FNPDMASYNCCOMPLETEUSB *PFNPDMASYNCCOMPLETEUSB;
|
|---|
| 93 |
|
|---|
| 94 |
|
|---|
| 95 | /**
|
|---|
| 96 | * Completion callback for internal.
|
|---|
| 97 | *
|
|---|
| 98 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 99 | * @param pvUser User argument for the task.
|
|---|
| 100 | * @param pvUser2 User argument for the template.
|
|---|
| 101 | * @param rc The status code of the completed request.
|
|---|
| 102 | */
|
|---|
| 103 | typedef DECLCALLBACK(void) FNPDMASYNCCOMPLETEINT(PVM pVM, void *pvUser, void *pvUser2, int rc);
|
|---|
| 104 | /** Pointer to a FNPDMASYNCCOMPLETEINT(). */
|
|---|
| 105 | typedef FNPDMASYNCCOMPLETEINT *PFNPDMASYNCCOMPLETEINT;
|
|---|
| 106 |
|
|---|
| 107 |
|
|---|
| 108 | /**
|
|---|
| 109 | * Creates a async completion template for a device instance.
|
|---|
| 110 | *
|
|---|
| 111 | * The template is used when creating new completion tasks.
|
|---|
| 112 | *
|
|---|
| 113 | * @returns VBox status code.
|
|---|
| 114 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 115 | * @param pDevIns The device instance.
|
|---|
| 116 | * @param ppTemplate Where to store the template pointer on success.
|
|---|
| 117 | * @param pfnCompleted The completion callback routine.
|
|---|
| 118 | * @param pszDesc Description.
|
|---|
| 119 | */
|
|---|
| 120 | VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateDevice(PVM pVM, PPDMDEVINS pDevIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEDEV pfnCompleted, const char *pszDesc);
|
|---|
| 121 |
|
|---|
| 122 | /**
|
|---|
| 123 | * Creates a async completion template for a driver instance.
|
|---|
| 124 | *
|
|---|
| 125 | * The template is used when creating new completion tasks.
|
|---|
| 126 | *
|
|---|
| 127 | * @returns VBox status code.
|
|---|
| 128 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 129 | * @param pDrvIns The driver instance.
|
|---|
| 130 | * @param ppTemplate Where to store the template pointer on success.
|
|---|
| 131 | * @param pfnCompleted The completion callback routine.
|
|---|
| 132 | * @param pvTemplateUser Template user argument.
|
|---|
| 133 | * @param pszDesc Description.
|
|---|
| 134 | */
|
|---|
| 135 | VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser, const char *pszDesc);
|
|---|
| 136 |
|
|---|
| 137 | /**
|
|---|
| 138 | * Creates a async completion template for a USB device instance.
|
|---|
| 139 | *
|
|---|
| 140 | * The template is used when creating new completion tasks.
|
|---|
| 141 | *
|
|---|
| 142 | * @returns VBox status code.
|
|---|
| 143 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 144 | * @param pUsbIns The USB device instance.
|
|---|
| 145 | * @param ppTemplate Where to store the template pointer on success.
|
|---|
| 146 | * @param pfnCompleted The completion callback routine.
|
|---|
| 147 | * @param pszDesc Description.
|
|---|
| 148 | */
|
|---|
| 149 | VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateUsb(PVM pVM, PPDMUSBINS pUsbIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEUSB pfnCompleted, const char *pszDesc);
|
|---|
| 150 |
|
|---|
| 151 | /**
|
|---|
| 152 | * Creates a async completion template for internally by the VMM.
|
|---|
| 153 | *
|
|---|
| 154 | * The template is used when creating new completion tasks.
|
|---|
| 155 | *
|
|---|
| 156 | * @returns VBox status code.
|
|---|
| 157 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 158 | * @param ppTemplate Where to store the template pointer on success.
|
|---|
| 159 | * @param pfnCompleted The completion callback routine.
|
|---|
| 160 | * @param pvUser2 The 2nd user argument for the callback.
|
|---|
| 161 | * @param pszDesc Description.
|
|---|
| 162 | */
|
|---|
| 163 | VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateInternal(PVM pVM, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEINT pfnCompleted, void *pvUser2, const char *pszDesc);
|
|---|
| 164 |
|
|---|
| 165 | /**
|
|---|
| 166 | * Destroys the specified async completion template.
|
|---|
| 167 | *
|
|---|
| 168 | * @returns VBox status codes:
|
|---|
| 169 | * @retval VINF_SUCCESS on success.
|
|---|
| 170 | * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if the template is still in use.
|
|---|
| 171 | *
|
|---|
| 172 | * @param pTemplate The template in question.
|
|---|
| 173 | */
|
|---|
| 174 | VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroy(PPDMASYNCCOMPLETIONTEMPLATE pTemplate);
|
|---|
| 175 |
|
|---|
| 176 | /**
|
|---|
| 177 | * Destroys all the specified async completion templates for the given device instance.
|
|---|
| 178 | *
|
|---|
| 179 | * @returns VBox status codes:
|
|---|
| 180 | * @retval VINF_SUCCESS on success.
|
|---|
| 181 | * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use.
|
|---|
| 182 | *
|
|---|
| 183 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 184 | * @param pDevIns The device instance.
|
|---|
| 185 | */
|
|---|
| 186 | VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroyDevice(PVM pVM, PPDMDEVINS pDevIns);
|
|---|
| 187 |
|
|---|
| 188 | /**
|
|---|
| 189 | * Destroys all the specified async completion templates for the given driver instance.
|
|---|
| 190 | *
|
|---|
| 191 | * @returns VBox status codes:
|
|---|
| 192 | * @retval VINF_SUCCESS on success.
|
|---|
| 193 | * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use.
|
|---|
| 194 | *
|
|---|
| 195 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 196 | * @param pDrvIns The driver instance.
|
|---|
| 197 | */
|
|---|
| 198 | VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns);
|
|---|
| 199 |
|
|---|
| 200 | /**
|
|---|
| 201 | * Destroys all the specified async completion templates for the given USB device instance.
|
|---|
| 202 | *
|
|---|
| 203 | * @returns VBox status codes:
|
|---|
| 204 | * @retval VINF_SUCCESS on success.
|
|---|
| 205 | * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use.
|
|---|
| 206 | *
|
|---|
| 207 | * @param pVM Pointer to the shared VM structure.
|
|---|
| 208 | * @param pUsbIns The USB device instance.
|
|---|
| 209 | */
|
|---|
| 210 | VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroyUsb(PVM pVM, PPDMUSBINS pUsbIns);
|
|---|
| 211 |
|
|---|
| 212 |
|
|---|
| 213 | /**
|
|---|
| 214 | * Opens a file as a async completion endpoint.
|
|---|
| 215 | *
|
|---|
| 216 | * @returns VBox status code.
|
|---|
| 217 | * @param ppEndpoint Where to store the opaque endpoint handle on success.
|
|---|
| 218 | * @param pszFilename Path to the file which is to be opened. (UTF-8)
|
|---|
| 219 | * @param fFlags Open flags, see grp_pdmacep_file_flags.
|
|---|
| 220 | * @param pTemplate Handle to the completion callback template to use
|
|---|
| 221 | * for this end point.
|
|---|
| 222 | */
|
|---|
| 223 | VMMR3DECL(int) PDMR3AsyncCompletionEpCreateForFile(PPPDMASYNCCOMPLETIONENDPOINT ppEndpoint,
|
|---|
| 224 | const char *pszFilename, uint32_t fFlags,
|
|---|
| 225 | PPDMASYNCCOMPLETIONTEMPLATE pTemplate);
|
|---|
| 226 |
|
|---|
| 227 | /** @defgroup grp_pdmacep_file_flags Flags for PDMR3AsyncCompletionEpCreateForFile
|
|---|
| 228 | * @{ */
|
|---|
| 229 | /** Open the file in read-only mode. */
|
|---|
| 230 | #define PDMACEP_FILE_FLAGS_READ_ONLY RT_BIT_32(0)
|
|---|
| 231 | /** whether file content should be cached by the endpoint. */
|
|---|
| 232 | #define PDMACEP_FILE_FLAGS_CACHING RT_BIT_32(1)
|
|---|
| 233 | /** Whether the file should not be write protected.
|
|---|
| 234 | * The default is to protect the file against writes by other processes
|
|---|
| 235 | * when opened in read/write mode to prevent data corruption by
|
|---|
| 236 | * concurrent access which can occur if the local writeback cache is enabled.
|
|---|
| 237 | */
|
|---|
| 238 | #define PDMACEP_FILE_FLAGS_DONT_LOCK RT_BIT_32(2)
|
|---|
| 239 | /** @} */
|
|---|
| 240 |
|
|---|
| 241 | /**
|
|---|
| 242 | * Closes a endpoint waiting for any pending tasks to finish.
|
|---|
| 243 | *
|
|---|
| 244 | * @returns nothing.
|
|---|
| 245 | * @param pEndpoint Handle of the endpoint.
|
|---|
| 246 | */
|
|---|
| 247 | VMMR3DECL(void) PDMR3AsyncCompletionEpClose(PPDMASYNCCOMPLETIONENDPOINT pEndpoint);
|
|---|
| 248 |
|
|---|
| 249 | /**
|
|---|
| 250 | * Creates a read task on the given endpoint.
|
|---|
| 251 | *
|
|---|
| 252 | * @returns VBox status code.
|
|---|
| 253 | * @param pEndpoint The file endpoint to read from.
|
|---|
| 254 | * @param off Where to start reading from.
|
|---|
| 255 | * @param paSegments Scatter gather list to store the data in.
|
|---|
| 256 | * @param cSegments Number of segments in the list.
|
|---|
| 257 | * @param cbRead The overall number of bytes to read.
|
|---|
| 258 | * @param pvUser Opaque user data returned in the completion callback
|
|---|
| 259 | * upon completion of the task.
|
|---|
| 260 | * @param ppTask Where to store the task handle on success.
|
|---|
| 261 | */
|
|---|
| 262 | VMMR3DECL(int) PDMR3AsyncCompletionEpRead(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
|
|---|
| 263 | PCRTSGSEG paSegments, unsigned cSegments,
|
|---|
| 264 | size_t cbRead, void *pvUser,
|
|---|
| 265 | PPPDMASYNCCOMPLETIONTASK ppTask);
|
|---|
| 266 |
|
|---|
| 267 | /**
|
|---|
| 268 | * Creates a write task on the given endpoint.
|
|---|
| 269 | *
|
|---|
| 270 | * @returns VBox status code.
|
|---|
| 271 | * @param pEndpoint The file endpoint to write to.
|
|---|
| 272 | * @param off Where to start writing at.
|
|---|
| 273 | * @param paSegments Scatter gather list of the data to write.
|
|---|
| 274 | * @param cSegments Number of segments in the list.
|
|---|
| 275 | * @param cbWrite The overall number of bytes to write.
|
|---|
| 276 | * @param pvUser Opaque user data returned in the completion callback
|
|---|
| 277 | * upon completion of the task.
|
|---|
| 278 | * @param ppTask Where to store the task handle on success.
|
|---|
| 279 | */
|
|---|
| 280 | VMMR3DECL(int) PDMR3AsyncCompletionEpWrite(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
|
|---|
| 281 | PCRTSGSEG paSegments, unsigned cSegments,
|
|---|
| 282 | size_t cbWrite, void *pvUser,
|
|---|
| 283 | PPPDMASYNCCOMPLETIONTASK ppTask);
|
|---|
| 284 |
|
|---|
| 285 | /**
|
|---|
| 286 | * Creates a flush task on the given endpoint.
|
|---|
| 287 | *
|
|---|
| 288 | * Every read and write task initiated before the flush task is
|
|---|
| 289 | * finished upon completion of this task.
|
|---|
| 290 | *
|
|---|
| 291 | * @returns VBox status code.
|
|---|
| 292 | * @param pEndpoint The file endpoint to flush.
|
|---|
| 293 | * @param pvUser Opaque user data returned in the completion callback
|
|---|
| 294 | * upon completion of the task.
|
|---|
| 295 | * @param ppTask Where to store the task handle on success.
|
|---|
| 296 | */
|
|---|
| 297 | VMMR3DECL(int) PDMR3AsyncCompletionEpFlush(PPDMASYNCCOMPLETIONENDPOINT pEndpoint,
|
|---|
| 298 | void *pvUser,
|
|---|
| 299 | PPPDMASYNCCOMPLETIONTASK ppTask);
|
|---|
| 300 |
|
|---|
| 301 | /**
|
|---|
| 302 | * Queries the size of an endpoint.
|
|---|
| 303 | * Not that some endpoints may not support this and will return an error
|
|---|
| 304 | * (sockets for example).
|
|---|
| 305 | *
|
|---|
| 306 | * @returns VBox status code.
|
|---|
| 307 | * @retval VERR_NOT_SUPPORTED if the endpoint does not support this operation.
|
|---|
| 308 | * @param pEndpoint The file endpoint.
|
|---|
| 309 | * @param pcbSize Where to store the size of the endpoint.
|
|---|
| 310 | */
|
|---|
| 311 | VMMR3DECL(int) PDMR3AsyncCompletionEpGetSize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint,
|
|---|
| 312 | uint64_t *pcbSize);
|
|---|
| 313 |
|
|---|
| 314 | /**
|
|---|
| 315 | * Sets the size of an endpoint.
|
|---|
| 316 | * Not that some endpoints may not support this and will return an error
|
|---|
| 317 | * (sockets for example).
|
|---|
| 318 | *
|
|---|
| 319 | * @returns VBox status code.
|
|---|
| 320 | * @retval VERR_NOT_SUPPORTED if the endpoint does not support this operation.
|
|---|
| 321 | * @param pEndpoint The file endpoint.
|
|---|
| 322 | * @param cbSize The size to set.
|
|---|
| 323 | *
|
|---|
| 324 | * @note PDMR3AsyncCompletionEpFlush should be called before this operation is executed.
|
|---|
| 325 | */
|
|---|
| 326 | VMMR3DECL(int) PDMR3AsyncCompletionEpSetSize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint,
|
|---|
| 327 | uint64_t cbSize);
|
|---|
| 328 |
|
|---|
| 329 | /**
|
|---|
| 330 | * Cancels a async completion task.
|
|---|
| 331 | *
|
|---|
| 332 | * If you want to use this method, you have to take great create to make sure
|
|---|
| 333 | * you will never attempt cancel a task which has been completed. Since there is
|
|---|
| 334 | * no reference counting or anything on the task it self, you have to serialize
|
|---|
| 335 | * the cancelation and completion paths such that the aren't racing one another.
|
|---|
| 336 | *
|
|---|
| 337 | * @returns VBox status code
|
|---|
| 338 | * @param pTask The Task to cancel.
|
|---|
| 339 | */
|
|---|
| 340 | VMMR3DECL(int) PDMR3AsyncCompletionTaskCancel(PPDMASYNCCOMPLETIONTASK pTask);
|
|---|
| 341 |
|
|---|
| 342 | /** @} */
|
|---|
| 343 |
|
|---|
| 344 | RT_C_DECLS_END
|
|---|
| 345 |
|
|---|
| 346 | #endif
|
|---|
| 347 |
|
|---|
