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