installboot.c revision 1.26
1 /* $NetBSD: installboot.c,v 1.26 2006/04/22 19:57:04 christos Exp $ */ 2 3 /*- 4 * Copyright (c) 2002 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Luke Mewburn of Wasabi Systems. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 #if HAVE_NBTOOL_CONFIG_H 40 #include "nbtool_config.h" 41 #endif 42 43 #include <sys/cdefs.h> 44 #if defined(__RCSID) && !defined(__lint) 45 __RCSID("$NetBSD: installboot.c,v 1.26 2006/04/22 19:57:04 christos Exp $"); 46 #endif /* !__lint */ 47 48 #include <sys/ioctl.h> 49 #include <sys/utsname.h> 50 51 #include <assert.h> 52 #include <err.h> 53 #include <fcntl.h> 54 #include <limits.h> 55 #include <stdio.h> 56 #include <stdlib.h> 57 #include <stddef.h> 58 #include <string.h> 59 #include <unistd.h> 60 61 #include "installboot.h" 62 63 int main(int, char *[]); 64 static void getmachine(ib_params *, const char *, const char *); 65 static void getfstype(ib_params *, const char *, const char *); 66 static void parseoptions(ib_params *, const char *); 67 static void usage(void); 68 static void options_usage(void); 69 static void machine_usage(void); 70 static void fstype_usage(void); 71 72 static ib_params installboot_params; 73 74 #define OFFSET(field) offsetof(ib_params, field) 75 const struct option { 76 const char *name; /* Name of option */ 77 ib_flags flag; /* Corresponding IB_xxx flag */ 78 enum { /* Type of option value... */ 79 OPT_BOOL, /* no value */ 80 OPT_INT, /* numeric value */ 81 OPT_WORD, /* space/tab/, terminated */ 82 OPT_STRING /* null terminated */ 83 } type; 84 int offset; /* of field in ib_params */ 85 } options[] = { 86 { "alphasum", IB_ALPHASUM, OPT_BOOL }, 87 { "append", IB_APPEND, OPT_BOOL }, 88 { "command", IB_COMMAND, OPT_STRING, OFFSET(command) }, 89 { "console", IB_CONSOLE, OPT_WORD, OFFSET(console) }, 90 { "ioaddr", IB_CONSADDR, OPT_INT, OFFSET(consaddr) }, 91 { "keymap", IB_KEYMAP, OPT_WORD, OFFSET(keymap) }, 92 { "password", IB_PASSWORD, OPT_WORD, OFFSET(password) }, 93 { "resetvideo", IB_RESETVIDEO, OPT_BOOL }, 94 { "speed", IB_CONSPEED, OPT_INT, OFFSET(conspeed) }, 95 { "sunsum", IB_SUNSUM, OPT_BOOL }, 96 { "timeout", IB_TIMEOUT, OPT_INT, OFFSET(timeout) }, 97 { NULL }, 98 }; 99 #undef OFFSET 100 #define OPTION(params, type, opt) (*(type *)((char *)(params) + (opt)->offset)) 101 102 int 103 main(int argc, char *argv[]) 104 { 105 struct utsname utsname; 106 ib_params *params; 107 unsigned long lval; 108 int ch, rv, mode; 109 char *p; 110 const char *op; 111 ib_flags unsupported_flags; 112 113 setprogname(argv[0]); 114 params = &installboot_params; 115 memset(params, 0, sizeof(*params)); 116 params->fsfd = -1; 117 params->s1fd = -1; 118 if ((p = getenv("MACHINE")) != NULL) 119 getmachine(params, p, "$MACHINE"); 120 121 while ((ch = getopt(argc, argv, "b:B:cem:no:t:v")) != -1) { 122 switch (ch) { 123 124 case 'b': 125 case 'B': 126 if (*optarg == '\0') 127 goto badblock; 128 lval = strtoul(optarg, &p, 0); 129 if (lval > UINT32_MAX || *p != '\0') { 130 badblock: 131 errx(1, "Invalid block number `%s'", optarg); 132 } 133 if (ch == 'b') { 134 params->s1start = (uint32_t)lval; 135 params->flags |= IB_STAGE1START; 136 } else { 137 params->s2start = (uint32_t)lval; 138 params->flags |= IB_STAGE2START; 139 } 140 break; 141 142 case 'c': 143 params->flags |= IB_CLEAR; 144 break; 145 146 case 'e': 147 params->flags |= IB_EDIT; 148 break; 149 150 case 'm': 151 getmachine(params, optarg, "-m"); 152 break; 153 154 case 'n': 155 params->flags |= IB_NOWRITE; 156 break; 157 158 case 'o': 159 parseoptions(params, optarg); 160 break; 161 162 case 't': 163 getfstype(params, optarg, "-t"); 164 break; 165 166 case 'v': 167 params->flags |= IB_VERBOSE; 168 break; 169 170 case '?': 171 default: 172 usage(); 173 /* NOTREACHED */ 174 175 } 176 } 177 argc -= optind; 178 argv += optind; 179 180 if (params->flags & IB_CLEAR && params->flags & IB_EDIT) 181 usage(); 182 if (argc < 1 || argc + 2 * !!(params->flags & (IB_CLEAR | IB_EDIT)) > 3) 183 usage(); 184 185 /* set missing defaults */ 186 if (params->machine == NULL) { 187 if (uname(&utsname) == -1) 188 err(1, "Determine uname"); 189 getmachine(params, utsname.machine, "uname()"); 190 } 191 192 /* Check that options are supported by this system */ 193 unsupported_flags = params->flags & ~params->machine->valid_flags; 194 unsupported_flags &= ~(IB_VERBOSE | IB_NOWRITE | IB_CLEAR | IB_EDIT); 195 if (unsupported_flags != 0) { 196 int ndx; 197 for (ndx = 0; options[ndx].name != NULL; ndx++) { 198 if (unsupported_flags & options[ndx].flag) 199 warnx("`-o %s' is not supported for %s", 200 options[ndx].name, params->machine->name); 201 } 202 if (unsupported_flags & IB_STAGE1START) 203 warnx("`-b bno' is not supported for %s", 204 params->machine->name); 205 if (unsupported_flags & IB_STAGE2START) 206 warnx("`-B bno' is not supported for %s", 207 params->machine->name); 208 exit(1); 209 } 210 /* and some illegal combinations */ 211 if (params->flags & IB_STAGE1START && params->flags & IB_APPEND) { 212 warnx("Can't use `-b bno' with `-o append'"); 213 exit(1); 214 } 215 if (params->flags & IB_CLEAR && 216 params->flags & (IB_STAGE1START | IB_STAGE2START | IB_APPEND)) { 217 warnx("Can't use `-b bno', `-B bno' or `-o append' with `-c'"); 218 exit(1); 219 } 220 221 if (argc >= 3) { 222 params->stage2 = argv[2]; 223 } 224 225 params->filesystem = argv[0]; 226 if (params->flags & IB_NOWRITE) { 227 op = "only"; 228 mode = O_RDONLY; 229 } else { 230 op = "write"; 231 mode = O_RDWR; 232 } 233 if ((params->fsfd = open(params->filesystem, mode, 0600)) == -1) 234 err(1, "Opening file system `%s' read-%s", 235 params->filesystem, op); 236 if (fstat(params->fsfd, ¶ms->fsstat) == -1) 237 err(1, "Examining file system `%s'", params->filesystem); 238 if (params->fstype != NULL) { 239 if (! params->fstype->match(params)) 240 errx(1, "File system `%s' is not of type %s", 241 params->filesystem, params->fstype->name); 242 } else { 243 if (params->stage2 != NULL) { 244 params->fstype = &fstypes[0]; 245 while (params->fstype->name != NULL && 246 !params->fstype->match(params)) 247 params->fstype++; 248 if (params->fstype->name == NULL) 249 errx(1, "File system `%s' is of an unknown type", 250 params->filesystem); 251 } 252 } 253 254 if (argc >= 2) { 255 if ((params->s1fd = open(argv[1], O_RDONLY, 0600)) == -1) 256 err(1, "Opening primary bootstrap `%s'", argv[1]); 257 if (fstat(params->s1fd, ¶ms->s1stat) == -1) 258 err(1, "Examining primary bootstrap `%s'", argv[1]); 259 if (!S_ISREG(params->s1stat.st_mode)) 260 errx(1, "`%s' must be a regular file", argv[1]); 261 params->stage1 = argv[1]; 262 } 263 assert(params->machine != NULL); 264 265 if (params->flags & IB_VERBOSE) { 266 printf("File system: %s\n", params->filesystem); 267 if (params->fstype) 268 printf("File system type: %s (blocksize %u, " 269 "needswap %d)\n", 270 params->fstype->name, params->fstype->blocksize, 271 params->fstype->needswap); 272 if (!(params->flags & IB_EDIT)) 273 printf("Primary bootstrap: %s\n", 274 (params->flags & IB_CLEAR) ? "(to be cleared)" 275 : params->stage1 ? params->stage1 : "(none)" ); 276 if (params->stage2 != NULL) 277 printf("Secondary bootstrap: %s\n", params->stage2); 278 } 279 280 if (params->flags & IB_EDIT) { 281 op = "Edit"; 282 rv = params->machine->editboot(params); 283 } else if (params->flags & IB_CLEAR) { 284 op = "Clear"; 285 rv = params->machine->clearboot(params); 286 } else { 287 if (argc < 2) 288 errx(EXIT_FAILURE, "Please specify the primary " 289 "bootstrap file"); 290 op = "Set"; 291 rv = params->machine->setboot(params); 292 } 293 if (rv == 0) 294 errx(1, "%s bootstrap operation failed", op); 295 296 if (S_ISREG(params->fsstat.st_mode)) { 297 if (fsync(params->fsfd) == -1) 298 err(1, "Synchronising file system `%s'", 299 params->filesystem); 300 } else { 301 /* Sync filesystems (to clean in-memory superblock?) */ 302 sync(); 303 } 304 if (close(params->fsfd) == -1) 305 err(1, "Closing file system `%s'", params->filesystem); 306 if (argc == 2) 307 if (close(params->s1fd) == -1) 308 err(1, "Closing primary bootstrap `%s'", 309 params->stage1); 310 311 exit(0); 312 /* NOTREACHED */ 313 } 314 315 static void 316 parseoptions(ib_params *params, const char *option) 317 { 318 char *cp; 319 const struct option *opt; 320 int len; 321 unsigned long val; 322 323 assert(params != NULL); 324 assert(option != NULL); 325 326 for (;; option += len) { 327 option += strspn(option, ", \t"); 328 if (*option == 0) 329 return; 330 len = strcspn(option, "=,"); 331 for (opt = options; opt->name != NULL; opt++) { 332 if (memcmp(option, opt->name, len) == 0 333 && opt->name[len] == 0) 334 break; 335 } 336 if (opt->name == NULL) { 337 len = strcspn(option, ","); 338 warnx("Unknown option `-o %.*s'", len, option); 339 break; 340 } 341 params->flags |= opt->flag; 342 if (opt->type == OPT_BOOL) { 343 if (option[len] != '=') 344 continue; 345 warnx("Option `%s' must not have a value", opt->name); 346 break; 347 } 348 if (option[len] != '=') { 349 warnx("Option `%s' must have a value", opt->name); 350 break; 351 } 352 option += len + 1; 353 len = strcspn(option, ","); 354 switch (opt->type) { 355 case OPT_STRING: 356 len = strlen(option); 357 /* FALLTHROUGH */ 358 case OPT_WORD: 359 cp = strdup(option); 360 if (cp == NULL) 361 err(1, "strdup"); 362 cp[len] = 0; 363 OPTION(params, char *, opt) = cp; 364 continue; 365 case OPT_INT: 366 val = strtoul(option, &cp, 0); 367 if (cp > option + len || (*cp != 0 && *cp != ',')) 368 break; 369 OPTION(params, int, opt) = val; 370 if (OPTION(params, int, opt) != val) 371 /* value got truncated on int convertion */ 372 break; 373 continue; 374 default: 375 errx(1, "Internal error: option `%s' has invalid type %d", 376 opt->name, opt->type); 377 } 378 warnx("Invalid option value `%s=%.*s'", opt->name, len, option); 379 break; 380 } 381 options_usage(); 382 exit(1); 383 } 384 385 static void 386 options_usage(void) 387 { 388 int ndx; 389 const char *pfx; 390 391 warnx("Valid options are:"); 392 pfx = "\t"; 393 for (ndx = 0; options[ndx].name != 0; ndx++) { 394 fprintf(stderr, "%s%s", pfx, options[ndx].name); 395 switch (options[ndx].type) { 396 case OPT_INT: 397 fprintf(stderr, "=number"); 398 break; 399 case OPT_WORD: 400 fprintf(stderr, "=word"); 401 break; 402 case OPT_STRING: 403 fprintf(stderr, "=string"); 404 break; 405 default: 406 break; 407 } 408 if ((ndx % 5) == 4) 409 pfx = ",\n\t"; 410 else 411 pfx = ", "; 412 } 413 fprintf(stderr, "\n"); 414 } 415 416 int 417 no_setboot(ib_params *params) 418 { 419 420 assert(params != NULL); 421 422 warnx("%s: bootstrap installation is not supported", 423 params->machine->name); 424 return (0); 425 } 426 427 int 428 no_clearboot(ib_params *params) 429 { 430 431 assert(params != NULL); 432 433 warnx("%s: bootstrap removal is not supported", 434 params->machine->name); 435 return (0); 436 } 437 438 int 439 no_editboot(ib_params *params) 440 { 441 442 assert(params != NULL); 443 444 warnx("%s: bootstrap editing is not supported", 445 params->machine->name); 446 return (0); 447 } 448 449 450 static void 451 getmachine(ib_params *param, const char *mach, const char *provider) 452 { 453 int i; 454 455 assert(param != NULL); 456 assert(mach != NULL); 457 assert(provider != NULL); 458 459 for (i = 0; machines[i] != NULL; i++) { 460 if (machines[i]->name == NULL) 461 continue; 462 if (strcmp(machines[i]->name, mach) == 0) { 463 param->machine = machines[i]; 464 return; 465 } 466 } 467 warnx("Invalid machine `%s' from %s", mach, provider); 468 machine_usage(); 469 exit(1); 470 } 471 472 static void 473 machine_usage(void) 474 { 475 const char *prefix; 476 int i; 477 int col, len; 478 const char *name; 479 int wincol=80; 480 #ifdef TIOCGWINSZ 481 struct winsize win; 482 483 if (ioctl(fileno(stderr), TIOCGWINSZ, &win) == 0) 484 wincol = win.ws_col; 485 #endif 486 487 warnx("Supported machines are:"); 488 prefix="\t"; 489 col = 8 + 3; 490 for (i = 0; machines[i] != NULL; i++) { 491 name = machines[i]->name; 492 if (name == NULL) 493 continue; 494 len = strlen(name); 495 if (col + len > wincol) { 496 prefix=",\n\t"; 497 col = -2 + 8 + 3; 498 } 499 col += fprintf(stderr, "%s%s", prefix, name); 500 prefix=", "; 501 } 502 fputs("\n", stderr); 503 } 504 505 static void 506 getfstype(ib_params *param, const char *fstype, const char *provider) 507 { 508 int i; 509 510 assert(param != NULL); 511 assert(fstype != NULL); 512 assert(provider != NULL); 513 514 for (i = 0; fstypes[i].name != NULL; i++) { 515 if (strcmp(fstypes[i].name, fstype) == 0) { 516 param->fstype = &fstypes[i]; 517 return; 518 } 519 } 520 warnx("Invalid file system type `%s' from %s", fstype, provider); 521 fstype_usage(); 522 exit(1); 523 } 524 525 static void 526 fstype_usage(void) 527 { 528 const char *prefix; 529 int i; 530 531 warnx("Supported file system types are:"); 532 #define FSTYPES_PER_LINE 9 533 prefix="\t"; 534 for (i = 0; fstypes[i].name != NULL; i++) { 535 if (i && (i % FSTYPES_PER_LINE) == 0) 536 prefix=",\n\t"; 537 fprintf(stderr, "%s%s", prefix, fstypes[i].name); 538 prefix=", "; 539 } 540 fputs("\n", stderr); 541 } 542 543 static void 544 usage(void) 545 { 546 const char *prog; 547 548 prog = getprogname(); 549 fprintf(stderr, 550 "usage: %s [-nv] [-B s2bno] [-b s1bno] [-m machine] [-o options]\n" 551 "\t\t [-t fstype] filesystem primary [secondary]\n" 552 "usage: %s -c [-nv] [-m machine] [-o options] [-t fstype] filesystem\n" 553 "usage: %s -e [-nv] [-m machine] [-o options] bootstrap\n", 554 prog, prog, prog); 555 machine_usage(); 556 fstype_usage(); 557 options_usage(); 558 exit(1); 559 } 560
Indexes created Thu Sep 25 02:09:54 GMT 2025