kbuild, modpost: fix unexpected non-allocatable section when cross compiling
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / scripts / mod / modpost.c
bloba5c17db14ee53efefe9f5540b5d315fc21eaf671
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 ...
14 #define _GNU_SOURCE
15 #include <stdio.h>
16 #include <ctype.h>
17 #include "modpost.h"
18 #include "../../include/linux/license.h"
20 /* Are we using CONFIG_MODVERSIONS? */
21 int modversions = 0;
22 /* Warn about undefined symbols? (do so if we have vmlinux) */
23 int have_vmlinux = 0;
24 /* Is CONFIG_MODULE_SRCVERSION_ALL set? */
25 static int all_versions = 0;
26 /* If we are modposting external module set to 1 */
27 static int external_module = 0;
28 /* Warn about section mismatch in vmlinux if set to 1 */
29 static int vmlinux_section_warnings = 1;
30 /* Only warn about unresolved symbols */
31 static int warn_unresolved = 0;
32 /* How a symbol is exported */
33 static int sec_mismatch_count = 0;
34 static int sec_mismatch_verbose = 1;
36 enum export {
37 export_plain, export_unused, export_gpl,
38 export_unused_gpl, export_gpl_future, export_unknown
41 #define PRINTF __attribute__ ((format (printf, 1, 2)))
43 PRINTF void fatal(const char *fmt, ...)
45 va_list arglist;
47 fprintf(stderr, "FATAL: ");
49 va_start(arglist, fmt);
50 vfprintf(stderr, fmt, arglist);
51 va_end(arglist);
53 exit(1);
56 PRINTF void warn(const char *fmt, ...)
58 va_list arglist;
60 fprintf(stderr, "WARNING: ");
62 va_start(arglist, fmt);
63 vfprintf(stderr, fmt, arglist);
64 va_end(arglist);
67 PRINTF void merror(const char *fmt, ...)
69 va_list arglist;
71 fprintf(stderr, "ERROR: ");
73 va_start(arglist, fmt);
74 vfprintf(stderr, fmt, arglist);
75 va_end(arglist);
78 static int is_vmlinux(const char *modname)
80 const char *myname;
82 myname = strrchr(modname, '/');
83 if (myname)
84 myname++;
85 else
86 myname = modname;
88 return (strcmp(myname, "vmlinux") == 0) ||
89 (strcmp(myname, "vmlinux.o") == 0);
92 void *do_nofail(void *ptr, const char *expr)
94 if (!ptr)
95 fatal("modpost: Memory allocation failure: %s.\n", expr);
97 return ptr;
100 /* A list of all modules we processed */
101 static struct module *modules;
103 static struct module *find_module(char *modname)
105 struct module *mod;
107 for (mod = modules; mod; mod = mod->next)
108 if (strcmp(mod->name, modname) == 0)
109 break;
110 return mod;
113 static struct module *new_module(char *modname)
115 struct module *mod;
116 char *p, *s;
118 mod = NOFAIL(malloc(sizeof(*mod)));
119 memset(mod, 0, sizeof(*mod));
120 p = NOFAIL(strdup(modname));
122 /* strip trailing .o */
123 s = strrchr(p, '.');
124 if (s != NULL)
125 if (strcmp(s, ".o") == 0)
126 *s = '\0';
128 /* add to list */
129 mod->name = p;
130 mod->gpl_compatible = -1;
131 mod->next = modules;
132 modules = mod;
134 return mod;
137 /* A hash of all exported symbols,
138 * struct symbol is also used for lists of unresolved symbols */
140 #define SYMBOL_HASH_SIZE 1024
142 struct symbol {
143 struct symbol *next;
144 struct module *module;
145 unsigned int crc;
146 int crc_valid;
147 unsigned int weak:1;
148 unsigned int vmlinux:1; /* 1 if symbol is defined in vmlinux */
149 unsigned int kernel:1; /* 1 if symbol is from kernel
150 * (only for external modules) **/
151 unsigned int preloaded:1; /* 1 if symbol from Module.symvers */
152 enum export export; /* Type of export */
153 char name[0];
156 static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
158 /* This is based on the hash agorithm from gdbm, via tdb */
159 static inline unsigned int tdb_hash(const char *name)
161 unsigned value; /* Used to compute the hash value. */
162 unsigned i; /* Used to cycle through random values. */
164 /* Set the initial value from the key size. */
165 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
166 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
168 return (1103515243 * value + 12345);
172 * Allocate a new symbols for use in the hash of exported symbols or
173 * the list of unresolved symbols per module
175 static struct symbol *alloc_symbol(const char *name, unsigned int weak,
176 struct symbol *next)
178 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
180 memset(s, 0, sizeof(*s));
181 strcpy(s->name, name);
182 s->weak = weak;
183 s->next = next;
184 return s;
187 /* For the hash of exported symbols */
188 static struct symbol *new_symbol(const char *name, struct module *module,
189 enum export export)
191 unsigned int hash;
192 struct symbol *new;
194 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
195 new = symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
196 new->module = module;
197 new->export = export;
198 return new;
201 static struct symbol *find_symbol(const char *name)
203 struct symbol *s;
205 /* For our purposes, .foo matches foo. PPC64 needs this. */
206 if (name[0] == '.')
207 name++;
209 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
210 if (strcmp(s->name, name) == 0)
211 return s;
213 return NULL;
216 static struct {
217 const char *str;
218 enum export export;
219 } export_list[] = {
220 { .str = "EXPORT_SYMBOL", .export = export_plain },
221 { .str = "EXPORT_UNUSED_SYMBOL", .export = export_unused },
222 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
223 { .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
224 { .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
225 { .str = "(unknown)", .export = export_unknown },
229 static const char *export_str(enum export ex)
231 return export_list[ex].str;
234 static enum export export_no(const char *s)
236 int i;
238 if (!s)
239 return export_unknown;
240 for (i = 0; export_list[i].export != export_unknown; i++) {
241 if (strcmp(export_list[i].str, s) == 0)
242 return export_list[i].export;
244 return export_unknown;
247 static enum export export_from_sec(struct elf_info *elf, Elf_Section sec)
249 if (sec == elf->export_sec)
250 return export_plain;
251 else if (sec == elf->export_unused_sec)
252 return export_unused;
253 else if (sec == elf->export_gpl_sec)
254 return export_gpl;
255 else if (sec == elf->export_unused_gpl_sec)
256 return export_unused_gpl;
257 else if (sec == elf->export_gpl_future_sec)
258 return export_gpl_future;
259 else
260 return export_unknown;
264 * Add an exported symbol - it may have already been added without a
265 * CRC, in this case just update the CRC
267 static struct symbol *sym_add_exported(const char *name, struct module *mod,
268 enum export export)
270 struct symbol *s = find_symbol(name);
272 if (!s) {
273 s = new_symbol(name, mod, export);
274 } else {
275 if (!s->preloaded) {
276 warn("%s: '%s' exported twice. Previous export "
277 "was in %s%s\n", mod->name, name,
278 s->module->name,
279 is_vmlinux(s->module->name) ?"":".ko");
280 } else {
281 /* In case Modules.symvers was out of date */
282 s->module = mod;
285 s->preloaded = 0;
286 s->vmlinux = is_vmlinux(mod->name);
287 s->kernel = 0;
288 s->export = export;
289 return s;
292 static void sym_update_crc(const char *name, struct module *mod,
293 unsigned int crc, enum export export)
295 struct symbol *s = find_symbol(name);
297 if (!s)
298 s = new_symbol(name, mod, export);
299 s->crc = crc;
300 s->crc_valid = 1;
303 void *grab_file(const char *filename, unsigned long *size)
305 struct stat st;
306 void *map;
307 int fd;
309 fd = open(filename, O_RDONLY);
310 if (fd < 0 || fstat(fd, &st) != 0)
311 return NULL;
313 *size = st.st_size;
314 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
315 close(fd);
317 if (map == MAP_FAILED)
318 return NULL;
319 return map;
323 * Return a copy of the next line in a mmap'ed file.
324 * spaces in the beginning of the line is trimmed away.
325 * Return a pointer to a static buffer.
327 char *get_next_line(unsigned long *pos, void *file, unsigned long size)
329 static char line[4096];
330 int skip = 1;
331 size_t len = 0;
332 signed char *p = (signed char *)file + *pos;
333 char *s = line;
335 for (; *pos < size ; (*pos)++) {
336 if (skip && isspace(*p)) {
337 p++;
338 continue;
340 skip = 0;
341 if (*p != '\n' && (*pos < size)) {
342 len++;
343 *s++ = *p++;
344 if (len > 4095)
345 break; /* Too long, stop */
346 } else {
347 /* End of string */
348 *s = '\0';
349 return line;
352 /* End of buffer */
353 return NULL;
356 void release_file(void *file, unsigned long size)
358 munmap(file, size);
361 static int parse_elf(struct elf_info *info, const char *filename)
363 unsigned int i;
364 Elf_Ehdr *hdr;
365 Elf_Shdr *sechdrs;
366 Elf_Sym *sym;
368 hdr = grab_file(filename, &info->size);
369 if (!hdr) {
370 perror(filename);
371 exit(1);
373 info->hdr = hdr;
374 if (info->size < sizeof(*hdr)) {
375 /* file too small, assume this is an empty .o file */
376 return 0;
378 /* Is this a valid ELF file? */
379 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
380 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
381 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
382 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
383 /* Not an ELF file - silently ignore it */
384 return 0;
386 /* Fix endianness in ELF header */
387 hdr->e_type = TO_NATIVE(hdr->e_type);
388 hdr->e_machine = TO_NATIVE(hdr->e_machine);
389 hdr->e_version = TO_NATIVE(hdr->e_version);
390 hdr->e_entry = TO_NATIVE(hdr->e_entry);
391 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
392 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
393 hdr->e_flags = TO_NATIVE(hdr->e_flags);
394 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
395 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
396 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
397 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
398 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
399 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
400 sechdrs = (void *)hdr + hdr->e_shoff;
401 info->sechdrs = sechdrs;
403 /* Check if file offset is correct */
404 if (hdr->e_shoff > info->size) {
405 fatal("section header offset=%lu in file '%s' is bigger than "
406 "filesize=%lu\n", (unsigned long)hdr->e_shoff,
407 filename, info->size);
408 return 0;
411 /* Fix endianness in section headers */
412 for (i = 0; i < hdr->e_shnum; i++) {
413 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
414 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
415 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
416 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
417 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
418 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
419 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
420 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
421 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
422 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
424 /* Find symbol table. */
425 for (i = 1; i < hdr->e_shnum; i++) {
426 const char *secstrings
427 = (void *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
428 const char *secname;
429 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
431 if (!nobits && sechdrs[i].sh_offset > info->size) {
432 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
433 "sizeof(*hrd)=%zu\n", filename,
434 (unsigned long)sechdrs[i].sh_offset,
435 sizeof(*hdr));
436 return 0;
438 secname = secstrings + sechdrs[i].sh_name;
439 if (strcmp(secname, ".modinfo") == 0) {
440 if (nobits)
441 fatal("%s has NOBITS .modinfo\n", filename);
442 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
443 info->modinfo_len = sechdrs[i].sh_size;
444 } else if (strcmp(secname, "__ksymtab") == 0)
445 info->export_sec = i;
446 else if (strcmp(secname, "__ksymtab_unused") == 0)
447 info->export_unused_sec = i;
448 else if (strcmp(secname, "__ksymtab_gpl") == 0)
449 info->export_gpl_sec = i;
450 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
451 info->export_unused_gpl_sec = i;
452 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
453 info->export_gpl_future_sec = i;
454 else if (strcmp(secname, "__markers_strings") == 0)
455 info->markers_strings_sec = i;
457 if (sechdrs[i].sh_type != SHT_SYMTAB)
458 continue;
460 info->symtab_start = (void *)hdr + sechdrs[i].sh_offset;
461 info->symtab_stop = (void *)hdr + sechdrs[i].sh_offset
462 + sechdrs[i].sh_size;
463 info->strtab = (void *)hdr +
464 sechdrs[sechdrs[i].sh_link].sh_offset;
466 if (!info->symtab_start)
467 fatal("%s has no symtab?\n", filename);
469 /* Fix endianness in symbols */
470 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
471 sym->st_shndx = TO_NATIVE(sym->st_shndx);
472 sym->st_name = TO_NATIVE(sym->st_name);
473 sym->st_value = TO_NATIVE(sym->st_value);
474 sym->st_size = TO_NATIVE(sym->st_size);
476 return 1;
479 static void parse_elf_finish(struct elf_info *info)
481 release_file(info->hdr, info->size);
484 static int ignore_undef_symbol(struct elf_info *info, const char *symname)
486 /* ignore __this_module, it will be resolved shortly */
487 if (strcmp(symname, MODULE_SYMBOL_PREFIX "__this_module") == 0)
488 return 1;
489 /* ignore global offset table */
490 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
491 return 1;
492 if (info->hdr->e_machine == EM_PPC)
493 /* Special register function linked on all modules during final link of .ko */
494 if (strncmp(symname, "_restgpr_", sizeof("_restgpr_") - 1) == 0 ||
495 strncmp(symname, "_savegpr_", sizeof("_savegpr_") - 1) == 0 ||
496 strncmp(symname, "_rest32gpr_", sizeof("_rest32gpr_") - 1) == 0 ||
497 strncmp(symname, "_save32gpr_", sizeof("_save32gpr_") - 1) == 0)
498 return 1;
499 /* Do not ignore this symbol */
500 return 0;
503 #define CRC_PFX MODULE_SYMBOL_PREFIX "__crc_"
504 #define KSYMTAB_PFX MODULE_SYMBOL_PREFIX "__ksymtab_"
506 static void handle_modversions(struct module *mod, struct elf_info *info,
507 Elf_Sym *sym, const char *symname)
509 unsigned int crc;
510 enum export export = export_from_sec(info, sym->st_shndx);
512 switch (sym->st_shndx) {
513 case SHN_COMMON:
514 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
515 break;
516 case SHN_ABS:
517 /* CRC'd symbol */
518 if (memcmp(symname, CRC_PFX, strlen(CRC_PFX)) == 0) {
519 crc = (unsigned int) sym->st_value;
520 sym_update_crc(symname + strlen(CRC_PFX), mod, crc,
521 export);
523 break;
524 case SHN_UNDEF:
525 /* undefined symbol */
526 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
527 ELF_ST_BIND(sym->st_info) != STB_WEAK)
528 break;
529 if (ignore_undef_symbol(info, symname))
530 break;
531 /* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
532 #if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
533 /* add compatibility with older glibc */
534 #ifndef STT_SPARC_REGISTER
535 #define STT_SPARC_REGISTER STT_REGISTER
536 #endif
537 if (info->hdr->e_machine == EM_SPARC ||
538 info->hdr->e_machine == EM_SPARCV9) {
539 /* Ignore register directives. */
540 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
541 break;
542 if (symname[0] == '.') {
543 char *munged = strdup(symname);
544 munged[0] = '_';
545 munged[1] = toupper(munged[1]);
546 symname = munged;
549 #endif
551 if (memcmp(symname, MODULE_SYMBOL_PREFIX,
552 strlen(MODULE_SYMBOL_PREFIX)) == 0) {
553 mod->unres =
554 alloc_symbol(symname +
555 strlen(MODULE_SYMBOL_PREFIX),
556 ELF_ST_BIND(sym->st_info) == STB_WEAK,
557 mod->unres);
559 break;
560 default:
561 /* All exported symbols */
562 if (memcmp(symname, KSYMTAB_PFX, strlen(KSYMTAB_PFX)) == 0) {
563 sym_add_exported(symname + strlen(KSYMTAB_PFX), mod,
564 export);
566 if (strcmp(symname, MODULE_SYMBOL_PREFIX "init_module") == 0)
567 mod->has_init = 1;
568 if (strcmp(symname, MODULE_SYMBOL_PREFIX "cleanup_module") == 0)
569 mod->has_cleanup = 1;
570 break;
575 * Parse tag=value strings from .modinfo section
577 static char *next_string(char *string, unsigned long *secsize)
579 /* Skip non-zero chars */
580 while (string[0]) {
581 string++;
582 if ((*secsize)-- <= 1)
583 return NULL;
586 /* Skip any zero padding. */
587 while (!string[0]) {
588 string++;
589 if ((*secsize)-- <= 1)
590 return NULL;
592 return string;
595 static char *get_next_modinfo(void *modinfo, unsigned long modinfo_len,
596 const char *tag, char *info)
598 char *p;
599 unsigned int taglen = strlen(tag);
600 unsigned long size = modinfo_len;
602 if (info) {
603 size -= info - (char *)modinfo;
604 modinfo = next_string(info, &size);
607 for (p = modinfo; p; p = next_string(p, &size)) {
608 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
609 return p + taglen + 1;
611 return NULL;
614 static char *get_modinfo(void *modinfo, unsigned long modinfo_len,
615 const char *tag)
618 return get_next_modinfo(modinfo, modinfo_len, tag, NULL);
622 * Test if string s ends in string sub
623 * return 0 if match
625 static int strrcmp(const char *s, const char *sub)
627 int slen, sublen;
629 if (!s || !sub)
630 return 1;
632 slen = strlen(s);
633 sublen = strlen(sub);
635 if ((slen == 0) || (sublen == 0))
636 return 1;
638 if (sublen > slen)
639 return 1;
641 return memcmp(s + slen - sublen, sub, sublen);
644 static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
646 if (sym)
647 return elf->strtab + sym->st_name;
648 else
649 return "(unknown)";
652 static const char *sec_name(struct elf_info *elf, int shndx)
654 Elf_Shdr *sechdrs = elf->sechdrs;
655 return (void *)elf->hdr +
656 elf->sechdrs[elf->hdr->e_shstrndx].sh_offset +
657 sechdrs[shndx].sh_name;
660 static const char *sech_name(struct elf_info *elf, Elf_Shdr *sechdr)
662 return (void *)elf->hdr +
663 elf->sechdrs[elf->hdr->e_shstrndx].sh_offset +
664 sechdr->sh_name;
667 /* if sym is empty or point to a string
668 * like ".[0-9]+" then return 1.
669 * This is the optional prefix added by ld to some sections
671 static int number_prefix(const char *sym)
673 if (*sym++ == '\0')
674 return 1;
675 if (*sym != '.')
676 return 0;
677 do {
678 char c = *sym++;
679 if (c < '0' || c > '9')
680 return 0;
681 } while (*sym);
682 return 1;
685 /* The pattern is an array of simple patterns.
686 * "foo" will match an exact string equal to "foo"
687 * "*foo" will match a string that ends with "foo"
688 * "foo*" will match a string that begins with "foo"
689 * "foo$" will match a string equal to "foo" or "foo.1"
690 * where the '1' can be any number including several digits.
691 * The $ syntax is for sections where ld append a dot number
692 * to make section name unique.
694 int match(const char *sym, const char * const pat[])
696 const char *p;
697 while (*pat) {
698 p = *pat++;
699 const char *endp = p + strlen(p) - 1;
701 /* "*foo" */
702 if (*p == '*') {
703 if (strrcmp(sym, p + 1) == 0)
704 return 1;
706 /* "foo*" */
707 else if (*endp == '*') {
708 if (strncmp(sym, p, strlen(p) - 1) == 0)
709 return 1;
711 /* "foo$" */
712 else if (*endp == '$') {
713 if (strncmp(sym, p, strlen(p) - 1) == 0) {
714 if (number_prefix(sym + strlen(p) - 1))
715 return 1;
718 /* no wildcards */
719 else {
720 if (strcmp(p, sym) == 0)
721 return 1;
724 /* no match */
725 return 0;
728 /* sections that we do not want to do full section mismatch check on */
729 static const char *section_white_list[] =
730 { ".comment", ".debug*", ".stab*", ".note*", ".got*", ".toc*", NULL };
733 * This is used to find sections missing the SHF_ALLOC flag.
734 * The cause of this is often a section specified in assembler
735 * without "ax" / "aw".
737 static void check_section(const char *modname, struct elf_info *elf,
738 Elf_Shdr *sechdr)
740 const char *sec = sech_name(elf, sechdr);
742 if (sechdr->sh_type == SHT_PROGBITS &&
743 !(sechdr->sh_flags & SHF_ALLOC) &&
744 !match(sec, section_white_list)) {
745 warn("%s (%s): unexpected non-allocatable section.\n"
746 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
747 "Note that for example <linux/init.h> contains\n"
748 "section definitions for use in .S files.\n\n",
749 modname, sec);
755 #define ALL_INIT_DATA_SECTIONS \
756 ".init.data$", ".devinit.data$", ".cpuinit.data$", ".meminit.data$"
757 #define ALL_EXIT_DATA_SECTIONS \
758 ".exit.data$", ".devexit.data$", ".cpuexit.data$", ".memexit.data$"
760 #define ALL_INIT_TEXT_SECTIONS \
761 ".init.text$", ".devinit.text$", ".cpuinit.text$", ".meminit.text$"
762 #define ALL_EXIT_TEXT_SECTIONS \
763 ".exit.text$", ".devexit.text$", ".cpuexit.text$", ".memexit.text$"
765 #define ALL_INIT_SECTIONS ALL_INIT_DATA_SECTIONS, ALL_INIT_TEXT_SECTIONS
766 #define ALL_EXIT_SECTIONS ALL_EXIT_DATA_SECTIONS, ALL_EXIT_TEXT_SECTIONS
768 #define DATA_SECTIONS ".data$", ".data.rel$"
769 #define TEXT_SECTIONS ".text$"
771 #define INIT_SECTIONS ".init.data$", ".init.text$"
772 #define DEV_INIT_SECTIONS ".devinit.data$", ".devinit.text$"
773 #define CPU_INIT_SECTIONS ".cpuinit.data$", ".cpuinit.text$"
774 #define MEM_INIT_SECTIONS ".meminit.data$", ".meminit.text$"
776 #define EXIT_SECTIONS ".exit.data$", ".exit.text$"
777 #define DEV_EXIT_SECTIONS ".devexit.data$", ".devexit.text$"
778 #define CPU_EXIT_SECTIONS ".cpuexit.data$", ".cpuexit.text$"
779 #define MEM_EXIT_SECTIONS ".memexit.data$", ".memexit.text$"
781 /* init data sections */
782 static const char *init_data_sections[] = { ALL_INIT_DATA_SECTIONS, NULL };
784 /* all init sections */
785 static const char *init_sections[] = { ALL_INIT_SECTIONS, NULL };
787 /* All init and exit sections (code + data) */
788 static const char *init_exit_sections[] =
789 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
791 /* data section */
792 static const char *data_sections[] = { DATA_SECTIONS, NULL };
795 /* symbols in .data that may refer to init/exit sections */
796 static const char *symbol_white_list[] =
798 "*driver",
799 "*_template", /* scsi uses *_template a lot */
800 "*_timer", /* arm uses ops structures named _timer a lot */
801 "*_sht", /* scsi also used *_sht to some extent */
802 "*_ops",
803 "*_probe",
804 "*_probe_one",
805 "*_console",
806 NULL
809 static const char *head_sections[] = { ".head.text*", NULL };
810 static const char *linker_symbols[] =
811 { "__init_begin", "_sinittext", "_einittext", NULL };
813 enum mismatch {
814 NO_MISMATCH,
815 TEXT_TO_INIT,
816 DATA_TO_INIT,
817 TEXT_TO_EXIT,
818 DATA_TO_EXIT,
819 XXXINIT_TO_INIT,
820 XXXEXIT_TO_EXIT,
821 INIT_TO_EXIT,
822 EXIT_TO_INIT,
823 EXPORT_TO_INIT_EXIT,
826 struct sectioncheck {
827 const char *fromsec[20];
828 const char *tosec[20];
829 enum mismatch mismatch;
832 const struct sectioncheck sectioncheck[] = {
833 /* Do not reference init/exit code/data from
834 * normal code and data
837 .fromsec = { TEXT_SECTIONS, NULL },
838 .tosec = { ALL_INIT_SECTIONS, NULL },
839 .mismatch = TEXT_TO_INIT,
842 .fromsec = { DATA_SECTIONS, NULL },
843 .tosec = { ALL_INIT_SECTIONS, NULL },
844 .mismatch = DATA_TO_INIT,
847 .fromsec = { TEXT_SECTIONS, NULL },
848 .tosec = { ALL_EXIT_SECTIONS, NULL },
849 .mismatch = TEXT_TO_EXIT,
852 .fromsec = { DATA_SECTIONS, NULL },
853 .tosec = { ALL_EXIT_SECTIONS, NULL },
854 .mismatch = DATA_TO_EXIT,
856 /* Do not reference init code/data from devinit/cpuinit/meminit code/data */
858 .fromsec = { DEV_INIT_SECTIONS, CPU_INIT_SECTIONS, MEM_INIT_SECTIONS, NULL },
859 .tosec = { INIT_SECTIONS, NULL },
860 .mismatch = XXXINIT_TO_INIT,
862 /* Do not reference exit code/data from devexit/cpuexit/memexit code/data */
864 .fromsec = { DEV_EXIT_SECTIONS, CPU_EXIT_SECTIONS, MEM_EXIT_SECTIONS, NULL },
865 .tosec = { EXIT_SECTIONS, NULL },
866 .mismatch = XXXEXIT_TO_EXIT,
868 /* Do not use exit code/data from init code */
870 .fromsec = { ALL_INIT_SECTIONS, NULL },
871 .tosec = { ALL_EXIT_SECTIONS, NULL },
872 .mismatch = INIT_TO_EXIT,
874 /* Do not use init code/data from exit code */
876 .fromsec = { ALL_EXIT_SECTIONS, NULL },
877 .tosec = { ALL_INIT_SECTIONS, NULL },
878 .mismatch = EXIT_TO_INIT,
880 /* Do not export init/exit functions or data */
882 .fromsec = { "__ksymtab*", NULL },
883 .tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
884 .mismatch = EXPORT_TO_INIT_EXIT
888 static int section_mismatch(const char *fromsec, const char *tosec)
890 int i;
891 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
892 const struct sectioncheck *check = &sectioncheck[0];
894 for (i = 0; i < elems; i++) {
895 if (match(fromsec, check->fromsec) &&
896 match(tosec, check->tosec))
897 return check->mismatch;
898 check++;
900 return NO_MISMATCH;
904 * Whitelist to allow certain references to pass with no warning.
906 * Pattern 1:
907 * If a module parameter is declared __initdata and permissions=0
908 * then this is legal despite the warning generated.
909 * We cannot see value of permissions here, so just ignore
910 * this pattern.
911 * The pattern is identified by:
912 * tosec = .init.data
913 * fromsec = .data*
914 * atsym =__param*
916 * Pattern 2:
917 * Many drivers utilise a *driver container with references to
918 * add, remove, probe functions etc.
919 * These functions may often be marked __init and we do not want to
920 * warn here.
921 * the pattern is identified by:
922 * tosec = init or exit section
923 * fromsec = data section
924 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
925 * *probe_one, *_console, *_timer
927 * Pattern 3:
928 * Whitelist all references from .head.text to any init section
930 * Pattern 4:
931 * Some symbols belong to init section but still it is ok to reference
932 * these from non-init sections as these symbols don't have any memory
933 * allocated for them and symbol address and value are same. So even
934 * if init section is freed, its ok to reference those symbols.
935 * For ex. symbols marking the init section boundaries.
936 * This pattern is identified by
937 * refsymname = __init_begin, _sinittext, _einittext
940 static int secref_whitelist(const char *fromsec, const char *fromsym,
941 const char *tosec, const char *tosym)
943 /* Check for pattern 1 */
944 if (match(tosec, init_data_sections) &&
945 match(fromsec, data_sections) &&
946 (strncmp(fromsym, "__param", strlen("__param")) == 0))
947 return 0;
949 /* Check for pattern 2 */
950 if (match(tosec, init_exit_sections) &&
951 match(fromsec, data_sections) &&
952 match(fromsym, symbol_white_list))
953 return 0;
955 /* Check for pattern 3 */
956 if (match(fromsec, head_sections) &&
957 match(tosec, init_sections))
958 return 0;
960 /* Check for pattern 4 */
961 if (match(tosym, linker_symbols))
962 return 0;
964 return 1;
968 * Find symbol based on relocation record info.
969 * In some cases the symbol supplied is a valid symbol so
970 * return refsym. If st_name != 0 we assume this is a valid symbol.
971 * In other cases the symbol needs to be looked up in the symbol table
972 * based on section and address.
973 * **/
974 static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
975 Elf_Sym *relsym)
977 Elf_Sym *sym;
978 Elf_Sym *near = NULL;
979 Elf64_Sword distance = 20;
980 Elf64_Sword d;
982 if (relsym->st_name != 0)
983 return relsym;
984 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
985 if (sym->st_shndx != relsym->st_shndx)
986 continue;
987 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
988 continue;
989 if (sym->st_value == addr)
990 return sym;
991 /* Find a symbol nearby - addr are maybe negative */
992 d = sym->st_value - addr;
993 if (d < 0)
994 d = addr - sym->st_value;
995 if (d < distance) {
996 distance = d;
997 near = sym;
1000 /* We need a close match */
1001 if (distance < 20)
1002 return near;
1003 else
1004 return NULL;
1007 static inline int is_arm_mapping_symbol(const char *str)
1009 return str[0] == '$' && strchr("atd", str[1])
1010 && (str[2] == '\0' || str[2] == '.');
1014 * If there's no name there, ignore it; likewise, ignore it if it's
1015 * one of the magic symbols emitted used by current ARM tools.
1017 * Otherwise if find_symbols_between() returns those symbols, they'll
1018 * fail the whitelist tests and cause lots of false alarms ... fixable
1019 * only by merging __exit and __init sections into __text, bloating
1020 * the kernel (which is especially evil on embedded platforms).
1022 static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1024 const char *name = elf->strtab + sym->st_name;
1026 if (!name || !strlen(name))
1027 return 0;
1028 return !is_arm_mapping_symbol(name);
1032 * Find symbols before or equal addr and after addr - in the section sec.
1033 * If we find two symbols with equal offset prefer one with a valid name.
1034 * The ELF format may have a better way to detect what type of symbol
1035 * it is, but this works for now.
1037 static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1038 const char *sec)
1040 Elf_Sym *sym;
1041 Elf_Sym *near = NULL;
1042 Elf_Addr distance = ~0;
1044 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1045 const char *symsec;
1047 if (sym->st_shndx >= SHN_LORESERVE)
1048 continue;
1049 symsec = sec_name(elf, sym->st_shndx);
1050 if (strcmp(symsec, sec) != 0)
1051 continue;
1052 if (!is_valid_name(elf, sym))
1053 continue;
1054 if (sym->st_value <= addr) {
1055 if ((addr - sym->st_value) < distance) {
1056 distance = addr - sym->st_value;
1057 near = sym;
1058 } else if ((addr - sym->st_value) == distance) {
1059 near = sym;
1063 return near;
1067 * Convert a section name to the function/data attribute
1068 * .init.text => __init
1069 * .cpuinit.data => __cpudata
1070 * .memexitconst => __memconst
1071 * etc.
1073 static char *sec2annotation(const char *s)
1075 if (match(s, init_exit_sections)) {
1076 char *p = malloc(20);
1077 char *r = p;
1079 *p++ = '_';
1080 *p++ = '_';
1081 if (*s == '.')
1082 s++;
1083 while (*s && *s != '.')
1084 *p++ = *s++;
1085 *p = '\0';
1086 if (*s == '.')
1087 s++;
1088 if (strstr(s, "rodata") != NULL)
1089 strcat(p, "const ");
1090 else if (strstr(s, "data") != NULL)
1091 strcat(p, "data ");
1092 else
1093 strcat(p, " ");
1094 return r; /* we leak her but we do not care */
1095 } else {
1096 return "";
1100 static int is_function(Elf_Sym *sym)
1102 if (sym)
1103 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1104 else
1105 return -1;
1109 * Print a warning about a section mismatch.
1110 * Try to find symbols near it so user can find it.
1111 * Check whitelist before warning - it may be a false positive.
1113 static void report_sec_mismatch(const char *modname, enum mismatch mismatch,
1114 const char *fromsec,
1115 unsigned long long fromaddr,
1116 const char *fromsym,
1117 int from_is_func,
1118 const char *tosec, const char *tosym,
1119 int to_is_func)
1121 const char *from, *from_p;
1122 const char *to, *to_p;
1124 switch (from_is_func) {
1125 case 0: from = "variable"; from_p = ""; break;
1126 case 1: from = "function"; from_p = "()"; break;
1127 default: from = "(unknown reference)"; from_p = ""; break;
1129 switch (to_is_func) {
1130 case 0: to = "variable"; to_p = ""; break;
1131 case 1: to = "function"; to_p = "()"; break;
1132 default: to = "(unknown reference)"; to_p = ""; break;
1135 sec_mismatch_count++;
1136 if (!sec_mismatch_verbose)
1137 return;
1139 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1140 "to the %s %s:%s%s\n",
1141 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1142 tosym, to_p);
1144 switch (mismatch) {
1145 case TEXT_TO_INIT:
1146 fprintf(stderr,
1147 "The function %s%s() references\n"
1148 "the %s %s%s%s.\n"
1149 "This is often because %s lacks a %s\n"
1150 "annotation or the annotation of %s is wrong.\n",
1151 sec2annotation(fromsec), fromsym,
1152 to, sec2annotation(tosec), tosym, to_p,
1153 fromsym, sec2annotation(tosec), tosym);
1154 break;
1155 case DATA_TO_INIT: {
1156 const char **s = symbol_white_list;
1157 fprintf(stderr,
1158 "The variable %s references\n"
1159 "the %s %s%s%s\n"
1160 "If the reference is valid then annotate the\n"
1161 "variable with __init* (see linux/init.h) "
1162 "or name the variable:\n",
1163 fromsym, to, sec2annotation(tosec), tosym, to_p);
1164 while (*s)
1165 fprintf(stderr, "%s, ", *s++);
1166 fprintf(stderr, "\n");
1167 break;
1169 case TEXT_TO_EXIT:
1170 fprintf(stderr,
1171 "The function %s() references a %s in an exit section.\n"
1172 "Often the %s %s%s has valid usage outside the exit section\n"
1173 "and the fix is to remove the %sannotation of %s.\n",
1174 fromsym, to, to, tosym, to_p, sec2annotation(tosec), tosym);
1175 break;
1176 case DATA_TO_EXIT: {
1177 const char **s = symbol_white_list;
1178 fprintf(stderr,
1179 "The variable %s references\n"
1180 "the %s %s%s%s\n"
1181 "If the reference is valid then annotate the\n"
1182 "variable with __exit* (see linux/init.h) or "
1183 "name the variable:\n",
1184 fromsym, to, sec2annotation(tosec), tosym, to_p);
1185 while (*s)
1186 fprintf(stderr, "%s, ", *s++);
1187 fprintf(stderr, "\n");
1188 break;
1190 case XXXINIT_TO_INIT:
1191 case XXXEXIT_TO_EXIT:
1192 fprintf(stderr,
1193 "The %s %s%s%s references\n"
1194 "a %s %s%s%s.\n"
1195 "If %s is only used by %s then\n"
1196 "annotate %s with a matching annotation.\n",
1197 from, sec2annotation(fromsec), fromsym, from_p,
1198 to, sec2annotation(tosec), tosym, to_p,
1199 tosym, fromsym, tosym);
1200 break;
1201 case INIT_TO_EXIT:
1202 fprintf(stderr,
1203 "The %s %s%s%s references\n"
1204 "a %s %s%s%s.\n"
1205 "This is often seen when error handling "
1206 "in the init function\n"
1207 "uses functionality in the exit path.\n"
1208 "The fix is often to remove the %sannotation of\n"
1209 "%s%s so it may be used outside an exit section.\n",
1210 from, sec2annotation(fromsec), fromsym, from_p,
1211 to, sec2annotation(tosec), tosym, to_p,
1212 sec2annotation(tosec), tosym, to_p);
1213 break;
1214 case EXIT_TO_INIT:
1215 fprintf(stderr,
1216 "The %s %s%s%s references\n"
1217 "a %s %s%s%s.\n"
1218 "This is often seen when error handling "
1219 "in the exit function\n"
1220 "uses functionality in the init path.\n"
1221 "The fix is often to remove the %sannotation of\n"
1222 "%s%s so it may be used outside an init section.\n",
1223 from, sec2annotation(fromsec), fromsym, from_p,
1224 to, sec2annotation(tosec), tosym, to_p,
1225 sec2annotation(tosec), tosym, to_p);
1226 break;
1227 case EXPORT_TO_INIT_EXIT:
1228 fprintf(stderr,
1229 "The symbol %s is exported and annotated %s\n"
1230 "Fix this by removing the %sannotation of %s "
1231 "or drop the export.\n",
1232 tosym, sec2annotation(tosec), sec2annotation(tosec), tosym);
1233 case NO_MISMATCH:
1234 /* To get warnings on missing members */
1235 break;
1237 fprintf(stderr, "\n");
1240 static void check_section_mismatch(const char *modname, struct elf_info *elf,
1241 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1243 const char *tosec;
1244 enum mismatch mismatch;
1246 tosec = sec_name(elf, sym->st_shndx);
1247 mismatch = section_mismatch(fromsec, tosec);
1248 if (mismatch != NO_MISMATCH) {
1249 Elf_Sym *to;
1250 Elf_Sym *from;
1251 const char *tosym;
1252 const char *fromsym;
1254 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1255 fromsym = sym_name(elf, from);
1256 to = find_elf_symbol(elf, r->r_addend, sym);
1257 tosym = sym_name(elf, to);
1259 /* check whitelist - we may ignore it */
1260 if (secref_whitelist(fromsec, fromsym, tosec, tosym)) {
1261 report_sec_mismatch(modname, mismatch,
1262 fromsec, r->r_offset, fromsym,
1263 is_function(from), tosec, tosym,
1264 is_function(to));
1269 static unsigned int *reloc_location(struct elf_info *elf,
1270 Elf_Shdr *sechdr, Elf_Rela *r)
1272 Elf_Shdr *sechdrs = elf->sechdrs;
1273 int section = sechdr->sh_info;
1275 return (void *)elf->hdr + sechdrs[section].sh_offset +
1276 (r->r_offset - sechdrs[section].sh_addr);
1279 static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
1281 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1282 unsigned int *location = reloc_location(elf, sechdr, r);
1284 switch (r_typ) {
1285 case R_386_32:
1286 r->r_addend = TO_NATIVE(*location);
1287 break;
1288 case R_386_PC32:
1289 r->r_addend = TO_NATIVE(*location) + 4;
1290 /* For CONFIG_RELOCATABLE=y */
1291 if (elf->hdr->e_type == ET_EXEC)
1292 r->r_addend += r->r_offset;
1293 break;
1295 return 0;
1298 static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
1300 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1302 switch (r_typ) {
1303 case R_ARM_ABS32:
1304 /* From ARM ABI: (S + A) | T */
1305 r->r_addend = (int)(long)
1306 (elf->symtab_start + ELF_R_SYM(r->r_info));
1307 break;
1308 case R_ARM_PC24:
1309 /* From ARM ABI: ((S + A) | T) - P */
1310 r->r_addend = (int)(long)(elf->hdr +
1311 sechdr->sh_offset +
1312 (r->r_offset - sechdr->sh_addr));
1313 break;
1314 default:
1315 return 1;
1317 return 0;
1320 static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
1322 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1323 unsigned int *location = reloc_location(elf, sechdr, r);
1324 unsigned int inst;
1326 if (r_typ == R_MIPS_HI16)
1327 return 1; /* skip this */
1328 inst = TO_NATIVE(*location);
1329 switch (r_typ) {
1330 case R_MIPS_LO16:
1331 r->r_addend = inst & 0xffff;
1332 break;
1333 case R_MIPS_26:
1334 r->r_addend = (inst & 0x03ffffff) << 2;
1335 break;
1336 case R_MIPS_32:
1337 r->r_addend = inst;
1338 break;
1340 return 0;
1343 static void section_rela(const char *modname, struct elf_info *elf,
1344 Elf_Shdr *sechdr)
1346 Elf_Sym *sym;
1347 Elf_Rela *rela;
1348 Elf_Rela r;
1349 unsigned int r_sym;
1350 const char *fromsec;
1352 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
1353 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1355 fromsec = sech_name(elf, sechdr);
1356 fromsec += strlen(".rela");
1357 /* if from section (name) is know good then skip it */
1358 if (match(fromsec, section_white_list))
1359 return;
1361 for (rela = start; rela < stop; rela++) {
1362 r.r_offset = TO_NATIVE(rela->r_offset);
1363 #if KERNEL_ELFCLASS == ELFCLASS64
1364 if (elf->hdr->e_machine == EM_MIPS) {
1365 unsigned int r_typ;
1366 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1367 r_sym = TO_NATIVE(r_sym);
1368 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1369 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1370 } else {
1371 r.r_info = TO_NATIVE(rela->r_info);
1372 r_sym = ELF_R_SYM(r.r_info);
1374 #else
1375 r.r_info = TO_NATIVE(rela->r_info);
1376 r_sym = ELF_R_SYM(r.r_info);
1377 #endif
1378 r.r_addend = TO_NATIVE(rela->r_addend);
1379 sym = elf->symtab_start + r_sym;
1380 /* Skip special sections */
1381 if (sym->st_shndx >= SHN_LORESERVE)
1382 continue;
1383 check_section_mismatch(modname, elf, &r, sym, fromsec);
1387 static void section_rel(const char *modname, struct elf_info *elf,
1388 Elf_Shdr *sechdr)
1390 Elf_Sym *sym;
1391 Elf_Rel *rel;
1392 Elf_Rela r;
1393 unsigned int r_sym;
1394 const char *fromsec;
1396 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
1397 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1399 fromsec = sech_name(elf, sechdr);
1400 fromsec += strlen(".rel");
1401 /* if from section (name) is know good then skip it */
1402 if (match(fromsec, section_white_list))
1403 return;
1405 for (rel = start; rel < stop; rel++) {
1406 r.r_offset = TO_NATIVE(rel->r_offset);
1407 #if KERNEL_ELFCLASS == ELFCLASS64
1408 if (elf->hdr->e_machine == EM_MIPS) {
1409 unsigned int r_typ;
1410 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1411 r_sym = TO_NATIVE(r_sym);
1412 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1413 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1414 } else {
1415 r.r_info = TO_NATIVE(rel->r_info);
1416 r_sym = ELF_R_SYM(r.r_info);
1418 #else
1419 r.r_info = TO_NATIVE(rel->r_info);
1420 r_sym = ELF_R_SYM(r.r_info);
1421 #endif
1422 r.r_addend = 0;
1423 switch (elf->hdr->e_machine) {
1424 case EM_386:
1425 if (addend_386_rel(elf, sechdr, &r))
1426 continue;
1427 break;
1428 case EM_ARM:
1429 if (addend_arm_rel(elf, sechdr, &r))
1430 continue;
1431 break;
1432 case EM_MIPS:
1433 if (addend_mips_rel(elf, sechdr, &r))
1434 continue;
1435 break;
1437 sym = elf->symtab_start + r_sym;
1438 /* Skip special sections */
1439 if (sym->st_shndx >= SHN_LORESERVE)
1440 continue;
1441 check_section_mismatch(modname, elf, &r, sym, fromsec);
1446 * A module includes a number of sections that are discarded
1447 * either when loaded or when used as built-in.
1448 * For loaded modules all functions marked __init and all data
1449 * marked __initdata will be discarded when the module has been intialized.
1450 * Likewise for modules used built-in the sections marked __exit
1451 * are discarded because __exit marked function are supposed to be called
1452 * only when a module is unloaded which never happens for built-in modules.
1453 * The check_sec_ref() function traverses all relocation records
1454 * to find all references to a section that reference a section that will
1455 * be discarded and warns about it.
1457 static void check_sec_ref(struct module *mod, const char *modname,
1458 struct elf_info *elf)
1460 int i;
1461 Elf_Shdr *sechdrs = elf->sechdrs;
1463 /* Walk through all sections */
1464 for (i = 0; i < elf->hdr->e_shnum; i++) {
1465 check_section(modname, elf, &elf->sechdrs[i]);
1466 /* We want to process only relocation sections and not .init */
1467 if (sechdrs[i].sh_type == SHT_RELA)
1468 section_rela(modname, elf, &elf->sechdrs[i]);
1469 else if (sechdrs[i].sh_type == SHT_REL)
1470 section_rel(modname, elf, &elf->sechdrs[i]);
1474 static void get_markers(struct elf_info *info, struct module *mod)
1476 const Elf_Shdr *sh = &info->sechdrs[info->markers_strings_sec];
1477 const char *strings = (const char *) info->hdr + sh->sh_offset;
1478 const Elf_Sym *sym, *first_sym, *last_sym;
1479 size_t n;
1481 if (!info->markers_strings_sec)
1482 return;
1485 * First count the strings. We look for all the symbols defined
1486 * in the __markers_strings section named __mstrtab_*. For
1487 * these local names, the compiler puts a random .NNN suffix on,
1488 * so the names don't correspond exactly.
1490 first_sym = last_sym = NULL;
1491 n = 0;
1492 for (sym = info->symtab_start; sym < info->symtab_stop; sym++)
1493 if (ELF_ST_TYPE(sym->st_info) == STT_OBJECT &&
1494 sym->st_shndx == info->markers_strings_sec &&
1495 !strncmp(info->strtab + sym->st_name,
1496 "__mstrtab_", sizeof "__mstrtab_" - 1)) {
1497 if (first_sym == NULL)
1498 first_sym = sym;
1499 last_sym = sym;
1500 ++n;
1503 if (n == 0)
1504 return;
1507 * Now collect each name and format into a line for the output.
1508 * Lines look like:
1509 * marker_name vmlinux marker %s format %d
1510 * The format string after the second \t can use whitespace.
1512 mod->markers = NOFAIL(malloc(sizeof mod->markers[0] * n));
1513 mod->nmarkers = n;
1515 n = 0;
1516 for (sym = first_sym; sym <= last_sym; sym++)
1517 if (ELF_ST_TYPE(sym->st_info) == STT_OBJECT &&
1518 sym->st_shndx == info->markers_strings_sec &&
1519 !strncmp(info->strtab + sym->st_name,
1520 "__mstrtab_", sizeof "__mstrtab_" - 1)) {
1521 const char *name = strings + sym->st_value;
1522 const char *fmt = strchr(name, '\0') + 1;
1523 char *line = NULL;
1524 asprintf(&line, "%s\t%s\t%s\n", name, mod->name, fmt);
1525 NOFAIL(line);
1526 mod->markers[n++] = line;
1530 static void read_symbols(char *modname)
1532 const char *symname;
1533 char *version;
1534 char *license;
1535 struct module *mod;
1536 struct elf_info info = { };
1537 Elf_Sym *sym;
1539 if (!parse_elf(&info, modname))
1540 return;
1542 mod = new_module(modname);
1544 /* When there's no vmlinux, don't print warnings about
1545 * unresolved symbols (since there'll be too many ;) */
1546 if (is_vmlinux(modname)) {
1547 have_vmlinux = 1;
1548 mod->skip = 1;
1551 license = get_modinfo(info.modinfo, info.modinfo_len, "license");
1552 if (info.modinfo && !license && !is_vmlinux(modname))
1553 warn("modpost: missing MODULE_LICENSE() in %s\n"
1554 "see include/linux/module.h for "
1555 "more information\n", modname);
1556 while (license) {
1557 if (license_is_gpl_compatible(license))
1558 mod->gpl_compatible = 1;
1559 else {
1560 mod->gpl_compatible = 0;
1561 break;
1563 license = get_next_modinfo(info.modinfo, info.modinfo_len,
1564 "license", license);
1567 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
1568 symname = info.strtab + sym->st_name;
1570 handle_modversions(mod, &info, sym, symname);
1571 handle_moddevtable(mod, &info, sym, symname);
1573 if (!is_vmlinux(modname) ||
1574 (is_vmlinux(modname) && vmlinux_section_warnings))
1575 check_sec_ref(mod, modname, &info);
1577 version = get_modinfo(info.modinfo, info.modinfo_len, "version");
1578 if (version)
1579 maybe_frob_rcs_version(modname, version, info.modinfo,
1580 version - (char *)info.hdr);
1581 if (version || (all_versions && !is_vmlinux(modname)))
1582 get_src_version(modname, mod->srcversion,
1583 sizeof(mod->srcversion)-1);
1585 get_markers(&info, mod);
1587 parse_elf_finish(&info);
1589 /* Our trick to get versioning for module struct etc. - it's
1590 * never passed as an argument to an exported function, so
1591 * the automatic versioning doesn't pick it up, but it's really
1592 * important anyhow */
1593 if (modversions)
1594 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
1597 #define SZ 500
1599 /* We first write the generated file into memory using the
1600 * following helper, then compare to the file on disk and
1601 * only update the later if anything changed */
1603 void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
1604 const char *fmt, ...)
1606 char tmp[SZ];
1607 int len;
1608 va_list ap;
1610 va_start(ap, fmt);
1611 len = vsnprintf(tmp, SZ, fmt, ap);
1612 buf_write(buf, tmp, len);
1613 va_end(ap);
1616 void buf_write(struct buffer *buf, const char *s, int len)
1618 if (buf->size - buf->pos < len) {
1619 buf->size += len + SZ;
1620 buf->p = realloc(buf->p, buf->size);
1622 strncpy(buf->p + buf->pos, s, len);
1623 buf->pos += len;
1626 static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
1628 const char *e = is_vmlinux(m) ?"":".ko";
1630 switch (exp) {
1631 case export_gpl:
1632 fatal("modpost: GPL-incompatible module %s%s "
1633 "uses GPL-only symbol '%s'\n", m, e, s);
1634 break;
1635 case export_unused_gpl:
1636 fatal("modpost: GPL-incompatible module %s%s "
1637 "uses GPL-only symbol marked UNUSED '%s'\n", m, e, s);
1638 break;
1639 case export_gpl_future:
1640 warn("modpost: GPL-incompatible module %s%s "
1641 "uses future GPL-only symbol '%s'\n", m, e, s);
1642 break;
1643 case export_plain:
1644 case export_unused:
1645 case export_unknown:
1646 /* ignore */
1647 break;
1651 static void check_for_unused(enum export exp, const char *m, const char *s)
1653 const char *e = is_vmlinux(m) ?"":".ko";
1655 switch (exp) {
1656 case export_unused:
1657 case export_unused_gpl:
1658 warn("modpost: module %s%s "
1659 "uses symbol '%s' marked UNUSED\n", m, e, s);
1660 break;
1661 default:
1662 /* ignore */
1663 break;
1667 static void check_exports(struct module *mod)
1669 struct symbol *s, *exp;
1671 for (s = mod->unres; s; s = s->next) {
1672 const char *basename;
1673 exp = find_symbol(s->name);
1674 if (!exp || exp->module == mod)
1675 continue;
1676 basename = strrchr(mod->name, '/');
1677 if (basename)
1678 basename++;
1679 else
1680 basename = mod->name;
1681 if (!mod->gpl_compatible)
1682 check_for_gpl_usage(exp->export, basename, exp->name);
1683 check_for_unused(exp->export, basename, exp->name);
1688 * Header for the generated file
1690 static void add_header(struct buffer *b, struct module *mod)
1692 buf_printf(b, "#include <linux/module.h>\n");
1693 buf_printf(b, "#include <linux/vermagic.h>\n");
1694 buf_printf(b, "#include <linux/compiler.h>\n");
1695 buf_printf(b, "\n");
1696 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
1697 buf_printf(b, "\n");
1698 buf_printf(b, "struct module __this_module\n");
1699 buf_printf(b, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
1700 buf_printf(b, " .name = KBUILD_MODNAME,\n");
1701 if (mod->has_init)
1702 buf_printf(b, " .init = init_module,\n");
1703 if (mod->has_cleanup)
1704 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
1705 " .exit = cleanup_module,\n"
1706 "#endif\n");
1707 buf_printf(b, " .arch = MODULE_ARCH_INIT,\n");
1708 buf_printf(b, "};\n");
1711 void add_staging_flag(struct buffer *b, const char *name)
1713 static const char *staging_dir = "drivers/staging";
1715 if (strncmp(staging_dir, name, strlen(staging_dir)) == 0)
1716 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
1720 * Record CRCs for unresolved symbols
1722 static int add_versions(struct buffer *b, struct module *mod)
1724 struct symbol *s, *exp;
1725 int err = 0;
1727 for (s = mod->unres; s; s = s->next) {
1728 exp = find_symbol(s->name);
1729 if (!exp || exp->module == mod) {
1730 if (have_vmlinux && !s->weak) {
1731 if (warn_unresolved) {
1732 warn("\"%s\" [%s.ko] undefined!\n",
1733 s->name, mod->name);
1734 } else {
1735 merror("\"%s\" [%s.ko] undefined!\n",
1736 s->name, mod->name);
1737 err = 1;
1740 continue;
1742 s->module = exp->module;
1743 s->crc_valid = exp->crc_valid;
1744 s->crc = exp->crc;
1747 if (!modversions)
1748 return err;
1750 buf_printf(b, "\n");
1751 buf_printf(b, "static const struct modversion_info ____versions[]\n");
1752 buf_printf(b, "__used\n");
1753 buf_printf(b, "__attribute__((section(\"__versions\"))) = {\n");
1755 for (s = mod->unres; s; s = s->next) {
1756 if (!s->module)
1757 continue;
1758 if (!s->crc_valid) {
1759 warn("\"%s\" [%s.ko] has no CRC!\n",
1760 s->name, mod->name);
1761 continue;
1763 buf_printf(b, "\t{ %#8x, \"%s\" },\n", s->crc, s->name);
1766 buf_printf(b, "};\n");
1768 return err;
1771 static void add_depends(struct buffer *b, struct module *mod,
1772 struct module *modules)
1774 struct symbol *s;
1775 struct module *m;
1776 int first = 1;
1778 for (m = modules; m; m = m->next)
1779 m->seen = is_vmlinux(m->name);
1781 buf_printf(b, "\n");
1782 buf_printf(b, "static const char __module_depends[]\n");
1783 buf_printf(b, "__used\n");
1784 buf_printf(b, "__attribute__((section(\".modinfo\"))) =\n");
1785 buf_printf(b, "\"depends=");
1786 for (s = mod->unres; s; s = s->next) {
1787 const char *p;
1788 if (!s->module)
1789 continue;
1791 if (s->module->seen)
1792 continue;
1794 s->module->seen = 1;
1795 p = strrchr(s->module->name, '/');
1796 if (p)
1797 p++;
1798 else
1799 p = s->module->name;
1800 buf_printf(b, "%s%s", first ? "" : ",", p);
1801 first = 0;
1803 buf_printf(b, "\";\n");
1806 static void add_srcversion(struct buffer *b, struct module *mod)
1808 if (mod->srcversion[0]) {
1809 buf_printf(b, "\n");
1810 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
1811 mod->srcversion);
1815 static void write_if_changed(struct buffer *b, const char *fname)
1817 char *tmp;
1818 FILE *file;
1819 struct stat st;
1821 file = fopen(fname, "r");
1822 if (!file)
1823 goto write;
1825 if (fstat(fileno(file), &st) < 0)
1826 goto close_write;
1828 if (st.st_size != b->pos)
1829 goto close_write;
1831 tmp = NOFAIL(malloc(b->pos));
1832 if (fread(tmp, 1, b->pos, file) != b->pos)
1833 goto free_write;
1835 if (memcmp(tmp, b->p, b->pos) != 0)
1836 goto free_write;
1838 free(tmp);
1839 fclose(file);
1840 return;
1842 free_write:
1843 free(tmp);
1844 close_write:
1845 fclose(file);
1846 write:
1847 file = fopen(fname, "w");
1848 if (!file) {
1849 perror(fname);
1850 exit(1);
1852 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
1853 perror(fname);
1854 exit(1);
1856 fclose(file);
1859 /* parse Module.symvers file. line format:
1860 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
1862 static void read_dump(const char *fname, unsigned int kernel)
1864 unsigned long size, pos = 0;
1865 void *file = grab_file(fname, &size);
1866 char *line;
1868 if (!file)
1869 /* No symbol versions, silently ignore */
1870 return;
1872 while ((line = get_next_line(&pos, file, size))) {
1873 char *symname, *modname, *d, *export, *end;
1874 unsigned int crc;
1875 struct module *mod;
1876 struct symbol *s;
1878 if (!(symname = strchr(line, '\t')))
1879 goto fail;
1880 *symname++ = '\0';
1881 if (!(modname = strchr(symname, '\t')))
1882 goto fail;
1883 *modname++ = '\0';
1884 if ((export = strchr(modname, '\t')) != NULL)
1885 *export++ = '\0';
1886 if (export && ((end = strchr(export, '\t')) != NULL))
1887 *end = '\0';
1888 crc = strtoul(line, &d, 16);
1889 if (*symname == '\0' || *modname == '\0' || *d != '\0')
1890 goto fail;
1891 mod = find_module(modname);
1892 if (!mod) {
1893 if (is_vmlinux(modname))
1894 have_vmlinux = 1;
1895 mod = new_module(modname);
1896 mod->skip = 1;
1898 s = sym_add_exported(symname, mod, export_no(export));
1899 s->kernel = kernel;
1900 s->preloaded = 1;
1901 sym_update_crc(symname, mod, crc, export_no(export));
1903 return;
1904 fail:
1905 fatal("parse error in symbol dump file\n");
1908 /* For normal builds always dump all symbols.
1909 * For external modules only dump symbols
1910 * that are not read from kernel Module.symvers.
1912 static int dump_sym(struct symbol *sym)
1914 if (!external_module)
1915 return 1;
1916 if (sym->vmlinux || sym->kernel)
1917 return 0;
1918 return 1;
1921 static void write_dump(const char *fname)
1923 struct buffer buf = { };
1924 struct symbol *symbol;
1925 int n;
1927 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
1928 symbol = symbolhash[n];
1929 while (symbol) {
1930 if (dump_sym(symbol))
1931 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\n",
1932 symbol->crc, symbol->name,
1933 symbol->module->name,
1934 export_str(symbol->export));
1935 symbol = symbol->next;
1938 write_if_changed(&buf, fname);
1941 static void add_marker(struct module *mod, const char *name, const char *fmt)
1943 char *line = NULL;
1944 asprintf(&line, "%s\t%s\t%s\n", name, mod->name, fmt);
1945 NOFAIL(line);
1947 mod->markers = NOFAIL(realloc(mod->markers, ((mod->nmarkers + 1) *
1948 sizeof mod->markers[0])));
1949 mod->markers[mod->nmarkers++] = line;
1952 static void read_markers(const char *fname)
1954 unsigned long size, pos = 0;
1955 void *file = grab_file(fname, &size);
1956 char *line;
1958 if (!file) /* No old markers, silently ignore */
1959 return;
1961 while ((line = get_next_line(&pos, file, size))) {
1962 char *marker, *modname, *fmt;
1963 struct module *mod;
1965 marker = line;
1966 modname = strchr(marker, '\t');
1967 if (!modname)
1968 goto fail;
1969 *modname++ = '\0';
1970 fmt = strchr(modname, '\t');
1971 if (!fmt)
1972 goto fail;
1973 *fmt++ = '\0';
1974 if (*marker == '\0' || *modname == '\0')
1975 goto fail;
1977 mod = find_module(modname);
1978 if (!mod) {
1979 mod = new_module(modname);
1980 mod->skip = 1;
1982 if (is_vmlinux(modname)) {
1983 have_vmlinux = 1;
1984 mod->skip = 0;
1987 if (!mod->skip)
1988 add_marker(mod, marker, fmt);
1990 release_file(file, size);
1991 return;
1992 fail:
1993 fatal("parse error in markers list file\n");
1996 static int compare_strings(const void *a, const void *b)
1998 return strcmp(*(const char **) a, *(const char **) b);
2001 static void write_markers(const char *fname)
2003 struct buffer buf = { };
2004 struct module *mod;
2005 size_t i;
2007 for (mod = modules; mod; mod = mod->next)
2008 if ((!external_module || !mod->skip) && mod->markers != NULL) {
2010 * Sort the strings so we can skip duplicates when
2011 * we write them out.
2013 qsort(mod->markers, mod->nmarkers,
2014 sizeof mod->markers[0], &compare_strings);
2015 for (i = 0; i < mod->nmarkers; ++i) {
2016 char *line = mod->markers[i];
2017 buf_write(&buf, line, strlen(line));
2018 while (i + 1 < mod->nmarkers &&
2019 !strcmp(mod->markers[i],
2020 mod->markers[i + 1]))
2021 free(mod->markers[i++]);
2022 free(mod->markers[i]);
2024 free(mod->markers);
2025 mod->markers = NULL;
2028 write_if_changed(&buf, fname);
2031 struct ext_sym_list {
2032 struct ext_sym_list *next;
2033 const char *file;
2036 int main(int argc, char **argv)
2038 struct module *mod;
2039 struct buffer buf = { };
2040 char *kernel_read = NULL, *module_read = NULL;
2041 char *dump_write = NULL;
2042 char *markers_read = NULL;
2043 char *markers_write = NULL;
2044 int opt;
2045 int err;
2046 struct ext_sym_list *extsym_iter;
2047 struct ext_sym_list *extsym_start = NULL;
2049 while ((opt = getopt(argc, argv, "i:I:e:cmsSo:awM:K:")) != -1) {
2050 switch (opt) {
2051 case 'i':
2052 kernel_read = optarg;
2053 break;
2054 case 'I':
2055 module_read = optarg;
2056 external_module = 1;
2057 break;
2058 case 'c':
2059 cross_build = 1;
2060 break;
2061 case 'e':
2062 external_module = 1;
2063 extsym_iter =
2064 NOFAIL(malloc(sizeof(*extsym_iter)));
2065 extsym_iter->next = extsym_start;
2066 extsym_iter->file = optarg;
2067 extsym_start = extsym_iter;
2068 break;
2069 case 'm':
2070 modversions = 1;
2071 break;
2072 case 'o':
2073 dump_write = optarg;
2074 break;
2075 case 'a':
2076 all_versions = 1;
2077 break;
2078 case 's':
2079 vmlinux_section_warnings = 0;
2080 break;
2081 case 'S':
2082 sec_mismatch_verbose = 0;
2083 break;
2084 case 'w':
2085 warn_unresolved = 1;
2086 break;
2087 case 'M':
2088 markers_write = optarg;
2089 break;
2090 case 'K':
2091 markers_read = optarg;
2092 break;
2093 default:
2094 exit(1);
2098 if (kernel_read)
2099 read_dump(kernel_read, 1);
2100 if (module_read)
2101 read_dump(module_read, 0);
2102 while (extsym_start) {
2103 read_dump(extsym_start->file, 0);
2104 extsym_iter = extsym_start->next;
2105 free(extsym_start);
2106 extsym_start = extsym_iter;
2109 while (optind < argc)
2110 read_symbols(argv[optind++]);
2112 for (mod = modules; mod; mod = mod->next) {
2113 if (mod->skip)
2114 continue;
2115 check_exports(mod);
2118 err = 0;
2120 for (mod = modules; mod; mod = mod->next) {
2121 char fname[strlen(mod->name) + 10];
2123 if (mod->skip)
2124 continue;
2126 buf.pos = 0;
2128 add_header(&buf, mod);
2129 add_staging_flag(&buf, mod->name);
2130 err |= add_versions(&buf, mod);
2131 add_depends(&buf, mod, modules);
2132 add_moddevtable(&buf, mod);
2133 add_srcversion(&buf, mod);
2135 sprintf(fname, "%s.mod.c", mod->name);
2136 write_if_changed(&buf, fname);
2139 if (dump_write)
2140 write_dump(dump_write);
2141 if (sec_mismatch_count && !sec_mismatch_verbose)
2142 warn("modpost: Found %d section mismatch(es).\n"
2143 "To see full details build your kernel with:\n"
2144 "'make CONFIG_DEBUG_SECTION_MISMATCH=y'\n",
2145 sec_mismatch_count);
2147 if (markers_read)
2148 read_markers(markers_read);
2150 if (markers_write)
2151 write_markers(markers_write);
2153 return err;