xref: /linux-6.15/include/linux/module.h (revision ca3574bd)
1bf49d9ddSMasahiro Yamada /* SPDX-License-Identifier: GPL-2.0-only */
21da177e4SLinus Torvalds /*
31da177e4SLinus Torvalds  * Dynamic loading of modules into the kernel.
41da177e4SLinus Torvalds  *
51da177e4SLinus Torvalds  * Rewritten by Richard Henderson <[email protected]> Dec 1996
61da177e4SLinus Torvalds  * Rewritten again by Rusty Russell, 2002
71da177e4SLinus Torvalds  */
8bf49d9ddSMasahiro Yamada 
9bf49d9ddSMasahiro Yamada #ifndef _LINUX_MODULE_H
10bf49d9ddSMasahiro Yamada #define _LINUX_MODULE_H
11bf49d9ddSMasahiro Yamada 
121da177e4SLinus Torvalds #include <linux/list.h>
131da177e4SLinus Torvalds #include <linux/stat.h>
149294523eSStephen Boyd #include <linux/buildid.h>
151da177e4SLinus Torvalds #include <linux/compiler.h>
161da177e4SLinus Torvalds #include <linux/cache.h>
171da177e4SLinus Torvalds #include <linux/kmod.h>
180fd972a7SPaul Gortmaker #include <linux/init.h>
191da177e4SLinus Torvalds #include <linux/elf.h>
201da177e4SLinus Torvalds #include <linux/stringify.h>
211da177e4SLinus Torvalds #include <linux/kobject.h>
221da177e4SLinus Torvalds #include <linux/moduleparam.h>
23b2e285fcSSteven Rostedt (Red Hat) #include <linux/jump_label.h>
24f5016932SPaul Gortmaker #include <linux/export.h>
2593c2e105SPeter Zijlstra #include <linux/rbtree_latch.h>
26663faf9fSMasami Hiramatsu #include <linux/error-injection.h>
279c0be3f6SMathieu Desnoyers #include <linux/tracepoint-defs.h>
28fe15b50cSPaul E. McKenney #include <linux/srcu.h>
299183c3f9SJosh Poimboeuf #include <linux/static_call_types.h>
30cf68fffbSSami Tolvanen #include <linux/cfi.h>
311da177e4SLinus Torvalds 
32e1783a24SChristoph Lameter #include <linux/percpu.h>
331da177e4SLinus Torvalds #include <asm/module.h>
341da177e4SLinus Torvalds 
35730b69d2SRusty Russell #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
361da177e4SLinus Torvalds 
37e865d06bSSeunghun Lee struct modversion_info {
381da177e4SLinus Torvalds 	unsigned long crc;
391da177e4SLinus Torvalds 	char name[MODULE_NAME_LEN];
401da177e4SLinus Torvalds };
411da177e4SLinus Torvalds 
421da177e4SLinus Torvalds struct module;
430ef76537SPaul Gortmaker struct exception_table_entry;
441da177e4SLinus Torvalds 
454befb026SKay Sievers struct module_kobject {
464befb026SKay Sievers 	struct kobject kobj;
474befb026SKay Sievers 	struct module *mod;
484befb026SKay Sievers 	struct kobject *drivers_dir;
494befb026SKay Sievers 	struct module_param_attrs *mp;
50942e4431SLi Zhong 	struct completion *kobj_completion;
513859a271SKees Cook } __randomize_layout;
524befb026SKay Sievers 
531da177e4SLinus Torvalds struct module_attribute {
541da177e4SLinus Torvalds 	struct attribute attr;
554befb026SKay Sievers 	ssize_t (*show)(struct module_attribute *, struct module_kobject *,
564befb026SKay Sievers 			char *);
574befb026SKay Sievers 	ssize_t (*store)(struct module_attribute *, struct module_kobject *,
581da177e4SLinus Torvalds 			 const char *, size_t count);
59c988d2b2SMatt Domsch 	void (*setup)(struct module *, const char *);
60c988d2b2SMatt Domsch 	int (*test)(struct module *);
61c988d2b2SMatt Domsch 	void (*free)(struct module *);
621da177e4SLinus Torvalds };
631da177e4SLinus Torvalds 
64e94965edSDmitry Torokhov struct module_version_attribute {
65e94965edSDmitry Torokhov 	struct module_attribute mattr;
66e94965edSDmitry Torokhov 	const char *module_name;
67e94965edSDmitry Torokhov 	const char *version;
680801a007SJohan Hovold };
69e94965edSDmitry Torokhov 
709b73a584SDmitry Torokhov extern ssize_t __modver_version_show(struct module_attribute *,
714befb026SKay Sievers 				     struct module_kobject *, char *);
729b73a584SDmitry Torokhov 
7388bfa324SKay Sievers extern struct module_attribute module_uevent;
741da177e4SLinus Torvalds 
751da177e4SLinus Torvalds /* These are either module local, or the kernel's dummy ones. */
761da177e4SLinus Torvalds extern int init_module(void);
771da177e4SLinus Torvalds extern void cleanup_module(void);
781da177e4SLinus Torvalds 
790fd972a7SPaul Gortmaker #ifndef MODULE
800fd972a7SPaul Gortmaker /**
810fd972a7SPaul Gortmaker  * module_init() - driver initialization entry point
820fd972a7SPaul Gortmaker  * @x: function to be run at kernel boot time or module insertion
830fd972a7SPaul Gortmaker  *
840fd972a7SPaul Gortmaker  * module_init() will either be called during do_initcalls() (if
850fd972a7SPaul Gortmaker  * builtin) or at module insertion time (if a module).  There can only
860fd972a7SPaul Gortmaker  * be one per module.
870fd972a7SPaul Gortmaker  */
880fd972a7SPaul Gortmaker #define module_init(x)	__initcall(x);
890fd972a7SPaul Gortmaker 
900fd972a7SPaul Gortmaker /**
910fd972a7SPaul Gortmaker  * module_exit() - driver exit entry point
920fd972a7SPaul Gortmaker  * @x: function to be run when driver is removed
930fd972a7SPaul Gortmaker  *
940fd972a7SPaul Gortmaker  * module_exit() will wrap the driver clean-up code
950fd972a7SPaul Gortmaker  * with cleanup_module() when used with rmmod when
960fd972a7SPaul Gortmaker  * the driver is a module.  If the driver is statically
970fd972a7SPaul Gortmaker  * compiled into the kernel, module_exit() has no effect.
980fd972a7SPaul Gortmaker  * There can only be one per module.
990fd972a7SPaul Gortmaker  */
1000fd972a7SPaul Gortmaker #define module_exit(x)	__exitcall(x);
1010fd972a7SPaul Gortmaker 
1020fd972a7SPaul Gortmaker #else /* MODULE */
1030fd972a7SPaul Gortmaker 
1040fd972a7SPaul Gortmaker /*
1050fd972a7SPaul Gortmaker  * In most cases loadable modules do not need custom
1060fd972a7SPaul Gortmaker  * initcall levels. There are still some valid cases where
1070fd972a7SPaul Gortmaker  * a driver may be needed early if built in, and does not
1080fd972a7SPaul Gortmaker  * matter when built as a loadable module. Like bus
1090fd972a7SPaul Gortmaker  * snooping debug drivers.
1100fd972a7SPaul Gortmaker  */
1110fd972a7SPaul Gortmaker #define early_initcall(fn)		module_init(fn)
1120fd972a7SPaul Gortmaker #define core_initcall(fn)		module_init(fn)
1130fd972a7SPaul Gortmaker #define core_initcall_sync(fn)		module_init(fn)
1140fd972a7SPaul Gortmaker #define postcore_initcall(fn)		module_init(fn)
1150fd972a7SPaul Gortmaker #define postcore_initcall_sync(fn)	module_init(fn)
1160fd972a7SPaul Gortmaker #define arch_initcall(fn)		module_init(fn)
1170fd972a7SPaul Gortmaker #define subsys_initcall(fn)		module_init(fn)
1180fd972a7SPaul Gortmaker #define subsys_initcall_sync(fn)	module_init(fn)
1190fd972a7SPaul Gortmaker #define fs_initcall(fn)			module_init(fn)
1200fd972a7SPaul Gortmaker #define fs_initcall_sync(fn)		module_init(fn)
1210fd972a7SPaul Gortmaker #define rootfs_initcall(fn)		module_init(fn)
1220fd972a7SPaul Gortmaker #define device_initcall(fn)		module_init(fn)
1230fd972a7SPaul Gortmaker #define device_initcall_sync(fn)	module_init(fn)
1240fd972a7SPaul Gortmaker #define late_initcall(fn)		module_init(fn)
1250fd972a7SPaul Gortmaker #define late_initcall_sync(fn)		module_init(fn)
1260fd972a7SPaul Gortmaker 
1270fd972a7SPaul Gortmaker #define console_initcall(fn)		module_init(fn)
1280fd972a7SPaul Gortmaker 
1290fd972a7SPaul Gortmaker /* Each module must use one module_init(). */
1300fd972a7SPaul Gortmaker #define module_init(initfn)					\
1311f318a8bSArnd Bergmann 	static inline initcall_t __maybe_unused __inittest(void)		\
1320fd972a7SPaul Gortmaker 	{ return initfn; }					\
133cf68fffbSSami Tolvanen 	int init_module(void) __copy(initfn)			\
134cf68fffbSSami Tolvanen 		__attribute__((alias(#initfn)));		\
135cf68fffbSSami Tolvanen 	__CFI_ADDRESSABLE(init_module, __initdata);
1360fd972a7SPaul Gortmaker 
1370fd972a7SPaul Gortmaker /* This is only required if you want to be unloadable. */
1380fd972a7SPaul Gortmaker #define module_exit(exitfn)					\
1391f318a8bSArnd Bergmann 	static inline exitcall_t __maybe_unused __exittest(void)		\
1400fd972a7SPaul Gortmaker 	{ return exitfn; }					\
141cf68fffbSSami Tolvanen 	void cleanup_module(void) __copy(exitfn)		\
142cf68fffbSSami Tolvanen 		__attribute__((alias(#exitfn)));		\
143cf68fffbSSami Tolvanen 	__CFI_ADDRESSABLE(cleanup_module, __exitdata);
1440fd972a7SPaul Gortmaker 
1450fd972a7SPaul Gortmaker #endif
1460fd972a7SPaul Gortmaker 
1470fd972a7SPaul Gortmaker /* This means "can be init if no module support, otherwise module load
1480fd972a7SPaul Gortmaker    may call it." */
1490fd972a7SPaul Gortmaker #ifdef CONFIG_MODULES
1500fd972a7SPaul Gortmaker #define __init_or_module
1510fd972a7SPaul Gortmaker #define __initdata_or_module
1520fd972a7SPaul Gortmaker #define __initconst_or_module
1530fd972a7SPaul Gortmaker #define __INIT_OR_MODULE	.text
1540fd972a7SPaul Gortmaker #define __INITDATA_OR_MODULE	.data
1550fd972a7SPaul Gortmaker #define __INITRODATA_OR_MODULE	.section ".rodata","a",%progbits
1560fd972a7SPaul Gortmaker #else
1570fd972a7SPaul Gortmaker #define __init_or_module __init
1580fd972a7SPaul Gortmaker #define __initdata_or_module __initdata
1590fd972a7SPaul Gortmaker #define __initconst_or_module __initconst
1600fd972a7SPaul Gortmaker #define __INIT_OR_MODULE __INIT
1610fd972a7SPaul Gortmaker #define __INITDATA_OR_MODULE __INITDATA
1620fd972a7SPaul Gortmaker #define __INITRODATA_OR_MODULE __INITRODATA
1630fd972a7SPaul Gortmaker #endif /*CONFIG_MODULES*/
1640fd972a7SPaul Gortmaker 
1651da177e4SLinus Torvalds /* Generic info of form tag = "info" */
1661da177e4SLinus Torvalds #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
1671da177e4SLinus Torvalds 
1681da177e4SLinus Torvalds /* For userspace: you can also call me... */
1691da177e4SLinus Torvalds #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
1701da177e4SLinus Torvalds 
1717cb14ba7SAndreas Robinson /* Soft module dependencies. See man modprobe.d for details.
1727cb14ba7SAndreas Robinson  * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
1737cb14ba7SAndreas Robinson  */
1747cb14ba7SAndreas Robinson #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
1757cb14ba7SAndreas Robinson 
1761da177e4SLinus Torvalds /*
1778b41fc44SMasahiro Yamada  * MODULE_FILE is used for generating modules.builtin
1788b41fc44SMasahiro Yamada  * So, make it no-op when this is being built as a module
1798b41fc44SMasahiro Yamada  */
1808b41fc44SMasahiro Yamada #ifdef MODULE
1818b41fc44SMasahiro Yamada #define MODULE_FILE
1828b41fc44SMasahiro Yamada #else
1838b41fc44SMasahiro Yamada #define MODULE_FILE	MODULE_INFO(file, KBUILD_MODFILE);
1848b41fc44SMasahiro Yamada #endif
1858b41fc44SMasahiro Yamada 
1868b41fc44SMasahiro Yamada /*
1871da177e4SLinus Torvalds  * The following license idents are currently accepted as indicating free
1881da177e4SLinus Torvalds  * software modules
1891da177e4SLinus Torvalds  *
190bf7fbeeaSThomas Gleixner  *	"GPL"				[GNU Public License v2]
1911da177e4SLinus Torvalds  *	"GPL v2"			[GNU Public License v2]
1921da177e4SLinus Torvalds  *	"GPL and additional rights"	[GNU Public License v2 rights and more]
1931da177e4SLinus Torvalds  *	"Dual BSD/GPL"			[GNU Public License v2
1941da177e4SLinus Torvalds  *					 or BSD license choice]
1958d27e908SXose Vazquez Perez  *	"Dual MIT/GPL"			[GNU Public License v2
1968d27e908SXose Vazquez Perez  *					 or MIT license choice]
1971da177e4SLinus Torvalds  *	"Dual MPL/GPL"			[GNU Public License v2
1981da177e4SLinus Torvalds  *					 or Mozilla license choice]
1991da177e4SLinus Torvalds  *
2001da177e4SLinus Torvalds  * The following other idents are available
2011da177e4SLinus Torvalds  *
2021da177e4SLinus Torvalds  *	"Proprietary"			[Non free products]
2031da177e4SLinus Torvalds  *
204bf7fbeeaSThomas Gleixner  * Both "GPL v2" and "GPL" (the latter also in dual licensed strings) are
205bf7fbeeaSThomas Gleixner  * merely stating that the module is licensed under the GPL v2, but are not
206bf7fbeeaSThomas Gleixner  * telling whether "GPL v2 only" or "GPL v2 or later". The reason why there
207bf7fbeeaSThomas Gleixner  * are two variants is a historic and failed attempt to convey more
208bf7fbeeaSThomas Gleixner  * information in the MODULE_LICENSE string. For module loading the
209bf7fbeeaSThomas Gleixner  * "only/or later" distinction is completely irrelevant and does neither
210bf7fbeeaSThomas Gleixner  * replace the proper license identifiers in the corresponding source file
211bf7fbeeaSThomas Gleixner  * nor amends them in any way. The sole purpose is to make the
212bf7fbeeaSThomas Gleixner  * 'Proprietary' flagging work and to refuse to bind symbols which are
213bf7fbeeaSThomas Gleixner  * exported with EXPORT_SYMBOL_GPL when a non free module is loaded.
214bf7fbeeaSThomas Gleixner  *
215bf7fbeeaSThomas Gleixner  * In the same way "BSD" is not a clear license information. It merely
216bf7fbeeaSThomas Gleixner  * states, that the module is licensed under one of the compatible BSD
217bf7fbeeaSThomas Gleixner  * license variants. The detailed and correct license information is again
218bf7fbeeaSThomas Gleixner  * to be found in the corresponding source files.
219bf7fbeeaSThomas Gleixner  *
2201da177e4SLinus Torvalds  * There are dual licensed components, but when running with Linux it is the
2211da177e4SLinus Torvalds  * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
2221da177e4SLinus Torvalds  * is a GPL combined work.
2231da177e4SLinus Torvalds  *
2241da177e4SLinus Torvalds  * This exists for several reasons
2251da177e4SLinus Torvalds  * 1.	So modinfo can show license info for users wanting to vet their setup
2261da177e4SLinus Torvalds  *	is free
2271da177e4SLinus Torvalds  * 2.	So the community can ignore bug reports including proprietary modules
2281da177e4SLinus Torvalds  * 3.	So vendors can do likewise based on their own policies
2291da177e4SLinus Torvalds  */
2308b41fc44SMasahiro Yamada #define MODULE_LICENSE(_license) MODULE_FILE MODULE_INFO(license, _license)
2311da177e4SLinus Torvalds 
2321d7015caSJohannes Berg /*
2331d7015caSJohannes Berg  * Author(s), use "Name <email>" or just "Name", for multiple
2341d7015caSJohannes Berg  * authors use multiple MODULE_AUTHOR() statements/lines.
2351d7015caSJohannes Berg  */
2361da177e4SLinus Torvalds #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
2371da177e4SLinus Torvalds 
2381da177e4SLinus Torvalds /* What your module does. */
2391da177e4SLinus Torvalds #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
2401da177e4SLinus Torvalds 
241cff26a51SRusty Russell #ifdef MODULE
242cff26a51SRusty Russell /* Creates an alias so file2alias.c can find device table. */
2431da177e4SLinus Torvalds #define MODULE_DEVICE_TABLE(type, name)					\
2440bf8bf50SMatthias Kaehlcke extern typeof(name) __mod_##type##__##name##_device_table		\
245cff26a51SRusty Russell   __attribute__ ((unused, alias(__stringify(name))))
246cff26a51SRusty Russell #else  /* !MODULE */
247cff26a51SRusty Russell #define MODULE_DEVICE_TABLE(type, name)
248cff26a51SRusty Russell #endif
2491da177e4SLinus Torvalds 
2501da177e4SLinus Torvalds /* Version of form [<epoch>:]<version>[-<extra-version>].
251e865d06bSSeunghun Lee  * Or for CVS/RCS ID version, everything but the number is stripped.
252e865d06bSSeunghun Lee  * <epoch>: A (small) unsigned integer which allows you to start versions
253e865d06bSSeunghun Lee  * anew. If not mentioned, it's zero.  eg. "2:1.0" is after
254e865d06bSSeunghun Lee  * "1:2.0".
2551da177e4SLinus Torvalds 
256e865d06bSSeunghun Lee  * <version>: The <version> may contain only alphanumerics and the
257e865d06bSSeunghun Lee  * character `.'.  Ordered by numeric sort for numeric parts,
258e865d06bSSeunghun Lee  * ascii sort for ascii parts (as per RPM or DEB algorithm).
259e865d06bSSeunghun Lee 
260e865d06bSSeunghun Lee  * <extraversion>: Like <version>, but inserted for local
261e865d06bSSeunghun Lee  * customizations, eg "rh3" or "rusty1".
262e865d06bSSeunghun Lee 
263e865d06bSSeunghun Lee  * Using this automatically adds a checksum of the .c files and the
264e865d06bSSeunghun Lee  * local headers in "srcversion".
2651da177e4SLinus Torvalds  */
266e94965edSDmitry Torokhov 
2673b90a5b2SRusty Russell #if defined(MODULE) || !defined(CONFIG_SYSFS)
2681da177e4SLinus Torvalds #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
269e94965edSDmitry Torokhov #else
270e94965edSDmitry Torokhov #define MODULE_VERSION(_version)					\
271898490c0SAlexey Gladkov 	MODULE_INFO(version, _version);					\
272b112082cSJohan Hovold 	static struct module_version_attribute __modver_attr		\
273b112082cSJohan Hovold 		__used __section("__modver")				\
274b112082cSJohan Hovold 		__aligned(__alignof__(struct module_version_attribute)) \
275b112082cSJohan Hovold 		= {							\
276e94965edSDmitry Torokhov 			.mattr	= {					\
277e94965edSDmitry Torokhov 				.attr	= {				\
278e94965edSDmitry Torokhov 					.name	= "version",		\
279e94965edSDmitry Torokhov 					.mode	= S_IRUGO,		\
280e94965edSDmitry Torokhov 				},					\
281e94965edSDmitry Torokhov 				.show	= __modver_version_show,	\
282e94965edSDmitry Torokhov 			},						\
283e94965edSDmitry Torokhov 			.module_name	= KBUILD_MODNAME,		\
284e94965edSDmitry Torokhov 			.version	= _version,			\
2852d26c716SJohan Hovold 		}
286e94965edSDmitry Torokhov #endif
2871da177e4SLinus Torvalds 
288187afbedSJon Masters /* Optional firmware file (or files) needed by the module
289187afbedSJon Masters  * format is simply firmware file name.  Multiple firmware
290187afbedSJon Masters  * files require multiple MODULE_FIRMWARE() specifiers */
291187afbedSJon Masters #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
292187afbedSJon Masters 
2933e4d890aSLinus Torvalds #define MODULE_IMPORT_NS(ns) MODULE_INFO(import_ns, #ns)
2943e4d890aSLinus Torvalds 
2951da177e4SLinus Torvalds struct notifier_block;
2961da177e4SLinus Torvalds 
2971da177e4SLinus Torvalds #ifdef CONFIG_MODULES
2981da177e4SLinus Torvalds 
2995ed10910SDave Young extern int modules_disabled; /* for sysctl */
3001da177e4SLinus Torvalds /* Get/put a kernel symbol (calls must be symmetric) */
3011da177e4SLinus Torvalds void *__symbol_get(const char *symbol);
3021da177e4SLinus Torvalds void *__symbol_get_gpl(const char *symbol);
303996302c5SMasahiro Yamada #define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
3041da177e4SLinus Torvalds 
305c8e21cedSRusty Russell /* modules using other modules: kdb wants to see this. */
306c8e21cedSRusty Russell struct module_use {
307c8e21cedSRusty Russell 	struct list_head source_list;
308c8e21cedSRusty Russell 	struct list_head target_list;
309c8e21cedSRusty Russell 	struct module *source, *target;
310c8e21cedSRusty Russell };
311c8e21cedSRusty Russell 
3120d21b0e3SRusty Russell enum module_state {
3130d21b0e3SRusty Russell 	MODULE_STATE_LIVE,	/* Normal state. */
3140d21b0e3SRusty Russell 	MODULE_STATE_COMING,	/* Full formed, running module_init. */
3150d21b0e3SRusty Russell 	MODULE_STATE_GOING,	/* Going away. */
3160d21b0e3SRusty Russell 	MODULE_STATE_UNFORMED,	/* Still setting it up. */
3171da177e4SLinus Torvalds };
3181da177e4SLinus Torvalds 
31993c2e105SPeter Zijlstra struct mod_tree_node {
32093c2e105SPeter Zijlstra 	struct module *mod;
32193c2e105SPeter Zijlstra 	struct latch_tree_node node;
32293c2e105SPeter Zijlstra };
32393c2e105SPeter Zijlstra 
3247523e4dcSRusty Russell struct module_layout {
3257523e4dcSRusty Russell 	/* The actual code + data. */
3267523e4dcSRusty Russell 	void *base;
3277523e4dcSRusty Russell 	/* Total size. */
3287523e4dcSRusty Russell 	unsigned int size;
3297523e4dcSRusty Russell 	/* The size of the executable code.  */
3307523e4dcSRusty Russell 	unsigned int text_size;
3317523e4dcSRusty Russell 	/* Size of RO section of the module (text+rodata) */
3327523e4dcSRusty Russell 	unsigned int ro_size;
333444d13ffSJessica Yu 	/* Size of RO after init section */
334444d13ffSJessica Yu 	unsigned int ro_after_init_size;
3357523e4dcSRusty Russell 
3367523e4dcSRusty Russell #ifdef CONFIG_MODULES_TREE_LOOKUP
3377523e4dcSRusty Russell 	struct mod_tree_node mtn;
3387523e4dcSRusty Russell #endif
3397523e4dcSRusty Russell };
3407523e4dcSRusty Russell 
3417523e4dcSRusty Russell #ifdef CONFIG_MODULES_TREE_LOOKUP
3427523e4dcSRusty Russell /* Only touch one cacheline for common rbtree-for-core-layout case. */
3437523e4dcSRusty Russell #define __module_layout_align ____cacheline_aligned
3447523e4dcSRusty Russell #else
3457523e4dcSRusty Russell #define __module_layout_align
3467523e4dcSRusty Russell #endif
3477523e4dcSRusty Russell 
3488244062eSRusty Russell struct mod_kallsyms {
3498244062eSRusty Russell 	Elf_Sym *symtab;
3508244062eSRusty Russell 	unsigned int num_symtab;
3518244062eSRusty Russell 	char *strtab;
3521c7651f4SEugene Loh 	char *typetab;
3538244062eSRusty Russell };
3548244062eSRusty Russell 
3551ce15ef4SJessica Yu #ifdef CONFIG_LIVEPATCH
3561ce15ef4SJessica Yu struct klp_modinfo {
3571ce15ef4SJessica Yu 	Elf_Ehdr hdr;
3581ce15ef4SJessica Yu 	Elf_Shdr *sechdrs;
3591ce15ef4SJessica Yu 	char *secstrings;
3601ce15ef4SJessica Yu 	unsigned int symndx;
3611ce15ef4SJessica Yu };
3621ce15ef4SJessica Yu #endif
3631ce15ef4SJessica Yu 
364e865d06bSSeunghun Lee struct module {
3651da177e4SLinus Torvalds 	enum module_state state;
3661da177e4SLinus Torvalds 
3671da177e4SLinus Torvalds 	/* Member of list of modules */
3681da177e4SLinus Torvalds 	struct list_head list;
3691da177e4SLinus Torvalds 
3701da177e4SLinus Torvalds 	/* Unique handle for this module */
3711da177e4SLinus Torvalds 	char name[MODULE_NAME_LEN];
3721da177e4SLinus Torvalds 
3739294523eSStephen Boyd #ifdef CONFIG_STACKTRACE_BUILD_ID
3749294523eSStephen Boyd 	/* Module build ID */
3759294523eSStephen Boyd 	unsigned char build_id[BUILD_ID_SIZE_MAX];
3769294523eSStephen Boyd #endif
3779294523eSStephen Boyd 
3781da177e4SLinus Torvalds 	/* Sysfs stuff. */
3791da177e4SLinus Torvalds 	struct module_kobject mkobj;
38003e88ae1SGreg Kroah-Hartman 	struct module_attribute *modinfo_attrs;
381c988d2b2SMatt Domsch 	const char *version;
382c988d2b2SMatt Domsch 	const char *srcversion;
383270a6c4cSKay Sievers 	struct kobject *holders_dir;
3841da177e4SLinus Torvalds 
3851da177e4SLinus Torvalds 	/* Exported symbols */
3861da177e4SLinus Torvalds 	const struct kernel_symbol *syms;
38771810db2SArd Biesheuvel 	const s32 *crcs;
388af540689SRichard Kennedy 	unsigned int num_syms;
3891da177e4SLinus Torvalds 
390cf68fffbSSami Tolvanen #ifdef CONFIG_CFI_CLANG
391cf68fffbSSami Tolvanen 	cfi_check_fn cfi_check;
392cf68fffbSSami Tolvanen #endif
393cf68fffbSSami Tolvanen 
394e180a6b7SRusty Russell 	/* Kernel parameters. */
395cf2fde7bSRusty Russell #ifdef CONFIG_SYSFS
396b51d23e4SDan Streetman 	struct mutex param_lock;
397cf2fde7bSRusty Russell #endif
398e180a6b7SRusty Russell 	struct kernel_param *kp;
399e180a6b7SRusty Russell 	unsigned int num_kp;
400e180a6b7SRusty Russell 
4011da177e4SLinus Torvalds 	/* GPL-only exported symbols. */
4021da177e4SLinus Torvalds 	unsigned int num_gpl_syms;
403af540689SRichard Kennedy 	const struct kernel_symbol *gpl_syms;
40471810db2SArd Biesheuvel 	const s32 *gpl_crcs;
405262e6ae7SChristoph Hellwig 	bool using_gplonly_symbols;
4061da177e4SLinus Torvalds 
407106a4ee2SRusty Russell #ifdef CONFIG_MODULE_SIG
408106a4ee2SRusty Russell 	/* Signature was verified. */
409106a4ee2SRusty Russell 	bool sig_ok;
410106a4ee2SRusty Russell #endif
411106a4ee2SRusty Russell 
412f2411da7SLuis R. Rodriguez 	bool async_probe_requested;
413f2411da7SLuis R. Rodriguez 
4141da177e4SLinus Torvalds 	/* Exception table */
4151da177e4SLinus Torvalds 	unsigned int num_exentries;
4165e458cc0SRusty Russell 	struct exception_table_entry *extable;
4171da177e4SLinus Torvalds 
4181da177e4SLinus Torvalds 	/* Startup function. */
4191da177e4SLinus Torvalds 	int (*init)(void);
4201da177e4SLinus Torvalds 
4217523e4dcSRusty Russell 	/* Core layout: rbtree is accessed frequently, so keep together. */
4227523e4dcSRusty Russell 	struct module_layout core_layout __module_layout_align;
4237523e4dcSRusty Russell 	struct module_layout init_layout;
42484e1c6bbSmatthieu castet 
4251da177e4SLinus Torvalds 	/* Arch-specific module values */
4261da177e4SLinus Torvalds 	struct mod_arch_specific arch;
4271da177e4SLinus Torvalds 
4287fd8329bSPetr Mladek 	unsigned long taints;	/* same bits as kernel:taint_flags */
4292bc2d61aSRandy Dunlap 
4307664c5a1SJeremy Fitzhardinge #ifdef CONFIG_GENERIC_BUG
4317664c5a1SJeremy Fitzhardinge 	/* Support for BUG */
432af540689SRichard Kennedy 	unsigned num_bugs;
4337664c5a1SJeremy Fitzhardinge 	struct list_head bug_list;
4347664c5a1SJeremy Fitzhardinge 	struct bug_entry *bug_table;
4351da177e4SLinus Torvalds #endif
4361da177e4SLinus Torvalds 
4371da177e4SLinus Torvalds #ifdef CONFIG_KALLSYMS
4388244062eSRusty Russell 	/* Protected by RCU and/or module_mutex: use rcu_dereference() */
4396080d608SMadhuparna Bhowmik 	struct mod_kallsyms __rcu *kallsyms;
4408244062eSRusty Russell 	struct mod_kallsyms core_kallsyms;
4411da177e4SLinus Torvalds 
4421da177e4SLinus Torvalds 	/* Section attributes */
4431da177e4SLinus Torvalds 	struct module_sect_attrs *sect_attrs;
4446d760133SRoland McGrath 
4456d760133SRoland McGrath 	/* Notes attributes */
4466d760133SRoland McGrath 	struct module_notes_attrs *notes_attrs;
4471da177e4SLinus Torvalds #endif
4481da177e4SLinus Torvalds 
449a288bd65SRichard Kennedy 	/* The command line arguments (may be mangled).  People like
450a288bd65SRichard Kennedy 	   keeping pointers to this stuff */
451a288bd65SRichard Kennedy 	char *args;
452a288bd65SRichard Kennedy 
453259354deSTejun Heo #ifdef CONFIG_SMP
4541da177e4SLinus Torvalds 	/* Per-cpu data. */
455259354deSTejun Heo 	void __percpu *percpu;
456259354deSTejun Heo 	unsigned int percpu_size;
457259354deSTejun Heo #endif
45866e9b071SThomas Gleixner 	void *noinstr_text_start;
45966e9b071SThomas Gleixner 	unsigned int noinstr_text_size;
4601da177e4SLinus Torvalds 
46197e1c18eSMathieu Desnoyers #ifdef CONFIG_TRACEPOINTS
46297e1c18eSMathieu Desnoyers 	unsigned int num_tracepoints;
4639c0be3f6SMathieu Desnoyers 	tracepoint_ptr_t *tracepoints_ptrs;
46497e1c18eSMathieu Desnoyers #endif
465fe15b50cSPaul E. McKenney #ifdef CONFIG_TREE_SRCU
466fe15b50cSPaul E. McKenney 	unsigned int num_srcu_structs;
467fe15b50cSPaul E. McKenney 	struct srcu_struct **srcu_struct_ptrs;
468fe15b50cSPaul E. McKenney #endif
469a38d1107SMatt Mullins #ifdef CONFIG_BPF_EVENTS
470a38d1107SMatt Mullins 	unsigned int num_bpf_raw_events;
471a38d1107SMatt Mullins 	struct bpf_raw_event_map *bpf_raw_events;
472a38d1107SMatt Mullins #endif
47336e68442SAndrii Nakryiko #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
47436e68442SAndrii Nakryiko 	unsigned int btf_data_size;
47536e68442SAndrii Nakryiko 	void *btf_data;
47636e68442SAndrii Nakryiko #endif
477e9666d10SMasahiro Yamada #ifdef CONFIG_JUMP_LABEL
478bf5438fcSJason Baron 	struct jump_entry *jump_entries;
479bf5438fcSJason Baron 	unsigned int num_jump_entries;
480bf5438fcSJason Baron #endif
481769b0441SFrederic Weisbecker #ifdef CONFIG_TRACING
4821ba28e02SLai Jiangshan 	unsigned int num_trace_bprintk_fmt;
483a288bd65SRichard Kennedy 	const char **trace_bprintk_fmt_start;
4841ba28e02SLai Jiangshan #endif
4856d723736SSteven Rostedt #ifdef CONFIG_EVENT_TRACING
4862425bcb9SSteven Rostedt (Red Hat) 	struct trace_event_call **trace_events;
4876d723736SSteven Rostedt 	unsigned int num_trace_events;
48899be647cSJeremy Linton 	struct trace_eval_map **trace_evals;
48999be647cSJeremy Linton 	unsigned int num_trace_evals;
4906d723736SSteven Rostedt #endif
49193eb677dSSteven Rostedt #ifdef CONFIG_FTRACE_MCOUNT_RECORD
49293eb677dSSteven Rostedt 	unsigned int num_ftrace_callsites;
493a288bd65SRichard Kennedy 	unsigned long *ftrace_callsites;
49493eb677dSSteven Rostedt #endif
4951e6769b0SMasami Hiramatsu #ifdef CONFIG_KPROBES
4961e6769b0SMasami Hiramatsu 	void *kprobes_text_start;
4971e6769b0SMasami Hiramatsu 	unsigned int kprobes_text_size;
49816db6264SMasami Hiramatsu 	unsigned long *kprobe_blacklist;
49916db6264SMasami Hiramatsu 	unsigned int num_kprobe_blacklist;
5001e6769b0SMasami Hiramatsu #endif
5019183c3f9SJosh Poimboeuf #ifdef CONFIG_HAVE_STATIC_CALL_INLINE
5029183c3f9SJosh Poimboeuf 	int num_static_call_sites;
5039183c3f9SJosh Poimboeuf 	struct static_call_site *static_call_sites;
5049183c3f9SJosh Poimboeuf #endif
5051ba28e02SLai Jiangshan 
5068cb2c2dcSPetr Mladek #ifdef CONFIG_LIVEPATCH
5071ce15ef4SJessica Yu 	bool klp; /* Is this a livepatch module? */
5088cb2c2dcSPetr Mladek 	bool klp_alive;
5091ce15ef4SJessica Yu 
5101ce15ef4SJessica Yu 	/* Elf information */
5111ce15ef4SJessica Yu 	struct klp_modinfo *klp_info;
5128cb2c2dcSPetr Mladek #endif
5138cb2c2dcSPetr Mladek 
51433701557SChris Down #ifdef CONFIG_PRINTK_INDEX
51533701557SChris Down 	unsigned int printk_index_size;
51633701557SChris Down 	struct pi_entry **printk_index_start;
51733701557SChris Down #endif
51833701557SChris Down 
519af540689SRichard Kennedy #ifdef CONFIG_MODULE_UNLOAD
520af540689SRichard Kennedy 	/* What modules depend on me? */
5212c02dfe7SLinus Torvalds 	struct list_head source_list;
5222c02dfe7SLinus Torvalds 	/* What modules do I depend on? */
5232c02dfe7SLinus Torvalds 	struct list_head target_list;
524af540689SRichard Kennedy 
525af540689SRichard Kennedy 	/* Destruction function. */
526af540689SRichard Kennedy 	void (*exit)(void);
527af540689SRichard Kennedy 
5282f35c41fSMasami Hiramatsu 	atomic_t refcnt;
529af540689SRichard Kennedy #endif
530b99b87f7SPeter Oberparleiter 
531b99b87f7SPeter Oberparleiter #ifdef CONFIG_CONSTRUCTORS
532b99b87f7SPeter Oberparleiter 	/* Constructor functions. */
533b99b87f7SPeter Oberparleiter 	ctor_fn_t *ctors;
534b99b87f7SPeter Oberparleiter 	unsigned int num_ctors;
535b99b87f7SPeter Oberparleiter #endif
53692ace999SJosef Bacik 
537540adea3SMasami Hiramatsu #ifdef CONFIG_FUNCTION_ERROR_INJECTION
538663faf9fSMasami Hiramatsu 	struct error_injection_entry *ei_funcs;
539540adea3SMasami Hiramatsu 	unsigned int num_ei_funcs;
54092ace999SJosef Bacik #endif
5413859a271SKees Cook } ____cacheline_aligned __randomize_layout;
542e61a1c1cSRoman Zippel #ifndef MODULE_ARCH_INIT
543e61a1c1cSRoman Zippel #define MODULE_ARCH_INIT {}
544e61a1c1cSRoman Zippel #endif
5451da177e4SLinus Torvalds 
54693d77e7fSVincent Whitchurch #ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
54793d77e7fSVincent Whitchurch static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
54893d77e7fSVincent Whitchurch {
54993d77e7fSVincent Whitchurch 	return sym->st_value;
55093d77e7fSVincent Whitchurch }
55193d77e7fSVincent Whitchurch #endif
55293d77e7fSVincent Whitchurch 
5531da177e4SLinus Torvalds /* FIXME: It'd be nice to isolate modules during init, too, so they
5541da177e4SLinus Torvalds    aren't used before they (may) fail.  But presently too much code
5551da177e4SLinus Torvalds    (IDE & SCSI) require entry into the module during init.*/
556171d864eSYaowei Bai static inline bool module_is_live(struct module *mod)
5571da177e4SLinus Torvalds {
5581da177e4SLinus Torvalds 	return mod->state != MODULE_STATE_GOING;
5591da177e4SLinus Torvalds }
5601da177e4SLinus Torvalds 
5611da177e4SLinus Torvalds struct module *__module_text_address(unsigned long addr);
562e610499eSRusty Russell struct module *__module_address(unsigned long addr);
563e610499eSRusty Russell bool is_module_address(unsigned long addr);
564383776faSThomas Gleixner bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
56510fad5e4STejun Heo bool is_module_percpu_address(unsigned long addr);
566e610499eSRusty Russell bool is_module_text_address(unsigned long addr);
5671da177e4SLinus Torvalds 
56876681c8fSPetr Mladek static inline bool within_module_core(unsigned long addr,
56976681c8fSPetr Mladek 				      const struct module *mod)
570a06f6211SMasami Hiramatsu {
5717523e4dcSRusty Russell 	return (unsigned long)mod->core_layout.base <= addr &&
5727523e4dcSRusty Russell 	       addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
573a06f6211SMasami Hiramatsu }
574a06f6211SMasami Hiramatsu 
57576681c8fSPetr Mladek static inline bool within_module_init(unsigned long addr,
57676681c8fSPetr Mladek 				      const struct module *mod)
577a06f6211SMasami Hiramatsu {
5787523e4dcSRusty Russell 	return (unsigned long)mod->init_layout.base <= addr &&
5797523e4dcSRusty Russell 	       addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
580a06f6211SMasami Hiramatsu }
581a06f6211SMasami Hiramatsu 
58276681c8fSPetr Mladek static inline bool within_module(unsigned long addr, const struct module *mod)
5839b20a352SPetr Mladek {
5849b20a352SPetr Mladek 	return within_module_init(addr, mod) || within_module_core(addr, mod);
5859b20a352SPetr Mladek }
5869b20a352SPetr Mladek 
587a0060505SChristoph Hellwig /* Search for module by name: must be in a RCU-sched critical section. */
588c6b37801STim Abbott struct module *find_module(const char *name);
589c6b37801STim Abbott 
590ea07890aSAlexey Dobriyan /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
5911da177e4SLinus Torvalds    symnum out of range. */
592ea07890aSAlexey Dobriyan int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
593ea07890aSAlexey Dobriyan 			char *name, char *module_name, int *exported);
5941da177e4SLinus Torvalds 
5951da177e4SLinus Torvalds /* Look for this name: can be of form module:name. */
5961da177e4SLinus Torvalds unsigned long module_kallsyms_lookup_name(const char *name);
5971da177e4SLinus Torvalds 
598*ca3574bdSEric W. Biederman extern void __noreturn __module_put_and_kthread_exit(struct module *mod,
599bf262dceSJiri Kosina 			long code);
600*ca3574bdSEric W. Biederman #define module_put_and_kthread_exit(code) __module_put_and_kthread_exit(THIS_MODULE, code)
6011da177e4SLinus Torvalds 
6021da177e4SLinus Torvalds #ifdef CONFIG_MODULE_UNLOAD
603d5db139aSRusty Russell int module_refcount(struct module *mod);
6041da177e4SLinus Torvalds void __symbol_put(const char *symbol);
605996302c5SMasahiro Yamada #define symbol_put(x) __symbol_put(__stringify(x))
6061da177e4SLinus Torvalds void symbol_put_addr(void *addr);
6071da177e4SLinus Torvalds 
6081da177e4SLinus Torvalds /* Sometimes we know we already have a refcount, and it's easier not
6091da177e4SLinus Torvalds    to handle the error case (which only happens with rmmod --wait). */
610d53799beSSteven Rostedt extern void __module_get(struct module *module);
6111da177e4SLinus Torvalds 
612d53799beSSteven Rostedt /* This is the Right Way to get a module: if it fails, it's being removed,
613d53799beSSteven Rostedt  * so pretend it's not there. */
614d53799beSSteven Rostedt extern bool try_module_get(struct module *module);
6151da177e4SLinus Torvalds 
616f6a57033SAl Viro extern void module_put(struct module *module);
6171da177e4SLinus Torvalds 
6181da177e4SLinus Torvalds #else /*!CONFIG_MODULE_UNLOAD*/
6198ba4fcdfSGao Feng static inline bool try_module_get(struct module *module)
6201da177e4SLinus Torvalds {
6211da177e4SLinus Torvalds 	return !module || module_is_live(module);
6221da177e4SLinus Torvalds }
6231da177e4SLinus Torvalds static inline void module_put(struct module *module)
6241da177e4SLinus Torvalds {
6251da177e4SLinus Torvalds }
6261da177e4SLinus Torvalds static inline void __module_get(struct module *module)
6271da177e4SLinus Torvalds {
6281da177e4SLinus Torvalds }
6291da177e4SLinus Torvalds #define symbol_put(x) do { } while (0)
6301da177e4SLinus Torvalds #define symbol_put_addr(p) do { } while (0)
6311da177e4SLinus Torvalds 
6321da177e4SLinus Torvalds #endif /* CONFIG_MODULE_UNLOAD */
6331da177e4SLinus Torvalds 
6341da177e4SLinus Torvalds /* This is a #define so the string doesn't get put in every .o file */
6351da177e4SLinus Torvalds #define module_name(mod)			\
6361da177e4SLinus Torvalds ({						\
6371da177e4SLinus Torvalds 	struct module *__mod = (mod);		\
6381da177e4SLinus Torvalds 	__mod ? __mod->name : "kernel";		\
6391da177e4SLinus Torvalds })
6401da177e4SLinus Torvalds 
641b865ea64SSergey Senozhatsky /* Dereference module function descriptor */
642b865ea64SSergey Senozhatsky void *dereference_module_function_descriptor(struct module *mod, void *ptr);
643b865ea64SSergey Senozhatsky 
6446dd06c9fSRusty Russell /* For kallsyms to ask for address resolution.  namebuf should be at
6456dd06c9fSRusty Russell  * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
6466dd06c9fSRusty Russell  * found, otherwise NULL. */
64792dfc9dcSAndrew Morton const char *module_address_lookup(unsigned long addr,
6481da177e4SLinus Torvalds 			    unsigned long *symbolsize,
6491da177e4SLinus Torvalds 			    unsigned long *offset,
6509294523eSStephen Boyd 			    char **modname, const unsigned char **modbuildid,
6516dd06c9fSRusty Russell 			    char *namebuf);
6529d65cb4aSAlexey Dobriyan int lookup_module_symbol_name(unsigned long addr, char *symname);
653a5c43daeSAlexey Dobriyan int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
6541da177e4SLinus Torvalds 
6551da177e4SLinus Torvalds int register_module_notifier(struct notifier_block *nb);
6561da177e4SLinus Torvalds int unregister_module_notifier(struct notifier_block *nb);
6571da177e4SLinus Torvalds 
6581da177e4SLinus Torvalds extern void print_modules(void);
6591da177e4SLinus Torvalds 
66080c6e146SDmitry Torokhov static inline bool module_requested_async_probing(struct module *module)
66180c6e146SDmitry Torokhov {
66280c6e146SDmitry Torokhov 	return module && module->async_probe_requested;
66380c6e146SDmitry Torokhov }
66480c6e146SDmitry Torokhov 
6651ce15ef4SJessica Yu #ifdef CONFIG_LIVEPATCH
6661ce15ef4SJessica Yu static inline bool is_livepatch_module(struct module *mod)
6671ce15ef4SJessica Yu {
6681ce15ef4SJessica Yu 	return mod->klp;
6691ce15ef4SJessica Yu }
6701ce15ef4SJessica Yu #else /* !CONFIG_LIVEPATCH */
6711ce15ef4SJessica Yu static inline bool is_livepatch_module(struct module *mod)
6721ce15ef4SJessica Yu {
6731ce15ef4SJessica Yu 	return false;
6741ce15ef4SJessica Yu }
6751ce15ef4SJessica Yu #endif /* CONFIG_LIVEPATCH */
6761ce15ef4SJessica Yu 
677fda784e5SBruno E. O. Meneguele bool is_module_sig_enforced(void);
6788db5da0bSMimi Zohar void set_module_sig_enforced(void);
679fda784e5SBruno E. O. Meneguele 
6801da177e4SLinus Torvalds #else /* !CONFIG_MODULES... */
6811da177e4SLinus Torvalds 
682e610499eSRusty Russell static inline struct module *__module_address(unsigned long addr)
683e610499eSRusty Russell {
684e610499eSRusty Russell 	return NULL;
685e610499eSRusty Russell }
686e610499eSRusty Russell 
6871da177e4SLinus Torvalds static inline struct module *__module_text_address(unsigned long addr)
6881da177e4SLinus Torvalds {
6891da177e4SLinus Torvalds 	return NULL;
6901da177e4SLinus Torvalds }
6911da177e4SLinus Torvalds 
692e610499eSRusty Russell static inline bool is_module_address(unsigned long addr)
6934d435f9dSIngo Molnar {
694e610499eSRusty Russell 	return false;
695e610499eSRusty Russell }
696e610499eSRusty Russell 
697d5e50dafSRandy Dunlap static inline bool is_module_percpu_address(unsigned long addr)
698d5e50dafSRandy Dunlap {
699d5e50dafSRandy Dunlap 	return false;
700d5e50dafSRandy Dunlap }
701d5e50dafSRandy Dunlap 
702383776faSThomas Gleixner static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
703383776faSThomas Gleixner {
704383776faSThomas Gleixner 	return false;
705383776faSThomas Gleixner }
706383776faSThomas Gleixner 
707e610499eSRusty Russell static inline bool is_module_text_address(unsigned long addr)
708e610499eSRusty Russell {
709e610499eSRusty Russell 	return false;
7104d435f9dSIngo Molnar }
7114d435f9dSIngo Molnar 
712007ec26cSDavid Howells static inline bool within_module_core(unsigned long addr,
713007ec26cSDavid Howells 				      const struct module *mod)
714007ec26cSDavid Howells {
715007ec26cSDavid Howells 	return false;
716007ec26cSDavid Howells }
717007ec26cSDavid Howells 
718dadec066STri Vo static inline bool within_module_init(unsigned long addr,
719dadec066STri Vo 				      const struct module *mod)
720dadec066STri Vo {
721dadec066STri Vo 	return false;
722dadec066STri Vo }
723dadec066STri Vo 
724dadec066STri Vo static inline bool within_module(unsigned long addr, const struct module *mod)
725dadec066STri Vo {
726dadec066STri Vo 	return false;
727dadec066STri Vo }
728dadec066STri Vo 
7291da177e4SLinus Torvalds /* Get/put a kernel symbol (calls should be symmetric) */
73013150bc5SArd Biesheuvel #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak,visibility("hidden"))); &(x); })
7311da177e4SLinus Torvalds #define symbol_put(x) do { } while (0)
7321da177e4SLinus Torvalds #define symbol_put_addr(x) do { } while (0)
7331da177e4SLinus Torvalds 
7341da177e4SLinus Torvalds static inline void __module_get(struct module *module)
7351da177e4SLinus Torvalds {
7361da177e4SLinus Torvalds }
7371da177e4SLinus Torvalds 
7388ba4fcdfSGao Feng static inline bool try_module_get(struct module *module)
7391da177e4SLinus Torvalds {
7408ba4fcdfSGao Feng 	return true;
7411da177e4SLinus Torvalds }
7421da177e4SLinus Torvalds 
7431da177e4SLinus Torvalds static inline void module_put(struct module *module)
7441da177e4SLinus Torvalds {
7451da177e4SLinus Torvalds }
7461da177e4SLinus Torvalds 
7471da177e4SLinus Torvalds #define module_name(mod) "kernel"
7481da177e4SLinus Torvalds 
7491da177e4SLinus Torvalds /* For kallsyms to ask for address resolution.  NULL means not found. */
75092dfc9dcSAndrew Morton static inline const char *module_address_lookup(unsigned long addr,
7511da177e4SLinus Torvalds 					  unsigned long *symbolsize,
7521da177e4SLinus Torvalds 					  unsigned long *offset,
7536dd06c9fSRusty Russell 					  char **modname,
7549294523eSStephen Boyd 					  const unsigned char **modbuildid,
7556dd06c9fSRusty Russell 					  char *namebuf)
7561da177e4SLinus Torvalds {
7571da177e4SLinus Torvalds 	return NULL;
7581da177e4SLinus Torvalds }
7591da177e4SLinus Torvalds 
7609d65cb4aSAlexey Dobriyan static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
7619d65cb4aSAlexey Dobriyan {
7629d65cb4aSAlexey Dobriyan 	return -ERANGE;
7639d65cb4aSAlexey Dobriyan }
7649d65cb4aSAlexey Dobriyan 
765a5c43daeSAlexey Dobriyan static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
766a5c43daeSAlexey Dobriyan {
767a5c43daeSAlexey Dobriyan 	return -ERANGE;
768a5c43daeSAlexey Dobriyan }
769a5c43daeSAlexey Dobriyan 
770ea07890aSAlexey Dobriyan static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
771ea07890aSAlexey Dobriyan 					char *type, char *name,
772ea07890aSAlexey Dobriyan 					char *module_name, int *exported)
7731da177e4SLinus Torvalds {
774ea07890aSAlexey Dobriyan 	return -ERANGE;
7751da177e4SLinus Torvalds }
7761da177e4SLinus Torvalds 
7771da177e4SLinus Torvalds static inline unsigned long module_kallsyms_lookup_name(const char *name)
7781da177e4SLinus Torvalds {
7791da177e4SLinus Torvalds 	return 0;
7801da177e4SLinus Torvalds }
7811da177e4SLinus Torvalds 
7821da177e4SLinus Torvalds static inline int register_module_notifier(struct notifier_block *nb)
7831da177e4SLinus Torvalds {
7841da177e4SLinus Torvalds 	/* no events will happen anyway, so this can always succeed */
7851da177e4SLinus Torvalds 	return 0;
7861da177e4SLinus Torvalds }
7871da177e4SLinus Torvalds 
7881da177e4SLinus Torvalds static inline int unregister_module_notifier(struct notifier_block *nb)
7891da177e4SLinus Torvalds {
7901da177e4SLinus Torvalds 	return 0;
7911da177e4SLinus Torvalds }
7921da177e4SLinus Torvalds 
793*ca3574bdSEric W. Biederman #define module_put_and_kthread_exit(code) kthread_exit(code)
7941da177e4SLinus Torvalds 
7951da177e4SLinus Torvalds static inline void print_modules(void)
7961da177e4SLinus Torvalds {
7971da177e4SLinus Torvalds }
79880c6e146SDmitry Torokhov 
79980c6e146SDmitry Torokhov static inline bool module_requested_async_probing(struct module *module)
80080c6e146SDmitry Torokhov {
80180c6e146SDmitry Torokhov 	return false;
80280c6e146SDmitry Torokhov }
80380c6e146SDmitry Torokhov 
804fda784e5SBruno E. O. Meneguele static inline bool is_module_sig_enforced(void)
805fda784e5SBruno E. O. Meneguele {
806fda784e5SBruno E. O. Meneguele 	return false;
807fda784e5SBruno E. O. Meneguele }
808fda784e5SBruno E. O. Meneguele 
8098db5da0bSMimi Zohar static inline void set_module_sig_enforced(void)
8108db5da0bSMimi Zohar {
8118db5da0bSMimi Zohar }
8128db5da0bSMimi Zohar 
813b865ea64SSergey Senozhatsky /* Dereference module function descriptor */
814b865ea64SSergey Senozhatsky static inline
815b865ea64SSergey Senozhatsky void *dereference_module_function_descriptor(struct module *mod, void *ptr)
816b865ea64SSergey Senozhatsky {
817b865ea64SSergey Senozhatsky 	return ptr;
818b865ea64SSergey Senozhatsky }
819b865ea64SSergey Senozhatsky 
820ef665c1aSRandy Dunlap #endif /* CONFIG_MODULES */
821ef665c1aSRandy Dunlap 
822ef665c1aSRandy Dunlap #ifdef CONFIG_SYSFS
8237405c1e1SGreg Kroah-Hartman extern struct kset *module_kset;
8247405c1e1SGreg Kroah-Hartman extern struct kobj_type module_ktype;
8257405c1e1SGreg Kroah-Hartman extern int module_sysfs_initialized;
826ef665c1aSRandy Dunlap #endif /* CONFIG_SYSFS */
827ef665c1aSRandy Dunlap 
8281da177e4SLinus Torvalds #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
8291da177e4SLinus Torvalds 
8301da177e4SLinus Torvalds /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
8311da177e4SLinus Torvalds 
8321da177e4SLinus Torvalds #define __MODULE_STRING(x) __stringify(x)
8331da177e4SLinus Torvalds 
8340d9c25ddSAndrew Morton #ifdef CONFIG_GENERIC_BUG
8355336377dSLinus Torvalds void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
8360d9c25ddSAndrew Morton 			 struct module *);
8370d9c25ddSAndrew Morton void module_bug_cleanup(struct module *);
8380d9c25ddSAndrew Morton 
8390d9c25ddSAndrew Morton #else	/* !CONFIG_GENERIC_BUG */
8400d9c25ddSAndrew Morton 
8415336377dSLinus Torvalds static inline void module_bug_finalize(const Elf_Ehdr *hdr,
8420d9c25ddSAndrew Morton 					const Elf_Shdr *sechdrs,
8430d9c25ddSAndrew Morton 					struct module *mod)
8440d9c25ddSAndrew Morton {
8450d9c25ddSAndrew Morton }
8460d9c25ddSAndrew Morton static inline void module_bug_cleanup(struct module *mod) {}
8470d9c25ddSAndrew Morton #endif	/* CONFIG_GENERIC_BUG */
8480d9c25ddSAndrew Morton 
849e4f35891SWANG Chao #ifdef CONFIG_RETPOLINE
850caf7501aSAndi Kleen extern bool retpoline_module_ok(bool has_retpoline);
851caf7501aSAndi Kleen #else
852caf7501aSAndi Kleen static inline bool retpoline_module_ok(bool has_retpoline)
853caf7501aSAndi Kleen {
854caf7501aSAndi Kleen 	return true;
855caf7501aSAndi Kleen }
856caf7501aSAndi Kleen #endif
857caf7501aSAndi Kleen 
85859afdc7bSHerbert Xu #ifdef CONFIG_MODULE_SIG
85959afdc7bSHerbert Xu static inline bool module_sig_ok(struct module *module)
86059afdc7bSHerbert Xu {
86159afdc7bSHerbert Xu 	return module->sig_ok;
86259afdc7bSHerbert Xu }
86359afdc7bSHerbert Xu #else	/* !CONFIG_MODULE_SIG */
86459afdc7bSHerbert Xu static inline bool module_sig_ok(struct module *module)
86559afdc7bSHerbert Xu {
86659afdc7bSHerbert Xu 	return true;
86759afdc7bSHerbert Xu }
86859afdc7bSHerbert Xu #endif	/* CONFIG_MODULE_SIG */
86959afdc7bSHerbert Xu 
8703e355205SChristoph Hellwig int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
8713e355205SChristoph Hellwig 					     struct module *, unsigned long),
8723e355205SChristoph Hellwig 				   void *data);
8733e355205SChristoph Hellwig 
8741da177e4SLinus Torvalds #endif /* _LINUX_MODULE_H */
875