blob: a750596d5cc23957a0cc4f9c3ef53e056639f899 [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;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -070033/* Only warn about unresolved symbols */
34static int warn_unresolved = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -070035/* How a symbol is exported */
Sam Ravnborg588ccd72008-01-24 21:12:37 +010036static int sec_mismatch_count = 0;
Masahiro Yamadac7299d92020-12-01 19:34:18 +090037static int sec_mismatch_warn_only = true;
Guenter Roeckeed380f2013-09-23 15:23:54 +093038/* ignore missing files */
39static int ignore_missing_files;
Jessica Yu54b77842020-03-06 17:02:06 +010040/* If set to 1, only warn (instead of error) about missing ns imports */
41static int allow_missing_ns_imports;
Sam Ravnborg588ccd72008-01-24 21:12:37 +010042
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +090043static bool error_occurred;
44
Sam Ravnborgc96fca22006-07-01 11:44:23 +020045enum export {
46 export_plain, export_unused, export_gpl,
47 export_unused_gpl, export_gpl_future, export_unknown
48};
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
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);
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +090083 if (loglevel == LOG_ERROR)
84 error_occurred = true;
Matthew Wilcox2a116652006-10-07 05:35:32 -060085}
86
Rusty Russelld4ef1c32013-04-04 17:37:32 +103087static inline bool strends(const char *str, const char *postfix)
88{
89 if (strlen(str) < strlen(postfix))
90 return false;
91
92 return strcmp(str + strlen(str) - strlen(postfix), postfix) == 0;
93}
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095void *do_nofail(void *ptr, const char *expr)
96{
Sam Ravnborgdf578e72008-01-11 19:17:15 +010097 if (!ptr)
Jessica Yu93c95e52020-03-06 17:02:05 +010098 fatal("Memory allocation failure: %s.\n", expr);
Sam Ravnborgdf578e72008-01-11 19:17:15 +010099
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 return ptr;
101}
102
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900103char *read_text_file(const char *filename)
104{
105 struct stat st;
106 size_t nbytes;
107 int fd;
108 char *buf;
109
110 fd = open(filename, O_RDONLY);
111 if (fd < 0) {
112 perror(filename);
113 exit(1);
114 }
115
116 if (fstat(fd, &st) < 0) {
117 perror(filename);
118 exit(1);
119 }
120
121 buf = NOFAIL(malloc(st.st_size + 1));
122
123 nbytes = st.st_size;
124
125 while (nbytes) {
126 ssize_t bytes_read;
127
128 bytes_read = read(fd, buf, nbytes);
129 if (bytes_read < 0) {
130 perror(filename);
131 exit(1);
132 }
133
134 nbytes -= bytes_read;
135 }
136 buf[st.st_size] = '\0';
137
138 close(fd);
139
140 return buf;
141}
142
143char *get_line(char **stringp)
144{
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200145 char *orig = *stringp, *next;
146
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900147 /* do not return the unwanted extra line at EOF */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200148 if (!orig || *orig == '\0')
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900149 return NULL;
150
Wolfram Sang6020db52020-07-26 23:44:19 +0200151 /* don't use strsep here, it is not available everywhere */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200152 next = strchr(orig, '\n');
153 if (next)
154 *next++ = '\0';
155
156 *stringp = next;
157
158 return orig;
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900159}
160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161/* A list of all modules we processed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162static struct module *modules;
163
Masahiro Yamada8b185742018-05-09 18:50:40 +0900164static struct module *find_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 struct module *mod;
167
168 for (mod = modules; mod; mod = mod->next)
169 if (strcmp(mod->name, modname) == 0)
170 break;
171 return mod;
172}
173
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030174static struct module *new_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175{
176 struct module *mod;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100177
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900178 mod = NOFAIL(malloc(sizeof(*mod) + strlen(modname) + 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 memset(mod, 0, sizeof(*mod));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181 /* add to list */
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900182 strcpy(mod->name, modname);
Masahiro Yamada4de7b622020-06-01 14:57:30 +0900183 mod->is_vmlinux = (strcmp(modname, "vmlinux") == 0);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200184 mod->gpl_compatible = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 mod->next = modules;
186 modules = mod;
187
Masahiro Yamada858b9372020-06-01 14:57:28 +0900188 if (mod->is_vmlinux)
189 have_vmlinux = 1;
190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 return mod;
192}
193
194/* A hash of all exported symbols,
195 * struct symbol is also used for lists of unresolved symbols */
196
197#define SYMBOL_HASH_SIZE 1024
198
199struct symbol {
200 struct symbol *next;
201 struct module *module;
202 unsigned int crc;
203 int crc_valid;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900204 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 unsigned int weak:1;
Denis Efremov15bfc232019-08-01 09:06:57 +0300206 unsigned int is_static:1; /* 1 if symbol is not global */
Ram Paibd5cbce2006-06-08 22:12:53 -0700207 enum export export; /* Type of export */
Gustavo A. R. Silva859c8172020-05-07 13:56:01 -0500208 char name[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209};
210
211static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
212
213/* This is based on the hash agorithm from gdbm, via tdb */
214static inline unsigned int tdb_hash(const char *name)
215{
216 unsigned value; /* Used to compute the hash value. */
217 unsigned i; /* Used to cycle through random values. */
218
219 /* Set the initial value from the key size. */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100220 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
222
223 return (1103515243 * value + 12345);
224}
225
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100226/**
227 * Allocate a new symbols for use in the hash of exported symbols or
228 * the list of unresolved symbols per module
229 **/
230static struct symbol *alloc_symbol(const char *name, unsigned int weak,
231 struct symbol *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232{
233 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
234
235 memset(s, 0, sizeof(*s));
236 strcpy(s->name, name);
237 s->weak = weak;
238 s->next = next;
Denis Efremov15bfc232019-08-01 09:06:57 +0300239 s->is_static = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 return s;
241}
242
243/* For the hash of exported symbols */
Ram Paibd5cbce2006-06-08 22:12:53 -0700244static struct symbol *new_symbol(const char *name, struct module *module,
245 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246{
247 unsigned int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900250 symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
251
252 return symbolhash[hash];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
254
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100255static struct symbol *find_symbol(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256{
257 struct symbol *s;
258
259 /* For our purposes, .foo matches foo. PPC64 needs this. */
260 if (name[0] == '.')
261 name++;
262
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100263 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 if (strcmp(s->name, name) == 0)
265 return s;
266 }
267 return NULL;
268}
269
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100270static bool contains_namespace(struct namespace_list *list,
271 const char *namespace)
272{
Masahiro Yamada76b54cf2019-10-29 21:38:09 +0900273 for (; list; list = list->next)
274 if (!strcmp(list->namespace, namespace))
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100275 return true;
276
277 return false;
278}
279
280static void add_namespace(struct namespace_list **list, const char *namespace)
281{
282 struct namespace_list *ns_entry;
283
284 if (!contains_namespace(*list, namespace)) {
285 ns_entry = NOFAIL(malloc(sizeof(struct namespace_list) +
286 strlen(namespace) + 1));
287 strcpy(ns_entry->namespace, namespace);
288 ns_entry->next = *list;
289 *list = ns_entry;
290 }
291}
292
293static bool module_imports_namespace(struct module *module,
294 const char *namespace)
295{
296 return contains_namespace(module->imported_namespaces, namespace);
297}
298
Mathias Krause7a3ee752014-08-27 20:28:53 +0930299static const struct {
Ram Paibd5cbce2006-06-08 22:12:53 -0700300 const char *str;
301 enum export export;
302} export_list[] = {
303 { .str = "EXPORT_SYMBOL", .export = export_plain },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200304 { .str = "EXPORT_UNUSED_SYMBOL", .export = export_unused },
Ram Paibd5cbce2006-06-08 22:12:53 -0700305 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200306 { .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
Ram Paibd5cbce2006-06-08 22:12:53 -0700307 { .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
308 { .str = "(unknown)", .export = export_unknown },
309};
310
311
312static const char *export_str(enum export ex)
313{
314 return export_list[ex].str;
315}
316
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100317static enum export export_no(const char *s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700318{
319 int i;
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100320
Sam Ravnborg534b89a2006-07-01 10:10:19 +0200321 if (!s)
322 return export_unknown;
Ram Paibd5cbce2006-06-08 22:12:53 -0700323 for (i = 0; export_list[i].export != export_unknown; i++) {
324 if (strcmp(export_list[i].str, s) == 0)
325 return export_list[i].export;
326 }
327 return export_unknown;
328}
329
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900330static void *sym_get_data_by_offset(const struct elf_info *info,
331 unsigned int secindex, unsigned long offset)
Masahiro Yamada6124c042017-09-06 16:19:05 -0700332{
Xiao Yang4b8a5cf2020-03-18 18:34:16 +0800333 Elf_Shdr *sechdr = &info->sechdrs[secindex];
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900334
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900335 if (info->hdr->e_type != ET_REL)
336 offset -= sechdr->sh_addr;
337
338 return (void *)info->hdr + sechdr->sh_offset + offset;
339}
340
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900341static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
342{
343 return sym_get_data_by_offset(info, get_secindex(info, sym),
344 sym->st_value);
345}
346
Masahiro Yamada565587d2020-05-25 14:47:05 +0900347static const char *sech_name(const struct elf_info *info, Elf_Shdr *sechdr)
348{
349 return sym_get_data_by_offset(info, info->secindex_strings,
350 sechdr->sh_name);
351}
352
353static const char *sec_name(const struct elf_info *info, int secindex)
354{
355 return sech_name(info, &info->sechdrs[secindex]);
356}
357
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200358#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
359
360static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
361{
362 const char *secname = sec_name(elf, sec);
363
364 if (strstarts(secname, "___ksymtab+"))
365 return export_plain;
366 else if (strstarts(secname, "___ksymtab_unused+"))
367 return export_unused;
368 else if (strstarts(secname, "___ksymtab_gpl+"))
369 return export_gpl;
370 else if (strstarts(secname, "___ksymtab_unused_gpl+"))
371 return export_unused_gpl;
372 else if (strstarts(secname, "___ksymtab_gpl_future+"))
373 return export_gpl_future;
374 else
375 return export_unknown;
376}
377
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200378static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700379{
380 if (sec == elf->export_sec)
381 return export_plain;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200382 else if (sec == elf->export_unused_sec)
383 return export_unused;
Ram Paibd5cbce2006-06-08 22:12:53 -0700384 else if (sec == elf->export_gpl_sec)
385 return export_gpl;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200386 else if (sec == elf->export_unused_gpl_sec)
387 return export_unused_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700388 else if (sec == elf->export_gpl_future_sec)
389 return export_gpl_future;
390 else
391 return export_unknown;
392}
393
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900394static const char *namespace_from_kstrtabns(const struct elf_info *info,
395 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100396{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900397 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100398 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100399}
400
Matthias Maennicha2b11182019-10-18 10:31:40 +0100401static void sym_update_namespace(const char *symname, const char *namespace)
402{
403 struct symbol *s = find_symbol(symname);
404
405 /*
406 * That symbol should have been created earlier and thus this is
407 * actually an assertion.
408 */
409 if (!s) {
Masahiro Yamadabc72d722020-12-01 19:34:14 +0900410 error("Could not update namespace(%s) for symbol %s\n",
411 namespace, symname);
Matthias Maennicha2b11182019-10-18 10:31:40 +0100412 return;
413 }
414
415 free(s->namespace);
416 s->namespace =
417 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
418}
419
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100420/**
421 * Add an exported symbol - it may have already been added without a
422 * CRC, in this case just update the CRC
423 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100424static struct symbol *sym_add_exported(const char *name, struct module *mod,
425 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426{
427 struct symbol *s = find_symbol(name);
428
429 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700430 s = new_symbol(name, mod, export);
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900431 } else if (!external_module || s->module->is_vmlinux ||
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900432 s->module == mod) {
433 warn("%s: '%s' exported twice. Previous export was in %s%s\n",
434 mod->name, name, s->module->name,
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900435 s->module->is_vmlinux ? "" : ".ko");
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900436 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900438
439 s->module = mod;
Ram Paibd5cbce2006-06-08 22:12:53 -0700440 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100441 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442}
443
Masahiro Yamada17436942019-11-15 02:42:24 +0900444static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100445{
446 struct symbol *s = find_symbol(name);
447
Masahiro Yamada17436942019-11-15 02:42:24 +0900448 /*
449 * Ignore stand-alone __crc_*, which might be auto-generated symbols
450 * such as __*_veneer in ARM ELF.
451 */
452 if (!s)
453 return;
454
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100455 s->crc = crc;
456 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457}
458
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900459static void *grab_file(const char *filename, size_t *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460{
461 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930462 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 int fd;
464
465 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930466 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930468 if (fstat(fd, &st))
469 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
471 *size = st.st_size;
472 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930474failed:
475 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 if (map == MAP_FAILED)
477 return NULL;
478 return map;
479}
480
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900481static void release_file(void *file, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482{
483 munmap(file, size);
484}
485
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100486static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487{
488 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100489 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 Elf_Shdr *sechdrs;
491 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200492 const char *secstrings;
493 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
495 hdr = grab_file(filename, &info->size);
496 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930497 if (ignore_missing_files) {
498 fprintf(stderr, "%s: %s (ignored)\n", filename,
499 strerror(errno));
500 return 0;
501 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200503 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 }
505 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100506 if (info->size < sizeof(*hdr)) {
507 /* file too small, assume this is an empty .o file */
508 return 0;
509 }
510 /* Is this a valid ELF file? */
511 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
512 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
513 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
514 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
515 /* Not an ELF file - silently ignore it */
516 return 0;
517 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200519 hdr->e_type = TO_NATIVE(hdr->e_type);
520 hdr->e_machine = TO_NATIVE(hdr->e_machine);
521 hdr->e_version = TO_NATIVE(hdr->e_version);
522 hdr->e_entry = TO_NATIVE(hdr->e_entry);
523 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
524 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
525 hdr->e_flags = TO_NATIVE(hdr->e_flags);
526 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
527 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
528 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
529 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
530 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
531 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 sechdrs = (void *)hdr + hdr->e_shoff;
533 info->sechdrs = sechdrs;
534
Petr Stetiara83710e2007-08-27 12:15:07 +0200535 /* Check if file offset is correct */
536 if (hdr->e_shoff > info->size) {
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900537 fatal("section header offset=%lu in file '%s' is bigger than filesize=%zu\n",
538 (unsigned long)hdr->e_shoff, filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200539 return 0;
540 }
541
Anders Kaseorg68457562011-05-19 16:55:27 -0600542 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200543 /*
544 * There are more than 64k sections,
545 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200546 */
547 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
548 }
549 else {
550 info->num_sections = hdr->e_shnum;
551 }
552 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600553 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200554 }
555 else {
556 info->secindex_strings = hdr->e_shstrndx;
557 }
558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200560 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200561 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
562 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
563 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
564 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
565 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
566 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
567 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
568 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
569 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
570 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 }
572 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200573 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
574 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700575 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900576 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
Tejun Heo56fc82c2009-02-06 00:48:02 +0900578 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100579 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
580 "sizeof(*hrd)=%zu\n", filename,
581 (unsigned long)sechdrs[i].sh_offset,
582 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100583 return 0;
584 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700585 secname = secstrings + sechdrs[i].sh_name;
586 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900587 if (nobits)
588 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
590 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700591 } else if (strcmp(secname, "__ksymtab") == 0)
592 info->export_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200593 else if (strcmp(secname, "__ksymtab_unused") == 0)
594 info->export_unused_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700595 else if (strcmp(secname, "__ksymtab_gpl") == 0)
596 info->export_gpl_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200597 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
598 info->export_unused_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700599 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
600 info->export_gpl_future_sec = i;
601
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200602 if (sechdrs[i].sh_type == SHT_SYMTAB) {
603 unsigned int sh_link_idx;
604 symtab_idx = i;
605 info->symtab_start = (void *)hdr +
606 sechdrs[i].sh_offset;
607 info->symtab_stop = (void *)hdr +
608 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600609 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200610 info->strtab = (void *)hdr +
611 sechdrs[sh_link_idx].sh_offset;
612 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200614 /* 32bit section no. table? ("more than 64k sections") */
615 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
616 symtab_shndx_idx = i;
617 info->symtab_shndx_start = (void *)hdr +
618 sechdrs[i].sh_offset;
619 info->symtab_shndx_stop = (void *)hdr +
620 sechdrs[i].sh_offset + sechdrs[i].sh_size;
621 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100623 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100624 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 /* Fix endianness in symbols */
627 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
628 sym->st_shndx = TO_NATIVE(sym->st_shndx);
629 sym->st_name = TO_NATIVE(sym->st_name);
630 sym->st_value = TO_NATIVE(sym->st_value);
631 sym->st_size = TO_NATIVE(sym->st_size);
632 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200633
634 if (symtab_shndx_idx != ~0U) {
635 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600636 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200637 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600638 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200639 symtab_idx);
640 /* Fix endianness */
641 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
642 p++)
643 *p = TO_NATIVE(*p);
644 }
645
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100646 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
648
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100649static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
651 release_file(info->hdr, info->size);
652}
653
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200654static int ignore_undef_symbol(struct elf_info *info, const char *symname)
655{
656 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900657 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200658 return 1;
659 /* ignore global offset table */
660 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
661 return 1;
662 if (info->hdr->e_machine == EM_PPC)
663 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900664 if (strstarts(symname, "_restgpr_") ||
665 strstarts(symname, "_savegpr_") ||
666 strstarts(symname, "_rest32gpr_") ||
667 strstarts(symname, "_save32gpr_") ||
668 strstarts(symname, "_restvr_") ||
669 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200670 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000671 if (info->hdr->e_machine == EM_PPC64)
672 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900673 if (strstarts(symname, "_restgpr0_") ||
674 strstarts(symname, "_savegpr0_") ||
675 strstarts(symname, "_restvr_") ||
676 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100677 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000678 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200679 /* Do not ignore this symbol */
680 return 0;
681}
682
Masahiro Yamada17436942019-11-15 02:42:24 +0900683static void handle_modversion(const struct module *mod,
684 const struct elf_info *info,
685 const Elf_Sym *sym, const char *symname)
686{
687 unsigned int crc;
688
689 if (sym->st_shndx == SHN_UNDEF) {
690 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n",
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900691 symname, mod->name, mod->is_vmlinux ? "" : ".ko");
Masahiro Yamada17436942019-11-15 02:42:24 +0900692 return;
693 }
694
695 if (sym->st_shndx == SHN_ABS) {
696 crc = sym->st_value;
697 } else {
698 unsigned int *crcp;
699
700 /* symbol points to the CRC in the ELF object */
701 crcp = sym_get_data(info, sym);
702 crc = TO_NATIVE(*crcp);
703 }
704 sym_set_crc(symname, crc);
705}
706
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900707static void handle_symbol(struct module *mod, struct elf_info *info,
708 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200710 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900711 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200712
Masahiro Yamada33795762020-06-01 14:57:24 +0900713 if (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", \
Thomas Gleixner65538962020-03-09 22:47:17 +0100955 ".kprobes.text", ".cpuidle.text", ".noinstr.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
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002008 {
2009 char *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002011 /* strip trailing .o */
2012 tmp = NOFAIL(strdup(modname));
2013 tmp[strlen(tmp) - 2] = '\0';
2014 mod = new_module(tmp);
2015 free(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 }
2017
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002018 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002019 license = get_modinfo(&info, "license");
2020 if (!license)
Masahiro Yamada1d6cd3922020-12-01 19:34:16 +09002021 error("missing MODULE_LICENSE() in %s\n", modname);
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002022 while (license) {
2023 if (license_is_gpl_compatible(license))
2024 mod->gpl_compatible = 1;
2025 else {
2026 mod->gpl_compatible = 0;
2027 break;
2028 }
2029 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002030 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002031
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002032 namespace = get_modinfo(&info, "import_ns");
2033 while (namespace) {
2034 add_namespace(&mod->imported_namespaces, namespace);
2035 namespace = get_next_modinfo(&info, "import_ns",
2036 namespace);
2037 }
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002038 }
2039
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002041 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002043 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 handle_moddevtable(mod, &info, sym, symname);
2045 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002046
Matthias Maennich69923202019-10-18 10:31:42 +01002047 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2048 symname = remove_dot(info.strtab + sym->st_name);
2049
Masahiro Yamada17436942019-11-15 02:42:24 +09002050 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002051 if (strstarts(symname, "__kstrtabns_"))
2052 sym_update_namespace(symname + strlen("__kstrtabns_"),
2053 namespace_from_kstrtabns(&info,
2054 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002055
2056 if (strstarts(symname, "__crc_"))
2057 handle_modversion(mod, &info, sym,
2058 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002059 }
2060
Denis Efremov15bfc232019-08-01 09:06:57 +03002061 // check for static EXPORT_SYMBOL_* functions && global vars
2062 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2063 unsigned char bind = ELF_ST_BIND(sym->st_info);
2064
2065 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2066 struct symbol *s =
2067 find_symbol(remove_dot(info.strtab +
2068 sym->st_name));
2069
2070 if (s)
2071 s->is_static = 0;
2072 }
2073 }
2074
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002075 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002077 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002078 version = get_modinfo(&info, "version");
2079 if (version || all_versions)
2080 get_src_version(modname, mod->srcversion,
2081 sizeof(mod->srcversion) - 1);
2082 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083
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{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002146 switch (exp) {
2147 case export_gpl:
Masahiro Yamadad6d692f2020-12-01 19:34:17 +09002148 error("GPL-incompatible module %s.ko uses GPL-only symbol '%s'\n",
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002149 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002150 break;
2151 case export_unused_gpl:
Masahiro Yamadad6d692f2020-12-01 19:34:17 +09002152 error("GPL-incompatible module %s.ko uses GPL-only symbol marked UNUSED '%s'\n",
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002153 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002154 break;
2155 case export_gpl_future:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002156 warn("GPL-incompatible module %s.ko uses future GPL-only symbol '%s'\n",
2157 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002158 break;
2159 case export_plain:
2160 case export_unused:
2161 case export_unknown:
2162 /* ignore */
2163 break;
2164 }
2165}
2166
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002167static void check_for_unused(enum export exp, const char *m, const char *s)
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002168{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002169 switch (exp) {
2170 case export_unused:
2171 case export_unused_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002172 warn("module %s.ko uses symbol '%s' marked UNUSED\n",
2173 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002174 break;
2175 default:
2176 /* ignore */
2177 break;
2178 }
2179}
2180
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002181static void check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002182{
2183 struct symbol *s, *exp;
2184
2185 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002186 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002187 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002188 if (!exp || exp->module == mod) {
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002189 if (have_vmlinux && !s->weak)
Jessica Yu93c95e52020-03-06 17:02:05 +01002190 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2191 "\"%s\" [%s.ko] undefined!\n",
2192 s->name, mod->name);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002193 continue;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002194 }
Andrew Morton6449bd62006-06-09 20:45:06 -07002195 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002196 if (basename)
2197 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002198 else
2199 basename = mod->name;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002200
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002201 if (exp->namespace &&
2202 !module_imports_namespace(mod, exp->namespace)) {
Jessica Yu54b77842020-03-06 17:02:06 +01002203 modpost_log(allow_missing_ns_imports ? LOG_WARN : LOG_ERROR,
2204 "module %s uses symbol %s from namespace %s, but does not import it.\n",
2205 basename, exp->name, exp->namespace);
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002206 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002207 }
2208
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002209 if (!mod->gpl_compatible)
2210 check_for_gpl_usage(exp->export, basename, exp->name);
2211 check_for_unused(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002212 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002213}
2214
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002215static void check_modname_len(struct module *mod)
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002216{
2217 const char *mod_name;
2218
2219 mod_name = strrchr(mod->name, '/');
2220 if (mod_name == NULL)
2221 mod_name = mod->name;
2222 else
2223 mod_name++;
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002224 if (strlen(mod_name) >= MODULE_NAME_LEN)
Masahiro Yamadabc72d722020-12-01 19:34:14 +09002225 error("module name is too long [%s.ko]\n", mod->name);
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002226}
2227
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002228/**
2229 * Header for the generated file
2230 **/
2231static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232{
2233 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002234 /*
2235 * Include build-salt.h after module.h in order to
2236 * inherit the definitions.
2237 */
Leon Romanovsky51161bf2020-04-19 18:55:06 +03002238 buf_printf(b, "#define INCLUDE_VERMAGIC\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002239 buf_printf(b, "#include <linux/build-salt.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 buf_printf(b, "#include <linux/vermagic.h>\n");
2241 buf_printf(b, "#include <linux/compiler.h>\n");
2242 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002243 buf_printf(b, "BUILD_SALT;\n");
2244 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002246 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302248 buf_printf(b, "__visible struct module __this_module\n");
Joe Perches33def842020-10-21 19:36:07 -07002249 buf_printf(b, "__section(\".gnu.linkonce.this_module\") = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002250 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002252 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 if (mod->has_cleanup)
2254 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002255 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002257 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 buf_printf(b, "};\n");
2259}
2260
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002261static void add_intree_flag(struct buffer *b, int is_intree)
2262{
2263 if (is_intree)
2264 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2265}
2266
Andi Kleencaf75012018-01-25 15:50:28 -08002267/* Cannot check for assembler */
2268static void add_retpoline(struct buffer *b)
2269{
WANG Chaoe4f35892018-12-11 00:37:25 +08002270 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002271 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2272 buf_printf(b, "#endif\n");
2273}
2274
Trevor Keith5c725132009-09-22 16:43:38 -07002275static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002276{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002277 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002278 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2279}
2280
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002281/**
2282 * Record CRCs for unresolved symbols
2283 **/
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002284static void add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285{
2286 struct symbol *s, *exp;
2287
2288 for (s = mod->unres; s; s = s->next) {
2289 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002290 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 s->module = exp->module;
2293 s->crc_valid = exp->crc_valid;
2294 s->crc = exp->crc;
2295 }
2296
2297 if (!modversions)
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002298 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299
2300 buf_printf(b, "\n");
2301 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Joe Perches33def842020-10-21 19:36:07 -07002302 buf_printf(b, "__used __section(\"__versions\") = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303
2304 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002305 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002308 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 s->name, mod->name);
2310 continue;
2311 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302312 if (strlen(s->name) >= MODULE_NAME_LEN) {
Masahiro Yamadabc72d722020-12-01 19:34:14 +09002313 error("too long symbol \"%s\" [%s.ko]\n",
2314 s->name, mod->name);
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302315 break;
2316 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002317 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302318 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 }
2320
2321 buf_printf(b, "};\n");
2322}
2323
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002324static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325{
2326 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 int first = 1;
2328
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002329 /* Clear ->seen flag of modules that own symbols needed by this. */
2330 for (s = mod->unres; s; s = s->next)
2331 if (s->module)
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002332 s->module->seen = s->module->is_vmlinux;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333
2334 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002335 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002337 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 if (!s->module)
2339 continue;
2340
2341 if (s->module->seen)
2342 continue;
2343
2344 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002345 p = strrchr(s->module->name, '/');
2346 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002347 p++;
2348 else
2349 p = s->module->name;
2350 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 first = 0;
2352 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002353 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354}
2355
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002356static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357{
2358 if (mod->srcversion[0]) {
2359 buf_printf(b, "\n");
2360 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2361 mod->srcversion);
2362 }
2363}
2364
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002365static void write_buf(struct buffer *b, const char *fname)
2366{
2367 FILE *file;
2368
2369 file = fopen(fname, "w");
2370 if (!file) {
2371 perror(fname);
2372 exit(1);
2373 }
2374 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2375 perror(fname);
2376 exit(1);
2377 }
2378 if (fclose(file) != 0) {
2379 perror(fname);
2380 exit(1);
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:
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002416 write_buf(b, fname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417}
2418
Ram Paibd5cbce2006-06-08 22:12:53 -07002419/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002420 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002421 **/
Masahiro Yamada52c34162020-06-01 14:57:05 +09002422static void read_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423{
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002424 char *buf, *pos, *line;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002426 buf = read_text_file(fname);
2427 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428 /* No symbol versions, silently ignore */
2429 return;
2430
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002431 pos = buf;
2432
2433 while ((line = get_line(&pos))) {
Jessica Yu51900442020-03-11 18:01:20 +01002434 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 unsigned int crc;
2436 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002437 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438
2439 if (!(symname = strchr(line, '\t')))
2440 goto fail;
2441 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002442 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 goto fail;
2444 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002445 if (!(export = strchr(modname, '\t')))
2446 goto fail;
2447 *export++ = '\0';
2448 if (!(namespace = strchr(export, '\t')))
2449 goto fail;
2450 *namespace++ = '\0';
2451
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452 crc = strtoul(line, &d, 16);
2453 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2454 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002455 mod = find_module(modname);
2456 if (!mod) {
Jan Beulich0fa3a882009-03-12 12:28:30 +00002457 mod = new_module(modname);
Masahiro Yamada52c34162020-06-01 14:57:05 +09002458 mod->from_dump = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002460 s = sym_add_exported(symname, mod, export_no(export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002461 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002462 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002463 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 }
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002465 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 return;
2467fail:
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002468 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 fatal("parse error in symbol dump file\n");
2470}
2471
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002472/* For normal builds always dump all symbols.
2473 * For external modules only dump symbols
2474 * that are not read from kernel Module.symvers.
2475 **/
2476static int dump_sym(struct symbol *sym)
2477{
2478 if (!external_module)
2479 return 1;
Masahiro Yamada52c34162020-06-01 14:57:05 +09002480 if (sym->module->from_dump)
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002481 return 0;
2482 return 1;
2483}
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002484
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002485static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486{
2487 struct buffer buf = { };
2488 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002489 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490 int n;
2491
2492 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2493 symbol = symbolhash[n];
2494 while (symbol) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002495 if (dump_sym(symbol)) {
2496 namespace = symbol->namespace;
2497 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2498 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002499 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002500 export_str(symbol->export),
2501 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002502 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503 symbol = symbol->next;
2504 }
2505 }
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002506 write_buf(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002507 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508}
2509
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002510static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002511{
2512 struct module *mod;
2513 struct namespace_list *ns;
2514 struct buffer ns_deps_buf = {};
2515
2516 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002517
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002518 if (mod->from_dump || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002519 continue;
2520
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002521 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002522
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002523 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2524 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002525
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002526 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002527 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002528
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002529 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002530 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002531}
2532
Masahiro Yamada79247992020-06-01 14:57:07 +09002533struct dump_list {
2534 struct dump_list *next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002535 const char *file;
2536};
2537
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002538int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539{
2540 struct module *mod;
2541 struct buffer buf = { };
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002542 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302543 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 int opt;
Denis Efremov15bfc232019-08-01 09:06:57 +03002545 int n;
Masahiro Yamada79247992020-06-01 14:57:07 +09002546 struct dump_list *dump_read_start = NULL;
2547 struct dump_list **dump_read_iter = &dump_read_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002549 while ((opt = getopt(argc, argv, "ei:mnT:o:awENd:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002550 switch (opt) {
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002551 case 'e':
2552 external_module = 1;
Masahiro Yamadae3fb4df2020-06-01 14:57:08 +09002553 break;
2554 case 'i':
Masahiro Yamada79247992020-06-01 14:57:07 +09002555 *dump_read_iter =
2556 NOFAIL(calloc(1, sizeof(**dump_read_iter)));
2557 (*dump_read_iter)->file = optarg;
2558 dump_read_iter = &(*dump_read_iter)->next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002559 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002560 case 'm':
2561 modversions = 1;
2562 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302563 case 'n':
2564 ignore_missing_files = 1;
2565 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002566 case 'o':
2567 dump_write = optarg;
2568 break;
2569 case 'a':
2570 all_versions = 1;
2571 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302572 case 'T':
2573 files_source = optarg;
2574 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002575 case 'w':
2576 warn_unresolved = 1;
2577 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302578 case 'E':
Masahiro Yamadac7299d92020-12-01 19:34:18 +09002579 sec_mismatch_warn_only = false;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302580 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002581 case 'N':
2582 allow_missing_ns_imports = 1;
2583 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002584 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002585 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002586 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002587 default:
2588 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589 }
2590 }
2591
Masahiro Yamada79247992020-06-01 14:57:07 +09002592 while (dump_read_start) {
2593 struct dump_list *tmp;
Masahiro Yamada2beee862020-06-01 14:57:04 +09002594
Masahiro Yamada79247992020-06-01 14:57:07 +09002595 read_dump(dump_read_start->file);
2596 tmp = dump_read_start->next;
2597 free(dump_read_start);
2598 dump_read_start = tmp;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002599 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002601 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603
Rusty Russell712f9b42013-04-04 17:37:38 +10302604 if (files_source)
2605 read_symbols_from_files(files_source);
2606
Masahiro Yamada7e8a3232020-06-01 14:57:13 +09002607 /*
2608 * When there's no vmlinux, don't print warnings about
2609 * unresolved symbols (since there'll be too many ;)
2610 */
2611 if (!have_vmlinux)
2612 warn("Symbol info of vmlinux is missing. Unresolved symbol check will be entirely skipped.\n");
2613
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002614 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302615 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002616
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002617 if (mod->is_vmlinux || mod->from_dump)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002618 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619
2620 buf.pos = 0;
2621
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002622 check_modname_len(mod);
2623 check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002624
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002626 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002627 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002628 add_staging_flag(&buf, mod->name);
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002629 add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002630 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631 add_moddevtable(&buf, mod);
2632 add_srcversion(&buf, mod);
2633
2634 sprintf(fname, "%s.mod.c", mod->name);
2635 write_if_changed(&buf, fname);
2636 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002637
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002638 if (missing_namespace_deps)
2639 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002640
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641 if (dump_write)
2642 write_dump(dump_write);
Masahiro Yamadac7299d92020-12-01 19:34:18 +09002643 if (sec_mismatch_count && !sec_mismatch_warn_only)
2644 error("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002645 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002646 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002647 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002648
Masahiro Yamada47346e92019-09-24 21:07:40 +09002649 for (s = symbolhash[n]; s; s = s->next) {
Denis Efremov15bfc232019-08-01 09:06:57 +03002650 if (s->is_static)
2651 warn("\"%s\" [%s] is a static %s\n",
2652 s->name, s->module->name,
2653 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002654 }
2655 }
2656
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002657 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002659 return error_occurred ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660}