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