lib/librte_cmdline/cmdline_parse_string.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  *  version: DPDK.L.1.2.3-3
  34  */
  35
  36 /*
  37  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  38  * All rights reserved.
  39  * Redistribution and use in source and binary forms, with or without
  40  * modification, are permitted provided that the following conditions are met:
  41  *
  42  *     * Redistributions of source code must retain the above copyright
  43  *       notice, this list of conditions and the following disclaimer.
  44  *     * Redistributions in binary form must reproduce the above copyright
  45  *       notice, this list of conditions and the following disclaimer in the
  46  *       documentation and/or other materials provided with the distribution.
  47  *     * Neither the name of the University of California, Berkeley nor the
  48  *       names of its contributors may be used to endorse or promote products
  49  *       derived from this software without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  52  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  53  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  54  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  55  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  56  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  57  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  58  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  60  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  */
  62
  63 #include <stdio.h>
  64 #include <inttypes.h>
  65 #include <ctype.h>
  66 #include <string.h>
  67 #include <stdarg.h>
  68 #include <errno.h>
  69 #include <rte_string_fns.h>
  70
  71 #include "cmdline_parse.h"
  72 #include "cmdline_parse_string.h"
  73
  74 struct cmdline_token_ops cmdline_token_string_ops = {
  75         .parse = cmdline_parse_string,
  76         .complete_get_nb = cmdline_complete_get_nb_string,
  77         .complete_get_elt = cmdline_complete_get_elt_string,
  78         .get_help = cmdline_get_help_string,
  79 };
  80
  81 #define MULTISTRING_HELP "Mul-choice STRING"
  82 #define ANYSTRING_HELP   "Any STRING"
  83 #define FIXEDSTRING_HELP "Fixed STRING"
  84
  85 static unsigned int
  86 get_token_len(const char *s)
  87 {
  88         char c;
  89         unsigned int i=0;
  90
  91         c = s[i];
  92         while (c!='#' && c!='\0') {
  93                 i++;
  94                 c = s[i];
  95         }
  96         return i;
  97 }
  98
  99 static const char *
 100 get_next_token(const char *s)
 101 {
 102         unsigned int i;
 103         i = get_token_len(s);
 104         if (s[i] == '#')
 105                 return s+i+1;
 106         return NULL;
 107 }
 108
 109 int
 110 cmdline_parse_string(cmdline_parse_token_hdr_t *tk, const char *buf, void *res)
 111 {
 112         struct cmdline_token_string *tk2 = (struct cmdline_token_string *)tk;
 113         struct cmdline_token_string_data *sd = &tk2->string_data;
 114         unsigned int token_len;
 115         const char *str;
 116
 117         if (! *buf)
 118                 return -1;
 119
 120         /* fixed string */
 121         if (sd->str) {
 122                 str = sd->str;
 123                 do {
 124                         token_len = get_token_len(str);
 125
 126                         /* if token is too big... */
 127                         if (token_len >= STR_TOKEN_SIZE - 1) {
 128                                 continue;
 129                         }
 130
 131                         if ( strncmp(buf, str, token_len) ) {
 132                                 continue;
 133                         }
 134
 135                         if ( !cmdline_isendoftoken(*(buf+token_len)) ) {
 136                                 continue;
 137                         }
 138
 139                         break;
 140                 } while ( (str = get_next_token(str)) != NULL );
 141
 142                 if (!str)
 143                         return -1;
 144         }
 145         /* unspecified string */
 146         else {
 147                 token_len=0;
 148                 while(!cmdline_isendoftoken(buf[token_len]) &&
 149                       token_len < (STR_TOKEN_SIZE-1))
 150                         token_len++;
 151
 152                 /* return if token too long */
 153                 if (token_len >= STR_TOKEN_SIZE - 1) {
 154                         return -1;
 155                 }
 156         }
 157
 158         if (res) {
 159                 /* we are sure that token_len is < STR_TOKEN_SIZE-1 */
 160                 rte_snprintf(res, STR_TOKEN_SIZE, "%s", buf);
 161                 *((char *)res + token_len) = 0;
 162         }
 163
 164         return token_len;
 165 }
 166
 167 int cmdline_complete_get_nb_string(cmdline_parse_token_hdr_t *tk)
 168 {
 169         struct cmdline_token_string *tk2 = (struct cmdline_token_string *)tk;
 170         struct cmdline_token_string_data *sd = &tk2->string_data;;
 171         int ret=1;
 172         const char *str;
 173
 174         if (!sd->str)
 175                 return 0;
 176
 177         str = sd->str;
 178         while( (str = get_next_token(str)) != NULL ) {
 179                 ret++;
 180         }
 181         return ret;
 182 }
 183
 184 int cmdline_complete_get_elt_string(cmdline_parse_token_hdr_t *tk, int idx,
 185                                     char *dstbuf, unsigned int size)
 186 {
 187         struct cmdline_token_string *tk2 = (struct cmdline_token_string *)tk;
 188         struct cmdline_token_string_data *sd = &tk2->string_data;;
 189         const char *s;
 190         unsigned int len;
 191
 192         s = sd->str;
 193
 194         while (idx-- && s)
 195                 s = get_next_token(s);
 196
 197         if (!s)
 198                 return -1;
 199
 200         len = get_token_len(s);
 201         if (len > size - 1)
 202                 return -1;
 203
 204         memcpy(dstbuf, s, len);
 205         dstbuf[len] = '\0';
 206         return 0;
 207 }
 208
 209
 210 int cmdline_get_help_string(cmdline_parse_token_hdr_t *tk, char *dstbuf,
 211                             unsigned int size)
 212 {
 213         struct cmdline_token_string *tk2 = (struct cmdline_token_string *)tk;
 214         struct cmdline_token_string_data *sd = &tk2->string_data;;
 215         const char *s;
 216
 217         s = sd->str;
 218
 219         if (s) {
 220                 if (get_next_token(s))
 221                         rte_snprintf(dstbuf, size, MULTISTRING_HELP);
 222                 else
 223                         rte_snprintf(dstbuf, size, FIXEDSTRING_HELP);
 224         } else
 225                 rte_snprintf(dstbuf, size, ANYSTRING_HELP);
 226
 227         return 0;
 228 }