kbuild: refactor code in modpost to improve maintainability
[deliverable/linux.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);
ae4ac123 377 hdr->e_type = TO_NATIVE(hdr->e_type);
1da177e4
LT
378 sechdrs = (void *)hdr + hdr->e_shoff;
379 info->sechdrs = sechdrs;
380
381 /* Fix endianness in section headers */
382 for (i = 0; i < hdr->e_shnum; i++) {
383 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
384 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
385 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
386 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
387 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
ae4ac123
AN
388 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
389 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
1da177e4
LT
390 }
391 /* Find symbol table. */
392 for (i = 1; i < hdr->e_shnum; i++) {
393 const char *secstrings
394 = (void *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
bd5cbced 395 const char *secname;
1da177e4 396
85bd2fdd
SR
397 if (sechdrs[i].sh_offset > info->size) {
398 fatal("%s is truncated. sechdrs[i].sh_offset=%u > sizeof(*hrd)=%ul\n", filename, (unsigned int)sechdrs[i].sh_offset, sizeof(*hdr));
399 return 0;
400 }
bd5cbced
RP
401 secname = secstrings + sechdrs[i].sh_name;
402 if (strcmp(secname, ".modinfo") == 0) {
1da177e4
LT
403 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
404 info->modinfo_len = sechdrs[i].sh_size;
bd5cbced
RP
405 } else if (strcmp(secname, "__ksymtab") == 0)
406 info->export_sec = i;
c96fca21
SR
407 else if (strcmp(secname, "__ksymtab_unused") == 0)
408 info->export_unused_sec = i;
bd5cbced
RP
409 else if (strcmp(secname, "__ksymtab_gpl") == 0)
410 info->export_gpl_sec = i;
c96fca21
SR
411 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
412 info->export_unused_gpl_sec = i;
bd5cbced
RP
413 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
414 info->export_gpl_future_sec = i;
415
1da177e4
LT
416 if (sechdrs[i].sh_type != SHT_SYMTAB)
417 continue;
418
419 info->symtab_start = (void *)hdr + sechdrs[i].sh_offset;
62070fa4 420 info->symtab_stop = (void *)hdr + sechdrs[i].sh_offset
1da177e4 421 + sechdrs[i].sh_size;
62070fa4 422 info->strtab = (void *)hdr +
1da177e4
LT
423 sechdrs[sechdrs[i].sh_link].sh_offset;
424 }
425 if (!info->symtab_start) {
cb80514d 426 fatal("%s has no symtab?\n", filename);
1da177e4
LT
427 }
428 /* Fix endianness in symbols */
429 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
430 sym->st_shndx = TO_NATIVE(sym->st_shndx);
431 sym->st_name = TO_NATIVE(sym->st_name);
432 sym->st_value = TO_NATIVE(sym->st_value);
433 sym->st_size = TO_NATIVE(sym->st_size);
434 }
85bd2fdd 435 return 1;
1da177e4
LT
436}
437
5c3ead8c 438static void parse_elf_finish(struct elf_info *info)
1da177e4
LT
439{
440 release_file(info->hdr, info->size);
441}
442
f7b05e64
LY
443#define CRC_PFX MODULE_SYMBOL_PREFIX "__crc_"
444#define KSYMTAB_PFX MODULE_SYMBOL_PREFIX "__ksymtab_"
1da177e4 445
5c3ead8c
SR
446static void handle_modversions(struct module *mod, struct elf_info *info,
447 Elf_Sym *sym, const char *symname)
1da177e4
LT
448{
449 unsigned int crc;
bd5cbced 450 enum export export = export_from_sec(info, sym->st_shndx);
1da177e4
LT
451
452 switch (sym->st_shndx) {
453 case SHN_COMMON:
cb80514d 454 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
1da177e4
LT
455 break;
456 case SHN_ABS:
457 /* CRC'd symbol */
458 if (memcmp(symname, CRC_PFX, strlen(CRC_PFX)) == 0) {
459 crc = (unsigned int) sym->st_value;
bd5cbced
RP
460 sym_update_crc(symname + strlen(CRC_PFX), mod, crc,
461 export);
1da177e4
LT
462 }
463 break;
464 case SHN_UNDEF:
465 /* undefined symbol */
466 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
467 ELF_ST_BIND(sym->st_info) != STB_WEAK)
468 break;
469 /* ignore global offset table */
470 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
471 break;
472 /* ignore __this_module, it will be resolved shortly */
473 if (strcmp(symname, MODULE_SYMBOL_PREFIX "__this_module") == 0)
474 break;
8d529014
BC
475/* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
476#if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
477/* add compatibility with older glibc */
478#ifndef STT_SPARC_REGISTER
479#define STT_SPARC_REGISTER STT_REGISTER
480#endif
1da177e4
LT
481 if (info->hdr->e_machine == EM_SPARC ||
482 info->hdr->e_machine == EM_SPARCV9) {
483 /* Ignore register directives. */
8d529014 484 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
1da177e4 485 break;
62070fa4
SR
486 if (symname[0] == '.') {
487 char *munged = strdup(symname);
488 munged[0] = '_';
489 munged[1] = toupper(munged[1]);
490 symname = munged;
491 }
1da177e4
LT
492 }
493#endif
62070fa4 494
1da177e4
LT
495 if (memcmp(symname, MODULE_SYMBOL_PREFIX,
496 strlen(MODULE_SYMBOL_PREFIX)) == 0)
497 mod->unres = alloc_symbol(symname +
498 strlen(MODULE_SYMBOL_PREFIX),
499 ELF_ST_BIND(sym->st_info) == STB_WEAK,
500 mod->unres);
501 break;
502 default:
503 /* All exported symbols */
504 if (memcmp(symname, KSYMTAB_PFX, strlen(KSYMTAB_PFX)) == 0) {
bd5cbced
RP
505 sym_add_exported(symname + strlen(KSYMTAB_PFX), mod,
506 export);
1da177e4
LT
507 }
508 if (strcmp(symname, MODULE_SYMBOL_PREFIX "init_module") == 0)
509 mod->has_init = 1;
510 if (strcmp(symname, MODULE_SYMBOL_PREFIX "cleanup_module") == 0)
511 mod->has_cleanup = 1;
512 break;
513 }
514}
515
5c3ead8c
SR
516/**
517 * Parse tag=value strings from .modinfo section
518 **/
1da177e4
LT
519static char *next_string(char *string, unsigned long *secsize)
520{
521 /* Skip non-zero chars */
522 while (string[0]) {
523 string++;
524 if ((*secsize)-- <= 1)
525 return NULL;
526 }
527
528 /* Skip any zero padding. */
529 while (!string[0]) {
530 string++;
531 if ((*secsize)-- <= 1)
532 return NULL;
533 }
534 return string;
535}
536
b817f6fe
SR
537static char *get_next_modinfo(void *modinfo, unsigned long modinfo_len,
538 const char *tag, char *info)
1da177e4
LT
539{
540 char *p;
541 unsigned int taglen = strlen(tag);
542 unsigned long size = modinfo_len;
543
b817f6fe
SR
544 if (info) {
545 size -= info - (char *)modinfo;
546 modinfo = next_string(info, &size);
547 }
548
1da177e4
LT
549 for (p = modinfo; p; p = next_string(p, &size)) {
550 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
551 return p + taglen + 1;
552 }
553 return NULL;
554}
555
b817f6fe
SR
556static char *get_modinfo(void *modinfo, unsigned long modinfo_len,
557 const char *tag)
558
559{
560 return get_next_modinfo(modinfo, modinfo_len, tag, NULL);
561}
562
4c8fbca5
SR
563/**
564 * Test if string s ends in string sub
565 * return 0 if match
566 **/
567static int strrcmp(const char *s, const char *sub)
568{
569 int slen, sublen;
62070fa4 570
4c8fbca5
SR
571 if (!s || !sub)
572 return 1;
62070fa4 573
4c8fbca5
SR
574 slen = strlen(s);
575 sublen = strlen(sub);
62070fa4 576
4c8fbca5
SR
577 if ((slen == 0) || (sublen == 0))
578 return 1;
579
580 if (sublen > slen)
581 return 1;
582
583 return memcmp(s + slen - sublen, sub, sublen);
584}
585
586/**
587 * Whitelist to allow certain references to pass with no warning.
0e0d314e
SR
588 *
589 * Pattern 0:
590 * Do not warn if funtion/data are marked with __init_refok/__initdata_refok.
591 * The pattern is identified by:
592 * fromsec = .text.init.refok | .data.init.refok
593 *
4c8fbca5
SR
594 * Pattern 1:
595 * If a module parameter is declared __initdata and permissions=0
596 * then this is legal despite the warning generated.
597 * We cannot see value of permissions here, so just ignore
598 * this pattern.
599 * The pattern is identified by:
600 * tosec = .init.data
9209aed0 601 * fromsec = .data*
4c8fbca5 602 * atsym =__param*
62070fa4 603 *
4c8fbca5 604 * Pattern 2:
72ee59b5 605 * Many drivers utilise a *driver container with references to
4c8fbca5
SR
606 * add, remove, probe functions etc.
607 * These functions may often be marked __init and we do not want to
608 * warn here.
609 * the pattern is identified by:
5ecdd0f6 610 * tosec = .init.text | .exit.text | .init.data
4c8fbca5 611 * fromsec = .data
aae5f662 612 * atsym = *driver, *_template, *_sht, *_ops, *_probe, *probe_one, *_console
ee6a8545
VG
613 *
614 * Pattern 3:
9bf8cb9b
SR
615 * Whitelist all references from .pci_fixup* section to .init.text
616 * This is part of the PCI init when built-in
617 *
618 * Pattern 4:
619 * Whitelist all refereces from .text.head to .init.data
620 * Whitelist all refereces from .text.head to .init.text
621 *
622 * Pattern 5:
ee6a8545
VG
623 * Some symbols belong to init section but still it is ok to reference
624 * these from non-init sections as these symbols don't have any memory
625 * allocated for them and symbol address and value are same. So even
626 * if init section is freed, its ok to reference those symbols.
627 * For ex. symbols marking the init section boundaries.
628 * This pattern is identified by
629 * refsymname = __init_begin, _sinittext, _einittext
9bf8cb9b 630 *
5a4910fb
SR
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 639 *
72280ede 640 * Pattern 10:
cd547791
LY
641 * ia64 has machvec table for each platform and
642 * powerpc has a machine desc table for each platform.
643 * It is mixture of function pointers of .init.text and .text.
644 * fromsec = .machvec | .machine.desc
4c8fbca5 645 **/
9e157a5a 646static int secref_whitelist(const char *modname, const char *tosec,
ee6a8545
VG
647 const char *fromsec, const char *atsym,
648 const char *refsymname)
4c8fbca5
SR
649{
650 int f1 = 1, f2 = 1;
651 const char **s;
652 const char *pat2sym[] = {
72ee59b5 653 "driver",
5ecdd0f6
SR
654 "_template", /* scsi uses *_template a lot */
655 "_sht", /* scsi also used *_sht to some extent */
4c8fbca5
SR
656 "_ops",
657 "_probe",
658 "_probe_one",
118c0ace 659 "_console",
1833d6bc 660 "apic_es7000",
4c8fbca5
SR
661 NULL
662 };
62070fa4 663
ee6a8545
VG
664 const char *pat3refsym[] = {
665 "__init_begin",
666 "_sinittext",
667 "_einittext",
668 NULL
669 };
670
0e0d314e
SR
671 /* Check for pattern 0 */
672 if ((strcmp(fromsec, ".text.init.refok") == 0) ||
673 (strcmp(fromsec, ".data.init.refok") == 0))
674 return 1;
675
4c8fbca5
SR
676 /* Check for pattern 1 */
677 if (strcmp(tosec, ".init.data") != 0)
678 f1 = 0;
9209aed0 679 if (strncmp(fromsec, ".data", strlen(".data")) != 0)
4c8fbca5
SR
680 f1 = 0;
681 if (strncmp(atsym, "__param", strlen("__param")) != 0)
682 f1 = 0;
683
684 if (f1)
685 return f1;
686
687 /* Check for pattern 2 */
62070fa4 688 if ((strcmp(tosec, ".init.text") != 0) &&
5ecdd0f6
SR
689 (strcmp(tosec, ".exit.text") != 0) &&
690 (strcmp(tosec, ".init.data") != 0))
4c8fbca5
SR
691 f2 = 0;
692 if (strcmp(fromsec, ".data") != 0)
693 f2 = 0;
694
695 for (s = pat2sym; *s; s++)
696 if (strrcmp(atsym, *s) == 0)
697 f1 = 1;
9e157a5a
MD
698 if (f1 && f2)
699 return 1;
4c8fbca5 700
9bf8cb9b
SR
701 /* Check for pattern 3 */
702 if ((strncmp(fromsec, ".pci_fixup", strlen(".pci_fixup")) == 0) &&
703 (strcmp(tosec, ".init.text") == 0))
704 return 1;
f8657e1b 705
aae5f662 706 /* Check for pattern 4 */
9bf8cb9b
SR
707 if ((strcmp(fromsec, ".text.head") == 0) &&
708 ((strcmp(tosec, ".init.data") == 0) ||
709 (strcmp(tosec, ".init.text") == 0)))
710 return 1;
711
712 /* Check for pattern 5 */
713 for (s = pat3refsym; *s; s++)
714 if (strcmp(refsymname, *s) == 0)
715 return 1;
716
5a4910fb
SR
717 /* Check for pattern 7 */
718 if ((strcmp(tosec, ".init.data") == 0) &&
719 (strncmp(fromsec, ".text", strlen(".text")) == 0) &&
720 (strncmp(refsymname, "logo_", strlen("logo_")) == 0))
721 return 1;
b4d5171a 722
72280ede 723 /* Check for pattern 10 */
cd547791
LY
724 if ((strcmp(fromsec, ".machvec") == 0) ||
725 (strcmp(fromsec, ".machine.desc") == 0))
72280ede
YG
726 return 1;
727
93659af1 728 return 0;
4c8fbca5
SR
729}
730
93684d3b
SR
731/**
732 * Find symbol based on relocation record info.
733 * In some cases the symbol supplied is a valid symbol so
734 * return refsym. If st_name != 0 we assume this is a valid symbol.
735 * In other cases the symbol needs to be looked up in the symbol table
736 * based on section and address.
737 * **/
738static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf_Addr addr,
739 Elf_Sym *relsym)
740{
741 Elf_Sym *sym;
742
743 if (relsym->st_name != 0)
744 return relsym;
745 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
746 if (sym->st_shndx != relsym->st_shndx)
747 continue;
ae4ac123
AN
748 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
749 continue;
93684d3b
SR
750 if (sym->st_value == addr)
751 return sym;
752 }
753 return NULL;
754}
755
da68d61f
DB
756static inline int is_arm_mapping_symbol(const char *str)
757{
758 return str[0] == '$' && strchr("atd", str[1])
759 && (str[2] == '\0' || str[2] == '.');
760}
761
762/*
763 * If there's no name there, ignore it; likewise, ignore it if it's
764 * one of the magic symbols emitted used by current ARM tools.
765 *
766 * Otherwise if find_symbols_between() returns those symbols, they'll
767 * fail the whitelist tests and cause lots of false alarms ... fixable
768 * only by merging __exit and __init sections into __text, bloating
769 * the kernel (which is especially evil on embedded platforms).
770 */
771static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
772{
773 const char *name = elf->strtab + sym->st_name;
774
775 if (!name || !strlen(name))
776 return 0;
777 return !is_arm_mapping_symbol(name);
778}
779
b39927cf 780/*
43c74d17
SR
781 * Find symbols before or equal addr and after addr - in the section sec.
782 * If we find two symbols with equal offset prefer one with a valid name.
783 * The ELF format may have a better way to detect what type of symbol
784 * it is, but this works for now.
b39927cf
SR
785 **/
786static void find_symbols_between(struct elf_info *elf, Elf_Addr addr,
787 const char *sec,
788 Elf_Sym **before, Elf_Sym **after)
789{
790 Elf_Sym *sym;
791 Elf_Ehdr *hdr = elf->hdr;
792 Elf_Addr beforediff = ~0;
793 Elf_Addr afterdiff = ~0;
794 const char *secstrings = (void *)hdr +
795 elf->sechdrs[hdr->e_shstrndx].sh_offset;
62070fa4 796
b39927cf
SR
797 *before = NULL;
798 *after = NULL;
799
800 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
801 const char *symsec;
802
803 if (sym->st_shndx >= SHN_LORESERVE)
804 continue;
805 symsec = secstrings + elf->sechdrs[sym->st_shndx].sh_name;
806 if (strcmp(symsec, sec) != 0)
807 continue;
da68d61f
DB
808 if (!is_valid_name(elf, sym))
809 continue;
b39927cf
SR
810 if (sym->st_value <= addr) {
811 if ((addr - sym->st_value) < beforediff) {
812 beforediff = addr - sym->st_value;
813 *before = sym;
814 }
43c74d17 815 else if ((addr - sym->st_value) == beforediff) {
da68d61f 816 *before = sym;
43c74d17 817 }
b39927cf
SR
818 }
819 else
820 {
821 if ((sym->st_value - addr) < afterdiff) {
822 afterdiff = sym->st_value - addr;
823 *after = sym;
824 }
43c74d17 825 else if ((sym->st_value - addr) == afterdiff) {
da68d61f 826 *after = sym;
43c74d17 827 }
b39927cf
SR
828 }
829 }
830}
831
832/**
833 * Print a warning about a section mismatch.
834 * Try to find symbols near it so user can find it.
4c8fbca5 835 * Check whitelist before warning - it may be a false positive.
b39927cf
SR
836 **/
837static void warn_sec_mismatch(const char *modname, const char *fromsec,
838 struct elf_info *elf, Elf_Sym *sym, Elf_Rela r)
839{
93684d3b
SR
840 const char *refsymname = "";
841 Elf_Sym *before, *after;
842 Elf_Sym *refsym;
b39927cf
SR
843 Elf_Ehdr *hdr = elf->hdr;
844 Elf_Shdr *sechdrs = elf->sechdrs;
845 const char *secstrings = (void *)hdr +
846 sechdrs[hdr->e_shstrndx].sh_offset;
847 const char *secname = secstrings + sechdrs[sym->st_shndx].sh_name;
62070fa4 848
b39927cf
SR
849 find_symbols_between(elf, r.r_offset, fromsec, &before, &after);
850
93684d3b
SR
851 refsym = find_elf_symbol(elf, r.r_addend, sym);
852 if (refsym && strlen(elf->strtab + refsym->st_name))
853 refsymname = elf->strtab + refsym->st_name;
4c8fbca5
SR
854
855 /* check whitelist - we may ignore it */
62070fa4 856 if (before &&
9e157a5a 857 secref_whitelist(modname, secname, fromsec,
ee6a8545 858 elf->strtab + before->st_name, refsymname))
4c8fbca5 859 return;
62070fa4 860
b39927cf 861 if (before && after) {
25601209
RK
862 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
863 "(between '%s' and '%s')\n",
864 modname, fromsec, (unsigned long long)r.r_offset,
865 secname, refsymname,
b39927cf 866 elf->strtab + before->st_name,
b39927cf
SR
867 elf->strtab + after->st_name);
868 } else if (before) {
25601209
RK
869 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
870 "(after '%s')\n",
871 modname, fromsec, (unsigned long long)r.r_offset,
872 secname, refsymname,
873 elf->strtab + before->st_name);
b39927cf 874 } else if (after) {
25601209 875 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
93684d3b 876 "before '%s' (at offset -0x%llx)\n",
25601209
RK
877 modname, fromsec, (unsigned long long)r.r_offset,
878 secname, refsymname,
879 elf->strtab + after->st_name);
b39927cf 880 } else {
25601209
RK
881 warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s\n",
882 modname, fromsec, (unsigned long long)r.r_offset,
883 secname, refsymname);
b39927cf
SR
884 }
885}
886
ae4ac123
AN
887static unsigned int *reloc_location(struct elf_info *elf,
888 int rsection, Elf_Rela *r)
889{
890 Elf_Shdr *sechdrs = elf->sechdrs;
891 int section = sechdrs[rsection].sh_info;
892
893 return (void *)elf->hdr + sechdrs[section].sh_offset +
894 (r->r_offset - sechdrs[section].sh_addr);
895}
896
897static int addend_386_rel(struct elf_info *elf, int rsection, Elf_Rela *r)
898{
899 unsigned int r_typ = ELF_R_TYPE(r->r_info);
900 unsigned int *location = reloc_location(elf, rsection, r);
901
902 switch (r_typ) {
903 case R_386_32:
904 r->r_addend = TO_NATIVE(*location);
905 break;
906 case R_386_PC32:
907 r->r_addend = TO_NATIVE(*location) + 4;
908 /* For CONFIG_RELOCATABLE=y */
909 if (elf->hdr->e_type == ET_EXEC)
910 r->r_addend += r->r_offset;
911 break;
912 }
913 return 0;
914}
915
56a974fa
SR
916static int addend_arm_rel(struct elf_info *elf, int rsection, Elf_Rela *r)
917{
918 unsigned int r_typ = ELF_R_TYPE(r->r_info);
919
920 switch (r_typ) {
921 case R_ARM_ABS32:
922 /* From ARM ABI: (S + A) | T */
923 r->r_addend = (int)(long)(elf->symtab_start + ELF_R_SYM(r->r_info));
924 break;
925 case R_ARM_PC24:
926 /* From ARM ABI: ((S + A) | T) - P */
927 r->r_addend = (int)(long)(elf->hdr + elf->sechdrs[rsection].sh_offset +
928 (r->r_offset - elf->sechdrs[rsection].sh_addr));
929 break;
930 default:
931 return 1;
932 }
933 return 0;
934}
935
ae4ac123
AN
936static int addend_mips_rel(struct elf_info *elf, int rsection, Elf_Rela *r)
937{
938 unsigned int r_typ = ELF_R_TYPE(r->r_info);
939 unsigned int *location = reloc_location(elf, rsection, r);
940 unsigned int inst;
941
942 if (r_typ == R_MIPS_HI16)
943 return 1; /* skip this */
944 inst = TO_NATIVE(*location);
945 switch (r_typ) {
946 case R_MIPS_LO16:
947 r->r_addend = inst & 0xffff;
948 break;
949 case R_MIPS_26:
950 r->r_addend = (inst & 0x03ffffff) << 2;
951 break;
952 case R_MIPS_32:
953 r->r_addend = inst;
954 break;
955 }
956 return 0;
957}
958
b39927cf
SR
959/**
960 * A module includes a number of sections that are discarded
961 * either when loaded or when used as built-in.
962 * For loaded modules all functions marked __init and all data
963 * marked __initdata will be discarded when the module has been intialized.
964 * Likewise for modules used built-in the sections marked __exit
965 * are discarded because __exit marked function are supposed to be called
966 * only when a moduel is unloaded which never happes for built-in modules.
967 * The check_sec_ref() function traverses all relocation records
968 * to find all references to a section that reference a section that will
969 * be discarded and warns about it.
970 **/
971static void check_sec_ref(struct module *mod, const char *modname,
972 struct elf_info *elf,
973 int section(const char*),
974 int section_ref_ok(const char *))
975{
976 int i;
977 Elf_Sym *sym;
978 Elf_Ehdr *hdr = elf->hdr;
979 Elf_Shdr *sechdrs = elf->sechdrs;
980 const char *secstrings = (void *)hdr +
981 sechdrs[hdr->e_shstrndx].sh_offset;
62070fa4 982
b39927cf
SR
983 /* Walk through all sections */
984 for (i = 0; i < hdr->e_shnum; i++) {
2c1a51f3
AN
985 const char *name = secstrings + sechdrs[i].sh_name;
986 const char *secname;
987 Elf_Rela r;
eae07ac6 988 unsigned int r_sym;
b39927cf 989 /* We want to process only relocation sections and not .init */
2c1a51f3
AN
990 if (sechdrs[i].sh_type == SHT_RELA) {
991 Elf_Rela *rela;
992 Elf_Rela *start = (void *)hdr + sechdrs[i].sh_offset;
993 Elf_Rela *stop = (void*)start + sechdrs[i].sh_size;
994 name += strlen(".rela");
995 if (section_ref_ok(name))
996 continue;
b39927cf 997
2c1a51f3
AN
998 for (rela = start; rela < stop; rela++) {
999 r.r_offset = TO_NATIVE(rela->r_offset);
eae07ac6
AN
1000#if KERNEL_ELFCLASS == ELFCLASS64
1001 if (hdr->e_machine == EM_MIPS) {
ae4ac123 1002 unsigned int r_typ;
eae07ac6
AN
1003 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1004 r_sym = TO_NATIVE(r_sym);
ae4ac123
AN
1005 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1006 r.r_info = ELF64_R_INFO(r_sym, r_typ);
eae07ac6
AN
1007 } else {
1008 r.r_info = TO_NATIVE(rela->r_info);
1009 r_sym = ELF_R_SYM(r.r_info);
1010 }
1011#else
1012 r.r_info = TO_NATIVE(rela->r_info);
1013 r_sym = ELF_R_SYM(r.r_info);
1014#endif
2c1a51f3 1015 r.r_addend = TO_NATIVE(rela->r_addend);
eae07ac6 1016 sym = elf->symtab_start + r_sym;
2c1a51f3
AN
1017 /* Skip special sections */
1018 if (sym->st_shndx >= SHN_LORESERVE)
1019 continue;
1020
1021 secname = secstrings +
1022 sechdrs[sym->st_shndx].sh_name;
1023 if (section(secname))
1024 warn_sec_mismatch(modname, name,
1025 elf, sym, r);
1026 }
1027 } else if (sechdrs[i].sh_type == SHT_REL) {
1028 Elf_Rel *rel;
1029 Elf_Rel *start = (void *)hdr + sechdrs[i].sh_offset;
1030 Elf_Rel *stop = (void*)start + sechdrs[i].sh_size;
1031 name += strlen(".rel");
1032 if (section_ref_ok(name))
b39927cf
SR
1033 continue;
1034
2c1a51f3
AN
1035 for (rel = start; rel < stop; rel++) {
1036 r.r_offset = TO_NATIVE(rel->r_offset);
eae07ac6
AN
1037#if KERNEL_ELFCLASS == ELFCLASS64
1038 if (hdr->e_machine == EM_MIPS) {
ae4ac123 1039 unsigned int r_typ;
eae07ac6
AN
1040 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1041 r_sym = TO_NATIVE(r_sym);
ae4ac123
AN
1042 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1043 r.r_info = ELF64_R_INFO(r_sym, r_typ);
eae07ac6
AN
1044 } else {
1045 r.r_info = TO_NATIVE(rel->r_info);
1046 r_sym = ELF_R_SYM(r.r_info);
1047 }
1048#else
1049 r.r_info = TO_NATIVE(rel->r_info);
1050 r_sym = ELF_R_SYM(r.r_info);
1051#endif
2c1a51f3 1052 r.r_addend = 0;
ae4ac123
AN
1053 switch (hdr->e_machine) {
1054 case EM_386:
1055 if (addend_386_rel(elf, i, &r))
1056 continue;
1057 break;
56a974fa
SR
1058 case EM_ARM:
1059 if(addend_arm_rel(elf, i, &r))
1060 continue;
1061 break;
ae4ac123
AN
1062 case EM_MIPS:
1063 if (addend_mips_rel(elf, i, &r))
1064 continue;
1065 break;
1066 }
eae07ac6 1067 sym = elf->symtab_start + r_sym;
2c1a51f3
AN
1068 /* Skip special sections */
1069 if (sym->st_shndx >= SHN_LORESERVE)
1070 continue;
1071
1072 secname = secstrings +
1073 sechdrs[sym->st_shndx].sh_name;
1074 if (section(secname))
1075 warn_sec_mismatch(modname, name,
1076 elf, sym, r);
1077 }
b39927cf
SR
1078 }
1079 }
1080}
1081
1087247b
SR
1082/*
1083 * Identify sections from which references to either a
1084 * .init or a .exit section is OK.
1085 *
1086 * [OPD] Keith Ownes <kaos@sgi.com> commented:
1087 * For our future {in}sanity, add a comment that this is the ppc .opd
1088 * section, not the ia64 .opd section.
1089 * ia64 .opd should not point to discarded sections.
1090 * [.rodata] like for .init.text we ignore .rodata references -same reason
1091 **/
1092static int initexit_section_ref_ok(const char *name)
1093{
1094 const char **s;
1095 /* Absolute section names */
1096 const char *namelist1[] = {
1097 "__bug_table", /* used by powerpc for BUG() */
1098 "__ex_table",
1099 ".altinstructions",
1100 ".cranges", /* used by sh64 */
1101 ".fixup",
1102 ".opd", /* See comment [OPD] */
1103 ".parainstructions",
1104 ".pdr",
1105 ".plt", /* seen on ARCH=um build on x86_64. Harmless */
1106 ".smp_locks",
1107 ".stab",
1108 NULL
1109 };
1110 /* Start of section names */
1111 const char *namelist2[] = {
1112 ".debug",
1113 ".eh_frame",
1114 ".note", /* ignore ELF notes - may contain anything */
1115 ".got", /* powerpc - global offset table */
1116 ".toc", /* powerpc - table of contents */
1117 NULL
1118 };
1119 /* part of section name */
1120 const char *namelist3 [] = {
1121 ".unwind", /* Sample: IA_64.unwind.exit.text */
1122 NULL
1123 };
1124
1125 for (s = namelist1; *s; s++)
1126 if (strcmp(*s, name) == 0)
1127 return 1;
1128 for (s = namelist2; *s; s++)
1129 if (strncmp(*s, name, strlen(*s)) == 0)
1130 return 1;
1131 for (s = namelist3; *s; s++)
1132 if (strstr(name, *s) != NULL)
1133 return 1;
1134 return 0;
1135}
1136
b39927cf
SR
1137/**
1138 * Functions used only during module init is marked __init and is stored in
1139 * a .init.text section. Likewise data is marked __initdata and stored in
1140 * a .init.data section.
1141 * If this section is one of these sections return 1
1142 * See include/linux/init.h for the details
1143 **/
1144static int init_section(const char *name)
1145{
1146 if (strcmp(name, ".init") == 0)
1147 return 1;
1148 if (strncmp(name, ".init.", strlen(".init.")) == 0)
1149 return 1;
1150 return 0;
1151}
1152
1087247b 1153/*
b39927cf 1154 * Identify sections from which references to a .init section is OK.
62070fa4 1155 *
b39927cf
SR
1156 * Unfortunately references to read only data that referenced .init
1157 * sections had to be excluded. Almost all of these are false
1158 * positives, they are created by gcc. The downside of excluding rodata
1159 * is that there really are some user references from rodata to
1160 * init code, e.g. drivers/video/vgacon.c:
62070fa4 1161 *
b39927cf
SR
1162 * const struct consw vga_con = {
1163 * con_startup: vgacon_startup,
1164 *
1165 * where vgacon_startup is __init. If you want to wade through the false
1166 * positives, take out the check for rodata.
1087247b 1167 */
b39927cf
SR
1168static int init_section_ref_ok(const char *name)
1169{
1170 const char **s;
1171 /* Absolute section names */
1172 const char *namelist1[] = {
21c4ff80
BH
1173 "__ftr_fixup", /* powerpc cpu feature fixup */
1174 "__fw_ftr_fixup", /* powerpc firmware feature fixup */
1087247b
SR
1175 "__param",
1176 ".data.rel.ro", /* used by parisc64 */
1177 ".init",
1178 ".text.lock",
b39927cf
SR
1179 NULL
1180 };
1181 /* Start of section names */
1182 const char *namelist2[] = {
1183 ".init.",
1087247b 1184 ".pci_fixup",
742433b0 1185 ".rodata",
6e10133f
SR
1186 NULL
1187 };
1188
1087247b
SR
1189 if (initexit_section_ref_ok(name))
1190 return 1;
1191
b39927cf
SR
1192 for (s = namelist1; *s; s++)
1193 if (strcmp(*s, name) == 0)
1194 return 1;
62070fa4 1195 for (s = namelist2; *s; s++)
b39927cf
SR
1196 if (strncmp(*s, name, strlen(*s)) == 0)
1197 return 1;
1087247b
SR
1198
1199 /* If section name ends with ".init" we allow references
1200 * as is the case with .initcallN.init, .early_param.init, .taglist.init etc
1201 */
468d9494
AV
1202 if (strrcmp(name, ".init") == 0)
1203 return 1;
b39927cf
SR
1204 return 0;
1205}
1206
1207/*
1208 * Functions used only during module exit is marked __exit and is stored in
1209 * a .exit.text section. Likewise data is marked __exitdata and stored in
1210 * a .exit.data section.
1211 * If this section is one of these sections return 1
1212 * See include/linux/init.h for the details
1213 **/
1214static int exit_section(const char *name)
1215{
1216 if (strcmp(name, ".exit.text") == 0)
1217 return 1;
1218 if (strcmp(name, ".exit.data") == 0)
1219 return 1;
1220 return 0;
62070fa4 1221
b39927cf
SR
1222}
1223
1224/*
1225 * Identify sections from which references to a .exit section is OK.
1087247b 1226 */
b39927cf
SR
1227static int exit_section_ref_ok(const char *name)
1228{
1229 const char **s;
1230 /* Absolute section names */
1231 const char *namelist1[] = {
b39927cf 1232 ".exit.data",
1087247b
SR
1233 ".exit.text",
1234 ".exitcall.exit",
b39927cf 1235 ".init.text",
5ecdd0f6 1236 ".rodata",
6e10133f
SR
1237 NULL
1238 };
62070fa4 1239
1087247b
SR
1240 if (initexit_section_ref_ok(name))
1241 return 1;
1242
b39927cf
SR
1243 for (s = namelist1; *s; s++)
1244 if (strcmp(*s, name) == 0)
1245 return 1;
b39927cf
SR
1246 return 0;
1247}
1248
5c3ead8c 1249static void read_symbols(char *modname)
1da177e4
LT
1250{
1251 const char *symname;
1252 char *version;
b817f6fe 1253 char *license;
1da177e4
LT
1254 struct module *mod;
1255 struct elf_info info = { };
1256 Elf_Sym *sym;
1257
85bd2fdd
SR
1258 if (!parse_elf(&info, modname))
1259 return;
1da177e4
LT
1260
1261 mod = new_module(modname);
1262
1263 /* When there's no vmlinux, don't print warnings about
1264 * unresolved symbols (since there'll be too many ;) */
1265 if (is_vmlinux(modname)) {
1da177e4 1266 have_vmlinux = 1;
1da177e4
LT
1267 mod->skip = 1;
1268 }
1269
b817f6fe
SR
1270 license = get_modinfo(info.modinfo, info.modinfo_len, "license");
1271 while (license) {
1272 if (license_is_gpl_compatible(license))
1273 mod->gpl_compatible = 1;
1274 else {
1275 mod->gpl_compatible = 0;
1276 break;
1277 }
1278 license = get_next_modinfo(info.modinfo, info.modinfo_len,
1279 "license", license);
1280 }
1281
1da177e4
LT
1282 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
1283 symname = info.strtab + sym->st_name;
1284
1285 handle_modversions(mod, &info, sym, symname);
1286 handle_moddevtable(mod, &info, sym, symname);
1287 }
b39927cf
SR
1288 check_sec_ref(mod, modname, &info, init_section, init_section_ref_ok);
1289 check_sec_ref(mod, modname, &info, exit_section, exit_section_ref_ok);
1da177e4
LT
1290
1291 version = get_modinfo(info.modinfo, info.modinfo_len, "version");
1292 if (version)
1293 maybe_frob_rcs_version(modname, version, info.modinfo,
1294 version - (char *)info.hdr);
1295 if (version || (all_versions && !is_vmlinux(modname)))
1296 get_src_version(modname, mod->srcversion,
1297 sizeof(mod->srcversion)-1);
1298
1299 parse_elf_finish(&info);
1300
1301 /* Our trick to get versioning for struct_module - it's
1302 * never passed as an argument to an exported function, so
1303 * the automatic versioning doesn't pick it up, but it's really
1304 * important anyhow */
1305 if (modversions)
1306 mod->unres = alloc_symbol("struct_module", 0, mod->unres);
1307}
1308
1309#define SZ 500
1310
1311/* We first write the generated file into memory using the
1312 * following helper, then compare to the file on disk and
1313 * only update the later if anything changed */
1314
5c3ead8c
SR
1315void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
1316 const char *fmt, ...)
1da177e4
LT
1317{
1318 char tmp[SZ];
1319 int len;
1320 va_list ap;
62070fa4 1321
1da177e4
LT
1322 va_start(ap, fmt);
1323 len = vsnprintf(tmp, SZ, fmt, ap);
7670f023 1324 buf_write(buf, tmp, len);
1da177e4
LT
1325 va_end(ap);
1326}
1327
5c3ead8c 1328void buf_write(struct buffer *buf, const char *s, int len)
1da177e4
LT
1329{
1330 if (buf->size - buf->pos < len) {
7670f023 1331 buf->size += len + SZ;
1da177e4
LT
1332 buf->p = realloc(buf->p, buf->size);
1333 }
1334 strncpy(buf->p + buf->pos, s, len);
1335 buf->pos += len;
1336}
1337
c96fca21
SR
1338static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
1339{
1340 const char *e = is_vmlinux(m) ?"":".ko";
1341
1342 switch (exp) {
1343 case export_gpl:
1344 fatal("modpost: GPL-incompatible module %s%s "
1345 "uses GPL-only symbol '%s'\n", m, e, s);
1346 break;
1347 case export_unused_gpl:
1348 fatal("modpost: GPL-incompatible module %s%s "
1349 "uses GPL-only symbol marked UNUSED '%s'\n", m, e, s);
1350 break;
1351 case export_gpl_future:
1352 warn("modpost: GPL-incompatible module %s%s "
1353 "uses future GPL-only symbol '%s'\n", m, e, s);
1354 break;
1355 case export_plain:
1356 case export_unused:
1357 case export_unknown:
1358 /* ignore */
1359 break;
1360 }
1361}
1362
1363static void check_for_unused(enum export exp, const char* m, const char* s)
1364{
1365 const char *e = is_vmlinux(m) ?"":".ko";
1366
1367 switch (exp) {
1368 case export_unused:
1369 case export_unused_gpl:
1370 warn("modpost: module %s%s "
1371 "uses symbol '%s' marked UNUSED\n", m, e, s);
1372 break;
1373 default:
1374 /* ignore */
1375 break;
1376 }
1377}
1378
1379static void check_exports(struct module *mod)
b817f6fe
SR
1380{
1381 struct symbol *s, *exp;
1382
1383 for (s = mod->unres; s; s = s->next) {
6449bd62 1384 const char *basename;
b817f6fe
SR
1385 exp = find_symbol(s->name);
1386 if (!exp || exp->module == mod)
1387 continue;
6449bd62 1388 basename = strrchr(mod->name, '/');
b817f6fe
SR
1389 if (basename)
1390 basename++;
c96fca21
SR
1391 else
1392 basename = mod->name;
1393 if (!mod->gpl_compatible)
1394 check_for_gpl_usage(exp->export, basename, exp->name);
1395 check_for_unused(exp->export, basename, exp->name);
b817f6fe
SR
1396 }
1397}
1398
5c3ead8c
SR
1399/**
1400 * Header for the generated file
1401 **/
1402static void add_header(struct buffer *b, struct module *mod)
1da177e4
LT
1403{
1404 buf_printf(b, "#include <linux/module.h>\n");
1405 buf_printf(b, "#include <linux/vermagic.h>\n");
1406 buf_printf(b, "#include <linux/compiler.h>\n");
1407 buf_printf(b, "\n");
1408 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
1409 buf_printf(b, "\n");
1da177e4
LT
1410 buf_printf(b, "struct module __this_module\n");
1411 buf_printf(b, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
f83b5e32 1412 buf_printf(b, " .name = KBUILD_MODNAME,\n");
1da177e4
LT
1413 if (mod->has_init)
1414 buf_printf(b, " .init = init_module,\n");
1415 if (mod->has_cleanup)
1416 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
1417 " .exit = cleanup_module,\n"
1418 "#endif\n");
e61a1c1c 1419 buf_printf(b, " .arch = MODULE_ARCH_INIT,\n");
1da177e4
LT
1420 buf_printf(b, "};\n");
1421}
1422
5c3ead8c
SR
1423/**
1424 * Record CRCs for unresolved symbols
1425 **/
c53ddacd 1426static int add_versions(struct buffer *b, struct module *mod)
1da177e4
LT
1427{
1428 struct symbol *s, *exp;
c53ddacd 1429 int err = 0;
1da177e4
LT
1430
1431 for (s = mod->unres; s; s = s->next) {
1432 exp = find_symbol(s->name);
1433 if (!exp || exp->module == mod) {
c53ddacd 1434 if (have_vmlinux && !s->weak) {
2a116659
MW
1435 if (warn_unresolved) {
1436 warn("\"%s\" [%s.ko] undefined!\n",
1437 s->name, mod->name);
1438 } else {
1439 merror("\"%s\" [%s.ko] undefined!\n",
1440 s->name, mod->name);
1441 err = 1;
1442 }
c53ddacd 1443 }
1da177e4
LT
1444 continue;
1445 }
1446 s->module = exp->module;
1447 s->crc_valid = exp->crc_valid;
1448 s->crc = exp->crc;
1449 }
1450
1451 if (!modversions)
c53ddacd 1452 return err;
1da177e4
LT
1453
1454 buf_printf(b, "\n");
1455 buf_printf(b, "static const struct modversion_info ____versions[]\n");
1456 buf_printf(b, "__attribute_used__\n");
1457 buf_printf(b, "__attribute__((section(\"__versions\"))) = {\n");
1458
1459 for (s = mod->unres; s; s = s->next) {
1460 if (!s->module) {
1461 continue;
1462 }
1463 if (!s->crc_valid) {
cb80514d 1464 warn("\"%s\" [%s.ko] has no CRC!\n",
1da177e4
LT
1465 s->name, mod->name);
1466 continue;
1467 }
1468 buf_printf(b, "\t{ %#8x, \"%s\" },\n", s->crc, s->name);
1469 }
1470
1471 buf_printf(b, "};\n");
c53ddacd
KK
1472
1473 return err;
1da177e4
LT
1474}
1475
5c3ead8c
SR
1476static void add_depends(struct buffer *b, struct module *mod,
1477 struct module *modules)
1da177e4
LT
1478{
1479 struct symbol *s;
1480 struct module *m;
1481 int first = 1;
1482
1483 for (m = modules; m; m = m->next) {
1484 m->seen = is_vmlinux(m->name);
1485 }
1486
1487 buf_printf(b, "\n");
1488 buf_printf(b, "static const char __module_depends[]\n");
1489 buf_printf(b, "__attribute_used__\n");
1490 buf_printf(b, "__attribute__((section(\".modinfo\"))) =\n");
1491 buf_printf(b, "\"depends=");
1492 for (s = mod->unres; s; s = s->next) {
a61b2dfd 1493 const char *p;
1da177e4
LT
1494 if (!s->module)
1495 continue;
1496
1497 if (s->module->seen)
1498 continue;
1499
1500 s->module->seen = 1;
a61b2dfd
SR
1501 if ((p = strrchr(s->module->name, '/')) != NULL)
1502 p++;
1503 else
1504 p = s->module->name;
1505 buf_printf(b, "%s%s", first ? "" : ",", p);
1da177e4
LT
1506 first = 0;
1507 }
1508 buf_printf(b, "\";\n");
1509}
1510
5c3ead8c 1511static void add_srcversion(struct buffer *b, struct module *mod)
1da177e4
LT
1512{
1513 if (mod->srcversion[0]) {
1514 buf_printf(b, "\n");
1515 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
1516 mod->srcversion);
1517 }
1518}
1519
5c3ead8c 1520static void write_if_changed(struct buffer *b, const char *fname)
1da177e4
LT
1521{
1522 char *tmp;
1523 FILE *file;
1524 struct stat st;
1525
1526 file = fopen(fname, "r");
1527 if (!file)
1528 goto write;
1529
1530 if (fstat(fileno(file), &st) < 0)
1531 goto close_write;
1532
1533 if (st.st_size != b->pos)
1534 goto close_write;
1535
1536 tmp = NOFAIL(malloc(b->pos));
1537 if (fread(tmp, 1, b->pos, file) != b->pos)
1538 goto free_write;
1539
1540 if (memcmp(tmp, b->p, b->pos) != 0)
1541 goto free_write;
1542
1543 free(tmp);
1544 fclose(file);
1545 return;
1546
1547 free_write:
1548 free(tmp);
1549 close_write:
1550 fclose(file);
1551 write:
1552 file = fopen(fname, "w");
1553 if (!file) {
1554 perror(fname);
1555 exit(1);
1556 }
1557 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
1558 perror(fname);
1559 exit(1);
1560 }
1561 fclose(file);
1562}
1563
bd5cbced 1564/* parse Module.symvers file. line format:
534b89a9 1565 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
bd5cbced 1566 **/
040fcc81 1567static void read_dump(const char *fname, unsigned int kernel)
1da177e4
LT
1568{
1569 unsigned long size, pos = 0;
1570 void *file = grab_file(fname, &size);
1571 char *line;
1572
1573 if (!file)
1574 /* No symbol versions, silently ignore */
1575 return;
1576
1577 while ((line = get_next_line(&pos, file, size))) {
534b89a9 1578 char *symname, *modname, *d, *export, *end;
1da177e4
LT
1579 unsigned int crc;
1580 struct module *mod;
040fcc81 1581 struct symbol *s;
1da177e4
LT
1582
1583 if (!(symname = strchr(line, '\t')))
1584 goto fail;
1585 *symname++ = '\0';
1586 if (!(modname = strchr(symname, '\t')))
1587 goto fail;
1588 *modname++ = '\0';
9ac545b0 1589 if ((export = strchr(modname, '\t')) != NULL)
bd5cbced 1590 *export++ = '\0';
534b89a9
SR
1591 if (export && ((end = strchr(export, '\t')) != NULL))
1592 *end = '\0';
1da177e4
LT
1593 crc = strtoul(line, &d, 16);
1594 if (*symname == '\0' || *modname == '\0' || *d != '\0')
1595 goto fail;
1596
1597 if (!(mod = find_module(modname))) {
1598 if (is_vmlinux(modname)) {
1599 have_vmlinux = 1;
1600 }
1601 mod = new_module(NOFAIL(strdup(modname)));
1602 mod->skip = 1;
1603 }
bd5cbced 1604 s = sym_add_exported(symname, mod, export_no(export));
8e70c458
SR
1605 s->kernel = kernel;
1606 s->preloaded = 1;
bd5cbced 1607 sym_update_crc(symname, mod, crc, export_no(export));
1da177e4
LT
1608 }
1609 return;
1610fail:
1611 fatal("parse error in symbol dump file\n");
1612}
1613
040fcc81
SR
1614/* For normal builds always dump all symbols.
1615 * For external modules only dump symbols
1616 * that are not read from kernel Module.symvers.
1617 **/
1618static int dump_sym(struct symbol *sym)
1619{
1620 if (!external_module)
1621 return 1;
1622 if (sym->vmlinux || sym->kernel)
1623 return 0;
1624 return 1;
1625}
62070fa4 1626
5c3ead8c 1627static void write_dump(const char *fname)
1da177e4
LT
1628{
1629 struct buffer buf = { };
1630 struct symbol *symbol;
1631 int n;
1632
1633 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
1634 symbol = symbolhash[n];
1635 while (symbol) {
040fcc81 1636 if (dump_sym(symbol))
bd5cbced 1637 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\n",
62070fa4 1638 symbol->crc, symbol->name,
bd5cbced
RP
1639 symbol->module->name,
1640 export_str(symbol->export));
1da177e4
LT
1641 symbol = symbol->next;
1642 }
1643 }
1644 write_if_changed(&buf, fname);
1645}
1646
5c3ead8c 1647int main(int argc, char **argv)
1da177e4
LT
1648{
1649 struct module *mod;
1650 struct buffer buf = { };
1651 char fname[SZ];
040fcc81
SR
1652 char *kernel_read = NULL, *module_read = NULL;
1653 char *dump_write = NULL;
1da177e4 1654 int opt;
c53ddacd 1655 int err;
1da177e4 1656
c53ddacd 1657 while ((opt = getopt(argc, argv, "i:I:mo:aw")) != -1) {
1da177e4
LT
1658 switch(opt) {
1659 case 'i':
040fcc81
SR
1660 kernel_read = optarg;
1661 break;
1662 case 'I':
1663 module_read = optarg;
1664 external_module = 1;
1da177e4
LT
1665 break;
1666 case 'm':
1667 modversions = 1;
1668 break;
1669 case 'o':
1670 dump_write = optarg;
1671 break;
1672 case 'a':
1673 all_versions = 1;
1674 break;
c53ddacd
KK
1675 case 'w':
1676 warn_unresolved = 1;
1677 break;
1da177e4
LT
1678 default:
1679 exit(1);
1680 }
1681 }
1682
040fcc81
SR
1683 if (kernel_read)
1684 read_dump(kernel_read, 1);
1685 if (module_read)
1686 read_dump(module_read, 0);
1da177e4
LT
1687
1688 while (optind < argc) {
1689 read_symbols(argv[optind++]);
1690 }
1691
b817f6fe
SR
1692 for (mod = modules; mod; mod = mod->next) {
1693 if (mod->skip)
1694 continue;
c96fca21 1695 check_exports(mod);
b817f6fe
SR
1696 }
1697
c53ddacd
KK
1698 err = 0;
1699
1da177e4
LT
1700 for (mod = modules; mod; mod = mod->next) {
1701 if (mod->skip)
1702 continue;
1703
1704 buf.pos = 0;
1705
1706 add_header(&buf, mod);
c53ddacd 1707 err |= add_versions(&buf, mod);
1da177e4
LT
1708 add_depends(&buf, mod, modules);
1709 add_moddevtable(&buf, mod);
1710 add_srcversion(&buf, mod);
1711
1712 sprintf(fname, "%s.mod.c", mod->name);
1713 write_if_changed(&buf, fname);
1714 }
1715
1716 if (dump_write)
1717 write_dump(dump_write);
1718
c53ddacd 1719 return err;
1da177e4 1720}
This page took 0.363762 seconds and 5 git commands to generate.