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

    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
*/
#include <linux/module.h>
#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/fs.h>
Roland McGrath's avatar
Roland McGrath committed
25
#include <linux/sysfs.h>
26
#include <linux/kernel.h>
Linus Torvalds's avatar
Linus Torvalds committed
27 28 29
#include <linux/slab.h>
#include <linux/vmalloc.h>
#include <linux/elf.h>
30
#include <linux/proc_fs.h>
Linus Torvalds's avatar
Linus Torvalds committed
31 32 33 34
#include <linux/seq_file.h>
#include <linux/syscalls.h>
#include <linux/fcntl.h>
#include <linux/rcupdate.h>
35
#include <linux/capability.h>
Linus Torvalds's avatar
Linus Torvalds committed
36 37 38 39 40 41
#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
42
#include <linux/sched.h>
Linus Torvalds's avatar
Linus Torvalds committed
43 44
#include <linux/stop_machine.h>
#include <linux/device.h>
45
#include <linux/string.h>
Arjan van de Ven's avatar
Arjan van de Ven committed
46
#include <linux/mutex.h>
47
#include <linux/rculist.h>
Linus Torvalds's avatar
Linus Torvalds committed
48 49
#include <asm/uaccess.h>
#include <asm/cacheflush.h>
50
#include <asm/mmu_context.h>
51
#include <linux/license.h>
52
#include <asm/sections.h>
53
#include <linux/tracepoint.h>
54
#include <linux/ftrace.h>
55
#include <linux/async.h>
56
#include <linux/percpu.h>
57
#include <linux/kmemleak.h>
Linus Torvalds's avatar
Linus Torvalds committed
58

59 60 61
#define CREATE_TRACE_POINTS
#include <trace/events/module.h>

Linus Torvalds's avatar
Linus Torvalds committed
62 63 64 65 66 67 68 69 70 71 72 73 74
#if 0
#define DEBUGP printk
#else
#define DEBUGP(fmt , a...)
#endif

#ifndef ARCH_SHF_SMALL
#define ARCH_SHF_SMALL 0
#endif

/* If this is set, the section belongs in the init part of the module */
#define INIT_OFFSET_MASK (1UL << (BITS_PER_LONG-1))

75 76 77 78 79
/*
 * Mutex protects:
 * 1) List of modules (also safely readable with preempt_disable),
 * 2) module_use links,
 * 3) module_addr_min/module_addr_max.
80
 * (delete uses stop_machine/add uses RCU list operations). */
81 82
DEFINE_MUTEX(module_mutex);
EXPORT_SYMBOL_GPL(module_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
83
static LIST_HEAD(modules);
84 85 86 87
#ifdef CONFIG_KGDB_KDB
struct list_head *kdb_modules = &modules; /* kdb needs the list of modules */
#endif /* CONFIG_KGDB_KDB */

Linus Torvalds's avatar
Linus Torvalds committed
88

89 90 91
/* Block module loading/unloading? */
int modules_disabled = 0;

92 93 94
/* Waiting for a module to finish initializing? */
static DECLARE_WAIT_QUEUE_HEAD(module_wq);

95
static BLOCKING_NOTIFIER_HEAD(module_notify_list);
Linus Torvalds's avatar
Linus Torvalds committed
96

97 98
/* Bounds of module allocation, for speeding __module_address.
 * Protected by module_mutex. */
99 100
static unsigned long module_addr_min = -1UL, module_addr_max = 0;

Linus Torvalds's avatar
Linus Torvalds committed
101 102
int register_module_notifier(struct notifier_block * nb)
{
103
	return blocking_notifier_chain_register(&module_notify_list, nb);
Linus Torvalds's avatar
Linus Torvalds committed
104 105 106 107 108
}
EXPORT_SYMBOL(register_module_notifier);

int unregister_module_notifier(struct notifier_block * nb)
{
109
	return blocking_notifier_chain_unregister(&module_notify_list, nb);
Linus Torvalds's avatar
Linus Torvalds committed
110 111 112
}
EXPORT_SYMBOL(unregister_module_notifier);

113 114
/* 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
115 116 117
static inline int strong_try_module_get(struct module *mod)
{
	if (mod && mod->state == MODULE_STATE_COMING)
118 119
		return -EBUSY;
	if (try_module_get(mod))
Linus Torvalds's avatar
Linus Torvalds committed
120
		return 0;
121 122
	else
		return -ENOENT;
Linus Torvalds's avatar
Linus Torvalds committed
123 124
}

125 126 127
static inline void add_taint_module(struct module *mod, unsigned flag)
{
	add_taint(flag);
Andi Kleen's avatar
Andi Kleen committed
128
	mod->taints |= (1U << flag);
129 130
}

131 132 133
/*
 * 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
134 135 136 137 138 139 140
 */
void __module_put_and_exit(struct module *mod, long code)
{
	module_put(mod);
	do_exit(code);
}
EXPORT_SYMBOL(__module_put_and_exit);
141

Linus Torvalds's avatar
Linus Torvalds committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
/* Find a module section: 0 means not found. */
static unsigned int find_sec(Elf_Ehdr *hdr,
			     Elf_Shdr *sechdrs,
			     const char *secstrings,
			     const char *name)
{
	unsigned int i;

	for (i = 1; i < hdr->e_shnum; i++)
		/* Alloc bit cleared means "ignore it." */
		if ((sechdrs[i].sh_flags & SHF_ALLOC)
		    && strcmp(secstrings+sechdrs[i].sh_name, name) == 0)
			return i;
	return 0;
}

Rusty Russell's avatar
Rusty Russell committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
/* Find a module section, or NULL. */
static void *section_addr(Elf_Ehdr *hdr, Elf_Shdr *shdrs,
			  const char *secstrings, const char *name)
{
	/* Section 0 has sh_addr 0. */
	return (void *)shdrs[find_sec(hdr, shdrs, secstrings, name)].sh_addr;
}

/* Find a module section, or NULL.  Fill in number of "objects" in section. */
static void *section_objs(Elf_Ehdr *hdr,
			  Elf_Shdr *sechdrs,
			  const char *secstrings,
			  const char *name,
			  size_t object_size,
			  unsigned int *num)
{
	unsigned int sec = find_sec(hdr, sechdrs, secstrings, name);

	/* Section 0 has sh_addr 0 and sh_size 0. */
	*num = sechdrs[sec].sh_size / object_size;
	return (void *)sechdrs[sec].sh_addr;
}

Linus Torvalds's avatar
Linus Torvalds committed
181 182 183 184 185
/* 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[];
186 187
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
188 189
extern const unsigned long __start___kcrctab[];
extern const unsigned long __start___kcrctab_gpl[];
190
extern const unsigned long __start___kcrctab_gpl_future[];
191 192 193 194 195
#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[];
196 197
extern const unsigned long __start___kcrctab_unused[];
extern const unsigned long __start___kcrctab_unused_gpl[];
198
#endif
Linus Torvalds's avatar
Linus Torvalds committed
199 200 201 202

#ifndef CONFIG_MODVERSIONS
#define symversion(base, idx) NULL
#else
Andrew Morton's avatar
Andrew Morton committed
203
#define symversion(base, idx) ((base != NULL) ? ((base) + (idx)) : NULL)
Linus Torvalds's avatar
Linus Torvalds committed
204 205
#endif

206 207 208 209 210 211 212
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,
					      unsigned int symnum, void *data),
				   void *data)
213
{
214
	unsigned int i, j;
215

216 217 218 219
	for (j = 0; j < arrsize; j++) {
		for (i = 0; i < arr[j].stop - arr[j].start; i++)
			if (fn(&arr[j], owner, i, data))
				return true;
220
	}
221 222

	return false;
223 224
}

225
/* Returns true as soon as fn returns true, otherwise false. */
226 227
bool each_symbol(bool (*fn)(const struct symsearch *arr, struct module *owner,
			    unsigned int symnum, void *data), void *data)
228 229 230 231
{
	struct module *mod;
	const struct symsearch arr[] = {
		{ __start___ksymtab, __stop___ksymtab, __start___kcrctab,
232
		  NOT_GPL_ONLY, false },
233
		{ __start___ksymtab_gpl, __stop___ksymtab_gpl,
234 235
		  __start___kcrctab_gpl,
		  GPL_ONLY, false },
236
		{ __start___ksymtab_gpl_future, __stop___ksymtab_gpl_future,
237 238
		  __start___kcrctab_gpl_future,
		  WILL_BE_GPL_ONLY, false },
239
#ifdef CONFIG_UNUSED_SYMBOLS
240
		{ __start___ksymtab_unused, __stop___ksymtab_unused,
241 242
		  __start___kcrctab_unused,
		  NOT_GPL_ONLY, true },
243
		{ __start___ksymtab_unused_gpl, __stop___ksymtab_unused_gpl,
244 245
		  __start___kcrctab_unused_gpl,
		  GPL_ONLY, true },
246
#endif
247
	};
248

249 250
	if (each_symbol_in_section(arr, ARRAY_SIZE(arr), NULL, fn, data))
		return true;
251

252
	list_for_each_entry_rcu(mod, &modules, list) {
253 254
		struct symsearch arr[] = {
			{ mod->syms, mod->syms + mod->num_syms, mod->crcs,
255
			  NOT_GPL_ONLY, false },
256
			{ mod->gpl_syms, mod->gpl_syms + mod->num_gpl_syms,
257 258
			  mod->gpl_crcs,
			  GPL_ONLY, false },
259 260
			{ mod->gpl_future_syms,
			  mod->gpl_future_syms + mod->num_gpl_future_syms,
261 262
			  mod->gpl_future_crcs,
			  WILL_BE_GPL_ONLY, false },
263
#ifdef CONFIG_UNUSED_SYMBOLS
264 265
			{ mod->unused_syms,
			  mod->unused_syms + mod->num_unused_syms,
266 267
			  mod->unused_crcs,
			  NOT_GPL_ONLY, true },
268 269
			{ mod->unused_gpl_syms,
			  mod->unused_gpl_syms + mod->num_unused_gpl_syms,
270 271
			  mod->unused_gpl_crcs,
			  GPL_ONLY, true },
272
#endif
273 274
		};

275 276 277 278 279
		if (each_symbol_in_section(arr, ARRAY_SIZE(arr), mod, fn, data))
			return true;
	}
	return false;
}
280
EXPORT_SYMBOL_GPL(each_symbol);
281 282 283 284 285 286 287 288 289 290

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

	/* Output */
	struct module *owner;
	const unsigned long *crc;
291
	const struct kernel_symbol *sym;
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
};

static bool find_symbol_in_section(const struct symsearch *syms,
				   struct module *owner,
				   unsigned int symnum, void *data)
{
	struct find_symbol_arg *fsa = data;

	if (strcmp(syms->start[symnum].name, fsa->name) != 0)
		return false;

	if (!fsa->gplok) {
		if (syms->licence == GPL_ONLY)
			return false;
		if (syms->licence == WILL_BE_GPL_ONLY && fsa->warn) {
			printk(KERN_WARNING "Symbol %s is being used "
			       "by a non-GPL module, which will not "
			       "be allowed in the future\n", fsa->name);
			printk(KERN_WARNING "Please see the file "
			       "Documentation/feature-removal-schedule.txt "
			       "in the kernel source tree for more details.\n");
313
		}
Linus Torvalds's avatar
Linus Torvalds committed
314
	}
315

316
#ifdef CONFIG_UNUSED_SYMBOLS
317 318 319 320 321 322 323 324 325 326 327
	if (syms->unused && fsa->warn) {
		printk(KERN_WARNING "Symbol %s is marked as UNUSED, "
		       "however this module is using it.\n", fsa->name);
		printk(KERN_WARNING
		       "This symbol will go away in the future.\n");
		printk(KERN_WARNING
		       "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");
	}
328
#endif
329 330 331

	fsa->owner = owner;
	fsa->crc = symversion(syms->crcs, symnum);
332
	fsa->sym = &syms->start[symnum];
333 334 335
	return true;
}

336
/* Find a symbol and return it, along with, (optional) crc and
337
 * (optional) module which owns it.  Needs preempt disabled or module_mutex. */
338 339 340 341 342
const struct kernel_symbol *find_symbol(const char *name,
					struct module **owner,
					const unsigned long **crc,
					bool gplok,
					bool warn)
343 344 345 346 347 348 349 350 351 352 353 354
{
	struct find_symbol_arg fsa;

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

	if (each_symbol(find_symbol_in_section, &fsa)) {
		if (owner)
			*owner = fsa.owner;
		if (crc)
			*crc = fsa.crc;
355
		return fsa.sym;
356 357
	}

Linus Torvalds's avatar
Linus Torvalds committed
358
	DEBUGP("Failed to find symbol %s\n", name);
359
	return NULL;
Linus Torvalds's avatar
Linus Torvalds committed
360
}
361
EXPORT_SYMBOL_GPL(find_symbol);
Linus Torvalds's avatar
Linus Torvalds committed
362 363

/* Search for module by name: must hold module_mutex. */
364
struct module *find_module(const char *name)
Linus Torvalds's avatar
Linus Torvalds committed
365 366 367 368 369 370 371 372 373
{
	struct module *mod;

	list_for_each_entry(mod, &modules, list) {
		if (strcmp(mod->name, name) == 0)
			return mod;
	}
	return NULL;
}
374
EXPORT_SYMBOL_GPL(find_module);
Linus Torvalds's avatar
Linus Torvalds committed
375 376

#ifdef CONFIG_SMP
377

378
static inline void __percpu *mod_percpu(struct module *mod)
379
{
380 381
	return mod->percpu;
}
382

383 384 385
static int percpu_modalloc(struct module *mod,
			   unsigned long size, unsigned long align)
{
386 387
	if (align > PAGE_SIZE) {
		printk(KERN_WARNING "%s: per-cpu alignment %li > %li\n",
388
		       mod->name, align, PAGE_SIZE);
389 390 391
		align = PAGE_SIZE;
	}

392 393
	mod->percpu = __alloc_reserved_percpu(size, align);
	if (!mod->percpu) {
394 395
		printk(KERN_WARNING
		       "Could not allocate %lu bytes percpu data\n", size);
396 397 398 399
		return -ENOMEM;
	}
	mod->percpu_size = size;
	return 0;
400 401
}

402
static void percpu_modfree(struct module *mod)
403
{
404
	free_percpu(mod->percpu);
405 406
}

407 408 409 410
static unsigned int find_pcpusec(Elf_Ehdr *hdr,
				 Elf_Shdr *sechdrs,
				 const char *secstrings)
{
411
	return find_sec(hdr, sechdrs, secstrings, ".data..percpu");
412 413
}

414 415
static void percpu_modcopy(struct module *mod,
			   const void *from, unsigned long size)
416 417 418 419
{
	int cpu;

	for_each_possible_cpu(cpu)
420
		memcpy(per_cpu_ptr(mod->percpu, cpu), from, size);
421 422
}

423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
/**
 * 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) {
		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;
455 456
}

Linus Torvalds's avatar
Linus Torvalds committed
457
#else /* ... !CONFIG_SMP */
458

459
static inline void __percpu *mod_percpu(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
460 461 462
{
	return NULL;
}
463 464 465 466 467 468
static inline int percpu_modalloc(struct module *mod,
				  unsigned long size, unsigned long align)
{
	return -ENOMEM;
}
static inline void percpu_modfree(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
469 470 471 472 473 474 475 476
{
}
static inline unsigned int find_pcpusec(Elf_Ehdr *hdr,
					Elf_Shdr *sechdrs,
					const char *secstrings)
{
	return 0;
}
477 478
static inline void percpu_modcopy(struct module *mod,
				  const void *from, unsigned long size)
Linus Torvalds's avatar
Linus Torvalds committed
479 480 481 482
{
	/* pcpusec should be 0, and size of that section should be 0. */
	BUG_ON(size != 0);
}
483 484 485 486
bool is_module_percpu_address(unsigned long addr)
{
	return false;
}
487

Linus Torvalds's avatar
Linus Torvalds committed
488 489
#endif /* CONFIG_SMP */

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
#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,   \
	                struct module *mod, char *buffer)             \
{                                                                     \
	return sprintf(buffer, "%s\n", mod->field);                   \
}                                                                     \
static int modinfo_##field##_exists(struct module *mod)               \
{                                                                     \
	return mod->field != NULL;                                    \
}                                                                     \
static void free_modinfo_##field(struct module *mod)                  \
{                                                                     \
506 507
	kfree(mod->field);                                            \
	mod->field = NULL;                                            \
508 509
}                                                                     \
static struct module_attribute modinfo_##field = {                    \
510
	.attr = { .name = __stringify(field), .mode = 0444 },         \
511 512 513 514 515 516 517 518 519
	.show = show_modinfo_##field,                                 \
	.setup = setup_modinfo_##field,                               \
	.test = modinfo_##field##_exists,                             \
	.free = free_modinfo_##field,                                 \
};

MODINFO_ATTR(version);
MODINFO_ATTR(srcversion);

520 521
static char last_unloaded_module[MODULE_NAME_LEN+1];

522
#ifdef CONFIG_MODULE_UNLOAD
523 524 525

EXPORT_TRACEPOINT_SYMBOL(module_get);

Linus Torvalds's avatar
Linus Torvalds committed
526
/* Init the unload section of the module. */
527
static int module_unload_init(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
528
{
529 530 531 532
	mod->refptr = alloc_percpu(struct module_ref);
	if (!mod->refptr)
		return -ENOMEM;

533 534
	INIT_LIST_HEAD(&mod->source_list);
	INIT_LIST_HEAD(&mod->target_list);
535

Linus Torvalds's avatar
Linus Torvalds committed
536
	/* Hold reference count during initialization. */
537
	__this_cpu_write(mod->refptr->incs, 1);
Linus Torvalds's avatar
Linus Torvalds committed
538 539
	/* Backwards compatibility macros put refcount during init. */
	mod->waiter = current;
540 541

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
542 543 544 545 546 547 548
}

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

549 550
	list_for_each_entry(use, &b->source_list, source_list) {
		if (use->source == a) {
Linus Torvalds's avatar
Linus Torvalds committed
551 552 553 554 555 556 557 558
			DEBUGP("%s uses %s!\n", a->name, b->name);
			return 1;
		}
	}
	DEBUGP("%s does not use %s!\n", a->name, b->name);
	return 0;
}

559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
/*
 * 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;

	DEBUGP("Allocating new usage for %s.\n", a->name);
	use = kmalloc(sizeof(*use), GFP_ATOMIC);
	if (!use) {
		printk(KERN_WARNING "%s: out of memory loading\n", a->name);
		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;
}

584
/* Module a uses b: caller needs module_mutex() */
585
int ref_module(struct module *a, struct module *b)
Linus Torvalds's avatar
Linus Torvalds committed
586
{
587
	int err;
Kay Sievers's avatar
Kay Sievers committed
588

589
	if (b == NULL || already_uses(a, b))
590 591
		return 0;

592 593
	/* If module isn't available, we fail. */
	err = strong_try_module_get(b);
594
	if (err)
595
		return err;
Linus Torvalds's avatar
Linus Torvalds committed
596

597 598
	err = add_module_usage(a, b);
	if (err) {
Linus Torvalds's avatar
Linus Torvalds committed
599
		module_put(b);
600
		return err;
Linus Torvalds's avatar
Linus Torvalds committed
601
	}
602
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
603
}
604
EXPORT_SYMBOL_GPL(ref_module);
Linus Torvalds's avatar
Linus Torvalds committed
605 606 607 608

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

611
	mutex_lock(&module_mutex);
612 613 614 615 616 617 618
	list_for_each_entry_safe(use, tmp, &mod->target_list, target_list) {
		struct module *i = use->target;
		DEBUGP("%s unusing %s\n", mod->name, i->name);
		module_put(i);
		list_del(&use->source_list);
		list_del(&use->target_list);
		kfree(use);
Linus Torvalds's avatar
Linus Torvalds committed
619
	}
620
	mutex_unlock(&module_mutex);
621 622

	free_percpu(mod->refptr);
Linus Torvalds's avatar
Linus Torvalds committed
623 624 625
}

#ifdef CONFIG_MODULE_FORCE_UNLOAD
626
static inline int try_force_unload(unsigned int flags)
Linus Torvalds's avatar
Linus Torvalds committed
627 628 629
{
	int ret = (flags & O_TRUNC);
	if (ret)
630
		add_taint(TAINT_FORCED_RMMOD);
Linus Torvalds's avatar
Linus Torvalds committed
631 632 633
	return ret;
}
#else
634
static inline int try_force_unload(unsigned int flags)
Linus Torvalds's avatar
Linus Torvalds committed
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
{
	return 0;
}
#endif /* CONFIG_MODULE_FORCE_UNLOAD */

struct stopref
{
	struct module *mod;
	int flags;
	int *forced;
};

/* Whole machine is stopped with interrupts off when this runs. */
static int __try_stop_module(void *_sref)
{
	struct stopref *sref = _sref;

652 653
	/* If it's not unused, quit unless we're forcing. */
	if (module_refcount(sref->mod) != 0) {
654
		if (!(*sref->forced = try_force_unload(sref->flags)))
Linus Torvalds's avatar
Linus Torvalds committed
655 656 657 658 659 660 661 662 663 664
			return -EWOULDBLOCK;
	}

	/* Mark it as dying. */
	sref->mod->state = MODULE_STATE_GOING;
	return 0;
}

static int try_stop_module(struct module *mod, int flags, int *forced)
{
665 666
	if (flags & O_NONBLOCK) {
		struct stopref sref = { mod, flags, forced };
Linus Torvalds's avatar
Linus Torvalds committed
667

668
		return stop_machine(__try_stop_module, &sref, NULL);
669 670 671 672 673 674
	} else {
		/* We don't need to stop the machine for this. */
		mod->state = MODULE_STATE_GOING;
		synchronize_sched();
		return 0;
	}
Linus Torvalds's avatar
Linus Torvalds committed
675 676 677 678
}

unsigned int module_refcount(struct module *mod)
{
679
	unsigned int incs = 0, decs = 0;
680
	int cpu;
Linus Torvalds's avatar
Linus Torvalds committed
681

682
	for_each_possible_cpu(cpu)
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
		decs += per_cpu_ptr(mod->refptr, cpu)->decs;
	/*
	 * ensure the incs are added up after the decs.
	 * module_put ensures incs are visible before decs with smp_wmb.
	 *
	 * This 2-count scheme avoids the situation where the refcount
	 * for CPU0 is read, then CPU0 increments the module refcount,
	 * then CPU1 drops that refcount, then the refcount for CPU1 is
	 * read. We would record a decrement but not its corresponding
	 * increment so we would see a low count (disaster).
	 *
	 * Rare situation? But module_refcount can be preempted, and we
	 * might be tallying up 4096+ CPUs. So it is not impossible.
	 */
	smp_rmb();
	for_each_possible_cpu(cpu)
		incs += per_cpu_ptr(mod->refptr, cpu)->incs;
	return incs - decs;
Linus Torvalds's avatar
Linus Torvalds committed
701 702 703 704 705 706 707 708
}
EXPORT_SYMBOL(module_refcount);

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

static void wait_for_zero_refcount(struct module *mod)
{
709
	/* Since we might sleep for some time, release the mutex first */
710
	mutex_unlock(&module_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
711 712 713 714 715 716 717 718
	for (;;) {
		DEBUGP("Looking at refcount...\n");
		set_current_state(TASK_UNINTERRUPTIBLE);
		if (module_refcount(mod) == 0)
			break;
		schedule();
	}
	current->state = TASK_RUNNING;
719
	mutex_lock(&module_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
720 721
}

722 723
SYSCALL_DEFINE2(delete_module, const char __user *, name_user,
		unsigned int, flags)
Linus Torvalds's avatar
Linus Torvalds committed
724 725
{
	struct module *mod;
726
	char name[MODULE_NAME_LEN];
Linus Torvalds's avatar
Linus Torvalds committed
727 728
	int ret, forced = 0;

729
	if (!capable(CAP_SYS_MODULE) || modules_disabled)
730 731 732 733 734 735
		return -EPERM;

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

736 737
	if (mutex_lock_interruptible(&module_mutex) != 0)
		return -EINTR;
Linus Torvalds's avatar
Linus Torvalds committed
738 739 740 741 742 743 744

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

745
	if (!list_empty(&mod->source_list)) {
Linus Torvalds's avatar
Linus Torvalds committed
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
		/* 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) {
		/* FIXME: if (force), slam module count and wake up
                   waiter --RR */
		DEBUGP("%s already dying\n", mod->name);
		ret = -EBUSY;
		goto out;
	}

	/* If it has an init func, it must have an exit func to unload */
761
	if (mod->init && !mod->exit) {
762
		forced = try_force_unload(flags);
Linus Torvalds's avatar
Linus Torvalds committed
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
		if (!forced) {
			/* This module can't be removed */
			ret = -EBUSY;
			goto out;
		}
	}

	/* Set this up before setting mod->state */
	mod->waiter = current;

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

	/* Never wait if forced. */
	if (!forced && module_refcount(mod) != 0)
		wait_for_zero_refcount(mod);

782
	mutex_unlock(&module_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
783
	/* Final destruction now noone is using it. */
784
	if (mod->exit != NULL)
Linus Torvalds's avatar
Linus Torvalds committed
785
		mod->exit();
786 787
	blocking_notifier_call_chain(&module_notify_list,
				     MODULE_STATE_GOING, mod);
788
	async_synchronize_full();
789

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

793 794 795
	free_module(mod);
	return 0;
out:
796
	mutex_unlock(&module_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
797 798 799
	return ret;
}

800
static inline void print_unload_info(struct seq_file *m, struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
801 802 803 804 805 806 807 808
{
	struct module_use *use;
	int printed_something = 0;

	seq_printf(m, " %u ", module_refcount(mod));

	/* Always include a trailing , so userspace can differentiate
           between this and the old multi-field proc format. */
809
	list_for_each_entry(use, &mod->source_list, source_list) {
Linus Torvalds's avatar
Linus Torvalds committed
810
		printed_something = 1;
811
		seq_printf(m, "%s,", use->source->name);
Linus Torvalds's avatar
Linus Torvalds committed
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
	}

	if (mod->init != NULL && mod->exit == NULL) {
		printed_something = 1;
		seq_printf(m, "[permanent],");
	}

	if (!printed_something)
		seq_printf(m, "-");
}

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

Rusty Russell's avatar
Rusty Russell committed
827
	preempt_disable();
828
	if (!find_symbol(symbol, &owner, NULL, true, false))
Linus Torvalds's avatar
Linus Torvalds committed
829 830
		BUG();
	module_put(owner);
Rusty Russell's avatar
Rusty Russell committed
831
	preempt_enable();
Linus Torvalds's avatar
Linus Torvalds committed
832 833 834
}
EXPORT_SYMBOL(__symbol_put);

835
/* Note this assumes addr is a function, which it currently always is. */
Linus Torvalds's avatar
Linus Torvalds committed
836 837
void symbol_put_addr(void *addr)
{
838
	struct module *modaddr;
839
	unsigned long a = (unsigned long)dereference_function_descriptor(addr);
Linus Torvalds's avatar
Linus Torvalds committed
840

841
	if (core_kernel_text(a))
842
		return;
Linus Torvalds's avatar
Linus Torvalds committed
843

844 845
	/* module_text_address is safe here: we're supposed to have reference
	 * to module from symbol_get, so it can't go away. */
846
	modaddr = __module_text_address(a);
847
	BUG_ON(!modaddr);
848
	module_put(modaddr);
Linus Torvalds's avatar
Linus Torvalds committed
849 850 851 852 853 854
}
EXPORT_SYMBOL_GPL(symbol_put_addr);

static ssize_t show_refcnt(struct module_attribute *mattr,
			   struct module *mod, char *buffer)
{
855
	return sprintf(buffer, "%u\n", module_refcount(mod));
Linus Torvalds's avatar
Linus Torvalds committed
856 857 858
}

static struct module_attribute refcnt = {
859
	.attr = { .name = "refcnt", .mode = 0444 },
Linus Torvalds's avatar
Linus Torvalds committed
860 861 862
	.show = show_refcnt,
};

Al Viro's avatar
Al Viro committed
863 864 865
void module_put(struct module *module)
{
	if (module) {
866
		preempt_disable();
867 868
		smp_wmb(); /* see comment in module_refcount */
		__this_cpu_inc(module->refptr->decs);
869

870
		trace_module_put(module, _RET_IP_);
Al Viro's avatar
Al Viro committed
871 872 873
		/* Maybe they're waiting for us to drop reference? */
		if (unlikely(!module_is_live(module)))
			wake_up_process(module->waiter);
874
		preempt_enable();
Al Viro's avatar
Al Viro committed
875 876 877 878
	}
}
EXPORT_SYMBOL(module_put);

Linus Torvalds's avatar
Linus Torvalds committed
879
#else /* !CONFIG_MODULE_UNLOAD */
880
static inline void print_unload_info(struct seq_file *m, struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
881 882 883 884 885 886 887 888 889
{
	/* We don't know the usage count, or what modules are using. */
	seq_printf(m, " - -");
}

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

890
int ref_module(struct module *a, struct module *b)
Linus Torvalds's avatar
Linus Torvalds committed
891
{
892
	return strong_try_module_get(b);
Linus Torvalds's avatar
Linus Torvalds committed
893
}
894
EXPORT_SYMBOL_GPL(ref_module);
Linus Torvalds's avatar
Linus Torvalds committed
895

896
static inline int module_unload_init(struct module *mod)
Linus Torvalds's avatar
Linus Torvalds committed
897
{
898
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
899 900 901
}
#endif /* CONFIG_MODULE_UNLOAD */

902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
static ssize_t show_initstate(struct module_attribute *mattr,
			   struct module *mod, char *buffer)
{
	const char *state = "unknown";

	switch (mod->state) {
	case MODULE_STATE_LIVE:
		state = "live";
		break;
	case MODULE_STATE_COMING:
		state = "coming";
		break;
	case MODULE_STATE_GOING:
		state = "going";
		break;
	}
	return sprintf(buffer, "%s\n", state);
}

static struct module_attribute initstate = {
922
	.attr = { .name = "initstate", .mode = 0444 },
923 924 925
	.show = show_initstate,
};

926 927 928
static struct module_attribute *modinfo_attrs[] = {
	&modinfo_version,
	&modinfo_srcversion,
929
	&initstate,
930 931 932 933 934 935
#ifdef CONFIG_MODULE_UNLOAD
	&refcnt,
#endif
	NULL,
};

Linus Torvalds's avatar
Linus Torvalds committed
936 937
static const char vermagic[] = VERMAGIC_STRING;

938
static int try_to_force_load(struct module *mod, const char *reason)
939 940
{
#ifdef CONFIG_MODULE_FORCE_LOAD
Andi Kleen's avatar
Andi Kleen committed
941
	if (!test_taint(TAINT_FORCED_MODULE))
942 943
		printk(KERN_WARNING "%s: %s: kernel tainted.\n",
		       mod->name, reason);
944 945 946 947 948 949 950
	add_taint_module(mod, TAINT_FORCED_MODULE);
	return 0;
#else
	return -ENOEXEC;
#endif
}

Linus Torvalds's avatar
Linus Torvalds committed
951
#ifdef CONFIG_MODVERSIONS
952 953 954 955 956 957 958 959 960 961 962
/* 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
963 964 965 966
static int check_version(Elf_Shdr *sechdrs,
			 unsigned int versindex,
			 const char *symname,
			 struct module *mod, 
967 968
			 const unsigned long *crc,
			 const struct module *crc_owner)
Linus Torvalds's avatar
Linus Torvalds committed
969 970 971 972 973 974 975 976
{
	unsigned int i, num_versions;
	struct modversion_info *versions;

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

977 978 979 980
	/* No versions at all?  modprobe --force does this. */
	if (versindex == 0)
		return try_to_force_load(mod, symname) == 0;

Linus Torvalds's avatar
Linus Torvalds committed
981 982 983 984 985 986 987 988
	versions = (void *) sechdrs[versindex].sh_addr;
	num_versions = sechdrs[versindex].sh_size
		/ sizeof(struct modversion_info);

	for (i = 0; i < num_versions; i++) {
		if (strcmp(versions[i].name, symname) != 0)
			continue;

989
		if (versions[i].crc == maybe_relocated(*crc, crc_owner))
Linus Torvalds's avatar
Linus Torvalds committed
990 991
			return 1;
		DEBUGP("Found checksum %lX vs module %lX\n",
992
		       maybe_relocated(*crc, crc_owner), versions[i].crc);
993
		goto bad_version;
Linus Torvalds's avatar
Linus Torvalds committed
994
	}
995

996 997 998
	printk(KERN_WARNING "%s: no symbol version for %s\n",
	       mod->name, symname);
	return 0;
999 1000 1001 1002 1003

bad_version:
	printk("%s: disagrees about version of symbol %s\n",
	       mod->name, symname);
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
1004 1005 1006 1007 1008 1009 1010 1011
}

static inline int check_modstruct_version(Elf_Shdr *sechdrs,
					  unsigned int versindex,
					  struct module *mod)
{
	const unsigned long *crc;

1012 1013
	/* Since this should be found in kernel (which can't be removed),
	 * no locking is necessary. */
1014 1015
	if (!find_symbol(MODULE_SYMBOL_PREFIX "module_layout", NULL,
			 &crc, true, false))
Linus Torvalds's avatar
Linus Torvalds committed
1016
		BUG();
1017 1018
	return check_version(sechdrs, versindex, "module_layout", mod, crc,
			     NULL);
Linus Torvalds's avatar
Linus Torvalds committed
1019 1020
}

1021 1022 1023
/* First part is kernel version, which we ignore if module has crcs. */
static inline int same_magic(const char *amagic, const char *bmagic,
			     bool has_crcs)
Linus Torvalds's avatar
Linus Torvalds committed
1024
{
1025 1026 1027 1028
	if (has_crcs) {
		amagic += strcspn(amagic, " ");
		bmagic += strcspn(bmagic, " ");
	}
Linus Torvalds's avatar
Linus Torvalds committed
1029 1030 1031 1032 1033 1034 1035
	return strcmp(amagic, bmagic) == 0;
}
#else
static inline int check_version(Elf_Shdr *sechdrs,
				unsigned int versindex,
				const char *symname,
				struct module *mod, 
1036 1037
				const unsigned long *crc,
				const struct module *crc_owner)
Linus Torvalds's avatar
Linus Torvalds committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
{
	return 1;
}

static inline int check_modstruct_version(Elf_Shdr *sechdrs,
					  unsigned int versindex,
					  struct module *mod)
{
	return 1;
}

1049 1050
static inline int same_magic(const char *amagic, const char *bmagic,
			     bool has_crcs)
Linus Torvalds's avatar
Linus Torvalds committed
1051 1052 1053 1054 1055
{
	return strcmp(amagic, bmagic) == 0;
}
#endif /* CONFIG_MODVERSIONS */

1056
/* Resolve a symbol for this module.  I.e. if we find one, record usage. */
1057 1058 1059
static const struct kernel_symbol *resolve_symbol(Elf_Shdr *sechdrs,
						  unsigned int versindex,
						  const char *name,
1060 1061
						  struct module *mod,
						  char ownername[])
Linus Torvalds's avatar
Linus Torvalds committed
1062 1063
{
	struct module *owner;
1064
	const struct kernel_symbol *sym;
Linus Torvalds's avatar
Linus Torvalds committed
1065
	const unsigned long *crc;
1066
	int err;
Linus Torvalds's avatar
Linus Torvalds committed
1067

1068
	mutex_lock(&module_mutex);
1069
	sym = find_symbol(name, &owner, &crc,
Andi Kleen's avatar
Andi Kleen committed
1070
			  !(mod->taints & (1 << TAINT_PROPRIETARY_MODULE)), true);
1071 1072 1073 1074 1075 1076
	if (!sym)
		goto unlock;

	if (!check_version(sechdrs, versindex, name, mod, crc, owner)) {
		sym = ERR_PTR(-EINVAL);
		goto getname;
Linus Torvalds's avatar
Linus Torvalds committed
1077
	}
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088

	err = ref_module(mod, owner);
	if (err) {
		sym = ERR_PTR(err);
		goto getname;
	}

getname:
	/* We must make copy under the lock if we failed to get ref. */
	strncpy(ownername, module_name(owner), MODULE_NAME_LEN);
unlock:
1089
	mutex_unlock(&module_mutex);
1090
	return sym;
Linus Torvalds's avatar
Linus Torvalds committed
1091 1092
}

1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
static const struct kernel_symbol *resolve_symbol_wait(Elf_Shdr *sechdrs,
						       unsigned int versindex,
						       const char *name,
						       struct module *mod)
{
	const struct kernel_symbol *ksym;
	char ownername[MODULE_NAME_LEN];

	if (wait_event_interruptible_timeout(module_wq,
			!IS_ERR(ksym = resolve_symbol(sechdrs, versindex, name,
						      mod, ownername)) ||
			PTR_ERR(ksym) != -EBUSY,
					     30 * HZ) <= 0) {
		printk(KERN_WARNING "%s: gave up waiting for init of module %s.\n",
		       mod->name, ownername);
	}
	return ksym;
}

Linus Torvalds's avatar
Linus Torvalds committed
1112 1113 1114 1115
/*
 * /sys/module/foo/sections stuff
 * J. Corbet <corbet@lwn.net>
 */
1116
#if defined(CONFIG_KALLSYMS) && defined(CONFIG_SYSFS)
1117 1118 1119 1120 1121 1122

static inline bool sect_empty(const Elf_Shdr *sect)
{
	return !(sect->sh_flags & SHF_ALLOC) || sect->sh_size == 0;
}

1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
struct module_sect_attr
{
	struct module_attribute mattr;
	char *name;
	unsigned long address;
};

struct module_sect_attrs
{
	struct attribute_group grp;
	unsigned int nsections;
	struct module_sect_attr attrs[0];
};

Linus Torvalds's avatar
Linus Torvalds committed
1137 1138 1139 1140 1141 1142 1143 1144
static ssize_t module_sect_show(struct module_attribute *mattr,
				struct module *mod, char *buf)
{
	struct module_sect_attr *sattr =
		container_of(mattr, struct module_sect_attr, mattr);
	return sprintf(buf, "0x%lx\n", sattr->address);
}

1145 1146
static void free_sect_attrs(struct module_sect_attrs *sect_attrs)
{
1147
	unsigned int section;
1148 1149 1150 1151 1152 1153

	for (section = 0; section < sect_attrs->nsections; section++)
		kfree(sect_attrs->attrs[section].name);
	kfree(sect_attrs);
}

Linus Torvalds's avatar
Linus Torvalds committed
1154 1155 1156 1157 1158 1159 1160
static void add_sect_attrs(struct module *mod, unsigned int nsect,
		char *secstrings, Elf_Shdr *sechdrs)
{
	unsigned int nloaded = 0, i, size[2];
	struct module_sect_attrs *sect_attrs;
	struct module_sect_attr *sattr;
	struct attribute **gattr;
1161

Linus Torvalds's avatar
Linus Torvalds committed
1162 1163
	/* Count loaded sections and allocate structures */
	for (i = 0; i < nsect; i++)
1164
		if (!sect_empty(&sechdrs[i]))
Linus Torvalds's avatar
Linus Torvalds committed
1165 1166 1167