]> bbs.cooldavid.org Git - net-next-2.6.git/blame - scripts/mod/modpost.c
all-archs: consolidate .data section definition in asm-generic
[net-next-2.6.git] / scripts / mod / modpost.c
CommitLineData
1da177e4
LT
1/* Postprocess module symbol versions
2 *
3 * Copyright 2003 Kai Germaschewski
4 * Copyright 2002-2004 Rusty Russell, IBM Corporation
382168f4 5 * Copyright 2006 Sam Ravnborg
1da177e4
LT
6 * Based in part on module-init-tools/depmod.c,file2alias
7 *
8 * This software may be used and distributed according to the terms
9 * of the GNU General Public License, incorporated herein by reference.
10 *
11 * Usage: modpost vmlinux module1.o module2.o ...
12 */
13
14#include <ctype.h>
15#include "modpost.h"
b817f6fe 16#include "../../include/linux/license.h"
1da177e4
LT
17
18/* Are we using CONFIG_MODVERSIONS? */
19int modversions = 0;
20/* Warn about undefined symbols? (do so if we have vmlinux) */
21int have_vmlinux = 0;
22/* Is CONFIG_MODULE_SRCVERSION_ALL set? */
23static int all_versions = 0;
040fcc81
SR
24/* If we are modposting external module set to 1 */
25static int external_module = 0;
c53ddacd
KK
26/* Only warn about unresolved symbols */
27static int warn_unresolved = 0;
bd5cbced 28/* How a symbol is exported */
c96fca21
SR
29enum export {
30 export_plain, export_unused, export_gpl,
31 export_unused_gpl, export_gpl_future, export_unknown
32};
1da177e4 33
5c3ead8c 34void fatal(const char *fmt, ...)
1da177e4
LT
35{
36 va_list arglist;
37
38 fprintf(stderr, "FATAL: ");
39
40 va_start(arglist, fmt);
41 vfprintf(stderr, fmt, arglist);
42 va_end(arglist);
43
44 exit(1);
45}
46
5c3ead8c 47void warn(const char *fmt, ...)
1da177e4
LT
48{
49 va_list arglist;
50
51 fprintf(stderr, "WARNING: ");
52
53 va_start(arglist, fmt);
54 vfprintf(stderr, fmt, arglist);
55 va_end(arglist);
56}
57
2a116659
MW
58void merror(const char *fmt, ...)
59{
60 va_list arglist;
61
62 fprintf(stderr, "ERROR: ");
63
64 va_start(arglist, fmt);
65 vfprintf(stderr, fmt, arglist);
66 va_end(arglist);
67}
68
040fcc81
SR
69static int is_vmlinux(const char *modname)
70{
71 const char *myname;
72
73 if ((myname = strrchr(modname, '/')))
74 myname++;
75 else
76 myname = modname;
77
78 return strcmp(myname, "vmlinux") == 0;
79}
80
1da177e4
LT
81void *do_nofail(void *ptr, const char *expr)
82{
83 if (!ptr) {
84 fatal("modpost: Memory allocation failure: %s.\n", expr);
85 }
86 return ptr;
87}
88
89/* A list of all modules we processed */
90
91static struct module *modules;
92
5c3ead8c 93static struct module *find_module(char *modname)
1da177e4
LT
94{
95 struct module *mod;
96
97 for (mod = modules; mod; mod = mod->next)
98 if (strcmp(mod->name, modname) == 0)
99 break;
100 return mod;
101}
102
5c3ead8c 103static struct module *new_module(char *modname)
1da177e4
LT
104{
105 struct module *mod;
106 char *p, *s;
62070fa4 107
1da177e4
LT
108 mod = NOFAIL(malloc(sizeof(*mod)));
109 memset(mod, 0, sizeof(*mod));
110 p = NOFAIL(strdup(modname));
111
112 /* strip trailing .o */
113 if ((s = strrchr(p, '.')) != NULL)
114 if (strcmp(s, ".o") == 0)
115 *s = '\0';
116
117 /* add to list */
118 mod->name = p;
b817f6fe 119 mod->gpl_compatible = -1;
1da177e4
LT
120 mod->next = modules;
121 modules = mod;
122
123 return mod;
124}
125
126/* A hash of all exported symbols,
127 * struct symbol is also used for lists of unresolved symbols */
128
129#define SYMBOL_HASH_SIZE 1024
130
131struct symbol {
132 struct symbol *next;
133 struct module *module;
134 unsigned int crc;
135 int crc_valid;
136 unsigned int weak:1;
040fcc81
SR
137 unsigned int vmlinux:1; /* 1 if symbol is defined in vmlinux */
138 unsigned int kernel:1; /* 1 if symbol is from kernel
139 * (only for external modules) **/
8e70c458 140 unsigned int preloaded:1; /* 1 if symbol from Module.symvers */
bd5cbced 141 enum export export; /* Type of export */
1da177e4
LT
142 char name[0];
143};
144
145static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
146
147/* This is based on the hash agorithm from gdbm, via tdb */
148static inline unsigned int tdb_hash(const char *name)
149{
150 unsigned value; /* Used to compute the hash value. */
151 unsigned i; /* Used to cycle through random values. */
152
153 /* Set the initial value from the key size. */
154 for (value = 0x238F13AF * strlen(name), i=0; name[i]; i++)
155 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
156
157 return (1103515243 * value + 12345);
158}
159
5c3ead8c
SR
160/**
161 * Allocate a new symbols for use in the hash of exported symbols or
162 * the list of unresolved symbols per module
163 **/
164static struct symbol *alloc_symbol(const char *name, unsigned int weak,
165 struct symbol *next)
1da177e4
LT
166{
167 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
168
169 memset(s, 0, sizeof(*s));
170 strcpy(s->name, name);
171 s->weak = weak;
172 s->next = next;
173 return s;
174}
175
176/* For the hash of exported symbols */
bd5cbced
RP
177static struct symbol *new_symbol(const char *name, struct module *module,
178 enum export export)
1da177e4
LT
179{
180 unsigned int hash;
181 struct symbol *new;
182
183 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
184 new = symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
185 new->module = module;
bd5cbced 186 new->export = export;
040fcc81 187 return new;
1da177e4
LT
188}
189
5c3ead8c 190static struct symbol *find_symbol(const char *name)
1da177e4
LT
191{
192 struct symbol *s;
193
194 /* For our purposes, .foo matches foo. PPC64 needs this. */
195 if (name[0] == '.')
196 name++;
197
198 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s=s->next) {
199 if (strcmp(s->name, name) == 0)
200 return s;
201 }
202 return NULL;
203}
204
bd5cbced
RP
205static struct {
206 const char *str;
207 enum export export;
208} export_list[] = {
209 { .str = "EXPORT_SYMBOL", .export = export_plain },
c96fca21 210 { .str = "EXPORT_UNUSED_SYMBOL", .export = export_unused },
bd5cbced 211 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
c96fca21 212 { .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
bd5cbced
RP
213 { .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
214 { .str = "(unknown)", .export = export_unknown },
215};
216
217
218static const char *export_str(enum export ex)
219{
220 return export_list[ex].str;
221}
222
223static enum export export_no(const char * s)
224{
225 int i;
534b89a9
SR
226 if (!s)
227 return export_unknown;
bd5cbced
RP
228 for (i = 0; export_list[i].export != export_unknown; i++) {
229 if (strcmp(export_list[i].str, s) == 0)
230 return export_list[i].export;
231 }
232 return export_unknown;
233}
234
235static enum export export_from_sec(struct elf_info *elf, Elf_Section sec)
236{
237 if (sec == elf->export_sec)
238 return export_plain;
c96fca21
SR
239 else if (sec == elf->export_unused_sec)
240 return export_unused;
bd5cbced
RP
241 else if (sec == elf->export_gpl_sec)
242 return export_gpl;
c96fca21
SR
243 else if (sec == elf->export_unused_gpl_sec)
244 return export_unused_gpl;
bd5cbced
RP
245 else if (sec == elf->export_gpl_future_sec)
246 return export_gpl_future;
247 else
248 return export_unknown;
249}
250
5c3ead8c
SR
251/**
252 * Add an exported symbol - it may have already been added without a
253 * CRC, in this case just update the CRC
254 **/
bd5cbced
RP
255static struct symbol *sym_add_exported(const char *name, struct module *mod,
256 enum export export)
1da177e4
LT
257{
258 struct symbol *s = find_symbol(name);
259
260 if (!s) {
bd5cbced 261 s = new_symbol(name, mod, export);
8e70c458
SR
262 } else {
263 if (!s->preloaded) {
7b75b13c 264 warn("%s: '%s' exported twice. Previous export "
8e70c458
SR
265 "was in %s%s\n", mod->name, name,
266 s->module->name,
267 is_vmlinux(s->module->name) ?"":".ko");
268 }
1da177e4 269 }
8e70c458 270 s->preloaded = 0;
040fcc81
SR
271 s->vmlinux = is_vmlinux(mod->name);
272 s->kernel = 0;
bd5cbced 273 s->export = export;
040fcc81
SR
274 return s;
275}
276
277static void sym_update_crc(const char *name, struct module *mod,
bd5cbced 278 unsigned int crc, enum export export)
040fcc81
SR
279{
280 struct symbol *s = find_symbol(name);
281
282 if (!s)
bd5cbced 283 s = new_symbol(name, mod, export);
040fcc81
SR
284 s->crc = crc;
285 s->crc_valid = 1;
1da177e4
LT
286}
287
5c3ead8c 288void *grab_file(const char *filename, unsigned long *size)
1da177e4
LT
289{
290 struct stat st;
291 void *map;
292 int fd;
293
294 fd = open(filename, O_RDONLY);
295 if (fd < 0 || fstat(fd, &st) != 0)
296 return NULL;
297
298 *size = st.st_size;
299 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
300 close(fd);
301
302 if (map == MAP_FAILED)
303 return NULL;
304 return map;
305}
306
5c3ead8c
SR
307/**
308 * Return a copy of the next line in a mmap'ed file.
309 * spaces in the beginning of the line is trimmed away.
310 * Return a pointer to a static buffer.
311 **/
312char* get_next_line(unsigned long *pos, void *file, unsigned long size)
1da177e4
LT
313{
314 static char line[4096];
315 int skip = 1;
316 size_t len = 0;
317 signed char *p = (signed char *)file + *pos;
318 char *s = line;
319
320 for (; *pos < size ; (*pos)++)
321 {
322 if (skip && isspace(*p)) {
323 p++;
324 continue;
325 }
326 skip = 0;
327 if (*p != '\n' && (*pos < size)) {
328 len++;
329 *s++ = *p++;
330 if (len > 4095)
331 break; /* Too long, stop */
332 } else {
333 /* End of string */
334 *s = '\0';
335 return line;
336 }
337 }
338 /* End of buffer */
339 return NULL;
340}
341
5c3ead8c 342void release_file(void *file, unsigned long size)
1da177e4
LT
343{
344 munmap(file, size);
345}
346
85bd2fdd 347static int parse_elf(struct elf_info *info, const char *filename)
1da177e4
LT
348{
349 unsigned int i;
85bd2fdd 350 Elf_Ehdr *hdr;
1da177e4
LT
351 Elf_Shdr *sechdrs;
352 Elf_Sym *sym;
353
354 hdr = grab_file(filename, &info->size);
355 if (!hdr) {
356 perror(filename);
6803dc0e 357 exit(1);
1da177e4
LT
358 }
359 info->hdr = hdr;
85bd2fdd
SR
360 if (info->size < sizeof(*hdr)) {
361 /* file too small, assume this is an empty .o file */
362 return 0;
363 }
364 /* Is this a valid ELF file? */
365 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
366 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
367 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
368 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
369 /* Not an ELF file - silently ignore it */
370 return 0;
371 }
1da177e4
LT
372 /* Fix endianness in ELF header */
373 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
374 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
375 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
376 hdr->e_machine = TO_NATIVE(hdr->e_machine);
377 sechdrs = (void *)hdr + hdr->e_shoff;
378 info->sechdrs = sechdrs;
379
380 /* Fix endianness in section headers */
381 for (i = 0; i < hdr->e_shnum; i++) {
382 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
383 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
384 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
385 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
386 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
f892b7d4 387 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
1da177e4
LT
388 }
389 /* Find symbol table. */
390 for (i = 1; i < hdr->e_shnum; i++) {
391 const char *secstrings
392 = (void *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
bd5cbced 393 const char *secname;
1da177e4 394
85bd2fdd
SR
395 if (sechdrs[i].sh_offset > info->size) {
396 fatal("%s is truncated. sechdrs[i].sh_offset=%u > sizeof(*hrd)=%ul\n", filename, (unsigned int)sechdrs[i].sh_offset, sizeof(*hdr));
397 return 0;
398 }
bd5cbced
RP
399 secname = secstrings + sechdrs[i].sh_name;
400 if (strcmp(secname, ".modinfo") == 0) {
1da177e4
LT
401 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
402 info->modinfo_len = sechdrs[i].sh_size;
bd5cbced
RP
403 } else if (strcmp(secname, "__ksymtab") == 0)
404 info->export_sec = i;
c96fca21
SR
405 else if (strcmp(secname, "__ksymtab_unused") == 0)
406 info->export_unused_sec = i;
bd5cbced
RP
407 else if (strcmp(secname, "__ksymtab_gpl") == 0)
408 info->export_gpl_sec = i;
c96fca21
SR
409 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
410 info->export_unused_gpl_sec = i;
bd5cbced
RP
411 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
412 info->export_gpl_future_sec = i;
413
1da177e4
LT
414 if (sechdrs[i].sh_type != SHT_SYMTAB)
415 continue;
416
417 info->symtab_start = (void *)hdr + sechdrs[i].sh_offset;
62070fa4 418 info->symtab_stop = (void *)hdr + sechdrs[i].sh_offset
1da177e4 419 + sechdrs[i].sh_size;
62070fa4 420 info->strtab = (void *)hdr +
1da177e4
LT
421 sechdrs[sechdrs[i].sh_link].sh_offset;
422 }
423 if (!info->symtab_start) {
cb80514d 424 fatal("%s has no symtab?\n", filename);
1da177e4
LT
425 }
426 /* Fix endianness in symbols */
427 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
428 sym->st_shndx = TO_NATIVE(sym->st_shndx);
429 sym->st_name = TO_NATIVE(sym->st_name);
430 sym->st_value = TO_NATIVE(sym->st_value);
431 sym->st_size = TO_NATIVE(sym->st_size);
432 }
85bd2fdd 433 return 1;
1da177e4
LT
434}
435
5c3ead8c 436static void parse_elf_finish(struct elf_info *info)
1da177e4
LT
437{
438 release_file(info->hdr, info->size);
439}
440
f7b05e64
LY
441#define CRC_PFX MODULE_SYMBOL_PREFIX "__crc_"
442#define KSYMTAB_PFX MODULE_SYMBOL_PREFIX "__ksymtab_"
1da177e4 443
5c3ead8c
SR
444static void handle_modversions(struct module *mod, struct elf_info *info,
445 Elf_Sym *sym, const char *symname)
1da177e4
LT
446{
447 unsigned int crc;
bd5cbced 448 enum export export = export_from_sec(info, sym->st_shndx);
1da177e4
LT
449
450 switch (sym->st_shndx) {
451 case SHN_COMMON:
cb80514d 452 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
1da177e4
LT
453 break;
454 case SHN_ABS:
455 /* CRC'd symbol */
456 if (memcmp(symname, CRC_PFX, strlen(CRC_PFX)) == 0) {
457 crc = (unsigned int) sym->st_value;
bd5cbced
RP
458 sym_update_crc(symname + strlen(CRC_PFX), mod, crc,
459 export);
1da177e4
LT
460 }
461 break;
462 case SHN_UNDEF:
463 /* undefined symbol */
464 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
465 ELF_ST_BIND(sym->st_info) != STB_WEAK)
466 break;
467 /* ignore global offset table */
468 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
469 break;
470 /* ignore __this_module, it will be resolved shortly */
471 if (strcmp(symname, MODULE_SYMBOL_PREFIX "__this_module") == 0)
472 break;
8d529014
BC
473/* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
474#if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
475/* add compatibility with older glibc */
476#ifndef STT_SPARC_REGISTER
477#define STT_SPARC_REGISTER STT_REGISTER
478#endif
1da177e4
LT
479 if (info->hdr->e_machine == EM_SPARC ||
480 info->hdr->e_machine == EM_SPARCV9) {
481 /* Ignore register directives. */
8d529014 482 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
1da177e4 483 break;
62070fa4
SR
484 if (symname[0] == '.') {
485 char *munged = strdup(symname);
486 munged[0] = '_';
487 munged[1] = toupper(munged[1]);
488 symname = munged;
489 }
1da177e4
LT
490 }
491#endif
62070fa4 492
1da177e4
LT
493 if (memcmp(symname, MODULE_SYMBOL_PREFIX,
494 strlen(MODULE_SYMBOL_PREFIX)) == 0)
495 mod->unres = alloc_symbol(symname +
496 strlen(MODULE_SYMBOL_PREFIX),
497 ELF_ST_BIND(sym->st_info) == STB_WEAK,
498 mod->unres);
499 break;
500 default:
501 /* All exported symbols */
502 if (memcmp(symname, KSYMTAB_PFX, strlen(KSYMTAB_PFX)) == 0) {
bd5cbced
RP
503 sym_add_exported(symname + strlen(KSYMTAB_PFX), mod,
504 export);
1da177e4
LT
505 }
506 if (strcmp(symname, MODULE_SYMBOL_PREFIX "init_module") == 0)
507 mod->has_init = 1;
508 if (strcmp(symname, MODULE_SYMBOL_PREFIX "cleanup_module") == 0)
509 mod->has_cleanup = 1;
510 break;
511 }
512}
513
5c3ead8c
SR
514/**
515 * Parse tag=value strings from .modinfo section
516 **/
1da177e4
LT
517static char *next_string(char *string, unsigned long *secsize)
518{
519 /* Skip non-zero chars */
520 while (string[0]) {
521 string++;
522 if ((*secsize)-- <= 1)
523 return NULL;
524 }
525
526 /* Skip any zero padding. */
527 while (!string[0]) {
528 string++;
529 if ((*secsize)-- <= 1)
530 return NULL;
531 }
532 return string;
533}
534
b817f6fe
SR
535static char *get_next_modinfo(void *modinfo, unsigned long modinfo_len,
536 const char *tag, char *info)
1da177e4
LT
537{
538 char *p;
539 unsigned int taglen = strlen(tag);
540 unsigned long size = modinfo_len;
541
b817f6fe
SR
542 if (info) {
543 size -= info - (char *)modinfo;
544 modinfo = next_string(info, &size);
545 }
546
1da177e4
LT
547 for (p = modinfo; p; p = next_string(p, &size)) {
548 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
549 return p + taglen + 1;
550 }
551 return NULL;
552}
553
b817f6fe
SR
554static char *get_modinfo(void *modinfo, unsigned long modinfo_len,
555 const char *tag)
556
557{
558 return get_next_modinfo(modinfo, modinfo_len, tag, NULL);
559}
560
4c8fbca5
SR
561/**
562 * Test if string s ends in string sub
563 * return 0 if match
564 **/
565static int strrcmp(const char *s, const char *sub)
566{
567 int slen, sublen;
62070fa4 568
4c8fbca5
SR
569 if (!s || !sub)
570 return 1;
62070fa4 571
4c8fbca5
SR
572 slen = strlen(s);
573 sublen = strlen(sub);
62070fa4 574
4c8fbca5
SR
575 if ((slen == 0) || (sublen == 0))
576 return 1;
577
578 if (sublen > slen)
579 return 1;
580
581 return memcmp(s + slen - sublen, sub, sublen);
582}
583
584/**
585 * Whitelist to allow certain references to pass with no warning.
586 * Pattern 1:
587 * If a module parameter is declared __initdata and permissions=0
588 * then this is legal despite the warning generated.
589 * We cannot see value of permissions here, so just ignore
590 * this pattern.
591 * The pattern is identified by:
592 * tosec = .init.data
9209aed0 593 * fromsec = .data*
4c8fbca5 594 * atsym =__param*
62070fa4 595 *
4c8fbca5 596 * Pattern 2:
72ee59b5 597 * Many drivers utilise a *driver container with references to
4c8fbca5
SR
598 * add, remove, probe functions etc.
599 * These functions may often be marked __init and we do not want to
600 * warn here.
601 * the pattern is identified by:
5ecdd0f6 602 * tosec = .init.text | .exit.text | .init.data
4c8fbca5 603 * fromsec = .data
aae5f662 604 * atsym = *driver, *_template, *_sht, *_ops, *_probe, *probe_one, *_console
ee6a8545
VG
605 *
606 * Pattern 3:
9bf8cb9b
SR
607 * Whitelist all references from .pci_fixup* section to .init.text
608 * This is part of the PCI init when built-in
609 *
610 * Pattern 4:
611 * Whitelist all refereces from .text.head to .init.data
612 * Whitelist all refereces from .text.head to .init.text
613 *
614 * Pattern 5:
ee6a8545
VG
615 * Some symbols belong to init section but still it is ok to reference
616 * these from non-init sections as these symbols don't have any memory
617 * allocated for them and symbol address and value are same. So even
618 * if init section is freed, its ok to reference those symbols.
619 * For ex. symbols marking the init section boundaries.
620 * This pattern is identified by
621 * refsymname = __init_begin, _sinittext, _einittext
9bf8cb9b
SR
622 *
623 * Pattern 6:
aae5f662
SR
624 * During the early init phase we have references from .init.text to
625 * .text we have an intended section mismatch - do not warn about it.
626 * See kernel_init() in init/main.c
627 * tosec = .init.text
628 * fromsec = .text
629 * atsym = kernel_init
5a4910fb
SR
630 *
631 * Pattern 7:
632 * Logos used in drivers/video/logo reside in __initdata but the
633 * funtion that references them are EXPORT_SYMBOL() so cannot be
634 * marker __init. So we whitelist them here.
635 * The pattern is:
636 * tosec = .init.data
637 * fromsec = .text*
638 * refsymname = logo_
b4d5171a
SR
639 *
640 * Pattern 8:
641 * Symbols contained in .paravirtprobe may safely reference .init.text.
642 * The pattern is:
643 * tosec = .init.text
644 * fromsec = .paravirtprobe
645 *
72280ede
YG
646 * Pattern 9:
647 * Some of functions are common code between boot time and hotplug
648 * time. The bootmem allocater is called only boot time in its
649 * functions. So it's ok to reference.
650 * tosec = .init.text
651 *
652 * Pattern 10:
cd547791
LY
653 * ia64 has machvec table for each platform and
654 * powerpc has a machine desc table for each platform.
655 * It is mixture of function pointers of .init.text and .text.
656 * fromsec = .machvec | .machine.desc
4c8fbca5 657 **/
9e157a5a 658static int secref_whitelist(const char *modname, const char *tosec,
ee6a8545
VG
659 const char *fromsec, const char *atsym,
660 const char *refsymname)
4c8fbca5
SR
661{
662 int f1 = 1, f2 = 1;
663 const char **s;
664 const char *pat2sym[] = {
72ee59b5 665 "driver",
5ecdd0f6
SR
666 "_template", /* scsi uses *_template a lot */
667 "_sht", /* scsi also used *_sht to some extent */
4c8fbca5
SR
668 "_ops",
669 "_probe",
670 "_probe_one",
118c0ace 671 "_console",
1833d6bc 672 "apic_es7000",
4c8fbca5
SR
673 NULL
674 };
62070fa4 675
ee6a8545
VG
676 const char *pat3refsym[] = {
677 "__init_begin",
678 "_sinittext",
679 "_einittext",
680 NULL
681 };
682
72280ede
YG
683 const char *pat4sym[] = {
684 "sparse_index_alloc",
685 "zone_wait_table_init",
686 NULL
687 };
688
4c8fbca5
SR
689 /* Check for pattern 1 */
690 if (strcmp(tosec, ".init.data") != 0)
691 f1 = 0;
9209aed0 692 if (strncmp(fromsec, ".data", strlen(".data")) != 0)
4c8fbca5
SR
693 f1 = 0;
694 if (strncmp(atsym, "__param", strlen("__param")) != 0)
695 f1 = 0;
696
697 if (f1)
698 return f1;
699
700 /* Check for pattern 2 */
62070fa4 701 if ((strcmp(tosec, ".init.text") != 0) &&
5ecdd0f6
SR
702 (strcmp(tosec, ".exit.text") != 0) &&
703 (strcmp(tosec, ".init.data") != 0))
4c8fbca5
SR
704 f2 = 0;
705 if (strcmp(fromsec, ".data") != 0)
706 f2 = 0;
707
708 for (s = pat2sym; *s; s++)
709 if (strrcmp(atsym, *s) == 0)
710 f1 = 1;
9e157a5a
MD
711 if (f1 && f2)
712 return 1;
4c8fbca5 713
9bf8cb9b
SR
714 /* Check for pattern 3 */
715 if ((strncmp(fromsec, ".pci_fixup", strlen(".pci_fixup")) == 0) &&
716 (strcmp(tosec, ".init.text") == 0))
717 return 1;
f8657e1b 718
aae5f662 719 /* Check for pattern 4 */
9bf8cb9b
SR
720 if ((strcmp(fromsec, ".text.head") == 0) &&
721 ((strcmp(tosec, ".init.data") == 0) ||
722 (strcmp(tosec, ".init.text") == 0)))
723 return 1;
724
725 /* Check for pattern 5 */
726 for (s = pat3refsym; *s; s++)
727 if (strcmp(refsymname, *s) == 0)
728 return 1;
729
730 /* Check for pattern 6 */
aae5f662
SR
731 if ((strcmp(tosec, ".init.text") == 0) &&
732 (strcmp(fromsec, ".text") == 0) &&
733 (strcmp(refsymname, "kernel_init") == 0))
9e157a5a 734 return 1;
ee6a8545 735
5a4910fb
SR
736 /* Check for pattern 7 */
737 if ((strcmp(tosec, ".init.data") == 0) &&
738 (strncmp(fromsec, ".text", strlen(".text")) == 0) &&
739 (strncmp(refsymname, "logo_", strlen("logo_")) == 0))
740 return 1;
b4d5171a
SR
741
742 /* Check for pattern 8 */
743 if ((strcmp(tosec, ".init.text") == 0) &&
744 (strcmp(fromsec, ".paravirtprobe") == 0))
f8657e1b
VG
745 return 1;
746
72280ede
YG
747 /* Check for pattern 9 */
748 if ((strcmp(tosec, ".init.text") == 0) &&
749 (strcmp(fromsec, ".text") == 0))
750 for (s = pat4sym; *s; s++)
751 if (strcmp(atsym, *s) == 0)
752 return 1;
753
754 /* Check for pattern 10 */
cd547791
LY
755 if ((strcmp(fromsec, ".machvec") == 0) ||
756 (strcmp(fromsec, ".machine.desc") == 0))
72280ede
YG
757 return 1;
758
93659af1 759 return 0;
4c8fbca5
SR
760}
761
93684d3b
SR
762/**
763 * Find symbol based on relocation record info.
764 * In some cases the symbol supplied is a valid symbol so
765 * return refsym. If st_name != 0 we assume this is a valid symbol.
766 * In other cases the symbol needs to be looked up in the symbol table
767 * based on section and address.
768 * **/
769static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf_Addr addr,
770 Elf_Sym *relsym)
771{
772 Elf_Sym *sym;
773
774 if (relsym->st_name != 0)
775 return relsym;
776 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
777 if (sym->st_shndx != relsym->st_shndx)
778 continue;
f892b7d4
AN
779 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
780 continue;
93684d3b
SR
781 if (sym->st_value == addr)
782 return sym;
783 }
784 return NULL;
785}
786
da68d61f
DB
787static inline int is_arm_mapping_symbol(const char *str)
788{
789 return str[0] == '$' && strchr("atd", str[1])
790 && (str[2] == '\0' || str[2] == '.');
791}
792
793/*
794 * If there's no name there, ignore it; likewise, ignore it if it's
795 * one of the magic symbols emitted used by current ARM tools.
796 *
797 * Otherwise if find_symbols_between() returns those symbols, they'll
798 * fail the whitelist tests and cause lots of false alarms ... fixable
799 * only by merging __exit and __init sections into __text, bloating
800 * the kernel (which is especially evil on embedded platforms).
801 */
802static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
803{
804 const char *name = elf->strtab + sym->st_name;
805
806 if (!name || !strlen(name))
807 return 0;
808 return !is_arm_mapping_symbol(name);
809}
810
b39927cf 811/*
43c74d17
SR
812 * Find symbols before or equal addr and after addr - in the section sec.
813 * If we find two symbols with equal offset prefer one with a valid name.
814 * The ELF format may have a better way to detect what type of symbol
815 * it is, but this works for now.
b39927cf
SR
816 **/
817static void find_symbols_between(struct elf_info *elf, Elf_Addr addr,
818 const char *sec,
819 Elf_Sym **before, Elf_Sym **after)
820{
821 Elf_Sym *sym;
822 Elf_Ehdr *hdr = elf->hdr;
823 Elf_Addr beforediff = ~0;
824 Elf_Addr afterdiff = ~0;
825 const char *secstrings = (void *)hdr +
826 elf->sechdrs[hdr->e_shstrndx].sh_offset;
62070fa4 827
b39927cf
SR
828 *before = NULL;
829 *after = NULL;
830
831 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
832 const char *symsec;
833
834 if (sym->st_shndx >= SHN_LORESERVE)
835 continue;
836 symsec = secstrings + elf->sechdrs[sym->st_shndx].sh_name;
837 if (strcmp(symsec, sec) != 0)
838 continue;
da68d61f
DB
839 if (!is_valid_name(elf, sym))
840 continue;
b39927cf
SR
841 if (sym->st_value <= addr) {
842 if ((addr - sym->st_value) < beforediff) {
843 beforediff = addr - sym->st_value;
844 *before = sym;
845 }
43c74d17 846 else if ((addr - sym->st_value) == beforediff) {
da68d61f 847 *before = sym;
43c74d17 848 }
b39927cf
SR
849 }
850 else
851 {
852 if ((sym->st_value - addr) < afterdiff) {
853 afterdiff = sym->st_value - addr;
854 *after = sym;
855 }
43c74d17 856 else if ((sym->st_value - addr) == afterdiff) {
da68d61f 857 *after = sym;
43c74d17 858 }
b39927cf
SR
859 }
860 }
861}
862
863/**
864 * Print a warning about a section mismatch.
865 * Try to find symbols near it so user can find it.
4c8fbca5 866 * Check whitelist before warning - it may be a false positive.
b39927cf
SR
867 **/
868static void warn_sec_mismatch(const char *modname, const char *fromsec,
869 struct elf_info *elf, Elf_Sym *sym, Elf_Rela r)
870{
93684d3b
SR
871 const char *refsymname = "";
872 Elf_Sym *before, *after;
873 Elf_Sym *refsym;
b39927cf
SR
874 Elf_Ehdr *hdr = elf->hdr;
875 Elf_Shdr *sechdrs = elf->sechdrs;
876 const char *secstrings = (void *)hdr +
877 sechdrs[hdr->e_shstrndx].sh_offset;
878 const char *secname = secstrings + sechdrs[sym->st_shndx].sh_name;
62070fa4 879
b39927cf
SR
880 find_symbols_between(elf, r.r_offset, fromsec, &before, &after);
881
93684d3b
SR
882 refsym = find_elf_symbol(elf, r.r_addend, sym);
883 if (refsym && strlen(elf->strtab + refsym->st_name))
884 refsymname = elf->strtab + refsym->st_name;
4c8fbca5
SR
885
886 /* check whitelist - we may ignore it */
62070fa4 887 if (before &&
9e157a5a 888 secref_whitelist(modname, secname, fromsec,
ee6a8545 889 elf->strtab + before->st_name, refsymname))
4c8fbca5 890 return;
62070fa4 891
cd547791
LY
892 /* fromsec whitelist - without a valid 'before'
893 * powerpc has a GOT table in .got2 section */
894 if (strcmp(fromsec, ".got2") == 0)
895 return;
896
b39927cf 897 if (before && after) {
25601209
RK
898 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
899 "(between '%s' and '%s')\n",
900 modname, fromsec, (unsigned long long)r.r_offset,
901 secname, refsymname,
b39927cf 902 elf->strtab + before->st_name,
b39927cf
SR
903 elf->strtab + after->st_name);
904 } else if (before) {
25601209
RK
905 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
906 "(after '%s')\n",
907 modname, fromsec, (unsigned long long)r.r_offset,
908 secname, refsymname,
909 elf->strtab + before->st_name);
b39927cf 910 } else if (after) {
25601209 911 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
93684d3b 912 "before '%s' (at offset -0x%llx)\n",
25601209
RK
913 modname, fromsec, (unsigned long long)r.r_offset,
914 secname, refsymname,
915 elf->strtab + after->st_name);
b39927cf 916 } else {
25601209
RK
917 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s\n",
918 modname, fromsec, (unsigned long long)r.r_offset,
919 secname, refsymname);
b39927cf
SR
920 }
921}
922
f892b7d4
AN
923static void addend_386_rel(struct elf_info *elf, int section, Elf_Rela *r)
924{
925 Elf_Shdr *sechdrs = elf->sechdrs;
926 unsigned int r_typ;
927 unsigned int *location;
928
929 r_typ = ELF_R_TYPE(r->r_info);
930 location = (void *)elf->hdr +
931 sechdrs[sechdrs[section].sh_info].sh_offset + r->r_offset;
932 switch (r_typ) {
933 case R_386_32:
934 r->r_addend = TO_NATIVE(*location);
935 break;
936 case R_386_PC32:
937 r->r_addend = TO_NATIVE(*location) + 4;
938 break;
939 }
940}
941
942static void addend_arm_rel(struct elf_info *elf, int section, Elf_Rela *r)
943{
944 Elf_Shdr *sechdrs = elf->sechdrs;
945 unsigned int r_typ;
946 unsigned int *location;
947
948 r_typ = ELF_R_TYPE(r->r_info);
949 location = (void *)elf->hdr +
950 sechdrs[sechdrs[section].sh_info].sh_offset + r->r_offset;
951 switch (r_typ) {
952 case R_ARM_ABS32:
953 r->r_addend = TO_NATIVE(*location);
954 break;
955 case R_ARM_PC24:
956 r->r_addend = ((TO_NATIVE(*location) & 0x00ffffff) << 2) + 8;
957 break;
958 }
959}
960
961static int addend_mips_rel(struct elf_info *elf, int section, Elf_Rela *r)
962{
963 Elf_Shdr *sechdrs = elf->sechdrs;
964 unsigned int r_typ;
965 unsigned int *location;
966 unsigned int inst;
967
968 r_typ = ELF_R_TYPE(r->r_info);
969 if (r_typ == R_MIPS_HI16)
970 return 1; /* skip this */
971 location = (void *)elf->hdr +
972 sechdrs[sechdrs[section].sh_info].sh_offset + r->r_offset;
973 inst = TO_NATIVE(*location);
974 switch (r_typ) {
975 case R_MIPS_LO16:
976 r->r_addend = ((inst & 0xffff) ^ 0x8000) - 0x8000;
977 break;
978 case R_MIPS_26:
979 r->r_addend = (inst & 0x03ffffff) << 2;
980 break;
981 }
982 return 0;
983}
984
b39927cf
SR
985/**
986 * A module includes a number of sections that are discarded
987 * either when loaded or when used as built-in.
988 * For loaded modules all functions marked __init and all data
989 * marked __initdata will be discarded when the module has been intialized.
990 * Likewise for modules used built-in the sections marked __exit
991 * are discarded because __exit marked function are supposed to be called
992 * only when a moduel is unloaded which never happes for built-in modules.
993 * The check_sec_ref() function traverses all relocation records
994 * to find all references to a section that reference a section that will
995 * be discarded and warns about it.
996 **/
997static void check_sec_ref(struct module *mod, const char *modname,
998 struct elf_info *elf,
999 int section(const char*),
1000 int section_ref_ok(const char *))
1001{
1002 int i;
1003 Elf_Sym *sym;
1004 Elf_Ehdr *hdr = elf->hdr;
1005 Elf_Shdr *sechdrs = elf->sechdrs;
1006 const char *secstrings = (void *)hdr +
1007 sechdrs[hdr->e_shstrndx].sh_offset;
62070fa4 1008
b39927cf
SR
1009 /* Walk through all sections */
1010 for (i = 0; i < hdr->e_shnum; i++) {
2c1a51f3
AN
1011 const char *name = secstrings + sechdrs[i].sh_name;
1012 const char *secname;
1013 Elf_Rela r;
eae07ac6 1014 unsigned int r_sym;
b39927cf 1015 /* We want to process only relocation sections and not .init */
2c1a51f3
AN
1016 if (sechdrs[i].sh_type == SHT_RELA) {
1017 Elf_Rela *rela;
1018 Elf_Rela *start = (void *)hdr + sechdrs[i].sh_offset;
1019 Elf_Rela *stop = (void*)start + sechdrs[i].sh_size;
1020 name += strlen(".rela");
1021 if (section_ref_ok(name))
1022 continue;
b39927cf 1023
2c1a51f3
AN
1024 for (rela = start; rela < stop; rela++) {
1025 r.r_offset = TO_NATIVE(rela->r_offset);
eae07ac6
AN
1026#if KERNEL_ELFCLASS == ELFCLASS64
1027 if (hdr->e_machine == EM_MIPS) {
f892b7d4 1028 unsigned int r_typ;
eae07ac6
AN
1029 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1030 r_sym = TO_NATIVE(r_sym);
f892b7d4
AN
1031 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1032 r.r_info = ELF64_R_INFO(r_sym, r_typ);
eae07ac6
AN
1033 } else {
1034 r.r_info = TO_NATIVE(rela->r_info);
1035 r_sym = ELF_R_SYM(r.r_info);
1036 }
1037#else
1038 r.r_info = TO_NATIVE(rela->r_info);
1039 r_sym = ELF_R_SYM(r.r_info);
1040#endif
2c1a51f3 1041 r.r_addend = TO_NATIVE(rela->r_addend);
eae07ac6 1042 sym = elf->symtab_start + r_sym;
2c1a51f3
AN
1043 /* Skip special sections */
1044 if (sym->st_shndx >= SHN_LORESERVE)
1045 continue;
1046
1047 secname = secstrings +
1048 sechdrs[sym->st_shndx].sh_name;
1049 if (section(secname))
1050 warn_sec_mismatch(modname, name,
1051 elf, sym, r);
1052 }
1053 } else if (sechdrs[i].sh_type == SHT_REL) {
1054 Elf_Rel *rel;
1055 Elf_Rel *start = (void *)hdr + sechdrs[i].sh_offset;
1056 Elf_Rel *stop = (void*)start + sechdrs[i].sh_size;
1057 name += strlen(".rel");
1058 if (section_ref_ok(name))
b39927cf
SR
1059 continue;
1060
2c1a51f3
AN
1061 for (rel = start; rel < stop; rel++) {
1062 r.r_offset = TO_NATIVE(rel->r_offset);
eae07ac6
AN
1063#if KERNEL_ELFCLASS == ELFCLASS64
1064 if (hdr->e_machine == EM_MIPS) {
f892b7d4 1065 unsigned int r_typ;
eae07ac6
AN
1066 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1067 r_sym = TO_NATIVE(r_sym);
f892b7d4
AN
1068 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1069 r.r_info = ELF64_R_INFO(r_sym, r_typ);
eae07ac6
AN
1070 } else {
1071 r.r_info = TO_NATIVE(rel->r_info);
1072 r_sym = ELF_R_SYM(r.r_info);
1073 }
1074#else
1075 r.r_info = TO_NATIVE(rel->r_info);
1076 r_sym = ELF_R_SYM(r.r_info);
1077#endif
2c1a51f3 1078 r.r_addend = 0;
f892b7d4
AN
1079 if (hdr->e_machine == EM_386)
1080 addend_386_rel(elf, i, &r);
1081 else if (hdr->e_machine == EM_ARM)
1082 addend_arm_rel(elf, i, &r);
1083 else if (hdr->e_machine == EM_MIPS) {
1084 if (addend_mips_rel(elf, i, &r))
1085 continue;
1086 }
eae07ac6 1087 sym = elf->symtab_start + r_sym;
2c1a51f3
AN
1088 /* Skip special sections */
1089 if (sym->st_shndx >= SHN_LORESERVE)
1090 continue;
1091
1092 secname = secstrings +
1093 sechdrs[sym->st_shndx].sh_name;
1094 if (section(secname))
1095 warn_sec_mismatch(modname, name,
1096 elf, sym, r);
1097 }
b39927cf
SR
1098 }
1099 }
1100}
1101
1102/**
1103 * Functions used only during module init is marked __init and is stored in
1104 * a .init.text section. Likewise data is marked __initdata and stored in
1105 * a .init.data section.
1106 * If this section is one of these sections return 1
1107 * See include/linux/init.h for the details
1108 **/
1109static int init_section(const char *name)
1110{
1111 if (strcmp(name, ".init") == 0)
1112 return 1;
1113 if (strncmp(name, ".init.", strlen(".init.")) == 0)
1114 return 1;
1115 return 0;
1116}
1117
1118/**
1119 * Identify sections from which references to a .init section is OK.
62070fa4 1120 *
b39927cf
SR
1121 * Unfortunately references to read only data that referenced .init
1122 * sections had to be excluded. Almost all of these are false
1123 * positives, they are created by gcc. The downside of excluding rodata
1124 * is that there really are some user references from rodata to
1125 * init code, e.g. drivers/video/vgacon.c:
62070fa4 1126 *
b39927cf
SR
1127 * const struct consw vga_con = {
1128 * con_startup: vgacon_startup,
1129 *
1130 * where vgacon_startup is __init. If you want to wade through the false
1131 * positives, take out the check for rodata.
1132 **/
1133static int init_section_ref_ok(const char *name)
1134{
1135 const char **s;
1136 /* Absolute section names */
1137 const char *namelist1[] = {
1138 ".init",
9209aed0
SR
1139 ".opd", /* see comment [OPD] at exit_section_ref_ok() */
1140 ".toc1", /* used by ppc64 */
b39927cf 1141 ".stab",
742433b0 1142 ".data.rel.ro", /* used by parisc64 */
139ec7c4 1143 ".parainstructions",
b39927cf 1144 ".text.lock",
9209aed0 1145 "__bug_table", /* used by powerpc for BUG() */
b39927cf
SR
1146 ".pci_fixup_header",
1147 ".pci_fixup_final",
1148 ".pdr",
1149 "__param",
468d9494
AV
1150 "__ex_table",
1151 ".fixup",
35899c57 1152 ".smp_locks",
909252d2 1153 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
21c4ff80
BH
1154 "__ftr_fixup", /* powerpc cpu feature fixup */
1155 "__fw_ftr_fixup", /* powerpc firmware feature fixup */
b39927cf
SR
1156 NULL
1157 };
1158 /* Start of section names */
1159 const char *namelist2[] = {
1160 ".init.",
1161 ".altinstructions",
1162 ".eh_frame",
1163 ".debug",
139ec7c4 1164 ".parainstructions",
742433b0 1165 ".rodata",
b39927cf
SR
1166 NULL
1167 };
6e10133f
SR
1168 /* part of section name */
1169 const char *namelist3 [] = {
1170 ".unwind", /* sample: IA_64.unwind.init.text */
1171 NULL
1172 };
1173
b39927cf
SR
1174 for (s = namelist1; *s; s++)
1175 if (strcmp(*s, name) == 0)
1176 return 1;
62070fa4 1177 for (s = namelist2; *s; s++)
b39927cf
SR
1178 if (strncmp(*s, name, strlen(*s)) == 0)
1179 return 1;
62070fa4 1180 for (s = namelist3; *s; s++)
e835a39c 1181 if (strstr(name, *s) != NULL)
6e10133f 1182 return 1;
468d9494
AV
1183 if (strrcmp(name, ".init") == 0)
1184 return 1;
b39927cf
SR
1185 return 0;
1186}
1187
1188/*
1189 * Functions used only during module exit is marked __exit and is stored in
1190 * a .exit.text section. Likewise data is marked __exitdata and stored in
1191 * a .exit.data section.
1192 * If this section is one of these sections return 1
1193 * See include/linux/init.h for the details
1194 **/
1195static int exit_section(const char *name)
1196{
1197 if (strcmp(name, ".exit.text") == 0)
1198 return 1;
1199 if (strcmp(name, ".exit.data") == 0)
1200 return 1;
1201 return 0;
62070fa4 1202
b39927cf
SR
1203}
1204
1205/*
1206 * Identify sections from which references to a .exit section is OK.
62070fa4 1207 *
b39927cf
SR
1208 * [OPD] Keith Ownes <kaos@sgi.com> commented:
1209 * For our future {in}sanity, add a comment that this is the ppc .opd
1210 * section, not the ia64 .opd section.
1211 * ia64 .opd should not point to discarded sections.
5ecdd0f6 1212 * [.rodata] like for .init.text we ignore .rodata references -same reason
b39927cf
SR
1213 **/
1214static int exit_section_ref_ok(const char *name)
1215{
1216 const char **s;
1217 /* Absolute section names */
1218 const char *namelist1[] = {
1219 ".exit.text",
1220 ".exit.data",
1221 ".init.text",
5ecdd0f6 1222 ".rodata",
b39927cf 1223 ".opd", /* See comment [OPD] */
9209aed0 1224 ".toc1", /* used by ppc64 */
b39927cf
SR
1225 ".altinstructions",
1226 ".pdr",
9209aed0 1227 "__bug_table", /* used by powerpc for BUG() */
b39927cf
SR
1228 ".exitcall.exit",
1229 ".eh_frame",
acd19499 1230 ".parainstructions",
b39927cf 1231 ".stab",
468d9494
AV
1232 "__ex_table",
1233 ".fixup",
35899c57 1234 ".smp_locks",
909252d2 1235 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
b39927cf
SR
1236 NULL
1237 };
1238 /* Start of section names */
1239 const char *namelist2[] = {
1240 ".debug",
1241 NULL
1242 };
6e10133f
SR
1243 /* part of section name */
1244 const char *namelist3 [] = {
1245 ".unwind", /* Sample: IA_64.unwind.exit.text */
1246 NULL
1247 };
62070fa4 1248
b39927cf
SR
1249 for (s = namelist1; *s; s++)
1250 if (strcmp(*s, name) == 0)
1251 return 1;
62070fa4 1252 for (s = namelist2; *s; s++)
b39927cf
SR
1253 if (strncmp(*s, name, strlen(*s)) == 0)
1254 return 1;
62070fa4 1255 for (s = namelist3; *s; s++)
e835a39c 1256 if (strstr(name, *s) != NULL)
6e10133f 1257 return 1;
b39927cf
SR
1258 return 0;
1259}
1260
5c3ead8c 1261static void read_symbols(char *modname)
1da177e4
LT
1262{
1263 const char *symname;
1264 char *version;
b817f6fe 1265 char *license;
1da177e4
LT
1266 struct module *mod;
1267 struct elf_info info = { };
1268 Elf_Sym *sym;
1269
85bd2fdd
SR
1270 if (!parse_elf(&info, modname))
1271 return;
1da177e4
LT
1272
1273 mod = new_module(modname);
1274
1275 /* When there's no vmlinux, don't print warnings about
1276 * unresolved symbols (since there'll be too many ;) */
1277 if (is_vmlinux(modname)) {
1da177e4 1278 have_vmlinux = 1;
1da177e4
LT
1279 mod->skip = 1;
1280 }
1281
b817f6fe
SR
1282 license = get_modinfo(info.modinfo, info.modinfo_len, "license");
1283 while (license) {
1284 if (license_is_gpl_compatible(license))
1285 mod->gpl_compatible = 1;
1286 else {
1287 mod->gpl_compatible = 0;
1288 break;
1289 }
1290 license = get_next_modinfo(info.modinfo, info.modinfo_len,
1291 "license", license);
1292 }
1293
1da177e4
LT
1294 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
1295 symname = info.strtab + sym->st_name;
1296
1297 handle_modversions(mod, &info, sym, symname);
1298 handle_moddevtable(mod, &info, sym, symname);
1299 }
b39927cf
SR
1300 check_sec_ref(mod, modname, &info, init_section, init_section_ref_ok);
1301 check_sec_ref(mod, modname, &info, exit_section, exit_section_ref_ok);
1da177e4
LT
1302
1303 version = get_modinfo(info.modinfo, info.modinfo_len, "version");
1304 if (version)
1305 maybe_frob_rcs_version(modname, version, info.modinfo,
1306 version - (char *)info.hdr);
1307 if (version || (all_versions && !is_vmlinux(modname)))
1308 get_src_version(modname, mod->srcversion,
1309 sizeof(mod->srcversion)-1);
1310
1311 parse_elf_finish(&info);
1312
1313 /* Our trick to get versioning for struct_module - it's
1314 * never passed as an argument to an exported function, so
1315 * the automatic versioning doesn't pick it up, but it's really
1316 * important anyhow */
1317 if (modversions)
1318 mod->unres = alloc_symbol("struct_module", 0, mod->unres);
1319}
1320
1321#define SZ 500
1322
1323/* We first write the generated file into memory using the
1324 * following helper, then compare to the file on disk and
1325 * only update the later if anything changed */
1326
5c3ead8c
SR
1327void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
1328 const char *fmt, ...)
1da177e4
LT
1329{
1330 char tmp[SZ];
1331 int len;
1332 va_list ap;
62070fa4 1333
1da177e4
LT
1334 va_start(ap, fmt);
1335 len = vsnprintf(tmp, SZ, fmt, ap);
7670f023 1336 buf_write(buf, tmp, len);
1da177e4
LT
1337 va_end(ap);
1338}
1339
5c3ead8c 1340void buf_write(struct buffer *buf, const char *s, int len)
1da177e4
LT
1341{
1342 if (buf->size - buf->pos < len) {
7670f023 1343 buf->size += len + SZ;
1da177e4
LT
1344 buf->p = realloc(buf->p, buf->size);
1345 }
1346 strncpy(buf->p + buf->pos, s, len);
1347 buf->pos += len;
1348}
1349
c96fca21
SR
1350static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
1351{
1352 const char *e = is_vmlinux(m) ?"":".ko";
1353
1354 switch (exp) {
1355 case export_gpl:
1356 fatal("modpost: GPL-incompatible module %s%s "
1357 "uses GPL-only symbol '%s'\n", m, e, s);
1358 break;
1359 case export_unused_gpl:
1360 fatal("modpost: GPL-incompatible module %s%s "
1361 "uses GPL-only symbol marked UNUSED '%s'\n", m, e, s);
1362 break;
1363 case export_gpl_future:
1364 warn("modpost: GPL-incompatible module %s%s "
1365 "uses future GPL-only symbol '%s'\n", m, e, s);
1366 break;
1367 case export_plain:
1368 case export_unused:
1369 case export_unknown:
1370 /* ignore */
1371 break;
1372 }
1373}
1374
1375static void check_for_unused(enum export exp, const char* m, const char* s)
1376{
1377 const char *e = is_vmlinux(m) ?"":".ko";
1378
1379 switch (exp) {
1380 case export_unused:
1381 case export_unused_gpl:
1382 warn("modpost: module %s%s "
1383 "uses symbol '%s' marked UNUSED\n", m, e, s);
1384 break;
1385 default:
1386 /* ignore */
1387 break;
1388 }
1389}
1390
1391static void check_exports(struct module *mod)
b817f6fe
SR
1392{
1393 struct symbol *s, *exp;
1394
1395 for (s = mod->unres; s; s = s->next) {
6449bd62 1396 const char *basename;
b817f6fe
SR
1397 exp = find_symbol(s->name);
1398 if (!exp || exp->module == mod)
1399 continue;
6449bd62 1400 basename = strrchr(mod->name, '/');
b817f6fe
SR
1401 if (basename)
1402 basename++;
c96fca21
SR
1403 else
1404 basename = mod->name;
1405 if (!mod->gpl_compatible)
1406 check_for_gpl_usage(exp->export, basename, exp->name);
1407 check_for_unused(exp->export, basename, exp->name);
b817f6fe
SR
1408 }
1409}
1410
5c3ead8c
SR
1411/**
1412 * Header for the generated file
1413 **/
1414static void add_header(struct buffer *b, struct module *mod)
1da177e4
LT
1415{
1416 buf_printf(b, "#include <linux/module.h>\n");
1417 buf_printf(b, "#include <linux/vermagic.h>\n");
1418 buf_printf(b, "#include <linux/compiler.h>\n");
1419 buf_printf(b, "\n");
1420 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
1421 buf_printf(b, "\n");
1da177e4
LT
1422 buf_printf(b, "struct module __this_module\n");
1423 buf_printf(b, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
f83b5e32 1424 buf_printf(b, " .name = KBUILD_MODNAME,\n");
1da177e4
LT
1425 if (mod->has_init)
1426 buf_printf(b, " .init = init_module,\n");
1427 if (mod->has_cleanup)
1428 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
1429 " .exit = cleanup_module,\n"
1430 "#endif\n");
e61a1c1c 1431 buf_printf(b, " .arch = MODULE_ARCH_INIT,\n");
1da177e4
LT
1432 buf_printf(b, "};\n");
1433}
1434
5c3ead8c
SR
1435/**
1436 * Record CRCs for unresolved symbols
1437 **/
c53ddacd 1438static int add_versions(struct buffer *b, struct module *mod)
1da177e4
LT
1439{
1440 struct symbol *s, *exp;
c53ddacd 1441 int err = 0;
1da177e4
LT
1442
1443 for (s = mod->unres; s; s = s->next) {
1444 exp = find_symbol(s->name);
1445 if (!exp || exp->module == mod) {
c53ddacd 1446 if (have_vmlinux && !s->weak) {
2a116659
MW
1447 if (warn_unresolved) {
1448 warn("\"%s\" [%s.ko] undefined!\n",
1449 s->name, mod->name);
1450 } else {
1451 merror("\"%s\" [%s.ko] undefined!\n",
1452 s->name, mod->name);
1453 err = 1;
1454 }
c53ddacd 1455 }
1da177e4
LT
1456 continue;
1457 }
1458 s->module = exp->module;
1459 s->crc_valid = exp->crc_valid;
1460 s->crc = exp->crc;
1461 }
1462
1463 if (!modversions)
c53ddacd 1464 return err;
1da177e4
LT
1465
1466 buf_printf(b, "\n");
1467 buf_printf(b, "static const struct modversion_info ____versions[]\n");
1468 buf_printf(b, "__attribute_used__\n");
1469 buf_printf(b, "__attribute__((section(\"__versions\"))) = {\n");
1470
1471 for (s = mod->unres; s; s = s->next) {
1472 if (!s->module) {
1473 continue;
1474 }
1475 if (!s->crc_valid) {
cb80514d 1476 warn("\"%s\" [%s.ko] has no CRC!\n",
1da177e4
LT
1477 s->name, mod->name);
1478 continue;
1479 }
1480 buf_printf(b, "\t{ %#8x, \"%s\" },\n", s->crc, s->name);
1481 }
1482
1483 buf_printf(b, "};\n");
c53ddacd
KK
1484
1485 return err;
1da177e4
LT
1486}
1487
5c3ead8c
SR
1488static void add_depends(struct buffer *b, struct module *mod,
1489 struct module *modules)
1da177e4
LT
1490{
1491 struct symbol *s;
1492 struct module *m;
1493 int first = 1;
1494
1495 for (m = modules; m; m = m->next) {
1496 m->seen = is_vmlinux(m->name);
1497 }
1498
1499 buf_printf(b, "\n");
1500 buf_printf(b, "static const char __module_depends[]\n");
1501 buf_printf(b, "__attribute_used__\n");
1502 buf_printf(b, "__attribute__((section(\".modinfo\"))) =\n");
1503 buf_printf(b, "\"depends=");
1504 for (s = mod->unres; s; s = s->next) {
a61b2dfd 1505 const char *p;
1da177e4
LT
1506 if (!s->module)
1507 continue;
1508
1509 if (s->module->seen)
1510 continue;
1511
1512 s->module->seen = 1;
a61b2dfd
SR
1513 if ((p = strrchr(s->module->name, '/')) != NULL)
1514 p++;
1515 else
1516 p = s->module->name;
1517 buf_printf(b, "%s%s", first ? "" : ",", p);
1da177e4
LT
1518 first = 0;
1519 }
1520 buf_printf(b, "\";\n");
1521}
1522
5c3ead8c 1523static void add_srcversion(struct buffer *b, struct module *mod)
1da177e4
LT
1524{
1525 if (mod->srcversion[0]) {
1526 buf_printf(b, "\n");
1527 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
1528 mod->srcversion);
1529 }
1530}
1531
5c3ead8c 1532static void write_if_changed(struct buffer *b, const char *fname)
1da177e4
LT
1533{
1534 char *tmp;
1535 FILE *file;
1536 struct stat st;
1537
1538 file = fopen(fname, "r");
1539 if (!file)
1540 goto write;
1541
1542 if (fstat(fileno(file), &st) < 0)
1543 goto close_write;
1544
1545 if (st.st_size != b->pos)
1546 goto close_write;
1547
1548 tmp = NOFAIL(malloc(b->pos));
1549 if (fread(tmp, 1, b->pos, file) != b->pos)
1550 goto free_write;
1551
1552 if (memcmp(tmp, b->p, b->pos) != 0)
1553 goto free_write;
1554
1555 free(tmp);
1556 fclose(file);
1557 return;
1558
1559 free_write:
1560 free(tmp);
1561 close_write:
1562 fclose(file);
1563 write:
1564 file = fopen(fname, "w");
1565 if (!file) {
1566 perror(fname);
1567 exit(1);
1568 }
1569 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
1570 perror(fname);
1571 exit(1);
1572 }
1573 fclose(file);
1574}
1575
bd5cbced 1576/* parse Module.symvers file. line format:
534b89a9 1577 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
bd5cbced 1578 **/
040fcc81 1579static void read_dump(const char *fname, unsigned int kernel)
1da177e4
LT
1580{
1581 unsigned long size, pos = 0;
1582 void *file = grab_file(fname, &size);
1583 char *line;
1584
1585 if (!file)
1586 /* No symbol versions, silently ignore */
1587 return;
1588
1589 while ((line = get_next_line(&pos, file, size))) {
534b89a9 1590 char *symname, *modname, *d, *export, *end;
1da177e4
LT
1591 unsigned int crc;
1592 struct module *mod;
040fcc81 1593 struct symbol *s;
1da177e4
LT
1594
1595 if (!(symname = strchr(line, '\t')))
1596 goto fail;
1597 *symname++ = '\0';
1598 if (!(modname = strchr(symname, '\t')))
1599 goto fail;
1600 *modname++ = '\0';
9ac545b0 1601 if ((export = strchr(modname, '\t')) != NULL)
bd5cbced 1602 *export++ = '\0';
534b89a9
SR
1603 if (export && ((end = strchr(export, '\t')) != NULL))
1604 *end = '\0';
1da177e4
LT
1605 crc = strtoul(line, &d, 16);
1606 if (*symname == '\0' || *modname == '\0' || *d != '\0')
1607 goto fail;
1608
1609 if (!(mod = find_module(modname))) {
1610 if (is_vmlinux(modname)) {
1611 have_vmlinux = 1;
1612 }
1613 mod = new_module(NOFAIL(strdup(modname)));
1614 mod->skip = 1;
1615 }
bd5cbced 1616 s = sym_add_exported(symname, mod, export_no(export));
8e70c458
SR
1617 s->kernel = kernel;
1618 s->preloaded = 1;
bd5cbced 1619 sym_update_crc(symname, mod, crc, export_no(export));
1da177e4
LT
1620 }
1621 return;
1622fail:
1623 fatal("parse error in symbol dump file\n");
1624}
1625
040fcc81
SR
1626/* For normal builds always dump all symbols.
1627 * For external modules only dump symbols
1628 * that are not read from kernel Module.symvers.
1629 **/
1630static int dump_sym(struct symbol *sym)
1631{
1632 if (!external_module)
1633 return 1;
1634 if (sym->vmlinux || sym->kernel)
1635 return 0;
1636 return 1;
1637}
62070fa4 1638
5c3ead8c 1639static void write_dump(const char *fname)
1da177e4
LT
1640{
1641 struct buffer buf = { };
1642 struct symbol *symbol;
1643 int n;
1644
1645 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
1646 symbol = symbolhash[n];
1647 while (symbol) {
040fcc81 1648 if (dump_sym(symbol))
bd5cbced 1649 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\n",
62070fa4 1650 symbol->crc, symbol->name,
bd5cbced
RP
1651 symbol->module->name,
1652 export_str(symbol->export));
1da177e4
LT
1653 symbol = symbol->next;
1654 }
1655 }
1656 write_if_changed(&buf, fname);
1657}
1658
5c3ead8c 1659int main(int argc, char **argv)
1da177e4
LT
1660{
1661 struct module *mod;
1662 struct buffer buf = { };
1663 char fname[SZ];
040fcc81
SR
1664 char *kernel_read = NULL, *module_read = NULL;
1665 char *dump_write = NULL;
1da177e4 1666 int opt;
c53ddacd 1667 int err;
1da177e4 1668
c53ddacd 1669 while ((opt = getopt(argc, argv, "i:I:mo:aw")) != -1) {
1da177e4
LT
1670 switch(opt) {
1671 case 'i':
040fcc81
SR
1672 kernel_read = optarg;
1673 break;
1674 case 'I':
1675 module_read = optarg;
1676 external_module = 1;
1da177e4
LT
1677 break;
1678 case 'm':
1679 modversions = 1;
1680 break;
1681 case 'o':
1682 dump_write = optarg;
1683 break;
1684 case 'a':
1685 all_versions = 1;
1686 break;
c53ddacd
KK
1687 case 'w':
1688 warn_unresolved = 1;
1689 break;
1da177e4
LT
1690 default:
1691 exit(1);
1692 }
1693 }
1694
040fcc81
SR
1695 if (kernel_read)
1696 read_dump(kernel_read, 1);
1697 if (module_read)
1698 read_dump(module_read, 0);
1da177e4
LT
1699
1700 while (optind < argc) {
1701 read_symbols(argv[optind++]);
1702 }
1703
b817f6fe
SR
1704 for (mod = modules; mod; mod = mod->next) {
1705 if (mod->skip)
1706 continue;
c96fca21 1707 check_exports(mod);
b817f6fe
SR
1708 }
1709
c53ddacd
KK
1710 err = 0;
1711
1da177e4
LT
1712 for (mod = modules; mod; mod = mod->next) {
1713 if (mod->skip)
1714 continue;
1715
1716 buf.pos = 0;
1717
1718 add_header(&buf, mod);
c53ddacd 1719 err |= add_versions(&buf, mod);
1da177e4
LT
1720 add_depends(&buf, mod, modules);
1721 add_moddevtable(&buf, mod);
1722 add_srcversion(&buf, mod);
1723
1724 sprintf(fname, "%s.mod.c", mod->name);
1725 write_if_changed(&buf, fname);
1726 }
1727
1728 if (dump_write)
1729 write_dump(dump_write);
1730
c53ddacd 1731 return err;
1da177e4 1732}