VirtualBox

source: vbox/trunk/include/VBox/vmm/pdmtask.h@ 97150

Last change on this file since 97150 was 96407, checked in by vboxsync, 2 years ago

scm copyright and license note update

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.2 KB
Line 
1/** @file
2 * PDM - Pluggable Device Manager, Tasks.
3 */
4
5/*
6 * Copyright (C) 2019-2022 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_pdmtask_h
37#define VBOX_INCLUDED_vmm_pdmtask_h
38#ifndef RT_WITHOUT_PRAGMA_ONCE
39# pragma once
40#endif
41
42#include <VBox/types.h>
43
44RT_C_DECLS_BEGIN
45
46/** @defgroup grp_pdm_task The PDM Tasks API
47 * @ingroup grp_pdm
48 *
49 * A task is a predefined asynchronous procedure call that can be triggered from
50 * any context.
51 *
52 * @{
53 */
54
55/** PDM task handle. */
56typedef uint64_t PDMTASKHANDLE;
57/** NIL PDM task handle. */
58#define NIL_PDMTASKHANDLE UINT64_MAX
59
60
61/**
62 * Task worker callback for devices.
63 *
64 * @param pDevIns The device instance.
65 * @param pvUser The user parameter.
66 * @thread Task worker thread.
67 * @remarks The device critical section will NOT be entered before calling the
68 * callback. No other locks will be held either.
69 */
70typedef DECLCALLBACKTYPE(void, FNPDMTASKDEV,(PPDMDEVINS pDevIns, void *pvUser));
71/** Pointer to a FNPDMTASKDEV(). */
72typedef FNPDMTASKDEV *PFNPDMTASKDEV;
73
74/**
75 * Task worker callback for drivers.
76 *
77 * @param pDrvIns The driver instance.
78 * @param pvUser The user parameter.
79 * @thread Task worker thread.
80 * @remarks No other locks will be held.
81 */
82typedef DECLCALLBACKTYPE(void, FNPDMTASKDRV,(PPDMDRVINS pDrvIns, void *pvUser));
83/** Pointer to a FNPDMTASKDRV(). */
84typedef FNPDMTASKDRV *PFNPDMTASKDRV;
85
86/**
87 * Task worker callback for USB devices.
88 *
89 * @param pUsbIns The USB device instance.
90 * @param pvUser The user parameter.
91 * @thread Task worker thread.
92 * @remarks No other locks will be held.
93 */
94typedef DECLCALLBACKTYPE(void, FNPDMTASKUSB,(PPDMUSBINS pUsbIns, void *pvUser));
95/** Pointer to a FNPDMTASKUSB(). */
96typedef FNPDMTASKUSB *PFNPDMTASKUSB;
97
98/**
99 * Task worker callback for internal components.
100 *
101 * @param pVM The cross context VM structure.
102 * @param pvUser The user parameter.
103 * @thread Task worker thread.
104 * @remarks No other locks will be held.
105 */
106typedef DECLCALLBACKTYPE(void, FNPDMTASKINT,(PVM pVM, void *pvUser));
107/** Pointer to a FNPDMTASKINT(). */
108typedef FNPDMTASKINT *PFNPDMTASKINT;
109
110
111/** @name PDMTASK_F_XXX - Task creation flags.
112 * @{ */
113/** Create a ring-0 triggerable task. */
114#define PDMTASK_F_R0 RT_BIT_32(0)
115/** Create a raw-mode triggerable task. */
116#define PDMTASK_F_RC RT_BIT_32(1)
117/** Create a ring-0 and raw-mode triggerable task. */
118#define PDMTASK_F_RZ (PDMTASK_F_R0 | PDMTASK_F_RC)
119/** Valid flags. */
120#define PDMTASK_F_VALID_MASK UINT32_C(0x00000003)
121/** @} */
122
123#ifdef VBOX_IN_VMM
124/**
125 * Task owner type.
126 */
127typedef enum PDMTASKTYPE
128{
129 /** Invalid zero value. */
130 PDMTASKTYPE_INVALID = 0,
131 /** Device consumer. */
132 PDMTASKTYPE_DEV,
133 /** Driver consumer. */
134 PDMTASKTYPE_DRV,
135 /** USB device consumer. */
136 PDMTASKTYPE_USB,
137 /** Internal consumer. */
138 PDMTASKTYPE_INTERNAL,
139 /** End of valid values. */
140 PDMTASKTYPE_END,
141 /** Typical 32-bit type blowup. */
142 PDMTASKTYPE_32BIT_HACK = 0x7fffffff
143} PDMTASKTYPE;
144
145VMMR3_INT_DECL(int) PDMR3TaskCreate(PVM pVM, uint32_t fFlags, const char *pszName, PDMTASKTYPE enmType, void *pvOwner,
146 PFNRT pfnCallback, void *pvUser, PDMTASKHANDLE *phTask);
147VMMR3_INT_DECL(int) PDMR3TaskCreateInternal(PVM pVM, uint32_t fFlags, const char *pszName,
148 PFNPDMTASKINT pfnCallback, void *pvUser, PDMTASKHANDLE *phTask);
149VMMR3_INT_DECL(int) PDMR3TaskDestroyAllByOwner(PVM pVM, PDMTASKTYPE enmType, void *pvOwner);
150VMMR3_INT_DECL(int) PDMR3TaskDestroySpecific(PVM pVM, PDMTASKTYPE enmType, void *pvOwner, PDMTASKHANDLE hTask);
151VMMR3_INT_DECL(int) PDMR3TaskDestroyInternal(PVM pVM, PDMTASKHANDLE hTask);
152
153VMM_INT_DECL(int) PDMTaskTrigger(PVMCC pVM, PDMTASKTYPE enmType, RTR3PTR pvOwner, PDMTASKHANDLE hTask);
154VMM_INT_DECL(int) PDMTaskTriggerInternal(PVMCC pVM, PDMTASKHANDLE hTask);
155#endif /* VBOX_IN_VMM */
156
157/** @} */
158
159RT_C_DECLS_END
160
161#endif /* !VBOX_INCLUDED_vmm_pdmtask_h */
162
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette