| 1 | /** @file
|
|---|
| 2 | * PDM - Pluggable Device Manager, Queues.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 9 | * available from https://www.virtualbox.org.
|
|---|
| 10 | *
|
|---|
| 11 | * This program is free software; you can redistribute it and/or
|
|---|
| 12 | * modify it under the terms of the GNU General Public License
|
|---|
| 13 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 14 | * License.
|
|---|
| 15 | *
|
|---|
| 16 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 17 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 19 | * General Public License for more details.
|
|---|
| 20 | *
|
|---|
| 21 | * You should have received a copy of the GNU General Public License
|
|---|
| 22 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 23 | *
|
|---|
| 24 | * The contents of this file may alternatively be used under the terms
|
|---|
| 25 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 26 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 27 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 28 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 29 | *
|
|---|
| 30 | * You may elect to license modified versions of this file under the
|
|---|
| 31 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 32 | *
|
|---|
| 33 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 34 | */
|
|---|
| 35 |
|
|---|
| 36 | #ifndef VBOX_INCLUDED_vmm_pdmqueue_h
|
|---|
| 37 | #define VBOX_INCLUDED_vmm_pdmqueue_h
|
|---|
| 38 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 39 | # pragma once
|
|---|
| 40 | #endif
|
|---|
| 41 |
|
|---|
| 42 | #include <VBox/types.h>
|
|---|
| 43 |
|
|---|
| 44 | RT_C_DECLS_BEGIN
|
|---|
| 45 |
|
|---|
| 46 | /** @defgroup grp_pdm_queue The PDM Queues API
|
|---|
| 47 | * @ingroup grp_pdm
|
|---|
| 48 | * @{
|
|---|
| 49 | */
|
|---|
| 50 |
|
|---|
| 51 | /** Pointer to a PDM queue. */
|
|---|
| 52 | typedef struct PDMQUEUE *PPDMQUEUE;
|
|---|
| 53 |
|
|---|
| 54 | /** Pointer to a PDM queue item core. */
|
|---|
| 55 | typedef union PDMQUEUEITEMCORE *PPDMQUEUEITEMCORE;
|
|---|
| 56 |
|
|---|
| 57 | /**
|
|---|
| 58 | * PDM queue item core.
|
|---|
| 59 | */
|
|---|
| 60 | typedef union PDMQUEUEITEMCORE
|
|---|
| 61 | {
|
|---|
| 62 | /** The next queue item on the pending list (UINT32_MAX for NIL). */
|
|---|
| 63 | uint32_t volatile iNext;
|
|---|
| 64 | /** The next item about to be flushed. */
|
|---|
| 65 | R3PTRTYPE(PPDMQUEUEITEMCORE) pNext;
|
|---|
| 66 | /** Make sure the core is 64-bit wide. */
|
|---|
| 67 | uint64_t u64View;
|
|---|
| 68 | } PDMQUEUEITEMCORE;
|
|---|
| 69 |
|
|---|
| 70 |
|
|---|
| 71 | /**
|
|---|
| 72 | * Queue consumer callback for devices.
|
|---|
| 73 | *
|
|---|
| 74 | * @returns Success indicator.
|
|---|
| 75 | * If false the item will not be removed and the flushing will stop.
|
|---|
| 76 | * @param pDevIns The device instance.
|
|---|
| 77 | * @param pItem The item to consume. Upon return this item will be freed.
|
|---|
| 78 | * @remarks The device critical section will NOT be entered before calling the
|
|---|
| 79 | * callback. No locks will be held, but for now it's safe to assume
|
|---|
| 80 | * that only one EMT will do queue callbacks at any one time.
|
|---|
| 81 | */
|
|---|
| 82 | typedef DECLCALLBACKTYPE(bool, FNPDMQUEUEDEV,(PPDMDEVINS pDevIns, PPDMQUEUEITEMCORE pItem));
|
|---|
| 83 | /** Pointer to a FNPDMQUEUEDEV(). */
|
|---|
| 84 | typedef FNPDMQUEUEDEV *PFNPDMQUEUEDEV;
|
|---|
| 85 |
|
|---|
| 86 | /**
|
|---|
| 87 | * Queue consumer callback for USB devices.
|
|---|
| 88 | *
|
|---|
| 89 | * @returns Success indicator.
|
|---|
| 90 | * If false the item will not be removed and the flushing will stop.
|
|---|
| 91 | * @param pUsbIns The USB device instance.
|
|---|
| 92 | * @param pItem The item to consume. Upon return this item will be freed.
|
|---|
| 93 | * @remarks No locks will be held, but for now it's safe to assume that only one
|
|---|
| 94 | * EMT will do queue callbacks at any one time.
|
|---|
| 95 | */
|
|---|
| 96 | typedef DECLCALLBACKTYPE(bool, FNPDMQUEUEUSB,(PPDMUSBINS pUsbIns, PPDMQUEUEITEMCORE pItem));
|
|---|
| 97 | /** Pointer to a FNPDMQUEUEUSB(). */
|
|---|
| 98 | typedef FNPDMQUEUEUSB *PFNPDMQUEUEUSB;
|
|---|
| 99 |
|
|---|
| 100 | /**
|
|---|
| 101 | * Queue consumer callback for drivers.
|
|---|
| 102 | *
|
|---|
| 103 | * @returns Success indicator.
|
|---|
| 104 | * If false the item will not be removed and the flushing will stop.
|
|---|
| 105 | * @param pDrvIns The driver instance.
|
|---|
| 106 | * @param pItem The item to consume. Upon return this item will be freed.
|
|---|
| 107 | * @remarks No locks will be held, but for now it's safe to assume that only one
|
|---|
| 108 | * EMT will do queue callbacks at any one time.
|
|---|
| 109 | */
|
|---|
| 110 | typedef DECLCALLBACKTYPE(bool, FNPDMQUEUEDRV,(PPDMDRVINS pDrvIns, PPDMQUEUEITEMCORE pItem));
|
|---|
| 111 | /** Pointer to a FNPDMQUEUEDRV(). */
|
|---|
| 112 | typedef FNPDMQUEUEDRV *PFNPDMQUEUEDRV;
|
|---|
| 113 |
|
|---|
| 114 | /**
|
|---|
| 115 | * Queue consumer callback for internal component.
|
|---|
| 116 | *
|
|---|
| 117 | * @returns Success indicator.
|
|---|
| 118 | * If false the item will not be removed and the flushing will stop.
|
|---|
| 119 | * @param pVM The cross context VM structure.
|
|---|
| 120 | * @param pItem The item to consume. Upon return this item will be freed.
|
|---|
| 121 | * @remarks No locks will be held, but for now it's safe to assume that only one
|
|---|
| 122 | * EMT will do queue callbacks at any one time.
|
|---|
| 123 | */
|
|---|
| 124 | typedef DECLCALLBACKTYPE(bool, FNPDMQUEUEINT,(PVM pVM, PPDMQUEUEITEMCORE pItem));
|
|---|
| 125 | /** Pointer to a FNPDMQUEUEINT(). */
|
|---|
| 126 | typedef FNPDMQUEUEINT *PFNPDMQUEUEINT;
|
|---|
| 127 |
|
|---|
| 128 | /**
|
|---|
| 129 | * Queue consumer callback for external component.
|
|---|
| 130 | *
|
|---|
| 131 | * @returns Success indicator.
|
|---|
| 132 | * If false the item will not be removed and the flushing will stop.
|
|---|
| 133 | * @param pvUser User argument.
|
|---|
| 134 | * @param pItem The item to consume. Upon return this item will be freed.
|
|---|
| 135 | * @remarks No locks will be held, but for now it's safe to assume that only one
|
|---|
| 136 | * EMT will do queue callbacks at any one time.
|
|---|
| 137 | */
|
|---|
| 138 | typedef DECLCALLBACKTYPE(bool, FNPDMQUEUEEXT,(void *pvUser, PPDMQUEUEITEMCORE pItem));
|
|---|
| 139 | /** Pointer to a FNPDMQUEUEEXT(). */
|
|---|
| 140 | typedef FNPDMQUEUEEXT *PFNPDMQUEUEEXT;
|
|---|
| 141 |
|
|---|
| 142 | #ifdef VBOX_IN_VMM
|
|---|
| 143 | VMMR3_INT_DECL(int) PDMR3QueueCreateDevice(PVM pVM, PPDMDEVINS pDevIns, size_t cbItem, uint32_t cItems,
|
|---|
| 144 | uint32_t cMilliesInterval, PFNPDMQUEUEDEV pfnCallback,
|
|---|
| 145 | bool fRZEnabled, const char *pszName, PDMQUEUEHANDLE *phQueue);
|
|---|
| 146 | VMMR3_INT_DECL(int) PDMR3QueueCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, size_t cbItem, uint32_t cItems,
|
|---|
| 147 | uint32_t cMilliesInterval, PFNPDMQUEUEDRV pfnCallback,
|
|---|
| 148 | const char *pszName, PDMQUEUEHANDLE *phQueue);
|
|---|
| 149 | VMMR3_INT_DECL(int) PDMR3QueueCreateInternal(PVM pVM, size_t cbItem, uint32_t cItems,
|
|---|
| 150 | uint32_t cMilliesInterval, PFNPDMQUEUEINT pfnCallback,
|
|---|
| 151 | bool fRZEnabled, const char *pszName, PDMQUEUEHANDLE *phQueue);
|
|---|
| 152 | VMMR3DECL(int) PDMR3QueueCreateExternal(PVM pVM, size_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
|
|---|
| 153 | PFNPDMQUEUEEXT pfnCallback, void *pvUser, const char *pszName, PDMQUEUEHANDLE *phQueue);
|
|---|
| 154 | VMMR3DECL(int) PDMR3QueueDestroy(PVM pVM, PDMQUEUEHANDLE hQueue, void *pvOwner);
|
|---|
| 155 | VMMR3_INT_DECL(int) PDMR3QueueDestroyDevice(PVM pVM, PPDMDEVINS pDevIns);
|
|---|
| 156 | VMMR3_INT_DECL(int) PDMR3QueueDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns);
|
|---|
| 157 | VMMR3DECL(void) PDMR3QueueFlushAll(PVM pVM);
|
|---|
| 158 | #endif /* VBOX_IN_VMM */
|
|---|
| 159 |
|
|---|
| 160 | VMMDECL(PPDMQUEUEITEMCORE) PDMQueueAlloc(PVMCC pVM, PDMQUEUEHANDLE hQueue, void *pvOwner);
|
|---|
| 161 | VMMDECL(int) PDMQueueInsert(PVMCC pVM, PDMQUEUEHANDLE hQueue, void *pvOwner, PPDMQUEUEITEMCORE pInsert);
|
|---|
| 162 | VMMDECL(int) PDMQueueFlushIfNecessary(PVMCC pVM, PDMQUEUEHANDLE hQueue, void *pvOwner);
|
|---|
| 163 |
|
|---|
| 164 | /** @} */
|
|---|
| 165 |
|
|---|
| 166 | RT_C_DECLS_END
|
|---|
| 167 |
|
|---|
| 168 | #endif /* !VBOX_INCLUDED_vmm_pdmqueue_h */
|
|---|
| 169 |
|
|---|
