modpost.c 56.3 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4
/* Postprocess module symbol versions
 *
 * Copyright 2003       Kai Germaschewski
 * Copyright 2002-2004  Rusty Russell, IBM Corporation
S
Sam Ravnborg 已提交
5
 * Copyright 2006-2008  Sam Ravnborg
L
Linus Torvalds 已提交
6 7 8 9 10 11 12 13
 * Based in part on module-init-tools/depmod.c,file2alias
 *
 * This software may be used and distributed according to the terms
 * of the GNU General Public License, incorporated herein by reference.
 *
 * Usage: modpost vmlinux module1.o module2.o ...
 */

14 15
#define _GNU_SOURCE
#include <stdio.h>
L
Linus Torvalds 已提交
16
#include <ctype.h>
17
#include <string.h>
L
Linus Torvalds 已提交
18
#include "modpost.h"
19
#include "../../include/generated/autoconf.h"
20
#include "../../include/linux/license.h"
L
Linus Torvalds 已提交
21

22 23 24 25 26 27 28 29
/* Some toolchains use a `_' prefix for all user symbols. */
#ifdef CONFIG_SYMBOL_PREFIX
#define MODULE_SYMBOL_PREFIX CONFIG_SYMBOL_PREFIX
#else
#define MODULE_SYMBOL_PREFIX ""
#endif


L
Linus Torvalds 已提交
30 31 32 33 34 35
/* Are we using CONFIG_MODVERSIONS? */
int modversions = 0;
/* Warn about undefined symbols? (do so if we have vmlinux) */
int have_vmlinux = 0;
/* Is CONFIG_MODULE_SRCVERSION_ALL set? */
static int all_versions = 0;
36 37
/* If we are modposting external module set to 1 */
static int external_module = 0;
38 39
/* Warn about section mismatch in vmlinux if set to 1 */
static int vmlinux_section_warnings = 1;
40 41
/* Only warn about unresolved symbols */
static int warn_unresolved = 0;
42
/* How a symbol is exported */
43 44 45
static int sec_mismatch_count = 0;
static int sec_mismatch_verbose = 1;

46 47 48 49
enum export {
	export_plain,      export_unused,     export_gpl,
	export_unused_gpl, export_gpl_future, export_unknown
};
L
Linus Torvalds 已提交
50

51 52 53
#define PRINTF __attribute__ ((format (printf, 1, 2)))

PRINTF void fatal(const char *fmt, ...)
L
Linus Torvalds 已提交
54 55 56 57 58 59 60 61 62 63 64 65
{
	va_list arglist;

	fprintf(stderr, "FATAL: ");

	va_start(arglist, fmt);
	vfprintf(stderr, fmt, arglist);
	va_end(arglist);

	exit(1);
}

66
PRINTF void warn(const char *fmt, ...)
L
Linus Torvalds 已提交
67 68 69 70 71 72 73 74 75 76
{
	va_list arglist;

	fprintf(stderr, "WARNING: ");

	va_start(arglist, fmt);
	vfprintf(stderr, fmt, arglist);
	va_end(arglist);
}

77
PRINTF void merror(const char *fmt, ...)
78 79 80 81 82 83 84 85 86 87
{
	va_list arglist;

	fprintf(stderr, "ERROR: ");

	va_start(arglist, fmt);
	vfprintf(stderr, fmt, arglist);
	va_end(arglist);
}

88 89 90 91
static int is_vmlinux(const char *modname)
{
	const char *myname;

S
Sam Ravnborg 已提交
92 93
	myname = strrchr(modname, '/');
	if (myname)
94 95 96 97
		myname++;
	else
		myname = modname;

98 99
	return (strcmp(myname, "vmlinux") == 0) ||
	       (strcmp(myname, "vmlinux.o") == 0);
100 101
}

L
Linus Torvalds 已提交
102 103
void *do_nofail(void *ptr, const char *expr)
{
S
Sam Ravnborg 已提交
104
	if (!ptr)
L
Linus Torvalds 已提交
105
		fatal("modpost: Memory allocation failure: %s.\n", expr);
S
Sam Ravnborg 已提交
106

L
Linus Torvalds 已提交
107 108 109 110 111 112
	return ptr;
}

/* A list of all modules we processed */
static struct module *modules;

113
static struct module *find_module(char *modname)
L
Linus Torvalds 已提交
114 115 116 117 118 119 120 121 122
{
	struct module *mod;

	for (mod = modules; mod; mod = mod->next)
		if (strcmp(mod->name, modname) == 0)
			break;
	return mod;
}

123
static struct module *new_module(char *modname)
L
Linus Torvalds 已提交
124 125 126
{
	struct module *mod;
	char *p, *s;
127

L
Linus Torvalds 已提交
128 129 130 131 132
	mod = NOFAIL(malloc(sizeof(*mod)));
	memset(mod, 0, sizeof(*mod));
	p = NOFAIL(strdup(modname));

	/* strip trailing .o */
S
Sam Ravnborg 已提交
133 134
	s = strrchr(p, '.');
	if (s != NULL)
135
		if (strcmp(s, ".o") == 0) {
L
Linus Torvalds 已提交
136
			*s = '\0';
137 138
			mod->is_dot_o = 1;
		}
L
Linus Torvalds 已提交
139 140 141

	/* add to list */
	mod->name = p;
142
	mod->gpl_compatible = -1;
L
Linus Torvalds 已提交
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
	mod->next = modules;
	modules = mod;

	return mod;
}

/* A hash of all exported symbols,
 * struct symbol is also used for lists of unresolved symbols */

#define SYMBOL_HASH_SIZE 1024

struct symbol {
	struct symbol *next;
	struct module *module;
	unsigned int crc;
	int crc_valid;
	unsigned int weak:1;
160 161 162
	unsigned int vmlinux:1;    /* 1 if symbol is defined in vmlinux */
	unsigned int kernel:1;     /* 1 if symbol is from kernel
				    *  (only for external modules) **/
163
	unsigned int preloaded:1;  /* 1 if symbol from Module.symvers */
164
	enum export  export;       /* Type of export */
L
Linus Torvalds 已提交
165 166 167 168 169 170 171 172 173 174 175 176
	char name[0];
};

static struct symbol *symbolhash[SYMBOL_HASH_SIZE];

/* This is based on the hash agorithm from gdbm, via tdb */
static inline unsigned int tdb_hash(const char *name)
{
	unsigned value;	/* Used to compute the hash value.  */
	unsigned   i;	/* Used to cycle through random values. */

	/* Set the initial value from the key size. */
S
Sam Ravnborg 已提交
177
	for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
L
Linus Torvalds 已提交
178 179 180 181 182
		value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));

	return (1103515243 * value + 12345);
}

183 184 185 186 187 188
/**
 * Allocate a new symbols for use in the hash of exported symbols or
 * the list of unresolved symbols per module
 **/
static struct symbol *alloc_symbol(const char *name, unsigned int weak,
				   struct symbol *next)
L
Linus Torvalds 已提交
189 190 191 192 193 194 195 196 197 198 199
{
	struct symbol *s = NOFAIL(malloc(sizeof(*s) + strlen(name) + 1));

	memset(s, 0, sizeof(*s));
	strcpy(s->name, name);
	s->weak = weak;
	s->next = next;
	return s;
}

/* For the hash of exported symbols */
200 201
static struct symbol *new_symbol(const char *name, struct module *module,
				 enum export export)
L
Linus Torvalds 已提交
202 203 204 205 206 207 208
{
	unsigned int hash;
	struct symbol *new;

	hash = tdb_hash(name) % SYMBOL_HASH_SIZE;
	new = symbolhash[hash] = alloc_symbol(name, 0, symbolhash[hash]);
	new->module = module;
209
	new->export = export;
210
	return new;
L
Linus Torvalds 已提交
211 212
}

213
static struct symbol *find_symbol(const char *name)
L
Linus Torvalds 已提交
214 215 216 217 218 219 220
{
	struct symbol *s;

	/* For our purposes, .foo matches foo.  PPC64 needs this. */
	if (name[0] == '.')
		name++;

S
Sam Ravnborg 已提交
221
	for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
L
Linus Torvalds 已提交
222 223 224 225 226 227
		if (strcmp(s->name, name) == 0)
			return s;
	}
	return NULL;
}

228 229 230 231 232
static struct {
	const char *str;
	enum export export;
} export_list[] = {
	{ .str = "EXPORT_SYMBOL",            .export = export_plain },
233
	{ .str = "EXPORT_UNUSED_SYMBOL",     .export = export_unused },
234
	{ .str = "EXPORT_SYMBOL_GPL",        .export = export_gpl },
235
	{ .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
236 237 238 239 240 241 242 243 244 245
	{ .str = "EXPORT_SYMBOL_GPL_FUTURE", .export = export_gpl_future },
	{ .str = "(unknown)",                .export = export_unknown },
};


static const char *export_str(enum export ex)
{
	return export_list[ex].str;
}

S
Sam Ravnborg 已提交
246
static enum export export_no(const char *s)
247 248
{
	int i;
S
Sam Ravnborg 已提交
249

S
Sam Ravnborg 已提交
250 251
	if (!s)
		return export_unknown;
252 253 254 255 256 257 258
	for (i = 0; export_list[i].export != export_unknown; i++) {
		if (strcmp(export_list[i].str, s) == 0)
			return export_list[i].export;
	}
	return export_unknown;
}

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
static const char *sec_name(struct elf_info *elf, int secindex);

#define strstarts(str, prefix) (strncmp(str, prefix, strlen(prefix)) == 0)

static enum export export_from_secname(struct elf_info *elf, unsigned int sec)
{
	const char *secname = sec_name(elf, sec);

	if (strstarts(secname, "___ksymtab+"))
		return export_plain;
	else if (strstarts(secname, "___ksymtab_unused+"))
		return export_unused;
	else if (strstarts(secname, "___ksymtab_gpl+"))
		return export_gpl;
	else if (strstarts(secname, "___ksymtab_unused_gpl+"))
		return export_unused_gpl;
	else if (strstarts(secname, "___ksymtab_gpl_future+"))
		return export_gpl_future;
	else
		return export_unknown;
}

281
static enum export export_from_sec(struct elf_info *elf, unsigned int sec)
282 283 284
{
	if (sec == elf->export_sec)
		return export_plain;
285 286
	else if (sec == elf->export_unused_sec)
		return export_unused;
287 288
	else if (sec == elf->export_gpl_sec)
		return export_gpl;
289 290
	else if (sec == elf->export_unused_gpl_sec)
		return export_unused_gpl;
291 292 293 294 295 296
	else if (sec == elf->export_gpl_future_sec)
		return export_gpl_future;
	else
		return export_unknown;
}

297 298 299 300
/**
 * Add an exported symbol - it may have already been added without a
 * CRC, in this case just update the CRC
 **/
301 302
static struct symbol *sym_add_exported(const char *name, struct module *mod,
				       enum export export)
L
Linus Torvalds 已提交
303 304 305 306
{
	struct symbol *s = find_symbol(name);

	if (!s) {
307
		s = new_symbol(name, mod, export);
308 309
	} else {
		if (!s->preloaded) {
310
			warn("%s: '%s' exported twice. Previous export "
311 312 313
			     "was in %s%s\n", mod->name, name,
			     s->module->name,
			     is_vmlinux(s->module->name) ?"":".ko");
314 315 316
		} else {
			/* In case Modules.symvers was out of date */
			s->module = mod;
317
		}
L
Linus Torvalds 已提交
318
	}
319
	s->preloaded = 0;
320 321
	s->vmlinux   = is_vmlinux(mod->name);
	s->kernel    = 0;
322
	s->export    = export;
323 324 325 326
	return s;
}

static void sym_update_crc(const char *name, struct module *mod,
327
			   unsigned int crc, enum export export)
328 329 330 331
{
	struct symbol *s = find_symbol(name);

	if (!s)
332
		s = new_symbol(name, mod, export);
333 334
	s->crc = crc;
	s->crc_valid = 1;
L
Linus Torvalds 已提交
335 336
}

337
void *grab_file(const char *filename, unsigned long *size)
L
Linus Torvalds 已提交
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
{
	struct stat st;
	void *map;
	int fd;

	fd = open(filename, O_RDONLY);
	if (fd < 0 || fstat(fd, &st) != 0)
		return NULL;

	*size = st.st_size;
	map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
	close(fd);

	if (map == MAP_FAILED)
		return NULL;
	return map;
}

356 357 358 359 360
/**
  * Return a copy of the next line in a mmap'ed file.
  * spaces in the beginning of the line is trimmed away.
  * Return a pointer to a static buffer.
  **/
S
Sam Ravnborg 已提交
361
char *get_next_line(unsigned long *pos, void *file, unsigned long size)
L
Linus Torvalds 已提交
362 363 364 365 366 367 368
{
	static char line[4096];
	int skip = 1;
	size_t len = 0;
	signed char *p = (signed char *)file + *pos;
	char *s = line;

S
Sam Ravnborg 已提交
369
	for (; *pos < size ; (*pos)++) {
L
Linus Torvalds 已提交
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
		if (skip && isspace(*p)) {
			p++;
			continue;
		}
		skip = 0;
		if (*p != '\n' && (*pos < size)) {
			len++;
			*s++ = *p++;
			if (len > 4095)
				break; /* Too long, stop */
		} else {
			/* End of string */
			*s = '\0';
			return line;
		}
	}
	/* End of buffer */
	return NULL;
}

390
void release_file(void *file, unsigned long size)
L
Linus Torvalds 已提交
391 392 393 394
{
	munmap(file, size);
}

395
static int parse_elf(struct elf_info *info, const char *filename)
L
Linus Torvalds 已提交
396 397
{
	unsigned int i;
398
	Elf_Ehdr *hdr;
L
Linus Torvalds 已提交
399 400
	Elf_Shdr *sechdrs;
	Elf_Sym  *sym;
401 402
	const char *secstrings;
	unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
L
Linus Torvalds 已提交
403 404 405 406

	hdr = grab_file(filename, &info->size);
	if (!hdr) {
		perror(filename);
407
		exit(1);
L
Linus Torvalds 已提交
408 409
	}
	info->hdr = hdr;
410 411 412 413 414 415 416 417 418 419 420 421
	if (info->size < sizeof(*hdr)) {
		/* file too small, assume this is an empty .o file */
		return 0;
	}
	/* Is this a valid ELF file? */
	if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
	    (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
	    (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
	    (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
		/* Not an ELF file - silently ignore it */
		return 0;
	}
L
Linus Torvalds 已提交
422
	/* Fix endianness in ELF header */
423 424 425 426 427 428 429 430 431 432 433 434 435
	hdr->e_type      = TO_NATIVE(hdr->e_type);
	hdr->e_machine   = TO_NATIVE(hdr->e_machine);
	hdr->e_version   = TO_NATIVE(hdr->e_version);
	hdr->e_entry     = TO_NATIVE(hdr->e_entry);
	hdr->e_phoff     = TO_NATIVE(hdr->e_phoff);
	hdr->e_shoff     = TO_NATIVE(hdr->e_shoff);
	hdr->e_flags     = TO_NATIVE(hdr->e_flags);
	hdr->e_ehsize    = TO_NATIVE(hdr->e_ehsize);
	hdr->e_phentsize = TO_NATIVE(hdr->e_phentsize);
	hdr->e_phnum     = TO_NATIVE(hdr->e_phnum);
	hdr->e_shentsize = TO_NATIVE(hdr->e_shentsize);
	hdr->e_shnum     = TO_NATIVE(hdr->e_shnum);
	hdr->e_shstrndx  = TO_NATIVE(hdr->e_shstrndx);
L
Linus Torvalds 已提交
436 437 438
	sechdrs = (void *)hdr + hdr->e_shoff;
	info->sechdrs = sechdrs;

P
Petr Stetiar 已提交
439 440
	/* Check if file offset is correct */
	if (hdr->e_shoff > info->size) {
S
Sam Ravnborg 已提交
441 442 443
		fatal("section header offset=%lu in file '%s' is bigger than "
		      "filesize=%lu\n", (unsigned long)hdr->e_shoff,
		      filename, info->size);
P
Petr Stetiar 已提交
444 445 446
		return 0;
	}

447
	if (hdr->e_shnum == SHN_UNDEF) {
448 449 450 451 452 453 454 455 456 457
		/*
		 * There are more than 64k sections,
		 * read count from .sh_size.
		 */
		info->num_sections = TO_NATIVE(sechdrs[0].sh_size);
	}
	else {
		info->num_sections = hdr->e_shnum;
	}
	if (hdr->e_shstrndx == SHN_XINDEX) {
458
		info->secindex_strings = TO_NATIVE(sechdrs[0].sh_link);
459 460 461 462 463
	}
	else {
		info->secindex_strings = hdr->e_shstrndx;
	}

L
Linus Torvalds 已提交
464
	/* Fix endianness in section headers */
465
	for (i = 0; i < info->num_sections; i++) {
466 467 468 469 470 471 472 473 474 475
		sechdrs[i].sh_name      = TO_NATIVE(sechdrs[i].sh_name);
		sechdrs[i].sh_type      = TO_NATIVE(sechdrs[i].sh_type);
		sechdrs[i].sh_flags     = TO_NATIVE(sechdrs[i].sh_flags);
		sechdrs[i].sh_addr      = TO_NATIVE(sechdrs[i].sh_addr);
		sechdrs[i].sh_offset    = TO_NATIVE(sechdrs[i].sh_offset);
		sechdrs[i].sh_size      = TO_NATIVE(sechdrs[i].sh_size);
		sechdrs[i].sh_link      = TO_NATIVE(sechdrs[i].sh_link);
		sechdrs[i].sh_info      = TO_NATIVE(sechdrs[i].sh_info);
		sechdrs[i].sh_addralign = TO_NATIVE(sechdrs[i].sh_addralign);
		sechdrs[i].sh_entsize   = TO_NATIVE(sechdrs[i].sh_entsize);
L
Linus Torvalds 已提交
476 477
	}
	/* Find symbol table. */
478 479
	secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
	for (i = 1; i < info->num_sections; i++) {
480
		const char *secname;
481
		int nobits = sechdrs[i].sh_type == SHT_NOBITS;
L
Linus Torvalds 已提交
482

483
		if (!nobits && sechdrs[i].sh_offset > info->size) {
S
Sam Ravnborg 已提交
484 485 486 487
			fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
			      "sizeof(*hrd)=%zu\n", filename,
			      (unsigned long)sechdrs[i].sh_offset,
			      sizeof(*hdr));
488 489
			return 0;
		}
490 491
		secname = secstrings + sechdrs[i].sh_name;
		if (strcmp(secname, ".modinfo") == 0) {
492 493
			if (nobits)
				fatal("%s has NOBITS .modinfo\n", filename);
L
Linus Torvalds 已提交
494 495
			info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
			info->modinfo_len = sechdrs[i].sh_size;
496 497
		} else if (strcmp(secname, "__ksymtab") == 0)
			info->export_sec = i;
498 499
		else if (strcmp(secname, "__ksymtab_unused") == 0)
			info->export_unused_sec = i;
500 501
		else if (strcmp(secname, "__ksymtab_gpl") == 0)
			info->export_gpl_sec = i;
502 503
		else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
			info->export_unused_gpl_sec = i;
504 505 506
		else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
			info->export_gpl_future_sec = i;

507 508 509 510 511 512 513
		if (sechdrs[i].sh_type == SHT_SYMTAB) {
			unsigned int sh_link_idx;
			symtab_idx = i;
			info->symtab_start = (void *)hdr +
			    sechdrs[i].sh_offset;
			info->symtab_stop  = (void *)hdr +
			    sechdrs[i].sh_offset + sechdrs[i].sh_size;
514
			sh_link_idx = sechdrs[i].sh_link;
515 516 517
			info->strtab       = (void *)hdr +
			    sechdrs[sh_link_idx].sh_offset;
		}
L
Linus Torvalds 已提交
518

519 520 521 522 523 524 525 526
		/* 32bit section no. table? ("more than 64k sections") */
		if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
			symtab_shndx_idx = i;
			info->symtab_shndx_start = (void *)hdr +
			    sechdrs[i].sh_offset;
			info->symtab_shndx_stop  = (void *)hdr +
			    sechdrs[i].sh_offset + sechdrs[i].sh_size;
		}
L
Linus Torvalds 已提交
527
	}
S
Sam Ravnborg 已提交
528
	if (!info->symtab_start)
529
		fatal("%s has no symtab?\n", filename);
S
Sam Ravnborg 已提交
530

L
Linus Torvalds 已提交
531 532 533 534 535 536 537
	/* Fix endianness in symbols */
	for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
		sym->st_shndx = TO_NATIVE(sym->st_shndx);
		sym->st_name  = TO_NATIVE(sym->st_name);
		sym->st_value = TO_NATIVE(sym->st_value);
		sym->st_size  = TO_NATIVE(sym->st_size);
	}
538 539 540

	if (symtab_shndx_idx != ~0U) {
		Elf32_Word *p;
541
		if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
542
			fatal("%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
543
			      filename, sechdrs[symtab_shndx_idx].sh_link,
544 545 546 547 548 549 550
			      symtab_idx);
		/* Fix endianness */
		for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
		     p++)
			*p = TO_NATIVE(*p);
	}

551
	return 1;
L
Linus Torvalds 已提交
552 553
}

554
static void parse_elf_finish(struct elf_info *info)
L
Linus Torvalds 已提交
555 556 557 558
{
	release_file(info->hdr, info->size);
}

559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
static int ignore_undef_symbol(struct elf_info *info, const char *symname)
{
	/* ignore __this_module, it will be resolved shortly */
	if (strcmp(symname, MODULE_SYMBOL_PREFIX "__this_module") == 0)
		return 1;
	/* ignore global offset table */
	if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
		return 1;
	if (info->hdr->e_machine == EM_PPC)
		/* Special register function linked on all modules during final link of .ko */
		if (strncmp(symname, "_restgpr_", sizeof("_restgpr_") - 1) == 0 ||
		    strncmp(symname, "_savegpr_", sizeof("_savegpr_") - 1) == 0 ||
		    strncmp(symname, "_rest32gpr_", sizeof("_rest32gpr_") - 1) == 0 ||
		    strncmp(symname, "_save32gpr_", sizeof("_save32gpr_") - 1) == 0)
			return 1;
574 575 576 577 578
	if (info->hdr->e_machine == EM_PPC64)
		/* Special register function linked on all modules during final link of .ko */
		if (strncmp(symname, "_restgpr0_", sizeof("_restgpr0_") - 1) == 0 ||
		    strncmp(symname, "_savegpr0_", sizeof("_savegpr0_") - 1) == 0)
			return 1;
579 580 581 582
	/* Do not ignore this symbol */
	return 0;
}

583 584
#define CRC_PFX     MODULE_SYMBOL_PREFIX "__crc_"
#define KSYMTAB_PFX MODULE_SYMBOL_PREFIX "__ksymtab_"
L
Linus Torvalds 已提交
585

586 587
static void handle_modversions(struct module *mod, struct elf_info *info,
			       Elf_Sym *sym, const char *symname)
L
Linus Torvalds 已提交
588 589
{
	unsigned int crc;
590 591
	enum export export;

592 593
	if ((!is_vmlinux(mod->name) || mod->is_dot_o) &&
	    strncmp(symname, "__ksymtab", 9) == 0)
594 595 596
		export = export_from_secname(info, get_secindex(info, sym));
	else
		export = export_from_sec(info, get_secindex(info, sym));
L
Linus Torvalds 已提交
597 598 599

	switch (sym->st_shndx) {
	case SHN_COMMON:
600
		warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
L
Linus Torvalds 已提交
601 602 603
		break;
	case SHN_ABS:
		/* CRC'd symbol */
604
		if (strncmp(symname, CRC_PFX, strlen(CRC_PFX)) == 0) {
L
Linus Torvalds 已提交
605
			crc = (unsigned int) sym->st_value;
606 607
			sym_update_crc(symname + strlen(CRC_PFX), mod, crc,
					export);
L
Linus Torvalds 已提交
608 609 610 611 612 613 614
		}
		break;
	case SHN_UNDEF:
		/* undefined symbol */
		if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
		    ELF_ST_BIND(sym->st_info) != STB_WEAK)
			break;
615
		if (ignore_undef_symbol(info, symname))
L
Linus Torvalds 已提交
616
			break;
617 618 619 620 621 622
/* cope with newer glibc (2.3.4 or higher) STT_ definition in elf.h */
#if defined(STT_REGISTER) || defined(STT_SPARC_REGISTER)
/* add compatibility with older glibc */
#ifndef STT_SPARC_REGISTER
#define STT_SPARC_REGISTER STT_REGISTER
#endif
L
Linus Torvalds 已提交
623 624 625
		if (info->hdr->e_machine == EM_SPARC ||
		    info->hdr->e_machine == EM_SPARCV9) {
			/* Ignore register directives. */
626
			if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
L
Linus Torvalds 已提交
627
				break;
628 629 630 631 632 633
			if (symname[0] == '.') {
				char *munged = strdup(symname);
				munged[0] = '_';
				munged[1] = toupper(munged[1]);
				symname = munged;
			}
L
Linus Torvalds 已提交
634 635
		}
#endif
636

L
Linus Torvalds 已提交
637
		if (memcmp(symname, MODULE_SYMBOL_PREFIX,
S
Sam Ravnborg 已提交
638 639 640 641 642 643 644
			   strlen(MODULE_SYMBOL_PREFIX)) == 0) {
			mod->unres =
			  alloc_symbol(symname +
			               strlen(MODULE_SYMBOL_PREFIX),
			               ELF_ST_BIND(sym->st_info) == STB_WEAK,
			               mod->unres);
		}
L
Linus Torvalds 已提交
645 646 647
		break;
	default:
		/* All exported symbols */
648
		if (strncmp(symname, KSYMTAB_PFX, strlen(KSYMTAB_PFX)) == 0) {
649 650
			sym_add_exported(symname + strlen(KSYMTAB_PFX), mod,
					export);
L
Linus Torvalds 已提交
651 652 653 654 655 656 657 658 659
		}
		if (strcmp(symname, MODULE_SYMBOL_PREFIX "init_module") == 0)
			mod->has_init = 1;
		if (strcmp(symname, MODULE_SYMBOL_PREFIX "cleanup_module") == 0)
			mod->has_cleanup = 1;
		break;
	}
}

660 661 662
/**
 * Parse tag=value strings from .modinfo section
 **/
L
Linus Torvalds 已提交
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
static char *next_string(char *string, unsigned long *secsize)
{
	/* Skip non-zero chars */
	while (string[0]) {
		string++;
		if ((*secsize)-- <= 1)
			return NULL;
	}

	/* Skip any zero padding. */
	while (!string[0]) {
		string++;
		if ((*secsize)-- <= 1)
			return NULL;
	}
	return string;
}

681 682
static char *get_next_modinfo(void *modinfo, unsigned long modinfo_len,
			      const char *tag, char *info)
L
Linus Torvalds 已提交
683 684 685 686 687
{
	char *p;
	unsigned int taglen = strlen(tag);
	unsigned long size = modinfo_len;

688 689 690 691 692
	if (info) {
		size -= info - (char *)modinfo;
		modinfo = next_string(info, &size);
	}

L
Linus Torvalds 已提交
693 694 695 696 697 698 699
	for (p = modinfo; p; p = next_string(p, &size)) {
		if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
			return p + taglen + 1;
	}
	return NULL;
}

700 701 702 703 704 705 706
static char *get_modinfo(void *modinfo, unsigned long modinfo_len,
			 const char *tag)

{
	return get_next_modinfo(modinfo, modinfo_len, tag, NULL);
}

707 708 709 710 711 712
/**
 * Test if string s ends in string sub
 * return 0 if match
 **/
static int strrcmp(const char *s, const char *sub)
{
S
Sam Ravnborg 已提交
713
	int slen, sublen;
714

715 716
	if (!s || !sub)
		return 1;
717

718
	slen = strlen(s);
S
Sam Ravnborg 已提交
719
	sublen = strlen(sub);
720

721 722 723
	if ((slen == 0) || (sublen == 0))
		return 1;

S
Sam Ravnborg 已提交
724 725
	if (sublen > slen)
		return 1;
726

S
Sam Ravnborg 已提交
727
	return memcmp(s + slen - sublen, sub, sublen);
728 729
}

730 731
static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
{
732 733 734
	if (sym)
		return elf->strtab + sym->st_name;
	else
735
		return "(unknown)";
736 737
}

738
static const char *sec_name(struct elf_info *elf, int secindex)
739 740 741
{
	Elf_Shdr *sechdrs = elf->sechdrs;
	return (void *)elf->hdr +
742 743
		elf->sechdrs[elf->secindex_strings].sh_offset +
		sechdrs[secindex].sh_name;
744 745 746 747 748
}

static const char *sech_name(struct elf_info *elf, Elf_Shdr *sechdr)
{
	return (void *)elf->hdr +
749 750
		elf->sechdrs[elf->secindex_strings].sh_offset +
		sechdr->sh_name;
751 752
}

753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
/* if sym is empty or point to a string
 * like ".[0-9]+" then return 1.
 * This is the optional prefix added by ld to some sections
 */
static int number_prefix(const char *sym)
{
	if (*sym++ == '\0')
		return 1;
	if (*sym != '.')
		return 0;
	do {
		char c = *sym++;
		if (c < '0' || c > '9')
			return 0;
	} while (*sym);
	return 1;
}

/* The pattern is an array of simple patterns.
 * "foo" will match an exact string equal to "foo"
773
 * "*foo" will match a string that ends with "foo"
774 775 776 777 778 779
 * "foo*" will match a string that begins with "foo"
 * "foo$" will match a string equal to "foo" or "foo.1"
 *   where the '1' can be any number including several digits.
 *   The $ syntax is for sections where ld append a dot number
 *   to make section name unique.
 */
780
static int match(const char *sym, const char * const pat[])
781 782 783 784 785 786
{
	const char *p;
	while (*pat) {
		p = *pat++;
		const char *endp = p + strlen(p) - 1;

787 788 789 790 791
		/* "*foo" */
		if (*p == '*') {
			if (strrcmp(sym, p + 1) == 0)
				return 1;
		}
792
		/* "foo*" */
793
		else if (*endp == '*') {
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
			if (strncmp(sym, p, strlen(p) - 1) == 0)
				return 1;
		}
		/* "foo$" */
		else if (*endp == '$') {
			if (strncmp(sym, p, strlen(p) - 1) == 0) {
				if (number_prefix(sym + strlen(p) - 1))
					return 1;
			}
		}
		/* no wildcards */
		else {
			if (strcmp(p, sym) == 0)
				return 1;
		}
	}
	/* no match */
	return 0;
}

/* sections that we do not want to do full section mismatch check on */
static const char *section_white_list[] =
816 817 818
{
	".comment*",
	".debug*",
819
	".zdebug*",		/* Compressed debug sections. */
820
	".GCC-command-line",	/* mn10300 */
821 822 823 824 825 826 827 828
	".mdebug*",        /* alpha, score, mips etc. */
	".pdr",            /* alpha, score, mips etc. */
	".stab*",
	".note*",
	".got*",
	".toc*",
	NULL
};
829

830
/*
831
 * This is used to find sections missing the SHF_ALLOC flag.
832
 * The cause of this is often a section specified in assembler
833
 * without "ax" / "aw".
834
 */
835 836
static void check_section(const char *modname, struct elf_info *elf,
                          Elf_Shdr *sechdr)
837
{
838 839 840 841 842 843 844 845 846 847
	const char *sec = sech_name(elf, sechdr);

	if (sechdr->sh_type == SHT_PROGBITS &&
	    !(sechdr->sh_flags & SHF_ALLOC) &&
	    !match(sec, section_white_list)) {
		warn("%s (%s): unexpected non-allocatable section.\n"
		     "Did you forget to use \"ax\"/\"aw\" in a .S file?\n"
		     "Note that for example <linux/init.h> contains\n"
		     "section definitions for use in .S files.\n\n",
		     modname, sec);
848 849 850 851 852
	}
}



853
#define ALL_INIT_DATA_SECTIONS \
J
Jan Beulich 已提交
854
	".init.setup$", ".init.rodata$", \
855
	".devinit.rodata$", ".cpuinit.rodata$", ".meminit.rodata$", \
856 857 858
	".init.data$", ".devinit.data$", ".cpuinit.data$", ".meminit.data$"
#define ALL_EXIT_DATA_SECTIONS \
	".exit.data$", ".devexit.data$", ".cpuexit.data$", ".memexit.data$"
859

860 861 862 863
#define ALL_INIT_TEXT_SECTIONS \
	".init.text$", ".devinit.text$", ".cpuinit.text$", ".meminit.text$"
#define ALL_EXIT_TEXT_SECTIONS \
	".exit.text$", ".devexit.text$", ".cpuexit.text$", ".memexit.text$"
864

865 866 867 868 869 870 871
#define ALL_XXXINIT_SECTIONS DEV_INIT_SECTIONS, CPU_INIT_SECTIONS, \
	MEM_INIT_SECTIONS
#define ALL_XXXEXIT_SECTIONS DEV_EXIT_SECTIONS, CPU_EXIT_SECTIONS, \
	MEM_EXIT_SECTIONS

#define ALL_INIT_SECTIONS INIT_SECTIONS, ALL_XXXINIT_SECTIONS
#define ALL_EXIT_SECTIONS EXIT_SECTIONS, ALL_XXXEXIT_SECTIONS
872

873
#define DATA_SECTIONS ".data$", ".data.rel$"
874 875
#define TEXT_SECTIONS ".text$"

J
Jan Beulich 已提交
876 877 878 879
#define INIT_SECTIONS      ".init.*"
#define DEV_INIT_SECTIONS  ".devinit.*"
#define CPU_INIT_SECTIONS  ".cpuinit.*"
#define MEM_INIT_SECTIONS  ".meminit.*"
880

J
Jan Beulich 已提交
881 882 883 884
#define EXIT_SECTIONS      ".exit.*"
#define DEV_EXIT_SECTIONS  ".devexit.*"
#define CPU_EXIT_SECTIONS  ".cpuexit.*"
#define MEM_EXIT_SECTIONS  ".memexit.*"
885

886
/* init data sections */
887
static const char *init_data_sections[] = { ALL_INIT_DATA_SECTIONS, NULL };
888 889

/* all init sections */
890
static const char *init_sections[] = { ALL_INIT_SECTIONS, NULL };
891 892 893

/* All init and exit sections (code + data) */
static const char *init_exit_sections[] =
894
	{ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
895 896 897 898 899 900

/* data section */
static const char *data_sections[] = { DATA_SECTIONS, NULL };


/* symbols in .data that may refer to init/exit sections */
901 902 903 904 905 906 907 908 909
#define DEFAULT_SYMBOL_WHITE_LIST					\
	"*driver",							\
	"*_template", /* scsi uses *_template a lot */			\
	"*_timer",    /* arm uses ops structures named _timer a lot */	\
	"*_sht",      /* scsi also used *_sht to some extent */		\
	"*_ops",							\
	"*_probe",							\
	"*_probe_one",							\
	"*_console"
910 911 912 913 914

static const char *head_sections[] = { ".head.text*", NULL };
static const char *linker_symbols[] =
	{ "__init_begin", "_sinittext", "_einittext", NULL };

915
enum mismatch {
916 917 918 919 920 921 922 923
	TEXT_TO_ANY_INIT,
	DATA_TO_ANY_INIT,
	TEXT_TO_ANY_EXIT,
	DATA_TO_ANY_EXIT,
	XXXINIT_TO_SOME_INIT,
	XXXEXIT_TO_SOME_EXIT,
	ANY_INIT_TO_ANY_EXIT,
	ANY_EXIT_TO_ANY_INIT,
924 925 926
	EXPORT_TO_INIT_EXIT,
};

927 928 929
struct sectioncheck {
	const char *fromsec[20];
	const char *tosec[20];
930
	enum mismatch mismatch;
931
	const char *symbol_white_list[20];
932 933 934 935 936 937 938
};

const struct sectioncheck sectioncheck[] = {
/* Do not reference init/exit code/data from
 * normal code and data
 */
{
939 940
	.fromsec = { TEXT_SECTIONS, NULL },
	.tosec   = { ALL_INIT_SECTIONS, NULL },
941
	.mismatch = TEXT_TO_ANY_INIT,
942
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
943 944 945
},
{
	.fromsec = { DATA_SECTIONS, NULL },
946
	.tosec   = { ALL_XXXINIT_SECTIONS, NULL },
947
	.mismatch = DATA_TO_ANY_INIT,
948
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
949
},
950 951 952 953 954 955 956 957 958
{
	.fromsec = { DATA_SECTIONS, NULL },
	.tosec   = { INIT_SECTIONS, NULL },
	.mismatch = DATA_TO_ANY_INIT,
	.symbol_white_list = {
		"*_template", "*_timer", "*_sht", "*_ops",
		"*_probe", "*_probe_one", "*_console", NULL
	},
},
959 960 961
{
	.fromsec = { TEXT_SECTIONS, NULL },
	.tosec   = { ALL_EXIT_SECTIONS, NULL },
962
	.mismatch = TEXT_TO_ANY_EXIT,
963
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
964 965 966 967
},
{
	.fromsec = { DATA_SECTIONS, NULL },
	.tosec   = { ALL_EXIT_SECTIONS, NULL },
968
	.mismatch = DATA_TO_ANY_EXIT,
969
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
970 971 972
},
/* Do not reference init code/data from devinit/cpuinit/meminit code/data */
{
973
	.fromsec = { ALL_XXXINIT_SECTIONS, NULL },
974
	.tosec   = { INIT_SECTIONS, NULL },
975
	.mismatch = XXXINIT_TO_SOME_INIT,
976
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
977
},
J
Jan Beulich 已提交
978 979 980 981
/* Do not reference cpuinit code/data from meminit code/data */
{
	.fromsec = { MEM_INIT_SECTIONS, NULL },
	.tosec   = { CPU_INIT_SECTIONS, NULL },
982
	.mismatch = XXXINIT_TO_SOME_INIT,
983
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
J
Jan Beulich 已提交
984 985 986 987 988
},
/* Do not reference meminit code/data from cpuinit code/data */
{
	.fromsec = { CPU_INIT_SECTIONS, NULL },
	.tosec   = { MEM_INIT_SECTIONS, NULL },
989
	.mismatch = XXXINIT_TO_SOME_INIT,
990
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
J
Jan Beulich 已提交
991
},
992 993
/* Do not reference exit code/data from devexit/cpuexit/memexit code/data */
{
994
	.fromsec = { ALL_XXXEXIT_SECTIONS, NULL },
995
	.tosec   = { EXIT_SECTIONS, NULL },
996
	.mismatch = XXXEXIT_TO_SOME_EXIT,
997
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
998
},
J
Jan Beulich 已提交
999 1000 1001 1002
/* Do not reference cpuexit code/data from memexit code/data */
{
	.fromsec = { MEM_EXIT_SECTIONS, NULL },
	.tosec   = { CPU_EXIT_SECTIONS, NULL },
1003
	.mismatch = XXXEXIT_TO_SOME_EXIT,
1004
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
J
Jan Beulich 已提交
1005 1006 1007 1008 1009
},
/* Do not reference memexit code/data from cpuexit code/data */
{
	.fromsec = { CPU_EXIT_SECTIONS, NULL },
	.tosec   = { MEM_EXIT_SECTIONS, NULL },
1010
	.mismatch = XXXEXIT_TO_SOME_EXIT,
1011
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
J
Jan Beulich 已提交
1012
},
1013 1014
/* Do not use exit code/data from init code */
{
1015 1016
	.fromsec = { ALL_INIT_SECTIONS, NULL },
	.tosec   = { ALL_EXIT_SECTIONS, NULL },
1017
	.mismatch = ANY_INIT_TO_ANY_EXIT,
1018
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
1019 1020 1021
},
/* Do not use init code/data from exit code */
{
1022
	.fromsec = { ALL_EXIT_SECTIONS, NULL },
1023
	.tosec   = { ALL_INIT_SECTIONS, NULL },
1024
	.mismatch = ANY_EXIT_TO_ANY_INIT,
1025
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
1026 1027 1028 1029
},
/* Do not export init/exit functions or data */
{
	.fromsec = { "__ksymtab*", NULL },
1030
	.tosec   = { INIT_SECTIONS, EXIT_SECTIONS, NULL },
1031 1032
	.mismatch = EXPORT_TO_INIT_EXIT,
	.symbol_white_list = { DEFAULT_SYMBOL_WHITE_LIST, NULL },
1033 1034 1035
}
};

1036 1037
static const struct sectioncheck *section_mismatch(
		const char *fromsec, const char *tosec)
1038 1039 1040 1041 1042 1043 1044 1045
{
	int i;
	int elems = sizeof(sectioncheck) / sizeof(struct sectioncheck);
	const struct sectioncheck *check = &sectioncheck[0];

	for (i = 0; i < elems; i++) {
		if (match(fromsec, check->fromsec) &&
		    match(tosec, check->tosec))
1046
			return check;
1047 1048
		check++;
	}
1049
	return NULL;
1050 1051
}

1052 1053
/**
 * Whitelist to allow certain references to pass with no warning.
1054
 *
1055 1056 1057 1058 1059 1060 1061
 * Pattern 1:
 *   If a module parameter is declared __initdata and permissions=0
 *   then this is legal despite the warning generated.
 *   We cannot see value of permissions here, so just ignore
 *   this pattern.
 *   The pattern is identified by:
 *   tosec   = .init.data
1062
 *   fromsec = .data*
1063
 *   atsym   =__param*
1064
 *
1065 1066 1067 1068 1069 1070 1071
 * Pattern 1a:
 *   module_param_call() ops can refer to __init set function if permissions=0
 *   The pattern is identified by:
 *   tosec   = .init.text
 *   fromsec = .data*
 *   atsym   = __param_ops_*
 *
1072
 * Pattern 2:
1073
 *   Many drivers utilise a *driver container with references to
1074
 *   add, remove, probe functions etc.
1075
 *   These functions may often be marked __devinit and we do not want to
1076 1077
 *   warn here.
 *   the pattern is identified by:
1078 1079
 *   tosec   = init or exit section
 *   fromsec = data section
S
Sam Ravnborg 已提交
1080 1081
 *   atsym = *driver, *_template, *_sht, *_ops, *_probe,
 *           *probe_one, *_console, *_timer
1082 1083
 *
 * Pattern 3:
S
Sam Ravnborg 已提交
1084
 *   Whitelist all references from .head.text to any init section
1085
 *
1086
 * Pattern 4:
1087 1088 1089 1090 1091 1092 1093
 *   Some symbols belong to init section but still it is ok to reference
 *   these from non-init sections as these symbols don't have any memory
 *   allocated for them and symbol address and value are same. So even
 *   if init section is freed, its ok to reference those symbols.
 *   For ex. symbols marking the init section boundaries.
 *   This pattern is identified by
 *   refsymname = __init_begin, _sinittext, _einittext
1094
 *
1095
 **/
1096 1097
static int secref_whitelist(const struct sectioncheck *mismatch,
			    const char *fromsec, const char *fromsym,
1098
			    const char *tosec, const char *tosym)
1099 1100
{
	/* Check for pattern 1 */
1101 1102
	if (match(tosec, init_data_sections) &&
	    match(fromsec, data_sections) &&
1103 1104
	    (strncmp(fromsym, "__param", strlen("__param")) == 0))
		return 0;
1105

1106 1107 1108 1109 1110 1111
	/* Check for pattern 1a */
	if (strcmp(tosec, ".init.text") == 0 &&
	    match(fromsec, data_sections) &&
	    (strncmp(fromsym, "__param_ops_", strlen("__param_ops_")) == 0))
		return 0;

1112
	/* Check for pattern 2 */
1113 1114
	if (match(tosec, init_exit_sections) &&
	    match(fromsec, data_sections) &&
1115
	    match(fromsym, mismatch->symbol_white_list))
1116
		return 0;
1117

1118
	/* Check for pattern 3 */
1119 1120
	if (match(fromsec, head_sections) &&
	    match(tosec, init_sections))
1121
		return 0;
1122

1123
	/* Check for pattern 4 */
1124 1125
	if (match(tosym, linker_symbols))
		return 0;
1126

1127
	return 1;
1128 1129
}

1130 1131 1132 1133 1134 1135 1136
/**
 * Find symbol based on relocation record info.
 * In some cases the symbol supplied is a valid symbol so
 * return refsym. If st_name != 0 we assume this is a valid symbol.
 * In other cases the symbol needs to be looked up in the symbol table
 * based on section and address.
 *  **/
1137
static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
1138 1139 1140
				Elf_Sym *relsym)
{
	Elf_Sym *sym;
1141 1142 1143
	Elf_Sym *near = NULL;
	Elf64_Sword distance = 20;
	Elf64_Sword d;
1144
	unsigned int relsym_secindex;
1145 1146 1147

	if (relsym->st_name != 0)
		return relsym;
1148 1149

	relsym_secindex = get_secindex(elf, relsym);
1150
	for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
1151
		if (get_secindex(elf, sym) != relsym_secindex)
1152
			continue;
1153 1154
		if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
			continue;
1155 1156
		if (sym->st_value == addr)
			return sym;
1157 1158 1159 1160 1161 1162 1163 1164
		/* Find a symbol nearby - addr are maybe negative */
		d = sym->st_value - addr;
		if (d < 0)
			d = addr - sym->st_value;
		if (d < distance) {
			distance = d;
			near = sym;
		}
1165
	}
1166 1167 1168 1169 1170
	/* We need a close match */
	if (distance < 20)
		return near;
	else
		return NULL;
1171 1172
}

1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
static inline int is_arm_mapping_symbol(const char *str)
{
	return str[0] == '$' && strchr("atd", str[1])
	       && (str[2] == '\0' || str[2] == '.');
}

/*
 * If there's no name there, ignore it; likewise, ignore it if it's
 * one of the magic symbols emitted used by current ARM tools.
 *
 * Otherwise if find_symbols_between() returns those symbols, they'll
 * fail the whitelist tests and cause lots of false alarms ... fixable
 * only by merging __exit and __init sections into __text, bloating
 * the kernel (which is especially evil on embedded platforms).
 */
static inline int is_valid_name(struct elf_info *elf, Elf_Sym *sym)
{
	const char *name = elf->strtab + sym->st_name;

	if (!name || !strlen(name))
		return 0;
	return !is_arm_mapping_symbol(name);
}

1197
/*
1198 1199 1200 1201
 * Find symbols before or equal addr and after addr - in the section sec.
 * If we find two symbols with equal offset prefer one with a valid name.
 * The ELF format may have a better way to detect what type of symbol
 * it is, but this works for now.
1202
 **/
1203 1204
static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
				 const char *sec)
1205 1206
{
	Elf_Sym *sym;
1207 1208
	Elf_Sym *near = NULL;
	Elf_Addr distance = ~0;
1209

1210 1211 1212
	for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
		const char *symsec;

1213
		if (is_shndx_special(sym->st_shndx))
1214
			continue;
1215
		symsec = sec_name(elf, get_secindex(elf, sym));
1216 1217
		if (strcmp(symsec, sec) != 0)
			continue;
1218 1219
		if (!is_valid_name(elf, sym))
			continue;
1220
		if (sym->st_value <= addr) {
1221 1222 1223 1224 1225
			if ((addr - sym->st_value) < distance) {
				distance = addr - sym->st_value;
				near = sym;
			} else if ((addr - sym->st_value) == distance) {
				near = sym;
1226
			}
1227 1228
		}
	}
1229
	return near;
1230 1231
}

1232 1233 1234 1235 1236 1237
/*
 * Convert a section name to the function/data attribute
 * .init.text => __init
 * .cpuinit.data => __cpudata
 * .memexitconst => __memconst
 * etc.
1238 1239 1240
 *
 * The memory of returned value has been allocated on a heap. The user of this
 * method should free it after usage.
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
*/
static char *sec2annotation(const char *s)
{
	if (match(s, init_exit_sections)) {
		char *p = malloc(20);
		char *r = p;

		*p++ = '_';
		*p++ = '_';
		if (*s == '.')
			s++;
		while (*s && *s != '.')
			*p++ = *s++;
		*p = '\0';
		if (*s == '.')
			s++;
		if (strstr(s, "rodata") != NULL)
			strcat(p, "const ");
		else if (strstr(s, "data") != NULL)
			strcat(p, "data ");
		else
			strcat(p, " ");
1263
		return r;
1264
	} else {
1265
		return strdup("");
1266 1267 1268 1269 1270 1271 1272 1273
	}
}

static int is_function(Elf_Sym *sym)
{
	if (sym)
		return ELF_ST_TYPE(sym->st_info) == STT_FUNC;
	else
1274
		return -1;
1275 1276
}

R
Randy Dunlap 已提交
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
static void print_section_list(const char * const list[20])
{
	const char *const *s = list;

	while (*s) {
		fprintf(stderr, "%s", *s);
		s++;
		if (*s)
			fprintf(stderr, ", ");
	}
	fprintf(stderr, "\n");
}

1290
/*
1291 1292
 * Print a warning about a section mismatch.
 * Try to find symbols near it so user can find it.
1293
 * Check whitelist before warning - it may be a false positive.
1294
 */
1295 1296
static void report_sec_mismatch(const char *modname,
				const struct sectioncheck *mismatch,
1297 1298 1299
                                const char *fromsec,
                                unsigned long long fromaddr,
                                const char *fromsym,
1300 1301 1302 1303 1304 1305
                                int from_is_func,
                                const char *tosec, const char *tosym,
                                int to_is_func)
{
	const char *from, *from_p;
	const char *to, *to_p;
1306 1307
	char *prl_from;
	char *prl_to;
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318

	switch (from_is_func) {
	case 0: from = "variable"; from_p = "";   break;
	case 1: from = "function"; from_p = "()"; break;
	default: from = "(unknown reference)"; from_p = ""; break;
	}
	switch (to_is_func) {
	case 0: to = "variable"; to_p = "";   break;
	case 1: to = "function"; to_p = "()"; break;
	default: to = "(unknown reference)"; to_p = ""; break;
	}
1319

1320 1321 1322 1323
	sec_mismatch_count++;
	if (!sec_mismatch_verbose)
		return;

1324 1325 1326 1327
	warn("%s(%s+0x%llx): Section mismatch in reference from the %s %s%s "
	     "to the %s %s:%s%s\n",
	     modname, fromsec, fromaddr, from, fromsym, from_p, to, tosec,
	     tosym, to_p);
1328

1329
	switch (mismatch->mismatch) {
1330
	case TEXT_TO_ANY_INIT:
1331 1332
		prl_from = sec2annotation(fromsec);
		prl_to = sec2annotation(tosec);
1333
		fprintf(stderr,
1334
		"The function %s%s() references\n"
1335 1336 1337
		"the %s %s%s%s.\n"
		"This is often because %s lacks a %s\n"
		"annotation or the annotation of %s is wrong.\n",
1338 1339 1340 1341 1342
		prl_from, fromsym,
		to, prl_to, tosym, to_p,
		fromsym, prl_to, tosym);
		free(prl_from);
		free(prl_to);
1343
		break;
1344
	case DATA_TO_ANY_INIT: {
1345
		prl_to = sec2annotation(tosec);
1346 1347 1348 1349
		fprintf(stderr,
		"The variable %s references\n"
		"the %s %s%s%s\n"
		"If the reference is valid then annotate the\n"
1350
		"variable with __init* or __refdata (see linux/init.h) "
1351
		"or name the variable:\n",
1352
		fromsym, to, prl_to, tosym, to_p);
R
Randy Dunlap 已提交
1353
		print_section_list(mismatch->symbol_white_list);
1354
		free(prl_to);
1355
		break;
1356
	}
1357
	case TEXT_TO_ANY_EXIT:
1358
		prl_to = sec2annotation(tosec);
1359 1360 1361 1362
		fprintf(stderr,
		"The function %s() references a %s in an exit section.\n"
		"Often the %s %s%s has valid usage outside the exit section\n"
		"and the fix is to remove the %sannotation of %s.\n",
1363 1364
		fromsym, to, to, tosym, to_p, prl_to, tosym);
		free(prl_to);
1365
		break;
1366
	case DATA_TO_ANY_EXIT: {
1367
		prl_to = sec2annotation(tosec);
1368 1369 1370 1371 1372 1373
		fprintf(stderr,
		"The variable %s references\n"
		"the %s %s%s%s\n"
		"If the reference is valid then annotate the\n"
		"variable with __exit* (see linux/init.h) or "
		"name the variable:\n",
1374
		fromsym, to, prl_to, tosym, to_p);
R
Randy Dunlap 已提交
1375
		print_section_list(mismatch->symbol_white_list);
1376
		free(prl_to);
1377 1378
		break;
	}
1379 1380
	case XXXINIT_TO_SOME_INIT:
	case XXXEXIT_TO_SOME_EXIT:
1381 1382
		prl_from = sec2annotation(fromsec);
		prl_to = sec2annotation(tosec);
1383 1384 1385 1386 1387
		fprintf(stderr,
		"The %s %s%s%s references\n"
		"a %s %s%s%s.\n"
		"If %s is only used by %s then\n"
		"annotate %s with a matching annotation.\n",
1388 1389
		from, prl_from, fromsym, from_p,
		to, prl_to, tosym, to_p,
1390
		tosym, fromsym, tosym);
1391 1392
		free(prl_from);
		free(prl_to);
1393
		break;
1394
	case ANY_INIT_TO_ANY_EXIT:
1395 1396
		prl_from = sec2annotation(fromsec);
		prl_to = sec2annotation(tosec);
1397 1398 1399 1400 1401 1402 1403 1404
		fprintf(stderr,
		"The %s %s%s%s references\n"
		"a %s %s%s%s.\n"
		"This is often seen when error handling "
		"in the init function\n"
		"uses functionality in the exit path.\n"
		"The fix is often to remove the %sannotation of\n"
		"%s%s so it may be used outside an exit section.\n",
1405 1406
		from, prl_from, fromsym, from_p,
		to, prl_to, tosym, to_p,
1407
		prl_to, tosym, to_p);
1408 1409
		free(prl_from);
		free(prl_to);
1410
		break;
1411
	case ANY_EXIT_TO_ANY_INIT:
1412 1413
		prl_from = sec2annotation(fromsec);
		prl_to = sec2annotation(tosec);
1414 1415 1416 1417 1418 1419 1420 1421
		fprintf(stderr,
		"The %s %s%s%s references\n"
		"a %s %s%s%s.\n"
		"This is often seen when error handling "
		"in the exit function\n"
		"uses functionality in the init path.\n"
		"The fix is often to remove the %sannotation of\n"
		"%s%s so it may be used outside an init section.\n",
1422 1423 1424 1425 1426
		from, prl_from, fromsym, from_p,
		to, prl_to, tosym, to_p,
		prl_to, tosym, to_p);
		free(prl_from);
		free(prl_to);
1427 1428
		break;
	case EXPORT_TO_INIT_EXIT:
1429
		prl_to = sec2annotation(tosec);
1430 1431 1432 1433
		fprintf(stderr,
		"The symbol %s is exported and annotated %s\n"
		"Fix this by removing the %sannotation of %s "
		"or drop the export.\n",
1434 1435
		tosym, prl_to, prl_to, tosym);
		free(prl_to);
1436 1437 1438
		break;
	}
	fprintf(stderr, "\n");
1439 1440 1441 1442 1443 1444
}

static void check_section_mismatch(const char *modname, struct elf_info *elf,
                                   Elf_Rela *r, Elf_Sym *sym, const char *fromsec)
{
	const char *tosec;
1445
	const struct sectioncheck *mismatch;
1446

1447
	tosec = sec_name(elf, get_secindex(elf, sym));
1448
	mismatch = section_mismatch(fromsec, tosec);
1449
	if (mismatch) {
1450 1451
		Elf_Sym *to;
		Elf_Sym *from;
1452
		const char *tosym;
1453
		const char *fromsym;
1454

1455 1456 1457 1458
		from = find_elf_symbol2(elf, r->r_offset, fromsec);
		fromsym = sym_name(elf, from);
		to = find_elf_symbol(elf, r->r_addend, sym);
		tosym = sym_name(elf, to);
1459 1460

		/* check whitelist - we may ignore it */
1461 1462
		if (secref_whitelist(mismatch,
					fromsec, fromsym, tosec, tosym)) {
1463 1464 1465 1466
			report_sec_mismatch(modname, mismatch,
			   fromsec, r->r_offset, fromsym,
			   is_function(from), tosec, tosym,
			   is_function(to));
1467
		}
1468 1469 1470
	}
}

1471
static unsigned int *reloc_location(struct elf_info *elf,
1472
				    Elf_Shdr *sechdr, Elf_Rela *r)
1473 1474
{
	Elf_Shdr *sechdrs = elf->sechdrs;
1475
	int section = sechdr->sh_info;
1476 1477

	return (void *)elf->hdr + sechdrs[section].sh_offset +
1478
		r->r_offset;
1479 1480
}

1481
static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
1482 1483
{
	unsigned int r_typ = ELF_R_TYPE(r->r_info);
1484
	unsigned int *location = reloc_location(elf, sechdr, r);
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499

	switch (r_typ) {
	case R_386_32:
		r->r_addend = TO_NATIVE(*location);
		break;
	case R_386_PC32:
		r->r_addend = TO_NATIVE(*location) + 4;
		/* For CONFIG_RELOCATABLE=y */
		if (elf->hdr->e_type == ET_EXEC)
			r->r_addend += r->r_offset;
		break;
	}
	return 0;
}

1500 1501 1502 1503 1504 1505 1506
#ifndef R_ARM_CALL
#define R_ARM_CALL	28
#endif
#ifndef R_ARM_JUMP24
#define R_ARM_JUMP24	29
#endif

1507
static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
1508 1509 1510 1511 1512 1513
{
	unsigned int r_typ = ELF_R_TYPE(r->r_info);

	switch (r_typ) {
	case R_ARM_ABS32:
		/* From ARM ABI: (S + A) | T */
S
Sam Ravnborg 已提交
1514 1515
		r->r_addend = (int)(long)
		              (elf->symtab_start + ELF_R_SYM(r->r_info));
1516 1517
		break;
	case R_ARM_PC24:
1518 1519
	case R_ARM_CALL:
	case R_ARM_JUMP24:
1520
		/* From ARM ABI: ((S + A) | T) - P */
S
Sam Ravnborg 已提交
1521
		r->r_addend = (int)(long)(elf->hdr +
1522 1523
		              sechdr->sh_offset +
		              (r->r_offset - sechdr->sh_addr));
1524 1525 1526 1527 1528 1529 1530
		break;
	default:
		return 1;
	}
	return 0;
}

1531
static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
1532 1533
{
	unsigned int r_typ = ELF_R_TYPE(r->r_info);
1534
	unsigned int *location = reloc_location(elf, sechdr, r);
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
	unsigned int inst;

	if (r_typ == R_MIPS_HI16)
		return 1;	/* skip this */
	inst = TO_NATIVE(*location);
	switch (r_typ) {
	case R_MIPS_LO16:
		r->r_addend = inst & 0xffff;
		break;
	case R_MIPS_26:
		r->r_addend = (inst & 0x03ffffff) << 2;
		break;
	case R_MIPS_32:
		r->r_addend = inst;
		break;
	}
	return 0;
}

1554
static void section_rela(const char *modname, struct elf_info *elf,
1555
                         Elf_Shdr *sechdr)
1556 1557 1558 1559 1560 1561 1562
{
	Elf_Sym  *sym;
	Elf_Rela *rela;
	Elf_Rela r;
	unsigned int r_sym;
	const char *fromsec;

1563
	Elf_Rela *start = (void *)elf->hdr + sechdr->sh_offset;
1564 1565
	Elf_Rela *stop  = (void *)start + sechdr->sh_size;

1566
	fromsec = sech_name(elf, sechdr);
1567 1568
	fromsec += strlen(".rela");
	/* if from section (name) is know good then skip it */
1569
	if (match(fromsec, section_white_list))
1570
		return;
1571

1572 1573 1574
	for (rela = start; rela < stop; rela++) {
		r.r_offset = TO_NATIVE(rela->r_offset);
#if KERNEL_ELFCLASS == ELFCLASS64
1575
		if (elf->hdr->e_machine == EM_MIPS) {
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
			unsigned int r_typ;
			r_sym = ELF64_MIPS_R_SYM(rela->r_info);
			r_sym = TO_NATIVE(r_sym);
			r_typ = ELF64_MIPS_R_TYPE(rela->r_info);
			r.r_info = ELF64_R_INFO(r_sym, r_typ);
		} else {
			r.r_info = TO_NATIVE(rela->r_info);
			r_sym = ELF_R_SYM(r.r_info);
		}
#else
		r.r_info = TO_NATIVE(rela->r_info);
		r_sym = ELF_R_SYM(r.r_info);
#endif
		r.r_addend = TO_NATIVE(rela->r_addend);
		sym = elf->symtab_start + r_sym;
		/* Skip special sections */
1592
		if (is_shndx_special(sym->st_shndx))
1593
			continue;
1594
		check_section_mismatch(modname, elf, &r, sym, fromsec);
1595 1596 1597 1598
	}
}

static void section_rel(const char *modname, struct elf_info *elf,
1599
                        Elf_Shdr *sechdr)
1600 1601 1602 1603 1604 1605 1606
{
	Elf_Sym *sym;
	Elf_Rel *rel;
	Elf_Rela r;
	unsigned int r_sym;
	const char *fromsec;

1607
	Elf_Rel *start = (void *)elf->hdr + sechdr->sh_offset;
1608 1609
	Elf_Rel *stop  = (void *)start + sechdr->sh_size;

1610
	fromsec = sech_name(elf, sechdr);
1611 1612
	fromsec += strlen(".rel");
	/* if from section (name) is know good then skip it */
1613
	if (match(fromsec, section_white_list))
1614 1615 1616 1617 1618
		return;

	for (rel = start; rel < stop; rel++) {
		r.r_offset = TO_NATIVE(rel->r_offset);
#if KERNEL_ELFCLASS == ELFCLASS64
1619
		if (elf->hdr->e_machine == EM_MIPS) {
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
			unsigned int r_typ;
			r_sym = ELF64_MIPS_R_SYM(rel->r_info);
			r_sym = TO_NATIVE(r_sym);
			r_typ = ELF64_MIPS_R_TYPE(rel->r_info);
			r.r_info = ELF64_R_INFO(r_sym, r_typ);
		} else {
			r.r_info = TO_NATIVE(rel->r_info);
			r_sym = ELF_R_SYM(r.r_info);
		}
#else
		r.r_info = TO_NATIVE(rel->r_info);
		r_sym = ELF_R_SYM(r.r_info);
#endif
		r.r_addend = 0;
1634
		switch (elf->hdr->e_machine) {
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
		case EM_386:
			if (addend_386_rel(elf, sechdr, &r))
				continue;
			break;
		case EM_ARM:
			if (addend_arm_rel(elf, sechdr, &r))
				continue;
			break;
		case EM_MIPS:
			if (addend_mips_rel(elf, sechdr, &r))
				continue;
			break;
		}
		sym = elf->symtab_start + r_sym;
		/* Skip special sections */
1650
		if (is_shndx_special(sym->st_shndx))
1651
			continue;
1652
		check_section_mismatch(modname, elf, &r, sym, fromsec);
1653 1654 1655
	}
}

1656 1657 1658 1659
/**
 * A module includes a number of sections that are discarded
 * either when loaded or when used as built-in.
 * For loaded modules all functions marked __init and all data
1660
 * marked __initdata will be discarded when the module has been initialized.
1661 1662
 * Likewise for modules used built-in the sections marked __exit
 * are discarded because __exit marked function are supposed to be called
1663
 * only when a module is unloaded which never happens for built-in modules.
1664 1665 1666 1667 1668
 * The check_sec_ref() function traverses all relocation records
 * to find all references to a section that reference a section that will
 * be discarded and warns about it.
 **/
static void check_sec_ref(struct module *mod, const char *modname,
1669
                          struct elf_info *elf)
1670 1671 1672
{
	int i;
	Elf_Shdr *sechdrs = elf->sechdrs;
1673

1674
	/* Walk through all sections */
1675
	for (i = 0; i < elf->num_sections; i++) {
1676
		check_section(modname, elf, &elf->sechdrs[i]);
1677
		/* We want to process only relocation sections and not .init */
1678
		if (sechdrs[i].sh_type == SHT_RELA)
1679
			section_rela(modname, elf, &elf->sechdrs[i]);
1680
		else if (sechdrs[i].sh_type == SHT_REL)
1681
			section_rel(modname, elf, &elf->sechdrs[i]);
1682 1683 1684
	}
}

1685
static void read_symbols(char *modname)
L
Linus Torvalds 已提交
1686 1687 1688
{
	const char *symname;
	char *version;
1689
	char *license;
L
Linus Torvalds 已提交
1690 1691 1692 1693
	struct module *mod;
	struct elf_info info = { };
	Elf_Sym *sym;

1694 1695
	if (!parse_elf(&info, modname))
		return;
L
Linus Torvalds 已提交
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705

	mod = new_module(modname);

	/* When there's no vmlinux, don't print warnings about
	 * unresolved symbols (since there'll be too many ;) */
	if (is_vmlinux(modname)) {
		have_vmlinux = 1;
		mod->skip = 1;
	}

1706
	license = get_modinfo(info.modinfo, info.modinfo_len, "license");
1707 1708 1709 1710
	if (info.modinfo && !license && !is_vmlinux(modname))
		warn("modpost: missing MODULE_LICENSE() in %s\n"
		     "see include/linux/module.h for "
		     "more information\n", modname);
1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
	while (license) {
		if (license_is_gpl_compatible(license))
			mod->gpl_compatible = 1;
		else {
			mod->gpl_compatible = 0;
			break;
		}
		license = get_next_modinfo(info.modinfo, info.modinfo_len,
					   "license", license);
	}

L
Linus Torvalds 已提交
1722 1723 1724 1725 1726 1727
	for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
		symname = info.strtab + sym->st_name;

		handle_modversions(mod, &info, sym, symname);
		handle_moddevtable(mod, &info, sym, symname);
	}
1728
	if (!is_vmlinux(modname) ||
1729 1730
	     (is_vmlinux(modname) && vmlinux_section_warnings))
		check_sec_ref(mod, modname, &info);
L
Linus Torvalds 已提交
1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741

	version = get_modinfo(info.modinfo, info.modinfo_len, "version");
	if (version)
		maybe_frob_rcs_version(modname, version, info.modinfo,
				       version - (char *)info.hdr);
	if (version || (all_versions && !is_vmlinux(modname)))
		get_src_version(modname, mod->srcversion,
				sizeof(mod->srcversion)-1);

	parse_elf_finish(&info);

1742
	/* Our trick to get versioning for module struct etc. - it's
L
Linus Torvalds 已提交
1743 1744 1745 1746
	 * never passed as an argument to an exported function, so
	 * the automatic versioning doesn't pick it up, but it's really
	 * important anyhow */
	if (modversions)
1747
		mod->unres = alloc_symbol("module_layout", 0, mod->unres);
L
Linus Torvalds 已提交
1748 1749 1750 1751 1752 1753 1754 1755
}

#define SZ 500

/* We first write the generated file into memory using the
 * following helper, then compare to the file on disk and
 * only update the later if anything changed */

1756 1757
void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
						      const char *fmt, ...)
L
Linus Torvalds 已提交
1758 1759 1760 1761
{
	char tmp[SZ];
	int len;
	va_list ap;
1762

L
Linus Torvalds 已提交
1763 1764
	va_start(ap, fmt);
	len = vsnprintf(tmp, SZ, fmt, ap);
1765
	buf_write(buf, tmp, len);
L
Linus Torvalds 已提交
1766 1767 1768
	va_end(ap);
}

1769
void buf_write(struct buffer *buf, const char *s, int len)
L
Linus Torvalds 已提交
1770 1771
{
	if (buf->size - buf->pos < len) {
1772
		buf->size += len + SZ;
L
Linus Torvalds 已提交
1773 1774 1775 1776 1777 1778
		buf->p = realloc(buf->p, buf->size);
	}
	strncpy(buf->p + buf->pos, s, len);
	buf->pos += len;
}

1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
static void check_for_gpl_usage(enum export exp, const char *m, const char *s)
{
	const char *e = is_vmlinux(m) ?"":".ko";

	switch (exp) {
	case export_gpl:
		fatal("modpost: GPL-incompatible module %s%s "
		      "uses GPL-only symbol '%s'\n", m, e, s);
		break;
	case export_unused_gpl:
		fatal("modpost: GPL-incompatible module %s%s "
		      "uses GPL-only symbol marked UNUSED '%s'\n", m, e, s);
		break;
	case export_gpl_future:
		warn("modpost: GPL-incompatible module %s%s "
		      "uses future GPL-only symbol '%s'\n", m, e, s);
		break;
	case export_plain:
	case export_unused:
	case export_unknown:
		/* ignore */
		break;
	}
}

S
Sam Ravnborg 已提交
1804
static void check_for_unused(enum export exp, const char *m, const char *s)
1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820
{
	const char *e = is_vmlinux(m) ?"":".ko";

	switch (exp) {
	case export_unused:
	case export_unused_gpl:
		warn("modpost: module %s%s "
		      "uses symbol '%s' marked UNUSED\n", m, e, s);
		break;
	default:
		/* ignore */
		break;
	}
}

static void check_exports(struct module *mod)
1821 1822 1823 1824
{
	struct symbol *s, *exp;

	for (s = mod->unres; s; s = s->next) {
A
Andrew Morton 已提交
1825
		const char *basename;
1826 1827 1828
		exp = find_symbol(s->name);
		if (!exp || exp->module == mod)
			continue;
A
Andrew Morton 已提交
1829
		basename = strrchr(mod->name, '/');
1830 1831
		if (basename)
			basename++;
1832 1833 1834 1835 1836
		else
			basename = mod->name;
		if (!mod->gpl_compatible)
			check_for_gpl_usage(exp->export, basename, exp->name);
		check_for_unused(exp->export, basename, exp->name);
S
Sam Ravnborg 已提交
1837
	}
1838 1839
}

1840 1841 1842 1843
/**
 * Header for the generated file
 **/
static void add_header(struct buffer *b, struct module *mod)
L
Linus Torvalds 已提交
1844 1845 1846 1847 1848 1849 1850 1851 1852
{
	buf_printf(b, "#include <linux/module.h>\n");
	buf_printf(b, "#include <linux/vermagic.h>\n");
	buf_printf(b, "#include <linux/compiler.h>\n");
	buf_printf(b, "\n");
	buf_printf(b, "MODULE_INFO(vermagic, VERMAGIC_STRING);\n");
	buf_printf(b, "\n");
	buf_printf(b, "struct module __this_module\n");
	buf_printf(b, "__attribute__((section(\".gnu.linkonce.this_module\"))) = {\n");
1853
	buf_printf(b, " .name = KBUILD_MODNAME,\n");
L
Linus Torvalds 已提交
1854 1855 1856 1857 1858 1859
	if (mod->has_init)
		buf_printf(b, " .init = init_module,\n");
	if (mod->has_cleanup)
		buf_printf(b, "#ifdef CONFIG_MODULE_UNLOAD\n"
			      " .exit = cleanup_module,\n"
			      "#endif\n");
1860
	buf_printf(b, " .arch = MODULE_ARCH_INIT,\n");
L
Linus Torvalds 已提交
1861 1862 1863
	buf_printf(b, "};\n");
}

1864 1865 1866 1867 1868 1869
static void add_intree_flag(struct buffer *b, int is_intree)
{
	if (is_intree)
		buf_printf(b, "\nMODULE_INFO(intree, \"Y\");\n");
}

1870
static void add_staging_flag(struct buffer *b, const char *name)
1871 1872 1873 1874 1875 1876 1877
{
	static const char *staging_dir = "drivers/staging";

	if (strncmp(staging_dir, name, strlen(staging_dir)) == 0)
		buf_printf(b, "\nMODULE_INFO(staging, \"Y\");\n");
}

1878 1879 1880
/**
 * Record CRCs for unresolved symbols
 **/
1881
static int add_versions(struct buffer *b, struct module *mod)
L
Linus Torvalds 已提交
1882 1883
{
	struct symbol *s, *exp;
1884
	int err = 0;
L
Linus Torvalds 已提交
1885 1886 1887 1888

	for (s = mod->unres; s; s = s->next) {
		exp = find_symbol(s->name);
		if (!exp || exp->module == mod) {
1889
			if (have_vmlinux && !s->weak) {
1890 1891 1892 1893 1894 1895 1896 1897
				if (warn_unresolved) {
					warn("\"%s\" [%s.ko] undefined!\n",
					     s->name, mod->name);
				} else {
					merror("\"%s\" [%s.ko] undefined!\n",
					          s->name, mod->name);
					err = 1;
				}
1898
			}
L
Linus Torvalds 已提交
1899 1900 1901 1902 1903 1904 1905 1906
			continue;
		}
		s->module = exp->module;
		s->crc_valid = exp->crc_valid;
		s->crc = exp->crc;
	}

	if (!modversions)
1907
		return err;
L
Linus Torvalds 已提交
1908 1909 1910

	buf_printf(b, "\n");
	buf_printf(b, "static const struct modversion_info ____versions[]\n");
A
Adrian Bunk 已提交
1911
	buf_printf(b, "__used\n");
L
Linus Torvalds 已提交
1912 1913 1914
	buf_printf(b, "__attribute__((section(\"__versions\"))) = {\n");

	for (s = mod->unres; s; s = s->next) {
S
Sam Ravnborg 已提交
1915
		if (!s->module)
L
Linus Torvalds 已提交
1916 1917
			continue;
		if (!s->crc_valid) {
1918
			warn("\"%s\" [%s.ko] has no CRC!\n",
L
Linus Torvalds 已提交
1919 1920 1921 1922 1923 1924 1925
				s->name, mod->name);
			continue;
		}
		buf_printf(b, "\t{ %#8x, \"%s\" },\n", s->crc, s->name);
	}

	buf_printf(b, "};\n");
1926 1927

	return err;
L
Linus Torvalds 已提交
1928 1929
}

1930 1931
static void add_depends(struct buffer *b, struct module *mod,
			struct module *modules)
L
Linus Torvalds 已提交
1932 1933 1934 1935 1936
{
	struct symbol *s;
	struct module *m;
	int first = 1;

S
Sam Ravnborg 已提交
1937
	for (m = modules; m; m = m->next)
L
Linus Torvalds 已提交
1938 1939 1940 1941
		m->seen = is_vmlinux(m->name);

	buf_printf(b, "\n");
	buf_printf(b, "static const char __module_depends[]\n");
A
Adrian Bunk 已提交
1942
	buf_printf(b, "__used\n");
L
Linus Torvalds 已提交
1943 1944 1945
	buf_printf(b, "__attribute__((section(\".modinfo\"))) =\n");
	buf_printf(b, "\"depends=");
	for (s = mod->unres; s; s = s->next) {
1946
		const char *p;
L
Linus Torvalds 已提交
1947 1948 1949 1950 1951 1952 1953
		if (!s->module)
			continue;

		if (s->module->seen)
			continue;

		s->module->seen = 1;
S
Sam Ravnborg 已提交
1954 1955
		p = strrchr(s->module->name, '/');
		if (p)
1956 1957 1958 1959
			p++;
		else
			p = s->module->name;
		buf_printf(b, "%s%s", first ? "" : ",", p);
L
Linus Torvalds 已提交
1960 1961 1962 1963 1964
		first = 0;
	}
	buf_printf(b, "\";\n");
}

1965
static void add_srcversion(struct buffer *b, struct module *mod)
L
Linus Torvalds 已提交
1966 1967 1968 1969 1970 1971 1972 1973
{
	if (mod->srcversion[0]) {
		buf_printf(b, "\n");
		buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
			   mod->srcversion);
	}
}

1974
static void write_if_changed(struct buffer *b, const char *fname)
L
Linus Torvalds 已提交
1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017
{
	char *tmp;
	FILE *file;
	struct stat st;

	file = fopen(fname, "r");
	if (!file)
		goto write;

	if (fstat(fileno(file), &st) < 0)
		goto close_write;

	if (st.st_size != b->pos)
		goto close_write;

	tmp = NOFAIL(malloc(b->pos));
	if (fread(tmp, 1, b->pos, file) != b->pos)
		goto free_write;

	if (memcmp(tmp, b->p, b->pos) != 0)
		goto free_write;

	free(tmp);
	fclose(file);
	return;

 free_write:
	free(tmp);
 close_write:
	fclose(file);
 write:
	file = fopen(fname, "w");
	if (!file) {
		perror(fname);
		exit(1);
	}
	if (fwrite(b->p, 1, b->pos, file) != b->pos) {
		perror(fname);
		exit(1);
	}
	fclose(file);
}

2018
/* parse Module.symvers file. line format:
S
Sam Ravnborg 已提交
2019
 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
2020
 **/
2021
static void read_dump(const char *fname, unsigned int kernel)
L
Linus Torvalds 已提交
2022 2023 2024 2025 2026
{
	unsigned long size, pos = 0;
	void *file = grab_file(fname, &size);
	char *line;

S
Sam Ravnborg 已提交
2027
	if (!file)
L
Linus Torvalds 已提交
2028 2029 2030 2031
		/* No symbol versions, silently ignore */
		return;

	while ((line = get_next_line(&pos, file, size))) {
S
Sam Ravnborg 已提交
2032
		char *symname, *modname, *d, *export, *end;
L
Linus Torvalds 已提交
2033 2034
		unsigned int crc;
		struct module *mod;
2035
		struct symbol *s;
L
Linus Torvalds 已提交
2036 2037 2038 2039 2040 2041 2042

		if (!(symname = strchr(line, '\t')))
			goto fail;
		*symname++ = '\0';
		if (!(modname = strchr(symname, '\t')))
			goto fail;
		*modname++ = '\0';
2043
		if ((export = strchr(modname, '\t')) != NULL)
2044
			*export++ = '\0';
S
Sam Ravnborg 已提交
2045 2046
		if (export && ((end = strchr(export, '\t')) != NULL))
			*end = '\0';
L
Linus Torvalds 已提交
2047 2048 2049
		crc = strtoul(line, &d, 16);
		if (*symname == '\0' || *modname == '\0' || *d != '\0')
			goto fail;
S
Sam Ravnborg 已提交
2050 2051 2052
		mod = find_module(modname);
		if (!mod) {
			if (is_vmlinux(modname))
L
Linus Torvalds 已提交
2053
				have_vmlinux = 1;
2054
			mod = new_module(modname);
L
Linus Torvalds 已提交
2055 2056
			mod->skip = 1;
		}
2057
		s = sym_add_exported(symname, mod, export_no(export));
2058 2059
		s->kernel    = kernel;
		s->preloaded = 1;
2060
		sym_update_crc(symname, mod, crc, export_no(export));
L
Linus Torvalds 已提交
2061 2062 2063 2064 2065 2066
	}
	return;
fail:
	fatal("parse error in symbol dump file\n");
}

2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078
/* For normal builds always dump all symbols.
 * For external modules only dump symbols
 * that are not read from kernel Module.symvers.
 **/
static int dump_sym(struct symbol *sym)
{
	if (!external_module)
		return 1;
	if (sym->vmlinux || sym->kernel)
		return 0;
	return 1;
}
2079

2080
static void write_dump(const char *fname)
L
Linus Torvalds 已提交
2081 2082 2083 2084 2085 2086 2087 2088
{
	struct buffer buf = { };
	struct symbol *symbol;
	int n;

	for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
		symbol = symbolhash[n];
		while (symbol) {
2089
			if (dump_sym(symbol))
2090
				buf_printf(&buf, "0x%08x\t%s\t%s\t%s\n",
2091
					symbol->crc, symbol->name,
2092 2093
					symbol->module->name,
					export_str(symbol->export));
L
Linus Torvalds 已提交
2094 2095 2096 2097 2098 2099
			symbol = symbol->next;
		}
	}
	write_if_changed(&buf, fname);
}

2100 2101 2102 2103 2104
struct ext_sym_list {
	struct ext_sym_list *next;
	const char *file;
};

2105
int main(int argc, char **argv)
L
Linus Torvalds 已提交
2106 2107 2108
{
	struct module *mod;
	struct buffer buf = { };
2109 2110
	char *kernel_read = NULL, *module_read = NULL;
	char *dump_write = NULL;
L
Linus Torvalds 已提交
2111
	int opt;
2112
	int err;
2113 2114
	struct ext_sym_list *extsym_iter;
	struct ext_sym_list *extsym_start = NULL;
L
Linus Torvalds 已提交
2115

2116
	while ((opt = getopt(argc, argv, "i:I:e:cmsSo:awM:K:")) != -1) {
S
Sam Ravnborg 已提交
2117 2118 2119 2120 2121 2122 2123 2124
		switch (opt) {
		case 'i':
			kernel_read = optarg;
			break;
		case 'I':
			module_read = optarg;
			external_module = 1;
			break;
2125 2126 2127
		case 'c':
			cross_build = 1;
			break;
2128 2129 2130 2131 2132 2133 2134 2135
		case 'e':
			external_module = 1;
			extsym_iter =
			   NOFAIL(malloc(sizeof(*extsym_iter)));
			extsym_iter->next = extsym_start;
			extsym_iter->file = optarg;
			extsym_start = extsym_iter;
			break;
S
Sam Ravnborg 已提交
2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
		case 'm':
			modversions = 1;
			break;
		case 'o':
			dump_write = optarg;
			break;
		case 'a':
			all_versions = 1;
			break;
		case 's':
			vmlinux_section_warnings = 0;
			break;
2148 2149 2150
		case 'S':
			sec_mismatch_verbose = 0;
			break;
S
Sam Ravnborg 已提交
2151 2152 2153 2154 2155
		case 'w':
			warn_unresolved = 1;
			break;
		default:
			exit(1);
L
Linus Torvalds 已提交
2156 2157 2158
		}
	}

2159 2160 2161 2162
	if (kernel_read)
		read_dump(kernel_read, 1);
	if (module_read)
		read_dump(module_read, 0);
2163 2164 2165 2166 2167 2168
	while (extsym_start) {
		read_dump(extsym_start->file, 0);
		extsym_iter = extsym_start->next;
		free(extsym_start);
		extsym_start = extsym_iter;
	}
L
Linus Torvalds 已提交
2169

S
Sam Ravnborg 已提交
2170
	while (optind < argc)
L
Linus Torvalds 已提交
2171 2172
		read_symbols(argv[optind++]);

2173 2174 2175
	for (mod = modules; mod; mod = mod->next) {
		if (mod->skip)
			continue;
2176
		check_exports(mod);
2177 2178
	}

2179 2180
	err = 0;

L
Linus Torvalds 已提交
2181
	for (mod = modules; mod; mod = mod->next) {
2182 2183
		char fname[strlen(mod->name) + 10];

L
Linus Torvalds 已提交
2184 2185 2186 2187 2188 2189
		if (mod->skip)
			continue;

		buf.pos = 0;

		add_header(&buf, mod);
2190
		add_intree_flag(&buf, !external_module);
2191
		add_staging_flag(&buf, mod->name);
2192
		err |= add_versions(&buf, mod);
L
Linus Torvalds 已提交
2193 2194 2195 2196 2197 2198 2199 2200 2201 2202
		add_depends(&buf, mod, modules);
		add_moddevtable(&buf, mod);
		add_srcversion(&buf, mod);

		sprintf(fname, "%s.mod.c", mod->name);
		write_if_changed(&buf, fname);
	}

	if (dump_write)
		write_dump(dump_write);
2203
	if (sec_mismatch_count && !sec_mismatch_verbose)
2204 2205 2206 2207
		warn("modpost: Found %d section mismatch(es).\n"
		     "To see full details build your kernel with:\n"
		     "'make CONFIG_DEBUG_SECTION_MISMATCH=y'\n",
		     sec_mismatch_count);
L
Linus Torvalds 已提交
2208

2209
	return err;
L
Linus Torvalds 已提交
2210
}