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 __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 __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. */
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 struct tracepoint
* const *tracepoints_ptrs
;
436 #ifdef HAVE_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_enum_map
**trace_enums
;
448 unsigned int num_trace_enums
;
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
;
480 } ____cacheline_aligned
;
481 #ifndef MODULE_ARCH_INIT
482 #define MODULE_ARCH_INIT {}
485 extern struct mutex module_mutex
;
487 /* FIXME: It'd be nice to isolate modules during init, too, so they
488 aren't used before they (may) fail. But presently too much code
489 (IDE & SCSI) require entry into the module during init.*/
490 static inline int module_is_live(struct module
*mod
)
492 return mod
->state
!= MODULE_STATE_GOING
;
495 struct module
*__module_text_address(unsigned long addr
);
496 struct module
*__module_address(unsigned long addr
);
497 bool is_module_address(unsigned long addr
);
498 bool is_module_percpu_address(unsigned long addr
);
499 bool is_module_text_address(unsigned long addr
);
501 static inline bool within_module_core(unsigned long addr
,
502 const struct module
*mod
)
504 return (unsigned long)mod
->core_layout
.base
<= addr
&&
505 addr
< (unsigned long)mod
->core_layout
.base
+ mod
->core_layout
.size
;
508 static inline bool within_module_init(unsigned long addr
,
509 const struct module
*mod
)
511 return (unsigned long)mod
->init_layout
.base
<= addr
&&
512 addr
< (unsigned long)mod
->init_layout
.base
+ mod
->init_layout
.size
;
515 static inline bool within_module(unsigned long addr
, const struct module
*mod
)
517 return within_module_init(addr
, mod
) || within_module_core(addr
, mod
);
520 /* Search for module by name: must hold module_mutex. */
521 struct module
*find_module(const char *name
);
524 const struct kernel_symbol
*start
, *stop
;
535 * Search for an exported symbol by name.
537 * Must be called with module_mutex held or preemption disabled.
539 const struct kernel_symbol
*find_symbol(const char *name
,
540 struct module
**owner
,
546 * Walk the exported symbol table
548 * Must be called with module_mutex held or preemption disabled.
550 bool each_symbol_section(bool (*fn
)(const struct symsearch
*arr
,
551 struct module
*owner
,
552 void *data
), void *data
);
554 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
555 symnum out of range. */
556 int module_get_kallsym(unsigned int symnum
, unsigned long *value
, char *type
,
557 char *name
, char *module_name
, int *exported
);
559 /* Look for this name: can be of form module:name. */
560 unsigned long module_kallsyms_lookup_name(const char *name
);
562 int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
563 struct module
*, unsigned long),
566 extern void __noreturn
__module_put_and_exit(struct module
*mod
,
568 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
570 #ifdef CONFIG_MODULE_UNLOAD
571 int module_refcount(struct module
*mod
);
572 void __symbol_put(const char *symbol
);
573 #define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
574 void symbol_put_addr(void *addr
);
576 /* Sometimes we know we already have a refcount, and it's easier not
577 to handle the error case (which only happens with rmmod --wait). */
578 extern void __module_get(struct module
*module
);
580 /* This is the Right Way to get a module: if it fails, it's being removed,
581 * so pretend it's not there. */
582 extern bool try_module_get(struct module
*module
);
584 extern void module_put(struct module
*module
);
586 #else /*!CONFIG_MODULE_UNLOAD*/
587 static inline int try_module_get(struct module
*module
)
589 return !module
|| module_is_live(module
);
591 static inline void module_put(struct module
*module
)
594 static inline void __module_get(struct module
*module
)
597 #define symbol_put(x) do { } while (0)
598 #define symbol_put_addr(p) do { } while (0)
600 #endif /* CONFIG_MODULE_UNLOAD */
601 int ref_module(struct module
*a
, struct module
*b
);
603 /* This is a #define so the string doesn't get put in every .o file */
604 #define module_name(mod) \
606 struct module *__mod = (mod); \
607 __mod ? __mod->name : "kernel"; \
610 /* For kallsyms to ask for address resolution. namebuf should be at
611 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
612 * found, otherwise NULL. */
613 const char *module_address_lookup(unsigned long addr
,
614 unsigned long *symbolsize
,
615 unsigned long *offset
,
618 int lookup_module_symbol_name(unsigned long addr
, char *symname
);
619 int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
);
621 int register_module_notifier(struct notifier_block
*nb
);
622 int unregister_module_notifier(struct notifier_block
*nb
);
624 extern void print_modules(void);
626 static inline bool module_requested_async_probing(struct module
*module
)
628 return module
&& module
->async_probe_requested
;
631 #ifdef CONFIG_LIVEPATCH
632 static inline bool is_livepatch_module(struct module
*mod
)
636 #else /* !CONFIG_LIVEPATCH */
637 static inline bool is_livepatch_module(struct module
*mod
)
641 #endif /* CONFIG_LIVEPATCH */
643 #else /* !CONFIG_MODULES... */
645 static inline struct module
*__module_address(unsigned long addr
)
650 static inline struct module
*__module_text_address(unsigned long addr
)
655 static inline bool is_module_address(unsigned long addr
)
660 static inline bool is_module_percpu_address(unsigned long addr
)
665 static inline bool is_module_text_address(unsigned long addr
)
670 /* Get/put a kernel symbol (calls should be symmetric) */
671 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
672 #define symbol_put(x) do { } while (0)
673 #define symbol_put_addr(x) do { } while (0)
675 static inline void __module_get(struct module
*module
)
679 static inline int try_module_get(struct module
*module
)
684 static inline void module_put(struct module
*module
)
688 #define module_name(mod) "kernel"
690 /* For kallsyms to ask for address resolution. NULL means not found. */
691 static inline const char *module_address_lookup(unsigned long addr
,
692 unsigned long *symbolsize
,
693 unsigned long *offset
,
700 static inline int lookup_module_symbol_name(unsigned long addr
, char *symname
)
705 static inline int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
)
710 static inline int module_get_kallsym(unsigned int symnum
, unsigned long *value
,
711 char *type
, char *name
,
712 char *module_name
, int *exported
)
717 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
722 static inline int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
730 static inline int register_module_notifier(struct notifier_block
*nb
)
732 /* no events will happen anyway, so this can always succeed */
736 static inline int unregister_module_notifier(struct notifier_block
*nb
)
741 #define module_put_and_exit(code) do_exit(code)
743 static inline void print_modules(void)
747 static inline bool module_requested_async_probing(struct module
*module
)
752 #endif /* CONFIG_MODULES */
755 extern struct kset
*module_kset
;
756 extern struct kobj_type module_ktype
;
757 extern int module_sysfs_initialized
;
758 #endif /* CONFIG_SYSFS */
760 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
762 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
764 #define __MODULE_STRING(x) __stringify(x)
766 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
767 extern void set_all_modules_text_rw(void);
768 extern void set_all_modules_text_ro(void);
769 extern void module_enable_ro(const struct module
*mod
, bool after_init
);
770 extern void module_disable_ro(const struct module
*mod
);
772 static inline void set_all_modules_text_rw(void) { }
773 static inline void set_all_modules_text_ro(void) { }
774 static inline void module_enable_ro(const struct module
*mod
, bool after_init
) { }
775 static inline void module_disable_ro(const struct module
*mod
) { }
778 #ifdef CONFIG_GENERIC_BUG
779 void module_bug_finalize(const Elf_Ehdr
*, const Elf_Shdr
*,
781 void module_bug_cleanup(struct module
*);
783 #else /* !CONFIG_GENERIC_BUG */
785 static inline void module_bug_finalize(const Elf_Ehdr
*hdr
,
786 const Elf_Shdr
*sechdrs
,
790 static inline void module_bug_cleanup(struct module
*mod
) {}
791 #endif /* CONFIG_GENERIC_BUG */
793 #ifdef CONFIG_MODULE_SIG
794 static inline bool module_sig_ok(struct module
*module
)
796 return module
->sig_ok
;
798 #else /* !CONFIG_MODULE_SIG */
799 static inline bool module_sig_ok(struct module
*module
)
803 #endif /* CONFIG_MODULE_SIG */
805 #endif /* _LINUX_MODULE_H */