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>
42 u8 * format_vec32 (u8 * s, va_list * va)
44 u32 * v = va_arg (*va, u32 *);
45 char * fmt = va_arg (*va, char *);
47 for (i = 0; i < vec_len (v); i++)
51 s = format (s, fmt, v[i]);
56 u8 * format_vec_uword (u8 * s, va_list * va)
58 uword * v = va_arg (*va, uword *);
59 char * fmt = va_arg (*va, char *);
61 for (i = 0; i < vec_len (v); i++)
65 s = format (s, fmt, v[i]);
70 /* Ascii buffer and length. */
71 u8 * format_ascii_bytes (u8 * s, va_list * va)
73 u8 * v = va_arg (*va, u8 *);
74 uword n_bytes = va_arg (*va, uword);
75 vec_add (s, v, n_bytes);
79 /* Format hex dump. */
80 u8 * format_hex_bytes (u8 * s, va_list * va)
82 u8 * bytes = va_arg (*va, u8 *);
83 int n_bytes = va_arg (*va, int);
86 /* Print short or long form depending on byte count. */
87 uword short_form = n_bytes <= 32;
88 uword indent = format_get_indent (s);
93 for (i = 0; i < n_bytes; i++)
95 if (! short_form && (i % 32) == 0)
96 s = format (s, "%08x: ", i);
98 s = format (s, "%02x", bytes[i]);
100 if (! short_form && ((i + 1) % 32) == 0 && (i + 1) < n_bytes)
101 s = format (s, "\n%U", format_white_space, indent);
107 /* Add variable number of spaces. */
108 u8 * format_white_space (u8 * s, va_list * va)
110 uword n = va_arg (*va, uword);
116 u8 * format_time_interval (u8 * s, va_list * args)
118 u8 * fmt = va_arg (*args, u8 *);
119 f64 t = va_arg (*args, f64);
122 const f64 seconds_per_minute = 60;
123 const f64 seconds_per_hour = 60 * seconds_per_minute;
124 const f64 seconds_per_day = 24 * seconds_per_hour;
125 uword days, hours, minutes, secs, msecs, usecs;
127 days = t / seconds_per_day;
128 t -= days * seconds_per_day;
130 hours = t / seconds_per_hour;
131 t -= hours * seconds_per_hour;
133 minutes = t / seconds_per_minute;
134 t -= minutes * seconds_per_minute;
142 for (f = fmt; *f; f++)
145 char * what_fmt = "%d";
179 s = format (s, what_fmt, what);
185 /* Unparse memory size e.g. 100, 100k, 100m, 100g. */
186 u8 * format_memory_size (u8 * s, va_list * va)
188 uword size = va_arg (*va, uword);
191 l = size > 0 ? min_log2 (size) : 0;
201 u = (uword) 1 << log_u;
203 s = format (s, "%.2f", (f64) size / (f64) u);
205 s = format (s, "%d", size >> log_u);
208 s = format (s, "%c", " kmg"[log_u / 10]);
213 /* Parse memory size e.g. 100, 100k, 100m, 100g. */
214 uword unformat_memory_size (unformat_input_t * input, va_list * va)
216 uword amount, shift, c;
217 uword * result = va_arg (*va, uword *);
219 if (! unformat (input, "%wd%_", &amount))
222 c = unformat_get_input (input);
225 case 'k': case 'K': shift = 10; break;
226 case 'm': case 'M': shift = 20; break;
227 case 'g': case 'G': shift = 30; break;
230 unformat_put_input (input);
234 *result = amount << shift;
238 /* Format c identifier: e.g. a_name -> "a name".
239 Words for both vector names and null terminated c strings. */
240 u8 * format_c_identifier (u8 * s, va_list * va)
242 u8 * id = va_arg (*va, u8 *);
246 if (clib_mem_is_vec (id))
250 for (i = 0; id[i] != 0 && i < l; i++)
263 format_hexdump (u8 * s, va_list * args)
265 u8 * data = va_arg (*args, u8 *);
266 uword len = va_arg (*args, uword);
268 const int line_len = 16;
271 uword indent = format_get_indent (s);
276 for(i=0; i < len; i++)
278 line_hex = format (line_hex, "%02x ", data[i]);
279 line_str = format (line_str, "%c", isprint (data[i]) ? data[i] : '.');
280 if (!( (i + 1) % line_len))
282 s = format (s, "%U%05x: %v[%v]",
283 format_white_space, index ? indent : 0,
284 index, line_hex, line_str);
286 s = format (s, "\n");
288 vec_reset_length(line_hex);
289 vec_reset_length(line_str);
293 while (i++ % line_len)
294 line_hex = format (line_hex, " ");
296 if (vec_len(line_hex))
297 s = format (s, "%U%05x: %v[%v]",
298 format_white_space, indent,
299 index, line_hex, line_str);