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>
24 #include <linux/percpu.h>
25 #include <asm/module.h>
27 /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
28 #define MODULE_SIG_STRING "~Module signature appended~\n"
30 /* Not Yet Implemented */
31 #define MODULE_SUPPORTED_DEVICE(name)
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;
66 } __attribute__ ((__aligned__(sizeof(void *))));
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)
126 #define security_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) __attribute__((alias(#initfn)));
134 /* This is only required if you want to be unloadable. */
135 #define module_exit(exitfn) \
136 static inline exitcall_t __maybe_unused __exittest(void) \
138 void cleanup_module(void) __attribute__((alias(#exitfn)));
142 /* This means "can be init if no module support, otherwise module load
144 #ifdef CONFIG_MODULES
145 #define __init_or_module
146 #define __initdata_or_module
147 #define __initconst_or_module
148 #define __INIT_OR_MODULE .text
149 #define __INITDATA_OR_MODULE .data
150 #define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
152 #define __init_or_module __init
153 #define __initdata_or_module __initdata
154 #define __initconst_or_module __initconst
155 #define __INIT_OR_MODULE __INIT
156 #define __INITDATA_OR_MODULE __INITDATA
157 #define __INITRODATA_OR_MODULE __INITRODATA
158 #endif /*CONFIG_MODULES*/
160 /* Generic info of form tag = "info" */
161 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
163 /* For userspace: you can also call me... */
164 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
166 /* Soft module dependencies. See man modprobe.d for details.
167 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
169 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
172 * The following license idents are currently accepted as indicating free
175 * "GPL" [GNU Public License v2 or later]
176 * "GPL v2" [GNU Public License v2]
177 * "GPL and additional rights" [GNU Public License v2 rights and more]
178 * "Dual BSD/GPL" [GNU Public License v2
179 * or BSD license choice]
180 * "Dual MIT/GPL" [GNU Public License v2
181 * or MIT license choice]
182 * "Dual MPL/GPL" [GNU Public License v2
183 * or Mozilla license choice]
185 * The following other idents are available
187 * "Proprietary" [Non free products]
189 * There are dual licensed components, but when running with Linux it is the
190 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
191 * is a GPL combined work.
193 * This exists for several reasons
194 * 1. So modinfo can show license info for users wanting to vet their setup
196 * 2. So the community can ignore bug reports including proprietary modules
197 * 3. So vendors can do likewise based on their own policies
199 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
202 * Author(s), use "Name <email>" or just "Name", for multiple
203 * authors use multiple MODULE_AUTHOR() statements/lines.
205 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
207 /* What your module does. */
208 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
211 /* Creates an alias so file2alias.c can find device table. */
212 #define MODULE_DEVICE_TABLE(type, name) \
213 extern typeof(name) __mod_##type##__##name##_device_table \
214 __attribute__ ((unused, alias(__stringify(name))))
216 #define MODULE_DEVICE_TABLE(type, name)
219 /* Version of form [<epoch>:]<version>[-<extra-version>].
220 * Or for CVS/RCS ID version, everything but the number is stripped.
221 * <epoch>: A (small) unsigned integer which allows you to start versions
222 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
225 * <version>: The <version> may contain only alphanumerics and the
226 * character `.'. Ordered by numeric sort for numeric parts,
227 * ascii sort for ascii parts (as per RPM or DEB algorithm).
229 * <extraversion>: Like <version>, but inserted for local
230 * customizations, eg "rh3" or "rusty1".
232 * Using this automatically adds a checksum of the .c files and the
233 * local headers in "srcversion".
236 #if defined(MODULE) || !defined(CONFIG_SYSFS)
237 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
239 #define MODULE_VERSION(_version) \
240 static struct module_version_attribute ___modver_attr = { \
246 .show = __modver_version_show, \
248 .module_name = KBUILD_MODNAME, \
249 .version = _version, \
251 static const struct module_version_attribute \
252 __used __attribute__ ((__section__ ("__modver"))) \
253 * __moduleparam_const __modver_attr = &___modver_attr
256 /* Optional firmware file (or files) needed by the module
257 * format is simply firmware file name. Multiple firmware
258 * files require multiple MODULE_FIRMWARE() specifiers */
259 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
261 struct notifier_block;
263 #ifdef CONFIG_MODULES
265 extern int modules_disabled; /* for sysctl */
266 /* Get/put a kernel symbol (calls must be symmetric) */
267 void *__symbol_get(const char *symbol);
268 void *__symbol_get_gpl(const char *symbol);
269 #define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
271 /* modules using other modules: kdb wants to see this. */
273 struct list_head source_list;
274 struct list_head target_list;
275 struct module *source, *target;
279 MODULE_STATE_LIVE, /* Normal state. */
280 MODULE_STATE_COMING, /* Full formed, running module_init. */
281 MODULE_STATE_GOING, /* Going away. */
282 MODULE_STATE_UNFORMED, /* Still setting it up. */
285 struct mod_tree_node {
287 struct latch_tree_node node;
290 struct module_layout {
291 /* The actual code + data. */
295 /* The size of the executable code. */
296 unsigned int text_size;
297 /* Size of RO section of the module (text+rodata) */
298 unsigned int ro_size;
299 /* Size of RO after init section */
300 unsigned int ro_after_init_size;
302 #ifdef CONFIG_MODULES_TREE_LOOKUP
303 struct mod_tree_node mtn;
307 #ifdef CONFIG_MODULES_TREE_LOOKUP
308 /* Only touch one cacheline for common rbtree-for-core-layout case. */
309 #define __module_layout_align ____cacheline_aligned
311 #define __module_layout_align
314 struct mod_kallsyms {
316 unsigned int num_symtab;
320 #ifdef CONFIG_LIVEPATCH
330 enum module_state state;
332 /* Member of list of modules */
333 struct list_head list;
335 /* Unique handle for this module */
336 char name[MODULE_NAME_LEN];
339 struct module_kobject mkobj;
340 struct module_attribute *modinfo_attrs;
342 const char *srcversion;
343 struct kobject *holders_dir;
345 /* Exported symbols */
346 const struct kernel_symbol *syms;
348 unsigned int num_syms;
350 /* Kernel parameters. */
352 struct mutex param_lock;
354 struct kernel_param *kp;
357 /* GPL-only exported symbols. */
358 unsigned int num_gpl_syms;
359 const struct kernel_symbol *gpl_syms;
362 #ifdef CONFIG_UNUSED_SYMBOLS
363 /* unused exported symbols. */
364 const struct kernel_symbol *unused_syms;
365 const s32 *unused_crcs;
366 unsigned int num_unused_syms;
368 /* GPL-only, unused exported symbols. */
369 unsigned int num_unused_gpl_syms;
370 const struct kernel_symbol *unused_gpl_syms;
371 const s32 *unused_gpl_crcs;
374 #ifdef CONFIG_MODULE_SIG
375 /* Signature was verified. */
379 bool async_probe_requested;
381 /* symbols that will be GPL-only in the near future. */
382 const struct kernel_symbol *gpl_future_syms;
383 const s32 *gpl_future_crcs;
384 unsigned int num_gpl_future_syms;
386 /* Exception table */
387 unsigned int num_exentries;
388 struct exception_table_entry *extable;
390 /* Startup function. */
393 /* Core layout: rbtree is accessed frequently, so keep together. */
394 struct module_layout core_layout __module_layout_align;
395 struct module_layout init_layout;
397 /* Arch-specific module values */
398 struct mod_arch_specific arch;
400 unsigned long taints; /* same bits as kernel:taint_flags */
402 #ifdef CONFIG_GENERIC_BUG
403 /* Support for BUG */
405 struct list_head bug_list;
406 struct bug_entry *bug_table;
409 #ifdef CONFIG_KALLSYMS
410 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
411 struct mod_kallsyms *kallsyms;
412 struct mod_kallsyms core_kallsyms;
414 /* Section attributes */
415 struct module_sect_attrs *sect_attrs;
417 /* Notes attributes */
418 struct module_notes_attrs *notes_attrs;
421 /* The command line arguments (may be mangled). People like
422 keeping pointers to this stuff */
427 void __percpu *percpu;
428 unsigned int percpu_size;
431 #ifdef CONFIG_TRACEPOINTS
432 unsigned int num_tracepoints;
433 struct tracepoint * const *tracepoints_ptrs;
435 #ifdef HAVE_JUMP_LABEL
436 struct jump_entry *jump_entries;
437 unsigned int num_jump_entries;
439 #ifdef CONFIG_TRACING
440 unsigned int num_trace_bprintk_fmt;
441 const char **trace_bprintk_fmt_start;
443 #ifdef CONFIG_EVENT_TRACING
444 struct trace_event_call **trace_events;
445 unsigned int num_trace_events;
446 struct trace_eval_map **trace_evals;
447 unsigned int num_trace_evals;
449 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
450 unsigned int num_ftrace_callsites;
451 unsigned long *ftrace_callsites;
454 #ifdef CONFIG_LIVEPATCH
455 bool klp; /* Is this a livepatch module? */
458 /* Elf information */
459 struct klp_modinfo *klp_info;
462 #ifdef CONFIG_MODULE_UNLOAD
463 /* What modules depend on me? */
464 struct list_head source_list;
465 /* What modules do I depend on? */
466 struct list_head target_list;
468 /* Destruction function. */
474 #ifdef CONFIG_CONSTRUCTORS
475 /* Constructor functions. */
477 unsigned int num_ctors;
480 #ifdef CONFIG_FUNCTION_ERROR_INJECTION
481 struct error_injection_entry *ei_funcs;
482 unsigned int num_ei_funcs;
484 } ____cacheline_aligned __randomize_layout;
485 #ifndef MODULE_ARCH_INIT
486 #define MODULE_ARCH_INIT {}
489 extern struct mutex module_mutex;
491 /* FIXME: It'd be nice to isolate modules during init, too, so they
492 aren't used before they (may) fail. But presently too much code
493 (IDE & SCSI) require entry into the module during init.*/
494 static inline bool module_is_live(struct module *mod)
496 return mod->state != MODULE_STATE_GOING;
499 struct module *__module_text_address(unsigned long addr);
500 struct module *__module_address(unsigned long addr);
501 bool is_module_address(unsigned long addr);
502 bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
503 bool is_module_percpu_address(unsigned long addr);
504 bool is_module_text_address(unsigned long addr);
506 static inline bool within_module_core(unsigned long addr,
507 const struct module *mod)
509 return (unsigned long)mod->core_layout.base <= addr &&
510 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
513 static inline bool within_module_init(unsigned long addr,
514 const struct module *mod)
516 return (unsigned long)mod->init_layout.base <= addr &&
517 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
520 static inline bool within_module(unsigned long addr, const struct module *mod)
522 return within_module_init(addr, mod) || within_module_core(addr, mod);
525 /* Search for module by name: must hold module_mutex. */
526 struct module *find_module(const char *name);
529 const struct kernel_symbol *start, *stop;
540 * Search for an exported symbol by name.
542 * Must be called with module_mutex held or preemption disabled.
544 const struct kernel_symbol *find_symbol(const char *name,
545 struct module **owner,
551 * Walk the exported symbol table
553 * Must be called with module_mutex held or preemption disabled.
555 bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
556 struct module *owner,
557 void *data), void *data);
559 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
560 symnum out of range. */
561 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
562 char *name, char *module_name, int *exported);
564 /* Look for this name: can be of form module:name. */
565 unsigned long module_kallsyms_lookup_name(const char *name);
567 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
568 struct module *, unsigned long),
571 extern void __noreturn __module_put_and_exit(struct module *mod,
573 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
575 #ifdef CONFIG_MODULE_UNLOAD
576 int module_refcount(struct module *mod);
577 void __symbol_put(const char *symbol);
578 #define symbol_put(x) __symbol_put(__stringify(x))
579 void symbol_put_addr(void *addr);
581 /* Sometimes we know we already have a refcount, and it's easier not
582 to handle the error case (which only happens with rmmod --wait). */
583 extern void __module_get(struct module *module);
585 /* This is the Right Way to get a module: if it fails, it's being removed,
586 * so pretend it's not there. */
587 extern bool try_module_get(struct module *module);
589 extern void module_put(struct module *module);
591 #else /*!CONFIG_MODULE_UNLOAD*/
592 static inline bool try_module_get(struct module *module)
594 return !module || module_is_live(module);
596 static inline void module_put(struct module *module)
599 static inline void __module_get(struct module *module)
602 #define symbol_put(x) do { } while (0)
603 #define symbol_put_addr(p) do { } while (0)
605 #endif /* CONFIG_MODULE_UNLOAD */
606 int ref_module(struct module *a, struct module *b);
608 /* This is a #define so the string doesn't get put in every .o file */
609 #define module_name(mod) \
611 struct module *__mod = (mod); \
612 __mod ? __mod->name : "kernel"; \
615 /* Dereference module function descriptor */
616 void *dereference_module_function_descriptor(struct module *mod, void *ptr);
618 /* For kallsyms to ask for address resolution. namebuf should be at
619 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
620 * found, otherwise NULL. */
621 const char *module_address_lookup(unsigned long addr,
622 unsigned long *symbolsize,
623 unsigned long *offset,
626 int lookup_module_symbol_name(unsigned long addr, char *symname);
627 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
629 int register_module_notifier(struct notifier_block *nb);
630 int unregister_module_notifier(struct notifier_block *nb);
632 extern void print_modules(void);
634 static inline bool module_requested_async_probing(struct module *module)
636 return module && module->async_probe_requested;
639 #ifdef CONFIG_LIVEPATCH
640 static inline bool is_livepatch_module(struct module *mod)
644 #else /* !CONFIG_LIVEPATCH */
645 static inline bool is_livepatch_module(struct module *mod)
649 #endif /* CONFIG_LIVEPATCH */
651 bool is_module_sig_enforced(void);
653 #else /* !CONFIG_MODULES... */
655 static inline struct module *__module_address(unsigned long addr)
660 static inline struct module *__module_text_address(unsigned long addr)
665 static inline bool is_module_address(unsigned long addr)
670 static inline bool is_module_percpu_address(unsigned long addr)
675 static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
680 static inline bool is_module_text_address(unsigned long addr)
685 /* Get/put a kernel symbol (calls should be symmetric) */
686 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
687 #define symbol_put(x) do { } while (0)
688 #define symbol_put_addr(x) do { } while (0)
690 static inline void __module_get(struct module *module)
694 static inline bool try_module_get(struct module *module)
699 static inline void module_put(struct module *module)
703 #define module_name(mod) "kernel"
705 /* For kallsyms to ask for address resolution. NULL means not found. */
706 static inline const char *module_address_lookup(unsigned long addr,
707 unsigned long *symbolsize,
708 unsigned long *offset,
715 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
720 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
725 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
726 char *type, char *name,
727 char *module_name, int *exported)
732 static inline unsigned long module_kallsyms_lookup_name(const char *name)
737 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
745 static inline int register_module_notifier(struct notifier_block *nb)
747 /* no events will happen anyway, so this can always succeed */
751 static inline int unregister_module_notifier(struct notifier_block *nb)
756 #define module_put_and_exit(code) do_exit(code)
758 static inline void print_modules(void)
762 static inline bool module_requested_async_probing(struct module *module)
767 static inline bool is_module_sig_enforced(void)
772 /* Dereference module function descriptor */
774 void *dereference_module_function_descriptor(struct module *mod, void *ptr)
779 #endif /* CONFIG_MODULES */
782 extern struct kset *module_kset;
783 extern struct kobj_type module_ktype;
784 extern int module_sysfs_initialized;
785 #endif /* CONFIG_SYSFS */
787 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
789 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
791 #define __MODULE_STRING(x) __stringify(x)
793 #ifdef CONFIG_STRICT_MODULE_RWX
794 extern void set_all_modules_text_rw(void);
795 extern void set_all_modules_text_ro(void);
796 extern void module_enable_ro(const struct module *mod, bool after_init);
797 extern void module_disable_ro(const struct module *mod);
799 static inline void set_all_modules_text_rw(void) { }
800 static inline void set_all_modules_text_ro(void) { }
801 static inline void module_enable_ro(const struct module *mod, bool after_init) { }
802 static inline void module_disable_ro(const struct module *mod) { }
805 #ifdef CONFIG_GENERIC_BUG
806 void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
808 void module_bug_cleanup(struct module *);
810 #else /* !CONFIG_GENERIC_BUG */
812 static inline void module_bug_finalize(const Elf_Ehdr *hdr,
813 const Elf_Shdr *sechdrs,
817 static inline void module_bug_cleanup(struct module *mod) {}
818 #endif /* CONFIG_GENERIC_BUG */
821 extern bool retpoline_module_ok(bool has_retpoline);
823 static inline bool retpoline_module_ok(bool has_retpoline)
829 #ifdef CONFIG_MODULE_SIG
830 static inline bool module_sig_ok(struct module *module)
832 return module->sig_ok;
834 #else /* !CONFIG_MODULE_SIG */
835 static inline bool module_sig_ok(struct module *module)
839 #endif /* CONFIG_MODULE_SIG */
841 #endif /* _LINUX_MODULE_H */