Merge from vendor branch LIBARCHIVE:
[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.8 2004/07/29 20:31:13 dillon 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 on failure
131  * atomic_poll_release_int(P)
132  *
133  * Currently these are hacks just to support the NDIS driver.
134  */
135
136 #if defined(KLD_MODULE)
137
138 extern int atomic_poll_acquire_int(volatile u_int *p);
139 extern void atomic_poll_release_int(volatile u_int *p);
140
141 #else
142
143 static __inline
144 int
145 atomic_poll_acquire_int(volatile u_int *p)
146 {
147         u_int data;
148
149         __asm __volatile(MPLOCKED "btsl $0,%0; setnc %%al; andl $255,%%eax" : "+m" (*p), "=a" (data));
150         return(data);
151 }
152
153 static __inline
154 void
155 atomic_poll_release_int(volatile u_int *p)
156 {
157         __asm __volatile("movl $0,%0" : "+m" (*p));
158 }
159
160 #endif
161
162 #endif /* ! _MACHINE_ATOMIC_H_ */