1 /* Postprocess module symbol versions
3 * Copyright 2003 Kai Germaschewski
4 * Copyright 2002-2004 Rusty Russell, IBM Corporation
5 * Copyright 2006 Sam Ravnborg
6 * Based in part on module-init-tools/depmod.c,file2alias
8 * This software may be used and distributed according to the terms
9 * of the GNU General Public License, incorporated herein by reference.
11 * Usage: modpost vmlinux module1.o module2.o ...
16 #include "../../include/linux/license.h"
18 /* Are we using CONFIG_MODVERSIONS? */
20 /* Warn about undefined symbols? (do so if we have vmlinux) */
22 /* Is CONFIG_MODULE_SRCVERSION_ALL set? */
23 static int all_versions = 0;
24 /* If we are modposting external module set to 1 */
25 static int external_module = 0;
26 /* Only warn about unresolved symbols */
27 static int warn_unresolved = 0;
28 /* How a symbol is exported */
30 export_plain, export_unused, export_gpl,
31 export_unused_gpl, export_gpl_future, export_unknown
34 void fatal(const char *fmt, ...)
38 fprintf(stderr, "FATAL: ");
40 va_start(arglist, fmt);
41 vfprintf(stderr, fmt, arglist);
47 void warn(const char *fmt, ...)
51 fprintf(stderr, "WARNING: ");
53 va_start(arglist, fmt);
54 vfprintf(stderr, fmt, arglist);
58 void merror(const char *fmt, ...)
62 fprintf(stderr, "ERROR: ");
64 va_start(arglist, fmt);
65 vfprintf(stderr, fmt, arglist);
69 static int is_vmlinux(const char *modname)
73 if ((myname = strrchr(modname, '/')))
78 return strcmp(myname, "vmlinux") == 0;
81 void *do_nofail(void *ptr, const char *expr)
84 fatal("modpost: Memory allocation failure: %s.\n", expr);
89 /* A list of all modules we processed */
91 static struct module *modules;
93 static struct module *find_module(char *modname)
97 for (mod = modules; mod; mod = mod->next)
98 if (strcmp(mod->name, modname) == 0)
103 static struct module *new_module(char *modname)
108 mod = NOFAIL(malloc(sizeof(*mod)));
109 memset(mod, 0, sizeof(*mod));
110 p = NOFAIL(strdup(modname));
112 /* strip trailing .o */
113 if ((s = strrchr(p, '.')) != NULL)
114 if (strcmp(s, ".o") == 0)
119 mod->gpl_compatible = -1;
126 /* A hash of all exported symbols,
127 * struct symbol is also used for lists of unresolved symbols */
129 #define SYMBOL_HASH_SIZE 1024
133 struct module *module;
137 unsigned int vmlinux:1; /* 1 if symbol is defined in vmlinux */
138 unsigned int kernel:1; /* 1 if symbol is from kernel
139 * (only for external modules) **/
140 unsigned int preloaded:1; /* 1 if symbol from Module.symvers */
141 enum export export; /* Type of export */
145 static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
147 /* This is based on the hash agorithm from gdbm, via tdb */
148 static inline unsigned int tdb_hash(const char *name)
150 unsigned value; /* Used to compute the hash value. */
151 unsigned i; /* Used to cycle through random values. */
153 /* Set the initial value from the key size. */
154 for (value = 0x238F13AF * strlen(name), i=0; name[i]; i++)
155 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
157 return (1103515243 * value + 12345);
161 * Allocate a new symbols for use in the hash of exported symbols or
162 * the list of unresolved symbols per module
164 static struct symbol *alloc_symbol(const char *name, unsigned int weak,
167 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
169 memset(s, 0, sizeof(*s));
170 strcpy(s->name, name);
176 /* For the hash of exported symbols */
177 static struct symbol *new_symbol(const char *name, struct module *module,
183 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
184 new = symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
185 new->module = module;
186 new->export = export;
190 static struct symbol *find_symbol(const char *name)
194 /* For our purposes, .foo matches foo. PPC64 needs this. */
198 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s=s->next) {
199 if (strcmp(s->name, name) == 0)
209 { .str = "EXPORT_SYMBOL", .export = export_plain },
210 { .str = "EXPORT_UNUSED_SYMBOL", .export = export_unused },
211 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
212 { .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
213 { .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
214 { .str = "(unknown)", .export = export_unknown },
218 static const char *export_str(enum export ex)
220 return export_list[ex].str;
223 static enum export export_no(const char * s)
227 return export_unknown;
228 for (i = 0; export_list[i].export != export_unknown; i++) {
229 if (strcmp(export_list[i].str, s) == 0)
230 return export_list[i].export;
232 return export_unknown;
235 static enum export export_from_sec(struct elf_info *elf, Elf_Section sec)
237 if (sec == elf->export_sec)
239 else if (sec == elf->export_unused_sec)
240 return export_unused;
241 else if (sec == elf->export_gpl_sec)
243 else if (sec == elf->export_unused_gpl_sec)
244 return export_unused_gpl;
245 else if (sec == elf->export_gpl_future_sec)
246 return export_gpl_future;
248 return export_unknown;
252 * Add an exported symbol - it may have already been added without a
253 * CRC, in this case just update the CRC
255 static struct symbol *sym_add_exported(const char *name, struct module *mod,
258 struct symbol *s = find_symbol(name);
261 s = new_symbol(name, mod, export);
264 warn("%s: '%s' exported twice. Previous export "
265 "was in %s%s\n", mod->name, name,
267 is_vmlinux(s->module->name) ?"":".ko");
271 s->vmlinux = is_vmlinux(mod->name);
277 static void sym_update_crc(const char *name, struct module *mod,
278 unsigned int crc, enum export export)
280 struct symbol *s = find_symbol(name);
283 s = new_symbol(name, mod, export);
288 void *grab_file(const char *filename, unsigned long *size)
294 fd = open(filename, O_RDONLY);
295 if (fd < 0 || fstat(fd, &st) != 0)
299 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
302 if (map == MAP_FAILED)
308 * Return a copy of the next line in a mmap'ed file.
309 * spaces in the beginning of the line is trimmed away.
310 * Return a pointer to a static buffer.
312 char* get_next_line(unsigned long *pos, void *file, unsigned long size)
314 static char line[4096];
317 signed char *p = (signed char *)file + *pos;
320 for (; *pos < size ; (*pos)++)
322 if (skip && isspace(*p)) {
327 if (*p != '\n' && (*pos < size)) {
331 break; /* Too long, stop */
342 void release_file(void *file, unsigned long size)
347 static int parse_elf(struct elf_info *info, const char *filename)
354 hdr = grab_file(filename, &info->size);
360 if (info->size < sizeof(*hdr)) {
361 /* file too small, assume this is an empty .o file */
364 /* Is this a valid ELF file? */
365 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
366 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
367 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
368 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
369 /* Not an ELF file - silently ignore it */
372 /* Fix endianness in ELF header */
373 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
374 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
375 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
376 hdr->e_machine = TO_NATIVE(hdr->e_machine);
377 sechdrs = (void *)hdr + hdr->e_shoff;
378 info->sechdrs = sechdrs;
380 /* Fix endianness in section headers */
381 for (i = 0; i < hdr->e_shnum; i++) {
382 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
383 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
384 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
385 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
386 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
388 /* Find symbol table. */
389 for (i = 1; i < hdr->e_shnum; i++) {
390 const char *secstrings
391 = (void *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
394 if (sechdrs[i].sh_offset > info->size) {
395 fatal("%s is truncated. sechdrs[i].sh_offset=%u > sizeof(*hrd)=%ul\n", filename, (unsigned int)sechdrs[i].sh_offset, sizeof(*hdr));
398 secname = secstrings + sechdrs[i].sh_name;
399 if (strcmp(secname, ".modinfo") == 0) {
400 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
401 info->modinfo_len = sechdrs[i].sh_size;
402 } else if (strcmp(secname, "__ksymtab") == 0)
403 info->export_sec = i;
404 else if (strcmp(secname, "__ksymtab_unused") == 0)
405 info->export_unused_sec = i;
406 else if (strcmp(secname, "__ksymtab_gpl") == 0)
407 info->export_gpl_sec = i;
408 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
409 info->export_unused_gpl_sec = i;
410 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
411 info->export_gpl_future_sec = i;
413 if (sechdrs[i].sh_type != SHT_SYMTAB)
416 info->symtab_start = (void *)hdr + sechdrs[i].sh_offset;
417 info->symtab_stop = (void *)hdr + sechdrs[i].sh_offset
418 + sechdrs[i].sh_size;
419 info->strtab = (void *)hdr +
420 sechdrs[sechdrs[i].sh_link].sh_offset;
422 if (!info->symtab_start) {
423 fatal("%s has no symtab?\n", filename);
425 /* Fix endianness in symbols */
426 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
427 sym->st_shndx = TO_NATIVE(sym->st_shndx);
428 sym->st_name = TO_NATIVE(sym->st_name);
429 sym->st_value = TO_NATIVE(sym->st_value);
430 sym->st_size = TO_NATIVE(sym->st_size);
435 static void parse_elf_finish(struct elf_info *info)
437 release_file(info->hdr, info->size);
440 #define CRC_PFX MODULE_SYMBOL_PREFIX "__crc_"
441 #define KSYMTAB_PFX MODULE_SYMBOL_PREFIX "__ksymtab_"
443 static void handle_modversions(struct module *mod, struct elf_info *info,
444 Elf_Sym *sym, const char *symname)
447 enum export export = export_from_sec(info, sym->st_shndx);
449 switch (sym->st_shndx) {
451 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
455 if (memcmp(symname, CRC_PFX, strlen(CRC_PFX)) == 0) {
456 crc = (unsigned int) sym->st_value;
457 sym_update_crc(symname + strlen(CRC_PFX), mod, crc,
462 /* undefined symbol */
463 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
464 ELF_ST_BIND(sym->st_info) != STB_WEAK)
466 /* ignore global offset table */
467 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
469 /* ignore __this_module, it will be resolved shortly */
470 if (strcmp(symname, MODULE_SYMBOL_PREFIX "__this_module") == 0)
472 /* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
473 #if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
474 /* add compatibility with older glibc */
475 #ifndef STT_SPARC_REGISTER
476 #define STT_SPARC_REGISTER STT_REGISTER
478 if (info->hdr->e_machine == EM_SPARC ||
479 info->hdr->e_machine == EM_SPARCV9) {
480 /* Ignore register directives. */
481 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
483 if (symname[0] == '.') {
484 char *munged = strdup(symname);
486 munged[1] = toupper(munged[1]);
492 if (memcmp(symname, MODULE_SYMBOL_PREFIX,
493 strlen(MODULE_SYMBOL_PREFIX)) == 0)
494 mod->unres = alloc_symbol(symname +
495 strlen(MODULE_SYMBOL_PREFIX),
496 ELF_ST_BIND(sym->st_info) == STB_WEAK,
500 /* All exported symbols */
501 if (memcmp(symname, KSYMTAB_PFX, strlen(KSYMTAB_PFX)) == 0) {
502 sym_add_exported(symname + strlen(KSYMTAB_PFX), mod,
505 if (strcmp(symname, MODULE_SYMBOL_PREFIX "init_module") == 0)
507 if (strcmp(symname, MODULE_SYMBOL_PREFIX "cleanup_module") == 0)
508 mod->has_cleanup = 1;
514 * Parse tag=value strings from .modinfo section
516 static char *next_string(char *string, unsigned long *secsize)
518 /* Skip non-zero chars */
521 if ((*secsize)-- <= 1)
525 /* Skip any zero padding. */
528 if ((*secsize)-- <= 1)
534 static char *get_next_modinfo(void *modinfo, unsigned long modinfo_len,
535 const char *tag, char *info)
538 unsigned int taglen = strlen(tag);
539 unsigned long size = modinfo_len;
542 size -= info - (char *)modinfo;
543 modinfo = next_string(info, &size);
546 for (p = modinfo; p; p = next_string(p, &size)) {
547 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
548 return p + taglen + 1;
553 static char *get_modinfo(void *modinfo, unsigned long modinfo_len,
557 return get_next_modinfo(modinfo, modinfo_len, tag, NULL);
561 * Test if string s ends in string sub
564 static int strrcmp(const char *s, const char *sub)
572 sublen = strlen(sub);
574 if ((slen == 0) || (sublen == 0))
580 return memcmp(s + slen - sublen, sub, sublen);
584 * Whitelist to allow certain references to pass with no warning.
586 * If a module parameter is declared __initdata and permissions=0
587 * then this is legal despite the warning generated.
588 * We cannot see value of permissions here, so just ignore
590 * The pattern is identified by:
596 * Many drivers utilise a *driver container with references to
597 * add, remove, probe functions etc.
598 * These functions may often be marked __init and we do not want to
600 * the pattern is identified by:
601 * tosec = .init.text | .exit.text | .init.data
603 * atsym = *driver, *_template, *_sht, *_ops, *_probe, *probe_one, *_console
606 * Whitelist all references from .pci_fixup* section to .init.text
607 * This is part of the PCI init when built-in
610 * Whitelist all refereces from .text.head to .init.data
611 * Whitelist all refereces from .text.head to .init.text
614 * Some symbols belong to init section but still it is ok to reference
615 * these from non-init sections as these symbols don't have any memory
616 * allocated for them and symbol address and value are same. So even
617 * if init section is freed, its ok to reference those symbols.
618 * For ex. symbols marking the init section boundaries.
619 * This pattern is identified by
620 * refsymname = __init_begin, _sinittext, _einittext
623 * During the early init phase we have references from .init.text to
624 * .text we have an intended section mismatch - do not warn about it.
625 * See kernel_init() in init/main.c
628 * atsym = kernel_init
629 * Some symbols belong to init section but still it is ok to reference
632 * Logos used in drivers/video/logo reside in __initdata but the
633 * funtion that references them are EXPORT_SYMBOL() so cannot be
634 * marker __init. So we whitelist them here.
640 static int secref_whitelist(const char *modname, const char *tosec,
641 const char *fromsec, const char *atsym,
642 const char *refsymname)
646 const char *pat2sym[] = {
648 "_template", /* scsi uses *_template a lot */
649 "_sht", /* scsi also used *_sht to some extent */
657 const char *pat3refsym[] = {
664 /* Check for pattern 1 */
665 if (strcmp(tosec, ".init.data") != 0)
667 if (strncmp(fromsec, ".data", strlen(".data")) != 0)
669 if (strncmp(atsym, "__param", strlen("__param")) != 0)
675 /* Check for pattern 2 */
676 if ((strcmp(tosec, ".init.text") != 0) &&
677 (strcmp(tosec, ".exit.text") != 0) &&
678 (strcmp(tosec, ".init.data") != 0))
680 if (strcmp(fromsec, ".data") != 0)
683 for (s = pat2sym; *s; s++)
684 if (strrcmp(atsym, *s) == 0)
689 /* Check for pattern 3 */
690 if ((strncmp(fromsec, ".pci_fixup", strlen(".pci_fixup")) == 0) &&
691 (strcmp(tosec, ".init.text") == 0))
694 /* Check for pattern 4 */
695 if ((strcmp(fromsec, ".text.head") == 0) &&
696 ((strcmp(tosec, ".init.data") == 0) ||
697 (strcmp(tosec, ".init.text") == 0)))
700 /* Check for pattern 5 */
701 for (s = pat3refsym; *s; s++)
702 if (strcmp(refsymname, *s) == 0)
705 /* Check for pattern 6 */
706 if ((strcmp(tosec, ".init.text") == 0) &&
707 (strcmp(fromsec, ".text") == 0) &&
708 (strcmp(refsymname, "kernel_init") == 0))
711 /* Check for pattern 7 */
712 if ((strcmp(tosec, ".init.data") == 0) &&
713 (strncmp(fromsec, ".text", strlen(".text")) == 0) &&
714 (strncmp(refsymname, "logo_", strlen("logo_")) == 0))
720 * Find symbol based on relocation record info.
721 * In some cases the symbol supplied is a valid symbol so
722 * return refsym. If st_name != 0 we assume this is a valid symbol.
723 * In other cases the symbol needs to be looked up in the symbol table
724 * based on section and address.
726 static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf_Addr addr,
731 if (relsym->st_name != 0)
733 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
734 if (sym->st_shndx != relsym->st_shndx)
736 if (sym->st_value == addr)
742 static inline int is_arm_mapping_symbol(const char *str)
744 return str[0] == '$' && strchr("atd", str[1])
745 && (str[2] == '\0' || str[2] == '.');
749 * If there's no name there, ignore it; likewise, ignore it if it's
750 * one of the magic symbols emitted used by current ARM tools.
752 * Otherwise if find_symbols_between() returns those symbols, they'll
753 * fail the whitelist tests and cause lots of false alarms ... fixable
754 * only by merging __exit and __init sections into __text, bloating
755 * the kernel (which is especially evil on embedded platforms).
757 static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
759 const char *name = elf->strtab + sym->st_name;
761 if (!name || !strlen(name))
763 return !is_arm_mapping_symbol(name);
767 * Find symbols before or equal addr and after addr - in the section sec.
768 * If we find two symbols with equal offset prefer one with a valid name.
769 * The ELF format may have a better way to detect what type of symbol
770 * it is, but this works for now.
772 static void find_symbols_between(struct elf_info *elf, Elf_Addr addr,
774 Elf_Sym **before, Elf_Sym **after)
777 Elf_Ehdr *hdr = elf->hdr;
778 Elf_Addr beforediff = ~0;
779 Elf_Addr afterdiff = ~0;
780 const char *secstrings = (void *)hdr +
781 elf->sechdrs[hdr->e_shstrndx].sh_offset;
786 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
789 if (sym->st_shndx >= SHN_LORESERVE)
791 symsec = secstrings + elf->sechdrs[sym->st_shndx].sh_name;
792 if (strcmp(symsec, sec) != 0)
794 if (!is_valid_name(elf, sym))
796 if (sym->st_value <= addr) {
797 if ((addr - sym->st_value) < beforediff) {
798 beforediff = addr - sym->st_value;
801 else if ((addr - sym->st_value) == beforediff) {
807 if ((sym->st_value - addr) < afterdiff) {
808 afterdiff = sym->st_value - addr;
811 else if ((sym->st_value - addr) == afterdiff) {
819 * Print a warning about a section mismatch.
820 * Try to find symbols near it so user can find it.
821 * Check whitelist before warning - it may be a false positive.
823 static void warn_sec_mismatch(const char *modname, const char *fromsec,
824 struct elf_info *elf, Elf_Sym *sym, Elf_Rela r)
826 const char *refsymname = "";
827 Elf_Sym *before, *after;
829 Elf_Ehdr *hdr = elf->hdr;
830 Elf_Shdr *sechdrs = elf->sechdrs;
831 const char *secstrings = (void *)hdr +
832 sechdrs[hdr->e_shstrndx].sh_offset;
833 const char *secname = secstrings + sechdrs[sym->st_shndx].sh_name;
835 find_symbols_between(elf, r.r_offset, fromsec, &before, &after);
837 refsym = find_elf_symbol(elf, r.r_addend, sym);
838 if (refsym && strlen(elf->strtab + refsym->st_name))
839 refsymname = elf->strtab + refsym->st_name;
841 /* check whitelist - we may ignore it */
843 secref_whitelist(modname, secname, fromsec,
844 elf->strtab + before->st_name, refsymname))
847 if (before && after) {
848 warn("%s - Section mismatch: reference to %s:%s from %s "
849 "between '%s' (at offset 0x%llx) and '%s'\n",
850 modname, secname, refsymname, fromsec,
851 elf->strtab + before->st_name,
852 (long long)r.r_offset,
853 elf->strtab + after->st_name);
855 warn("%s - Section mismatch: reference to %s:%s from %s "
856 "after '%s' (at offset 0x%llx)\n",
857 modname, secname, refsymname, fromsec,
858 elf->strtab + before->st_name,
859 (long long)r.r_offset);
861 warn("%s - Section mismatch: reference to %s:%s from %s "
862 "before '%s' (at offset -0x%llx)\n",
863 modname, secname, refsymname, fromsec,
864 elf->strtab + after->st_name,
865 (long long)r.r_offset);
867 warn("%s - Section mismatch: reference to %s:%s from %s "
869 modname, secname, fromsec, refsymname,
870 (long long)r.r_offset);
875 * A module includes a number of sections that are discarded
876 * either when loaded or when used as built-in.
877 * For loaded modules all functions marked __init and all data
878 * marked __initdata will be discarded when the module has been intialized.
879 * Likewise for modules used built-in the sections marked __exit
880 * are discarded because __exit marked function are supposed to be called
881 * only when a moduel is unloaded which never happes for built-in modules.
882 * The check_sec_ref() function traverses all relocation records
883 * to find all references to a section that reference a section that will
884 * be discarded and warns about it.
886 static void check_sec_ref(struct module *mod, const char *modname,
887 struct elf_info *elf,
888 int section(const char*),
889 int section_ref_ok(const char *))
893 Elf_Ehdr *hdr = elf->hdr;
894 Elf_Shdr *sechdrs = elf->sechdrs;
895 const char *secstrings = (void *)hdr +
896 sechdrs[hdr->e_shstrndx].sh_offset;
898 /* Walk through all sections */
899 for (i = 0; i < hdr->e_shnum; i++) {
900 const char *name = secstrings + sechdrs[i].sh_name;
904 /* We want to process only relocation sections and not .init */
905 if (sechdrs[i].sh_type == SHT_RELA) {
907 Elf_Rela *start = (void *)hdr + sechdrs[i].sh_offset;
908 Elf_Rela *stop = (void*)start + sechdrs[i].sh_size;
909 name += strlen(".rela");
910 if (section_ref_ok(name))
913 for (rela = start; rela < stop; rela++) {
914 r.r_offset = TO_NATIVE(rela->r_offset);
915 #if KERNEL_ELFCLASS == ELFCLASS64
916 if (hdr->e_machine == EM_MIPS) {
917 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
918 r_sym = TO_NATIVE(r_sym);
920 r.r_info = TO_NATIVE(rela->r_info);
921 r_sym = ELF_R_SYM(r.r_info);
924 r.r_info = TO_NATIVE(rela->r_info);
925 r_sym = ELF_R_SYM(r.r_info);
927 r.r_addend = TO_NATIVE(rela->r_addend);
928 sym = elf->symtab_start + r_sym;
929 /* Skip special sections */
930 if (sym->st_shndx >= SHN_LORESERVE)
933 secname = secstrings +
934 sechdrs[sym->st_shndx].sh_name;
935 if (section(secname))
936 warn_sec_mismatch(modname, name,
939 } else if (sechdrs[i].sh_type == SHT_REL) {
941 Elf_Rel *start = (void *)hdr + sechdrs[i].sh_offset;
942 Elf_Rel *stop = (void*)start + sechdrs[i].sh_size;
943 name += strlen(".rel");
944 if (section_ref_ok(name))
947 for (rel = start; rel < stop; rel++) {
948 r.r_offset = TO_NATIVE(rel->r_offset);
949 #if KERNEL_ELFCLASS == ELFCLASS64
950 if (hdr->e_machine == EM_MIPS) {
951 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
952 r_sym = TO_NATIVE(r_sym);
954 r.r_info = TO_NATIVE(rel->r_info);
955 r_sym = ELF_R_SYM(r.r_info);
958 r.r_info = TO_NATIVE(rel->r_info);
959 r_sym = ELF_R_SYM(r.r_info);
962 sym = elf->symtab_start + r_sym;
963 /* Skip special sections */
964 if (sym->st_shndx >= SHN_LORESERVE)
967 secname = secstrings +
968 sechdrs[sym->st_shndx].sh_name;
969 if (section(secname))
970 warn_sec_mismatch(modname, name,
978 * Functions used only during module init is marked __init and is stored in
979 * a .init.text section. Likewise data is marked __initdata and stored in
980 * a .init.data section.
981 * If this section is one of these sections return 1
982 * See include/linux/init.h for the details
984 static int init_section(const char *name)
986 if (strcmp(name, ".init") == 0)
988 if (strncmp(name, ".init.", strlen(".init.")) == 0)
994 * Identify sections from which references to a .init section is OK.
996 * Unfortunately references to read only data that referenced .init
997 * sections had to be excluded. Almost all of these are false
998 * positives, they are created by gcc. The downside of excluding rodata
999 * is that there really are some user references from rodata to
1000 * init code, e.g. drivers/video/vgacon.c:
1002 * const struct consw vga_con = {
1003 * con_startup: vgacon_startup,
1005 * where vgacon_startup is __init. If you want to wade through the false
1006 * positives, take out the check for rodata.
1008 static int init_section_ref_ok(const char *name)
1011 /* Absolute section names */
1012 const char *namelist1[] = {
1014 ".opd", /* see comment [OPD] at exit_section_ref_ok() */
1015 ".toc1", /* used by ppc64 */
1017 ".data.rel.ro", /* used by parisc64 */
1018 ".parainstructions",
1020 "__bug_table", /* used by powerpc for BUG() */
1021 ".pci_fixup_header",
1028 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
1029 "__ftr_fixup", /* powerpc cpu feature fixup */
1030 "__fw_ftr_fixup", /* powerpc firmware feature fixup */
1033 /* Start of section names */
1034 const char *namelist2[] = {
1039 ".parainstructions",
1043 /* part of section name */
1044 const char *namelist3 [] = {
1045 ".unwind", /* sample: IA_64.unwind.init.text */
1049 for (s = namelist1; *s; s++)
1050 if (strcmp(*s, name) == 0)
1052 for (s = namelist2; *s; s++)
1053 if (strncmp(*s, name, strlen(*s)) == 0)
1055 for (s = namelist3; *s; s++)
1056 if (strstr(name, *s) != NULL)
1058 if (strrcmp(name, ".init") == 0)
1064 * Functions used only during module exit is marked __exit and is stored in
1065 * a .exit.text section. Likewise data is marked __exitdata and stored in
1066 * a .exit.data section.
1067 * If this section is one of these sections return 1
1068 * See include/linux/init.h for the details
1070 static int exit_section(const char *name)
1072 if (strcmp(name, ".exit.text") == 0)
1074 if (strcmp(name, ".exit.data") == 0)
1081 * Identify sections from which references to a .exit section is OK.
1083 * [OPD] Keith Ownes <kaos@sgi.com> commented:
1084 * For our future {in}sanity, add a comment that this is the ppc .opd
1085 * section, not the ia64 .opd section.
1086 * ia64 .opd should not point to discarded sections.
1087 * [.rodata] like for .init.text we ignore .rodata references -same reason
1089 static int exit_section_ref_ok(const char *name)
1092 /* Absolute section names */
1093 const char *namelist1[] = {
1098 ".opd", /* See comment [OPD] */
1099 ".toc1", /* used by ppc64 */
1102 "__bug_table", /* used by powerpc for BUG() */
1105 ".parainstructions",
1110 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
1113 /* Start of section names */
1114 const char *namelist2[] = {
1118 /* part of section name */
1119 const char *namelist3 [] = {
1120 ".unwind", /* Sample: IA_64.unwind.exit.text */
1124 for (s = namelist1; *s; s++)
1125 if (strcmp(*s, name) == 0)
1127 for (s = namelist2; *s; s++)
1128 if (strncmp(*s, name, strlen(*s)) == 0)
1130 for (s = namelist3; *s; s++)
1131 if (strstr(name, *s) != NULL)
1136 static void read_symbols(char *modname)
1138 const char *symname;
1142 struct elf_info info = { };
1145 if (!parse_elf(&info, modname))
1148 mod = new_module(modname);
1150 /* When there's no vmlinux, don't print warnings about
1151 * unresolved symbols (since there'll be too many ;) */
1152 if (is_vmlinux(modname)) {
1157 license = get_modinfo(info.modinfo, info.modinfo_len, "license");
1159 if (license_is_gpl_compatible(license))
1160 mod->gpl_compatible = 1;
1162 mod->gpl_compatible = 0;
1165 license = get_next_modinfo(info.modinfo, info.modinfo_len,
1166 "license", license);
1169 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
1170 symname = info.strtab + sym->st_name;
1172 handle_modversions(mod, &info, sym, symname);
1173 handle_moddevtable(mod, &info, sym, symname);
1175 check_sec_ref(mod, modname, &info, init_section, init_section_ref_ok);
1176 check_sec_ref(mod, modname, &info, exit_section, exit_section_ref_ok);
1178 version = get_modinfo(info.modinfo, info.modinfo_len, "version");
1180 maybe_frob_rcs_version(modname, version, info.modinfo,
1181 version - (char *)info.hdr);
1182 if (version || (all_versions && !is_vmlinux(modname)))
1183 get_src_version(modname, mod->srcversion,
1184 sizeof(mod->srcversion)-1);
1186 parse_elf_finish(&info);
1188 /* Our trick to get versioning for struct_module - it's
1189 * never passed as an argument to an exported function, so
1190 * the automatic versioning doesn't pick it up, but it's really
1191 * important anyhow */
1193 mod->unres = alloc_symbol("struct_module", 0, mod->unres);
1198 /* We first write the generated file into memory using the
1199 * following helper, then compare to the file on disk and
1200 * only update the later if anything changed */
1202 void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
1203 const char *fmt, ...)
1210 len = vsnprintf(tmp, SZ, fmt, ap);
1211 buf_write(buf, tmp, len);
1215 void buf_write(struct buffer *buf, const char *s, int len)
1217 if (buf->size - buf->pos < len) {
1218 buf->size += len + SZ;
1219 buf->p = realloc(buf->p, buf->size);
1221 strncpy(buf->p + buf->pos, s, len);
1225 static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
1227 const char *e = is_vmlinux(m) ?"":".ko";
1231 fatal("modpost: GPL-incompatible module %s%s "
1232 "uses GPL-only symbol '%s'\n", m, e, s);
1234 case export_unused_gpl:
1235 fatal("modpost: GPL-incompatible module %s%s "
1236 "uses GPL-only symbol marked UNUSED '%s'\n", m, e, s);
1238 case export_gpl_future:
1239 warn("modpost: GPL-incompatible module %s%s "
1240 "uses future GPL-only symbol '%s'\n", m, e, s);
1244 case export_unknown:
1250 static void check_for_unused(enum export exp, const char* m, const char* s)
1252 const char *e = is_vmlinux(m) ?"":".ko";
1256 case export_unused_gpl:
1257 warn("modpost: module %s%s "
1258 "uses symbol '%s' marked UNUSED\n", m, e, s);
1266 static void check_exports(struct module *mod)
1268 struct symbol *s, *exp;
1270 for (s = mod->unres; s; s = s->next) {
1271 const char *basename;
1272 exp = find_symbol(s->name);
1273 if (!exp || exp->module == mod)
1275 basename = strrchr(mod->name, '/');
1279 basename = mod->name;
1280 if (!mod->gpl_compatible)
1281 check_for_gpl_usage(exp->export, basename, exp->name);
1282 check_for_unused(exp->export, basename, exp->name);
1287 * Header for the generated file
1289 static void add_header(struct buffer *b, struct module *mod)
1291 buf_printf(b, "#include <linux/module.h>\n");
1292 buf_printf(b, "#include <linux/vermagic.h>\n");
1293 buf_printf(b, "#include <linux/compiler.h>\n");
1294 buf_printf(b, "\n");
1295 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
1296 buf_printf(b, "\n");
1297 buf_printf(b, "struct module __this_module\n");
1298 buf_printf(b, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
1299 buf_printf(b, " .name = KBUILD_MODNAME,\n");
1301 buf_printf(b, " .init = init_module,\n");
1302 if (mod->has_cleanup)
1303 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
1304 " .exit = cleanup_module,\n"
1306 buf_printf(b, "};\n");
1310 * Record CRCs for unresolved symbols
1312 static int add_versions(struct buffer *b, struct module *mod)
1314 struct symbol *s, *exp;
1317 for (s = mod->unres; s; s = s->next) {
1318 exp = find_symbol(s->name);
1319 if (!exp || exp->module == mod) {
1320 if (have_vmlinux && !s->weak) {
1321 if (warn_unresolved) {
1322 warn("\"%s\" [%s.ko] undefined!\n",
1323 s->name, mod->name);
1325 merror("\"%s\" [%s.ko] undefined!\n",
1326 s->name, mod->name);
1332 s->module = exp->module;
1333 s->crc_valid = exp->crc_valid;
1340 buf_printf(b, "\n");
1341 buf_printf(b, "static const struct modversion_info ____versions[]\n");
1342 buf_printf(b, "__attribute_used__\n");
1343 buf_printf(b, "__attribute__((section(\"__versions\"))) = {\n");
1345 for (s = mod->unres; s; s = s->next) {
1349 if (!s->crc_valid) {
1350 warn("\"%s\" [%s.ko] has no CRC!\n",
1351 s->name, mod->name);
1354 buf_printf(b, "\t{ %#8x, \"%s\" },\n", s->crc, s->name);
1357 buf_printf(b, "};\n");
1362 static void add_depends(struct buffer *b, struct module *mod,
1363 struct module *modules)
1369 for (m = modules; m; m = m->next) {
1370 m->seen = is_vmlinux(m->name);
1373 buf_printf(b, "\n");
1374 buf_printf(b, "static const char __module_depends[]\n");
1375 buf_printf(b, "__attribute_used__\n");
1376 buf_printf(b, "__attribute__((section(\".modinfo\"))) =\n");
1377 buf_printf(b, "\"depends=");
1378 for (s = mod->unres; s; s = s->next) {
1383 if (s->module->seen)
1386 s->module->seen = 1;
1387 if ((p = strrchr(s->module->name, '/')) != NULL)
1390 p = s->module->name;
1391 buf_printf(b, "%s%s", first ? "" : ",", p);
1394 buf_printf(b, "\";\n");
1397 static void add_srcversion(struct buffer *b, struct module *mod)
1399 if (mod->srcversion[0]) {
1400 buf_printf(b, "\n");
1401 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
1406 static void write_if_changed(struct buffer *b, const char *fname)
1412 file = fopen(fname, "r");
1416 if (fstat(fileno(file), &st) < 0)
1419 if (st.st_size != b->pos)
1422 tmp = NOFAIL(malloc(b->pos));
1423 if (fread(tmp, 1, b->pos, file) != b->pos)
1426 if (memcmp(tmp, b->p, b->pos) != 0)
1438 file = fopen(fname, "w");
1443 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
1450 /* parse Module.symvers file. line format:
1451 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
1453 static void read_dump(const char *fname, unsigned int kernel)
1455 unsigned long size, pos = 0;
1456 void *file = grab_file(fname, &size);
1460 /* No symbol versions, silently ignore */
1463 while ((line = get_next_line(&pos, file, size))) {
1464 char *symname, *modname, *d, *export, *end;
1469 if (!(symname = strchr(line, '\t')))
1472 if (!(modname = strchr(symname, '\t')))
1475 if ((export = strchr(modname, '\t')) != NULL)
1477 if (export && ((end = strchr(export, '\t')) != NULL))
1479 crc = strtoul(line, &d, 16);
1480 if (*symname == '\0' || *modname == '\0' || *d != '\0')
1483 if (!(mod = find_module(modname))) {
1484 if (is_vmlinux(modname)) {
1487 mod = new_module(NOFAIL(strdup(modname)));
1490 s = sym_add_exported(symname, mod, export_no(export));
1493 sym_update_crc(symname, mod, crc, export_no(export));
1497 fatal("parse error in symbol dump file\n");
1500 /* For normal builds always dump all symbols.
1501 * For external modules only dump symbols
1502 * that are not read from kernel Module.symvers.
1504 static int dump_sym(struct symbol *sym)
1506 if (!external_module)
1508 if (sym->vmlinux || sym->kernel)
1513 static void write_dump(const char *fname)
1515 struct buffer buf = { };
1516 struct symbol *symbol;
1519 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
1520 symbol = symbolhash[n];
1522 if (dump_sym(symbol))
1523 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\n",
1524 symbol->crc, symbol->name,
1525 symbol->module->name,
1526 export_str(symbol->export));
1527 symbol = symbol->next;
1530 write_if_changed(&buf, fname);
1533 int main(int argc, char **argv)
1536 struct buffer buf = { };
1538 char *kernel_read = NULL, *module_read = NULL;
1539 char *dump_write = NULL;
1543 while ((opt = getopt(argc, argv, "i:I:mo:aw")) != -1) {
1546 kernel_read = optarg;
1549 module_read = optarg;
1550 external_module = 1;
1556 dump_write = optarg;
1562 warn_unresolved = 1;
1570 read_dump(kernel_read, 1);
1572 read_dump(module_read, 0);
1574 while (optind < argc) {
1575 read_symbols(argv[optind++]);
1578 for (mod = modules; mod; mod = mod->next) {
1586 for (mod = modules; mod; mod = mod->next) {
1592 add_header(&buf, mod);
1593 err |= add_versions(&buf, mod);
1594 add_depends(&buf, mod, modules);
1595 add_moddevtable(&buf, mod);
1596 add_srcversion(&buf, mod);
1598 sprintf(fname, "%s.mod.c", mod->name);
1599 write_if_changed(&buf, fname);
1603 write_dump(dump_write);