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 /* Warn about section mismatch in vmlinux if set to 1 */
27 static int vmlinux_section_warnings
= 1;
28 /* Only warn about unresolved symbols */
29 static int warn_unresolved
= 0;
30 /* How a symbol is exported */
32 export_plain
, export_unused
, export_gpl
,
33 export_unused_gpl
, export_gpl_future
, export_unknown
36 void fatal(const char *fmt
, ...)
40 fprintf(stderr
, "FATAL: ");
42 va_start(arglist
, fmt
);
43 vfprintf(stderr
, fmt
, arglist
);
49 void warn(const char *fmt
, ...)
53 fprintf(stderr
, "WARNING: ");
55 va_start(arglist
, fmt
);
56 vfprintf(stderr
, fmt
, arglist
);
60 void merror(const char *fmt
, ...)
64 fprintf(stderr
, "ERROR: ");
66 va_start(arglist
, fmt
);
67 vfprintf(stderr
, fmt
, arglist
);
71 static int is_vmlinux(const char *modname
)
75 if ((myname
= strrchr(modname
, '/')))
80 return (strcmp(myname
, "vmlinux") == 0) ||
81 (strcmp(myname
, "vmlinux.o") == 0);
84 void *do_nofail(void *ptr
, const char *expr
)
87 fatal("modpost: Memory allocation failure: %s.\n", expr
);
92 /* A list of all modules we processed */
94 static struct module
*modules
;
96 static struct module
*find_module(char *modname
)
100 for (mod
= modules
; mod
; mod
= mod
->next
)
101 if (strcmp(mod
->name
, modname
) == 0)
106 static struct module
*new_module(char *modname
)
111 mod
= NOFAIL(malloc(sizeof(*mod
)));
112 memset(mod
, 0, sizeof(*mod
));
113 p
= NOFAIL(strdup(modname
));
115 /* strip trailing .o */
116 if ((s
= strrchr(p
, '.')) != NULL
)
117 if (strcmp(s
, ".o") == 0)
122 mod
->gpl_compatible
= -1;
129 /* A hash of all exported symbols,
130 * struct symbol is also used for lists of unresolved symbols */
132 #define SYMBOL_HASH_SIZE 1024
136 struct module
*module
;
140 unsigned int vmlinux
:1; /* 1 if symbol is defined in vmlinux */
141 unsigned int kernel
:1; /* 1 if symbol is from kernel
142 * (only for external modules) **/
143 unsigned int preloaded
:1; /* 1 if symbol from Module.symvers */
144 enum export export
; /* Type of export */
148 static struct symbol
*symbolhash
[SYMBOL_HASH_SIZE
];
150 /* This is based on the hash agorithm from gdbm, via tdb */
151 static inline unsigned int tdb_hash(const char *name
)
153 unsigned value
; /* Used to compute the hash value. */
154 unsigned i
; /* Used to cycle through random values. */
156 /* Set the initial value from the key size. */
157 for (value
= 0x238F13AF * strlen(name
), i
=0; name
[i
]; i
++)
158 value
= (value
+ (((unsigned char *)name
)[i
] << (i
*5 % 24)));
160 return (1103515243 * value
+ 12345);
164 * Allocate a new symbols for use in the hash of exported symbols or
165 * the list of unresolved symbols per module
167 static struct symbol
*alloc_symbol(const char *name
, unsigned int weak
,
170 struct symbol
*s
= NOFAIL(malloc(sizeof(*s
) + strlen(name
) + 1));
172 memset(s
, 0, sizeof(*s
));
173 strcpy(s
->name
, name
);
179 /* For the hash of exported symbols */
180 static struct symbol
*new_symbol(const char *name
, struct module
*module
,
186 hash
= tdb_hash(name
) % SYMBOL_HASH_SIZE
;
187 new = symbolhash
[hash
] = alloc_symbol(name
, 0, symbolhash
[hash
]);
188 new->module
= module
;
189 new->export
= export
;
193 static struct symbol
*find_symbol(const char *name
)
197 /* For our purposes, .foo matches foo. PPC64 needs this. */
201 for (s
= symbolhash
[tdb_hash(name
) % SYMBOL_HASH_SIZE
]; s
; s
=s
->next
) {
202 if (strcmp(s
->name
, name
) == 0)
212 { .str
= "EXPORT_SYMBOL", .export
= export_plain
},
213 { .str
= "EXPORT_UNUSED_SYMBOL", .export
= export_unused
},
214 { .str
= "EXPORT_SYMBOL_GPL", .export
= export_gpl
},
215 { .str
= "EXPORT_UNUSED_SYMBOL_GPL", .export
= export_unused_gpl
},
216 { .str
= "EXPORT_SYMBOL_GPL_FUTURE", .export
= export_gpl_future
},
217 { .str
= "(unknown)", .export
= export_unknown
},
221 static const char *export_str(enum export ex
)
223 return export_list
[ex
].str
;
226 static enum export
export_no(const char * s
)
230 return export_unknown
;
231 for (i
= 0; export_list
[i
].export
!= export_unknown
; i
++) {
232 if (strcmp(export_list
[i
].str
, s
) == 0)
233 return export_list
[i
].export
;
235 return export_unknown
;
238 static enum export
export_from_sec(struct elf_info
*elf
, Elf_Section sec
)
240 if (sec
== elf
->export_sec
)
242 else if (sec
== elf
->export_unused_sec
)
243 return export_unused
;
244 else if (sec
== elf
->export_gpl_sec
)
246 else if (sec
== elf
->export_unused_gpl_sec
)
247 return export_unused_gpl
;
248 else if (sec
== elf
->export_gpl_future_sec
)
249 return export_gpl_future
;
251 return export_unknown
;
255 * Add an exported symbol - it may have already been added without a
256 * CRC, in this case just update the CRC
258 static struct symbol
*sym_add_exported(const char *name
, struct module
*mod
,
261 struct symbol
*s
= find_symbol(name
);
264 s
= new_symbol(name
, mod
, export
);
267 warn("%s: '%s' exported twice. Previous export "
268 "was in %s%s\n", mod
->name
, name
,
270 is_vmlinux(s
->module
->name
) ?"":".ko");
272 /* In case Modules.symvers was out of date */
277 s
->vmlinux
= is_vmlinux(mod
->name
);
283 static void sym_update_crc(const char *name
, struct module
*mod
,
284 unsigned int crc
, enum export export
)
286 struct symbol
*s
= find_symbol(name
);
289 s
= new_symbol(name
, mod
, export
);
294 void *grab_file(const char *filename
, unsigned long *size
)
300 fd
= open(filename
, O_RDONLY
);
301 if (fd
< 0 || fstat(fd
, &st
) != 0)
305 map
= mmap(NULL
, *size
, PROT_READ
|PROT_WRITE
, MAP_PRIVATE
, fd
, 0);
308 if (map
== MAP_FAILED
)
314 * Return a copy of the next line in a mmap'ed file.
315 * spaces in the beginning of the line is trimmed away.
316 * Return a pointer to a static buffer.
318 char* get_next_line(unsigned long *pos
, void *file
, unsigned long size
)
320 static char line
[4096];
323 signed char *p
= (signed char *)file
+ *pos
;
326 for (; *pos
< size
; (*pos
)++)
328 if (skip
&& isspace(*p
)) {
333 if (*p
!= '\n' && (*pos
< size
)) {
337 break; /* Too long, stop */
348 void release_file(void *file
, unsigned long size
)
353 static int parse_elf(struct elf_info
*info
, const char *filename
)
360 hdr
= grab_file(filename
, &info
->size
);
366 if (info
->size
< sizeof(*hdr
)) {
367 /* file too small, assume this is an empty .o file */
370 /* Is this a valid ELF file? */
371 if ((hdr
->e_ident
[EI_MAG0
] != ELFMAG0
) ||
372 (hdr
->e_ident
[EI_MAG1
] != ELFMAG1
) ||
373 (hdr
->e_ident
[EI_MAG2
] != ELFMAG2
) ||
374 (hdr
->e_ident
[EI_MAG3
] != ELFMAG3
)) {
375 /* Not an ELF file - silently ignore it */
378 /* Fix endianness in ELF header */
379 hdr
->e_shoff
= TO_NATIVE(hdr
->e_shoff
);
380 hdr
->e_shstrndx
= TO_NATIVE(hdr
->e_shstrndx
);
381 hdr
->e_shnum
= TO_NATIVE(hdr
->e_shnum
);
382 hdr
->e_machine
= TO_NATIVE(hdr
->e_machine
);
383 hdr
->e_type
= TO_NATIVE(hdr
->e_type
);
384 sechdrs
= (void *)hdr
+ hdr
->e_shoff
;
385 info
->sechdrs
= sechdrs
;
387 /* Check if file offset is correct */
388 if (hdr
->e_shoff
> info
->size
) {
389 fatal("section header offset=%u in file '%s' is bigger then filesize=%lu\n", hdr
->e_shoff
, filename
, info
->size
);
393 /* Fix endianness in section headers */
394 for (i
= 0; i
< hdr
->e_shnum
; i
++) {
395 sechdrs
[i
].sh_type
= TO_NATIVE(sechdrs
[i
].sh_type
);
396 sechdrs
[i
].sh_offset
= TO_NATIVE(sechdrs
[i
].sh_offset
);
397 sechdrs
[i
].sh_size
= TO_NATIVE(sechdrs
[i
].sh_size
);
398 sechdrs
[i
].sh_link
= TO_NATIVE(sechdrs
[i
].sh_link
);
399 sechdrs
[i
].sh_name
= TO_NATIVE(sechdrs
[i
].sh_name
);
400 sechdrs
[i
].sh_info
= TO_NATIVE(sechdrs
[i
].sh_info
);
401 sechdrs
[i
].sh_addr
= TO_NATIVE(sechdrs
[i
].sh_addr
);
403 /* Find symbol table. */
404 for (i
= 1; i
< hdr
->e_shnum
; i
++) {
405 const char *secstrings
406 = (void *)hdr
+ sechdrs
[hdr
->e_shstrndx
].sh_offset
;
409 if (sechdrs
[i
].sh_offset
> info
->size
) {
410 fatal("%s is truncated. sechdrs[i].sh_offset=%u > sizeof(*hrd)=%ul\n", filename
, (unsigned int)sechdrs
[i
].sh_offset
, sizeof(*hdr
));
413 secname
= secstrings
+ sechdrs
[i
].sh_name
;
414 if (strcmp(secname
, ".modinfo") == 0) {
415 info
->modinfo
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
416 info
->modinfo_len
= sechdrs
[i
].sh_size
;
417 } else if (strcmp(secname
, "__ksymtab") == 0)
418 info
->export_sec
= i
;
419 else if (strcmp(secname
, "__ksymtab_unused") == 0)
420 info
->export_unused_sec
= i
;
421 else if (strcmp(secname
, "__ksymtab_gpl") == 0)
422 info
->export_gpl_sec
= i
;
423 else if (strcmp(secname
, "__ksymtab_unused_gpl") == 0)
424 info
->export_unused_gpl_sec
= i
;
425 else if (strcmp(secname
, "__ksymtab_gpl_future") == 0)
426 info
->export_gpl_future_sec
= i
;
428 if (sechdrs
[i
].sh_type
!= SHT_SYMTAB
)
431 info
->symtab_start
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
432 info
->symtab_stop
= (void *)hdr
+ sechdrs
[i
].sh_offset
433 + sechdrs
[i
].sh_size
;
434 info
->strtab
= (void *)hdr
+
435 sechdrs
[sechdrs
[i
].sh_link
].sh_offset
;
437 if (!info
->symtab_start
) {
438 fatal("%s has no symtab?\n", filename
);
440 /* Fix endianness in symbols */
441 for (sym
= info
->symtab_start
; sym
< info
->symtab_stop
; sym
++) {
442 sym
->st_shndx
= TO_NATIVE(sym
->st_shndx
);
443 sym
->st_name
= TO_NATIVE(sym
->st_name
);
444 sym
->st_value
= TO_NATIVE(sym
->st_value
);
445 sym
->st_size
= TO_NATIVE(sym
->st_size
);
450 static void parse_elf_finish(struct elf_info
*info
)
452 release_file(info
->hdr
, info
->size
);
455 #define CRC_PFX MODULE_SYMBOL_PREFIX "__crc_"
456 #define KSYMTAB_PFX MODULE_SYMBOL_PREFIX "__ksymtab_"
458 static void handle_modversions(struct module
*mod
, struct elf_info
*info
,
459 Elf_Sym
*sym
, const char *symname
)
462 enum export export
= export_from_sec(info
, sym
->st_shndx
);
464 switch (sym
->st_shndx
) {
466 warn("\"%s\" [%s] is COMMON symbol\n", symname
, mod
->name
);
470 if (memcmp(symname
, CRC_PFX
, strlen(CRC_PFX
)) == 0) {
471 crc
= (unsigned int) sym
->st_value
;
472 sym_update_crc(symname
+ strlen(CRC_PFX
), mod
, crc
,
477 /* undefined symbol */
478 if (ELF_ST_BIND(sym
->st_info
) != STB_GLOBAL
&&
479 ELF_ST_BIND(sym
->st_info
) != STB_WEAK
)
481 /* ignore global offset table */
482 if (strcmp(symname
, "_GLOBAL_OFFSET_TABLE_") == 0)
484 /* ignore __this_module, it will be resolved shortly */
485 if (strcmp(symname
, MODULE_SYMBOL_PREFIX
"__this_module") == 0)
487 /* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
488 #if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
489 /* add compatibility with older glibc */
490 #ifndef STT_SPARC_REGISTER
491 #define STT_SPARC_REGISTER STT_REGISTER
493 if (info
->hdr
->e_machine
== EM_SPARC
||
494 info
->hdr
->e_machine
== EM_SPARCV9
) {
495 /* Ignore register directives. */
496 if (ELF_ST_TYPE(sym
->st_info
) == STT_SPARC_REGISTER
)
498 if (symname
[0] == '.') {
499 char *munged
= strdup(symname
);
501 munged
[1] = toupper(munged
[1]);
507 if (memcmp(symname
, MODULE_SYMBOL_PREFIX
,
508 strlen(MODULE_SYMBOL_PREFIX
)) == 0)
509 mod
->unres
= alloc_symbol(symname
+
510 strlen(MODULE_SYMBOL_PREFIX
),
511 ELF_ST_BIND(sym
->st_info
) == STB_WEAK
,
515 /* All exported symbols */
516 if (memcmp(symname
, KSYMTAB_PFX
, strlen(KSYMTAB_PFX
)) == 0) {
517 sym_add_exported(symname
+ strlen(KSYMTAB_PFX
), mod
,
520 if (strcmp(symname
, MODULE_SYMBOL_PREFIX
"init_module") == 0)
522 if (strcmp(symname
, MODULE_SYMBOL_PREFIX
"cleanup_module") == 0)
523 mod
->has_cleanup
= 1;
529 * Parse tag=value strings from .modinfo section
531 static char *next_string(char *string
, unsigned long *secsize
)
533 /* Skip non-zero chars */
536 if ((*secsize
)-- <= 1)
540 /* Skip any zero padding. */
543 if ((*secsize
)-- <= 1)
549 static char *get_next_modinfo(void *modinfo
, unsigned long modinfo_len
,
550 const char *tag
, char *info
)
553 unsigned int taglen
= strlen(tag
);
554 unsigned long size
= modinfo_len
;
557 size
-= info
- (char *)modinfo
;
558 modinfo
= next_string(info
, &size
);
561 for (p
= modinfo
; p
; p
= next_string(p
, &size
)) {
562 if (strncmp(p
, tag
, taglen
) == 0 && p
[taglen
] == '=')
563 return p
+ taglen
+ 1;
568 static char *get_modinfo(void *modinfo
, unsigned long modinfo_len
,
572 return get_next_modinfo(modinfo
, modinfo_len
, tag
, NULL
);
576 * Test if string s ends in string sub
579 static int strrcmp(const char *s
, const char *sub
)
587 sublen
= strlen(sub
);
589 if ((slen
== 0) || (sublen
== 0))
595 return memcmp(s
+ slen
- sublen
, sub
, sublen
);
599 * Functions used only during module init is marked __init and is stored in
600 * a .init.text section. Likewise data is marked __initdata and stored in
601 * a .init.data section.
602 * If this section is one of these sections return 1
603 * See include/linux/init.h for the details
605 static int init_section(const char *name
)
607 if (strcmp(name
, ".init") == 0)
609 if (strncmp(name
, ".init.", strlen(".init.")) == 0)
615 * Functions used only during module exit is marked __exit and is stored in
616 * a .exit.text section. Likewise data is marked __exitdata and stored in
617 * a .exit.data section.
618 * If this section is one of these sections return 1
619 * See include/linux/init.h for the details
621 static int exit_section(const char *name
)
623 if (strcmp(name
, ".exit.text") == 0)
625 if (strcmp(name
, ".exit.data") == 0)
632 * Data sections are named like this:
633 * .data | .data.rel | .data.rel.*
634 * Return 1 if the specified section is a data section
636 static int data_section(const char *name
)
638 if ((strcmp(name
, ".data") == 0) ||
639 (strcmp(name
, ".data.rel") == 0) ||
640 (strncmp(name
, ".data.rel.", strlen(".data.rel.")) == 0))
647 * Whitelist to allow certain references to pass with no warning.
650 * Do not warn if funtion/data are marked with __init_refok/__initdata_refok.
651 * The pattern is identified by:
652 * fromsec = .text.init.refok* | .data.init.refok*
655 * If a module parameter is declared __initdata and permissions=0
656 * then this is legal despite the warning generated.
657 * We cannot see value of permissions here, so just ignore
659 * The pattern is identified by:
665 * Many drivers utilise a *driver container with references to
666 * add, remove, probe functions etc.
667 * These functions may often be marked __init and we do not want to
669 * the pattern is identified by:
670 * tosec = init or exit section
671 * fromsec = data section
672 * atsym = *driver, *_template, *_sht, *_ops, *_probe, *probe_one, *_console, *_timer
675 * Whitelist all refereces from .text.head to .init.data
676 * Whitelist all refereces from .text.head to .init.text
679 * Some symbols belong to init section but still it is ok to reference
680 * these from non-init sections as these symbols don't have any memory
681 * allocated for them and symbol address and value are same. So even
682 * if init section is freed, its ok to reference those symbols.
683 * For ex. symbols marking the init section boundaries.
684 * This pattern is identified by
685 * refsymname = __init_begin, _sinittext, _einittext
688 * Xtensa uses literal sections for constants that are accessed PC-relative.
689 * Literal sections may safely reference their text sections.
690 * (Note that the name for the literal section omits any trailing '.text')
691 * tosec = <section>[.text]
692 * fromsec = <section>.literal
694 static int secref_whitelist(const char *modname
, const char *tosec
,
695 const char *fromsec
, const char *atsym
,
696 const char *refsymname
)
700 const char *pat2sym
[] = {
702 "_template", /* scsi uses *_template a lot */
703 "_timer", /* arm uses ops structures named _timer a lot */
704 "_sht", /* scsi also used *_sht to some extent */
712 const char *pat3refsym
[] = {
719 /* Check for pattern 0 */
720 if ((strncmp(fromsec
, ".text.init.refok", strlen(".text.init.refok")) == 0) ||
721 (strncmp(fromsec
, ".exit.text.refok", strlen(".exit.text.refok")) == 0) ||
722 (strncmp(fromsec
, ".data.init.refok", strlen(".data.init.refok")) == 0))
725 /* Check for pattern 1 */
726 if ((strcmp(tosec
, ".init.data") == 0) &&
727 (strncmp(fromsec
, ".data", strlen(".data")) == 0) &&
728 (strncmp(atsym
, "__param", strlen("__param")) == 0))
731 /* Check for pattern 2 */
732 if ((init_section(tosec
) || exit_section(tosec
)) && data_section(fromsec
))
733 for (s
= pat2sym
; *s
; s
++)
734 if (strrcmp(atsym
, *s
) == 0)
737 /* Check for pattern 3 */
738 if ((strcmp(fromsec
, ".text.head") == 0) &&
739 ((strcmp(tosec
, ".init.data") == 0) ||
740 (strcmp(tosec
, ".init.text") == 0)))
743 /* Check for pattern 4 */
744 for (s
= pat3refsym
; *s
; s
++)
745 if (strcmp(refsymname
, *s
) == 0)
748 /* Check for pattern 5 */
749 if (strrcmp(tosec
, ".text") == 0)
750 len
= strlen(tosec
) - strlen(".text");
753 if ((strncmp(tosec
, fromsec
, len
) == 0) && (strlen(fromsec
) > len
) &&
754 (strcmp(fromsec
+ len
, ".literal") == 0))
761 * Find symbol based on relocation record info.
762 * In some cases the symbol supplied is a valid symbol so
763 * return refsym. If st_name != 0 we assume this is a valid symbol.
764 * In other cases the symbol needs to be looked up in the symbol table
765 * based on section and address.
767 static Elf_Sym
*find_elf_symbol(struct elf_info
*elf
, Elf_Addr addr
,
772 if (relsym
->st_name
!= 0)
774 for (sym
= elf
->symtab_start
; sym
< elf
->symtab_stop
; sym
++) {
775 if (sym
->st_shndx
!= relsym
->st_shndx
)
777 if (ELF_ST_TYPE(sym
->st_info
) == STT_SECTION
)
779 if (sym
->st_value
== addr
)
785 static inline int is_arm_mapping_symbol(const char *str
)
787 return str
[0] == '$' && strchr("atd", str
[1])
788 && (str
[2] == '\0' || str
[2] == '.');
792 * If there's no name there, ignore it; likewise, ignore it if it's
793 * one of the magic symbols emitted used by current ARM tools.
795 * Otherwise if find_symbols_between() returns those symbols, they'll
796 * fail the whitelist tests and cause lots of false alarms ... fixable
797 * only by merging __exit and __init sections into __text, bloating
798 * the kernel (which is especially evil on embedded platforms).
800 static inline int is_valid_name(struct elf_info
*elf
, Elf_Sym
*sym
)
802 const char *name
= elf
->strtab
+ sym
->st_name
;
804 if (!name
|| !strlen(name
))
806 return !is_arm_mapping_symbol(name
);
810 * Find symbols before or equal addr and after addr - in the section sec.
811 * If we find two symbols with equal offset prefer one with a valid name.
812 * The ELF format may have a better way to detect what type of symbol
813 * it is, but this works for now.
815 static void find_symbols_between(struct elf_info
*elf
, Elf_Addr addr
,
817 Elf_Sym
**before
, Elf_Sym
**after
)
820 Elf_Ehdr
*hdr
= elf
->hdr
;
821 Elf_Addr beforediff
= ~0;
822 Elf_Addr afterdiff
= ~0;
823 const char *secstrings
= (void *)hdr
+
824 elf
->sechdrs
[hdr
->e_shstrndx
].sh_offset
;
829 for (sym
= elf
->symtab_start
; sym
< elf
->symtab_stop
; sym
++) {
832 if (sym
->st_shndx
>= SHN_LORESERVE
)
834 symsec
= secstrings
+ elf
->sechdrs
[sym
->st_shndx
].sh_name
;
835 if (strcmp(symsec
, sec
) != 0)
837 if (!is_valid_name(elf
, sym
))
839 if (sym
->st_value
<= addr
) {
840 if ((addr
- sym
->st_value
) < beforediff
) {
841 beforediff
= addr
- sym
->st_value
;
844 else if ((addr
- sym
->st_value
) == beforediff
) {
850 if ((sym
->st_value
- addr
) < afterdiff
) {
851 afterdiff
= sym
->st_value
- addr
;
854 else if ((sym
->st_value
- addr
) == afterdiff
) {
862 * Print a warning about a section mismatch.
863 * Try to find symbols near it so user can find it.
864 * Check whitelist before warning - it may be a false positive.
866 static void warn_sec_mismatch(const char *modname
, const char *fromsec
,
867 struct elf_info
*elf
, Elf_Sym
*sym
, Elf_Rela r
)
869 const char *refsymname
= "";
870 Elf_Sym
*before
, *after
;
872 Elf_Ehdr
*hdr
= elf
->hdr
;
873 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
874 const char *secstrings
= (void *)hdr
+
875 sechdrs
[hdr
->e_shstrndx
].sh_offset
;
876 const char *secname
= secstrings
+ sechdrs
[sym
->st_shndx
].sh_name
;
878 find_symbols_between(elf
, r
.r_offset
, fromsec
, &before
, &after
);
880 refsym
= find_elf_symbol(elf
, r
.r_addend
, sym
);
881 if (refsym
&& strlen(elf
->strtab
+ refsym
->st_name
))
882 refsymname
= elf
->strtab
+ refsym
->st_name
;
884 /* check whitelist - we may ignore it */
885 if (secref_whitelist(modname
, secname
, fromsec
,
886 before
? elf
->strtab
+ before
->st_name
: "",
890 if (before
&& after
) {
891 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
892 "(between '%s' and '%s')\n",
893 modname
, fromsec
, (unsigned long long)r
.r_offset
,
895 elf
->strtab
+ before
->st_name
,
896 elf
->strtab
+ after
->st_name
);
898 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
900 modname
, fromsec
, (unsigned long long)r
.r_offset
,
902 elf
->strtab
+ before
->st_name
);
904 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
905 "before '%s' (at offset -0x%llx)\n",
906 modname
, fromsec
, (unsigned long long)r
.r_offset
,
908 elf
->strtab
+ after
->st_name
);
910 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s\n",
911 modname
, fromsec
, (unsigned long long)r
.r_offset
,
912 secname
, refsymname
);
916 static unsigned int *reloc_location(struct elf_info
*elf
,
917 int rsection
, Elf_Rela
*r
)
919 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
920 int section
= sechdrs
[rsection
].sh_info
;
922 return (void *)elf
->hdr
+ sechdrs
[section
].sh_offset
+
923 (r
->r_offset
- sechdrs
[section
].sh_addr
);
926 static int addend_386_rel(struct elf_info
*elf
, int rsection
, Elf_Rela
*r
)
928 unsigned int r_typ
= ELF_R_TYPE(r
->r_info
);
929 unsigned int *location
= reloc_location(elf
, rsection
, r
);
933 r
->r_addend
= TO_NATIVE(*location
);
936 r
->r_addend
= TO_NATIVE(*location
) + 4;
937 /* For CONFIG_RELOCATABLE=y */
938 if (elf
->hdr
->e_type
== ET_EXEC
)
939 r
->r_addend
+= r
->r_offset
;
945 static int addend_arm_rel(struct elf_info
*elf
, int rsection
, Elf_Rela
*r
)
947 unsigned int r_typ
= ELF_R_TYPE(r
->r_info
);
951 /* From ARM ABI: (S + A) | T */
952 r
->r_addend
= (int)(long)(elf
->symtab_start
+ ELF_R_SYM(r
->r_info
));
955 /* From ARM ABI: ((S + A) | T) - P */
956 r
->r_addend
= (int)(long)(elf
->hdr
+ elf
->sechdrs
[rsection
].sh_offset
+
957 (r
->r_offset
- elf
->sechdrs
[rsection
].sh_addr
));
965 static int addend_mips_rel(struct elf_info
*elf
, int rsection
, Elf_Rela
*r
)
967 unsigned int r_typ
= ELF_R_TYPE(r
->r_info
);
968 unsigned int *location
= reloc_location(elf
, rsection
, r
);
971 if (r_typ
== R_MIPS_HI16
)
972 return 1; /* skip this */
973 inst
= TO_NATIVE(*location
);
976 r
->r_addend
= inst
& 0xffff;
979 r
->r_addend
= (inst
& 0x03ffffff) << 2;
989 * A module includes a number of sections that are discarded
990 * either when loaded or when used as built-in.
991 * For loaded modules all functions marked __init and all data
992 * marked __initdata will be discarded when the module has been intialized.
993 * Likewise for modules used built-in the sections marked __exit
994 * are discarded because __exit marked function are supposed to be called
995 * only when a moduel is unloaded which never happes for built-in modules.
996 * The check_sec_ref() function traverses all relocation records
997 * to find all references to a section that reference a section that will
998 * be discarded and warns about it.
1000 static void check_sec_ref(struct module
*mod
, const char *modname
,
1001 struct elf_info
*elf
,
1002 int section(const char*),
1003 int section_ref_ok(const char *))
1007 Elf_Ehdr
*hdr
= elf
->hdr
;
1008 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
1009 const char *secstrings
= (void *)hdr
+
1010 sechdrs
[hdr
->e_shstrndx
].sh_offset
;
1012 /* Walk through all sections */
1013 for (i
= 0; i
< hdr
->e_shnum
; i
++) {
1014 const char *name
= secstrings
+ sechdrs
[i
].sh_name
;
1015 const char *secname
;
1018 /* We want to process only relocation sections and not .init */
1019 if (sechdrs
[i
].sh_type
== SHT_RELA
) {
1021 Elf_Rela
*start
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
1022 Elf_Rela
*stop
= (void*)start
+ sechdrs
[i
].sh_size
;
1023 name
+= strlen(".rela");
1024 if (section_ref_ok(name
))
1027 for (rela
= start
; rela
< stop
; rela
++) {
1028 r
.r_offset
= TO_NATIVE(rela
->r_offset
);
1029 #if KERNEL_ELFCLASS == ELFCLASS64
1030 if (hdr
->e_machine
== EM_MIPS
) {
1032 r_sym
= ELF64_MIPS_R_SYM(rela
->r_info
);
1033 r_sym
= TO_NATIVE(r_sym
);
1034 r_typ
= ELF64_MIPS_R_TYPE(rela
->r_info
);
1035 r
.r_info
= ELF64_R_INFO(r_sym
, r_typ
);
1037 r
.r_info
= TO_NATIVE(rela
->r_info
);
1038 r_sym
= ELF_R_SYM(r
.r_info
);
1041 r
.r_info
= TO_NATIVE(rela
->r_info
);
1042 r_sym
= ELF_R_SYM(r
.r_info
);
1044 r
.r_addend
= TO_NATIVE(rela
->r_addend
);
1045 sym
= elf
->symtab_start
+ r_sym
;
1046 /* Skip special sections */
1047 if (sym
->st_shndx
>= SHN_LORESERVE
)
1050 secname
= secstrings
+
1051 sechdrs
[sym
->st_shndx
].sh_name
;
1052 if (section(secname
))
1053 warn_sec_mismatch(modname
, name
,
1056 } else if (sechdrs
[i
].sh_type
== SHT_REL
) {
1058 Elf_Rel
*start
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
1059 Elf_Rel
*stop
= (void*)start
+ sechdrs
[i
].sh_size
;
1060 name
+= strlen(".rel");
1061 if (section_ref_ok(name
))
1064 for (rel
= start
; rel
< stop
; rel
++) {
1065 r
.r_offset
= TO_NATIVE(rel
->r_offset
);
1066 #if KERNEL_ELFCLASS == ELFCLASS64
1067 if (hdr
->e_machine
== EM_MIPS
) {
1069 r_sym
= ELF64_MIPS_R_SYM(rel
->r_info
);
1070 r_sym
= TO_NATIVE(r_sym
);
1071 r_typ
= ELF64_MIPS_R_TYPE(rel
->r_info
);
1072 r
.r_info
= ELF64_R_INFO(r_sym
, r_typ
);
1074 r
.r_info
= TO_NATIVE(rel
->r_info
);
1075 r_sym
= ELF_R_SYM(r
.r_info
);
1078 r
.r_info
= TO_NATIVE(rel
->r_info
);
1079 r_sym
= ELF_R_SYM(r
.r_info
);
1082 switch (hdr
->e_machine
) {
1084 if (addend_386_rel(elf
, i
, &r
))
1088 if(addend_arm_rel(elf
, i
, &r
))
1092 if (addend_mips_rel(elf
, i
, &r
))
1096 sym
= elf
->symtab_start
+ r_sym
;
1097 /* Skip special sections */
1098 if (sym
->st_shndx
>= SHN_LORESERVE
)
1101 secname
= secstrings
+
1102 sechdrs
[sym
->st_shndx
].sh_name
;
1103 if (section(secname
))
1104 warn_sec_mismatch(modname
, name
,
1112 * Identify sections from which references to either a
1113 * .init or a .exit section is OK.
1115 * [OPD] Keith Ownes <kaos@sgi.com> commented:
1116 * For our future {in}sanity, add a comment that this is the ppc .opd
1117 * section, not the ia64 .opd section.
1118 * ia64 .opd should not point to discarded sections.
1119 * [.rodata] like for .init.text we ignore .rodata references -same reason
1121 static int initexit_section_ref_ok(const char *name
)
1124 /* Absolute section names */
1125 const char *namelist1
[] = {
1126 "__bug_table", /* used by powerpc for BUG() */
1129 ".cranges", /* used by sh64 */
1131 ".machvec", /* ia64 + powerpc uses these */
1133 ".opd", /* See comment [OPD] */
1135 ".parainstructions",
1137 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
1141 ".xt.prop", /* xtensa informational section */
1142 ".xt.lit", /* xtensa informational section */
1145 /* Start of section names */
1146 const char *namelist2
[] = {
1149 ".note", /* ignore ELF notes - may contain anything */
1150 ".got", /* powerpc - global offset table */
1151 ".toc", /* powerpc - table of contents */
1154 /* part of section name */
1155 const char *namelist3
[] = {
1156 ".unwind", /* Sample: IA_64.unwind.exit.text */
1160 for (s
= namelist1
; *s
; s
++)
1161 if (strcmp(*s
, name
) == 0)
1163 for (s
= namelist2
; *s
; s
++)
1164 if (strncmp(*s
, name
, strlen(*s
)) == 0)
1166 for (s
= namelist3
; *s
; s
++)
1167 if (strstr(name
, *s
) != NULL
)
1174 * Identify sections from which references to a .init section is OK.
1176 * Unfortunately references to read only data that referenced .init
1177 * sections had to be excluded. Almost all of these are false
1178 * positives, they are created by gcc. The downside of excluding rodata
1179 * is that there really are some user references from rodata to
1180 * init code, e.g. drivers/video/vgacon.c:
1182 * const struct consw vga_con = {
1183 * con_startup: vgacon_startup,
1185 * where vgacon_startup is __init. If you want to wade through the false
1186 * positives, take out the check for rodata.
1188 static int init_section_ref_ok(const char *name
)
1191 /* Absolute section names */
1192 const char *namelist1
[] = {
1193 "__dbe_table", /* MIPS generate these */
1194 "__ftr_fixup", /* powerpc cpu feature fixup */
1195 "__fw_ftr_fixup", /* powerpc firmware feature fixup */
1197 ".data.rel.ro", /* used by parisc64 */
1202 /* Start of section names */
1203 const char *namelist2
[] = {
1210 if (initexit_section_ref_ok(name
))
1213 for (s
= namelist1
; *s
; s
++)
1214 if (strcmp(*s
, name
) == 0)
1216 for (s
= namelist2
; *s
; s
++)
1217 if (strncmp(*s
, name
, strlen(*s
)) == 0)
1220 /* If section name ends with ".init" we allow references
1221 * as is the case with .initcallN.init, .early_param.init, .taglist.init etc
1223 if (strrcmp(name
, ".init") == 0)
1229 * Identify sections from which references to a .exit section is OK.
1231 static int exit_section_ref_ok(const char *name
)
1234 /* Absolute section names */
1235 const char *namelist1
[] = {
1243 if (initexit_section_ref_ok(name
))
1246 for (s
= namelist1
; *s
; s
++)
1247 if (strcmp(*s
, name
) == 0)
1252 static void read_symbols(char *modname
)
1254 const char *symname
;
1258 struct elf_info info
= { };
1261 if (!parse_elf(&info
, modname
))
1264 mod
= new_module(modname
);
1266 /* When there's no vmlinux, don't print warnings about
1267 * unresolved symbols (since there'll be too many ;) */
1268 if (is_vmlinux(modname
)) {
1273 license
= get_modinfo(info
.modinfo
, info
.modinfo_len
, "license");
1275 if (license_is_gpl_compatible(license
))
1276 mod
->gpl_compatible
= 1;
1278 mod
->gpl_compatible
= 0;
1281 license
= get_next_modinfo(info
.modinfo
, info
.modinfo_len
,
1282 "license", license
);
1285 for (sym
= info
.symtab_start
; sym
< info
.symtab_stop
; sym
++) {
1286 symname
= info
.strtab
+ sym
->st_name
;
1288 handle_modversions(mod
, &info
, sym
, symname
);
1289 handle_moddevtable(mod
, &info
, sym
, symname
);
1291 if (is_vmlinux(modname
) && vmlinux_section_warnings
) {
1292 check_sec_ref(mod
, modname
, &info
, init_section
, init_section_ref_ok
);
1293 check_sec_ref(mod
, modname
, &info
, exit_section
, exit_section_ref_ok
);
1296 version
= get_modinfo(info
.modinfo
, info
.modinfo_len
, "version");
1298 maybe_frob_rcs_version(modname
, version
, info
.modinfo
,
1299 version
- (char *)info
.hdr
);
1300 if (version
|| (all_versions
&& !is_vmlinux(modname
)))
1301 get_src_version(modname
, mod
->srcversion
,
1302 sizeof(mod
->srcversion
)-1);
1304 parse_elf_finish(&info
);
1306 /* Our trick to get versioning for struct_module - it's
1307 * never passed as an argument to an exported function, so
1308 * the automatic versioning doesn't pick it up, but it's really
1309 * important anyhow */
1311 mod
->unres
= alloc_symbol("struct_module", 0, mod
->unres
);
1316 /* We first write the generated file into memory using the
1317 * following helper, then compare to the file on disk and
1318 * only update the later if anything changed */
1320 void __attribute__((format(printf
, 2, 3))) buf_printf(struct buffer
*buf
,
1321 const char *fmt
, ...)
1328 len
= vsnprintf(tmp
, SZ
, fmt
, ap
);
1329 buf_write(buf
, tmp
, len
);
1333 void buf_write(struct buffer
*buf
, const char *s
, int len
)
1335 if (buf
->size
- buf
->pos
< len
) {
1336 buf
->size
+= len
+ SZ
;
1337 buf
->p
= realloc(buf
->p
, buf
->size
);
1339 strncpy(buf
->p
+ buf
->pos
, s
, len
);
1343 static void check_for_gpl_usage(enum export exp
, const char *m
, const char *s
)
1345 const char *e
= is_vmlinux(m
) ?"":".ko";
1349 fatal("modpost: GPL-incompatible module %s%s "
1350 "uses GPL-only symbol '%s'\n", m
, e
, s
);
1352 case export_unused_gpl
:
1353 fatal("modpost: GPL-incompatible module %s%s "
1354 "uses GPL-only symbol marked UNUSED '%s'\n", m
, e
, s
);
1356 case export_gpl_future
:
1357 warn("modpost: GPL-incompatible module %s%s "
1358 "uses future GPL-only symbol '%s'\n", m
, e
, s
);
1362 case export_unknown
:
1368 static void check_for_unused(enum export exp
, const char* m
, const char* s
)
1370 const char *e
= is_vmlinux(m
) ?"":".ko";
1374 case export_unused_gpl
:
1375 warn("modpost: module %s%s "
1376 "uses symbol '%s' marked UNUSED\n", m
, e
, s
);
1384 static void check_exports(struct module
*mod
)
1386 struct symbol
*s
, *exp
;
1388 for (s
= mod
->unres
; s
; s
= s
->next
) {
1389 const char *basename
;
1390 exp
= find_symbol(s
->name
);
1391 if (!exp
|| exp
->module
== mod
)
1393 basename
= strrchr(mod
->name
, '/');
1397 basename
= mod
->name
;
1398 if (!mod
->gpl_compatible
)
1399 check_for_gpl_usage(exp
->export
, basename
, exp
->name
);
1400 check_for_unused(exp
->export
, basename
, exp
->name
);
1405 * Header for the generated file
1407 static void add_header(struct buffer
*b
, struct module
*mod
)
1409 buf_printf(b
, "#include <linux/module.h>\n");
1410 buf_printf(b
, "#include <linux/vermagic.h>\n");
1411 buf_printf(b
, "#include <linux/compiler.h>\n");
1412 buf_printf(b
, "\n");
1413 buf_printf(b
, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
1414 buf_printf(b
, "\n");
1415 buf_printf(b
, "struct module __this_module\n");
1416 buf_printf(b
, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
1417 buf_printf(b
, " .name = KBUILD_MODNAME,\n");
1419 buf_printf(b
, " .init = init_module,\n");
1420 if (mod
->has_cleanup
)
1421 buf_printf(b
, "#ifdef CONFIG_MODULE_UNLOAD\n"
1422 " .exit = cleanup_module,\n"
1424 buf_printf(b
, " .arch = MODULE_ARCH_INIT,\n");
1425 buf_printf(b
, "};\n");
1429 * Record CRCs for unresolved symbols
1431 static int add_versions(struct buffer
*b
, struct module
*mod
)
1433 struct symbol
*s
, *exp
;
1436 for (s
= mod
->unres
; s
; s
= s
->next
) {
1437 exp
= find_symbol(s
->name
);
1438 if (!exp
|| exp
->module
== mod
) {
1439 if (have_vmlinux
&& !s
->weak
) {
1440 if (warn_unresolved
) {
1441 warn("\"%s\" [%s.ko] undefined!\n",
1442 s
->name
, mod
->name
);
1444 merror("\"%s\" [%s.ko] undefined!\n",
1445 s
->name
, mod
->name
);
1451 s
->module
= exp
->module
;
1452 s
->crc_valid
= exp
->crc_valid
;
1459 buf_printf(b
, "\n");
1460 buf_printf(b
, "static const struct modversion_info ____versions[]\n");
1461 buf_printf(b
, "__attribute_used__\n");
1462 buf_printf(b
, "__attribute__((section(\"__versions\"))) = {\n");
1464 for (s
= mod
->unres
; s
; s
= s
->next
) {
1468 if (!s
->crc_valid
) {
1469 warn("\"%s\" [%s.ko] has no CRC!\n",
1470 s
->name
, mod
->name
);
1473 buf_printf(b
, "\t{ %#8x, \"%s\" },\n", s
->crc
, s
->name
);
1476 buf_printf(b
, "};\n");
1481 static void add_depends(struct buffer
*b
, struct module
*mod
,
1482 struct module
*modules
)
1488 for (m
= modules
; m
; m
= m
->next
) {
1489 m
->seen
= is_vmlinux(m
->name
);
1492 buf_printf(b
, "\n");
1493 buf_printf(b
, "static const char __module_depends[]\n");
1494 buf_printf(b
, "__attribute_used__\n");
1495 buf_printf(b
, "__attribute__((section(\".modinfo\"))) =\n");
1496 buf_printf(b
, "\"depends=");
1497 for (s
= mod
->unres
; s
; s
= s
->next
) {
1502 if (s
->module
->seen
)
1505 s
->module
->seen
= 1;
1506 if ((p
= strrchr(s
->module
->name
, '/')) != NULL
)
1509 p
= s
->module
->name
;
1510 buf_printf(b
, "%s%s", first
? "" : ",", p
);
1513 buf_printf(b
, "\";\n");
1516 static void add_srcversion(struct buffer
*b
, struct module
*mod
)
1518 if (mod
->srcversion
[0]) {
1519 buf_printf(b
, "\n");
1520 buf_printf(b
, "MODULE_INFO(srcversion, \"%s\");\n",
1525 static void write_if_changed(struct buffer
*b
, const char *fname
)
1531 file
= fopen(fname
, "r");
1535 if (fstat(fileno(file
), &st
) < 0)
1538 if (st
.st_size
!= b
->pos
)
1541 tmp
= NOFAIL(malloc(b
->pos
));
1542 if (fread(tmp
, 1, b
->pos
, file
) != b
->pos
)
1545 if (memcmp(tmp
, b
->p
, b
->pos
) != 0)
1557 file
= fopen(fname
, "w");
1562 if (fwrite(b
->p
, 1, b
->pos
, file
) != b
->pos
) {
1569 /* parse Module.symvers file. line format:
1570 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
1572 static void read_dump(const char *fname
, unsigned int kernel
)
1574 unsigned long size
, pos
= 0;
1575 void *file
= grab_file(fname
, &size
);
1579 /* No symbol versions, silently ignore */
1582 while ((line
= get_next_line(&pos
, file
, size
))) {
1583 char *symname
, *modname
, *d
, *export
, *end
;
1588 if (!(symname
= strchr(line
, '\t')))
1591 if (!(modname
= strchr(symname
, '\t')))
1594 if ((export
= strchr(modname
, '\t')) != NULL
)
1596 if (export
&& ((end
= strchr(export
, '\t')) != NULL
))
1598 crc
= strtoul(line
, &d
, 16);
1599 if (*symname
== '\0' || *modname
== '\0' || *d
!= '\0')
1602 if (!(mod
= find_module(modname
))) {
1603 if (is_vmlinux(modname
)) {
1606 mod
= new_module(NOFAIL(strdup(modname
)));
1609 s
= sym_add_exported(symname
, mod
, export_no(export
));
1612 sym_update_crc(symname
, mod
, crc
, export_no(export
));
1616 fatal("parse error in symbol dump file\n");
1619 /* For normal builds always dump all symbols.
1620 * For external modules only dump symbols
1621 * that are not read from kernel Module.symvers.
1623 static int dump_sym(struct symbol
*sym
)
1625 if (!external_module
)
1627 if (sym
->vmlinux
|| sym
->kernel
)
1632 static void write_dump(const char *fname
)
1634 struct buffer buf
= { };
1635 struct symbol
*symbol
;
1638 for (n
= 0; n
< SYMBOL_HASH_SIZE
; n
++) {
1639 symbol
= symbolhash
[n
];
1641 if (dump_sym(symbol
))
1642 buf_printf(&buf
, "0x%08x\t%s\t%s\t%s\n",
1643 symbol
->crc
, symbol
->name
,
1644 symbol
->module
->name
,
1645 export_str(symbol
->export
));
1646 symbol
= symbol
->next
;
1649 write_if_changed(&buf
, fname
);
1652 int main(int argc
, char **argv
)
1655 struct buffer buf
= { };
1657 char *kernel_read
= NULL
, *module_read
= NULL
;
1658 char *dump_write
= NULL
;
1662 while ((opt
= getopt(argc
, argv
, "i:I:mso:aw")) != -1) {
1665 kernel_read
= optarg
;
1668 module_read
= optarg
;
1669 external_module
= 1;
1675 dump_write
= optarg
;
1681 vmlinux_section_warnings
= 0;
1684 warn_unresolved
= 1;
1692 read_dump(kernel_read
, 1);
1694 read_dump(module_read
, 0);
1696 while (optind
< argc
) {
1697 read_symbols(argv
[optind
++]);
1700 for (mod
= modules
; mod
; mod
= mod
->next
) {
1708 for (mod
= modules
; mod
; mod
= mod
->next
) {
1714 add_header(&buf
, mod
);
1715 err
|= add_versions(&buf
, mod
);
1716 add_depends(&buf
, mod
, modules
);
1717 add_moddevtable(&buf
, mod
);
1718 add_srcversion(&buf
, mod
);
1720 sprintf(fname
, "%s.mod.c", mod
->name
);
1721 write_if_changed(&buf
, fname
);
1725 write_dump(dump_write
);