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/tracepoint.h>
19 #include <linux/export.h>
21 #include <linux/percpu.h>
22 #include <asm/module.h>
24 /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
25 #define MODULE_SIG_STRING "~Module signature appended~\n"
27 /* Not Yet Implemented */
28 #define MODULE_SUPPORTED_DEVICE(name)
30 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
32 struct modversion_info
35 char name[MODULE_NAME_LEN];
40 struct module_kobject {
43 struct kobject *drivers_dir;
44 struct module_param_attrs *mp;
47 struct module_attribute {
48 struct attribute attr;
49 ssize_t (*show)(struct module_attribute *, struct module_kobject *,
51 ssize_t (*store)(struct module_attribute *, struct module_kobject *,
52 const char *, size_t count);
53 void (*setup)(struct module *, const char *);
54 int (*test)(struct module *);
55 void (*free)(struct module *);
58 struct module_version_attribute {
59 struct module_attribute mattr;
60 const char *module_name;
62 } __attribute__ ((__aligned__(sizeof(void *))));
64 extern ssize_t __modver_version_show(struct module_attribute *,
65 struct module_kobject *, char *);
67 extern struct module_attribute module_uevent;
69 /* These are either module local, or the kernel's dummy ones. */
70 extern int init_module(void);
71 extern void cleanup_module(void);
73 /* Archs provide a method of finding the correct exception table. */
74 struct exception_table_entry;
76 const struct exception_table_entry *
77 search_extable(const struct exception_table_entry *first,
78 const struct exception_table_entry *last,
80 void sort_extable(struct exception_table_entry *start,
81 struct exception_table_entry *finish);
82 void sort_main_extable(void);
83 void trim_init_extable(struct module *m);
86 #define MODULE_GENERIC_TABLE(gtype,name) \
87 extern const struct gtype##_id __mod_##gtype##_table \
88 __attribute__ ((unused, alias(__stringify(name))))
91 #define MODULE_GENERIC_TABLE(gtype,name)
94 /* Generic info of form tag = "info" */
95 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
97 /* For userspace: you can also call me... */
98 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
100 /* Soft module dependencies. See man modprobe.d for details.
101 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
103 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
106 * The following license idents are currently accepted as indicating free
109 * "GPL" [GNU Public License v2 or later]
110 * "GPL v2" [GNU Public License v2]
111 * "GPL and additional rights" [GNU Public License v2 rights and more]
112 * "Dual BSD/GPL" [GNU Public License v2
113 * or BSD license choice]
114 * "Dual MIT/GPL" [GNU Public License v2
115 * or MIT license choice]
116 * "Dual MPL/GPL" [GNU Public License v2
117 * or Mozilla license choice]
119 * The following other idents are available
121 * "Proprietary" [Non free products]
123 * There are dual licensed components, but when running with Linux it is the
124 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
125 * is a GPL combined work.
127 * This exists for several reasons
128 * 1. So modinfo can show license info for users wanting to vet their setup
130 * 2. So the community can ignore bug reports including proprietary modules
131 * 3. So vendors can do likewise based on their own policies
133 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
136 * Author(s), use "Name <email>" or just "Name", for multiple
137 * authors use multiple MODULE_AUTHOR() statements/lines.
139 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
141 /* What your module does. */
142 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
144 #define MODULE_DEVICE_TABLE(type,name) \
145 MODULE_GENERIC_TABLE(type##_device,name)
147 /* Version of form [<epoch>:]<version>[-<extra-version>].
148 Or for CVS/RCS ID version, everything but the number is stripped.
149 <epoch>: A (small) unsigned integer which allows you to start versions
150 anew. If not mentioned, it's zero. eg. "2:1.0" is after
152 <version>: The <version> may contain only alphanumerics and the
153 character `.'. Ordered by numeric sort for numeric parts,
154 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. */
215 * struct module_ref - per cpu module reference counts
216 * @incs: number of module get on this cpu
217 * @decs: number of module put on this cpu
219 * We force an alignment on 8 or 16 bytes, so that alloc_percpu()
220 * put @incs/@decs in same cache line, with no extra memory cost,
221 * since alloc_percpu() is fine grained.
226 } __attribute((aligned(2 * sizeof(unsigned long))));
230 enum module_state state;
232 /* Member of list of modules */
233 struct list_head list;
235 /* Unique handle for this module */
236 char name[MODULE_NAME_LEN];
239 struct module_kobject mkobj;
240 struct module_attribute *modinfo_attrs;
242 const char *srcversion;
243 struct kobject *holders_dir;
245 /* Exported symbols */
246 const struct kernel_symbol *syms;
247 const unsigned long *crcs;
248 unsigned int num_syms;
250 /* Kernel parameters. */
251 struct kernel_param *kp;
254 /* GPL-only exported symbols. */
255 unsigned int num_gpl_syms;
256 const struct kernel_symbol *gpl_syms;
257 const unsigned long *gpl_crcs;
259 #ifdef CONFIG_UNUSED_SYMBOLS
260 /* unused exported symbols. */
261 const struct kernel_symbol *unused_syms;
262 const unsigned long *unused_crcs;
263 unsigned int num_unused_syms;
265 /* GPL-only, unused exported symbols. */
266 unsigned int num_unused_gpl_syms;
267 const struct kernel_symbol *unused_gpl_syms;
268 const unsigned long *unused_gpl_crcs;
271 #ifdef CONFIG_MODULE_SIG
272 /* Signature was verified. */
276 /* symbols that will be GPL-only in the near future. */
277 const struct kernel_symbol *gpl_future_syms;
278 const unsigned long *gpl_future_crcs;
279 unsigned int num_gpl_future_syms;
281 /* Exception table */
282 unsigned int num_exentries;
283 struct exception_table_entry *extable;
285 /* Startup function. */
288 /* If this is non-NULL, vfree after init() returns */
291 /* Here is the actual code + data, vfree'd on unload. */
294 /* Here are the sizes of the init and core sections */
295 unsigned int init_size, core_size;
297 /* The size of the executable code in each section. */
298 unsigned int init_text_size, core_text_size;
300 /* Size of RO sections of the module (text+rodata) */
301 unsigned int init_ro_size, core_ro_size;
303 /* Arch-specific module values */
304 struct mod_arch_specific arch;
306 unsigned int taints; /* same bits as kernel:tainted */
308 #ifdef CONFIG_GENERIC_BUG
309 /* Support for BUG */
311 struct list_head bug_list;
312 struct bug_entry *bug_table;
315 #ifdef CONFIG_KALLSYMS
317 * We keep the symbol and string tables for kallsyms.
318 * The core_* fields below are temporary, loader-only (they
319 * could really be discarded after module init).
321 Elf_Sym *symtab, *core_symtab;
322 unsigned int num_symtab, core_num_syms;
323 char *strtab, *core_strtab;
325 /* Section attributes */
326 struct module_sect_attrs *sect_attrs;
328 /* Notes attributes */
329 struct module_notes_attrs *notes_attrs;
332 /* The command line arguments (may be mangled). People like
333 keeping pointers to this stuff */
338 void __percpu *percpu;
339 unsigned int percpu_size;
342 #ifdef CONFIG_TRACEPOINTS
343 unsigned int num_tracepoints;
344 struct tracepoint * const *tracepoints_ptrs;
346 #ifdef HAVE_JUMP_LABEL
347 struct jump_entry *jump_entries;
348 unsigned int num_jump_entries;
350 #ifdef CONFIG_TRACING
351 unsigned int num_trace_bprintk_fmt;
352 const char **trace_bprintk_fmt_start;
354 #ifdef CONFIG_EVENT_TRACING
355 struct ftrace_event_call **trace_events;
356 unsigned int num_trace_events;
358 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
359 unsigned int num_ftrace_callsites;
360 unsigned long *ftrace_callsites;
363 #ifdef CONFIG_MODULE_UNLOAD
364 /* What modules depend on me? */
365 struct list_head source_list;
366 /* What modules do I depend on? */
367 struct list_head target_list;
369 /* Who is waiting for us to be unloaded */
370 struct task_struct *waiter;
372 /* Destruction function. */
375 struct module_ref __percpu *refptr;
378 #ifdef CONFIG_CONSTRUCTORS
379 /* Constructor functions. */
381 unsigned int num_ctors;
384 #ifndef MODULE_ARCH_INIT
385 #define MODULE_ARCH_INIT {}
388 extern struct mutex module_mutex;
390 /* FIXME: It'd be nice to isolate modules during init, too, so they
391 aren't used before they (may) fail. But presently too much code
392 (IDE & SCSI) require entry into the module during init.*/
393 static inline int module_is_live(struct module *mod)
395 return mod->state != MODULE_STATE_GOING;
398 struct module *__module_text_address(unsigned long addr);
399 struct module *__module_address(unsigned long addr);
400 bool is_module_address(unsigned long addr);
401 bool is_module_percpu_address(unsigned long addr);
402 bool is_module_text_address(unsigned long addr);
404 static inline int within_module_core(unsigned long addr, const struct module *mod)
406 return (unsigned long)mod->module_core <= addr &&
407 addr < (unsigned long)mod->module_core + mod->core_size;
410 static inline int within_module_init(unsigned long addr, const struct module *mod)
412 return (unsigned long)mod->module_init <= addr &&
413 addr < (unsigned long)mod->module_init + mod->init_size;
416 /* Search for module by name: must hold module_mutex. */
417 struct module *find_module(const char *name);
420 const struct kernel_symbol *start, *stop;
421 const unsigned long *crcs;
430 /* Search for an exported symbol by name. */
431 const struct kernel_symbol *find_symbol(const char *name,
432 struct module **owner,
433 const unsigned long **crc,
437 /* Walk the exported symbol table */
438 bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
439 struct module *owner,
440 void *data), void *data);
442 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
443 symnum out of range. */
444 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
445 char *name, char *module_name, int *exported);
447 /* Look for this name: can be of form module:name. */
448 unsigned long module_kallsyms_lookup_name(const char *name);
450 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
451 struct module *, unsigned long),
454 extern void __module_put_and_exit(struct module *mod, long code)
455 __attribute__((noreturn));
456 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
458 #ifdef CONFIG_MODULE_UNLOAD
459 unsigned long module_refcount(struct module *mod);
460 void __symbol_put(const char *symbol);
461 #define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
462 void symbol_put_addr(void *addr);
464 /* Sometimes we know we already have a refcount, and it's easier not
465 to handle the error case (which only happens with rmmod --wait). */
466 extern void __module_get(struct module *module);
468 /* This is the Right Way to get a module: if it fails, it's being removed,
469 * so pretend it's not there. */
470 extern bool try_module_get(struct module *module);
472 extern void module_put(struct module *module);
474 #else /*!CONFIG_MODULE_UNLOAD*/
475 static inline int try_module_get(struct module *module)
477 return !module || module_is_live(module);
479 static inline void module_put(struct module *module)
482 static inline void __module_get(struct module *module)
485 #define symbol_put(x) do { } while(0)
486 #define symbol_put_addr(p) do { } while(0)
488 #endif /* CONFIG_MODULE_UNLOAD */
489 int ref_module(struct module *a, struct module *b);
491 /* This is a #define so the string doesn't get put in every .o file */
492 #define module_name(mod) \
494 struct module *__mod = (mod); \
495 __mod ? __mod->name : "kernel"; \
498 /* For kallsyms to ask for address resolution. namebuf should be at
499 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
500 * found, otherwise NULL. */
501 const char *module_address_lookup(unsigned long addr,
502 unsigned long *symbolsize,
503 unsigned long *offset,
506 int lookup_module_symbol_name(unsigned long addr, char *symname);
507 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
509 /* For extable.c to search modules' exception tables. */
510 const struct exception_table_entry *search_module_extables(unsigned long addr);
512 int register_module_notifier(struct notifier_block * nb);
513 int unregister_module_notifier(struct notifier_block * nb);
515 extern void print_modules(void);
517 #else /* !CONFIG_MODULES... */
519 /* Given an address, look for it in the exception tables. */
520 static inline const struct exception_table_entry *
521 search_module_extables(unsigned long addr)
526 static inline struct module *__module_address(unsigned long addr)
531 static inline struct module *__module_text_address(unsigned long addr)
536 static inline bool is_module_address(unsigned long addr)
541 static inline bool is_module_percpu_address(unsigned long addr)
546 static inline bool is_module_text_address(unsigned long addr)
551 /* Get/put a kernel symbol (calls should be symmetric) */
552 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
553 #define symbol_put(x) do { } while(0)
554 #define symbol_put_addr(x) do { } while(0)
556 static inline void __module_get(struct module *module)
560 static inline int try_module_get(struct module *module)
565 static inline void module_put(struct module *module)
569 #define module_name(mod) "kernel"
571 /* For kallsyms to ask for address resolution. NULL means not found. */
572 static inline const char *module_address_lookup(unsigned long addr,
573 unsigned long *symbolsize,
574 unsigned long *offset,
581 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
586 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
591 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
592 char *type, char *name,
593 char *module_name, int *exported)
598 static inline unsigned long module_kallsyms_lookup_name(const char *name)
603 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
611 static inline int register_module_notifier(struct notifier_block * nb)
613 /* no events will happen anyway, so this can always succeed */
617 static inline int unregister_module_notifier(struct notifier_block * nb)
622 #define module_put_and_exit(code) do_exit(code)
624 static inline void print_modules(void)
627 #endif /* CONFIG_MODULES */
630 extern struct kset *module_kset;
631 extern struct kobj_type module_ktype;
632 extern int module_sysfs_initialized;
633 #endif /* CONFIG_SYSFS */
635 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
637 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
639 #define __MODULE_STRING(x) __stringify(x)
641 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
642 extern void set_all_modules_text_rw(void);
643 extern void set_all_modules_text_ro(void);
645 static inline void set_all_modules_text_rw(void) { }
646 static inline void set_all_modules_text_ro(void) { }
649 #ifdef CONFIG_GENERIC_BUG
650 void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
652 void module_bug_cleanup(struct module *);
654 #else /* !CONFIG_GENERIC_BUG */
656 static inline void module_bug_finalize(const Elf_Ehdr *hdr,
657 const Elf_Shdr *sechdrs,
661 static inline void module_bug_cleanup(struct module *mod) {}
662 #endif /* CONFIG_GENERIC_BUG */
664 #endif /* _LINUX_MODULE_H */