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