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/config.h>
10 #include <linux/sched.h>
11 #include <linux/spinlock.h>
12 #include <linux/list.h>
13 #include <linux/stat.h>
14 #include <linux/compiler.h>
15 #include <linux/cache.h>
16 #include <linux/kmod.h>
17 #include <linux/elf.h>
18 #include <linux/stringify.h>
19 #include <linux/kobject.h>
20 #include <linux/moduleparam.h>
21 #include <asm/local.h>
23 #include <asm/module.h>
25 /* Not Yet Implemented */
26 #define MODULE_SUPPORTED_DEVICE(name)
28 /* v850 toolchain uses a `_' prefix for all user symbols */
29 #ifndef MODULE_SYMBOL_PREFIX
30 #define MODULE_SYMBOL_PREFIX ""
33 #define MODULE_NAME_LEN (64 - sizeof(unsigned long))
41 struct modversion_info
44 char name[MODULE_NAME_LEN];
49 struct module_attribute {
50 struct attribute attr;
51 ssize_t (*show)(struct module_attribute *, struct module *, char *);
52 ssize_t (*store)(struct module_attribute *, struct module *,
53 const char *, size_t count);
54 void (*setup)(struct module *, const char *);
55 int (*test)(struct module *);
56 void (*free)(struct module *);
65 /* These are either module local, or the kernel's dummy ones. */
66 extern int init_module(void);
67 extern void cleanup_module(void);
69 /* Archs provide a method of finding the correct exception table. */
70 struct exception_table_entry;
72 const struct exception_table_entry *
73 search_extable(const struct exception_table_entry *first,
74 const struct exception_table_entry *last,
76 void sort_extable(struct exception_table_entry *start,
77 struct exception_table_entry *finish);
78 void sort_main_extable(void);
80 extern struct subsystem module_subsys;
83 #define MODULE_GENERIC_TABLE(gtype,name) \
84 extern const struct gtype##_id __mod_##gtype##_table \
85 __attribute__ ((unused, alias(__stringify(name))))
87 extern struct module __this_module;
88 #define THIS_MODULE (&__this_module)
90 #define MODULE_GENERIC_TABLE(gtype,name)
91 #define THIS_MODULE ((struct module *)0)
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)
101 * The following license idents are currently accepted as indicating free
104 * "GPL" [GNU Public License v2 or later]
105 * "GPL v2" [GNU Public License v2]
106 * "GPL and additional rights" [GNU Public License v2 rights and more]
107 * "Dual BSD/GPL" [GNU Public License v2
108 * or BSD license choice]
109 * "Dual MPL/GPL" [GNU Public License v2
110 * or Mozilla license choice]
112 * The following other idents are available
114 * "Proprietary" [Non free products]
116 * There are dual licensed components, but when running with Linux it is the
117 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
118 * is a GPL combined work.
120 * This exists for several reasons
121 * 1. So modinfo can show license info for users wanting to vet their setup
123 * 2. So the community can ignore bug reports including proprietary modules
124 * 3. So vendors can do likewise based on their own policies
126 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
128 /* Author, ideally of form NAME <EMAIL>[, NAME <EMAIL>]*[ and NAME <EMAIL>] */
129 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
131 /* What your module does. */
132 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
134 /* One for each parameter, describing how to use it. Some files do
135 multiple of these per line, so can't just use MODULE_INFO. */
136 #define MODULE_PARM_DESC(_parm, desc) \
137 __MODULE_INFO(parm, _parm, #_parm ":" desc)
139 #define MODULE_DEVICE_TABLE(type,name) \
140 MODULE_GENERIC_TABLE(type##_device,name)
142 /* Version of form [<epoch>:]<version>[-<extra-version>].
143 Or for CVS/RCS ID version, everything but the number is stripped.
144 <epoch>: A (small) unsigned integer which allows you to start versions
145 anew. If not mentioned, it's zero. eg. "2:1.0" is after
147 <version>: The <version> may contain only alphanumerics and the
148 character `.'. Ordered by numeric sort for numeric parts,
149 ascii sort for ascii parts (as per RPM or DEB algorithm).
150 <extraversion>: Like <version>, but inserted for local
151 customizations, eg "rh3" or "rusty1".
153 Using this automatically adds a checksum of the .c files and the
154 local headers in "srcversion".
156 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
158 /* Given an address, look for it in the exception tables */
159 const struct exception_table_entry *search_exception_tables(unsigned long add);
161 struct notifier_block;
163 #ifdef CONFIG_MODULES
165 /* Get/put a kernel symbol (calls must be symmetric) */
166 void *__symbol_get(const char *symbol);
167 void *__symbol_get_gpl(const char *symbol);
168 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
171 #ifdef CONFIG_MODVERSIONS
172 /* Mark the CRC weak since genksyms apparently decides not to
173 * generate a checksums for some symbols */
174 #define __CRC_SYMBOL(sym, sec) \
175 extern void *__crc_##sym __attribute__((weak)); \
176 static const unsigned long __kcrctab_##sym \
178 __attribute__((section("__kcrctab" sec), unused)) \
179 = (unsigned long) &__crc_##sym;
181 #define __CRC_SYMBOL(sym, sec)
184 /* For every exported symbol, place a struct in the __ksymtab section */
185 #define __EXPORT_SYMBOL(sym, sec) \
186 __CRC_SYMBOL(sym, sec) \
187 static const char __kstrtab_##sym[] \
188 __attribute__((section("__ksymtab_strings"))) \
189 = MODULE_SYMBOL_PREFIX #sym; \
190 static const struct kernel_symbol __ksymtab_##sym \
192 __attribute__((section("__ksymtab" sec), unused)) \
193 = { (unsigned long)&sym, __kstrtab_##sym }
195 #define EXPORT_SYMBOL(sym) \
196 __EXPORT_SYMBOL(sym, "")
198 #define EXPORT_SYMBOL_GPL(sym) \
199 __EXPORT_SYMBOL(sym, "_gpl")
201 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
202 __EXPORT_SYMBOL(sym, "_gpl_future")
209 } ____cacheline_aligned;
218 /* Similar stuff for section attributes. */
219 #define MODULE_SECT_NAME_LEN 32
220 struct module_sect_attr
222 struct module_attribute mattr;
223 char name[MODULE_SECT_NAME_LEN];
224 unsigned long address;
227 struct module_sect_attrs
229 struct attribute_group grp;
230 struct module_sect_attr attrs[0];
233 struct module_param_attrs;
237 enum module_state state;
239 /* Member of list of modules */
240 struct list_head list;
242 /* Unique handle for this module */
243 char name[MODULE_NAME_LEN];
246 struct module_kobject mkobj;
247 struct module_param_attrs *param_attrs;
249 const char *srcversion;
251 /* Exported symbols */
252 const struct kernel_symbol *syms;
253 unsigned int num_syms;
254 const unsigned long *crcs;
256 /* GPL-only exported symbols. */
257 const struct kernel_symbol *gpl_syms;
258 unsigned int num_gpl_syms;
259 const unsigned long *gpl_crcs;
261 /* symbols that will be GPL-only in the near future. */
262 const struct kernel_symbol *gpl_future_syms;
263 unsigned int num_gpl_future_syms;
264 const unsigned long *gpl_future_crcs;
266 /* Exception table */
267 unsigned int num_exentries;
268 const struct exception_table_entry *extable;
270 /* Startup function. */
273 /* If this is non-NULL, vfree after init() returns */
276 /* Here is the actual code + data, vfree'd on unload. */
279 /* Here are the sizes of the init and core sections */
280 unsigned long init_size, core_size;
282 /* The size of the executable code in each section. */
283 unsigned long init_text_size, core_text_size;
285 /* Arch-specific module values */
286 struct mod_arch_specific arch;
288 /* Am I unsafe to unload? */
291 /* Am I GPL-compatible */
294 #ifdef CONFIG_MODULE_UNLOAD
295 /* Reference counts */
296 struct module_ref ref[NR_CPUS];
298 /* What modules depend on me? */
299 struct list_head modules_which_use_me;
301 /* Who is waiting for us to be unloaded */
302 struct task_struct *waiter;
304 /* Destruction function. */
308 #ifdef CONFIG_KALLSYMS
309 /* We keep the symbol and string tables for kallsyms. */
311 unsigned long num_symtab;
314 /* Section attributes */
315 struct module_sect_attrs *sect_attrs;
321 /* The command line arguments (may be mangled). People like
322 keeping pointers to this stuff */
326 /* FIXME: It'd be nice to isolate modules during init, too, so they
327 aren't used before they (may) fail. But presently too much code
328 (IDE & SCSI) require entry into the module during init.*/
329 static inline int module_is_live(struct module *mod)
331 return mod->state != MODULE_STATE_GOING;
334 /* Is this address in a module? (second is with no locks, for oops) */
335 struct module *module_text_address(unsigned long addr);
336 struct module *__module_text_address(unsigned long addr);
338 /* Returns module and fills in value, defined and namebuf, or NULL if
339 symnum out of range. */
340 struct module *module_get_kallsym(unsigned int symnum,
341 unsigned long *value,
345 /* Look for this name: can be of form module:name. */
346 unsigned long module_kallsyms_lookup_name(const char *name);
348 int is_exported(const char *name, const struct module *mod);
350 extern void __module_put_and_exit(struct module *mod, long code)
351 __attribute__((noreturn));
352 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
354 #ifdef CONFIG_MODULE_UNLOAD
355 unsigned int module_refcount(struct module *mod);
356 void __symbol_put(const char *symbol);
357 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
358 void symbol_put_addr(void *addr);
360 /* Sometimes we know we already have a refcount, and it's easier not
361 to handle the error case (which only happens with rmmod --wait). */
362 static inline void __module_get(struct module *module)
365 BUG_ON(module_refcount(module) == 0);
366 local_inc(&module->ref[get_cpu()].count);
371 static inline int try_module_get(struct module *module)
376 unsigned int cpu = get_cpu();
377 if (likely(module_is_live(module)))
378 local_inc(&module->ref[cpu].count);
386 static inline void module_put(struct module *module)
389 unsigned int cpu = get_cpu();
390 local_dec(&module->ref[cpu].count);
391 /* Maybe they're waiting for us to drop reference? */
392 if (unlikely(!module_is_live(module)))
393 wake_up_process(module->waiter);
398 #else /*!CONFIG_MODULE_UNLOAD*/
399 static inline int try_module_get(struct module *module)
401 return !module || module_is_live(module);
403 static inline void module_put(struct module *module)
406 static inline void __module_get(struct module *module)
409 #define symbol_put(x) do { } while(0)
410 #define symbol_put_addr(p) do { } while(0)
412 #endif /* CONFIG_MODULE_UNLOAD */
414 /* This is a #define so the string doesn't get put in every .o file */
415 #define module_name(mod) \
417 struct module *__mod = (mod); \
418 __mod ? __mod->name : "kernel"; \
421 #define __unsafe(mod) \
423 if (mod && !(mod)->unsafe) { \
424 printk(KERN_WARNING \
425 "Module %s cannot be unloaded due to unsafe usage in" \
426 " %s:%u\n", (mod)->name, __FILE__, __LINE__); \
431 /* For kallsyms to ask for address resolution. NULL means not found. */
432 const char *module_address_lookup(unsigned long addr,
433 unsigned long *symbolsize,
434 unsigned long *offset,
437 /* For extable.c to search modules' exception tables. */
438 const struct exception_table_entry *search_module_extables(unsigned long addr);
440 int register_module_notifier(struct notifier_block * nb);
441 int unregister_module_notifier(struct notifier_block * nb);
443 extern void print_modules(void);
445 struct device_driver;
446 void module_add_driver(struct module *, struct device_driver *);
447 void module_remove_driver(struct device_driver *);
449 #else /* !CONFIG_MODULES... */
450 #define EXPORT_SYMBOL(sym)
451 #define EXPORT_SYMBOL_GPL(sym)
452 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
454 /* Given an address, look for it in the exception tables. */
455 static inline const struct exception_table_entry *
456 search_module_extables(unsigned long addr)
461 /* Is this address in a module? */
462 static inline struct module *module_text_address(unsigned long addr)
467 /* Is this address in a module? (don't take a lock, we're oopsing) */
468 static inline struct module *__module_text_address(unsigned long addr)
473 /* Get/put a kernel symbol (calls should be symmetric) */
474 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
475 #define symbol_put(x) do { } while(0)
476 #define symbol_put_addr(x) do { } while(0)
478 static inline void __module_get(struct module *module)
482 static inline int try_module_get(struct module *module)
487 static inline void module_put(struct module *module)
491 #define module_name(mod) "kernel"
493 #define __unsafe(mod)
495 /* For kallsyms to ask for address resolution. NULL means not found. */
496 static inline const char *module_address_lookup(unsigned long addr,
497 unsigned long *symbolsize,
498 unsigned long *offset,
504 static inline struct module *module_get_kallsym(unsigned int symnum,
505 unsigned long *value,
512 static inline unsigned long module_kallsyms_lookup_name(const char *name)
517 static inline int is_exported(const char *name, const struct module *mod)
522 static inline int register_module_notifier(struct notifier_block * nb)
524 /* no events will happen anyway, so this can always succeed */
528 static inline int unregister_module_notifier(struct notifier_block * nb)
533 #define module_put_and_exit(code) do_exit(code)
535 static inline void print_modules(void)
539 struct device_driver;
542 static inline void module_add_driver(struct module *module, struct device_driver *driver)
546 static inline void module_remove_driver(struct device_driver *driver)
550 #endif /* CONFIG_MODULES */
552 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
554 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
556 struct obsolete_modparm {
558 char type[64-sizeof(void *)];
562 static inline void MODULE_PARM_(void) { }
564 /* DEPRECATED: Do not use. */
565 #define MODULE_PARM(var,type) \
566 extern struct obsolete_modparm __parm_##var \
567 __attribute__((section("__obsparm"))); \
568 struct obsolete_modparm __parm_##var = \
569 { __stringify(var), type, &MODULE_PARM_ }; \
570 __MODULE_PARM_TYPE(var, type);
572 #define MODULE_PARM(var,type) static void __attribute__((__unused__)) *__parm_##var = &MODULE_PARM_;
575 #define __MODULE_STRING(x) __stringify(x)
577 /* Use symbol_get and symbol_put instead. You'll thank me. */
578 #define HAVE_INTER_MODULE
579 extern void __deprecated inter_module_register(const char *,
580 struct module *, const void *);
581 extern void __deprecated inter_module_unregister(const char *);
582 extern const void * __deprecated inter_module_get_request(const char *,
584 extern void __deprecated inter_module_put(const char *);
586 #endif /* _LINUX_MODULE_H */