blob: 3e623ccc020b2f8ac8e7e400f83bb23ea98b0dc5 [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>
Guenter Roeckeed380f2013-09-23 15:23:54 +093020#include <errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include "modpost.h"
Sam Ravnborgb817f6f2006-06-09 21:53:55 +020022#include "../../include/linux/license.h"
Alan Jenkins9e1b9b82009-11-07 21:03:54 +000023
Linus Torvalds1da177e2005-04-16 15:20:36 -070024/* Are we using CONFIG_MODVERSIONS? */
Mathias Krause7a3ee752014-08-27 20:28:53 +093025static int modversions = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070026/* Is CONFIG_MODULE_SRCVERSION_ALL set? */
27static int all_versions = 0;
Sam Ravnborg040fcc82006-01-28 22:15:55 +010028/* If we are modposting external module set to 1 */
29static int external_module = 0;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -070030/* Only warn about unresolved symbols */
31static int warn_unresolved = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -070032/* How a symbol is exported */
Sam Ravnborg588ccd72008-01-24 21:12:37 +010033static int sec_mismatch_count = 0;
Masahiro Yamadac7299d92020-12-01 19:34:18 +090034static int sec_mismatch_warn_only = true;
Guenter Roeckeed380f2013-09-23 15:23:54 +093035/* ignore missing files */
36static int ignore_missing_files;
Jessica Yu54b77842020-03-06 17:02:06 +010037/* If set to 1, only warn (instead of error) about missing ns imports */
38static int allow_missing_ns_imports;
Sam Ravnborg588ccd72008-01-24 21:12:37 +010039
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +090040static bool error_occurred;
41
Masahiro Yamada4475dff2021-03-26 03:54:11 +090042/*
43 * Cut off the warnings when there are too many. This typically occurs when
44 * vmlinux is missing. ('make modules' without building vmlinux.)
45 */
46#define MAX_UNRESOLVED_REPORTS 10
47static unsigned int nr_unresolved;
48
Sam Ravnborgc96fca22006-07-01 11:44:23 +020049enum export {
Christoph Hellwig36794822021-02-02 13:13:34 +010050 export_plain,
51 export_gpl,
52 export_unknown
Sam Ravnborgc96fca22006-07-01 11:44:23 +020053};
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +080055/* In kernel, this size is defined in linux/module.h;
56 * here we use Elf_Addr instead of long for covering cross-compile
57 */
58
59#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
60
Jessica Yu93c95e52020-03-06 17:02:05 +010061void __attribute__((format(printf, 2, 3)))
62modpost_log(enum loglevel loglevel, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063{
64 va_list arglist;
65
Jessica Yu93c95e52020-03-06 17:02:05 +010066 switch (loglevel) {
67 case LOG_WARN:
68 fprintf(stderr, "WARNING: ");
69 break;
70 case LOG_ERROR:
71 fprintf(stderr, "ERROR: ");
72 break;
73 case LOG_FATAL:
74 fprintf(stderr, "FATAL: ");
75 break;
76 default: /* invalid loglevel, ignore */
77 break;
78 }
79
80 fprintf(stderr, "modpost: ");
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82 va_start(arglist, fmt);
83 vfprintf(stderr, fmt, arglist);
84 va_end(arglist);
85
Jessica Yu93c95e52020-03-06 17:02:05 +010086 if (loglevel == LOG_FATAL)
87 exit(1);
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +090088 if (loglevel == LOG_ERROR)
89 error_occurred = true;
Matthew Wilcox2a116652006-10-07 05:35:32 -060090}
91
Linus Torvalds1da177e2005-04-16 15:20:36 -070092void *do_nofail(void *ptr, const char *expr)
93{
Sam Ravnborgdf578e72008-01-11 19:17:15 +010094 if (!ptr)
Jessica Yu93c95e52020-03-06 17:02:05 +010095 fatal("Memory allocation failure: %s.\n", expr);
Sam Ravnborgdf578e72008-01-11 19:17:15 +010096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 return ptr;
98}
99
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900100char *read_text_file(const char *filename)
101{
102 struct stat st;
103 size_t nbytes;
104 int fd;
105 char *buf;
106
107 fd = open(filename, O_RDONLY);
108 if (fd < 0) {
109 perror(filename);
110 exit(1);
111 }
112
113 if (fstat(fd, &st) < 0) {
114 perror(filename);
115 exit(1);
116 }
117
118 buf = NOFAIL(malloc(st.st_size + 1));
119
120 nbytes = st.st_size;
121
122 while (nbytes) {
123 ssize_t bytes_read;
124
125 bytes_read = read(fd, buf, nbytes);
126 if (bytes_read < 0) {
127 perror(filename);
128 exit(1);
129 }
130
131 nbytes -= bytes_read;
132 }
133 buf[st.st_size] = '\0';
134
135 close(fd);
136
137 return buf;
138}
139
140char *get_line(char **stringp)
141{
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200142 char *orig = *stringp, *next;
143
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900144 /* do not return the unwanted extra line at EOF */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200145 if (!orig || *orig == '\0')
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900146 return NULL;
147
Wolfram Sang6020db52020-07-26 23:44:19 +0200148 /* don't use strsep here, it is not available everywhere */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200149 next = strchr(orig, '\n');
150 if (next)
151 *next++ = '\0';
152
153 *stringp = next;
154
155 return orig;
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900156}
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158/* A list of all modules we processed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159static struct module *modules;
160
Masahiro Yamada8b185742018-05-09 18:50:40 +0900161static struct module *find_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162{
163 struct module *mod;
164
165 for (mod = modules; mod; mod = mod->next)
166 if (strcmp(mod->name, modname) == 0)
167 break;
168 return mod;
169}
170
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030171static struct module *new_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
173 struct module *mod;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100174
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900175 mod = NOFAIL(malloc(sizeof(*mod) + strlen(modname) + 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 memset(mod, 0, sizeof(*mod));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178 /* add to list */
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900179 strcpy(mod->name, modname);
Masahiro Yamada4de7b622020-06-01 14:57:30 +0900180 mod->is_vmlinux = (strcmp(modname, "vmlinux") == 0);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200181 mod->gpl_compatible = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 mod->next = modules;
183 modules = mod;
184
185 return mod;
186}
187
188/* A hash of all exported symbols,
189 * struct symbol is also used for lists of unresolved symbols */
190
191#define SYMBOL_HASH_SIZE 1024
192
193struct symbol {
194 struct symbol *next;
195 struct module *module;
196 unsigned int crc;
197 int crc_valid;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900198 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 unsigned int weak:1;
Denis Efremov15bfc232019-08-01 09:06:57 +0300200 unsigned int is_static:1; /* 1 if symbol is not global */
Ram Paibd5cbce2006-06-08 22:12:53 -0700201 enum export export; /* Type of export */
Gustavo A. R. Silva859c8172020-05-07 13:56:01 -0500202 char name[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203};
204
205static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
206
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +0530207/* This is based on the hash algorithm from gdbm, via tdb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208static inline unsigned int tdb_hash(const char *name)
209{
210 unsigned value; /* Used to compute the hash value. */
211 unsigned i; /* Used to cycle through random values. */
212
213 /* Set the initial value from the key size. */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100214 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
216
217 return (1103515243 * value + 12345);
218}
219
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100220/**
221 * Allocate a new symbols for use in the hash of exported symbols or
222 * the list of unresolved symbols per module
223 **/
224static struct symbol *alloc_symbol(const char *name, unsigned int weak,
225 struct symbol *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
227 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
228
229 memset(s, 0, sizeof(*s));
230 strcpy(s->name, name);
231 s->weak = weak;
232 s->next = next;
Denis Efremov15bfc232019-08-01 09:06:57 +0300233 s->is_static = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 return s;
235}
236
237/* For the hash of exported symbols */
Ram Paibd5cbce2006-06-08 22:12:53 -0700238static struct symbol *new_symbol(const char *name, struct module *module,
239 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
241 unsigned int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900244 symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
245
246 return symbolhash[hash];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247}
248
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100249static struct symbol *find_symbol(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250{
251 struct symbol *s;
252
253 /* For our purposes, .foo matches foo. PPC64 needs this. */
254 if (name[0] == '.')
255 name++;
256
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100257 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 if (strcmp(s->name, name) == 0)
259 return s;
260 }
261 return NULL;
262}
263
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100264static bool contains_namespace(struct namespace_list *list,
265 const char *namespace)
266{
Masahiro Yamada76b54cf2019-10-29 21:38:09 +0900267 for (; list; list = list->next)
268 if (!strcmp(list->namespace, namespace))
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100269 return true;
270
271 return false;
272}
273
274static void add_namespace(struct namespace_list **list, const char *namespace)
275{
276 struct namespace_list *ns_entry;
277
278 if (!contains_namespace(*list, namespace)) {
279 ns_entry = NOFAIL(malloc(sizeof(struct namespace_list) +
280 strlen(namespace) + 1));
281 strcpy(ns_entry->namespace, namespace);
282 ns_entry->next = *list;
283 *list = ns_entry;
284 }
285}
286
287static bool module_imports_namespace(struct module *module,
288 const char *namespace)
289{
290 return contains_namespace(module->imported_namespaces, namespace);
291}
292
Mathias Krause7a3ee752014-08-27 20:28:53 +0930293static const struct {
Ram Paibd5cbce2006-06-08 22:12:53 -0700294 const char *str;
295 enum export export;
296} export_list[] = {
297 { .str = "EXPORT_SYMBOL", .export = export_plain },
298 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
Ram Paibd5cbce2006-06-08 22:12:53 -0700299 { .str = "(unknown)", .export = export_unknown },
300};
301
302
303static const char *export_str(enum export ex)
304{
305 return export_list[ex].str;
306}
307
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100308static enum export export_no(const char *s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700309{
310 int i;
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100311
Sam Ravnborg534b89a2006-07-01 10:10:19 +0200312 if (!s)
313 return export_unknown;
Ram Paibd5cbce2006-06-08 22:12:53 -0700314 for (i = 0; export_list[i].export != export_unknown; i++) {
315 if (strcmp(export_list[i].str, s) == 0)
316 return export_list[i].export;
317 }
318 return export_unknown;
319}
320
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900321static void *sym_get_data_by_offset(const struct elf_info *info,
322 unsigned int secindex, unsigned long offset)
Masahiro Yamada6124c042017-09-06 16:19:05 -0700323{
Xiao Yang4b8a5cf2020-03-18 18:34:16 +0800324 Elf_Shdr *sechdr = &info->sechdrs[secindex];
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900325
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900326 if (info->hdr->e_type != ET_REL)
327 offset -= sechdr->sh_addr;
328
329 return (void *)info->hdr + sechdr->sh_offset + offset;
330}
331
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900332static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
333{
334 return sym_get_data_by_offset(info, get_secindex(info, sym),
335 sym->st_value);
336}
337
Masahiro Yamada565587d2020-05-25 14:47:05 +0900338static const char *sech_name(const struct elf_info *info, Elf_Shdr *sechdr)
339{
340 return sym_get_data_by_offset(info, info->secindex_strings,
341 sechdr->sh_name);
342}
343
344static const char *sec_name(const struct elf_info *info, int secindex)
345{
346 return sech_name(info, &info->sechdrs[secindex]);
347}
348
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200349#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
350
351static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
352{
353 const char *secname = sec_name(elf, sec);
354
355 if (strstarts(secname, "___ksymtab+"))
356 return export_plain;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200357 else if (strstarts(secname, "___ksymtab_gpl+"))
358 return export_gpl;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200359 else
360 return export_unknown;
361}
362
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200363static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700364{
365 if (sec == elf->export_sec)
366 return export_plain;
367 else if (sec == elf->export_gpl_sec)
368 return export_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700369 else
370 return export_unknown;
371}
372
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900373static const char *namespace_from_kstrtabns(const struct elf_info *info,
374 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100375{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900376 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100377 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100378}
379
Matthias Maennicha2b11182019-10-18 10:31:40 +0100380static void sym_update_namespace(const char *symname, const char *namespace)
381{
382 struct symbol *s = find_symbol(symname);
383
384 /*
385 * That symbol should have been created earlier and thus this is
386 * actually an assertion.
387 */
388 if (!s) {
Masahiro Yamadabc72d722020-12-01 19:34:14 +0900389 error("Could not update namespace(%s) for symbol %s\n",
390 namespace, symname);
Matthias Maennicha2b11182019-10-18 10:31:40 +0100391 return;
392 }
393
394 free(s->namespace);
395 s->namespace =
396 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
397}
398
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100399/**
400 * Add an exported symbol - it may have already been added without a
401 * CRC, in this case just update the CRC
402 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100403static struct symbol *sym_add_exported(const char *name, struct module *mod,
404 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405{
406 struct symbol *s = find_symbol(name);
407
408 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700409 s = new_symbol(name, mod, export);
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900410 } else if (!external_module || s->module->is_vmlinux ||
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900411 s->module == mod) {
412 warn("%s: '%s' exported twice. Previous export was in %s%s\n",
413 mod->name, name, s->module->name,
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900414 s->module->is_vmlinux ? "" : ".ko");
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900415 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900417
418 s->module = mod;
Ram Paibd5cbce2006-06-08 22:12:53 -0700419 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100420 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421}
422
Masahiro Yamada17436942019-11-15 02:42:24 +0900423static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100424{
425 struct symbol *s = find_symbol(name);
426
Masahiro Yamada17436942019-11-15 02:42:24 +0900427 /*
428 * Ignore stand-alone __crc_*, which might be auto-generated symbols
429 * such as __*_veneer in ARM ELF.
430 */
431 if (!s)
432 return;
433
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100434 s->crc = crc;
435 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436}
437
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900438static void *grab_file(const char *filename, size_t *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439{
440 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930441 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 int fd;
443
444 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930445 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930447 if (fstat(fd, &st))
448 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
450 *size = st.st_size;
451 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930453failed:
454 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 if (map == MAP_FAILED)
456 return NULL;
457 return map;
458}
459
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900460static void release_file(void *file, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461{
462 munmap(file, size);
463}
464
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100465static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466{
467 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100468 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 Elf_Shdr *sechdrs;
470 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200471 const char *secstrings;
472 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
474 hdr = grab_file(filename, &info->size);
475 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930476 if (ignore_missing_files) {
477 fprintf(stderr, "%s: %s (ignored)\n", filename,
478 strerror(errno));
479 return 0;
480 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200482 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 }
484 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100485 if (info->size < sizeof(*hdr)) {
486 /* file too small, assume this is an empty .o file */
487 return 0;
488 }
489 /* Is this a valid ELF file? */
490 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
491 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
492 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
493 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
494 /* Not an ELF file - silently ignore it */
495 return 0;
496 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200498 hdr->e_type = TO_NATIVE(hdr->e_type);
499 hdr->e_machine = TO_NATIVE(hdr->e_machine);
500 hdr->e_version = TO_NATIVE(hdr->e_version);
501 hdr->e_entry = TO_NATIVE(hdr->e_entry);
502 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
503 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
504 hdr->e_flags = TO_NATIVE(hdr->e_flags);
505 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
506 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
507 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
508 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
509 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
510 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 sechdrs = (void *)hdr + hdr->e_shoff;
512 info->sechdrs = sechdrs;
513
Petr Stetiara83710e2007-08-27 12:15:07 +0200514 /* Check if file offset is correct */
515 if (hdr->e_shoff > info->size) {
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900516 fatal("section header offset=%lu in file '%s' is bigger than filesize=%zu\n",
517 (unsigned long)hdr->e_shoff, filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200518 return 0;
519 }
520
Anders Kaseorg68457562011-05-19 16:55:27 -0600521 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200522 /*
523 * There are more than 64k sections,
524 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200525 */
526 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
527 }
528 else {
529 info->num_sections = hdr->e_shnum;
530 }
531 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600532 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200533 }
534 else {
535 info->secindex_strings = hdr->e_shstrndx;
536 }
537
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200539 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200540 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
541 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
542 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
543 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
544 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
545 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
546 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
547 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
548 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
549 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 }
551 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200552 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
553 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700554 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900555 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Tejun Heo56fc82c2009-02-06 00:48:02 +0900557 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100558 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
559 "sizeof(*hrd)=%zu\n", filename,
560 (unsigned long)sechdrs[i].sh_offset,
561 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100562 return 0;
563 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700564 secname = secstrings + sechdrs[i].sh_name;
565 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900566 if (nobits)
567 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
569 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700570 } else if (strcmp(secname, "__ksymtab") == 0)
571 info->export_sec = i;
572 else if (strcmp(secname, "__ksymtab_gpl") == 0)
573 info->export_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700574
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200575 if (sechdrs[i].sh_type == SHT_SYMTAB) {
576 unsigned int sh_link_idx;
577 symtab_idx = i;
578 info->symtab_start = (void *)hdr +
579 sechdrs[i].sh_offset;
580 info->symtab_stop = (void *)hdr +
581 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600582 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200583 info->strtab = (void *)hdr +
584 sechdrs[sh_link_idx].sh_offset;
585 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200587 /* 32bit section no. table? ("more than 64k sections") */
588 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
589 symtab_shndx_idx = i;
590 info->symtab_shndx_start = (void *)hdr +
591 sechdrs[i].sh_offset;
592 info->symtab_shndx_stop = (void *)hdr +
593 sechdrs[i].sh_offset + sechdrs[i].sh_size;
594 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100596 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100597 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 /* Fix endianness in symbols */
600 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
601 sym->st_shndx = TO_NATIVE(sym->st_shndx);
602 sym->st_name = TO_NATIVE(sym->st_name);
603 sym->st_value = TO_NATIVE(sym->st_value);
604 sym->st_size = TO_NATIVE(sym->st_size);
605 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200606
607 if (symtab_shndx_idx != ~0U) {
608 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600609 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200610 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600611 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200612 symtab_idx);
613 /* Fix endianness */
614 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
615 p++)
616 *p = TO_NATIVE(*p);
617 }
618
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100619 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620}
621
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100622static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623{
624 release_file(info->hdr, info->size);
625}
626
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200627static int ignore_undef_symbol(struct elf_info *info, const char *symname)
628{
629 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900630 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200631 return 1;
632 /* ignore global offset table */
633 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
634 return 1;
635 if (info->hdr->e_machine == EM_PPC)
636 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900637 if (strstarts(symname, "_restgpr_") ||
638 strstarts(symname, "_savegpr_") ||
639 strstarts(symname, "_rest32gpr_") ||
640 strstarts(symname, "_save32gpr_") ||
641 strstarts(symname, "_restvr_") ||
642 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200643 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000644 if (info->hdr->e_machine == EM_PPC64)
645 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900646 if (strstarts(symname, "_restgpr0_") ||
647 strstarts(symname, "_savegpr0_") ||
648 strstarts(symname, "_restvr_") ||
649 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100650 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000651 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200652 /* Do not ignore this symbol */
653 return 0;
654}
655
Masahiro Yamada17436942019-11-15 02:42:24 +0900656static void handle_modversion(const struct module *mod,
657 const struct elf_info *info,
658 const Elf_Sym *sym, const char *symname)
659{
660 unsigned int crc;
661
662 if (sym->st_shndx == SHN_UNDEF) {
663 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n",
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900664 symname, mod->name, mod->is_vmlinux ? "" : ".ko");
Masahiro Yamada17436942019-11-15 02:42:24 +0900665 return;
666 }
667
668 if (sym->st_shndx == SHN_ABS) {
669 crc = sym->st_value;
670 } else {
671 unsigned int *crcp;
672
673 /* symbol points to the CRC in the ELF object */
674 crcp = sym_get_data(info, sym);
675 crc = TO_NATIVE(*crcp);
676 }
677 sym_set_crc(symname, crc);
678}
679
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900680static void handle_symbol(struct module *mod, struct elf_info *info,
681 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200683 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900684 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200685
Masahiro Yamada33795762020-06-01 14:57:24 +0900686 if (strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200687 export = export_from_secname(info, get_secindex(info, sym));
688 else
689 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
691 switch (sym->st_shndx) {
692 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900693 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100694 /* Should warn here, but modpost runs before the linker */
695 } else
696 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 case SHN_UNDEF:
699 /* undefined symbol */
700 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
701 ELF_ST_BIND(sym->st_info) != STB_WEAK)
702 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200703 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 if (info->hdr->e_machine == EM_SPARC ||
706 info->hdr->e_machine == EM_SPARCV9) {
707 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700708 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100710 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700711 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100712 munged[0] = '_';
713 munged[1] = toupper(munged[1]);
714 symname = munged;
715 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100717
Rusty Russellb92021b2013-03-15 15:04:17 +1030718 mod->unres = alloc_symbol(symname,
719 ELF_ST_BIND(sym->st_info) == STB_WEAK,
720 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 break;
722 default:
723 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900724 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100725 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100726 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900728 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900730 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 mod->has_cleanup = 1;
732 break;
733 }
734}
735
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100736/**
737 * Parse tag=value strings from .modinfo section
738 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739static char *next_string(char *string, unsigned long *secsize)
740{
741 /* Skip non-zero chars */
742 while (string[0]) {
743 string++;
744 if ((*secsize)-- <= 1)
745 return NULL;
746 }
747
748 /* Skip any zero padding. */
749 while (!string[0]) {
750 string++;
751 if ((*secsize)-- <= 1)
752 return NULL;
753 }
754 return string;
755}
756
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900757static char *get_next_modinfo(struct elf_info *info, const char *tag,
758 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759{
760 char *p;
761 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900762 char *modinfo = info->modinfo;
763 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900765 if (prev) {
766 size -= prev - modinfo;
767 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200768 }
769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 for (p = modinfo; p; p = next_string(p, &size)) {
771 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
772 return p + taglen + 1;
773 }
774 return NULL;
775}
776
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900777static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200778
779{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900780 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200781}
782
Sam Ravnborg93684d32006-02-19 11:53:35 +0100783/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100784 * Test if string s ends in string sub
785 * return 0 if match
786 **/
787static int strrcmp(const char *s, const char *sub)
788{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100789 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100790
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100791 if (!s || !sub)
792 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100793
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100794 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100795 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100796
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100797 if ((slen == 0) || (sublen == 0))
798 return 1;
799
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100800 if (sublen > slen)
801 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100802
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100803 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100804}
805
Sam Ravnborgff13f922008-01-23 19:54:27 +0100806static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
807{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100808 if (sym)
809 return elf->strtab + sym->st_name;
810 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100811 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100812}
813
Sam Ravnborg10668222008-01-13 22:21:31 +0100814/* The pattern is an array of simple patterns.
815 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100816 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100817 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930818 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100819 */
Trevor Keith5c725132009-09-22 16:43:38 -0700820static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100821{
822 const char *p;
823 while (*pat) {
824 p = *pat++;
825 const char *endp = p + strlen(p) - 1;
826
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930827 /* "*foo*" */
828 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300829 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
830 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930831
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930832 free(bare);
833 if (here != NULL)
834 return 1;
835 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100836 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930837 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100838 if (strrcmp(sym, p + 1) == 0)
839 return 1;
840 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100841 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100842 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100843 if (strncmp(sym, p, strlen(p) - 1) == 0)
844 return 1;
845 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100846 /* no wildcards */
847 else {
848 if (strcmp(p, sym) == 0)
849 return 1;
850 }
851 }
852 /* no match */
853 return 0;
854}
855
Sam Ravnborg10668222008-01-13 22:21:31 +0100856/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930857static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200858{
859 ".comment*",
860 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930861 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800862 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000863 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200864 ".mdebug*", /* alpha, score, mips etc. */
865 ".pdr", /* alpha, score, mips etc. */
866 ".stab*",
867 ".note*",
868 ".got*",
869 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400870 ".xt.prop", /* xtensa */
871 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030872 ".arcextmap*", /* arc */
873 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030874 ".cmem*", /* EZchip */
875 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100876 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600877 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200878 NULL
879};
Sam Ravnborg10668222008-01-13 22:21:31 +0100880
Sam Ravnborge241a632008-01-28 20:13:13 +0100881/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400882 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100883 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400884 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100885 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400886static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900887 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100888{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400889 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100890
Anders Kaseorgb614a692009-04-23 16:49:33 -0400891 if (sechdr->sh_type == SHT_PROGBITS &&
892 !(sechdr->sh_flags & SHF_ALLOC) &&
893 !match(sec, section_white_list)) {
894 warn("%s (%s): unexpected non-allocatable section.\n"
895 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
896 "Note that for example <linux/init.h> contains\n"
897 "section definitions for use in .S files.\n\n",
898 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100899 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100900}
901
902
903
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100904#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930905 ".init.setup", ".init.rodata", ".meminit.rodata", \
906 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100907#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930908 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100909
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100910#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930911 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100912#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930913 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100914
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200915#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930916 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
917 ".pci_fixup_enable", ".pci_fixup_resume", \
918 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200919
Paul Gortmakere24f6622013-06-19 19:30:48 -0400920#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
921#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100922
923#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
924#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100925
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930926#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930927#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Thomas Gleixner65538962020-03-09 22:47:17 +0100928 ".kprobes.text", ".cpuidle.text", ".noinstr.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930929#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400930 ".fixup", ".entry.text", ".exception.text", ".text.*", \
931 ".coldtext"
Sam Ravnborg10668222008-01-13 22:21:31 +0100932
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000933#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000934#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100935
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000936#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000937#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100938
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930939#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
940 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
941
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100942/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930943static const char *const init_data_sections[] =
944 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100945
946/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930947static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100948
949/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930950static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100951 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100952
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930953/* all text sections */
954static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
955
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100956/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930957static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100958
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100959
960/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100961#define DEFAULT_SYMBOL_WHITE_LIST \
962 "*driver", \
963 "*_template", /* scsi uses *_template a lot */ \
964 "*_timer", /* arm uses ops structures named _timer a lot */ \
965 "*_sht", /* scsi also used *_sht to some extent */ \
966 "*_ops", \
967 "*_probe", \
968 "*_probe_one", \
969 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100970
Mathias Krause7a3ee752014-08-27 20:28:53 +0930971static const char *const head_sections[] = { ".head.text*", NULL };
972static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100973 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930974static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100975
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100976enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100977 TEXT_TO_ANY_INIT,
978 DATA_TO_ANY_INIT,
979 TEXT_TO_ANY_EXIT,
980 DATA_TO_ANY_EXIT,
981 XXXINIT_TO_SOME_INIT,
982 XXXEXIT_TO_SOME_EXIT,
983 ANY_INIT_TO_ANY_EXIT,
984 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100985 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930986 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100987};
988
Quentin Casasnovase5d8f592015-04-13 20:55:15 +0930989/**
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +0530990 * Describe how to match sections on different criteria:
Quentin Casasnovase5d8f592015-04-13 20:55:15 +0930991 *
992 * @fromsec: Array of sections to be matched.
993 *
994 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
995 * this array is forbidden (black-list). Can be empty.
996 *
997 * @good_tosec: Relocations applied to a section in @fromsec must be
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +0530998 * targeting sections in this array (white-list). Can be empty.
Quentin Casasnovase5d8f592015-04-13 20:55:15 +0930999 *
1000 * @mismatch: Type of mismatch.
1001 *
1002 * @symbol_white_list: Do not match a relocation to a symbol in this list
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +05301003 * even if it is targeting a section in @bad_to_sec.
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301004 *
1005 * @handler: Specific handler to call when a match is found. If NULL,
1006 * default_mismatch_handler() will be called.
1007 *
1008 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001009struct sectioncheck {
1010 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301011 const char *bad_tosec[20];
1012 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001013 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001014 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301015 void (*handler)(const char *modname, struct elf_info *elf,
1016 const struct sectioncheck* const mismatch,
1017 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1018
Sam Ravnborg10668222008-01-13 22:21:31 +01001019};
1020
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301021static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1022 const struct sectioncheck* const mismatch,
1023 Elf_Rela *r, Elf_Sym *sym,
1024 const char *fromsec);
1025
Mathias Krause7a3ee752014-08-27 20:28:53 +09301026static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001027/* Do not reference init/exit code/data from
1028 * normal code and data
1029 */
1030{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001031 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301032 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001033 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001034 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001035},
1036{
1037 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301038 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001039 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001040 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001041},
1042{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001043 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301044 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001045 .mismatch = DATA_TO_ANY_INIT,
1046 .symbol_white_list = {
1047 "*_template", "*_timer", "*_sht", "*_ops",
1048 "*_probe", "*_probe_one", "*_console", NULL
1049 },
1050},
1051{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001052 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301053 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001054 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001055 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001056},
1057{
1058 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301059 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001060 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001061 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001062},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001063/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001064{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001065 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301066 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001067 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001068 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001069},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001070/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001071{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001072 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301073 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001074 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001075 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001076},
1077/* Do not use exit code/data from init code */
1078{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001079 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301080 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001081 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001082 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001083},
1084/* Do not use init code/data from exit code */
1085{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001086 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301087 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001088 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001089 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001090},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001091{
1092 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301093 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001094 .mismatch = ANY_INIT_TO_ANY_EXIT,
1095 .symbol_white_list = { NULL },
1096},
Sam Ravnborg10668222008-01-13 22:21:31 +01001097/* Do not export init/exit functions or data */
1098{
1099 .fromsec = { "__ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301100 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001101 .mismatch = EXPORT_TO_INIT_EXIT,
1102 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301103},
1104{
1105 .fromsec = { "__ex_table", NULL },
1106 /* If you're adding any new black-listed sections in here, consider
1107 * adding a special 'printer' for them in scripts/check_extable.
1108 */
1109 .bad_tosec = { ".altinstr_replacement", NULL },
1110 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1111 .mismatch = EXTABLE_TO_NON_TEXT,
1112 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001113}
1114};
1115
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001116static const struct sectioncheck *section_mismatch(
1117 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001118{
1119 int i;
1120 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1121 const struct sectioncheck *check = &sectioncheck[0];
1122
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301123 /*
1124 * The target section could be the SHT_NUL section when we're
1125 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001126 * doesn't make much sense and causes build failures on parisc
1127 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301128 */
1129 if (*tosec == '\0')
1130 return NULL;
1131
Sam Ravnborg10668222008-01-13 22:21:31 +01001132 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301133 if (match(fromsec, check->fromsec)) {
1134 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1135 return check;
1136 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1137 return check;
1138 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001139 check++;
1140 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001141 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001142}
1143
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001144/**
1145 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001146 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001147 * Pattern 1:
1148 * If a module parameter is declared __initdata and permissions=0
1149 * then this is legal despite the warning generated.
1150 * We cannot see value of permissions here, so just ignore
1151 * this pattern.
1152 * The pattern is identified by:
1153 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001154 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001155 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001156 *
Rusty Russell6a841522010-08-11 23:04:16 -06001157 * Pattern 1a:
1158 * module_param_call() ops can refer to __init set function if permissions=0
1159 * The pattern is identified by:
1160 * tosec = .init.text
1161 * fromsec = .data*
1162 * atsym = __param_ops_*
1163 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001164 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001165 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001166 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001167 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001168 * tosec = init or exit section
1169 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001170 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1171 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001172 *
1173 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001174 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001175 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001176 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001177 * Some symbols belong to init section but still it is ok to reference
1178 * these from non-init sections as these symbols don't have any memory
1179 * allocated for them and symbol address and value are same. So even
1180 * if init section is freed, its ok to reference those symbols.
1181 * For ex. symbols marking the init section boundaries.
1182 * This pattern is identified by
1183 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001184 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301185 * Pattern 5:
1186 * GCC may optimize static inlines when fed constant arg(s) resulting
1187 * in functions like cpumask_empty() -- generating an associated symbol
1188 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1189 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1190 * meaningless section warning. May need to add isra symbols too...
1191 * This pattern is identified by
1192 * tosec = init section
1193 * fromsec = text section
1194 * refsymname = *.constprop.*
1195 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001196 * Pattern 6:
1197 * Hide section mismatch warnings for ELF local symbols. The goal
1198 * is to eliminate false positive modpost warnings caused by
1199 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1200 * Autogenerated symbol names bypass modpost's "Pattern 2"
1201 * whitelisting, which relies on pattern-matching against symbol
1202 * names to work. (One situation where gcc can autogenerate ELF
1203 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001204 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001205static int secref_whitelist(const struct sectioncheck *mismatch,
1206 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001207 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001208{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001209 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001210 if (match(tosec, init_data_sections) &&
1211 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001212 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001213 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001214
Rusty Russell6a841522010-08-11 23:04:16 -06001215 /* Check for pattern 1a */
1216 if (strcmp(tosec, ".init.text") == 0 &&
1217 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001218 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001219 return 0;
1220
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001221 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001222 if (match(tosec, init_exit_sections) &&
1223 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001224 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001225 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001226
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001227 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001228 if (match(fromsec, head_sections) &&
1229 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001230 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001231
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001232 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001233 if (match(tosym, linker_symbols))
1234 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001235
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301236 /* Check for pattern 5 */
1237 if (match(fromsec, text_sections) &&
1238 match(tosec, init_sections) &&
1239 match(fromsym, optim_symbols))
1240 return 0;
1241
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001242 /* Check for pattern 6 */
1243 if (strstarts(fromsym, ".L"))
1244 return 0;
1245
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001246 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001247}
1248
Sami Tolvanen5818c682018-10-23 15:15:35 -07001249static inline int is_arm_mapping_symbol(const char *str)
1250{
1251 return str[0] == '$' && strchr("axtd", str[1])
1252 && (str[2] == '\0' || str[2] == '.');
1253}
1254
1255/*
1256 * If there's no name there, ignore it; likewise, ignore it if it's
1257 * one of the magic symbols emitted used by current ARM tools.
1258 *
1259 * Otherwise if find_symbols_between() returns those symbols, they'll
1260 * fail the whitelist tests and cause lots of false alarms ... fixable
1261 * only by merging __exit and __init sections into __text, bloating
1262 * the kernel (which is especially evil on embedded platforms).
1263 */
1264static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1265{
1266 const char *name = elf->strtab + sym->st_name;
1267
1268 if (!name || !strlen(name))
1269 return 0;
1270 return !is_arm_mapping_symbol(name);
1271}
1272
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001273/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001274 * Find symbol based on relocation record info.
1275 * In some cases the symbol supplied is a valid symbol so
1276 * return refsym. If st_name != 0 we assume this is a valid symbol.
1277 * In other cases the symbol needs to be looked up in the symbol table
1278 * based on section and address.
1279 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001280static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001281 Elf_Sym *relsym)
1282{
1283 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001284 Elf_Sym *near = NULL;
1285 Elf64_Sword distance = 20;
1286 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001287 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001288
1289 if (relsym->st_name != 0)
1290 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001291
1292 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001293 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001294 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001295 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001296 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1297 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001298 if (!is_valid_name(elf, sym))
1299 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001300 if (sym->st_value == addr)
1301 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001302 /* Find a symbol nearby - addr are maybe negative */
1303 d = sym->st_value - addr;
1304 if (d < 0)
1305 d = addr - sym->st_value;
1306 if (d < distance) {
1307 distance = d;
1308 near = sym;
1309 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001310 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001311 /* We need a close match */
1312 if (distance < 20)
1313 return near;
1314 else
1315 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001316}
1317
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001318/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001319 * Find symbols before or equal addr and after addr - in the section sec.
1320 * If we find two symbols with equal offset prefer one with a valid name.
1321 * The ELF format may have a better way to detect what type of symbol
1322 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001323 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001324static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1325 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001326{
1327 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001328 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001329 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001330
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001331 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1332 const char *symsec;
1333
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001334 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001335 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001336 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001337 if (strcmp(symsec, sec) != 0)
1338 continue;
David Brownellda68d612007-02-20 13:58:16 -08001339 if (!is_valid_name(elf, sym))
1340 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001341 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001342 if ((addr - sym->st_value) < distance) {
1343 distance = addr - sym->st_value;
1344 near = sym;
1345 } else if ((addr - sym->st_value) == distance) {
1346 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001347 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001348 }
1349 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001350 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001351}
1352
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001353/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001354 * Convert a section name to the function/data attribute
1355 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001356 * .memexitconst => __memconst
1357 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001358 *
1359 * The memory of returned value has been allocated on a heap. The user of this
1360 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001361*/
1362static char *sec2annotation(const char *s)
1363{
1364 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001365 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001366 char *r = p;
1367
1368 *p++ = '_';
1369 *p++ = '_';
1370 if (*s == '.')
1371 s++;
1372 while (*s && *s != '.')
1373 *p++ = *s++;
1374 *p = '\0';
1375 if (*s == '.')
1376 s++;
1377 if (strstr(s, "rodata") != NULL)
1378 strcat(p, "const ");
1379 else if (strstr(s, "data") != NULL)
1380 strcat(p, "data ");
1381 else
1382 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001383 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001384 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001385 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001386 }
1387}
1388
1389static int is_function(Elf_Sym *sym)
1390{
1391 if (sym)
1392 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1393 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001394 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001395}
1396
Randy Dunlap00759c02011-03-15 14:13:47 -07001397static void print_section_list(const char * const list[20])
1398{
1399 const char *const *s = list;
1400
1401 while (*s) {
1402 fprintf(stderr, "%s", *s);
1403 s++;
1404 if (*s)
1405 fprintf(stderr, ", ");
1406 }
1407 fprintf(stderr, "\n");
1408}
1409
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301410static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1411{
1412 switch (is_func) {
1413 case 0: *name = "variable"; *name_p = ""; break;
1414 case 1: *name = "function"; *name_p = "()"; break;
1415 default: *name = "(unknown reference)"; *name_p = ""; break;
1416 }
1417}
1418
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001419/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001420 * Print a warning about a section mismatch.
1421 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001422 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001423 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001424static void report_sec_mismatch(const char *modname,
1425 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001426 const char *fromsec,
1427 unsigned long long fromaddr,
1428 const char *fromsym,
1429 int from_is_func,
1430 const char *tosec, const char *tosym,
1431 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001432{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001433 const char *from, *from_p;
1434 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001435 char *prl_from;
1436 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001437
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001438 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001439
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301440 get_pretty_name(from_is_func, &from, &from_p);
1441 get_pretty_name(to_is_func, &to, &to_p);
1442
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001443 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1444 "to the %s %s:%s%s\n",
1445 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1446 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001447
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001448 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001449 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001450 prl_from = sec2annotation(fromsec);
1451 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001452 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001453 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001454 "the %s %s%s%s.\n"
1455 "This is often because %s lacks a %s\n"
1456 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001457 prl_from, fromsym,
1458 to, prl_to, tosym, to_p,
1459 fromsym, prl_to, tosym);
1460 free(prl_from);
1461 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001462 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001463 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001464 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001465 fprintf(stderr,
1466 "The variable %s references\n"
1467 "the %s %s%s%s\n"
1468 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001469 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001470 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001471 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001472 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001473 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001474 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001475 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001476 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001477 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001478 fprintf(stderr,
1479 "The function %s() references a %s in an exit section.\n"
1480 "Often the %s %s%s has valid usage outside the exit section\n"
1481 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001482 fromsym, to, to, tosym, to_p, prl_to, tosym);
1483 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001484 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001485 case DATA_TO_ANY_EXIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001486 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001487 fprintf(stderr,
1488 "The variable %s references\n"
1489 "the %s %s%s%s\n"
1490 "If the reference is valid then annotate the\n"
1491 "variable with __exit* (see linux/init.h) or "
1492 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001493 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001494 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001495 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001496 break;
1497 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001498 case XXXINIT_TO_SOME_INIT:
1499 case XXXEXIT_TO_SOME_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001500 prl_from = sec2annotation(fromsec);
1501 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001502 fprintf(stderr,
1503 "The %s %s%s%s references\n"
1504 "a %s %s%s%s.\n"
1505 "If %s is only used by %s then\n"
1506 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001507 from, prl_from, fromsym, from_p,
1508 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001509 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001510 free(prl_from);
1511 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001512 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001513 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001514 prl_from = sec2annotation(fromsec);
1515 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001516 fprintf(stderr,
1517 "The %s %s%s%s references\n"
1518 "a %s %s%s%s.\n"
1519 "This is often seen when error handling "
1520 "in the init function\n"
1521 "uses functionality in the exit path.\n"
1522 "The fix is often to remove the %sannotation of\n"
1523 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001524 from, prl_from, fromsym, from_p,
1525 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001526 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001527 free(prl_from);
1528 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001529 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001530 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001531 prl_from = sec2annotation(fromsec);
1532 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001533 fprintf(stderr,
1534 "The %s %s%s%s references\n"
1535 "a %s %s%s%s.\n"
1536 "This is often seen when error handling "
1537 "in the exit function\n"
1538 "uses functionality in the init path.\n"
1539 "The fix is often to remove the %sannotation of\n"
1540 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001541 from, prl_from, fromsym, from_p,
1542 to, prl_to, tosym, to_p,
1543 prl_to, tosym, to_p);
1544 free(prl_from);
1545 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001546 break;
1547 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001548 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001549 fprintf(stderr,
1550 "The symbol %s is exported and annotated %s\n"
1551 "Fix this by removing the %sannotation of %s "
1552 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001553 tosym, prl_to, prl_to, tosym);
1554 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001555 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301556 case EXTABLE_TO_NON_TEXT:
1557 fatal("There's a special handler for this mismatch type, "
1558 "we should never get here.");
1559 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001560 }
1561 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001562}
1563
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301564static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1565 const struct sectioncheck* const mismatch,
1566 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1567{
1568 const char *tosec;
1569 Elf_Sym *to;
1570 Elf_Sym *from;
1571 const char *tosym;
1572 const char *fromsym;
1573
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301574 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1575 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301576
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001577 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301578 return;
1579
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301580 tosec = sec_name(elf, get_secindex(elf, sym));
1581 to = find_elf_symbol(elf, r->r_addend, sym);
1582 tosym = sym_name(elf, to);
1583
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301584 /* check whitelist - we may ignore it */
1585 if (secref_whitelist(mismatch,
1586 fromsec, fromsym, tosec, tosym)) {
1587 report_sec_mismatch(modname, mismatch,
1588 fromsec, r->r_offset, fromsym,
1589 is_function(from), tosec, tosym,
1590 is_function(to));
1591 }
1592}
1593
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301594static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1595{
1596 if (section_index > elf->num_sections)
1597 fatal("section_index is outside elf->num_sections!\n");
1598
1599 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1600}
1601
1602/*
1603 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1604 * to know the sizeof(struct exception_table_entry) for the target architecture.
1605 */
1606static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301607static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301608{
1609 /*
1610 * If we're currently checking the second relocation within __ex_table,
1611 * that relocation offset tells us the offsetof(struct
1612 * exception_table_entry, fixup) which is equal to sizeof(struct
1613 * exception_table_entry) divided by two. We use that to our advantage
1614 * since there's no portable way to get that size as every architecture
1615 * seems to go with different sized types. Not pretty but better than
1616 * hard-coding the size for every architecture..
1617 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301618 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301619 extable_entry_size = r->r_offset * 2;
1620}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301621
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301622static inline bool is_extable_fault_address(Elf_Rela *r)
1623{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301624 /*
1625 * extable_entry_size is only discovered after we've handled the
1626 * _second_ relocation in __ex_table, so only abort when we're not
1627 * handling the first reloc and extable_entry_size is zero.
1628 */
1629 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301630 fatal("extable_entry size hasn't been discovered!\n");
1631
1632 return ((r->r_offset == 0) ||
1633 (r->r_offset % extable_entry_size == 0));
1634}
1635
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301636#define is_second_extable_reloc(Start, Cur, Sec) \
1637 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1638
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301639static void report_extable_warnings(const char* modname, struct elf_info* elf,
1640 const struct sectioncheck* const mismatch,
1641 Elf_Rela* r, Elf_Sym* sym,
1642 const char* fromsec, const char* tosec)
1643{
1644 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1645 const char* fromsym_name = sym_name(elf, fromsym);
1646 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1647 const char* tosym_name = sym_name(elf, tosym);
1648 const char* from_pretty_name;
1649 const char* from_pretty_name_p;
1650 const char* to_pretty_name;
1651 const char* to_pretty_name_p;
1652
1653 get_pretty_name(is_function(fromsym),
1654 &from_pretty_name, &from_pretty_name_p);
1655 get_pretty_name(is_function(tosym),
1656 &to_pretty_name, &to_pretty_name_p);
1657
1658 warn("%s(%s+0x%lx): Section mismatch in reference"
1659 " from the %s %s%s to the %s %s:%s%s\n",
1660 modname, fromsec, (long)r->r_offset, from_pretty_name,
1661 fromsym_name, from_pretty_name_p,
1662 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1663
1664 if (!match(tosec, mismatch->bad_tosec) &&
1665 is_executable_section(elf, get_secindex(elf, sym)))
1666 fprintf(stderr,
1667 "The relocation at %s+0x%lx references\n"
1668 "section \"%s\" which is not in the list of\n"
1669 "authorized sections. If you're adding a new section\n"
1670 "and/or if this reference is valid, add \"%s\" to the\n"
1671 "list of authorized sections to jump to on fault.\n"
1672 "This can be achieved by adding \"%s\" to \n"
1673 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1674 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1675}
1676
1677static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1678 const struct sectioncheck* const mismatch,
1679 Elf_Rela* r, Elf_Sym* sym,
1680 const char *fromsec)
1681{
1682 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1683
1684 sec_mismatch_count++;
1685
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001686 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301687
1688 if (match(tosec, mismatch->bad_tosec))
1689 fatal("The relocation at %s+0x%lx references\n"
1690 "section \"%s\" which is black-listed.\n"
1691 "Something is seriously wrong and should be fixed.\n"
1692 "You might get more information about where this is\n"
1693 "coming from by using scripts/check_extable.sh %s\n",
1694 fromsec, (long)r->r_offset, tosec, modname);
1695 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1696 if (is_extable_fault_address(r))
1697 fatal("The relocation at %s+0x%lx references\n"
1698 "section \"%s\" which is not executable, IOW\n"
1699 "it is not possible for the kernel to fault\n"
1700 "at that address. Something is seriously wrong\n"
1701 "and should be fixed.\n",
1702 fromsec, (long)r->r_offset, tosec);
1703 else
1704 fatal("The relocation at %s+0x%lx references\n"
1705 "section \"%s\" which is not executable, IOW\n"
1706 "the kernel will fault if it ever tries to\n"
1707 "jump to it. Something is seriously wrong\n"
1708 "and should be fixed.\n",
1709 fromsec, (long)r->r_offset, tosec);
1710 }
1711}
1712
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001713static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001714 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001715{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001716 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301717 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001718
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001719 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301720 if (mismatch->handler)
1721 mismatch->handler(modname, elf, mismatch,
1722 r, sym, fromsec);
1723 else
1724 default_mismatch_handler(modname, elf, mismatch,
1725 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001726 }
1727}
1728
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001729static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001730 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001731{
Masahiro Yamadad2e4d052020-05-25 14:47:04 +09001732 return sym_get_data_by_offset(elf, sechdr->sh_info, r->r_offset);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001733}
1734
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001735static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001736{
1737 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001738 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001739
1740 switch (r_typ) {
1741 case R_386_32:
1742 r->r_addend = TO_NATIVE(*location);
1743 break;
1744 case R_386_PC32:
1745 r->r_addend = TO_NATIVE(*location) + 4;
1746 /* For CONFIG_RELOCATABLE=y */
1747 if (elf->hdr->e_type == ET_EXEC)
1748 r->r_addend += r->r_offset;
1749 break;
1750 }
1751 return 0;
1752}
1753
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001754#ifndef R_ARM_CALL
1755#define R_ARM_CALL 28
1756#endif
1757#ifndef R_ARM_JUMP24
1758#define R_ARM_JUMP24 29
1759#endif
1760
David A. Longc9698e52014-02-14 22:41:18 +01001761#ifndef R_ARM_THM_CALL
1762#define R_ARM_THM_CALL 10
1763#endif
1764#ifndef R_ARM_THM_JUMP24
1765#define R_ARM_THM_JUMP24 30
1766#endif
1767#ifndef R_ARM_THM_JUMP19
1768#define R_ARM_THM_JUMP19 51
1769#endif
1770
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001771static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001772{
1773 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1774
1775 switch (r_typ) {
1776 case R_ARM_ABS32:
1777 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001778 r->r_addend = (int)(long)
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001779 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001780 break;
1781 case R_ARM_PC24:
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001782 case R_ARM_CALL:
1783 case R_ARM_JUMP24:
David A. Longc9698e52014-02-14 22:41:18 +01001784 case R_ARM_THM_CALL:
1785 case R_ARM_THM_JUMP24:
1786 case R_ARM_THM_JUMP19:
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001787 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001788 r->r_addend = (int)(long)(elf->hdr +
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001789 sechdr->sh_offset +
1790 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001791 break;
1792 default:
1793 return 1;
1794 }
1795 return 0;
1796}
1797
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001798static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001799{
1800 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001801 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001802 unsigned int inst;
1803
1804 if (r_typ == R_MIPS_HI16)
1805 return 1; /* skip this */
1806 inst = TO_NATIVE(*location);
1807 switch (r_typ) {
1808 case R_MIPS_LO16:
1809 r->r_addend = inst & 0xffff;
1810 break;
1811 case R_MIPS_26:
1812 r->r_addend = (inst & 0x03ffffff) << 2;
1813 break;
1814 case R_MIPS_32:
1815 r->r_addend = inst;
1816 break;
1817 }
1818 return 0;
1819}
1820
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001821static void section_rela(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001822 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001823{
1824 Elf_Sym *sym;
1825 Elf_Rela *rela;
1826 Elf_Rela r;
1827 unsigned int r_sym;
1828 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001829
Sam Ravnborgff13f922008-01-23 19:54:27 +01001830 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001831 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1832
Sam Ravnborgff13f922008-01-23 19:54:27 +01001833 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001834 fromsec += strlen(".rela");
1835 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001836 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001837 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001838
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001839 for (rela = start; rela < stop; rela++) {
1840 r.r_offset = TO_NATIVE(rela->r_offset);
1841#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001842 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001843 unsigned int r_typ;
1844 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1845 r_sym = TO_NATIVE(r_sym);
1846 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1847 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1848 } else {
1849 r.r_info = TO_NATIVE(rela->r_info);
1850 r_sym = ELF_R_SYM(r.r_info);
1851 }
1852#else
1853 r.r_info = TO_NATIVE(rela->r_info);
1854 r_sym = ELF_R_SYM(r.r_info);
1855#endif
1856 r.r_addend = TO_NATIVE(rela->r_addend);
1857 sym = elf->symtab_start + r_sym;
1858 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001859 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001860 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301861 if (is_second_extable_reloc(start, rela, fromsec))
1862 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001863 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001864 }
1865}
1866
1867static void section_rel(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001868 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001869{
1870 Elf_Sym *sym;
1871 Elf_Rel *rel;
1872 Elf_Rela r;
1873 unsigned int r_sym;
1874 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001875
Sam Ravnborgff13f922008-01-23 19:54:27 +01001876 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001877 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1878
Sam Ravnborgff13f922008-01-23 19:54:27 +01001879 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001880 fromsec += strlen(".rel");
1881 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001882 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001883 return;
1884
1885 for (rel = start; rel < stop; rel++) {
1886 r.r_offset = TO_NATIVE(rel->r_offset);
1887#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001888 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001889 unsigned int r_typ;
1890 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1891 r_sym = TO_NATIVE(r_sym);
1892 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1893 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1894 } else {
1895 r.r_info = TO_NATIVE(rel->r_info);
1896 r_sym = ELF_R_SYM(r.r_info);
1897 }
1898#else
1899 r.r_info = TO_NATIVE(rel->r_info);
1900 r_sym = ELF_R_SYM(r.r_info);
1901#endif
1902 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001903 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001904 case EM_386:
1905 if (addend_386_rel(elf, sechdr, &r))
1906 continue;
1907 break;
1908 case EM_ARM:
1909 if (addend_arm_rel(elf, sechdr, &r))
1910 continue;
1911 break;
1912 case EM_MIPS:
1913 if (addend_mips_rel(elf, sechdr, &r))
1914 continue;
1915 break;
1916 }
1917 sym = elf->symtab_start + r_sym;
1918 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001919 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001920 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301921 if (is_second_extable_reloc(start, rel, fromsec))
1922 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001923 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001924 }
1925}
1926
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001927/**
1928 * A module includes a number of sections that are discarded
1929 * either when loaded or when used as built-in.
1930 * For loaded modules all functions marked __init and all data
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001931 * marked __initdata will be discarded when the module has been initialized.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001932 * Likewise for modules used built-in the sections marked __exit
1933 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001934 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001935 * The check_sec_ref() function traverses all relocation records
1936 * to find all references to a section that reference a section that will
1937 * be discarded and warns about it.
1938 **/
1939static void check_sec_ref(struct module *mod, const char *modname,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001940 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001941{
1942 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001943 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001944
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001945 /* Walk through all sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001946 for (i = 0; i < elf->num_sections; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001947 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001948 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001949 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001950 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001951 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001952 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001953 }
1954}
1955
Andi Kleen7d02b492014-02-08 09:01:12 +01001956static char *remove_dot(char *s)
1957{
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301958 size_t n = strcspn(s, ".");
Andi Kleen7d02b492014-02-08 09:01:12 +01001959
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301960 if (n && s[n]) {
1961 size_t m = strspn(s + n + 1, "0123456789");
1962 if (m && (s[n + m] == '.' || s[n + m] == 0))
Andi Kleen7d02b492014-02-08 09:01:12 +01001963 s[n] = 0;
Sami Tolvanen7ac204b2020-12-11 10:46:27 -08001964
1965 /* strip trailing .lto */
1966 if (strends(s, ".lto"))
1967 s[strlen(s) - 4] = '\0';
Andi Kleen7d02b492014-02-08 09:01:12 +01001968 }
1969 return s;
1970}
1971
Masahiro Yamada8b185742018-05-09 18:50:40 +09001972static void read_symbols(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973{
1974 const char *symname;
1975 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001976 char *license;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01001977 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 struct module *mod;
1979 struct elf_info info = { };
1980 Elf_Sym *sym;
1981
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01001982 if (!parse_elf(&info, modname))
1983 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09001985 {
1986 char *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09001988 /* strip trailing .o */
1989 tmp = NOFAIL(strdup(modname));
1990 tmp[strlen(tmp) - 2] = '\0';
Sami Tolvanen7ac204b2020-12-11 10:46:27 -08001991 /* strip trailing .lto */
1992 if (strends(tmp, ".lto"))
1993 tmp[strlen(tmp) - 4] = '\0';
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09001994 mod = new_module(tmp);
1995 free(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 }
1997
Masahiro Yamada5a438af2020-06-01 14:57:26 +09001998 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09001999 license = get_modinfo(&info, "license");
2000 if (!license)
Masahiro Yamada1d6cd3922020-12-01 19:34:16 +09002001 error("missing MODULE_LICENSE() in %s\n", modname);
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002002 while (license) {
2003 if (license_is_gpl_compatible(license))
2004 mod->gpl_compatible = 1;
2005 else {
2006 mod->gpl_compatible = 0;
2007 break;
2008 }
2009 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002010 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002011
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002012 namespace = get_modinfo(&info, "import_ns");
2013 while (namespace) {
2014 add_namespace(&mod->imported_namespaces, namespace);
2015 namespace = get_next_modinfo(&info, "import_ns",
2016 namespace);
2017 }
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002018 }
2019
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002021 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002023 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 handle_moddevtable(mod, &info, sym, symname);
2025 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002026
Matthias Maennich69923202019-10-18 10:31:42 +01002027 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2028 symname = remove_dot(info.strtab + sym->st_name);
2029
Masahiro Yamada17436942019-11-15 02:42:24 +09002030 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002031 if (strstarts(symname, "__kstrtabns_"))
2032 sym_update_namespace(symname + strlen("__kstrtabns_"),
2033 namespace_from_kstrtabns(&info,
2034 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002035
2036 if (strstarts(symname, "__crc_"))
2037 handle_modversion(mod, &info, sym,
2038 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002039 }
2040
Denis Efremov15bfc232019-08-01 09:06:57 +03002041 // check for static EXPORT_SYMBOL_* functions && global vars
2042 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2043 unsigned char bind = ELF_ST_BIND(sym->st_info);
2044
2045 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2046 struct symbol *s =
2047 find_symbol(remove_dot(info.strtab +
2048 sym->st_name));
2049
2050 if (s)
2051 s->is_static = 0;
2052 }
2053 }
2054
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002055 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002057 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002058 version = get_modinfo(&info, "version");
2059 if (version || all_versions)
2060 get_src_version(modname, mod->srcversion,
2061 sizeof(mod->srcversion) - 1);
2062 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063
2064 parse_elf_finish(&info);
2065
Rusty Russell8c8ef422009-03-31 13:05:34 -06002066 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 * never passed as an argument to an exported function, so
2068 * the automatic versioning doesn't pick it up, but it's really
2069 * important anyhow */
2070 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06002071 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072}
2073
Rusty Russell712f9b42013-04-04 17:37:38 +10302074static void read_symbols_from_files(const char *filename)
2075{
2076 FILE *in = stdin;
2077 char fname[PATH_MAX];
2078
2079 if (strcmp(filename, "-") != 0) {
2080 in = fopen(filename, "r");
2081 if (!in)
2082 fatal("Can't open filenames file %s: %m", filename);
2083 }
2084
2085 while (fgets(fname, PATH_MAX, in) != NULL) {
2086 if (strends(fname, "\n"))
2087 fname[strlen(fname)-1] = '\0';
2088 read_symbols(fname);
2089 }
2090
2091 if (in != stdin)
2092 fclose(in);
2093}
2094
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095#define SZ 500
2096
2097/* We first write the generated file into memory using the
2098 * following helper, then compare to the file on disk and
2099 * only update the later if anything changed */
2100
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002101void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
2102 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103{
2104 char tmp[SZ];
2105 int len;
2106 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002107
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 va_start(ap, fmt);
2109 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002110 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 va_end(ap);
2112}
2113
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002114void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115{
2116 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002117 buf->size += len + SZ;
Randy Dunlap1f3aa902018-08-15 12:30:38 -07002118 buf->p = NOFAIL(realloc(buf->p, buf->size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 }
2120 strncpy(buf->p + buf->pos, s, len);
2121 buf->pos += len;
2122}
2123
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002124static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
2125{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002126 switch (exp) {
2127 case export_gpl:
Masahiro Yamadad6d692f2020-12-01 19:34:17 +09002128 error("GPL-incompatible module %s.ko uses GPL-only symbol '%s'\n",
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002129 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002130 break;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002131 case export_plain:
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002132 case export_unknown:
2133 /* ignore */
2134 break;
2135 }
2136}
2137
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002138static void check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002139{
2140 struct symbol *s, *exp;
2141
2142 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002143 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002144 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002145 if (!exp || exp->module == mod) {
Masahiro Yamada4475dff2021-03-26 03:54:11 +09002146 if (!s->weak && nr_unresolved++ < MAX_UNRESOLVED_REPORTS)
Jessica Yu93c95e52020-03-06 17:02:05 +01002147 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2148 "\"%s\" [%s.ko] undefined!\n",
2149 s->name, mod->name);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002150 continue;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002151 }
Andrew Morton6449bd62006-06-09 20:45:06 -07002152 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002153 if (basename)
2154 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002155 else
2156 basename = mod->name;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002157
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002158 if (exp->namespace &&
2159 !module_imports_namespace(mod, exp->namespace)) {
Jessica Yu54b77842020-03-06 17:02:06 +01002160 modpost_log(allow_missing_ns_imports ? LOG_WARN : LOG_ERROR,
2161 "module %s uses symbol %s from namespace %s, but does not import it.\n",
2162 basename, exp->name, exp->namespace);
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002163 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002164 }
2165
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002166 if (!mod->gpl_compatible)
2167 check_for_gpl_usage(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002168 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002169}
2170
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002171static void check_modname_len(struct module *mod)
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002172{
2173 const char *mod_name;
2174
2175 mod_name = strrchr(mod->name, '/');
2176 if (mod_name == NULL)
2177 mod_name = mod->name;
2178 else
2179 mod_name++;
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002180 if (strlen(mod_name) >= MODULE_NAME_LEN)
Masahiro Yamadabc72d722020-12-01 19:34:14 +09002181 error("module name is too long [%s.ko]\n", mod->name);
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002182}
2183
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002184/**
2185 * Header for the generated file
2186 **/
2187static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188{
2189 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002190 /*
2191 * Include build-salt.h after module.h in order to
2192 * inherit the definitions.
2193 */
Leon Romanovsky51161bf2020-04-19 18:55:06 +03002194 buf_printf(b, "#define INCLUDE_VERMAGIC\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002195 buf_printf(b, "#include <linux/build-salt.h>\n");
Yonghong Song1fdd7432021-04-01 16:27:23 -07002196 buf_printf(b, "#include <linux/elfnote-lto.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 buf_printf(b, "#include <linux/vermagic.h>\n");
2198 buf_printf(b, "#include <linux/compiler.h>\n");
2199 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002200 buf_printf(b, "BUILD_SALT;\n");
Yonghong Song1fdd7432021-04-01 16:27:23 -07002201 buf_printf(b, "BUILD_LTO_INFO;\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002202 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002204 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302206 buf_printf(b, "__visible struct module __this_module\n");
Joe Perches33def842020-10-21 19:36:07 -07002207 buf_printf(b, "__section(\".gnu.linkonce.this_module\") = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002208 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002210 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 if (mod->has_cleanup)
2212 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002213 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002215 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 buf_printf(b, "};\n");
2217}
2218
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002219static void add_intree_flag(struct buffer *b, int is_intree)
2220{
2221 if (is_intree)
2222 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2223}
2224
Andi Kleencaf75012018-01-25 15:50:28 -08002225/* Cannot check for assembler */
2226static void add_retpoline(struct buffer *b)
2227{
WANG Chaoe4f35892018-12-11 00:37:25 +08002228 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002229 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2230 buf_printf(b, "#endif\n");
2231}
2232
Trevor Keith5c725132009-09-22 16:43:38 -07002233static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002234{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002235 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002236 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2237}
2238
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002239/**
2240 * Record CRCs for unresolved symbols
2241 **/
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002242static void add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243{
2244 struct symbol *s, *exp;
2245
2246 for (s = mod->unres; s; s = s->next) {
2247 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002248 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 s->module = exp->module;
2251 s->crc_valid = exp->crc_valid;
2252 s->crc = exp->crc;
2253 }
2254
2255 if (!modversions)
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002256 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257
2258 buf_printf(b, "\n");
2259 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Joe Perches33def842020-10-21 19:36:07 -07002260 buf_printf(b, "__used __section(\"__versions\") = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261
2262 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002263 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002266 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 s->name, mod->name);
2268 continue;
2269 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302270 if (strlen(s->name) >= MODULE_NAME_LEN) {
Masahiro Yamadabc72d722020-12-01 19:34:14 +09002271 error("too long symbol \"%s\" [%s.ko]\n",
2272 s->name, mod->name);
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302273 break;
2274 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002275 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302276 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 }
2278
2279 buf_printf(b, "};\n");
2280}
2281
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002282static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283{
2284 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 int first = 1;
2286
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002287 /* Clear ->seen flag of modules that own symbols needed by this. */
2288 for (s = mod->unres; s; s = s->next)
2289 if (s->module)
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002290 s->module->seen = s->module->is_vmlinux;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291
2292 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002293 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002295 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 if (!s->module)
2297 continue;
2298
2299 if (s->module->seen)
2300 continue;
2301
2302 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002303 p = strrchr(s->module->name, '/');
2304 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002305 p++;
2306 else
2307 p = s->module->name;
2308 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 first = 0;
2310 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002311 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312}
2313
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002314static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315{
2316 if (mod->srcversion[0]) {
2317 buf_printf(b, "\n");
2318 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2319 mod->srcversion);
2320 }
2321}
2322
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002323static void write_buf(struct buffer *b, const char *fname)
2324{
2325 FILE *file;
2326
2327 file = fopen(fname, "w");
2328 if (!file) {
2329 perror(fname);
2330 exit(1);
2331 }
2332 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2333 perror(fname);
2334 exit(1);
2335 }
2336 if (fclose(file) != 0) {
2337 perror(fname);
2338 exit(1);
2339 }
2340}
2341
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002342static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343{
2344 char *tmp;
2345 FILE *file;
2346 struct stat st;
2347
2348 file = fopen(fname, "r");
2349 if (!file)
2350 goto write;
2351
2352 if (fstat(fileno(file), &st) < 0)
2353 goto close_write;
2354
2355 if (st.st_size != b->pos)
2356 goto close_write;
2357
2358 tmp = NOFAIL(malloc(b->pos));
2359 if (fread(tmp, 1, b->pos, file) != b->pos)
2360 goto free_write;
2361
2362 if (memcmp(tmp, b->p, b->pos) != 0)
2363 goto free_write;
2364
2365 free(tmp);
2366 fclose(file);
2367 return;
2368
2369 free_write:
2370 free(tmp);
2371 close_write:
2372 fclose(file);
2373 write:
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002374 write_buf(b, fname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375}
2376
Ram Paibd5cbce2006-06-08 22:12:53 -07002377/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002378 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002379 **/
Masahiro Yamada52c34162020-06-01 14:57:05 +09002380static void read_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381{
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002382 char *buf, *pos, *line;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002384 buf = read_text_file(fname);
2385 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 /* No symbol versions, silently ignore */
2387 return;
2388
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002389 pos = buf;
2390
2391 while ((line = get_line(&pos))) {
Jessica Yu51900442020-03-11 18:01:20 +01002392 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 unsigned int crc;
2394 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002395 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396
2397 if (!(symname = strchr(line, '\t')))
2398 goto fail;
2399 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002400 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 goto fail;
2402 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002403 if (!(export = strchr(modname, '\t')))
2404 goto fail;
2405 *export++ = '\0';
2406 if (!(namespace = strchr(export, '\t')))
2407 goto fail;
2408 *namespace++ = '\0';
2409
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410 crc = strtoul(line, &d, 16);
2411 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2412 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002413 mod = find_module(modname);
2414 if (!mod) {
Jan Beulich0fa3a882009-03-12 12:28:30 +00002415 mod = new_module(modname);
Masahiro Yamada52c34162020-06-01 14:57:05 +09002416 mod->from_dump = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002418 s = sym_add_exported(symname, mod, export_no(export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002419 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002420 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002421 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422 }
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002423 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 return;
2425fail:
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002426 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 fatal("parse error in symbol dump file\n");
2428}
2429
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002430static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431{
2432 struct buffer buf = { };
2433 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002434 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 int n;
2436
2437 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2438 symbol = symbolhash[n];
2439 while (symbol) {
Masahiro Yamada69bc8d32021-03-26 03:54:09 +09002440 if (!symbol->module->from_dump) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002441 namespace = symbol->namespace;
2442 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2443 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002444 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002445 export_str(symbol->export),
2446 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002447 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 symbol = symbol->next;
2449 }
2450 }
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002451 write_buf(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002452 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453}
2454
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002455static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002456{
2457 struct module *mod;
2458 struct namespace_list *ns;
2459 struct buffer ns_deps_buf = {};
2460
2461 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002462
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002463 if (mod->from_dump || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002464 continue;
2465
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002466 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002467
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002468 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2469 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002470
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002471 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002472 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002473
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002474 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002475 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002476}
2477
Masahiro Yamada79247992020-06-01 14:57:07 +09002478struct dump_list {
2479 struct dump_list *next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002480 const char *file;
2481};
2482
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002483int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484{
2485 struct module *mod;
2486 struct buffer buf = { };
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002487 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302488 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 int opt;
Denis Efremov15bfc232019-08-01 09:06:57 +03002490 int n;
Masahiro Yamada79247992020-06-01 14:57:07 +09002491 struct dump_list *dump_read_start = NULL;
2492 struct dump_list **dump_read_iter = &dump_read_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002494 while ((opt = getopt(argc, argv, "ei:mnT:o:awENd:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002495 switch (opt) {
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002496 case 'e':
2497 external_module = 1;
Masahiro Yamadae3fb4df2020-06-01 14:57:08 +09002498 break;
2499 case 'i':
Masahiro Yamada79247992020-06-01 14:57:07 +09002500 *dump_read_iter =
2501 NOFAIL(calloc(1, sizeof(**dump_read_iter)));
2502 (*dump_read_iter)->file = optarg;
2503 dump_read_iter = &(*dump_read_iter)->next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002504 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002505 case 'm':
2506 modversions = 1;
2507 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302508 case 'n':
2509 ignore_missing_files = 1;
2510 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002511 case 'o':
2512 dump_write = optarg;
2513 break;
2514 case 'a':
2515 all_versions = 1;
2516 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302517 case 'T':
2518 files_source = optarg;
2519 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002520 case 'w':
2521 warn_unresolved = 1;
2522 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302523 case 'E':
Masahiro Yamadac7299d92020-12-01 19:34:18 +09002524 sec_mismatch_warn_only = false;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302525 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002526 case 'N':
2527 allow_missing_ns_imports = 1;
2528 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002529 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002530 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002531 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002532 default:
2533 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 }
2535 }
2536
Masahiro Yamada79247992020-06-01 14:57:07 +09002537 while (dump_read_start) {
2538 struct dump_list *tmp;
Masahiro Yamada2beee862020-06-01 14:57:04 +09002539
Masahiro Yamada79247992020-06-01 14:57:07 +09002540 read_dump(dump_read_start->file);
2541 tmp = dump_read_start->next;
2542 free(dump_read_start);
2543 dump_read_start = tmp;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002544 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002546 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548
Rusty Russell712f9b42013-04-04 17:37:38 +10302549 if (files_source)
2550 read_symbols_from_files(files_source);
2551
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002552 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302553 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002554
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002555 if (mod->is_vmlinux || mod->from_dump)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002556 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557
2558 buf.pos = 0;
2559
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002560 check_modname_len(mod);
2561 check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002562
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002564 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002565 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002566 add_staging_flag(&buf, mod->name);
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002567 add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002568 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 add_moddevtable(&buf, mod);
2570 add_srcversion(&buf, mod);
2571
2572 sprintf(fname, "%s.mod.c", mod->name);
2573 write_if_changed(&buf, fname);
2574 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002575
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002576 if (missing_namespace_deps)
2577 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002578
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 if (dump_write)
2580 write_dump(dump_write);
Masahiro Yamadac7299d92020-12-01 19:34:18 +09002581 if (sec_mismatch_count && !sec_mismatch_warn_only)
2582 error("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002583 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002584 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002585 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002586
Masahiro Yamada47346e92019-09-24 21:07:40 +09002587 for (s = symbolhash[n]; s; s = s->next) {
Denis Efremov15bfc232019-08-01 09:06:57 +03002588 if (s->is_static)
Quentin Perretb9ed8472020-12-01 16:52:22 +00002589 error("\"%s\" [%s] is a static %s\n",
2590 s->name, s->module->name,
2591 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002592 }
2593 }
2594
Masahiro Yamada4475dff2021-03-26 03:54:11 +09002595 if (nr_unresolved > MAX_UNRESOLVED_REPORTS)
2596 warn("suppressed %u unresolved symbol warnings because there were too many)\n",
2597 nr_unresolved - MAX_UNRESOLVED_REPORTS);
2598
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002599 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002601 return error_occurred ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602}