blob: a3b6b82108b9ad239dd1dda1abe6c8e3f585d3b3 [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))
Jiri Slabyd05be132007-10-18 23:40:31 -07007#define BIT_MASK(nr) (1UL << ((nr) % BITS_PER_LONG))
8#define BIT_WORD(nr) ((nr) / BITS_PER_LONG)
Jiri Slabyd05be132007-10-18 23:40:31 -07009#define BITS_PER_BYTE 8
Eric Dumazetede9c692008-04-29 00:58:35 -070010#define BITS_TO_LONGS(nr) DIV_ROUND_UP(nr, BITS_PER_BYTE * sizeof(long))
Jiri Slabyd05be132007-10-18 23:40:31 -070011#endif
12
Borislav Petkov4677d4a2010-05-03 14:57:11 +020013extern unsigned int __sw_hweight8(unsigned int w);
14extern unsigned int __sw_hweight16(unsigned int w);
15extern unsigned int __sw_hweight32(unsigned int w);
16extern unsigned long __sw_hweight64(__u64 w);
17
Linus Torvalds1da177e2005-04-16 15:20:36 -070018/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * Include this here because some architectures need generic_ffs/fls in
20 * scope
21 */
22#include <asm/bitops.h>
23
Akinobu Mita984b3f52010-03-05 13:41:37 -080024#define for_each_set_bit(bit, addr, size) \
Robert Richter1e2ad282011-11-18 12:35:21 +010025 for ((bit) = find_first_bit((addr), (size)); \
26 (bit) < (size); \
27 (bit) = find_next_bit((addr), (size), (bit) + 1))
28
29/* same as for_each_set_bit() but use bit as value to start with */
Akinobu Mita307b1cd2012-03-23 15:02:03 -070030#define for_each_set_bit_from(bit, addr, size) \
Robert Richter1e2ad282011-11-18 12:35:21 +010031 for ((bit) = find_next_bit((addr), (size), (bit)); \
32 (bit) < (size); \
Shannon Nelson3e037452007-10-16 01:27:40 -070033 (bit) = find_next_bit((addr), (size), (bit) + 1))
34
Akinobu Mita03f4a822012-03-23 15:02:04 -070035#define for_each_clear_bit(bit, addr, size) \
36 for ((bit) = find_first_zero_bit((addr), (size)); \
37 (bit) < (size); \
38 (bit) = find_next_zero_bit((addr), (size), (bit) + 1))
39
40/* same as for_each_clear_bit() but use bit as value to start with */
41#define for_each_clear_bit_from(bit, addr, size) \
42 for ((bit) = find_next_zero_bit((addr), (size), (bit)); \
43 (bit) < (size); \
44 (bit) = find_next_zero_bit((addr), (size), (bit) + 1))
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046static __inline__ int get_bitmask_order(unsigned int count)
47{
48 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 order = fls(count);
51 return order; /* We could be slightly more clever with -1 here... */
52}
53
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010054static __inline__ int get_count_order(unsigned int count)
55{
56 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010057
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010058 order = fls(count) - 1;
59 if (count & (count - 1))
60 order++;
61 return order;
62}
63
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static inline unsigned long hweight_long(unsigned long w)
65{
Akinobu Mitae9bebd62006-03-26 01:39:55 -080066 return sizeof(w) == 4 ? hweight32(w) : hweight64(w);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067}
68
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080069/**
Alexey Dobriyanf2ea0f52012-01-14 21:44:49 +030070 * rol64 - rotate a 64-bit value left
71 * @word: value to rotate
72 * @shift: bits to roll
73 */
74static inline __u64 rol64(__u64 word, unsigned int shift)
75{
76 return (word << shift) | (word >> (64 - shift));
77}
78
79/**
80 * ror64 - rotate a 64-bit value right
81 * @word: value to rotate
82 * @shift: bits to roll
83 */
84static inline __u64 ror64(__u64 word, unsigned int shift)
85{
86 return (word >> shift) | (word << (64 - shift));
87}
88
89/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 * rol32 - rotate a 32-bit value left
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 * @word: value to rotate
92 * @shift: bits to roll
93 */
94static inline __u32 rol32(__u32 word, unsigned int shift)
95{
96 return (word << shift) | (word >> (32 - shift));
97}
98
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080099/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 * ror32 - rotate a 32-bit value right
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 * @word: value to rotate
102 * @shift: bits to roll
103 */
104static inline __u32 ror32(__u32 word, unsigned int shift)
105{
106 return (word >> shift) | (word << (32 - shift));
107}
108
Harvey Harrison3afe3922008-03-28 14:16:01 -0700109/**
110 * rol16 - rotate a 16-bit value left
111 * @word: value to rotate
112 * @shift: bits to roll
113 */
114static inline __u16 rol16(__u16 word, unsigned int shift)
115{
116 return (word << shift) | (word >> (16 - shift));
117}
118
119/**
120 * ror16 - rotate a 16-bit value right
121 * @word: value to rotate
122 * @shift: bits to roll
123 */
124static inline __u16 ror16(__u16 word, unsigned int shift)
125{
126 return (word >> shift) | (word << (16 - shift));
127}
128
129/**
130 * rol8 - rotate an 8-bit value left
131 * @word: value to rotate
132 * @shift: bits to roll
133 */
134static inline __u8 rol8(__u8 word, unsigned int shift)
135{
136 return (word << shift) | (word >> (8 - shift));
137}
138
139/**
140 * ror8 - rotate an 8-bit value right
141 * @word: value to rotate
142 * @shift: bits to roll
143 */
144static inline __u8 ror8(__u8 word, unsigned int shift)
145{
146 return (word >> shift) | (word << (8 - shift));
147}
148
Andreas Herrmann7919a572010-08-30 19:04:01 +0000149/**
150 * sign_extend32 - sign extend a 32-bit value using specified bit as sign-bit
151 * @value: value to sign extend
152 * @index: 0 based bit index (0<=index<32) to sign bit
153 */
154static inline __s32 sign_extend32(__u32 value, int index)
155{
156 __u8 shift = 31 - index;
157 return (__s32)(value << shift) >> shift;
158}
159
Andrew Morton962749a2006-03-25 03:08:01 -0800160static inline unsigned fls_long(unsigned long l)
161{
162 if (sizeof(l) == 4)
163 return fls(l);
164 return fls64(l);
165}
166
Steven Whitehouse952043a2009-04-23 08:48:15 +0100167/**
168 * __ffs64 - find first set bit in a 64 bit word
169 * @word: The 64 bit word
170 *
171 * On 64 bit arches this is a synomyn for __ffs
172 * The result is not defined if no bits are set, so check that @word
173 * is non-zero before calling this.
174 */
175static inline unsigned long __ffs64(u64 word)
176{
177#if BITS_PER_LONG == 32
178 if (((u32)word) == 0UL)
179 return __ffs((u32)(word >> 32)) + 32;
180#elif BITS_PER_LONG != 64
181#error BITS_PER_LONG not 32 or 64
182#endif
183 return __ffs((unsigned long)word);
184}
185
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100186#ifdef __KERNEL__
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200187
Akinobu Mita19de85e2011-05-26 16:26:09 -0700188#ifndef find_last_bit
Rusty Russellab53d472009-01-01 10:12:19 +1030189/**
190 * find_last_bit - find the last set bit in a memory region
191 * @addr: The address to start the search at
192 * @size: The maximum size to search
193 *
194 * Returns the bit number of the first set bit, or size.
195 */
196extern unsigned long find_last_bit(const unsigned long *addr,
197 unsigned long size);
Akinobu Mita19de85e2011-05-26 16:26:09 -0700198#endif
Rusty Russellab53d472009-01-01 10:12:19 +1030199
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100200#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201#endif