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