1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2013 Intel Corporation.
3 * Copyright(c) 2014 6WIND S.A.
10 #include <rte_os_shim.h>
12 #include "rte_kvargs.h"
15 * Receive a string with a list of arguments following the pattern
16 * key=value,key=value,... and insert them into the list.
17 * Params string will be copied to be modified.
18 * list "[]" and list element splitter ",", "-" is treated as value.
22 * k1=x[0-1]y[1,3-5,9]z
25 rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params)
28 bool in_list = false, end_key = false, end_value = false;
29 bool save = false, end_pair = false;
31 /* Copy the const char *params to a modifiable string
32 * to pass to rte_strsplit
34 kvlist->str = strdup(params);
35 if (kvlist->str == NULL)
38 /* browse each key/value pair and add it in kvlist */
40 start = str; /* start of current key or value */
43 case '=': /* End of key. */
48 /* End of value, skip comma in middle of range */
58 case '[': /* Start of list. */
61 case ']': /* End of list. */
65 case '\0': /* End of string */
78 /* Continue if not end of key or value. */
83 if (kvlist->count >= RTE_KVARGS_MAX)
88 kvlist->pairs[kvlist->count].value = start;
91 kvlist->pairs[kvlist->count].key = start;
94 if (end_value || str != start)
95 /* Ignore empty pair. */
102 if (*str == '\0') /* End of string. */
114 * Determine whether a key is valid or not by looking
115 * into a list of valid keys.
118 is_valid_key(const char * const valid[], const char *key_match)
120 const char * const *valid_ptr;
122 for (valid_ptr = valid; *valid_ptr != NULL; valid_ptr++) {
123 if (strcmp(key_match, *valid_ptr) == 0)
130 * Determine whether all keys are valid or not by looking
131 * into a list of valid keys.
134 check_for_valid_keys(struct rte_kvargs *kvlist,
135 const char * const valid[])
138 struct rte_kvargs_pair *pair;
140 for (i = 0; i < kvlist->count; i++) {
141 pair = &kvlist->pairs[i];
142 ret = is_valid_key(valid, pair->key);
150 * Return the number of times a given arg_name exists in the key/value list.
151 * E.g. given a list = { rx = 0, rx = 1, tx = 2 } the number of args for
152 * arg "rx" will be 2.
155 rte_kvargs_count(const struct rte_kvargs *kvlist, const char *key_match)
157 const struct rte_kvargs_pair *pair;
161 for (i = 0; i < kvlist->count; i++) {
162 pair = &kvlist->pairs[i];
163 if (key_match == NULL || strcmp(pair->key, key_match) == 0)
171 * For each matching key, call the given handler function.
174 rte_kvargs_process(const struct rte_kvargs *kvlist,
175 const char *key_match,
176 arg_handler_t handler,
179 const struct rte_kvargs_pair *pair;
185 for (i = 0; i < kvlist->count; i++) {
186 pair = &kvlist->pairs[i];
187 if (key_match == NULL || strcmp(pair->key, key_match) == 0) {
188 if ((*handler)(pair->key, pair->value, opaque_arg) < 0)
195 /* free the rte_kvargs structure */
197 rte_kvargs_free(struct rte_kvargs *kvlist)
206 /* Lookup a value in an rte_kvargs list by its key and value. */
208 rte_kvargs_get_with_value(const struct rte_kvargs *kvlist, const char *key,
215 for (i = 0; i < kvlist->count; ++i) {
216 if (key != NULL && strcmp(kvlist->pairs[i].key, key) != 0)
218 if (value != NULL && strcmp(kvlist->pairs[i].value, value) != 0)
220 return kvlist->pairs[i].value;
225 /* Lookup a value in an rte_kvargs list by its key. */
227 rte_kvargs_get(const struct rte_kvargs *kvlist, const char *key)
229 if (kvlist == NULL || key == NULL)
231 return rte_kvargs_get_with_value(kvlist, key, NULL);
235 * Parse the arguments "key=value,key=value,..." string and return
236 * an allocated structure that contains a key/value list. Also
237 * check if only valid keys were used.
240 rte_kvargs_parse(const char *args, const char * const valid_keys[])
242 struct rte_kvargs *kvlist;
244 kvlist = malloc(sizeof(*kvlist));
247 memset(kvlist, 0, sizeof(*kvlist));
249 if (rte_kvargs_tokenize(kvlist, args) < 0) {
250 rte_kvargs_free(kvlist);
254 if (valid_keys != NULL && check_for_valid_keys(kvlist, valid_keys) < 0) {
255 rte_kvargs_free(kvlist);
263 rte_kvargs_parse_delim(const char *args, const char * const valid_keys[],
264 const char *valid_ends)
266 struct rte_kvargs *kvlist = NULL;
270 if (valid_ends == NULL)
271 return rte_kvargs_parse(args, valid_keys);
277 len = strcspn(copy, valid_ends);
280 kvlist = rte_kvargs_parse(copy, valid_keys);