xref: /linux-6.15/include/linux/module.h (revision 92efda8e)
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)));		\
135*92efda8eSSami Tolvanen 	___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)));		\
143*92efda8eSSami Tolvanen 	___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 
29380140a81SGreg Kroah-Hartman #define MODULE_IMPORT_NS(ns)	MODULE_INFO(import_ns, __stringify(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;
42401dc0386SChristophe Leroy #ifdef CONFIG_ARCH_WANTS_MODULES_DATA_IN_VMALLOC
42501dc0386SChristophe Leroy 	struct module_layout data_layout;
42601dc0386SChristophe Leroy #endif
42784e1c6bbSmatthieu castet 
4281da177e4SLinus Torvalds 	/* Arch-specific module values */
4291da177e4SLinus Torvalds 	struct mod_arch_specific arch;
4301da177e4SLinus Torvalds 
4317fd8329bSPetr Mladek 	unsigned long taints;	/* same bits as kernel:taint_flags */
4322bc2d61aSRandy Dunlap 
4337664c5a1SJeremy Fitzhardinge #ifdef CONFIG_GENERIC_BUG
4347664c5a1SJeremy Fitzhardinge 	/* Support for BUG */
435af540689SRichard Kennedy 	unsigned num_bugs;
4367664c5a1SJeremy Fitzhardinge 	struct list_head bug_list;
4377664c5a1SJeremy Fitzhardinge 	struct bug_entry *bug_table;
4381da177e4SLinus Torvalds #endif
4391da177e4SLinus Torvalds 
4401da177e4SLinus Torvalds #ifdef CONFIG_KALLSYMS
4418244062eSRusty Russell 	/* Protected by RCU and/or module_mutex: use rcu_dereference() */
4426080d608SMadhuparna Bhowmik 	struct mod_kallsyms __rcu *kallsyms;
4438244062eSRusty Russell 	struct mod_kallsyms core_kallsyms;
4441da177e4SLinus Torvalds 
4451da177e4SLinus Torvalds 	/* Section attributes */
4461da177e4SLinus Torvalds 	struct module_sect_attrs *sect_attrs;
4476d760133SRoland McGrath 
4486d760133SRoland McGrath 	/* Notes attributes */
4496d760133SRoland McGrath 	struct module_notes_attrs *notes_attrs;
4501da177e4SLinus Torvalds #endif
4511da177e4SLinus Torvalds 
452a288bd65SRichard Kennedy 	/* The command line arguments (may be mangled).  People like
453a288bd65SRichard Kennedy 	   keeping pointers to this stuff */
454a288bd65SRichard Kennedy 	char *args;
455a288bd65SRichard Kennedy 
456259354deSTejun Heo #ifdef CONFIG_SMP
4571da177e4SLinus Torvalds 	/* Per-cpu data. */
458259354deSTejun Heo 	void __percpu *percpu;
459259354deSTejun Heo 	unsigned int percpu_size;
460259354deSTejun Heo #endif
46166e9b071SThomas Gleixner 	void *noinstr_text_start;
46266e9b071SThomas Gleixner 	unsigned int noinstr_text_size;
4631da177e4SLinus Torvalds 
46497e1c18eSMathieu Desnoyers #ifdef CONFIG_TRACEPOINTS
46597e1c18eSMathieu Desnoyers 	unsigned int num_tracepoints;
4669c0be3f6SMathieu Desnoyers 	tracepoint_ptr_t *tracepoints_ptrs;
46797e1c18eSMathieu Desnoyers #endif
468fe15b50cSPaul E. McKenney #ifdef CONFIG_TREE_SRCU
469fe15b50cSPaul E. McKenney 	unsigned int num_srcu_structs;
470fe15b50cSPaul E. McKenney 	struct srcu_struct **srcu_struct_ptrs;
471fe15b50cSPaul E. McKenney #endif
472a38d1107SMatt Mullins #ifdef CONFIG_BPF_EVENTS
473a38d1107SMatt Mullins 	unsigned int num_bpf_raw_events;
474a38d1107SMatt Mullins 	struct bpf_raw_event_map *bpf_raw_events;
475a38d1107SMatt Mullins #endif
47636e68442SAndrii Nakryiko #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
47736e68442SAndrii Nakryiko 	unsigned int btf_data_size;
47836e68442SAndrii Nakryiko 	void *btf_data;
47936e68442SAndrii Nakryiko #endif
480e9666d10SMasahiro Yamada #ifdef CONFIG_JUMP_LABEL
481bf5438fcSJason Baron 	struct jump_entry *jump_entries;
482bf5438fcSJason Baron 	unsigned int num_jump_entries;
483bf5438fcSJason Baron #endif
484769b0441SFrederic Weisbecker #ifdef CONFIG_TRACING
4851ba28e02SLai Jiangshan 	unsigned int num_trace_bprintk_fmt;
486a288bd65SRichard Kennedy 	const char **trace_bprintk_fmt_start;
4871ba28e02SLai Jiangshan #endif
4886d723736SSteven Rostedt #ifdef CONFIG_EVENT_TRACING
4892425bcb9SSteven Rostedt (Red Hat) 	struct trace_event_call **trace_events;
4906d723736SSteven Rostedt 	unsigned int num_trace_events;
49199be647cSJeremy Linton 	struct trace_eval_map **trace_evals;
49299be647cSJeremy Linton 	unsigned int num_trace_evals;
4936d723736SSteven Rostedt #endif
49493eb677dSSteven Rostedt #ifdef CONFIG_FTRACE_MCOUNT_RECORD
49593eb677dSSteven Rostedt 	unsigned int num_ftrace_callsites;
496a288bd65SRichard Kennedy 	unsigned long *ftrace_callsites;
49793eb677dSSteven Rostedt #endif
4981e6769b0SMasami Hiramatsu #ifdef CONFIG_KPROBES
4991e6769b0SMasami Hiramatsu 	void *kprobes_text_start;
5001e6769b0SMasami Hiramatsu 	unsigned int kprobes_text_size;
50116db6264SMasami Hiramatsu 	unsigned long *kprobe_blacklist;
50216db6264SMasami Hiramatsu 	unsigned int num_kprobe_blacklist;
5031e6769b0SMasami Hiramatsu #endif
5049183c3f9SJosh Poimboeuf #ifdef CONFIG_HAVE_STATIC_CALL_INLINE
5059183c3f9SJosh Poimboeuf 	int num_static_call_sites;
5069183c3f9SJosh Poimboeuf 	struct static_call_site *static_call_sites;
5079183c3f9SJosh Poimboeuf #endif
5083d6e4462SJeremy Kerr #if IS_ENABLED(CONFIG_KUNIT)
5093d6e4462SJeremy Kerr 	int num_kunit_suites;
510e5857d39SDaniel Latypov 	struct kunit_suite **kunit_suites;
5113d6e4462SJeremy Kerr #endif
5123d6e4462SJeremy Kerr 
5131ba28e02SLai Jiangshan 
5148cb2c2dcSPetr Mladek #ifdef CONFIG_LIVEPATCH
5151ce15ef4SJessica Yu 	bool klp; /* Is this a livepatch module? */
5168cb2c2dcSPetr Mladek 	bool klp_alive;
5171ce15ef4SJessica Yu 
5181ce15ef4SJessica Yu 	/* Elf information */
5191ce15ef4SJessica Yu 	struct klp_modinfo *klp_info;
5208cb2c2dcSPetr Mladek #endif
5218cb2c2dcSPetr Mladek 
52233701557SChris Down #ifdef CONFIG_PRINTK_INDEX
52333701557SChris Down 	unsigned int printk_index_size;
52433701557SChris Down 	struct pi_entry **printk_index_start;
52533701557SChris Down #endif
52633701557SChris Down 
527af540689SRichard Kennedy #ifdef CONFIG_MODULE_UNLOAD
528af540689SRichard Kennedy 	/* What modules depend on me? */
5292c02dfe7SLinus Torvalds 	struct list_head source_list;
5302c02dfe7SLinus Torvalds 	/* What modules do I depend on? */
5312c02dfe7SLinus Torvalds 	struct list_head target_list;
532af540689SRichard Kennedy 
533af540689SRichard Kennedy 	/* Destruction function. */
534af540689SRichard Kennedy 	void (*exit)(void);
535af540689SRichard Kennedy 
5362f35c41fSMasami Hiramatsu 	atomic_t refcnt;
537af540689SRichard Kennedy #endif
538b99b87f7SPeter Oberparleiter 
539b99b87f7SPeter Oberparleiter #ifdef CONFIG_CONSTRUCTORS
540b99b87f7SPeter Oberparleiter 	/* Constructor functions. */
541b99b87f7SPeter Oberparleiter 	ctor_fn_t *ctors;
542b99b87f7SPeter Oberparleiter 	unsigned int num_ctors;
543b99b87f7SPeter Oberparleiter #endif
54492ace999SJosef Bacik 
545540adea3SMasami Hiramatsu #ifdef CONFIG_FUNCTION_ERROR_INJECTION
546663faf9fSMasami Hiramatsu 	struct error_injection_entry *ei_funcs;
547540adea3SMasami Hiramatsu 	unsigned int num_ei_funcs;
54892ace999SJosef Bacik #endif
5493859a271SKees Cook } ____cacheline_aligned __randomize_layout;
550e61a1c1cSRoman Zippel #ifndef MODULE_ARCH_INIT
551e61a1c1cSRoman Zippel #define MODULE_ARCH_INIT {}
552e61a1c1cSRoman Zippel #endif
5531da177e4SLinus Torvalds 
55493d77e7fSVincent Whitchurch #ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
55593d77e7fSVincent Whitchurch static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
55693d77e7fSVincent Whitchurch {
55793d77e7fSVincent Whitchurch 	return sym->st_value;
55893d77e7fSVincent Whitchurch }
55993d77e7fSVincent Whitchurch #endif
56093d77e7fSVincent Whitchurch 
5611da177e4SLinus Torvalds /* FIXME: It'd be nice to isolate modules during init, too, so they
5621da177e4SLinus Torvalds    aren't used before they (may) fail.  But presently too much code
5631da177e4SLinus Torvalds    (IDE & SCSI) require entry into the module during init.*/
564171d864eSYaowei Bai static inline bool module_is_live(struct module *mod)
5651da177e4SLinus Torvalds {
5661da177e4SLinus Torvalds 	return mod->state != MODULE_STATE_GOING;
5671da177e4SLinus Torvalds }
5681da177e4SLinus Torvalds 
5691da177e4SLinus Torvalds struct module *__module_text_address(unsigned long addr);
570e610499eSRusty Russell struct module *__module_address(unsigned long addr);
571e610499eSRusty Russell bool is_module_address(unsigned long addr);
572383776faSThomas Gleixner bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
57310fad5e4STejun Heo bool is_module_percpu_address(unsigned long addr);
574e610499eSRusty Russell bool is_module_text_address(unsigned long addr);
5751da177e4SLinus Torvalds 
57676681c8fSPetr Mladek static inline bool within_module_core(unsigned long addr,
57776681c8fSPetr Mladek 				      const struct module *mod)
578a06f6211SMasami Hiramatsu {
57901dc0386SChristophe Leroy #ifdef CONFIG_ARCH_WANTS_MODULES_DATA_IN_VMALLOC
58001dc0386SChristophe Leroy 	if ((unsigned long)mod->data_layout.base <= addr &&
58101dc0386SChristophe Leroy 	    addr < (unsigned long)mod->data_layout.base + mod->data_layout.size)
58201dc0386SChristophe Leroy 		return true;
58301dc0386SChristophe Leroy #endif
5847523e4dcSRusty Russell 	return (unsigned long)mod->core_layout.base <= addr &&
5857523e4dcSRusty Russell 	       addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
586a06f6211SMasami Hiramatsu }
587a06f6211SMasami Hiramatsu 
58876681c8fSPetr Mladek static inline bool within_module_init(unsigned long addr,
58976681c8fSPetr Mladek 				      const struct module *mod)
590a06f6211SMasami Hiramatsu {
5917523e4dcSRusty Russell 	return (unsigned long)mod->init_layout.base <= addr &&
5927523e4dcSRusty Russell 	       addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
593a06f6211SMasami Hiramatsu }
594a06f6211SMasami Hiramatsu 
59576681c8fSPetr Mladek static inline bool within_module(unsigned long addr, const struct module *mod)
5969b20a352SPetr Mladek {
5979b20a352SPetr Mladek 	return within_module_init(addr, mod) || within_module_core(addr, mod);
5989b20a352SPetr Mladek }
5999b20a352SPetr Mladek 
600a0060505SChristoph Hellwig /* Search for module by name: must be in a RCU-sched critical section. */
601c6b37801STim Abbott struct module *find_module(const char *name);
602c6b37801STim Abbott 
603ea07890aSAlexey Dobriyan /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
6041da177e4SLinus Torvalds    symnum out of range. */
605ea07890aSAlexey Dobriyan int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
606ea07890aSAlexey Dobriyan 			char *name, char *module_name, int *exported);
6071da177e4SLinus Torvalds 
6081da177e4SLinus Torvalds /* Look for this name: can be of form module:name. */
6091da177e4SLinus Torvalds unsigned long module_kallsyms_lookup_name(const char *name);
6101da177e4SLinus Torvalds 
611ca3574bdSEric W. Biederman extern void __noreturn __module_put_and_kthread_exit(struct module *mod,
612bf262dceSJiri Kosina 			long code);
613ca3574bdSEric W. Biederman #define module_put_and_kthread_exit(code) __module_put_and_kthread_exit(THIS_MODULE, code)
6141da177e4SLinus Torvalds 
6151da177e4SLinus Torvalds #ifdef CONFIG_MODULE_UNLOAD
616d5db139aSRusty Russell int module_refcount(struct module *mod);
6171da177e4SLinus Torvalds void __symbol_put(const char *symbol);
618996302c5SMasahiro Yamada #define symbol_put(x) __symbol_put(__stringify(x))
6191da177e4SLinus Torvalds void symbol_put_addr(void *addr);
6201da177e4SLinus Torvalds 
6211da177e4SLinus Torvalds /* Sometimes we know we already have a refcount, and it's easier not
6221da177e4SLinus Torvalds    to handle the error case (which only happens with rmmod --wait). */
623d53799beSSteven Rostedt extern void __module_get(struct module *module);
6241da177e4SLinus Torvalds 
625d53799beSSteven Rostedt /* This is the Right Way to get a module: if it fails, it's being removed,
626d53799beSSteven Rostedt  * so pretend it's not there. */
627d53799beSSteven Rostedt extern bool try_module_get(struct module *module);
6281da177e4SLinus Torvalds 
629f6a57033SAl Viro extern void module_put(struct module *module);
6301da177e4SLinus Torvalds 
6311da177e4SLinus Torvalds #else /*!CONFIG_MODULE_UNLOAD*/
6328ba4fcdfSGao Feng static inline bool try_module_get(struct module *module)
6331da177e4SLinus Torvalds {
6341da177e4SLinus Torvalds 	return !module || module_is_live(module);
6351da177e4SLinus Torvalds }
6361da177e4SLinus Torvalds static inline void module_put(struct module *module)
6371da177e4SLinus Torvalds {
6381da177e4SLinus Torvalds }
6391da177e4SLinus Torvalds static inline void __module_get(struct module *module)
6401da177e4SLinus Torvalds {
6411da177e4SLinus Torvalds }
6421da177e4SLinus Torvalds #define symbol_put(x) do { } while (0)
6431da177e4SLinus Torvalds #define symbol_put_addr(p) do { } while (0)
6441da177e4SLinus Torvalds 
6451da177e4SLinus Torvalds #endif /* CONFIG_MODULE_UNLOAD */
6461da177e4SLinus Torvalds 
6471da177e4SLinus Torvalds /* This is a #define so the string doesn't get put in every .o file */
6481da177e4SLinus Torvalds #define module_name(mod)			\
6491da177e4SLinus Torvalds ({						\
6501da177e4SLinus Torvalds 	struct module *__mod = (mod);		\
6511da177e4SLinus Torvalds 	__mod ? __mod->name : "kernel";		\
6521da177e4SLinus Torvalds })
6531da177e4SLinus Torvalds 
654b865ea64SSergey Senozhatsky /* Dereference module function descriptor */
655b865ea64SSergey Senozhatsky void *dereference_module_function_descriptor(struct module *mod, void *ptr);
656b865ea64SSergey Senozhatsky 
6576dd06c9fSRusty Russell /* For kallsyms to ask for address resolution.  namebuf should be at
6586dd06c9fSRusty Russell  * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
6596dd06c9fSRusty Russell  * found, otherwise NULL. */
66092dfc9dcSAndrew Morton const char *module_address_lookup(unsigned long addr,
6611da177e4SLinus Torvalds 			    unsigned long *symbolsize,
6621da177e4SLinus Torvalds 			    unsigned long *offset,
6639294523eSStephen Boyd 			    char **modname, const unsigned char **modbuildid,
6646dd06c9fSRusty Russell 			    char *namebuf);
6659d65cb4aSAlexey Dobriyan int lookup_module_symbol_name(unsigned long addr, char *symname);
666a5c43daeSAlexey Dobriyan int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
6671da177e4SLinus Torvalds 
6681da177e4SLinus Torvalds int register_module_notifier(struct notifier_block *nb);
6691da177e4SLinus Torvalds int unregister_module_notifier(struct notifier_block *nb);
6701da177e4SLinus Torvalds 
6711da177e4SLinus Torvalds extern void print_modules(void);
6721da177e4SLinus Torvalds 
67380c6e146SDmitry Torokhov static inline bool module_requested_async_probing(struct module *module)
67480c6e146SDmitry Torokhov {
67580c6e146SDmitry Torokhov 	return module && module->async_probe_requested;
67680c6e146SDmitry Torokhov }
67780c6e146SDmitry Torokhov 
6781be9473eSAaron Tomlin static inline bool is_livepatch_module(struct module *mod)
6791be9473eSAaron Tomlin {
6801ce15ef4SJessica Yu #ifdef CONFIG_LIVEPATCH
6811ce15ef4SJessica Yu 	return mod->klp;
6821be9473eSAaron Tomlin #else
6831ce15ef4SJessica Yu 	return false;
6841be9473eSAaron Tomlin #endif
6851ce15ef4SJessica Yu }
6861ce15ef4SJessica Yu 
6878db5da0bSMimi Zohar void set_module_sig_enforced(void);
688fda784e5SBruno E. O. Meneguele 
6891da177e4SLinus Torvalds #else /* !CONFIG_MODULES... */
6901da177e4SLinus Torvalds 
691e610499eSRusty Russell static inline struct module *__module_address(unsigned long addr)
692e610499eSRusty Russell {
693e610499eSRusty Russell 	return NULL;
694e610499eSRusty Russell }
695e610499eSRusty Russell 
6961da177e4SLinus Torvalds static inline struct module *__module_text_address(unsigned long addr)
6971da177e4SLinus Torvalds {
6981da177e4SLinus Torvalds 	return NULL;
6991da177e4SLinus Torvalds }
7001da177e4SLinus Torvalds 
701e610499eSRusty Russell static inline bool is_module_address(unsigned long addr)
7024d435f9dSIngo Molnar {
703e610499eSRusty Russell 	return false;
704e610499eSRusty Russell }
705e610499eSRusty Russell 
706d5e50dafSRandy Dunlap static inline bool is_module_percpu_address(unsigned long addr)
707d5e50dafSRandy Dunlap {
708d5e50dafSRandy Dunlap 	return false;
709d5e50dafSRandy Dunlap }
710d5e50dafSRandy Dunlap 
711383776faSThomas Gleixner static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
712383776faSThomas Gleixner {
713383776faSThomas Gleixner 	return false;
714383776faSThomas Gleixner }
715383776faSThomas Gleixner 
716e610499eSRusty Russell static inline bool is_module_text_address(unsigned long addr)
717e610499eSRusty Russell {
718e610499eSRusty Russell 	return false;
7194d435f9dSIngo Molnar }
7204d435f9dSIngo Molnar 
721007ec26cSDavid Howells static inline bool within_module_core(unsigned long addr,
722007ec26cSDavid Howells 				      const struct module *mod)
723007ec26cSDavid Howells {
724007ec26cSDavid Howells 	return false;
725007ec26cSDavid Howells }
726007ec26cSDavid Howells 
727dadec066STri Vo static inline bool within_module_init(unsigned long addr,
728dadec066STri Vo 				      const struct module *mod)
729dadec066STri Vo {
730dadec066STri Vo 	return false;
731dadec066STri Vo }
732dadec066STri Vo 
733dadec066STri Vo static inline bool within_module(unsigned long addr, const struct module *mod)
734dadec066STri Vo {
735dadec066STri Vo 	return false;
736dadec066STri Vo }
737dadec066STri Vo 
7381da177e4SLinus Torvalds /* Get/put a kernel symbol (calls should be symmetric) */
73913150bc5SArd Biesheuvel #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak,visibility("hidden"))); &(x); })
7401da177e4SLinus Torvalds #define symbol_put(x) do { } while (0)
7411da177e4SLinus Torvalds #define symbol_put_addr(x) do { } while (0)
7421da177e4SLinus Torvalds 
7431da177e4SLinus Torvalds static inline void __module_get(struct module *module)
7441da177e4SLinus Torvalds {
7451da177e4SLinus Torvalds }
7461da177e4SLinus Torvalds 
7478ba4fcdfSGao Feng static inline bool try_module_get(struct module *module)
7481da177e4SLinus Torvalds {
7498ba4fcdfSGao Feng 	return true;
7501da177e4SLinus Torvalds }
7511da177e4SLinus Torvalds 
7521da177e4SLinus Torvalds static inline void module_put(struct module *module)
7531da177e4SLinus Torvalds {
7541da177e4SLinus Torvalds }
7551da177e4SLinus Torvalds 
7561da177e4SLinus Torvalds #define module_name(mod) "kernel"
7571da177e4SLinus Torvalds 
7581da177e4SLinus Torvalds /* For kallsyms to ask for address resolution.  NULL means not found. */
75992dfc9dcSAndrew Morton static inline const char *module_address_lookup(unsigned long addr,
7601da177e4SLinus Torvalds 					  unsigned long *symbolsize,
7611da177e4SLinus Torvalds 					  unsigned long *offset,
7626dd06c9fSRusty Russell 					  char **modname,
7639294523eSStephen Boyd 					  const unsigned char **modbuildid,
7646dd06c9fSRusty Russell 					  char *namebuf)
7651da177e4SLinus Torvalds {
7661da177e4SLinus Torvalds 	return NULL;
7671da177e4SLinus Torvalds }
7681da177e4SLinus Torvalds 
7699d65cb4aSAlexey Dobriyan static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
7709d65cb4aSAlexey Dobriyan {
7719d65cb4aSAlexey Dobriyan 	return -ERANGE;
7729d65cb4aSAlexey Dobriyan }
7739d65cb4aSAlexey Dobriyan 
774a5c43daeSAlexey Dobriyan static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
775a5c43daeSAlexey Dobriyan {
776a5c43daeSAlexey Dobriyan 	return -ERANGE;
777a5c43daeSAlexey Dobriyan }
778a5c43daeSAlexey Dobriyan 
779ea07890aSAlexey Dobriyan static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
780ea07890aSAlexey Dobriyan 					char *type, char *name,
781ea07890aSAlexey Dobriyan 					char *module_name, int *exported)
7821da177e4SLinus Torvalds {
783ea07890aSAlexey Dobriyan 	return -ERANGE;
7841da177e4SLinus Torvalds }
7851da177e4SLinus Torvalds 
7861da177e4SLinus Torvalds static inline unsigned long module_kallsyms_lookup_name(const char *name)
7871da177e4SLinus Torvalds {
7881da177e4SLinus Torvalds 	return 0;
7891da177e4SLinus Torvalds }
7901da177e4SLinus Torvalds 
7911da177e4SLinus Torvalds static inline int register_module_notifier(struct notifier_block *nb)
7921da177e4SLinus Torvalds {
7931da177e4SLinus Torvalds 	/* no events will happen anyway, so this can always succeed */
7941da177e4SLinus Torvalds 	return 0;
7951da177e4SLinus Torvalds }
7961da177e4SLinus Torvalds 
7971da177e4SLinus Torvalds static inline int unregister_module_notifier(struct notifier_block *nb)
7981da177e4SLinus Torvalds {
7991da177e4SLinus Torvalds 	return 0;
8001da177e4SLinus Torvalds }
8011da177e4SLinus Torvalds 
802ca3574bdSEric W. Biederman #define module_put_and_kthread_exit(code) kthread_exit(code)
8031da177e4SLinus Torvalds 
8041da177e4SLinus Torvalds static inline void print_modules(void)
8051da177e4SLinus Torvalds {
8061da177e4SLinus Torvalds }
80780c6e146SDmitry Torokhov 
80880c6e146SDmitry Torokhov static inline bool module_requested_async_probing(struct module *module)
80980c6e146SDmitry Torokhov {
81080c6e146SDmitry Torokhov 	return false;
81180c6e146SDmitry Torokhov }
81280c6e146SDmitry Torokhov 
813fda784e5SBruno E. O. Meneguele 
8148db5da0bSMimi Zohar static inline void set_module_sig_enforced(void)
8158db5da0bSMimi Zohar {
8168db5da0bSMimi Zohar }
8178db5da0bSMimi Zohar 
818b865ea64SSergey Senozhatsky /* Dereference module function descriptor */
819b865ea64SSergey Senozhatsky static inline
820b865ea64SSergey Senozhatsky void *dereference_module_function_descriptor(struct module *mod, void *ptr)
821b865ea64SSergey Senozhatsky {
822b865ea64SSergey Senozhatsky 	return ptr;
823b865ea64SSergey Senozhatsky }
824b865ea64SSergey Senozhatsky 
825ef665c1aSRandy Dunlap #endif /* CONFIG_MODULES */
826ef665c1aSRandy Dunlap 
827ef665c1aSRandy Dunlap #ifdef CONFIG_SYSFS
8287405c1e1SGreg Kroah-Hartman extern struct kset *module_kset;
8297405c1e1SGreg Kroah-Hartman extern struct kobj_type module_ktype;
8307405c1e1SGreg Kroah-Hartman extern int module_sysfs_initialized;
831ef665c1aSRandy Dunlap #endif /* CONFIG_SYSFS */
832ef665c1aSRandy Dunlap 
8331da177e4SLinus Torvalds #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
8341da177e4SLinus Torvalds 
8351da177e4SLinus Torvalds /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
8361da177e4SLinus Torvalds 
8371da177e4SLinus Torvalds #define __MODULE_STRING(x) __stringify(x)
8381da177e4SLinus Torvalds 
8390d9c25ddSAndrew Morton #ifdef CONFIG_GENERIC_BUG
8405336377dSLinus Torvalds void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
8410d9c25ddSAndrew Morton 			 struct module *);
8420d9c25ddSAndrew Morton void module_bug_cleanup(struct module *);
8430d9c25ddSAndrew Morton 
8440d9c25ddSAndrew Morton #else	/* !CONFIG_GENERIC_BUG */
8450d9c25ddSAndrew Morton 
8465336377dSLinus Torvalds static inline void module_bug_finalize(const Elf_Ehdr *hdr,
8470d9c25ddSAndrew Morton 					const Elf_Shdr *sechdrs,
8480d9c25ddSAndrew Morton 					struct module *mod)
8490d9c25ddSAndrew Morton {
8500d9c25ddSAndrew Morton }
8510d9c25ddSAndrew Morton static inline void module_bug_cleanup(struct module *mod) {}
8520d9c25ddSAndrew Morton #endif	/* CONFIG_GENERIC_BUG */
8530d9c25ddSAndrew Morton 
854e4f35891SWANG Chao #ifdef CONFIG_RETPOLINE
855caf7501aSAndi Kleen extern bool retpoline_module_ok(bool has_retpoline);
856caf7501aSAndi Kleen #else
857caf7501aSAndi Kleen static inline bool retpoline_module_ok(bool has_retpoline)
858caf7501aSAndi Kleen {
859caf7501aSAndi Kleen 	return true;
860caf7501aSAndi Kleen }
861caf7501aSAndi Kleen #endif
862caf7501aSAndi Kleen 
86359afdc7bSHerbert Xu #ifdef CONFIG_MODULE_SIG
8640c1e4280SAaron Tomlin bool is_module_sig_enforced(void);
8650c1e4280SAaron Tomlin 
86659afdc7bSHerbert Xu static inline bool module_sig_ok(struct module *module)
86759afdc7bSHerbert Xu {
86859afdc7bSHerbert Xu 	return module->sig_ok;
86959afdc7bSHerbert Xu }
87059afdc7bSHerbert Xu #else	/* !CONFIG_MODULE_SIG */
8710c1e4280SAaron Tomlin static inline bool is_module_sig_enforced(void)
8720c1e4280SAaron Tomlin {
8730c1e4280SAaron Tomlin 	return false;
8740c1e4280SAaron Tomlin }
8750c1e4280SAaron Tomlin 
87659afdc7bSHerbert Xu static inline bool module_sig_ok(struct module *module)
87759afdc7bSHerbert Xu {
87859afdc7bSHerbert Xu 	return true;
87959afdc7bSHerbert Xu }
88059afdc7bSHerbert Xu #endif	/* CONFIG_MODULE_SIG */
88159afdc7bSHerbert Xu 
8823e355205SChristoph Hellwig int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
8833e355205SChristoph Hellwig 					     struct module *, unsigned long),
8843e355205SChristoph Hellwig 				   void *data);
8853e355205SChristoph Hellwig 
8861da177e4SLinus Torvalds #endif /* _LINUX_MODULE_H */
887