[3854] | 1 | /** @file
|
---|
| 2 | * PDM - Pluggable Device Manager, Critical Sections.
|
---|
| 3 | */
|
---|
| 4 |
|
---|
| 5 | /*
|
---|
[8155] | 6 | * Copyright (C) 2006-2007 Sun Microsystems, Inc.
|
---|
[3854] | 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
|
---|
[5999] | 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.
|
---|
[8155] | 24 | *
|
---|
| 25 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
---|
| 26 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
---|
| 27 | * additional information or have any questions.
|
---|
[3854] | 28 | */
|
---|
| 29 |
|
---|
| 30 | #ifndef ___VBox_pdmcritsect_h
|
---|
| 31 | #define ___VBox_pdmcritsect_h
|
---|
| 32 |
|
---|
[4011] | 33 | #include <VBox/types.h>
|
---|
| 34 | #include <iprt/critsect.h>
|
---|
| 35 |
|
---|
[3854] | 36 | __BEGIN_DECLS
|
---|
| 37 |
|
---|
| 38 | /** @defgroup grp_pdm_critsect The PDM Critical Section
|
---|
| 39 | * @ingroup grp_pdm
|
---|
| 40 | * @{
|
---|
| 41 | */
|
---|
| 42 |
|
---|
| 43 | /**
|
---|
| 44 | * A PDM critical section.
|
---|
| 45 | * Initialize using PDMDRVHLP::pfnCritSectInit().
|
---|
| 46 | */
|
---|
| 47 | typedef union PDMCRITSECT
|
---|
| 48 | {
|
---|
| 49 | /** Padding. */
|
---|
| 50 | uint8_t padding[HC_ARCH_BITS == 64 ? 0xb8 : 0x80];
|
---|
| 51 | #ifdef PDMCRITSECTINT_DECLARED
|
---|
| 52 | /** The internal structure (not normally visible). */
|
---|
| 53 | struct PDMCRITSECTINT s;
|
---|
| 54 | #endif
|
---|
| 55 | } PDMCRITSECT;
|
---|
| 56 | /** Pointer to a PDM critical section. */
|
---|
| 57 | typedef PDMCRITSECT *PPDMCRITSECT;
|
---|
| 58 | /** Pointer to a const PDM critical section. */
|
---|
| 59 | typedef const PDMCRITSECT *PCPDMCRITSECT;
|
---|
| 60 |
|
---|
| 61 | /**
|
---|
| 62 | * Initializes a PDM critical section for internal use.
|
---|
| 63 | *
|
---|
| 64 | * The PDM critical sections are derived from the IPRT critical sections, but
|
---|
| 65 | * works in GC as well.
|
---|
| 66 | *
|
---|
| 67 | * @returns VBox status code.
|
---|
| 68 | * @param pVM The VM handle.
|
---|
| 69 | * @param pDevIns Device instance.
|
---|
| 70 | * @param pCritSect Pointer to the critical section.
|
---|
| 71 | * @param pszName The name of the critical section (for statistics).
|
---|
| 72 | */
|
---|
| 73 | PDMR3DECL(int) PDMR3CritSectInit(PVM pVM, PPDMCRITSECT pCritSect, const char *pszName);
|
---|
| 74 |
|
---|
| 75 | /**
|
---|
| 76 | * Leaves a critical section entered with PDMCritSectEnter().
|
---|
| 77 | *
|
---|
| 78 | * @returns VINF_SUCCESS if entered successfully.
|
---|
| 79 | * @returns rcBusy when encountering a busy critical section in GC/R0.
|
---|
| 80 | * @returns VERR_SEM_DESTROYED if the critical section is dead.
|
---|
| 81 | *
|
---|
| 82 | * @param pCritSect The PDM critical section to enter.
|
---|
| 83 | * @param rcBusy The status code to return when we're in GC or R0
|
---|
| 84 | * and the section is busy.
|
---|
| 85 | */
|
---|
| 86 | PDMDECL(int) PDMCritSectEnter(PPDMCRITSECT pCritSect, int rcBusy);
|
---|
| 87 |
|
---|
| 88 | /**
|
---|
| 89 | * Leaves a critical section entered with PDMCritSectEnter().
|
---|
| 90 | *
|
---|
| 91 | * @param pCritSect The PDM critical section to leave.
|
---|
| 92 | */
|
---|
| 93 | PDMDECL(void) PDMCritSectLeave(PPDMCRITSECT pCritSect);
|
---|
| 94 |
|
---|
| 95 | /**
|
---|
| 96 | * Checks the caller is the owner of the critical section.
|
---|
| 97 | *
|
---|
| 98 | * @returns true if owner.
|
---|
| 99 | * @returns false if not owner.
|
---|
| 100 | * @param pCritSect The critical section.
|
---|
| 101 | */
|
---|
| 102 | PDMDECL(bool) PDMCritSectIsOwner(PCPDMCRITSECT pCritSect);
|
---|
| 103 |
|
---|
| 104 | /**
|
---|
[4403] | 105 | * Checks if a critical section is initialized or not.
|
---|
| 106 | *
|
---|
| 107 | * @returns true if initialized.
|
---|
| 108 | * @returns false if not initialized.
|
---|
| 109 | * @param pCritSect The critical section.
|
---|
| 110 | */
|
---|
| 111 | PDMDECL(bool) PDMCritSectIsInitialized(PCPDMCRITSECT pCritSect);
|
---|
| 112 |
|
---|
| 113 | /**
|
---|
[3854] | 114 | * Try enter a critical section.
|
---|
| 115 | *
|
---|
| 116 | * @returns VINF_SUCCESS on success.
|
---|
| 117 | * @returns VERR_SEM_BUSY if the critsect was owned.
|
---|
| 118 | * @returns VERR_SEM_NESTED if nested enter on a no nesting section. (Asserted.)
|
---|
| 119 | * @returns VERR_SEM_DESTROYED if RTCritSectDelete was called while waiting.
|
---|
| 120 | * @param pCritSect The critical section.
|
---|
| 121 | */
|
---|
| 122 | PDMR3DECL(int) PDMR3CritSectTryEnter(PPDMCRITSECT pCritSect);
|
---|
| 123 |
|
---|
| 124 | /**
|
---|
| 125 | * Schedule a event semaphore for signalling upon critsect exit.
|
---|
| 126 | *
|
---|
| 127 | * @returns VINF_SUCCESS on success.
|
---|
| 128 | * @returns VERR_TOO_MANY_SEMAPHORES if an event was already scheduled.
|
---|
| 129 | * @returns VERR_NOT_OWNER if we're not the critsect owner.
|
---|
| 130 | * @returns VERR_SEM_DESTROYED if RTCritSectDelete was called while waiting.
|
---|
| 131 | * @param pCritSect The critical section.
|
---|
| 132 | * @param EventToSignal The semapore that should be signalled.
|
---|
| 133 | */
|
---|
| 134 | PDMR3DECL(int) PDMR3CritSectScheduleExitEvent(PPDMCRITSECT pCritSect, RTSEMEVENT EventToSignal);
|
---|
| 135 |
|
---|
| 136 | /**
|
---|
| 137 | * Deletes the critical section.
|
---|
| 138 | *
|
---|
| 139 | * @returns VBox status code.
|
---|
| 140 | * @param pCritSect The PDM critical section to destroy.
|
---|
| 141 | */
|
---|
| 142 | PDMR3DECL(int) PDMR3CritSectDelete(PPDMCRITSECT pCritSect);
|
---|
| 143 |
|
---|
| 144 | /**
|
---|
| 145 | * Deletes all remaining critical sections.
|
---|
| 146 | *
|
---|
| 147 | * This is called at the end of the termination process.
|
---|
| 148 | *
|
---|
| 149 | * @returns VBox status.
|
---|
| 150 | * First error code, rest is lost.
|
---|
| 151 | * @param pVM The VM handle.
|
---|
| 152 | * @remark Don't confuse this with PDMR3CritSectDelete.
|
---|
| 153 | */
|
---|
| 154 | PDMDECL(int) PDMR3CritSectTerm(PVM pVM);
|
---|
| 155 |
|
---|
| 156 | /**
|
---|
| 157 | * Process the critical sections queued for ring-3 'leave'.
|
---|
| 158 | *
|
---|
| 159 | * @param pVM The VM handle.
|
---|
| 160 | */
|
---|
| 161 | PDMR3DECL(void) PDMR3CritSectFF(PVM pVM);
|
---|
| 162 |
|
---|
| 163 | /** @} */
|
---|
| 164 |
|
---|
| 165 | __END_DECLS
|
---|
| 166 |
|
---|
| 167 | #endif
|
---|
| 168 |
|
---|