bootinfo64.c revision 88874 
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 * $FreeBSD: head/sys/boot/i386/libi386/bootinfo64.c 88874 2002-01-04 07:59:27Z jhb $
27 */
28
29#include <stand.h>
30#include <sys/param.h>
31#include <sys/reboot.h>
32#include <sys/linker.h>
33#include <machine/bootinfo.h>
34#include "bootstrap.h"
35#include "libi386.h"
36#include "btxv86.h"
37
38static struct bootinfo	bi;
39
40/*
41 * Return a 'boothowto' value corresponding to the kernel arguments in
42 * (kargs) and any relevant environment variables.
43 */
44static struct
45{
46    const char	*ev;
47    int		mask;
48} howto_names[] = {
49    {"boot_askname",	RB_ASKNAME},
50    {"boot_cdrom",	RB_CDROM},
51    {"boot_userconfig",	RB_CONFIG},
52    {"boot_ddb",	RB_KDB},
53    {"boot_gdb",	RB_GDB},
54    {"boot_single",	RB_SINGLE},
55    {"boot_verbose",	RB_VERBOSE},
56    {NULL,	0}
57};
58
59vm_offset_t	bi_copymodules(vm_offset_t addr);
60
61int
62bi_getboothowto(char *kargs)
63{
64    char	*cp;
65    int		howto;
66    int		active;
67    int		i;
68
69    /* Parse kargs */
70    howto = 0;
71    if (kargs  != NULL) {
72	cp = kargs;
73	active = 0;
74	while (*cp != 0) {
75	    if (!active && (*cp == '-')) {
76		active = 1;
77	    } else if (active)
78		switch (*cp) {
79		case 'a':
80		    howto |= RB_ASKNAME;
81		    break;
82		case 'c':
83		    howto |= RB_CONFIG;
84		    break;
85		case 'C':
86		    howto |= RB_CDROM;
87		    break;
88		case 'd':
89		    howto |= RB_KDB;
90		    break;
91		case 'D':
92		    howto |= RB_MULTIPLE;
93		    break;
94		case 'm':
95		    howto |= RB_MUTE;
96		    break;
97		case 'g':
98		    howto |= RB_GDB;
99		    break;
100		case 'h':
101		    howto |= RB_SERIAL;
102		    break;
103		case 'p':
104		    howto |= RB_PAUSE;
105		    break;
106		case 'r':
107		    howto |= RB_DFLTROOT;
108		    break;
109		case 's':
110		    howto |= RB_SINGLE;
111		    break;
112		case 'v':
113		    howto |= RB_VERBOSE;
114		    break;
115		default:
116		    active = 0;
117		    break;
118		}
119	    cp++;
120	}
121    }
122    /* get equivalents from the environment */
123    for (i = 0; howto_names[i].ev != NULL; i++)
124	if (getenv(howto_names[i].ev) != NULL)
125	    howto |= howto_names[i].mask;
126    if (!strcmp(getenv("console"), "comconsole"))
127	howto |= RB_SERIAL;
128    if (!strcmp(getenv("console"), "nullconsole"))
129	howto |= RB_MUTE;
130    return(howto);
131}
132
133/*
134 * Copy the environment into the load area starting at (addr).
135 * Each variable is formatted as <name>=<value>, with a single nul
136 * separating each variable, and a double nul terminating the environment.
137 */
138vm_offset_t
139bi_copyenv(vm_offset_t addr)
140{
141    struct env_var	*ep;
142
143    /* traverse the environment */
144    for (ep = environ; ep != NULL; ep = ep->ev_next) {
145	i386_copyin(ep->ev_name, addr, strlen(ep->ev_name));
146	addr += strlen(ep->ev_name);
147	i386_copyin("=", addr, 1);
148	addr++;
149	if (ep->ev_value != NULL) {
150	    i386_copyin(ep->ev_value, addr, strlen(ep->ev_value));
151	    addr += strlen(ep->ev_value);
152	}
153	i386_copyin("", addr, 1);
154	addr++;
155    }
156    i386_copyin("", addr, 1);
157    addr++;
158    return(addr);
159}
160
161/*
162 * Copy module-related data into the load area, where it can be
163 * used as a directory for loaded modules.
164 *
165 * Module data is presented in a self-describing format.  Each datum
166 * is preceded by a 32-bit identifier and a 32-bit size field.
167 *
168 * Currently, the following data are saved:
169 *
170 * MOD_NAME	(variable)		module name (string)
171 * MOD_TYPE	(variable)		module type (string)
172 * MOD_ARGS	(variable)		module parameters (string)
173 * MOD_ADDR	sizeof(vm_offset_t)	module load address
174 * MOD_SIZE	sizeof(size_t)		module size
175 * MOD_METADATA	(variable)		type-specific metadata
176 */
177#define COPY32(v, a) {				\
178    u_int32_t	x = (v);			\
179    i386_copyin(&x, a, sizeof(x));		\
180    a += sizeof(x);				\
181}
182
183#define MOD_STR(t, a, s) {			\
184    COPY32(t, a);				\
185    COPY32(strlen(s) + 1, a);			\
186    i386_copyin(s, a, strlen(s) + 1);		\
187    a += roundup(strlen(s) + 1, sizeof(u_long));\
188}
189
190#define MOD_NAME(a, s)	MOD_STR(MODINFO_NAME, a, s)
191#define MOD_TYPE(a, s)	MOD_STR(MODINFO_TYPE, a, s)
192#define MOD_ARGS(a, s)	MOD_STR(MODINFO_ARGS, a, s)
193
194#define MOD_VAR(t, a, s) {			\
195    COPY32(t, a);				\
196    COPY32(sizeof(s), a);			\
197    i386_copyin(&s, a, sizeof(s));		\
198    a += roundup(sizeof(s), sizeof(u_long));	\
199}
200
201#define MOD_ADDR(a, s)	MOD_VAR(MODINFO_ADDR, a, s)
202#define MOD_SIZE(a, s)	MOD_VAR(MODINFO_SIZE, a, s)
203
204#define MOD_METADATA(a, mm) {			\
205    COPY32(MODINFO_METADATA | mm->md_type, a);	\
206    COPY32(mm->md_size, a);			\
207    i386_copyin(mm->md_data, a, mm->md_size);	\
208    a += roundup(mm->md_size, sizeof(u_long));\
209}
210
211#define MOD_END(a) {				\
212    COPY32(MODINFO_END, a);			\
213    COPY32(0, a);				\
214}
215
216vm_offset_t
217bi_copymodules(vm_offset_t addr)
218{
219    struct preloaded_file	*fp;
220    struct file_metadata	*md;
221
222    /* start with the first module on the list, should be the kernel */
223    for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) {
224
225	MOD_NAME(addr, fp->f_name);	/* this field must come first */
226	MOD_TYPE(addr, fp->f_type);
227	if (fp->f_args)
228	    MOD_ARGS(addr, fp->f_args);
229	MOD_ADDR(addr, fp->f_addr);
230	MOD_SIZE(addr, fp->f_size);
231	for (md = fp->f_metadata; md != NULL; md = md->md_next)
232	    if (!(md->md_type & MODINFOMD_NOCOPY))
233		MOD_METADATA(addr, md);
234    }
235    MOD_END(addr);
236    return(addr);
237}
238
239/*
240 * Load the information expected by an i386 kernel.
241 *
242 * - The 'boothowto' argument is constructed
243 * - The 'bootdev' argument is constructed
244 * - The 'bootinfo' struct is constructed, and copied into the kernel space.
245 * - The kernel environment is copied into kernel space.
246 * - Module metadata are formatted and placed in kernel space.
247 */
248int
249bi_load(char *args, int *howtop, int *bootdevp, vm_offset_t *bip)
250{
251    struct preloaded_file	*xp;
252    struct i386_devdesc		*rootdev;
253    vm_offset_t			addr;
254    char			*rootdevname;
255    int				bootdevnr, i;
256    u_int			pad;
257    char			*kernelname;
258    const char			*kernelpath;
259
260    *howtop = bi_getboothowto(args);
261
262    /*
263     * Allow the environment variable 'rootdev' to override the supplied device
264     * This should perhaps go to MI code and/or have $rootdev tested/set by
265     * MI code before launching the kernel.
266     */
267    rootdevname = getenv("rootdev");
268    i386_getdev((void **)(&rootdev), rootdevname, NULL);
269    if (rootdev == NULL) {		/* bad $rootdev/$currdev */
270	printf("can't determine root device\n");
271	return(EINVAL);
272    }
273
274    /* Try reading the /etc/fstab file to select the root device */
275    getrootmount(i386_fmtdev((void *)rootdev));
276
277    /* Do legacy rootdev guessing */
278
279    /* XXX - use a default bootdev of 0.  Is this ok??? */
280    bootdevnr = 0;
281
282    switch(rootdev->d_type) {
283    case DEVT_CD:
284	    /* Pass in BIOS device number. */
285	    bi.bi_bios_dev = bc_unit2bios(rootdev->d_kind.bioscd.unit);
286	    bootdevnr = bc_getdev(rootdev);
287	    break;
288
289    case DEVT_DISK:
290	/* pass in the BIOS device number of the current disk */
291	bi.bi_bios_dev = bd_unit2bios(rootdev->d_kind.biosdisk.unit);
292	bootdevnr = bd_getdev(rootdev);
293	break;
294
295    case DEVT_NET:
296	    break;
297
298    default:
299	printf("WARNING - don't know how to boot from device type %d\n", rootdev->d_type);
300    }
301    if (bootdevnr == -1) {
302	printf("root device %s invalid\n", i386_fmtdev(rootdev));
303	return (EINVAL);
304    }
305    free(rootdev);
306    *bootdevp = bootdevnr;
307
308    /* legacy bootinfo structure */
309    bi.bi_version = BOOTINFO_VERSION;
310    bi.bi_kernelname = 0;		/* XXX char * -> kernel name */
311    bi.bi_nfs_diskless = 0;		/* struct nfs_diskless * */
312    bi.bi_n_bios_used = 0;		/* XXX would have to hook biosdisk driver for these */
313    for (i = 0; i < N_BIOS_GEOM; i++)
314        bi.bi_bios_geom[i] = bd_getbigeom(i);
315    bi.bi_size = sizeof(bi);
316    bi.bi_memsizes_valid = 1;
317    bi.bi_basemem = bios_basemem / 1024;
318    bi.bi_extmem = bios_extmem / 1024;
319
320    /* find the last module in the chain */
321    addr = 0;
322    for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
323	if (addr < (xp->f_addr + xp->f_size))
324	    addr = xp->f_addr + xp->f_size;
325    }
326    /* pad to a page boundary */
327    pad = (u_int)addr & PAGE_MASK;
328    if (pad != 0) {
329	pad = PAGE_SIZE - pad;
330	addr += pad;
331    }
332
333    /* copy our environment */
334    bi.bi_envp = addr;
335    addr = bi_copyenv(addr);
336
337    /* pad to a page boundary */
338    pad = (u_int)addr & PAGE_MASK;
339    if (pad != 0) {
340	pad = PAGE_SIZE - pad;
341	addr += pad;
342    }
343    /* copy module list and metadata */
344    bi.bi_modulep = addr;
345    addr = bi_copymodules(addr);
346
347    /* all done copying stuff in, save end of loaded object space */
348    bi.bi_kernend = addr;
349
350    *howtop |= RB_BOOTINFO;		/* it's there now */
351
352    /*
353     * Get the kernel name, strip off any device prefix.
354     */
355    kernelname = getenv("kernelname");
356    i386_getdev(NULL, kernelname, &kernelpath);
357    bi.bi_kernelname = VTOP(kernelpath);
358    *bip = VTOP(&bi);
359
360    return(0);
361}
362