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 * format.c: generic network formatting/unformating
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vlib/vlib.h>
43 format_vlib_rx_tx (u8 * s, va_list * args)
45 vlib_rx_or_tx_t r = va_arg (*args, vlib_rx_or_tx_t);
61 vec_add (s, t, strlen (t));
66 format_vlib_read_write (u8 * s, va_list * args)
68 vlib_rx_or_tx_t r = va_arg (*args, vlib_rx_or_tx_t);
84 vec_add (s, t, strlen (t));
88 /* Formats buffer data as printable ascii or as hex. */
90 format_vlib_buffer_data (u8 * s, va_list * args)
92 u8 *data = va_arg (*args, u8 *);
93 u32 n_data_bytes = va_arg (*args, u32);
97 for (i = 0; i < n_data_bytes && is_printable; i++)
107 vec_add (s, data, n_data_bytes);
109 s = format (s, "%U", format_hex_bytes, data, n_data_bytes);
114 /* Enable/on => 1; disable/off => 0. */
116 unformat_vlib_enable_disable (unformat_input_t * input, va_list * args)
118 int *result = va_arg (*args, int *);
121 if (unformat (input, "enable") || unformat (input, "on"))
123 else if (unformat (input, "disable") || unformat (input, "off"))
132 /* rx/tx => VLIB_RX/VLIB_TX. */
134 unformat_vlib_rx_tx (unformat_input_t * input, va_list * args)
136 int *result = va_arg (*args, int *);
137 if (unformat (input, "rx"))
139 else if (unformat (input, "tx"))
146 /* Parse an int either %d or 0x%x. */
148 unformat_vlib_number (unformat_input_t * input, va_list * args)
150 int *result = va_arg (*args, int *);
152 return (unformat (input, "0x%x", result) || unformat (input, "%d", result));
155 /* Parse a-zA-Z0-9_ token and hash to value. */
157 unformat_vlib_number_by_name (unformat_input_t * input, va_list * args)
159 uword *hash = va_arg (*args, uword *);
160 int *result = va_arg (*args, int *);
165 if (!unformat_user (input, unformat_token, "a-zA-Z0-9_", &token))
168 /* Null terminate. */
169 if (vec_len (token) > 0 && token[vec_len (token) - 1] != 0)
172 /* Check for exact match. */
173 p = hash_get_mem (hash, token);
177 /* Convert to upper case & try match. */
178 for (i = 0; i < vec_len (token); i++)
179 if (token[i] >= 'a' && token[i] <= 'z')
180 token[i] = 'A' + token[i] - 'a';
181 p = hash_get_mem (hash, token);
190 /* Parse a filename to dump debug info */
192 unformat_vlib_tmpfile (unformat_input_t * input, va_list * args)
194 u8 **chroot_filename = va_arg (*args, u8 **);
197 if (!unformat (input, "%s", &filename))
200 /* Brain-police user path input */
201 if (strstr ((char *) filename, "..") || index ((char *) filename, '/'))
207 *chroot_filename = format (0, "/tmp/%s%c", filename, 0);
215 * fd.io coding-style-patch-verification: ON
218 * eval: (c-set-style "gnu")