kvm tools, setup: Create private directory
[linux-2.6/next.git] / include / linux / module.h
blobd9ca2d5dc6d0d974c5d57eb89479365d0a9f8796
1 #ifndef _LINUX_MODULE_H
2 #define _LINUX_MODULE_H
3 /*
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
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>
20 #include <linux/percpu.h>
21 #include <asm/module.h>
23 #include <trace/events/module.h>
25 /* Not Yet Implemented */
26 #define MODULE_SUPPORTED_DEVICE(name)
28 /* Some toolchains use a `_' prefix for all user symbols. */
29 #ifdef CONFIG_SYMBOL_PREFIX
30 #define MODULE_SYMBOL_PREFIX CONFIG_SYMBOL_PREFIX
31 #else
32 #define MODULE_SYMBOL_PREFIX ""
33 #endif
35 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
37 struct kernel_symbol
39 unsigned long value;
40 const char *name;
43 struct modversion_info
45 unsigned long crc;
46 char name[MODULE_NAME_LEN];
49 struct module;
51 struct module_attribute {
52 struct attribute attr;
53 ssize_t (*show)(struct module_attribute *, struct module *, char *);
54 ssize_t (*store)(struct module_attribute *, struct module *,
55 const char *, size_t count);
56 void (*setup)(struct module *, const char *);
57 int (*test)(struct module *);
58 void (*free)(struct module *);
61 struct module_version_attribute {
62 struct module_attribute mattr;
63 const char *module_name;
64 const char *version;
65 } __attribute__ ((__aligned__(sizeof(void *))));
67 extern ssize_t __modver_version_show(struct module_attribute *,
68 struct module *, char *);
70 struct module_kobject
72 struct kobject kobj;
73 struct module *mod;
74 struct kobject *drivers_dir;
75 struct module_param_attrs *mp;
78 /* These are either module local, or the kernel's dummy ones. */
79 extern int init_module(void);
80 extern void cleanup_module(void);
82 /* Archs provide a method of finding the correct exception table. */
83 struct exception_table_entry;
85 const struct exception_table_entry *
86 search_extable(const struct exception_table_entry *first,
87 const struct exception_table_entry *last,
88 unsigned long value);
89 void sort_extable(struct exception_table_entry *start,
90 struct exception_table_entry *finish);
91 void sort_main_extable(void);
92 void trim_init_extable(struct module *m);
94 #ifdef MODULE
95 #define MODULE_GENERIC_TABLE(gtype,name) \
96 extern const struct gtype##_id __mod_##gtype##_table \
97 __attribute__ ((unused, alias(__stringify(name))))
99 extern struct module __this_module;
100 #define THIS_MODULE (&__this_module)
101 #else /* !MODULE */
102 #define MODULE_GENERIC_TABLE(gtype,name)
103 #define THIS_MODULE ((struct module *)0)
104 #endif
106 /* Generic info of form tag = "info" */
107 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
109 /* For userspace: you can also call me... */
110 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
113 * The following license idents are currently accepted as indicating free
114 * software modules
116 * "GPL" [GNU Public License v2 or later]
117 * "GPL v2" [GNU Public License v2]
118 * "GPL and additional rights" [GNU Public License v2 rights and more]
119 * "Dual BSD/GPL" [GNU Public License v2
120 * or BSD license choice]
121 * "Dual MIT/GPL" [GNU Public License v2
122 * or MIT license choice]
123 * "Dual MPL/GPL" [GNU Public License v2
124 * or Mozilla license choice]
126 * The following other idents are available
128 * "Proprietary" [Non free products]
130 * There are dual licensed components, but when running with Linux it is the
131 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
132 * is a GPL combined work.
134 * This exists for several reasons
135 * 1. So modinfo can show license info for users wanting to vet their setup
136 * is free
137 * 2. So the community can ignore bug reports including proprietary modules
138 * 3. So vendors can do likewise based on their own policies
140 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
143 * Author(s), use "Name <email>" or just "Name", for multiple
144 * authors use multiple MODULE_AUTHOR() statements/lines.
146 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
148 /* What your module does. */
149 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
151 /* One for each parameter, describing how to use it. Some files do
152 multiple of these per line, so can't just use MODULE_INFO. */
153 #define MODULE_PARM_DESC(_parm, desc) \
154 __MODULE_INFO(parm, _parm, #_parm ":" desc)
156 #define MODULE_DEVICE_TABLE(type,name) \
157 MODULE_GENERIC_TABLE(type##_device,name)
159 /* Version of form [<epoch>:]<version>[-<extra-version>].
160 Or for CVS/RCS ID version, everything but the number is stripped.
161 <epoch>: A (small) unsigned integer which allows you to start versions
162 anew. If not mentioned, it's zero. eg. "2:1.0" is after
163 "1:2.0".
164 <version>: The <version> may contain only alphanumerics and the
165 character `.'. Ordered by numeric sort for numeric parts,
166 ascii sort for ascii parts (as per RPM or DEB algorithm).
167 <extraversion>: Like <version>, but inserted for local
168 customizations, eg "rh3" or "rusty1".
170 Using this automatically adds a checksum of the .c files and the
171 local headers in "srcversion".
174 #if defined(MODULE) || !defined(CONFIG_SYSFS)
175 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
176 #else
177 #define MODULE_VERSION(_version) \
178 static struct module_version_attribute ___modver_attr = { \
179 .mattr = { \
180 .attr = { \
181 .name = "version", \
182 .mode = S_IRUGO, \
183 }, \
184 .show = __modver_version_show, \
185 }, \
186 .module_name = KBUILD_MODNAME, \
187 .version = _version, \
188 }; \
189 static const struct module_version_attribute \
190 __used __attribute__ ((__section__ ("__modver"))) \
191 * __moduleparam_const __modver_attr = &___modver_attr
192 #endif
194 /* Optional firmware file (or files) needed by the module
195 * format is simply firmware file name. Multiple firmware
196 * files require multiple MODULE_FIRMWARE() specifiers */
197 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
199 /* Given an address, look for it in the exception tables */
200 const struct exception_table_entry *search_exception_tables(unsigned long add);
202 struct notifier_block;
204 #ifdef CONFIG_MODULES
206 extern int modules_disabled; /* for sysctl */
207 /* Get/put a kernel symbol (calls must be symmetric) */
208 void *__symbol_get(const char *symbol);
209 void *__symbol_get_gpl(const char *symbol);
210 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
212 /* modules using other modules: kdb wants to see this. */
213 struct module_use {
214 struct list_head source_list;
215 struct list_head target_list;
216 struct module *source, *target;
219 #ifndef __GENKSYMS__
220 #ifdef CONFIG_MODVERSIONS
221 /* Mark the CRC weak since genksyms apparently decides not to
222 * generate a checksums for some symbols */
223 #define __CRC_SYMBOL(sym, sec) \
224 extern void *__crc_##sym __attribute__((weak)); \
225 static const unsigned long __kcrctab_##sym \
226 __used \
227 __attribute__((section("___kcrctab" sec "+" #sym), unused)) \
228 = (unsigned long) &__crc_##sym;
229 #else
230 #define __CRC_SYMBOL(sym, sec)
231 #endif
233 /* For every exported symbol, place a struct in the __ksymtab section */
234 #define __EXPORT_SYMBOL(sym, sec) \
235 extern typeof(sym) sym; \
236 __CRC_SYMBOL(sym, sec) \
237 static const char __kstrtab_##sym[] \
238 __attribute__((section("__ksymtab_strings"), aligned(1))) \
239 = MODULE_SYMBOL_PREFIX #sym; \
240 static const struct kernel_symbol __ksymtab_##sym \
241 __used \
242 __attribute__((section("___ksymtab" sec "+" #sym), unused)) \
243 = { (unsigned long)&sym, __kstrtab_##sym }
245 #define EXPORT_SYMBOL(sym) \
246 __EXPORT_SYMBOL(sym, "")
248 #define EXPORT_SYMBOL_GPL(sym) \
249 __EXPORT_SYMBOL(sym, "_gpl")
251 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
252 __EXPORT_SYMBOL(sym, "_gpl_future")
255 #ifdef CONFIG_UNUSED_SYMBOLS
256 #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
257 #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
258 #else
259 #define EXPORT_UNUSED_SYMBOL(sym)
260 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
261 #endif
263 #endif
265 enum module_state
267 MODULE_STATE_LIVE,
268 MODULE_STATE_COMING,
269 MODULE_STATE_GOING,
272 struct module
274 enum module_state state;
276 /* Member of list of modules */
277 struct list_head list;
279 /* Unique handle for this module */
280 char name[MODULE_NAME_LEN];
282 /* Sysfs stuff. */
283 struct module_kobject mkobj;
284 struct module_attribute *modinfo_attrs;
285 const char *version;
286 const char *srcversion;
287 struct kobject *holders_dir;
289 /* Exported symbols */
290 const struct kernel_symbol *syms;
291 const unsigned long *crcs;
292 unsigned int num_syms;
294 /* Kernel parameters. */
295 struct kernel_param *kp;
296 unsigned int num_kp;
298 /* GPL-only exported symbols. */
299 unsigned int num_gpl_syms;
300 const struct kernel_symbol *gpl_syms;
301 const unsigned long *gpl_crcs;
303 #ifdef CONFIG_UNUSED_SYMBOLS
304 /* unused exported symbols. */
305 const struct kernel_symbol *unused_syms;
306 const unsigned long *unused_crcs;
307 unsigned int num_unused_syms;
309 /* GPL-only, unused exported symbols. */
310 unsigned int num_unused_gpl_syms;
311 const struct kernel_symbol *unused_gpl_syms;
312 const unsigned long *unused_gpl_crcs;
313 #endif
315 /* symbols that will be GPL-only in the near future. */
316 const struct kernel_symbol *gpl_future_syms;
317 const unsigned long *gpl_future_crcs;
318 unsigned int num_gpl_future_syms;
320 /* Exception table */
321 unsigned int num_exentries;
322 struct exception_table_entry *extable;
324 /* Startup function. */
325 int (*init)(void);
327 /* If this is non-NULL, vfree after init() returns */
328 void *module_init;
330 /* Here is the actual code + data, vfree'd on unload. */
331 void *module_core;
333 /* Here are the sizes of the init and core sections */
334 unsigned int init_size, core_size;
336 /* The size of the executable code in each section. */
337 unsigned int init_text_size, core_text_size;
339 /* Size of RO sections of the module (text+rodata) */
340 unsigned int init_ro_size, core_ro_size;
342 /* Arch-specific module values */
343 struct mod_arch_specific arch;
345 unsigned int taints; /* same bits as kernel:tainted */
347 #ifdef CONFIG_GENERIC_BUG
348 /* Support for BUG */
349 unsigned num_bugs;
350 struct list_head bug_list;
351 struct bug_entry *bug_table;
352 #endif
354 #ifdef CONFIG_KALLSYMS
356 * We keep the symbol and string tables for kallsyms.
357 * The core_* fields below are temporary, loader-only (they
358 * could really be discarded after module init).
360 Elf_Sym *symtab, *core_symtab;
361 unsigned int num_symtab, core_num_syms;
362 char *strtab, *core_strtab;
364 /* Section attributes */
365 struct module_sect_attrs *sect_attrs;
367 /* Notes attributes */
368 struct module_notes_attrs *notes_attrs;
369 #endif
371 /* The command line arguments (may be mangled). People like
372 keeping pointers to this stuff */
373 char *args;
375 #ifdef CONFIG_SMP
376 /* Per-cpu data. */
377 void __percpu *percpu;
378 unsigned int percpu_size;
379 #endif
381 #ifdef CONFIG_TRACEPOINTS
382 unsigned int num_tracepoints;
383 struct tracepoint * const *tracepoints_ptrs;
384 #endif
385 #ifdef HAVE_JUMP_LABEL
386 struct jump_entry *jump_entries;
387 unsigned int num_jump_entries;
388 #endif
389 #ifdef CONFIG_TRACING
390 unsigned int num_trace_bprintk_fmt;
391 const char **trace_bprintk_fmt_start;
392 #endif
393 #ifdef CONFIG_EVENT_TRACING
394 struct ftrace_event_call **trace_events;
395 unsigned int num_trace_events;
396 #endif
397 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
398 unsigned int num_ftrace_callsites;
399 unsigned long *ftrace_callsites;
400 #endif
402 #ifdef CONFIG_MODULE_UNLOAD
403 /* What modules depend on me? */
404 struct list_head source_list;
405 /* What modules do I depend on? */
406 struct list_head target_list;
408 /* Who is waiting for us to be unloaded */
409 struct task_struct *waiter;
411 /* Destruction function. */
412 void (*exit)(void);
414 struct module_ref {
415 unsigned int incs;
416 unsigned int decs;
417 } __percpu *refptr;
418 #endif
420 #ifdef CONFIG_CONSTRUCTORS
421 /* Constructor functions. */
422 ctor_fn_t *ctors;
423 unsigned int num_ctors;
424 #endif
426 #ifndef MODULE_ARCH_INIT
427 #define MODULE_ARCH_INIT {}
428 #endif
430 extern struct mutex module_mutex;
432 /* FIXME: It'd be nice to isolate modules during init, too, so they
433 aren't used before they (may) fail. But presently too much code
434 (IDE & SCSI) require entry into the module during init.*/
435 static inline int module_is_live(struct module *mod)
437 return mod->state != MODULE_STATE_GOING;
440 struct module *__module_text_address(unsigned long addr);
441 struct module *__module_address(unsigned long addr);
442 bool is_module_address(unsigned long addr);
443 bool is_module_percpu_address(unsigned long addr);
444 bool is_module_text_address(unsigned long addr);
446 static inline int within_module_core(unsigned long addr, struct module *mod)
448 return (unsigned long)mod->module_core <= addr &&
449 addr < (unsigned long)mod->module_core + mod->core_size;
452 static inline int within_module_init(unsigned long addr, struct module *mod)
454 return (unsigned long)mod->module_init <= addr &&
455 addr < (unsigned long)mod->module_init + mod->init_size;
458 /* Search for module by name: must hold module_mutex. */
459 struct module *find_module(const char *name);
461 struct symsearch {
462 const struct kernel_symbol *start, *stop;
463 const unsigned long *crcs;
464 enum {
465 NOT_GPL_ONLY,
466 GPL_ONLY,
467 WILL_BE_GPL_ONLY,
468 } licence;
469 bool unused;
472 /* Search for an exported symbol by name. */
473 const struct kernel_symbol *find_symbol(const char *name,
474 struct module **owner,
475 const unsigned long **crc,
476 bool gplok,
477 bool warn);
479 /* Walk the exported symbol table */
480 bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
481 struct module *owner,
482 void *data), void *data);
484 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
485 symnum out of range. */
486 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
487 char *name, char *module_name, int *exported);
489 /* Look for this name: can be of form module:name. */
490 unsigned long module_kallsyms_lookup_name(const char *name);
492 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
493 struct module *, unsigned long),
494 void *data);
496 extern void __module_put_and_exit(struct module *mod, long code)
497 __attribute__((noreturn));
498 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
500 #ifdef CONFIG_MODULE_UNLOAD
501 unsigned int module_refcount(struct module *mod);
502 void __symbol_put(const char *symbol);
503 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
504 void symbol_put_addr(void *addr);
506 /* Sometimes we know we already have a refcount, and it's easier not
507 to handle the error case (which only happens with rmmod --wait). */
508 static inline void __module_get(struct module *module)
510 if (module) {
511 preempt_disable();
512 __this_cpu_inc(module->refptr->incs);
513 trace_module_get(module, _THIS_IP_);
514 preempt_enable();
518 static inline int try_module_get(struct module *module)
520 int ret = 1;
522 if (module) {
523 preempt_disable();
525 if (likely(module_is_live(module))) {
526 __this_cpu_inc(module->refptr->incs);
527 trace_module_get(module, _THIS_IP_);
528 } else
529 ret = 0;
531 preempt_enable();
533 return ret;
536 extern void module_put(struct module *module);
538 #else /*!CONFIG_MODULE_UNLOAD*/
539 static inline int try_module_get(struct module *module)
541 return !module || module_is_live(module);
543 static inline void module_put(struct module *module)
546 static inline void __module_get(struct module *module)
549 #define symbol_put(x) do { } while(0)
550 #define symbol_put_addr(p) do { } while(0)
552 #endif /* CONFIG_MODULE_UNLOAD */
553 int ref_module(struct module *a, struct module *b);
555 /* This is a #define so the string doesn't get put in every .o file */
556 #define module_name(mod) \
557 ({ \
558 struct module *__mod = (mod); \
559 __mod ? __mod->name : "kernel"; \
562 /* For kallsyms to ask for address resolution. namebuf should be at
563 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
564 * found, otherwise NULL. */
565 const char *module_address_lookup(unsigned long addr,
566 unsigned long *symbolsize,
567 unsigned long *offset,
568 char **modname,
569 char *namebuf);
570 int lookup_module_symbol_name(unsigned long addr, char *symname);
571 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
573 /* For extable.c to search modules' exception tables. */
574 const struct exception_table_entry *search_module_extables(unsigned long addr);
576 int register_module_notifier(struct notifier_block * nb);
577 int unregister_module_notifier(struct notifier_block * nb);
579 extern void print_modules(void);
581 extern void module_update_tracepoints(void);
582 extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);
584 #else /* !CONFIG_MODULES... */
585 #define EXPORT_SYMBOL(sym)
586 #define EXPORT_SYMBOL_GPL(sym)
587 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
588 #define EXPORT_UNUSED_SYMBOL(sym)
589 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
591 /* Given an address, look for it in the exception tables. */
592 static inline const struct exception_table_entry *
593 search_module_extables(unsigned long addr)
595 return NULL;
598 static inline struct module *__module_address(unsigned long addr)
600 return NULL;
603 static inline struct module *__module_text_address(unsigned long addr)
605 return NULL;
608 static inline bool is_module_address(unsigned long addr)
610 return false;
613 static inline bool is_module_percpu_address(unsigned long addr)
615 return false;
618 static inline bool is_module_text_address(unsigned long addr)
620 return false;
623 /* Get/put a kernel symbol (calls should be symmetric) */
624 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
625 #define symbol_put(x) do { } while(0)
626 #define symbol_put_addr(x) do { } while(0)
628 static inline void __module_get(struct module *module)
632 static inline int try_module_get(struct module *module)
634 return 1;
637 static inline void module_put(struct module *module)
641 #define module_name(mod) "kernel"
643 /* For kallsyms to ask for address resolution. NULL means not found. */
644 static inline const char *module_address_lookup(unsigned long addr,
645 unsigned long *symbolsize,
646 unsigned long *offset,
647 char **modname,
648 char *namebuf)
650 return NULL;
653 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
655 return -ERANGE;
658 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
660 return -ERANGE;
663 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
664 char *type, char *name,
665 char *module_name, int *exported)
667 return -ERANGE;
670 static inline unsigned long module_kallsyms_lookup_name(const char *name)
672 return 0;
675 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
676 struct module *,
677 unsigned long),
678 void *data)
680 return 0;
683 static inline int register_module_notifier(struct notifier_block * nb)
685 /* no events will happen anyway, so this can always succeed */
686 return 0;
689 static inline int unregister_module_notifier(struct notifier_block * nb)
691 return 0;
694 #define module_put_and_exit(code) do_exit(code)
696 static inline void print_modules(void)
700 static inline void module_update_tracepoints(void)
704 static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
706 return 0;
708 #endif /* CONFIG_MODULES */
710 #ifdef CONFIG_SYSFS
711 extern struct kset *module_kset;
712 extern struct kobj_type module_ktype;
713 extern int module_sysfs_initialized;
714 #endif /* CONFIG_SYSFS */
716 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
718 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
720 #define __MODULE_STRING(x) __stringify(x)
722 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
723 extern void set_all_modules_text_rw(void);
724 extern void set_all_modules_text_ro(void);
725 #else
726 static inline void set_all_modules_text_rw(void) { }
727 static inline void set_all_modules_text_ro(void) { }
728 #endif
730 #ifdef CONFIG_GENERIC_BUG
731 void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
732 struct module *);
733 void module_bug_cleanup(struct module *);
735 #else /* !CONFIG_GENERIC_BUG */
737 static inline void module_bug_finalize(const Elf_Ehdr *hdr,
738 const Elf_Shdr *sechdrs,
739 struct module *mod)
742 static inline void module_bug_cleanup(struct module *mod) {}
743 #endif /* CONFIG_GENERIC_BUG */
745 #endif /* _LINUX_MODULE_H */