scripts/mod/modpost.c

   1 /* Postprocess module symbol versions
   2  *
   3  * Copyright 2003       Kai Germaschewski
   4  * Copyright 2002-2004  Rusty Russell, IBM Corporation
   5  *
   6  * Based in part on module-init-tools/depmod.c,file2alias
   7  *
   8  * This software may be used and distributed according to the terms
   9  * of the GNU General Public License, incorporated herein by reference.
  10  *
  11  * Usage: modpost vmlinux module1.o module2.o ...
  12  */
  13
  14 #include <ctype.h>
  15 #include "modpost.h"
  16
  17 /* Are we using CONFIG_MODVERSIONS? */
  18 int modversions = 0;
  19 /* Warn about undefined symbols? (do so if we have vmlinux) */
  20 int have_vmlinux = 0;
  21 /* Is CONFIG_MODULE_SRCVERSION_ALL set? */
  22 static int all_versions = 0;
  23 /* If we are modposting external module set to 1 */
  24 static int external_module = 0;
  25
  26 void fatal(const char *fmt, ...)
  27 {
  28         va_list arglist;
  29
  30         fprintf(stderr, "FATAL: ");
  31
  32         va_start(arglist, fmt);
  33         vfprintf(stderr, fmt, arglist);
  34         va_end(arglist);
  35
  36         exit(1);
  37 }
  38
  39 void warn(const char *fmt, ...)
  40 {
  41         va_list arglist;
  42
  43         fprintf(stderr, "WARNING: ");
  44
  45         va_start(arglist, fmt);
  46         vfprintf(stderr, fmt, arglist);
  47         va_end(arglist);
  48 }
  49
  50 static int is_vmlinux(const char *modname)
  51 {
  52         const char *myname;
  53
  54         if ((myname = strrchr(modname, '/')))
  55                 myname++;
  56         else
  57                 myname = modname;
  58
  59         return strcmp(myname, "vmlinux") == 0;
  60 }
  61
  62 void *do_nofail(void *ptr, const char *expr)
  63 {
  64         if (!ptr) {
  65                 fatal("modpost: Memory allocation failure: %s.\n", expr);
  66         }
  67         return ptr;
  68 }
  69
  70 /* A list of all modules we processed */
  71
  72 static struct module *modules;
  73
  74 static struct module *find_module(char *modname)
  75 {
  76         struct module *mod;
  77
  78         for (mod = modules; mod; mod = mod->next)
  79                 if (strcmp(mod->name, modname) == 0)
  80                         break;
  81         return mod;
  82 }
  83
  84 static struct module *new_module(char *modname)
  85 {
  86         struct module *mod;
  87         char *p, *s;
  88
  89         mod = NOFAIL(malloc(sizeof(*mod)));
  90         memset(mod, 0, sizeof(*mod));
  91         p = NOFAIL(strdup(modname));
  92
  93         /* strip trailing .o */
  94         if ((s = strrchr(p, '.')) != NULL)
  95                 if (strcmp(s, ".o") == 0)
  96                         *s = '\0';
  97
  98         /* add to list */
  99         mod->name = p;
 100         mod->next = modules;
 101         modules = mod;
 102
 103         return mod;
 104 }
 105
 106 /* A hash of all exported symbols,
 107  * struct symbol is also used for lists of unresolved symbols */
 108
 109 #define SYMBOL_HASH_SIZE 1024
 110
 111 struct symbol {
 112         struct symbol *next;
 113         struct module *module;
 114         unsigned int crc;
 115         int crc_valid;
 116         unsigned int weak:1;
 117         unsigned int vmlinux:1;    /* 1 if symbol is defined in vmlinux */
 118         unsigned int kernel:1;     /* 1 if symbol is from kernel
 119                                     *  (only for external modules) **/
 120         unsigned int preloaded:1;  /* 1 if symbol from Module.symvers */
 121         char name[0];
 122 };
 123
 124 static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
 125
 126 /* This is based on the hash agorithm from gdbm, via tdb */
 127 static inline unsigned int tdb_hash(const char *name)
 128 {
 129         unsigned value; /* Used to compute the hash value.  */
 130         unsigned   i;   /* Used to cycle through random values. */
 131
 132         /* Set the initial value from the key size. */
 133         for (value = 0x238F13AF * strlen(name), i=0; name[i]; i++)
 134                 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
 135
 136         return (1103515243 * value + 12345);
 137 }
 138
 139 /**
 140  * Allocate a new symbols for use in the hash of exported symbols or
 141  * the list of unresolved symbols per module
 142  **/
 143 static struct symbol *alloc_symbol(const char *name, unsigned int weak,
 144                                    struct symbol *next)
 145 {
 146         struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
 147
 148         memset(s, 0, sizeof(*s));
 149         strcpy(s->name, name);
 150         s->weak = weak;
 151         s->next = next;
 152         return s;
 153 }
 154
 155 /* For the hash of exported symbols */
 156 static struct symbol *new_symbol(const char *name, struct module *module)
 157 {
 158         unsigned int hash;
 159         struct symbol *new;
 160
 161         hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
 162         new = symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
 163         new->module = module;
 164         return new;
 165 }
 166
 167 static struct symbol *find_symbol(const char *name)
 168 {
 169         struct symbol *s;
 170
 171         /* For our purposes, .foo matches foo.  PPC64 needs this. */
 172         if (name[0] == '.')
 173                 name++;
 174
 175         for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s=s->next) {
 176                 if (strcmp(s->name, name) == 0)
 177                         return s;
 178         }
 179         return NULL;
 180 }
 181
 182 /**
 183  * Add an exported symbol - it may have already been added without a
 184  * CRC, in this case just update the CRC
 185  **/
 186 static struct symbol *sym_add_exported(const char *name, struct module *mod)
 187 {
 188         struct symbol *s = find_symbol(name);
 189
 190         if (!s) {
 191                 s = new_symbol(name, mod);
 192         } else {
 193                 if (!s->preloaded) {
 194                         warn("%s: duplicate symbol '%s' previous definition "
 195                              "was in %s%s\n", mod->name, name,
 196                              s->module->name,
 197                              is_vmlinux(s->module->name) ?"":".ko");
 198                 }
 199         }
 200         s->preloaded = 0;
 201         s->vmlinux   = is_vmlinux(mod->name);
 202         s->kernel    = 0;
 203         return s;
 204 }
 205
 206 static void sym_update_crc(const char *name, struct module *mod,
 207                            unsigned int crc)
 208 {
 209         struct symbol *s = find_symbol(name);
 210
 211         if (!s)
 212                 s = new_symbol(name, mod);
 213         s->crc = crc;
 214         s->crc_valid = 1;
 215 }
 216
 217 void *grab_file(const char *filename, unsigned long *size)
 218 {
 219         struct stat st;
 220         void *map;
 221         int fd;
 222
 223         fd = open(filename, O_RDONLY);
 224         if (fd < 0 || fstat(fd, &st) != 0)
 225                 return NULL;
 226
 227         *size = st.st_size;
 228         map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
 229         close(fd);
 230
 231         if (map == MAP_FAILED)
 232                 return NULL;
 233         return map;
 234 }
 235
 236 /**
 237   * Return a copy of the next line in a mmap'ed file.
 238   * spaces in the beginning of the line is trimmed away.
 239   * Return a pointer to a static buffer.
 240   **/
 241 char* get_next_line(unsigned long *pos, void *file, unsigned long size)
 242 {
 243         static char line[4096];
 244         int skip = 1;
 245         size_t len = 0;
 246         signed char *p = (signed char *)file + *pos;
 247         char *s = line;
 248
 249         for (; *pos < size ; (*pos)++)
 250         {
 251                 if (skip && isspace(*p)) {
 252                         p++;
 253                         continue;
 254                 }
 255                 skip = 0;
 256                 if (*p != '\n' && (*pos < size)) {
 257                         len++;
 258                         *s++ = *p++;
 259                         if (len > 4095)
 260                                 break; /* Too long, stop */
 261                 } else {
 262                         /* End of string */
 263                         *s = '\0';
 264                         return line;
 265                 }
 266         }
 267         /* End of buffer */
 268         return NULL;
 269 }
 270
 271 void release_file(void *file, unsigned long size)
 272 {
 273         munmap(file, size);
 274 }
 275
 276 static void parse_elf(struct elf_info *info, const char *filename)
 277 {
 278         unsigned int i;
 279         Elf_Ehdr *hdr = info->hdr;
 280         Elf_Shdr *sechdrs;
 281         Elf_Sym  *sym;
 282
 283         hdr = grab_file(filename, &info->size);
 284         if (!hdr) {
 285                 perror(filename);
 286                 abort();
 287         }
 288         info->hdr = hdr;
 289         if (info->size < sizeof(*hdr))
 290                 goto truncated;
 291
 292         /* Fix endianness in ELF header */
 293         hdr->e_shoff    = TO_NATIVE(hdr->e_shoff);
 294         hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
 295         hdr->e_shnum    = TO_NATIVE(hdr->e_shnum);
 296         hdr->e_machine  = TO_NATIVE(hdr->e_machine);
 297         sechdrs = (void *)hdr + hdr->e_shoff;
 298         info->sechdrs = sechdrs;
 299
 300         /* Fix endianness in section headers */
 301         for (i = 0; i < hdr->e_shnum; i++) {
 302                 sechdrs[i].sh_type   = TO_NATIVE(sechdrs[i].sh_type);
 303                 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
 304                 sechdrs[i].sh_size   = TO_NATIVE(sechdrs[i].sh_size);
 305                 sechdrs[i].sh_link   = TO_NATIVE(sechdrs[i].sh_link);
 306                 sechdrs[i].sh_name   = TO_NATIVE(sechdrs[i].sh_name);
 307         }
 308         /* Find symbol table. */
 309         for (i = 1; i < hdr->e_shnum; i++) {
 310                 const char *secstrings
 311                         = (void *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
 312
 313                 if (sechdrs[i].sh_offset > info->size)
 314                         goto truncated;
 315                 if (strcmp(secstrings+sechdrs[i].sh_name, ".modinfo") == 0) {
 316                         info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
 317                         info->modinfo_len = sechdrs[i].sh_size;
 318                 }
 319                 if (sechdrs[i].sh_type != SHT_SYMTAB)
 320                         continue;
 321
 322                 info->symtab_start = (void *)hdr + sechdrs[i].sh_offset;
 323                 info->symtab_stop  = (void *)hdr + sechdrs[i].sh_offset
 324                                                  + sechdrs[i].sh_size;
 325                 info->strtab       = (void *)hdr +
 326                                      sechdrs[sechdrs[i].sh_link].sh_offset;
 327         }
 328         if (!info->symtab_start) {
 329                 fatal("%s has no symtab?\n", filename);
 330         }
 331         /* Fix endianness in symbols */
 332         for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
 333                 sym->st_shndx = TO_NATIVE(sym->st_shndx);
 334                 sym->st_name  = TO_NATIVE(sym->st_name);
 335                 sym->st_value = TO_NATIVE(sym->st_value);
 336                 sym->st_size  = TO_NATIVE(sym->st_size);
 337         }
 338         return;
 339
 340  truncated:
 341         fatal("%s is truncated.\n", filename);
 342 }
 343
 344 static void parse_elf_finish(struct elf_info *info)
 345 {
 346         release_file(info->hdr, info->size);
 347 }
 348
 349 #define CRC_PFX     "__crc_"
 350 #define KSYMTAB_PFX "__ksymtab_"
 351
 352 static void handle_modversions(struct module *mod, struct elf_info *info,
 353                                Elf_Sym *sym, const char *symname)
 354 {
 355         unsigned int crc;
 356
 357         switch (sym->st_shndx) {
 358         case SHN_COMMON:
 359                 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
 360                 break;
 361         case SHN_ABS:
 362                 /* CRC'd symbol */
 363                 if (memcmp(symname, CRC_PFX, strlen(CRC_PFX)) == 0) {
 364                         crc = (unsigned int) sym->st_value;
 365                         sym_update_crc(symname + strlen(CRC_PFX), mod, crc);
 366                 }
 367                 break;
 368         case SHN_UNDEF:
 369                 /* undefined symbol */
 370                 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
 371                     ELF_ST_BIND(sym->st_info) != STB_WEAK)
 372                         break;
 373                 /* ignore global offset table */
 374                 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
 375                         break;
 376                 /* ignore __this_module, it will be resolved shortly */
 377                 if (strcmp(symname, MODULE_SYMBOL_PREFIX "__this_module") == 0)
 378                         break;
 379 /* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
 380 #if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
 381 /* add compatibility with older glibc */
 382 #ifndef STT_SPARC_REGISTER
 383 #define STT_SPARC_REGISTER STT_REGISTER
 384 #endif
 385                 if (info->hdr->e_machine == EM_SPARC ||
 386                     info->hdr->e_machine == EM_SPARCV9) {
 387                         /* Ignore register directives. */
 388                         if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
 389                                 break;
 390                         if (symname[0] == '.') {
 391                                 char *munged = strdup(symname);
 392                                 munged[0] = '_';
 393                                 munged[1] = toupper(munged[1]);
 394                                 symname = munged;
 395                         }
 396                 }
 397 #endif
 398
 399                 if (memcmp(symname, MODULE_SYMBOL_PREFIX,
 400                            strlen(MODULE_SYMBOL_PREFIX)) == 0)
 401                         mod->unres = alloc_symbol(symname +
 402                                                   strlen(MODULE_SYMBOL_PREFIX),
 403                                                   ELF_ST_BIND(sym->st_info) == STB_WEAK,
 404                                                   mod->unres);
 405                 break;
 406         default:
 407                 /* All exported symbols */
 408                 if (memcmp(symname, KSYMTAB_PFX, strlen(KSYMTAB_PFX)) == 0) {
 409                         sym_add_exported(symname + strlen(KSYMTAB_PFX), mod);
 410                 }
 411                 if (strcmp(symname, MODULE_SYMBOL_PREFIX "init_module") == 0)
 412                         mod->has_init = 1;
 413                 if (strcmp(symname, MODULE_SYMBOL_PREFIX "cleanup_module") == 0)
 414                         mod->has_cleanup = 1;
 415                 break;
 416         }
 417 }
 418
 419 /**
 420  * Parse tag=value strings from .modinfo section
 421  **/
 422 static char *next_string(char *string, unsigned long *secsize)
 423 {
 424         /* Skip non-zero chars */
 425         while (string[0]) {
 426                 string++;
 427                 if ((*secsize)-- <= 1)
 428                         return NULL;
 429         }
 430
 431         /* Skip any zero padding. */
 432         while (!string[0]) {
 433                 string++;
 434                 if ((*secsize)-- <= 1)
 435                         return NULL;
 436         }
 437         return string;
 438 }
 439
 440 static char *get_modinfo(void *modinfo, unsigned long modinfo_len,
 441                          const char *tag)
 442 {
 443         char *p;
 444         unsigned int taglen = strlen(tag);
 445         unsigned long size = modinfo_len;
 446
 447         for (p = modinfo; p; p = next_string(p, &size)) {
 448                 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
 449                         return p + taglen + 1;
 450         }
 451         return NULL;
 452 }
 453
 454 /**
 455  * Find symbol based on relocation record info.
 456  * In some cases the symbol supplied is a valid symbol so
 457  * return refsym. If st_name != 0 we assume this is a valid symbol.
 458  * In other cases the symbol needs to be looked up in the symbol table
 459  * based on section and address.
 460  *  **/
 461 static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf_Addr addr,
 462                                 Elf_Sym *relsym)
 463 {
 464         Elf_Sym *sym;
 465
 466         if (relsym->st_name != 0)
 467                 return relsym;
 468         for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
 469                 if (sym->st_shndx != relsym->st_shndx)
 470                         continue;
 471                 if (sym->st_value == addr)
 472                         return sym;
 473         }
 474         return NULL;
 475 }
 476
 477 /*
 478  * Find symbols before or equal addr and after addr - in the section sec
 479  **/
 480 static void find_symbols_between(struct elf_info *elf, Elf_Addr addr,
 481                                  const char *sec,
 482                                  Elf_Sym **before, Elf_Sym **after)
 483 {
 484         Elf_Sym *sym;
 485         Elf_Ehdr *hdr = elf->hdr;
 486         Elf_Addr beforediff = ~0;
 487         Elf_Addr afterdiff = ~0;
 488         const char *secstrings = (void *)hdr +
 489                                  elf->sechdrs[hdr->e_shstrndx].sh_offset;
 490
 491         *before = NULL;
 492         *after = NULL;
 493
 494         for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
 495                 const char *symsec;
 496
 497                 if (sym->st_shndx >= SHN_LORESERVE)
 498                         continue;
 499                 symsec = secstrings + elf->sechdrs[sym->st_shndx].sh_name;
 500                 if (strcmp(symsec, sec) != 0)
 501                         continue;
 502                 if (sym->st_value <= addr) {
 503                         if ((addr - sym->st_value) < beforediff) {
 504                                 beforediff = addr - sym->st_value;
 505                                 *before = sym;
 506                         }
 507                 }
 508                 else
 509                 {
 510                         if ((sym->st_value - addr) < afterdiff) {
 511                                 afterdiff = sym->st_value - addr;
 512                                 *after = sym;
 513                         }
 514                 }
 515         }
 516 }
 517
 518 /**
 519  * Print a warning about a section mismatch.
 520  * Try to find symbols near it so user can find it.
 521  **/
 522 static void warn_sec_mismatch(const char *modname, const char *fromsec,
 523                               struct elf_info *elf, Elf_Sym *sym, Elf_Rela r)
 524 {
 525         const char *refsymname = "";
 526         Elf_Sym *before, *after;
 527         Elf_Sym *refsym;
 528         Elf_Ehdr *hdr = elf->hdr;
 529         Elf_Shdr *sechdrs = elf->sechdrs;
 530         const char *secstrings = (void *)hdr +
 531                                  sechdrs[hdr->e_shstrndx].sh_offset;
 532         const char *secname = secstrings + sechdrs[sym->st_shndx].sh_name;
 533
 534         find_symbols_between(elf, r.r_offset, fromsec, &before, &after);
 535
 536         refsym = find_elf_symbol(elf, r.r_addend, sym);
 537         if (refsym && strlen(elf->strtab + refsym->st_name))
 538                 refsymname = elf->strtab + refsym->st_name;
 539
 540         if (before && after) {
 541                 warn("%s - Section mismatch: reference to %s:%s from %s "
 542                      "between '%s' (at offset 0x%llx) and '%s'\n",
 543                      modname, secname, refsymname, fromsec,
 544                      elf->strtab + before->st_name,
 545                      (long long)r.r_offset,
 546                      elf->strtab + after->st_name);
 547         } else if (before) {
 548                 warn("%s - Section mismatch: reference to %s:%s from %s "
 549                      "after '%s' (at offset 0x%llx)\n",
 550                      modname, secname, refsymname, fromsec,
 551                      elf->strtab + before->st_name,
 552                      (long long)r.r_offset);
 553         } else if (after) {
 554                 warn("%s - Section mismatch: reference to %s:%s from %s "
 555                      "before '%s' (at offset -0x%llx)\n",
 556                      modname, secname, refsymname, fromsec,
 557                      elf->strtab + before->st_name,
 558                      (long long)r.r_offset);
 559         } else {
 560                 warn("%s - Section mismatch: reference to %s:%s from %s "
 561                      "(offset 0x%llx)\n",
 562                      modname, secname, fromsec, refsymname,
 563                      (long long)r.r_offset);
 564         }
 565 }
 566
 567 /**
 568  * A module includes a number of sections that are discarded
 569  * either when loaded or when used as built-in.
 570  * For loaded modules all functions marked __init and all data
 571  * marked __initdata will be discarded when the module has been intialized.
 572  * Likewise for modules used built-in the sections marked __exit
 573  * are discarded because __exit marked function are supposed to be called
 574  * only when a moduel is unloaded which never happes for built-in modules.
 575  * The check_sec_ref() function traverses all relocation records
 576  * to find all references to a section that reference a section that will
 577  * be discarded and warns about it.
 578  **/
 579 static void check_sec_ref(struct module *mod, const char *modname,
 580                           struct elf_info *elf,
 581                           int section(const char*),
 582                           int section_ref_ok(const char *))
 583 {
 584         int i;
 585         Elf_Sym  *sym;
 586         Elf_Ehdr *hdr = elf->hdr;
 587         Elf_Shdr *sechdrs = elf->sechdrs;
 588         const char *secstrings = (void *)hdr +
 589                                  sechdrs[hdr->e_shstrndx].sh_offset;
 590
 591         /* Walk through all sections */
 592         for (i = 0; i < hdr->e_shnum; i++) {
 593                 Elf_Rela *rela;
 594                 Elf_Rela *start = (void *)hdr + sechdrs[i].sh_offset;
 595                 Elf_Rela *stop  = (void*)start + sechdrs[i].sh_size;
 596                 const char *name = secstrings + sechdrs[i].sh_name +
 597                                                 strlen(".rela");
 598                 /* We want to process only relocation sections and not .init */
 599                 if (section_ref_ok(name) || (sechdrs[i].sh_type != SHT_RELA))
 600                         continue;
 601
 602                 for (rela = start; rela < stop; rela++) {
 603                         Elf_Rela r;
 604                         const char *secname;
 605                         r.r_offset = TO_NATIVE(rela->r_offset);
 606                         r.r_info   = TO_NATIVE(rela->r_info);
 607                         r.r_addend = TO_NATIVE(rela->r_addend);
 608                         sym = elf->symtab_start + ELF_R_SYM(r.r_info);
 609                         /* Skip special sections */
 610                         if (sym->st_shndx >= SHN_LORESERVE)
 611                                 continue;
 612
 613                         secname = secstrings + sechdrs[sym->st_shndx].sh_name;
 614                         if (section(secname))
 615                                 warn_sec_mismatch(modname, name, elf, sym, r);
 616                 }
 617         }
 618 }
 619
 620 /**
 621  * Functions used only during module init is marked __init and is stored in
 622  * a .init.text section. Likewise data is marked __initdata and stored in
 623  * a .init.data section.
 624  * If this section is one of these sections return 1
 625  * See include/linux/init.h for the details
 626  **/
 627 static int init_section(const char *name)
 628 {
 629         if (strcmp(name, ".init") == 0)
 630                 return 1;
 631         if (strncmp(name, ".init.", strlen(".init.")) == 0)
 632                 return 1;
 633         return 0;
 634 }
 635
 636 /**
 637  * Identify sections from which references to a .init section is OK.
 638  *
 639  * Unfortunately references to read only data that referenced .init
 640  * sections had to be excluded. Almost all of these are false
 641  * positives, they are created by gcc. The downside of excluding rodata
 642  * is that there really are some user references from rodata to
 643  * init code, e.g. drivers/video/vgacon.c:
 644  *
 645  * const struct consw vga_con = {
 646  *        con_startup:            vgacon_startup,
 647  *
 648  * where vgacon_startup is __init.  If you want to wade through the false
 649  * positives, take out the check for rodata.
 650  **/
 651 static int init_section_ref_ok(const char *name)
 652 {
 653         const char **s;
 654         /* Absolute section names */
 655         const char *namelist1[] = {
 656                 ".init",
 657                 ".stab",
 658                 ".rodata",
 659                 ".text.lock",
 660                 ".pci_fixup_header",
 661                 ".pci_fixup_final",
 662                 ".pdr",
 663                 "__param",
 664                 NULL
 665         };
 666         /* Start of section names */
 667         const char *namelist2[] = {
 668                 ".init.",
 669                 ".altinstructions",
 670                 ".eh_frame",
 671                 ".debug",
 672                 NULL
 673         };
 674
 675         for (s = namelist1; *s; s++)
 676                 if (strcmp(*s, name) == 0)
 677                         return 1;
 678         for (s = namelist2; *s; s++)
 679                 if (strncmp(*s, name, strlen(*s)) == 0)
 680                         return 1;
 681         return 0;
 682 }
 683
 684 /*
 685  * Functions used only during module exit is marked __exit and is stored in
 686  * a .exit.text section. Likewise data is marked __exitdata and stored in
 687  * a .exit.data section.
 688  * If this section is one of these sections return 1
 689  * See include/linux/init.h for the details
 690  **/
 691 static int exit_section(const char *name)
 692 {
 693         if (strcmp(name, ".exit.text") == 0)
 694                 return 1;
 695         if (strcmp(name, ".exit.data") == 0)
 696                 return 1;
 697         return 0;
 698
 699 }
 700
 701 /*
 702  * Identify sections from which references to a .exit section is OK.
 703  *
 704  * [OPD] Keith Ownes <kaos@sgi.com> commented:
 705  * For our future {in}sanity, add a comment that this is the ppc .opd
 706  * section, not the ia64 .opd section.
 707  * ia64 .opd should not point to discarded sections.
 708  **/
 709 static int exit_section_ref_ok(const char *name)
 710 {
 711         const char **s;
 712         /* Absolute section names */
 713         const char *namelist1[] = {
 714                 ".exit.text",
 715                 ".exit.data",
 716                 ".init.text",
 717                 ".opd", /* See comment [OPD] */
 718                 ".altinstructions",
 719                 ".pdr",
 720                 ".exitcall.exit",
 721                 ".eh_frame",
 722                 ".stab",
 723                 NULL
 724         };
 725         /* Start of section names */
 726         const char *namelist2[] = {
 727                 ".debug",
 728                 NULL
 729         };
 730
 731         for (s = namelist1; *s; s++)
 732                 if (strcmp(*s, name) == 0)
 733                         return 1;
 734         for (s = namelist2; *s; s++)
 735                 if (strncmp(*s, name, strlen(*s)) == 0)
 736                         return 1;
 737         return 0;
 738 }
 739
 740 static void read_symbols(char *modname)
 741 {
 742         const char *symname;
 743         char *version;
 744         struct module *mod;
 745         struct elf_info info = { };
 746         Elf_Sym *sym;
 747
 748         parse_elf(&info, modname);
 749
 750         mod = new_module(modname);
 751
 752         /* When there's no vmlinux, don't print warnings about
 753          * unresolved symbols (since there'll be too many ;) */
 754         if (is_vmlinux(modname)) {
 755                 have_vmlinux = 1;
 756                 mod->skip = 1;
 757         }
 758
 759         for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
 760                 symname = info.strtab + sym->st_name;
 761
 762                 handle_modversions(mod, &info, sym, symname);
 763                 handle_moddevtable(mod, &info, sym, symname);
 764         }
 765         check_sec_ref(mod, modname, &info, init_section, init_section_ref_ok);
 766         check_sec_ref(mod, modname, &info, exit_section, exit_section_ref_ok);
 767
 768         version = get_modinfo(info.modinfo, info.modinfo_len, "version");
 769         if (version)
 770                 maybe_frob_rcs_version(modname, version, info.modinfo,
 771                                        version - (char *)info.hdr);
 772         if (version || (all_versions && !is_vmlinux(modname)))
 773                 get_src_version(modname, mod->srcversion,
 774                                 sizeof(mod->srcversion)-1);
 775
 776         parse_elf_finish(&info);
 777
 778         /* Our trick to get versioning for struct_module - it's
 779          * never passed as an argument to an exported function, so
 780          * the automatic versioning doesn't pick it up, but it's really
 781          * important anyhow */
 782         if (modversions)
 783                 mod->unres = alloc_symbol("struct_module", 0, mod->unres);
 784 }
 785
 786 #define SZ 500
 787
 788 /* We first write the generated file into memory using the
 789  * following helper, then compare to the file on disk and
 790  * only update the later if anything changed */
 791
 792 void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
 793                                                       const char *fmt, ...)
 794 {
 795         char tmp[SZ];
 796         int len;
 797         va_list ap;
 798
 799         va_start(ap, fmt);
 800         len = vsnprintf(tmp, SZ, fmt, ap);
 801         if (buf->size - buf->pos < len + 1) {
 802                 buf->size += 128;
 803                 buf->p = realloc(buf->p, buf->size);
 804         }
 805         strncpy(buf->p + buf->pos, tmp, len + 1);
 806         buf->pos += len;
 807         va_end(ap);
 808 }
 809
 810 void buf_write(struct buffer *buf, const char *s, int len)
 811 {
 812         if (buf->size - buf->pos < len) {
 813                 buf->size += len;
 814                 buf->p = realloc(buf->p, buf->size);
 815         }
 816         strncpy(buf->p + buf->pos, s, len);
 817         buf->pos += len;
 818 }
 819
 820 /**
 821  * Header for the generated file
 822  **/
 823 static void add_header(struct buffer *b, struct module *mod)
 824 {
 825         buf_printf(b, "#include <linux/module.h>\n");
 826         buf_printf(b, "#include <linux/vermagic.h>\n");
 827         buf_printf(b, "#include <linux/compiler.h>\n");
 828         buf_printf(b, "\n");
 829         buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
 830         buf_printf(b, "\n");
 831         buf_printf(b, "struct module __this_module\n");
 832         buf_printf(b, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
 833         buf_printf(b, " .name = KBUILD_MODNAME,\n");
 834         if (mod->has_init)
 835                 buf_printf(b, " .init = init_module,\n");
 836         if (mod->has_cleanup)
 837                 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
 838                               " .exit = cleanup_module,\n"
 839                               "#endif\n");
 840         buf_printf(b, "};\n");
 841 }
 842
 843 /**
 844  * Record CRCs for unresolved symbols
 845  **/
 846 static void add_versions(struct buffer *b, struct module *mod)
 847 {
 848         struct symbol *s, *exp;
 849
 850         for (s = mod->unres; s; s = s->next) {
 851                 exp = find_symbol(s->name);
 852                 if (!exp || exp->module == mod) {
 853                         if (have_vmlinux && !s->weak)
 854                                 warn("\"%s\" [%s.ko] undefined!\n",
 855                                      s->name, mod->name);
 856                         continue;
 857                 }
 858                 s->module = exp->module;
 859                 s->crc_valid = exp->crc_valid;
 860                 s->crc = exp->crc;
 861         }
 862
 863         if (!modversions)
 864                 return;
 865
 866         buf_printf(b, "\n");
 867         buf_printf(b, "static const struct modversion_info ____versions[]\n");
 868         buf_printf(b, "__attribute_used__\n");
 869         buf_printf(b, "__attribute__((section(\"__versions\"))) = {\n");
 870
 871         for (s = mod->unres; s; s = s->next) {
 872                 if (!s->module) {
 873                         continue;
 874                 }
 875                 if (!s->crc_valid) {
 876                         warn("\"%s\" [%s.ko] has no CRC!\n",
 877                                 s->name, mod->name);
 878                         continue;
 879                 }
 880                 buf_printf(b, "\t{ %#8x, \"%s\" },\n", s->crc, s->name);
 881         }
 882
 883         buf_printf(b, "};\n");
 884 }
 885
 886 static void add_depends(struct buffer *b, struct module *mod,
 887                         struct module *modules)
 888 {
 889         struct symbol *s;
 890         struct module *m;
 891         int first = 1;
 892
 893         for (m = modules; m; m = m->next) {
 894                 m->seen = is_vmlinux(m->name);
 895         }
 896
 897         buf_printf(b, "\n");
 898         buf_printf(b, "static const char __module_depends[]\n");
 899         buf_printf(b, "__attribute_used__\n");
 900         buf_printf(b, "__attribute__((section(\".modinfo\"))) =\n");
 901         buf_printf(b, "\"depends=");
 902         for (s = mod->unres; s; s = s->next) {
 903                 if (!s->module)
 904                         continue;
 905
 906                 if (s->module->seen)
 907                         continue;
 908
 909                 s->module->seen = 1;
 910                 buf_printf(b, "%s%s", first ? "" : ",",
 911                            strrchr(s->module->name, '/') + 1);
 912                 first = 0;
 913         }
 914         buf_printf(b, "\";\n");
 915 }
 916
 917 static void add_srcversion(struct buffer *b, struct module *mod)
 918 {
 919         if (mod->srcversion[0]) {
 920                 buf_printf(b, "\n");
 921                 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
 922                            mod->srcversion);
 923         }
 924 }
 925
 926 static void write_if_changed(struct buffer *b, const char *fname)
 927 {
 928         char *tmp;
 929         FILE *file;
 930         struct stat st;
 931
 932         file = fopen(fname, "r");
 933         if (!file)
 934                 goto write;
 935
 936         if (fstat(fileno(file), &st) < 0)
 937                 goto close_write;
 938
 939         if (st.st_size != b->pos)
 940                 goto close_write;
 941
 942         tmp = NOFAIL(malloc(b->pos));
 943         if (fread(tmp, 1, b->pos, file) != b->pos)
 944                 goto free_write;
 945
 946         if (memcmp(tmp, b->p, b->pos) != 0)
 947                 goto free_write;
 948
 949         free(tmp);
 950         fclose(file);
 951         return;
 952
 953  free_write:
 954         free(tmp);
 955  close_write:
 956         fclose(file);
 957  write:
 958         file = fopen(fname, "w");
 959         if (!file) {
 960                 perror(fname);
 961                 exit(1);
 962         }
 963         if (fwrite(b->p, 1, b->pos, file) != b->pos) {
 964                 perror(fname);
 965                 exit(1);
 966         }
 967         fclose(file);
 968 }
 969
 970 static void read_dump(const char *fname, unsigned int kernel)
 971 {
 972         unsigned long size, pos = 0;
 973         void *file = grab_file(fname, &size);
 974         char *line;
 975
 976         if (!file)
 977                 /* No symbol versions, silently ignore */
 978                 return;
 979
 980         while ((line = get_next_line(&pos, file, size))) {
 981                 char *symname, *modname, *d;
 982                 unsigned int crc;
 983                 struct module *mod;
 984                 struct symbol *s;
 985
 986                 if (!(symname = strchr(line, '\t')))
 987                         goto fail;
 988                 *symname++ = '\0';
 989                 if (!(modname = strchr(symname, '\t')))
 990                         goto fail;
 991                 *modname++ = '\0';
 992                 if (strchr(modname, '\t'))
 993                         goto fail;
 994                 crc = strtoul(line, &d, 16);
 995                 if (*symname == '\0' || *modname == '\0' || *d != '\0')
 996                         goto fail;
 997
 998                 if (!(mod = find_module(modname))) {
 999                         if (is_vmlinux(modname)) {
1000                                 have_vmlinux = 1;
1001                         }
1002                         mod = new_module(NOFAIL(strdup(modname)));
1003                         mod->skip = 1;
1004                 }
1005                 s = sym_add_exported(symname, mod);
1006                 s->kernel    = kernel;
1007                 s->preloaded = 1;
1008                 sym_update_crc(symname, mod, crc);
1009         }
1010         return;
1011 fail:
1012         fatal("parse error in symbol dump file\n");
1013 }
1014
1015 /* For normal builds always dump all symbols.
1016  * For external modules only dump symbols
1017  * that are not read from kernel Module.symvers.
1018  **/
1019 static int dump_sym(struct symbol *sym)
1020 {
1021         if (!external_module)
1022                 return 1;
1023         if (sym->vmlinux || sym->kernel)
1024                 return 0;
1025         return 1;
1026 }
1027
1028 static void write_dump(const char *fname)
1029 {
1030         struct buffer buf = { };
1031         struct symbol *symbol;
1032         int n;
1033
1034         for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
1035                 symbol = symbolhash[n];
1036                 while (symbol) {
1037                         if (dump_sym(symbol))
1038                                 buf_printf(&buf, "0x%08x\t%s\t%s\n",
1039                                         symbol->crc, symbol->name,
1040                                         symbol->module->name);
1041                         symbol = symbol->next;
1042                 }
1043         }
1044         write_if_changed(&buf, fname);
1045 }
1046
1047 int main(int argc, char **argv)
1048 {
1049         struct module *mod;
1050         struct buffer buf = { };
1051         char fname[SZ];
1052         char *kernel_read = NULL, *module_read = NULL;
1053         char *dump_write = NULL;
1054         int opt;
1055
1056         while ((opt = getopt(argc, argv, "i:I:mo:a")) != -1) {
1057                 switch(opt) {
1058                         case 'i':
1059                                 kernel_read = optarg;
1060                                 break;
1061                         case 'I':
1062                                 module_read = optarg;
1063                                 external_module = 1;
1064                                 break;
1065                         case 'm':
1066                                 modversions = 1;
1067                                 break;
1068                         case 'o':
1069                                 dump_write = optarg;
1070                                 break;
1071                         case 'a':
1072                                 all_versions = 1;
1073                                 break;
1074                         default:
1075                                 exit(1);
1076                 }
1077         }
1078
1079         if (kernel_read)
1080                 read_dump(kernel_read, 1);
1081         if (module_read)
1082                 read_dump(module_read, 0);
1083
1084         while (optind < argc) {
1085                 read_symbols(argv[optind++]);
1086         }
1087
1088         for (mod = modules; mod; mod = mod->next) {
1089                 if (mod->skip)
1090                         continue;
1091
1092                 buf.pos = 0;
1093
1094                 add_header(&buf, mod);
1095                 add_versions(&buf, mod);
1096                 add_depends(&buf, mod, modules);
1097                 add_moddevtable(&buf, mod);
1098                 add_srcversion(&buf, mod);
1099
1100                 sprintf(fname, "%s.mod.c", mod->name);
1101                 write_if_changed(&buf, fname);
1102         }
1103
1104         if (dump_write)
1105                 write_dump(dump_write);
1106
1107         return 0;
1108 }