1 /* 2 * Copyright (c) 1998 Robert Nordier 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 17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS 18 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 19 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 20 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 21 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 22 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 23 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 24 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 #include <sys/param.h> 28 #include "endian.h" 29 #include <sys/stat.h> 30 #include <sys/mman.h> 31 32 /* XXX make this work as an i386/amd64 cross-tool */ 33 #undef __LDPGSZ 34 #define __LDPGSZ 4096 35 36 #include <netinet/in.h> 37 38 #include "imgact_aout.h" 39 #include <err.h> 40 #include <errno.h> 41 #include <fcntl.h> 42 #include <stdarg.h> 43 #include <stdio.h> 44 #include <stdlib.h> 45 #include <string.h> 46 #include <unistd.h> 47 48 #include "btx.h" 49 #include "elfh.h" 50 51 #define BTX_PATH "/sys/boot/i386/btx" 52 53 #define I_LDR 0 /* BTX loader */ 54 #define I_BTX 1 /* BTX kernel */ 55 #define I_CLNT 2 /* Client program */ 56 57 #define F_BIN 0 /* Binary */ 58 #define F_AOUT 1 /* ZMAGIC a.out */ 59 #define F_ELF 2 /* 32-bit ELF */ 60 #define F_CNT 3 /* Number of formats */ 61 62 #define IMPURE 1 /* Writable text */ 63 #define MAXU32 0xffffffff /* Maximum unsigned 32-bit quantity */ 64 65 #define align(x, y) (((x) + (y) - 1) & ~((y) - 1)) 66 67 struct hdr { 68 uint32_t fmt; /* Format */ 69 uint32_t flags; /* Bit flags */ 70 uint32_t size; /* Size of file */ 71 uint32_t text; /* Size of text segment */ 72 uint32_t data; /* Size of data segment */ 73 uint32_t bss; /* Size of bss segment */ 74 uint32_t org; /* Program origin */ 75 uint32_t entry; /* Program entry point */ 76 }; 77 78 static const char *const fmtlist[] = {"bin", "aout", "elf"}; 79 80 static const char binfo[] = 81 "kernel: ver=%u.%02u size=%x load=%x entry=%x map=%uM " 82 "pgctl=%x:%x\n"; 83 static const char cinfo[] = 84 "client: fmt=%s size=%x text=%x data=%x bss=%x entry=%x\n"; 85 static const char oinfo[] = 86 "output: fmt=%s size=%x text=%x data=%x org=%x entry=%x\n"; 87 88 /* BTX loader and kernel is only provided from command line */ 89 static const char *lname = NULL; 90 static const char *bname = NULL; 91 static const char *oname = 92 "a.out"; /* Output filename */ 93 94 static int ppage = -1; /* First page present */ 95 static int wpage = -1; /* First page writable */ 96 97 static unsigned int format; /* Output format */ 98 99 static uint32_t centry; /* Client entry address */ 100 static uint32_t lentry; /* Loader entry address */ 101 102 static int Eflag; /* Client entry option */ 103 104 static int quiet; /* Inhibit warnings */ 105 static int verbose; /* Display information */ 106 107 static const char *tname; /* Temporary output file */ 108 static const char *fname; /* Current input file */ 109 110 static void cleanup(void); 111 static void btxld(const char *); 112 static void getbtx(int, struct btx_hdr *); 113 static void gethdr(int, struct hdr *); 114 static void puthdr(int, struct hdr *); 115 static void copy(int, int, size_t, off_t); 116 static size_t readx(int, void *, size_t, off_t); 117 static void writex(int, const void *, size_t); 118 static void seekx(int, off_t); 119 static unsigned int optfmt(const char *); 120 static uint32_t optaddr(const char *); 121 static int optpage(const char *, int); 122 static void Warn(const char *, const char *, ...); 123 static void usage(void); 124 extern void add_version(const char *, char *); 125 126 /* 127 * A link editor for BTX clients. 128 */ 129 int 130 main(int argc, char *argv[]) 131 { 132 int c; 133 char *version = NULL; 134 135 while ((c = getopt(argc, argv, "qvb:E:e:f:l:o:P:V:W:")) != -1) 136 switch (c) { 137 case 'q': 138 quiet = 1; 139 break; 140 case 'v': 141 verbose = 1; 142 break; 143 case 'b': 144 bname = optarg; 145 break; 146 case 'E': 147 centry = optaddr(optarg); 148 Eflag = 1; 149 break; 150 case 'e': 151 lentry = optaddr(optarg); 152 break; 153 case 'f': 154 format = optfmt(optarg); 155 break; 156 case 'l': 157 lname = optarg; 158 break; 159 case 'o': 160 oname = optarg; 161 break; 162 case 'P': 163 ppage = optpage(optarg, 1); 164 break; 165 case 'V': 166 version = optarg; 167 break; 168 case 'W': 169 wpage = optpage(optarg, BTX_MAXCWR); 170 break; 171 default: 172 usage(); 173 } 174 argc -= optind; 175 argv += optind; 176 if (argc != 1) 177 usage(); 178 atexit(cleanup); 179 if (lname != NULL && bname != NULL) 180 btxld(*argv); 181 if (version != NULL) 182 add_version(oname, version); 183 return 0; 184 } 185 186 /* 187 * Clean up after errors. 188 */ 189 static void 190 cleanup(void) 191 { 192 if (tname) 193 remove(tname); 194 } 195 196 /* 197 * Read the input files; write the output file; display information. 198 */ 199 static void 200 btxld(const char *iname) 201 { 202 char name[FILENAME_MAX]; 203 struct btx_hdr btx, btxle; 204 struct hdr ihdr, ohdr; 205 unsigned int ldr_size, cwr; 206 int fdi[3], fdo, i; 207 208 ldr_size = 0; 209 210 for (i = I_LDR; i <= I_CLNT; i++) { 211 fname = i == I_LDR ? lname : i == I_BTX ? bname : iname; 212 if ((fdi[i] = open(fname, O_RDONLY)) == -1) 213 err(2, "%s", fname); 214 switch (i) { 215 case I_LDR: 216 gethdr(fdi[i], &ihdr); 217 if (ihdr.fmt != F_BIN) 218 Warn(fname, "Loader format is %s; processing as %s", 219 fmtlist[ihdr.fmt], fmtlist[F_BIN]); 220 ldr_size = ihdr.size; 221 break; 222 case I_BTX: 223 getbtx(fdi[i], &btx); 224 break; 225 case I_CLNT: 226 gethdr(fdi[i], &ihdr); 227 if (ihdr.org && ihdr.org != BTX_PGSIZE) 228 Warn(fname, 229 "Client origin is 0x%x; expecting 0 or 0x%x", 230 ihdr.org, BTX_PGSIZE); 231 } 232 } 233 memset(&ohdr, 0, sizeof(ohdr)); 234 ohdr.fmt = format; 235 ohdr.text = ldr_size; 236 ohdr.data = btx.btx_textsz + ihdr.size; 237 ohdr.org = lentry; 238 ohdr.entry = lentry; 239 cwr = 0; 240 if (wpage > 0 || (wpage == -1 && !(ihdr.flags & IMPURE))) { 241 if (wpage > 0) 242 cwr = wpage; 243 else { 244 cwr = howmany(ihdr.text, BTX_PGSIZE); 245 if (cwr > BTX_MAXCWR) 246 cwr = BTX_MAXCWR; 247 } 248 } 249 if (ppage > 0 || (ppage && wpage && ihdr.org >= BTX_PGSIZE)) { 250 btx.btx_flags |= BTX_MAPONE; 251 if (!cwr) 252 cwr++; 253 } 254 btx.btx_pgctl -= cwr; 255 btx.btx_entry = Eflag ? centry : ihdr.entry; 256 if ((size_t)snprintf(name, sizeof(name), "%s.tmp", oname) >= sizeof(name)) 257 errx(2, "%s: Filename too long", oname); 258 if ((fdo = open(name, O_CREAT | O_TRUNC | O_WRONLY, 0666)) == -1) 259 err(2, "%s", name); 260 if (!(tname = strdup(name))) 261 err(2, NULL); 262 puthdr(fdo, &ohdr); 263 for (i = I_LDR; i <= I_CLNT; i++) { 264 fname = i == I_LDR ? lname : i == I_BTX ? bname : iname; 265 switch (i) { 266 case I_LDR: 267 copy(fdi[i], fdo, ldr_size, 0); 268 seekx(fdo, ohdr.size += ohdr.text); 269 break; 270 case I_BTX: 271 btxle = btx; 272 btxle.btx_pgctl = htole16(btxle.btx_pgctl); 273 btxle.btx_textsz = htole16(btxle.btx_textsz); 274 btxle.btx_entry = htole32(btxle.btx_entry); 275 writex(fdo, &btxle, sizeof(btxle)); 276 copy(fdi[i], fdo, btx.btx_textsz - sizeof(btx), 277 sizeof(btx)); 278 break; 279 case I_CLNT: 280 copy(fdi[i], fdo, ihdr.size, 0); 281 if (ftruncate(fdo, ohdr.size += ohdr.data)) 282 err(2, "%s", tname); 283 } 284 if (close(fdi[i])) 285 err(2, "%s", fname); 286 } 287 if (close(fdo)) 288 err(2, "%s", tname); 289 if (rename(tname, oname)) 290 err(2, "%s: Can't rename to %s", tname, oname); 291 tname = NULL; 292 if (verbose) { 293 printf(binfo, btx.btx_majver, btx.btx_minver, btx.btx_textsz, 294 BTX_ORIGIN(btx), BTX_ENTRY(btx), BTX_MAPPED(btx) * 295 BTX_PGSIZE / 0x100000, !!(btx.btx_flags & BTX_MAPONE), 296 BTX_MAPPED(btx) - btx.btx_pgctl - BTX_PGBASE / 297 BTX_PGSIZE - BTX_MAPPED(btx) * 4 / BTX_PGSIZE); 298 printf(cinfo, fmtlist[ihdr.fmt], ihdr.size, ihdr.text, 299 ihdr.data, ihdr.bss, ihdr.entry); 300 printf(oinfo, fmtlist[ohdr.fmt], ohdr.size, ohdr.text, 301 ohdr.data, ohdr.org, ohdr.entry); 302 } 303 } 304 305 /* 306 * Read BTX file header. 307 */ 308 static void 309 getbtx(int fd, struct btx_hdr * btx) 310 { 311 if (readx(fd, btx, sizeof(*btx), 0) != sizeof(*btx) || 312 btx->btx_magic[0] != BTX_MAG0 || 313 btx->btx_magic[1] != BTX_MAG1 || 314 btx->btx_magic[2] != BTX_MAG2) 315 errx(1, "%s: Not a BTX kernel", fname); 316 btx->btx_pgctl = le16toh(btx->btx_pgctl); 317 btx->btx_textsz = le16toh(btx->btx_textsz); 318 btx->btx_entry = le32toh(btx->btx_entry); 319 } 320 321 /* 322 * Get file size and read a.out or ELF header. 323 */ 324 static void 325 gethdr(int fd, struct hdr *hdr) 326 { 327 struct stat sb; 328 const struct exec *ex; 329 const Elf32_Ehdr *ee; 330 const Elf32_Phdr *ep; 331 void *p; 332 unsigned int fmt, x, n, i; 333 334 memset(hdr, 0, sizeof(*hdr)); 335 if (fstat(fd, &sb)) 336 err(2, "%s", fname); 337 if (sb.st_size > MAXU32) 338 errx(1, "%s: Too big", fname); 339 hdr->size = sb.st_size; 340 if (!hdr->size) 341 return; 342 if ((p = mmap(NULL, hdr->size, PROT_READ, MAP_SHARED, fd, 343 0)) == MAP_FAILED) 344 err(2, "%s", fname); 345 for (fmt = F_CNT - 1; !hdr->fmt && fmt; fmt--) 346 switch (fmt) { 347 case F_AOUT: 348 ex = p; 349 if (hdr->size >= sizeof(struct exec) && !N_BADMAG(*ex)) { 350 hdr->fmt = fmt; 351 x = N_GETMAGIC(*ex); 352 if (x == OMAGIC || x == NMAGIC) { 353 if (x == NMAGIC) 354 Warn(fname, "Treating %s NMAGIC as OMAGIC", 355 fmtlist[fmt]); 356 hdr->flags |= IMPURE; 357 } 358 hdr->text = le32toh(ex->a_text); 359 hdr->data = le32toh(ex->a_data); 360 hdr->bss = le32toh(ex->a_bss); 361 hdr->entry = le32toh(ex->a_entry); 362 if (le32toh(ex->a_entry) >= BTX_PGSIZE) 363 hdr->org = BTX_PGSIZE; 364 } 365 break; 366 case F_ELF: 367 ee = p; 368 if (hdr->size >= sizeof(Elf32_Ehdr) && IS_ELF(*ee)) { 369 hdr->fmt = fmt; 370 for (n = i = 0; i < le16toh(ee->e_phnum); i++) { 371 ep = (void *)((uint8_t *)p + le32toh(ee->e_phoff) + 372 le16toh(ee->e_phentsize) * i); 373 if (le32toh(ep->p_type) == PT_LOAD) 374 switch (n++) { 375 case 0: 376 hdr->text = le32toh(ep->p_filesz); 377 hdr->org = le32toh(ep->p_paddr); 378 if (le32toh(ep->p_flags) & PF_W) 379 hdr->flags |= IMPURE; 380 break; 381 case 1: 382 hdr->data = le32toh(ep->p_filesz); 383 hdr->bss = le32toh(ep->p_memsz) - 384 le32toh(ep->p_filesz); 385 break; 386 case 2: 387 Warn(fname, 388 "Ignoring extra %s PT_LOAD segments", 389 fmtlist[fmt]); 390 } 391 } 392 hdr->entry = le32toh(ee->e_entry); 393 } 394 } 395 if (munmap(p, hdr->size)) 396 err(2, "%s", fname); 397 } 398 399 /* 400 * Write a.out or ELF header. 401 */ 402 static void 403 puthdr(int fd, struct hdr *hdr) 404 { 405 struct exec ex; 406 struct elfh eh; 407 408 switch (hdr->fmt) { 409 case F_AOUT: 410 memset(&ex, 0, sizeof(ex)); 411 N_SETMAGIC(ex, ZMAGIC, MID_I386, 0); 412 hdr->text = N_ALIGN(ex, hdr->text); 413 ex.a_text = htole32(hdr->text); 414 hdr->data = N_ALIGN(ex, hdr->data); 415 ex.a_data = htole32(hdr->data); 416 ex.a_entry = htole32(hdr->entry); 417 writex(fd, &ex, sizeof(ex)); 418 hdr->size = N_ALIGN(ex, sizeof(ex)); 419 seekx(fd, hdr->size); 420 break; 421 case F_ELF: 422 eh = elfhdr; 423 eh.e.e_entry = htole32(hdr->entry); 424 eh.p[0].p_vaddr = eh.p[0].p_paddr = htole32(hdr->org); 425 eh.p[0].p_filesz = eh.p[0].p_memsz = htole32(hdr->text); 426 eh.p[1].p_offset = htole32(le32toh(eh.p[0].p_offset) + 427 le32toh(eh.p[0].p_filesz)); 428 eh.p[1].p_vaddr = eh.p[1].p_paddr = 429 htole32(align(le32toh(eh.p[0].p_paddr) + le32toh(eh.p[0].p_memsz), 430 4096)); 431 eh.p[1].p_filesz = eh.p[1].p_memsz = htole32(hdr->data); 432 eh.sh[2].sh_addr = eh.p[0].p_vaddr; 433 eh.sh[2].sh_offset = eh.p[0].p_offset; 434 eh.sh[2].sh_size = eh.p[0].p_filesz; 435 eh.sh[3].sh_addr = eh.p[1].p_vaddr; 436 eh.sh[3].sh_offset = eh.p[1].p_offset; 437 eh.sh[3].sh_size = eh.p[1].p_filesz; 438 writex(fd, &eh, sizeof(eh)); 439 hdr->size = sizeof(eh); 440 } 441 } 442 443 /* 444 * Safe copy from input file to output file. 445 */ 446 static void 447 copy(int fdi, int fdo, size_t nbyte, off_t offset) 448 { 449 char buf[8192]; 450 size_t n; 451 452 while (nbyte) { 453 if ((n = sizeof(buf)) > nbyte) 454 n = nbyte; 455 if (readx(fdi, buf, n, offset) != n) 456 errx(2, "%s: Short read", fname); 457 writex(fdo, buf, n); 458 nbyte -= n; 459 offset = -1; 460 } 461 } 462 463 /* 464 * Safe read from input file. 465 */ 466 static size_t 467 readx(int fd, void *buf, size_t nbyte, off_t offset) 468 { 469 ssize_t n; 470 471 if (offset != -1 && lseek(fd, offset, SEEK_SET) != offset) 472 err(2, "%s", fname); 473 if ((n = read(fd, buf, nbyte)) == -1) 474 err(2, "%s", fname); 475 return n; 476 } 477 478 /* 479 * Safe write to output file. 480 */ 481 static void 482 writex(int fd, const void *buf, size_t nbyte) 483 { 484 ssize_t n; 485 486 if ((n = write(fd, buf, nbyte)) == -1) 487 err(2, "%s", tname); 488 if ((size_t)n != nbyte) 489 errx(2, "%s: Short write", tname); 490 } 491 492 /* 493 * Safe seek in output file. 494 */ 495 static void 496 seekx(int fd, off_t offset) 497 { 498 if (lseek(fd, offset, SEEK_SET) != offset) 499 err(2, "%s", tname); 500 } 501 502 /* 503 * Convert an option argument to a format code. 504 */ 505 static unsigned int 506 optfmt(const char *arg) 507 { 508 unsigned int i; 509 510 for (i = 0; i < F_CNT && strcmp(arg, fmtlist[i]); i++); 511 if (i == F_CNT) 512 errx(1, "%s: Unknown format", arg); 513 return i; 514 } 515 516 /* 517 * Convert an option argument to an address. 518 */ 519 static uint32_t 520 optaddr(const char *arg) 521 { 522 char *s; 523 unsigned long x; 524 525 errno = 0; 526 x = strtoul(arg, &s, 0); 527 if (errno || !*arg || *s || x > MAXU32) 528 errx(1, "%s: Illegal address", arg); 529 return x; 530 } 531 532 /* 533 * Convert an option argument to a page number. 534 */ 535 static int 536 optpage(const char *arg, int hi) 537 { 538 char *s; 539 long x; 540 541 errno = 0; 542 x = strtol(arg, &s, 0); 543 if (errno || !*arg || *s || x < 0 || x > hi) 544 errx(1, "%s: Illegal page number", arg); 545 return x; 546 } 547 548 /* 549 * Display a warning. 550 */ 551 static void 552 Warn(const char *locus, const char *fmt, ...) 553 { 554 va_list ap; 555 char *s; 556 557 if (!quiet) { 558 asprintf(&s, "%s: Warning: %s", locus, fmt); 559 va_start(ap, fmt); 560 vwarnx(s, ap); 561 va_end(ap); 562 free(s); 563 } 564 } 565 566 /* 567 * Display usage information. 568 */ 569 static void 570 usage(void) 571 { 572 fprintf(stderr, "%s\n%s\n", 573 "usage: btxld [-qv] [-b file] [-E address] [-e address] [-f format]", 574 " [-l file] [-o filename] [-P page] [-W page] file"); 575 exit(1); 576 } 577