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