blob: 167700a7b80f0d14600ee756c17ba8533283567c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Postprocess module symbol versions
2 *
3 * Copyright 2003 Kai Germaschewski
4 * Copyright 2002-2004 Rusty Russell, IBM Corporation
Sam Ravnborgdf578e72008-01-11 19:17:15 +01005 * Copyright 2006-2008 Sam Ravnborg
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Based in part on module-init-tools/depmod.c,file2alias
7 *
8 * This software may be used and distributed according to the terms
9 * of the GNU General Public License, incorporated herein by reference.
10 *
11 * Usage: modpost vmlinux module1.o module2.o ...
12 */
13
Mathieu Desnoyersb2e3e652008-02-13 15:03:39 -080014#define _GNU_SOURCE
Masahiro Yamada5370d4a2020-01-05 00:36:51 +090015#include <elf.h>
Mathieu Desnoyersb2e3e652008-02-13 15:03:39 -080016#include <stdio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <ctype.h>
Andrew Morton5003bab2010-08-11 00:42:26 -070018#include <string.h>
Rusty Russell712f9b42013-04-04 17:37:38 +103019#include <limits.h>
Rusty Russelld4ef1c32013-04-04 17:37:32 +103020#include <stdbool.h>
Guenter Roeckeed380f2013-09-23 15:23:54 +093021#include <errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include "modpost.h"
Sam Ravnborgb817f6f2006-06-09 21:53:55 +020023#include "../../include/linux/license.h"
Alan Jenkins9e1b9b82009-11-07 21:03:54 +000024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/* Are we using CONFIG_MODVERSIONS? */
Mathias Krause7a3ee752014-08-27 20:28:53 +093026static int modversions = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070027/* Warn about undefined symbols? (do so if we have vmlinux) */
Mathias Krause7a3ee752014-08-27 20:28:53 +093028static int have_vmlinux = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029/* Is CONFIG_MODULE_SRCVERSION_ALL set? */
30static int all_versions = 0;
Sam Ravnborg040fcc82006-01-28 22:15:55 +010031/* If we are modposting external module set to 1 */
32static int external_module = 0;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -070033/* Only warn about unresolved symbols */
34static int warn_unresolved = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -070035/* How a symbol is exported */
Sam Ravnborg588ccd72008-01-24 21:12:37 +010036static int sec_mismatch_count = 0;
Nicolas Boichat47490ec2015-10-06 09:44:42 +103037static int sec_mismatch_fatal = 0;
Guenter Roeckeed380f2013-09-23 15:23:54 +093038/* ignore missing files */
39static int ignore_missing_files;
Jessica Yu54b77842020-03-06 17:02:06 +010040/* If set to 1, only warn (instead of error) about missing ns imports */
41static int allow_missing_ns_imports;
Sam Ravnborg588ccd72008-01-24 21:12:37 +010042
Sam Ravnborgc96fca22006-07-01 11:44:23 +020043enum export {
44 export_plain, export_unused, export_gpl,
45 export_unused_gpl, export_gpl_future, export_unknown
46};
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +080048/* In kernel, this size is defined in linux/module.h;
49 * here we use Elf_Addr instead of long for covering cross-compile
50 */
51
52#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
53
Jessica Yu93c95e52020-03-06 17:02:05 +010054void __attribute__((format(printf, 2, 3)))
55modpost_log(enum loglevel loglevel, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056{
57 va_list arglist;
58
Jessica Yu93c95e52020-03-06 17:02:05 +010059 switch (loglevel) {
60 case LOG_WARN:
61 fprintf(stderr, "WARNING: ");
62 break;
63 case LOG_ERROR:
64 fprintf(stderr, "ERROR: ");
65 break;
66 case LOG_FATAL:
67 fprintf(stderr, "FATAL: ");
68 break;
69 default: /* invalid loglevel, ignore */
70 break;
71 }
72
73 fprintf(stderr, "modpost: ");
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75 va_start(arglist, fmt);
76 vfprintf(stderr, fmt, arglist);
77 va_end(arglist);
78
Jessica Yu93c95e52020-03-06 17:02:05 +010079 if (loglevel == LOG_FATAL)
80 exit(1);
Matthew Wilcox2a116652006-10-07 05:35:32 -060081}
82
Rusty Russelld4ef1c32013-04-04 17:37:32 +103083static inline bool strends(const char *str, const char *postfix)
84{
85 if (strlen(str) < strlen(postfix))
86 return false;
87
88 return strcmp(str + strlen(str) - strlen(postfix), postfix) == 0;
89}
90
Sam Ravnborg040fcc82006-01-28 22:15:55 +010091static int is_vmlinux(const char *modname)
92{
93 const char *myname;
94
Sam Ravnborgdf578e72008-01-11 19:17:15 +010095 myname = strrchr(modname, '/');
96 if (myname)
Sam Ravnborg040fcc82006-01-28 22:15:55 +010097 myname++;
98 else
99 myname = modname;
100
Sam Ravnborg741f98f2007-07-17 10:54:06 +0200101 return (strcmp(myname, "vmlinux") == 0) ||
102 (strcmp(myname, "vmlinux.o") == 0);
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100103}
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105void *do_nofail(void *ptr, const char *expr)
106{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100107 if (!ptr)
Jessica Yu93c95e52020-03-06 17:02:05 +0100108 fatal("Memory allocation failure: %s.\n", expr);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 return ptr;
111}
112
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900113char *read_text_file(const char *filename)
114{
115 struct stat st;
116 size_t nbytes;
117 int fd;
118 char *buf;
119
120 fd = open(filename, O_RDONLY);
121 if (fd < 0) {
122 perror(filename);
123 exit(1);
124 }
125
126 if (fstat(fd, &st) < 0) {
127 perror(filename);
128 exit(1);
129 }
130
131 buf = NOFAIL(malloc(st.st_size + 1));
132
133 nbytes = st.st_size;
134
135 while (nbytes) {
136 ssize_t bytes_read;
137
138 bytes_read = read(fd, buf, nbytes);
139 if (bytes_read < 0) {
140 perror(filename);
141 exit(1);
142 }
143
144 nbytes -= bytes_read;
145 }
146 buf[st.st_size] = '\0';
147
148 close(fd);
149
150 return buf;
151}
152
153char *get_line(char **stringp)
154{
155 /* do not return the unwanted extra line at EOF */
156 if (*stringp && **stringp == '\0')
157 return NULL;
158
159 return strsep(stringp, "\n");
160}
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162/* A list of all modules we processed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163static struct module *modules;
164
Masahiro Yamada8b185742018-05-09 18:50:40 +0900165static struct module *find_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
167 struct module *mod;
168
169 for (mod = modules; mod; mod = mod->next)
170 if (strcmp(mod->name, modname) == 0)
171 break;
172 return mod;
173}
174
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030175static struct module *new_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176{
177 struct module *mod;
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030178 char *p;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 mod = NOFAIL(malloc(sizeof(*mod)));
181 memset(mod, 0, sizeof(*mod));
182 p = NOFAIL(strdup(modname));
183
184 /* strip trailing .o */
Masahiro Yamada33795762020-06-01 14:57:24 +0900185 if (strends(p, ".o"))
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030186 p[strlen(p) - 2] = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188 /* add to list */
189 mod->name = p;
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900190 mod->is_vmlinux = is_vmlinux(modname);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200191 mod->gpl_compatible = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 mod->next = modules;
193 modules = mod;
194
195 return mod;
196}
197
198/* A hash of all exported symbols,
199 * struct symbol is also used for lists of unresolved symbols */
200
201#define SYMBOL_HASH_SIZE 1024
202
203struct symbol {
204 struct symbol *next;
205 struct module *module;
206 unsigned int crc;
207 int crc_valid;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900208 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 unsigned int weak:1;
Denis Efremov15bfc232019-08-01 09:06:57 +0300210 unsigned int is_static:1; /* 1 if symbol is not global */
Ram Paibd5cbce2006-06-08 22:12:53 -0700211 enum export export; /* Type of export */
Gustavo A. R. Silva859c8172020-05-07 13:56:01 -0500212 char name[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213};
214
215static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
216
217/* This is based on the hash agorithm from gdbm, via tdb */
218static inline unsigned int tdb_hash(const char *name)
219{
220 unsigned value; /* Used to compute the hash value. */
221 unsigned i; /* Used to cycle through random values. */
222
223 /* Set the initial value from the key size. */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100224 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
226
227 return (1103515243 * value + 12345);
228}
229
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100230/**
231 * Allocate a new symbols for use in the hash of exported symbols or
232 * the list of unresolved symbols per module
233 **/
234static struct symbol *alloc_symbol(const char *name, unsigned int weak,
235 struct symbol *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236{
237 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
238
239 memset(s, 0, sizeof(*s));
240 strcpy(s->name, name);
241 s->weak = weak;
242 s->next = next;
Denis Efremov15bfc232019-08-01 09:06:57 +0300243 s->is_static = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 return s;
245}
246
247/* For the hash of exported symbols */
Ram Paibd5cbce2006-06-08 22:12:53 -0700248static struct symbol *new_symbol(const char *name, struct module *module,
249 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250{
251 unsigned int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
253 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900254 symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
255
256 return symbolhash[hash];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257}
258
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100259static struct symbol *find_symbol(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260{
261 struct symbol *s;
262
263 /* For our purposes, .foo matches foo. PPC64 needs this. */
264 if (name[0] == '.')
265 name++;
266
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100267 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 if (strcmp(s->name, name) == 0)
269 return s;
270 }
271 return NULL;
272}
273
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100274static bool contains_namespace(struct namespace_list *list,
275 const char *namespace)
276{
Masahiro Yamada76b54cf2019-10-29 21:38:09 +0900277 for (; list; list = list->next)
278 if (!strcmp(list->namespace, namespace))
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100279 return true;
280
281 return false;
282}
283
284static void add_namespace(struct namespace_list **list, const char *namespace)
285{
286 struct namespace_list *ns_entry;
287
288 if (!contains_namespace(*list, namespace)) {
289 ns_entry = NOFAIL(malloc(sizeof(struct namespace_list) +
290 strlen(namespace) + 1));
291 strcpy(ns_entry->namespace, namespace);
292 ns_entry->next = *list;
293 *list = ns_entry;
294 }
295}
296
297static bool module_imports_namespace(struct module *module,
298 const char *namespace)
299{
300 return contains_namespace(module->imported_namespaces, namespace);
301}
302
Mathias Krause7a3ee752014-08-27 20:28:53 +0930303static const struct {
Ram Paibd5cbce2006-06-08 22:12:53 -0700304 const char *str;
305 enum export export;
306} export_list[] = {
307 { .str = "EXPORT_SYMBOL", .export = export_plain },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200308 { .str = "EXPORT_UNUSED_SYMBOL", .export = export_unused },
Ram Paibd5cbce2006-06-08 22:12:53 -0700309 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200310 { .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
Ram Paibd5cbce2006-06-08 22:12:53 -0700311 { .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
312 { .str = "(unknown)", .export = export_unknown },
313};
314
315
316static const char *export_str(enum export ex)
317{
318 return export_list[ex].str;
319}
320
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100321static enum export export_no(const char *s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700322{
323 int i;
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100324
Sam Ravnborg534b89a2006-07-01 10:10:19 +0200325 if (!s)
326 return export_unknown;
Ram Paibd5cbce2006-06-08 22:12:53 -0700327 for (i = 0; export_list[i].export != export_unknown; i++) {
328 if (strcmp(export_list[i].str, s) == 0)
329 return export_list[i].export;
330 }
331 return export_unknown;
332}
333
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900334static void *sym_get_data_by_offset(const struct elf_info *info,
335 unsigned int secindex, unsigned long offset)
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900336{
Xiao Yang4b8a5cf2020-03-18 18:34:16 +0800337 Elf_Shdr *sechdr = &info->sechdrs[secindex];
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900338
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900339 if (info->hdr->e_type != ET_REL)
340 offset -= sechdr->sh_addr;
341
342 return (void *)info->hdr + sechdr->sh_offset + offset;
343}
344
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900345static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
346{
347 return sym_get_data_by_offset(info, get_secindex(info, sym),
348 sym->st_value);
349}
350
Masahiro Yamada565587d2020-05-25 14:47:05 +0900351static const char *sech_name(const struct elf_info *info, Elf_Shdr *sechdr)
352{
353 return sym_get_data_by_offset(info, info->secindex_strings,
354 sechdr->sh_name);
355}
356
357static const char *sec_name(const struct elf_info *info, int secindex)
358{
359 return sech_name(info, &info->sechdrs[secindex]);
360}
361
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200362#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
363
364static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
365{
366 const char *secname = sec_name(elf, sec);
367
368 if (strstarts(secname, "___ksymtab+"))
369 return export_plain;
370 else if (strstarts(secname, "___ksymtab_unused+"))
371 return export_unused;
372 else if (strstarts(secname, "___ksymtab_gpl+"))
373 return export_gpl;
374 else if (strstarts(secname, "___ksymtab_unused_gpl+"))
375 return export_unused_gpl;
376 else if (strstarts(secname, "___ksymtab_gpl_future+"))
377 return export_gpl_future;
378 else
379 return export_unknown;
380}
381
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200382static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700383{
384 if (sec == elf->export_sec)
385 return export_plain;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200386 else if (sec == elf->export_unused_sec)
387 return export_unused;
Ram Paibd5cbce2006-06-08 22:12:53 -0700388 else if (sec == elf->export_gpl_sec)
389 return export_gpl;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200390 else if (sec == elf->export_unused_gpl_sec)
391 return export_unused_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700392 else if (sec == elf->export_gpl_future_sec)
393 return export_gpl_future;
394 else
395 return export_unknown;
396}
397
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900398static const char *namespace_from_kstrtabns(const struct elf_info *info,
399 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100400{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900401 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100402 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100403}
404
Matthias Maennicha2b11182019-10-18 10:31:40 +0100405static void sym_update_namespace(const char *symname, const char *namespace)
406{
407 struct symbol *s = find_symbol(symname);
408
409 /*
410 * That symbol should have been created earlier and thus this is
411 * actually an assertion.
412 */
413 if (!s) {
414 merror("Could not update namespace(%s) for symbol %s\n",
415 namespace, symname);
416 return;
417 }
418
419 free(s->namespace);
420 s->namespace =
421 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
422}
423
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100424/**
425 * Add an exported symbol - it may have already been added without a
426 * CRC, in this case just update the CRC
427 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100428static struct symbol *sym_add_exported(const char *name, struct module *mod,
429 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430{
431 struct symbol *s = find_symbol(name);
432
433 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700434 s = new_symbol(name, mod, export);
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900435 } else if (!external_module || s->module->is_vmlinux ||
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900436 s->module == mod) {
437 warn("%s: '%s' exported twice. Previous export was in %s%s\n",
438 mod->name, name, s->module->name,
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900439 s->module->is_vmlinux ? "" : ".ko");
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900440 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900442
443 s->module = mod;
Ram Paibd5cbce2006-06-08 22:12:53 -0700444 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100445 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446}
447
Masahiro Yamada17436942019-11-15 02:42:24 +0900448static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100449{
450 struct symbol *s = find_symbol(name);
451
Masahiro Yamada17436942019-11-15 02:42:24 +0900452 /*
453 * Ignore stand-alone __crc_*, which might be auto-generated symbols
454 * such as __*_veneer in ARM ELF.
455 */
456 if (!s)
457 return;
458
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100459 s->crc = crc;
460 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461}
462
Masahiro Yamada75893572020-06-01 14:57:21 +0900463static void *grab_file(const char *filename, unsigned long *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464{
465 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930466 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 int fd;
468
469 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930470 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930472 if (fstat(fd, &st))
473 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
475 *size = st.st_size;
476 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930478failed:
479 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 if (map == MAP_FAILED)
481 return NULL;
482 return map;
483}
484
Masahiro Yamada75893572020-06-01 14:57:21 +0900485static void release_file(void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486{
487 munmap(file, size);
488}
489
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100490static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491{
492 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100493 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 Elf_Shdr *sechdrs;
495 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200496 const char *secstrings;
497 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
499 hdr = grab_file(filename, &info->size);
500 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930501 if (ignore_missing_files) {
502 fprintf(stderr, "%s: %s (ignored)\n", filename,
503 strerror(errno));
504 return 0;
505 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200507 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 }
509 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100510 if (info->size < sizeof(*hdr)) {
511 /* file too small, assume this is an empty .o file */
512 return 0;
513 }
514 /* Is this a valid ELF file? */
515 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
516 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
517 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
518 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
519 /* Not an ELF file - silently ignore it */
520 return 0;
521 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200523 hdr->e_type = TO_NATIVE(hdr->e_type);
524 hdr->e_machine = TO_NATIVE(hdr->e_machine);
525 hdr->e_version = TO_NATIVE(hdr->e_version);
526 hdr->e_entry = TO_NATIVE(hdr->e_entry);
527 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
528 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
529 hdr->e_flags = TO_NATIVE(hdr->e_flags);
530 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
531 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
532 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
533 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
534 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
535 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 sechdrs = (void *)hdr + hdr->e_shoff;
537 info->sechdrs = sechdrs;
538
Petr Stetiara83710e2007-08-27 12:15:07 +0200539 /* Check if file offset is correct */
540 if (hdr->e_shoff > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100541 fatal("section header offset=%lu in file '%s' is bigger than "
542 "filesize=%lu\n", (unsigned long)hdr->e_shoff,
543 filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200544 return 0;
545 }
546
Anders Kaseorg68457562011-05-19 16:55:27 -0600547 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200548 /*
549 * There are more than 64k sections,
550 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200551 */
552 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
553 }
554 else {
555 info->num_sections = hdr->e_shnum;
556 }
557 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600558 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200559 }
560 else {
561 info->secindex_strings = hdr->e_shstrndx;
562 }
563
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200565 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200566 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
567 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
568 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
569 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
570 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
571 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
572 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
573 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
574 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
575 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 }
577 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200578 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
579 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700580 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900581 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Tejun Heo56fc82c2009-02-06 00:48:02 +0900583 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100584 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
585 "sizeof(*hrd)=%zu\n", filename,
586 (unsigned long)sechdrs[i].sh_offset,
587 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100588 return 0;
589 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700590 secname = secstrings + sechdrs[i].sh_name;
591 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900592 if (nobits)
593 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
595 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700596 } else if (strcmp(secname, "__ksymtab") == 0)
597 info->export_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200598 else if (strcmp(secname, "__ksymtab_unused") == 0)
599 info->export_unused_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700600 else if (strcmp(secname, "__ksymtab_gpl") == 0)
601 info->export_gpl_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200602 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
603 info->export_unused_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700604 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
605 info->export_gpl_future_sec = i;
606
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200607 if (sechdrs[i].sh_type == SHT_SYMTAB) {
608 unsigned int sh_link_idx;
609 symtab_idx = i;
610 info->symtab_start = (void *)hdr +
611 sechdrs[i].sh_offset;
612 info->symtab_stop = (void *)hdr +
613 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600614 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200615 info->strtab = (void *)hdr +
616 sechdrs[sh_link_idx].sh_offset;
617 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200619 /* 32bit section no. table? ("more than 64k sections") */
620 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
621 symtab_shndx_idx = i;
622 info->symtab_shndx_start = (void *)hdr +
623 sechdrs[i].sh_offset;
624 info->symtab_shndx_stop = (void *)hdr +
625 sechdrs[i].sh_offset + sechdrs[i].sh_size;
626 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100628 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100629 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 /* Fix endianness in symbols */
632 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
633 sym->st_shndx = TO_NATIVE(sym->st_shndx);
634 sym->st_name = TO_NATIVE(sym->st_name);
635 sym->st_value = TO_NATIVE(sym->st_value);
636 sym->st_size = TO_NATIVE(sym->st_size);
637 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200638
639 if (symtab_shndx_idx != ~0U) {
640 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600641 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200642 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600643 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200644 symtab_idx);
645 /* Fix endianness */
646 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
647 p++)
648 *p = TO_NATIVE(*p);
649 }
650
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100651 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652}
653
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100654static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655{
656 release_file(info->hdr, info->size);
657}
658
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200659static int ignore_undef_symbol(struct elf_info *info, const char *symname)
660{
661 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900662 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200663 return 1;
664 /* ignore global offset table */
665 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
666 return 1;
667 if (info->hdr->e_machine == EM_PPC)
668 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900669 if (strstarts(symname, "_restgpr_") ||
670 strstarts(symname, "_savegpr_") ||
671 strstarts(symname, "_rest32gpr_") ||
672 strstarts(symname, "_save32gpr_") ||
673 strstarts(symname, "_restvr_") ||
674 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200675 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000676 if (info->hdr->e_machine == EM_PPC64)
677 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900678 if (strstarts(symname, "_restgpr0_") ||
679 strstarts(symname, "_savegpr0_") ||
680 strstarts(symname, "_restvr_") ||
681 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100682 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000683 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200684 /* Do not ignore this symbol */
685 return 0;
686}
687
Masahiro Yamada17436942019-11-15 02:42:24 +0900688static void handle_modversion(const struct module *mod,
689 const struct elf_info *info,
690 const Elf_Sym *sym, const char *symname)
691{
692 unsigned int crc;
693
694 if (sym->st_shndx == SHN_UNDEF) {
695 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n",
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900696 symname, mod->name, mod->is_vmlinux ? "" : ".ko");
Masahiro Yamada17436942019-11-15 02:42:24 +0900697 return;
698 }
699
700 if (sym->st_shndx == SHN_ABS) {
701 crc = sym->st_value;
702 } else {
703 unsigned int *crcp;
704
705 /* symbol points to the CRC in the ELF object */
706 crcp = sym_get_data(info, sym);
707 crc = TO_NATIVE(*crcp);
708 }
709 sym_set_crc(symname, crc);
710}
711
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900712static void handle_symbol(struct module *mod, struct elf_info *info,
713 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200715 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900716 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200717
Masahiro Yamada33795762020-06-01 14:57:24 +0900718 if (strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200719 export = export_from_secname(info, get_secindex(info, sym));
720 else
721 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
723 switch (sym->st_shndx) {
724 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900725 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100726 /* Should warn here, but modpost runs before the linker */
727 } else
728 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 case SHN_UNDEF:
731 /* undefined symbol */
732 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
733 ELF_ST_BIND(sym->st_info) != STB_WEAK)
734 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200735 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 if (info->hdr->e_machine == EM_SPARC ||
738 info->hdr->e_machine == EM_SPARCV9) {
739 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700740 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100742 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700743 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100744 munged[0] = '_';
745 munged[1] = toupper(munged[1]);
746 symname = munged;
747 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100749
Rusty Russellb92021b2013-03-15 15:04:17 +1030750 mod->unres = alloc_symbol(symname,
751 ELF_ST_BIND(sym->st_info) == STB_WEAK,
752 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 break;
754 default:
755 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900756 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100757 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100758 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900760 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900762 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 mod->has_cleanup = 1;
764 break;
765 }
766}
767
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100768/**
769 * Parse tag=value strings from .modinfo section
770 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771static char *next_string(char *string, unsigned long *secsize)
772{
773 /* Skip non-zero chars */
774 while (string[0]) {
775 string++;
776 if ((*secsize)-- <= 1)
777 return NULL;
778 }
779
780 /* Skip any zero padding. */
781 while (!string[0]) {
782 string++;
783 if ((*secsize)-- <= 1)
784 return NULL;
785 }
786 return string;
787}
788
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900789static char *get_next_modinfo(struct elf_info *info, const char *tag,
790 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791{
792 char *p;
793 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900794 char *modinfo = info->modinfo;
795 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900797 if (prev) {
798 size -= prev - modinfo;
799 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200800 }
801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 for (p = modinfo; p; p = next_string(p, &size)) {
803 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
804 return p + taglen + 1;
805 }
806 return NULL;
807}
808
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900809static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200810
811{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900812 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200813}
814
Sam Ravnborg93684d32006-02-19 11:53:35 +0100815/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100816 * Test if string s ends in string sub
817 * return 0 if match
818 **/
819static int strrcmp(const char *s, const char *sub)
820{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100821 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100822
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100823 if (!s || !sub)
824 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100825
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100826 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100827 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100828
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100829 if ((slen == 0) || (sublen == 0))
830 return 1;
831
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100832 if (sublen > slen)
833 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100834
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100835 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100836}
837
Sam Ravnborgff13f922008-01-23 19:54:27 +0100838static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
839{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100840 if (sym)
841 return elf->strtab + sym->st_name;
842 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100843 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100844}
845
Sam Ravnborg10668222008-01-13 22:21:31 +0100846/* The pattern is an array of simple patterns.
847 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100848 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100849 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930850 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100851 */
Trevor Keith5c725132009-09-22 16:43:38 -0700852static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100853{
854 const char *p;
855 while (*pat) {
856 p = *pat++;
857 const char *endp = p + strlen(p) - 1;
858
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930859 /* "*foo*" */
860 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300861 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
862 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930863
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930864 free(bare);
865 if (here != NULL)
866 return 1;
867 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100868 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930869 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100870 if (strrcmp(sym, p + 1) == 0)
871 return 1;
872 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100873 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100874 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100875 if (strncmp(sym, p, strlen(p) - 1) == 0)
876 return 1;
877 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100878 /* no wildcards */
879 else {
880 if (strcmp(p, sym) == 0)
881 return 1;
882 }
883 }
884 /* no match */
885 return 0;
886}
887
Sam Ravnborg10668222008-01-13 22:21:31 +0100888/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930889static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200890{
891 ".comment*",
892 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930893 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800894 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000895 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200896 ".mdebug*", /* alpha, score, mips etc. */
897 ".pdr", /* alpha, score, mips etc. */
898 ".stab*",
899 ".note*",
900 ".got*",
901 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400902 ".xt.prop", /* xtensa */
903 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030904 ".arcextmap*", /* arc */
905 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030906 ".cmem*", /* EZchip */
907 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100908 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600909 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200910 NULL
911};
Sam Ravnborg10668222008-01-13 22:21:31 +0100912
Sam Ravnborge241a632008-01-28 20:13:13 +0100913/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400914 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100915 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400916 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100917 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400918static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900919 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100920{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400921 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100922
Anders Kaseorgb614a692009-04-23 16:49:33 -0400923 if (sechdr->sh_type == SHT_PROGBITS &&
924 !(sechdr->sh_flags & SHF_ALLOC) &&
925 !match(sec, section_white_list)) {
926 warn("%s (%s): unexpected non-allocatable section.\n"
927 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
928 "Note that for example <linux/init.h> contains\n"
929 "section definitions for use in .S files.\n\n",
930 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100931 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100932}
933
934
935
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100936#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930937 ".init.setup", ".init.rodata", ".meminit.rodata", \
938 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100939#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930940 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100941
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100942#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930943 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100944#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930945 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100946
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200947#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930948 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
949 ".pci_fixup_enable", ".pci_fixup_resume", \
950 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200951
Paul Gortmakere24f6622013-06-19 19:30:48 -0400952#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
953#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100954
955#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
956#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100957
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930958#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930959#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Chris Metcalf6727ad92016-10-07 17:02:55 -0700960 ".kprobes.text", ".cpuidle.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930961#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400962 ".fixup", ".entry.text", ".exception.text", ".text.*", \
963 ".coldtext"
Sam Ravnborg10668222008-01-13 22:21:31 +0100964
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000965#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000966#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100967
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000968#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000969#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100970
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930971#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
972 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
973
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100974/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930975static const char *const init_data_sections[] =
976 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100977
978/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930979static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100980
981/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930982static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100983 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100984
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930985/* all text sections */
986static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
987
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100988/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930989static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100990
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100991
992/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100993#define DEFAULT_SYMBOL_WHITE_LIST \
994 "*driver", \
995 "*_template", /* scsi uses *_template a lot */ \
996 "*_timer", /* arm uses ops structures named _timer a lot */ \
997 "*_sht", /* scsi also used *_sht to some extent */ \
998 "*_ops", \
999 "*_probe", \
1000 "*_probe_one", \
1001 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001002
Mathias Krause7a3ee752014-08-27 20:28:53 +09301003static const char *const head_sections[] = { ".head.text*", NULL };
1004static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001005 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301006static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001007
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001008enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001009 TEXT_TO_ANY_INIT,
1010 DATA_TO_ANY_INIT,
1011 TEXT_TO_ANY_EXIT,
1012 DATA_TO_ANY_EXIT,
1013 XXXINIT_TO_SOME_INIT,
1014 XXXEXIT_TO_SOME_EXIT,
1015 ANY_INIT_TO_ANY_EXIT,
1016 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001017 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301018 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001019};
1020
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301021/**
1022 * Describe how to match sections on different criterias:
1023 *
1024 * @fromsec: Array of sections to be matched.
1025 *
1026 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
1027 * this array is forbidden (black-list). Can be empty.
1028 *
1029 * @good_tosec: Relocations applied to a section in @fromsec must be
1030 * targetting sections in this array (white-list). Can be empty.
1031 *
1032 * @mismatch: Type of mismatch.
1033 *
1034 * @symbol_white_list: Do not match a relocation to a symbol in this list
1035 * even if it is targetting a section in @bad_to_sec.
1036 *
1037 * @handler: Specific handler to call when a match is found. If NULL,
1038 * default_mismatch_handler() will be called.
1039 *
1040 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001041struct sectioncheck {
1042 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301043 const char *bad_tosec[20];
1044 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001045 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001046 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301047 void (*handler)(const char *modname, struct elf_info *elf,
1048 const struct sectioncheck* const mismatch,
1049 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1050
Sam Ravnborg10668222008-01-13 22:21:31 +01001051};
1052
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301053static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1054 const struct sectioncheck* const mismatch,
1055 Elf_Rela *r, Elf_Sym *sym,
1056 const char *fromsec);
1057
Mathias Krause7a3ee752014-08-27 20:28:53 +09301058static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001059/* Do not reference init/exit code/data from
1060 * normal code and data
1061 */
1062{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001063 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301064 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001065 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001066 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001067},
1068{
1069 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301070 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001071 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001072 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001073},
1074{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001075 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301076 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001077 .mismatch = DATA_TO_ANY_INIT,
1078 .symbol_white_list = {
1079 "*_template", "*_timer", "*_sht", "*_ops",
1080 "*_probe", "*_probe_one", "*_console", NULL
1081 },
1082},
1083{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001084 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301085 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001086 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001087 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001088},
1089{
1090 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301091 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001092 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001093 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001094},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001095/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001096{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001097 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301098 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001099 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001100 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001101},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001102/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001103{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001104 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301105 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001106 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001107 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001108},
1109/* Do not use exit code/data from init code */
1110{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001111 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301112 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001113 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001114 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001115},
1116/* Do not use init code/data from exit code */
1117{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001118 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301119 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001120 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001121 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001122},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001123{
1124 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301125 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001126 .mismatch = ANY_INIT_TO_ANY_EXIT,
1127 .symbol_white_list = { NULL },
1128},
Sam Ravnborg10668222008-01-13 22:21:31 +01001129/* Do not export init/exit functions or data */
1130{
1131 .fromsec = { "__ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301132 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001133 .mismatch = EXPORT_TO_INIT_EXIT,
1134 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301135},
1136{
1137 .fromsec = { "__ex_table", NULL },
1138 /* If you're adding any new black-listed sections in here, consider
1139 * adding a special 'printer' for them in scripts/check_extable.
1140 */
1141 .bad_tosec = { ".altinstr_replacement", NULL },
1142 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1143 .mismatch = EXTABLE_TO_NON_TEXT,
1144 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001145}
1146};
1147
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001148static const struct sectioncheck *section_mismatch(
1149 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001150{
1151 int i;
1152 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1153 const struct sectioncheck *check = &sectioncheck[0];
1154
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301155 /*
1156 * The target section could be the SHT_NUL section when we're
1157 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001158 * doesn't make much sense and causes build failures on parisc
1159 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301160 */
1161 if (*tosec == '\0')
1162 return NULL;
1163
Sam Ravnborg10668222008-01-13 22:21:31 +01001164 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301165 if (match(fromsec, check->fromsec)) {
1166 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1167 return check;
1168 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1169 return check;
1170 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001171 check++;
1172 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001173 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001174}
1175
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001176/**
1177 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001178 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001179 * Pattern 1:
1180 * If a module parameter is declared __initdata and permissions=0
1181 * then this is legal despite the warning generated.
1182 * We cannot see value of permissions here, so just ignore
1183 * this pattern.
1184 * The pattern is identified by:
1185 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001186 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001187 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001188 *
Rusty Russell6a841522010-08-11 23:04:16 -06001189 * Pattern 1a:
1190 * module_param_call() ops can refer to __init set function if permissions=0
1191 * The pattern is identified by:
1192 * tosec = .init.text
1193 * fromsec = .data*
1194 * atsym = __param_ops_*
1195 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001196 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001197 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001198 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001199 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001200 * tosec = init or exit section
1201 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001202 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1203 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001204 *
1205 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001206 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001207 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001208 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001209 * Some symbols belong to init section but still it is ok to reference
1210 * these from non-init sections as these symbols don't have any memory
1211 * allocated for them and symbol address and value are same. So even
1212 * if init section is freed, its ok to reference those symbols.
1213 * For ex. symbols marking the init section boundaries.
1214 * This pattern is identified by
1215 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001216 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301217 * Pattern 5:
1218 * GCC may optimize static inlines when fed constant arg(s) resulting
1219 * in functions like cpumask_empty() -- generating an associated symbol
1220 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1221 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1222 * meaningless section warning. May need to add isra symbols too...
1223 * This pattern is identified by
1224 * tosec = init section
1225 * fromsec = text section
1226 * refsymname = *.constprop.*
1227 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001228 * Pattern 6:
1229 * Hide section mismatch warnings for ELF local symbols. The goal
1230 * is to eliminate false positive modpost warnings caused by
1231 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1232 * Autogenerated symbol names bypass modpost's "Pattern 2"
1233 * whitelisting, which relies on pattern-matching against symbol
1234 * names to work. (One situation where gcc can autogenerate ELF
1235 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001236 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001237static int secref_whitelist(const struct sectioncheck *mismatch,
1238 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001239 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001240{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001241 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001242 if (match(tosec, init_data_sections) &&
1243 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001244 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001245 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001246
Rusty Russell6a841522010-08-11 23:04:16 -06001247 /* Check for pattern 1a */
1248 if (strcmp(tosec, ".init.text") == 0 &&
1249 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001250 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001251 return 0;
1252
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001253 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001254 if (match(tosec, init_exit_sections) &&
1255 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001256 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001257 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001258
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001259 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001260 if (match(fromsec, head_sections) &&
1261 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001262 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001263
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001264 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001265 if (match(tosym, linker_symbols))
1266 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001267
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301268 /* Check for pattern 5 */
1269 if (match(fromsec, text_sections) &&
1270 match(tosec, init_sections) &&
1271 match(fromsym, optim_symbols))
1272 return 0;
1273
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001274 /* Check for pattern 6 */
1275 if (strstarts(fromsym, ".L"))
1276 return 0;
1277
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001278 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001279}
1280
Sami Tolvanen5818c682018-10-23 15:15:35 -07001281static inline int is_arm_mapping_symbol(const char *str)
1282{
1283 return str[0] == '$' && strchr("axtd", str[1])
1284 && (str[2] == '\0' || str[2] == '.');
1285}
1286
1287/*
1288 * If there's no name there, ignore it; likewise, ignore it if it's
1289 * one of the magic symbols emitted used by current ARM tools.
1290 *
1291 * Otherwise if find_symbols_between() returns those symbols, they'll
1292 * fail the whitelist tests and cause lots of false alarms ... fixable
1293 * only by merging __exit and __init sections into __text, bloating
1294 * the kernel (which is especially evil on embedded platforms).
1295 */
1296static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1297{
1298 const char *name = elf->strtab + sym->st_name;
1299
1300 if (!name || !strlen(name))
1301 return 0;
1302 return !is_arm_mapping_symbol(name);
1303}
1304
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001305/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001306 * Find symbol based on relocation record info.
1307 * In some cases the symbol supplied is a valid symbol so
1308 * return refsym. If st_name != 0 we assume this is a valid symbol.
1309 * In other cases the symbol needs to be looked up in the symbol table
1310 * based on section and address.
1311 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001312static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001313 Elf_Sym *relsym)
1314{
1315 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001316 Elf_Sym *near = NULL;
1317 Elf64_Sword distance = 20;
1318 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001319 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001320
1321 if (relsym->st_name != 0)
1322 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001323
1324 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001325 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001326 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001327 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001328 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1329 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001330 if (!is_valid_name(elf, sym))
1331 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001332 if (sym->st_value == addr)
1333 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001334 /* Find a symbol nearby - addr are maybe negative */
1335 d = sym->st_value - addr;
1336 if (d < 0)
1337 d = addr - sym->st_value;
1338 if (d < distance) {
1339 distance = d;
1340 near = sym;
1341 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001342 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001343 /* We need a close match */
1344 if (distance < 20)
1345 return near;
1346 else
1347 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001348}
1349
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001350/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001351 * Find symbols before or equal addr and after addr - in the section sec.
1352 * If we find two symbols with equal offset prefer one with a valid name.
1353 * The ELF format may have a better way to detect what type of symbol
1354 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001355 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001356static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1357 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001358{
1359 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001360 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001361 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001362
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001363 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1364 const char *symsec;
1365
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001366 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001367 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001368 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001369 if (strcmp(symsec, sec) != 0)
1370 continue;
David Brownellda68d612007-02-20 13:58:16 -08001371 if (!is_valid_name(elf, sym))
1372 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001373 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001374 if ((addr - sym->st_value) < distance) {
1375 distance = addr - sym->st_value;
1376 near = sym;
1377 } else if ((addr - sym->st_value) == distance) {
1378 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001379 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001380 }
1381 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001382 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001383}
1384
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001385/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001386 * Convert a section name to the function/data attribute
1387 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001388 * .memexitconst => __memconst
1389 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001390 *
1391 * The memory of returned value has been allocated on a heap. The user of this
1392 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001393*/
1394static char *sec2annotation(const char *s)
1395{
1396 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001397 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001398 char *r = p;
1399
1400 *p++ = '_';
1401 *p++ = '_';
1402 if (*s == '.')
1403 s++;
1404 while (*s && *s != '.')
1405 *p++ = *s++;
1406 *p = '\0';
1407 if (*s == '.')
1408 s++;
1409 if (strstr(s, "rodata") != NULL)
1410 strcat(p, "const ");
1411 else if (strstr(s, "data") != NULL)
1412 strcat(p, "data ");
1413 else
1414 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001415 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001416 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001417 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001418 }
1419}
1420
1421static int is_function(Elf_Sym *sym)
1422{
1423 if (sym)
1424 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1425 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001426 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001427}
1428
Randy Dunlap00759c02011-03-15 14:13:47 -07001429static void print_section_list(const char * const list[20])
1430{
1431 const char *const *s = list;
1432
1433 while (*s) {
1434 fprintf(stderr, "%s", *s);
1435 s++;
1436 if (*s)
1437 fprintf(stderr, ", ");
1438 }
1439 fprintf(stderr, "\n");
1440}
1441
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301442static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1443{
1444 switch (is_func) {
1445 case 0: *name = "variable"; *name_p = ""; break;
1446 case 1: *name = "function"; *name_p = "()"; break;
1447 default: *name = "(unknown reference)"; *name_p = ""; break;
1448 }
1449}
1450
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001451/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001452 * Print a warning about a section mismatch.
1453 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001454 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001455 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001456static void report_sec_mismatch(const char *modname,
1457 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001458 const char *fromsec,
1459 unsigned long long fromaddr,
1460 const char *fromsym,
1461 int from_is_func,
1462 const char *tosec, const char *tosym,
1463 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001464{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001465 const char *from, *from_p;
1466 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001467 char *prl_from;
1468 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001469
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001470 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001471
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301472 get_pretty_name(from_is_func, &from, &from_p);
1473 get_pretty_name(to_is_func, &to, &to_p);
1474
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001475 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1476 "to the %s %s:%s%s\n",
1477 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1478 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001479
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001480 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001481 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001482 prl_from = sec2annotation(fromsec);
1483 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001484 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001485 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001486 "the %s %s%s%s.\n"
1487 "This is often because %s lacks a %s\n"
1488 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001489 prl_from, fromsym,
1490 to, prl_to, tosym, to_p,
1491 fromsym, prl_to, tosym);
1492 free(prl_from);
1493 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001494 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001495 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001496 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001497 fprintf(stderr,
1498 "The variable %s references\n"
1499 "the %s %s%s%s\n"
1500 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001501 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001502 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001503 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001504 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001505 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001506 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001507 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001508 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001509 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001510 fprintf(stderr,
1511 "The function %s() references a %s in an exit section.\n"
1512 "Often the %s %s%s has valid usage outside the exit section\n"
1513 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001514 fromsym, to, to, tosym, to_p, prl_to, tosym);
1515 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001516 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001517 case DATA_TO_ANY_EXIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001518 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001519 fprintf(stderr,
1520 "The variable %s references\n"
1521 "the %s %s%s%s\n"
1522 "If the reference is valid then annotate the\n"
1523 "variable with __exit* (see linux/init.h) or "
1524 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001525 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001526 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001527 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001528 break;
1529 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001530 case XXXINIT_TO_SOME_INIT:
1531 case XXXEXIT_TO_SOME_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001532 prl_from = sec2annotation(fromsec);
1533 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001534 fprintf(stderr,
1535 "The %s %s%s%s references\n"
1536 "a %s %s%s%s.\n"
1537 "If %s is only used by %s then\n"
1538 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001539 from, prl_from, fromsym, from_p,
1540 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001541 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001542 free(prl_from);
1543 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001544 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001545 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001546 prl_from = sec2annotation(fromsec);
1547 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001548 fprintf(stderr,
1549 "The %s %s%s%s references\n"
1550 "a %s %s%s%s.\n"
1551 "This is often seen when error handling "
1552 "in the init function\n"
1553 "uses functionality in the exit path.\n"
1554 "The fix is often to remove the %sannotation of\n"
1555 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001556 from, prl_from, fromsym, from_p,
1557 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001558 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001559 free(prl_from);
1560 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001561 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001562 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001563 prl_from = sec2annotation(fromsec);
1564 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001565 fprintf(stderr,
1566 "The %s %s%s%s references\n"
1567 "a %s %s%s%s.\n"
1568 "This is often seen when error handling "
1569 "in the exit function\n"
1570 "uses functionality in the init path.\n"
1571 "The fix is often to remove the %sannotation of\n"
1572 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001573 from, prl_from, fromsym, from_p,
1574 to, prl_to, tosym, to_p,
1575 prl_to, tosym, to_p);
1576 free(prl_from);
1577 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001578 break;
1579 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001580 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001581 fprintf(stderr,
1582 "The symbol %s is exported and annotated %s\n"
1583 "Fix this by removing the %sannotation of %s "
1584 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001585 tosym, prl_to, prl_to, tosym);
1586 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001587 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301588 case EXTABLE_TO_NON_TEXT:
1589 fatal("There's a special handler for this mismatch type, "
1590 "we should never get here.");
1591 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001592 }
1593 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001594}
1595
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301596static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1597 const struct sectioncheck* const mismatch,
1598 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1599{
1600 const char *tosec;
1601 Elf_Sym *to;
1602 Elf_Sym *from;
1603 const char *tosym;
1604 const char *fromsym;
1605
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301606 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1607 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301608
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001609 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301610 return;
1611
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301612 tosec = sec_name(elf, get_secindex(elf, sym));
1613 to = find_elf_symbol(elf, r->r_addend, sym);
1614 tosym = sym_name(elf, to);
1615
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301616 /* check whitelist - we may ignore it */
1617 if (secref_whitelist(mismatch,
1618 fromsec, fromsym, tosec, tosym)) {
1619 report_sec_mismatch(modname, mismatch,
1620 fromsec, r->r_offset, fromsym,
1621 is_function(from), tosec, tosym,
1622 is_function(to));
1623 }
1624}
1625
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301626static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1627{
1628 if (section_index > elf->num_sections)
1629 fatal("section_index is outside elf->num_sections!\n");
1630
1631 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1632}
1633
1634/*
1635 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1636 * to know the sizeof(struct exception_table_entry) for the target architecture.
1637 */
1638static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301639static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301640{
1641 /*
1642 * If we're currently checking the second relocation within __ex_table,
1643 * that relocation offset tells us the offsetof(struct
1644 * exception_table_entry, fixup) which is equal to sizeof(struct
1645 * exception_table_entry) divided by two. We use that to our advantage
1646 * since there's no portable way to get that size as every architecture
1647 * seems to go with different sized types. Not pretty but better than
1648 * hard-coding the size for every architecture..
1649 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301650 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301651 extable_entry_size = r->r_offset * 2;
1652}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301653
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301654static inline bool is_extable_fault_address(Elf_Rela *r)
1655{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301656 /*
1657 * extable_entry_size is only discovered after we've handled the
1658 * _second_ relocation in __ex_table, so only abort when we're not
1659 * handling the first reloc and extable_entry_size is zero.
1660 */
1661 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301662 fatal("extable_entry size hasn't been discovered!\n");
1663
1664 return ((r->r_offset == 0) ||
1665 (r->r_offset % extable_entry_size == 0));
1666}
1667
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301668#define is_second_extable_reloc(Start, Cur, Sec) \
1669 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1670
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301671static void report_extable_warnings(const char* modname, struct elf_info* elf,
1672 const struct sectioncheck* const mismatch,
1673 Elf_Rela* r, Elf_Sym* sym,
1674 const char* fromsec, const char* tosec)
1675{
1676 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1677 const char* fromsym_name = sym_name(elf, fromsym);
1678 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1679 const char* tosym_name = sym_name(elf, tosym);
1680 const char* from_pretty_name;
1681 const char* from_pretty_name_p;
1682 const char* to_pretty_name;
1683 const char* to_pretty_name_p;
1684
1685 get_pretty_name(is_function(fromsym),
1686 &from_pretty_name, &from_pretty_name_p);
1687 get_pretty_name(is_function(tosym),
1688 &to_pretty_name, &to_pretty_name_p);
1689
1690 warn("%s(%s+0x%lx): Section mismatch in reference"
1691 " from the %s %s%s to the %s %s:%s%s\n",
1692 modname, fromsec, (long)r->r_offset, from_pretty_name,
1693 fromsym_name, from_pretty_name_p,
1694 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1695
1696 if (!match(tosec, mismatch->bad_tosec) &&
1697 is_executable_section(elf, get_secindex(elf, sym)))
1698 fprintf(stderr,
1699 "The relocation at %s+0x%lx references\n"
1700 "section \"%s\" which is not in the list of\n"
1701 "authorized sections. If you're adding a new section\n"
1702 "and/or if this reference is valid, add \"%s\" to the\n"
1703 "list of authorized sections to jump to on fault.\n"
1704 "This can be achieved by adding \"%s\" to \n"
1705 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1706 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1707}
1708
1709static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1710 const struct sectioncheck* const mismatch,
1711 Elf_Rela* r, Elf_Sym* sym,
1712 const char *fromsec)
1713{
1714 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1715
1716 sec_mismatch_count++;
1717
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001718 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301719
1720 if (match(tosec, mismatch->bad_tosec))
1721 fatal("The relocation at %s+0x%lx references\n"
1722 "section \"%s\" which is black-listed.\n"
1723 "Something is seriously wrong and should be fixed.\n"
1724 "You might get more information about where this is\n"
1725 "coming from by using scripts/check_extable.sh %s\n",
1726 fromsec, (long)r->r_offset, tosec, modname);
1727 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1728 if (is_extable_fault_address(r))
1729 fatal("The relocation at %s+0x%lx references\n"
1730 "section \"%s\" which is not executable, IOW\n"
1731 "it is not possible for the kernel to fault\n"
1732 "at that address. Something is seriously wrong\n"
1733 "and should be fixed.\n",
1734 fromsec, (long)r->r_offset, tosec);
1735 else
1736 fatal("The relocation at %s+0x%lx references\n"
1737 "section \"%s\" which is not executable, IOW\n"
1738 "the kernel will fault if it ever tries to\n"
1739 "jump to it. Something is seriously wrong\n"
1740 "and should be fixed.\n",
1741 fromsec, (long)r->r_offset, tosec);
1742 }
1743}
1744
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001745static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001746 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001747{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001748 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301749 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001750
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001751 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301752 if (mismatch->handler)
1753 mismatch->handler(modname, elf, mismatch,
1754 r, sym, fromsec);
1755 else
1756 default_mismatch_handler(modname, elf, mismatch,
1757 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001758 }
1759}
1760
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001761static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001762 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001763{
Masahiro Yamadad2e4d052020-05-25 14:47:04 +09001764 return sym_get_data_by_offset(elf, sechdr->sh_info, r->r_offset);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001765}
1766
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001767static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001768{
1769 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001770 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001771
1772 switch (r_typ) {
1773 case R_386_32:
1774 r->r_addend = TO_NATIVE(*location);
1775 break;
1776 case R_386_PC32:
1777 r->r_addend = TO_NATIVE(*location) + 4;
1778 /* For CONFIG_RELOCATABLE=y */
1779 if (elf->hdr->e_type == ET_EXEC)
1780 r->r_addend += r->r_offset;
1781 break;
1782 }
1783 return 0;
1784}
1785
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001786#ifndef R_ARM_CALL
1787#define R_ARM_CALL 28
1788#endif
1789#ifndef R_ARM_JUMP24
1790#define R_ARM_JUMP24 29
1791#endif
1792
David A. Longc9698e52014-02-14 22:41:18 +01001793#ifndef R_ARM_THM_CALL
1794#define R_ARM_THM_CALL 10
1795#endif
1796#ifndef R_ARM_THM_JUMP24
1797#define R_ARM_THM_JUMP24 30
1798#endif
1799#ifndef R_ARM_THM_JUMP19
1800#define R_ARM_THM_JUMP19 51
1801#endif
1802
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001803static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001804{
1805 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1806
1807 switch (r_typ) {
1808 case R_ARM_ABS32:
1809 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001810 r->r_addend = (int)(long)
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001811 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001812 break;
1813 case R_ARM_PC24:
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001814 case R_ARM_CALL:
1815 case R_ARM_JUMP24:
David A. Longc9698e52014-02-14 22:41:18 +01001816 case R_ARM_THM_CALL:
1817 case R_ARM_THM_JUMP24:
1818 case R_ARM_THM_JUMP19:
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001819 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001820 r->r_addend = (int)(long)(elf->hdr +
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001821 sechdr->sh_offset +
1822 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001823 break;
1824 default:
1825 return 1;
1826 }
1827 return 0;
1828}
1829
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001830static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001831{
1832 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001833 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001834 unsigned int inst;
1835
1836 if (r_typ == R_MIPS_HI16)
1837 return 1; /* skip this */
1838 inst = TO_NATIVE(*location);
1839 switch (r_typ) {
1840 case R_MIPS_LO16:
1841 r->r_addend = inst & 0xffff;
1842 break;
1843 case R_MIPS_26:
1844 r->r_addend = (inst & 0x03ffffff) << 2;
1845 break;
1846 case R_MIPS_32:
1847 r->r_addend = inst;
1848 break;
1849 }
1850 return 0;
1851}
1852
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001853static void section_rela(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001854 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001855{
1856 Elf_Sym *sym;
1857 Elf_Rela *rela;
1858 Elf_Rela r;
1859 unsigned int r_sym;
1860 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001861
Sam Ravnborgff13f922008-01-23 19:54:27 +01001862 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001863 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1864
Sam Ravnborgff13f922008-01-23 19:54:27 +01001865 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001866 fromsec += strlen(".rela");
1867 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001868 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001869 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001870
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001871 for (rela = start; rela < stop; rela++) {
1872 r.r_offset = TO_NATIVE(rela->r_offset);
1873#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001874 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001875 unsigned int r_typ;
1876 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1877 r_sym = TO_NATIVE(r_sym);
1878 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1879 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1880 } else {
1881 r.r_info = TO_NATIVE(rela->r_info);
1882 r_sym = ELF_R_SYM(r.r_info);
1883 }
1884#else
1885 r.r_info = TO_NATIVE(rela->r_info);
1886 r_sym = ELF_R_SYM(r.r_info);
1887#endif
1888 r.r_addend = TO_NATIVE(rela->r_addend);
1889 sym = elf->symtab_start + r_sym;
1890 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001891 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001892 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301893 if (is_second_extable_reloc(start, rela, fromsec))
1894 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001895 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001896 }
1897}
1898
1899static void section_rel(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001900 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001901{
1902 Elf_Sym *sym;
1903 Elf_Rel *rel;
1904 Elf_Rela r;
1905 unsigned int r_sym;
1906 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001907
Sam Ravnborgff13f922008-01-23 19:54:27 +01001908 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001909 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1910
Sam Ravnborgff13f922008-01-23 19:54:27 +01001911 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001912 fromsec += strlen(".rel");
1913 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001914 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001915 return;
1916
1917 for (rel = start; rel < stop; rel++) {
1918 r.r_offset = TO_NATIVE(rel->r_offset);
1919#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001920 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001921 unsigned int r_typ;
1922 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1923 r_sym = TO_NATIVE(r_sym);
1924 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1925 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1926 } else {
1927 r.r_info = TO_NATIVE(rel->r_info);
1928 r_sym = ELF_R_SYM(r.r_info);
1929 }
1930#else
1931 r.r_info = TO_NATIVE(rel->r_info);
1932 r_sym = ELF_R_SYM(r.r_info);
1933#endif
1934 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001935 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001936 case EM_386:
1937 if (addend_386_rel(elf, sechdr, &r))
1938 continue;
1939 break;
1940 case EM_ARM:
1941 if (addend_arm_rel(elf, sechdr, &r))
1942 continue;
1943 break;
1944 case EM_MIPS:
1945 if (addend_mips_rel(elf, sechdr, &r))
1946 continue;
1947 break;
1948 }
1949 sym = elf->symtab_start + r_sym;
1950 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001951 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001952 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301953 if (is_second_extable_reloc(start, rel, fromsec))
1954 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001955 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001956 }
1957}
1958
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001959/**
1960 * A module includes a number of sections that are discarded
1961 * either when loaded or when used as built-in.
1962 * For loaded modules all functions marked __init and all data
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001963 * marked __initdata will be discarded when the module has been initialized.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001964 * Likewise for modules used built-in the sections marked __exit
1965 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001966 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001967 * The check_sec_ref() function traverses all relocation records
1968 * to find all references to a section that reference a section that will
1969 * be discarded and warns about it.
1970 **/
1971static void check_sec_ref(struct module *mod, const char *modname,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001972 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001973{
1974 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001975 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001976
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001977 /* Walk through all sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001978 for (i = 0; i < elf->num_sections; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001979 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001980 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001981 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001982 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001983 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001984 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001985 }
1986}
1987
Andi Kleen7d02b492014-02-08 09:01:12 +01001988static char *remove_dot(char *s)
1989{
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301990 size_t n = strcspn(s, ".");
Andi Kleen7d02b492014-02-08 09:01:12 +01001991
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301992 if (n && s[n]) {
1993 size_t m = strspn(s + n + 1, "0123456789");
1994 if (m && (s[n + m] == '.' || s[n + m] == 0))
Andi Kleen7d02b492014-02-08 09:01:12 +01001995 s[n] = 0;
1996 }
1997 return s;
1998}
1999
Masahiro Yamada8b185742018-05-09 18:50:40 +09002000static void read_symbols(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001{
2002 const char *symname;
2003 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002004 char *license;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002005 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 struct module *mod;
2007 struct elf_info info = { };
2008 Elf_Sym *sym;
2009
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01002010 if (!parse_elf(&info, modname))
2011 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
2013 mod = new_module(modname);
2014
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002015 if (mod->is_vmlinux) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 have_vmlinux = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017 mod->skip = 1;
2018 }
2019
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002020 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002021 license = get_modinfo(&info, "license");
2022 if (!license)
2023 warn("missing MODULE_LICENSE() in %s\n", modname);
2024 while (license) {
2025 if (license_is_gpl_compatible(license))
2026 mod->gpl_compatible = 1;
2027 else {
2028 mod->gpl_compatible = 0;
2029 break;
2030 }
2031 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002032 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002033
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002034 namespace = get_modinfo(&info, "import_ns");
2035 while (namespace) {
2036 add_namespace(&mod->imported_namespaces, namespace);
2037 namespace = get_next_modinfo(&info, "import_ns",
2038 namespace);
2039 }
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002040 }
2041
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002043 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002045 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 handle_moddevtable(mod, &info, sym, symname);
2047 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002048
Matthias Maennich69923202019-10-18 10:31:42 +01002049 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2050 symname = remove_dot(info.strtab + sym->st_name);
2051
Masahiro Yamada17436942019-11-15 02:42:24 +09002052 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002053 if (strstarts(symname, "__kstrtabns_"))
2054 sym_update_namespace(symname + strlen("__kstrtabns_"),
2055 namespace_from_kstrtabns(&info,
2056 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002057
2058 if (strstarts(symname, "__crc_"))
2059 handle_modversion(mod, &info, sym,
2060 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002061 }
2062
Denis Efremov15bfc232019-08-01 09:06:57 +03002063 // check for static EXPORT_SYMBOL_* functions && global vars
2064 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2065 unsigned char bind = ELF_ST_BIND(sym->st_info);
2066
2067 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2068 struct symbol *s =
2069 find_symbol(remove_dot(info.strtab +
2070 sym->st_name));
2071
2072 if (s)
2073 s->is_static = 0;
2074 }
2075 }
2076
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002077 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002079 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002080 version = get_modinfo(&info, "version");
2081 if (version || all_versions)
2082 get_src_version(modname, mod->srcversion,
2083 sizeof(mod->srcversion) - 1);
2084 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085
2086 parse_elf_finish(&info);
2087
Rusty Russell8c8ef422009-03-31 13:05:34 -06002088 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 * never passed as an argument to an exported function, so
2090 * the automatic versioning doesn't pick it up, but it's really
2091 * important anyhow */
2092 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06002093 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094}
2095
Rusty Russell712f9b42013-04-04 17:37:38 +10302096static void read_symbols_from_files(const char *filename)
2097{
2098 FILE *in = stdin;
2099 char fname[PATH_MAX];
2100
2101 if (strcmp(filename, "-") != 0) {
2102 in = fopen(filename, "r");
2103 if (!in)
2104 fatal("Can't open filenames file %s: %m", filename);
2105 }
2106
2107 while (fgets(fname, PATH_MAX, in) != NULL) {
2108 if (strends(fname, "\n"))
2109 fname[strlen(fname)-1] = '\0';
2110 read_symbols(fname);
2111 }
2112
2113 if (in != stdin)
2114 fclose(in);
2115}
2116
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117#define SZ 500
2118
2119/* We first write the generated file into memory using the
2120 * following helper, then compare to the file on disk and
2121 * only update the later if anything changed */
2122
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002123void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
2124 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125{
2126 char tmp[SZ];
2127 int len;
2128 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002129
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 va_start(ap, fmt);
2131 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002132 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 va_end(ap);
2134}
2135
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002136void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137{
2138 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002139 buf->size += len + SZ;
Randy Dunlap1f3aa902018-08-15 12:30:38 -07002140 buf->p = NOFAIL(realloc(buf->p, buf->size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 }
2142 strncpy(buf->p + buf->pos, s, len);
2143 buf->pos += len;
2144}
2145
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002146static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
2147{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002148 switch (exp) {
2149 case export_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002150 fatal("GPL-incompatible module %s.ko uses GPL-only symbol '%s'\n",
2151 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002152 break;
2153 case export_unused_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002154 fatal("GPL-incompatible module %s.ko uses GPL-only symbol marked UNUSED '%s'\n",
2155 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002156 break;
2157 case export_gpl_future:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002158 warn("GPL-incompatible module %s.ko uses future GPL-only symbol '%s'\n",
2159 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002160 break;
2161 case export_plain:
2162 case export_unused:
2163 case export_unknown:
2164 /* ignore */
2165 break;
2166 }
2167}
2168
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002169static void check_for_unused(enum export exp, const char *m, const char *s)
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002170{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002171 switch (exp) {
2172 case export_unused:
2173 case export_unused_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002174 warn("module %s.ko uses symbol '%s' marked UNUSED\n",
2175 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002176 break;
2177 default:
2178 /* ignore */
2179 break;
2180 }
2181}
2182
Masahiro Yamada3b415282018-11-23 16:57:23 +09002183static int check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002184{
2185 struct symbol *s, *exp;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002186 int err = 0;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002187
2188 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002189 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002190 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002191 if (!exp || exp->module == mod) {
2192 if (have_vmlinux && !s->weak) {
Jessica Yu93c95e52020-03-06 17:02:05 +01002193 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2194 "\"%s\" [%s.ko] undefined!\n",
2195 s->name, mod->name);
2196 if (!warn_unresolved)
Masahiro Yamada3b415282018-11-23 16:57:23 +09002197 err = 1;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002198 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002199 continue;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002200 }
Andrew Morton6449bd62006-06-09 20:45:06 -07002201 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002202 if (basename)
2203 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002204 else
2205 basename = mod->name;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002206
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002207 if (exp->namespace &&
2208 !module_imports_namespace(mod, exp->namespace)) {
Jessica Yu54b77842020-03-06 17:02:06 +01002209 modpost_log(allow_missing_ns_imports ? LOG_WARN : LOG_ERROR,
2210 "module %s uses symbol %s from namespace %s, but does not import it.\n",
2211 basename, exp->name, exp->namespace);
2212 if (!allow_missing_ns_imports)
2213 err = 1;
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002214 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002215 }
2216
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002217 if (!mod->gpl_compatible)
2218 check_for_gpl_usage(exp->export, basename, exp->name);
2219 check_for_unused(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002220 }
Masahiro Yamada3b415282018-11-23 16:57:23 +09002221
2222 return err;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002223}
2224
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002225static int check_modname_len(struct module *mod)
2226{
2227 const char *mod_name;
2228
2229 mod_name = strrchr(mod->name, '/');
2230 if (mod_name == NULL)
2231 mod_name = mod->name;
2232 else
2233 mod_name++;
2234 if (strlen(mod_name) >= MODULE_NAME_LEN) {
2235 merror("module name is too long [%s.ko]\n", mod->name);
2236 return 1;
2237 }
2238
2239 return 0;
2240}
2241
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002242/**
2243 * Header for the generated file
2244 **/
2245static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246{
2247 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002248 /*
2249 * Include build-salt.h after module.h in order to
2250 * inherit the definitions.
2251 */
2252 buf_printf(b, "#include <linux/build-salt.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 buf_printf(b, "#include <linux/vermagic.h>\n");
2254 buf_printf(b, "#include <linux/compiler.h>\n");
2255 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002256 buf_printf(b, "BUILD_SALT;\n");
2257 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002259 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302261 buf_printf(b, "__visible struct module __this_module\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002262 buf_printf(b, "__section(.gnu.linkonce.this_module) = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002263 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002265 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 if (mod->has_cleanup)
2267 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002268 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002270 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 buf_printf(b, "};\n");
2272}
2273
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002274static void add_intree_flag(struct buffer *b, int is_intree)
2275{
2276 if (is_intree)
2277 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2278}
2279
Andi Kleencaf75012018-01-25 15:50:28 -08002280/* Cannot check for assembler */
2281static void add_retpoline(struct buffer *b)
2282{
WANG Chaoe4f35892018-12-11 00:37:25 +08002283 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002284 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2285 buf_printf(b, "#endif\n");
2286}
2287
Trevor Keith5c725132009-09-22 16:43:38 -07002288static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002289{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002290 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002291 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2292}
2293
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002294/**
2295 * Record CRCs for unresolved symbols
2296 **/
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002297static int add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298{
2299 struct symbol *s, *exp;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002300 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301
2302 for (s = mod->unres; s; s = s->next) {
2303 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002304 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 s->module = exp->module;
2307 s->crc_valid = exp->crc_valid;
2308 s->crc = exp->crc;
2309 }
2310
2311 if (!modversions)
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002312 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313
2314 buf_printf(b, "\n");
2315 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002316 buf_printf(b, "__used __section(__versions) = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317
2318 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002319 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002322 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 s->name, mod->name);
2324 continue;
2325 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302326 if (strlen(s->name) >= MODULE_NAME_LEN) {
2327 merror("too long symbol \"%s\" [%s.ko]\n",
2328 s->name, mod->name);
2329 err = 1;
2330 break;
2331 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002332 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302333 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 }
2335
2336 buf_printf(b, "};\n");
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002337
2338 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339}
2340
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002341static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342{
2343 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 int first = 1;
2345
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002346 /* Clear ->seen flag of modules that own symbols needed by this. */
2347 for (s = mod->unres; s; s = s->next)
2348 if (s->module)
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002349 s->module->seen = s->module->is_vmlinux;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350
2351 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002352 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002354 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 if (!s->module)
2356 continue;
2357
2358 if (s->module->seen)
2359 continue;
2360
2361 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002362 p = strrchr(s->module->name, '/');
2363 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002364 p++;
2365 else
2366 p = s->module->name;
2367 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368 first = 0;
2369 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002370 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371}
2372
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002373static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374{
2375 if (mod->srcversion[0]) {
2376 buf_printf(b, "\n");
2377 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2378 mod->srcversion);
2379 }
2380}
2381
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002382static void write_buf(struct buffer *b, const char *fname)
2383{
2384 FILE *file;
2385
2386 file = fopen(fname, "w");
2387 if (!file) {
2388 perror(fname);
2389 exit(1);
2390 }
2391 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2392 perror(fname);
2393 exit(1);
2394 }
2395 if (fclose(file) != 0) {
2396 perror(fname);
2397 exit(1);
2398 }
2399}
2400
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002401static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402{
2403 char *tmp;
2404 FILE *file;
2405 struct stat st;
2406
2407 file = fopen(fname, "r");
2408 if (!file)
2409 goto write;
2410
2411 if (fstat(fileno(file), &st) < 0)
2412 goto close_write;
2413
2414 if (st.st_size != b->pos)
2415 goto close_write;
2416
2417 tmp = NOFAIL(malloc(b->pos));
2418 if (fread(tmp, 1, b->pos, file) != b->pos)
2419 goto free_write;
2420
2421 if (memcmp(tmp, b->p, b->pos) != 0)
2422 goto free_write;
2423
2424 free(tmp);
2425 fclose(file);
2426 return;
2427
2428 free_write:
2429 free(tmp);
2430 close_write:
2431 fclose(file);
2432 write:
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002433 write_buf(b, fname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434}
2435
Ram Paibd5cbce2006-06-08 22:12:53 -07002436/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002437 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002438 **/
Masahiro Yamada52c34162020-06-01 14:57:05 +09002439static void read_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440{
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002441 char *buf, *pos, *line;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002443 buf = read_text_file(fname);
2444 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 /* No symbol versions, silently ignore */
2446 return;
2447
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002448 pos = buf;
2449
2450 while ((line = get_line(&pos))) {
Jessica Yu51900442020-03-11 18:01:20 +01002451 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452 unsigned int crc;
2453 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002454 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455
2456 if (!(symname = strchr(line, '\t')))
2457 goto fail;
2458 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002459 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 goto fail;
2461 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002462 if (!(export = strchr(modname, '\t')))
2463 goto fail;
2464 *export++ = '\0';
2465 if (!(namespace = strchr(export, '\t')))
2466 goto fail;
2467 *namespace++ = '\0';
2468
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 crc = strtoul(line, &d, 16);
2470 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2471 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002472 mod = find_module(modname);
2473 if (!mod) {
Jan Beulich0fa3a882009-03-12 12:28:30 +00002474 mod = new_module(modname);
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002475 if (mod->is_vmlinux)
2476 have_vmlinux = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 mod->skip = 1;
Masahiro Yamada52c34162020-06-01 14:57:05 +09002478 mod->from_dump = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002480 s = sym_add_exported(symname, mod, export_no(export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002481 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002482 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002483 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 }
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002485 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 return;
2487fail:
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002488 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 fatal("parse error in symbol dump file\n");
2490}
2491
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002492/* For normal builds always dump all symbols.
2493 * For external modules only dump symbols
2494 * that are not read from kernel Module.symvers.
2495 **/
2496static int dump_sym(struct symbol *sym)
2497{
2498 if (!external_module)
2499 return 1;
Masahiro Yamada52c34162020-06-01 14:57:05 +09002500 if (sym->module->from_dump)
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002501 return 0;
2502 return 1;
2503}
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002504
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002505static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506{
2507 struct buffer buf = { };
2508 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002509 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 int n;
2511
2512 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2513 symbol = symbolhash[n];
2514 while (symbol) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002515 if (dump_sym(symbol)) {
2516 namespace = symbol->namespace;
2517 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2518 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002519 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002520 export_str(symbol->export),
2521 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002522 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523 symbol = symbol->next;
2524 }
2525 }
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002526 write_buf(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002527 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528}
2529
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002530static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002531{
2532 struct module *mod;
2533 struct namespace_list *ns;
2534 struct buffer ns_deps_buf = {};
2535
2536 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002537
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002538 if (mod->skip || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002539 continue;
2540
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002541 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002542
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002543 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2544 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002545
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002546 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002547 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002548
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002549 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002550 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002551}
2552
Masahiro Yamada79247992020-06-01 14:57:07 +09002553struct dump_list {
2554 struct dump_list *next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002555 const char *file;
2556};
2557
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002558int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559{
2560 struct module *mod;
2561 struct buffer buf = { };
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002562 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302563 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564 int opt;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002565 int err;
Denis Efremov15bfc232019-08-01 09:06:57 +03002566 int n;
Masahiro Yamada79247992020-06-01 14:57:07 +09002567 struct dump_list *dump_read_start = NULL;
2568 struct dump_list **dump_read_iter = &dump_read_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002570 while ((opt = getopt(argc, argv, "ei:mnT:o:awENd:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002571 switch (opt) {
Masahiro Yamadae3fb4df2020-06-01 14:57:08 +09002572 case 'e':
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002573 external_module = 1;
Masahiro Yamadae3fb4df2020-06-01 14:57:08 +09002574 break;
2575 case 'i':
Masahiro Yamada79247992020-06-01 14:57:07 +09002576 *dump_read_iter =
2577 NOFAIL(calloc(1, sizeof(**dump_read_iter)));
2578 (*dump_read_iter)->file = optarg;
2579 dump_read_iter = &(*dump_read_iter)->next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002580 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002581 case 'm':
2582 modversions = 1;
2583 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302584 case 'n':
2585 ignore_missing_files = 1;
2586 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002587 case 'o':
2588 dump_write = optarg;
2589 break;
2590 case 'a':
2591 all_versions = 1;
2592 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302593 case 'T':
2594 files_source = optarg;
2595 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002596 case 'w':
2597 warn_unresolved = 1;
2598 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302599 case 'E':
2600 sec_mismatch_fatal = 1;
2601 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002602 case 'N':
2603 allow_missing_ns_imports = 1;
2604 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002605 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002606 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002607 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002608 default:
2609 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 }
2611 }
2612
Masahiro Yamada79247992020-06-01 14:57:07 +09002613 while (dump_read_start) {
2614 struct dump_list *tmp;
Masahiro Yamada2beee862020-06-01 14:57:04 +09002615
Masahiro Yamada79247992020-06-01 14:57:07 +09002616 read_dump(dump_read_start->file);
2617 tmp = dump_read_start->next;
2618 free(dump_read_start);
2619 dump_read_start = tmp;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002620 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002622 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624
Rusty Russell712f9b42013-04-04 17:37:38 +10302625 if (files_source)
2626 read_symbols_from_files(files_source);
2627
Masahiro Yamada7e8a3232020-06-01 14:57:13 +09002628 /*
2629 * When there's no vmlinux, don't print warnings about
2630 * unresolved symbols (since there'll be too many ;)
2631 */
2632 if (!have_vmlinux)
2633 warn("Symbol info of vmlinux is missing. Unresolved symbol check will be entirely skipped.\n");
2634
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002635 err = 0;
2636
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002637 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302638 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002639
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002640 if (mod->skip)
2641 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642
2643 buf.pos = 0;
2644
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002645 err |= check_modname_len(mod);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002646 err |= check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002647
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002649 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002650 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002651 add_staging_flag(&buf, mod->name);
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002652 err |= add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002653 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 add_moddevtable(&buf, mod);
2655 add_srcversion(&buf, mod);
2656
2657 sprintf(fname, "%s.mod.c", mod->name);
2658 write_if_changed(&buf, fname);
2659 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002660
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002661 if (missing_namespace_deps)
2662 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002663
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 if (dump_write)
2665 write_dump(dump_write);
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002666 if (sec_mismatch_count && sec_mismatch_fatal)
Jessica Yu93c95e52020-03-06 17:02:05 +01002667 fatal("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002668 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002669 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002670 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002671
Masahiro Yamada47346e92019-09-24 21:07:40 +09002672 for (s = symbolhash[n]; s; s = s->next) {
Denis Efremov15bfc232019-08-01 09:06:57 +03002673 if (s->is_static)
2674 warn("\"%s\" [%s] is a static %s\n",
2675 s->name, s->module->name,
2676 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002677 }
2678 }
2679
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002680 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002682 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683}