1 /* Postprocess module symbol versions
3 * Copyright 2003 Kai Germaschewski
4 * Copyright 2002-2004 Rusty Russell, IBM Corporation
5 * Copyright 2006-2008 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 ...
25 #include <hashtable.h>
29 #include "../../include/linux/license.h"
31 static bool module_enabled
;
32 /* Are we using CONFIG_MODVERSIONS? */
33 static bool modversions
;
34 /* Is CONFIG_MODULE_SRCVERSION_ALL set? */
35 static bool all_versions
;
36 /* If we are modposting external module set to 1 */
37 static bool external_module
;
38 /* Only warn about unresolved symbols */
39 static bool warn_unresolved
;
41 static int sec_mismatch_count
;
42 static bool sec_mismatch_warn_only
= true;
43 /* Trim EXPORT_SYMBOLs that are unused by in-tree modules */
44 static bool trim_unused_exports
;
46 /* ignore missing files */
47 static bool ignore_missing_files
;
48 /* If set to 1, only warn (instead of error) about missing ns imports */
49 static bool allow_missing_ns_imports
;
51 static bool error_occurred
;
53 static bool extra_warn
;
55 bool target_is_big_endian
;
56 bool host_is_big_endian
;
59 * Cut off the warnings when there are too many. This typically occurs when
60 * vmlinux is missing. ('make modules' without building vmlinux.)
62 #define MAX_UNRESOLVED_REPORTS 10
63 static unsigned int nr_unresolved
;
65 /* In kernel, this size is defined in linux/module.h;
66 * here we use Elf_Addr instead of long for covering cross-compile
69 #define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
71 void modpost_log(bool is_error
, const char *fmt
, ...)
76 fprintf(stderr
, "ERROR: ");
77 error_occurred
= true;
79 fprintf(stderr
, "WARNING: ");
82 fprintf(stderr
, "modpost: ");
84 va_start(arglist
, fmt
);
85 vfprintf(stderr
, fmt
, arglist
);
89 static inline bool strends(const char *str
, const char *postfix
)
91 if (strlen(str
) < strlen(postfix
))
94 return strcmp(str
+ strlen(str
) - strlen(postfix
), postfix
) == 0;
97 char *read_text_file(const char *filename
)
104 fd
= open(filename
, O_RDONLY
);
110 if (fstat(fd
, &st
) < 0) {
115 buf
= xmalloc(st
.st_size
+ 1);
122 bytes_read
= read(fd
, buf
, nbytes
);
123 if (bytes_read
< 0) {
128 nbytes
-= bytes_read
;
130 buf
[st
.st_size
] = '\0';
137 char *get_line(char **stringp
)
139 char *orig
= *stringp
, *next
;
141 /* do not return the unwanted extra line at EOF */
142 if (!orig
|| *orig
== '\0')
145 /* don't use strsep here, it is not available everywhere */
146 next
= strchr(orig
, '\n');
155 /* A list of all modules we processed */
158 static struct module
*find_module(const char *modname
)
162 list_for_each_entry(mod
, &modules
, list
) {
163 if (strcmp(mod
->name
, modname
) == 0)
169 static struct module
*new_module(const char *name
, size_t namelen
)
173 mod
= xmalloc(sizeof(*mod
) + namelen
+ 1);
174 memset(mod
, 0, sizeof(*mod
));
176 INIT_LIST_HEAD(&mod
->exported_symbols
);
177 INIT_LIST_HEAD(&mod
->unresolved_symbols
);
178 INIT_LIST_HEAD(&mod
->missing_namespaces
);
179 INIT_LIST_HEAD(&mod
->imported_namespaces
);
180 INIT_LIST_HEAD(&mod
->aliases
);
182 memcpy(mod
->name
, name
, namelen
);
183 mod
->name
[namelen
] = '\0';
184 mod
->is_vmlinux
= (strcmp(mod
->name
, "vmlinux") == 0);
187 * Set mod->is_gpl_compatible to true by default. If MODULE_LICENSE()
188 * is missing, do not check the use for EXPORT_SYMBOL_GPL() becasue
189 * modpost will exit wiht error anyway.
191 mod
->is_gpl_compatible
= true;
193 list_add_tail(&mod
->list
, &modules
);
199 struct hlist_node hnode
;/* link to hash table */
200 struct list_head list
; /* link to module::exported_symbols or module::unresolved_symbols */
201 struct module
*module
;
207 bool is_gpl_only
; /* exported by EXPORT_SYMBOL_GPL */
208 bool used
; /* there exists a user of this symbol */
212 static HASHTABLE_DEFINE(symbol_hashtable
, 1U << 10);
215 * Allocate a new symbols for use in the hash of exported symbols or
216 * the list of unresolved symbols per module
218 static struct symbol
*alloc_symbol(const char *name
)
220 struct symbol
*s
= xmalloc(sizeof(*s
) + strlen(name
) + 1);
222 memset(s
, 0, sizeof(*s
));
223 strcpy(s
->name
, name
);
228 /* For the hash of exported symbols */
229 static void hash_add_symbol(struct symbol
*sym
)
231 hash_add(symbol_hashtable
, &sym
->hnode
, hash_str(sym
->name
));
234 static void sym_add_unresolved(const char *name
, struct module
*mod
, bool weak
)
238 sym
= alloc_symbol(name
);
241 list_add_tail(&sym
->list
, &mod
->unresolved_symbols
);
244 static struct symbol
*sym_find_with_module(const char *name
, struct module
*mod
)
248 /* For our purposes, .foo matches foo. PPC64 needs this. */
252 hash_for_each_possible(symbol_hashtable
, s
, hnode
, hash_str(name
)) {
253 if (strcmp(s
->name
, name
) == 0 && (!mod
|| s
->module
== mod
))
259 static struct symbol
*find_symbol(const char *name
)
261 return sym_find_with_module(name
, NULL
);
264 struct namespace_list
{
265 struct list_head list
;
269 static bool contains_namespace(struct list_head
*head
, const char *namespace)
271 struct namespace_list
*list
;
274 * The default namespace is null string "", which is always implicitly
280 list_for_each_entry(list
, head
, list
) {
281 if (!strcmp(list
->namespace, namespace))
288 static void add_namespace(struct list_head
*head
, const char *namespace)
290 struct namespace_list
*ns_entry
;
292 if (!contains_namespace(head
, namespace)) {
293 ns_entry
= xmalloc(sizeof(*ns_entry
) + strlen(namespace) + 1);
294 strcpy(ns_entry
->namespace, namespace);
295 list_add_tail(&ns_entry
->list
, head
);
299 static void *sym_get_data_by_offset(const struct elf_info
*info
,
300 unsigned int secindex
, unsigned long offset
)
302 Elf_Shdr
*sechdr
= &info
->sechdrs
[secindex
];
304 return (void *)info
->hdr
+ sechdr
->sh_offset
+ offset
;
307 void *sym_get_data(const struct elf_info
*info
, const Elf_Sym
*sym
)
309 return sym_get_data_by_offset(info
, get_secindex(info
, sym
),
313 static const char *sech_name(const struct elf_info
*info
, Elf_Shdr
*sechdr
)
315 return sym_get_data_by_offset(info
, info
->secindex_strings
,
319 static const char *sec_name(const struct elf_info
*info
, unsigned int secindex
)
322 * If sym->st_shndx is a special section index, there is no
323 * corresponding section header.
324 * Return "" if the index is out of range of info->sechdrs[] array.
326 if (secindex
>= info
->num_sections
)
329 return sech_name(info
, &info
->sechdrs
[secindex
]);
332 static struct symbol
*sym_add_exported(const char *name
, struct module
*mod
,
333 bool gpl_only
, const char *namespace)
335 struct symbol
*s
= find_symbol(name
);
337 if (s
&& (!external_module
|| s
->module
->is_vmlinux
|| s
->module
== mod
)) {
338 error("%s: '%s' exported twice. Previous export was in %s%s\n",
339 mod
->name
, name
, s
->module
->name
,
340 s
->module
->is_vmlinux
? "" : ".ko");
343 s
= alloc_symbol(name
);
345 s
->is_gpl_only
= gpl_only
;
346 s
->namespace = xstrdup(namespace);
347 list_add_tail(&s
->list
, &mod
->exported_symbols
);
353 static void sym_set_crc(struct symbol
*sym
, unsigned int crc
)
356 sym
->crc_valid
= true;
359 static void *grab_file(const char *filename
, size_t *size
)
362 void *map
= MAP_FAILED
;
365 fd
= open(filename
, O_RDONLY
);
372 map
= mmap(NULL
, *size
, PROT_READ
|PROT_WRITE
, MAP_PRIVATE
, fd
, 0);
376 if (map
== MAP_FAILED
)
381 static void release_file(void *file
, size_t size
)
386 static int parse_elf(struct elf_info
*info
, const char *filename
)
392 const char *secstrings
;
393 unsigned int symtab_idx
= ~0U, symtab_shndx_idx
= ~0U;
395 hdr
= grab_file(filename
, &info
->size
);
397 if (ignore_missing_files
) {
398 fprintf(stderr
, "%s: %s (ignored)\n", filename
,
406 if (info
->size
< sizeof(*hdr
)) {
407 /* file too small, assume this is an empty .o file */
410 /* Is this a valid ELF file? */
411 if ((hdr
->e_ident
[EI_MAG0
] != ELFMAG0
) ||
412 (hdr
->e_ident
[EI_MAG1
] != ELFMAG1
) ||
413 (hdr
->e_ident
[EI_MAG2
] != ELFMAG2
) ||
414 (hdr
->e_ident
[EI_MAG3
] != ELFMAG3
)) {
415 /* Not an ELF file - silently ignore it */
419 switch (hdr
->e_ident
[EI_DATA
]) {
421 target_is_big_endian
= false;
424 target_is_big_endian
= true;
427 fatal("target endian is unknown\n");
430 /* Fix endianness in ELF header */
431 hdr
->e_type
= TO_NATIVE(hdr
->e_type
);
432 hdr
->e_machine
= TO_NATIVE(hdr
->e_machine
);
433 hdr
->e_version
= TO_NATIVE(hdr
->e_version
);
434 hdr
->e_entry
= TO_NATIVE(hdr
->e_entry
);
435 hdr
->e_phoff
= TO_NATIVE(hdr
->e_phoff
);
436 hdr
->e_shoff
= TO_NATIVE(hdr
->e_shoff
);
437 hdr
->e_flags
= TO_NATIVE(hdr
->e_flags
);
438 hdr
->e_ehsize
= TO_NATIVE(hdr
->e_ehsize
);
439 hdr
->e_phentsize
= TO_NATIVE(hdr
->e_phentsize
);
440 hdr
->e_phnum
= TO_NATIVE(hdr
->e_phnum
);
441 hdr
->e_shentsize
= TO_NATIVE(hdr
->e_shentsize
);
442 hdr
->e_shnum
= TO_NATIVE(hdr
->e_shnum
);
443 hdr
->e_shstrndx
= TO_NATIVE(hdr
->e_shstrndx
);
444 sechdrs
= (void *)hdr
+ hdr
->e_shoff
;
445 info
->sechdrs
= sechdrs
;
447 /* modpost only works for relocatable objects */
448 if (hdr
->e_type
!= ET_REL
)
449 fatal("%s: not relocatable object.", filename
);
451 /* Check if file offset is correct */
452 if (hdr
->e_shoff
> info
->size
)
453 fatal("section header offset=%lu in file '%s' is bigger than filesize=%zu\n",
454 (unsigned long)hdr
->e_shoff
, filename
, info
->size
);
456 if (hdr
->e_shnum
== SHN_UNDEF
) {
458 * There are more than 64k sections,
459 * read count from .sh_size.
461 info
->num_sections
= TO_NATIVE(sechdrs
[0].sh_size
);
464 info
->num_sections
= hdr
->e_shnum
;
466 if (hdr
->e_shstrndx
== SHN_XINDEX
) {
467 info
->secindex_strings
= TO_NATIVE(sechdrs
[0].sh_link
);
470 info
->secindex_strings
= hdr
->e_shstrndx
;
473 /* Fix endianness in section headers */
474 for (i
= 0; i
< info
->num_sections
; i
++) {
475 sechdrs
[i
].sh_name
= TO_NATIVE(sechdrs
[i
].sh_name
);
476 sechdrs
[i
].sh_type
= TO_NATIVE(sechdrs
[i
].sh_type
);
477 sechdrs
[i
].sh_flags
= TO_NATIVE(sechdrs
[i
].sh_flags
);
478 sechdrs
[i
].sh_addr
= TO_NATIVE(sechdrs
[i
].sh_addr
);
479 sechdrs
[i
].sh_offset
= TO_NATIVE(sechdrs
[i
].sh_offset
);
480 sechdrs
[i
].sh_size
= TO_NATIVE(sechdrs
[i
].sh_size
);
481 sechdrs
[i
].sh_link
= TO_NATIVE(sechdrs
[i
].sh_link
);
482 sechdrs
[i
].sh_info
= TO_NATIVE(sechdrs
[i
].sh_info
);
483 sechdrs
[i
].sh_addralign
= TO_NATIVE(sechdrs
[i
].sh_addralign
);
484 sechdrs
[i
].sh_entsize
= TO_NATIVE(sechdrs
[i
].sh_entsize
);
486 /* Find symbol table. */
487 secstrings
= (void *)hdr
+ sechdrs
[info
->secindex_strings
].sh_offset
;
488 for (i
= 1; i
< info
->num_sections
; i
++) {
490 int nobits
= sechdrs
[i
].sh_type
== SHT_NOBITS
;
492 if (!nobits
&& sechdrs
[i
].sh_offset
> info
->size
)
493 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > sizeof(*hrd)=%zu\n",
494 filename
, (unsigned long)sechdrs
[i
].sh_offset
,
497 secname
= secstrings
+ sechdrs
[i
].sh_name
;
498 if (strcmp(secname
, ".modinfo") == 0) {
500 fatal("%s has NOBITS .modinfo\n", filename
);
501 info
->modinfo
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
502 info
->modinfo_len
= sechdrs
[i
].sh_size
;
503 } else if (!strcmp(secname
, ".export_symbol")) {
504 info
->export_symbol_secndx
= i
;
507 if (sechdrs
[i
].sh_type
== SHT_SYMTAB
) {
508 unsigned int sh_link_idx
;
510 info
->symtab_start
= (void *)hdr
+
511 sechdrs
[i
].sh_offset
;
512 info
->symtab_stop
= (void *)hdr
+
513 sechdrs
[i
].sh_offset
+ sechdrs
[i
].sh_size
;
514 sh_link_idx
= sechdrs
[i
].sh_link
;
515 info
->strtab
= (void *)hdr
+
516 sechdrs
[sh_link_idx
].sh_offset
;
519 /* 32bit section no. table? ("more than 64k sections") */
520 if (sechdrs
[i
].sh_type
== SHT_SYMTAB_SHNDX
) {
521 symtab_shndx_idx
= i
;
522 info
->symtab_shndx_start
= (void *)hdr
+
523 sechdrs
[i
].sh_offset
;
524 info
->symtab_shndx_stop
= (void *)hdr
+
525 sechdrs
[i
].sh_offset
+ sechdrs
[i
].sh_size
;
528 if (!info
->symtab_start
)
529 fatal("%s has no symtab?\n", filename
);
531 /* Fix endianness in symbols */
532 for (sym
= info
->symtab_start
; sym
< info
->symtab_stop
; sym
++) {
533 sym
->st_shndx
= TO_NATIVE(sym
->st_shndx
);
534 sym
->st_name
= TO_NATIVE(sym
->st_name
);
535 sym
->st_value
= TO_NATIVE(sym
->st_value
);
536 sym
->st_size
= TO_NATIVE(sym
->st_size
);
539 if (symtab_shndx_idx
!= ~0U) {
541 if (symtab_idx
!= sechdrs
[symtab_shndx_idx
].sh_link
)
542 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
543 filename
, sechdrs
[symtab_shndx_idx
].sh_link
,
546 for (p
= info
->symtab_shndx_start
; p
< info
->symtab_shndx_stop
;
551 symsearch_init(info
);
556 static void parse_elf_finish(struct elf_info
*info
)
558 symsearch_finish(info
);
559 release_file(info
->hdr
, info
->size
);
562 static int ignore_undef_symbol(struct elf_info
*info
, const char *symname
)
564 /* ignore __this_module, it will be resolved shortly */
565 if (strcmp(symname
, "__this_module") == 0)
567 /* ignore global offset table */
568 if (strcmp(symname
, "_GLOBAL_OFFSET_TABLE_") == 0)
570 if (info
->hdr
->e_machine
== EM_PPC
)
571 /* Special register function linked on all modules during final link of .ko */
572 if (strstarts(symname
, "_restgpr_") ||
573 strstarts(symname
, "_savegpr_") ||
574 strstarts(symname
, "_rest32gpr_") ||
575 strstarts(symname
, "_save32gpr_") ||
576 strstarts(symname
, "_restvr_") ||
577 strstarts(symname
, "_savevr_"))
579 if (info
->hdr
->e_machine
== EM_PPC64
)
580 /* Special register function linked on all modules during final link of .ko */
581 if (strstarts(symname
, "_restgpr0_") ||
582 strstarts(symname
, "_savegpr0_") ||
583 strstarts(symname
, "_restvr_") ||
584 strstarts(symname
, "_savevr_") ||
585 strcmp(symname
, ".TOC.") == 0)
587 /* Do not ignore this symbol */
591 static void handle_symbol(struct module
*mod
, struct elf_info
*info
,
592 const Elf_Sym
*sym
, const char *symname
)
594 switch (sym
->st_shndx
) {
596 if (strstarts(symname
, "__gnu_lto_")) {
597 /* Should warn here, but modpost runs before the linker */
599 warn("\"%s\" [%s] is COMMON symbol\n", symname
, mod
->name
);
602 /* undefined symbol */
603 if (ELF_ST_BIND(sym
->st_info
) != STB_GLOBAL
&&
604 ELF_ST_BIND(sym
->st_info
) != STB_WEAK
)
606 if (ignore_undef_symbol(info
, symname
))
608 if (info
->hdr
->e_machine
== EM_SPARC
||
609 info
->hdr
->e_machine
== EM_SPARCV9
) {
610 /* Ignore register directives. */
611 if (ELF_ST_TYPE(sym
->st_info
) == STT_SPARC_REGISTER
)
613 if (symname
[0] == '.') {
614 char *munged
= xstrdup(symname
);
616 munged
[1] = toupper(munged
[1]);
621 sym_add_unresolved(symname
, mod
,
622 ELF_ST_BIND(sym
->st_info
) == STB_WEAK
);
625 if (strcmp(symname
, "init_module") == 0)
626 mod
->has_init
= true;
627 if (strcmp(symname
, "cleanup_module") == 0)
628 mod
->has_cleanup
= true;
634 * Parse tag=value strings from .modinfo section
636 static char *next_string(char *string
, unsigned long *secsize
)
638 /* Skip non-zero chars */
641 if ((*secsize
)-- <= 1)
645 /* Skip any zero padding. */
648 if ((*secsize
)-- <= 1)
654 static char *get_next_modinfo(struct elf_info
*info
, const char *tag
,
658 unsigned int taglen
= strlen(tag
);
659 char *modinfo
= info
->modinfo
;
660 unsigned long size
= info
->modinfo_len
;
663 size
-= prev
- modinfo
;
664 modinfo
= next_string(prev
, &size
);
667 for (p
= modinfo
; p
; p
= next_string(p
, &size
)) {
668 if (strncmp(p
, tag
, taglen
) == 0 && p
[taglen
] == '=')
669 return p
+ taglen
+ 1;
674 static char *get_modinfo(struct elf_info
*info
, const char *tag
)
677 return get_next_modinfo(info
, tag
, NULL
);
680 static const char *sym_name(struct elf_info
*elf
, Elf_Sym
*sym
)
682 return sym
? elf
->strtab
+ sym
->st_name
: "";
686 * Check whether the 'string' argument matches one of the 'patterns',
687 * an array of shell wildcard patterns (glob).
689 * Return true is there is a match.
691 static bool match(const char *string
, const char *const patterns
[])
695 while ((pattern
= *patterns
++)) {
696 if (!fnmatch(pattern
, string
, 0))
703 /* useful to pass patterns to match() directly */
704 #define PATTERNS(...) \
706 static const char *const patterns[] = {__VA_ARGS__, NULL}; \
710 /* sections that we do not want to do full section mismatch check on */
711 static const char *const section_white_list
[] =
715 ".zdebug*", /* Compressed debug sections. */
716 ".GCC.command.line", /* record-gcc-switches */
717 ".mdebug*", /* alpha, score, mips etc. */
718 ".pdr", /* alpha, score, mips etc. */
723 ".xt.prop", /* xtensa */
724 ".xt.lit", /* xtensa */
725 ".arcextmap*", /* arc */
726 ".gnu.linkonce.arcext*", /* arc : modules */
727 ".cmem*", /* EZchip */
728 ".fmt_slot*", /* EZchip */
731 ".llvm.call-graph-profile", /* call graph */
736 * This is used to find sections missing the SHF_ALLOC flag.
737 * The cause of this is often a section specified in assembler
738 * without "ax" / "aw".
740 static void check_section(const char *modname
, struct elf_info
*elf
,
743 const char *sec
= sech_name(elf
, sechdr
);
745 if (sechdr
->sh_type
== SHT_PROGBITS
&&
746 !(sechdr
->sh_flags
& SHF_ALLOC
) &&
747 !match(sec
, section_white_list
)) {
748 warn("%s (%s): unexpected non-allocatable section.\n"
749 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
750 "Note that for example <linux/init.h> contains\n"
751 "section definitions for use in .S files.\n\n",
758 #define ALL_INIT_DATA_SECTIONS \
759 ".init.setup", ".init.rodata", ".init.data"
761 #define ALL_PCI_INIT_SECTIONS \
762 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
763 ".pci_fixup_enable", ".pci_fixup_resume", \
764 ".pci_fixup_resume_early", ".pci_fixup_suspend"
766 #define ALL_INIT_SECTIONS ".init.*"
767 #define ALL_EXIT_SECTIONS ".exit.*"
769 #define DATA_SECTIONS ".data", ".data.rel"
770 #define TEXT_SECTIONS ".text", ".text.*", ".sched.text", \
771 ".kprobes.text", ".cpuidle.text", ".noinstr.text", \
773 #define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
774 ".fixup", ".entry.text", ".exception.text", \
775 ".coldtext", ".softirqentry.text", ".irqentry.text"
777 #define ALL_TEXT_SECTIONS ".init.text", ".exit.text", \
778 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
781 TEXTDATA_TO_ANY_INIT_EXIT
,
782 XXXINIT_TO_SOME_INIT
,
783 ANY_INIT_TO_ANY_EXIT
,
784 ANY_EXIT_TO_ANY_INIT
,
789 * Describe how to match sections on different criteria:
791 * @fromsec: Array of sections to be matched.
793 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
794 * this array is forbidden (black-list). Can be empty.
796 * @good_tosec: Relocations applied to a section in @fromsec must be
797 * targeting sections in this array (white-list). Can be empty.
799 * @mismatch: Type of mismatch.
801 struct sectioncheck
{
802 const char *fromsec
[20];
803 const char *bad_tosec
[20];
804 const char *good_tosec
[20];
805 enum mismatch mismatch
;
808 static const struct sectioncheck sectioncheck
[] = {
809 /* Do not reference init/exit code/data from
810 * normal code and data
813 .fromsec
= { TEXT_SECTIONS
, DATA_SECTIONS
, NULL
},
814 .bad_tosec
= { ALL_INIT_SECTIONS
, ALL_EXIT_SECTIONS
, NULL
},
815 .mismatch
= TEXTDATA_TO_ANY_INIT_EXIT
,
817 /* Do not use exit code/data from init code */
819 .fromsec
= { ALL_INIT_SECTIONS
, NULL
},
820 .bad_tosec
= { ALL_EXIT_SECTIONS
, NULL
},
821 .mismatch
= ANY_INIT_TO_ANY_EXIT
,
823 /* Do not use init code/data from exit code */
825 .fromsec
= { ALL_EXIT_SECTIONS
, NULL
},
826 .bad_tosec
= { ALL_INIT_SECTIONS
, NULL
},
827 .mismatch
= ANY_EXIT_TO_ANY_INIT
,
830 .fromsec
= { ALL_PCI_INIT_SECTIONS
, NULL
},
831 .bad_tosec
= { ALL_INIT_SECTIONS
, NULL
},
832 .mismatch
= ANY_INIT_TO_ANY_EXIT
,
835 .fromsec
= { "__ex_table", NULL
},
836 /* If you're adding any new black-listed sections in here, consider
837 * adding a special 'printer' for them in scripts/check_extable.
839 .bad_tosec
= { ".altinstr_replacement", NULL
},
840 .good_tosec
= {ALL_TEXT_SECTIONS
, NULL
},
841 .mismatch
= EXTABLE_TO_NON_TEXT
,
845 static const struct sectioncheck
*section_mismatch(
846 const char *fromsec
, const char *tosec
)
851 * The target section could be the SHT_NUL section when we're
852 * handling relocations to un-resolved symbols, trying to match it
853 * doesn't make much sense and causes build failures on parisc
859 for (i
= 0; i
< ARRAY_SIZE(sectioncheck
); i
++) {
860 const struct sectioncheck
*check
= §ioncheck
[i
];
862 if (match(fromsec
, check
->fromsec
)) {
863 if (check
->bad_tosec
[0] && match(tosec
, check
->bad_tosec
))
865 if (check
->good_tosec
[0] && !match(tosec
, check
->good_tosec
))
873 * Whitelist to allow certain references to pass with no warning.
876 * If a module parameter is declared __initdata and permissions=0
877 * then this is legal despite the warning generated.
878 * We cannot see value of permissions here, so just ignore
880 * The pattern is identified by:
886 * module_param_call() ops can refer to __init set function if permissions=0
887 * The pattern is identified by:
890 * atsym = __param_ops_*
893 * Whitelist all references from .head.text to any init section
896 * Some symbols belong to init section but still it is ok to reference
897 * these from non-init sections as these symbols don't have any memory
898 * allocated for them and symbol address and value are same. So even
899 * if init section is freed, its ok to reference those symbols.
900 * For ex. symbols marking the init section boundaries.
901 * This pattern is identified by
902 * refsymname = __init_begin, _sinittext, _einittext
905 * GCC may optimize static inlines when fed constant arg(s) resulting
906 * in functions like cpumask_empty() -- generating an associated symbol
907 * cpumask_empty.constprop.3 that appears in the audit. If the const that
908 * is passed in comes from __init, like say nmi_ipi_mask, we get a
909 * meaningless section warning. May need to add isra symbols too...
910 * This pattern is identified by
911 * tosec = init section
912 * fromsec = text section
913 * refsymname = *.constprop.*
916 static int secref_whitelist(const char *fromsec
, const char *fromsym
,
917 const char *tosec
, const char *tosym
)
919 /* Check for pattern 1 */
920 if (match(tosec
, PATTERNS(ALL_INIT_DATA_SECTIONS
)) &&
921 match(fromsec
, PATTERNS(DATA_SECTIONS
)) &&
922 strstarts(fromsym
, "__param"))
925 /* Check for pattern 1a */
926 if (strcmp(tosec
, ".init.text") == 0 &&
927 match(fromsec
, PATTERNS(DATA_SECTIONS
)) &&
928 strstarts(fromsym
, "__param_ops_"))
931 /* symbols in data sections that may refer to any init/exit sections */
932 if (match(fromsec
, PATTERNS(DATA_SECTIONS
)) &&
933 match(tosec
, PATTERNS(ALL_INIT_SECTIONS
, ALL_EXIT_SECTIONS
)) &&
934 match(fromsym
, PATTERNS("*_ops", "*_probe", "*_console")))
937 /* Check for pattern 3 */
938 if (strstarts(fromsec
, ".head.text") &&
939 match(tosec
, PATTERNS(ALL_INIT_SECTIONS
)))
942 /* Check for pattern 4 */
943 if (match(tosym
, PATTERNS("__init_begin", "_sinittext", "_einittext")))
946 /* Check for pattern 5 */
947 if (match(fromsec
, PATTERNS(ALL_TEXT_SECTIONS
)) &&
948 match(tosec
, PATTERNS(ALL_INIT_SECTIONS
)) &&
949 match(fromsym
, PATTERNS("*.constprop.*")))
955 static Elf_Sym
*find_fromsym(struct elf_info
*elf
, Elf_Addr addr
,
958 return symsearch_find_nearest(elf
, addr
, secndx
, false, ~0);
961 static Elf_Sym
*find_tosym(struct elf_info
*elf
, Elf_Addr addr
, Elf_Sym
*sym
)
965 /* If the supplied symbol has a valid name, return it */
966 if (is_valid_name(elf
, sym
))
970 * Strive to find a better symbol name, but the resulting name may not
971 * match the symbol referenced in the original code.
973 new_sym
= symsearch_find_nearest(elf
, addr
, get_secindex(elf
, sym
),
975 return new_sym
? new_sym
: sym
;
978 static bool is_executable_section(struct elf_info
*elf
, unsigned int secndx
)
980 if (secndx
>= elf
->num_sections
)
983 return (elf
->sechdrs
[secndx
].sh_flags
& SHF_EXECINSTR
) != 0;
986 static void default_mismatch_handler(const char *modname
, struct elf_info
*elf
,
987 const struct sectioncheck
* const mismatch
,
989 unsigned int fsecndx
, const char *fromsec
, Elf_Addr faddr
,
990 const char *tosec
, Elf_Addr taddr
)
997 from
= find_fromsym(elf
, faddr
, fsecndx
);
998 fromsym
= sym_name(elf
, from
);
1000 tsym
= find_tosym(elf
, taddr
, tsym
);
1001 tosym
= sym_name(elf
, tsym
);
1003 /* check whitelist - we may ignore it */
1004 if (!secref_whitelist(fromsec
, fromsym
, tosec
, tosym
))
1007 sec_mismatch_count
++;
1010 snprintf(taddr_str
, sizeof(taddr_str
), "0x%x", (unsigned int)taddr
);
1013 * The format for the reference source: <symbol_name>+<offset> or <address>
1014 * The format for the reference destination: <symbol_name> or <address>
1016 warn("%s: section mismatch in reference: %s%s0x%x (section: %s) -> %s (section: %s)\n",
1017 modname
, fromsym
, fromsym
[0] ? "+" : "",
1018 (unsigned int)(faddr
- (fromsym
[0] ? from
->st_value
: 0)),
1019 fromsec
, tosym
[0] ? tosym
: taddr_str
, tosec
);
1021 if (mismatch
->mismatch
== EXTABLE_TO_NON_TEXT
) {
1022 if (match(tosec
, mismatch
->bad_tosec
))
1023 fatal("The relocation at %s+0x%lx references\n"
1024 "section \"%s\" which is black-listed.\n"
1025 "Something is seriously wrong and should be fixed.\n"
1026 "You might get more information about where this is\n"
1027 "coming from by using scripts/check_extable.sh %s\n",
1028 fromsec
, (long)faddr
, tosec
, modname
);
1029 else if (is_executable_section(elf
, get_secindex(elf
, tsym
)))
1030 warn("The relocation at %s+0x%lx references\n"
1031 "section \"%s\" which is not in the list of\n"
1032 "authorized sections. If you're adding a new section\n"
1033 "and/or if this reference is valid, add \"%s\" to the\n"
1034 "list of authorized sections to jump to on fault.\n"
1035 "This can be achieved by adding \"%s\" to\n"
1036 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1037 fromsec
, (long)faddr
, tosec
, tosec
, tosec
);
1039 error("%s+0x%lx references non-executable section '%s'\n",
1040 fromsec
, (long)faddr
, tosec
);
1044 static void check_export_symbol(struct module
*mod
, struct elf_info
*elf
,
1045 Elf_Addr faddr
, const char *secname
,
1048 static const char *prefix
= "__export_symbol_";
1049 const char *label_name
, *name
, *data
;
1054 label
= find_fromsym(elf
, faddr
, elf
->export_symbol_secndx
);
1055 label_name
= sym_name(elf
, label
);
1057 if (!strstarts(label_name
, prefix
)) {
1058 error("%s: .export_symbol section contains strange symbol '%s'\n",
1059 mod
->name
, label_name
);
1063 if (ELF_ST_BIND(sym
->st_info
) != STB_GLOBAL
&&
1064 ELF_ST_BIND(sym
->st_info
) != STB_WEAK
) {
1065 error("%s: local symbol '%s' was exported\n", mod
->name
,
1066 label_name
+ strlen(prefix
));
1070 name
= sym_name(elf
, sym
);
1071 if (strcmp(label_name
+ strlen(prefix
), name
)) {
1072 error("%s: .export_symbol section references '%s', but it does not seem to be an export symbol\n",
1077 data
= sym_get_data(elf
, label
); /* license */
1078 if (!strcmp(data
, "GPL")) {
1080 } else if (!strcmp(data
, "")) {
1083 error("%s: unknown license '%s' was specified for '%s'\n",
1084 mod
->name
, data
, name
);
1088 data
+= strlen(data
) + 1; /* namespace */
1089 s
= sym_add_exported(name
, mod
, is_gpl
, data
);
1092 * We need to be aware whether we are exporting a function or
1093 * a data on some architectures.
1095 s
->is_func
= (ELF_ST_TYPE(sym
->st_info
) == STT_FUNC
);
1098 * For parisc64, symbols prefixed $$ from the library have the symbol type
1099 * STT_LOPROC. They should be handled as functions too.
1101 if (elf
->hdr
->e_ident
[EI_CLASS
] == ELFCLASS64
&&
1102 elf
->hdr
->e_machine
== EM_PARISC
&&
1103 ELF_ST_TYPE(sym
->st_info
) == STT_LOPROC
)
1106 if (match(secname
, PATTERNS(ALL_INIT_SECTIONS
)))
1107 warn("%s: %s: EXPORT_SYMBOL used for init symbol. Remove __init or EXPORT_SYMBOL.\n",
1109 else if (match(secname
, PATTERNS(ALL_EXIT_SECTIONS
)))
1110 warn("%s: %s: EXPORT_SYMBOL used for exit symbol. Remove __exit or EXPORT_SYMBOL.\n",
1114 static void check_section_mismatch(struct module
*mod
, struct elf_info
*elf
,
1116 unsigned int fsecndx
, const char *fromsec
,
1117 Elf_Addr faddr
, Elf_Addr taddr
)
1119 const char *tosec
= sec_name(elf
, get_secindex(elf
, sym
));
1120 const struct sectioncheck
*mismatch
;
1122 if (module_enabled
&& elf
->export_symbol_secndx
== fsecndx
) {
1123 check_export_symbol(mod
, elf
, faddr
, tosec
, sym
);
1127 mismatch
= section_mismatch(fromsec
, tosec
);
1131 default_mismatch_handler(mod
->name
, elf
, mismatch
, sym
,
1132 fsecndx
, fromsec
, faddr
,
1136 static Elf_Addr
addend_386_rel(uint32_t *location
, unsigned int r_type
)
1140 return TO_NATIVE(*location
);
1142 return TO_NATIVE(*location
) + 4;
1145 return (Elf_Addr
)(-1);
1148 static int32_t sign_extend32(int32_t value
, int index
)
1150 uint8_t shift
= 31 - index
;
1152 return (int32_t)(value
<< shift
) >> shift
;
1155 static Elf_Addr
addend_arm_rel(void *loc
, Elf_Sym
*sym
, unsigned int r_type
)
1157 uint32_t inst
, upper
, lower
, sign
, j1
, j2
;
1163 inst
= TO_NATIVE(*(uint32_t *)loc
);
1164 return inst
+ sym
->st_value
;
1165 case R_ARM_MOVW_ABS_NC
:
1166 case R_ARM_MOVT_ABS
:
1167 inst
= TO_NATIVE(*(uint32_t *)loc
);
1168 offset
= sign_extend32(((inst
& 0xf0000) >> 4) | (inst
& 0xfff),
1170 return offset
+ sym
->st_value
;
1174 inst
= TO_NATIVE(*(uint32_t *)loc
);
1175 offset
= sign_extend32((inst
& 0x00ffffff) << 2, 25);
1176 return offset
+ sym
->st_value
+ 8;
1177 case R_ARM_THM_MOVW_ABS_NC
:
1178 case R_ARM_THM_MOVT_ABS
:
1179 upper
= TO_NATIVE(*(uint16_t *)loc
);
1180 lower
= TO_NATIVE(*((uint16_t *)loc
+ 1));
1181 offset
= sign_extend32(((upper
& 0x000f) << 12) |
1182 ((upper
& 0x0400) << 1) |
1183 ((lower
& 0x7000) >> 4) |
1186 return offset
+ sym
->st_value
;
1187 case R_ARM_THM_JUMP19
:
1194 * imm11 = lower[10:0]
1195 * imm32 = SignExtend(S:J2:J1:imm6:imm11:'0')
1197 upper
= TO_NATIVE(*(uint16_t *)loc
);
1198 lower
= TO_NATIVE(*((uint16_t *)loc
+ 1));
1200 sign
= (upper
>> 10) & 1;
1201 j1
= (lower
>> 13) & 1;
1202 j2
= (lower
>> 11) & 1;
1203 offset
= sign_extend32((sign
<< 20) | (j2
<< 19) | (j1
<< 18) |
1204 ((upper
& 0x03f) << 12) |
1205 ((lower
& 0x07ff) << 1),
1207 return offset
+ sym
->st_value
+ 4;
1208 case R_ARM_THM_PC22
:
1209 case R_ARM_THM_JUMP24
:
1213 * imm10 = upper[9:0]
1216 * imm11 = lower[10:0]
1217 * I1 = NOT(J1 XOR S)
1218 * I2 = NOT(J2 XOR S)
1219 * imm32 = SignExtend(S:I1:I2:imm10:imm11:'0')
1221 upper
= TO_NATIVE(*(uint16_t *)loc
);
1222 lower
= TO_NATIVE(*((uint16_t *)loc
+ 1));
1224 sign
= (upper
>> 10) & 1;
1225 j1
= (lower
>> 13) & 1;
1226 j2
= (lower
>> 11) & 1;
1227 offset
= sign_extend32((sign
<< 24) |
1228 ((~(j1
^ sign
) & 1) << 23) |
1229 ((~(j2
^ sign
) & 1) << 22) |
1230 ((upper
& 0x03ff) << 12) |
1231 ((lower
& 0x07ff) << 1),
1233 return offset
+ sym
->st_value
+ 4;
1236 return (Elf_Addr
)(-1);
1239 static Elf_Addr
addend_mips_rel(uint32_t *location
, unsigned int r_type
)
1243 inst
= TO_NATIVE(*location
);
1246 return inst
& 0xffff;
1248 return (inst
& 0x03ffffff) << 2;
1252 return (Elf_Addr
)(-1);
1256 #define EM_RISCV 243
1259 #ifndef R_RISCV_SUB32
1260 #define R_RISCV_SUB32 39
1263 #ifndef EM_LOONGARCH
1264 #define EM_LOONGARCH 258
1267 #ifndef R_LARCH_SUB32
1268 #define R_LARCH_SUB32 55
1271 #ifndef R_LARCH_RELAX
1272 #define R_LARCH_RELAX 100
1275 #ifndef R_LARCH_ALIGN
1276 #define R_LARCH_ALIGN 102
1279 static void get_rel_type_and_sym(struct elf_info
*elf
, uint64_t r_info
,
1280 unsigned int *r_type
, unsigned int *r_sym
)
1283 Elf64_Word r_sym
; /* Symbol index */
1284 unsigned char r_ssym
; /* Special symbol for 2nd relocation */
1285 unsigned char r_type3
; /* 3rd relocation type */
1286 unsigned char r_type2
; /* 2nd relocation type */
1287 unsigned char r_type
; /* 1st relocation type */
1288 } Elf64_Mips_R_Info
;
1290 bool is_64bit
= (elf
->hdr
->e_ident
[EI_CLASS
] == ELFCLASS64
);
1292 if (elf
->hdr
->e_machine
== EM_MIPS
&& is_64bit
) {
1293 Elf64_Mips_R_Info
*mips64_r_info
= (void *)&r_info
;
1295 *r_type
= mips64_r_info
->r_type
;
1296 *r_sym
= TO_NATIVE(mips64_r_info
->r_sym
);
1301 r_info
= TO_NATIVE((Elf64_Xword
)r_info
);
1303 r_info
= TO_NATIVE((Elf32_Word
)r_info
);
1305 *r_type
= ELF_R_TYPE(r_info
);
1306 *r_sym
= ELF_R_SYM(r_info
);
1309 static void section_rela(struct module
*mod
, struct elf_info
*elf
,
1310 unsigned int fsecndx
, const char *fromsec
,
1311 const Elf_Rela
*start
, const Elf_Rela
*stop
)
1313 const Elf_Rela
*rela
;
1315 for (rela
= start
; rela
< stop
; rela
++) {
1317 Elf_Addr taddr
, r_offset
;
1318 unsigned int r_type
, r_sym
;
1320 r_offset
= TO_NATIVE(rela
->r_offset
);
1321 get_rel_type_and_sym(elf
, rela
->r_info
, &r_type
, &r_sym
);
1323 tsym
= elf
->symtab_start
+ r_sym
;
1324 taddr
= tsym
->st_value
+ TO_NATIVE(rela
->r_addend
);
1326 switch (elf
->hdr
->e_machine
) {
1328 if (!strcmp("__ex_table", fromsec
) &&
1329 r_type
== R_RISCV_SUB32
)
1335 if (!strcmp("__ex_table", fromsec
))
1340 /* These relocs do not refer to symbols */
1346 check_section_mismatch(mod
, elf
, tsym
,
1347 fsecndx
, fromsec
, r_offset
, taddr
);
1351 static void section_rel(struct module
*mod
, struct elf_info
*elf
,
1352 unsigned int fsecndx
, const char *fromsec
,
1353 const Elf_Rel
*start
, const Elf_Rel
*stop
)
1357 for (rel
= start
; rel
< stop
; rel
++) {
1359 Elf_Addr taddr
, r_offset
;
1360 unsigned int r_type
, r_sym
;
1363 r_offset
= TO_NATIVE(rel
->r_offset
);
1364 get_rel_type_and_sym(elf
, rel
->r_info
, &r_type
, &r_sym
);
1366 loc
= sym_get_data_by_offset(elf
, fsecndx
, r_offset
);
1367 tsym
= elf
->symtab_start
+ r_sym
;
1369 switch (elf
->hdr
->e_machine
) {
1371 taddr
= addend_386_rel(loc
, r_type
);
1374 taddr
= addend_arm_rel(loc
, tsym
, r_type
);
1377 taddr
= addend_mips_rel(loc
, r_type
);
1380 fatal("Please add code to calculate addend for this architecture\n");
1383 check_section_mismatch(mod
, elf
, tsym
,
1384 fsecndx
, fromsec
, r_offset
, taddr
);
1389 * A module includes a number of sections that are discarded
1390 * either when loaded or when used as built-in.
1391 * For loaded modules all functions marked __init and all data
1392 * marked __initdata will be discarded when the module has been initialized.
1393 * Likewise for modules used built-in the sections marked __exit
1394 * are discarded because __exit marked function are supposed to be called
1395 * only when a module is unloaded which never happens for built-in modules.
1396 * The check_sec_ref() function traverses all relocation records
1397 * to find all references to a section that reference a section that will
1398 * be discarded and warns about it.
1400 static void check_sec_ref(struct module
*mod
, struct elf_info
*elf
)
1404 /* Walk through all sections */
1405 for (i
= 0; i
< elf
->num_sections
; i
++) {
1406 Elf_Shdr
*sechdr
= &elf
->sechdrs
[i
];
1408 check_section(mod
->name
, elf
, sechdr
);
1409 /* We want to process only relocation sections and not .init */
1410 if (sechdr
->sh_type
== SHT_REL
|| sechdr
->sh_type
== SHT_RELA
) {
1411 /* section to which the relocation applies */
1412 unsigned int secndx
= sechdr
->sh_info
;
1413 const char *secname
= sec_name(elf
, secndx
);
1414 const void *start
, *stop
;
1416 /* If the section is known good, skip it */
1417 if (match(secname
, section_white_list
))
1420 start
= sym_get_data_by_offset(elf
, i
, 0);
1421 stop
= start
+ sechdr
->sh_size
;
1423 if (sechdr
->sh_type
== SHT_RELA
)
1424 section_rela(mod
, elf
, secndx
, secname
,
1427 section_rel(mod
, elf
, secndx
, secname
,
1433 static char *remove_dot(char *s
)
1435 size_t n
= strcspn(s
, ".");
1438 size_t m
= strspn(s
+ n
+ 1, "0123456789");
1439 if (m
&& (s
[n
+ m
+ 1] == '.' || s
[n
+ m
+ 1] == 0))
1446 * The CRCs are recorded in .*.cmd files in the form of:
1447 * #SYMVER <name> <crc>
1449 static void extract_crcs_for_object(const char *object
, struct module
*mod
)
1451 char cmd_file
[PATH_MAX
];
1456 base
= strrchr(object
, '/');
1459 dirlen
= base
- object
;
1465 ret
= snprintf(cmd_file
, sizeof(cmd_file
), "%.*s.%s.cmd",
1466 dirlen
, object
, base
);
1467 if (ret
>= sizeof(cmd_file
)) {
1468 error("%s: too long path was truncated\n", cmd_file
);
1472 buf
= read_text_file(cmd_file
);
1475 while ((p
= strstr(p
, "\n#SYMVER "))) {
1481 name
= p
+ strlen("\n#SYMVER ");
1483 p
= strchr(name
, ' ');
1491 continue; /* skip this line */
1493 crc
= strtoul(p
, &p
, 0);
1495 continue; /* skip this line */
1497 name
[namelen
] = '\0';
1500 * sym_find_with_module() may return NULL here.
1501 * It typically occurs when CONFIG_TRIM_UNUSED_KSYMS=y.
1502 * Since commit e1327a127703, genksyms calculates CRCs of all
1503 * symbols, including trimmed ones. Ignore orphan CRCs.
1505 sym
= sym_find_with_module(name
, mod
);
1507 sym_set_crc(sym
, crc
);
1514 * The symbol versions (CRC) are recorded in the .*.cmd files.
1515 * Parse them to retrieve CRCs for the current module.
1517 static void mod_set_crcs(struct module
*mod
)
1519 char objlist
[PATH_MAX
];
1520 char *buf
, *p
, *obj
;
1523 if (mod
->is_vmlinux
) {
1524 strcpy(objlist
, ".vmlinux.objs");
1526 /* objects for a module are listed in the *.mod file. */
1527 ret
= snprintf(objlist
, sizeof(objlist
), "%s.mod", mod
->name
);
1528 if (ret
>= sizeof(objlist
)) {
1529 error("%s: too long path was truncated\n", objlist
);
1534 buf
= read_text_file(objlist
);
1537 while ((obj
= strsep(&p
, "\n")) && obj
[0])
1538 extract_crcs_for_object(obj
, mod
);
1543 static void read_symbols(const char *modname
)
1545 const char *symname
;
1550 struct elf_info info
= { };
1553 if (!parse_elf(&info
, modname
))
1556 if (!strends(modname
, ".o")) {
1557 error("%s: filename must be suffixed with .o\n", modname
);
1561 /* strip trailing .o */
1562 mod
= new_module(modname
, strlen(modname
) - strlen(".o"));
1564 if (!mod
->is_vmlinux
) {
1565 license
= get_modinfo(&info
, "license");
1567 error("missing MODULE_LICENSE() in %s\n", modname
);
1569 if (!license_is_gpl_compatible(license
)) {
1570 mod
->is_gpl_compatible
= false;
1573 license
= get_next_modinfo(&info
, "license", license
);
1576 namespace = get_modinfo(&info
, "import_ns");
1578 add_namespace(&mod
->imported_namespaces
, namespace);
1579 namespace = get_next_modinfo(&info
, "import_ns",
1583 if (extra_warn
&& !get_modinfo(&info
, "description"))
1584 warn("missing MODULE_DESCRIPTION() in %s\n", modname
);
1587 for (sym
= info
.symtab_start
; sym
< info
.symtab_stop
; sym
++) {
1588 symname
= remove_dot(info
.strtab
+ sym
->st_name
);
1590 handle_symbol(mod
, &info
, sym
, symname
);
1591 handle_moddevtable(mod
, &info
, sym
, symname
);
1594 check_sec_ref(mod
, &info
);
1596 if (!mod
->is_vmlinux
) {
1597 version
= get_modinfo(&info
, "version");
1598 if (version
|| all_versions
)
1599 get_src_version(mod
->name
, mod
->srcversion
,
1600 sizeof(mod
->srcversion
) - 1);
1603 parse_elf_finish(&info
);
1607 * Our trick to get versioning for module struct etc. - it's
1608 * never passed as an argument to an exported function, so
1609 * the automatic versioning doesn't pick it up, but it's really
1612 sym_add_unresolved("module_layout", mod
, false);
1618 static void read_symbols_from_files(const char *filename
)
1621 char fname
[PATH_MAX
];
1623 in
= fopen(filename
, "r");
1625 fatal("Can't open filenames file %s: %m", filename
);
1627 while (fgets(fname
, PATH_MAX
, in
) != NULL
) {
1628 if (strends(fname
, "\n"))
1629 fname
[strlen(fname
)-1] = '\0';
1630 read_symbols(fname
);
1638 /* We first write the generated file into memory using the
1639 * following helper, then compare to the file on disk and
1640 * only update the later if anything changed */
1642 void __attribute__((format(printf
, 2, 3))) buf_printf(struct buffer
*buf
,
1643 const char *fmt
, ...)
1650 len
= vsnprintf(tmp
, SZ
, fmt
, ap
);
1651 buf_write(buf
, tmp
, len
);
1655 void buf_write(struct buffer
*buf
, const char *s
, int len
)
1657 if (buf
->size
- buf
->pos
< len
) {
1658 buf
->size
+= len
+ SZ
;
1659 buf
->p
= xrealloc(buf
->p
, buf
->size
);
1661 strncpy(buf
->p
+ buf
->pos
, s
, len
);
1665 static void check_exports(struct module
*mod
)
1667 struct symbol
*s
, *exp
;
1669 list_for_each_entry(s
, &mod
->unresolved_symbols
, list
) {
1670 const char *basename
;
1671 exp
= find_symbol(s
->name
);
1673 if (!s
->weak
&& nr_unresolved
++ < MAX_UNRESOLVED_REPORTS
)
1674 modpost_log(!warn_unresolved
,
1675 "\"%s\" [%s.ko] undefined!\n",
1676 s
->name
, mod
->name
);
1679 if (exp
->module
== mod
) {
1680 error("\"%s\" [%s.ko] was exported without definition\n",
1681 s
->name
, mod
->name
);
1686 s
->module
= exp
->module
;
1687 s
->crc_valid
= exp
->crc_valid
;
1690 basename
= strrchr(mod
->name
, '/');
1694 basename
= mod
->name
;
1696 if (!contains_namespace(&mod
->imported_namespaces
, exp
->namespace)) {
1697 modpost_log(!allow_missing_ns_imports
,
1698 "module %s uses symbol %s from namespace %s, but does not import it.\n",
1699 basename
, exp
->name
, exp
->namespace);
1700 add_namespace(&mod
->missing_namespaces
, exp
->namespace);
1703 if (!mod
->is_gpl_compatible
&& exp
->is_gpl_only
)
1704 error("GPL-incompatible module %s.ko uses GPL-only symbol '%s'\n",
1705 basename
, exp
->name
);
1709 static void handle_white_list_exports(const char *white_list
)
1711 char *buf
, *p
, *name
;
1713 buf
= read_text_file(white_list
);
1716 while ((name
= strsep(&p
, "\n"))) {
1717 struct symbol
*sym
= find_symbol(name
);
1726 static void check_modname_len(struct module
*mod
)
1728 const char *mod_name
;
1730 mod_name
= strrchr(mod
->name
, '/');
1731 if (mod_name
== NULL
)
1732 mod_name
= mod
->name
;
1735 if (strlen(mod_name
) >= MODULE_NAME_LEN
)
1736 error("module name is too long [%s.ko]\n", mod
->name
);
1740 * Header for the generated file
1742 static void add_header(struct buffer
*b
, struct module
*mod
)
1744 buf_printf(b
, "#include <linux/module.h>\n");
1745 buf_printf(b
, "#include <linux/export-internal.h>\n");
1746 buf_printf(b
, "#include <linux/compiler.h>\n");
1747 buf_printf(b
, "\n");
1748 buf_printf(b
, "MODULE_INFO(name, KBUILD_MODNAME);\n");
1749 buf_printf(b
, "\n");
1750 buf_printf(b
, "__visible struct module __this_module\n");
1751 buf_printf(b
, "__section(\".gnu.linkonce.this_module\") = {\n");
1752 buf_printf(b
, "\t.name = KBUILD_MODNAME,\n");
1754 buf_printf(b
, "\t.init = init_module,\n");
1755 if (mod
->has_cleanup
)
1756 buf_printf(b
, "#ifdef CONFIG_MODULE_UNLOAD\n"
1757 "\t.exit = cleanup_module,\n"
1759 buf_printf(b
, "\t.arch = MODULE_ARCH_INIT,\n");
1760 buf_printf(b
, "};\n");
1762 if (!external_module
)
1763 buf_printf(b
, "\nMODULE_INFO(intree, \"Y\");\n");
1765 if (strstarts(mod
->name
, "drivers/staging"))
1766 buf_printf(b
, "\nMODULE_INFO(staging, \"Y\");\n");
1768 if (strstarts(mod
->name
, "tools/testing"))
1769 buf_printf(b
, "\nMODULE_INFO(test, \"Y\");\n");
1772 static void add_exported_symbols(struct buffer
*buf
, struct module
*mod
)
1776 /* generate struct for exported symbols */
1777 buf_printf(buf
, "\n");
1778 list_for_each_entry(sym
, &mod
->exported_symbols
, list
) {
1779 if (trim_unused_exports
&& !sym
->used
)
1782 buf_printf(buf
, "KSYMTAB_%s(%s, \"%s\", \"%s\");\n",
1783 sym
->is_func
? "FUNC" : "DATA", sym
->name
,
1784 sym
->is_gpl_only
? "_gpl" : "", sym
->namespace);
1790 /* record CRCs for exported symbols */
1791 buf_printf(buf
, "\n");
1792 list_for_each_entry(sym
, &mod
->exported_symbols
, list
) {
1793 if (trim_unused_exports
&& !sym
->used
)
1796 if (!sym
->crc_valid
)
1797 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n"
1798 "Is \"%s\" prototyped in <asm/asm-prototypes.h>?\n",
1799 sym
->name
, mod
->name
, mod
->is_vmlinux
? "" : ".ko",
1802 buf_printf(buf
, "SYMBOL_CRC(%s, 0x%08x, \"%s\");\n",
1803 sym
->name
, sym
->crc
, sym
->is_gpl_only
? "_gpl" : "");
1808 * Record CRCs for unresolved symbols
1810 static void add_versions(struct buffer
*b
, struct module
*mod
)
1817 buf_printf(b
, "\n");
1818 buf_printf(b
, "static const struct modversion_info ____versions[]\n");
1819 buf_printf(b
, "__used __section(\"__versions\") = {\n");
1821 list_for_each_entry(s
, &mod
->unresolved_symbols
, list
) {
1824 if (!s
->crc_valid
) {
1825 warn("\"%s\" [%s.ko] has no CRC!\n",
1826 s
->name
, mod
->name
);
1829 if (strlen(s
->name
) >= MODULE_NAME_LEN
) {
1830 error("too long symbol \"%s\" [%s.ko]\n",
1831 s
->name
, mod
->name
);
1834 buf_printf(b
, "\t{ %#8x, \"%s\" },\n",
1838 buf_printf(b
, "};\n");
1841 static void add_depends(struct buffer
*b
, struct module
*mod
)
1846 /* Clear ->seen flag of modules that own symbols needed by this. */
1847 list_for_each_entry(s
, &mod
->unresolved_symbols
, list
) {
1849 s
->module
->seen
= s
->module
->is_vmlinux
;
1852 buf_printf(b
, "\n");
1853 buf_printf(b
, "MODULE_INFO(depends, \"");
1854 list_for_each_entry(s
, &mod
->unresolved_symbols
, list
) {
1859 if (s
->module
->seen
)
1862 s
->module
->seen
= true;
1863 p
= strrchr(s
->module
->name
, '/');
1867 p
= s
->module
->name
;
1868 buf_printf(b
, "%s%s", first
? "" : ",", p
);
1871 buf_printf(b
, "\");\n");
1874 static void add_srcversion(struct buffer
*b
, struct module
*mod
)
1876 if (mod
->srcversion
[0]) {
1877 buf_printf(b
, "\n");
1878 buf_printf(b
, "MODULE_INFO(srcversion, \"%s\");\n",
1883 static void write_buf(struct buffer
*b
, const char *fname
)
1890 file
= fopen(fname
, "w");
1895 if (fwrite(b
->p
, 1, b
->pos
, file
) != b
->pos
) {
1899 if (fclose(file
) != 0) {
1905 static void write_if_changed(struct buffer
*b
, const char *fname
)
1911 file
= fopen(fname
, "r");
1915 if (fstat(fileno(file
), &st
) < 0)
1918 if (st
.st_size
!= b
->pos
)
1921 tmp
= xmalloc(b
->pos
);
1922 if (fread(tmp
, 1, b
->pos
, file
) != b
->pos
)
1925 if (memcmp(tmp
, b
->p
, b
->pos
) != 0)
1937 write_buf(b
, fname
);
1940 static void write_vmlinux_export_c_file(struct module
*mod
)
1942 struct buffer buf
= { };
1945 "#include <linux/export-internal.h>\n");
1947 add_exported_symbols(&buf
, mod
);
1948 write_if_changed(&buf
, ".vmlinux.export.c");
1952 /* do sanity checks, and generate *.mod.c file */
1953 static void write_mod_c_file(struct module
*mod
)
1955 struct buffer buf
= { };
1956 struct module_alias
*alias
, *next
;
1957 char fname
[PATH_MAX
];
1960 add_header(&buf
, mod
);
1961 add_exported_symbols(&buf
, mod
);
1962 add_versions(&buf
, mod
);
1963 add_depends(&buf
, mod
);
1965 buf_printf(&buf
, "\n");
1966 list_for_each_entry_safe(alias
, next
, &mod
->aliases
, node
) {
1967 buf_printf(&buf
, "MODULE_ALIAS(\"%s\");\n", alias
->str
);
1968 list_del(&alias
->node
);
1972 add_srcversion(&buf
, mod
);
1974 ret
= snprintf(fname
, sizeof(fname
), "%s.mod.c", mod
->name
);
1975 if (ret
>= sizeof(fname
)) {
1976 error("%s: too long path was truncated\n", fname
);
1980 write_if_changed(&buf
, fname
);
1986 /* parse Module.symvers file. line format:
1987 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
1989 static void read_dump(const char *fname
)
1991 char *buf
, *pos
, *line
;
1993 buf
= read_text_file(fname
);
1995 /* No symbol versions, silently ignore */
2000 while ((line
= get_line(&pos
))) {
2001 char *symname
, *namespace, *modname
, *d
, *export
;
2007 if (!(symname
= strchr(line
, '\t')))
2010 if (!(modname
= strchr(symname
, '\t')))
2013 if (!(export
= strchr(modname
, '\t')))
2016 if (!(namespace = strchr(export
, '\t')))
2018 *namespace++ = '\0';
2020 crc
= strtoul(line
, &d
, 16);
2021 if (*symname
== '\0' || *modname
== '\0' || *d
!= '\0')
2024 if (!strcmp(export
, "EXPORT_SYMBOL_GPL")) {
2026 } else if (!strcmp(export
, "EXPORT_SYMBOL")) {
2029 error("%s: unknown license %s. skip", symname
, export
);
2033 mod
= find_module(modname
);
2035 mod
= new_module(modname
, strlen(modname
));
2036 mod
->from_dump
= true;
2038 s
= sym_add_exported(symname
, mod
, gpl_only
, namespace);
2039 sym_set_crc(s
, crc
);
2045 fatal("parse error in symbol dump file\n");
2048 static void write_dump(const char *fname
)
2050 struct buffer buf
= { };
2054 list_for_each_entry(mod
, &modules
, list
) {
2057 list_for_each_entry(sym
, &mod
->exported_symbols
, list
) {
2058 if (trim_unused_exports
&& !sym
->used
)
2061 buf_printf(&buf
, "0x%08x\t%s\t%s\tEXPORT_SYMBOL%s\t%s\n",
2062 sym
->crc
, sym
->name
, mod
->name
,
2063 sym
->is_gpl_only
? "_GPL" : "",
2067 write_buf(&buf
, fname
);
2071 static void write_namespace_deps_files(const char *fname
)
2074 struct namespace_list
*ns
;
2075 struct buffer ns_deps_buf
= {};
2077 list_for_each_entry(mod
, &modules
, list
) {
2079 if (mod
->from_dump
|| list_empty(&mod
->missing_namespaces
))
2082 buf_printf(&ns_deps_buf
, "%s.ko:", mod
->name
);
2084 list_for_each_entry(ns
, &mod
->missing_namespaces
, list
)
2085 buf_printf(&ns_deps_buf
, " %s", ns
->namespace);
2087 buf_printf(&ns_deps_buf
, "\n");
2090 write_if_changed(&ns_deps_buf
, fname
);
2091 free(ns_deps_buf
.p
);
2095 struct list_head list
;
2099 static void check_host_endian(void)
2101 static const union {
2104 } endian_test
= { .c
= {0x01, 0x02} };
2106 switch (endian_test
.s
) {
2108 host_is_big_endian
= true;
2111 host_is_big_endian
= false;
2114 fatal("Unknown host endian\n");
2118 int main(int argc
, char **argv
)
2121 char *missing_namespace_deps
= NULL
;
2122 char *unused_exports_white_list
= NULL
;
2123 char *dump_write
= NULL
, *files_source
= NULL
;
2125 LIST_HEAD(dump_lists
);
2126 struct dump_list
*dl
, *dl2
;
2128 while ((opt
= getopt(argc
, argv
, "ei:MmnT:to:au:WwENd:")) != -1) {
2131 external_module
= true;
2134 dl
= xmalloc(sizeof(*dl
));
2136 list_add_tail(&dl
->list
, &dump_lists
);
2139 module_enabled
= true;
2145 ignore_missing_files
= true;
2148 dump_write
= optarg
;
2151 all_versions
= true;
2154 files_source
= optarg
;
2157 trim_unused_exports
= true;
2160 unused_exports_white_list
= optarg
;
2166 warn_unresolved
= true;
2169 sec_mismatch_warn_only
= false;
2172 allow_missing_ns_imports
= true;
2175 missing_namespace_deps
= optarg
;
2182 check_host_endian();
2184 list_for_each_entry_safe(dl
, dl2
, &dump_lists
, list
) {
2185 read_dump(dl
->file
);
2186 list_del(&dl
->list
);
2190 while (optind
< argc
)
2191 read_symbols(argv
[optind
++]);
2194 read_symbols_from_files(files_source
);
2196 list_for_each_entry(mod
, &modules
, list
) {
2197 if (mod
->from_dump
|| mod
->is_vmlinux
)
2200 check_modname_len(mod
);
2204 if (unused_exports_white_list
)
2205 handle_white_list_exports(unused_exports_white_list
);
2207 list_for_each_entry(mod
, &modules
, list
) {
2211 if (mod
->is_vmlinux
)
2212 write_vmlinux_export_c_file(mod
);
2214 write_mod_c_file(mod
);
2217 if (missing_namespace_deps
)
2218 write_namespace_deps_files(missing_namespace_deps
);
2221 write_dump(dump_write
);
2222 if (sec_mismatch_count
&& !sec_mismatch_warn_only
)
2223 error("Section mismatches detected.\n"
2224 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
2226 if (nr_unresolved
> MAX_UNRESOLVED_REPORTS
)
2227 warn("suppressed %u unresolved symbol warnings because there were too many)\n",
2228 nr_unresolved
- MAX_UNRESOLVED_REPORTS
);
2230 return error_occurred
? 1 : 0;