blob: ebfa9b76ba9227af4889c46db9d0f657ec1e8267 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Postprocess module symbol versions
2 *
3 * Copyright 2003 Kai Germaschewski
4 * Copyright 2002-2004 Rusty Russell, IBM Corporation
Sam Ravnborgdf578e72008-01-11 19:17:15 +01005 * Copyright 2006-2008 Sam Ravnborg
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Based in part on module-init-tools/depmod.c,file2alias
7 *
8 * This software may be used and distributed according to the terms
9 * of the GNU General Public License, incorporated herein by reference.
10 *
11 * Usage: modpost vmlinux module1.o module2.o ...
12 */
13
Mathieu Desnoyersb2e3e652008-02-13 15:03:39 -080014#define _GNU_SOURCE
Masahiro Yamada5370d4a2020-01-05 00:36:51 +090015#include <elf.h>
Mathieu Desnoyersb2e3e652008-02-13 15:03:39 -080016#include <stdio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <ctype.h>
Andrew Morton5003bab2010-08-11 00:42:26 -070018#include <string.h>
Rusty Russell712f9b42013-04-04 17:37:38 +103019#include <limits.h>
Rusty Russelld4ef1c32013-04-04 17:37:32 +103020#include <stdbool.h>
Guenter Roeckeed380f2013-09-23 15:23:54 +093021#include <errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include "modpost.h"
Sam Ravnborgb817f6f2006-06-09 21:53:55 +020023#include "../../include/linux/license.h"
Alan Jenkins9e1b9b82009-11-07 21:03:54 +000024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/* Are we using CONFIG_MODVERSIONS? */
Mathias Krause7a3ee752014-08-27 20:28:53 +093026static int modversions = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070027/* Warn about undefined symbols? (do so if we have vmlinux) */
Mathias Krause7a3ee752014-08-27 20:28:53 +093028static int have_vmlinux = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029/* Is CONFIG_MODULE_SRCVERSION_ALL set? */
30static int all_versions = 0;
Sam Ravnborg040fcc82006-01-28 22:15:55 +010031/* If we are modposting external module set to 1 */
32static int external_module = 0;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -070033/* Only warn about unresolved symbols */
34static int warn_unresolved = 0;
Ram Paibd5cbce2006-06-08 22:12:53 -070035/* How a symbol is exported */
Sam Ravnborg588ccd72008-01-24 21:12:37 +010036static int sec_mismatch_count = 0;
Nicolas Boichat47490ec2015-10-06 09:44:42 +103037static int sec_mismatch_fatal = 0;
Guenter Roeckeed380f2013-09-23 15:23:54 +093038/* ignore missing files */
39static int ignore_missing_files;
Jessica Yu54b77842020-03-06 17:02:06 +010040/* If set to 1, only warn (instead of error) about missing ns imports */
41static int allow_missing_ns_imports;
Sam Ravnborg588ccd72008-01-24 21:12:37 +010042
Sam Ravnborgc96fca22006-07-01 11:44:23 +020043enum export {
44 export_plain, export_unused, export_gpl,
45 export_unused_gpl, export_gpl_future, export_unknown
46};
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +080048/* In kernel, this size is defined in linux/module.h;
49 * here we use Elf_Addr instead of long for covering cross-compile
50 */
51
52#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
53
Jessica Yu93c95e52020-03-06 17:02:05 +010054void __attribute__((format(printf, 2, 3)))
55modpost_log(enum loglevel loglevel, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056{
57 va_list arglist;
58
Jessica Yu93c95e52020-03-06 17:02:05 +010059 switch (loglevel) {
60 case LOG_WARN:
61 fprintf(stderr, "WARNING: ");
62 break;
63 case LOG_ERROR:
64 fprintf(stderr, "ERROR: ");
65 break;
66 case LOG_FATAL:
67 fprintf(stderr, "FATAL: ");
68 break;
69 default: /* invalid loglevel, ignore */
70 break;
71 }
72
73 fprintf(stderr, "modpost: ");
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75 va_start(arglist, fmt);
76 vfprintf(stderr, fmt, arglist);
77 va_end(arglist);
78
Jessica Yu93c95e52020-03-06 17:02:05 +010079 if (loglevel == LOG_FATAL)
80 exit(1);
Matthew Wilcox2a116652006-10-07 05:35:32 -060081}
82
Rusty Russelld4ef1c32013-04-04 17:37:32 +103083static inline bool strends(const char *str, const char *postfix)
84{
85 if (strlen(str) < strlen(postfix))
86 return false;
87
88 return strcmp(str + strlen(str) - strlen(postfix), postfix) == 0;
89}
90
Sam Ravnborg040fcc82006-01-28 22:15:55 +010091static int is_vmlinux(const char *modname)
92{
93 const char *myname;
94
Sam Ravnborgdf578e72008-01-11 19:17:15 +010095 myname = strrchr(modname, '/');
96 if (myname)
Sam Ravnborg040fcc82006-01-28 22:15:55 +010097 myname++;
98 else
99 myname = modname;
100
Sam Ravnborg741f98f2007-07-17 10:54:06 +0200101 return (strcmp(myname, "vmlinux") == 0) ||
102 (strcmp(myname, "vmlinux.o") == 0);
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100103}
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105void *do_nofail(void *ptr, const char *expr)
106{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100107 if (!ptr)
Jessica Yu93c95e52020-03-06 17:02:05 +0100108 fatal("Memory allocation failure: %s.\n", expr);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 return ptr;
111}
112
Masahiro Yamadaac5100f2020-06-01 14:57:17 +0900113char *read_text_file(const char *filename)
114{
115 struct stat st;
116 size_t nbytes;
117 int fd;
118 char *buf;
119
120 fd = open(filename, O_RDONLY);
121 if (fd < 0) {
122 perror(filename);
123 exit(1);
124 }
125
126 if (fstat(fd, &st) < 0) {
127 perror(filename);
128 exit(1);
129 }
130
131 buf = NOFAIL(malloc(st.st_size + 1));
132
133 nbytes = st.st_size;
134
135 while (nbytes) {
136 ssize_t bytes_read;
137
138 bytes_read = read(fd, buf, nbytes);
139 if (bytes_read < 0) {
140 perror(filename);
141 exit(1);
142 }
143
144 nbytes -= bytes_read;
145 }
146 buf[st.st_size] = '\0';
147
148 close(fd);
149
150 return buf;
151}
152
153char *get_line(char **stringp)
154{
155 /* do not return the unwanted extra line at EOF */
156 if (*stringp && **stringp == '\0')
157 return NULL;
158
159 return strsep(stringp, "\n");
160}
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162/* A list of all modules we processed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163static struct module *modules;
164
Masahiro Yamada8b185742018-05-09 18:50:40 +0900165static struct module *find_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
167 struct module *mod;
168
169 for (mod = modules; mod; mod = mod->next)
170 if (strcmp(mod->name, modname) == 0)
171 break;
172 return mod;
173}
174
Rusty Russelld4ef1c32013-04-04 17:37:32 +1030175static struct module *new_module(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176{
177 struct module *mod;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100178
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900179 mod = NOFAIL(malloc(sizeof(*mod) + strlen(modname) + 1));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 memset(mod, 0, sizeof(*mod));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
182 /* add to list */
Masahiro Yamadaa82f7942020-06-01 14:57:29 +0900183 strcpy(mod->name, modname);
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900184 mod->is_vmlinux = is_vmlinux(modname);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200185 mod->gpl_compatible = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 mod->next = modules;
187 modules = mod;
188
Masahiro Yamada858b9372020-06-01 14:57:28 +0900189 if (mod->is_vmlinux)
190 have_vmlinux = 1;
191
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 return mod;
193}
194
195/* A hash of all exported symbols,
196 * struct symbol is also used for lists of unresolved symbols */
197
198#define SYMBOL_HASH_SIZE 1024
199
200struct symbol {
201 struct symbol *next;
202 struct module *module;
203 unsigned int crc;
204 int crc_valid;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900205 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 unsigned int weak:1;
Denis Efremov15bfc232019-08-01 09:06:57 +0300207 unsigned int is_static:1; /* 1 if symbol is not global */
Ram Paibd5cbce2006-06-08 22:12:53 -0700208 enum export export; /* Type of export */
Gustavo A. R. Silva859c8172020-05-07 13:56:01 -0500209 char name[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210};
211
212static struct symbol *symbolhash[SYMBOL_HASH_SIZE];
213
214/* This is based on the hash agorithm from gdbm, via tdb */
215static inline unsigned int tdb_hash(const char *name)
216{
217 unsigned value; /* Used to compute the hash value. */
218 unsigned i; /* Used to cycle through random values. */
219
220 /* Set the initial value from the key size. */
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100221 for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));
223
224 return (1103515243 * value + 12345);
225}
226
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100227/**
228 * Allocate a new symbols for use in the hash of exported symbols or
229 * the list of unresolved symbols per module
230 **/
231static struct symbol *alloc_symbol(const char *name, unsigned int weak,
232 struct symbol *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233{
234 struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));
235
236 memset(s, 0, sizeof(*s));
237 strcpy(s->name, name);
238 s->weak = weak;
239 s->next = next;
Denis Efremov15bfc232019-08-01 09:06:57 +0300240 s->is_static = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 return s;
242}
243
244/* For the hash of exported symbols */
Ram Paibd5cbce2006-06-08 22:12:53 -0700245static struct symbol *new_symbol(const char *name, struct module *module,
246 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247{
248 unsigned int hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250 hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900251 symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
252
253 return symbolhash[hash];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254}
255
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100256static struct symbol *find_symbol(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257{
258 struct symbol *s;
259
260 /* For our purposes, .foo matches foo. PPC64 needs this. */
261 if (name[0] == '.')
262 name++;
263
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100264 for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 if (strcmp(s->name, name) == 0)
266 return s;
267 }
268 return NULL;
269}
270
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100271static bool contains_namespace(struct namespace_list *list,
272 const char *namespace)
273{
Masahiro Yamada76b54cf2019-10-29 21:38:09 +0900274 for (; list; list = list->next)
275 if (!strcmp(list->namespace, namespace))
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100276 return true;
277
278 return false;
279}
280
281static void add_namespace(struct namespace_list **list, const char *namespace)
282{
283 struct namespace_list *ns_entry;
284
285 if (!contains_namespace(*list, namespace)) {
286 ns_entry = NOFAIL(malloc(sizeof(struct namespace_list) +
287 strlen(namespace) + 1));
288 strcpy(ns_entry->namespace, namespace);
289 ns_entry->next = *list;
290 *list = ns_entry;
291 }
292}
293
294static bool module_imports_namespace(struct module *module,
295 const char *namespace)
296{
297 return contains_namespace(module->imported_namespaces, namespace);
298}
299
Mathias Krause7a3ee752014-08-27 20:28:53 +0930300static const struct {
Ram Paibd5cbce2006-06-08 22:12:53 -0700301 const char *str;
302 enum export export;
303} export_list[] = {
304 { .str = "EXPORT_SYMBOL", .export = export_plain },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200305 { .str = "EXPORT_UNUSED_SYMBOL", .export = export_unused },
Ram Paibd5cbce2006-06-08 22:12:53 -0700306 { .str = "EXPORT_SYMBOL_GPL", .export = export_gpl },
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200307 { .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
Ram Paibd5cbce2006-06-08 22:12:53 -0700308 { .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
309 { .str = "(unknown)", .export = export_unknown },
310};
311
312
313static const char *export_str(enum export ex)
314{
315 return export_list[ex].str;
316}
317
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100318static enum export export_no(const char *s)
Ram Paibd5cbce2006-06-08 22:12:53 -0700319{
320 int i;
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100321
Sam Ravnborg534b89a2006-07-01 10:10:19 +0200322 if (!s)
323 return export_unknown;
Ram Paibd5cbce2006-06-08 22:12:53 -0700324 for (i = 0; export_list[i].export != export_unknown; i++) {
325 if (strcmp(export_list[i].str, s) == 0)
326 return export_list[i].export;
327 }
328 return export_unknown;
329}
330
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900331static void *sym_get_data_by_offset(const struct elf_info *info,
332 unsigned int secindex, unsigned long offset)
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900333{
Xiao Yang4b8a5cf2020-03-18 18:34:16 +0800334 Elf_Shdr *sechdr = &info->sechdrs[secindex];
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900335
Masahiro Yamadaafa04592019-11-15 02:42:21 +0900336 if (info->hdr->e_type != ET_REL)
337 offset -= sechdr->sh_addr;
338
339 return (void *)info->hdr + sechdr->sh_offset + offset;
340}
341
Masahiro Yamadad2e4d052020-05-25 14:47:04 +0900342static void *sym_get_data(const struct elf_info *info, const Elf_Sym *sym)
343{
344 return sym_get_data_by_offset(info, get_secindex(info, sym),
345 sym->st_value);
346}
347
Masahiro Yamada565587d2020-05-25 14:47:05 +0900348static const char *sech_name(const struct elf_info *info, Elf_Shdr *sechdr)
349{
350 return sym_get_data_by_offset(info, info->secindex_strings,
351 sechdr->sh_name);
352}
353
354static const char *sec_name(const struct elf_info *info, int secindex)
355{
356 return sech_name(info, &info->sechdrs[secindex]);
357}
358
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200359#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)
360
361static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
362{
363 const char *secname = sec_name(elf, sec);
364
365 if (strstarts(secname, "___ksymtab+"))
366 return export_plain;
367 else if (strstarts(secname, "___ksymtab_unused+"))
368 return export_unused;
369 else if (strstarts(secname, "___ksymtab_gpl+"))
370 return export_gpl;
371 else if (strstarts(secname, "___ksymtab_unused_gpl+"))
372 return export_unused_gpl;
373 else if (strstarts(secname, "___ksymtab_gpl_future+"))
374 return export_gpl_future;
375 else
376 return export_unknown;
377}
378
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200379static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
Ram Paibd5cbce2006-06-08 22:12:53 -0700380{
381 if (sec == elf->export_sec)
382 return export_plain;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200383 else if (sec == elf->export_unused_sec)
384 return export_unused;
Ram Paibd5cbce2006-06-08 22:12:53 -0700385 else if (sec == elf->export_gpl_sec)
386 return export_gpl;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200387 else if (sec == elf->export_unused_gpl_sec)
388 return export_unused_gpl;
Ram Paibd5cbce2006-06-08 22:12:53 -0700389 else if (sec == elf->export_gpl_future_sec)
390 return export_gpl_future;
391 else
392 return export_unknown;
393}
394
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900395static const char *namespace_from_kstrtabns(const struct elf_info *info,
396 const Elf_Sym *sym)
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100397{
Masahiro Yamadae84f9fb2019-11-15 02:42:22 +0900398 const char *value = sym_get_data(info, sym);
Matthias Maennich69923202019-10-18 10:31:42 +0100399 return value[0] ? value : NULL;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100400}
401
Matthias Maennicha2b11182019-10-18 10:31:40 +0100402static void sym_update_namespace(const char *symname, const char *namespace)
403{
404 struct symbol *s = find_symbol(symname);
405
406 /*
407 * That symbol should have been created earlier and thus this is
408 * actually an assertion.
409 */
410 if (!s) {
411 merror("Could not update namespace(%s) for symbol %s\n",
412 namespace, symname);
413 return;
414 }
415
416 free(s->namespace);
417 s->namespace =
418 namespace && namespace[0] ? NOFAIL(strdup(namespace)) : NULL;
419}
420
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100421/**
422 * Add an exported symbol - it may have already been added without a
423 * CRC, in this case just update the CRC
424 **/
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100425static struct symbol *sym_add_exported(const char *name, struct module *mod,
426 enum export export)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427{
428 struct symbol *s = find_symbol(name);
429
430 if (!s) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700431 s = new_symbol(name, mod, export);
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900432 } else if (!external_module || s->module->is_vmlinux ||
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900433 s->module == mod) {
434 warn("%s: '%s' exported twice. Previous export was in %s%s\n",
435 mod->name, name, s->module->name,
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900436 s->module->is_vmlinux ? "" : ".ko");
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900437 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 }
Masahiro Yamada7ef9ab32019-11-15 02:42:26 +0900439
440 s->module = mod;
Ram Paibd5cbce2006-06-08 22:12:53 -0700441 s->export = export;
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100442 return s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443}
444
Masahiro Yamada17436942019-11-15 02:42:24 +0900445static void sym_set_crc(const char *name, unsigned int crc)
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100446{
447 struct symbol *s = find_symbol(name);
448
Masahiro Yamada17436942019-11-15 02:42:24 +0900449 /*
450 * Ignore stand-alone __crc_*, which might be auto-generated symbols
451 * such as __*_veneer in ARM ELF.
452 */
453 if (!s)
454 return;
455
Sam Ravnborg040fcc82006-01-28 22:15:55 +0100456 s->crc = crc;
457 s->crc_valid = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458}
459
Masahiro Yamada75893572020-06-01 14:57:21 +0900460static void *grab_file(const char *filename, unsigned long *size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461{
462 struct stat st;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930463 void *map = MAP_FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 int fd;
465
466 fd = open(filename, O_RDONLY);
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930467 if (fd < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 return NULL;
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930469 if (fstat(fd, &st))
470 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
472 *size = st.st_size;
473 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
Jesper Juhleb3d5cc2012-05-23 22:28:49 +0930475failed:
476 close(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 if (map == MAP_FAILED)
478 return NULL;
479 return map;
480}
481
Masahiro Yamada75893572020-06-01 14:57:21 +0900482static void release_file(void *file, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483{
484 munmap(file, size);
485}
486
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100487static int parse_elf(struct elf_info *info, const char *filename)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488{
489 unsigned int i;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100490 Elf_Ehdr *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 Elf_Shdr *sechdrs;
492 Elf_Sym *sym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200493 const char *secstrings;
494 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
496 hdr = grab_file(filename, &info->size);
497 if (!hdr) {
Guenter Roeckeed380f2013-09-23 15:23:54 +0930498 if (ignore_missing_files) {
499 fprintf(stderr, "%s: %s (ignored)\n", filename,
500 strerror(errno));
501 return 0;
502 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 perror(filename);
Sam Ravnborg6803dc02006-06-24 23:46:54 +0200504 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 }
506 info->hdr = hdr;
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100507 if (info->size < sizeof(*hdr)) {
508 /* file too small, assume this is an empty .o file */
509 return 0;
510 }
511 /* Is this a valid ELF file? */
512 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
513 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
514 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
515 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
516 /* Not an ELF file - silently ignore it */
517 return 0;
518 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 /* Fix endianness in ELF header */
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200520 hdr->e_type = TO_NATIVE(hdr->e_type);
521 hdr->e_machine = TO_NATIVE(hdr->e_machine);
522 hdr->e_version = TO_NATIVE(hdr->e_version);
523 hdr->e_entry = TO_NATIVE(hdr->e_entry);
524 hdr->e_phoff = TO_NATIVE(hdr->e_phoff);
525 hdr->e_shoff = TO_NATIVE(hdr->e_shoff);
526 hdr->e_flags = TO_NATIVE(hdr->e_flags);
527 hdr->e_ehsize = TO_NATIVE(hdr->e_ehsize);
528 hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
529 hdr->e_phnum = TO_NATIVE(hdr->e_phnum);
530 hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
531 hdr->e_shnum = TO_NATIVE(hdr->e_shnum);
532 hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 sechdrs = (void *)hdr + hdr->e_shoff;
534 info->sechdrs = sechdrs;
535
Petr Stetiara83710e2007-08-27 12:15:07 +0200536 /* Check if file offset is correct */
537 if (hdr->e_shoff > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100538 fatal("section header offset=%lu in file '%s' is bigger than "
539 "filesize=%lu\n", (unsigned long)hdr->e_shoff,
540 filename, info->size);
Petr Stetiara83710e2007-08-27 12:15:07 +0200541 return 0;
542 }
543
Anders Kaseorg68457562011-05-19 16:55:27 -0600544 if (hdr->e_shnum == SHN_UNDEF) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200545 /*
546 * There are more than 64k sections,
547 * read count from .sh_size.
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200548 */
549 info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
550 }
551 else {
552 info->num_sections = hdr->e_shnum;
553 }
554 if (hdr->e_shstrndx == SHN_XINDEX) {
Anders Kaseorg68457562011-05-19 16:55:27 -0600555 info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200556 }
557 else {
558 info->secindex_strings = hdr->e_shstrndx;
559 }
560
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 /* Fix endianness in section headers */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200562 for (i = 0; i < info->num_sections; i++) {
Anders Kaseorg7d875a02009-05-03 22:02:55 +0200563 sechdrs[i].sh_name = TO_NATIVE(sechdrs[i].sh_name);
564 sechdrs[i].sh_type = TO_NATIVE(sechdrs[i].sh_type);
565 sechdrs[i].sh_flags = TO_NATIVE(sechdrs[i].sh_flags);
566 sechdrs[i].sh_addr = TO_NATIVE(sechdrs[i].sh_addr);
567 sechdrs[i].sh_offset = TO_NATIVE(sechdrs[i].sh_offset);
568 sechdrs[i].sh_size = TO_NATIVE(sechdrs[i].sh_size);
569 sechdrs[i].sh_link = TO_NATIVE(sechdrs[i].sh_link);
570 sechdrs[i].sh_info = TO_NATIVE(sechdrs[i].sh_info);
571 sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
572 sechdrs[i].sh_entsize = TO_NATIVE(sechdrs[i].sh_entsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 }
574 /* Find symbol table. */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200575 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
576 for (i = 1; i < info->num_sections; i++) {
Ram Paibd5cbce2006-06-08 22:12:53 -0700577 const char *secname;
Tejun Heo56fc82c2009-02-06 00:48:02 +0900578 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
Tejun Heo56fc82c2009-02-06 00:48:02 +0900580 if (!nobits && sechdrs[i].sh_offset > info->size) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100581 fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
582 "sizeof(*hrd)=%zu\n", filename,
583 (unsigned long)sechdrs[i].sh_offset,
584 sizeof(*hdr));
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100585 return 0;
586 }
Ram Paibd5cbce2006-06-08 22:12:53 -0700587 secname = secstrings + sechdrs[i].sh_name;
588 if (strcmp(secname, ".modinfo") == 0) {
Tejun Heo56fc82c2009-02-06 00:48:02 +0900589 if (nobits)
590 fatal("%s has NOBITS .modinfo\n", filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
592 info->modinfo_len = sechdrs[i].sh_size;
Ram Paibd5cbce2006-06-08 22:12:53 -0700593 } else if (strcmp(secname, "__ksymtab") == 0)
594 info->export_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200595 else if (strcmp(secname, "__ksymtab_unused") == 0)
596 info->export_unused_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700597 else if (strcmp(secname, "__ksymtab_gpl") == 0)
598 info->export_gpl_sec = i;
Sam Ravnborgc96fca22006-07-01 11:44:23 +0200599 else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
600 info->export_unused_gpl_sec = i;
Ram Paibd5cbce2006-06-08 22:12:53 -0700601 else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
602 info->export_gpl_future_sec = i;
603
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200604 if (sechdrs[i].sh_type == SHT_SYMTAB) {
605 unsigned int sh_link_idx;
606 symtab_idx = i;
607 info->symtab_start = (void *)hdr +
608 sechdrs[i].sh_offset;
609 info->symtab_stop = (void *)hdr +
610 sechdrs[i].sh_offset + sechdrs[i].sh_size;
Anders Kaseorg68457562011-05-19 16:55:27 -0600611 sh_link_idx = sechdrs[i].sh_link;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200612 info->strtab = (void *)hdr +
613 sechdrs[sh_link_idx].sh_offset;
614 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200616 /* 32bit section no. table? ("more than 64k sections") */
617 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
618 symtab_shndx_idx = i;
619 info->symtab_shndx_start = (void *)hdr +
620 sechdrs[i].sh_offset;
621 info->symtab_shndx_stop = (void *)hdr +
622 sechdrs[i].sh_offset + sechdrs[i].sh_size;
623 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 }
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100625 if (!info->symtab_start)
Sam Ravnborgcb805142006-01-28 16:57:26 +0100626 fatal("%s has no symtab?\n", filename);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 /* Fix endianness in symbols */
629 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
630 sym->st_shndx = TO_NATIVE(sym->st_shndx);
631 sym->st_name = TO_NATIVE(sym->st_name);
632 sym->st_value = TO_NATIVE(sym->st_value);
633 sym->st_size = TO_NATIVE(sym->st_size);
634 }
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200635
636 if (symtab_shndx_idx != ~0U) {
637 Elf32_Word *p;
Anders Kaseorg68457562011-05-19 16:55:27 -0600638 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200639 fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
Anders Kaseorg68457562011-05-19 16:55:27 -0600640 filename, sechdrs[symtab_shndx_idx].sh_link,
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +0200641 symtab_idx);
642 /* Fix endianness */
643 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
644 p++)
645 *p = TO_NATIVE(*p);
646 }
647
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +0100648 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649}
650
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100651static void parse_elf_finish(struct elf_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652{
653 release_file(info->hdr, info->size);
654}
655
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200656static int ignore_undef_symbol(struct elf_info *info, const char *symname)
657{
658 /* ignore __this_module, it will be resolved shortly */
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900659 if (strcmp(symname, "__this_module") == 0)
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200660 return 1;
661 /* ignore global offset table */
662 if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
663 return 1;
664 if (info->hdr->e_machine == EM_PPC)
665 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900666 if (strstarts(symname, "_restgpr_") ||
667 strstarts(symname, "_savegpr_") ||
668 strstarts(symname, "_rest32gpr_") ||
669 strstarts(symname, "_save32gpr_") ||
670 strstarts(symname, "_restvr_") ||
671 strstarts(symname, "_savevr_"))
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200672 return 1;
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000673 if (info->hdr->e_machine == EM_PPC64)
674 /* Special register function linked on all modules during final link of .ko */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900675 if (strstarts(symname, "_restgpr0_") ||
676 strstarts(symname, "_savegpr0_") ||
677 strstarts(symname, "_restvr_") ||
678 strstarts(symname, "_savevr_") ||
Alan Modrac1536932016-01-15 20:52:22 +1100679 strcmp(symname, ".TOC.") == 0)
Stephen Rothwell7fca5dc2010-06-29 20:08:42 +0000680 return 1;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200681 /* Do not ignore this symbol */
682 return 0;
683}
684
Masahiro Yamada17436942019-11-15 02:42:24 +0900685static void handle_modversion(const struct module *mod,
686 const struct elf_info *info,
687 const Elf_Sym *sym, const char *symname)
688{
689 unsigned int crc;
690
691 if (sym->st_shndx == SHN_UNDEF) {
692 warn("EXPORT symbol \"%s\" [%s%s] version generation failed, symbol will not be versioned.\n",
Masahiro Yamada5a438af2020-06-01 14:57:26 +0900693 symname, mod->name, mod->is_vmlinux ? "" : ".ko");
Masahiro Yamada17436942019-11-15 02:42:24 +0900694 return;
695 }
696
697 if (sym->st_shndx == SHN_ABS) {
698 crc = sym->st_value;
699 } else {
700 unsigned int *crcp;
701
702 /* symbol points to the CRC in the ELF object */
703 crcp = sym_get_data(info, sym);
704 crc = TO_NATIVE(*crcp);
705 }
706 sym_set_crc(symname, crc);
707}
708
Masahiro Yamada9bd2a092019-11-15 02:42:23 +0900709static void handle_symbol(struct module *mod, struct elf_info *info,
710 const Elf_Sym *sym, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711{
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200712 enum export export;
Masahiro Yamada389eb3f2019-10-03 16:58:22 +0900713 const char *name;
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200714
Masahiro Yamada33795762020-06-01 14:57:24 +0900715 if (strstarts(symname, "__ksymtab"))
Alessio Igor Bogani62a26352011-07-14 08:51:16 +0200716 export = export_from_secname(info, get_secindex(info, sym));
717 else
718 export = export_from_sec(info, get_secindex(info, sym));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
720 switch (sym->st_shndx) {
721 case SHN_COMMON:
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900722 if (strstarts(symname, "__gnu_lto_")) {
Andi Kleenef178f92014-02-08 09:01:17 +0100723 /* Should warn here, but modpost runs before the linker */
724 } else
725 warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 case SHN_UNDEF:
728 /* undefined symbol */
729 if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
730 ELF_ST_BIND(sym->st_info) != STB_WEAK)
731 break;
Sam Ravnborg4d7365d2008-06-12 15:02:55 +0200732 if (ignore_undef_symbol(info, symname))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 if (info->hdr->e_machine == EM_SPARC ||
735 info->hdr->e_machine == EM_SPARCV9) {
736 /* Ignore register directives. */
Ben Colline8d529012005-08-19 13:44:57 -0700737 if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 break;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100739 if (symname[0] == '.') {
Randy Dunlap1f3aa902018-08-15 12:30:38 -0700740 char *munged = NOFAIL(strdup(symname));
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100741 munged[0] = '_';
742 munged[1] = toupper(munged[1]);
743 symname = munged;
744 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 }
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100746
Rusty Russellb92021b2013-03-15 15:04:17 +1030747 mod->unres = alloc_symbol(symname,
748 ELF_ST_BIND(sym->st_info) == STB_WEAK,
749 mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 break;
751 default:
752 /* All exported symbols */
Masahiro Yamadad62c4762018-05-09 18:50:38 +0900753 if (strstarts(symname, "__ksymtab_")) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +0100754 name = symname + strlen("__ksymtab_");
Matthias Maennich9ae5bd12019-10-18 10:31:41 +0100755 sym_add_exported(name, mod, export);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900757 if (strcmp(symname, "init_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 mod->has_init = 1;
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +0900759 if (strcmp(symname, "cleanup_module") == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 mod->has_cleanup = 1;
761 break;
762 }
763}
764
Sam Ravnborg5c3ead82006-01-28 17:19:35 +0100765/**
766 * Parse tag=value strings from .modinfo section
767 **/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768static char *next_string(char *string, unsigned long *secsize)
769{
770 /* Skip non-zero chars */
771 while (string[0]) {
772 string++;
773 if ((*secsize)-- <= 1)
774 return NULL;
775 }
776
777 /* Skip any zero padding. */
778 while (!string[0]) {
779 string++;
780 if ((*secsize)-- <= 1)
781 return NULL;
782 }
783 return string;
784}
785
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900786static char *get_next_modinfo(struct elf_info *info, const char *tag,
787 char *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788{
789 char *p;
790 unsigned int taglen = strlen(tag);
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900791 char *modinfo = info->modinfo;
792 unsigned long size = info->modinfo_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900794 if (prev) {
795 size -= prev - modinfo;
796 modinfo = next_string(prev, &size);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200797 }
798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 for (p = modinfo; p; p = next_string(p, &size)) {
800 if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
801 return p + taglen + 1;
802 }
803 return NULL;
804}
805
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900806static char *get_modinfo(struct elf_info *info, const char *tag)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200807
808{
Masahiro Yamadabca2cce2018-05-09 18:50:37 +0900809 return get_next_modinfo(info, tag, NULL);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +0200810}
811
Sam Ravnborg93684d32006-02-19 11:53:35 +0100812/**
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100813 * Test if string s ends in string sub
814 * return 0 if match
815 **/
816static int strrcmp(const char *s, const char *sub)
817{
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100818 int slen, sublen;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100819
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100820 if (!s || !sub)
821 return 1;
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100822
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100823 slen = strlen(s);
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100824 sublen = strlen(sub);
Sam Ravnborg62070fa2006-03-03 16:46:04 +0100825
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100826 if ((slen == 0) || (sublen == 0))
827 return 1;
828
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100829 if (sublen > slen)
830 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100831
Sam Ravnborgdf578e72008-01-11 19:17:15 +0100832 return memcmp(s + slen - sublen, sub, sublen);
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +0100833}
834
Sam Ravnborgff13f922008-01-23 19:54:27 +0100835static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
836{
Sam Ravnborg58fb0d42008-01-23 21:13:50 +0100837 if (sym)
838 return elf->strtab + sym->st_name;
839 else
Sam Ravnborgf6667512008-02-06 21:51:18 +0100840 return "(unknown)";
Sam Ravnborgff13f922008-01-23 19:54:27 +0100841}
842
Sam Ravnborg10668222008-01-13 22:21:31 +0100843/* The pattern is an array of simple patterns.
844 * "foo" will match an exact string equal to "foo"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100845 * "*foo" will match a string that ends with "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100846 * "foo*" will match a string that begins with "foo"
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930847 * "*foo*" will match a string that contains "foo"
Sam Ravnborg10668222008-01-13 22:21:31 +0100848 */
Trevor Keith5c725132009-09-22 16:43:38 -0700849static int match(const char *sym, const char * const pat[])
Sam Ravnborg10668222008-01-13 22:21:31 +0100850{
851 const char *p;
852 while (*pat) {
853 p = *pat++;
854 const char *endp = p + strlen(p) - 1;
855
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930856 /* "*foo*" */
857 if (*p == '*' && *endp == '*') {
Denis Efremov6f02bdf2019-08-27 15:20:23 +0300858 char *bare = NOFAIL(strndup(p + 1, strlen(p) - 2));
859 char *here = strstr(sym, bare);
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930860
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930861 free(bare);
862 if (here != NULL)
863 return 1;
864 }
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100865 /* "*foo" */
Paul Gortmaker09c20c02015-04-20 10:20:26 +0930866 else if (*p == '*') {
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100867 if (strrcmp(sym, p + 1) == 0)
868 return 1;
869 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100870 /* "foo*" */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100871 else if (*endp == '*') {
Sam Ravnborg10668222008-01-13 22:21:31 +0100872 if (strncmp(sym, p, strlen(p) - 1) == 0)
873 return 1;
874 }
Sam Ravnborg10668222008-01-13 22:21:31 +0100875 /* no wildcards */
876 else {
877 if (strcmp(p, sym) == 0)
878 return 1;
879 }
880 }
881 /* no match */
882 return 0;
883}
884
Sam Ravnborg10668222008-01-13 22:21:31 +0100885/* sections that we do not want to do full section mismatch check on */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930886static const char *const section_white_list[] =
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200887{
888 ".comment*",
889 ".debug*",
Chen Gang4d10c222013-08-20 15:33:19 +0930890 ".cranges", /* sh64 */
H.J. Lu11215842010-12-15 17:11:22 -0800891 ".zdebug*", /* Compressed debug sections. */
David Howells739d8752018-03-08 09:48:46 +0000892 ".GCC.command.line", /* record-gcc-switches */
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200893 ".mdebug*", /* alpha, score, mips etc. */
894 ".pdr", /* alpha, score, mips etc. */
895 ".stab*",
896 ".note*",
897 ".got*",
898 ".toc*",
Max Filippovaf42e972012-09-17 05:44:38 +0400899 ".xt.prop", /* xtensa */
900 ".xt.lit", /* xtensa */
Vineet Guptaf2e207f2013-01-21 17:18:57 +1030901 ".arcextmap*", /* arc */
902 ".gnu.linkonce.arcext*", /* arc : modules */
Noam Camusd1189c62015-10-26 19:51:46 +1030903 ".cmem*", /* EZchip */
904 ".fmt_slot*", /* EZchip */
Andi Kleenef178f92014-02-08 09:01:17 +0100905 ".gnu.lto*",
Josh Poimboeufe390f9a2017-03-01 12:04:44 -0600906 ".discard.*",
Sam Ravnborg4391ed62009-05-04 13:05:26 +0200907 NULL
908};
Sam Ravnborg10668222008-01-13 22:21:31 +0100909
Sam Ravnborge241a632008-01-28 20:13:13 +0100910/*
Anders Kaseorgb614a692009-04-23 16:49:33 -0400911 * This is used to find sections missing the SHF_ALLOC flag.
Sam Ravnborge241a632008-01-28 20:13:13 +0100912 * The cause of this is often a section specified in assembler
Anders Kaseorgb614a692009-04-23 16:49:33 -0400913 * without "ax" / "aw".
Sam Ravnborge241a632008-01-28 20:13:13 +0100914 */
Anders Kaseorgb614a692009-04-23 16:49:33 -0400915static void check_section(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +0900916 Elf_Shdr *sechdr)
Sam Ravnborge241a632008-01-28 20:13:13 +0100917{
Anders Kaseorgb614a692009-04-23 16:49:33 -0400918 const char *sec = sech_name(elf, sechdr);
Sam Ravnborge241a632008-01-28 20:13:13 +0100919
Anders Kaseorgb614a692009-04-23 16:49:33 -0400920 if (sechdr->sh_type == SHT_PROGBITS &&
921 !(sechdr->sh_flags & SHF_ALLOC) &&
922 !match(sec, section_white_list)) {
923 warn("%s (%s): unexpected non-allocatable section.\n"
924 "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
925 "Note that for example <linux/init.h> contains\n"
926 "section definitions for use in .S files.\n\n",
927 modname, sec);
Sam Ravnborge241a632008-01-28 20:13:13 +0100928 }
Sam Ravnborge241a632008-01-28 20:13:13 +0100929}
930
931
932
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100933#define ALL_INIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930934 ".init.setup", ".init.rodata", ".meminit.rodata", \
935 ".init.data", ".meminit.data"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100936#define ALL_EXIT_DATA_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930937 ".exit.data", ".memexit.data"
Sam Ravnborg10668222008-01-13 22:21:31 +0100938
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100939#define ALL_INIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930940 ".init.text", ".meminit.text"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100941#define ALL_EXIT_TEXT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930942 ".exit.text", ".memexit.text"
Sam Ravnborg10668222008-01-13 22:21:31 +0100943
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200944#define ALL_PCI_INIT_SECTIONS \
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930945 ".pci_fixup_early", ".pci_fixup_header", ".pci_fixup_final", \
946 ".pci_fixup_enable", ".pci_fixup_resume", \
947 ".pci_fixup_resume_early", ".pci_fixup_suspend"
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +0200948
Paul Gortmakere24f6622013-06-19 19:30:48 -0400949#define ALL_XXXINIT_SECTIONS MEM_INIT_SECTIONS
950#define ALL_XXXEXIT_SECTIONS MEM_EXIT_SECTIONS
Uwe Kleine-König4a31a222010-01-29 12:04:26 +0100951
952#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
953#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
Sam Ravnborg10668222008-01-13 22:21:31 +0100954
Rasmus Villemoesa0d8f802014-07-27 07:28:01 +0930955#define DATA_SECTIONS ".data", ".data.rel"
Quentin Casasnovas157d1972015-04-13 20:42:52 +0930956#define TEXT_SECTIONS ".text", ".text.unlikely", ".sched.text", \
Chris Metcalf6727ad92016-10-07 17:02:55 -0700957 ".kprobes.text", ".cpuidle.text"
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930958#define OTHER_TEXT_SECTIONS ".ref.text", ".head.text", ".spinlock.text", \
Chris Metcalf673c2c32015-07-08 17:07:41 -0400959 ".fixup", ".entry.text", ".exception.text", ".text.*", \
960 ".coldtext"
Sam Ravnborg10668222008-01-13 22:21:31 +0100961
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000962#define INIT_SECTIONS ".init.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000963#define MEM_INIT_SECTIONS ".meminit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100964
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000965#define EXIT_SECTIONS ".exit.*"
Jan Beulichfd6c3a82009-03-12 10:58:33 +0000966#define MEM_EXIT_SECTIONS ".memexit.*"
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100967
Quentin Casasnovas52dc0592015-04-13 20:52:53 +0930968#define ALL_TEXT_SECTIONS ALL_INIT_TEXT_SECTIONS, ALL_EXIT_TEXT_SECTIONS, \
969 TEXT_SECTIONS, OTHER_TEXT_SECTIONS
970
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100971/* init data sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930972static const char *const init_data_sections[] =
973 { ALL_INIT_DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100974
975/* all init sections */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930976static const char *const init_sections[] = { ALL_INIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100977
978/* All init and exit sections (code + data) */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930979static const char *const init_exit_sections[] =
Sam Ravnborgeb8f6892008-01-20 20:07:28 +0100980 {ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100981
Paul Gortmaker4a3893d2015-04-20 10:20:40 +0930982/* all text sections */
983static const char *const text_sections[] = { ALL_TEXT_SECTIONS, NULL };
984
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100985/* data section */
Mathias Krause7a3ee752014-08-27 20:28:53 +0930986static const char *const data_sections[] = { DATA_SECTIONS, NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100987
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100988
989/* symbols in .data that may refer to init/exit sections */
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +0100990#define DEFAULT_SYMBOL_WHITE_LIST \
991 "*driver", \
992 "*_template", /* scsi uses *_template a lot */ \
993 "*_timer", /* arm uses ops structures named _timer a lot */ \
994 "*_sht", /* scsi also used *_sht to some extent */ \
995 "*_ops", \
996 "*_probe", \
997 "*_probe_one", \
998 "*_console"
Sam Ravnborg6c5bd232008-01-20 10:43:27 +0100999
Mathias Krause7a3ee752014-08-27 20:28:53 +09301000static const char *const head_sections[] = { ".head.text*", NULL };
1001static const char *const linker_symbols[] =
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001002 { "__init_begin", "_sinittext", "_einittext", NULL };
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301003static const char *const optim_symbols[] = { "*.constprop.*", NULL };
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001004
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001005enum mismatch {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001006 TEXT_TO_ANY_INIT,
1007 DATA_TO_ANY_INIT,
1008 TEXT_TO_ANY_EXIT,
1009 DATA_TO_ANY_EXIT,
1010 XXXINIT_TO_SOME_INIT,
1011 XXXEXIT_TO_SOME_EXIT,
1012 ANY_INIT_TO_ANY_EXIT,
1013 ANY_EXIT_TO_ANY_INIT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001014 EXPORT_TO_INIT_EXIT,
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301015 EXTABLE_TO_NON_TEXT,
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001016};
1017
Quentin Casasnovase5d8f592015-04-13 20:55:15 +09301018/**
1019 * Describe how to match sections on different criterias:
1020 *
1021 * @fromsec: Array of sections to be matched.
1022 *
1023 * @bad_tosec: Relocations applied to a section in @fromsec to a section in
1024 * this array is forbidden (black-list). Can be empty.
1025 *
1026 * @good_tosec: Relocations applied to a section in @fromsec must be
1027 * targetting sections in this array (white-list). Can be empty.
1028 *
1029 * @mismatch: Type of mismatch.
1030 *
1031 * @symbol_white_list: Do not match a relocation to a symbol in this list
1032 * even if it is targetting a section in @bad_to_sec.
1033 *
1034 * @handler: Specific handler to call when a match is found. If NULL,
1035 * default_mismatch_handler() will be called.
1036 *
1037 */
Sam Ravnborg10668222008-01-13 22:21:31 +01001038struct sectioncheck {
1039 const char *fromsec[20];
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301040 const char *bad_tosec[20];
1041 const char *good_tosec[20];
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001042 enum mismatch mismatch;
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001043 const char *symbol_white_list[20];
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301044 void (*handler)(const char *modname, struct elf_info *elf,
1045 const struct sectioncheck* const mismatch,
1046 Elf_Rela *r, Elf_Sym *sym, const char *fromsec);
1047
Sam Ravnborg10668222008-01-13 22:21:31 +01001048};
1049
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301050static void extable_mismatch_handler(const char *modname, struct elf_info *elf,
1051 const struct sectioncheck* const mismatch,
1052 Elf_Rela *r, Elf_Sym *sym,
1053 const char *fromsec);
1054
Mathias Krause7a3ee752014-08-27 20:28:53 +09301055static const struct sectioncheck sectioncheck[] = {
Sam Ravnborg10668222008-01-13 22:21:31 +01001056/* Do not reference init/exit code/data from
1057 * normal code and data
1058 */
1059{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001060 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301061 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001062 .mismatch = TEXT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001063 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001064},
1065{
1066 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301067 .bad_tosec = { ALL_XXXINIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001068 .mismatch = DATA_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001069 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001070},
1071{
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001072 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301073 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-König0db252452010-01-30 21:14:23 +01001074 .mismatch = DATA_TO_ANY_INIT,
1075 .symbol_white_list = {
1076 "*_template", "*_timer", "*_sht", "*_ops",
1077 "*_probe", "*_probe_one", "*_console", NULL
1078 },
1079},
1080{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001081 .fromsec = { TEXT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301082 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001083 .mismatch = TEXT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001084 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001085},
1086{
1087 .fromsec = { DATA_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301088 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001089 .mismatch = DATA_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001090 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001091},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001092/* Do not reference init code/data from meminit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001093{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001094 .fromsec = { ALL_XXXINIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301095 .bad_tosec = { INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001096 .mismatch = XXXINIT_TO_SOME_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001097 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001098},
Paul Gortmakere24f6622013-06-19 19:30:48 -04001099/* Do not reference exit code/data from memexit code/data */
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001100{
Uwe Kleine-König4a31a222010-01-29 12:04:26 +01001101 .fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301102 .bad_tosec = { EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001103 .mismatch = XXXEXIT_TO_SOME_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001104 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001105},
1106/* Do not use exit code/data from init code */
1107{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001108 .fromsec = { ALL_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301109 .bad_tosec = { ALL_EXIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001110 .mismatch = ANY_INIT_TO_ANY_EXIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001111 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001112},
1113/* Do not use init code/data from exit code */
1114{
Sam Ravnborgeb8f6892008-01-20 20:07:28 +01001115 .fromsec = { ALL_EXIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301116 .bad_tosec = { ALL_INIT_SECTIONS, NULL },
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001117 .mismatch = ANY_EXIT_TO_ANY_INIT,
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001118 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Sam Ravnborg10668222008-01-13 22:21:31 +01001119},
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001120{
1121 .fromsec = { ALL_PCI_INIT_SECTIONS, NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301122 .bad_tosec = { INIT_SECTIONS, NULL },
Sebastian Andrzej Siewiorbb15d8d2012-06-03 20:48:17 +02001123 .mismatch = ANY_INIT_TO_ANY_EXIT,
1124 .symbol_white_list = { NULL },
1125},
Sam Ravnborg10668222008-01-13 22:21:31 +01001126/* Do not export init/exit functions or data */
1127{
1128 .fromsec = { "__ksymtab*", NULL },
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301129 .bad_tosec = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001130 .mismatch = EXPORT_TO_INIT_EXIT,
1131 .symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301132},
1133{
1134 .fromsec = { "__ex_table", NULL },
1135 /* If you're adding any new black-listed sections in here, consider
1136 * adding a special 'printer' for them in scripts/check_extable.
1137 */
1138 .bad_tosec = { ".altinstr_replacement", NULL },
1139 .good_tosec = {ALL_TEXT_SECTIONS , NULL},
1140 .mismatch = EXTABLE_TO_NON_TEXT,
1141 .handler = extable_mismatch_handler,
Sam Ravnborg10668222008-01-13 22:21:31 +01001142}
1143};
1144
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001145static const struct sectioncheck *section_mismatch(
1146 const char *fromsec, const char *tosec)
Sam Ravnborg10668222008-01-13 22:21:31 +01001147{
1148 int i;
1149 int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
1150 const struct sectioncheck *check = &sectioncheck[0];
1151
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301152 /*
1153 * The target section could be the SHT_NUL section when we're
1154 * handling relocations to un-resolved symbols, trying to match it
David Howells739d8752018-03-08 09:48:46 +00001155 * doesn't make much sense and causes build failures on parisc
1156 * architectures.
Quentin Casasnovasc5c34392015-04-16 13:16:41 +09301157 */
1158 if (*tosec == '\0')
1159 return NULL;
1160
Sam Ravnborg10668222008-01-13 22:21:31 +01001161 for (i = 0; i < elems; i++) {
Quentin Casasnovas050e57f2015-04-13 20:41:04 +09301162 if (match(fromsec, check->fromsec)) {
1163 if (check->bad_tosec[0] && match(tosec, check->bad_tosec))
1164 return check;
1165 if (check->good_tosec[0] && !match(tosec, check->good_tosec))
1166 return check;
1167 }
Sam Ravnborg10668222008-01-13 22:21:31 +01001168 check++;
1169 }
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001170 return NULL;
Sam Ravnborg10668222008-01-13 22:21:31 +01001171}
1172
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001173/**
1174 * Whitelist to allow certain references to pass with no warning.
Sam Ravnborg0e0d3142007-05-17 20:14:48 +02001175 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001176 * Pattern 1:
1177 * If a module parameter is declared __initdata and permissions=0
1178 * then this is legal despite the warning generated.
1179 * We cannot see value of permissions here, so just ignore
1180 * this pattern.
1181 * The pattern is identified by:
1182 * tosec = .init.data
Sam Ravnborg9209aed2006-03-05 00:16:26 +01001183 * fromsec = .data*
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001184 * atsym =__param*
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001185 *
Rusty Russell6a841522010-08-11 23:04:16 -06001186 * Pattern 1a:
1187 * module_param_call() ops can refer to __init set function if permissions=0
1188 * The pattern is identified by:
1189 * tosec = .init.text
1190 * fromsec = .data*
1191 * atsym = __param_ops_*
1192 *
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001193 * Pattern 2:
Randy Dunlap72ee59b2006-04-15 11:17:12 -07001194 * Many drivers utilise a *driver container with references to
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001195 * add, remove, probe functions etc.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001196 * the pattern is identified by:
Sam Ravnborg83cda2b2007-07-25 21:52:31 +02001197 * tosec = init or exit section
1198 * fromsec = data section
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001199 * atsym = *driver, *_template, *_sht, *_ops, *_probe,
1200 * *probe_one, *_console, *_timer
Vivek Goyalee6a8542007-01-11 01:52:44 +01001201 *
1202 * Pattern 3:
Sam Ravnborgc9939712009-04-26 11:17:42 +02001203 * Whitelist all references from .head.text to any init section
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001204 *
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001205 * Pattern 4:
Vivek Goyalee6a8542007-01-11 01:52:44 +01001206 * Some symbols belong to init section but still it is ok to reference
1207 * these from non-init sections as these symbols don't have any memory
1208 * allocated for them and symbol address and value are same. So even
1209 * if init section is freed, its ok to reference those symbols.
1210 * For ex. symbols marking the init section boundaries.
1211 * This pattern is identified by
1212 * refsymname = __init_begin, _sinittext, _einittext
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001213 *
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301214 * Pattern 5:
1215 * GCC may optimize static inlines when fed constant arg(s) resulting
1216 * in functions like cpumask_empty() -- generating an associated symbol
1217 * cpumask_empty.constprop.3 that appears in the audit. If the const that
1218 * is passed in comes from __init, like say nmi_ipi_mask, we get a
1219 * meaningless section warning. May need to add isra symbols too...
1220 * This pattern is identified by
1221 * tosec = init section
1222 * fromsec = text section
1223 * refsymname = *.constprop.*
1224 *
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001225 * Pattern 6:
1226 * Hide section mismatch warnings for ELF local symbols. The goal
1227 * is to eliminate false positive modpost warnings caused by
1228 * compiler-generated ELF local symbol names such as ".LANCHOR1".
1229 * Autogenerated symbol names bypass modpost's "Pattern 2"
1230 * whitelisting, which relies on pattern-matching against symbol
1231 * names to work. (One situation where gcc can autogenerate ELF
1232 * local symbols is when "-fsection-anchors" is used.)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001233 **/
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001234static int secref_whitelist(const struct sectioncheck *mismatch,
1235 const char *fromsec, const char *fromsym,
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001236 const char *tosec, const char *tosym)
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001237{
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001238 /* Check for pattern 1 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001239 if (match(tosec, init_data_sections) &&
1240 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001241 strstarts(fromsym, "__param"))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001242 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001243
Rusty Russell6a841522010-08-11 23:04:16 -06001244 /* Check for pattern 1a */
1245 if (strcmp(tosec, ".init.text") == 0 &&
1246 match(fromsec, data_sections) &&
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001247 strstarts(fromsym, "__param_ops_"))
Rusty Russell6a841522010-08-11 23:04:16 -06001248 return 0;
1249
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001250 /* Check for pattern 2 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001251 if (match(tosec, init_exit_sections) &&
1252 match(fromsec, data_sections) &&
Uwe Kleine-Königaf92a822010-01-30 20:52:50 +01001253 match(fromsym, mismatch->symbol_white_list))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001254 return 0;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001255
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001256 /* Check for pattern 3 */
Sam Ravnborg6c5bd232008-01-20 10:43:27 +01001257 if (match(fromsec, head_sections) &&
1258 match(tosec, init_sections))
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001259 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001260
Sam Ravnborg1d8af552007-06-03 00:41:22 +02001261 /* Check for pattern 4 */
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001262 if (match(tosym, linker_symbols))
1263 return 0;
Sam Ravnborg9bf8cb92007-02-26 17:49:06 +01001264
Paul Gortmaker4a3893d2015-04-20 10:20:40 +09301265 /* Check for pattern 5 */
1266 if (match(fromsec, text_sections) &&
1267 match(tosec, init_sections) &&
1268 match(fromsym, optim_symbols))
1269 return 0;
1270
Paul Walmsleya4d26f12018-11-21 13:14:13 -08001271 /* Check for pattern 6 */
1272 if (strstarts(fromsym, ".L"))
1273 return 0;
1274
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001275 return 1;
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001276}
1277
Sami Tolvanen5818c682018-10-23 15:15:35 -07001278static inline int is_arm_mapping_symbol(const char *str)
1279{
1280 return str[0] == '$' && strchr("axtd", str[1])
1281 && (str[2] == '\0' || str[2] == '.');
1282}
1283
1284/*
1285 * If there's no name there, ignore it; likewise, ignore it if it's
1286 * one of the magic symbols emitted used by current ARM tools.
1287 *
1288 * Otherwise if find_symbols_between() returns those symbols, they'll
1289 * fail the whitelist tests and cause lots of false alarms ... fixable
1290 * only by merging __exit and __init sections into __text, bloating
1291 * the kernel (which is especially evil on embedded platforms).
1292 */
1293static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
1294{
1295 const char *name = elf->strtab + sym->st_name;
1296
1297 if (!name || !strlen(name))
1298 return 0;
1299 return !is_arm_mapping_symbol(name);
1300}
1301
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001302/**
Sam Ravnborg93684d32006-02-19 11:53:35 +01001303 * Find symbol based on relocation record info.
1304 * In some cases the symbol supplied is a valid symbol so
1305 * return refsym. If st_name != 0 we assume this is a valid symbol.
1306 * In other cases the symbol needs to be looked up in the symbol table
1307 * based on section and address.
1308 * **/
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001309static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
Sam Ravnborg93684d32006-02-19 11:53:35 +01001310 Elf_Sym *relsym)
1311{
1312 Elf_Sym *sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001313 Elf_Sym *near = NULL;
1314 Elf64_Sword distance = 20;
1315 Elf64_Sword d;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001316 unsigned int relsym_secindex;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001317
1318 if (relsym->st_name != 0)
1319 return relsym;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001320
1321 relsym_secindex = get_secindex(elf, relsym);
Sam Ravnborg93684d32006-02-19 11:53:35 +01001322 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001323 if (get_secindex(elf, sym) != relsym_secindex)
Sam Ravnborg93684d32006-02-19 11:53:35 +01001324 continue;
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001325 if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
1326 continue;
Sami Tolvanen5818c682018-10-23 15:15:35 -07001327 if (!is_valid_name(elf, sym))
1328 continue;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001329 if (sym->st_value == addr)
1330 return sym;
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001331 /* Find a symbol nearby - addr are maybe negative */
1332 d = sym->st_value - addr;
1333 if (d < 0)
1334 d = addr - sym->st_value;
1335 if (d < distance) {
1336 distance = d;
1337 near = sym;
1338 }
Sam Ravnborg93684d32006-02-19 11:53:35 +01001339 }
Sam Ravnborg9ad21c32008-01-18 21:04:34 +01001340 /* We need a close match */
1341 if (distance < 20)
1342 return near;
1343 else
1344 return NULL;
Sam Ravnborg93684d32006-02-19 11:53:35 +01001345}
1346
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001347/*
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001348 * Find symbols before or equal addr and after addr - in the section sec.
1349 * If we find two symbols with equal offset prefer one with a valid name.
1350 * The ELF format may have a better way to detect what type of symbol
1351 * it is, but this works for now.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001352 **/
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001353static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
1354 const char *sec)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001355{
1356 Elf_Sym *sym;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001357 Elf_Sym *near = NULL;
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001358 Elf_Addr distance = ~0;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001359
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001360 for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1361 const char *symsec;
1362
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001363 if (is_shndx_special(sym->st_shndx))
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001364 continue;
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001365 symsec = sec_name(elf, get_secindex(elf, sym));
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001366 if (strcmp(symsec, sec) != 0)
1367 continue;
David Brownellda68d612007-02-20 13:58:16 -08001368 if (!is_valid_name(elf, sym))
1369 continue;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001370 if (sym->st_value <= addr) {
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001371 if ((addr - sym->st_value) < distance) {
1372 distance = addr - sym->st_value;
1373 near = sym;
1374 } else if ((addr - sym->st_value) == distance) {
1375 near = sym;
Sam Ravnborg43c74d12006-03-05 12:02:46 +01001376 }
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001377 }
1378 }
Sam Ravnborg157c23c2008-01-22 21:44:32 +01001379 return near;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001380}
1381
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001382/*
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001383 * Convert a section name to the function/data attribute
1384 * .init.text => __init
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001385 * .memexitconst => __memconst
1386 * etc.
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001387 *
1388 * The memory of returned value has been allocated on a heap. The user of this
1389 * method should free it after usage.
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001390*/
1391static char *sec2annotation(const char *s)
1392{
1393 if (match(s, init_exit_sections)) {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001394 char *p = NOFAIL(malloc(20));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001395 char *r = p;
1396
1397 *p++ = '_';
1398 *p++ = '_';
1399 if (*s == '.')
1400 s++;
1401 while (*s && *s != '.')
1402 *p++ = *s++;
1403 *p = '\0';
1404 if (*s == '.')
1405 s++;
1406 if (strstr(s, "rodata") != NULL)
1407 strcat(p, "const ");
1408 else if (strstr(s, "data") != NULL)
1409 strcat(p, "data ");
1410 else
1411 strcat(p, " ");
Andy Shevchenkocbcf14a92010-08-17 13:36:40 +03001412 return r;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001413 } else {
Randy Dunlap1f3aa902018-08-15 12:30:38 -07001414 return NOFAIL(strdup(""));
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001415 }
1416}
1417
1418static int is_function(Elf_Sym *sym)
1419{
1420 if (sym)
1421 return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
1422 else
Sam Ravnborgf6667512008-02-06 21:51:18 +01001423 return -1;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001424}
1425
Randy Dunlap00759c02011-03-15 14:13:47 -07001426static void print_section_list(const char * const list[20])
1427{
1428 const char *const *s = list;
1429
1430 while (*s) {
1431 fprintf(stderr, "%s", *s);
1432 s++;
1433 if (*s)
1434 fprintf(stderr, ", ");
1435 }
1436 fprintf(stderr, "\n");
1437}
1438
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301439static inline void get_pretty_name(int is_func, const char** name, const char** name_p)
1440{
1441 switch (is_func) {
1442 case 0: *name = "variable"; *name_p = ""; break;
1443 case 1: *name = "function"; *name_p = "()"; break;
1444 default: *name = "(unknown reference)"; *name_p = ""; break;
1445 }
1446}
1447
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001448/*
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001449 * Print a warning about a section mismatch.
1450 * Try to find symbols near it so user can find it.
Sam Ravnborg4c8fbca2006-02-26 22:18:11 +01001451 * Check whitelist before warning - it may be a false positive.
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001452 */
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001453static void report_sec_mismatch(const char *modname,
1454 const struct sectioncheck *mismatch,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001455 const char *fromsec,
1456 unsigned long long fromaddr,
1457 const char *fromsym,
1458 int from_is_func,
1459 const char *tosec, const char *tosym,
1460 int to_is_func)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001461{
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001462 const char *from, *from_p;
1463 const char *to, *to_p;
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001464 char *prl_from;
1465 char *prl_to;
Sam Ravnborgf6667512008-02-06 21:51:18 +01001466
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001467 sec_mismatch_count++;
Sam Ravnborge5f95c82008-02-02 18:57:18 +01001468
Quentin Casasnovas356ad532015-04-13 20:43:34 +09301469 get_pretty_name(from_is_func, &from, &from_p);
1470 get_pretty_name(to_is_func, &to, &to_p);
1471
Geert Uytterhoeven7c0ac492008-02-05 11:38:49 +01001472 warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
1473 "to the %s %s:%s%s\n",
1474 modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
1475 tosym, to_p);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001476
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001477 switch (mismatch->mismatch) {
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001478 case TEXT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001479 prl_from = sec2annotation(fromsec);
1480 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001481 fprintf(stderr,
Sam Ravnborgf6667512008-02-06 21:51:18 +01001482 "The function %s%s() references\n"
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001483 "the %s %s%s%s.\n"
1484 "This is often because %s lacks a %s\n"
1485 "annotation or the annotation of %s is wrong.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001486 prl_from, fromsym,
1487 to, prl_to, tosym, to_p,
1488 fromsym, prl_to, tosym);
1489 free(prl_from);
1490 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001491 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001492 case DATA_TO_ANY_INIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001493 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001494 fprintf(stderr,
1495 "The variable %s references\n"
1496 "the %s %s%s%s\n"
1497 "If the reference is valid then annotate the\n"
Sam Ravnborg8b8b76c2009-06-06 00:18:05 +02001498 "variable with __init* or __refdata (see linux/init.h) "
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001499 "or name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001500 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001501 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001502 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001503 break;
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001504 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001505 case TEXT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001506 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001507 fprintf(stderr,
1508 "The function %s() references a %s in an exit section.\n"
1509 "Often the %s %s%s has valid usage outside the exit section\n"
1510 "and the fix is to remove the %sannotation of %s.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001511 fromsym, to, to, tosym, to_p, prl_to, tosym);
1512 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001513 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001514 case DATA_TO_ANY_EXIT: {
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001515 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001516 fprintf(stderr,
1517 "The variable %s references\n"
1518 "the %s %s%s%s\n"
1519 "If the reference is valid then annotate the\n"
1520 "variable with __exit* (see linux/init.h) or "
1521 "name the variable:\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001522 fromsym, to, prl_to, tosym, to_p);
Randy Dunlap00759c02011-03-15 14:13:47 -07001523 print_section_list(mismatch->symbol_white_list);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001524 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001525 break;
1526 }
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001527 case XXXINIT_TO_SOME_INIT:
1528 case XXXEXIT_TO_SOME_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001529 prl_from = sec2annotation(fromsec);
1530 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001531 fprintf(stderr,
1532 "The %s %s%s%s references\n"
1533 "a %s %s%s%s.\n"
1534 "If %s is only used by %s then\n"
1535 "annotate %s with a matching annotation.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001536 from, prl_from, fromsym, from_p,
1537 to, prl_to, tosym, to_p,
Geert Uytterhoevenb1d26752008-02-17 14:12:10 +01001538 tosym, fromsym, tosym);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001539 free(prl_from);
1540 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001541 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001542 case ANY_INIT_TO_ANY_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001543 prl_from = sec2annotation(fromsec);
1544 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001545 fprintf(stderr,
1546 "The %s %s%s%s references\n"
1547 "a %s %s%s%s.\n"
1548 "This is often seen when error handling "
1549 "in the init function\n"
1550 "uses functionality in the exit path.\n"
1551 "The fix is often to remove the %sannotation of\n"
1552 "%s%s so it may be used outside an exit section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001553 from, prl_from, fromsym, from_p,
1554 to, prl_to, tosym, to_p,
Andrew Morton5003bab2010-08-11 00:42:26 -07001555 prl_to, tosym, to_p);
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001556 free(prl_from);
1557 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001558 break;
Uwe Kleine-Königbbd3f4f2010-01-30 16:35:47 +01001559 case ANY_EXIT_TO_ANY_INIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001560 prl_from = sec2annotation(fromsec);
1561 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001562 fprintf(stderr,
1563 "The %s %s%s%s references\n"
1564 "a %s %s%s%s.\n"
1565 "This is often seen when error handling "
1566 "in the exit function\n"
1567 "uses functionality in the init path.\n"
1568 "The fix is often to remove the %sannotation of\n"
1569 "%s%s so it may be used outside an init section.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001570 from, prl_from, fromsym, from_p,
1571 to, prl_to, tosym, to_p,
1572 prl_to, tosym, to_p);
1573 free(prl_from);
1574 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001575 break;
1576 case EXPORT_TO_INIT_EXIT:
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001577 prl_to = sec2annotation(tosec);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001578 fprintf(stderr,
1579 "The symbol %s is exported and annotated %s\n"
1580 "Fix this by removing the %sannotation of %s "
1581 "or drop the export.\n",
Alexey Fomenko37ed19d2010-08-09 17:20:24 -07001582 tosym, prl_to, prl_to, tosym);
1583 free(prl_to);
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001584 break;
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301585 case EXTABLE_TO_NON_TEXT:
1586 fatal("There's a special handler for this mismatch type, "
1587 "we should never get here.");
1588 break;
Sam Ravnborg588ccd72008-01-24 21:12:37 +01001589 }
1590 fprintf(stderr, "\n");
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001591}
1592
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301593static void default_mismatch_handler(const char *modname, struct elf_info *elf,
1594 const struct sectioncheck* const mismatch,
1595 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
1596{
1597 const char *tosec;
1598 Elf_Sym *to;
1599 Elf_Sym *from;
1600 const char *tosym;
1601 const char *fromsym;
1602
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301603 from = find_elf_symbol2(elf, r->r_offset, fromsec);
1604 fromsym = sym_name(elf, from);
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301605
Masahiro Yamadad62c4762018-05-09 18:50:38 +09001606 if (strstarts(fromsym, "reference___initcall"))
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301607 return;
1608
Quentin Casasnovasc7a65e02015-04-13 20:43:45 +09301609 tosec = sec_name(elf, get_secindex(elf, sym));
1610 to = find_elf_symbol(elf, r->r_addend, sym);
1611 tosym = sym_name(elf, to);
1612
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301613 /* check whitelist - we may ignore it */
1614 if (secref_whitelist(mismatch,
1615 fromsec, fromsym, tosec, tosym)) {
1616 report_sec_mismatch(modname, mismatch,
1617 fromsec, r->r_offset, fromsym,
1618 is_function(from), tosec, tosym,
1619 is_function(to));
1620 }
1621}
1622
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301623static int is_executable_section(struct elf_info* elf, unsigned int section_index)
1624{
1625 if (section_index > elf->num_sections)
1626 fatal("section_index is outside elf->num_sections!\n");
1627
1628 return ((elf->sechdrs[section_index].sh_flags & SHF_EXECINSTR) == SHF_EXECINSTR);
1629}
1630
1631/*
1632 * We rely on a gross hack in section_rel[a]() calling find_extable_entry_size()
1633 * to know the sizeof(struct exception_table_entry) for the target architecture.
1634 */
1635static unsigned int extable_entry_size = 0;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301636static void find_extable_entry_size(const char* const sec, const Elf_Rela* r)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301637{
1638 /*
1639 * If we're currently checking the second relocation within __ex_table,
1640 * that relocation offset tells us the offsetof(struct
1641 * exception_table_entry, fixup) which is equal to sizeof(struct
1642 * exception_table_entry) divided by two. We use that to our advantage
1643 * since there's no portable way to get that size as every architecture
1644 * seems to go with different sized types. Not pretty but better than
1645 * hard-coding the size for every architecture..
1646 */
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301647 if (!extable_entry_size)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301648 extable_entry_size = r->r_offset * 2;
1649}
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301650
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301651static inline bool is_extable_fault_address(Elf_Rela *r)
1652{
Quentin Casasnovasd3df4de2015-04-16 13:03:32 +09301653 /*
1654 * extable_entry_size is only discovered after we've handled the
1655 * _second_ relocation in __ex_table, so only abort when we're not
1656 * handling the first reloc and extable_entry_size is zero.
1657 */
1658 if (r->r_offset && extable_entry_size == 0)
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301659 fatal("extable_entry size hasn't been discovered!\n");
1660
1661 return ((r->r_offset == 0) ||
1662 (r->r_offset % extable_entry_size == 0));
1663}
1664
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301665#define is_second_extable_reloc(Start, Cur, Sec) \
1666 (((Cur) == (Start) + 1) && (strcmp("__ex_table", (Sec)) == 0))
1667
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301668static void report_extable_warnings(const char* modname, struct elf_info* elf,
1669 const struct sectioncheck* const mismatch,
1670 Elf_Rela* r, Elf_Sym* sym,
1671 const char* fromsec, const char* tosec)
1672{
1673 Elf_Sym* fromsym = find_elf_symbol2(elf, r->r_offset, fromsec);
1674 const char* fromsym_name = sym_name(elf, fromsym);
1675 Elf_Sym* tosym = find_elf_symbol(elf, r->r_addend, sym);
1676 const char* tosym_name = sym_name(elf, tosym);
1677 const char* from_pretty_name;
1678 const char* from_pretty_name_p;
1679 const char* to_pretty_name;
1680 const char* to_pretty_name_p;
1681
1682 get_pretty_name(is_function(fromsym),
1683 &from_pretty_name, &from_pretty_name_p);
1684 get_pretty_name(is_function(tosym),
1685 &to_pretty_name, &to_pretty_name_p);
1686
1687 warn("%s(%s+0x%lx): Section mismatch in reference"
1688 " from the %s %s%s to the %s %s:%s%s\n",
1689 modname, fromsec, (long)r->r_offset, from_pretty_name,
1690 fromsym_name, from_pretty_name_p,
1691 to_pretty_name, tosec, tosym_name, to_pretty_name_p);
1692
1693 if (!match(tosec, mismatch->bad_tosec) &&
1694 is_executable_section(elf, get_secindex(elf, sym)))
1695 fprintf(stderr,
1696 "The relocation at %s+0x%lx references\n"
1697 "section \"%s\" which is not in the list of\n"
1698 "authorized sections. If you're adding a new section\n"
1699 "and/or if this reference is valid, add \"%s\" to the\n"
1700 "list of authorized sections to jump to on fault.\n"
1701 "This can be achieved by adding \"%s\" to \n"
1702 "OTHER_TEXT_SECTIONS in scripts/mod/modpost.c.\n",
1703 fromsec, (long)r->r_offset, tosec, tosec, tosec);
1704}
1705
1706static void extable_mismatch_handler(const char* modname, struct elf_info *elf,
1707 const struct sectioncheck* const mismatch,
1708 Elf_Rela* r, Elf_Sym* sym,
1709 const char *fromsec)
1710{
1711 const char* tosec = sec_name(elf, get_secindex(elf, sym));
1712
1713 sec_mismatch_count++;
1714
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09001715 report_extable_warnings(modname, elf, mismatch, r, sym, fromsec, tosec);
Quentin Casasnovas52dc0592015-04-13 20:52:53 +09301716
1717 if (match(tosec, mismatch->bad_tosec))
1718 fatal("The relocation at %s+0x%lx references\n"
1719 "section \"%s\" which is black-listed.\n"
1720 "Something is seriously wrong and should be fixed.\n"
1721 "You might get more information about where this is\n"
1722 "coming from by using scripts/check_extable.sh %s\n",
1723 fromsec, (long)r->r_offset, tosec, modname);
1724 else if (!is_executable_section(elf, get_secindex(elf, sym))) {
1725 if (is_extable_fault_address(r))
1726 fatal("The relocation at %s+0x%lx references\n"
1727 "section \"%s\" which is not executable, IOW\n"
1728 "it is not possible for the kernel to fault\n"
1729 "at that address. Something is seriously wrong\n"
1730 "and should be fixed.\n",
1731 fromsec, (long)r->r_offset, tosec);
1732 else
1733 fatal("The relocation at %s+0x%lx references\n"
1734 "section \"%s\" which is not executable, IOW\n"
1735 "the kernel will fault if it ever tries to\n"
1736 "jump to it. Something is seriously wrong\n"
1737 "and should be fixed.\n",
1738 fromsec, (long)r->r_offset, tosec);
1739 }
1740}
1741
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001742static void check_section_mismatch(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001743 Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001744{
Luis de Bethencourt0cad61d2018-01-16 13:21:29 +00001745 const char *tosec = sec_name(elf, get_secindex(elf, sym));
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301746 const struct sectioncheck *mismatch = section_mismatch(fromsec, tosec);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001747
Uwe Kleine-König0d2a6362010-01-30 16:56:20 +01001748 if (mismatch) {
Quentin Casasnovas644e8f12015-04-13 20:43:17 +09301749 if (mismatch->handler)
1750 mismatch->handler(modname, elf, mismatch,
1751 r, sym, fromsec);
1752 else
1753 default_mismatch_handler(modname, elf, mismatch,
1754 r, sym, fromsec);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001755 }
1756}
1757
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001758static unsigned int *reloc_location(struct elf_info *elf,
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001759 Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001760{
Masahiro Yamadad2e4d052020-05-25 14:47:04 +09001761 return sym_get_data_by_offset(elf, sechdr->sh_info, r->r_offset);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001762}
1763
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001764static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001765{
1766 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001767 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001768
1769 switch (r_typ) {
1770 case R_386_32:
1771 r->r_addend = TO_NATIVE(*location);
1772 break;
1773 case R_386_PC32:
1774 r->r_addend = TO_NATIVE(*location) + 4;
1775 /* For CONFIG_RELOCATABLE=y */
1776 if (elf->hdr->e_type == ET_EXEC)
1777 r->r_addend += r->r_offset;
1778 break;
1779 }
1780 return 0;
1781}
1782
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001783#ifndef R_ARM_CALL
1784#define R_ARM_CALL 28
1785#endif
1786#ifndef R_ARM_JUMP24
1787#define R_ARM_JUMP24 29
1788#endif
1789
David A. Longc9698e52014-02-14 22:41:18 +01001790#ifndef R_ARM_THM_CALL
1791#define R_ARM_THM_CALL 10
1792#endif
1793#ifndef R_ARM_THM_JUMP24
1794#define R_ARM_THM_JUMP24 30
1795#endif
1796#ifndef R_ARM_THM_JUMP19
1797#define R_ARM_THM_JUMP19 51
1798#endif
1799
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001800static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001801{
1802 unsigned int r_typ = ELF_R_TYPE(r->r_info);
1803
1804 switch (r_typ) {
1805 case R_ARM_ABS32:
1806 /* From ARM ABI: (S + A) | T */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001807 r->r_addend = (int)(long)
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001808 (elf->symtab_start + ELF_R_SYM(r->r_info));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001809 break;
1810 case R_ARM_PC24:
Tony Lindgren6e2e3402012-02-14 21:58:56 +01001811 case R_ARM_CALL:
1812 case R_ARM_JUMP24:
David A. Longc9698e52014-02-14 22:41:18 +01001813 case R_ARM_THM_CALL:
1814 case R_ARM_THM_JUMP24:
1815 case R_ARM_THM_JUMP19:
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001816 /* From ARM ABI: ((S + A) | T) - P */
Sam Ravnborgdf578e72008-01-11 19:17:15 +01001817 r->r_addend = (int)(long)(elf->hdr +
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001818 sechdr->sh_offset +
1819 (r->r_offset - sechdr->sh_addr));
Sam Ravnborg56a974f2007-07-16 22:39:35 +02001820 break;
1821 default:
1822 return 1;
1823 }
1824 return 0;
1825}
1826
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001827static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001828{
1829 unsigned int r_typ = ELF_R_TYPE(r->r_info);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001830 unsigned int *location = reloc_location(elf, sechdr, r);
Atsushi Nemotoae4ac122007-05-22 18:27:39 +09001831 unsigned int inst;
1832
1833 if (r_typ == R_MIPS_HI16)
1834 return 1; /* skip this */
1835 inst = TO_NATIVE(*location);
1836 switch (r_typ) {
1837 case R_MIPS_LO16:
1838 r->r_addend = inst & 0xffff;
1839 break;
1840 case R_MIPS_26:
1841 r->r_addend = (inst & 0x03ffffff) << 2;
1842 break;
1843 case R_MIPS_32:
1844 r->r_addend = inst;
1845 break;
1846 }
1847 return 0;
1848}
1849
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001850static void section_rela(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001851 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001852{
1853 Elf_Sym *sym;
1854 Elf_Rela *rela;
1855 Elf_Rela r;
1856 unsigned int r_sym;
1857 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001858
Sam Ravnborgff13f922008-01-23 19:54:27 +01001859 Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001860 Elf_Rela *stop = (void *)start + sechdr->sh_size;
1861
Sam Ravnborgff13f922008-01-23 19:54:27 +01001862 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001863 fromsec += strlen(".rela");
1864 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001865 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001866 return;
Sam Ravnborge241a632008-01-28 20:13:13 +01001867
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001868 for (rela = start; rela < stop; rela++) {
1869 r.r_offset = TO_NATIVE(rela->r_offset);
1870#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001871 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001872 unsigned int r_typ;
1873 r_sym = ELF64_MIPS_R_SYM(rela->r_info);
1874 r_sym = TO_NATIVE(r_sym);
1875 r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
1876 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1877 } else {
1878 r.r_info = TO_NATIVE(rela->r_info);
1879 r_sym = ELF_R_SYM(r.r_info);
1880 }
1881#else
1882 r.r_info = TO_NATIVE(rela->r_info);
1883 r_sym = ELF_R_SYM(r.r_info);
1884#endif
1885 r.r_addend = TO_NATIVE(rela->r_addend);
1886 sym = elf->symtab_start + r_sym;
1887 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001888 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001889 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301890 if (is_second_extable_reloc(start, rela, fromsec))
1891 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001892 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001893 }
1894}
1895
1896static void section_rel(const char *modname, struct elf_info *elf,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001897 Elf_Shdr *sechdr)
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001898{
1899 Elf_Sym *sym;
1900 Elf_Rel *rel;
1901 Elf_Rela r;
1902 unsigned int r_sym;
1903 const char *fromsec;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001904
Sam Ravnborgff13f922008-01-23 19:54:27 +01001905 Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001906 Elf_Rel *stop = (void *)start + sechdr->sh_size;
1907
Sam Ravnborgff13f922008-01-23 19:54:27 +01001908 fromsec = sech_name(elf, sechdr);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001909 fromsec += strlen(".rel");
1910 /* if from section (name) is know good then skip it */
Anders Kaseorgb614a692009-04-23 16:49:33 -04001911 if (match(fromsec, section_white_list))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001912 return;
1913
1914 for (rel = start; rel < stop; rel++) {
1915 r.r_offset = TO_NATIVE(rel->r_offset);
1916#if KERNEL_ELFCLASS == ELFCLASS64
Sam Ravnborgff13f922008-01-23 19:54:27 +01001917 if (elf->hdr->e_machine == EM_MIPS) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001918 unsigned int r_typ;
1919 r_sym = ELF64_MIPS_R_SYM(rel->r_info);
1920 r_sym = TO_NATIVE(r_sym);
1921 r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
1922 r.r_info = ELF64_R_INFO(r_sym, r_typ);
1923 } else {
1924 r.r_info = TO_NATIVE(rel->r_info);
1925 r_sym = ELF_R_SYM(r.r_info);
1926 }
1927#else
1928 r.r_info = TO_NATIVE(rel->r_info);
1929 r_sym = ELF_R_SYM(r.r_info);
1930#endif
1931 r.r_addend = 0;
Sam Ravnborgff13f922008-01-23 19:54:27 +01001932 switch (elf->hdr->e_machine) {
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001933 case EM_386:
1934 if (addend_386_rel(elf, sechdr, &r))
1935 continue;
1936 break;
1937 case EM_ARM:
1938 if (addend_arm_rel(elf, sechdr, &r))
1939 continue;
1940 break;
1941 case EM_MIPS:
1942 if (addend_mips_rel(elf, sechdr, &r))
1943 continue;
1944 break;
1945 }
1946 sym = elf->symtab_start + r_sym;
1947 /* Skip special sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001948 if (is_shndx_special(sym->st_shndx))
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001949 continue;
Quentin Casasnovase84048a2015-04-16 13:05:36 +09301950 if (is_second_extable_reloc(start, rel, fromsec))
1951 find_extable_entry_size(fromsec, &r);
Sam Ravnborg58fb0d42008-01-23 21:13:50 +01001952 check_section_mismatch(modname, elf, &r, sym, fromsec);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001953 }
1954}
1955
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001956/**
1957 * A module includes a number of sections that are discarded
1958 * either when loaded or when used as built-in.
1959 * For loaded modules all functions marked __init and all data
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001960 * marked __initdata will be discarded when the module has been initialized.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001961 * Likewise for modules used built-in the sections marked __exit
1962 * are discarded because __exit marked function are supposed to be called
Ben Dooks32be1d22008-07-29 22:33:44 -07001963 * only when a module is unloaded which never happens for built-in modules.
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001964 * The check_sec_ref() function traverses all relocation records
1965 * to find all references to a section that reference a section that will
1966 * be discarded and warns about it.
1967 **/
1968static void check_sec_ref(struct module *mod, const char *modname,
Masahiro Yamadabb66fc62014-06-10 19:08:13 +09001969 struct elf_info *elf)
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001970{
1971 int i;
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001972 Elf_Shdr *sechdrs = elf->sechdrs;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01001973
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001974 /* Walk through all sections */
Denys Vlasenko1ce53ad2010-07-29 01:47:53 +02001975 for (i = 0; i < elf->num_sections; i++) {
Anders Kaseorgb614a692009-04-23 16:49:33 -04001976 check_section(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001977 /* We want to process only relocation sections and not .init */
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001978 if (sechdrs[i].sh_type == SHT_RELA)
Sam Ravnborg10668222008-01-13 22:21:31 +01001979 section_rela(modname, elf, &elf->sechdrs[i]);
Sam Ravnborg5b24c072008-01-18 21:49:29 +01001980 else if (sechdrs[i].sh_type == SHT_REL)
Sam Ravnborg10668222008-01-13 22:21:31 +01001981 section_rel(modname, elf, &elf->sechdrs[i]);
Sam Ravnborgb39927c2006-02-17 22:42:02 +01001982 }
1983}
1984
Andi Kleen7d02b492014-02-08 09:01:12 +01001985static char *remove_dot(char *s)
1986{
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301987 size_t n = strcspn(s, ".");
Andi Kleen7d02b492014-02-08 09:01:12 +01001988
Michal Nazarewiczfcd38ed2014-07-27 07:27:01 +09301989 if (n && s[n]) {
1990 size_t m = strspn(s + n + 1, "0123456789");
1991 if (m && (s[n + m] == '.' || s[n + m] == 0))
Andi Kleen7d02b492014-02-08 09:01:12 +01001992 s[n] = 0;
1993 }
1994 return s;
1995}
1996
Masahiro Yamada8b185742018-05-09 18:50:40 +09001997static void read_symbols(const char *modname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998{
1999 const char *symname;
2000 char *version;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002001 char *license;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002002 char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 struct module *mod;
2004 struct elf_info info = { };
2005 Elf_Sym *sym;
2006
Sam Ravnborg85bd2fd2007-02-26 15:33:52 +01002007 if (!parse_elf(&info, modname))
2008 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009
Masahiro Yamadaa82f7942020-06-01 14:57:29 +09002010 {
2011 char *tmp;
2012
2013 /* strip trailing .o */
2014 tmp = NOFAIL(strdup(modname));
2015 tmp[strlen(tmp) - 2] = '\0';
2016 mod = new_module(tmp);
2017 free(tmp);
2018 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002020 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002021 license = get_modinfo(&info, "license");
2022 if (!license)
2023 warn("missing MODULE_LICENSE() in %s\n", modname);
2024 while (license) {
2025 if (license_is_gpl_compatible(license))
2026 mod->gpl_compatible = 1;
2027 else {
2028 mod->gpl_compatible = 0;
2029 break;
2030 }
2031 license = get_next_modinfo(&info, "license", license);
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002032 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002033
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002034 namespace = get_modinfo(&info, "import_ns");
2035 while (namespace) {
2036 add_namespace(&mod->imported_namespaces, namespace);
2037 namespace = get_next_modinfo(&info, "import_ns",
2038 namespace);
2039 }
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002040 }
2041
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
Andi Kleen7d02b492014-02-08 09:01:12 +01002043 symname = remove_dot(info.strtab + sym->st_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044
Masahiro Yamada9bd2a092019-11-15 02:42:23 +09002045 handle_symbol(mod, &info, sym, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 handle_moddevtable(mod, &info, sym, symname);
2047 }
Denis Efremov15bfc232019-08-01 09:06:57 +03002048
Matthias Maennich69923202019-10-18 10:31:42 +01002049 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2050 symname = remove_dot(info.strtab + sym->st_name);
2051
Masahiro Yamada17436942019-11-15 02:42:24 +09002052 /* Apply symbol namespaces from __kstrtabns_<symbol> entries. */
Matthias Maennich69923202019-10-18 10:31:42 +01002053 if (strstarts(symname, "__kstrtabns_"))
2054 sym_update_namespace(symname + strlen("__kstrtabns_"),
2055 namespace_from_kstrtabns(&info,
2056 sym));
Masahiro Yamada17436942019-11-15 02:42:24 +09002057
2058 if (strstarts(symname, "__crc_"))
2059 handle_modversion(mod, &info, sym,
2060 symname + strlen("__crc_"));
Matthias Maennich69923202019-10-18 10:31:42 +01002061 }
2062
Denis Efremov15bfc232019-08-01 09:06:57 +03002063 // check for static EXPORT_SYMBOL_* functions && global vars
2064 for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
2065 unsigned char bind = ELF_ST_BIND(sym->st_info);
2066
2067 if (bind == STB_GLOBAL || bind == STB_WEAK) {
2068 struct symbol *s =
2069 find_symbol(remove_dot(info.strtab +
2070 sym->st_name));
2071
2072 if (s)
2073 s->is_static = 0;
2074 }
2075 }
2076
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002077 check_sec_ref(mod, modname, &info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002079 if (!mod->is_vmlinux) {
Masahiro Yamada4ddea2f2020-06-01 14:57:16 +09002080 version = get_modinfo(&info, "version");
2081 if (version || all_versions)
2082 get_src_version(modname, mod->srcversion,
2083 sizeof(mod->srcversion) - 1);
2084 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085
2086 parse_elf_finish(&info);
2087
Rusty Russell8c8ef422009-03-31 13:05:34 -06002088 /* Our trick to get versioning for module struct etc. - it's
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 * never passed as an argument to an exported function, so
2090 * the automatic versioning doesn't pick it up, but it's really
2091 * important anyhow */
2092 if (modversions)
Rusty Russell8c8ef422009-03-31 13:05:34 -06002093 mod->unres = alloc_symbol("module_layout", 0, mod->unres);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094}
2095
Rusty Russell712f9b42013-04-04 17:37:38 +10302096static void read_symbols_from_files(const char *filename)
2097{
2098 FILE *in = stdin;
2099 char fname[PATH_MAX];
2100
2101 if (strcmp(filename, "-") != 0) {
2102 in = fopen(filename, "r");
2103 if (!in)
2104 fatal("Can't open filenames file %s: %m", filename);
2105 }
2106
2107 while (fgets(fname, PATH_MAX, in) != NULL) {
2108 if (strends(fname, "\n"))
2109 fname[strlen(fname)-1] = '\0';
2110 read_symbols(fname);
2111 }
2112
2113 if (in != stdin)
2114 fclose(in);
2115}
2116
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117#define SZ 500
2118
2119/* We first write the generated file into memory using the
2120 * following helper, then compare to the file on disk and
2121 * only update the later if anything changed */
2122
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002123void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
2124 const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125{
2126 char tmp[SZ];
2127 int len;
2128 va_list ap;
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002129
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 va_start(ap, fmt);
2131 len = vsnprintf(tmp, SZ, fmt, ap);
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002132 buf_write(buf, tmp, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 va_end(ap);
2134}
2135
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002136void buf_write(struct buffer *buf, const char *s, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137{
2138 if (buf->size - buf->pos < len) {
Sam Ravnborg7670f0232006-03-16 23:04:08 -08002139 buf->size += len + SZ;
Randy Dunlap1f3aa902018-08-15 12:30:38 -07002140 buf->p = NOFAIL(realloc(buf->p, buf->size));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 }
2142 strncpy(buf->p + buf->pos, s, len);
2143 buf->pos += len;
2144}
2145
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002146static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
2147{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002148 switch (exp) {
2149 case export_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002150 fatal("GPL-incompatible module %s.ko uses GPL-only symbol '%s'\n",
2151 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002152 break;
2153 case export_unused_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002154 fatal("GPL-incompatible module %s.ko uses GPL-only symbol marked UNUSED '%s'\n",
2155 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002156 break;
2157 case export_gpl_future:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002158 warn("GPL-incompatible module %s.ko uses future GPL-only symbol '%s'\n",
2159 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002160 break;
2161 case export_plain:
2162 case export_unused:
2163 case export_unknown:
2164 /* ignore */
2165 break;
2166 }
2167}
2168
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002169static void check_for_unused(enum export exp, const char *m, const char *s)
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002170{
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002171 switch (exp) {
2172 case export_unused:
2173 case export_unused_gpl:
Masahiro Yamada1be5fa62020-06-01 14:57:25 +09002174 warn("module %s.ko uses symbol '%s' marked UNUSED\n",
2175 m, s);
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002176 break;
2177 default:
2178 /* ignore */
2179 break;
2180 }
2181}
2182
Masahiro Yamada3b415282018-11-23 16:57:23 +09002183static int check_exports(struct module *mod)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002184{
2185 struct symbol *s, *exp;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002186 int err = 0;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002187
2188 for (s = mod->unres; s; s = s->next) {
Andrew Morton6449bd62006-06-09 20:45:06 -07002189 const char *basename;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002190 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002191 if (!exp || exp->module == mod) {
2192 if (have_vmlinux && !s->weak) {
Jessica Yu93c95e52020-03-06 17:02:05 +01002193 modpost_log(warn_unresolved ? LOG_WARN : LOG_ERROR,
2194 "\"%s\" [%s.ko] undefined!\n",
2195 s->name, mod->name);
2196 if (!warn_unresolved)
Masahiro Yamada3b415282018-11-23 16:57:23 +09002197 err = 1;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002198 }
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002199 continue;
Masahiro Yamada3b415282018-11-23 16:57:23 +09002200 }
Andrew Morton6449bd62006-06-09 20:45:06 -07002201 basename = strrchr(mod->name, '/');
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002202 if (basename)
2203 basename++;
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002204 else
2205 basename = mod->name;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002206
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002207 if (exp->namespace &&
2208 !module_imports_namespace(mod, exp->namespace)) {
Jessica Yu54b77842020-03-06 17:02:06 +01002209 modpost_log(allow_missing_ns_imports ? LOG_WARN : LOG_ERROR,
2210 "module %s uses symbol %s from namespace %s, but does not import it.\n",
2211 basename, exp->name, exp->namespace);
2212 if (!allow_missing_ns_imports)
2213 err = 1;
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002214 add_namespace(&mod->missing_namespaces, exp->namespace);
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002215 }
2216
Sam Ravnborgc96fca22006-07-01 11:44:23 +02002217 if (!mod->gpl_compatible)
2218 check_for_gpl_usage(exp->export, basename, exp->name);
2219 check_for_unused(exp->export, basename, exp->name);
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002220 }
Masahiro Yamada3b415282018-11-23 16:57:23 +09002221
2222 return err;
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002223}
2224
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002225static int check_modname_len(struct module *mod)
2226{
2227 const char *mod_name;
2228
2229 mod_name = strrchr(mod->name, '/');
2230 if (mod_name == NULL)
2231 mod_name = mod->name;
2232 else
2233 mod_name++;
2234 if (strlen(mod_name) >= MODULE_NAME_LEN) {
2235 merror("module name is too long [%s.ko]\n", mod->name);
2236 return 1;
2237 }
2238
2239 return 0;
2240}
2241
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002242/**
2243 * Header for the generated file
2244 **/
2245static void add_header(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246{
2247 buf_printf(b, "#include <linux/module.h>\n");
Vincenzo Frascinof58dd032020-03-20 14:53:41 +00002248 /*
2249 * Include build-salt.h after module.h in order to
2250 * inherit the definitions.
2251 */
2252 buf_printf(b, "#include <linux/build-salt.h>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 buf_printf(b, "#include <linux/vermagic.h>\n");
2254 buf_printf(b, "#include <linux/compiler.h>\n");
2255 buf_printf(b, "\n");
Laura Abbott9afb7192018-07-05 17:49:37 -07002256 buf_printf(b, "BUILD_SALT;\n");
2257 buf_printf(b, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
Kees Cook3e2e8572017-04-21 15:35:27 -07002259 buf_printf(b, "MODULE_INFO(name, KBUILD_MODNAME);\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 buf_printf(b, "\n");
Andi Kleene0f244c2013-10-23 10:57:58 +10302261 buf_printf(b, "__visible struct module __this_module\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002262 buf_printf(b, "__section(.gnu.linkonce.this_module) = {\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002263 buf_printf(b, "\t.name = KBUILD_MODNAME,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 if (mod->has_init)
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002265 buf_printf(b, "\t.init = init_module,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 if (mod->has_cleanup)
2267 buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002268 "\t.exit = cleanup_module,\n"
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 "#endif\n");
Greg Kroah-Hartman3c7ec942012-04-25 11:10:15 -07002270 buf_printf(b, "\t.arch = MODULE_ARCH_INIT,\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 buf_printf(b, "};\n");
2272}
2273
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002274static void add_intree_flag(struct buffer *b, int is_intree)
2275{
2276 if (is_intree)
2277 buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
2278}
2279
Andi Kleencaf75012018-01-25 15:50:28 -08002280/* Cannot check for assembler */
2281static void add_retpoline(struct buffer *b)
2282{
WANG Chaoe4f35892018-12-11 00:37:25 +08002283 buf_printf(b, "\n#ifdef CONFIG_RETPOLINE\n");
Andi Kleencaf75012018-01-25 15:50:28 -08002284 buf_printf(b, "MODULE_INFO(retpoline, \"Y\");\n");
2285 buf_printf(b, "#endif\n");
2286}
2287
Trevor Keith5c725132009-09-22 16:43:38 -07002288static void add_staging_flag(struct buffer *b, const char *name)
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002289{
Masahiro Yamadad62c4762018-05-09 18:50:38 +09002290 if (strstarts(name, "drivers/staging"))
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002291 buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
2292}
2293
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002294/**
2295 * Record CRCs for unresolved symbols
2296 **/
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002297static int add_versions(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298{
2299 struct symbol *s, *exp;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002300 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301
2302 for (s = mod->unres; s; s = s->next) {
2303 exp = find_symbol(s->name);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002304 if (!exp || exp->module == mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 s->module = exp->module;
2307 s->crc_valid = exp->crc_valid;
2308 s->crc = exp->crc;
2309 }
2310
2311 if (!modversions)
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002312 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313
2314 buf_printf(b, "\n");
2315 buf_printf(b, "static const struct modversion_info ____versions[]\n");
Masahiro Yamadaa3d0cb02019-09-09 20:34:23 +09002316 buf_printf(b, "__used __section(__versions) = {\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317
2318 for (s = mod->unres; s; s = s->next) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002319 if (!s->module)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 if (!s->crc_valid) {
Sam Ravnborgcb805142006-01-28 16:57:26 +01002322 warn("\"%s\" [%s.ko] has no CRC!\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 s->name, mod->name);
2324 continue;
2325 }
Takashi Iwai5cfb2032015-08-08 15:16:20 +09302326 if (strlen(s->name) >= MODULE_NAME_LEN) {
2327 merror("too long symbol \"%s\" [%s.ko]\n",
2328 s->name, mod->name);
2329 err = 1;
2330 break;
2331 }
Masahiro Yamadab2c5cdc2018-05-09 16:23:45 +09002332 buf_printf(b, "\t{ %#8x, \"%s\" },\n",
James Hogana4b6a772013-03-18 19:38:56 +10302333 s->crc, s->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 }
2335
2336 buf_printf(b, "};\n");
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002337
2338 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339}
2340
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002341static void add_depends(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342{
2343 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 int first = 1;
2345
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002346 /* Clear ->seen flag of modules that own symbols needed by this. */
2347 for (s = mod->unres; s; s = s->next)
2348 if (s->module)
Masahiro Yamada5a438af2020-06-01 14:57:26 +09002349 s->module->seen = s->module->is_vmlinux;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350
2351 buf_printf(b, "\n");
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002352 buf_printf(b, "MODULE_INFO(depends, \"");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 for (s = mod->unres; s; s = s->next) {
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002354 const char *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 if (!s->module)
2356 continue;
2357
2358 if (s->module->seen)
2359 continue;
2360
2361 s->module->seen = 1;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002362 p = strrchr(s->module->name, '/');
2363 if (p)
Sam Ravnborga61b2df2007-02-26 19:46:52 +01002364 p++;
2365 else
2366 p = s->module->name;
2367 buf_printf(b, "%s%s", first ? "" : ",", p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368 first = 0;
2369 }
Masahiro Yamada6df7e1e2019-09-09 20:34:22 +09002370 buf_printf(b, "\");\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371}
2372
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002373static void add_srcversion(struct buffer *b, struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374{
2375 if (mod->srcversion[0]) {
2376 buf_printf(b, "\n");
2377 buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
2378 mod->srcversion);
2379 }
2380}
2381
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002382static void write_buf(struct buffer *b, const char *fname)
2383{
2384 FILE *file;
2385
2386 file = fopen(fname, "w");
2387 if (!file) {
2388 perror(fname);
2389 exit(1);
2390 }
2391 if (fwrite(b->p, 1, b->pos, file) != b->pos) {
2392 perror(fname);
2393 exit(1);
2394 }
2395 if (fclose(file) != 0) {
2396 perror(fname);
2397 exit(1);
2398 }
2399}
2400
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002401static void write_if_changed(struct buffer *b, const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402{
2403 char *tmp;
2404 FILE *file;
2405 struct stat st;
2406
2407 file = fopen(fname, "r");
2408 if (!file)
2409 goto write;
2410
2411 if (fstat(fileno(file), &st) < 0)
2412 goto close_write;
2413
2414 if (st.st_size != b->pos)
2415 goto close_write;
2416
2417 tmp = NOFAIL(malloc(b->pos));
2418 if (fread(tmp, 1, b->pos, file) != b->pos)
2419 goto free_write;
2420
2421 if (memcmp(tmp, b->p, b->pos) != 0)
2422 goto free_write;
2423
2424 free(tmp);
2425 fclose(file);
2426 return;
2427
2428 free_write:
2429 free(tmp);
2430 close_write:
2431 fclose(file);
2432 write:
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002433 write_buf(b, fname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434}
2435
Ram Paibd5cbce2006-06-08 22:12:53 -07002436/* parse Module.symvers file. line format:
Jessica Yu51900442020-03-11 18:01:20 +01002437 * 0x12345678<tab>symbol<tab>module<tab>export<tab>namespace
Ram Paibd5cbce2006-06-08 22:12:53 -07002438 **/
Masahiro Yamada52c34162020-06-01 14:57:05 +09002439static void read_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440{
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002441 char *buf, *pos, *line;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002443 buf = read_text_file(fname);
2444 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 /* No symbol versions, silently ignore */
2446 return;
2447
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002448 pos = buf;
2449
2450 while ((line = get_line(&pos))) {
Jessica Yu51900442020-03-11 18:01:20 +01002451 char *symname, *namespace, *modname, *d, *export;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452 unsigned int crc;
2453 struct module *mod;
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002454 struct symbol *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455
2456 if (!(symname = strchr(line, '\t')))
2457 goto fail;
2458 *symname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002459 if (!(modname = strchr(symname, '\t')))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 goto fail;
2461 *modname++ = '\0';
Jessica Yu51900442020-03-11 18:01:20 +01002462 if (!(export = strchr(modname, '\t')))
2463 goto fail;
2464 *export++ = '\0';
2465 if (!(namespace = strchr(export, '\t')))
2466 goto fail;
2467 *namespace++ = '\0';
2468
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 crc = strtoul(line, &d, 16);
2470 if (*symname == '\0' || *modname == '\0' || *d != '\0')
2471 goto fail;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002472 mod = find_module(modname);
2473 if (!mod) {
Jan Beulich0fa3a882009-03-12 12:28:30 +00002474 mod = new_module(modname);
Masahiro Yamada52c34162020-06-01 14:57:05 +09002475 mod->from_dump = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 }
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002477 s = sym_add_exported(symname, mod, export_no(export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002478 s->is_static = 0;
Masahiro Yamada17436942019-11-15 02:42:24 +09002479 sym_set_crc(symname, crc);
Matthias Maennich9ae5bd12019-10-18 10:31:41 +01002480 sym_update_namespace(symname, namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481 }
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002482 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 return;
2484fail:
Masahiro Yamada70f30cf2020-06-01 14:57:20 +09002485 free(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 fatal("parse error in symbol dump file\n");
2487}
2488
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002489/* For normal builds always dump all symbols.
2490 * For external modules only dump symbols
2491 * that are not read from kernel Module.symvers.
2492 **/
2493static int dump_sym(struct symbol *sym)
2494{
2495 if (!external_module)
2496 return 1;
Masahiro Yamada52c34162020-06-01 14:57:05 +09002497 if (sym->module->from_dump)
Sam Ravnborg040fcc82006-01-28 22:15:55 +01002498 return 0;
2499 return 1;
2500}
Sam Ravnborg62070fa2006-03-03 16:46:04 +01002501
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002502static void write_dump(const char *fname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503{
2504 struct buffer buf = { };
2505 struct symbol *symbol;
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002506 const char *namespace;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507 int n;
2508
2509 for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
2510 symbol = symbolhash[n];
2511 while (symbol) {
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002512 if (dump_sym(symbol)) {
2513 namespace = symbol->namespace;
2514 buf_printf(&buf, "0x%08x\t%s\t%s\t%s\t%s\n",
2515 symbol->crc, symbol->name,
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002516 symbol->module->name,
Jessica Yu51900442020-03-11 18:01:20 +01002517 export_str(symbol->export),
2518 namespace ? namespace : "");
Matthias Maennichcb9b55d2019-09-06 11:32:28 +01002519 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 symbol = symbol->next;
2521 }
2522 }
Masahiro Yamada436b2ac2020-06-01 14:57:12 +09002523 write_buf(&buf, fname);
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002524 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525}
2526
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002527static void write_namespace_deps_files(const char *fname)
Matthias Maennich1d082772019-09-06 11:32:31 +01002528{
2529 struct module *mod;
2530 struct namespace_list *ns;
2531 struct buffer ns_deps_buf = {};
2532
2533 for (mod = modules; mod; mod = mod->next) {
Matthias Maennich1d082772019-09-06 11:32:31 +01002534
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002535 if (mod->from_dump || !mod->missing_namespaces)
Matthias Maennich1d082772019-09-06 11:32:31 +01002536 continue;
2537
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002538 buf_printf(&ns_deps_buf, "%s.ko:", mod->name);
Matthias Maennich1d082772019-09-06 11:32:31 +01002539
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002540 for (ns = mod->missing_namespaces; ns; ns = ns->next)
2541 buf_printf(&ns_deps_buf, " %s", ns->namespace);
Matthias Maennich1d082772019-09-06 11:32:31 +01002542
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002543 buf_printf(&ns_deps_buf, "\n");
Matthias Maennich1d082772019-09-06 11:32:31 +01002544 }
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002545
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002546 write_if_changed(&ns_deps_buf, fname);
Masahiro Yamada0241ea82019-11-07 00:19:59 +09002547 free(ns_deps_buf.p);
Matthias Maennich1d082772019-09-06 11:32:31 +01002548}
2549
Masahiro Yamada79247992020-06-01 14:57:07 +09002550struct dump_list {
2551 struct dump_list *next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002552 const char *file;
2553};
2554
Sam Ravnborg5c3ead82006-01-28 17:19:35 +01002555int main(int argc, char **argv)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556{
2557 struct module *mod;
2558 struct buffer buf = { };
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002559 char *missing_namespace_deps = NULL;
Rusty Russell712f9b42013-04-04 17:37:38 +10302560 char *dump_write = NULL, *files_source = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561 int opt;
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002562 int err;
Denis Efremov15bfc232019-08-01 09:06:57 +03002563 int n;
Masahiro Yamada79247992020-06-01 14:57:07 +09002564 struct dump_list *dump_read_start = NULL;
2565 struct dump_list **dump_read_iter = &dump_read_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566
Masahiro Yamada467b82d2020-06-01 14:57:22 +09002567 while ((opt = getopt(argc, argv, "ei:mnT:o:awENd:")) != -1) {
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002568 switch (opt) {
Masahiro Yamadae3fb4df2020-06-01 14:57:08 +09002569 case 'e':
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002570 external_module = 1;
Masahiro Yamadae3fb4df2020-06-01 14:57:08 +09002571 break;
2572 case 'i':
Masahiro Yamada79247992020-06-01 14:57:07 +09002573 *dump_read_iter =
2574 NOFAIL(calloc(1, sizeof(**dump_read_iter)));
2575 (*dump_read_iter)->file = optarg;
2576 dump_read_iter = &(*dump_read_iter)->next;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002577 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002578 case 'm':
2579 modversions = 1;
2580 break;
Guenter Roeckeed380f2013-09-23 15:23:54 +09302581 case 'n':
2582 ignore_missing_files = 1;
2583 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002584 case 'o':
2585 dump_write = optarg;
2586 break;
2587 case 'a':
2588 all_versions = 1;
2589 break;
Rusty Russell712f9b42013-04-04 17:37:38 +10302590 case 'T':
2591 files_source = optarg;
2592 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002593 case 'w':
2594 warn_unresolved = 1;
2595 break;
Nicolas Boichat47490ec2015-10-06 09:44:42 +10302596 case 'E':
2597 sec_mismatch_fatal = 1;
2598 break;
Jessica Yu54b77842020-03-06 17:02:06 +01002599 case 'N':
2600 allow_missing_ns_imports = 1;
2601 break;
Matthias Maennich1d082772019-09-06 11:32:31 +01002602 case 'd':
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002603 missing_namespace_deps = optarg;
Matthias Maennich1d082772019-09-06 11:32:31 +01002604 break;
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002605 default:
2606 exit(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 }
2608 }
2609
Masahiro Yamada79247992020-06-01 14:57:07 +09002610 while (dump_read_start) {
2611 struct dump_list *tmp;
Masahiro Yamada2beee862020-06-01 14:57:04 +09002612
Masahiro Yamada79247992020-06-01 14:57:07 +09002613 read_dump(dump_read_start->file);
2614 tmp = dump_read_start->next;
2615 free(dump_read_start);
2616 dump_read_start = tmp;
Richard Hacker2d04b5a2008-02-28 09:40:52 +01002617 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618
Sam Ravnborgdf578e72008-01-11 19:17:15 +01002619 while (optind < argc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 read_symbols(argv[optind++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621
Rusty Russell712f9b42013-04-04 17:37:38 +10302622 if (files_source)
2623 read_symbols_from_files(files_source);
2624
Masahiro Yamada7e8a3232020-06-01 14:57:13 +09002625 /*
2626 * When there's no vmlinux, don't print warnings about
2627 * unresolved symbols (since there'll be too many ;)
2628 */
2629 if (!have_vmlinux)
2630 warn("Symbol info of vmlinux is missing. Unresolved symbol check will be entirely skipped.\n");
2631
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002632 err = 0;
2633
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002634 for (mod = modules; mod; mod = mod->next) {
Mathias Kraused93e1712014-08-27 20:28:56 +09302635 char fname[PATH_MAX];
Andi Kleen666ab412007-11-22 03:43:10 +01002636
Masahiro Yamada0b19d542020-06-01 14:57:27 +09002637 if (mod->is_vmlinux || mod->from_dump)
Sam Ravnborgb817f6f2006-06-09 21:53:55 +02002638 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639
2640 buf.pos = 0;
2641
Wanlong Gao4fd3e4e2017-06-30 22:07:03 +08002642 err |= check_modname_len(mod);
Masahiro Yamada3b415282018-11-23 16:57:23 +09002643 err |= check_exports(mod);
Matthias Maennich1d082772019-09-06 11:32:31 +01002644
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645 add_header(&buf, mod);
Ben Hutchings2449b8b2011-10-24 15:12:28 +02002646 add_intree_flag(&buf, !external_module);
Andi Kleencaf75012018-01-25 15:50:28 -08002647 add_retpoline(&buf);
Greg Kroah-Hartmana9860bf2008-09-24 14:46:44 -07002648 add_staging_flag(&buf, mod->name);
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002649 err |= add_versions(&buf, mod);
Masahiro Yamadad2665ca2018-11-23 16:57:21 +09002650 add_depends(&buf, mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 add_moddevtable(&buf, mod);
2652 add_srcversion(&buf, mod);
2653
2654 sprintf(fname, "%s.mod.c", mod->name);
2655 write_if_changed(&buf, fname);
2656 }
Matthias Maennich1d082772019-09-06 11:32:31 +01002657
Masahiro Yamadabbc55bd2019-10-29 21:38:07 +09002658 if (missing_namespace_deps)
2659 write_namespace_deps_files(missing_namespace_deps);
Matthias Maennich1d082772019-09-06 11:32:31 +01002660
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 if (dump_write)
2662 write_dump(dump_write);
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002663 if (sec_mismatch_count && sec_mismatch_fatal)
Jessica Yu93c95e52020-03-06 17:02:05 +01002664 fatal("Section mismatches detected.\n"
Masahiro Yamada46c7dd52019-02-01 13:50:45 +09002665 "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n");
Denis Efremov15bfc232019-08-01 09:06:57 +03002666 for (n = 0; n < SYMBOL_HASH_SIZE; n++) {
Masahiro Yamada47346e92019-09-24 21:07:40 +09002667 struct symbol *s;
Denis Efremov15bfc232019-08-01 09:06:57 +03002668
Masahiro Yamada47346e92019-09-24 21:07:40 +09002669 for (s = symbolhash[n]; s; s = s->next) {
Denis Efremov15bfc232019-08-01 09:06:57 +03002670 if (s->is_static)
2671 warn("\"%s\" [%s] is a static %s\n",
2672 s->name, s->module->name,
2673 export_str(s->export));
Denis Efremov15bfc232019-08-01 09:06:57 +03002674 }
2675 }
2676
Heinrich Schuchardtc7d47f22016-08-02 21:43:01 +02002677 free(buf.p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678
Kirill Korotaevc53ddac2006-09-07 13:08:54 -07002679 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002680}