blob: 94041ee32798fd7a7dea557653ab9347ba5ad050 [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>
Masahiro Yamadae54dd932021-08-28 18:50:59 +090020#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/* Is CONFIG_MODULE_SRCVERSION_ALL set? */
28static int all_versions = 0;
Sam Ravnborg040fcc82006-01-28 22:15:55 +010029/* If we are modposting external module set to 1 */
30static int external_module = 0;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -070031/* Only warn about unresolved symbols */
32static int warn_unresolved = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -070033/* How a symbol is exported */
Sam Ravnborg588ccd72008-01-24 21:12:37 +010034static int sec_mismatch_count = 0;
Masahiro Yamadac7299d92020-12-01 19:34:18 +090035static int sec_mismatch_warn_only = true;
Guenter Roeckeed380f2013-09-23 15:23:54 +093036/* ignore missing files */
37static int ignore_missing_files;
Jessica Yu54b77842020-03-06 17:02:06 +010038/* If set to 1, only warn (instead of error) about missing ns imports */
39static int allow_missing_ns_imports;
Sam Ravnborg588ccd72008-01-24 21:12:37 +010040
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +090041static bool error_occurred;
42
Masahiro Yamada4475dff2021-03-26 03:54:11 +090043/*
44 * Cut off the warnings when there are too many. This typically occurs when
45 * vmlinux is missing. ('make modules' without building vmlinux.)
46 */
47#define MAX_UNRESOLVED_REPORTS 10
48static unsigned int nr_unresolved;
49
Sam Ravnborgc96fca22006-07-01 11:44:23 +020050enum export {
Christoph Hellwig36794822021-02-02 13:13:34 +010051 export_plain,
52 export_gpl,
53 export_unknown
Sam Ravnborgc96fca22006-07-01 11:44:23 +020054};
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +080056/* In kernel, this size is defined in linux/module.h;
57 * here we use Elf_Addr instead of long for covering cross-compile
58 */
59
60#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
61
Jessica Yu93c95e52020-03-06 17:02:05 +010062void __attribute__((format(printf, 2, 3)))
63modpost_log(enum loglevel loglevel, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064{
65 va_list arglist;
66
Jessica Yu93c95e52020-03-06 17:02:05 +010067 switch (loglevel) {
68 case LOG_WARN:
69 fprintf(stderr, "WARNING: ");
70 break;
71 case LOG_ERROR:
72 fprintf(stderr, "ERROR: ");
73 break;
74 case LOG_FATAL:
75 fprintf(stderr, "FATAL: ");
76 break;
77 default: /* invalid loglevel, ignore */
78 break;
79 }
80
81 fprintf(stderr, "modpost: ");
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83 va_start(arglist, fmt);
84 vfprintf(stderr, fmt, arglist);
85 va_end(arglist);
86
Jessica Yu93c95e52020-03-06 17:02:05 +010087 if (loglevel == LOG_FATAL)
88 exit(1);
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +090089 if (loglevel == LOG_ERROR)
90 error_occurred = true;
Matthew Wilcox2a116652006-10-07 05:35:32 -060091}
92
Masahiro Yamadae54dd932021-08-28 18:50:59 +090093static inline bool strends(const char *str, const char *postfix)
94{
95 if (strlen(str) < strlen(postfix))
96 return false;
97
98 return strcmp(str + strlen(str) - strlen(postfix), postfix) == 0;
99}
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101void *do_nofail(void *ptr, const char *expr)
102{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100103 if (!ptr)
Jessica Yu93c95e52020-03-06 17:02:05 +0100104 fatal("Memory allocation failure: %s.\n", expr);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 return ptr;
107}
108
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900109char *read_text_file(const char *filename)
110{
111 struct stat st;
112 size_t nbytes;
113 int fd;
114 char *buf;
115
116 fd = open(filename, O_RDONLY);
117 if (fd < 0) {
118 perror(filename);
119 exit(1);
120 }
121
122 if (fstat(fd, &st) < 0) {
123 perror(filename);
124 exit(1);
125 }
126
127 buf = NOFAIL(malloc(st.st_size + 1));
128
129 nbytes = st.st_size;
130
131 while (nbytes) {
132 ssize_t bytes_read;
133
134 bytes_read = read(fd, buf, nbytes);
135 if (bytes_read < 0) {
136 perror(filename);
137 exit(1);
138 }
139
140 nbytes -= bytes_read;
141 }
142 buf[st.st_size] = '\0';
143
144 close(fd);
145
146 return buf;
147}
148
149char *get_line(char **stringp)
150{
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200151 char *orig = *stringp, *next;
152
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900153 /* do not return the unwanted extra line at EOF */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200154 if (!orig || *orig == '\0')
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900155 return NULL;
156
Wolfram Sang6020db52020-07-26 23:44:19 +0200157 /* don't use strsep here, it is not available everywhere */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200158 next = strchr(orig, '\n');
159 if (next)
160 *next++ = '\0';
161
162 *stringp = next;
163
164 return orig;
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900165}
166
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167/* A list of all modules we processed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168static struct module *modules;
169
Masahiro Yamada8b185742018-05-09 18:50:40 +0900170static struct module *find_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
172 struct module *mod;
173
174 for (mod = modules; mod; mod = mod->next)
175 if (strcmp(mod->name, modname) == 0)
176 break;
177 return mod;
178}
179
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030180static struct module *new_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181{
182 struct module *mod;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100183
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900184 mod = NOFAIL(malloc(sizeof(*mod) + strlen(modname) + 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 memset(mod, 0, sizeof(*mod));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187 /* add to list */
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900188 strcpy(mod->name, modname);
Masahiro Yamada4de7b622020-06-01 14:57:30 +0900189 mod->is_vmlinux = (strcmp(modname, "vmlinux") == 0);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200190 mod->gpl_compatible = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 mod->next = modules;
192 modules = mod;
193
194 return mod;
195}
196
197/* A hash of all exported symbols,
198 * struct symbol is also used for lists of unresolved symbols */
199
200#define SYMBOL_HASH_SIZE 1024
201
202struct symbol {
203 struct symbol *next;
204 struct module *module;
205 unsigned int crc;
206 int crc_valid;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900207 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 unsigned int weak:1;
Denis Efremov15bfc232019-08-01 09:06:57 +0300209 unsigned int is_static:1; /* 1 if symbol is not global */
Ram Paibd5cbce2006-06-08 22:12:53 -0700210 enum export export; /* Type of export */
Gustavo A. R. Silva859c8172020-05-07 13:56:01 -0500211 char name[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212};
213
214static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
215
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +0530216/* This is based on the hash algorithm from gdbm, via tdb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217static inline unsigned int tdb_hash(const char *name)
218{
219 unsigned value; /* Used to compute the hash value. */
220 unsigned i; /* Used to cycle through random values. */
221
222 /* Set the initial value from the key size. */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100223 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
225
226 return (1103515243 * value + 12345);
227}
228
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100229/**
230 * Allocate a new symbols for use in the hash of exported symbols or
231 * the list of unresolved symbols per module
232 **/
233static struct symbol *alloc_symbol(const char *name, unsigned int weak,
234 struct symbol *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235{
236 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
237
238 memset(s, 0, sizeof(*s));
239 strcpy(s->name, name);
240 s->weak = weak;
241 s->next = next;
Denis Efremov15bfc232019-08-01 09:06:57 +0300242 s->is_static = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 return s;
244}
245
246/* For the hash of exported symbols */
Ram Paibd5cbce2006-06-08 22:12:53 -0700247static struct symbol *new_symbol(const char *name, struct module *module,
248 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249{
250 unsigned int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
252 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900253 symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
254
255 return symbolhash[hash];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256}
257
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100258static struct symbol *find_symbol(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
260 struct symbol *s;
261
262 /* For our purposes, .foo matches foo. PPC64 needs this. */
263 if (name[0] == '.')
264 name++;
265
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100266 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 if (strcmp(s->name, name) == 0)
268 return s;
269 }
270 return NULL;
271}
272
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100273static bool contains_namespace(struct namespace_list *list,
274 const char *namespace)
275{
Masahiro Yamada76b54cf2019-10-29 21:38:09 +0900276 for (; list; list = list->next)
277 if (!strcmp(list->namespace, namespace))
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100278 return true;
279
280 return false;
281}
282
283static void add_namespace(struct namespace_list **list, const char *namespace)
284{
285 struct namespace_list *ns_entry;
286
287 if (!contains_namespace(*list, namespace)) {
288 ns_entry = NOFAIL(malloc(sizeof(struct namespace_list) +
289 strlen(namespace) + 1));
290 strcpy(ns_entry->namespace, namespace);
291 ns_entry->next = *list;
292 *list = ns_entry;
293 }
294}
295
296static bool module_imports_namespace(struct module *module,
297 const char *namespace)
298{
299 return contains_namespace(module->imported_namespaces, namespace);
300}
301
Mathias Krause7a3ee752014-08-27 20:28:53 +0930302static const struct {
Ram Paibd5cbce2006-06-08 22:12:53 -0700303 const char *str;
304 enum export export;
305} export_list[] = {
306 { .str = "EXPORT_SYMBOL", .export = export_plain },
307 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
Ram Paibd5cbce2006-06-08 22:12:53 -0700308 { .str = "(unknown)", .export = export_unknown },
309};
310
311
312static const char *export_str(enum export ex)
313{
314 return export_list[ex].str;
315}
316
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100317static enum export export_no(const char *s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700318{
319 int i;
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100320
Sam Ravnborg534b89a2006-07-01 10:10:19 +0200321 if (!s)
322 return export_unknown;
Ram Paibd5cbce2006-06-08 22:12:53 -0700323 for (i = 0; export_list[i].export != export_unknown; i++) {
324 if (strcmp(export_list[i].str, s) == 0)
325 return export_list[i].export;
326 }
327 return export_unknown;
328}
329
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900330static void *sym_get_data_by_offset(const struct elf_info *info,
331 unsigned int secindex, unsigned long offset)
Masahiro Yamada6124c042017-09-06 16:19:05 -0700332{
Xiao Yang4b8a5cf2020-03-18 18:34:16 +0800333 Elf_Shdr *sechdr = &info->sechdrs[secindex];
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900334
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900335 if (info->hdr->e_type != ET_REL)
336 offset -= sechdr->sh_addr;
337
338 return (void *)info->hdr + sechdr->sh_offset + offset;
339}
340
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900341static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
342{
343 return sym_get_data_by_offset(info, get_secindex(info, sym),
344 sym->st_value);
345}
346
Masahiro Yamada565587d2020-05-25 14:47:05 +0900347static const char *sech_name(const struct elf_info *info, Elf_Shdr *sechdr)
348{
349 return sym_get_data_by_offset(info, info->secindex_strings,
350 sechdr->sh_name);
351}
352
353static const char *sec_name(const struct elf_info *info, int secindex)
354{
355 return sech_name(info, &info->sechdrs[secindex]);
356}
357
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200358#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
359
360static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
361{
362 const char *secname = sec_name(elf, sec);
363
364 if (strstarts(secname, "___ksymtab+"))
365 return export_plain;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200366 else if (strstarts(secname, "___ksymtab_gpl+"))
367 return export_gpl;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200368 else
369 return export_unknown;
370}
371
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200372static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700373{
374 if (sec == elf->export_sec)
375 return export_plain;
376 else if (sec == elf->export_gpl_sec)
377 return export_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700378 else
379 return export_unknown;
380}
381
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900382static const char *namespace_from_kstrtabns(const struct elf_info *info,
383 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100384{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900385 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100386 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100387}
388
Matthias Maennicha2b11182019-10-18 10:31:40 +0100389static void sym_update_namespace(const char *symname, const char *namespace)
390{
391 struct symbol *s = find_symbol(symname);
392
393 /*
394 * That symbol should have been created earlier and thus this is
395 * actually an assertion.
396 */
397 if (!s) {
Masahiro Yamadabc72d722020-12-01 19:34:14 +0900398 error("Could not update namespace(%s) for symbol %s\n",
399 namespace, symname);
Matthias Maennicha2b11182019-10-18 10:31:40 +0100400 return;
401 }
402
403 free(s->namespace);
404 s->namespace =
405 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
406}
407
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100408/**
409 * Add an exported symbol - it may have already been added without a
410 * CRC, in this case just update the CRC
411 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100412static struct symbol *sym_add_exported(const char *name, struct module *mod,
413 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414{
415 struct symbol *s = find_symbol(name);
416
417 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700418 s = new_symbol(name, mod, export);
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900419 } else if (!external_module || s->module->is_vmlinux ||
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900420 s->module == mod) {
421 warn("%s: '%s' exported twice. Previous export was in %s%s\n",
422 mod->name, name, s->module->name,
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900423 s->module->is_vmlinux ? "" : ".ko");
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900424 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900426
427 s->module = mod;
Ram Paibd5cbce2006-06-08 22:12:53 -0700428 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100429 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430}
431
Masahiro Yamada17436942019-11-15 02:42:24 +0900432static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100433{
434 struct symbol *s = find_symbol(name);
435
Masahiro Yamada17436942019-11-15 02:42:24 +0900436 /*
437 * Ignore stand-alone __crc_*, which might be auto-generated symbols
438 * such as __*_veneer in ARM ELF.
439 */
440 if (!s)
441 return;
442
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100443 s->crc = crc;
444 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445}
446
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900447static void *grab_file(const char *filename, size_t *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448{
449 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930450 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 int fd;
452
453 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930454 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930456 if (fstat(fd, &st))
457 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
459 *size = st.st_size;
460 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930462failed:
463 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 if (map == MAP_FAILED)
465 return NULL;
466 return map;
467}
468
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900469static void release_file(void *file, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470{
471 munmap(file, size);
472}
473
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100474static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
476 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100477 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 Elf_Shdr *sechdrs;
479 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200480 const char *secstrings;
481 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483 hdr = grab_file(filename, &info->size);
484 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930485 if (ignore_missing_files) {
486 fprintf(stderr, "%s: %s (ignored)\n", filename,
487 strerror(errno));
488 return 0;
489 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200491 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 }
493 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100494 if (info->size < sizeof(*hdr)) {
495 /* file too small, assume this is an empty .o file */
496 return 0;
497 }
498 /* Is this a valid ELF file? */
499 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
500 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
501 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
502 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
503 /* Not an ELF file - silently ignore it */
504 return 0;
505 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200507 hdr->e_type = TO_NATIVE(hdr->e_type);
508 hdr->e_machine = TO_NATIVE(hdr->e_machine);
509 hdr->e_version = TO_NATIVE(hdr->e_version);
510 hdr->e_entry = TO_NATIVE(hdr->e_entry);
511 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
512 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
513 hdr->e_flags = TO_NATIVE(hdr->e_flags);
514 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
515 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
516 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
517 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
518 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
519 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 sechdrs = (void *)hdr + hdr->e_shoff;
521 info->sechdrs = sechdrs;
522
Petr Stetiara83710e2007-08-27 12:15:07 +0200523 /* Check if file offset is correct */
524 if (hdr->e_shoff > info->size) {
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900525 fatal("section header offset=%lu in file '%s' is bigger than filesize=%zu\n",
526 (unsigned long)hdr->e_shoff, filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200527 return 0;
528 }
529
Anders Kaseorg68457562011-05-19 16:55:27 -0600530 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200531 /*
532 * There are more than 64k sections,
533 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200534 */
535 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
536 }
537 else {
538 info->num_sections = hdr->e_shnum;
539 }
540 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600541 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200542 }
543 else {
544 info->secindex_strings = hdr->e_shstrndx;
545 }
546
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200548 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200549 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
550 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
551 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
552 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
553 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
554 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
555 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
556 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
557 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
558 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 }
560 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200561 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
562 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700563 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900564 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
Tejun Heo56fc82c2009-02-06 00:48:02 +0900566 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100567 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
568 "sizeof(*hrd)=%zu\n", filename,
569 (unsigned long)sechdrs[i].sh_offset,
570 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100571 return 0;
572 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700573 secname = secstrings + sechdrs[i].sh_name;
574 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900575 if (nobits)
576 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
578 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700579 } else if (strcmp(secname, "__ksymtab") == 0)
580 info->export_sec = i;
581 else if (strcmp(secname, "__ksymtab_gpl") == 0)
582 info->export_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700583
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200584 if (sechdrs[i].sh_type == SHT_SYMTAB) {
585 unsigned int sh_link_idx;
586 symtab_idx = i;
587 info->symtab_start = (void *)hdr +
588 sechdrs[i].sh_offset;
589 info->symtab_stop = (void *)hdr +
590 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600591 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200592 info->strtab = (void *)hdr +
593 sechdrs[sh_link_idx].sh_offset;
594 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200596 /* 32bit section no. table? ("more than 64k sections") */
597 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
598 symtab_shndx_idx = i;
599 info->symtab_shndx_start = (void *)hdr +
600 sechdrs[i].sh_offset;
601 info->symtab_shndx_stop = (void *)hdr +
602 sechdrs[i].sh_offset + sechdrs[i].sh_size;
603 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100605 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100606 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 /* Fix endianness in symbols */
609 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
610 sym->st_shndx = TO_NATIVE(sym->st_shndx);
611 sym->st_name = TO_NATIVE(sym->st_name);
612 sym->st_value = TO_NATIVE(sym->st_value);
613 sym->st_size = TO_NATIVE(sym->st_size);
614 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200615
616 if (symtab_shndx_idx != ~0U) {
617 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600618 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200619 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600620 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200621 symtab_idx);
622 /* Fix endianness */
623 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
624 p++)
625 *p = TO_NATIVE(*p);
626 }
627
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100628 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629}
630
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100631static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
633 release_file(info->hdr, info->size);
634}
635
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200636static int ignore_undef_symbol(struct elf_info *info, const char *symname)
637{
638 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900639 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200640 return 1;
641 /* ignore global offset table */
642 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
643 return 1;
644 if (info->hdr->e_machine == EM_PPC)
645 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900646 if (strstarts(symname, "_restgpr_") ||
647 strstarts(symname, "_savegpr_") ||
648 strstarts(symname, "_rest32gpr_") ||
649 strstarts(symname, "_save32gpr_") ||
650 strstarts(symname, "_restvr_") ||
651 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200652 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000653 if (info->hdr->e_machine == EM_PPC64)
654 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900655 if (strstarts(symname, "_restgpr0_") ||
656 strstarts(symname, "_savegpr0_") ||
657 strstarts(symname, "_restvr_") ||
658 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100659 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000660 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200661 /* Do not ignore this symbol */
662 return 0;
663}
664
Masahiro Yamada17436942019-11-15 02:42:24 +0900665static void handle_modversion(const struct module *mod,
666 const struct elf_info *info,
667 const Elf_Sym *sym, const char *symname)
668{
669 unsigned int crc;
670
671 if (sym->st_shndx == SHN_UNDEF) {
Masahiro Yamada9f20ce92022-04-02 00:56:10 +0900672 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n"
Mark Brown4a679592021-06-07 15:02:06 +0100673 "Is \"%s\" prototyped in <asm/asm-prototypes.h>?\n",
674 symname, mod->name, mod->is_vmlinux ? "" : ".ko",
675 symname);
676
Masahiro Yamada17436942019-11-15 02:42:24 +0900677 return;
678 }
679
680 if (sym->st_shndx == SHN_ABS) {
681 crc = sym->st_value;
682 } else {
683 unsigned int *crcp;
684
685 /* symbol points to the CRC in the ELF object */
686 crcp = sym_get_data(info, sym);
687 crc = TO_NATIVE(*crcp);
688 }
689 sym_set_crc(symname, crc);
690}
691
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900692static void handle_symbol(struct module *mod, struct elf_info *info,
693 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200695 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900696 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200697
Masahiro Yamada33795762020-06-01 14:57:24 +0900698 if (strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200699 export = export_from_secname(info, get_secindex(info, sym));
700 else
701 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
703 switch (sym->st_shndx) {
704 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900705 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100706 /* Should warn here, but modpost runs before the linker */
707 } else
708 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 case SHN_UNDEF:
711 /* undefined symbol */
712 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
713 ELF_ST_BIND(sym->st_info) != STB_WEAK)
714 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200715 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 if (info->hdr->e_machine == EM_SPARC ||
718 info->hdr->e_machine == EM_SPARCV9) {
719 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700720 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100722 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700723 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100724 munged[0] = '_';
725 munged[1] = toupper(munged[1]);
726 symname = munged;
727 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100729
Rusty Russellb92021b2013-03-15 15:04:17 +1030730 mod->unres = alloc_symbol(symname,
731 ELF_ST_BIND(sym->st_info) == STB_WEAK,
732 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 break;
734 default:
735 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900736 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100737 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100738 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900740 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900742 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 mod->has_cleanup = 1;
744 break;
745 }
746}
747
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100748/**
749 * Parse tag=value strings from .modinfo section
750 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751static char *next_string(char *string, unsigned long *secsize)
752{
753 /* Skip non-zero chars */
754 while (string[0]) {
755 string++;
756 if ((*secsize)-- <= 1)
757 return NULL;
758 }
759
760 /* Skip any zero padding. */
761 while (!string[0]) {
762 string++;
763 if ((*secsize)-- <= 1)
764 return NULL;
765 }
766 return string;
767}
768
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900769static char *get_next_modinfo(struct elf_info *info, const char *tag,
770 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771{
772 char *p;
773 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900774 char *modinfo = info->modinfo;
775 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900777 if (prev) {
778 size -= prev - modinfo;
779 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200780 }
781
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 for (p = modinfo; p; p = next_string(p, &size)) {
783 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
784 return p + taglen + 1;
785 }
786 return NULL;
787}
788
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900789static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200790
791{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900792 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200793}
794
Sam Ravnborg93684d32006-02-19 11:53:35 +0100795/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100796 * Test if string s ends in string sub
797 * return 0 if match
798 **/
799static int strrcmp(const char *s, const char *sub)
800{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100801 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100802
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100803 if (!s || !sub)
804 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100805
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100806 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100807 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100808
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100809 if ((slen == 0) || (sublen == 0))
810 return 1;
811
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100812 if (sublen > slen)
813 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100814
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100815 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100816}
817
Sam Ravnborgff13f922008-01-23 19:54:27 +0100818static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
819{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100820 if (sym)
821 return elf->strtab + sym->st_name;
822 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100823 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100824}
825
Sam Ravnborg10668222008-01-13 22:21:31 +0100826/* The pattern is an array of simple patterns.
827 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100828 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100829 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930830 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100831 */
Trevor Keith5c725132009-09-22 16:43:38 -0700832static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100833{
834 const char *p;
835 while (*pat) {
836 p = *pat++;
837 const char *endp = p + strlen(p) - 1;
838
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930839 /* "*foo*" */
840 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300841 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
842 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930843
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930844 free(bare);
845 if (here != NULL)
846 return 1;
847 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100848 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930849 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100850 if (strrcmp(sym, p + 1) == 0)
851 return 1;
852 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100853 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100854 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100855 if (strncmp(sym, p, strlen(p) - 1) == 0)
856 return 1;
857 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100858 /* no wildcards */
859 else {
860 if (strcmp(p, sym) == 0)
861 return 1;
862 }
863 }
864 /* no match */
865 return 0;
866}
867
Sam Ravnborg10668222008-01-13 22:21:31 +0100868/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930869static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200870{
871 ".comment*",
872 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930873 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800874 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000875 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200876 ".mdebug*", /* alpha, score, mips etc. */
877 ".pdr", /* alpha, score, mips etc. */
878 ".stab*",
879 ".note*",
880 ".got*",
881 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400882 ".xt.prop", /* xtensa */
883 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030884 ".arcextmap*", /* arc */
885 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030886 ".cmem*", /* EZchip */
887 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100888 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600889 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200890 NULL
891};
Sam Ravnborg10668222008-01-13 22:21:31 +0100892
Sam Ravnborge241a632008-01-28 20:13:13 +0100893/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400894 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100895 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400896 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100897 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400898static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900899 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100900{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400901 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100902
Anders Kaseorgb614a692009-04-23 16:49:33 -0400903 if (sechdr->sh_type == SHT_PROGBITS &&
904 !(sechdr->sh_flags & SHF_ALLOC) &&
905 !match(sec, section_white_list)) {
906 warn("%s (%s): unexpected non-allocatable section.\n"
907 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
908 "Note that for example <linux/init.h> contains\n"
909 "section definitions for use in .S files.\n\n",
910 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100911 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100912}
913
914
915
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100916#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930917 ".init.setup", ".init.rodata", ".meminit.rodata", \
918 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100919#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930920 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100921
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100922#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930923 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100924#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930925 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100926
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200927#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930928 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
929 ".pci_fixup_enable", ".pci_fixup_resume", \
930 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200931
Paul Gortmakere24f6622013-06-19 19:30:48 -0400932#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
933#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100934
935#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
936#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100937
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930938#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930939#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Thomas Gleixner65538962020-03-09 22:47:17 +0100940 ".kprobes.text", ".cpuidle.text", ".noinstr.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930941#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400942 ".fixup", ".entry.text", ".exception.text", ".text.*", \
Christophe Leroy1e688dd22021-04-13 16:38:10 +0000943 ".coldtext", ".softirqentry.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100944
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000945#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000946#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100947
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000948#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000949#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100950
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930951#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
952 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
953
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100954/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930955static const char *const init_data_sections[] =
956 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100957
958/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930959static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100960
961/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930962static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100963 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100964
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930965/* all text sections */
966static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
967
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100968/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930969static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100970
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100971
972/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100973#define DEFAULT_SYMBOL_WHITE_LIST \
974 "*driver", \
975 "*_template", /* scsi uses *_template a lot */ \
976 "*_timer", /* arm uses ops structures named _timer a lot */ \
977 "*_sht", /* scsi also used *_sht to some extent */ \
978 "*_ops", \
979 "*_probe", \
980 "*_probe_one", \
981 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100982
Mathias Krause7a3ee752014-08-27 20:28:53 +0930983static const char *const head_sections[] = { ".head.text*", NULL };
984static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100985 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930986static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100987
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100988enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100989 TEXT_TO_ANY_INIT,
990 DATA_TO_ANY_INIT,
991 TEXT_TO_ANY_EXIT,
992 DATA_TO_ANY_EXIT,
993 XXXINIT_TO_SOME_INIT,
994 XXXEXIT_TO_SOME_EXIT,
995 ANY_INIT_TO_ANY_EXIT,
996 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100997 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930998 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100999};
1000
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301001/**
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +05301002 * Describe how to match sections on different criteria:
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301003 *
1004 * @fromsec: Array of sections to be matched.
1005 *
1006 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
1007 * this array is forbidden (black-list). Can be empty.
1008 *
1009 * @good_tosec: Relocations applied to a section in @fromsec must be
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +05301010 * targeting sections in this array (white-list). Can be empty.
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301011 *
1012 * @mismatch: Type of mismatch.
1013 *
1014 * @symbol_white_list: Do not match a relocation to a symbol in this list
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +05301015 * even if it is targeting a section in @bad_to_sec.
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301016 *
1017 * @handler: Specific handler to call when a match is found. If NULL,
1018 * default_mismatch_handler() will be called.
1019 *
1020 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001021struct sectioncheck {
1022 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301023 const char *bad_tosec[20];
1024 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001025 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001026 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301027 void (*handler)(const char *modname, struct elf_info *elf,
1028 const struct sectioncheck* const mismatch,
1029 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1030
Sam Ravnborg10668222008-01-13 22:21:31 +01001031};
1032
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301033static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1034 const struct sectioncheck* const mismatch,
1035 Elf_Rela *r, Elf_Sym *sym,
1036 const char *fromsec);
1037
Mathias Krause7a3ee752014-08-27 20:28:53 +09301038static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001039/* Do not reference init/exit code/data from
1040 * normal code and data
1041 */
1042{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001043 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301044 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001045 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001046 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001047},
1048{
1049 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301050 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001051 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001052 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001053},
1054{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001055 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301056 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001057 .mismatch = DATA_TO_ANY_INIT,
1058 .symbol_white_list = {
1059 "*_template", "*_timer", "*_sht", "*_ops",
1060 "*_probe", "*_probe_one", "*_console", NULL
1061 },
1062},
1063{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001064 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301065 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001066 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001067 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001068},
1069{
1070 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301071 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001072 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001073 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001074},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001075/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001076{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001077 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301078 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001079 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001080 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001081},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001082/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001083{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001084 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301085 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001086 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001087 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001088},
1089/* Do not use exit code/data from init code */
1090{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001091 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301092 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001093 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001094 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001095},
1096/* Do not use init code/data from exit code */
1097{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001098 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301099 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001100 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001101 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001102},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001103{
1104 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301105 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001106 .mismatch = ANY_INIT_TO_ANY_EXIT,
1107 .symbol_white_list = { NULL },
1108},
Sam Ravnborg10668222008-01-13 22:21:31 +01001109/* Do not export init/exit functions or data */
1110{
1111 .fromsec = { "__ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301112 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001113 .mismatch = EXPORT_TO_INIT_EXIT,
1114 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301115},
1116{
1117 .fromsec = { "__ex_table", NULL },
1118 /* If you're adding any new black-listed sections in here, consider
1119 * adding a special 'printer' for them in scripts/check_extable.
1120 */
1121 .bad_tosec = { ".altinstr_replacement", NULL },
1122 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1123 .mismatch = EXTABLE_TO_NON_TEXT,
1124 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001125}
1126};
1127
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001128static const struct sectioncheck *section_mismatch(
1129 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001130{
1131 int i;
1132 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1133 const struct sectioncheck *check = &sectioncheck[0];
1134
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301135 /*
1136 * The target section could be the SHT_NUL section when we're
1137 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001138 * doesn't make much sense and causes build failures on parisc
1139 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301140 */
1141 if (*tosec == '\0')
1142 return NULL;
1143
Sam Ravnborg10668222008-01-13 22:21:31 +01001144 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301145 if (match(fromsec, check->fromsec)) {
1146 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1147 return check;
1148 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1149 return check;
1150 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001151 check++;
1152 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001153 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001154}
1155
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001156/**
1157 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001158 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001159 * Pattern 1:
1160 * If a module parameter is declared __initdata and permissions=0
1161 * then this is legal despite the warning generated.
1162 * We cannot see value of permissions here, so just ignore
1163 * this pattern.
1164 * The pattern is identified by:
1165 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001166 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001167 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001168 *
Rusty Russell6a841522010-08-11 23:04:16 -06001169 * Pattern 1a:
1170 * module_param_call() ops can refer to __init set function if permissions=0
1171 * The pattern is identified by:
1172 * tosec = .init.text
1173 * fromsec = .data*
1174 * atsym = __param_ops_*
1175 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001176 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001177 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001178 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001179 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001180 * tosec = init or exit section
1181 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001182 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1183 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001184 *
1185 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001186 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001187 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001188 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001189 * Some symbols belong to init section but still it is ok to reference
1190 * these from non-init sections as these symbols don't have any memory
1191 * allocated for them and symbol address and value are same. So even
1192 * if init section is freed, its ok to reference those symbols.
1193 * For ex. symbols marking the init section boundaries.
1194 * This pattern is identified by
1195 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001196 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301197 * Pattern 5:
1198 * GCC may optimize static inlines when fed constant arg(s) resulting
1199 * in functions like cpumask_empty() -- generating an associated symbol
1200 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1201 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1202 * meaningless section warning. May need to add isra symbols too...
1203 * This pattern is identified by
1204 * tosec = init section
1205 * fromsec = text section
1206 * refsymname = *.constprop.*
1207 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001208 * Pattern 6:
1209 * Hide section mismatch warnings for ELF local symbols. The goal
1210 * is to eliminate false positive modpost warnings caused by
1211 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1212 * Autogenerated symbol names bypass modpost's "Pattern 2"
1213 * whitelisting, which relies on pattern-matching against symbol
1214 * names to work. (One situation where gcc can autogenerate ELF
1215 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001216 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001217static int secref_whitelist(const struct sectioncheck *mismatch,
1218 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001219 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001220{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001221 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001222 if (match(tosec, init_data_sections) &&
1223 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001224 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001225 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001226
Rusty Russell6a841522010-08-11 23:04:16 -06001227 /* Check for pattern 1a */
1228 if (strcmp(tosec, ".init.text") == 0 &&
1229 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001230 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001231 return 0;
1232
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001233 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001234 if (match(tosec, init_exit_sections) &&
1235 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001236 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001237 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001238
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001239 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001240 if (match(fromsec, head_sections) &&
1241 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001242 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001243
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001244 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001245 if (match(tosym, linker_symbols))
1246 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001247
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301248 /* Check for pattern 5 */
1249 if (match(fromsec, text_sections) &&
1250 match(tosec, init_sections) &&
1251 match(fromsym, optim_symbols))
1252 return 0;
1253
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001254 /* Check for pattern 6 */
1255 if (strstarts(fromsym, ".L"))
1256 return 0;
1257
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001258 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001259}
1260
Sami Tolvanen5818c682018-10-23 15:15:35 -07001261static inline int is_arm_mapping_symbol(const char *str)
1262{
Masahiro Yamada4adc7d72022-05-24 01:46:22 +09001263 return str[0] == '$' &&
1264 (str[1] == 'a' || str[1] == 'd' || str[1] == 't' || str[1] == 'x')
Sami Tolvanen5818c682018-10-23 15:15:35 -07001265 && (str[2] == '\0' || str[2] == '.');
1266}
1267
1268/*
1269 * If there's no name there, ignore it; likewise, ignore it if it's
1270 * one of the magic symbols emitted used by current ARM tools.
1271 *
1272 * Otherwise if find_symbols_between() returns those symbols, they'll
1273 * fail the whitelist tests and cause lots of false alarms ... fixable
1274 * only by merging __exit and __init sections into __text, bloating
1275 * the kernel (which is especially evil on embedded platforms).
1276 */
1277static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1278{
1279 const char *name = elf->strtab + sym->st_name;
1280
1281 if (!name || !strlen(name))
1282 return 0;
1283 return !is_arm_mapping_symbol(name);
1284}
1285
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001286/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001287 * Find symbol based on relocation record info.
1288 * In some cases the symbol supplied is a valid symbol so
1289 * return refsym. If st_name != 0 we assume this is a valid symbol.
1290 * In other cases the symbol needs to be looked up in the symbol table
1291 * based on section and address.
1292 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001293static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001294 Elf_Sym *relsym)
1295{
1296 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001297 Elf_Sym *near = NULL;
1298 Elf64_Sword distance = 20;
1299 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001300 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001301
1302 if (relsym->st_name != 0)
1303 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001304
1305 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001306 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001307 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001308 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001309 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1310 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001311 if (!is_valid_name(elf, sym))
1312 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001313 if (sym->st_value == addr)
1314 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001315 /* Find a symbol nearby - addr are maybe negative */
1316 d = sym->st_value - addr;
1317 if (d < 0)
1318 d = addr - sym->st_value;
1319 if (d < distance) {
1320 distance = d;
1321 near = sym;
1322 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001323 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001324 /* We need a close match */
1325 if (distance < 20)
1326 return near;
1327 else
1328 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001329}
1330
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001331/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001332 * Find symbols before or equal addr and after addr - in the section sec.
1333 * If we find two symbols with equal offset prefer one with a valid name.
1334 * The ELF format may have a better way to detect what type of symbol
1335 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001336 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001337static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1338 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001339{
1340 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001341 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001342 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001343
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001344 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1345 const char *symsec;
1346
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001347 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001348 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001349 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001350 if (strcmp(symsec, sec) != 0)
1351 continue;
David Brownellda68d612007-02-20 13:58:16 -08001352 if (!is_valid_name(elf, sym))
1353 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001354 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001355 if ((addr - sym->st_value) < distance) {
1356 distance = addr - sym->st_value;
1357 near = sym;
1358 } else if ((addr - sym->st_value) == distance) {
1359 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001360 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001361 }
1362 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001363 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001364}
1365
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001366/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001367 * Convert a section name to the function/data attribute
1368 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001369 * .memexitconst => __memconst
1370 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001371 *
1372 * The memory of returned value has been allocated on a heap. The user of this
1373 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001374*/
1375static char *sec2annotation(const char *s)
1376{
1377 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001378 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001379 char *r = p;
1380
1381 *p++ = '_';
1382 *p++ = '_';
1383 if (*s == '.')
1384 s++;
1385 while (*s && *s != '.')
1386 *p++ = *s++;
1387 *p = '\0';
1388 if (*s == '.')
1389 s++;
1390 if (strstr(s, "rodata") != NULL)
1391 strcat(p, "const ");
1392 else if (strstr(s, "data") != NULL)
1393 strcat(p, "data ");
1394 else
1395 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001396 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001397 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001398 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001399 }
1400}
1401
1402static int is_function(Elf_Sym *sym)
1403{
1404 if (sym)
1405 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1406 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001407 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001408}
1409
Randy Dunlap00759c02011-03-15 14:13:47 -07001410static void print_section_list(const char * const list[20])
1411{
1412 const char *const *s = list;
1413
1414 while (*s) {
1415 fprintf(stderr, "%s", *s);
1416 s++;
1417 if (*s)
1418 fprintf(stderr, ", ");
1419 }
1420 fprintf(stderr, "\n");
1421}
1422
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301423static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1424{
1425 switch (is_func) {
1426 case 0: *name = "variable"; *name_p = ""; break;
1427 case 1: *name = "function"; *name_p = "()"; break;
1428 default: *name = "(unknown reference)"; *name_p = ""; break;
1429 }
1430}
1431
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001432/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001433 * Print a warning about a section mismatch.
1434 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001435 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001436 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001437static void report_sec_mismatch(const char *modname,
1438 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001439 const char *fromsec,
1440 unsigned long long fromaddr,
1441 const char *fromsym,
1442 int from_is_func,
1443 const char *tosec, const char *tosym,
1444 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001445{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001446 const char *from, *from_p;
1447 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001448 char *prl_from;
1449 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001450
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001451 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001452
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301453 get_pretty_name(from_is_func, &from, &from_p);
1454 get_pretty_name(to_is_func, &to, &to_p);
1455
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001456 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1457 "to the %s %s:%s%s\n",
1458 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1459 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001460
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001461 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001462 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001463 prl_from = sec2annotation(fromsec);
1464 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001465 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001466 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001467 "the %s %s%s%s.\n"
1468 "This is often because %s lacks a %s\n"
1469 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001470 prl_from, fromsym,
1471 to, prl_to, tosym, to_p,
1472 fromsym, prl_to, tosym);
1473 free(prl_from);
1474 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001475 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001476 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001477 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001478 fprintf(stderr,
1479 "The variable %s references\n"
1480 "the %s %s%s%s\n"
1481 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001482 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001483 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001484 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001485 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001486 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001487 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001488 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001489 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001490 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001491 fprintf(stderr,
1492 "The function %s() references a %s in an exit section.\n"
1493 "Often the %s %s%s has valid usage outside the exit section\n"
1494 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001495 fromsym, to, to, tosym, to_p, prl_to, tosym);
1496 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001497 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001498 case DATA_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 variable %s references\n"
1502 "the %s %s%s%s\n"
1503 "If the reference is valid then annotate the\n"
1504 "variable with __exit* (see linux/init.h) or "
1505 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001506 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001507 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001508 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001509 break;
1510 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001511 case XXXINIT_TO_SOME_INIT:
1512 case XXXEXIT_TO_SOME_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001513 prl_from = sec2annotation(fromsec);
1514 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001515 fprintf(stderr,
1516 "The %s %s%s%s references\n"
1517 "a %s %s%s%s.\n"
1518 "If %s is only used by %s then\n"
1519 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001520 from, prl_from, fromsym, from_p,
1521 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001522 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001523 free(prl_from);
1524 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001525 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001526 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001527 prl_from = sec2annotation(fromsec);
1528 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001529 fprintf(stderr,
1530 "The %s %s%s%s references\n"
1531 "a %s %s%s%s.\n"
1532 "This is often seen when error handling "
1533 "in the init function\n"
1534 "uses functionality in the exit path.\n"
1535 "The fix is often to remove the %sannotation of\n"
1536 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001537 from, prl_from, fromsym, from_p,
1538 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001539 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001540 free(prl_from);
1541 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001542 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001543 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001544 prl_from = sec2annotation(fromsec);
1545 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001546 fprintf(stderr,
1547 "The %s %s%s%s references\n"
1548 "a %s %s%s%s.\n"
1549 "This is often seen when error handling "
1550 "in the exit function\n"
1551 "uses functionality in the init path.\n"
1552 "The fix is often to remove the %sannotation of\n"
1553 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001554 from, prl_from, fromsym, from_p,
1555 to, prl_to, tosym, to_p,
1556 prl_to, tosym, to_p);
1557 free(prl_from);
1558 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001559 break;
1560 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001561 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001562 fprintf(stderr,
1563 "The symbol %s is exported and annotated %s\n"
1564 "Fix this by removing the %sannotation of %s "
1565 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001566 tosym, prl_to, prl_to, tosym);
1567 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001568 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301569 case EXTABLE_TO_NON_TEXT:
1570 fatal("There's a special handler for this mismatch type, "
1571 "we should never get here.");
1572 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001573 }
1574 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001575}
1576
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301577static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1578 const struct sectioncheck* const mismatch,
1579 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1580{
1581 const char *tosec;
1582 Elf_Sym *to;
1583 Elf_Sym *from;
1584 const char *tosym;
1585 const char *fromsym;
1586
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301587 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1588 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301589
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001590 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301591 return;
1592
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301593 tosec = sec_name(elf, get_secindex(elf, sym));
1594 to = find_elf_symbol(elf, r->r_addend, sym);
1595 tosym = sym_name(elf, to);
1596
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301597 /* check whitelist - we may ignore it */
1598 if (secref_whitelist(mismatch,
1599 fromsec, fromsym, tosec, tosym)) {
1600 report_sec_mismatch(modname, mismatch,
1601 fromsec, r->r_offset, fromsym,
1602 is_function(from), tosec, tosym,
1603 is_function(to));
1604 }
1605}
1606
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301607static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1608{
1609 if (section_index > elf->num_sections)
1610 fatal("section_index is outside elf->num_sections!\n");
1611
1612 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1613}
1614
1615/*
1616 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1617 * to know the sizeof(struct exception_table_entry) for the target architecture.
1618 */
1619static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301620static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301621{
1622 /*
1623 * If we're currently checking the second relocation within __ex_table,
1624 * that relocation offset tells us the offsetof(struct
1625 * exception_table_entry, fixup) which is equal to sizeof(struct
1626 * exception_table_entry) divided by two. We use that to our advantage
1627 * since there's no portable way to get that size as every architecture
1628 * seems to go with different sized types. Not pretty but better than
1629 * hard-coding the size for every architecture..
1630 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301631 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301632 extable_entry_size = r->r_offset * 2;
1633}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301634
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301635static inline bool is_extable_fault_address(Elf_Rela *r)
1636{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301637 /*
1638 * extable_entry_size is only discovered after we've handled the
1639 * _second_ relocation in __ex_table, so only abort when we're not
1640 * handling the first reloc and extable_entry_size is zero.
1641 */
1642 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301643 fatal("extable_entry size hasn't been discovered!\n");
1644
1645 return ((r->r_offset == 0) ||
1646 (r->r_offset % extable_entry_size == 0));
1647}
1648
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301649#define is_second_extable_reloc(Start, Cur, Sec) \
1650 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1651
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301652static void report_extable_warnings(const char* modname, struct elf_info* elf,
1653 const struct sectioncheck* const mismatch,
1654 Elf_Rela* r, Elf_Sym* sym,
1655 const char* fromsec, const char* tosec)
1656{
1657 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1658 const char* fromsym_name = sym_name(elf, fromsym);
1659 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1660 const char* tosym_name = sym_name(elf, tosym);
1661 const char* from_pretty_name;
1662 const char* from_pretty_name_p;
1663 const char* to_pretty_name;
1664 const char* to_pretty_name_p;
1665
1666 get_pretty_name(is_function(fromsym),
1667 &from_pretty_name, &from_pretty_name_p);
1668 get_pretty_name(is_function(tosym),
1669 &to_pretty_name, &to_pretty_name_p);
1670
1671 warn("%s(%s+0x%lx): Section mismatch in reference"
1672 " from the %s %s%s to the %s %s:%s%s\n",
1673 modname, fromsec, (long)r->r_offset, from_pretty_name,
1674 fromsym_name, from_pretty_name_p,
1675 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1676
1677 if (!match(tosec, mismatch->bad_tosec) &&
1678 is_executable_section(elf, get_secindex(elf, sym)))
1679 fprintf(stderr,
1680 "The relocation at %s+0x%lx references\n"
1681 "section \"%s\" which is not in the list of\n"
1682 "authorized sections. If you're adding a new section\n"
1683 "and/or if this reference is valid, add \"%s\" to the\n"
1684 "list of authorized sections to jump to on fault.\n"
1685 "This can be achieved by adding \"%s\" to \n"
1686 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1687 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1688}
1689
1690static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1691 const struct sectioncheck* const mismatch,
1692 Elf_Rela* r, Elf_Sym* sym,
1693 const char *fromsec)
1694{
1695 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1696
1697 sec_mismatch_count++;
1698
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001699 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301700
1701 if (match(tosec, mismatch->bad_tosec))
1702 fatal("The relocation at %s+0x%lx references\n"
1703 "section \"%s\" which is black-listed.\n"
1704 "Something is seriously wrong and should be fixed.\n"
1705 "You might get more information about where this is\n"
1706 "coming from by using scripts/check_extable.sh %s\n",
1707 fromsec, (long)r->r_offset, tosec, modname);
1708 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1709 if (is_extable_fault_address(r))
1710 fatal("The relocation at %s+0x%lx references\n"
1711 "section \"%s\" which is not executable, IOW\n"
1712 "it is not possible for the kernel to fault\n"
1713 "at that address. Something is seriously wrong\n"
1714 "and should be fixed.\n",
1715 fromsec, (long)r->r_offset, tosec);
1716 else
1717 fatal("The relocation at %s+0x%lx references\n"
1718 "section \"%s\" which is not executable, IOW\n"
1719 "the kernel will fault if it ever tries to\n"
1720 "jump to it. Something is seriously wrong\n"
1721 "and should be fixed.\n",
1722 fromsec, (long)r->r_offset, tosec);
1723 }
1724}
1725
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001726static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001727 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001728{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001729 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301730 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001731
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001732 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301733 if (mismatch->handler)
1734 mismatch->handler(modname, elf, mismatch,
1735 r, sym, fromsec);
1736 else
1737 default_mismatch_handler(modname, elf, mismatch,
1738 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001739 }
1740}
1741
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001742static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001743 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001744{
Masahiro Yamadad2e4d052020-05-25 14:47:04 +09001745 return sym_get_data_by_offset(elf, sechdr->sh_info, r->r_offset);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001746}
1747
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001748static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001749{
1750 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001751 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001752
1753 switch (r_typ) {
1754 case R_386_32:
1755 r->r_addend = TO_NATIVE(*location);
1756 break;
1757 case R_386_PC32:
1758 r->r_addend = TO_NATIVE(*location) + 4;
1759 /* For CONFIG_RELOCATABLE=y */
1760 if (elf->hdr->e_type == ET_EXEC)
1761 r->r_addend += r->r_offset;
1762 break;
1763 }
1764 return 0;
1765}
1766
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001767#ifndef R_ARM_CALL
1768#define R_ARM_CALL 28
1769#endif
1770#ifndef R_ARM_JUMP24
1771#define R_ARM_JUMP24 29
1772#endif
1773
David A. Longc9698e52014-02-14 22:41:18 +01001774#ifndef R_ARM_THM_CALL
1775#define R_ARM_THM_CALL 10
1776#endif
1777#ifndef R_ARM_THM_JUMP24
1778#define R_ARM_THM_JUMP24 30
1779#endif
1780#ifndef R_ARM_THM_JUMP19
1781#define R_ARM_THM_JUMP19 51
1782#endif
1783
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001784static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001785{
1786 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1787
1788 switch (r_typ) {
1789 case R_ARM_ABS32:
1790 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001791 r->r_addend = (int)(long)
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001792 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001793 break;
1794 case R_ARM_PC24:
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001795 case R_ARM_CALL:
1796 case R_ARM_JUMP24:
David A. Longc9698e52014-02-14 22:41:18 +01001797 case R_ARM_THM_CALL:
1798 case R_ARM_THM_JUMP24:
1799 case R_ARM_THM_JUMP19:
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001800 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001801 r->r_addend = (int)(long)(elf->hdr +
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001802 sechdr->sh_offset +
1803 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001804 break;
1805 default:
1806 return 1;
1807 }
1808 return 0;
1809}
1810
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001811static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001812{
1813 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001814 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001815 unsigned int inst;
1816
1817 if (r_typ == R_MIPS_HI16)
1818 return 1; /* skip this */
1819 inst = TO_NATIVE(*location);
1820 switch (r_typ) {
1821 case R_MIPS_LO16:
1822 r->r_addend = inst & 0xffff;
1823 break;
1824 case R_MIPS_26:
1825 r->r_addend = (inst & 0x03ffffff) << 2;
1826 break;
1827 case R_MIPS_32:
1828 r->r_addend = inst;
1829 break;
1830 }
1831 return 0;
1832}
1833
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001834static void section_rela(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001835 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001836{
1837 Elf_Sym *sym;
1838 Elf_Rela *rela;
1839 Elf_Rela r;
1840 unsigned int r_sym;
1841 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001842
Sam Ravnborgff13f922008-01-23 19:54:27 +01001843 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001844 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1845
Sam Ravnborgff13f922008-01-23 19:54:27 +01001846 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001847 fromsec += strlen(".rela");
1848 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001849 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001850 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001851
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001852 for (rela = start; rela < stop; rela++) {
1853 r.r_offset = TO_NATIVE(rela->r_offset);
1854#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001855 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001856 unsigned int r_typ;
1857 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1858 r_sym = TO_NATIVE(r_sym);
1859 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1860 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1861 } else {
1862 r.r_info = TO_NATIVE(rela->r_info);
1863 r_sym = ELF_R_SYM(r.r_info);
1864 }
1865#else
1866 r.r_info = TO_NATIVE(rela->r_info);
1867 r_sym = ELF_R_SYM(r.r_info);
1868#endif
1869 r.r_addend = TO_NATIVE(rela->r_addend);
1870 sym = elf->symtab_start + r_sym;
1871 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001872 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001873 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301874 if (is_second_extable_reloc(start, rela, fromsec))
1875 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001876 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001877 }
1878}
1879
1880static void section_rel(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001881 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001882{
1883 Elf_Sym *sym;
1884 Elf_Rel *rel;
1885 Elf_Rela r;
1886 unsigned int r_sym;
1887 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001888
Sam Ravnborgff13f922008-01-23 19:54:27 +01001889 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001890 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1891
Sam Ravnborgff13f922008-01-23 19:54:27 +01001892 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001893 fromsec += strlen(".rel");
1894 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001895 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001896 return;
1897
1898 for (rel = start; rel < stop; rel++) {
1899 r.r_offset = TO_NATIVE(rel->r_offset);
1900#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001901 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001902 unsigned int r_typ;
1903 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1904 r_sym = TO_NATIVE(r_sym);
1905 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1906 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1907 } else {
1908 r.r_info = TO_NATIVE(rel->r_info);
1909 r_sym = ELF_R_SYM(r.r_info);
1910 }
1911#else
1912 r.r_info = TO_NATIVE(rel->r_info);
1913 r_sym = ELF_R_SYM(r.r_info);
1914#endif
1915 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001916 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001917 case EM_386:
1918 if (addend_386_rel(elf, sechdr, &r))
1919 continue;
1920 break;
1921 case EM_ARM:
1922 if (addend_arm_rel(elf, sechdr, &r))
1923 continue;
1924 break;
1925 case EM_MIPS:
1926 if (addend_mips_rel(elf, sechdr, &r))
1927 continue;
1928 break;
1929 }
1930 sym = elf->symtab_start + r_sym;
1931 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001932 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001933 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301934 if (is_second_extable_reloc(start, rel, fromsec))
1935 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001936 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001937 }
1938}
1939
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001940/**
1941 * A module includes a number of sections that are discarded
1942 * either when loaded or when used as built-in.
1943 * For loaded modules all functions marked __init and all data
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001944 * marked __initdata will be discarded when the module has been initialized.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001945 * Likewise for modules used built-in the sections marked __exit
1946 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001947 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001948 * The check_sec_ref() function traverses all relocation records
1949 * to find all references to a section that reference a section that will
1950 * be discarded and warns about it.
1951 **/
1952static void check_sec_ref(struct module *mod, const char *modname,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001953 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001954{
1955 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001956 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001957
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001958 /* Walk through all sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001959 for (i = 0; i < elf->num_sections; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001960 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001961 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001962 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001963 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001964 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001965 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001966 }
1967}
1968
Andi Kleen7d02b492014-02-08 09:01:12 +01001969static char *remove_dot(char *s)
1970{
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301971 size_t n = strcspn(s, ".");
Andi Kleen7d02b492014-02-08 09:01:12 +01001972
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301973 if (n && s[n]) {
1974 size_t m = strspn(s + n + 1, "0123456789");
Alexander Lobakina53131a2022-05-24 17:27:18 +02001975 if (m && (s[n + m + 1] == '.' || s[n + m + 1] == 0))
Andi Kleen7d02b492014-02-08 09:01:12 +01001976 s[n] = 0;
Sami Tolvanen7ac204b2020-12-11 10:46:27 -08001977
1978 /* strip trailing .lto */
1979 if (strends(s, ".lto"))
1980 s[strlen(s) - 4] = '\0';
Andi Kleen7d02b492014-02-08 09:01:12 +01001981 }
1982 return s;
1983}
1984
Masahiro Yamada8b185742018-05-09 18:50:40 +09001985static void read_symbols(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986{
1987 const char *symname;
1988 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001989 char *license;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01001990 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 struct module *mod;
1992 struct elf_info info = { };
1993 Elf_Sym *sym;
1994
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01001995 if (!parse_elf(&info, modname))
1996 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09001998 {
1999 char *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002001 /* strip trailing .o */
2002 tmp = NOFAIL(strdup(modname));
2003 tmp[strlen(tmp) - 2] = '\0';
Sami Tolvanen7ac204b2020-12-11 10:46:27 -08002004 /* strip trailing .lto */
2005 if (strends(tmp, ".lto"))
2006 tmp[strlen(tmp) - 4] = '\0';
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002007 mod = new_module(tmp);
2008 free(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 }
2010
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002011 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002012 license = get_modinfo(&info, "license");
2013 if (!license)
Masahiro Yamada1d6cd3922020-12-01 19:34:16 +09002014 error("missing MODULE_LICENSE() in %s\n", modname);
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002015 while (license) {
2016 if (license_is_gpl_compatible(license))
2017 mod->gpl_compatible = 1;
2018 else {
2019 mod->gpl_compatible = 0;
2020 break;
2021 }
2022 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002023 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002024
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002025 namespace = get_modinfo(&info, "import_ns");
2026 while (namespace) {
2027 add_namespace(&mod->imported_namespaces, namespace);
2028 namespace = get_next_modinfo(&info, "import_ns",
2029 namespace);
2030 }
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002031 }
2032
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002034 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002036 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 handle_moddevtable(mod, &info, sym, symname);
2038 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002039
Matthias Maennich69923202019-10-18 10:31:42 +01002040 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2041 symname = remove_dot(info.strtab + sym->st_name);
2042
Masahiro Yamada17436942019-11-15 02:42:24 +09002043 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002044 if (strstarts(symname, "__kstrtabns_"))
2045 sym_update_namespace(symname + strlen("__kstrtabns_"),
2046 namespace_from_kstrtabns(&info,
2047 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002048
2049 if (strstarts(symname, "__crc_"))
2050 handle_modversion(mod, &info, sym,
2051 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002052 }
2053
Denis Efremov15bfc232019-08-01 09:06:57 +03002054 // check for static EXPORT_SYMBOL_* functions && global vars
2055 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2056 unsigned char bind = ELF_ST_BIND(sym->st_info);
2057
2058 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2059 struct symbol *s =
2060 find_symbol(remove_dot(info.strtab +
2061 sym->st_name));
2062
2063 if (s)
2064 s->is_static = 0;
2065 }
2066 }
2067
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002068 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002070 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002071 version = get_modinfo(&info, "version");
2072 if (version || all_versions)
Masahiro Yamadae54dd932021-08-28 18:50:59 +09002073 get_src_version(mod->name, mod->srcversion,
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002074 sizeof(mod->srcversion) - 1);
2075 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076
2077 parse_elf_finish(&info);
2078
Rusty Russell8c8ef422009-03-31 13:05:34 -06002079 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 * never passed as an argument to an exported function, so
2081 * the automatic versioning doesn't pick it up, but it's really
2082 * important anyhow */
2083 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06002084 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085}
2086
Rusty Russell712f9b42013-04-04 17:37:38 +10302087static void read_symbols_from_files(const char *filename)
2088{
2089 FILE *in = stdin;
2090 char fname[PATH_MAX];
2091
2092 if (strcmp(filename, "-") != 0) {
2093 in = fopen(filename, "r");
2094 if (!in)
2095 fatal("Can't open filenames file %s: %m", filename);
2096 }
2097
2098 while (fgets(fname, PATH_MAX, in) != NULL) {
2099 if (strends(fname, "\n"))
2100 fname[strlen(fname)-1] = '\0';
2101 read_symbols(fname);
2102 }
2103
2104 if (in != stdin)
2105 fclose(in);
2106}
2107
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108#define SZ 500
2109
2110/* We first write the generated file into memory using the
2111 * following helper, then compare to the file on disk and
2112 * only update the later if anything changed */
2113
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002114void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
2115 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116{
2117 char tmp[SZ];
2118 int len;
2119 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002120
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 va_start(ap, fmt);
2122 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002123 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 va_end(ap);
2125}
2126
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002127void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128{
2129 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002130 buf->size += len + SZ;
Randy Dunlap1f3aa902018-08-15 12:30:38 -07002131 buf->p = NOFAIL(realloc(buf->p, buf->size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 }
2133 strncpy(buf->p + buf->pos, s, len);
2134 buf->pos += len;
2135}
2136
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002137static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
2138{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002139 switch (exp) {
2140 case export_gpl:
Masahiro Yamadad6d692f2020-12-01 19:34:17 +09002141 error("GPL-incompatible module %s.ko uses GPL-only symbol '%s'\n",
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002142 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002143 break;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002144 case export_plain:
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002145 case export_unknown:
2146 /* ignore */
2147 break;
2148 }
2149}
2150
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002151static void check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002152{
2153 struct symbol *s, *exp;
2154
2155 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002156 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002157 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002158 if (!exp || exp->module == mod) {
Masahiro Yamada4475dff2021-03-26 03:54:11 +09002159 if (!s->weak && nr_unresolved++ < MAX_UNRESOLVED_REPORTS)
Jessica Yu93c95e52020-03-06 17:02:05 +01002160 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2161 "\"%s\" [%s.ko] undefined!\n",
2162 s->name, mod->name);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002163 continue;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002164 }
Andrew Morton6449bd62006-06-09 20:45:06 -07002165 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002166 if (basename)
2167 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002168 else
2169 basename = mod->name;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002170
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002171 if (exp->namespace &&
2172 !module_imports_namespace(mod, exp->namespace)) {
Jessica Yu54b77842020-03-06 17:02:06 +01002173 modpost_log(allow_missing_ns_imports ? LOG_WARN : LOG_ERROR,
2174 "module %s uses symbol %s from namespace %s, but does not import it.\n",
2175 basename, exp->name, exp->namespace);
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002176 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002177 }
2178
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002179 if (!mod->gpl_compatible)
2180 check_for_gpl_usage(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002181 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002182}
2183
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002184static void check_modname_len(struct module *mod)
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002185{
2186 const char *mod_name;
2187
2188 mod_name = strrchr(mod->name, '/');
2189 if (mod_name == NULL)
2190 mod_name = mod->name;
2191 else
2192 mod_name++;
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002193 if (strlen(mod_name) >= MODULE_NAME_LEN)
Masahiro Yamadabc72d722020-12-01 19:34:14 +09002194 error("module name is too long [%s.ko]\n", mod->name);
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002195}
2196
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002197/**
2198 * Header for the generated file
2199 **/
2200static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201{
2202 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002203 /*
2204 * Include build-salt.h after module.h in order to
2205 * inherit the definitions.
2206 */
Leon Romanovsky51161bf2020-04-19 18:55:06 +03002207 buf_printf(b, "#define INCLUDE_VERMAGIC\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002208 buf_printf(b, "#include <linux/build-salt.h>\n");
Yonghong Song1fdd7432021-04-01 16:27:23 -07002209 buf_printf(b, "#include <linux/elfnote-lto.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 buf_printf(b, "#include <linux/vermagic.h>\n");
2211 buf_printf(b, "#include <linux/compiler.h>\n");
2212 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002213 buf_printf(b, "BUILD_SALT;\n");
Yonghong Song1fdd7432021-04-01 16:27:23 -07002214 buf_printf(b, "BUILD_LTO_INFO;\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002215 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002217 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302219 buf_printf(b, "__visible struct module __this_module\n");
Joe Perches33def842020-10-21 19:36:07 -07002220 buf_printf(b, "__section(\".gnu.linkonce.this_module\") = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002221 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002223 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 if (mod->has_cleanup)
2225 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002226 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002228 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 buf_printf(b, "};\n");
2230}
2231
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002232static void add_intree_flag(struct buffer *b, int is_intree)
2233{
2234 if (is_intree)
2235 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2236}
2237
Andi Kleencaf75012018-01-25 15:50:28 -08002238/* Cannot check for assembler */
2239static void add_retpoline(struct buffer *b)
2240{
WANG Chaoe4f35892018-12-11 00:37:25 +08002241 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002242 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2243 buf_printf(b, "#endif\n");
2244}
2245
Trevor Keith5c725132009-09-22 16:43:38 -07002246static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002247{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002248 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002249 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2250}
2251
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002252/**
2253 * Record CRCs for unresolved symbols
2254 **/
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002255static void add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256{
2257 struct symbol *s, *exp;
2258
2259 for (s = mod->unres; s; s = s->next) {
2260 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002261 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 s->module = exp->module;
2264 s->crc_valid = exp->crc_valid;
2265 s->crc = exp->crc;
2266 }
2267
2268 if (!modversions)
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002269 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270
2271 buf_printf(b, "\n");
2272 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Joe Perches33def842020-10-21 19:36:07 -07002273 buf_printf(b, "__used __section(\"__versions\") = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274
2275 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002276 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002279 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 s->name, mod->name);
2281 continue;
2282 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302283 if (strlen(s->name) >= MODULE_NAME_LEN) {
Masahiro Yamadabc72d722020-12-01 19:34:14 +09002284 error("too long symbol \"%s\" [%s.ko]\n",
2285 s->name, mod->name);
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302286 break;
2287 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002288 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302289 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290 }
2291
2292 buf_printf(b, "};\n");
2293}
2294
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002295static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296{
2297 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 int first = 1;
2299
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002300 /* Clear ->seen flag of modules that own symbols needed by this. */
2301 for (s = mod->unres; s; s = s->next)
2302 if (s->module)
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002303 s->module->seen = s->module->is_vmlinux;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304
2305 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002306 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002308 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 if (!s->module)
2310 continue;
2311
2312 if (s->module->seen)
2313 continue;
2314
2315 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002316 p = strrchr(s->module->name, '/');
2317 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002318 p++;
2319 else
2320 p = s->module->name;
2321 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 first = 0;
2323 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002324 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325}
2326
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002327static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328{
2329 if (mod->srcversion[0]) {
2330 buf_printf(b, "\n");
2331 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2332 mod->srcversion);
2333 }
2334}
2335
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002336static void write_buf(struct buffer *b, const char *fname)
2337{
2338 FILE *file;
2339
2340 file = fopen(fname, "w");
2341 if (!file) {
2342 perror(fname);
2343 exit(1);
2344 }
2345 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2346 perror(fname);
2347 exit(1);
2348 }
2349 if (fclose(file) != 0) {
2350 perror(fname);
2351 exit(1);
2352 }
2353}
2354
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002355static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356{
2357 char *tmp;
2358 FILE *file;
2359 struct stat st;
2360
2361 file = fopen(fname, "r");
2362 if (!file)
2363 goto write;
2364
2365 if (fstat(fileno(file), &st) < 0)
2366 goto close_write;
2367
2368 if (st.st_size != b->pos)
2369 goto close_write;
2370
2371 tmp = NOFAIL(malloc(b->pos));
2372 if (fread(tmp, 1, b->pos, file) != b->pos)
2373 goto free_write;
2374
2375 if (memcmp(tmp, b->p, b->pos) != 0)
2376 goto free_write;
2377
2378 free(tmp);
2379 fclose(file);
2380 return;
2381
2382 free_write:
2383 free(tmp);
2384 close_write:
2385 fclose(file);
2386 write:
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002387 write_buf(b, fname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388}
2389
Ram Paibd5cbce2006-06-08 22:12:53 -07002390/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002391 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002392 **/
Masahiro Yamada52c34162020-06-01 14:57:05 +09002393static void read_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394{
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002395 char *buf, *pos, *line;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002397 buf = read_text_file(fname);
2398 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 /* No symbol versions, silently ignore */
2400 return;
2401
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002402 pos = buf;
2403
2404 while ((line = get_line(&pos))) {
Jessica Yu51900442020-03-11 18:01:20 +01002405 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406 unsigned int crc;
2407 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002408 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409
2410 if (!(symname = strchr(line, '\t')))
2411 goto fail;
2412 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002413 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414 goto fail;
2415 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002416 if (!(export = strchr(modname, '\t')))
2417 goto fail;
2418 *export++ = '\0';
2419 if (!(namespace = strchr(export, '\t')))
2420 goto fail;
2421 *namespace++ = '\0';
2422
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423 crc = strtoul(line, &d, 16);
2424 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2425 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002426 mod = find_module(modname);
2427 if (!mod) {
Jan Beulich0fa3a882009-03-12 12:28:30 +00002428 mod = new_module(modname);
Masahiro Yamada52c34162020-06-01 14:57:05 +09002429 mod->from_dump = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002431 s = sym_add_exported(symname, mod, export_no(export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002432 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002433 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002434 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 }
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002436 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437 return;
2438fail:
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002439 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 fatal("parse error in symbol dump file\n");
2441}
2442
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002443static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444{
2445 struct buffer buf = { };
2446 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002447 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 int n;
2449
2450 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2451 symbol = symbolhash[n];
2452 while (symbol) {
Masahiro Yamada69bc8d32021-03-26 03:54:09 +09002453 if (!symbol->module->from_dump) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002454 namespace = symbol->namespace;
2455 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2456 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002457 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002458 export_str(symbol->export),
2459 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002460 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 symbol = symbol->next;
2462 }
2463 }
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002464 write_buf(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002465 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466}
2467
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002468static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002469{
2470 struct module *mod;
2471 struct namespace_list *ns;
2472 struct buffer ns_deps_buf = {};
2473
2474 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002475
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002476 if (mod->from_dump || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002477 continue;
2478
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002479 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002480
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002481 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2482 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002483
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002484 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002485 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002486
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002487 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002488 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002489}
2490
Masahiro Yamada79247992020-06-01 14:57:07 +09002491struct dump_list {
2492 struct dump_list *next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002493 const char *file;
2494};
2495
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002496int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497{
2498 struct module *mod;
2499 struct buffer buf = { };
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002500 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302501 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502 int opt;
Denis Efremov15bfc232019-08-01 09:06:57 +03002503 int n;
Masahiro Yamada79247992020-06-01 14:57:07 +09002504 struct dump_list *dump_read_start = NULL;
2505 struct dump_list **dump_read_iter = &dump_read_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002507 while ((opt = getopt(argc, argv, "ei:mnT:o:awENd:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002508 switch (opt) {
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002509 case 'e':
2510 external_module = 1;
Masahiro Yamadae3fb4df2020-06-01 14:57:08 +09002511 break;
2512 case 'i':
Masahiro Yamada79247992020-06-01 14:57:07 +09002513 *dump_read_iter =
2514 NOFAIL(calloc(1, sizeof(**dump_read_iter)));
2515 (*dump_read_iter)->file = optarg;
2516 dump_read_iter = &(*dump_read_iter)->next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002517 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002518 case 'm':
2519 modversions = 1;
2520 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302521 case 'n':
2522 ignore_missing_files = 1;
2523 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002524 case 'o':
2525 dump_write = optarg;
2526 break;
2527 case 'a':
2528 all_versions = 1;
2529 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302530 case 'T':
2531 files_source = optarg;
2532 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002533 case 'w':
2534 warn_unresolved = 1;
2535 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302536 case 'E':
Masahiro Yamadac7299d92020-12-01 19:34:18 +09002537 sec_mismatch_warn_only = false;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302538 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002539 case 'N':
2540 allow_missing_ns_imports = 1;
2541 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002542 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002543 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002544 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002545 default:
2546 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 }
2548 }
2549
Masahiro Yamada79247992020-06-01 14:57:07 +09002550 while (dump_read_start) {
2551 struct dump_list *tmp;
Masahiro Yamada2beee862020-06-01 14:57:04 +09002552
Masahiro Yamada79247992020-06-01 14:57:07 +09002553 read_dump(dump_read_start->file);
2554 tmp = dump_read_start->next;
2555 free(dump_read_start);
2556 dump_read_start = tmp;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002557 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002559 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561
Rusty Russell712f9b42013-04-04 17:37:38 +10302562 if (files_source)
2563 read_symbols_from_files(files_source);
2564
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002565 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302566 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002567
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002568 if (mod->is_vmlinux || mod->from_dump)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002569 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570
2571 buf.pos = 0;
2572
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002573 check_modname_len(mod);
2574 check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002575
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002577 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002578 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002579 add_staging_flag(&buf, mod->name);
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002580 add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002581 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582 add_moddevtable(&buf, mod);
2583 add_srcversion(&buf, mod);
2584
2585 sprintf(fname, "%s.mod.c", mod->name);
2586 write_if_changed(&buf, fname);
2587 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002588
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002589 if (missing_namespace_deps)
2590 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002591
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592 if (dump_write)
2593 write_dump(dump_write);
Masahiro Yamadac7299d92020-12-01 19:34:18 +09002594 if (sec_mismatch_count && !sec_mismatch_warn_only)
2595 error("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002596 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002597 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002598 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002599
Masahiro Yamada47346e92019-09-24 21:07:40 +09002600 for (s = symbolhash[n]; s; s = s->next) {
Denis Efremov15bfc232019-08-01 09:06:57 +03002601 if (s->is_static)
Quentin Perretb9ed8472020-12-01 16:52:22 +00002602 error("\"%s\" [%s] is a static %s\n",
2603 s->name, s->module->name,
2604 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002605 }
2606 }
2607
Masahiro Yamada4475dff2021-03-26 03:54:11 +09002608 if (nr_unresolved > MAX_UNRESOLVED_REPORTS)
2609 warn("suppressed %u unresolved symbol warnings because there were too many)\n",
2610 nr_unresolved - MAX_UNRESOLVED_REPORTS);
2611
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002612 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002614 return error_occurred ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615}