xref: /freebsd/stand/i386/loader/main.c (revision 3e15b01d6914c927e37d1699645783acf286655c)

/*-
 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/*
 * MD bootstrap main() and assorted miscellaneous
 * commands.
 */

#include <stand.h>
#include <stddef.h>
#include <string.h>
#include <machine/bootinfo.h>
#include <machine/cpufunc.h>
#include <machine/psl.h>
#include <sys/disk.h>
#include <sys/reboot.h>
#include <common/drv.h>

#include "bootstrap.h"
#include "common/bootargs.h"
#include "libi386/libi386.h"
#include <smbios.h>
#include "btxv86.h"

#ifdef LOADER_ZFS_SUPPORT
#include <sys/zfs_bootenv.h>
#include "libzfs.h"
#endif

_Static_assert(sizeof(struct bootargs) == BOOTARGS_SIZE, "Bootarg size bad");
_Static_assert(offsetof(struct bootargs, bootinfo) == BA_BOOTINFO, "BA_BOOTINFO");
_Static_assert(offsetof(struct bootargs, bootflags) == BA_BOOTFLAGS, "BA_BOOTFLAGS");
_Static_assert(offsetof(struct bootinfo, bi_size) == BI_SIZE, "BI_SIZE");

/* Arguments passed in from the boot1/boot2 loader */
static struct bootargs *kargs;
static uint32_t		initial_howto;
static uint32_t		initial_bootdev;
static struct bootinfo	*initial_bootinfo;

struct arch_switch	archsw;		/* MI/MD interface boundary */

static void		extract_currdev(void);
static int		isa_inb(int port);
static void		isa_outb(int port, int value);
void			exit(int code);
#ifdef LOADER_GELI_SUPPORT
#include "geliboot.h"
struct geli_boot_args	*gargs;
struct geli_boot_data	*gbdata;
#endif
#ifdef LOADER_ZFS_SUPPORT
struct zfs_boot_args	*zargs;
static void		i386_zfs_probe(void);
#endif

/* XXX debugging */
extern char end[];

static void *heap_top;
static void *heap_bottom;

caddr_t
ptov(uintptr_t x)
{
	return (PTOV(x));
}

int
main(void)
{
	/* Pick up arguments */
	kargs = (void *)__args;
	initial_howto = kargs->howto;
	initial_bootdev = kargs->bootdev;
	initial_bootinfo = kargs->bootinfo ?
	    (struct bootinfo *)PTOV(kargs->bootinfo) : NULL;

	/* Initialize the v86 register set to a known-good state. */
	bzero(&v86, sizeof(v86));
	v86.efl = PSL_RESERVED_DEFAULT | PSL_I;

	/*
	 * Initialise the heap as early as possible.
	 * Once this is done, malloc() is usable.
	 */
	bios_getmem();

#if defined(LOADER_BZIP2_SUPPORT) || \
    defined(LOADER_GPT_SUPPORT) || defined(LOADER_ZFS_SUPPORT)
	if (high_heap_size > 0) {
		heap_top = PTOV(high_heap_base + high_heap_size);
		heap_bottom = PTOV(high_heap_base);
		if (high_heap_base < memtop_copyin)
			memtop_copyin = high_heap_base;
	} else
#endif
	{
		heap_top = (void *)PTOV(bios_basemem);
		heap_bottom = (void *)end;
	}
	setheap(heap_bottom, heap_top);

	/*
	 * Now that malloc is usable, allocate a buffer for tslog and start
	 * logging timestamps during the boot process.
	 */
	tslog_init();

	/*
	 * detect ACPI for future reference. This may set console to comconsole
	 * if we do have ACPI SPCR table.
	 */
	biosacpi_detect();

	/*
	 * XXX Chicken-and-egg problem; we want to have console output early,
	 * but some console attributes may depend on reading from eg. the boot
	 * device, which we can't do yet.
	 *
	 * We can use printf() etc. once this is done.
	 * If the previous boot stage has requested a serial console,
	 * prefer that.
	 */
	bi_setboothowto(initial_howto);
	if (initial_howto & RB_MULTIPLE) {
		if (initial_howto & RB_SERIAL)
			setenv("console", "comconsole vidconsole", 1);
		else
			setenv("console", "vidconsole comconsole", 1);
	} else if (initial_howto & RB_SERIAL) {
		setenv("console", "comconsole", 1);
	} else if (initial_howto & RB_MUTE) {
		setenv("console", "nullconsole", 1);
	}
	cons_probe();

	/* Set up currdev variable to have hooks in place. */
	env_setenv("currdev", EV_VOLATILE | EV_NOHOOK, "",
	    gen_setcurrdev, env_nounset);

	/*
	 * Initialise the block cache. Set the upper limit.
	 */
	bcache_init(32768, 512);

	/*
	 * Special handling for PXE and CD booting.
	 */
	if (kargs->bootinfo == 0) {
		/*
		 * We only want the PXE disk to try to init itself in the below
		 * walk through devsw if we actually booted off of PXE.
		 */
		if (kargs->bootflags & KARGS_FLAGS_PXE)
			pxe_enable(kargs->pxeinfo ?
			    PTOV(kargs->pxeinfo) : NULL);
		else if (kargs->bootflags & KARGS_FLAGS_CD)
			bc_add(initial_bootdev);
	}

	archsw.arch_autoload = i386_autoload;
	archsw.arch_getdev = i386_getdev;
	archsw.arch_copyin = i386_copyin;
	archsw.arch_copyout = i386_copyout;
	archsw.arch_readin = i386_readin;
	archsw.arch_isainb = isa_inb;
	archsw.arch_isaoutb = isa_outb;
	archsw.arch_hypervisor = x86_hypervisor;
#ifdef LOADER_ZFS_SUPPORT
	archsw.arch_zfs_probe = i386_zfs_probe;

	/*
	 * zfsboot and gptzfsboot have always passed KARGS_FLAGS_ZFS,
	 * so if that is set along with KARGS_FLAGS_EXTARG we know we
	 * can interpret the extarg data as a struct zfs_boot_args.
	 */
#define	KARGS_EXTARGS_ZFS	(KARGS_FLAGS_EXTARG | KARGS_FLAGS_ZFS)

	if ((kargs->bootflags & KARGS_EXTARGS_ZFS) == KARGS_EXTARGS_ZFS) {
		zargs = (struct zfs_boot_args *)(kargs + 1);
	}
#endif /* LOADER_ZFS_SUPPORT */

#ifdef LOADER_GELI_SUPPORT
	/*
	 * If we decided earlier that we have zfs_boot_args extarg data,
	 * and it is big enough to contain the embedded geli data
	 * (the early zfs_boot_args structs weren't), then init the gbdata
	 * pointer accordingly. If there is extarg data which isn't
	 * zfs_boot_args data, determine whether it is geli_boot_args data.
	 * Recent versions of gptboot set KARGS_FLAGS_GELI to indicate that.
	 * Earlier versions didn't, but we presume that's what we
	 * have if the extarg size exactly matches the size of the
	 * geli_boot_args struct during that pre-flag era.
	 */
#define	LEGACY_GELI_ARGS_SIZE	260	/* This can never change */

#ifdef LOADER_ZFS_SUPPORT
	if (zargs != NULL) {
		if (zargs->size > offsetof(struct zfs_boot_args, gelidata)) {
			gbdata = &zargs->gelidata;
		}
	} else
#endif /* LOADER_ZFS_SUPPORT */
	if ((kargs->bootflags & KARGS_FLAGS_EXTARG) != 0) {
		gargs = (struct geli_boot_args *)(kargs + 1);
		if ((kargs->bootflags & KARGS_FLAGS_GELI) ||
		    gargs->size == LEGACY_GELI_ARGS_SIZE) {
			gbdata = &gargs->gelidata;
		}
	}

	if (gbdata != NULL)
		import_geli_boot_data(gbdata);
#endif /* LOADER_GELI_SUPPORT */

	devinit();

	printf("BIOS %dkB/%dkB available memory\n", bios_basemem / 1024,
	    bios_extmem / 1024);
	if (initial_bootinfo != NULL) {
		initial_bootinfo->bi_basemem = bios_basemem / 1024;
		initial_bootinfo->bi_extmem = bios_extmem / 1024;
	}

	/* detect SMBIOS for future reference */
	smbios_detect(NULL);

	/* detect PCI BIOS for future reference */
	biospci_detect();

	printf("\n%s", bootprog_info);

	extract_currdev();		/* set $currdev and $loaddev */
	autoload_font(true);

	bios_getsmap();

	interact();

	/* if we ever get here, it is an error */
	return (1);
}

/*
 * Set the 'current device' by (if possible) recovering the boot device as
 * supplied by the initial bootstrap.
 *
 * XXX should be extended for netbooting.
 */
static void
extract_currdev(void)
{
	struct i386_devdesc	new_currdev;
#ifdef LOADER_ZFS_SUPPORT
	char			buf[20];
	char			*bootonce;
#endif
	int			biosdev = -1;

	/* Assume we are booting from a BIOS disk by default */
	new_currdev.dd.d_dev = &bioshd;

	/* new-style boot loaders such as pxeldr and cdldr */
	if (kargs->bootinfo == 0) {
		if ((kargs->bootflags & KARGS_FLAGS_CD) != 0) {
			/* we are booting from a CD with cdboot */
			new_currdev.dd.d_dev = &bioscd;
			new_currdev.dd.d_unit = bd_bios2unit(initial_bootdev);
		} else if ((kargs->bootflags & KARGS_FLAGS_PXE) != 0) {
			/* we are booting from pxeldr */
			new_currdev.dd.d_dev = &pxedisk;
			new_currdev.dd.d_unit = 0;
		} else {
			/* we don't know what our boot device is */
			new_currdev.disk.d_slice = -1;
			new_currdev.disk.d_partition = 0;
			biosdev = -1;
		}
#ifdef LOADER_ZFS_SUPPORT
	} else if ((kargs->bootflags & KARGS_FLAGS_ZFS) != 0) {
		/*
		 * zargs was set in main() if we have new style extended
		 * argument
		 */
		if (zargs != NULL &&
		    zargs->size >=
		    offsetof(struct zfs_boot_args, primary_pool)) {
			/* sufficient data is provided */
			new_currdev.zfs.pool_guid = zargs->pool;
			new_currdev.zfs.root_guid = zargs->root;
			if (zargs->size >= sizeof(*zargs) &&
			    zargs->primary_vdev != 0) {
				sprintf(buf, "%llu", zargs->primary_pool);
				setenv("vfs.zfs.boot.primary_pool", buf, 1);
				sprintf(buf, "%llu", zargs->primary_vdev);
				setenv("vfs.zfs.boot.primary_vdev", buf, 1);
			}
		} else {
			/* old style zfsboot block */
			new_currdev.zfs.pool_guid = kargs->zfspool;
			new_currdev.zfs.root_guid = 0;
		}
		new_currdev.dd.d_dev = &zfs_dev;

		if ((bootonce = malloc(VDEV_PAD_SIZE)) != NULL) {
			if (zfs_get_bootonce(&new_currdev, OS_BOOTONCE_USED,
			    bootonce, VDEV_PAD_SIZE) == 0) {
				setenv("zfs-bootonce", bootonce, 1);
			}
			free(bootonce);
			(void) zfs_attach_nvstore(&new_currdev);
		}

#endif
	} else if ((initial_bootdev & B_MAGICMASK) != B_DEVMAGIC) {
		/* The passed-in boot device is bad */
		new_currdev.disk.d_slice = -1;
		new_currdev.disk.d_partition = 0;
		biosdev = -1;
	} else {
		new_currdev.disk.d_slice = B_SLICE(initial_bootdev) - 1;
		new_currdev.disk.d_partition = B_PARTITION(initial_bootdev);
		biosdev = initial_bootinfo->bi_bios_dev;

		/*
		 * If we are booted by an old bootstrap, we have to guess at
		 * the BIOS unit number. We will lose if there is more than
		 * one disk type and we are not booting from the
		 * lowest-numbered disk type (ie. SCSI when IDE also exists).
		 */
		if ((biosdev == 0) && (B_TYPE(initial_bootdev) != 2)) {
			/*
			 * biosdev doesn't match major, assume harddisk
			 */
			biosdev = 0x80 + B_UNIT(initial_bootdev);
		}
	}

	/*
	 * If we are booting off of a BIOS disk and we didn't succeed
	 * in determining which one we booted off of, just use disk0:
	 * as a reasonable default.
	 */
	if ((new_currdev.dd.d_dev->dv_type == bioshd.dv_type) &&
	    ((new_currdev.dd.d_unit = bd_bios2unit(biosdev)) == -1)) {
		printf("Can't work out which disk we are booting "
		    "from.\nGuessed BIOS device 0x%x not found by "
		    "probes, defaulting to disk0:\n", biosdev);
		new_currdev.dd.d_unit = 0;
	}

#ifdef LOADER_ZFS_SUPPORT
	if (new_currdev.dd.d_dev->dv_type == DEVT_ZFS)
		init_zfs_boot_options(devformat(&new_currdev.dd));
#endif

	set_currdev(devformat(&new_currdev.dd));
}

COMMAND_SET(reboot, "reboot", "reboot the system", command_reboot);

static int
command_reboot(int argc, char *argv[])
{
	int i;

	for (i = 0; devsw[i] != NULL; ++i)
		if (devsw[i]->dv_cleanup != NULL)
			(devsw[i]->dv_cleanup)();

	printf("Rebooting...\n");
	delay(1000000);
	__exit(0);
}

/* provide this for panic, as it's not in the startup code */
void
exit(int code)
{
	__exit(code);
}

COMMAND_SET(heap, "heap", "show heap usage", command_heap);

static int
command_heap(int argc, char *argv[])
{
	mallocstats();
	printf("heap base at %p, top at %p, upper limit at %p\n", heap_bottom,
	    sbrk(0), heap_top);
	return (CMD_OK);
}

/* ISA bus access functions for PnP. */
static int
isa_inb(int port)
{

	return (inb(port));
}

static void
isa_outb(int port, int value)
{

	outb(port, value);
}

#ifdef LOADER_ZFS_SUPPORT
static void
i386_zfs_probe(void)
{
	char devname[32];
	struct i386_devdesc dev;

	/*
	 * Open all the disks we can find and see if we can reconstruct
	 * ZFS pools from them.
	 */
	dev.dd.d_dev = &bioshd;
	for (dev.dd.d_unit = 0; bd_unit2bios(&dev) >= 0; dev.dd.d_unit++) {
		snprintf(devname, sizeof(devname), "%s%d:", bioshd.dv_name,
		    dev.dd.d_unit);
		zfs_probe_dev(devname, NULL, true);
	}
}
#endif