bitmap.h 17.6 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds's avatar
Linus Torvalds committed
2 3 4 5 6 7 8 9
#ifndef __LINUX_BITMAP_H
#define __LINUX_BITMAP_H

#ifndef __ASSEMBLY__

#include <linux/types.h>
#include <linux/bitops.h>
#include <linux/string.h>
Jiri Slaby's avatar
Jiri Slaby committed
10
#include <linux/kernel.h>
Linus Torvalds's avatar
Linus Torvalds committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24

/*
 * bitmaps provide bit arrays that consume one or more unsigned
 * longs.  The bitmap interface and available operations are listed
 * here, in bitmap.h
 *
 * Function implementations generic to all architectures are in
 * lib/bitmap.c.  Functions implementations that are architecture
 * specific are in various include/asm-<arch>/bitops.h headers
 * and other arch/<arch> specific files.
 *
 * See lib/bitmap.c for more details.
 */

25 26 27
/**
 * DOC: bitmap overview
 *
Linus Torvalds's avatar
Linus Torvalds committed
28 29 30
 * The available bitmap operations and their rough meaning in the
 * case that the bitmap is a single unsigned long are thus:
 *
31 32
 * The generated code is more efficient when nbits is known at
 * compile-time and at most BITS_PER_LONG.
33
 *
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
 * ::
 *
 *  bitmap_zero(dst, nbits)                     *dst = 0UL
 *  bitmap_fill(dst, nbits)                     *dst = ~0UL
 *  bitmap_copy(dst, src, nbits)                *dst = *src
 *  bitmap_and(dst, src1, src2, nbits)          *dst = *src1 & *src2
 *  bitmap_or(dst, src1, src2, nbits)           *dst = *src1 | *src2
 *  bitmap_xor(dst, src1, src2, nbits)          *dst = *src1 ^ *src2
 *  bitmap_andnot(dst, src1, src2, nbits)       *dst = *src1 & ~(*src2)
 *  bitmap_complement(dst, src, nbits)          *dst = ~(*src)
 *  bitmap_equal(src1, src2, nbits)             Are *src1 and *src2 equal?
 *  bitmap_intersects(src1, src2, nbits)        Do *src1 and *src2 overlap?
 *  bitmap_subset(src1, src2, nbits)            Is *src1 a subset of *src2?
 *  bitmap_empty(src, nbits)                    Are all bits zero in *src?
 *  bitmap_full(src, nbits)                     Are all bits set in *src?
 *  bitmap_weight(src, nbits)                   Hamming Weight: number set bits
 *  bitmap_set(dst, pos, nbits)                 Set specified bit area
 *  bitmap_clear(dst, pos, nbits)               Clear specified bit area
 *  bitmap_find_next_zero_area(buf, len, pos, n, mask)  Find bit free area
 *  bitmap_find_next_zero_area_off(buf, len, pos, n, mask)  as above
 *  bitmap_shift_right(dst, src, n, nbits)      *dst = *src >> n
 *  bitmap_shift_left(dst, src, n, nbits)       *dst = *src << n
 *  bitmap_remap(dst, src, old, new, nbits)     *dst = map(old, new)(src)
 *  bitmap_bitremap(oldbit, old, new, nbits)    newbit = map(old, new)(oldbit)
 *  bitmap_onto(dst, orig, relmap, nbits)       *dst = orig relative to relmap
 *  bitmap_fold(dst, orig, sz, nbits)           dst bits = orig bits mod sz
 *  bitmap_parse(buf, buflen, dst, nbits)       Parse bitmap dst from kernel buf
 *  bitmap_parse_user(ubuf, ulen, dst, nbits)   Parse bitmap dst from user buf
 *  bitmap_parselist(buf, dst, nbits)           Parse bitmap dst from kernel buf
 *  bitmap_parselist_user(buf, dst, nbits)      Parse bitmap dst from user buf
 *  bitmap_find_free_region(bitmap, bits, order)  Find and allocate bit region
 *  bitmap_release_region(bitmap, pos, order)   Free specified bit region
 *  bitmap_allocate_region(bitmap, pos, order)  Allocate specified bit region
67 68
 *  bitmap_from_arr32(dst, buf, nbits)          Copy nbits from u32[] buf to dst
 *  bitmap_to_arr32(buf, src, nbits)            Copy nbits from buf to u32[] dst
69
 *
70 71 72 73 74
 * Note, bitmap_zero() and bitmap_fill() operate over the region of
 * unsigned longs, that is, bits behind bitmap till the unsigned long
 * boundary will be zeroed or filled as well. Consider to use
 * bitmap_clear() or bitmap_set() to make explicit zeroing or filling
 * respectively.
Linus Torvalds's avatar
Linus Torvalds committed
75 76
 */

77 78 79 80 81 82 83 84 85 86 87 88 89 90
/**
 * DOC: bitmap bitops
 *
 * Also the following operations in asm/bitops.h apply to bitmaps.::
 *
 *  set_bit(bit, addr)                  *addr |= bit
 *  clear_bit(bit, addr)                *addr &= ~bit
 *  change_bit(bit, addr)               *addr ^= bit
 *  test_bit(bit, addr)                 Is bit set in *addr?
 *  test_and_set_bit(bit, addr)         Set bit and return old value
 *  test_and_clear_bit(bit, addr)       Clear bit and return old value
 *  test_and_change_bit(bit, addr)      Change bit and return old value
 *  find_first_zero_bit(addr, nbits)    Position first zero bit in *addr
 *  find_first_bit(addr, nbits)         Position first set bit in *addr
91 92
 *  find_next_zero_bit(addr, nbits, bit)
 *                                      Position next zero bit in *addr >= bit
93
 *  find_next_bit(addr, nbits, bit)     Position next set bit in *addr >= bit
94 95 96
 *  find_next_and_bit(addr1, addr2, nbits, bit)
 *                                      Same as find_next_bit, but in
 *                                      (*addr1 & *addr2)
Linus Torvalds's avatar
Linus Torvalds committed
97 98 99
 *
 */

100 101
/**
 * DOC: declare bitmap
Linus Torvalds's avatar
Linus Torvalds committed
102 103 104 105 106
 * The DECLARE_BITMAP(name,bits) macro, in linux/types.h, can be used
 * to declare an array named 'name' of just enough unsigned longs to
 * contain all bit positions from 0 to 'bits' - 1.
 */

107 108 109 110 111 112 113 114
/*
 * Allocation and deallocation of bitmap.
 * Provided in lib/bitmap.c to avoid circular dependency.
 */
extern unsigned long *bitmap_alloc(unsigned int nbits, gfp_t flags);
extern unsigned long *bitmap_zalloc(unsigned int nbits, gfp_t flags);
extern void bitmap_free(const unsigned long *bitmap);

Linus Torvalds's avatar
Linus Torvalds committed
115 116 117 118
/*
 * lib/bitmap.c provides these functions:
 */

119
extern int __bitmap_empty(const unsigned long *bitmap, unsigned int nbits);
120
extern int __bitmap_full(const unsigned long *bitmap, unsigned int nbits);
Linus Torvalds's avatar
Linus Torvalds committed
121
extern int __bitmap_equal(const unsigned long *bitmap1,
122
			  const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds's avatar
Linus Torvalds committed
123
extern void __bitmap_complement(unsigned long *dst, const unsigned long *src,
124
			unsigned int nbits);
125 126
extern void __bitmap_shift_right(unsigned long *dst, const unsigned long *src,
				unsigned int shift, unsigned int nbits);
127 128
extern void __bitmap_shift_left(unsigned long *dst, const unsigned long *src,
				unsigned int shift, unsigned int nbits);
129
extern int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1,
130
			const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds's avatar
Linus Torvalds committed
131
extern void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1,
132
			const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds's avatar
Linus Torvalds committed
133
extern void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1,
134
			const unsigned long *bitmap2, unsigned int nbits);
135
extern int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1,
136
			const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds's avatar
Linus Torvalds committed
137
extern int __bitmap_intersects(const unsigned long *bitmap1,
138
			const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds's avatar
Linus Torvalds committed
139
extern int __bitmap_subset(const unsigned long *bitmap1,
140
			const unsigned long *bitmap2, unsigned int nbits);
141
extern int __bitmap_weight(const unsigned long *bitmap, unsigned int nbits);
142 143
extern void __bitmap_set(unsigned long *map, unsigned int start, int len);
extern void __bitmap_clear(unsigned long *map, unsigned int start, int len);
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173

extern unsigned long bitmap_find_next_zero_area_off(unsigned long *map,
						    unsigned long size,
						    unsigned long start,
						    unsigned int nr,
						    unsigned long align_mask,
						    unsigned long align_offset);

/**
 * bitmap_find_next_zero_area - find a contiguous aligned zero area
 * @map: The address to base the search on
 * @size: The bitmap size in bits
 * @start: The bitnumber to start searching at
 * @nr: The number of zeroed bits we're looking for
 * @align_mask: Alignment mask for zero area
 *
 * The @align_mask should be one less than a power of 2; the effect is that
 * the bit offset of all zero areas this function finds is multiples of that
 * power of 2. A @align_mask of 0 means no alignment is required.
 */
static inline unsigned long
bitmap_find_next_zero_area(unsigned long *map,
			   unsigned long size,
			   unsigned long start,
			   unsigned int nr,
			   unsigned long align_mask)
{
	return bitmap_find_next_zero_area_off(map, size, start, nr,
					      align_mask, 0);
}
174

175 176 177
extern int __bitmap_parse(const char *buf, unsigned int buflen, int is_user,
			unsigned long *dst, int nbits);
extern int bitmap_parse_user(const char __user *ubuf, unsigned int ulen,
Linus Torvalds's avatar
Linus Torvalds committed
178 179 180
			unsigned long *dst, int nbits);
extern int bitmap_parselist(const char *buf, unsigned long *maskp,
			int nmaskbits);
181 182
extern int bitmap_parselist_user(const char __user *ubuf, unsigned int ulen,
			unsigned long *dst, int nbits);
183
extern void bitmap_remap(unsigned long *dst, const unsigned long *src,
184
		const unsigned long *old, const unsigned long *new, unsigned int nbits);
185 186
extern int bitmap_bitremap(int oldbit,
		const unsigned long *old, const unsigned long *new, int bits);
187
extern void bitmap_onto(unsigned long *dst, const unsigned long *orig,
188
		const unsigned long *relmap, unsigned int bits);
189
extern void bitmap_fold(unsigned long *dst, const unsigned long *orig,
190
		unsigned int sz, unsigned int nbits);
191 192 193
extern int bitmap_find_free_region(unsigned long *bitmap, unsigned int bits, int order);
extern void bitmap_release_region(unsigned long *bitmap, unsigned int pos, int order);
extern int bitmap_allocate_region(unsigned long *bitmap, unsigned int pos, int order);
194

195
#ifdef __BIG_ENDIAN
196
extern void bitmap_copy_le(unsigned long *dst, const unsigned long *src, unsigned int nbits);
197 198 199
#else
#define bitmap_copy_le bitmap_copy
#endif
200
extern unsigned int bitmap_ord_to_pos(const unsigned long *bitmap, unsigned int ord, unsigned int nbits);
201 202
extern int bitmap_print_to_pagebuf(bool list, char *buf,
				   const unsigned long *maskp, int nmaskbits);
Linus Torvalds's avatar
Linus Torvalds committed
203

204 205
#define BITMAP_FIRST_WORD_MASK(start) (~0UL << ((start) & (BITS_PER_LONG - 1)))
#define BITMAP_LAST_WORD_MASK(nbits) (~0UL >> (-(nbits) & (BITS_PER_LONG - 1)))
Linus Torvalds's avatar
Linus Torvalds committed
206

207 208 209 210 211
/*
 * The static inlines below do not handle constant nbits==0 correctly,
 * so make such users (should any ever turn up) call the out-of-line
 * versions.
 */
212
#define small_const_nbits(nbits) \
213
	(__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG && (nbits) > 0)
214

215
static inline void bitmap_zero(unsigned long *dst, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
216
{
217 218
	unsigned int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
	memset(dst, 0, len);
Linus Torvalds's avatar
Linus Torvalds committed
219 220
}

221
static inline void bitmap_fill(unsigned long *dst, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
222
{
223 224
	unsigned int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
	memset(dst, 0xff, len);
Linus Torvalds's avatar
Linus Torvalds committed
225 226 227
}

static inline void bitmap_copy(unsigned long *dst, const unsigned long *src,
228
			unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
229
{
230 231
	unsigned int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
	memcpy(dst, src, len);
Linus Torvalds's avatar
Linus Torvalds committed
232 233
}

234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
/*
 * Copy bitmap and clear tail bits in last word.
 */
static inline void bitmap_copy_clear_tail(unsigned long *dst,
		const unsigned long *src, unsigned int nbits)
{
	bitmap_copy(dst, src, nbits);
	if (nbits % BITS_PER_LONG)
		dst[nbits / BITS_PER_LONG] &= BITMAP_LAST_WORD_MASK(nbits);
}

/*
 * On 32-bit systems bitmaps are represented as u32 arrays internally, and
 * therefore conversion is not needed when copying data from/to arrays of u32.
 */
#if BITS_PER_LONG == 64
extern void bitmap_from_arr32(unsigned long *bitmap, const u32 *buf,
							unsigned int nbits);
extern void bitmap_to_arr32(u32 *buf, const unsigned long *bitmap,
							unsigned int nbits);
#else
#define bitmap_from_arr32(bitmap, buf, nbits)			\
	bitmap_copy_clear_tail((unsigned long *) (bitmap),	\
			(const unsigned long *) (buf), (nbits))
#define bitmap_to_arr32(buf, bitmap, nbits)			\
	bitmap_copy_clear_tail((unsigned long *) (buf),		\
			(const unsigned long *) (bitmap), (nbits))
#endif

263
static inline int bitmap_and(unsigned long *dst, const unsigned long *src1,
264
			const unsigned long *src2, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
265
{
266
	if (small_const_nbits(nbits))
267
		return (*dst = *src1 & *src2 & BITMAP_LAST_WORD_MASK(nbits)) != 0;
268
	return __bitmap_and(dst, src1, src2, nbits);
Linus Torvalds's avatar
Linus Torvalds committed
269 270 271
}

static inline void bitmap_or(unsigned long *dst, const unsigned long *src1,
272
			const unsigned long *src2, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
273
{
274
	if (small_const_nbits(nbits))
Linus Torvalds's avatar
Linus Torvalds committed
275 276 277 278 279 280
		*dst = *src1 | *src2;
	else
		__bitmap_or(dst, src1, src2, nbits);
}

static inline void bitmap_xor(unsigned long *dst, const unsigned long *src1,
281
			const unsigned long *src2, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
282
{
283
	if (small_const_nbits(nbits))
Linus Torvalds's avatar
Linus Torvalds committed
284 285 286 287 288
		*dst = *src1 ^ *src2;
	else
		__bitmap_xor(dst, src1, src2, nbits);
}

289
static inline int bitmap_andnot(unsigned long *dst, const unsigned long *src1,
290
			const unsigned long *src2, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
291
{
292
	if (small_const_nbits(nbits))
293
		return (*dst = *src1 & ~(*src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0;
294
	return __bitmap_andnot(dst, src1, src2, nbits);
Linus Torvalds's avatar
Linus Torvalds committed
295 296 297
}

static inline void bitmap_complement(unsigned long *dst, const unsigned long *src,
298
			unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
299
{
300
	if (small_const_nbits(nbits))
301
		*dst = ~(*src);
Linus Torvalds's avatar
Linus Torvalds committed
302 303 304 305
	else
		__bitmap_complement(dst, src, nbits);
}

306 307 308 309 310 311 312
#ifdef __LITTLE_ENDIAN
#define BITMAP_MEM_ALIGNMENT 8
#else
#define BITMAP_MEM_ALIGNMENT (8 * sizeof(unsigned long))
#endif
#define BITMAP_MEM_MASK (BITMAP_MEM_ALIGNMENT - 1)

Linus Torvalds's avatar
Linus Torvalds committed
313
static inline int bitmap_equal(const unsigned long *src1,
314
			const unsigned long *src2, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
315
{
316
	if (small_const_nbits(nbits))
317
		return !((*src1 ^ *src2) & BITMAP_LAST_WORD_MASK(nbits));
318 319
	if (__builtin_constant_p(nbits & BITMAP_MEM_MASK) &&
	    IS_ALIGNED(nbits, BITMAP_MEM_ALIGNMENT))
320
		return !memcmp(src1, src2, nbits / 8);
321
	return __bitmap_equal(src1, src2, nbits);
Linus Torvalds's avatar
Linus Torvalds committed
322 323 324
}

static inline int bitmap_intersects(const unsigned long *src1,
325
			const unsigned long *src2, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
326
{
327
	if (small_const_nbits(nbits))
Linus Torvalds's avatar
Linus Torvalds committed
328 329 330 331 332 333
		return ((*src1 & *src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0;
	else
		return __bitmap_intersects(src1, src2, nbits);
}

static inline int bitmap_subset(const unsigned long *src1,
334
			const unsigned long *src2, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
335
{
336
	if (small_const_nbits(nbits))
Linus Torvalds's avatar
Linus Torvalds committed
337 338 339 340 341
		return ! ((*src1 & ~(*src2)) & BITMAP_LAST_WORD_MASK(nbits));
	else
		return __bitmap_subset(src1, src2, nbits);
}

342
static inline int bitmap_empty(const unsigned long *src, unsigned nbits)
Linus Torvalds's avatar
Linus Torvalds committed
343
{
344
	if (small_const_nbits(nbits))
Linus Torvalds's avatar
Linus Torvalds committed
345
		return ! (*src & BITMAP_LAST_WORD_MASK(nbits));
346 347

	return find_first_bit(src, nbits) == nbits;
Linus Torvalds's avatar
Linus Torvalds committed
348 349
}

350
static inline int bitmap_full(const unsigned long *src, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
351
{
352
	if (small_const_nbits(nbits))
Linus Torvalds's avatar
Linus Torvalds committed
353
		return ! (~(*src) & BITMAP_LAST_WORD_MASK(nbits));
354 355

	return find_first_zero_bit(src, nbits) == nbits;
Linus Torvalds's avatar
Linus Torvalds committed
356 357
}

358
static __always_inline int bitmap_weight(const unsigned long *src, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
359
{
360
	if (small_const_nbits(nbits))
361
		return hweight_long(*src & BITMAP_LAST_WORD_MASK(nbits));
Linus Torvalds's avatar
Linus Torvalds committed
362 363 364
	return __bitmap_weight(src, nbits);
}

365 366 367 368 369
static __always_inline void bitmap_set(unsigned long *map, unsigned int start,
		unsigned int nbits)
{
	if (__builtin_constant_p(nbits) && nbits == 1)
		__set_bit(start, map);
370 371 372 373
	else if (__builtin_constant_p(start & BITMAP_MEM_MASK) &&
		 IS_ALIGNED(start, BITMAP_MEM_ALIGNMENT) &&
		 __builtin_constant_p(nbits & BITMAP_MEM_MASK) &&
		 IS_ALIGNED(nbits, BITMAP_MEM_ALIGNMENT))
374
		memset((char *)map + start / 8, 0xff, nbits / 8);
375 376 377 378 379 380 381 382 383
	else
		__bitmap_set(map, start, nbits);
}

static __always_inline void bitmap_clear(unsigned long *map, unsigned int start,
		unsigned int nbits)
{
	if (__builtin_constant_p(nbits) && nbits == 1)
		__clear_bit(start, map);
384 385 386 387
	else if (__builtin_constant_p(start & BITMAP_MEM_MASK) &&
		 IS_ALIGNED(start, BITMAP_MEM_ALIGNMENT) &&
		 __builtin_constant_p(nbits & BITMAP_MEM_MASK) &&
		 IS_ALIGNED(nbits, BITMAP_MEM_ALIGNMENT))
388
		memset((char *)map + start / 8, 0, nbits / 8);
389 390 391 392
	else
		__bitmap_clear(map, start, nbits);
}

393
static inline void bitmap_shift_right(unsigned long *dst, const unsigned long *src,
394
				unsigned int shift, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
395
{
396
	if (small_const_nbits(nbits))
397
		*dst = (*src & BITMAP_LAST_WORD_MASK(nbits)) >> shift;
Linus Torvalds's avatar
Linus Torvalds committed
398
	else
399
		__bitmap_shift_right(dst, src, shift, nbits);
Linus Torvalds's avatar
Linus Torvalds committed
400 401
}

402 403
static inline void bitmap_shift_left(unsigned long *dst, const unsigned long *src,
				unsigned int shift, unsigned int nbits)
Linus Torvalds's avatar
Linus Torvalds committed
404
{
405
	if (small_const_nbits(nbits))
406
		*dst = (*src << shift) & BITMAP_LAST_WORD_MASK(nbits);
Linus Torvalds's avatar
Linus Torvalds committed
407
	else
408
		__bitmap_shift_left(dst, src, shift, nbits);
Linus Torvalds's avatar
Linus Torvalds committed
409 410
}

411 412 413 414 415 416
static inline int bitmap_parse(const char *buf, unsigned int buflen,
			unsigned long *maskp, int nmaskbits)
{
	return __bitmap_parse(buf, buflen, 0, maskp, nmaskbits);
}

417
/**
418
 * BITMAP_FROM_U64() - Represent u64 value in the format suitable for bitmap.
419
 * @n: u64 value
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
 *
 * Linux bitmaps are internally arrays of unsigned longs, i.e. 32-bit
 * integers in 32-bit environment, and 64-bit integers in 64-bit one.
 *
 * There are four combinations of endianness and length of the word in linux
 * ABIs: LE64, BE64, LE32 and BE32.
 *
 * On 64-bit kernels 64-bit LE and BE numbers are naturally ordered in
 * bitmaps and therefore don't require any special handling.
 *
 * On 32-bit kernels 32-bit LE ABI orders lo word of 64-bit number in memory
 * prior to hi, and 32-bit BE orders hi word prior to lo. The bitmap on the
 * other hand is represented as an array of 32-bit words and the position of
 * bit N may therefore be calculated as: word #(N/32) and bit #(N%32) in that
 * word.  For example, bit #42 is located at 10th position of 2nd word.
 * It matches 32-bit LE ABI, and we can simply let the compiler store 64-bit
 * values in memory as it usually does. But for BE we need to swap hi and lo
 * words manually.
 *
 * With all that, the macro BITMAP_FROM_U64() does explicit reordering of hi and
 * lo parts of u64.  For LE32 it does nothing, and for BE environment it swaps
 * hi and lo words, as is expected by bitmap.
 */
#if __BITS_PER_LONG == 64
#define BITMAP_FROM_U64(n) (n)
#else
#define BITMAP_FROM_U64(n) ((unsigned long) ((u64)(n) & ULONG_MAX)), \
				((unsigned long) ((u64)(n) >> 32))
#endif

450
/**
451 452 453 454
 * bitmap_from_u64 - Check and swap words within u64.
 *  @mask: source bitmap
 *  @dst:  destination bitmap
 *
455
 * In 32-bit Big Endian kernel, when using ``(u32 *)(&val)[*]``
456
 * to read u64 mask, we will get the wrong word.
457
 * That is ``(u32 *)(&val)[0]`` gets the upper 32 bits,
458 459 460 461 462 463 464 465 466 467
 * but we expect the lower 32-bits of u64.
 */
static inline void bitmap_from_u64(unsigned long *dst, u64 mask)
{
	dst[0] = mask & ULONG_MAX;

	if (sizeof(mask) > sizeof(unsigned long))
		dst[1] = mask >> 32;
}

Linus Torvalds's avatar
Linus Torvalds committed
468 469 470
#endif /* __ASSEMBLY__ */

#endif /* __LINUX_BITMAP_H */