2 * Copyright (c) 1998 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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 $
29 #ifndef _CPU_ATOMIC_H_
30 #define _CPU_ATOMIC_H_
33 #include <sys/types.h>
37 * Various simple arithmetic on memory which is atomic in the presence
38 * of interrupts and multiple processors.
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))
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))
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))
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))
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.
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.
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 ; "
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).
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.
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)\
98 __asm __volatile(MPLOCKED OP \
102 static __inline void \
103 atomic_##NAME##_##TYPE##_nonlocked(volatile u_##TYPE *p, u_##TYPE v)\
105 __asm __volatile(OP \
110 #endif /* KLD_MODULE */
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)
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)
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)
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)
133 #if defined(KLD_MODULE)
135 u_int atomic_readandclear_int(volatile u_int *addr);
137 #else /* !KLD_MODULE */
139 static __inline u_int
140 atomic_readandclear_int(volatile u_int *addr)
147 "# atomic_readandclear_int"
148 : "+r" (res), /* 0 */
155 #endif /* KLD_MODULE */
159 * atomic_poll_acquire_int(P) Returns non-zero on success, 0 if the lock
160 * has already been acquired.
161 * atomic_poll_release_int(P)
163 * These support the NDIS driver and are also used for IPIQ interlocks
164 * between cpus. Both the acquisition and release must be
165 * cache-synchronizing instructions.
168 #if defined(KLD_MODULE)
170 extern int atomic_swap_int(volatile int *addr, int value);
171 extern int atomic_poll_acquire_int(volatile u_int *p);
172 extern void atomic_poll_release_int(volatile u_int *p);
177 atomic_swap_int(volatile int *addr, int value)
179 __asm __volatile("xchgl %0, %1" :
180 "=r" (value), "=m" (*addr) : "0" (value) : "memory");
186 atomic_poll_acquire_int(volatile u_int *p)
190 __asm __volatile(MPLOCKED "btsl $0,%0; setnc %%al; andl $255,%%eax" : "+m" (*p), "=a" (data));
196 atomic_poll_release_int(volatile u_int *p)
198 __asm __volatile(MPLOCKED "btrl $0,%0" : "+m" (*p));
204 * These functions operate on a 32 bit interrupt interlock which is defined
207 * bit 0-30 interrupt handler disabled bits (counter)
208 * bit 31 interrupt handler currently running bit (1 = run)
210 * atomic_intr_cond_test(P) Determine if the interlock is in an
211 * acquired state. Returns 0 if it not
212 * acquired, non-zero if it is.
214 * atomic_intr_cond_try(P)
215 * Increment the request counter and attempt to
216 * set bit 31 to acquire the interlock. If
217 * we are unable to set bit 31 the request
218 * counter is decremented and we return -1,
219 * otherwise we return 0.
221 * atomic_intr_cond_enter(P, func, arg)
222 * Increment the request counter and attempt to
223 * set bit 31 to acquire the interlock. If
224 * we are unable to set bit 31 func(arg) is
225 * called in a loop until we are able to set
228 * atomic_intr_cond_exit(P, func, arg)
229 * Decrement the request counter and clear bit
230 * 31. If the request counter is still non-zero
231 * call func(arg) once.
233 * atomic_intr_handler_disable(P)
234 * Set bit 30, indicating that the interrupt
235 * handler has been disabled. Must be called
236 * after the hardware is disabled.
238 * Returns bit 31 indicating whether a serialized
239 * accessor is active (typically the interrupt
240 * handler is running). 0 == not active,
241 * non-zero == active.
243 * atomic_intr_handler_enable(P)
244 * Clear bit 30, indicating that the interrupt
245 * handler has been enabled. Must be called
246 * before the hardware is actually enabled.
248 * atomic_intr_handler_is_enabled(P)
249 * Returns bit 30, 0 indicates that the handler
250 * is enabled, non-zero indicates that it is
251 * disabled. The request counter portion of
252 * the field is ignored.
255 #if defined(KLD_MODULE)
257 void atomic_intr_init(__atomic_intr_t *p);
258 int atomic_intr_handler_disable(__atomic_intr_t *p);
259 void atomic_intr_handler_enable(__atomic_intr_t *p);
260 int atomic_intr_handler_is_enabled(__atomic_intr_t *p);
261 int atomic_intr_cond_test(__atomic_intr_t *p);
262 int atomic_intr_cond_try(__atomic_intr_t *p);
263 void atomic_intr_cond_enter(__atomic_intr_t *p, void (*func)(void *), void *arg);
264 void atomic_intr_cond_exit(__atomic_intr_t *p, void (*func)(void *), void *arg);
270 atomic_intr_init(__atomic_intr_t *p)
277 atomic_intr_handler_disable(__atomic_intr_t *p)
281 __asm __volatile(MPLOCKED "orl $0x40000000,%1; movl %1,%%eax; " \
282 "andl $0x80000000,%%eax" \
283 : "=a"(data) , "+m"(*p));
289 atomic_intr_handler_enable(__atomic_intr_t *p)
291 __asm __volatile(MPLOCKED "andl $0xBFFFFFFF,%0" : "+m" (*p));
296 atomic_intr_handler_is_enabled(__atomic_intr_t *p)
300 __asm __volatile("movl %1,%%eax; andl $0x40000000,%%eax" \
301 : "=a"(data) : "m"(*p));
307 atomic_intr_cond_enter(__atomic_intr_t *p, void (*func)(void *), void *arg)
309 __asm __volatile(MPLOCKED "incl %0; " \
311 MPLOCKED "btsl $31,%0; jnc 2f; " \
312 "pushl %2; call *%1; addl $4,%%esp; " \
316 : "r"(func), "m"(arg) \
321 * Attempt to enter the interrupt condition variable. Returns zero on
322 * success, 1 on failure.
326 atomic_intr_cond_try(__atomic_intr_t *p)
330 __asm __volatile(MPLOCKED "incl %0; " \
332 "subl %%eax,%%eax; " \
333 MPLOCKED "btsl $31,%0; jnc 2f; " \
334 MPLOCKED "decl %0; " \
337 : "+m" (*p), "=&a"(ret)
345 atomic_intr_cond_test(__atomic_intr_t *p)
347 return((int)(*p & 0x80000000));
352 atomic_intr_cond_exit(__atomic_intr_t *p, void (*func)(void *), void *arg)
354 __asm __volatile(MPLOCKED "decl %0; " \
355 MPLOCKED "btrl $31,%0; " \
356 "testl $0x3FFFFFFF,%0; jz 1f; " \
357 "pushl %2; call *%1; addl $4,%%esp; " \
360 : "r"(func), "m"(arg) \
367 * Atomic compare and set
369 * if (*_dst == _old) *_dst = _new (all 32 bit words)
371 * Returns 0 on failure, non-zero on success
373 #if defined(KLD_MODULE)
375 extern int atomic_cmpset_int(volatile u_int *_dst, u_int _old, u_int _new);
376 extern long atomic_cmpset_long(volatile u_long *_dst, u_long _exp, u_long _src);
377 extern u_int atomic_fetchadd_int(volatile u_int *_p, u_int _v);
382 atomic_cmpset_int(volatile u_int *_dst, u_int _old, u_int _new)
386 __asm __volatile(MPLOCKED "cmpxchgl %2,%1; " \
387 : "+a" (res), "=m" (*_dst) \
388 : "r" (_new), "m" (*_dst) \
390 return (res == _old);
394 atomic_cmpset_long(volatile u_long *_dst, u_long _exp, u_long _src)
396 return (atomic_cmpset_int((volatile u_int *)_dst, (u_int)_exp,
401 * Atomically add the value of v to the integer pointed to by p and return
402 * the previous value of *p.
404 static __inline u_int
405 atomic_fetchadd_int(volatile u_int *_p, u_int _v)
407 __asm __volatile(MPLOCKED "xaddl %0,%1; " \
408 : "+r" (_v), "=m" (*_p) \
414 #endif /* KLD_MODULE */
416 #if defined(KLD_MODULE)
418 #define ATOMIC_STORE_LOAD(TYPE, LOP, SOP) \
419 extern u_##TYPE atomic_load_acq_##TYPE(volatile u_##TYPE *p); \
420 extern void atomic_store_rel_##TYPE(volatile u_##TYPE *p, u_##TYPE v);
422 #else /* !KLD_MODULE */
424 #if defined(_KERNEL) && !defined(SMP)
426 * We assume that a = b will do atomic loads and stores. However, on a
427 * PentiumPro or higher, reads may pass writes, so for that case we have
428 * to use a serializing instruction (i.e. with LOCK) to do the load in
429 * SMP kernels. For UP kernels, however, the cache of the single processor
430 * is always consistent, so we don't need any memory barriers.
432 #define ATOMIC_STORE_LOAD(TYPE, LOP, SOP) \
433 static __inline u_##TYPE \
434 atomic_load_acq_##TYPE(volatile u_##TYPE *p) \
439 static __inline void \
440 atomic_store_rel_##TYPE(volatile u_##TYPE *p, u_##TYPE v)\
446 #else /* !(_KERNEL && !SMP) */
448 #define ATOMIC_STORE_LOAD(TYPE, LOP, SOP) \
449 static __inline u_##TYPE \
450 atomic_load_acq_##TYPE(volatile u_##TYPE *p) \
454 __asm __volatile(MPLOCKED LOP \
455 : "=a" (res), /* 0 */ \
464 * The XCHG instruction asserts LOCK automagically. \
466 static __inline void \
467 atomic_store_rel_##TYPE(volatile u_##TYPE *p, u_##TYPE v)\
469 __asm __volatile(SOP \
470 : "=m" (*p), /* 0 */ \
472 : "m" (*p)); /* 2 */ \
476 #endif /* _KERNEL && !SMP */
478 #endif /* !KLD_MODULE */
480 ATOMIC_STORE_LOAD(char, "cmpxchgb %b0,%1", "xchgb %b1,%0");
481 ATOMIC_STORE_LOAD(short,"cmpxchgw %w0,%1", "xchgw %w1,%0");
482 ATOMIC_STORE_LOAD(int, "cmpxchgl %0,%1", "xchgl %1,%0");
483 ATOMIC_STORE_LOAD(long, "cmpxchgl %0,%1", "xchgl %1,%0");
486 #undef ATOMIC_STORE_LOAD
488 /* Acquire and release variants are identical to the normal ones. */
489 #define atomic_set_acq_char atomic_set_char
490 #define atomic_set_rel_char atomic_set_char
491 #define atomic_clear_acq_char atomic_clear_char
492 #define atomic_clear_rel_char atomic_clear_char
493 #define atomic_add_acq_char atomic_add_char
494 #define atomic_add_rel_char atomic_add_char
495 #define atomic_subtract_acq_char atomic_subtract_char
496 #define atomic_subtract_rel_char atomic_subtract_char
498 #define atomic_set_acq_short atomic_set_short
499 #define atomic_set_rel_short atomic_set_short
500 #define atomic_clear_acq_short atomic_clear_short
501 #define atomic_clear_rel_short atomic_clear_short
502 #define atomic_add_acq_short atomic_add_short
503 #define atomic_add_rel_short atomic_add_short
504 #define atomic_subtract_acq_short atomic_subtract_short
505 #define atomic_subtract_rel_short atomic_subtract_short
507 #define atomic_set_acq_int atomic_set_int
508 #define atomic_set_rel_int atomic_set_int
509 #define atomic_clear_acq_int atomic_clear_int
510 #define atomic_clear_rel_int atomic_clear_int
511 #define atomic_add_acq_int atomic_add_int
512 #define atomic_add_rel_int atomic_add_int
513 #define atomic_subtract_acq_int atomic_subtract_int
514 #define atomic_subtract_rel_int atomic_subtract_int
515 #define atomic_cmpset_acq_int atomic_cmpset_int
516 #define atomic_cmpset_rel_int atomic_cmpset_int
518 #define atomic_set_acq_long atomic_set_long
519 #define atomic_set_rel_long atomic_set_long
520 #define atomic_clear_acq_long atomic_clear_long
521 #define atomic_clear_rel_long atomic_clear_long
522 #define atomic_add_acq_long atomic_add_long
523 #define atomic_add_rel_long atomic_add_long
524 #define atomic_subtract_acq_long atomic_subtract_long
525 #define atomic_subtract_rel_long atomic_subtract_long
526 #define atomic_cmpset_acq_long atomic_cmpset_long
527 #define atomic_cmpset_rel_long atomic_cmpset_long
529 /* Operations on 8-bit bytes. */
530 #define atomic_set_8 atomic_set_char
531 #define atomic_set_acq_8 atomic_set_acq_char
532 #define atomic_set_rel_8 atomic_set_rel_char
533 #define atomic_clear_8 atomic_clear_char
534 #define atomic_clear_acq_8 atomic_clear_acq_char
535 #define atomic_clear_rel_8 atomic_clear_rel_char
536 #define atomic_add_8 atomic_add_char
537 #define atomic_add_acq_8 atomic_add_acq_char
538 #define atomic_add_rel_8 atomic_add_rel_char
539 #define atomic_subtract_8 atomic_subtract_char
540 #define atomic_subtract_acq_8 atomic_subtract_acq_char
541 #define atomic_subtract_rel_8 atomic_subtract_rel_char
542 #define atomic_load_acq_8 atomic_load_acq_char
543 #define atomic_store_rel_8 atomic_store_rel_char
545 /* Operations on 16-bit words. */
546 #define atomic_set_16 atomic_set_short
547 #define atomic_set_acq_16 atomic_set_acq_short
548 #define atomic_set_rel_16 atomic_set_rel_short
549 #define atomic_clear_16 atomic_clear_short
550 #define atomic_clear_acq_16 atomic_clear_acq_short
551 #define atomic_clear_rel_16 atomic_clear_rel_short
552 #define atomic_add_16 atomic_add_short
553 #define atomic_add_acq_16 atomic_add_acq_short
554 #define atomic_add_rel_16 atomic_add_rel_short
555 #define atomic_subtract_16 atomic_subtract_short
556 #define atomic_subtract_acq_16 atomic_subtract_acq_short
557 #define atomic_subtract_rel_16 atomic_subtract_rel_short
558 #define atomic_load_acq_16 atomic_load_acq_short
559 #define atomic_store_rel_16 atomic_store_rel_short
561 /* Operations on 32-bit double words. */
562 #define atomic_set_32 atomic_set_int
563 #define atomic_set_acq_32 atomic_set_acq_int
564 #define atomic_set_rel_32 atomic_set_rel_int
565 #define atomic_clear_32 atomic_clear_int
566 #define atomic_clear_acq_32 atomic_clear_acq_int
567 #define atomic_clear_rel_32 atomic_clear_rel_int
568 #define atomic_add_32 atomic_add_int
569 #define atomic_add_acq_32 atomic_add_acq_int
570 #define atomic_add_rel_32 atomic_add_rel_int
571 #define atomic_subtract_32 atomic_subtract_int
572 #define atomic_subtract_acq_32 atomic_subtract_acq_int
573 #define atomic_subtract_rel_32 atomic_subtract_rel_int
574 #define atomic_load_acq_32 atomic_load_acq_int
575 #define atomic_store_rel_32 atomic_store_rel_int
576 #define atomic_cmpset_32 atomic_cmpset_int
577 #define atomic_cmpset_acq_32 atomic_cmpset_acq_int
578 #define atomic_cmpset_rel_32 atomic_cmpset_rel_int
579 #define atomic_readandclear_32 atomic_readandclear_int
580 #define atomic_fetchadd_32 atomic_fetchadd_int
582 /* Operations on pointers. */
583 #define atomic_set_ptr(p, v) \
584 atomic_set_int((volatile u_int *)(p), (u_int)(v))
585 #define atomic_set_acq_ptr(p, v) \
586 atomic_set_acq_int((volatile u_int *)(p), (u_int)(v))
587 #define atomic_set_rel_ptr(p, v) \
588 atomic_set_rel_int((volatile u_int *)(p), (u_int)(v))
589 #define atomic_clear_ptr(p, v) \
590 atomic_clear_int((volatile u_int *)(p), (u_int)(v))
591 #define atomic_clear_acq_ptr(p, v) \
592 atomic_clear_acq_int((volatile u_int *)(p), (u_int)(v))
593 #define atomic_clear_rel_ptr(p, v) \
594 atomic_clear_rel_int((volatile u_int *)(p), (u_int)(v))
595 #define atomic_add_ptr(p, v) \
596 atomic_add_int((volatile u_int *)(p), (u_int)(v))
597 #define atomic_add_acq_ptr(p, v) \
598 atomic_add_acq_int((volatile u_int *)(p), (u_int)(v))
599 #define atomic_add_rel_ptr(p, v) \
600 atomic_add_rel_int((volatile u_int *)(p), (u_int)(v))
601 #define atomic_subtract_ptr(p, v) \
602 atomic_subtract_int((volatile u_int *)(p), (u_int)(v))
603 #define atomic_subtract_acq_ptr(p, v) \
604 atomic_subtract_acq_int((volatile u_int *)(p), (u_int)(v))
605 #define atomic_subtract_rel_ptr(p, v) \
606 atomic_subtract_rel_int((volatile u_int *)(p), (u_int)(v))
607 #define atomic_load_acq_ptr(p) \
608 atomic_load_acq_int((volatile u_int *)(p))
609 #define atomic_store_rel_ptr(p, v) \
610 atomic_store_rel_int((volatile u_int *)(p), (v))
611 #define atomic_cmpset_ptr(dst, old, new) \
612 atomic_cmpset_int((volatile u_int *)(dst), (u_int)(old), (u_int)(new))
613 #define atomic_cmpset_acq_ptr(dst, old, new) \
614 atomic_cmpset_acq_int((volatile u_int *)(dst), (u_int)(old), \
616 #define atomic_cmpset_rel_ptr(dst, old, new) \
617 atomic_cmpset_rel_int((volatile u_int *)(dst), (u_int)(old), \
619 #define atomic_readandclear_ptr(p) \
620 atomic_readandclear_int((volatile u_int *)(p))
622 #endif /* ! _CPU_ATOMIC_H_ */