Fix the backslashes in a __asm line's interference with an #ifdef
[dragonfly.git] / sys / cpu / 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/cpu/i386/include/atomic.h,v 1.25 2008/06/26 23:06:50 dillon Exp $
28  */
29 #ifndef _CPU_ATOMIC_H_
30 #define _CPU_ATOMIC_H_
31
32 #ifndef _SYS_TYPES_H_
33 #include <sys/types.h>
34 #endif
35
36 /*
37  * Various simple arithmetic on memory which is atomic in the presence
38  * of interrupts and multiple processors.
39  *
40  * atomic_set_char(P, V)        (*(u_char*)(P) |= (V))
41  * atomic_clear_char(P, V)      (*(u_char*)(P) &= ~(V))
42  * atomic_add_char(P, V)        (*(u_char*)(P) += (V))
43  * atomic_subtract_char(P, V)   (*(u_char*)(P) -= (V))
44  *
45  * atomic_set_short(P, V)       (*(u_short*)(P) |= (V))
46  * atomic_clear_short(P, V)     (*(u_short*)(P) &= ~(V))
47  * atomic_add_short(P, V)       (*(u_short*)(P) += (V))
48  * atomic_subtract_short(P, V)  (*(u_short*)(P) -= (V))
49  *
50  * atomic_set_int(P, V)         (*(u_int*)(P) |= (V))
51  * atomic_clear_int(P, V)       (*(u_int*)(P) &= ~(V))
52  * atomic_add_int(P, V)         (*(u_int*)(P) += (V))
53  * atomic_subtract_int(P, V)    (*(u_int*)(P) -= (V))
54  *
55  * atomic_set_long(P, V)        (*(u_long*)(P) |= (V))
56  * atomic_clear_long(P, V)      (*(u_long*)(P) &= ~(V))
57  * atomic_add_long(P, V)        (*(u_long*)(P) += (V))
58  * atomic_subtract_long(P, V)   (*(u_long*)(P) -= (V))
59  */
60
61 /*
62  * The above functions are expanded inline in the statically-linked
63  * kernel.  Lock prefixes are generated if an SMP kernel is being
64  * built, or if user code is using these functions.
65  *
66  * Kernel modules call real functions which are built into the kernel.
67  * This allows kernel modules to be portable between UP and SMP systems.
68  */
69 #if defined(KLD_MODULE)
70 #define ATOMIC_ASM(NAME, TYPE, OP, V)                   \
71         extern void atomic_##NAME##_##TYPE(volatile u_##TYPE *p, u_##TYPE v); \
72         extern void atomic_##NAME##_##TYPE##_nonlocked(volatile u_##TYPE *p, u_##TYPE v);
73 #else /* !KLD_MODULE */
74 #if defined(SMP) || !defined(_KERNEL)
75 #define MPLOCKED        "lock ; "
76 #else
77 #define MPLOCKED
78 #endif
79
80 /*
81  * The assembly is volatilized to demark potential before-and-after side
82  * effects if an interrupt or SMP collision were to occur.  The primary
83  * atomic instructions are MP safe, the nonlocked instructions are 
84  * local-interrupt-safe (so we don't depend on C 'X |= Y' generating an
85  * atomic instruction).
86  *
87  * +m - memory is read and written (=m - memory is only written)
88  * iq - integer constant or %ax/%bx/%cx/%dx (ir = int constant or any reg)
89  *      (Note: byte instructions only work on %ax,%bx,%cx, or %dx).  iq
90  *      is good enough for our needs so don't get fancy.
91  */
92
93 /* egcs 1.1.2+ version */
94 #define ATOMIC_ASM(NAME, TYPE, OP, V)                   \
95 static __inline void                                    \
96 atomic_##NAME##_##TYPE(volatile u_##TYPE *p, u_##TYPE v)\
97 {                                                       \
98         __asm __volatile(MPLOCKED OP                    \
99                          : "+m" (*p)                    \
100                          : "iq" (V));                   \
101 }                                                       \
102 static __inline void                                    \
103 atomic_##NAME##_##TYPE##_nonlocked(volatile u_##TYPE *p, u_##TYPE v)\
104 {                                                       \
105         __asm __volatile(OP                             \
106                          : "+m" (*p)                    \
107                          : "iq" (V));                   \
108 }
109
110 #endif /* KLD_MODULE */
111
112 /* egcs 1.1.2+ version */
113 ATOMIC_ASM(set,      char,  "orb %b1,%0",   v)
114 ATOMIC_ASM(clear,    char,  "andb %b1,%0", ~v)
115 ATOMIC_ASM(add,      char,  "addb %b1,%0",  v)
116 ATOMIC_ASM(subtract, char,  "subb %b1,%0",  v)
117
118 ATOMIC_ASM(set,      short, "orw %w1,%0",   v)
119 ATOMIC_ASM(clear,    short, "andw %w1,%0", ~v)
120 ATOMIC_ASM(add,      short, "addw %w1,%0",  v)
121 ATOMIC_ASM(subtract, short, "subw %w1,%0",  v)
122
123 ATOMIC_ASM(set,      int,   "orl %1,%0",   v)
124 ATOMIC_ASM(clear,    int,   "andl %1,%0", ~v)
125 ATOMIC_ASM(add,      int,   "addl %1,%0",  v)
126 ATOMIC_ASM(subtract, int,   "subl %1,%0",  v)
127
128 ATOMIC_ASM(set,      long,  "orl %1,%0",   v)
129 ATOMIC_ASM(clear,    long,  "andl %1,%0", ~v)
130 ATOMIC_ASM(add,      long,  "addl %1,%0",  v)
131 ATOMIC_ASM(subtract, long,  "subl %1,%0",  v)
132
133 /*
134  * atomic_poll_acquire_int(P)   Returns non-zero on success, 0 if the lock
135  *                              has already been acquired.
136  * atomic_poll_release_int(P)
137  *
138  * These support the NDIS driver and are also used for IPIQ interlocks
139  * between cpus.  Both the acquisition and release must be 
140  * cache-synchronizing instructions.
141  */
142
143 #if defined(KLD_MODULE)
144
145 extern int atomic_swap_int(volatile int *addr, int value);
146 extern int atomic_poll_acquire_int(volatile u_int *p);
147 extern void atomic_poll_release_int(volatile u_int *p);
148
149 #else
150
151 static __inline int
152 atomic_swap_int(volatile int *addr, int value)
153 {
154         __asm __volatile("xchgl %0, %1" :
155             "=r" (value), "=m" (*addr) : "0" (value) : "memory");
156         return (value);
157 }
158
159 static __inline
160 int
161 atomic_poll_acquire_int(volatile u_int *p)
162 {
163         u_int data;
164
165         __asm __volatile(MPLOCKED "btsl $0,%0; setnc %%al; andl $255,%%eax" : "+m" (*p), "=a" (data));
166         return(data);
167 }
168
169 static __inline
170 void
171 atomic_poll_release_int(volatile u_int *p)
172 {
173         __asm __volatile(MPLOCKED "btrl $0,%0" : "+m" (*p));
174 }
175
176 #endif
177
178 /*
179  * These functions operate on a 32 bit interrupt interlock which is defined
180  * as follows:
181  *
182  *      bit 0-30        interrupt handler disabled bits (counter)
183  *      bit 31          interrupt handler currently running bit (1 = run)
184  *
185  * atomic_intr_cond_test(P)     Determine if the interlock is in an
186  *                              acquired state.  Returns 0 if it not
187  *                              acquired, non-zero if it is.
188  *
189  * atomic_intr_cond_try(P)
190  *                              Increment the request counter and attempt to
191  *                              set bit 31 to acquire the interlock.  If
192  *                              we are unable to set bit 31 the request
193  *                              counter is decremented and we return -1,
194  *                              otherwise we return 0.
195  *
196  * atomic_intr_cond_enter(P, func, arg)
197  *                              Increment the request counter and attempt to
198  *                              set bit 31 to acquire the interlock.  If
199  *                              we are unable to set bit 31 func(arg) is
200  *                              called in a loop until we are able to set
201  *                              bit 31.
202  *
203  * atomic_intr_cond_exit(P, func, arg)
204  *                              Decrement the request counter and clear bit
205  *                              31.  If the request counter is still non-zero
206  *                              call func(arg) once.
207  *
208  * atomic_intr_handler_disable(P)
209  *                              Set bit 30, indicating that the interrupt
210  *                              handler has been disabled.  Must be called
211  *                              after the hardware is disabled.
212  *
213  *                              Returns bit 31 indicating whether a serialized
214  *                              accessor is active (typically the interrupt
215  *                              handler is running).  0 == not active,
216  *                              non-zero == active.
217  *
218  * atomic_intr_handler_enable(P)
219  *                              Clear bit 30, indicating that the interrupt
220  *                              handler has been enabled.  Must be called
221  *                              before the hardware is actually enabled.
222  *
223  * atomic_intr_handler_is_enabled(P)
224  *                              Returns bit 30, 0 indicates that the handler
225  *                              is enabled, non-zero indicates that it is
226  *                              disabled.  The request counter portion of
227  *                              the field is ignored.
228  */
229
230 #if defined(KLD_MODULE)
231
232 void atomic_intr_init(__atomic_intr_t *p);
233 int atomic_intr_handler_disable(__atomic_intr_t *p);
234 void atomic_intr_handler_enable(__atomic_intr_t *p);
235 int atomic_intr_handler_is_enabled(__atomic_intr_t *p);
236 int atomic_intr_cond_test(__atomic_intr_t *p);
237 int atomic_intr_cond_try(__atomic_intr_t *p);
238 void atomic_intr_cond_enter(__atomic_intr_t *p, void (*func)(void *), void *arg);
239 void atomic_intr_cond_exit(__atomic_intr_t *p, void (*func)(void *), void *arg);
240
241 #else
242
243 static __inline
244 void
245 atomic_intr_init(__atomic_intr_t *p)
246 {
247         *p = 0;
248 }
249
250 static __inline
251 int
252 atomic_intr_handler_disable(__atomic_intr_t *p)
253 {
254         int data;
255
256         __asm __volatile(MPLOCKED "orl $0x40000000,%1; movl %1,%%eax; " \
257                                   "andl $0x80000000,%%eax" \
258                                   : "=a"(data) , "+m"(*p));
259         return(data);
260 }
261
262 static __inline
263 void
264 atomic_intr_handler_enable(__atomic_intr_t *p)
265 {
266         __asm __volatile(MPLOCKED "andl $0xBFFFFFFF,%0" : "+m" (*p));
267 }
268
269 static __inline
270 int
271 atomic_intr_handler_is_enabled(__atomic_intr_t *p)
272 {
273         int data;
274
275         __asm __volatile("movl %1,%%eax; andl $0x40000000,%%eax" \
276                          : "=a"(data) : "m"(*p));
277         return(data);
278 }
279
280 static __inline
281 void
282 atomic_intr_cond_enter(__atomic_intr_t *p, void (*func)(void *), void *arg)
283 {
284         __asm __volatile(MPLOCKED "incl %0; " \
285                          "1: ;" \
286                          MPLOCKED "btsl $31,%0; jnc 2f; " \
287                          "pushl %2; call *%1; addl $4,%%esp; " \
288                          "jmp 1b; " \
289                          "2: ;" \
290                          : "+m" (*p) \
291                          : "r"(func), "m"(arg) \
292                          : "ax", "cx", "dx");
293 }
294
295 /*
296  * Attempt to enter the interrupt condition variable.  Returns zero on
297  * success, 1 on failure.
298  */
299 static __inline
300 int
301 atomic_intr_cond_try(__atomic_intr_t *p)
302 {
303         int ret;
304
305         __asm __volatile(MPLOCKED "incl %0; "                   \
306                          "1: ;"                                 \
307                          "subl %%eax,%%eax; "                   \
308                          MPLOCKED "btsl $31,%0; jnc 2f; "       \
309                          MPLOCKED "decl %0; "                   \
310                          "movl $1,%%eax;"                       \
311                          "2: ;"
312                          : "+m" (*p), "=a"(ret)
313 #ifdef __clang__
314                          : : "ax", "cx", "dx");
315 #else
316                          : : "cx", "dx");
317 #endif
318         return (ret);
319 }
320
321
322 static __inline
323 int
324 atomic_intr_cond_test(__atomic_intr_t *p)
325 {
326         return((int)(*p & 0x80000000));
327 }
328
329 static __inline
330 void
331 atomic_intr_cond_exit(__atomic_intr_t *p, void (*func)(void *), void *arg)
332 {
333         __asm __volatile(MPLOCKED "decl %0; " \
334                         MPLOCKED "btrl $31,%0; " \
335                         "testl $0x3FFFFFFF,%0; jz 1f; " \
336                          "pushl %2; call *%1; addl $4,%%esp; " \
337                          "1: ;" \
338                          : "+m" (*p) \
339                          : "r"(func), "m"(arg) \
340                          : "ax", "cx", "dx");
341 }
342
343 #endif
344
345 /*
346  * Atomic compare and set
347  *
348  * if (*_dst == _old) *_dst = _new (all 32 bit words)
349  *
350  * Returns 0 on failure, non-zero on success
351  */
352 #if defined(KLD_MODULE)
353
354 extern int atomic_cmpset_int(volatile u_int *_dst, u_int _old, u_int _new);
355 extern int atomic_cmpset_long(volatile u_long *dst, u_long exp, u_long src);
356 extern u_int atomic_fetchadd_int(volatile u_int *p, u_int v);
357
358 #else
359
360 static __inline int
361 atomic_cmpset_int(volatile u_int *_dst, u_int _old, u_int _new)
362 {
363         int res = _old;
364
365         __asm __volatile(MPLOCKED "cmpxchgl %2,%1; " \
366                          "setz %%al; " \
367                          "movzbl %%al,%0; " \
368                          : "+a" (res), "=m" (*_dst) \
369                          : "r" (_new), "m" (*_dst) \
370                          : "memory");
371         return res;
372 }
373
374 static __inline int
375 atomic_cmpset_long(volatile u_long *dst, u_long exp, u_long src)
376 {
377          return (atomic_cmpset_int((volatile u_int *)dst, (u_int)exp,
378                                    (u_int)src));
379 }
380
381 /*
382  * Atomically add the value of v to the integer pointed to by p and return
383  * the previous value of *p.
384  */
385 static __inline u_int
386 atomic_fetchadd_int(volatile u_int *p, u_int v)
387 {
388         __asm __volatile(MPLOCKED "xaddl %0,%1; " \
389                          : "+r" (v), "=m" (*p)  \
390                          : "m" (*p)             \
391                          : "memory");
392         return (v);
393 }
394
395 #endif  /* KLD_MODULE */
396
397 /* Acquire and release variants are identical to the normal ones. */
398 #define atomic_set_acq_char             atomic_set_char
399 #define atomic_set_rel_char             atomic_set_char
400 #define atomic_clear_acq_char           atomic_clear_char
401 #define atomic_clear_rel_char           atomic_clear_char
402 #define atomic_add_acq_char             atomic_add_char
403 #define atomic_add_rel_char             atomic_add_char
404 #define atomic_subtract_acq_char        atomic_subtract_char
405 #define atomic_subtract_rel_char        atomic_subtract_char
406
407 #define atomic_set_acq_short            atomic_set_short
408 #define atomic_set_rel_short            atomic_set_short
409 #define atomic_clear_acq_short          atomic_clear_short
410 #define atomic_clear_rel_short          atomic_clear_short
411 #define atomic_add_acq_short            atomic_add_short
412 #define atomic_add_rel_short            atomic_add_short
413 #define atomic_subtract_acq_short       atomic_subtract_short
414 #define atomic_subtract_rel_short       atomic_subtract_short
415
416 #define atomic_set_acq_int              atomic_set_int
417 #define atomic_set_rel_int              atomic_set_int
418 #define atomic_clear_acq_int            atomic_clear_int
419 #define atomic_clear_rel_int            atomic_clear_int
420 #define atomic_add_acq_int              atomic_add_int
421 #define atomic_add_rel_int              atomic_add_int
422 #define atomic_subtract_acq_int         atomic_subtract_int
423 #define atomic_subtract_rel_int         atomic_subtract_int
424 #define atomic_cmpset_acq_int           atomic_cmpset_int
425 #define atomic_cmpset_rel_int           atomic_cmpset_int
426
427 #define atomic_set_acq_long             atomic_set_long
428 #define atomic_set_rel_long             atomic_set_long
429 #define atomic_clear_acq_long           atomic_clear_long
430 #define atomic_clear_rel_long           atomic_clear_long
431 #define atomic_add_acq_long             atomic_add_long
432 #define atomic_add_rel_long             atomic_add_long
433 #define atomic_subtract_acq_long        atomic_subtract_long
434 #define atomic_subtract_rel_long        atomic_subtract_long
435 #define atomic_cmpset_acq_long          atomic_cmpset_long
436 #define atomic_cmpset_rel_long          atomic_cmpset_long
437
438 /* Operations on 8-bit bytes. */
439 #define atomic_set_8            atomic_set_char
440 #define atomic_set_acq_8        atomic_set_acq_char
441 #define atomic_set_rel_8        atomic_set_rel_char
442 #define atomic_clear_8          atomic_clear_char
443 #define atomic_clear_acq_8      atomic_clear_acq_char
444 #define atomic_clear_rel_8      atomic_clear_rel_char
445 #define atomic_add_8            atomic_add_char
446 #define atomic_add_acq_8        atomic_add_acq_char
447 #define atomic_add_rel_8        atomic_add_rel_char
448 #define atomic_subtract_8       atomic_subtract_char
449 #define atomic_subtract_acq_8   atomic_subtract_acq_char
450 #define atomic_subtract_rel_8   atomic_subtract_rel_char
451 #define atomic_load_acq_8       atomic_load_acq_char
452 #define atomic_store_rel_8      atomic_store_rel_char
453
454 /* Operations on 16-bit words. */
455 #define atomic_set_16           atomic_set_short
456 #define atomic_set_acq_16       atomic_set_acq_short
457 #define atomic_set_rel_16       atomic_set_rel_short
458 #define atomic_clear_16         atomic_clear_short
459 #define atomic_clear_acq_16     atomic_clear_acq_short
460 #define atomic_clear_rel_16     atomic_clear_rel_short
461 #define atomic_add_16           atomic_add_short
462 #define atomic_add_acq_16       atomic_add_acq_short
463 #define atomic_add_rel_16       atomic_add_rel_short
464 #define atomic_subtract_16      atomic_subtract_short
465 #define atomic_subtract_acq_16  atomic_subtract_acq_short
466 #define atomic_subtract_rel_16  atomic_subtract_rel_short
467 #define atomic_load_acq_16      atomic_load_acq_short
468 #define atomic_store_rel_16     atomic_store_rel_short
469
470 /* Operations on 32-bit double words. */
471 #define atomic_set_32           atomic_set_int
472 #define atomic_set_acq_32       atomic_set_acq_int
473 #define atomic_set_rel_32       atomic_set_rel_int
474 #define atomic_clear_32         atomic_clear_int
475 #define atomic_clear_acq_32     atomic_clear_acq_int
476 #define atomic_clear_rel_32     atomic_clear_rel_int
477 #define atomic_add_32           atomic_add_int
478 #define atomic_add_acq_32       atomic_add_acq_int
479 #define atomic_add_rel_32       atomic_add_rel_int
480 #define atomic_subtract_32      atomic_subtract_int
481 #define atomic_subtract_acq_32  atomic_subtract_acq_int
482 #define atomic_subtract_rel_32  atomic_subtract_rel_int
483 #define atomic_load_acq_32      atomic_load_acq_int
484 #define atomic_store_rel_32     atomic_store_rel_int
485 #define atomic_cmpset_32        atomic_cmpset_int
486 #define atomic_cmpset_acq_32    atomic_cmpset_acq_int
487 #define atomic_cmpset_rel_32    atomic_cmpset_rel_int
488 #define atomic_readandclear_32  atomic_readandclear_int
489 #define atomic_fetchadd_32      atomic_fetchadd_int
490
491 /* Operations on pointers. */
492 #define atomic_set_ptr(p, v) \
493         atomic_set_int((volatile u_int *)(p), (u_int)(v))
494 #define atomic_set_acq_ptr(p, v) \
495         atomic_set_acq_int((volatile u_int *)(p), (u_int)(v))
496 #define atomic_set_rel_ptr(p, v) \
497         atomic_set_rel_int((volatile u_int *)(p), (u_int)(v))
498 #define atomic_clear_ptr(p, v) \
499         atomic_clear_int((volatile u_int *)(p), (u_int)(v))
500 #define atomic_clear_acq_ptr(p, v) \
501         atomic_clear_acq_int((volatile u_int *)(p), (u_int)(v))
502 #define atomic_clear_rel_ptr(p, v) \
503         atomic_clear_rel_int((volatile u_int *)(p), (u_int)(v))
504 #define atomic_add_ptr(p, v) \
505         atomic_add_int((volatile u_int *)(p), (u_int)(v))
506 #define atomic_add_acq_ptr(p, v) \
507         atomic_add_acq_int((volatile u_int *)(p), (u_int)(v))
508 #define atomic_add_rel_ptr(p, v) \
509         atomic_add_rel_int((volatile u_int *)(p), (u_int)(v))
510 #define atomic_subtract_ptr(p, v) \
511         atomic_subtract_int((volatile u_int *)(p), (u_int)(v))
512 #define atomic_subtract_acq_ptr(p, v) \
513         atomic_subtract_acq_int((volatile u_int *)(p), (u_int)(v))
514 #define atomic_subtract_rel_ptr(p, v) \
515         atomic_subtract_rel_int((volatile u_int *)(p), (u_int)(v))
516 #define atomic_load_acq_ptr(p) \
517         atomic_load_acq_int((volatile u_int *)(p))
518 #define atomic_store_rel_ptr(p, v) \
519         atomic_store_rel_int((volatile u_int *)(p), (v))
520 #define atomic_cmpset_ptr(dst, old, new) \
521         atomic_cmpset_int((volatile u_int *)(dst), (u_int)(old), (u_int)(new))
522 #define atomic_cmpset_acq_ptr(dst, old, new) \
523         atomic_cmpset_acq_int((volatile u_int *)(dst), (u_int)(old), \
524             (u_int)(new))
525 #define atomic_cmpset_rel_ptr(dst, old, new) \
526         atomic_cmpset_rel_int((volatile u_int *)(dst), (u_int)(old), \
527             (u_int)(new))
528 #define atomic_readandclear_ptr(p) \
529         atomic_readandclear_int((volatile u_int *)(p))
530
531 #endif /* ! _CPU_ATOMIC_H_ */