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 <asm/local.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_attribute {
52 struct attribute attr;
53 ssize_t (*show)(struct module_attribute *, struct module *, char *);
54 ssize_t (*store)(struct module_attribute *, struct module *,
55 const char *, size_t count);
56 void (*setup)(struct module *, const char *);
57 int (*test)(struct module *);
58 void (*free)(struct module *);
65 struct kobject *drivers_dir;
66 struct module_param_attrs *mp;
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))))
90 extern struct module __this_module;
91 #define THIS_MODULE (&__this_module)
93 #define MODULE_GENERIC_TABLE(gtype,name)
94 #define THIS_MODULE ((struct module *)0)
97 /* Generic info of form tag = "info" */
98 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
100 /* For userspace: you can also call me... */
101 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
104 * The following license idents are currently accepted as indicating free
107 * "GPL" [GNU Public License v2 or later]
108 * "GPL v2" [GNU Public License v2]
109 * "GPL and additional rights" [GNU Public License v2 rights and more]
110 * "Dual BSD/GPL" [GNU Public License v2
111 * or BSD license choice]
112 * "Dual MIT/GPL" [GNU Public License v2
113 * or MIT license choice]
114 * "Dual MPL/GPL" [GNU Public License v2
115 * or Mozilla license choice]
117 * The following other idents are available
119 * "Proprietary" [Non free products]
121 * There are dual licensed components, but when running with Linux it is the
122 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
123 * is a GPL combined work.
125 * This exists for several reasons
126 * 1. So modinfo can show license info for users wanting to vet their setup
128 * 2. So the community can ignore bug reports including proprietary modules
129 * 3. So vendors can do likewise based on their own policies
131 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
134 * Author(s), use "Name <email>" or just "Name", for multiple
135 * authors use multiple MODULE_AUTHOR() statements/lines.
137 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
139 /* What your module does. */
140 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
142 /* One for each parameter, describing how to use it. Some files do
143 multiple of these per line, so can't just use MODULE_INFO. */
144 #define MODULE_PARM_DESC(_parm, desc) \
145 __MODULE_INFO(parm, _parm, #_parm ":" desc)
147 #define MODULE_DEVICE_TABLE(type,name) \
148 MODULE_GENERIC_TABLE(type##_device,name)
150 /* Version of form [<epoch>:]<version>[-<extra-version>].
151 Or for CVS/RCS ID version, everything but the number is stripped.
152 <epoch>: A (small) unsigned integer which allows you to start versions
153 anew. If not mentioned, it's zero. eg. "2:1.0" is after
155 <version>: The <version> may contain only alphanumerics and the
156 character `.'. Ordered by numeric sort for numeric parts,
157 ascii sort for ascii parts (as per RPM or DEB algorithm).
158 <extraversion>: Like <version>, but inserted for local
159 customizations, eg "rh3" or "rusty1".
161 Using this automatically adds a checksum of the .c files and the
162 local headers in "srcversion".
164 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
166 /* Optional firmware file (or files) needed by the module
167 * format is simply firmware file name. Multiple firmware
168 * files require multiple MODULE_FIRMWARE() specifiers */
169 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
171 /* Given an address, look for it in the exception tables */
172 const struct exception_table_entry *search_exception_tables(unsigned long add);
174 struct notifier_block;
176 #ifdef CONFIG_MODULES
178 /* Get/put a kernel symbol (calls must be symmetric) */
179 void *__symbol_get(const char *symbol);
180 void *__symbol_get_gpl(const char *symbol);
181 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
184 #ifdef CONFIG_MODVERSIONS
185 /* Mark the CRC weak since genksyms apparently decides not to
186 * generate a checksums for some symbols */
187 #define __CRC_SYMBOL(sym, sec) \
188 extern void *__crc_##sym __attribute__((weak)); \
189 static const unsigned long __kcrctab_##sym \
191 __attribute__((section("__kcrctab" sec), unused)) \
192 = (unsigned long) &__crc_##sym;
194 #define __CRC_SYMBOL(sym, sec)
197 /* For every exported symbol, place a struct in the __ksymtab section */
198 #define __EXPORT_SYMBOL(sym, sec) \
199 extern typeof(sym) sym; \
200 __CRC_SYMBOL(sym, sec) \
201 static const char __kstrtab_##sym[] \
202 __attribute__((section("__ksymtab_strings"), aligned(1))) \
203 = MODULE_SYMBOL_PREFIX #sym; \
204 static const struct kernel_symbol __ksymtab_##sym \
206 __attribute__((section("__ksymtab" sec), unused)) \
207 = { (unsigned long)&sym, __kstrtab_##sym }
209 #define EXPORT_SYMBOL(sym) \
210 __EXPORT_SYMBOL(sym, "")
212 #define EXPORT_SYMBOL_GPL(sym) \
213 __EXPORT_SYMBOL(sym, "_gpl")
215 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
216 __EXPORT_SYMBOL(sym, "_gpl_future")
219 #ifdef CONFIG_UNUSED_SYMBOLS
220 #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
221 #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
223 #define EXPORT_UNUSED_SYMBOL(sym)
224 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
238 enum module_state state;
240 /* Member of list of modules */
241 struct list_head list;
243 /* Unique handle for this module */
244 char name[MODULE_NAME_LEN];
247 struct module_kobject mkobj;
248 struct module_attribute *modinfo_attrs;
250 const char *srcversion;
251 struct kobject *holders_dir;
253 /* Exported symbols */
254 const struct kernel_symbol *syms;
255 const unsigned long *crcs;
256 unsigned int num_syms;
258 /* Kernel parameters. */
259 struct kernel_param *kp;
262 /* GPL-only exported symbols. */
263 unsigned int num_gpl_syms;
264 const struct kernel_symbol *gpl_syms;
265 const unsigned long *gpl_crcs;
267 #ifdef CONFIG_UNUSED_SYMBOLS
268 /* unused exported symbols. */
269 const struct kernel_symbol *unused_syms;
270 const unsigned long *unused_crcs;
271 unsigned int num_unused_syms;
273 /* GPL-only, unused exported symbols. */
274 unsigned int num_unused_gpl_syms;
275 const struct kernel_symbol *unused_gpl_syms;
276 const unsigned long *unused_gpl_crcs;
279 /* symbols that will be GPL-only in the near future. */
280 const struct kernel_symbol *gpl_future_syms;
281 const unsigned long *gpl_future_crcs;
282 unsigned int num_gpl_future_syms;
284 /* Exception table */
285 unsigned int num_exentries;
286 struct exception_table_entry *extable;
288 /* Startup function. */
291 /* If this is non-NULL, vfree after init() returns */
294 /* Here is the actual code + data, vfree'd on unload. */
297 /* Here are the sizes of the init and core sections */
298 unsigned int init_size, core_size;
300 /* The size of the executable code in each section. */
301 unsigned int init_text_size, core_text_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;
335 /* The command line arguments (may be mangled). People like
336 keeping pointers to this stuff */
338 #ifdef CONFIG_TRACEPOINTS
339 struct tracepoint *tracepoints;
340 unsigned int num_tracepoints;
343 #ifdef CONFIG_TRACING
344 const char **trace_bprintk_fmt_start;
345 unsigned int num_trace_bprintk_fmt;
347 #ifdef CONFIG_EVENT_TRACING
348 struct ftrace_event_call *trace_events;
349 unsigned int num_trace_events;
351 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
352 unsigned long *ftrace_callsites;
353 unsigned int num_ftrace_callsites;
356 #ifdef CONFIG_MODULE_UNLOAD
357 /* What modules depend on me? */
358 struct list_head modules_which_use_me;
360 /* Who is waiting for us to be unloaded */
361 struct task_struct *waiter;
363 /* Destruction function. */
373 #ifdef CONFIG_CONSTRUCTORS
374 /* Constructor functions. */
376 unsigned int num_ctors;
379 #ifndef MODULE_ARCH_INIT
380 #define MODULE_ARCH_INIT {}
383 extern struct mutex module_mutex;
385 /* FIXME: It'd be nice to isolate modules during init, too, so they
386 aren't used before they (may) fail. But presently too much code
387 (IDE & SCSI) require entry into the module during init.*/
388 static inline int module_is_live(struct module *mod)
390 return mod->state != MODULE_STATE_GOING;
393 struct module *__module_text_address(unsigned long addr);
394 struct module *__module_address(unsigned long addr);
395 bool is_module_address(unsigned long addr);
396 bool is_module_text_address(unsigned long addr);
398 static inline int within_module_core(unsigned long addr, struct module *mod)
400 return (unsigned long)mod->module_core <= addr &&
401 addr < (unsigned long)mod->module_core + mod->core_size;
404 static inline int within_module_init(unsigned long addr, struct module *mod)
406 return (unsigned long)mod->module_init <= addr &&
407 addr < (unsigned long)mod->module_init + mod->init_size;
410 /* Search for module by name: must hold module_mutex. */
411 struct module *find_module(const char *name);
414 const struct kernel_symbol *start, *stop;
415 const unsigned long *crcs;
424 /* Search for an exported symbol by name. */
425 const struct kernel_symbol *find_symbol(const char *name,
426 struct module **owner,
427 const unsigned long **crc,
431 /* Walk the exported symbol table */
432 bool each_symbol(bool (*fn)(const struct symsearch *arr, struct module *owner,
433 unsigned int symnum, void *data), void *data);
435 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
436 symnum out of range. */
437 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
438 char *name, char *module_name, int *exported);
440 /* Look for this name: can be of form module:name. */
441 unsigned long module_kallsyms_lookup_name(const char *name);
443 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
444 struct module *, unsigned long),
447 extern void __module_put_and_exit(struct module *mod, long code)
448 __attribute__((noreturn));
449 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
451 #ifdef CONFIG_MODULE_UNLOAD
452 unsigned int module_refcount(struct module *mod);
453 void __symbol_put(const char *symbol);
454 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
455 void symbol_put_addr(void *addr);
457 static inline local_t *__module_ref_addr(struct module *mod, int cpu)
460 return (local_t *) (mod->refptr + per_cpu_offset(cpu));
466 /* Sometimes we know we already have a refcount, and it's easier not
467 to handle the error case (which only happens with rmmod --wait). */
468 static inline void __module_get(struct module *module)
471 unsigned int cpu = get_cpu();
472 local_inc(__module_ref_addr(module, cpu));
473 trace_module_get(module, _THIS_IP_,
474 local_read(__module_ref_addr(module, cpu)));
479 static inline int try_module_get(struct module *module)
484 unsigned int cpu = get_cpu();
485 if (likely(module_is_live(module))) {
486 local_inc(__module_ref_addr(module, cpu));
487 trace_module_get(module, _THIS_IP_,
488 local_read(__module_ref_addr(module, cpu)));
497 extern void module_put(struct module *module);
499 #else /*!CONFIG_MODULE_UNLOAD*/
500 static inline int try_module_get(struct module *module)
502 return !module || module_is_live(module);
504 static inline void module_put(struct module *module)
507 static inline void __module_get(struct module *module)
510 #define symbol_put(x) do { } while(0)
511 #define symbol_put_addr(p) do { } while(0)
513 #endif /* CONFIG_MODULE_UNLOAD */
514 int use_module(struct module *a, struct module *b);
516 /* This is a #define so the string doesn't get put in every .o file */
517 #define module_name(mod) \
519 struct module *__mod = (mod); \
520 __mod ? __mod->name : "kernel"; \
523 /* For kallsyms to ask for address resolution. namebuf should be at
524 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
525 * found, otherwise NULL. */
526 const char *module_address_lookup(unsigned long addr,
527 unsigned long *symbolsize,
528 unsigned long *offset,
531 int lookup_module_symbol_name(unsigned long addr, char *symname);
532 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
534 /* For extable.c to search modules' exception tables. */
535 const struct exception_table_entry *search_module_extables(unsigned long addr);
537 int register_module_notifier(struct notifier_block * nb);
538 int unregister_module_notifier(struct notifier_block * nb);
540 extern void print_modules(void);
542 extern void module_update_tracepoints(void);
543 extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);
545 #else /* !CONFIG_MODULES... */
546 #define EXPORT_SYMBOL(sym)
547 #define EXPORT_SYMBOL_GPL(sym)
548 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
549 #define EXPORT_UNUSED_SYMBOL(sym)
550 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
552 /* Given an address, look for it in the exception tables. */
553 static inline const struct exception_table_entry *
554 search_module_extables(unsigned long addr)
559 static inline struct module *__module_address(unsigned long addr)
564 static inline struct module *__module_text_address(unsigned long addr)
569 static inline bool is_module_address(unsigned long addr)
574 static inline bool is_module_text_address(unsigned long addr)
579 /* Get/put a kernel symbol (calls should be symmetric) */
580 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
581 #define symbol_put(x) do { } while(0)
582 #define symbol_put_addr(x) do { } while(0)
584 static inline void __module_get(struct module *module)
588 static inline int try_module_get(struct module *module)
593 static inline void module_put(struct module *module)
597 #define module_name(mod) "kernel"
599 /* For kallsyms to ask for address resolution. NULL means not found. */
600 static inline const char *module_address_lookup(unsigned long addr,
601 unsigned long *symbolsize,
602 unsigned long *offset,
609 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
614 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
619 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
620 char *type, char *name,
621 char *module_name, int *exported)
626 static inline unsigned long module_kallsyms_lookup_name(const char *name)
631 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
639 static inline int register_module_notifier(struct notifier_block * nb)
641 /* no events will happen anyway, so this can always succeed */
645 static inline int unregister_module_notifier(struct notifier_block * nb)
650 #define module_put_and_exit(code) do_exit(code)
652 static inline void print_modules(void)
656 static inline void module_update_tracepoints(void)
660 static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
665 #endif /* CONFIG_MODULES */
667 struct device_driver;
671 extern struct kset *module_kset;
672 extern struct kobj_type module_ktype;
673 extern int module_sysfs_initialized;
675 int mod_sysfs_init(struct module *mod);
676 int mod_sysfs_setup(struct module *mod,
677 struct kernel_param *kparam,
678 unsigned int num_params);
679 int module_add_modinfo_attrs(struct module *mod);
680 void module_remove_modinfo_attrs(struct module *mod);
682 #else /* !CONFIG_SYSFS */
684 static inline int mod_sysfs_init(struct module *mod)
689 static inline int mod_sysfs_setup(struct module *mod,
690 struct kernel_param *kparam,
691 unsigned int num_params)
696 static inline int module_add_modinfo_attrs(struct module *mod)
701 static inline void module_remove_modinfo_attrs(struct module *mod)
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)
713 #ifdef CONFIG_GENERIC_BUG
714 int module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
716 void module_bug_cleanup(struct module *);
718 #else /* !CONFIG_GENERIC_BUG */
720 static inline int module_bug_finalize(const Elf_Ehdr *hdr,
721 const Elf_Shdr *sechdrs,
726 static inline void module_bug_cleanup(struct module *mod) {}
727 #endif /* CONFIG_GENERIC_BUG */
729 #endif /* _LINUX_MODULE_H */