blob: 419d3ef293dd996ba4ee3fda9501feebdd13e0aa [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/spinlock.h>
10#include <linux/list.h>
11#include <linux/stat.h>
12#include <linux/compiler.h>
13#include <linux/cache.h>
14#include <linux/kmod.h>
15#include <linux/elf.h>
16#include <linux/stringify.h>
17#include <linux/kobject.h>
18#include <linux/moduleparam.h>
19#include <asm/local.h>
20
21#include <asm/module.h>
22
23/* Not Yet Implemented */
24#define MODULE_SUPPORTED_DEVICE(name)
25
26/* v850 toolchain uses a `_' prefix for all user symbols */
27#ifndef MODULE_SYMBOL_PREFIX
28#define MODULE_SYMBOL_PREFIX ""
29#endif
30
31#define MODULE_NAME_LEN (64 - sizeof(unsigned long))
32
33struct kernel_symbol
34{
35 unsigned long value;
36 const char *name;
37};
38
39struct modversion_info
40{
41 unsigned long crc;
42 char name[MODULE_NAME_LEN];
43};
44
45struct module;
46
47struct 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);
Matt Domschc988d2b2005-06-23 22:05:15 -070052 void (*setup)(struct module *, const char *);
53 int (*test)(struct module *);
54 void (*free)(struct module *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055};
56
57struct module_kobject
58{
59 struct kobject kobj;
60 struct module *mod;
Kay Sieversf30c53a2007-01-15 20:22:02 +010061 struct kobject *drivers_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062};
63
64/* These are either module local, or the kernel's dummy ones. */
65extern int init_module(void);
66extern void cleanup_module(void);
67
68/* Archs provide a method of finding the correct exception table. */
69struct exception_table_entry;
70
71const struct exception_table_entry *
72search_extable(const struct exception_table_entry *first,
73 const struct exception_table_entry *last,
74 unsigned long value);
75void sort_extable(struct exception_table_entry *start,
76 struct exception_table_entry *finish);
77void sort_main_extable(void);
78
79extern struct subsystem module_subsys;
80
81#ifdef MODULE
82#define MODULE_GENERIC_TABLE(gtype,name) \
83extern const struct gtype##_id __mod_##gtype##_table \
84 __attribute__ ((unused, alias(__stringify(name))))
85
86extern struct module __this_module;
87#define THIS_MODULE (&__this_module)
88#else /* !MODULE */
89#define MODULE_GENERIC_TABLE(gtype,name)
90#define THIS_MODULE ((struct module *)0)
91#endif
92
93/* Generic info of form tag = "info" */
94#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
95
96/* For userspace: you can also call me... */
97#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
98
99/*
100 * The following license idents are currently accepted as indicating free
101 * software modules
102 *
103 * "GPL" [GNU Public License v2 or later]
104 * "GPL v2" [GNU Public License v2]
105 * "GPL and additional rights" [GNU Public License v2 rights and more]
106 * "Dual BSD/GPL" [GNU Public License v2
107 * or BSD license choice]
Xose Vazquez Perez8d27e902006-06-23 02:05:13 -0700108 * "Dual MIT/GPL" [GNU Public License v2
109 * or MIT license choice]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 * "Dual MPL/GPL" [GNU Public License v2
111 * or Mozilla license choice]
112 *
113 * The following other idents are available
114 *
115 * "Proprietary" [Non free products]
116 *
117 * There are dual licensed components, but when running with Linux it is the
118 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
119 * is a GPL combined work.
120 *
121 * This exists for several reasons
122 * 1. So modinfo can show license info for users wanting to vet their setup
123 * is free
124 * 2. So the community can ignore bug reports including proprietary modules
125 * 3. So vendors can do likewise based on their own policies
126 */
127#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
128
129/* Author, ideally of form NAME <EMAIL>[, NAME <EMAIL>]*[ and NAME <EMAIL>] */
130#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
131
132/* What your module does. */
133#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
134
135/* One for each parameter, describing how to use it. Some files do
136 multiple of these per line, so can't just use MODULE_INFO. */
137#define MODULE_PARM_DESC(_parm, desc) \
138 __MODULE_INFO(parm, _parm, #_parm ":" desc)
139
140#define MODULE_DEVICE_TABLE(type,name) \
141 MODULE_GENERIC_TABLE(type##_device,name)
142
143/* Version of form [<epoch>:]<version>[-<extra-version>].
144 Or for CVS/RCS ID version, everything but the number is stripped.
145 <epoch>: A (small) unsigned integer which allows you to start versions
146 anew. If not mentioned, it's zero. eg. "2:1.0" is after
147 "1:2.0".
148 <version>: The <version> may contain only alphanumerics and the
149 character `.'. Ordered by numeric sort for numeric parts,
150 ascii sort for ascii parts (as per RPM or DEB algorithm).
151 <extraversion>: Like <version>, but inserted for local
152 customizations, eg "rh3" or "rusty1".
153
154 Using this automatically adds a checksum of the .c files and the
155 local headers in "srcversion".
156*/
157#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
158
Jon Masters187afbe2006-08-28 17:08:21 -0500159/* Optional firmware file (or files) needed by the module
160 * format is simply firmware file name. Multiple firmware
161 * files require multiple MODULE_FIRMWARE() specifiers */
162#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164/* Given an address, look for it in the exception tables */
165const struct exception_table_entry *search_exception_tables(unsigned long add);
166
167struct notifier_block;
168
169#ifdef CONFIG_MODULES
170
171/* Get/put a kernel symbol (calls must be symmetric) */
172void *__symbol_get(const char *symbol);
173void *__symbol_get_gpl(const char *symbol);
174#define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
175
176#ifndef __GENKSYMS__
177#ifdef CONFIG_MODVERSIONS
178/* Mark the CRC weak since genksyms apparently decides not to
179 * generate a checksums for some symbols */
180#define __CRC_SYMBOL(sym, sec) \
181 extern void *__crc_##sym __attribute__((weak)); \
182 static const unsigned long __kcrctab_##sym \
183 __attribute_used__ \
184 __attribute__((section("__kcrctab" sec), unused)) \
185 = (unsigned long) &__crc_##sym;
186#else
187#define __CRC_SYMBOL(sym, sec)
188#endif
189
190/* For every exported symbol, place a struct in the __ksymtab section */
191#define __EXPORT_SYMBOL(sym, sec) \
Patrick McHardya1a8fee2006-03-23 22:07:34 -0800192 extern typeof(sym) sym; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 __CRC_SYMBOL(sym, sec) \
194 static const char __kstrtab_##sym[] \
195 __attribute__((section("__ksymtab_strings"))) \
196 = MODULE_SYMBOL_PREFIX #sym; \
197 static const struct kernel_symbol __ksymtab_##sym \
198 __attribute_used__ \
199 __attribute__((section("__ksymtab" sec), unused)) \
200 = { (unsigned long)&sym, __kstrtab_##sym }
201
202#define EXPORT_SYMBOL(sym) \
203 __EXPORT_SYMBOL(sym, "")
204
205#define EXPORT_SYMBOL_GPL(sym) \
206 __EXPORT_SYMBOL(sym, "_gpl")
207
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800208#define EXPORT_SYMBOL_GPL_FUTURE(sym) \
209 __EXPORT_SYMBOL(sym, "_gpl_future")
210
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700211
212#ifdef CONFIG_UNUSED_SYMBOLS
213#define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
214#define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
215#else
216#define EXPORT_UNUSED_SYMBOL(sym)
217#define EXPORT_UNUSED_SYMBOL_GPL(sym)
218#endif
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220#endif
221
222struct module_ref
223{
224 local_t count;
225} ____cacheline_aligned;
226
227enum module_state
228{
229 MODULE_STATE_LIVE,
230 MODULE_STATE_COMING,
231 MODULE_STATE_GOING,
232};
233
234/* Similar stuff for section attributes. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235struct module_sect_attr
236{
237 struct module_attribute mattr;
Ian S. Nelson04b1db92006-09-29 02:01:31 -0700238 char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 unsigned long address;
240};
241
242struct module_sect_attrs
243{
244 struct attribute_group grp;
Ian S. Nelson04b1db92006-09-29 02:01:31 -0700245 int nsections;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 struct module_sect_attr attrs[0];
247};
248
249struct module_param_attrs;
250
251struct module
252{
253 enum module_state state;
254
255 /* Member of list of modules */
256 struct list_head list;
257
258 /* Unique handle for this module */
259 char name[MODULE_NAME_LEN];
260
261 /* Sysfs stuff. */
262 struct module_kobject mkobj;
263 struct module_param_attrs *param_attrs;
Greg Kroah-Hartman03e88ae12006-02-16 13:50:23 -0800264 struct module_attribute *modinfo_attrs;
Matt Domschc988d2b2005-06-23 22:05:15 -0700265 const char *version;
266 const char *srcversion;
Kay Sievers270a6c42007-01-18 13:26:15 +0100267 struct kobject *holders_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269 /* Exported symbols */
270 const struct kernel_symbol *syms;
271 unsigned int num_syms;
272 const unsigned long *crcs;
273
274 /* GPL-only exported symbols. */
275 const struct kernel_symbol *gpl_syms;
276 unsigned int num_gpl_syms;
277 const unsigned long *gpl_crcs;
278
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700279 /* unused exported symbols. */
280 const struct kernel_symbol *unused_syms;
281 unsigned int num_unused_syms;
282 const unsigned long *unused_crcs;
283 /* GPL-only, unused exported symbols. */
284 const struct kernel_symbol *unused_gpl_syms;
285 unsigned int num_unused_gpl_syms;
286 const unsigned long *unused_gpl_crcs;
287
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800288 /* symbols that will be GPL-only in the near future. */
289 const struct kernel_symbol *gpl_future_syms;
290 unsigned int num_gpl_future_syms;
291 const unsigned long *gpl_future_crcs;
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 /* Exception table */
294 unsigned int num_exentries;
295 const struct exception_table_entry *extable;
296
297 /* Startup function. */
298 int (*init)(void);
299
300 /* If this is non-NULL, vfree after init() returns */
301 void *module_init;
302
303 /* Here is the actual code + data, vfree'd on unload. */
304 void *module_core;
305
306 /* Here are the sizes of the init and core sections */
307 unsigned long init_size, core_size;
308
309 /* The size of the executable code in each section. */
310 unsigned long init_text_size, core_text_size;
311
Jan Beulich4552d5d2006-06-26 13:57:28 +0200312 /* The handle returned from unwind_add_table. */
313 void *unwind_info;
314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 /* Arch-specific module values */
316 struct mod_arch_specific arch;
317
318 /* Am I unsafe to unload? */
319 int unsafe;
320
Randy Dunlap2bc2d612006-10-02 02:17:02 -0700321 unsigned int taints; /* same bits as kernel:tainted */
322
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800323#ifdef CONFIG_GENERIC_BUG
324 /* Support for BUG */
325 struct list_head bug_list;
326 struct bug_entry *bug_table;
327 unsigned num_bugs;
328#endif
329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330#ifdef CONFIG_MODULE_UNLOAD
331 /* Reference counts */
332 struct module_ref ref[NR_CPUS];
333
334 /* What modules depend on me? */
335 struct list_head modules_which_use_me;
336
337 /* Who is waiting for us to be unloaded */
338 struct task_struct *waiter;
339
340 /* Destruction function. */
341 void (*exit)(void);
342#endif
343
344#ifdef CONFIG_KALLSYMS
345 /* We keep the symbol and string tables for kallsyms. */
346 Elf_Sym *symtab;
347 unsigned long num_symtab;
348 char *strtab;
349
350 /* Section attributes */
351 struct module_sect_attrs *sect_attrs;
352#endif
353
354 /* Per-cpu data. */
355 void *percpu;
356
357 /* The command line arguments (may be mangled). People like
358 keeping pointers to this stuff */
359 char *args;
360};
361
362/* FIXME: It'd be nice to isolate modules during init, too, so they
363 aren't used before they (may) fail. But presently too much code
364 (IDE & SCSI) require entry into the module during init.*/
365static inline int module_is_live(struct module *mod)
366{
367 return mod->state != MODULE_STATE_GOING;
368}
369
370/* Is this address in a module? (second is with no locks, for oops) */
371struct module *module_text_address(unsigned long addr);
372struct module *__module_text_address(unsigned long addr);
Ingo Molnar4d435f92006-07-03 00:24:24 -0700373int is_module_address(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375/* Returns module and fills in value, defined and namebuf, or NULL if
376 symnum out of range. */
Andreas Gruenbacher098c5ee2006-07-14 00:24:04 -0700377struct module *module_get_kallsym(unsigned int symnum, unsigned long *value,
378 char *type, char *name, size_t namelen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380/* Look for this name: can be of form module:name. */
381unsigned long module_kallsyms_lookup_name(const char *name);
382
383int is_exported(const char *name, const struct module *mod);
384
385extern void __module_put_and_exit(struct module *mod, long code)
386 __attribute__((noreturn));
387#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
388
389#ifdef CONFIG_MODULE_UNLOAD
390unsigned int module_refcount(struct module *mod);
391void __symbol_put(const char *symbol);
392#define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
393void symbol_put_addr(void *addr);
394
395/* Sometimes we know we already have a refcount, and it's easier not
396 to handle the error case (which only happens with rmmod --wait). */
397static inline void __module_get(struct module *module)
398{
399 if (module) {
400 BUG_ON(module_refcount(module) == 0);
401 local_inc(&module->ref[get_cpu()].count);
402 put_cpu();
403 }
404}
405
406static inline int try_module_get(struct module *module)
407{
408 int ret = 1;
409
410 if (module) {
411 unsigned int cpu = get_cpu();
412 if (likely(module_is_live(module)))
413 local_inc(&module->ref[cpu].count);
414 else
415 ret = 0;
416 put_cpu();
417 }
418 return ret;
419}
420
Al Virof6a57032006-10-18 01:47:25 -0400421extern void module_put(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423#else /*!CONFIG_MODULE_UNLOAD*/
424static inline int try_module_get(struct module *module)
425{
426 return !module || module_is_live(module);
427}
428static inline void module_put(struct module *module)
429{
430}
431static inline void __module_get(struct module *module)
432{
433}
434#define symbol_put(x) do { } while(0)
435#define symbol_put_addr(p) do { } while(0)
436
437#endif /* CONFIG_MODULE_UNLOAD */
438
439/* This is a #define so the string doesn't get put in every .o file */
440#define module_name(mod) \
441({ \
442 struct module *__mod = (mod); \
443 __mod ? __mod->name : "kernel"; \
444})
445
446#define __unsafe(mod) \
447do { \
448 if (mod && !(mod)->unsafe) { \
449 printk(KERN_WARNING \
450 "Module %s cannot be unloaded due to unsafe usage in" \
451 " %s:%u\n", (mod)->name, __FILE__, __LINE__); \
452 (mod)->unsafe = 1; \
453 } \
454} while(0)
455
456/* For kallsyms to ask for address resolution. NULL means not found. */
457const char *module_address_lookup(unsigned long addr,
458 unsigned long *symbolsize,
459 unsigned long *offset,
460 char **modname);
461
462/* For extable.c to search modules' exception tables. */
463const struct exception_table_entry *search_module_extables(unsigned long addr);
464
465int register_module_notifier(struct notifier_block * nb);
466int unregister_module_notifier(struct notifier_block * nb);
467
468extern void print_modules(void);
469
470struct device_driver;
471void module_add_driver(struct module *, struct device_driver *);
472void module_remove_driver(struct device_driver *);
473
474#else /* !CONFIG_MODULES... */
475#define EXPORT_SYMBOL(sym)
476#define EXPORT_SYMBOL_GPL(sym)
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800477#define EXPORT_SYMBOL_GPL_FUTURE(sym)
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700478#define EXPORT_UNUSED_SYMBOL(sym)
479#define EXPORT_UNUSED_SYMBOL_GPL(sym)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
481/* Given an address, look for it in the exception tables. */
482static inline const struct exception_table_entry *
483search_module_extables(unsigned long addr)
484{
485 return NULL;
486}
487
488/* Is this address in a module? */
489static inline struct module *module_text_address(unsigned long addr)
490{
491 return NULL;
492}
493
494/* Is this address in a module? (don't take a lock, we're oopsing) */
495static inline struct module *__module_text_address(unsigned long addr)
496{
497 return NULL;
498}
499
Ingo Molnar4d435f92006-07-03 00:24:24 -0700500static inline int is_module_address(unsigned long addr)
501{
502 return 0;
503}
504
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505/* Get/put a kernel symbol (calls should be symmetric) */
506#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
507#define symbol_put(x) do { } while(0)
508#define symbol_put_addr(x) do { } while(0)
509
510static inline void __module_get(struct module *module)
511{
512}
513
514static inline int try_module_get(struct module *module)
515{
516 return 1;
517}
518
519static inline void module_put(struct module *module)
520{
521}
522
523#define module_name(mod) "kernel"
524
525#define __unsafe(mod)
526
527/* For kallsyms to ask for address resolution. NULL means not found. */
528static inline const char *module_address_lookup(unsigned long addr,
529 unsigned long *symbolsize,
530 unsigned long *offset,
531 char **modname)
532{
533 return NULL;
534}
535
536static inline struct module *module_get_kallsym(unsigned int symnum,
537 unsigned long *value,
Andreas Gruenbacher098c5ee2006-07-14 00:24:04 -0700538 char *type, char *name,
539 size_t namelen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540{
541 return NULL;
542}
543
544static inline unsigned long module_kallsyms_lookup_name(const char *name)
545{
546 return 0;
547}
548
549static inline int is_exported(const char *name, const struct module *mod)
550{
551 return 0;
552}
553
554static inline int register_module_notifier(struct notifier_block * nb)
555{
556 /* no events will happen anyway, so this can always succeed */
557 return 0;
558}
559
560static inline int unregister_module_notifier(struct notifier_block * nb)
561{
562 return 0;
563}
564
565#define module_put_and_exit(code) do_exit(code)
566
567static inline void print_modules(void)
568{
569}
570
571struct device_driver;
572struct module;
573
574static inline void module_add_driver(struct module *module, struct device_driver *driver)
575{
576}
577
578static inline void module_remove_driver(struct device_driver *driver)
579{
580}
581
582#endif /* CONFIG_MODULES */
583
584#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
585
586/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588#define __MODULE_STRING(x) __stringify(x)
589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590#endif /* _LINUX_MODULE_H */