usr/src/boot/sys/boot/i386/loader/main.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
  29 /*
  30  * MD bootstrap main() and assorted miscellaneous
  31  * commands.
  32  */
  33
  34 #include <stand.h>
  35 #include <stddef.h>
  36 #include <string.h>
  37 #include <machine/bootinfo.h>
  38 #include <machine/cpufunc.h>
  39 #include <machine/psl.h>
  40 #include <sys/disk.h>
  41 #include <sys/param.h>
  42 #include <sys/reboot.h>
  43
  44 #include "bootstrap.h"
  45 #include "common/bootargs.h"
  46 #include "libi386/libi386.h"
  47 #include "libi386/smbios.h"
  48 #include "btxv86.h"
  49
  50 #ifdef LOADER_ZFS_SUPPORT
  51 #include "../zfs/libzfs.h"
  52 #endif
  53
  54 CTASSERT(sizeof(struct bootargs) == BOOTARGS_SIZE);
  55 CTASSERT(offsetof(struct bootargs, bootinfo) == BA_BOOTINFO);
  56 CTASSERT(offsetof(struct bootargs, bootflags) == BA_BOOTFLAGS);
  57 CTASSERT(offsetof(struct bootinfo, bi_size) == BI_SIZE);
  58
  59 /* Arguments passed in from the boot1/boot2 loader */
  60 static struct bootargs *kargs;
  61
  62 static u_int32_t        initial_howto;
  63 static u_int32_t        initial_bootdev;
  64 static struct bootinfo  *initial_bootinfo;
  65
  66 struct arch_switch      archsw;         /* MI/MD interface boundary */
  67
  68 static void             extract_currdev(void);
  69 static int              isa_inb(int port);
  70 static void             isa_outb(int port, int value);
  71 void                    exit(int code);
  72 #ifdef LOADER_ZFS_SUPPORT
  73 static void             i386_zfs_probe(void);
  74 #endif
  75
  76 /* XXX debugging */
  77 extern char end[];
  78
  79 static void *heap_top;
  80 static void *heap_bottom;
  81
  82 int
  83 main(void)
  84 {
  85     int                 i;
  86
  87     /* Pick up arguments */
  88     kargs = (void *)__args;
  89     initial_howto = kargs->howto;
  90     initial_bootdev = kargs->bootdev;
  91     initial_bootinfo = kargs->bootinfo ? (struct bootinfo *)PTOV(kargs->bootinfo) : NULL;
  92
  93     /* Initialize the v86 register set to a known-good state. */
  94     bzero(&v86, sizeof(v86));
  95     v86.efl = PSL_RESERVED_DEFAULT | PSL_I;
  96
  97     /*
  98      * Initialise the heap as early as possible.  Once this is done, malloc() is usable.
  99      */
 100     bios_getmem();
 101
 102 #if defined(LOADER_BZIP2_SUPPORT) || defined(LOADER_FIREWIRE_SUPPORT) || \
 103     defined(LOADER_GPT_SUPPORT) || defined(LOADER_ZFS_SUPPORT)
 104     if (high_heap_size > 0) {
 105         heap_top = PTOV(high_heap_base + high_heap_size);
 106         heap_bottom = PTOV(high_heap_base);
 107         if (high_heap_base < memtop_copyin)
 108             memtop_copyin = high_heap_base;
 109     } else
 110 #endif
 111     {
 112         heap_top = (void *)PTOV(bios_basemem);
 113         heap_bottom = (void *)end;
 114     }
 115     setheap(heap_bottom, heap_top);
 116
 117     /*
 118      * XXX Chicken-and-egg problem; we want to have console output early, but some
 119      * console attributes may depend on reading from eg. the boot device, which we
 120      * can't do yet.
 121      *
 122      * We can use printf() etc. once this is done.
 123      * If the previous boot stage has requested a serial console, prefer that.
 124      */
 125     bi_setboothowto(initial_howto);
 126     if (initial_howto & RB_MULTIPLE) {
 127         if (initial_howto & RB_SERIAL)
 128             setenv("console", "ttya text", 1);
 129         else
 130             setenv("console", "text ttya", 1);
 131     } else if (initial_howto & RB_SERIAL)
 132         setenv("console", "ttya", 1);
 133     else if (initial_howto & RB_MUTE)
 134         setenv("console", "null", 1);
 135     cons_probe();
 136
 137     /*
 138      * Initialise the block cache. Set the upper limit.
 139      */
 140     bcache_init(32768, 512);
 141
 142     /*
 143      * Special handling for PXE and CD booting.
 144      */
 145     if (kargs->bootinfo == 0) {
 146         /*
 147          * We only want the PXE disk to try to init itself in the below
 148          * walk through devsw if we actually booted off of PXE.
 149          */
 150         if (kargs->bootflags & KARGS_FLAGS_PXE)
 151             pxe_enable(kargs->pxeinfo ? PTOV(kargs->pxeinfo) : NULL);
 152         else if (kargs->bootflags & KARGS_FLAGS_CD)
 153             bc_add(initial_bootdev);
 154     }
 155
 156     archsw.arch_autoload = i386_autoload;
 157     archsw.arch_getdev = i386_getdev;
 158     archsw.arch_copyin = i386_copyin;
 159     archsw.arch_copyout = i386_copyout;
 160     archsw.arch_readin = i386_readin;
 161     archsw.arch_isainb = isa_inb;
 162     archsw.arch_isaoutb = isa_outb;
 163     archsw.arch_loadaddr = i386_loadaddr;
 164 #ifdef LOADER_ZFS_SUPPORT
 165     archsw.arch_zfs_probe = i386_zfs_probe;
 166 #endif
 167
 168     /*
 169      * March through the device switch probing for things.
 170      */
 171     for (i = 0; devsw[i] != NULL; i++)
 172         if (devsw[i]->dv_init != NULL)
 173             (devsw[i]->dv_init)();
 174     printf("BIOS %dkB/%dkB available memory\n", bios_basemem / 1024, bios_extmem / 1024);
 175     if (initial_bootinfo != NULL) {
 176         initial_bootinfo->bi_basemem = bios_basemem / 1024;
 177         initial_bootinfo->bi_extmem = bios_extmem / 1024;
 178     }
 179
 180     /* detect ACPI for future reference */
 181     biosacpi_detect();
 182
 183     /* detect SMBIOS for future reference */
 184     smbios_detect(NULL);
 185
 186     /* detect PCI BIOS for future reference */
 187     biospci_detect();
 188
 189     printf("\n%s", bootprog_info);
 190
 191     extract_currdev();                          /* set $currdev and $loaddev */
 192     setenv("LINES", "24", 1);                   /* optional */
 193     setenv("COLUMNS", "80", 1);                 /* optional */
 194
 195     if (bi_checkcpu())
 196         setenv("ISADIR", "amd64", 1);
 197     else
 198         setenv("ISADIR", "", 1);
 199
 200     bios_getsmap();
 201
 202     interact(NULL);
 203
 204     /* if we ever get here, it is an error */
 205     return (1);
 206 }
 207
 208 /*
 209  * Set the 'current device' by (if possible) recovering the boot device as
 210  * supplied by the initial bootstrap.
 211  *
 212  * XXX should be extended for netbooting.
 213  */
 214 static void
 215 extract_currdev(void)
 216 {
 217     struct i386_devdesc         new_currdev;
 218 #ifdef LOADER_ZFS_SUPPORT
 219     char                        buf[20];
 220     struct zfs_boot_args        *zargs;
 221 #endif
 222     int                         biosdev = -1;
 223
 224     /* Assume we are booting from a BIOS disk by default */
 225     new_currdev.dd.d_dev = &biosdisk;
 226
 227     /* new-style boot loaders such as pxeldr and cdldr */
 228     if (kargs->bootinfo == 0) {
 229         if ((kargs->bootflags & KARGS_FLAGS_CD) != 0) {
 230             /* we are booting from a CD with cdboot */
 231             new_currdev.dd.d_dev = &bioscd;
 232             new_currdev.dd.d_unit = bc_bios2unit(initial_bootdev);
 233         } else if ((kargs->bootflags & KARGS_FLAGS_PXE) != 0) {
 234             /* we are booting from pxeldr */
 235             new_currdev.dd.d_dev = &pxedisk;
 236             new_currdev.dd.d_unit = 0;
 237         } else {
 238             /* we don't know what our boot device is */
 239             new_currdev.d_kind.biosdisk.slice = -1;
 240             new_currdev.d_kind.biosdisk.partition = 0;
 241             biosdev = -1;
 242         }
 243 #ifdef LOADER_ZFS_SUPPORT
 244     } else if ((kargs->bootflags & KARGS_FLAGS_ZFS) != 0) {
 245         zargs = NULL;
 246         /* check for new style extended argument */
 247         if ((kargs->bootflags & KARGS_FLAGS_EXTARG) != 0)
 248             zargs = (struct zfs_boot_args *)(kargs + 1);
 249
 250         if (zargs != NULL &&
 251             zargs->size >= offsetof(struct zfs_boot_args, primary_pool)) {
 252             /* sufficient data is provided */
 253             new_currdev.d_kind.zfs.pool_guid = zargs->pool;
 254             new_currdev.d_kind.zfs.root_guid = zargs->root;
 255             if (zargs->size >= sizeof(*zargs) && zargs->primary_vdev != 0) {
 256                 sprintf(buf, "%llu", zargs->primary_pool);
 257                 setenv("vfs.zfs.boot.primary_pool", buf, 1);
 258                 sprintf(buf, "%llu", zargs->primary_vdev);
 259                 setenv("vfs.zfs.boot.primary_vdev", buf, 1);
 260             }
 261         } else {
 262             /* old style zfsboot block */
 263             new_currdev.d_kind.zfs.pool_guid = kargs->zfspool;
 264             new_currdev.d_kind.zfs.root_guid = 0;
 265         }
 266         new_currdev.dd.d_dev = &zfs_dev;
 267 #endif
 268     } else if ((initial_bootdev & B_MAGICMASK) != B_DEVMAGIC) {
 269         /* The passed-in boot device is bad */
 270         new_currdev.d_kind.biosdisk.slice = -1;
 271         new_currdev.d_kind.biosdisk.partition = 0;
 272         biosdev = -1;
 273     } else {
 274         new_currdev.d_kind.biosdisk.slice = B_SLICE(initial_bootdev) - 1;
 275         new_currdev.d_kind.biosdisk.partition = B_PARTITION(initial_bootdev);
 276         biosdev = initial_bootinfo->bi_bios_dev;
 277
 278         /*
 279          * If we are booted by an old bootstrap, we have to guess at the BIOS
 280          * unit number.  We will lose if there is more than one disk type
 281          * and we are not booting from the lowest-numbered disk type
 282          * (ie. SCSI when IDE also exists).
 283          */
 284         if ((biosdev == 0) && (B_TYPE(initial_bootdev) != 2))   /* biosdev doesn't match major */
 285             biosdev = 0x80 + B_UNIT(initial_bootdev);           /* assume harddisk */
 286     }
 287
 288     /*
 289      * If we are booting off of a BIOS disk and we didn't succeed in determining
 290      * which one we booted off of, just use disk0: as a reasonable default.
 291      */
 292     if ((new_currdev.dd.d_dev->dv_type == biosdisk.dv_type) &&
 293         ((new_currdev.dd.d_unit = bd_bios2unit(biosdev)) == -1)) {
 294         printf("Can't work out which disk we are booting from.\n"
 295                "Guessed BIOS device 0x%x not found by probes, defaulting to disk0:\n", biosdev);
 296         new_currdev.dd.d_unit = 0;
 297     }
 298
 299     env_setenv("currdev", EV_VOLATILE, i386_fmtdev(&new_currdev),
 300                i386_setcurrdev, env_nounset);
 301     env_setenv("loaddev", EV_VOLATILE, i386_fmtdev(&new_currdev), env_noset,
 302                env_nounset);
 303 }
 304
 305 COMMAND_SET(reboot, "reboot", "reboot the system", command_reboot);
 306
 307 static int
 308 command_reboot(int argc, char *argv[])
 309 {
 310     int i;
 311
 312     for (i = 0; devsw[i] != NULL; ++i)
 313         if (devsw[i]->dv_cleanup != NULL)
 314             (devsw[i]->dv_cleanup)();
 315
 316     printf("Rebooting...\n");
 317     delay(1000000);
 318     __exit(0);
 319 }
 320
 321 /* provide this for panic, as it's not in the startup code */
 322 void
 323 exit(int code)
 324 {
 325     __exit(code);
 326 }
 327
 328 COMMAND_SET(heap, "heap", "show heap usage", command_heap);
 329
 330 static int
 331 command_heap(int argc, char *argv[])
 332 {
 333     mallocstats();
 334     printf("heap base at %p, top at %p, upper limit at %p\n", heap_bottom,
 335       sbrk(0), heap_top);
 336     return(CMD_OK);
 337 }
 338
 339 #ifdef LOADER_ZFS_SUPPORT
 340 COMMAND_SET(lszfs, "lszfs", "list child datasets of a zfs dataset",
 341     command_lszfs);
 342
 343 static int
 344 command_lszfs(int argc, char *argv[])
 345 {
 346     int err;
 347
 348     if (argc != 2) {
 349         command_errmsg = "wrong number of arguments";
 350         return (CMD_ERROR);
 351     }
 352
 353     err = zfs_list(argv[1]);
 354     if (err != 0) {
 355         command_errmsg = strerror(err);
 356         return (CMD_ERROR);
 357     }
 358
 359     return (CMD_OK);
 360 }
 361
 362 #ifdef __FreeBSD__
 363 COMMAND_SET(reloadbe, "reloadbe", "refresh the list of ZFS Boot Environments",
 364     command_reloadbe);
 365
 366 static int
 367 command_reloadbe(int argc, char *argv[])
 368 {
 369     int err;
 370     char *root;
 371
 372     if (argc > 2) {
 373         command_errmsg = "wrong number of arguments";
 374         return (CMD_ERROR);
 375     }
 376
 377     if (argc == 2) {
 378         err = zfs_bootenv(argv[1]);
 379     } else {
 380         root = getenv("zfs_be_root");
 381         if (root == NULL) {
 382             /* There does not appear to be a ZFS pool here, exit without error */
 383             return (CMD_OK);
 384         }
 385         err = zfs_bootenv(getenv("zfs_be_root"));
 386     }
 387
 388     if (err != 0) {
 389         command_errmsg = strerror(err);
 390         return (CMD_ERROR);
 391     }
 392
 393     return (CMD_OK);
 394 }
 395 #endif /* __FreeBSD__ */
 396 #endif
 397
 398 /* ISA bus access functions for PnP. */
 399 static int
 400 isa_inb(int port)
 401 {
 402
 403     return (inb(port));
 404 }
 405
 406 static void
 407 isa_outb(int port, int value)
 408 {
 409
 410     outb(port, value);
 411 }
 412
 413 #ifdef LOADER_ZFS_SUPPORT
 414 static void
 415 i386_zfs_probe(void)
 416 {
 417     char devname[32];
 418     int unit;
 419
 420     /*
 421      * Open all the disks we can find and see if we can reconstruct
 422      * ZFS pools from them.
 423      */
 424     for (unit = 0; unit < MAXBDDEV; unit++) {
 425         if (bd_unit2bios(unit) == -1)
 426             break;
 427         if (bd_unit2bios(unit) < 0x80)
 428             continue;
 429         sprintf(devname, "disk%d:", unit);
 430         zfs_probe_dev(devname, NULL);
 431     }
 432 }
 433
 434 uint64_t
 435 ldi_get_size(void *priv)
 436 {
 437         int fd = (uintptr_t) priv;
 438         uint64_t size;
 439
 440         ioctl(fd, DIOCGMEDIASIZE, &size);
 441         return (size);
 442 }
 443 #endif