patch-2_6_7-vs1_9_1_12
[linux-2.6.git] / include / asm-x86_64 / semaphore.h
1 #ifndef _X86_64_SEMAPHORE_H
2 #define _X86_64_SEMAPHORE_H
3
4 #include <linux/linkage.h>
5
6 #ifdef __KERNEL__
7
8 /*
9  * SMP- and interrupt-safe semaphores..
10  *
11  * (C) Copyright 1996 Linus Torvalds
12  *
13  * Modified 1996-12-23 by Dave Grothe <dave@gcom.com> to fix bugs in
14  *                     the original code and to make semaphore waits
15  *                     interruptible so that processes waiting on
16  *                     semaphores can be killed.
17  * Modified 1999-02-14 by Andrea Arcangeli, split the sched.c helper
18  *                     functions in asm/sempahore-helper.h while fixing a
19  *                     potential and subtle race discovered by Ulrich Schmid
20  *                     in down_interruptible(). Since I started to play here I
21  *                     also implemented the `trylock' semaphore operation.
22  *          1999-07-02 Artur Skawina <skawina@geocities.com>
23  *                     Optimized "0(ecx)" -> "(ecx)" (the assembler does not
24  *                     do this). Changed calling sequences from push/jmp to
25  *                     traditional call/ret.
26  * Modified 2001-01-01 Andreas Franck <afranck@gmx.de>
27  *                     Some hacks to ensure compatibility with recent
28  *                     GCC snapshots, to avoid stack corruption when compiling
29  *                     with -fomit-frame-pointer. It's not sure if this will
30  *                     be fixed in GCC, as our previous implementation was a
31  *                     bit dubious.
32  *
33  * If you would like to see an analysis of this implementation, please
34  * ftp to gcom.com and download the file
35  * /pub/linux/src/semaphore/semaphore-2.0.24.tar.gz.
36  *
37  */
38
39 #include <asm/system.h>
40 #include <asm/atomic.h>
41 #include <asm/rwlock.h>
42 #include <linux/wait.h>
43 #include <linux/rwsem.h>
44 #include <linux/stringify.h>
45
46 struct semaphore {
47         atomic_t count;
48         int sleepers;
49         wait_queue_head_t wait;
50 #ifdef WAITQUEUE_DEBUG
51         long __magic;
52 #endif
53 };
54
55 #ifdef WAITQUEUE_DEBUG
56 # define __SEM_DEBUG_INIT(name) \
57                 , (int)&(name).__magic
58 #else
59 # define __SEM_DEBUG_INIT(name)
60 #endif
61
62 #define __SEMAPHORE_INITIALIZER(name,count) \
63 { ATOMIC_INIT(count), 0, __WAIT_QUEUE_HEAD_INITIALIZER((name).wait) \
64         __SEM_DEBUG_INIT(name) }
65
66 #define __MUTEX_INITIALIZER(name) \
67         __SEMAPHORE_INITIALIZER(name,1)
68
69 #define __DECLARE_SEMAPHORE_GENERIC(name,count) \
70         struct semaphore name = __SEMAPHORE_INITIALIZER(name,count)
71
72 #define DECLARE_MUTEX(name) __DECLARE_SEMAPHORE_GENERIC(name,1)
73 #define DECLARE_MUTEX_LOCKED(name) __DECLARE_SEMAPHORE_GENERIC(name,0)
74
75 static inline void sema_init (struct semaphore *sem, int val)
76 {
77 /*
78  *      *sem = (struct semaphore)__SEMAPHORE_INITIALIZER((*sem),val);
79  *
80  * i'd rather use the more flexible initialization above, but sadly
81  * GCC 2.7.2.3 emits a bogus warning. EGCS doesn't. Oh well.
82  */
83         atomic_set(&sem->count, val);
84         sem->sleepers = 0;
85         init_waitqueue_head(&sem->wait);
86 #ifdef WAITQUEUE_DEBUG
87         sem->__magic = (int)&sem->__magic;
88 #endif
89 }
90
91 static inline void init_MUTEX (struct semaphore *sem)
92 {
93         sema_init(sem, 1);
94 }
95
96 static inline void init_MUTEX_LOCKED (struct semaphore *sem)
97 {
98         sema_init(sem, 0);
99 }
100
101 asmlinkage void __down_failed(void /* special register calling convention */);
102 asmlinkage int  __down_failed_interruptible(void  /* params in registers */);
103 asmlinkage int  __down_failed_trylock(void  /* params in registers */);
104 asmlinkage void __up_wakeup(void /* special register calling convention */);
105
106 asmlinkage void __down(struct semaphore * sem);
107 asmlinkage int  __down_interruptible(struct semaphore * sem);
108 asmlinkage int  __down_trylock(struct semaphore * sem);
109 asmlinkage void __up(struct semaphore * sem);
110
111 /*
112  * This is ugly, but we want the default case to fall through.
113  * "__down_failed" is a special asm handler that calls the C
114  * routine that actually waits. See arch/x86_64/kernel/semaphore.c
115  */
116 static inline void down(struct semaphore * sem)
117 {
118 #ifdef WAITQUEUE_DEBUG
119         CHECK_MAGIC(sem->__magic);
120 #endif
121         might_sleep();
122
123         __asm__ __volatile__(
124                 "# atomic down operation\n\t"
125                 LOCK "decl %0\n\t"     /* --sem->count */
126                 "js 2f\n"
127                 "1:\n"
128                 LOCK_SECTION_START("")
129                 "2:\tcall __down_failed\n\t"
130                 "jmp 1b\n"
131                 LOCK_SECTION_END
132                 :"=m" (sem->count)
133                 :"D" (sem)
134                 :"memory");
135 }
136
137 /*
138  * Interruptible try to acquire a semaphore.  If we obtained
139  * it, return zero.  If we were interrupted, returns -EINTR
140  */
141 static inline int down_interruptible(struct semaphore * sem)
142 {
143         int result;
144
145 #ifdef WAITQUEUE_DEBUG
146         CHECK_MAGIC(sem->__magic);
147 #endif
148         might_sleep();
149
150         __asm__ __volatile__(
151                 "# atomic interruptible down operation\n\t"
152                 LOCK "decl %1\n\t"     /* --sem->count */
153                 "js 2f\n\t"
154                 "xorl %0,%0\n"
155                 "1:\n"
156                 LOCK_SECTION_START("")
157                 "2:\tcall __down_failed_interruptible\n\t"
158                 "jmp 1b\n"
159                 LOCK_SECTION_END
160                 :"=a" (result), "=m" (sem->count)
161                 :"D" (sem)
162                 :"memory");
163         return result;
164 }
165
166 /*
167  * Non-blockingly attempt to down() a semaphore.
168  * Returns zero if we acquired it
169  */
170 static inline int down_trylock(struct semaphore * sem)
171 {
172         int result;
173
174 #ifdef WAITQUEUE_DEBUG
175         CHECK_MAGIC(sem->__magic);
176 #endif
177
178         __asm__ __volatile__(
179                 "# atomic interruptible down operation\n\t"
180                 LOCK "decl %1\n\t"     /* --sem->count */
181                 "js 2f\n\t"
182                 "xorl %0,%0\n"
183                 "1:\n"
184                 LOCK_SECTION_START("")
185                 "2:\tcall __down_failed_trylock\n\t"
186                 "jmp 1b\n"
187                 LOCK_SECTION_END
188                 :"=a" (result), "=m" (sem->count)
189                 :"D" (sem)
190                 :"memory","cc");
191         return result;
192 }
193
194 /*
195  * Note! This is subtle. We jump to wake people up only if
196  * the semaphore was negative (== somebody was waiting on it).
197  * The default case (no contention) will result in NO
198  * jumps for both down() and up().
199  */
200 static inline void up(struct semaphore * sem)
201 {
202 #ifdef WAITQUEUE_DEBUG
203         CHECK_MAGIC(sem->__magic);
204 #endif
205         __asm__ __volatile__(
206                 "# atomic up operation\n\t"
207                 LOCK "incl %0\n\t"     /* ++sem->count */
208                 "jle 2f\n"
209                 "1:\n"
210                 LOCK_SECTION_START("")
211                 "2:\tcall __up_wakeup\n\t"
212                 "jmp 1b\n"
213                 LOCK_SECTION_END
214                 :"=m" (sem->count)
215                 :"D" (sem)
216                 :"memory");
217 }
218 #endif /* __KERNEL__ */
219 #endif