1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright IBM Corp. 1999,2013
5 * Author(s): Martin Schwidefsky <schwidefsky@de.ibm.com>,
7 * The description below was taken in large parts from the powerpc
9 * Within a word, bits are numbered LSB first. Lot's of places make
10 * this assumption by directly testing bits with (val & (1<<nr)).
11 * This can cause confusion for large (> 1 word) bitmaps on a
12 * big-endian system because, unlike little endian, the number of each
13 * bit depends on the word size.
15 * The bitop functions are defined to work on unsigned longs, so the bits
17 * |63..............0|127............64|191...........128|255...........192|
19 * We also have special functions which work with an MSB0 encoding.
20 * The bits are numbered:
21 * |0..............63|64............127|128...........191|192...........255|
23 * The main difference is that bit 0-63 in the bit number field needs to be
24 * reversed compared to the LSB0 encoded bit fields. This can be achieved by
29 #ifndef _S390_BITOPS_H
30 #define _S390_BITOPS_H
32 #ifndef _LINUX_BITOPS_H
33 #error only <linux/bitops.h> can be included directly
36 #include <linux/typecheck.h>
37 #include <linux/compiler.h>
38 #include <linux/types.h>
39 #include <asm/atomic_ops.h>
40 #include <asm/barrier.h>
42 #define __BITOPS_WORDS(bits) (((bits) + BITS_PER_LONG - 1) / BITS_PER_LONG)
44 static inline unsigned long *
45 __bitops_word(unsigned long nr, const volatile unsigned long *ptr)
49 addr = (unsigned long)ptr + ((nr ^ (nr & (BITS_PER_LONG - 1))) >> 3);
50 return (unsigned long *)addr;
53 static inline unsigned long __bitops_mask(unsigned long nr)
55 return 1UL << (nr & (BITS_PER_LONG - 1));
58 static __always_inline void arch_set_bit(unsigned long nr, volatile unsigned long *ptr)
60 unsigned long *addr = __bitops_word(nr, ptr);
61 unsigned long mask = __bitops_mask(nr);
63 __atomic64_or(mask, (long *)addr);
66 static __always_inline void arch_clear_bit(unsigned long nr, volatile unsigned long *ptr)
68 unsigned long *addr = __bitops_word(nr, ptr);
69 unsigned long mask = __bitops_mask(nr);
71 __atomic64_and(~mask, (long *)addr);
74 static __always_inline void arch_change_bit(unsigned long nr,
75 volatile unsigned long *ptr)
77 unsigned long *addr = __bitops_word(nr, ptr);
78 unsigned long mask = __bitops_mask(nr);
80 __atomic64_xor(mask, (long *)addr);
83 static inline bool arch_test_and_set_bit(unsigned long nr,
84 volatile unsigned long *ptr)
86 unsigned long *addr = __bitops_word(nr, ptr);
87 unsigned long mask = __bitops_mask(nr);
90 old = __atomic64_or_barrier(mask, (long *)addr);
94 static inline bool arch_test_and_clear_bit(unsigned long nr,
95 volatile unsigned long *ptr)
97 unsigned long *addr = __bitops_word(nr, ptr);
98 unsigned long mask = __bitops_mask(nr);
101 old = __atomic64_and_barrier(~mask, (long *)addr);
105 static inline bool arch_test_and_change_bit(unsigned long nr,
106 volatile unsigned long *ptr)
108 unsigned long *addr = __bitops_word(nr, ptr);
109 unsigned long mask = __bitops_mask(nr);
112 old = __atomic64_xor_barrier(mask, (long *)addr);
116 static inline void arch___set_bit(unsigned long nr, volatile unsigned long *ptr)
118 unsigned long *addr = __bitops_word(nr, ptr);
119 unsigned long mask = __bitops_mask(nr);
124 static inline void arch___clear_bit(unsigned long nr,
125 volatile unsigned long *ptr)
127 unsigned long *addr = __bitops_word(nr, ptr);
128 unsigned long mask = __bitops_mask(nr);
133 static inline void arch___change_bit(unsigned long nr,
134 volatile unsigned long *ptr)
136 unsigned long *addr = __bitops_word(nr, ptr);
137 unsigned long mask = __bitops_mask(nr);
142 static inline bool arch___test_and_set_bit(unsigned long nr,
143 volatile unsigned long *ptr)
145 unsigned long *addr = __bitops_word(nr, ptr);
146 unsigned long mask = __bitops_mask(nr);
154 static inline bool arch___test_and_clear_bit(unsigned long nr,
155 volatile unsigned long *ptr)
157 unsigned long *addr = __bitops_word(nr, ptr);
158 unsigned long mask = __bitops_mask(nr);
166 static inline bool arch___test_and_change_bit(unsigned long nr,
167 volatile unsigned long *ptr)
169 unsigned long *addr = __bitops_word(nr, ptr);
170 unsigned long mask = __bitops_mask(nr);
178 static inline bool arch_test_bit(unsigned long nr,
179 const volatile unsigned long *ptr)
181 const volatile unsigned long *addr = __bitops_word(nr, ptr);
182 unsigned long mask = __bitops_mask(nr);
187 static inline bool arch_test_and_set_bit_lock(unsigned long nr,
188 volatile unsigned long *ptr)
190 if (arch_test_bit(nr, ptr))
192 return arch_test_and_set_bit(nr, ptr);
195 static inline void arch_clear_bit_unlock(unsigned long nr,
196 volatile unsigned long *ptr)
198 smp_mb__before_atomic();
199 arch_clear_bit(nr, ptr);
202 static inline void arch___clear_bit_unlock(unsigned long nr,
203 volatile unsigned long *ptr)
206 arch___clear_bit(nr, ptr);
209 #include <asm-generic/bitops/instrumented-atomic.h>
210 #include <asm-generic/bitops/instrumented-non-atomic.h>
211 #include <asm-generic/bitops/instrumented-lock.h>
214 * Functions which use MSB0 bit numbering.
215 * The bits are numbered:
216 * |0..............63|64............127|128...........191|192...........255|
218 unsigned long find_first_bit_inv(const unsigned long *addr, unsigned long size);
219 unsigned long find_next_bit_inv(const unsigned long *addr, unsigned long size,
220 unsigned long offset);
222 #define for_each_set_bit_inv(bit, addr, size) \
223 for ((bit) = find_first_bit_inv((addr), (size)); \
225 (bit) = find_next_bit_inv((addr), (size), (bit) + 1))
227 static inline void set_bit_inv(unsigned long nr, volatile unsigned long *ptr)
229 return set_bit(nr ^ (BITS_PER_LONG - 1), ptr);
232 static inline void clear_bit_inv(unsigned long nr, volatile unsigned long *ptr)
234 return clear_bit(nr ^ (BITS_PER_LONG - 1), ptr);
237 static inline bool test_and_clear_bit_inv(unsigned long nr,
238 volatile unsigned long *ptr)
240 return test_and_clear_bit(nr ^ (BITS_PER_LONG - 1), ptr);
243 static inline void __set_bit_inv(unsigned long nr, volatile unsigned long *ptr)
245 return __set_bit(nr ^ (BITS_PER_LONG - 1), ptr);
248 static inline void __clear_bit_inv(unsigned long nr, volatile unsigned long *ptr)
250 return __clear_bit(nr ^ (BITS_PER_LONG - 1), ptr);
253 static inline bool test_bit_inv(unsigned long nr,
254 const volatile unsigned long *ptr)
256 return test_bit(nr ^ (BITS_PER_LONG - 1), ptr);
259 #ifdef CONFIG_HAVE_MARCH_Z9_109_FEATURES
262 * __flogr - find leftmost one
263 * @word - The word to search
265 * Returns the bit number of the most significant bit set,
266 * where the most significant bit has bit number 0.
267 * If no bit is set this function returns 64.
269 static inline unsigned char __flogr(unsigned long word)
271 if (__builtin_constant_p(word)) {
272 unsigned long bit = 0;
276 if (!(word & 0xffffffff00000000UL)) {
280 if (!(word & 0xffff000000000000UL)) {
284 if (!(word & 0xff00000000000000UL)) {
288 if (!(word & 0xf000000000000000UL)) {
292 if (!(word & 0xc000000000000000UL)) {
296 if (!(word & 0x8000000000000000UL)) {
302 union register_pair rp;
306 " flogr %[rp],%[rp]\n"
307 : [rp] "+d" (rp.pair) : : "cc");
313 * __ffs - find first bit in word.
314 * @word: The word to search
316 * Undefined if no bit exists, so code should check against 0 first.
318 static inline unsigned long __ffs(unsigned long word)
320 return __flogr(-word & word) ^ (BITS_PER_LONG - 1);
324 * ffs - find first bit set
325 * @word: the word to search
327 * This is defined the same way as the libc and
328 * compiler builtin ffs routines (man ffs).
330 static inline int ffs(int word)
332 unsigned long mask = 2 * BITS_PER_LONG - 1;
333 unsigned int val = (unsigned int)word;
335 return (1 + (__flogr(-val & val) ^ (BITS_PER_LONG - 1))) & mask;
339 * __fls - find last (most-significant) set bit in a long word
340 * @word: the word to search
342 * Undefined if no set bit exists, so code should check against 0 first.
344 static inline unsigned long __fls(unsigned long word)
346 return __flogr(word) ^ (BITS_PER_LONG - 1);
350 * fls64 - find last set bit in a 64-bit word
351 * @word: the word to search
353 * This is defined in a similar way as the libc and compiler builtin
354 * ffsll, but returns the position of the most significant set bit.
356 * fls64(value) returns 0 if value is 0 or the position of the last
357 * set bit if value is nonzero. The last (most significant) bit is
360 static inline int fls64(unsigned long word)
362 unsigned long mask = 2 * BITS_PER_LONG - 1;
364 return (1 + (__flogr(word) ^ (BITS_PER_LONG - 1))) & mask;
368 * fls - find last (most-significant) bit set
369 * @word: the word to search
371 * This is defined the same way as ffs.
372 * Note fls(0) = 0, fls(1) = 1, fls(0x80000000) = 32.
374 static inline int fls(unsigned int word)
379 #else /* CONFIG_HAVE_MARCH_Z9_109_FEATURES */
381 #include <asm-generic/bitops/__ffs.h>
382 #include <asm-generic/bitops/ffs.h>
383 #include <asm-generic/bitops/__fls.h>
384 #include <asm-generic/bitops/fls.h>
385 #include <asm-generic/bitops/fls64.h>
387 #endif /* CONFIG_HAVE_MARCH_Z9_109_FEATURES */
389 #include <asm-generic/bitops/ffz.h>
390 #include <asm-generic/bitops/find.h>
391 #include <asm-generic/bitops/hweight.h>
392 #include <asm-generic/bitops/sched.h>
393 #include <asm-generic/bitops/le.h>
394 #include <asm-generic/bitops/ext2-atomic-setbit.h>
396 #endif /* _S390_BITOPS_H */