blob: a3d8370f954441ab71a6d7fd5ecd88ed8ca1ba48 [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
Masahiro Yamada5370d4a2020-01-05 00:36:51 +090015#include <elf.h>
Mathieu Desnoyersb2e3e652008-02-13 15:03:39 -080016#include <stdio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <ctype.h>
Andrew Morton5003bab2010-08-11 00:42:26 -070018#include <string.h>
Rusty Russell712f9b42013-04-04 17:37:38 +103019#include <limits.h>
Rusty Russelld4ef1c32013-04-04 17:37:32 +103020#include <stdbool.h>
Guenter Roeckeed380f2013-09-23 15:23:54 +093021#include <errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include "modpost.h"
Sam Ravnborgb817f6f2006-06-09 21:53:55 +020023#include "../../include/linux/license.h"
Alan Jenkins9e1b9b82009-11-07 21:03:54 +000024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/* Are we using CONFIG_MODVERSIONS? */
Mathias Krause7a3ee752014-08-27 20:28:53 +093026static int modversions = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070027/* Warn about undefined symbols? (do so if we have vmlinux) */
Mathias Krause7a3ee752014-08-27 20:28:53 +093028static int have_vmlinux = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029/* Is CONFIG_MODULE_SRCVERSION_ALL set? */
30static int all_versions = 0;
Sam Ravnborg040fcc82006-01-28 22:15:55 +010031/* If we are modposting external module set to 1 */
32static int external_module = 0;
Sam Ravnborg8d8d8282007-07-20 22:36:56 +020033/* Warn about section mismatch in vmlinux if set to 1 */
34static int vmlinux_section_warnings = 1;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -070035/* Only warn about unresolved symbols */
36static int warn_unresolved = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -070037/* How a symbol is exported */
Sam Ravnborg588ccd72008-01-24 21:12:37 +010038static int sec_mismatch_count = 0;
Nicolas Boichat47490ec2015-10-06 09:44:42 +103039static int sec_mismatch_fatal = 0;
Guenter Roeckeed380f2013-09-23 15:23:54 +093040/* ignore missing files */
41static int ignore_missing_files;
Jessica Yu54b77842020-03-06 17:02:06 +010042/* If set to 1, only warn (instead of error) about missing ns imports */
43static int allow_missing_ns_imports;
Sam Ravnborg588ccd72008-01-24 21:12:37 +010044
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
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +080050/* In kernel, this size is defined in linux/module.h;
51 * here we use Elf_Addr instead of long for covering cross-compile
52 */
53
54#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
55
Jessica Yu93c95e52020-03-06 17:02:05 +010056void __attribute__((format(printf, 2, 3)))
57modpost_log(enum loglevel loglevel, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070058{
59 va_list arglist;
60
Jessica Yu93c95e52020-03-06 17:02:05 +010061 switch (loglevel) {
62 case LOG_WARN:
63 fprintf(stderr, "WARNING: ");
64 break;
65 case LOG_ERROR:
66 fprintf(stderr, "ERROR: ");
67 break;
68 case LOG_FATAL:
69 fprintf(stderr, "FATAL: ");
70 break;
71 default: /* invalid loglevel, ignore */
72 break;
73 }
74
75 fprintf(stderr, "modpost: ");
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 va_start(arglist, fmt);
78 vfprintf(stderr, fmt, arglist);
79 va_end(arglist);
80
Jessica Yu93c95e52020-03-06 17:02:05 +010081 if (loglevel == LOG_FATAL)
82 exit(1);
Matthew Wilcox2a116652006-10-07 05:35:32 -060083}
84
Rusty Russelld4ef1c32013-04-04 17:37:32 +103085static inline bool strends(const char *str, const char *postfix)
86{
87 if (strlen(str) < strlen(postfix))
88 return false;
89
90 return strcmp(str + strlen(str) - strlen(postfix), postfix) == 0;
91}
92
Sam Ravnborg040fcc82006-01-28 22:15:55 +010093static int is_vmlinux(const char *modname)
94{
95 const char *myname;
96
Sam Ravnborgdf578e72008-01-11 19:17:15 +010097 myname = strrchr(modname, '/');
98 if (myname)
Sam Ravnborg040fcc82006-01-28 22:15:55 +010099 myname++;
100 else
101 myname = modname;
102
Sam Ravnborg741f98f2007-07-17 10:54:06 +0200103 return (strcmp(myname, "vmlinux") == 0) ||
104 (strcmp(myname, "vmlinux.o") == 0);
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100105}
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107void *do_nofail(void *ptr, const char *expr)
108{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100109 if (!ptr)
Jessica Yu93c95e52020-03-06 17:02:05 +0100110 fatal("Memory allocation failure: %s.\n", expr);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 return ptr;
113}
114
115/* A list of all modules we processed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116static struct module *modules;
117
Masahiro Yamada8b185742018-05-09 18:50:40 +0900118static struct module *find_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119{
120 struct module *mod;
121
122 for (mod = modules; mod; mod = mod->next)
123 if (strcmp(mod->name, modname) == 0)
124 break;
125 return mod;
126}
127
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030128static struct module *new_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129{
130 struct module *mod;
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030131 char *p;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100132
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 mod = NOFAIL(malloc(sizeof(*mod)));
134 memset(mod, 0, sizeof(*mod));
135 p = NOFAIL(strdup(modname));
136
137 /* strip trailing .o */
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030138 if (strends(p, ".o")) {
139 p[strlen(p) - 2] = '\0';
140 mod->is_dot_o = 1;
141 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143 /* add to list */
144 mod->name = p;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200145 mod->gpl_compatible = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 mod->next = modules;
147 modules = mod;
148
149 return mod;
150}
151
152/* A hash of all exported symbols,
153 * struct symbol is also used for lists of unresolved symbols */
154
155#define SYMBOL_HASH_SIZE 1024
156
157struct symbol {
158 struct symbol *next;
159 struct module *module;
160 unsigned int crc;
161 int crc_valid;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900162 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 unsigned int weak:1;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100164 unsigned int vmlinux:1; /* 1 if symbol is defined in vmlinux */
165 unsigned int kernel:1; /* 1 if symbol is from kernel
166 * (only for external modules) **/
Denis Efremov15bfc232019-08-01 09:06:57 +0300167 unsigned int is_static:1; /* 1 if symbol is not global */
Ram Paibd5cbce2006-06-08 22:12:53 -0700168 enum export export; /* Type of export */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 char name[0];
170};
171
172static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
173
174/* This is based on the hash agorithm from gdbm, via tdb */
175static inline unsigned int tdb_hash(const char *name)
176{
177 unsigned value; /* Used to compute the hash value. */
178 unsigned i; /* Used to cycle through random values. */
179
180 /* Set the initial value from the key size. */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100181 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
183
184 return (1103515243 * value + 12345);
185}
186
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100187/**
188 * Allocate a new symbols for use in the hash of exported symbols or
189 * the list of unresolved symbols per module
190 **/
191static struct symbol *alloc_symbol(const char *name, unsigned int weak,
192 struct symbol *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
194 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
195
196 memset(s, 0, sizeof(*s));
197 strcpy(s->name, name);
198 s->weak = weak;
199 s->next = next;
Denis Efremov15bfc232019-08-01 09:06:57 +0300200 s->is_static = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 return s;
202}
203
204/* For the hash of exported symbols */
Ram Paibd5cbce2006-06-08 22:12:53 -0700205static struct symbol *new_symbol(const char *name, struct module *module,
206 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207{
208 unsigned int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900211 symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
212
213 return symbolhash[hash];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214}
215
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100216static struct symbol *find_symbol(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
218 struct symbol *s;
219
220 /* For our purposes, .foo matches foo. PPC64 needs this. */
221 if (name[0] == '.')
222 name++;
223
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100224 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 if (strcmp(s->name, name) == 0)
226 return s;
227 }
228 return NULL;
229}
230
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100231static bool contains_namespace(struct namespace_list *list,
232 const char *namespace)
233{
Masahiro Yamada76b54cf2019-10-29 21:38:09 +0900234 for (; list; list = list->next)
235 if (!strcmp(list->namespace, namespace))
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100236 return true;
237
238 return false;
239}
240
241static void add_namespace(struct namespace_list **list, const char *namespace)
242{
243 struct namespace_list *ns_entry;
244
245 if (!contains_namespace(*list, namespace)) {
246 ns_entry = NOFAIL(malloc(sizeof(struct namespace_list) +
247 strlen(namespace) + 1));
248 strcpy(ns_entry->namespace, namespace);
249 ns_entry->next = *list;
250 *list = ns_entry;
251 }
252}
253
254static bool module_imports_namespace(struct module *module,
255 const char *namespace)
256{
257 return contains_namespace(module->imported_namespaces, namespace);
258}
259
Mathias Krause7a3ee752014-08-27 20:28:53 +0930260static const struct {
Ram Paibd5cbce2006-06-08 22:12:53 -0700261 const char *str;
262 enum export export;
263} export_list[] = {
264 { .str = "EXPORT_SYMBOL", .export = export_plain },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200265 { .str = "EXPORT_UNUSED_SYMBOL", .export = export_unused },
Ram Paibd5cbce2006-06-08 22:12:53 -0700266 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200267 { .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
Ram Paibd5cbce2006-06-08 22:12:53 -0700268 { .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
269 { .str = "(unknown)", .export = export_unknown },
270};
271
272
273static const char *export_str(enum export ex)
274{
275 return export_list[ex].str;
276}
277
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100278static enum export export_no(const char *s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700279{
280 int i;
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100281
Sam Ravnborg534b89a2006-07-01 10:10:19 +0200282 if (!s)
283 return export_unknown;
Ram Paibd5cbce2006-06-08 22:12:53 -0700284 for (i = 0; export_list[i].export != export_unknown; i++) {
285 if (strcmp(export_list[i].str, s) == 0)
286 return export_list[i].export;
287 }
288 return export_unknown;
289}
290
Masahiro Yamada6124c042017-09-06 16:19:05 -0700291static const char *sech_name(struct elf_info *elf, Elf_Shdr *sechdr)
292{
293 return (void *)elf->hdr +
294 elf->sechdrs[elf->secindex_strings].sh_offset +
295 sechdr->sh_name;
296}
297
298static const char *sec_name(struct elf_info *elf, int secindex)
299{
300 return sech_name(elf, &elf->sechdrs[secindex]);
301}
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200302
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900303static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
304{
305 Elf_Shdr *sechdr = &info->sechdrs[sym->st_shndx];
306 unsigned long offset;
307
308 offset = sym->st_value;
309 if (info->hdr->e_type != ET_REL)
310 offset -= sechdr->sh_addr;
311
312 return (void *)info->hdr + sechdr->sh_offset + offset;
313}
314
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200315#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
316
317static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
318{
319 const char *secname = sec_name(elf, sec);
320
321 if (strstarts(secname, "___ksymtab+"))
322 return export_plain;
323 else if (strstarts(secname, "___ksymtab_unused+"))
324 return export_unused;
325 else if (strstarts(secname, "___ksymtab_gpl+"))
326 return export_gpl;
327 else if (strstarts(secname, "___ksymtab_unused_gpl+"))
328 return export_unused_gpl;
329 else if (strstarts(secname, "___ksymtab_gpl_future+"))
330 return export_gpl_future;
331 else
332 return export_unknown;
333}
334
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200335static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700336{
337 if (sec == elf->export_sec)
338 return export_plain;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200339 else if (sec == elf->export_unused_sec)
340 return export_unused;
Ram Paibd5cbce2006-06-08 22:12:53 -0700341 else if (sec == elf->export_gpl_sec)
342 return export_gpl;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200343 else if (sec == elf->export_unused_gpl_sec)
344 return export_unused_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700345 else if (sec == elf->export_gpl_future_sec)
346 return export_gpl_future;
347 else
348 return export_unknown;
349}
350
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900351static const char *namespace_from_kstrtabns(const struct elf_info *info,
352 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100353{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900354 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100355 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100356}
357
Matthias Maennicha2b11182019-10-18 10:31:40 +0100358static void sym_update_namespace(const char *symname, const char *namespace)
359{
360 struct symbol *s = find_symbol(symname);
361
362 /*
363 * That symbol should have been created earlier and thus this is
364 * actually an assertion.
365 */
366 if (!s) {
367 merror("Could not update namespace(%s) for symbol %s\n",
368 namespace, symname);
369 return;
370 }
371
372 free(s->namespace);
373 s->namespace =
374 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
375}
376
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100377/**
378 * Add an exported symbol - it may have already been added without a
379 * CRC, in this case just update the CRC
380 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100381static struct symbol *sym_add_exported(const char *name, struct module *mod,
382 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
384 struct symbol *s = find_symbol(name);
385
386 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700387 s = new_symbol(name, mod, export);
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900388 } else if (!external_module || is_vmlinux(s->module->name) ||
389 s->module == mod) {
390 warn("%s: '%s' exported twice. Previous export was in %s%s\n",
391 mod->name, name, s->module->name,
392 is_vmlinux(s->module->name) ? "" : ".ko");
393 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900395
396 s->module = mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100397 s->vmlinux = is_vmlinux(mod->name);
398 s->kernel = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -0700399 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100400 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401}
402
Masahiro Yamada17436942019-11-15 02:42:24 +0900403static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100404{
405 struct symbol *s = find_symbol(name);
406
Masahiro Yamada17436942019-11-15 02:42:24 +0900407 /*
408 * Ignore stand-alone __crc_*, which might be auto-generated symbols
409 * such as __*_veneer in ARM ELF.
410 */
411 if (!s)
412 return;
413
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100414 s->crc = crc;
415 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416}
417
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100418void *grab_file(const char *filename, unsigned long *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419{
420 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930421 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 int fd;
423
424 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930425 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930427 if (fstat(fd, &st))
428 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
430 *size = st.st_size;
431 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930433failed:
434 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 if (map == MAP_FAILED)
436 return NULL;
437 return map;
438}
439
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100440/**
441 * Return a copy of the next line in a mmap'ed file.
442 * spaces in the beginning of the line is trimmed away.
443 * Return a pointer to a static buffer.
444 **/
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100445char *get_next_line(unsigned long *pos, void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446{
447 static char line[4096];
448 int skip = 1;
449 size_t len = 0;
450 signed char *p = (signed char *)file + *pos;
451 char *s = line;
452
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100453 for (; *pos < size ; (*pos)++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 if (skip && isspace(*p)) {
455 p++;
456 continue;
457 }
458 skip = 0;
459 if (*p != '\n' && (*pos < size)) {
460 len++;
461 *s++ = *p++;
462 if (len > 4095)
463 break; /* Too long, stop */
464 } else {
465 /* End of string */
466 *s = '\0';
467 return line;
468 }
469 }
470 /* End of buffer */
471 return NULL;
472}
473
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100474void release_file(void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
476 munmap(file, size);
477}
478
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100479static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480{
481 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100482 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 Elf_Shdr *sechdrs;
484 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200485 const char *secstrings;
486 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487
488 hdr = grab_file(filename, &info->size);
489 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930490 if (ignore_missing_files) {
491 fprintf(stderr, "%s: %s (ignored)\n", filename,
492 strerror(errno));
493 return 0;
494 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200496 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 }
498 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100499 if (info->size < sizeof(*hdr)) {
500 /* file too small, assume this is an empty .o file */
501 return 0;
502 }
503 /* Is this a valid ELF file? */
504 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
505 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
506 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
507 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
508 /* Not an ELF file - silently ignore it */
509 return 0;
510 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200512 hdr->e_type = TO_NATIVE(hdr->e_type);
513 hdr->e_machine = TO_NATIVE(hdr->e_machine);
514 hdr->e_version = TO_NATIVE(hdr->e_version);
515 hdr->e_entry = TO_NATIVE(hdr->e_entry);
516 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
517 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
518 hdr->e_flags = TO_NATIVE(hdr->e_flags);
519 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
520 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
521 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
522 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
523 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
524 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 sechdrs = (void *)hdr + hdr->e_shoff;
526 info->sechdrs = sechdrs;
527
Petr Stetiara83710e2007-08-27 12:15:07 +0200528 /* Check if file offset is correct */
529 if (hdr->e_shoff > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100530 fatal("section header offset=%lu in file '%s' is bigger than "
531 "filesize=%lu\n", (unsigned long)hdr->e_shoff,
532 filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200533 return 0;
534 }
535
Anders Kaseorg68457562011-05-19 16:55:27 -0600536 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200537 /*
538 * There are more than 64k sections,
539 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200540 */
541 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
542 }
543 else {
544 info->num_sections = hdr->e_shnum;
545 }
546 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600547 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200548 }
549 else {
550 info->secindex_strings = hdr->e_shstrndx;
551 }
552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200554 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200555 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
556 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
557 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
558 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
559 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
560 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
561 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
562 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
563 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
564 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 }
566 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200567 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
568 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700569 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900570 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Tejun Heo56fc82c2009-02-06 00:48:02 +0900572 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100573 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
574 "sizeof(*hrd)=%zu\n", filename,
575 (unsigned long)sechdrs[i].sh_offset,
576 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100577 return 0;
578 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700579 secname = secstrings + sechdrs[i].sh_name;
580 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900581 if (nobits)
582 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
584 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700585 } else if (strcmp(secname, "__ksymtab") == 0)
586 info->export_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200587 else if (strcmp(secname, "__ksymtab_unused") == 0)
588 info->export_unused_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700589 else if (strcmp(secname, "__ksymtab_gpl") == 0)
590 info->export_gpl_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200591 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
592 info->export_unused_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700593 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
594 info->export_gpl_future_sec = i;
595
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200596 if (sechdrs[i].sh_type == SHT_SYMTAB) {
597 unsigned int sh_link_idx;
598 symtab_idx = i;
599 info->symtab_start = (void *)hdr +
600 sechdrs[i].sh_offset;
601 info->symtab_stop = (void *)hdr +
602 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600603 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200604 info->strtab = (void *)hdr +
605 sechdrs[sh_link_idx].sh_offset;
606 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200608 /* 32bit section no. table? ("more than 64k sections") */
609 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
610 symtab_shndx_idx = i;
611 info->symtab_shndx_start = (void *)hdr +
612 sechdrs[i].sh_offset;
613 info->symtab_shndx_stop = (void *)hdr +
614 sechdrs[i].sh_offset + sechdrs[i].sh_size;
615 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100617 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100618 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 /* Fix endianness in symbols */
621 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
622 sym->st_shndx = TO_NATIVE(sym->st_shndx);
623 sym->st_name = TO_NATIVE(sym->st_name);
624 sym->st_value = TO_NATIVE(sym->st_value);
625 sym->st_size = TO_NATIVE(sym->st_size);
626 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200627
628 if (symtab_shndx_idx != ~0U) {
629 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600630 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200631 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600632 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200633 symtab_idx);
634 /* Fix endianness */
635 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
636 p++)
637 *p = TO_NATIVE(*p);
638 }
639
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100640 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641}
642
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100643static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644{
645 release_file(info->hdr, info->size);
646}
647
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200648static int ignore_undef_symbol(struct elf_info *info, const char *symname)
649{
650 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900651 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200652 return 1;
653 /* ignore global offset table */
654 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
655 return 1;
656 if (info->hdr->e_machine == EM_PPC)
657 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900658 if (strstarts(symname, "_restgpr_") ||
659 strstarts(symname, "_savegpr_") ||
660 strstarts(symname, "_rest32gpr_") ||
661 strstarts(symname, "_save32gpr_") ||
662 strstarts(symname, "_restvr_") ||
663 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200664 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000665 if (info->hdr->e_machine == EM_PPC64)
666 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900667 if (strstarts(symname, "_restgpr0_") ||
668 strstarts(symname, "_savegpr0_") ||
669 strstarts(symname, "_restvr_") ||
670 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100671 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000672 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200673 /* Do not ignore this symbol */
674 return 0;
675}
676
Masahiro Yamada17436942019-11-15 02:42:24 +0900677static void handle_modversion(const struct module *mod,
678 const struct elf_info *info,
679 const Elf_Sym *sym, const char *symname)
680{
681 unsigned int crc;
682
683 if (sym->st_shndx == SHN_UNDEF) {
684 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n",
685 symname, mod->name, is_vmlinux(mod->name) ? "":".ko");
686 return;
687 }
688
689 if (sym->st_shndx == SHN_ABS) {
690 crc = sym->st_value;
691 } else {
692 unsigned int *crcp;
693
694 /* symbol points to the CRC in the ELF object */
695 crcp = sym_get_data(info, sym);
696 crc = TO_NATIVE(*crcp);
697 }
698 sym_set_crc(symname, crc);
699}
700
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900701static void handle_symbol(struct module *mod, struct elf_info *info,
702 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200704 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900705 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200706
Frank Rowand258f7422012-04-09 17:59:03 -0700707 if ((!is_vmlinux(mod->name) || mod->is_dot_o) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900708 strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200709 export = export_from_secname(info, get_secindex(info, sym));
710 else
711 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
713 switch (sym->st_shndx) {
714 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900715 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100716 /* Should warn here, but modpost runs before the linker */
717 } else
718 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 case SHN_UNDEF:
721 /* undefined symbol */
722 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
723 ELF_ST_BIND(sym->st_info) != STB_WEAK)
724 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200725 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 if (info->hdr->e_machine == EM_SPARC ||
728 info->hdr->e_machine == EM_SPARCV9) {
729 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700730 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100732 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700733 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100734 munged[0] = '_';
735 munged[1] = toupper(munged[1]);
736 symname = munged;
737 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100739
Rusty Russellb92021b2013-03-15 15:04:17 +1030740 mod->unres = alloc_symbol(symname,
741 ELF_ST_BIND(sym->st_info) == STB_WEAK,
742 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 break;
744 default:
745 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900746 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100747 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100748 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900750 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900752 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 mod->has_cleanup = 1;
754 break;
755 }
756}
757
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100758/**
759 * Parse tag=value strings from .modinfo section
760 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761static char *next_string(char *string, unsigned long *secsize)
762{
763 /* Skip non-zero chars */
764 while (string[0]) {
765 string++;
766 if ((*secsize)-- <= 1)
767 return NULL;
768 }
769
770 /* Skip any zero padding. */
771 while (!string[0]) {
772 string++;
773 if ((*secsize)-- <= 1)
774 return NULL;
775 }
776 return string;
777}
778
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900779static char *get_next_modinfo(struct elf_info *info, const char *tag,
780 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781{
782 char *p;
783 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900784 char *modinfo = info->modinfo;
785 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900787 if (prev) {
788 size -= prev - modinfo;
789 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200790 }
791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 for (p = modinfo; p; p = next_string(p, &size)) {
793 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
794 return p + taglen + 1;
795 }
796 return NULL;
797}
798
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900799static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200800
801{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900802 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200803}
804
Sam Ravnborg93684d32006-02-19 11:53:35 +0100805/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100806 * Test if string s ends in string sub
807 * return 0 if match
808 **/
809static int strrcmp(const char *s, const char *sub)
810{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100811 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100812
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100813 if (!s || !sub)
814 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100815
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100816 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100817 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100818
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100819 if ((slen == 0) || (sublen == 0))
820 return 1;
821
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100822 if (sublen > slen)
823 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100824
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100825 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100826}
827
Sam Ravnborgff13f922008-01-23 19:54:27 +0100828static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
829{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100830 if (sym)
831 return elf->strtab + sym->st_name;
832 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100833 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100834}
835
Sam Ravnborg10668222008-01-13 22:21:31 +0100836/* The pattern is an array of simple patterns.
837 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100838 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100839 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930840 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100841 */
Trevor Keith5c725132009-09-22 16:43:38 -0700842static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100843{
844 const char *p;
845 while (*pat) {
846 p = *pat++;
847 const char *endp = p + strlen(p) - 1;
848
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930849 /* "*foo*" */
850 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300851 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
852 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930853
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930854 free(bare);
855 if (here != NULL)
856 return 1;
857 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100858 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930859 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100860 if (strrcmp(sym, p + 1) == 0)
861 return 1;
862 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100863 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100864 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100865 if (strncmp(sym, p, strlen(p) - 1) == 0)
866 return 1;
867 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100868 /* no wildcards */
869 else {
870 if (strcmp(p, sym) == 0)
871 return 1;
872 }
873 }
874 /* no match */
875 return 0;
876}
877
Sam Ravnborg10668222008-01-13 22:21:31 +0100878/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930879static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200880{
881 ".comment*",
882 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930883 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800884 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000885 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200886 ".mdebug*", /* alpha, score, mips etc. */
887 ".pdr", /* alpha, score, mips etc. */
888 ".stab*",
889 ".note*",
890 ".got*",
891 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400892 ".xt.prop", /* xtensa */
893 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030894 ".arcextmap*", /* arc */
895 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030896 ".cmem*", /* EZchip */
897 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100898 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600899 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200900 NULL
901};
Sam Ravnborg10668222008-01-13 22:21:31 +0100902
Sam Ravnborge241a632008-01-28 20:13:13 +0100903/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400904 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100905 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400906 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100907 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400908static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900909 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100910{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400911 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100912
Anders Kaseorgb614a692009-04-23 16:49:33 -0400913 if (sechdr->sh_type == SHT_PROGBITS &&
914 !(sechdr->sh_flags & SHF_ALLOC) &&
915 !match(sec, section_white_list)) {
916 warn("%s (%s): unexpected non-allocatable section.\n"
917 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
918 "Note that for example <linux/init.h> contains\n"
919 "section definitions for use in .S files.\n\n",
920 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100921 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100922}
923
924
925
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100926#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930927 ".init.setup", ".init.rodata", ".meminit.rodata", \
928 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100929#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930930 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100931
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100932#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930933 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100934#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930935 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100936
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200937#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930938 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
939 ".pci_fixup_enable", ".pci_fixup_resume", \
940 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200941
Paul Gortmakere24f6622013-06-19 19:30:48 -0400942#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
943#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100944
945#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
946#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100947
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930948#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930949#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Chris Metcalf6727ad92016-10-07 17:02:55 -0700950 ".kprobes.text", ".cpuidle.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930951#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400952 ".fixup", ".entry.text", ".exception.text", ".text.*", \
953 ".coldtext"
Sam Ravnborg10668222008-01-13 22:21:31 +0100954
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000955#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000956#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100957
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000958#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000959#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100960
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930961#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
962 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
963
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100964/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930965static const char *const init_data_sections[] =
966 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100967
968/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930969static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100970
971/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930972static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100973 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100974
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930975/* all text sections */
976static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
977
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100978/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930979static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100980
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100981
982/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100983#define DEFAULT_SYMBOL_WHITE_LIST \
984 "*driver", \
985 "*_template", /* scsi uses *_template a lot */ \
986 "*_timer", /* arm uses ops structures named _timer a lot */ \
987 "*_sht", /* scsi also used *_sht to some extent */ \
988 "*_ops", \
989 "*_probe", \
990 "*_probe_one", \
991 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100992
Mathias Krause7a3ee752014-08-27 20:28:53 +0930993static const char *const head_sections[] = { ".head.text*", NULL };
994static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100995 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930996static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100997
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100998enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100999 TEXT_TO_ANY_INIT,
1000 DATA_TO_ANY_INIT,
1001 TEXT_TO_ANY_EXIT,
1002 DATA_TO_ANY_EXIT,
1003 XXXINIT_TO_SOME_INIT,
1004 XXXEXIT_TO_SOME_EXIT,
1005 ANY_INIT_TO_ANY_EXIT,
1006 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001007 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301008 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001009};
1010
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301011/**
1012 * Describe how to match sections on different criterias:
1013 *
1014 * @fromsec: Array of sections to be matched.
1015 *
1016 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
1017 * this array is forbidden (black-list). Can be empty.
1018 *
1019 * @good_tosec: Relocations applied to a section in @fromsec must be
1020 * targetting sections in this array (white-list). Can be empty.
1021 *
1022 * @mismatch: Type of mismatch.
1023 *
1024 * @symbol_white_list: Do not match a relocation to a symbol in this list
1025 * even if it is targetting a section in @bad_to_sec.
1026 *
1027 * @handler: Specific handler to call when a match is found. If NULL,
1028 * default_mismatch_handler() will be called.
1029 *
1030 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001031struct sectioncheck {
1032 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301033 const char *bad_tosec[20];
1034 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001035 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001036 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301037 void (*handler)(const char *modname, struct elf_info *elf,
1038 const struct sectioncheck* const mismatch,
1039 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1040
Sam Ravnborg10668222008-01-13 22:21:31 +01001041};
1042
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301043static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1044 const struct sectioncheck* const mismatch,
1045 Elf_Rela *r, Elf_Sym *sym,
1046 const char *fromsec);
1047
Mathias Krause7a3ee752014-08-27 20:28:53 +09301048static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001049/* Do not reference init/exit code/data from
1050 * normal code and data
1051 */
1052{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001053 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301054 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001055 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001056 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001057},
1058{
1059 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301060 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001061 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001062 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001063},
1064{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001065 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301066 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001067 .mismatch = DATA_TO_ANY_INIT,
1068 .symbol_white_list = {
1069 "*_template", "*_timer", "*_sht", "*_ops",
1070 "*_probe", "*_probe_one", "*_console", NULL
1071 },
1072},
1073{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001074 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301075 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001076 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001077 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001078},
1079{
1080 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301081 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001082 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001083 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001084},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001085/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001086{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001087 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301088 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001089 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001090 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001091},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001092/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001093{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001094 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301095 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001096 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001097 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001098},
1099/* Do not use exit code/data from init code */
1100{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001101 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301102 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001103 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001104 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001105},
1106/* Do not use init code/data from exit code */
1107{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001108 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301109 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001110 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001111 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001112},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001113{
1114 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301115 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001116 .mismatch = ANY_INIT_TO_ANY_EXIT,
1117 .symbol_white_list = { NULL },
1118},
Sam Ravnborg10668222008-01-13 22:21:31 +01001119/* Do not export init/exit functions or data */
1120{
1121 .fromsec = { "__ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301122 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001123 .mismatch = EXPORT_TO_INIT_EXIT,
1124 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301125},
1126{
1127 .fromsec = { "__ex_table", NULL },
1128 /* If you're adding any new black-listed sections in here, consider
1129 * adding a special 'printer' for them in scripts/check_extable.
1130 */
1131 .bad_tosec = { ".altinstr_replacement", NULL },
1132 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1133 .mismatch = EXTABLE_TO_NON_TEXT,
1134 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001135}
1136};
1137
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001138static const struct sectioncheck *section_mismatch(
1139 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001140{
1141 int i;
1142 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1143 const struct sectioncheck *check = &sectioncheck[0];
1144
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301145 /*
1146 * The target section could be the SHT_NUL section when we're
1147 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001148 * doesn't make much sense and causes build failures on parisc
1149 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301150 */
1151 if (*tosec == '\0')
1152 return NULL;
1153
Sam Ravnborg10668222008-01-13 22:21:31 +01001154 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301155 if (match(fromsec, check->fromsec)) {
1156 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1157 return check;
1158 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1159 return check;
1160 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001161 check++;
1162 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001163 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001164}
1165
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001166/**
1167 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001168 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001169 * Pattern 1:
1170 * If a module parameter is declared __initdata and permissions=0
1171 * then this is legal despite the warning generated.
1172 * We cannot see value of permissions here, so just ignore
1173 * this pattern.
1174 * The pattern is identified by:
1175 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001176 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001177 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001178 *
Rusty Russell6a841522010-08-11 23:04:16 -06001179 * Pattern 1a:
1180 * module_param_call() ops can refer to __init set function if permissions=0
1181 * The pattern is identified by:
1182 * tosec = .init.text
1183 * fromsec = .data*
1184 * atsym = __param_ops_*
1185 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001186 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001187 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001188 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001189 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001190 * tosec = init or exit section
1191 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001192 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1193 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001194 *
1195 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001196 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001197 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001198 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001199 * Some symbols belong to init section but still it is ok to reference
1200 * these from non-init sections as these symbols don't have any memory
1201 * allocated for them and symbol address and value are same. So even
1202 * if init section is freed, its ok to reference those symbols.
1203 * For ex. symbols marking the init section boundaries.
1204 * This pattern is identified by
1205 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001206 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301207 * Pattern 5:
1208 * GCC may optimize static inlines when fed constant arg(s) resulting
1209 * in functions like cpumask_empty() -- generating an associated symbol
1210 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1211 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1212 * meaningless section warning. May need to add isra symbols too...
1213 * This pattern is identified by
1214 * tosec = init section
1215 * fromsec = text section
1216 * refsymname = *.constprop.*
1217 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001218 * Pattern 6:
1219 * Hide section mismatch warnings for ELF local symbols. The goal
1220 * is to eliminate false positive modpost warnings caused by
1221 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1222 * Autogenerated symbol names bypass modpost's "Pattern 2"
1223 * whitelisting, which relies on pattern-matching against symbol
1224 * names to work. (One situation where gcc can autogenerate ELF
1225 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001226 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001227static int secref_whitelist(const struct sectioncheck *mismatch,
1228 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001229 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001230{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001231 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001232 if (match(tosec, init_data_sections) &&
1233 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001234 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001235 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001236
Rusty Russell6a841522010-08-11 23:04:16 -06001237 /* Check for pattern 1a */
1238 if (strcmp(tosec, ".init.text") == 0 &&
1239 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001240 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001241 return 0;
1242
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001243 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001244 if (match(tosec, init_exit_sections) &&
1245 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001246 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001247 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001248
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001249 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001250 if (match(fromsec, head_sections) &&
1251 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001252 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001253
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001254 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001255 if (match(tosym, linker_symbols))
1256 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001257
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301258 /* Check for pattern 5 */
1259 if (match(fromsec, text_sections) &&
1260 match(tosec, init_sections) &&
1261 match(fromsym, optim_symbols))
1262 return 0;
1263
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001264 /* Check for pattern 6 */
1265 if (strstarts(fromsym, ".L"))
1266 return 0;
1267
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001268 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001269}
1270
Sami Tolvanen5818c682018-10-23 15:15:35 -07001271static inline int is_arm_mapping_symbol(const char *str)
1272{
1273 return str[0] == '$' && strchr("axtd", str[1])
1274 && (str[2] == '\0' || str[2] == '.');
1275}
1276
1277/*
1278 * If there's no name there, ignore it; likewise, ignore it if it's
1279 * one of the magic symbols emitted used by current ARM tools.
1280 *
1281 * Otherwise if find_symbols_between() returns those symbols, they'll
1282 * fail the whitelist tests and cause lots of false alarms ... fixable
1283 * only by merging __exit and __init sections into __text, bloating
1284 * the kernel (which is especially evil on embedded platforms).
1285 */
1286static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1287{
1288 const char *name = elf->strtab + sym->st_name;
1289
1290 if (!name || !strlen(name))
1291 return 0;
1292 return !is_arm_mapping_symbol(name);
1293}
1294
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001295/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001296 * Find symbol based on relocation record info.
1297 * In some cases the symbol supplied is a valid symbol so
1298 * return refsym. If st_name != 0 we assume this is a valid symbol.
1299 * In other cases the symbol needs to be looked up in the symbol table
1300 * based on section and address.
1301 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001302static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001303 Elf_Sym *relsym)
1304{
1305 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001306 Elf_Sym *near = NULL;
1307 Elf64_Sword distance = 20;
1308 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001309 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001310
1311 if (relsym->st_name != 0)
1312 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001313
1314 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001315 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001316 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001317 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001318 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1319 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001320 if (!is_valid_name(elf, sym))
1321 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001322 if (sym->st_value == addr)
1323 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001324 /* Find a symbol nearby - addr are maybe negative */
1325 d = sym->st_value - addr;
1326 if (d < 0)
1327 d = addr - sym->st_value;
1328 if (d < distance) {
1329 distance = d;
1330 near = sym;
1331 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001332 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001333 /* We need a close match */
1334 if (distance < 20)
1335 return near;
1336 else
1337 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001338}
1339
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001340/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001341 * Find symbols before or equal addr and after addr - in the section sec.
1342 * If we find two symbols with equal offset prefer one with a valid name.
1343 * The ELF format may have a better way to detect what type of symbol
1344 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001345 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001346static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1347 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001348{
1349 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001350 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001351 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001352
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001353 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1354 const char *symsec;
1355
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001356 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001357 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001358 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001359 if (strcmp(symsec, sec) != 0)
1360 continue;
David Brownellda68d612007-02-20 13:58:16 -08001361 if (!is_valid_name(elf, sym))
1362 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001363 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001364 if ((addr - sym->st_value) < distance) {
1365 distance = addr - sym->st_value;
1366 near = sym;
1367 } else if ((addr - sym->st_value) == distance) {
1368 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001369 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001370 }
1371 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001372 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001373}
1374
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001375/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001376 * Convert a section name to the function/data attribute
1377 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001378 * .memexitconst => __memconst
1379 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001380 *
1381 * The memory of returned value has been allocated on a heap. The user of this
1382 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001383*/
1384static char *sec2annotation(const char *s)
1385{
1386 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001387 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001388 char *r = p;
1389
1390 *p++ = '_';
1391 *p++ = '_';
1392 if (*s == '.')
1393 s++;
1394 while (*s && *s != '.')
1395 *p++ = *s++;
1396 *p = '\0';
1397 if (*s == '.')
1398 s++;
1399 if (strstr(s, "rodata") != NULL)
1400 strcat(p, "const ");
1401 else if (strstr(s, "data") != NULL)
1402 strcat(p, "data ");
1403 else
1404 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001405 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001406 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001407 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001408 }
1409}
1410
1411static int is_function(Elf_Sym *sym)
1412{
1413 if (sym)
1414 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1415 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001416 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001417}
1418
Randy Dunlap00759c02011-03-15 14:13:47 -07001419static void print_section_list(const char * const list[20])
1420{
1421 const char *const *s = list;
1422
1423 while (*s) {
1424 fprintf(stderr, "%s", *s);
1425 s++;
1426 if (*s)
1427 fprintf(stderr, ", ");
1428 }
1429 fprintf(stderr, "\n");
1430}
1431
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301432static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1433{
1434 switch (is_func) {
1435 case 0: *name = "variable"; *name_p = ""; break;
1436 case 1: *name = "function"; *name_p = "()"; break;
1437 default: *name = "(unknown reference)"; *name_p = ""; break;
1438 }
1439}
1440
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001441/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001442 * Print a warning about a section mismatch.
1443 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001444 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001445 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001446static void report_sec_mismatch(const char *modname,
1447 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001448 const char *fromsec,
1449 unsigned long long fromaddr,
1450 const char *fromsym,
1451 int from_is_func,
1452 const char *tosec, const char *tosym,
1453 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001454{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001455 const char *from, *from_p;
1456 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001457 char *prl_from;
1458 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001459
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001460 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001461
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301462 get_pretty_name(from_is_func, &from, &from_p);
1463 get_pretty_name(to_is_func, &to, &to_p);
1464
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001465 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1466 "to the %s %s:%s%s\n",
1467 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1468 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001469
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001470 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001471 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001472 prl_from = sec2annotation(fromsec);
1473 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001474 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001475 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001476 "the %s %s%s%s.\n"
1477 "This is often because %s lacks a %s\n"
1478 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001479 prl_from, fromsym,
1480 to, prl_to, tosym, to_p,
1481 fromsym, prl_to, tosym);
1482 free(prl_from);
1483 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001484 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001485 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001486 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001487 fprintf(stderr,
1488 "The variable %s references\n"
1489 "the %s %s%s%s\n"
1490 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001491 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001492 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001493 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001494 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001495 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001496 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001497 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001498 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001499 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001500 fprintf(stderr,
1501 "The function %s() references a %s in an exit section.\n"
1502 "Often the %s %s%s has valid usage outside the exit section\n"
1503 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001504 fromsym, to, to, tosym, to_p, prl_to, tosym);
1505 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001506 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001507 case DATA_TO_ANY_EXIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001508 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001509 fprintf(stderr,
1510 "The variable %s references\n"
1511 "the %s %s%s%s\n"
1512 "If the reference is valid then annotate the\n"
1513 "variable with __exit* (see linux/init.h) or "
1514 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001515 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001516 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001517 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001518 break;
1519 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001520 case XXXINIT_TO_SOME_INIT:
1521 case XXXEXIT_TO_SOME_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001522 prl_from = sec2annotation(fromsec);
1523 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001524 fprintf(stderr,
1525 "The %s %s%s%s references\n"
1526 "a %s %s%s%s.\n"
1527 "If %s is only used by %s then\n"
1528 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001529 from, prl_from, fromsym, from_p,
1530 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001531 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001532 free(prl_from);
1533 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001534 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001535 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001536 prl_from = sec2annotation(fromsec);
1537 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001538 fprintf(stderr,
1539 "The %s %s%s%s references\n"
1540 "a %s %s%s%s.\n"
1541 "This is often seen when error handling "
1542 "in the init function\n"
1543 "uses functionality in the exit path.\n"
1544 "The fix is often to remove the %sannotation of\n"
1545 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001546 from, prl_from, fromsym, from_p,
1547 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001548 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001549 free(prl_from);
1550 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001551 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001552 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001553 prl_from = sec2annotation(fromsec);
1554 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001555 fprintf(stderr,
1556 "The %s %s%s%s references\n"
1557 "a %s %s%s%s.\n"
1558 "This is often seen when error handling "
1559 "in the exit function\n"
1560 "uses functionality in the init path.\n"
1561 "The fix is often to remove the %sannotation of\n"
1562 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001563 from, prl_from, fromsym, from_p,
1564 to, prl_to, tosym, to_p,
1565 prl_to, tosym, to_p);
1566 free(prl_from);
1567 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001568 break;
1569 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001570 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001571 fprintf(stderr,
1572 "The symbol %s is exported and annotated %s\n"
1573 "Fix this by removing the %sannotation of %s "
1574 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001575 tosym, prl_to, prl_to, tosym);
1576 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001577 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301578 case EXTABLE_TO_NON_TEXT:
1579 fatal("There's a special handler for this mismatch type, "
1580 "we should never get here.");
1581 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001582 }
1583 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001584}
1585
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301586static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1587 const struct sectioncheck* const mismatch,
1588 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1589{
1590 const char *tosec;
1591 Elf_Sym *to;
1592 Elf_Sym *from;
1593 const char *tosym;
1594 const char *fromsym;
1595
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301596 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1597 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301598
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001599 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301600 return;
1601
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301602 tosec = sec_name(elf, get_secindex(elf, sym));
1603 to = find_elf_symbol(elf, r->r_addend, sym);
1604 tosym = sym_name(elf, to);
1605
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301606 /* check whitelist - we may ignore it */
1607 if (secref_whitelist(mismatch,
1608 fromsec, fromsym, tosec, tosym)) {
1609 report_sec_mismatch(modname, mismatch,
1610 fromsec, r->r_offset, fromsym,
1611 is_function(from), tosec, tosym,
1612 is_function(to));
1613 }
1614}
1615
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301616static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1617{
1618 if (section_index > elf->num_sections)
1619 fatal("section_index is outside elf->num_sections!\n");
1620
1621 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1622}
1623
1624/*
1625 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1626 * to know the sizeof(struct exception_table_entry) for the target architecture.
1627 */
1628static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301629static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301630{
1631 /*
1632 * If we're currently checking the second relocation within __ex_table,
1633 * that relocation offset tells us the offsetof(struct
1634 * exception_table_entry, fixup) which is equal to sizeof(struct
1635 * exception_table_entry) divided by two. We use that to our advantage
1636 * since there's no portable way to get that size as every architecture
1637 * seems to go with different sized types. Not pretty but better than
1638 * hard-coding the size for every architecture..
1639 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301640 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301641 extable_entry_size = r->r_offset * 2;
1642}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301643
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301644static inline bool is_extable_fault_address(Elf_Rela *r)
1645{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301646 /*
1647 * extable_entry_size is only discovered after we've handled the
1648 * _second_ relocation in __ex_table, so only abort when we're not
1649 * handling the first reloc and extable_entry_size is zero.
1650 */
1651 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301652 fatal("extable_entry size hasn't been discovered!\n");
1653
1654 return ((r->r_offset == 0) ||
1655 (r->r_offset % extable_entry_size == 0));
1656}
1657
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301658#define is_second_extable_reloc(Start, Cur, Sec) \
1659 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1660
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301661static void report_extable_warnings(const char* modname, struct elf_info* elf,
1662 const struct sectioncheck* const mismatch,
1663 Elf_Rela* r, Elf_Sym* sym,
1664 const char* fromsec, const char* tosec)
1665{
1666 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1667 const char* fromsym_name = sym_name(elf, fromsym);
1668 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1669 const char* tosym_name = sym_name(elf, tosym);
1670 const char* from_pretty_name;
1671 const char* from_pretty_name_p;
1672 const char* to_pretty_name;
1673 const char* to_pretty_name_p;
1674
1675 get_pretty_name(is_function(fromsym),
1676 &from_pretty_name, &from_pretty_name_p);
1677 get_pretty_name(is_function(tosym),
1678 &to_pretty_name, &to_pretty_name_p);
1679
1680 warn("%s(%s+0x%lx): Section mismatch in reference"
1681 " from the %s %s%s to the %s %s:%s%s\n",
1682 modname, fromsec, (long)r->r_offset, from_pretty_name,
1683 fromsym_name, from_pretty_name_p,
1684 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1685
1686 if (!match(tosec, mismatch->bad_tosec) &&
1687 is_executable_section(elf, get_secindex(elf, sym)))
1688 fprintf(stderr,
1689 "The relocation at %s+0x%lx references\n"
1690 "section \"%s\" which is not in the list of\n"
1691 "authorized sections. If you're adding a new section\n"
1692 "and/or if this reference is valid, add \"%s\" to the\n"
1693 "list of authorized sections to jump to on fault.\n"
1694 "This can be achieved by adding \"%s\" to \n"
1695 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1696 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1697}
1698
1699static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1700 const struct sectioncheck* const mismatch,
1701 Elf_Rela* r, Elf_Sym* sym,
1702 const char *fromsec)
1703{
1704 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1705
1706 sec_mismatch_count++;
1707
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001708 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301709
1710 if (match(tosec, mismatch->bad_tosec))
1711 fatal("The relocation at %s+0x%lx references\n"
1712 "section \"%s\" which is black-listed.\n"
1713 "Something is seriously wrong and should be fixed.\n"
1714 "You might get more information about where this is\n"
1715 "coming from by using scripts/check_extable.sh %s\n",
1716 fromsec, (long)r->r_offset, tosec, modname);
1717 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1718 if (is_extable_fault_address(r))
1719 fatal("The relocation at %s+0x%lx references\n"
1720 "section \"%s\" which is not executable, IOW\n"
1721 "it is not possible for the kernel to fault\n"
1722 "at that address. Something is seriously wrong\n"
1723 "and should be fixed.\n",
1724 fromsec, (long)r->r_offset, tosec);
1725 else
1726 fatal("The relocation at %s+0x%lx references\n"
1727 "section \"%s\" which is not executable, IOW\n"
1728 "the kernel will fault if it ever tries to\n"
1729 "jump to it. Something is seriously wrong\n"
1730 "and should be fixed.\n",
1731 fromsec, (long)r->r_offset, tosec);
1732 }
1733}
1734
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001735static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001736 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001737{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001738 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301739 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001740
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001741 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301742 if (mismatch->handler)
1743 mismatch->handler(modname, elf, mismatch,
1744 r, sym, fromsec);
1745 else
1746 default_mismatch_handler(modname, elf, mismatch,
1747 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001748 }
1749}
1750
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001751static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001752 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001753{
1754 Elf_Shdr *sechdrs = elf->sechdrs;
Anders Kaseorg68457562011-05-19 16:55:27 -06001755 int section = sechdr->sh_info;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001756
1757 return (void *)elf->hdr + sechdrs[section].sh_offset +
Olof Johansson731ece42010-12-10 02:09:23 -06001758 r->r_offset;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001759}
1760
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001761static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001762{
1763 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001764 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001765
1766 switch (r_typ) {
1767 case R_386_32:
1768 r->r_addend = TO_NATIVE(*location);
1769 break;
1770 case R_386_PC32:
1771 r->r_addend = TO_NATIVE(*location) + 4;
1772 /* For CONFIG_RELOCATABLE=y */
1773 if (elf->hdr->e_type == ET_EXEC)
1774 r->r_addend += r->r_offset;
1775 break;
1776 }
1777 return 0;
1778}
1779
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001780#ifndef R_ARM_CALL
1781#define R_ARM_CALL 28
1782#endif
1783#ifndef R_ARM_JUMP24
1784#define R_ARM_JUMP24 29
1785#endif
1786
David A. Longc9698e52014-02-14 22:41:18 +01001787#ifndef R_ARM_THM_CALL
1788#define R_ARM_THM_CALL 10
1789#endif
1790#ifndef R_ARM_THM_JUMP24
1791#define R_ARM_THM_JUMP24 30
1792#endif
1793#ifndef R_ARM_THM_JUMP19
1794#define R_ARM_THM_JUMP19 51
1795#endif
1796
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001797static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001798{
1799 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1800
1801 switch (r_typ) {
1802 case R_ARM_ABS32:
1803 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001804 r->r_addend = (int)(long)
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001805 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001806 break;
1807 case R_ARM_PC24:
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001808 case R_ARM_CALL:
1809 case R_ARM_JUMP24:
David A. Longc9698e52014-02-14 22:41:18 +01001810 case R_ARM_THM_CALL:
1811 case R_ARM_THM_JUMP24:
1812 case R_ARM_THM_JUMP19:
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001813 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001814 r->r_addend = (int)(long)(elf->hdr +
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001815 sechdr->sh_offset +
1816 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001817 break;
1818 default:
1819 return 1;
1820 }
1821 return 0;
1822}
1823
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001824static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001825{
1826 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001827 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001828 unsigned int inst;
1829
1830 if (r_typ == R_MIPS_HI16)
1831 return 1; /* skip this */
1832 inst = TO_NATIVE(*location);
1833 switch (r_typ) {
1834 case R_MIPS_LO16:
1835 r->r_addend = inst & 0xffff;
1836 break;
1837 case R_MIPS_26:
1838 r->r_addend = (inst & 0x03ffffff) << 2;
1839 break;
1840 case R_MIPS_32:
1841 r->r_addend = inst;
1842 break;
1843 }
1844 return 0;
1845}
1846
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001847static void section_rela(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001848 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001849{
1850 Elf_Sym *sym;
1851 Elf_Rela *rela;
1852 Elf_Rela r;
1853 unsigned int r_sym;
1854 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001855
Sam Ravnborgff13f922008-01-23 19:54:27 +01001856 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001857 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1858
Sam Ravnborgff13f922008-01-23 19:54:27 +01001859 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001860 fromsec += strlen(".rela");
1861 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001862 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001863 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001864
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001865 for (rela = start; rela < stop; rela++) {
1866 r.r_offset = TO_NATIVE(rela->r_offset);
1867#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001868 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001869 unsigned int r_typ;
1870 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1871 r_sym = TO_NATIVE(r_sym);
1872 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1873 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1874 } else {
1875 r.r_info = TO_NATIVE(rela->r_info);
1876 r_sym = ELF_R_SYM(r.r_info);
1877 }
1878#else
1879 r.r_info = TO_NATIVE(rela->r_info);
1880 r_sym = ELF_R_SYM(r.r_info);
1881#endif
1882 r.r_addend = TO_NATIVE(rela->r_addend);
1883 sym = elf->symtab_start + r_sym;
1884 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001885 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001886 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301887 if (is_second_extable_reloc(start, rela, fromsec))
1888 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001889 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001890 }
1891}
1892
1893static void section_rel(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001894 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001895{
1896 Elf_Sym *sym;
1897 Elf_Rel *rel;
1898 Elf_Rela r;
1899 unsigned int r_sym;
1900 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001901
Sam Ravnborgff13f922008-01-23 19:54:27 +01001902 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001903 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1904
Sam Ravnborgff13f922008-01-23 19:54:27 +01001905 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001906 fromsec += strlen(".rel");
1907 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001908 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001909 return;
1910
1911 for (rel = start; rel < stop; rel++) {
1912 r.r_offset = TO_NATIVE(rel->r_offset);
1913#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001914 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001915 unsigned int r_typ;
1916 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1917 r_sym = TO_NATIVE(r_sym);
1918 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1919 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1920 } else {
1921 r.r_info = TO_NATIVE(rel->r_info);
1922 r_sym = ELF_R_SYM(r.r_info);
1923 }
1924#else
1925 r.r_info = TO_NATIVE(rel->r_info);
1926 r_sym = ELF_R_SYM(r.r_info);
1927#endif
1928 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001929 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001930 case EM_386:
1931 if (addend_386_rel(elf, sechdr, &r))
1932 continue;
1933 break;
1934 case EM_ARM:
1935 if (addend_arm_rel(elf, sechdr, &r))
1936 continue;
1937 break;
1938 case EM_MIPS:
1939 if (addend_mips_rel(elf, sechdr, &r))
1940 continue;
1941 break;
1942 }
1943 sym = elf->symtab_start + r_sym;
1944 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001945 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001946 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301947 if (is_second_extable_reloc(start, rel, fromsec))
1948 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001949 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001950 }
1951}
1952
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001953/**
1954 * A module includes a number of sections that are discarded
1955 * either when loaded or when used as built-in.
1956 * For loaded modules all functions marked __init and all data
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001957 * marked __initdata will be discarded when the module has been initialized.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001958 * Likewise for modules used built-in the sections marked __exit
1959 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001960 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001961 * The check_sec_ref() function traverses all relocation records
1962 * to find all references to a section that reference a section that will
1963 * be discarded and warns about it.
1964 **/
1965static void check_sec_ref(struct module *mod, const char *modname,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001966 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001967{
1968 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001969 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001970
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001971 /* Walk through all sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001972 for (i = 0; i < elf->num_sections; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001973 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001974 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001975 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001976 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001977 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001978 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001979 }
1980}
1981
Andi Kleen7d02b492014-02-08 09:01:12 +01001982static char *remove_dot(char *s)
1983{
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301984 size_t n = strcspn(s, ".");
Andi Kleen7d02b492014-02-08 09:01:12 +01001985
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301986 if (n && s[n]) {
1987 size_t m = strspn(s + n + 1, "0123456789");
1988 if (m && (s[n + m] == '.' || s[n + m] == 0))
Andi Kleen7d02b492014-02-08 09:01:12 +01001989 s[n] = 0;
1990 }
1991 return s;
1992}
1993
Masahiro Yamada8b185742018-05-09 18:50:40 +09001994static void read_symbols(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995{
1996 const char *symname;
1997 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001998 char *license;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01001999 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 struct module *mod;
2001 struct elf_info info = { };
2002 Elf_Sym *sym;
2003
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01002004 if (!parse_elf(&info, modname))
2005 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
2007 mod = new_module(modname);
2008
2009 /* When there's no vmlinux, don't print warnings about
2010 * unresolved symbols (since there'll be too many ;) */
2011 if (is_vmlinux(modname)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 have_vmlinux = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 mod->skip = 1;
2014 }
2015
Masahiro Yamadabca2cce2018-05-09 18:50:37 +09002016 license = get_modinfo(&info, "license");
Randy Dunlapba1029c2017-11-12 11:21:45 -08002017 if (!license && !is_vmlinux(modname))
Jessica Yu93c95e52020-03-06 17:02:05 +01002018 warn("missing MODULE_LICENSE() in %s\n"
Sam Ravnborg2fa36562008-04-26 21:07:26 +02002019 "see include/linux/module.h for "
2020 "more information\n", modname);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002021 while (license) {
2022 if (license_is_gpl_compatible(license))
2023 mod->gpl_compatible = 1;
2024 else {
2025 mod->gpl_compatible = 0;
2026 break;
2027 }
Masahiro Yamadabca2cce2018-05-09 18:50:37 +09002028 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002029 }
2030
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002031 namespace = get_modinfo(&info, "import_ns");
2032 while (namespace) {
2033 add_namespace(&mod->imported_namespaces, namespace);
2034 namespace = get_next_modinfo(&info, "import_ns", namespace);
2035 }
2036
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002038 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002040 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 handle_moddevtable(mod, &info, sym, symname);
2042 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002043
Matthias Maennich69923202019-10-18 10:31:42 +01002044 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2045 symname = remove_dot(info.strtab + sym->st_name);
2046
Masahiro Yamada17436942019-11-15 02:42:24 +09002047 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002048 if (strstarts(symname, "__kstrtabns_"))
2049 sym_update_namespace(symname + strlen("__kstrtabns_"),
2050 namespace_from_kstrtabns(&info,
2051 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002052
2053 if (strstarts(symname, "__crc_"))
2054 handle_modversion(mod, &info, sym,
2055 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002056 }
2057
Denis Efremov15bfc232019-08-01 09:06:57 +03002058 // check for static EXPORT_SYMBOL_* functions && global vars
2059 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2060 unsigned char bind = ELF_ST_BIND(sym->st_info);
2061
2062 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2063 struct symbol *s =
2064 find_symbol(remove_dot(info.strtab +
2065 sym->st_name));
2066
2067 if (s)
2068 s->is_static = 0;
2069 }
2070 }
2071
Masahiro Yamada074a04f2018-05-09 18:50:39 +09002072 if (!is_vmlinux(modname) || vmlinux_section_warnings)
Sam Ravnborg10668222008-01-13 22:21:31 +01002073 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074
Masahiro Yamadabca2cce2018-05-09 18:50:37 +09002075 version = get_modinfo(&info, "version");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 if (version)
2077 maybe_frob_rcs_version(modname, version, info.modinfo,
2078 version - (char *)info.hdr);
2079 if (version || (all_versions && !is_vmlinux(modname)))
2080 get_src_version(modname, mod->srcversion,
2081 sizeof(mod->srcversion)-1);
2082
2083 parse_elf_finish(&info);
2084
Rusty Russell8c8ef422009-03-31 13:05:34 -06002085 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 * never passed as an argument to an exported function, so
2087 * the automatic versioning doesn't pick it up, but it's really
2088 * important anyhow */
2089 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06002090 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091}
2092
Rusty Russell712f9b42013-04-04 17:37:38 +10302093static void read_symbols_from_files(const char *filename)
2094{
2095 FILE *in = stdin;
2096 char fname[PATH_MAX];
2097
2098 if (strcmp(filename, "-") != 0) {
2099 in = fopen(filename, "r");
2100 if (!in)
2101 fatal("Can't open filenames file %s: %m", filename);
2102 }
2103
2104 while (fgets(fname, PATH_MAX, in) != NULL) {
2105 if (strends(fname, "\n"))
2106 fname[strlen(fname)-1] = '\0';
2107 read_symbols(fname);
2108 }
2109
2110 if (in != stdin)
2111 fclose(in);
2112}
2113
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114#define SZ 500
2115
2116/* We first write the generated file into memory using the
2117 * following helper, then compare to the file on disk and
2118 * only update the later if anything changed */
2119
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002120void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
2121 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122{
2123 char tmp[SZ];
2124 int len;
2125 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002126
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 va_start(ap, fmt);
2128 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002129 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 va_end(ap);
2131}
2132
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002133void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134{
2135 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002136 buf->size += len + SZ;
Randy Dunlap1f3aa902018-08-15 12:30:38 -07002137 buf->p = NOFAIL(realloc(buf->p, buf->size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 }
2139 strncpy(buf->p + buf->pos, s, len);
2140 buf->pos += len;
2141}
2142
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002143static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
2144{
2145 const char *e = is_vmlinux(m) ?"":".ko";
2146
2147 switch (exp) {
2148 case export_gpl:
Jessica Yu93c95e52020-03-06 17:02:05 +01002149 fatal("GPL-incompatible module %s%s "
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002150 "uses GPL-only symbol '%s'\n", m, e, s);
2151 break;
2152 case export_unused_gpl:
Jessica Yu93c95e52020-03-06 17:02:05 +01002153 fatal("GPL-incompatible module %s%s "
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002154 "uses GPL-only symbol marked UNUSED '%s'\n", m, e, s);
2155 break;
2156 case export_gpl_future:
Jessica Yu93c95e52020-03-06 17:02:05 +01002157 warn("GPL-incompatible module %s%s "
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002158 "uses future GPL-only symbol '%s'\n", m, e, s);
2159 break;
2160 case export_plain:
2161 case export_unused:
2162 case export_unknown:
2163 /* ignore */
2164 break;
2165 }
2166}
2167
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002168static void check_for_unused(enum export exp, const char *m, const char *s)
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002169{
2170 const char *e = is_vmlinux(m) ?"":".ko";
2171
2172 switch (exp) {
2173 case export_unused:
2174 case export_unused_gpl:
Jessica Yu93c95e52020-03-06 17:02:05 +01002175 warn("module %s%s "
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002176 "uses symbol '%s' marked UNUSED\n", m, e, s);
2177 break;
2178 default:
2179 /* ignore */
2180 break;
2181 }
2182}
2183
Masahiro Yamada3b415282018-11-23 16:57:23 +09002184static int check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002185{
2186 struct symbol *s, *exp;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002187 int err = 0;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002188
2189 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002190 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002191 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002192 if (!exp || exp->module == mod) {
2193 if (have_vmlinux && !s->weak) {
Jessica Yu93c95e52020-03-06 17:02:05 +01002194 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2195 "\"%s\" [%s.ko] undefined!\n",
2196 s->name, mod->name);
2197 if (!warn_unresolved)
Masahiro Yamada3b415282018-11-23 16:57:23 +09002198 err = 1;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002199 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002200 continue;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002201 }
Andrew Morton6449bd62006-06-09 20:45:06 -07002202 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002203 if (basename)
2204 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002205 else
2206 basename = mod->name;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002207
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002208 if (exp->namespace &&
2209 !module_imports_namespace(mod, exp->namespace)) {
Jessica Yu54b77842020-03-06 17:02:06 +01002210 modpost_log(allow_missing_ns_imports ? LOG_WARN : LOG_ERROR,
2211 "module %s uses symbol %s from namespace %s, but does not import it.\n",
2212 basename, exp->name, exp->namespace);
2213 if (!allow_missing_ns_imports)
2214 err = 1;
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002215 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002216 }
2217
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002218 if (!mod->gpl_compatible)
2219 check_for_gpl_usage(exp->export, basename, exp->name);
2220 check_for_unused(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002221 }
Masahiro Yamada3b415282018-11-23 16:57:23 +09002222
2223 return err;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002224}
2225
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002226static int check_modname_len(struct module *mod)
2227{
2228 const char *mod_name;
2229
2230 mod_name = strrchr(mod->name, '/');
2231 if (mod_name == NULL)
2232 mod_name = mod->name;
2233 else
2234 mod_name++;
2235 if (strlen(mod_name) >= MODULE_NAME_LEN) {
2236 merror("module name is too long [%s.ko]\n", mod->name);
2237 return 1;
2238 }
2239
2240 return 0;
2241}
2242
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002243/**
2244 * Header for the generated file
2245 **/
2246static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247{
Laura Abbott9afb7192018-07-05 17:49:37 -07002248 buf_printf(b, "#include <linux/build-salt.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 buf_printf(b, "#include <linux/module.h>\n");
2250 buf_printf(b, "#include <linux/vermagic.h>\n");
2251 buf_printf(b, "#include <linux/compiler.h>\n");
2252 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002253 buf_printf(b, "BUILD_SALT;\n");
2254 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002256 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302258 buf_printf(b, "__visible struct module __this_module\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002259 buf_printf(b, "__section(.gnu.linkonce.this_module) = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002260 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002262 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 if (mod->has_cleanup)
2264 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002265 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002267 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268 buf_printf(b, "};\n");
2269}
2270
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002271static void add_intree_flag(struct buffer *b, int is_intree)
2272{
2273 if (is_intree)
2274 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2275}
2276
Andi Kleencaf75012018-01-25 15:50:28 -08002277/* Cannot check for assembler */
2278static void add_retpoline(struct buffer *b)
2279{
WANG Chaoe4f35892018-12-11 00:37:25 +08002280 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002281 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2282 buf_printf(b, "#endif\n");
2283}
2284
Trevor Keith5c725132009-09-22 16:43:38 -07002285static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002286{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002287 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002288 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2289}
2290
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002291/**
2292 * Record CRCs for unresolved symbols
2293 **/
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002294static int add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295{
2296 struct symbol *s, *exp;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002297 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298
2299 for (s = mod->unres; s; s = s->next) {
2300 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002301 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 s->module = exp->module;
2304 s->crc_valid = exp->crc_valid;
2305 s->crc = exp->crc;
2306 }
2307
2308 if (!modversions)
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002309 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310
2311 buf_printf(b, "\n");
2312 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002313 buf_printf(b, "__used __section(__versions) = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314
2315 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002316 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002319 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 s->name, mod->name);
2321 continue;
2322 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302323 if (strlen(s->name) >= MODULE_NAME_LEN) {
2324 merror("too long symbol \"%s\" [%s.ko]\n",
2325 s->name, mod->name);
2326 err = 1;
2327 break;
2328 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002329 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302330 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 }
2332
2333 buf_printf(b, "};\n");
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002334
2335 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336}
2337
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002338static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339{
2340 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 int first = 1;
2342
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002343 /* Clear ->seen flag of modules that own symbols needed by this. */
2344 for (s = mod->unres; s; s = s->next)
2345 if (s->module)
2346 s->module->seen = is_vmlinux(s->module->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347
2348 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002349 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002351 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 if (!s->module)
2353 continue;
2354
2355 if (s->module->seen)
2356 continue;
2357
2358 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002359 p = strrchr(s->module->name, '/');
2360 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002361 p++;
2362 else
2363 p = s->module->name;
2364 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 first = 0;
2366 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002367 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368}
2369
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002370static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371{
2372 if (mod->srcversion[0]) {
2373 buf_printf(b, "\n");
2374 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2375 mod->srcversion);
2376 }
2377}
2378
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002379static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380{
2381 char *tmp;
2382 FILE *file;
2383 struct stat st;
2384
2385 file = fopen(fname, "r");
2386 if (!file)
2387 goto write;
2388
2389 if (fstat(fileno(file), &st) < 0)
2390 goto close_write;
2391
2392 if (st.st_size != b->pos)
2393 goto close_write;
2394
2395 tmp = NOFAIL(malloc(b->pos));
2396 if (fread(tmp, 1, b->pos, file) != b->pos)
2397 goto free_write;
2398
2399 if (memcmp(tmp, b->p, b->pos) != 0)
2400 goto free_write;
2401
2402 free(tmp);
2403 fclose(file);
2404 return;
2405
2406 free_write:
2407 free(tmp);
2408 close_write:
2409 fclose(file);
2410 write:
2411 file = fopen(fname, "w");
2412 if (!file) {
2413 perror(fname);
2414 exit(1);
2415 }
2416 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2417 perror(fname);
2418 exit(1);
2419 }
2420 fclose(file);
2421}
2422
Ram Paibd5cbce2006-06-08 22:12:53 -07002423/* parse Module.symvers file. line format:
Sam Ravnborg534b89a2006-07-01 10:10:19 +02002424 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
Ram Paibd5cbce2006-06-08 22:12:53 -07002425 **/
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002426static void read_dump(const char *fname, unsigned int kernel)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427{
2428 unsigned long size, pos = 0;
2429 void *file = grab_file(fname, &size);
2430 char *line;
2431
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002432 if (!file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433 /* No symbol versions, silently ignore */
2434 return;
2435
2436 while ((line = get_next_line(&pos, file, size))) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002437 char *symname, *namespace, *modname, *d, *export, *end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 unsigned int crc;
2439 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002440 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441
2442 if (!(symname = strchr(line, '\t')))
2443 goto fail;
2444 *symname++ = '\0';
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002445 if (!(namespace = strchr(symname, '\t')))
2446 goto fail;
2447 *namespace++ = '\0';
2448 if (!(modname = strchr(namespace, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 goto fail;
2450 *modname++ = '\0';
Laurent Riffard9ac545b2006-06-11 08:02:06 +02002451 if ((export = strchr(modname, '\t')) != NULL)
Ram Paibd5cbce2006-06-08 22:12:53 -07002452 *export++ = '\0';
Sam Ravnborg534b89a2006-07-01 10:10:19 +02002453 if (export && ((end = strchr(export, '\t')) != NULL))
2454 *end = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 crc = strtoul(line, &d, 16);
2456 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2457 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002458 mod = find_module(modname);
2459 if (!mod) {
2460 if (is_vmlinux(modname))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 have_vmlinux = 1;
Jan Beulich0fa3a882009-03-12 12:28:30 +00002462 mod = new_module(modname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 mod->skip = 1;
2464 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002465 s = sym_add_exported(symname, mod, export_no(export));
Sam Ravnborg8e70c452006-01-28 22:22:33 +01002466 s->kernel = kernel;
Denis Efremov15bfc232019-08-01 09:06:57 +03002467 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002468 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002469 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 }
Christian Engelmayer2ee41e62014-04-28 11:34:32 +09302471 release_file(file, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 return;
2473fail:
Christian Engelmayer2ee41e62014-04-28 11:34:32 +09302474 release_file(file, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475 fatal("parse error in symbol dump file\n");
2476}
2477
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002478/* For normal builds always dump all symbols.
2479 * For external modules only dump symbols
2480 * that are not read from kernel Module.symvers.
2481 **/
2482static int dump_sym(struct symbol *sym)
2483{
2484 if (!external_module)
2485 return 1;
2486 if (sym->vmlinux || sym->kernel)
2487 return 0;
2488 return 1;
2489}
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002490
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002491static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492{
2493 struct buffer buf = { };
2494 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002495 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 int n;
2497
2498 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2499 symbol = symbolhash[n];
2500 while (symbol) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002501 if (dump_sym(symbol)) {
2502 namespace = symbol->namespace;
2503 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2504 symbol->crc, symbol->name,
2505 namespace ? namespace : "",
2506 symbol->module->name,
2507 export_str(symbol->export));
2508 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509 symbol = symbol->next;
2510 }
2511 }
2512 write_if_changed(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002513 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514}
2515
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002516static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002517{
2518 struct module *mod;
2519 struct namespace_list *ns;
2520 struct buffer ns_deps_buf = {};
2521
2522 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002523
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002524 if (mod->skip || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002525 continue;
2526
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002527 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002528
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002529 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2530 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002531
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002532 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002533 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002534
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002535 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002536 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002537}
2538
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002539struct ext_sym_list {
2540 struct ext_sym_list *next;
2541 const char *file;
2542};
2543
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002544int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545{
2546 struct module *mod;
2547 struct buffer buf = { };
Masahiro Yamada39808e42019-10-03 19:29:14 +09002548 char *kernel_read = NULL;
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002549 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302550 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551 int opt;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002552 int err;
Denis Efremov15bfc232019-08-01 09:06:57 +03002553 int n;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002554 struct ext_sym_list *extsym_iter;
2555 struct ext_sym_list *extsym_start = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556
Jessica Yu54b77842020-03-06 17:02:06 +01002557 while ((opt = getopt(argc, argv, "i:e:mnsT:o:awENd:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002558 switch (opt) {
2559 case 'i':
2560 kernel_read = optarg;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002561 external_module = 1;
2562 break;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002563 case 'e':
2564 external_module = 1;
2565 extsym_iter =
2566 NOFAIL(malloc(sizeof(*extsym_iter)));
2567 extsym_iter->next = extsym_start;
2568 extsym_iter->file = optarg;
2569 extsym_start = extsym_iter;
2570 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002571 case 'm':
2572 modversions = 1;
2573 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302574 case 'n':
2575 ignore_missing_files = 1;
2576 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002577 case 'o':
2578 dump_write = optarg;
2579 break;
2580 case 'a':
2581 all_versions = 1;
2582 break;
2583 case 's':
2584 vmlinux_section_warnings = 0;
2585 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302586 case 'T':
2587 files_source = optarg;
2588 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002589 case 'w':
2590 warn_unresolved = 1;
2591 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302592 case 'E':
2593 sec_mismatch_fatal = 1;
2594 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002595 case 'N':
2596 allow_missing_ns_imports = 1;
2597 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002598 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002599 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002600 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002601 default:
2602 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 }
2604 }
2605
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002606 if (kernel_read)
2607 read_dump(kernel_read, 1);
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002608 while (extsym_start) {
2609 read_dump(extsym_start->file, 0);
2610 extsym_iter = extsym_start->next;
2611 free(extsym_start);
2612 extsym_start = extsym_iter;
2613 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002615 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617
Rusty Russell712f9b42013-04-04 17:37:38 +10302618 if (files_source)
2619 read_symbols_from_files(files_source);
2620
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002621 err = 0;
2622
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002623 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302624 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002625
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002626 if (mod->skip)
2627 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002628
2629 buf.pos = 0;
2630
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002631 err |= check_modname_len(mod);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002632 err |= check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002633
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002635 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002636 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002637 add_staging_flag(&buf, mod->name);
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002638 err |= add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002639 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640 add_moddevtable(&buf, mod);
2641 add_srcversion(&buf, mod);
2642
2643 sprintf(fname, "%s.mod.c", mod->name);
2644 write_if_changed(&buf, fname);
2645 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002646
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002647 if (missing_namespace_deps)
2648 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002649
Linus Torvalds1da177e2005-04-16 15:20:36 -07002650 if (dump_write)
2651 write_dump(dump_write);
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002652 if (sec_mismatch_count && sec_mismatch_fatal)
Jessica Yu93c95e52020-03-06 17:02:05 +01002653 fatal("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002654 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002655 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002656 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002657
Masahiro Yamada47346e92019-09-24 21:07:40 +09002658 for (s = symbolhash[n]; s; s = s->next) {
2659 /*
2660 * Do not check "vmlinux". This avoids the same warnings
2661 * shown twice, and false-positives for ARCH=um.
2662 */
2663 if (is_vmlinux(s->module->name) && !s->module->is_dot_o)
2664 continue;
2665
Denis Efremov15bfc232019-08-01 09:06:57 +03002666 if (s->is_static)
2667 warn("\"%s\" [%s] is a static %s\n",
2668 s->name, s->module->name,
2669 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002670 }
2671 }
2672
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002673 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002675 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002676}