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/list.h>
10 #include <linux/stat.h>
11 #include <linux/compiler.h>
12 #include <linux/cache.h>
13 #include <linux/kmod.h>
14 #include <linux/elf.h>
15 #include <linux/stringify.h>
16 #include <linux/kobject.h>
17 #include <linux/moduleparam.h>
18 #include <asm/local.h>
20 #include <asm/module.h>
22 /* Not Yet Implemented */
23 #define MODULE_SUPPORTED_DEVICE(name)
25 /* v850 toolchain uses a `_' prefix for all user symbols */
26 #ifndef MODULE_SYMBOL_PREFIX
27 #define MODULE_SYMBOL_PREFIX ""
30 #define MODULE_NAME_LEN (64 - sizeof(unsigned long))
38 struct modversion_info
41 char name
[MODULE_NAME_LEN
];
46 struct module_attribute
{
47 struct attribute attr
;
48 ssize_t (*show
)(struct module_attribute
*, struct module
*, char *);
49 ssize_t (*store
)(struct module_attribute
*, struct module
*,
50 const char *, size_t count
);
51 void (*setup
)(struct module
*, const char *);
52 int (*test
)(struct module
*);
53 void (*free
)(struct module
*);
60 struct kobject
*drivers_dir
;
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);
79 #define MODULE_GENERIC_TABLE(gtype,name) \
80 extern const struct gtype##_id __mod_##gtype##_table \
81 __attribute__ ((unused, alias(__stringify(name))))
83 extern struct module __this_module
;
84 #define THIS_MODULE (&__this_module)
86 #define MODULE_GENERIC_TABLE(gtype,name)
87 #define THIS_MODULE ((struct module *)0)
90 /* Generic info of form tag = "info" */
91 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
93 /* For userspace: you can also call me... */
94 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
97 * The following license idents are currently accepted as indicating free
100 * "GPL" [GNU Public License v2 or later]
101 * "GPL v2" [GNU Public License v2]
102 * "GPL and additional rights" [GNU Public License v2 rights and more]
103 * "Dual BSD/GPL" [GNU Public License v2
104 * or BSD license choice]
105 * "Dual MIT/GPL" [GNU Public License v2
106 * or MIT license choice]
107 * "Dual MPL/GPL" [GNU Public License v2
108 * or Mozilla license choice]
110 * The following other idents are available
112 * "Proprietary" [Non free products]
114 * There are dual licensed components, but when running with Linux it is the
115 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
116 * is a GPL combined work.
118 * This exists for several reasons
119 * 1. So modinfo can show license info for users wanting to vet their setup
121 * 2. So the community can ignore bug reports including proprietary modules
122 * 3. So vendors can do likewise based on their own policies
124 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
126 /* Author, ideally of form NAME[, NAME]*[ and NAME] */
127 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
129 /* What your module does. */
130 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
132 /* One for each parameter, describing how to use it. Some files do
133 multiple of these per line, so can't just use MODULE_INFO. */
134 #define MODULE_PARM_DESC(_parm, desc) \
135 __MODULE_INFO(parm, _parm, #_parm ":" desc)
137 #define MODULE_DEVICE_TABLE(type,name) \
138 MODULE_GENERIC_TABLE(type##_device,name)
140 /* Version of form [<epoch>:]<version>[-<extra-version>].
141 Or for CVS/RCS ID version, everything but the number is stripped.
142 <epoch>: A (small) unsigned integer which allows you to start versions
143 anew. If not mentioned, it's zero. eg. "2:1.0" is after
145 <version>: The <version> may contain only alphanumerics and the
146 character `.'. Ordered by numeric sort for numeric parts,
147 ascii sort for ascii parts (as per RPM or DEB algorithm).
148 <extraversion>: Like <version>, but inserted for local
149 customizations, eg "rh3" or "rusty1".
151 Using this automatically adds a checksum of the .c files and the
152 local headers in "srcversion".
154 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
156 /* Optional firmware file (or files) needed by the module
157 * format is simply firmware file name. Multiple firmware
158 * files require multiple MODULE_FIRMWARE() specifiers */
159 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
161 /* Given an address, look for it in the exception tables */
162 const struct exception_table_entry
*search_exception_tables(unsigned long add
);
164 struct notifier_block
;
166 #ifdef CONFIG_MODULES
168 /* Get/put a kernel symbol (calls must be symmetric) */
169 void *__symbol_get(const char *symbol
);
170 void *__symbol_get_gpl(const char *symbol
);
171 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
174 #ifdef CONFIG_MODVERSIONS
175 /* Mark the CRC weak since genksyms apparently decides not to
176 * generate a checksums for some symbols */
177 #define __CRC_SYMBOL(sym, sec) \
178 extern void *__crc_##sym __attribute__((weak)); \
179 static const unsigned long __kcrctab_##sym \
181 __attribute__((section("__kcrctab" sec), unused)) \
182 = (unsigned long) &__crc_##sym;
184 #define __CRC_SYMBOL(sym, sec)
187 /* For every exported symbol, place a struct in the __ksymtab section */
188 #define __EXPORT_SYMBOL(sym, sec) \
189 extern typeof(sym) sym; \
190 __CRC_SYMBOL(sym, sec) \
191 static const char __kstrtab_##sym[] \
192 __attribute__((section("__ksymtab_strings"))) \
193 = MODULE_SYMBOL_PREFIX #sym; \
194 static const struct kernel_symbol __ksymtab_##sym \
196 __attribute__((section("__ksymtab" sec), unused)) \
197 = { (unsigned long)&sym, __kstrtab_##sym }
199 #define EXPORT_SYMBOL(sym) \
200 __EXPORT_SYMBOL(sym, "")
202 #define EXPORT_SYMBOL_GPL(sym) \
203 __EXPORT_SYMBOL(sym, "_gpl")
205 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
206 __EXPORT_SYMBOL(sym, "_gpl_future")
209 #ifdef CONFIG_UNUSED_SYMBOLS
210 #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
211 #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
213 #define EXPORT_UNUSED_SYMBOL(sym)
214 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
222 } ____cacheline_aligned
;
231 /* Similar stuff for section attributes. */
232 struct module_sect_attr
234 struct module_attribute mattr
;
236 unsigned long address
;
239 struct module_sect_attrs
241 struct attribute_group grp
;
243 struct module_sect_attr attrs
[0];
246 struct module_param_attrs
;
250 enum module_state state
;
252 /* Member of list of modules */
253 struct list_head list
;
255 /* Unique handle for this module */
256 char name
[MODULE_NAME_LEN
];
259 struct module_kobject mkobj
;
260 struct module_param_attrs
*param_attrs
;
261 struct module_attribute
*modinfo_attrs
;
263 const char *srcversion
;
264 struct kobject
*holders_dir
;
266 /* Exported symbols */
267 const struct kernel_symbol
*syms
;
268 unsigned int num_syms
;
269 const unsigned long *crcs
;
271 /* GPL-only exported symbols. */
272 const struct kernel_symbol
*gpl_syms
;
273 unsigned int num_gpl_syms
;
274 const unsigned long *gpl_crcs
;
276 /* unused exported symbols. */
277 const struct kernel_symbol
*unused_syms
;
278 unsigned int num_unused_syms
;
279 const unsigned long *unused_crcs
;
280 /* GPL-only, unused exported symbols. */
281 const struct kernel_symbol
*unused_gpl_syms
;
282 unsigned int num_unused_gpl_syms
;
283 const unsigned long *unused_gpl_crcs
;
285 /* symbols that will be GPL-only in the near future. */
286 const struct kernel_symbol
*gpl_future_syms
;
287 unsigned int num_gpl_future_syms
;
288 const unsigned long *gpl_future_crcs
;
290 /* Exception table */
291 unsigned int num_exentries
;
292 const struct exception_table_entry
*extable
;
294 /* Startup function. */
297 /* If this is non-NULL, vfree after init() returns */
300 /* Here is the actual code + data, vfree'd on unload. */
303 /* Here are the sizes of the init and core sections */
304 unsigned long init_size
, core_size
;
306 /* The size of the executable code in each section. */
307 unsigned long init_text_size
, core_text_size
;
309 /* The handle returned from unwind_add_table. */
312 /* Arch-specific module values */
313 struct mod_arch_specific arch
;
315 unsigned int taints
; /* same bits as kernel:tainted */
317 #ifdef CONFIG_GENERIC_BUG
318 /* Support for BUG */
319 struct list_head bug_list
;
320 struct bug_entry
*bug_table
;
324 #ifdef CONFIG_MODULE_UNLOAD
325 /* Reference counts */
326 struct module_ref ref
[NR_CPUS
];
328 /* What modules depend on me? */
329 struct list_head modules_which_use_me
;
331 /* Who is waiting for us to be unloaded */
332 struct task_struct
*waiter
;
334 /* Destruction function. */
338 #ifdef CONFIG_KALLSYMS
339 /* We keep the symbol and string tables for kallsyms. */
341 unsigned long num_symtab
;
344 /* Section attributes */
345 struct module_sect_attrs
*sect_attrs
;
351 /* The command line arguments (may be mangled). People like
352 keeping pointers to this stuff */
355 #ifndef MODULE_ARCH_INIT
356 #define MODULE_ARCH_INIT {}
359 /* FIXME: It'd be nice to isolate modules during init, too, so they
360 aren't used before they (may) fail. But presently too much code
361 (IDE & SCSI) require entry into the module during init.*/
362 static inline int module_is_live(struct module
*mod
)
364 return mod
->state
!= MODULE_STATE_GOING
;
367 /* Is this address in a module? (second is with no locks, for oops) */
368 struct module
*module_text_address(unsigned long addr
);
369 struct module
*__module_text_address(unsigned long addr
);
370 int is_module_address(unsigned long addr
);
372 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
373 symnum out of range. */
374 int module_get_kallsym(unsigned int symnum
, unsigned long *value
, char *type
,
375 char *name
, char *module_name
, int *exported
);
377 /* Look for this name: can be of form module:name. */
378 unsigned long module_kallsyms_lookup_name(const char *name
);
380 extern 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);
384 #ifdef CONFIG_MODULE_UNLOAD
385 unsigned int module_refcount(struct module
*mod
);
386 void __symbol_put(const char *symbol
);
387 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
388 void symbol_put_addr(void *addr
);
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). */
392 static inline void __module_get(struct module
*module
)
395 BUG_ON(module_refcount(module
) == 0);
396 local_inc(&module
->ref
[get_cpu()].count
);
401 static inline int try_module_get(struct module
*module
)
406 unsigned int cpu
= get_cpu();
407 if (likely(module_is_live(module
)))
408 local_inc(&module
->ref
[cpu
].count
);
416 extern void module_put(struct module
*module
);
418 #else /*!CONFIG_MODULE_UNLOAD*/
419 static inline int try_module_get(struct module
*module
)
421 return !module
|| module_is_live(module
);
423 static inline void module_put(struct module
*module
)
426 static inline void __module_get(struct module
*module
)
429 #define symbol_put(x) do { } while(0)
430 #define symbol_put_addr(p) do { } while(0)
432 #endif /* CONFIG_MODULE_UNLOAD */
434 /* This is a #define so the string doesn't get put in every .o file */
435 #define module_name(mod) \
437 struct module *__mod = (mod); \
438 __mod ? __mod->name : "kernel"; \
441 /* For kallsyms to ask for address resolution. NULL means not found. */
442 const char *module_address_lookup(unsigned long addr
,
443 unsigned long *symbolsize
,
444 unsigned long *offset
,
446 int lookup_module_symbol_name(unsigned long addr
, char *symname
);
447 int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
);
449 /* For extable.c to search modules' exception tables. */
450 const struct exception_table_entry
*search_module_extables(unsigned long addr
);
452 int register_module_notifier(struct notifier_block
* nb
);
453 int unregister_module_notifier(struct notifier_block
* nb
);
455 extern void print_modules(void);
457 #else /* !CONFIG_MODULES... */
458 #define EXPORT_SYMBOL(sym)
459 #define EXPORT_SYMBOL_GPL(sym)
460 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
461 #define EXPORT_UNUSED_SYMBOL(sym)
462 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
464 /* Given an address, look for it in the exception tables. */
465 static inline const struct exception_table_entry
*
466 search_module_extables(unsigned long addr
)
471 /* Is this address in a module? */
472 static inline struct module
*module_text_address(unsigned long addr
)
477 /* Is this address in a module? (don't take a lock, we're oopsing) */
478 static inline struct module
*__module_text_address(unsigned long addr
)
483 static inline int is_module_address(unsigned long addr
)
488 /* Get/put a kernel symbol (calls should be symmetric) */
489 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
490 #define symbol_put(x) do { } while(0)
491 #define symbol_put_addr(x) do { } while(0)
493 static inline void __module_get(struct module
*module
)
497 static inline int try_module_get(struct module
*module
)
502 static inline void module_put(struct module
*module
)
506 #define module_name(mod) "kernel"
508 /* For kallsyms to ask for address resolution. NULL means not found. */
509 static inline const char *module_address_lookup(unsigned long addr
,
510 unsigned long *symbolsize
,
511 unsigned long *offset
,
517 static inline int lookup_module_symbol_name(unsigned long addr
, char *symname
)
522 static inline int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
)
527 static inline int module_get_kallsym(unsigned int symnum
, unsigned long *value
,
528 char *type
, char *name
,
529 char *module_name
, int *exported
)
534 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
539 static inline int register_module_notifier(struct notifier_block
* nb
)
541 /* no events will happen anyway, so this can always succeed */
545 static inline int unregister_module_notifier(struct notifier_block
* nb
)
550 #define module_put_and_exit(code) do_exit(code)
552 static inline void print_modules(void)
556 #endif /* CONFIG_MODULES */
558 struct device_driver
;
562 extern struct kset module_subsys
;
564 int mod_sysfs_init(struct module
*mod
);
565 int mod_sysfs_setup(struct module
*mod
,
566 struct kernel_param
*kparam
,
567 unsigned int num_params
);
568 int module_add_modinfo_attrs(struct module
*mod
);
569 void module_remove_modinfo_attrs(struct module
*mod
);
571 #else /* !CONFIG_SYSFS */
573 static inline int mod_sysfs_init(struct module
*mod
)
578 static inline int mod_sysfs_setup(struct module
*mod
,
579 struct kernel_param
*kparam
,
580 unsigned int num_params
)
585 static inline int module_add_modinfo_attrs(struct module
*mod
)
590 static inline void module_remove_modinfo_attrs(struct module
*mod
)
593 #endif /* CONFIG_SYSFS */
595 #if defined(CONFIG_SYSFS) && defined(CONFIG_MODULES)
597 void module_add_driver(struct module
*mod
, struct device_driver
*drv
);
598 void module_remove_driver(struct device_driver
*drv
);
600 #else /* not both CONFIG_SYSFS && CONFIG_MODULES */
602 static inline void module_add_driver(struct module
*mod
, struct device_driver
*drv
)
605 static inline void module_remove_driver(struct device_driver
*drv
)
610 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
612 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
614 #define __MODULE_STRING(x) __stringify(x)
616 #endif /* _LINUX_MODULE_H */