blob: 5224a02edbf27494769e474be1fa7b56f4644d2a [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 */
Gustavo A. R. Silva859c8172020-05-07 13:56:01 -0500169 char name[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170};
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 Yamadad2e4d052020-05-25 14:47:04 +0900291static void *sym_get_data_by_offset(const struct elf_info *info,
292 unsigned int secindex, unsigned long offset)
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900293{
Xiao Yang4b8a5cf2020-03-18 18:34:16 +0800294 Elf_Shdr *sechdr = &info->sechdrs[secindex];
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900295
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900296 if (info->hdr->e_type != ET_REL)
297 offset -= sechdr->sh_addr;
298
299 return (void *)info->hdr + sechdr->sh_offset + offset;
300}
301
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900302static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
303{
304 return sym_get_data_by_offset(info, get_secindex(info, sym),
305 sym->st_value);
306}
307
Masahiro Yamada565587d2020-05-25 14:47:05 +0900308static const char *sech_name(const struct elf_info *info, Elf_Shdr *sechdr)
309{
310 return sym_get_data_by_offset(info, info->secindex_strings,
311 sechdr->sh_name);
312}
313
314static const char *sec_name(const struct elf_info *info, int secindex)
315{
316 return sech_name(info, &info->sechdrs[secindex]);
317}
318
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200319#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
320
321static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
322{
323 const char *secname = sec_name(elf, sec);
324
325 if (strstarts(secname, "___ksymtab+"))
326 return export_plain;
327 else if (strstarts(secname, "___ksymtab_unused+"))
328 return export_unused;
329 else if (strstarts(secname, "___ksymtab_gpl+"))
330 return export_gpl;
331 else if (strstarts(secname, "___ksymtab_unused_gpl+"))
332 return export_unused_gpl;
333 else if (strstarts(secname, "___ksymtab_gpl_future+"))
334 return export_gpl_future;
335 else
336 return export_unknown;
337}
338
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200339static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700340{
341 if (sec == elf->export_sec)
342 return export_plain;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200343 else if (sec == elf->export_unused_sec)
344 return export_unused;
Ram Paibd5cbce2006-06-08 22:12:53 -0700345 else if (sec == elf->export_gpl_sec)
346 return export_gpl;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200347 else if (sec == elf->export_unused_gpl_sec)
348 return export_unused_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700349 else if (sec == elf->export_gpl_future_sec)
350 return export_gpl_future;
351 else
352 return export_unknown;
353}
354
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900355static const char *namespace_from_kstrtabns(const struct elf_info *info,
356 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100357{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900358 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100359 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100360}
361
Matthias Maennicha2b11182019-10-18 10:31:40 +0100362static void sym_update_namespace(const char *symname, const char *namespace)
363{
364 struct symbol *s = find_symbol(symname);
365
366 /*
367 * That symbol should have been created earlier and thus this is
368 * actually an assertion.
369 */
370 if (!s) {
371 merror("Could not update namespace(%s) for symbol %s\n",
372 namespace, symname);
373 return;
374 }
375
376 free(s->namespace);
377 s->namespace =
378 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
379}
380
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100381/**
382 * Add an exported symbol - it may have already been added without a
383 * CRC, in this case just update the CRC
384 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100385static struct symbol *sym_add_exported(const char *name, struct module *mod,
386 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387{
388 struct symbol *s = find_symbol(name);
389
390 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700391 s = new_symbol(name, mod, export);
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900392 } else if (!external_module || is_vmlinux(s->module->name) ||
393 s->module == mod) {
394 warn("%s: '%s' exported twice. Previous export was in %s%s\n",
395 mod->name, name, s->module->name,
396 is_vmlinux(s->module->name) ? "" : ".ko");
397 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900399
400 s->module = mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100401 s->vmlinux = is_vmlinux(mod->name);
402 s->kernel = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -0700403 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100404 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405}
406
Masahiro Yamada17436942019-11-15 02:42:24 +0900407static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100408{
409 struct symbol *s = find_symbol(name);
410
Masahiro Yamada17436942019-11-15 02:42:24 +0900411 /*
412 * Ignore stand-alone __crc_*, which might be auto-generated symbols
413 * such as __*_veneer in ARM ELF.
414 */
415 if (!s)
416 return;
417
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100418 s->crc = crc;
419 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420}
421
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100422void *grab_file(const char *filename, unsigned long *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423{
424 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930425 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 int fd;
427
428 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930429 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930431 if (fstat(fd, &st))
432 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
434 *size = st.st_size;
435 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930437failed:
438 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 if (map == MAP_FAILED)
440 return NULL;
441 return map;
442}
443
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100444/**
445 * Return a copy of the next line in a mmap'ed file.
446 * spaces in the beginning of the line is trimmed away.
447 * Return a pointer to a static buffer.
448 **/
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100449char *get_next_line(unsigned long *pos, void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
451 static char line[4096];
452 int skip = 1;
453 size_t len = 0;
454 signed char *p = (signed char *)file + *pos;
455 char *s = line;
456
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100457 for (; *pos < size ; (*pos)++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 if (skip && isspace(*p)) {
459 p++;
460 continue;
461 }
462 skip = 0;
463 if (*p != '\n' && (*pos < size)) {
464 len++;
465 *s++ = *p++;
466 if (len > 4095)
467 break; /* Too long, stop */
468 } else {
469 /* End of string */
470 *s = '\0';
471 return line;
472 }
473 }
474 /* End of buffer */
475 return NULL;
476}
477
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100478void release_file(void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479{
480 munmap(file, size);
481}
482
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100483static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484{
485 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100486 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 Elf_Shdr *sechdrs;
488 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200489 const char *secstrings;
490 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492 hdr = grab_file(filename, &info->size);
493 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930494 if (ignore_missing_files) {
495 fprintf(stderr, "%s: %s (ignored)\n", filename,
496 strerror(errno));
497 return 0;
498 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200500 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 }
502 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100503 if (info->size < sizeof(*hdr)) {
504 /* file too small, assume this is an empty .o file */
505 return 0;
506 }
507 /* Is this a valid ELF file? */
508 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
509 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
510 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
511 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
512 /* Not an ELF file - silently ignore it */
513 return 0;
514 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200516 hdr->e_type = TO_NATIVE(hdr->e_type);
517 hdr->e_machine = TO_NATIVE(hdr->e_machine);
518 hdr->e_version = TO_NATIVE(hdr->e_version);
519 hdr->e_entry = TO_NATIVE(hdr->e_entry);
520 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
521 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
522 hdr->e_flags = TO_NATIVE(hdr->e_flags);
523 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
524 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
525 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
526 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
527 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
528 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 sechdrs = (void *)hdr + hdr->e_shoff;
530 info->sechdrs = sechdrs;
531
Petr Stetiara83710e2007-08-27 12:15:07 +0200532 /* Check if file offset is correct */
533 if (hdr->e_shoff > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100534 fatal("section header offset=%lu in file '%s' is bigger than "
535 "filesize=%lu\n", (unsigned long)hdr->e_shoff,
536 filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200537 return 0;
538 }
539
Anders Kaseorg68457562011-05-19 16:55:27 -0600540 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200541 /*
542 * There are more than 64k sections,
543 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200544 */
545 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
546 }
547 else {
548 info->num_sections = hdr->e_shnum;
549 }
550 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600551 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200552 }
553 else {
554 info->secindex_strings = hdr->e_shstrndx;
555 }
556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200558 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200559 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
560 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
561 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
562 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
563 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
564 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
565 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
566 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
567 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
568 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 }
570 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200571 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
572 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700573 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900574 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Tejun Heo56fc82c2009-02-06 00:48:02 +0900576 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100577 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
578 "sizeof(*hrd)=%zu\n", filename,
579 (unsigned long)sechdrs[i].sh_offset,
580 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100581 return 0;
582 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700583 secname = secstrings + sechdrs[i].sh_name;
584 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900585 if (nobits)
586 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
588 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700589 } else if (strcmp(secname, "__ksymtab") == 0)
590 info->export_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200591 else if (strcmp(secname, "__ksymtab_unused") == 0)
592 info->export_unused_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700593 else if (strcmp(secname, "__ksymtab_gpl") == 0)
594 info->export_gpl_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200595 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
596 info->export_unused_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700597 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
598 info->export_gpl_future_sec = i;
599
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200600 if (sechdrs[i].sh_type == SHT_SYMTAB) {
601 unsigned int sh_link_idx;
602 symtab_idx = i;
603 info->symtab_start = (void *)hdr +
604 sechdrs[i].sh_offset;
605 info->symtab_stop = (void *)hdr +
606 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600607 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200608 info->strtab = (void *)hdr +
609 sechdrs[sh_link_idx].sh_offset;
610 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200612 /* 32bit section no. table? ("more than 64k sections") */
613 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
614 symtab_shndx_idx = i;
615 info->symtab_shndx_start = (void *)hdr +
616 sechdrs[i].sh_offset;
617 info->symtab_shndx_stop = (void *)hdr +
618 sechdrs[i].sh_offset + sechdrs[i].sh_size;
619 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100621 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100622 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 /* Fix endianness in symbols */
625 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
626 sym->st_shndx = TO_NATIVE(sym->st_shndx);
627 sym->st_name = TO_NATIVE(sym->st_name);
628 sym->st_value = TO_NATIVE(sym->st_value);
629 sym->st_size = TO_NATIVE(sym->st_size);
630 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200631
632 if (symtab_shndx_idx != ~0U) {
633 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600634 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200635 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600636 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200637 symtab_idx);
638 /* Fix endianness */
639 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
640 p++)
641 *p = TO_NATIVE(*p);
642 }
643
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100644 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645}
646
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100647static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648{
649 release_file(info->hdr, info->size);
650}
651
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200652static int ignore_undef_symbol(struct elf_info *info, const char *symname)
653{
654 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900655 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200656 return 1;
657 /* ignore global offset table */
658 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
659 return 1;
660 if (info->hdr->e_machine == EM_PPC)
661 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900662 if (strstarts(symname, "_restgpr_") ||
663 strstarts(symname, "_savegpr_") ||
664 strstarts(symname, "_rest32gpr_") ||
665 strstarts(symname, "_save32gpr_") ||
666 strstarts(symname, "_restvr_") ||
667 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200668 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000669 if (info->hdr->e_machine == EM_PPC64)
670 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900671 if (strstarts(symname, "_restgpr0_") ||
672 strstarts(symname, "_savegpr0_") ||
673 strstarts(symname, "_restvr_") ||
674 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100675 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000676 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200677 /* Do not ignore this symbol */
678 return 0;
679}
680
Masahiro Yamada17436942019-11-15 02:42:24 +0900681static void handle_modversion(const struct module *mod,
682 const struct elf_info *info,
683 const Elf_Sym *sym, const char *symname)
684{
685 unsigned int crc;
686
687 if (sym->st_shndx == SHN_UNDEF) {
688 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n",
689 symname, mod->name, is_vmlinux(mod->name) ? "":".ko");
690 return;
691 }
692
693 if (sym->st_shndx == SHN_ABS) {
694 crc = sym->st_value;
695 } else {
696 unsigned int *crcp;
697
698 /* symbol points to the CRC in the ELF object */
699 crcp = sym_get_data(info, sym);
700 crc = TO_NATIVE(*crcp);
701 }
702 sym_set_crc(symname, crc);
703}
704
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900705static void handle_symbol(struct module *mod, struct elf_info *info,
706 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200708 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900709 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200710
Frank Rowand258f7422012-04-09 17:59:03 -0700711 if ((!is_vmlinux(mod->name) || mod->is_dot_o) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900712 strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200713 export = export_from_secname(info, get_secindex(info, sym));
714 else
715 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
717 switch (sym->st_shndx) {
718 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900719 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100720 /* Should warn here, but modpost runs before the linker */
721 } else
722 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 case SHN_UNDEF:
725 /* undefined symbol */
726 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
727 ELF_ST_BIND(sym->st_info) != STB_WEAK)
728 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200729 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 if (info->hdr->e_machine == EM_SPARC ||
732 info->hdr->e_machine == EM_SPARCV9) {
733 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700734 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100736 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700737 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100738 munged[0] = '_';
739 munged[1] = toupper(munged[1]);
740 symname = munged;
741 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100743
Rusty Russellb92021b2013-03-15 15:04:17 +1030744 mod->unres = alloc_symbol(symname,
745 ELF_ST_BIND(sym->st_info) == STB_WEAK,
746 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 break;
748 default:
749 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900750 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100751 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100752 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900754 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900756 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 mod->has_cleanup = 1;
758 break;
759 }
760}
761
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100762/**
763 * Parse tag=value strings from .modinfo section
764 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765static char *next_string(char *string, unsigned long *secsize)
766{
767 /* Skip non-zero chars */
768 while (string[0]) {
769 string++;
770 if ((*secsize)-- <= 1)
771 return NULL;
772 }
773
774 /* Skip any zero padding. */
775 while (!string[0]) {
776 string++;
777 if ((*secsize)-- <= 1)
778 return NULL;
779 }
780 return string;
781}
782
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900783static char *get_next_modinfo(struct elf_info *info, const char *tag,
784 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785{
786 char *p;
787 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900788 char *modinfo = info->modinfo;
789 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900791 if (prev) {
792 size -= prev - modinfo;
793 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200794 }
795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 for (p = modinfo; p; p = next_string(p, &size)) {
797 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
798 return p + taglen + 1;
799 }
800 return NULL;
801}
802
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900803static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200804
805{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900806 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200807}
808
Sam Ravnborg93684d32006-02-19 11:53:35 +0100809/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100810 * Test if string s ends in string sub
811 * return 0 if match
812 **/
813static int strrcmp(const char *s, const char *sub)
814{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100815 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100816
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100817 if (!s || !sub)
818 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100819
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100820 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100821 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100822
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100823 if ((slen == 0) || (sublen == 0))
824 return 1;
825
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100826 if (sublen > slen)
827 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100828
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100829 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100830}
831
Sam Ravnborgff13f922008-01-23 19:54:27 +0100832static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
833{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100834 if (sym)
835 return elf->strtab + sym->st_name;
836 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100837 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100838}
839
Sam Ravnborg10668222008-01-13 22:21:31 +0100840/* The pattern is an array of simple patterns.
841 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100842 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100843 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930844 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100845 */
Trevor Keith5c725132009-09-22 16:43:38 -0700846static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100847{
848 const char *p;
849 while (*pat) {
850 p = *pat++;
851 const char *endp = p + strlen(p) - 1;
852
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930853 /* "*foo*" */
854 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300855 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
856 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930857
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930858 free(bare);
859 if (here != NULL)
860 return 1;
861 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100862 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930863 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100864 if (strrcmp(sym, p + 1) == 0)
865 return 1;
866 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100867 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100868 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100869 if (strncmp(sym, p, strlen(p) - 1) == 0)
870 return 1;
871 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100872 /* no wildcards */
873 else {
874 if (strcmp(p, sym) == 0)
875 return 1;
876 }
877 }
878 /* no match */
879 return 0;
880}
881
Sam Ravnborg10668222008-01-13 22:21:31 +0100882/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930883static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200884{
885 ".comment*",
886 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930887 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800888 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000889 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200890 ".mdebug*", /* alpha, score, mips etc. */
891 ".pdr", /* alpha, score, mips etc. */
892 ".stab*",
893 ".note*",
894 ".got*",
895 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400896 ".xt.prop", /* xtensa */
897 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030898 ".arcextmap*", /* arc */
899 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030900 ".cmem*", /* EZchip */
901 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100902 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600903 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200904 NULL
905};
Sam Ravnborg10668222008-01-13 22:21:31 +0100906
Sam Ravnborge241a632008-01-28 20:13:13 +0100907/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400908 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100909 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400910 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100911 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400912static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900913 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100914{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400915 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100916
Anders Kaseorgb614a692009-04-23 16:49:33 -0400917 if (sechdr->sh_type == SHT_PROGBITS &&
918 !(sechdr->sh_flags & SHF_ALLOC) &&
919 !match(sec, section_white_list)) {
920 warn("%s (%s): unexpected non-allocatable section.\n"
921 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
922 "Note that for example <linux/init.h> contains\n"
923 "section definitions for use in .S files.\n\n",
924 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100925 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100926}
927
928
929
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100930#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930931 ".init.setup", ".init.rodata", ".meminit.rodata", \
932 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100933#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930934 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100935
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100936#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930937 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100938#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930939 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100940
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200941#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930942 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
943 ".pci_fixup_enable", ".pci_fixup_resume", \
944 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200945
Paul Gortmakere24f6622013-06-19 19:30:48 -0400946#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
947#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100948
949#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
950#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100951
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930952#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930953#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Chris Metcalf6727ad92016-10-07 17:02:55 -0700954 ".kprobes.text", ".cpuidle.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930955#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400956 ".fixup", ".entry.text", ".exception.text", ".text.*", \
957 ".coldtext"
Sam Ravnborg10668222008-01-13 22:21:31 +0100958
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000959#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000960#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100961
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000962#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000963#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100964
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930965#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
966 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
967
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100968/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930969static const char *const init_data_sections[] =
970 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100971
972/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930973static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100974
975/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930976static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100977 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100978
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930979/* all text sections */
980static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
981
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100982/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930983static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100984
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100985
986/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100987#define DEFAULT_SYMBOL_WHITE_LIST \
988 "*driver", \
989 "*_template", /* scsi uses *_template a lot */ \
990 "*_timer", /* arm uses ops structures named _timer a lot */ \
991 "*_sht", /* scsi also used *_sht to some extent */ \
992 "*_ops", \
993 "*_probe", \
994 "*_probe_one", \
995 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100996
Mathias Krause7a3ee752014-08-27 20:28:53 +0930997static const char *const head_sections[] = { ".head.text*", NULL };
998static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100999 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301000static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001001
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001002enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001003 TEXT_TO_ANY_INIT,
1004 DATA_TO_ANY_INIT,
1005 TEXT_TO_ANY_EXIT,
1006 DATA_TO_ANY_EXIT,
1007 XXXINIT_TO_SOME_INIT,
1008 XXXEXIT_TO_SOME_EXIT,
1009 ANY_INIT_TO_ANY_EXIT,
1010 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001011 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301012 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001013};
1014
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301015/**
1016 * Describe how to match sections on different criterias:
1017 *
1018 * @fromsec: Array of sections to be matched.
1019 *
1020 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
1021 * this array is forbidden (black-list). Can be empty.
1022 *
1023 * @good_tosec: Relocations applied to a section in @fromsec must be
1024 * targetting sections in this array (white-list). Can be empty.
1025 *
1026 * @mismatch: Type of mismatch.
1027 *
1028 * @symbol_white_list: Do not match a relocation to a symbol in this list
1029 * even if it is targetting a section in @bad_to_sec.
1030 *
1031 * @handler: Specific handler to call when a match is found. If NULL,
1032 * default_mismatch_handler() will be called.
1033 *
1034 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001035struct sectioncheck {
1036 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301037 const char *bad_tosec[20];
1038 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001039 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001040 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301041 void (*handler)(const char *modname, struct elf_info *elf,
1042 const struct sectioncheck* const mismatch,
1043 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1044
Sam Ravnborg10668222008-01-13 22:21:31 +01001045};
1046
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301047static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1048 const struct sectioncheck* const mismatch,
1049 Elf_Rela *r, Elf_Sym *sym,
1050 const char *fromsec);
1051
Mathias Krause7a3ee752014-08-27 20:28:53 +09301052static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001053/* Do not reference init/exit code/data from
1054 * normal code and data
1055 */
1056{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001057 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301058 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001059 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001060 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001061},
1062{
1063 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301064 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001065 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001066 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001067},
1068{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001069 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301070 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001071 .mismatch = DATA_TO_ANY_INIT,
1072 .symbol_white_list = {
1073 "*_template", "*_timer", "*_sht", "*_ops",
1074 "*_probe", "*_probe_one", "*_console", NULL
1075 },
1076},
1077{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001078 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301079 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001080 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001081 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001082},
1083{
1084 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301085 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001086 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001087 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001088},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001089/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001090{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001091 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301092 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001093 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001094 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001095},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001096/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001097{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001098 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301099 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001100 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001101 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001102},
1103/* Do not use exit code/data from init code */
1104{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001105 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301106 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001107 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001108 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001109},
1110/* Do not use init code/data from exit code */
1111{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001112 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301113 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001114 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001115 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001116},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001117{
1118 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301119 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001120 .mismatch = ANY_INIT_TO_ANY_EXIT,
1121 .symbol_white_list = { NULL },
1122},
Sam Ravnborg10668222008-01-13 22:21:31 +01001123/* Do not export init/exit functions or data */
1124{
1125 .fromsec = { "__ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301126 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001127 .mismatch = EXPORT_TO_INIT_EXIT,
1128 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301129},
1130{
1131 .fromsec = { "__ex_table", NULL },
1132 /* If you're adding any new black-listed sections in here, consider
1133 * adding a special 'printer' for them in scripts/check_extable.
1134 */
1135 .bad_tosec = { ".altinstr_replacement", NULL },
1136 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1137 .mismatch = EXTABLE_TO_NON_TEXT,
1138 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001139}
1140};
1141
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001142static const struct sectioncheck *section_mismatch(
1143 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001144{
1145 int i;
1146 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1147 const struct sectioncheck *check = &sectioncheck[0];
1148
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301149 /*
1150 * The target section could be the SHT_NUL section when we're
1151 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001152 * doesn't make much sense and causes build failures on parisc
1153 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301154 */
1155 if (*tosec == '\0')
1156 return NULL;
1157
Sam Ravnborg10668222008-01-13 22:21:31 +01001158 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301159 if (match(fromsec, check->fromsec)) {
1160 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1161 return check;
1162 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1163 return check;
1164 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001165 check++;
1166 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001167 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001168}
1169
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001170/**
1171 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001172 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001173 * Pattern 1:
1174 * If a module parameter is declared __initdata and permissions=0
1175 * then this is legal despite the warning generated.
1176 * We cannot see value of permissions here, so just ignore
1177 * this pattern.
1178 * The pattern is identified by:
1179 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001180 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001181 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001182 *
Rusty Russell6a841522010-08-11 23:04:16 -06001183 * Pattern 1a:
1184 * module_param_call() ops can refer to __init set function if permissions=0
1185 * The pattern is identified by:
1186 * tosec = .init.text
1187 * fromsec = .data*
1188 * atsym = __param_ops_*
1189 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001190 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001191 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001192 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001193 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001194 * tosec = init or exit section
1195 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001196 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1197 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001198 *
1199 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001200 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001201 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001202 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001203 * Some symbols belong to init section but still it is ok to reference
1204 * these from non-init sections as these symbols don't have any memory
1205 * allocated for them and symbol address and value are same. So even
1206 * if init section is freed, its ok to reference those symbols.
1207 * For ex. symbols marking the init section boundaries.
1208 * This pattern is identified by
1209 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001210 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301211 * Pattern 5:
1212 * GCC may optimize static inlines when fed constant arg(s) resulting
1213 * in functions like cpumask_empty() -- generating an associated symbol
1214 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1215 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1216 * meaningless section warning. May need to add isra symbols too...
1217 * This pattern is identified by
1218 * tosec = init section
1219 * fromsec = text section
1220 * refsymname = *.constprop.*
1221 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001222 * Pattern 6:
1223 * Hide section mismatch warnings for ELF local symbols. The goal
1224 * is to eliminate false positive modpost warnings caused by
1225 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1226 * Autogenerated symbol names bypass modpost's "Pattern 2"
1227 * whitelisting, which relies on pattern-matching against symbol
1228 * names to work. (One situation where gcc can autogenerate ELF
1229 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001230 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001231static int secref_whitelist(const struct sectioncheck *mismatch,
1232 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001233 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001234{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001235 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001236 if (match(tosec, init_data_sections) &&
1237 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001238 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001239 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001240
Rusty Russell6a841522010-08-11 23:04:16 -06001241 /* Check for pattern 1a */
1242 if (strcmp(tosec, ".init.text") == 0 &&
1243 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001244 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001245 return 0;
1246
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001247 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001248 if (match(tosec, init_exit_sections) &&
1249 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001250 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001251 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001252
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001253 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001254 if (match(fromsec, head_sections) &&
1255 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001256 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001257
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001258 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001259 if (match(tosym, linker_symbols))
1260 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001261
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301262 /* Check for pattern 5 */
1263 if (match(fromsec, text_sections) &&
1264 match(tosec, init_sections) &&
1265 match(fromsym, optim_symbols))
1266 return 0;
1267
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001268 /* Check for pattern 6 */
1269 if (strstarts(fromsym, ".L"))
1270 return 0;
1271
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001272 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001273}
1274
Sami Tolvanen5818c682018-10-23 15:15:35 -07001275static inline int is_arm_mapping_symbol(const char *str)
1276{
1277 return str[0] == '$' && strchr("axtd", str[1])
1278 && (str[2] == '\0' || str[2] == '.');
1279}
1280
1281/*
1282 * If there's no name there, ignore it; likewise, ignore it if it's
1283 * one of the magic symbols emitted used by current ARM tools.
1284 *
1285 * Otherwise if find_symbols_between() returns those symbols, they'll
1286 * fail the whitelist tests and cause lots of false alarms ... fixable
1287 * only by merging __exit and __init sections into __text, bloating
1288 * the kernel (which is especially evil on embedded platforms).
1289 */
1290static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1291{
1292 const char *name = elf->strtab + sym->st_name;
1293
1294 if (!name || !strlen(name))
1295 return 0;
1296 return !is_arm_mapping_symbol(name);
1297}
1298
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001299/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001300 * Find symbol based on relocation record info.
1301 * In some cases the symbol supplied is a valid symbol so
1302 * return refsym. If st_name != 0 we assume this is a valid symbol.
1303 * In other cases the symbol needs to be looked up in the symbol table
1304 * based on section and address.
1305 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001306static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001307 Elf_Sym *relsym)
1308{
1309 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001310 Elf_Sym *near = NULL;
1311 Elf64_Sword distance = 20;
1312 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001313 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001314
1315 if (relsym->st_name != 0)
1316 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001317
1318 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001319 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001320 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001321 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001322 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1323 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001324 if (!is_valid_name(elf, sym))
1325 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001326 if (sym->st_value == addr)
1327 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001328 /* Find a symbol nearby - addr are maybe negative */
1329 d = sym->st_value - addr;
1330 if (d < 0)
1331 d = addr - sym->st_value;
1332 if (d < distance) {
1333 distance = d;
1334 near = sym;
1335 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001336 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001337 /* We need a close match */
1338 if (distance < 20)
1339 return near;
1340 else
1341 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001342}
1343
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001344/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001345 * Find symbols before or equal addr and after addr - in the section sec.
1346 * If we find two symbols with equal offset prefer one with a valid name.
1347 * The ELF format may have a better way to detect what type of symbol
1348 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001349 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001350static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1351 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001352{
1353 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001354 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001355 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001356
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001357 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1358 const char *symsec;
1359
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001360 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001361 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001362 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001363 if (strcmp(symsec, sec) != 0)
1364 continue;
David Brownellda68d612007-02-20 13:58:16 -08001365 if (!is_valid_name(elf, sym))
1366 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001367 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001368 if ((addr - sym->st_value) < distance) {
1369 distance = addr - sym->st_value;
1370 near = sym;
1371 } else if ((addr - sym->st_value) == distance) {
1372 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001373 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001374 }
1375 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001376 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001377}
1378
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001379/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001380 * Convert a section name to the function/data attribute
1381 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001382 * .memexitconst => __memconst
1383 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001384 *
1385 * The memory of returned value has been allocated on a heap. The user of this
1386 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001387*/
1388static char *sec2annotation(const char *s)
1389{
1390 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001391 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001392 char *r = p;
1393
1394 *p++ = '_';
1395 *p++ = '_';
1396 if (*s == '.')
1397 s++;
1398 while (*s && *s != '.')
1399 *p++ = *s++;
1400 *p = '\0';
1401 if (*s == '.')
1402 s++;
1403 if (strstr(s, "rodata") != NULL)
1404 strcat(p, "const ");
1405 else if (strstr(s, "data") != NULL)
1406 strcat(p, "data ");
1407 else
1408 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001409 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001410 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001411 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001412 }
1413}
1414
1415static int is_function(Elf_Sym *sym)
1416{
1417 if (sym)
1418 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1419 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001420 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001421}
1422
Randy Dunlap00759c02011-03-15 14:13:47 -07001423static void print_section_list(const char * const list[20])
1424{
1425 const char *const *s = list;
1426
1427 while (*s) {
1428 fprintf(stderr, "%s", *s);
1429 s++;
1430 if (*s)
1431 fprintf(stderr, ", ");
1432 }
1433 fprintf(stderr, "\n");
1434}
1435
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301436static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1437{
1438 switch (is_func) {
1439 case 0: *name = "variable"; *name_p = ""; break;
1440 case 1: *name = "function"; *name_p = "()"; break;
1441 default: *name = "(unknown reference)"; *name_p = ""; break;
1442 }
1443}
1444
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001445/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001446 * Print a warning about a section mismatch.
1447 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001448 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001449 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001450static void report_sec_mismatch(const char *modname,
1451 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001452 const char *fromsec,
1453 unsigned long long fromaddr,
1454 const char *fromsym,
1455 int from_is_func,
1456 const char *tosec, const char *tosym,
1457 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001458{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001459 const char *from, *from_p;
1460 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001461 char *prl_from;
1462 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001463
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001464 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001465
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301466 get_pretty_name(from_is_func, &from, &from_p);
1467 get_pretty_name(to_is_func, &to, &to_p);
1468
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001469 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1470 "to the %s %s:%s%s\n",
1471 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1472 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001473
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001474 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001475 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001476 prl_from = sec2annotation(fromsec);
1477 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001478 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001479 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001480 "the %s %s%s%s.\n"
1481 "This is often because %s lacks a %s\n"
1482 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001483 prl_from, fromsym,
1484 to, prl_to, tosym, to_p,
1485 fromsym, prl_to, tosym);
1486 free(prl_from);
1487 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001488 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001489 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001490 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001491 fprintf(stderr,
1492 "The variable %s references\n"
1493 "the %s %s%s%s\n"
1494 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001495 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001496 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001497 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001498 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001499 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001500 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001501 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001502 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001503 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001504 fprintf(stderr,
1505 "The function %s() references a %s in an exit section.\n"
1506 "Often the %s %s%s has valid usage outside the exit section\n"
1507 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001508 fromsym, to, to, tosym, to_p, prl_to, tosym);
1509 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001510 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001511 case DATA_TO_ANY_EXIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001512 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001513 fprintf(stderr,
1514 "The variable %s references\n"
1515 "the %s %s%s%s\n"
1516 "If the reference is valid then annotate the\n"
1517 "variable with __exit* (see linux/init.h) or "
1518 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001519 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001520 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001521 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001522 break;
1523 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001524 case XXXINIT_TO_SOME_INIT:
1525 case XXXEXIT_TO_SOME_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001526 prl_from = sec2annotation(fromsec);
1527 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001528 fprintf(stderr,
1529 "The %s %s%s%s references\n"
1530 "a %s %s%s%s.\n"
1531 "If %s is only used by %s then\n"
1532 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001533 from, prl_from, fromsym, from_p,
1534 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001535 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001536 free(prl_from);
1537 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001538 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001539 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001540 prl_from = sec2annotation(fromsec);
1541 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001542 fprintf(stderr,
1543 "The %s %s%s%s references\n"
1544 "a %s %s%s%s.\n"
1545 "This is often seen when error handling "
1546 "in the init function\n"
1547 "uses functionality in the exit path.\n"
1548 "The fix is often to remove the %sannotation of\n"
1549 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001550 from, prl_from, fromsym, from_p,
1551 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001552 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001553 free(prl_from);
1554 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001555 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001556 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001557 prl_from = sec2annotation(fromsec);
1558 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001559 fprintf(stderr,
1560 "The %s %s%s%s references\n"
1561 "a %s %s%s%s.\n"
1562 "This is often seen when error handling "
1563 "in the exit function\n"
1564 "uses functionality in the init path.\n"
1565 "The fix is often to remove the %sannotation of\n"
1566 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001567 from, prl_from, fromsym, from_p,
1568 to, prl_to, tosym, to_p,
1569 prl_to, tosym, to_p);
1570 free(prl_from);
1571 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001572 break;
1573 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001574 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001575 fprintf(stderr,
1576 "The symbol %s is exported and annotated %s\n"
1577 "Fix this by removing the %sannotation of %s "
1578 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001579 tosym, prl_to, prl_to, tosym);
1580 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001581 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301582 case EXTABLE_TO_NON_TEXT:
1583 fatal("There's a special handler for this mismatch type, "
1584 "we should never get here.");
1585 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001586 }
1587 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001588}
1589
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301590static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1591 const struct sectioncheck* const mismatch,
1592 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1593{
1594 const char *tosec;
1595 Elf_Sym *to;
1596 Elf_Sym *from;
1597 const char *tosym;
1598 const char *fromsym;
1599
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301600 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1601 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301602
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001603 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301604 return;
1605
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301606 tosec = sec_name(elf, get_secindex(elf, sym));
1607 to = find_elf_symbol(elf, r->r_addend, sym);
1608 tosym = sym_name(elf, to);
1609
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301610 /* check whitelist - we may ignore it */
1611 if (secref_whitelist(mismatch,
1612 fromsec, fromsym, tosec, tosym)) {
1613 report_sec_mismatch(modname, mismatch,
1614 fromsec, r->r_offset, fromsym,
1615 is_function(from), tosec, tosym,
1616 is_function(to));
1617 }
1618}
1619
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301620static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1621{
1622 if (section_index > elf->num_sections)
1623 fatal("section_index is outside elf->num_sections!\n");
1624
1625 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1626}
1627
1628/*
1629 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1630 * to know the sizeof(struct exception_table_entry) for the target architecture.
1631 */
1632static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301633static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301634{
1635 /*
1636 * If we're currently checking the second relocation within __ex_table,
1637 * that relocation offset tells us the offsetof(struct
1638 * exception_table_entry, fixup) which is equal to sizeof(struct
1639 * exception_table_entry) divided by two. We use that to our advantage
1640 * since there's no portable way to get that size as every architecture
1641 * seems to go with different sized types. Not pretty but better than
1642 * hard-coding the size for every architecture..
1643 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301644 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301645 extable_entry_size = r->r_offset * 2;
1646}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301647
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301648static inline bool is_extable_fault_address(Elf_Rela *r)
1649{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301650 /*
1651 * extable_entry_size is only discovered after we've handled the
1652 * _second_ relocation in __ex_table, so only abort when we're not
1653 * handling the first reloc and extable_entry_size is zero.
1654 */
1655 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301656 fatal("extable_entry size hasn't been discovered!\n");
1657
1658 return ((r->r_offset == 0) ||
1659 (r->r_offset % extable_entry_size == 0));
1660}
1661
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301662#define is_second_extable_reloc(Start, Cur, Sec) \
1663 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1664
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301665static void report_extable_warnings(const char* modname, struct elf_info* elf,
1666 const struct sectioncheck* const mismatch,
1667 Elf_Rela* r, Elf_Sym* sym,
1668 const char* fromsec, const char* tosec)
1669{
1670 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1671 const char* fromsym_name = sym_name(elf, fromsym);
1672 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1673 const char* tosym_name = sym_name(elf, tosym);
1674 const char* from_pretty_name;
1675 const char* from_pretty_name_p;
1676 const char* to_pretty_name;
1677 const char* to_pretty_name_p;
1678
1679 get_pretty_name(is_function(fromsym),
1680 &from_pretty_name, &from_pretty_name_p);
1681 get_pretty_name(is_function(tosym),
1682 &to_pretty_name, &to_pretty_name_p);
1683
1684 warn("%s(%s+0x%lx): Section mismatch in reference"
1685 " from the %s %s%s to the %s %s:%s%s\n",
1686 modname, fromsec, (long)r->r_offset, from_pretty_name,
1687 fromsym_name, from_pretty_name_p,
1688 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1689
1690 if (!match(tosec, mismatch->bad_tosec) &&
1691 is_executable_section(elf, get_secindex(elf, sym)))
1692 fprintf(stderr,
1693 "The relocation at %s+0x%lx references\n"
1694 "section \"%s\" which is not in the list of\n"
1695 "authorized sections. If you're adding a new section\n"
1696 "and/or if this reference is valid, add \"%s\" to the\n"
1697 "list of authorized sections to jump to on fault.\n"
1698 "This can be achieved by adding \"%s\" to \n"
1699 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1700 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1701}
1702
1703static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1704 const struct sectioncheck* const mismatch,
1705 Elf_Rela* r, Elf_Sym* sym,
1706 const char *fromsec)
1707{
1708 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1709
1710 sec_mismatch_count++;
1711
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001712 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301713
1714 if (match(tosec, mismatch->bad_tosec))
1715 fatal("The relocation at %s+0x%lx references\n"
1716 "section \"%s\" which is black-listed.\n"
1717 "Something is seriously wrong and should be fixed.\n"
1718 "You might get more information about where this is\n"
1719 "coming from by using scripts/check_extable.sh %s\n",
1720 fromsec, (long)r->r_offset, tosec, modname);
1721 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1722 if (is_extable_fault_address(r))
1723 fatal("The relocation at %s+0x%lx references\n"
1724 "section \"%s\" which is not executable, IOW\n"
1725 "it is not possible for the kernel to fault\n"
1726 "at that address. Something is seriously wrong\n"
1727 "and should be fixed.\n",
1728 fromsec, (long)r->r_offset, tosec);
1729 else
1730 fatal("The relocation at %s+0x%lx references\n"
1731 "section \"%s\" which is not executable, IOW\n"
1732 "the kernel will fault if it ever tries to\n"
1733 "jump to it. Something is seriously wrong\n"
1734 "and should be fixed.\n",
1735 fromsec, (long)r->r_offset, tosec);
1736 }
1737}
1738
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001739static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001740 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001741{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001742 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301743 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001744
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001745 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301746 if (mismatch->handler)
1747 mismatch->handler(modname, elf, mismatch,
1748 r, sym, fromsec);
1749 else
1750 default_mismatch_handler(modname, elf, mismatch,
1751 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001752 }
1753}
1754
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001755static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001756 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001757{
Masahiro Yamadad2e4d052020-05-25 14:47:04 +09001758 return sym_get_data_by_offset(elf, sechdr->sh_info, 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{
2248 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002249 /*
2250 * Include build-salt.h after module.h in order to
2251 * inherit the definitions.
2252 */
2253 buf_printf(b, "#include <linux/build-salt.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 buf_printf(b, "#include <linux/vermagic.h>\n");
2255 buf_printf(b, "#include <linux/compiler.h>\n");
2256 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002257 buf_printf(b, "BUILD_SALT;\n");
2258 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002260 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302262 buf_printf(b, "__visible struct module __this_module\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002263 buf_printf(b, "__section(.gnu.linkonce.this_module) = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002264 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002266 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 if (mod->has_cleanup)
2268 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002269 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002271 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 buf_printf(b, "};\n");
2273}
2274
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002275static void add_intree_flag(struct buffer *b, int is_intree)
2276{
2277 if (is_intree)
2278 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2279}
2280
Andi Kleencaf75012018-01-25 15:50:28 -08002281/* Cannot check for assembler */
2282static void add_retpoline(struct buffer *b)
2283{
WANG Chaoe4f35892018-12-11 00:37:25 +08002284 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002285 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2286 buf_printf(b, "#endif\n");
2287}
2288
Trevor Keith5c725132009-09-22 16:43:38 -07002289static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002290{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002291 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002292 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2293}
2294
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002295/**
2296 * Record CRCs for unresolved symbols
2297 **/
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002298static int add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299{
2300 struct symbol *s, *exp;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002301 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302
2303 for (s = mod->unres; s; s = s->next) {
2304 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002305 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 s->module = exp->module;
2308 s->crc_valid = exp->crc_valid;
2309 s->crc = exp->crc;
2310 }
2311
2312 if (!modversions)
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002313 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314
2315 buf_printf(b, "\n");
2316 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002317 buf_printf(b, "__used __section(__versions) = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318
2319 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002320 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002323 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 s->name, mod->name);
2325 continue;
2326 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302327 if (strlen(s->name) >= MODULE_NAME_LEN) {
2328 merror("too long symbol \"%s\" [%s.ko]\n",
2329 s->name, mod->name);
2330 err = 1;
2331 break;
2332 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002333 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302334 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 }
2336
2337 buf_printf(b, "};\n");
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002338
2339 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340}
2341
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002342static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343{
2344 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 int first = 1;
2346
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002347 /* Clear ->seen flag of modules that own symbols needed by this. */
2348 for (s = mod->unres; s; s = s->next)
2349 if (s->module)
2350 s->module->seen = is_vmlinux(s->module->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351
2352 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002353 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002355 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 if (!s->module)
2357 continue;
2358
2359 if (s->module->seen)
2360 continue;
2361
2362 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002363 p = strrchr(s->module->name, '/');
2364 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002365 p++;
2366 else
2367 p = s->module->name;
2368 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 first = 0;
2370 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002371 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372}
2373
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002374static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375{
2376 if (mod->srcversion[0]) {
2377 buf_printf(b, "\n");
2378 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2379 mod->srcversion);
2380 }
2381}
2382
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002383static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384{
2385 char *tmp;
2386 FILE *file;
2387 struct stat st;
2388
2389 file = fopen(fname, "r");
2390 if (!file)
2391 goto write;
2392
2393 if (fstat(fileno(file), &st) < 0)
2394 goto close_write;
2395
2396 if (st.st_size != b->pos)
2397 goto close_write;
2398
2399 tmp = NOFAIL(malloc(b->pos));
2400 if (fread(tmp, 1, b->pos, file) != b->pos)
2401 goto free_write;
2402
2403 if (memcmp(tmp, b->p, b->pos) != 0)
2404 goto free_write;
2405
2406 free(tmp);
2407 fclose(file);
2408 return;
2409
2410 free_write:
2411 free(tmp);
2412 close_write:
2413 fclose(file);
2414 write:
2415 file = fopen(fname, "w");
2416 if (!file) {
2417 perror(fname);
2418 exit(1);
2419 }
2420 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2421 perror(fname);
2422 exit(1);
2423 }
2424 fclose(file);
2425}
2426
Ram Paibd5cbce2006-06-08 22:12:53 -07002427/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002428 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002429 **/
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002430static void read_dump(const char *fname, unsigned int kernel)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431{
2432 unsigned long size, pos = 0;
2433 void *file = grab_file(fname, &size);
2434 char *line;
2435
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002436 if (!file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437 /* No symbol versions, silently ignore */
2438 return;
2439
2440 while ((line = get_next_line(&pos, file, size))) {
Jessica Yu51900442020-03-11 18:01:20 +01002441 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442 unsigned int crc;
2443 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002444 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445
2446 if (!(symname = strchr(line, '\t')))
2447 goto fail;
2448 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002449 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 goto fail;
2451 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002452 if (!(export = strchr(modname, '\t')))
2453 goto fail;
2454 *export++ = '\0';
2455 if (!(namespace = strchr(export, '\t')))
2456 goto fail;
2457 *namespace++ = '\0';
2458
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 crc = strtoul(line, &d, 16);
2460 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2461 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002462 mod = find_module(modname);
2463 if (!mod) {
2464 if (is_vmlinux(modname))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 have_vmlinux = 1;
Jan Beulich0fa3a882009-03-12 12:28:30 +00002466 mod = new_module(modname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 mod->skip = 1;
2468 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002469 s = sym_add_exported(symname, mod, export_no(export));
Sam Ravnborg8e70c452006-01-28 22:22:33 +01002470 s->kernel = kernel;
Denis Efremov15bfc232019-08-01 09:06:57 +03002471 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002472 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002473 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 }
Christian Engelmayer2ee41e62014-04-28 11:34:32 +09302475 release_file(file, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 return;
2477fail:
Christian Engelmayer2ee41e62014-04-28 11:34:32 +09302478 release_file(file, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479 fatal("parse error in symbol dump file\n");
2480}
2481
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002482/* For normal builds always dump all symbols.
2483 * For external modules only dump symbols
2484 * that are not read from kernel Module.symvers.
2485 **/
2486static int dump_sym(struct symbol *sym)
2487{
2488 if (!external_module)
2489 return 1;
2490 if (sym->vmlinux || sym->kernel)
2491 return 0;
2492 return 1;
2493}
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002494
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002495static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496{
2497 struct buffer buf = { };
2498 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002499 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 int n;
2501
2502 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2503 symbol = symbolhash[n];
2504 while (symbol) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002505 if (dump_sym(symbol)) {
2506 namespace = symbol->namespace;
2507 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2508 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002509 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002510 export_str(symbol->export),
2511 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002512 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513 symbol = symbol->next;
2514 }
2515 }
2516 write_if_changed(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002517 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518}
2519
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002520static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002521{
2522 struct module *mod;
2523 struct namespace_list *ns;
2524 struct buffer ns_deps_buf = {};
2525
2526 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002527
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002528 if (mod->skip || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002529 continue;
2530
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002531 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002532
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002533 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2534 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002535
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002536 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002537 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002538
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002539 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002540 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002541}
2542
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002543struct ext_sym_list {
2544 struct ext_sym_list *next;
2545 const char *file;
2546};
2547
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002548int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549{
2550 struct module *mod;
2551 struct buffer buf = { };
Masahiro Yamada39808e42019-10-03 19:29:14 +09002552 char *kernel_read = NULL;
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002553 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302554 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555 int opt;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002556 int err;
Denis Efremov15bfc232019-08-01 09:06:57 +03002557 int n;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002558 struct ext_sym_list *extsym_start = NULL;
Masahiro Yamada2beee862020-06-01 14:57:04 +09002559 struct ext_sym_list **extsym_iter = &extsym_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560
Jessica Yu54b77842020-03-06 17:02:06 +01002561 while ((opt = getopt(argc, argv, "i:e:mnsT:o:awENd:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002562 switch (opt) {
2563 case 'i':
2564 kernel_read = optarg;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002565 external_module = 1;
2566 break;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002567 case 'e':
2568 external_module = 1;
Masahiro Yamada2beee862020-06-01 14:57:04 +09002569 *extsym_iter = NOFAIL(calloc(1, sizeof(**extsym_iter)));
2570 (*extsym_iter)->file = optarg;
2571 extsym_iter = &(*extsym_iter)->next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002572 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002573 case 'm':
2574 modversions = 1;
2575 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302576 case 'n':
2577 ignore_missing_files = 1;
2578 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002579 case 'o':
2580 dump_write = optarg;
2581 break;
2582 case 'a':
2583 all_versions = 1;
2584 break;
2585 case 's':
2586 vmlinux_section_warnings = 0;
2587 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302588 case 'T':
2589 files_source = optarg;
2590 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002591 case 'w':
2592 warn_unresolved = 1;
2593 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302594 case 'E':
2595 sec_mismatch_fatal = 1;
2596 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002597 case 'N':
2598 allow_missing_ns_imports = 1;
2599 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002600 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002601 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002602 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002603 default:
2604 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 }
2606 }
2607
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002608 if (kernel_read)
2609 read_dump(kernel_read, 1);
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002610 while (extsym_start) {
Masahiro Yamada2beee862020-06-01 14:57:04 +09002611 struct ext_sym_list *tmp;
2612
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002613 read_dump(extsym_start->file, 0);
Masahiro Yamada2beee862020-06-01 14:57:04 +09002614 tmp = extsym_start->next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002615 free(extsym_start);
Masahiro Yamada2beee862020-06-01 14:57:04 +09002616 extsym_start = tmp;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002617 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002619 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621
Rusty Russell712f9b42013-04-04 17:37:38 +10302622 if (files_source)
2623 read_symbols_from_files(files_source);
2624
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002625 err = 0;
2626
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002627 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302628 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002629
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002630 if (mod->skip)
2631 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632
2633 buf.pos = 0;
2634
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002635 err |= check_modname_len(mod);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002636 err |= check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002637
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002639 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002640 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002641 add_staging_flag(&buf, mod->name);
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002642 err |= add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002643 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644 add_moddevtable(&buf, mod);
2645 add_srcversion(&buf, mod);
2646
2647 sprintf(fname, "%s.mod.c", mod->name);
2648 write_if_changed(&buf, fname);
2649 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002650
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002651 if (missing_namespace_deps)
2652 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002653
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 if (dump_write)
2655 write_dump(dump_write);
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002656 if (sec_mismatch_count && sec_mismatch_fatal)
Jessica Yu93c95e52020-03-06 17:02:05 +01002657 fatal("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002658 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002659 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002660 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002661
Masahiro Yamada47346e92019-09-24 21:07:40 +09002662 for (s = symbolhash[n]; s; s = s->next) {
2663 /*
2664 * Do not check "vmlinux". This avoids the same warnings
2665 * shown twice, and false-positives for ARCH=um.
2666 */
2667 if (is_vmlinux(s->module->name) && !s->module->is_dot_o)
2668 continue;
2669
Denis Efremov15bfc232019-08-01 09:06:57 +03002670 if (s->is_static)
2671 warn("\"%s\" [%s] is a static %s\n",
2672 s->name, s->module->name,
2673 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002674 }
2675 }
2676
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002677 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002679 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002680}