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 <poll.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         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         int ret;
 134
 135         if (!ctx || !prompt)
 136                 return NULL;
 137
 138         cl = malloc(sizeof(struct cmdline));
 139         if (cl == NULL)
 140                 return NULL;
 141         memset(cl, 0, sizeof(struct cmdline));
 142         cl->s_in = s_in;
 143         cl->s_out = s_out;
 144         cl->ctx = ctx;
 145
 146         ret = rdline_init(&cl->rdl, cmdline_write_char, cmdline_valid_buffer,
 147                         cmdline_complete_buffer);
 148         if (ret != 0) {
 149                 free(cl);
 150                 return NULL;
 151         }
 152
 153         cl->rdl.opaque = cl;
 154         cmdline_set_prompt(cl, prompt);
 155         rdline_newline(&cl->rdl, cl->prompt);
 156
 157         return cl;
 158 }
 159
 160 void
 161 cmdline_free(struct cmdline *cl)
 162 {
 163         dprintf("called\n");
 164
 165         if (!cl)
 166                 return;
 167
 168         if (cl->s_in > 2)
 169                 close(cl->s_in);
 170         if (cl->s_out != cl->s_in && cl->s_out > 2)
 171                 close(cl->s_out);
 172         free(cl);
 173 }
 174
 175 void
 176 cmdline_printf(const struct cmdline *cl, const char *fmt, ...)
 177 {
 178         va_list ap;
 179
 180         if (!cl || !fmt)
 181                 return;
 182
 183 #ifdef _GNU_SOURCE
 184         if (cl->s_out < 0)
 185                 return;
 186         va_start(ap, fmt);
 187         vdprintf(cl->s_out, fmt, ap);
 188         va_end(ap);
 189 #else
 190         int ret;
 191         char *buf;
 192
 193         if (cl->s_out < 0)
 194                 return;
 195
 196         buf = malloc(BUFSIZ);
 197         if (buf == NULL)
 198                 return;
 199         va_start(ap, fmt);
 200         ret = vsnprintf(buf, BUFSIZ, fmt, ap);
 201         va_end(ap);
 202         if (ret < 0) {
 203                 free(buf);
 204                 return;
 205         }
 206         if (ret >= BUFSIZ)
 207                 ret = BUFSIZ - 1;
 208         ret = write(cl->s_out, buf, ret);
 209         (void)ret;
 210         free(buf);
 211 #endif
 212 }
 213
 214 int
 215 cmdline_in(struct cmdline *cl, const char *buf, int size)
 216 {
 217         const char *history, *buffer;
 218         size_t histlen, buflen;
 219         int ret = 0;
 220         int i, same;
 221
 222         if (!cl || !buf)
 223                 return -1;
 224
 225         for (i=0; i<size; i++) {
 226                 ret = rdline_char_in(&cl->rdl, buf[i]);
 227
 228                 if (ret == RDLINE_RES_VALIDATED) {
 229                         buffer = rdline_get_buffer(&cl->rdl);
 230                         history = rdline_get_history_item(&cl->rdl, 0);
 231                         if (history) {
 232                                 histlen = strnlen(history, RDLINE_BUF_SIZE);
 233                                 same = !memcmp(buffer, history, histlen) &&
 234                                         buffer[histlen] == '\n';
 235                         }
 236                         else
 237                                 same = 0;
 238                         buflen = strnlen(buffer, RDLINE_BUF_SIZE);
 239                         if (buflen > 1 && !same)
 240                                 rdline_add_history(&cl->rdl, buffer);
 241                         rdline_newline(&cl->rdl, cl->prompt);
 242                 }
 243                 else if (ret == RDLINE_RES_EOF)
 244                         return -1;
 245                 else if (ret == RDLINE_RES_EXITED)
 246                         return -1;
 247         }
 248         return i;
 249 }
 250
 251 void
 252 cmdline_quit(struct cmdline *cl)
 253 {
 254         if (!cl)
 255                 return;
 256         rdline_quit(&cl->rdl);
 257 }
 258
 259 int
 260 cmdline_poll(struct cmdline *cl)
 261 {
 262         struct pollfd pfd;
 263         int status;
 264         ssize_t read_status;
 265         char c;
 266
 267         if (!cl)
 268                 return -EINVAL;
 269         else if (cl->rdl.status == RDLINE_EXITED)
 270                 return RDLINE_EXITED;
 271
 272         pfd.fd = cl->s_in;
 273         pfd.events = POLLIN;
 274         pfd.revents = 0;
 275
 276         status = poll(&pfd, 1, 0);
 277         if (status < 0)
 278                 return status;
 279         else if (status > 0) {
 280                 c = -1;
 281                 read_status = read(cl->s_in, &c, 1);
 282                 if (read_status < 0)
 283                         return read_status;
 284
 285                 status = cmdline_in(cl, &c, 1);
 286                 if (status < 0 && cl->rdl.status != RDLINE_EXITED)
 287                         return status;
 288         }
 289
 290         return cl->rdl.status;
 291 }
 292
 293 void
 294 cmdline_interact(struct cmdline *cl)
 295 {
 296         char c;
 297
 298         if (!cl)
 299                 return;
 300
 301         c = -1;
 302         while (1) {
 303                 if (read(cl->s_in, &c, 1) <= 0)
 304                         break;
 305                 if (cmdline_in(cl, &c, 1) < 0)
 306                         break;
 307         }
 308 }