module.h 22.6 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>
L
Linus Torvalds 已提交
23

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

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

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

33
#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
L
Linus Torvalds 已提交
34

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

struct module;
41
struct exception_table_entry;
L
Linus Torvalds 已提交
42

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

L
Linus Torvalds 已提交
51
struct module_attribute {
52 53 54 55
	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 已提交
56
			 const char *, size_t count);
57 58 59
	void (*setup)(struct module *, const char *);
	int (*test)(struct module *);
	void (*free)(struct module *);
L
Linus Torvalds 已提交
60 61
};

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

68
extern ssize_t __modver_version_show(struct module_attribute *,
69
				     struct module_kobject *, char *);
70

71
extern struct module_attribute module_uevent;
L
Linus Torvalds 已提交
72 73 74 75 76

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

77 78 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
#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)
#define security_initcall(fn)		module_init(fn)

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

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

#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 已提交
160 161 162 163 164 165
/* 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)

166 167 168 169 170
/* 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 已提交
171 172 173 174 175 176 177 178 179
/*
 * The following license idents are currently accepted as indicating free
 * software modules
 *
 *	"GPL"				[GNU Public License v2 or later]
 *	"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]
180 181
 *	"Dual MIT/GPL"			[GNU Public License v2
 *					 or MIT license choice]
L
Linus Torvalds 已提交
182 183 184 185 186 187 188 189 190 191 192 193
 *	"Dual MPL/GPL"			[GNU Public License v2
 *					 or Mozilla license choice]
 *
 * The following other idents are available
 *
 *	"Proprietary"			[Non free products]
 *
 * 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 已提交
194
 * 1.	So modinfo can show license info for users wanting to vet their setup
L
Linus Torvalds 已提交
195 196 197 198 199 200
 *	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)

201 202 203 204
/*
 * Author(s), use "Name <email>" or just "Name", for multiple
 * authors use multiple MODULE_AUTHOR() statements/lines.
 */
L
Linus Torvalds 已提交
205
#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
S
Seunghun Lee 已提交
206

L
Linus Torvalds 已提交
207 208 209
/* What your module does. */
#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)

210 211 212
#ifdef MODULE
/* Creates an alias so file2alias.c can find device table. */
#define MODULE_DEVICE_TABLE(type, name)					\
213
extern typeof(name) __mod_##type##__##name##_device_table		\
214 215 216 217
  __attribute__ ((unused, alias(__stringify(name))))
#else  /* !MODULE */
#define MODULE_DEVICE_TABLE(type, name)
#endif
L
Linus Torvalds 已提交
218 219

/* Version of form [<epoch>:]<version>[-<extra-version>].
S
Seunghun Lee 已提交
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
 * 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".
 */
235

236
#if defined(MODULE) || !defined(CONFIG_SYSFS)
L
Linus Torvalds 已提交
237
#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
238 239
#else
#define MODULE_VERSION(_version)					\
240
	static struct module_version_attribute ___modver_attr = {	\
241 242 243 244 245 246 247 248 249
		.mattr	= {						\
			.attr	= {					\
				.name	= "version",			\
				.mode	= S_IRUGO,			\
			},						\
			.show	= __modver_version_show,		\
		},							\
		.module_name	= KBUILD_MODNAME,			\
		.version	= _version,				\
250 251 252 253
	};								\
	static const struct module_version_attribute			\
	__used __attribute__ ((__section__ ("__modver")))		\
	* __moduleparam_const __modver_attr = &___modver_attr
254
#endif
L
Linus Torvalds 已提交
255

256 257 258 259 260
/* 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 已提交
261 262 263 264
struct notifier_block;

#ifdef CONFIG_MODULES

D
Dave Young 已提交
265
extern int modules_disabled; /* for sysctl */
L
Linus Torvalds 已提交
266 267 268
/* Get/put a kernel symbol (calls must be symmetric) */
void *__symbol_get(const char *symbol);
void *__symbol_get_gpl(const char *symbol);
R
Rusty Russell 已提交
269
#define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
L
Linus Torvalds 已提交
270

271 272 273 274 275 276 277
/* 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;
};

278 279 280 281 282
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 已提交
283 284
};

285 286 287 288 289
struct mod_tree_node {
	struct module *mod;
	struct latch_tree_node node;
};

290 291 292 293 294 295 296 297 298
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 已提交
299 300
	/* Size of RO after init section */
	unsigned int ro_after_init_size;
301 302 303 304 305 306 307 308 309 310 311 312 313

#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

314 315 316 317 318 319
struct mod_kallsyms {
	Elf_Sym *symtab;
	unsigned int num_symtab;
	char *strtab;
};

320 321 322 323 324 325 326 327 328
#ifdef CONFIG_LIVEPATCH
struct klp_modinfo {
	Elf_Ehdr hdr;
	Elf_Shdr *sechdrs;
	char *secstrings;
	unsigned int symndx;
};
#endif

S
Seunghun Lee 已提交
329
struct module {
L
Linus Torvalds 已提交
330 331 332 333 334 335 336 337 338 339
	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;
340
	struct module_attribute *modinfo_attrs;
341 342
	const char *version;
	const char *srcversion;
K
Kay Sievers 已提交
343
	struct kobject *holders_dir;
L
Linus Torvalds 已提交
344 345 346

	/* Exported symbols */
	const struct kernel_symbol *syms;
347
	const s32 *crcs;
348
	unsigned int num_syms;
L
Linus Torvalds 已提交
349

350
	/* Kernel parameters. */
351
#ifdef CONFIG_SYSFS
352
	struct mutex param_lock;
353
#endif
354 355 356
	struct kernel_param *kp;
	unsigned int num_kp;

L
Linus Torvalds 已提交
357 358
	/* GPL-only exported symbols. */
	unsigned int num_gpl_syms;
359
	const struct kernel_symbol *gpl_syms;
360
	const s32 *gpl_crcs;
L
Linus Torvalds 已提交
361

362
#ifdef CONFIG_UNUSED_SYMBOLS
363 364
	/* unused exported symbols. */
	const struct kernel_symbol *unused_syms;
365
	const s32 *unused_crcs;
366 367
	unsigned int num_unused_syms;

368 369
	/* GPL-only, unused exported symbols. */
	unsigned int num_unused_gpl_syms;
370
	const struct kernel_symbol *unused_gpl_syms;
371
	const s32 *unused_gpl_crcs;
372
#endif
373

R
Rusty Russell 已提交
374 375 376 377 378
#ifdef CONFIG_MODULE_SIG
	/* Signature was verified. */
	bool sig_ok;
#endif

379 380
	bool async_probe_requested;

381 382
	/* symbols that will be GPL-only in the near future. */
	const struct kernel_symbol *gpl_future_syms;
383
	const s32 *gpl_future_crcs;
384
	unsigned int num_gpl_future_syms;
385

L
Linus Torvalds 已提交
386 387
	/* Exception table */
	unsigned int num_exentries;
R
Rusty Russell 已提交
388
	struct exception_table_entry *extable;
L
Linus Torvalds 已提交
389 390 391 392

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

393 394 395
	/* Core layout: rbtree is accessed frequently, so keep together. */
	struct module_layout core_layout __module_layout_align;
	struct module_layout init_layout;
396

L
Linus Torvalds 已提交
397 398 399
	/* Arch-specific module values */
	struct mod_arch_specific arch;

400
	unsigned long taints;	/* same bits as kernel:taint_flags */
401

402 403
#ifdef CONFIG_GENERIC_BUG
	/* Support for BUG */
404
	unsigned num_bugs;
405 406
	struct list_head bug_list;
	struct bug_entry *bug_table;
L
Linus Torvalds 已提交
407 408 409
#endif

#ifdef CONFIG_KALLSYMS
410 411 412
	/* Protected by RCU and/or module_mutex: use rcu_dereference() */
	struct mod_kallsyms *kallsyms;
	struct mod_kallsyms core_kallsyms;
A
Anson Jacob 已提交
413

L
Linus Torvalds 已提交
414 415
	/* Section attributes */
	struct module_sect_attrs *sect_attrs;
R
Roland McGrath 已提交
416 417 418

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

421 422 423 424
	/* The command line arguments (may be mangled).  People like
	   keeping pointers to this stuff */
	char *args;

425
#ifdef CONFIG_SMP
L
Linus Torvalds 已提交
426
	/* Per-cpu data. */
427 428 429
	void __percpu *percpu;
	unsigned int percpu_size;
#endif
L
Linus Torvalds 已提交
430

M
Mathieu Desnoyers 已提交
431 432
#ifdef CONFIG_TRACEPOINTS
	unsigned int num_tracepoints;
433
	struct tracepoint * const *tracepoints_ptrs;
M
Mathieu Desnoyers 已提交
434
#endif
435 436 437 438
#ifdef HAVE_JUMP_LABEL
	struct jump_entry *jump_entries;
	unsigned int num_jump_entries;
#endif
439
#ifdef CONFIG_TRACING
L
Lai Jiangshan 已提交
440
	unsigned int num_trace_bprintk_fmt;
441
	const char **trace_bprintk_fmt_start;
L
Lai Jiangshan 已提交
442
#endif
443
#ifdef CONFIG_EVENT_TRACING
444
	struct trace_event_call **trace_events;
445
	unsigned int num_trace_events;
446 447
	struct trace_eval_map **trace_evals;
	unsigned int num_trace_evals;
448
#endif
449 450
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
	unsigned int num_ftrace_callsites;
451
	unsigned long *ftrace_callsites;
452
#endif
L
Lai Jiangshan 已提交
453

454
#ifdef CONFIG_LIVEPATCH
455
	bool klp; /* Is this a livepatch module? */
456
	bool klp_alive;
457 458 459

	/* Elf information */
	struct klp_modinfo *klp_info;
460 461
#endif

462 463
#ifdef CONFIG_MODULE_UNLOAD
	/* What modules depend on me? */
464 465 466
	struct list_head source_list;
	/* What modules do I depend on? */
	struct list_head target_list;
467 468 469 470

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

471
	atomic_t refcnt;
472
#endif
473 474 475 476 477 478

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

480
#ifdef CONFIG_FUNCTION_ERROR_INJECTION
481
	struct error_injection_entry *ei_funcs;
482
	unsigned int num_ei_funcs;
483
#endif
484
} ____cacheline_aligned __randomize_layout;
485 486 487
#ifndef MODULE_ARCH_INIT
#define MODULE_ARCH_INIT {}
#endif
L
Linus Torvalds 已提交
488

489 490
extern struct mutex module_mutex;

L
Linus Torvalds 已提交
491 492 493
/* 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.*/
494
static inline bool module_is_live(struct module *mod)
L
Linus Torvalds 已提交
495 496 497 498 499
{
	return mod->state != MODULE_STATE_GOING;
}

struct module *__module_text_address(unsigned long addr);
R
Rusty Russell 已提交
500 501
struct module *__module_address(unsigned long addr);
bool is_module_address(unsigned long addr);
502
bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
503
bool is_module_percpu_address(unsigned long addr);
R
Rusty Russell 已提交
504
bool is_module_text_address(unsigned long addr);
L
Linus Torvalds 已提交
505

506 507
static inline bool within_module_core(unsigned long addr,
				      const struct module *mod)
508
{
509 510
	return (unsigned long)mod->core_layout.base <= addr &&
	       addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
511 512
}

513 514
static inline bool within_module_init(unsigned long addr,
				      const struct module *mod)
515
{
516 517
	return (unsigned long)mod->init_layout.base <= addr &&
	       addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
518 519
}

520
static inline bool within_module(unsigned long addr, const struct module *mod)
521 522 523 524
{
	return within_module_init(addr, mod) || within_module_core(addr, mod);
}

525 526 527 528 529
/* Search for module by name: must hold module_mutex. */
struct module *find_module(const char *name);

struct symsearch {
	const struct kernel_symbol *start, *stop;
530
	const s32 *crcs;
531 532 533 534 535 536 537 538
	enum {
		NOT_GPL_ONLY,
		GPL_ONLY,
		WILL_BE_GPL_ONLY,
	} licence;
	bool unused;
};

539 540 541 542 543
/*
 * Search for an exported symbol by name.
 *
 * Must be called with module_mutex held or preemption disabled.
 */
544 545
const struct kernel_symbol *find_symbol(const char *name,
					struct module **owner,
546
					const s32 **crc,
547 548 549
					bool gplok,
					bool warn);

550 551 552 553 554
/*
 * Walk the exported symbol table
 *
 * Must be called with module_mutex held or preemption disabled.
 */
555 556 557
bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
				    struct module *owner,
				    void *data), void *data);
558

559
/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
L
Linus Torvalds 已提交
560
   symnum out of range. */
561 562
int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
			char *name, char *module_name, int *exported);
L
Linus Torvalds 已提交
563 564 565 566

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

567 568 569 570
int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
					     struct module *, unsigned long),
				   void *data);

571 572
extern void __noreturn __module_put_and_exit(struct module *mod,
			long code);
573
#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
L
Linus Torvalds 已提交
574 575

#ifdef CONFIG_MODULE_UNLOAD
576
int module_refcount(struct module *mod);
L
Linus Torvalds 已提交
577
void __symbol_put(const char *symbol);
R
Rusty Russell 已提交
578
#define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
L
Linus Torvalds 已提交
579 580 581 582
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). */
583
extern void __module_get(struct module *module);
584

585 586 587
/* 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 已提交
588

A
Al Viro 已提交
589
extern void module_put(struct module *module);
L
Linus Torvalds 已提交
590 591

#else /*!CONFIG_MODULE_UNLOAD*/
592
static inline bool try_module_get(struct module *module)
L
Linus Torvalds 已提交
593 594 595 596 597 598 599 600 601
{
	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 已提交
602 603
#define symbol_put(x) do { } while (0)
#define symbol_put_addr(p) do { } while (0)
L
Linus Torvalds 已提交
604 605

#endif /* CONFIG_MODULE_UNLOAD */
606
int ref_module(struct module *a, struct module *b);
L
Linus Torvalds 已提交
607 608 609 610 611 612 613 614

/* 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";		\
})

615 616 617
/* Dereference module function descriptor */
void *dereference_module_function_descriptor(struct module *mod, void *ptr);

618 619 620
/* 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. */
621
const char *module_address_lookup(unsigned long addr,
622 623 624 625
			    unsigned long *symbolsize,
			    unsigned long *offset,
			    char **modname,
			    char *namebuf);
626
int lookup_module_symbol_name(unsigned long addr, char *symname);
627
int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
L
Linus Torvalds 已提交
628

S
Seunghun Lee 已提交
629 630
int register_module_notifier(struct notifier_block *nb);
int unregister_module_notifier(struct notifier_block *nb);
L
Linus Torvalds 已提交
631 632 633

extern void print_modules(void);

634 635 636 637 638
static inline bool module_requested_async_probing(struct module *module)
{
	return module && module->async_probe_requested;
}

639 640 641 642 643 644 645 646 647 648 649 650
#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 */

651 652
bool is_module_sig_enforced(void);

L
Linus Torvalds 已提交
653 654
#else /* !CONFIG_MODULES... */

R
Rusty Russell 已提交
655 656 657 658 659
static inline struct module *__module_address(unsigned long addr)
{
	return NULL;
}

L
Linus Torvalds 已提交
660 661 662 663 664
static inline struct module *__module_text_address(unsigned long addr)
{
	return NULL;
}

R
Rusty Russell 已提交
665 666 667 668 669
static inline bool is_module_address(unsigned long addr)
{
	return false;
}

670 671 672 673 674
static inline bool is_module_percpu_address(unsigned long addr)
{
	return false;
}

675 676 677 678 679
static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
{
	return false;
}

R
Rusty Russell 已提交
680
static inline bool is_module_text_address(unsigned long addr)
681
{
R
Rusty Russell 已提交
682
	return false;
683 684
}

L
Linus Torvalds 已提交
685 686
/* Get/put a kernel symbol (calls should be symmetric) */
#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
S
Seunghun Lee 已提交
687 688
#define symbol_put(x) do { } while (0)
#define symbol_put_addr(x) do { } while (0)
L
Linus Torvalds 已提交
689 690 691 692 693

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

694
static inline bool try_module_get(struct module *module)
L
Linus Torvalds 已提交
695
{
696
	return true;
L
Linus Torvalds 已提交
697 698 699 700 701 702 703 704 705
}

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

#define module_name(mod) "kernel"

/* For kallsyms to ask for address resolution.  NULL means not found. */
706
static inline const char *module_address_lookup(unsigned long addr,
707 708 709 710
					  unsigned long *symbolsize,
					  unsigned long *offset,
					  char **modname,
					  char *namebuf)
L
Linus Torvalds 已提交
711 712 713 714
{
	return NULL;
}

715 716 717 718 719
static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
{
	return -ERANGE;
}

720 721 722 723 724
static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
{
	return -ERANGE;
}

725 726 727
static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
					char *type, char *name,
					char *module_name, int *exported)
L
Linus Torvalds 已提交
728
{
729
	return -ERANGE;
L
Linus Torvalds 已提交
730 731 732 733 734 735 736
}

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

737 738 739 740 741 742 743 744
static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
							   struct module *,
							   unsigned long),
						 void *data)
{
	return 0;
}

S
Seunghun Lee 已提交
745
static inline int register_module_notifier(struct notifier_block *nb)
L
Linus Torvalds 已提交
746 747 748 749 750
{
	/* no events will happen anyway, so this can always succeed */
	return 0;
}

S
Seunghun Lee 已提交
751
static inline int unregister_module_notifier(struct notifier_block *nb)
L
Linus Torvalds 已提交
752 753 754 755 756 757 758 759 760
{
	return 0;
}

#define module_put_and_exit(code) do_exit(code)

static inline void print_modules(void)
{
}
761 762 763 764 765 766

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

767 768 769 770 771
static inline bool is_module_sig_enforced(void)
{
	return false;
}

772 773 774 775 776 777 778
/* Dereference module function descriptor */
static inline
void *dereference_module_function_descriptor(struct module *mod, void *ptr)
{
	return ptr;
}

779 780 781
#endif /* CONFIG_MODULES */

#ifdef CONFIG_SYSFS
782 783 784
extern struct kset *module_kset;
extern struct kobj_type module_ktype;
extern int module_sysfs_initialized;
785 786
#endif /* CONFIG_SYSFS */

L
Linus Torvalds 已提交
787 788 789 790 791 792
#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)

793
#ifdef CONFIG_STRICT_MODULE_RWX
794 795
extern void set_all_modules_text_rw(void);
extern void set_all_modules_text_ro(void);
J
Jessica Yu 已提交
796
extern void module_enable_ro(const struct module *mod, bool after_init);
R
Rusty Russell 已提交
797
extern void module_disable_ro(const struct module *mod);
798 799 800
#else
static inline void set_all_modules_text_rw(void) { }
static inline void set_all_modules_text_ro(void) { }
J
Jessica Yu 已提交
801
static inline void module_enable_ro(const struct module *mod, bool after_init) { }
R
Rusty Russell 已提交
802
static inline void module_disable_ro(const struct module *mod) { }
803
#endif
804 805

#ifdef CONFIG_GENERIC_BUG
806
void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
807 808 809 810 811
			 struct module *);
void module_bug_cleanup(struct module *);

#else	/* !CONFIG_GENERIC_BUG */

812
static inline void module_bug_finalize(const Elf_Ehdr *hdr,
813 814 815 816 817 818 819
					const Elf_Shdr *sechdrs,
					struct module *mod)
{
}
static inline void module_bug_cleanup(struct module *mod) {}
#endif	/* CONFIG_GENERIC_BUG */

820 821 822 823 824 825 826 827 828
#ifdef RETPOLINE
extern bool retpoline_module_ok(bool has_retpoline);
#else
static inline bool retpoline_module_ok(bool has_retpoline)
{
	return true;
}
#endif

829 830 831 832 833 834 835 836 837 838 839 840
#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 已提交
841
#endif /* _LINUX_MODULE_H */