V4L/DVB (6715): ivtv: Remove unnecessary register update
[linux-2.6/verdex.git] / include / linux / module.h
blobc97bdb7eb957cdd71e625ac9cf66862132d153da
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/marker.h>
19 #include <asm/local.h>
21 #include <asm/module.h>
23 /* Not Yet Implemented */
24 #define MODULE_SUPPORTED_DEVICE(name)
26 /* v850 toolchain uses a `_' prefix for all user symbols */
27 #ifndef MODULE_SYMBOL_PREFIX
28 #define MODULE_SYMBOL_PREFIX ""
29 #endif
31 #define MODULE_NAME_LEN (64 - sizeof(unsigned long))
33 struct kernel_symbol
35 unsigned long value;
36 const char *name;
39 struct modversion_info
41 unsigned long crc;
42 char name[MODULE_NAME_LEN];
45 struct module;
47 struct module_attribute {
48 struct attribute attr;
49 ssize_t (*show)(struct module_attribute *, struct module *, char *);
50 ssize_t (*store)(struct module_attribute *, struct module *,
51 const char *, size_t count);
52 void (*setup)(struct module *, const char *);
53 int (*test)(struct module *);
54 void (*free)(struct module *);
57 struct module_kobject
59 struct kobject kobj;
60 struct module *mod;
61 struct kobject *drivers_dir;
64 /* These are either module local, or the kernel's dummy ones. */
65 extern int init_module(void);
66 extern void cleanup_module(void);
68 /* Archs provide a method of finding the correct exception table. */
69 struct exception_table_entry;
71 const struct exception_table_entry *
72 search_extable(const struct exception_table_entry *first,
73 const struct exception_table_entry *last,
74 unsigned long value);
75 void sort_extable(struct exception_table_entry *start,
76 struct exception_table_entry *finish);
77 void sort_main_extable(void);
79 #ifdef MODULE
80 #define MODULE_GENERIC_TABLE(gtype,name) \
81 extern const struct gtype##_id __mod_##gtype##_table \
82 __attribute__ ((unused, alias(__stringify(name))))
84 extern struct module __this_module;
85 #define THIS_MODULE (&__this_module)
86 #else /* !MODULE */
87 #define MODULE_GENERIC_TABLE(gtype,name)
88 #define THIS_MODULE ((struct module *)0)
89 #endif
91 /* Generic info of form tag = "info" */
92 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
94 /* For userspace: you can also call me... */
95 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
98 * The following license idents are currently accepted as indicating free
99 * software modules
101 * "GPL" [GNU Public License v2 or later]
102 * "GPL v2" [GNU Public License v2]
103 * "GPL and additional rights" [GNU Public License v2 rights and more]
104 * "Dual BSD/GPL" [GNU Public License v2
105 * or BSD license choice]
106 * "Dual MIT/GPL" [GNU Public License v2
107 * or MIT license choice]
108 * "Dual MPL/GPL" [GNU Public License v2
109 * or Mozilla license choice]
111 * The following other idents are available
113 * "Proprietary" [Non free products]
115 * There are dual licensed components, but when running with Linux it is the
116 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
117 * is a GPL combined work.
119 * This exists for several reasons
120 * 1. So modinfo can show license info for users wanting to vet their setup
121 * is free
122 * 2. So the community can ignore bug reports including proprietary modules
123 * 3. So vendors can do likewise based on their own policies
125 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
127 /* Author, ideally of form NAME[, NAME]*[ and NAME] */
128 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
130 /* What your module does. */
131 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
133 /* One for each parameter, describing how to use it. Some files do
134 multiple of these per line, so can't just use MODULE_INFO. */
135 #define MODULE_PARM_DESC(_parm, desc) \
136 __MODULE_INFO(parm, _parm, #_parm ":" desc)
138 #define MODULE_DEVICE_TABLE(type,name) \
139 MODULE_GENERIC_TABLE(type##_device,name)
141 /* Version of form [<epoch>:]<version>[-<extra-version>].
142 Or for CVS/RCS ID version, everything but the number is stripped.
143 <epoch>: A (small) unsigned integer which allows you to start versions
144 anew. If not mentioned, it's zero. eg. "2:1.0" is after
145 "1:2.0".
146 <version>: The <version> may contain only alphanumerics and the
147 character `.'. Ordered by numeric sort for numeric parts,
148 ascii sort for ascii parts (as per RPM or DEB algorithm).
149 <extraversion>: Like <version>, but inserted for local
150 customizations, eg "rh3" or "rusty1".
152 Using this automatically adds a checksum of the .c files and the
153 local headers in "srcversion".
155 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
157 /* Optional firmware file (or files) needed by the module
158 * format is simply firmware file name. Multiple firmware
159 * files require multiple MODULE_FIRMWARE() specifiers */
160 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
162 /* Given an address, look for it in the exception tables */
163 const struct exception_table_entry *search_exception_tables(unsigned long add);
165 struct notifier_block;
167 #ifdef CONFIG_MODULES
169 /* Get/put a kernel symbol (calls must be symmetric) */
170 void *__symbol_get(const char *symbol);
171 void *__symbol_get_gpl(const char *symbol);
172 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
174 #ifndef __GENKSYMS__
175 #ifdef CONFIG_MODVERSIONS
176 /* Mark the CRC weak since genksyms apparently decides not to
177 * generate a checksums for some symbols */
178 #define __CRC_SYMBOL(sym, sec) \
179 extern void *__crc_##sym __attribute__((weak)); \
180 static const unsigned long __kcrctab_##sym \
181 __attribute_used__ \
182 __attribute__((section("__kcrctab" sec), unused)) \
183 = (unsigned long) &__crc_##sym;
184 #else
185 #define __CRC_SYMBOL(sym, sec)
186 #endif
188 /* For every exported symbol, place a struct in the __ksymtab section */
189 #define __EXPORT_SYMBOL(sym, sec) \
190 extern typeof(sym) sym; \
191 __CRC_SYMBOL(sym, sec) \
192 static const char __kstrtab_##sym[] \
193 __attribute__((section("__ksymtab_strings"))) \
194 = MODULE_SYMBOL_PREFIX #sym; \
195 static const struct kernel_symbol __ksymtab_##sym \
196 __attribute_used__ \
197 __attribute__((section("__ksymtab" sec), unused)) \
198 = { (unsigned long)&sym, __kstrtab_##sym }
200 #define EXPORT_SYMBOL(sym) \
201 __EXPORT_SYMBOL(sym, "")
203 #define EXPORT_SYMBOL_GPL(sym) \
204 __EXPORT_SYMBOL(sym, "_gpl")
206 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
207 __EXPORT_SYMBOL(sym, "_gpl_future")
210 #ifdef CONFIG_UNUSED_SYMBOLS
211 #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
212 #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
213 #else
214 #define EXPORT_UNUSED_SYMBOL(sym)
215 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
216 #endif
218 #endif
220 struct module_ref
222 local_t count;
223 } ____cacheline_aligned;
225 enum module_state
227 MODULE_STATE_LIVE,
228 MODULE_STATE_COMING,
229 MODULE_STATE_GOING,
232 /* Similar stuff for section attributes. */
233 struct module_sect_attr
235 struct module_attribute mattr;
236 char *name;
237 unsigned long address;
240 struct module_sect_attrs
242 struct attribute_group grp;
243 int nsections;
244 struct module_sect_attr attrs[0];
247 struct module_param_attrs;
249 struct module
251 enum module_state state;
253 /* Member of list of modules */
254 struct list_head list;
256 /* Unique handle for this module */
257 char name[MODULE_NAME_LEN];
259 /* Sysfs stuff. */
260 struct module_kobject mkobj;
261 struct module_param_attrs *param_attrs;
262 struct module_attribute *modinfo_attrs;
263 const char *version;
264 const char *srcversion;
265 struct kobject *holders_dir;
267 /* Exported symbols */
268 const struct kernel_symbol *syms;
269 unsigned int num_syms;
270 const unsigned long *crcs;
272 /* GPL-only exported symbols. */
273 const struct kernel_symbol *gpl_syms;
274 unsigned int num_gpl_syms;
275 const unsigned long *gpl_crcs;
277 /* unused exported symbols. */
278 const struct kernel_symbol *unused_syms;
279 unsigned int num_unused_syms;
280 const unsigned long *unused_crcs;
281 /* GPL-only, unused exported symbols. */
282 const struct kernel_symbol *unused_gpl_syms;
283 unsigned int num_unused_gpl_syms;
284 const unsigned long *unused_gpl_crcs;
286 /* symbols that will be GPL-only in the near future. */
287 const struct kernel_symbol *gpl_future_syms;
288 unsigned int num_gpl_future_syms;
289 const unsigned long *gpl_future_crcs;
291 /* Exception table */
292 unsigned int num_exentries;
293 const struct exception_table_entry *extable;
295 /* Startup function. */
296 int (*init)(void);
298 /* If this is non-NULL, vfree after init() returns */
299 void *module_init;
301 /* Here is the actual code + data, vfree'd on unload. */
302 void *module_core;
304 /* Here are the sizes of the init and core sections */
305 unsigned long init_size, core_size;
307 /* The size of the executable code in each section. */
308 unsigned long init_text_size, core_text_size;
310 /* The handle returned from unwind_add_table. */
311 void *unwind_info;
313 /* Arch-specific module values */
314 struct mod_arch_specific arch;
316 unsigned int taints; /* same bits as kernel:tainted */
318 #ifdef CONFIG_GENERIC_BUG
319 /* Support for BUG */
320 struct list_head bug_list;
321 struct bug_entry *bug_table;
322 unsigned num_bugs;
323 #endif
325 #ifdef CONFIG_MODULE_UNLOAD
326 /* Reference counts */
327 struct module_ref ref[NR_CPUS];
329 /* What modules depend on me? */
330 struct list_head modules_which_use_me;
332 /* Who is waiting for us to be unloaded */
333 struct task_struct *waiter;
335 /* Destruction function. */
336 void (*exit)(void);
337 #endif
339 #ifdef CONFIG_KALLSYMS
340 /* We keep the symbol and string tables for kallsyms. */
341 Elf_Sym *symtab;
342 unsigned long num_symtab;
343 char *strtab;
345 /* Section attributes */
346 struct module_sect_attrs *sect_attrs;
348 /* Notes attributes */
349 struct module_notes_attrs *notes_attrs;
350 #endif
352 /* Per-cpu data. */
353 void *percpu;
355 /* The command line arguments (may be mangled). People like
356 keeping pointers to this stuff */
357 char *args;
358 #ifdef CONFIG_MARKERS
359 struct marker *markers;
360 unsigned int num_markers;
361 #endif
363 #ifndef MODULE_ARCH_INIT
364 #define MODULE_ARCH_INIT {}
365 #endif
367 /* FIXME: It'd be nice to isolate modules during init, too, so they
368 aren't used before they (may) fail. But presently too much code
369 (IDE & SCSI) require entry into the module during init.*/
370 static inline int module_is_live(struct module *mod)
372 return mod->state != MODULE_STATE_GOING;
375 /* Is this address in a module? (second is with no locks, for oops) */
376 struct module *module_text_address(unsigned long addr);
377 struct module *__module_text_address(unsigned long addr);
378 int is_module_address(unsigned long addr);
380 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
381 symnum out of range. */
382 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
383 char *name, char *module_name, int *exported);
385 /* Look for this name: can be of form module:name. */
386 unsigned long module_kallsyms_lookup_name(const char *name);
388 extern void __module_put_and_exit(struct module *mod, long code)
389 __attribute__((noreturn));
390 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
392 #ifdef CONFIG_MODULE_UNLOAD
393 unsigned int module_refcount(struct module *mod);
394 void __symbol_put(const char *symbol);
395 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
396 void symbol_put_addr(void *addr);
398 /* Sometimes we know we already have a refcount, and it's easier not
399 to handle the error case (which only happens with rmmod --wait). */
400 static inline void __module_get(struct module *module)
402 if (module) {
403 BUG_ON(module_refcount(module) == 0);
404 local_inc(&module->ref[get_cpu()].count);
405 put_cpu();
409 static inline int try_module_get(struct module *module)
411 int ret = 1;
413 if (module) {
414 unsigned int cpu = get_cpu();
415 if (likely(module_is_live(module)))
416 local_inc(&module->ref[cpu].count);
417 else
418 ret = 0;
419 put_cpu();
421 return ret;
424 extern void module_put(struct module *module);
426 #else /*!CONFIG_MODULE_UNLOAD*/
427 static inline int try_module_get(struct module *module)
429 return !module || module_is_live(module);
431 static inline void module_put(struct module *module)
434 static inline void __module_get(struct module *module)
437 #define symbol_put(x) do { } while(0)
438 #define symbol_put_addr(p) do { } while(0)
440 #endif /* CONFIG_MODULE_UNLOAD */
442 /* This is a #define so the string doesn't get put in every .o file */
443 #define module_name(mod) \
444 ({ \
445 struct module *__mod = (mod); \
446 __mod ? __mod->name : "kernel"; \
449 /* For kallsyms to ask for address resolution. NULL means not found. */
450 const char *module_address_lookup(unsigned long addr,
451 unsigned long *symbolsize,
452 unsigned long *offset,
453 char **modname);
454 int lookup_module_symbol_name(unsigned long addr, char *symname);
455 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
457 /* For extable.c to search modules' exception tables. */
458 const struct exception_table_entry *search_module_extables(unsigned long addr);
460 int register_module_notifier(struct notifier_block * nb);
461 int unregister_module_notifier(struct notifier_block * nb);
463 extern void print_modules(void);
465 extern void module_update_markers(struct module *probe_module, int *refcount);
467 #else /* !CONFIG_MODULES... */
468 #define EXPORT_SYMBOL(sym)
469 #define EXPORT_SYMBOL_GPL(sym)
470 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
471 #define EXPORT_UNUSED_SYMBOL(sym)
472 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
474 /* Given an address, look for it in the exception tables. */
475 static inline const struct exception_table_entry *
476 search_module_extables(unsigned long addr)
478 return NULL;
481 /* Is this address in a module? */
482 static inline struct module *module_text_address(unsigned long addr)
484 return NULL;
487 /* Is this address in a module? (don't take a lock, we're oopsing) */
488 static inline struct module *__module_text_address(unsigned long addr)
490 return NULL;
493 static inline int is_module_address(unsigned long addr)
495 return 0;
498 /* Get/put a kernel symbol (calls should be symmetric) */
499 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
500 #define symbol_put(x) do { } while(0)
501 #define symbol_put_addr(x) do { } while(0)
503 static inline void __module_get(struct module *module)
507 static inline int try_module_get(struct module *module)
509 return 1;
512 static inline void module_put(struct module *module)
516 #define module_name(mod) "kernel"
518 /* For kallsyms to ask for address resolution. NULL means not found. */
519 static inline const char *module_address_lookup(unsigned long addr,
520 unsigned long *symbolsize,
521 unsigned long *offset,
522 char **modname)
524 return NULL;
527 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
529 return -ERANGE;
532 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
534 return -ERANGE;
537 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
538 char *type, char *name,
539 char *module_name, int *exported)
541 return -ERANGE;
544 static inline unsigned long module_kallsyms_lookup_name(const char *name)
546 return 0;
549 static inline int register_module_notifier(struct notifier_block * nb)
551 /* no events will happen anyway, so this can always succeed */
552 return 0;
555 static inline int unregister_module_notifier(struct notifier_block * nb)
557 return 0;
560 #define module_put_and_exit(code) do_exit(code)
562 static inline void print_modules(void)
566 static inline void module_update_markers(struct module *probe_module,
567 int *refcount)
571 #endif /* CONFIG_MODULES */
573 struct device_driver;
574 #ifdef CONFIG_SYSFS
575 struct module;
577 extern struct kset *module_kset;
578 extern struct kobj_type module_ktype;
579 extern int module_sysfs_initialized;
581 int mod_sysfs_init(struct module *mod);
582 int mod_sysfs_setup(struct module *mod,
583 struct kernel_param *kparam,
584 unsigned int num_params);
585 int module_add_modinfo_attrs(struct module *mod);
586 void module_remove_modinfo_attrs(struct module *mod);
588 #else /* !CONFIG_SYSFS */
590 static inline int mod_sysfs_init(struct module *mod)
592 return 0;
595 static inline int mod_sysfs_setup(struct module *mod,
596 struct kernel_param *kparam,
597 unsigned int num_params)
599 return 0;
602 static inline int module_add_modinfo_attrs(struct module *mod)
604 return 0;
607 static inline void module_remove_modinfo_attrs(struct module *mod)
610 #endif /* CONFIG_SYSFS */
612 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
614 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
616 #define __MODULE_STRING(x) __stringify(x)
618 #endif /* _LINUX_MODULE_H */