blob: c55d5bc4ee5834c034f97e11c6500717416dcc63 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070013/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 * Include this here because some architectures need generic_ffs/fls in
15 * scope
16 */
17#include <asm/bitops.h>
18
Akinobu Mita984b3f52010-03-05 13:41:37 -080019#define for_each_set_bit(bit, addr, size) \
Shannon Nelson3e037452007-10-16 01:27:40 -070020 for ((bit) = find_first_bit((addr), (size)); \
21 (bit) < (size); \
22 (bit) = find_next_bit((addr), (size), (bit) + 1))
23
Akinobu Mita984b3f52010-03-05 13:41:37 -080024/* Temporary */
25#define for_each_bit(bit, addr, size) for_each_set_bit(bit, addr, size)
Shannon Nelson3e037452007-10-16 01:27:40 -070026
Linus Torvalds1da177e2005-04-16 15:20:36 -070027static __inline__ int get_bitmask_order(unsigned int count)
28{
29 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010030
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 order = fls(count);
32 return order; /* We could be slightly more clever with -1 here... */
33}
34
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010035static __inline__ int get_count_order(unsigned int count)
36{
37 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010038
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010039 order = fls(count) - 1;
40 if (count & (count - 1))
41 order++;
42 return order;
43}
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045static inline unsigned long hweight_long(unsigned long w)
46{
Akinobu Mitae9bebd62006-03-26 01:39:55 -080047 return sizeof(w) == 4 ? hweight32(w) : hweight64(w);
Linus Torvalds1da177e2005-04-16 15:20:36 -070048}
49
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080050/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * rol32 - rotate a 32-bit value left
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * @word: value to rotate
53 * @shift: bits to roll
54 */
55static inline __u32 rol32(__u32 word, unsigned int shift)
56{
57 return (word << shift) | (word >> (32 - shift));
58}
59
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080060/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 * ror32 - rotate a 32-bit value right
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 * @word: value to rotate
63 * @shift: bits to roll
64 */
65static inline __u32 ror32(__u32 word, unsigned int shift)
66{
67 return (word >> shift) | (word << (32 - shift));
68}
69
Harvey Harrison3afe3922008-03-28 14:16:01 -070070/**
71 * rol16 - rotate a 16-bit value left
72 * @word: value to rotate
73 * @shift: bits to roll
74 */
75static inline __u16 rol16(__u16 word, unsigned int shift)
76{
77 return (word << shift) | (word >> (16 - shift));
78}
79
80/**
81 * ror16 - rotate a 16-bit value right
82 * @word: value to rotate
83 * @shift: bits to roll
84 */
85static inline __u16 ror16(__u16 word, unsigned int shift)
86{
87 return (word >> shift) | (word << (16 - shift));
88}
89
90/**
91 * rol8 - rotate an 8-bit value left
92 * @word: value to rotate
93 * @shift: bits to roll
94 */
95static inline __u8 rol8(__u8 word, unsigned int shift)
96{
97 return (word << shift) | (word >> (8 - shift));
98}
99
100/**
101 * ror8 - rotate an 8-bit value right
102 * @word: value to rotate
103 * @shift: bits to roll
104 */
105static inline __u8 ror8(__u8 word, unsigned int shift)
106{
107 return (word >> shift) | (word << (8 - shift));
108}
109
Andrew Morton962749a2006-03-25 03:08:01 -0800110static inline unsigned fls_long(unsigned long l)
111{
112 if (sizeof(l) == 4)
113 return fls(l);
114 return fls64(l);
115}
116
Steven Whitehouse952043a2009-04-23 08:48:15 +0100117/**
118 * __ffs64 - find first set bit in a 64 bit word
119 * @word: The 64 bit word
120 *
121 * On 64 bit arches this is a synomyn for __ffs
122 * The result is not defined if no bits are set, so check that @word
123 * is non-zero before calling this.
124 */
125static inline unsigned long __ffs64(u64 word)
126{
127#if BITS_PER_LONG == 32
128 if (((u32)word) == 0UL)
129 return __ffs((u32)(word >> 32)) + 32;
130#elif BITS_PER_LONG != 64
131#error BITS_PER_LONG not 32 or 64
132#endif
133 return __ffs((unsigned long)word);
134}
135
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100136#ifdef __KERNEL__
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200137#ifdef CONFIG_GENERIC_FIND_FIRST_BIT
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200138
139/**
140 * find_first_bit - find the first set bit in a memory region
141 * @addr: The address to start the search at
142 * @size: The maximum size to search
143 *
144 * Returns the bit number of the first set bit.
145 */
Thomas Gleixnerfee4b192008-04-29 12:01:02 +0200146extern unsigned long find_first_bit(const unsigned long *addr,
147 unsigned long size);
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200148
149/**
150 * find_first_zero_bit - find the first cleared bit in a memory region
151 * @addr: The address to start the search at
152 * @size: The maximum size to search
153 *
154 * Returns the bit number of the first cleared bit.
155 */
Thomas Gleixnerfee4b192008-04-29 12:01:02 +0200156extern unsigned long find_first_zero_bit(const unsigned long *addr,
157 unsigned long size);
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200158#endif /* CONFIG_GENERIC_FIND_FIRST_BIT */
159
Rusty Russellab53d472009-01-01 10:12:19 +1030160#ifdef CONFIG_GENERIC_FIND_LAST_BIT
161/**
162 * find_last_bit - find the last set 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 set bit, or size.
167 */
168extern unsigned long find_last_bit(const unsigned long *addr,
169 unsigned long size);
170#endif /* CONFIG_GENERIC_FIND_LAST_BIT */
171
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100172#ifdef CONFIG_GENERIC_FIND_NEXT_BIT
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100173
174/**
175 * find_next_bit - find the next set bit in a memory region
176 * @addr: The address to base the search on
177 * @offset: The bitnumber to start searching at
178 * @size: The bitmap size in bits
179 */
Thomas Gleixnerfee4b192008-04-29 12:01:02 +0200180extern unsigned long find_next_bit(const unsigned long *addr,
181 unsigned long size, unsigned long offset);
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100182
183/**
184 * find_next_zero_bit - find the next cleared bit in a memory region
185 * @addr: The address to base the search on
186 * @offset: The bitnumber to start searching at
187 * @size: The bitmap size in bits
188 */
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100189
Thomas Gleixnerfee4b192008-04-29 12:01:02 +0200190extern unsigned long find_next_zero_bit(const unsigned long *addr,
191 unsigned long size,
192 unsigned long offset);
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100193
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100194#endif /* CONFIG_GENERIC_FIND_NEXT_BIT */
195#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196#endif