Merge git://git.kernel.org/pub/scm/linux/kernel/git/rusty/linux-2.6-for-linus
[linux-2.6.git] / include / linux / module.h
1 #ifndef _LINUX_MODULE_H
2 #define _LINUX_MODULE_H
3 /*
4  * Dynamic loading of modules into the kernel.
5  *
6  * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
7  * Rewritten again by Rusty Russell, 2002
8  */
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 <asm/local.h>
20
21 #include <asm/module.h>
22
23 /* Not Yet Implemented */
24 #define MODULE_SUPPORTED_DEVICE(name)
25
26 /* v850 toolchain uses a `_' prefix for all user symbols */
27 #ifndef MODULE_SYMBOL_PREFIX
28 #define MODULE_SYMBOL_PREFIX ""
29 #endif
30
31 #define MODULE_NAME_LEN (64 - sizeof(unsigned long))
32
33 struct kernel_symbol
34 {
35         unsigned long value;
36         const char *name;
37 };
38
39 struct modversion_info
40 {
41         unsigned long crc;
42         char name[MODULE_NAME_LEN];
43 };
44
45 struct module;
46
47 struct module_attribute {
48         struct attribute attr;
49         ssize_t (*show)(struct module_attribute *, struct module *, char *);
50         ssize_t (*store)(struct module_attribute *, struct module *,
51                          const char *, size_t count);
52         void (*setup)(struct module *, const char *);
53         int (*test)(struct module *);
54         void (*free)(struct module *);
55 };
56
57 struct module_kobject
58 {
59         struct kobject kobj;
60         struct module *mod;
61         struct kobject *drivers_dir;
62 };
63
64 /* These are either module local, or the kernel's dummy ones. */
65 extern int init_module(void);
66 extern void cleanup_module(void);
67
68 /* Archs provide a method of finding the correct exception table. */
69 struct exception_table_entry;
70
71 const struct exception_table_entry *
72 search_extable(const struct exception_table_entry *first,
73                const struct exception_table_entry *last,
74                unsigned long value);
75 void sort_extable(struct exception_table_entry *start,
76                   struct exception_table_entry *finish);
77 void sort_main_extable(void);
78
79 #ifdef MODULE
80 #define MODULE_GENERIC_TABLE(gtype,name)                        \
81 extern const struct gtype##_id __mod_##gtype##_table            \
82   __attribute__ ((unused, alias(__stringify(name))))
83
84 extern struct module __this_module;
85 #define THIS_MODULE (&__this_module)
86 #else  /* !MODULE */
87 #define MODULE_GENERIC_TABLE(gtype,name)
88 #define THIS_MODULE ((struct module *)0)
89 #endif
90
91 /* Generic info of form tag = "info" */
92 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
93
94 /* For userspace: you can also call me... */
95 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
96
97 /*
98  * The following license idents are currently accepted as indicating free
99  * software modules
100  *
101  *      "GPL"                           [GNU Public License v2 or later]
102  *      "GPL v2"                        [GNU Public License v2]
103  *      "GPL and additional rights"     [GNU Public License v2 rights and more]
104  *      "Dual BSD/GPL"                  [GNU Public License v2
105  *                                       or BSD license choice]
106  *      "Dual MIT/GPL"                  [GNU Public License v2
107  *                                       or MIT license choice]
108  *      "Dual MPL/GPL"                  [GNU Public License v2
109  *                                       or Mozilla license choice]
110  *
111  * The following other idents are available
112  *
113  *      "Proprietary"                   [Non free products]
114  *
115  * There are dual licensed components, but when running with Linux it is the
116  * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
117  * is a GPL combined work.
118  *
119  * This exists for several reasons
120  * 1.   So modinfo can show license info for users wanting to vet their setup 
121  *      is free
122  * 2.   So the community can ignore bug reports including proprietary modules
123  * 3.   So vendors can do likewise based on their own policies
124  */
125 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
126
127 /* Author, ideally of form NAME[, NAME]*[ and NAME] */
128 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
129   
130 /* What your module does. */
131 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
132
133 /* One for each parameter, describing how to use it.  Some files do
134    multiple of these per line, so can't just use MODULE_INFO. */
135 #define MODULE_PARM_DESC(_parm, desc) \
136         __MODULE_INFO(parm, _parm, #_parm ":" desc)
137
138 #define MODULE_DEVICE_TABLE(type,name)          \
139   MODULE_GENERIC_TABLE(type##_device,name)
140
141 /* Version of form [<epoch>:]<version>[-<extra-version>].
142    Or for CVS/RCS ID version, everything but the number is stripped.
143   <epoch>: A (small) unsigned integer which allows you to start versions
144            anew. If not mentioned, it's zero.  eg. "2:1.0" is after
145            "1:2.0".
146   <version>: The <version> may contain only alphanumerics and the
147            character `.'.  Ordered by numeric sort for numeric parts,
148            ascii sort for ascii parts (as per RPM or DEB algorithm).
149   <extraversion>: Like <version>, but inserted for local
150            customizations, eg "rh3" or "rusty1".
151
152   Using this automatically adds a checksum of the .c files and the
153   local headers in "srcversion".
154 */
155 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
156
157 /* Optional firmware file (or files) needed by the module
158  * format is simply firmware file name.  Multiple firmware
159  * files require multiple MODULE_FIRMWARE() specifiers */
160 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
161
162 /* Given an address, look for it in the exception tables */
163 const struct exception_table_entry *search_exception_tables(unsigned long add);
164
165 struct notifier_block;
166
167 #ifdef CONFIG_MODULES
168
169 /* Get/put a kernel symbol (calls must be symmetric) */
170 void *__symbol_get(const char *symbol);
171 void *__symbol_get_gpl(const char *symbol);
172 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
173
174 #ifndef __GENKSYMS__
175 #ifdef CONFIG_MODVERSIONS
176 /* Mark the CRC weak since genksyms apparently decides not to
177  * generate a checksums for some symbols */
178 #define __CRC_SYMBOL(sym, sec)                                  \
179         extern void *__crc_##sym __attribute__((weak));         \
180         static const unsigned long __kcrctab_##sym              \
181         __used                                                  \
182         __attribute__((section("__kcrctab" sec), unused))       \
183         = (unsigned long) &__crc_##sym;
184 #else
185 #define __CRC_SYMBOL(sym, sec)
186 #endif
187
188 /* For every exported symbol, place a struct in the __ksymtab section */
189 #define __EXPORT_SYMBOL(sym, sec)                               \
190         extern typeof(sym) sym;                                 \
191         __CRC_SYMBOL(sym, sec)                                  \
192         static const char __kstrtab_##sym[]                     \
193         __attribute__((section("__ksymtab_strings"), aligned(1))) \
194         = MODULE_SYMBOL_PREFIX #sym;                            \
195         static const struct kernel_symbol __ksymtab_##sym       \
196         __used                                                  \
197         __attribute__((section("__ksymtab" sec), unused))       \
198         = { (unsigned long)&sym, __kstrtab_##sym }
199
200 #define EXPORT_SYMBOL(sym)                                      \
201         __EXPORT_SYMBOL(sym, "")
202
203 #define EXPORT_SYMBOL_GPL(sym)                                  \
204         __EXPORT_SYMBOL(sym, "_gpl")
205
206 #define EXPORT_SYMBOL_GPL_FUTURE(sym)                           \
207         __EXPORT_SYMBOL(sym, "_gpl_future")
208
209
210 #ifdef CONFIG_UNUSED_SYMBOLS
211 #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
212 #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
213 #else
214 #define EXPORT_UNUSED_SYMBOL(sym)
215 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
216 #endif
217
218 #endif
219
220 struct module_ref
221 {
222         local_t count;
223 } ____cacheline_aligned;
224
225 enum module_state
226 {
227         MODULE_STATE_LIVE,
228         MODULE_STATE_COMING,
229         MODULE_STATE_GOING,
230 };
231
232 struct module
233 {
234         enum module_state state;
235
236         /* Member of list of modules */
237         struct list_head list;
238
239         /* Unique handle for this module */
240         char name[MODULE_NAME_LEN];
241
242         /* Sysfs stuff. */
243         struct module_kobject mkobj;
244         struct module_param_attrs *param_attrs;
245         struct module_attribute *modinfo_attrs;
246         const char *version;
247         const char *srcversion;
248         struct kobject *holders_dir;
249
250         /* Exported symbols */
251         const struct kernel_symbol *syms;
252         unsigned int num_syms;
253         const unsigned long *crcs;
254
255         /* GPL-only exported symbols. */
256         const struct kernel_symbol *gpl_syms;
257         unsigned int num_gpl_syms;
258         const unsigned long *gpl_crcs;
259
260         /* unused exported symbols. */
261         const struct kernel_symbol *unused_syms;
262         unsigned int num_unused_syms;
263         const unsigned long *unused_crcs;
264         /* GPL-only, unused exported symbols. */
265         const struct kernel_symbol *unused_gpl_syms;
266         unsigned int num_unused_gpl_syms;
267         const unsigned long *unused_gpl_crcs;
268
269         /* symbols that will be GPL-only in the near future. */
270         const struct kernel_symbol *gpl_future_syms;
271         unsigned int num_gpl_future_syms;
272         const unsigned long *gpl_future_crcs;
273
274         /* Exception table */
275         unsigned int num_exentries;
276         const struct exception_table_entry *extable;
277
278         /* Startup function. */
279         int (*init)(void);
280
281         /* If this is non-NULL, vfree after init() returns */
282         void *module_init;
283
284         /* Here is the actual code + data, vfree'd on unload. */
285         void *module_core;
286
287         /* Here are the sizes of the init and core sections */
288         unsigned long init_size, core_size;
289
290         /* The size of the executable code in each section.  */
291         unsigned long init_text_size, core_text_size;
292
293         /* The handle returned from unwind_add_table. */
294         void *unwind_info;
295
296         /* Arch-specific module values */
297         struct mod_arch_specific arch;
298
299         unsigned int taints;    /* same bits as kernel:tainted */
300
301 #ifdef CONFIG_GENERIC_BUG
302         /* Support for BUG */
303         struct list_head bug_list;
304         struct bug_entry *bug_table;
305         unsigned num_bugs;
306 #endif
307
308 #ifdef CONFIG_MODULE_UNLOAD
309         /* Reference counts */
310         struct module_ref ref[NR_CPUS];
311
312         /* What modules depend on me? */
313         struct list_head modules_which_use_me;
314
315         /* Who is waiting for us to be unloaded */
316         struct task_struct *waiter;
317
318         /* Destruction function. */
319         void (*exit)(void);
320 #endif
321
322 #ifdef CONFIG_KALLSYMS
323         /* We keep the symbol and string tables for kallsyms. */
324         Elf_Sym *symtab;
325         unsigned long num_symtab;
326         char *strtab;
327
328         /* Section attributes */
329         struct module_sect_attrs *sect_attrs;
330
331         /* Notes attributes */
332         struct module_notes_attrs *notes_attrs;
333 #endif
334
335         /* Per-cpu data. */
336         void *percpu;
337
338         /* The command line arguments (may be mangled).  People like
339            keeping pointers to this stuff */
340         char *args;
341 #ifdef CONFIG_MARKERS
342         struct marker *markers;
343         unsigned int num_markers;
344 #endif
345 };
346 #ifndef MODULE_ARCH_INIT
347 #define MODULE_ARCH_INIT {}
348 #endif
349
350 /* FIXME: It'd be nice to isolate modules during init, too, so they
351    aren't used before they (may) fail.  But presently too much code
352    (IDE & SCSI) require entry into the module during init.*/
353 static inline int module_is_live(struct module *mod)
354 {
355         return mod->state != MODULE_STATE_GOING;
356 }
357
358 /* Is this address in a module? (second is with no locks, for oops) */
359 struct module *module_text_address(unsigned long addr);
360 struct module *__module_text_address(unsigned long addr);
361 int is_module_address(unsigned long addr);
362
363 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
364    symnum out of range. */
365 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
366                         char *name, char *module_name, int *exported);
367
368 /* Look for this name: can be of form module:name. */
369 unsigned long module_kallsyms_lookup_name(const char *name);
370
371 extern void __module_put_and_exit(struct module *mod, long code)
372         __attribute__((noreturn));
373 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
374
375 #ifdef CONFIG_MODULE_UNLOAD
376 unsigned int module_refcount(struct module *mod);
377 void __symbol_put(const char *symbol);
378 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
379 void symbol_put_addr(void *addr);
380
381 /* Sometimes we know we already have a refcount, and it's easier not
382    to handle the error case (which only happens with rmmod --wait). */
383 static inline void __module_get(struct module *module)
384 {
385         if (module) {
386                 BUG_ON(module_refcount(module) == 0);
387                 local_inc(&module->ref[get_cpu()].count);
388                 put_cpu();
389         }
390 }
391
392 static inline int try_module_get(struct module *module)
393 {
394         int ret = 1;
395
396         if (module) {
397                 unsigned int cpu = get_cpu();
398                 if (likely(module_is_live(module)))
399                         local_inc(&module->ref[cpu].count);
400                 else
401                         ret = 0;
402                 put_cpu();
403         }
404         return ret;
405 }
406
407 extern void module_put(struct module *module);
408
409 #else /*!CONFIG_MODULE_UNLOAD*/
410 static inline int try_module_get(struct module *module)
411 {
412         return !module || module_is_live(module);
413 }
414 static inline void module_put(struct module *module)
415 {
416 }
417 static inline void __module_get(struct module *module)
418 {
419 }
420 #define symbol_put(x) do { } while(0)
421 #define symbol_put_addr(p) do { } while(0)
422
423 #endif /* CONFIG_MODULE_UNLOAD */
424
425 /* This is a #define so the string doesn't get put in every .o file */
426 #define module_name(mod)                        \
427 ({                                              \
428         struct module *__mod = (mod);           \
429         __mod ? __mod->name : "kernel";         \
430 })
431
432 /* For kallsyms to ask for address resolution.  namebuf should be at
433  * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
434  * found, otherwise NULL. */
435 const char *module_address_lookup(unsigned long addr,
436                             unsigned long *symbolsize,
437                             unsigned long *offset,
438                             char **modname,
439                             char *namebuf);
440 int lookup_module_symbol_name(unsigned long addr, char *symname);
441 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
442
443 /* For extable.c to search modules' exception tables. */
444 const struct exception_table_entry *search_module_extables(unsigned long addr);
445
446 int register_module_notifier(struct notifier_block * nb);
447 int unregister_module_notifier(struct notifier_block * nb);
448
449 extern void print_modules(void);
450
451 extern void module_update_markers(void);
452
453 #else /* !CONFIG_MODULES... */
454 #define EXPORT_SYMBOL(sym)
455 #define EXPORT_SYMBOL_GPL(sym)
456 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
457 #define EXPORT_UNUSED_SYMBOL(sym)
458 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
459
460 /* Given an address, look for it in the exception tables. */
461 static inline const struct exception_table_entry *
462 search_module_extables(unsigned long addr)
463 {
464         return NULL;
465 }
466
467 /* Is this address in a module? */
468 static inline struct module *module_text_address(unsigned long addr)
469 {
470         return NULL;
471 }
472
473 /* Is this address in a module? (don't take a lock, we're oopsing) */
474 static inline struct module *__module_text_address(unsigned long addr)
475 {
476         return NULL;
477 }
478
479 static inline int is_module_address(unsigned long addr)
480 {
481         return 0;
482 }
483
484 /* Get/put a kernel symbol (calls should be symmetric) */
485 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
486 #define symbol_put(x) do { } while(0)
487 #define symbol_put_addr(x) do { } while(0)
488
489 static inline void __module_get(struct module *module)
490 {
491 }
492
493 static inline int try_module_get(struct module *module)
494 {
495         return 1;
496 }
497
498 static inline void module_put(struct module *module)
499 {
500 }
501
502 #define module_name(mod) "kernel"
503
504 /* For kallsyms to ask for address resolution.  NULL means not found. */
505 static inline const char *module_address_lookup(unsigned long addr,
506                                           unsigned long *symbolsize,
507                                           unsigned long *offset,
508                                           char **modname,
509                                           char *namebuf)
510 {
511         return NULL;
512 }
513
514 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
515 {
516         return -ERANGE;
517 }
518
519 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
520 {
521         return -ERANGE;
522 }
523
524 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
525                                         char *type, char *name,
526                                         char *module_name, int *exported)
527 {
528         return -ERANGE;
529 }
530
531 static inline unsigned long module_kallsyms_lookup_name(const char *name)
532 {
533         return 0;
534 }
535
536 static inline int register_module_notifier(struct notifier_block * nb)
537 {
538         /* no events will happen anyway, so this can always succeed */
539         return 0;
540 }
541
542 static inline int unregister_module_notifier(struct notifier_block * nb)
543 {
544         return 0;
545 }
546
547 #define module_put_and_exit(code) do_exit(code)
548
549 static inline void print_modules(void)
550 {
551 }
552
553 static inline void module_update_markers(void)
554 {
555 }
556
557 #endif /* CONFIG_MODULES */
558
559 struct device_driver;
560 #ifdef CONFIG_SYSFS
561 struct module;
562
563 extern struct kset *module_kset;
564 extern struct kobj_type module_ktype;
565 extern int module_sysfs_initialized;
566
567 int mod_sysfs_init(struct module *mod);
568 int mod_sysfs_setup(struct module *mod,
569                            struct kernel_param *kparam,
570                            unsigned int num_params);
571 int module_add_modinfo_attrs(struct module *mod);
572 void module_remove_modinfo_attrs(struct module *mod);
573
574 #else /* !CONFIG_SYSFS */
575
576 static inline int mod_sysfs_init(struct module *mod)
577 {
578         return 0;
579 }
580
581 static inline int mod_sysfs_setup(struct module *mod,
582                            struct kernel_param *kparam,
583                            unsigned int num_params)
584 {
585         return 0;
586 }
587
588 static inline int module_add_modinfo_attrs(struct module *mod)
589 {
590         return 0;
591 }
592
593 static inline void module_remove_modinfo_attrs(struct module *mod)
594 { }
595
596 #endif /* CONFIG_SYSFS */
597
598 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
599
600 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
601
602 #define __MODULE_STRING(x) __stringify(x)
603
604 #endif /* _LINUX_MODULE_H */