blob: e08f75aed4293335aee5382a606b27bb08f85488 [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;
Nicolas Boichat47490ec2015-10-06 09:44:42 +103037static int sec_mismatch_fatal = 0;
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
Sam Ravnborgc96fca22006-07-01 11:44:23 +020043enum export {
44 export_plain, export_unused, export_gpl,
45 export_unused_gpl, export_gpl_future, export_unknown
46};
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +080048/* In kernel, this size is defined in linux/module.h;
49 * here we use Elf_Addr instead of long for covering cross-compile
50 */
51
52#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
53
Jessica Yu93c95e52020-03-06 17:02:05 +010054void __attribute__((format(printf, 2, 3)))
55modpost_log(enum loglevel loglevel, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056{
57 va_list arglist;
58
Jessica Yu93c95e52020-03-06 17:02:05 +010059 switch (loglevel) {
60 case LOG_WARN:
61 fprintf(stderr, "WARNING: ");
62 break;
63 case LOG_ERROR:
64 fprintf(stderr, "ERROR: ");
65 break;
66 case LOG_FATAL:
67 fprintf(stderr, "FATAL: ");
68 break;
69 default: /* invalid loglevel, ignore */
70 break;
71 }
72
73 fprintf(stderr, "modpost: ");
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75 va_start(arglist, fmt);
76 vfprintf(stderr, fmt, arglist);
77 va_end(arglist);
78
Jessica Yu93c95e52020-03-06 17:02:05 +010079 if (loglevel == LOG_FATAL)
80 exit(1);
Matthew Wilcox2a116652006-10-07 05:35:32 -060081}
82
Rusty Russelld4ef1c32013-04-04 17:37:32 +103083static inline bool strends(const char *str, const char *postfix)
84{
85 if (strlen(str) < strlen(postfix))
86 return false;
87
88 return strcmp(str + strlen(str) - strlen(postfix), postfix) == 0;
89}
90
Linus Torvalds1da177e2005-04-16 15:20:36 -070091void *do_nofail(void *ptr, const char *expr)
92{
Sam Ravnborgdf578e72008-01-11 19:17:15 +010093 if (!ptr)
Jessica Yu93c95e52020-03-06 17:02:05 +010094 fatal("Memory allocation failure: %s.\n", expr);
Sam Ravnborgdf578e72008-01-11 19:17:15 +010095
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 return ptr;
97}
98
Masahiro Yamadaac5100f2020-06-01 14:57:17 +090099char *read_text_file(const char *filename)
100{
101 struct stat st;
102 size_t nbytes;
103 int fd;
104 char *buf;
105
106 fd = open(filename, O_RDONLY);
107 if (fd < 0) {
108 perror(filename);
109 exit(1);
110 }
111
112 if (fstat(fd, &st) < 0) {
113 perror(filename);
114 exit(1);
115 }
116
117 buf = NOFAIL(malloc(st.st_size + 1));
118
119 nbytes = st.st_size;
120
121 while (nbytes) {
122 ssize_t bytes_read;
123
124 bytes_read = read(fd, buf, nbytes);
125 if (bytes_read < 0) {
126 perror(filename);
127 exit(1);
128 }
129
130 nbytes -= bytes_read;
131 }
132 buf[st.st_size] = '\0';
133
134 close(fd);
135
136 return buf;
137}
138
139char *get_line(char **stringp)
140{
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200141 char *orig = *stringp, *next;
142
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900143 /* do not return the unwanted extra line at EOF */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200144 if (!orig || *orig == '\0')
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900145 return NULL;
146
Wolfram Sang6020db52020-07-26 23:44:19 +0200147 /* don't use strsep here, it is not available everywhere */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200148 next = strchr(orig, '\n');
149 if (next)
150 *next++ = '\0';
151
152 *stringp = next;
153
154 return orig;
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900155}
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157/* A list of all modules we processed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158static struct module *modules;
159
Masahiro Yamada8b185742018-05-09 18:50:40 +0900160static struct module *find_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161{
162 struct module *mod;
163
164 for (mod = modules; mod; mod = mod->next)
165 if (strcmp(mod->name, modname) == 0)
166 break;
167 return mod;
168}
169
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030170static struct module *new_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
172 struct module *mod;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100173
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900174 mod = NOFAIL(malloc(sizeof(*mod) + strlen(modname) + 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 memset(mod, 0, sizeof(*mod));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 /* add to list */
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900178 strcpy(mod->name, modname);
Masahiro Yamada4de7b622020-06-01 14:57:30 +0900179 mod->is_vmlinux = (strcmp(modname, "vmlinux") == 0);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200180 mod->gpl_compatible = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 mod->next = modules;
182 modules = mod;
183
Masahiro Yamada858b9372020-06-01 14:57:28 +0900184 if (mod->is_vmlinux)
185 have_vmlinux = 1;
186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 return mod;
188}
189
190/* A hash of all exported symbols,
191 * struct symbol is also used for lists of unresolved symbols */
192
193#define SYMBOL_HASH_SIZE 1024
194
195struct symbol {
196 struct symbol *next;
197 struct module *module;
198 unsigned int crc;
199 int crc_valid;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900200 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 unsigned int weak:1;
Denis Efremov15bfc232019-08-01 09:06:57 +0300202 unsigned int is_static:1; /* 1 if symbol is not global */
Ram Paibd5cbce2006-06-08 22:12:53 -0700203 enum export export; /* Type of export */
Gustavo A. R. Silva859c8172020-05-07 13:56:01 -0500204 char name[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205};
206
207static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
208
209/* This is based on the hash agorithm from gdbm, via tdb */
210static inline unsigned int tdb_hash(const char *name)
211{
212 unsigned value; /* Used to compute the hash value. */
213 unsigned i; /* Used to cycle through random values. */
214
215 /* Set the initial value from the key size. */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100216 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
218
219 return (1103515243 * value + 12345);
220}
221
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100222/**
223 * Allocate a new symbols for use in the hash of exported symbols or
224 * the list of unresolved symbols per module
225 **/
226static struct symbol *alloc_symbol(const char *name, unsigned int weak,
227 struct symbol *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228{
229 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
230
231 memset(s, 0, sizeof(*s));
232 strcpy(s->name, name);
233 s->weak = weak;
234 s->next = next;
Denis Efremov15bfc232019-08-01 09:06:57 +0300235 s->is_static = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 return s;
237}
238
239/* For the hash of exported symbols */
Ram Paibd5cbce2006-06-08 22:12:53 -0700240static struct symbol *new_symbol(const char *name, struct module *module,
241 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242{
243 unsigned int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900246 symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
247
248 return symbolhash[hash];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249}
250
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100251static struct symbol *find_symbol(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252{
253 struct symbol *s;
254
255 /* For our purposes, .foo matches foo. PPC64 needs this. */
256 if (name[0] == '.')
257 name++;
258
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100259 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 if (strcmp(s->name, name) == 0)
261 return s;
262 }
263 return NULL;
264}
265
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100266static bool contains_namespace(struct namespace_list *list,
267 const char *namespace)
268{
Masahiro Yamada76b54cf2019-10-29 21:38:09 +0900269 for (; list; list = list->next)
270 if (!strcmp(list->namespace, namespace))
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100271 return true;
272
273 return false;
274}
275
276static void add_namespace(struct namespace_list **list, const char *namespace)
277{
278 struct namespace_list *ns_entry;
279
280 if (!contains_namespace(*list, namespace)) {
281 ns_entry = NOFAIL(malloc(sizeof(struct namespace_list) +
282 strlen(namespace) + 1));
283 strcpy(ns_entry->namespace, namespace);
284 ns_entry->next = *list;
285 *list = ns_entry;
286 }
287}
288
289static bool module_imports_namespace(struct module *module,
290 const char *namespace)
291{
292 return contains_namespace(module->imported_namespaces, namespace);
293}
294
Mathias Krause7a3ee752014-08-27 20:28:53 +0930295static const struct {
Ram Paibd5cbce2006-06-08 22:12:53 -0700296 const char *str;
297 enum export export;
298} export_list[] = {
299 { .str = "EXPORT_SYMBOL", .export = export_plain },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200300 { .str = "EXPORT_UNUSED_SYMBOL", .export = export_unused },
Ram Paibd5cbce2006-06-08 22:12:53 -0700301 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200302 { .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
Ram Paibd5cbce2006-06-08 22:12:53 -0700303 { .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
304 { .str = "(unknown)", .export = export_unknown },
305};
306
307
308static const char *export_str(enum export ex)
309{
310 return export_list[ex].str;
311}
312
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100313static enum export export_no(const char *s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700314{
315 int i;
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100316
Sam Ravnborg534b89a2006-07-01 10:10:19 +0200317 if (!s)
318 return export_unknown;
Ram Paibd5cbce2006-06-08 22:12:53 -0700319 for (i = 0; export_list[i].export != export_unknown; i++) {
320 if (strcmp(export_list[i].str, s) == 0)
321 return export_list[i].export;
322 }
323 return export_unknown;
324}
325
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900326static void *sym_get_data_by_offset(const struct elf_info *info,
327 unsigned int secindex, unsigned long offset)
Masahiro Yamada6124c042017-09-06 16:19:05 -0700328{
Xiao Yang4b8a5cf2020-03-18 18:34:16 +0800329 Elf_Shdr *sechdr = &info->sechdrs[secindex];
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900330
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900331 if (info->hdr->e_type != ET_REL)
332 offset -= sechdr->sh_addr;
333
334 return (void *)info->hdr + sechdr->sh_offset + offset;
335}
336
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900337static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
338{
339 return sym_get_data_by_offset(info, get_secindex(info, sym),
340 sym->st_value);
341}
342
Masahiro Yamada565587d2020-05-25 14:47:05 +0900343static const char *sech_name(const struct elf_info *info, Elf_Shdr *sechdr)
344{
345 return sym_get_data_by_offset(info, info->secindex_strings,
346 sechdr->sh_name);
347}
348
349static const char *sec_name(const struct elf_info *info, int secindex)
350{
351 return sech_name(info, &info->sechdrs[secindex]);
352}
353
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200354#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
355
356static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
357{
358 const char *secname = sec_name(elf, sec);
359
360 if (strstarts(secname, "___ksymtab+"))
361 return export_plain;
362 else if (strstarts(secname, "___ksymtab_unused+"))
363 return export_unused;
364 else if (strstarts(secname, "___ksymtab_gpl+"))
365 return export_gpl;
366 else if (strstarts(secname, "___ksymtab_unused_gpl+"))
367 return export_unused_gpl;
368 else if (strstarts(secname, "___ksymtab_gpl_future+"))
369 return export_gpl_future;
370 else
371 return export_unknown;
372}
373
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200374static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700375{
376 if (sec == elf->export_sec)
377 return export_plain;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200378 else if (sec == elf->export_unused_sec)
379 return export_unused;
Ram Paibd5cbce2006-06-08 22:12:53 -0700380 else if (sec == elf->export_gpl_sec)
381 return export_gpl;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200382 else if (sec == elf->export_unused_gpl_sec)
383 return export_unused_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700384 else if (sec == elf->export_gpl_future_sec)
385 return export_gpl_future;
386 else
387 return export_unknown;
388}
389
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900390static const char *namespace_from_kstrtabns(const struct elf_info *info,
391 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100392{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900393 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100394 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100395}
396
Matthias Maennicha2b11182019-10-18 10:31:40 +0100397static void sym_update_namespace(const char *symname, const char *namespace)
398{
399 struct symbol *s = find_symbol(symname);
400
401 /*
402 * That symbol should have been created earlier and thus this is
403 * actually an assertion.
404 */
405 if (!s) {
406 merror("Could not update namespace(%s) for symbol %s\n",
407 namespace, symname);
408 return;
409 }
410
411 free(s->namespace);
412 s->namespace =
413 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
414}
415
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100416/**
417 * Add an exported symbol - it may have already been added without a
418 * CRC, in this case just update the CRC
419 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100420static struct symbol *sym_add_exported(const char *name, struct module *mod,
421 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422{
423 struct symbol *s = find_symbol(name);
424
425 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700426 s = new_symbol(name, mod, export);
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900427 } else if (!external_module || s->module->is_vmlinux ||
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900428 s->module == mod) {
429 warn("%s: '%s' exported twice. Previous export was in %s%s\n",
430 mod->name, name, s->module->name,
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900431 s->module->is_vmlinux ? "" : ".ko");
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900432 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900434
435 s->module = mod;
Ram Paibd5cbce2006-06-08 22:12:53 -0700436 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100437 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438}
439
Masahiro Yamada17436942019-11-15 02:42:24 +0900440static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100441{
442 struct symbol *s = find_symbol(name);
443
Masahiro Yamada17436942019-11-15 02:42:24 +0900444 /*
445 * Ignore stand-alone __crc_*, which might be auto-generated symbols
446 * such as __*_veneer in ARM ELF.
447 */
448 if (!s)
449 return;
450
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100451 s->crc = crc;
452 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453}
454
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900455static void *grab_file(const char *filename, size_t *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456{
457 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930458 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 int fd;
460
461 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930462 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930464 if (fstat(fd, &st))
465 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
467 *size = st.st_size;
468 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930470failed:
471 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 if (map == MAP_FAILED)
473 return NULL;
474 return map;
475}
476
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900477static void release_file(void *file, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478{
479 munmap(file, size);
480}
481
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100482static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483{
484 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100485 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 Elf_Shdr *sechdrs;
487 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200488 const char *secstrings;
489 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
491 hdr = grab_file(filename, &info->size);
492 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930493 if (ignore_missing_files) {
494 fprintf(stderr, "%s: %s (ignored)\n", filename,
495 strerror(errno));
496 return 0;
497 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200499 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 }
501 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100502 if (info->size < sizeof(*hdr)) {
503 /* file too small, assume this is an empty .o file */
504 return 0;
505 }
506 /* Is this a valid ELF file? */
507 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
508 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
509 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
510 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
511 /* Not an ELF file - silently ignore it */
512 return 0;
513 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200515 hdr->e_type = TO_NATIVE(hdr->e_type);
516 hdr->e_machine = TO_NATIVE(hdr->e_machine);
517 hdr->e_version = TO_NATIVE(hdr->e_version);
518 hdr->e_entry = TO_NATIVE(hdr->e_entry);
519 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
520 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
521 hdr->e_flags = TO_NATIVE(hdr->e_flags);
522 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
523 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
524 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
525 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
526 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
527 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 sechdrs = (void *)hdr + hdr->e_shoff;
529 info->sechdrs = sechdrs;
530
Petr Stetiara83710e2007-08-27 12:15:07 +0200531 /* Check if file offset is correct */
532 if (hdr->e_shoff > info->size) {
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900533 fatal("section header offset=%lu in file '%s' is bigger than filesize=%zu\n",
534 (unsigned long)hdr->e_shoff, filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200535 return 0;
536 }
537
Anders Kaseorg68457562011-05-19 16:55:27 -0600538 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200539 /*
540 * There are more than 64k sections,
541 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200542 */
543 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
544 }
545 else {
546 info->num_sections = hdr->e_shnum;
547 }
548 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600549 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200550 }
551 else {
552 info->secindex_strings = hdr->e_shstrndx;
553 }
554
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200556 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200557 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
558 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
559 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
560 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
561 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
562 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
563 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
564 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
565 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
566 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 }
568 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200569 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
570 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700571 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900572 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Tejun Heo56fc82c2009-02-06 00:48:02 +0900574 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100575 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
576 "sizeof(*hrd)=%zu\n", filename,
577 (unsigned long)sechdrs[i].sh_offset,
578 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100579 return 0;
580 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700581 secname = secstrings + sechdrs[i].sh_name;
582 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900583 if (nobits)
584 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
586 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700587 } else if (strcmp(secname, "__ksymtab") == 0)
588 info->export_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200589 else if (strcmp(secname, "__ksymtab_unused") == 0)
590 info->export_unused_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700591 else if (strcmp(secname, "__ksymtab_gpl") == 0)
592 info->export_gpl_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200593 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
594 info->export_unused_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700595 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
596 info->export_gpl_future_sec = i;
597
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200598 if (sechdrs[i].sh_type == SHT_SYMTAB) {
599 unsigned int sh_link_idx;
600 symtab_idx = i;
601 info->symtab_start = (void *)hdr +
602 sechdrs[i].sh_offset;
603 info->symtab_stop = (void *)hdr +
604 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600605 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200606 info->strtab = (void *)hdr +
607 sechdrs[sh_link_idx].sh_offset;
608 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200610 /* 32bit section no. table? ("more than 64k sections") */
611 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
612 symtab_shndx_idx = i;
613 info->symtab_shndx_start = (void *)hdr +
614 sechdrs[i].sh_offset;
615 info->symtab_shndx_stop = (void *)hdr +
616 sechdrs[i].sh_offset + sechdrs[i].sh_size;
617 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100619 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100620 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 /* Fix endianness in symbols */
623 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
624 sym->st_shndx = TO_NATIVE(sym->st_shndx);
625 sym->st_name = TO_NATIVE(sym->st_name);
626 sym->st_value = TO_NATIVE(sym->st_value);
627 sym->st_size = TO_NATIVE(sym->st_size);
628 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200629
630 if (symtab_shndx_idx != ~0U) {
631 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600632 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200633 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600634 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200635 symtab_idx);
636 /* Fix endianness */
637 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
638 p++)
639 *p = TO_NATIVE(*p);
640 }
641
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100642 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643}
644
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100645static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646{
647 release_file(info->hdr, info->size);
648}
649
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200650static int ignore_undef_symbol(struct elf_info *info, const char *symname)
651{
652 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900653 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200654 return 1;
655 /* ignore global offset table */
656 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
657 return 1;
658 if (info->hdr->e_machine == EM_PPC)
659 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900660 if (strstarts(symname, "_restgpr_") ||
661 strstarts(symname, "_savegpr_") ||
662 strstarts(symname, "_rest32gpr_") ||
663 strstarts(symname, "_save32gpr_") ||
664 strstarts(symname, "_restvr_") ||
665 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200666 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000667 if (info->hdr->e_machine == EM_PPC64)
668 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900669 if (strstarts(symname, "_restgpr0_") ||
670 strstarts(symname, "_savegpr0_") ||
671 strstarts(symname, "_restvr_") ||
672 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100673 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000674 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200675 /* Do not ignore this symbol */
676 return 0;
677}
678
Masahiro Yamada17436942019-11-15 02:42:24 +0900679static void handle_modversion(const struct module *mod,
680 const struct elf_info *info,
681 const Elf_Sym *sym, const char *symname)
682{
683 unsigned int crc;
684
685 if (sym->st_shndx == SHN_UNDEF) {
686 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n",
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900687 symname, mod->name, mod->is_vmlinux ? "" : ".ko");
Masahiro Yamada17436942019-11-15 02:42:24 +0900688 return;
689 }
690
691 if (sym->st_shndx == SHN_ABS) {
692 crc = sym->st_value;
693 } else {
694 unsigned int *crcp;
695
696 /* symbol points to the CRC in the ELF object */
697 crcp = sym_get_data(info, sym);
698 crc = TO_NATIVE(*crcp);
699 }
700 sym_set_crc(symname, crc);
701}
702
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900703static void handle_symbol(struct module *mod, struct elf_info *info,
704 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200706 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900707 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200708
Masahiro Yamada33795762020-06-01 14:57:24 +0900709 if (strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200710 export = export_from_secname(info, get_secindex(info, sym));
711 else
712 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 switch (sym->st_shndx) {
715 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900716 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100717 /* Should warn here, but modpost runs before the linker */
718 } else
719 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 case SHN_UNDEF:
722 /* undefined symbol */
723 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
724 ELF_ST_BIND(sym->st_info) != STB_WEAK)
725 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200726 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 if (info->hdr->e_machine == EM_SPARC ||
729 info->hdr->e_machine == EM_SPARCV9) {
730 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700731 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100733 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700734 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100735 munged[0] = '_';
736 munged[1] = toupper(munged[1]);
737 symname = munged;
738 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100740
Rusty Russellb92021b2013-03-15 15:04:17 +1030741 mod->unres = alloc_symbol(symname,
742 ELF_ST_BIND(sym->st_info) == STB_WEAK,
743 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 break;
745 default:
746 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900747 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100748 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100749 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900751 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900753 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 mod->has_cleanup = 1;
755 break;
756 }
757}
758
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100759/**
760 * Parse tag=value strings from .modinfo section
761 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762static char *next_string(char *string, unsigned long *secsize)
763{
764 /* Skip non-zero chars */
765 while (string[0]) {
766 string++;
767 if ((*secsize)-- <= 1)
768 return NULL;
769 }
770
771 /* Skip any zero padding. */
772 while (!string[0]) {
773 string++;
774 if ((*secsize)-- <= 1)
775 return NULL;
776 }
777 return string;
778}
779
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900780static char *get_next_modinfo(struct elf_info *info, const char *tag,
781 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782{
783 char *p;
784 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900785 char *modinfo = info->modinfo;
786 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900788 if (prev) {
789 size -= prev - modinfo;
790 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200791 }
792
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 for (p = modinfo; p; p = next_string(p, &size)) {
794 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
795 return p + taglen + 1;
796 }
797 return NULL;
798}
799
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900800static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200801
802{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900803 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200804}
805
Sam Ravnborg93684d32006-02-19 11:53:35 +0100806/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100807 * Test if string s ends in string sub
808 * return 0 if match
809 **/
810static int strrcmp(const char *s, const char *sub)
811{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100812 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100813
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100814 if (!s || !sub)
815 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100816
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100817 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100818 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100819
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100820 if ((slen == 0) || (sublen == 0))
821 return 1;
822
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100823 if (sublen > slen)
824 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100825
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100826 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100827}
828
Sam Ravnborgff13f922008-01-23 19:54:27 +0100829static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
830{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100831 if (sym)
832 return elf->strtab + sym->st_name;
833 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100834 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100835}
836
Sam Ravnborg10668222008-01-13 22:21:31 +0100837/* The pattern is an array of simple patterns.
838 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100839 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100840 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930841 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100842 */
Trevor Keith5c725132009-09-22 16:43:38 -0700843static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100844{
845 const char *p;
846 while (*pat) {
847 p = *pat++;
848 const char *endp = p + strlen(p) - 1;
849
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930850 /* "*foo*" */
851 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300852 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
853 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930854
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930855 free(bare);
856 if (here != NULL)
857 return 1;
858 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100859 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930860 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100861 if (strrcmp(sym, p + 1) == 0)
862 return 1;
863 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100864 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100865 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100866 if (strncmp(sym, p, strlen(p) - 1) == 0)
867 return 1;
868 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100869 /* no wildcards */
870 else {
871 if (strcmp(p, sym) == 0)
872 return 1;
873 }
874 }
875 /* no match */
876 return 0;
877}
878
Sam Ravnborg10668222008-01-13 22:21:31 +0100879/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930880static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200881{
882 ".comment*",
883 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930884 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800885 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000886 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200887 ".mdebug*", /* alpha, score, mips etc. */
888 ".pdr", /* alpha, score, mips etc. */
889 ".stab*",
890 ".note*",
891 ".got*",
892 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400893 ".xt.prop", /* xtensa */
894 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030895 ".arcextmap*", /* arc */
896 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030897 ".cmem*", /* EZchip */
898 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100899 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600900 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200901 NULL
902};
Sam Ravnborg10668222008-01-13 22:21:31 +0100903
Sam Ravnborge241a632008-01-28 20:13:13 +0100904/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400905 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100906 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400907 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100908 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400909static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900910 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100911{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400912 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100913
Anders Kaseorgb614a692009-04-23 16:49:33 -0400914 if (sechdr->sh_type == SHT_PROGBITS &&
915 !(sechdr->sh_flags & SHF_ALLOC) &&
916 !match(sec, section_white_list)) {
917 warn("%s (%s): unexpected non-allocatable section.\n"
918 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
919 "Note that for example <linux/init.h> contains\n"
920 "section definitions for use in .S files.\n\n",
921 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100922 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100923}
924
925
926
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100927#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930928 ".init.setup", ".init.rodata", ".meminit.rodata", \
929 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100930#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930931 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100932
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100933#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930934 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100935#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930936 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100937
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200938#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930939 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
940 ".pci_fixup_enable", ".pci_fixup_resume", \
941 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200942
Paul Gortmakere24f6622013-06-19 19:30:48 -0400943#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
944#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100945
946#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
947#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100948
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930949#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930950#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Thomas Gleixner65538962020-03-09 22:47:17 +0100951 ".kprobes.text", ".cpuidle.text", ".noinstr.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930952#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400953 ".fixup", ".entry.text", ".exception.text", ".text.*", \
954 ".coldtext"
Sam Ravnborg10668222008-01-13 22:21:31 +0100955
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000956#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000957#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100958
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000959#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000960#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100961
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930962#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
963 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
964
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100965/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930966static const char *const init_data_sections[] =
967 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100968
969/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930970static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100971
972/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930973static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100974 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100975
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930976/* all text sections */
977static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
978
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100979/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930980static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100981
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100982
983/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100984#define DEFAULT_SYMBOL_WHITE_LIST \
985 "*driver", \
986 "*_template", /* scsi uses *_template a lot */ \
987 "*_timer", /* arm uses ops structures named _timer a lot */ \
988 "*_sht", /* scsi also used *_sht to some extent */ \
989 "*_ops", \
990 "*_probe", \
991 "*_probe_one", \
992 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100993
Mathias Krause7a3ee752014-08-27 20:28:53 +0930994static const char *const head_sections[] = { ".head.text*", NULL };
995static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100996 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930997static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100998
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100999enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001000 TEXT_TO_ANY_INIT,
1001 DATA_TO_ANY_INIT,
1002 TEXT_TO_ANY_EXIT,
1003 DATA_TO_ANY_EXIT,
1004 XXXINIT_TO_SOME_INIT,
1005 XXXEXIT_TO_SOME_EXIT,
1006 ANY_INIT_TO_ANY_EXIT,
1007 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001008 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301009 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001010};
1011
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301012/**
1013 * Describe how to match sections on different criterias:
1014 *
1015 * @fromsec: Array of sections to be matched.
1016 *
1017 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
1018 * this array is forbidden (black-list). Can be empty.
1019 *
1020 * @good_tosec: Relocations applied to a section in @fromsec must be
1021 * targetting sections in this array (white-list). Can be empty.
1022 *
1023 * @mismatch: Type of mismatch.
1024 *
1025 * @symbol_white_list: Do not match a relocation to a symbol in this list
1026 * even if it is targetting a section in @bad_to_sec.
1027 *
1028 * @handler: Specific handler to call when a match is found. If NULL,
1029 * default_mismatch_handler() will be called.
1030 *
1031 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001032struct sectioncheck {
1033 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301034 const char *bad_tosec[20];
1035 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001036 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001037 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301038 void (*handler)(const char *modname, struct elf_info *elf,
1039 const struct sectioncheck* const mismatch,
1040 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1041
Sam Ravnborg10668222008-01-13 22:21:31 +01001042};
1043
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301044static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1045 const struct sectioncheck* const mismatch,
1046 Elf_Rela *r, Elf_Sym *sym,
1047 const char *fromsec);
1048
Mathias Krause7a3ee752014-08-27 20:28:53 +09301049static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001050/* Do not reference init/exit code/data from
1051 * normal code and data
1052 */
1053{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001054 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301055 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001056 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001057 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001058},
1059{
1060 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301061 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001062 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001063 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001064},
1065{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001066 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301067 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001068 .mismatch = DATA_TO_ANY_INIT,
1069 .symbol_white_list = {
1070 "*_template", "*_timer", "*_sht", "*_ops",
1071 "*_probe", "*_probe_one", "*_console", NULL
1072 },
1073},
1074{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001075 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301076 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001077 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001078 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001079},
1080{
1081 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301082 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001083 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001084 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001085},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001086/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001087{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001088 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301089 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001090 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001091 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001092},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001093/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001094{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001095 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301096 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001097 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001098 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001099},
1100/* Do not use exit code/data from init code */
1101{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001102 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301103 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001104 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001105 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001106},
1107/* Do not use init code/data from exit code */
1108{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001109 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301110 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001111 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001112 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001113},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001114{
1115 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301116 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001117 .mismatch = ANY_INIT_TO_ANY_EXIT,
1118 .symbol_white_list = { NULL },
1119},
Sam Ravnborg10668222008-01-13 22:21:31 +01001120/* Do not export init/exit functions or data */
1121{
1122 .fromsec = { "__ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301123 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001124 .mismatch = EXPORT_TO_INIT_EXIT,
1125 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301126},
1127{
1128 .fromsec = { "__ex_table", NULL },
1129 /* If you're adding any new black-listed sections in here, consider
1130 * adding a special 'printer' for them in scripts/check_extable.
1131 */
1132 .bad_tosec = { ".altinstr_replacement", NULL },
1133 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1134 .mismatch = EXTABLE_TO_NON_TEXT,
1135 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001136}
1137};
1138
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001139static const struct sectioncheck *section_mismatch(
1140 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001141{
1142 int i;
1143 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1144 const struct sectioncheck *check = &sectioncheck[0];
1145
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301146 /*
1147 * The target section could be the SHT_NUL section when we're
1148 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001149 * doesn't make much sense and causes build failures on parisc
1150 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301151 */
1152 if (*tosec == '\0')
1153 return NULL;
1154
Sam Ravnborg10668222008-01-13 22:21:31 +01001155 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301156 if (match(fromsec, check->fromsec)) {
1157 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1158 return check;
1159 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1160 return check;
1161 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001162 check++;
1163 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001164 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001165}
1166
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001167/**
1168 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001169 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001170 * Pattern 1:
1171 * If a module parameter is declared __initdata and permissions=0
1172 * then this is legal despite the warning generated.
1173 * We cannot see value of permissions here, so just ignore
1174 * this pattern.
1175 * The pattern is identified by:
1176 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001177 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001178 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001179 *
Rusty Russell6a841522010-08-11 23:04:16 -06001180 * Pattern 1a:
1181 * module_param_call() ops can refer to __init set function if permissions=0
1182 * The pattern is identified by:
1183 * tosec = .init.text
1184 * fromsec = .data*
1185 * atsym = __param_ops_*
1186 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001187 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001188 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001189 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001190 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001191 * tosec = init or exit section
1192 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001193 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1194 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001195 *
1196 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001197 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001198 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001199 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001200 * Some symbols belong to init section but still it is ok to reference
1201 * these from non-init sections as these symbols don't have any memory
1202 * allocated for them and symbol address and value are same. So even
1203 * if init section is freed, its ok to reference those symbols.
1204 * For ex. symbols marking the init section boundaries.
1205 * This pattern is identified by
1206 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001207 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301208 * Pattern 5:
1209 * GCC may optimize static inlines when fed constant arg(s) resulting
1210 * in functions like cpumask_empty() -- generating an associated symbol
1211 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1212 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1213 * meaningless section warning. May need to add isra symbols too...
1214 * This pattern is identified by
1215 * tosec = init section
1216 * fromsec = text section
1217 * refsymname = *.constprop.*
1218 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001219 * Pattern 6:
1220 * Hide section mismatch warnings for ELF local symbols. The goal
1221 * is to eliminate false positive modpost warnings caused by
1222 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1223 * Autogenerated symbol names bypass modpost's "Pattern 2"
1224 * whitelisting, which relies on pattern-matching against symbol
1225 * names to work. (One situation where gcc can autogenerate ELF
1226 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001227 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001228static int secref_whitelist(const struct sectioncheck *mismatch,
1229 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001230 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001231{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001232 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001233 if (match(tosec, init_data_sections) &&
1234 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001235 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001236 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001237
Rusty Russell6a841522010-08-11 23:04:16 -06001238 /* Check for pattern 1a */
1239 if (strcmp(tosec, ".init.text") == 0 &&
1240 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001241 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001242 return 0;
1243
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001244 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001245 if (match(tosec, init_exit_sections) &&
1246 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001247 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001248 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001249
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001250 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001251 if (match(fromsec, head_sections) &&
1252 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001253 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001254
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001255 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001256 if (match(tosym, linker_symbols))
1257 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001258
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301259 /* Check for pattern 5 */
1260 if (match(fromsec, text_sections) &&
1261 match(tosec, init_sections) &&
1262 match(fromsym, optim_symbols))
1263 return 0;
1264
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001265 /* Check for pattern 6 */
1266 if (strstarts(fromsym, ".L"))
1267 return 0;
1268
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001269 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001270}
1271
Sami Tolvanen5818c682018-10-23 15:15:35 -07001272static inline int is_arm_mapping_symbol(const char *str)
1273{
1274 return str[0] == '$' && strchr("axtd", str[1])
1275 && (str[2] == '\0' || str[2] == '.');
1276}
1277
1278/*
1279 * If there's no name there, ignore it; likewise, ignore it if it's
1280 * one of the magic symbols emitted used by current ARM tools.
1281 *
1282 * Otherwise if find_symbols_between() returns those symbols, they'll
1283 * fail the whitelist tests and cause lots of false alarms ... fixable
1284 * only by merging __exit and __init sections into __text, bloating
1285 * the kernel (which is especially evil on embedded platforms).
1286 */
1287static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1288{
1289 const char *name = elf->strtab + sym->st_name;
1290
1291 if (!name || !strlen(name))
1292 return 0;
1293 return !is_arm_mapping_symbol(name);
1294}
1295
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001296/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001297 * Find symbol based on relocation record info.
1298 * In some cases the symbol supplied is a valid symbol so
1299 * return refsym. If st_name != 0 we assume this is a valid symbol.
1300 * In other cases the symbol needs to be looked up in the symbol table
1301 * based on section and address.
1302 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001303static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001304 Elf_Sym *relsym)
1305{
1306 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001307 Elf_Sym *near = NULL;
1308 Elf64_Sword distance = 20;
1309 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001310 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001311
1312 if (relsym->st_name != 0)
1313 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001314
1315 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001316 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001317 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001318 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001319 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1320 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001321 if (!is_valid_name(elf, sym))
1322 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001323 if (sym->st_value == addr)
1324 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001325 /* Find a symbol nearby - addr are maybe negative */
1326 d = sym->st_value - addr;
1327 if (d < 0)
1328 d = addr - sym->st_value;
1329 if (d < distance) {
1330 distance = d;
1331 near = sym;
1332 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001333 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001334 /* We need a close match */
1335 if (distance < 20)
1336 return near;
1337 else
1338 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001339}
1340
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001341/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001342 * Find symbols before or equal addr and after addr - in the section sec.
1343 * If we find two symbols with equal offset prefer one with a valid name.
1344 * The ELF format may have a better way to detect what type of symbol
1345 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001346 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001347static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1348 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001349{
1350 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001351 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001352 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001353
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001354 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1355 const char *symsec;
1356
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001357 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001358 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001359 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001360 if (strcmp(symsec, sec) != 0)
1361 continue;
David Brownellda68d612007-02-20 13:58:16 -08001362 if (!is_valid_name(elf, sym))
1363 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001364 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001365 if ((addr - sym->st_value) < distance) {
1366 distance = addr - sym->st_value;
1367 near = sym;
1368 } else if ((addr - sym->st_value) == distance) {
1369 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001370 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001371 }
1372 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001373 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001374}
1375
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001376/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001377 * Convert a section name to the function/data attribute
1378 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001379 * .memexitconst => __memconst
1380 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001381 *
1382 * The memory of returned value has been allocated on a heap. The user of this
1383 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001384*/
1385static char *sec2annotation(const char *s)
1386{
1387 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001388 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001389 char *r = p;
1390
1391 *p++ = '_';
1392 *p++ = '_';
1393 if (*s == '.')
1394 s++;
1395 while (*s && *s != '.')
1396 *p++ = *s++;
1397 *p = '\0';
1398 if (*s == '.')
1399 s++;
1400 if (strstr(s, "rodata") != NULL)
1401 strcat(p, "const ");
1402 else if (strstr(s, "data") != NULL)
1403 strcat(p, "data ");
1404 else
1405 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001406 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001407 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001408 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001409 }
1410}
1411
1412static int is_function(Elf_Sym *sym)
1413{
1414 if (sym)
1415 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1416 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001417 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001418}
1419
Randy Dunlap00759c02011-03-15 14:13:47 -07001420static void print_section_list(const char * const list[20])
1421{
1422 const char *const *s = list;
1423
1424 while (*s) {
1425 fprintf(stderr, "%s", *s);
1426 s++;
1427 if (*s)
1428 fprintf(stderr, ", ");
1429 }
1430 fprintf(stderr, "\n");
1431}
1432
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301433static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1434{
1435 switch (is_func) {
1436 case 0: *name = "variable"; *name_p = ""; break;
1437 case 1: *name = "function"; *name_p = "()"; break;
1438 default: *name = "(unknown reference)"; *name_p = ""; break;
1439 }
1440}
1441
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001442/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001443 * Print a warning about a section mismatch.
1444 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001445 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001446 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001447static void report_sec_mismatch(const char *modname,
1448 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001449 const char *fromsec,
1450 unsigned long long fromaddr,
1451 const char *fromsym,
1452 int from_is_func,
1453 const char *tosec, const char *tosym,
1454 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001455{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001456 const char *from, *from_p;
1457 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001458 char *prl_from;
1459 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001460
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001461 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001462
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301463 get_pretty_name(from_is_func, &from, &from_p);
1464 get_pretty_name(to_is_func, &to, &to_p);
1465
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001466 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1467 "to the %s %s:%s%s\n",
1468 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1469 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001470
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001471 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001472 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001473 prl_from = sec2annotation(fromsec);
1474 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001475 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001476 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001477 "the %s %s%s%s.\n"
1478 "This is often because %s lacks a %s\n"
1479 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001480 prl_from, fromsym,
1481 to, prl_to, tosym, to_p,
1482 fromsym, prl_to, tosym);
1483 free(prl_from);
1484 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001485 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001486 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001487 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001488 fprintf(stderr,
1489 "The variable %s references\n"
1490 "the %s %s%s%s\n"
1491 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001492 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001493 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001494 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001495 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001496 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001497 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001498 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001499 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001500 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001501 fprintf(stderr,
1502 "The function %s() references a %s in an exit section.\n"
1503 "Often the %s %s%s has valid usage outside the exit section\n"
1504 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001505 fromsym, to, to, tosym, to_p, prl_to, tosym);
1506 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001507 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001508 case DATA_TO_ANY_EXIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001509 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001510 fprintf(stderr,
1511 "The variable %s references\n"
1512 "the %s %s%s%s\n"
1513 "If the reference is valid then annotate the\n"
1514 "variable with __exit* (see linux/init.h) or "
1515 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001516 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001517 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001518 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001519 break;
1520 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001521 case XXXINIT_TO_SOME_INIT:
1522 case XXXEXIT_TO_SOME_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001523 prl_from = sec2annotation(fromsec);
1524 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001525 fprintf(stderr,
1526 "The %s %s%s%s references\n"
1527 "a %s %s%s%s.\n"
1528 "If %s is only used by %s then\n"
1529 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001530 from, prl_from, fromsym, from_p,
1531 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001532 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001533 free(prl_from);
1534 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001535 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001536 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001537 prl_from = sec2annotation(fromsec);
1538 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001539 fprintf(stderr,
1540 "The %s %s%s%s references\n"
1541 "a %s %s%s%s.\n"
1542 "This is often seen when error handling "
1543 "in the init function\n"
1544 "uses functionality in the exit path.\n"
1545 "The fix is often to remove the %sannotation of\n"
1546 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001547 from, prl_from, fromsym, from_p,
1548 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001549 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001550 free(prl_from);
1551 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001552 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001553 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001554 prl_from = sec2annotation(fromsec);
1555 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001556 fprintf(stderr,
1557 "The %s %s%s%s references\n"
1558 "a %s %s%s%s.\n"
1559 "This is often seen when error handling "
1560 "in the exit function\n"
1561 "uses functionality in the init path.\n"
1562 "The fix is often to remove the %sannotation of\n"
1563 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001564 from, prl_from, fromsym, from_p,
1565 to, prl_to, tosym, to_p,
1566 prl_to, tosym, to_p);
1567 free(prl_from);
1568 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001569 break;
1570 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001571 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001572 fprintf(stderr,
1573 "The symbol %s is exported and annotated %s\n"
1574 "Fix this by removing the %sannotation of %s "
1575 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001576 tosym, prl_to, prl_to, tosym);
1577 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001578 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301579 case EXTABLE_TO_NON_TEXT:
1580 fatal("There's a special handler for this mismatch type, "
1581 "we should never get here.");
1582 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001583 }
1584 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001585}
1586
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301587static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1588 const struct sectioncheck* const mismatch,
1589 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1590{
1591 const char *tosec;
1592 Elf_Sym *to;
1593 Elf_Sym *from;
1594 const char *tosym;
1595 const char *fromsym;
1596
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301597 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1598 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301599
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001600 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301601 return;
1602
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301603 tosec = sec_name(elf, get_secindex(elf, sym));
1604 to = find_elf_symbol(elf, r->r_addend, sym);
1605 tosym = sym_name(elf, to);
1606
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301607 /* check whitelist - we may ignore it */
1608 if (secref_whitelist(mismatch,
1609 fromsec, fromsym, tosec, tosym)) {
1610 report_sec_mismatch(modname, mismatch,
1611 fromsec, r->r_offset, fromsym,
1612 is_function(from), tosec, tosym,
1613 is_function(to));
1614 }
1615}
1616
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301617static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1618{
1619 if (section_index > elf->num_sections)
1620 fatal("section_index is outside elf->num_sections!\n");
1621
1622 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1623}
1624
1625/*
1626 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1627 * to know the sizeof(struct exception_table_entry) for the target architecture.
1628 */
1629static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301630static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301631{
1632 /*
1633 * If we're currently checking the second relocation within __ex_table,
1634 * that relocation offset tells us the offsetof(struct
1635 * exception_table_entry, fixup) which is equal to sizeof(struct
1636 * exception_table_entry) divided by two. We use that to our advantage
1637 * since there's no portable way to get that size as every architecture
1638 * seems to go with different sized types. Not pretty but better than
1639 * hard-coding the size for every architecture..
1640 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301641 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301642 extable_entry_size = r->r_offset * 2;
1643}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301644
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301645static inline bool is_extable_fault_address(Elf_Rela *r)
1646{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301647 /*
1648 * extable_entry_size is only discovered after we've handled the
1649 * _second_ relocation in __ex_table, so only abort when we're not
1650 * handling the first reloc and extable_entry_size is zero.
1651 */
1652 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301653 fatal("extable_entry size hasn't been discovered!\n");
1654
1655 return ((r->r_offset == 0) ||
1656 (r->r_offset % extable_entry_size == 0));
1657}
1658
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301659#define is_second_extable_reloc(Start, Cur, Sec) \
1660 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1661
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301662static void report_extable_warnings(const char* modname, struct elf_info* elf,
1663 const struct sectioncheck* const mismatch,
1664 Elf_Rela* r, Elf_Sym* sym,
1665 const char* fromsec, const char* tosec)
1666{
1667 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1668 const char* fromsym_name = sym_name(elf, fromsym);
1669 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1670 const char* tosym_name = sym_name(elf, tosym);
1671 const char* from_pretty_name;
1672 const char* from_pretty_name_p;
1673 const char* to_pretty_name;
1674 const char* to_pretty_name_p;
1675
1676 get_pretty_name(is_function(fromsym),
1677 &from_pretty_name, &from_pretty_name_p);
1678 get_pretty_name(is_function(tosym),
1679 &to_pretty_name, &to_pretty_name_p);
1680
1681 warn("%s(%s+0x%lx): Section mismatch in reference"
1682 " from the %s %s%s to the %s %s:%s%s\n",
1683 modname, fromsec, (long)r->r_offset, from_pretty_name,
1684 fromsym_name, from_pretty_name_p,
1685 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1686
1687 if (!match(tosec, mismatch->bad_tosec) &&
1688 is_executable_section(elf, get_secindex(elf, sym)))
1689 fprintf(stderr,
1690 "The relocation at %s+0x%lx references\n"
1691 "section \"%s\" which is not in the list of\n"
1692 "authorized sections. If you're adding a new section\n"
1693 "and/or if this reference is valid, add \"%s\" to the\n"
1694 "list of authorized sections to jump to on fault.\n"
1695 "This can be achieved by adding \"%s\" to \n"
1696 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1697 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1698}
1699
1700static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1701 const struct sectioncheck* const mismatch,
1702 Elf_Rela* r, Elf_Sym* sym,
1703 const char *fromsec)
1704{
1705 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1706
1707 sec_mismatch_count++;
1708
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001709 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301710
1711 if (match(tosec, mismatch->bad_tosec))
1712 fatal("The relocation at %s+0x%lx references\n"
1713 "section \"%s\" which is black-listed.\n"
1714 "Something is seriously wrong and should be fixed.\n"
1715 "You might get more information about where this is\n"
1716 "coming from by using scripts/check_extable.sh %s\n",
1717 fromsec, (long)r->r_offset, tosec, modname);
1718 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1719 if (is_extable_fault_address(r))
1720 fatal("The relocation at %s+0x%lx references\n"
1721 "section \"%s\" which is not executable, IOW\n"
1722 "it is not possible for the kernel to fault\n"
1723 "at that address. Something is seriously wrong\n"
1724 "and should be fixed.\n",
1725 fromsec, (long)r->r_offset, tosec);
1726 else
1727 fatal("The relocation at %s+0x%lx references\n"
1728 "section \"%s\" which is not executable, IOW\n"
1729 "the kernel will fault if it ever tries to\n"
1730 "jump to it. Something is seriously wrong\n"
1731 "and should be fixed.\n",
1732 fromsec, (long)r->r_offset, tosec);
1733 }
1734}
1735
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001736static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001737 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001738{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001739 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301740 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001741
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001742 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301743 if (mismatch->handler)
1744 mismatch->handler(modname, elf, mismatch,
1745 r, sym, fromsec);
1746 else
1747 default_mismatch_handler(modname, elf, mismatch,
1748 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001749 }
1750}
1751
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001752static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001753 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001754{
Masahiro Yamadad2e4d052020-05-25 14:47:04 +09001755 return sym_get_data_by_offset(elf, sechdr->sh_info, r->r_offset);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001756}
1757
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001758static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001759{
1760 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001761 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001762
1763 switch (r_typ) {
1764 case R_386_32:
1765 r->r_addend = TO_NATIVE(*location);
1766 break;
1767 case R_386_PC32:
1768 r->r_addend = TO_NATIVE(*location) + 4;
1769 /* For CONFIG_RELOCATABLE=y */
1770 if (elf->hdr->e_type == ET_EXEC)
1771 r->r_addend += r->r_offset;
1772 break;
1773 }
1774 return 0;
1775}
1776
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001777#ifndef R_ARM_CALL
1778#define R_ARM_CALL 28
1779#endif
1780#ifndef R_ARM_JUMP24
1781#define R_ARM_JUMP24 29
1782#endif
1783
David A. Longc9698e52014-02-14 22:41:18 +01001784#ifndef R_ARM_THM_CALL
1785#define R_ARM_THM_CALL 10
1786#endif
1787#ifndef R_ARM_THM_JUMP24
1788#define R_ARM_THM_JUMP24 30
1789#endif
1790#ifndef R_ARM_THM_JUMP19
1791#define R_ARM_THM_JUMP19 51
1792#endif
1793
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001794static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001795{
1796 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1797
1798 switch (r_typ) {
1799 case R_ARM_ABS32:
1800 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001801 r->r_addend = (int)(long)
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001802 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001803 break;
1804 case R_ARM_PC24:
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001805 case R_ARM_CALL:
1806 case R_ARM_JUMP24:
David A. Longc9698e52014-02-14 22:41:18 +01001807 case R_ARM_THM_CALL:
1808 case R_ARM_THM_JUMP24:
1809 case R_ARM_THM_JUMP19:
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001810 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001811 r->r_addend = (int)(long)(elf->hdr +
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001812 sechdr->sh_offset +
1813 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001814 break;
1815 default:
1816 return 1;
1817 }
1818 return 0;
1819}
1820
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001821static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001822{
1823 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001824 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001825 unsigned int inst;
1826
1827 if (r_typ == R_MIPS_HI16)
1828 return 1; /* skip this */
1829 inst = TO_NATIVE(*location);
1830 switch (r_typ) {
1831 case R_MIPS_LO16:
1832 r->r_addend = inst & 0xffff;
1833 break;
1834 case R_MIPS_26:
1835 r->r_addend = (inst & 0x03ffffff) << 2;
1836 break;
1837 case R_MIPS_32:
1838 r->r_addend = inst;
1839 break;
1840 }
1841 return 0;
1842}
1843
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001844static void section_rela(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001845 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001846{
1847 Elf_Sym *sym;
1848 Elf_Rela *rela;
1849 Elf_Rela r;
1850 unsigned int r_sym;
1851 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001852
Sam Ravnborgff13f922008-01-23 19:54:27 +01001853 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001854 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1855
Sam Ravnborgff13f922008-01-23 19:54:27 +01001856 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001857 fromsec += strlen(".rela");
1858 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001859 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001860 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001861
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001862 for (rela = start; rela < stop; rela++) {
1863 r.r_offset = TO_NATIVE(rela->r_offset);
1864#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001865 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001866 unsigned int r_typ;
1867 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1868 r_sym = TO_NATIVE(r_sym);
1869 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1870 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1871 } else {
1872 r.r_info = TO_NATIVE(rela->r_info);
1873 r_sym = ELF_R_SYM(r.r_info);
1874 }
1875#else
1876 r.r_info = TO_NATIVE(rela->r_info);
1877 r_sym = ELF_R_SYM(r.r_info);
1878#endif
1879 r.r_addend = TO_NATIVE(rela->r_addend);
1880 sym = elf->symtab_start + r_sym;
1881 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001882 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001883 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301884 if (is_second_extable_reloc(start, rela, fromsec))
1885 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001886 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001887 }
1888}
1889
1890static void section_rel(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001891 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001892{
1893 Elf_Sym *sym;
1894 Elf_Rel *rel;
1895 Elf_Rela r;
1896 unsigned int r_sym;
1897 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001898
Sam Ravnborgff13f922008-01-23 19:54:27 +01001899 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001900 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1901
Sam Ravnborgff13f922008-01-23 19:54:27 +01001902 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001903 fromsec += strlen(".rel");
1904 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001905 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001906 return;
1907
1908 for (rel = start; rel < stop; rel++) {
1909 r.r_offset = TO_NATIVE(rel->r_offset);
1910#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001911 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001912 unsigned int r_typ;
1913 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1914 r_sym = TO_NATIVE(r_sym);
1915 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1916 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1917 } else {
1918 r.r_info = TO_NATIVE(rel->r_info);
1919 r_sym = ELF_R_SYM(r.r_info);
1920 }
1921#else
1922 r.r_info = TO_NATIVE(rel->r_info);
1923 r_sym = ELF_R_SYM(r.r_info);
1924#endif
1925 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001926 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001927 case EM_386:
1928 if (addend_386_rel(elf, sechdr, &r))
1929 continue;
1930 break;
1931 case EM_ARM:
1932 if (addend_arm_rel(elf, sechdr, &r))
1933 continue;
1934 break;
1935 case EM_MIPS:
1936 if (addend_mips_rel(elf, sechdr, &r))
1937 continue;
1938 break;
1939 }
1940 sym = elf->symtab_start + r_sym;
1941 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001942 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001943 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301944 if (is_second_extable_reloc(start, rel, fromsec))
1945 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001946 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001947 }
1948}
1949
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001950/**
1951 * A module includes a number of sections that are discarded
1952 * either when loaded or when used as built-in.
1953 * For loaded modules all functions marked __init and all data
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001954 * marked __initdata will be discarded when the module has been initialized.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001955 * Likewise for modules used built-in the sections marked __exit
1956 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001957 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001958 * The check_sec_ref() function traverses all relocation records
1959 * to find all references to a section that reference a section that will
1960 * be discarded and warns about it.
1961 **/
1962static void check_sec_ref(struct module *mod, const char *modname,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001963 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001964{
1965 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001966 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001967
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001968 /* Walk through all sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001969 for (i = 0; i < elf->num_sections; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001970 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001971 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001972 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001973 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001974 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001975 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001976 }
1977}
1978
Andi Kleen7d02b492014-02-08 09:01:12 +01001979static char *remove_dot(char *s)
1980{
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301981 size_t n = strcspn(s, ".");
Andi Kleen7d02b492014-02-08 09:01:12 +01001982
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301983 if (n && s[n]) {
1984 size_t m = strspn(s + n + 1, "0123456789");
1985 if (m && (s[n + m] == '.' || s[n + m] == 0))
Andi Kleen7d02b492014-02-08 09:01:12 +01001986 s[n] = 0;
1987 }
1988 return s;
1989}
1990
Masahiro Yamada8b185742018-05-09 18:50:40 +09001991static void read_symbols(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992{
1993 const char *symname;
1994 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001995 char *license;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01001996 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 struct module *mod;
1998 struct elf_info info = { };
1999 Elf_Sym *sym;
2000
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01002001 if (!parse_elf(&info, modname))
2002 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002004 {
2005 char *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002007 /* strip trailing .o */
2008 tmp = NOFAIL(strdup(modname));
2009 tmp[strlen(tmp) - 2] = '\0';
2010 mod = new_module(tmp);
2011 free(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 }
2013
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002014 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002015 license = get_modinfo(&info, "license");
2016 if (!license)
2017 warn("missing MODULE_LICENSE() in %s\n", modname);
2018 while (license) {
2019 if (license_is_gpl_compatible(license))
2020 mod->gpl_compatible = 1;
2021 else {
2022 mod->gpl_compatible = 0;
2023 break;
2024 }
2025 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002026 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002027
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002028 namespace = get_modinfo(&info, "import_ns");
2029 while (namespace) {
2030 add_namespace(&mod->imported_namespaces, namespace);
2031 namespace = get_next_modinfo(&info, "import_ns",
2032 namespace);
2033 }
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002034 }
2035
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002037 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002039 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 handle_moddevtable(mod, &info, sym, symname);
2041 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002042
Matthias Maennich69923202019-10-18 10:31:42 +01002043 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2044 symname = remove_dot(info.strtab + sym->st_name);
2045
Masahiro Yamada17436942019-11-15 02:42:24 +09002046 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002047 if (strstarts(symname, "__kstrtabns_"))
2048 sym_update_namespace(symname + strlen("__kstrtabns_"),
2049 namespace_from_kstrtabns(&info,
2050 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002051
2052 if (strstarts(symname, "__crc_"))
2053 handle_modversion(mod, &info, sym,
2054 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002055 }
2056
Denis Efremov15bfc232019-08-01 09:06:57 +03002057 // check for static EXPORT_SYMBOL_* functions && global vars
2058 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2059 unsigned char bind = ELF_ST_BIND(sym->st_info);
2060
2061 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2062 struct symbol *s =
2063 find_symbol(remove_dot(info.strtab +
2064 sym->st_name));
2065
2066 if (s)
2067 s->is_static = 0;
2068 }
2069 }
2070
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002071 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002073 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002074 version = get_modinfo(&info, "version");
2075 if (version || all_versions)
2076 get_src_version(modname, mod->srcversion,
2077 sizeof(mod->srcversion) - 1);
2078 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
2080 parse_elf_finish(&info);
2081
Rusty Russell8c8ef422009-03-31 13:05:34 -06002082 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 * never passed as an argument to an exported function, so
2084 * the automatic versioning doesn't pick it up, but it's really
2085 * important anyhow */
2086 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06002087 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088}
2089
Rusty Russell712f9b42013-04-04 17:37:38 +10302090static void read_symbols_from_files(const char *filename)
2091{
2092 FILE *in = stdin;
2093 char fname[PATH_MAX];
2094
2095 if (strcmp(filename, "-") != 0) {
2096 in = fopen(filename, "r");
2097 if (!in)
2098 fatal("Can't open filenames file %s: %m", filename);
2099 }
2100
2101 while (fgets(fname, PATH_MAX, in) != NULL) {
2102 if (strends(fname, "\n"))
2103 fname[strlen(fname)-1] = '\0';
2104 read_symbols(fname);
2105 }
2106
2107 if (in != stdin)
2108 fclose(in);
2109}
2110
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111#define SZ 500
2112
2113/* We first write the generated file into memory using the
2114 * following helper, then compare to the file on disk and
2115 * only update the later if anything changed */
2116
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002117void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
2118 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119{
2120 char tmp[SZ];
2121 int len;
2122 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002123
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 va_start(ap, fmt);
2125 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002126 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 va_end(ap);
2128}
2129
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002130void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131{
2132 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002133 buf->size += len + SZ;
Randy Dunlap1f3aa902018-08-15 12:30:38 -07002134 buf->p = NOFAIL(realloc(buf->p, buf->size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 }
2136 strncpy(buf->p + buf->pos, s, len);
2137 buf->pos += len;
2138}
2139
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002140static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
2141{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002142 switch (exp) {
2143 case export_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002144 fatal("GPL-incompatible module %s.ko uses GPL-only symbol '%s'\n",
2145 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002146 break;
2147 case export_unused_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002148 fatal("GPL-incompatible module %s.ko uses GPL-only symbol marked UNUSED '%s'\n",
2149 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002150 break;
2151 case export_gpl_future:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002152 warn("GPL-incompatible module %s.ko uses future GPL-only symbol '%s'\n",
2153 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002154 break;
2155 case export_plain:
2156 case export_unused:
2157 case export_unknown:
2158 /* ignore */
2159 break;
2160 }
2161}
2162
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002163static void check_for_unused(enum export exp, const char *m, const char *s)
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002164{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002165 switch (exp) {
2166 case export_unused:
2167 case export_unused_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002168 warn("module %s.ko uses symbol '%s' marked UNUSED\n",
2169 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002170 break;
2171 default:
2172 /* ignore */
2173 break;
2174 }
2175}
2176
Masahiro Yamada3b415282018-11-23 16:57:23 +09002177static int check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002178{
2179 struct symbol *s, *exp;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002180 int err = 0;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002181
2182 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002183 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002184 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002185 if (!exp || exp->module == mod) {
2186 if (have_vmlinux && !s->weak) {
Jessica Yu93c95e52020-03-06 17:02:05 +01002187 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2188 "\"%s\" [%s.ko] undefined!\n",
2189 s->name, mod->name);
2190 if (!warn_unresolved)
Masahiro Yamada3b415282018-11-23 16:57:23 +09002191 err = 1;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002192 }
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);
2206 if (!allow_missing_ns_imports)
2207 err = 1;
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002208 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002209 }
2210
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002211 if (!mod->gpl_compatible)
2212 check_for_gpl_usage(exp->export, basename, exp->name);
2213 check_for_unused(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002214 }
Masahiro Yamada3b415282018-11-23 16:57:23 +09002215
2216 return err;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002217}
2218
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002219static int check_modname_len(struct module *mod)
2220{
2221 const char *mod_name;
2222
2223 mod_name = strrchr(mod->name, '/');
2224 if (mod_name == NULL)
2225 mod_name = mod->name;
2226 else
2227 mod_name++;
2228 if (strlen(mod_name) >= MODULE_NAME_LEN) {
2229 merror("module name is too long [%s.ko]\n", mod->name);
2230 return 1;
2231 }
2232
2233 return 0;
2234}
2235
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002236/**
2237 * Header for the generated file
2238 **/
2239static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240{
2241 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002242 /*
2243 * Include build-salt.h after module.h in order to
2244 * inherit the definitions.
2245 */
Leon Romanovsky51161bf2020-04-19 18:55:06 +03002246 buf_printf(b, "#define INCLUDE_VERMAGIC\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002247 buf_printf(b, "#include <linux/build-salt.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 buf_printf(b, "#include <linux/vermagic.h>\n");
2249 buf_printf(b, "#include <linux/compiler.h>\n");
2250 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002251 buf_printf(b, "BUILD_SALT;\n");
2252 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002254 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302256 buf_printf(b, "__visible struct module __this_module\n");
Joe Perches33def842020-10-21 19:36:07 -07002257 buf_printf(b, "__section(\".gnu.linkonce.this_module\") = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002258 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002260 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 if (mod->has_cleanup)
2262 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002263 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002265 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 buf_printf(b, "};\n");
2267}
2268
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002269static void add_intree_flag(struct buffer *b, int is_intree)
2270{
2271 if (is_intree)
2272 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2273}
2274
Andi Kleencaf75012018-01-25 15:50:28 -08002275/* Cannot check for assembler */
2276static void add_retpoline(struct buffer *b)
2277{
WANG Chaoe4f35892018-12-11 00:37:25 +08002278 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002279 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2280 buf_printf(b, "#endif\n");
2281}
2282
Trevor Keith5c725132009-09-22 16:43:38 -07002283static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002284{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002285 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002286 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2287}
2288
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002289/**
2290 * Record CRCs for unresolved symbols
2291 **/
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002292static int add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293{
2294 struct symbol *s, *exp;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002295 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296
2297 for (s = mod->unres; s; s = s->next) {
2298 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002299 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 s->module = exp->module;
2302 s->crc_valid = exp->crc_valid;
2303 s->crc = exp->crc;
2304 }
2305
2306 if (!modversions)
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002307 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308
2309 buf_printf(b, "\n");
2310 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Joe Perches33def842020-10-21 19:36:07 -07002311 buf_printf(b, "__used __section(\"__versions\") = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312
2313 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002314 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002317 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 s->name, mod->name);
2319 continue;
2320 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302321 if (strlen(s->name) >= MODULE_NAME_LEN) {
2322 merror("too long symbol \"%s\" [%s.ko]\n",
2323 s->name, mod->name);
2324 err = 1;
2325 break;
2326 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002327 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302328 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 }
2330
2331 buf_printf(b, "};\n");
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002332
2333 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334}
2335
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002336static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337{
2338 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 int first = 1;
2340
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002341 /* Clear ->seen flag of modules that own symbols needed by this. */
2342 for (s = mod->unres; s; s = s->next)
2343 if (s->module)
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002344 s->module->seen = s->module->is_vmlinux;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345
2346 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002347 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002349 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 if (!s->module)
2351 continue;
2352
2353 if (s->module->seen)
2354 continue;
2355
2356 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002357 p = strrchr(s->module->name, '/');
2358 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002359 p++;
2360 else
2361 p = s->module->name;
2362 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 first = 0;
2364 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002365 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366}
2367
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002368static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369{
2370 if (mod->srcversion[0]) {
2371 buf_printf(b, "\n");
2372 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2373 mod->srcversion);
2374 }
2375}
2376
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002377static void write_buf(struct buffer *b, const char *fname)
2378{
2379 FILE *file;
2380
2381 file = fopen(fname, "w");
2382 if (!file) {
2383 perror(fname);
2384 exit(1);
2385 }
2386 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2387 perror(fname);
2388 exit(1);
2389 }
2390 if (fclose(file) != 0) {
2391 perror(fname);
2392 exit(1);
2393 }
2394}
2395
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002396static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397{
2398 char *tmp;
2399 FILE *file;
2400 struct stat st;
2401
2402 file = fopen(fname, "r");
2403 if (!file)
2404 goto write;
2405
2406 if (fstat(fileno(file), &st) < 0)
2407 goto close_write;
2408
2409 if (st.st_size != b->pos)
2410 goto close_write;
2411
2412 tmp = NOFAIL(malloc(b->pos));
2413 if (fread(tmp, 1, b->pos, file) != b->pos)
2414 goto free_write;
2415
2416 if (memcmp(tmp, b->p, b->pos) != 0)
2417 goto free_write;
2418
2419 free(tmp);
2420 fclose(file);
2421 return;
2422
2423 free_write:
2424 free(tmp);
2425 close_write:
2426 fclose(file);
2427 write:
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002428 write_buf(b, fname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429}
2430
Ram Paibd5cbce2006-06-08 22:12:53 -07002431/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002432 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002433 **/
Masahiro Yamada52c34162020-06-01 14:57:05 +09002434static void read_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435{
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002436 char *buf, *pos, *line;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002438 buf = read_text_file(fname);
2439 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 /* No symbol versions, silently ignore */
2441 return;
2442
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002443 pos = buf;
2444
2445 while ((line = get_line(&pos))) {
Jessica Yu51900442020-03-11 18:01:20 +01002446 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 unsigned int crc;
2448 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002449 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450
2451 if (!(symname = strchr(line, '\t')))
2452 goto fail;
2453 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002454 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 goto fail;
2456 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002457 if (!(export = strchr(modname, '\t')))
2458 goto fail;
2459 *export++ = '\0';
2460 if (!(namespace = strchr(export, '\t')))
2461 goto fail;
2462 *namespace++ = '\0';
2463
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 crc = strtoul(line, &d, 16);
2465 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2466 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002467 mod = find_module(modname);
2468 if (!mod) {
Jan Beulich0fa3a882009-03-12 12:28:30 +00002469 mod = new_module(modname);
Masahiro Yamada52c34162020-06-01 14:57:05 +09002470 mod->from_dump = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002472 s = sym_add_exported(symname, mod, export_no(export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002473 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002474 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002475 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 }
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002477 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 return;
2479fail:
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002480 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481 fatal("parse error in symbol dump file\n");
2482}
2483
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002484static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485{
2486 struct buffer buf = { };
2487 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002488 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 int n;
2490
2491 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2492 symbol = symbolhash[n];
2493 while (symbol) {
Masahiro Yamadad0736af2021-03-26 03:54:09 +09002494 if (!symbol->module->from_dump) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002495 namespace = symbol->namespace;
2496 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2497 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002498 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002499 export_str(symbol->export),
2500 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002501 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502 symbol = symbol->next;
2503 }
2504 }
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002505 write_buf(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002506 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507}
2508
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002509static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002510{
2511 struct module *mod;
2512 struct namespace_list *ns;
2513 struct buffer ns_deps_buf = {};
2514
2515 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002516
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002517 if (mod->from_dump || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002518 continue;
2519
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002520 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002521
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002522 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2523 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002524
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002525 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002526 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002527
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002528 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002529 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002530}
2531
Masahiro Yamada79247992020-06-01 14:57:07 +09002532struct dump_list {
2533 struct dump_list *next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002534 const char *file;
2535};
2536
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002537int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538{
2539 struct module *mod;
2540 struct buffer buf = { };
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002541 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302542 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543 int opt;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002544 int err;
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':
2579 sec_mismatch_fatal = 1;
2580 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
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002614 err = 0;
2615
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002616 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302617 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002618
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002619 if (mod->is_vmlinux || mod->from_dump)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002620 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621
2622 buf.pos = 0;
2623
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002624 err |= check_modname_len(mod);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002625 err |= check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002626
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002628 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002629 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002630 add_staging_flag(&buf, mod->name);
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002631 err |= add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002632 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 add_moddevtable(&buf, mod);
2634 add_srcversion(&buf, mod);
2635
2636 sprintf(fname, "%s.mod.c", mod->name);
2637 write_if_changed(&buf, fname);
2638 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002639
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002640 if (missing_namespace_deps)
2641 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002642
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 if (dump_write)
2644 write_dump(dump_write);
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002645 if (sec_mismatch_count && sec_mismatch_fatal)
Jessica Yu93c95e52020-03-06 17:02:05 +01002646 fatal("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002647 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002648 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002649 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002650
Masahiro Yamada47346e92019-09-24 21:07:40 +09002651 for (s = symbolhash[n]; s; s = s->next) {
Denis Efremov15bfc232019-08-01 09:06:57 +03002652 if (s->is_static)
2653 warn("\"%s\" [%s] is a static %s\n",
2654 s->name, s->module->name,
2655 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002656 }
2657 }
2658
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002659 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002661 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662}