modpost.c 42.4 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
static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
{
	return elf->strtab + sym->st_name;
}

static const char *sec_name(struct elf_info *elf, int shndx)
{
	Elf_Shdr *sechdrs = elf->sechdrs;
	return (void *)elf->hdr +
	        elf->sechdrs[elf->hdr->e_shstrndx].sh_offset +
	        sechdrs[shndx].sh_name;
}

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

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
/* 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"
648
 * "*foo" will match a string that ends with "foo"
649 650 651 652 653 654 655 656 657 658 659 660 661
 * "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.
 */
int match(const char *sym, const char * const pat[])
{
	const char *p;
	while (*pat) {
		p = *pat++;
		const char *endp = p + strlen(p) - 1;

662 663 664 665 666
		/* "*foo" */
		if (*p == '*') {
			if (strrcmp(sym, p + 1) == 0)
				return 1;
		}
667
		/* "foo*" */
668
		else if (*endp == '*') {
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
			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[] =
	{ ".debug*", ".stab*", ".note*", ".got*", ".toc*", NULL };

693 694 695 696
#define ALL_INIT_DATA_SECTIONS \
	".init.data$", ".devinit.data$", ".cpuinit.data$", ".meminit.data$"
#define ALL_EXIT_DATA_SECTIONS \
	".exit.data$", ".devexit.data$", ".cpuexit.data$", ".memexit.data$"
697

698 699 700 701
#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$"
702

703 704
#define ALL_INIT_SECTIONS ALL_INIT_DATA_SECTIONS, ALL_INIT_TEXT_SECTIONS
#define ALL_EXIT_SECTIONS ALL_EXIT_DATA_SECTIONS, ALL_EXIT_TEXT_SECTIONS
705

706
#define DATA_SECTIONS ".data$", ".data.rel$"
707 708
#define TEXT_SECTIONS ".text$"

709 710 711 712 713 714 715 716 717 718
#define INIT_SECTIONS      ".init.data$", ".init.text$"
#define DEV_INIT_SECTIONS  ".devinit.data$", ".devinit.text$"
#define CPU_INIT_SECTIONS  ".cpuinit.data$", ".cpuinit.text$"
#define MEM_INIT_SECTIONS  ".meminit.data$", ".meminit.text$"

#define EXIT_SECTIONS      ".exit.data$", ".exit.text$"
#define DEV_EXIT_SECTIONS  ".devexit.data$", ".devexit.text$"
#define CPU_EXIT_SECTIONS  ".cpuexit.data$", ".cpuexit.text$"
#define MEM_EXIT_SECTIONS  ".memexit.data$", ".memexit.text$"

719
/* init data sections */
720
static const char *init_data_sections[] = { ALL_INIT_DATA_SECTIONS, NULL };
721 722

/* all init sections */
723
static const char *init_sections[] = { ALL_INIT_SECTIONS, NULL };
724 725 726

/* All init and exit sections (code + data) */
static const char *init_exit_sections[] =
727
	{ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL };
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759

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

/* sections that may refer to an init/exit section with no warning */
static const char *initref_sections[] =
{
	".text.init.refok*",
	".exit.text.refok*",
	".data.init.refok*",
	NULL
};


/* symbols in .data that may refer to init/exit sections */
static const char *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",
	NULL
};

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

760 761 762 763 764 765 766 767 768 769 770
struct sectioncheck {
	const char *fromsec[20];
	const char *tosec[20];
};

const struct sectioncheck sectioncheck[] = {
/* Do not reference init/exit code/data from
 * normal code and data
 */
{
	.fromsec = { TEXT_SECTIONS, DATA_SECTIONS, NULL },
771 772 773 774 775 776 777 778 779 780 781
	.tosec   = { ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL }
},
/* Do not reference init code/data from devinit/cpuinit/meminit code/data */
{
	.fromsec = { DEV_INIT_SECTIONS, CPU_INIT_SECTIONS, MEM_INIT_SECTIONS, NULL },
	.tosec   = { INIT_SECTIONS, NULL }
},
/* Do not reference exit code/data from devexit/cpuexit/memexit code/data */
{
	.fromsec = { DEV_EXIT_SECTIONS, CPU_EXIT_SECTIONS, MEM_EXIT_SECTIONS, NULL },
	.tosec   = { EXIT_SECTIONS, NULL }
782 783 784
},
/* Do not use exit code/data from init code */
{
785 786
	.fromsec = { ALL_INIT_SECTIONS, NULL },
	.tosec   = { ALL_EXIT_SECTIONS, NULL },
787 788 789
},
/* Do not use init code/data from exit code */
{
790 791
	.fromsec = { ALL_EXIT_SECTIONS, NULL },
	.tosec   = { ALL_INIT_SECTIONS, NULL }
792 793 794 795
},
/* Do not export init/exit functions or data */
{
	.fromsec = { "__ksymtab*", NULL },
796
	.tosec   = { ALL_INIT_SECTIONS, ALL_EXIT_SECTIONS, NULL }
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
}
};

static int section_mismatch(const char *fromsec, const char *tosec)
{
	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))
			return 1;
		check++;
	}
	return 0;
}


816 817
/**
 * Whitelist to allow certain references to pass with no warning.
818 819 820 821
 *
 * Pattern 0:
 *   Do not warn if funtion/data are marked with __init_refok/__initdata_refok.
 *   The pattern is identified by:
822
 *   fromsec = .text.init.refok* | .data.init.refok*
823
 *
824 825 826 827 828 829 830
 * 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
831
 *   fromsec = .data*
832
 *   atsym   =__param*
833
 *
834
 * Pattern 2:
835
 *   Many drivers utilise a *driver container with references to
836 837 838 839
 *   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:
840 841
 *   tosec   = init or exit section
 *   fromsec = data section
S
Sam Ravnborg 已提交
842 843
 *   atsym = *driver, *_template, *_sht, *_ops, *_probe,
 *           *probe_one, *_console, *_timer
844 845
 *
 * Pattern 3:
846 847 848
 *   Whitelist all refereces from .text.head to .init.data
 *   Whitelist all refereces from .text.head to .init.text
 *
849
 * Pattern 4:
850 851 852 853 854 855 856
 *   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
857
 *
858
 **/
859
static int secref_whitelist(const char *modname, const char *tosec,
860 861
			    const char *fromsec, const char *atsym,
			    const char *refsymname)
862
{
863
	/* Check for pattern 0 */
864
	if (match(fromsec, initref_sections))
865 866
		return 1;

867
	/* Check for pattern 1 */
868 869
	if (match(tosec, init_data_sections) &&
	    match(fromsec, data_sections) &&
870 871
	    (strncmp(atsym, "__param", strlen("__param")) == 0))
		return 1;
872 873

	/* Check for pattern 2 */
874 875 876 877
	if (match(tosec, init_exit_sections) &&
	    match(fromsec, data_sections) &&
	    match(atsym, symbol_white_list))
		return 1;
878

879
	/* Check for pattern 3 */
880 881
	if (match(fromsec, head_sections) &&
	    match(tosec, init_sections))
882 883
	return 1;

884
	/* Check for pattern 4 */
885 886
	if (match(refsymname, linker_symbols))
		return 1;
887

888
	return 0;
889 890
}

891 892 893 894 895 896 897
/**
 * 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.
 *  **/
898
static Elf_Sym *find_elf_symbol(struct elf_info *elf, Elf64_Sword addr,
899 900 901
				Elf_Sym *relsym)
{
	Elf_Sym *sym;
902 903 904
	Elf_Sym *near = NULL;
	Elf64_Sword distance = 20;
	Elf64_Sword d;
905 906 907 908 909 910

	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;
911 912
		if (ELF_ST_TYPE(sym->st_info) == STT_SECTION)
			continue;
913 914
		if (sym->st_value == addr)
			return sym;
915 916 917 918 919 920 921 922
		/* 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;
		}
923
	}
924 925 926 927 928
	/* We need a close match */
	if (distance < 20)
		return near;
	else
		return NULL;
929 930
}

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
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);
}

955
/*
956 957 958 959
 * 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.
960
 **/
961 962
static Elf_Sym *find_elf_symbol2(struct elf_info *elf, Elf_Addr addr,
				 const char *sec)
963 964
{
	Elf_Sym *sym;
965 966
	Elf_Sym *near = NULL;
	Elf_Addr distance = ~0;
967

968 969 970 971 972
	for (sym = elf->symtab_start; sym < elf->symtab_stop; sym++) {
		const char *symsec;

		if (sym->st_shndx >= SHN_LORESERVE)
			continue;
973
		symsec = sec_name(elf, sym->st_shndx);
974 975
		if (strcmp(symsec, sec) != 0)
			continue;
976 977
		if (!is_valid_name(elf, sym))
			continue;
978
		if (sym->st_value <= addr) {
979 980 981 982 983
			if ((addr - sym->st_value) < distance) {
				distance = addr - sym->st_value;
				near = sym;
			} else if ((addr - sym->st_value) == distance) {
				near = sym;
984
			}
985 986
		}
	}
987
	return near;
988 989 990 991 992
}

/**
 * Print a warning about a section mismatch.
 * Try to find symbols near it so user can find it.
993
 * Check whitelist before warning - it may be a false positive.
994 995 996 997
 **/
static void warn_sec_mismatch(const char *modname, const char *fromsec,
			      struct elf_info *elf, Elf_Sym *sym, Elf_Rela r)
{
998
	Elf_Sym *where;
999
	Elf_Sym *refsym;
1000 1001
	const char *refsymname = "";
	const char *secname;
1002

1003
	secname = sec_name(elf, sym->st_shndx);
1004
	where = find_elf_symbol2(elf, r.r_offset, fromsec);
1005

1006
	refsym = find_elf_symbol(elf, r.r_addend, sym);
1007 1008
	if (refsym && strlen(sym_name(elf, refsym)))
		refsymname = sym_name(elf, refsym);
1009 1010

	/* check whitelist - we may ignore it */
1011
	if (secref_whitelist(modname, secname, fromsec,
1012
			     where ? sym_name(elf, where) : "",
1013
	                     refsymname))
1014
		return;
1015

1016
	if (where) {
1017
		warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s "
1018
		     "in '%s'\n",
1019
		     modname, fromsec, (unsigned long long)r.r_offset,
1020
		     secname, refsymname, sym_name(elf, where));
1021
	} else {
1022 1023 1024
		warn("%s(%s+0x%llx): Section mismatch: reference to %s:%s\n",
		     modname, fromsec, (unsigned long long)r.r_offset,
		     secname, refsymname);
1025 1026 1027
	}
}

1028
static unsigned int *reloc_location(struct elf_info *elf,
1029
				    Elf_Shdr *sechdr, Elf_Rela *r)
1030 1031
{
	Elf_Shdr *sechdrs = elf->sechdrs;
1032
	int section = sechdr->sh_info;
1033 1034 1035 1036 1037

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

1038
static int addend_386_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
1039 1040
{
	unsigned int r_typ = ELF_R_TYPE(r->r_info);
1041
	unsigned int *location = reloc_location(elf, sechdr, r);
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056

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

1057
static int addend_arm_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
1058 1059 1060 1061 1062 1063
{
	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 已提交
1064 1065
		r->r_addend = (int)(long)
		              (elf->symtab_start + ELF_R_SYM(r->r_info));
1066 1067 1068
		break;
	case R_ARM_PC24:
		/* From ARM ABI: ((S + A) | T) - P */
S
Sam Ravnborg 已提交
1069
		r->r_addend = (int)(long)(elf->hdr +
1070 1071
		              sechdr->sh_offset +
		              (r->r_offset - sechdr->sh_addr));
1072 1073 1074 1075 1076 1077 1078
		break;
	default:
		return 1;
	}
	return 0;
}

1079
static int addend_mips_rel(struct elf_info *elf, Elf_Shdr *sechdr, Elf_Rela *r)
1080 1081
{
	unsigned int r_typ = ELF_R_TYPE(r->r_info);
1082
	unsigned int *location = reloc_location(elf, sechdr, r);
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
	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;
}

1102
static void section_rela(const char *modname, struct elf_info *elf,
1103
                         Elf_Shdr *sechdr)
1104 1105 1106 1107 1108 1109 1110 1111
{
	Elf_Sym  *sym;
	Elf_Rela *rela;
	Elf_Rela r;
	unsigned int r_sym;
	const char *fromsec;
	const char * tosec;

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

1115
	fromsec = sech_name(elf, sechdr);
1116 1117
	fromsec += strlen(".rela");
	/* if from section (name) is know good then skip it */
1118
	if (match(fromsec, section_white_list))
1119 1120 1121 1122 1123
		return;

	for (rela = start; rela < stop; rela++) {
		r.r_offset = TO_NATIVE(rela->r_offset);
#if KERNEL_ELFCLASS == ELFCLASS64
1124
		if (elf->hdr->e_machine == EM_MIPS) {
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
			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;

1144
		tosec = sec_name(elf, sym->st_shndx);
1145
		if (section_mismatch(fromsec, tosec))
1146 1147 1148 1149 1150
			warn_sec_mismatch(modname, fromsec, elf, sym, r);
	}
}

static void section_rel(const char *modname, struct elf_info *elf,
1151
                        Elf_Shdr *sechdr)
1152 1153 1154 1155 1156 1157 1158 1159
{
	Elf_Sym *sym;
	Elf_Rel *rel;
	Elf_Rela r;
	unsigned int r_sym;
	const char *fromsec;
	const char * tosec;

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

1163
	fromsec = sech_name(elf, sechdr);
1164 1165
	fromsec += strlen(".rel");
	/* if from section (name) is know good then skip it */
1166
	if (match(fromsec, section_white_list))
1167 1168 1169 1170 1171
		return;

	for (rel = start; rel < stop; rel++) {
		r.r_offset = TO_NATIVE(rel->r_offset);
#if KERNEL_ELFCLASS == ELFCLASS64
1172
		if (elf->hdr->e_machine == EM_MIPS) {
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
			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;
1187
		switch (elf->hdr->e_machine) {
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
		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;

1206
		tosec = sec_name(elf, sym->st_shndx);
1207
		if (section_mismatch(fromsec, tosec))
1208 1209 1210 1211
			warn_sec_mismatch(modname, fromsec, elf, sym, r);
	}
}

1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
/**
 * 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,
1225
                          struct elf_info *elf)
1226 1227 1228
{
	int i;
	Elf_Shdr *sechdrs = elf->sechdrs;
1229

1230
	/* Walk through all sections */
1231
	for (i = 0; i < elf->hdr->e_shnum; i++) {
1232
		/* We want to process only relocation sections and not .init */
1233
		if (sechdrs[i].sh_type == SHT_RELA)
1234
			section_rela(modname, elf, &elf->sechdrs[i]);
1235
		else if (sechdrs[i].sh_type == SHT_REL)
1236
			section_rel(modname, elf, &elf->sechdrs[i]);
1237 1238 1239
	}
}

1240
static void read_symbols(char *modname)
L
Linus Torvalds 已提交
1241 1242 1243
{
	const char *symname;
	char *version;
1244
	char *license;
L
Linus Torvalds 已提交
1245 1246 1247 1248
	struct module *mod;
	struct elf_info info = { };
	Elf_Sym *sym;

1249 1250
	if (!parse_elf(&info, modname))
		return;
L
Linus Torvalds 已提交
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260

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

1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
	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 已提交
1273 1274 1275 1276 1277 1278
	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);
	}
1279
	if (!is_vmlinux(modname) ||
1280 1281
	     (is_vmlinux(modname) && vmlinux_section_warnings))
		check_sec_ref(mod, modname, &info);
L
Linus Torvalds 已提交
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306

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

1307 1308
void __attribute__((format(printf, 2, 3))) buf_printf(struct buffer *buf,
						      const char *fmt, ...)
L
Linus Torvalds 已提交
1309 1310 1311 1312
{
	char tmp[SZ];
	int len;
	va_list ap;
1313

L
Linus Torvalds 已提交
1314 1315
	va_start(ap, fmt);
	len = vsnprintf(tmp, SZ, fmt, ap);
1316
	buf_write(buf, tmp, len);
L
Linus Torvalds 已提交
1317 1318 1319
	va_end(ap);
}

1320
void buf_write(struct buffer *buf, const char *s, int len)
L
Linus Torvalds 已提交
1321 1322
{
	if (buf->size - buf->pos < len) {
1323
		buf->size += len + SZ;
L
Linus Torvalds 已提交
1324 1325 1326 1327 1328 1329
		buf->p = realloc(buf->p, buf->size);
	}
	strncpy(buf->p + buf->pos, s, len);
	buf->pos += len;
}

1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
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 已提交
1355
static void check_for_unused(enum export exp, const char *m, const char *s)
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
{
	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)
1372 1373 1374 1375
{
	struct symbol *s, *exp;

	for (s = mod->unres; s; s = s->next) {
A
Andrew Morton 已提交
1376
		const char *basename;
1377 1378 1379
		exp = find_symbol(s->name);
		if (!exp || exp->module == mod)
			continue;
A
Andrew Morton 已提交
1380
		basename = strrchr(mod->name, '/');
1381 1382
		if (basename)
			basename++;
1383 1384 1385 1386 1387
		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 已提交
1388
	}
1389 1390
}

1391 1392 1393 1394
/**
 * Header for the generated file
 **/
static void add_header(struct buffer *b, struct module *mod)
L
Linus Torvalds 已提交
1395 1396 1397 1398 1399 1400 1401 1402 1403
{
	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");
1404
	buf_printf(b, " .name = KBUILD_MODNAME,\n");
L
Linus Torvalds 已提交
1405 1406 1407 1408 1409 1410
	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");
1411
	buf_printf(b, " .arch = MODULE_ARCH_INIT,\n");
L
Linus Torvalds 已提交
1412 1413 1414
	buf_printf(b, "};\n");
}

1415 1416 1417
/**
 * Record CRCs for unresolved symbols
 **/
1418
static int add_versions(struct buffer *b, struct module *mod)
L
Linus Torvalds 已提交
1419 1420
{
	struct symbol *s, *exp;
1421
	int err = 0;
L
Linus Torvalds 已提交
1422 1423 1424 1425

	for (s = mod->unres; s; s = s->next) {
		exp = find_symbol(s->name);
		if (!exp || exp->module == mod) {
1426
			if (have_vmlinux && !s->weak) {
1427 1428 1429 1430 1431 1432 1433 1434
				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;
				}
1435
			}
L
Linus Torvalds 已提交
1436 1437 1438 1439 1440 1441 1442 1443
			continue;
		}
		s->module = exp->module;
		s->crc_valid = exp->crc_valid;
		s->crc = exp->crc;
	}

	if (!modversions)
1444
		return err;
L
Linus Torvalds 已提交
1445 1446 1447 1448 1449 1450 1451

	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 已提交
1452
		if (!s->module)
L
Linus Torvalds 已提交
1453 1454
			continue;
		if (!s->crc_valid) {
1455
			warn("\"%s\" [%s.ko] has no CRC!\n",
L
Linus Torvalds 已提交
1456 1457 1458 1459 1460 1461 1462
				s->name, mod->name);
			continue;
		}
		buf_printf(b, "\t{ %#8x, \"%s\" },\n", s->crc, s->name);
	}

	buf_printf(b, "};\n");
1463 1464

	return err;
L
Linus Torvalds 已提交
1465 1466
}

1467 1468
static void add_depends(struct buffer *b, struct module *mod,
			struct module *modules)
L
Linus Torvalds 已提交
1469 1470 1471 1472 1473
{
	struct symbol *s;
	struct module *m;
	int first = 1;

S
Sam Ravnborg 已提交
1474
	for (m = modules; m; m = m->next)
L
Linus Torvalds 已提交
1475 1476 1477 1478 1479 1480 1481 1482
		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) {
1483
		const char *p;
L
Linus Torvalds 已提交
1484 1485 1486 1487 1488 1489 1490
		if (!s->module)
			continue;

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

		s->module->seen = 1;
S
Sam Ravnborg 已提交
1491 1492
		p = strrchr(s->module->name, '/');
		if (p)
1493 1494 1495 1496
			p++;
		else
			p = s->module->name;
		buf_printf(b, "%s%s", first ? "" : ",", p);
L
Linus Torvalds 已提交
1497 1498 1499 1500 1501
		first = 0;
	}
	buf_printf(b, "\";\n");
}

1502
static void add_srcversion(struct buffer *b, struct module *mod)
L
Linus Torvalds 已提交
1503 1504 1505 1506 1507 1508 1509 1510
{
	if (mod->srcversion[0]) {
		buf_printf(b, "\n");
		buf_printf(b, "MODULE_INFO(srcversion, \"%s\");\n",
			   mod->srcversion);
	}
}

1511
static void write_if_changed(struct buffer *b, const char *fname)
L
Linus Torvalds 已提交
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
{
	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);
}

1555
/* parse Module.symvers file. line format:
S
Sam Ravnborg 已提交
1556
 * 0x12345678<tab>symbol<tab>module[[<tab>export]<tab>something]
1557
 **/
1558
static void read_dump(const char *fname, unsigned int kernel)
L
Linus Torvalds 已提交
1559 1560 1561 1562 1563
{
	unsigned long size, pos = 0;
	void *file = grab_file(fname, &size);
	char *line;

S
Sam Ravnborg 已提交
1564
	if (!file)
L
Linus Torvalds 已提交
1565 1566 1567 1568
		/* No symbol versions, silently ignore */
		return;

	while ((line = get_next_line(&pos, file, size))) {
S
Sam Ravnborg 已提交
1569
		char *symname, *modname, *d, *export, *end;
L
Linus Torvalds 已提交
1570 1571
		unsigned int crc;
		struct module *mod;
1572
		struct symbol *s;
L
Linus Torvalds 已提交
1573 1574 1575 1576 1577 1578 1579

		if (!(symname = strchr(line, '\t')))
			goto fail;
		*symname++ = '\0';
		if (!(modname = strchr(symname, '\t')))
			goto fail;
		*modname++ = '\0';
1580
		if ((export = strchr(modname, '\t')) != NULL)
1581
			*export++ = '\0';
S
Sam Ravnborg 已提交
1582 1583
		if (export && ((end = strchr(export, '\t')) != NULL))
			*end = '\0';
L
Linus Torvalds 已提交
1584 1585 1586
		crc = strtoul(line, &d, 16);
		if (*symname == '\0' || *modname == '\0' || *d != '\0')
			goto fail;
S
Sam Ravnborg 已提交
1587 1588 1589
		mod = find_module(modname);
		if (!mod) {
			if (is_vmlinux(modname))
L
Linus Torvalds 已提交
1590 1591 1592 1593
				have_vmlinux = 1;
			mod = new_module(NOFAIL(strdup(modname)));
			mod->skip = 1;
		}
1594
		s = sym_add_exported(symname, mod, export_no(export));
1595 1596
		s->kernel    = kernel;
		s->preloaded = 1;
1597
		sym_update_crc(symname, mod, crc, export_no(export));
L
Linus Torvalds 已提交
1598 1599 1600 1601 1602 1603
	}
	return;
fail:
	fatal("parse error in symbol dump file\n");
}

1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615
/* 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;
}
1616

1617
static void write_dump(const char *fname)
L
Linus Torvalds 已提交
1618 1619 1620 1621 1622 1623 1624 1625
{
	struct buffer buf = { };
	struct symbol *symbol;
	int n;

	for (n = 0; n < SYMBOL_HASH_SIZE ; n++) {
		symbol = symbolhash[n];
		while (symbol) {
1626
			if (dump_sym(symbol))
1627
				buf_printf(&buf, "0x%08x\t%s\t%s\t%s\n",
1628
					symbol->crc, symbol->name,
1629 1630
					symbol->module->name,
					export_str(symbol->export));
L
Linus Torvalds 已提交
1631 1632 1633 1634 1635 1636
			symbol = symbol->next;
		}
	}
	write_if_changed(&buf, fname);
}

1637
int main(int argc, char **argv)
L
Linus Torvalds 已提交
1638 1639 1640
{
	struct module *mod;
	struct buffer buf = { };
1641 1642
	char *kernel_read = NULL, *module_read = NULL;
	char *dump_write = NULL;
L
Linus Torvalds 已提交
1643
	int opt;
1644
	int err;
L
Linus Torvalds 已提交
1645

1646
	while ((opt = getopt(argc, argv, "i:I:mso:aw")) != -1) {
S
Sam Ravnborg 已提交
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
		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 已提交
1672 1673 1674
		}
	}

1675 1676 1677 1678
	if (kernel_read)
		read_dump(kernel_read, 1);
	if (module_read)
		read_dump(module_read, 0);
L
Linus Torvalds 已提交
1679

S
Sam Ravnborg 已提交
1680
	while (optind < argc)
L
Linus Torvalds 已提交
1681 1682
		read_symbols(argv[optind++]);

1683 1684 1685
	for (mod = modules; mod; mod = mod->next) {
		if (mod->skip)
			continue;
1686
		check_exports(mod);
1687 1688
	}

1689 1690
	err = 0;

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

L
Linus Torvalds 已提交
1694 1695 1696 1697 1698 1699
		if (mod->skip)
			continue;

		buf.pos = 0;

		add_header(&buf, mod);
1700
		err |= add_versions(&buf, mod);
L
Linus Torvalds 已提交
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711
		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);

1712
	return err;
L
Linus Torvalds 已提交
1713
}