module.h 24.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13
#ifndef _LINUX_MODULE_H
#define _LINUX_MODULE_H
/*
 * Dynamic loading of modules into the kernel.
 *
 * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
 * Rewritten again by Rusty Russell, 2002
 */
#include <linux/list.h>
#include <linux/stat.h>
#include <linux/compiler.h>
#include <linux/cache.h>
#include <linux/kmod.h>
14
#include <linux/init.h>
L
Linus Torvalds 已提交
15 16 17 18
#include <linux/elf.h>
#include <linux/stringify.h>
#include <linux/kobject.h>
#include <linux/moduleparam.h>
19
#include <linux/jump_label.h>
20
#include <linux/export.h>
21
#include <linux/rbtree_latch.h>
22
#include <linux/error-injection.h>
23
#include <linux/tracepoint-defs.h>
24
#include <linux/srcu.h>
L
Linus Torvalds 已提交
25

26
#include <linux/percpu.h>
L
Linus Torvalds 已提交
27 28
#include <asm/module.h>

R
Rusty Russell 已提交
29 30 31
/* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
#define MODULE_SIG_STRING "~Module signature appended~\n"

L
Linus Torvalds 已提交
32 33 34
/* Not Yet Implemented */
#define MODULE_SUPPORTED_DEVICE(name)

35
#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
L
Linus Torvalds 已提交
36

S
Seunghun Lee 已提交
37
struct modversion_info {
L
Linus Torvalds 已提交
38 39 40 41 42
	unsigned long crc;
	char name[MODULE_NAME_LEN];
};

struct module;
43
struct exception_table_entry;
L
Linus Torvalds 已提交
44

45 46 47 48 49
struct module_kobject {
	struct kobject kobj;
	struct module *mod;
	struct kobject *drivers_dir;
	struct module_param_attrs *mp;
50
	struct completion *kobj_completion;
51
} __randomize_layout;
52

L
Linus Torvalds 已提交
53
struct module_attribute {
54 55 56 57
	struct attribute attr;
	ssize_t (*show)(struct module_attribute *, struct module_kobject *,
			char *);
	ssize_t (*store)(struct module_attribute *, struct module_kobject *,
L
Linus Torvalds 已提交
58
			 const char *, size_t count);
59 60 61
	void (*setup)(struct module *, const char *);
	int (*test)(struct module *);
	void (*free)(struct module *);
L
Linus Torvalds 已提交
62 63
};

64 65 66 67
struct module_version_attribute {
	struct module_attribute mattr;
	const char *module_name;
	const char *version;
68
} __attribute__ ((__aligned__(sizeof(void *))));
69

70
extern ssize_t __modver_version_show(struct module_attribute *,
71
				     struct module_kobject *, char *);
72

73
extern struct module_attribute module_uevent;
L
Linus Torvalds 已提交
74 75 76 77 78

/* These are either module local, or the kernel's dummy ones. */
extern int init_module(void);
extern void cleanup_module(void);

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
#ifndef MODULE
/**
 * module_init() - driver initialization entry point
 * @x: function to be run at kernel boot time or module insertion
 *
 * module_init() will either be called during do_initcalls() (if
 * builtin) or at module insertion time (if a module).  There can only
 * be one per module.
 */
#define module_init(x)	__initcall(x);

/**
 * module_exit() - driver exit entry point
 * @x: function to be run when driver is removed
 *
 * module_exit() will wrap the driver clean-up code
 * with cleanup_module() when used with rmmod when
 * the driver is a module.  If the driver is statically
 * compiled into the kernel, module_exit() has no effect.
 * There can only be one per module.
 */
#define module_exit(x)	__exitcall(x);

#else /* MODULE */

/*
 * In most cases loadable modules do not need custom
 * initcall levels. There are still some valid cases where
 * a driver may be needed early if built in, and does not
 * matter when built as a loadable module. Like bus
 * snooping debug drivers.
 */
#define early_initcall(fn)		module_init(fn)
#define core_initcall(fn)		module_init(fn)
#define core_initcall_sync(fn)		module_init(fn)
#define postcore_initcall(fn)		module_init(fn)
#define postcore_initcall_sync(fn)	module_init(fn)
#define arch_initcall(fn)		module_init(fn)
#define subsys_initcall(fn)		module_init(fn)
#define subsys_initcall_sync(fn)	module_init(fn)
#define fs_initcall(fn)			module_init(fn)
#define fs_initcall_sync(fn)		module_init(fn)
#define rootfs_initcall(fn)		module_init(fn)
#define device_initcall(fn)		module_init(fn)
#define device_initcall_sync(fn)	module_init(fn)
#define late_initcall(fn)		module_init(fn)
#define late_initcall_sync(fn)		module_init(fn)

#define console_initcall(fn)		module_init(fn)

/* Each module must use one module_init(). */
#define module_init(initfn)					\
131
	static inline initcall_t __maybe_unused __inittest(void)		\
132
	{ return initfn; }					\
133
	int init_module(void) __copy(initfn) __attribute__((alias(#initfn)));
134 135 136

/* This is only required if you want to be unloadable. */
#define module_exit(exitfn)					\
137
	static inline exitcall_t __maybe_unused __exittest(void)		\
138
	{ return exitfn; }					\
139
	void cleanup_module(void) __copy(exitfn) __attribute__((alias(#exitfn)));
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160

#endif

/* This means "can be init if no module support, otherwise module load
   may call it." */
#ifdef CONFIG_MODULES
#define __init_or_module
#define __initdata_or_module
#define __initconst_or_module
#define __INIT_OR_MODULE	.text
#define __INITDATA_OR_MODULE	.data
#define __INITRODATA_OR_MODULE	.section ".rodata","a",%progbits
#else
#define __init_or_module __init
#define __initdata_or_module __initdata
#define __initconst_or_module __initconst
#define __INIT_OR_MODULE __INIT
#define __INITDATA_OR_MODULE __INITDATA
#define __INITRODATA_OR_MODULE __INITRODATA
#endif /*CONFIG_MODULES*/

L
Linus Torvalds 已提交
161 162 163 164 165 166
/* Generic info of form tag = "info" */
#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)

/* For userspace: you can also call me... */
#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)

167 168 169 170 171
/* Soft module dependencies. See man modprobe.d for details.
 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
 */
#define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)

L
Linus Torvalds 已提交
172 173 174 175
/*
 * The following license idents are currently accepted as indicating free
 * software modules
 *
176
 *	"GPL"				[GNU Public License v2]
L
Linus Torvalds 已提交
177 178 179 180
 *	"GPL v2"			[GNU Public License v2]
 *	"GPL and additional rights"	[GNU Public License v2 rights and more]
 *	"Dual BSD/GPL"			[GNU Public License v2
 *					 or BSD license choice]
181 182
 *	"Dual MIT/GPL"			[GNU Public License v2
 *					 or MIT license choice]
L
Linus Torvalds 已提交
183 184 185 186 187 188 189
 *	"Dual MPL/GPL"			[GNU Public License v2
 *					 or Mozilla license choice]
 *
 * The following other idents are available
 *
 *	"Proprietary"			[Non free products]
 *
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
 * Both "GPL v2" and "GPL" (the latter also in dual licensed strings) are
 * merely stating that the module is licensed under the GPL v2, but are not
 * telling whether "GPL v2 only" or "GPL v2 or later". The reason why there
 * are two variants is a historic and failed attempt to convey more
 * information in the MODULE_LICENSE string. For module loading the
 * "only/or later" distinction is completely irrelevant and does neither
 * replace the proper license identifiers in the corresponding source file
 * nor amends them in any way. The sole purpose is to make the
 * 'Proprietary' flagging work and to refuse to bind symbols which are
 * exported with EXPORT_SYMBOL_GPL when a non free module is loaded.
 *
 * In the same way "BSD" is not a clear license information. It merely
 * states, that the module is licensed under one of the compatible BSD
 * license variants. The detailed and correct license information is again
 * to be found in the corresponding source files.
 *
L
Linus Torvalds 已提交
206 207 208 209 210
 * There are dual licensed components, but when running with Linux it is the
 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
 * is a GPL combined work.
 *
 * This exists for several reasons
S
Seunghun Lee 已提交
211
 * 1.	So modinfo can show license info for users wanting to vet their setup
L
Linus Torvalds 已提交
212 213 214 215 216 217
 *	is free
 * 2.	So the community can ignore bug reports including proprietary modules
 * 3.	So vendors can do likewise based on their own policies
 */
#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)

218 219 220 221
/*
 * Author(s), use "Name <email>" or just "Name", for multiple
 * authors use multiple MODULE_AUTHOR() statements/lines.
 */
L
Linus Torvalds 已提交
222
#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
S
Seunghun Lee 已提交
223

L
Linus Torvalds 已提交
224 225 226
/* What your module does. */
#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)

227 228 229
#ifdef MODULE
/* Creates an alias so file2alias.c can find device table. */
#define MODULE_DEVICE_TABLE(type, name)					\
230
extern typeof(name) __mod_##type##__##name##_device_table		\
231 232 233 234
  __attribute__ ((unused, alias(__stringify(name))))
#else  /* !MODULE */
#define MODULE_DEVICE_TABLE(type, name)
#endif
L
Linus Torvalds 已提交
235 236

/* Version of form [<epoch>:]<version>[-<extra-version>].
S
Seunghun Lee 已提交
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
 * Or for CVS/RCS ID version, everything but the number is stripped.
 * <epoch>: A (small) unsigned integer which allows you to start versions
 * anew. If not mentioned, it's zero.  eg. "2:1.0" is after
 * "1:2.0".

 * <version>: The <version> may contain only alphanumerics and the
 * character `.'.  Ordered by numeric sort for numeric parts,
 * ascii sort for ascii parts (as per RPM or DEB algorithm).

 * <extraversion>: Like <version>, but inserted for local
 * customizations, eg "rh3" or "rusty1".

 * Using this automatically adds a checksum of the .c files and the
 * local headers in "srcversion".
 */
252

253
#if defined(MODULE) || !defined(CONFIG_SYSFS)
L
Linus Torvalds 已提交
254
#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
255 256
#else
#define MODULE_VERSION(_version)					\
257
	MODULE_INFO(version, _version);					\
258
	static struct module_version_attribute ___modver_attr = {	\
259 260 261 262 263 264 265 266 267
		.mattr	= {						\
			.attr	= {					\
				.name	= "version",			\
				.mode	= S_IRUGO,			\
			},						\
			.show	= __modver_version_show,		\
		},							\
		.module_name	= KBUILD_MODNAME,			\
		.version	= _version,				\
268 269 270 271
	};								\
	static const struct module_version_attribute			\
	__used __attribute__ ((__section__ ("__modver")))		\
	* __moduleparam_const __modver_attr = &___modver_attr
272
#endif
L
Linus Torvalds 已提交
273

274 275 276 277 278
/* Optional firmware file (or files) needed by the module
 * format is simply firmware file name.  Multiple firmware
 * files require multiple MODULE_FIRMWARE() specifiers */
#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)

L
Linus Torvalds 已提交
279 280 281 282
struct notifier_block;

#ifdef CONFIG_MODULES

283 284
#define MODULE_IMPORT_NS(ns) MODULE_INFO(import_ns, #ns)

D
Dave Young 已提交
285
extern int modules_disabled; /* for sysctl */
L
Linus Torvalds 已提交
286 287 288
/* Get/put a kernel symbol (calls must be symmetric) */
void *__symbol_get(const char *symbol);
void *__symbol_get_gpl(const char *symbol);
289
#define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
L
Linus Torvalds 已提交
290

291 292 293 294 295 296 297
/* modules using other modules: kdb wants to see this. */
struct module_use {
	struct list_head source_list;
	struct list_head target_list;
	struct module *source, *target;
};

298 299 300 301 302
enum module_state {
	MODULE_STATE_LIVE,	/* Normal state. */
	MODULE_STATE_COMING,	/* Full formed, running module_init. */
	MODULE_STATE_GOING,	/* Going away. */
	MODULE_STATE_UNFORMED,	/* Still setting it up. */
L
Linus Torvalds 已提交
303 304
};

305 306 307 308 309
struct mod_tree_node {
	struct module *mod;
	struct latch_tree_node node;
};

310 311 312 313 314 315 316 317 318
struct module_layout {
	/* The actual code + data. */
	void *base;
	/* Total size. */
	unsigned int size;
	/* The size of the executable code.  */
	unsigned int text_size;
	/* Size of RO section of the module (text+rodata) */
	unsigned int ro_size;
J
Jessica Yu 已提交
319 320
	/* Size of RO after init section */
	unsigned int ro_after_init_size;
321 322 323 324 325 326 327 328 329 330 331 332 333

#ifdef CONFIG_MODULES_TREE_LOOKUP
	struct mod_tree_node mtn;
#endif
};

#ifdef CONFIG_MODULES_TREE_LOOKUP
/* Only touch one cacheline for common rbtree-for-core-layout case. */
#define __module_layout_align ____cacheline_aligned
#else
#define __module_layout_align
#endif

334 335 336 337
struct mod_kallsyms {
	Elf_Sym *symtab;
	unsigned int num_symtab;
	char *strtab;
338
	char *typetab;
339 340
};

341 342 343 344 345 346 347 348 349
#ifdef CONFIG_LIVEPATCH
struct klp_modinfo {
	Elf_Ehdr hdr;
	Elf_Shdr *sechdrs;
	char *secstrings;
	unsigned int symndx;
};
#endif

S
Seunghun Lee 已提交
350
struct module {
L
Linus Torvalds 已提交
351 352 353 354 355 356 357 358 359 360
	enum module_state state;

	/* Member of list of modules */
	struct list_head list;

	/* Unique handle for this module */
	char name[MODULE_NAME_LEN];

	/* Sysfs stuff. */
	struct module_kobject mkobj;
361
	struct module_attribute *modinfo_attrs;
362 363
	const char *version;
	const char *srcversion;
K
Kay Sievers 已提交
364
	struct kobject *holders_dir;
L
Linus Torvalds 已提交
365 366 367

	/* Exported symbols */
	const struct kernel_symbol *syms;
368
	const s32 *crcs;
369
	unsigned int num_syms;
L
Linus Torvalds 已提交
370

371
	/* Kernel parameters. */
372
#ifdef CONFIG_SYSFS
373
	struct mutex param_lock;
374
#endif
375 376 377
	struct kernel_param *kp;
	unsigned int num_kp;

L
Linus Torvalds 已提交
378 379
	/* GPL-only exported symbols. */
	unsigned int num_gpl_syms;
380
	const struct kernel_symbol *gpl_syms;
381
	const s32 *gpl_crcs;
L
Linus Torvalds 已提交
382

383
#ifdef CONFIG_UNUSED_SYMBOLS
384 385
	/* unused exported symbols. */
	const struct kernel_symbol *unused_syms;
386
	const s32 *unused_crcs;
387 388
	unsigned int num_unused_syms;

389 390
	/* GPL-only, unused exported symbols. */
	unsigned int num_unused_gpl_syms;
391
	const struct kernel_symbol *unused_gpl_syms;
392
	const s32 *unused_gpl_crcs;
393
#endif
394

R
Rusty Russell 已提交
395 396 397 398 399
#ifdef CONFIG_MODULE_SIG
	/* Signature was verified. */
	bool sig_ok;
#endif

400 401
	bool async_probe_requested;

402 403
	/* symbols that will be GPL-only in the near future. */
	const struct kernel_symbol *gpl_future_syms;
404
	const s32 *gpl_future_crcs;
405
	unsigned int num_gpl_future_syms;
406

L
Linus Torvalds 已提交
407 408
	/* Exception table */
	unsigned int num_exentries;
R
Rusty Russell 已提交
409
	struct exception_table_entry *extable;
L
Linus Torvalds 已提交
410 411 412 413

	/* Startup function. */
	int (*init)(void);

414 415 416
	/* Core layout: rbtree is accessed frequently, so keep together. */
	struct module_layout core_layout __module_layout_align;
	struct module_layout init_layout;
417

L
Linus Torvalds 已提交
418 419 420
	/* Arch-specific module values */
	struct mod_arch_specific arch;

421
	unsigned long taints;	/* same bits as kernel:taint_flags */
422

423 424
#ifdef CONFIG_GENERIC_BUG
	/* Support for BUG */
425
	unsigned num_bugs;
426 427
	struct list_head bug_list;
	struct bug_entry *bug_table;
L
Linus Torvalds 已提交
428 429 430
#endif

#ifdef CONFIG_KALLSYMS
431 432 433
	/* Protected by RCU and/or module_mutex: use rcu_dereference() */
	struct mod_kallsyms *kallsyms;
	struct mod_kallsyms core_kallsyms;
A
Anson Jacob 已提交
434

L
Linus Torvalds 已提交
435 436
	/* Section attributes */
	struct module_sect_attrs *sect_attrs;
R
Roland McGrath 已提交
437 438 439

	/* Notes attributes */
	struct module_notes_attrs *notes_attrs;
L
Linus Torvalds 已提交
440 441
#endif

442 443 444 445
	/* The command line arguments (may be mangled).  People like
	   keeping pointers to this stuff */
	char *args;

446
#ifdef CONFIG_SMP
L
Linus Torvalds 已提交
447
	/* Per-cpu data. */
448 449 450
	void __percpu *percpu;
	unsigned int percpu_size;
#endif
L
Linus Torvalds 已提交
451

M
Mathieu Desnoyers 已提交
452 453
#ifdef CONFIG_TRACEPOINTS
	unsigned int num_tracepoints;
454
	tracepoint_ptr_t *tracepoints_ptrs;
M
Mathieu Desnoyers 已提交
455
#endif
456 457 458 459
#ifdef CONFIG_TREE_SRCU
	unsigned int num_srcu_structs;
	struct srcu_struct **srcu_struct_ptrs;
#endif
460 461 462 463
#ifdef CONFIG_BPF_EVENTS
	unsigned int num_bpf_raw_events;
	struct bpf_raw_event_map *bpf_raw_events;
#endif
464
#ifdef CONFIG_JUMP_LABEL
465 466 467
	struct jump_entry *jump_entries;
	unsigned int num_jump_entries;
#endif
468
#ifdef CONFIG_TRACING
L
Lai Jiangshan 已提交
469
	unsigned int num_trace_bprintk_fmt;
470
	const char **trace_bprintk_fmt_start;
L
Lai Jiangshan 已提交
471
#endif
472
#ifdef CONFIG_EVENT_TRACING
473
	struct trace_event_call **trace_events;
474
	unsigned int num_trace_events;
475 476
	struct trace_eval_map **trace_evals;
	unsigned int num_trace_evals;
477
#endif
478 479
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
	unsigned int num_ftrace_callsites;
480
	unsigned long *ftrace_callsites;
481
#endif
L
Lai Jiangshan 已提交
482

483
#ifdef CONFIG_LIVEPATCH
484
	bool klp; /* Is this a livepatch module? */
485
	bool klp_alive;
486 487 488

	/* Elf information */
	struct klp_modinfo *klp_info;
489 490
#endif

491 492
#ifdef CONFIG_MODULE_UNLOAD
	/* What modules depend on me? */
493 494 495
	struct list_head source_list;
	/* What modules do I depend on? */
	struct list_head target_list;
496 497 498 499

	/* Destruction function. */
	void (*exit)(void);

500
	atomic_t refcnt;
501
#endif
502 503 504 505 506 507

#ifdef CONFIG_CONSTRUCTORS
	/* Constructor functions. */
	ctor_fn_t *ctors;
	unsigned int num_ctors;
#endif
508

509
#ifdef CONFIG_FUNCTION_ERROR_INJECTION
510
	struct error_injection_entry *ei_funcs;
511
	unsigned int num_ei_funcs;
512
#endif
513
} ____cacheline_aligned __randomize_layout;
514 515 516
#ifndef MODULE_ARCH_INIT
#define MODULE_ARCH_INIT {}
#endif
L
Linus Torvalds 已提交
517

518 519 520 521 522 523 524
#ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
{
	return sym->st_value;
}
#endif

525 526
extern struct mutex module_mutex;

L
Linus Torvalds 已提交
527 528 529
/* FIXME: It'd be nice to isolate modules during init, too, so they
   aren't used before they (may) fail.  But presently too much code
   (IDE & SCSI) require entry into the module during init.*/
530
static inline bool module_is_live(struct module *mod)
L
Linus Torvalds 已提交
531 532 533 534 535
{
	return mod->state != MODULE_STATE_GOING;
}

struct module *__module_text_address(unsigned long addr);
R
Rusty Russell 已提交
536 537
struct module *__module_address(unsigned long addr);
bool is_module_address(unsigned long addr);
538
bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
539
bool is_module_percpu_address(unsigned long addr);
R
Rusty Russell 已提交
540
bool is_module_text_address(unsigned long addr);
L
Linus Torvalds 已提交
541

542 543
static inline bool within_module_core(unsigned long addr,
				      const struct module *mod)
544
{
545 546
	return (unsigned long)mod->core_layout.base <= addr &&
	       addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
547 548
}

549 550
static inline bool within_module_init(unsigned long addr,
				      const struct module *mod)
551
{
552 553
	return (unsigned long)mod->init_layout.base <= addr &&
	       addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
554 555
}

556
static inline bool within_module(unsigned long addr, const struct module *mod)
557 558 559 560
{
	return within_module_init(addr, mod) || within_module_core(addr, mod);
}

561 562 563 564 565
/* Search for module by name: must hold module_mutex. */
struct module *find_module(const char *name);

struct symsearch {
	const struct kernel_symbol *start, *stop;
566
	const s32 *crcs;
567 568 569 570 571 572 573 574
	enum {
		NOT_GPL_ONLY,
		GPL_ONLY,
		WILL_BE_GPL_ONLY,
	} licence;
	bool unused;
};

575 576 577 578 579
/*
 * Search for an exported symbol by name.
 *
 * Must be called with module_mutex held or preemption disabled.
 */
580 581
const struct kernel_symbol *find_symbol(const char *name,
					struct module **owner,
582
					const s32 **crc,
583 584 585
					bool gplok,
					bool warn);

586 587 588 589 590
/*
 * Walk the exported symbol table
 *
 * Must be called with module_mutex held or preemption disabled.
 */
591 592 593
bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
				    struct module *owner,
				    void *data), void *data);
594

595
/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
L
Linus Torvalds 已提交
596
   symnum out of range. */
597 598
int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
			char *name, char *module_name, int *exported);
L
Linus Torvalds 已提交
599 600 601 602

/* Look for this name: can be of form module:name. */
unsigned long module_kallsyms_lookup_name(const char *name);

603 604 605 606
int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
					     struct module *, unsigned long),
				   void *data);

607 608
extern void __noreturn __module_put_and_exit(struct module *mod,
			long code);
609
#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
L
Linus Torvalds 已提交
610 611

#ifdef CONFIG_MODULE_UNLOAD
612
int module_refcount(struct module *mod);
L
Linus Torvalds 已提交
613
void __symbol_put(const char *symbol);
614
#define symbol_put(x) __symbol_put(__stringify(x))
L
Linus Torvalds 已提交
615 616 617 618
void symbol_put_addr(void *addr);

/* Sometimes we know we already have a refcount, and it's easier not
   to handle the error case (which only happens with rmmod --wait). */
619
extern void __module_get(struct module *module);
620

621 622 623
/* This is the Right Way to get a module: if it fails, it's being removed,
 * so pretend it's not there. */
extern bool try_module_get(struct module *module);
L
Linus Torvalds 已提交
624

A
Al Viro 已提交
625
extern void module_put(struct module *module);
L
Linus Torvalds 已提交
626 627

#else /*!CONFIG_MODULE_UNLOAD*/
628
static inline bool try_module_get(struct module *module)
L
Linus Torvalds 已提交
629 630 631 632 633 634 635 636 637
{
	return !module || module_is_live(module);
}
static inline void module_put(struct module *module)
{
}
static inline void __module_get(struct module *module)
{
}
S
Seunghun Lee 已提交
638 639
#define symbol_put(x) do { } while (0)
#define symbol_put_addr(p) do { } while (0)
L
Linus Torvalds 已提交
640 641

#endif /* CONFIG_MODULE_UNLOAD */
642
int ref_module(struct module *a, struct module *b);
L
Linus Torvalds 已提交
643 644 645 646 647 648 649 650

/* This is a #define so the string doesn't get put in every .o file */
#define module_name(mod)			\
({						\
	struct module *__mod = (mod);		\
	__mod ? __mod->name : "kernel";		\
})

651 652 653
/* Dereference module function descriptor */
void *dereference_module_function_descriptor(struct module *mod, void *ptr);

654 655 656
/* For kallsyms to ask for address resolution.  namebuf should be at
 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
 * found, otherwise NULL. */
657
const char *module_address_lookup(unsigned long addr,
658 659 660 661
			    unsigned long *symbolsize,
			    unsigned long *offset,
			    char **modname,
			    char *namebuf);
662
int lookup_module_symbol_name(unsigned long addr, char *symname);
663
int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
L
Linus Torvalds 已提交
664

S
Seunghun Lee 已提交
665 666
int register_module_notifier(struct notifier_block *nb);
int unregister_module_notifier(struct notifier_block *nb);
L
Linus Torvalds 已提交
667 668 669

extern void print_modules(void);

670 671 672 673 674
static inline bool module_requested_async_probing(struct module *module)
{
	return module && module->async_probe_requested;
}

675 676 677 678 679 680 681 682 683 684 685 686
#ifdef CONFIG_LIVEPATCH
static inline bool is_livepatch_module(struct module *mod)
{
	return mod->klp;
}
#else /* !CONFIG_LIVEPATCH */
static inline bool is_livepatch_module(struct module *mod)
{
	return false;
}
#endif /* CONFIG_LIVEPATCH */

687
bool is_module_sig_enforced(void);
688
void set_module_sig_enforced(void);
689

L
Linus Torvalds 已提交
690 691
#else /* !CONFIG_MODULES... */

R
Rusty Russell 已提交
692 693 694 695 696
static inline struct module *__module_address(unsigned long addr)
{
	return NULL;
}

L
Linus Torvalds 已提交
697 698 699 700 701
static inline struct module *__module_text_address(unsigned long addr)
{
	return NULL;
}

R
Rusty Russell 已提交
702 703 704 705 706
static inline bool is_module_address(unsigned long addr)
{
	return false;
}

707 708 709 710 711
static inline bool is_module_percpu_address(unsigned long addr)
{
	return false;
}

712 713 714 715 716
static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
{
	return false;
}

R
Rusty Russell 已提交
717
static inline bool is_module_text_address(unsigned long addr)
718
{
R
Rusty Russell 已提交
719
	return false;
720 721
}

722 723 724 725 726 727
static inline bool within_module_core(unsigned long addr,
				      const struct module *mod)
{
	return false;
}

728 729 730 731 732 733 734 735 736 737 738
static inline bool within_module_init(unsigned long addr,
				      const struct module *mod)
{
	return false;
}

static inline bool within_module(unsigned long addr, const struct module *mod)
{
	return false;
}

L
Linus Torvalds 已提交
739 740
/* Get/put a kernel symbol (calls should be symmetric) */
#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
S
Seunghun Lee 已提交
741 742
#define symbol_put(x) do { } while (0)
#define symbol_put_addr(x) do { } while (0)
L
Linus Torvalds 已提交
743 744 745 746 747

static inline void __module_get(struct module *module)
{
}

748
static inline bool try_module_get(struct module *module)
L
Linus Torvalds 已提交
749
{
750
	return true;
L
Linus Torvalds 已提交
751 752 753 754 755 756 757 758 759
}

static inline void module_put(struct module *module)
{
}

#define module_name(mod) "kernel"

/* For kallsyms to ask for address resolution.  NULL means not found. */
760
static inline const char *module_address_lookup(unsigned long addr,
761 762 763 764
					  unsigned long *symbolsize,
					  unsigned long *offset,
					  char **modname,
					  char *namebuf)
L
Linus Torvalds 已提交
765 766 767 768
{
	return NULL;
}

769 770 771 772 773
static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
{
	return -ERANGE;
}

774 775 776 777 778
static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
{
	return -ERANGE;
}

779 780 781
static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
					char *type, char *name,
					char *module_name, int *exported)
L
Linus Torvalds 已提交
782
{
783
	return -ERANGE;
L
Linus Torvalds 已提交
784 785 786 787 788 789 790
}

static inline unsigned long module_kallsyms_lookup_name(const char *name)
{
	return 0;
}

791 792 793 794 795 796 797 798
static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
							   struct module *,
							   unsigned long),
						 void *data)
{
	return 0;
}

S
Seunghun Lee 已提交
799
static inline int register_module_notifier(struct notifier_block *nb)
L
Linus Torvalds 已提交
800 801 802 803 804
{
	/* no events will happen anyway, so this can always succeed */
	return 0;
}

S
Seunghun Lee 已提交
805
static inline int unregister_module_notifier(struct notifier_block *nb)
L
Linus Torvalds 已提交
806 807 808 809 810 811 812 813 814
{
	return 0;
}

#define module_put_and_exit(code) do_exit(code)

static inline void print_modules(void)
{
}
815 816 817 818 819 820

static inline bool module_requested_async_probing(struct module *module)
{
	return false;
}

821 822 823 824 825
static inline bool is_module_sig_enforced(void)
{
	return false;
}

826 827 828 829
static inline void set_module_sig_enforced(void)
{
}

830 831 832 833 834 835 836
/* Dereference module function descriptor */
static inline
void *dereference_module_function_descriptor(struct module *mod, void *ptr)
{
	return ptr;
}

837 838 839
#endif /* CONFIG_MODULES */

#ifdef CONFIG_SYSFS
840 841 842
extern struct kset *module_kset;
extern struct kobj_type module_ktype;
extern int module_sysfs_initialized;
843 844
#endif /* CONFIG_SYSFS */

L
Linus Torvalds 已提交
845 846 847 848 849 850
#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)

/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */

#define __MODULE_STRING(x) __stringify(x)

851
#ifdef CONFIG_STRICT_MODULE_RWX
852 853
extern void set_all_modules_text_rw(void);
extern void set_all_modules_text_ro(void);
J
Jessica Yu 已提交
854
extern void module_enable_ro(const struct module *mod, bool after_init);
R
Rusty Russell 已提交
855
extern void module_disable_ro(const struct module *mod);
856 857 858
#else
static inline void set_all_modules_text_rw(void) { }
static inline void set_all_modules_text_ro(void) { }
J
Jessica Yu 已提交
859
static inline void module_enable_ro(const struct module *mod, bool after_init) { }
R
Rusty Russell 已提交
860
static inline void module_disable_ro(const struct module *mod) { }
861
#endif
862 863

#ifdef CONFIG_GENERIC_BUG
864
void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
865 866 867 868 869
			 struct module *);
void module_bug_cleanup(struct module *);

#else	/* !CONFIG_GENERIC_BUG */

870
static inline void module_bug_finalize(const Elf_Ehdr *hdr,
871 872 873 874 875 876 877
					const Elf_Shdr *sechdrs,
					struct module *mod)
{
}
static inline void module_bug_cleanup(struct module *mod) {}
#endif	/* CONFIG_GENERIC_BUG */

878
#ifdef CONFIG_RETPOLINE
879 880 881 882 883 884 885 886
extern bool retpoline_module_ok(bool has_retpoline);
#else
static inline bool retpoline_module_ok(bool has_retpoline)
{
	return true;
}
#endif

887 888 889 890 891 892 893 894 895 896 897 898
#ifdef CONFIG_MODULE_SIG
static inline bool module_sig_ok(struct module *module)
{
	return module->sig_ok;
}
#else	/* !CONFIG_MODULE_SIG */
static inline bool module_sig_ok(struct module *module)
{
	return true;
}
#endif	/* CONFIG_MODULE_SIG */

L
Linus Torvalds 已提交
899
#endif /* _LINUX_MODULE_H */