e386300e579e13678f55f336928e0d9015938e4c
[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.13 2005/05/26 09:10:08 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 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_poll_acquire_int(volatile u_int *p);
142 extern void atomic_poll_release_int(volatile u_int *p);
143
144 #else
145
146 static __inline
147 int
148 atomic_poll_acquire_int(volatile u_int *p)
149 {
150         u_int data;
151
152         __asm __volatile(MPLOCKED "btsl $0,%0; setnc %%al; andl $255,%%eax" : "+m" (*p), "=a" (data));
153         return(data);
154 }
155
156 static __inline
157 void
158 atomic_poll_release_int(volatile u_int *p)
159 {
160         __asm __volatile(MPLOCKED "btrl $0,%0" : "+m" (*p));
161 }
162
163 #endif
164
165 /*
166  * These functions operate on a 32 bit interrupt interlock which is defined
167  * as follows:
168  *
169  *      bit 0-30        interrupt handler disabled bits (counter)
170  *      bit 31          interrupt handler currently running bit (1 = run)
171  *
172  * atomic_intr_cond_test(P)     Determine if the interlock is in an
173  *                              acquired state.  Returns 0 if it not
174  *                              acquired, non-zero if it is.
175  *
176  * atomic_intr_cond_enter(P, func, arg)
177  *                              Increment the request counter and attempt to
178  *                              set bit 31 to acquire the interlock.  If
179  *                              we are unable to set bit 31 func(arg) is
180  *                              called in a loop until we are able to set
181  *                              bit 31.
182  *
183  * atomic_intr_cond_exit(P, func, arg)
184  *                              Decrement the request counter and clear bit
185  *                              31.  If the request counter is still non-zero
186  *                              call func(arg) once.
187  *
188  * atomic_intr_handler_disable(P)
189  *                              Set bit 30, indicating that the interrupt
190  *                              handler has been disabled.  Must be called
191  *                              after the hardware is disabled.
192  *
193  *                              Returns bit 31 indicating whether a serialized
194  *                              accessor is active (typically the interrupt
195  *                              handler is running).  0 == not active,
196  *                              non-zero == active.
197  *
198  * atomic_intr_handler_enable(P)
199  *                              Clear bit 30, indicating that the interrupt
200  *                              handler has been enabled.  Must be called
201  *                              before the hardware is actually enabled.
202  *
203  * atomic_intr_handler_is_enabled(P)
204  *                              Returns bit 30, 0 indicates that the handler
205  *                              is enabled, non-zero indicates that it is
206  *                              disabled.  The request counter portion of
207  *                              the field is ignored.
208  */
209
210 #ifndef __ATOMIC_INTR_T
211 #define __ATOMIC_INTR_T
212 typedef volatile int atomic_intr_t;
213 #endif
214
215 #if defined(KLD_MODULE)
216
217 void atomic_intr_init(atomic_intr_t *p);
218 int atomic_intr_handler_disable(atomic_intr_t *p);
219 void atomic_intr_handler_enable(atomic_intr_t *p);
220 int atomic_intr_handler_is_enabled(atomic_intr_t *p);
221 int atomic_intr_cond_test(atomic_intr_t *p);
222 void atomic_intr_cond_enter(atomic_intr_t *p, void (*func)(void *), void *arg);
223 void atomic_intr_cond_exit(atomic_intr_t *p, void (*func)(void *), void *arg);
224
225 #else
226
227 static __inline
228 void
229 atomic_intr_init(atomic_intr_t *p)
230 {
231         *p = 0;
232 }
233
234 static __inline
235 int
236 atomic_intr_handler_disable(atomic_intr_t *p)
237 {
238         int data;
239
240         __asm __volatile(MPLOCKED "orl $0x40000000,%1; movl %1,%%eax; " \
241                                   "andl $0x80000000,%%eax" \
242                                   : "=a"(data) , "+m"(*p));
243         return(data);
244 }
245
246 static __inline
247 void
248 atomic_intr_handler_enable(atomic_intr_t *p)
249 {
250         __asm __volatile(MPLOCKED "andl $0xBFFFFFFF,%0" : "+m" (*p));
251 }
252
253 static __inline
254 int
255 atomic_intr_handler_is_enabled(atomic_intr_t *p)
256 {
257         int data;
258
259         __asm __volatile("movl %1,%%eax; andl $0x40000000,%%eax" \
260                          : "=a"(data) : "m"(*p));
261         return(data);
262 }
263
264 static __inline
265 void
266 atomic_intr_cond_enter(atomic_intr_t *p, void (*func)(void *), void *arg)
267 {
268         __asm __volatile(MPLOCKED "incl %0; " \
269                          "1: ;" \
270                          MPLOCKED "btsl $31,%0; jnc 2f; " \
271                          "pushl %2; call *%1; addl $4,%%esp; " \
272                          "jmp 1b; " \
273                          "2: ;" \
274                          : "+m" (*p) \
275                          : "r"(func), "m"(arg) \
276                          : "ax", "cx", "dx");
277 }
278
279 static __inline
280 int
281 atomic_intr_cond_test(atomic_intr_t *p)
282 {
283         return((int)(*p & 0x80000000));
284 }
285
286 static __inline
287 void
288 atomic_intr_cond_exit(atomic_intr_t *p, void (*func)(void *), void *arg)
289 {
290         __asm __volatile(MPLOCKED "decl %0; " \
291                         MPLOCKED "btrl $31,%0; " \
292                         "testl $0x3FFFFFFF,%0; jz 1f; " \
293                          "pushl %2; call *%1; addl $4,%%esp; " \
294                          "1: ;" \
295                          : "+m" (*p) \
296                          : "r"(func), "m"(arg) \
297                          : "ax", "cx", "dx");
298 }
299
300 #endif
301
302 #endif /* ! _MACHINE_ATOMIC_H_ */