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