blob: 44a55aeb35e2e06d372ddbc62c667a8e8e5bc11e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Postprocess module symbol versions
2 *
3 * Copyright 2003 Kai Germaschewski
4 * Copyright 2002-2004 Rusty Russell, IBM Corporation
Sam Ravnborgdf578e72008-01-11 19:17:15 +01005 * Copyright 2006-2008 Sam Ravnborg
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Based in part on module-init-tools/depmod.c,file2alias
7 *
8 * This software may be used and distributed according to the terms
9 * of the GNU General Public License, incorporated herein by reference.
10 *
11 * Usage: modpost vmlinux module1.o module2.o ...
12 */
13
Mathieu Desnoyersb2e3e652008-02-13 15:03:39 -080014#define _GNU_SOURCE
Masahiro Yamada5370d4a2020-01-05 00:36:51 +090015#include <elf.h>
Mathieu Desnoyersb2e3e652008-02-13 15:03:39 -080016#include <stdio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <ctype.h>
Andrew Morton5003bab2010-08-11 00:42:26 -070018#include <string.h>
Rusty Russell712f9b42013-04-04 17:37:38 +103019#include <limits.h>
Masahiro Yamadae54dd932021-08-28 18:50:59 +090020#include <stdbool.h>
Guenter Roeckeed380f2013-09-23 15:23:54 +093021#include <errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include "modpost.h"
Sam Ravnborgb817f6f2006-06-09 21:53:55 +020023#include "../../include/linux/license.h"
Alan Jenkins9e1b9b82009-11-07 21:03:54 +000024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/* Are we using CONFIG_MODVERSIONS? */
Mathias Krause7a3ee752014-08-27 20:28:53 +093026static int modversions = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070027/* Is CONFIG_MODULE_SRCVERSION_ALL set? */
28static int all_versions = 0;
Sam Ravnborg040fcc82006-01-28 22:15:55 +010029/* If we are modposting external module set to 1 */
30static int external_module = 0;
Will McVicker4b9c11a2020-11-19 13:46:37 -080031#define MODULE_SCMVERSION_SIZE 64
32static char module_scmversion[MODULE_SCMVERSION_SIZE];
Kirill Korotaevc53ddac2006-09-07 13:08:54 -070033/* Only warn about unresolved symbols */
34static int warn_unresolved = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -070035/* How a symbol is exported */
Sam Ravnborg588ccd72008-01-24 21:12:37 +010036static int sec_mismatch_count = 0;
Masahiro Yamadac7299d92020-12-01 19:34:18 +090037static int sec_mismatch_warn_only = true;
Guenter Roeckeed380f2013-09-23 15:23:54 +093038/* ignore missing files */
39static int ignore_missing_files;
Jessica Yu54b77842020-03-06 17:02:06 +010040/* If set to 1, only warn (instead of error) about missing ns imports */
41static int allow_missing_ns_imports;
Sam Ravnborg588ccd72008-01-24 21:12:37 +010042
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +090043static bool error_occurred;
44
Masahiro Yamada4475dff2021-03-26 03:54:11 +090045/*
46 * Cut off the warnings when there are too many. This typically occurs when
47 * vmlinux is missing. ('make modules' without building vmlinux.)
48 */
49#define MAX_UNRESOLVED_REPORTS 10
50static unsigned int nr_unresolved;
51
Sam Ravnborgc96fca22006-07-01 11:44:23 +020052enum export {
Christoph Hellwig36794822021-02-02 13:13:34 +010053 export_plain,
54 export_gpl,
55 export_unknown
Sam Ravnborgc96fca22006-07-01 11:44:23 +020056};
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +080058/* In kernel, this size is defined in linux/module.h;
59 * here we use Elf_Addr instead of long for covering cross-compile
60 */
61
62#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
63
Jessica Yu93c95e52020-03-06 17:02:05 +010064void __attribute__((format(printf, 2, 3)))
65modpost_log(enum loglevel loglevel, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066{
67 va_list arglist;
68
Jessica Yu93c95e52020-03-06 17:02:05 +010069 switch (loglevel) {
70 case LOG_WARN:
71 fprintf(stderr, "WARNING: ");
72 break;
73 case LOG_ERROR:
74 fprintf(stderr, "ERROR: ");
75 break;
76 case LOG_FATAL:
77 fprintf(stderr, "FATAL: ");
78 break;
79 default: /* invalid loglevel, ignore */
80 break;
81 }
82
83 fprintf(stderr, "modpost: ");
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85 va_start(arglist, fmt);
86 vfprintf(stderr, fmt, arglist);
87 va_end(arglist);
88
Jessica Yu93c95e52020-03-06 17:02:05 +010089 if (loglevel == LOG_FATAL)
90 exit(1);
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +090091 if (loglevel == LOG_ERROR)
92 error_occurred = true;
Matthew Wilcox2a116652006-10-07 05:35:32 -060093}
94
Masahiro Yamadae54dd932021-08-28 18:50:59 +090095static inline bool strends(const char *str, const char *postfix)
96{
97 if (strlen(str) < strlen(postfix))
98 return false;
99
100 return strcmp(str + strlen(str) - strlen(postfix), postfix) == 0;
101}
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103void *do_nofail(void *ptr, const char *expr)
104{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100105 if (!ptr)
Jessica Yu93c95e52020-03-06 17:02:05 +0100106 fatal("Memory allocation failure: %s.\n", expr);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 return ptr;
109}
110
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900111char *read_text_file(const char *filename)
112{
113 struct stat st;
114 size_t nbytes;
115 int fd;
116 char *buf;
117
118 fd = open(filename, O_RDONLY);
119 if (fd < 0) {
120 perror(filename);
121 exit(1);
122 }
123
124 if (fstat(fd, &st) < 0) {
125 perror(filename);
126 exit(1);
127 }
128
129 buf = NOFAIL(malloc(st.st_size + 1));
130
131 nbytes = st.st_size;
132
133 while (nbytes) {
134 ssize_t bytes_read;
135
136 bytes_read = read(fd, buf, nbytes);
137 if (bytes_read < 0) {
138 perror(filename);
139 exit(1);
140 }
141
142 nbytes -= bytes_read;
143 }
144 buf[st.st_size] = '\0';
145
146 close(fd);
147
148 return buf;
149}
150
151char *get_line(char **stringp)
152{
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200153 char *orig = *stringp, *next;
154
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900155 /* do not return the unwanted extra line at EOF */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200156 if (!orig || *orig == '\0')
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900157 return NULL;
158
Wolfram Sang6020db52020-07-26 23:44:19 +0200159 /* don't use strsep here, it is not available everywhere */
H. Nikolaus Schaller736bb112020-07-01 08:18:27 +0200160 next = strchr(orig, '\n');
161 if (next)
162 *next++ = '\0';
163
164 *stringp = next;
165
166 return orig;
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900167}
168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169/* A list of all modules we processed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170static struct module *modules;
171
Masahiro Yamada8b185742018-05-09 18:50:40 +0900172static struct module *find_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173{
174 struct module *mod;
175
176 for (mod = modules; mod; mod = mod->next)
177 if (strcmp(mod->name, modname) == 0)
178 break;
179 return mod;
180}
181
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030182static struct module *new_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183{
184 struct module *mod;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100185
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900186 mod = NOFAIL(malloc(sizeof(*mod) + strlen(modname) + 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 memset(mod, 0, sizeof(*mod));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189 /* add to list */
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900190 strcpy(mod->name, modname);
Masahiro Yamada4de7b622020-06-01 14:57:30 +0900191 mod->is_vmlinux = (strcmp(modname, "vmlinux") == 0);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200192 mod->gpl_compatible = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 mod->next = modules;
194 modules = mod;
195
196 return mod;
197}
198
199/* A hash of all exported symbols,
200 * struct symbol is also used for lists of unresolved symbols */
201
202#define SYMBOL_HASH_SIZE 1024
203
204struct symbol {
205 struct symbol *next;
206 struct module *module;
207 unsigned int crc;
208 int crc_valid;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900209 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 unsigned int weak:1;
Denis Efremov15bfc232019-08-01 09:06:57 +0300211 unsigned int is_static:1; /* 1 if symbol is not global */
Ram Paibd5cbce2006-06-08 22:12:53 -0700212 enum export export; /* Type of export */
Gustavo A. R. Silva859c8172020-05-07 13:56:01 -0500213 char name[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214};
215
216static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
217
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +0530218/* This is based on the hash algorithm from gdbm, via tdb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219static inline unsigned int tdb_hash(const char *name)
220{
221 unsigned value; /* Used to compute the hash value. */
222 unsigned i; /* Used to cycle through random values. */
223
224 /* Set the initial value from the key size. */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100225 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
227
228 return (1103515243 * value + 12345);
229}
230
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100231/**
232 * Allocate a new symbols for use in the hash of exported symbols or
233 * the list of unresolved symbols per module
234 **/
235static struct symbol *alloc_symbol(const char *name, unsigned int weak,
236 struct symbol *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237{
238 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
239
240 memset(s, 0, sizeof(*s));
241 strcpy(s->name, name);
242 s->weak = weak;
243 s->next = next;
Denis Efremov15bfc232019-08-01 09:06:57 +0300244 s->is_static = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 return s;
246}
247
248/* For the hash of exported symbols */
Ram Paibd5cbce2006-06-08 22:12:53 -0700249static struct symbol *new_symbol(const char *name, struct module *module,
250 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
252 unsigned int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
254 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900255 symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
256
257 return symbolhash[hash];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258}
259
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100260static struct symbol *find_symbol(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261{
262 struct symbol *s;
263
264 /* For our purposes, .foo matches foo. PPC64 needs this. */
265 if (name[0] == '.')
266 name++;
267
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100268 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 if (strcmp(s->name, name) == 0)
270 return s;
271 }
272 return NULL;
273}
274
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100275static bool contains_namespace(struct namespace_list *list,
276 const char *namespace)
277{
Masahiro Yamada76b54cf2019-10-29 21:38:09 +0900278 for (; list; list = list->next)
279 if (!strcmp(list->namespace, namespace))
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100280 return true;
281
282 return false;
283}
284
285static void add_namespace(struct namespace_list **list, const char *namespace)
286{
287 struct namespace_list *ns_entry;
288
289 if (!contains_namespace(*list, namespace)) {
290 ns_entry = NOFAIL(malloc(sizeof(struct namespace_list) +
291 strlen(namespace) + 1));
292 strcpy(ns_entry->namespace, namespace);
293 ns_entry->next = *list;
294 *list = ns_entry;
295 }
296}
297
298static bool module_imports_namespace(struct module *module,
299 const char *namespace)
300{
301 return contains_namespace(module->imported_namespaces, namespace);
302}
303
Mathias Krause7a3ee752014-08-27 20:28:53 +0930304static const struct {
Ram Paibd5cbce2006-06-08 22:12:53 -0700305 const char *str;
306 enum export export;
307} export_list[] = {
308 { .str = "EXPORT_SYMBOL", .export = export_plain },
309 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
Ram Paibd5cbce2006-06-08 22:12:53 -0700310 { .str = "(unknown)", .export = export_unknown },
311};
312
313
314static const char *export_str(enum export ex)
315{
316 return export_list[ex].str;
317}
318
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100319static enum export export_no(const char *s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700320{
321 int i;
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100322
Sam Ravnborg534b89a2006-07-01 10:10:19 +0200323 if (!s)
324 return export_unknown;
Ram Paibd5cbce2006-06-08 22:12:53 -0700325 for (i = 0; export_list[i].export != export_unknown; i++) {
326 if (strcmp(export_list[i].str, s) == 0)
327 return export_list[i].export;
328 }
329 return export_unknown;
330}
331
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900332static void *sym_get_data_by_offset(const struct elf_info *info,
333 unsigned int secindex, unsigned long offset)
Masahiro Yamada6124c042017-09-06 16:19:05 -0700334{
Xiao Yang4b8a5cf2020-03-18 18:34:16 +0800335 Elf_Shdr *sechdr = &info->sechdrs[secindex];
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900336
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900337 if (info->hdr->e_type != ET_REL)
338 offset -= sechdr->sh_addr;
339
340 return (void *)info->hdr + sechdr->sh_offset + offset;
341}
342
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900343static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
344{
345 return sym_get_data_by_offset(info, get_secindex(info, sym),
346 sym->st_value);
347}
348
Masahiro Yamada565587d2020-05-25 14:47:05 +0900349static const char *sech_name(const struct elf_info *info, Elf_Shdr *sechdr)
350{
351 return sym_get_data_by_offset(info, info->secindex_strings,
352 sechdr->sh_name);
353}
354
355static const char *sec_name(const struct elf_info *info, int secindex)
356{
357 return sech_name(info, &info->sechdrs[secindex]);
358}
359
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200360#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
361
362static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
363{
364 const char *secname = sec_name(elf, sec);
365
366 if (strstarts(secname, "___ksymtab+"))
367 return export_plain;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200368 else if (strstarts(secname, "___ksymtab_gpl+"))
369 return export_gpl;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200370 else
371 return export_unknown;
372}
373
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200374static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700375{
376 if (sec == elf->export_sec)
377 return export_plain;
378 else if (sec == elf->export_gpl_sec)
379 return export_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700380 else
381 return export_unknown;
382}
383
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900384static const char *namespace_from_kstrtabns(const struct elf_info *info,
385 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100386{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900387 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100388 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100389}
390
Matthias Maennicha2b11182019-10-18 10:31:40 +0100391static void sym_update_namespace(const char *symname, const char *namespace)
392{
393 struct symbol *s = find_symbol(symname);
394
395 /*
396 * That symbol should have been created earlier and thus this is
397 * actually an assertion.
398 */
399 if (!s) {
Masahiro Yamadabc72d722020-12-01 19:34:14 +0900400 error("Could not update namespace(%s) for symbol %s\n",
401 namespace, symname);
Matthias Maennicha2b11182019-10-18 10:31:40 +0100402 return;
403 }
404
405 free(s->namespace);
406 s->namespace =
407 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
408}
409
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100410/**
411 * Add an exported symbol - it may have already been added without a
412 * CRC, in this case just update the CRC
413 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100414static struct symbol *sym_add_exported(const char *name, struct module *mod,
415 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416{
417 struct symbol *s = find_symbol(name);
418
419 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700420 s = new_symbol(name, mod, export);
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900421 } else if (!external_module || s->module->is_vmlinux ||
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900422 s->module == mod) {
Quentin Perret479488f2020-11-24 14:40:13 +0000423 fatal("%s: '%s' exported twice. Previous export was in %s%s\n",
424 mod->name, name, s->module->name,
425 s->module->is_vmlinux ? "" : ".ko");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900427
428 s->module = mod;
Ram Paibd5cbce2006-06-08 22:12:53 -0700429 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100430 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431}
432
Masahiro Yamada17436942019-11-15 02:42:24 +0900433static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100434{
435 struct symbol *s = find_symbol(name);
436
Masahiro Yamada17436942019-11-15 02:42:24 +0900437 /*
438 * Ignore stand-alone __crc_*, which might be auto-generated symbols
439 * such as __*_veneer in ARM ELF.
440 */
441 if (!s)
442 return;
443
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100444 s->crc = crc;
445 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446}
447
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900448static void *grab_file(const char *filename, size_t *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
450 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930451 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 int fd;
453
454 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930455 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930457 if (fstat(fd, &st))
458 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460 *size = st.st_size;
461 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930463failed:
464 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 if (map == MAP_FAILED)
466 return NULL;
467 return map;
468}
469
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900470static void release_file(void *file, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471{
472 munmap(file, size);
473}
474
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100475static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476{
477 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100478 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 Elf_Shdr *sechdrs;
480 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200481 const char *secstrings;
482 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
484 hdr = grab_file(filename, &info->size);
485 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930486 if (ignore_missing_files) {
487 fprintf(stderr, "%s: %s (ignored)\n", filename,
488 strerror(errno));
489 return 0;
490 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200492 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 }
494 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100495 if (info->size < sizeof(*hdr)) {
496 /* file too small, assume this is an empty .o file */
497 return 0;
498 }
499 /* Is this a valid ELF file? */
500 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
501 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
502 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
503 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
504 /* Not an ELF file - silently ignore it */
505 return 0;
506 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200508 hdr->e_type = TO_NATIVE(hdr->e_type);
509 hdr->e_machine = TO_NATIVE(hdr->e_machine);
510 hdr->e_version = TO_NATIVE(hdr->e_version);
511 hdr->e_entry = TO_NATIVE(hdr->e_entry);
512 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
513 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
514 hdr->e_flags = TO_NATIVE(hdr->e_flags);
515 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
516 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
517 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
518 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
519 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
520 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 sechdrs = (void *)hdr + hdr->e_shoff;
522 info->sechdrs = sechdrs;
523
Petr Stetiara83710e2007-08-27 12:15:07 +0200524 /* Check if file offset is correct */
525 if (hdr->e_shoff > info->size) {
Masahiro Yamada3b09efc2020-06-01 14:57:31 +0900526 fatal("section header offset=%lu in file '%s' is bigger than filesize=%zu\n",
527 (unsigned long)hdr->e_shoff, filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200528 return 0;
529 }
530
Anders Kaseorg68457562011-05-19 16:55:27 -0600531 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200532 /*
533 * There are more than 64k sections,
534 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200535 */
536 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
537 }
538 else {
539 info->num_sections = hdr->e_shnum;
540 }
541 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600542 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200543 }
544 else {
545 info->secindex_strings = hdr->e_shstrndx;
546 }
547
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200549 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200550 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
551 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
552 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
553 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
554 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
555 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
556 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
557 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
558 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
559 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 }
561 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200562 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
563 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700564 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900565 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
Tejun Heo56fc82c2009-02-06 00:48:02 +0900567 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100568 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
569 "sizeof(*hrd)=%zu\n", filename,
570 (unsigned long)sechdrs[i].sh_offset,
571 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100572 return 0;
573 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700574 secname = secstrings + sechdrs[i].sh_name;
575 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900576 if (nobits)
577 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
579 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700580 } else if (strcmp(secname, "__ksymtab") == 0)
581 info->export_sec = i;
582 else if (strcmp(secname, "__ksymtab_gpl") == 0)
583 info->export_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700584
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200585 if (sechdrs[i].sh_type == SHT_SYMTAB) {
586 unsigned int sh_link_idx;
587 symtab_idx = i;
588 info->symtab_start = (void *)hdr +
589 sechdrs[i].sh_offset;
590 info->symtab_stop = (void *)hdr +
591 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600592 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200593 info->strtab = (void *)hdr +
594 sechdrs[sh_link_idx].sh_offset;
595 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200597 /* 32bit section no. table? ("more than 64k sections") */
598 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
599 symtab_shndx_idx = i;
600 info->symtab_shndx_start = (void *)hdr +
601 sechdrs[i].sh_offset;
602 info->symtab_shndx_stop = (void *)hdr +
603 sechdrs[i].sh_offset + sechdrs[i].sh_size;
604 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100606 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100607 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 /* Fix endianness in symbols */
610 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
611 sym->st_shndx = TO_NATIVE(sym->st_shndx);
612 sym->st_name = TO_NATIVE(sym->st_name);
613 sym->st_value = TO_NATIVE(sym->st_value);
614 sym->st_size = TO_NATIVE(sym->st_size);
615 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200616
617 if (symtab_shndx_idx != ~0U) {
618 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600619 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200620 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600621 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200622 symtab_idx);
623 /* Fix endianness */
624 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
625 p++)
626 *p = TO_NATIVE(*p);
627 }
628
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100629 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630}
631
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100632static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633{
634 release_file(info->hdr, info->size);
635}
636
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200637static int ignore_undef_symbol(struct elf_info *info, const char *symname)
638{
639 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900640 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200641 return 1;
642 /* ignore global offset table */
643 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
644 return 1;
645 if (info->hdr->e_machine == EM_PPC)
646 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900647 if (strstarts(symname, "_restgpr_") ||
648 strstarts(symname, "_savegpr_") ||
649 strstarts(symname, "_rest32gpr_") ||
650 strstarts(symname, "_save32gpr_") ||
651 strstarts(symname, "_restvr_") ||
652 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200653 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000654 if (info->hdr->e_machine == EM_PPC64)
655 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900656 if (strstarts(symname, "_restgpr0_") ||
657 strstarts(symname, "_savegpr0_") ||
658 strstarts(symname, "_restvr_") ||
659 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100660 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000661 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200662 /* Do not ignore this symbol */
663 return 0;
664}
665
Masahiro Yamada17436942019-11-15 02:42:24 +0900666static void handle_modversion(const struct module *mod,
667 const struct elf_info *info,
668 const Elf_Sym *sym, const char *symname)
669{
670 unsigned int crc;
671
672 if (sym->st_shndx == SHN_UNDEF) {
Masahiro Yamada9f20ce92022-04-02 00:56:10 +0900673 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n"
Mark Brown4a679592021-06-07 15:02:06 +0100674 "Is \"%s\" prototyped in <asm/asm-prototypes.h>?\n",
675 symname, mod->name, mod->is_vmlinux ? "" : ".ko",
676 symname);
677
Masahiro Yamada17436942019-11-15 02:42:24 +0900678 return;
679 }
680
681 if (sym->st_shndx == SHN_ABS) {
682 crc = sym->st_value;
683 } else {
684 unsigned int *crcp;
685
686 /* symbol points to the CRC in the ELF object */
687 crcp = sym_get_data(info, sym);
688 crc = TO_NATIVE(*crcp);
689 }
690 sym_set_crc(symname, crc);
691}
692
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900693static void handle_symbol(struct module *mod, struct elf_info *info,
694 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200696 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900697 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200698
Masahiro Yamada33795762020-06-01 14:57:24 +0900699 if (strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200700 export = export_from_secname(info, get_secindex(info, sym));
701 else
702 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
704 switch (sym->st_shndx) {
705 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900706 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100707 /* Should warn here, but modpost runs before the linker */
708 } else
709 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 case SHN_UNDEF:
712 /* undefined symbol */
713 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
714 ELF_ST_BIND(sym->st_info) != STB_WEAK)
715 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200716 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 if (info->hdr->e_machine == EM_SPARC ||
719 info->hdr->e_machine == EM_SPARCV9) {
720 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700721 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100723 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700724 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100725 munged[0] = '_';
726 munged[1] = toupper(munged[1]);
727 symname = munged;
728 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100730
Rusty Russellb92021b2013-03-15 15:04:17 +1030731 mod->unres = alloc_symbol(symname,
732 ELF_ST_BIND(sym->st_info) == STB_WEAK,
733 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 break;
735 default:
736 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900737 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100738 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100739 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900741 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900743 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 mod->has_cleanup = 1;
745 break;
746 }
747}
748
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100749/**
750 * Parse tag=value strings from .modinfo section
751 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752static char *next_string(char *string, unsigned long *secsize)
753{
754 /* Skip non-zero chars */
755 while (string[0]) {
756 string++;
757 if ((*secsize)-- <= 1)
758 return NULL;
759 }
760
761 /* Skip any zero padding. */
762 while (!string[0]) {
763 string++;
764 if ((*secsize)-- <= 1)
765 return NULL;
766 }
767 return string;
768}
769
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900770static char *get_next_modinfo(struct elf_info *info, const char *tag,
771 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772{
773 char *p;
774 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900775 char *modinfo = info->modinfo;
776 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900778 if (prev) {
779 size -= prev - modinfo;
780 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200781 }
782
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 for (p = modinfo; p; p = next_string(p, &size)) {
784 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
785 return p + taglen + 1;
786 }
787 return NULL;
788}
789
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900790static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200791
792{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900793 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200794}
795
Sam Ravnborg93684d32006-02-19 11:53:35 +0100796/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100797 * Test if string s ends in string sub
798 * return 0 if match
799 **/
800static int strrcmp(const char *s, const char *sub)
801{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100802 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100803
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100804 if (!s || !sub)
805 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100806
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100807 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100808 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100809
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100810 if ((slen == 0) || (sublen == 0))
811 return 1;
812
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100813 if (sublen > slen)
814 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100815
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100816 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100817}
818
Sam Ravnborgff13f922008-01-23 19:54:27 +0100819static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
820{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100821 if (sym)
822 return elf->strtab + sym->st_name;
823 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100824 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100825}
826
Sam Ravnborg10668222008-01-13 22:21:31 +0100827/* The pattern is an array of simple patterns.
828 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100829 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100830 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930831 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100832 */
Trevor Keith5c725132009-09-22 16:43:38 -0700833static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100834{
835 const char *p;
836 while (*pat) {
837 p = *pat++;
838 const char *endp = p + strlen(p) - 1;
839
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930840 /* "*foo*" */
841 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300842 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
843 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930844
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930845 free(bare);
846 if (here != NULL)
847 return 1;
848 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100849 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930850 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100851 if (strrcmp(sym, p + 1) == 0)
852 return 1;
853 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100854 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100855 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100856 if (strncmp(sym, p, strlen(p) - 1) == 0)
857 return 1;
858 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100859 /* no wildcards */
860 else {
861 if (strcmp(p, sym) == 0)
862 return 1;
863 }
864 }
865 /* no match */
866 return 0;
867}
868
Sam Ravnborg10668222008-01-13 22:21:31 +0100869/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930870static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200871{
872 ".comment*",
873 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930874 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800875 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000876 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200877 ".mdebug*", /* alpha, score, mips etc. */
878 ".pdr", /* alpha, score, mips etc. */
879 ".stab*",
880 ".note*",
881 ".got*",
882 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400883 ".xt.prop", /* xtensa */
884 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030885 ".arcextmap*", /* arc */
886 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030887 ".cmem*", /* EZchip */
888 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100889 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600890 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200891 NULL
892};
Sam Ravnborg10668222008-01-13 22:21:31 +0100893
Sam Ravnborge241a632008-01-28 20:13:13 +0100894/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400895 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100896 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400897 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100898 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400899static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900900 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100901{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400902 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100903
Anders Kaseorgb614a692009-04-23 16:49:33 -0400904 if (sechdr->sh_type == SHT_PROGBITS &&
905 !(sechdr->sh_flags & SHF_ALLOC) &&
906 !match(sec, section_white_list)) {
907 warn("%s (%s): unexpected non-allocatable section.\n"
908 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
909 "Note that for example <linux/init.h> contains\n"
910 "section definitions for use in .S files.\n\n",
911 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100912 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100913}
914
915
916
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100917#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930918 ".init.setup", ".init.rodata", ".meminit.rodata", \
919 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100920#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930921 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100922
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100923#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930924 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100925#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930926 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100927
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200928#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930929 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
930 ".pci_fixup_enable", ".pci_fixup_resume", \
931 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200932
Paul Gortmakere24f6622013-06-19 19:30:48 -0400933#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
934#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100935
936#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
937#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100938
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930939#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930940#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Thomas Gleixner65538962020-03-09 22:47:17 +0100941 ".kprobes.text", ".cpuidle.text", ".noinstr.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930942#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400943 ".fixup", ".entry.text", ".exception.text", ".text.*", \
Christophe Leroy1e688dd22021-04-13 16:38:10 +0000944 ".coldtext", ".softirqentry.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100945
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000946#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000947#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100948
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000949#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000950#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100951
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930952#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
953 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
954
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100955/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930956static const char *const init_data_sections[] =
957 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100958
959/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930960static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100961
962/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930963static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100964 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100965
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930966/* all text sections */
967static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
968
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100969/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930970static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100971
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100972
973/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100974#define DEFAULT_SYMBOL_WHITE_LIST \
975 "*driver", \
976 "*_template", /* scsi uses *_template a lot */ \
977 "*_timer", /* arm uses ops structures named _timer a lot */ \
978 "*_sht", /* scsi also used *_sht to some extent */ \
979 "*_ops", \
980 "*_probe", \
981 "*_probe_one", \
982 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100983
Mathias Krause7a3ee752014-08-27 20:28:53 +0930984static const char *const head_sections[] = { ".head.text*", NULL };
985static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100986 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930987static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100988
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100989enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +0100990 TEXT_TO_ANY_INIT,
991 DATA_TO_ANY_INIT,
992 TEXT_TO_ANY_EXIT,
993 DATA_TO_ANY_EXIT,
994 XXXINIT_TO_SOME_INIT,
995 XXXEXIT_TO_SOME_EXIT,
996 ANY_INIT_TO_ANY_EXIT,
997 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +0100998 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930999 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001000};
1001
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301002/**
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +05301003 * Describe how to match sections on different criteria:
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301004 *
1005 * @fromsec: Array of sections to be matched.
1006 *
1007 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
1008 * this array is forbidden (black-list). Can be empty.
1009 *
1010 * @good_tosec: Relocations applied to a section in @fromsec must be
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +05301011 * targeting sections in this array (white-list). Can be empty.
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301012 *
1013 * @mismatch: Type of mismatch.
1014 *
1015 * @symbol_white_list: Do not match a relocation to a symbol in this list
Bhaskar Chowdhuryf3945832021-03-26 11:22:19 +05301016 * even if it is targeting a section in @bad_to_sec.
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301017 *
1018 * @handler: Specific handler to call when a match is found. If NULL,
1019 * default_mismatch_handler() will be called.
1020 *
1021 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001022struct sectioncheck {
1023 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301024 const char *bad_tosec[20];
1025 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001026 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001027 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301028 void (*handler)(const char *modname, struct elf_info *elf,
1029 const struct sectioncheck* const mismatch,
1030 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1031
Sam Ravnborg10668222008-01-13 22:21:31 +01001032};
1033
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301034static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1035 const struct sectioncheck* const mismatch,
1036 Elf_Rela *r, Elf_Sym *sym,
1037 const char *fromsec);
1038
Mathias Krause7a3ee752014-08-27 20:28:53 +09301039static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001040/* Do not reference init/exit code/data from
1041 * normal code and data
1042 */
1043{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001044 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301045 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001046 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001047 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001048},
1049{
1050 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301051 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001052 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001053 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001054},
1055{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001056 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301057 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001058 .mismatch = DATA_TO_ANY_INIT,
1059 .symbol_white_list = {
1060 "*_template", "*_timer", "*_sht", "*_ops",
1061 "*_probe", "*_probe_one", "*_console", NULL
1062 },
1063},
1064{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001065 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301066 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001067 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001068 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001069},
1070{
1071 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301072 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001073 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001074 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001075},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001076/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001077{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001078 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301079 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001080 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001081 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001082},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001083/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001084{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001085 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301086 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001087 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001088 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001089},
1090/* Do not use exit code/data from init code */
1091{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001092 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301093 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001094 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001095 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001096},
1097/* Do not use init code/data from exit code */
1098{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001099 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301100 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001101 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001102 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001103},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001104{
1105 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301106 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001107 .mismatch = ANY_INIT_TO_ANY_EXIT,
1108 .symbol_white_list = { NULL },
1109},
Sam Ravnborg10668222008-01-13 22:21:31 +01001110/* Do not export init/exit functions or data */
1111{
Masahiro Yamadabcf20872022-06-11 03:32:30 +09001112 .fromsec = { "___ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301113 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001114 .mismatch = EXPORT_TO_INIT_EXIT,
1115 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301116},
1117{
1118 .fromsec = { "__ex_table", NULL },
1119 /* If you're adding any new black-listed sections in here, consider
1120 * adding a special 'printer' for them in scripts/check_extable.
1121 */
1122 .bad_tosec = { ".altinstr_replacement", NULL },
1123 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1124 .mismatch = EXTABLE_TO_NON_TEXT,
1125 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001126}
1127};
1128
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001129static const struct sectioncheck *section_mismatch(
1130 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001131{
1132 int i;
1133 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1134 const struct sectioncheck *check = &sectioncheck[0];
1135
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301136 /*
1137 * The target section could be the SHT_NUL section when we're
1138 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001139 * doesn't make much sense and causes build failures on parisc
1140 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301141 */
1142 if (*tosec == '\0')
1143 return NULL;
1144
Sam Ravnborg10668222008-01-13 22:21:31 +01001145 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301146 if (match(fromsec, check->fromsec)) {
1147 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1148 return check;
1149 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1150 return check;
1151 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001152 check++;
1153 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001154 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001155}
1156
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001157/**
1158 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001159 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001160 * Pattern 1:
1161 * If a module parameter is declared __initdata and permissions=0
1162 * then this is legal despite the warning generated.
1163 * We cannot see value of permissions here, so just ignore
1164 * this pattern.
1165 * The pattern is identified by:
1166 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001167 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001168 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001169 *
Rusty Russell6a841522010-08-11 23:04:16 -06001170 * Pattern 1a:
1171 * module_param_call() ops can refer to __init set function if permissions=0
1172 * The pattern is identified by:
1173 * tosec = .init.text
1174 * fromsec = .data*
1175 * atsym = __param_ops_*
1176 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001177 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001178 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001179 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001180 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001181 * tosec = init or exit section
1182 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001183 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1184 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001185 *
1186 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001187 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001188 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001189 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001190 * Some symbols belong to init section but still it is ok to reference
1191 * these from non-init sections as these symbols don't have any memory
1192 * allocated for them and symbol address and value are same. So even
1193 * if init section is freed, its ok to reference those symbols.
1194 * For ex. symbols marking the init section boundaries.
1195 * This pattern is identified by
1196 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001197 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301198 * Pattern 5:
1199 * GCC may optimize static inlines when fed constant arg(s) resulting
1200 * in functions like cpumask_empty() -- generating an associated symbol
1201 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1202 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1203 * meaningless section warning. May need to add isra symbols too...
1204 * This pattern is identified by
1205 * tosec = init section
1206 * fromsec = text section
1207 * refsymname = *.constprop.*
1208 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001209 * Pattern 6:
1210 * Hide section mismatch warnings for ELF local symbols. The goal
1211 * is to eliminate false positive modpost warnings caused by
1212 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1213 * Autogenerated symbol names bypass modpost's "Pattern 2"
1214 * whitelisting, which relies on pattern-matching against symbol
1215 * names to work. (One situation where gcc can autogenerate ELF
1216 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001217 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001218static int secref_whitelist(const struct sectioncheck *mismatch,
1219 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001220 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001221{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001222 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001223 if (match(tosec, init_data_sections) &&
1224 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001225 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001226 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001227
Rusty Russell6a841522010-08-11 23:04:16 -06001228 /* Check for pattern 1a */
1229 if (strcmp(tosec, ".init.text") == 0 &&
1230 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001231 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001232 return 0;
1233
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001234 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001235 if (match(tosec, init_exit_sections) &&
1236 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001237 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001238 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001239
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001240 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001241 if (match(fromsec, head_sections) &&
1242 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001243 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001244
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001245 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001246 if (match(tosym, linker_symbols))
1247 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001248
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301249 /* Check for pattern 5 */
1250 if (match(fromsec, text_sections) &&
1251 match(tosec, init_sections) &&
1252 match(fromsym, optim_symbols))
1253 return 0;
1254
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001255 /* Check for pattern 6 */
1256 if (strstarts(fromsym, ".L"))
1257 return 0;
1258
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001259 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001260}
1261
Sami Tolvanen5818c682018-10-23 15:15:35 -07001262static inline int is_arm_mapping_symbol(const char *str)
1263{
Masahiro Yamada4adc7d72022-05-24 01:46:22 +09001264 return str[0] == '$' &&
1265 (str[1] == 'a' || str[1] == 'd' || str[1] == 't' || str[1] == 'x')
Sami Tolvanen5818c682018-10-23 15:15:35 -07001266 && (str[2] == '\0' || str[2] == '.');
1267}
1268
1269/*
1270 * If there's no name there, ignore it; likewise, ignore it if it's
1271 * one of the magic symbols emitted used by current ARM tools.
1272 *
1273 * Otherwise if find_symbols_between() returns those symbols, they'll
1274 * fail the whitelist tests and cause lots of false alarms ... fixable
1275 * only by merging __exit and __init sections into __text, bloating
1276 * the kernel (which is especially evil on embedded platforms).
1277 */
1278static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1279{
1280 const char *name = elf->strtab + sym->st_name;
1281
1282 if (!name || !strlen(name))
1283 return 0;
1284 return !is_arm_mapping_symbol(name);
1285}
1286
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001287/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001288 * Find symbol based on relocation record info.
1289 * In some cases the symbol supplied is a valid symbol so
1290 * return refsym. If st_name != 0 we assume this is a valid symbol.
1291 * In other cases the symbol needs to be looked up in the symbol table
1292 * based on section and address.
1293 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001294static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001295 Elf_Sym *relsym)
1296{
1297 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001298 Elf_Sym *near = NULL;
1299 Elf64_Sword distance = 20;
1300 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001301 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001302
1303 if (relsym->st_name != 0)
1304 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001305
1306 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001307 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001308 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001309 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001310 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1311 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001312 if (!is_valid_name(elf, sym))
1313 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001314 if (sym->st_value == addr)
1315 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001316 /* Find a symbol nearby - addr are maybe negative */
1317 d = sym->st_value - addr;
1318 if (d < 0)
1319 d = addr - sym->st_value;
1320 if (d < distance) {
1321 distance = d;
1322 near = sym;
1323 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001324 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001325 /* We need a close match */
1326 if (distance < 20)
1327 return near;
1328 else
1329 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001330}
1331
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001332/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001333 * Find symbols before or equal addr and after addr - in the section sec.
1334 * If we find two symbols with equal offset prefer one with a valid name.
1335 * The ELF format may have a better way to detect what type of symbol
1336 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001337 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001338static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1339 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001340{
1341 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001342 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001343 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001344
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001345 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1346 const char *symsec;
1347
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001348 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001349 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001350 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001351 if (strcmp(symsec, sec) != 0)
1352 continue;
David Brownellda68d612007-02-20 13:58:16 -08001353 if (!is_valid_name(elf, sym))
1354 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001355 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001356 if ((addr - sym->st_value) < distance) {
1357 distance = addr - sym->st_value;
1358 near = sym;
1359 } else if ((addr - sym->st_value) == distance) {
1360 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001361 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001362 }
1363 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001364 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001365}
1366
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001367/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001368 * Convert a section name to the function/data attribute
1369 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001370 * .memexitconst => __memconst
1371 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001372 *
1373 * The memory of returned value has been allocated on a heap. The user of this
1374 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001375*/
1376static char *sec2annotation(const char *s)
1377{
1378 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001379 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001380 char *r = p;
1381
1382 *p++ = '_';
1383 *p++ = '_';
1384 if (*s == '.')
1385 s++;
1386 while (*s && *s != '.')
1387 *p++ = *s++;
1388 *p = '\0';
1389 if (*s == '.')
1390 s++;
1391 if (strstr(s, "rodata") != NULL)
1392 strcat(p, "const ");
1393 else if (strstr(s, "data") != NULL)
1394 strcat(p, "data ");
1395 else
1396 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001397 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001398 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001399 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001400 }
1401}
1402
1403static int is_function(Elf_Sym *sym)
1404{
1405 if (sym)
1406 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1407 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001408 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001409}
1410
Randy Dunlap00759c02011-03-15 14:13:47 -07001411static void print_section_list(const char * const list[20])
1412{
1413 const char *const *s = list;
1414
1415 while (*s) {
1416 fprintf(stderr, "%s", *s);
1417 s++;
1418 if (*s)
1419 fprintf(stderr, ", ");
1420 }
1421 fprintf(stderr, "\n");
1422}
1423
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301424static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1425{
1426 switch (is_func) {
1427 case 0: *name = "variable"; *name_p = ""; break;
1428 case 1: *name = "function"; *name_p = "()"; break;
1429 default: *name = "(unknown reference)"; *name_p = ""; break;
1430 }
1431}
1432
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001433/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001434 * Print a warning about a section mismatch.
1435 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001436 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001437 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001438static void report_sec_mismatch(const char *modname,
1439 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001440 const char *fromsec,
1441 unsigned long long fromaddr,
1442 const char *fromsym,
1443 int from_is_func,
1444 const char *tosec, const char *tosym,
1445 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001446{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001447 const char *from, *from_p;
1448 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001449 char *prl_from;
1450 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001451
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001452 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001453
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301454 get_pretty_name(from_is_func, &from, &from_p);
1455 get_pretty_name(to_is_func, &to, &to_p);
1456
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001457 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1458 "to the %s %s:%s%s\n",
1459 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1460 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001461
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001462 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001463 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001464 prl_from = sec2annotation(fromsec);
1465 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001466 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001467 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001468 "the %s %s%s%s.\n"
1469 "This is often because %s lacks a %s\n"
1470 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001471 prl_from, fromsym,
1472 to, prl_to, tosym, to_p,
1473 fromsym, prl_to, tosym);
1474 free(prl_from);
1475 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001476 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001477 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001478 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001479 fprintf(stderr,
1480 "The variable %s references\n"
1481 "the %s %s%s%s\n"
1482 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001483 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001484 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001485 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001486 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001487 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001488 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001489 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001490 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001491 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001492 fprintf(stderr,
1493 "The function %s() references a %s in an exit section.\n"
1494 "Often the %s %s%s has valid usage outside the exit section\n"
1495 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001496 fromsym, to, to, tosym, to_p, prl_to, tosym);
1497 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001498 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001499 case DATA_TO_ANY_EXIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001500 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001501 fprintf(stderr,
1502 "The variable %s references\n"
1503 "the %s %s%s%s\n"
1504 "If the reference is valid then annotate the\n"
1505 "variable with __exit* (see linux/init.h) or "
1506 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001507 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001508 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001509 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001510 break;
1511 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001512 case XXXINIT_TO_SOME_INIT:
1513 case XXXEXIT_TO_SOME_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 "If %s is only used by %s then\n"
1520 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001521 from, prl_from, fromsym, from_p,
1522 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001523 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001524 free(prl_from);
1525 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001526 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001527 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001528 prl_from = sec2annotation(fromsec);
1529 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001530 fprintf(stderr,
1531 "The %s %s%s%s references\n"
1532 "a %s %s%s%s.\n"
1533 "This is often seen when error handling "
1534 "in the init function\n"
1535 "uses functionality in the exit path.\n"
1536 "The fix is often to remove the %sannotation of\n"
1537 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001538 from, prl_from, fromsym, from_p,
1539 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001540 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001541 free(prl_from);
1542 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001543 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001544 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001545 prl_from = sec2annotation(fromsec);
1546 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001547 fprintf(stderr,
1548 "The %s %s%s%s references\n"
1549 "a %s %s%s%s.\n"
1550 "This is often seen when error handling "
1551 "in the exit function\n"
1552 "uses functionality in the init path.\n"
1553 "The fix is often to remove the %sannotation of\n"
1554 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001555 from, prl_from, fromsym, from_p,
1556 to, prl_to, tosym, to_p,
1557 prl_to, tosym, to_p);
1558 free(prl_from);
1559 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001560 break;
1561 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001562 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001563 fprintf(stderr,
1564 "The symbol %s is exported and annotated %s\n"
1565 "Fix this by removing the %sannotation of %s "
1566 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001567 tosym, prl_to, prl_to, tosym);
1568 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001569 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301570 case EXTABLE_TO_NON_TEXT:
1571 fatal("There's a special handler for this mismatch type, "
1572 "we should never get here.");
1573 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001574 }
1575 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001576}
1577
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301578static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1579 const struct sectioncheck* const mismatch,
1580 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1581{
1582 const char *tosec;
1583 Elf_Sym *to;
1584 Elf_Sym *from;
1585 const char *tosym;
1586 const char *fromsym;
1587
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301588 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1589 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301590
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001591 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301592 return;
1593
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301594 tosec = sec_name(elf, get_secindex(elf, sym));
1595 to = find_elf_symbol(elf, r->r_addend, sym);
1596 tosym = sym_name(elf, to);
1597
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301598 /* check whitelist - we may ignore it */
1599 if (secref_whitelist(mismatch,
1600 fromsec, fromsym, tosec, tosym)) {
1601 report_sec_mismatch(modname, mismatch,
1602 fromsec, r->r_offset, fromsym,
1603 is_function(from), tosec, tosym,
1604 is_function(to));
1605 }
1606}
1607
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301608static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1609{
1610 if (section_index > elf->num_sections)
1611 fatal("section_index is outside elf->num_sections!\n");
1612
1613 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1614}
1615
1616/*
1617 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1618 * to know the sizeof(struct exception_table_entry) for the target architecture.
1619 */
1620static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301621static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301622{
1623 /*
1624 * If we're currently checking the second relocation within __ex_table,
1625 * that relocation offset tells us the offsetof(struct
1626 * exception_table_entry, fixup) which is equal to sizeof(struct
1627 * exception_table_entry) divided by two. We use that to our advantage
1628 * since there's no portable way to get that size as every architecture
1629 * seems to go with different sized types. Not pretty but better than
1630 * hard-coding the size for every architecture..
1631 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301632 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301633 extable_entry_size = r->r_offset * 2;
1634}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301635
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301636static inline bool is_extable_fault_address(Elf_Rela *r)
1637{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301638 /*
1639 * extable_entry_size is only discovered after we've handled the
1640 * _second_ relocation in __ex_table, so only abort when we're not
1641 * handling the first reloc and extable_entry_size is zero.
1642 */
1643 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301644 fatal("extable_entry size hasn't been discovered!\n");
1645
1646 return ((r->r_offset == 0) ||
1647 (r->r_offset % extable_entry_size == 0));
1648}
1649
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301650#define is_second_extable_reloc(Start, Cur, Sec) \
1651 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1652
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301653static void report_extable_warnings(const char* modname, struct elf_info* elf,
1654 const struct sectioncheck* const mismatch,
1655 Elf_Rela* r, Elf_Sym* sym,
1656 const char* fromsec, const char* tosec)
1657{
1658 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1659 const char* fromsym_name = sym_name(elf, fromsym);
1660 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1661 const char* tosym_name = sym_name(elf, tosym);
1662 const char* from_pretty_name;
1663 const char* from_pretty_name_p;
1664 const char* to_pretty_name;
1665 const char* to_pretty_name_p;
1666
1667 get_pretty_name(is_function(fromsym),
1668 &from_pretty_name, &from_pretty_name_p);
1669 get_pretty_name(is_function(tosym),
1670 &to_pretty_name, &to_pretty_name_p);
1671
1672 warn("%s(%s+0x%lx): Section mismatch in reference"
1673 " from the %s %s%s to the %s %s:%s%s\n",
1674 modname, fromsec, (long)r->r_offset, from_pretty_name,
1675 fromsym_name, from_pretty_name_p,
1676 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1677
1678 if (!match(tosec, mismatch->bad_tosec) &&
1679 is_executable_section(elf, get_secindex(elf, sym)))
1680 fprintf(stderr,
1681 "The relocation at %s+0x%lx references\n"
1682 "section \"%s\" which is not in the list of\n"
1683 "authorized sections. If you're adding a new section\n"
1684 "and/or if this reference is valid, add \"%s\" to the\n"
1685 "list of authorized sections to jump to on fault.\n"
1686 "This can be achieved by adding \"%s\" to \n"
1687 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1688 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1689}
1690
1691static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1692 const struct sectioncheck* const mismatch,
1693 Elf_Rela* r, Elf_Sym* sym,
1694 const char *fromsec)
1695{
1696 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1697
1698 sec_mismatch_count++;
1699
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001700 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301701
1702 if (match(tosec, mismatch->bad_tosec))
1703 fatal("The relocation at %s+0x%lx references\n"
1704 "section \"%s\" which is black-listed.\n"
1705 "Something is seriously wrong and should be fixed.\n"
1706 "You might get more information about where this is\n"
1707 "coming from by using scripts/check_extable.sh %s\n",
1708 fromsec, (long)r->r_offset, tosec, modname);
1709 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1710 if (is_extable_fault_address(r))
1711 fatal("The relocation at %s+0x%lx references\n"
1712 "section \"%s\" which is not executable, IOW\n"
1713 "it is not possible for the kernel to fault\n"
1714 "at that address. Something is seriously wrong\n"
1715 "and should be fixed.\n",
1716 fromsec, (long)r->r_offset, tosec);
1717 else
1718 fatal("The relocation at %s+0x%lx references\n"
1719 "section \"%s\" which is not executable, IOW\n"
1720 "the kernel will fault if it ever tries to\n"
1721 "jump to it. Something is seriously wrong\n"
1722 "and should be fixed.\n",
1723 fromsec, (long)r->r_offset, tosec);
1724 }
1725}
1726
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001727static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001728 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001729{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001730 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301731 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001732
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001733 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301734 if (mismatch->handler)
1735 mismatch->handler(modname, elf, mismatch,
1736 r, sym, fromsec);
1737 else
1738 default_mismatch_handler(modname, elf, mismatch,
1739 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001740 }
1741}
1742
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001743static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001744 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001745{
Masahiro Yamadad2e4d052020-05-25 14:47:04 +09001746 return sym_get_data_by_offset(elf, sechdr->sh_info, r->r_offset);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001747}
1748
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001749static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001750{
1751 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001752 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001753
1754 switch (r_typ) {
1755 case R_386_32:
1756 r->r_addend = TO_NATIVE(*location);
1757 break;
1758 case R_386_PC32:
1759 r->r_addend = TO_NATIVE(*location) + 4;
1760 /* For CONFIG_RELOCATABLE=y */
1761 if (elf->hdr->e_type == ET_EXEC)
1762 r->r_addend += r->r_offset;
1763 break;
1764 }
1765 return 0;
1766}
1767
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001768#ifndef R_ARM_CALL
1769#define R_ARM_CALL 28
1770#endif
1771#ifndef R_ARM_JUMP24
1772#define R_ARM_JUMP24 29
1773#endif
1774
David A. Longc9698e52014-02-14 22:41:18 +01001775#ifndef R_ARM_THM_CALL
1776#define R_ARM_THM_CALL 10
1777#endif
1778#ifndef R_ARM_THM_JUMP24
1779#define R_ARM_THM_JUMP24 30
1780#endif
1781#ifndef R_ARM_THM_JUMP19
1782#define R_ARM_THM_JUMP19 51
1783#endif
1784
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001785static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001786{
1787 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1788
1789 switch (r_typ) {
1790 case R_ARM_ABS32:
1791 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001792 r->r_addend = (int)(long)
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001793 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001794 break;
1795 case R_ARM_PC24:
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001796 case R_ARM_CALL:
1797 case R_ARM_JUMP24:
David A. Longc9698e52014-02-14 22:41:18 +01001798 case R_ARM_THM_CALL:
1799 case R_ARM_THM_JUMP24:
1800 case R_ARM_THM_JUMP19:
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001801 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001802 r->r_addend = (int)(long)(elf->hdr +
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001803 sechdr->sh_offset +
1804 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001805 break;
1806 default:
1807 return 1;
1808 }
1809 return 0;
1810}
1811
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001812static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001813{
1814 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001815 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001816 unsigned int inst;
1817
1818 if (r_typ == R_MIPS_HI16)
1819 return 1; /* skip this */
1820 inst = TO_NATIVE(*location);
1821 switch (r_typ) {
1822 case R_MIPS_LO16:
1823 r->r_addend = inst & 0xffff;
1824 break;
1825 case R_MIPS_26:
1826 r->r_addend = (inst & 0x03ffffff) << 2;
1827 break;
1828 case R_MIPS_32:
1829 r->r_addend = inst;
1830 break;
1831 }
1832 return 0;
1833}
1834
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001835static void section_rela(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001836 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001837{
1838 Elf_Sym *sym;
1839 Elf_Rela *rela;
1840 Elf_Rela r;
1841 unsigned int r_sym;
1842 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001843
Sam Ravnborgff13f922008-01-23 19:54:27 +01001844 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001845 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1846
Sam Ravnborgff13f922008-01-23 19:54:27 +01001847 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001848 fromsec += strlen(".rela");
1849 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001850 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001851 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001852
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001853 for (rela = start; rela < stop; rela++) {
1854 r.r_offset = TO_NATIVE(rela->r_offset);
1855#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001856 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001857 unsigned int r_typ;
1858 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1859 r_sym = TO_NATIVE(r_sym);
1860 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1861 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1862 } else {
1863 r.r_info = TO_NATIVE(rela->r_info);
1864 r_sym = ELF_R_SYM(r.r_info);
1865 }
1866#else
1867 r.r_info = TO_NATIVE(rela->r_info);
1868 r_sym = ELF_R_SYM(r.r_info);
1869#endif
1870 r.r_addend = TO_NATIVE(rela->r_addend);
1871 sym = elf->symtab_start + r_sym;
1872 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001873 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001874 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301875 if (is_second_extable_reloc(start, rela, fromsec))
1876 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001877 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001878 }
1879}
1880
1881static void section_rel(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001882 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001883{
1884 Elf_Sym *sym;
1885 Elf_Rel *rel;
1886 Elf_Rela r;
1887 unsigned int r_sym;
1888 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001889
Sam Ravnborgff13f922008-01-23 19:54:27 +01001890 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001891 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1892
Sam Ravnborgff13f922008-01-23 19:54:27 +01001893 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001894 fromsec += strlen(".rel");
1895 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001896 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001897 return;
1898
1899 for (rel = start; rel < stop; rel++) {
1900 r.r_offset = TO_NATIVE(rel->r_offset);
1901#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001902 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001903 unsigned int r_typ;
1904 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1905 r_sym = TO_NATIVE(r_sym);
1906 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1907 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1908 } else {
1909 r.r_info = TO_NATIVE(rel->r_info);
1910 r_sym = ELF_R_SYM(r.r_info);
1911 }
1912#else
1913 r.r_info = TO_NATIVE(rel->r_info);
1914 r_sym = ELF_R_SYM(r.r_info);
1915#endif
1916 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001917 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001918 case EM_386:
1919 if (addend_386_rel(elf, sechdr, &r))
1920 continue;
1921 break;
1922 case EM_ARM:
1923 if (addend_arm_rel(elf, sechdr, &r))
1924 continue;
1925 break;
1926 case EM_MIPS:
1927 if (addend_mips_rel(elf, sechdr, &r))
1928 continue;
1929 break;
1930 }
1931 sym = elf->symtab_start + r_sym;
1932 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001933 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001934 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301935 if (is_second_extable_reloc(start, rel, fromsec))
1936 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001937 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001938 }
1939}
1940
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001941/**
1942 * A module includes a number of sections that are discarded
1943 * either when loaded or when used as built-in.
1944 * For loaded modules all functions marked __init and all data
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001945 * marked __initdata will be discarded when the module has been initialized.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001946 * Likewise for modules used built-in the sections marked __exit
1947 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001948 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001949 * The check_sec_ref() function traverses all relocation records
1950 * to find all references to a section that reference a section that will
1951 * be discarded and warns about it.
1952 **/
1953static void check_sec_ref(struct module *mod, const char *modname,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001954 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001955{
1956 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001957 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001958
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001959 /* Walk through all sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001960 for (i = 0; i < elf->num_sections; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001961 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001962 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001963 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001964 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001965 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001966 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001967 }
1968}
1969
Andi Kleen7d02b492014-02-08 09:01:12 +01001970static char *remove_dot(char *s)
1971{
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301972 size_t n = strcspn(s, ".");
Andi Kleen7d02b492014-02-08 09:01:12 +01001973
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301974 if (n && s[n]) {
1975 size_t m = strspn(s + n + 1, "0123456789");
Alexander Lobakina53131a2022-05-24 17:27:18 +02001976 if (m && (s[n + m + 1] == '.' || s[n + m + 1] == 0))
Andi Kleen7d02b492014-02-08 09:01:12 +01001977 s[n] = 0;
Sami Tolvanen7ac204b2020-12-11 10:46:27 -08001978
1979 /* strip trailing .lto */
1980 if (strends(s, ".lto"))
1981 s[strlen(s) - 4] = '\0';
Andi Kleen7d02b492014-02-08 09:01:12 +01001982 }
1983 return s;
1984}
1985
Masahiro Yamada8b185742018-05-09 18:50:40 +09001986static void read_symbols(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987{
1988 const char *symname;
1989 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02001990 char *license;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01001991 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 struct module *mod;
1993 struct elf_info info = { };
1994 Elf_Sym *sym;
1995
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01001996 if (!parse_elf(&info, modname))
1997 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09001999 {
2000 char *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002002 /* strip trailing .o */
2003 tmp = NOFAIL(strdup(modname));
2004 tmp[strlen(tmp) - 2] = '\0';
Sami Tolvanen7ac204b2020-12-11 10:46:27 -08002005 /* strip trailing .lto */
2006 if (strends(tmp, ".lto"))
2007 tmp[strlen(tmp) - 4] = '\0';
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002008 mod = new_module(tmp);
2009 free(tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 }
2011
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002012 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002013 license = get_modinfo(&info, "license");
2014 if (!license)
Masahiro Yamada1d6cd3922020-12-01 19:34:16 +09002015 error("missing MODULE_LICENSE() in %s\n", modname);
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002016 while (license) {
2017 if (license_is_gpl_compatible(license))
2018 mod->gpl_compatible = 1;
2019 else {
2020 mod->gpl_compatible = 0;
2021 break;
2022 }
2023 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002024 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002025
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002026 namespace = get_modinfo(&info, "import_ns");
2027 while (namespace) {
2028 add_namespace(&mod->imported_namespaces, namespace);
2029 namespace = get_next_modinfo(&info, "import_ns",
2030 namespace);
2031 }
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002032 }
2033
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002035 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002037 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 handle_moddevtable(mod, &info, sym, symname);
2039 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002040
Matthias Maennich69923202019-10-18 10:31:42 +01002041 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2042 symname = remove_dot(info.strtab + sym->st_name);
2043
Masahiro Yamada17436942019-11-15 02:42:24 +09002044 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002045 if (strstarts(symname, "__kstrtabns_"))
2046 sym_update_namespace(symname + strlen("__kstrtabns_"),
2047 namespace_from_kstrtabns(&info,
2048 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002049
2050 if (strstarts(symname, "__crc_"))
2051 handle_modversion(mod, &info, sym,
2052 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002053 }
2054
Denis Efremov15bfc232019-08-01 09:06:57 +03002055 // check for static EXPORT_SYMBOL_* functions && global vars
2056 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2057 unsigned char bind = ELF_ST_BIND(sym->st_info);
2058
2059 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2060 struct symbol *s =
2061 find_symbol(remove_dot(info.strtab +
2062 sym->st_name));
2063
2064 if (s)
2065 s->is_static = 0;
2066 }
2067 }
2068
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002069 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002071 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002072 version = get_modinfo(&info, "version");
2073 if (version || all_versions)
Masahiro Yamadae54dd932021-08-28 18:50:59 +09002074 get_src_version(mod->name, mod->srcversion,
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002075 sizeof(mod->srcversion) - 1);
2076 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077
2078 parse_elf_finish(&info);
2079
Rusty Russell8c8ef422009-03-31 13:05:34 -06002080 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 * never passed as an argument to an exported function, so
2082 * the automatic versioning doesn't pick it up, but it's really
2083 * important anyhow */
2084 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06002085 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086}
2087
Rusty Russell712f9b42013-04-04 17:37:38 +10302088static void read_symbols_from_files(const char *filename)
2089{
2090 FILE *in = stdin;
2091 char fname[PATH_MAX];
2092
2093 if (strcmp(filename, "-") != 0) {
2094 in = fopen(filename, "r");
2095 if (!in)
2096 fatal("Can't open filenames file %s: %m", filename);
2097 }
2098
2099 while (fgets(fname, PATH_MAX, in) != NULL) {
2100 if (strends(fname, "\n"))
2101 fname[strlen(fname)-1] = '\0';
2102 read_symbols(fname);
2103 }
2104
2105 if (in != stdin)
2106 fclose(in);
2107}
2108
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109#define SZ 500
2110
2111/* We first write the generated file into memory using the
2112 * following helper, then compare to the file on disk and
2113 * only update the later if anything changed */
2114
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002115void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
2116 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117{
2118 char tmp[SZ];
2119 int len;
2120 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002121
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 va_start(ap, fmt);
2123 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002124 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 va_end(ap);
2126}
2127
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002128void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129{
2130 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002131 buf->size += len + SZ;
Randy Dunlap1f3aa902018-08-15 12:30:38 -07002132 buf->p = NOFAIL(realloc(buf->p, buf->size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 }
2134 strncpy(buf->p + buf->pos, s, len);
2135 buf->pos += len;
2136}
2137
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002138static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
2139{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002140 switch (exp) {
2141 case export_gpl:
Masahiro Yamadad6d692f2020-12-01 19:34:17 +09002142 error("GPL-incompatible module %s.ko uses GPL-only symbol '%s'\n",
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002143 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002144 break;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002145 case export_plain:
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002146 case export_unknown:
2147 /* ignore */
2148 break;
2149 }
2150}
2151
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002152static void check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002153{
2154 struct symbol *s, *exp;
2155
2156 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002157 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002158 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002159 if (!exp || exp->module == mod) {
Masahiro Yamada4475dff2021-03-26 03:54:11 +09002160 if (!s->weak && nr_unresolved++ < MAX_UNRESOLVED_REPORTS)
Jessica Yu93c95e52020-03-06 17:02:05 +01002161 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2162 "\"%s\" [%s.ko] undefined!\n",
2163 s->name, mod->name);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002164 continue;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002165 }
Andrew Morton6449bd62006-06-09 20:45:06 -07002166 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002167 if (basename)
2168 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002169 else
2170 basename = mod->name;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002171
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002172 if (exp->namespace &&
2173 !module_imports_namespace(mod, exp->namespace)) {
Jessica Yu54b77842020-03-06 17:02:06 +01002174 modpost_log(allow_missing_ns_imports ? LOG_WARN : LOG_ERROR,
2175 "module %s uses symbol %s from namespace %s, but does not import it.\n",
2176 basename, exp->name, exp->namespace);
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002177 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002178 }
2179
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002180 if (!mod->gpl_compatible)
2181 check_for_gpl_usage(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002182 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002183}
2184
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002185static void check_modname_len(struct module *mod)
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002186{
2187 const char *mod_name;
2188
2189 mod_name = strrchr(mod->name, '/');
2190 if (mod_name == NULL)
2191 mod_name = mod->name;
2192 else
2193 mod_name++;
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002194 if (strlen(mod_name) >= MODULE_NAME_LEN)
Masahiro Yamadabc72d722020-12-01 19:34:14 +09002195 error("module name is too long [%s.ko]\n", mod->name);
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002196}
2197
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002198/**
2199 * Header for the generated file
2200 **/
2201static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202{
2203 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002204 /*
2205 * Include build-salt.h after module.h in order to
2206 * inherit the definitions.
2207 */
Leon Romanovsky51161bf2020-04-19 18:55:06 +03002208 buf_printf(b, "#define INCLUDE_VERMAGIC\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002209 buf_printf(b, "#include <linux/build-salt.h>\n");
Yonghong Song1fdd7432021-04-01 16:27:23 -07002210 buf_printf(b, "#include <linux/elfnote-lto.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 buf_printf(b, "#include <linux/vermagic.h>\n");
2212 buf_printf(b, "#include <linux/compiler.h>\n");
2213 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002214 buf_printf(b, "BUILD_SALT;\n");
Yonghong Song1fdd7432021-04-01 16:27:23 -07002215 buf_printf(b, "BUILD_LTO_INFO;\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002216 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002218 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302220 buf_printf(b, "__visible struct module __this_module\n");
Joe Perches33def842020-10-21 19:36:07 -07002221 buf_printf(b, "__section(\".gnu.linkonce.this_module\") = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002222 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002224 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 if (mod->has_cleanup)
2226 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002227 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002229 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 buf_printf(b, "};\n");
2231}
2232
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002233static void add_intree_flag(struct buffer *b, int is_intree)
2234{
2235 if (is_intree)
2236 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2237}
2238
Will McVicker4b9c11a2020-11-19 13:46:37 -08002239/**
2240 * add_scmversion() - Adds the MODULE_INFO macro for the scmversion.
2241 * @b: Buffer to append to.
2242 *
2243 * This function fills in the module attribute `scmversion` for the kernel
2244 * module. This is useful for determining a given module's SCM version on
2245 * device via /sys/modules/<module>/scmversion and/or using the modinfo tool.
2246 */
2247static void add_scmversion(struct buffer *b)
2248{
2249 if (module_scmversion[0] != '\0')
2250 buf_printf(b, "\nMODULE_INFO(scmversion, \"%s\");\n", module_scmversion);
2251}
2252
Andi Kleencaf75012018-01-25 15:50:28 -08002253/* Cannot check for assembler */
2254static void add_retpoline(struct buffer *b)
2255{
WANG Chaoe4f35892018-12-11 00:37:25 +08002256 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002257 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2258 buf_printf(b, "#endif\n");
2259}
2260
Trevor Keith5c725132009-09-22 16:43:38 -07002261static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002262{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002263 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002264 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2265}
2266
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002267/**
2268 * Record CRCs for unresolved symbols
2269 **/
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002270static void add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271{
2272 struct symbol *s, *exp;
2273
2274 for (s = mod->unres; s; s = s->next) {
2275 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002276 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 s->module = exp->module;
2279 s->crc_valid = exp->crc_valid;
2280 s->crc = exp->crc;
2281 }
2282
2283 if (!modversions)
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002284 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285
2286 buf_printf(b, "\n");
2287 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Joe Perches33def842020-10-21 19:36:07 -07002288 buf_printf(b, "__used __section(\"__versions\") = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289
2290 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002291 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002294 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 s->name, mod->name);
2296 continue;
2297 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302298 if (strlen(s->name) >= MODULE_NAME_LEN) {
Masahiro Yamadabc72d722020-12-01 19:34:14 +09002299 error("too long symbol \"%s\" [%s.ko]\n",
2300 s->name, mod->name);
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302301 break;
2302 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002303 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302304 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 }
2306
2307 buf_printf(b, "};\n");
2308}
2309
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002310static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311{
2312 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313 int first = 1;
2314
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002315 /* Clear ->seen flag of modules that own symbols needed by this. */
2316 for (s = mod->unres; s; s = s->next)
2317 if (s->module)
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002318 s->module->seen = s->module->is_vmlinux;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319
2320 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002321 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002323 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 if (!s->module)
2325 continue;
2326
2327 if (s->module->seen)
2328 continue;
2329
2330 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002331 p = strrchr(s->module->name, '/');
2332 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002333 p++;
2334 else
2335 p = s->module->name;
2336 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 first = 0;
2338 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002339 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340}
2341
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002342static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343{
2344 if (mod->srcversion[0]) {
2345 buf_printf(b, "\n");
2346 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2347 mod->srcversion);
2348 }
2349}
2350
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002351static void write_buf(struct buffer *b, const char *fname)
2352{
2353 FILE *file;
2354
2355 file = fopen(fname, "w");
2356 if (!file) {
2357 perror(fname);
2358 exit(1);
2359 }
2360 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2361 perror(fname);
2362 exit(1);
2363 }
2364 if (fclose(file) != 0) {
2365 perror(fname);
2366 exit(1);
2367 }
2368}
2369
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002370static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371{
2372 char *tmp;
2373 FILE *file;
2374 struct stat st;
2375
2376 file = fopen(fname, "r");
2377 if (!file)
2378 goto write;
2379
2380 if (fstat(fileno(file), &st) < 0)
2381 goto close_write;
2382
2383 if (st.st_size != b->pos)
2384 goto close_write;
2385
2386 tmp = NOFAIL(malloc(b->pos));
2387 if (fread(tmp, 1, b->pos, file) != b->pos)
2388 goto free_write;
2389
2390 if (memcmp(tmp, b->p, b->pos) != 0)
2391 goto free_write;
2392
2393 free(tmp);
2394 fclose(file);
2395 return;
2396
2397 free_write:
2398 free(tmp);
2399 close_write:
2400 fclose(file);
2401 write:
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002402 write_buf(b, fname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403}
2404
Ram Paibd5cbce2006-06-08 22:12:53 -07002405/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002406 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002407 **/
Masahiro Yamada52c34162020-06-01 14:57:05 +09002408static void read_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409{
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002410 char *buf, *pos, *line;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002412 buf = read_text_file(fname);
2413 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414 /* No symbol versions, silently ignore */
2415 return;
2416
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002417 pos = buf;
2418
2419 while ((line = get_line(&pos))) {
Jessica Yu51900442020-03-11 18:01:20 +01002420 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 unsigned int crc;
2422 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002423 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424
2425 if (!(symname = strchr(line, '\t')))
2426 goto fail;
2427 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002428 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 goto fail;
2430 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002431 if (!(export = strchr(modname, '\t')))
2432 goto fail;
2433 *export++ = '\0';
2434 if (!(namespace = strchr(export, '\t')))
2435 goto fail;
2436 *namespace++ = '\0';
2437
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 crc = strtoul(line, &d, 16);
2439 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2440 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002441 mod = find_module(modname);
2442 if (!mod) {
Jan Beulich0fa3a882009-03-12 12:28:30 +00002443 mod = new_module(modname);
Masahiro Yamada52c34162020-06-01 14:57:05 +09002444 mod->from_dump = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002446 s = sym_add_exported(symname, mod, export_no(export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002447 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002448 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002449 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 }
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002451 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452 return;
2453fail:
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002454 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 fatal("parse error in symbol dump file\n");
2456}
2457
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002458static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459{
2460 struct buffer buf = { };
2461 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002462 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 int n;
2464
2465 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2466 symbol = symbolhash[n];
2467 while (symbol) {
Masahiro Yamada69bc8d32021-03-26 03:54:09 +09002468 if (!symbol->module->from_dump) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002469 namespace = symbol->namespace;
2470 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2471 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002472 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002473 export_str(symbol->export),
2474 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002475 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 symbol = symbol->next;
2477 }
2478 }
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002479 write_buf(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002480 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481}
2482
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002483static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002484{
2485 struct module *mod;
2486 struct namespace_list *ns;
2487 struct buffer ns_deps_buf = {};
2488
2489 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002490
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002491 if (mod->from_dump || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002492 continue;
2493
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002494 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002495
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002496 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2497 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002498
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002499 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002500 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002501
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002502 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002503 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002504}
2505
Masahiro Yamada79247992020-06-01 14:57:07 +09002506struct dump_list {
2507 struct dump_list *next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002508 const char *file;
2509};
2510
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002511int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512{
2513 struct module *mod;
2514 struct buffer buf = { };
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002515 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302516 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 int opt;
Denis Efremov15bfc232019-08-01 09:06:57 +03002518 int n;
Masahiro Yamada79247992020-06-01 14:57:07 +09002519 struct dump_list *dump_read_start = NULL;
2520 struct dump_list **dump_read_iter = &dump_read_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521
Will McVicker4b9c11a2020-11-19 13:46:37 -08002522 while ((opt = getopt(argc, argv, "ei:mnT:o:awENd:v:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002523 switch (opt) {
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002524 case 'e':
2525 external_module = 1;
Masahiro Yamadae3fb4df2020-06-01 14:57:08 +09002526 break;
2527 case 'i':
Masahiro Yamada79247992020-06-01 14:57:07 +09002528 *dump_read_iter =
2529 NOFAIL(calloc(1, sizeof(**dump_read_iter)));
2530 (*dump_read_iter)->file = optarg;
2531 dump_read_iter = &(*dump_read_iter)->next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002532 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002533 case 'm':
2534 modversions = 1;
2535 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302536 case 'n':
2537 ignore_missing_files = 1;
2538 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002539 case 'o':
2540 dump_write = optarg;
2541 break;
2542 case 'a':
2543 all_versions = 1;
2544 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302545 case 'T':
2546 files_source = optarg;
2547 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002548 case 'w':
2549 warn_unresolved = 1;
2550 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302551 case 'E':
Masahiro Yamadac7299d92020-12-01 19:34:18 +09002552 sec_mismatch_warn_only = false;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302553 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002554 case 'N':
2555 allow_missing_ns_imports = 1;
2556 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002557 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002558 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002559 break;
Will McVicker4b9c11a2020-11-19 13:46:37 -08002560 case 'v':
2561 strncpy(module_scmversion, optarg, sizeof(module_scmversion) - 1);
2562 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002563 default:
2564 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565 }
2566 }
2567
Masahiro Yamada79247992020-06-01 14:57:07 +09002568 while (dump_read_start) {
2569 struct dump_list *tmp;
Masahiro Yamada2beee862020-06-01 14:57:04 +09002570
Masahiro Yamada79247992020-06-01 14:57:07 +09002571 read_dump(dump_read_start->file);
2572 tmp = dump_read_start->next;
2573 free(dump_read_start);
2574 dump_read_start = tmp;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002575 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002577 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579
Rusty Russell712f9b42013-04-04 17:37:38 +10302580 if (files_source)
2581 read_symbols_from_files(files_source);
2582
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002583 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302584 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002585
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002586 if (mod->is_vmlinux || mod->from_dump)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002587 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588
2589 buf.pos = 0;
2590
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002591 check_modname_len(mod);
2592 check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002593
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002595 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002596 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002597 add_staging_flag(&buf, mod->name);
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002598 add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002599 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 add_moddevtable(&buf, mod);
2601 add_srcversion(&buf, mod);
Will McVicker4b9c11a2020-11-19 13:46:37 -08002602 add_scmversion(&buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603
2604 sprintf(fname, "%s.mod.c", mod->name);
2605 write_if_changed(&buf, fname);
2606 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002607
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002608 if (missing_namespace_deps)
2609 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002610
Linus Torvalds1da177e2005-04-16 15:20:36 -07002611 if (dump_write)
2612 write_dump(dump_write);
Masahiro Yamadac7299d92020-12-01 19:34:18 +09002613 if (sec_mismatch_count && !sec_mismatch_warn_only)
2614 error("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002615 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002616 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002617 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002618
Masahiro Yamada47346e92019-09-24 21:07:40 +09002619 for (s = symbolhash[n]; s; s = s->next) {
Denis Efremov15bfc232019-08-01 09:06:57 +03002620 if (s->is_static)
Greg Kroah-Hartman09059c62021-02-02 11:31:33 +01002621 error("\"%s\" [%s] is a static %s\n",
2622 s->name, s->module->name,
2623 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002624 }
2625 }
2626
Masahiro Yamada4475dff2021-03-26 03:54:11 +09002627 if (nr_unresolved > MAX_UNRESOLVED_REPORTS)
2628 warn("suppressed %u unresolved symbol warnings because there were too many)\n",
2629 nr_unresolved - MAX_UNRESOLVED_REPORTS);
2630
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002631 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632
Masahiro Yamada0fd3fba2020-12-01 19:34:15 +09002633 return error_occurred ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634}