2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 Copyright (c) 2001, 2002, 2003, 2005 Eliot Dresselhaus
18 Permission is hereby granted, free of charge, to any person obtaining
19 a copy of this software and associated documentation files (the
20 "Software"), to deal in the Software without restriction, including
21 without limitation the rights to use, copy, modify, merge, publish,
22 distribute, sublicense, and/or sell copies of the Software, and to
23 permit persons to whom the Software is furnished to do so, subject to
24 the following conditions:
26 The above copyright notice and this permission notice shall be
27 included in all copies or substantial portions of the Software.
29 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 #ifndef included_clib_bitmap_h
39 #define included_clib_bitmap_h
42 Bitmaps built as vectors of machine words
45 #include <vppinfra/vec.h>
46 #include <vppinfra/random.h>
47 #include <vppinfra/error.h>
48 #include <vppinfra/bitops.h> /* for count_set_bits */
50 typedef uword clib_bitmap_t;
52 /** predicate function; is an entire bitmap empty?
53 @param ai - pointer to a bitmap
54 @returns 1 if the entire bitmap is zero, 0 otherwise
57 clib_bitmap_is_zero (uword * ai)
60 for (i = 0; i < vec_len (ai); i++)
66 /** predicate function; are two bitmaps equal?
67 @param a - pointer to a bitmap
68 @param b - pointer to a bitmap
69 @returns 1 if the bitmaps are equal, 0 otherwise
72 clib_bitmap_is_equal (uword * a, uword * b)
75 if (vec_len (a) != vec_len (b))
77 for (i = 0; i < vec_len (a); i++)
83 /** Duplicate a bitmap
84 @param v - pointer to a bitmap
85 @returns a duplicate of the bitmap
87 #define clib_bitmap_dup(v) vec_dup(v)
90 @param v - pointer to the bitmap to free
92 #define clib_bitmap_free(v) vec_free(v)
94 /** Number of bytes in a bitmap
95 @param v - pointer to the bitmap
97 #define clib_bitmap_bytes(v) vec_bytes(v)
100 @param v - pointer to the bitmap to clear
102 #define clib_bitmap_zero(v) vec_zero(v)
104 /** Allocate a bitmap with the supplied number of bits
105 @param [out] v - the resulting bitmap
106 @param n_bits - the required number of bits
109 #define clib_bitmap_alloc(v,n_bits) \
110 v = vec_new (uword, ((n_bits) + BITS (uword) - 1) / BITS (uword))
112 #define clib_bitmap_vec_validate(v,i) vec_validate_aligned((v),(i),sizeof(uword))
114 /* Make sure that a bitmap is at least n_bits in size */
115 #define clib_bitmap_validate(v,n_bits) \
116 clib_bitmap_vec_validate ((v), ((n_bits) - 1) / BITS (uword))
118 /* low-level routine to remove trailing zeros from a bitmap */
119 always_inline uword *
120 _clib_bitmap_remove_trailing_zeros (uword * a)
125 for (i = _vec_len (a) - 1; i >= 0; i--)
128 _vec_len (a) = i + 1;
133 /** Sets the ith bit of a bitmap to new_value.
134 No sanity checking. Be careful.
135 @param a - pointer to the bitmap
136 @param i - the bit position to interrogate
137 @param new_value - new value for the bit
138 @returns the old value of the bit
141 clib_bitmap_set_no_check (uword * a, uword i, uword new_value)
143 uword i0 = i / BITS (a[0]);
144 uword i1 = i % BITS (a[0]);
145 uword bit = (uword) 1 << i1;
148 /* Removed ASSERT since uword * a may not be a vector. */
149 /* ASSERT (i0 < vec_len (a)); */
152 old_value = (ai & bit) != 0;
154 ai |= ((uword) (new_value != 0)) << i1;
159 /** Sets the ith bit of a bitmap to new_value
160 Removes trailing zeros from the bitmap
161 @param ai - pointer to the bitmap
162 @param i - the bit position to interrogate
163 @param value - new value for the bit
164 @returns the old value of the bit
166 always_inline uword *
167 clib_bitmap_set (uword * ai, uword i, uword value)
169 uword i0 = i / BITS (ai[0]);
170 uword i1 = i % BITS (ai[0]);
173 /* Check for writing a zero to beyond end of bitmap. */
174 if (value == 0 && i0 >= vec_len (ai))
175 return ai; /* Implied trailing zeros. */
177 clib_bitmap_vec_validate (ai, i0);
180 a &= ~((uword) 1 << i1);
181 a |= ((uword) (value != 0)) << i1;
184 /* If bits have been cleared, test for zero. */
186 ai = _clib_bitmap_remove_trailing_zeros (ai);
191 /** Gets the ith bit value from a bitmap
192 @param ai - pointer to the bitmap
193 @param i - the bit position to interrogate
194 @returns the indicated bit value
197 clib_bitmap_get (uword * ai, uword i)
199 uword i0 = i / BITS (ai[0]);
200 uword i1 = i % BITS (ai[0]);
201 return i0 < vec_len (ai) && 0 != ((ai[i0] >> i1) & 1);
204 /** Gets the ith bit value from a bitmap
205 Does not sanity-check the bit position. Be careful.
206 @param ai - pointer to the bitmap
207 @param i - the bit position to interrogate
208 @returns the indicated bit value, or garbage if the bit position is
212 clib_bitmap_get_no_check (uword * ai, uword i)
214 uword i0 = i / BITS (ai[0]);
215 uword i1 = i % BITS (ai[0]);
216 return 0 != ((ai[i0] >> i1) & 1);
220 clib_bitmap_get_multiple_no_check (uword * ai, uword i, uword n_bits)
222 uword i0 = i / BITS (ai[0]);
223 uword i1 = i % BITS (ai[0]);
224 ASSERT (i1 + n_bits <= BITS (uword));
225 return 0 != ((ai[i0] >> i1) & pow2_mask (n_bits));
228 /** Gets the ith through ith + n_bits bit values from a bitmap
229 @param bitmap - pointer to the bitmap
230 @param i - the first bit position to retrieve
231 @param n_bits - the number of bit positions to retrieve
232 @returns the indicated range of bits
235 clib_bitmap_get_multiple (uword * bitmap, uword i, uword n_bits)
237 uword i0, i1, result;
238 uword l = vec_len (bitmap);
240 ASSERT (n_bits <= BITS (result));
242 i0 = i / BITS (bitmap[0]);
243 i1 = i % BITS (bitmap[0]);
245 /* Check first word. */
249 result |= (bitmap[i0] >> i1);
250 if (n_bits < BITS (bitmap[0]))
251 result &= (((uword) 1 << n_bits) - 1);
254 /* Check for overlap into next word. */
256 if (i1 + n_bits > BITS (bitmap[0]) && i0 < l)
258 n_bits -= BITS (bitmap[0]) - i1;
260 (bitmap[i0] & (((uword) 1 << n_bits) - 1)) << (BITS (bitmap[0]) - i1);
266 /** sets the ith through ith + n_bits bits in a bitmap
267 @param bitmap - pointer to the bitmap
268 @param i - the first bit position to retrieve
269 @param value - the values to set
270 @param n_bits - the number of bit positions to set
271 @returns a pointer to the updated bitmap, which may expand and move
274 always_inline uword *
275 clib_bitmap_set_multiple (uword * bitmap, uword i, uword value, uword n_bits)
277 uword i0, i1, l, t, m;
279 ASSERT (n_bits <= BITS (value));
281 i0 = i / BITS (bitmap[0]);
282 i1 = i % BITS (bitmap[0]);
284 /* Allocate bitmap. */
285 clib_bitmap_vec_validate (bitmap, (i + n_bits) / BITS (bitmap[0]));
286 l = vec_len (bitmap);
289 if (n_bits < BITS (value))
290 m = (((uword) 1 << n_bits) - 1);
293 /* Insert into first word. */
299 /* Insert into second word. */
301 if (i1 + n_bits > BITS (bitmap[0]) && i0 < l)
303 t = BITS (bitmap[0]) - i1;
307 m = ((uword) 1 << n_bits) - 1;
316 always_inline uword *
317 clfib_bitmap_set_region (uword * bitmap, uword i, uword value, uword n_bits)
322 a0 = i / BITS (bitmap[0]);
323 a1 = i % BITS (bitmap[0]);
326 b0 = i_end / BITS (bitmap[0]);
328 clib_bitmap_vec_validate (bitmap, b0);
331 mask = n_bits < BITS (bitmap[0]) ? pow2_mask (n_bits) : ~0;
339 for (a0++; a0 < b0; a0++)
340 bitmap[a0] = value ? ~0 : 0;
344 word n_bits_left = n_bits - (BITS (bitmap[0]) - a1);
345 mask = pow2_mask (n_bits_left);
355 /** Macro to iterate across set bits in a bitmap
357 @param i - the current set bit
358 @param ai - the bitmap
359 @param body - the expression to evaluate for each set bit
361 #define clib_bitmap_foreach(i,ai,body) \
363 uword __bitmap_i, __bitmap_ai, __bitmap_len, __bitmap_first_set; \
364 __bitmap_len = vec_len ((ai)); \
365 for (__bitmap_i = 0; __bitmap_i < __bitmap_len; __bitmap_i++) \
367 __bitmap_ai = (ai)[__bitmap_i]; \
368 while (__bitmap_ai != 0) \
370 __bitmap_first_set = first_set (__bitmap_ai); \
371 (i) = (__bitmap_i * BITS ((ai)[0]) \
372 + min_log2 (__bitmap_first_set)); \
373 do { body; } while (0); \
374 __bitmap_ai ^= __bitmap_first_set; \
380 /** Return the lowest numbered set bit in a bitmap
381 @param ai - pointer to the bitmap
382 @returns lowest numbered set bit, or ~0 if the entire bitmap is zero
385 clib_bitmap_first_set (uword * ai)
389 #if defined(CLIB_HAVE_VEC256)
390 while (i + 7 < vec_len (ai))
393 v = u64x4_load_unaligned (ai + i) | u64x4_load_unaligned (ai + i + 4);
394 if (!u64x4_is_all_zero (v))
398 #elif defined(CLIB_HAVE_VEC128) && defined(CLIB_HAVE_VEC128_UNALIGNED_LOAD_STORE)
399 while (i + 3 < vec_len (ai))
402 v = u64x2_load_unaligned (ai + i) | u64x2_load_unaligned (ai + i + 2);
403 if (!u64x2_is_all_zero (v))
409 for (; i < vec_len (ai); i++)
413 return i * BITS (ai[0]) + log2_first_set (x);
418 /** Return the higest numbered set bit in a bitmap
419 @param ai - pointer to the bitmap
420 @returns lowest numbered set bit, or ~0 if the entire bitmap is zero
423 clib_bitmap_last_set (uword * ai)
427 for (i = vec_len (ai); i > 0; i--)
433 first_bit = count_leading_zeros (x);
434 return (i) * BITS (ai[0]) - first_bit - 1;
440 /** Return the lowest numbered clear bit in a bitmap
441 @param ai - pointer to the bitmap
442 @returns lowest numbered clear bit
445 clib_bitmap_first_clear (uword * ai)
448 for (i = 0; i < vec_len (ai); i++)
452 return i * BITS (ai[0]) + log2_first_set (x);
454 return i * BITS (ai[0]);
457 /** Return the number of set bits in a bitmap
458 @param ai - pointer to the bitmap
459 @returns the number of set bits in the bitmap
462 clib_bitmap_count_set_bits (uword * ai)
466 for (i = 0; i < vec_len (ai); i++)
467 n_set += count_set_bits (ai[i]);
471 /** Logical operator across two bitmaps
473 @param ai - pointer to the destination bitmap
474 @param bi - pointer to the source bitmap
475 @returns ai = ai and bi. ai is modified, bi is not modified
477 always_inline uword *clib_bitmap_and (uword * ai, uword * bi);
479 /** Logical operator across two bitmaps
481 @param ai - pointer to the destination bitmap
482 @param bi - pointer to the source bitmap
483 @returns ai = ai & ~bi. ai is modified, bi is not modified
485 always_inline uword *clib_bitmap_andnot (uword * ai, uword * bi);
487 /** Logical operator across two bitmaps
489 @param ai - pointer to the destination bitmap
490 @param bi - pointer to the source bitmap
491 @returns ai = ai & ~bi. ai is modified, bi is not modified
493 always_inline uword *clib_bitmap_or (uword * ai, uword * bi);
494 /** Logical operator across two bitmaps
496 @param ai - pointer to the destination bitmap
497 @param bi - pointer to the source bitmap
498 @returns ai = ai or bi. ai is modified, bi is not modified
500 always_inline uword *clib_bitmap_or (uword * ai, uword * bi);
502 /** Logical operator across two bitmaps
504 @param ai - pointer to the destination bitmap
505 @param bi - pointer to the source bitmap
506 @returns ai = ai xor bi. ai is modified, bi is not modified
508 always_inline uword *clib_bitmap_xor (uword * ai, uword * bi);
510 /* ALU function definition macro for functions taking two bitmaps. */
511 #define _(name, body, check_zero) \
512 always_inline uword * \
513 clib_bitmap_##name (uword * ai, uword * bi) \
515 uword i, a, b, bi_len, n_trailing_zeros; \
517 n_trailing_zeros = 0; \
518 bi_len = vec_len (bi); \
520 clib_bitmap_vec_validate (ai, bi_len - 1); \
521 for (i = 0; i < vec_len (ai); i++) \
524 b = i < bi_len ? bi[i] : 0; \
525 do { body; } while (0); \
528 n_trailing_zeros = a ? 0 : (n_trailing_zeros + 1); \
531 _vec_len (ai) -= n_trailing_zeros; \
538 _(andnot, a = a & ~b, 1)
543 /** Logical operator across two bitmaps which duplicates the first bitmap
545 @param ai - pointer to the destination bitmap
546 @param bi - pointer to the source bitmap
547 @returns aiDup = ai and bi. Neither ai nor bi are modified
549 always_inline uword *clib_bitmap_dup_and (uword * ai, uword * bi);
551 /** Logical operator across two bitmaps which duplicates the first bitmap
553 @param ai - pointer to the destination bitmap
554 @param bi - pointer to the source bitmap
555 @returns aiDup = ai & ~bi. Neither ai nor bi are modified
557 always_inline uword *clib_bitmap_dup_andnot (uword * ai, uword * bi);
559 /** Logical operator across two bitmaps which duplicates the first bitmap
561 @param ai - pointer to the destination bitmap
562 @param bi - pointer to the source bitmap
563 @returns aiDup = ai or bi. Neither ai nor bi are modified
565 always_inline uword *clib_bitmap_dup_or (uword * ai, uword * bi);
567 /** Logical operator across two bitmaps which duplicates the first bitmap
569 @param ai - pointer to the destination bitmap
570 @param bi - pointer to the source bitmap
571 @returns aiDup = ai xor bi. Neither ai nor bi are modified
573 always_inline uword *clib_bitmap_dup_xor (uword * ai, uword * bi);
576 always_inline uword * \
577 clib_bitmap_dup_##name (uword * ai, uword * bi) \
578 { return clib_bitmap_##name (clib_bitmap_dup (ai), bi); }
588 /* ALU function definition macro for functions taking one bitmap and an
590 #define _(name, body, check_zero) \
591 always_inline uword * \
592 clib_bitmap_##name (uword * ai, uword i) \
594 uword i0 = i / BITS (ai[0]); \
595 uword i1 = i % BITS (ai[0]); \
597 clib_bitmap_vec_validate (ai, i0); \
599 b = (uword) 1 << i1; \
600 do { body; } while (0); \
602 if (check_zero && a == 0) \
603 ai = _clib_bitmap_remove_trailing_zeros (ai); \
607 /* ALU functions immediate: */
609 _(andi, a = a & b, 1)
610 _(andnoti, a = a & ~b, 1)
612 _(xori, a = a ^ b, 1)
616 /* ALU function definition macro for functions taking one bitmap and an
617 * immediate. No tail trimming */
618 #define _(name, body) \
619 always_inline uword * \
620 clib_bitmap_##name##_notrim (uword * ai, uword i) \
622 uword i0 = i / BITS (ai[0]); \
623 uword i1 = i % BITS (ai[0]); \
625 clib_bitmap_vec_validate (ai, i0); \
627 b = (uword) 1 << i1; \
628 do { body; } while (0); \
633 /* ALU functions immediate: */
636 _(andnoti, a = a & ~b)
642 /** Return a random bitmap of the requested length
643 @param ai - pointer to the destination bitmap
644 @param n_bits - number of bits to allocate
645 @param [in,out] seed - pointer to the random number seed
646 @returns a reasonably random bitmap based. See random.h.
648 always_inline uword *
649 clib_bitmap_random (uword * ai, uword n_bits, u32 * seed)
651 vec_reset_length (ai);
655 uword i = n_bits - 1;
659 log2_rand_max = min_log2 (random_u32_max ());
661 i0 = i / BITS (ai[0]);
662 i1 = i % BITS (ai[0]);
664 clib_bitmap_vec_validate (ai, i0);
665 for (i = 0; i <= i0; i++)
668 for (n = 0; n < BITS (ai[i]); n += log2_rand_max)
669 ai[i] |= random_u32 (seed) << n;
671 if (i1 + 1 < BITS (ai[0]))
672 ai[i0] &= (((uword) 1 << (i1 + 1)) - 1);
677 /** Return the next set bit in a bitmap starting at bit i
678 @param ai - pointer to the bitmap
679 @param i - first bit position to test
680 @returns first set bit position at or after i,
681 ~0 if no further set bits are found
684 clib_bitmap_next_set (uword * ai, uword i)
686 uword i0 = i / BITS (ai[0]);
687 uword i1 = i % BITS (ai[0]);
690 if (i0 < vec_len (ai))
692 t = (ai[i0] >> i1) << i1;
694 return log2_first_set (t) + i0 * BITS (ai[0]);
696 for (i0++; i0 < vec_len (ai); i0++)
700 return log2_first_set (t) + i0 * BITS (ai[0]);
707 /** Return the next clear bit in a bitmap starting at bit i
708 @param ai - pointer to the bitmap
709 @param i - first bit position to test
710 @returns first clear bit position at or after i
713 clib_bitmap_next_clear (uword * ai, uword i)
715 uword i0 = i / BITS (ai[0]);
716 uword i1 = i % BITS (ai[0]);
719 if (i0 < vec_len (ai))
721 t = (~ai[i0] >> i1) << i1;
723 return log2_first_set (t) + i0 * BITS (ai[0]);
725 for (i0++; i0 < vec_len (ai); i0++)
729 return log2_first_set (t) + i0 * BITS (ai[0]);
732 /* no clear bit left in bitmap, return bit just beyond bitmap */
733 return (i0 + 1) * BITS (ai[0]);
738 /** unformat an any sized hexadecimal bitmask into a bitmap
741 rv = unformat ("%U", unformat_bitmap_mask, &bitmap);
743 Standard unformat_function_t arguments
745 @param input - pointer an unformat_input_t
746 @param va - varargs list comprising a single uword **
747 @returns 1 on success, 0 on failure
750 unformat_bitmap_mask (unformat_input_t * input, va_list * va)
752 u8 *v = 0; /* hexadecimal vector */
753 uword **bitmap_return = va_arg (*va, uword **);
756 if (unformat (input, "%U", unformat_hex_string, &v))
758 int i, s = vec_len (v) - 1; /* 's' for significance or shift */
760 /* v[0] holds the most significant byte */
761 for (i = 0; s >= 0; i++, s--)
762 bitmap = clib_bitmap_set_multiple (bitmap,
763 s * BITS (v[i]), v[i],
767 *bitmap_return = bitmap;
774 /** unformat a list of bit ranges into a bitmap (eg "0-3,5-7,11" )
777 rv = unformat ("%U", unformat_bitmap_list, &bitmap);
779 Standard unformat_function_t arguments
781 @param input - pointer an unformat_input_t
782 @param va - varargs list comprising a single uword **
783 @returns 1 on success, 0 on failure
786 unformat_bitmap_list (unformat_input_t * input, va_list * va)
788 uword **bitmap_return = va_arg (*va, uword **);
793 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
796 if (unformat (input, "%u-%u,", &a, &b))
798 else if (unformat (input, "%u,", &a))
800 else if (unformat (input, "%u-%u", &a, &b))
802 else if (unformat (input, "%u", &a))
806 unformat_put_input (input);
815 for (i = a; i <= b; i++)
816 bitmap = clib_bitmap_set (bitmap, i, 1);
818 *bitmap_return = bitmap;
821 clib_bitmap_free (bitmap);
825 /** Format a bitmap as a string of hex bytes
828 s = format ("%U", format_bitmap_hex, bitmap);
830 Standard format_function_t arguments
832 @param s - string under construction
833 @param args - varargs list comprising a single uword *
834 @returns string under construction
837 format_bitmap_hex (u8 * s, va_list * args)
839 uword *bitmap = va_arg (*args, uword *);
840 int i, is_trailing_zero = 1;
843 return format (s, "0");
845 i = vec_bytes (bitmap) * 2;
849 u8 x = clib_bitmap_get_multiple (bitmap, --i * 4, 4);
851 if (x && is_trailing_zero)
852 is_trailing_zero = 0;
854 if (x || !is_trailing_zero)
855 s = format (s, "%x", x);
859 #endif /* included_clib_bitmap_h */
862 * fd.io coding-style-patch-verification: ON
865 * eval: (c-set-style "gnu")