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
];
41 struct module_kobject
{
44 struct kobject
*drivers_dir
;
45 struct module_param_attrs
*mp
;
46 struct completion
*kobj_completion
;
49 struct module_attribute
{
50 struct attribute attr
;
51 ssize_t (*show
)(struct module_attribute
*, struct module_kobject
*,
53 ssize_t (*store
)(struct module_attribute
*, struct module_kobject
*,
54 const char *, size_t count
);
55 void (*setup
)(struct module
*, const char *);
56 int (*test
)(struct module
*);
57 void (*free
)(struct module
*);
60 struct module_version_attribute
{
61 struct module_attribute mattr
;
62 const char *module_name
;
64 } __attribute__ ((__aligned__(sizeof(void *))));
66 extern ssize_t
__modver_version_show(struct module_attribute
*,
67 struct module_kobject
*, char *);
69 extern struct module_attribute module_uevent
;
71 /* These are either module local, or the kernel's dummy ones. */
72 extern int init_module(void);
73 extern void cleanup_module(void);
77 * module_init() - driver initialization entry point
78 * @x: function to be run at kernel boot time or module insertion
80 * module_init() will either be called during do_initcalls() (if
81 * builtin) or at module insertion time (if a module). There can only
84 #define module_init(x) __initcall(x);
87 * module_exit() - driver exit entry point
88 * @x: function to be run when driver is removed
90 * module_exit() will wrap the driver clean-up code
91 * with cleanup_module() when used with rmmod when
92 * the driver is a module. If the driver is statically
93 * compiled into the kernel, module_exit() has no effect.
94 * There can only be one per module.
96 #define module_exit(x) __exitcall(x);
101 * In most cases loadable modules do not need custom
102 * initcall levels. There are still some valid cases where
103 * a driver may be needed early if built in, and does not
104 * matter when built as a loadable module. Like bus
105 * snooping debug drivers.
107 #define early_initcall(fn) module_init(fn)
108 #define core_initcall(fn) module_init(fn)
109 #define core_initcall_sync(fn) module_init(fn)
110 #define postcore_initcall(fn) module_init(fn)
111 #define postcore_initcall_sync(fn) module_init(fn)
112 #define arch_initcall(fn) module_init(fn)
113 #define subsys_initcall(fn) module_init(fn)
114 #define subsys_initcall_sync(fn) module_init(fn)
115 #define fs_initcall(fn) module_init(fn)
116 #define fs_initcall_sync(fn) module_init(fn)
117 #define rootfs_initcall(fn) module_init(fn)
118 #define device_initcall(fn) module_init(fn)
119 #define device_initcall_sync(fn) module_init(fn)
120 #define late_initcall(fn) module_init(fn)
121 #define late_initcall_sync(fn) module_init(fn)
123 #define console_initcall(fn) module_init(fn)
124 #define security_initcall(fn) module_init(fn)
126 /* Each module must use one module_init(). */
127 #define module_init(initfn) \
128 static inline initcall_t __inittest(void) \
130 int init_module(void) __attribute__((alias(#initfn)));
132 /* This is only required if you want to be unloadable. */
133 #define module_exit(exitfn) \
134 static inline exitcall_t __exittest(void) \
136 void cleanup_module(void) __attribute__((alias(#exitfn)));
140 /* This means "can be init if no module support, otherwise module load
142 #ifdef CONFIG_MODULES
143 #define __init_or_module
144 #define __initdata_or_module
145 #define __initconst_or_module
146 #define __INIT_OR_MODULE .text
147 #define __INITDATA_OR_MODULE .data
148 #define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
150 #define __init_or_module __init
151 #define __initdata_or_module __initdata
152 #define __initconst_or_module __initconst
153 #define __INIT_OR_MODULE __INIT
154 #define __INITDATA_OR_MODULE __INITDATA
155 #define __INITRODATA_OR_MODULE __INITRODATA
156 #endif /*CONFIG_MODULES*/
158 /* Archs provide a method of finding the correct exception table. */
159 struct exception_table_entry
;
161 const struct exception_table_entry
*
162 search_extable(const struct exception_table_entry
*first
,
163 const struct exception_table_entry
*last
,
164 unsigned long value
);
165 void sort_extable(struct exception_table_entry
*start
,
166 struct exception_table_entry
*finish
);
167 void sort_main_extable(void);
168 void trim_init_extable(struct module
*m
);
170 /* Generic info of form tag = "info" */
171 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
173 /* For userspace: you can also call me... */
174 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
176 /* Soft module dependencies. See man modprobe.d for details.
177 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
179 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
182 * The following license idents are currently accepted as indicating free
185 * "GPL" [GNU Public License v2 or later]
186 * "GPL v2" [GNU Public License v2]
187 * "GPL and additional rights" [GNU Public License v2 rights and more]
188 * "Dual BSD/GPL" [GNU Public License v2
189 * or BSD license choice]
190 * "Dual MIT/GPL" [GNU Public License v2
191 * or MIT license choice]
192 * "Dual MPL/GPL" [GNU Public License v2
193 * or Mozilla license choice]
195 * The following other idents are available
197 * "Proprietary" [Non free products]
199 * There are dual licensed components, but when running with Linux it is the
200 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
201 * is a GPL combined work.
203 * This exists for several reasons
204 * 1. So modinfo can show license info for users wanting to vet their setup
206 * 2. So the community can ignore bug reports including proprietary modules
207 * 3. So vendors can do likewise based on their own policies
209 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
212 * Author(s), use "Name <email>" or just "Name", for multiple
213 * authors use multiple MODULE_AUTHOR() statements/lines.
215 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
217 /* What your module does. */
218 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
221 /* Creates an alias so file2alias.c can find device table. */
222 #define MODULE_DEVICE_TABLE(type, name) \
223 extern const typeof(name) __mod_##type##__##name##_device_table \
224 __attribute__ ((unused, alias(__stringify(name))))
226 #define MODULE_DEVICE_TABLE(type, name)
229 /* Version of form [<epoch>:]<version>[-<extra-version>].
230 * Or for CVS/RCS ID version, everything but the number is stripped.
231 * <epoch>: A (small) unsigned integer which allows you to start versions
232 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
235 * <version>: The <version> may contain only alphanumerics and the
236 * character `.'. Ordered by numeric sort for numeric parts,
237 * ascii sort for ascii parts (as per RPM or DEB algorithm).
239 * <extraversion>: Like <version>, but inserted for local
240 * customizations, eg "rh3" or "rusty1".
242 * Using this automatically adds a checksum of the .c files and the
243 * local headers in "srcversion".
246 #if defined(MODULE) || !defined(CONFIG_SYSFS)
247 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
249 #define MODULE_VERSION(_version) \
250 static struct module_version_attribute ___modver_attr = { \
256 .show = __modver_version_show, \
258 .module_name = KBUILD_MODNAME, \
259 .version = _version, \
261 static const struct module_version_attribute \
262 __used __attribute__ ((__section__ ("__modver"))) \
263 * __moduleparam_const __modver_attr = &___modver_attr
266 /* Optional firmware file (or files) needed by the module
267 * format is simply firmware file name. Multiple firmware
268 * files require multiple MODULE_FIRMWARE() specifiers */
269 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
271 /* Given an address, look for it in the exception tables */
272 const struct exception_table_entry
*search_exception_tables(unsigned long add
);
274 struct notifier_block
;
276 #ifdef CONFIG_MODULES
278 extern int modules_disabled
; /* for sysctl */
279 /* Get/put a kernel symbol (calls must be symmetric) */
280 void *__symbol_get(const char *symbol
);
281 void *__symbol_get_gpl(const char *symbol
);
282 #define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
284 /* modules using other modules: kdb wants to see this. */
286 struct list_head source_list
;
287 struct list_head target_list
;
288 struct module
*source
, *target
;
292 MODULE_STATE_LIVE
, /* Normal state. */
293 MODULE_STATE_COMING
, /* Full formed, running module_init. */
294 MODULE_STATE_GOING
, /* Going away. */
295 MODULE_STATE_UNFORMED
, /* Still setting it up. */
300 struct mod_tree_node
{
302 struct latch_tree_node node
;
305 struct module_layout
{
306 /* The actual code + data. */
310 /* The size of the executable code. */
311 unsigned int text_size
;
312 /* Size of RO section of the module (text+rodata) */
313 unsigned int ro_size
;
315 #ifdef CONFIG_MODULES_TREE_LOOKUP
316 struct mod_tree_node mtn
;
320 #ifdef CONFIG_MODULES_TREE_LOOKUP
321 /* Only touch one cacheline for common rbtree-for-core-layout case. */
322 #define __module_layout_align ____cacheline_aligned
324 #define __module_layout_align
327 struct mod_kallsyms
{
329 unsigned int num_symtab
;
333 #ifdef CONFIG_LIVEPATCH
343 enum module_state state
;
345 /* Member of list of modules */
346 struct list_head list
;
348 /* Unique handle for this module */
349 char name
[MODULE_NAME_LEN
];
352 struct module_kobject mkobj
;
353 struct module_attribute
*modinfo_attrs
;
355 const char *srcversion
;
356 struct kobject
*holders_dir
;
358 /* Exported symbols */
359 const struct kernel_symbol
*syms
;
360 const unsigned long *crcs
;
361 unsigned int num_syms
;
363 /* Kernel parameters. */
365 struct mutex param_lock
;
367 struct kernel_param
*kp
;
370 /* GPL-only exported symbols. */
371 unsigned int num_gpl_syms
;
372 const struct kernel_symbol
*gpl_syms
;
373 const unsigned long *gpl_crcs
;
375 #ifdef CONFIG_UNUSED_SYMBOLS
376 /* unused exported symbols. */
377 const struct kernel_symbol
*unused_syms
;
378 const unsigned long *unused_crcs
;
379 unsigned int num_unused_syms
;
381 /* GPL-only, unused exported symbols. */
382 unsigned int num_unused_gpl_syms
;
383 const struct kernel_symbol
*unused_gpl_syms
;
384 const unsigned long *unused_gpl_crcs
;
387 #ifdef CONFIG_MODULE_SIG
388 /* Signature was verified. */
392 bool async_probe_requested
;
394 /* symbols that will be GPL-only in the near future. */
395 const struct kernel_symbol
*gpl_future_syms
;
396 const unsigned long *gpl_future_crcs
;
397 unsigned int num_gpl_future_syms
;
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 int taints
; /* same bits as kernel:tainted */
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
*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
;
444 #ifdef CONFIG_TRACEPOINTS
445 unsigned int num_tracepoints
;
446 struct tracepoint
* const *tracepoints_ptrs
;
448 #ifdef HAVE_JUMP_LABEL
449 struct jump_entry
*jump_entries
;
450 unsigned int num_jump_entries
;
452 #ifdef CONFIG_TRACING
453 unsigned int num_trace_bprintk_fmt
;
454 const char **trace_bprintk_fmt_start
;
456 #ifdef CONFIG_EVENT_TRACING
457 struct trace_event_call
**trace_events
;
458 unsigned int num_trace_events
;
459 struct trace_enum_map
**trace_enums
;
460 unsigned int num_trace_enums
;
462 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
463 unsigned int num_ftrace_callsites
;
464 unsigned long *ftrace_callsites
;
467 #ifdef CONFIG_LIVEPATCH
468 bool klp
; /* Is this a livepatch module? */
471 /* Elf information */
472 struct klp_modinfo
*klp_info
;
475 #ifdef CONFIG_MODULE_UNLOAD
476 /* What modules depend on me? */
477 struct list_head source_list
;
478 /* What modules do I depend on? */
479 struct list_head target_list
;
481 /* Destruction function. */
487 #ifdef CONFIG_CONSTRUCTORS
488 /* Constructor functions. */
490 unsigned int num_ctors
;
492 } ____cacheline_aligned
;
493 #ifndef MODULE_ARCH_INIT
494 #define MODULE_ARCH_INIT {}
497 extern struct mutex module_mutex
;
499 /* FIXME: It'd be nice to isolate modules during init, too, so they
500 aren't used before they (may) fail. But presently too much code
501 (IDE & SCSI) require entry into the module during init.*/
502 static inline int module_is_live(struct module
*mod
)
504 return mod
->state
!= MODULE_STATE_GOING
;
507 struct module
*__module_text_address(unsigned long addr
);
508 struct module
*__module_address(unsigned long addr
);
509 bool is_module_address(unsigned long addr
);
510 bool is_module_percpu_address(unsigned long addr
);
511 bool is_module_text_address(unsigned long addr
);
513 static inline bool within_module_core(unsigned long addr
,
514 const struct module
*mod
)
516 return (unsigned long)mod
->core_layout
.base
<= addr
&&
517 addr
< (unsigned long)mod
->core_layout
.base
+ mod
->core_layout
.size
;
520 static inline bool within_module_init(unsigned long addr
,
521 const struct module
*mod
)
523 return (unsigned long)mod
->init_layout
.base
<= addr
&&
524 addr
< (unsigned long)mod
->init_layout
.base
+ mod
->init_layout
.size
;
527 static inline bool within_module(unsigned long addr
, const struct module
*mod
)
529 return within_module_init(addr
, mod
) || within_module_core(addr
, mod
);
532 /* Search for module by name: must hold module_mutex. */
533 struct module
*find_module(const char *name
);
536 const struct kernel_symbol
*start
, *stop
;
537 const unsigned long *crcs
;
547 * Search for an exported symbol by name.
549 * Must be called with module_mutex held or preemption disabled.
551 const struct kernel_symbol
*find_symbol(const char *name
,
552 struct module
**owner
,
553 const unsigned long **crc
,
558 * Walk the exported symbol table
560 * Must be called with module_mutex held or preemption disabled.
562 bool each_symbol_section(bool (*fn
)(const struct symsearch
*arr
,
563 struct module
*owner
,
564 void *data
), void *data
);
566 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
567 symnum out of range. */
568 int module_get_kallsym(unsigned int symnum
, unsigned long *value
, char *type
,
569 char *name
, char *module_name
, int *exported
);
571 /* Look for this name: can be of form module:name. */
572 unsigned long module_kallsyms_lookup_name(const char *name
);
574 int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
575 struct module
*, unsigned long),
578 extern void __module_put_and_exit(struct module
*mod
, long code
)
579 __attribute__((noreturn
));
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(VMLINUX_SYMBOL_STR(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 int 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 */
613 int ref_module(struct module
*a
, struct module
*b
);
615 /* This is a #define so the string doesn't get put in every .o file */
616 #define module_name(mod) \
618 struct module *__mod = (mod); \
619 __mod ? __mod->name : "kernel"; \
622 /* For kallsyms to ask for address resolution. namebuf should be at
623 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
624 * found, otherwise NULL. */
625 const char *module_address_lookup(unsigned long addr
,
626 unsigned long *symbolsize
,
627 unsigned long *offset
,
630 int lookup_module_symbol_name(unsigned long addr
, char *symname
);
631 int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
);
633 /* For extable.c to search modules' exception tables. */
634 const struct exception_table_entry
*search_module_extables(unsigned long addr
);
636 int register_module_notifier(struct notifier_block
*nb
);
637 int unregister_module_notifier(struct notifier_block
*nb
);
639 extern void print_modules(void);
641 static inline bool module_requested_async_probing(struct module
*module
)
643 return module
&& module
->async_probe_requested
;
646 #ifdef CONFIG_LIVEPATCH
647 static inline bool is_livepatch_module(struct module
*mod
)
651 #else /* !CONFIG_LIVEPATCH */
652 static inline bool is_livepatch_module(struct module
*mod
)
656 #endif /* CONFIG_LIVEPATCH */
658 #else /* !CONFIG_MODULES... */
660 /* Given an address, look for it in the exception tables. */
661 static inline const struct exception_table_entry
*
662 search_module_extables(unsigned long addr
)
667 static inline struct module
*__module_address(unsigned long addr
)
672 static inline struct module
*__module_text_address(unsigned long addr
)
677 static inline bool is_module_address(unsigned long addr
)
682 static inline bool is_module_percpu_address(unsigned long addr
)
687 static inline bool is_module_text_address(unsigned long addr
)
692 /* Get/put a kernel symbol (calls should be symmetric) */
693 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
694 #define symbol_put(x) do { } while (0)
695 #define symbol_put_addr(x) do { } while (0)
697 static inline void __module_get(struct module
*module
)
701 static inline int try_module_get(struct module
*module
)
706 static inline void module_put(struct module
*module
)
710 #define module_name(mod) "kernel"
712 /* For kallsyms to ask for address resolution. NULL means not found. */
713 static inline const char *module_address_lookup(unsigned long addr
,
714 unsigned long *symbolsize
,
715 unsigned long *offset
,
722 static inline int lookup_module_symbol_name(unsigned long addr
, char *symname
)
727 static inline int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
)
732 static inline int module_get_kallsym(unsigned int symnum
, unsigned long *value
,
733 char *type
, char *name
,
734 char *module_name
, int *exported
)
739 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
744 static inline int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
752 static inline int register_module_notifier(struct notifier_block
*nb
)
754 /* no events will happen anyway, so this can always succeed */
758 static inline int unregister_module_notifier(struct notifier_block
*nb
)
763 #define module_put_and_exit(code) do_exit(code)
765 static inline void print_modules(void)
769 static inline bool module_requested_async_probing(struct module
*module
)
774 #endif /* CONFIG_MODULES */
777 extern struct kset
*module_kset
;
778 extern struct kobj_type module_ktype
;
779 extern int module_sysfs_initialized
;
780 #endif /* CONFIG_SYSFS */
782 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
784 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
786 #define __MODULE_STRING(x) __stringify(x)
788 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
789 extern void set_all_modules_text_rw(void);
790 extern void set_all_modules_text_ro(void);
791 extern void module_enable_ro(const struct module
*mod
);
792 extern void module_disable_ro(const struct module
*mod
);
794 static inline void set_all_modules_text_rw(void) { }
795 static inline void set_all_modules_text_ro(void) { }
796 static inline void module_enable_ro(const struct module
*mod
) { }
797 static inline void module_disable_ro(const struct module
*mod
) { }
800 #ifdef CONFIG_GENERIC_BUG
801 void module_bug_finalize(const Elf_Ehdr
*, const Elf_Shdr
*,
803 void module_bug_cleanup(struct module
*);
805 #else /* !CONFIG_GENERIC_BUG */
807 static inline void module_bug_finalize(const Elf_Ehdr
*hdr
,
808 const Elf_Shdr
*sechdrs
,
812 static inline void module_bug_cleanup(struct module
*mod
) {}
813 #endif /* CONFIG_GENERIC_BUG */
815 #ifdef CONFIG_MODULE_SIG
816 static inline bool module_sig_ok(struct module
*module
)
818 return module
->sig_ok
;
820 #else /* !CONFIG_MODULE_SIG */
821 static inline bool module_sig_ok(struct module
*module
)
825 #endif /* CONFIG_MODULE_SIG */
827 #endif /* _LINUX_MODULE_H */