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  * $FreeBSD: src/sys/boot/common/interp.c,v 1.29 2003/08/25 23:30:41 obrien Exp $
  27  * $DragonFly: src/sys/boot/common/interp.c,v 1.3 2003/11/10 06:08:31 dillon Exp $
  28  */
  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)       stackPushINT(bf_vm->pStack,!x); return(x)
  43
  44 extern FICL_VM *bf_vm;
  45 #else
  46 #define RETURN(x)       return(x)
  47 #endif
  48
  49 #define MAXARGS 20                      /* maximum number of arguments allowed */
  50
  51 static void     prompt(void);
  52
  53 #ifndef BOOT_FORTH
  54 static int      perform(int argc, char *argv[]);
  55
  56 /*
  57  * Perform the command
  58  */
  59 int
  60 perform(int argc, char *argv[])
  61 {
  62     int                         result;
  63     struct bootblk_command      **cmdp;
  64     bootblk_cmd_t               *cmd;
  65
  66     if (argc < 1)
  67         return(CMD_OK);
  68
  69     /* set return defaults; a successful command will override these */
  70     command_errmsg = command_errbuf;
  71     strcpy(command_errbuf, "no error message");
  72     cmd = NULL;
  73     result = CMD_ERROR;
  74
  75     /* search the command set for the command */
  76     SET_FOREACH(cmdp, Xcommand_set) {
  77         if (((*cmdp)->c_name != NULL) && !strcmp(argv[0], (*cmdp)->c_name))
  78             cmd = (*cmdp)->c_fn;
  79     }
  80     if (cmd != NULL) {
  81         result = (cmd)(argc, argv);
  82     } else {
  83         command_errmsg = "unknown command";
  84     }
  85     RETURN(result);
  86 }
  87 #endif  /* ! BOOT_FORTH */
  88
  89 /*
  90  * Interactive mode
  91  */
  92 void
  93 interact(void)
  94 {
  95     char        input[256];                     /* big enough? */
  96 #ifndef BOOT_FORTH
  97     int         argc;
  98     char        **argv;
  99 #endif
 100
 101 #ifdef BOOT_FORTH
 102     bf_init();
 103 #endif
 104
 105     /*
 106      * Read our default configuration
 107      */
 108     if(include("/boot/loader.rc")!=CMD_OK)
 109         include("/boot/boot.conf");
 110     printf("\n");
 111     /*
 112      * Before interacting, we might want to autoboot.
 113      */
 114     autoboot_maybe();
 115
 116     /*
 117      * Not autobooting, go manual
 118      */
 119     printf("\nType '?' for a list of commands, 'help' for more detailed help.\n");
 120     if (getenv("prompt") == NULL)
 121         setenv("prompt", "${interpret}", 1);
 122     if (getenv("interpret") == NULL)
 123         setenv("interpret", "OK", 1);
 124
 125
 126     for (;;) {
 127         input[0] = '\0';
 128         prompt();
 129         ngets(input, sizeof(input));
 130 #ifdef BOOT_FORTH
 131         bf_vm->sourceID.i = 0;
 132         bf_run(input);
 133 #else
 134         if (!parse(&argc, &argv, input)) {
 135             if (perform(argc, argv))
 136                 printf("%s: %s\n", argv[0], command_errmsg);
 137             free(argv);
 138         } else {
 139             printf("parse error\n");
 140         }
 141 #endif
 142     }
 143 }
 144
 145 /*
 146  * Read commands from a file, then execute them.
 147  *
 148  * We store the commands in memory and close the source file so that the media
 149  * holding it can safely go away while we are executing.
 150  *
 151  * Commands may be prefixed with '@' (so they aren't displayed) or '-' (so
 152  * that the script won't stop if they fail).
 153  */
 154 COMMAND_SET(include, "include", "read commands from a file", command_include);
 155
 156 static int
 157 command_include(int argc, char *argv[])
 158 {
 159     int         i;
 160     int         res;
 161     char        **argvbuf;
 162
 163     /*
 164      * Since argv is static, we need to save it here.
 165      */
 166     argvbuf = (char**) calloc((u_int)argc, sizeof(char*));
 167     for (i = 0; i < argc; i++)
 168         argvbuf[i] = strdup(argv[i]);
 169
 170     res=CMD_OK;
 171     for (i = 1; (i < argc) && (res == CMD_OK); i++)
 172         res = include(argvbuf[i]);
 173
 174     for (i = 0; i < argc; i++)
 175         free(argvbuf[i]);
 176     free(argvbuf);
 177
 178     return(res);
 179 }
 180
 181 struct includeline
 182 {
 183     char                *text;
 184     int                 flags;
 185     int                 line;
 186 #define SL_QUIET        (1<<0)
 187 #define SL_IGNOREERR    (1<<1)
 188     struct includeline  *next;
 189 };
 190
 191 int
 192 include(const char *filename)
 193 {
 194     struct includeline  *script, *se, *sp;
 195     char                input[256];                     /* big enough? */
 196 #ifdef BOOT_FORTH
 197     int                 res;
 198     char                *cp;
 199     int                 prevsrcid, fd, line;
 200 #else
 201     int                 argc,res;
 202     char                **argv, *cp;
 203     int                 fd, flags, line;
 204 #endif
 205
 206     if (((fd = open(filename, O_RDONLY)) == -1)) {
 207         sprintf(command_errbuf,"can't open '%s': %s\n", filename, strerror(errno));
 208         return(CMD_ERROR);
 209     }
 210
 211     /*
 212      * Read the script into memory.
 213      */
 214     script = se = NULL;
 215     line = 0;
 216
 217     while (fgetstr(input, sizeof(input), fd) >= 0) {
 218         line++;
 219 #ifdef BOOT_FORTH
 220         cp = input;
 221 #else
 222         flags = 0;
 223         /* Discard comments */
 224         if (strncmp(input+strspn(input, " "), "\\ ", 2) == 0)
 225             continue;
 226         cp = input;
 227         /* Echo? */
 228         if (input[0] == '@') {
 229             cp++;
 230             flags |= SL_QUIET;
 231         }
 232         /* Error OK? */
 233         if (input[0] == '-') {
 234             cp++;
 235             flags |= SL_IGNOREERR;
 236         }
 237 #endif
 238         /* Allocate script line structure and copy line, flags */
 239         sp = malloc(sizeof(struct includeline) + strlen(cp) + 1);
 240         sp->text = (char *)sp + sizeof(struct includeline);
 241         strcpy(sp->text, cp);
 242 #ifndef BOOT_FORTH
 243         sp->flags = flags;
 244 #endif
 245         sp->line = line;
 246         sp->next = NULL;
 247
 248         if (script == NULL) {
 249             script = sp;
 250         } else {
 251             se->next = sp;
 252         }
 253         se = sp;
 254     }
 255     close(fd);
 256
 257     /*
 258      * Execute the script
 259      */
 260 #ifndef BOOT_FORTH
 261     argv = NULL;
 262 #else
 263     prevsrcid = bf_vm->sourceID.i;
 264     bf_vm->sourceID.i = fd;
 265 #endif
 266     res = CMD_OK;
 267     for (sp = script; sp != NULL; sp = sp->next) {
 268
 269 #ifdef BOOT_FORTH
 270         res = bf_run(sp->text);
 271         if (res != VM_OUTOFTEXT) {
 272                 sprintf(command_errbuf, "Error while including %s, in the line:\n%s", filename, sp->text);
 273                 res = CMD_ERROR;
 274                 break;
 275         } else
 276                 res = CMD_OK;
 277 #else
 278         /* print if not being quiet */
 279         if (!(sp->flags & SL_QUIET)) {
 280             prompt();
 281             printf("%s\n", sp->text);
 282         }
 283
 284         /* Parse the command */
 285         if (!parse(&argc, &argv, sp->text)) {
 286             if ((argc > 0) && (perform(argc, argv) != 0)) {
 287                 /* normal command */
 288                 printf("%s: %s\n", argv[0], command_errmsg);
 289                 if (!(sp->flags & SL_IGNOREERR)) {
 290                     res=CMD_ERROR;
 291                     break;
 292                 }
 293             }
 294             free(argv);
 295             argv = NULL;
 296         } else {
 297             printf("%s line %d: parse error\n", filename, sp->line);
 298             res=CMD_ERROR;
 299             break;
 300         }
 301 #endif
 302     }
 303 #ifndef BOOT_FORTH
 304     if (argv != NULL)
 305         free(argv);
 306 #else
 307     bf_vm->sourceID.i = prevsrcid;
 308 #endif
 309     while(script != NULL) {
 310         se = script;
 311         script = script->next;
 312         free(se);
 313     }
 314     return(res);
 315 }
 316
 317 /*
 318  * Emit the current prompt; use the same syntax as the parser
 319  * for embedding environment variables.
 320  */
 321 static void
 322 prompt(void)
 323 {
 324     char        *pr, *p, *cp, *ev;
 325
 326     if ((cp = getenv("prompt")) == NULL)
 327         cp = ">";
 328     pr = p = strdup(cp);
 329
 330     while (*p != 0) {
 331         if ((*p == '$') && (*(p+1) == '{')) {
 332             for (cp = p + 2; (*cp != 0) && (*cp != '}'); cp++)
 333                 ;
 334             *cp = 0;
 335             ev = getenv(p + 2);
 336
 337             if (ev != NULL)
 338                 printf("%s", ev);
 339             p = cp + 1;
 340             continue;
 341         }
 342         putchar(*p++);
 343     }
 344     putchar(' ');
 345     free(pr);
 346 }