tracing: Remove markers
[linux-2.6/linux-2.6-openrd.git] / include / linux / module.h
blob1c755b2f937dd19e99f353203ef4c130fb53cf6c
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 <asm/local.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 uses a `_' prefix for all user symbols */
29 #ifndef MODULE_SYMBOL_PREFIX
30 #define MODULE_SYMBOL_PREFIX ""
31 #endif
33 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
35 struct kernel_symbol
37 unsigned long value;
38 const char *name;
41 struct modversion_info
43 unsigned long crc;
44 char name[MODULE_NAME_LEN];
47 struct module;
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 *);
59 struct module_kobject
61 struct kobject kobj;
62 struct module *mod;
63 struct kobject *drivers_dir;
64 struct module_param_attrs *mp;
67 /* These are either module local, or the kernel's dummy ones. */
68 extern int init_module(void);
69 extern void cleanup_module(void);
71 /* Archs provide a method of finding the correct exception table. */
72 struct exception_table_entry;
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);
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))))
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
95 /* Generic info of form tag = "info" */
96 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
98 /* For userspace: you can also call me... */
99 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
102 * The following license idents are currently accepted as indicating free
103 * software modules
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]
115 * The following other idents are available
117 * "Proprietary" [Non free products]
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.
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
129 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
131 /* Author, ideally of form NAME[, NAME]*[ and NAME] */
132 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
134 /* What your module does. */
135 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
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)
142 #define MODULE_DEVICE_TABLE(type,name) \
143 MODULE_GENERIC_TABLE(type##_device,name)
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".
156 Using this automatically adds a checksum of the .c files and the
157 local headers in "srcversion".
159 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
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)
166 /* Given an address, look for it in the exception tables */
167 const struct exception_table_entry *search_exception_tables(unsigned long add);
169 struct notifier_block;
171 #ifdef CONFIG_MODULES
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)))
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
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 }
204 #define EXPORT_SYMBOL(sym) \
205 __EXPORT_SYMBOL(sym, "")
207 #define EXPORT_SYMBOL_GPL(sym) \
208 __EXPORT_SYMBOL(sym, "_gpl")
210 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
211 __EXPORT_SYMBOL(sym, "_gpl_future")
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
222 #endif
224 enum module_state
226 MODULE_STATE_LIVE,
227 MODULE_STATE_COMING,
228 MODULE_STATE_GOING,
231 struct module
233 enum module_state state;
235 /* Member of list of modules */
236 struct list_head list;
238 /* Unique handle for this module */
239 char name[MODULE_NAME_LEN];
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;
248 /* Exported symbols */
249 const struct kernel_symbol *syms;
250 const unsigned long *crcs;
251 unsigned int num_syms;
253 /* Kernel parameters. */
254 struct kernel_param *kp;
255 unsigned int num_kp;
257 /* GPL-only exported symbols. */
258 unsigned int num_gpl_syms;
259 const struct kernel_symbol *gpl_syms;
260 const unsigned long *gpl_crcs;
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;
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
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;
279 /* Exception table */
280 unsigned int num_exentries;
281 struct exception_table_entry *extable;
283 /* Startup function. */
284 int (*init)(void);
286 /* If this is non-NULL, vfree after init() returns */
287 void *module_init;
289 /* Here is the actual code + data, vfree'd on unload. */
290 void *module_core;
292 /* Here are the sizes of the init and core sections */
293 unsigned int init_size, core_size;
295 /* The size of the executable code in each section. */
296 unsigned int init_text_size, core_text_size;
298 /* Arch-specific module values */
299 struct mod_arch_specific arch;
301 unsigned int taints; /* same bits as kernel:tainted */
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
310 #ifdef CONFIG_KALLSYMS
311 /* We keep the symbol and string tables for kallsyms. */
312 Elf_Sym *symtab;
313 unsigned int num_symtab;
314 char *strtab;
316 /* Section attributes */
317 struct module_sect_attrs *sect_attrs;
319 /* Notes attributes */
320 struct module_notes_attrs *notes_attrs;
321 #endif
323 /* Per-cpu data. */
324 void *percpu;
326 /* The command line arguments (may be mangled). People like
327 keeping pointers to this stuff */
328 char *args;
329 #ifdef CONFIG_TRACEPOINTS
330 struct tracepoint *tracepoints;
331 unsigned int num_tracepoints;
332 #endif
334 #ifdef CONFIG_TRACING
335 const char **trace_bprintk_fmt_start;
336 unsigned int num_trace_bprintk_fmt;
337 #endif
338 #ifdef CONFIG_EVENT_TRACING
339 struct ftrace_event_call *trace_events;
340 unsigned int num_trace_events;
341 #endif
342 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
343 unsigned long *ftrace_callsites;
344 unsigned int num_ftrace_callsites;
345 #endif
347 #ifdef CONFIG_MODULE_UNLOAD
348 /* What modules depend on me? */
349 struct list_head modules_which_use_me;
351 /* Who is waiting for us to be unloaded */
352 struct task_struct *waiter;
354 /* Destruction function. */
355 void (*exit)(void);
357 #ifdef CONFIG_SMP
358 char *refptr;
359 #else
360 local_t ref;
361 #endif
362 #endif
364 #ifdef CONFIG_CONSTRUCTORS
365 /* Constructor functions. */
366 ctor_fn_t *ctors;
367 unsigned int num_ctors;
368 #endif
370 #ifndef MODULE_ARCH_INIT
371 #define MODULE_ARCH_INIT {}
372 #endif
374 extern struct mutex module_mutex;
376 /* FIXME: It'd be nice to isolate modules during init, too, so they
377 aren't used before they (may) fail. But presently too much code
378 (IDE & SCSI) require entry into the module during init.*/
379 static inline int module_is_live(struct module *mod)
381 return mod->state != MODULE_STATE_GOING;
384 struct module *__module_text_address(unsigned long addr);
385 struct module *__module_address(unsigned long addr);
386 bool is_module_address(unsigned long addr);
387 bool is_module_text_address(unsigned long addr);
389 static inline int within_module_core(unsigned long addr, struct module *mod)
391 return (unsigned long)mod->module_core <= addr &&
392 addr < (unsigned long)mod->module_core + mod->core_size;
395 static inline int within_module_init(unsigned long addr, struct module *mod)
397 return (unsigned long)mod->module_init <= addr &&
398 addr < (unsigned long)mod->module_init + mod->init_size;
401 /* Search for module by name: must hold module_mutex. */
402 struct module *find_module(const char *name);
404 struct symsearch {
405 const struct kernel_symbol *start, *stop;
406 const unsigned long *crcs;
407 enum {
408 NOT_GPL_ONLY,
409 GPL_ONLY,
410 WILL_BE_GPL_ONLY,
411 } licence;
412 bool unused;
415 /* Search for an exported symbol by name. */
416 const struct kernel_symbol *find_symbol(const char *name,
417 struct module **owner,
418 const unsigned long **crc,
419 bool gplok,
420 bool warn);
422 /* Walk the exported symbol table */
423 bool each_symbol(bool (*fn)(const struct symsearch *arr, struct module *owner,
424 unsigned int symnum, void *data), void *data);
426 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
427 symnum out of range. */
428 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
429 char *name, char *module_name, int *exported);
431 /* Look for this name: can be of form module:name. */
432 unsigned long module_kallsyms_lookup_name(const char *name);
434 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
435 struct module *, unsigned long),
436 void *data);
438 extern void __module_put_and_exit(struct module *mod, long code)
439 __attribute__((noreturn));
440 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
442 #ifdef CONFIG_MODULE_UNLOAD
443 unsigned int module_refcount(struct module *mod);
444 void __symbol_put(const char *symbol);
445 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
446 void symbol_put_addr(void *addr);
448 static inline local_t *__module_ref_addr(struct module *mod, int cpu)
450 #ifdef CONFIG_SMP
451 return (local_t *) (mod->refptr + per_cpu_offset(cpu));
452 #else
453 return &mod->ref;
454 #endif
457 /* Sometimes we know we already have a refcount, and it's easier not
458 to handle the error case (which only happens with rmmod --wait). */
459 static inline void __module_get(struct module *module)
461 if (module) {
462 unsigned int cpu = get_cpu();
463 local_inc(__module_ref_addr(module, cpu));
464 trace_module_get(module, _THIS_IP_,
465 local_read(__module_ref_addr(module, cpu)));
466 put_cpu();
470 static inline int try_module_get(struct module *module)
472 int ret = 1;
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 trace_module_get(module, _THIS_IP_,
479 local_read(__module_ref_addr(module, cpu)));
481 else
482 ret = 0;
483 put_cpu();
485 return ret;
488 extern void module_put(struct module *module);
490 #else /*!CONFIG_MODULE_UNLOAD*/
491 static inline int try_module_get(struct module *module)
493 return !module || module_is_live(module);
495 static inline void module_put(struct module *module)
498 static inline void __module_get(struct module *module)
501 #define symbol_put(x) do { } while(0)
502 #define symbol_put_addr(p) do { } while(0)
504 #endif /* CONFIG_MODULE_UNLOAD */
505 int use_module(struct module *a, struct module *b);
507 /* This is a #define so the string doesn't get put in every .o file */
508 #define module_name(mod) \
509 ({ \
510 struct module *__mod = (mod); \
511 __mod ? __mod->name : "kernel"; \
514 /* For kallsyms to ask for address resolution. namebuf should be at
515 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
516 * found, otherwise NULL. */
517 const char *module_address_lookup(unsigned long addr,
518 unsigned long *symbolsize,
519 unsigned long *offset,
520 char **modname,
521 char *namebuf);
522 int lookup_module_symbol_name(unsigned long addr, char *symname);
523 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
525 /* For extable.c to search modules' exception tables. */
526 const struct exception_table_entry *search_module_extables(unsigned long addr);
528 int register_module_notifier(struct notifier_block * nb);
529 int unregister_module_notifier(struct notifier_block * nb);
531 extern void print_modules(void);
533 extern void module_update_tracepoints(void);
534 extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);
536 #else /* !CONFIG_MODULES... */
537 #define EXPORT_SYMBOL(sym)
538 #define EXPORT_SYMBOL_GPL(sym)
539 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
540 #define EXPORT_UNUSED_SYMBOL(sym)
541 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
543 /* Given an address, look for it in the exception tables. */
544 static inline const struct exception_table_entry *
545 search_module_extables(unsigned long addr)
547 return NULL;
550 static inline struct module *__module_address(unsigned long addr)
552 return NULL;
555 static inline struct module *__module_text_address(unsigned long addr)
557 return NULL;
560 static inline bool is_module_address(unsigned long addr)
562 return false;
565 static inline bool is_module_text_address(unsigned long addr)
567 return false;
570 /* Get/put a kernel symbol (calls should be symmetric) */
571 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
572 #define symbol_put(x) do { } while(0)
573 #define symbol_put_addr(x) do { } while(0)
575 static inline void __module_get(struct module *module)
579 static inline int try_module_get(struct module *module)
581 return 1;
584 static inline void module_put(struct module *module)
588 #define module_name(mod) "kernel"
590 /* For kallsyms to ask for address resolution. NULL means not found. */
591 static inline const char *module_address_lookup(unsigned long addr,
592 unsigned long *symbolsize,
593 unsigned long *offset,
594 char **modname,
595 char *namebuf)
597 return NULL;
600 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
602 return -ERANGE;
605 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
607 return -ERANGE;
610 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
611 char *type, char *name,
612 char *module_name, int *exported)
614 return -ERANGE;
617 static inline unsigned long module_kallsyms_lookup_name(const char *name)
619 return 0;
622 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
623 struct module *,
624 unsigned long),
625 void *data)
627 return 0;
630 static inline int register_module_notifier(struct notifier_block * nb)
632 /* no events will happen anyway, so this can always succeed */
633 return 0;
636 static inline int unregister_module_notifier(struct notifier_block * nb)
638 return 0;
641 #define module_put_and_exit(code) do_exit(code)
643 static inline void print_modules(void)
647 static inline void module_update_tracepoints(void)
651 static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
653 return 0;
656 #endif /* CONFIG_MODULES */
658 struct device_driver;
659 #ifdef CONFIG_SYSFS
660 struct module;
662 extern struct kset *module_kset;
663 extern struct kobj_type module_ktype;
664 extern int module_sysfs_initialized;
666 int mod_sysfs_init(struct module *mod);
667 int mod_sysfs_setup(struct module *mod,
668 struct kernel_param *kparam,
669 unsigned int num_params);
670 int module_add_modinfo_attrs(struct module *mod);
671 void module_remove_modinfo_attrs(struct module *mod);
673 #else /* !CONFIG_SYSFS */
675 static inline int mod_sysfs_init(struct module *mod)
677 return 0;
680 static inline int mod_sysfs_setup(struct module *mod,
681 struct kernel_param *kparam,
682 unsigned int num_params)
684 return 0;
687 static inline int module_add_modinfo_attrs(struct module *mod)
689 return 0;
692 static inline void module_remove_modinfo_attrs(struct module *mod)
695 #endif /* CONFIG_SYSFS */
697 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
699 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
701 #define __MODULE_STRING(x) __stringify(x)
704 #ifdef CONFIG_GENERIC_BUG
705 int module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
706 struct module *);
707 void module_bug_cleanup(struct module *);
709 #else /* !CONFIG_GENERIC_BUG */
711 static inline int module_bug_finalize(const Elf_Ehdr *hdr,
712 const Elf_Shdr *sechdrs,
713 struct module *mod)
715 return 0;
717 static inline void module_bug_cleanup(struct module *mod) {}
718 #endif /* CONFIG_GENERIC_BUG */
720 #endif /* _LINUX_MODULE_H */