1 /* SPDX-License-Identifier: Apache-2.0
2 * Copyright(c) 2021 Cisco Systems, Inc.
5 #include <vppinfra/vec.h>
6 #include <vppinfra/bitmap.h>
8 /** unformat an any sized hexadecimal bitmask into a bitmap
11 rv = unformat ("%U", unformat_bitmap_mask, &bitmap);
13 Standard unformat_function_t arguments
15 @param input - pointer an unformat_input_t
16 @param va - varargs list comprising a single uword **
17 @returns 1 on success, 0 on failure
20 unformat_bitmap_mask (unformat_input_t *input, va_list *va)
22 u8 *v = 0; /* hexadecimal vector */
23 uword **bitmap_return = va_arg (*va, uword **);
26 if (unformat (input, "%U", unformat_hex_string, &v))
28 int i, s = vec_len (v) - 1; /* 's' for significance or shift */
30 /* v[0] holds the most significant byte */
31 for (i = 0; s >= 0; i++, s--)
32 bitmap = clib_bitmap_set_multiple (bitmap, s * BITS (v[i]), v[i],
36 *bitmap_return = bitmap;
43 /** unformat a list of bit ranges into a bitmap (eg "0-3,5-7,11" )
46 rv = unformat ("%U", unformat_bitmap_list, &bitmap);
48 Standard unformat_function_t arguments
50 @param input - pointer an unformat_input_t
51 @param va - varargs list comprising a single uword **
52 @returns 1 on success, 0 on failure
55 unformat_bitmap_list (unformat_input_t *input, va_list *va)
57 uword **bitmap_return = va_arg (*va, uword **);
62 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
65 if (unformat (input, "%u-%u,", &a, &b))
67 else if (unformat (input, "%u,", &a))
69 else if (unformat (input, "%u-%u", &a, &b))
71 else if (unformat (input, "%u", &a))
75 unformat_put_input (input);
84 for (i = a; i <= b; i++)
85 bitmap = clib_bitmap_set (bitmap, i, 1);
87 *bitmap_return = bitmap;
90 clib_bitmap_free (bitmap);
94 /** Format a bitmap as a string of hex bytes
97 s = format ("%U", format_bitmap_hex, bitmap);
99 Standard format_function_t arguments
101 @param s - string under construction
102 @param args - varargs list comprising a single uword *
103 @returns string under construction
107 format_bitmap_hex (u8 *s, va_list *args)
109 uword *bitmap = va_arg (*args, uword *);
110 int i, is_trailing_zero = 1;
113 return format (s, "0");
115 i = vec_bytes (bitmap) * 2;
119 u8 x = clib_bitmap_get_multiple (bitmap, --i * 4, 4);
121 if (x && is_trailing_zero)
122 is_trailing_zero = 0;
124 if (x || !is_trailing_zero)
125 s = format (s, "%x", x);
130 /** Format a bitmap as a list
133 s = format ("%U", format_bitmap_list, bitmap);
135 Standard format_function_t arguments
137 @param s - string under construction
138 @param args - varargs list comprising a single uword *
139 @returns string under construction
143 format_bitmap_list (u8 *s, va_list *args)
145 uword *bitmap = va_arg (*args, uword *);
151 fs = clib_bitmap_first_set (bitmap);
157 fc = clib_bitmap_next_clear (bitmap, fs + 1);
159 s = format (s, "%lu-%lu", fs, fc - 1);
161 s = format (s, "%lu", fs);
163 if ((fs = clib_bitmap_next_set (bitmap, fc)) == ~0)
165 s = format (s, ", ");