2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
6 * Copyright (c) 1998 Robert Nordier
8 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
10 * Copyright (c) 2014 Roger Pau Monné <roger.pau@citrix.com>
11 * All Rights Reserved.
12 * Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
13 * Copyright (c) 2018 Netflix, Inc.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer
20 * in this position and unchanged.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 #include <sys/cdefs.h>
39 /* Note: This is compiled in both the kernel and boot loader contexts */
41 #include <sys/param.h>
43 #include <sys/systm.h>
47 #include <sys/reboot.h>
49 #include <sys/tslog.h>
52 #define SETENV(k, v) kern_setenv(k, v)
53 #define GETENV(k) kern_getenv(k)
54 #define FREE(v) freeenv(v)
55 #else /* Boot loader */
56 #define SETENV(k, v) setenv(k, v, 1)
57 #define GETENV(k) getenv(k)
66 { "boot_askname", RB_ASKNAME},
67 { "boot_cdrom", RB_CDROM},
68 { "boot_ddb", RB_KDB},
69 { "boot_dfltroot", RB_DFLTROOT},
70 { "boot_gdb", RB_GDB},
71 { "boot_multicons", RB_MULTIPLE},
72 { "boot_mute", RB_MUTE},
73 { "boot_pause", RB_PAUSE},
74 { "boot_serial", RB_SERIAL},
75 { "boot_single", RB_SINGLE},
76 { "boot_verbose", RB_VERBOSE},
81 * In the boot environment, we often parse a command line and have to throw away
82 * its contents. As we do so, we set environment variables that correspond to
83 * the flags we encounter. Later, to get a howto mask, we grovel through these
84 * to reconstruct it. This also allows users in their loader.conf to set them
85 * and have the kernel see them.
89 * @brief convert the env vars in howto_names into a howto mask
92 boot_env_to_howto(void)
98 for (howto = 0, i = 0; howto_names[i].ev != NULL; i++) {
99 val = GETENV(howto_names[i].ev);
100 if (val != NULL && strcasecmp(val, "no") != 0)
101 howto |= howto_names[i].mask;
109 * @brief Set env vars from howto_names based on howto passed in
112 boot_howto_to_env(int howto)
116 for (i = 0; howto_names[i].ev != NULL; i++)
117 if (howto & howto_names[i].mask)
118 SETENV(howto_names[i].ev, "YES");
122 * @brief Helper routine to parse a single arg and return its mask
124 * Parse all the - options to create a mask (or a serial speed in the
125 * case of -S). If the arg doesn't start with '-' assume it's an env
126 * variable and set that instead.
129 boot_parse_arg(const char *v)
135 /* Need to see if this is better or worse than the meat of the #else */
136 static const char howto_switches[] = "aCdrgDmphsv";
137 static int howto_masks[] = {
138 RB_ASKNAME, RB_CDROM, RB_KDB, RB_DFLTROOT, RB_GDB, RB_MULTIPLE,
139 RB_MUTE, RB_PAUSE, RB_SERIAL, RB_SINGLE, RB_VERBOSE
142 opts = strchr(kargs, '-');
143 while (opts != NULL) {
144 while (*(++opts) != '\0') {
145 sw = strchr(howto_switches, *opts);
148 howto |= howto_masks[sw - howto_switches];
150 opts = strchr(opts, '-');
158 case 'a': howto |= RB_ASKNAME; break;
159 case 'C': howto |= RB_CDROM; break;
160 case 'd': howto |= RB_KDB; break;
161 case 'D': howto |= RB_MULTIPLE; break;
162 case 'm': howto |= RB_MUTE; break;
163 case 'g': howto |= RB_GDB; break;
164 case 'h': howto |= RB_SERIAL; break;
165 case 'p': howto |= RB_PAUSE; break;
166 case 'P': howto |= RB_PROBE; break;
167 case 'r': howto |= RB_DFLTROOT; break;
168 case 's': howto |= RB_SINGLE; break;
169 case 'S': SETENV("comconsole_speed", v + 1); v += strlen(v); break;
170 case 'v': howto |= RB_VERBOSE; break;
177 strlcpy(buf, v, sizeof(buf));
178 n = strsep(&vv, "=");
189 * @brief breakup the command line into args, and pass to boot_parse_arg
192 boot_parse_cmdline_delim(char *cmdline, const char *delim)
199 while ((v = strsep(&cmdline, delim)) != NULL) {
202 howto |= boot_parse_arg(v);
209 * @brief Simplified interface for common 'space or tab separated' args
212 boot_parse_cmdline(char *cmdline)
215 return (boot_parse_cmdline_delim(cmdline, " \t\n"));
219 * @brief Pass a vector of strings to boot_parse_arg
222 boot_parse_args(int argc, char *argv[])
227 for (i = 1; i < argc; i++)
228 howto |= boot_parse_arg(argv[i]);