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>
23 #include <linux/percpu.h>
24 #include <asm/module.h>
26 /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
27 #define MODULE_SIG_STRING "~Module signature appended~\n"
29 /* Not Yet Implemented */
30 #define MODULE_SUPPORTED_DEVICE(name)
32 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
34 struct modversion_info
{
36 char name
[MODULE_NAME_LEN
];
40 struct exception_table_entry
;
42 struct module_kobject
{
45 struct kobject
*drivers_dir
;
46 struct module_param_attrs
*mp
;
47 struct completion
*kobj_completion
;
50 struct module_attribute
{
51 struct attribute attr
;
52 ssize_t (*show
)(struct module_attribute
*, struct module_kobject
*,
54 ssize_t (*store
)(struct module_attribute
*, struct module_kobject
*,
55 const char *, size_t count
);
56 void (*setup
)(struct module
*, const char *);
57 int (*test
)(struct module
*);
58 void (*free
)(struct module
*);
61 struct module_version_attribute
{
62 struct module_attribute mattr
;
63 const char *module_name
;
65 } __attribute__ ((__aligned__(sizeof(void *))));
67 extern ssize_t
__modver_version_show(struct module_attribute
*,
68 struct module_kobject
*, char *);
70 extern struct module_attribute module_uevent
;
72 /* These are either module local, or the kernel's dummy ones. */
73 extern int init_module(void);
74 extern void cleanup_module(void);
78 * module_init() - driver initialization entry point
79 * @x: function to be run at kernel boot time or module insertion
81 * module_init() will either be called during do_initcalls() (if
82 * builtin) or at module insertion time (if a module). There can only
85 #define module_init(x) __initcall(x);
88 * module_exit() - driver exit entry point
89 * @x: function to be run when driver is removed
91 * module_exit() will wrap the driver clean-up code
92 * with cleanup_module() when used with rmmod when
93 * the driver is a module. If the driver is statically
94 * compiled into the kernel, module_exit() has no effect.
95 * There can only be one per module.
97 #define module_exit(x) __exitcall(x);
102 * In most cases loadable modules do not need custom
103 * initcall levels. There are still some valid cases where
104 * a driver may be needed early if built in, and does not
105 * matter when built as a loadable module. Like bus
106 * snooping debug drivers.
108 #define early_initcall(fn) module_init(fn)
109 #define core_initcall(fn) module_init(fn)
110 #define core_initcall_sync(fn) module_init(fn)
111 #define postcore_initcall(fn) module_init(fn)
112 #define postcore_initcall_sync(fn) module_init(fn)
113 #define arch_initcall(fn) module_init(fn)
114 #define subsys_initcall(fn) module_init(fn)
115 #define subsys_initcall_sync(fn) module_init(fn)
116 #define fs_initcall(fn) module_init(fn)
117 #define fs_initcall_sync(fn) module_init(fn)
118 #define rootfs_initcall(fn) module_init(fn)
119 #define device_initcall(fn) module_init(fn)
120 #define device_initcall_sync(fn) module_init(fn)
121 #define late_initcall(fn) module_init(fn)
122 #define late_initcall_sync(fn) module_init(fn)
124 #define console_initcall(fn) module_init(fn)
125 #define security_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) __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) __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 * The following license idents are currently accepted as indicating free
174 * "GPL" [GNU Public License v2 or later]
175 * "GPL v2" [GNU Public License v2]
176 * "GPL and additional rights" [GNU Public License v2 rights and more]
177 * "Dual BSD/GPL" [GNU Public License v2
178 * or BSD license choice]
179 * "Dual MIT/GPL" [GNU Public License v2
180 * or MIT license choice]
181 * "Dual MPL/GPL" [GNU Public License v2
182 * or Mozilla license choice]
184 * The following other idents are available
186 * "Proprietary" [Non free products]
188 * There are dual licensed components, but when running with Linux it is the
189 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
190 * is a GPL combined work.
192 * This exists for several reasons
193 * 1. So modinfo can show license info for users wanting to vet their setup
195 * 2. So the community can ignore bug reports including proprietary modules
196 * 3. So vendors can do likewise based on their own policies
198 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
201 * Author(s), use "Name <email>" or just "Name", for multiple
202 * authors use multiple MODULE_AUTHOR() statements/lines.
204 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
206 /* What your module does. */
207 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
210 /* Creates an alias so file2alias.c can find device table. */
211 #define MODULE_DEVICE_TABLE(type, name) \
212 extern const typeof(name) __mod_##type##__##name##_device_table \
213 __attribute__ ((unused, alias(__stringify(name))))
215 #define MODULE_DEVICE_TABLE(type, name)
218 /* Version of form [<epoch>:]<version>[-<extra-version>].
219 * Or for CVS/RCS ID version, everything but the number is stripped.
220 * <epoch>: A (small) unsigned integer which allows you to start versions
221 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
224 * <version>: The <version> may contain only alphanumerics and the
225 * character `.'. Ordered by numeric sort for numeric parts,
226 * ascii sort for ascii parts (as per RPM or DEB algorithm).
228 * <extraversion>: Like <version>, but inserted for local
229 * customizations, eg "rh3" or "rusty1".
231 * Using this automatically adds a checksum of the .c files and the
232 * local headers in "srcversion".
235 #if defined(MODULE) || !defined(CONFIG_SYSFS)
236 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
238 #define MODULE_VERSION(_version) \
239 static struct module_version_attribute ___modver_attr = { \
245 .show = __modver_version_show, \
247 .module_name = KBUILD_MODNAME, \
248 .version = _version, \
250 static const struct module_version_attribute \
251 __used __attribute__ ((__section__ ("__modver"))) \
252 * __moduleparam_const __modver_attr = &___modver_attr
255 /* Optional firmware file (or files) needed by the module
256 * format is simply firmware file name. Multiple firmware
257 * files require multiple MODULE_FIRMWARE() specifiers */
258 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
260 struct notifier_block
;
262 #ifdef CONFIG_MODULES
264 extern int modules_disabled
; /* for sysctl */
265 /* Get/put a kernel symbol (calls must be symmetric) */
266 void *__symbol_get(const char *symbol
);
267 void *__symbol_get_gpl(const char *symbol
);
268 #define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
270 /* modules using other modules: kdb wants to see this. */
272 struct list_head source_list
;
273 struct list_head target_list
;
274 struct module
*source
, *target
;
278 MODULE_STATE_LIVE
, /* Normal state. */
279 MODULE_STATE_COMING
, /* Full formed, running module_init. */
280 MODULE_STATE_GOING
, /* Going away. */
281 MODULE_STATE_UNFORMED
, /* Still setting it up. */
284 struct mod_tree_node
{
286 struct latch_tree_node node
;
289 struct module_layout
{
290 /* The actual code + data. */
294 /* The size of the executable code. */
295 unsigned int text_size
;
296 /* Size of RO section of the module (text+rodata) */
297 unsigned int ro_size
;
298 /* Size of RO after init section */
299 unsigned int ro_after_init_size
;
301 #ifdef CONFIG_MODULES_TREE_LOOKUP
302 struct mod_tree_node mtn
;
306 #ifdef CONFIG_MODULES_TREE_LOOKUP
307 /* Only touch one cacheline for common rbtree-for-core-layout case. */
308 #define __module_layout_align ____cacheline_aligned
310 #define __module_layout_align
313 struct mod_kallsyms
{
315 unsigned int num_symtab
;
319 #ifdef CONFIG_LIVEPATCH
329 enum module_state state
;
331 /* Member of list of modules */
332 struct list_head list
;
334 /* Unique handle for this module */
335 char name
[MODULE_NAME_LEN
];
338 struct module_kobject mkobj
;
339 struct module_attribute
*modinfo_attrs
;
341 const char *srcversion
;
342 struct kobject
*holders_dir
;
344 /* Exported symbols */
345 const struct kernel_symbol
*syms
;
347 unsigned int num_syms
;
349 /* Kernel parameters. */
351 struct mutex param_lock
;
353 struct kernel_param
*kp
;
356 /* GPL-only exported symbols. */
357 unsigned int num_gpl_syms
;
358 const struct kernel_symbol
*gpl_syms
;
361 #ifdef CONFIG_UNUSED_SYMBOLS
362 /* unused exported symbols. */
363 const struct kernel_symbol
*unused_syms
;
364 const s32
*unused_crcs
;
365 unsigned int num_unused_syms
;
367 /* GPL-only, unused exported symbols. */
368 unsigned int num_unused_gpl_syms
;
369 const struct kernel_symbol
*unused_gpl_syms
;
370 const s32
*unused_gpl_crcs
;
373 #ifdef CONFIG_MODULE_SIG
374 /* Signature was verified. */
378 bool async_probe_requested
;
380 /* symbols that will be GPL-only in the near future. */
381 const struct kernel_symbol
*gpl_future_syms
;
382 const s32
*gpl_future_crcs
;
383 unsigned int num_gpl_future_syms
;
385 /* Exception table */
386 unsigned int num_exentries
;
387 struct exception_table_entry
*extable
;
389 /* Startup function. */
392 /* Core layout: rbtree is accessed frequently, so keep together. */
393 struct module_layout core_layout __module_layout_align
;
394 struct module_layout init_layout
;
396 /* Arch-specific module values */
397 struct mod_arch_specific arch
;
399 unsigned long taints
; /* same bits as kernel:taint_flags */
401 #ifdef CONFIG_GENERIC_BUG
402 /* Support for BUG */
404 struct list_head bug_list
;
405 struct bug_entry
*bug_table
;
408 #ifdef CONFIG_KALLSYMS
409 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
410 struct mod_kallsyms
*kallsyms
;
411 struct mod_kallsyms core_kallsyms
;
413 /* Section attributes */
414 struct module_sect_attrs
*sect_attrs
;
416 /* Notes attributes */
417 struct module_notes_attrs
*notes_attrs
;
420 /* The command line arguments (may be mangled). People like
421 keeping pointers to this stuff */
426 void __percpu
*percpu
;
427 unsigned int percpu_size
;
430 #ifdef CONFIG_TRACEPOINTS
431 unsigned int num_tracepoints
;
432 struct tracepoint
* const *tracepoints_ptrs
;
434 #ifdef HAVE_JUMP_LABEL
435 struct jump_entry
*jump_entries
;
436 unsigned int num_jump_entries
;
438 #ifdef CONFIG_TRACING
439 unsigned int num_trace_bprintk_fmt
;
440 const char **trace_bprintk_fmt_start
;
442 #ifdef CONFIG_EVENT_TRACING
443 struct trace_event_call
**trace_events
;
444 unsigned int num_trace_events
;
445 struct trace_eval_map
**trace_evals
;
446 unsigned int num_trace_evals
;
448 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
449 unsigned int num_ftrace_callsites
;
450 unsigned long *ftrace_callsites
;
453 #ifdef CONFIG_LIVEPATCH
454 bool klp
; /* Is this a livepatch module? */
457 /* Elf information */
458 struct klp_modinfo
*klp_info
;
461 #ifdef CONFIG_MODULE_UNLOAD
462 /* What modules depend on me? */
463 struct list_head source_list
;
464 /* What modules do I depend on? */
465 struct list_head target_list
;
467 /* Destruction function. */
473 #ifdef CONFIG_CONSTRUCTORS
474 /* Constructor functions. */
476 unsigned int num_ctors
;
478 } ____cacheline_aligned
;
479 #ifndef MODULE_ARCH_INIT
480 #define MODULE_ARCH_INIT {}
483 extern struct mutex module_mutex
;
485 /* FIXME: It'd be nice to isolate modules during init, too, so they
486 aren't used before they (may) fail. But presently too much code
487 (IDE & SCSI) require entry into the module during init.*/
488 static inline int module_is_live(struct module
*mod
)
490 return mod
->state
!= MODULE_STATE_GOING
;
493 struct module
*__module_text_address(unsigned long addr
);
494 struct module
*__module_address(unsigned long addr
);
495 bool is_module_address(unsigned long addr
);
496 bool __is_module_percpu_address(unsigned long addr
, unsigned long *can_addr
);
497 bool is_module_percpu_address(unsigned long addr
);
498 bool is_module_text_address(unsigned long addr
);
500 static inline bool within_module_core(unsigned long addr
,
501 const struct module
*mod
)
503 return (unsigned long)mod
->core_layout
.base
<= addr
&&
504 addr
< (unsigned long)mod
->core_layout
.base
+ mod
->core_layout
.size
;
507 static inline bool within_module_init(unsigned long addr
,
508 const struct module
*mod
)
510 return (unsigned long)mod
->init_layout
.base
<= addr
&&
511 addr
< (unsigned long)mod
->init_layout
.base
+ mod
->init_layout
.size
;
514 static inline bool within_module(unsigned long addr
, const struct module
*mod
)
516 return within_module_init(addr
, mod
) || within_module_core(addr
, mod
);
519 /* Search for module by name: must hold module_mutex. */
520 struct module
*find_module(const char *name
);
523 const struct kernel_symbol
*start
, *stop
;
534 * Search for an exported symbol by name.
536 * Must be called with module_mutex held or preemption disabled.
538 const struct kernel_symbol
*find_symbol(const char *name
,
539 struct module
**owner
,
545 * Walk the exported symbol table
547 * Must be called with module_mutex held or preemption disabled.
549 bool each_symbol_section(bool (*fn
)(const struct symsearch
*arr
,
550 struct module
*owner
,
551 void *data
), void *data
);
553 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
554 symnum out of range. */
555 int module_get_kallsym(unsigned int symnum
, unsigned long *value
, char *type
,
556 char *name
, char *module_name
, int *exported
);
558 /* Look for this name: can be of form module:name. */
559 unsigned long module_kallsyms_lookup_name(const char *name
);
561 int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
562 struct module
*, unsigned long),
565 extern void __noreturn
__module_put_and_exit(struct module
*mod
,
567 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
569 #ifdef CONFIG_MODULE_UNLOAD
570 int module_refcount(struct module
*mod
);
571 void __symbol_put(const char *symbol
);
572 #define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
573 void symbol_put_addr(void *addr
);
575 /* Sometimes we know we already have a refcount, and it's easier not
576 to handle the error case (which only happens with rmmod --wait). */
577 extern void __module_get(struct module
*module
);
579 /* This is the Right Way to get a module: if it fails, it's being removed,
580 * so pretend it's not there. */
581 extern bool try_module_get(struct module
*module
);
583 extern void module_put(struct module
*module
);
585 #else /*!CONFIG_MODULE_UNLOAD*/
586 static inline bool try_module_get(struct module
*module
)
588 return !module
|| module_is_live(module
);
590 static inline void module_put(struct module
*module
)
593 static inline void __module_get(struct module
*module
)
596 #define symbol_put(x) do { } while (0)
597 #define symbol_put_addr(p) do { } while (0)
599 #endif /* CONFIG_MODULE_UNLOAD */
600 int ref_module(struct module
*a
, struct module
*b
);
602 /* This is a #define so the string doesn't get put in every .o file */
603 #define module_name(mod) \
605 struct module *__mod = (mod); \
606 __mod ? __mod->name : "kernel"; \
609 /* For kallsyms to ask for address resolution. namebuf should be at
610 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
611 * found, otherwise NULL. */
612 const char *module_address_lookup(unsigned long addr
,
613 unsigned long *symbolsize
,
614 unsigned long *offset
,
617 int lookup_module_symbol_name(unsigned long addr
, char *symname
);
618 int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
);
620 int register_module_notifier(struct notifier_block
*nb
);
621 int unregister_module_notifier(struct notifier_block
*nb
);
623 extern void print_modules(void);
625 static inline bool module_requested_async_probing(struct module
*module
)
627 return module
&& module
->async_probe_requested
;
630 #ifdef CONFIG_LIVEPATCH
631 static inline bool is_livepatch_module(struct module
*mod
)
635 #else /* !CONFIG_LIVEPATCH */
636 static inline bool is_livepatch_module(struct module
*mod
)
640 #endif /* CONFIG_LIVEPATCH */
642 #else /* !CONFIG_MODULES... */
644 static inline struct module
*__module_address(unsigned long addr
)
649 static inline struct module
*__module_text_address(unsigned long addr
)
654 static inline bool is_module_address(unsigned long addr
)
659 static inline bool is_module_percpu_address(unsigned long addr
)
664 static inline bool __is_module_percpu_address(unsigned long addr
, unsigned long *can_addr
)
669 static inline bool is_module_text_address(unsigned long addr
)
674 /* Get/put a kernel symbol (calls should be symmetric) */
675 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
676 #define symbol_put(x) do { } while (0)
677 #define symbol_put_addr(x) do { } while (0)
679 static inline void __module_get(struct module
*module
)
683 static inline bool try_module_get(struct module
*module
)
688 static inline void module_put(struct module
*module
)
692 #define module_name(mod) "kernel"
694 /* For kallsyms to ask for address resolution. NULL means not found. */
695 static inline const char *module_address_lookup(unsigned long addr
,
696 unsigned long *symbolsize
,
697 unsigned long *offset
,
704 static inline int lookup_module_symbol_name(unsigned long addr
, char *symname
)
709 static inline int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
)
714 static inline int module_get_kallsym(unsigned int symnum
, unsigned long *value
,
715 char *type
, char *name
,
716 char *module_name
, int *exported
)
721 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
726 static inline int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
734 static inline int register_module_notifier(struct notifier_block
*nb
)
736 /* no events will happen anyway, so this can always succeed */
740 static inline int unregister_module_notifier(struct notifier_block
*nb
)
745 #define module_put_and_exit(code) do_exit(code)
747 static inline void print_modules(void)
751 static inline bool module_requested_async_probing(struct module
*module
)
756 #endif /* CONFIG_MODULES */
759 extern struct kset
*module_kset
;
760 extern struct kobj_type module_ktype
;
761 extern int module_sysfs_initialized
;
762 #endif /* CONFIG_SYSFS */
764 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
766 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
768 #define __MODULE_STRING(x) __stringify(x)
770 #ifdef CONFIG_STRICT_MODULE_RWX
771 extern void set_all_modules_text_rw(void);
772 extern void set_all_modules_text_ro(void);
773 extern void module_enable_ro(const struct module
*mod
, bool after_init
);
774 extern void module_disable_ro(const struct module
*mod
);
776 static inline void set_all_modules_text_rw(void) { }
777 static inline void set_all_modules_text_ro(void) { }
778 static inline void module_enable_ro(const struct module
*mod
, bool after_init
) { }
779 static inline void module_disable_ro(const struct module
*mod
) { }
782 #ifdef CONFIG_GENERIC_BUG
783 void module_bug_finalize(const Elf_Ehdr
*, const Elf_Shdr
*,
785 void module_bug_cleanup(struct module
*);
787 #else /* !CONFIG_GENERIC_BUG */
789 static inline void module_bug_finalize(const Elf_Ehdr
*hdr
,
790 const Elf_Shdr
*sechdrs
,
794 static inline void module_bug_cleanup(struct module
*mod
) {}
795 #endif /* CONFIG_GENERIC_BUG */
797 #ifdef CONFIG_MODULE_SIG
798 static inline bool module_sig_ok(struct module
*module
)
800 return module
->sig_ok
;
802 #else /* !CONFIG_MODULE_SIG */
803 static inline bool module_sig_ok(struct module
*module
)
807 #endif /* CONFIG_MODULE_SIG */
809 #endif /* _LINUX_MODULE_H */