kvargs: fix invalid token parsing on FreeBSD
[dpdk.git] / lib / librte_kvargs / rte_kvargs.c
index 3acb895..285081c 100644 (file)
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
- *   Copyright(c) 2014 6WIND S.A.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2013 Intel Corporation.
+ * Copyright(c) 2014 6WIND S.A.
  */
+
 #include <string.h>
-#include <sys/user.h>
-#include <linux/binfmts.h>
+#include <stdlib.h>
 
-#include <rte_malloc.h>
-#include <rte_log.h>
 #include <rte_string_fns.h>
 
 #include "rte_kvargs.h"
 
-/*
- * Initialize a rte_kvargs structure to an empty key/value list.
- */
-int
-rte_kvargs_init(struct rte_kvargs *kvlist)
-{
-       kvlist->count = 0;
-       kvlist->size = RTE_KVARGS_MAX;
-       memset(kvlist->pairs, 0, kvlist->size);
-       return 0;
-}
-
-/*
- * Add a key-value pair at the end of a given key/value list.
- * Return an error if the list is full or if the key is duplicated.
- */
-static int
-rte_kvargs_add_pair(struct rte_kvargs *kvlist, char *key, char *val)
-{
-       unsigned i;
-       struct rte_kvargs_pair* entry;
-
-       /* is the list full? */
-       if (kvlist->count >= kvlist->size) {
-               RTE_LOG(ERR, PMD, "Couldn't add %s, key/value list is full\n", key);
-               return -1;
-       }
-
-       /* Check if the key is duplicated */
-       for (i = 0; i < kvlist->count; i++) {
-               entry = &kvlist->pairs[i];
-               if (strcmp(entry->key, key) == 0) {
-                       RTE_LOG(ERR, PMD, "Couldn't add %s, duplicated key\n", key);
-                       return -1;
-               }
-       }
-
-       entry = &kvlist->pairs[kvlist->count];
-       entry->key = key;
-       entry->value = val;
-       kvlist->count++;
-       return 0;
-}
-
 /*
  * Receive a string with a list of arguments following the pattern
- * key=value;key=value;... and insert them into the list.
+ * key=value,key=value,... and insert them into the list.
  * strtok() is used so the params string will be copied to be modified.
  */
 static int
-rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *name,
-       const char *params)
+rte_kvargs_tokenize(struct rte_kvargs *kvlist, const char *params)
 {
-       unsigned i, count;
-       char *args;
-       char *pairs[RTE_KVARGS_MAX];
-       char *pair[2];
-
-       /* If params are empty, nothing to do */
-       if (params == NULL || params[0] == 0) {
-               RTE_LOG(ERR, PMD, "Couldn't parse %s device, empty arguments\n", name);
-               return -1;
-       }
+       unsigned i;
+       char *str;
+       char *ctx1 = NULL;
+       char *ctx2 = NULL;
 
        /* Copy the const char *params to a modifiable string
         * to pass to rte_strsplit
         */
-       args = strdup(params);
-       if(args == NULL){
-               RTE_LOG(ERR, PMD, "Couldn't parse %s device \n", name);
+       kvlist->str = strdup(params);
+       if (kvlist->str == NULL)
                return -1;
-       }
 
-       count = rte_strsplit(args, strnlen(args, MAX_ARG_STRLEN), pairs,
-                       RTE_KVARGS_MAX, RTE_KVARGS_PAIRS_DELIM);
+       /* browse each key/value pair and add it in kvlist */
+       str = kvlist->str;
+       while ((str = strtok_r(str, RTE_KVARGS_PAIRS_DELIM, &ctx1)) != NULL) {
 
-       for (i = 0; i < count; i++) {
-               pair[0] = NULL;
-               pair[1] = NULL;
+               i = kvlist->count;
+               if (i >= RTE_KVARGS_MAX)
+                       return -1;
 
-               rte_strsplit(pairs[i], strnlen(pairs[i], MAX_ARG_STRLEN), pair, 2,
-                               RTE_KVARGS_KV_DELIM);
+               kvlist->pairs[i].key = strtok_r(str, RTE_KVARGS_KV_DELIM, &ctx2);
+               kvlist->pairs[i].value = strtok_r(NULL, RTE_KVARGS_KV_DELIM, &ctx2);
+               if (kvlist->pairs[i].key == NULL ||
+                   kvlist->pairs[i].value == NULL)
+                       return -1;
 
-               if (pair[0] == NULL || pair[1] == NULL || pair[0][0] == 0
-                               || pair[1][0] == 0) {
-                       RTE_LOG(ERR, PMD,
-                                       "Couldn't parse %s device, wrong key or value \n", name);
-                       goto error;
+               /* Detect list [a,b] to skip comma delimiter in list. */
+               str = kvlist->pairs[i].value;
+               if (str[0] == '[') {
+                       /* Find the end of the list. */
+                       while (str[strlen(str) - 1] != ']') {
+                               /* Restore the comma erased by strtok_r(). */
+                               if (ctx1 == NULL || ctx1[0] == '\0')
+                                       return -1; /* no closing bracket */
+                               str[strlen(str)] = ',';
+                               /* Parse until next comma. */
+                               str = strtok_r(NULL, RTE_KVARGS_PAIRS_DELIM, &ctx1);
+                               if (str == NULL)
+                                       return -1; /* no closing bracket */
+                       }
                }
 
-               if (rte_kvargs_add_pair(kvlist, pair[0], pair[1]) < 0)
-                       goto error;
+               kvlist->count++;
+               str = NULL;
        }
-       return 0;
 
-error:
-       rte_free(args);
-       return -1;
+       return 0;
 }
 
 /*
@@ -146,13 +72,14 @@ error:
  * into a list of valid keys.
  */
 static int
-is_valid_key(const char *valid[], const char *key_match)
+is_valid_key(const char * const valid[], const char *key_match)
 {
-       const char **valid_ptr;
+       const char * const *valid_ptr;
 
-       for (valid_ptr = valid; *valid_ptr != NULL; valid_ptr++)
-               if (strstr(key_match, *valid_ptr) != NULL)
+       for (valid_ptr = valid; *valid_ptr != NULL; valid_ptr++) {
+               if (strcmp(key_match, *valid_ptr) == 0)
                        return 1;
+       }
        return 0;
 }
 
@@ -162,7 +89,7 @@ is_valid_key(const char *valid[], const char *key_match)
  */
 static int
 check_for_valid_keys(struct rte_kvargs *kvlist,
-               const char *valid[])
+               const char * const valid[])
 {
        unsigned i, ret;
        struct rte_kvargs_pair *pair;
@@ -170,12 +97,8 @@ check_for_valid_keys(struct rte_kvargs *kvlist,
        for (i = 0; i < kvlist->count; i++) {
                pair = &kvlist->pairs[i];
                ret = is_valid_key(valid, pair->key);
-               if (!ret) {
-                       RTE_LOG(ERR, PMD,
-                               "Error parsing device, invalid key <%s>\n",
-                               pair->key);
+               if (!ret)
                        return -1;
-               }
        }
        return 0;
 }
@@ -194,7 +117,7 @@ rte_kvargs_count(const struct rte_kvargs *kvlist, const char *key_match)
        ret = 0;
        for (i = 0; i < kvlist->count; i++) {
                pair = &kvlist->pairs[i];
-               if (strcmp(pair->key, key_match) == 0)
+               if (key_match == NULL || strcmp(pair->key, key_match) == 0)
                        ret++;
        }
 
@@ -213,36 +136,87 @@ rte_kvargs_process(const struct rte_kvargs *kvlist,
        const struct rte_kvargs_pair *pair;
        unsigned i;
 
+       if (kvlist == NULL)
+               return 0;
+
        for (i = 0; i < kvlist->count; i++) {
                pair = &kvlist->pairs[i];
-               if (strstr(pair->key, key_match) != NULL) {
-                       if ((*handler)(pair->value, opaque_arg) < 0)
+               if (key_match == NULL || strcmp(pair->key, key_match) == 0) {
+                       if ((*handler)(pair->key, pair->value, opaque_arg) < 0)
                                return -1;
                }
        }
        return 0;
 }
 
+/* free the rte_kvargs structure */
+void
+rte_kvargs_free(struct rte_kvargs *kvlist)
+{
+       if (!kvlist)
+               return;
+
+       free(kvlist->str);
+       free(kvlist);
+}
+
 /*
- * Parse the arguments "key=value;key=value;..." string and return
+ * Parse the arguments "key=value,key=value,..." string and return
  * an allocated structure that contains a key/value list. Also
  * check if only valid keys were used.
  */
-int
-rte_kvargs_parse(struct rte_kvargs *kvlist,
-               const char *name,
-               const char *args,
-               const char *valid_keys[])
+struct rte_kvargs *
+rte_kvargs_parse(const char *args, const char * const valid_keys[])
 {
+       struct rte_kvargs *kvlist;
 
-       int ret;
+       kvlist = malloc(sizeof(*kvlist));
+       if (kvlist == NULL)
+               return NULL;
+       memset(kvlist, 0, sizeof(*kvlist));
 
-       ret = rte_kvargs_tokenize(kvlist, name, args);
-       if (ret < 0)
-               return ret;
+       if (rte_kvargs_tokenize(kvlist, args) < 0) {
+               rte_kvargs_free(kvlist);
+               return NULL;
+       }
 
-       if (valid_keys == NULL)
-               return 0;
+       if (valid_keys != NULL && check_for_valid_keys(kvlist, valid_keys) < 0) {
+               rte_kvargs_free(kvlist);
+               return NULL;
+       }
+
+       return kvlist;
+}
+
+struct rte_kvargs *
+rte_kvargs_parse_delim(const char *args, const char * const valid_keys[],
+                      const char *valid_ends)
+{
+       struct rte_kvargs *kvlist = NULL;
+       char *copy;
+       size_t len;
+
+       if (valid_ends == NULL)
+               return rte_kvargs_parse(args, valid_keys);
+
+       copy = strdup(args);
+       if (copy == NULL)
+               return NULL;
+
+       len = strcspn(copy, valid_ends);
+       copy[len] = '\0';
+
+       kvlist = rte_kvargs_parse(copy, valid_keys);
+
+       free(copy);
+       return kvlist;
+}
+
+int
+rte_kvargs_strcmp(const char *key __rte_unused,
+                 const char *value, void *opaque)
+{
+       const char *str = opaque;
 
-       return check_for_valid_keys(kvlist, valid_keys);
+       return -abs(strcmp(str, value));
 }