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/elf.h>
15 #include <linux/stringify.h>
16 #include <linux/kobject.h>
17 #include <linux/moduleparam.h>
18 #include <linux/jump_label.h>
19 #include <linux/export.h>
20 #include <linux/rbtree_latch.h>
22 #include <linux/percpu.h>
23 #include <asm/module.h>
25 /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
26 #define MODULE_SIG_STRING "~Module signature appended~\n"
28 /* Not Yet Implemented */
29 #define MODULE_SUPPORTED_DEVICE(name)
31 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
33 struct modversion_info
{
35 char name
[MODULE_NAME_LEN
];
40 struct module_kobject
{
43 struct kobject
*drivers_dir
;
44 struct module_param_attrs
*mp
;
45 struct completion
*kobj_completion
;
48 struct module_attribute
{
49 struct attribute attr
;
50 ssize_t (*show
)(struct module_attribute
*, struct module_kobject
*,
52 ssize_t (*store
)(struct module_attribute
*, struct module_kobject
*,
53 const char *, size_t count
);
54 void (*setup
)(struct module
*, const char *);
55 int (*test
)(struct module
*);
56 void (*free
)(struct module
*);
59 struct module_version_attribute
{
60 struct module_attribute mattr
;
61 const char *module_name
;
63 } __attribute__ ((__aligned__(sizeof(void *))));
65 extern ssize_t
__modver_version_show(struct module_attribute
*,
66 struct module_kobject
*, char *);
68 extern struct module_attribute module_uevent
;
70 /* These are either module local, or the kernel's dummy ones. */
71 extern int init_module(void);
72 extern void cleanup_module(void);
74 /* Archs provide a method of finding the correct exception table. */
75 struct exception_table_entry
;
77 const struct exception_table_entry
*
78 search_extable(const struct exception_table_entry
*first
,
79 const struct exception_table_entry
*last
,
81 void sort_extable(struct exception_table_entry
*start
,
82 struct exception_table_entry
*finish
);
83 void sort_main_extable(void);
84 void trim_init_extable(struct module
*m
);
86 /* Generic info of form tag = "info" */
87 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
89 /* For userspace: you can also call me... */
90 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
92 /* Soft module dependencies. See man modprobe.d for details.
93 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
95 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
98 * The following license idents are currently accepted as indicating free
101 * "GPL" [GNU Public License v2 or later]
102 * "GPL v2" [GNU Public License v2]
103 * "GPL and additional rights" [GNU Public License v2 rights and more]
104 * "Dual BSD/GPL" [GNU Public License v2
105 * or BSD license choice]
106 * "Dual MIT/GPL" [GNU Public License v2
107 * or MIT license choice]
108 * "Dual MPL/GPL" [GNU Public License v2
109 * or Mozilla license choice]
111 * The following other idents are available
113 * "Proprietary" [Non free products]
115 * There are dual licensed components, but when running with Linux it is the
116 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
117 * is a GPL combined work.
119 * This exists for several reasons
120 * 1. So modinfo can show license info for users wanting to vet their setup
122 * 2. So the community can ignore bug reports including proprietary modules
123 * 3. So vendors can do likewise based on their own policies
125 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
128 * Author(s), use "Name <email>" or just "Name", for multiple
129 * authors use multiple MODULE_AUTHOR() statements/lines.
131 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
133 /* What your module does. */
134 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
137 /* Creates an alias so file2alias.c can find device table. */
138 #define MODULE_DEVICE_TABLE(type, name) \
139 extern const typeof(name) __mod_##type##__##name##_device_table \
140 __attribute__ ((unused, alias(__stringify(name))))
142 #define MODULE_DEVICE_TABLE(type, name)
145 /* Version of form [<epoch>:]<version>[-<extra-version>].
146 * Or for CVS/RCS ID version, everything but the number is stripped.
147 * <epoch>: A (small) unsigned integer which allows you to start versions
148 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
151 * <version>: The <version> may contain only alphanumerics and the
152 * character `.'. Ordered by numeric sort for numeric parts,
153 * ascii sort for ascii parts (as per RPM or DEB algorithm).
155 * <extraversion>: Like <version>, but inserted for local
156 * customizations, eg "rh3" or "rusty1".
158 * Using this automatically adds a checksum of the .c files and the
159 * local headers in "srcversion".
162 #if defined(MODULE) || !defined(CONFIG_SYSFS)
163 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
165 #define MODULE_VERSION(_version) \
166 static struct module_version_attribute ___modver_attr = { \
172 .show = __modver_version_show, \
174 .module_name = KBUILD_MODNAME, \
175 .version = _version, \
177 static const struct module_version_attribute \
178 __used __attribute__ ((__section__ ("__modver"))) \
179 * __moduleparam_const __modver_attr = &___modver_attr
182 /* Optional firmware file (or files) needed by the module
183 * format is simply firmware file name. Multiple firmware
184 * files require multiple MODULE_FIRMWARE() specifiers */
185 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
187 /* Given an address, look for it in the exception tables */
188 const struct exception_table_entry
*search_exception_tables(unsigned long add
);
190 struct notifier_block
;
192 #ifdef CONFIG_MODULES
194 extern int modules_disabled
; /* for sysctl */
195 /* Get/put a kernel symbol (calls must be symmetric) */
196 void *__symbol_get(const char *symbol
);
197 void *__symbol_get_gpl(const char *symbol
);
198 #define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
200 /* modules using other modules: kdb wants to see this. */
202 struct list_head source_list
;
203 struct list_head target_list
;
204 struct module
*source
, *target
;
208 MODULE_STATE_LIVE
, /* Normal state. */
209 MODULE_STATE_COMING
, /* Full formed, running module_init. */
210 MODULE_STATE_GOING
, /* Going away. */
211 MODULE_STATE_UNFORMED
, /* Still setting it up. */
216 struct mod_tree_node
{
218 struct latch_tree_node node
;
222 enum module_state state
;
224 /* Member of list of modules */
225 struct list_head list
;
227 /* Unique handle for this module */
228 char name
[MODULE_NAME_LEN
];
231 struct module_kobject mkobj
;
232 struct module_attribute
*modinfo_attrs
;
234 const char *srcversion
;
235 struct kobject
*holders_dir
;
237 /* Exported symbols */
238 const struct kernel_symbol
*syms
;
239 const unsigned long *crcs
;
240 unsigned int num_syms
;
242 /* Kernel parameters. */
244 struct mutex param_lock
;
246 struct kernel_param
*kp
;
249 /* GPL-only exported symbols. */
250 unsigned int num_gpl_syms
;
251 const struct kernel_symbol
*gpl_syms
;
252 const unsigned long *gpl_crcs
;
254 #ifdef CONFIG_UNUSED_SYMBOLS
255 /* unused exported symbols. */
256 const struct kernel_symbol
*unused_syms
;
257 const unsigned long *unused_crcs
;
258 unsigned int num_unused_syms
;
260 /* GPL-only, unused exported symbols. */
261 unsigned int num_unused_gpl_syms
;
262 const struct kernel_symbol
*unused_gpl_syms
;
263 const unsigned long *unused_gpl_crcs
;
266 #ifdef CONFIG_MODULE_SIG
267 /* Signature was verified. */
271 bool async_probe_requested
;
273 /* symbols that will be GPL-only in the near future. */
274 const struct kernel_symbol
*gpl_future_syms
;
275 const unsigned long *gpl_future_crcs
;
276 unsigned int num_gpl_future_syms
;
278 /* Exception table */
279 unsigned int num_exentries
;
280 struct exception_table_entry
*extable
;
282 /* Startup function. */
286 * If this is non-NULL, vfree() after init() returns.
288 * Cacheline align here, such that:
289 * module_init, module_core, init_size, core_size,
290 * init_text_size, core_text_size and mtn_core::{mod,node[0]}
291 * are on the same cacheline.
293 void *module_init ____cacheline_aligned
;
295 /* Here is the actual code + data, vfree'd on unload. */
298 /* Here are the sizes of the init and core sections */
299 unsigned int init_size
, core_size
;
301 /* The size of the executable code in each section. */
302 unsigned int init_text_size
, core_text_size
;
304 #ifdef CONFIG_MODULES_TREE_LOOKUP
306 * We want mtn_core::{mod,node[0]} to be in the same cacheline as the
307 * above entries such that a regular lookup will only touch one
310 struct mod_tree_node mtn_core
;
311 struct mod_tree_node mtn_init
;
314 /* Size of RO sections of the module (text+rodata) */
315 unsigned int init_ro_size
, core_ro_size
;
317 /* Arch-specific module values */
318 struct mod_arch_specific arch
;
320 unsigned int taints
; /* same bits as kernel:tainted */
322 #ifdef CONFIG_GENERIC_BUG
323 /* Support for BUG */
325 struct list_head bug_list
;
326 struct bug_entry
*bug_table
;
329 #ifdef CONFIG_KALLSYMS
331 * We keep the symbol and string tables for kallsyms.
332 * The core_* fields below are temporary, loader-only (they
333 * could really be discarded after module init).
335 Elf_Sym
*symtab
, *core_symtab
;
336 unsigned int num_symtab
, core_num_syms
;
337 char *strtab
, *core_strtab
;
339 /* Section attributes */
340 struct module_sect_attrs
*sect_attrs
;
342 /* Notes attributes */
343 struct module_notes_attrs
*notes_attrs
;
346 /* The command line arguments (may be mangled). People like
347 keeping pointers to this stuff */
352 void __percpu
*percpu
;
353 unsigned int percpu_size
;
356 #ifdef CONFIG_TRACEPOINTS
357 unsigned int num_tracepoints
;
358 struct tracepoint
* const *tracepoints_ptrs
;
360 #ifdef HAVE_JUMP_LABEL
361 struct jump_entry
*jump_entries
;
362 unsigned int num_jump_entries
;
364 #ifdef CONFIG_TRACING
365 unsigned int num_trace_bprintk_fmt
;
366 const char **trace_bprintk_fmt_start
;
368 #ifdef CONFIG_EVENT_TRACING
369 struct trace_event_call
**trace_events
;
370 unsigned int num_trace_events
;
371 struct trace_enum_map
**trace_enums
;
372 unsigned int num_trace_enums
;
374 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
375 unsigned int num_ftrace_callsites
;
376 unsigned long *ftrace_callsites
;
379 #ifdef CONFIG_LIVEPATCH
383 #ifdef CONFIG_MODULE_UNLOAD
384 /* What modules depend on me? */
385 struct list_head source_list
;
386 /* What modules do I depend on? */
387 struct list_head target_list
;
389 /* Destruction function. */
395 #ifdef CONFIG_CONSTRUCTORS
396 /* Constructor functions. */
398 unsigned int num_ctors
;
400 } ____cacheline_aligned
;
401 #ifndef MODULE_ARCH_INIT
402 #define MODULE_ARCH_INIT {}
405 extern struct mutex module_mutex
;
407 /* FIXME: It'd be nice to isolate modules during init, too, so they
408 aren't used before they (may) fail. But presently too much code
409 (IDE & SCSI) require entry into the module during init.*/
410 static inline int module_is_live(struct module
*mod
)
412 return mod
->state
!= MODULE_STATE_GOING
;
415 struct module
*__module_text_address(unsigned long addr
);
416 struct module
*__module_address(unsigned long addr
);
417 bool is_module_address(unsigned long addr
);
418 bool is_module_percpu_address(unsigned long addr
);
419 bool is_module_text_address(unsigned long addr
);
421 static inline bool within_module_core(unsigned long addr
,
422 const struct module
*mod
)
424 return (unsigned long)mod
->module_core
<= addr
&&
425 addr
< (unsigned long)mod
->module_core
+ mod
->core_size
;
428 static inline bool within_module_init(unsigned long addr
,
429 const struct module
*mod
)
431 return (unsigned long)mod
->module_init
<= addr
&&
432 addr
< (unsigned long)mod
->module_init
+ mod
->init_size
;
435 static inline bool within_module(unsigned long addr
, const struct module
*mod
)
437 return within_module_init(addr
, mod
) || within_module_core(addr
, mod
);
440 /* Search for module by name: must hold module_mutex. */
441 struct module
*find_module(const char *name
);
444 const struct kernel_symbol
*start
, *stop
;
445 const unsigned long *crcs
;
455 * Search for an exported symbol by name.
457 * Must be called with module_mutex held or preemption disabled.
459 const struct kernel_symbol
*find_symbol(const char *name
,
460 struct module
**owner
,
461 const unsigned long **crc
,
466 * Walk the exported symbol table
468 * Must be called with module_mutex held or preemption disabled.
470 bool each_symbol_section(bool (*fn
)(const struct symsearch
*arr
,
471 struct module
*owner
,
472 void *data
), void *data
);
474 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
475 symnum out of range. */
476 int module_get_kallsym(unsigned int symnum
, unsigned long *value
, char *type
,
477 char *name
, char *module_name
, int *exported
);
479 /* Look for this name: can be of form module:name. */
480 unsigned long module_kallsyms_lookup_name(const char *name
);
482 int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
483 struct module
*, unsigned long),
486 extern void __module_put_and_exit(struct module
*mod
, long code
)
487 __attribute__((noreturn
));
488 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
490 #ifdef CONFIG_MODULE_UNLOAD
491 int module_refcount(struct module
*mod
);
492 void __symbol_put(const char *symbol
);
493 #define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
494 void symbol_put_addr(void *addr
);
496 /* Sometimes we know we already have a refcount, and it's easier not
497 to handle the error case (which only happens with rmmod --wait). */
498 extern void __module_get(struct module
*module
);
500 /* This is the Right Way to get a module: if it fails, it's being removed,
501 * so pretend it's not there. */
502 extern bool try_module_get(struct module
*module
);
504 extern void module_put(struct module
*module
);
506 #else /*!CONFIG_MODULE_UNLOAD*/
507 static inline int try_module_get(struct module
*module
)
509 return !module
|| module_is_live(module
);
511 static inline void module_put(struct module
*module
)
514 static inline void __module_get(struct module
*module
)
517 #define symbol_put(x) do { } while (0)
518 #define symbol_put_addr(p) do { } while (0)
520 #endif /* CONFIG_MODULE_UNLOAD */
521 int ref_module(struct module
*a
, struct module
*b
);
523 /* This is a #define so the string doesn't get put in every .o file */
524 #define module_name(mod) \
526 struct module *__mod = (mod); \
527 __mod ? __mod->name : "kernel"; \
530 /* For kallsyms to ask for address resolution. namebuf should be at
531 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
532 * found, otherwise NULL. */
533 const char *module_address_lookup(unsigned long addr
,
534 unsigned long *symbolsize
,
535 unsigned long *offset
,
538 int lookup_module_symbol_name(unsigned long addr
, char *symname
);
539 int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
);
541 /* For extable.c to search modules' exception tables. */
542 const struct exception_table_entry
*search_module_extables(unsigned long addr
);
544 int register_module_notifier(struct notifier_block
*nb
);
545 int unregister_module_notifier(struct notifier_block
*nb
);
547 extern void print_modules(void);
549 static inline bool module_requested_async_probing(struct module
*module
)
551 return module
&& module
->async_probe_requested
;
554 #else /* !CONFIG_MODULES... */
556 /* Given an address, look for it in the exception tables. */
557 static inline const struct exception_table_entry
*
558 search_module_extables(unsigned long addr
)
563 static inline struct module
*__module_address(unsigned long addr
)
568 static inline struct module
*__module_text_address(unsigned long addr
)
573 static inline bool is_module_address(unsigned long addr
)
578 static inline bool is_module_percpu_address(unsigned long addr
)
583 static inline bool is_module_text_address(unsigned long addr
)
588 /* Get/put a kernel symbol (calls should be symmetric) */
589 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
590 #define symbol_put(x) do { } while (0)
591 #define symbol_put_addr(x) do { } while (0)
593 static inline void __module_get(struct module
*module
)
597 static inline int try_module_get(struct module
*module
)
602 static inline void module_put(struct module
*module
)
606 #define module_name(mod) "kernel"
608 /* For kallsyms to ask for address resolution. NULL means not found. */
609 static inline const char *module_address_lookup(unsigned long addr
,
610 unsigned long *symbolsize
,
611 unsigned long *offset
,
618 static inline int lookup_module_symbol_name(unsigned long addr
, char *symname
)
623 static inline int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
)
628 static inline int module_get_kallsym(unsigned int symnum
, unsigned long *value
,
629 char *type
, char *name
,
630 char *module_name
, int *exported
)
635 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
640 static inline int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
648 static inline int register_module_notifier(struct notifier_block
*nb
)
650 /* no events will happen anyway, so this can always succeed */
654 static inline int unregister_module_notifier(struct notifier_block
*nb
)
659 #define module_put_and_exit(code) do_exit(code)
661 static inline void print_modules(void)
665 static inline bool module_requested_async_probing(struct module
*module
)
670 #endif /* CONFIG_MODULES */
673 extern struct kset
*module_kset
;
674 extern struct kobj_type module_ktype
;
675 extern int module_sysfs_initialized
;
676 #endif /* CONFIG_SYSFS */
678 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
680 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
682 #define __MODULE_STRING(x) __stringify(x)
684 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
685 extern void set_all_modules_text_rw(void);
686 extern void set_all_modules_text_ro(void);
688 static inline void set_all_modules_text_rw(void) { }
689 static inline void set_all_modules_text_ro(void) { }
692 #ifdef CONFIG_GENERIC_BUG
693 void module_bug_finalize(const Elf_Ehdr
*, const Elf_Shdr
*,
695 void module_bug_cleanup(struct module
*);
697 #else /* !CONFIG_GENERIC_BUG */
699 static inline void module_bug_finalize(const Elf_Ehdr
*hdr
,
700 const Elf_Shdr
*sechdrs
,
704 static inline void module_bug_cleanup(struct module
*mod
) {}
705 #endif /* CONFIG_GENERIC_BUG */
707 #ifdef CONFIG_MODULE_SIG
708 static inline bool module_sig_ok(struct module
*module
)
710 return module
->sig_ok
;
712 #else /* !CONFIG_MODULE_SIG */
713 static inline bool module_sig_ok(struct module
*module
)
717 #endif /* CONFIG_MODULE_SIG */
719 #endif /* _LINUX_MODULE_H */