xref: /OK3568_Linux_fs/kernel/include/linux/module.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Dynamic loading of modules into the kernel.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
6*4882a593Smuzhiyun  * Rewritten again by Rusty Russell, 2002
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #ifndef _LINUX_MODULE_H
10*4882a593Smuzhiyun #define _LINUX_MODULE_H
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include <linux/list.h>
13*4882a593Smuzhiyun #include <linux/stat.h>
14*4882a593Smuzhiyun #include <linux/compiler.h>
15*4882a593Smuzhiyun #include <linux/cache.h>
16*4882a593Smuzhiyun #include <linux/kmod.h>
17*4882a593Smuzhiyun #include <linux/init.h>
18*4882a593Smuzhiyun #include <linux/elf.h>
19*4882a593Smuzhiyun #include <linux/stringify.h>
20*4882a593Smuzhiyun #include <linux/kobject.h>
21*4882a593Smuzhiyun #include <linux/moduleparam.h>
22*4882a593Smuzhiyun #include <linux/jump_label.h>
23*4882a593Smuzhiyun #include <linux/export.h>
24*4882a593Smuzhiyun #include <linux/rbtree_latch.h>
25*4882a593Smuzhiyun #include <linux/error-injection.h>
26*4882a593Smuzhiyun #include <linux/tracepoint-defs.h>
27*4882a593Smuzhiyun #include <linux/srcu.h>
28*4882a593Smuzhiyun #include <linux/static_call_types.h>
29*4882a593Smuzhiyun #include <linux/cfi.h>
30*4882a593Smuzhiyun #include <linux/android_kabi.h>
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun #include <linux/percpu.h>
33*4882a593Smuzhiyun #include <asm/module.h>
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun /* Not Yet Implemented */
36*4882a593Smuzhiyun #define MODULE_SUPPORTED_DEVICE(name)
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun struct modversion_info {
41*4882a593Smuzhiyun 	unsigned long crc;
42*4882a593Smuzhiyun 	char name[MODULE_NAME_LEN];
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun struct module;
46*4882a593Smuzhiyun struct exception_table_entry;
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun struct module_kobject {
49*4882a593Smuzhiyun 	struct kobject kobj;
50*4882a593Smuzhiyun 	struct module *mod;
51*4882a593Smuzhiyun 	struct kobject *drivers_dir;
52*4882a593Smuzhiyun 	struct module_param_attrs *mp;
53*4882a593Smuzhiyun 	struct completion *kobj_completion;
54*4882a593Smuzhiyun } __randomize_layout;
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun struct module_attribute {
57*4882a593Smuzhiyun 	struct attribute attr;
58*4882a593Smuzhiyun 	ssize_t (*show)(struct module_attribute *, struct module_kobject *,
59*4882a593Smuzhiyun 			char *);
60*4882a593Smuzhiyun 	ssize_t (*store)(struct module_attribute *, struct module_kobject *,
61*4882a593Smuzhiyun 			 const char *, size_t count);
62*4882a593Smuzhiyun 	void (*setup)(struct module *, const char *);
63*4882a593Smuzhiyun 	int (*test)(struct module *);
64*4882a593Smuzhiyun 	void (*free)(struct module *);
65*4882a593Smuzhiyun };
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun struct module_version_attribute {
68*4882a593Smuzhiyun 	struct module_attribute mattr;
69*4882a593Smuzhiyun 	const char *module_name;
70*4882a593Smuzhiyun 	const char *version;
71*4882a593Smuzhiyun } __attribute__ ((__aligned__(sizeof(void *))));
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun extern ssize_t __modver_version_show(struct module_attribute *,
74*4882a593Smuzhiyun 				     struct module_kobject *, char *);
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun extern struct module_attribute module_uevent;
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun /* These are either module local, or the kernel's dummy ones. */
79*4882a593Smuzhiyun extern int init_module(void);
80*4882a593Smuzhiyun extern void cleanup_module(void);
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun #ifndef MODULE
83*4882a593Smuzhiyun /**
84*4882a593Smuzhiyun  * module_init() - driver initialization entry point
85*4882a593Smuzhiyun  * @x: function to be run at kernel boot time or module insertion
86*4882a593Smuzhiyun  *
87*4882a593Smuzhiyun  * module_init() will either be called during do_initcalls() (if
88*4882a593Smuzhiyun  * builtin) or at module insertion time (if a module).  There can only
89*4882a593Smuzhiyun  * be one per module.
90*4882a593Smuzhiyun  */
91*4882a593Smuzhiyun #define module_init(x)	__initcall(x);
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun /**
94*4882a593Smuzhiyun  * module_exit() - driver exit entry point
95*4882a593Smuzhiyun  * @x: function to be run when driver is removed
96*4882a593Smuzhiyun  *
97*4882a593Smuzhiyun  * module_exit() will wrap the driver clean-up code
98*4882a593Smuzhiyun  * with cleanup_module() when used with rmmod when
99*4882a593Smuzhiyun  * the driver is a module.  If the driver is statically
100*4882a593Smuzhiyun  * compiled into the kernel, module_exit() has no effect.
101*4882a593Smuzhiyun  * There can only be one per module.
102*4882a593Smuzhiyun  */
103*4882a593Smuzhiyun #define module_exit(x)	__exitcall(x);
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun #else /* MODULE */
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun /*
108*4882a593Smuzhiyun  * In most cases loadable modules do not need custom
109*4882a593Smuzhiyun  * initcall levels. There are still some valid cases where
110*4882a593Smuzhiyun  * a driver may be needed early if built in, and does not
111*4882a593Smuzhiyun  * matter when built as a loadable module. Like bus
112*4882a593Smuzhiyun  * snooping debug drivers.
113*4882a593Smuzhiyun  */
114*4882a593Smuzhiyun #define early_initcall(fn)		module_init(fn)
115*4882a593Smuzhiyun #define core_initcall(fn)		module_init(fn)
116*4882a593Smuzhiyun #define core_initcall_sync(fn)		module_init(fn)
117*4882a593Smuzhiyun #define postcore_initcall(fn)		module_init(fn)
118*4882a593Smuzhiyun #define postcore_initcall_sync(fn)	module_init(fn)
119*4882a593Smuzhiyun #define arch_initcall(fn)		module_init(fn)
120*4882a593Smuzhiyun #define subsys_initcall(fn)		module_init(fn)
121*4882a593Smuzhiyun #define subsys_initcall_sync(fn)	module_init(fn)
122*4882a593Smuzhiyun #define fs_initcall(fn)			module_init(fn)
123*4882a593Smuzhiyun #define fs_initcall_sync(fn)		module_init(fn)
124*4882a593Smuzhiyun #define rootfs_initcall(fn)		module_init(fn)
125*4882a593Smuzhiyun #define device_initcall(fn)		module_init(fn)
126*4882a593Smuzhiyun #define device_initcall_sync(fn)	module_init(fn)
127*4882a593Smuzhiyun #define late_initcall(fn)		module_init(fn)
128*4882a593Smuzhiyun #define late_initcall_sync(fn)		module_init(fn)
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun #define console_initcall(fn)		module_init(fn)
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun /* Each module must use one module_init(). */
133*4882a593Smuzhiyun #define module_init(initfn)					\
134*4882a593Smuzhiyun 	static inline initcall_t __maybe_unused __inittest(void)		\
135*4882a593Smuzhiyun 	{ return initfn; }					\
136*4882a593Smuzhiyun 	int init_module(void) __copy(initfn) 			\
137*4882a593Smuzhiyun 		__attribute__((alias(#initfn)));		\
138*4882a593Smuzhiyun 	__CFI_ADDRESSABLE(init_module)
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun /* This is only required if you want to be unloadable. */
141*4882a593Smuzhiyun #define module_exit(exitfn)					\
142*4882a593Smuzhiyun 	static inline exitcall_t __maybe_unused __exittest(void)		\
143*4882a593Smuzhiyun 	{ return exitfn; }					\
144*4882a593Smuzhiyun 	void cleanup_module(void) __copy(exitfn) 		\
145*4882a593Smuzhiyun 		__attribute__((alias(#exitfn))); 		\
146*4882a593Smuzhiyun 	__CFI_ADDRESSABLE(cleanup_module)
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun #endif
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun /* This means "can be init if no module support, otherwise module load
151*4882a593Smuzhiyun    may call it." */
152*4882a593Smuzhiyun #ifdef CONFIG_MODULES
153*4882a593Smuzhiyun #define __init_or_module
154*4882a593Smuzhiyun #define __initdata_or_module
155*4882a593Smuzhiyun #define __initconst_or_module
156*4882a593Smuzhiyun #define __INIT_OR_MODULE	.text
157*4882a593Smuzhiyun #define __INITDATA_OR_MODULE	.data
158*4882a593Smuzhiyun #define __INITRODATA_OR_MODULE	.section ".rodata","a",%progbits
159*4882a593Smuzhiyun #else
160*4882a593Smuzhiyun #define __init_or_module __init
161*4882a593Smuzhiyun #define __initdata_or_module __initdata
162*4882a593Smuzhiyun #define __initconst_or_module __initconst
163*4882a593Smuzhiyun #define __INIT_OR_MODULE __INIT
164*4882a593Smuzhiyun #define __INITDATA_OR_MODULE __INITDATA
165*4882a593Smuzhiyun #define __INITRODATA_OR_MODULE __INITRODATA
166*4882a593Smuzhiyun #endif /*CONFIG_MODULES*/
167*4882a593Smuzhiyun 
168*4882a593Smuzhiyun /* Generic info of form tag = "info" */
169*4882a593Smuzhiyun #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
170*4882a593Smuzhiyun 
171*4882a593Smuzhiyun /* For userspace: you can also call me... */
172*4882a593Smuzhiyun #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
173*4882a593Smuzhiyun 
174*4882a593Smuzhiyun /* Soft module dependencies. See man modprobe.d for details.
175*4882a593Smuzhiyun  * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
176*4882a593Smuzhiyun  */
177*4882a593Smuzhiyun #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun /*
180*4882a593Smuzhiyun  * MODULE_FILE is used for generating modules.builtin
181*4882a593Smuzhiyun  * So, make it no-op when this is being built as a module
182*4882a593Smuzhiyun  */
183*4882a593Smuzhiyun #ifdef MODULE
184*4882a593Smuzhiyun #define MODULE_FILE
185*4882a593Smuzhiyun #else
186*4882a593Smuzhiyun #define MODULE_FILE	MODULE_INFO(file, KBUILD_MODFILE);
187*4882a593Smuzhiyun #endif
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun /*
190*4882a593Smuzhiyun  * The following license idents are currently accepted as indicating free
191*4882a593Smuzhiyun  * software modules
192*4882a593Smuzhiyun  *
193*4882a593Smuzhiyun  *	"GPL"				[GNU Public License v2]
194*4882a593Smuzhiyun  *	"GPL v2"			[GNU Public License v2]
195*4882a593Smuzhiyun  *	"GPL and additional rights"	[GNU Public License v2 rights and more]
196*4882a593Smuzhiyun  *	"Dual BSD/GPL"			[GNU Public License v2
197*4882a593Smuzhiyun  *					 or BSD license choice]
198*4882a593Smuzhiyun  *	"Dual MIT/GPL"			[GNU Public License v2
199*4882a593Smuzhiyun  *					 or MIT license choice]
200*4882a593Smuzhiyun  *	"Dual MPL/GPL"			[GNU Public License v2
201*4882a593Smuzhiyun  *					 or Mozilla license choice]
202*4882a593Smuzhiyun  *
203*4882a593Smuzhiyun  * The following other idents are available
204*4882a593Smuzhiyun  *
205*4882a593Smuzhiyun  *	"Proprietary"			[Non free products]
206*4882a593Smuzhiyun  *
207*4882a593Smuzhiyun  * Both "GPL v2" and "GPL" (the latter also in dual licensed strings) are
208*4882a593Smuzhiyun  * merely stating that the module is licensed under the GPL v2, but are not
209*4882a593Smuzhiyun  * telling whether "GPL v2 only" or "GPL v2 or later". The reason why there
210*4882a593Smuzhiyun  * are two variants is a historic and failed attempt to convey more
211*4882a593Smuzhiyun  * information in the MODULE_LICENSE string. For module loading the
212*4882a593Smuzhiyun  * "only/or later" distinction is completely irrelevant and does neither
213*4882a593Smuzhiyun  * replace the proper license identifiers in the corresponding source file
214*4882a593Smuzhiyun  * nor amends them in any way. The sole purpose is to make the
215*4882a593Smuzhiyun  * 'Proprietary' flagging work and to refuse to bind symbols which are
216*4882a593Smuzhiyun  * exported with EXPORT_SYMBOL_GPL when a non free module is loaded.
217*4882a593Smuzhiyun  *
218*4882a593Smuzhiyun  * In the same way "BSD" is not a clear license information. It merely
219*4882a593Smuzhiyun  * states, that the module is licensed under one of the compatible BSD
220*4882a593Smuzhiyun  * license variants. The detailed and correct license information is again
221*4882a593Smuzhiyun  * to be found in the corresponding source files.
222*4882a593Smuzhiyun  *
223*4882a593Smuzhiyun  * There are dual licensed components, but when running with Linux it is the
224*4882a593Smuzhiyun  * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
225*4882a593Smuzhiyun  * is a GPL combined work.
226*4882a593Smuzhiyun  *
227*4882a593Smuzhiyun  * This exists for several reasons
228*4882a593Smuzhiyun  * 1.	So modinfo can show license info for users wanting to vet their setup
229*4882a593Smuzhiyun  *	is free
230*4882a593Smuzhiyun  * 2.	So the community can ignore bug reports including proprietary modules
231*4882a593Smuzhiyun  * 3.	So vendors can do likewise based on their own policies
232*4882a593Smuzhiyun  */
233*4882a593Smuzhiyun #define MODULE_LICENSE(_license) MODULE_FILE MODULE_INFO(license, _license)
234*4882a593Smuzhiyun 
235*4882a593Smuzhiyun /*
236*4882a593Smuzhiyun  * Author(s), use "Name <email>" or just "Name", for multiple
237*4882a593Smuzhiyun  * authors use multiple MODULE_AUTHOR() statements/lines.
238*4882a593Smuzhiyun  */
239*4882a593Smuzhiyun #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
240*4882a593Smuzhiyun 
241*4882a593Smuzhiyun /* What your module does. */
242*4882a593Smuzhiyun #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
243*4882a593Smuzhiyun 
244*4882a593Smuzhiyun #ifdef MODULE
245*4882a593Smuzhiyun /* Creates an alias so file2alias.c can find device table. */
246*4882a593Smuzhiyun #define MODULE_DEVICE_TABLE(type, name)					\
247*4882a593Smuzhiyun extern typeof(name) __mod_##type##__##name##_device_table		\
248*4882a593Smuzhiyun   __attribute__ ((unused, alias(__stringify(name))))
249*4882a593Smuzhiyun #else  /* !MODULE */
250*4882a593Smuzhiyun #define MODULE_DEVICE_TABLE(type, name)
251*4882a593Smuzhiyun #endif
252*4882a593Smuzhiyun 
253*4882a593Smuzhiyun /* Version of form [<epoch>:]<version>[-<extra-version>].
254*4882a593Smuzhiyun  * Or for CVS/RCS ID version, everything but the number is stripped.
255*4882a593Smuzhiyun  * <epoch>: A (small) unsigned integer which allows you to start versions
256*4882a593Smuzhiyun  * anew. If not mentioned, it's zero.  eg. "2:1.0" is after
257*4882a593Smuzhiyun  * "1:2.0".
258*4882a593Smuzhiyun 
259*4882a593Smuzhiyun  * <version>: The <version> may contain only alphanumerics and the
260*4882a593Smuzhiyun  * character `.'.  Ordered by numeric sort for numeric parts,
261*4882a593Smuzhiyun  * ascii sort for ascii parts (as per RPM or DEB algorithm).
262*4882a593Smuzhiyun 
263*4882a593Smuzhiyun  * <extraversion>: Like <version>, but inserted for local
264*4882a593Smuzhiyun  * customizations, eg "rh3" or "rusty1".
265*4882a593Smuzhiyun 
266*4882a593Smuzhiyun  * Using this automatically adds a checksum of the .c files and the
267*4882a593Smuzhiyun  * local headers in "srcversion".
268*4882a593Smuzhiyun  */
269*4882a593Smuzhiyun 
270*4882a593Smuzhiyun #if defined(MODULE) || !defined(CONFIG_SYSFS)
271*4882a593Smuzhiyun #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
272*4882a593Smuzhiyun #else
273*4882a593Smuzhiyun #define MODULE_VERSION(_version)					\
274*4882a593Smuzhiyun 	MODULE_INFO(version, _version);					\
275*4882a593Smuzhiyun 	static struct module_version_attribute ___modver_attr = {	\
276*4882a593Smuzhiyun 		.mattr	= {						\
277*4882a593Smuzhiyun 			.attr	= {					\
278*4882a593Smuzhiyun 				.name	= "version",			\
279*4882a593Smuzhiyun 				.mode	= S_IRUGO,			\
280*4882a593Smuzhiyun 			},						\
281*4882a593Smuzhiyun 			.show	= __modver_version_show,		\
282*4882a593Smuzhiyun 		},							\
283*4882a593Smuzhiyun 		.module_name	= KBUILD_MODNAME,			\
284*4882a593Smuzhiyun 		.version	= _version,				\
285*4882a593Smuzhiyun 	};								\
286*4882a593Smuzhiyun 	static const struct module_version_attribute			\
287*4882a593Smuzhiyun 	__used __section("__modver")					\
288*4882a593Smuzhiyun 	* __moduleparam_const __modver_attr = &___modver_attr
289*4882a593Smuzhiyun #endif
290*4882a593Smuzhiyun 
291*4882a593Smuzhiyun /* Optional firmware file (or files) needed by the module
292*4882a593Smuzhiyun  * format is simply firmware file name.  Multiple firmware
293*4882a593Smuzhiyun  * files require multiple MODULE_FIRMWARE() specifiers */
294*4882a593Smuzhiyun #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
295*4882a593Smuzhiyun 
296*4882a593Smuzhiyun #define MODULE_IMPORT_NS(ns)	MODULE_INFO(import_ns, __stringify(ns))
297*4882a593Smuzhiyun 
298*4882a593Smuzhiyun struct notifier_block;
299*4882a593Smuzhiyun 
300*4882a593Smuzhiyun #ifdef CONFIG_MODULES
301*4882a593Smuzhiyun 
302*4882a593Smuzhiyun extern int modules_disabled; /* for sysctl */
303*4882a593Smuzhiyun /* Get/put a kernel symbol (calls must be symmetric) */
304*4882a593Smuzhiyun void *__symbol_get(const char *symbol);
305*4882a593Smuzhiyun void *__symbol_get_gpl(const char *symbol);
306*4882a593Smuzhiyun #define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
307*4882a593Smuzhiyun 
308*4882a593Smuzhiyun /* modules using other modules: kdb wants to see this. */
309*4882a593Smuzhiyun struct module_use {
310*4882a593Smuzhiyun 	struct list_head source_list;
311*4882a593Smuzhiyun 	struct list_head target_list;
312*4882a593Smuzhiyun 	struct module *source, *target;
313*4882a593Smuzhiyun };
314*4882a593Smuzhiyun 
315*4882a593Smuzhiyun enum module_state {
316*4882a593Smuzhiyun 	MODULE_STATE_LIVE,	/* Normal state. */
317*4882a593Smuzhiyun 	MODULE_STATE_COMING,	/* Full formed, running module_init. */
318*4882a593Smuzhiyun 	MODULE_STATE_GOING,	/* Going away. */
319*4882a593Smuzhiyun 	MODULE_STATE_UNFORMED,	/* Still setting it up. */
320*4882a593Smuzhiyun };
321*4882a593Smuzhiyun 
322*4882a593Smuzhiyun struct mod_tree_node {
323*4882a593Smuzhiyun 	struct module *mod;
324*4882a593Smuzhiyun 	struct latch_tree_node node;
325*4882a593Smuzhiyun };
326*4882a593Smuzhiyun 
327*4882a593Smuzhiyun struct module_layout {
328*4882a593Smuzhiyun 	/* The actual code + data. */
329*4882a593Smuzhiyun 	void *base;
330*4882a593Smuzhiyun 	/* Total size. */
331*4882a593Smuzhiyun 	unsigned int size;
332*4882a593Smuzhiyun 	/* The size of the executable code.  */
333*4882a593Smuzhiyun 	unsigned int text_size;
334*4882a593Smuzhiyun 	/* Size of RO section of the module (text+rodata) */
335*4882a593Smuzhiyun 	unsigned int ro_size;
336*4882a593Smuzhiyun 	/* Size of RO after init section */
337*4882a593Smuzhiyun 	unsigned int ro_after_init_size;
338*4882a593Smuzhiyun 
339*4882a593Smuzhiyun #ifdef CONFIG_MODULES_TREE_LOOKUP
340*4882a593Smuzhiyun 	struct mod_tree_node mtn;
341*4882a593Smuzhiyun #endif
342*4882a593Smuzhiyun };
343*4882a593Smuzhiyun 
344*4882a593Smuzhiyun #ifdef CONFIG_MODULES_TREE_LOOKUP
345*4882a593Smuzhiyun /* Only touch one cacheline for common rbtree-for-core-layout case. */
346*4882a593Smuzhiyun #define __module_layout_align ____cacheline_aligned
347*4882a593Smuzhiyun #else
348*4882a593Smuzhiyun #define __module_layout_align
349*4882a593Smuzhiyun #endif
350*4882a593Smuzhiyun 
351*4882a593Smuzhiyun struct mod_kallsyms {
352*4882a593Smuzhiyun 	Elf_Sym *symtab;
353*4882a593Smuzhiyun 	unsigned int num_symtab;
354*4882a593Smuzhiyun 	char *strtab;
355*4882a593Smuzhiyun 	char *typetab;
356*4882a593Smuzhiyun };
357*4882a593Smuzhiyun 
358*4882a593Smuzhiyun #ifdef CONFIG_LIVEPATCH
359*4882a593Smuzhiyun struct klp_modinfo {
360*4882a593Smuzhiyun 	Elf_Ehdr hdr;
361*4882a593Smuzhiyun 	Elf_Shdr *sechdrs;
362*4882a593Smuzhiyun 	char *secstrings;
363*4882a593Smuzhiyun 	unsigned int symndx;
364*4882a593Smuzhiyun };
365*4882a593Smuzhiyun #endif
366*4882a593Smuzhiyun 
367*4882a593Smuzhiyun struct module {
368*4882a593Smuzhiyun 	enum module_state state;
369*4882a593Smuzhiyun 
370*4882a593Smuzhiyun 	/* Member of list of modules */
371*4882a593Smuzhiyun 	struct list_head list;
372*4882a593Smuzhiyun 
373*4882a593Smuzhiyun 	/* Unique handle for this module */
374*4882a593Smuzhiyun 	char name[MODULE_NAME_LEN];
375*4882a593Smuzhiyun 
376*4882a593Smuzhiyun 	/* Sysfs stuff. */
377*4882a593Smuzhiyun 	struct module_kobject mkobj;
378*4882a593Smuzhiyun 	struct module_attribute *modinfo_attrs;
379*4882a593Smuzhiyun 	const char *version;
380*4882a593Smuzhiyun 	const char *srcversion;
381*4882a593Smuzhiyun 	const char *scmversion;
382*4882a593Smuzhiyun 	struct kobject *holders_dir;
383*4882a593Smuzhiyun 
384*4882a593Smuzhiyun 	/* Exported symbols */
385*4882a593Smuzhiyun 	const struct kernel_symbol *syms;
386*4882a593Smuzhiyun 	const s32 *crcs;
387*4882a593Smuzhiyun 	unsigned int num_syms;
388*4882a593Smuzhiyun 
389*4882a593Smuzhiyun #ifdef CONFIG_CFI_CLANG
390*4882a593Smuzhiyun 	cfi_check_fn cfi_check;
391*4882a593Smuzhiyun #endif
392*4882a593Smuzhiyun 
393*4882a593Smuzhiyun 	/* Kernel parameters. */
394*4882a593Smuzhiyun #ifdef CONFIG_SYSFS
395*4882a593Smuzhiyun 	struct mutex param_lock;
396*4882a593Smuzhiyun #endif
397*4882a593Smuzhiyun 	struct kernel_param *kp;
398*4882a593Smuzhiyun 	unsigned int num_kp;
399*4882a593Smuzhiyun 
400*4882a593Smuzhiyun 	/* GPL-only exported symbols. */
401*4882a593Smuzhiyun 	unsigned int num_gpl_syms;
402*4882a593Smuzhiyun 	const struct kernel_symbol *gpl_syms;
403*4882a593Smuzhiyun 	const s32 *gpl_crcs;
404*4882a593Smuzhiyun 	bool using_gplonly_symbols;
405*4882a593Smuzhiyun 
406*4882a593Smuzhiyun #ifdef CONFIG_UNUSED_SYMBOLS
407*4882a593Smuzhiyun 	/* unused exported symbols. */
408*4882a593Smuzhiyun 	const struct kernel_symbol *unused_syms;
409*4882a593Smuzhiyun 	const s32 *unused_crcs;
410*4882a593Smuzhiyun 	unsigned int num_unused_syms;
411*4882a593Smuzhiyun 
412*4882a593Smuzhiyun 	/* GPL-only, unused exported symbols. */
413*4882a593Smuzhiyun 	unsigned int num_unused_gpl_syms;
414*4882a593Smuzhiyun 	const struct kernel_symbol *unused_gpl_syms;
415*4882a593Smuzhiyun 	const s32 *unused_gpl_crcs;
416*4882a593Smuzhiyun #endif
417*4882a593Smuzhiyun 
418*4882a593Smuzhiyun 	/*
419*4882a593Smuzhiyun 	 * Signature was verified. Unconditionally compiled in Android to
420*4882a593Smuzhiyun 	 * preserve ABI compatibility between kernels without module
421*4882a593Smuzhiyun 	 * signing enabled and signed modules.
422*4882a593Smuzhiyun 	 */
423*4882a593Smuzhiyun 	bool sig_ok;
424*4882a593Smuzhiyun 
425*4882a593Smuzhiyun 	bool async_probe_requested;
426*4882a593Smuzhiyun 
427*4882a593Smuzhiyun 	/* symbols that will be GPL-only in the near future. */
428*4882a593Smuzhiyun 	const struct kernel_symbol *gpl_future_syms;
429*4882a593Smuzhiyun 	const s32 *gpl_future_crcs;
430*4882a593Smuzhiyun 	unsigned int num_gpl_future_syms;
431*4882a593Smuzhiyun 
432*4882a593Smuzhiyun 	/* Exception table */
433*4882a593Smuzhiyun 	unsigned int num_exentries;
434*4882a593Smuzhiyun 	struct exception_table_entry *extable;
435*4882a593Smuzhiyun 
436*4882a593Smuzhiyun 	/* Startup function. */
437*4882a593Smuzhiyun 	int (*init)(void);
438*4882a593Smuzhiyun 
439*4882a593Smuzhiyun 	/* Core layout: rbtree is accessed frequently, so keep together. */
440*4882a593Smuzhiyun 	struct module_layout core_layout __module_layout_align;
441*4882a593Smuzhiyun 	struct module_layout init_layout;
442*4882a593Smuzhiyun 
443*4882a593Smuzhiyun 	/* Arch-specific module values */
444*4882a593Smuzhiyun 	struct mod_arch_specific arch;
445*4882a593Smuzhiyun 
446*4882a593Smuzhiyun 	unsigned long taints;	/* same bits as kernel:taint_flags */
447*4882a593Smuzhiyun 
448*4882a593Smuzhiyun #ifdef CONFIG_GENERIC_BUG
449*4882a593Smuzhiyun 	/* Support for BUG */
450*4882a593Smuzhiyun 	unsigned num_bugs;
451*4882a593Smuzhiyun 	struct list_head bug_list;
452*4882a593Smuzhiyun 	struct bug_entry *bug_table;
453*4882a593Smuzhiyun #endif
454*4882a593Smuzhiyun 
455*4882a593Smuzhiyun #ifdef CONFIG_KALLSYMS
456*4882a593Smuzhiyun 	/* Protected by RCU and/or module_mutex: use rcu_dereference() */
457*4882a593Smuzhiyun 	struct mod_kallsyms __rcu *kallsyms;
458*4882a593Smuzhiyun 	struct mod_kallsyms core_kallsyms;
459*4882a593Smuzhiyun 
460*4882a593Smuzhiyun 	/* Section attributes */
461*4882a593Smuzhiyun 	struct module_sect_attrs *sect_attrs;
462*4882a593Smuzhiyun 
463*4882a593Smuzhiyun 	/* Notes attributes */
464*4882a593Smuzhiyun 	struct module_notes_attrs *notes_attrs;
465*4882a593Smuzhiyun #endif
466*4882a593Smuzhiyun 
467*4882a593Smuzhiyun 	/* The command line arguments (may be mangled).  People like
468*4882a593Smuzhiyun 	   keeping pointers to this stuff */
469*4882a593Smuzhiyun 	char *args;
470*4882a593Smuzhiyun 
471*4882a593Smuzhiyun #ifdef CONFIG_SMP
472*4882a593Smuzhiyun 	/* Per-cpu data. */
473*4882a593Smuzhiyun 	void __percpu *percpu;
474*4882a593Smuzhiyun 	unsigned int percpu_size;
475*4882a593Smuzhiyun #endif
476*4882a593Smuzhiyun 	void *noinstr_text_start;
477*4882a593Smuzhiyun 	unsigned int noinstr_text_size;
478*4882a593Smuzhiyun 
479*4882a593Smuzhiyun #ifdef CONFIG_TRACEPOINTS
480*4882a593Smuzhiyun 	unsigned int num_tracepoints;
481*4882a593Smuzhiyun 	tracepoint_ptr_t *tracepoints_ptrs;
482*4882a593Smuzhiyun #endif
483*4882a593Smuzhiyun #ifdef CONFIG_TREE_SRCU
484*4882a593Smuzhiyun 	unsigned int num_srcu_structs;
485*4882a593Smuzhiyun 	struct srcu_struct **srcu_struct_ptrs;
486*4882a593Smuzhiyun #endif
487*4882a593Smuzhiyun #ifdef CONFIG_BPF_EVENTS
488*4882a593Smuzhiyun 	unsigned int num_bpf_raw_events;
489*4882a593Smuzhiyun 	struct bpf_raw_event_map *bpf_raw_events;
490*4882a593Smuzhiyun #endif
491*4882a593Smuzhiyun #ifdef CONFIG_JUMP_LABEL
492*4882a593Smuzhiyun 	struct jump_entry *jump_entries;
493*4882a593Smuzhiyun 	unsigned int num_jump_entries;
494*4882a593Smuzhiyun #endif
495*4882a593Smuzhiyun #ifdef CONFIG_TRACING
496*4882a593Smuzhiyun 	unsigned int num_trace_bprintk_fmt;
497*4882a593Smuzhiyun 	const char **trace_bprintk_fmt_start;
498*4882a593Smuzhiyun #endif
499*4882a593Smuzhiyun #ifdef CONFIG_EVENT_TRACING
500*4882a593Smuzhiyun 	struct trace_event_call **trace_events;
501*4882a593Smuzhiyun 	unsigned int num_trace_events;
502*4882a593Smuzhiyun 	struct trace_eval_map **trace_evals;
503*4882a593Smuzhiyun 	unsigned int num_trace_evals;
504*4882a593Smuzhiyun #endif
505*4882a593Smuzhiyun #ifdef CONFIG_FTRACE_MCOUNT_RECORD
506*4882a593Smuzhiyun 	unsigned int num_ftrace_callsites;
507*4882a593Smuzhiyun 	unsigned long *ftrace_callsites;
508*4882a593Smuzhiyun #endif
509*4882a593Smuzhiyun #ifdef CONFIG_KPROBES
510*4882a593Smuzhiyun 	void *kprobes_text_start;
511*4882a593Smuzhiyun 	unsigned int kprobes_text_size;
512*4882a593Smuzhiyun 	unsigned long *kprobe_blacklist;
513*4882a593Smuzhiyun 	unsigned int num_kprobe_blacklist;
514*4882a593Smuzhiyun #endif
515*4882a593Smuzhiyun #ifdef CONFIG_HAVE_STATIC_CALL_INLINE
516*4882a593Smuzhiyun 	int num_static_call_sites;
517*4882a593Smuzhiyun 	struct static_call_site *static_call_sites;
518*4882a593Smuzhiyun #endif
519*4882a593Smuzhiyun 
520*4882a593Smuzhiyun #ifdef CONFIG_LIVEPATCH
521*4882a593Smuzhiyun 	bool klp; /* Is this a livepatch module? */
522*4882a593Smuzhiyun 	bool klp_alive;
523*4882a593Smuzhiyun 
524*4882a593Smuzhiyun 	/* Elf information */
525*4882a593Smuzhiyun 	struct klp_modinfo *klp_info;
526*4882a593Smuzhiyun #endif
527*4882a593Smuzhiyun 
528*4882a593Smuzhiyun #ifdef CONFIG_MODULE_UNLOAD
529*4882a593Smuzhiyun 	/* What modules depend on me? */
530*4882a593Smuzhiyun 	struct list_head source_list;
531*4882a593Smuzhiyun 	/* What modules do I depend on? */
532*4882a593Smuzhiyun 	struct list_head target_list;
533*4882a593Smuzhiyun 
534*4882a593Smuzhiyun 	/* Destruction function. */
535*4882a593Smuzhiyun 	void (*exit)(void);
536*4882a593Smuzhiyun 
537*4882a593Smuzhiyun 	atomic_t refcnt;
538*4882a593Smuzhiyun #endif
539*4882a593Smuzhiyun 
540*4882a593Smuzhiyun #ifdef CONFIG_CONSTRUCTORS
541*4882a593Smuzhiyun 	/* Constructor functions. */
542*4882a593Smuzhiyun 	ctor_fn_t *ctors;
543*4882a593Smuzhiyun 	unsigned int num_ctors;
544*4882a593Smuzhiyun #endif
545*4882a593Smuzhiyun 
546*4882a593Smuzhiyun #ifdef CONFIG_FUNCTION_ERROR_INJECTION
547*4882a593Smuzhiyun 	struct error_injection_entry *ei_funcs;
548*4882a593Smuzhiyun 	unsigned int num_ei_funcs;
549*4882a593Smuzhiyun #endif
550*4882a593Smuzhiyun 	ANDROID_KABI_RESERVE(1);
551*4882a593Smuzhiyun 	ANDROID_KABI_RESERVE(2);
552*4882a593Smuzhiyun 	ANDROID_KABI_RESERVE(3);
553*4882a593Smuzhiyun 	ANDROID_KABI_RESERVE(4);
554*4882a593Smuzhiyun } ____cacheline_aligned __randomize_layout;
555*4882a593Smuzhiyun #ifndef MODULE_ARCH_INIT
556*4882a593Smuzhiyun #define MODULE_ARCH_INIT {}
557*4882a593Smuzhiyun #endif
558*4882a593Smuzhiyun 
559*4882a593Smuzhiyun #ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
kallsyms_symbol_value(const Elf_Sym * sym)560*4882a593Smuzhiyun static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
561*4882a593Smuzhiyun {
562*4882a593Smuzhiyun 	return sym->st_value;
563*4882a593Smuzhiyun }
564*4882a593Smuzhiyun #endif
565*4882a593Smuzhiyun 
566*4882a593Smuzhiyun extern struct mutex module_mutex;
567*4882a593Smuzhiyun 
568*4882a593Smuzhiyun /* FIXME: It'd be nice to isolate modules during init, too, so they
569*4882a593Smuzhiyun    aren't used before they (may) fail.  But presently too much code
570*4882a593Smuzhiyun    (IDE & SCSI) require entry into the module during init.*/
module_is_live(struct module * mod)571*4882a593Smuzhiyun static inline bool module_is_live(struct module *mod)
572*4882a593Smuzhiyun {
573*4882a593Smuzhiyun 	return mod->state != MODULE_STATE_GOING;
574*4882a593Smuzhiyun }
575*4882a593Smuzhiyun 
576*4882a593Smuzhiyun struct module *__module_text_address(unsigned long addr);
577*4882a593Smuzhiyun struct module *__module_address(unsigned long addr);
578*4882a593Smuzhiyun bool is_module_address(unsigned long addr);
579*4882a593Smuzhiyun bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
580*4882a593Smuzhiyun bool is_module_percpu_address(unsigned long addr);
581*4882a593Smuzhiyun bool is_module_text_address(unsigned long addr);
582*4882a593Smuzhiyun 
within_module_core(unsigned long addr,const struct module * mod)583*4882a593Smuzhiyun static inline bool within_module_core(unsigned long addr,
584*4882a593Smuzhiyun 				      const struct module *mod)
585*4882a593Smuzhiyun {
586*4882a593Smuzhiyun 	return (unsigned long)mod->core_layout.base <= addr &&
587*4882a593Smuzhiyun 	       addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
588*4882a593Smuzhiyun }
589*4882a593Smuzhiyun 
within_module_init(unsigned long addr,const struct module * mod)590*4882a593Smuzhiyun static inline bool within_module_init(unsigned long addr,
591*4882a593Smuzhiyun 				      const struct module *mod)
592*4882a593Smuzhiyun {
593*4882a593Smuzhiyun 	return (unsigned long)mod->init_layout.base <= addr &&
594*4882a593Smuzhiyun 	       addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
595*4882a593Smuzhiyun }
596*4882a593Smuzhiyun 
within_module(unsigned long addr,const struct module * mod)597*4882a593Smuzhiyun static inline bool within_module(unsigned long addr, const struct module *mod)
598*4882a593Smuzhiyun {
599*4882a593Smuzhiyun 	return within_module_init(addr, mod) || within_module_core(addr, mod);
600*4882a593Smuzhiyun }
601*4882a593Smuzhiyun 
602*4882a593Smuzhiyun /* Search for module by name: must hold module_mutex. */
603*4882a593Smuzhiyun struct module *find_module(const char *name);
604*4882a593Smuzhiyun 
605*4882a593Smuzhiyun struct symsearch {
606*4882a593Smuzhiyun 	const struct kernel_symbol *start, *stop;
607*4882a593Smuzhiyun 	const s32 *crcs;
608*4882a593Smuzhiyun 	enum mod_license {
609*4882a593Smuzhiyun 		NOT_GPL_ONLY,
610*4882a593Smuzhiyun 		GPL_ONLY,
611*4882a593Smuzhiyun 		WILL_BE_GPL_ONLY,
612*4882a593Smuzhiyun 	} license;
613*4882a593Smuzhiyun 	bool unused;
614*4882a593Smuzhiyun };
615*4882a593Smuzhiyun 
616*4882a593Smuzhiyun /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
617*4882a593Smuzhiyun    symnum out of range. */
618*4882a593Smuzhiyun int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
619*4882a593Smuzhiyun 			char *name, char *module_name, int *exported);
620*4882a593Smuzhiyun 
621*4882a593Smuzhiyun /* Look for this name: can be of form module:name. */
622*4882a593Smuzhiyun unsigned long module_kallsyms_lookup_name(const char *name);
623*4882a593Smuzhiyun 
624*4882a593Smuzhiyun int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
625*4882a593Smuzhiyun 					     struct module *, unsigned long),
626*4882a593Smuzhiyun 				   void *data);
627*4882a593Smuzhiyun 
628*4882a593Smuzhiyun extern void __noreturn __module_put_and_exit(struct module *mod,
629*4882a593Smuzhiyun 			long code);
630*4882a593Smuzhiyun #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
631*4882a593Smuzhiyun 
632*4882a593Smuzhiyun #ifdef CONFIG_MODULE_UNLOAD
633*4882a593Smuzhiyun int module_refcount(struct module *mod);
634*4882a593Smuzhiyun void __symbol_put(const char *symbol);
635*4882a593Smuzhiyun #define symbol_put(x) __symbol_put(__stringify(x))
636*4882a593Smuzhiyun void symbol_put_addr(void *addr);
637*4882a593Smuzhiyun 
638*4882a593Smuzhiyun /* Sometimes we know we already have a refcount, and it's easier not
639*4882a593Smuzhiyun    to handle the error case (which only happens with rmmod --wait). */
640*4882a593Smuzhiyun extern void __module_get(struct module *module);
641*4882a593Smuzhiyun 
642*4882a593Smuzhiyun /* This is the Right Way to get a module: if it fails, it's being removed,
643*4882a593Smuzhiyun  * so pretend it's not there. */
644*4882a593Smuzhiyun extern bool try_module_get(struct module *module);
645*4882a593Smuzhiyun 
646*4882a593Smuzhiyun extern void module_put(struct module *module);
647*4882a593Smuzhiyun 
648*4882a593Smuzhiyun #else /*!CONFIG_MODULE_UNLOAD*/
try_module_get(struct module * module)649*4882a593Smuzhiyun static inline bool try_module_get(struct module *module)
650*4882a593Smuzhiyun {
651*4882a593Smuzhiyun 	return !module || module_is_live(module);
652*4882a593Smuzhiyun }
module_put(struct module * module)653*4882a593Smuzhiyun static inline void module_put(struct module *module)
654*4882a593Smuzhiyun {
655*4882a593Smuzhiyun }
__module_get(struct module * module)656*4882a593Smuzhiyun static inline void __module_get(struct module *module)
657*4882a593Smuzhiyun {
658*4882a593Smuzhiyun }
659*4882a593Smuzhiyun #define symbol_put(x) do { } while (0)
660*4882a593Smuzhiyun #define symbol_put_addr(p) do { } while (0)
661*4882a593Smuzhiyun 
662*4882a593Smuzhiyun #endif /* CONFIG_MODULE_UNLOAD */
663*4882a593Smuzhiyun 
664*4882a593Smuzhiyun /* This is a #define so the string doesn't get put in every .o file */
665*4882a593Smuzhiyun #define module_name(mod)			\
666*4882a593Smuzhiyun ({						\
667*4882a593Smuzhiyun 	struct module *__mod = (mod);		\
668*4882a593Smuzhiyun 	__mod ? __mod->name : "kernel";		\
669*4882a593Smuzhiyun })
670*4882a593Smuzhiyun 
671*4882a593Smuzhiyun /* Dereference module function descriptor */
672*4882a593Smuzhiyun void *dereference_module_function_descriptor(struct module *mod, void *ptr);
673*4882a593Smuzhiyun 
674*4882a593Smuzhiyun /* For kallsyms to ask for address resolution.  namebuf should be at
675*4882a593Smuzhiyun  * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
676*4882a593Smuzhiyun  * found, otherwise NULL. */
677*4882a593Smuzhiyun const char *module_address_lookup(unsigned long addr,
678*4882a593Smuzhiyun 			    unsigned long *symbolsize,
679*4882a593Smuzhiyun 			    unsigned long *offset,
680*4882a593Smuzhiyun 			    char **modname,
681*4882a593Smuzhiyun 			    char *namebuf);
682*4882a593Smuzhiyun int lookup_module_symbol_name(unsigned long addr, char *symname);
683*4882a593Smuzhiyun int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
684*4882a593Smuzhiyun 
685*4882a593Smuzhiyun int register_module_notifier(struct notifier_block *nb);
686*4882a593Smuzhiyun int unregister_module_notifier(struct notifier_block *nb);
687*4882a593Smuzhiyun 
688*4882a593Smuzhiyun extern void print_modules(void);
689*4882a593Smuzhiyun 
module_requested_async_probing(struct module * module)690*4882a593Smuzhiyun static inline bool module_requested_async_probing(struct module *module)
691*4882a593Smuzhiyun {
692*4882a593Smuzhiyun 	return module && module->async_probe_requested;
693*4882a593Smuzhiyun }
694*4882a593Smuzhiyun 
695*4882a593Smuzhiyun #ifdef CONFIG_LIVEPATCH
is_livepatch_module(struct module * mod)696*4882a593Smuzhiyun static inline bool is_livepatch_module(struct module *mod)
697*4882a593Smuzhiyun {
698*4882a593Smuzhiyun 	return mod->klp;
699*4882a593Smuzhiyun }
700*4882a593Smuzhiyun #else /* !CONFIG_LIVEPATCH */
is_livepatch_module(struct module * mod)701*4882a593Smuzhiyun static inline bool is_livepatch_module(struct module *mod)
702*4882a593Smuzhiyun {
703*4882a593Smuzhiyun 	return false;
704*4882a593Smuzhiyun }
705*4882a593Smuzhiyun #endif /* CONFIG_LIVEPATCH */
706*4882a593Smuzhiyun 
707*4882a593Smuzhiyun bool is_module_sig_enforced(void);
708*4882a593Smuzhiyun void set_module_sig_enforced(void);
709*4882a593Smuzhiyun 
710*4882a593Smuzhiyun #else /* !CONFIG_MODULES... */
711*4882a593Smuzhiyun 
__module_address(unsigned long addr)712*4882a593Smuzhiyun static inline struct module *__module_address(unsigned long addr)
713*4882a593Smuzhiyun {
714*4882a593Smuzhiyun 	return NULL;
715*4882a593Smuzhiyun }
716*4882a593Smuzhiyun 
__module_text_address(unsigned long addr)717*4882a593Smuzhiyun static inline struct module *__module_text_address(unsigned long addr)
718*4882a593Smuzhiyun {
719*4882a593Smuzhiyun 	return NULL;
720*4882a593Smuzhiyun }
721*4882a593Smuzhiyun 
is_module_address(unsigned long addr)722*4882a593Smuzhiyun static inline bool is_module_address(unsigned long addr)
723*4882a593Smuzhiyun {
724*4882a593Smuzhiyun 	return false;
725*4882a593Smuzhiyun }
726*4882a593Smuzhiyun 
is_module_percpu_address(unsigned long addr)727*4882a593Smuzhiyun static inline bool is_module_percpu_address(unsigned long addr)
728*4882a593Smuzhiyun {
729*4882a593Smuzhiyun 	return false;
730*4882a593Smuzhiyun }
731*4882a593Smuzhiyun 
__is_module_percpu_address(unsigned long addr,unsigned long * can_addr)732*4882a593Smuzhiyun static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
733*4882a593Smuzhiyun {
734*4882a593Smuzhiyun 	return false;
735*4882a593Smuzhiyun }
736*4882a593Smuzhiyun 
is_module_text_address(unsigned long addr)737*4882a593Smuzhiyun static inline bool is_module_text_address(unsigned long addr)
738*4882a593Smuzhiyun {
739*4882a593Smuzhiyun 	return false;
740*4882a593Smuzhiyun }
741*4882a593Smuzhiyun 
within_module_core(unsigned long addr,const struct module * mod)742*4882a593Smuzhiyun static inline bool within_module_core(unsigned long addr,
743*4882a593Smuzhiyun 				      const struct module *mod)
744*4882a593Smuzhiyun {
745*4882a593Smuzhiyun 	return false;
746*4882a593Smuzhiyun }
747*4882a593Smuzhiyun 
within_module_init(unsigned long addr,const struct module * mod)748*4882a593Smuzhiyun static inline bool within_module_init(unsigned long addr,
749*4882a593Smuzhiyun 				      const struct module *mod)
750*4882a593Smuzhiyun {
751*4882a593Smuzhiyun 	return false;
752*4882a593Smuzhiyun }
753*4882a593Smuzhiyun 
within_module(unsigned long addr,const struct module * mod)754*4882a593Smuzhiyun static inline bool within_module(unsigned long addr, const struct module *mod)
755*4882a593Smuzhiyun {
756*4882a593Smuzhiyun 	return false;
757*4882a593Smuzhiyun }
758*4882a593Smuzhiyun 
759*4882a593Smuzhiyun /* Get/put a kernel symbol (calls should be symmetric) */
760*4882a593Smuzhiyun #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak,visibility("hidden"))); &(x); })
761*4882a593Smuzhiyun #define symbol_put(x) do { } while (0)
762*4882a593Smuzhiyun #define symbol_put_addr(x) do { } while (0)
763*4882a593Smuzhiyun 
__module_get(struct module * module)764*4882a593Smuzhiyun static inline void __module_get(struct module *module)
765*4882a593Smuzhiyun {
766*4882a593Smuzhiyun }
767*4882a593Smuzhiyun 
try_module_get(struct module * module)768*4882a593Smuzhiyun static inline bool try_module_get(struct module *module)
769*4882a593Smuzhiyun {
770*4882a593Smuzhiyun 	return true;
771*4882a593Smuzhiyun }
772*4882a593Smuzhiyun 
module_put(struct module * module)773*4882a593Smuzhiyun static inline void module_put(struct module *module)
774*4882a593Smuzhiyun {
775*4882a593Smuzhiyun }
776*4882a593Smuzhiyun 
777*4882a593Smuzhiyun #define module_name(mod) "kernel"
778*4882a593Smuzhiyun 
779*4882a593Smuzhiyun /* For kallsyms to ask for address resolution.  NULL means not found. */
module_address_lookup(unsigned long addr,unsigned long * symbolsize,unsigned long * offset,char ** modname,char * namebuf)780*4882a593Smuzhiyun static inline const char *module_address_lookup(unsigned long addr,
781*4882a593Smuzhiyun 					  unsigned long *symbolsize,
782*4882a593Smuzhiyun 					  unsigned long *offset,
783*4882a593Smuzhiyun 					  char **modname,
784*4882a593Smuzhiyun 					  char *namebuf)
785*4882a593Smuzhiyun {
786*4882a593Smuzhiyun 	return NULL;
787*4882a593Smuzhiyun }
788*4882a593Smuzhiyun 
lookup_module_symbol_name(unsigned long addr,char * symname)789*4882a593Smuzhiyun static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
790*4882a593Smuzhiyun {
791*4882a593Smuzhiyun 	return -ERANGE;
792*4882a593Smuzhiyun }
793*4882a593Smuzhiyun 
lookup_module_symbol_attrs(unsigned long addr,unsigned long * size,unsigned long * offset,char * modname,char * name)794*4882a593Smuzhiyun static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
795*4882a593Smuzhiyun {
796*4882a593Smuzhiyun 	return -ERANGE;
797*4882a593Smuzhiyun }
798*4882a593Smuzhiyun 
module_get_kallsym(unsigned int symnum,unsigned long * value,char * type,char * name,char * module_name,int * exported)799*4882a593Smuzhiyun static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
800*4882a593Smuzhiyun 					char *type, char *name,
801*4882a593Smuzhiyun 					char *module_name, int *exported)
802*4882a593Smuzhiyun {
803*4882a593Smuzhiyun 	return -ERANGE;
804*4882a593Smuzhiyun }
805*4882a593Smuzhiyun 
module_kallsyms_lookup_name(const char * name)806*4882a593Smuzhiyun static inline unsigned long module_kallsyms_lookup_name(const char *name)
807*4882a593Smuzhiyun {
808*4882a593Smuzhiyun 	return 0;
809*4882a593Smuzhiyun }
810*4882a593Smuzhiyun 
module_kallsyms_on_each_symbol(int (* fn)(void *,const char *,struct module *,unsigned long),void * data)811*4882a593Smuzhiyun static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
812*4882a593Smuzhiyun 							   struct module *,
813*4882a593Smuzhiyun 							   unsigned long),
814*4882a593Smuzhiyun 						 void *data)
815*4882a593Smuzhiyun {
816*4882a593Smuzhiyun 	return 0;
817*4882a593Smuzhiyun }
818*4882a593Smuzhiyun 
register_module_notifier(struct notifier_block * nb)819*4882a593Smuzhiyun static inline int register_module_notifier(struct notifier_block *nb)
820*4882a593Smuzhiyun {
821*4882a593Smuzhiyun 	/* no events will happen anyway, so this can always succeed */
822*4882a593Smuzhiyun 	return 0;
823*4882a593Smuzhiyun }
824*4882a593Smuzhiyun 
unregister_module_notifier(struct notifier_block * nb)825*4882a593Smuzhiyun static inline int unregister_module_notifier(struct notifier_block *nb)
826*4882a593Smuzhiyun {
827*4882a593Smuzhiyun 	return 0;
828*4882a593Smuzhiyun }
829*4882a593Smuzhiyun 
830*4882a593Smuzhiyun #define module_put_and_exit(code) do_exit(code)
831*4882a593Smuzhiyun 
print_modules(void)832*4882a593Smuzhiyun static inline void print_modules(void)
833*4882a593Smuzhiyun {
834*4882a593Smuzhiyun }
835*4882a593Smuzhiyun 
module_requested_async_probing(struct module * module)836*4882a593Smuzhiyun static inline bool module_requested_async_probing(struct module *module)
837*4882a593Smuzhiyun {
838*4882a593Smuzhiyun 	return false;
839*4882a593Smuzhiyun }
840*4882a593Smuzhiyun 
is_module_sig_enforced(void)841*4882a593Smuzhiyun static inline bool is_module_sig_enforced(void)
842*4882a593Smuzhiyun {
843*4882a593Smuzhiyun 	return false;
844*4882a593Smuzhiyun }
845*4882a593Smuzhiyun 
set_module_sig_enforced(void)846*4882a593Smuzhiyun static inline void set_module_sig_enforced(void)
847*4882a593Smuzhiyun {
848*4882a593Smuzhiyun }
849*4882a593Smuzhiyun 
850*4882a593Smuzhiyun /* Dereference module function descriptor */
851*4882a593Smuzhiyun static inline
dereference_module_function_descriptor(struct module * mod,void * ptr)852*4882a593Smuzhiyun void *dereference_module_function_descriptor(struct module *mod, void *ptr)
853*4882a593Smuzhiyun {
854*4882a593Smuzhiyun 	return ptr;
855*4882a593Smuzhiyun }
856*4882a593Smuzhiyun 
857*4882a593Smuzhiyun #endif /* CONFIG_MODULES */
858*4882a593Smuzhiyun 
859*4882a593Smuzhiyun #ifdef CONFIG_SYSFS
860*4882a593Smuzhiyun extern struct kset *module_kset;
861*4882a593Smuzhiyun extern struct kobj_type module_ktype;
862*4882a593Smuzhiyun extern int module_sysfs_initialized;
863*4882a593Smuzhiyun #endif /* CONFIG_SYSFS */
864*4882a593Smuzhiyun 
865*4882a593Smuzhiyun #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
866*4882a593Smuzhiyun 
867*4882a593Smuzhiyun /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
868*4882a593Smuzhiyun 
869*4882a593Smuzhiyun #define __MODULE_STRING(x) __stringify(x)
870*4882a593Smuzhiyun 
871*4882a593Smuzhiyun #ifdef CONFIG_GENERIC_BUG
872*4882a593Smuzhiyun void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
873*4882a593Smuzhiyun 			 struct module *);
874*4882a593Smuzhiyun void module_bug_cleanup(struct module *);
875*4882a593Smuzhiyun 
876*4882a593Smuzhiyun #else	/* !CONFIG_GENERIC_BUG */
877*4882a593Smuzhiyun 
module_bug_finalize(const Elf_Ehdr * hdr,const Elf_Shdr * sechdrs,struct module * mod)878*4882a593Smuzhiyun static inline void module_bug_finalize(const Elf_Ehdr *hdr,
879*4882a593Smuzhiyun 					const Elf_Shdr *sechdrs,
880*4882a593Smuzhiyun 					struct module *mod)
881*4882a593Smuzhiyun {
882*4882a593Smuzhiyun }
module_bug_cleanup(struct module * mod)883*4882a593Smuzhiyun static inline void module_bug_cleanup(struct module *mod) {}
884*4882a593Smuzhiyun #endif	/* CONFIG_GENERIC_BUG */
885*4882a593Smuzhiyun 
886*4882a593Smuzhiyun #ifdef CONFIG_RETPOLINE
887*4882a593Smuzhiyun extern bool retpoline_module_ok(bool has_retpoline);
888*4882a593Smuzhiyun #else
retpoline_module_ok(bool has_retpoline)889*4882a593Smuzhiyun static inline bool retpoline_module_ok(bool has_retpoline)
890*4882a593Smuzhiyun {
891*4882a593Smuzhiyun 	return true;
892*4882a593Smuzhiyun }
893*4882a593Smuzhiyun #endif
894*4882a593Smuzhiyun 
895*4882a593Smuzhiyun #ifdef CONFIG_MODULE_SIG
module_sig_ok(struct module * module)896*4882a593Smuzhiyun static inline bool module_sig_ok(struct module *module)
897*4882a593Smuzhiyun {
898*4882a593Smuzhiyun 	return module->sig_ok;
899*4882a593Smuzhiyun }
900*4882a593Smuzhiyun #else	/* !CONFIG_MODULE_SIG */
module_sig_ok(struct module * module)901*4882a593Smuzhiyun static inline bool module_sig_ok(struct module *module)
902*4882a593Smuzhiyun {
903*4882a593Smuzhiyun 	return true;
904*4882a593Smuzhiyun }
905*4882a593Smuzhiyun #endif	/* CONFIG_MODULE_SIG */
906*4882a593Smuzhiyun 
907*4882a593Smuzhiyun #endif /* _LINUX_MODULE_H */
908