VirtualBox

source: vbox/trunk/include/iprt/spinlock.h@ 40453

Last change on this file since 40453 was 28800, checked in by vboxsync, 15 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.1 KB
Line 
1/** @file
2 * IPRT - Spinlocks.
3 */
4
5/*
6 * Copyright (C) 2006-2007 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 ___iprt_spinlock_h
27#define ___iprt_spinlock_h
28
29#include <iprt/cdefs.h>
30#include <iprt/types.h>
31
32RT_C_DECLS_BEGIN
33
34
35/** @defgroup grp_rt_spinlock RTSpinlock - Spinlocks
36 * @ingroup grp_rt
37 * @{
38 */
39
40/**
41 * Temporary spinlock state variable.
42 * All members are undefined and highly platform specific.
43 */
44typedef struct RTSPINLOCKTMP
45{
46#ifdef IN_RING0
47# ifdef RT_OS_LINUX
48 /** The saved [R|E]FLAGS. */
49 unsigned long flFlags;
50# define RTSPINLOCKTMP_INITIALIZER { 0 }
51
52# elif defined(RT_OS_WINDOWS)
53 /** The saved [R|E]FLAGS. */
54 RTCCUINTREG uFlags;
55 /** The KIRQL. */
56 unsigned char uchIrqL;
57# define RTSPINLOCKTMP_INITIALIZER { 0, 0 }
58
59# elif defined(__L4__)
60 /** The saved [R|E]FLAGS. */
61 unsigned long flFlags;
62# define RTSPINLOCKTMP_INITIALIZER { 0 }
63
64# elif defined(RT_OS_DARWIN) || defined(RT_OS_FREEBSD) || defined(RT_OS_SOLARIS)
65 /** The saved [R|E]FLAGS. */
66 RTCCUINTREG uFlags;
67# define RTSPINLOCKTMP_INITIALIZER { 0 }
68
69# elif defined(RT_OS_OS2)
70 /** The saved [R|E]FLAGS. (dummy) */
71 RTCCUINTREG uFlags;
72# define RTSPINLOCKTMP_INITIALIZER { 0 }
73
74# else
75# error "PORTME\n"
76 /** The saved [R|E]FLAGS. */
77 RTCCUINTREG uFlags;
78# endif
79
80#else /* !IN_RING0 */
81 /** The saved [R|E]FLAGS. (dummy) */
82 RTCCUINTREG uFlags;
83# define RTSPINLOCKTMP_INITIALIZER { 0 }
84#endif /* !IN_RING0 */
85} RTSPINLOCKTMP;
86/** Pointer to a temporary spinlock state variable. */
87typedef RTSPINLOCKTMP *PRTSPINLOCKTMP;
88/** Pointer to a const temporary spinlock state variable. */
89typedef const RTSPINLOCKTMP *PCRTSPINLOCKTMP;
90
91/** @def RTSPINLOCKTMP_INITIALIZER
92 * What to assign to a RTSPINLOCKTMP at definition.
93 */
94#ifdef DOXYGEN_RUNNING
95# define RTSPINLOCKTMP_INITIALIZER
96#endif
97
98
99
100/**
101 * Creates a spinlock.
102 *
103 * @returns iprt status code.
104 * @param pSpinlock Where to store the spinlock handle.
105 */
106RTDECL(int) RTSpinlockCreate(PRTSPINLOCK pSpinlock);
107
108/**
109 * Destroys a spinlock created by RTSpinlockCreate().
110 *
111 * @returns iprt status code.
112 * @param Spinlock Spinlock returned by RTSpinlockCreate().
113 */
114RTDECL(int) RTSpinlockDestroy(RTSPINLOCK Spinlock);
115
116/**
117 * Acquires the spinlock.
118 * Interrupts are disabled upon return.
119 *
120 * @param Spinlock The spinlock to acquire.
121 * @param pTmp Where to save the state.
122 */
123RTDECL(void) RTSpinlockAcquireNoInts(RTSPINLOCK Spinlock, PRTSPINLOCKTMP pTmp);
124
125/**
126 * Releases the spinlock.
127 *
128 * @param Spinlock The spinlock to acquire.
129 * @param pTmp The state to restore. (This better be the same as for the RTSpinlockAcquire() call!)
130 */
131RTDECL(void) RTSpinlockReleaseNoInts(RTSPINLOCK Spinlock, PRTSPINLOCKTMP pTmp);
132
133/**
134 * Acquires the spinlock.
135 *
136 * @param Spinlock The spinlock to acquire.
137 * @param pTmp Where to save the state.
138 */
139RTDECL(void) RTSpinlockAcquire(RTSPINLOCK Spinlock, PRTSPINLOCKTMP pTmp);
140
141/**
142 * Releases the spinlock.
143 *
144 * @param Spinlock The spinlock to acquire.
145 * @param pTmp The state to restore. (This better be the same as for the RTSpinlockAcquire() call!)
146 */
147RTDECL(void) RTSpinlockRelease(RTSPINLOCK Spinlock, PRTSPINLOCKTMP pTmp);
148
149
150/** @} */
151
152RT_C_DECLS_END
153
154#endif
155
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