usr.sbin/ngctl/main.c

   1
   2 /*
   3  * main.c
   4  *
   5  * Copyright (c) 1996-1999 Whistle Communications, Inc.
   6  * All rights reserved.
   7  *
   8  * Subject to the following obligations and disclaimer of warranty, use and
   9  * redistribution of this software, in source or object code forms, with or
  10  * without modifications are expressly permitted by Whistle Communications;
  11  * provided, however, that:
  12  * 1. Any and all reproductions of the source or object code must include the
  13  *    copyright notice above and the following disclaimer of warranties; and
  14  * 2. No rights are granted, in any manner or form, to use Whistle
  15  *    Communications, Inc. trademarks, including the mark "WHISTLE
  16  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  17  *    such appears in the above copyright notice or in the software.
  18  *
  19  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  20  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  21  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  22  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  24  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  25  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  26  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  27  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  28  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  29  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  30  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  31  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  34  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  35  * OF SUCH DAMAGE.
  36  *
  37  * $FreeBSD$
  38  * $Whistle: main.c,v 1.12 1999/11/29 19:17:46 archie Exp $
  39  */
  40
  41 #include <sys/param.h>
  42 #include <sys/socket.h>
  43 #include <sys/select.h>
  44
  45 #include <ctype.h>
  46 #include <err.h>
  47 #include <errno.h>
  48 #include <limits.h>
  49 #include <stdio.h>
  50 #include <stdlib.h>
  51 #include <string.h>
  52 #include <sysexits.h>
  53 #include <unistd.h>
  54 #ifdef EDITLINE
  55 #include <signal.h>
  56 #include <histedit.h>
  57 #include <pthread.h>
  58 #endif
  59
  60 #include <netgraph.h>
  61
  62 #include "ngctl.h"
  63
  64 #define PROMPT                  "+ "
  65 #define MAX_ARGS                512
  66 #define WHITESPACE              " \t\r\n\v\f"
  67 #define DUMP_BYTES_PER_LINE     16
  68
  69 /* Internal functions */
  70 static int      ReadFile(FILE *fp);
  71 static void     ReadSockets(fd_set *);
  72 static int      DoParseCommand(const char *line);
  73 static int      DoCommand(int ac, char **av);
  74 static int      DoInteractive(void);
  75 static const    struct ngcmd *FindCommand(const char *string);
  76 static int      MatchCommand(const struct ngcmd *cmd, const char *s);
  77 static void     Usage(const char *msg);
  78 static int      ReadCmd(int ac, char **av);
  79 static int      HelpCmd(int ac, char **av);
  80 static int      QuitCmd(int ac, char **av);
  81 #ifdef EDITLINE
  82 static volatile sig_atomic_t unblock;
  83 static pthread_mutex_t  mutex = PTHREAD_MUTEX_INITIALIZER;
  84 static pthread_cond_t   cond = PTHREAD_COND_INITIALIZER;
  85 #endif
  86
  87 /* List of commands */
  88 static const struct ngcmd *const cmds[] = {
  89         &config_cmd,
  90         &connect_cmd,
  91         &debug_cmd,
  92         &dot_cmd,
  93         &help_cmd,
  94         &list_cmd,
  95         &mkpeer_cmd,
  96         &msg_cmd,
  97         &name_cmd,
  98         &read_cmd,
  99         &rmhook_cmd,
 100         &show_cmd,
 101         &shutdown_cmd,
 102         &status_cmd,
 103         &types_cmd,
 104         &write_cmd,
 105         &quit_cmd,
 106         NULL
 107 };
 108
 109 /* Commands defined in this file */
 110 const struct ngcmd read_cmd = {
 111         ReadCmd,
 112         "read <filename>",
 113         "Read and execute commands from a file",
 114         NULL,
 115         { "source", "." }
 116 };
 117 const struct ngcmd help_cmd = {
 118         HelpCmd,
 119         "help [command]",
 120         "Show command summary or get more help on a specific command",
 121         NULL,
 122         { "?" }
 123 };
 124 const struct ngcmd quit_cmd = {
 125         QuitCmd,
 126         "quit",
 127         "Exit program",
 128         NULL,
 129         { "exit" }
 130 };
 131
 132 /* Our control and data sockets */
 133 int     csock, dsock;
 134
 135 /*
 136  * main()
 137  */
 138 int
 139 main(int ac, char *av[])
 140 {
 141         char    name[NG_NODESIZ];
 142         int     interactive = isatty(0) && isatty(1);
 143         FILE    *fp = NULL;
 144         int     ch, rtn = 0;
 145
 146         /* Set default node name */
 147         snprintf(name, sizeof(name), "ngctl%d", getpid());
 148
 149         /* Parse command line */
 150         while ((ch = getopt(ac, av, "df:n:")) != -1) {
 151                 switch (ch) {
 152                 case 'd':
 153                         NgSetDebug(NgSetDebug(-1) + 1);
 154                         break;
 155                 case 'f':
 156                         if (strcmp(optarg, "-") == 0)
 157                                 fp = stdin;
 158                         else if ((fp = fopen(optarg, "r")) == NULL)
 159                                 err(EX_NOINPUT, "%s", optarg);
 160                         break;
 161                 case 'n':
 162                         snprintf(name, sizeof(name), "%s", optarg);
 163                         break;
 164                 case '?':
 165                 default:
 166                         Usage((char *)NULL);
 167                         break;
 168                 }
 169         }
 170         ac -= optind;
 171         av += optind;
 172
 173         /* Create a new socket node */
 174         if (NgMkSockNode(name, &csock, &dsock) < 0)
 175                 err(EX_OSERR, "can't create node");
 176
 177         /* Do commands as requested */
 178         if (ac == 0) {
 179                 if (fp != NULL) {
 180                         rtn = ReadFile(fp);
 181                 } else if (interactive) {
 182                         rtn = DoInteractive();
 183                 } else
 184                         Usage("no command specified");
 185         } else {
 186                 rtn = DoCommand(ac, av);
 187         }
 188
 189         /* Convert command return code into system exit code */
 190         switch (rtn) {
 191         case CMDRTN_OK:
 192         case CMDRTN_QUIT:
 193                 rtn = 0;
 194                 break;
 195         case CMDRTN_USAGE:
 196                 rtn = EX_USAGE;
 197                 break;
 198         case CMDRTN_ERROR:
 199                 rtn = EX_OSERR;
 200                 break;
 201         }
 202         return (rtn);
 203 }
 204
 205 /*
 206  * Process commands from a file
 207  */
 208 static int
 209 ReadFile(FILE *fp)
 210 {
 211         char line[LINE_MAX];
 212         int num, rtn;
 213
 214         for (num = 1; fgets(line, sizeof(line), fp) != NULL; num++) {
 215                 if (*line == '#')
 216                         continue;
 217                 if ((rtn = DoParseCommand(line)) != 0) {
 218                         warnx("line %d: error in file", num);
 219                         return (rtn);
 220                 }
 221         }
 222         return (CMDRTN_OK);
 223 }
 224
 225 #ifdef EDITLINE
 226 /* Signal handler for Monitor() thread. */
 227 static void
 228 Unblock(int signal)
 229 {
 230
 231         unblock = 1;
 232 }
 233
 234 /*
 235  * Thread that monitors csock and dsock while main thread
 236  * can be blocked in el_gets().
 237  */
 238 static void *
 239 Monitor(void *v)
 240 {
 241         struct sigaction act;
 242         const int maxfd = MAX(csock, dsock) + 1;
 243
 244         act.sa_handler = Unblock;
 245         sigemptyset(&act.sa_mask);
 246         act.sa_flags = 0;
 247         sigaction(SIGUSR1, &act, NULL);
 248
 249         pthread_mutex_lock(&mutex);
 250         for (;;) {
 251                 fd_set rfds;
 252
 253                 /* See if any data or control messages are arriving. */
 254                 FD_ZERO(&rfds);
 255                 FD_SET(csock, &rfds);
 256                 FD_SET(dsock, &rfds);
 257                 unblock = 0;
 258                 if (select(maxfd, &rfds, NULL, NULL, NULL) <= 0) {
 259                         if (errno == EINTR) {
 260                                 if (unblock == 1)
 261                                         pthread_cond_wait(&cond, &mutex);
 262                                 continue;
 263                         }
 264                         err(EX_OSERR, "select");
 265                 }
 266                 ReadSockets(&rfds);
 267         }
 268
 269         return (NULL);
 270 }
 271
 272 static char *
 273 Prompt(EditLine *el)
 274 {
 275
 276         return (PROMPT);
 277 }
 278
 279 /*
 280  * Here we start a thread, that will monitor the netgraph
 281  * sockets and catch any unexpected messages or data on them,
 282  * that can arrive while user edits his/her commands.
 283  *
 284  * Whenever we expect data on netgraph sockets, we send signal
 285  * to monitoring thread. The signal forces it to exit select()
 286  * system call and sleep on condvar until we wake it. While
 287  * monitoring thread sleeps, we can do our work with netgraph
 288  * sockets.
 289  */
 290 static int
 291 DoInteractive(void)
 292 {
 293         pthread_t monitor;
 294         EditLine *el;
 295         History *hist;
 296         HistEvent hev = { 0, "" };
 297
 298         (*help_cmd.func)(0, NULL);
 299         pthread_create(&monitor, NULL, Monitor, NULL);
 300         el = el_init(getprogname(), stdin, stdout, stderr);
 301         if (el == NULL)
 302                 return (CMDRTN_ERROR);
 303         el_set(el, EL_PROMPT, Prompt);
 304         el_set(el, EL_SIGNAL, 1);
 305         el_set(el, EL_EDITOR, "emacs");
 306         hist = history_init();
 307         if (hist == NULL)
 308                 return (CMDRTN_ERROR);
 309         history(hist, &hev, H_SETSIZE, 100);
 310         history(hist, &hev, H_SETUNIQUE, 1);
 311         el_set(el, EL_HIST, history, (const char *)hist);
 312         el_source(el, NULL);
 313
 314         for (;;) {
 315                 const char *buf;
 316                 int count;
 317
 318                 if ((buf = el_gets(el, &count)) == NULL) {
 319                         printf("\n");
 320                         break;
 321                 }
 322                 history(hist, &hev, H_ENTER, buf);
 323                 pthread_kill(monitor, SIGUSR1);
 324                 pthread_mutex_lock(&mutex);
 325                 if (DoParseCommand(buf) == CMDRTN_QUIT)
 326                         break;
 327                 pthread_cond_signal(&cond);
 328                 pthread_mutex_unlock(&mutex);
 329         }
 330
 331         history_end(hist);
 332         el_end(el);
 333         pthread_cancel(monitor);
 334
 335         return (CMDRTN_QUIT);
 336 }
 337
 338 #else /* !EDITLINE */
 339
 340 /*
 341  * Interactive mode w/o libedit functionality.
 342  */
 343 static int
 344 DoInteractive(void)
 345 {
 346         const int maxfd = MAX(csock, dsock) + 1;
 347
 348         (*help_cmd.func)(0, NULL);
 349         while (1) {
 350                 struct timeval tv;
 351                 fd_set rfds;
 352
 353                 /* See if any data or control messages are arriving */
 354                 FD_ZERO(&rfds);
 355                 FD_SET(csock, &rfds);
 356                 FD_SET(dsock, &rfds);
 357                 memset(&tv, 0, sizeof(tv));
 358                 if (select(maxfd, &rfds, NULL, NULL, &tv) <= 0) {
 359
 360                         /* Issue prompt and wait for anything to happen */
 361                         printf("%s", PROMPT);
 362                         fflush(stdout);
 363                         FD_ZERO(&rfds);
 364                         FD_SET(0, &rfds);
 365                         FD_SET(csock, &rfds);
 366                         FD_SET(dsock, &rfds);
 367                         if (select(maxfd, &rfds, NULL, NULL, NULL) < 0)
 368                                 err(EX_OSERR, "select");
 369
 370                         /* If not user input, print a newline first */
 371                         if (!FD_ISSET(0, &rfds))
 372                                 printf("\n");
 373                 }
 374
 375                 ReadSockets(&rfds);
 376
 377                 /* Get any user input */
 378                 if (FD_ISSET(0, &rfds)) {
 379                         char buf[LINE_MAX];
 380
 381                         if (fgets(buf, sizeof(buf), stdin) == NULL) {
 382                                 printf("\n");
 383                                 break;
 384                         }
 385                         if (DoParseCommand(buf) == CMDRTN_QUIT)
 386                                 break;
 387                 }
 388         }
 389         return (CMDRTN_QUIT);
 390 }
 391 #endif /* !EDITLINE */
 392
 393 /*
 394  * Read and process data on netgraph control and data sockets.
 395  */
 396 static void
 397 ReadSockets(fd_set *rfds)
 398 {
 399         /* Display any incoming control message. */
 400         if (FD_ISSET(csock, rfds))
 401                 MsgRead();
 402
 403         /* Display any incoming data packet. */
 404         if (FD_ISSET(dsock, rfds)) {
 405                 char hook[NG_HOOKSIZ];
 406                 u_char *buf;
 407                 int rl;
 408
 409                 /* Read packet from socket. */
 410                 if ((rl = NgAllocRecvData(dsock, &buf, hook)) < 0)
 411                         err(EX_OSERR, "reading hook \"%s\"", hook);
 412                 if (rl == 0)
 413                         errx(EX_OSERR, "EOF from hook \"%s\"?", hook);
 414
 415                 /* Write packet to stdout. */
 416                 printf("Rec'd data packet on hook \"%s\":\n", hook);
 417                 DumpAscii(buf, rl);
 418                 free(buf);
 419         }
 420 }
 421
 422 /*
 423  * Parse a command line and execute the command
 424  */
 425 static int
 426 DoParseCommand(const char *line)
 427 {
 428         char *av[MAX_ARGS];
 429         int ac;
 430
 431         /* Parse line */
 432         for (ac = 0, av[0] = strtok((char *)line, WHITESPACE);
 433             ac < MAX_ARGS - 1 && av[ac];
 434             av[++ac] = strtok(NULL, WHITESPACE));
 435
 436         /* Do command */
 437         return (DoCommand(ac, av));
 438 }
 439
 440 /*
 441  * Execute the command
 442  */
 443 static int
 444 DoCommand(int ac, char **av)
 445 {
 446         const struct ngcmd *cmd;
 447         int rtn;
 448
 449         if (ac == 0 || *av[0] == 0)
 450                 return (CMDRTN_OK);
 451         if ((cmd = FindCommand(av[0])) == NULL)
 452                 return (CMDRTN_ERROR);
 453         if ((rtn = (*cmd->func)(ac, av)) == CMDRTN_USAGE)
 454                 warnx("usage: %s", cmd->cmd);
 455         return (rtn);
 456 }
 457
 458 /*
 459  * Find a command
 460  */
 461 static const struct ngcmd *
 462 FindCommand(const char *string)
 463 {
 464         int k, found = -1;
 465
 466         for (k = 0; cmds[k] != NULL; k++) {
 467                 if (MatchCommand(cmds[k], string)) {
 468                         if (found != -1) {
 469                                 warnx("\"%s\": ambiguous command", string);
 470                                 return (NULL);
 471                         }
 472                         found = k;
 473                 }
 474         }
 475         if (found == -1) {
 476                 warnx("\"%s\": unknown command", string);
 477                 return (NULL);
 478         }
 479         return (cmds[found]);
 480 }
 481
 482 /*
 483  * See if string matches a prefix of "cmd" (or an alias) case insensitively
 484  */
 485 static int
 486 MatchCommand(const struct ngcmd *cmd, const char *s)
 487 {
 488         int a;
 489
 490         /* Try to match command, ignoring the usage stuff */
 491         if (strlen(s) <= strcspn(cmd->cmd, WHITESPACE)) {
 492                 if (strncasecmp(s, cmd->cmd, strlen(s)) == 0)
 493                         return (1);
 494         }
 495
 496         /* Try to match aliases */
 497         for (a = 0; a < MAX_CMD_ALIAS && cmd->aliases[a] != NULL; a++) {
 498                 if (strlen(cmd->aliases[a]) >= strlen(s)) {
 499                         if (strncasecmp(s, cmd->aliases[a], strlen(s)) == 0)
 500                                 return (1);
 501                 }
 502         }
 503
 504         /* No match */
 505         return (0);
 506 }
 507
 508 /*
 509  * ReadCmd()
 510  */
 511 static int
 512 ReadCmd(int ac, char **av)
 513 {
 514         FILE *fp;
 515         int rtn;
 516
 517         /* Open file */
 518         switch (ac) {
 519         case 2:
 520                 if ((fp = fopen(av[1], "r")) == NULL) {
 521                         warn("%s", av[1]);
 522                         return (CMDRTN_ERROR);
 523                 }
 524                 break;
 525         default:
 526                 return (CMDRTN_USAGE);
 527         }
 528
 529         /* Process it */
 530         rtn = ReadFile(fp);
 531         fclose(fp);
 532         return (rtn);
 533 }
 534
 535 /*
 536  * HelpCmd()
 537  */
 538 static int
 539 HelpCmd(int ac, char **av)
 540 {
 541         const struct ngcmd *cmd;
 542         int k;
 543
 544         switch (ac) {
 545         case 0:
 546         case 1:
 547                 /* Show all commands */
 548                 printf("Available commands:\n");
 549                 for (k = 0; cmds[k] != NULL; k++) {
 550                         char *s, buf[100];
 551
 552                         cmd = cmds[k];
 553                         snprintf(buf, sizeof(buf), "%s", cmd->cmd);
 554                         for (s = buf; *s != '\0' && !isspace(*s); s++);
 555                         *s = '\0';
 556                         printf("  %-10s %s\n", buf, cmd->desc);
 557                 }
 558                 return (CMDRTN_OK);
 559         default:
 560                 /* Show help on a specific command */
 561                 if ((cmd = FindCommand(av[1])) != NULL) {
 562                         printf("usage:    %s\n", cmd->cmd);
 563                         if (cmd->aliases[0] != NULL) {
 564                                 int a = 0;
 565
 566                                 printf("Aliases:  ");
 567                                 while (1) {
 568                                         printf("%s", cmd->aliases[a++]);
 569                                         if (a == MAX_CMD_ALIAS
 570                                             || cmd->aliases[a] == NULL) {
 571                                                 printf("\n");
 572                                                 break;
 573                                         }
 574                                         printf(", ");
 575                                 }
 576                         }
 577                         printf("Summary:  %s\n", cmd->desc);
 578                         if (cmd->help != NULL) {
 579                                 const char *s;
 580                                 char buf[65];
 581                                 int tot, len, done;
 582
 583                                 printf("Description:\n");
 584                                 for (s = cmd->help; *s != '\0'; s += len) {
 585                                         while (isspace(*s))
 586                                                 s++;
 587                                         tot = snprintf(buf,
 588                                             sizeof(buf), "%s", s);
 589                                         len = strlen(buf);
 590                                         done = len == tot;
 591                                         if (!done) {
 592                                                 while (len > 0
 593                                                     && !isspace(buf[len-1]))
 594                                                         buf[--len] = '\0';
 595                                         }
 596                                         printf("  %s\n", buf);
 597                                 }
 598                         }
 599                 }
 600         }
 601         return (CMDRTN_OK);
 602 }
 603
 604 /*
 605  * QuitCmd()
 606  */
 607 static int
 608 QuitCmd(int ac __unused, char **av __unused)
 609 {
 610         return (CMDRTN_QUIT);
 611 }
 612
 613 /*
 614  * Dump data in hex and ASCII form
 615  */
 616 void
 617 DumpAscii(const u_char *buf, int len)
 618 {
 619         char ch, sbuf[100];
 620         int k, count;
 621
 622         for (count = 0; count < len; count += DUMP_BYTES_PER_LINE) {
 623                 snprintf(sbuf, sizeof(sbuf), "%04x:  ", count);
 624                 for (k = 0; k < DUMP_BYTES_PER_LINE; k++) {
 625                         if (count + k < len) {
 626                                 snprintf(sbuf + strlen(sbuf),
 627                                     sizeof(sbuf) - strlen(sbuf),
 628                                     "%02x ", buf[count + k]);
 629                         } else {
 630                                 snprintf(sbuf + strlen(sbuf),
 631                                     sizeof(sbuf) - strlen(sbuf), "   ");
 632                         }
 633                 }
 634                 snprintf(sbuf + strlen(sbuf), sizeof(sbuf) - strlen(sbuf), " ");
 635                 for (k = 0; k < DUMP_BYTES_PER_LINE; k++) {
 636                         if (count + k < len) {
 637                                 ch = isprint(buf[count + k]) ?
 638                                     buf[count + k] : '.';
 639                                 snprintf(sbuf + strlen(sbuf),
 640                                     sizeof(sbuf) - strlen(sbuf), "%c", ch);
 641                         } else {
 642                                 snprintf(sbuf + strlen(sbuf),
 643                                     sizeof(sbuf) - strlen(sbuf), " ");
 644                         }
 645                 }
 646                 printf("%s\n", sbuf);
 647         }
 648 }
 649
 650 /*
 651  * Usage()
 652  */
 653 static void
 654 Usage(const char *msg)
 655 {
 656         if (msg)
 657                 warnx("%s", msg);
 658         fprintf(stderr,
 659                 "usage: ngctl [-d] [-f file] [-n name] [command ...]\n");
 660         exit(EX_USAGE);
 661 }