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 ...
22 #include "../../include/generated/autoconf.h"
23 #include "../../include/linux/license.h"
24 #include "../../include/linux/export.h"
26 /* Are we using CONFIG_MODVERSIONS? */
28 /* Warn about undefined symbols? (do so if we have vmlinux) */
30 /* Is CONFIG_MODULE_SRCVERSION_ALL set? */
31 static int all_versions
= 0;
32 /* If we are modposting external module set to 1 */
33 static int external_module
= 0;
34 /* Warn about section mismatch in vmlinux if set to 1 */
35 static int vmlinux_section_warnings
= 1;
36 /* Only warn about unresolved symbols */
37 static int warn_unresolved
= 0;
38 /* How a symbol is exported */
39 static int sec_mismatch_count
= 0;
40 static int sec_mismatch_verbose
= 1;
41 /* ignore missing files */
42 static int ignore_missing_files
;
45 export_plain
, export_unused
, export_gpl
,
46 export_unused_gpl
, export_gpl_future
, export_unknown
49 #define PRINTF __attribute__ ((format (printf, 1, 2)))
51 PRINTF
void fatal(const char *fmt
, ...)
55 fprintf(stderr
, "FATAL: ");
57 va_start(arglist
, fmt
);
58 vfprintf(stderr
, fmt
, arglist
);
64 PRINTF
void warn(const char *fmt
, ...)
68 fprintf(stderr
, "WARNING: ");
70 va_start(arglist
, fmt
);
71 vfprintf(stderr
, fmt
, arglist
);
75 PRINTF
void merror(const char *fmt
, ...)
79 fprintf(stderr
, "ERROR: ");
81 va_start(arglist
, fmt
);
82 vfprintf(stderr
, fmt
, arglist
);
86 static inline bool strends(const char *str
, const char *postfix
)
88 if (strlen(str
) < strlen(postfix
))
91 return strcmp(str
+ strlen(str
) - strlen(postfix
), postfix
) == 0;
94 static int is_vmlinux(const char *modname
)
98 myname
= strrchr(modname
, '/');
104 return (strcmp(myname
, "vmlinux") == 0) ||
105 (strcmp(myname
, "vmlinux.o") == 0);
108 void *do_nofail(void *ptr
, const char *expr
)
111 fatal("modpost: Memory allocation failure: %s.\n", expr
);
116 /* A list of all modules we processed */
117 static struct module
*modules
;
119 static struct module
*find_module(char *modname
)
123 for (mod
= modules
; mod
; mod
= mod
->next
)
124 if (strcmp(mod
->name
, modname
) == 0)
129 static struct module
*new_module(const char *modname
)
134 mod
= NOFAIL(malloc(sizeof(*mod
)));
135 memset(mod
, 0, sizeof(*mod
));
136 p
= NOFAIL(strdup(modname
));
138 /* strip trailing .o */
139 if (strends(p
, ".o")) {
140 p
[strlen(p
) - 2] = '\0';
146 mod
->gpl_compatible
= -1;
153 /* A hash of all exported symbols,
154 * struct symbol is also used for lists of unresolved symbols */
156 #define SYMBOL_HASH_SIZE 1024
160 struct module
*module
;
164 unsigned int vmlinux
:1; /* 1 if symbol is defined in vmlinux */
165 unsigned int kernel
:1; /* 1 if symbol is from kernel
166 * (only for external modules) **/
167 unsigned int preloaded
:1; /* 1 if symbol from Module.symvers, or crc */
168 enum export export
; /* Type of export */
172 static struct symbol
*symbolhash
[SYMBOL_HASH_SIZE
];
174 /* This is based on the hash agorithm from gdbm, via tdb */
175 static inline unsigned int tdb_hash(const char *name
)
177 unsigned value
; /* Used to compute the hash value. */
178 unsigned i
; /* Used to cycle through random values. */
180 /* Set the initial value from the key size. */
181 for (value
= 0x238F13AF * strlen(name
), i
= 0; name
[i
]; i
++)
182 value
= (value
+ (((unsigned char *)name
)[i
] << (i
*5 % 24)));
184 return (1103515243 * value
+ 12345);
188 * Allocate a new symbols for use in the hash of exported symbols or
189 * the list of unresolved symbols per module
191 static struct symbol
*alloc_symbol(const char *name
, unsigned int weak
,
194 struct symbol
*s
= NOFAIL(malloc(sizeof(*s
) + strlen(name
) + 1));
196 memset(s
, 0, sizeof(*s
));
197 strcpy(s
->name
, name
);
203 /* For the hash of exported symbols */
204 static struct symbol
*new_symbol(const char *name
, struct module
*module
,
210 hash
= tdb_hash(name
) % SYMBOL_HASH_SIZE
;
211 new = symbolhash
[hash
] = alloc_symbol(name
, 0, symbolhash
[hash
]);
212 new->module
= module
;
213 new->export
= export
;
217 static struct symbol
*find_symbol(const char *name
)
221 /* For our purposes, .foo matches foo. PPC64 needs this. */
225 for (s
= symbolhash
[tdb_hash(name
) % SYMBOL_HASH_SIZE
]; s
; s
= s
->next
) {
226 if (strcmp(s
->name
, name
) == 0)
236 { .str
= "EXPORT_SYMBOL", .export
= export_plain
},
237 { .str
= "EXPORT_UNUSED_SYMBOL", .export
= export_unused
},
238 { .str
= "EXPORT_SYMBOL_GPL", .export
= export_gpl
},
239 { .str
= "EXPORT_UNUSED_SYMBOL_GPL", .export
= export_unused_gpl
},
240 { .str
= "EXPORT_SYMBOL_GPL_FUTURE", .export
= export_gpl_future
},
241 { .str
= "(unknown)", .export
= export_unknown
},
245 static const char *export_str(enum export ex
)
247 return export_list
[ex
].str
;
250 static enum export
export_no(const char *s
)
255 return export_unknown
;
256 for (i
= 0; export_list
[i
].export
!= export_unknown
; i
++) {
257 if (strcmp(export_list
[i
].str
, s
) == 0)
258 return export_list
[i
].export
;
260 return export_unknown
;
263 static const char *sec_name(struct elf_info
*elf
, int secindex
);
265 #define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
267 static enum export
export_from_secname(struct elf_info
*elf
, unsigned int sec
)
269 const char *secname
= sec_name(elf
, sec
);
271 if (strstarts(secname
, "___ksymtab+"))
273 else if (strstarts(secname
, "___ksymtab_unused+"))
274 return export_unused
;
275 else if (strstarts(secname
, "___ksymtab_gpl+"))
277 else if (strstarts(secname
, "___ksymtab_unused_gpl+"))
278 return export_unused_gpl
;
279 else if (strstarts(secname
, "___ksymtab_gpl_future+"))
280 return export_gpl_future
;
282 return export_unknown
;
285 static enum export
export_from_sec(struct elf_info
*elf
, unsigned int sec
)
287 if (sec
== elf
->export_sec
)
289 else if (sec
== elf
->export_unused_sec
)
290 return export_unused
;
291 else if (sec
== elf
->export_gpl_sec
)
293 else if (sec
== elf
->export_unused_gpl_sec
)
294 return export_unused_gpl
;
295 else if (sec
== elf
->export_gpl_future_sec
)
296 return export_gpl_future
;
298 return export_unknown
;
302 * Add an exported symbol - it may have already been added without a
303 * CRC, in this case just update the CRC
305 static struct symbol
*sym_add_exported(const char *name
, struct module
*mod
,
308 struct symbol
*s
= find_symbol(name
);
311 s
= new_symbol(name
, mod
, export
);
314 warn("%s: '%s' exported twice. Previous export "
315 "was in %s%s\n", mod
->name
, name
,
317 is_vmlinux(s
->module
->name
) ?"":".ko");
319 /* In case Modules.symvers was out of date */
324 s
->vmlinux
= is_vmlinux(mod
->name
);
330 static void sym_update_crc(const char *name
, struct module
*mod
,
331 unsigned int crc
, enum export export
)
333 struct symbol
*s
= find_symbol(name
);
336 s
= new_symbol(name
, mod
, export
);
337 /* Don't complain when we find it later. */
344 void *grab_file(const char *filename
, unsigned long *size
)
347 void *map
= MAP_FAILED
;
350 fd
= open(filename
, O_RDONLY
);
357 map
= mmap(NULL
, *size
, PROT_READ
|PROT_WRITE
, MAP_PRIVATE
, fd
, 0);
361 if (map
== MAP_FAILED
)
367 * Return a copy of the next line in a mmap'ed file.
368 * spaces in the beginning of the line is trimmed away.
369 * Return a pointer to a static buffer.
371 char *get_next_line(unsigned long *pos
, void *file
, unsigned long size
)
373 static char line
[4096];
376 signed char *p
= (signed char *)file
+ *pos
;
379 for (; *pos
< size
; (*pos
)++) {
380 if (skip
&& isspace(*p
)) {
385 if (*p
!= '\n' && (*pos
< size
)) {
389 break; /* Too long, stop */
400 void release_file(void *file
, unsigned long size
)
405 static int parse_elf(struct elf_info
*info
, const char *filename
)
411 const char *secstrings
;
412 unsigned int symtab_idx
= ~0U, symtab_shndx_idx
= ~0U;
414 hdr
= grab_file(filename
, &info
->size
);
416 if (ignore_missing_files
) {
417 fprintf(stderr
, "%s: %s (ignored)\n", filename
,
425 if (info
->size
< sizeof(*hdr
)) {
426 /* file too small, assume this is an empty .o file */
429 /* Is this a valid ELF file? */
430 if ((hdr
->e_ident
[EI_MAG0
] != ELFMAG0
) ||
431 (hdr
->e_ident
[EI_MAG1
] != ELFMAG1
) ||
432 (hdr
->e_ident
[EI_MAG2
] != ELFMAG2
) ||
433 (hdr
->e_ident
[EI_MAG3
] != ELFMAG3
)) {
434 /* Not an ELF file - silently ignore it */
437 /* Fix endianness in ELF header */
438 hdr
->e_type
= TO_NATIVE(hdr
->e_type
);
439 hdr
->e_machine
= TO_NATIVE(hdr
->e_machine
);
440 hdr
->e_version
= TO_NATIVE(hdr
->e_version
);
441 hdr
->e_entry
= TO_NATIVE(hdr
->e_entry
);
442 hdr
->e_phoff
= TO_NATIVE(hdr
->e_phoff
);
443 hdr
->e_shoff
= TO_NATIVE(hdr
->e_shoff
);
444 hdr
->e_flags
= TO_NATIVE(hdr
->e_flags
);
445 hdr
->e_ehsize
= TO_NATIVE(hdr
->e_ehsize
);
446 hdr
->e_phentsize
= TO_NATIVE(hdr
->e_phentsize
);
447 hdr
->e_phnum
= TO_NATIVE(hdr
->e_phnum
);
448 hdr
->e_shentsize
= TO_NATIVE(hdr
->e_shentsize
);
449 hdr
->e_shnum
= TO_NATIVE(hdr
->e_shnum
);
450 hdr
->e_shstrndx
= TO_NATIVE(hdr
->e_shstrndx
);
451 sechdrs
= (void *)hdr
+ hdr
->e_shoff
;
452 info
->sechdrs
= sechdrs
;
454 /* Check if file offset is correct */
455 if (hdr
->e_shoff
> info
->size
) {
456 fatal("section header offset=%lu in file '%s' is bigger than "
457 "filesize=%lu\n", (unsigned long)hdr
->e_shoff
,
458 filename
, info
->size
);
462 if (hdr
->e_shnum
== SHN_UNDEF
) {
464 * There are more than 64k sections,
465 * read count from .sh_size.
467 info
->num_sections
= TO_NATIVE(sechdrs
[0].sh_size
);
470 info
->num_sections
= hdr
->e_shnum
;
472 if (hdr
->e_shstrndx
== SHN_XINDEX
) {
473 info
->secindex_strings
= TO_NATIVE(sechdrs
[0].sh_link
);
476 info
->secindex_strings
= hdr
->e_shstrndx
;
479 /* Fix endianness in section headers */
480 for (i
= 0; i
< info
->num_sections
; i
++) {
481 sechdrs
[i
].sh_name
= TO_NATIVE(sechdrs
[i
].sh_name
);
482 sechdrs
[i
].sh_type
= TO_NATIVE(sechdrs
[i
].sh_type
);
483 sechdrs
[i
].sh_flags
= TO_NATIVE(sechdrs
[i
].sh_flags
);
484 sechdrs
[i
].sh_addr
= TO_NATIVE(sechdrs
[i
].sh_addr
);
485 sechdrs
[i
].sh_offset
= TO_NATIVE(sechdrs
[i
].sh_offset
);
486 sechdrs
[i
].sh_size
= TO_NATIVE(sechdrs
[i
].sh_size
);
487 sechdrs
[i
].sh_link
= TO_NATIVE(sechdrs
[i
].sh_link
);
488 sechdrs
[i
].sh_info
= TO_NATIVE(sechdrs
[i
].sh_info
);
489 sechdrs
[i
].sh_addralign
= TO_NATIVE(sechdrs
[i
].sh_addralign
);
490 sechdrs
[i
].sh_entsize
= TO_NATIVE(sechdrs
[i
].sh_entsize
);
492 /* Find symbol table. */
493 secstrings
= (void *)hdr
+ sechdrs
[info
->secindex_strings
].sh_offset
;
494 for (i
= 1; i
< info
->num_sections
; i
++) {
496 int nobits
= sechdrs
[i
].sh_type
== SHT_NOBITS
;
498 if (!nobits
&& sechdrs
[i
].sh_offset
> info
->size
) {
499 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
500 "sizeof(*hrd)=%zu\n", filename
,
501 (unsigned long)sechdrs
[i
].sh_offset
,
505 secname
= secstrings
+ sechdrs
[i
].sh_name
;
506 if (strcmp(secname
, ".modinfo") == 0) {
508 fatal("%s has NOBITS .modinfo\n", filename
);
509 info
->modinfo
= (void *)hdr
+ sechdrs
[i
].sh_offset
;
510 info
->modinfo_len
= sechdrs
[i
].sh_size
;
511 } else if (strcmp(secname
, "__ksymtab") == 0)
512 info
->export_sec
= i
;
513 else if (strcmp(secname
, "__ksymtab_unused") == 0)
514 info
->export_unused_sec
= i
;
515 else if (strcmp(secname
, "__ksymtab_gpl") == 0)
516 info
->export_gpl_sec
= i
;
517 else if (strcmp(secname
, "__ksymtab_unused_gpl") == 0)
518 info
->export_unused_gpl_sec
= i
;
519 else if (strcmp(secname
, "__ksymtab_gpl_future") == 0)
520 info
->export_gpl_future_sec
= i
;
522 if (sechdrs
[i
].sh_type
== SHT_SYMTAB
) {
523 unsigned int sh_link_idx
;
525 info
->symtab_start
= (void *)hdr
+
526 sechdrs
[i
].sh_offset
;
527 info
->symtab_stop
= (void *)hdr
+
528 sechdrs
[i
].sh_offset
+ sechdrs
[i
].sh_size
;
529 sh_link_idx
= sechdrs
[i
].sh_link
;
530 info
->strtab
= (void *)hdr
+
531 sechdrs
[sh_link_idx
].sh_offset
;
534 /* 32bit section no. table? ("more than 64k sections") */
535 if (sechdrs
[i
].sh_type
== SHT_SYMTAB_SHNDX
) {
536 symtab_shndx_idx
= i
;
537 info
->symtab_shndx_start
= (void *)hdr
+
538 sechdrs
[i
].sh_offset
;
539 info
->symtab_shndx_stop
= (void *)hdr
+
540 sechdrs
[i
].sh_offset
+ sechdrs
[i
].sh_size
;
543 if (!info
->symtab_start
)
544 fatal("%s has no symtab?\n", filename
);
546 /* Fix endianness in symbols */
547 for (sym
= info
->symtab_start
; sym
< info
->symtab_stop
; sym
++) {
548 sym
->st_shndx
= TO_NATIVE(sym
->st_shndx
);
549 sym
->st_name
= TO_NATIVE(sym
->st_name
);
550 sym
->st_value
= TO_NATIVE(sym
->st_value
);
551 sym
->st_size
= TO_NATIVE(sym
->st_size
);
554 if (symtab_shndx_idx
!= ~0U) {
556 if (symtab_idx
!= sechdrs
[symtab_shndx_idx
].sh_link
)
557 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
558 filename
, sechdrs
[symtab_shndx_idx
].sh_link
,
561 for (p
= info
->symtab_shndx_start
; p
< info
->symtab_shndx_stop
;
569 static void parse_elf_finish(struct elf_info
*info
)
571 release_file(info
->hdr
, info
->size
);
574 static int ignore_undef_symbol(struct elf_info
*info
, const char *symname
)
576 /* ignore __this_module, it will be resolved shortly */
577 if (strcmp(symname
, VMLINUX_SYMBOL_STR(__this_module
)) == 0)
579 /* ignore global offset table */
580 if (strcmp(symname
, "_GLOBAL_OFFSET_TABLE_") == 0)
582 if (info
->hdr
->e_machine
== EM_PPC
)
583 /* Special register function linked on all modules during final link of .ko */
584 if (strncmp(symname
, "_restgpr_", sizeof("_restgpr_") - 1) == 0 ||
585 strncmp(symname
, "_savegpr_", sizeof("_savegpr_") - 1) == 0 ||
586 strncmp(symname
, "_rest32gpr_", sizeof("_rest32gpr_") - 1) == 0 ||
587 strncmp(symname
, "_save32gpr_", sizeof("_save32gpr_") - 1) == 0 ||
588 strncmp(symname
, "_restvr_", sizeof("_restvr_") - 1) == 0 ||
589 strncmp(symname
, "_savevr_", sizeof("_savevr_") - 1) == 0)
591 if (info
->hdr
->e_machine
== EM_PPC64
)
592 /* Special register function linked on all modules during final link of .ko */
593 if (strncmp(symname
, "_restgpr0_", sizeof("_restgpr0_") - 1) == 0 ||
594 strncmp(symname
, "_savegpr0_", sizeof("_savegpr0_") - 1) == 0 ||
595 strncmp(symname
, "_restvr_", sizeof("_restvr_") - 1) == 0 ||
596 strncmp(symname
, "_savevr_", sizeof("_savevr_") - 1) == 0)
598 /* Do not ignore this symbol */
602 #define CRC_PFX VMLINUX_SYMBOL_STR(__crc_)
603 #define KSYMTAB_PFX VMLINUX_SYMBOL_STR(__ksymtab_)
605 static void handle_modversions(struct module
*mod
, struct elf_info
*info
,
606 Elf_Sym
*sym
, const char *symname
)
611 if ((!is_vmlinux(mod
->name
) || mod
->is_dot_o
) &&
612 strncmp(symname
, "__ksymtab", 9) == 0)
613 export
= export_from_secname(info
, get_secindex(info
, sym
));
615 export
= export_from_sec(info
, get_secindex(info
, sym
));
618 if (strncmp(symname
, CRC_PFX
, strlen(CRC_PFX
)) == 0) {
619 crc
= (unsigned int) sym
->st_value
;
620 sym_update_crc(symname
+ strlen(CRC_PFX
), mod
, crc
,
624 switch (sym
->st_shndx
) {
626 if (!strncmp(symname
, "__gnu_lto_", sizeof("__gnu_lto_")-1)) {
627 /* Should warn here, but modpost runs before the linker */
629 warn("\"%s\" [%s] is COMMON symbol\n", symname
, mod
->name
);
632 /* undefined symbol */
633 if (ELF_ST_BIND(sym
->st_info
) != STB_GLOBAL
&&
634 ELF_ST_BIND(sym
->st_info
) != STB_WEAK
)
636 if (ignore_undef_symbol(info
, symname
))
638 /* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
639 #if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
640 /* add compatibility with older glibc */
641 #ifndef STT_SPARC_REGISTER
642 #define STT_SPARC_REGISTER STT_REGISTER
644 if (info
->hdr
->e_machine
== EM_SPARC
||
645 info
->hdr
->e_machine
== EM_SPARCV9
) {
646 /* Ignore register directives. */
647 if (ELF_ST_TYPE(sym
->st_info
) == STT_SPARC_REGISTER
)
649 if (symname
[0] == '.') {
650 char *munged
= strdup(symname
);
652 munged
[1] = toupper(munged
[1]);
658 #ifdef CONFIG_HAVE_UNDERSCORE_SYMBOL_PREFIX
659 if (symname
[0] != '_')
664 mod
->unres
= alloc_symbol(symname
,
665 ELF_ST_BIND(sym
->st_info
) == STB_WEAK
,
669 /* All exported symbols */
670 if (strncmp(symname
, KSYMTAB_PFX
, strlen(KSYMTAB_PFX
)) == 0) {
671 sym_add_exported(symname
+ strlen(KSYMTAB_PFX
), mod
,
674 if (strcmp(symname
, VMLINUX_SYMBOL_STR(init_module
)) == 0)
676 if (strcmp(symname
, VMLINUX_SYMBOL_STR(cleanup_module
)) == 0)
677 mod
->has_cleanup
= 1;
683 * Parse tag=value strings from .modinfo section
685 static char *next_string(char *string
, unsigned long *secsize
)
687 /* Skip non-zero chars */
690 if ((*secsize
)-- <= 1)
694 /* Skip any zero padding. */
697 if ((*secsize
)-- <= 1)
703 static char *get_next_modinfo(void *modinfo
, unsigned long modinfo_len
,
704 const char *tag
, char *info
)
707 unsigned int taglen
= strlen(tag
);
708 unsigned long size
= modinfo_len
;
711 size
-= info
- (char *)modinfo
;
712 modinfo
= next_string(info
, &size
);
715 for (p
= modinfo
; p
; p
= next_string(p
, &size
)) {
716 if (strncmp(p
, tag
, taglen
) == 0 && p
[taglen
] == '=')
717 return p
+ taglen
+ 1;
722 static char *get_modinfo(void *modinfo
, unsigned long modinfo_len
,
726 return get_next_modinfo(modinfo
, modinfo_len
, tag
, NULL
);
730 * Test if string s ends in string sub
733 static int strrcmp(const char *s
, const char *sub
)
741 sublen
= strlen(sub
);
743 if ((slen
== 0) || (sublen
== 0))
749 return memcmp(s
+ slen
- sublen
, sub
, sublen
);
752 static const char *sym_name(struct elf_info
*elf
, Elf_Sym
*sym
)
755 return elf
->strtab
+ sym
->st_name
;
760 static const char *sec_name(struct elf_info
*elf
, int secindex
)
762 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
763 return (void *)elf
->hdr
+
764 elf
->sechdrs
[elf
->secindex_strings
].sh_offset
+
765 sechdrs
[secindex
].sh_name
;
768 static const char *sech_name(struct elf_info
*elf
, Elf_Shdr
*sechdr
)
770 return (void *)elf
->hdr
+
771 elf
->sechdrs
[elf
->secindex_strings
].sh_offset
+
775 /* if sym is empty or point to a string
776 * like ".[0-9]+" then return 1.
777 * This is the optional prefix added by ld to some sections
779 static int number_prefix(const char *sym
)
787 if (c
< '0' || c
> '9')
793 /* The pattern is an array of simple patterns.
794 * "foo" will match an exact string equal to "foo"
795 * "*foo" will match a string that ends with "foo"
796 * "foo*" will match a string that begins with "foo"
797 * "foo$" will match a string equal to "foo" or "foo.1"
798 * where the '1' can be any number including several digits.
799 * The $ syntax is for sections where ld append a dot number
800 * to make section name unique.
802 static int match(const char *sym
, const char * const pat
[])
807 const char *endp
= p
+ strlen(p
) - 1;
811 if (strrcmp(sym
, p
+ 1) == 0)
815 else if (*endp
== '*') {
816 if (strncmp(sym
, p
, strlen(p
) - 1) == 0)
820 else if (*endp
== '$') {
821 if (strncmp(sym
, p
, strlen(p
) - 1) == 0) {
822 if (number_prefix(sym
+ strlen(p
) - 1))
828 if (strcmp(p
, sym
) == 0)
836 /* sections that we do not want to do full section mismatch check on */
837 static const char *section_white_list
[] =
841 ".cranges", /* sh64 */
842 ".zdebug*", /* Compressed debug sections. */
843 ".GCC-command-line", /* mn10300 */
844 ".GCC.command.line", /* record-gcc-switches, non mn10300 */
845 ".mdebug*", /* alpha, score, mips etc. */
846 ".pdr", /* alpha, score, mips etc. */
851 ".xt.prop", /* xtensa */
852 ".xt.lit", /* xtensa */
853 ".arcextmap*", /* arc */
854 ".gnu.linkonce.arcext*", /* arc : modules */
860 * This is used to find sections missing the SHF_ALLOC flag.
861 * The cause of this is often a section specified in assembler
862 * without "ax" / "aw".
864 static void check_section(const char *modname
, struct elf_info
*elf
,
867 const char *sec
= sech_name(elf
, sechdr
);
869 if (sechdr
->sh_type
== SHT_PROGBITS
&&
870 !(sechdr
->sh_flags
& SHF_ALLOC
) &&
871 !match(sec
, section_white_list
)) {
872 warn("%s (%s): unexpected non-allocatable section.\n"
873 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
874 "Note that for example <linux/init.h> contains\n"
875 "section definitions for use in .S files.\n\n",
882 #define ALL_INIT_DATA_SECTIONS \
883 ".init.setup$", ".init.rodata$", ".meminit.rodata$", \
884 ".init.data$", ".meminit.data$"
885 #define ALL_EXIT_DATA_SECTIONS \
886 ".exit.data$", ".memexit.data$"
888 #define ALL_INIT_TEXT_SECTIONS \
889 ".init.text$", ".meminit.text$"
890 #define ALL_EXIT_TEXT_SECTIONS \
891 ".exit.text$", ".memexit.text$"
893 #define ALL_PCI_INIT_SECTIONS \
894 ".pci_fixup_early$", ".pci_fixup_header$", ".pci_fixup_final$", \
895 ".pci_fixup_enable$", ".pci_fixup_resume$", \
896 ".pci_fixup_resume_early$", ".pci_fixup_suspend$"
898 #define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
899 #define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
901 #define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
902 #define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
904 #define DATA_SECTIONS ".data$", ".data.rel$"
905 #define TEXT_SECTIONS ".text$", ".text.unlikely$"
907 #define INIT_SECTIONS ".init.*"
908 #define MEM_INIT_SECTIONS ".meminit.*"
910 #define EXIT_SECTIONS ".exit.*"
911 #define MEM_EXIT_SECTIONS ".memexit.*"
913 /* init data sections */
914 static const char *init_data_sections
[] = { ALL_INIT_DATA_SECTIONS
, NULL
};
916 /* all init sections */
917 static const char *init_sections
[] = { ALL_INIT_SECTIONS
, NULL
};
919 /* All init and exit sections (code + data) */
920 static const char *init_exit_sections
[] =
921 {ALL_INIT_SECTIONS
, ALL_EXIT_SECTIONS
, NULL
};
924 static const char *data_sections
[] = { DATA_SECTIONS
, NULL
};
927 /* symbols in .data that may refer to init/exit sections */
928 #define DEFAULT_SYMBOL_WHITE_LIST \
930 "*_template", /* scsi uses *_template a lot */ \
931 "*_timer", /* arm uses ops structures named _timer a lot */ \
932 "*_sht", /* scsi also used *_sht to some extent */ \
938 static const char *head_sections
[] = { ".head.text*", NULL
};
939 static const char *linker_symbols
[] =
940 { "__init_begin", "_sinittext", "_einittext", NULL
};
947 XXXINIT_TO_SOME_INIT
,
948 XXXEXIT_TO_SOME_EXIT
,
949 ANY_INIT_TO_ANY_EXIT
,
950 ANY_EXIT_TO_ANY_INIT
,
954 struct sectioncheck
{
955 const char *fromsec
[20];
956 const char *tosec
[20];
957 enum mismatch mismatch
;
958 const char *symbol_white_list
[20];
961 const struct sectioncheck sectioncheck
[] = {
962 /* Do not reference init/exit code/data from
963 * normal code and data
966 .fromsec
= { TEXT_SECTIONS
, NULL
},
967 .tosec
= { ALL_INIT_SECTIONS
, NULL
},
968 .mismatch
= TEXT_TO_ANY_INIT
,
969 .symbol_white_list
= { DEFAULT_SYMBOL_WHITE_LIST
, NULL
},
972 .fromsec
= { DATA_SECTIONS
, NULL
},
973 .tosec
= { ALL_XXXINIT_SECTIONS
, NULL
},
974 .mismatch
= DATA_TO_ANY_INIT
,
975 .symbol_white_list
= { DEFAULT_SYMBOL_WHITE_LIST
, NULL
},
978 .fromsec
= { DATA_SECTIONS
, NULL
},
979 .tosec
= { INIT_SECTIONS
, NULL
},
980 .mismatch
= DATA_TO_ANY_INIT
,
981 .symbol_white_list
= {
982 "*_template", "*_timer", "*_sht", "*_ops",
983 "*_probe", "*_probe_one", "*_console", NULL
987 .fromsec
= { TEXT_SECTIONS
, NULL
},
988 .tosec
= { ALL_EXIT_SECTIONS
, NULL
},
989 .mismatch
= TEXT_TO_ANY_EXIT
,
990 .symbol_white_list
= { DEFAULT_SYMBOL_WHITE_LIST
, NULL
},
993 .fromsec
= { DATA_SECTIONS
, NULL
},
994 .tosec
= { ALL_EXIT_SECTIONS
, NULL
},
995 .mismatch
= DATA_TO_ANY_EXIT
,
996 .symbol_white_list
= { DEFAULT_SYMBOL_WHITE_LIST
, NULL
},
998 /* Do not reference init code/data from meminit code/data */
1000 .fromsec
= { ALL_XXXINIT_SECTIONS
, NULL
},
1001 .tosec
= { INIT_SECTIONS
, NULL
},
1002 .mismatch
= XXXINIT_TO_SOME_INIT
,
1003 .symbol_white_list
= { DEFAULT_SYMBOL_WHITE_LIST
, NULL
},
1005 /* Do not reference exit code/data from memexit code/data */
1007 .fromsec
= { ALL_XXXEXIT_SECTIONS
, NULL
},
1008 .tosec
= { EXIT_SECTIONS
, NULL
},
1009 .mismatch
= XXXEXIT_TO_SOME_EXIT
,
1010 .symbol_white_list
= { DEFAULT_SYMBOL_WHITE_LIST
, NULL
},
1012 /* Do not use exit code/data from init code */
1014 .fromsec
= { ALL_INIT_SECTIONS
, NULL
},
1015 .tosec
= { ALL_EXIT_SECTIONS
, NULL
},
1016 .mismatch
= ANY_INIT_TO_ANY_EXIT
,
1017 .symbol_white_list
= { DEFAULT_SYMBOL_WHITE_LIST
, NULL
},
1019 /* Do not use init code/data from exit code */
1021 .fromsec
= { ALL_EXIT_SECTIONS
, NULL
},
1022 .tosec
= { ALL_INIT_SECTIONS
, NULL
},
1023 .mismatch
= ANY_EXIT_TO_ANY_INIT
,
1024 .symbol_white_list
= { DEFAULT_SYMBOL_WHITE_LIST
, NULL
},
1027 .fromsec
= { ALL_PCI_INIT_SECTIONS
, NULL
},
1028 .tosec
= { INIT_SECTIONS
, NULL
},
1029 .mismatch
= ANY_INIT_TO_ANY_EXIT
,
1030 .symbol_white_list
= { NULL
},
1032 /* Do not export init/exit functions or data */
1034 .fromsec
= { "__ksymtab*", NULL
},
1035 .tosec
= { INIT_SECTIONS
, EXIT_SECTIONS
, NULL
},
1036 .mismatch
= EXPORT_TO_INIT_EXIT
,
1037 .symbol_white_list
= { DEFAULT_SYMBOL_WHITE_LIST
, NULL
},
1041 static const struct sectioncheck
*section_mismatch(
1042 const char *fromsec
, const char *tosec
)
1045 int elems
= sizeof(sectioncheck
) / sizeof(struct sectioncheck
);
1046 const struct sectioncheck
*check
= §ioncheck
[0];
1048 for (i
= 0; i
< elems
; i
++) {
1049 if (match(fromsec
, check
->fromsec
) &&
1050 match(tosec
, check
->tosec
))
1058 * Whitelist to allow certain references to pass with no warning.
1061 * If a module parameter is declared __initdata and permissions=0
1062 * then this is legal despite the warning generated.
1063 * We cannot see value of permissions here, so just ignore
1065 * The pattern is identified by:
1066 * tosec = .init.data
1071 * module_param_call() ops can refer to __init set function if permissions=0
1072 * The pattern is identified by:
1073 * tosec = .init.text
1075 * atsym = __param_ops_*
1078 * Many drivers utilise a *driver container with references to
1079 * add, remove, probe functions etc.
1080 * the pattern is identified by:
1081 * tosec = init or exit section
1082 * fromsec = data section
1083 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1084 * *probe_one, *_console, *_timer
1087 * Whitelist all references from .head.text to any init section
1090 * Some symbols belong to init section but still it is ok to reference
1091 * these from non-init sections as these symbols don't have any memory
1092 * allocated for them and symbol address and value are same. So even
1093 * if init section is freed, its ok to reference those symbols.
1094 * For ex. symbols marking the init section boundaries.
1095 * This pattern is identified by
1096 * refsymname = __init_begin, _sinittext, _einittext
1099 static int secref_whitelist(const struct sectioncheck
*mismatch
,
1100 const char *fromsec
, const char *fromsym
,
1101 const char *tosec
, const char *tosym
)
1103 /* Check for pattern 1 */
1104 if (match(tosec
, init_data_sections
) &&
1105 match(fromsec
, data_sections
) &&
1106 (strncmp(fromsym
, "__param", strlen("__param")) == 0))
1109 /* Check for pattern 1a */
1110 if (strcmp(tosec
, ".init.text") == 0 &&
1111 match(fromsec
, data_sections
) &&
1112 (strncmp(fromsym
, "__param_ops_", strlen("__param_ops_")) == 0))
1115 /* Check for pattern 2 */
1116 if (match(tosec
, init_exit_sections
) &&
1117 match(fromsec
, data_sections
) &&
1118 match(fromsym
, mismatch
->symbol_white_list
))
1121 /* Check for pattern 3 */
1122 if (match(fromsec
, head_sections
) &&
1123 match(tosec
, init_sections
))
1126 /* Check for pattern 4 */
1127 if (match(tosym
, linker_symbols
))
1134 * Find symbol based on relocation record info.
1135 * In some cases the symbol supplied is a valid symbol so
1136 * return refsym. If st_name != 0 we assume this is a valid symbol.
1137 * In other cases the symbol needs to be looked up in the symbol table
1138 * based on section and address.
1140 static Elf_Sym
*find_elf_symbol(struct elf_info
*elf
, Elf64_Sword addr
,
1144 Elf_Sym
*near
= NULL
;
1145 Elf64_Sword distance
= 20;
1147 unsigned int relsym_secindex
;
1149 if (relsym
->st_name
!= 0)
1152 relsym_secindex
= get_secindex(elf
, relsym
);
1153 for (sym
= elf
->symtab_start
; sym
< elf
->symtab_stop
; sym
++) {
1154 if (get_secindex(elf
, sym
) != relsym_secindex
)
1156 if (ELF_ST_TYPE(sym
->st_info
) == STT_SECTION
)
1158 if (sym
->st_value
== addr
)
1160 /* Find a symbol nearby - addr are maybe negative */
1161 d
= sym
->st_value
- addr
;
1163 d
= addr
- sym
->st_value
;
1169 /* We need a close match */
1176 static inline int is_arm_mapping_symbol(const char *str
)
1178 return str
[0] == '$' && strchr("atd", str
[1])
1179 && (str
[2] == '\0' || str
[2] == '.');
1183 * If there's no name there, ignore it; likewise, ignore it if it's
1184 * one of the magic symbols emitted used by current ARM tools.
1186 * Otherwise if find_symbols_between() returns those symbols, they'll
1187 * fail the whitelist tests and cause lots of false alarms ... fixable
1188 * only by merging __exit and __init sections into __text, bloating
1189 * the kernel (which is especially evil on embedded platforms).
1191 static inline int is_valid_name(struct elf_info
*elf
, Elf_Sym
*sym
)
1193 const char *name
= elf
->strtab
+ sym
->st_name
;
1195 if (!name
|| !strlen(name
))
1197 return !is_arm_mapping_symbol(name
);
1201 * Find symbols before or equal addr and after addr - in the section sec.
1202 * If we find two symbols with equal offset prefer one with a valid name.
1203 * The ELF format may have a better way to detect what type of symbol
1204 * it is, but this works for now.
1206 static Elf_Sym
*find_elf_symbol2(struct elf_info
*elf
, Elf_Addr addr
,
1210 Elf_Sym
*near
= NULL
;
1211 Elf_Addr distance
= ~0;
1213 for (sym
= elf
->symtab_start
; sym
< elf
->symtab_stop
; sym
++) {
1216 if (is_shndx_special(sym
->st_shndx
))
1218 symsec
= sec_name(elf
, get_secindex(elf
, sym
));
1219 if (strcmp(symsec
, sec
) != 0)
1221 if (!is_valid_name(elf
, sym
))
1223 if (sym
->st_value
<= addr
) {
1224 if ((addr
- sym
->st_value
) < distance
) {
1225 distance
= addr
- sym
->st_value
;
1227 } else if ((addr
- sym
->st_value
) == distance
) {
1236 * Convert a section name to the function/data attribute
1237 * .init.text => __init
1238 * .memexitconst => __memconst
1241 * The memory of returned value has been allocated on a heap. The user of this
1242 * method should free it after usage.
1244 static char *sec2annotation(const char *s
)
1246 if (match(s
, init_exit_sections
)) {
1247 char *p
= malloc(20);
1254 while (*s
&& *s
!= '.')
1259 if (strstr(s
, "rodata") != NULL
)
1260 strcat(p
, "const ");
1261 else if (strstr(s
, "data") != NULL
)
1271 static int is_function(Elf_Sym
*sym
)
1274 return ELF_ST_TYPE(sym
->st_info
) == STT_FUNC
;
1279 static void print_section_list(const char * const list
[20])
1281 const char *const *s
= list
;
1284 fprintf(stderr
, "%s", *s
);
1287 fprintf(stderr
, ", ");
1289 fprintf(stderr
, "\n");
1293 * Print a warning about a section mismatch.
1294 * Try to find symbols near it so user can find it.
1295 * Check whitelist before warning - it may be a false positive.
1297 static void report_sec_mismatch(const char *modname
,
1298 const struct sectioncheck
*mismatch
,
1299 const char *fromsec
,
1300 unsigned long long fromaddr
,
1301 const char *fromsym
,
1303 const char *tosec
, const char *tosym
,
1306 const char *from
, *from_p
;
1307 const char *to
, *to_p
;
1311 switch (from_is_func
) {
1312 case 0: from
= "variable"; from_p
= ""; break;
1313 case 1: from
= "function"; from_p
= "()"; break;
1314 default: from
= "(unknown reference)"; from_p
= ""; break;
1316 switch (to_is_func
) {
1317 case 0: to
= "variable"; to_p
= ""; break;
1318 case 1: to
= "function"; to_p
= "()"; break;
1319 default: to
= "(unknown reference)"; to_p
= ""; break;
1322 sec_mismatch_count
++;
1323 if (!sec_mismatch_verbose
)
1326 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1327 "to the %s %s:%s%s\n",
1328 modname
, fromsec
, fromaddr
, from
, fromsym
, from_p
, to
, tosec
,
1331 switch (mismatch
->mismatch
) {
1332 case TEXT_TO_ANY_INIT
:
1333 prl_from
= sec2annotation(fromsec
);
1334 prl_to
= sec2annotation(tosec
);
1336 "The function %s%s() references\n"
1338 "This is often because %s lacks a %s\n"
1339 "annotation or the annotation of %s is wrong.\n",
1341 to
, prl_to
, tosym
, to_p
,
1342 fromsym
, prl_to
, tosym
);
1346 case DATA_TO_ANY_INIT
: {
1347 prl_to
= sec2annotation(tosec
);
1349 "The variable %s references\n"
1351 "If the reference is valid then annotate the\n"
1352 "variable with __init* or __refdata (see linux/init.h) "
1353 "or name the variable:\n",
1354 fromsym
, to
, prl_to
, tosym
, to_p
);
1355 print_section_list(mismatch
->symbol_white_list
);
1359 case TEXT_TO_ANY_EXIT
:
1360 prl_to
= sec2annotation(tosec
);
1362 "The function %s() references a %s in an exit section.\n"
1363 "Often the %s %s%s has valid usage outside the exit section\n"
1364 "and the fix is to remove the %sannotation of %s.\n",
1365 fromsym
, to
, to
, tosym
, to_p
, prl_to
, tosym
);
1368 case DATA_TO_ANY_EXIT
: {
1369 prl_to
= sec2annotation(tosec
);
1371 "The variable %s references\n"
1373 "If the reference is valid then annotate the\n"
1374 "variable with __exit* (see linux/init.h) or "
1375 "name the variable:\n",
1376 fromsym
, to
, prl_to
, tosym
, to_p
);
1377 print_section_list(mismatch
->symbol_white_list
);
1381 case XXXINIT_TO_SOME_INIT
:
1382 case XXXEXIT_TO_SOME_EXIT
:
1383 prl_from
= sec2annotation(fromsec
);
1384 prl_to
= sec2annotation(tosec
);
1386 "The %s %s%s%s references\n"
1388 "If %s is only used by %s then\n"
1389 "annotate %s with a matching annotation.\n",
1390 from
, prl_from
, fromsym
, from_p
,
1391 to
, prl_to
, tosym
, to_p
,
1392 tosym
, fromsym
, tosym
);
1396 case ANY_INIT_TO_ANY_EXIT
:
1397 prl_from
= sec2annotation(fromsec
);
1398 prl_to
= sec2annotation(tosec
);
1400 "The %s %s%s%s references\n"
1402 "This is often seen when error handling "
1403 "in the init function\n"
1404 "uses functionality in the exit path.\n"
1405 "The fix is often to remove the %sannotation of\n"
1406 "%s%s so it may be used outside an exit section.\n",
1407 from
, prl_from
, fromsym
, from_p
,
1408 to
, prl_to
, tosym
, to_p
,
1409 prl_to
, tosym
, to_p
);
1413 case ANY_EXIT_TO_ANY_INIT
:
1414 prl_from
= sec2annotation(fromsec
);
1415 prl_to
= sec2annotation(tosec
);
1417 "The %s %s%s%s references\n"
1419 "This is often seen when error handling "
1420 "in the exit function\n"
1421 "uses functionality in the init path.\n"
1422 "The fix is often to remove the %sannotation of\n"
1423 "%s%s so it may be used outside an init section.\n",
1424 from
, prl_from
, fromsym
, from_p
,
1425 to
, prl_to
, tosym
, to_p
,
1426 prl_to
, tosym
, to_p
);
1430 case EXPORT_TO_INIT_EXIT
:
1431 prl_to
= sec2annotation(tosec
);
1433 "The symbol %s is exported and annotated %s\n"
1434 "Fix this by removing the %sannotation of %s "
1435 "or drop the export.\n",
1436 tosym
, prl_to
, prl_to
, tosym
);
1440 fprintf(stderr
, "\n");
1443 static void check_section_mismatch(const char *modname
, struct elf_info
*elf
,
1444 Elf_Rela
*r
, Elf_Sym
*sym
, const char *fromsec
)
1447 const struct sectioncheck
*mismatch
;
1449 tosec
= sec_name(elf
, get_secindex(elf
, sym
));
1450 mismatch
= section_mismatch(fromsec
, tosec
);
1455 const char *fromsym
;
1457 from
= find_elf_symbol2(elf
, r
->r_offset
, fromsec
);
1458 fromsym
= sym_name(elf
, from
);
1459 to
= find_elf_symbol(elf
, r
->r_addend
, sym
);
1460 tosym
= sym_name(elf
, to
);
1462 if (!strncmp(fromsym
, "reference___initcall",
1463 sizeof("reference___initcall")-1))
1466 /* check whitelist - we may ignore it */
1467 if (secref_whitelist(mismatch
,
1468 fromsec
, fromsym
, tosec
, tosym
)) {
1469 report_sec_mismatch(modname
, mismatch
,
1470 fromsec
, r
->r_offset
, fromsym
,
1471 is_function(from
), tosec
, tosym
,
1477 static unsigned int *reloc_location(struct elf_info
*elf
,
1478 Elf_Shdr
*sechdr
, Elf_Rela
*r
)
1480 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
1481 int section
= sechdr
->sh_info
;
1483 return (void *)elf
->hdr
+ sechdrs
[section
].sh_offset
+
1487 static int addend_386_rel(struct elf_info
*elf
, Elf_Shdr
*sechdr
, Elf_Rela
*r
)
1489 unsigned int r_typ
= ELF_R_TYPE(r
->r_info
);
1490 unsigned int *location
= reloc_location(elf
, sechdr
, r
);
1494 r
->r_addend
= TO_NATIVE(*location
);
1497 r
->r_addend
= TO_NATIVE(*location
) + 4;
1498 /* For CONFIG_RELOCATABLE=y */
1499 if (elf
->hdr
->e_type
== ET_EXEC
)
1500 r
->r_addend
+= r
->r_offset
;
1507 #define R_ARM_CALL 28
1509 #ifndef R_ARM_JUMP24
1510 #define R_ARM_JUMP24 29
1513 #ifndef R_ARM_THM_CALL
1514 #define R_ARM_THM_CALL 10
1516 #ifndef R_ARM_THM_JUMP24
1517 #define R_ARM_THM_JUMP24 30
1519 #ifndef R_ARM_THM_JUMP19
1520 #define R_ARM_THM_JUMP19 51
1523 static int addend_arm_rel(struct elf_info
*elf
, Elf_Shdr
*sechdr
, Elf_Rela
*r
)
1525 unsigned int r_typ
= ELF_R_TYPE(r
->r_info
);
1529 /* From ARM ABI: (S + A) | T */
1530 r
->r_addend
= (int)(long)
1531 (elf
->symtab_start
+ ELF_R_SYM(r
->r_info
));
1536 case R_ARM_THM_CALL
:
1537 case R_ARM_THM_JUMP24
:
1538 case R_ARM_THM_JUMP19
:
1539 /* From ARM ABI: ((S + A) | T) - P */
1540 r
->r_addend
= (int)(long)(elf
->hdr
+
1542 (r
->r_offset
- sechdr
->sh_addr
));
1550 static int addend_mips_rel(struct elf_info
*elf
, Elf_Shdr
*sechdr
, Elf_Rela
*r
)
1552 unsigned int r_typ
= ELF_R_TYPE(r
->r_info
);
1553 unsigned int *location
= reloc_location(elf
, sechdr
, r
);
1556 if (r_typ
== R_MIPS_HI16
)
1557 return 1; /* skip this */
1558 inst
= TO_NATIVE(*location
);
1561 r
->r_addend
= inst
& 0xffff;
1564 r
->r_addend
= (inst
& 0x03ffffff) << 2;
1573 static void section_rela(const char *modname
, struct elf_info
*elf
,
1580 const char *fromsec
;
1582 Elf_Rela
*start
= (void *)elf
->hdr
+ sechdr
->sh_offset
;
1583 Elf_Rela
*stop
= (void *)start
+ sechdr
->sh_size
;
1585 fromsec
= sech_name(elf
, sechdr
);
1586 fromsec
+= strlen(".rela");
1587 /* if from section (name) is know good then skip it */
1588 if (match(fromsec
, section_white_list
))
1591 for (rela
= start
; rela
< stop
; rela
++) {
1592 r
.r_offset
= TO_NATIVE(rela
->r_offset
);
1593 #if KERNEL_ELFCLASS == ELFCLASS64
1594 if (elf
->hdr
->e_machine
== EM_MIPS
) {
1596 r_sym
= ELF64_MIPS_R_SYM(rela
->r_info
);
1597 r_sym
= TO_NATIVE(r_sym
);
1598 r_typ
= ELF64_MIPS_R_TYPE(rela
->r_info
);
1599 r
.r_info
= ELF64_R_INFO(r_sym
, r_typ
);
1601 r
.r_info
= TO_NATIVE(rela
->r_info
);
1602 r_sym
= ELF_R_SYM(r
.r_info
);
1605 r
.r_info
= TO_NATIVE(rela
->r_info
);
1606 r_sym
= ELF_R_SYM(r
.r_info
);
1608 r
.r_addend
= TO_NATIVE(rela
->r_addend
);
1609 sym
= elf
->symtab_start
+ r_sym
;
1610 /* Skip special sections */
1611 if (is_shndx_special(sym
->st_shndx
))
1613 check_section_mismatch(modname
, elf
, &r
, sym
, fromsec
);
1617 static void section_rel(const char *modname
, struct elf_info
*elf
,
1624 const char *fromsec
;
1626 Elf_Rel
*start
= (void *)elf
->hdr
+ sechdr
->sh_offset
;
1627 Elf_Rel
*stop
= (void *)start
+ sechdr
->sh_size
;
1629 fromsec
= sech_name(elf
, sechdr
);
1630 fromsec
+= strlen(".rel");
1631 /* if from section (name) is know good then skip it */
1632 if (match(fromsec
, section_white_list
))
1635 for (rel
= start
; rel
< stop
; rel
++) {
1636 r
.r_offset
= TO_NATIVE(rel
->r_offset
);
1637 #if KERNEL_ELFCLASS == ELFCLASS64
1638 if (elf
->hdr
->e_machine
== EM_MIPS
) {
1640 r_sym
= ELF64_MIPS_R_SYM(rel
->r_info
);
1641 r_sym
= TO_NATIVE(r_sym
);
1642 r_typ
= ELF64_MIPS_R_TYPE(rel
->r_info
);
1643 r
.r_info
= ELF64_R_INFO(r_sym
, r_typ
);
1645 r
.r_info
= TO_NATIVE(rel
->r_info
);
1646 r_sym
= ELF_R_SYM(r
.r_info
);
1649 r
.r_info
= TO_NATIVE(rel
->r_info
);
1650 r_sym
= ELF_R_SYM(r
.r_info
);
1653 switch (elf
->hdr
->e_machine
) {
1655 if (addend_386_rel(elf
, sechdr
, &r
))
1659 if (addend_arm_rel(elf
, sechdr
, &r
))
1663 if (addend_mips_rel(elf
, sechdr
, &r
))
1667 sym
= elf
->symtab_start
+ r_sym
;
1668 /* Skip special sections */
1669 if (is_shndx_special(sym
->st_shndx
))
1671 check_section_mismatch(modname
, elf
, &r
, sym
, fromsec
);
1676 * A module includes a number of sections that are discarded
1677 * either when loaded or when used as built-in.
1678 * For loaded modules all functions marked __init and all data
1679 * marked __initdata will be discarded when the module has been initialized.
1680 * Likewise for modules used built-in the sections marked __exit
1681 * are discarded because __exit marked function are supposed to be called
1682 * only when a module is unloaded which never happens for built-in modules.
1683 * The check_sec_ref() function traverses all relocation records
1684 * to find all references to a section that reference a section that will
1685 * be discarded and warns about it.
1687 static void check_sec_ref(struct module
*mod
, const char *modname
,
1688 struct elf_info
*elf
)
1691 Elf_Shdr
*sechdrs
= elf
->sechdrs
;
1693 /* Walk through all sections */
1694 for (i
= 0; i
< elf
->num_sections
; i
++) {
1695 check_section(modname
, elf
, &elf
->sechdrs
[i
]);
1696 /* We want to process only relocation sections and not .init */
1697 if (sechdrs
[i
].sh_type
== SHT_RELA
)
1698 section_rela(modname
, elf
, &elf
->sechdrs
[i
]);
1699 else if (sechdrs
[i
].sh_type
== SHT_REL
)
1700 section_rel(modname
, elf
, &elf
->sechdrs
[i
]);
1704 static char *remove_dot(char *s
)
1707 int n
= strcspn(s
, ".");
1709 if (n
> 0 && s
[n
] != 0) {
1710 strtoul(s
+ n
+ 1, &end
, 10);
1711 if (end
> s
+ n
+ 1 && (*end
== '.' || *end
== 0))
1717 static void read_symbols(char *modname
)
1719 const char *symname
;
1723 struct elf_info info
= { };
1726 if (!parse_elf(&info
, modname
))
1729 mod
= new_module(modname
);
1731 /* When there's no vmlinux, don't print warnings about
1732 * unresolved symbols (since there'll be too many ;) */
1733 if (is_vmlinux(modname
)) {
1738 license
= get_modinfo(info
.modinfo
, info
.modinfo_len
, "license");
1739 if (info
.modinfo
&& !license
&& !is_vmlinux(modname
))
1740 warn("modpost: missing MODULE_LICENSE() in %s\n"
1741 "see include/linux/module.h for "
1742 "more information\n", modname
);
1744 if (license_is_gpl_compatible(license
))
1745 mod
->gpl_compatible
= 1;
1747 mod
->gpl_compatible
= 0;
1750 license
= get_next_modinfo(info
.modinfo
, info
.modinfo_len
,
1751 "license", license
);
1754 for (sym
= info
.symtab_start
; sym
< info
.symtab_stop
; sym
++) {
1755 symname
= remove_dot(info
.strtab
+ sym
->st_name
);
1757 handle_modversions(mod
, &info
, sym
, symname
);
1758 handle_moddevtable(mod
, &info
, sym
, symname
);
1760 if (!is_vmlinux(modname
) ||
1761 (is_vmlinux(modname
) && vmlinux_section_warnings
))
1762 check_sec_ref(mod
, modname
, &info
);
1764 version
= get_modinfo(info
.modinfo
, info
.modinfo_len
, "version");
1766 maybe_frob_rcs_version(modname
, version
, info
.modinfo
,
1767 version
- (char *)info
.hdr
);
1768 if (version
|| (all_versions
&& !is_vmlinux(modname
)))
1769 get_src_version(modname
, mod
->srcversion
,
1770 sizeof(mod
->srcversion
)-1);
1772 parse_elf_finish(&info
);
1774 /* Our trick to get versioning for module struct etc. - it's
1775 * never passed as an argument to an exported function, so
1776 * the automatic versioning doesn't pick it up, but it's really
1777 * important anyhow */
1779 mod
->unres
= alloc_symbol("module_layout", 0, mod
->unres
);
1782 static void read_symbols_from_files(const char *filename
)
1785 char fname
[PATH_MAX
];
1787 if (strcmp(filename
, "-") != 0) {
1788 in
= fopen(filename
, "r");
1790 fatal("Can't open filenames file %s: %m", filename
);
1793 while (fgets(fname
, PATH_MAX
, in
) != NULL
) {
1794 if (strends(fname
, "\n"))
1795 fname
[strlen(fname
)-1] = '\0';
1796 read_symbols(fname
);
1805 /* We first write the generated file into memory using the
1806 * following helper, then compare to the file on disk and
1807 * only update the later if anything changed */
1809 void __attribute__((format(printf
, 2, 3))) buf_printf(struct buffer
*buf
,
1810 const char *fmt
, ...)
1817 len
= vsnprintf(tmp
, SZ
, fmt
, ap
);
1818 buf_write(buf
, tmp
, len
);
1822 void buf_write(struct buffer
*buf
, const char *s
, int len
)
1824 if (buf
->size
- buf
->pos
< len
) {
1825 buf
->size
+= len
+ SZ
;
1826 buf
->p
= realloc(buf
->p
, buf
->size
);
1828 strncpy(buf
->p
+ buf
->pos
, s
, len
);
1832 static void check_for_gpl_usage(enum export exp
, const char *m
, const char *s
)
1834 const char *e
= is_vmlinux(m
) ?"":".ko";
1838 fatal("modpost: GPL-incompatible module %s%s "
1839 "uses GPL-only symbol '%s'\n", m
, e
, s
);
1841 case export_unused_gpl
:
1842 fatal("modpost: GPL-incompatible module %s%s "
1843 "uses GPL-only symbol marked UNUSED '%s'\n", m
, e
, s
);
1845 case export_gpl_future
:
1846 warn("modpost: GPL-incompatible module %s%s "
1847 "uses future GPL-only symbol '%s'\n", m
, e
, s
);
1851 case export_unknown
:
1857 static void check_for_unused(enum export exp
, const char *m
, const char *s
)
1859 const char *e
= is_vmlinux(m
) ?"":".ko";
1863 case export_unused_gpl
:
1864 warn("modpost: module %s%s "
1865 "uses symbol '%s' marked UNUSED\n", m
, e
, s
);
1873 static void check_exports(struct module
*mod
)
1875 struct symbol
*s
, *exp
;
1877 for (s
= mod
->unres
; s
; s
= s
->next
) {
1878 const char *basename
;
1879 exp
= find_symbol(s
->name
);
1880 if (!exp
|| exp
->module
== mod
)
1882 basename
= strrchr(mod
->name
, '/');
1886 basename
= mod
->name
;
1887 if (!mod
->gpl_compatible
)
1888 check_for_gpl_usage(exp
->export
, basename
, exp
->name
);
1889 check_for_unused(exp
->export
, basename
, exp
->name
);
1894 * Header for the generated file
1896 static void add_header(struct buffer
*b
, struct module
*mod
)
1898 buf_printf(b
, "#include <linux/module.h>\n");
1899 buf_printf(b
, "#include <linux/vermagic.h>\n");
1900 buf_printf(b
, "#include <linux/compiler.h>\n");
1901 buf_printf(b
, "\n");
1902 buf_printf(b
, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
1903 buf_printf(b
, "\n");
1904 buf_printf(b
, "__visible struct module __this_module\n");
1905 buf_printf(b
, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
1906 buf_printf(b
, "\t.name = KBUILD_MODNAME,\n");
1908 buf_printf(b
, "\t.init = init_module,\n");
1909 if (mod
->has_cleanup
)
1910 buf_printf(b
, "#ifdef CONFIG_MODULE_UNLOAD\n"
1911 "\t.exit = cleanup_module,\n"
1913 buf_printf(b
, "\t.arch = MODULE_ARCH_INIT,\n");
1914 buf_printf(b
, "};\n");
1917 static void add_intree_flag(struct buffer
*b
, int is_intree
)
1920 buf_printf(b
, "\nMODULE_INFO(intree, \"Y\");\n");
1923 static void add_staging_flag(struct buffer
*b
, const char *name
)
1925 static const char *staging_dir
= "drivers/staging";
1927 if (strncmp(staging_dir
, name
, strlen(staging_dir
)) == 0)
1928 buf_printf(b
, "\nMODULE_INFO(staging, \"Y\");\n");
1932 * Record CRCs for unresolved symbols
1934 static int add_versions(struct buffer
*b
, struct module
*mod
)
1936 struct symbol
*s
, *exp
;
1939 for (s
= mod
->unres
; s
; s
= s
->next
) {
1940 exp
= find_symbol(s
->name
);
1941 if (!exp
|| exp
->module
== mod
) {
1942 if (have_vmlinux
&& !s
->weak
) {
1943 if (warn_unresolved
) {
1944 warn("\"%s\" [%s.ko] undefined!\n",
1945 s
->name
, mod
->name
);
1947 merror("\"%s\" [%s.ko] undefined!\n",
1948 s
->name
, mod
->name
);
1954 s
->module
= exp
->module
;
1955 s
->crc_valid
= exp
->crc_valid
;
1962 buf_printf(b
, "\n");
1963 buf_printf(b
, "static const struct modversion_info ____versions[]\n");
1964 buf_printf(b
, "__used\n");
1965 buf_printf(b
, "__attribute__((section(\"__versions\"))) = {\n");
1967 for (s
= mod
->unres
; s
; s
= s
->next
) {
1970 if (!s
->crc_valid
) {
1971 warn("\"%s\" [%s.ko] has no CRC!\n",
1972 s
->name
, mod
->name
);
1975 buf_printf(b
, "\t{ %#8x, __VMLINUX_SYMBOL_STR(%s) },\n",
1979 buf_printf(b
, "};\n");
1984 static void add_depends(struct buffer
*b
, struct module
*mod
,
1985 struct module
*modules
)
1991 for (m
= modules
; m
; m
= m
->next
)
1992 m
->seen
= is_vmlinux(m
->name
);
1994 buf_printf(b
, "\n");
1995 buf_printf(b
, "static const char __module_depends[]\n");
1996 buf_printf(b
, "__used\n");
1997 buf_printf(b
, "__attribute__((section(\".modinfo\"))) =\n");
1998 buf_printf(b
, "\"depends=");
1999 for (s
= mod
->unres
; s
; s
= s
->next
) {
2004 if (s
->module
->seen
)
2007 s
->module
->seen
= 1;
2008 p
= strrchr(s
->module
->name
, '/');
2012 p
= s
->module
->name
;
2013 buf_printf(b
, "%s%s", first
? "" : ",", p
);
2016 buf_printf(b
, "\";\n");
2019 static void add_srcversion(struct buffer
*b
, struct module
*mod
)
2021 if (mod
->srcversion
[0]) {
2022 buf_printf(b
, "\n");
2023 buf_printf(b
, "MODULE_INFO(srcversion, \"%s\");\n",
2028 static void write_if_changed(struct buffer
*b
, const char *fname
)
2034 file
= fopen(fname
, "r");
2038 if (fstat(fileno(file
), &st
) < 0)
2041 if (st
.st_size
!= b
->pos
)
2044 tmp
= NOFAIL(malloc(b
->pos
));
2045 if (fread(tmp
, 1, b
->pos
, file
) != b
->pos
)
2048 if (memcmp(tmp
, b
->p
, b
->pos
) != 0)
2060 file
= fopen(fname
, "w");
2065 if (fwrite(b
->p
, 1, b
->pos
, file
) != b
->pos
) {
2072 /* parse Module.symvers file. line format:
2073 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
2075 static void read_dump(const char *fname
, unsigned int kernel
)
2077 unsigned long size
, pos
= 0;
2078 void *file
= grab_file(fname
, &size
);
2082 /* No symbol versions, silently ignore */
2085 while ((line
= get_next_line(&pos
, file
, size
))) {
2086 char *symname
, *modname
, *d
, *export
, *end
;
2091 if (!(symname
= strchr(line
, '\t')))
2094 if (!(modname
= strchr(symname
, '\t')))
2097 if ((export
= strchr(modname
, '\t')) != NULL
)
2099 if (export
&& ((end
= strchr(export
, '\t')) != NULL
))
2101 crc
= strtoul(line
, &d
, 16);
2102 if (*symname
== '\0' || *modname
== '\0' || *d
!= '\0')
2104 mod
= find_module(modname
);
2106 if (is_vmlinux(modname
))
2108 mod
= new_module(modname
);
2111 s
= sym_add_exported(symname
, mod
, export_no(export
));
2114 sym_update_crc(symname
, mod
, crc
, export_no(export
));
2118 fatal("parse error in symbol dump file\n");
2121 /* For normal builds always dump all symbols.
2122 * For external modules only dump symbols
2123 * that are not read from kernel Module.symvers.
2125 static int dump_sym(struct symbol
*sym
)
2127 if (!external_module
)
2129 if (sym
->vmlinux
|| sym
->kernel
)
2134 static void write_dump(const char *fname
)
2136 struct buffer buf
= { };
2137 struct symbol
*symbol
;
2140 for (n
= 0; n
< SYMBOL_HASH_SIZE
; n
++) {
2141 symbol
= symbolhash
[n
];
2143 if (dump_sym(symbol
))
2144 buf_printf(&buf
, "0x%08x\t%s\t%s\t%s\n",
2145 symbol
->crc
, symbol
->name
,
2146 symbol
->module
->name
,
2147 export_str(symbol
->export
));
2148 symbol
= symbol
->next
;
2151 write_if_changed(&buf
, fname
);
2154 struct ext_sym_list
{
2155 struct ext_sym_list
*next
;
2159 int main(int argc
, char **argv
)
2162 struct buffer buf
= { };
2163 char *kernel_read
= NULL
, *module_read
= NULL
;
2164 char *dump_write
= NULL
, *files_source
= NULL
;
2167 struct ext_sym_list
*extsym_iter
;
2168 struct ext_sym_list
*extsym_start
= NULL
;
2170 while ((opt
= getopt(argc
, argv
, "i:I:e:mnsST:o:awM:K:")) != -1) {
2173 kernel_read
= optarg
;
2176 module_read
= optarg
;
2177 external_module
= 1;
2180 external_module
= 1;
2182 NOFAIL(malloc(sizeof(*extsym_iter
)));
2183 extsym_iter
->next
= extsym_start
;
2184 extsym_iter
->file
= optarg
;
2185 extsym_start
= extsym_iter
;
2191 ignore_missing_files
= 1;
2194 dump_write
= optarg
;
2200 vmlinux_section_warnings
= 0;
2203 sec_mismatch_verbose
= 0;
2206 files_source
= optarg
;
2209 warn_unresolved
= 1;
2217 read_dump(kernel_read
, 1);
2219 read_dump(module_read
, 0);
2220 while (extsym_start
) {
2221 read_dump(extsym_start
->file
, 0);
2222 extsym_iter
= extsym_start
->next
;
2224 extsym_start
= extsym_iter
;
2227 while (optind
< argc
)
2228 read_symbols(argv
[optind
++]);
2231 read_symbols_from_files(files_source
);
2233 for (mod
= modules
; mod
; mod
= mod
->next
) {
2241 for (mod
= modules
; mod
; mod
= mod
->next
) {
2242 char fname
[strlen(mod
->name
) + 10];
2249 add_header(&buf
, mod
);
2250 add_intree_flag(&buf
, !external_module
);
2251 add_staging_flag(&buf
, mod
->name
);
2252 err
|= add_versions(&buf
, mod
);
2253 add_depends(&buf
, mod
, modules
);
2254 add_moddevtable(&buf
, mod
);
2255 add_srcversion(&buf
, mod
);
2257 sprintf(fname
, "%s.mod.c", mod
->name
);
2258 write_if_changed(&buf
, fname
);
2262 write_dump(dump_write
);
2263 if (sec_mismatch_count
&& !sec_mismatch_verbose
)
2264 warn("modpost: Found %d section mismatch(es).\n"
2265 "To see full details build your kernel with:\n"
2266 "'make CONFIG_DEBUG_SECTION_MISMATCH=y'\n",
2267 sec_mismatch_count
);