blob: c7501dcc6609eccabd31c20f48766360079aba1a [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) {
Quentin Perret479488f2020-11-24 14:40:13 +0000429 fatal("%s: '%s' exported twice. Previous export was in %s%s\n",
430 mod->name, name, s->module->name,
431 s->module->is_vmlinux ? "" : ".ko");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900433
434 s->module = mod;
Ram Paibd5cbce2006-06-08 22:12:53 -0700435 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100436 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437}
438
Masahiro Yamada17436942019-11-15 02:42:24 +0900439static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100440{
441 struct symbol *s = find_symbol(name);
442
Masahiro Yamada17436942019-11-15 02:42:24 +0900443 /*
444 * Ignore stand-alone __crc_*, which might be auto-generated symbols
445 * such as __*_veneer in ARM ELF.
446 */
447 if (!s)
448 return;
449
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100450 s->crc = crc;
451 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452}
453
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900454static void *grab_file(const char *filename, size_t *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
456 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930457 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 int fd;
459
460 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930461 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930463 if (fstat(fd, &st))
464 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466 *size = st.st_size;
467 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930469failed:
470 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 if (map == MAP_FAILED)
472 return NULL;
473 return map;
474}
475
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900476static void release_file(void *file, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477{
478 munmap(file, size);
479}
480
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100481static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482{
483 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100484 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 Elf_Shdr *sechdrs;
486 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200487 const char *secstrings;
488 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490 hdr = grab_file(filename, &info->size);
491 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930492 if (ignore_missing_files) {
493 fprintf(stderr, "%s: %s (ignored)\n", filename,
494 strerror(errno));
495 return 0;
496 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200498 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 }
500 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100501 if (info->size < sizeof(*hdr)) {
502 /* file too small, assume this is an empty .o file */
503 return 0;
504 }
505 /* Is this a valid ELF file? */
506 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
507 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
508 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
509 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
510 /* Not an ELF file - silently ignore it */
511 return 0;
512 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200514 hdr->e_type = TO_NATIVE(hdr->e_type);
515 hdr->e_machine = TO_NATIVE(hdr->e_machine);
516 hdr->e_version = TO_NATIVE(hdr->e_version);
517 hdr->e_entry = TO_NATIVE(hdr->e_entry);
518 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
519 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
520 hdr->e_flags = TO_NATIVE(hdr->e_flags);
521 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
522 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
523 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
524 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
525 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
526 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 sechdrs = (void *)hdr + hdr->e_shoff;
528 info->sechdrs = sechdrs;
529
Petr Stetiara83710e2007-08-27 12:15:07 +0200530 /* Check if file offset is correct */
531 if (hdr->e_shoff > info->size) {
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900532 fatal("section header offset=%lu in file '%s' is bigger than filesize=%zu\n",
533 (unsigned long)hdr->e_shoff, filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200534 return 0;
535 }
536
Anders Kaseorg68457562011-05-19 16:55:27 -0600537 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200538 /*
539 * There are more than 64k sections,
540 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200541 */
542 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
543 }
544 else {
545 info->num_sections = hdr->e_shnum;
546 }
547 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600548 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200549 }
550 else {
551 info->secindex_strings = hdr->e_shstrndx;
552 }
553
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200555 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200556 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
557 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
558 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
559 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
560 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
561 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
562 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
563 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
564 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
565 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 }
567 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200568 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
569 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700570 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900571 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Tejun Heo56fc82c2009-02-06 00:48:02 +0900573 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100574 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
575 "sizeof(*hrd)=%zu\n", filename,
576 (unsigned long)sechdrs[i].sh_offset,
577 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100578 return 0;
579 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700580 secname = secstrings + sechdrs[i].sh_name;
581 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900582 if (nobits)
583 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
585 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700586 } else if (strcmp(secname, "__ksymtab") == 0)
587 info->export_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200588 else if (strcmp(secname, "__ksymtab_unused") == 0)
589 info->export_unused_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700590 else if (strcmp(secname, "__ksymtab_gpl") == 0)
591 info->export_gpl_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200592 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
593 info->export_unused_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700594 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
595 info->export_gpl_future_sec = i;
596
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200597 if (sechdrs[i].sh_type == SHT_SYMTAB) {
598 unsigned int sh_link_idx;
599 symtab_idx = i;
600 info->symtab_start = (void *)hdr +
601 sechdrs[i].sh_offset;
602 info->symtab_stop = (void *)hdr +
603 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600604 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200605 info->strtab = (void *)hdr +
606 sechdrs[sh_link_idx].sh_offset;
607 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200609 /* 32bit section no. table? ("more than 64k sections") */
610 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
611 symtab_shndx_idx = i;
612 info->symtab_shndx_start = (void *)hdr +
613 sechdrs[i].sh_offset;
614 info->symtab_shndx_stop = (void *)hdr +
615 sechdrs[i].sh_offset + sechdrs[i].sh_size;
616 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100618 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100619 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 /* Fix endianness in symbols */
622 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
623 sym->st_shndx = TO_NATIVE(sym->st_shndx);
624 sym->st_name = TO_NATIVE(sym->st_name);
625 sym->st_value = TO_NATIVE(sym->st_value);
626 sym->st_size = TO_NATIVE(sym->st_size);
627 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200628
629 if (symtab_shndx_idx != ~0U) {
630 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600631 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200632 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600633 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200634 symtab_idx);
635 /* Fix endianness */
636 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
637 p++)
638 *p = TO_NATIVE(*p);
639 }
640
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100641 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642}
643
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100644static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645{
646 release_file(info->hdr, info->size);
647}
648
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200649static int ignore_undef_symbol(struct elf_info *info, const char *symname)
650{
651 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900652 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200653 return 1;
654 /* ignore global offset table */
655 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
656 return 1;
657 if (info->hdr->e_machine == EM_PPC)
658 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900659 if (strstarts(symname, "_restgpr_") ||
660 strstarts(symname, "_savegpr_") ||
661 strstarts(symname, "_rest32gpr_") ||
662 strstarts(symname, "_save32gpr_") ||
663 strstarts(symname, "_restvr_") ||
664 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200665 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000666 if (info->hdr->e_machine == EM_PPC64)
667 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900668 if (strstarts(symname, "_restgpr0_") ||
669 strstarts(symname, "_savegpr0_") ||
670 strstarts(symname, "_restvr_") ||
671 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100672 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000673 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200674 /* Do not ignore this symbol */
675 return 0;
676}
677
Masahiro Yamada17436942019-11-15 02:42:24 +0900678static void handle_modversion(const struct module *mod,
679 const struct elf_info *info,
680 const Elf_Sym *sym, const char *symname)
681{
682 unsigned int crc;
683
684 if (sym->st_shndx == SHN_UNDEF) {
685 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n",
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900686 symname, mod->name, mod->is_vmlinux ? "" : ".ko");
Masahiro Yamada17436942019-11-15 02:42:24 +0900687 return;
688 }
689
690 if (sym->st_shndx == SHN_ABS) {
691 crc = sym->st_value;
692 } else {
693 unsigned int *crcp;
694
695 /* symbol points to the CRC in the ELF object */
696 crcp = sym_get_data(info, sym);
697 crc = TO_NATIVE(*crcp);
698 }
699 sym_set_crc(symname, crc);
700}
701
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900702static void handle_symbol(struct module *mod, struct elf_info *info,
703 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200705 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900706 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200707
Masahiro Yamada33795762020-06-01 14:57:24 +0900708 if (strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200709 export = export_from_secname(info, get_secindex(info, sym));
710 else
711 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
713 switch (sym->st_shndx) {
714 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900715 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100716 /* Should warn here, but modpost runs before the linker */
717 } else
718 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 case SHN_UNDEF:
721 /* undefined symbol */
722 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
723 ELF_ST_BIND(sym->st_info) != STB_WEAK)
724 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200725 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 if (info->hdr->e_machine == EM_SPARC ||
728 info->hdr->e_machine == EM_SPARCV9) {
729 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700730 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100732 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700733 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100734 munged[0] = '_';
735 munged[1] = toupper(munged[1]);
736 symname = munged;
737 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100739
Rusty Russellb92021b2013-03-15 15:04:17 +1030740 mod->unres = alloc_symbol(symname,
741 ELF_ST_BIND(sym->st_info) == STB_WEAK,
742 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 break;
744 default:
745 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900746 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100747 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100748 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900750 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900752 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 mod->has_cleanup = 1;
754 break;
755 }
756}
757
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100758/**
759 * Parse tag=value strings from .modinfo section
760 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761static char *next_string(char *string, unsigned long *secsize)
762{
763 /* Skip non-zero chars */
764 while (string[0]) {
765 string++;
766 if ((*secsize)-- <= 1)
767 return NULL;
768 }
769
770 /* Skip any zero padding. */
771 while (!string[0]) {
772 string++;
773 if ((*secsize)-- <= 1)
774 return NULL;
775 }
776 return string;
777}
778
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900779static char *get_next_modinfo(struct elf_info *info, const char *tag,
780 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781{
782 char *p;
783 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900784 char *modinfo = info->modinfo;
785 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900787 if (prev) {
788 size -= prev - modinfo;
789 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200790 }
791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 for (p = modinfo; p; p = next_string(p, &size)) {
793 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
794 return p + taglen + 1;
795 }
796 return NULL;
797}
798
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900799static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200800
801{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900802 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200803}
804
Sam Ravnborg93684d32006-02-19 11:53:35 +0100805/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100806 * Test if string s ends in string sub
807 * return 0 if match
808 **/
809static int strrcmp(const char *s, const char *sub)
810{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100811 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100812
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100813 if (!s || !sub)
814 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100815
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100816 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100817 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100818
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100819 if ((slen == 0) || (sublen == 0))
820 return 1;
821
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100822 if (sublen > slen)
823 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100824
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100825 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100826}
827
Sam Ravnborgff13f922008-01-23 19:54:27 +0100828static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
829{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100830 if (sym)
831 return elf->strtab + sym->st_name;
832 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100833 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100834}
835
Sam Ravnborg10668222008-01-13 22:21:31 +0100836/* The pattern is an array of simple patterns.
837 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100838 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100839 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930840 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100841 */
Trevor Keith5c725132009-09-22 16:43:38 -0700842static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100843{
844 const char *p;
845 while (*pat) {
846 p = *pat++;
847 const char *endp = p + strlen(p) - 1;
848
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930849 /* "*foo*" */
850 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300851 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
852 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930853
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930854 free(bare);
855 if (here != NULL)
856 return 1;
857 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100858 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930859 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100860 if (strrcmp(sym, p + 1) == 0)
861 return 1;
862 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100863 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100864 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100865 if (strncmp(sym, p, strlen(p) - 1) == 0)
866 return 1;
867 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100868 /* no wildcards */
869 else {
870 if (strcmp(p, sym) == 0)
871 return 1;
872 }
873 }
874 /* no match */
875 return 0;
876}
877
Sam Ravnborg10668222008-01-13 22:21:31 +0100878/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930879static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200880{
881 ".comment*",
882 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930883 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800884 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000885 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200886 ".mdebug*", /* alpha, score, mips etc. */
887 ".pdr", /* alpha, score, mips etc. */
888 ".stab*",
889 ".note*",
890 ".got*",
891 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400892 ".xt.prop", /* xtensa */
893 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030894 ".arcextmap*", /* arc */
895 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030896 ".cmem*", /* EZchip */
897 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100898 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600899 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200900 NULL
901};
Sam Ravnborg10668222008-01-13 22:21:31 +0100902
Sam Ravnborge241a632008-01-28 20:13:13 +0100903/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400904 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100905 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400906 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100907 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400908static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900909 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100910{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400911 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100912
Anders Kaseorgb614a692009-04-23 16:49:33 -0400913 if (sechdr->sh_type == SHT_PROGBITS &&
914 !(sechdr->sh_flags & SHF_ALLOC) &&
915 !match(sec, section_white_list)) {
916 warn("%s (%s): unexpected non-allocatable section.\n"
917 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
918 "Note that for example <linux/init.h> contains\n"
919 "section definitions for use in .S files.\n\n",
920 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100921 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100922}
923
924
925
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100926#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930927 ".init.setup", ".init.rodata", ".meminit.rodata", \
928 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100929#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930930 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100931
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100932#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930933 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100934#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930935 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100936
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200937#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930938 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
939 ".pci_fixup_enable", ".pci_fixup_resume", \
940 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200941
Paul Gortmakere24f6622013-06-19 19:30:48 -0400942#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
943#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100944
945#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
946#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100947
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930948#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930949#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Thomas Gleixner65538962020-03-09 22:47:17 +0100950 ".kprobes.text", ".cpuidle.text", ".noinstr.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930951#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400952 ".fixup", ".entry.text", ".exception.text", ".text.*", \
953 ".coldtext"
Sam Ravnborg10668222008-01-13 22:21:31 +0100954
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000955#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000956#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100957
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000958#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000959#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100960
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930961#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
962 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
963
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100964/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930965static const char *const init_data_sections[] =
966 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100967
968/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930969static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100970
971/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930972static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100973 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100974
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930975/* all text sections */
976static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
977
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100978/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930979static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100980
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100981
982/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100983#define DEFAULT_SYMBOL_WHITE_LIST \
984 "*driver", \
985 "*_template", /* scsi uses *_template a lot */ \
986 "*_timer", /* arm uses ops structures named _timer a lot */ \
987 "*_sht", /* scsi also used *_sht to some extent */ \
988 "*_ops", \
989 "*_probe", \
990 "*_probe_one", \
991 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100992
Mathias Krause7a3ee752014-08-27 20:28:53 +0930993static const char *const head_sections[] = { ".head.text*", NULL };
994static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100995 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930996static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100997
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100998enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100999 TEXT_TO_ANY_INIT,
1000 DATA_TO_ANY_INIT,
1001 TEXT_TO_ANY_EXIT,
1002 DATA_TO_ANY_EXIT,
1003 XXXINIT_TO_SOME_INIT,
1004 XXXEXIT_TO_SOME_EXIT,
1005 ANY_INIT_TO_ANY_EXIT,
1006 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001007 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301008 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001009};
1010
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301011/**
1012 * Describe how to match sections on different criterias:
1013 *
1014 * @fromsec: Array of sections to be matched.
1015 *
1016 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
1017 * this array is forbidden (black-list). Can be empty.
1018 *
1019 * @good_tosec: Relocations applied to a section in @fromsec must be
1020 * targetting sections in this array (white-list). Can be empty.
1021 *
1022 * @mismatch: Type of mismatch.
1023 *
1024 * @symbol_white_list: Do not match a relocation to a symbol in this list
1025 * even if it is targetting a section in @bad_to_sec.
1026 *
1027 * @handler: Specific handler to call when a match is found. If NULL,
1028 * default_mismatch_handler() will be called.
1029 *
1030 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001031struct sectioncheck {
1032 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301033 const char *bad_tosec[20];
1034 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001035 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001036 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301037 void (*handler)(const char *modname, struct elf_info *elf,
1038 const struct sectioncheck* const mismatch,
1039 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1040
Sam Ravnborg10668222008-01-13 22:21:31 +01001041};
1042
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301043static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1044 const struct sectioncheck* const mismatch,
1045 Elf_Rela *r, Elf_Sym *sym,
1046 const char *fromsec);
1047
Mathias Krause7a3ee752014-08-27 20:28:53 +09301048static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001049/* Do not reference init/exit code/data from
1050 * normal code and data
1051 */
1052{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001053 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301054 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001055 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001056 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001057},
1058{
1059 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301060 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001061 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001062 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001063},
1064{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001065 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301066 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001067 .mismatch = DATA_TO_ANY_INIT,
1068 .symbol_white_list = {
1069 "*_template", "*_timer", "*_sht", "*_ops",
1070 "*_probe", "*_probe_one", "*_console", NULL
1071 },
1072},
1073{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001074 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301075 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001076 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001077 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001078},
1079{
1080 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301081 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001082 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001083 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001084},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001085/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001086{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001087 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301088 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001089 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001090 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001091},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001092/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001093{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001094 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301095 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001096 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001097 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001098},
1099/* Do not use exit code/data from init code */
1100{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001101 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301102 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001103 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001104 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001105},
1106/* Do not use init code/data from exit code */
1107{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001108 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301109 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001110 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001111 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001112},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001113{
1114 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301115 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001116 .mismatch = ANY_INIT_TO_ANY_EXIT,
1117 .symbol_white_list = { NULL },
1118},
Sam Ravnborg10668222008-01-13 22:21:31 +01001119/* Do not export init/exit functions or data */
1120{
1121 .fromsec = { "__ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301122 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001123 .mismatch = EXPORT_TO_INIT_EXIT,
1124 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301125},
1126{
1127 .fromsec = { "__ex_table", NULL },
1128 /* If you're adding any new black-listed sections in here, consider
1129 * adding a special 'printer' for them in scripts/check_extable.
1130 */
1131 .bad_tosec = { ".altinstr_replacement", NULL },
1132 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1133 .mismatch = EXTABLE_TO_NON_TEXT,
1134 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001135}
1136};
1137
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001138static const struct sectioncheck *section_mismatch(
1139 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001140{
1141 int i;
1142 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1143 const struct sectioncheck *check = &sectioncheck[0];
1144
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301145 /*
1146 * The target section could be the SHT_NUL section when we're
1147 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001148 * doesn't make much sense and causes build failures on parisc
1149 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301150 */
1151 if (*tosec == '\0')
1152 return NULL;
1153
Sam Ravnborg10668222008-01-13 22:21:31 +01001154 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301155 if (match(fromsec, check->fromsec)) {
1156 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1157 return check;
1158 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1159 return check;
1160 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001161 check++;
1162 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001163 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001164}
1165
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001166/**
1167 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001168 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001169 * Pattern 1:
1170 * If a module parameter is declared __initdata and permissions=0
1171 * then this is legal despite the warning generated.
1172 * We cannot see value of permissions here, so just ignore
1173 * this pattern.
1174 * The pattern is identified by:
1175 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001176 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001177 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001178 *
Rusty Russell6a841522010-08-11 23:04:16 -06001179 * Pattern 1a:
1180 * module_param_call() ops can refer to __init set function if permissions=0
1181 * The pattern is identified by:
1182 * tosec = .init.text
1183 * fromsec = .data*
1184 * atsym = __param_ops_*
1185 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001186 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001187 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001188 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001189 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001190 * tosec = init or exit section
1191 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001192 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1193 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001194 *
1195 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001196 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001197 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001198 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001199 * Some symbols belong to init section but still it is ok to reference
1200 * these from non-init sections as these symbols don't have any memory
1201 * allocated for them and symbol address and value are same. So even
1202 * if init section is freed, its ok to reference those symbols.
1203 * For ex. symbols marking the init section boundaries.
1204 * This pattern is identified by
1205 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001206 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301207 * Pattern 5:
1208 * GCC may optimize static inlines when fed constant arg(s) resulting
1209 * in functions like cpumask_empty() -- generating an associated symbol
1210 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1211 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1212 * meaningless section warning. May need to add isra symbols too...
1213 * This pattern is identified by
1214 * tosec = init section
1215 * fromsec = text section
1216 * refsymname = *.constprop.*
1217 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001218 * Pattern 6:
1219 * Hide section mismatch warnings for ELF local symbols. The goal
1220 * is to eliminate false positive modpost warnings caused by
1221 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1222 * Autogenerated symbol names bypass modpost's "Pattern 2"
1223 * whitelisting, which relies on pattern-matching against symbol
1224 * names to work. (One situation where gcc can autogenerate ELF
1225 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001226 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001227static int secref_whitelist(const struct sectioncheck *mismatch,
1228 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001229 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001230{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001231 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001232 if (match(tosec, init_data_sections) &&
1233 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001234 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001235 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001236
Rusty Russell6a841522010-08-11 23:04:16 -06001237 /* Check for pattern 1a */
1238 if (strcmp(tosec, ".init.text") == 0 &&
1239 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001240 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001241 return 0;
1242
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001243 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001244 if (match(tosec, init_exit_sections) &&
1245 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001246 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001247 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001248
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001249 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001250 if (match(fromsec, head_sections) &&
1251 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001252 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001253
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001254 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001255 if (match(tosym, linker_symbols))
1256 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001257
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301258 /* Check for pattern 5 */
1259 if (match(fromsec, text_sections) &&
1260 match(tosec, init_sections) &&
1261 match(fromsym, optim_symbols))
1262 return 0;
1263
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001264 /* Check for pattern 6 */
1265 if (strstarts(fromsym, ".L"))
1266 return 0;
1267
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001268 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001269}
1270
Sami Tolvanen5818c682018-10-23 15:15:35 -07001271static inline int is_arm_mapping_symbol(const char *str)
1272{
1273 return str[0] == '$' && strchr("axtd", str[1])
1274 && (str[2] == '\0' || str[2] == '.');
1275}
1276
1277/*
1278 * If there's no name there, ignore it; likewise, ignore it if it's
1279 * one of the magic symbols emitted used by current ARM tools.
1280 *
1281 * Otherwise if find_symbols_between() returns those symbols, they'll
1282 * fail the whitelist tests and cause lots of false alarms ... fixable
1283 * only by merging __exit and __init sections into __text, bloating
1284 * the kernel (which is especially evil on embedded platforms).
1285 */
1286static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1287{
1288 const char *name = elf->strtab + sym->st_name;
1289
1290 if (!name || !strlen(name))
1291 return 0;
1292 return !is_arm_mapping_symbol(name);
1293}
1294
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001295/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001296 * Find symbol based on relocation record info.
1297 * In some cases the symbol supplied is a valid symbol so
1298 * return refsym. If st_name != 0 we assume this is a valid symbol.
1299 * In other cases the symbol needs to be looked up in the symbol table
1300 * based on section and address.
1301 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001302static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001303 Elf_Sym *relsym)
1304{
1305 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001306 Elf_Sym *near = NULL;
1307 Elf64_Sword distance = 20;
1308 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001309 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001310
1311 if (relsym->st_name != 0)
1312 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001313
1314 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001315 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001316 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001317 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001318 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1319 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001320 if (!is_valid_name(elf, sym))
1321 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001322 if (sym->st_value == addr)
1323 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001324 /* Find a symbol nearby - addr are maybe negative */
1325 d = sym->st_value - addr;
1326 if (d < 0)
1327 d = addr - sym->st_value;
1328 if (d < distance) {
1329 distance = d;
1330 near = sym;
1331 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001332 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001333 /* We need a close match */
1334 if (distance < 20)
1335 return near;
1336 else
1337 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001338}
1339
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001340/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001341 * Find symbols before or equal addr and after addr - in the section sec.
1342 * If we find two symbols with equal offset prefer one with a valid name.
1343 * The ELF format may have a better way to detect what type of symbol
1344 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001345 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001346static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1347 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001348{
1349 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001350 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001351 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001352
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001353 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1354 const char *symsec;
1355
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001356 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001357 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001358 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001359 if (strcmp(symsec, sec) != 0)
1360 continue;
David Brownellda68d612007-02-20 13:58:16 -08001361 if (!is_valid_name(elf, sym))
1362 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001363 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001364 if ((addr - sym->st_value) < distance) {
1365 distance = addr - sym->st_value;
1366 near = sym;
1367 } else if ((addr - sym->st_value) == distance) {
1368 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001369 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001370 }
1371 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001372 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001373}
1374
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001375/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001376 * Convert a section name to the function/data attribute
1377 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001378 * .memexitconst => __memconst
1379 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001380 *
1381 * The memory of returned value has been allocated on a heap. The user of this
1382 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001383*/
1384static char *sec2annotation(const char *s)
1385{
1386 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001387 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001388 char *r = p;
1389
1390 *p++ = '_';
1391 *p++ = '_';
1392 if (*s == '.')
1393 s++;
1394 while (*s && *s != '.')
1395 *p++ = *s++;
1396 *p = '\0';
1397 if (*s == '.')
1398 s++;
1399 if (strstr(s, "rodata") != NULL)
1400 strcat(p, "const ");
1401 else if (strstr(s, "data") != NULL)
1402 strcat(p, "data ");
1403 else
1404 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001405 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001406 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001407 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001408 }
1409}
1410
1411static int is_function(Elf_Sym *sym)
1412{
1413 if (sym)
1414 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1415 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001416 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001417}
1418
Randy Dunlap00759c02011-03-15 14:13:47 -07001419static void print_section_list(const char * const list[20])
1420{
1421 const char *const *s = list;
1422
1423 while (*s) {
1424 fprintf(stderr, "%s", *s);
1425 s++;
1426 if (*s)
1427 fprintf(stderr, ", ");
1428 }
1429 fprintf(stderr, "\n");
1430}
1431
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301432static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1433{
1434 switch (is_func) {
1435 case 0: *name = "variable"; *name_p = ""; break;
1436 case 1: *name = "function"; *name_p = "()"; break;
1437 default: *name = "(unknown reference)"; *name_p = ""; break;
1438 }
1439}
1440
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001441/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001442 * Print a warning about a section mismatch.
1443 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001444 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001445 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001446static void report_sec_mismatch(const char *modname,
1447 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001448 const char *fromsec,
1449 unsigned long long fromaddr,
1450 const char *fromsym,
1451 int from_is_func,
1452 const char *tosec, const char *tosym,
1453 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001454{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001455 const char *from, *from_p;
1456 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001457 char *prl_from;
1458 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001459
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001460 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001461
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301462 get_pretty_name(from_is_func, &from, &from_p);
1463 get_pretty_name(to_is_func, &to, &to_p);
1464
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001465 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1466 "to the %s %s:%s%s\n",
1467 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1468 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001469
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001470 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001471 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001472 prl_from = sec2annotation(fromsec);
1473 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001474 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001475 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001476 "the %s %s%s%s.\n"
1477 "This is often because %s lacks a %s\n"
1478 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001479 prl_from, fromsym,
1480 to, prl_to, tosym, to_p,
1481 fromsym, prl_to, tosym);
1482 free(prl_from);
1483 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001484 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001485 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001486 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001487 fprintf(stderr,
1488 "The variable %s references\n"
1489 "the %s %s%s%s\n"
1490 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001491 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001492 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001493 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001494 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001495 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001496 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001497 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001498 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001499 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001500 fprintf(stderr,
1501 "The function %s() references a %s in an exit section.\n"
1502 "Often the %s %s%s has valid usage outside the exit section\n"
1503 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001504 fromsym, to, to, tosym, to_p, prl_to, tosym);
1505 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001506 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001507 case DATA_TO_ANY_EXIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001508 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001509 fprintf(stderr,
1510 "The variable %s references\n"
1511 "the %s %s%s%s\n"
1512 "If the reference is valid then annotate the\n"
1513 "variable with __exit* (see linux/init.h) or "
1514 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001515 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001516 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001517 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001518 break;
1519 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001520 case XXXINIT_TO_SOME_INIT:
1521 case XXXEXIT_TO_SOME_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001522 prl_from = sec2annotation(fromsec);
1523 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001524 fprintf(stderr,
1525 "The %s %s%s%s references\n"
1526 "a %s %s%s%s.\n"
1527 "If %s is only used by %s then\n"
1528 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001529 from, prl_from, fromsym, from_p,
1530 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001531 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001532 free(prl_from);
1533 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001534 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001535 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001536 prl_from = sec2annotation(fromsec);
1537 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001538 fprintf(stderr,
1539 "The %s %s%s%s references\n"
1540 "a %s %s%s%s.\n"
1541 "This is often seen when error handling "
1542 "in the init function\n"
1543 "uses functionality in the exit path.\n"
1544 "The fix is often to remove the %sannotation of\n"
1545 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001546 from, prl_from, fromsym, from_p,
1547 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001548 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001549 free(prl_from);
1550 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001551 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001552 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001553 prl_from = sec2annotation(fromsec);
1554 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001555 fprintf(stderr,
1556 "The %s %s%s%s references\n"
1557 "a %s %s%s%s.\n"
1558 "This is often seen when error handling "
1559 "in the exit function\n"
1560 "uses functionality in the init path.\n"
1561 "The fix is often to remove the %sannotation of\n"
1562 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001563 from, prl_from, fromsym, from_p,
1564 to, prl_to, tosym, to_p,
1565 prl_to, tosym, to_p);
1566 free(prl_from);
1567 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001568 break;
1569 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001570 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001571 fprintf(stderr,
1572 "The symbol %s is exported and annotated %s\n"
1573 "Fix this by removing the %sannotation of %s "
1574 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001575 tosym, prl_to, prl_to, tosym);
1576 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001577 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301578 case EXTABLE_TO_NON_TEXT:
1579 fatal("There's a special handler for this mismatch type, "
1580 "we should never get here.");
1581 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001582 }
1583 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001584}
1585
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301586static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1587 const struct sectioncheck* const mismatch,
1588 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1589{
1590 const char *tosec;
1591 Elf_Sym *to;
1592 Elf_Sym *from;
1593 const char *tosym;
1594 const char *fromsym;
1595
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301596 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1597 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301598
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001599 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301600 return;
1601
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301602 tosec = sec_name(elf, get_secindex(elf, sym));
1603 to = find_elf_symbol(elf, r->r_addend, sym);
1604 tosym = sym_name(elf, to);
1605
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301606 /* check whitelist - we may ignore it */
1607 if (secref_whitelist(mismatch,
1608 fromsec, fromsym, tosec, tosym)) {
1609 report_sec_mismatch(modname, mismatch,
1610 fromsec, r->r_offset, fromsym,
1611 is_function(from), tosec, tosym,
1612 is_function(to));
1613 }
1614}
1615
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301616static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1617{
1618 if (section_index > elf->num_sections)
1619 fatal("section_index is outside elf->num_sections!\n");
1620
1621 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1622}
1623
1624/*
1625 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1626 * to know the sizeof(struct exception_table_entry) for the target architecture.
1627 */
1628static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301629static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301630{
1631 /*
1632 * If we're currently checking the second relocation within __ex_table,
1633 * that relocation offset tells us the offsetof(struct
1634 * exception_table_entry, fixup) which is equal to sizeof(struct
1635 * exception_table_entry) divided by two. We use that to our advantage
1636 * since there's no portable way to get that size as every architecture
1637 * seems to go with different sized types. Not pretty but better than
1638 * hard-coding the size for every architecture..
1639 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301640 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301641 extable_entry_size = r->r_offset * 2;
1642}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301643
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301644static inline bool is_extable_fault_address(Elf_Rela *r)
1645{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301646 /*
1647 * extable_entry_size is only discovered after we've handled the
1648 * _second_ relocation in __ex_table, so only abort when we're not
1649 * handling the first reloc and extable_entry_size is zero.
1650 */
1651 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301652 fatal("extable_entry size hasn't been discovered!\n");
1653
1654 return ((r->r_offset == 0) ||
1655 (r->r_offset % extable_entry_size == 0));
1656}
1657
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301658#define is_second_extable_reloc(Start, Cur, Sec) \
1659 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1660
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301661static void report_extable_warnings(const char* modname, struct elf_info* elf,
1662 const struct sectioncheck* const mismatch,
1663 Elf_Rela* r, Elf_Sym* sym,
1664 const char* fromsec, const char* tosec)
1665{
1666 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1667 const char* fromsym_name = sym_name(elf, fromsym);
1668 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1669 const char* tosym_name = sym_name(elf, tosym);
1670 const char* from_pretty_name;
1671 const char* from_pretty_name_p;
1672 const char* to_pretty_name;
1673 const char* to_pretty_name_p;
1674
1675 get_pretty_name(is_function(fromsym),
1676 &from_pretty_name, &from_pretty_name_p);
1677 get_pretty_name(is_function(tosym),
1678 &to_pretty_name, &to_pretty_name_p);
1679
1680 warn("%s(%s+0x%lx): Section mismatch in reference"
1681 " from the %s %s%s to the %s %s:%s%s\n",
1682 modname, fromsec, (long)r->r_offset, from_pretty_name,
1683 fromsym_name, from_pretty_name_p,
1684 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1685
1686 if (!match(tosec, mismatch->bad_tosec) &&
1687 is_executable_section(elf, get_secindex(elf, sym)))
1688 fprintf(stderr,
1689 "The relocation at %s+0x%lx references\n"
1690 "section \"%s\" which is not in the list of\n"
1691 "authorized sections. If you're adding a new section\n"
1692 "and/or if this reference is valid, add \"%s\" to the\n"
1693 "list of authorized sections to jump to on fault.\n"
1694 "This can be achieved by adding \"%s\" to \n"
1695 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1696 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1697}
1698
1699static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1700 const struct sectioncheck* const mismatch,
1701 Elf_Rela* r, Elf_Sym* sym,
1702 const char *fromsec)
1703{
1704 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1705
1706 sec_mismatch_count++;
1707
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001708 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301709
1710 if (match(tosec, mismatch->bad_tosec))
1711 fatal("The relocation at %s+0x%lx references\n"
1712 "section \"%s\" which is black-listed.\n"
1713 "Something is seriously wrong and should be fixed.\n"
1714 "You might get more information about where this is\n"
1715 "coming from by using scripts/check_extable.sh %s\n",
1716 fromsec, (long)r->r_offset, tosec, modname);
1717 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1718 if (is_extable_fault_address(r))
1719 fatal("The relocation at %s+0x%lx references\n"
1720 "section \"%s\" which is not executable, IOW\n"
1721 "it is not possible for the kernel to fault\n"
1722 "at that address. Something is seriously wrong\n"
1723 "and should be fixed.\n",
1724 fromsec, (long)r->r_offset, tosec);
1725 else
1726 fatal("The relocation at %s+0x%lx references\n"
1727 "section \"%s\" which is not executable, IOW\n"
1728 "the kernel will fault if it ever tries to\n"
1729 "jump to it. Something is seriously wrong\n"
1730 "and should be fixed.\n",
1731 fromsec, (long)r->r_offset, tosec);
1732 }
1733}
1734
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001735static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001736 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001737{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001738 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301739 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001740
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001741 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301742 if (mismatch->handler)
1743 mismatch->handler(modname, elf, mismatch,
1744 r, sym, fromsec);
1745 else
1746 default_mismatch_handler(modname, elf, mismatch,
1747 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001748 }
1749}
1750
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001751static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001752 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001753{
Masahiro Yamadad2e4d052020-05-25 14:47:04 +09001754 return sym_get_data_by_offset(elf, sechdr->sh_info, r->r_offset);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001755}
1756
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001757static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001758{
1759 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001760 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001761
1762 switch (r_typ) {
1763 case R_386_32:
1764 r->r_addend = TO_NATIVE(*location);
1765 break;
1766 case R_386_PC32:
1767 r->r_addend = TO_NATIVE(*location) + 4;
1768 /* For CONFIG_RELOCATABLE=y */
1769 if (elf->hdr->e_type == ET_EXEC)
1770 r->r_addend += r->r_offset;
1771 break;
1772 }
1773 return 0;
1774}
1775
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001776#ifndef R_ARM_CALL
1777#define R_ARM_CALL 28
1778#endif
1779#ifndef R_ARM_JUMP24
1780#define R_ARM_JUMP24 29
1781#endif
1782
David A. Longc9698e52014-02-14 22:41:18 +01001783#ifndef R_ARM_THM_CALL
1784#define R_ARM_THM_CALL 10
1785#endif
1786#ifndef R_ARM_THM_JUMP24
1787#define R_ARM_THM_JUMP24 30
1788#endif
1789#ifndef R_ARM_THM_JUMP19
1790#define R_ARM_THM_JUMP19 51
1791#endif
1792
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001793static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001794{
1795 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1796
1797 switch (r_typ) {
1798 case R_ARM_ABS32:
1799 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001800 r->r_addend = (int)(long)
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001801 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001802 break;
1803 case R_ARM_PC24:
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001804 case R_ARM_CALL:
1805 case R_ARM_JUMP24:
David A. Longc9698e52014-02-14 22:41:18 +01001806 case R_ARM_THM_CALL:
1807 case R_ARM_THM_JUMP24:
1808 case R_ARM_THM_JUMP19:
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001809 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001810 r->r_addend = (int)(long)(elf->hdr +
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001811 sechdr->sh_offset +
1812 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001813 break;
1814 default:
1815 return 1;
1816 }
1817 return 0;
1818}
1819
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001820static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001821{
1822 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001823 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001824 unsigned int inst;
1825
1826 if (r_typ == R_MIPS_HI16)
1827 return 1; /* skip this */
1828 inst = TO_NATIVE(*location);
1829 switch (r_typ) {
1830 case R_MIPS_LO16:
1831 r->r_addend = inst & 0xffff;
1832 break;
1833 case R_MIPS_26:
1834 r->r_addend = (inst & 0x03ffffff) << 2;
1835 break;
1836 case R_MIPS_32:
1837 r->r_addend = inst;
1838 break;
1839 }
1840 return 0;
1841}
1842
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001843static void section_rela(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001844 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001845{
1846 Elf_Sym *sym;
1847 Elf_Rela *rela;
1848 Elf_Rela r;
1849 unsigned int r_sym;
1850 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001851
Sam Ravnborgff13f922008-01-23 19:54:27 +01001852 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001853 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1854
Sam Ravnborgff13f922008-01-23 19:54:27 +01001855 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001856 fromsec += strlen(".rela");
1857 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001858 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001859 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001860
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001861 for (rela = start; rela < stop; rela++) {
1862 r.r_offset = TO_NATIVE(rela->r_offset);
1863#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001864 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001865 unsigned int r_typ;
1866 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1867 r_sym = TO_NATIVE(r_sym);
1868 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1869 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1870 } else {
1871 r.r_info = TO_NATIVE(rela->r_info);
1872 r_sym = ELF_R_SYM(r.r_info);
1873 }
1874#else
1875 r.r_info = TO_NATIVE(rela->r_info);
1876 r_sym = ELF_R_SYM(r.r_info);
1877#endif
1878 r.r_addend = TO_NATIVE(rela->r_addend);
1879 sym = elf->symtab_start + r_sym;
1880 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001881 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001882 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301883 if (is_second_extable_reloc(start, rela, fromsec))
1884 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001885 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001886 }
1887}
1888
1889static void section_rel(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001890 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001891{
1892 Elf_Sym *sym;
1893 Elf_Rel *rel;
1894 Elf_Rela r;
1895 unsigned int r_sym;
1896 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001897
Sam Ravnborgff13f922008-01-23 19:54:27 +01001898 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001899 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1900
Sam Ravnborgff13f922008-01-23 19:54:27 +01001901 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001902 fromsec += strlen(".rel");
1903 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001904 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001905 return;
1906
1907 for (rel = start; rel < stop; rel++) {
1908 r.r_offset = TO_NATIVE(rel->r_offset);
1909#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001910 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001911 unsigned int r_typ;
1912 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1913 r_sym = TO_NATIVE(r_sym);
1914 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1915 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1916 } else {
1917 r.r_info = TO_NATIVE(rel->r_info);
1918 r_sym = ELF_R_SYM(r.r_info);
1919 }
1920#else
1921 r.r_info = TO_NATIVE(rel->r_info);
1922 r_sym = ELF_R_SYM(r.r_info);
1923#endif
1924 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001925 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001926 case EM_386:
1927 if (addend_386_rel(elf, sechdr, &r))
1928 continue;
1929 break;
1930 case EM_ARM:
1931 if (addend_arm_rel(elf, sechdr, &r))
1932 continue;
1933 break;
1934 case EM_MIPS:
1935 if (addend_mips_rel(elf, sechdr, &r))
1936 continue;
1937 break;
1938 }
1939 sym = elf->symtab_start + r_sym;
1940 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001941 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001942 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301943 if (is_second_extable_reloc(start, rel, fromsec))
1944 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001945 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001946 }
1947}
1948
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001949/**
1950 * A module includes a number of sections that are discarded
1951 * either when loaded or when used as built-in.
1952 * For loaded modules all functions marked __init and all data
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001953 * marked __initdata will be discarded when the module has been initialized.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001954 * Likewise for modules used built-in the sections marked __exit
1955 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001956 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001957 * The check_sec_ref() function traverses all relocation records
1958 * to find all references to a section that reference a section that will
1959 * be discarded and warns about it.
1960 **/
1961static void check_sec_ref(struct module *mod, const char *modname,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001962 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001963{
1964 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001965 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001966
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001967 /* Walk through all sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001968 for (i = 0; i < elf->num_sections; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001969 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001970 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001971 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001972 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001973 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001974 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001975 }
1976}
1977
Andi Kleen7d02b492014-02-08 09:01:12 +01001978static char *remove_dot(char *s)
1979{
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301980 size_t n = strcspn(s, ".");
Andi Kleen7d02b492014-02-08 09:01:12 +01001981
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301982 if (n && s[n]) {
1983 size_t m = strspn(s + n + 1, "0123456789");
1984 if (m && (s[n + m] == '.' || s[n + m] == 0))
Andi Kleen7d02b492014-02-08 09:01:12 +01001985 s[n] = 0;
1986 }
1987 return s;
1988}
1989
Masahiro Yamada8b185742018-05-09 18:50:40 +09001990static void read_symbols(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991{
1992 const char *symname;
1993 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001994 char *license;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01001995 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 struct module *mod;
1997 struct elf_info info = { };
1998 Elf_Sym *sym;
1999
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01002000 if (!parse_elf(&info, modname))
2001 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002003 {
2004 char *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002006 /* strip trailing .o */
2007 tmp = NOFAIL(strdup(modname));
2008 tmp[strlen(tmp) - 2] = '\0';
2009 mod = new_module(tmp);
2010 free(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 }
2012
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002013 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002014 license = get_modinfo(&info, "license");
2015 if (!license)
2016 warn("missing MODULE_LICENSE() in %s\n", modname);
2017 while (license) {
2018 if (license_is_gpl_compatible(license))
2019 mod->gpl_compatible = 1;
2020 else {
2021 mod->gpl_compatible = 0;
2022 break;
2023 }
2024 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002025 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002026
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002027 namespace = get_modinfo(&info, "import_ns");
2028 while (namespace) {
2029 add_namespace(&mod->imported_namespaces, namespace);
2030 namespace = get_next_modinfo(&info, "import_ns",
2031 namespace);
2032 }
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002033 }
2034
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002036 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002038 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 handle_moddevtable(mod, &info, sym, symname);
2040 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002041
Matthias Maennich69923202019-10-18 10:31:42 +01002042 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2043 symname = remove_dot(info.strtab + sym->st_name);
2044
Masahiro Yamada17436942019-11-15 02:42:24 +09002045 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002046 if (strstarts(symname, "__kstrtabns_"))
2047 sym_update_namespace(symname + strlen("__kstrtabns_"),
2048 namespace_from_kstrtabns(&info,
2049 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002050
2051 if (strstarts(symname, "__crc_"))
2052 handle_modversion(mod, &info, sym,
2053 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002054 }
2055
Denis Efremov15bfc232019-08-01 09:06:57 +03002056 // check for static EXPORT_SYMBOL_* functions && global vars
2057 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2058 unsigned char bind = ELF_ST_BIND(sym->st_info);
2059
2060 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2061 struct symbol *s =
2062 find_symbol(remove_dot(info.strtab +
2063 sym->st_name));
2064
2065 if (s)
2066 s->is_static = 0;
2067 }
2068 }
2069
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002070 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002072 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002073 version = get_modinfo(&info, "version");
2074 if (version || all_versions)
2075 get_src_version(modname, mod->srcversion,
2076 sizeof(mod->srcversion) - 1);
2077 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078
2079 parse_elf_finish(&info);
2080
Rusty Russell8c8ef422009-03-31 13:05:34 -06002081 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 * never passed as an argument to an exported function, so
2083 * the automatic versioning doesn't pick it up, but it's really
2084 * important anyhow */
2085 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06002086 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087}
2088
Rusty Russell712f9b42013-04-04 17:37:38 +10302089static void read_symbols_from_files(const char *filename)
2090{
2091 FILE *in = stdin;
2092 char fname[PATH_MAX];
2093
2094 if (strcmp(filename, "-") != 0) {
2095 in = fopen(filename, "r");
2096 if (!in)
2097 fatal("Can't open filenames file %s: %m", filename);
2098 }
2099
2100 while (fgets(fname, PATH_MAX, in) != NULL) {
2101 if (strends(fname, "\n"))
2102 fname[strlen(fname)-1] = '\0';
2103 read_symbols(fname);
2104 }
2105
2106 if (in != stdin)
2107 fclose(in);
2108}
2109
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110#define SZ 500
2111
2112/* We first write the generated file into memory using the
2113 * following helper, then compare to the file on disk and
2114 * only update the later if anything changed */
2115
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002116void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
2117 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118{
2119 char tmp[SZ];
2120 int len;
2121 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002122
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 va_start(ap, fmt);
2124 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f022006-03-16 23:04:08 -08002125 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 va_end(ap);
2127}
2128
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002129void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130{
2131 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f022006-03-16 23:04:08 -08002132 buf->size += len + SZ;
Randy Dunlap1f3aa902018-08-15 12:30:38 -07002133 buf->p = NOFAIL(realloc(buf->p, buf->size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 }
2135 strncpy(buf->p + buf->pos, s, len);
2136 buf->pos += len;
2137}
2138
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002139static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
2140{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002141 switch (exp) {
2142 case export_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002143 fatal("GPL-incompatible module %s.ko uses GPL-only symbol '%s'\n",
2144 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002145 break;
2146 case export_unused_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002147 fatal("GPL-incompatible module %s.ko uses GPL-only symbol marked UNUSED '%s'\n",
2148 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002149 break;
2150 case export_gpl_future:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002151 warn("GPL-incompatible module %s.ko uses future GPL-only symbol '%s'\n",
2152 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002153 break;
2154 case export_plain:
2155 case export_unused:
2156 case export_unknown:
2157 /* ignore */
2158 break;
2159 }
2160}
2161
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002162static void check_for_unused(enum export exp, const char *m, const char *s)
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002163{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002164 switch (exp) {
2165 case export_unused:
2166 case export_unused_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002167 warn("module %s.ko uses symbol '%s' marked UNUSED\n",
2168 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002169 break;
2170 default:
2171 /* ignore */
2172 break;
2173 }
2174}
2175
Masahiro Yamada3b415282018-11-23 16:57:23 +09002176static int check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002177{
2178 struct symbol *s, *exp;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002179 int err = 0;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002180
2181 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002182 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002183 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002184 if (!exp || exp->module == mod) {
2185 if (have_vmlinux && !s->weak) {
Jessica Yu93c95e52020-03-06 17:02:05 +01002186 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2187 "\"%s\" [%s.ko] undefined!\n",
2188 s->name, mod->name);
2189 if (!warn_unresolved)
Masahiro Yamada3b415282018-11-23 16:57:23 +09002190 err = 1;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002191 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002192 continue;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002193 }
Andrew Morton6449bd62006-06-09 20:45:06 -07002194 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002195 if (basename)
2196 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002197 else
2198 basename = mod->name;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002199
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002200 if (exp->namespace &&
2201 !module_imports_namespace(mod, exp->namespace)) {
Jessica Yu54b77842020-03-06 17:02:06 +01002202 modpost_log(allow_missing_ns_imports ? LOG_WARN : LOG_ERROR,
2203 "module %s uses symbol %s from namespace %s, but does not import it.\n",
2204 basename, exp->name, exp->namespace);
2205 if (!allow_missing_ns_imports)
2206 err = 1;
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002207 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002208 }
2209
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002210 if (!mod->gpl_compatible)
2211 check_for_gpl_usage(exp->export, basename, exp->name);
2212 check_for_unused(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002213 }
Masahiro Yamada3b415282018-11-23 16:57:23 +09002214
2215 return err;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002216}
2217
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002218static int check_modname_len(struct module *mod)
2219{
2220 const char *mod_name;
2221
2222 mod_name = strrchr(mod->name, '/');
2223 if (mod_name == NULL)
2224 mod_name = mod->name;
2225 else
2226 mod_name++;
2227 if (strlen(mod_name) >= MODULE_NAME_LEN) {
2228 merror("module name is too long [%s.ko]\n", mod->name);
2229 return 1;
2230 }
2231
2232 return 0;
2233}
2234
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002235/**
2236 * Header for the generated file
2237 **/
2238static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239{
2240 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002241 /*
2242 * Include build-salt.h after module.h in order to
2243 * inherit the definitions.
2244 */
Leon Romanovsky51161bf2020-04-19 18:55:06 +03002245 buf_printf(b, "#define INCLUDE_VERMAGIC\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002246 buf_printf(b, "#include <linux/build-salt.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 buf_printf(b, "#include <linux/vermagic.h>\n");
2248 buf_printf(b, "#include <linux/compiler.h>\n");
2249 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002250 buf_printf(b, "BUILD_SALT;\n");
2251 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002253 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302255 buf_printf(b, "__visible struct module __this_module\n");
Joe Perches33def842020-10-21 19:36:07 -07002256 buf_printf(b, "__section(\".gnu.linkonce.this_module\") = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002257 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002259 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 if (mod->has_cleanup)
2261 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002262 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002264 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 buf_printf(b, "};\n");
2266}
2267
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002268static void add_intree_flag(struct buffer *b, int is_intree)
2269{
2270 if (is_intree)
2271 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2272}
2273
Andi Kleencaf75012018-01-25 15:50:28 -08002274/* Cannot check for assembler */
2275static void add_retpoline(struct buffer *b)
2276{
WANG Chaoe4f35892018-12-11 00:37:25 +08002277 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002278 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2279 buf_printf(b, "#endif\n");
2280}
2281
Trevor Keith5c725132009-09-22 16:43:38 -07002282static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002283{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002284 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002285 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2286}
2287
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002288/**
2289 * Record CRCs for unresolved symbols
2290 **/
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002291static int add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292{
2293 struct symbol *s, *exp;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002294 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295
2296 for (s = mod->unres; s; s = s->next) {
2297 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002298 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 s->module = exp->module;
2301 s->crc_valid = exp->crc_valid;
2302 s->crc = exp->crc;
2303 }
2304
2305 if (!modversions)
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002306 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307
2308 buf_printf(b, "\n");
2309 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Joe Perches33def842020-10-21 19:36:07 -07002310 buf_printf(b, "__used __section(\"__versions\") = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311
2312 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002313 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002316 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 s->name, mod->name);
2318 continue;
2319 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302320 if (strlen(s->name) >= MODULE_NAME_LEN) {
2321 merror("too long symbol \"%s\" [%s.ko]\n",
2322 s->name, mod->name);
2323 err = 1;
2324 break;
2325 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002326 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302327 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 }
2329
2330 buf_printf(b, "};\n");
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002331
2332 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333}
2334
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002335static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336{
2337 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 int first = 1;
2339
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002340 /* Clear ->seen flag of modules that own symbols needed by this. */
2341 for (s = mod->unres; s; s = s->next)
2342 if (s->module)
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002343 s->module->seen = s->module->is_vmlinux;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344
2345 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002346 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002348 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 if (!s->module)
2350 continue;
2351
2352 if (s->module->seen)
2353 continue;
2354
2355 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002356 p = strrchr(s->module->name, '/');
2357 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002358 p++;
2359 else
2360 p = s->module->name;
2361 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 first = 0;
2363 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002364 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365}
2366
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002367static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368{
2369 if (mod->srcversion[0]) {
2370 buf_printf(b, "\n");
2371 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2372 mod->srcversion);
2373 }
2374}
2375
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002376static void write_buf(struct buffer *b, const char *fname)
2377{
2378 FILE *file;
2379
2380 file = fopen(fname, "w");
2381 if (!file) {
2382 perror(fname);
2383 exit(1);
2384 }
2385 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2386 perror(fname);
2387 exit(1);
2388 }
2389 if (fclose(file) != 0) {
2390 perror(fname);
2391 exit(1);
2392 }
2393}
2394
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002395static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396{
2397 char *tmp;
2398 FILE *file;
2399 struct stat st;
2400
2401 file = fopen(fname, "r");
2402 if (!file)
2403 goto write;
2404
2405 if (fstat(fileno(file), &st) < 0)
2406 goto close_write;
2407
2408 if (st.st_size != b->pos)
2409 goto close_write;
2410
2411 tmp = NOFAIL(malloc(b->pos));
2412 if (fread(tmp, 1, b->pos, file) != b->pos)
2413 goto free_write;
2414
2415 if (memcmp(tmp, b->p, b->pos) != 0)
2416 goto free_write;
2417
2418 free(tmp);
2419 fclose(file);
2420 return;
2421
2422 free_write:
2423 free(tmp);
2424 close_write:
2425 fclose(file);
2426 write:
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002427 write_buf(b, fname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428}
2429
Ram Paibd5cbce2006-06-08 22:12:53 -07002430/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002431 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002432 **/
Masahiro Yamada52c34162020-06-01 14:57:05 +09002433static void read_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434{
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002435 char *buf, *pos, *line;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002437 buf = read_text_file(fname);
2438 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 /* No symbol versions, silently ignore */
2440 return;
2441
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002442 pos = buf;
2443
2444 while ((line = get_line(&pos))) {
Jessica Yu51900442020-03-11 18:01:20 +01002445 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 unsigned int crc;
2447 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002448 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449
2450 if (!(symname = strchr(line, '\t')))
2451 goto fail;
2452 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002453 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 goto fail;
2455 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002456 if (!(export = strchr(modname, '\t')))
2457 goto fail;
2458 *export++ = '\0';
2459 if (!(namespace = strchr(export, '\t')))
2460 goto fail;
2461 *namespace++ = '\0';
2462
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 crc = strtoul(line, &d, 16);
2464 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2465 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002466 mod = find_module(modname);
2467 if (!mod) {
Jan Beulich0fa3a882009-03-12 12:28:30 +00002468 mod = new_module(modname);
Masahiro Yamada52c34162020-06-01 14:57:05 +09002469 mod->from_dump = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002471 s = sym_add_exported(symname, mod, export_no(export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002472 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002473 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002474 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475 }
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002476 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 return;
2478fail:
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002479 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 fatal("parse error in symbol dump file\n");
2481}
2482
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002483/* For normal builds always dump all symbols.
2484 * For external modules only dump symbols
2485 * that are not read from kernel Module.symvers.
2486 **/
2487static int dump_sym(struct symbol *sym)
2488{
2489 if (!external_module)
2490 return 1;
Masahiro Yamada52c34162020-06-01 14:57:05 +09002491 if (sym->module->from_dump)
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002492 return 0;
2493 return 1;
2494}
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002495
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002496static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497{
2498 struct buffer buf = { };
2499 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002500 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 int n;
2502
2503 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2504 symbol = symbolhash[n];
2505 while (symbol) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002506 if (dump_sym(symbol)) {
2507 namespace = symbol->namespace;
2508 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2509 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002510 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002511 export_str(symbol->export),
2512 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002513 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 symbol = symbol->next;
2515 }
2516 }
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002517 write_buf(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002518 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519}
2520
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002521static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002522{
2523 struct module *mod;
2524 struct namespace_list *ns;
2525 struct buffer ns_deps_buf = {};
2526
2527 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002528
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002529 if (mod->from_dump || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002530 continue;
2531
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002532 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002533
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002534 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2535 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002536
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002537 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002538 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002539
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002540 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002541 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002542}
2543
Masahiro Yamada79247992020-06-01 14:57:07 +09002544struct dump_list {
2545 struct dump_list *next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002546 const char *file;
2547};
2548
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002549int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550{
2551 struct module *mod;
2552 struct buffer buf = { };
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002553 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302554 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555 int opt;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002556 int err;
Denis Efremov15bfc232019-08-01 09:06:57 +03002557 int n;
Masahiro Yamada79247992020-06-01 14:57:07 +09002558 struct dump_list *dump_read_start = NULL;
2559 struct dump_list **dump_read_iter = &dump_read_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002561 while ((opt = getopt(argc, argv, "ei:mnT:o:awENd:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002562 switch (opt) {
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002563 case 'e':
2564 external_module = 1;
Masahiro Yamadae3fb4df2020-06-01 14:57:08 +09002565 break;
2566 case 'i':
Masahiro Yamada79247992020-06-01 14:57:07 +09002567 *dump_read_iter =
2568 NOFAIL(calloc(1, sizeof(**dump_read_iter)));
2569 (*dump_read_iter)->file = optarg;
2570 dump_read_iter = &(*dump_read_iter)->next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002571 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002572 case 'm':
2573 modversions = 1;
2574 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302575 case 'n':
2576 ignore_missing_files = 1;
2577 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002578 case 'o':
2579 dump_write = optarg;
2580 break;
2581 case 'a':
2582 all_versions = 1;
2583 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302584 case 'T':
2585 files_source = optarg;
2586 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002587 case 'w':
2588 warn_unresolved = 1;
2589 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302590 case 'E':
2591 sec_mismatch_fatal = 1;
2592 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002593 case 'N':
2594 allow_missing_ns_imports = 1;
2595 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002596 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002597 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002598 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002599 default:
2600 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 }
2602 }
2603
Masahiro Yamada79247992020-06-01 14:57:07 +09002604 while (dump_read_start) {
2605 struct dump_list *tmp;
Masahiro Yamada2beee862020-06-01 14:57:04 +09002606
Masahiro Yamada79247992020-06-01 14:57:07 +09002607 read_dump(dump_read_start->file);
2608 tmp = dump_read_start->next;
2609 free(dump_read_start);
2610 dump_read_start = tmp;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002611 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002613 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615
Rusty Russell712f9b42013-04-04 17:37:38 +10302616 if (files_source)
2617 read_symbols_from_files(files_source);
2618
Masahiro Yamada7e8a3232020-06-01 14:57:13 +09002619 /*
2620 * When there's no vmlinux, don't print warnings about
2621 * unresolved symbols (since there'll be too many ;)
2622 */
2623 if (!have_vmlinux)
2624 warn("Symbol info of vmlinux is missing. Unresolved symbol check will be entirely skipped.\n");
2625
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002626 err = 0;
2627
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002628 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302629 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002630
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002631 if (mod->is_vmlinux || mod->from_dump)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002632 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633
2634 buf.pos = 0;
2635
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002636 err |= check_modname_len(mod);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002637 err |= check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002638
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002640 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002641 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002642 add_staging_flag(&buf, mod->name);
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002643 err |= add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002644 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645 add_moddevtable(&buf, mod);
2646 add_srcversion(&buf, mod);
2647
2648 sprintf(fname, "%s.mod.c", mod->name);
2649 write_if_changed(&buf, fname);
2650 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002651
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002652 if (missing_namespace_deps)
2653 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002654
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 if (dump_write)
2656 write_dump(dump_write);
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002657 if (sec_mismatch_count && sec_mismatch_fatal)
Jessica Yu93c95e52020-03-06 17:02:05 +01002658 fatal("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002659 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002660 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002661 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002662
Masahiro Yamada47346e92019-09-24 21:07:40 +09002663 for (s = symbolhash[n]; s; s = s->next) {
Denis Efremov15bfc232019-08-01 09:06:57 +03002664 if (s->is_static)
Quentin Perretdb78f3b2020-11-24 18:24:09 +00002665 fatal("\"%s\" [%s] is a static %s\n",
2666 s->name, s->module->name,
2667 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002668 }
2669 }
2670
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002671 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002673 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674}