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