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/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>
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 ""
31 #define MODULE_NAME_LEN (64 - sizeof(unsigned long))
39 struct modversion_info
42 char name
[MODULE_NAME_LEN
];
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
*);
63 /* These are either module local, or the kernel's dummy ones. */
64 extern int init_module(void);
65 extern void cleanup_module(void);
67 /* Archs provide a method of finding the correct exception table. */
68 struct exception_table_entry
;
70 const struct exception_table_entry
*
71 search_extable(const struct exception_table_entry
*first
,
72 const struct exception_table_entry
*last
,
74 void sort_extable(struct exception_table_entry
*start
,
75 struct exception_table_entry
*finish
);
76 void sort_main_extable(void);
78 extern struct subsystem module_subsys
;
81 #define MODULE_GENERIC_TABLE(gtype,name) \
82 extern const struct gtype##_id __mod_##gtype##_table \
83 __attribute__ ((unused, alias(__stringify(name))))
85 extern struct module __this_module
;
86 #define THIS_MODULE (&__this_module)
88 #define MODULE_GENERIC_TABLE(gtype,name)
89 #define THIS_MODULE ((struct module *)0)
92 /* Generic info of form tag = "info" */
93 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
95 /* For userspace: you can also call me... */
96 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
99 * The following license idents are currently accepted as indicating free
102 * "GPL" [GNU Public License v2 or later]
103 * "GPL v2" [GNU Public License v2]
104 * "GPL and additional rights" [GNU Public License v2 rights and more]
105 * "Dual BSD/GPL" [GNU Public License v2
106 * or BSD license choice]
107 * "Dual MIT/GPL" [GNU Public License v2
108 * or MIT license choice]
109 * "Dual MPL/GPL" [GNU Public License v2
110 * or Mozilla license choice]
112 * The following other idents are available
114 * "Proprietary" [Non free products]
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.
120 * This exists for several reasons
121 * 1. So modinfo can show license info for users wanting to vet their setup
123 * 2. So the community can ignore bug reports including proprietary modules
124 * 3. So vendors can do likewise based on their own policies
126 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
128 /* Author, ideally of form NAME <EMAIL>[, NAME <EMAIL>]*[ and NAME <EMAIL>] */
129 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
131 /* What your module does. */
132 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
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)
139 #define MODULE_DEVICE_TABLE(type,name) \
140 MODULE_GENERIC_TABLE(type##_device,name)
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
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".
153 Using this automatically adds a checksum of the .c files and the
154 local headers in "srcversion".
156 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
158 /* Optional firmware file (or files) needed by the module
159 * format is simply firmware file name. Multiple firmware
160 * files require multiple MODULE_FIRMWARE() specifiers */
161 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
163 /* Given an address, look for it in the exception tables */
164 const struct exception_table_entry
*search_exception_tables(unsigned long add
);
166 struct notifier_block
;
168 #ifdef CONFIG_MODULES
170 /* Get/put a kernel symbol (calls must be symmetric) */
171 void *__symbol_get(const char *symbol
);
172 void *__symbol_get_gpl(const char *symbol
);
173 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
176 #ifdef CONFIG_MODVERSIONS
177 /* Mark the CRC weak since genksyms apparently decides not to
178 * generate a checksums for some symbols */
179 #define __CRC_SYMBOL(sym, sec) \
180 extern void *__crc_##sym __attribute__((weak)); \
181 static const unsigned long __kcrctab_##sym \
183 __attribute__((section("__kcrctab" sec), unused)) \
184 = (unsigned long) &__crc_##sym;
186 #define __CRC_SYMBOL(sym, sec)
189 /* For every exported symbol, place a struct in the __ksymtab section */
190 #define __EXPORT_SYMBOL(sym, sec) \
191 extern typeof(sym) sym; \
192 __CRC_SYMBOL(sym, sec) \
193 static const char __kstrtab_##sym[] \
194 __attribute__((section("__ksymtab_strings"))) \
195 = MODULE_SYMBOL_PREFIX #sym; \
196 static const struct kernel_symbol __ksymtab_##sym \
198 __attribute__((section("__ksymtab" sec), unused)) \
199 = { (unsigned long)&sym, __kstrtab_##sym }
201 #define EXPORT_SYMBOL(sym) \
202 __EXPORT_SYMBOL(sym, "")
204 #define EXPORT_SYMBOL_GPL(sym) \
205 __EXPORT_SYMBOL(sym, "_gpl")
207 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
208 __EXPORT_SYMBOL(sym, "_gpl_future")
211 #ifdef CONFIG_UNUSED_SYMBOLS
212 #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
213 #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
215 #define EXPORT_UNUSED_SYMBOL(sym)
216 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
224 } ____cacheline_aligned
;
233 /* Similar stuff for section attributes. */
234 struct module_sect_attr
236 struct module_attribute mattr
;
238 unsigned long address
;
241 struct module_sect_attrs
243 struct attribute_group grp
;
245 struct module_sect_attr attrs
[0];
248 struct module_param_attrs
;
252 enum module_state state
;
254 /* Member of list of modules */
255 struct list_head list
;
257 /* Unique handle for this module */
258 char name
[MODULE_NAME_LEN
];
261 struct module_kobject mkobj
;
262 struct module_param_attrs
*param_attrs
;
263 struct module_attribute
*modinfo_attrs
;
265 const char *srcversion
;
266 struct kobject
*drivers_dir
;
268 /* Exported symbols */
269 const struct kernel_symbol
*syms
;
270 unsigned int num_syms
;
271 const unsigned long *crcs
;
273 /* GPL-only exported symbols. */
274 const struct kernel_symbol
*gpl_syms
;
275 unsigned int num_gpl_syms
;
276 const unsigned long *gpl_crcs
;
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
;
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
;
292 /* Exception table */
293 unsigned int num_exentries
;
294 const struct exception_table_entry
*extable
;
296 /* Startup function. */
299 /* If this is non-NULL, vfree after init() returns */
302 /* Here is the actual code + data, vfree'd on unload. */
305 /* Here are the sizes of the init and core sections */
306 unsigned long init_size
, core_size
;
308 /* The size of the executable code in each section. */
309 unsigned long init_text_size
, core_text_size
;
311 /* The handle returned from unwind_add_table. */
314 /* Arch-specific module values */
315 struct mod_arch_specific arch
;
317 /* Am I unsafe to unload? */
320 unsigned int taints
; /* same bits as kernel:tainted */
322 #ifdef CONFIG_GENERIC_BUG
323 /* Support for BUG */
324 struct list_head bug_list
;
325 struct bug_entry
*bug_table
;
329 #ifdef CONFIG_MODULE_UNLOAD
330 /* Reference counts */
331 struct module_ref ref
[NR_CPUS
];
333 /* What modules depend on me? */
334 struct list_head modules_which_use_me
;
336 /* Who is waiting for us to be unloaded */
337 struct task_struct
*waiter
;
339 /* Destruction function. */
343 #ifdef CONFIG_KALLSYMS
344 /* We keep the symbol and string tables for kallsyms. */
346 unsigned long num_symtab
;
349 /* Section attributes */
350 struct module_sect_attrs
*sect_attrs
;
356 /* The command line arguments (may be mangled). People like
357 keeping pointers to this stuff */
361 /* FIXME: It'd be nice to isolate modules during init, too, so they
362 aren't used before they (may) fail. But presently too much code
363 (IDE & SCSI) require entry into the module during init.*/
364 static inline int module_is_live(struct module
*mod
)
366 return mod
->state
!= MODULE_STATE_GOING
;
369 /* Is this address in a module? (second is with no locks, for oops) */
370 struct module
*module_text_address(unsigned long addr
);
371 struct module
*__module_text_address(unsigned long addr
);
372 int is_module_address(unsigned long addr
);
374 /* Returns module and fills in value, defined and namebuf, or NULL if
375 symnum out of range. */
376 struct module
*module_get_kallsym(unsigned int symnum
, unsigned long *value
,
377 char *type
, char *name
, size_t namelen
);
379 /* Look for this name: can be of form module:name. */
380 unsigned long module_kallsyms_lookup_name(const char *name
);
382 int is_exported(const char *name
, const struct module
*mod
);
384 extern void __module_put_and_exit(struct module
*mod
, long code
)
385 __attribute__((noreturn
));
386 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
388 #ifdef CONFIG_MODULE_UNLOAD
389 unsigned int module_refcount(struct module
*mod
);
390 void __symbol_put(const char *symbol
);
391 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
392 void symbol_put_addr(void *addr
);
394 /* Sometimes we know we already have a refcount, and it's easier not
395 to handle the error case (which only happens with rmmod --wait). */
396 static inline void __module_get(struct module
*module
)
399 BUG_ON(module_refcount(module
) == 0);
400 local_inc(&module
->ref
[get_cpu()].count
);
405 static inline int try_module_get(struct module
*module
)
410 unsigned int cpu
= get_cpu();
411 if (likely(module_is_live(module
)))
412 local_inc(&module
->ref
[cpu
].count
);
420 extern void module_put(struct module
*module
);
422 #else /*!CONFIG_MODULE_UNLOAD*/
423 static inline int try_module_get(struct module
*module
)
425 return !module
|| module_is_live(module
);
427 static inline void module_put(struct module
*module
)
430 static inline void __module_get(struct module
*module
)
433 #define symbol_put(x) do { } while(0)
434 #define symbol_put_addr(p) do { } while(0)
436 #endif /* CONFIG_MODULE_UNLOAD */
438 /* This is a #define so the string doesn't get put in every .o file */
439 #define module_name(mod) \
441 struct module *__mod = (mod); \
442 __mod ? __mod->name : "kernel"; \
445 #define __unsafe(mod) \
447 if (mod && !(mod)->unsafe) { \
448 printk(KERN_WARNING \
449 "Module %s cannot be unloaded due to unsafe usage in" \
450 " %s:%u\n", (mod)->name, __FILE__, __LINE__); \
455 /* For kallsyms to ask for address resolution. NULL means not found. */
456 const char *module_address_lookup(unsigned long addr
,
457 unsigned long *symbolsize
,
458 unsigned long *offset
,
461 /* For extable.c to search modules' exception tables. */
462 const struct exception_table_entry
*search_module_extables(unsigned long addr
);
464 int register_module_notifier(struct notifier_block
* nb
);
465 int unregister_module_notifier(struct notifier_block
* nb
);
467 extern void print_modules(void);
469 struct device_driver
;
470 void module_add_driver(struct module
*, struct device_driver
*);
471 void module_remove_driver(struct device_driver
*);
473 #else /* !CONFIG_MODULES... */
474 #define EXPORT_SYMBOL(sym)
475 #define EXPORT_SYMBOL_GPL(sym)
476 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
477 #define EXPORT_UNUSED_SYMBOL(sym)
478 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
480 /* Given an address, look for it in the exception tables. */
481 static inline const struct exception_table_entry
*
482 search_module_extables(unsigned long addr
)
487 /* Is this address in a module? */
488 static inline struct module
*module_text_address(unsigned long addr
)
493 /* Is this address in a module? (don't take a lock, we're oopsing) */
494 static inline struct module
*__module_text_address(unsigned long addr
)
499 static inline int is_module_address(unsigned long addr
)
504 /* Get/put a kernel symbol (calls should be symmetric) */
505 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
506 #define symbol_put(x) do { } while(0)
507 #define symbol_put_addr(x) do { } while(0)
509 static inline void __module_get(struct module
*module
)
513 static inline int try_module_get(struct module
*module
)
518 static inline void module_put(struct module
*module
)
522 #define module_name(mod) "kernel"
524 #define __unsafe(mod)
526 /* For kallsyms to ask for address resolution. NULL means not found. */
527 static inline const char *module_address_lookup(unsigned long addr
,
528 unsigned long *symbolsize
,
529 unsigned long *offset
,
535 static inline struct module
*module_get_kallsym(unsigned int symnum
,
536 unsigned long *value
,
537 char *type
, char *name
,
543 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
548 static inline int is_exported(const char *name
, const struct module
*mod
)
553 static inline int register_module_notifier(struct notifier_block
* nb
)
555 /* no events will happen anyway, so this can always succeed */
559 static inline int unregister_module_notifier(struct notifier_block
* nb
)
564 #define module_put_and_exit(code) do_exit(code)
566 static inline void print_modules(void)
570 struct device_driver
;
573 static inline void module_add_driver(struct module
*module
, struct device_driver
*driver
)
577 static inline void module_remove_driver(struct device_driver
*driver
)
581 #endif /* CONFIG_MODULES */
583 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
585 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
587 #define __MODULE_STRING(x) __stringify(x)
589 #endif /* _LINUX_MODULE_H */