blob: 8c5f1bd7548105df1813708b764051a10e821185 [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 Yamada6124c042017-09-06 16:19:05 -0700291static const char *sech_name(struct elf_info *elf, Elf_Shdr *sechdr)
292{
293 return (void *)elf->hdr +
294 elf->sechdrs[elf->secindex_strings].sh_offset +
295 sechdr->sh_name;
296}
297
298static const char *sec_name(struct elf_info *elf, int secindex)
299{
300 return sech_name(elf, &elf->sechdrs[secindex]);
301}
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200302
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900303static void *sym_get_data_by_offset(const struct elf_info *info,
304 unsigned int secindex, unsigned long offset)
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900305{
Xiao Yang4b8a5cf2020-03-18 18:34:16 +0800306 Elf_Shdr *sechdr = &info->sechdrs[secindex];
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900307
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900308 if (info->hdr->e_type != ET_REL)
309 offset -= sechdr->sh_addr;
310
311 return (void *)info->hdr + sechdr->sh_offset + offset;
312}
313
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900314static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
315{
316 return sym_get_data_by_offset(info, get_secindex(info, sym),
317 sym->st_value);
318}
319
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200320#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
321
322static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
323{
324 const char *secname = sec_name(elf, sec);
325
326 if (strstarts(secname, "___ksymtab+"))
327 return export_plain;
328 else if (strstarts(secname, "___ksymtab_unused+"))
329 return export_unused;
330 else if (strstarts(secname, "___ksymtab_gpl+"))
331 return export_gpl;
332 else if (strstarts(secname, "___ksymtab_unused_gpl+"))
333 return export_unused_gpl;
334 else if (strstarts(secname, "___ksymtab_gpl_future+"))
335 return export_gpl_future;
336 else
337 return export_unknown;
338}
339
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200340static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700341{
342 if (sec == elf->export_sec)
343 return export_plain;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200344 else if (sec == elf->export_unused_sec)
345 return export_unused;
Ram Paibd5cbce2006-06-08 22:12:53 -0700346 else if (sec == elf->export_gpl_sec)
347 return export_gpl;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200348 else if (sec == elf->export_unused_gpl_sec)
349 return export_unused_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700350 else if (sec == elf->export_gpl_future_sec)
351 return export_gpl_future;
352 else
353 return export_unknown;
354}
355
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900356static const char *namespace_from_kstrtabns(const struct elf_info *info,
357 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100358{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900359 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100360 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100361}
362
Matthias Maennicha2b11182019-10-18 10:31:40 +0100363static void sym_update_namespace(const char *symname, const char *namespace)
364{
365 struct symbol *s = find_symbol(symname);
366
367 /*
368 * That symbol should have been created earlier and thus this is
369 * actually an assertion.
370 */
371 if (!s) {
372 merror("Could not update namespace(%s) for symbol %s\n",
373 namespace, symname);
374 return;
375 }
376
377 free(s->namespace);
378 s->namespace =
379 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
380}
381
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100382/**
383 * Add an exported symbol - it may have already been added without a
384 * CRC, in this case just update the CRC
385 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100386static struct symbol *sym_add_exported(const char *name, struct module *mod,
387 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388{
389 struct symbol *s = find_symbol(name);
390
391 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700392 s = new_symbol(name, mod, export);
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900393 } else if (!external_module || is_vmlinux(s->module->name) ||
394 s->module == mod) {
395 warn("%s: '%s' exported twice. Previous export was in %s%s\n",
396 mod->name, name, s->module->name,
397 is_vmlinux(s->module->name) ? "" : ".ko");
398 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900400
401 s->module = mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100402 s->vmlinux = is_vmlinux(mod->name);
403 s->kernel = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -0700404 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100405 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406}
407
Masahiro Yamada17436942019-11-15 02:42:24 +0900408static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100409{
410 struct symbol *s = find_symbol(name);
411
Masahiro Yamada17436942019-11-15 02:42:24 +0900412 /*
413 * Ignore stand-alone __crc_*, which might be auto-generated symbols
414 * such as __*_veneer in ARM ELF.
415 */
416 if (!s)
417 return;
418
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100419 s->crc = crc;
420 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421}
422
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100423void *grab_file(const char *filename, unsigned long *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424{
425 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930426 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 int fd;
428
429 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930430 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930432 if (fstat(fd, &st))
433 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
435 *size = st.st_size;
436 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930438failed:
439 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 if (map == MAP_FAILED)
441 return NULL;
442 return map;
443}
444
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100445/**
446 * Return a copy of the next line in a mmap'ed file.
447 * spaces in the beginning of the line is trimmed away.
448 * Return a pointer to a static buffer.
449 **/
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100450char *get_next_line(unsigned long *pos, void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451{
452 static char line[4096];
453 int skip = 1;
454 size_t len = 0;
455 signed char *p = (signed char *)file + *pos;
456 char *s = line;
457
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100458 for (; *pos < size ; (*pos)++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 if (skip && isspace(*p)) {
460 p++;
461 continue;
462 }
463 skip = 0;
464 if (*p != '\n' && (*pos < size)) {
465 len++;
466 *s++ = *p++;
467 if (len > 4095)
468 break; /* Too long, stop */
469 } else {
470 /* End of string */
471 *s = '\0';
472 return line;
473 }
474 }
475 /* End of buffer */
476 return NULL;
477}
478
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100479void release_file(void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480{
481 munmap(file, size);
482}
483
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100484static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485{
486 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100487 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 Elf_Shdr *sechdrs;
489 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200490 const char *secstrings;
491 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
493 hdr = grab_file(filename, &info->size);
494 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930495 if (ignore_missing_files) {
496 fprintf(stderr, "%s: %s (ignored)\n", filename,
497 strerror(errno));
498 return 0;
499 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200501 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 }
503 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100504 if (info->size < sizeof(*hdr)) {
505 /* file too small, assume this is an empty .o file */
506 return 0;
507 }
508 /* Is this a valid ELF file? */
509 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
510 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
511 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
512 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
513 /* Not an ELF file - silently ignore it */
514 return 0;
515 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200517 hdr->e_type = TO_NATIVE(hdr->e_type);
518 hdr->e_machine = TO_NATIVE(hdr->e_machine);
519 hdr->e_version = TO_NATIVE(hdr->e_version);
520 hdr->e_entry = TO_NATIVE(hdr->e_entry);
521 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
522 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
523 hdr->e_flags = TO_NATIVE(hdr->e_flags);
524 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
525 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
526 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
527 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
528 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
529 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 sechdrs = (void *)hdr + hdr->e_shoff;
531 info->sechdrs = sechdrs;
532
Petr Stetiara83710e2007-08-27 12:15:07 +0200533 /* Check if file offset is correct */
534 if (hdr->e_shoff > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100535 fatal("section header offset=%lu in file '%s' is bigger than "
536 "filesize=%lu\n", (unsigned long)hdr->e_shoff,
537 filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200538 return 0;
539 }
540
Anders Kaseorg68457562011-05-19 16:55:27 -0600541 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200542 /*
543 * There are more than 64k sections,
544 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200545 */
546 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
547 }
548 else {
549 info->num_sections = hdr->e_shnum;
550 }
551 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600552 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200553 }
554 else {
555 info->secindex_strings = hdr->e_shstrndx;
556 }
557
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200559 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200560 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
561 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
562 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
563 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
564 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
565 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
566 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
567 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
568 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
569 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 }
571 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200572 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
573 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700574 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900575 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Tejun Heo56fc82c2009-02-06 00:48:02 +0900577 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100578 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
579 "sizeof(*hrd)=%zu\n", filename,
580 (unsigned long)sechdrs[i].sh_offset,
581 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100582 return 0;
583 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700584 secname = secstrings + sechdrs[i].sh_name;
585 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900586 if (nobits)
587 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
589 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700590 } else if (strcmp(secname, "__ksymtab") == 0)
591 info->export_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200592 else if (strcmp(secname, "__ksymtab_unused") == 0)
593 info->export_unused_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700594 else if (strcmp(secname, "__ksymtab_gpl") == 0)
595 info->export_gpl_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200596 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
597 info->export_unused_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700598 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
599 info->export_gpl_future_sec = i;
600
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200601 if (sechdrs[i].sh_type == SHT_SYMTAB) {
602 unsigned int sh_link_idx;
603 symtab_idx = i;
604 info->symtab_start = (void *)hdr +
605 sechdrs[i].sh_offset;
606 info->symtab_stop = (void *)hdr +
607 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600608 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200609 info->strtab = (void *)hdr +
610 sechdrs[sh_link_idx].sh_offset;
611 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200613 /* 32bit section no. table? ("more than 64k sections") */
614 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
615 symtab_shndx_idx = i;
616 info->symtab_shndx_start = (void *)hdr +
617 sechdrs[i].sh_offset;
618 info->symtab_shndx_stop = (void *)hdr +
619 sechdrs[i].sh_offset + sechdrs[i].sh_size;
620 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100622 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100623 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 /* Fix endianness in symbols */
626 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
627 sym->st_shndx = TO_NATIVE(sym->st_shndx);
628 sym->st_name = TO_NATIVE(sym->st_name);
629 sym->st_value = TO_NATIVE(sym->st_value);
630 sym->st_size = TO_NATIVE(sym->st_size);
631 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200632
633 if (symtab_shndx_idx != ~0U) {
634 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600635 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200636 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600637 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200638 symtab_idx);
639 /* Fix endianness */
640 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
641 p++)
642 *p = TO_NATIVE(*p);
643 }
644
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100645 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646}
647
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100648static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649{
650 release_file(info->hdr, info->size);
651}
652
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200653static int ignore_undef_symbol(struct elf_info *info, const char *symname)
654{
655 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900656 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200657 return 1;
658 /* ignore global offset table */
659 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
660 return 1;
661 if (info->hdr->e_machine == EM_PPC)
662 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900663 if (strstarts(symname, "_restgpr_") ||
664 strstarts(symname, "_savegpr_") ||
665 strstarts(symname, "_rest32gpr_") ||
666 strstarts(symname, "_save32gpr_") ||
667 strstarts(symname, "_restvr_") ||
668 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200669 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000670 if (info->hdr->e_machine == EM_PPC64)
671 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900672 if (strstarts(symname, "_restgpr0_") ||
673 strstarts(symname, "_savegpr0_") ||
674 strstarts(symname, "_restvr_") ||
675 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100676 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000677 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200678 /* Do not ignore this symbol */
679 return 0;
680}
681
Masahiro Yamada17436942019-11-15 02:42:24 +0900682static void handle_modversion(const struct module *mod,
683 const struct elf_info *info,
684 const Elf_Sym *sym, const char *symname)
685{
686 unsigned int crc;
687
688 if (sym->st_shndx == SHN_UNDEF) {
689 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n",
690 symname, mod->name, is_vmlinux(mod->name) ? "":".ko");
691 return;
692 }
693
694 if (sym->st_shndx == SHN_ABS) {
695 crc = sym->st_value;
696 } else {
697 unsigned int *crcp;
698
699 /* symbol points to the CRC in the ELF object */
700 crcp = sym_get_data(info, sym);
701 crc = TO_NATIVE(*crcp);
702 }
703 sym_set_crc(symname, crc);
704}
705
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900706static void handle_symbol(struct module *mod, struct elf_info *info,
707 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200709 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900710 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200711
Frank Rowand258f7422012-04-09 17:59:03 -0700712 if ((!is_vmlinux(mod->name) || mod->is_dot_o) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900713 strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200714 export = export_from_secname(info, get_secindex(info, sym));
715 else
716 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
718 switch (sym->st_shndx) {
719 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900720 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100721 /* Should warn here, but modpost runs before the linker */
722 } else
723 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 case SHN_UNDEF:
726 /* undefined symbol */
727 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
728 ELF_ST_BIND(sym->st_info) != STB_WEAK)
729 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200730 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 if (info->hdr->e_machine == EM_SPARC ||
733 info->hdr->e_machine == EM_SPARCV9) {
734 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700735 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100737 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700738 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100739 munged[0] = '_';
740 munged[1] = toupper(munged[1]);
741 symname = munged;
742 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100744
Rusty Russellb92021b2013-03-15 15:04:17 +1030745 mod->unres = alloc_symbol(symname,
746 ELF_ST_BIND(sym->st_info) == STB_WEAK,
747 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 break;
749 default:
750 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900751 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100752 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100753 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900755 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900757 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 mod->has_cleanup = 1;
759 break;
760 }
761}
762
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100763/**
764 * Parse tag=value strings from .modinfo section
765 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766static char *next_string(char *string, unsigned long *secsize)
767{
768 /* Skip non-zero chars */
769 while (string[0]) {
770 string++;
771 if ((*secsize)-- <= 1)
772 return NULL;
773 }
774
775 /* Skip any zero padding. */
776 while (!string[0]) {
777 string++;
778 if ((*secsize)-- <= 1)
779 return NULL;
780 }
781 return string;
782}
783
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900784static char *get_next_modinfo(struct elf_info *info, const char *tag,
785 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786{
787 char *p;
788 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900789 char *modinfo = info->modinfo;
790 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900792 if (prev) {
793 size -= prev - modinfo;
794 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200795 }
796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 for (p = modinfo; p; p = next_string(p, &size)) {
798 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
799 return p + taglen + 1;
800 }
801 return NULL;
802}
803
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900804static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200805
806{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900807 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200808}
809
Sam Ravnborg93684d32006-02-19 11:53:35 +0100810/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100811 * Test if string s ends in string sub
812 * return 0 if match
813 **/
814static int strrcmp(const char *s, const char *sub)
815{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100816 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100817
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100818 if (!s || !sub)
819 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100820
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100821 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100822 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100823
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100824 if ((slen == 0) || (sublen == 0))
825 return 1;
826
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100827 if (sublen > slen)
828 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100829
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100830 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100831}
832
Sam Ravnborgff13f922008-01-23 19:54:27 +0100833static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
834{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100835 if (sym)
836 return elf->strtab + sym->st_name;
837 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100838 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100839}
840
Sam Ravnborg10668222008-01-13 22:21:31 +0100841/* The pattern is an array of simple patterns.
842 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100843 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100844 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930845 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100846 */
Trevor Keith5c725132009-09-22 16:43:38 -0700847static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100848{
849 const char *p;
850 while (*pat) {
851 p = *pat++;
852 const char *endp = p + strlen(p) - 1;
853
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930854 /* "*foo*" */
855 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300856 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
857 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930858
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930859 free(bare);
860 if (here != NULL)
861 return 1;
862 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100863 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930864 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100865 if (strrcmp(sym, p + 1) == 0)
866 return 1;
867 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100868 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100869 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100870 if (strncmp(sym, p, strlen(p) - 1) == 0)
871 return 1;
872 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100873 /* no wildcards */
874 else {
875 if (strcmp(p, sym) == 0)
876 return 1;
877 }
878 }
879 /* no match */
880 return 0;
881}
882
Sam Ravnborg10668222008-01-13 22:21:31 +0100883/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930884static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200885{
886 ".comment*",
887 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930888 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800889 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000890 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200891 ".mdebug*", /* alpha, score, mips etc. */
892 ".pdr", /* alpha, score, mips etc. */
893 ".stab*",
894 ".note*",
895 ".got*",
896 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400897 ".xt.prop", /* xtensa */
898 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030899 ".arcextmap*", /* arc */
900 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030901 ".cmem*", /* EZchip */
902 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100903 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600904 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200905 NULL
906};
Sam Ravnborg10668222008-01-13 22:21:31 +0100907
Sam Ravnborge241a632008-01-28 20:13:13 +0100908/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400909 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100910 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400911 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100912 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400913static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900914 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100915{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400916 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100917
Anders Kaseorgb614a692009-04-23 16:49:33 -0400918 if (sechdr->sh_type == SHT_PROGBITS &&
919 !(sechdr->sh_flags & SHF_ALLOC) &&
920 !match(sec, section_white_list)) {
921 warn("%s (%s): unexpected non-allocatable section.\n"
922 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
923 "Note that for example <linux/init.h> contains\n"
924 "section definitions for use in .S files.\n\n",
925 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100926 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100927}
928
929
930
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100931#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930932 ".init.setup", ".init.rodata", ".meminit.rodata", \
933 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100934#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930935 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100936
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100937#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930938 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100939#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930940 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100941
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200942#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930943 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
944 ".pci_fixup_enable", ".pci_fixup_resume", \
945 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200946
Paul Gortmakere24f6622013-06-19 19:30:48 -0400947#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
948#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100949
950#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
951#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100952
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930953#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930954#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Chris Metcalf6727ad92016-10-07 17:02:55 -0700955 ".kprobes.text", ".cpuidle.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930956#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400957 ".fixup", ".entry.text", ".exception.text", ".text.*", \
958 ".coldtext"
Sam Ravnborg10668222008-01-13 22:21:31 +0100959
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000960#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000961#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100962
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000963#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000964#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100965
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930966#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
967 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
968
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100969/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930970static const char *const init_data_sections[] =
971 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100972
973/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930974static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100975
976/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930977static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100978 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100979
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930980/* all text sections */
981static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
982
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100983/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930984static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100985
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100986
987/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100988#define DEFAULT_SYMBOL_WHITE_LIST \
989 "*driver", \
990 "*_template", /* scsi uses *_template a lot */ \
991 "*_timer", /* arm uses ops structures named _timer a lot */ \
992 "*_sht", /* scsi also used *_sht to some extent */ \
993 "*_ops", \
994 "*_probe", \
995 "*_probe_one", \
996 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100997
Mathias Krause7a3ee752014-08-27 20:28:53 +0930998static const char *const head_sections[] = { ".head.text*", NULL };
999static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001000 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301001static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001002
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001003enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001004 TEXT_TO_ANY_INIT,
1005 DATA_TO_ANY_INIT,
1006 TEXT_TO_ANY_EXIT,
1007 DATA_TO_ANY_EXIT,
1008 XXXINIT_TO_SOME_INIT,
1009 XXXEXIT_TO_SOME_EXIT,
1010 ANY_INIT_TO_ANY_EXIT,
1011 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001012 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301013 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001014};
1015
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301016/**
1017 * Describe how to match sections on different criterias:
1018 *
1019 * @fromsec: Array of sections to be matched.
1020 *
1021 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
1022 * this array is forbidden (black-list). Can be empty.
1023 *
1024 * @good_tosec: Relocations applied to a section in @fromsec must be
1025 * targetting sections in this array (white-list). Can be empty.
1026 *
1027 * @mismatch: Type of mismatch.
1028 *
1029 * @symbol_white_list: Do not match a relocation to a symbol in this list
1030 * even if it is targetting a section in @bad_to_sec.
1031 *
1032 * @handler: Specific handler to call when a match is found. If NULL,
1033 * default_mismatch_handler() will be called.
1034 *
1035 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001036struct sectioncheck {
1037 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301038 const char *bad_tosec[20];
1039 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001040 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001041 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301042 void (*handler)(const char *modname, struct elf_info *elf,
1043 const struct sectioncheck* const mismatch,
1044 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1045
Sam Ravnborg10668222008-01-13 22:21:31 +01001046};
1047
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301048static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1049 const struct sectioncheck* const mismatch,
1050 Elf_Rela *r, Elf_Sym *sym,
1051 const char *fromsec);
1052
Mathias Krause7a3ee752014-08-27 20:28:53 +09301053static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001054/* Do not reference init/exit code/data from
1055 * normal code and data
1056 */
1057{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001058 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301059 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001060 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001061 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001062},
1063{
1064 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301065 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001066 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001067 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001068},
1069{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001070 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301071 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001072 .mismatch = DATA_TO_ANY_INIT,
1073 .symbol_white_list = {
1074 "*_template", "*_timer", "*_sht", "*_ops",
1075 "*_probe", "*_probe_one", "*_console", NULL
1076 },
1077},
1078{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001079 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301080 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001081 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001082 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001083},
1084{
1085 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301086 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001087 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001088 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001089},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001090/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001091{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001092 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301093 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001094 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001095 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001096},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001097/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001098{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001099 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301100 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001101 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001102 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001103},
1104/* Do not use exit code/data from init code */
1105{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001106 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301107 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001108 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001109 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001110},
1111/* Do not use init code/data from exit code */
1112{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001113 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301114 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001115 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001116 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001117},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001118{
1119 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301120 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001121 .mismatch = ANY_INIT_TO_ANY_EXIT,
1122 .symbol_white_list = { NULL },
1123},
Sam Ravnborg10668222008-01-13 22:21:31 +01001124/* Do not export init/exit functions or data */
1125{
1126 .fromsec = { "__ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301127 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001128 .mismatch = EXPORT_TO_INIT_EXIT,
1129 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301130},
1131{
1132 .fromsec = { "__ex_table", NULL },
1133 /* If you're adding any new black-listed sections in here, consider
1134 * adding a special 'printer' for them in scripts/check_extable.
1135 */
1136 .bad_tosec = { ".altinstr_replacement", NULL },
1137 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1138 .mismatch = EXTABLE_TO_NON_TEXT,
1139 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001140}
1141};
1142
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001143static const struct sectioncheck *section_mismatch(
1144 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001145{
1146 int i;
1147 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1148 const struct sectioncheck *check = &sectioncheck[0];
1149
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301150 /*
1151 * The target section could be the SHT_NUL section when we're
1152 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001153 * doesn't make much sense and causes build failures on parisc
1154 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301155 */
1156 if (*tosec == '\0')
1157 return NULL;
1158
Sam Ravnborg10668222008-01-13 22:21:31 +01001159 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301160 if (match(fromsec, check->fromsec)) {
1161 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1162 return check;
1163 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1164 return check;
1165 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001166 check++;
1167 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001168 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001169}
1170
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001171/**
1172 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001173 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001174 * Pattern 1:
1175 * If a module parameter is declared __initdata and permissions=0
1176 * then this is legal despite the warning generated.
1177 * We cannot see value of permissions here, so just ignore
1178 * this pattern.
1179 * The pattern is identified by:
1180 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001181 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001182 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001183 *
Rusty Russell6a841522010-08-11 23:04:16 -06001184 * Pattern 1a:
1185 * module_param_call() ops can refer to __init set function if permissions=0
1186 * The pattern is identified by:
1187 * tosec = .init.text
1188 * fromsec = .data*
1189 * atsym = __param_ops_*
1190 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001191 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001192 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001193 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001194 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001195 * tosec = init or exit section
1196 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001197 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1198 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001199 *
1200 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001201 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001202 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001203 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001204 * Some symbols belong to init section but still it is ok to reference
1205 * these from non-init sections as these symbols don't have any memory
1206 * allocated for them and symbol address and value are same. So even
1207 * if init section is freed, its ok to reference those symbols.
1208 * For ex. symbols marking the init section boundaries.
1209 * This pattern is identified by
1210 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001211 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301212 * Pattern 5:
1213 * GCC may optimize static inlines when fed constant arg(s) resulting
1214 * in functions like cpumask_empty() -- generating an associated symbol
1215 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1216 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1217 * meaningless section warning. May need to add isra symbols too...
1218 * This pattern is identified by
1219 * tosec = init section
1220 * fromsec = text section
1221 * refsymname = *.constprop.*
1222 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001223 * Pattern 6:
1224 * Hide section mismatch warnings for ELF local symbols. The goal
1225 * is to eliminate false positive modpost warnings caused by
1226 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1227 * Autogenerated symbol names bypass modpost's "Pattern 2"
1228 * whitelisting, which relies on pattern-matching against symbol
1229 * names to work. (One situation where gcc can autogenerate ELF
1230 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001231 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001232static int secref_whitelist(const struct sectioncheck *mismatch,
1233 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001234 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001235{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001236 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001237 if (match(tosec, init_data_sections) &&
1238 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001239 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001240 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001241
Rusty Russell6a841522010-08-11 23:04:16 -06001242 /* Check for pattern 1a */
1243 if (strcmp(tosec, ".init.text") == 0 &&
1244 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001245 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001246 return 0;
1247
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001248 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001249 if (match(tosec, init_exit_sections) &&
1250 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001251 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001252 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001253
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001254 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001255 if (match(fromsec, head_sections) &&
1256 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001257 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001258
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001259 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001260 if (match(tosym, linker_symbols))
1261 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001262
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301263 /* Check for pattern 5 */
1264 if (match(fromsec, text_sections) &&
1265 match(tosec, init_sections) &&
1266 match(fromsym, optim_symbols))
1267 return 0;
1268
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001269 /* Check for pattern 6 */
1270 if (strstarts(fromsym, ".L"))
1271 return 0;
1272
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001273 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001274}
1275
Sami Tolvanen5818c682018-10-23 15:15:35 -07001276static inline int is_arm_mapping_symbol(const char *str)
1277{
1278 return str[0] == '$' && strchr("axtd", str[1])
1279 && (str[2] == '\0' || str[2] == '.');
1280}
1281
1282/*
1283 * If there's no name there, ignore it; likewise, ignore it if it's
1284 * one of the magic symbols emitted used by current ARM tools.
1285 *
1286 * Otherwise if find_symbols_between() returns those symbols, they'll
1287 * fail the whitelist tests and cause lots of false alarms ... fixable
1288 * only by merging __exit and __init sections into __text, bloating
1289 * the kernel (which is especially evil on embedded platforms).
1290 */
1291static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1292{
1293 const char *name = elf->strtab + sym->st_name;
1294
1295 if (!name || !strlen(name))
1296 return 0;
1297 return !is_arm_mapping_symbol(name);
1298}
1299
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001300/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001301 * Find symbol based on relocation record info.
1302 * In some cases the symbol supplied is a valid symbol so
1303 * return refsym. If st_name != 0 we assume this is a valid symbol.
1304 * In other cases the symbol needs to be looked up in the symbol table
1305 * based on section and address.
1306 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001307static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001308 Elf_Sym *relsym)
1309{
1310 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001311 Elf_Sym *near = NULL;
1312 Elf64_Sword distance = 20;
1313 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001314 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001315
1316 if (relsym->st_name != 0)
1317 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001318
1319 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001320 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001321 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001322 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001323 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1324 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001325 if (!is_valid_name(elf, sym))
1326 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001327 if (sym->st_value == addr)
1328 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001329 /* Find a symbol nearby - addr are maybe negative */
1330 d = sym->st_value - addr;
1331 if (d < 0)
1332 d = addr - sym->st_value;
1333 if (d < distance) {
1334 distance = d;
1335 near = sym;
1336 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001337 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001338 /* We need a close match */
1339 if (distance < 20)
1340 return near;
1341 else
1342 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001343}
1344
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001345/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001346 * Find symbols before or equal addr and after addr - in the section sec.
1347 * If we find two symbols with equal offset prefer one with a valid name.
1348 * The ELF format may have a better way to detect what type of symbol
1349 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001350 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001351static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1352 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001353{
1354 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001355 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001356 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001357
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001358 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1359 const char *symsec;
1360
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001361 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001362 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001363 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001364 if (strcmp(symsec, sec) != 0)
1365 continue;
David Brownellda68d612007-02-20 13:58:16 -08001366 if (!is_valid_name(elf, sym))
1367 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001368 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001369 if ((addr - sym->st_value) < distance) {
1370 distance = addr - sym->st_value;
1371 near = sym;
1372 } else if ((addr - sym->st_value) == distance) {
1373 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001374 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001375 }
1376 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001377 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001378}
1379
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001380/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001381 * Convert a section name to the function/data attribute
1382 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001383 * .memexitconst => __memconst
1384 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001385 *
1386 * The memory of returned value has been allocated on a heap. The user of this
1387 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001388*/
1389static char *sec2annotation(const char *s)
1390{
1391 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001392 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001393 char *r = p;
1394
1395 *p++ = '_';
1396 *p++ = '_';
1397 if (*s == '.')
1398 s++;
1399 while (*s && *s != '.')
1400 *p++ = *s++;
1401 *p = '\0';
1402 if (*s == '.')
1403 s++;
1404 if (strstr(s, "rodata") != NULL)
1405 strcat(p, "const ");
1406 else if (strstr(s, "data") != NULL)
1407 strcat(p, "data ");
1408 else
1409 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001410 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001411 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001412 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001413 }
1414}
1415
1416static int is_function(Elf_Sym *sym)
1417{
1418 if (sym)
1419 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1420 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001421 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001422}
1423
Randy Dunlap00759c02011-03-15 14:13:47 -07001424static void print_section_list(const char * const list[20])
1425{
1426 const char *const *s = list;
1427
1428 while (*s) {
1429 fprintf(stderr, "%s", *s);
1430 s++;
1431 if (*s)
1432 fprintf(stderr, ", ");
1433 }
1434 fprintf(stderr, "\n");
1435}
1436
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301437static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1438{
1439 switch (is_func) {
1440 case 0: *name = "variable"; *name_p = ""; break;
1441 case 1: *name = "function"; *name_p = "()"; break;
1442 default: *name = "(unknown reference)"; *name_p = ""; break;
1443 }
1444}
1445
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001446/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001447 * Print a warning about a section mismatch.
1448 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001449 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001450 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001451static void report_sec_mismatch(const char *modname,
1452 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001453 const char *fromsec,
1454 unsigned long long fromaddr,
1455 const char *fromsym,
1456 int from_is_func,
1457 const char *tosec, const char *tosym,
1458 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001459{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001460 const char *from, *from_p;
1461 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001462 char *prl_from;
1463 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001464
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001465 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001466
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301467 get_pretty_name(from_is_func, &from, &from_p);
1468 get_pretty_name(to_is_func, &to, &to_p);
1469
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001470 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1471 "to the %s %s:%s%s\n",
1472 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1473 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001474
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001475 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001476 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001477 prl_from = sec2annotation(fromsec);
1478 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001479 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001480 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001481 "the %s %s%s%s.\n"
1482 "This is often because %s lacks a %s\n"
1483 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001484 prl_from, fromsym,
1485 to, prl_to, tosym, to_p,
1486 fromsym, prl_to, tosym);
1487 free(prl_from);
1488 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001489 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001490 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001491 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001492 fprintf(stderr,
1493 "The variable %s references\n"
1494 "the %s %s%s%s\n"
1495 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001496 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001497 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001498 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001499 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001500 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001501 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001502 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001503 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001504 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001505 fprintf(stderr,
1506 "The function %s() references a %s in an exit section.\n"
1507 "Often the %s %s%s has valid usage outside the exit section\n"
1508 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001509 fromsym, to, to, tosym, to_p, prl_to, tosym);
1510 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001511 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001512 case DATA_TO_ANY_EXIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001513 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001514 fprintf(stderr,
1515 "The variable %s references\n"
1516 "the %s %s%s%s\n"
1517 "If the reference is valid then annotate the\n"
1518 "variable with __exit* (see linux/init.h) or "
1519 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001520 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001521 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001522 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001523 break;
1524 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001525 case XXXINIT_TO_SOME_INIT:
1526 case XXXEXIT_TO_SOME_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001527 prl_from = sec2annotation(fromsec);
1528 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001529 fprintf(stderr,
1530 "The %s %s%s%s references\n"
1531 "a %s %s%s%s.\n"
1532 "If %s is only used by %s then\n"
1533 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001534 from, prl_from, fromsym, from_p,
1535 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001536 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001537 free(prl_from);
1538 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001539 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001540 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001541 prl_from = sec2annotation(fromsec);
1542 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001543 fprintf(stderr,
1544 "The %s %s%s%s references\n"
1545 "a %s %s%s%s.\n"
1546 "This is often seen when error handling "
1547 "in the init function\n"
1548 "uses functionality in the exit path.\n"
1549 "The fix is often to remove the %sannotation of\n"
1550 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001551 from, prl_from, fromsym, from_p,
1552 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001553 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001554 free(prl_from);
1555 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001556 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001557 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001558 prl_from = sec2annotation(fromsec);
1559 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001560 fprintf(stderr,
1561 "The %s %s%s%s references\n"
1562 "a %s %s%s%s.\n"
1563 "This is often seen when error handling "
1564 "in the exit function\n"
1565 "uses functionality in the init path.\n"
1566 "The fix is often to remove the %sannotation of\n"
1567 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001568 from, prl_from, fromsym, from_p,
1569 to, prl_to, tosym, to_p,
1570 prl_to, tosym, to_p);
1571 free(prl_from);
1572 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001573 break;
1574 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001575 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001576 fprintf(stderr,
1577 "The symbol %s is exported and annotated %s\n"
1578 "Fix this by removing the %sannotation of %s "
1579 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001580 tosym, prl_to, prl_to, tosym);
1581 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001582 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301583 case EXTABLE_TO_NON_TEXT:
1584 fatal("There's a special handler for this mismatch type, "
1585 "we should never get here.");
1586 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001587 }
1588 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001589}
1590
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301591static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1592 const struct sectioncheck* const mismatch,
1593 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1594{
1595 const char *tosec;
1596 Elf_Sym *to;
1597 Elf_Sym *from;
1598 const char *tosym;
1599 const char *fromsym;
1600
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301601 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1602 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301603
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001604 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301605 return;
1606
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301607 tosec = sec_name(elf, get_secindex(elf, sym));
1608 to = find_elf_symbol(elf, r->r_addend, sym);
1609 tosym = sym_name(elf, to);
1610
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301611 /* check whitelist - we may ignore it */
1612 if (secref_whitelist(mismatch,
1613 fromsec, fromsym, tosec, tosym)) {
1614 report_sec_mismatch(modname, mismatch,
1615 fromsec, r->r_offset, fromsym,
1616 is_function(from), tosec, tosym,
1617 is_function(to));
1618 }
1619}
1620
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301621static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1622{
1623 if (section_index > elf->num_sections)
1624 fatal("section_index is outside elf->num_sections!\n");
1625
1626 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1627}
1628
1629/*
1630 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1631 * to know the sizeof(struct exception_table_entry) for the target architecture.
1632 */
1633static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301634static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301635{
1636 /*
1637 * If we're currently checking the second relocation within __ex_table,
1638 * that relocation offset tells us the offsetof(struct
1639 * exception_table_entry, fixup) which is equal to sizeof(struct
1640 * exception_table_entry) divided by two. We use that to our advantage
1641 * since there's no portable way to get that size as every architecture
1642 * seems to go with different sized types. Not pretty but better than
1643 * hard-coding the size for every architecture..
1644 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301645 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301646 extable_entry_size = r->r_offset * 2;
1647}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301648
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301649static inline bool is_extable_fault_address(Elf_Rela *r)
1650{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301651 /*
1652 * extable_entry_size is only discovered after we've handled the
1653 * _second_ relocation in __ex_table, so only abort when we're not
1654 * handling the first reloc and extable_entry_size is zero.
1655 */
1656 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301657 fatal("extable_entry size hasn't been discovered!\n");
1658
1659 return ((r->r_offset == 0) ||
1660 (r->r_offset % extable_entry_size == 0));
1661}
1662
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301663#define is_second_extable_reloc(Start, Cur, Sec) \
1664 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1665
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301666static void report_extable_warnings(const char* modname, struct elf_info* elf,
1667 const struct sectioncheck* const mismatch,
1668 Elf_Rela* r, Elf_Sym* sym,
1669 const char* fromsec, const char* tosec)
1670{
1671 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1672 const char* fromsym_name = sym_name(elf, fromsym);
1673 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1674 const char* tosym_name = sym_name(elf, tosym);
1675 const char* from_pretty_name;
1676 const char* from_pretty_name_p;
1677 const char* to_pretty_name;
1678 const char* to_pretty_name_p;
1679
1680 get_pretty_name(is_function(fromsym),
1681 &from_pretty_name, &from_pretty_name_p);
1682 get_pretty_name(is_function(tosym),
1683 &to_pretty_name, &to_pretty_name_p);
1684
1685 warn("%s(%s+0x%lx): Section mismatch in reference"
1686 " from the %s %s%s to the %s %s:%s%s\n",
1687 modname, fromsec, (long)r->r_offset, from_pretty_name,
1688 fromsym_name, from_pretty_name_p,
1689 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1690
1691 if (!match(tosec, mismatch->bad_tosec) &&
1692 is_executable_section(elf, get_secindex(elf, sym)))
1693 fprintf(stderr,
1694 "The relocation at %s+0x%lx references\n"
1695 "section \"%s\" which is not in the list of\n"
1696 "authorized sections. If you're adding a new section\n"
1697 "and/or if this reference is valid, add \"%s\" to the\n"
1698 "list of authorized sections to jump to on fault.\n"
1699 "This can be achieved by adding \"%s\" to \n"
1700 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1701 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1702}
1703
1704static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1705 const struct sectioncheck* const mismatch,
1706 Elf_Rela* r, Elf_Sym* sym,
1707 const char *fromsec)
1708{
1709 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1710
1711 sec_mismatch_count++;
1712
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001713 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301714
1715 if (match(tosec, mismatch->bad_tosec))
1716 fatal("The relocation at %s+0x%lx references\n"
1717 "section \"%s\" which is black-listed.\n"
1718 "Something is seriously wrong and should be fixed.\n"
1719 "You might get more information about where this is\n"
1720 "coming from by using scripts/check_extable.sh %s\n",
1721 fromsec, (long)r->r_offset, tosec, modname);
1722 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1723 if (is_extable_fault_address(r))
1724 fatal("The relocation at %s+0x%lx references\n"
1725 "section \"%s\" which is not executable, IOW\n"
1726 "it is not possible for the kernel to fault\n"
1727 "at that address. Something is seriously wrong\n"
1728 "and should be fixed.\n",
1729 fromsec, (long)r->r_offset, tosec);
1730 else
1731 fatal("The relocation at %s+0x%lx references\n"
1732 "section \"%s\" which is not executable, IOW\n"
1733 "the kernel will fault if it ever tries to\n"
1734 "jump to it. Something is seriously wrong\n"
1735 "and should be fixed.\n",
1736 fromsec, (long)r->r_offset, tosec);
1737 }
1738}
1739
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001740static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001741 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001742{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001743 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301744 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001745
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001746 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301747 if (mismatch->handler)
1748 mismatch->handler(modname, elf, mismatch,
1749 r, sym, fromsec);
1750 else
1751 default_mismatch_handler(modname, elf, mismatch,
1752 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001753 }
1754}
1755
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001756static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001757 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001758{
Masahiro Yamadad2e4d052020-05-25 14:47:04 +09001759 return sym_get_data_by_offset(elf, sechdr->sh_info, r->r_offset);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001760}
1761
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001762static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001763{
1764 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001765 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001766
1767 switch (r_typ) {
1768 case R_386_32:
1769 r->r_addend = TO_NATIVE(*location);
1770 break;
1771 case R_386_PC32:
1772 r->r_addend = TO_NATIVE(*location) + 4;
1773 /* For CONFIG_RELOCATABLE=y */
1774 if (elf->hdr->e_type == ET_EXEC)
1775 r->r_addend += r->r_offset;
1776 break;
1777 }
1778 return 0;
1779}
1780
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001781#ifndef R_ARM_CALL
1782#define R_ARM_CALL 28
1783#endif
1784#ifndef R_ARM_JUMP24
1785#define R_ARM_JUMP24 29
1786#endif
1787
David A. Longc9698e52014-02-14 22:41:18 +01001788#ifndef R_ARM_THM_CALL
1789#define R_ARM_THM_CALL 10
1790#endif
1791#ifndef R_ARM_THM_JUMP24
1792#define R_ARM_THM_JUMP24 30
1793#endif
1794#ifndef R_ARM_THM_JUMP19
1795#define R_ARM_THM_JUMP19 51
1796#endif
1797
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001798static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001799{
1800 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1801
1802 switch (r_typ) {
1803 case R_ARM_ABS32:
1804 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001805 r->r_addend = (int)(long)
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001806 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001807 break;
1808 case R_ARM_PC24:
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001809 case R_ARM_CALL:
1810 case R_ARM_JUMP24:
David A. Longc9698e52014-02-14 22:41:18 +01001811 case R_ARM_THM_CALL:
1812 case R_ARM_THM_JUMP24:
1813 case R_ARM_THM_JUMP19:
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001814 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001815 r->r_addend = (int)(long)(elf->hdr +
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001816 sechdr->sh_offset +
1817 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001818 break;
1819 default:
1820 return 1;
1821 }
1822 return 0;
1823}
1824
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001825static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001826{
1827 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001828 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001829 unsigned int inst;
1830
1831 if (r_typ == R_MIPS_HI16)
1832 return 1; /* skip this */
1833 inst = TO_NATIVE(*location);
1834 switch (r_typ) {
1835 case R_MIPS_LO16:
1836 r->r_addend = inst & 0xffff;
1837 break;
1838 case R_MIPS_26:
1839 r->r_addend = (inst & 0x03ffffff) << 2;
1840 break;
1841 case R_MIPS_32:
1842 r->r_addend = inst;
1843 break;
1844 }
1845 return 0;
1846}
1847
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001848static void section_rela(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001849 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001850{
1851 Elf_Sym *sym;
1852 Elf_Rela *rela;
1853 Elf_Rela r;
1854 unsigned int r_sym;
1855 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001856
Sam Ravnborgff13f922008-01-23 19:54:27 +01001857 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001858 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1859
Sam Ravnborgff13f922008-01-23 19:54:27 +01001860 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001861 fromsec += strlen(".rela");
1862 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001863 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001864 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001865
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001866 for (rela = start; rela < stop; rela++) {
1867 r.r_offset = TO_NATIVE(rela->r_offset);
1868#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001869 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001870 unsigned int r_typ;
1871 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1872 r_sym = TO_NATIVE(r_sym);
1873 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1874 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1875 } else {
1876 r.r_info = TO_NATIVE(rela->r_info);
1877 r_sym = ELF_R_SYM(r.r_info);
1878 }
1879#else
1880 r.r_info = TO_NATIVE(rela->r_info);
1881 r_sym = ELF_R_SYM(r.r_info);
1882#endif
1883 r.r_addend = TO_NATIVE(rela->r_addend);
1884 sym = elf->symtab_start + r_sym;
1885 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001886 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001887 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301888 if (is_second_extable_reloc(start, rela, fromsec))
1889 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001890 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001891 }
1892}
1893
1894static void section_rel(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001895 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001896{
1897 Elf_Sym *sym;
1898 Elf_Rel *rel;
1899 Elf_Rela r;
1900 unsigned int r_sym;
1901 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001902
Sam Ravnborgff13f922008-01-23 19:54:27 +01001903 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001904 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1905
Sam Ravnborgff13f922008-01-23 19:54:27 +01001906 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001907 fromsec += strlen(".rel");
1908 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001909 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001910 return;
1911
1912 for (rel = start; rel < stop; rel++) {
1913 r.r_offset = TO_NATIVE(rel->r_offset);
1914#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001915 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001916 unsigned int r_typ;
1917 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1918 r_sym = TO_NATIVE(r_sym);
1919 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1920 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1921 } else {
1922 r.r_info = TO_NATIVE(rel->r_info);
1923 r_sym = ELF_R_SYM(r.r_info);
1924 }
1925#else
1926 r.r_info = TO_NATIVE(rel->r_info);
1927 r_sym = ELF_R_SYM(r.r_info);
1928#endif
1929 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001930 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001931 case EM_386:
1932 if (addend_386_rel(elf, sechdr, &r))
1933 continue;
1934 break;
1935 case EM_ARM:
1936 if (addend_arm_rel(elf, sechdr, &r))
1937 continue;
1938 break;
1939 case EM_MIPS:
1940 if (addend_mips_rel(elf, sechdr, &r))
1941 continue;
1942 break;
1943 }
1944 sym = elf->symtab_start + r_sym;
1945 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001946 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001947 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301948 if (is_second_extable_reloc(start, rel, fromsec))
1949 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001950 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001951 }
1952}
1953
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001954/**
1955 * A module includes a number of sections that are discarded
1956 * either when loaded or when used as built-in.
1957 * For loaded modules all functions marked __init and all data
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001958 * marked __initdata will be discarded when the module has been initialized.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001959 * Likewise for modules used built-in the sections marked __exit
1960 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001961 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001962 * The check_sec_ref() function traverses all relocation records
1963 * to find all references to a section that reference a section that will
1964 * be discarded and warns about it.
1965 **/
1966static void check_sec_ref(struct module *mod, const char *modname,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001967 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001968{
1969 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001970 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001971
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001972 /* Walk through all sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001973 for (i = 0; i < elf->num_sections; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001974 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001975 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001976 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001977 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001978 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001979 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001980 }
1981}
1982
Andi Kleen7d02b492014-02-08 09:01:12 +01001983static char *remove_dot(char *s)
1984{
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301985 size_t n = strcspn(s, ".");
Andi Kleen7d02b492014-02-08 09:01:12 +01001986
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301987 if (n && s[n]) {
1988 size_t m = strspn(s + n + 1, "0123456789");
1989 if (m && (s[n + m] == '.' || s[n + m] == 0))
Andi Kleen7d02b492014-02-08 09:01:12 +01001990 s[n] = 0;
1991 }
1992 return s;
1993}
1994
Masahiro Yamada8b185742018-05-09 18:50:40 +09001995static void read_symbols(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996{
1997 const char *symname;
1998 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001999 char *license;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002000 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 struct module *mod;
2002 struct elf_info info = { };
2003 Elf_Sym *sym;
2004
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01002005 if (!parse_elf(&info, modname))
2006 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007
2008 mod = new_module(modname);
2009
2010 /* When there's no vmlinux, don't print warnings about
2011 * unresolved symbols (since there'll be too many ;) */
2012 if (is_vmlinux(modname)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 have_vmlinux = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 mod->skip = 1;
2015 }
2016
Masahiro Yamadabca2cce2018-05-09 18:50:37 +09002017 license = get_modinfo(&info, "license");
Randy Dunlapba1029c2017-11-12 11:21:45 -08002018 if (!license && !is_vmlinux(modname))
Jessica Yu93c95e52020-03-06 17:02:05 +01002019 warn("missing MODULE_LICENSE() in %s\n"
Sam Ravnborg2fa36562008-04-26 21:07:26 +02002020 "see include/linux/module.h for "
2021 "more information\n", modname);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002022 while (license) {
2023 if (license_is_gpl_compatible(license))
2024 mod->gpl_compatible = 1;
2025 else {
2026 mod->gpl_compatible = 0;
2027 break;
2028 }
Masahiro Yamadabca2cce2018-05-09 18:50:37 +09002029 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002030 }
2031
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002032 namespace = get_modinfo(&info, "import_ns");
2033 while (namespace) {
2034 add_namespace(&mod->imported_namespaces, namespace);
2035 namespace = get_next_modinfo(&info, "import_ns", namespace);
2036 }
2037
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002039 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002041 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 handle_moddevtable(mod, &info, sym, symname);
2043 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002044
Matthias Maennich69923202019-10-18 10:31:42 +01002045 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2046 symname = remove_dot(info.strtab + sym->st_name);
2047
Masahiro Yamada17436942019-11-15 02:42:24 +09002048 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002049 if (strstarts(symname, "__kstrtabns_"))
2050 sym_update_namespace(symname + strlen("__kstrtabns_"),
2051 namespace_from_kstrtabns(&info,
2052 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002053
2054 if (strstarts(symname, "__crc_"))
2055 handle_modversion(mod, &info, sym,
2056 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002057 }
2058
Denis Efremov15bfc232019-08-01 09:06:57 +03002059 // check for static EXPORT_SYMBOL_* functions && global vars
2060 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2061 unsigned char bind = ELF_ST_BIND(sym->st_info);
2062
2063 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2064 struct symbol *s =
2065 find_symbol(remove_dot(info.strtab +
2066 sym->st_name));
2067
2068 if (s)
2069 s->is_static = 0;
2070 }
2071 }
2072
Masahiro Yamada074a04f2018-05-09 18:50:39 +09002073 if (!is_vmlinux(modname) || vmlinux_section_warnings)
Sam Ravnborg10668222008-01-13 22:21:31 +01002074 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075
Masahiro Yamadabca2cce2018-05-09 18:50:37 +09002076 version = get_modinfo(&info, "version");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 if (version)
2078 maybe_frob_rcs_version(modname, version, info.modinfo,
2079 version - (char *)info.hdr);
2080 if (version || (all_versions && !is_vmlinux(modname)))
2081 get_src_version(modname, mod->srcversion,
2082 sizeof(mod->srcversion)-1);
2083
2084 parse_elf_finish(&info);
2085
Rusty Russell8c8ef422009-03-31 13:05:34 -06002086 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 * never passed as an argument to an exported function, so
2088 * the automatic versioning doesn't pick it up, but it's really
2089 * important anyhow */
2090 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06002091 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092}
2093
Rusty Russell712f9b42013-04-04 17:37:38 +10302094static void read_symbols_from_files(const char *filename)
2095{
2096 FILE *in = stdin;
2097 char fname[PATH_MAX];
2098
2099 if (strcmp(filename, "-") != 0) {
2100 in = fopen(filename, "r");
2101 if (!in)
2102 fatal("Can't open filenames file %s: %m", filename);
2103 }
2104
2105 while (fgets(fname, PATH_MAX, in) != NULL) {
2106 if (strends(fname, "\n"))
2107 fname[strlen(fname)-1] = '\0';
2108 read_symbols(fname);
2109 }
2110
2111 if (in != stdin)
2112 fclose(in);
2113}
2114
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115#define SZ 500
2116
2117/* We first write the generated file into memory using the
2118 * following helper, then compare to the file on disk and
2119 * only update the later if anything changed */
2120
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002121void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
2122 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123{
2124 char tmp[SZ];
2125 int len;
2126 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002127
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 va_start(ap, fmt);
2129 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002130 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 va_end(ap);
2132}
2133
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002134void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135{
2136 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002137 buf->size += len + SZ;
Randy Dunlap1f3aa902018-08-15 12:30:38 -07002138 buf->p = NOFAIL(realloc(buf->p, buf->size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 }
2140 strncpy(buf->p + buf->pos, s, len);
2141 buf->pos += len;
2142}
2143
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002144static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
2145{
2146 const char *e = is_vmlinux(m) ?"":".ko";
2147
2148 switch (exp) {
2149 case export_gpl:
Jessica Yu93c95e52020-03-06 17:02:05 +01002150 fatal("GPL-incompatible module %s%s "
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002151 "uses GPL-only symbol '%s'\n", m, e, s);
2152 break;
2153 case export_unused_gpl:
Jessica Yu93c95e52020-03-06 17:02:05 +01002154 fatal("GPL-incompatible module %s%s "
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002155 "uses GPL-only symbol marked UNUSED '%s'\n", m, e, s);
2156 break;
2157 case export_gpl_future:
Jessica Yu93c95e52020-03-06 17:02:05 +01002158 warn("GPL-incompatible module %s%s "
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002159 "uses future GPL-only symbol '%s'\n", m, e, s);
2160 break;
2161 case export_plain:
2162 case export_unused:
2163 case export_unknown:
2164 /* ignore */
2165 break;
2166 }
2167}
2168
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002169static void check_for_unused(enum export exp, const char *m, const char *s)
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002170{
2171 const char *e = is_vmlinux(m) ?"":".ko";
2172
2173 switch (exp) {
2174 case export_unused:
2175 case export_unused_gpl:
Jessica Yu93c95e52020-03-06 17:02:05 +01002176 warn("module %s%s "
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002177 "uses symbol '%s' marked UNUSED\n", m, e, s);
2178 break;
2179 default:
2180 /* ignore */
2181 break;
2182 }
2183}
2184
Masahiro Yamada3b415282018-11-23 16:57:23 +09002185static int check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002186{
2187 struct symbol *s, *exp;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002188 int err = 0;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002189
2190 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002191 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002192 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002193 if (!exp || exp->module == mod) {
2194 if (have_vmlinux && !s->weak) {
Jessica Yu93c95e52020-03-06 17:02:05 +01002195 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2196 "\"%s\" [%s.ko] undefined!\n",
2197 s->name, mod->name);
2198 if (!warn_unresolved)
Masahiro Yamada3b415282018-11-23 16:57:23 +09002199 err = 1;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002200 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002201 continue;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002202 }
Andrew Morton6449bd62006-06-09 20:45:06 -07002203 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002204 if (basename)
2205 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002206 else
2207 basename = mod->name;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002208
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002209 if (exp->namespace &&
2210 !module_imports_namespace(mod, exp->namespace)) {
Jessica Yu54b77842020-03-06 17:02:06 +01002211 modpost_log(allow_missing_ns_imports ? LOG_WARN : LOG_ERROR,
2212 "module %s uses symbol %s from namespace %s, but does not import it.\n",
2213 basename, exp->name, exp->namespace);
2214 if (!allow_missing_ns_imports)
2215 err = 1;
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002216 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002217 }
2218
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002219 if (!mod->gpl_compatible)
2220 check_for_gpl_usage(exp->export, basename, exp->name);
2221 check_for_unused(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002222 }
Masahiro Yamada3b415282018-11-23 16:57:23 +09002223
2224 return err;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002225}
2226
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002227static int check_modname_len(struct module *mod)
2228{
2229 const char *mod_name;
2230
2231 mod_name = strrchr(mod->name, '/');
2232 if (mod_name == NULL)
2233 mod_name = mod->name;
2234 else
2235 mod_name++;
2236 if (strlen(mod_name) >= MODULE_NAME_LEN) {
2237 merror("module name is too long [%s.ko]\n", mod->name);
2238 return 1;
2239 }
2240
2241 return 0;
2242}
2243
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002244/**
2245 * Header for the generated file
2246 **/
2247static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248{
2249 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002250 /*
2251 * Include build-salt.h after module.h in order to
2252 * inherit the definitions.
2253 */
2254 buf_printf(b, "#include <linux/build-salt.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 buf_printf(b, "#include <linux/vermagic.h>\n");
2256 buf_printf(b, "#include <linux/compiler.h>\n");
2257 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002258 buf_printf(b, "BUILD_SALT;\n");
2259 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002261 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302263 buf_printf(b, "__visible struct module __this_module\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002264 buf_printf(b, "__section(.gnu.linkonce.this_module) = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002265 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002267 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268 if (mod->has_cleanup)
2269 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002270 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002272 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 buf_printf(b, "};\n");
2274}
2275
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002276static void add_intree_flag(struct buffer *b, int is_intree)
2277{
2278 if (is_intree)
2279 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2280}
2281
Andi Kleencaf75012018-01-25 15:50:28 -08002282/* Cannot check for assembler */
2283static void add_retpoline(struct buffer *b)
2284{
WANG Chaoe4f35892018-12-11 00:37:25 +08002285 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002286 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2287 buf_printf(b, "#endif\n");
2288}
2289
Trevor Keith5c725132009-09-22 16:43:38 -07002290static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002291{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002292 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002293 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2294}
2295
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002296/**
2297 * Record CRCs for unresolved symbols
2298 **/
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002299static int add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300{
2301 struct symbol *s, *exp;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002302 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303
2304 for (s = mod->unres; s; s = s->next) {
2305 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002306 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 s->module = exp->module;
2309 s->crc_valid = exp->crc_valid;
2310 s->crc = exp->crc;
2311 }
2312
2313 if (!modversions)
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002314 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315
2316 buf_printf(b, "\n");
2317 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002318 buf_printf(b, "__used __section(__versions) = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319
2320 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002321 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002324 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 s->name, mod->name);
2326 continue;
2327 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302328 if (strlen(s->name) >= MODULE_NAME_LEN) {
2329 merror("too long symbol \"%s\" [%s.ko]\n",
2330 s->name, mod->name);
2331 err = 1;
2332 break;
2333 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002334 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302335 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 }
2337
2338 buf_printf(b, "};\n");
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002339
2340 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341}
2342
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002343static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344{
2345 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 int first = 1;
2347
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002348 /* Clear ->seen flag of modules that own symbols needed by this. */
2349 for (s = mod->unres; s; s = s->next)
2350 if (s->module)
2351 s->module->seen = is_vmlinux(s->module->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352
2353 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002354 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002356 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 if (!s->module)
2358 continue;
2359
2360 if (s->module->seen)
2361 continue;
2362
2363 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002364 p = strrchr(s->module->name, '/');
2365 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002366 p++;
2367 else
2368 p = s->module->name;
2369 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 first = 0;
2371 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002372 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373}
2374
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002375static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376{
2377 if (mod->srcversion[0]) {
2378 buf_printf(b, "\n");
2379 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2380 mod->srcversion);
2381 }
2382}
2383
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002384static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385{
2386 char *tmp;
2387 FILE *file;
2388 struct stat st;
2389
2390 file = fopen(fname, "r");
2391 if (!file)
2392 goto write;
2393
2394 if (fstat(fileno(file), &st) < 0)
2395 goto close_write;
2396
2397 if (st.st_size != b->pos)
2398 goto close_write;
2399
2400 tmp = NOFAIL(malloc(b->pos));
2401 if (fread(tmp, 1, b->pos, file) != b->pos)
2402 goto free_write;
2403
2404 if (memcmp(tmp, b->p, b->pos) != 0)
2405 goto free_write;
2406
2407 free(tmp);
2408 fclose(file);
2409 return;
2410
2411 free_write:
2412 free(tmp);
2413 close_write:
2414 fclose(file);
2415 write:
2416 file = fopen(fname, "w");
2417 if (!file) {
2418 perror(fname);
2419 exit(1);
2420 }
2421 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2422 perror(fname);
2423 exit(1);
2424 }
2425 fclose(file);
2426}
2427
Ram Paibd5cbce2006-06-08 22:12:53 -07002428/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002429 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002430 **/
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002431static void read_dump(const char *fname, unsigned int kernel)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432{
2433 unsigned long size, pos = 0;
2434 void *file = grab_file(fname, &size);
2435 char *line;
2436
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002437 if (!file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 /* No symbol versions, silently ignore */
2439 return;
2440
2441 while ((line = get_next_line(&pos, file, size))) {
Jessica Yu51900442020-03-11 18:01:20 +01002442 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 unsigned int crc;
2444 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002445 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446
2447 if (!(symname = strchr(line, '\t')))
2448 goto fail;
2449 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002450 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 goto fail;
2452 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002453 if (!(export = strchr(modname, '\t')))
2454 goto fail;
2455 *export++ = '\0';
2456 if (!(namespace = strchr(export, '\t')))
2457 goto fail;
2458 *namespace++ = '\0';
2459
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 crc = strtoul(line, &d, 16);
2461 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2462 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002463 mod = find_module(modname);
2464 if (!mod) {
2465 if (is_vmlinux(modname))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 have_vmlinux = 1;
Jan Beulich0fa3a882009-03-12 12:28:30 +00002467 mod = new_module(modname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 mod->skip = 1;
2469 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002470 s = sym_add_exported(symname, mod, export_no(export));
Sam Ravnborg8e70c452006-01-28 22:22:33 +01002471 s->kernel = kernel;
Denis Efremov15bfc232019-08-01 09:06:57 +03002472 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002473 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002474 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475 }
Christian Engelmayer2ee41e62014-04-28 11:34:32 +09302476 release_file(file, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 return;
2478fail:
Christian Engelmayer2ee41e62014-04-28 11:34:32 +09302479 release_file(file, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 fatal("parse error in symbol dump file\n");
2481}
2482
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002483/* For normal builds always dump all symbols.
2484 * For external modules only dump symbols
2485 * that are not read from kernel Module.symvers.
2486 **/
2487static int dump_sym(struct symbol *sym)
2488{
2489 if (!external_module)
2490 return 1;
2491 if (sym->vmlinux || sym->kernel)
2492 return 0;
2493 return 1;
2494}
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002495
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002496static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497{
2498 struct buffer buf = { };
2499 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002500 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 int n;
2502
2503 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2504 symbol = symbolhash[n];
2505 while (symbol) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002506 if (dump_sym(symbol)) {
2507 namespace = symbol->namespace;
2508 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2509 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002510 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002511 export_str(symbol->export),
2512 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002513 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 symbol = symbol->next;
2515 }
2516 }
2517 write_if_changed(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002518 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519}
2520
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002521static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002522{
2523 struct module *mod;
2524 struct namespace_list *ns;
2525 struct buffer ns_deps_buf = {};
2526
2527 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002528
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002529 if (mod->skip || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002530 continue;
2531
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002532 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002533
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002534 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2535 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002536
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002537 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002538 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002539
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002540 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002541 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002542}
2543
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002544struct ext_sym_list {
2545 struct ext_sym_list *next;
2546 const char *file;
2547};
2548
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002549int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550{
2551 struct module *mod;
2552 struct buffer buf = { };
Masahiro Yamada39808e42019-10-03 19:29:14 +09002553 char *kernel_read = NULL;
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002554 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302555 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556 int opt;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002557 int err;
Denis Efremov15bfc232019-08-01 09:06:57 +03002558 int n;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002559 struct ext_sym_list *extsym_iter;
2560 struct ext_sym_list *extsym_start = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561
Jessica Yu54b77842020-03-06 17:02:06 +01002562 while ((opt = getopt(argc, argv, "i:e:mnsT:o:awENd:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002563 switch (opt) {
2564 case 'i':
2565 kernel_read = optarg;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002566 external_module = 1;
2567 break;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002568 case 'e':
2569 external_module = 1;
2570 extsym_iter =
2571 NOFAIL(malloc(sizeof(*extsym_iter)));
2572 extsym_iter->next = extsym_start;
2573 extsym_iter->file = optarg;
2574 extsym_start = extsym_iter;
2575 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002576 case 'm':
2577 modversions = 1;
2578 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302579 case 'n':
2580 ignore_missing_files = 1;
2581 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002582 case 'o':
2583 dump_write = optarg;
2584 break;
2585 case 'a':
2586 all_versions = 1;
2587 break;
2588 case 's':
2589 vmlinux_section_warnings = 0;
2590 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302591 case 'T':
2592 files_source = optarg;
2593 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002594 case 'w':
2595 warn_unresolved = 1;
2596 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302597 case 'E':
2598 sec_mismatch_fatal = 1;
2599 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002600 case 'N':
2601 allow_missing_ns_imports = 1;
2602 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002603 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002604 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002605 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002606 default:
2607 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608 }
2609 }
2610
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002611 if (kernel_read)
2612 read_dump(kernel_read, 1);
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002613 while (extsym_start) {
2614 read_dump(extsym_start->file, 0);
2615 extsym_iter = extsym_start->next;
2616 free(extsym_start);
2617 extsym_start = extsym_iter;
2618 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002620 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622
Rusty Russell712f9b42013-04-04 17:37:38 +10302623 if (files_source)
2624 read_symbols_from_files(files_source);
2625
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002626 err = 0;
2627
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002628 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302629 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002630
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002631 if (mod->skip)
2632 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633
2634 buf.pos = 0;
2635
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002636 err |= check_modname_len(mod);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002637 err |= check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002638
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002640 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002641 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002642 add_staging_flag(&buf, mod->name);
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002643 err |= add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002644 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645 add_moddevtable(&buf, mod);
2646 add_srcversion(&buf, mod);
2647
2648 sprintf(fname, "%s.mod.c", mod->name);
2649 write_if_changed(&buf, fname);
2650 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002651
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002652 if (missing_namespace_deps)
2653 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002654
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 if (dump_write)
2656 write_dump(dump_write);
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002657 if (sec_mismatch_count && sec_mismatch_fatal)
Jessica Yu93c95e52020-03-06 17:02:05 +01002658 fatal("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002659 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002660 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002661 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002662
Masahiro Yamada47346e92019-09-24 21:07:40 +09002663 for (s = symbolhash[n]; s; s = s->next) {
2664 /*
2665 * Do not check "vmlinux". This avoids the same warnings
2666 * shown twice, and false-positives for ARCH=um.
2667 */
2668 if (is_vmlinux(s->module->name) && !s->module->is_dot_o)
2669 continue;
2670
Denis Efremov15bfc232019-08-01 09:06:57 +03002671 if (s->is_static)
2672 warn("\"%s\" [%s] is a static %s\n",
2673 s->name, s->module->name,
2674 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002675 }
2676 }
2677
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002678 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002680 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681}