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>
20 #include <linux/percpu.h>
21 #include <asm/module.h>
23 #include <trace/events/module.h>
25 /* Not Yet Implemented */
26 #define MODULE_SUPPORTED_DEVICE(name)
28 /* Some toolchains use a `_' prefix for all user symbols. */
29 #ifdef CONFIG_SYMBOL_PREFIX
30 #define MODULE_SYMBOL_PREFIX CONFIG_SYMBOL_PREFIX
32 #define MODULE_SYMBOL_PREFIX ""
35 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
43 struct modversion_info
46 char name[MODULE_NAME_LEN];
51 struct module_kobject {
54 struct kobject *drivers_dir;
55 struct module_param_attrs *mp;
58 struct module_attribute {
59 struct attribute attr;
60 ssize_t (*show)(struct module_attribute *, struct module_kobject *,
62 ssize_t (*store)(struct module_attribute *, struct module_kobject *,
63 const char *, size_t count);
64 void (*setup)(struct module *, const char *);
65 int (*test)(struct module *);
66 void (*free)(struct module *);
69 struct module_version_attribute {
70 struct module_attribute mattr;
71 const char *module_name;
73 } __attribute__ ((__aligned__(sizeof(void *))));
75 extern ssize_t __modver_version_show(struct module_attribute *,
76 struct module_kobject *, char *);
78 extern struct module_attribute module_uevent;
80 /* These are either module local, or the kernel's dummy ones. */
81 extern int init_module(void);
82 extern void cleanup_module(void);
84 /* Archs provide a method of finding the correct exception table. */
85 struct exception_table_entry;
87 const struct exception_table_entry *
88 search_extable(const struct exception_table_entry *first,
89 const struct exception_table_entry *last,
91 void sort_extable(struct exception_table_entry *start,
92 struct exception_table_entry *finish);
93 void sort_main_extable(void);
94 void trim_init_extable(struct module *m);
97 #define MODULE_GENERIC_TABLE(gtype,name) \
98 extern const struct gtype##_id __mod_##gtype##_table \
99 __attribute__ ((unused, alias(__stringify(name))))
101 extern struct module __this_module;
102 #define THIS_MODULE (&__this_module)
104 #define MODULE_GENERIC_TABLE(gtype,name)
105 #define THIS_MODULE ((struct module *)0)
108 /* Generic info of form tag = "info" */
109 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
111 /* For userspace: you can also call me... */
112 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
115 * The following license idents are currently accepted as indicating free
118 * "GPL" [GNU Public License v2 or later]
119 * "GPL v2" [GNU Public License v2]
120 * "GPL and additional rights" [GNU Public License v2 rights and more]
121 * "Dual BSD/GPL" [GNU Public License v2
122 * or BSD license choice]
123 * "Dual MIT/GPL" [GNU Public License v2
124 * or MIT license choice]
125 * "Dual MPL/GPL" [GNU Public License v2
126 * or Mozilla license choice]
128 * The following other idents are available
130 * "Proprietary" [Non free products]
132 * There are dual licensed components, but when running with Linux it is the
133 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
134 * is a GPL combined work.
136 * This exists for several reasons
137 * 1. So modinfo can show license info for users wanting to vet their setup
139 * 2. So the community can ignore bug reports including proprietary modules
140 * 3. So vendors can do likewise based on their own policies
142 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
145 * Author(s), use "Name <email>" or just "Name", for multiple
146 * authors use multiple MODULE_AUTHOR() statements/lines.
148 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
150 /* What your module does. */
151 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
153 /* One for each parameter, describing how to use it. Some files do
154 multiple of these per line, so can't just use MODULE_INFO. */
155 #define MODULE_PARM_DESC(_parm, desc) \
156 __MODULE_INFO(parm, _parm, #_parm ":" desc)
158 #define MODULE_DEVICE_TABLE(type,name) \
159 MODULE_GENERIC_TABLE(type##_device,name)
161 /* Version of form [<epoch>:]<version>[-<extra-version>].
162 Or for CVS/RCS ID version, everything but the number is stripped.
163 <epoch>: A (small) unsigned integer which allows you to start versions
164 anew. If not mentioned, it's zero. eg. "2:1.0" is after
166 <version>: The <version> may contain only alphanumerics and the
167 character `.'. Ordered by numeric sort for numeric parts,
168 ascii sort for ascii parts (as per RPM or DEB algorithm).
169 <extraversion>: Like <version>, but inserted for local
170 customizations, eg "rh3" or "rusty1".
172 Using this automatically adds a checksum of the .c files and the
173 local headers in "srcversion".
176 #if defined(MODULE) || !defined(CONFIG_SYSFS)
177 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
179 #define MODULE_VERSION(_version) \
180 static struct module_version_attribute ___modver_attr = { \
186 .show = __modver_version_show, \
188 .module_name = KBUILD_MODNAME, \
189 .version = _version, \
191 static const struct module_version_attribute \
192 __used __attribute__ ((__section__ ("__modver"))) \
193 * __moduleparam_const __modver_attr = &___modver_attr
196 /* Optional firmware file (or files) needed by the module
197 * format is simply firmware file name. Multiple firmware
198 * files require multiple MODULE_FIRMWARE() specifiers */
199 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
201 /* Given an address, look for it in the exception tables */
202 const struct exception_table_entry *search_exception_tables(unsigned long add);
204 struct notifier_block;
206 #ifdef CONFIG_MODULES
208 extern int modules_disabled; /* for sysctl */
209 /* Get/put a kernel symbol (calls must be symmetric) */
210 void *__symbol_get(const char *symbol);
211 void *__symbol_get_gpl(const char *symbol);
212 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
214 /* modules using other modules: kdb wants to see this. */
216 struct list_head source_list;
217 struct list_head target_list;
218 struct module *source, *target;
222 #ifdef CONFIG_MODVERSIONS
223 /* Mark the CRC weak since genksyms apparently decides not to
224 * generate a checksums for some symbols */
225 #define __CRC_SYMBOL(sym, sec) \
226 extern void *__crc_##sym __attribute__((weak)); \
227 static const unsigned long __kcrctab_##sym \
229 __attribute__((section("___kcrctab" sec "+" #sym), unused)) \
230 = (unsigned long) &__crc_##sym;
232 #define __CRC_SYMBOL(sym, sec)
235 /* For every exported symbol, place a struct in the __ksymtab section */
236 #define __EXPORT_SYMBOL(sym, sec) \
237 extern typeof(sym) sym; \
238 __CRC_SYMBOL(sym, sec) \
239 static const char __kstrtab_##sym[] \
240 __attribute__((section("__ksymtab_strings"), aligned(1))) \
241 = MODULE_SYMBOL_PREFIX #sym; \
242 static const struct kernel_symbol __ksymtab_##sym \
244 __attribute__((section("___ksymtab" sec "+" #sym), unused)) \
245 = { (unsigned long)&sym, __kstrtab_##sym }
247 #define EXPORT_SYMBOL(sym) \
248 __EXPORT_SYMBOL(sym, "")
250 #define EXPORT_SYMBOL_GPL(sym) \
251 __EXPORT_SYMBOL(sym, "_gpl")
253 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
254 __EXPORT_SYMBOL(sym, "_gpl_future")
257 #ifdef CONFIG_UNUSED_SYMBOLS
258 #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
259 #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
261 #define EXPORT_UNUSED_SYMBOL(sym)
262 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
276 enum module_state state;
278 /* Member of list of modules */
279 struct list_head list;
281 /* Unique handle for this module */
282 char name[MODULE_NAME_LEN];
285 struct module_kobject mkobj;
286 struct module_attribute *modinfo_attrs;
288 const char *srcversion;
289 struct kobject *holders_dir;
291 /* Exported symbols */
292 const struct kernel_symbol *syms;
293 const unsigned long *crcs;
294 unsigned int num_syms;
296 /* Kernel parameters. */
297 struct kernel_param *kp;
300 /* GPL-only exported symbols. */
301 unsigned int num_gpl_syms;
302 const struct kernel_symbol *gpl_syms;
303 const unsigned long *gpl_crcs;
305 #ifdef CONFIG_UNUSED_SYMBOLS
306 /* unused exported symbols. */
307 const struct kernel_symbol *unused_syms;
308 const unsigned long *unused_crcs;
309 unsigned int num_unused_syms;
311 /* GPL-only, unused exported symbols. */
312 unsigned int num_unused_gpl_syms;
313 const struct kernel_symbol *unused_gpl_syms;
314 const unsigned long *unused_gpl_crcs;
317 /* symbols that will be GPL-only in the near future. */
318 const struct kernel_symbol *gpl_future_syms;
319 const unsigned long *gpl_future_crcs;
320 unsigned int num_gpl_future_syms;
322 /* Exception table */
323 unsigned int num_exentries;
324 struct exception_table_entry *extable;
326 /* Startup function. */
329 /* If this is non-NULL, vfree after init() returns */
332 /* Here is the actual code + data, vfree'd on unload. */
335 /* Here are the sizes of the init and core sections */
336 unsigned int init_size, core_size;
338 /* The size of the executable code in each section. */
339 unsigned int init_text_size, core_text_size;
341 /* Size of RO sections of the module (text+rodata) */
342 unsigned int init_ro_size, core_ro_size;
344 /* Arch-specific module values */
345 struct mod_arch_specific arch;
347 unsigned int taints; /* same bits as kernel:tainted */
349 #ifdef CONFIG_GENERIC_BUG
350 /* Support for BUG */
352 struct list_head bug_list;
353 struct bug_entry *bug_table;
356 #ifdef CONFIG_KALLSYMS
358 * We keep the symbol and string tables for kallsyms.
359 * The core_* fields below are temporary, loader-only (they
360 * could really be discarded after module init).
362 Elf_Sym *symtab, *core_symtab;
363 unsigned int num_symtab, core_num_syms;
364 char *strtab, *core_strtab;
366 /* Section attributes */
367 struct module_sect_attrs *sect_attrs;
369 /* Notes attributes */
370 struct module_notes_attrs *notes_attrs;
373 /* The command line arguments (may be mangled). People like
374 keeping pointers to this stuff */
379 void __percpu *percpu;
380 unsigned int percpu_size;
383 #ifdef CONFIG_TRACEPOINTS
384 unsigned int num_tracepoints;
385 struct tracepoint * const *tracepoints_ptrs;
387 #ifdef HAVE_JUMP_LABEL
388 struct jump_entry *jump_entries;
389 unsigned int num_jump_entries;
391 #ifdef CONFIG_TRACING
392 unsigned int num_trace_bprintk_fmt;
393 const char **trace_bprintk_fmt_start;
395 #ifdef CONFIG_EVENT_TRACING
396 struct ftrace_event_call **trace_events;
397 unsigned int num_trace_events;
399 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
400 unsigned int num_ftrace_callsites;
401 unsigned long *ftrace_callsites;
404 #ifdef CONFIG_MODULE_UNLOAD
405 /* What modules depend on me? */
406 struct list_head source_list;
407 /* What modules do I depend on? */
408 struct list_head target_list;
410 /* Who is waiting for us to be unloaded */
411 struct task_struct *waiter;
413 /* Destruction function. */
422 #ifdef CONFIG_CONSTRUCTORS
423 /* Constructor functions. */
425 unsigned int num_ctors;
428 #ifndef MODULE_ARCH_INIT
429 #define MODULE_ARCH_INIT {}
432 extern struct mutex module_mutex;
434 /* FIXME: It'd be nice to isolate modules during init, too, so they
435 aren't used before they (may) fail. But presently too much code
436 (IDE & SCSI) require entry into the module during init.*/
437 static inline int module_is_live(struct module *mod)
439 return mod->state != MODULE_STATE_GOING;
442 struct module *__module_text_address(unsigned long addr);
443 struct module *__module_address(unsigned long addr);
444 bool is_module_address(unsigned long addr);
445 bool is_module_percpu_address(unsigned long addr);
446 bool is_module_text_address(unsigned long addr);
448 static inline int within_module_core(unsigned long addr, struct module *mod)
450 return (unsigned long)mod->module_core <= addr &&
451 addr < (unsigned long)mod->module_core + mod->core_size;
454 static inline int within_module_init(unsigned long addr, struct module *mod)
456 return (unsigned long)mod->module_init <= addr &&
457 addr < (unsigned long)mod->module_init + mod->init_size;
460 /* Search for module by name: must hold module_mutex. */
461 struct module *find_module(const char *name);
464 const struct kernel_symbol *start, *stop;
465 const unsigned long *crcs;
474 /* Search for an exported symbol by name. */
475 const struct kernel_symbol *find_symbol(const char *name,
476 struct module **owner,
477 const unsigned long **crc,
481 /* Walk the exported symbol table */
482 bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
483 struct module *owner,
484 void *data), void *data);
486 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
487 symnum out of range. */
488 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
489 char *name, char *module_name, int *exported);
491 /* Look for this name: can be of form module:name. */
492 unsigned long module_kallsyms_lookup_name(const char *name);
494 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
495 struct module *, unsigned long),
498 extern void __module_put_and_exit(struct module *mod, long code)
499 __attribute__((noreturn));
500 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
502 #ifdef CONFIG_MODULE_UNLOAD
503 unsigned int module_refcount(struct module *mod);
504 void __symbol_put(const char *symbol);
505 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
506 void symbol_put_addr(void *addr);
508 /* Sometimes we know we already have a refcount, and it's easier not
509 to handle the error case (which only happens with rmmod --wait). */
510 static inline void __module_get(struct module *module)
514 __this_cpu_inc(module->refptr->incs);
515 trace_module_get(module, _THIS_IP_);
520 static inline int try_module_get(struct module *module)
527 if (likely(module_is_live(module))) {
528 __this_cpu_inc(module->refptr->incs);
529 trace_module_get(module, _THIS_IP_);
538 extern void module_put(struct module *module);
540 #else /*!CONFIG_MODULE_UNLOAD*/
541 static inline int try_module_get(struct module *module)
543 return !module || module_is_live(module);
545 static inline void module_put(struct module *module)
548 static inline void __module_get(struct module *module)
551 #define symbol_put(x) do { } while(0)
552 #define symbol_put_addr(p) do { } while(0)
554 #endif /* CONFIG_MODULE_UNLOAD */
555 int ref_module(struct module *a, struct module *b);
557 /* This is a #define so the string doesn't get put in every .o file */
558 #define module_name(mod) \
560 struct module *__mod = (mod); \
561 __mod ? __mod->name : "kernel"; \
564 /* For kallsyms to ask for address resolution. namebuf should be at
565 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
566 * found, otherwise NULL. */
567 const char *module_address_lookup(unsigned long addr,
568 unsigned long *symbolsize,
569 unsigned long *offset,
572 int lookup_module_symbol_name(unsigned long addr, char *symname);
573 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
575 /* For extable.c to search modules' exception tables. */
576 const struct exception_table_entry *search_module_extables(unsigned long addr);
578 int register_module_notifier(struct notifier_block * nb);
579 int unregister_module_notifier(struct notifier_block * nb);
581 extern void print_modules(void);
583 #else /* !CONFIG_MODULES... */
584 #define EXPORT_SYMBOL(sym)
585 #define EXPORT_SYMBOL_GPL(sym)
586 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
587 #define EXPORT_UNUSED_SYMBOL(sym)
588 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
590 /* Given an address, look for it in the exception tables. */
591 static inline const struct exception_table_entry *
592 search_module_extables(unsigned long addr)
597 static inline struct module *__module_address(unsigned long addr)
602 static inline struct module *__module_text_address(unsigned long addr)
607 static inline bool is_module_address(unsigned long addr)
612 static inline bool is_module_percpu_address(unsigned long addr)
617 static inline bool is_module_text_address(unsigned long addr)
622 /* Get/put a kernel symbol (calls should be symmetric) */
623 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
624 #define symbol_put(x) do { } while(0)
625 #define symbol_put_addr(x) do { } while(0)
627 static inline void __module_get(struct module *module)
631 static inline int try_module_get(struct module *module)
636 static inline void module_put(struct module *module)
640 #define module_name(mod) "kernel"
642 /* For kallsyms to ask for address resolution. NULL means not found. */
643 static inline const char *module_address_lookup(unsigned long addr,
644 unsigned long *symbolsize,
645 unsigned long *offset,
652 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
657 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
662 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
663 char *type, char *name,
664 char *module_name, int *exported)
669 static inline unsigned long module_kallsyms_lookup_name(const char *name)
674 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
682 static inline int register_module_notifier(struct notifier_block * nb)
684 /* no events will happen anyway, so this can always succeed */
688 static inline int unregister_module_notifier(struct notifier_block * nb)
693 #define module_put_and_exit(code) do_exit(code)
695 static inline void print_modules(void)
698 #endif /* CONFIG_MODULES */
701 extern struct kset *module_kset;
702 extern struct kobj_type module_ktype;
703 extern int module_sysfs_initialized;
704 #endif /* CONFIG_SYSFS */
706 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
708 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
710 #define __MODULE_STRING(x) __stringify(x)
712 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
713 extern void set_all_modules_text_rw(void);
714 extern void set_all_modules_text_ro(void);
716 static inline void set_all_modules_text_rw(void) { }
717 static inline void set_all_modules_text_ro(void) { }
720 #ifdef CONFIG_GENERIC_BUG
721 void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
723 void module_bug_cleanup(struct module *);
725 #else /* !CONFIG_GENERIC_BUG */
727 static inline void module_bug_finalize(const Elf_Ehdr *hdr,
728 const Elf_Shdr *sechdrs,
732 static inline void module_bug_cleanup(struct module *mod) {}
733 #endif /* CONFIG_GENERIC_BUG */
735 #endif /* _LINUX_MODULE_H */