1 #ifndef _LINUX_MODULE_H
2 #define _LINUX_MODULE_H
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
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 <asm/local.h>
21 #include <asm/module.h>
23 /* Not Yet Implemented */
24 #define MODULE_SUPPORTED_DEVICE(name)
25 #define print_modules()
27 /* v850 toolchain uses a `_' prefix for all user symbols */
28 #ifndef MODULE_SYMBOL_PREFIX
29 #define MODULE_SYMBOL_PREFIX ""
32 #define MODULE_NAME_LEN (64 - sizeof(unsigned long))
40 struct modversion_info
43 char name
[MODULE_NAME_LEN
];
46 /* These are either module local, or the kernel's dummy ones. */
47 extern int init_module(void);
48 extern void cleanup_module(void);
50 /* Archs provide a method of finding the correct exception table. */
51 struct exception_table_entry
;
53 const struct exception_table_entry
*
54 search_extable(const struct exception_table_entry
*first
,
55 const struct exception_table_entry
*last
,
57 void sort_extable(struct exception_table_entry
*start
,
58 struct exception_table_entry
*finish
);
59 void sort_main_extable(void);
62 #define ___module_cat(a,b) __mod_ ## a ## b
63 #define __module_cat(a,b) ___module_cat(a,b)
64 #define __MODULE_INFO(tag, name, info) \
65 static const char __module_cat(name,__LINE__)[] \
67 __attribute__((section(".modinfo"),unused)) = __stringify(tag) "=" info
69 #define MODULE_GENERIC_TABLE(gtype,name) \
70 extern const struct gtype##_id __mod_##gtype##_table \
71 __attribute__ ((unused, alias(__stringify(name))))
73 extern struct module __this_module
;
74 #define THIS_MODULE (&__this_module)
78 #define MODULE_GENERIC_TABLE(gtype,name)
79 #define __MODULE_INFO(tag, name, info)
80 #define THIS_MODULE ((struct module *)0)
83 /* Generic info of form tag = "info" */
84 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
86 /* For userspace: you can also call me... */
87 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
90 * The following license idents are currently accepted as indicating free
93 * "GPL" [GNU Public License v2 or later]
94 * "GPL v2" [GNU Public License v2]
95 * "GPL and additional rights" [GNU Public License v2 rights and more]
96 * "Dual BSD/GPL" [GNU Public License v2
97 * or BSD license choice]
98 * "Dual MPL/GPL" [GNU Public License v2
99 * or Mozilla license choice]
101 * The following other idents are available
103 * "Proprietary" [Non free products]
105 * There are dual licensed components, but when running with Linux it is the
106 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
107 * is a GPL combined work.
109 * This exists for several reasons
110 * 1. So modinfo can show license info for users wanting to vet their setup
112 * 2. So the community can ignore bug reports including proprietary modules
113 * 3. So vendors can do likewise based on their own policies
115 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
117 /* Author, ideally of form NAME <EMAIL>[, NAME <EMAIL>]*[ and NAME <EMAIL>] */
118 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
120 /* What your module does. */
121 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
123 /* One for each parameter, describing how to use it. Some files do
124 multiple of these per line, so can't just use MODULE_INFO. */
125 #define MODULE_PARM_DESC(_parm, desc) \
126 __MODULE_INFO(parm, _parm, #_parm ":" desc)
128 #define MODULE_DEVICE_TABLE(type,name) \
129 MODULE_GENERIC_TABLE(type##_device,name)
131 /* Version of form [<epoch>:]<version>[-<extra-version>].
132 Or for CVS/RCS ID version, everything but the number is stripped.
133 <epoch>: A (small) unsigned integer which allows you to start versions
134 anew. If not mentioned, it's zero. eg. "2:1.0" is after
136 <version>: The <version> may contain only alphanumerics and the
137 character `.'. Ordered by numeric sort for numeric parts,
138 ascii sort for ascii parts (as per RPM or DEB algorithm).
139 <extraversion>: Like <version>, but inserted for local
140 customizations, eg "rh3" or "rusty1".
142 Using this automatically adds a checksum of the .c files and the
143 local headers to the end. Use MODULE_VERSION("") if you want just
144 this. Macro includes room for this.
146 #define MODULE_VERSION(_version) \
147 MODULE_INFO(version, _version "\0xxxxxxxxxxxxxxxxxxxxxxxx")
149 /* Given an address, look for it in the exception tables */
150 const struct exception_table_entry
*search_exception_tables(unsigned long add
);
152 struct notifier_block
;
154 #ifdef CONFIG_MODULES
156 /* Get/put a kernel symbol (calls must be symmetric) */
157 void *__symbol_get(const char *symbol
);
158 void *__symbol_get_gpl(const char *symbol
);
159 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
162 #ifdef CONFIG_MODVERSIONS
163 /* Mark the CRC weak since genksyms apparently decides not to
164 * generate a checksums for some symbols */
165 #define __CRC_SYMBOL(sym, sec) \
166 extern void *__crc_##sym __attribute__((weak)); \
167 static const unsigned long __kcrctab_##sym \
169 __attribute__((section("__kcrctab" sec), unused)) \
170 = (unsigned long) &__crc_##sym;
172 #define __CRC_SYMBOL(sym, sec)
175 /* For every exported symbol, place a struct in the __ksymtab section */
176 #define __EXPORT_SYMBOL(sym, sec) \
177 __CRC_SYMBOL(sym, sec) \
178 static const char __kstrtab_##sym[] \
179 __attribute__((section("__ksymtab_strings"))) \
180 = MODULE_SYMBOL_PREFIX #sym; \
181 static const struct kernel_symbol __ksymtab_##sym \
183 __attribute__((section("__ksymtab" sec), unused)) \
184 = { (unsigned long)&sym, __kstrtab_##sym }
186 #define EXPORT_SYMBOL(sym) \
187 __EXPORT_SYMBOL(sym, "")
189 #define EXPORT_SYMBOL_GPL(sym) \
190 __EXPORT_SYMBOL(sym, "_gpl")
194 /* We don't mangle the actual symbol anymore, so no need for
195 * special casing EXPORT_SYMBOL_NOVERS. FIXME: Deprecated */
196 #define EXPORT_SYMBOL_NOVERS(sym) EXPORT_SYMBOL(sym)
201 } ____cacheline_aligned
;
212 enum module_state state
;
214 /* Member of list of modules */
215 struct list_head list
;
217 /* Unique handle for this module */
218 char name
[MODULE_NAME_LEN
];
220 /* Exported symbols */
221 const struct kernel_symbol
*syms
;
222 unsigned int num_syms
;
223 const unsigned long *crcs
;
225 /* GPL-only exported symbols. */
226 const struct kernel_symbol
*gpl_syms
;
227 unsigned int num_gpl_syms
;
228 const unsigned long *gpl_crcs
;
230 /* Exception table */
231 unsigned int num_exentries
;
232 const struct exception_table_entry
*extable
;
234 /* Startup function. */
237 /* If this is non-NULL, vfree after init() returns */
240 /* Here is the actual code + data, vfree'd on unload. */
243 /* Here are the sizes of the init and core sections */
244 unsigned long init_size
, core_size
;
246 /* The size of the executable code in each section. */
247 unsigned long init_text_size
, core_text_size
;
249 /* Arch-specific module values */
250 struct mod_arch_specific arch
;
252 /* Am I unsafe to unload? */
255 /* Am I GPL-compatible */
258 #ifdef CONFIG_MODULE_UNLOAD
259 /* Reference counts */
260 struct module_ref ref
[NR_CPUS
];
262 /* What modules depend on me? */
263 struct list_head modules_which_use_me
;
265 /* Who is waiting for us to be unloaded */
266 struct task_struct
*waiter
;
268 /* Destruction function. */
272 #ifdef CONFIG_KALLSYMS
273 /* We keep the symbol and string tables for kallsyms. */
275 unsigned long num_symtab
;
282 /* The command line arguments (may be mangled). People like
283 keeping pointers to this stuff */
287 /* FIXME: It'd be nice to isolate modules during init, too, so they
288 aren't used before they (may) fail. But presently too much code
289 (IDE & SCSI) require entry into the module during init.*/
290 static inline int module_is_live(struct module
*mod
)
292 return mod
->state
!= MODULE_STATE_GOING
;
295 /* Is this address in a module? */
296 struct module
*module_text_address(unsigned long addr
);
298 /* Returns module and fills in value, defined and namebuf, or NULL if
299 symnum out of range. */
300 struct module
*module_get_kallsym(unsigned int symnum
,
301 unsigned long *value
,
305 /* Look for this name: can be of form module:name. */
306 unsigned long module_kallsyms_lookup_name(const char *name
);
308 int is_exported(const char *name
, const struct module
*mod
);
310 extern void __module_put_and_exit(struct module
*mod
, long code
)
311 __attribute__((noreturn
));
312 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
314 #ifdef CONFIG_MODULE_UNLOAD
315 unsigned int module_refcount(struct module
*mod
);
316 void __symbol_put(const char *symbol
);
317 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
318 void symbol_put_addr(void *addr
);
320 /* Sometimes we know we already have a refcount, and it's easier not
321 to handle the error case (which only happens with rmmod --wait). */
322 static inline void __module_get(struct module
*module
)
325 BUG_ON(module_refcount(module
) == 0);
326 local_inc(&module
->ref
[get_cpu()].count
);
331 static inline int try_module_get(struct module
*module
)
336 unsigned int cpu
= get_cpu();
337 if (likely(module_is_live(module
)))
338 local_inc(&module
->ref
[cpu
].count
);
346 static inline void module_put(struct module
*module
)
349 unsigned int cpu
= get_cpu();
350 local_dec(&module
->ref
[cpu
].count
);
351 /* Maybe they're waiting for us to drop reference? */
352 if (unlikely(!module_is_live(module
)))
353 wake_up_process(module
->waiter
);
358 #else /*!CONFIG_MODULE_UNLOAD*/
359 static inline int try_module_get(struct module
*module
)
361 return !module
|| module_is_live(module
);
363 static inline void module_put(struct module
*module
)
366 static inline void __module_get(struct module
*module
)
369 #define symbol_put(x) do { } while(0)
370 #define symbol_put_addr(p) do { } while(0)
372 #endif /* CONFIG_MODULE_UNLOAD */
374 /* This is a #define so the string doesn't get put in every .o file */
375 #define module_name(mod) \
377 struct module *__mod = (mod); \
378 __mod ? __mod->name : "kernel"; \
381 #define __unsafe(mod) \
383 if (mod && !(mod)->unsafe) { \
384 printk(KERN_WARNING \
385 "Module %s cannot be unloaded due to unsafe usage in" \
386 " %s:%u\n", (mod)->name, __FILE__, __LINE__); \
391 /* For kallsyms to ask for address resolution. NULL means not found. */
392 const char *module_address_lookup(unsigned long addr
,
393 unsigned long *symbolsize
,
394 unsigned long *offset
,
397 /* For extable.c to search modules' exception tables. */
398 const struct exception_table_entry
*search_module_extables(unsigned long addr
);
400 int register_module_notifier(struct notifier_block
* nb
);
401 int unregister_module_notifier(struct notifier_block
* nb
);
403 #else /* !CONFIG_MODULES... */
404 #define EXPORT_SYMBOL(sym)
405 #define EXPORT_SYMBOL_GPL(sym)
406 #define EXPORT_SYMBOL_NOVERS(sym)
408 /* Given an address, look for it in the exception tables. */
409 static inline const struct exception_table_entry
*
410 search_module_extables(unsigned long addr
)
415 /* Is this address in a module? */
416 static inline struct module
*module_text_address(unsigned long addr
)
421 /* Get/put a kernel symbol (calls should be symmetric) */
422 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
423 #define symbol_put(x) do { } while(0)
424 #define symbol_put_addr(x) do { } while(0)
426 static inline void __module_get(struct module
*module
)
430 static inline int try_module_get(struct module
*module
)
435 static inline void module_put(struct module
*module
)
439 #define module_name(mod) "kernel"
441 #define __unsafe(mod)
443 /* For kallsyms to ask for address resolution. NULL means not found. */
444 static inline const char *module_address_lookup(unsigned long addr
,
445 unsigned long *symbolsize
,
446 unsigned long *offset
,
452 static inline struct module
*module_get_kallsym(unsigned int symnum
,
453 unsigned long *value
,
460 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
465 static inline int is_exported(const char *name
, const struct module
*mod
)
470 static inline int register_module_notifier(struct notifier_block
* nb
)
472 /* no events will happen anyway, so this can always succeed */
476 static inline int unregister_module_notifier(struct notifier_block
* nb
)
481 #define module_put_and_exit(code) do_exit(code)
483 #endif /* CONFIG_MODULES */
485 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
487 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
489 struct obsolete_modparm
{
491 char type
[64-sizeof(void *)];
495 /* DEPRECATED: Do not use. */
496 #define MODULE_PARM(var,type) \
497 struct obsolete_modparm __parm_##var __attribute__((section("__obsparm"))) = \
498 { __stringify(var), type };
500 static inline void __deprecated
MOD_INC_USE_COUNT(struct module
*module
)
504 #if defined(CONFIG_MODULE_UNLOAD) && defined(MODULE)
505 local_inc(&module
->ref
[get_cpu()].count
);
508 (void)try_module_get(module
);
512 static inline void __deprecated
MOD_DEC_USE_COUNT(struct module
*module
)
517 #define MOD_INC_USE_COUNT MOD_INC_USE_COUNT(THIS_MODULE)
518 #define MOD_DEC_USE_COUNT MOD_DEC_USE_COUNT(THIS_MODULE)
520 #define MODULE_PARM(var,type)
521 #define MOD_INC_USE_COUNT do { } while (0)
522 #define MOD_DEC_USE_COUNT do { } while (0)
525 #define __MODULE_STRING(x) __stringify(x)
527 /* Use symbol_get and symbol_put instead. You'll thank me. */
528 #define HAVE_INTER_MODULE
529 extern void inter_module_register(const char *, struct module
*, const void *);
530 extern void inter_module_unregister(const char *);
531 extern const void *inter_module_get(const char *);
532 extern const void *inter_module_get_request(const char *, const char *);
533 extern void inter_module_put(const char *);
535 #endif /* _LINUX_MODULE_H */