usr.sbin/ndiscvt/ndiscvt.c

   1 /*
   2  * Copyright (c) 2003
   3  *      Bill Paul <wpaul@windriver.com>.  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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Bill Paul.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30  * THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * $FreeBSD: src/usr.sbin/ndiscvt/ndiscvt.c,v 1.16 2011/02/18 20:54:12 dim Exp $
  33  */
  34
  35 #include <sys/types.h>
  36 #include <sys/queue.h>
  37 #include <sys/socket.h>
  38 #include <net/if.h>
  39 #include <stdlib.h>
  40 #include <stddef.h>
  41 #include <unistd.h>
  42 #include <stdio.h>
  43 #include <errno.h>
  44 #include <string.h>
  45 #include <libgen.h>
  46 #include <err.h>
  47 #include <ctype.h>
  48
  49 #include <emulation/ndis/pe_var.h>
  50
  51 #include "inf.h"
  52
  53 static int insert_padding(void **, int *);
  54 extern const char *__progname;
  55
  56 /*
  57  * Sections within Windows PE files are defined using virtual
  58  * and physical address offsets and virtual and physical sizes.
  59  * The physical values define how the section data is stored in
  60  * the executable file while the virtual values describe how the
  61  * sections will look once loaded into memory. It happens that
  62  * the linker in the Microsoft(r) DDK will tend to generate
  63  * binaries where the virtual and physical values are identical,
  64  * which means in most cases we can just transfer the file
  65  * directly to memory without any fixups. This is not always
  66  * the case though, so we have to be prepared to handle files
  67  * where the in-memory section layout differs from the disk file
  68  * section layout.
  69  *
  70  * There are two kinds of variations that can occur: the relative
  71  * virtual address of the section might be different from the
  72  * physical file offset, and the virtual section size might be
  73  * different from the physical size (for example, the physical
  74  * size of the .data section might be 1024 bytes, but the virtual
  75  * size might be 1384 bytes, indicating that the data section should
  76  * actually use up 1384 bytes in RAM and be padded with zeros). What we
  77  * do is read the original file into memory and then make an in-memory
  78  * copy with all of the sections relocated, re-sized and zero padded
  79  * according to the virtual values specified in the section headers.
  80  * We then emit the fixed up image file for use by the if_ndis driver.
  81  * This way, we don't have to do the fixups inside the kernel.
  82  */
  83
  84 #define ROUND_DOWN(n, align)    (((uintptr_t)n) & ~((align) - 1l))
  85 #define ROUND_UP(n, align)      ROUND_DOWN(((uintptr_t)n) + (align) - 1l, \
  86                                 (align))
  87
  88 #define SET_HDRS(x)     \
  89         dos_hdr = (image_dos_header *)x;                                \
  90         nt_hdr = (image_nt_header *)(x + dos_hdr->idh_lfanew);          \
  91         sect_hdr = IMAGE_FIRST_SECTION(nt_hdr);
  92
  93 static int
  94 insert_padding(void **imgbase, int *imglen)
  95 {
  96         image_section_header    *sect_hdr;
  97         image_dos_header        *dos_hdr;
  98         image_nt_header         *nt_hdr;
  99         image_optional_header   opt_hdr;
 100         int                     i = 0, sections;
 101         int                     offaccum = 0, oldraddr, oldrlen;
 102         uint8_t                 *newimg, *tmp;
 103
 104         newimg = malloc(*imglen);
 105
 106         if (newimg == NULL)
 107                 return(ENOMEM);
 108
 109         bcopy(*imgbase, newimg, *imglen);
 110
 111         if (pe_get_optional_header((vm_offset_t)newimg, &opt_hdr))
 112                 return(0);
 113
 114         sections = pe_numsections((vm_offset_t)newimg);
 115
 116         SET_HDRS(newimg);
 117
 118         for (i = 0; i < sections; i++) {
 119                 oldraddr = sect_hdr->ish_rawdataaddr;
 120                 oldrlen = sect_hdr->ish_rawdatasize;
 121                 sect_hdr->ish_rawdataaddr = sect_hdr->ish_vaddr;
 122                 offaccum += ROUND_UP(sect_hdr->ish_vaddr - oldraddr,
 123                     opt_hdr.ioh_filealign);
 124                 offaccum +=
 125                     ROUND_UP(sect_hdr->ish_misc.ish_vsize,
 126                              opt_hdr.ioh_filealign) -
 127                     ROUND_UP(sect_hdr->ish_rawdatasize,
 128                              opt_hdr.ioh_filealign);
 129                 tmp = realloc(newimg, *imglen + offaccum);
 130                 if (tmp == NULL) {
 131                         free(newimg);
 132                         return(ENOMEM);
 133                 }
 134                 newimg = tmp;
 135                 SET_HDRS(newimg);
 136                 sect_hdr += i;
 137                 bzero(newimg + sect_hdr->ish_rawdataaddr,
 138                     ROUND_UP(sect_hdr->ish_misc.ish_vsize,
 139                     opt_hdr.ioh_filealign));
 140                 bcopy((uint8_t *)(*imgbase) + oldraddr,
 141                     newimg + sect_hdr->ish_rawdataaddr, oldrlen);
 142                 sect_hdr++;
 143         }
 144
 145         free(*imgbase);
 146
 147         *imgbase = newimg;
 148         *imglen += offaccum;
 149
 150         return(0);
 151 }
 152
 153 static void
 154 usage(void)
 155 {
 156         fprintf(stderr, "Usage: %s [-O] [-i <inffile>] -s <sysfile> "
 157             "[-n devname] [-o outfile]\n", __progname);
 158         fprintf(stderr, "       %s -f <firmfile>\n", __progname);
 159
 160         exit(1);
 161 }
 162
 163 static void
 164 bincvt(char *sysfile, char *outfile, void *img, int fsize)
 165 {
 166         char                    *ptr;
 167         char                    tname[] = "/tmp/ndiscvt.XXXXXX";
 168         char                    sysbuf[1024];
 169         FILE                    *binfp;
 170
 171         mkstemp(tname);
 172
 173         binfp = fopen(tname, "a+");
 174         if (binfp == NULL)
 175                 err(1, "opening %s failed", tname);
 176
 177         if (fwrite(img, fsize, 1, binfp) != 1)
 178                 err(1, "failed to output binary image");
 179
 180         fclose(binfp);
 181
 182         outfile = strdup(basename(outfile));
 183         if (strchr(outfile, '.'))
 184                 *strchr(outfile, '.') = '\0';
 185
 186         snprintf(sysbuf, sizeof(sysbuf),
 187 #ifdef __x86_64__
 188             "objcopy -I binary -O elf64-x86-64 -B i386 %s %s.o\n",
 189 #endif
 190             tname, outfile);
 191         printf("%s", sysbuf);
 192         system(sysbuf);
 193         unlink(tname);
 194
 195         ptr = tname;
 196         while (*ptr) {
 197                 if (*ptr == '/' || *ptr == '.')
 198                         *ptr = '_';
 199                 ptr++;
 200         }
 201
 202         snprintf(sysbuf, sizeof(sysbuf),
 203             "objcopy --redefine-sym _binary_%s_start=ndis_%s_drv_data_start "
 204             "--strip-symbol _binary_%s_size "
 205             "--redefine-sym _binary_%s_end=ndis_%s_drv_data_end %s.o %s.o\n",
 206             tname, sysfile, tname, tname, sysfile, outfile, outfile);
 207         printf("%s", sysbuf);
 208         system(sysbuf);
 209
 210         return;
 211 }
 212
 213 static void
 214 firmcvt(char *firmfile)
 215 {
 216         char                    *basefile, *outfile, *ptr;
 217         char                    sysbuf[1024];
 218
 219         outfile = strdup(basename(firmfile));
 220         basefile = strdup(outfile);
 221
 222         snprintf(sysbuf, sizeof(sysbuf),
 223 #ifdef __x86_64__
 224             "objcopy -I binary -O elf64-x86-64 -B i386 %s %s.o\n",
 225 #endif
 226             firmfile, outfile);
 227         printf("%s", sysbuf);
 228         system(sysbuf);
 229
 230         ptr = firmfile;
 231         while (*ptr) {
 232                 if (*ptr == '/' || *ptr == '.')
 233                         *ptr = '_';
 234                 ptr++;
 235         }
 236         ptr = basefile;
 237         while (*ptr) {
 238                 if (*ptr == '/' || *ptr == '.')
 239                         *ptr = '_';
 240                 else
 241                         *ptr = tolower(*ptr);
 242                 ptr++;
 243         }
 244
 245         snprintf(sysbuf, sizeof(sysbuf),
 246             "objcopy --redefine-sym _binary_%s_start=%s_start "
 247             "--strip-symbol _binary_%s_size "
 248             "--redefine-sym _binary_%s_end=%s_end %s.o %s.o\n",
 249             firmfile, basefile, firmfile, firmfile,
 250             basefile, outfile, outfile);
 251         ptr = sysbuf;
 252         printf("%s", sysbuf);
 253         system(sysbuf);
 254
 255         snprintf(sysbuf, sizeof(sysbuf),
 256             "ld -Bshareable -d -warn-common -o %s.ko %s.o\n",
 257             outfile, outfile);
 258         printf("%s", sysbuf);
 259         system(sysbuf);
 260
 261         free(basefile);
 262
 263         exit(0);
 264 }
 265
 266 int
 267 main(int argc, char *argv[])
 268 {
 269         FILE                    *fp, *outfp;
 270         int                     i, bin = 0;
 271         void                    *img;
 272         int                     n, fsize, cnt;
 273         unsigned char           *ptr;
 274         char                    *inffile = NULL, *sysfile = NULL;
 275         char                    *outfile = NULL, *firmfile = NULL;
 276         char                    *dname = NULL;
 277         int                     ch;
 278
 279         while((ch = getopt(argc, argv, "i:s:o:n:f:O")) != -1) {
 280                 switch(ch) {
 281                 case 'f':
 282                         firmfile = optarg;
 283                         break;
 284                 case 'i':
 285                         inffile = optarg;
 286                         break;
 287                 case 's':
 288                         sysfile = optarg;
 289                         break;
 290                 case 'o':
 291                         outfile = optarg;
 292                         break;
 293                 case 'n':
 294                         dname = optarg;
 295                         break;
 296                 case 'O':
 297                         bin = 1;
 298                         break;
 299                 default:
 300                         usage();
 301                         break;
 302                 }
 303         }
 304
 305         if (firmfile != NULL)
 306                 firmcvt(firmfile);
 307
 308         if (sysfile == NULL)
 309                 usage();
 310
 311         /* Open the .SYS file and load it into memory */
 312         fp = fopen(sysfile, "r");
 313         if (fp == NULL)
 314                 err(1, "opening .SYS file '%s' failed", sysfile);
 315         fseek (fp, 0L, SEEK_END);
 316         fsize = ftell (fp);
 317         rewind (fp);
 318         img = calloc(fsize, 1);
 319         n = fread (img, fsize, 1, fp);
 320         if (n == 0)
 321                 err(1, "reading .SYS file '%s' failed", sysfile);
 322
 323         fclose(fp);
 324
 325         if (insert_padding(&img, &fsize)) {
 326                 fprintf(stderr, "section relocation failed\n");
 327                 exit(1);
 328         }
 329
 330         if (outfile == NULL || strcmp(outfile, "-") == 0)
 331                 outfp = stdout;
 332         else {
 333                 outfp = fopen(outfile, "w");
 334                 if (outfp == NULL)
 335                         err(1, "opening output file '%s' failed", outfile);
 336         }
 337
 338         fprintf(outfp, "\n/*\n");
 339         fprintf(outfp, " * Generated from %s and %s (%d bytes)\n",
 340             inffile == NULL ? "<notused>" : inffile, sysfile, fsize);
 341         fprintf(outfp, " */\n\n");
 342
 343         if (dname != NULL) {
 344                 if (strlen(dname) > IFNAMSIZ)
 345                         err(1, "selected device name '%s' is "
 346                             "too long (max chars: %d)", dname, IFNAMSIZ);
 347                 fprintf (outfp, "#define NDIS_DEVNAME \"%s\"\n", dname);
 348                 fprintf (outfp, "#define NDIS_MODNAME %s\n\n", dname);
 349         }
 350
 351         if (inffile == NULL) {
 352                 fprintf (outfp, "#ifdef NDIS_REGVALS\n");
 353                 fprintf (outfp, "ndis_cfg ndis_regvals[] = {\n");
 354                 fprintf (outfp, "\t{ NULL, NULL, { 0 }, 0 }\n");
 355                 fprintf (outfp, "#endif /* NDIS_REGVALS */\n");
 356
 357                 fprintf (outfp, "};\n\n");
 358         } else {
 359                 fp = fopen(inffile, "r");
 360                 if (fp == NULL)
 361                         err(1, "opening .INF file '%s' failed", inffile);
 362
 363
 364                 inf_parse(fp, outfp);
 365                 fclose(fp);
 366         }
 367
 368         fprintf(outfp, "\n#ifdef NDIS_IMAGE\n");
 369
 370         if (bin) {
 371                 sysfile = strdup(basename(sysfile));
 372                 ptr = (unsigned char *)sysfile;
 373                 while (*ptr) {
 374                         if (*ptr == '.')
 375                                 *ptr = '_';
 376                         ptr++;
 377                 }
 378                 fprintf(outfp,
 379                     "\nextern unsigned char ndis_%s_drv_data_start[];\n",
 380                     sysfile);
 381                 fprintf(outfp, "static unsigned char *drv_data = "
 382                     "ndis_%s_drv_data_start;\n\n", sysfile);
 383                 bincvt(sysfile, outfile, img, fsize);
 384                 goto done;
 385         }
 386
 387
 388         fprintf(outfp, "\nextern unsigned char drv_data[];\n\n");
 389
 390         fprintf(outfp, "__asm__(\".data\");\n");
 391         fprintf(outfp, "__asm__(\".globl  drv_data\");\n");
 392         fprintf(outfp, "__asm__(\".type   drv_data, @object\");\n");
 393         fprintf(outfp, "__asm__(\".size   drv_data, %d\");\n", fsize);
 394         fprintf(outfp, "__asm__(\"drv_data:\");\n");
 395
 396         ptr = img;
 397         cnt = 0;
 398         while(cnt < fsize) {
 399                 fprintf (outfp, "__asm__(\".byte ");
 400                 for (i = 0; i < 10; i++) {
 401                         cnt++;
 402                         if (cnt == fsize) {
 403                                 fprintf(outfp, "0x%.2X\");\n", ptr[i]);
 404                                 goto done;
 405                         } else {
 406                                 if (i == 9)
 407                                         fprintf(outfp, "0x%.2X\");\n", ptr[i]);
 408                                 else
 409                                         fprintf(outfp, "0x%.2X, ", ptr[i]);
 410                         }
 411                 }
 412                 ptr += 10;
 413         }
 414
 415 done:
 416
 417         fprintf(outfp, "#endif /* NDIS_IMAGE */\n");
 418
 419         if (fp != NULL)
 420                 fclose(fp);
 421         fclose(outfp);
 422         free(img);
 423         exit(0);
 424 }