VirtualBox

source: vbox/trunk/include/VBox/vmm/pdmcritsect.h@ 67180

Last change on this file since 67180 was 62476, checked in by vboxsync, 8 years ago

(C) 2016

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 4.0 KB
Line 
1/** @file
2 * PDM - Pluggable Device Manager, Critical Sections.
3 */
4
5/*
6 * Copyright (C) 2006-2016 Oracle Corporation
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
26#ifndef ___VBox_vmm_pdmcritsect_h
27#define ___VBox_vmm_pdmcritsect_h
28
29#include <VBox/types.h>
30#include <iprt/critsect.h>
31
32
33RT_C_DECLS_BEGIN
34
35/** @defgroup grp_pdm_critsect The PDM Critical Section API
36 * @ingroup grp_pdm
37 * @{
38 */
39
40/**
41 * A PDM critical section.
42 * Initialize using PDMDRVHLP::pfnCritSectInit().
43 */
44typedef union PDMCRITSECT
45{
46 /** Padding. */
47 uint8_t padding[HC_ARCH_BITS == 32 ? 0x80 : 0xc0];
48#ifdef PDMCRITSECTINT_DECLARED
49 /** The internal structure (not normally visible). */
50 struct PDMCRITSECTINT s;
51#endif
52} PDMCRITSECT;
53
54VMMR3_INT_DECL(int) PDMR3CritSectBothTerm(PVM pVM);
55VMMR3_INT_DECL(void) PDMR3CritSectLeaveAll(PVM pVM);
56VMM_INT_DECL(void) PDMCritSectBothFF(PVMCPU pVCpu);
57
58
59VMMR3DECL(uint32_t) PDMR3CritSectCountOwned(PVM pVM, char *pszNames, size_t cbNames);
60
61VMMR3DECL(int) PDMR3CritSectInit(PVM pVM, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL,
62 const char *pszNameFmt, ...) RT_IPRT_FORMAT_ATTR(6, 7);
63VMMR3DECL(int) PDMR3CritSectEnterEx(PPDMCRITSECT pCritSect, bool fCallRing3);
64VMMR3DECL(bool) PDMR3CritSectYield(PPDMCRITSECT pCritSect);
65VMMR3DECL(const char *) PDMR3CritSectName(PCPDMCRITSECT pCritSect);
66VMMR3DECL(int) PDMR3CritSectDelete(PPDMCRITSECT pCritSect);
67#if defined(IN_RING0) || defined(IN_RING3)
68VMMDECL(int) PDMHCCritSectScheduleExitEvent(PPDMCRITSECT pCritSect, SUPSEMEVENT hEventToSignal);
69#endif
70
71VMMDECL(int) PDMCritSectEnter(PPDMCRITSECT pCritSect, int rcBusy);
72VMMDECL(int) PDMCritSectEnterDebug(PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL);
73VMMDECL(int) PDMCritSectTryEnter(PPDMCRITSECT pCritSect);
74VMMDECL(int) PDMCritSectTryEnterDebug(PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL);
75VMMDECL(int) PDMCritSectLeave(PPDMCRITSECT pCritSect);
76
77VMMDECL(bool) PDMCritSectIsOwner(PCPDMCRITSECT pCritSect);
78VMMDECL(bool) PDMCritSectIsOwnerEx(PCPDMCRITSECT pCritSect, PVMCPU pVCpu);
79VMMDECL(bool) PDMCritSectIsInitialized(PCPDMCRITSECT pCritSect);
80VMMDECL(bool) PDMCritSectHasWaiters(PCPDMCRITSECT pCritSect);
81VMMDECL(uint32_t) PDMCritSectGetRecursion(PCPDMCRITSECT pCritSect);
82
83VMMR3DECL(PPDMCRITSECT) PDMR3CritSectGetNop(PVM pVM);
84VMMR3DECL(R0PTRTYPE(PPDMCRITSECT)) PDMR3CritSectGetNopR0(PVM pVM);
85VMMR3DECL(RCPTRTYPE(PPDMCRITSECT)) PDMR3CritSectGetNopRC(PVM pVM);
86
87/* Strict build: Remap the two enter calls to the debug versions. */
88#ifdef VBOX_STRICT
89# ifdef ___iprt_asm_h
90# define PDMCritSectEnter(pCritSect, rcBusy) PDMCritSectEnterDebug((pCritSect), (rcBusy), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
91# define PDMCritSectTryEnter(pCritSect) PDMCritSectTryEnterDebug((pCritSect), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
92# else
93# define PDMCritSectEnter(pCritSect, rcBusy) PDMCritSectEnterDebug((pCritSect), (rcBusy), 0, RT_SRC_POS)
94# define PDMCritSectTryEnter(pCritSect) PDMCritSectTryEnterDebug((pCritSect), 0, RT_SRC_POS)
95# endif
96#endif
97
98/** @} */
99
100RT_C_DECLS_END
101
102#endif
103
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