cmdline: fix dynamic tokens initialization
[dpdk.git] / lib / librte_cmdline / cmdline_parse.c
index f9d46ca..67e452d 100644 (file)
@@ -1,36 +1,34 @@
 /*-
  *   BSD LICENSE
- * 
- *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
+ *
+ *   Copyright(c) 2010-2014 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 
+ *
+ *   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 
+ *
+ *     * 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 
+ *     * 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 
+ *     * 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 
+ *
+ *   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.
- * 
- *  version: DPDK.L.1.2.3-3
  */
 
 /*
@@ -120,12 +118,20 @@ cmdline_isendoftoken(char c)
        return 0;
 }
 
+int
+cmdline_isendofcommand(char c)
+{
+       if (!c || iscomment(c) || isendofline(c))
+               return 1;
+       return 0;
+}
+
 static unsigned int
 nb_common_chars(const char * s1, const char * s2)
 {
        unsigned int i=0;
 
-       while (*s1==*s2 && *s1 && *s2) {
+       while (*s1==*s2 && *s1) {
                s1++;
                s2++;
                i++;
@@ -133,6 +139,32 @@ nb_common_chars(const char * s1, const char * s2)
        return i;
 }
 
+/** Retrieve either static or dynamic token at a given index. */
+static cmdline_parse_token_hdr_t *
+get_token(cmdline_parse_inst_t *inst,
+         unsigned int index,
+         cmdline_parse_token_hdr_t
+               *(*dyn_tokens)[CMDLINE_PARSE_DYNAMIC_TOKENS])
+{
+       /* check presence of static tokens first */
+       if (inst->tokens[0] || !inst->f)
+               return inst->tokens[index];
+       /* for dynamic tokens, make sure index does not overflow */
+       if (index >= CMDLINE_PARSE_DYNAMIC_TOKENS - 1)
+               return NULL;
+       /* in case token is already generated, return it */
+       if ((*dyn_tokens)[index])
+               return (*dyn_tokens)[index];
+       /* generate token */
+       inst->f(&(*dyn_tokens)[index], NULL, dyn_tokens);
+       /* return immediately if there are no more tokens to expect */
+       if (!(*dyn_tokens)[index])
+               return NULL;
+       /* terminate list with a NULL entry */
+       (*dyn_tokens)[index + 1] = NULL;
+       return (*dyn_tokens)[index];
+}
+
 /**
  * try to match the buffer with an instruction (only the first
  * nb_match_token tokens if != 0). Return 0 if we match all the
@@ -140,7 +172,9 @@ nb_common_chars(const char * s1, const char * s2)
  */
 static int
 match_inst(cmdline_parse_inst_t *inst, const char *buf,
-          unsigned int nb_match_token, void * result_buf)
+          unsigned int nb_match_token, void *resbuf, unsigned resbuf_size,
+          cmdline_parse_token_hdr_t
+               *(*dyn_tokens)[CMDLINE_PARSE_DYNAMIC_TOKENS])
 {
        unsigned int token_num=0;
        cmdline_parse_token_hdr_t * token_p;
@@ -148,7 +182,7 @@ match_inst(cmdline_parse_inst_t *inst, const char *buf,
        int n = 0;
        struct cmdline_token_hdr token_hdr;
 
-       token_p = inst->tokens[token_num];
+       token_p = get_token(inst, token_num, dyn_tokens);
        if (token_p)
                memcpy(&token_hdr, token_p, sizeof(token_hdr));
 
@@ -164,12 +198,23 @@ match_inst(cmdline_parse_inst_t *inst, const char *buf,
                if ( isendofline(*buf) || iscomment(*buf) )
                        break;
 
-               if (result_buf)
-                       n = token_hdr.ops->parse(token_p, buf,
-                                                (char *)result_buf +
-                                                token_hdr.offset);
-               else
-                       n = token_hdr.ops->parse(token_p, buf, NULL);
+               if (resbuf == NULL) {
+                       n = token_hdr.ops->parse(token_p, buf, NULL, 0);
+               } else {
+                       unsigned rb_sz;
+
+                       if (token_hdr.offset > resbuf_size) {
+                               printf("Parse error(%s:%d): Token offset(%u) "
+                                       "exceeds maximum size(%u)\n",
+                                       __FILE__, __LINE__,
+                                       token_hdr.offset, resbuf_size);
+                               return -ENOBUFS;
+                       }
+                       rb_sz = resbuf_size - token_hdr.offset;
+
+                       n = token_hdr.ops->parse(token_p, buf, (char *)resbuf +
+                               token_hdr.offset, rb_sz);
+               }
 
                if (n < 0)
                        break;
@@ -179,7 +224,7 @@ match_inst(cmdline_parse_inst_t *inst, const char *buf,
                buf += n;
 
                token_num ++;
-               token_p = inst->tokens[token_num];
+               token_p = get_token(inst, token_num, dyn_tokens);
                if (token_p)
                        memcpy(&token_hdr, token_p, sizeof(token_hdr));
        }
@@ -221,7 +266,11 @@ cmdline_parse(struct cmdline *cl, const char * buf)
        unsigned int inst_num=0;
        cmdline_parse_inst_t *inst;
        const char *curbuf;
-       char result_buf[BUFSIZ];
+       union {
+               char buf[CMDLINE_PARSE_RESULT_BUFSIZE];
+               long double align; /* strong alignment constraint for buf */
+       } result, tmp_result;
+       cmdline_parse_token_hdr_t *dyn_tokens[CMDLINE_PARSE_DYNAMIC_TOKENS];
        void (*f)(void *, struct cmdline *, void *) = NULL;
        void *data = NULL;
        int comment = 0;
@@ -229,11 +278,16 @@ cmdline_parse(struct cmdline *cl, const char * buf)
        int parse_it = 0;
        int err = CMDLINE_PARSE_NOMATCH;
        int tok;
-       cmdline_parse_ctx_t *ctx = cl->ctx;
+       cmdline_parse_ctx_t *ctx;
 #ifdef RTE_LIBRTE_CMDLINE_DEBUG
        char debug_buf[BUFSIZ];
 #endif
 
+       if (!cl || !buf)
+               return CMDLINE_PARSE_BAD_ARGS;
+
+       ctx = cl->ctx;
+
        /*
         * - look if the buffer contains at least one line
         * - look if line contains only spaces or comments
@@ -267,23 +321,27 @@ cmdline_parse(struct cmdline *cl, const char * buf)
        }
 
 #ifdef RTE_LIBRTE_CMDLINE_DEBUG
-       rte_snprintf(debug_buf, (linelen>64 ? 64 : linelen), "%s", buf);
+       snprintf(debug_buf, (linelen>64 ? 64 : linelen), "%s", buf);
        debug_printf("Parse line : len=%d, <%s>\n", linelen, debug_buf);
 #endif
 
        /* parse it !! */
        inst = ctx[inst_num];
+       dyn_tokens[0] = NULL;
        while (inst) {
                debug_printf("INST %d\n", inst_num);
 
                /* fully parsed */
-               tok = match_inst(inst, buf, 0, result_buf);
+               tok = match_inst(inst, buf, 0, tmp_result.buf,
+                                sizeof(tmp_result.buf), &dyn_tokens);
 
                if (tok > 0) /* we matched at least one token */
                        err = CMDLINE_PARSE_BAD_ARGS;
 
                else if (!tok) {
                        debug_printf("INST fully parsed\n");
+                       memcpy(&result, &tmp_result,
+                              sizeof(result));
                        /* skip spaces */
                        while (isblank2(*curbuf)) {
                                curbuf++;
@@ -307,11 +365,12 @@ cmdline_parse(struct cmdline *cl, const char * buf)
 
                inst_num ++;
                inst = ctx[inst_num];
+               dyn_tokens[0] = NULL;
        }
 
        /* call func */
        if (f) {
-               f(result_buf, cl, data);
+               f(result.buf, cl, data);
        }
 
        /* no match */
@@ -333,6 +392,7 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
        cmdline_parse_token_hdr_t *token_p;
        struct cmdline_token_hdr token_hdr;
        char tmpbuf[CMDLINE_BUFFER_SIZE], comp_buf[CMDLINE_BUFFER_SIZE];
+       cmdline_parse_token_hdr_t *dyn_tokens[CMDLINE_PARSE_DYNAMIC_TOKENS];
        unsigned int partial_tok_len;
        int comp_len = -1;
        int tmp_len = -1;
@@ -343,7 +403,12 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
        unsigned int nb_non_completable;
        int local_state = 0;
        const char *help_str;
-       cmdline_parse_ctx_t *ctx = cl->ctx;
+       cmdline_parse_ctx_t *ctx;
+
+       if (!cl || !buf || !state || !dst)
+               return -1;
+
+       ctx = cl->ctx;
 
        debug_printf("%s called\n", __func__);
        memset(&token_hdr, 0, sizeof(token_hdr));
@@ -367,13 +432,16 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
                nb_non_completable = 0;
 
                inst = ctx[inst_num];
+               dyn_tokens[0] = NULL;
                while (inst) {
                        /* parse the first tokens of the inst */
-                       if (nb_token && match_inst(inst, buf, nb_token, NULL))
+                       if (nb_token &&
+                           match_inst(inst, buf, nb_token, NULL, 0,
+                                      &dyn_tokens))
                                goto next;
 
-                       debug_printf("instruction match \n");
-                       token_p = inst->tokens[nb_token];
+                       debug_printf("instruction match\n");
+                       token_p = get_token(inst, nb_token, &dyn_tokens);
                        if (token_p)
                                memcpy(&token_hdr, token_p, sizeof(token_hdr));
 
@@ -407,7 +475,7 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
                                if (!strncmp(partial_tok, tmpbuf,
                                             partial_tok_len)) {
                                        if (comp_len == -1) {
-                                               rte_snprintf(comp_buf, sizeof(comp_buf),
+                                               snprintf(comp_buf, sizeof(comp_buf),
                                                         "%s", tmpbuf + partial_tok_len);
                                                comp_len =
                                                        strnlen(tmpbuf + partial_tok_len,
@@ -424,8 +492,10 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
                                }
                        }
                next:
+                       debug_printf("next\n");
                        inst_num ++;
                        inst = ctx[inst_num];
+                       dyn_tokens[0] = NULL;
                }
 
                debug_printf("total choices %d for this completion\n",
@@ -443,7 +513,7 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
                                if ((unsigned)(comp_len + 1) > size)
                                        return 0;
 
-                               rte_snprintf(dst, size, "%s", comp_buf);
+                               snprintf(dst, size, "%s", comp_buf);
                                dst[comp_len] = 0;
                                return 2;
                        }
@@ -458,14 +528,16 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
 
        inst_num = 0;
        inst = ctx[inst_num];
+       dyn_tokens[0] = NULL;
        while (inst) {
                /* we need to redo it */
                inst = ctx[inst_num];
 
-               if (nb_token && match_inst(inst, buf, nb_token, NULL))
+               if (nb_token &&
+                   match_inst(inst, buf, nb_token, NULL, 0, &dyn_tokens))
                        goto next2;
 
-               token_p = inst->tokens[nb_token];
+               token_p = get_token(inst, nb_token, &dyn_tokens);
                if (token_p)
                        memcpy(&token_hdr, token_p, sizeof(token_hdr));
 
@@ -484,14 +556,14 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
                                                        sizeof(tmpbuf));
                                help_str = inst->help_str;
                                if (help_str)
-                                       rte_snprintf(dst, size, "[%s]: %s", tmpbuf,
+                                       snprintf(dst, size, "[%s]: %s", tmpbuf,
                                                 help_str);
                                else
-                                       rte_snprintf(dst, size, "[%s]: No help",
+                                       snprintf(dst, size, "[%s]: No help",
                                                 tmpbuf);
                        }
                        else {
-                               rte_snprintf(dst, size, "[RETURN]");
+                               snprintf(dst, size, "[RETURN]");
                        }
                        return 1;
                }
@@ -519,16 +591,16 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
                                        continue;
                                }
                                (*state)++;
-                               l=rte_snprintf(dst, size, "%s", tmpbuf);
+                               l=snprintf(dst, size, "%s", tmpbuf);
                                if (l>=0 && token_hdr.ops->get_help) {
                                        token_hdr.ops->get_help(token_p, tmpbuf,
                                                                sizeof(tmpbuf));
                                        help_str = inst->help_str;
                                        if (help_str)
-                                               rte_snprintf(dst+l, size-l, "[%s]: %s",
+                                               snprintf(dst+l, size-l, "[%s]: %s",
                                                         tmpbuf, help_str);
                                        else
-                                               rte_snprintf(dst+l, size-l,
+                                               snprintf(dst+l, size-l,
                                                         "[%s]: No help", tmpbuf);
                                }
 
@@ -538,7 +610,7 @@ cmdline_complete(struct cmdline *cl, const char *buf, int *state,
        next2:
                inst_num ++;
                inst = ctx[inst_num];
+               dyn_tokens[0] = NULL;
        }
        return 0;
 }
-