cmdline: use SPDX tags
[dpdk.git] / lib / librte_cmdline / cmdline_parse_string.c
index 712db1c..abde041 100644 (file)
@@ -1,62 +1,7 @@
-/*-
- *   BSD LICENSE
- * 
- *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
- *   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-2014 Intel Corporation.
  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  * 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 the University of California, Berkeley 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 REGENTS 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 REGENTS AND 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.
  */
 
 #include <stdio.h>
@@ -77,9 +22,10 @@ struct cmdline_token_ops cmdline_token_string_ops = {
        .get_help = cmdline_get_help_string,
 };
 
-#define MULTISTRING_HELP "Mul-choice STRING"
-#define ANYSTRING_HELP   "Any STRING"
-#define FIXEDSTRING_HELP "Fixed STRING"
+#define CHOICESTRING_HELP "Mul-choice STRING"
+#define ANYSTRING_HELP    "Any STRING"
+#define ANYSTRINGS_HELP   "Any STRINGS"
+#define FIXEDSTRING_HELP  "Fixed STRING"
 
 static unsigned int
 get_token_len(const char *s)
@@ -106,13 +52,17 @@ get_next_token(const char *s)
 }
 
 int
-cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
+cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *buf, void *res,
+       unsigned ressize)
 {
        struct cmdline_token_string *tk2;
        struct cmdline_token_string_data *sd;
        unsigned int token_len;
        const char *str;
 
+       if (res && ressize < STR_TOKEN_SIZE)
+               return -1;
+
        if (!tk || !buf || ! *buf)
                return -1;
 
@@ -120,8 +70,8 @@ cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
 
        sd = &tk2->string_data;
 
-       /* fixed string */
-       if (sd->str) {
+       /* fixed string (known single token) */
+       if ((sd->str != NULL) && (strcmp(sd->str, TOKEN_STRING_MULTI) != 0)) {
                str = sd->str;
                do {
                        token_len = get_token_len(str);
@@ -145,7 +95,21 @@ cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
                if (!str)
                        return -1;
        }
-       /* unspecified string */
+       /* multi string */
+       else if (sd->str != NULL) {
+               if (ressize < STR_MULTI_TOKEN_SIZE)
+                       return -1;
+
+               token_len = 0;
+               while (!cmdline_isendofcommand(buf[token_len]) &&
+                     token_len < (STR_MULTI_TOKEN_SIZE - 1))
+                       token_len++;
+
+               /* return if token too long */
+               if (token_len >= (STR_MULTI_TOKEN_SIZE - 1))
+                       return -1;
+       }
+       /* unspecified string (unknown single token) */
        else {
                token_len = 0;
                while(!cmdline_isendoftoken(buf[token_len]) &&
@@ -159,12 +123,16 @@ cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
        }
 
        if (res) {
-               /* we are sure that token_len is < STR_TOKEN_SIZE-1 */
-               rte_snprintf(res, STR_TOKEN_SIZE, "%s", buf);
+               if ((sd->str != NULL) && (strcmp(sd->str, TOKEN_STRING_MULTI) == 0))
+                       /* we are sure that token_len is < STR_MULTI_TOKEN_SIZE-1 */
+                       snprintf(res, STR_MULTI_TOKEN_SIZE, "%s", buf);
+               else
+                       /* we are sure that token_len is < STR_TOKEN_SIZE-1 */
+                       snprintf(res, STR_TOKEN_SIZE, "%s", buf);
+
                *((char *)res + token_len) = 0;
        }
 
-
        return token_len;
 }
 
@@ -239,12 +207,14 @@ int cmdline_get_help_string(cmdline_parse_token_hdr_t *tk, char *dstbuf,
        s = sd->str;
 
        if (s) {
-               if (get_next_token(s))
-                       rte_snprintf(dstbuf, size, MULTISTRING_HELP);
+               if (strcmp(s, TOKEN_STRING_MULTI) == 0)
+                       snprintf(dstbuf, size, ANYSTRINGS_HELP);
+               else if (get_next_token(s))
+                       snprintf(dstbuf, size, CHOICESTRING_HELP);
                else
-                       rte_snprintf(dstbuf, size, FIXEDSTRING_HELP);
+                       snprintf(dstbuf, size, FIXEDSTRING_HELP);
        } else
-               rte_snprintf(dstbuf, size, ANYSTRING_HELP);
+               snprintf(dstbuf, size, ANYSTRING_HELP);
 
        return 0;
 }