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