lib/librte_cmdline/cmdline.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 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  */
  34
  35 /*
  36  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  37  * All rights reserved.
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions are met:
  40  *
  41  *     * Redistributions of source code must retain the above copyright
  42  *       notice, this list of conditions and the following disclaimer.
  43  *     * Redistributions in binary form must reproduce the above copyright
  44  *       notice, this list of conditions and the following disclaimer in the
  45  *       documentation and/or other materials provided with the distribution.
  46  *     * Neither the name of the University of California, Berkeley nor the
  47  *       names of its contributors may be used to endorse or promote products
  48  *       derived from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  51  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  52  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  53  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  54  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  55  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  56  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  57  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  59  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  60  */
  61
  62 #include <stdio.h>
  63 #include <string.h>
  64 #include <unistd.h>
  65 #include <stdlib.h>
  66 #include <stdarg.h>
  67 #include <inttypes.h>
  68 #include <fcntl.h>
  69 #include <errno.h>
  70 #include <termios.h>
  71 #include <netinet/in.h>
  72
  73 #include <rte_string_fns.h>
  74
  75 #include "cmdline_parse.h"
  76 #include "cmdline_rdline.h"
  77 #include "cmdline.h"
  78
  79 static void
  80 cmdline_valid_buffer(struct rdline *rdl, const char *buf,
  81                      __attribute__((unused)) unsigned int size)
  82 {
  83         struct cmdline *cl = rdl->opaque;
  84         int ret;
  85         ret = cmdline_parse(cl, buf);
  86         if (ret == CMDLINE_PARSE_AMBIGUOUS)
  87                 cmdline_printf(cl, "Ambiguous command\n");
  88         else if (ret == CMDLINE_PARSE_NOMATCH)
  89                 cmdline_printf(cl, "Command not found\n");
  90         else if (ret == CMDLINE_PARSE_BAD_ARGS)
  91                 cmdline_printf(cl, "Bad arguments\n");
  92 }
  93
  94 static int
  95 cmdline_complete_buffer(struct rdline *rdl, const char *buf,
  96                         char *dstbuf, unsigned int dstsize,
  97                         int *state)
  98 {
  99         struct cmdline *cl = rdl->opaque;
 100         return cmdline_complete(cl, buf, state, dstbuf, dstsize);
 101 }
 102
 103 int
 104 cmdline_write_char(struct rdline *rdl, char c)
 105 {
 106         int ret = -1;
 107         struct cmdline *cl;
 108
 109         if (!rdl)
 110                 return -1;
 111
 112         cl = rdl->opaque;
 113
 114         if (cl->s_out >= 0)
 115                 ret = write(cl->s_out, &c, 1);
 116
 117         return ret;
 118 }
 119
 120
 121 void
 122 cmdline_set_prompt(struct cmdline *cl, const char *prompt)
 123 {
 124         if (!cl || !prompt)
 125                 return;
 126         rte_snprintf(cl->prompt, sizeof(cl->prompt), "%s", prompt);
 127 }
 128
 129 struct cmdline *
 130 cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out)
 131 {
 132         struct cmdline *cl;
 133
 134         if (!ctx || !prompt)
 135                 return NULL;
 136
 137         cl = malloc(sizeof(struct cmdline));
 138         if (cl == NULL)
 139                 return NULL;
 140         memset(cl, 0, sizeof(struct cmdline));
 141         cl->s_in = s_in;
 142         cl->s_out = s_out;
 143         cl->ctx = ctx;
 144
 145         rdline_init(&cl->rdl, cmdline_write_char,
 146                     cmdline_valid_buffer, cmdline_complete_buffer);
 147         cl->rdl.opaque = cl;
 148         cmdline_set_prompt(cl, prompt);
 149         rdline_newline(&cl->rdl, cl->prompt);
 150
 151         return cl;
 152 }
 153
 154 void
 155 cmdline_free(struct cmdline *cl)
 156 {
 157         dprintf("called\n");
 158
 159         if (!cl)
 160                 return;
 161
 162         if (cl->s_in > 2)
 163                 close(cl->s_in);
 164         if (cl->s_out != cl->s_in && cl->s_out > 2)
 165                 close(cl->s_out);
 166         free(cl);
 167 }
 168
 169 void
 170 cmdline_printf(const struct cmdline *cl, const char *fmt, ...)
 171 {
 172         va_list ap;
 173
 174         if (!cl || !fmt)
 175                 return;
 176
 177 #ifdef _GNU_SOURCE
 178         if (cl->s_out < 0)
 179                 return;
 180         va_start(ap, fmt);
 181         vdprintf(cl->s_out, fmt, ap);
 182         va_end(ap);
 183 #else
 184         int ret;
 185         char *buf;
 186
 187         if (cl->s_out < 0)
 188                 return;
 189
 190         buf = malloc(BUFSIZ);
 191         if (buf == NULL)
 192                 return;
 193         va_start(ap, fmt);
 194         ret = vsnprintf(buf, BUFSIZ, fmt, ap);
 195         va_end(ap);
 196         if (ret < 0)
 197                 return;
 198         if (ret >= BUFSIZ)
 199                 ret = BUFSIZ - 1;
 200         write(cl->s_out, buf, ret);
 201         free(buf);
 202 #endif
 203 }
 204
 205 int
 206 cmdline_in(struct cmdline *cl, const char *buf, int size)
 207 {
 208         const char *history, *buffer;
 209         size_t histlen, buflen;
 210         int ret = 0;
 211         int i, same;
 212
 213         if (!cl || !buf)
 214                 return -1;
 215
 216         for (i=0; i<size; i++) {
 217                 ret = rdline_char_in(&cl->rdl, buf[i]);
 218
 219                 if (ret == RDLINE_RES_VALIDATED) {
 220                         buffer = rdline_get_buffer(&cl->rdl);
 221                         history = rdline_get_history_item(&cl->rdl, 0);
 222                         if (history) {
 223                                 histlen = strnlen(history, RDLINE_BUF_SIZE);
 224                                 same = !memcmp(buffer, history, histlen) &&
 225                                         buffer[histlen] == '\n';
 226                         }
 227                         else
 228                                 same = 0;
 229                         buflen = strnlen(buffer, RDLINE_BUF_SIZE);
 230                         if (buflen > 1 && !same)
 231                                 rdline_add_history(&cl->rdl, buffer);
 232                         rdline_newline(&cl->rdl, cl->prompt);
 233                 }
 234                 else if (ret == RDLINE_RES_EOF)
 235                         return -1;
 236                 else if (ret == RDLINE_RES_EXITED)
 237                         return -1;
 238         }
 239         return i;
 240 }
 241
 242 void
 243 cmdline_quit(struct cmdline *cl)
 244 {
 245         if (!cl)
 246                 return;
 247         rdline_quit(&cl->rdl);
 248 }
 249
 250 void
 251 cmdline_interact(struct cmdline *cl)
 252 {
 253         char c;
 254
 255         if (!cl)
 256                 return;
 257
 258         c = -1;
 259         while (1) {
 260                 if (read(cl->s_in, &c, 1) < 0)
 261                         break;
 262                 if (cmdline_in(cl, &c, 1) < 0)
 263                         break;
 264         }
 265 }