lib/librte_cmdline/cmdline.c

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