module.c 97.9 KB
Newer Older
1
/*
Linus Torvalds's avatar
Linus Torvalds committed
2
   Copyright (C) 2002 Richard Henderson
3
   Copyright (C) 2001 Rusty Russell, 2002, 2010 Rusty Russell IBM.
Linus Torvalds's avatar
Linus Torvalds committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
19
#include <linux/export.h>
Linus Torvalds's avatar
Linus Torvalds committed
20
#include <linux/moduleloader.h>
21
#include <linux/ftrace_event.h>
Linus Torvalds's avatar
Linus Torvalds committed
22
#include <linux/init.h>
23
#include <linux/kallsyms.h>
24
#include <linux/file.h>
25
#include <linux/fs.h>
Roland McGrath's avatar
Roland McGrath committed
26
#include <linux/sysfs.h>
27
#include <linux/kernel.h>
Linus Torvalds's avatar
Linus Torvalds committed
28 29 30
#include <linux/slab.h>
#include <linux/vmalloc.h>
#include <linux/elf.h>
31
#include <linux/proc_fs.h>
32
#include <linux/security.h>
Linus Torvalds's avatar
Linus Torvalds committed
33 34 35 36
#include <linux/seq_file.h>
#include <linux/syscalls.h>
#include <linux/fcntl.h>
#include <linux/rcupdate.h>
37
#include <linux/capability.h>
Linus Torvalds's avatar
Linus Torvalds committed
38 39 40 41 42 43
#include <linux/cpu.h>
#include <linux/moduleparam.h>
#include <linux/errno.h>
#include <linux/err.h>
#include <linux/vermagic.h>
#include <linux/notifier.h>
Al Viro's avatar
Al Viro committed
44
#include <linux/sched.h>
Linus Torvalds's avatar
Linus Torvalds committed
45
#include <linux/device.h>
46
#include <linux/string.h>
47
#include <linux/mutex.h>
48
#include <linux/rculist.h>
Linus Torvalds's avatar
Linus Torvalds committed
49 50
#include <asm/uaccess.h>
#include <asm/cacheflush.h>
51
#include <asm/mmu_context.h>
52
#include <linux/license.h>
53
#include <asm/sections.h>
54
#include <linux/tracepoint.h>
55
#include <linux/ftrace.h>
56
#include <linux/async.h>
57
#include <linux/percpu.h>
58
#include <linux/kmemleak.h>
59
#include <linux/jump_label.h>
60
#include <linux/pfn.h>
61
#include <linux/bsearch.h>
62
#include <uapi/linux/module.h>
63
#include "module-internal.h"
Linus Torvalds's avatar
Linus Torvalds committed
64

65 66 67
#define CREATE_TRACE_POINTS
#include <trace/events/module.h>

Linus Torvalds's avatar
Linus Torvalds committed
68 69 70 71
#ifndef ARCH_SHF_SMALL
#define ARCH_SHF_SMALL 0
#endif

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
/*
 * Modules' sections will be aligned on page boundaries
 * to ensure complete separation of code and data, but
 * only when CONFIG_DEBUG_SET_MODULE_RONX=y
 */
#ifdef CONFIG_DEBUG_SET_MODULE_RONX
# define debug_align(X) ALIGN(X, PAGE_SIZE)
#else
# define debug_align(X) (X)
#endif

/*
 * Given BASE and SIZE this macro calculates the number of pages the
 * memory regions occupies
 */
#define MOD_NUMBER_OF_PAGES(BASE, SIZE) (((SIZE) > 0) ?		\
		(PFN_DOWN((unsigned long)(BASE) + (SIZE) - 1) -	\
			 PFN_DOWN((unsigned long)BASE) + 1)	\
		: (0UL))

Linus Torvalds's avatar
Linus Torvalds committed
92 93 94
/* If this is set, the section belongs in the init part of the module */
#define INIT_OFFSET_MASK (1UL << (BITS_PER_LONG-1))

95 96 97 98 99
/*
 * Mutex protects:
 * 1) List of modules (also safely readable with preempt_disable),
 * 2) module_use links,
 * 3) module_addr_min/module_addr_max.
100
 * (delete and add uses RCU list operations). */
101 102
DEFINE_MUTEX(module_mutex);
EXPORT_SYMBOL_GPL(module_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
103
static LIST_HEAD(modules);
104 105 106 107
#ifdef CONFIG_KGDB_KDB
struct list_head *kdb_modules = &modules; /* kdb needs the list of modules */
#endif /* CONFIG_KGDB_KDB */

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
#ifdef CONFIG_MODULE_SIG
#ifdef CONFIG_MODULE_SIG_FORCE
static bool sig_enforce = true;
#else
static bool sig_enforce = false;

static int param_set_bool_enable_only(const char *val,
				      const struct kernel_param *kp)
{
	int err;
	bool test;
	struct kernel_param dummy_kp = *kp;

	dummy_kp.arg = &test;

	err = param_set_bool(val, &dummy_kp);
	if (err)
		return err;

	/* Don't let them unset it once it's set! */
	if (!test && sig_enforce)
		return -EROFS;

	if (test)
		sig_enforce = true;
	return 0;
}

static const struct kernel_param_ops param_ops_bool_enable_only = {
137
	.flags = KERNEL_PARAM_OPS_FL_NOARG,
138 139 140 141 142 143 144 145
	.set = param_set_bool_enable_only,
	.get = param_get_bool,
};
#define param_check_bool_enable_only param_check_bool

module_param(sig_enforce, bool_enable_only, 0644);
#endif /* !CONFIG_MODULE_SIG_FORCE */
#endif /* CONFIG_MODULE_SIG */
Linus Torvalds's avatar
Linus Torvalds committed
146

147 148
/* Block module loading/unloading? */
int modules_disabled = 0;
149
core_param(nomodule, modules_disabled, bint, 0);
150

151 152 153
/* Waiting for a module to finish initializing? */
static DECLARE_WAIT_QUEUE_HEAD(module_wq);

154
static BLOCKING_NOTIFIER_HEAD(module_notify_list);
Linus Torvalds's avatar
Linus Torvalds committed
155

156 157
/* Bounds of module allocation, for speeding __module_address.
 * Protected by module_mutex. */
158 159
static unsigned long module_addr_min = -1UL, module_addr_max = 0;

160
int register_module_notifier(struct notifier_block *nb)
Linus Torvalds's avatar
Linus Torvalds committed
161
{
162
	return blocking_notifier_chain_register(&module_notify_list, nb);
Linus Torvalds's avatar
Linus Torvalds committed
163 164 165
}
EXPORT_SYMBOL(register_module_notifier);

166
int unregister_module_notifier(struct notifier_block *nb)
Linus Torvalds's avatar
Linus Torvalds committed
167
{
168
	return blocking_notifier_chain_unregister(&module_notify_list, nb);
Linus Torvalds's avatar
Linus Torvalds committed
169 170 171
}
EXPORT_SYMBOL(unregister_module_notifier);

172 173 174 175
struct load_info {
	Elf_Ehdr *hdr;
	unsigned long len;
	Elf_Shdr *sechdrs;
176
	char *secstrings, *strtab;
Rusty Russell's avatar
Rusty Russell committed
177
	unsigned long symoffs, stroffs;
178 179
	struct _ddebug *debug;
	unsigned int num_debug;
180
	bool sig_ok;
181 182 183 184 185
	struct {
		unsigned int sym, str, mod, vers, info, pcpu;
	} index;
};

186 187
/* We require a truly strong try_module_get(): 0 means failure due to
   ongoing or failed initialization etc. */
Linus Torvalds's avatar
Linus Torvalds committed
188 189
static inline int strong_try_module_get(struct module *mod)
{
190
	BUG_ON(mod && mod->state == MODULE_STATE_UNFORMED);
Linus Torvalds's avatar
Linus Torvalds committed
191
	if (mod && mod->state == MODULE_STATE_COMING)
192 193
		return -EBUSY;
	if (try_module_get(mod))
Linus Torvalds's avatar
Linus Torvalds committed
194
		return 0;
195 196
	else
		return -ENOENT;
Linus Torvalds's avatar
Linus Torvalds committed
197 198
}

199 200
static inline void add_taint_module(struct module *mod, unsigned flag,
				    enum lockdep_ok lockdep_ok)
201
{
202
	add_taint(flag, lockdep_ok);
Andi Kleen's avatar
Andi Kleen committed
203
	mod->taints |= (1U << flag);
204 205
}

206 207 208
/*
 * A thread that wants to hold a reference to a module only while it
 * is running can call this to safely exit.  nfsd and lockd use this.
Linus Torvalds's avatar
Linus Torvalds committed
209 210 211 212 213 214 215
 */
void __module_put_and_exit(struct module *mod, long code)
{
	module_put(mod);
	do_exit(code);
}
EXPORT_SYMBOL(__module_put_and_exit);
216

Linus Torvalds's avatar
Linus Torvalds committed
217
/* Find a module section: 0 means not found. */
218
static unsigned int find_sec(const struct load_info *info, const char *name)
Linus Torvalds's avatar
Linus Torvalds committed
219 220 221
{
	unsigned int i;

222 223
	for (i = 1; i < info->hdr->e_shnum; i++) {
		Elf_Shdr *shdr = &info->sechdrs[i];
Linus Torvalds's avatar
Linus Torvalds committed
224
		/* Alloc bit cleared means "ignore it." */
225 226
		if ((shdr->sh_flags & SHF_ALLOC)
		    && strcmp(info->secstrings + shdr->sh_name, name) == 0)
Linus Torvalds's avatar
Linus Torvalds committed
227
			return i;
228
	}
Linus Torvalds's avatar
Linus Torvalds committed
229 230 231
	return 0;
}

232
/* Find a module section, or NULL. */
233
static void *section_addr(const struct load_info *info, const char *name)
234 235
{
	/* Section 0 has sh_addr 0. */
236
	return (void *)info->sechdrs[find_sec(info, name)].sh_addr;
237 238 239
}

/* Find a module section, or NULL.  Fill in number of "objects" in section. */
240
static void *section_objs(const struct load_info *info,
241 242 243 244
			  const char *name,
			  size_t object_size,
			  unsigned int *num)
{
245
	unsigned int sec = find_sec(info, name);
246 247

	/* Section 0 has sh_addr 0 and sh_size 0. */
248 249
	*num = info->sechdrs[sec].sh_size / object_size;
	return (void *)info->sechdrs[sec].sh_addr;
250 251
}

Linus Torvalds's avatar
Linus Torvalds committed
252 253 254 255 256
/* Provided by the linker */
extern const struct kernel_symbol __start___ksymtab[];
extern const struct kernel_symbol __stop___ksymtab[];
extern const struct kernel_symbol __start___ksymtab_gpl[];
extern const struct kernel_symbol __stop___ksymtab_gpl[];
257 258
extern const struct kernel_symbol __start___ksymtab_gpl_future[];
extern const struct kernel_symbol __stop___ksymtab_gpl_future[];
Linus Torvalds's avatar
Linus Torvalds committed
259 260
extern const unsigned long __start___kcrctab[];
extern const unsigned long __start___kcrctab_gpl[];
261
extern const unsigned long __start___kcrctab_gpl_future[];
262 263 264 265 266
#ifdef CONFIG_UNUSED_SYMBOLS
extern const struct kernel_symbol __start___ksymtab_unused[];
extern const struct kernel_symbol __stop___ksymtab_unused[];
extern const struct kernel_symbol __start___ksymtab_unused_gpl[];
extern const struct kernel_symbol __stop___ksymtab_unused_gpl[];
267 268
extern const unsigned long __start___kcrctab_unused[];
extern const unsigned long __start___kcrctab_unused_gpl[];
269
#endif
Linus Torvalds's avatar
Linus Torvalds committed
270 271 272 273

#ifndef CONFIG_MODVERSIONS
#define symversion(base, idx) NULL
#else
274
#define symversion(base, idx) ((base != NULL) ? ((base) + (idx)) : NULL)
Linus Torvalds's avatar
Linus Torvalds committed
275 276
#endif

277 278 279 280 281
static bool each_symbol_in_section(const struct symsearch *arr,
				   unsigned int arrsize,
				   struct module *owner,
				   bool (*fn)(const struct symsearch *syms,
					      struct module *owner,
282
					      void *data),
283
				   void *data)
284
{
285
	unsigned int j;
286

287
	for (j = 0; j < arrsize; j++) {
288 289
		if (fn(&arr[j], owner, data))
			return true;
290
	}
291 292

	return false;
293 294
}

295
/* Returns true as soon as fn returns true, otherwise false. */
296 297 298 299
bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
				    struct module *owner,
				    void *data),
			 void *data)
300 301
{
	struct module *mod;
302
	static const struct symsearch arr[] = {
303
		{ __start___ksymtab, __stop___ksymtab, __start___kcrctab,
304
		  NOT_GPL_ONLY, false },
305
		{ __start___ksymtab_gpl, __stop___ksymtab_gpl,
306 307
		  __start___kcrctab_gpl,
		  GPL_ONLY, false },
308
		{ __start___ksymtab_gpl_future, __stop___ksymtab_gpl_future,
309 310
		  __start___kcrctab_gpl_future,
		  WILL_BE_GPL_ONLY, false },
311
#ifdef CONFIG_UNUSED_SYMBOLS
312
		{ __start___ksymtab_unused, __stop___ksymtab_unused,
313 314
		  __start___kcrctab_unused,
		  NOT_GPL_ONLY, true },
315
		{ __start___ksymtab_unused_gpl, __stop___ksymtab_unused_gpl,
316 317
		  __start___kcrctab_unused_gpl,
		  GPL_ONLY, true },
318
#endif
319
	};
320

321 322
	if (each_symbol_in_section(arr, ARRAY_SIZE(arr), NULL, fn, data))
		return true;
323

324
	list_for_each_entry_rcu(mod, &modules, list) {
325 326
		struct symsearch arr[] = {
			{ mod->syms, mod->syms + mod->num_syms, mod->crcs,
327
			  NOT_GPL_ONLY, false },
328
			{ mod->gpl_syms, mod->gpl_syms + mod->num_gpl_syms,
329 330
			  mod->gpl_crcs,
			  GPL_ONLY, false },
331 332
			{ mod->gpl_future_syms,
			  mod->gpl_future_syms + mod->num_gpl_future_syms,
333 334
			  mod->gpl_future_crcs,
			  WILL_BE_GPL_ONLY, false },
335
#ifdef CONFIG_UNUSED_SYMBOLS
336 337
			{ mod->unused_syms,
			  mod->unused_syms + mod->num_unused_syms,
338 339
			  mod->unused_crcs,
			  NOT_GPL_ONLY, true },
340 341
			{ mod->unused_gpl_syms,
			  mod->unused_gpl_syms + mod->num_unused_gpl_syms,
342 343
			  mod->unused_gpl_crcs,
			  GPL_ONLY, true },
344
#endif
345 346
		};

347 348 349
		if (mod->state == MODULE_STATE_UNFORMED)
			continue;

350 351 352 353 354
		if (each_symbol_in_section(arr, ARRAY_SIZE(arr), mod, fn, data))
			return true;
	}
	return false;
}
355
EXPORT_SYMBOL_GPL(each_symbol_section);
356 357 358 359 360 361 362 363 364 365

struct find_symbol_arg {
	/* Input */
	const char *name;
	bool gplok;
	bool warn;

	/* Output */
	struct module *owner;
	const unsigned long *crc;
366
	const struct kernel_symbol *sym;
367 368
};

369 370 371
static bool check_symbol(const struct symsearch *syms,
				 struct module *owner,
				 unsigned int symnum, void *data)
372 373 374 375 376 377 378
{
	struct find_symbol_arg *fsa = data;

	if (!fsa->gplok) {
		if (syms->licence == GPL_ONLY)
			return false;
		if (syms->licence == WILL_BE_GPL_ONLY && fsa->warn) {
379 380 381
			pr_warn("Symbol %s is being used by a non-GPL module, "
				"which will not be allowed in the future\n",
				fsa->name);
382
		}
Linus Torvalds's avatar
Linus Torvalds committed
383
	}
384

385
#ifdef CONFIG_UNUSED_SYMBOLS
386
	if (syms->unused && fsa->warn) {
387 388 389 390 391 392 393
		pr_warn("Symbol %s is marked as UNUSED, however this module is "
			"using it.\n", fsa->name);
		pr_warn("This symbol will go away in the future.\n");
		pr_warn("Please evalute if this is the right api to use and if "
			"it really is, submit a report the linux kernel "
			"mailinglist together with submitting your code for "
			"inclusion.\n");
394
	}
395
#endif
396 397 398

	fsa->owner = owner;
	fsa->crc = symversion(syms->crcs, symnum);
399
	fsa->sym = &syms->start[symnum];
400 401 402
	return true;
}

403 404 405 406 407 408 409 410
static int cmp_name(const void *va, const void *vb)
{
	const char *a;
	const struct kernel_symbol *b;
	a = va; b = vb;
	return strcmp(a, b->name);
}

411 412 413 414 415
static bool find_symbol_in_section(const struct symsearch *syms,
				   struct module *owner,
				   void *data)
{
	struct find_symbol_arg *fsa = data;
416 417 418 419 420 421 422
	struct kernel_symbol *sym;

	sym = bsearch(fsa->name, syms->start, syms->stop - syms->start,
			sizeof(struct kernel_symbol), cmp_name);

	if (sym != NULL && check_symbol(syms, owner, sym - syms->start, data))
		return true;
423 424 425 426

	return false;
}

427
/* Find a symbol and return it, along with, (optional) crc and
428
 * (optional) module which owns it.  Needs preempt disabled or module_mutex. */
429 430 431 432 433
const struct kernel_symbol *find_symbol(const char *name,
					struct module **owner,
					const unsigned long **crc,
					bool gplok,
					bool warn)
434 435 436 437 438 439 440
{
	struct find_symbol_arg fsa;

	fsa.name = name;
	fsa.gplok = gplok;
	fsa.warn = warn;

441
	if (each_symbol_section(find_symbol_in_section, &fsa)) {
442 443 444 445
		if (owner)
			*owner = fsa.owner;
		if (crc)
			*crc = fsa.crc;
446
		return fsa.sym;
447 448
	}

449
	pr_debug("Failed to find symbol %s\n", name);
450
	return NULL;
Linus Torvalds's avatar
Linus Torvalds committed
451
}
452
EXPORT_SYMBOL_GPL(find_symbol);
Linus Torvalds's avatar
Linus Torvalds committed
453 454

/* Search for module by name: must hold module_mutex. */
455
static struct module *find_module_all(const char *name, size_t len,
456
				      bool even_unformed)
Linus Torvalds's avatar
Linus Torvalds committed
457 458 459 460
{
	struct module *mod;

	list_for_each_entry(mod, &modules, list) {
461 462
		if (!even_unformed && mod->state == MODULE_STATE_UNFORMED)
			continue;
463
		if (strlen(mod->name) == len && !memcmp(mod->name, name, len))
Linus Torvalds's avatar
Linus Torvalds committed
464 465 466 467
			return mod;
	}
	return NULL;
}
468 469 470

struct module *find_module(const char *name)
{
471
	return find_module_all(name, strlen(name), false);
472
}
473
EXPORT_SYMBOL_GPL(find_module);
Linus Torvalds's avatar
Linus Torvalds committed
474 475

#ifdef CONFIG_SMP
476

477
static inline void __percpu *mod_percpu(struct module *mod)
478
{
479 480
	return mod->percpu;
}
481

Rusty Russell's avatar
Rusty Russell committed
482
static int percpu_modalloc(struct module *mod, struct load_info *info)
483
{
Rusty Russell's avatar
Rusty Russell committed
484 485 486 487 488 489
	Elf_Shdr *pcpusec = &info->sechdrs[info->index.pcpu];
	unsigned long align = pcpusec->sh_addralign;

	if (!pcpusec->sh_size)
		return 0;

490
	if (align > PAGE_SIZE) {
491 492
		pr_warn("%s: per-cpu alignment %li > %li\n",
			mod->name, align, PAGE_SIZE);
493 494 495
		align = PAGE_SIZE;
	}

Rusty Russell's avatar
Rusty Russell committed
496
	mod->percpu = __alloc_reserved_percpu(pcpusec->sh_size, align);
497
	if (!mod->percpu) {
498 499
		pr_warn("%s: Could not allocate %lu bytes percpu data\n",
			mod->name, (unsigned long)pcpusec->sh_size);
500 501
		return -ENOMEM;
	}
Rusty Russell's avatar
Rusty Russell committed
502
	mod->percpu_size = pcpusec->sh_size;
503
	return 0;
504 505
}

506
static void percpu_modfree(struct module *mod)
507
{
508
	free_percpu(mod->percpu);
509 510
}

511
static unsigned int find_pcpusec(struct load_info *info)
512
{
513
	return find_sec(info, ".data..percpu");
514 515
}

516 517
static void percpu_modcopy(struct module *mod,
			   const void *from, unsigned long size)
518 519 520 521
{
	int cpu;

	for_each_possible_cpu(cpu)
522
		memcpy(per_cpu_ptr(mod->percpu, cpu), from, size);
523 524
}

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
/**
 * is_module_percpu_address - test whether address is from module static percpu
 * @addr: address to test
 *
 * Test whether @addr belongs to module static percpu area.
 *
 * RETURNS:
 * %true if @addr is from module static percpu area
 */
bool is_module_percpu_address(unsigned long addr)
{
	struct module *mod;
	unsigned int cpu;

	preempt_disable();

	list_for_each_entry_rcu(mod, &modules, list) {
542 543
		if (mod->state == MODULE_STATE_UNFORMED)
			continue;
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
		if (!mod->percpu_size)
			continue;
		for_each_possible_cpu(cpu) {
			void *start = per_cpu_ptr(mod->percpu, cpu);

			if ((void *)addr >= start &&
			    (void *)addr < start + mod->percpu_size) {
				preempt_enable();
				return true;
			}
		}
	}

	preempt_enable();
	return false;
559 560
}

Linus Torvalds's avatar
Linus Torvalds committed
561
#else /* ... !CONFIG_SMP */
562

563
static inline void __percpu *mod_percpu(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
564 565 566
{
	return NULL;
}
Rusty Russell's avatar
Rusty Russell committed
567
static int percpu_modalloc(struct module *mod, struct load_info *info)
568
{
Rusty Russell's avatar
Rusty Russell committed
569 570 571 572
	/* UP modules shouldn't have this section: ENOMEM isn't quite right */
	if (info->sechdrs[info->index.pcpu].sh_size != 0)
		return -ENOMEM;
	return 0;
573 574
}
static inline void percpu_modfree(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
575 576
{
}
577
static unsigned int find_pcpusec(struct load_info *info)
Linus Torvalds's avatar
Linus Torvalds committed
578 579 580
{
	return 0;
}
581 582
static inline void percpu_modcopy(struct module *mod,
				  const void *from, unsigned long size)
Linus Torvalds's avatar
Linus Torvalds committed
583 584 585 586
{
	/* pcpusec should be 0, and size of that section should be 0. */
	BUG_ON(size != 0);
}
587 588 589 590
bool is_module_percpu_address(unsigned long addr)
{
	return false;
}
591

Linus Torvalds's avatar
Linus Torvalds committed
592 593
#endif /* CONFIG_SMP */

594 595 596 597 598 599
#define MODINFO_ATTR(field)	\
static void setup_modinfo_##field(struct module *mod, const char *s)  \
{                                                                     \
	mod->field = kstrdup(s, GFP_KERNEL);                          \
}                                                                     \
static ssize_t show_modinfo_##field(struct module_attribute *mattr,   \
600
			struct module_kobject *mk, char *buffer)      \
601
{                                                                     \
602
	return scnprintf(buffer, PAGE_SIZE, "%s\n", mk->mod->field);  \
603 604 605 606 607 608 609
}                                                                     \
static int modinfo_##field##_exists(struct module *mod)               \
{                                                                     \
	return mod->field != NULL;                                    \
}                                                                     \
static void free_modinfo_##field(struct module *mod)                  \
{                                                                     \
610 611
	kfree(mod->field);                                            \
	mod->field = NULL;                                            \
612 613
}                                                                     \
static struct module_attribute modinfo_##field = {                    \
614
	.attr = { .name = __stringify(field), .mode = 0444 },         \
615 616 617 618 619 620 621 622 623
	.show = show_modinfo_##field,                                 \
	.setup = setup_modinfo_##field,                               \
	.test = modinfo_##field##_exists,                             \
	.free = free_modinfo_##field,                                 \
};

MODINFO_ATTR(version);
MODINFO_ATTR(srcversion);

624 625
static char last_unloaded_module[MODULE_NAME_LEN+1];

626
#ifdef CONFIG_MODULE_UNLOAD
627 628 629

EXPORT_TRACEPOINT_SYMBOL(module_get);

630 631 632
/* MODULE_REF_BASE is the base reference count by kmodule loader. */
#define MODULE_REF_BASE	1

Linus Torvalds's avatar
Linus Torvalds committed
633
/* Init the unload section of the module. */
634
static int module_unload_init(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
635
{
636 637 638 639 640
	/*
	 * Initialize reference counter to MODULE_REF_BASE.
	 * refcnt == 0 means module is going.
	 */
	atomic_set(&mod->refcnt, MODULE_REF_BASE);
641

642 643
	INIT_LIST_HEAD(&mod->source_list);
	INIT_LIST_HEAD(&mod->target_list);
644

Linus Torvalds's avatar
Linus Torvalds committed
645
	/* Hold reference count during initialization. */
646
	atomic_inc(&mod->refcnt);
647 648

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
649 650 651 652 653 654 655
}

/* Does a already use b? */
static int already_uses(struct module *a, struct module *b)
{
	struct module_use *use;

656 657
	list_for_each_entry(use, &b->source_list, source_list) {
		if (use->source == a) {
658
			pr_debug("%s uses %s!\n", a->name, b->name);
Linus Torvalds's avatar
Linus Torvalds committed
659 660 661
			return 1;
		}
	}
662
	pr_debug("%s does not use %s!\n", a->name, b->name);
Linus Torvalds's avatar
Linus Torvalds committed
663 664 665
	return 0;
}

666 667 668 669 670 671 672 673 674 675 676
/*
 * Module a uses b
 *  - we add 'a' as a "source", 'b' as a "target" of module use
 *  - the module_use is added to the list of 'b' sources (so
 *    'b' can walk the list to see who sourced them), and of 'a'
 *    targets (so 'a' can see what modules it targets).
 */
static int add_module_usage(struct module *a, struct module *b)
{
	struct module_use *use;

677
	pr_debug("Allocating new usage for %s.\n", a->name);
678 679
	use = kmalloc(sizeof(*use), GFP_ATOMIC);
	if (!use) {
680
		pr_warn("%s: out of memory loading\n", a->name);
681 682 683 684 685 686 687 688 689 690
		return -ENOMEM;
	}

	use->source = a;
	use->target = b;
	list_add(&use->source_list, &b->source_list);
	list_add(&use->target_list, &a->target_list);
	return 0;
}

691
/* Module a uses b: caller needs module_mutex() */
692
int ref_module(struct module *a, struct module *b)
Linus Torvalds's avatar
Linus Torvalds committed
693
{
694
	int err;
Kay Sievers's avatar
Kay Sievers committed
695

696
	if (b == NULL || already_uses(a, b))
697 698
		return 0;

699 700
	/* If module isn't available, we fail. */
	err = strong_try_module_get(b);
701
	if (err)
702
		return err;
Linus Torvalds's avatar
Linus Torvalds committed
703

704 705
	err = add_module_usage(a, b);
	if (err) {
Linus Torvalds's avatar
Linus Torvalds committed
706
		module_put(b);
707
		return err;
Linus Torvalds's avatar
Linus Torvalds committed
708
	}
709
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
710
}
711
EXPORT_SYMBOL_GPL(ref_module);
Linus Torvalds's avatar
Linus Torvalds committed
712 713 714 715

/* Clear the unload stuff of the module. */
static void module_unload_free(struct module *mod)
{
716
	struct module_use *use, *tmp;
Linus Torvalds's avatar
Linus Torvalds committed
717

718
	mutex_lock(&module_mutex);
719 720
	list_for_each_entry_safe(use, tmp, &mod->target_list, target_list) {
		struct module *i = use->target;
721
		pr_debug("%s unusing %s\n", mod->name, i->name);
722 723 724 725
		module_put(i);
		list_del(&use->source_list);
		list_del(&use->target_list);
		kfree(use);
Linus Torvalds's avatar
Linus Torvalds committed
726
	}
727
	mutex_unlock(&module_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
728 729 730
}

#ifdef CONFIG_MODULE_FORCE_UNLOAD
731
static inline int try_force_unload(unsigned int flags)
Linus Torvalds's avatar
Linus Torvalds committed
732 733 734
{
	int ret = (flags & O_TRUNC);
	if (ret)
735
		add_taint(TAINT_FORCED_RMMOD, LOCKDEP_NOW_UNRELIABLE);
Linus Torvalds's avatar
Linus Torvalds committed
736 737 738
	return ret;
}
#else
739
static inline int try_force_unload(unsigned int flags)
Linus Torvalds's avatar
Linus Torvalds committed
740 741 742 743 744
{
	return 0;
}
#endif /* CONFIG_MODULE_FORCE_UNLOAD */

745 746
/* Try to release refcount of module, 0 means success. */
static int try_release_module_ref(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
747
{
748
	int ret;
Linus Torvalds's avatar
Linus Torvalds committed
749

750 751 752 753 754 755
	/* Try to decrement refcnt which we set at loading */
	ret = atomic_sub_return(MODULE_REF_BASE, &mod->refcnt);
	BUG_ON(ret < 0);
	if (ret)
		/* Someone can put this right now, recover with checking */
		ret = atomic_add_unless(&mod->refcnt, MODULE_REF_BASE, 0);
Linus Torvalds's avatar
Linus Torvalds committed
756

757 758
	return ret;
}
Linus Torvalds's avatar
Linus Torvalds committed
759

760 761
static int try_stop_module(struct module *mod, int flags, int *forced)
{
762
	/* If it's not unused, quit unless we're forcing. */
763 764 765
	if (try_release_module_ref(mod) != 0) {
		*forced = try_force_unload(flags);
		if (!(*forced))
Linus Torvalds's avatar
Linus Torvalds committed
766 767 768 769
			return -EWOULDBLOCK;
	}

	/* Mark it as dying. */
770
	mod->state = MODULE_STATE_GOING;
Linus Torvalds's avatar
Linus Torvalds committed
771

772
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
773 774
}

775 776 777 778 779 780 781 782 783 784
/**
 * module_refcount - return the refcount or -1 if unloading
 *
 * @mod:	the module we're checking
 *
 * Returns:
 *	-1 if the module is in the process of unloading
 *	otherwise the number of references in the kernel to the module
 */
int module_refcount(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
785
{
786
	return atomic_read(&mod->refcnt) - MODULE_REF_BASE;
Linus Torvalds's avatar
Linus Torvalds committed
787 788 789 790 791 792
}
EXPORT_SYMBOL(module_refcount);

/* This exists whether we can unload or not */
static void free_module(struct module *mod);

793 794
SYSCALL_DEFINE2(delete_module, const char __user *, name_user,
		unsigned int, flags)
Linus Torvalds's avatar
Linus Torvalds committed
795 796
{
	struct module *mod;
797
	char name[MODULE_NAME_LEN];
Linus Torvalds's avatar
Linus Torvalds committed
798 799
	int ret, forced = 0;

800
	if (!capable(CAP_SYS_MODULE) || modules_disabled)
801 802 803 804 805 806
		return -EPERM;

	if (strncpy_from_user(name, name_user, MODULE_NAME_LEN-1) < 0)
		return -EFAULT;
	name[MODULE_NAME_LEN-1] = '\0';

807 808
	if (mutex_lock_interruptible(&module_mutex) != 0)
		return -EINTR;
Linus Torvalds's avatar
Linus Torvalds committed
809 810 811 812 813 814 815

	mod = find_module(name);
	if (!mod) {
		ret = -ENOENT;
		goto out;
	}

816
	if (!list_empty(&mod->source_list)) {
Linus Torvalds's avatar
Linus Torvalds committed
817 818 819 820 821 822 823
		/* Other modules depend on us: get rid of them first. */
		ret = -EWOULDBLOCK;
		goto out;
	}

	/* Doing init or already dying? */
	if (mod->state != MODULE_STATE_LIVE) {
824
		/* FIXME: if (force), slam module count damn the torpedoes */
825
		pr_debug("%s already dying\n", mod->name);
Linus Torvalds's avatar
Linus Torvalds committed
826 827 828 829 830
		ret = -EBUSY;
		goto out;
	}

	/* If it has an init func, it must have an exit func to unload */
831
	if (mod->init && !mod->exit) {
832
		forced = try_force_unload(flags);
Linus Torvalds's avatar
Linus Torvalds committed
833 834 835 836 837 838 839 840 841 842 843 844
		if (!forced) {
			/* This module can't be removed */
			ret = -EBUSY;
			goto out;
		}
	}

	/* Stop the machine so refcounts can't move and disable module. */
	ret = try_stop_module(mod, flags, &forced);
	if (ret != 0)
		goto out;

845
	mutex_unlock(&module_mutex);
Lucas De Marchi's avatar
Lucas De Marchi committed
846
	/* Final destruction now no one is using it. */
847
	if (mod->exit != NULL)
Linus Torvalds's avatar
Linus Torvalds committed
848
		mod->exit();
849 850
	blocking_notifier_call_chain(&module_notify_list,
				     MODULE_STATE_GOING, mod);
851
	async_synchronize_full();
852

853
	/* Store the name of the last unloaded module for diagnostic purposes */
854
	strlcpy(last_unloaded_module, mod->name, sizeof(last_unloaded_module));
Linus Torvalds's avatar
Linus Torvalds committed
855

856 857 858
	free_module(mod);
	return 0;
out:
859
	mutex_unlock(&module_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
860 861 862
	return ret;
}

863
static inline void print_unload_info(struct seq_file *m, struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
864 865 866 867
{
	struct module_use *use;
	int printed_something = 0;

868
	seq_printf(m, " %i ", module_refcount(mod));
Linus Torvalds's avatar
Linus Torvalds committed
869

870 871 872 873
	/*
	 * Always include a trailing , so userspace can differentiate
	 * between this and the old multi-field proc format.
	 */
874
	list_for_each_entry(use, &mod->source_list, source_list) {
Linus Torvalds's avatar
Linus Torvalds committed
875
		printed_something = 1;
876
		seq_printf(m, "%s,", use->source->name);
Linus Torvalds's avatar
Linus Torvalds committed
877 878 879 880
	}

	if (mod->init != NULL && mod->exit == NULL) {
		printed_something = 1;
881
		seq_puts(m, "[permanent],");
Linus Torvalds's avatar
Linus Torvalds committed
882 883 884
	}

	if (!printed_something)
885
		seq_puts(m, "-");
Linus Torvalds's avatar
Linus Torvalds committed
886 887 888 889 890 891
}

void __symbol_put(const char *symbol)
{
	struct module *owner;

Rusty Russell's avatar
Rusty Russell committed
892
	preempt_disable();
893
	if (!find_symbol(symbol, &owner, NULL, true, false))
Linus Torvalds's avatar
Linus Torvalds committed
894 895
		BUG();
	module_put(owner);
Rusty Russell's avatar
Rusty Russell committed
896
	preempt_enable();
Linus Torvalds's avatar
Linus Torvalds committed
897 898 899
}
EXPORT_SYMBOL(__symbol_put);

900
/* Note this assumes addr is a function, which it currently always is. */
Linus Torvalds's avatar
Linus Torvalds committed
901 902
void symbol_put_addr(void *addr)
{
903
	struct module *modaddr;
904
	unsigned long a = (unsigned long)dereference_function_descriptor(addr);
Linus Torvalds's avatar
Linus Torvalds committed
905

906
	if (core_kernel_text(a))
907
		return;
Linus Torvalds's avatar
Linus Torvalds committed
908

909 910
	/* module_text_address is safe here: we're supposed to have reference
	 * to module from symbol_get, so it can't go away. */
911
	modaddr = __module_text_address(a);
912
	BUG_ON(!modaddr);
913
	module_put(modaddr);
Linus Torvalds's avatar
Linus Torvalds committed
914 915 916 917
}
EXPORT_SYMBOL_GPL(symbol_put_addr);

static ssize_t show_refcnt(struct module_attribute *mattr,
918
			   struct module_kobject *mk, char *buffer)
Linus Torvalds's avatar
Linus Torvalds committed
919
{
920
	return sprintf(buffer, "%i\n", module_refcount(mk->mod));
Linus Torvalds's avatar
Linus Torvalds committed
921 922
}

923 924
static struct module_attribute modinfo_refcnt =
	__ATTR(refcnt, 0444, show_refcnt, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
925

926 927 928 929
void __module_get(struct module *module)
{
	if (module) {
		preempt_disable();
930
		atomic_inc(&module->refcnt);
931 932 933 934 935 936 937 938 939 940 941 942
		trace_module_get(module, _RET_IP_);
		preempt_enable();
	}
}
EXPORT_SYMBOL(__module_get);

bool try_module_get(struct module *module)
{
	bool ret = true;

	if (module) {
		preempt_disable();
943 944 945
		/* Note: here, we can fail to get a reference */
		if (likely(module_is_live(module) &&
			   atomic_inc_not_zero(&module->refcnt) != 0))
946
			trace_module_get(module, _RET_IP_);
947
		else
948 949 950 951 952 953 954 955
			ret = false;

		preempt_enable();
	}
	return ret;
}
EXPORT_SYMBOL(try_module_get);

Al Viro's avatar
Al Viro committed
956 957
void module_put(struct module *module)
{
958 959
	int ret;

Al Viro's avatar
Al Viro committed
960
	if (module) {
961
		preempt_disable();
962 963
		ret = atomic_dec_if_positive(&module->refcnt);
		WARN_ON(ret < 0);	/* Failed to put refcount */
964
		trace_module_put(module, _RET_IP_);
965
		preempt_enable();
Al Viro's avatar
Al Viro committed
966 967 968 969
	}
}
EXPORT_SYMBOL(module_put);

Linus Torvalds's avatar
Linus Torvalds committed
970
#else /* !CONFIG_MODULE_UNLOAD */
971
static inline void print_unload_info(struct seq_file *m, struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
972 973
{
	/* We don't know the usage count, or what modules are using. */
974
	seq_puts(m, " - -");
Linus Torvalds's avatar
Linus Torvalds committed
975 976 977 978 979 980
}

static inline void module_unload_free(struct module *mod)
{
}

981
int ref_module(struct module *a, struct module *b)
Linus Torvalds's avatar
Linus Torvalds committed
982
{
983
	return strong_try_module_get(b);
Linus Torvalds's avatar
Linus Torvalds committed
984
}
985
EXPORT_SYMBOL_GPL(ref_module);
Linus Torvalds's avatar
Linus Torvalds committed
986

987
static inline int module_unload_init(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
988
{
989
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
990 991 992
}
#endif /* CONFIG_MODULE_UNLOAD */

993 994 995 996 997 998 999 1000 1001 1002 1003 1004
static size_t module_flags_taint(struct module *mod, char *buf)
{
	size_t l = 0;

	if (mod->taints & (1 << TAINT_PROPRIETARY_MODULE))
		buf[l++] = 'P';
	if (mod->taints & (1 << TAINT_OOT_MODULE))
		buf[l++] = 'O';
	if (mod->taints & (1 << TAINT_FORCED_MODULE))
		buf[l++] = 'F';
	if (mod->taints & (1 << TAINT_CRAP))
		buf[l++] = 'C';
1005
	if (mod->taints & (1 << TAINT_UNSIGNED_MODULE))
1006
		buf[l++] = 'E';
1007 1008
	/*
	 * TAINT_FORCED_RMMOD: could be added.
1009
	 * TAINT_CPU_OUT_OF_SPEC, TAINT_MACHINE_CHECK, TAINT_BAD_PAGE don't
1010 1011 1012 1013 1014
	 * apply to modules.
	 */
	return l;
}

1015
static ssize_t show_initstate(struct module_attribute *mattr,
1016
			      struct module_kobject *mk, char *buffer)
1017 1018 1019
{
	const char *state = "unknown";

1020
	switch (mk->mod->state) {
1021 1022 1023 1024 1025 1026 1027 1028 1029
	case MODULE_STATE_LIVE:
		state = "live";
		break;
	case MODULE_STATE_COMING:
		state = "coming";
		break;
	case MODULE_STATE_GOING:
		state = "going";
		break;
1030 1031
	default:
		BUG();
1032 1033 1034 1035
	}
	return sprintf(buffer, "%s\n", state);
}

1036 1037
static struct module_attribute modinfo_initstate =
	__ATTR(initstate, 0444, show_initstate, NULL);
1038

1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
static ssize_t store_uevent(struct module_attribute *mattr,
			    struct module_kobject *mk,
			    const char *buffer, size_t count)
{
	enum kobject_action action;

	if (kobject_action_type(buffer, count, &action) == 0)
		kobject_uevent(&mk->kobj, action);
	return count;
}

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
struct module_attribute module_uevent =
	__ATTR(uevent, 0200, NULL, store_uevent);

static ssize_t show_coresize(struct module_attribute *mattr,
			     struct module_kobject *mk, char *buffer)
{
	return sprintf(buffer, "%u\n", mk->mod->core_size);
}

static struct module_attribute modinfo_coresize =
	__ATTR(coresize, 0444, show_coresize, NULL);

static ssize_t show_initsize(struct module_attribute *mattr,
			     struct module_kobject *mk, char *buffer)
{
	return sprintf(buffer, "%u\n", mk->mod->init_size);
}

static struct module_attribute modinfo_initsize =
	__ATTR(initsize, 0444, show_initsize, NULL);

static ssize_t show_taint(struct module_attribute *mattr,
			  struct module_kobject *mk, char *buffer)
{
	size_t l;

	l = module_flags_taint(mk->mod, buffer);
	buffer[l++] = '\n';
	return l;
}

static struct module_attribute modinfo_taint =
	__ATTR(taint, 0444, show_taint, NULL);
1083

1084
static struct module_attribute *modinfo_attrs[] = {
1085
	&module_uevent,
1086 1087
	&modinfo_version,
	&modinfo_srcversion,
1088 1089 1090 1091
	&modinfo_initstate,
	&modinfo_coresize,
	&modinfo_initsize,
	&modinfo_taint,
1092
#ifdef CONFIG_MODULE_UNLOAD
1093
	&modinfo_refcnt,
1094 1095 1096 1097
#endif
	NULL,
};

Linus Torvalds's avatar
Linus Torvalds committed
1098 1099
static const char vermagic[] = VERMAGIC_STRING;

1100
static int try_to_force_load(struct module *mod, const char *reason)
1101 1102
{
#ifdef CONFIG_MODULE_FORCE_LOAD
Andi Kleen's avatar
Andi Kleen committed
1103
	if (!test_taint(TAINT_FORCED_MODULE))
1104
		pr_warn("%s: %s: kernel tainted.\n", mod->name, reason);
1105
	add_taint_module(mod, TAINT_FORCED_MODULE, LOCKDEP_NOW_UNRELIABLE);
1106 1107 1108 1109 1110 1111
	return 0;
#else
	return -ENOEXEC;
#endif
}

Linus Torvalds's avatar
Linus Torvalds committed
1112
#ifdef CONFIG_MODVERSIONS
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
/* If the arch applies (non-zero) relocations to kernel kcrctab, unapply it. */
static unsigned long maybe_relocated(unsigned long crc,
				     const struct module *crc_owner)
{
#ifdef ARCH_RELOCATES_KCRCTAB
	if (crc_owner == NULL)
		return crc - (unsigned long)reloc_start;
#endif
	return crc;
}

Linus Torvalds's avatar
Linus Torvalds committed
1124 1125 1126
static int check_version(Elf_Shdr *sechdrs,
			 unsigned int versindex,
			 const char *symname,
1127
			 struct module *mod,
1128 1129
			 const unsigned long *crc,
			 const struct module *crc_owner)
Linus Torvalds's avatar
Linus Torvalds committed
1130 1131 1132 1133 1134 1135 1136 1137
{
	unsigned int i, num_versions;
	struct modversion_info *versions;

	/* Exporting module didn't supply crcs?  OK, we're already tainted. */
	if (!crc)
		return 1;

1138 1139 1140 1141
	/* No versions at all?  modprobe --force does this. */
	if (versindex == 0)