blob: 5a1c8b71ccd84616b0471b833ee909c9d794be5f [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
Borislav Petkov4677d4a2010-05-03 14:57:11 +020016extern unsigned int __sw_hweight8(unsigned int w);
17extern unsigned int __sw_hweight16(unsigned int w);
18extern unsigned int __sw_hweight32(unsigned int w);
19extern unsigned long __sw_hweight64(__u64 w);
20
Linus Torvalds1da177e2005-04-16 15:20:36 -070021/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 * Include this here because some architectures need generic_ffs/fls in
23 * scope
24 */
25#include <asm/bitops.h>
26
Akinobu Mita984b3f52010-03-05 13:41:37 -080027#define for_each_set_bit(bit, addr, size) \
Robert Richter1e2ad282011-11-18 12:35:21 +010028 for ((bit) = find_first_bit((addr), (size)); \
29 (bit) < (size); \
30 (bit) = find_next_bit((addr), (size), (bit) + 1))
31
32/* same as for_each_set_bit() but use bit as value to start with */
Akinobu Mita307b1cd2012-03-23 15:02:03 -070033#define for_each_set_bit_from(bit, addr, size) \
Robert Richter1e2ad282011-11-18 12:35:21 +010034 for ((bit) = find_next_bit((addr), (size), (bit)); \
35 (bit) < (size); \
Shannon Nelson3e037452007-10-16 01:27:40 -070036 (bit) = find_next_bit((addr), (size), (bit) + 1))
37
Akinobu Mita03f4a822012-03-23 15:02:04 -070038#define for_each_clear_bit(bit, addr, size) \
39 for ((bit) = find_first_zero_bit((addr), (size)); \
40 (bit) < (size); \
41 (bit) = find_next_zero_bit((addr), (size), (bit) + 1))
42
43/* same as for_each_clear_bit() but use bit as value to start with */
44#define for_each_clear_bit_from(bit, addr, size) \
45 for ((bit) = find_next_zero_bit((addr), (size), (bit)); \
46 (bit) < (size); \
47 (bit) = find_next_zero_bit((addr), (size), (bit) + 1))
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049static __inline__ int get_bitmask_order(unsigned int count)
50{
51 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 order = fls(count);
54 return order; /* We could be slightly more clever with -1 here... */
55}
56
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010057static __inline__ int get_count_order(unsigned int count)
58{
59 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010060
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010061 order = fls(count) - 1;
62 if (count & (count - 1))
63 order++;
64 return order;
65}
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static inline unsigned long hweight_long(unsigned long w)
68{
Akinobu Mitae9bebd62006-03-26 01:39:55 -080069 return sizeof(w) == 4 ? hweight32(w) : hweight64(w);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070}
71
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080072/**
Alexey Dobriyanf2ea0f52012-01-14 21:44:49 +030073 * rol64 - rotate a 64-bit value left
74 * @word: value to rotate
75 * @shift: bits to roll
76 */
77static inline __u64 rol64(__u64 word, unsigned int shift)
78{
79 return (word << shift) | (word >> (64 - shift));
80}
81
82/**
83 * ror64 - rotate a 64-bit value right
84 * @word: value to rotate
85 * @shift: bits to roll
86 */
87static inline __u64 ror64(__u64 word, unsigned int shift)
88{
89 return (word >> shift) | (word << (64 - shift));
90}
91
92/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 * rol32 - rotate a 32-bit value left
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 * @word: value to rotate
95 * @shift: bits to roll
96 */
97static inline __u32 rol32(__u32 word, unsigned int shift)
98{
99 return (word << shift) | (word >> (32 - shift));
100}
101
Robert P. J. Day45f8bde2007-01-26 00:57:09 -0800102/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 * ror32 - rotate a 32-bit value right
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 * @word: value to rotate
105 * @shift: bits to roll
106 */
107static inline __u32 ror32(__u32 word, unsigned int shift)
108{
109 return (word >> shift) | (word << (32 - shift));
110}
111
Harvey Harrison3afe3922008-03-28 14:16:01 -0700112/**
113 * rol16 - rotate a 16-bit value left
114 * @word: value to rotate
115 * @shift: bits to roll
116 */
117static inline __u16 rol16(__u16 word, unsigned int shift)
118{
119 return (word << shift) | (word >> (16 - shift));
120}
121
122/**
123 * ror16 - rotate a 16-bit value right
124 * @word: value to rotate
125 * @shift: bits to roll
126 */
127static inline __u16 ror16(__u16 word, unsigned int shift)
128{
129 return (word >> shift) | (word << (16 - shift));
130}
131
132/**
133 * rol8 - rotate an 8-bit value left
134 * @word: value to rotate
135 * @shift: bits to roll
136 */
137static inline __u8 rol8(__u8 word, unsigned int shift)
138{
139 return (word << shift) | (word >> (8 - shift));
140}
141
142/**
143 * ror8 - rotate an 8-bit value right
144 * @word: value to rotate
145 * @shift: bits to roll
146 */
147static inline __u8 ror8(__u8 word, unsigned int shift)
148{
149 return (word >> shift) | (word << (8 - shift));
150}
151
Andreas Herrmann7919a572010-08-30 19:04:01 +0000152/**
153 * sign_extend32 - sign extend a 32-bit value using specified bit as sign-bit
154 * @value: value to sign extend
155 * @index: 0 based bit index (0<=index<32) to sign bit
156 */
157static inline __s32 sign_extend32(__u32 value, int index)
158{
159 __u8 shift = 31 - index;
160 return (__s32)(value << shift) >> shift;
161}
162
Andrew Morton962749a2006-03-25 03:08:01 -0800163static inline unsigned fls_long(unsigned long l)
164{
165 if (sizeof(l) == 4)
166 return fls(l);
167 return fls64(l);
168}
169
Steven Whitehouse952043a2009-04-23 08:48:15 +0100170/**
171 * __ffs64 - find first set bit in a 64 bit word
172 * @word: The 64 bit word
173 *
174 * On 64 bit arches this is a synomyn for __ffs
175 * The result is not defined if no bits are set, so check that @word
176 * is non-zero before calling this.
177 */
178static inline unsigned long __ffs64(u64 word)
179{
180#if BITS_PER_LONG == 32
181 if (((u32)word) == 0UL)
182 return __ffs((u32)(word >> 32)) + 32;
183#elif BITS_PER_LONG != 64
184#error BITS_PER_LONG not 32 or 64
185#endif
186 return __ffs((unsigned long)word);
187}
188
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100189#ifdef __KERNEL__
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200190
Akinobu Mita19de85e2011-05-26 16:26:09 -0700191#ifndef find_last_bit
Rusty Russellab53d472009-01-01 10:12:19 +1030192/**
193 * find_last_bit - find the last set bit in a memory region
194 * @addr: The address to start the search at
195 * @size: The maximum size to search
196 *
197 * Returns the bit number of the first set bit, or size.
198 */
199extern unsigned long find_last_bit(const unsigned long *addr,
200 unsigned long size);
Akinobu Mita19de85e2011-05-26 16:26:09 -0700201#endif
Rusty Russellab53d472009-01-01 10:12:19 +1030202
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100203#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204#endif