blob: fc8a3ffce3204b7f887c401bb2e14bfc229cc5fd [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) \
Shannon Nelson3e037452007-10-16 01:27:40 -070025 for ((bit) = find_first_bit((addr), (size)); \
26 (bit) < (size); \
27 (bit) = find_next_bit((addr), (size), (bit) + 1))
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029static __inline__ int get_bitmask_order(unsigned int count)
30{
31 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010032
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 order = fls(count);
34 return order; /* We could be slightly more clever with -1 here... */
35}
36
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010037static __inline__ int get_count_order(unsigned int count)
38{
39 int order;
Peter Zijlstra9f416992010-01-22 15:59:29 +010040
Siddha, Suresh B94605ef2005-11-05 17:25:54 +010041 order = fls(count) - 1;
42 if (count & (count - 1))
43 order++;
44 return order;
45}
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047static inline unsigned long hweight_long(unsigned long w)
48{
Akinobu Mitae9bebd62006-03-26 01:39:55 -080049 return sizeof(w) == 4 ? hweight32(w) : hweight64(w);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050}
51
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080052/**
Alexey Dobriyanf2ea0f52012-01-14 21:44:49 +030053 * rol64 - rotate a 64-bit value left
54 * @word: value to rotate
55 * @shift: bits to roll
56 */
57static inline __u64 rol64(__u64 word, unsigned int shift)
58{
59 return (word << shift) | (word >> (64 - shift));
60}
61
62/**
63 * ror64 - rotate a 64-bit value right
64 * @word: value to rotate
65 * @shift: bits to roll
66 */
67static inline __u64 ror64(__u64 word, unsigned int shift)
68{
69 return (word >> shift) | (word << (64 - shift));
70}
71
72/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * rol32 - rotate a 32-bit value left
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 * @word: value to rotate
75 * @shift: bits to roll
76 */
77static inline __u32 rol32(__u32 word, unsigned int shift)
78{
79 return (word << shift) | (word >> (32 - shift));
80}
81
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080082/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 * ror32 - rotate a 32-bit value right
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 * @word: value to rotate
85 * @shift: bits to roll
86 */
87static inline __u32 ror32(__u32 word, unsigned int shift)
88{
89 return (word >> shift) | (word << (32 - shift));
90}
91
Harvey Harrison3afe3922008-03-28 14:16:01 -070092/**
93 * rol16 - rotate a 16-bit value left
94 * @word: value to rotate
95 * @shift: bits to roll
96 */
97static inline __u16 rol16(__u16 word, unsigned int shift)
98{
99 return (word << shift) | (word >> (16 - shift));
100}
101
102/**
103 * ror16 - rotate a 16-bit value right
104 * @word: value to rotate
105 * @shift: bits to roll
106 */
107static inline __u16 ror16(__u16 word, unsigned int shift)
108{
109 return (word >> shift) | (word << (16 - shift));
110}
111
112/**
113 * rol8 - rotate an 8-bit value left
114 * @word: value to rotate
115 * @shift: bits to roll
116 */
117static inline __u8 rol8(__u8 word, unsigned int shift)
118{
119 return (word << shift) | (word >> (8 - shift));
120}
121
122/**
123 * ror8 - rotate an 8-bit value right
124 * @word: value to rotate
125 * @shift: bits to roll
126 */
127static inline __u8 ror8(__u8 word, unsigned int shift)
128{
129 return (word >> shift) | (word << (8 - shift));
130}
131
Andreas Herrmann7919a572010-08-30 19:04:01 +0000132/**
133 * sign_extend32 - sign extend a 32-bit value using specified bit as sign-bit
134 * @value: value to sign extend
135 * @index: 0 based bit index (0<=index<32) to sign bit
136 */
137static inline __s32 sign_extend32(__u32 value, int index)
138{
139 __u8 shift = 31 - index;
140 return (__s32)(value << shift) >> shift;
141}
142
Andrew Morton962749a2006-03-25 03:08:01 -0800143static inline unsigned fls_long(unsigned long l)
144{
145 if (sizeof(l) == 4)
146 return fls(l);
147 return fls64(l);
148}
149
Steven Whitehouse952043a2009-04-23 08:48:15 +0100150/**
151 * __ffs64 - find first set bit in a 64 bit word
152 * @word: The 64 bit word
153 *
154 * On 64 bit arches this is a synomyn for __ffs
155 * The result is not defined if no bits are set, so check that @word
156 * is non-zero before calling this.
157 */
158static inline unsigned long __ffs64(u64 word)
159{
160#if BITS_PER_LONG == 32
161 if (((u32)word) == 0UL)
162 return __ffs((u32)(word >> 32)) + 32;
163#elif BITS_PER_LONG != 64
164#error BITS_PER_LONG not 32 or 64
165#endif
166 return __ffs((unsigned long)word);
167}
168
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100169#ifdef __KERNEL__
Alexander van Heukelum77b9bd92008-04-01 11:46:19 +0200170
Akinobu Mita19de85e2011-05-26 16:26:09 -0700171#ifndef find_last_bit
Rusty Russellab53d472009-01-01 10:12:19 +1030172/**
173 * find_last_bit - find the last set bit in a memory region
174 * @addr: The address to start the search at
175 * @size: The maximum size to search
176 *
177 * Returns the bit number of the first set bit, or size.
178 */
179extern unsigned long find_last_bit(const unsigned long *addr,
180 unsigned long size);
Akinobu Mita19de85e2011-05-26 16:26:09 -0700181#endif
Rusty Russellab53d472009-01-01 10:12:19 +1030182
Alexander van Heukelum64970b62008-03-11 16:17:19 +0100183#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184#endif