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
631 * Logos used in drivers/video/logo reside in __initdata but the
632 * funtion that references them are EXPORT_SYMBOL() so cannot be
633 * marker __init. So we whitelist them here.
640 * Symbols contained in .paravirtprobe may safely reference .init.text.
643 * fromsec = .paravirtprobe
646 static int secref_whitelist(const char *modname
, const char *tosec
,
647 const char *fromsec
, const char *atsym
,
648 const char *refsymname
)
652 const char *pat2sym
[] = {
654 "_template", /* scsi uses *_template a lot */
655 "_sht", /* scsi also used *_sht to some extent */
664 const char *pat3refsym
[] = {
671 /* Check for pattern 1 */
672 if (strcmp(tosec
, ".init.data") != 0)
674 if (strncmp(fromsec
, ".data", strlen(".data")) != 0)
676 if (strncmp(atsym
, "__param", strlen("__param")) != 0)
682 /* Check for pattern 2 */
683 if ((strcmp(tosec
, ".init.text") != 0) &&
684 (strcmp(tosec
, ".exit.text") != 0) &&
685 (strcmp(tosec
, ".init.data") != 0))
687 if (strcmp(fromsec
, ".data") != 0)
690 for (s
= pat2sym
; *s
; s
++)
691 if (strrcmp(atsym
, *s
) == 0)
696 /* Check for pattern 3 */
697 if ((strncmp(fromsec
, ".pci_fixup", strlen(".pci_fixup")) == 0) &&
698 (strcmp(tosec
, ".init.text") == 0))
701 /* Check for pattern 4 */
702 if ((strcmp(fromsec
, ".text.head") == 0) &&
703 ((strcmp(tosec
, ".init.data") == 0) ||
704 (strcmp(tosec
, ".init.text") == 0)))
707 /* Check for pattern 5 */
708 for (s
= pat3refsym
; *s
; s
++)
709 if (strcmp(refsymname
, *s
) == 0)
712 /* Check for pattern 6 */
713 if ((strcmp(tosec
, ".init.text") == 0) &&
714 (strcmp(fromsec
, ".text") == 0) &&
715 (strcmp(refsymname
, "kernel_init") == 0))
718 /* Check for pattern 7 */
719 if ((strcmp(tosec
, ".init.data") == 0) &&
720 (strncmp(fromsec
, ".text", strlen(".text")) == 0) &&
721 (strncmp(refsymname
, "logo_", strlen("logo_")) == 0))
724 /* Check for pattern 8 */
725 if ((strcmp(tosec
, ".init.text") == 0) &&
726 (strcmp(fromsec
, ".paravirtprobe") == 0))
733 * Find symbol based on relocation record info.
734 * In some cases the symbol supplied is a valid symbol so
735 * return refsym. If st_name != 0 we assume this is a valid symbol.
736 * In other cases the symbol needs to be looked up in the symbol table
737 * based on section and address.
739 static Elf_Sym
*find_elf_symbol(struct elf_info
*elf
, Elf_Addr addr
,
744 if (relsym
->st_name
!= 0)
746 for (sym
= elf
->symtab_start
; sym
< elf
->symtab_stop
; sym
++) {
747 if (sym
->st_shndx
!= relsym
->st_shndx
)
749 if (sym
->st_value
== addr
)
755 static inline int is_arm_mapping_symbol(const char *str
)
757 return str
[0] == '$' && strchr("atd", str
[1])
758 && (str
[2] == '\0' || str
[2] == '.');
762 * If there's no name there, ignore it; likewise, ignore it if it's
763 * one of the magic symbols emitted used by current ARM tools.
765 * Otherwise if find_symbols_between() returns those symbols, they'll
766 * fail the whitelist tests and cause lots of false alarms ... fixable
767 * only by merging __exit and __init sections into __text, bloating
768 * the kernel (which is especially evil on embedded platforms).
770 static inline int is_valid_name(struct elf_info
*elf
, Elf_Sym
*sym
)
772 const char *name
= elf
->strtab
+ sym
->st_name
;
774 if (!name
|| !strlen(name
))
776 return !is_arm_mapping_symbol(name
);
780 * Find symbols before or equal addr and after addr - in the section sec.
781 * If we find two symbols with equal offset prefer one with a valid name.
782 * The ELF format may have a better way to detect what type of symbol
783 * it is, but this works for now.
785 static void find_symbols_between(struct elf_info
*elf
, Elf_Addr addr
,
787 Elf_Sym
**before
, Elf_Sym
**after
)
790 Elf_Ehdr
*hdr
= elf
->hdr
;
791 Elf_Addr beforediff
= ~0;
792 Elf_Addr afterdiff
= ~0;
793 const char *secstrings
= (void *)hdr
+
794 elf
->sechdrs
[hdr
->e_shstrndx
].sh_offset
;
799 for (sym
= elf
->symtab_start
; sym
< elf
->symtab_stop
; sym
++) {
802 if (sym
->st_shndx
>= SHN_LORESERVE
)
804 symsec
= secstrings
+ elf
->sechdrs
[sym
->st_shndx
].sh_name
;
805 if (strcmp(symsec
, sec
) != 0)
807 if (!is_valid_name(elf
, sym
))
809 if (sym
->st_value
<= addr
) {
810 if ((addr
- sym
->st_value
) < beforediff
) {
811 beforediff
= addr
- sym
->st_value
;
814 else if ((addr
- sym
->st_value
) == beforediff
) {
820 if ((sym
->st_value
- addr
) < afterdiff
) {
821 afterdiff
= sym
->st_value
- addr
;
824 else if ((sym
->st_value
- addr
) == afterdiff
) {
832 * Print a warning about a section mismatch.
833 * Try to find symbols near it so user can find it.
834 * Check whitelist before warning - it may be a false positive.
836 static void warn_sec_mismatch(const char *modname
, const char *fromsec
,
837 struct elf_info
*elf
, Elf_Sym
*sym
, Elf_Rela r
)
839 const char *refsymname
= "";
840 Elf_Sym
*before
, *after
;
842 Elf_Ehdr
*hdr
= elf
->hdr
;
843 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
844 const char *secstrings
= (void *)hdr
+
845 sechdrs
[hdr
->e_shstrndx
].sh_offset
;
846 const char *secname
= secstrings
+ sechdrs
[sym
->st_shndx
].sh_name
;
848 find_symbols_between(elf
, r
.r_offset
, fromsec
, &before
, &after
);
850 refsym
= find_elf_symbol(elf
, r
.r_addend
, sym
);
851 if (refsym
&& strlen(elf
->strtab
+ refsym
->st_name
))
852 refsymname
= elf
->strtab
+ refsym
->st_name
;
854 /* check whitelist - we may ignore it */
856 secref_whitelist(modname
, secname
, fromsec
,
857 elf
->strtab
+ before
->st_name
, refsymname
))
860 if (before
&& after
) {
861 warn("%s - Section mismatch: reference to %s:%s from %s "
862 "between '%s' (at offset 0x%llx) and '%s'\n",
863 modname
, secname
, refsymname
, fromsec
,
864 elf
->strtab
+ before
->st_name
,
865 (long long)r
.r_offset
,
866 elf
->strtab
+ after
->st_name
);
868 warn("%s - Section mismatch: reference to %s:%s from %s "
869 "after '%s' (at offset 0x%llx)\n",
870 modname
, secname
, refsymname
, fromsec
,
871 elf
->strtab
+ before
->st_name
,
872 (long long)r
.r_offset
);
874 warn("%s - Section mismatch: reference to %s:%s from %s "
875 "before '%s' (at offset -0x%llx)\n",
876 modname
, secname
, refsymname
, fromsec
,
877 elf
->strtab
+ after
->st_name
,
878 (long long)r
.r_offset
);
880 warn("%s - Section mismatch: reference to %s:%s from %s "
882 modname
, secname
, fromsec
, refsymname
,
883 (long long)r
.r_offset
);
888 * A module includes a number of sections that are discarded
889 * either when loaded or when used as built-in.
890 * For loaded modules all functions marked __init and all data
891 * marked __initdata will be discarded when the module has been intialized.
892 * Likewise for modules used built-in the sections marked __exit
893 * are discarded because __exit marked function are supposed to be called
894 * only when a moduel is unloaded which never happes for built-in modules.
895 * The check_sec_ref() function traverses all relocation records
896 * to find all references to a section that reference a section that will
897 * be discarded and warns about it.
899 static void check_sec_ref(struct module
*mod
, const char *modname
,
900 struct elf_info
*elf
,
901 int section(const char*),
902 int section_ref_ok(const char *))
906 Elf_Ehdr
*hdr
= elf
->hdr
;
907 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
908 const char *secstrings
= (void *)hdr
+
909 sechdrs
[hdr
->e_shstrndx
].sh_offset
;
911 /* Walk through all sections */
912 for (i
= 0; i
< hdr
->e_shnum
; i
++) {
913 const char *name
= secstrings
+ sechdrs
[i
].sh_name
;
917 /* We want to process only relocation sections and not .init */
918 if (sechdrs
[i
].sh_type
== SHT_RELA
) {
920 Elf_Rela
*start
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
921 Elf_Rela
*stop
= (void*)start
+ sechdrs
[i
].sh_size
;
922 name
+= strlen(".rela");
923 if (section_ref_ok(name
))
926 for (rela
= start
; rela
< stop
; rela
++) {
927 r
.r_offset
= TO_NATIVE(rela
->r_offset
);
928 #if KERNEL_ELFCLASS == ELFCLASS64
929 if (hdr
->e_machine
== EM_MIPS
) {
930 r_sym
= ELF64_MIPS_R_SYM(rela
->r_info
);
931 r_sym
= TO_NATIVE(r_sym
);
933 r
.r_info
= TO_NATIVE(rela
->r_info
);
934 r_sym
= ELF_R_SYM(r
.r_info
);
937 r
.r_info
= TO_NATIVE(rela
->r_info
);
938 r_sym
= ELF_R_SYM(r
.r_info
);
940 r
.r_addend
= TO_NATIVE(rela
->r_addend
);
941 sym
= elf
->symtab_start
+ r_sym
;
942 /* Skip special sections */
943 if (sym
->st_shndx
>= SHN_LORESERVE
)
946 secname
= secstrings
+
947 sechdrs
[sym
->st_shndx
].sh_name
;
948 if (section(secname
))
949 warn_sec_mismatch(modname
, name
,
952 } else if (sechdrs
[i
].sh_type
== SHT_REL
) {
954 Elf_Rel
*start
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
955 Elf_Rel
*stop
= (void*)start
+ sechdrs
[i
].sh_size
;
956 name
+= strlen(".rel");
957 if (section_ref_ok(name
))
960 for (rel
= start
; rel
< stop
; rel
++) {
961 r
.r_offset
= TO_NATIVE(rel
->r_offset
);
962 #if KERNEL_ELFCLASS == ELFCLASS64
963 if (hdr
->e_machine
== EM_MIPS
) {
964 r_sym
= ELF64_MIPS_R_SYM(rel
->r_info
);
965 r_sym
= TO_NATIVE(r_sym
);
967 r
.r_info
= TO_NATIVE(rel
->r_info
);
968 r_sym
= ELF_R_SYM(r
.r_info
);
971 r
.r_info
= TO_NATIVE(rel
->r_info
);
972 r_sym
= ELF_R_SYM(r
.r_info
);
975 sym
= elf
->symtab_start
+ r_sym
;
976 /* Skip special sections */
977 if (sym
->st_shndx
>= SHN_LORESERVE
)
980 secname
= secstrings
+
981 sechdrs
[sym
->st_shndx
].sh_name
;
982 if (section(secname
))
983 warn_sec_mismatch(modname
, name
,
991 * Functions used only during module init is marked __init and is stored in
992 * a .init.text section. Likewise data is marked __initdata and stored in
993 * a .init.data section.
994 * If this section is one of these sections return 1
995 * See include/linux/init.h for the details
997 static int init_section(const char *name
)
999 if (strcmp(name
, ".init") == 0)
1001 if (strncmp(name
, ".init.", strlen(".init.")) == 0)
1007 * Identify sections from which references to a .init section is OK.
1009 * Unfortunately references to read only data that referenced .init
1010 * sections had to be excluded. Almost all of these are false
1011 * positives, they are created by gcc. The downside of excluding rodata
1012 * is that there really are some user references from rodata to
1013 * init code, e.g. drivers/video/vgacon.c:
1015 * const struct consw vga_con = {
1016 * con_startup: vgacon_startup,
1018 * where vgacon_startup is __init. If you want to wade through the false
1019 * positives, take out the check for rodata.
1021 static int init_section_ref_ok(const char *name
)
1024 /* Absolute section names */
1025 const char *namelist1
[] = {
1027 ".opd", /* see comment [OPD] at exit_section_ref_ok() */
1028 ".toc1", /* used by ppc64 */
1030 ".data.rel.ro", /* used by parisc64 */
1031 ".parainstructions",
1033 "__bug_table", /* used by powerpc for BUG() */
1034 ".pci_fixup_header",
1041 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
1042 "__ftr_fixup", /* powerpc cpu feature fixup */
1043 "__fw_ftr_fixup", /* powerpc firmware feature fixup */
1046 /* Start of section names */
1047 const char *namelist2
[] = {
1052 ".parainstructions",
1056 /* part of section name */
1057 const char *namelist3
[] = {
1058 ".unwind", /* sample: IA_64.unwind.init.text */
1062 for (s
= namelist1
; *s
; s
++)
1063 if (strcmp(*s
, name
) == 0)
1065 for (s
= namelist2
; *s
; s
++)
1066 if (strncmp(*s
, name
, strlen(*s
)) == 0)
1068 for (s
= namelist3
; *s
; s
++)
1069 if (strstr(name
, *s
) != NULL
)
1071 if (strrcmp(name
, ".init") == 0)
1077 * Functions used only during module exit is marked __exit and is stored in
1078 * a .exit.text section. Likewise data is marked __exitdata and stored in
1079 * a .exit.data section.
1080 * If this section is one of these sections return 1
1081 * See include/linux/init.h for the details
1083 static int exit_section(const char *name
)
1085 if (strcmp(name
, ".exit.text") == 0)
1087 if (strcmp(name
, ".exit.data") == 0)
1094 * Identify sections from which references to a .exit section is OK.
1096 * [OPD] Keith Ownes <kaos@sgi.com> commented:
1097 * For our future {in}sanity, add a comment that this is the ppc .opd
1098 * section, not the ia64 .opd section.
1099 * ia64 .opd should not point to discarded sections.
1100 * [.rodata] like for .init.text we ignore .rodata references -same reason
1102 static int exit_section_ref_ok(const char *name
)
1105 /* Absolute section names */
1106 const char *namelist1
[] = {
1111 ".opd", /* See comment [OPD] */
1112 ".toc1", /* used by ppc64 */
1115 "__bug_table", /* used by powerpc for BUG() */
1118 ".parainstructions",
1123 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
1126 /* Start of section names */
1127 const char *namelist2
[] = {
1131 /* part of section name */
1132 const char *namelist3
[] = {
1133 ".unwind", /* Sample: IA_64.unwind.exit.text */
1137 for (s
= namelist1
; *s
; s
++)
1138 if (strcmp(*s
, name
) == 0)
1140 for (s
= namelist2
; *s
; s
++)
1141 if (strncmp(*s
, name
, strlen(*s
)) == 0)
1143 for (s
= namelist3
; *s
; s
++)
1144 if (strstr(name
, *s
) != NULL
)
1149 static void read_symbols(char *modname
)
1151 const char *symname
;
1155 struct elf_info info
= { };
1158 if (!parse_elf(&info
, modname
))
1161 mod
= new_module(modname
);
1163 /* When there's no vmlinux, don't print warnings about
1164 * unresolved symbols (since there'll be too many ;) */
1165 if (is_vmlinux(modname
)) {
1170 license
= get_modinfo(info
.modinfo
, info
.modinfo_len
, "license");
1172 if (license_is_gpl_compatible(license
))
1173 mod
->gpl_compatible
= 1;
1175 mod
->gpl_compatible
= 0;
1178 license
= get_next_modinfo(info
.modinfo
, info
.modinfo_len
,
1179 "license", license
);
1182 for (sym
= info
.symtab_start
; sym
< info
.symtab_stop
; sym
++) {
1183 symname
= info
.strtab
+ sym
->st_name
;
1185 handle_modversions(mod
, &info
, sym
, symname
);
1186 handle_moddevtable(mod
, &info
, sym
, symname
);
1188 check_sec_ref(mod
, modname
, &info
, init_section
, init_section_ref_ok
);
1189 check_sec_ref(mod
, modname
, &info
, exit_section
, exit_section_ref_ok
);
1191 version
= get_modinfo(info
.modinfo
, info
.modinfo_len
, "version");
1193 maybe_frob_rcs_version(modname
, version
, info
.modinfo
,
1194 version
- (char *)info
.hdr
);
1195 if (version
|| (all_versions
&& !is_vmlinux(modname
)))
1196 get_src_version(modname
, mod
->srcversion
,
1197 sizeof(mod
->srcversion
)-1);
1199 parse_elf_finish(&info
);
1201 /* Our trick to get versioning for struct_module - it's
1202 * never passed as an argument to an exported function, so
1203 * the automatic versioning doesn't pick it up, but it's really
1204 * important anyhow */
1206 mod
->unres
= alloc_symbol("struct_module", 0, mod
->unres
);
1211 /* We first write the generated file into memory using the
1212 * following helper, then compare to the file on disk and
1213 * only update the later if anything changed */
1215 void __attribute__((format(printf
, 2, 3))) buf_printf(struct buffer
*buf
,
1216 const char *fmt
, ...)
1223 len
= vsnprintf(tmp
, SZ
, fmt
, ap
);
1224 buf_write(buf
, tmp
, len
);
1228 void buf_write(struct buffer
*buf
, const char *s
, int len
)
1230 if (buf
->size
- buf
->pos
< len
) {
1231 buf
->size
+= len
+ SZ
;
1232 buf
->p
= realloc(buf
->p
, buf
->size
);
1234 strncpy(buf
->p
+ buf
->pos
, s
, len
);
1238 static void check_for_gpl_usage(enum export exp
, const char *m
, const char *s
)
1240 const char *e
= is_vmlinux(m
) ?"":".ko";
1244 fatal("modpost: GPL-incompatible module %s%s "
1245 "uses GPL-only symbol '%s'\n", m
, e
, s
);
1247 case export_unused_gpl
:
1248 fatal("modpost: GPL-incompatible module %s%s "
1249 "uses GPL-only symbol marked UNUSED '%s'\n", m
, e
, s
);
1251 case export_gpl_future
:
1252 warn("modpost: GPL-incompatible module %s%s "
1253 "uses future GPL-only symbol '%s'\n", m
, e
, s
);
1257 case export_unknown
:
1263 static void check_for_unused(enum export exp
, const char* m
, const char* s
)
1265 const char *e
= is_vmlinux(m
) ?"":".ko";
1269 case export_unused_gpl
:
1270 warn("modpost: module %s%s "
1271 "uses symbol '%s' marked UNUSED\n", m
, e
, s
);
1279 static void check_exports(struct module
*mod
)
1281 struct symbol
*s
, *exp
;
1283 for (s
= mod
->unres
; s
; s
= s
->next
) {
1284 const char *basename
;
1285 exp
= find_symbol(s
->name
);
1286 if (!exp
|| exp
->module
== mod
)
1288 basename
= strrchr(mod
->name
, '/');
1292 basename
= mod
->name
;
1293 if (!mod
->gpl_compatible
)
1294 check_for_gpl_usage(exp
->export
, basename
, exp
->name
);
1295 check_for_unused(exp
->export
, basename
, exp
->name
);
1300 * Header for the generated file
1302 static void add_header(struct buffer
*b
, struct module
*mod
)
1304 buf_printf(b
, "#include <linux/module.h>\n");
1305 buf_printf(b
, "#include <linux/vermagic.h>\n");
1306 buf_printf(b
, "#include <linux/compiler.h>\n");
1307 buf_printf(b
, "\n");
1308 buf_printf(b
, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
1309 buf_printf(b
, "\n");
1310 buf_printf(b
, "struct module __this_module\n");
1311 buf_printf(b
, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
1312 buf_printf(b
, " .name = KBUILD_MODNAME,\n");
1314 buf_printf(b
, " .init = init_module,\n");
1315 if (mod
->has_cleanup
)
1316 buf_printf(b
, "#ifdef CONFIG_MODULE_UNLOAD\n"
1317 " .exit = cleanup_module,\n"
1319 buf_printf(b
, "};\n");
1323 * Record CRCs for unresolved symbols
1325 static int add_versions(struct buffer
*b
, struct module
*mod
)
1327 struct symbol
*s
, *exp
;
1330 for (s
= mod
->unres
; s
; s
= s
->next
) {
1331 exp
= find_symbol(s
->name
);
1332 if (!exp
|| exp
->module
== mod
) {
1333 if (have_vmlinux
&& !s
->weak
) {
1334 if (warn_unresolved
) {
1335 warn("\"%s\" [%s.ko] undefined!\n",
1336 s
->name
, mod
->name
);
1338 merror("\"%s\" [%s.ko] undefined!\n",
1339 s
->name
, mod
->name
);
1345 s
->module
= exp
->module
;
1346 s
->crc_valid
= exp
->crc_valid
;
1353 buf_printf(b
, "\n");
1354 buf_printf(b
, "static const struct modversion_info ____versions[]\n");
1355 buf_printf(b
, "__attribute_used__\n");
1356 buf_printf(b
, "__attribute__((section(\"__versions\"))) = {\n");
1358 for (s
= mod
->unres
; s
; s
= s
->next
) {
1362 if (!s
->crc_valid
) {
1363 warn("\"%s\" [%s.ko] has no CRC!\n",
1364 s
->name
, mod
->name
);
1367 buf_printf(b
, "\t{ %#8x, \"%s\" },\n", s
->crc
, s
->name
);
1370 buf_printf(b
, "};\n");
1375 static void add_depends(struct buffer
*b
, struct module
*mod
,
1376 struct module
*modules
)
1382 for (m
= modules
; m
; m
= m
->next
) {
1383 m
->seen
= is_vmlinux(m
->name
);
1386 buf_printf(b
, "\n");
1387 buf_printf(b
, "static const char __module_depends[]\n");
1388 buf_printf(b
, "__attribute_used__\n");
1389 buf_printf(b
, "__attribute__((section(\".modinfo\"))) =\n");
1390 buf_printf(b
, "\"depends=");
1391 for (s
= mod
->unres
; s
; s
= s
->next
) {
1396 if (s
->module
->seen
)
1399 s
->module
->seen
= 1;
1400 if ((p
= strrchr(s
->module
->name
, '/')) != NULL
)
1403 p
= s
->module
->name
;
1404 buf_printf(b
, "%s%s", first
? "" : ",", p
);
1407 buf_printf(b
, "\";\n");
1410 static void add_srcversion(struct buffer
*b
, struct module
*mod
)
1412 if (mod
->srcversion
[0]) {
1413 buf_printf(b
, "\n");
1414 buf_printf(b
, "MODULE_INFO(srcversion, \"%s\");\n",
1419 static void write_if_changed(struct buffer
*b
, const char *fname
)
1425 file
= fopen(fname
, "r");
1429 if (fstat(fileno(file
), &st
) < 0)
1432 if (st
.st_size
!= b
->pos
)
1435 tmp
= NOFAIL(malloc(b
->pos
));
1436 if (fread(tmp
, 1, b
->pos
, file
) != b
->pos
)
1439 if (memcmp(tmp
, b
->p
, b
->pos
) != 0)
1451 file
= fopen(fname
, "w");
1456 if (fwrite(b
->p
, 1, b
->pos
, file
) != b
->pos
) {
1463 /* parse Module.symvers file. line format:
1464 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
1466 static void read_dump(const char *fname
, unsigned int kernel
)
1468 unsigned long size
, pos
= 0;
1469 void *file
= grab_file(fname
, &size
);
1473 /* No symbol versions, silently ignore */
1476 while ((line
= get_next_line(&pos
, file
, size
))) {
1477 char *symname
, *modname
, *d
, *export
, *end
;
1482 if (!(symname
= strchr(line
, '\t')))
1485 if (!(modname
= strchr(symname
, '\t')))
1488 if ((export
= strchr(modname
, '\t')) != NULL
)
1490 if (export
&& ((end
= strchr(export
, '\t')) != NULL
))
1492 crc
= strtoul(line
, &d
, 16);
1493 if (*symname
== '\0' || *modname
== '\0' || *d
!= '\0')
1496 if (!(mod
= find_module(modname
))) {
1497 if (is_vmlinux(modname
)) {
1500 mod
= new_module(NOFAIL(strdup(modname
)));
1503 s
= sym_add_exported(symname
, mod
, export_no(export
));
1506 sym_update_crc(symname
, mod
, crc
, export_no(export
));
1510 fatal("parse error in symbol dump file\n");
1513 /* For normal builds always dump all symbols.
1514 * For external modules only dump symbols
1515 * that are not read from kernel Module.symvers.
1517 static int dump_sym(struct symbol
*sym
)
1519 if (!external_module
)
1521 if (sym
->vmlinux
|| sym
->kernel
)
1526 static void write_dump(const char *fname
)
1528 struct buffer buf
= { };
1529 struct symbol
*symbol
;
1532 for (n
= 0; n
< SYMBOL_HASH_SIZE
; n
++) {
1533 symbol
= symbolhash
[n
];
1535 if (dump_sym(symbol
))
1536 buf_printf(&buf
, "0x%08x\t%s\t%s\t%s\n",
1537 symbol
->crc
, symbol
->name
,
1538 symbol
->module
->name
,
1539 export_str(symbol
->export
));
1540 symbol
= symbol
->next
;
1543 write_if_changed(&buf
, fname
);
1546 int main(int argc
, char **argv
)
1549 struct buffer buf
= { };
1551 char *kernel_read
= NULL
, *module_read
= NULL
;
1552 char *dump_write
= NULL
;
1556 while ((opt
= getopt(argc
, argv
, "i:I:mo:aw")) != -1) {
1559 kernel_read
= optarg
;
1562 module_read
= optarg
;
1563 external_module
= 1;
1569 dump_write
= optarg
;
1575 warn_unresolved
= 1;
1583 read_dump(kernel_read
, 1);
1585 read_dump(module_read
, 0);
1587 while (optind
< argc
) {
1588 read_symbols(argv
[optind
++]);
1591 for (mod
= modules
; mod
; mod
= mod
->next
) {
1599 for (mod
= modules
; mod
; mod
= mod
->next
) {
1605 add_header(&buf
, mod
);
1606 err
|= add_versions(&buf
, mod
);
1607 add_depends(&buf
, mod
, modules
);
1608 add_moddevtable(&buf
, mod
);
1609 add_srcversion(&buf
, mod
);
1611 sprintf(fname
, "%s.mod.c", mod
->name
);
1612 write_if_changed(&buf
, fname
);
1616 write_dump(dump_write
);