blob: f05372b7fe7746a48a838a310b18e3115c0e55ef [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 */
9#include <linux/config.h>
10#include <linux/sched.h>
11#include <linux/spinlock.h>
12#include <linux/list.h>
13#include <linux/stat.h>
14#include <linux/compiler.h>
15#include <linux/cache.h>
16#include <linux/kmod.h>
17#include <linux/elf.h>
18#include <linux/stringify.h>
19#include <linux/kobject.h>
20#include <linux/moduleparam.h>
21#include <asm/local.h>
22
23#include <asm/module.h>
24
25/* Not Yet Implemented */
26#define MODULE_SUPPORTED_DEVICE(name)
27
28/* v850 toolchain uses a `_' prefix for all user symbols */
29#ifndef MODULE_SYMBOL_PREFIX
30#define MODULE_SYMBOL_PREFIX ""
31#endif
32
33#define MODULE_NAME_LEN (64 - sizeof(unsigned long))
34
35struct kernel_symbol
36{
37 unsigned long value;
38 const char *name;
39};
40
41struct modversion_info
42{
43 unsigned long crc;
44 char name[MODULE_NAME_LEN];
45};
46
47struct module;
48
49struct 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);
Matt Domschc988d2b2005-06-23 22:05:15 -070054 void (*setup)(struct module *, const char *);
55 int (*test)(struct module *);
56 void (*free)(struct module *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057};
58
59struct module_kobject
60{
61 struct kobject kobj;
62 struct module *mod;
63};
64
65/* These are either module local, or the kernel's dummy ones. */
66extern int init_module(void);
67extern void cleanup_module(void);
68
69/* Archs provide a method of finding the correct exception table. */
70struct exception_table_entry;
71
72const struct exception_table_entry *
73search_extable(const struct exception_table_entry *first,
74 const struct exception_table_entry *last,
75 unsigned long value);
76void sort_extable(struct exception_table_entry *start,
77 struct exception_table_entry *finish);
78void sort_main_extable(void);
79
80extern struct subsystem module_subsys;
81
82#ifdef MODULE
83#define MODULE_GENERIC_TABLE(gtype,name) \
84extern const struct gtype##_id __mod_##gtype##_table \
85 __attribute__ ((unused, alias(__stringify(name))))
86
87extern 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 MPL/GPL" [GNU Public License v2
110 * or Mozilla license choice]
111 *
112 * The following other idents are available
113 *
114 * "Proprietary" [Non free products]
115 *
116 * There are dual licensed components, but when running with Linux it is the
117 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
118 * is a GPL combined work.
119 *
120 * This exists for several reasons
121 * 1. So modinfo can show license info for users wanting to vet their setup
122 * is free
123 * 2. So the community can ignore bug reports including proprietary modules
124 * 3. So vendors can do likewise based on their own policies
125 */
126#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
127
128/* Author, ideally of form NAME <EMAIL>[, NAME <EMAIL>]*[ and NAME <EMAIL>] */
129#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
130
131/* What your module does. */
132#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
133
134/* One for each parameter, describing how to use it. Some files do
135 multiple of these per line, so can't just use MODULE_INFO. */
136#define MODULE_PARM_DESC(_parm, desc) \
137 __MODULE_INFO(parm, _parm, #_parm ":" desc)
138
139#define MODULE_DEVICE_TABLE(type,name) \
140 MODULE_GENERIC_TABLE(type##_device,name)
141
142/* Version of form [<epoch>:]<version>[-<extra-version>].
143 Or for CVS/RCS ID version, everything but the number is stripped.
144 <epoch>: A (small) unsigned integer which allows you to start versions
145 anew. If not mentioned, it's zero. eg. "2:1.0" is after
146 "1:2.0".
147 <version>: The <version> may contain only alphanumerics and the
148 character `.'. Ordered by numeric sort for numeric parts,
149 ascii sort for ascii parts (as per RPM or DEB algorithm).
150 <extraversion>: Like <version>, but inserted for local
151 customizations, eg "rh3" or "rusty1".
152
153 Using this automatically adds a checksum of the .c files and the
154 local headers in "srcversion".
155*/
156#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
157
158/* Given an address, look for it in the exception tables */
159const struct exception_table_entry *search_exception_tables(unsigned long add);
160
161struct notifier_block;
162
163#ifdef CONFIG_MODULES
164
165/* Get/put a kernel symbol (calls must be symmetric) */
166void *__symbol_get(const char *symbol);
167void *__symbol_get_gpl(const char *symbol);
168#define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
169
170#ifndef __GENKSYMS__
171#ifdef CONFIG_MODVERSIONS
172/* Mark the CRC weak since genksyms apparently decides not to
173 * generate a checksums for some symbols */
174#define __CRC_SYMBOL(sym, sec) \
175 extern void *__crc_##sym __attribute__((weak)); \
176 static const unsigned long __kcrctab_##sym \
177 __attribute_used__ \
178 __attribute__((section("__kcrctab" sec), unused)) \
179 = (unsigned long) &__crc_##sym;
180#else
181#define __CRC_SYMBOL(sym, sec)
182#endif
183
184/* For every exported symbol, place a struct in the __ksymtab section */
185#define __EXPORT_SYMBOL(sym, sec) \
186 __CRC_SYMBOL(sym, sec) \
187 static const char __kstrtab_##sym[] \
188 __attribute__((section("__ksymtab_strings"))) \
189 = MODULE_SYMBOL_PREFIX #sym; \
190 static const struct kernel_symbol __ksymtab_##sym \
191 __attribute_used__ \
192 __attribute__((section("__ksymtab" sec), unused)) \
193 = { (unsigned long)&sym, __kstrtab_##sym }
194
195#define EXPORT_SYMBOL(sym) \
196 __EXPORT_SYMBOL(sym, "")
197
198#define EXPORT_SYMBOL_GPL(sym) \
199 __EXPORT_SYMBOL(sym, "_gpl")
200
201#endif
202
203struct module_ref
204{
205 local_t count;
206} ____cacheline_aligned;
207
208enum module_state
209{
210 MODULE_STATE_LIVE,
211 MODULE_STATE_COMING,
212 MODULE_STATE_GOING,
213};
214
215/* Similar stuff for section attributes. */
216#define MODULE_SECT_NAME_LEN 32
217struct module_sect_attr
218{
219 struct module_attribute mattr;
220 char name[MODULE_SECT_NAME_LEN];
221 unsigned long address;
222};
223
224struct module_sect_attrs
225{
226 struct attribute_group grp;
227 struct module_sect_attr attrs[0];
228};
229
230struct module_param_attrs;
231
232struct module
233{
234 enum module_state state;
235
236 /* Member of list of modules */
237 struct list_head list;
238
239 /* Unique handle for this module */
240 char name[MODULE_NAME_LEN];
241
242 /* Sysfs stuff. */
243 struct module_kobject mkobj;
244 struct module_param_attrs *param_attrs;
Matt Domschc988d2b2005-06-23 22:05:15 -0700245 const char *version;
246 const char *srcversion;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 /* Exported symbols */
249 const struct kernel_symbol *syms;
250 unsigned int num_syms;
251 const unsigned long *crcs;
252
253 /* GPL-only exported symbols. */
254 const struct kernel_symbol *gpl_syms;
255 unsigned int num_gpl_syms;
256 const unsigned long *gpl_crcs;
257
258 /* Exception table */
259 unsigned int num_exentries;
260 const struct exception_table_entry *extable;
261
262 /* Startup function. */
263 int (*init)(void);
264
265 /* If this is non-NULL, vfree after init() returns */
266 void *module_init;
267
268 /* Here is the actual code + data, vfree'd on unload. */
269 void *module_core;
270
271 /* Here are the sizes of the init and core sections */
272 unsigned long init_size, core_size;
273
274 /* The size of the executable code in each section. */
275 unsigned long init_text_size, core_text_size;
276
277 /* Arch-specific module values */
278 struct mod_arch_specific arch;
279
280 /* Am I unsafe to unload? */
281 int unsafe;
282
283 /* Am I GPL-compatible */
284 int license_gplok;
285
286#ifdef CONFIG_MODULE_UNLOAD
287 /* Reference counts */
288 struct module_ref ref[NR_CPUS];
289
290 /* What modules depend on me? */
291 struct list_head modules_which_use_me;
292
293 /* Who is waiting for us to be unloaded */
294 struct task_struct *waiter;
295
296 /* Destruction function. */
297 void (*exit)(void);
298#endif
299
300#ifdef CONFIG_KALLSYMS
301 /* We keep the symbol and string tables for kallsyms. */
302 Elf_Sym *symtab;
303 unsigned long num_symtab;
304 char *strtab;
305
306 /* Section attributes */
307 struct module_sect_attrs *sect_attrs;
308#endif
309
310 /* Per-cpu data. */
311 void *percpu;
312
313 /* The command line arguments (may be mangled). People like
314 keeping pointers to this stuff */
315 char *args;
316};
317
318/* FIXME: It'd be nice to isolate modules during init, too, so they
319 aren't used before they (may) fail. But presently too much code
320 (IDE & SCSI) require entry into the module during init.*/
321static inline int module_is_live(struct module *mod)
322{
323 return mod->state != MODULE_STATE_GOING;
324}
325
326/* Is this address in a module? (second is with no locks, for oops) */
327struct module *module_text_address(unsigned long addr);
328struct module *__module_text_address(unsigned long addr);
329
330/* Returns module and fills in value, defined and namebuf, or NULL if
331 symnum out of range. */
332struct module *module_get_kallsym(unsigned int symnum,
333 unsigned long *value,
334 char *type,
335 char namebuf[128]);
336
337/* Look for this name: can be of form module:name. */
338unsigned long module_kallsyms_lookup_name(const char *name);
339
340int is_exported(const char *name, const struct module *mod);
341
342extern void __module_put_and_exit(struct module *mod, long code)
343 __attribute__((noreturn));
344#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
345
346#ifdef CONFIG_MODULE_UNLOAD
347unsigned int module_refcount(struct module *mod);
348void __symbol_put(const char *symbol);
349#define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
350void symbol_put_addr(void *addr);
351
352/* Sometimes we know we already have a refcount, and it's easier not
353 to handle the error case (which only happens with rmmod --wait). */
354static inline void __module_get(struct module *module)
355{
356 if (module) {
357 BUG_ON(module_refcount(module) == 0);
358 local_inc(&module->ref[get_cpu()].count);
359 put_cpu();
360 }
361}
362
363static inline int try_module_get(struct module *module)
364{
365 int ret = 1;
366
367 if (module) {
368 unsigned int cpu = get_cpu();
369 if (likely(module_is_live(module)))
370 local_inc(&module->ref[cpu].count);
371 else
372 ret = 0;
373 put_cpu();
374 }
375 return ret;
376}
377
378static inline void module_put(struct module *module)
379{
380 if (module) {
381 unsigned int cpu = get_cpu();
382 local_dec(&module->ref[cpu].count);
383 /* Maybe they're waiting for us to drop reference? */
384 if (unlikely(!module_is_live(module)))
385 wake_up_process(module->waiter);
386 put_cpu();
387 }
388}
389
390#else /*!CONFIG_MODULE_UNLOAD*/
391static inline int try_module_get(struct module *module)
392{
393 return !module || module_is_live(module);
394}
395static inline void module_put(struct module *module)
396{
397}
398static inline void __module_get(struct module *module)
399{
400}
401#define symbol_put(x) do { } while(0)
402#define symbol_put_addr(p) do { } while(0)
403
404#endif /* CONFIG_MODULE_UNLOAD */
405
406/* This is a #define so the string doesn't get put in every .o file */
407#define module_name(mod) \
408({ \
409 struct module *__mod = (mod); \
410 __mod ? __mod->name : "kernel"; \
411})
412
413#define __unsafe(mod) \
414do { \
415 if (mod && !(mod)->unsafe) { \
416 printk(KERN_WARNING \
417 "Module %s cannot be unloaded due to unsafe usage in" \
418 " %s:%u\n", (mod)->name, __FILE__, __LINE__); \
419 (mod)->unsafe = 1; \
420 } \
421} while(0)
422
423/* For kallsyms to ask for address resolution. NULL means not found. */
424const char *module_address_lookup(unsigned long addr,
425 unsigned long *symbolsize,
426 unsigned long *offset,
427 char **modname);
428
429/* For extable.c to search modules' exception tables. */
430const struct exception_table_entry *search_module_extables(unsigned long addr);
431
432int register_module_notifier(struct notifier_block * nb);
433int unregister_module_notifier(struct notifier_block * nb);
434
435extern void print_modules(void);
436
437struct device_driver;
438void module_add_driver(struct module *, struct device_driver *);
439void module_remove_driver(struct device_driver *);
440
441#else /* !CONFIG_MODULES... */
442#define EXPORT_SYMBOL(sym)
443#define EXPORT_SYMBOL_GPL(sym)
444
445/* Given an address, look for it in the exception tables. */
446static inline const struct exception_table_entry *
447search_module_extables(unsigned long addr)
448{
449 return NULL;
450}
451
452/* Is this address in a module? */
453static inline struct module *module_text_address(unsigned long addr)
454{
455 return NULL;
456}
457
458/* Is this address in a module? (don't take a lock, we're oopsing) */
459static inline struct module *__module_text_address(unsigned long addr)
460{
461 return NULL;
462}
463
464/* Get/put a kernel symbol (calls should be symmetric) */
465#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
466#define symbol_put(x) do { } while(0)
467#define symbol_put_addr(x) do { } while(0)
468
469static inline void __module_get(struct module *module)
470{
471}
472
473static inline int try_module_get(struct module *module)
474{
475 return 1;
476}
477
478static inline void module_put(struct module *module)
479{
480}
481
482#define module_name(mod) "kernel"
483
484#define __unsafe(mod)
485
486/* For kallsyms to ask for address resolution. NULL means not found. */
487static inline const char *module_address_lookup(unsigned long addr,
488 unsigned long *symbolsize,
489 unsigned long *offset,
490 char **modname)
491{
492 return NULL;
493}
494
495static inline struct module *module_get_kallsym(unsigned int symnum,
496 unsigned long *value,
497 char *type,
498 char namebuf[128])
499{
500 return NULL;
501}
502
503static inline unsigned long module_kallsyms_lookup_name(const char *name)
504{
505 return 0;
506}
507
508static inline int is_exported(const char *name, const struct module *mod)
509{
510 return 0;
511}
512
513static inline int register_module_notifier(struct notifier_block * nb)
514{
515 /* no events will happen anyway, so this can always succeed */
516 return 0;
517}
518
519static inline int unregister_module_notifier(struct notifier_block * nb)
520{
521 return 0;
522}
523
524#define module_put_and_exit(code) do_exit(code)
525
526static inline void print_modules(void)
527{
528}
529
530struct device_driver;
531struct module;
532
533static inline void module_add_driver(struct module *module, struct device_driver *driver)
534{
535}
536
537static inline void module_remove_driver(struct device_driver *driver)
538{
539}
540
541#endif /* CONFIG_MODULES */
542
543#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
544
545/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
546
547struct obsolete_modparm {
548 char name[64];
549 char type[64-sizeof(void *)];
550 void *addr;
551};
552
553static inline void MODULE_PARM_(void) { }
554#ifdef MODULE
555/* DEPRECATED: Do not use. */
556#define MODULE_PARM(var,type) \
557struct obsolete_modparm __parm_##var __attribute__((section("__obsparm"))) = \
558{ __stringify(var), type, &MODULE_PARM_ }; \
559__MODULE_PARM_TYPE(var, type);
560#else
561#define MODULE_PARM(var,type) static void __attribute__((__unused__)) *__parm_##var = &MODULE_PARM_;
562#endif
563
564#define __MODULE_STRING(x) __stringify(x)
565
566/* Use symbol_get and symbol_put instead. You'll thank me. */
567#define HAVE_INTER_MODULE
568extern void __deprecated inter_module_register(const char *,
569 struct module *, const void *);
570extern void __deprecated inter_module_unregister(const char *);
571extern const void * __deprecated inter_module_get_request(const char *,
572 const char *);
573extern void __deprecated inter_module_put(const char *);
574
575#endif /* _LINUX_MODULE_H */