xref: /freebsd/stand/common/boot.c (revision 190cef3d)
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  * Loading modules, booting the system
32  */
33 
34 #include <stand.h>
35 #include <sys/reboot.h>
36 #include <sys/boot.h>
37 #include <string.h>
38 
39 #include "bootstrap.h"
40 
41 static int	autoboot(int timeout, char *prompt);
42 static char	*getbootfile(int try);
43 static int	loadakernel(int try, int argc, char* argv[]);
44 
45 /* List of kernel names to try (may be overwritten by boot.config) XXX should move from here? */
46 static const char *default_bootfiles = "kernel";
47 
48 static int autoboot_tried;
49 
50 /*
51  * The user wants us to boot.
52  */
53 COMMAND_SET(boot, "boot", "boot a file or loaded kernel", command_boot);
54 
55 static int
56 command_boot(int argc, char *argv[])
57 {
58 	struct preloaded_file	*fp;
59 
60 	/*
61 	 * See if the user has specified an explicit kernel to boot.
62 	 */
63 	if ((argc > 1) && (argv[1][0] != '-')) {
64 
65 		/* XXX maybe we should discard everything and start again? */
66 		if (file_findfile(NULL, NULL) != NULL) {
67 			snprintf(command_errbuf, sizeof(command_errbuf),
68 			    "can't boot '%s', kernel module already loaded", argv[1]);
69 			return(CMD_ERROR);
70 		}
71 
72 		/* find/load the kernel module */
73 		if (mod_loadkld(argv[1], argc - 2, argv + 2) != 0)
74 			return(CMD_ERROR);
75 		/* we have consumed all arguments */
76 		argc = 1;
77 	}
78 
79 	/*
80 	 * See if there is a kernel module already loaded
81 	 */
82 	if (file_findfile(NULL, NULL) == NULL)
83 		if (loadakernel(0, argc - 1, argv + 1))
84 			/* we have consumed all arguments */
85 			argc = 1;
86 
87 	/*
88 	 * Loaded anything yet?
89 	 */
90 	if ((fp = file_findfile(NULL, NULL)) == NULL) {
91 		command_errmsg = "no bootable kernel";
92 		return(CMD_ERROR);
93 	}
94 
95 	/*
96 	 * If we were given arguments, discard any previous.
97 	 * XXX should we merge arguments?  Hard to DWIM.
98 	 */
99 	if (argc > 1) {
100 		if (fp->f_args != NULL)
101 			free(fp->f_args);
102 		fp->f_args = unargv(argc - 1, argv + 1);
103 	}
104 
105 	/* Hook for platform-specific autoloading of modules */
106 	if (archsw.arch_autoload() != 0)
107 		return(CMD_ERROR);
108 
109 	/* Call the exec handler from the loader matching the kernel */
110 	file_formats[fp->f_loader]->l_exec(fp);
111 	return(CMD_ERROR);
112 }
113 
114 
115 /*
116  * Autoboot after a delay
117  */
118 
119 COMMAND_SET(autoboot, "autoboot", "boot automatically after a delay", command_autoboot);
120 
121 static int
122 command_autoboot(int argc, char *argv[])
123 {
124 	int		howlong;
125 	char	*cp, *prompt;
126 
127 	prompt = NULL;
128 	howlong = -1;
129 	switch(argc) {
130 	case 3:
131 		prompt = argv[2];
132 		/* FALLTHROUGH */
133 	case 2:
134 		howlong = strtol(argv[1], &cp, 0);
135 		if (*cp != 0) {
136 			snprintf(command_errbuf, sizeof(command_errbuf),
137 			    "bad delay '%s'", argv[1]);
138 			return(CMD_ERROR);
139 		}
140 		/* FALLTHROUGH */
141 	case 1:
142 		return(autoboot(howlong, prompt));
143 	}
144 
145 	command_errmsg = "too many arguments";
146 	return(CMD_ERROR);
147 }
148 
149 /*
150  * Called before we go interactive.  If we think we can autoboot, and
151  * we haven't tried already, try now.
152  */
153 void
154 autoboot_maybe()
155 {
156 	char	*cp;
157 
158 	cp = getenv("autoboot_delay");
159 	if ((autoboot_tried == 0) && ((cp == NULL) || strcasecmp(cp, "NO")))
160 		autoboot(-1, NULL);		/* try to boot automatically */
161 }
162 
163 static int
164 autoboot(int timeout, char *prompt)
165 {
166 	time_t	when, otime, ntime;
167 	int		c, yes;
168 	char	*argv[2], *cp, *ep;
169 	char	*kernelname;
170 #ifdef BOOT_PROMPT_123
171 	const char	*seq = "123", *p = seq;
172 #endif
173 
174 	autoboot_tried = 1;
175 
176 	if (timeout == -1) {
177 		timeout = 10;
178 		/* try to get a delay from the environment */
179 		if ((cp = getenv("autoboot_delay"))) {
180 			timeout = strtol(cp, &ep, 0);
181 			if (cp == ep)
182 				timeout = 10;		/* Unparseable? Set default! */
183 		}
184 	}
185 
186 	kernelname = getenv("kernelname");
187 	if (kernelname == NULL) {
188 		argv[0] = NULL;
189 		loadakernel(0, 0, argv);
190 		kernelname = getenv("kernelname");
191 		if (kernelname == NULL) {
192 			command_errmsg = "no valid kernel found";
193 			return(CMD_ERROR);
194 		}
195 	}
196 
197 	if (timeout >= 0) {
198 		otime = time(NULL);
199 		when = otime + timeout;	/* when to boot */
200 
201 		yes = 0;
202 
203 #ifdef BOOT_PROMPT_123
204 		printf("%s\n", (prompt == NULL) ? "Hit [Enter] to boot immediately, or "
205 		    "1 2 3 sequence for command prompt." : prompt);
206 #else
207 		printf("%s\n", (prompt == NULL) ? "Hit [Enter] to boot immediately, or any other key for command prompt." : prompt);
208 #endif
209 
210 		for (;;) {
211 			if (ischar()) {
212 				c = getchar();
213 #ifdef BOOT_PROMPT_123
214 				if ((c == '\r') || (c == '\n')) {
215 					yes = 1;
216 					break;
217 				} else if (c != *p++)
218 					p = seq;
219 				if (*p == 0)
220 					break;
221 #else
222 				if ((c == '\r') || (c == '\n'))
223 					yes = 1;
224 				break;
225 #endif
226 			}
227 			ntime = time(NULL);
228 			if (ntime >= when) {
229 				yes = 1;
230 				break;
231 			}
232 
233 			if (ntime != otime) {
234 				printf("\rBooting [%s] in %d second%s... ",
235 				    kernelname, (int)(when - ntime),
236 				    (when-ntime)==1?"":"s");
237 				otime = ntime;
238 			}
239 		}
240 	} else {
241 		yes = 1;
242 	}
243 
244 	if (yes)
245 		printf("\rBooting [%s]...               ", kernelname);
246 	putchar('\n');
247 	if (yes) {
248 		argv[0] = "boot";
249 		argv[1] = NULL;
250 		return(command_boot(1, argv));
251 	}
252 	return(CMD_OK);
253 }
254 
255 /*
256  * Scrounge for the name of the (try)'th file we will try to boot.
257  */
258 static char *
259 getbootfile(int try)
260 {
261 	static char *name = NULL;
262 	const char	*spec, *ep;
263 	size_t	len;
264 
265 	/* we use dynamic storage */
266 	if (name != NULL) {
267 		free(name);
268 		name = NULL;
269 	}
270 
271 	/*
272 	 * Try $bootfile, then try our builtin default
273 	 */
274 	if ((spec = getenv("bootfile")) == NULL)
275 		spec = default_bootfiles;
276 
277 	while ((try > 0) && (spec != NULL)) {
278 		spec = strchr(spec, ';');
279 		if (spec)
280 			spec++;	/* skip over the leading ';' */
281 		try--;
282 	}
283 	if (spec != NULL) {
284 		if ((ep = strchr(spec, ';')) != NULL) {
285 			len = ep - spec;
286 		} else {
287 			len = strlen(spec);
288 		}
289 		name = malloc(len + 1);
290 		strncpy(name, spec, len);
291 		name[len] = 0;
292 	}
293 	if (name && name[0] == 0) {
294 		free(name);
295 		name = NULL;
296 	}
297 	return(name);
298 }
299 
300 /*
301  * Try to find the /etc/fstab file on the filesystem (rootdev),
302  * which should be be the root filesystem, and parse it to find
303  * out what the kernel ought to think the root filesystem is.
304  *
305  * If we're successful, set vfs.root.mountfrom to <vfstype>:<path>
306  * so that the kernel can tell both which VFS and which node to use
307  * to mount the device.  If this variable's already set, don't
308  * overwrite it.
309  */
310 int
311 getrootmount(char *rootdev)
312 {
313 	char	lbuf[128], *cp, *ep, *dev, *fstyp, *options;
314 	int		fd, error;
315 
316 	if (getenv("vfs.root.mountfrom") != NULL)
317 		return(0);
318 
319 	error = 1;
320 	sprintf(lbuf, "%s/etc/fstab", rootdev);
321 	if ((fd = open(lbuf, O_RDONLY)) < 0)
322 		goto notfound;
323 
324 	/* loop reading lines from /etc/fstab    What was that about sscanf again? */
325 	fstyp = NULL;
326 	dev = NULL;
327 	while (fgetstr(lbuf, sizeof(lbuf), fd) >= 0) {
328 		if ((lbuf[0] == 0) || (lbuf[0] == '#'))
329 			continue;
330 
331 		/* skip device name */
332 		for (cp = lbuf; (*cp != 0) && !isspace(*cp); cp++)
333 			;
334 		if (*cp == 0)		/* misformatted */
335 			continue;
336 		/* delimit and save */
337 		*cp++ = 0;
338 		free(dev);
339 		dev = strdup(lbuf);
340 
341 		/* skip whitespace up to mountpoint */
342 		while ((*cp != 0) && isspace(*cp))
343 			cp++;
344 		/* must have /<space> to be root */
345 		if ((*cp == 0) || (*cp != '/') || !isspace(*(cp + 1)))
346 			continue;
347 		/* skip whitespace up to fstype */
348 		cp += 2;
349 		while ((*cp != 0) && isspace(*cp))
350 			cp++;
351 		if (*cp == 0)		/* misformatted */
352 			continue;
353 		/* skip text to end of fstype and delimit */
354 		ep = cp;
355 		while ((*cp != 0) && !isspace(*cp))
356 			cp++;
357 		*cp = 0;
358 		free(fstyp);
359 		fstyp = strdup(ep);
360 
361 		/* skip whitespace up to mount options */
362 		cp += 1;
363 		while ((*cp != 0) && isspace(*cp))
364 			cp++;
365 		if (*cp == 0)           /* misformatted */
366 			continue;
367 		/* skip text to end of mount options and delimit */
368 		ep = cp;
369 		while ((*cp != 0) && !isspace(*cp))
370 			cp++;
371 		*cp = 0;
372 		options = strdup(ep);
373 		/* Build the <fstype>:<device> and save it in vfs.root.mountfrom */
374 		sprintf(lbuf, "%s:%s", fstyp, dev);
375 		setenv("vfs.root.mountfrom", lbuf, 0);
376 
377 		/* Don't override vfs.root.mountfrom.options if it is already set */
378 		if (getenv("vfs.root.mountfrom.options") == NULL) {
379 			/* save mount options */
380 			setenv("vfs.root.mountfrom.options", options, 0);
381 		}
382 		free(options);
383 		error = 0;
384 		break;
385 	}
386 	close(fd);
387 	free(dev);
388 	free(fstyp);
389 
390 notfound:
391 	if (error) {
392 		const char *currdev;
393 
394 		currdev = getenv("currdev");
395 		if (currdev != NULL && strncmp("zfs:", currdev, 4) == 0) {
396 			cp = strdup(currdev);
397 			cp[strlen(cp) - 1] = '\0';
398 			setenv("vfs.root.mountfrom", cp, 0);
399 			error = 0;
400 			free(cp);
401 		}
402 	}
403 
404 	return(error);
405 }
406 
407 static int
408 loadakernel(int try, int argc, char* argv[])
409 {
410 	char *cp;
411 
412 	for (try = 0; (cp = getbootfile(try)) != NULL; try++)
413 		if (mod_loadkld(cp, argc - 1, argv + 1) != 0)
414 			printf("can't load '%s'\n", cp);
415 		else
416 			return 1;
417 	return 0;
418 }
419