lib/librte_cmdline/cmdline.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  */
  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 = rdl->opaque;
 108
 109         if (cl->s_out >= 0)
 110                 ret = write(cl->s_out, &c, 1);
 111
 112         return ret;
 113 }
 114
 115
 116 void
 117 cmdline_set_prompt(struct cmdline *cl, const char *prompt)
 118 {
 119         rte_snprintf(cl->prompt, sizeof(cl->prompt), "%s", prompt);
 120 }
 121
 122 struct cmdline *
 123 cmdline_new(cmdline_parse_ctx_t *ctx, const char *prompt, int s_in, int s_out)
 124 {
 125         struct cmdline *cl;
 126         cl = malloc(sizeof(struct cmdline));
 127         if (cl == NULL)
 128                 return NULL;
 129         memset(cl, 0, sizeof(struct cmdline));
 130         cl->s_in = s_in;
 131         cl->s_out = s_out;
 132         cl->ctx = ctx;
 133
 134         rdline_init(&cl->rdl, cmdline_write_char,
 135                     cmdline_valid_buffer, cmdline_complete_buffer);
 136         cl->rdl.opaque = cl;
 137         cmdline_set_prompt(cl, prompt);
 138         rdline_newline(&cl->rdl, cl->prompt);
 139
 140         return cl;
 141 }
 142
 143 void
 144 cmdline_free(struct cmdline *cl)
 145 {
 146         dprintf("called\n");
 147         if (cl->s_in > 2)
 148                 close(cl->s_in);
 149         if (cl->s_out != cl->s_in && cl->s_out > 2)
 150                 close(cl->s_out);
 151         free(cl);
 152 }
 153
 154 void
 155 cmdline_printf(const struct cmdline *cl, const char *fmt, ...)
 156 {
 157         va_list ap;
 158
 159 #ifdef _GNU_SOURCE
 160         if (cl->s_out < 0)
 161                 return;
 162         va_start(ap, fmt);
 163         vdprintf(cl->s_out, fmt, ap);
 164         va_end(ap);
 165 #else
 166         int ret;
 167         char *buf;
 168
 169         if (cl->s_out < 0)
 170                 return;
 171
 172         buf = malloc(BUFSIZ);
 173         if (buf == NULL)
 174                 return;
 175         va_start(ap, fmt);
 176         ret = vsnprintf(buf, BUFSIZ, fmt, ap);
 177         va_end(ap);
 178         if (ret < 0)
 179                 return;
 180         if (ret >= BUFSIZ)
 181                 ret = BUFSIZ - 1;
 182         write(cl->s_out, buf, ret);
 183         free(buf);
 184 #endif
 185 }
 186
 187 int
 188 cmdline_in(struct cmdline *cl, const char *buf, int size)
 189 {
 190         const char *history, *buffer;
 191         size_t histlen, buflen;
 192         int ret = 0;
 193         int i, same;
 194
 195         for (i=0; i<size; i++) {
 196                 ret = rdline_char_in(&cl->rdl, buf[i]);
 197
 198                 if (ret == RDLINE_RES_VALIDATED) {
 199                         buffer = rdline_get_buffer(&cl->rdl);
 200                         history = rdline_get_history_item(&cl->rdl, 0);
 201                         if (history) {
 202                                 histlen = strnlen(history, RDLINE_BUF_SIZE);
 203                                 same = !memcmp(buffer, history, histlen) &&
 204                                         buffer[histlen] == '\n';
 205                         }
 206                         else
 207                                 same = 0;
 208                         buflen = strnlen(buffer, RDLINE_BUF_SIZE);
 209                         if (buflen > 1 && !same)
 210                                 rdline_add_history(&cl->rdl, buffer);
 211                         rdline_newline(&cl->rdl, cl->prompt);
 212                 }
 213                 else if (ret == RDLINE_RES_EOF)
 214                         return -1;
 215                 else if (ret == RDLINE_RES_EXITED)
 216                         return -1;
 217         }
 218         return i;
 219 }
 220
 221 void
 222 cmdline_quit(struct cmdline *cl)
 223 {
 224         rdline_quit(&cl->rdl);
 225 }
 226
 227 void
 228 cmdline_interact(struct cmdline *cl)
 229 {
 230         char c;
 231
 232         c = -1;
 233         while (1) {
 234                 if (read(cl->s_in, &c, 1) < 0)
 235                         break;
 236                 if (cmdline_in(cl, &c, 1) < 0)
 237                         break;
 238         }
 239 }