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>
30 #include <linux/percpu.h>
31 #include <asm/module.h>
33 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
35 struct modversion_info {
37 char name[MODULE_NAME_LEN];
41 struct exception_table_entry;
43 struct module_kobject {
46 struct kobject *drivers_dir;
47 struct module_param_attrs *mp;
48 struct completion *kobj_completion;
51 struct module_attribute {
52 struct attribute attr;
53 ssize_t (*show)(struct module_attribute *, struct module_kobject *,
55 ssize_t (*store)(struct module_attribute *, struct module_kobject *,
56 const char *, size_t count);
57 void (*setup)(struct module *, const char *);
58 int (*test)(struct module *);
59 void (*free)(struct module *);
62 struct module_version_attribute {
63 struct module_attribute mattr;
64 const char *module_name;
68 extern ssize_t __modver_version_show(struct module_attribute *,
69 struct module_kobject *, char *);
71 extern struct module_attribute module_uevent;
73 /* These are either module local, or the kernel's dummy ones. */
74 extern int init_module(void);
75 extern void cleanup_module(void);
79 * module_init() - driver initialization entry point
80 * @x: function to be run at kernel boot time or module insertion
82 * module_init() will either be called during do_initcalls() (if
83 * builtin) or at module insertion time (if a module). There can only
86 #define module_init(x) __initcall(x);
89 * module_exit() - driver exit entry point
90 * @x: function to be run when driver is removed
92 * module_exit() will wrap the driver clean-up code
93 * with cleanup_module() when used with rmmod when
94 * the driver is a module. If the driver is statically
95 * compiled into the kernel, module_exit() has no effect.
96 * There can only be one per module.
98 #define module_exit(x) __exitcall(x);
103 * In most cases loadable modules do not need custom
104 * initcall levels. There are still some valid cases where
105 * a driver may be needed early if built in, and does not
106 * matter when built as a loadable module. Like bus
107 * snooping debug drivers.
109 #define early_initcall(fn) module_init(fn)
110 #define core_initcall(fn) module_init(fn)
111 #define core_initcall_sync(fn) module_init(fn)
112 #define postcore_initcall(fn) module_init(fn)
113 #define postcore_initcall_sync(fn) module_init(fn)
114 #define arch_initcall(fn) module_init(fn)
115 #define subsys_initcall(fn) module_init(fn)
116 #define subsys_initcall_sync(fn) module_init(fn)
117 #define fs_initcall(fn) module_init(fn)
118 #define fs_initcall_sync(fn) module_init(fn)
119 #define rootfs_initcall(fn) module_init(fn)
120 #define device_initcall(fn) module_init(fn)
121 #define device_initcall_sync(fn) module_init(fn)
122 #define late_initcall(fn) module_init(fn)
123 #define late_initcall_sync(fn) module_init(fn)
125 #define console_initcall(fn) module_init(fn)
127 /* Each module must use one module_init(). */
128 #define module_init(initfn) \
129 static inline initcall_t __maybe_unused __inittest(void) \
131 int init_module(void) __copy(initfn) __attribute__((alias(#initfn)));
133 /* This is only required if you want to be unloadable. */
134 #define module_exit(exitfn) \
135 static inline exitcall_t __maybe_unused __exittest(void) \
137 void cleanup_module(void) __copy(exitfn) __attribute__((alias(#exitfn)));
141 /* This means "can be init if no module support, otherwise module load
143 #ifdef CONFIG_MODULES
144 #define __init_or_module
145 #define __initdata_or_module
146 #define __initconst_or_module
147 #define __INIT_OR_MODULE .text
148 #define __INITDATA_OR_MODULE .data
149 #define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
151 #define __init_or_module __init
152 #define __initdata_or_module __initdata
153 #define __initconst_or_module __initconst
154 #define __INIT_OR_MODULE __INIT
155 #define __INITDATA_OR_MODULE __INITDATA
156 #define __INITRODATA_OR_MODULE __INITRODATA
157 #endif /*CONFIG_MODULES*/
159 /* Generic info of form tag = "info" */
160 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
162 /* For userspace: you can also call me... */
163 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
165 /* Soft module dependencies. See man modprobe.d for details.
166 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
168 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
171 * MODULE_FILE is used for generating modules.builtin
172 * So, make it no-op when this is being built as a module
177 #define MODULE_FILE MODULE_INFO(file, KBUILD_MODFILE);
181 * The following license idents are currently accepted as indicating free
184 * "GPL" [GNU Public License v2]
185 * "GPL v2" [GNU Public License v2]
186 * "GPL and additional rights" [GNU Public License v2 rights and more]
187 * "Dual BSD/GPL" [GNU Public License v2
188 * or BSD license choice]
189 * "Dual MIT/GPL" [GNU Public License v2
190 * or MIT license choice]
191 * "Dual MPL/GPL" [GNU Public License v2
192 * or Mozilla license choice]
194 * The following other idents are available
196 * "Proprietary" [Non free products]
198 * Both "GPL v2" and "GPL" (the latter also in dual licensed strings) are
199 * merely stating that the module is licensed under the GPL v2, but are not
200 * telling whether "GPL v2 only" or "GPL v2 or later". The reason why there
201 * are two variants is a historic and failed attempt to convey more
202 * information in the MODULE_LICENSE string. For module loading the
203 * "only/or later" distinction is completely irrelevant and does neither
204 * replace the proper license identifiers in the corresponding source file
205 * nor amends them in any way. The sole purpose is to make the
206 * 'Proprietary' flagging work and to refuse to bind symbols which are
207 * exported with EXPORT_SYMBOL_GPL when a non free module is loaded.
209 * In the same way "BSD" is not a clear license information. It merely
210 * states, that the module is licensed under one of the compatible BSD
211 * license variants. The detailed and correct license information is again
212 * to be found in the corresponding source files.
214 * There are dual licensed components, but when running with Linux it is the
215 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
216 * is a GPL combined work.
218 * This exists for several reasons
219 * 1. So modinfo can show license info for users wanting to vet their setup
221 * 2. So the community can ignore bug reports including proprietary modules
222 * 3. So vendors can do likewise based on their own policies
224 #define MODULE_LICENSE(_license) MODULE_FILE MODULE_INFO(license, _license)
227 * Author(s), use "Name <email>" or just "Name", for multiple
228 * authors use multiple MODULE_AUTHOR() statements/lines.
230 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
232 /* What your module does. */
233 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
236 /* Creates an alias so file2alias.c can find device table. */
237 #define MODULE_DEVICE_TABLE(type, name) \
238 extern typeof(name) __mod_##type##__##name##_device_table \
239 __attribute__ ((unused, alias(__stringify(name))))
241 #define MODULE_DEVICE_TABLE(type, name)
244 /* Version of form [<epoch>:]<version>[-<extra-version>].
245 * Or for CVS/RCS ID version, everything but the number is stripped.
246 * <epoch>: A (small) unsigned integer which allows you to start versions
247 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
250 * <version>: The <version> may contain only alphanumerics and the
251 * character `.'. Ordered by numeric sort for numeric parts,
252 * ascii sort for ascii parts (as per RPM or DEB algorithm).
254 * <extraversion>: Like <version>, but inserted for local
255 * customizations, eg "rh3" or "rusty1".
257 * Using this automatically adds a checksum of the .c files and the
258 * local headers in "srcversion".
261 #if defined(MODULE) || !defined(CONFIG_SYSFS)
262 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
264 #define MODULE_VERSION(_version) \
265 MODULE_INFO(version, _version); \
266 static struct module_version_attribute __modver_attr \
267 __used __section("__modver") \
268 __aligned(__alignof__(struct module_version_attribute)) \
275 .show = __modver_version_show, \
277 .module_name = KBUILD_MODNAME, \
278 .version = _version, \
282 /* Optional firmware file (or files) needed by the module
283 * format is simply firmware file name. Multiple firmware
284 * files require multiple MODULE_FIRMWARE() specifiers */
285 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
287 #define MODULE_IMPORT_NS(ns) MODULE_INFO(import_ns, #ns)
289 struct notifier_block;
291 #ifdef CONFIG_MODULES
293 extern int modules_disabled; /* for sysctl */
294 /* Get/put a kernel symbol (calls must be symmetric) */
295 void *__symbol_get(const char *symbol);
296 void *__symbol_get_gpl(const char *symbol);
297 #define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
299 /* modules using other modules: kdb wants to see this. */
301 struct list_head source_list;
302 struct list_head target_list;
303 struct module *source, *target;
307 MODULE_STATE_LIVE, /* Normal state. */
308 MODULE_STATE_COMING, /* Full formed, running module_init. */
309 MODULE_STATE_GOING, /* Going away. */
310 MODULE_STATE_UNFORMED, /* Still setting it up. */
313 struct mod_tree_node {
315 struct latch_tree_node node;
318 struct module_layout {
319 /* The actual code + data. */
323 /* The size of the executable code. */
324 unsigned int text_size;
325 /* Size of RO section of the module (text+rodata) */
326 unsigned int ro_size;
327 /* Size of RO after init section */
328 unsigned int ro_after_init_size;
330 #ifdef CONFIG_MODULES_TREE_LOOKUP
331 struct mod_tree_node mtn;
335 #ifdef CONFIG_MODULES_TREE_LOOKUP
336 /* Only touch one cacheline for common rbtree-for-core-layout case. */
337 #define __module_layout_align ____cacheline_aligned
339 #define __module_layout_align
342 struct mod_kallsyms {
344 unsigned int num_symtab;
349 #ifdef CONFIG_LIVEPATCH
359 enum module_state state;
361 /* Member of list of modules */
362 struct list_head list;
364 /* Unique handle for this module */
365 char name[MODULE_NAME_LEN];
368 struct module_kobject mkobj;
369 struct module_attribute *modinfo_attrs;
371 const char *srcversion;
372 struct kobject *holders_dir;
374 /* Exported symbols */
375 const struct kernel_symbol *syms;
377 unsigned int num_syms;
379 /* Kernel parameters. */
381 struct mutex param_lock;
383 struct kernel_param *kp;
386 /* GPL-only exported symbols. */
387 unsigned int num_gpl_syms;
388 const struct kernel_symbol *gpl_syms;
390 bool using_gplonly_symbols;
392 #ifdef CONFIG_MODULE_SIG
393 /* Signature was verified. */
397 bool async_probe_requested;
399 /* Exception table */
400 unsigned int num_exentries;
401 struct exception_table_entry *extable;
403 /* Startup function. */
406 /* Core layout: rbtree is accessed frequently, so keep together. */
407 struct module_layout core_layout __module_layout_align;
408 struct module_layout init_layout;
410 /* Arch-specific module values */
411 struct mod_arch_specific arch;
413 unsigned long taints; /* same bits as kernel:taint_flags */
415 #ifdef CONFIG_GENERIC_BUG
416 /* Support for BUG */
418 struct list_head bug_list;
419 struct bug_entry *bug_table;
422 #ifdef CONFIG_KALLSYMS
423 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
424 struct mod_kallsyms __rcu *kallsyms;
425 struct mod_kallsyms core_kallsyms;
427 /* Section attributes */
428 struct module_sect_attrs *sect_attrs;
430 /* Notes attributes */
431 struct module_notes_attrs *notes_attrs;
434 /* The command line arguments (may be mangled). People like
435 keeping pointers to this stuff */
440 void __percpu *percpu;
441 unsigned int percpu_size;
443 void *noinstr_text_start;
444 unsigned int noinstr_text_size;
446 #ifdef CONFIG_TRACEPOINTS
447 unsigned int num_tracepoints;
448 tracepoint_ptr_t *tracepoints_ptrs;
450 #ifdef CONFIG_TREE_SRCU
451 unsigned int num_srcu_structs;
452 struct srcu_struct **srcu_struct_ptrs;
454 #ifdef CONFIG_BPF_EVENTS
455 unsigned int num_bpf_raw_events;
456 struct bpf_raw_event_map *bpf_raw_events;
458 #ifdef CONFIG_DEBUG_INFO_BTF_MODULES
459 unsigned int btf_data_size;
462 #ifdef CONFIG_JUMP_LABEL
463 struct jump_entry *jump_entries;
464 unsigned int num_jump_entries;
466 #ifdef CONFIG_TRACING
467 unsigned int num_trace_bprintk_fmt;
468 const char **trace_bprintk_fmt_start;
470 #ifdef CONFIG_EVENT_TRACING
471 struct trace_event_call **trace_events;
472 unsigned int num_trace_events;
473 struct trace_eval_map **trace_evals;
474 unsigned int num_trace_evals;
476 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
477 unsigned int num_ftrace_callsites;
478 unsigned long *ftrace_callsites;
480 #ifdef CONFIG_KPROBES
481 void *kprobes_text_start;
482 unsigned int kprobes_text_size;
483 unsigned long *kprobe_blacklist;
484 unsigned int num_kprobe_blacklist;
486 #ifdef CONFIG_HAVE_STATIC_CALL_INLINE
487 int num_static_call_sites;
488 struct static_call_site *static_call_sites;
491 #ifdef CONFIG_LIVEPATCH
492 bool klp; /* Is this a livepatch module? */
495 /* Elf information */
496 struct klp_modinfo *klp_info;
499 #ifdef CONFIG_MODULE_UNLOAD
500 /* What modules depend on me? */
501 struct list_head source_list;
502 /* What modules do I depend on? */
503 struct list_head target_list;
505 /* Destruction function. */
511 #ifdef CONFIG_CONSTRUCTORS
512 /* Constructor functions. */
514 unsigned int num_ctors;
517 #ifdef CONFIG_FUNCTION_ERROR_INJECTION
518 struct error_injection_entry *ei_funcs;
519 unsigned int num_ei_funcs;
521 } ____cacheline_aligned __randomize_layout;
522 #ifndef MODULE_ARCH_INIT
523 #define MODULE_ARCH_INIT {}
526 #ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
527 static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
529 return sym->st_value;
533 /* FIXME: It'd be nice to isolate modules during init, too, so they
534 aren't used before they (may) fail. But presently too much code
535 (IDE & SCSI) require entry into the module during init.*/
536 static inline bool module_is_live(struct module *mod)
538 return mod->state != MODULE_STATE_GOING;
541 struct module *__module_text_address(unsigned long addr);
542 struct module *__module_address(unsigned long addr);
543 bool is_module_address(unsigned long addr);
544 bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
545 bool is_module_percpu_address(unsigned long addr);
546 bool is_module_text_address(unsigned long addr);
548 static inline bool within_module_core(unsigned long addr,
549 const struct module *mod)
551 return (unsigned long)mod->core_layout.base <= addr &&
552 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
555 static inline bool within_module_init(unsigned long addr,
556 const struct module *mod)
558 return (unsigned long)mod->init_layout.base <= addr &&
559 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
562 static inline bool within_module(unsigned long addr, const struct module *mod)
564 return within_module_init(addr, mod) || within_module_core(addr, mod);
567 /* Search for module by name: must be in a RCU-sched critical section. */
568 struct module *find_module(const char *name);
570 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
571 symnum out of range. */
572 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
573 char *name, char *module_name, int *exported);
575 /* Look for this name: can be of form module:name. */
576 unsigned long module_kallsyms_lookup_name(const char *name);
578 extern void __noreturn __module_put_and_exit(struct module *mod,
580 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
582 #ifdef CONFIG_MODULE_UNLOAD
583 int module_refcount(struct module *mod);
584 void __symbol_put(const char *symbol);
585 #define symbol_put(x) __symbol_put(__stringify(x))
586 void symbol_put_addr(void *addr);
588 /* Sometimes we know we already have a refcount, and it's easier not
589 to handle the error case (which only happens with rmmod --wait). */
590 extern void __module_get(struct module *module);
592 /* This is the Right Way to get a module: if it fails, it's being removed,
593 * so pretend it's not there. */
594 extern bool try_module_get(struct module *module);
596 extern void module_put(struct module *module);
598 #else /*!CONFIG_MODULE_UNLOAD*/
599 static inline bool try_module_get(struct module *module)
601 return !module || module_is_live(module);
603 static inline void module_put(struct module *module)
606 static inline void __module_get(struct module *module)
609 #define symbol_put(x) do { } while (0)
610 #define symbol_put_addr(p) do { } while (0)
612 #endif /* CONFIG_MODULE_UNLOAD */
614 /* This is a #define so the string doesn't get put in every .o file */
615 #define module_name(mod) \
617 struct module *__mod = (mod); \
618 __mod ? __mod->name : "kernel"; \
621 /* Dereference module function descriptor */
622 void *dereference_module_function_descriptor(struct module *mod, void *ptr);
624 /* For kallsyms to ask for address resolution. namebuf should be at
625 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
626 * found, otherwise NULL. */
627 const char *module_address_lookup(unsigned long addr,
628 unsigned long *symbolsize,
629 unsigned long *offset,
632 int lookup_module_symbol_name(unsigned long addr, char *symname);
633 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
635 int register_module_notifier(struct notifier_block *nb);
636 int unregister_module_notifier(struct notifier_block *nb);
638 extern void print_modules(void);
640 static inline bool module_requested_async_probing(struct module *module)
642 return module && module->async_probe_requested;
645 #ifdef CONFIG_LIVEPATCH
646 static inline bool is_livepatch_module(struct module *mod)
650 #else /* !CONFIG_LIVEPATCH */
651 static inline bool is_livepatch_module(struct module *mod)
655 #endif /* CONFIG_LIVEPATCH */
657 bool is_module_sig_enforced(void);
658 void set_module_sig_enforced(void);
660 #else /* !CONFIG_MODULES... */
662 static inline struct module *__module_address(unsigned long addr)
667 static inline struct module *__module_text_address(unsigned long addr)
672 static inline bool is_module_address(unsigned long addr)
677 static inline bool is_module_percpu_address(unsigned long addr)
682 static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
687 static inline bool is_module_text_address(unsigned long addr)
692 static inline bool within_module_core(unsigned long addr,
693 const struct module *mod)
698 static inline bool within_module_init(unsigned long addr,
699 const struct module *mod)
704 static inline bool within_module(unsigned long addr, const struct module *mod)
709 /* Get/put a kernel symbol (calls should be symmetric) */
710 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak,visibility("hidden"))); &(x); })
711 #define symbol_put(x) do { } while (0)
712 #define symbol_put_addr(x) do { } while (0)
714 static inline void __module_get(struct module *module)
718 static inline bool try_module_get(struct module *module)
723 static inline void module_put(struct module *module)
727 #define module_name(mod) "kernel"
729 /* For kallsyms to ask for address resolution. NULL means not found. */
730 static inline const char *module_address_lookup(unsigned long addr,
731 unsigned long *symbolsize,
732 unsigned long *offset,
739 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
744 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
749 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
750 char *type, char *name,
751 char *module_name, int *exported)
756 static inline unsigned long module_kallsyms_lookup_name(const char *name)
761 static inline int register_module_notifier(struct notifier_block *nb)
763 /* no events will happen anyway, so this can always succeed */
767 static inline int unregister_module_notifier(struct notifier_block *nb)
772 #define module_put_and_exit(code) do_exit(code)
774 static inline void print_modules(void)
778 static inline bool module_requested_async_probing(struct module *module)
783 static inline bool is_module_sig_enforced(void)
788 static inline void set_module_sig_enforced(void)
792 /* Dereference module function descriptor */
794 void *dereference_module_function_descriptor(struct module *mod, void *ptr)
799 #endif /* CONFIG_MODULES */
802 extern struct kset *module_kset;
803 extern struct kobj_type module_ktype;
804 extern int module_sysfs_initialized;
805 #endif /* CONFIG_SYSFS */
807 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
809 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
811 #define __MODULE_STRING(x) __stringify(x)
813 #ifdef CONFIG_GENERIC_BUG
814 void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
816 void module_bug_cleanup(struct module *);
818 #else /* !CONFIG_GENERIC_BUG */
820 static inline void module_bug_finalize(const Elf_Ehdr *hdr,
821 const Elf_Shdr *sechdrs,
825 static inline void module_bug_cleanup(struct module *mod) {}
826 #endif /* CONFIG_GENERIC_BUG */
828 #ifdef CONFIG_RETPOLINE
829 extern bool retpoline_module_ok(bool has_retpoline);
831 static inline bool retpoline_module_ok(bool has_retpoline)
837 #ifdef CONFIG_MODULE_SIG
838 static inline bool module_sig_ok(struct module *module)
840 return module->sig_ok;
842 #else /* !CONFIG_MODULE_SIG */
843 static inline bool module_sig_ok(struct module *module)
847 #endif /* CONFIG_MODULE_SIG */
849 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
850 struct module *, unsigned long),
853 #endif /* _LINUX_MODULE_H */