A machine-independent spinlock implementation. It has the advantages of
[dragonfly.git] / sys / i386 / include / atomic.h
1 /*-
2  * Copyright (c) 1998 Doug Rabson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/i386/include/atomic.h,v 1.9.2.1 2000/07/07 00:38:47 obrien Exp $
27  * $DragonFly: src/sys/i386/include/Attic/atomic.h,v 1.14 2005/08/28 15:27:05 hsu Exp $
28  */
29 #ifndef _MACHINE_ATOMIC_H_
30 #define _MACHINE_ATOMIC_H_
31
32 /*
33  * Various simple arithmetic on memory which is atomic in the presence
34  * of interrupts and multiple processors.
35  *
36  * atomic_set_char(P, V)        (*(u_char*)(P) |= (V))
37  * atomic_clear_char(P, V)      (*(u_char*)(P) &= ~(V))
38  * atomic_add_char(P, V)        (*(u_char*)(P) += (V))
39  * atomic_subtract_char(P, V)   (*(u_char*)(P) -= (V))
40  *
41  * atomic_set_short(P, V)       (*(u_short*)(P) |= (V))
42  * atomic_clear_short(P, V)     (*(u_short*)(P) &= ~(V))
43  * atomic_add_short(P, V)       (*(u_short*)(P) += (V))
44  * atomic_subtract_short(P, V)  (*(u_short*)(P) -= (V))
45  *
46  * atomic_set_int(P, V)         (*(u_int*)(P) |= (V))
47  * atomic_clear_int(P, V)       (*(u_int*)(P) &= ~(V))
48  * atomic_add_int(P, V)         (*(u_int*)(P) += (V))
49  * atomic_subtract_int(P, V)    (*(u_int*)(P) -= (V))
50  *
51  * atomic_set_long(P, V)        (*(u_long*)(P) |= (V))
52  * atomic_clear_long(P, V)      (*(u_long*)(P) &= ~(V))
53  * atomic_add_long(P, V)        (*(u_long*)(P) += (V))
54  * atomic_subtract_long(P, V)   (*(u_long*)(P) -= (V))
55  */
56
57 /*
58  * The above functions are expanded inline in the statically-linked
59  * kernel.  Lock prefixes are generated if an SMP kernel is being
60  * built.
61  *
62  * Kernel modules call real functions which are built into the kernel.
63  * This allows kernel modules to be portable between UP and SMP systems.
64  */
65 #if defined(KLD_MODULE)
66 #define ATOMIC_ASM(NAME, TYPE, OP, V)                   \
67         extern void atomic_##NAME##_##TYPE(volatile u_##TYPE *p, u_##TYPE v); \
68         extern void atomic_##NAME##_##TYPE##_nonlocked(volatile u_##TYPE *p, u_##TYPE v);
69 #else /* !KLD_MODULE */
70 #if defined(SMP)
71 #define MPLOCKED        "lock ; "
72 #else
73 #define MPLOCKED
74 #endif
75
76 /*
77  * The assembly is volatilized to demark potential before-and-after side
78  * effects if an interrupt or SMP collision were to occur.  The primary
79  * atomic instructions are MP safe, the nonlocked instructions are 
80  * local-interrupt-safe (so we don't depend on C 'X |= Y' generating an
81  * atomic instruction).
82  *
83  * +m - memory is read and written (=m - memory is only written)
84  * iq - integer constant or %ax/%bx/%cx/%dx (ir = int constant or any reg)
85  *      (Note: byte instructions only work on %ax,%bx,%cx, or %dx).  iq
86  *      is good enough for our needs so don't get fancy.
87  */
88
89 /* egcs 1.1.2+ version */
90 #define ATOMIC_ASM(NAME, TYPE, OP, V)                   \
91 static __inline void                                    \
92 atomic_##NAME##_##TYPE(volatile u_##TYPE *p, u_##TYPE v)\
93 {                                                       \
94         __asm __volatile(MPLOCKED OP                    \
95                          : "+m" (*p)                    \
96                          : "iq" (V));                   \
97 }                                                       \
98 static __inline void                                    \
99 atomic_##NAME##_##TYPE##_nonlocked(volatile u_##TYPE *p, u_##TYPE v)\
100 {                                                       \
101         __asm __volatile(OP                             \
102                          : "+m" (*p)                    \
103                          : "iq" (V));                   \
104 }
105
106 #endif /* KLD_MODULE */
107
108 /* egcs 1.1.2+ version */
109 ATOMIC_ASM(set,      char,  "orb %b1,%0",   v)
110 ATOMIC_ASM(clear,    char,  "andb %b1,%0", ~v)
111 ATOMIC_ASM(add,      char,  "addb %b1,%0",  v)
112 ATOMIC_ASM(subtract, char,  "subb %b1,%0",  v)
113
114 ATOMIC_ASM(set,      short, "orw %w1,%0",   v)
115 ATOMIC_ASM(clear,    short, "andw %w1,%0", ~v)
116 ATOMIC_ASM(add,      short, "addw %w1,%0",  v)
117 ATOMIC_ASM(subtract, short, "subw %w1,%0",  v)
118
119 ATOMIC_ASM(set,      int,   "orl %1,%0",   v)
120 ATOMIC_ASM(clear,    int,   "andl %1,%0", ~v)
121 ATOMIC_ASM(add,      int,   "addl %1,%0",  v)
122 ATOMIC_ASM(subtract, int,   "subl %1,%0",  v)
123
124 ATOMIC_ASM(set,      long,  "orl %1,%0",   v)
125 ATOMIC_ASM(clear,    long,  "andl %1,%0", ~v)
126 ATOMIC_ASM(add,      long,  "addl %1,%0",  v)
127 ATOMIC_ASM(subtract, long,  "subl %1,%0",  v)
128
129 /*
130  * atomic_poll_acquire_int(P)   Returns non-zero on success, 0 if the lock
131  *                              has already been acquired.
132  * atomic_poll_release_int(P)
133  *
134  * These support the NDIS driver and are also used for IPIQ interlocks
135  * between cpus.  Both the acquisition and release must be 
136  * cache-synchronizing instructions.
137  */
138
139 #if defined(KLD_MODULE)
140
141 extern int atomic_swap_int(volatile int *addr, int value);
142 extern int atomic_poll_acquire_int(volatile u_int *p);
143 extern void atomic_poll_release_int(volatile u_int *p);
144
145 #else
146
147 static __inline int
148 atomic_swap_int(volatile int *addr, int value)
149 {
150         __asm __volatile("xchgl %0, %1" :
151             "=r" (value), "=m" (*addr) : "0" (value) : "memory");
152         return (value);
153 }
154
155 static __inline
156 int
157 atomic_poll_acquire_int(volatile u_int *p)
158 {
159         u_int data;
160
161         __asm __volatile(MPLOCKED "btsl $0,%0; setnc %%al; andl $255,%%eax" : "+m" (*p), "=a" (data));
162         return(data);
163 }
164
165 static __inline
166 void
167 atomic_poll_release_int(volatile u_int *p)
168 {
169         __asm __volatile(MPLOCKED "btrl $0,%0" : "+m" (*p));
170 }
171
172 #endif
173
174 /*
175  * These functions operate on a 32 bit interrupt interlock which is defined
176  * as follows:
177  *
178  *      bit 0-30        interrupt handler disabled bits (counter)
179  *      bit 31          interrupt handler currently running bit (1 = run)
180  *
181  * atomic_intr_cond_test(P)     Determine if the interlock is in an
182  *                              acquired state.  Returns 0 if it not
183  *                              acquired, non-zero if it is.
184  *
185  * atomic_intr_cond_enter(P, func, arg)
186  *                              Increment the request counter and attempt to
187  *                              set bit 31 to acquire the interlock.  If
188  *                              we are unable to set bit 31 func(arg) is
189  *                              called in a loop until we are able to set
190  *                              bit 31.
191  *
192  * atomic_intr_cond_exit(P, func, arg)
193  *                              Decrement the request counter and clear bit
194  *                              31.  If the request counter is still non-zero
195  *                              call func(arg) once.
196  *
197  * atomic_intr_handler_disable(P)
198  *                              Set bit 30, indicating that the interrupt
199  *                              handler has been disabled.  Must be called
200  *                              after the hardware is disabled.
201  *
202  *                              Returns bit 31 indicating whether a serialized
203  *                              accessor is active (typically the interrupt
204  *                              handler is running).  0 == not active,
205  *                              non-zero == active.
206  *
207  * atomic_intr_handler_enable(P)
208  *                              Clear bit 30, indicating that the interrupt
209  *                              handler has been enabled.  Must be called
210  *                              before the hardware is actually enabled.
211  *
212  * atomic_intr_handler_is_enabled(P)
213  *                              Returns bit 30, 0 indicates that the handler
214  *                              is enabled, non-zero indicates that it is
215  *                              disabled.  The request counter portion of
216  *                              the field is ignored.
217  */
218
219 #ifndef __ATOMIC_INTR_T
220 #define __ATOMIC_INTR_T
221 typedef volatile int atomic_intr_t;
222 #endif
223
224 #if defined(KLD_MODULE)
225
226 void atomic_intr_init(atomic_intr_t *p);
227 int atomic_intr_handler_disable(atomic_intr_t *p);
228 void atomic_intr_handler_enable(atomic_intr_t *p);
229 int atomic_intr_handler_is_enabled(atomic_intr_t *p);
230 int atomic_intr_cond_test(atomic_intr_t *p);
231 void atomic_intr_cond_enter(atomic_intr_t *p, void (*func)(void *), void *arg);
232 void atomic_intr_cond_exit(atomic_intr_t *p, void (*func)(void *), void *arg);
233
234 #else
235
236 static __inline
237 void
238 atomic_intr_init(atomic_intr_t *p)
239 {
240         *p = 0;
241 }
242
243 static __inline
244 int
245 atomic_intr_handler_disable(atomic_intr_t *p)
246 {
247         int data;
248
249         __asm __volatile(MPLOCKED "orl $0x40000000,%1; movl %1,%%eax; " \
250                                   "andl $0x80000000,%%eax" \
251                                   : "=a"(data) , "+m"(*p));
252         return(data);
253 }
254
255 static __inline
256 void
257 atomic_intr_handler_enable(atomic_intr_t *p)
258 {
259         __asm __volatile(MPLOCKED "andl $0xBFFFFFFF,%0" : "+m" (*p));
260 }
261
262 static __inline
263 int
264 atomic_intr_handler_is_enabled(atomic_intr_t *p)
265 {
266         int data;
267
268         __asm __volatile("movl %1,%%eax; andl $0x40000000,%%eax" \
269                          : "=a"(data) : "m"(*p));
270         return(data);
271 }
272
273 static __inline
274 void
275 atomic_intr_cond_enter(atomic_intr_t *p, void (*func)(void *), void *arg)
276 {
277         __asm __volatile(MPLOCKED "incl %0; " \
278                          "1: ;" \
279                          MPLOCKED "btsl $31,%0; jnc 2f; " \
280                          "pushl %2; call *%1; addl $4,%%esp; " \
281                          "jmp 1b; " \
282                          "2: ;" \
283                          : "+m" (*p) \
284                          : "r"(func), "m"(arg) \
285                          : "ax", "cx", "dx");
286 }
287
288 static __inline
289 int
290 atomic_intr_cond_test(atomic_intr_t *p)
291 {
292         return((int)(*p & 0x80000000));
293 }
294
295 static __inline
296 void
297 atomic_intr_cond_exit(atomic_intr_t *p, void (*func)(void *), void *arg)
298 {
299         __asm __volatile(MPLOCKED "decl %0; " \
300                         MPLOCKED "btrl $31,%0; " \
301                         "testl $0x3FFFFFFF,%0; jz 1f; " \
302                          "pushl %2; call *%1; addl $4,%%esp; " \
303                          "1: ;" \
304                          : "+m" (*p) \
305                          : "r"(func), "m"(arg) \
306                          : "ax", "cx", "dx");
307 }
308
309 #endif
310
311 #endif /* ! _MACHINE_ATOMIC_H_ */