stand/common/boot.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  * Loading modules, booting the system
  32  */
  33
  34 #include <stand.h>
  35 #include <sys/reboot.h>
  36 #include <sys/boot.h>
  37 #include <string.h>
  38
  39 #include "bootstrap.h"
  40
  41 static int      autoboot(int timeout, char *prompt);
  42 static char     *getbootfile(int try);
  43 static int      loadakernel(int try, int argc, char* argv[]);
  44
  45 /* List of kernel names to try (may be overwritten by boot.config) XXX should move from here? */
  46 static const char *default_bootfiles = "kernel";
  47
  48 static int autoboot_tried;
  49
  50 /*
  51  * The user wants us to boot.
  52  */
  53 COMMAND_SET(boot, "boot", "boot a file or loaded kernel", command_boot);
  54
  55 static int
  56 command_boot(int argc, char *argv[])
  57 {
  58         struct preloaded_file   *fp;
  59
  60         /*
  61          * See if the user has specified an explicit kernel to boot.
  62          */
  63         if ((argc > 1) && (argv[1][0] != '-')) {
  64
  65                 /* XXX maybe we should discard everything and start again? */
  66                 if (file_findfile(NULL, NULL) != NULL) {
  67                         snprintf(command_errbuf, sizeof(command_errbuf),
  68                             "can't boot '%s', kernel module already loaded", argv[1]);
  69                         return(CMD_ERROR);
  70                 }
  71
  72                 /* find/load the kernel module */
  73                 if (mod_loadkld(argv[1], argc - 2, argv + 2) != 0)
  74                         return(CMD_ERROR);
  75                 /* we have consumed all arguments */
  76                 argc = 1;
  77         }
  78
  79         /*
  80          * See if there is a kernel module already loaded
  81          */
  82         if (file_findfile(NULL, NULL) == NULL)
  83                 if (loadakernel(0, argc - 1, argv + 1))
  84                         /* we have consumed all arguments */
  85                         argc = 1;
  86
  87         /*
  88          * Loaded anything yet?
  89          */
  90         if ((fp = file_findfile(NULL, NULL)) == NULL) {
  91                 command_errmsg = "no bootable kernel";
  92                 return(CMD_ERROR);
  93         }
  94
  95         /*
  96          * If we were given arguments, discard any previous.
  97          * XXX should we merge arguments?  Hard to DWIM.
  98          */
  99         if (argc > 1) {
 100                 if (fp->f_args != NULL)
 101                         free(fp->f_args);
 102                 fp->f_args = unargv(argc - 1, argv + 1);
 103         }
 104
 105         /* Hook for platform-specific autoloading of modules */
 106         if (archsw.arch_autoload() != 0)
 107                 return(CMD_ERROR);
 108
 109 #ifdef LOADER_VERIEXEC
 110         verify_pcr_export();            /* for measured boot */
 111 #ifdef LOADER_VERIEXEC_PASS_MANIFEST
 112         pass_manifest_export_envs();
 113 #endif
 114 #endif
 115
 116         /* Call the exec handler from the loader matching the kernel */
 117         file_formats[fp->f_loader]->l_exec(fp);
 118         return(CMD_ERROR);
 119 }
 120
 121
 122 /*
 123  * Autoboot after a delay
 124  */
 125
 126 COMMAND_SET(autoboot, "autoboot", "boot automatically after a delay", command_autoboot);
 127
 128 static int
 129 command_autoboot(int argc, char *argv[])
 130 {
 131         int             howlong;
 132         char    *cp, *prompt;
 133
 134         prompt = NULL;
 135         howlong = -1;
 136         switch(argc) {
 137         case 3:
 138                 prompt = argv[2];
 139                 /* FALLTHROUGH */
 140         case 2:
 141                 howlong = strtol(argv[1], &cp, 0);
 142                 if (*cp != 0) {
 143                         snprintf(command_errbuf, sizeof(command_errbuf),
 144                             "bad delay '%s'", argv[1]);
 145                         return(CMD_ERROR);
 146                 }
 147                 /* FALLTHROUGH */
 148         case 1:
 149                 return(autoboot(howlong, prompt));
 150         }
 151
 152         command_errmsg = "too many arguments";
 153         return(CMD_ERROR);
 154 }
 155
 156 /*
 157  * Called before we go interactive.  If we think we can autoboot, and
 158  * we haven't tried already, try now.
 159  */
 160 void
 161 autoboot_maybe()
 162 {
 163         char    *cp;
 164
 165         cp = getenv("autoboot_delay");
 166         if ((autoboot_tried == 0) && ((cp == NULL) || strcasecmp(cp, "NO")))
 167                 autoboot(-1, NULL);             /* try to boot automatically */
 168 }
 169
 170 static int
 171 autoboot(int timeout, char *prompt)
 172 {
 173         time_t  when, otime, ntime;
 174         int             c, yes;
 175         char    *argv[2], *cp, *ep;
 176         char    *kernelname;
 177 #ifdef BOOT_PROMPT_123
 178         const char      *seq = "123", *p = seq;
 179 #endif
 180
 181         autoboot_tried = 1;
 182
 183         if (timeout == -1) {
 184                 timeout = 10;
 185                 /* try to get a delay from the environment */
 186                 if ((cp = getenv("autoboot_delay"))) {
 187                         timeout = strtol(cp, &ep, 0);
 188                         if (cp == ep)
 189                                 timeout = 10;           /* Unparseable? Set default! */
 190                 }
 191         }
 192
 193         kernelname = getenv("kernelname");
 194         if (kernelname == NULL) {
 195                 argv[0] = NULL;
 196                 loadakernel(0, 0, argv);
 197                 kernelname = getenv("kernelname");
 198                 if (kernelname == NULL) {
 199                         command_errmsg = "no valid kernel found";
 200                         return(CMD_ERROR);
 201                 }
 202         }
 203
 204         if (timeout >= 0) {
 205                 otime = -1;
 206                 ntime = time(NULL);
 207                 when = ntime + timeout; /* when to boot */
 208
 209                 yes = 0;
 210
 211 #ifdef BOOT_PROMPT_123
 212                 printf("%s\n", (prompt == NULL) ? "Hit [Enter] to boot immediately, or "
 213                     "1 2 3 sequence for command prompt." : prompt);
 214 #else
 215                 printf("%s\n", (prompt == NULL) ? "Hit [Enter] to boot immediately, or any other key for command prompt." : prompt);
 216 #endif
 217
 218                 for (;;) {
 219                         if (ischar()) {
 220                                 c = getchar();
 221 #ifdef BOOT_PROMPT_123
 222                                 if ((c == '\r') || (c == '\n')) {
 223                                         yes = 1;
 224                                         break;
 225                                 } else if (c != *p++)
 226                                         p = seq;
 227                                 if (*p == 0)
 228                                         break;
 229 #else
 230                                 if ((c == '\r') || (c == '\n'))
 231                                         yes = 1;
 232                                 break;
 233 #endif
 234                         }
 235                         ntime = time(NULL);
 236                         if (ntime >= when) {
 237                                 yes = 1;
 238                                 break;
 239                         }
 240
 241                         if (ntime != otime) {
 242                                 printf("\rBooting [%s] in %d second%s... ",
 243                                     kernelname, (int)(when - ntime),
 244                                     (when-ntime)==1?"":"s");
 245                                 otime = ntime;
 246                         }
 247                 }
 248         } else {
 249                 yes = 1;
 250         }
 251
 252         if (yes)
 253                 printf("\rBooting [%s]...               ", kernelname);
 254         putchar('\n');
 255         if (yes) {
 256                 argv[0] = "boot";
 257                 argv[1] = NULL;
 258                 return(command_boot(1, argv));
 259         }
 260         return(CMD_OK);
 261 }
 262
 263 /*
 264  * Scrounge for the name of the (try)'th file we will try to boot.
 265  */
 266 static char *
 267 getbootfile(int try)
 268 {
 269         static char *name = NULL;
 270         const char      *spec, *ep;
 271         size_t  len;
 272
 273         /* we use dynamic storage */
 274         if (name != NULL) {
 275                 free(name);
 276                 name = NULL;
 277         }
 278
 279         /*
 280          * Try $bootfile, then try our builtin default
 281          */
 282         if ((spec = getenv("bootfile")) == NULL)
 283                 spec = default_bootfiles;
 284
 285         while ((try > 0) && (spec != NULL)) {
 286                 spec = strchr(spec, ';');
 287                 if (spec)
 288                         spec++; /* skip over the leading ';' */
 289                 try--;
 290         }
 291         if (spec != NULL) {
 292                 if ((ep = strchr(spec, ';')) != NULL) {
 293                         len = ep - spec;
 294                 } else {
 295                         len = strlen(spec);
 296                 }
 297                 name = malloc(len + 1);
 298                 strncpy(name, spec, len);
 299                 name[len] = 0;
 300         }
 301         if (name && name[0] == 0) {
 302                 free(name);
 303                 name = NULL;
 304         }
 305         return(name);
 306 }
 307
 308 /*
 309  * Try to find the /etc/fstab file on the filesystem (rootdev),
 310  * which should be be the root filesystem, and parse it to find
 311  * out what the kernel ought to think the root filesystem is.
 312  *
 313  * If we're successful, set vfs.root.mountfrom to <vfstype>:<path>
 314  * so that the kernel can tell both which VFS and which node to use
 315  * to mount the device.  If this variable's already set, don't
 316  * overwrite it.
 317  */
 318 int
 319 getrootmount(char *rootdev)
 320 {
 321         char    lbuf[128], *cp, *ep, *dev, *fstyp, *options;
 322         int             fd, error;
 323
 324         if (getenv("vfs.root.mountfrom") != NULL)
 325                 return(0);
 326
 327         error = 1;
 328         sprintf(lbuf, "%s/etc/fstab", rootdev);
 329         if ((fd = open(lbuf, O_RDONLY)) < 0)
 330                 goto notfound;
 331
 332         /* loop reading lines from /etc/fstab    What was that about sscanf again? */
 333         fstyp = NULL;
 334         dev = NULL;
 335         while (fgetstr(lbuf, sizeof(lbuf), fd) >= 0) {
 336                 if ((lbuf[0] == 0) || (lbuf[0] == '#'))
 337                         continue;
 338
 339                 /* skip device name */
 340                 for (cp = lbuf; (*cp != 0) && !isspace(*cp); cp++)
 341                         ;
 342                 if (*cp == 0)           /* misformatted */
 343                         continue;
 344                 /* delimit and save */
 345                 *cp++ = 0;
 346                 free(dev);
 347                 dev = strdup(lbuf);
 348
 349                 /* skip whitespace up to mountpoint */
 350                 while ((*cp != 0) && isspace(*cp))
 351                         cp++;
 352                 /* must have /<space> to be root */
 353                 if ((*cp == 0) || (*cp != '/') || !isspace(*(cp + 1)))
 354                         continue;
 355                 /* skip whitespace up to fstype */
 356                 cp += 2;
 357                 while ((*cp != 0) && isspace(*cp))
 358                         cp++;
 359                 if (*cp == 0)           /* misformatted */
 360                         continue;
 361                 /* skip text to end of fstype and delimit */
 362                 ep = cp;
 363                 while ((*cp != 0) && !isspace(*cp))
 364                         cp++;
 365                 *cp = 0;
 366                 free(fstyp);
 367                 fstyp = strdup(ep);
 368
 369                 /* skip whitespace up to mount options */
 370                 cp += 1;
 371                 while ((*cp != 0) && isspace(*cp))
 372                         cp++;
 373                 if (*cp == 0)           /* misformatted */
 374                         continue;
 375                 /* skip text to end of mount options and delimit */
 376                 ep = cp;
 377                 while ((*cp != 0) && !isspace(*cp))
 378                         cp++;
 379                 *cp = 0;
 380                 options = strdup(ep);
 381                 /* Build the <fstype>:<device> and save it in vfs.root.mountfrom */
 382                 sprintf(lbuf, "%s:%s", fstyp, dev);
 383                 setenv("vfs.root.mountfrom", lbuf, 0);
 384
 385                 /* Don't override vfs.root.mountfrom.options if it is already set */
 386                 if (getenv("vfs.root.mountfrom.options") == NULL) {
 387                         /* save mount options */
 388                         setenv("vfs.root.mountfrom.options", options, 0);
 389                 }
 390                 free(options);
 391                 error = 0;
 392                 break;
 393         }
 394         close(fd);
 395         free(dev);
 396         free(fstyp);
 397
 398 notfound:
 399         if (error) {
 400                 const char *currdev;
 401
 402                 currdev = getenv("currdev");
 403                 if (currdev != NULL && strncmp("zfs:", currdev, 4) == 0) {
 404                         cp = strdup(currdev);
 405                         cp[strlen(cp) - 1] = '\0';
 406                         setenv("vfs.root.mountfrom", cp, 0);
 407                         error = 0;
 408                         free(cp);
 409                 }
 410         }
 411
 412         return(error);
 413 }
 414
 415 static int
 416 loadakernel(int try, int argc, char* argv[])
 417 {
 418         char *cp;
 419
 420         for (try = 0; (cp = getbootfile(try)) != NULL; try++)
 421                 if (mod_loadkld(cp, argc - 1, argv + 1) != 0)
 422                         printf("can't load '%s'\n", cp);
 423                 else
 424                         return 1;
 425         return 0;
 426 }