1 /* SPDX-License-Identifier: Apache-2.0
2 * Copyright (c) 2023 Cisco Systems, Inc.
5 #include "vppinfra/pool.h"
7 #include <vnet/dev/dev.h>
8 #include <vnet/dev/counters.h>
9 #include <vnet/dev/log.h>
10 #include <vnet/dev/types.h>
11 #include <vppinfra/format_table.h>
13 VLIB_REGISTER_LOG_CLASS (dev_log, static) = {
15 .subclass_name = "args",
19 vnet_dev_arg_clear_value (vnet_dev_arg_t *a)
21 if (a->type == VNET_DEV_ARG_TYPE_STRING)
22 vec_free (a->val.string);
23 a->val = (typeof (a->val)){};
28 vnet_dev_arg_free (vnet_dev_arg_t **vp)
32 vnet_dev_arg_clear_value (v);
37 vnet_dev_arg_parse (vlib_main_t *vm, vnet_dev_t *dev, vnet_dev_arg_t *args,
40 vnet_dev_rv_t rv = VNET_DEV_OK;
45 log_debug (dev, "input '%v'", str);
49 unformat_init_string (&in, (char *) str, vec_len (str));
51 while (unformat (&in, "%U=", unformat_token, "a-zA-Z0-9_", &name))
53 vnet_dev_arg_t *a = args;
55 while (a < vec_end (args))
56 if (strcmp (a->name, (char *) name) == 0)
61 if (a->type == VNET_DEV_ARG_TYPE_BOOL)
64 if (unformat (&in, "true") || unformat (&in, "1") ||
65 unformat (&in, "on") || unformat (&in, "yes"))
67 else if (unformat (&in, "false") || unformat (&in, "0") ||
68 unformat (&in, "off") || unformat (&in, "no"))
72 log_err (dev, "unable to parse args: %U", format_unformat_error,
76 "boolean value expected ('yes', 'no', '0', '1', 'on', "
77 "'off', 'true' or 'false') for argument '%s', found '%U'",
78 a->name, format_unformat_error, &in);
82 else if (a->type == VNET_DEV_ARG_TYPE_UINT32)
84 u32 val, min = 0, max = CLIB_U32_MAX;
85 if (!unformat (&in, "%u", &val))
88 "unsigned integer in range %u - %u expected for "
89 "argument '%s', found '%U'",
90 min, max, a->name, format_unformat_error, &in);
100 if (val < min || val > max)
103 "unsigned integer in range %u - %u expected for "
104 "argument '%s', found '%u'",
105 min, max, a->name, val);
110 else if (a->type == VNET_DEV_ARG_TYPE_STRING)
112 if (!unformat (&in, "%U", unformat_double_quoted_string,
117 "double quoted string expected for argument '%s', found '%U'",
118 a->name, format_unformat_error, &in);
122 if (a->min && vec_len (a->val.string) < a->min)
125 format (0, "string '%v' too short, must be at least %u chars",
126 a->val.string, a->min);
129 if (a->max && vec_len (a->val.string) > a->max)
132 0, "string '%v' too long, must be no longer than %u chars",
133 a->val.string, a->max);
139 err = format (0, "unknown argument '%s'", name);
144 log_debug (dev, "name '%s' type %U value %U", name,
145 format_vnet_dev_arg_type, a->type, format_vnet_dev_arg_value,
151 if (unformat_check_input (&in) != UNFORMAT_END_OF_INPUT)
152 err = format (0, "unable to parse argument name '%U'",
153 format_unformat_error, &in);
158 vnet_dev_arg_t *a = 0;
159 log_err (dev, "%v", err);
161 vec_foreach (a, args)
162 vnet_dev_arg_clear_value (a);
163 rv = VNET_DEV_ERR_INVALID_ARG;
172 format_vnet_dev_arg_type (u8 *s, va_list *args)
174 vnet_dev_arg_type_t t = va_arg (*args, u32);
177 #define _(n, f, val) \
178 case VNET_DEV_ARG_TYPE_##n: \
179 return format (s, #n);
180 foreach_vnet_dev_arg_type
182 default : ASSERT (0);
189 format_vnet_dev_arg_value (u8 *s, va_list *args)
191 vnet_dev_arg_type_t t = va_arg (*args, u32);
192 vnet_dev_arg_value_t *v = va_arg (*args, vnet_dev_arg_value_t *);
196 #define _(n, f, value) \
197 case VNET_DEV_ARG_TYPE_##n: \
198 s = format (s, f, v->value); \
200 foreach_vnet_dev_arg_type
208 format_vnet_dev_args (u8 *s, va_list *va)
210 vnet_dev_arg_t *a, *args = va_arg (*va, vnet_dev_arg_t *);
211 table_t t = { .no_ansi = 1 };
213 table_add_header_col (&t, 4, "Name", "Value", "Default", "Description");
214 table_set_cell_align (&t, -1, 0, TTAA_LEFT);
215 table_set_cell_align (&t, -1, 3, TTAA_LEFT);
216 vec_foreach (a, args)
219 table_format_cell (&t, r, 0, "%s", a->name);
221 table_format_cell (&t, r, 1, "%U", format_vnet_dev_arg_value, a->type,
224 table_format_cell (&t, r, 1, "<not set>");
226 table_format_cell (&t, r, 2, "%U", format_vnet_dev_arg_value, a->type,
228 table_format_cell (&t, r, 3, "%s", a->desc);
229 table_set_cell_align (&t, r, 0, TTAA_LEFT);
230 table_set_cell_align (&t, r, 3, TTAA_LEFT);
233 s = format (s, "%U", format_table, &t);