WebSVN – HelenOS – Diff – /trunk/kernel/generic/include/synch/spinlock.h


/*
 * Copyright (c) 2001-2004 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup sync
 * @{
 */
/** @file
 */
 
#ifndef KERN_SPINLOCK_H_
#define KERN_SPINLOCK_H_
 
#include <arch/types.h>
#include <preemption.h>
#include <atomic.h>
#include <debug.h>
 
#ifdef CONFIG_SMP
typedef struct {
#ifdef CONFIG_DEBUG_SPINLOCK
    char *name;
#endif
    atomic_t val;
} spinlock_t;
 
/*
 * SPINLOCK_DECLARE is to be used for dynamically allocated spinlocks,
 * where the lock gets initialized in run time.
 */
#define SPINLOCK_DECLARE(slname)    spinlock_t slname
#define SPINLOCK_EXTERN(slname)     extern spinlock_t slname
 
/*
 * SPINLOCK_INITIALIZE is to be used for statically allocated spinlocks.
 * It declares and initializes the lock.
 */
#ifdef CONFIG_DEBUG_SPINLOCK
#define SPINLOCK_INITIALIZE(slname)     \
    spinlock_t slname = {       \
        .name = #slname,    \
        .val = { 0 }        \
    }
#else
#define SPINLOCK_INITIALIZE(slname)     \
    spinlock_t slname = {       \
        .val = { 0 }        \
    }
#endif
 
extern void spinlock_initialize(spinlock_t *sl, char *name);
extern int spinlock_trylock(spinlock_t *sl);
extern void spinlock_lock_debug(spinlock_t *sl);
 
#ifdef CONFIG_DEBUG_SPINLOCK
#  define spinlock_lock(x) spinlock_lock_debug(x)
#else
#  define spinlock_lock(x) atomic_lock_arch(&(x)->val)
#endif
 
/** Unlock spinlock
 *
 * Unlock spinlock.
 *
 * @param sl Pointer to spinlock_t structure.
 */
static inline void spinlock_unlock(spinlock_t *sl)
{
    ASSERT(atomic_get(&sl->val) != 0);
 
    /*
     * Prevent critical section code from bleeding out this way down.
     */
    CS_LEAVE_BARRIER();
   
    atomic_set(&sl->val, 0);
    preemption_enable();
}
 
#else
 
 
 
/* On UP systems, spinlocks are effectively left out. */
#define SPINLOCK_DECLARE(name)
#define SPINLOCK_EXTERN(name)
#define SPINLOCK_INITIALIZE(name)
 
#define spinlock_initialize(x, name)
#define spinlock_lock(x)        preemption_disable()
#define spinlock_trylock(x)         (preemption_disable(), 1)
#define spinlock_unlock(x)      preemption_enable()
 
#endif
 
#endif
 
/** @}
 */
 

Rev 2089	Rev 2093
1	/*	1	/*
2	* Copyright (c) 2001-2004 Jakub Jermar	2	* Copyright (c) 2001-2004 Jakub Jermar
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup sync	29	/** @addtogroup sync
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef KERN_SPINLOCK_H_	35	#ifndef KERN_SPINLOCK_H_
36	#define KERN_SPINLOCK_H_	36	#define KERN_SPINLOCK_H_
37		37
38	#include <arch/types.h>	38	#include <arch/types.h>
39	#include <preemption.h>	39	#include <preemption.h>
40	#include <atomic.h>	40	#include <atomic.h>
41	#include <debug.h>	41	#include <debug.h>
42		42
43	#ifdef CONFIG_SMP	43	#ifdef CONFIG_SMP
44	typedef struct {	44	typedef struct {
45	#ifdef CONFIG_DEBUG_SPINLOCK	45	#ifdef CONFIG_DEBUG_SPINLOCK
46	char *name;	46	char *name;
47	#endif	47	#endif
48	atomic_t val;	48	atomic_t val;
49	} spinlock_t;	49	} spinlock_t;
50		50
51	/*	51	/*
52	* SPINLOCK_DECLARE is to be used for dynamically allocated spinlocks,	52	* SPINLOCK_DECLARE is to be used for dynamically allocated spinlocks,
53	* where the lock gets initialized in run time.	53	* where the lock gets initialized in run time.
54	*/	54	*/
55	#define SPINLOCK_DECLARE(slname) spinlock_t slname	55	#define SPINLOCK_DECLARE(slname) spinlock_t slname
-		56	#define SPINLOCK_EXTERN(slname) extern spinlock_t slname
56		57
57	/*	58	/*
58	* SPINLOCK_INITIALIZE is to be used for statically allocated spinlocks.	59	* SPINLOCK_INITIALIZE is to be used for statically allocated spinlocks.
59	* It declares and initializes the lock.	60	* It declares and initializes the lock.
60	*/	61	*/
61	#ifdef CONFIG_DEBUG_SPINLOCK	62	#ifdef CONFIG_DEBUG_SPINLOCK
62	#define SPINLOCK_INITIALIZE(slname) \	63	#define SPINLOCK_INITIALIZE(slname) \
63	spinlock_t slname = { \	64	spinlock_t slname = { \
64	.name = #slname, \	65	.name = #slname, \
65	.val = { 0 } \	66	.val = { 0 } \
66	}	67	}
67	#else	68	#else
68	#define SPINLOCK_INITIALIZE(slname) \	69	#define SPINLOCK_INITIALIZE(slname) \
69	spinlock_t slname = { \	70	spinlock_t slname = { \
70	.val = { 0 } \	71	.val = { 0 } \
71	}	72	}
72	#endif	73	#endif
73		74
74	extern void spinlock_initialize(spinlock_t sl, char name);	75	extern void spinlock_initialize(spinlock_t sl, char name);
75	extern int spinlock_trylock(spinlock_t *sl);	76	extern int spinlock_trylock(spinlock_t *sl);
76	extern void spinlock_lock_debug(spinlock_t *sl);	77	extern void spinlock_lock_debug(spinlock_t *sl);
77		78
78	#ifdef CONFIG_DEBUG_SPINLOCK	79	#ifdef CONFIG_DEBUG_SPINLOCK
79	# define spinlock_lock(x) spinlock_lock_debug(x)	80	# define spinlock_lock(x) spinlock_lock_debug(x)
80	#else	81	#else
81	# define spinlock_lock(x) atomic_lock_arch(&(x)->val)	82	# define spinlock_lock(x) atomic_lock_arch(&(x)->val)
82	#endif	83	#endif
83		84
84	/** Unlock spinlock	85	/** Unlock spinlock
85	*	86	*
86	* Unlock spinlock.	87	* Unlock spinlock.
87	*	88	*
88	* @param sl Pointer to spinlock_t structure.	89	* @param sl Pointer to spinlock_t structure.
89	*/	90	*/
90	static inline void spinlock_unlock(spinlock_t *sl)	91	static inline void spinlock_unlock(spinlock_t *sl)
91	{	92	{
92	ASSERT(atomic_get(&sl->val) != 0);	93	ASSERT(atomic_get(&sl->val) != 0);
93		94
94	/*	95	/*
95	* Prevent critical section code from bleeding out this way down.	96	* Prevent critical section code from bleeding out this way down.
96	*/	97	*/
97	CS_LEAVE_BARRIER();	98	CS_LEAVE_BARRIER();
98		99
99	atomic_set(&sl->val, 0);	100	atomic_set(&sl->val, 0);
100	preemption_enable();	101	preemption_enable();
101	}	102	}
102		103
103	#else	104	#else
104		105
105	typedef void spinlock_t;	-
106		-
107	/* On UP systems, spinlocks are effectively left out. */	106	/* On UP systems, spinlocks are effectively left out. */
108	#define SPINLOCK_DECLARE(name)	107	#define SPINLOCK_DECLARE(name)
-		108	#define SPINLOCK_EXTERN(name)
109	#define SPINLOCK_INITIALIZE(name)	109	#define SPINLOCK_INITIALIZE(name)
110		110
111	#define spinlock_initialize(x, name)	111	#define spinlock_initialize(x, name)
112	#define spinlock_lock(x) preemption_disable()	112	#define spinlock_lock(x) preemption_disable()
113	#define spinlock_trylock(x) (preemption_disable(), 1)	113	#define spinlock_trylock(x) (preemption_disable(), 1)
114	#define spinlock_unlock(x) preemption_enable()	114	#define spinlock_unlock(x) preemption_enable()
115		115
116	#endif	116	#endif
117		117
118	#endif	118	#endif
119		119
120	/** @}	120	/** @}
121	*/	121	*/
122		122

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/synch/spinlock.h @ 2089 – Rev 2089 → 2093