blob: a78e358f0c1736240ffa32a26e088b11cdaed086 [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 Mita307b1cd2012-03-23 15:02:03 -070035#define for_each_set_bit_cont(bit, addr, size) \
36 for_each_set_bit_from(bit, addr, size)
37
Linus Torvalds1da177e2005-04-16 15:20:36 -070038static __inline__ int get_bitmask_order(unsigned int count)
39{
40 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 order = fls(count);
43 return order; /* We could be slightly more clever with -1 here... */
44}
45
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010046static __inline__ int get_count_order(unsigned int count)
47{
48 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010049
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010050 order = fls(count) - 1;
51 if (count & (count - 1))
52 order++;
53 return order;
54}
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056static inline unsigned long hweight_long(unsigned long w)
57{
Akinobu Mitae9bebd62006-03-26 01:39:55 -080058 return sizeof(w) == 4 ? hweight32(w) : hweight64(w);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059}
60
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080061/**
Alexey Dobriyanf2ea0f52012-01-14 21:44:49 +030062 * rol64 - rotate a 64-bit value left
63 * @word: value to rotate
64 * @shift: bits to roll
65 */
66static inline __u64 rol64(__u64 word, unsigned int shift)
67{
68 return (word << shift) | (word >> (64 - shift));
69}
70
71/**
72 * ror64 - rotate a 64-bit value right
73 * @word: value to rotate
74 * @shift: bits to roll
75 */
76static inline __u64 ror64(__u64 word, unsigned int shift)
77{
78 return (word >> shift) | (word << (64 - shift));
79}
80
81/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 * rol32 - rotate a 32-bit value left
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 * @word: value to rotate
84 * @shift: bits to roll
85 */
86static inline __u32 rol32(__u32 word, unsigned int shift)
87{
88 return (word << shift) | (word >> (32 - shift));
89}
90
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080091/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 * ror32 - rotate a 32-bit value right
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 * @word: value to rotate
94 * @shift: bits to roll
95 */
96static inline __u32 ror32(__u32 word, unsigned int shift)
97{
98 return (word >> shift) | (word << (32 - shift));
99}
100
Harvey Harrison3afe3922008-03-28 14:16:01 -0700101/**
102 * rol16 - rotate a 16-bit value left
103 * @word: value to rotate
104 * @shift: bits to roll
105 */
106static inline __u16 rol16(__u16 word, unsigned int shift)
107{
108 return (word << shift) | (word >> (16 - shift));
109}
110
111/**
112 * ror16 - rotate a 16-bit value right
113 * @word: value to rotate
114 * @shift: bits to roll
115 */
116static inline __u16 ror16(__u16 word, unsigned int shift)
117{
118 return (word >> shift) | (word << (16 - shift));
119}
120
121/**
122 * rol8 - rotate an 8-bit value left
123 * @word: value to rotate
124 * @shift: bits to roll
125 */
126static inline __u8 rol8(__u8 word, unsigned int shift)
127{
128 return (word << shift) | (word >> (8 - shift));
129}
130
131/**
132 * ror8 - rotate an 8-bit value right
133 * @word: value to rotate
134 * @shift: bits to roll
135 */
136static inline __u8 ror8(__u8 word, unsigned int shift)
137{
138 return (word >> shift) | (word << (8 - shift));
139}
140
Andreas Herrmann7919a572010-08-30 19:04:01 +0000141/**
142 * sign_extend32 - sign extend a 32-bit value using specified bit as sign-bit
143 * @value: value to sign extend
144 * @index: 0 based bit index (0<=index<32) to sign bit
145 */
146static inline __s32 sign_extend32(__u32 value, int index)
147{
148 __u8 shift = 31 - index;
149 return (__s32)(value << shift) >> shift;
150}
151
Andrew Morton962749a2006-03-25 03:08:01 -0800152static inline unsigned fls_long(unsigned long l)
153{
154 if (sizeof(l) == 4)
155 return fls(l);
156 return fls64(l);
157}
158
Steven Whitehouse952043a2009-04-23 08:48:15 +0100159/**
160 * __ffs64 - find first set bit in a 64 bit word
161 * @word: The 64 bit word
162 *
163 * On 64 bit arches this is a synomyn for __ffs
164 * The result is not defined if no bits are set, so check that @word
165 * is non-zero before calling this.
166 */
167static inline unsigned long __ffs64(u64 word)
168{
169#if BITS_PER_LONG == 32
170 if (((u32)word) == 0UL)
171 return __ffs((u32)(word >> 32)) + 32;
172#elif BITS_PER_LONG != 64
173#error BITS_PER_LONG not 32 or 64
174#endif
175 return __ffs((unsigned long)word);
176}
177
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100178#ifdef __KERNEL__
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200179
Akinobu Mita19de85e2011-05-26 16:26:09 -0700180#ifndef find_last_bit
Rusty Russellab53d472009-01-01 10:12:19 +1030181/**
182 * find_last_bit - find the last set bit in a memory region
183 * @addr: The address to start the search at
184 * @size: The maximum size to search
185 *
186 * Returns the bit number of the first set bit, or size.
187 */
188extern unsigned long find_last_bit(const unsigned long *addr,
189 unsigned long size);
Akinobu Mita19de85e2011-05-26 16:26:09 -0700190#endif
Rusty Russellab53d472009-01-01 10:12:19 +1030191
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100192#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193#endif