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/marker.h>
19 #include <linux/tracepoint.h>
20 #include <asm/local.h>
22 #include <asm/module.h>
24 /* Not Yet Implemented */
25 #define MODULE_SUPPORTED_DEVICE(name)
27 /* some toolchains uses a `_' prefix for all user symbols */
28 #ifndef MODULE_SYMBOL_PREFIX
29 #define MODULE_SYMBOL_PREFIX ""
32 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
40 struct modversion_info
43 char name[MODULE_NAME_LEN];
48 struct module_attribute {
49 struct attribute attr;
50 ssize_t (*show)(struct module_attribute *, struct module *, char *);
51 ssize_t (*store)(struct module_attribute *, struct module *,
52 const char *, size_t count);
53 void (*setup)(struct module *, const char *);
54 int (*test)(struct module *);
55 void (*free)(struct module *);
62 struct kobject *drivers_dir;
63 struct module_param_attrs *mp;
66 /* These are either module local, or the kernel's dummy ones. */
67 extern int init_module(void);
68 extern void cleanup_module(void);
70 /* Archs provide a method of finding the correct exception table. */
71 struct exception_table_entry;
73 const struct exception_table_entry *
74 search_extable(const struct exception_table_entry *first,
75 const struct exception_table_entry *last,
77 void sort_extable(struct exception_table_entry *start,
78 struct exception_table_entry *finish);
79 void sort_main_extable(void);
82 #define MODULE_GENERIC_TABLE(gtype,name) \
83 extern const struct gtype##_id __mod_##gtype##_table \
84 __attribute__ ((unused, alias(__stringify(name))))
86 extern struct module __this_module;
87 #define THIS_MODULE (&__this_module)
89 #define MODULE_GENERIC_TABLE(gtype,name)
90 #define THIS_MODULE ((struct module *)0)
93 /* Generic info of form tag = "info" */
94 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
96 /* For userspace: you can also call me... */
97 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
100 * The following license idents are currently accepted as indicating free
103 * "GPL" [GNU Public License v2 or later]
104 * "GPL v2" [GNU Public License v2]
105 * "GPL and additional rights" [GNU Public License v2 rights and more]
106 * "Dual BSD/GPL" [GNU Public License v2
107 * or BSD license choice]
108 * "Dual MIT/GPL" [GNU Public License v2
109 * or MIT license choice]
110 * "Dual MPL/GPL" [GNU Public License v2
111 * or Mozilla license choice]
113 * The following other idents are available
115 * "Proprietary" [Non free products]
117 * There are dual licensed components, but when running with Linux it is the
118 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
119 * is a GPL combined work.
121 * This exists for several reasons
122 * 1. So modinfo can show license info for users wanting to vet their setup
124 * 2. So the community can ignore bug reports including proprietary modules
125 * 3. So vendors can do likewise based on their own policies
127 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
129 /* Author, ideally of form NAME[, NAME]*[ and NAME] */
130 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
132 /* What your module does. */
133 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
135 /* One for each parameter, describing how to use it. Some files do
136 multiple of these per line, so can't just use MODULE_INFO. */
137 #define MODULE_PARM_DESC(_parm, desc) \
138 __MODULE_INFO(parm, _parm, #_parm ":" desc)
140 #define MODULE_DEVICE_TABLE(type,name) \
141 MODULE_GENERIC_TABLE(type##_device,name)
143 /* Version of form [<epoch>:]<version>[-<extra-version>].
144 Or for CVS/RCS ID version, everything but the number is stripped.
145 <epoch>: A (small) unsigned integer which allows you to start versions
146 anew. If not mentioned, it's zero. eg. "2:1.0" is after
148 <version>: The <version> may contain only alphanumerics and the
149 character `.'. Ordered by numeric sort for numeric parts,
150 ascii sort for ascii parts (as per RPM or DEB algorithm).
151 <extraversion>: Like <version>, but inserted for local
152 customizations, eg "rh3" or "rusty1".
154 Using this automatically adds a checksum of the .c files and the
155 local headers in "srcversion".
157 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
159 /* Optional firmware file (or files) needed by the module
160 * format is simply firmware file name. Multiple firmware
161 * files require multiple MODULE_FIRMWARE() specifiers */
162 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
164 /* Given an address, look for it in the exception tables */
165 const struct exception_table_entry *search_exception_tables(unsigned long add);
167 struct notifier_block;
169 #ifdef CONFIG_MODULES
171 /* Get/put a kernel symbol (calls must be symmetric) */
172 void *__symbol_get(const char *symbol);
173 void *__symbol_get_gpl(const char *symbol);
174 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
177 #ifdef CONFIG_MODVERSIONS
178 /* Mark the CRC weak since genksyms apparently decides not to
179 * generate a checksums for some symbols */
180 #define __CRC_SYMBOL(sym, sec) \
181 extern void *__crc_##sym __attribute__((weak)); \
182 static const unsigned long __kcrctab_##sym \
184 __attribute__((section("__kcrctab" sec), unused)) \
185 = (unsigned long) &__crc_##sym;
187 #define __CRC_SYMBOL(sym, sec)
190 /* For every exported symbol, place a struct in the __ksymtab section */
191 #define __EXPORT_SYMBOL(sym, sec) \
192 extern typeof(sym) sym; \
193 __CRC_SYMBOL(sym, sec) \
194 static const char __kstrtab_##sym[] \
195 __attribute__((section("__ksymtab_strings"), aligned(1))) \
196 = MODULE_SYMBOL_PREFIX #sym; \
197 static const struct kernel_symbol __ksymtab_##sym \
199 __attribute__((section("__ksymtab" sec), unused)) \
200 = { (unsigned long)&sym, __kstrtab_##sym }
202 #define EXPORT_SYMBOL(sym) \
203 __EXPORT_SYMBOL(sym, "")
205 #define EXPORT_SYMBOL_GPL(sym) \
206 __EXPORT_SYMBOL(sym, "_gpl")
208 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
209 __EXPORT_SYMBOL(sym, "_gpl_future")
212 #ifdef CONFIG_UNUSED_SYMBOLS
213 #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
214 #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
216 #define EXPORT_UNUSED_SYMBOL(sym)
217 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
231 enum module_state state;
233 /* Member of list of modules */
234 struct list_head list;
236 /* Unique handle for this module */
237 char name[MODULE_NAME_LEN];
240 struct module_kobject mkobj;
241 struct module_attribute *modinfo_attrs;
243 const char *srcversion;
244 struct kobject *holders_dir;
246 /* Exported symbols */
247 const struct kernel_symbol *syms;
248 const unsigned long *crcs;
249 unsigned int num_syms;
251 /* Kernel parameters. */
252 struct kernel_param *kp;
255 /* GPL-only exported symbols. */
256 unsigned int num_gpl_syms;
257 const struct kernel_symbol *gpl_syms;
258 const unsigned long *gpl_crcs;
260 #ifdef CONFIG_UNUSED_SYMBOLS
261 /* unused exported symbols. */
262 const struct kernel_symbol *unused_syms;
263 const unsigned long *unused_crcs;
264 unsigned int num_unused_syms;
266 /* GPL-only, unused exported symbols. */
267 unsigned int num_unused_gpl_syms;
268 const struct kernel_symbol *unused_gpl_syms;
269 const unsigned long *unused_gpl_crcs;
272 /* symbols that will be GPL-only in the near future. */
273 const struct kernel_symbol *gpl_future_syms;
274 const unsigned long *gpl_future_crcs;
275 unsigned int num_gpl_future_syms;
277 /* Exception table */
278 unsigned int num_exentries;
279 struct exception_table_entry *extable;
281 /* Startup function. */
284 /* If this is non-NULL, vfree after init() returns */
287 /* Here is the actual code + data, vfree'd on unload. */
290 /* Here are the sizes of the init and core sections */
291 unsigned int init_size, core_size;
293 /* The size of the executable code in each section. */
294 unsigned int init_text_size, core_text_size;
296 /* Arch-specific module values */
297 struct mod_arch_specific arch;
299 unsigned int taints; /* same bits as kernel:tainted */
301 #ifdef CONFIG_GENERIC_BUG
302 /* Support for BUG */
304 struct list_head bug_list;
305 struct bug_entry *bug_table;
308 #ifdef CONFIG_KALLSYMS
309 /* We keep the symbol and string tables for kallsyms. */
311 unsigned int num_symtab;
314 /* Section attributes */
315 struct module_sect_attrs *sect_attrs;
317 /* Notes attributes */
318 struct module_notes_attrs *notes_attrs;
324 /* The command line arguments (may be mangled). People like
325 keeping pointers to this stuff */
327 #ifdef CONFIG_MARKERS
328 struct marker *markers;
329 unsigned int num_markers;
331 #ifdef CONFIG_TRACEPOINTS
332 struct tracepoint *tracepoints;
333 unsigned int num_tracepoints;
336 #ifdef CONFIG_TRACING
337 const char **trace_bprintk_fmt_start;
338 unsigned int num_trace_bprintk_fmt;
340 #ifdef CONFIG_EVENT_TRACING
341 struct ftrace_event_call *trace_events;
342 unsigned int num_trace_events;
345 #ifdef CONFIG_MODULE_UNLOAD
346 /* What modules depend on me? */
347 struct list_head modules_which_use_me;
349 /* Who is waiting for us to be unloaded */
350 struct task_struct *waiter;
352 /* Destruction function. */
362 #ifndef MODULE_ARCH_INIT
363 #define MODULE_ARCH_INIT {}
366 extern struct mutex module_mutex;
368 /* FIXME: It'd be nice to isolate modules during init, too, so they
369 aren't used before they (may) fail. But presently too much code
370 (IDE & SCSI) require entry into the module during init.*/
371 static inline int module_is_live(struct module *mod)
373 return mod->state != MODULE_STATE_GOING;
376 struct module *__module_text_address(unsigned long addr);
377 struct module *__module_address(unsigned long addr);
378 bool is_module_address(unsigned long addr);
379 bool is_module_text_address(unsigned long addr);
381 static inline int within_module_core(unsigned long addr, struct module *mod)
383 return (unsigned long)mod->module_core <= addr &&
384 addr < (unsigned long)mod->module_core + mod->core_size;
387 static inline int within_module_init(unsigned long addr, struct module *mod)
389 return (unsigned long)mod->module_init <= addr &&
390 addr < (unsigned long)mod->module_init + mod->init_size;
393 /* Search for module by name: must hold module_mutex. */
394 struct module *find_module(const char *name);
397 const struct kernel_symbol *start, *stop;
398 const unsigned long *crcs;
407 /* Search for an exported symbol by name. */
408 const struct kernel_symbol *find_symbol(const char *name,
409 struct module **owner,
410 const unsigned long **crc,
414 /* Walk the exported symbol table */
415 bool each_symbol(bool (*fn)(const struct symsearch *arr, struct module *owner,
416 unsigned int symnum, void *data), void *data);
418 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
419 symnum out of range. */
420 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
421 char *name, char *module_name, int *exported);
423 /* Look for this name: can be of form module:name. */
424 unsigned long module_kallsyms_lookup_name(const char *name);
426 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
427 struct module *, unsigned long),
430 extern void __module_put_and_exit(struct module *mod, long code)
431 __attribute__((noreturn));
432 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
434 #ifdef CONFIG_MODULE_UNLOAD
435 unsigned int module_refcount(struct module *mod);
436 void __symbol_put(const char *symbol);
437 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
438 void symbol_put_addr(void *addr);
440 static inline local_t *__module_ref_addr(struct module *mod, int cpu)
443 return (local_t *) (mod->refptr + per_cpu_offset(cpu));
449 /* Sometimes we know we already have a refcount, and it's easier not
450 to handle the error case (which only happens with rmmod --wait). */
451 static inline void __module_get(struct module *module)
454 local_inc(__module_ref_addr(module, get_cpu()));
459 static inline int try_module_get(struct module *module)
464 unsigned int cpu = get_cpu();
465 if (likely(module_is_live(module)))
466 local_inc(__module_ref_addr(module, cpu));
474 extern void module_put(struct module *module);
476 #else /*!CONFIG_MODULE_UNLOAD*/
477 static inline int try_module_get(struct module *module)
479 return !module || module_is_live(module);
481 static inline void module_put(struct module *module)
484 static inline void __module_get(struct module *module)
487 #define symbol_put(x) do { } while(0)
488 #define symbol_put_addr(p) do { } while(0)
490 #endif /* CONFIG_MODULE_UNLOAD */
491 int use_module(struct module *a, struct module *b);
493 /* This is a #define so the string doesn't get put in every .o file */
494 #define module_name(mod) \
496 struct module *__mod = (mod); \
497 __mod ? __mod->name : "kernel"; \
500 /* For kallsyms to ask for address resolution. namebuf should be at
501 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
502 * found, otherwise NULL. */
503 const char *module_address_lookup(unsigned long addr,
504 unsigned long *symbolsize,
505 unsigned long *offset,
508 int lookup_module_symbol_name(unsigned long addr, char *symname);
509 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
511 /* For extable.c to search modules' exception tables. */
512 const struct exception_table_entry *search_module_extables(unsigned long addr);
514 int register_module_notifier(struct notifier_block * nb);
515 int unregister_module_notifier(struct notifier_block * nb);
517 extern void print_modules(void);
519 extern void module_update_markers(void);
521 extern void module_update_tracepoints(void);
522 extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);
524 #else /* !CONFIG_MODULES... */
525 #define EXPORT_SYMBOL(sym)
526 #define EXPORT_SYMBOL_GPL(sym)
527 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
528 #define EXPORT_UNUSED_SYMBOL(sym)
529 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
531 /* Given an address, look for it in the exception tables. */
532 static inline const struct exception_table_entry *
533 search_module_extables(unsigned long addr)
538 static inline struct module *__module_address(unsigned long addr)
543 static inline struct module *__module_text_address(unsigned long addr)
548 static inline bool is_module_address(unsigned long addr)
553 static inline bool is_module_text_address(unsigned long addr)
558 /* Get/put a kernel symbol (calls should be symmetric) */
559 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
560 #define symbol_put(x) do { } while(0)
561 #define symbol_put_addr(x) do { } while(0)
563 static inline void __module_get(struct module *module)
567 static inline int try_module_get(struct module *module)
572 static inline void module_put(struct module *module)
576 #define module_name(mod) "kernel"
578 /* For kallsyms to ask for address resolution. NULL means not found. */
579 static inline const char *module_address_lookup(unsigned long addr,
580 unsigned long *symbolsize,
581 unsigned long *offset,
588 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
593 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
598 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
599 char *type, char *name,
600 char *module_name, int *exported)
605 static inline unsigned long module_kallsyms_lookup_name(const char *name)
610 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
618 static inline int register_module_notifier(struct notifier_block * nb)
620 /* no events will happen anyway, so this can always succeed */
624 static inline int unregister_module_notifier(struct notifier_block * nb)
629 #define module_put_and_exit(code) do_exit(code)
631 static inline void print_modules(void)
635 static inline void module_update_markers(void)
639 static inline void module_update_tracepoints(void)
643 static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
648 #endif /* CONFIG_MODULES */
650 struct device_driver;
654 extern struct kset *module_kset;
655 extern struct kobj_type module_ktype;
656 extern int module_sysfs_initialized;
658 int mod_sysfs_init(struct module *mod);
659 int mod_sysfs_setup(struct module *mod,
660 struct kernel_param *kparam,
661 unsigned int num_params);
662 int module_add_modinfo_attrs(struct module *mod);
663 void module_remove_modinfo_attrs(struct module *mod);
665 #else /* !CONFIG_SYSFS */
667 static inline int mod_sysfs_init(struct module *mod)
672 static inline int mod_sysfs_setup(struct module *mod,
673 struct kernel_param *kparam,
674 unsigned int num_params)
679 static inline int module_add_modinfo_attrs(struct module *mod)
684 static inline void module_remove_modinfo_attrs(struct module *mod)
687 #endif /* CONFIG_SYSFS */
689 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
691 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
693 #define __MODULE_STRING(x) __stringify(x)
695 #endif /* _LINUX_MODULE_H */