blob: 3318692e4e761ffecaf1849693e376291b5a7655 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Postprocess module symbol versions
2 *
3 * Copyright 2003 Kai Germaschewski
4 * Copyright 2002-2004 Rusty Russell, IBM Corporation
Sam Ravnborgdf578e72008-01-11 19:17:15 +01005 * Copyright 2006-2008 Sam Ravnborg
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * 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
Mathieu Desnoyersb2e3e652008-02-13 15:03:39 -080014#define _GNU_SOURCE
15#include <stdio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <ctype.h>
17#include "modpost.h"
Linus Torvalds5a865c02009-12-17 07:23:42 -080018#include "../../include/generated/autoconf.h"
Sam Ravnborgb817f6f2006-06-09 21:53:55 +020019#include "../../include/linux/license.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Alan Jenkins9e1b9b82009-11-07 21:03:54 +000021/* Some toolchains use a `_' prefix for all user symbols. */
22#ifdef CONFIG_SYMBOL_PREFIX
23#define MODULE_SYMBOL_PREFIX CONFIG_SYMBOL_PREFIX
24#else
25#define MODULE_SYMBOL_PREFIX ""
26#endif
27
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029/* Are we using CONFIG_MODVERSIONS? */
30int modversions = 0;
31/* Warn about undefined symbols? (do so if we have vmlinux) */
32int have_vmlinux = 0;
33/* Is CONFIG_MODULE_SRCVERSION_ALL set? */
34static int all_versions = 0;
Sam Ravnborg040fcc82006-01-28 22:15:55 +010035/* If we are modposting external module set to 1 */
36static int external_module = 0;
Sam Ravnborg8d8d8282007-07-20 22:36:56 +020037/* Warn about section mismatch in vmlinux if set to 1 */
38static int vmlinux_section_warnings = 1;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -070039/* Only warn about unresolved symbols */
40static int warn_unresolved = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -070041/* How a symbol is exported */
Sam Ravnborg588ccd72008-01-24 21:12:37 +010042static int sec_mismatch_count = 0;
43static int sec_mismatch_verbose = 1;
44
Sam Ravnborgc96fca22006-07-01 11:44:23 +020045enum export {
46 export_plain, export_unused, export_gpl,
47 export_unused_gpl, export_gpl_future, export_unknown
48};
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Andi Kleen6d9a89e2007-11-22 03:43:08 +010050#define PRINTF __attribute__ ((format (printf, 1, 2)))
51
52PRINTF void fatal(const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070053{
54 va_list arglist;
55
56 fprintf(stderr, "FATAL: ");
57
58 va_start(arglist, fmt);
59 vfprintf(stderr, fmt, arglist);
60 va_end(arglist);
61
62 exit(1);
63}
64
Andi Kleen6d9a89e2007-11-22 03:43:08 +010065PRINTF void warn(const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066{
67 va_list arglist;
68
69 fprintf(stderr, "WARNING: ");
70
71 va_start(arglist, fmt);
72 vfprintf(stderr, fmt, arglist);
73 va_end(arglist);
74}
75
Andi Kleen6d9a89e2007-11-22 03:43:08 +010076PRINTF void merror(const char *fmt, ...)
Matthew Wilcox2a116652006-10-07 05:35:32 -060077{
78 va_list arglist;
79
80 fprintf(stderr, "ERROR: ");
81
82 va_start(arglist, fmt);
83 vfprintf(stderr, fmt, arglist);
84 va_end(arglist);
85}
86
Sam Ravnborg040fcc82006-01-28 22:15:55 +010087static int is_vmlinux(const char *modname)
88{
89 const char *myname;
90
Sam Ravnborgdf578e72008-01-11 19:17:15 +010091 myname = strrchr(modname, '/');
92 if (myname)
Sam Ravnborg040fcc82006-01-28 22:15:55 +010093 myname++;
94 else
95 myname = modname;
96
Sam Ravnborg741f98f2007-07-17 10:54:06 +020097 return (strcmp(myname, "vmlinux") == 0) ||
98 (strcmp(myname, "vmlinux.o") == 0);
Sam Ravnborg040fcc82006-01-28 22:15:55 +010099}
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101void *do_nofail(void *ptr, const char *expr)
102{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100103 if (!ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 fatal("modpost: Memory allocation failure: %s.\n", expr);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 return ptr;
107}
108
109/* A list of all modules we processed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110static struct module *modules;
111
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100112static struct module *find_module(char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
114 struct module *mod;
115
116 for (mod = modules; mod; mod = mod->next)
117 if (strcmp(mod->name, modname) == 0)
118 break;
119 return mod;
120}
121
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100122static struct module *new_module(char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
124 struct module *mod;
125 char *p, *s;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 mod = NOFAIL(malloc(sizeof(*mod)));
128 memset(mod, 0, sizeof(*mod));
129 p = NOFAIL(strdup(modname));
130
131 /* strip trailing .o */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100132 s = strrchr(p, '.');
133 if (s != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 if (strcmp(s, ".o") == 0)
135 *s = '\0';
136
137 /* add to list */
138 mod->name = p;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200139 mod->gpl_compatible = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 mod->next = modules;
141 modules = mod;
142
143 return mod;
144}
145
146/* A hash of all exported symbols,
147 * struct symbol is also used for lists of unresolved symbols */
148
149#define SYMBOL_HASH_SIZE 1024
150
151struct symbol {
152 struct symbol *next;
153 struct module *module;
154 unsigned int crc;
155 int crc_valid;
156 unsigned int weak:1;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100157 unsigned int vmlinux:1; /* 1 if symbol is defined in vmlinux */
158 unsigned int kernel:1; /* 1 if symbol is from kernel
159 * (only for external modules) **/
Sam Ravnborg8e70c452006-01-28 22:22:33 +0100160 unsigned int preloaded:1; /* 1 if symbol from Module.symvers */
Ram Paibd5cbce2006-06-08 22:12:53 -0700161 enum export export; /* Type of export */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 char name[0];
163};
164
165static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
166
167/* This is based on the hash agorithm from gdbm, via tdb */
168static inline unsigned int tdb_hash(const char *name)
169{
170 unsigned value; /* Used to compute the hash value. */
171 unsigned i; /* Used to cycle through random values. */
172
173 /* Set the initial value from the key size. */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100174 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
176
177 return (1103515243 * value + 12345);
178}
179
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100180/**
181 * Allocate a new symbols for use in the hash of exported symbols or
182 * the list of unresolved symbols per module
183 **/
184static struct symbol *alloc_symbol(const char *name, unsigned int weak,
185 struct symbol *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186{
187 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
188
189 memset(s, 0, sizeof(*s));
190 strcpy(s->name, name);
191 s->weak = weak;
192 s->next = next;
193 return s;
194}
195
196/* For the hash of exported symbols */
Ram Paibd5cbce2006-06-08 22:12:53 -0700197static struct symbol *new_symbol(const char *name, struct module *module,
198 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199{
200 unsigned int hash;
201 struct symbol *new;
202
203 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
204 new = symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
205 new->module = module;
Ram Paibd5cbce2006-06-08 22:12:53 -0700206 new->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100207 return new;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208}
209
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100210static struct symbol *find_symbol(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211{
212 struct symbol *s;
213
214 /* For our purposes, .foo matches foo. PPC64 needs this. */
215 if (name[0] == '.')
216 name++;
217
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100218 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 if (strcmp(s->name, name) == 0)
220 return s;
221 }
222 return NULL;
223}
224
Ram Paibd5cbce2006-06-08 22:12:53 -0700225static struct {
226 const char *str;
227 enum export export;
228} export_list[] = {
229 { .str = "EXPORT_SYMBOL", .export = export_plain },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200230 { .str = "EXPORT_UNUSED_SYMBOL", .export = export_unused },
Ram Paibd5cbce2006-06-08 22:12:53 -0700231 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200232 { .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
Ram Paibd5cbce2006-06-08 22:12:53 -0700233 { .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
234 { .str = "(unknown)", .export = export_unknown },
235};
236
237
238static const char *export_str(enum export ex)
239{
240 return export_list[ex].str;
241}
242
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100243static enum export export_no(const char *s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700244{
245 int i;
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100246
Sam Ravnborg534b89a2006-07-01 10:10:19 +0200247 if (!s)
248 return export_unknown;
Ram Paibd5cbce2006-06-08 22:12:53 -0700249 for (i = 0; export_list[i].export != export_unknown; i++) {
250 if (strcmp(export_list[i].str, s) == 0)
251 return export_list[i].export;
252 }
253 return export_unknown;
254}
255
256static enum export export_from_sec(struct elf_info *elf, Elf_Section sec)
257{
258 if (sec == elf->export_sec)
259 return export_plain;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200260 else if (sec == elf->export_unused_sec)
261 return export_unused;
Ram Paibd5cbce2006-06-08 22:12:53 -0700262 else if (sec == elf->export_gpl_sec)
263 return export_gpl;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200264 else if (sec == elf->export_unused_gpl_sec)
265 return export_unused_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700266 else if (sec == elf->export_gpl_future_sec)
267 return export_gpl_future;
268 else
269 return export_unknown;
270}
271
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100272/**
273 * Add an exported symbol - it may have already been added without a
274 * CRC, in this case just update the CRC
275 **/
Ram Paibd5cbce2006-06-08 22:12:53 -0700276static struct symbol *sym_add_exported(const char *name, struct module *mod,
277 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278{
279 struct symbol *s = find_symbol(name);
280
281 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700282 s = new_symbol(name, mod, export);
Sam Ravnborg8e70c452006-01-28 22:22:33 +0100283 } else {
284 if (!s->preloaded) {
Sam Ravnborg7b75b132006-03-05 13:48:58 +0100285 warn("%s: '%s' exported twice. Previous export "
Sam Ravnborg8e70c452006-01-28 22:22:33 +0100286 "was in %s%s\n", mod->name, name,
287 s->module->name,
288 is_vmlinux(s->module->name) ?"":".ko");
Trent Piepho4b219602007-10-11 16:40:10 -0700289 } else {
290 /* In case Modules.symvers was out of date */
291 s->module = mod;
Sam Ravnborg8e70c452006-01-28 22:22:33 +0100292 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 }
Sam Ravnborg8e70c452006-01-28 22:22:33 +0100294 s->preloaded = 0;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100295 s->vmlinux = is_vmlinux(mod->name);
296 s->kernel = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -0700297 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100298 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299}
300
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100301static void sym_update_crc(const char *name, struct module *mod,
Ram Paibd5cbce2006-06-08 22:12:53 -0700302 unsigned int crc, enum export export)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100303{
304 struct symbol *s = find_symbol(name);
305
306 if (!s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700307 s = new_symbol(name, mod, export);
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100308 s->crc = crc;
309 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310}
311
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100312void *grab_file(const char *filename, unsigned long *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313{
314 struct stat st;
315 void *map;
316 int fd;
317
318 fd = open(filename, O_RDONLY);
319 if (fd < 0 || fstat(fd, &st) != 0)
320 return NULL;
321
322 *size = st.st_size;
323 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
324 close(fd);
325
326 if (map == MAP_FAILED)
327 return NULL;
328 return map;
329}
330
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100331/**
332 * Return a copy of the next line in a mmap'ed file.
333 * spaces in the beginning of the line is trimmed away.
334 * Return a pointer to a static buffer.
335 **/
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100336char *get_next_line(unsigned long *pos, void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
338 static char line[4096];
339 int skip = 1;
340 size_t len = 0;
341 signed char *p = (signed char *)file + *pos;
342 char *s = line;
343
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100344 for (; *pos < size ; (*pos)++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 if (skip && isspace(*p)) {
346 p++;
347 continue;
348 }
349 skip = 0;
350 if (*p != '\n' && (*pos < size)) {
351 len++;
352 *s++ = *p++;
353 if (len > 4095)
354 break; /* Too long, stop */
355 } else {
356 /* End of string */
357 *s = '\0';
358 return line;
359 }
360 }
361 /* End of buffer */
362 return NULL;
363}
364
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100365void release_file(void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366{
367 munmap(file, size);
368}
369
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100370static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371{
372 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100373 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 Elf_Shdr *sechdrs;
375 Elf_Sym *sym;
376
377 hdr = grab_file(filename, &info->size);
378 if (!hdr) {
379 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200380 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 }
382 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100383 if (info->size < sizeof(*hdr)) {
384 /* file too small, assume this is an empty .o file */
385 return 0;
386 }
387 /* Is this a valid ELF file? */
388 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
389 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
390 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
391 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
392 /* Not an ELF file - silently ignore it */
393 return 0;
394 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200396 hdr->e_type = TO_NATIVE(hdr->e_type);
397 hdr->e_machine = TO_NATIVE(hdr->e_machine);
398 hdr->e_version = TO_NATIVE(hdr->e_version);
399 hdr->e_entry = TO_NATIVE(hdr->e_entry);
400 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
401 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
402 hdr->e_flags = TO_NATIVE(hdr->e_flags);
403 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
404 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
405 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
406 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
407 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
408 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 sechdrs = (void *)hdr + hdr->e_shoff;
410 info->sechdrs = sechdrs;
411
Petr Stetiara83710e2007-08-27 12:15:07 +0200412 /* Check if file offset is correct */
413 if (hdr->e_shoff > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100414 fatal("section header offset=%lu in file '%s' is bigger than "
415 "filesize=%lu\n", (unsigned long)hdr->e_shoff,
416 filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200417 return 0;
418 }
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 /* Fix endianness in section headers */
421 for (i = 0; i < hdr->e_shnum; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200422 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
423 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
424 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
425 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
426 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
427 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
428 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
429 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
430 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
431 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 }
433 /* Find symbol table. */
434 for (i = 1; i < hdr->e_shnum; i++) {
435 const char *secstrings
436 = (void *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
Ram Paibd5cbce2006-06-08 22:12:53 -0700437 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900438 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
Tejun Heo56fc82c2009-02-06 00:48:02 +0900440 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100441 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
442 "sizeof(*hrd)=%zu\n", filename,
443 (unsigned long)sechdrs[i].sh_offset,
444 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100445 return 0;
446 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700447 secname = secstrings + sechdrs[i].sh_name;
448 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900449 if (nobits)
450 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
452 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700453 } else if (strcmp(secname, "__ksymtab") == 0)
454 info->export_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200455 else if (strcmp(secname, "__ksymtab_unused") == 0)
456 info->export_unused_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700457 else if (strcmp(secname, "__ksymtab_gpl") == 0)
458 info->export_gpl_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200459 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
460 info->export_unused_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700461 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
462 info->export_gpl_future_sec = i;
463
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 if (sechdrs[i].sh_type != SHT_SYMTAB)
465 continue;
466
467 info->symtab_start = (void *)hdr + sechdrs[i].sh_offset;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100468 info->symtab_stop = (void *)hdr + sechdrs[i].sh_offset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 + sechdrs[i].sh_size;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100470 info->strtab = (void *)hdr +
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 sechdrs[sechdrs[i].sh_link].sh_offset;
472 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100473 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100474 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 /* Fix endianness in symbols */
477 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
478 sym->st_shndx = TO_NATIVE(sym->st_shndx);
479 sym->st_name = TO_NATIVE(sym->st_name);
480 sym->st_value = TO_NATIVE(sym->st_value);
481 sym->st_size = TO_NATIVE(sym->st_size);
482 }
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100483 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484}
485
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100486static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487{
488 release_file(info->hdr, info->size);
489}
490
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200491static int ignore_undef_symbol(struct elf_info *info, const char *symname)
492{
493 /* ignore __this_module, it will be resolved shortly */
494 if (strcmp(symname, MODULE_SYMBOL_PREFIX "__this_module") == 0)
495 return 1;
496 /* ignore global offset table */
497 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
498 return 1;
499 if (info->hdr->e_machine == EM_PPC)
500 /* Special register function linked on all modules during final link of .ko */
501 if (strncmp(symname, "_restgpr_", sizeof("_restgpr_") - 1) == 0 ||
502 strncmp(symname, "_savegpr_", sizeof("_savegpr_") - 1) == 0 ||
503 strncmp(symname, "_rest32gpr_", sizeof("_rest32gpr_") - 1) == 0 ||
504 strncmp(symname, "_save32gpr_", sizeof("_save32gpr_") - 1) == 0)
505 return 1;
506 /* Do not ignore this symbol */
507 return 0;
508}
509
Luke Yangf7b05e62006-03-02 18:35:31 +0800510#define CRC_PFX MODULE_SYMBOL_PREFIX "__crc_"
511#define KSYMTAB_PFX MODULE_SYMBOL_PREFIX "__ksymtab_"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100513static void handle_modversions(struct module *mod, struct elf_info *info,
514 Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515{
516 unsigned int crc;
Ram Paibd5cbce2006-06-08 22:12:53 -0700517 enum export export = export_from_sec(info, sym->st_shndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519 switch (sym->st_shndx) {
520 case SHN_COMMON:
Sam Ravnborgcb805142006-01-28 16:57:26 +0100521 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 break;
523 case SHN_ABS:
524 /* CRC'd symbol */
Michal Marek8d995132009-12-12 12:02:24 +0100525 if (strncmp(symname, CRC_PFX, strlen(CRC_PFX)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 crc = (unsigned int) sym->st_value;
Ram Paibd5cbce2006-06-08 22:12:53 -0700527 sym_update_crc(symname + strlen(CRC_PFX), mod, crc,
528 export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 }
530 break;
531 case SHN_UNDEF:
532 /* undefined symbol */
533 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
534 ELF_ST_BIND(sym->st_info) != STB_WEAK)
535 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200536 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 break;
Ben Colline8d529012005-08-19 13:44:57 -0700538/* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
539#if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
540/* add compatibility with older glibc */
541#ifndef STT_SPARC_REGISTER
542#define STT_SPARC_REGISTER STT_REGISTER
543#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 if (info->hdr->e_machine == EM_SPARC ||
545 info->hdr->e_machine == EM_SPARCV9) {
546 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700547 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100549 if (symname[0] == '.') {
550 char *munged = strdup(symname);
551 munged[0] = '_';
552 munged[1] = toupper(munged[1]);
553 symname = munged;
554 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 }
556#endif
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100557
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 if (memcmp(symname, MODULE_SYMBOL_PREFIX,
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100559 strlen(MODULE_SYMBOL_PREFIX)) == 0) {
560 mod->unres =
561 alloc_symbol(symname +
562 strlen(MODULE_SYMBOL_PREFIX),
563 ELF_ST_BIND(sym->st_info) == STB_WEAK,
564 mod->unres);
565 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 break;
567 default:
568 /* All exported symbols */
Michal Marek8d995132009-12-12 12:02:24 +0100569 if (strncmp(symname, KSYMTAB_PFX, strlen(KSYMTAB_PFX)) == 0) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700570 sym_add_exported(symname + strlen(KSYMTAB_PFX), mod,
571 export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 }
573 if (strcmp(symname, MODULE_SYMBOL_PREFIX "init_module") == 0)
574 mod->has_init = 1;
575 if (strcmp(symname, MODULE_SYMBOL_PREFIX "cleanup_module") == 0)
576 mod->has_cleanup = 1;
577 break;
578 }
579}
580
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100581/**
582 * Parse tag=value strings from .modinfo section
583 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584static char *next_string(char *string, unsigned long *secsize)
585{
586 /* Skip non-zero chars */
587 while (string[0]) {
588 string++;
589 if ((*secsize)-- <= 1)
590 return NULL;
591 }
592
593 /* Skip any zero padding. */
594 while (!string[0]) {
595 string++;
596 if ((*secsize)-- <= 1)
597 return NULL;
598 }
599 return string;
600}
601
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200602static char *get_next_modinfo(void *modinfo, unsigned long modinfo_len,
603 const char *tag, char *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604{
605 char *p;
606 unsigned int taglen = strlen(tag);
607 unsigned long size = modinfo_len;
608
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200609 if (info) {
610 size -= info - (char *)modinfo;
611 modinfo = next_string(info, &size);
612 }
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 for (p = modinfo; p; p = next_string(p, &size)) {
615 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
616 return p + taglen + 1;
617 }
618 return NULL;
619}
620
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200621static char *get_modinfo(void *modinfo, unsigned long modinfo_len,
622 const char *tag)
623
624{
625 return get_next_modinfo(modinfo, modinfo_len, tag, NULL);
626}
627
Sam Ravnborg93684d32006-02-19 11:53:35 +0100628/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100629 * Test if string s ends in string sub
630 * return 0 if match
631 **/
632static int strrcmp(const char *s, const char *sub)
633{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100634 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100635
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100636 if (!s || !sub)
637 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100638
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100639 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100640 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100641
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100642 if ((slen == 0) || (sublen == 0))
643 return 1;
644
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100645 if (sublen > slen)
646 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100647
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100648 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100649}
650
Sam Ravnborgff13f922008-01-23 19:54:27 +0100651static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
652{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100653 if (sym)
654 return elf->strtab + sym->st_name;
655 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100656 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100657}
658
659static const char *sec_name(struct elf_info *elf, int shndx)
660{
661 Elf_Shdr *sechdrs = elf->sechdrs;
662 return (void *)elf->hdr +
663 elf->sechdrs[elf->hdr->e_shstrndx].sh_offset +
664 sechdrs[shndx].sh_name;
665}
666
667static const char *sech_name(struct elf_info *elf, Elf_Shdr *sechdr)
668{
669 return (void *)elf->hdr +
670 elf->sechdrs[elf->hdr->e_shstrndx].sh_offset +
671 sechdr->sh_name;
672}
673
Sam Ravnborg10668222008-01-13 22:21:31 +0100674/* if sym is empty or point to a string
675 * like ".[0-9]+" then return 1.
676 * This is the optional prefix added by ld to some sections
677 */
678static int number_prefix(const char *sym)
679{
680 if (*sym++ == '\0')
681 return 1;
682 if (*sym != '.')
683 return 0;
684 do {
685 char c = *sym++;
686 if (c < '0' || c > '9')
687 return 0;
688 } while (*sym);
689 return 1;
690}
691
692/* The pattern is an array of simple patterns.
693 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100694 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100695 * "foo*" will match a string that begins with "foo"
696 * "foo$" will match a string equal to "foo" or "foo.1"
697 * where the '1' can be any number including several digits.
698 * The $ syntax is for sections where ld append a dot number
699 * to make section name unique.
700 */
Trevor Keith5c725132009-09-22 16:43:38 -0700701static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100702{
703 const char *p;
704 while (*pat) {
705 p = *pat++;
706 const char *endp = p + strlen(p) - 1;
707
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100708 /* "*foo" */
709 if (*p == '*') {
710 if (strrcmp(sym, p + 1) == 0)
711 return 1;
712 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100713 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100714 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100715 if (strncmp(sym, p, strlen(p) - 1) == 0)
716 return 1;
717 }
718 /* "foo$" */
719 else if (*endp == '$') {
720 if (strncmp(sym, p, strlen(p) - 1) == 0) {
721 if (number_prefix(sym + strlen(p) - 1))
722 return 1;
723 }
724 }
725 /* no wildcards */
726 else {
727 if (strcmp(p, sym) == 0)
728 return 1;
729 }
730 }
731 /* no match */
732 return 0;
733}
734
Sam Ravnborg10668222008-01-13 22:21:31 +0100735/* sections that we do not want to do full section mismatch check on */
736static const char *section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200737{
738 ".comment*",
739 ".debug*",
740 ".mdebug*", /* alpha, score, mips etc. */
741 ".pdr", /* alpha, score, mips etc. */
742 ".stab*",
743 ".note*",
744 ".got*",
745 ".toc*",
746 NULL
747};
Sam Ravnborg10668222008-01-13 22:21:31 +0100748
Sam Ravnborge241a632008-01-28 20:13:13 +0100749/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400750 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100751 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400752 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100753 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400754static void check_section(const char *modname, struct elf_info *elf,
755 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100756{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400757 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100758
Anders Kaseorgb614a692009-04-23 16:49:33 -0400759 if (sechdr->sh_type == SHT_PROGBITS &&
760 !(sechdr->sh_flags & SHF_ALLOC) &&
761 !match(sec, section_white_list)) {
762 warn("%s (%s): unexpected non-allocatable section.\n"
763 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
764 "Note that for example <linux/init.h> contains\n"
765 "section definitions for use in .S files.\n\n",
766 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100767 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100768}
769
770
771
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100772#define ALL_INIT_DATA_SECTIONS \
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000773 ".init.setup$", ".init.rodata$", \
774 ".devinit.rodata$", ".cpuinit.rodata$", ".meminit.rodata$" \
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100775 ".init.data$", ".devinit.data$", ".cpuinit.data$", ".meminit.data$"
776#define ALL_EXIT_DATA_SECTIONS \
777 ".exit.data$", ".devexit.data$", ".cpuexit.data$", ".memexit.data$"
Sam Ravnborg10668222008-01-13 22:21:31 +0100778
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100779#define ALL_INIT_TEXT_SECTIONS \
780 ".init.text$", ".devinit.text$", ".cpuinit.text$", ".meminit.text$"
781#define ALL_EXIT_TEXT_SECTIONS \
782 ".exit.text$", ".devexit.text$", ".cpuexit.text$", ".memexit.text$"
Sam Ravnborg10668222008-01-13 22:21:31 +0100783
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100784#define ALL_XXXINIT_SECTIONS DEV_INIT_SECTIONS, CPU_INIT_SECTIONS, \
785 MEM_INIT_SECTIONS
786#define ALL_XXXEXIT_SECTIONS DEV_EXIT_SECTIONS, CPU_EXIT_SECTIONS, \
787 MEM_EXIT_SECTIONS
788
789#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
790#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100791
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100792#define DATA_SECTIONS ".data$", ".data.rel$"
Sam Ravnborg10668222008-01-13 22:21:31 +0100793#define TEXT_SECTIONS ".text$"
794
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000795#define INIT_SECTIONS ".init.*"
796#define DEV_INIT_SECTIONS ".devinit.*"
797#define CPU_INIT_SECTIONS ".cpuinit.*"
798#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100799
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000800#define EXIT_SECTIONS ".exit.*"
801#define DEV_EXIT_SECTIONS ".devexit.*"
802#define CPU_EXIT_SECTIONS ".cpuexit.*"
803#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100804
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100805/* init data sections */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100806static const char *init_data_sections[] = { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100807
808/* all init sections */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100809static const char *init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100810
811/* All init and exit sections (code + data) */
812static const char *init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100813 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100814
815/* data section */
816static const char *data_sections[] = { DATA_SECTIONS, NULL };
817
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100818
819/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100820#define DEFAULT_SYMBOL_WHITE_LIST \
821 "*driver", \
822 "*_template", /* scsi uses *_template a lot */ \
823 "*_timer", /* arm uses ops structures named _timer a lot */ \
824 "*_sht", /* scsi also used *_sht to some extent */ \
825 "*_ops", \
826 "*_probe", \
827 "*_probe_one", \
828 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100829
830static const char *head_sections[] = { ".head.text*", NULL };
831static const char *linker_symbols[] =
832 { "__init_begin", "_sinittext", "_einittext", NULL };
833
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100834enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100835 TEXT_TO_ANY_INIT,
836 DATA_TO_ANY_INIT,
837 TEXT_TO_ANY_EXIT,
838 DATA_TO_ANY_EXIT,
839 XXXINIT_TO_SOME_INIT,
840 XXXEXIT_TO_SOME_EXIT,
841 ANY_INIT_TO_ANY_EXIT,
842 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100843 EXPORT_TO_INIT_EXIT,
844};
845
Sam Ravnborg10668222008-01-13 22:21:31 +0100846struct sectioncheck {
847 const char *fromsec[20];
848 const char *tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100849 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100850 const char *symbol_white_list[20];
Sam Ravnborg10668222008-01-13 22:21:31 +0100851};
852
853const struct sectioncheck sectioncheck[] = {
854/* Do not reference init/exit code/data from
855 * normal code and data
856 */
857{
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100858 .fromsec = { TEXT_SECTIONS, NULL },
859 .tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100860 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100861 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100862},
863{
864 .fromsec = { DATA_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +0100865 .tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100866 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100867 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100868},
869{
Uwe Kleine-König0db252452010-01-30 21:14:23 +0100870 .fromsec = { DATA_SECTIONS, NULL },
871 .tosec = { INIT_SECTIONS, NULL },
872 .mismatch = DATA_TO_ANY_INIT,
873 .symbol_white_list = {
874 "*_template", "*_timer", "*_sht", "*_ops",
875 "*_probe", "*_probe_one", "*_console", NULL
876 },
877},
878{
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100879 .fromsec = { TEXT_SECTIONS, NULL },
880 .tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100881 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100882 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100883},
884{
885 .fromsec = { DATA_SECTIONS, NULL },
886 .tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100887 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100888 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100889},
890/* Do not reference init code/data from devinit/cpuinit/meminit code/data */
891{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100892 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100893 .tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100894 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100895 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100896},
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000897/* Do not reference cpuinit code/data from meminit code/data */
898{
899 .fromsec = { MEM_INIT_SECTIONS, NULL },
900 .tosec = { CPU_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100901 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100902 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000903},
904/* Do not reference meminit code/data from cpuinit code/data */
905{
906 .fromsec = { CPU_INIT_SECTIONS, NULL },
907 .tosec = { MEM_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100908 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100909 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000910},
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100911/* Do not reference exit code/data from devexit/cpuexit/memexit code/data */
912{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100913 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100914 .tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100915 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100916 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +0100917},
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000918/* Do not reference cpuexit code/data from memexit code/data */
919{
920 .fromsec = { MEM_EXIT_SECTIONS, NULL },
921 .tosec = { CPU_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100922 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100923 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000924},
925/* Do not reference memexit code/data from cpuexit code/data */
926{
927 .fromsec = { CPU_EXIT_SECTIONS, NULL },
928 .tosec = { MEM_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100929 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100930 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000931},
Sam Ravnborg10668222008-01-13 22:21:31 +0100932/* Do not use exit code/data from init code */
933{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100934 .fromsec = { ALL_INIT_SECTIONS, NULL },
935 .tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100936 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100937 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +0100938},
939/* Do not use init code/data from exit code */
940{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100941 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100942 .tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100943 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100944 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +0100945},
946/* Do not export init/exit functions or data */
947{
948 .fromsec = { "__ksymtab*", NULL },
Sam Ravnborgfa95eb12008-02-02 23:30:22 +0100949 .tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100950 .mismatch = EXPORT_TO_INIT_EXIT,
951 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +0100952}
953};
954
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +0100955static const struct sectioncheck *section_mismatch(
956 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +0100957{
958 int i;
959 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
960 const struct sectioncheck *check = &sectioncheck[0];
961
962 for (i = 0; i < elems; i++) {
963 if (match(fromsec, check->fromsec) &&
964 match(tosec, check->tosec))
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +0100965 return check;
Sam Ravnborg10668222008-01-13 22:21:31 +0100966 check++;
967 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +0100968 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +0100969}
970
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100971/**
972 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +0200973 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100974 * Pattern 1:
975 * If a module parameter is declared __initdata and permissions=0
976 * then this is legal despite the warning generated.
977 * We cannot see value of permissions here, so just ignore
978 * this pattern.
979 * The pattern is identified by:
980 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +0100981 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100982 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100983 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100984 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -0700985 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100986 * add, remove, probe functions etc.
Uwe Kleine-Königb75dcab2010-01-29 11:40:38 +0100987 * These functions may often be marked __devinit and we do not want to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100988 * warn here.
989 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +0200990 * tosec = init or exit section
991 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100992 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
993 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +0100994 *
995 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +0200996 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +0100997 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +0200998 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +0100999 * Some symbols belong to init section but still it is ok to reference
1000 * these from non-init sections as these symbols don't have any memory
1001 * allocated for them and symbol address and value are same. So even
1002 * if init section is freed, its ok to reference those symbols.
1003 * For ex. symbols marking the init section boundaries.
1004 * This pattern is identified by
1005 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001006 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001007 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001008static int secref_whitelist(const struct sectioncheck *mismatch,
1009 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001010 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001011{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001012 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001013 if (match(tosec, init_data_sections) &&
1014 match(fromsec, data_sections) &&
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001015 (strncmp(fromsym, "__param", strlen("__param")) == 0))
1016 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001017
1018 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001019 if (match(tosec, init_exit_sections) &&
1020 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001021 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001022 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001023
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001024 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001025 if (match(fromsec, head_sections) &&
1026 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001027 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001028
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001029 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001030 if (match(tosym, linker_symbols))
1031 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001032
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001033 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001034}
1035
1036/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001037 * Find symbol based on relocation record info.
1038 * In some cases the symbol supplied is a valid symbol so
1039 * return refsym. If st_name != 0 we assume this is a valid symbol.
1040 * In other cases the symbol needs to be looked up in the symbol table
1041 * based on section and address.
1042 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001043static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001044 Elf_Sym *relsym)
1045{
1046 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001047 Elf_Sym *near = NULL;
1048 Elf64_Sword distance = 20;
1049 Elf64_Sword d;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001050
1051 if (relsym->st_name != 0)
1052 return relsym;
1053 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1054 if (sym->st_shndx != relsym->st_shndx)
1055 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001056 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1057 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001058 if (sym->st_value == addr)
1059 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001060 /* Find a symbol nearby - addr are maybe negative */
1061 d = sym->st_value - addr;
1062 if (d < 0)
1063 d = addr - sym->st_value;
1064 if (d < distance) {
1065 distance = d;
1066 near = sym;
1067 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001068 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001069 /* We need a close match */
1070 if (distance < 20)
1071 return near;
1072 else
1073 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001074}
1075
David Brownellda68d612007-02-20 13:58:16 -08001076static inline int is_arm_mapping_symbol(const char *str)
1077{
1078 return str[0] == '$' && strchr("atd", str[1])
1079 && (str[2] == '\0' || str[2] == '.');
1080}
1081
1082/*
1083 * If there's no name there, ignore it; likewise, ignore it if it's
1084 * one of the magic symbols emitted used by current ARM tools.
1085 *
1086 * Otherwise if find_symbols_between() returns those symbols, they'll
1087 * fail the whitelist tests and cause lots of false alarms ... fixable
1088 * only by merging __exit and __init sections into __text, bloating
1089 * the kernel (which is especially evil on embedded platforms).
1090 */
1091static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1092{
1093 const char *name = elf->strtab + sym->st_name;
1094
1095 if (!name || !strlen(name))
1096 return 0;
1097 return !is_arm_mapping_symbol(name);
1098}
1099
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001100/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001101 * Find symbols before or equal addr and after addr - in the section sec.
1102 * If we find two symbols with equal offset prefer one with a valid name.
1103 * The ELF format may have a better way to detect what type of symbol
1104 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001105 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001106static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1107 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001108{
1109 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001110 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001111 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001112
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001113 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1114 const char *symsec;
1115
1116 if (sym->st_shndx >= SHN_LORESERVE)
1117 continue;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001118 symsec = sec_name(elf, sym->st_shndx);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001119 if (strcmp(symsec, sec) != 0)
1120 continue;
David Brownellda68d612007-02-20 13:58:16 -08001121 if (!is_valid_name(elf, sym))
1122 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001123 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001124 if ((addr - sym->st_value) < distance) {
1125 distance = addr - sym->st_value;
1126 near = sym;
1127 } else if ((addr - sym->st_value) == distance) {
1128 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001129 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001130 }
1131 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001132 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001133}
1134
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001135/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001136 * Convert a section name to the function/data attribute
1137 * .init.text => __init
1138 * .cpuinit.data => __cpudata
1139 * .memexitconst => __memconst
1140 * etc.
1141*/
1142static char *sec2annotation(const char *s)
1143{
1144 if (match(s, init_exit_sections)) {
1145 char *p = malloc(20);
1146 char *r = p;
1147
1148 *p++ = '_';
1149 *p++ = '_';
1150 if (*s == '.')
1151 s++;
1152 while (*s && *s != '.')
1153 *p++ = *s++;
1154 *p = '\0';
1155 if (*s == '.')
1156 s++;
1157 if (strstr(s, "rodata") != NULL)
1158 strcat(p, "const ");
1159 else if (strstr(s, "data") != NULL)
1160 strcat(p, "data ");
1161 else
1162 strcat(p, " ");
1163 return r; /* we leak her but we do not care */
1164 } else {
1165 return "";
1166 }
1167}
1168
1169static int is_function(Elf_Sym *sym)
1170{
1171 if (sym)
1172 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1173 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001174 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001175}
1176
1177/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001178 * Print a warning about a section mismatch.
1179 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001180 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001181 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001182static void report_sec_mismatch(const char *modname,
1183 const struct sectioncheck *mismatch,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001184 const char *fromsec,
1185 unsigned long long fromaddr,
1186 const char *fromsym,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001187 int from_is_func,
1188 const char *tosec, const char *tosym,
1189 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001190{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001191 const char *from, *from_p;
1192 const char *to, *to_p;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001193
1194 switch (from_is_func) {
1195 case 0: from = "variable"; from_p = ""; break;
1196 case 1: from = "function"; from_p = "()"; break;
1197 default: from = "(unknown reference)"; from_p = ""; break;
1198 }
1199 switch (to_is_func) {
1200 case 0: to = "variable"; to_p = ""; break;
1201 case 1: to = "function"; to_p = "()"; break;
1202 default: to = "(unknown reference)"; to_p = ""; break;
1203 }
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001204
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001205 sec_mismatch_count++;
1206 if (!sec_mismatch_verbose)
1207 return;
1208
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001209 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1210 "to the %s %s:%s%s\n",
1211 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1212 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001213
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001214 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001215 case TEXT_TO_ANY_INIT:
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001216 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001217 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001218 "the %s %s%s%s.\n"
1219 "This is often because %s lacks a %s\n"
1220 "annotation or the annotation of %s is wrong.\n",
1221 sec2annotation(fromsec), fromsym,
1222 to, sec2annotation(tosec), tosym, to_p,
1223 fromsym, sec2annotation(tosec), tosym);
1224 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001225 case DATA_TO_ANY_INIT: {
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001226 const char *const *s = mismatch->symbol_white_list;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001227 fprintf(stderr,
1228 "The variable %s references\n"
1229 "the %s %s%s%s\n"
1230 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001231 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001232 "or name the variable:\n",
1233 fromsym, to, sec2annotation(tosec), tosym, to_p);
1234 while (*s)
1235 fprintf(stderr, "%s, ", *s++);
1236 fprintf(stderr, "\n");
1237 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001238 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001239 case TEXT_TO_ANY_EXIT:
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001240 fprintf(stderr,
1241 "The function %s() references a %s in an exit section.\n"
1242 "Often the %s %s%s has valid usage outside the exit section\n"
1243 "and the fix is to remove the %sannotation of %s.\n",
1244 fromsym, to, to, tosym, to_p, sec2annotation(tosec), tosym);
1245 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001246 case DATA_TO_ANY_EXIT: {
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001247 const char *const *s = mismatch->symbol_white_list;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001248 fprintf(stderr,
1249 "The variable %s references\n"
1250 "the %s %s%s%s\n"
1251 "If the reference is valid then annotate the\n"
1252 "variable with __exit* (see linux/init.h) or "
1253 "name the variable:\n",
1254 fromsym, to, sec2annotation(tosec), tosym, to_p);
1255 while (*s)
1256 fprintf(stderr, "%s, ", *s++);
1257 fprintf(stderr, "\n");
1258 break;
1259 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001260 case XXXINIT_TO_SOME_INIT:
1261 case XXXEXIT_TO_SOME_EXIT:
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001262 fprintf(stderr,
1263 "The %s %s%s%s references\n"
1264 "a %s %s%s%s.\n"
1265 "If %s is only used by %s then\n"
1266 "annotate %s with a matching annotation.\n",
1267 from, sec2annotation(fromsec), fromsym, from_p,
1268 to, sec2annotation(tosec), tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001269 tosym, fromsym, tosym);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001270 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001271 case ANY_INIT_TO_ANY_EXIT:
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001272 fprintf(stderr,
1273 "The %s %s%s%s references\n"
1274 "a %s %s%s%s.\n"
1275 "This is often seen when error handling "
1276 "in the init function\n"
1277 "uses functionality in the exit path.\n"
1278 "The fix is often to remove the %sannotation of\n"
1279 "%s%s so it may be used outside an exit section.\n",
1280 from, sec2annotation(fromsec), fromsym, from_p,
1281 to, sec2annotation(tosec), tosym, to_p,
1282 sec2annotation(tosec), tosym, to_p);
1283 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001284 case ANY_EXIT_TO_ANY_INIT:
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001285 fprintf(stderr,
1286 "The %s %s%s%s references\n"
1287 "a %s %s%s%s.\n"
1288 "This is often seen when error handling "
1289 "in the exit function\n"
1290 "uses functionality in the init path.\n"
1291 "The fix is often to remove the %sannotation of\n"
1292 "%s%s so it may be used outside an init section.\n",
1293 from, sec2annotation(fromsec), fromsym, from_p,
1294 to, sec2annotation(tosec), tosym, to_p,
1295 sec2annotation(tosec), tosym, to_p);
1296 break;
1297 case EXPORT_TO_INIT_EXIT:
1298 fprintf(stderr,
1299 "The symbol %s is exported and annotated %s\n"
1300 "Fix this by removing the %sannotation of %s "
1301 "or drop the export.\n",
1302 tosym, sec2annotation(tosec), sec2annotation(tosec), tosym);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001303 break;
1304 }
1305 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001306}
1307
1308static void check_section_mismatch(const char *modname, struct elf_info *elf,
1309 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1310{
1311 const char *tosec;
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001312 const struct sectioncheck *mismatch;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001313
1314 tosec = sec_name(elf, sym->st_shndx);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001315 mismatch = section_mismatch(fromsec, tosec);
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001316 if (mismatch) {
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001317 Elf_Sym *to;
1318 Elf_Sym *from;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001319 const char *tosym;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001320 const char *fromsym;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001321
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001322 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1323 fromsym = sym_name(elf, from);
1324 to = find_elf_symbol(elf, r->r_addend, sym);
1325 tosym = sym_name(elf, to);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001326
1327 /* check whitelist - we may ignore it */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001328 if (secref_whitelist(mismatch,
1329 fromsec, fromsym, tosec, tosym)) {
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001330 report_sec_mismatch(modname, mismatch,
1331 fromsec, r->r_offset, fromsym,
1332 is_function(from), tosec, tosym,
1333 is_function(to));
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001334 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001335 }
1336}
1337
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001338static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001339 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001340{
1341 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001342 int section = sechdr->sh_info;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001343
1344 return (void *)elf->hdr + sechdrs[section].sh_offset +
1345 (r->r_offset - sechdrs[section].sh_addr);
1346}
1347
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001348static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001349{
1350 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001351 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001352
1353 switch (r_typ) {
1354 case R_386_32:
1355 r->r_addend = TO_NATIVE(*location);
1356 break;
1357 case R_386_PC32:
1358 r->r_addend = TO_NATIVE(*location) + 4;
1359 /* For CONFIG_RELOCATABLE=y */
1360 if (elf->hdr->e_type == ET_EXEC)
1361 r->r_addend += r->r_offset;
1362 break;
1363 }
1364 return 0;
1365}
1366
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001367static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001368{
1369 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1370
1371 switch (r_typ) {
1372 case R_ARM_ABS32:
1373 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001374 r->r_addend = (int)(long)
1375 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001376 break;
1377 case R_ARM_PC24:
1378 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001379 r->r_addend = (int)(long)(elf->hdr +
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001380 sechdr->sh_offset +
1381 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001382 break;
1383 default:
1384 return 1;
1385 }
1386 return 0;
1387}
1388
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001389static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001390{
1391 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001392 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001393 unsigned int inst;
1394
1395 if (r_typ == R_MIPS_HI16)
1396 return 1; /* skip this */
1397 inst = TO_NATIVE(*location);
1398 switch (r_typ) {
1399 case R_MIPS_LO16:
1400 r->r_addend = inst & 0xffff;
1401 break;
1402 case R_MIPS_26:
1403 r->r_addend = (inst & 0x03ffffff) << 2;
1404 break;
1405 case R_MIPS_32:
1406 r->r_addend = inst;
1407 break;
1408 }
1409 return 0;
1410}
1411
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001412static void section_rela(const char *modname, struct elf_info *elf,
Sam Ravnborg10668222008-01-13 22:21:31 +01001413 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001414{
1415 Elf_Sym *sym;
1416 Elf_Rela *rela;
1417 Elf_Rela r;
1418 unsigned int r_sym;
1419 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001420
Sam Ravnborgff13f922008-01-23 19:54:27 +01001421 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001422 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1423
Sam Ravnborgff13f922008-01-23 19:54:27 +01001424 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001425 fromsec += strlen(".rela");
1426 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001427 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001428 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001429
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001430 for (rela = start; rela < stop; rela++) {
1431 r.r_offset = TO_NATIVE(rela->r_offset);
1432#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001433 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001434 unsigned int r_typ;
1435 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1436 r_sym = TO_NATIVE(r_sym);
1437 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1438 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1439 } else {
1440 r.r_info = TO_NATIVE(rela->r_info);
1441 r_sym = ELF_R_SYM(r.r_info);
1442 }
1443#else
1444 r.r_info = TO_NATIVE(rela->r_info);
1445 r_sym = ELF_R_SYM(r.r_info);
1446#endif
1447 r.r_addend = TO_NATIVE(rela->r_addend);
1448 sym = elf->symtab_start + r_sym;
1449 /* Skip special sections */
1450 if (sym->st_shndx >= SHN_LORESERVE)
1451 continue;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001452 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001453 }
1454}
1455
1456static void section_rel(const char *modname, struct elf_info *elf,
Sam Ravnborg10668222008-01-13 22:21:31 +01001457 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001458{
1459 Elf_Sym *sym;
1460 Elf_Rel *rel;
1461 Elf_Rela r;
1462 unsigned int r_sym;
1463 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001464
Sam Ravnborgff13f922008-01-23 19:54:27 +01001465 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001466 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1467
Sam Ravnborgff13f922008-01-23 19:54:27 +01001468 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001469 fromsec += strlen(".rel");
1470 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001471 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001472 return;
1473
1474 for (rel = start; rel < stop; rel++) {
1475 r.r_offset = TO_NATIVE(rel->r_offset);
1476#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001477 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001478 unsigned int r_typ;
1479 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1480 r_sym = TO_NATIVE(r_sym);
1481 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1482 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1483 } else {
1484 r.r_info = TO_NATIVE(rel->r_info);
1485 r_sym = ELF_R_SYM(r.r_info);
1486 }
1487#else
1488 r.r_info = TO_NATIVE(rel->r_info);
1489 r_sym = ELF_R_SYM(r.r_info);
1490#endif
1491 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001492 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001493 case EM_386:
1494 if (addend_386_rel(elf, sechdr, &r))
1495 continue;
1496 break;
1497 case EM_ARM:
1498 if (addend_arm_rel(elf, sechdr, &r))
1499 continue;
1500 break;
1501 case EM_MIPS:
1502 if (addend_mips_rel(elf, sechdr, &r))
1503 continue;
1504 break;
1505 }
1506 sym = elf->symtab_start + r_sym;
1507 /* Skip special sections */
1508 if (sym->st_shndx >= SHN_LORESERVE)
1509 continue;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001510 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001511 }
1512}
1513
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001514/**
1515 * A module includes a number of sections that are discarded
1516 * either when loaded or when used as built-in.
1517 * For loaded modules all functions marked __init and all data
1518 * marked __initdata will be discarded when the module has been intialized.
1519 * Likewise for modules used built-in the sections marked __exit
1520 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001521 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001522 * The check_sec_ref() function traverses all relocation records
1523 * to find all references to a section that reference a section that will
1524 * be discarded and warns about it.
1525 **/
1526static void check_sec_ref(struct module *mod, const char *modname,
Sam Ravnborg10668222008-01-13 22:21:31 +01001527 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001528{
1529 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001530 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001531
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001532 /* Walk through all sections */
Sam Ravnborgff13f922008-01-23 19:54:27 +01001533 for (i = 0; i < elf->hdr->e_shnum; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001534 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001535 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001536 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001537 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001538 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001539 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001540 }
1541}
1542
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001543static void read_symbols(char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544{
1545 const char *symname;
1546 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001547 char *license;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 struct module *mod;
1549 struct elf_info info = { };
1550 Elf_Sym *sym;
1551
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01001552 if (!parse_elf(&info, modname))
1553 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554
1555 mod = new_module(modname);
1556
1557 /* When there's no vmlinux, don't print warnings about
1558 * unresolved symbols (since there'll be too many ;) */
1559 if (is_vmlinux(modname)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 have_vmlinux = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 mod->skip = 1;
1562 }
1563
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001564 license = get_modinfo(info.modinfo, info.modinfo_len, "license");
Sam Ravnborg2fa36562008-04-26 21:07:26 +02001565 if (info.modinfo && !license && !is_vmlinux(modname))
1566 warn("modpost: missing MODULE_LICENSE() in %s\n"
1567 "see include/linux/module.h for "
1568 "more information\n", modname);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001569 while (license) {
1570 if (license_is_gpl_compatible(license))
1571 mod->gpl_compatible = 1;
1572 else {
1573 mod->gpl_compatible = 0;
1574 break;
1575 }
1576 license = get_next_modinfo(info.modinfo, info.modinfo_len,
1577 "license", license);
1578 }
1579
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
1581 symname = info.strtab + sym->st_name;
1582
1583 handle_modversions(mod, &info, sym, symname);
1584 handle_moddevtable(mod, &info, sym, symname);
1585 }
Sam Ravnborgd1f25e62008-01-17 21:17:42 +01001586 if (!is_vmlinux(modname) ||
Sam Ravnborg10668222008-01-13 22:21:31 +01001587 (is_vmlinux(modname) && vmlinux_section_warnings))
1588 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
1590 version = get_modinfo(info.modinfo, info.modinfo_len, "version");
1591 if (version)
1592 maybe_frob_rcs_version(modname, version, info.modinfo,
1593 version - (char *)info.hdr);
1594 if (version || (all_versions && !is_vmlinux(modname)))
1595 get_src_version(modname, mod->srcversion,
1596 sizeof(mod->srcversion)-1);
1597
1598 parse_elf_finish(&info);
1599
Rusty Russell8c8ef422009-03-31 13:05:34 -06001600 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 * never passed as an argument to an exported function, so
1602 * the automatic versioning doesn't pick it up, but it's really
1603 * important anyhow */
1604 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06001605 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606}
1607
1608#define SZ 500
1609
1610/* We first write the generated file into memory using the
1611 * following helper, then compare to the file on disk and
1612 * only update the later if anything changed */
1613
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001614void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
1615 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616{
1617 char tmp[SZ];
1618 int len;
1619 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001620
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 va_start(ap, fmt);
1622 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f022006-03-16 23:04:08 -08001623 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 va_end(ap);
1625}
1626
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001627void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628{
1629 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f022006-03-16 23:04:08 -08001630 buf->size += len + SZ;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 buf->p = realloc(buf->p, buf->size);
1632 }
1633 strncpy(buf->p + buf->pos, s, len);
1634 buf->pos += len;
1635}
1636
Sam Ravnborgc96fca22006-07-01 11:44:23 +02001637static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
1638{
1639 const char *e = is_vmlinux(m) ?"":".ko";
1640
1641 switch (exp) {
1642 case export_gpl:
1643 fatal("modpost: GPL-incompatible module %s%s "
1644 "uses GPL-only symbol '%s'\n", m, e, s);
1645 break;
1646 case export_unused_gpl:
1647 fatal("modpost: GPL-incompatible module %s%s "
1648 "uses GPL-only symbol marked UNUSED '%s'\n", m, e, s);
1649 break;
1650 case export_gpl_future:
1651 warn("modpost: GPL-incompatible module %s%s "
1652 "uses future GPL-only symbol '%s'\n", m, e, s);
1653 break;
1654 case export_plain:
1655 case export_unused:
1656 case export_unknown:
1657 /* ignore */
1658 break;
1659 }
1660}
1661
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001662static void check_for_unused(enum export exp, const char *m, const char *s)
Sam Ravnborgc96fca22006-07-01 11:44:23 +02001663{
1664 const char *e = is_vmlinux(m) ?"":".ko";
1665
1666 switch (exp) {
1667 case export_unused:
1668 case export_unused_gpl:
1669 warn("modpost: module %s%s "
1670 "uses symbol '%s' marked UNUSED\n", m, e, s);
1671 break;
1672 default:
1673 /* ignore */
1674 break;
1675 }
1676}
1677
1678static void check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001679{
1680 struct symbol *s, *exp;
1681
1682 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07001683 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001684 exp = find_symbol(s->name);
1685 if (!exp || exp->module == mod)
1686 continue;
Andrew Morton6449bd62006-06-09 20:45:06 -07001687 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001688 if (basename)
1689 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02001690 else
1691 basename = mod->name;
1692 if (!mod->gpl_compatible)
1693 check_for_gpl_usage(exp->export, basename, exp->name);
1694 check_for_unused(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001695 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001696}
1697
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001698/**
1699 * Header for the generated file
1700 **/
1701static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702{
1703 buf_printf(b, "#include <linux/module.h>\n");
1704 buf_printf(b, "#include <linux/vermagic.h>\n");
1705 buf_printf(b, "#include <linux/compiler.h>\n");
1706 buf_printf(b, "\n");
1707 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
1708 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 buf_printf(b, "struct module __this_module\n");
1710 buf_printf(b, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
Ustyugov Romanf83b5e32005-09-23 08:42:11 +04001711 buf_printf(b, " .name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 if (mod->has_init)
1713 buf_printf(b, " .init = init_module,\n");
1714 if (mod->has_cleanup)
1715 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
1716 " .exit = cleanup_module,\n"
1717 "#endif\n");
Roman Zippele61a1c12007-05-09 02:35:15 -07001718 buf_printf(b, " .arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 buf_printf(b, "};\n");
1720}
1721
Trevor Keith5c725132009-09-22 16:43:38 -07001722static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07001723{
1724 static const char *staging_dir = "drivers/staging";
1725
1726 if (strncmp(staging_dir, name, strlen(staging_dir)) == 0)
1727 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
1728}
1729
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001730/**
1731 * Record CRCs for unresolved symbols
1732 **/
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07001733static int add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734{
1735 struct symbol *s, *exp;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07001736 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
1738 for (s = mod->unres; s; s = s->next) {
1739 exp = find_symbol(s->name);
1740 if (!exp || exp->module == mod) {
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07001741 if (have_vmlinux && !s->weak) {
Matthew Wilcox2a116652006-10-07 05:35:32 -06001742 if (warn_unresolved) {
1743 warn("\"%s\" [%s.ko] undefined!\n",
1744 s->name, mod->name);
1745 } else {
1746 merror("\"%s\" [%s.ko] undefined!\n",
1747 s->name, mod->name);
1748 err = 1;
1749 }
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07001750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 continue;
1752 }
1753 s->module = exp->module;
1754 s->crc_valid = exp->crc_valid;
1755 s->crc = exp->crc;
1756 }
1757
1758 if (!modversions)
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07001759 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760
1761 buf_printf(b, "\n");
1762 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Adrian Bunk3ff6eec2008-01-24 22:16:20 +01001763 buf_printf(b, "__used\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 buf_printf(b, "__attribute__((section(\"__versions\"))) = {\n");
1765
1766 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001767 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01001770 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 s->name, mod->name);
1772 continue;
1773 }
1774 buf_printf(b, "\t{ %#8x, \"%s\" },\n", s->crc, s->name);
1775 }
1776
1777 buf_printf(b, "};\n");
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07001778
1779 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780}
1781
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001782static void add_depends(struct buffer *b, struct module *mod,
1783 struct module *modules)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784{
1785 struct symbol *s;
1786 struct module *m;
1787 int first = 1;
1788
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001789 for (m = modules; m; m = m->next)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 m->seen = is_vmlinux(m->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791
1792 buf_printf(b, "\n");
1793 buf_printf(b, "static const char __module_depends[]\n");
Adrian Bunk3ff6eec2008-01-24 22:16:20 +01001794 buf_printf(b, "__used\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 buf_printf(b, "__attribute__((section(\".modinfo\"))) =\n");
1796 buf_printf(b, "\"depends=");
1797 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01001798 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 if (!s->module)
1800 continue;
1801
1802 if (s->module->seen)
1803 continue;
1804
1805 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001806 p = strrchr(s->module->name, '/');
1807 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01001808 p++;
1809 else
1810 p = s->module->name;
1811 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 first = 0;
1813 }
1814 buf_printf(b, "\";\n");
1815}
1816
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001817static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818{
1819 if (mod->srcversion[0]) {
1820 buf_printf(b, "\n");
1821 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
1822 mod->srcversion);
1823 }
1824}
1825
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001826static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827{
1828 char *tmp;
1829 FILE *file;
1830 struct stat st;
1831
1832 file = fopen(fname, "r");
1833 if (!file)
1834 goto write;
1835
1836 if (fstat(fileno(file), &st) < 0)
1837 goto close_write;
1838
1839 if (st.st_size != b->pos)
1840 goto close_write;
1841
1842 tmp = NOFAIL(malloc(b->pos));
1843 if (fread(tmp, 1, b->pos, file) != b->pos)
1844 goto free_write;
1845
1846 if (memcmp(tmp, b->p, b->pos) != 0)
1847 goto free_write;
1848
1849 free(tmp);
1850 fclose(file);
1851 return;
1852
1853 free_write:
1854 free(tmp);
1855 close_write:
1856 fclose(file);
1857 write:
1858 file = fopen(fname, "w");
1859 if (!file) {
1860 perror(fname);
1861 exit(1);
1862 }
1863 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
1864 perror(fname);
1865 exit(1);
1866 }
1867 fclose(file);
1868}
1869
Ram Paibd5cbce2006-06-08 22:12:53 -07001870/* parse Module.symvers file. line format:
Sam Ravnborg534b89a2006-07-01 10:10:19 +02001871 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
Ram Paibd5cbce2006-06-08 22:12:53 -07001872 **/
Sam Ravnborg040fcc82006-01-28 22:15:55 +01001873static void read_dump(const char *fname, unsigned int kernel)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874{
1875 unsigned long size, pos = 0;
1876 void *file = grab_file(fname, &size);
1877 char *line;
1878
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001879 if (!file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 /* No symbol versions, silently ignore */
1881 return;
1882
1883 while ((line = get_next_line(&pos, file, size))) {
Sam Ravnborg534b89a2006-07-01 10:10:19 +02001884 char *symname, *modname, *d, *export, *end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 unsigned int crc;
1886 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01001887 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888
1889 if (!(symname = strchr(line, '\t')))
1890 goto fail;
1891 *symname++ = '\0';
1892 if (!(modname = strchr(symname, '\t')))
1893 goto fail;
1894 *modname++ = '\0';
Laurent Riffard9ac545b2006-06-11 08:02:06 +02001895 if ((export = strchr(modname, '\t')) != NULL)
Ram Paibd5cbce2006-06-08 22:12:53 -07001896 *export++ = '\0';
Sam Ravnborg534b89a2006-07-01 10:10:19 +02001897 if (export && ((end = strchr(export, '\t')) != NULL))
1898 *end = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 crc = strtoul(line, &d, 16);
1900 if (*symname == '\0' || *modname == '\0' || *d != '\0')
1901 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001902 mod = find_module(modname);
1903 if (!mod) {
1904 if (is_vmlinux(modname))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 have_vmlinux = 1;
Jan Beulich0fa3a882009-03-12 12:28:30 +00001906 mod = new_module(modname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 mod->skip = 1;
1908 }
Ram Paibd5cbce2006-06-08 22:12:53 -07001909 s = sym_add_exported(symname, mod, export_no(export));
Sam Ravnborg8e70c452006-01-28 22:22:33 +01001910 s->kernel = kernel;
1911 s->preloaded = 1;
Ram Paibd5cbce2006-06-08 22:12:53 -07001912 sym_update_crc(symname, mod, crc, export_no(export));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 }
1914 return;
1915fail:
1916 fatal("parse error in symbol dump file\n");
1917}
1918
Sam Ravnborg040fcc82006-01-28 22:15:55 +01001919/* For normal builds always dump all symbols.
1920 * For external modules only dump symbols
1921 * that are not read from kernel Module.symvers.
1922 **/
1923static int dump_sym(struct symbol *sym)
1924{
1925 if (!external_module)
1926 return 1;
1927 if (sym->vmlinux || sym->kernel)
1928 return 0;
1929 return 1;
1930}
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001931
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001932static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933{
1934 struct buffer buf = { };
1935 struct symbol *symbol;
1936 int n;
1937
1938 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
1939 symbol = symbolhash[n];
1940 while (symbol) {
Sam Ravnborg040fcc82006-01-28 22:15:55 +01001941 if (dump_sym(symbol))
Ram Paibd5cbce2006-06-08 22:12:53 -07001942 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\n",
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001943 symbol->crc, symbol->name,
Ram Paibd5cbce2006-06-08 22:12:53 -07001944 symbol->module->name,
1945 export_str(symbol->export));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 symbol = symbol->next;
1947 }
1948 }
1949 write_if_changed(&buf, fname);
1950}
1951
Richard Hacker2d04b5a2008-02-28 09:40:52 +01001952struct ext_sym_list {
1953 struct ext_sym_list *next;
1954 const char *file;
1955};
1956
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01001957int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958{
1959 struct module *mod;
1960 struct buffer buf = { };
Sam Ravnborg040fcc82006-01-28 22:15:55 +01001961 char *kernel_read = NULL, *module_read = NULL;
1962 char *dump_write = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 int opt;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07001964 int err;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01001965 struct ext_sym_list *extsym_iter;
1966 struct ext_sym_list *extsym_start = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967
Richard Hacker2d04b5a2008-02-28 09:40:52 +01001968 while ((opt = getopt(argc, argv, "i:I:e:cmsSo:awM:K:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001969 switch (opt) {
1970 case 'i':
1971 kernel_read = optarg;
1972 break;
1973 case 'I':
1974 module_read = optarg;
1975 external_module = 1;
1976 break;
Sam Ravnborg4ce6efe2008-03-23 21:38:54 +01001977 case 'c':
1978 cross_build = 1;
1979 break;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01001980 case 'e':
1981 external_module = 1;
1982 extsym_iter =
1983 NOFAIL(malloc(sizeof(*extsym_iter)));
1984 extsym_iter->next = extsym_start;
1985 extsym_iter->file = optarg;
1986 extsym_start = extsym_iter;
1987 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001988 case 'm':
1989 modversions = 1;
1990 break;
1991 case 'o':
1992 dump_write = optarg;
1993 break;
1994 case 'a':
1995 all_versions = 1;
1996 break;
1997 case 's':
1998 vmlinux_section_warnings = 0;
1999 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01002000 case 'S':
2001 sec_mismatch_verbose = 0;
2002 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002003 case 'w':
2004 warn_unresolved = 1;
2005 break;
2006 default:
2007 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 }
2009 }
2010
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002011 if (kernel_read)
2012 read_dump(kernel_read, 1);
2013 if (module_read)
2014 read_dump(module_read, 0);
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002015 while (extsym_start) {
2016 read_dump(extsym_start->file, 0);
2017 extsym_iter = extsym_start->next;
2018 free(extsym_start);
2019 extsym_start = extsym_iter;
2020 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002022 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024
2025 for (mod = modules; mod; mod = mod->next) {
2026 if (mod->skip)
2027 continue;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002028 check_exports(mod);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002029 }
2030
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002031 err = 0;
2032
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002033 for (mod = modules; mod; mod = mod->next) {
Andi Kleen666ab412007-11-22 03:43:10 +01002034 char fname[strlen(mod->name) + 10];
2035
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002036 if (mod->skip)
2037 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038
2039 buf.pos = 0;
2040
2041 add_header(&buf, mod);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002042 add_staging_flag(&buf, mod->name);
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002043 err |= add_versions(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 add_depends(&buf, mod, modules);
2045 add_moddevtable(&buf, mod);
2046 add_srcversion(&buf, mod);
2047
2048 sprintf(fname, "%s.mod.c", mod->name);
2049 write_if_changed(&buf, fname);
2050 }
2051
2052 if (dump_write)
2053 write_dump(dump_write);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01002054 if (sec_mismatch_count && !sec_mismatch_verbose)
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01002055 warn("modpost: Found %d section mismatch(es).\n"
2056 "To see full details build your kernel with:\n"
2057 "'make CONFIG_DEBUG_SECTION_MISMATCH=y'\n",
2058 sec_mismatch_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002060 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061}