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 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 #include <vppinfra/format.h>
43 format_vec32 (u8 * s, va_list * va)
45 u32 *v = va_arg (*va, u32 *);
46 char *fmt = va_arg (*va, char *);
48 for (i = 0; i < vec_len (v); i++)
52 s = format (s, fmt, v[i]);
58 format_vec_uword (u8 * s, va_list * va)
60 uword *v = va_arg (*va, uword *);
61 char *fmt = va_arg (*va, char *);
63 for (i = 0; i < vec_len (v); i++)
67 s = format (s, fmt, v[i]);
72 /* Ascii buffer and length. */
74 format_ascii_bytes (u8 * s, va_list * va)
76 u8 *v = va_arg (*va, u8 *);
77 uword n_bytes = va_arg (*va, uword);
78 vec_add (s, v, n_bytes);
82 /* Format hex dump. */
84 format_hex_bytes (u8 * s, va_list * va)
86 u8 *bytes = va_arg (*va, u8 *);
87 int n_bytes = va_arg (*va, int);
90 /* Print short or long form depending on byte count. */
91 uword short_form = n_bytes <= 32;
92 u32 indent = format_get_indent (s);
97 for (i = 0; i < n_bytes; i++)
99 if (!short_form && (i % 32) == 0)
100 s = format (s, "%08x: ", i);
102 s = format (s, "%02x", bytes[i]);
104 if (!short_form && ((i + 1) % 32) == 0 && (i + 1) < n_bytes)
105 s = format (s, "\n%U", format_white_space, indent);
112 format_hex_bytes_no_wrap (u8 * s, va_list * va)
114 u8 *bytes = va_arg (*va, u8 *);
115 int n_bytes = va_arg (*va, int);
121 for (i = 0; i < n_bytes; i++)
122 s = format (s, "%02x", bytes[i]);
127 /* Add variable number of spaces. */
129 format_white_space (u8 * s, va_list * va)
131 u32 n = va_arg (*va, u32);
138 format_time_interval (u8 * s, va_list * args)
140 u8 *fmt = va_arg (*args, u8 *);
141 f64 t = va_arg (*args, f64);
144 const f64 seconds_per_minute = 60;
145 const f64 seconds_per_hour = 60 * seconds_per_minute;
146 const f64 seconds_per_day = 24 * seconds_per_hour;
147 uword days, hours, minutes, secs, msecs, usecs;
149 days = t / seconds_per_day;
150 t -= days * seconds_per_day;
152 hours = t / seconds_per_hour;
153 t -= hours * seconds_per_hour;
155 minutes = t / seconds_per_minute;
156 t -= minutes * seconds_per_minute;
164 for (f = fmt; *f; f++)
167 char *what_fmt = "%d";
201 s = format (s, what_fmt, what);
207 /* Unparse memory size e.g. 100, 100k, 100m, 100g. */
209 format_memory_size (u8 * s, va_list * va)
211 uword size = va_arg (*va, uword);
214 l = size > 0 ? min_log2 (size) : 0;
224 u = (uword) 1 << log_u;
226 s = format (s, "%.2f", (f64) size / (f64) u);
228 s = format (s, "%d", size >> log_u);
231 s = format (s, "%c", " kmg"[log_u / 10]);
236 /* Parse memory size e.g. 100, 100k, 100m, 100g. */
238 unformat_memory_size (unformat_input_t * input, va_list * va)
240 uword amount, shift, c;
241 uword *result = va_arg (*va, uword *);
243 if (!unformat (input, "%wd%_", &amount))
246 c = unformat_get_input (input);
263 unformat_put_input (input);
267 *result = amount << shift;
271 /* Unparse memory page size e.g. 4K, 2M */
273 format_log2_page_size (u8 * s, va_list * va)
275 clib_mem_page_sz_t log2_page_sz = va_arg (*va, clib_mem_page_sz_t);
277 if (log2_page_sz == CLIB_MEM_PAGE_SZ_UNKNOWN)
278 return format (s, "unknown");
280 if (log2_page_sz == CLIB_MEM_PAGE_SZ_DEFAULT)
281 return format (s, "default");
283 if (log2_page_sz == CLIB_MEM_PAGE_SZ_DEFAULT_HUGE)
284 return format (s, "default-hugepage");
286 if (log2_page_sz >= 30)
287 return format (s, "%uG", 1 << (log2_page_sz - 30));
289 if (log2_page_sz >= 20)
290 return format (s, "%uM", 1 << (log2_page_sz - 20));
292 if (log2_page_sz >= 10)
293 return format (s, "%uK", 1 << (log2_page_sz - 10));
295 return format (s, "%u", 1 << log2_page_sz);
298 /* Parse memory page size e.g. 4K, 2M */
300 unformat_log2_page_size (unformat_input_t * input, va_list * va)
302 uword amount, shift, c;
303 clib_mem_page_sz_t *result = va_arg (*va, clib_mem_page_sz_t *);
305 if (unformat (input, "default"))
306 return CLIB_MEM_PAGE_SZ_DEFAULT;
308 if (unformat (input, "default-hugepage"))
309 return CLIB_MEM_PAGE_SZ_DEFAULT_HUGE;
311 if (!unformat (input, "%wd%_", &amount))
312 return CLIB_MEM_PAGE_SZ_UNKNOWN;
314 c = unformat_get_input (input);
331 unformat_put_input (input);
335 *result = min_log2 (amount) + shift;
339 /* Format c identifier: e.g. a_name -> "a name".
340 Works for both vector names and null terminated c strings. */
342 format_c_identifier (u8 * s, va_list * va)
344 u8 *id = va_arg (*va, u8 *);
348 if (clib_mem_is_vec (id))
352 for (i = 0; i < l && id[i] != 0; i++)
365 format_hexdump (u8 * s, va_list * args)
367 u8 *data = va_arg (*args, u8 *);
368 uword len = va_arg (*args, uword);
370 const int line_len = 16;
373 u32 indent = format_get_indent (s);
378 for (i = 0; i < len; i++)
380 line_hex = format (line_hex, "%02x ", data[i]);
381 line_str = format (line_str, "%c", isprint (data[i]) ? data[i] : '.');
382 if (!((i + 1) % line_len))
384 s = format (s, "%U%05x: %v[%v]",
385 format_white_space, index ? indent : 0,
386 index, line_hex, line_str);
388 s = format (s, "\n");
390 vec_reset_length (line_hex);
391 vec_reset_length (line_str);
395 while (i++ % line_len)
396 line_hex = format (line_hex, " ");
398 if (vec_len (line_hex))
399 s = format (s, "%U%05x: %v[%v]",
400 format_white_space, index ? indent : 0,
401 index, line_hex, line_str);
410 * fd.io coding-style-patch-verification: ON
413 * eval: (c-set-style "gnu")