1 | /** @file
|
---|
2 | * PDM - Pluggable Device Manager, Critical Sections. (VMM)
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2006-2007 Sun Microsystems, Inc.
|
---|
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
|
---|
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.
|
---|
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.
|
---|
28 | */
|
---|
29 |
|
---|
30 | #ifndef ___VBox_pdmcritsect_h
|
---|
31 | #define ___VBox_pdmcritsect_h
|
---|
32 |
|
---|
33 | #include <VBox/types.h>
|
---|
34 | #include <iprt/critsect.h>
|
---|
35 |
|
---|
36 | RT_C_DECLS_BEGIN
|
---|
37 |
|
---|
38 | /** @defgroup grp_pdm_critsect The PDM Critical Section API
|
---|
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 == 32 ? 0x80 : 0xc0];
|
---|
51 | #ifdef PDMCRITSECTINT_DECLARED
|
---|
52 | /** The internal structure (not normally visible). */
|
---|
53 | struct PDMCRITSECTINT s;
|
---|
54 | #endif
|
---|
55 | } PDMCRITSECT;
|
---|
56 |
|
---|
57 | VMMR3DECL(int) PDMR3CritSectInit(PVM pVM, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszNameFmt, ...);
|
---|
58 | VMMDECL(int) PDMCritSectEnter(PPDMCRITSECT pCritSect, int rcBusy);
|
---|
59 | VMMDECL(int) PDMCritSectEnterDebug(PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL);
|
---|
60 | VMMDECL(int) PDMCritSectTryEnter(PPDMCRITSECT pCritSect);
|
---|
61 | VMMDECL(int) PDMCritSectTryEnterDebug(PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL);
|
---|
62 | VMMR3DECL(int) PDMR3CritSectEnterEx(PPDMCRITSECT pCritSect, bool fCallRing3);
|
---|
63 | VMMDECL(void) PDMCritSectLeave(PPDMCRITSECT pCritSect);
|
---|
64 | VMMDECL(bool) PDMCritSectIsOwner(PCPDMCRITSECT pCritSect);
|
---|
65 | VMMDECL(bool) PDMCritSectIsOwnerEx(PCPDMCRITSECT pCritSect, VMCPUID idCpu);
|
---|
66 | VMMDECL(bool) PDMCritSectIsOwned(PCPDMCRITSECT pCritSect);
|
---|
67 | VMMDECL(bool) PDMCritSectIsInitialized(PCPDMCRITSECT pCritSect);
|
---|
68 | VMMDECL(bool) PDMCritSectHasWaiters(PCPDMCRITSECT pCritSect);
|
---|
69 | VMMDECL(uint32_t) PDMCritSectGetRecursion(PCPDMCRITSECT pCritSect);
|
---|
70 | VMMR3DECL(bool) PDMR3CritSectYield(PPDMCRITSECT pCritSect);
|
---|
71 | VMMR3DECL(const char *) PDMR3CritSectName(PCPDMCRITSECT pCritSect);
|
---|
72 | VMMR3DECL(int) PDMR3CritSectScheduleExitEvent(PPDMCRITSECT pCritSect, RTSEMEVENT EventToSignal);
|
---|
73 | VMMR3DECL(int) PDMR3CritSectDelete(PPDMCRITSECT pCritSect);
|
---|
74 | VMMDECL(int) PDMR3CritSectTerm(PVM pVM);
|
---|
75 | VMMDECL(void) PDMCritSectFF(PVMCPU pVCpu);
|
---|
76 | VMMR3DECL(uint32_t) PDMR3CritSectCountOwned(PVM pVM, char *pszNames, size_t cbNames);
|
---|
77 | VMMR3DECL(void) PDMR3CritSectLeaveAll(PVM pVM);
|
---|
78 |
|
---|
79 | /* Strict build: Remap the two enter calls to the debug versions. */
|
---|
80 | #ifdef VBOX_STRICT
|
---|
81 | # ifdef ___iprt_asm_h
|
---|
82 | # define PDMCritSectEnter(pCritSect, rcBusy) PDMCritSectEnterDebug((pCritSect), (rcBusy), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
|
---|
83 | # define PDMCritSectTryEnter(pCritSect) PDMCritSectTryEnterDebug((pCritSect), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
|
---|
84 | # else
|
---|
85 | # define PDMCritSectEnter(pCritSect, rcBusy) PDMCritSectEnterDebug((pCritSect), (rcBusy), 0, RT_SRC_POS)
|
---|
86 | # define PDMCritSectTryEnter(pCritSect) PDMCritSectTryEnterDebug((pCritSect), 0, RT_SRC_POS)
|
---|
87 | # endif
|
---|
88 | #endif
|
---|
89 |
|
---|
90 | /** @} */
|
---|
91 |
|
---|
92 | RT_C_DECLS_END
|
---|
93 |
|
---|
94 | #endif
|
---|
95 |
|
---|