1 #ifndef _LINUX_MODULE_H
2 #define _LINUX_MODULE_H
4 * Dynamic loading of modules into the kernel.
6 * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
7 * Rewritten again by Rusty Russell, 2002
9 #include <linux/list.h>
10 #include <linux/stat.h>
11 #include <linux/compiler.h>
12 #include <linux/cache.h>
13 #include <linux/kmod.h>
14 #include <linux/init.h>
15 #include <linux/elf.h>
16 #include <linux/stringify.h>
17 #include <linux/kobject.h>
18 #include <linux/moduleparam.h>
19 #include <linux/jump_label.h>
20 #include <linux/export.h>
21 #include <linux/rbtree_latch.h>
22 #include <linux/error-injection.h>
23 #include <linux/tracepoint-defs.h>
25 #include <linux/percpu.h>
26 #include <asm/module.h>
28 /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
29 #define MODULE_SIG_STRING "~Module signature appended~\n"
31 /* Not Yet Implemented */
32 #define MODULE_SUPPORTED_DEVICE(name)
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;
67 } __attribute__ ((__aligned__(sizeof(void *))));
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)
127 #define security_initcall(fn) module_init(fn)
129 /* Each module must use one module_init(). */
130 #define module_init(initfn) \
131 static inline initcall_t __maybe_unused __inittest(void) \
133 int init_module(void) __copy(initfn) __attribute__((alias(#initfn)));
135 /* This is only required if you want to be unloadable. */
136 #define module_exit(exitfn) \
137 static inline exitcall_t __maybe_unused __exittest(void) \
139 void cleanup_module(void) __copy(exitfn) __attribute__((alias(#exitfn)));
143 /* This means "can be init if no module support, otherwise module load
145 #ifdef CONFIG_MODULES
146 #define __init_or_module
147 #define __initdata_or_module
148 #define __initconst_or_module
149 #define __INIT_OR_MODULE .text
150 #define __INITDATA_OR_MODULE .data
151 #define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
153 #define __init_or_module __init
154 #define __initdata_or_module __initdata
155 #define __initconst_or_module __initconst
156 #define __INIT_OR_MODULE __INIT
157 #define __INITDATA_OR_MODULE __INITDATA
158 #define __INITRODATA_OR_MODULE __INITRODATA
159 #endif /*CONFIG_MODULES*/
161 /* Generic info of form tag = "info" */
162 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
164 /* For userspace: you can also call me... */
165 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
167 /* Soft module dependencies. See man modprobe.d for details.
168 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
170 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
173 * The following license idents are currently accepted as indicating free
176 * "GPL" [GNU Public License v2 or later]
177 * "GPL v2" [GNU Public License v2]
178 * "GPL and additional rights" [GNU Public License v2 rights and more]
179 * "Dual BSD/GPL" [GNU Public License v2
180 * or BSD license choice]
181 * "Dual MIT/GPL" [GNU Public License v2
182 * or MIT license choice]
183 * "Dual MPL/GPL" [GNU Public License v2
184 * or Mozilla license choice]
186 * The following other idents are available
188 * "Proprietary" [Non free products]
190 * There are dual licensed components, but when running with Linux it is the
191 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
192 * is a GPL combined work.
194 * This exists for several reasons
195 * 1. So modinfo can show license info for users wanting to vet their setup
197 * 2. So the community can ignore bug reports including proprietary modules
198 * 3. So vendors can do likewise based on their own policies
200 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
203 * Author(s), use "Name <email>" or just "Name", for multiple
204 * authors use multiple MODULE_AUTHOR() statements/lines.
206 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
208 /* What your module does. */
209 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
212 /* Creates an alias so file2alias.c can find device table. */
213 #define MODULE_DEVICE_TABLE(type, name) \
214 extern typeof(name) __mod_##type##__##name##_device_table \
215 __attribute__ ((unused, alias(__stringify(name))))
217 #define MODULE_DEVICE_TABLE(type, name)
220 /* Version of form [<epoch>:]<version>[-<extra-version>].
221 * Or for CVS/RCS ID version, everything but the number is stripped.
222 * <epoch>: A (small) unsigned integer which allows you to start versions
223 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
226 * <version>: The <version> may contain only alphanumerics and the
227 * character `.'. Ordered by numeric sort for numeric parts,
228 * ascii sort for ascii parts (as per RPM or DEB algorithm).
230 * <extraversion>: Like <version>, but inserted for local
231 * customizations, eg "rh3" or "rusty1".
233 * Using this automatically adds a checksum of the .c files and the
234 * local headers in "srcversion".
237 #if defined(MODULE) || !defined(CONFIG_SYSFS)
238 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
240 #define MODULE_VERSION(_version) \
241 static struct module_version_attribute ___modver_attr = { \
247 .show = __modver_version_show, \
249 .module_name = KBUILD_MODNAME, \
250 .version = _version, \
252 static const struct module_version_attribute \
253 __used __attribute__ ((__section__ ("__modver"))) \
254 * __moduleparam_const __modver_attr = &___modver_attr
257 /* Optional firmware file (or files) needed by the module
258 * format is simply firmware file name. Multiple firmware
259 * files require multiple MODULE_FIRMWARE() specifiers */
260 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
262 struct notifier_block;
264 #ifdef CONFIG_MODULES
266 extern int modules_disabled; /* for sysctl */
267 /* Get/put a kernel symbol (calls must be symmetric) */
268 void *__symbol_get(const char *symbol);
269 void *__symbol_get_gpl(const char *symbol);
270 #define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
272 /* modules using other modules: kdb wants to see this. */
274 struct list_head source_list;
275 struct list_head target_list;
276 struct module *source, *target;
280 MODULE_STATE_LIVE, /* Normal state. */
281 MODULE_STATE_COMING, /* Full formed, running module_init. */
282 MODULE_STATE_GOING, /* Going away. */
283 MODULE_STATE_UNFORMED, /* Still setting it up. */
286 struct mod_tree_node {
288 struct latch_tree_node node;
291 struct module_layout {
292 /* The actual code + data. */
296 /* The size of the executable code. */
297 unsigned int text_size;
298 /* Size of RO section of the module (text+rodata) */
299 unsigned int ro_size;
300 /* Size of RO after init section */
301 unsigned int ro_after_init_size;
303 #ifdef CONFIG_MODULES_TREE_LOOKUP
304 struct mod_tree_node mtn;
308 #ifdef CONFIG_MODULES_TREE_LOOKUP
309 /* Only touch one cacheline for common rbtree-for-core-layout case. */
310 #define __module_layout_align ____cacheline_aligned
312 #define __module_layout_align
315 struct mod_kallsyms {
317 unsigned int num_symtab;
321 #ifdef CONFIG_LIVEPATCH
331 enum module_state state;
333 /* Member of list of modules */
334 struct list_head list;
336 /* Unique handle for this module */
337 char name[MODULE_NAME_LEN];
340 struct module_kobject mkobj;
341 struct module_attribute *modinfo_attrs;
343 const char *srcversion;
344 struct kobject *holders_dir;
346 /* Exported symbols */
347 const struct kernel_symbol *syms;
349 unsigned int num_syms;
351 /* Kernel parameters. */
353 struct mutex param_lock;
355 struct kernel_param *kp;
358 /* GPL-only exported symbols. */
359 unsigned int num_gpl_syms;
360 const struct kernel_symbol *gpl_syms;
363 #ifdef CONFIG_UNUSED_SYMBOLS
364 /* unused exported symbols. */
365 const struct kernel_symbol *unused_syms;
366 const s32 *unused_crcs;
367 unsigned int num_unused_syms;
369 /* GPL-only, unused exported symbols. */
370 unsigned int num_unused_gpl_syms;
371 const struct kernel_symbol *unused_gpl_syms;
372 const s32 *unused_gpl_crcs;
375 #ifdef CONFIG_MODULE_SIG
376 /* Signature was verified. */
380 bool async_probe_requested;
382 /* symbols that will be GPL-only in the near future. */
383 const struct kernel_symbol *gpl_future_syms;
384 const s32 *gpl_future_crcs;
385 unsigned int num_gpl_future_syms;
387 /* Exception table */
388 unsigned int num_exentries;
389 struct exception_table_entry *extable;
391 /* Startup function. */
394 /* Core layout: rbtree is accessed frequently, so keep together. */
395 struct module_layout core_layout __module_layout_align;
396 struct module_layout init_layout;
398 /* Arch-specific module values */
399 struct mod_arch_specific arch;
401 unsigned long taints; /* same bits as kernel:taint_flags */
403 #ifdef CONFIG_GENERIC_BUG
404 /* Support for BUG */
406 struct list_head bug_list;
407 struct bug_entry *bug_table;
410 #ifdef CONFIG_KALLSYMS
411 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
412 struct mod_kallsyms *kallsyms;
413 struct mod_kallsyms core_kallsyms;
415 /* Section attributes */
416 struct module_sect_attrs *sect_attrs;
418 /* Notes attributes */
419 struct module_notes_attrs *notes_attrs;
422 /* The command line arguments (may be mangled). People like
423 keeping pointers to this stuff */
428 void __percpu *percpu;
429 unsigned int percpu_size;
432 #ifdef CONFIG_TRACEPOINTS
433 unsigned int num_tracepoints;
434 tracepoint_ptr_t *tracepoints_ptrs;
436 #ifdef CONFIG_JUMP_LABEL
437 struct jump_entry *jump_entries;
438 unsigned int num_jump_entries;
440 #ifdef CONFIG_TRACING
441 unsigned int num_trace_bprintk_fmt;
442 const char **trace_bprintk_fmt_start;
444 #ifdef CONFIG_EVENT_TRACING
445 struct trace_event_call **trace_events;
446 unsigned int num_trace_events;
447 struct trace_eval_map **trace_evals;
448 unsigned int num_trace_evals;
450 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
451 unsigned int num_ftrace_callsites;
452 unsigned long *ftrace_callsites;
455 #ifdef CONFIG_LIVEPATCH
456 bool klp; /* Is this a livepatch module? */
459 /* Elf information */
460 struct klp_modinfo *klp_info;
463 #ifdef CONFIG_MODULE_UNLOAD
464 /* What modules depend on me? */
465 struct list_head source_list;
466 /* What modules do I depend on? */
467 struct list_head target_list;
469 /* Destruction function. */
475 #ifdef CONFIG_CONSTRUCTORS
476 /* Constructor functions. */
478 unsigned int num_ctors;
481 #ifdef CONFIG_FUNCTION_ERROR_INJECTION
482 struct error_injection_entry *ei_funcs;
483 unsigned int num_ei_funcs;
485 } ____cacheline_aligned __randomize_layout;
486 #ifndef MODULE_ARCH_INIT
487 #define MODULE_ARCH_INIT {}
490 extern struct mutex module_mutex;
492 /* FIXME: It'd be nice to isolate modules during init, too, so they
493 aren't used before they (may) fail. But presently too much code
494 (IDE & SCSI) require entry into the module during init.*/
495 static inline bool module_is_live(struct module *mod)
497 return mod->state != MODULE_STATE_GOING;
500 struct module *__module_text_address(unsigned long addr);
501 struct module *__module_address(unsigned long addr);
502 bool is_module_address(unsigned long addr);
503 bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
504 bool is_module_percpu_address(unsigned long addr);
505 bool is_module_text_address(unsigned long addr);
507 static inline bool within_module_core(unsigned long addr,
508 const struct module *mod)
510 return (unsigned long)mod->core_layout.base <= addr &&
511 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
514 static inline bool within_module_init(unsigned long addr,
515 const struct module *mod)
517 return (unsigned long)mod->init_layout.base <= addr &&
518 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
521 static inline bool within_module(unsigned long addr, const struct module *mod)
523 return within_module_init(addr, mod) || within_module_core(addr, mod);
526 /* Search for module by name: must hold module_mutex. */
527 struct module *find_module(const char *name);
530 const struct kernel_symbol *start, *stop;
541 * Search for an exported symbol by name.
543 * Must be called with module_mutex held or preemption disabled.
545 const struct kernel_symbol *find_symbol(const char *name,
546 struct module **owner,
552 * Walk the exported symbol table
554 * Must be called with module_mutex held or preemption disabled.
556 bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
557 struct module *owner,
558 void *data), void *data);
560 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
561 symnum out of range. */
562 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
563 char *name, char *module_name, int *exported);
565 /* Look for this name: can be of form module:name. */
566 unsigned long module_kallsyms_lookup_name(const char *name);
568 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
569 struct module *, unsigned long),
572 extern void __noreturn __module_put_and_exit(struct module *mod,
574 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
576 #ifdef CONFIG_MODULE_UNLOAD
577 int module_refcount(struct module *mod);
578 void __symbol_put(const char *symbol);
579 #define symbol_put(x) __symbol_put(__stringify(x))
580 void symbol_put_addr(void *addr);
582 /* Sometimes we know we already have a refcount, and it's easier not
583 to handle the error case (which only happens with rmmod --wait). */
584 extern void __module_get(struct module *module);
586 /* This is the Right Way to get a module: if it fails, it's being removed,
587 * so pretend it's not there. */
588 extern bool try_module_get(struct module *module);
590 extern void module_put(struct module *module);
592 #else /*!CONFIG_MODULE_UNLOAD*/
593 static inline bool try_module_get(struct module *module)
595 return !module || module_is_live(module);
597 static inline void module_put(struct module *module)
600 static inline void __module_get(struct module *module)
603 #define symbol_put(x) do { } while (0)
604 #define symbol_put_addr(p) do { } while (0)
606 #endif /* CONFIG_MODULE_UNLOAD */
607 int ref_module(struct module *a, struct module *b);
609 /* This is a #define so the string doesn't get put in every .o file */
610 #define module_name(mod) \
612 struct module *__mod = (mod); \
613 __mod ? __mod->name : "kernel"; \
616 /* Dereference module function descriptor */
617 void *dereference_module_function_descriptor(struct module *mod, void *ptr);
619 /* For kallsyms to ask for address resolution. namebuf should be at
620 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
621 * found, otherwise NULL. */
622 const char *module_address_lookup(unsigned long addr,
623 unsigned long *symbolsize,
624 unsigned long *offset,
627 int lookup_module_symbol_name(unsigned long addr, char *symname);
628 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
630 int register_module_notifier(struct notifier_block *nb);
631 int unregister_module_notifier(struct notifier_block *nb);
633 extern void print_modules(void);
635 static inline bool module_requested_async_probing(struct module *module)
637 return module && module->async_probe_requested;
640 #ifdef CONFIG_LIVEPATCH
641 static inline bool is_livepatch_module(struct module *mod)
645 #else /* !CONFIG_LIVEPATCH */
646 static inline bool is_livepatch_module(struct module *mod)
650 #endif /* CONFIG_LIVEPATCH */
652 bool is_module_sig_enforced(void);
654 #else /* !CONFIG_MODULES... */
656 static inline struct module *__module_address(unsigned long addr)
661 static inline struct module *__module_text_address(unsigned long addr)
666 static inline bool is_module_address(unsigned long addr)
671 static inline bool is_module_percpu_address(unsigned long addr)
676 static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
681 static inline bool is_module_text_address(unsigned long addr)
686 /* Get/put a kernel symbol (calls should be symmetric) */
687 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
688 #define symbol_put(x) do { } while (0)
689 #define symbol_put_addr(x) do { } while (0)
691 static inline void __module_get(struct module *module)
695 static inline bool try_module_get(struct module *module)
700 static inline void module_put(struct module *module)
704 #define module_name(mod) "kernel"
706 /* For kallsyms to ask for address resolution. NULL means not found. */
707 static inline const char *module_address_lookup(unsigned long addr,
708 unsigned long *symbolsize,
709 unsigned long *offset,
716 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
721 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
726 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
727 char *type, char *name,
728 char *module_name, int *exported)
733 static inline unsigned long module_kallsyms_lookup_name(const char *name)
738 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
746 static inline int register_module_notifier(struct notifier_block *nb)
748 /* no events will happen anyway, so this can always succeed */
752 static inline int unregister_module_notifier(struct notifier_block *nb)
757 #define module_put_and_exit(code) do_exit(code)
759 static inline void print_modules(void)
763 static inline bool module_requested_async_probing(struct module *module)
768 static inline bool is_module_sig_enforced(void)
773 /* Dereference module function descriptor */
775 void *dereference_module_function_descriptor(struct module *mod, void *ptr)
780 #endif /* CONFIG_MODULES */
783 extern struct kset *module_kset;
784 extern struct kobj_type module_ktype;
785 extern int module_sysfs_initialized;
786 #endif /* CONFIG_SYSFS */
788 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
790 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
792 #define __MODULE_STRING(x) __stringify(x)
794 #ifdef CONFIG_STRICT_MODULE_RWX
795 extern void set_all_modules_text_rw(void);
796 extern void set_all_modules_text_ro(void);
797 extern void module_enable_ro(const struct module *mod, bool after_init);
798 extern void module_disable_ro(const struct module *mod);
800 static inline void set_all_modules_text_rw(void) { }
801 static inline void set_all_modules_text_ro(void) { }
802 static inline void module_enable_ro(const struct module *mod, bool after_init) { }
803 static inline void module_disable_ro(const struct module *mod) { }
806 #ifdef CONFIG_GENERIC_BUG
807 void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
809 void module_bug_cleanup(struct module *);
811 #else /* !CONFIG_GENERIC_BUG */
813 static inline void module_bug_finalize(const Elf_Ehdr *hdr,
814 const Elf_Shdr *sechdrs,
818 static inline void module_bug_cleanup(struct module *mod) {}
819 #endif /* CONFIG_GENERIC_BUG */
821 #ifdef CONFIG_RETPOLINE
822 extern bool retpoline_module_ok(bool has_retpoline);
824 static inline bool retpoline_module_ok(bool has_retpoline)
830 #ifdef CONFIG_MODULE_SIG
831 static inline bool module_sig_ok(struct module *module)
833 return module->sig_ok;
835 #else /* !CONFIG_MODULE_SIG */
836 static inline bool module_sig_ok(struct module *module)
840 #endif /* CONFIG_MODULE_SIG */
842 #endif /* _LINUX_MODULE_H */