]> bbs.cooldavid.org Git - net-next-2.6.git/blob - include/linux/module.h
tracing/events: add support for modules to TRACE_EVENT
[net-next-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 <linux/tracepoint.h>
20 #include <asm/local.h>
21
22 #include <asm/module.h>
23
24 /* Not Yet Implemented */
25 #define MODULE_SUPPORTED_DEVICE(name)
26
27 /* some toolchains uses a `_' prefix for all user symbols */
28 #ifndef MODULE_SYMBOL_PREFIX
29 #define MODULE_SYMBOL_PREFIX ""
30 #endif
31
32 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
33
34 struct kernel_symbol
35 {
36         unsigned long value;
37         const char *name;
38 };
39
40 struct modversion_info
41 {
42         unsigned long crc;
43         char name[MODULE_NAME_LEN];
44 };
45
46 struct module;
47
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 *);
56 };
57
58 struct module_kobject
59 {
60         struct kobject kobj;
61         struct module *mod;
62         struct kobject *drivers_dir;
63         struct module_param_attrs *mp;
64 };
65
66 /* These are either module local, or the kernel's dummy ones. */
67 extern int init_module(void);
68 extern void cleanup_module(void);
69
70 /* Archs provide a method of finding the correct exception table. */
71 struct exception_table_entry;
72
73 const struct exception_table_entry *
74 search_extable(const struct exception_table_entry *first,
75                const struct exception_table_entry *last,
76                unsigned long value);
77 void sort_extable(struct exception_table_entry *start,
78                   struct exception_table_entry *finish);
79 void sort_main_extable(void);
80
81 #ifdef MODULE
82 #define MODULE_GENERIC_TABLE(gtype,name)                        \
83 extern const struct gtype##_id __mod_##gtype##_table            \
84   __attribute__ ((unused, alias(__stringify(name))))
85
86 extern struct module __this_module;
87 #define THIS_MODULE (&__this_module)
88 #else  /* !MODULE */
89 #define MODULE_GENERIC_TABLE(gtype,name)
90 #define THIS_MODULE ((struct module *)0)
91 #endif
92
93 /* Generic info of form tag = "info" */
94 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
95
96 /* For userspace: you can also call me... */
97 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
98
99 /*
100  * The following license idents are currently accepted as indicating free
101  * software modules
102  *
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]
112  *
113  * The following other idents are available
114  *
115  *      "Proprietary"                   [Non free products]
116  *
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.
120  *
121  * This exists for several reasons
122  * 1.   So modinfo can show license info for users wanting to vet their setup 
123  *      is free
124  * 2.   So the community can ignore bug reports including proprietary modules
125  * 3.   So vendors can do likewise based on their own policies
126  */
127 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
128
129 /* Author, ideally of form NAME[, NAME]*[ and NAME] */
130 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
131   
132 /* What your module does. */
133 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
134
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)
139
140 #define MODULE_DEVICE_TABLE(type,name)          \
141   MODULE_GENERIC_TABLE(type##_device,name)
142
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
147            "1:2.0".
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".
153
154   Using this automatically adds a checksum of the .c files and the
155   local headers in "srcversion".
156 */
157 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
158
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)
163
164 /* Given an address, look for it in the exception tables */
165 const struct exception_table_entry *search_exception_tables(unsigned long add);
166
167 struct notifier_block;
168
169 #ifdef CONFIG_MODULES
170
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)))
175
176 #ifndef __GENKSYMS__
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              \
183         __used                                                  \
184         __attribute__((section("__kcrctab" sec), unused))       \
185         = (unsigned long) &__crc_##sym;
186 #else
187 #define __CRC_SYMBOL(sym, sec)
188 #endif
189
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       \
198         __used                                                  \
199         __attribute__((section("__ksymtab" sec), unused))       \
200         = { (unsigned long)&sym, __kstrtab_##sym }
201
202 #define EXPORT_SYMBOL(sym)                                      \
203         __EXPORT_SYMBOL(sym, "")
204
205 #define EXPORT_SYMBOL_GPL(sym)                                  \
206         __EXPORT_SYMBOL(sym, "_gpl")
207
208 #define EXPORT_SYMBOL_GPL_FUTURE(sym)                           \
209         __EXPORT_SYMBOL(sym, "_gpl_future")
210
211
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")
215 #else
216 #define EXPORT_UNUSED_SYMBOL(sym)
217 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
218 #endif
219
220 #endif
221
222 enum module_state
223 {
224         MODULE_STATE_LIVE,
225         MODULE_STATE_COMING,
226         MODULE_STATE_GOING,
227 };
228
229 struct module
230 {
231         enum module_state state;
232
233         /* Member of list of modules */
234         struct list_head list;
235
236         /* Unique handle for this module */
237         char name[MODULE_NAME_LEN];
238
239         /* Sysfs stuff. */
240         struct module_kobject mkobj;
241         struct module_attribute *modinfo_attrs;
242         const char *version;
243         const char *srcversion;
244         struct kobject *holders_dir;
245
246         /* Exported symbols */
247         const struct kernel_symbol *syms;
248         const unsigned long *crcs;
249         unsigned int num_syms;
250
251         /* Kernel parameters. */
252         struct kernel_param *kp;
253         unsigned int num_kp;
254
255         /* GPL-only exported symbols. */
256         unsigned int num_gpl_syms;
257         const struct kernel_symbol *gpl_syms;
258         const unsigned long *gpl_crcs;
259
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;
265
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;
270 #endif
271
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;
276
277         /* Exception table */
278         unsigned int num_exentries;
279         struct exception_table_entry *extable;
280
281         /* Startup function. */
282         int (*init)(void);
283
284         /* If this is non-NULL, vfree after init() returns */
285         void *module_init;
286
287         /* Here is the actual code + data, vfree'd on unload. */
288         void *module_core;
289
290         /* Here are the sizes of the init and core sections */
291         unsigned int init_size, core_size;
292
293         /* The size of the executable code in each section.  */
294         unsigned int init_text_size, core_text_size;
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         unsigned num_bugs;
304         struct list_head bug_list;
305         struct bug_entry *bug_table;
306 #endif
307
308 #ifdef CONFIG_KALLSYMS
309         /* We keep the symbol and string tables for kallsyms. */
310         Elf_Sym *symtab;
311         unsigned int num_symtab;
312         char *strtab;
313
314         /* Section attributes */
315         struct module_sect_attrs *sect_attrs;
316
317         /* Notes attributes */
318         struct module_notes_attrs *notes_attrs;
319 #endif
320
321         /* Per-cpu data. */
322         void *percpu;
323
324         /* The command line arguments (may be mangled).  People like
325            keeping pointers to this stuff */
326         char *args;
327 #ifdef CONFIG_MARKERS
328         struct marker *markers;
329         unsigned int num_markers;
330 #endif
331 #ifdef CONFIG_TRACEPOINTS
332         struct tracepoint *tracepoints;
333         unsigned int num_tracepoints;
334 #endif
335
336 #ifdef CONFIG_TRACING
337         const char **trace_bprintk_fmt_start;
338         unsigned int num_trace_bprintk_fmt;
339 #endif
340 #ifdef CONFIG_EVENT_TRACING
341         struct ftrace_event_call *trace_events;
342         unsigned int num_trace_events;
343 #endif
344
345 #ifdef CONFIG_MODULE_UNLOAD
346         /* What modules depend on me? */
347         struct list_head modules_which_use_me;
348
349         /* Who is waiting for us to be unloaded */
350         struct task_struct *waiter;
351
352         /* Destruction function. */
353         void (*exit)(void);
354
355 #ifdef CONFIG_SMP
356         char *refptr;
357 #else
358         local_t ref;
359 #endif
360 #endif
361 };
362 #ifndef MODULE_ARCH_INIT
363 #define MODULE_ARCH_INIT {}
364 #endif
365
366 extern struct mutex module_mutex;
367
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)
372 {
373         return mod->state != MODULE_STATE_GOING;
374 }
375
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);
380
381 static inline int within_module_core(unsigned long addr, struct module *mod)
382 {
383         return (unsigned long)mod->module_core <= addr &&
384                addr < (unsigned long)mod->module_core + mod->core_size;
385 }
386
387 static inline int within_module_init(unsigned long addr, struct module *mod)
388 {
389         return (unsigned long)mod->module_init <= addr &&
390                addr < (unsigned long)mod->module_init + mod->init_size;
391 }
392
393 /* Search for module by name: must hold module_mutex. */
394 struct module *find_module(const char *name);
395
396 struct symsearch {
397         const struct kernel_symbol *start, *stop;
398         const unsigned long *crcs;
399         enum {
400                 NOT_GPL_ONLY,
401                 GPL_ONLY,
402                 WILL_BE_GPL_ONLY,
403         } licence;
404         bool unused;
405 };
406
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,
411                                         bool gplok,
412                                         bool warn);
413
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);
417
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);
422
423 /* Look for this name: can be of form module:name. */
424 unsigned long module_kallsyms_lookup_name(const char *name);
425
426 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
427                                              struct module *, unsigned long),
428                                    void *data);
429
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);
433
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);
439
440 static inline local_t *__module_ref_addr(struct module *mod, int cpu)
441 {
442 #ifdef CONFIG_SMP
443         return (local_t *) (mod->refptr + per_cpu_offset(cpu));
444 #else
445         return &mod->ref;
446 #endif
447 }
448
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)
452 {
453         if (module) {
454                 local_inc(__module_ref_addr(module, get_cpu()));
455                 put_cpu();
456         }
457 }
458
459 static inline int try_module_get(struct module *module)
460 {
461         int ret = 1;
462
463         if (module) {
464                 unsigned int cpu = get_cpu();
465                 if (likely(module_is_live(module)))
466                         local_inc(__module_ref_addr(module, cpu));
467                 else
468                         ret = 0;
469                 put_cpu();
470         }
471         return ret;
472 }
473
474 extern void module_put(struct module *module);
475
476 #else /*!CONFIG_MODULE_UNLOAD*/
477 static inline int try_module_get(struct module *module)
478 {
479         return !module || module_is_live(module);
480 }
481 static inline void module_put(struct module *module)
482 {
483 }
484 static inline void __module_get(struct module *module)
485 {
486 }
487 #define symbol_put(x) do { } while(0)
488 #define symbol_put_addr(p) do { } while(0)
489
490 #endif /* CONFIG_MODULE_UNLOAD */
491 int use_module(struct module *a, struct module *b);
492
493 /* This is a #define so the string doesn't get put in every .o file */
494 #define module_name(mod)                        \
495 ({                                              \
496         struct module *__mod = (mod);           \
497         __mod ? __mod->name : "kernel";         \
498 })
499
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,
506                             char **modname,
507                             char *namebuf);
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);
510
511 /* For extable.c to search modules' exception tables. */
512 const struct exception_table_entry *search_module_extables(unsigned long addr);
513
514 int register_module_notifier(struct notifier_block * nb);
515 int unregister_module_notifier(struct notifier_block * nb);
516
517 extern void print_modules(void);
518
519 extern void module_update_markers(void);
520
521 extern void module_update_tracepoints(void);
522 extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);
523
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)
530
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)
534 {
535         return NULL;
536 }
537
538 static inline struct module *__module_address(unsigned long addr)
539 {
540         return NULL;
541 }
542
543 static inline struct module *__module_text_address(unsigned long addr)
544 {
545         return NULL;
546 }
547
548 static inline bool is_module_address(unsigned long addr)
549 {
550         return false;
551 }
552
553 static inline bool is_module_text_address(unsigned long addr)
554 {
555         return false;
556 }
557
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)
562
563 static inline void __module_get(struct module *module)
564 {
565 }
566
567 static inline int try_module_get(struct module *module)
568 {
569         return 1;
570 }
571
572 static inline void module_put(struct module *module)
573 {
574 }
575
576 #define module_name(mod) "kernel"
577
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,
582                                           char **modname,
583                                           char *namebuf)
584 {
585         return NULL;
586 }
587
588 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
589 {
590         return -ERANGE;
591 }
592
593 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
594 {
595         return -ERANGE;
596 }
597
598 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
599                                         char *type, char *name,
600                                         char *module_name, int *exported)
601 {
602         return -ERANGE;
603 }
604
605 static inline unsigned long module_kallsyms_lookup_name(const char *name)
606 {
607         return 0;
608 }
609
610 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
611                                                            struct module *,
612                                                            unsigned long),
613                                                  void *data)
614 {
615         return 0;
616 }
617
618 static inline int register_module_notifier(struct notifier_block * nb)
619 {
620         /* no events will happen anyway, so this can always succeed */
621         return 0;
622 }
623
624 static inline int unregister_module_notifier(struct notifier_block * nb)
625 {
626         return 0;
627 }
628
629 #define module_put_and_exit(code) do_exit(code)
630
631 static inline void print_modules(void)
632 {
633 }
634
635 static inline void module_update_markers(void)
636 {
637 }
638
639 static inline void module_update_tracepoints(void)
640 {
641 }
642
643 static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
644 {
645         return 0;
646 }
647
648 #endif /* CONFIG_MODULES */
649
650 struct device_driver;
651 #ifdef CONFIG_SYSFS
652 struct module;
653
654 extern struct kset *module_kset;
655 extern struct kobj_type module_ktype;
656 extern int module_sysfs_initialized;
657
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);
664
665 #else /* !CONFIG_SYSFS */
666
667 static inline int mod_sysfs_init(struct module *mod)
668 {
669         return 0;
670 }
671
672 static inline int mod_sysfs_setup(struct module *mod,
673                            struct kernel_param *kparam,
674                            unsigned int num_params)
675 {
676         return 0;
677 }
678
679 static inline int module_add_modinfo_attrs(struct module *mod)
680 {
681         return 0;
682 }
683
684 static inline void module_remove_modinfo_attrs(struct module *mod)
685 { }
686
687 #endif /* CONFIG_SYSFS */
688
689 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
690
691 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
692
693 #define __MODULE_STRING(x) __stringify(x)
694
695 #endif /* _LINUX_MODULE_H */