diff options
Diffstat (limited to 'include/VBox/vmm/pdmasynccompletion.h')
| -rw-r--r-- | include/VBox/vmm/pdmasynccompletion.h | 232 |
1 files changed, 6 insertions, 226 deletions
diff --git a/include/VBox/vmm/pdmasynccompletion.h b/include/VBox/vmm/pdmasynccompletion.h index 1d1af265..74285945 100644 --- a/include/VBox/vmm/pdmasynccompletion.h +++ b/include/VBox/vmm/pdmasynccompletion.h @@ -3,7 +3,7 @@ */ /* - * Copyright (C) 2007-2010 Oracle Corporation + * Copyright (C) 2007-2013 Oracle Corporation * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; @@ -104,122 +104,8 @@ typedef DECLCALLBACK(void) FNPDMASYNCCOMPLETEINT(PVM pVM, void *pvUser, void *pv /** Pointer to a FNPDMASYNCCOMPLETEINT(). */ typedef FNPDMASYNCCOMPLETEINT *PFNPDMASYNCCOMPLETEINT; - -/** - * Creates an async completion template for a device instance. - * - * The template is used when creating new completion tasks. - * - * @returns VBox status code. - * @param pVM Pointer to the shared VM structure. - * @param pDevIns The device instance. - * @param ppTemplate Where to store the template pointer on success. - * @param pfnCompleted The completion callback routine. - * @param pszDesc Description. - */ -VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateDevice(PVM pVM, PPDMDEVINS pDevIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEDEV pfnCompleted, const char *pszDesc); - -/** - * Creates an async completion template for a driver instance. - * - * The template is used when creating new completion tasks. - * - * @returns VBox status code. - * @param pVM Pointer to the shared VM structure. - * @param pDrvIns The driver instance. - * @param ppTemplate Where to store the template pointer on success. - * @param pfnCompleted The completion callback routine. - * @param pvTemplateUser Template user argument. - * @param pszDesc Description. - */ -VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser, const char *pszDesc); - -/** - * Creates an async completion template for a USB device instance. - * - * The template is used when creating new completion tasks. - * - * @returns VBox status code. - * @param pVM Pointer to the shared VM structure. - * @param pUsbIns The USB device instance. - * @param ppTemplate Where to store the template pointer on success. - * @param pfnCompleted The completion callback routine. - * @param pszDesc Description. - */ -VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateUsb(PVM pVM, PPDMUSBINS pUsbIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEUSB pfnCompleted, const char *pszDesc); - -/** - * Creates an async completion template for internally by the VMM. - * - * The template is used when creating new completion tasks. - * - * @returns VBox status code. - * @param pVM Pointer to the shared VM structure. - * @param ppTemplate Where to store the template pointer on success. - * @param pfnCompleted The completion callback routine. - * @param pvUser2 The 2nd user argument for the callback. - * @param pszDesc Description. - */ VMMR3DECL(int) PDMR3AsyncCompletionTemplateCreateInternal(PVM pVM, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate, PFNPDMASYNCCOMPLETEINT pfnCompleted, void *pvUser2, const char *pszDesc); - -/** - * Destroys the specified async completion template. - * - * @returns VBox status codes: - * @retval VINF_SUCCESS on success. - * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if the template is still in use. - * - * @param pTemplate The template in question. - */ VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroy(PPDMASYNCCOMPLETIONTEMPLATE pTemplate); - -/** - * Destroys all the specified async completion templates for the given device instance. - * - * @returns VBox status codes: - * @retval VINF_SUCCESS on success. - * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use. - * - * @param pVM Pointer to the shared VM structure. - * @param pDevIns The device instance. - */ -VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroyDevice(PVM pVM, PPDMDEVINS pDevIns); - -/** - * Destroys all the specified async completion templates for the given driver instance. - * - * @returns VBox status codes: - * @retval VINF_SUCCESS on success. - * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use. - * - * @param pVM Pointer to the shared VM structure. - * @param pDrvIns The driver instance. - */ -VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns); - -/** - * Destroys all the specified async completion templates for the given USB device instance. - * - * @returns VBox status codes: - * @retval VINF_SUCCESS on success. - * @retval VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use. - * - * @param pVM Pointer to the shared VM structure. - * @param pUsbIns The USB device instance. - */ -VMMR3DECL(int) PDMR3AsyncCompletionTemplateDestroyUsb(PVM pVM, PPDMUSBINS pUsbIns); - - -/** - * Opens a file as an async completion endpoint. - * - * @returns VBox status code. - * @param ppEndpoint Where to store the opaque endpoint handle on success. - * @param pszFilename Path to the file which is to be opened. (UTF-8) - * @param fFlags Open flags, see grp_pdmacep_file_flags. - * @param pTemplate Handle to the completion callback template to use - * for this end point. - */ VMMR3DECL(int) PDMR3AsyncCompletionEpCreateForFile(PPPDMASYNCCOMPLETIONENDPOINT ppEndpoint, const char *pszFilename, uint32_t fFlags, PPDMASYNCCOMPLETIONTEMPLATE pTemplate); @@ -238,127 +124,21 @@ VMMR3DECL(int) PDMR3AsyncCompletionEpCreateForFile(PPPDMASYNCCOMPLETIONENDPOINT #define PDMACEP_FILE_FLAGS_HOST_CACHE_ENABLED RT_BIT_32(3) /** @} */ -/** - * Closes a endpoint waiting for any pending tasks to finish. - * - * @returns nothing. - * @param pEndpoint Handle of the endpoint. - */ VMMR3DECL(void) PDMR3AsyncCompletionEpClose(PPDMASYNCCOMPLETIONENDPOINT pEndpoint); - -/** - * Creates a read task on the given endpoint. - * - * @returns VBox status code. - * @param pEndpoint The file endpoint to read from. - * @param off Where to start reading from. - * @param paSegments Scatter gather list to store the data in. - * @param cSegments Number of segments in the list. - * @param cbRead The overall number of bytes to read. - * @param pvUser Opaque user data returned in the completion callback - * upon completion of the task. - * @param ppTask Where to store the task handle on success. - */ VMMR3DECL(int) PDMR3AsyncCompletionEpRead(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off, PCRTSGSEG paSegments, unsigned cSegments, size_t cbRead, void *pvUser, PPPDMASYNCCOMPLETIONTASK ppTask); - -/** - * Creates a write task on the given endpoint. - * - * @returns VBox status code. - * @param pEndpoint The file endpoint to write to. - * @param off Where to start writing at. - * @param paSegments Scatter gather list of the data to write. - * @param cSegments Number of segments in the list. - * @param cbWrite The overall number of bytes to write. - * @param pvUser Opaque user data returned in the completion callback - * upon completion of the task. - * @param ppTask Where to store the task handle on success. - */ VMMR3DECL(int) PDMR3AsyncCompletionEpWrite(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off, PCRTSGSEG paSegments, unsigned cSegments, size_t cbWrite, void *pvUser, PPPDMASYNCCOMPLETIONTASK ppTask); - -/** - * Creates a flush task on the given endpoint. - * - * Every read and write task initiated before the flush task is - * finished upon completion of this task. - * - * @returns VBox status code. - * @param pEndpoint The file endpoint to flush. - * @param pvUser Opaque user data returned in the completion callback - * upon completion of the task. - * @param ppTask Where to store the task handle on success. - */ -VMMR3DECL(int) PDMR3AsyncCompletionEpFlush(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, - void *pvUser, - PPPDMASYNCCOMPLETIONTASK ppTask); - -/** - * Queries the size of an endpoint. - * Not that some endpoints may not support this and will return an error - * (sockets for example). - * - * @returns VBox status code. - * @retval VERR_NOT_SUPPORTED if the endpoint does not support this operation. - * @param pEndpoint The file endpoint. - * @param pcbSize Where to store the size of the endpoint. - */ -VMMR3DECL(int) PDMR3AsyncCompletionEpGetSize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, - uint64_t *pcbSize); - -/** - * Sets the size of an endpoint. - * Not that some endpoints may not support this and will return an error - * (sockets for example). - * - * @returns VBox status code. - * @retval VERR_NOT_SUPPORTED if the endpoint does not support this operation. - * @param pEndpoint The file endpoint. - * @param cbSize The size to set. - * - * @note PDMR3AsyncCompletionEpFlush should be called before this operation is executed. - */ -VMMR3DECL(int) PDMR3AsyncCompletionEpSetSize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, - uint64_t cbSize); - -/** - * Assigns or removes a bandwidth control manager to/from the endpoint. - * - * @returns VBox status code. - * @param pEndpoint The endpoint. - * @param pcszBwMgr The identifer of the new bandwidth manager to assign - * or NULL to remove the current one. - */ -VMMR3DECL(int) PDMR3AsyncCompletionEpSetBwMgr(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, - const char *pcszBwMgr); - -/** - * Cancels an async completion task. - * - * If you want to use this method, you have to take great create to make sure - * you will never attempt cancel a task which has been completed. Since there is - * no reference counting or anything on the task it self, you have to serialize - * the cancelation and completion paths such that the aren't racing one another. - * - * @returns VBox status code - * @param pTask The Task to cancel. - */ +VMMR3DECL(int) PDMR3AsyncCompletionEpFlush(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, void *pvUser, PPPDMASYNCCOMPLETIONTASK ppTask); +VMMR3DECL(int) PDMR3AsyncCompletionEpGetSize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t *pcbSize); +VMMR3DECL(int) PDMR3AsyncCompletionEpSetSize(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t cbSize); +VMMR3DECL(int) PDMR3AsyncCompletionEpSetBwMgr(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, const char *pszBwMgr); VMMR3DECL(int) PDMR3AsyncCompletionTaskCancel(PPDMASYNCCOMPLETIONTASK pTask); - -/** - * Changes the limit of a bandwidth manager for file endpoints to the given value. - * - * @returns VBox status code. - * @param pVM Pointer to the shared VM structure. - * @param pcszBwMgr The identifer of the bandwidth manager to change. - * @param cbMaxNew The new maximum for the bandwidth manager in bytes/sec. - */ -VMMR3DECL(int) PDMR3AsyncCompletionBwMgrSetMaxForFile(PVM pVM, const char *pcszBwMgr, uint32_t cbMaxNew); +VMMR3DECL(int) PDMR3AsyncCompletionBwMgrSetMaxForFile(PUVM pUVM, const char *pszBwMgr, uint32_t cbMaxNew); /** @} */ |