2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
33 #include "bootstrap.h"
35 const char *command_errmsg;
36 /* XXX should have procedural interface for setting, size limit? */
37 char command_errbuf[COMMAND_ERRBUFSZ];
39 static int page_file(char *filename);
42 * Help is read from a formatted text file.
44 * Entries in the file are formatted as
46 # Ttopic [Ssubtopic] Ddescription
53 * Note that for code simplicity's sake, the above format must be followed
56 * Subtopic entries must immediately follow the topic (this is used to
57 * produce the listing of subtopics).
59 * If no argument(s) are supplied by the user, the help for 'help' is displayed.
61 COMMAND_SET(help, "help", "detailed help", command_help);
64 help_getnext(int fd, char **topic, char **subtopic, char **desc)
66 char line[81], *cp, *ep;
68 /* Make sure we provide sane values. */
69 *topic = *subtopic = *desc = NULL;
71 if (fgetstr(line, 80, fd) < 0)
74 if (strlen(line) < 3 || line[0] != '#' || line[1] != ' ')
78 while (cp != NULL && *cp != 0) {
80 if (*cp == 'T' && *topic == NULL) {
83 *topic = strdup(cp + 1);
84 } else if (*cp == 'S' && *subtopic == NULL) {
87 *subtopic = strdup(cp + 1);
88 } else if (*cp == 'D') {
89 *desc = strdup(cp + 1);
97 *subtopic = *desc = NULL;
105 help_emitsummary(char *topic, char *subtopic, char *desc)
112 if (subtopic != NULL) {
114 pager_output(subtopic);
115 i += strlen(subtopic) + 1;
123 return (pager_output("\n"));
128 command_help(int argc, char *argv[])
130 char buf[81]; /* XXX buffer size? */
131 int hfd, matched, doindex;
132 char *topic, *subtopic, *t, *s, *d;
134 /* page the help text from our load path */
135 snprintf(buf, sizeof(buf), "%s/boot/loader.help", getenv("loaddev"));
136 if ((hfd = open(buf, O_RDONLY)) < 0) {
137 printf("Verbose help not available, "
138 "use '?' to list commands\n");
142 /* pick up request from arguments */
143 topic = subtopic = NULL;
146 subtopic = strdup(argv[2]);
149 topic = strdup(argv[1]);
152 topic = strdup("help");
155 command_errmsg = "usage is 'help <topic> [<subtopic>]";
160 /* magic "index" keyword */
161 doindex = strcmp(topic, "index") == 0? 1 : 0;
164 /* Scan the helpfile looking for help matching the request */
166 while (help_getnext(hfd, &t, &s, &d)) {
168 if (doindex) { /* dink around formatting */
169 if (help_emitsummary(t, s, d))
172 } else if (strcmp(topic, t)) {
175 /* nothing more on this topic, stop scanning */
181 if ((subtopic == NULL && s == NULL) ||
182 (subtopic != NULL && s != NULL &&
183 strcmp(subtopic, s) == 0)) {
184 /* exact match, print text */
185 while (fgetstr(buf, 80, hfd) >= 0 &&
187 if (pager_output(buf))
189 if (pager_output("\n"))
192 } else if (subtopic == NULL && s != NULL) {
193 /* topic match, list subtopics */
194 if (help_emitsummary(t, s, d))
209 snprintf(command_errbuf, sizeof(command_errbuf),
210 "no help available for '%s'", topic);
220 COMMAND_SET(commandlist, "?", "list commands", command_commandlist);
223 * Please note: although we use the pager for the list of commands,
224 * this routine is called from the ? FORTH function which then
225 * unconditionally prints some commands. This will lead to anomalous
226 * behavior. There's no 'pager_output' binding to FORTH to allow
227 * things to work right, so I'm documenting the bug rather than
231 command_commandlist(int argc __unused, char *argv[] __unused)
233 struct bootblk_command **cmdp;
239 res = pager_output("Available commands:\n");
240 SET_FOREACH(cmdp, Xcommand_set) {
243 if ((*cmdp)->c_name != NULL && (*cmdp)->c_desc != NULL) {
244 snprintf(name, sizeof(name), " %-15s ",
247 pager_output((*cmdp)->c_desc);
248 res = pager_output("\n");
256 * XXX set/show should become set/echo if we have variable
257 * substitution happening.
260 COMMAND_SET(show, "show", "show variable(s)", command_show);
263 command_show(int argc, char *argv[])
270 * With no arguments, print everything.
273 for (ev = environ; ev != NULL; ev = ev->ev_next) {
274 pager_output(ev->ev_name);
275 cp = getenv(ev->ev_name);
280 if (pager_output("\n"))
285 if ((cp = getenv(argv[1])) != NULL) {
288 snprintf(command_errbuf, sizeof(command_errbuf),
289 "variable '%s' not found", argv[1]);
296 COMMAND_SET(set, "set", "set a variable", command_set);
299 command_set(int argc, char *argv[])
304 command_errmsg = "wrong number of arguments";
307 #ifdef LOADER_VERIEXEC
309 * Impose restrictions if input is not verified
311 const char *restricted[] = {
323 ves = ve_status_get(-1);
324 if (ves == VE_UNVERIFIED_OK) {
325 #ifdef LOADER_VERIEXEC_TESTING
326 printf("Checking: %s\n", argv[1]);
328 for (cp = restricted; *cp; cp++) {
329 if (strncmp(argv[1], *cp, strlen(*cp)) == 0) {
330 printf("Ignoring restricted variable: %s\n",
337 if ((err = putenv(argv[1])) != 0) {
338 command_errmsg = strerror(err);
345 COMMAND_SET(unset, "unset", "unset a variable", command_unset);
348 command_unset(int argc, char *argv[])
353 command_errmsg = "wrong number of arguments";
356 if ((err = unsetenv(argv[1])) != 0) {
357 command_errmsg = strerror(err);
364 COMMAND_SET(echo, "echo", "echo arguments", command_echo);
367 command_echo(int argc, char *argv[])
375 while ((ch = getopt(argc, argv, "n")) != -1) {
382 /* getopt has already reported an error */
389 s = unargv(argc, argv);
400 * A passable emulation of the sh(1) command of the same name.
403 COMMAND_SET(read, "read", "read input from the terminal", command_read);
406 command_read(int argc, char *argv[])
413 char buf[256]; /* XXX size? */
420 while ((c = getopt(argc, argv, "p:t:")) != -1) {
426 timeout = strtol(optarg, &cp, 0);
428 snprintf(command_errbuf,
429 sizeof(command_errbuf),
430 "bad timeout '%s'", optarg);
441 name = (argc > 0) ? argv[0]: NULL;
444 printf("%s", prompt);
446 when = time(NULL) + timeout;
448 if (time(NULL) >= when)
449 return (CMD_OK); /* is timeout an error? */
452 ngets(buf, sizeof(buf));
455 setenv(name, buf, 1);
462 COMMAND_SET(more, "more", "show contents of a file", command_more);
465 command_more(int argc, char *argv[])
473 for (i = 1; (i < argc) && (res == 0); i++) {
474 snprintf(line, sizeof(line), "*** FILE %s BEGIN ***\n",
476 if (pager_output(line))
478 res = page_file(argv[i]);
480 snprintf(line, sizeof(line), "*** FILE %s END ***\n",
482 res = pager_output(line);
494 page_file(char *filename)
498 result = pager_file(filename);
501 snprintf(command_errbuf, sizeof(command_errbuf),
502 "error showing %s", filename);
509 * List all disk-like devices
511 COMMAND_SET(lsdev, "lsdev", "list all devices", command_lsdev);
514 command_lsdev(int argc, char *argv[])
522 while ((ch = getopt(argc, argv, "v")) != -1) {
529 /* getopt has already reported an error */
537 for (i = 0; devsw[i] != NULL; i++) {
538 if (devsw[i]->dv_print != NULL) {
539 if (devsw[i]->dv_print(verbose))
542 snprintf(line, sizeof(line), "%s: (unknown)\n",
544 if (pager_output(line))