ba0fd1eb4af79cd2e8bae36acc5899215d2b7f73
[linux-2.6.git] / include / linux / bitops.h
1 #ifndef _LINUX_BITOPS_H
2 #define _LINUX_BITOPS_H
3 #include <asm/types.h>
4
5 #ifdef  __KERNEL__
6 #define BIT(nr)                 (1UL << (nr))
7 #define BIT_MASK(nr)            (1UL << ((nr) % BITS_PER_LONG))
8 #define BIT_WORD(nr)            ((nr) / BITS_PER_LONG)
9 #define BITS_PER_BYTE           8
10 #define BITS_TO_LONGS(nr)       DIV_ROUND_UP(nr, BITS_PER_BYTE * sizeof(long))
11 #endif
12
13 /*
14  * Include this here because some architectures need generic_ffs/fls in
15  * scope
16  */
17 #include <asm/bitops.h>
18
19 #define for_each_bit(bit, addr, size) \
20         for ((bit) = find_first_bit((addr), (size)); \
21              (bit) < (size); \
22              (bit) = find_next_bit((addr), (size), (bit) + 1))
23
24
25 static __inline__ int get_bitmask_order(unsigned int count)
26 {
27         int order;
28
29         order = fls(count);
30         return order;   /* We could be slightly more clever with -1 here... */
31 }
32
33 static __inline__ int get_count_order(unsigned int count)
34 {
35         int order;
36
37         order = fls(count) - 1;
38         if (count & (count - 1))
39                 order++;
40         return order;
41 }
42
43 static inline unsigned long hweight_long(unsigned long w)
44 {
45         return sizeof(w) == 4 ? hweight32(w) : hweight64(w);
46 }
47
48 #define HWEIGHT8(w)                     \
49       ( (!!((w) & (1ULL << 0))) +       \
50         (!!((w) & (1ULL << 1))) +       \
51         (!!((w) & (1ULL << 2))) +       \
52         (!!((w) & (1ULL << 3))) +       \
53         (!!((w) & (1ULL << 4))) +       \
54         (!!((w) & (1ULL << 5))) +       \
55         (!!((w) & (1ULL << 6))) +       \
56         (!!((w) & (1ULL << 7))) )
57
58 #define HWEIGHT16(w) (HWEIGHT8(w)  + HWEIGHT8(w >> 8))
59 #define HWEIGHT32(w) (HWEIGHT16(w) + HWEIGHT16(w >> 16))
60 #define HWEIGHT64(w) (HWEIGHT32(w) + HWEIGHT32(w >> 32))
61
62 /**
63  * rol32 - rotate a 32-bit value left
64  * @word: value to rotate
65  * @shift: bits to roll
66  */
67 static inline __u32 rol32(__u32 word, unsigned int shift)
68 {
69         return (word << shift) | (word >> (32 - shift));
70 }
71
72 /**
73  * ror32 - rotate a 32-bit value right
74  * @word: value to rotate
75  * @shift: bits to roll
76  */
77 static inline __u32 ror32(__u32 word, unsigned int shift)
78 {
79         return (word >> shift) | (word << (32 - shift));
80 }
81
82 /**
83  * rol16 - rotate a 16-bit value left
84  * @word: value to rotate
85  * @shift: bits to roll
86  */
87 static inline __u16 rol16(__u16 word, unsigned int shift)
88 {
89         return (word << shift) | (word >> (16 - shift));
90 }
91
92 /**
93  * ror16 - rotate a 16-bit value right
94  * @word: value to rotate
95  * @shift: bits to roll
96  */
97 static inline __u16 ror16(__u16 word, unsigned int shift)
98 {
99         return (word >> shift) | (word << (16 - shift));
100 }
101
102 /**
103  * rol8 - rotate an 8-bit value left
104  * @word: value to rotate
105  * @shift: bits to roll
106  */
107 static inline __u8 rol8(__u8 word, unsigned int shift)
108 {
109         return (word << shift) | (word >> (8 - shift));
110 }
111
112 /**
113  * ror8 - rotate an 8-bit value right
114  * @word: value to rotate
115  * @shift: bits to roll
116  */
117 static inline __u8 ror8(__u8 word, unsigned int shift)
118 {
119         return (word >> shift) | (word << (8 - shift));
120 }
121
122 static inline unsigned fls_long(unsigned long l)
123 {
124         if (sizeof(l) == 4)
125                 return fls(l);
126         return fls64(l);
127 }
128
129 /**
130  * __ffs64 - find first set bit in a 64 bit word
131  * @word: The 64 bit word
132  *
133  * On 64 bit arches this is a synomyn for __ffs
134  * The result is not defined if no bits are set, so check that @word
135  * is non-zero before calling this.
136  */
137 static inline unsigned long __ffs64(u64 word)
138 {
139 #if BITS_PER_LONG == 32
140         if (((u32)word) == 0UL)
141                 return __ffs((u32)(word >> 32)) + 32;
142 #elif BITS_PER_LONG != 64
143 #error BITS_PER_LONG not 32 or 64
144 #endif
145         return __ffs((unsigned long)word);
146 }
147
148 #ifdef __KERNEL__
149 #ifdef CONFIG_GENERIC_FIND_FIRST_BIT
150
151 /**
152  * find_first_bit - find the first set bit in a memory region
153  * @addr: The address to start the search at
154  * @size: The maximum size to search
155  *
156  * Returns the bit number of the first set bit.
157  */
158 extern unsigned long find_first_bit(const unsigned long *addr,
159                                     unsigned long size);
160
161 /**
162  * find_first_zero_bit - find the first cleared bit in a memory region
163  * @addr: The address to start the search at
164  * @size: The maximum size to search
165  *
166  * Returns the bit number of the first cleared bit.
167  */
168 extern unsigned long find_first_zero_bit(const unsigned long *addr,
169                                          unsigned long size);
170 #endif /* CONFIG_GENERIC_FIND_FIRST_BIT */
171
172 #ifdef CONFIG_GENERIC_FIND_LAST_BIT
173 /**
174  * find_last_bit - find the last set bit in a memory region
175  * @addr: The address to start the search at
176  * @size: The maximum size to search
177  *
178  * Returns the bit number of the first set bit, or size.
179  */
180 extern unsigned long find_last_bit(const unsigned long *addr,
181                                    unsigned long size);
182 #endif /* CONFIG_GENERIC_FIND_LAST_BIT */
183
184 #ifdef CONFIG_GENERIC_FIND_NEXT_BIT
185
186 /**
187  * find_next_bit - find the next set bit in a memory region
188  * @addr: The address to base the search on
189  * @offset: The bitnumber to start searching at
190  * @size: The bitmap size in bits
191  */
192 extern unsigned long find_next_bit(const unsigned long *addr,
193                                    unsigned long size, unsigned long offset);
194
195 /**
196  * find_next_zero_bit - find the next cleared bit in a memory region
197  * @addr: The address to base the search on
198  * @offset: The bitnumber to start searching at
199  * @size: The bitmap size in bits
200  */
201
202 extern unsigned long find_next_zero_bit(const unsigned long *addr,
203                                         unsigned long size,
204                                         unsigned long offset);
205
206 #endif /* CONFIG_GENERIC_FIND_NEXT_BIT */
207 #endif /* __KERNEL__ */
208 #endif