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