projects/linux·blob v2.6.19-rc1 · refs

595 lines · 15.8 KiB

1#ifndef _LINUX_MODULE_H
2#define _LINUX_MODULE_H
3/*
4 * Dynamic loading of modules into the kernel.
5 *
6 * Rewritten by Richard Henderson <[email protected]> Dec 1996
7 * Rewritten again by Rusty Russell, 2002
8 */
9#include <linux/sched.h>
10#include <linux/spinlock.h>
11#include <linux/list.h>
12#include <linux/stat.h>
13#include <linux/compiler.h>
14#include <linux/cache.h>
15#include <linux/kmod.h>
16#include <linux/elf.h>
17#include <linux/stringify.h>
18#include <linux/kobject.h>
19#include <linux/moduleparam.h>
20#include <asm/local.h>
21
22#include <asm/module.h>
23
24/* Not Yet Implemented */
25#define MODULE_SUPPORTED_DEVICE(name)
26
27/* v850 toolchain uses a `_' prefix for all user symbols */
28#ifndef MODULE_SYMBOL_PREFIX
29#define MODULE_SYMBOL_PREFIX ""
30#endif
31
32#define MODULE_NAME_LEN (64 - sizeof(unsigned long))
33
34struct kernel_symbol
35{
36 unsigned long value;
37 const char *name;
38};
39
40struct modversion_info
41{
42 unsigned long crc;
43 char name[MODULE_NAME_LEN];
44};
45
46struct module;
47
48struct module_attribute {
49 struct attribute attr;
50 ssize_t (*show)(struct module_attribute *, struct module *, char *);
51 ssize_t (*store)(struct module_attribute *, struct module *,
52 const char *, size_t count);
53 void (*setup)(struct module *, const char *);
54 int (*test)(struct module *);
55 void (*free)(struct module *);
56};
57
58struct module_kobject
59{
60 struct kobject kobj;
61 struct module *mod;
62};
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]
108 * "Dual MIT/GPL" [GNU Public License v2
109 * or MIT license choice]
110 * "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
159/* 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
164/* 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) \
192 extern typeof(sym) sym; \
193 __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
208#define EXPORT_SYMBOL_GPL_FUTURE(sym) \
209 __EXPORT_SYMBOL(sym, "_gpl_future")
210
211
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
220#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. */
235struct module_sect_attr
236{
237 struct module_attribute mattr;
238 char *name;
239 unsigned long address;
240};
241
242struct module_sect_attrs
243{
244 struct attribute_group grp;
245 int nsections;
246 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;
264 struct module_attribute *modinfo_attrs;
265 const char *version;
266 const char *srcversion;
267
268 /* Exported symbols */
269 const struct kernel_symbol *syms;
270 unsigned int num_syms;
271 const unsigned long *crcs;
272
273 /* GPL-only exported symbols. */
274 const struct kernel_symbol *gpl_syms;
275 unsigned int num_gpl_syms;
276 const unsigned long *gpl_crcs;
277
278 /* unused exported symbols. */
279 const struct kernel_symbol *unused_syms;
280 unsigned int num_unused_syms;
281 const unsigned long *unused_crcs;
282 /* GPL-only, unused exported symbols. */
283 const struct kernel_symbol *unused_gpl_syms;
284 unsigned int num_unused_gpl_syms;
285 const unsigned long *unused_gpl_crcs;
286
287 /* symbols that will be GPL-only in the near future. */
288 const struct kernel_symbol *gpl_future_syms;
289 unsigned int num_gpl_future_syms;
290 const unsigned long *gpl_future_crcs;
291
292 /* Exception table */
293 unsigned int num_exentries;
294 const struct exception_table_entry *extable;
295
296 /* Startup function. */
297 int (*init)(void);
298
299 /* If this is non-NULL, vfree after init() returns */
300 void *module_init;
301
302 /* Here is the actual code + data, vfree'd on unload. */
303 void *module_core;
304
305 /* Here are the sizes of the init and core sections */
306 unsigned long init_size, core_size;
307
308 /* The size of the executable code in each section. */
309 unsigned long init_text_size, core_text_size;
310
311 /* The handle returned from unwind_add_table. */
312 void *unwind_info;
313
314 /* Arch-specific module values */
315 struct mod_arch_specific arch;
316
317 /* Am I unsafe to unload? */
318 int unsafe;
319
320 /* Am I GPL-compatible */
321 int license_gplok;
322
323 unsigned int taints; /* same bits as kernel:tainted */
324
325#ifdef CONFIG_MODULE_UNLOAD
326 /* Reference counts */
327 struct module_ref ref[NR_CPUS];
328
329 /* What modules depend on me? */
330 struct list_head modules_which_use_me;
331
332 /* Who is waiting for us to be unloaded */
333 struct task_struct *waiter;
334
335 /* Destruction function. */
336 void (*exit)(void);
337#endif
338
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;
344
345 /* Section attributes */
346 struct module_sect_attrs *sect_attrs;
347#endif
348
349 /* Per-cpu data. */
350 void *percpu;
351
352 /* The command line arguments (may be mangled). People like
353 keeping pointers to this stuff */
354 char *args;
355};
356
357/* FIXME: It'd be nice to isolate modules during init, too, so they
358 aren't used before they (may) fail. But presently too much code
359 (IDE & SCSI) require entry into the module during init.*/
360static inline int module_is_live(struct module *mod)
361{
362 return mod->state != MODULE_STATE_GOING;
363}
364
365/* Is this address in a module? (second is with no locks, for oops) */
366struct module *module_text_address(unsigned long addr);
367struct module *__module_text_address(unsigned long addr);
368int is_module_address(unsigned long addr);
369
370/* Returns module and fills in value, defined and namebuf, or NULL if
371 symnum out of range. */
372struct module *module_get_kallsym(unsigned int symnum, unsigned long *value,
373 char *type, char *name, size_t namelen);
374
375/* Look for this name: can be of form module:name. */
376unsigned long module_kallsyms_lookup_name(const char *name);
377
378int is_exported(const char *name, const struct module *mod);
379
380extern void __module_put_and_exit(struct module *mod, long code)
381 __attribute__((noreturn));
382#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
383
384#ifdef CONFIG_MODULE_UNLOAD
385unsigned int module_refcount(struct module *mod);
386void __symbol_put(const char *symbol);
387#define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
388void symbol_put_addr(void *addr);
389
390/* Sometimes we know we already have a refcount, and it's easier not
391 to handle the error case (which only happens with rmmod --wait). */
392static inline void __module_get(struct module *module)
393{
394 if (module) {
395 BUG_ON(module_refcount(module) == 0);
396 local_inc(&module->ref[get_cpu()].count);
397 put_cpu();
398 }
399}
400
401static inline int try_module_get(struct module *module)
402{
403 int ret = 1;
404
405 if (module) {
406 unsigned int cpu = get_cpu();
407 if (likely(module_is_live(module)))
408 local_inc(&module->ref[cpu].count);
409 else
410 ret = 0;
411 put_cpu();
412 }
413 return ret;
414}
415
416static inline void module_put(struct module *module)
417{
418 if (module) {
419 unsigned int cpu = get_cpu();
420 local_dec(&module->ref[cpu].count);
421 /* Maybe they're waiting for us to drop reference? */
422 if (unlikely(!module_is_live(module)))
423 wake_up_process(module->waiter);
424 put_cpu();
425 }
426}
427
428#else /*!CONFIG_MODULE_UNLOAD*/
429static inline int try_module_get(struct module *module)
430{
431 return !module || module_is_live(module);
432}
433static inline void module_put(struct module *module)
434{
435}
436static inline void __module_get(struct module *module)
437{
438}
439#define symbol_put(x) do { } while(0)
440#define symbol_put_addr(p) do { } while(0)
441
442#endif /* CONFIG_MODULE_UNLOAD */
443
444/* This is a #define so the string doesn't get put in every .o file */
445#define module_name(mod) \
446({ \
447 struct module *__mod = (mod); \
448 __mod ? __mod->name : "kernel"; \
449})
450
451#define __unsafe(mod) \
452do { \
453 if (mod && !(mod)->unsafe) { \
454 printk(KERN_WARNING \
455 "Module %s cannot be unloaded due to unsafe usage in" \
456 " %s:%u\n", (mod)->name, __FILE__, __LINE__); \
457 (mod)->unsafe = 1; \
458 } \
459} while(0)
460
461/* For kallsyms to ask for address resolution. NULL means not found. */
462const char *module_address_lookup(unsigned long addr,
463 unsigned long *symbolsize,
464 unsigned long *offset,
465 char **modname);
466
467/* For extable.c to search modules' exception tables. */
468const struct exception_table_entry *search_module_extables(unsigned long addr);
469
470int register_module_notifier(struct notifier_block * nb);
471int unregister_module_notifier(struct notifier_block * nb);
472
473extern void print_modules(void);
474
475struct device_driver;
476void module_add_driver(struct module *, struct device_driver *);
477void module_remove_driver(struct device_driver *);
478
479#else /* !CONFIG_MODULES... */
480#define EXPORT_SYMBOL(sym)
481#define EXPORT_SYMBOL_GPL(sym)
482#define EXPORT_SYMBOL_GPL_FUTURE(sym)
483#define EXPORT_UNUSED_SYMBOL(sym)
484#define EXPORT_UNUSED_SYMBOL_GPL(sym)
485
486/* Given an address, look for it in the exception tables. */
487static inline const struct exception_table_entry *
488search_module_extables(unsigned long addr)
489{
490 return NULL;
491}
492
493/* Is this address in a module? */
494static inline struct module *module_text_address(unsigned long addr)
495{
496 return NULL;
497}
498
499/* Is this address in a module? (don't take a lock, we're oopsing) */
500static inline struct module *__module_text_address(unsigned long addr)
501{
502 return NULL;
503}
504
505static inline int is_module_address(unsigned long addr)
506{
507 return 0;
508}
509
510/* Get/put a kernel symbol (calls should be symmetric) */
511#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
512#define symbol_put(x) do { } while(0)
513#define symbol_put_addr(x) do { } while(0)
514
515static inline void __module_get(struct module *module)
516{
517}
518
519static inline int try_module_get(struct module *module)
520{
521 return 1;
522}
523
524static inline void module_put(struct module *module)
525{
526}
527
528#define module_name(mod) "kernel"
529
530#define __unsafe(mod)
531
532/* For kallsyms to ask for address resolution. NULL means not found. */
533static inline const char *module_address_lookup(unsigned long addr,
534 unsigned long *symbolsize,
535 unsigned long *offset,
536 char **modname)
537{
538 return NULL;
539}
540
541static inline struct module *module_get_kallsym(unsigned int symnum,
542 unsigned long *value,
543 char *type, char *name,
544 size_t namelen)
545{
546 return NULL;
547}
548
549static inline unsigned long module_kallsyms_lookup_name(const char *name)
550{
551 return 0;
552}
553
554static inline int is_exported(const char *name, const struct module *mod)
555{
556 return 0;
557}
558
559static inline int register_module_notifier(struct notifier_block * nb)
560{
561 /* no events will happen anyway, so this can always succeed */
562 return 0;
563}
564
565static inline int unregister_module_notifier(struct notifier_block * nb)
566{
567 return 0;
568}
569
570#define module_put_and_exit(code) do_exit(code)
571
572static inline void print_modules(void)
573{
574}
575
576struct device_driver;
577struct module;
578
579static inline void module_add_driver(struct module *module, struct device_driver *driver)
580{
581}
582
583static inline void module_remove_driver(struct device_driver *driver)
584{
585}
586
587#endif /* CONFIG_MODULES */
588
589#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
590
591/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
592
593#define __MODULE_STRING(x) __stringify(x)
594
595#endif /* _LINUX_MODULE_H */