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
*);
61 struct kobject
*drivers_dir
;
64 /* These are either module local, or the kernel's dummy ones. */
65 extern int init_module(void);
66 extern void cleanup_module(void);
68 /* Archs provide a method of finding the correct exception table. */
69 struct exception_table_entry
;
71 const struct exception_table_entry
*
72 search_extable(const struct exception_table_entry
*first
,
73 const struct exception_table_entry
*last
,
75 void sort_extable(struct exception_table_entry
*start
,
76 struct exception_table_entry
*finish
);
77 void sort_main_extable(void);
79 extern struct subsystem module_subsys
;
82 #define MODULE_GENERIC_TABLE(gtype,name) \
83 extern const struct gtype##_id __mod_##gtype##_table \
84 __attribute__ ((unused, alias(__stringify(name))))
86 extern struct module __this_module
;
87 #define THIS_MODULE (&__this_module)
89 #define MODULE_GENERIC_TABLE(gtype,name)
90 #define THIS_MODULE ((struct module *)0)
93 /* Generic info of form tag = "info" */
94 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
96 /* For userspace: you can also call me... */
97 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
100 * The following license idents are currently accepted as indicating free
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]
113 * The following other idents are available
115 * "Proprietary" [Non free products]
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.
121 * This exists for several reasons
122 * 1. So modinfo can show license info for users wanting to vet their setup
124 * 2. So the community can ignore bug reports including proprietary modules
125 * 3. So vendors can do likewise based on their own policies
127 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
129 /* Author, ideally of form NAME <EMAIL>[, NAME <EMAIL>]*[ and NAME <EMAIL>] */
130 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
132 /* What your module does. */
133 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
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)
140 #define MODULE_DEVICE_TABLE(type,name) \
141 MODULE_GENERIC_TABLE(type##_device,name)
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
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".
154 Using this automatically adds a checksum of the .c files and the
155 local headers in "srcversion".
157 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
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)
164 /* Given an address, look for it in the exception tables */
165 const struct exception_table_entry
*search_exception_tables(unsigned long add
);
167 struct notifier_block
;
169 #ifdef CONFIG_MODULES
171 /* Get/put a kernel symbol (calls must be symmetric) */
172 void *__symbol_get(const char *symbol
);
173 void *__symbol_get_gpl(const char *symbol
);
174 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
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 \
184 __attribute__((section("__kcrctab" sec), unused)) \
185 = (unsigned long) &__crc_##sym;
187 #define __CRC_SYMBOL(sym, sec)
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 \
199 __attribute__((section("__ksymtab" sec), unused)) \
200 = { (unsigned long)&sym, __kstrtab_##sym }
202 #define EXPORT_SYMBOL(sym) \
203 __EXPORT_SYMBOL(sym, "")
205 #define EXPORT_SYMBOL_GPL(sym) \
206 __EXPORT_SYMBOL(sym, "_gpl")
208 #define EXPORT_SYMBOL_GPL_FUTURE(sym) \
209 __EXPORT_SYMBOL(sym, "_gpl_future")
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")
216 #define EXPORT_UNUSED_SYMBOL(sym)
217 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
225 } ____cacheline_aligned
;
234 /* Similar stuff for section attributes. */
235 struct module_sect_attr
237 struct module_attribute mattr
;
239 unsigned long address
;
242 struct module_sect_attrs
244 struct attribute_group grp
;
246 struct module_sect_attr attrs
[0];
249 struct module_param_attrs
;
253 enum module_state state
;
255 /* Member of list of modules */
256 struct list_head list
;
258 /* Unique handle for this module */
259 char name
[MODULE_NAME_LEN
];
262 struct module_kobject mkobj
;
263 struct module_param_attrs
*param_attrs
;
264 struct module_attribute
*modinfo_attrs
;
266 const char *srcversion
;
267 struct kobject
*holders_dir
;
269 /* Exported symbols */
270 const struct kernel_symbol
*syms
;
271 unsigned int num_syms
;
272 const unsigned long *crcs
;
274 /* GPL-only exported symbols. */
275 const struct kernel_symbol
*gpl_syms
;
276 unsigned int num_gpl_syms
;
277 const unsigned long *gpl_crcs
;
279 /* unused exported symbols. */
280 const struct kernel_symbol
*unused_syms
;
281 unsigned int num_unused_syms
;
282 const unsigned long *unused_crcs
;
283 /* GPL-only, unused exported symbols. */
284 const struct kernel_symbol
*unused_gpl_syms
;
285 unsigned int num_unused_gpl_syms
;
286 const unsigned long *unused_gpl_crcs
;
288 /* symbols that will be GPL-only in the near future. */
289 const struct kernel_symbol
*gpl_future_syms
;
290 unsigned int num_gpl_future_syms
;
291 const unsigned long *gpl_future_crcs
;
293 /* Exception table */
294 unsigned int num_exentries
;
295 const struct exception_table_entry
*extable
;
297 /* Startup function. */
300 /* If this is non-NULL, vfree after init() returns */
303 /* Here is the actual code + data, vfree'd on unload. */
306 /* Here are the sizes of the init and core sections */
307 unsigned long init_size
, core_size
;
309 /* The size of the executable code in each section. */
310 unsigned long init_text_size
, core_text_size
;
312 /* The handle returned from unwind_add_table. */
315 /* Arch-specific module values */
316 struct mod_arch_specific arch
;
318 /* Am I unsafe to unload? */
321 unsigned int taints
; /* same bits as kernel:tainted */
323 #ifdef CONFIG_GENERIC_BUG
324 /* Support for BUG */
325 struct list_head bug_list
;
326 struct bug_entry
*bug_table
;
330 #ifdef CONFIG_MODULE_UNLOAD
331 /* Reference counts */
332 struct module_ref ref
[NR_CPUS
];
334 /* What modules depend on me? */
335 struct list_head modules_which_use_me
;
337 /* Who is waiting for us to be unloaded */
338 struct task_struct
*waiter
;
340 /* Destruction function. */
344 #ifdef CONFIG_KALLSYMS
345 /* We keep the symbol and string tables for kallsyms. */
347 unsigned long num_symtab
;
350 /* Section attributes */
351 struct module_sect_attrs
*sect_attrs
;
357 /* The command line arguments (may be mangled). People like
358 keeping pointers to this stuff */
362 /* FIXME: It'd be nice to isolate modules during init, too, so they
363 aren't used before they (may) fail. But presently too much code
364 (IDE & SCSI) require entry into the module during init.*/
365 static inline int module_is_live(struct module
*mod
)
367 return mod
->state
!= MODULE_STATE_GOING
;
370 /* Is this address in a module? (second is with no locks, for oops) */
371 struct module
*module_text_address(unsigned long addr
);
372 struct module
*__module_text_address(unsigned long addr
);
373 int is_module_address(unsigned long addr
);
375 /* Returns module and fills in value, defined and namebuf, or NULL if
376 symnum out of range. */
377 struct module
*module_get_kallsym(unsigned int symnum
, unsigned long *value
,
378 char *type
, char *name
, size_t namelen
);
380 /* Look for this name: can be of form module:name. */
381 unsigned long module_kallsyms_lookup_name(const char *name
);
383 int is_exported(const char *name
, const struct module
*mod
);
385 extern void __module_put_and_exit(struct module
*mod
, long code
)
386 __attribute__((noreturn
));
387 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
389 #ifdef CONFIG_MODULE_UNLOAD
390 unsigned int module_refcount(struct module
*mod
);
391 void __symbol_put(const char *symbol
);
392 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
393 void symbol_put_addr(void *addr
);
395 /* Sometimes we know we already have a refcount, and it's easier not
396 to handle the error case (which only happens with rmmod --wait). */
397 static inline void __module_get(struct module
*module
)
400 BUG_ON(module_refcount(module
) == 0);
401 local_inc(&module
->ref
[get_cpu()].count
);
406 static inline int try_module_get(struct module
*module
)
411 unsigned int cpu
= get_cpu();
412 if (likely(module_is_live(module
)))
413 local_inc(&module
->ref
[cpu
].count
);
421 extern void module_put(struct module
*module
);
423 #else /*!CONFIG_MODULE_UNLOAD*/
424 static inline int try_module_get(struct module
*module
)
426 return !module
|| module_is_live(module
);
428 static inline void module_put(struct module
*module
)
431 static inline void __module_get(struct module
*module
)
434 #define symbol_put(x) do { } while(0)
435 #define symbol_put_addr(p) do { } while(0)
437 #endif /* CONFIG_MODULE_UNLOAD */
439 /* This is a #define so the string doesn't get put in every .o file */
440 #define module_name(mod) \
442 struct module *__mod = (mod); \
443 __mod ? __mod->name : "kernel"; \
446 #define __unsafe(mod) \
448 if (mod && !(mod)->unsafe) { \
449 printk(KERN_WARNING \
450 "Module %s cannot be unloaded due to unsafe usage in" \
451 " %s:%u\n", (mod)->name, __FILE__, __LINE__); \
456 /* For kallsyms to ask for address resolution. NULL means not found. */
457 const char *module_address_lookup(unsigned long addr
,
458 unsigned long *symbolsize
,
459 unsigned long *offset
,
462 /* For extable.c to search modules' exception tables. */
463 const struct exception_table_entry
*search_module_extables(unsigned long addr
);
465 int register_module_notifier(struct notifier_block
* nb
);
466 int unregister_module_notifier(struct notifier_block
* nb
);
468 extern void print_modules(void);
470 struct device_driver
;
471 void module_add_driver(struct module
*, struct device_driver
*);
472 void module_remove_driver(struct device_driver
*);
474 #else /* !CONFIG_MODULES... */
475 #define EXPORT_SYMBOL(sym)
476 #define EXPORT_SYMBOL_GPL(sym)
477 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
478 #define EXPORT_UNUSED_SYMBOL(sym)
479 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
481 /* Given an address, look for it in the exception tables. */
482 static inline const struct exception_table_entry
*
483 search_module_extables(unsigned long addr
)
488 /* Is this address in a module? */
489 static inline struct module
*module_text_address(unsigned long addr
)
494 /* Is this address in a module? (don't take a lock, we're oopsing) */
495 static inline struct module
*__module_text_address(unsigned long addr
)
500 static inline int is_module_address(unsigned long addr
)
505 /* Get/put a kernel symbol (calls should be symmetric) */
506 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
507 #define symbol_put(x) do { } while(0)
508 #define symbol_put_addr(x) do { } while(0)
510 static inline void __module_get(struct module
*module
)
514 static inline int try_module_get(struct module
*module
)
519 static inline void module_put(struct module
*module
)
523 #define module_name(mod) "kernel"
525 #define __unsafe(mod)
527 /* For kallsyms to ask for address resolution. NULL means not found. */
528 static inline const char *module_address_lookup(unsigned long addr
,
529 unsigned long *symbolsize
,
530 unsigned long *offset
,
536 static inline struct module
*module_get_kallsym(unsigned int symnum
,
537 unsigned long *value
,
538 char *type
, char *name
,
544 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
549 static inline int is_exported(const char *name
, const struct module
*mod
)
554 static inline int register_module_notifier(struct notifier_block
* nb
)
556 /* no events will happen anyway, so this can always succeed */
560 static inline int unregister_module_notifier(struct notifier_block
* nb
)
565 #define module_put_and_exit(code) do_exit(code)
567 static inline void print_modules(void)
571 struct device_driver
;
574 static inline void module_add_driver(struct module
*module
, struct device_driver
*driver
)
578 static inline void module_remove_driver(struct device_driver
*driver
)
582 #endif /* CONFIG_MODULES */
584 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
586 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
588 #define __MODULE_STRING(x) __stringify(x)
590 #endif /* _LINUX_MODULE_H */