usr/src/boot/sys/boot/common/interp.c

   1 /*-
   2  * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 /*
  31  * Simple commandline interpreter, toplevel and misc.
  32  *
  33  * XXX may be obsoleted by BootFORTH or some other, better, interpreter.
  34  */
  35
  36 #include <stand.h>
  37 #include <string.h>
  38 #include "bootstrap.h"
  39
  40 #ifdef BOOT_FORTH
  41 #include "ficl.h"
  42 #define RETURN(x)       ficlStackPushInteger(ficlVmGetDataStack(bf_vm),!x); return(x)
  43
  44 extern ficlVm *bf_vm;
  45 #else
  46 #define RETURN(x)       return(x)
  47 #endif
  48
  49 #include "linenoise/linenoise.h"
  50
  51 #define MAXARGS 20              /* maximum number of arguments allowed */
  52
  53 static char *prompt(void);
  54
  55 #ifndef BOOT_FORTH
  56 static int      perform(int argc, char *argv[]);
  57
  58 /*
  59  * Perform the command
  60  */
  61 int
  62 perform(int argc, char *argv[])
  63 {
  64     int                         result;
  65     struct bootblk_command      **cmdp;
  66     bootblk_cmd_t               *cmd;
  67
  68     if (argc < 1)
  69         return(CMD_OK);
  70
  71     /* set return defaults; a successful command will override these */
  72     command_errmsg = command_errbuf;
  73     strcpy(command_errbuf, "no error message");
  74     cmd = NULL;
  75     result = CMD_ERROR;
  76
  77     /* search the command set for the command */
  78     SET_FOREACH(cmdp, Xcommand_set) {
  79         if (((*cmdp)->c_name != NULL) && !strcmp(argv[0], (*cmdp)->c_name))
  80             cmd = (*cmdp)->c_fn;
  81     }
  82     if (cmd != NULL) {
  83         result = (cmd)(argc, argv);
  84     } else {
  85         command_errmsg = "unknown command";
  86     }
  87     RETURN(result);
  88 }
  89 #endif  /* ! BOOT_FORTH */
  90
  91 /*
  92  * Interactive mode
  93  */
  94 void
  95 interact(const char *rc)
  96 {
  97     char *input = NULL;
  98
  99     bf_init((rc) ? "" : NULL);
 100
 101     if (rc == NULL) {
 102         /* Read our default configuration. */
 103         if (include("/boot/loader.rc") != CMD_OK)
 104             include("/boot/boot.conf");
 105     } else if (*rc != '\0')
 106         include(rc);
 107
 108     printf("\n");
 109
 110     /*
 111      * Before interacting, we might want to autoboot.
 112      */
 113     autoboot_maybe();
 114
 115     /*
 116      * Not autobooting, go manual
 117      */
 118     printf("\nType '?' for a list of commands, 'help' for more detailed help.\n");
 119     if (getenv("prompt") == NULL)
 120         setenv("prompt", "${interpret}", 1);
 121     if (getenv("interpret") == NULL)
 122         setenv("interpret", "ok", 1);
 123
 124
 125     while ((input = linenoise(prompt())) != NULL) {
 126         bf_vm->sourceId.i = 0;
 127         bf_run(input);
 128         linenoiseHistoryAdd(input);
 129         free(input);
 130     }
 131 }
 132
 133 /*
 134  * Read commands from a file, then execute them.
 135  *
 136  * We store the commands in memory and close the source file so that the media
 137  * holding it can safely go away while we are executing.
 138  *
 139  * Commands may be prefixed with '@' (so they aren't displayed) or '-' (so
 140  * that the script won't stop if they fail).
 141  */
 142 COMMAND_SET(include, "include", "read commands from a file", command_include);
 143
 144 static int
 145 command_include(int argc, char *argv[])
 146 {
 147     int         i;
 148     int         res;
 149     char        **argvbuf;
 150
 151     /*
 152      * Since argv is static, we need to save it here.
 153      */
 154     argvbuf = (char**) calloc((u_int)argc, sizeof(char*));
 155     for (i = 0; i < argc; i++)
 156         argvbuf[i] = strdup(argv[i]);
 157
 158     res=CMD_OK;
 159     for (i = 1; (i < argc) && (res == CMD_OK); i++)
 160         res = include(argvbuf[i]);
 161
 162     for (i = 0; i < argc; i++)
 163         free(argvbuf[i]);
 164     free(argvbuf);
 165
 166     return(res);
 167 }
 168
 169 /*
 170  * Header prepended to each line. The text immediately follows the header.
 171  * We try to make this short in order to save memory -- the loader has
 172  * limited memory available, and some of the forth files are very long.
 173  */
 174 struct includeline
 175 {
 176     struct includeline  *next;
 177     int                 line;
 178     char                text[0];
 179 };
 180
 181 /*
 182  * the PXE tftp service allows to open exactly one connection at the time,
 183  * so we need to read included file to memory, then process line by line
 184  * as it may contain embedded include commands.
 185  */
 186 int
 187 include(const char *filename)
 188 {
 189     struct includeline  *script, *se, *sp;
 190     int res = CMD_OK;
 191     int prevsrcid, fd, line;
 192     char *cp, input[256];               /* big enough? */
 193
 194     if (((fd = open(filename, O_RDONLY)) == -1)) {
 195         snprintf(command_errbuf, sizeof (command_errbuf), "can't open '%s': %s",
 196             filename, strerror(errno));
 197         return(CMD_ERROR);
 198     }
 199     /*
 200      * Read the script into memory.
 201      */
 202     script = se = NULL;
 203     line = 0;
 204
 205     while (fgetstr(input, sizeof(input), fd) >= 0) {
 206         line++;
 207         cp = input;
 208         /* Allocate script line structure and copy line, flags */
 209         if (*cp == '\0')
 210                 continue;       /* ignore empty line, save memory */
 211         if (cp[0] == '\\' && cp[1] == ' ')
 212                 continue;       /* ignore comment */
 213
 214         sp = malloc(sizeof(struct includeline) + strlen(cp) + 1);
 215         /* On malloc failure (it happens!), free as much as possible and exit */
 216         if (sp == NULL) {
 217                 while (script != NULL) {
 218                         se = script;
 219                         script = script->next;
 220                         free(se);
 221                 }
 222                 snprintf(command_errbuf, sizeof (command_errbuf),
 223                     "file '%s' line %d: memory allocation failure - aborting",
 224                     filename, line);
 225                 close(fd);
 226                 return (CMD_ERROR);
 227         }
 228         strcpy(sp->text, cp);
 229         sp->line = line;
 230         sp->next = NULL;
 231
 232         if (script == NULL) {
 233                 script = sp;
 234         } else {
 235                 se->next = sp;
 236         }
 237         se = sp;
 238     }
 239     close(fd);
 240
 241     /*
 242      * Execute the script
 243      */
 244
 245     prevsrcid = bf_vm->sourceId.i;
 246     bf_vm->sourceId.i = fd+1;   /* 0 is user input device */
 247
 248     res = CMD_OK;
 249
 250     for (sp = script; sp != NULL; sp = sp->next) {
 251         res = bf_run(sp->text);
 252         if (res != FICL_VM_STATUS_OUT_OF_TEXT) {
 253                 snprintf(command_errbuf, sizeof (command_errbuf),
 254                     "Error while including %s, in the line %d:\n%s",
 255                     filename, sp->line, sp->text);
 256                 res = CMD_ERROR;
 257                 break;
 258         } else
 259                 res = CMD_OK;
 260     }
 261
 262     bf_vm->sourceId.i = -1;
 263     (void) bf_run("");
 264     bf_vm->sourceId.i = prevsrcid;
 265
 266     while(script != NULL) {
 267         se = script;
 268         script = script->next;
 269         free(se);
 270     }
 271
 272     return(res);
 273 }
 274
 275 /*
 276  * Emit the current prompt; use the same syntax as the parser
 277  * for embedding environment variables.
 278  */
 279 static char *
 280 prompt(void)
 281 {
 282     static char promptbuf[20];  /* probably too large, but well... */
 283     char        *pr, *p, *cp, *ev;
 284     int n = 0;
 285
 286     if ((cp = getenv("prompt")) == NULL)
 287         cp = (char *)(uintptr_t)">";
 288     pr = p = strdup(cp);
 289
 290     while (*p != 0) {
 291         if ((*p == '$') && (*(p+1) == '{')) {
 292             for (cp = p + 2; (*cp != 0) && (*cp != '}'); cp++)
 293                 ;
 294             *cp = 0;
 295             ev = getenv(p + 2);
 296
 297             if (ev != NULL)
 298                 n = sprintf(promptbuf+n, "%s", ev);
 299             p = cp + 1;
 300             continue;
 301         }
 302         promptbuf[n++] = *p;
 303         p++;
 304     }
 305     if (promptbuf[n - 1] != ' ')
 306         promptbuf[n++] = ' ';
 307     promptbuf[n] = '\0';
 308     free(pr);
 309     return (promptbuf);
 310 }