1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
|
/** @file
* IPRT - Spinlocks.
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___iprt_spinlock_h
#define ___iprt_spinlock_h
#include <iprt/cdefs.h>
#include <iprt/types.h>
__BEGIN_DECLS
/** @defgroup grp_rt_spinlock RTSpinlock - Spinlocks
* @ingroup grp_rt
* @{
*/
/**
* Temporary spinlock state variable.
* All members are undefined and highly platform specific.
*/
typedef struct RTSPINLOCKTMP
{
#ifdef IN_RING0
# ifdef RT_OS_LINUX
/** The saved [R|E]FLAGS. */
unsigned long flFlags;
# define RTSPINLOCKTMP_INITIALIZER { 0 }
# elif defined(RT_OS_WINDOWS)
/** The saved [R|E]FLAGS. */
RTUINTREG uFlags;
/** The KIRQL. */
unsigned char uchIrqL;
# define RTSPINLOCKTMP_INITIALIZER { 0, 0 }
# elif defined(__L4__)
/** The saved [R|E]FLAGS. */
unsigned long flFlags;
# define RTSPINLOCKTMP_INITIALIZER { 0 }
# elif defined(RT_OS_DARWIN)
/** The saved [R|E]FLAGS. */
RTUINTREG uFlags;
# define RTSPINLOCKTMP_INITIALIZER { 0 }
# elif defined(RT_OS_OS2) || defined(RT_OS_FREEBSD) || defined(RT_OS_SOLARIS)
/** The saved [R|E]FLAGS. (dummy) */
RTUINTREG uFlags;
# define RTSPINLOCKTMP_INITIALIZER { 0 }
# else
# error "Your OS is not supported.\n"
/** The saved [R|E]FLAGS. */
RTUINTREG uFlags;
# endif
#else /* !IN_RING0 */
/** The saved [R|E]FLAGS.
* (RT spinlocks will by definition disable interrupts.) */
RTUINTREG uFlags;
# define RTSPINLOCKTMP_INITIALIZER { 0 }
#endif /* !IN_RING0 */
} RTSPINLOCKTMP;
/** Pointer to a temporary spinlock state variable. */
typedef RTSPINLOCKTMP *PRTSPINLOCKTMP;
/** Pointer to a const temporary spinlock state variable. */
typedef const RTSPINLOCKTMP *PCRTSPINLOCKTMP;
/** @def RTSPINLOCKTMP_INITIALIZER
* What to assign to a RTSPINLOCKTMP at definition.
*/
#ifdef DOXYGEN_RUNNING
# define RTSPINLOCKTMP_INITIALIZER
#endif
/**
* Creates a spinlock.
*
* @returns iprt status code.
* @param pSpinlock Where to store the spinlock handle.
*/
RTDECL(int) RTSpinlockCreate(PRTSPINLOCK pSpinlock);
/**
* Destroys a spinlock created by RTSpinlockCreate().
*
* @returns iprt status code.
* @param Spinlock Spinlock returned by RTSpinlockCreate().
*/
RTDECL(int) RTSpinlockDestroy(RTSPINLOCK Spinlock);
/**
* Acquires the spinlock.
* Interrupts are disabled upon return.
*
* @param Spinlock The spinlock to acquire.
* @param pTmp Where to save the state.
*/
RTDECL(void) RTSpinlockAcquireNoInts(RTSPINLOCK Spinlock, PRTSPINLOCKTMP pTmp);
/**
* Releases the spinlock.
*
* @param Spinlock The spinlock to acquire.
* @param pTmp The state to restore. (This better be the same as for the RTSpinlockAcquire() call!)
*/
RTDECL(void) RTSpinlockReleaseNoInts(RTSPINLOCK Spinlock, PRTSPINLOCKTMP pTmp);
/**
* Acquires the spinlock.
*
* @param Spinlock The spinlock to acquire.
* @param pTmp Where to save the state.
*/
RTDECL(void) RTSpinlockAcquire(RTSPINLOCK Spinlock, PRTSPINLOCKTMP pTmp);
/**
* Releases the spinlock.
*
* @param Spinlock The spinlock to acquire.
* @param pTmp The state to restore. (This better be the same as for the RTSpinlockAcquire() call!)
*/
RTDECL(void) RTSpinlockRelease(RTSPINLOCK Spinlock, PRTSPINLOCKTMP pTmp);
/** @} */
__END_DECLS
#endif
|