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