Blame view

lib/bitmap.c 36.2 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
  /*
   * lib/bitmap.c
   * Helper functions for bitmap.h.
   *
   * This source code is licensed under the GNU General Public License,
   * Version 2.  See the file COPYING for more details.
   */
8bc3bcc93   Paul Gortmaker   lib: reduce the u...
8
9
  #include <linux/export.h>
  #include <linux/thread_info.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
10
11
12
13
  #include <linux/ctype.h>
  #include <linux/errno.h>
  #include <linux/bitmap.h>
  #include <linux/bitops.h>
50af5ead3   Paul Gortmaker   bug.h: add includ...
14
  #include <linux/bug.h>
5aaba3631   Sudeep Holla   cpumask: factor o...
15
16
  
  #include <asm/page.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
  #include <asm/uaccess.h>
  
  /*
   * bitmaps provide an array of bits, implemented using an an
   * array of unsigned longs.  The number of valid bits in a
   * given bitmap does _not_ need to be an exact multiple of
   * BITS_PER_LONG.
   *
   * The possible unused bits in the last, partially used word
   * of a bitmap are 'don't care'.  The implementation makes
   * no particular effort to keep them zero.  It ensures that
   * their value will not affect the results of any operation.
   * The bitmap operations that return Boolean (bitmap_empty,
   * for example) or scalar (bitmap_weight, for example) results
   * carefully filter out these unused bits from impacting their
   * results.
   *
   * These operations actually hold to a slightly stronger rule:
   * if you don't input any bitmaps to these ops that have some
   * unused bits set, then they won't output any set unused bits
   * in output bitmaps.
   *
   * The byte ordering of bitmaps is more natural on little
   * endian architectures.  See the big-endian headers
   * include/asm-ppc64/bitops.h and include/asm-s390/bitops.h
   * for the best explanations of this ordering.
   */
0679cc483   Rasmus Villemoes   lib: bitmap: make...
44
  int __bitmap_empty(const unsigned long *bitmap, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
45
  {
0679cc483   Rasmus Villemoes   lib: bitmap: make...
46
  	unsigned int k, lim = bits/BITS_PER_LONG;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
47
48
49
50
51
52
53
54
55
56
57
  	for (k = 0; k < lim; ++k)
  		if (bitmap[k])
  			return 0;
  
  	if (bits % BITS_PER_LONG)
  		if (bitmap[k] & BITMAP_LAST_WORD_MASK(bits))
  			return 0;
  
  	return 1;
  }
  EXPORT_SYMBOL(__bitmap_empty);
8397927c8   Rasmus Villemoes   lib: bitmap: make...
58
  int __bitmap_full(const unsigned long *bitmap, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
59
  {
8397927c8   Rasmus Villemoes   lib: bitmap: make...
60
  	unsigned int k, lim = bits/BITS_PER_LONG;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
61
62
63
64
65
66
67
68
69
70
71
72
73
  	for (k = 0; k < lim; ++k)
  		if (~bitmap[k])
  			return 0;
  
  	if (bits % BITS_PER_LONG)
  		if (~bitmap[k] & BITMAP_LAST_WORD_MASK(bits))
  			return 0;
  
  	return 1;
  }
  EXPORT_SYMBOL(__bitmap_full);
  
  int __bitmap_equal(const unsigned long *bitmap1,
5e0680693   Rasmus Villemoes   lib: bitmap: make...
74
  		const unsigned long *bitmap2, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
75
  {
5e0680693   Rasmus Villemoes   lib: bitmap: make...
76
  	unsigned int k, lim = bits/BITS_PER_LONG;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
77
78
79
80
81
82
83
84
85
86
87
  	for (k = 0; k < lim; ++k)
  		if (bitmap1[k] != bitmap2[k])
  			return 0;
  
  	if (bits % BITS_PER_LONG)
  		if ((bitmap1[k] ^ bitmap2[k]) & BITMAP_LAST_WORD_MASK(bits))
  			return 0;
  
  	return 1;
  }
  EXPORT_SYMBOL(__bitmap_equal);
3d6684f4e   Rasmus Villemoes   lib: bitmap: make...
88
  void __bitmap_complement(unsigned long *dst, const unsigned long *src, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
89
  {
3d6684f4e   Rasmus Villemoes   lib: bitmap: make...
90
  	unsigned int k, lim = bits/BITS_PER_LONG;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
91
92
93
94
  	for (k = 0; k < lim; ++k)
  		dst[k] = ~src[k];
  
  	if (bits % BITS_PER_LONG)
65b4ee62c   Rasmus Villemoes   lib: bitmap: remo...
95
  		dst[k] = ~src[k];
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
96
97
  }
  EXPORT_SYMBOL(__bitmap_complement);
72fd4a35a   Robert P. J. Day   [PATCH] Numerous ...
98
  /**
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
99
   * __bitmap_shift_right - logical right shift of the bits in a bitmap
05fb6bf0b   Randy Dunlap   [PATCH] kernel-do...
100
101
102
103
   *   @dst : destination bitmap
   *   @src : source bitmap
   *   @shift : shift by this many bits
   *   @bits : bitmap size, in bits
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
   *
   * Shifting right (dividing) means moving bits in the MS -> LS bit
   * direction.  Zeros are fed into the vacated MS positions and the
   * LS bits shifted off the bottom are lost.
   */
  void __bitmap_shift_right(unsigned long *dst,
  			const unsigned long *src, int shift, int bits)
  {
  	int k, lim = BITS_TO_LONGS(bits), left = bits % BITS_PER_LONG;
  	int off = shift/BITS_PER_LONG, rem = shift % BITS_PER_LONG;
  	unsigned long mask = (1UL << left) - 1;
  	for (k = 0; off + k < lim; ++k) {
  		unsigned long upper, lower;
  
  		/*
  		 * If shift is not word aligned, take lower rem bits of
  		 * word above and make them the top rem bits of result.
  		 */
  		if (!rem || off + k + 1 >= lim)
  			upper = 0;
  		else {
  			upper = src[off + k + 1];
  			if (off + k + 1 == lim - 1 && left)
  				upper &= mask;
  		}
  		lower = src[off + k];
  		if (left && off + k == lim - 1)
  			lower &= mask;
ea5d05b34   Jan Kara   lib/bitmap.c: fix...
132
133
134
  		dst[k] = lower >> rem;
  		if (rem)
  			dst[k] |= upper << (BITS_PER_LONG - rem);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
135
136
137
138
139
140
141
  		if (left && k == lim - 1)
  			dst[k] &= mask;
  	}
  	if (off)
  		memset(&dst[lim - off], 0, off*sizeof(unsigned long));
  }
  EXPORT_SYMBOL(__bitmap_shift_right);
72fd4a35a   Robert P. J. Day   [PATCH] Numerous ...
142
  /**
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
143
   * __bitmap_shift_left - logical left shift of the bits in a bitmap
05fb6bf0b   Randy Dunlap   [PATCH] kernel-do...
144
145
146
147
   *   @dst : destination bitmap
   *   @src : source bitmap
   *   @shift : shift by this many bits
   *   @bits : bitmap size, in bits
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
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
   *
   * Shifting left (multiplying) means moving bits in the LS -> MS
   * direction.  Zeros are fed into the vacated LS bit positions
   * and those MS bits shifted off the top are lost.
   */
  
  void __bitmap_shift_left(unsigned long *dst,
  			const unsigned long *src, int shift, int bits)
  {
  	int k, lim = BITS_TO_LONGS(bits), left = bits % BITS_PER_LONG;
  	int off = shift/BITS_PER_LONG, rem = shift % BITS_PER_LONG;
  	for (k = lim - off - 1; k >= 0; --k) {
  		unsigned long upper, lower;
  
  		/*
  		 * If shift is not word aligned, take upper rem bits of
  		 * word below and make them the bottom rem bits of result.
  		 */
  		if (rem && k > 0)
  			lower = src[k - 1];
  		else
  			lower = 0;
  		upper = src[k];
  		if (left && k == lim - 1)
  			upper &= (1UL << left) - 1;
ea5d05b34   Jan Kara   lib/bitmap.c: fix...
173
174
175
  		dst[k + off] = upper << rem;
  		if (rem)
  			dst[k + off] |= lower >> (BITS_PER_LONG - rem);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
176
177
178
179
180
181
182
  		if (left && k + off == lim - 1)
  			dst[k + off] &= (1UL << left) - 1;
  	}
  	if (off)
  		memset(dst, 0, off*sizeof(unsigned long));
  }
  EXPORT_SYMBOL(__bitmap_shift_left);
f4b0373b2   Linus Torvalds   Make bitmask 'and...
183
  int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1,
2f9305eb3   Rasmus Villemoes   lib: bitmap: make...
184
  				const unsigned long *bitmap2, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
185
  {
2f9305eb3   Rasmus Villemoes   lib: bitmap: make...
186
  	unsigned int k;
7e5f97d19   Rasmus Villemoes   lib: bitmap: add ...
187
  	unsigned int lim = bits/BITS_PER_LONG;
f4b0373b2   Linus Torvalds   Make bitmask 'and...
188
  	unsigned long result = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
189

7e5f97d19   Rasmus Villemoes   lib: bitmap: add ...
190
  	for (k = 0; k < lim; k++)
f4b0373b2   Linus Torvalds   Make bitmask 'and...
191
  		result |= (dst[k] = bitmap1[k] & bitmap2[k]);
7e5f97d19   Rasmus Villemoes   lib: bitmap: add ...
192
193
194
  	if (bits % BITS_PER_LONG)
  		result |= (dst[k] = bitmap1[k] & bitmap2[k] &
  			   BITMAP_LAST_WORD_MASK(bits));
f4b0373b2   Linus Torvalds   Make bitmask 'and...
195
  	return result != 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
196
197
198
199
  }
  EXPORT_SYMBOL(__bitmap_and);
  
  void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1,
2f9305eb3   Rasmus Villemoes   lib: bitmap: make...
200
  				const unsigned long *bitmap2, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
201
  {
2f9305eb3   Rasmus Villemoes   lib: bitmap: make...
202
203
  	unsigned int k;
  	unsigned int nr = BITS_TO_LONGS(bits);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
204
205
206
207
208
209
210
  
  	for (k = 0; k < nr; k++)
  		dst[k] = bitmap1[k] | bitmap2[k];
  }
  EXPORT_SYMBOL(__bitmap_or);
  
  void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1,
2f9305eb3   Rasmus Villemoes   lib: bitmap: make...
211
  				const unsigned long *bitmap2, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
212
  {
2f9305eb3   Rasmus Villemoes   lib: bitmap: make...
213
214
  	unsigned int k;
  	unsigned int nr = BITS_TO_LONGS(bits);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
215
216
217
218
219
  
  	for (k = 0; k < nr; k++)
  		dst[k] = bitmap1[k] ^ bitmap2[k];
  }
  EXPORT_SYMBOL(__bitmap_xor);
f4b0373b2   Linus Torvalds   Make bitmask 'and...
220
  int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1,
2f9305eb3   Rasmus Villemoes   lib: bitmap: make...
221
  				const unsigned long *bitmap2, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
222
  {
2f9305eb3   Rasmus Villemoes   lib: bitmap: make...
223
  	unsigned int k;
74e765319   Rasmus Villemoes   lib: bitmap: add ...
224
  	unsigned int lim = bits/BITS_PER_LONG;
f4b0373b2   Linus Torvalds   Make bitmask 'and...
225
  	unsigned long result = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
226

74e765319   Rasmus Villemoes   lib: bitmap: add ...
227
  	for (k = 0; k < lim; k++)
f4b0373b2   Linus Torvalds   Make bitmask 'and...
228
  		result |= (dst[k] = bitmap1[k] & ~bitmap2[k]);
74e765319   Rasmus Villemoes   lib: bitmap: add ...
229
230
231
  	if (bits % BITS_PER_LONG)
  		result |= (dst[k] = bitmap1[k] & ~bitmap2[k] &
  			   BITMAP_LAST_WORD_MASK(bits));
f4b0373b2   Linus Torvalds   Make bitmask 'and...
232
  	return result != 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
233
234
235
236
  }
  EXPORT_SYMBOL(__bitmap_andnot);
  
  int __bitmap_intersects(const unsigned long *bitmap1,
6dfe9799c   Rasmus Villemoes   lib: bitmap: make...
237
  			const unsigned long *bitmap2, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
238
  {
6dfe9799c   Rasmus Villemoes   lib: bitmap: make...
239
  	unsigned int k, lim = bits/BITS_PER_LONG;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
240
241
242
243
244
245
246
247
248
249
250
251
  	for (k = 0; k < lim; ++k)
  		if (bitmap1[k] & bitmap2[k])
  			return 1;
  
  	if (bits % BITS_PER_LONG)
  		if ((bitmap1[k] & bitmap2[k]) & BITMAP_LAST_WORD_MASK(bits))
  			return 1;
  	return 0;
  }
  EXPORT_SYMBOL(__bitmap_intersects);
  
  int __bitmap_subset(const unsigned long *bitmap1,
5be20213e   Rasmus Villemoes   lib: bitmap: make...
252
  		    const unsigned long *bitmap2, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
253
  {
5be20213e   Rasmus Villemoes   lib: bitmap: make...
254
  	unsigned int k, lim = bits/BITS_PER_LONG;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
255
256
257
258
259
260
261
262
263
264
  	for (k = 0; k < lim; ++k)
  		if (bitmap1[k] & ~bitmap2[k])
  			return 0;
  
  	if (bits % BITS_PER_LONG)
  		if ((bitmap1[k] & ~bitmap2[k]) & BITMAP_LAST_WORD_MASK(bits))
  			return 0;
  	return 1;
  }
  EXPORT_SYMBOL(__bitmap_subset);
877d9f3b6   Rasmus Villemoes   lib: bitmap: make...
265
  int __bitmap_weight(const unsigned long *bitmap, unsigned int bits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
266
  {
877d9f3b6   Rasmus Villemoes   lib: bitmap: make...
267
268
  	unsigned int k, lim = bits/BITS_PER_LONG;
  	int w = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
269
270
  
  	for (k = 0; k < lim; k++)
37d54111c   Akinobu Mita   [PATCH] bitops: h...
271
  		w += hweight_long(bitmap[k]);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
272
273
  
  	if (bits % BITS_PER_LONG)
37d54111c   Akinobu Mita   [PATCH] bitops: h...
274
  		w += hweight_long(bitmap[k] & BITMAP_LAST_WORD_MASK(bits));
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
275
276
277
  
  	return w;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
278
  EXPORT_SYMBOL(__bitmap_weight);
fb5ac5426   Rasmus Villemoes   lib: bitmap: make...
279
  void bitmap_set(unsigned long *map, unsigned int start, int len)
c1a2a962a   Akinobu Mita   bitmap: introduce...
280
281
  {
  	unsigned long *p = map + BIT_WORD(start);
fb5ac5426   Rasmus Villemoes   lib: bitmap: make...
282
  	const unsigned int size = start + len;
c1a2a962a   Akinobu Mita   bitmap: introduce...
283
284
  	int bits_to_set = BITS_PER_LONG - (start % BITS_PER_LONG);
  	unsigned long mask_to_set = BITMAP_FIRST_WORD_MASK(start);
fb5ac5426   Rasmus Villemoes   lib: bitmap: make...
285
  	while (len - bits_to_set >= 0) {
c1a2a962a   Akinobu Mita   bitmap: introduce...
286
  		*p |= mask_to_set;
fb5ac5426   Rasmus Villemoes   lib: bitmap: make...
287
  		len -= bits_to_set;
c1a2a962a   Akinobu Mita   bitmap: introduce...
288
289
290
291
  		bits_to_set = BITS_PER_LONG;
  		mask_to_set = ~0UL;
  		p++;
  	}
fb5ac5426   Rasmus Villemoes   lib: bitmap: make...
292
  	if (len) {
c1a2a962a   Akinobu Mita   bitmap: introduce...
293
294
295
296
297
  		mask_to_set &= BITMAP_LAST_WORD_MASK(size);
  		*p |= mask_to_set;
  	}
  }
  EXPORT_SYMBOL(bitmap_set);
154f5e38f   Rasmus Villemoes   lib: bitmap: make...
298
  void bitmap_clear(unsigned long *map, unsigned int start, int len)
c1a2a962a   Akinobu Mita   bitmap: introduce...
299
300
  {
  	unsigned long *p = map + BIT_WORD(start);
154f5e38f   Rasmus Villemoes   lib: bitmap: make...
301
  	const unsigned int size = start + len;
c1a2a962a   Akinobu Mita   bitmap: introduce...
302
303
  	int bits_to_clear = BITS_PER_LONG - (start % BITS_PER_LONG);
  	unsigned long mask_to_clear = BITMAP_FIRST_WORD_MASK(start);
154f5e38f   Rasmus Villemoes   lib: bitmap: make...
304
  	while (len - bits_to_clear >= 0) {
c1a2a962a   Akinobu Mita   bitmap: introduce...
305
  		*p &= ~mask_to_clear;
154f5e38f   Rasmus Villemoes   lib: bitmap: make...
306
  		len -= bits_to_clear;
c1a2a962a   Akinobu Mita   bitmap: introduce...
307
308
309
310
  		bits_to_clear = BITS_PER_LONG;
  		mask_to_clear = ~0UL;
  		p++;
  	}
154f5e38f   Rasmus Villemoes   lib: bitmap: make...
311
  	if (len) {
c1a2a962a   Akinobu Mita   bitmap: introduce...
312
313
314
315
316
  		mask_to_clear &= BITMAP_LAST_WORD_MASK(size);
  		*p &= ~mask_to_clear;
  	}
  }
  EXPORT_SYMBOL(bitmap_clear);
5e19b013f   Michal Nazarewicz   lib: bitmap: add ...
317
318
  /**
   * bitmap_find_next_zero_area_off - find a contiguous aligned zero area
c1a2a962a   Akinobu Mita   bitmap: introduce...
319
320
321
322
323
   * @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
5e19b013f   Michal Nazarewicz   lib: bitmap: add ...
324
   * @align_offset: Alignment offset for zero area.
c1a2a962a   Akinobu Mita   bitmap: introduce...
325
326
   *
   * The @align_mask should be one less than a power of 2; the effect is that
5e19b013f   Michal Nazarewicz   lib: bitmap: add ...
327
328
   * the bit offset of all zero areas this function finds plus @align_offset
   * is multiple of that power of 2.
c1a2a962a   Akinobu Mita   bitmap: introduce...
329
   */
5e19b013f   Michal Nazarewicz   lib: bitmap: add ...
330
331
332
333
334
335
  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)
c1a2a962a   Akinobu Mita   bitmap: introduce...
336
337
338
339
340
341
  {
  	unsigned long index, end, i;
  again:
  	index = find_next_zero_bit(map, size, start);
  
  	/* Align allocation */
5e19b013f   Michal Nazarewicz   lib: bitmap: add ...
342
  	index = __ALIGN_MASK(index + align_offset, align_mask) - align_offset;
c1a2a962a   Akinobu Mita   bitmap: introduce...
343
344
345
346
347
348
349
350
351
352
353
  
  	end = index + nr;
  	if (end > size)
  		return end;
  	i = find_next_bit(map, end, index);
  	if (i < end) {
  		start = i + 1;
  		goto again;
  	}
  	return index;
  }
5e19b013f   Michal Nazarewicz   lib: bitmap: add ...
354
  EXPORT_SYMBOL(bitmap_find_next_zero_area_off);
c1a2a962a   Akinobu Mita   bitmap: introduce...
355

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
356
  /*
6d49e352a   Nadia Yvette Chambers   propagate name ch...
357
   * Bitmap printing & parsing functions: first version by Nadia Yvette Chambers,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
358
359
360
361
362
   * second version by Paul Jackson, third by Joe Korty.
   */
  
  #define CHUNKSZ				32
  #define nbits_to_hold_value(val)	fls(val)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
363
364
365
366
367
368
369
370
371
372
  #define BASEDEC 10		/* fancier cpuset lists input in decimal */
  
  /**
   * bitmap_scnprintf - convert bitmap to an ASCII hex string.
   * @buf: byte buffer into which string is placed
   * @buflen: reserved size of @buf, in bytes
   * @maskp: pointer to bitmap to convert
   * @nmaskbits: size of bitmap, in bits
   *
   * Exactly @nmaskbits bits are displayed.  Hex digits are grouped into
05a6c8a92   Andrew Morton   lib/bitmap.c: fix...
373
374
   * comma-separated sets of eight digits per set.  Returns the number of
   * characters which were written to *buf, excluding the trailing \0.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
375
376
377
378
379
380
381
382
383
384
385
386
387
   */
  int bitmap_scnprintf(char *buf, unsigned int buflen,
  	const unsigned long *maskp, int nmaskbits)
  {
  	int i, word, bit, len = 0;
  	unsigned long val;
  	const char *sep = "";
  	int chunksz;
  	u32 chunkmask;
  
  	chunksz = nmaskbits & (CHUNKSZ - 1);
  	if (chunksz == 0)
  		chunksz = CHUNKSZ;
8c0e33c13   Nick Wilson   [PATCH] Use ALIGN...
388
  	i = ALIGN(nmaskbits, CHUNKSZ) - CHUNKSZ;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
  	for (; i >= 0; i -= CHUNKSZ) {
  		chunkmask = ((1ULL << chunksz) - 1);
  		word = i / BITS_PER_LONG;
  		bit = i % BITS_PER_LONG;
  		val = (maskp[word] >> bit) & chunkmask;
  		len += scnprintf(buf+len, buflen-len, "%s%0*lx", sep,
  			(chunksz+3)/4, val);
  		chunksz = CHUNKSZ;
  		sep = ",";
  	}
  	return len;
  }
  EXPORT_SYMBOL(bitmap_scnprintf);
  
  /**
01a3ee2b2   Reinette Chatre   [PATCH] bitmap: p...
404
405
406
   * __bitmap_parse - convert an ASCII hex string into a bitmap.
   * @buf: pointer to buffer containing string.
   * @buflen: buffer size in bytes.  If string is smaller than this
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
407
   *    then it must be terminated with a \0.
01a3ee2b2   Reinette Chatre   [PATCH] bitmap: p...
408
   * @is_user: location of buffer, 0 indicates kernel space
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
409
410
411
412
413
   * @maskp: pointer to bitmap array that will contain result.
   * @nmaskbits: size of bitmap, in bits.
   *
   * Commas group hex digits into chunks.  Each chunk defines exactly 32
   * bits of the resultant bitmask.  No chunk may specify a value larger
6e1907ffd   Randy Dunlap   [PATCH] kernel-do...
414
415
   * than 32 bits (%-EOVERFLOW), and if a chunk specifies a smaller value
   * then leading 0-bits are prepended.  %-EINVAL is returned for illegal
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
416
417
418
   * characters and for grouping errors such as "1,,5", ",44", "," and "".
   * Leading and trailing whitespace accepted, but not embedded whitespace.
   */
01a3ee2b2   Reinette Chatre   [PATCH] bitmap: p...
419
420
421
  int __bitmap_parse(const char *buf, unsigned int buflen,
  		int is_user, unsigned long *maskp,
  		int nmaskbits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
422
423
424
  {
  	int c, old_c, totaldigits, ndigits, nchunks, nbits;
  	u32 chunk;
b9c321fd8   H Hartley Sweeten   lib/bitmap.c: qui...
425
  	const char __user __force *ubuf = (const char __user __force *)buf;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
426
427
428
429
430
431
432
433
  
  	bitmap_zero(maskp, nmaskbits);
  
  	nchunks = nbits = totaldigits = c = 0;
  	do {
  		chunk = ndigits = 0;
  
  		/* Get the next chunk of the bitmap */
01a3ee2b2   Reinette Chatre   [PATCH] bitmap: p...
434
  		while (buflen) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
435
  			old_c = c;
01a3ee2b2   Reinette Chatre   [PATCH] bitmap: p...
436
437
438
439
440
441
442
  			if (is_user) {
  				if (__get_user(c, ubuf++))
  					return -EFAULT;
  			}
  			else
  				c = *buf++;
  			buflen--;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
  			if (isspace(c))
  				continue;
  
  			/*
  			 * If the last character was a space and the current
  			 * character isn't '\0', we've got embedded whitespace.
  			 * This is a no-no, so throw an error.
  			 */
  			if (totaldigits && c && isspace(old_c))
  				return -EINVAL;
  
  			/* A '\0' or a ',' signal the end of the chunk */
  			if (c == '\0' || c == ',')
  				break;
  
  			if (!isxdigit(c))
  				return -EINVAL;
  
  			/*
  			 * Make sure there are at least 4 free bits in 'chunk'.
  			 * If not, this hexdigit will overflow 'chunk', so
  			 * throw an error.
  			 */
  			if (chunk & ~((1UL << (CHUNKSZ - 4)) - 1))
  				return -EOVERFLOW;
66f1991bc   Andy Shevchenko   lib/bitmap.c: use...
468
  			chunk = (chunk << 4) | hex_to_bin(c);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
469
470
471
472
473
474
475
476
477
478
479
480
481
  			ndigits++; totaldigits++;
  		}
  		if (ndigits == 0)
  			return -EINVAL;
  		if (nchunks == 0 && chunk == 0)
  			continue;
  
  		__bitmap_shift_left(maskp, maskp, CHUNKSZ, nmaskbits);
  		*maskp |= chunk;
  		nchunks++;
  		nbits += (nchunks == 1) ? nbits_to_hold_value(chunk) : CHUNKSZ;
  		if (nbits > nmaskbits)
  			return -EOVERFLOW;
01a3ee2b2   Reinette Chatre   [PATCH] bitmap: p...
482
  	} while (buflen && c == ',');
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
483
484
485
  
  	return 0;
  }
01a3ee2b2   Reinette Chatre   [PATCH] bitmap: p...
486
487
488
  EXPORT_SYMBOL(__bitmap_parse);
  
  /**
9a86e2bad   Ben Hutchings   lib: fix first li...
489
   * bitmap_parse_user - convert an ASCII hex string in a user buffer into a bitmap
01a3ee2b2   Reinette Chatre   [PATCH] bitmap: p...
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
   *
   * @ubuf: pointer to user buffer containing string.
   * @ulen: buffer size in bytes.  If string is smaller than this
   *    then it must be terminated with a \0.
   * @maskp: pointer to bitmap array that will contain result.
   * @nmaskbits: size of bitmap, in bits.
   *
   * Wrapper for __bitmap_parse(), providing it with user buffer.
   *
   * We cannot have this as an inline function in bitmap.h because it needs
   * linux/uaccess.h to get the access_ok() declaration and this causes
   * cyclic dependencies.
   */
  int bitmap_parse_user(const char __user *ubuf,
  			unsigned int ulen, unsigned long *maskp,
  			int nmaskbits)
  {
  	if (!access_ok(VERIFY_READ, ubuf, ulen))
  		return -EFAULT;
b9c321fd8   H Hartley Sweeten   lib/bitmap.c: qui...
509
510
  	return __bitmap_parse((const char __force *)ubuf,
  				ulen, 1, maskp, nmaskbits);
01a3ee2b2   Reinette Chatre   [PATCH] bitmap: p...
511
512
  }
  EXPORT_SYMBOL(bitmap_parse_user);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
513
514
515
516
517
518
  
  /*
   * bscnl_emit(buf, buflen, rbot, rtop, bp)
   *
   * Helper routine for bitmap_scnlistprintf().  Write decimal number
   * or range to buf, suppressing output past buf+buflen, with optional
05a6c8a92   Andrew Morton   lib/bitmap.c: fix...
519
520
   * comma-prefix.  Return len of what was written to *buf, excluding the
   * trailing \0.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
   */
  static inline int bscnl_emit(char *buf, int buflen, int rbot, int rtop, int len)
  {
  	if (len > 0)
  		len += scnprintf(buf + len, buflen - len, ",");
  	if (rbot == rtop)
  		len += scnprintf(buf + len, buflen - len, "%d", rbot);
  	else
  		len += scnprintf(buf + len, buflen - len, "%d-%d", rbot, rtop);
  	return len;
  }
  
  /**
   * bitmap_scnlistprintf - convert bitmap to list format ASCII string
   * @buf: byte buffer into which string is placed
   * @buflen: reserved size of @buf, in bytes
   * @maskp: pointer to bitmap to convert
   * @nmaskbits: size of bitmap, in bits
   *
   * Output format is a comma-separated list of decimal numbers and
   * ranges.  Consecutively set bits are shown as two hyphen-separated
   * decimal numbers, the smallest and largest bit numbers set in
   * the range.  Output format is compatible with the format
   * accepted as input by bitmap_parselist().
   *
05a6c8a92   Andrew Morton   lib/bitmap.c: fix...
546
547
   * The return value is the number of characters which were written to *buf
   * excluding the trailing '\0', as per ISO C99's scnprintf.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
548
549
550
551
552
553
554
   */
  int bitmap_scnlistprintf(char *buf, unsigned int buflen,
  	const unsigned long *maskp, int nmaskbits)
  {
  	int len = 0;
  	/* current bit is 'cur', most recently seen range is [rbot, rtop] */
  	int cur, rbot, rtop;
0b030c2c2   Andi Kleen   Fix bitmap_scnlis...
555
556
557
  	if (buflen == 0)
  		return 0;
  	buf[0] = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
558
559
560
561
562
563
564
565
566
567
568
569
570
571
  	rbot = cur = find_first_bit(maskp, nmaskbits);
  	while (cur < nmaskbits) {
  		rtop = cur;
  		cur = find_next_bit(maskp, nmaskbits, cur+1);
  		if (cur >= nmaskbits || cur > rtop + 1) {
  			len = bscnl_emit(buf, buflen, rbot, rtop, len);
  			rbot = cur;
  		}
  	}
  	return len;
  }
  EXPORT_SYMBOL(bitmap_scnlistprintf);
  
  /**
5aaba3631   Sudeep Holla   cpumask: factor o...
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
   * bitmap_print_to_pagebuf - convert bitmap to list or hex format ASCII string
   * @list: indicates whether the bitmap must be list
   * @buf: page aligned buffer into which string is placed
   * @maskp: pointer to bitmap to convert
   * @nmaskbits: size of bitmap, in bits
   *
   * Output format is a comma-separated list of decimal numbers and
   * ranges if list is specified or hex digits grouped into comma-separated
   * sets of 8 digits/set. Returns the number of characters written to buf.
   */
  int bitmap_print_to_pagebuf(bool list, char *buf, const unsigned long *maskp,
  			    int nmaskbits)
  {
  	ptrdiff_t len = PTR_ALIGN(buf + PAGE_SIZE - 1, PAGE_SIZE) - buf - 2;
  	int n = 0;
  
  	if (len > 1) {
  		n = list ? bitmap_scnlistprintf(buf, len, maskp, nmaskbits) :
  			   bitmap_scnprintf(buf, len, maskp, nmaskbits);
  		buf[n++] = '
  ';
  		buf[n] = '\0';
  	}
  	return n;
  }
  EXPORT_SYMBOL(bitmap_print_to_pagebuf);
  
  /**
4b060420a   Mike Travis   bitmap, irq: add ...
600
   * __bitmap_parselist - convert list format ASCII string to bitmap
b0825ee3a   Randy Dunlap   lib/bitmap.c: fix...
601
   * @buf: read nul-terminated user string from this buffer
4b060420a   Mike Travis   bitmap, irq: add ...
602
603
604
   * @buflen: buffer size in bytes.  If string is smaller than this
   *    then it must be terminated with a \0.
   * @is_user: location of buffer, 0 indicates kernel space
6e1907ffd   Randy Dunlap   [PATCH] kernel-do...
605
   * @maskp: write resulting mask here
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
606
607
608
609
610
611
612
   * @nmaskbits: number of bits in mask to be written
   *
   * Input format is a comma-separated list of decimal numbers and
   * ranges.  Consecutively set bits are shown as two hyphen-separated
   * decimal numbers, the smallest and largest bit numbers set in
   * the range.
   *
6e1907ffd   Randy Dunlap   [PATCH] kernel-do...
613
614
615
616
617
   * Returns 0 on success, -errno on invalid input strings.
   * Error values:
   *    %-EINVAL: second number in range smaller than first
   *    %-EINVAL: invalid character in string
   *    %-ERANGE: bit number specified too large for mask
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
618
   */
4b060420a   Mike Travis   bitmap, irq: add ...
619
620
621
  static int __bitmap_parselist(const char *buf, unsigned int buflen,
  		int is_user, unsigned long *maskp,
  		int nmaskbits)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
622
623
  {
  	unsigned a, b;
4b060420a   Mike Travis   bitmap, irq: add ...
624
  	int c, old_c, totaldigits;
b9c321fd8   H Hartley Sweeten   lib/bitmap.c: qui...
625
  	const char __user __force *ubuf = (const char __user __force *)buf;
4b060420a   Mike Travis   bitmap, irq: add ...
626
  	int exp_digit, in_range;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
627

4b060420a   Mike Travis   bitmap, irq: add ...
628
  	totaldigits = c = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
629
630
  	bitmap_zero(maskp, nmaskbits);
  	do {
4b060420a   Mike Travis   bitmap, irq: add ...
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
  		exp_digit = 1;
  		in_range = 0;
  		a = b = 0;
  
  		/* Get the next cpu# or a range of cpu#'s */
  		while (buflen) {
  			old_c = c;
  			if (is_user) {
  				if (__get_user(c, ubuf++))
  					return -EFAULT;
  			} else
  				c = *buf++;
  			buflen--;
  			if (isspace(c))
  				continue;
  
  			/*
  			 * If the last character was a space and the current
  			 * character isn't '\0', we've got embedded whitespace.
  			 * This is a no-no, so throw an error.
  			 */
  			if (totaldigits && c && isspace(old_c))
  				return -EINVAL;
  
  			/* A '\0' or a ',' signal the end of a cpu# or range */
  			if (c == '\0' || c == ',')
  				break;
  
  			if (c == '-') {
  				if (exp_digit || in_range)
  					return -EINVAL;
  				b = 0;
  				in_range = 1;
  				exp_digit = 1;
  				continue;
  			}
  
  			if (!isdigit(c))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
669
  				return -EINVAL;
4b060420a   Mike Travis   bitmap, irq: add ...
670
671
672
673
674
675
  
  			b = b * 10 + (c - '0');
  			if (!in_range)
  				a = b;
  			exp_digit = 0;
  			totaldigits++;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
676
677
678
679
680
681
682
683
684
  		}
  		if (!(a <= b))
  			return -EINVAL;
  		if (b >= nmaskbits)
  			return -ERANGE;
  		while (a <= b) {
  			set_bit(a, maskp);
  			a++;
  		}
4b060420a   Mike Travis   bitmap, irq: add ...
685
  	} while (buflen && c == ',');
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
686
687
  	return 0;
  }
4b060420a   Mike Travis   bitmap, irq: add ...
688
689
690
  
  int bitmap_parselist(const char *bp, unsigned long *maskp, int nmaskbits)
  {
bc5be1828   Rasmus Villemoes   lib: bitmap: simp...
691
692
693
  	char *nl  = strchrnul(bp, '
  ');
  	int len = nl - bp;
4b060420a   Mike Travis   bitmap, irq: add ...
694
695
696
  
  	return __bitmap_parselist(bp, len, 0, maskp, nmaskbits);
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
697
  EXPORT_SYMBOL(bitmap_parselist);
4b060420a   Mike Travis   bitmap, irq: add ...
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
  
  /**
   * bitmap_parselist_user()
   *
   * @ubuf: pointer to user buffer containing string.
   * @ulen: buffer size in bytes.  If string is smaller than this
   *    then it must be terminated with a \0.
   * @maskp: pointer to bitmap array that will contain result.
   * @nmaskbits: size of bitmap, in bits.
   *
   * Wrapper for bitmap_parselist(), providing it with user buffer.
   *
   * We cannot have this as an inline function in bitmap.h because it needs
   * linux/uaccess.h to get the access_ok() declaration and this causes
   * cyclic dependencies.
   */
  int bitmap_parselist_user(const char __user *ubuf,
  			unsigned int ulen, unsigned long *maskp,
  			int nmaskbits)
  {
  	if (!access_ok(VERIFY_READ, ubuf, ulen))
  		return -EFAULT;
b9c321fd8   H Hartley Sweeten   lib/bitmap.c: qui...
720
  	return __bitmap_parselist((const char __force *)ubuf,
4b060420a   Mike Travis   bitmap, irq: add ...
721
722
723
  					ulen, 1, maskp, nmaskbits);
  }
  EXPORT_SYMBOL(bitmap_parselist_user);
72fd4a35a   Robert P. J. Day   [PATCH] Numerous ...
724
  /**
9a86e2bad   Ben Hutchings   lib: fix first li...
725
   * bitmap_pos_to_ord - find ordinal of set bit at given position in bitmap
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
726
727
728
729
730
731
   *	@buf: pointer to a bitmap
   *	@pos: a bit position in @buf (0 <= @pos < @bits)
   *	@bits: number of valid bit positions in @buf
   *
   * Map the bit at position @pos in @buf (of length @bits) to the
   * ordinal of which set bit it is.  If it is not set or if @pos
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
732
   * is not a valid bit position, map to -1.
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
733
734
735
   *
   * If for example, just bits 4 through 7 are set in @buf, then @pos
   * values 4 through 7 will get mapped to 0 through 3, respectively,
a85517487   Rasmus Villemoes   lib: bitmap: fix ...
736
   * and other @pos values will get mapped to -1.  When @pos value 7
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
737
738
739
740
741
742
743
   * gets mapped to (returns) @ord value 3 in this example, that means
   * that bit 7 is the 3rd (starting with 0th) set bit in @buf.
   *
   * The bit positions 0 through @bits are valid positions in @buf.
   */
  static int bitmap_pos_to_ord(const unsigned long *buf, int pos, int bits)
  {
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
744
  	int i, ord;
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
745

96b7f3414   Paul Jackson   [PATCH] cpuset: b...
746
747
  	if (pos < 0 || pos >= bits || !test_bit(pos, buf))
  		return -1;
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
748

96b7f3414   Paul Jackson   [PATCH] cpuset: b...
749
750
751
752
753
  	i = find_first_bit(buf, bits);
  	ord = 0;
  	while (i < pos) {
  		i = find_next_bit(buf, bits, i + 1);
  	     	ord++;
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
754
  	}
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
755
  	BUG_ON(i != pos);
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
756
757
758
759
  	return ord;
  }
  
  /**
9a86e2bad   Ben Hutchings   lib: fix first li...
760
   * bitmap_ord_to_pos - find position of n-th set bit in bitmap
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
761
762
763
764
765
   *	@buf: pointer to bitmap
   *	@ord: ordinal bit position (n-th set bit, n >= 0)
   *	@bits: number of valid bit positions in @buf
   *
   * Map the ordinal offset of bit @ord in @buf to its position in @buf.
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
766
767
   * Value of @ord should be in range 0 <= @ord < weight(buf), else
   * results are undefined.
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
768
769
770
   *
   * If for example, just bits 4 through 7 are set in @buf, then @ord
   * values 0 through 3 will get mapped to 4 through 7, respectively,
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
771
   * and all other @ord values return undefined values.  When @ord value 3
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
772
773
774
775
776
   * gets mapped to (returns) @pos value 7 in this example, that means
   * that the 3rd set bit (starting with 0th) is at position 7 in @buf.
   *
   * The bit positions 0 through @bits are valid positions in @buf.
   */
778d3b0ff   Michal Hocko   cpusets: randomiz...
777
  int bitmap_ord_to_pos(const unsigned long *buf, int ord, int bits)
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
  {
  	int pos = 0;
  
  	if (ord >= 0 && ord < bits) {
  		int i;
  
  		for (i = find_first_bit(buf, bits);
  		     i < bits && ord > 0;
  		     i = find_next_bit(buf, bits, i + 1))
  	     		ord--;
  		if (i < bits && ord == 0)
  			pos = i;
  	}
  
  	return pos;
  }
  
  /**
   * bitmap_remap - Apply map defined by a pair of bitmaps to another bitmap
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
797
   *	@dst: remapped result
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
798
   *	@src: subset to be remapped
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
799
800
801
802
803
804
805
806
807
808
809
   *	@old: defines domain of map
   *	@new: defines range of map
   *	@bits: number of bits in each of these bitmaps
   *
   * Let @old and @new define a mapping of bit positions, such that
   * whatever position is held by the n-th set bit in @old is mapped
   * to the n-th set bit in @new.  In the more general case, allowing
   * for the possibility that the weight 'w' of @new is less than the
   * weight of @old, map the position of the n-th set bit in @old to
   * the position of the m-th set bit in @new, where m == n % w.
   *
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
810
811
812
   * If either of the @old and @new bitmaps are empty, or if @src and
   * @dst point to the same location, then this routine copies @src
   * to @dst.
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
813
   *
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
814
815
   * The positions of unset bits in @old are mapped to themselves
   * (the identify map).
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
816
817
818
819
   *
   * Apply the above specified mapping to @src, placing the result in
   * @dst, clearing any bits previously set in @dst.
   *
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
820
821
822
   * For example, lets say that @old has bits 4 through 7 set, and
   * @new has bits 12 through 15 set.  This defines the mapping of bit
   * position 4 to 12, 5 to 13, 6 to 14 and 7 to 15, and of all other
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
823
824
825
   * bit positions unchanged.  So if say @src comes into this routine
   * with bits 1, 5 and 7 set, then @dst should leave with bits 1,
   * 13 and 15 set.
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
826
827
828
829
830
   */
  void bitmap_remap(unsigned long *dst, const unsigned long *src,
  		const unsigned long *old, const unsigned long *new,
  		int bits)
  {
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
831
  	int oldbit, w;
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
832

fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
833
834
  	if (dst == src)		/* following doesn't handle inplace remaps */
  		return;
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
835
  	bitmap_zero(dst, bits);
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
836
837
  
  	w = bitmap_weight(new, bits);
08564fb7a   Akinobu Mita   bitmap: use for_e...
838
  	for_each_set_bit(oldbit, src, bits) {
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
839
  	     	int n = bitmap_pos_to_ord(old, oldbit, bits);
08564fb7a   Akinobu Mita   bitmap: use for_e...
840

96b7f3414   Paul Jackson   [PATCH] cpuset: b...
841
842
843
844
  		if (n < 0 || w == 0)
  			set_bit(oldbit, dst);	/* identity map */
  		else
  			set_bit(bitmap_ord_to_pos(new, n % w, bits), dst);
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
845
846
847
848
849
850
  	}
  }
  EXPORT_SYMBOL(bitmap_remap);
  
  /**
   * bitmap_bitremap - Apply map defined by a pair of bitmaps to a single bit
6e1907ffd   Randy Dunlap   [PATCH] kernel-do...
851
852
853
854
   *	@oldbit: bit position to be mapped
   *	@old: defines domain of map
   *	@new: defines range of map
   *	@bits: number of bits in each of these bitmaps
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
855
856
857
858
859
860
861
862
   *
   * Let @old and @new define a mapping of bit positions, such that
   * whatever position is held by the n-th set bit in @old is mapped
   * to the n-th set bit in @new.  In the more general case, allowing
   * for the possibility that the weight 'w' of @new is less than the
   * weight of @old, map the position of the n-th set bit in @old to
   * the position of the m-th set bit in @new, where m == n % w.
   *
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
863
864
   * The positions of unset bits in @old are mapped to themselves
   * (the identify map).
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
865
866
867
868
869
870
871
   *
   * Apply the above specified mapping to bit position @oldbit, returning
   * the new bit position.
   *
   * For example, lets say that @old has bits 4 through 7 set, and
   * @new has bits 12 through 15 set.  This defines the mapping of bit
   * position 4 to 12, 5 to 13, 6 to 14 and 7 to 15, and of all other
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
872
873
   * bit positions unchanged.  So if say @oldbit is 5, then this routine
   * returns 13.
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
874
875
876
877
   */
  int bitmap_bitremap(int oldbit, const unsigned long *old,
  				const unsigned long *new, int bits)
  {
96b7f3414   Paul Jackson   [PATCH] cpuset: b...
878
879
880
881
882
883
  	int w = bitmap_weight(new, bits);
  	int n = bitmap_pos_to_ord(old, oldbit, bits);
  	if (n < 0 || w == 0)
  		return oldbit;
  	else
  		return bitmap_ord_to_pos(new, n % w, bits);
fb5eeeee4   Paul Jackson   [PATCH] cpusets: ...
884
885
  }
  EXPORT_SYMBOL(bitmap_bitremap);
7ea931c9f   Paul Jackson   mempolicy: add bi...
886
887
888
889
890
891
892
893
894
895
896
897
898
899
  /**
   * bitmap_onto - translate one bitmap relative to another
   *	@dst: resulting translated bitmap
   * 	@orig: original untranslated bitmap
   * 	@relmap: bitmap relative to which translated
   *	@bits: number of bits in each of these bitmaps
   *
   * Set the n-th bit of @dst iff there exists some m such that the
   * n-th bit of @relmap is set, the m-th bit of @orig is set, and
   * the n-th bit of @relmap is also the m-th _set_ bit of @relmap.
   * (If you understood the previous sentence the first time your
   * read it, you're overqualified for your current job.)
   *
   * In other words, @orig is mapped onto (surjectively) @dst,
da3dae54e   Masanari Iida   Documentation: Do...
900
   * using the map { <n, m> | the n-th bit of @relmap is the
7ea931c9f   Paul Jackson   mempolicy: add bi...
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
   * m-th set bit of @relmap }.
   *
   * Any set bits in @orig above bit number W, where W is the
   * weight of (number of set bits in) @relmap are mapped nowhere.
   * In particular, if for all bits m set in @orig, m >= W, then
   * @dst will end up empty.  In situations where the possibility
   * of such an empty result is not desired, one way to avoid it is
   * to use the bitmap_fold() operator, below, to first fold the
   * @orig bitmap over itself so that all its set bits x are in the
   * range 0 <= x < W.  The bitmap_fold() operator does this by
   * setting the bit (m % W) in @dst, for each bit (m) set in @orig.
   *
   * Example [1] for bitmap_onto():
   *  Let's say @relmap has bits 30-39 set, and @orig has bits
   *  1, 3, 5, 7, 9 and 11 set.  Then on return from this routine,
   *  @dst will have bits 31, 33, 35, 37 and 39 set.
   *
   *  When bit 0 is set in @orig, it means turn on the bit in
   *  @dst corresponding to whatever is the first bit (if any)
   *  that is turned on in @relmap.  Since bit 0 was off in the
   *  above example, we leave off that bit (bit 30) in @dst.
   *
   *  When bit 1 is set in @orig (as in the above example), it
   *  means turn on the bit in @dst corresponding to whatever
   *  is the second bit that is turned on in @relmap.  The second
   *  bit in @relmap that was turned on in the above example was
   *  bit 31, so we turned on bit 31 in @dst.
   *
   *  Similarly, we turned on bits 33, 35, 37 and 39 in @dst,
   *  because they were the 4th, 6th, 8th and 10th set bits
   *  set in @relmap, and the 4th, 6th, 8th and 10th bits of
   *  @orig (i.e. bits 3, 5, 7 and 9) were also set.
   *
   *  When bit 11 is set in @orig, it means turn on the bit in
25985edce   Lucas De Marchi   Fix common misspe...
935
   *  @dst corresponding to whatever is the twelfth bit that is
7ea931c9f   Paul Jackson   mempolicy: add bi...
936
937
938
939
940
941
942
943
944
945
946
947
   *  turned on in @relmap.  In the above example, there were
   *  only ten bits turned on in @relmap (30..39), so that bit
   *  11 was set in @orig had no affect on @dst.
   *
   * Example [2] for bitmap_fold() + bitmap_onto():
   *  Let's say @relmap has these ten bits set:
   *		40 41 42 43 45 48 53 61 74 95
   *  (for the curious, that's 40 plus the first ten terms of the
   *  Fibonacci sequence.)
   *
   *  Further lets say we use the following code, invoking
   *  bitmap_fold() then bitmap_onto, as suggested above to
da3dae54e   Masanari Iida   Documentation: Do...
948
   *  avoid the possibility of an empty @dst result:
7ea931c9f   Paul Jackson   mempolicy: add bi...
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
   *
   *	unsigned long *tmp;	// a temporary bitmap's bits
   *
   *	bitmap_fold(tmp, orig, bitmap_weight(relmap, bits), bits);
   *	bitmap_onto(dst, tmp, relmap, bits);
   *
   *  Then this table shows what various values of @dst would be, for
   *  various @orig's.  I list the zero-based positions of each set bit.
   *  The tmp column shows the intermediate result, as computed by
   *  using bitmap_fold() to fold the @orig bitmap modulo ten
   *  (the weight of @relmap).
   *
   *      @orig           tmp            @dst
   *      0                0             40
   *      1                1             41
   *      9                9             95
   *      10               0             40 (*)
   *      1 3 5 7          1 3 5 7       41 43 48 61
   *      0 1 2 3 4        0 1 2 3 4     40 41 42 43 45
   *      0 9 18 27        0 9 8 7       40 61 74 95
   *      0 10 20 30       0             40
   *      0 11 22 33       0 1 2 3       40 41 42 43
   *      0 12 24 36       0 2 4 6       40 42 45 53
   *      78 102 211       1 2 8         41 42 74 (*)
   *
   * (*) For these marked lines, if we hadn't first done bitmap_fold()
   *     into tmp, then the @dst result would have been empty.
   *
   * If either of @orig or @relmap is empty (no set bits), then @dst
   * will be returned empty.
   *
   * If (as explained above) the only set bits in @orig are in positions
   * m where m >= W, (where W is the weight of @relmap) then @dst will
   * once again be returned empty.
   *
   * All bits in @dst not set by the above rule are cleared.
   */
  void bitmap_onto(unsigned long *dst, const unsigned long *orig,
  			const unsigned long *relmap, int bits)
  {
  	int n, m;       	/* same meaning as in above comment */
  
  	if (dst == orig)	/* following doesn't handle inplace mappings */
  		return;
  	bitmap_zero(dst, bits);
  
  	/*
  	 * The following code is a more efficient, but less
  	 * obvious, equivalent to the loop:
  	 *	for (m = 0; m < bitmap_weight(relmap, bits); m++) {
  	 *		n = bitmap_ord_to_pos(orig, m, bits);
  	 *		if (test_bit(m, orig))
  	 *			set_bit(n, dst);
  	 *	}
  	 */
  
  	m = 0;
08564fb7a   Akinobu Mita   bitmap: use for_e...
1006
  	for_each_set_bit(n, relmap, bits) {
7ea931c9f   Paul Jackson   mempolicy: add bi...
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
  		/* m == bitmap_pos_to_ord(relmap, n, bits) */
  		if (test_bit(m, orig))
  			set_bit(n, dst);
  		m++;
  	}
  }
  EXPORT_SYMBOL(bitmap_onto);
  
  /**
   * bitmap_fold - fold larger bitmap into smaller, modulo specified size
   *	@dst: resulting smaller bitmap
   *	@orig: original larger bitmap
   *	@sz: specified size
   *	@bits: number of bits in each of these bitmaps
   *
   * For each bit oldbit in @orig, set bit oldbit mod @sz in @dst.
   * Clear all other bits in @dst.  See further the comment and
   * Example [2] for bitmap_onto() for why and how to use this.
   */
  void bitmap_fold(unsigned long *dst, const unsigned long *orig,
  			int sz, int bits)
  {
  	int oldbit;
  
  	if (dst == orig)	/* following doesn't handle inplace mappings */
  		return;
  	bitmap_zero(dst, bits);
08564fb7a   Akinobu Mita   bitmap: use for_e...
1034
  	for_each_set_bit(oldbit, orig, bits)
7ea931c9f   Paul Jackson   mempolicy: add bi...
1035
1036
1037
  		set_bit(oldbit % sz, dst);
  }
  EXPORT_SYMBOL(bitmap_fold);
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1038
1039
1040
1041
1042
1043
  /*
   * Common code for bitmap_*_region() routines.
   *	bitmap: array of unsigned longs corresponding to the bitmap
   *	pos: the beginning of the region
   *	order: region size (log base 2 of number of bits)
   *	reg_op: operation(s) to perform on that region of bitmap
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1044
   *
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1045
1046
   * Can set, verify and/or release a region of bits in a bitmap,
   * depending on which combination of REG_OP_* flag bits is set.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1047
   *
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1048
1049
1050
1051
1052
1053
   * A region of a bitmap is a sequence of bits in the bitmap, of
   * some size '1 << order' (a power of two), aligned to that same
   * '1 << order' power of two.
   *
   * Returns 1 if REG_OP_ISFREE succeeds (region is all zero bits).
   * Returns 0 in all other cases and reg_ops.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1054
   */
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1055
1056
1057
1058
1059
1060
  
  enum {
  	REG_OP_ISFREE,		/* true if region is all zero bits */
  	REG_OP_ALLOC,		/* set all bits in region */
  	REG_OP_RELEASE,		/* clear all bits in region */
  };
9279d3286   Rasmus Villemoes   lib: bitmap: chan...
1061
  static int __reg_op(unsigned long *bitmap, unsigned int pos, int order, int reg_op)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1062
  {
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1063
1064
1065
1066
  	int nbits_reg;		/* number of bits in region */
  	int index;		/* index first long of region in bitmap */
  	int offset;		/* bit offset region in bitmap[index] */
  	int nlongs_reg;		/* num longs spanned by region in bitmap */
74373c6ac   Paul Mundt   [PATCH] bitmap: r...
1067
  	int nbitsinlong;	/* num bits of region in each spanned long */
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1068
  	unsigned long mask;	/* bitmask for one long of region */
74373c6ac   Paul Mundt   [PATCH] bitmap: r...
1069
  	int i;			/* scans bitmap by longs */
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1070
  	int ret = 0;		/* return value */
74373c6ac   Paul Mundt   [PATCH] bitmap: r...
1071

3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1072
1073
1074
1075
1076
1077
1078
1079
1080
  	/*
  	 * Either nlongs_reg == 1 (for small orders that fit in one long)
  	 * or (offset == 0 && mask == ~0UL) (for larger multiword orders.)
  	 */
  	nbits_reg = 1 << order;
  	index = pos / BITS_PER_LONG;
  	offset = pos - (index * BITS_PER_LONG);
  	nlongs_reg = BITS_TO_LONGS(nbits_reg);
  	nbitsinlong = min(nbits_reg,  BITS_PER_LONG);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1081

3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1082
1083
1084
1085
  	/*
  	 * Can't do "mask = (1UL << nbitsinlong) - 1", as that
  	 * overflows if nbitsinlong == BITS_PER_LONG.
  	 */
74373c6ac   Paul Mundt   [PATCH] bitmap: r...
1086
  	mask = (1UL << (nbitsinlong - 1));
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1087
  	mask += mask - 1;
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1088
  	mask <<= offset;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1089

3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
  	switch (reg_op) {
  	case REG_OP_ISFREE:
  		for (i = 0; i < nlongs_reg; i++) {
  			if (bitmap[index + i] & mask)
  				goto done;
  		}
  		ret = 1;	/* all bits in region free (zero) */
  		break;
  
  	case REG_OP_ALLOC:
  		for (i = 0; i < nlongs_reg; i++)
  			bitmap[index + i] |= mask;
  		break;
  
  	case REG_OP_RELEASE:
  		for (i = 0; i < nlongs_reg; i++)
  			bitmap[index + i] &= ~mask;
  		break;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1108
  	}
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
  done:
  	return ret;
  }
  
  /**
   * bitmap_find_free_region - find a contiguous aligned mem region
   *	@bitmap: array of unsigned longs corresponding to the bitmap
   *	@bits: number of bits in the bitmap
   *	@order: region size (log base 2 of number of bits) to find
   *
   * Find a region of free (zero) bits in a @bitmap of @bits bits and
   * allocate them (set them to one).  Only consider regions of length
   * a power (@order) of two, aligned to that power of two, which
   * makes the search algorithm much faster.
   *
   * Return the bit offset in bitmap of the allocated region,
   * or -errno on failure.
   */
9279d3286   Rasmus Villemoes   lib: bitmap: chan...
1127
  int bitmap_find_free_region(unsigned long *bitmap, unsigned int bits, int order)
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1128
  {
9279d3286   Rasmus Villemoes   lib: bitmap: chan...
1129
  	unsigned int pos, end;		/* scans bitmap by regions of size order */
aa8e4fc68   Linus Torvalds   bitmap: fix end c...
1130

9279d3286   Rasmus Villemoes   lib: bitmap: chan...
1131
  	for (pos = 0 ; (end = pos + (1U << order)) <= bits; pos = end) {
aa8e4fc68   Linus Torvalds   bitmap: fix end c...
1132
1133
1134
1135
1136
1137
  		if (!__reg_op(bitmap, pos, order, REG_OP_ISFREE))
  			continue;
  		__reg_op(bitmap, pos, order, REG_OP_ALLOC);
  		return pos;
  	}
  	return -ENOMEM;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1138
1139
1140
1141
  }
  EXPORT_SYMBOL(bitmap_find_free_region);
  
  /**
87e248025   Paul Jackson   [PATCH] bitmap: r...
1142
   * bitmap_release_region - release allocated bitmap region
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1143
1144
1145
   *	@bitmap: array of unsigned longs corresponding to the bitmap
   *	@pos: beginning of bit region to release
   *	@order: region size (log base 2 of number of bits) to release
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1146
   *
72fd4a35a   Robert P. J. Day   [PATCH] Numerous ...
1147
   * This is the complement to __bitmap_find_free_region() and releases
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1148
   * the found region (by clearing it in the bitmap).
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1149
1150
   *
   * No return value.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1151
   */
9279d3286   Rasmus Villemoes   lib: bitmap: chan...
1152
  void bitmap_release_region(unsigned long *bitmap, unsigned int pos, int order)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1153
  {
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1154
  	__reg_op(bitmap, pos, order, REG_OP_RELEASE);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1155
1156
  }
  EXPORT_SYMBOL(bitmap_release_region);
87e248025   Paul Jackson   [PATCH] bitmap: r...
1157
1158
  /**
   * bitmap_allocate_region - allocate bitmap region
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1159
1160
1161
   *	@bitmap: array of unsigned longs corresponding to the bitmap
   *	@pos: beginning of bit region to allocate
   *	@order: region size (log base 2 of number of bits) to allocate
87e248025   Paul Jackson   [PATCH] bitmap: r...
1162
1163
   *
   * Allocate (set bits in) a specified region of a bitmap.
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1164
   *
6e1907ffd   Randy Dunlap   [PATCH] kernel-do...
1165
   * Return 0 on success, or %-EBUSY if specified region wasn't
87e248025   Paul Jackson   [PATCH] bitmap: r...
1166
1167
   * free (not all bits were zero).
   */
9279d3286   Rasmus Villemoes   lib: bitmap: chan...
1168
  int bitmap_allocate_region(unsigned long *bitmap, unsigned int pos, int order)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1169
  {
3cf64b933   Paul Jackson   [PATCH] bitmap: r...
1170
1171
  	if (!__reg_op(bitmap, pos, order, REG_OP_ISFREE))
  		return -EBUSY;
2ac521d33   Rasmus Villemoes   lib: bitmap: micr...
1172
  	return __reg_op(bitmap, pos, order, REG_OP_ALLOC);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1173
1174
  }
  EXPORT_SYMBOL(bitmap_allocate_region);
ccbe329bc   David Vrabel   bitmap: add bitma...
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
  
  /**
   * bitmap_copy_le - copy a bitmap, putting the bits into little-endian order.
   * @dst:   destination buffer
   * @src:   bitmap to copy
   * @nbits: number of bits in the bitmap
   *
   * Require nbits % BITS_PER_LONG == 0.
   */
  void bitmap_copy_le(void *dst, const unsigned long *src, int nbits)
  {
  	unsigned long *d = dst;
  	int i;
  
  	for (i = 0; i < nbits/BITS_PER_LONG; i++) {
  		if (BITS_PER_LONG == 64)
  			d[i] = cpu_to_le64(src[i]);
  		else
  			d[i] = cpu_to_le32(src[i]);
  	}
  }
  EXPORT_SYMBOL(bitmap_copy_le);