1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Dynamic loading of modules into the kernel.
5 * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
6 * Rewritten again by Rusty Russell, 2002
9 #ifndef _LINUX_MODULE_H
10 #define _LINUX_MODULE_H
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 #include <linux/static_call_types.h>
29 #include <linux/cfi.h>
31 #include <linux/percpu.h>
32 #include <asm/module.h>
34 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
36 struct modversion_info {
38 char name[MODULE_NAME_LEN];
42 struct exception_table_entry;
44 struct module_kobject {
47 struct kobject *drivers_dir;
48 struct module_param_attrs *mp;
49 struct completion *kobj_completion;
52 struct module_attribute {
53 struct attribute attr;
54 ssize_t (*show)(struct module_attribute *, struct module_kobject *,
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 *);
63 struct module_version_attribute {
64 struct module_attribute mattr;
65 const char *module_name;
69 extern ssize_t __modver_version_show(struct module_attribute *,
70 struct module_kobject *, char *);
72 extern struct module_attribute module_uevent;
74 /* These are either module local, or the kernel's dummy ones. */
75 extern int init_module(void);
76 extern void cleanup_module(void);
80 * module_init() - driver initialization entry point
81 * @x: function to be run at kernel boot time or module insertion
83 * module_init() will either be called during do_initcalls() (if
84 * builtin) or at module insertion time (if a module). There can only
87 #define module_init(x) __initcall(x);
90 * module_exit() - driver exit entry point
91 * @x: function to be run when driver is removed
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.
99 #define module_exit(x) __exitcall(x);
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.
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)
126 #define console_initcall(fn) module_init(fn)
128 /* Each module must use one module_init(). */
129 #define module_init(initfn) \
130 static inline initcall_t __maybe_unused __inittest(void) \
132 int init_module(void) __copy(initfn) \
133 __attribute__((alias(#initfn))); \
134 __CFI_ADDRESSABLE(init_module, __initdata);
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) \
140 void cleanup_module(void) __copy(exitfn) \
141 __attribute__((alias(#exitfn))); \
142 __CFI_ADDRESSABLE(cleanup_module, __exitdata);
146 /* This means "can be init if no module support, otherwise module load
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
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*/
164 /* Generic info of form tag = "info" */
165 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
167 /* For userspace: you can also call me... */
168 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
170 /* Soft module dependencies. See man modprobe.d for details.
171 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
173 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
176 * MODULE_FILE is used for generating modules.builtin
177 * So, make it no-op when this is being built as a module
182 #define MODULE_FILE MODULE_INFO(file, KBUILD_MODFILE);
186 * The following license idents are currently accepted as indicating free
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]
199 * The following other idents are available
201 * "Proprietary" [Non free products]
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.
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.
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.
223 * This exists for several reasons
224 * 1. So modinfo can show license info for users wanting to vet their setup
226 * 2. So the community can ignore bug reports including proprietary modules
227 * 3. So vendors can do likewise based on their own policies
229 #define MODULE_LICENSE(_license) MODULE_FILE MODULE_INFO(license, _license)
232 * Author(s), use "Name <email>" or just "Name", for multiple
233 * authors use multiple MODULE_AUTHOR() statements/lines.
235 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
237 /* What your module does. */
238 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
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))))
246 #define MODULE_DEVICE_TABLE(type, name)
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
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).
259 * <extraversion>: Like <version>, but inserted for local
260 * customizations, eg "rh3" or "rusty1".
262 * Using this automatically adds a checksum of the .c files and the
263 * local headers in "srcversion".
266 #if defined(MODULE) || !defined(CONFIG_SYSFS)
267 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
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)) \
280 .show = __modver_version_show, \
282 .module_name = KBUILD_MODNAME, \
283 .version = _version, \
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)
292 #define MODULE_IMPORT_NS(ns) MODULE_INFO(import_ns, #ns)
294 struct notifier_block;
296 #ifdef CONFIG_MODULES
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))))
304 /* modules using other modules: kdb wants to see this. */
306 struct list_head source_list;
307 struct list_head target_list;
308 struct module *source, *target;
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. */
318 struct mod_tree_node {
320 struct latch_tree_node node;
323 struct module_layout {
324 /* The actual code + data. */
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;
335 #ifdef CONFIG_MODULES_TREE_LOOKUP
336 struct mod_tree_node mtn;
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
344 #define __module_layout_align
347 struct mod_kallsyms {
349 unsigned int num_symtab;
354 #ifdef CONFIG_LIVEPATCH
364 enum module_state state;
366 /* Member of list of modules */
367 struct list_head list;
369 /* Unique handle for this module */
370 char name[MODULE_NAME_LEN];
373 struct module_kobject mkobj;
374 struct module_attribute *modinfo_attrs;
376 const char *srcversion;
377 struct kobject *holders_dir;
379 /* Exported symbols */
380 const struct kernel_symbol *syms;
382 unsigned int num_syms;
384 #ifdef CONFIG_CFI_CLANG
385 cfi_check_fn cfi_check;
388 /* Kernel parameters. */
390 struct mutex param_lock;
392 struct kernel_param *kp;
395 /* GPL-only exported symbols. */
396 unsigned int num_gpl_syms;
397 const struct kernel_symbol *gpl_syms;
399 bool using_gplonly_symbols;
401 #ifdef CONFIG_MODULE_SIG
402 /* Signature was verified. */
406 bool async_probe_requested;
408 /* Exception table */
409 unsigned int num_exentries;
410 struct exception_table_entry *extable;
412 /* Startup function. */
415 /* Core layout: rbtree is accessed frequently, so keep together. */
416 struct module_layout core_layout __module_layout_align;
417 struct module_layout init_layout;
419 /* Arch-specific module values */
420 struct mod_arch_specific arch;
422 unsigned long taints; /* same bits as kernel:taint_flags */
424 #ifdef CONFIG_GENERIC_BUG
425 /* Support for BUG */
427 struct list_head bug_list;
428 struct bug_entry *bug_table;
431 #ifdef CONFIG_KALLSYMS
432 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
433 struct mod_kallsyms __rcu *kallsyms;
434 struct mod_kallsyms core_kallsyms;
436 /* Section attributes */
437 struct module_sect_attrs *sect_attrs;
439 /* Notes attributes */
440 struct module_notes_attrs *notes_attrs;
443 /* The command line arguments (may be mangled). People like
444 keeping pointers to this stuff */
449 void __percpu *percpu;
450 unsigned int percpu_size;
452 void *noinstr_text_start;
453 unsigned int noinstr_text_size;
455 #ifdef CONFIG_TRACEPOINTS
456 unsigned int num_tracepoints;
457 tracepoint_ptr_t *tracepoints_ptrs;
459 #ifdef CONFIG_TREE_SRCU
460 unsigned int num_srcu_structs;
461 struct srcu_struct **srcu_struct_ptrs;
463 #ifdef CONFIG_BPF_EVENTS
464 unsigned int num_bpf_raw_events;
465 struct bpf_raw_event_map *bpf_raw_events;
467 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
468 unsigned int btf_data_size;
471 #ifdef CONFIG_JUMP_LABEL
472 struct jump_entry *jump_entries;
473 unsigned int num_jump_entries;
475 #ifdef CONFIG_TRACING
476 unsigned int num_trace_bprintk_fmt;
477 const char **trace_bprintk_fmt_start;
479 #ifdef CONFIG_EVENT_TRACING
480 struct trace_event_call **trace_events;
481 unsigned int num_trace_events;
482 struct trace_eval_map **trace_evals;
483 unsigned int num_trace_evals;
485 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
486 unsigned int num_ftrace_callsites;
487 unsigned long *ftrace_callsites;
489 #ifdef CONFIG_KPROBES
490 void *kprobes_text_start;
491 unsigned int kprobes_text_size;
492 unsigned long *kprobe_blacklist;
493 unsigned int num_kprobe_blacklist;
495 #ifdef CONFIG_HAVE_STATIC_CALL_INLINE
496 int num_static_call_sites;
497 struct static_call_site *static_call_sites;
500 #ifdef CONFIG_LIVEPATCH
501 bool klp; /* Is this a livepatch module? */
504 /* Elf information */
505 struct klp_modinfo *klp_info;
508 #ifdef CONFIG_MODULE_UNLOAD
509 /* What modules depend on me? */
510 struct list_head source_list;
511 /* What modules do I depend on? */
512 struct list_head target_list;
514 /* Destruction function. */
520 #ifdef CONFIG_CONSTRUCTORS
521 /* Constructor functions. */
523 unsigned int num_ctors;
526 #ifdef CONFIG_FUNCTION_ERROR_INJECTION
527 struct error_injection_entry *ei_funcs;
528 unsigned int num_ei_funcs;
530 } ____cacheline_aligned __randomize_layout;
531 #ifndef MODULE_ARCH_INIT
532 #define MODULE_ARCH_INIT {}
535 #ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
536 static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
538 return sym->st_value;
542 /* FIXME: It'd be nice to isolate modules during init, too, so they
543 aren't used before they (may) fail. But presently too much code
544 (IDE & SCSI) require entry into the module during init.*/
545 static inline bool module_is_live(struct module *mod)
547 return mod->state != MODULE_STATE_GOING;
550 struct module *__module_text_address(unsigned long addr);
551 struct module *__module_address(unsigned long addr);
552 bool is_module_address(unsigned long addr);
553 bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
554 bool is_module_percpu_address(unsigned long addr);
555 bool is_module_text_address(unsigned long addr);
557 static inline bool within_module_core(unsigned long addr,
558 const struct module *mod)
560 return (unsigned long)mod->core_layout.base <= addr &&
561 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
564 static inline bool within_module_init(unsigned long addr,
565 const struct module *mod)
567 return (unsigned long)mod->init_layout.base <= addr &&
568 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
571 static inline bool within_module(unsigned long addr, const struct module *mod)
573 return within_module_init(addr, mod) || within_module_core(addr, mod);
576 /* Search for module by name: must be in a RCU-sched critical section. */
577 struct module *find_module(const char *name);
579 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
580 symnum out of range. */
581 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
582 char *name, char *module_name, int *exported);
584 /* Look for this name: can be of form module:name. */
585 unsigned long module_kallsyms_lookup_name(const char *name);
587 extern void __noreturn __module_put_and_exit(struct module *mod,
589 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
591 #ifdef CONFIG_MODULE_UNLOAD
592 int module_refcount(struct module *mod);
593 void __symbol_put(const char *symbol);
594 #define symbol_put(x) __symbol_put(__stringify(x))
595 void symbol_put_addr(void *addr);
597 /* Sometimes we know we already have a refcount, and it's easier not
598 to handle the error case (which only happens with rmmod --wait). */
599 extern void __module_get(struct module *module);
601 /* This is the Right Way to get a module: if it fails, it's being removed,
602 * so pretend it's not there. */
603 extern bool try_module_get(struct module *module);
605 extern void module_put(struct module *module);
607 #else /*!CONFIG_MODULE_UNLOAD*/
608 static inline bool try_module_get(struct module *module)
610 return !module || module_is_live(module);
612 static inline void module_put(struct module *module)
615 static inline void __module_get(struct module *module)
618 #define symbol_put(x) do { } while (0)
619 #define symbol_put_addr(p) do { } while (0)
621 #endif /* CONFIG_MODULE_UNLOAD */
623 /* This is a #define so the string doesn't get put in every .o file */
624 #define module_name(mod) \
626 struct module *__mod = (mod); \
627 __mod ? __mod->name : "kernel"; \
630 /* Dereference module function descriptor */
631 void *dereference_module_function_descriptor(struct module *mod, void *ptr);
633 /* For kallsyms to ask for address resolution. namebuf should be at
634 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
635 * found, otherwise NULL. */
636 const char *module_address_lookup(unsigned long addr,
637 unsigned long *symbolsize,
638 unsigned long *offset,
641 int lookup_module_symbol_name(unsigned long addr, char *symname);
642 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
644 int register_module_notifier(struct notifier_block *nb);
645 int unregister_module_notifier(struct notifier_block *nb);
647 extern void print_modules(void);
649 static inline bool module_requested_async_probing(struct module *module)
651 return module && module->async_probe_requested;
654 #ifdef CONFIG_LIVEPATCH
655 static inline bool is_livepatch_module(struct module *mod)
659 #else /* !CONFIG_LIVEPATCH */
660 static inline bool is_livepatch_module(struct module *mod)
664 #endif /* CONFIG_LIVEPATCH */
666 bool is_module_sig_enforced(void);
667 void set_module_sig_enforced(void);
669 #else /* !CONFIG_MODULES... */
671 static inline struct module *__module_address(unsigned long addr)
676 static inline struct module *__module_text_address(unsigned long addr)
681 static inline bool is_module_address(unsigned long addr)
686 static inline bool is_module_percpu_address(unsigned long addr)
691 static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
696 static inline bool is_module_text_address(unsigned long addr)
701 static inline bool within_module_core(unsigned long addr,
702 const struct module *mod)
707 static inline bool within_module_init(unsigned long addr,
708 const struct module *mod)
713 static inline bool within_module(unsigned long addr, const struct module *mod)
718 /* Get/put a kernel symbol (calls should be symmetric) */
719 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak,visibility("hidden"))); &(x); })
720 #define symbol_put(x) do { } while (0)
721 #define symbol_put_addr(x) do { } while (0)
723 static inline void __module_get(struct module *module)
727 static inline bool try_module_get(struct module *module)
732 static inline void module_put(struct module *module)
736 #define module_name(mod) "kernel"
738 /* For kallsyms to ask for address resolution. NULL means not found. */
739 static inline const char *module_address_lookup(unsigned long addr,
740 unsigned long *symbolsize,
741 unsigned long *offset,
748 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
753 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
758 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
759 char *type, char *name,
760 char *module_name, int *exported)
765 static inline unsigned long module_kallsyms_lookup_name(const char *name)
770 static inline int register_module_notifier(struct notifier_block *nb)
772 /* no events will happen anyway, so this can always succeed */
776 static inline int unregister_module_notifier(struct notifier_block *nb)
781 #define module_put_and_exit(code) do_exit(code)
783 static inline void print_modules(void)
787 static inline bool module_requested_async_probing(struct module *module)
792 static inline bool is_module_sig_enforced(void)
797 static inline void set_module_sig_enforced(void)
801 /* Dereference module function descriptor */
803 void *dereference_module_function_descriptor(struct module *mod, void *ptr)
808 #endif /* CONFIG_MODULES */
811 extern struct kset *module_kset;
812 extern struct kobj_type module_ktype;
813 extern int module_sysfs_initialized;
814 #endif /* CONFIG_SYSFS */
816 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
818 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
820 #define __MODULE_STRING(x) __stringify(x)
822 #ifdef CONFIG_GENERIC_BUG
823 void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
825 void module_bug_cleanup(struct module *);
827 #else /* !CONFIG_GENERIC_BUG */
829 static inline void module_bug_finalize(const Elf_Ehdr *hdr,
830 const Elf_Shdr *sechdrs,
834 static inline void module_bug_cleanup(struct module *mod) {}
835 #endif /* CONFIG_GENERIC_BUG */
837 #ifdef CONFIG_RETPOLINE
838 extern bool retpoline_module_ok(bool has_retpoline);
840 static inline bool retpoline_module_ok(bool has_retpoline)
846 #ifdef CONFIG_MODULE_SIG
847 static inline bool module_sig_ok(struct module *module)
849 return module->sig_ok;
851 #else /* !CONFIG_MODULE_SIG */
852 static inline bool module_sig_ok(struct module *module)
856 #endif /* CONFIG_MODULE_SIG */
858 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
859 struct module *, unsigned long),
862 #endif /* _LINUX_MODULE_H */