blob: e63553386ae715d387fadd39c4e53650ce3e226e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_BITOPS_H
2#define _LINUX_BITOPS_H
3#include <asm/types.h>
4
Jiri Slabyd05be132007-10-18 23:40:31 -07005#ifdef __KERNEL__
Jiri Slaby93043ec2007-10-18 23:40:35 -07006#define BIT(nr) (1UL << (nr))
Srinivas Pandruvadabfd1ff62013-10-11 16:54:59 -07007#define BIT_ULL(nr) (1ULL << (nr))
Jiri Slabyd05be132007-10-18 23:40:31 -07008#define BIT_MASK(nr) (1UL << ((nr) % BITS_PER_LONG))
9#define BIT_WORD(nr) ((nr) / BITS_PER_LONG)
Srinivas Pandruvadabfd1ff62013-10-11 16:54:59 -070010#define BIT_ULL_MASK(nr) (1ULL << ((nr) % BITS_PER_LONG_LONG))
11#define BIT_ULL_WORD(nr) ((nr) / BITS_PER_LONG_LONG)
Jiri Slabyd05be132007-10-18 23:40:31 -070012#define BITS_PER_BYTE 8
Eric Dumazetede9c692008-04-29 00:58:35 -070013#define BITS_TO_LONGS(nr) DIV_ROUND_UP(nr, BITS_PER_BYTE * sizeof(long))
Jiri Slabyd05be132007-10-18 23:40:31 -070014#endif
15
Chen, Gong10ef6b02013-10-18 14:29:07 -070016/*
17 * Create a contiguous bitmask starting at bit position @l and ending at
18 * position @h. For example
19 * GENMASK_ULL(39, 21) gives us the 64bit vector 0x000000ffffe00000.
20 */
Maxime COQUELIN00b4d9a12014-11-06 10:54:19 +010021#define GENMASK(h, l) \
22 (((~0UL) << (l)) & (~0UL >> (BITS_PER_LONG - 1 - (h))))
23
24#define GENMASK_ULL(h, l) \
25 (((~0ULL) << (l)) & (~0ULL >> (BITS_PER_LONG_LONG - 1 - (h))))
Chen, Gong10ef6b02013-10-18 14:29:07 -070026
Borislav Petkov4677d4a2010-05-03 14:57:11 +020027extern unsigned int __sw_hweight8(unsigned int w);
28extern unsigned int __sw_hweight16(unsigned int w);
29extern unsigned int __sw_hweight32(unsigned int w);
30extern unsigned long __sw_hweight64(__u64 w);
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 * Include this here because some architectures need generic_ffs/fls in
34 * scope
35 */
36#include <asm/bitops.h>
37
Akinobu Mita984b3f52010-03-05 13:41:37 -080038#define for_each_set_bit(bit, addr, size) \
Robert Richter1e2ad282011-11-18 12:35:21 +010039 for ((bit) = find_first_bit((addr), (size)); \
40 (bit) < (size); \
41 (bit) = find_next_bit((addr), (size), (bit) + 1))
42
43/* same as for_each_set_bit() but use bit as value to start with */
Akinobu Mita307b1cd2012-03-23 15:02:03 -070044#define for_each_set_bit_from(bit, addr, size) \
Robert Richter1e2ad282011-11-18 12:35:21 +010045 for ((bit) = find_next_bit((addr), (size), (bit)); \
46 (bit) < (size); \
Shannon Nelson3e037452007-10-16 01:27:40 -070047 (bit) = find_next_bit((addr), (size), (bit) + 1))
48
Akinobu Mita03f4a822012-03-23 15:02:04 -070049#define for_each_clear_bit(bit, addr, size) \
50 for ((bit) = find_first_zero_bit((addr), (size)); \
51 (bit) < (size); \
52 (bit) = find_next_zero_bit((addr), (size), (bit) + 1))
53
54/* same as for_each_clear_bit() but use bit as value to start with */
55#define for_each_clear_bit_from(bit, addr, size) \
56 for ((bit) = find_next_zero_bit((addr), (size), (bit)); \
57 (bit) < (size); \
58 (bit) = find_next_zero_bit((addr), (size), (bit) + 1))
59
Denys Vlasenko1a1d48a2015-08-04 16:15:14 +020060static inline int get_bitmask_order(unsigned int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070061{
62 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010063
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 order = fls(count);
65 return order; /* We could be slightly more clever with -1 here... */
66}
67
Denys Vlasenko1a1d48a2015-08-04 16:15:14 +020068static inline int get_count_order(unsigned int count)
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010069{
70 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010071
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010072 order = fls(count) - 1;
73 if (count & (count - 1))
74 order++;
75 return order;
76}
77
Denys Vlasenko1a1d48a2015-08-04 16:15:14 +020078static __always_inline unsigned long hweight_long(unsigned long w)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079{
Akinobu Mitae9bebd62006-03-26 01:39:55 -080080 return sizeof(w) == 4 ? hweight32(w) : hweight64(w);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081}
82
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080083/**
Alexey Dobriyanf2ea0f52012-01-14 21:44:49 +030084 * rol64 - rotate a 64-bit value left
85 * @word: value to rotate
86 * @shift: bits to roll
87 */
88static inline __u64 rol64(__u64 word, unsigned int shift)
89{
90 return (word << shift) | (word >> (64 - shift));
91}
92
93/**
94 * ror64 - rotate a 64-bit value right
95 * @word: value to rotate
96 * @shift: bits to roll
97 */
98static inline __u64 ror64(__u64 word, unsigned int shift)
99{
100 return (word >> shift) | (word << (64 - shift));
101}
102
103/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 * rol32 - rotate a 32-bit value left
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 * @word: value to rotate
106 * @shift: bits to roll
107 */
108static inline __u32 rol32(__u32 word, unsigned int shift)
109{
110 return (word << shift) | (word >> (32 - shift));
111}
112
Robert P. J. Day45f8bde2007-01-26 00:57:09 -0800113/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 * ror32 - rotate a 32-bit value right
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 * @word: value to rotate
116 * @shift: bits to roll
117 */
118static inline __u32 ror32(__u32 word, unsigned int shift)
119{
120 return (word >> shift) | (word << (32 - shift));
121}
122
Harvey Harrison3afe3922008-03-28 14:16:01 -0700123/**
124 * rol16 - rotate a 16-bit value left
125 * @word: value to rotate
126 * @shift: bits to roll
127 */
128static inline __u16 rol16(__u16 word, unsigned int shift)
129{
130 return (word << shift) | (word >> (16 - shift));
131}
132
133/**
134 * ror16 - rotate a 16-bit value right
135 * @word: value to rotate
136 * @shift: bits to roll
137 */
138static inline __u16 ror16(__u16 word, unsigned int shift)
139{
140 return (word >> shift) | (word << (16 - shift));
141}
142
143/**
144 * rol8 - rotate an 8-bit value left
145 * @word: value to rotate
146 * @shift: bits to roll
147 */
148static inline __u8 rol8(__u8 word, unsigned int shift)
149{
150 return (word << shift) | (word >> (8 - shift));
151}
152
153/**
154 * ror8 - rotate an 8-bit value right
155 * @word: value to rotate
156 * @shift: bits to roll
157 */
158static inline __u8 ror8(__u8 word, unsigned int shift)
159{
160 return (word >> shift) | (word << (8 - shift));
161}
162
Andreas Herrmann7919a572010-08-30 19:04:01 +0000163/**
164 * sign_extend32 - sign extend a 32-bit value using specified bit as sign-bit
165 * @value: value to sign extend
166 * @index: 0 based bit index (0<=index<32) to sign bit
167 */
168static inline __s32 sign_extend32(__u32 value, int index)
169{
170 __u8 shift = 31 - index;
171 return (__s32)(value << shift) >> shift;
172}
173
Andrew Morton962749a2006-03-25 03:08:01 -0800174static inline unsigned fls_long(unsigned long l)
175{
176 if (sizeof(l) == 4)
177 return fls(l);
178 return fls64(l);
179}
180
Steven Whitehouse952043a2009-04-23 08:48:15 +0100181/**
182 * __ffs64 - find first set bit in a 64 bit word
183 * @word: The 64 bit word
184 *
185 * On 64 bit arches this is a synomyn for __ffs
186 * The result is not defined if no bits are set, so check that @word
187 * is non-zero before calling this.
188 */
189static inline unsigned long __ffs64(u64 word)
190{
191#if BITS_PER_LONG == 32
192 if (((u32)word) == 0UL)
193 return __ffs((u32)(word >> 32)) + 32;
194#elif BITS_PER_LONG != 64
195#error BITS_PER_LONG not 32 or 64
196#endif
197 return __ffs((unsigned long)word);
198}
199
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100200#ifdef __KERNEL__
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200201
Theodore Ts'o00a1a052014-03-30 10:20:01 -0400202#ifndef set_mask_bits
203#define set_mask_bits(ptr, _mask, _bits) \
204({ \
205 const typeof(*ptr) mask = (_mask), bits = (_bits); \
206 typeof(*ptr) old, new; \
207 \
208 do { \
209 old = ACCESS_ONCE(*ptr); \
210 new = (old & ~mask) | bits; \
211 } while (cmpxchg(ptr, old, new) != old); \
212 \
213 new; \
214})
215#endif
216
Akinobu Mita19de85e2011-05-26 16:26:09 -0700217#ifndef find_last_bit
Rusty Russellab53d472009-01-01 10:12:19 +1030218/**
219 * find_last_bit - find the last set bit in a memory region
220 * @addr: The address to start the search at
Yury Norov2c57a0e2015-04-16 12:43:13 -0700221 * @size: The number of bits to search
Rusty Russellab53d472009-01-01 10:12:19 +1030222 *
Yury Norov2c57a0e2015-04-16 12:43:13 -0700223 * Returns the bit number of the last set bit, or size.
Rusty Russellab53d472009-01-01 10:12:19 +1030224 */
225extern unsigned long find_last_bit(const unsigned long *addr,
226 unsigned long size);
Akinobu Mita19de85e2011-05-26 16:26:09 -0700227#endif
Rusty Russellab53d472009-01-01 10:12:19 +1030228
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100229#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230#endif