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 /* How a symbol is exported */
28 export_plain
, export_unused
, export_gpl
,
29 export_unused_gpl
, export_gpl_future
, export_unknown
32 void fatal(const char *fmt
, ...)
36 fprintf(stderr
, "FATAL: ");
38 va_start(arglist
, fmt
);
39 vfprintf(stderr
, fmt
, arglist
);
45 void warn(const char *fmt
, ...)
49 fprintf(stderr
, "WARNING: ");
51 va_start(arglist
, fmt
);
52 vfprintf(stderr
, fmt
, arglist
);
56 static int is_vmlinux(const char *modname
)
60 if ((myname
= strrchr(modname
, '/')))
65 return strcmp(myname
, "vmlinux") == 0;
68 void *do_nofail(void *ptr
, const char *expr
)
71 fatal("modpost: Memory allocation failure: %s.\n", expr
);
76 /* A list of all modules we processed */
78 static struct module
*modules
;
80 static struct module
*find_module(char *modname
)
84 for (mod
= modules
; mod
; mod
= mod
->next
)
85 if (strcmp(mod
->name
, modname
) == 0)
90 static struct module
*new_module(char *modname
)
95 mod
= NOFAIL(malloc(sizeof(*mod
)));
96 memset(mod
, 0, sizeof(*mod
));
97 p
= NOFAIL(strdup(modname
));
99 /* strip trailing .o */
100 if ((s
= strrchr(p
, '.')) != NULL
)
101 if (strcmp(s
, ".o") == 0)
106 mod
->gpl_compatible
= -1;
113 /* A hash of all exported symbols,
114 * struct symbol is also used for lists of unresolved symbols */
116 #define SYMBOL_HASH_SIZE 1024
120 struct module
*module
;
124 unsigned int vmlinux
:1; /* 1 if symbol is defined in vmlinux */
125 unsigned int kernel
:1; /* 1 if symbol is from kernel
126 * (only for external modules) **/
127 unsigned int preloaded
:1; /* 1 if symbol from Module.symvers */
128 enum export export
; /* Type of export */
132 static struct symbol
*symbolhash
[SYMBOL_HASH_SIZE
];
134 /* This is based on the hash agorithm from gdbm, via tdb */
135 static inline unsigned int tdb_hash(const char *name
)
137 unsigned value
; /* Used to compute the hash value. */
138 unsigned i
; /* Used to cycle through random values. */
140 /* Set the initial value from the key size. */
141 for (value
= 0x238F13AF * strlen(name
), i
=0; name
[i
]; i
++)
142 value
= (value
+ (((unsigned char *)name
)[i
] << (i
*5 % 24)));
144 return (1103515243 * value
+ 12345);
148 * Allocate a new symbols for use in the hash of exported symbols or
149 * the list of unresolved symbols per module
151 static struct symbol
*alloc_symbol(const char *name
, unsigned int weak
,
154 struct symbol
*s
= NOFAIL(malloc(sizeof(*s
) + strlen(name
) + 1));
156 memset(s
, 0, sizeof(*s
));
157 strcpy(s
->name
, name
);
163 /* For the hash of exported symbols */
164 static struct symbol
*new_symbol(const char *name
, struct module
*module
,
170 hash
= tdb_hash(name
) % SYMBOL_HASH_SIZE
;
171 new = symbolhash
[hash
] = alloc_symbol(name
, 0, symbolhash
[hash
]);
172 new->module
= module
;
173 new->export
= export
;
177 static struct symbol
*find_symbol(const char *name
)
181 /* For our purposes, .foo matches foo. PPC64 needs this. */
185 for (s
= symbolhash
[tdb_hash(name
) % SYMBOL_HASH_SIZE
]; s
; s
=s
->next
) {
186 if (strcmp(s
->name
, name
) == 0)
196 { .str
= "EXPORT_SYMBOL", .export
= export_plain
},
197 { .str
= "EXPORT_UNUSED_SYMBOL", .export
= export_unused
},
198 { .str
= "EXPORT_SYMBOL_GPL", .export
= export_gpl
},
199 { .str
= "EXPORT_UNUSED_SYMBOL_GPL", .export
= export_unused_gpl
},
200 { .str
= "EXPORT_SYMBOL_GPL_FUTURE", .export
= export_gpl_future
},
201 { .str
= "(unknown)", .export
= export_unknown
},
205 static const char *export_str(enum export ex
)
207 return export_list
[ex
].str
;
210 static enum export
export_no(const char * s
)
214 return export_unknown
;
215 for (i
= 0; export_list
[i
].export
!= export_unknown
; i
++) {
216 if (strcmp(export_list
[i
].str
, s
) == 0)
217 return export_list
[i
].export
;
219 return export_unknown
;
222 static enum export
export_from_sec(struct elf_info
*elf
, Elf_Section sec
)
224 if (sec
== elf
->export_sec
)
226 else if (sec
== elf
->export_unused_sec
)
227 return export_unused
;
228 else if (sec
== elf
->export_gpl_sec
)
230 else if (sec
== elf
->export_unused_gpl_sec
)
231 return export_unused_gpl
;
232 else if (sec
== elf
->export_gpl_future_sec
)
233 return export_gpl_future
;
235 return export_unknown
;
239 * Add an exported symbol - it may have already been added without a
240 * CRC, in this case just update the CRC
242 static struct symbol
*sym_add_exported(const char *name
, struct module
*mod
,
245 struct symbol
*s
= find_symbol(name
);
248 s
= new_symbol(name
, mod
, export
);
251 warn("%s: '%s' exported twice. Previous export "
252 "was in %s%s\n", mod
->name
, name
,
254 is_vmlinux(s
->module
->name
) ?"":".ko");
258 s
->vmlinux
= is_vmlinux(mod
->name
);
264 static void sym_update_crc(const char *name
, struct module
*mod
,
265 unsigned int crc
, enum export export
)
267 struct symbol
*s
= find_symbol(name
);
270 s
= new_symbol(name
, mod
, export
);
275 void *grab_file(const char *filename
, unsigned long *size
)
281 fd
= open(filename
, O_RDONLY
);
282 if (fd
< 0 || fstat(fd
, &st
) != 0)
286 map
= mmap(NULL
, *size
, PROT_READ
|PROT_WRITE
, MAP_PRIVATE
, fd
, 0);
289 if (map
== MAP_FAILED
)
295 * Return a copy of the next line in a mmap'ed file.
296 * spaces in the beginning of the line is trimmed away.
297 * Return a pointer to a static buffer.
299 char* get_next_line(unsigned long *pos
, void *file
, unsigned long size
)
301 static char line
[4096];
304 signed char *p
= (signed char *)file
+ *pos
;
307 for (; *pos
< size
; (*pos
)++)
309 if (skip
&& isspace(*p
)) {
314 if (*p
!= '\n' && (*pos
< size
)) {
318 break; /* Too long, stop */
329 void release_file(void *file
, unsigned long size
)
334 static void parse_elf(struct elf_info
*info
, const char *filename
)
337 Elf_Ehdr
*hdr
= info
->hdr
;
341 hdr
= grab_file(filename
, &info
->size
);
347 if (info
->size
< sizeof(*hdr
))
350 /* Fix endianness in ELF header */
351 hdr
->e_shoff
= TO_NATIVE(hdr
->e_shoff
);
352 hdr
->e_shstrndx
= TO_NATIVE(hdr
->e_shstrndx
);
353 hdr
->e_shnum
= TO_NATIVE(hdr
->e_shnum
);
354 hdr
->e_machine
= TO_NATIVE(hdr
->e_machine
);
355 sechdrs
= (void *)hdr
+ hdr
->e_shoff
;
356 info
->sechdrs
= sechdrs
;
358 /* Fix endianness in section headers */
359 for (i
= 0; i
< hdr
->e_shnum
; i
++) {
360 sechdrs
[i
].sh_type
= TO_NATIVE(sechdrs
[i
].sh_type
);
361 sechdrs
[i
].sh_offset
= TO_NATIVE(sechdrs
[i
].sh_offset
);
362 sechdrs
[i
].sh_size
= TO_NATIVE(sechdrs
[i
].sh_size
);
363 sechdrs
[i
].sh_link
= TO_NATIVE(sechdrs
[i
].sh_link
);
364 sechdrs
[i
].sh_name
= TO_NATIVE(sechdrs
[i
].sh_name
);
366 /* Find symbol table. */
367 for (i
= 1; i
< hdr
->e_shnum
; i
++) {
368 const char *secstrings
369 = (void *)hdr
+ sechdrs
[hdr
->e_shstrndx
].sh_offset
;
372 if (sechdrs
[i
].sh_offset
> info
->size
)
374 secname
= secstrings
+ sechdrs
[i
].sh_name
;
375 if (strcmp(secname
, ".modinfo") == 0) {
376 info
->modinfo
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
377 info
->modinfo_len
= sechdrs
[i
].sh_size
;
378 } else if (strcmp(secname
, "__ksymtab") == 0)
379 info
->export_sec
= i
;
380 else if (strcmp(secname
, "__ksymtab_unused") == 0)
381 info
->export_unused_sec
= i
;
382 else if (strcmp(secname
, "__ksymtab_gpl") == 0)
383 info
->export_gpl_sec
= i
;
384 else if (strcmp(secname
, "__ksymtab_unused_gpl") == 0)
385 info
->export_unused_gpl_sec
= i
;
386 else if (strcmp(secname
, "__ksymtab_gpl_future") == 0)
387 info
->export_gpl_future_sec
= i
;
389 if (sechdrs
[i
].sh_type
!= SHT_SYMTAB
)
392 info
->symtab_start
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
393 info
->symtab_stop
= (void *)hdr
+ sechdrs
[i
].sh_offset
394 + sechdrs
[i
].sh_size
;
395 info
->strtab
= (void *)hdr
+
396 sechdrs
[sechdrs
[i
].sh_link
].sh_offset
;
398 if (!info
->symtab_start
) {
399 fatal("%s has no symtab?\n", filename
);
401 /* Fix endianness in symbols */
402 for (sym
= info
->symtab_start
; sym
< info
->symtab_stop
; sym
++) {
403 sym
->st_shndx
= TO_NATIVE(sym
->st_shndx
);
404 sym
->st_name
= TO_NATIVE(sym
->st_name
);
405 sym
->st_value
= TO_NATIVE(sym
->st_value
);
406 sym
->st_size
= TO_NATIVE(sym
->st_size
);
411 fatal("%s is truncated.\n", filename
);
414 static void parse_elf_finish(struct elf_info
*info
)
416 release_file(info
->hdr
, info
->size
);
419 #define CRC_PFX MODULE_SYMBOL_PREFIX "__crc_"
420 #define KSYMTAB_PFX MODULE_SYMBOL_PREFIX "__ksymtab_"
422 static void handle_modversions(struct module
*mod
, struct elf_info
*info
,
423 Elf_Sym
*sym
, const char *symname
)
426 enum export export
= export_from_sec(info
, sym
->st_shndx
);
428 switch (sym
->st_shndx
) {
430 warn("\"%s\" [%s] is COMMON symbol\n", symname
, mod
->name
);
434 if (memcmp(symname
, CRC_PFX
, strlen(CRC_PFX
)) == 0) {
435 crc
= (unsigned int) sym
->st_value
;
436 sym_update_crc(symname
+ strlen(CRC_PFX
), mod
, crc
,
441 /* undefined symbol */
442 if (ELF_ST_BIND(sym
->st_info
) != STB_GLOBAL
&&
443 ELF_ST_BIND(sym
->st_info
) != STB_WEAK
)
445 /* ignore global offset table */
446 if (strcmp(symname
, "_GLOBAL_OFFSET_TABLE_") == 0)
448 /* ignore __this_module, it will be resolved shortly */
449 if (strcmp(symname
, MODULE_SYMBOL_PREFIX
"__this_module") == 0)
451 /* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
452 #if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
453 /* add compatibility with older glibc */
454 #ifndef STT_SPARC_REGISTER
455 #define STT_SPARC_REGISTER STT_REGISTER
457 if (info
->hdr
->e_machine
== EM_SPARC
||
458 info
->hdr
->e_machine
== EM_SPARCV9
) {
459 /* Ignore register directives. */
460 if (ELF_ST_TYPE(sym
->st_info
) == STT_SPARC_REGISTER
)
462 if (symname
[0] == '.') {
463 char *munged
= strdup(symname
);
465 munged
[1] = toupper(munged
[1]);
471 if (memcmp(symname
, MODULE_SYMBOL_PREFIX
,
472 strlen(MODULE_SYMBOL_PREFIX
)) == 0)
473 mod
->unres
= alloc_symbol(symname
+
474 strlen(MODULE_SYMBOL_PREFIX
),
475 ELF_ST_BIND(sym
->st_info
) == STB_WEAK
,
479 /* All exported symbols */
480 if (memcmp(symname
, KSYMTAB_PFX
, strlen(KSYMTAB_PFX
)) == 0) {
481 sym_add_exported(symname
+ strlen(KSYMTAB_PFX
), mod
,
484 if (strcmp(symname
, MODULE_SYMBOL_PREFIX
"init_module") == 0)
486 if (strcmp(symname
, MODULE_SYMBOL_PREFIX
"cleanup_module") == 0)
487 mod
->has_cleanup
= 1;
493 * Parse tag=value strings from .modinfo section
495 static char *next_string(char *string
, unsigned long *secsize
)
497 /* Skip non-zero chars */
500 if ((*secsize
)-- <= 1)
504 /* Skip any zero padding. */
507 if ((*secsize
)-- <= 1)
513 static char *get_next_modinfo(void *modinfo
, unsigned long modinfo_len
,
514 const char *tag
, char *info
)
517 unsigned int taglen
= strlen(tag
);
518 unsigned long size
= modinfo_len
;
521 size
-= info
- (char *)modinfo
;
522 modinfo
= next_string(info
, &size
);
525 for (p
= modinfo
; p
; p
= next_string(p
, &size
)) {
526 if (strncmp(p
, tag
, taglen
) == 0 && p
[taglen
] == '=')
527 return p
+ taglen
+ 1;
532 static char *get_modinfo(void *modinfo
, unsigned long modinfo_len
,
536 return get_next_modinfo(modinfo
, modinfo_len
, tag
, NULL
);
540 * Test if string s ends in string sub
543 static int strrcmp(const char *s
, const char *sub
)
551 sublen
= strlen(sub
);
553 if ((slen
== 0) || (sublen
== 0))
559 return memcmp(s
+ slen
- sublen
, sub
, sublen
);
563 * Whitelist to allow certain references to pass with no warning.
565 * If a module parameter is declared __initdata and permissions=0
566 * then this is legal despite the warning generated.
567 * We cannot see value of permissions here, so just ignore
569 * The pattern is identified by:
575 * Many drivers utilise a *driver container with references to
576 * add, remove, probe functions etc.
577 * These functions may often be marked __init and we do not want to
579 * the pattern is identified by:
580 * tosec = .init.text | .exit.text | .init.data
582 * atsym = *driver, *_template, *_sht, *_ops, *_probe, *probe_one
584 static int secref_whitelist(const char *modname
, const char *tosec
,
585 const char *fromsec
, const char *atsym
)
589 const char *pat2sym
[] = {
591 "_template", /* scsi uses *_template a lot */
592 "_sht", /* scsi also used *_sht to some extent */
599 /* Check for pattern 1 */
600 if (strcmp(tosec
, ".init.data") != 0)
602 if (strncmp(fromsec
, ".data", strlen(".data")) != 0)
604 if (strncmp(atsym
, "__param", strlen("__param")) != 0)
610 /* Check for pattern 2 */
611 if ((strcmp(tosec
, ".init.text") != 0) &&
612 (strcmp(tosec
, ".exit.text") != 0) &&
613 (strcmp(tosec
, ".init.data") != 0))
615 if (strcmp(fromsec
, ".data") != 0)
618 for (s
= pat2sym
; *s
; s
++)
619 if (strrcmp(atsym
, *s
) == 0)
624 /* Whitelist all references from .pci_fixup section if vmlinux */
625 if (is_vmlinux(modname
)) {
626 if ((strcmp(fromsec
, ".pci_fixup") == 0) &&
627 (strcmp(tosec
, ".init.text") == 0))
634 * Find symbol based on relocation record info.
635 * In some cases the symbol supplied is a valid symbol so
636 * return refsym. If st_name != 0 we assume this is a valid symbol.
637 * In other cases the symbol needs to be looked up in the symbol table
638 * based on section and address.
640 static Elf_Sym
*find_elf_symbol(struct elf_info
*elf
, Elf_Addr addr
,
645 if (relsym
->st_name
!= 0)
647 for (sym
= elf
->symtab_start
; sym
< elf
->symtab_stop
; sym
++) {
648 if (sym
->st_shndx
!= relsym
->st_shndx
)
650 if (sym
->st_value
== addr
)
657 * Find symbols before or equal addr and after addr - in the section sec.
658 * If we find two symbols with equal offset prefer one with a valid name.
659 * The ELF format may have a better way to detect what type of symbol
660 * it is, but this works for now.
662 static void find_symbols_between(struct elf_info
*elf
, Elf_Addr addr
,
664 Elf_Sym
**before
, Elf_Sym
**after
)
667 Elf_Ehdr
*hdr
= elf
->hdr
;
668 Elf_Addr beforediff
= ~0;
669 Elf_Addr afterdiff
= ~0;
670 const char *secstrings
= (void *)hdr
+
671 elf
->sechdrs
[hdr
->e_shstrndx
].sh_offset
;
676 for (sym
= elf
->symtab_start
; sym
< elf
->symtab_stop
; sym
++) {
679 if (sym
->st_shndx
>= SHN_LORESERVE
)
681 symsec
= secstrings
+ elf
->sechdrs
[sym
->st_shndx
].sh_name
;
682 if (strcmp(symsec
, sec
) != 0)
684 if (sym
->st_value
<= addr
) {
685 if ((addr
- sym
->st_value
) < beforediff
) {
686 beforediff
= addr
- sym
->st_value
;
689 else if ((addr
- sym
->st_value
) == beforediff
) {
690 /* equal offset, valid name? */
691 const char *name
= elf
->strtab
+ sym
->st_name
;
692 if (name
&& strlen(name
))
698 if ((sym
->st_value
- addr
) < afterdiff
) {
699 afterdiff
= sym
->st_value
- addr
;
702 else if ((sym
->st_value
- addr
) == afterdiff
) {
703 /* equal offset, valid name? */
704 const char *name
= elf
->strtab
+ sym
->st_name
;
705 if (name
&& strlen(name
))
713 * Print a warning about a section mismatch.
714 * Try to find symbols near it so user can find it.
715 * Check whitelist before warning - it may be a false positive.
717 static void warn_sec_mismatch(const char *modname
, const char *fromsec
,
718 struct elf_info
*elf
, Elf_Sym
*sym
, Elf_Rela r
)
720 const char *refsymname
= "";
721 Elf_Sym
*before
, *after
;
723 Elf_Ehdr
*hdr
= elf
->hdr
;
724 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
725 const char *secstrings
= (void *)hdr
+
726 sechdrs
[hdr
->e_shstrndx
].sh_offset
;
727 const char *secname
= secstrings
+ sechdrs
[sym
->st_shndx
].sh_name
;
729 find_symbols_between(elf
, r
.r_offset
, fromsec
, &before
, &after
);
731 refsym
= find_elf_symbol(elf
, r
.r_addend
, sym
);
732 if (refsym
&& strlen(elf
->strtab
+ refsym
->st_name
))
733 refsymname
= elf
->strtab
+ refsym
->st_name
;
735 /* check whitelist - we may ignore it */
737 secref_whitelist(modname
, secname
, fromsec
,
738 elf
->strtab
+ before
->st_name
))
741 if (before
&& after
) {
742 warn("%s - Section mismatch: reference to %s:%s from %s "
743 "between '%s' (at offset 0x%llx) and '%s'\n",
744 modname
, secname
, refsymname
, fromsec
,
745 elf
->strtab
+ before
->st_name
,
746 (long long)r
.r_offset
,
747 elf
->strtab
+ after
->st_name
);
749 warn("%s - Section mismatch: reference to %s:%s from %s "
750 "after '%s' (at offset 0x%llx)\n",
751 modname
, secname
, refsymname
, fromsec
,
752 elf
->strtab
+ before
->st_name
,
753 (long long)r
.r_offset
);
755 warn("%s - Section mismatch: reference to %s:%s from %s "
756 "before '%s' (at offset -0x%llx)\n",
757 modname
, secname
, refsymname
, fromsec
,
758 elf
->strtab
+ after
->st_name
,
759 (long long)r
.r_offset
);
761 warn("%s - Section mismatch: reference to %s:%s from %s "
763 modname
, secname
, fromsec
, refsymname
,
764 (long long)r
.r_offset
);
769 * A module includes a number of sections that are discarded
770 * either when loaded or when used as built-in.
771 * For loaded modules all functions marked __init and all data
772 * marked __initdata will be discarded when the module has been intialized.
773 * Likewise for modules used built-in the sections marked __exit
774 * are discarded because __exit marked function are supposed to be called
775 * only when a moduel is unloaded which never happes for built-in modules.
776 * The check_sec_ref() function traverses all relocation records
777 * to find all references to a section that reference a section that will
778 * be discarded and warns about it.
780 static void check_sec_ref(struct module
*mod
, const char *modname
,
781 struct elf_info
*elf
,
782 int section(const char*),
783 int section_ref_ok(const char *))
787 Elf_Ehdr
*hdr
= elf
->hdr
;
788 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
789 const char *secstrings
= (void *)hdr
+
790 sechdrs
[hdr
->e_shstrndx
].sh_offset
;
792 /* Walk through all sections */
793 for (i
= 0; i
< hdr
->e_shnum
; i
++) {
794 const char *name
= secstrings
+ sechdrs
[i
].sh_name
;
798 /* We want to process only relocation sections and not .init */
799 if (sechdrs
[i
].sh_type
== SHT_RELA
) {
801 Elf_Rela
*start
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
802 Elf_Rela
*stop
= (void*)start
+ sechdrs
[i
].sh_size
;
803 name
+= strlen(".rela");
804 if (section_ref_ok(name
))
807 for (rela
= start
; rela
< stop
; rela
++) {
808 r
.r_offset
= TO_NATIVE(rela
->r_offset
);
809 #if KERNEL_ELFCLASS == ELFCLASS64
810 if (hdr
->e_machine
== EM_MIPS
) {
811 r_sym
= ELF64_MIPS_R_SYM(rela
->r_info
);
812 r_sym
= TO_NATIVE(r_sym
);
814 r
.r_info
= TO_NATIVE(rela
->r_info
);
815 r_sym
= ELF_R_SYM(r
.r_info
);
818 r
.r_info
= TO_NATIVE(rela
->r_info
);
819 r_sym
= ELF_R_SYM(r
.r_info
);
821 r
.r_addend
= TO_NATIVE(rela
->r_addend
);
822 sym
= elf
->symtab_start
+ r_sym
;
823 /* Skip special sections */
824 if (sym
->st_shndx
>= SHN_LORESERVE
)
827 secname
= secstrings
+
828 sechdrs
[sym
->st_shndx
].sh_name
;
829 if (section(secname
))
830 warn_sec_mismatch(modname
, name
,
833 } else if (sechdrs
[i
].sh_type
== SHT_REL
) {
835 Elf_Rel
*start
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
836 Elf_Rel
*stop
= (void*)start
+ sechdrs
[i
].sh_size
;
837 name
+= strlen(".rel");
838 if (section_ref_ok(name
))
841 for (rel
= start
; rel
< stop
; rel
++) {
842 r
.r_offset
= TO_NATIVE(rel
->r_offset
);
843 #if KERNEL_ELFCLASS == ELFCLASS64
844 if (hdr
->e_machine
== EM_MIPS
) {
845 r_sym
= ELF64_MIPS_R_SYM(rel
->r_info
);
846 r_sym
= TO_NATIVE(r_sym
);
848 r
.r_info
= TO_NATIVE(rel
->r_info
);
849 r_sym
= ELF_R_SYM(r
.r_info
);
852 r
.r_info
= TO_NATIVE(rel
->r_info
);
853 r_sym
= ELF_R_SYM(r
.r_info
);
856 sym
= elf
->symtab_start
+ r_sym
;
857 /* Skip special sections */
858 if (sym
->st_shndx
>= SHN_LORESERVE
)
861 secname
= secstrings
+
862 sechdrs
[sym
->st_shndx
].sh_name
;
863 if (section(secname
))
864 warn_sec_mismatch(modname
, name
,
872 * Functions used only during module init is marked __init and is stored in
873 * a .init.text section. Likewise data is marked __initdata and stored in
874 * a .init.data section.
875 * If this section is one of these sections return 1
876 * See include/linux/init.h for the details
878 static int init_section(const char *name
)
880 if (strcmp(name
, ".init") == 0)
882 if (strncmp(name
, ".init.", strlen(".init.")) == 0)
888 * Identify sections from which references to a .init section is OK.
890 * Unfortunately references to read only data that referenced .init
891 * sections had to be excluded. Almost all of these are false
892 * positives, they are created by gcc. The downside of excluding rodata
893 * is that there really are some user references from rodata to
894 * init code, e.g. drivers/video/vgacon.c:
896 * const struct consw vga_con = {
897 * con_startup: vgacon_startup,
899 * where vgacon_startup is __init. If you want to wade through the false
900 * positives, take out the check for rodata.
902 static int init_section_ref_ok(const char *name
)
905 /* Absolute section names */
906 const char *namelist1
[] = {
908 ".opd", /* see comment [OPD] at exit_section_ref_ok() */
909 ".toc1", /* used by ppc64 */
913 "__bug_table", /* used by powerpc for BUG() */
921 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
924 /* Start of section names */
925 const char *namelist2
[] = {
932 /* part of section name */
933 const char *namelist3
[] = {
934 ".unwind", /* sample: IA_64.unwind.init.text */
938 for (s
= namelist1
; *s
; s
++)
939 if (strcmp(*s
, name
) == 0)
941 for (s
= namelist2
; *s
; s
++)
942 if (strncmp(*s
, name
, strlen(*s
)) == 0)
944 for (s
= namelist3
; *s
; s
++)
945 if (strstr(name
, *s
) != NULL
)
947 if (strrcmp(name
, ".init") == 0)
953 * Functions used only during module exit is marked __exit and is stored in
954 * a .exit.text section. Likewise data is marked __exitdata and stored in
955 * a .exit.data section.
956 * If this section is one of these sections return 1
957 * See include/linux/init.h for the details
959 static int exit_section(const char *name
)
961 if (strcmp(name
, ".exit.text") == 0)
963 if (strcmp(name
, ".exit.data") == 0)
970 * Identify sections from which references to a .exit section is OK.
972 * [OPD] Keith Ownes <kaos@sgi.com> commented:
973 * For our future {in}sanity, add a comment that this is the ppc .opd
974 * section, not the ia64 .opd section.
975 * ia64 .opd should not point to discarded sections.
976 * [.rodata] like for .init.text we ignore .rodata references -same reason
978 static int exit_section_ref_ok(const char *name
)
981 /* Absolute section names */
982 const char *namelist1
[] = {
987 ".opd", /* See comment [OPD] */
988 ".toc1", /* used by ppc64 */
991 "__bug_table", /* used by powerpc for BUG() */
998 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
1001 /* Start of section names */
1002 const char *namelist2
[] = {
1006 /* part of section name */
1007 const char *namelist3
[] = {
1008 ".unwind", /* Sample: IA_64.unwind.exit.text */
1012 for (s
= namelist1
; *s
; s
++)
1013 if (strcmp(*s
, name
) == 0)
1015 for (s
= namelist2
; *s
; s
++)
1016 if (strncmp(*s
, name
, strlen(*s
)) == 0)
1018 for (s
= namelist3
; *s
; s
++)
1019 if (strstr(name
, *s
) != NULL
)
1024 static void read_symbols(char *modname
)
1026 const char *symname
;
1030 struct elf_info info
= { };
1033 parse_elf(&info
, modname
);
1035 mod
= new_module(modname
);
1037 /* When there's no vmlinux, don't print warnings about
1038 * unresolved symbols (since there'll be too many ;) */
1039 if (is_vmlinux(modname
)) {
1044 license
= get_modinfo(info
.modinfo
, info
.modinfo_len
, "license");
1046 if (license_is_gpl_compatible(license
))
1047 mod
->gpl_compatible
= 1;
1049 mod
->gpl_compatible
= 0;
1052 license
= get_next_modinfo(info
.modinfo
, info
.modinfo_len
,
1053 "license", license
);
1056 for (sym
= info
.symtab_start
; sym
< info
.symtab_stop
; sym
++) {
1057 symname
= info
.strtab
+ sym
->st_name
;
1059 handle_modversions(mod
, &info
, sym
, symname
);
1060 handle_moddevtable(mod
, &info
, sym
, symname
);
1062 check_sec_ref(mod
, modname
, &info
, init_section
, init_section_ref_ok
);
1063 check_sec_ref(mod
, modname
, &info
, exit_section
, exit_section_ref_ok
);
1065 version
= get_modinfo(info
.modinfo
, info
.modinfo_len
, "version");
1067 maybe_frob_rcs_version(modname
, version
, info
.modinfo
,
1068 version
- (char *)info
.hdr
);
1069 if (version
|| (all_versions
&& !is_vmlinux(modname
)))
1070 get_src_version(modname
, mod
->srcversion
,
1071 sizeof(mod
->srcversion
)-1);
1073 parse_elf_finish(&info
);
1075 /* Our trick to get versioning for struct_module - it's
1076 * never passed as an argument to an exported function, so
1077 * the automatic versioning doesn't pick it up, but it's really
1078 * important anyhow */
1080 mod
->unres
= alloc_symbol("struct_module", 0, mod
->unres
);
1085 /* We first write the generated file into memory using the
1086 * following helper, then compare to the file on disk and
1087 * only update the later if anything changed */
1089 void __attribute__((format(printf
, 2, 3))) buf_printf(struct buffer
*buf
,
1090 const char *fmt
, ...)
1097 len
= vsnprintf(tmp
, SZ
, fmt
, ap
);
1098 buf_write(buf
, tmp
, len
);
1102 void buf_write(struct buffer
*buf
, const char *s
, int len
)
1104 if (buf
->size
- buf
->pos
< len
) {
1105 buf
->size
+= len
+ SZ
;
1106 buf
->p
= realloc(buf
->p
, buf
->size
);
1108 strncpy(buf
->p
+ buf
->pos
, s
, len
);
1112 static void check_for_gpl_usage(enum export exp
, const char *m
, const char *s
)
1114 const char *e
= is_vmlinux(m
) ?"":".ko";
1118 fatal("modpost: GPL-incompatible module %s%s "
1119 "uses GPL-only symbol '%s'\n", m
, e
, s
);
1121 case export_unused_gpl
:
1122 fatal("modpost: GPL-incompatible module %s%s "
1123 "uses GPL-only symbol marked UNUSED '%s'\n", m
, e
, s
);
1125 case export_gpl_future
:
1126 warn("modpost: GPL-incompatible module %s%s "
1127 "uses future GPL-only symbol '%s'\n", m
, e
, s
);
1131 case export_unknown
:
1137 static void check_for_unused(enum export exp
, const char* m
, const char* s
)
1139 const char *e
= is_vmlinux(m
) ?"":".ko";
1143 case export_unused_gpl
:
1144 warn("modpost: module %s%s "
1145 "uses symbol '%s' marked UNUSED\n", m
, e
, s
);
1153 static void check_exports(struct module
*mod
)
1155 struct symbol
*s
, *exp
;
1157 for (s
= mod
->unres
; s
; s
= s
->next
) {
1158 const char *basename
;
1159 exp
= find_symbol(s
->name
);
1160 if (!exp
|| exp
->module
== mod
)
1162 basename
= strrchr(mod
->name
, '/');
1166 basename
= mod
->name
;
1167 if (!mod
->gpl_compatible
)
1168 check_for_gpl_usage(exp
->export
, basename
, exp
->name
);
1169 check_for_unused(exp
->export
, basename
, exp
->name
);
1174 * Header for the generated file
1176 static void add_header(struct buffer
*b
, struct module
*mod
)
1178 buf_printf(b
, "#include <linux/module.h>\n");
1179 buf_printf(b
, "#include <linux/vermagic.h>\n");
1180 buf_printf(b
, "#include <linux/compiler.h>\n");
1181 buf_printf(b
, "\n");
1182 buf_printf(b
, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
1183 buf_printf(b
, "\n");
1184 buf_printf(b
, "struct module __this_module\n");
1185 buf_printf(b
, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
1186 buf_printf(b
, " .name = KBUILD_MODNAME,\n");
1188 buf_printf(b
, " .init = init_module,\n");
1189 if (mod
->has_cleanup
)
1190 buf_printf(b
, "#ifdef CONFIG_MODULE_UNLOAD\n"
1191 " .exit = cleanup_module,\n"
1193 buf_printf(b
, "};\n");
1197 * Record CRCs for unresolved symbols
1199 static void add_versions(struct buffer
*b
, struct module
*mod
)
1201 struct symbol
*s
, *exp
;
1203 for (s
= mod
->unres
; s
; s
= s
->next
) {
1204 exp
= find_symbol(s
->name
);
1205 if (!exp
|| exp
->module
== mod
) {
1206 if (have_vmlinux
&& !s
->weak
)
1207 warn("\"%s\" [%s.ko] undefined!\n",
1208 s
->name
, mod
->name
);
1211 s
->module
= exp
->module
;
1212 s
->crc_valid
= exp
->crc_valid
;
1219 buf_printf(b
, "\n");
1220 buf_printf(b
, "static const struct modversion_info ____versions[]\n");
1221 buf_printf(b
, "__attribute_used__\n");
1222 buf_printf(b
, "__attribute__((section(\"__versions\"))) = {\n");
1224 for (s
= mod
->unres
; s
; s
= s
->next
) {
1228 if (!s
->crc_valid
) {
1229 warn("\"%s\" [%s.ko] has no CRC!\n",
1230 s
->name
, mod
->name
);
1233 buf_printf(b
, "\t{ %#8x, \"%s\" },\n", s
->crc
, s
->name
);
1236 buf_printf(b
, "};\n");
1239 static void add_depends(struct buffer
*b
, struct module
*mod
,
1240 struct module
*modules
)
1246 for (m
= modules
; m
; m
= m
->next
) {
1247 m
->seen
= is_vmlinux(m
->name
);
1250 buf_printf(b
, "\n");
1251 buf_printf(b
, "static const char __module_depends[]\n");
1252 buf_printf(b
, "__attribute_used__\n");
1253 buf_printf(b
, "__attribute__((section(\".modinfo\"))) =\n");
1254 buf_printf(b
, "\"depends=");
1255 for (s
= mod
->unres
; s
; s
= s
->next
) {
1259 if (s
->module
->seen
)
1262 s
->module
->seen
= 1;
1263 buf_printf(b
, "%s%s", first
? "" : ",",
1264 strrchr(s
->module
->name
, '/') + 1);
1267 buf_printf(b
, "\";\n");
1270 static void add_srcversion(struct buffer
*b
, struct module
*mod
)
1272 if (mod
->srcversion
[0]) {
1273 buf_printf(b
, "\n");
1274 buf_printf(b
, "MODULE_INFO(srcversion, \"%s\");\n",
1279 static void write_if_changed(struct buffer
*b
, const char *fname
)
1285 file
= fopen(fname
, "r");
1289 if (fstat(fileno(file
), &st
) < 0)
1292 if (st
.st_size
!= b
->pos
)
1295 tmp
= NOFAIL(malloc(b
->pos
));
1296 if (fread(tmp
, 1, b
->pos
, file
) != b
->pos
)
1299 if (memcmp(tmp
, b
->p
, b
->pos
) != 0)
1311 file
= fopen(fname
, "w");
1316 if (fwrite(b
->p
, 1, b
->pos
, file
) != b
->pos
) {
1323 /* parse Module.symvers file. line format:
1324 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
1326 static void read_dump(const char *fname
, unsigned int kernel
)
1328 unsigned long size
, pos
= 0;
1329 void *file
= grab_file(fname
, &size
);
1333 /* No symbol versions, silently ignore */
1336 while ((line
= get_next_line(&pos
, file
, size
))) {
1337 char *symname
, *modname
, *d
, *export
, *end
;
1342 if (!(symname
= strchr(line
, '\t')))
1345 if (!(modname
= strchr(symname
, '\t')))
1348 if ((export
= strchr(modname
, '\t')) != NULL
)
1350 if (export
&& ((end
= strchr(export
, '\t')) != NULL
))
1352 crc
= strtoul(line
, &d
, 16);
1353 if (*symname
== '\0' || *modname
== '\0' || *d
!= '\0')
1356 if (!(mod
= find_module(modname
))) {
1357 if (is_vmlinux(modname
)) {
1360 mod
= new_module(NOFAIL(strdup(modname
)));
1363 s
= sym_add_exported(symname
, mod
, export_no(export
));
1366 sym_update_crc(symname
, mod
, crc
, export_no(export
));
1370 fatal("parse error in symbol dump file\n");
1373 /* For normal builds always dump all symbols.
1374 * For external modules only dump symbols
1375 * that are not read from kernel Module.symvers.
1377 static int dump_sym(struct symbol
*sym
)
1379 if (!external_module
)
1381 if (sym
->vmlinux
|| sym
->kernel
)
1386 static void write_dump(const char *fname
)
1388 struct buffer buf
= { };
1389 struct symbol
*symbol
;
1392 for (n
= 0; n
< SYMBOL_HASH_SIZE
; n
++) {
1393 symbol
= symbolhash
[n
];
1395 if (dump_sym(symbol
))
1396 buf_printf(&buf
, "0x%08x\t%s\t%s\t%s\n",
1397 symbol
->crc
, symbol
->name
,
1398 symbol
->module
->name
,
1399 export_str(symbol
->export
));
1400 symbol
= symbol
->next
;
1403 write_if_changed(&buf
, fname
);
1406 int main(int argc
, char **argv
)
1409 struct buffer buf
= { };
1411 char *kernel_read
= NULL
, *module_read
= NULL
;
1412 char *dump_write
= NULL
;
1415 while ((opt
= getopt(argc
, argv
, "i:I:mo:a")) != -1) {
1418 kernel_read
= optarg
;
1421 module_read
= optarg
;
1422 external_module
= 1;
1428 dump_write
= optarg
;
1439 read_dump(kernel_read
, 1);
1441 read_dump(module_read
, 0);
1443 while (optind
< argc
) {
1444 read_symbols(argv
[optind
++]);
1447 for (mod
= modules
; mod
; mod
= mod
->next
) {
1453 for (mod
= modules
; mod
; mod
= mod
->next
) {
1459 add_header(&buf
, mod
);
1460 add_versions(&buf
, mod
);
1461 add_depends(&buf
, mod
, modules
);
1462 add_moddevtable(&buf
, mod
);
1463 add_srcversion(&buf
, mod
);
1465 sprintf(fname
, "%s.mod.c", mod
->name
);
1466 write_if_changed(&buf
, fname
);
1470 write_dump(dump_write
);