[PATCH] x86_64 merge: arch + asm
[opensuse:kernel.git] / include / asm-x86_64 / bitops.h
1 #ifndef _X86_64_BITOPS_H
2 #define _X86_64_BITOPS_H
3
4 /*
5  * Copyright 1992, Linus Torvalds.
6  */
7
8 #include <linux/config.h>
9
10 /*
11  * These have to be done with inline assembly: that way the bit-setting
12  * is guaranteed to be atomic. All bit operations return 0 if the bit
13  * was cleared before the operation and != 0 if it was not.
14  *
15  * bit 0 is the LSB of addr; bit 32 is the LSB of (addr+1).
16  */
17
18 #ifdef CONFIG_SMP
19 #define LOCK_PREFIX "lock ; "
20 #else
21 #define LOCK_PREFIX ""
22 #endif
23
24 #define ADDR (*(volatile long *) addr)
25
26 /**
27  * set_bit - Atomically set a bit in memory
28  * @nr: the bit to set
29  * @addr: the address to start counting from
30  *
31  * This function is atomic and may not be reordered.  See __set_bit()
32  * if you do not require the atomic guarantees.
33  */
34 static __inline__ void set_bit(int nr, volatile void * addr)
35 {
36         __asm__ __volatile__( LOCK_PREFIX
37                 "btsl %1,%0"
38                 :"=m" (ADDR)
39                 :"dIr" (nr));
40 }
41
42 /**
43  * __set_bit - Set a bit in memory
44  * @nr: the bit to set
45  * @addr: the address to start counting from
46  *
47  * Unlike set_bit(), this function is non-atomic and may be reordered.
48  * If it's called on the same region of memory simultaneously, the effect
49  * may be that only one operation succeeds.
50  */
51 static __inline__ void __set_bit(int nr, volatile void * addr)
52 {
53         __asm__(
54                 "btsl %1,%0"
55                 :"=m" (ADDR)
56                 :"dIr" (nr));
57 }
58
59 /**
60  * clear_bit - Clears a bit in memory
61  * @nr: Bit to clear
62  * @addr: Address to start counting from
63  *
64  * clear_bit() is atomic and may not be reordered.  However, it does
65  * not contain a memory barrier, so if it is used for locking purposes,
66  * you should call smp_mb__before_clear_bit() and/or smp_mb__after_clear_bit()
67  * in order to ensure changes are visible on other processors.
68  */
69 static __inline__ void clear_bit(int nr, volatile void * addr)
70 {
71         __asm__ __volatile__( LOCK_PREFIX
72                 "btrl %1,%0"
73                 :"=m" (ADDR)
74                 :"dIr" (nr));
75 }
76
77 static __inline__ void __clear_bit(int nr, volatile void * addr)
78 {
79         __asm__ __volatile__(
80                 "btrl %1,%0"
81                 :"=m" (ADDR)
82                 :"Ir" (nr));
83 }
84 #define smp_mb__before_clear_bit()      barrier()
85 #define smp_mb__after_clear_bit()       barrier()
86
87 /**
88  * __change_bit - Toggle a bit in memory
89  * @nr: the bit to set
90  * @addr: the address to start counting from
91  *
92  * Unlike change_bit(), this function is non-atomic and may be reordered.
93  * If it's called on the same region of memory simultaneously, the effect
94  * may be that only one operation succeeds.
95  */
96 static __inline__ void __change_bit(int nr, volatile void * addr)
97 {
98         __asm__ __volatile__(
99                 "btcl %1,%0"
100                 :"=m" (ADDR)
101                 :"dIr" (nr));
102 }
103
104 /**
105  * change_bit - Toggle a bit in memory
106  * @nr: Bit to clear
107  * @addr: Address to start counting from
108  *
109  * change_bit() is atomic and may not be reordered.
110  * Note that @nr may be almost arbitrarily large; this function is not
111  * restricted to acting on a single-word quantity.
112  */
113 static __inline__ void change_bit(int nr, volatile void * addr)
114 {
115         __asm__ __volatile__( LOCK_PREFIX
116                 "btcl %1,%0"
117                 :"=m" (ADDR)
118                 :"dIr" (nr));
119 }
120
121 /**
122  * test_and_set_bit - Set a bit and return its old value
123  * @nr: Bit to set
124  * @addr: Address to count from
125  *
126  * This operation is atomic and cannot be reordered.  
127  * It also implies a memory barrier.
128  */
129 static __inline__ int test_and_set_bit(int nr, volatile void * addr)
130 {
131         int oldbit;
132
133         __asm__ __volatile__( LOCK_PREFIX
134                 "btsl %2,%1\n\tsbbl %0,%0"
135                 :"=r" (oldbit),"=m" (ADDR)
136                 :"dIr" (nr) : "memory");
137         return oldbit;
138 }
139
140 /**
141  * __test_and_set_bit - Set a bit and return its old value
142  * @nr: Bit to set
143  * @addr: Address to count from
144  *
145  * This operation is non-atomic and can be reordered.  
146  * If two examples of this operation race, one can appear to succeed
147  * but actually fail.  You must protect multiple accesses with a lock.
148  */
149 static __inline__ int __test_and_set_bit(int nr, volatile void * addr)
150 {
151         int oldbit;
152
153         __asm__(
154                 "btsl %2,%1\n\tsbbl %0,%0"
155                 :"=r" (oldbit),"=m" (ADDR)
156                 :"dIr" (nr));
157         return oldbit;
158 }
159
160 /**
161  * test_and_clear_bit - Clear a bit and return its old value
162  * @nr: Bit to set
163  * @addr: Address to count from
164  *
165  * This operation is atomic and cannot be reordered.  
166  * It also implies a memory barrier.
167  */
168 static __inline__ int test_and_clear_bit(int nr, volatile void * addr)
169 {
170         int oldbit;
171
172         __asm__ __volatile__( LOCK_PREFIX
173                 "btrl %2,%1\n\tsbbl %0,%0"
174                 :"=r" (oldbit),"=m" (ADDR)
175                 :"dIr" (nr) : "memory");
176         return oldbit;
177 }
178
179 /**
180  * __test_and_clear_bit - Clear a bit and return its old value
181  * @nr: Bit to set
182  * @addr: Address to count from
183  *
184  * This operation is non-atomic and can be reordered.  
185  * If two examples of this operation race, one can appear to succeed
186  * but actually fail.  You must protect multiple accesses with a lock.
187  */
188 static __inline__ int __test_and_clear_bit(int nr, volatile void * addr)
189 {
190         int oldbit;
191
192         __asm__(
193                 "btrl %2,%1\n\tsbbl %0,%0"
194                 :"=r" (oldbit),"=m" (ADDR)
195                 :"dIr" (nr));
196         return oldbit;
197 }
198
199 /* WARNING: non atomic and it can be reordered! */
200 static __inline__ int __test_and_change_bit(int nr, volatile void * addr)
201 {
202         int oldbit;
203
204         __asm__ __volatile__(
205                 "btcl %2,%1\n\tsbbl %0,%0"
206                 :"=r" (oldbit),"=m" (ADDR)
207                 :"dIr" (nr) : "memory");
208         return oldbit;
209 }
210
211 /**
212  * test_and_change_bit - Change a bit and return its new value
213  * @nr: Bit to set
214  * @addr: Address to count from
215  *
216  * This operation is atomic and cannot be reordered.  
217  * It also implies a memory barrier.
218  */
219 static __inline__ int test_and_change_bit(int nr, volatile void * addr)
220 {
221         int oldbit;
222
223         __asm__ __volatile__( LOCK_PREFIX
224                 "btcl %2,%1\n\tsbbl %0,%0"
225                 :"=r" (oldbit),"=m" (ADDR)
226                 :"dIr" (nr) : "memory");
227         return oldbit;
228 }
229
230 #if 0 /* Fool kernel-doc since it doesn't do macros yet */
231 /**
232  * test_bit - Determine whether a bit is set
233  * @nr: bit number to test
234  * @addr: Address to start counting from
235  */
236 static int test_bit(int nr, const volatile void * addr);
237 #endif
238
239 static __inline__ int constant_test_bit(int nr, const volatile void * addr)
240 {
241         return ((1UL << (nr & 31)) & (((const volatile unsigned int *) addr)[nr >> 5])) != 0;
242 }
243
244 static __inline__ int variable_test_bit(int nr, volatile void * addr)
245 {
246         int oldbit;
247
248         __asm__ __volatile__(
249                 "btl %2,%1\n\tsbbl %0,%0"
250                 :"=r" (oldbit)
251                 :"m" (ADDR),"dIr" (nr));
252         return oldbit;
253 }
254
255 #define test_bit(nr,addr) \
256 (__builtin_constant_p(nr) ? \
257  constant_test_bit((nr),(addr)) : \
258  variable_test_bit((nr),(addr)))
259
260 /**
261  * find_first_zero_bit - find the first zero bit in a memory region
262  * @addr: The address to start the search at
263  * @size: The maximum size to search
264  *
265  * Returns the bit-number of the first zero bit, not the number of the byte
266  * containing a bit.
267  */
268 static __inline__ int find_first_zero_bit(void * addr, unsigned size)
269 {
270         int d0, d1, d2;
271         int res;
272
273         if (!size)
274                 return 0;
275         __asm__ __volatile__(
276                 "movl $-1,%%eax\n\t"
277                 "xorq %%rdx,%%rdx\n\t"
278                 "repe; scasl\n\t"
279                 "je 1f\n\t"
280                 "xorl -4(%%rdi),%%eax\n\t"
281                 "subq $4,%%rdi\n\t"
282                 "bsfl %%eax,%%edx\n"
283                 "1:\tsubq %%rbx,%%rdi\n\t"
284                 "shlq $3,%%rdi\n\t"
285                 "addq %%rdi,%%rdx"
286                 :"=d" (res), "=&c" (d0), "=&D" (d1), "=&a" (d2)
287                 :"1" ((size + 31) >> 5), "2" (addr), "b" (addr) : "memory");
288         return res;
289 }
290
291 /**
292  * find_first_bit - find the first set bit in a memory region
293  * @addr: The address to start the search at
294  * @size: The maximum size to search
295  *
296  * Returns the bit-number of the first set bit, not the number of the byte
297  * containing a bit.
298  */
299 static __inline__ int find_first_bit(void * addr, unsigned size)
300 {
301         int d0, d1;
302         int res;
303
304         /* This looks at memory. Mark it volatile to tell gcc not to move it around */
305         /* Work in 32bit for now */ 
306         __asm__ __volatile__(
307                 "xorl %%eax,%%eax\n\t"
308                 "repe; scasl\n\t"
309                 "jz 1f\n\t"
310                 "leaq -4(%%rdi),%%rdi\n\t"
311                 "bsfl (%%rdi),%%eax\n"
312                 "1:\tsubq %%rbx,%%rdi\n\t"
313                 "shlq $3,%%rdi\n\t"
314                 "addq %%rdi,%%rax"
315                 :"=a" (res), "=&c" (d0), "=&D" (d1)
316                 :"1" ((size + 31) >> 5), "2" (addr), "b" (addr));
317         return res;
318 }
319
320 /**
321  * find_next_zero_bit - find the first zero bit in a memory region
322  * @addr: The address to base the search on
323  * @offset: The bitnumber to start searching at
324  * @size: The maximum size to search
325  */
326 static __inline__ int find_next_zero_bit (void * addr, int size, int offset)
327 {
328         unsigned int * p = ((unsigned int *) addr) + (offset >> 5);
329         int set = 0, bit = offset & 31, res;
330         
331         if (bit) {
332                 /*
333                  * Look for zero in the first 32 bits.
334                  */
335                 __asm__("bsfl %1,%0\n\t"
336                         "jne 1f\n\t"
337                         "movl $32, %0\n"
338                         "1:"
339                         : "=r" (set)
340                         : "r" (~(*p >> bit)));
341                 if (set < (32 - bit))
342                         return set + offset;
343                 set = 32 - bit;
344                 p++;
345         }
346         /*
347          * No zero yet, search remaining full bytes for a zero
348          */
349         res = find_first_zero_bit (p, size - 32 * (p - (unsigned int *) addr));
350         return (offset + set + res);
351 }
352
353 /**
354  * find_next_bit - find the first set bit in a memory region
355  * @addr: The address to base the search on
356  * @offset: The bitnumber to start searching at
357  * @size: The maximum size to search
358  */
359 static __inline__ int find_next_bit (void * addr, int size, int offset)
360 {
361         unsigned long * p = ((unsigned long *) addr) + (offset >> 5);
362         unsigned long set = 0, bit = offset & 63, res;
363
364         if (bit) {
365                 /*
366                  * Look for nonzero in the first 64 bits:
367                  */
368                 __asm__("bsfq %1,%0\n\t"
369                         "jne 1f\n\t"
370                         "movq $64, %0\n"
371                         "1:"
372                         : "=r" (set)
373                         : "r" (*p >> bit));
374                 if (set < (64 - bit))
375                         return set + offset;
376                 set = 64 - bit;
377                 p++;
378         }
379         /*
380          * No set bit yet, search remaining full words for a bit
381          */
382         res = find_first_bit (p, size - 64 * (p - (unsigned long *) addr));
383         return (offset + set + res);
384 }
385
386 /**
387  * ffz - find first zero in word.
388  * @word: The word to search
389  *
390  * Undefined if no zero exists, so code should check against ~0UL first.
391  */
392 static __inline__ unsigned long ffz(unsigned long word)
393 {
394         __asm__("bsfq %1,%0"
395                 :"=r" (word)
396                 :"r" (~word));
397         return word;
398 }
399
400 /**
401  * __ffs - find first bit in word.
402  * @word: The word to search
403  *
404  * Undefined if no bit exists, so code should check against 0 first.
405  */
406 static __inline__ unsigned long __ffs(unsigned long word)
407 {
408         __asm__("bsfq %1,%0"
409                 :"=r" (word)
410                 :"rm" (word));
411         return word;
412 }
413
414 #ifdef __KERNEL__
415
416 /**
417  * ffs - find first bit set
418  * @x: the word to search
419  *
420  * This is defined the same way as
421  * the libc and compiler builtin ffs routines, therefore
422  * differs in spirit from the above ffz (man ffs).
423  */
424 static __inline__ int ffs(int x)
425 {
426         int r;
427
428         __asm__("bsfl %1,%0\n\t"
429                 "jnz 1f\n\t"
430                 "movl $-1,%0\n"
431                 "1:" : "=r" (r) : "g" (x));
432         return r+1;
433 }
434
435 /**
436  * hweightN - returns the hamming weight of a N-bit word
437  * @x: the word to weigh
438  *
439  * The Hamming Weight of a number is the total number of bits set in it.
440  */
441
442 #define hweight32(x) generic_hweight32(x)
443 #define hweight16(x) generic_hweight16(x)
444 #define hweight8(x) generic_hweight8(x)
445
446 #endif /* __KERNEL__ */
447
448 #ifdef __KERNEL__
449
450 #define ext2_set_bit                 __test_and_set_bit
451 #define ext2_clear_bit               __test_and_clear_bit
452 #define ext2_test_bit                test_bit
453 #define ext2_find_first_zero_bit     find_first_zero_bit
454 #define ext2_find_next_zero_bit      find_next_zero_bit
455
456 /* Bitmap functions for the minix filesystem.  */
457 #define minix_test_and_set_bit(nr,addr) __test_and_set_bit(nr,addr)
458 #define minix_set_bit(nr,addr) __set_bit(nr,addr)
459 #define minix_test_and_clear_bit(nr,addr) __test_and_clear_bit(nr,addr)
460 #define minix_test_bit(nr,addr) test_bit(nr,addr)
461 #define minix_find_first_zero_bit(addr,size) find_first_zero_bit(addr,size)
462
463 #endif /* __KERNEL__ */
464
465 #endif /* _X86_64_BITOPS_H */