Lindent pass
[akaros.git] / kern / arch / x86 / bitops.h
1 #ifndef _ASM_X86_BITOPS_H
2 #define _ASM_X86_BITOPS_H
3
4 /*
5  * Copyright 1992, Linus Torvalds.
6  *
7  * Note: inlines with more than a single statement should be marked
8  * __always_inline to avoid problems with older gcc's inlining heuristics.
9  */
10
11 #ifndef _LINUX_BITOPS_H
12 #error only <linux/bitops.h> can be included directly
13 #endif
14
15 #include <linux/compiler.h>
16 #include <asm/alternative.h>
17
18 #define BIT_64(n)                       (U64_C(1) << (n))
19
20 /*
21  * These have to be done with inline assembly: that way the bit-setting
22  * is guaranteed to be atomic. All bit operations return 0 if the bit
23  * was cleared before the operation and != 0 if it was not.
24  *
25  * bit 0 is the LSB of addr; bit 32 is the LSB of (addr+1).
26  */
27
28 #if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 1)
29 /* Technically wrong, but this avoids compilation errors on some gcc
30    versions. */
31 #define BITOP_ADDR(x) "=m" (*(volatile long *) (x))
32 #else
33 #define BITOP_ADDR(x) "+m" (*(volatile long *) (x))
34 #endif
35
36 #define ADDR                            BITOP_ADDR(addr)
37
38 /*
39  * We do the locked ops that don't return the old value as
40  * a mask operation on a byte.
41  */
42 #define IS_IMMEDIATE(nr)                (__builtin_constant_p(nr))
43 #define CONST_MASK_ADDR(nr, addr)       BITOP_ADDR((void *)(addr) + ((nr)>>3))
44 #define CONST_MASK(nr)                  (1 << ((nr) & 7))
45
46 /**
47  * set_bit - Atomically set a bit in memory
48  * @nr: the bit to set
49  * @addr: the address to start counting from
50  *
51  * This function is atomic and may not be reordered.  See __set_bit()
52  * if you do not require the atomic guarantees.
53  *
54  * Note: there are no guarantees that this function will not be reordered
55  * on non x86 architectures, so if you are writing portable code,
56  * make sure not to rely on its reordering guarantees.
57  *
58  * Note that @nr may be almost arbitrarily large; this function is not
59  * restricted to acting on a single-word quantity.
60  */
61 static __always_inline void
62 set_bit(unsigned int nr, volatile unsigned long *addr)
63 {
64         if (IS_IMMEDIATE(nr)) {
65                 asm volatile (LOCK_PREFIX "orb %1,%0":CONST_MASK_ADDR(nr, addr)
66                                           :"iq"((u8) CONST_MASK(nr))
67                                           :"memory");
68         } else {
69                 asm volatile (LOCK_PREFIX
70                                           "bts %1,%0":BITOP_ADDR(addr):"Ir"(nr):"memory");
71         }
72 }
73
74 /**
75  * __set_bit - Set a bit in memory
76  * @nr: the bit to set
77  * @addr: the address to start counting from
78  *
79  * Unlike set_bit(), this function is non-atomic and may be reordered.
80  * If it's called on the same region of memory simultaneously, the effect
81  * may be that only one operation succeeds.
82  */
83 static inline void __set_bit(int nr, volatile unsigned long *addr)
84 {
85         asm volatile ("bts %1,%0":ADDR:"Ir"(nr):"memory");
86 }
87
88 /**
89  * clear_bit - Clears a bit in memory
90  * @nr: Bit to clear
91  * @addr: Address to start counting from
92  *
93  * clear_bit() is atomic and may not be reordered.  However, it does
94  * not contain a memory barrier, so if it is used for locking purposes,
95  * you should call smp_mb__before_clear_bit() and/or smp_mb__after_clear_bit()
96  * in order to ensure changes are visible on other processors.
97  */
98 static __always_inline void clear_bit(int nr, volatile unsigned long *addr)
99 {
100         if (IS_IMMEDIATE(nr)) {
101                 asm volatile (LOCK_PREFIX "andb %1,%0":CONST_MASK_ADDR(nr, addr)
102                                           :"iq"((u8) ~ CONST_MASK(nr)));
103         } else {
104                 asm volatile (LOCK_PREFIX "btr %1,%0":BITOP_ADDR(addr)
105                                           :"Ir"(nr));
106         }
107 }
108
109 /*
110  * clear_bit_unlock - Clears a bit in memory
111  * @nr: Bit to clear
112  * @addr: Address to start counting from
113  *
114  * clear_bit() is atomic and implies release semantics before the memory
115  * operation. It can be used for an unlock.
116  */
117 static inline void clear_bit_unlock(unsigned nr, volatile unsigned long *addr)
118 {
119         barrier();
120         clear_bit(nr, addr);
121 }
122
123 static inline void __clear_bit(int nr, volatile unsigned long *addr)
124 {
125         asm volatile ("btr %1,%0":ADDR:"Ir"(nr));
126 }
127
128 /*
129  * __clear_bit_unlock - Clears a bit in memory
130  * @nr: Bit to clear
131  * @addr: Address to start counting from
132  *
133  * __clear_bit() is non-atomic and implies release semantics before the memory
134  * operation. It can be used for an unlock if no other CPUs can concurrently
135  * modify other bits in the word.
136  *
137  * No memory barrier is required here, because x86 cannot reorder stores past
138  * older loads. Same principle as spin_unlock.
139  */
140 static inline void __clear_bit_unlock(unsigned nr, volatile unsigned long *addr)
141 {
142         barrier();
143         __clear_bit(nr, addr);
144 }
145
146 #define smp_mb__before_clear_bit()      barrier()
147 #define smp_mb__after_clear_bit()       barrier()
148
149 /**
150  * __change_bit - Toggle a bit in memory
151  * @nr: the bit to change
152  * @addr: the address to start counting from
153  *
154  * Unlike change_bit(), this function is non-atomic and may be reordered.
155  * If it's called on the same region of memory simultaneously, the effect
156  * may be that only one operation succeeds.
157  */
158 static inline void __change_bit(int nr, volatile unsigned long *addr)
159 {
160         asm volatile ("btc %1,%0":ADDR:"Ir"(nr));
161 }
162
163 /**
164  * change_bit - Toggle a bit in memory
165  * @nr: Bit to change
166  * @addr: Address to start counting from
167  *
168  * change_bit() is atomic and may not be reordered.
169  * Note that @nr may be almost arbitrarily large; this function is not
170  * restricted to acting on a single-word quantity.
171  */
172 static inline void change_bit(int nr, volatile unsigned long *addr)
173 {
174         if (IS_IMMEDIATE(nr)) {
175                 asm volatile (LOCK_PREFIX "xorb %1,%0":CONST_MASK_ADDR(nr, addr)
176                                           :"iq"((u8) CONST_MASK(nr)));
177         } else {
178                 asm volatile (LOCK_PREFIX "btc %1,%0":BITOP_ADDR(addr)
179                                           :"Ir"(nr));
180         }
181 }
182
183 /**
184  * test_and_set_bit - Set a bit and return its old value
185  * @nr: Bit to set
186  * @addr: Address to count from
187  *
188  * This operation is atomic and cannot be reordered.
189  * It also implies a memory barrier.
190  */
191 static inline int test_and_set_bit(int nr, volatile unsigned long *addr)
192 {
193         int oldbit;
194
195         asm volatile (LOCK_PREFIX "bts %2,%1\n\t"
196                                   "sbb %0,%0":"=r"(oldbit), ADDR:"Ir"(nr):"memory");
197
198         return oldbit;
199 }
200
201 /**
202  * test_and_set_bit_lock - Set a bit and return its old value for lock
203  * @nr: Bit to set
204  * @addr: Address to count from
205  *
206  * This is the same as test_and_set_bit on x86.
207  */
208 static __always_inline int
209 test_and_set_bit_lock(int nr, volatile unsigned long *addr)
210 {
211         return test_and_set_bit(nr, addr);
212 }
213
214 /**
215  * __test_and_set_bit - Set a bit and return its old value
216  * @nr: Bit to set
217  * @addr: Address to count from
218  *
219  * This operation is non-atomic and can be reordered.
220  * If two examples of this operation race, one can appear to succeed
221  * but actually fail.  You must protect multiple accesses with a lock.
222  */
223 static inline int __test_and_set_bit(int nr, volatile unsigned long *addr)
224 {
225         int oldbit;
226
227 asm("bts %2,%1\n\t" "sbb %0,%0": "=r"(oldbit), ADDR:"Ir"(nr));
228         return oldbit;
229 }
230
231 /**
232  * test_and_clear_bit - Clear a bit and return its old value
233  * @nr: Bit to clear
234  * @addr: Address to count from
235  *
236  * This operation is atomic and cannot be reordered.
237  * It also implies a memory barrier.
238  */
239 static inline int test_and_clear_bit(int nr, volatile unsigned long *addr)
240 {
241         int oldbit;
242
243         asm volatile (LOCK_PREFIX "btr %2,%1\n\t"
244                                   "sbb %0,%0":"=r"(oldbit), ADDR:"Ir"(nr):"memory");
245
246         return oldbit;
247 }
248
249 /**
250  * __test_and_clear_bit - Clear a bit and return its old value
251  * @nr: Bit to clear
252  * @addr: Address to count from
253  *
254  * This operation is non-atomic and can be reordered.
255  * If two examples of this operation race, one can appear to succeed
256  * but actually fail.  You must protect multiple accesses with a lock.
257  *
258  * Note: the operation is performed atomically with respect to
259  * the local CPU, but not other CPUs. Portable code should not
260  * rely on this behaviour.
261  * KVM relies on this behaviour on x86 for modifying memory that is also
262  * accessed from a hypervisor on the same CPU if running in a VM: don't change
263  * this without also updating arch/x86/kernel/kvm.c
264  */
265 static inline int __test_and_clear_bit(int nr, volatile unsigned long *addr)
266 {
267         int oldbit;
268
269         asm volatile ("btr %2,%1\n\t" "sbb %0,%0":"=r" (oldbit), ADDR:"Ir"(nr));
270         return oldbit;
271 }
272
273 /* WARNING: non atomic and it can be reordered! */
274 static inline int __test_and_change_bit(int nr, volatile unsigned long *addr)
275 {
276         int oldbit;
277
278         asm volatile ("btc %2,%1\n\t"
279                                   "sbb %0,%0":"=r" (oldbit), ADDR:"Ir"(nr):"memory");
280
281         return oldbit;
282 }
283
284 /**
285  * test_and_change_bit - Change a bit and return its old value
286  * @nr: Bit to change
287  * @addr: Address to count from
288  *
289  * This operation is atomic and cannot be reordered.
290  * It also implies a memory barrier.
291  */
292 static inline int test_and_change_bit(int nr, volatile unsigned long *addr)
293 {
294         int oldbit;
295
296         asm volatile (LOCK_PREFIX "btc %2,%1\n\t"
297                                   "sbb %0,%0":"=r"(oldbit), ADDR:"Ir"(nr):"memory");
298
299         return oldbit;
300 }
301
302 static __always_inline int constant_test_bit(unsigned int nr,
303                                                                                          const volatile unsigned long *addr)
304 {
305         return ((1UL << (nr % BITS_PER_LONG)) & (addr[nr / BITS_PER_LONG])) != 0;
306 }
307
308 static inline int variable_test_bit(int nr, volatile const unsigned long *addr)
309 {
310         int oldbit;
311
312         asm volatile ("bt %2,%1\n\t" "sbb %0,%0":"=r" (oldbit)
313                                   :"m"(*(unsigned long *)addr), "Ir"(nr));
314
315         return oldbit;
316 }
317
318 #if 0   /* Fool kernel-doc since it doesn't do macros yet */
319 /**
320  * test_bit - Determine whether a bit is set
321  * @nr: bit number to test
322  * @addr: Address to start counting from
323  */
324 static int test_bit(int nr, const volatile unsigned long *addr);
325 #endif
326
327 #define test_bit(nr, addr)                      \
328         (__builtin_constant_p((nr))             \
329          ? constant_test_bit((nr), (addr))      \
330          : variable_test_bit((nr), (addr)))
331
332 /**
333  * __ffs - find first set bit in word
334  * @word: The word to search
335  *
336  * Undefined if no bit exists, so code should check against 0 first.
337  */
338 static inline unsigned long __ffs(unsigned long word)
339 {
340 asm("rep; bsf %1,%0":"=r"(word)
341 :               "rm"(word));
342         return word;
343 }
344
345 /**
346  * ffz - find first zero bit in word
347  * @word: The word to search
348  *
349  * Undefined if no zero exists, so code should check against ~0UL first.
350  */
351 static inline unsigned long ffz(unsigned long word)
352 {
353 asm("rep; bsf %1,%0":"=r"(word)
354 :               "r"(~word));
355         return word;
356 }
357
358 /*
359  * __fls: find last set bit in word
360  * @word: The word to search
361  *
362  * Undefined if no set bit exists, so code should check against 0 first.
363  */
364 static inline unsigned long __fls(unsigned long word)
365 {
366 asm("bsr %1,%0":"=r"(word)
367 :               "rm"(word));
368         return word;
369 }
370
371 #undef ADDR
372
373 #ifdef __KERNEL__
374 /**
375  * ffs - find first set bit in word
376  * @x: the word to search
377  *
378  * This is defined the same way as the libc and compiler builtin ffs
379  * routines, therefore differs in spirit from the other bitops.
380  *
381  * ffs(value) returns 0 if value is 0 or the position of the first
382  * set bit if value is nonzero. The first (least significant) bit
383  * is at position 1.
384  */
385 static inline int ffs(int x)
386 {
387         int r;
388
389 #ifdef CONFIG_X86_64
390         /*
391          * AMD64 says BSFL won't clobber the dest reg if x==0; Intel64 says the
392          * dest reg is undefined if x==0, but their CPU architect says its
393          * value is written to set it to the same as before, except that the
394          * top 32 bits will be cleared.
395          *
396          * We cannot do this on 32 bits because at the very least some
397          * 486 CPUs did not behave this way.
398          */
399 asm("bsfl %1,%0":"=r"(r)
400 :               "rm"(x), "0"(-1));
401 #elif defined(CONFIG_X86_CMOV)
402 asm("bsfl %1,%0\n\t" "cmovzl %2,%0": "=&r"(r):"rm"(x), "r"(-1));
403 #else
404 asm("bsfl %1,%0\n\t" "jnz 1f\n\t" "movl $-1,%0\n" "1:": "=r"(r):"rm"(x));
405 #endif
406         return r + 1;
407 }
408
409 /**
410  * fls - find last set bit in word
411  * @x: the word to search
412  *
413  * This is defined in a similar way as the libc and compiler builtin
414  * ffs, but returns the position of the most significant set bit.
415  *
416  * fls(value) returns 0 if value is 0 or the position of the last
417  * set bit if value is nonzero. The last (most significant) bit is
418  * at position 32.
419  */
420 static inline int fls(int x)
421 {
422         int r;
423
424 #ifdef CONFIG_X86_64
425         /*
426          * AMD64 says BSRL won't clobber the dest reg if x==0; Intel64 says the
427          * dest reg is undefined if x==0, but their CPU architect says its
428          * value is written to set it to the same as before, except that the
429          * top 32 bits will be cleared.
430          *
431          * We cannot do this on 32 bits because at the very least some
432          * 486 CPUs did not behave this way.
433          */
434 asm("bsrl %1,%0":"=r"(r)
435 :               "rm"(x), "0"(-1));
436 #elif defined(CONFIG_X86_CMOV)
437 asm("bsrl %1,%0\n\t" "cmovzl %2,%0": "=&r"(r):"rm"(x), "rm"(-1));
438 #else
439 asm("bsrl %1,%0\n\t" "jnz 1f\n\t" "movl $-1,%0\n" "1:": "=r"(r):"rm"(x));
440 #endif
441         return r + 1;
442 }
443
444 /**
445  * fls64 - find last set bit in a 64-bit word
446  * @x: the word to search
447  *
448  * This is defined in a similar way as the libc and compiler builtin
449  * ffsll, but returns the position of the most significant set bit.
450  *
451  * fls64(value) returns 0 if value is 0 or the position of the last
452  * set bit if value is nonzero. The last (most significant) bit is
453  * at position 64.
454  */
455 #ifdef CONFIG_X86_64
456 static __always_inline int fls64(__u64 x)
457 {
458         int bitpos = -1;
459         /*
460          * AMD64 says BSRQ won't clobber the dest reg if x==0; Intel64 says the
461          * dest reg is undefined if x==0, but their CPU architect says its
462          * value is written to set it to the same as before.
463          */
464 asm("bsrq %1,%q0":"+r"(bitpos)
465 :               "rm"(x));
466         return bitpos + 1;
467 }
468 #else
469 #include <asm-generic/bitops/fls64.h>
470 #endif
471
472 #include <asm-generic/bitops/find.h>
473
474 #include <asm-generic/bitops/sched.h>
475
476 #define ARCH_HAS_FAST_MULTIPLIER 1
477
478 #include <asm/arch_hweight.h>
479
480 #include <asm-generic/bitops/const_hweight.h>
481
482 #include <asm-generic/bitops/le.h>
483
484 #include <asm-generic/bitops/ext2-atomic-setbit.h>
485
486 #endif /* __KERNEL__ */
487 #endif /* _ASM_X86_BITOPS_H */