modpost.c 44.5 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 14 15
 * 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 ...
 */

#include <ctype.h>
#include "modpost.h"
16
#include "../../include/linux/license.h"
L
Linus Torvalds 已提交
17 18 19 20 21 22 23

/* 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;
24 25
/* If we are modposting external module set to 1 */
static int external_module = 0;
26 27
/* Warn about section mismatch in vmlinux if set to 1 */
static int vmlinux_section_warnings = 1;
28 29
/* Only warn about unresolved symbols */
static int warn_unresolved = 0;
30
/* How a symbol is exported */
31 32 33 34
enum export {
	export_plain,      export_unused,     export_gpl,
	export_unused_gpl, export_gpl_future, export_unknown
};
L
Linus Torvalds 已提交
35

36 37 38
#define PRINTF __attribute__ ((format (printf, 1, 2)))

PRINTF void fatal(const char *fmt, ...)
L
Linus Torvalds 已提交
39 40 41 42 43 44 45 46 47 48 49 50
{
	va_list arglist;

	fprintf(stderr, "FATAL: ");

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

	exit(1);
}

51
PRINTF void warn(const char *fmt, ...)
L
Linus Torvalds 已提交
52 53 54 55 56 57 58 59 60 61
{
	va_list arglist;

	fprintf(stderr, "WARNING: ");

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

62
PRINTF void merror(const char *fmt, ...)
63 64 65 66 67 68 69 70 71 72
{
	va_list arglist;

	fprintf(stderr, "ERROR: ");

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

73 74 75 76
static int is_vmlinux(const char *modname)
{
	const char *myname;

S
Sam Ravnborg 已提交
77 78
	myname = strrchr(modname, '/');
	if (myname)
79 80 81 82
		myname++;
	else
		myname = modname;

83 84
	return (strcmp(myname, "vmlinux") == 0) ||
	       (strcmp(myname, "vmlinux.o") == 0);
85 86
}

L
Linus Torvalds 已提交
87 88
void *do_nofail(void *ptr, const char *expr)
{
S
Sam Ravnborg 已提交
89
	if (!ptr)
L
Linus Torvalds 已提交
90
		fatal("modpost: Memory allocation failure: %s.\n", expr);
S
Sam Ravnborg 已提交
91

L
Linus Torvalds 已提交
92 93 94 95 96 97
	return ptr;
}

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

98
static struct module *find_module(char *modname)
L
Linus Torvalds 已提交
99 100 101 102 103 104 105 106 107
{
	struct module *mod;

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

108
static struct module *new_module(char *modname)
L
Linus Torvalds 已提交
109 110 111
{
	struct module *mod;
	char *p, *s;
112

L
Linus Torvalds 已提交
113 114 115 116 117
	mod = NOFAIL(malloc(sizeof(*mod)));
	memset(mod, 0, sizeof(*mod));
	p = NOFAIL(strdup(modname));

	/* strip trailing .o */
S
Sam Ravnborg 已提交
118 119
	s = strrchr(p, '.');
	if (s != NULL)
L
Linus Torvalds 已提交
120 121 122 123 124
		if (strcmp(s, ".o") == 0)
			*s = '\0';

	/* add to list */
	mod->name = p;
125
	mod->gpl_compatible = -1;
L
Linus Torvalds 已提交
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
	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;
143 144 145
	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) **/
146
	unsigned int preloaded:1;  /* 1 if symbol from Module.symvers */
147
	enum export  export;       /* Type of export */
L
Linus Torvalds 已提交
148 149 150 151 152 153 154 155 156 157 158 159
	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 已提交
160
	for (value = 0x238F13AF * strlen(name), i = 0; name[i]; i++)
L
Linus Torvalds 已提交
161 162 163 164 165
		value = (value + (((unsigned char *)name)[i] << (i*5 % 24)));

	return (1103515243 * value + 12345);
}

166 167 168 169 170 171
/**
 * 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 已提交
172 173 174 175 176 177 178 179 180 181 182
{
	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 */
183 184
static struct symbol *new_symbol(const char *name, struct module *module,
				 enum export export)
L
Linus Torvalds 已提交
185 186 187 188 189 190 191
{
	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;
192
	new->export = export;
193
	return new;
L
Linus Torvalds 已提交
194 195
}

196
static struct symbol *find_symbol(const char *name)
L
Linus Torvalds 已提交
197 198 199 200 201 202 203
{
	struct symbol *s;

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

S
Sam Ravnborg 已提交
204
	for (s = symbolhash[tdb_hash(name) % SYMBOL_HASH_SIZE]; s; s = s->next) {
L
Linus Torvalds 已提交
205 206 207 208 209 210
		if (strcmp(s->name, name) == 0)
			return s;
	}
	return NULL;
}

211 212 213 214 215
static struct {
	const char *str;
	enum export export;
} export_list[] = {
	{ .str = "EXPORT_SYMBOL",            .export = export_plain },
216
	{ .str = "EXPORT_UNUSED_SYMBOL",     .export = export_unused },
217
	{ .str = "EXPORT_SYMBOL_GPL",        .export = export_gpl },
218
	{ .str = "EXPORT_UNUSED_SYMBOL_GPL", .export = export_unused_gpl },
219 220 221 222 223 224 225 226 227 228
	{ .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 已提交
229
static enum export export_no(const char *s)
230 231
{
	int i;
S
Sam Ravnborg 已提交
232

S
Sam Ravnborg 已提交
233 234
	if (!s)
		return export_unknown;
235 236 237 238 239 240 241 242 243 244 245
	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;
}

static enum export export_from_sec(struct elf_info *elf, Elf_Section sec)
{
	if (sec == elf->export_sec)
		return export_plain;
246 247
	else if (sec == elf->export_unused_sec)
		return export_unused;
248 249
	else if (sec == elf->export_gpl_sec)
		return export_gpl;
250 251
	else if (sec == elf->export_unused_gpl_sec)
		return export_unused_gpl;
252 253 254 255 256 257
	else if (sec == elf->export_gpl_future_sec)
		return export_gpl_future;
	else
		return export_unknown;
}

258 259 260 261
/**
 * Add an exported symbol - it may have already been added without a
 * CRC, in this case just update the CRC
 **/
262 263
static struct symbol *sym_add_exported(const char *name, struct module *mod,
				       enum export export)
L
Linus Torvalds 已提交
264 265 266 267
{
	struct symbol *s = find_symbol(name);

	if (!s) {
268
		s = new_symbol(name, mod, export);
269 270
	} else {
		if (!s->preloaded) {
271
			warn("%s: '%s' exported twice. Previous export "
272 273 274
			     "was in %s%s\n", mod->name, name,
			     s->module->name,
			     is_vmlinux(s->module->name) ?"":".ko");
275 276 277
		} else {
			/* In case Modules.symvers was out of date */
			s->module = mod;
278
		}
L
Linus Torvalds 已提交
279
	}
280
	s->preloaded = 0;
281 282
	s->vmlinux   = is_vmlinux(mod->name);
	s->kernel    = 0;
283
	s->export    = export;
284 285 286 287
	return s;
}

static void sym_update_crc(const char *name, struct module *mod,
288
			   unsigned int crc, enum export export)
289 290 291 292
{
	struct symbol *s = find_symbol(name);

	if (!s)
293
		s = new_symbol(name, mod, export);
294 295
	s->crc = crc;
	s->crc_valid = 1;
L
Linus Torvalds 已提交
296 297
}

298
void *grab_file(const char *filename, unsigned long *size)
L
Linus Torvalds 已提交
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
{
	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;
}

317 318 319 320 321
/**
  * 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 已提交
322
char *get_next_line(unsigned long *pos, void *file, unsigned long size)
L
Linus Torvalds 已提交
323 324 325 326 327 328 329
{
	static char line[4096];
	int skip = 1;
	size_t len = 0;
	signed char *p = (signed char *)file + *pos;
	char *s = line;

S
Sam Ravnborg 已提交
330
	for (; *pos < size ; (*pos)++) {
L
Linus Torvalds 已提交
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
		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;
}

351
void release_file(void *file, unsigned long size)
L
Linus Torvalds 已提交
352 353 354 355
{
	munmap(file, size);
}

356
static int parse_elf(struct elf_info *info, const char *filename)
L
Linus Torvalds 已提交
357 358
{
	unsigned int i;
359
	Elf_Ehdr *hdr;
L
Linus Torvalds 已提交
360 361 362 363 364 365
	Elf_Shdr *sechdrs;
	Elf_Sym  *sym;

	hdr = grab_file(filename, &info->size);
	if (!hdr) {
		perror(filename);
366
		exit(1);
L
Linus Torvalds 已提交
367 368
	}
	info->hdr = hdr;
369 370 371 372 373 374 375 376 377 378 379 380
	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 已提交
381 382 383 384 385
	/* Fix endianness in ELF header */
	hdr->e_shoff    = TO_NATIVE(hdr->e_shoff);
	hdr->e_shstrndx = TO_NATIVE(hdr->e_shstrndx);
	hdr->e_shnum    = TO_NATIVE(hdr->e_shnum);
	hdr->e_machine  = TO_NATIVE(hdr->e_machine);
386
	hdr->e_type     = TO_NATIVE(hdr->e_type);
L
Linus Torvalds 已提交
387 388 389
	sechdrs = (void *)hdr + hdr->e_shoff;
	info->sechdrs = sechdrs;

P
Petr Stetiar 已提交
390 391
	/* Check if file offset is correct */
	if (hdr->e_shoff > info->size) {
S
Sam Ravnborg 已提交
392 393 394
		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 已提交
395 396 397
		return 0;
	}

L
Linus Torvalds 已提交
398 399 400 401 402 403 404
	/* Fix endianness in section headers */
	for (i = 0; i < hdr->e_shnum; i++) {
		sechdrs[i].sh_type   = TO_NATIVE(sechdrs[i].sh_type);
		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_name   = TO_NATIVE(sechdrs[i].sh_name);
405 406
		sechdrs[i].sh_info   = TO_NATIVE(sechdrs[i].sh_info);
		sechdrs[i].sh_addr   = TO_NATIVE(sechdrs[i].sh_addr);
L
Linus Torvalds 已提交
407 408 409 410 411
	}
	/* Find symbol table. */
	for (i = 1; i < hdr->e_shnum; i++) {
		const char *secstrings
			= (void *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
412
		const char *secname;
L
Linus Torvalds 已提交
413

414
		if (sechdrs[i].sh_offset > info->size) {
S
Sam Ravnborg 已提交
415 416 417 418
			fatal("%s is truncated. sechdrs[i].sh_offset=%lu > "
			      "sizeof(*hrd)=%zu\n", filename,
			      (unsigned long)sechdrs[i].sh_offset,
			      sizeof(*hdr));
419 420
			return 0;
		}
421 422
		secname = secstrings + sechdrs[i].sh_name;
		if (strcmp(secname, ".modinfo") == 0) {
L
Linus Torvalds 已提交
423 424
			info->modinfo = (void *)hdr + sechdrs[i].sh_offset;
			info->modinfo_len = sechdrs[i].sh_size;
425 426
		} else if (strcmp(secname, "__ksymtab") == 0)
			info->export_sec = i;
427 428
		else if (strcmp(secname, "__ksymtab_unused") == 0)
			info->export_unused_sec = i;
429 430
		else if (strcmp(secname, "__ksymtab_gpl") == 0)
			info->export_gpl_sec = i;
431 432
		else if (strcmp(secname, "__ksymtab_unused_gpl") == 0)
			info->export_unused_gpl_sec = i;
433 434 435
		else if (strcmp(secname, "__ksymtab_gpl_future") == 0)
			info->export_gpl_future_sec = i;

L
Linus Torvalds 已提交
436 437 438 439
		if (sechdrs[i].sh_type != SHT_SYMTAB)
			continue;

		info->symtab_start = (void *)hdr + sechdrs[i].sh_offset;
440
		info->symtab_stop  = (void *)hdr + sechdrs[i].sh_offset
L
Linus Torvalds 已提交
441
			                         + sechdrs[i].sh_size;
442
		info->strtab       = (void *)hdr +
L
Linus Torvalds 已提交
443 444
			             sechdrs[sechdrs[i].sh_link].sh_offset;
	}
S
Sam Ravnborg 已提交
445
	if (!info->symtab_start)
446
		fatal("%s has no symtab?\n", filename);
S
Sam Ravnborg 已提交
447

L
Linus Torvalds 已提交
448 449 450 451 452 453 454
	/* 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);
	}
455
	return 1;
L
Linus Torvalds 已提交
456 457
}

458
static void parse_elf_finish(struct elf_info *info)
L
Linus Torvalds 已提交
459 460 461 462
{
	release_file(info->hdr, info->size);
}

463 464
#define CRC_PFX     MODULE_SYMBOL_PREFIX "__crc_"
#define KSYMTAB_PFX MODULE_SYMBOL_PREFIX "__ksymtab_"
L
Linus Torvalds 已提交
465

466 467
static void handle_modversions(struct module *mod, struct elf_info *info,
			       Elf_Sym *sym, const char *symname)
L
Linus Torvalds 已提交
468 469
{
	unsigned int crc;
470
	enum export export = export_from_sec(info, sym->st_shndx);
L
Linus Torvalds 已提交
471 472 473

	switch (sym->st_shndx) {
	case SHN_COMMON:
474
		warn("\"%s\" [%s] is COMMON symbol\n", symname, mod->name);
L
Linus Torvalds 已提交
475 476 477 478 479
		break;
	case SHN_ABS:
		/* CRC'd symbol */
		if (memcmp(symname, CRC_PFX, strlen(CRC_PFX)) == 0) {
			crc = (unsigned int) sym->st_value;
480 481
			sym_update_crc(symname + strlen(CRC_PFX), mod, crc,
					export);
L
Linus Torvalds 已提交
482 483 484 485 486 487 488 489 490 491 492 493 494
		}
		break;
	case SHN_UNDEF:
		/* undefined symbol */
		if (ELF_ST_BIND(sym->st_info) != STB_GLOBAL &&
		    ELF_ST_BIND(sym->st_info) != STB_WEAK)
			break;
		/* ignore global offset table */
		if (strcmp(symname, "_GLOBAL_OFFSET_TABLE_") == 0)
			break;
		/* ignore __this_module, it will be resolved shortly */
		if (strcmp(symname, MODULE_SYMBOL_PREFIX "__this_module") == 0)
			break;
495 496 497 498 499 500
/* 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 已提交
501 502 503
		if (info->hdr->e_machine == EM_SPARC ||
		    info->hdr->e_machine == EM_SPARCV9) {
			/* Ignore register directives. */
504
			if (ELF_ST_TYPE(sym->st_info) == STT_SPARC_REGISTER)
L
Linus Torvalds 已提交
505
				break;
506 507 508 509 510 511
			if (symname[0] == '.') {
				char *munged = strdup(symname);
				munged[0] = '_';
				munged[1] = toupper(munged[1]);
				symname = munged;
			}
L
Linus Torvalds 已提交
512 513
		}
#endif
514

L
Linus Torvalds 已提交
515
		if (memcmp(symname, MODULE_SYMBOL_PREFIX,
S
Sam Ravnborg 已提交
516 517 518 519 520 521 522
			   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 已提交
523 524 525 526
		break;
	default:
		/* All exported symbols */
		if (memcmp(symname, KSYMTAB_PFX, strlen(KSYMTAB_PFX)) == 0) {
527 528
			sym_add_exported(symname + strlen(KSYMTAB_PFX), mod,
					export);
L
Linus Torvalds 已提交
529 530 531 532 533 534 535 536 537
		}
		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;
	}
}

538 539 540
/**
 * Parse tag=value strings from .modinfo section
 **/
L
Linus Torvalds 已提交
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
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;
}

559 560
static char *get_next_modinfo(void *modinfo, unsigned long modinfo_len,
			      const char *tag, char *info)
L
Linus Torvalds 已提交
561 562 563 564 565
{
	char *p;
	unsigned int taglen = strlen(tag);
	unsigned long size = modinfo_len;

566 567 568 569 570
	if (info) {
		size -= info - (char *)modinfo;
		modinfo = next_string(info, &size);
	}

L
Linus Torvalds 已提交
571 572 573 574 575 576 577
	for (p = modinfo; p; p = next_string(p, &size)) {
		if (strncmp(p, tag, taglen) == 0 && p[taglen] == '=')
			return p + taglen + 1;
	}
	return NULL;
}

578 579 580 581 582 583 584
static char *get_modinfo(void *modinfo, unsigned long modinfo_len,
			 const char *tag)

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

585 586 587 588 589 590
/**
 * Test if string s ends in string sub
 * return 0 if match
 **/
static int strrcmp(const char *s, const char *sub)
{
S
Sam Ravnborg 已提交
591
	int slen, sublen;
592

593 594
	if (!s || !sub)
		return 1;
595

596
	slen = strlen(s);
S
Sam Ravnborg 已提交
597
	sublen = strlen(sub);
598

599 600 601
	if ((slen == 0) || (sublen == 0))
		return 1;

S
Sam Ravnborg 已提交
602 603
	if (sublen > slen)
		return 1;
604

S
Sam Ravnborg 已提交
605
	return memcmp(s + slen - sublen, sub, sublen);
606 607
}

608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
/*
 * Functions used only during module init is marked __init and is stored in
 * a .init.text section. Likewise data is marked __initdata and stored in
 * a .init.data section.
 * If this section is one of these sections return 1
 * See include/linux/init.h for the details
 */
static int init_section(const char *name)
{
	if (strcmp(name, ".init") == 0)
		return 1;
	if (strncmp(name, ".init.", strlen(".init.")) == 0)
		return 1;
	return 0;
}

/*
 * Functions used only during module exit is marked __exit and is stored in
 * a .exit.text section. Likewise data is marked __exitdata and stored in
 * a .exit.data section.
 * If this section is one of these sections return 1
 * See include/linux/init.h for the details
 **/
static int exit_section(const char *name)
{
	if (strcmp(name, ".exit.text") == 0)
		return 1;
	if (strcmp(name, ".exit.data") == 0)
		return 1;
	return 0;

}

/*
 * Data sections are named like this:
 * .data | .data.rel | .data.rel.*
 * Return 1 if the specified section is a data section
 */
static int data_section(const char *name)
{
	if ((strcmp(name, ".data") == 0) ||
	    (strcmp(name, ".data.rel") == 0) ||
	    (strncmp(name, ".data.rel.", strlen(".data.rel.")) == 0))
		return 1;
	else
		return 0;
}

656 657
/**
 * Whitelist to allow certain references to pass with no warning.
658 659 660 661
 *
 * Pattern 0:
 *   Do not warn if funtion/data are marked with __init_refok/__initdata_refok.
 *   The pattern is identified by:
662
 *   fromsec = .text.init.refok* | .data.init.refok*
663
 *
664 665 666 667 668 669 670
 * 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
671
 *   fromsec = .data*
672
 *   atsym   =__param*
673
 *
674
 * Pattern 2:
675
 *   Many drivers utilise a *driver container with references to
676 677 678 679
 *   add, remove, probe functions etc.
 *   These functions may often be marked __init and we do not want to
 *   warn here.
 *   the pattern is identified by:
680 681
 *   tosec   = init or exit section
 *   fromsec = data section
S
Sam Ravnborg 已提交
682 683
 *   atsym = *driver, *_template, *_sht, *_ops, *_probe,
 *           *probe_one, *_console, *_timer
684 685
 *
 * Pattern 3:
686 687 688
 *   Whitelist all refereces from .text.head to .init.data
 *   Whitelist all refereces from .text.head to .init.text
 *
689
 * Pattern 4:
690 691 692 693 694 695 696
 *   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
697
 *
698 699 700 701 702 703
 * Pattern 5:
 *   Xtensa uses literal sections for constants that are accessed PC-relative.
 *   Literal sections may safely reference their text sections.
 *   (Note that the name for the literal section omits any trailing '.text')
 *   tosec = <section>[.text]
 *   fromsec = <section>.literal
704
 **/
705
static int secref_whitelist(const char *modname, const char *tosec,
706 707
			    const char *fromsec, const char *atsym,
			    const char *refsymname)
708
{
709
	int len;
710 711
	const char **s;
	const char *pat2sym[] = {
712
		"driver",
713
		"_template", /* scsi uses *_template a lot */
714
		"_timer",    /* arm uses ops structures named _timer a lot */
715
		"_sht",      /* scsi also used *_sht to some extent */
716 717 718
		"_ops",
		"_probe",
		"_probe_one",
719
		"_console",
720 721
		NULL
	};
722

723 724 725 726 727 728 729
	const char *pat3refsym[] = {
		"__init_begin",
		"_sinittext",
		"_einittext",
		NULL
	};

730
	/* Check for pattern 0 */
731
	if ((strncmp(fromsec, ".text.init.refok", strlen(".text.init.refok")) == 0) ||
732
	    (strncmp(fromsec, ".exit.text.refok", strlen(".exit.text.refok")) == 0) ||
733
	    (strncmp(fromsec, ".data.init.refok", strlen(".data.init.refok")) == 0))
734 735
		return 1;

736
	/* Check for pattern 1 */
737 738 739 740
	if ((strcmp(tosec, ".init.data") == 0) &&
	    (strncmp(fromsec, ".data", strlen(".data")) == 0) &&
	    (strncmp(atsym, "__param", strlen("__param")) == 0))
		return 1;
741 742

	/* Check for pattern 2 */
S
Sam Ravnborg 已提交
743 744
	if ((init_section(tosec) || exit_section(tosec))
	    && data_section(fromsec))
745 746 747
		for (s = pat2sym; *s; s++)
			if (strrcmp(atsym, *s) == 0)
				return 1;
748

749 750
	/* Check for pattern 3 */
	if ((strcmp(fromsec, ".text.head") == 0) &&
S
Sam Ravnborg 已提交
751 752
	    ((strcmp(tosec, ".init.data") == 0) ||
	    (strcmp(tosec, ".init.text") == 0)))
753 754
	return 1;

755
	/* Check for pattern 4 */
756 757 758 759
	for (s = pat3refsym; *s; s++)
		if (strcmp(refsymname, *s) == 0)
			return 1;

760 761 762 763 764 765 766 767 768
	/* Check for pattern 5 */
	if (strrcmp(tosec, ".text") == 0)
		len = strlen(tosec) - strlen(".text");
	else
		len = strlen(tosec);
	if ((strncmp(tosec, fromsec, len) == 0) && (strlen(fromsec) > len) &&
	    (strcmp(fromsec + len, ".literal") == 0))
		return 1;

769
	return 0;
770 771
}

772 773 774 775 776 777 778
/**
 * 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.
 *  **/
779
static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
780 781 782
				Elf_Sym *relsym)
{
	Elf_Sym *sym;
783 784 785
	Elf_Sym *near = NULL;
	Elf64_Sword distance = 20;
	Elf64_Sword d;
786 787 788 789 790 791

	if (relsym->st_name != 0)
		return relsym;
	for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
		if (sym->st_shndx != relsym->st_shndx)
			continue;
792 793
		if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
			continue;
794 795
		if (sym->st_value == addr)
			return sym;
796 797 798 799 800 801 802 803
		/* 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;
		}
804
	}
805 806 807 808 809
	/* We need a close match */
	if (distance < 20)
		return near;
	else
		return NULL;
810 811
}

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
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);
}

836
/*
837 838 839 840
 * 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.
841 842 843
 **/
static void find_symbols_between(struct elf_info *elf, Elf_Addr addr,
				 const char *sec,
S
Sam Ravnborg 已提交
844
				 Elf_Sym **before, Elf_Sym **after)
845 846 847 848 849 850 851
{
	Elf_Sym *sym;
	Elf_Ehdr *hdr = elf->hdr;
	Elf_Addr beforediff = ~0;
	Elf_Addr afterdiff = ~0;
	const char *secstrings = (void *)hdr +
				 elf->sechdrs[hdr->e_shstrndx].sh_offset;
852

853 854 855 856 857 858 859 860 861 862 863
	*before = NULL;
	*after = NULL;

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

		if (sym->st_shndx >= SHN_LORESERVE)
			continue;
		symsec = secstrings + elf->sechdrs[sym->st_shndx].sh_name;
		if (strcmp(symsec, sec) != 0)
			continue;
864 865
		if (!is_valid_name(elf, sym))
			continue;
866 867 868 869
		if (sym->st_value <= addr) {
			if ((addr - sym->st_value) < beforediff) {
				beforediff = addr - sym->st_value;
				*before = sym;
S
Sam Ravnborg 已提交
870
			} else if ((addr - sym->st_value) == beforediff) {
871
				*before = sym;
872
			}
S
Sam Ravnborg 已提交
873
		} else {
874 875 876
			if ((sym->st_value - addr) < afterdiff) {
				afterdiff = sym->st_value - addr;
				*after = sym;
S
Sam Ravnborg 已提交
877
			} else if ((sym->st_value - addr) == afterdiff)
878
				*after = sym;
879 880 881 882 883 884 885
		}
	}
}

/**
 * Print a warning about a section mismatch.
 * Try to find symbols near it so user can find it.
886
 * Check whitelist before warning - it may be a false positive.
887 888 889 890
 **/
static void warn_sec_mismatch(const char *modname, const char *fromsec,
			      struct elf_info *elf, Elf_Sym *sym, Elf_Rela r)
{
891 892 893
	const char *refsymname = "";
	Elf_Sym *before, *after;
	Elf_Sym *refsym;
894 895 896 897 898
	Elf_Ehdr *hdr = elf->hdr;
	Elf_Shdr *sechdrs = elf->sechdrs;
	const char *secstrings = (void *)hdr +
				 sechdrs[hdr->e_shstrndx].sh_offset;
	const char *secname = secstrings + sechdrs[sym->st_shndx].sh_name;
899

900 901
	find_symbols_between(elf, r.r_offset, fromsec, &before, &after);

902 903 904
	refsym = find_elf_symbol(elf, r.r_addend, sym);
	if (refsym && strlen(elf->strtab + refsym->st_name))
		refsymname = elf->strtab + refsym->st_name;
905 906

	/* check whitelist - we may ignore it */
907 908 909
	if (secref_whitelist(modname, secname, fromsec,
			     before ? elf->strtab + before->st_name : "",
	                     refsymname))
910
		return;
911

912
	if (before && after) {
913 914 915 916
		warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
		     "(between '%s' and '%s')\n",
		     modname, fromsec, (unsigned long long)r.r_offset,
		     secname, refsymname,
917 918 919
		     elf->strtab + before->st_name,
		     elf->strtab + after->st_name);
	} else if (before) {
920 921 922 923 924
		warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
		     "(after '%s')\n",
		     modname, fromsec, (unsigned long long)r.r_offset,
		     secname, refsymname,
		     elf->strtab + before->st_name);
925
	} else if (after) {
926
		warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
927
		     "before '%s' (at offset -0x%llx)\n",
928 929
		     modname, fromsec, (unsigned long long)r.r_offset,
		     secname, refsymname,
930 931
		     elf->strtab + after->st_name,
		     (unsigned long long)r.r_offset);
932
	} else {
933 934 935
		warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s\n",
		     modname, fromsec, (unsigned long long)r.r_offset,
		     secname, refsymname);
936 937 938
	}
}

939
static unsigned int *reloc_location(struct elf_info *elf,
940
				    Elf_Shdr *sechdr, Elf_Rela *r)
941 942
{
	Elf_Shdr *sechdrs = elf->sechdrs;
943
	int section = sechdr->sh_info;
944 945 946 947 948

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

949
static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
950 951
{
	unsigned int r_typ = ELF_R_TYPE(r->r_info);
952
	unsigned int *location = reloc_location(elf, sechdr, r);
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967

	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;
}

968
static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
969 970 971 972 973 974
{
	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 已提交
975 976
		r->r_addend = (int)(long)
		              (elf->symtab_start + ELF_R_SYM(r->r_info));
977 978 979
		break;
	case R_ARM_PC24:
		/* From ARM ABI: ((S + A) | T) - P */
S
Sam Ravnborg 已提交
980
		r->r_addend = (int)(long)(elf->hdr +
981 982
		              sechdr->sh_offset +
		              (r->r_offset - sechdr->sh_addr));
983 984 985 986 987 988 989
		break;
	default:
		return 1;
	}
	return 0;
}

990
static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
991 992
{
	unsigned int r_typ = ELF_R_TYPE(r->r_info);
993
	unsigned int *location = reloc_location(elf, sechdr, r);
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
	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;
}

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
static void section_rela(const char *modname, struct elf_info *elf,
                         Elf_Shdr *sechdr, int section(const char *),
                         int section_ref_ok(const char *))
{
	Elf_Sym  *sym;
	Elf_Rela *rela;
	Elf_Rela r;
	unsigned int r_sym;
	const char *fromsec;
	const char * tosec;

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

	const char *secstrings = (void *)hdr +
				 elf->sechdrs[hdr->e_shstrndx].sh_offset;

	fromsec = secstrings + sechdr->sh_name;
	fromsec += strlen(".rela");
	/* if from section (name) is know good then skip it */
	if (section_ref_ok(fromsec))
		return;

	for (rela = start; rela < stop; rela++) {
		r.r_offset = TO_NATIVE(rela->r_offset);
#if KERNEL_ELFCLASS == ELFCLASS64
		if (hdr->e_machine == EM_MIPS) {
			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 */
		if (sym->st_shndx >= SHN_LORESERVE)
			continue;

		tosec = secstrings +
			elf->sechdrs[sym->st_shndx].sh_name;
		if (section(tosec))
			warn_sec_mismatch(modname, fromsec, elf, sym, r);
	}
}

static void section_rel(const char *modname, struct elf_info *elf,
                        Elf_Shdr *sechdr, int section(const char *),
                        int section_ref_ok(const char *))
{
	Elf_Sym *sym;
	Elf_Rel *rel;
	Elf_Rela r;
	unsigned int r_sym;
	const char *fromsec;
	const char * tosec;

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

	const char *secstrings = (void *)hdr +
				 elf->sechdrs[hdr->e_shstrndx].sh_offset;

	fromsec = secstrings + sechdr->sh_name;
	fromsec += strlen(".rel");
	/* if from section (name) is know good then skip it */
	if (section_ref_ok(fromsec))
		return;

	for (rel = start; rel < stop; rel++) {
		r.r_offset = TO_NATIVE(rel->r_offset);
#if KERNEL_ELFCLASS == ELFCLASS64
		if (hdr->e_machine == EM_MIPS) {
			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;
		switch (hdr->e_machine) {
		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 */
		if (sym->st_shndx >= SHN_LORESERVE)
			continue;

		tosec = secstrings +
			elf->sechdrs[sym->st_shndx].sh_name;
		if (section(tosec))
			warn_sec_mismatch(modname, fromsec, elf, sym, r);
	}
}

1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
/**
 * 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
 * marked __initdata will be discarded when the module has been intialized.
 * Likewise for modules used built-in the sections marked __exit
 * are discarded because __exit marked function are supposed to be called
 * only when a moduel is unloaded which never happes for built-in modules.
 * 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,
			  struct elf_info *elf,
S
Sam Ravnborg 已提交
1149
			  int section(const char *),
1150 1151 1152 1153 1154
			  int section_ref_ok(const char *))
{
	int i;
	Elf_Ehdr *hdr = elf->hdr;
	Elf_Shdr *sechdrs = elf->sechdrs;
1155

1156 1157 1158
	/* Walk through all sections */
	for (i = 0; i < hdr->e_shnum; i++) {
		/* We want to process only relocation sections and not .init */
1159 1160 1161 1162 1163 1164
		if (sechdrs[i].sh_type == SHT_RELA)
			section_rela(modname, elf, &elf->sechdrs[i],
			             section, section_ref_ok);
		else if (sechdrs[i].sh_type == SHT_REL)
			section_rel(modname, elf, &elf->sechdrs[i],
			            section, section_ref_ok);
1165 1166 1167
	}
}

1168 1169 1170 1171 1172 1173 1174 1175 1176
/*
 * Identify sections from which references to either a
 * .init or a .exit section is OK.
 *
 * [OPD] Keith Ownes <kaos@sgi.com> commented:
 * For our future {in}sanity, add a comment that this is the ppc .opd
 * section, not the ia64 .opd section.
 * ia64 .opd should not point to discarded sections.
 * [.rodata] like for .init.text we ignore .rodata references -same reason
1177
 */
1178 1179 1180 1181 1182
static int initexit_section_ref_ok(const char *name)
{
	const char **s;
	/* Absolute section names */
	const char *namelist1[] = {
S
Sam Ravnborg 已提交
1183
		"__bug_table",	/* used by powerpc for BUG() */
1184 1185
		"__ex_table",
		".altinstructions",
S
Sam Ravnborg 已提交
1186
		".cranges",	/* used by sh64 */
1187
		".fixup",
S
Sam Ravnborg 已提交
1188
		".machvec",	/* ia64 + powerpc uses these */
1189
		".machine.desc",
S
Sam Ravnborg 已提交
1190
		".opd",		/* See comment [OPD] */
1191
		"__dbe_table",
1192 1193
		".parainstructions",
		".pdr",
S
Sam Ravnborg 已提交
1194
		".plt",		/* seen on ARCH=um build on x86_64. Harmless */
1195 1196
		".smp_locks",
		".stab",
A
Al Viro 已提交
1197
		".m68k_fixup",
S
Sam Ravnborg 已提交
1198 1199
		".xt.prop",	/* xtensa informational section */
		".xt.lit",	/* xtensa informational section */
1200 1201 1202 1203 1204 1205
		NULL
	};
	/* Start of section names */
	const char *namelist2[] = {
		".debug",
		".eh_frame",
S
Sam Ravnborg 已提交
1206 1207 1208
		".note",	/* ignore ELF notes - may contain anything */
		".got",		/* powerpc - global offset table */
		".toc",		/* powerpc - table of contents */
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
		NULL
	};
	/* part of section name */
	const char *namelist3 [] = {
		".unwind",  /* Sample: IA_64.unwind.exit.text */
		NULL
	};

	for (s = namelist1; *s; s++)
		if (strcmp(*s, name) == 0)
			return 1;
	for (s = namelist2; *s; s++)
		if (strncmp(*s, name, strlen(*s)) == 0)
			return 1;
	for (s = namelist3; *s; s++)
		if (strstr(name, *s) != NULL)
			return 1;
	return 0;
}

1229

1230
/*
1231
 * Identify sections from which references to a .init section is OK.
1232
 *
1233 1234 1235 1236 1237
 * Unfortunately references to read only data that referenced .init
 * sections had to be excluded. Almost all of these are false
 * positives, they are created by gcc. The downside of excluding rodata
 * is that there really are some user references from rodata to
 * init code, e.g. drivers/video/vgacon.c:
1238
 *
1239 1240 1241 1242 1243
 * const struct consw vga_con = {
 *        con_startup:            vgacon_startup,
 *
 * where vgacon_startup is __init.  If you want to wade through the false
 * positives, take out the check for rodata.
1244
 */
1245 1246 1247 1248 1249
static int init_section_ref_ok(const char *name)
{
	const char **s;
	/* Absolute section names */
	const char *namelist1[] = {
1250
		"__dbe_table",		/* MIPS generate these */
1251 1252
		"__ftr_fixup",		/* powerpc cpu feature fixup */
		"__fw_ftr_fixup",	/* powerpc firmware feature fixup */
1253 1254 1255 1256
		"__param",
		".data.rel.ro",		/* used by parisc64 */
		".init",
		".text.lock",
1257 1258 1259 1260 1261
		NULL
	};
	/* Start of section names */
	const char *namelist2[] = {
		".init.",
1262
		".pci_fixup",
1263
		".rodata",
1264 1265 1266
		NULL
	};

1267 1268 1269
	if (initexit_section_ref_ok(name))
		return 1;

1270 1271 1272
	for (s = namelist1; *s; s++)
		if (strcmp(*s, name) == 0)
			return 1;
1273
	for (s = namelist2; *s; s++)
1274 1275
		if (strncmp(*s, name, strlen(*s)) == 0)
			return 1;
1276 1277

	/* If section name ends with ".init" we allow references
S
Sam Ravnborg 已提交
1278 1279
	 * as is the case with .initcallN.init, .early_param.init,
	 * .taglist.init etc
1280
	 */
1281 1282
	if (strrcmp(name, ".init") == 0)
		return 1;
1283 1284 1285 1286 1287
	return 0;
}

/*
 * Identify sections from which references to a .exit section is OK.
1288
 */
1289 1290 1291 1292 1293 1294
static int exit_section_ref_ok(const char *name)
{
	const char **s;
	/* Absolute section names */
	const char *namelist1[] = {
		".exit.data",
1295 1296
		".exit.text",
		".exitcall.exit",
1297
		".rodata",
1298 1299
		NULL
	};
1300

1301 1302 1303
	if (initexit_section_ref_ok(name))
		return 1;

1304 1305 1306 1307 1308 1309
	for (s = namelist1; *s; s++)
		if (strcmp(*s, name) == 0)
			return 1;
	return 0;
}

1310
static void read_symbols(char *modname)
L
Linus Torvalds 已提交
1311 1312 1313
{
	const char *symname;
	char *version;
1314
	char *license;
L
Linus Torvalds 已提交
1315 1316 1317 1318
	struct module *mod;
	struct elf_info info = { };
	Elf_Sym *sym;

1319 1320
	if (!parse_elf(&info, modname))
		return;
L
Linus Torvalds 已提交
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330

	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;
	}

1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
	license = get_modinfo(info.modinfo, info.modinfo_len, "license");
	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 已提交
1343 1344 1345 1346 1347 1348
	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);
	}
1349 1350
	if (!is_vmlinux(modname) ||
	     (is_vmlinux(modname) && vmlinux_section_warnings)) {
1351 1352 1353
		check_sec_ref(mod, modname, &info, init_section, init_section_ref_ok);
		check_sec_ref(mod, modname, &info, exit_section, exit_section_ref_ok);
	}
L
Linus Torvalds 已提交
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378

	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);

	/* Our trick to get versioning for struct_module - it's
	 * 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)
		mod->unres = alloc_symbol("struct_module", 0, mod->unres);
}

#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 */

1379 1380
void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
						      const char *fmt, ...)
L
Linus Torvalds 已提交
1381 1382 1383 1384
{
	char tmp[SZ];
	int len;
	va_list ap;
1385

L
Linus Torvalds 已提交
1386 1387
	va_start(ap, fmt);
	len = vsnprintf(tmp, SZ, fmt, ap);
1388
	buf_write(buf, tmp, len);
L
Linus Torvalds 已提交
1389 1390 1391
	va_end(ap);
}

1392
void buf_write(struct buffer *buf, const char *s, int len)
L
Linus Torvalds 已提交
1393 1394
{
	if (buf->size - buf->pos < len) {
1395
		buf->size += len + SZ;
L
Linus Torvalds 已提交
1396 1397 1398 1399 1400 1401
		buf->p = realloc(buf->p, buf->size);
	}
	strncpy(buf->p + buf->pos, s, len);
	buf->pos += len;
}

1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
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 已提交
1427
static void check_for_unused(enum export exp, const char *m, const char *s)
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
{
	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)
1444 1445 1446 1447
{
	struct symbol *s, *exp;

	for (s = mod->unres; s; s = s->next) {
A
Andrew Morton 已提交
1448
		const char *basename;
1449 1450 1451
		exp = find_symbol(s->name);
		if (!exp || exp->module == mod)
			continue;
A
Andrew Morton 已提交
1452
		basename = strrchr(mod->name, '/');
1453 1454
		if (basename)
			basename++;
1455 1456 1457 1458 1459
		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 已提交
1460
	}
1461 1462
}

1463 1464 1465 1466
/**
 * Header for the generated file
 **/
static void add_header(struct buffer *b, struct module *mod)
L
Linus Torvalds 已提交
1467 1468 1469 1470 1471 1472 1473 1474 1475
{
	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");
1476
	buf_printf(b, " .name = KBUILD_MODNAME,\n");
L
Linus Torvalds 已提交
1477 1478 1479 1480 1481 1482
	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");
1483
	buf_printf(b, " .arch = MODULE_ARCH_INIT,\n");
L
Linus Torvalds 已提交
1484 1485 1486
	buf_printf(b, "};\n");
}

1487 1488 1489
/**
 * Record CRCs for unresolved symbols
 **/
1490
static int add_versions(struct buffer *b, struct module *mod)
L
Linus Torvalds 已提交
1491 1492
{
	struct symbol *s, *exp;
1493
	int err = 0;
L
Linus Torvalds 已提交
1494 1495 1496 1497

	for (s = mod->unres; s; s = s->next) {
		exp = find_symbol(s->name);
		if (!exp || exp->module == mod) {
1498
			if (have_vmlinux && !s->weak) {
1499 1500 1501 1502 1503 1504 1505 1506
				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;
				}
1507
			}
L
Linus Torvalds 已提交
1508 1509 1510 1511 1512 1513 1514 1515
			continue;
		}
		s->module = exp->module;
		s->crc_valid = exp->crc_valid;
		s->crc = exp->crc;
	}

	if (!modversions)
1516
		return err;
L
Linus Torvalds 已提交
1517 1518 1519 1520 1521 1522 1523

	buf_printf(b, "\n");
	buf_printf(b, "static const struct modversion_info ____versions[]\n");
	buf_printf(b, "__attribute_used__\n");
	buf_printf(b, "__attribute__((section(\"__versions\"))) = {\n");

	for (s = mod->unres; s; s = s->next) {
S
Sam Ravnborg 已提交
1524
		if (!s->module)
L
Linus Torvalds 已提交
1525 1526
			continue;
		if (!s->crc_valid) {
1527
			warn("\"%s\" [%s.ko] has no CRC!\n",
L
Linus Torvalds 已提交
1528 1529 1530 1531 1532 1533 1534
				s->name, mod->name);
			continue;
		}
		buf_printf(b, "\t{ %#8x, \"%s\" },\n", s->crc, s->name);
	}

	buf_printf(b, "};\n");
1535 1536

	return err;
L
Linus Torvalds 已提交
1537 1538
}

1539 1540
static void add_depends(struct buffer *b, struct module *mod,
			struct module *modules)
L
Linus Torvalds 已提交
1541 1542 1543 1544 1545
{
	struct symbol *s;
	struct module *m;
	int first = 1;

S
Sam Ravnborg 已提交
1546
	for (m = modules; m; m = m->next)
L
Linus Torvalds 已提交
1547 1548 1549 1550 1551 1552 1553 1554
		m->seen = is_vmlinux(m->name);

	buf_printf(b, "\n");
	buf_printf(b, "static const char __module_depends[]\n");
	buf_printf(b, "__attribute_used__\n");
	buf_printf(b, "__attribute__((section(\".modinfo\"))) =\n");
	buf_printf(b, "\"depends=");
	for (s = mod->unres; s; s = s->next) {
1555
		const char *p;
L
Linus Torvalds 已提交
1556 1557 1558 1559 1560 1561 1562
		if (!s->module)
			continue;

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

		s->module->seen = 1;
S
Sam Ravnborg 已提交
1563 1564
		p = strrchr(s->module->name, '/');
		if (p)
1565 1566 1567 1568
			p++;
		else
			p = s->module->name;
		buf_printf(b, "%s%s", first ? "" : ",", p);
L
Linus Torvalds 已提交
1569 1570 1571 1572 1573
		first = 0;
	}
	buf_printf(b, "\";\n");
}

1574
static void add_srcversion(struct buffer *b, struct module *mod)
L
Linus Torvalds 已提交
1575 1576 1577 1578 1579 1580 1581 1582
{
	if (mod->srcversion[0]) {
		buf_printf(b, "\n");
		buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
			   mod->srcversion);
	}
}

1583
static void write_if_changed(struct buffer *b, const char *fname)
L
Linus Torvalds 已提交
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
{
	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);
}

1627
/* parse Module.symvers file. line format:
S
Sam Ravnborg 已提交
1628
 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
1629
 **/
1630
static void read_dump(const char *fname, unsigned int kernel)
L
Linus Torvalds 已提交
1631 1632 1633 1634 1635
{
	unsigned long size, pos = 0;
	void *file = grab_file(fname, &size);
	char *line;

S
Sam Ravnborg 已提交
1636
	if (!file)
L
Linus Torvalds 已提交
1637 1638 1639 1640
		/* No symbol versions, silently ignore */
		return;

	while ((line = get_next_line(&pos, file, size))) {
S
Sam Ravnborg 已提交
1641
		char *symname, *modname, *d, *export, *end;
L
Linus Torvalds 已提交
1642 1643
		unsigned int crc;
		struct module *mod;
1644
		struct symbol *s;
L
Linus Torvalds 已提交
1645 1646 1647 1648 1649 1650 1651

		if (!(symname = strchr(line, '\t')))
			goto fail;
		*symname++ = '\0';
		if (!(modname = strchr(symname, '\t')))
			goto fail;
		*modname++ = '\0';
1652
		if ((export = strchr(modname, '\t')) != NULL)
1653
			*export++ = '\0';
S
Sam Ravnborg 已提交
1654 1655
		if (export && ((end = strchr(export, '\t')) != NULL))
			*end = '\0';
L
Linus Torvalds 已提交
1656 1657 1658
		crc = strtoul(line, &d, 16);
		if (*symname == '\0' || *modname == '\0' || *d != '\0')
			goto fail;
S
Sam Ravnborg 已提交
1659 1660 1661
		mod = find_module(modname);
		if (!mod) {
			if (is_vmlinux(modname))
L
Linus Torvalds 已提交
1662 1663 1664 1665
				have_vmlinux = 1;
			mod = new_module(NOFAIL(strdup(modname)));
			mod->skip = 1;
		}
1666
		s = sym_add_exported(symname, mod, export_no(export));
1667 1668
		s->kernel    = kernel;
		s->preloaded = 1;
1669
		sym_update_crc(symname, mod, crc, export_no(export));
L
Linus Torvalds 已提交
1670 1671 1672 1673 1674 1675
	}
	return;
fail:
	fatal("parse error in symbol dump file\n");
}

1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
/* 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;
}
1688

1689
static void write_dump(const char *fname)
L
Linus Torvalds 已提交
1690 1691 1692 1693 1694 1695 1696 1697
{
	struct buffer buf = { };
	struct symbol *symbol;
	int n;

	for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
		symbol = symbolhash[n];
		while (symbol) {
1698
			if (dump_sym(symbol))
1699
				buf_printf(&buf, "0x%08x\t%s\t%s\t%s\n",
1700
					symbol->crc, symbol->name,
1701 1702
					symbol->module->name,
					export_str(symbol->export));
L
Linus Torvalds 已提交
1703 1704 1705 1706 1707 1708
			symbol = symbol->next;
		}
	}
	write_if_changed(&buf, fname);
}

1709
int main(int argc, char **argv)
L
Linus Torvalds 已提交
1710 1711 1712
{
	struct module *mod;
	struct buffer buf = { };
1713 1714
	char *kernel_read = NULL, *module_read = NULL;
	char *dump_write = NULL;
L
Linus Torvalds 已提交
1715
	int opt;
1716
	int err;
L
Linus Torvalds 已提交
1717

1718
	while ((opt = getopt(argc, argv, "i:I:mso:aw")) != -1) {
S
Sam Ravnborg 已提交
1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
		switch (opt) {
		case 'i':
			kernel_read = optarg;
			break;
		case 'I':
			module_read = optarg;
			external_module = 1;
			break;
		case 'm':
			modversions = 1;
			break;
		case 'o':
			dump_write = optarg;
			break;
		case 'a':
			all_versions = 1;
			break;
		case 's':
			vmlinux_section_warnings = 0;
			break;
		case 'w':
			warn_unresolved = 1;
			break;
		default:
			exit(1);
L
Linus Torvalds 已提交
1744 1745 1746
		}
	}

1747 1748 1749 1750
	if (kernel_read)
		read_dump(kernel_read, 1);
	if (module_read)
		read_dump(module_read, 0);
L
Linus Torvalds 已提交
1751

S
Sam Ravnborg 已提交
1752
	while (optind < argc)
L
Linus Torvalds 已提交
1753 1754
		read_symbols(argv[optind++]);

1755 1756 1757
	for (mod = modules; mod; mod = mod->next) {
		if (mod->skip)
			continue;
1758
		check_exports(mod);
1759 1760
	}

1761 1762
	err = 0;

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

L
Linus Torvalds 已提交
1766 1767 1768 1769 1770 1771
		if (mod->skip)
			continue;

		buf.pos = 0;

		add_header(&buf, mod);
1772
		err |= add_versions(&buf, mod);
L
Linus Torvalds 已提交
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
		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);

1784
	return err;
L
Linus Torvalds 已提交
1785
}