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