xref: /linux-6.15/include/linux/module.h (revision e4f35891)
11da177e4SLinus Torvalds #ifndef _LINUX_MODULE_H
21da177e4SLinus Torvalds #define _LINUX_MODULE_H
31da177e4SLinus Torvalds /*
41da177e4SLinus Torvalds  * Dynamic loading of modules into the kernel.
51da177e4SLinus Torvalds  *
61da177e4SLinus Torvalds  * Rewritten by Richard Henderson <[email protected]> Dec 1996
71da177e4SLinus Torvalds  * Rewritten again by Rusty Russell, 2002
81da177e4SLinus Torvalds  */
91da177e4SLinus Torvalds #include <linux/list.h>
101da177e4SLinus Torvalds #include <linux/stat.h>
111da177e4SLinus Torvalds #include <linux/compiler.h>
121da177e4SLinus Torvalds #include <linux/cache.h>
131da177e4SLinus Torvalds #include <linux/kmod.h>
140fd972a7SPaul Gortmaker #include <linux/init.h>
151da177e4SLinus Torvalds #include <linux/elf.h>
161da177e4SLinus Torvalds #include <linux/stringify.h>
171da177e4SLinus Torvalds #include <linux/kobject.h>
181da177e4SLinus Torvalds #include <linux/moduleparam.h>
19b2e285fcSSteven Rostedt (Red Hat) #include <linux/jump_label.h>
20f5016932SPaul Gortmaker #include <linux/export.h>
2193c2e105SPeter Zijlstra #include <linux/rbtree_latch.h>
22663faf9fSMasami Hiramatsu #include <linux/error-injection.h>
239c0be3f6SMathieu Desnoyers #include <linux/tracepoint-defs.h>
241da177e4SLinus Torvalds 
25e1783a24SChristoph Lameter #include <linux/percpu.h>
261da177e4SLinus Torvalds #include <asm/module.h>
271da177e4SLinus Torvalds 
28106a4ee2SRusty Russell /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
29106a4ee2SRusty Russell #define MODULE_SIG_STRING "~Module signature appended~\n"
30106a4ee2SRusty Russell 
311da177e4SLinus Torvalds /* Not Yet Implemented */
321da177e4SLinus Torvalds #define MODULE_SUPPORTED_DEVICE(name)
331da177e4SLinus Torvalds 
34730b69d2SRusty Russell #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
351da177e4SLinus Torvalds 
36e865d06bSSeunghun Lee struct modversion_info {
371da177e4SLinus Torvalds 	unsigned long crc;
381da177e4SLinus Torvalds 	char name[MODULE_NAME_LEN];
391da177e4SLinus Torvalds };
401da177e4SLinus Torvalds 
411da177e4SLinus Torvalds struct module;
420ef76537SPaul Gortmaker struct exception_table_entry;
431da177e4SLinus Torvalds 
444befb026SKay Sievers struct module_kobject {
454befb026SKay Sievers 	struct kobject kobj;
464befb026SKay Sievers 	struct module *mod;
474befb026SKay Sievers 	struct kobject *drivers_dir;
484befb026SKay Sievers 	struct module_param_attrs *mp;
49942e4431SLi Zhong 	struct completion *kobj_completion;
503859a271SKees Cook } __randomize_layout;
514befb026SKay Sievers 
521da177e4SLinus Torvalds struct module_attribute {
531da177e4SLinus Torvalds 	struct attribute attr;
544befb026SKay Sievers 	ssize_t (*show)(struct module_attribute *, struct module_kobject *,
554befb026SKay Sievers 			char *);
564befb026SKay Sievers 	ssize_t (*store)(struct module_attribute *, struct module_kobject *,
571da177e4SLinus Torvalds 			 const char *, size_t count);
58c988d2b2SMatt Domsch 	void (*setup)(struct module *, const char *);
59c988d2b2SMatt Domsch 	int (*test)(struct module *);
60c988d2b2SMatt Domsch 	void (*free)(struct module *);
611da177e4SLinus Torvalds };
621da177e4SLinus Torvalds 
63e94965edSDmitry Torokhov struct module_version_attribute {
64e94965edSDmitry Torokhov 	struct module_attribute mattr;
65e94965edSDmitry Torokhov 	const char *module_name;
66e94965edSDmitry Torokhov 	const char *version;
6798562ad8SDmitry Torokhov } __attribute__ ((__aligned__(sizeof(void *))));
68e94965edSDmitry Torokhov 
699b73a584SDmitry Torokhov extern ssize_t __modver_version_show(struct module_attribute *,
704befb026SKay Sievers 				     struct module_kobject *, char *);
719b73a584SDmitry Torokhov 
7288bfa324SKay Sievers extern struct module_attribute module_uevent;
731da177e4SLinus Torvalds 
741da177e4SLinus Torvalds /* These are either module local, or the kernel's dummy ones. */
751da177e4SLinus Torvalds extern int init_module(void);
761da177e4SLinus Torvalds extern void cleanup_module(void);
771da177e4SLinus Torvalds 
780fd972a7SPaul Gortmaker #ifndef MODULE
790fd972a7SPaul Gortmaker /**
800fd972a7SPaul Gortmaker  * module_init() - driver initialization entry point
810fd972a7SPaul Gortmaker  * @x: function to be run at kernel boot time or module insertion
820fd972a7SPaul Gortmaker  *
830fd972a7SPaul Gortmaker  * module_init() will either be called during do_initcalls() (if
840fd972a7SPaul Gortmaker  * builtin) or at module insertion time (if a module).  There can only
850fd972a7SPaul Gortmaker  * be one per module.
860fd972a7SPaul Gortmaker  */
870fd972a7SPaul Gortmaker #define module_init(x)	__initcall(x);
880fd972a7SPaul Gortmaker 
890fd972a7SPaul Gortmaker /**
900fd972a7SPaul Gortmaker  * module_exit() - driver exit entry point
910fd972a7SPaul Gortmaker  * @x: function to be run when driver is removed
920fd972a7SPaul Gortmaker  *
930fd972a7SPaul Gortmaker  * module_exit() will wrap the driver clean-up code
940fd972a7SPaul Gortmaker  * with cleanup_module() when used with rmmod when
950fd972a7SPaul Gortmaker  * the driver is a module.  If the driver is statically
960fd972a7SPaul Gortmaker  * compiled into the kernel, module_exit() has no effect.
970fd972a7SPaul Gortmaker  * There can only be one per module.
980fd972a7SPaul Gortmaker  */
990fd972a7SPaul Gortmaker #define module_exit(x)	__exitcall(x);
1000fd972a7SPaul Gortmaker 
1010fd972a7SPaul Gortmaker #else /* MODULE */
1020fd972a7SPaul Gortmaker 
1030fd972a7SPaul Gortmaker /*
1040fd972a7SPaul Gortmaker  * In most cases loadable modules do not need custom
1050fd972a7SPaul Gortmaker  * initcall levels. There are still some valid cases where
1060fd972a7SPaul Gortmaker  * a driver may be needed early if built in, and does not
1070fd972a7SPaul Gortmaker  * matter when built as a loadable module. Like bus
1080fd972a7SPaul Gortmaker  * snooping debug drivers.
1090fd972a7SPaul Gortmaker  */
1100fd972a7SPaul Gortmaker #define early_initcall(fn)		module_init(fn)
1110fd972a7SPaul Gortmaker #define core_initcall(fn)		module_init(fn)
1120fd972a7SPaul Gortmaker #define core_initcall_sync(fn)		module_init(fn)
1130fd972a7SPaul Gortmaker #define postcore_initcall(fn)		module_init(fn)
1140fd972a7SPaul Gortmaker #define postcore_initcall_sync(fn)	module_init(fn)
1150fd972a7SPaul Gortmaker #define arch_initcall(fn)		module_init(fn)
1160fd972a7SPaul Gortmaker #define subsys_initcall(fn)		module_init(fn)
1170fd972a7SPaul Gortmaker #define subsys_initcall_sync(fn)	module_init(fn)
1180fd972a7SPaul Gortmaker #define fs_initcall(fn)			module_init(fn)
1190fd972a7SPaul Gortmaker #define fs_initcall_sync(fn)		module_init(fn)
1200fd972a7SPaul Gortmaker #define rootfs_initcall(fn)		module_init(fn)
1210fd972a7SPaul Gortmaker #define device_initcall(fn)		module_init(fn)
1220fd972a7SPaul Gortmaker #define device_initcall_sync(fn)	module_init(fn)
1230fd972a7SPaul Gortmaker #define late_initcall(fn)		module_init(fn)
1240fd972a7SPaul Gortmaker #define late_initcall_sync(fn)		module_init(fn)
1250fd972a7SPaul Gortmaker 
1260fd972a7SPaul Gortmaker #define console_initcall(fn)		module_init(fn)
1270fd972a7SPaul Gortmaker 
1280fd972a7SPaul Gortmaker /* Each module must use one module_init(). */
1290fd972a7SPaul Gortmaker #define module_init(initfn)					\
1301f318a8bSArnd Bergmann 	static inline initcall_t __maybe_unused __inittest(void)		\
1310fd972a7SPaul Gortmaker 	{ return initfn; }					\
1320fd972a7SPaul Gortmaker 	int init_module(void) __attribute__((alias(#initfn)));
1330fd972a7SPaul Gortmaker 
1340fd972a7SPaul Gortmaker /* This is only required if you want to be unloadable. */
1350fd972a7SPaul Gortmaker #define module_exit(exitfn)					\
1361f318a8bSArnd Bergmann 	static inline exitcall_t __maybe_unused __exittest(void)		\
1370fd972a7SPaul Gortmaker 	{ return exitfn; }					\
1380fd972a7SPaul Gortmaker 	void cleanup_module(void) __attribute__((alias(#exitfn)));
1390fd972a7SPaul Gortmaker 
1400fd972a7SPaul Gortmaker #endif
1410fd972a7SPaul Gortmaker 
1420fd972a7SPaul Gortmaker /* This means "can be init if no module support, otherwise module load
1430fd972a7SPaul Gortmaker    may call it." */
1440fd972a7SPaul Gortmaker #ifdef CONFIG_MODULES
1450fd972a7SPaul Gortmaker #define __init_or_module
1460fd972a7SPaul Gortmaker #define __initdata_or_module
1470fd972a7SPaul Gortmaker #define __initconst_or_module
1480fd972a7SPaul Gortmaker #define __INIT_OR_MODULE	.text
1490fd972a7SPaul Gortmaker #define __INITDATA_OR_MODULE	.data
1500fd972a7SPaul Gortmaker #define __INITRODATA_OR_MODULE	.section ".rodata","a",%progbits
1510fd972a7SPaul Gortmaker #else
1520fd972a7SPaul Gortmaker #define __init_or_module __init
1530fd972a7SPaul Gortmaker #define __initdata_or_module __initdata
1540fd972a7SPaul Gortmaker #define __initconst_or_module __initconst
1550fd972a7SPaul Gortmaker #define __INIT_OR_MODULE __INIT
1560fd972a7SPaul Gortmaker #define __INITDATA_OR_MODULE __INITDATA
1570fd972a7SPaul Gortmaker #define __INITRODATA_OR_MODULE __INITRODATA
1580fd972a7SPaul Gortmaker #endif /*CONFIG_MODULES*/
1590fd972a7SPaul Gortmaker 
1601da177e4SLinus Torvalds /* Generic info of form tag = "info" */
1611da177e4SLinus Torvalds #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
1621da177e4SLinus Torvalds 
1631da177e4SLinus Torvalds /* For userspace: you can also call me... */
1641da177e4SLinus Torvalds #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
1651da177e4SLinus Torvalds 
1667cb14ba7SAndreas Robinson /* Soft module dependencies. See man modprobe.d for details.
1677cb14ba7SAndreas Robinson  * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
1687cb14ba7SAndreas Robinson  */
1697cb14ba7SAndreas Robinson #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
1707cb14ba7SAndreas Robinson 
1711da177e4SLinus Torvalds /*
1721da177e4SLinus Torvalds  * The following license idents are currently accepted as indicating free
1731da177e4SLinus Torvalds  * software modules
1741da177e4SLinus Torvalds  *
1751da177e4SLinus Torvalds  *	"GPL"				[GNU Public License v2 or later]
1761da177e4SLinus Torvalds  *	"GPL v2"			[GNU Public License v2]
1771da177e4SLinus Torvalds  *	"GPL and additional rights"	[GNU Public License v2 rights and more]
1781da177e4SLinus Torvalds  *	"Dual BSD/GPL"			[GNU Public License v2
1791da177e4SLinus Torvalds  *					 or BSD license choice]
1808d27e908SXose Vazquez Perez  *	"Dual MIT/GPL"			[GNU Public License v2
1818d27e908SXose Vazquez Perez  *					 or MIT license choice]
1821da177e4SLinus Torvalds  *	"Dual MPL/GPL"			[GNU Public License v2
1831da177e4SLinus Torvalds  *					 or Mozilla license choice]
1841da177e4SLinus Torvalds  *
1851da177e4SLinus Torvalds  * The following other idents are available
1861da177e4SLinus Torvalds  *
1871da177e4SLinus Torvalds  *	"Proprietary"			[Non free products]
1881da177e4SLinus Torvalds  *
1891da177e4SLinus Torvalds  * There are dual licensed components, but when running with Linux it is the
1901da177e4SLinus Torvalds  * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
1911da177e4SLinus Torvalds  * is a GPL combined work.
1921da177e4SLinus Torvalds  *
1931da177e4SLinus Torvalds  * This exists for several reasons
1941da177e4SLinus Torvalds  * 1.	So modinfo can show license info for users wanting to vet their setup
1951da177e4SLinus Torvalds  *	is free
1961da177e4SLinus Torvalds  * 2.	So the community can ignore bug reports including proprietary modules
1971da177e4SLinus Torvalds  * 3.	So vendors can do likewise based on their own policies
1981da177e4SLinus Torvalds  */
1991da177e4SLinus Torvalds #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
2001da177e4SLinus Torvalds 
2011d7015caSJohannes Berg /*
2021d7015caSJohannes Berg  * Author(s), use "Name <email>" or just "Name", for multiple
2031d7015caSJohannes Berg  * authors use multiple MODULE_AUTHOR() statements/lines.
2041d7015caSJohannes Berg  */
2051da177e4SLinus Torvalds #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
2061da177e4SLinus Torvalds 
2071da177e4SLinus Torvalds /* What your module does. */
2081da177e4SLinus Torvalds #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
2091da177e4SLinus Torvalds 
210cff26a51SRusty Russell #ifdef MODULE
211cff26a51SRusty Russell /* Creates an alias so file2alias.c can find device table. */
2121da177e4SLinus Torvalds #define MODULE_DEVICE_TABLE(type, name)					\
2130bf8bf50SMatthias Kaehlcke extern typeof(name) __mod_##type##__##name##_device_table		\
214cff26a51SRusty Russell   __attribute__ ((unused, alias(__stringify(name))))
215cff26a51SRusty Russell #else  /* !MODULE */
216cff26a51SRusty Russell #define MODULE_DEVICE_TABLE(type, name)
217cff26a51SRusty Russell #endif
2181da177e4SLinus Torvalds 
2191da177e4SLinus Torvalds /* Version of form [<epoch>:]<version>[-<extra-version>].
220e865d06bSSeunghun Lee  * Or for CVS/RCS ID version, everything but the number is stripped.
221e865d06bSSeunghun Lee  * <epoch>: A (small) unsigned integer which allows you to start versions
222e865d06bSSeunghun Lee  * anew. If not mentioned, it's zero.  eg. "2:1.0" is after
223e865d06bSSeunghun Lee  * "1:2.0".
2241da177e4SLinus Torvalds 
225e865d06bSSeunghun Lee  * <version>: The <version> may contain only alphanumerics and the
226e865d06bSSeunghun Lee  * character `.'.  Ordered by numeric sort for numeric parts,
227e865d06bSSeunghun Lee  * ascii sort for ascii parts (as per RPM or DEB algorithm).
228e865d06bSSeunghun Lee 
229e865d06bSSeunghun Lee  * <extraversion>: Like <version>, but inserted for local
230e865d06bSSeunghun Lee  * customizations, eg "rh3" or "rusty1".
231e865d06bSSeunghun Lee 
232e865d06bSSeunghun Lee  * Using this automatically adds a checksum of the .c files and the
233e865d06bSSeunghun Lee  * local headers in "srcversion".
2341da177e4SLinus Torvalds  */
235e94965edSDmitry Torokhov 
2363b90a5b2SRusty Russell #if defined(MODULE) || !defined(CONFIG_SYSFS)
2371da177e4SLinus Torvalds #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
238e94965edSDmitry Torokhov #else
239e94965edSDmitry Torokhov #define MODULE_VERSION(_version)					\
240b4bc8428SDmitry Torokhov 	static struct module_version_attribute ___modver_attr = {	\
241e94965edSDmitry Torokhov 		.mattr	= {						\
242e94965edSDmitry Torokhov 			.attr	= {					\
243e94965edSDmitry Torokhov 				.name	= "version",			\
244e94965edSDmitry Torokhov 				.mode	= S_IRUGO,			\
245e94965edSDmitry Torokhov 			},						\
246e94965edSDmitry Torokhov 			.show	= __modver_version_show,		\
247e94965edSDmitry Torokhov 		},							\
248e94965edSDmitry Torokhov 		.module_name	= KBUILD_MODNAME,			\
249e94965edSDmitry Torokhov 		.version	= _version,				\
250b4bc8428SDmitry Torokhov 	};								\
251b4bc8428SDmitry Torokhov 	static const struct module_version_attribute			\
252b4bc8428SDmitry Torokhov 	__used __attribute__ ((__section__ ("__modver")))		\
253b4bc8428SDmitry Torokhov 	* __moduleparam_const __modver_attr = &___modver_attr
254e94965edSDmitry Torokhov #endif
2551da177e4SLinus Torvalds 
256187afbedSJon Masters /* Optional firmware file (or files) needed by the module
257187afbedSJon Masters  * format is simply firmware file name.  Multiple firmware
258187afbedSJon Masters  * files require multiple MODULE_FIRMWARE() specifiers */
259187afbedSJon Masters #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
260187afbedSJon Masters 
2611da177e4SLinus Torvalds struct notifier_block;
2621da177e4SLinus Torvalds 
2631da177e4SLinus Torvalds #ifdef CONFIG_MODULES
2641da177e4SLinus Torvalds 
2655ed10910SDave Young extern int modules_disabled; /* for sysctl */
2661da177e4SLinus Torvalds /* Get/put a kernel symbol (calls must be symmetric) */
2671da177e4SLinus Torvalds void *__symbol_get(const char *symbol);
2681da177e4SLinus Torvalds void *__symbol_get_gpl(const char *symbol);
269996302c5SMasahiro Yamada #define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
2701da177e4SLinus Torvalds 
271c8e21cedSRusty Russell /* modules using other modules: kdb wants to see this. */
272c8e21cedSRusty Russell struct module_use {
273c8e21cedSRusty Russell 	struct list_head source_list;
274c8e21cedSRusty Russell 	struct list_head target_list;
275c8e21cedSRusty Russell 	struct module *source, *target;
276c8e21cedSRusty Russell };
277c8e21cedSRusty Russell 
2780d21b0e3SRusty Russell enum module_state {
2790d21b0e3SRusty Russell 	MODULE_STATE_LIVE,	/* Normal state. */
2800d21b0e3SRusty Russell 	MODULE_STATE_COMING,	/* Full formed, running module_init. */
2810d21b0e3SRusty Russell 	MODULE_STATE_GOING,	/* Going away. */
2820d21b0e3SRusty Russell 	MODULE_STATE_UNFORMED,	/* Still setting it up. */
2831da177e4SLinus Torvalds };
2841da177e4SLinus Torvalds 
28593c2e105SPeter Zijlstra struct mod_tree_node {
28693c2e105SPeter Zijlstra 	struct module *mod;
28793c2e105SPeter Zijlstra 	struct latch_tree_node node;
28893c2e105SPeter Zijlstra };
28993c2e105SPeter Zijlstra 
2907523e4dcSRusty Russell struct module_layout {
2917523e4dcSRusty Russell 	/* The actual code + data. */
2927523e4dcSRusty Russell 	void *base;
2937523e4dcSRusty Russell 	/* Total size. */
2947523e4dcSRusty Russell 	unsigned int size;
2957523e4dcSRusty Russell 	/* The size of the executable code.  */
2967523e4dcSRusty Russell 	unsigned int text_size;
2977523e4dcSRusty Russell 	/* Size of RO section of the module (text+rodata) */
2987523e4dcSRusty Russell 	unsigned int ro_size;
299444d13ffSJessica Yu 	/* Size of RO after init section */
300444d13ffSJessica Yu 	unsigned int ro_after_init_size;
3017523e4dcSRusty Russell 
3027523e4dcSRusty Russell #ifdef CONFIG_MODULES_TREE_LOOKUP
3037523e4dcSRusty Russell 	struct mod_tree_node mtn;
3047523e4dcSRusty Russell #endif
3057523e4dcSRusty Russell };
3067523e4dcSRusty Russell 
3077523e4dcSRusty Russell #ifdef CONFIG_MODULES_TREE_LOOKUP
3087523e4dcSRusty Russell /* Only touch one cacheline for common rbtree-for-core-layout case. */
3097523e4dcSRusty Russell #define __module_layout_align ____cacheline_aligned
3107523e4dcSRusty Russell #else
3117523e4dcSRusty Russell #define __module_layout_align
3127523e4dcSRusty Russell #endif
3137523e4dcSRusty Russell 
3148244062eSRusty Russell struct mod_kallsyms {
3158244062eSRusty Russell 	Elf_Sym *symtab;
3168244062eSRusty Russell 	unsigned int num_symtab;
3178244062eSRusty Russell 	char *strtab;
3188244062eSRusty Russell };
3198244062eSRusty Russell 
3201ce15ef4SJessica Yu #ifdef CONFIG_LIVEPATCH
3211ce15ef4SJessica Yu struct klp_modinfo {
3221ce15ef4SJessica Yu 	Elf_Ehdr hdr;
3231ce15ef4SJessica Yu 	Elf_Shdr *sechdrs;
3241ce15ef4SJessica Yu 	char *secstrings;
3251ce15ef4SJessica Yu 	unsigned int symndx;
3261ce15ef4SJessica Yu };
3271ce15ef4SJessica Yu #endif
3281ce15ef4SJessica Yu 
329e865d06bSSeunghun Lee struct module {
3301da177e4SLinus Torvalds 	enum module_state state;
3311da177e4SLinus Torvalds 
3321da177e4SLinus Torvalds 	/* Member of list of modules */
3331da177e4SLinus Torvalds 	struct list_head list;
3341da177e4SLinus Torvalds 
3351da177e4SLinus Torvalds 	/* Unique handle for this module */
3361da177e4SLinus Torvalds 	char name[MODULE_NAME_LEN];
3371da177e4SLinus Torvalds 
3381da177e4SLinus Torvalds 	/* Sysfs stuff. */
3391da177e4SLinus Torvalds 	struct module_kobject mkobj;
34003e88ae1SGreg Kroah-Hartman 	struct module_attribute *modinfo_attrs;
341c988d2b2SMatt Domsch 	const char *version;
342c988d2b2SMatt Domsch 	const char *srcversion;
343270a6c4cSKay Sievers 	struct kobject *holders_dir;
3441da177e4SLinus Torvalds 
3451da177e4SLinus Torvalds 	/* Exported symbols */
3461da177e4SLinus Torvalds 	const struct kernel_symbol *syms;
34771810db2SArd Biesheuvel 	const s32 *crcs;
348af540689SRichard Kennedy 	unsigned int num_syms;
3491da177e4SLinus Torvalds 
350e180a6b7SRusty Russell 	/* Kernel parameters. */
351cf2fde7bSRusty Russell #ifdef CONFIG_SYSFS
352b51d23e4SDan Streetman 	struct mutex param_lock;
353cf2fde7bSRusty Russell #endif
354e180a6b7SRusty Russell 	struct kernel_param *kp;
355e180a6b7SRusty Russell 	unsigned int num_kp;
356e180a6b7SRusty Russell 
3571da177e4SLinus Torvalds 	/* GPL-only exported symbols. */
3581da177e4SLinus Torvalds 	unsigned int num_gpl_syms;
359af540689SRichard Kennedy 	const struct kernel_symbol *gpl_syms;
36071810db2SArd Biesheuvel 	const s32 *gpl_crcs;
3611da177e4SLinus Torvalds 
362f7f5b675SDenys Vlasenko #ifdef CONFIG_UNUSED_SYMBOLS
363f71d20e9SArjan van de Ven 	/* unused exported symbols. */
364f71d20e9SArjan van de Ven 	const struct kernel_symbol *unused_syms;
36571810db2SArd Biesheuvel 	const s32 *unused_crcs;
366af540689SRichard Kennedy 	unsigned int num_unused_syms;
367af540689SRichard Kennedy 
368f71d20e9SArjan van de Ven 	/* GPL-only, unused exported symbols. */
369f71d20e9SArjan van de Ven 	unsigned int num_unused_gpl_syms;
370af540689SRichard Kennedy 	const struct kernel_symbol *unused_gpl_syms;
37171810db2SArd Biesheuvel 	const s32 *unused_gpl_crcs;
372f7f5b675SDenys Vlasenko #endif
373f71d20e9SArjan van de Ven 
374106a4ee2SRusty Russell #ifdef CONFIG_MODULE_SIG
375106a4ee2SRusty Russell 	/* Signature was verified. */
376106a4ee2SRusty Russell 	bool sig_ok;
377106a4ee2SRusty Russell #endif
378106a4ee2SRusty Russell 
379f2411da7SLuis R. Rodriguez 	bool async_probe_requested;
380f2411da7SLuis R. Rodriguez 
3819f28bb7eSGreg Kroah-Hartman 	/* symbols that will be GPL-only in the near future. */
3829f28bb7eSGreg Kroah-Hartman 	const struct kernel_symbol *gpl_future_syms;
38371810db2SArd Biesheuvel 	const s32 *gpl_future_crcs;
384af540689SRichard Kennedy 	unsigned int num_gpl_future_syms;
3859f28bb7eSGreg Kroah-Hartman 
3861da177e4SLinus Torvalds 	/* Exception table */
3871da177e4SLinus Torvalds 	unsigned int num_exentries;
3885e458cc0SRusty Russell 	struct exception_table_entry *extable;
3891da177e4SLinus Torvalds 
3901da177e4SLinus Torvalds 	/* Startup function. */
3911da177e4SLinus Torvalds 	int (*init)(void);
3921da177e4SLinus Torvalds 
3937523e4dcSRusty Russell 	/* Core layout: rbtree is accessed frequently, so keep together. */
3947523e4dcSRusty Russell 	struct module_layout core_layout __module_layout_align;
3957523e4dcSRusty Russell 	struct module_layout init_layout;
39684e1c6bbSmatthieu castet 
3971da177e4SLinus Torvalds 	/* Arch-specific module values */
3981da177e4SLinus Torvalds 	struct mod_arch_specific arch;
3991da177e4SLinus Torvalds 
4007fd8329bSPetr Mladek 	unsigned long taints;	/* same bits as kernel:taint_flags */
4012bc2d61aSRandy Dunlap 
4027664c5a1SJeremy Fitzhardinge #ifdef CONFIG_GENERIC_BUG
4037664c5a1SJeremy Fitzhardinge 	/* Support for BUG */
404af540689SRichard Kennedy 	unsigned num_bugs;
4057664c5a1SJeremy Fitzhardinge 	struct list_head bug_list;
4067664c5a1SJeremy Fitzhardinge 	struct bug_entry *bug_table;
4071da177e4SLinus Torvalds #endif
4081da177e4SLinus Torvalds 
4091da177e4SLinus Torvalds #ifdef CONFIG_KALLSYMS
4108244062eSRusty Russell 	/* Protected by RCU and/or module_mutex: use rcu_dereference() */
4118244062eSRusty Russell 	struct mod_kallsyms *kallsyms;
4128244062eSRusty Russell 	struct mod_kallsyms core_kallsyms;
4131da177e4SLinus Torvalds 
4141da177e4SLinus Torvalds 	/* Section attributes */
4151da177e4SLinus Torvalds 	struct module_sect_attrs *sect_attrs;
4166d760133SRoland McGrath 
4176d760133SRoland McGrath 	/* Notes attributes */
4186d760133SRoland McGrath 	struct module_notes_attrs *notes_attrs;
4191da177e4SLinus Torvalds #endif
4201da177e4SLinus Torvalds 
421a288bd65SRichard Kennedy 	/* The command line arguments (may be mangled).  People like
422a288bd65SRichard Kennedy 	   keeping pointers to this stuff */
423a288bd65SRichard Kennedy 	char *args;
424a288bd65SRichard Kennedy 
425259354deSTejun Heo #ifdef CONFIG_SMP
4261da177e4SLinus Torvalds 	/* Per-cpu data. */
427259354deSTejun Heo 	void __percpu *percpu;
428259354deSTejun Heo 	unsigned int percpu_size;
429259354deSTejun Heo #endif
4301da177e4SLinus Torvalds 
43197e1c18eSMathieu Desnoyers #ifdef CONFIG_TRACEPOINTS
43297e1c18eSMathieu Desnoyers 	unsigned int num_tracepoints;
4339c0be3f6SMathieu Desnoyers 	tracepoint_ptr_t *tracepoints_ptrs;
43497e1c18eSMathieu Desnoyers #endif
435a38d1107SMatt Mullins #ifdef CONFIG_BPF_EVENTS
436a38d1107SMatt Mullins 	unsigned int num_bpf_raw_events;
437a38d1107SMatt Mullins 	struct bpf_raw_event_map *bpf_raw_events;
438a38d1107SMatt Mullins #endif
439e9666d10SMasahiro Yamada #ifdef CONFIG_JUMP_LABEL
440bf5438fcSJason Baron 	struct jump_entry *jump_entries;
441bf5438fcSJason Baron 	unsigned int num_jump_entries;
442bf5438fcSJason Baron #endif
443769b0441SFrederic Weisbecker #ifdef CONFIG_TRACING
4441ba28e02SLai Jiangshan 	unsigned int num_trace_bprintk_fmt;
445a288bd65SRichard Kennedy 	const char **trace_bprintk_fmt_start;
4461ba28e02SLai Jiangshan #endif
4476d723736SSteven Rostedt #ifdef CONFIG_EVENT_TRACING
4482425bcb9SSteven Rostedt (Red Hat) 	struct trace_event_call **trace_events;
4496d723736SSteven Rostedt 	unsigned int num_trace_events;
45099be647cSJeremy Linton 	struct trace_eval_map **trace_evals;
45199be647cSJeremy Linton 	unsigned int num_trace_evals;
4526d723736SSteven Rostedt #endif
45393eb677dSSteven Rostedt #ifdef CONFIG_FTRACE_MCOUNT_RECORD
45493eb677dSSteven Rostedt 	unsigned int num_ftrace_callsites;
455a288bd65SRichard Kennedy 	unsigned long *ftrace_callsites;
45693eb677dSSteven Rostedt #endif
4571ba28e02SLai Jiangshan 
4588cb2c2dcSPetr Mladek #ifdef CONFIG_LIVEPATCH
4591ce15ef4SJessica Yu 	bool klp; /* Is this a livepatch module? */
4608cb2c2dcSPetr Mladek 	bool klp_alive;
4611ce15ef4SJessica Yu 
4621ce15ef4SJessica Yu 	/* Elf information */
4631ce15ef4SJessica Yu 	struct klp_modinfo *klp_info;
4648cb2c2dcSPetr Mladek #endif
4658cb2c2dcSPetr Mladek 
466af540689SRichard Kennedy #ifdef CONFIG_MODULE_UNLOAD
467af540689SRichard Kennedy 	/* What modules depend on me? */
4682c02dfe7SLinus Torvalds 	struct list_head source_list;
4692c02dfe7SLinus Torvalds 	/* What modules do I depend on? */
4702c02dfe7SLinus Torvalds 	struct list_head target_list;
471af540689SRichard Kennedy 
472af540689SRichard Kennedy 	/* Destruction function. */
473af540689SRichard Kennedy 	void (*exit)(void);
474af540689SRichard Kennedy 
4752f35c41fSMasami Hiramatsu 	atomic_t refcnt;
476af540689SRichard Kennedy #endif
477b99b87f7SPeter Oberparleiter 
478b99b87f7SPeter Oberparleiter #ifdef CONFIG_CONSTRUCTORS
479b99b87f7SPeter Oberparleiter 	/* Constructor functions. */
480b99b87f7SPeter Oberparleiter 	ctor_fn_t *ctors;
481b99b87f7SPeter Oberparleiter 	unsigned int num_ctors;
482b99b87f7SPeter Oberparleiter #endif
48392ace999SJosef Bacik 
484540adea3SMasami Hiramatsu #ifdef CONFIG_FUNCTION_ERROR_INJECTION
485663faf9fSMasami Hiramatsu 	struct error_injection_entry *ei_funcs;
486540adea3SMasami Hiramatsu 	unsigned int num_ei_funcs;
48792ace999SJosef Bacik #endif
4883859a271SKees Cook } ____cacheline_aligned __randomize_layout;
489e61a1c1cSRoman Zippel #ifndef MODULE_ARCH_INIT
490e61a1c1cSRoman Zippel #define MODULE_ARCH_INIT {}
491e61a1c1cSRoman Zippel #endif
4921da177e4SLinus Torvalds 
49393d77e7fSVincent Whitchurch #ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
49493d77e7fSVincent Whitchurch static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
49593d77e7fSVincent Whitchurch {
49693d77e7fSVincent Whitchurch 	return sym->st_value;
49793d77e7fSVincent Whitchurch }
49893d77e7fSVincent Whitchurch #endif
49993d77e7fSVincent Whitchurch 
500c6b37801STim Abbott extern struct mutex module_mutex;
501c6b37801STim Abbott 
5021da177e4SLinus Torvalds /* FIXME: It'd be nice to isolate modules during init, too, so they
5031da177e4SLinus Torvalds    aren't used before they (may) fail.  But presently too much code
5041da177e4SLinus Torvalds    (IDE & SCSI) require entry into the module during init.*/
505171d864eSYaowei Bai static inline bool module_is_live(struct module *mod)
5061da177e4SLinus Torvalds {
5071da177e4SLinus Torvalds 	return mod->state != MODULE_STATE_GOING;
5081da177e4SLinus Torvalds }
5091da177e4SLinus Torvalds 
5101da177e4SLinus Torvalds struct module *__module_text_address(unsigned long addr);
511e610499eSRusty Russell struct module *__module_address(unsigned long addr);
512e610499eSRusty Russell bool is_module_address(unsigned long addr);
513383776faSThomas Gleixner bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
51410fad5e4STejun Heo bool is_module_percpu_address(unsigned long addr);
515e610499eSRusty Russell bool is_module_text_address(unsigned long addr);
5161da177e4SLinus Torvalds 
51776681c8fSPetr Mladek static inline bool within_module_core(unsigned long addr,
51876681c8fSPetr Mladek 				      const struct module *mod)
519a06f6211SMasami Hiramatsu {
5207523e4dcSRusty Russell 	return (unsigned long)mod->core_layout.base <= addr &&
5217523e4dcSRusty Russell 	       addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
522a06f6211SMasami Hiramatsu }
523a06f6211SMasami Hiramatsu 
52476681c8fSPetr Mladek static inline bool within_module_init(unsigned long addr,
52576681c8fSPetr Mladek 				      const struct module *mod)
526a06f6211SMasami Hiramatsu {
5277523e4dcSRusty Russell 	return (unsigned long)mod->init_layout.base <= addr &&
5287523e4dcSRusty Russell 	       addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
529a06f6211SMasami Hiramatsu }
530a06f6211SMasami Hiramatsu 
53176681c8fSPetr Mladek static inline bool within_module(unsigned long addr, const struct module *mod)
5329b20a352SPetr Mladek {
5339b20a352SPetr Mladek 	return within_module_init(addr, mod) || within_module_core(addr, mod);
5349b20a352SPetr Mladek }
5359b20a352SPetr Mladek 
536c6b37801STim Abbott /* Search for module by name: must hold module_mutex. */
537c6b37801STim Abbott struct module *find_module(const char *name);
538c6b37801STim Abbott 
539c6b37801STim Abbott struct symsearch {
540c6b37801STim Abbott 	const struct kernel_symbol *start, *stop;
54171810db2SArd Biesheuvel 	const s32 *crcs;
542c6b37801STim Abbott 	enum {
543c6b37801STim Abbott 		NOT_GPL_ONLY,
544c6b37801STim Abbott 		GPL_ONLY,
545c6b37801STim Abbott 		WILL_BE_GPL_ONLY,
546c6b37801STim Abbott 	} licence;
547c6b37801STim Abbott 	bool unused;
548c6b37801STim Abbott };
549c6b37801STim Abbott 
5500be964beSPeter Zijlstra /*
5510be964beSPeter Zijlstra  * Search for an exported symbol by name.
5520be964beSPeter Zijlstra  *
5530be964beSPeter Zijlstra  * Must be called with module_mutex held or preemption disabled.
5540be964beSPeter Zijlstra  */
555c6b37801STim Abbott const struct kernel_symbol *find_symbol(const char *name,
556c6b37801STim Abbott 					struct module **owner,
55771810db2SArd Biesheuvel 					const s32 **crc,
558c6b37801STim Abbott 					bool gplok,
559c6b37801STim Abbott 					bool warn);
560c6b37801STim Abbott 
5610be964beSPeter Zijlstra /*
5620be964beSPeter Zijlstra  * Walk the exported symbol table
5630be964beSPeter Zijlstra  *
5640be964beSPeter Zijlstra  * Must be called with module_mutex held or preemption disabled.
5650be964beSPeter Zijlstra  */
566de4d8d53SRusty Russell bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
567de4d8d53SRusty Russell 				    struct module *owner,
568de4d8d53SRusty Russell 				    void *data), void *data);
569c6b37801STim Abbott 
570ea07890aSAlexey Dobriyan /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
5711da177e4SLinus Torvalds    symnum out of range. */
572ea07890aSAlexey Dobriyan int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
573ea07890aSAlexey Dobriyan 			char *name, char *module_name, int *exported);
5741da177e4SLinus Torvalds 
5751da177e4SLinus Torvalds /* Look for this name: can be of form module:name. */
5761da177e4SLinus Torvalds unsigned long module_kallsyms_lookup_name(const char *name);
5771da177e4SLinus Torvalds 
57875a66614SAnders Kaseorg int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
57975a66614SAnders Kaseorg 					     struct module *, unsigned long),
58075a66614SAnders Kaseorg 				   void *data);
58175a66614SAnders Kaseorg 
582bf262dceSJiri Kosina extern void __noreturn __module_put_and_exit(struct module *mod,
583bf262dceSJiri Kosina 			long code);
58474e22facSJoe Perches #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
5851da177e4SLinus Torvalds 
5861da177e4SLinus Torvalds #ifdef CONFIG_MODULE_UNLOAD
587d5db139aSRusty Russell int module_refcount(struct module *mod);
5881da177e4SLinus Torvalds void __symbol_put(const char *symbol);
589996302c5SMasahiro Yamada #define symbol_put(x) __symbol_put(__stringify(x))
5901da177e4SLinus Torvalds void symbol_put_addr(void *addr);
5911da177e4SLinus Torvalds 
5921da177e4SLinus Torvalds /* Sometimes we know we already have a refcount, and it's easier not
5931da177e4SLinus Torvalds    to handle the error case (which only happens with rmmod --wait). */
594d53799beSSteven Rostedt extern void __module_get(struct module *module);
5951da177e4SLinus Torvalds 
596d53799beSSteven Rostedt /* This is the Right Way to get a module: if it fails, it's being removed,
597d53799beSSteven Rostedt  * so pretend it's not there. */
598d53799beSSteven Rostedt extern bool try_module_get(struct module *module);
5991da177e4SLinus Torvalds 
600f6a57033SAl Viro extern void module_put(struct module *module);
6011da177e4SLinus Torvalds 
6021da177e4SLinus Torvalds #else /*!CONFIG_MODULE_UNLOAD*/
6038ba4fcdfSGao Feng static inline bool try_module_get(struct module *module)
6041da177e4SLinus Torvalds {
6051da177e4SLinus Torvalds 	return !module || module_is_live(module);
6061da177e4SLinus Torvalds }
6071da177e4SLinus Torvalds static inline void module_put(struct module *module)
6081da177e4SLinus Torvalds {
6091da177e4SLinus Torvalds }
6101da177e4SLinus Torvalds static inline void __module_get(struct module *module)
6111da177e4SLinus Torvalds {
6121da177e4SLinus Torvalds }
6131da177e4SLinus Torvalds #define symbol_put(x) do { } while (0)
6141da177e4SLinus Torvalds #define symbol_put_addr(p) do { } while (0)
6151da177e4SLinus Torvalds 
6161da177e4SLinus Torvalds #endif /* CONFIG_MODULE_UNLOAD */
617dfd62d1dSAnders Kaseorg int ref_module(struct module *a, struct module *b);
6181da177e4SLinus Torvalds 
6191da177e4SLinus Torvalds /* This is a #define so the string doesn't get put in every .o file */
6201da177e4SLinus Torvalds #define module_name(mod)			\
6211da177e4SLinus Torvalds ({						\
6221da177e4SLinus Torvalds 	struct module *__mod = (mod);		\
6231da177e4SLinus Torvalds 	__mod ? __mod->name : "kernel";		\
6241da177e4SLinus Torvalds })
6251da177e4SLinus Torvalds 
626b865ea64SSergey Senozhatsky /* Dereference module function descriptor */
627b865ea64SSergey Senozhatsky void *dereference_module_function_descriptor(struct module *mod, void *ptr);
628b865ea64SSergey Senozhatsky 
6296dd06c9fSRusty Russell /* For kallsyms to ask for address resolution.  namebuf should be at
6306dd06c9fSRusty Russell  * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
6316dd06c9fSRusty Russell  * found, otherwise NULL. */
63292dfc9dcSAndrew Morton const char *module_address_lookup(unsigned long addr,
6331da177e4SLinus Torvalds 			    unsigned long *symbolsize,
6341da177e4SLinus Torvalds 			    unsigned long *offset,
6356dd06c9fSRusty Russell 			    char **modname,
6366dd06c9fSRusty Russell 			    char *namebuf);
6379d65cb4aSAlexey Dobriyan int lookup_module_symbol_name(unsigned long addr, char *symname);
638a5c43daeSAlexey Dobriyan int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
6391da177e4SLinus Torvalds 
6401da177e4SLinus Torvalds int register_module_notifier(struct notifier_block *nb);
6411da177e4SLinus Torvalds int unregister_module_notifier(struct notifier_block *nb);
6421da177e4SLinus Torvalds 
6431da177e4SLinus Torvalds extern void print_modules(void);
6441da177e4SLinus Torvalds 
64580c6e146SDmitry Torokhov static inline bool module_requested_async_probing(struct module *module)
64680c6e146SDmitry Torokhov {
64780c6e146SDmitry Torokhov 	return module && module->async_probe_requested;
64880c6e146SDmitry Torokhov }
64980c6e146SDmitry Torokhov 
6501ce15ef4SJessica Yu #ifdef CONFIG_LIVEPATCH
6511ce15ef4SJessica Yu static inline bool is_livepatch_module(struct module *mod)
6521ce15ef4SJessica Yu {
6531ce15ef4SJessica Yu 	return mod->klp;
6541ce15ef4SJessica Yu }
6551ce15ef4SJessica Yu #else /* !CONFIG_LIVEPATCH */
6561ce15ef4SJessica Yu static inline bool is_livepatch_module(struct module *mod)
6571ce15ef4SJessica Yu {
6581ce15ef4SJessica Yu 	return false;
6591ce15ef4SJessica Yu }
6601ce15ef4SJessica Yu #endif /* CONFIG_LIVEPATCH */
6611ce15ef4SJessica Yu 
662fda784e5SBruno E. O. Meneguele bool is_module_sig_enforced(void);
663fda784e5SBruno E. O. Meneguele 
6641da177e4SLinus Torvalds #else /* !CONFIG_MODULES... */
6651da177e4SLinus Torvalds 
666e610499eSRusty Russell static inline struct module *__module_address(unsigned long addr)
667e610499eSRusty Russell {
668e610499eSRusty Russell 	return NULL;
669e610499eSRusty Russell }
670e610499eSRusty Russell 
6711da177e4SLinus Torvalds static inline struct module *__module_text_address(unsigned long addr)
6721da177e4SLinus Torvalds {
6731da177e4SLinus Torvalds 	return NULL;
6741da177e4SLinus Torvalds }
6751da177e4SLinus Torvalds 
676e610499eSRusty Russell static inline bool is_module_address(unsigned long addr)
6774d435f9dSIngo Molnar {
678e610499eSRusty Russell 	return false;
679e610499eSRusty Russell }
680e610499eSRusty Russell 
681d5e50dafSRandy Dunlap static inline bool is_module_percpu_address(unsigned long addr)
682d5e50dafSRandy Dunlap {
683d5e50dafSRandy Dunlap 	return false;
684d5e50dafSRandy Dunlap }
685d5e50dafSRandy Dunlap 
686383776faSThomas Gleixner static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
687383776faSThomas Gleixner {
688383776faSThomas Gleixner 	return false;
689383776faSThomas Gleixner }
690383776faSThomas Gleixner 
691e610499eSRusty Russell static inline bool is_module_text_address(unsigned long addr)
692e610499eSRusty Russell {
693e610499eSRusty Russell 	return false;
6944d435f9dSIngo Molnar }
6954d435f9dSIngo Molnar 
6961da177e4SLinus Torvalds /* Get/put a kernel symbol (calls should be symmetric) */
6971da177e4SLinus Torvalds #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
6981da177e4SLinus Torvalds #define symbol_put(x) do { } while (0)
6991da177e4SLinus Torvalds #define symbol_put_addr(x) do { } while (0)
7001da177e4SLinus Torvalds 
7011da177e4SLinus Torvalds static inline void __module_get(struct module *module)
7021da177e4SLinus Torvalds {
7031da177e4SLinus Torvalds }
7041da177e4SLinus Torvalds 
7058ba4fcdfSGao Feng static inline bool try_module_get(struct module *module)
7061da177e4SLinus Torvalds {
7078ba4fcdfSGao Feng 	return true;
7081da177e4SLinus Torvalds }
7091da177e4SLinus Torvalds 
7101da177e4SLinus Torvalds static inline void module_put(struct module *module)
7111da177e4SLinus Torvalds {
7121da177e4SLinus Torvalds }
7131da177e4SLinus Torvalds 
7141da177e4SLinus Torvalds #define module_name(mod) "kernel"
7151da177e4SLinus Torvalds 
7161da177e4SLinus Torvalds /* For kallsyms to ask for address resolution.  NULL means not found. */
71792dfc9dcSAndrew Morton static inline const char *module_address_lookup(unsigned long addr,
7181da177e4SLinus Torvalds 					  unsigned long *symbolsize,
7191da177e4SLinus Torvalds 					  unsigned long *offset,
7206dd06c9fSRusty Russell 					  char **modname,
7216dd06c9fSRusty Russell 					  char *namebuf)
7221da177e4SLinus Torvalds {
7231da177e4SLinus Torvalds 	return NULL;
7241da177e4SLinus Torvalds }
7251da177e4SLinus Torvalds 
7269d65cb4aSAlexey Dobriyan static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
7279d65cb4aSAlexey Dobriyan {
7289d65cb4aSAlexey Dobriyan 	return -ERANGE;
7299d65cb4aSAlexey Dobriyan }
7309d65cb4aSAlexey Dobriyan 
731a5c43daeSAlexey Dobriyan static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
732a5c43daeSAlexey Dobriyan {
733a5c43daeSAlexey Dobriyan 	return -ERANGE;
734a5c43daeSAlexey Dobriyan }
735a5c43daeSAlexey Dobriyan 
736ea07890aSAlexey Dobriyan static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
737ea07890aSAlexey Dobriyan 					char *type, char *name,
738ea07890aSAlexey Dobriyan 					char *module_name, int *exported)
7391da177e4SLinus Torvalds {
740ea07890aSAlexey Dobriyan 	return -ERANGE;
7411da177e4SLinus Torvalds }
7421da177e4SLinus Torvalds 
7431da177e4SLinus Torvalds static inline unsigned long module_kallsyms_lookup_name(const char *name)
7441da177e4SLinus Torvalds {
7451da177e4SLinus Torvalds 	return 0;
7461da177e4SLinus Torvalds }
7471da177e4SLinus Torvalds 
74875a66614SAnders Kaseorg static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
74975a66614SAnders Kaseorg 							   struct module *,
75075a66614SAnders Kaseorg 							   unsigned long),
75175a66614SAnders Kaseorg 						 void *data)
75275a66614SAnders Kaseorg {
75375a66614SAnders Kaseorg 	return 0;
75475a66614SAnders Kaseorg }
75575a66614SAnders Kaseorg 
7561da177e4SLinus Torvalds static inline int register_module_notifier(struct notifier_block *nb)
7571da177e4SLinus Torvalds {
7581da177e4SLinus Torvalds 	/* no events will happen anyway, so this can always succeed */
7591da177e4SLinus Torvalds 	return 0;
7601da177e4SLinus Torvalds }
7611da177e4SLinus Torvalds 
7621da177e4SLinus Torvalds static inline int unregister_module_notifier(struct notifier_block *nb)
7631da177e4SLinus Torvalds {
7641da177e4SLinus Torvalds 	return 0;
7651da177e4SLinus Torvalds }
7661da177e4SLinus Torvalds 
7671da177e4SLinus Torvalds #define module_put_and_exit(code) do_exit(code)
7681da177e4SLinus Torvalds 
7691da177e4SLinus Torvalds static inline void print_modules(void)
7701da177e4SLinus Torvalds {
7711da177e4SLinus Torvalds }
77280c6e146SDmitry Torokhov 
77380c6e146SDmitry Torokhov static inline bool module_requested_async_probing(struct module *module)
77480c6e146SDmitry Torokhov {
77580c6e146SDmitry Torokhov 	return false;
77680c6e146SDmitry Torokhov }
77780c6e146SDmitry Torokhov 
778fda784e5SBruno E. O. Meneguele static inline bool is_module_sig_enforced(void)
779fda784e5SBruno E. O. Meneguele {
780fda784e5SBruno E. O. Meneguele 	return false;
781fda784e5SBruno E. O. Meneguele }
782fda784e5SBruno E. O. Meneguele 
783b865ea64SSergey Senozhatsky /* Dereference module function descriptor */
784b865ea64SSergey Senozhatsky static inline
785b865ea64SSergey Senozhatsky void *dereference_module_function_descriptor(struct module *mod, void *ptr)
786b865ea64SSergey Senozhatsky {
787b865ea64SSergey Senozhatsky 	return ptr;
788b865ea64SSergey Senozhatsky }
789b865ea64SSergey Senozhatsky 
790ef665c1aSRandy Dunlap #endif /* CONFIG_MODULES */
791ef665c1aSRandy Dunlap 
792ef665c1aSRandy Dunlap #ifdef CONFIG_SYSFS
7937405c1e1SGreg Kroah-Hartman extern struct kset *module_kset;
7947405c1e1SGreg Kroah-Hartman extern struct kobj_type module_ktype;
7957405c1e1SGreg Kroah-Hartman extern int module_sysfs_initialized;
796ef665c1aSRandy Dunlap #endif /* CONFIG_SYSFS */
797ef665c1aSRandy Dunlap 
7981da177e4SLinus Torvalds #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
7991da177e4SLinus Torvalds 
8001da177e4SLinus Torvalds /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
8011da177e4SLinus Torvalds 
8021da177e4SLinus Torvalds #define __MODULE_STRING(x) __stringify(x)
8031da177e4SLinus Torvalds 
8040f5bf6d0SLaura Abbott #ifdef CONFIG_STRICT_MODULE_RWX
80584e1c6bbSmatthieu castet extern void set_all_modules_text_rw(void);
80684e1c6bbSmatthieu castet extern void set_all_modules_text_ro(void);
807444d13ffSJessica Yu extern void module_enable_ro(const struct module *mod, bool after_init);
80885c898dbSRusty Russell extern void module_disable_ro(const struct module *mod);
80984e1c6bbSmatthieu castet #else
81084e1c6bbSmatthieu castet static inline void set_all_modules_text_rw(void) { }
81184e1c6bbSmatthieu castet static inline void set_all_modules_text_ro(void) { }
812444d13ffSJessica Yu static inline void module_enable_ro(const struct module *mod, bool after_init) { }
81385c898dbSRusty Russell static inline void module_disable_ro(const struct module *mod) { }
81484e1c6bbSmatthieu castet #endif
8150d9c25ddSAndrew Morton 
8160d9c25ddSAndrew Morton #ifdef CONFIG_GENERIC_BUG
8175336377dSLinus Torvalds void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
8180d9c25ddSAndrew Morton 			 struct module *);
8190d9c25ddSAndrew Morton void module_bug_cleanup(struct module *);
8200d9c25ddSAndrew Morton 
8210d9c25ddSAndrew Morton #else	/* !CONFIG_GENERIC_BUG */
8220d9c25ddSAndrew Morton 
8235336377dSLinus Torvalds static inline void module_bug_finalize(const Elf_Ehdr *hdr,
8240d9c25ddSAndrew Morton 					const Elf_Shdr *sechdrs,
8250d9c25ddSAndrew Morton 					struct module *mod)
8260d9c25ddSAndrew Morton {
8270d9c25ddSAndrew Morton }
8280d9c25ddSAndrew Morton static inline void module_bug_cleanup(struct module *mod) {}
8290d9c25ddSAndrew Morton #endif	/* CONFIG_GENERIC_BUG */
8300d9c25ddSAndrew Morton 
831*e4f35891SWANG Chao #ifdef CONFIG_RETPOLINE
832caf7501aSAndi Kleen extern bool retpoline_module_ok(bool has_retpoline);
833caf7501aSAndi Kleen #else
834caf7501aSAndi Kleen static inline bool retpoline_module_ok(bool has_retpoline)
835caf7501aSAndi Kleen {
836caf7501aSAndi Kleen 	return true;
837caf7501aSAndi Kleen }
838caf7501aSAndi Kleen #endif
839caf7501aSAndi Kleen 
84059afdc7bSHerbert Xu #ifdef CONFIG_MODULE_SIG
84159afdc7bSHerbert Xu static inline bool module_sig_ok(struct module *module)
84259afdc7bSHerbert Xu {
84359afdc7bSHerbert Xu 	return module->sig_ok;
84459afdc7bSHerbert Xu }
84559afdc7bSHerbert Xu #else	/* !CONFIG_MODULE_SIG */
84659afdc7bSHerbert Xu static inline bool module_sig_ok(struct module *module)
84759afdc7bSHerbert Xu {
84859afdc7bSHerbert Xu 	return true;
84959afdc7bSHerbert Xu }
85059afdc7bSHerbert Xu #endif	/* CONFIG_MODULE_SIG */
85159afdc7bSHerbert Xu 
8521da177e4SLinus Torvalds #endif /* _LINUX_MODULE_H */
853