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 <linux/tracepoint.h>
19 #include <linux/export.h>
21 #include <linux/percpu.h>
22 #include <asm/module.h>
24 /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
25 #define MODULE_SIG_STRING "~Module signature appended~\n"
27 /* Not Yet Implemented */
28 #define MODULE_SUPPORTED_DEVICE(name)
30 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
32 struct modversion_info
35 char name
[MODULE_NAME_LEN
];
40 struct module_kobject
{
43 struct kobject
*drivers_dir
;
44 struct module_param_attrs
*mp
;
45 struct completion
*kobj_completion
;
48 struct module_attribute
{
49 struct attribute attr
;
50 ssize_t (*show
)(struct module_attribute
*, struct module_kobject
*,
52 ssize_t (*store
)(struct module_attribute
*, struct module_kobject
*,
53 const char *, size_t count
);
54 void (*setup
)(struct module
*, const char *);
55 int (*test
)(struct module
*);
56 void (*free
)(struct module
*);
59 struct module_version_attribute
{
60 struct module_attribute mattr
;
61 const char *module_name
;
63 } __attribute__ ((__aligned__(sizeof(void *))));
65 extern ssize_t
__modver_version_show(struct module_attribute
*,
66 struct module_kobject
*, char *);
68 extern struct module_attribute module_uevent
;
70 /* These are either module local, or the kernel's dummy ones. */
71 extern int init_module(void);
72 extern void cleanup_module(void);
74 /* Archs provide a method of finding the correct exception table. */
75 struct exception_table_entry
;
77 const struct exception_table_entry
*
78 search_extable(const struct exception_table_entry
*first
,
79 const struct exception_table_entry
*last
,
81 void sort_extable(struct exception_table_entry
*start
,
82 struct exception_table_entry
*finish
);
83 void sort_main_extable(void);
84 void trim_init_extable(struct module
*m
);
87 #define MODULE_GENERIC_TABLE(gtype,name) \
88 extern const struct gtype##_id __mod_##gtype##_table \
89 __attribute__ ((unused, alias(__stringify(name))))
92 #define MODULE_GENERIC_TABLE(gtype,name)
95 /* Generic info of form tag = "info" */
96 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
98 /* For userspace: you can also call me... */
99 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
101 /* Soft module dependencies. See man modprobe.d for details.
102 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
104 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
107 * The following license idents are currently accepted as indicating free
110 * "GPL" [GNU Public License v2 or later]
111 * "GPL v2" [GNU Public License v2]
112 * "GPL and additional rights" [GNU Public License v2 rights and more]
113 * "Dual BSD/GPL" [GNU Public License v2
114 * or BSD license choice]
115 * "Dual MIT/GPL" [GNU Public License v2
116 * or MIT license choice]
117 * "Dual MPL/GPL" [GNU Public License v2
118 * or Mozilla license choice]
120 * The following other idents are available
122 * "Proprietary" [Non free products]
124 * There are dual licensed components, but when running with Linux it is the
125 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
126 * is a GPL combined work.
128 * This exists for several reasons
129 * 1. So modinfo can show license info for users wanting to vet their setup
131 * 2. So the community can ignore bug reports including proprietary modules
132 * 3. So vendors can do likewise based on their own policies
134 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
137 * Author(s), use "Name <email>" or just "Name", for multiple
138 * authors use multiple MODULE_AUTHOR() statements/lines.
140 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
142 /* What your module does. */
143 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
145 #define MODULE_DEVICE_TABLE(type,name) \
146 MODULE_GENERIC_TABLE(type##_device,name)
148 /* Version of form [<epoch>:]<version>[-<extra-version>].
149 Or for CVS/RCS ID version, everything but the number is stripped.
150 <epoch>: A (small) unsigned integer which allows you to start versions
151 anew. If not mentioned, it's zero. eg. "2:1.0" is after
153 <version>: The <version> may contain only alphanumerics and the
154 character `.'. Ordered by numeric sort for numeric parts,
155 ascii sort for ascii parts (as per RPM or DEB algorithm).
156 <extraversion>: Like <version>, but inserted for local
157 customizations, eg "rh3" or "rusty1".
159 Using this automatically adds a checksum of the .c files and the
160 local headers in "srcversion".
163 #if defined(MODULE) || !defined(CONFIG_SYSFS)
164 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
166 #define MODULE_VERSION(_version) \
167 static struct module_version_attribute ___modver_attr = { \
173 .show = __modver_version_show, \
175 .module_name = KBUILD_MODNAME, \
176 .version = _version, \
178 static const struct module_version_attribute \
179 __used __attribute__ ((__section__ ("__modver"))) \
180 * __moduleparam_const __modver_attr = &___modver_attr
183 /* Optional firmware file (or files) needed by the module
184 * format is simply firmware file name. Multiple firmware
185 * files require multiple MODULE_FIRMWARE() specifiers */
186 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
188 /* Given an address, look for it in the exception tables */
189 const struct exception_table_entry
*search_exception_tables(unsigned long add
);
191 struct notifier_block
;
193 #ifdef CONFIG_MODULES
195 extern int modules_disabled
; /* for sysctl */
196 /* Get/put a kernel symbol (calls must be symmetric) */
197 void *__symbol_get(const char *symbol
);
198 void *__symbol_get_gpl(const char *symbol
);
199 #define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
201 /* modules using other modules: kdb wants to see this. */
203 struct list_head source_list
;
204 struct list_head target_list
;
205 struct module
*source
, *target
;
209 MODULE_STATE_LIVE
, /* Normal state. */
210 MODULE_STATE_COMING
, /* Full formed, running module_init. */
211 MODULE_STATE_GOING
, /* Going away. */
212 MODULE_STATE_UNFORMED
, /* Still setting it up. */
216 * struct module_ref - per cpu module reference counts
217 * @incs: number of module get on this cpu
218 * @decs: number of module put on this cpu
220 * We force an alignment on 8 or 16 bytes, so that alloc_percpu()
221 * put @incs/@decs in same cache line, with no extra memory cost,
222 * since alloc_percpu() is fine grained.
227 } __attribute((aligned(2 * sizeof(unsigned long))));
231 enum module_state state
;
233 /* Member of list of modules */
234 struct list_head list
;
236 /* Unique handle for this module */
237 char name
[MODULE_NAME_LEN
];
240 struct module_kobject mkobj
;
241 struct module_attribute
*modinfo_attrs
;
243 const char *srcversion
;
244 struct kobject
*holders_dir
;
246 /* Exported symbols */
247 const struct kernel_symbol
*syms
;
248 const unsigned long *crcs
;
249 unsigned int num_syms
;
251 /* Kernel parameters. */
252 struct kernel_param
*kp
;
255 /* GPL-only exported symbols. */
256 unsigned int num_gpl_syms
;
257 const struct kernel_symbol
*gpl_syms
;
258 const unsigned long *gpl_crcs
;
260 #ifdef CONFIG_UNUSED_SYMBOLS
261 /* unused exported symbols. */
262 const struct kernel_symbol
*unused_syms
;
263 const unsigned long *unused_crcs
;
264 unsigned int num_unused_syms
;
266 /* GPL-only, unused exported symbols. */
267 unsigned int num_unused_gpl_syms
;
268 const struct kernel_symbol
*unused_gpl_syms
;
269 const unsigned long *unused_gpl_crcs
;
272 #ifdef CONFIG_MODULE_SIG
273 /* Signature was verified. */
277 /* symbols that will be GPL-only in the near future. */
278 const struct kernel_symbol
*gpl_future_syms
;
279 const unsigned long *gpl_future_crcs
;
280 unsigned int num_gpl_future_syms
;
282 /* Exception table */
283 unsigned int num_exentries
;
284 struct exception_table_entry
*extable
;
286 /* Startup function. */
289 /* If this is non-NULL, vfree after init() returns */
292 /* Here is the actual code + data, vfree'd on unload. */
295 /* Here are the sizes of the init and core sections */
296 unsigned int init_size
, core_size
;
298 /* The size of the executable code in each section. */
299 unsigned int init_text_size
, core_text_size
;
301 /* Size of RO sections of the module (text+rodata) */
302 unsigned int init_ro_size
, core_ro_size
;
304 /* Arch-specific module values */
305 struct mod_arch_specific arch
;
307 unsigned int taints
; /* same bits as kernel:tainted */
309 #ifdef CONFIG_GENERIC_BUG
310 /* Support for BUG */
312 struct list_head bug_list
;
313 struct bug_entry
*bug_table
;
316 #ifdef CONFIG_KALLSYMS
318 * We keep the symbol and string tables for kallsyms.
319 * The core_* fields below are temporary, loader-only (they
320 * could really be discarded after module init).
322 Elf_Sym
*symtab
, *core_symtab
;
323 unsigned int num_symtab
, core_num_syms
;
324 char *strtab
, *core_strtab
;
326 /* Section attributes */
327 struct module_sect_attrs
*sect_attrs
;
329 /* Notes attributes */
330 struct module_notes_attrs
*notes_attrs
;
333 /* The command line arguments (may be mangled). People like
334 keeping pointers to this stuff */
339 void __percpu
*percpu
;
340 unsigned int percpu_size
;
343 #ifdef CONFIG_TRACEPOINTS
344 unsigned int num_tracepoints
;
345 struct tracepoint
* const *tracepoints_ptrs
;
347 #ifdef HAVE_JUMP_LABEL
348 struct jump_entry
*jump_entries
;
349 unsigned int num_jump_entries
;
351 #ifdef CONFIG_TRACING
352 unsigned int num_trace_bprintk_fmt
;
353 const char **trace_bprintk_fmt_start
;
355 #ifdef CONFIG_EVENT_TRACING
356 struct ftrace_event_call
**trace_events
;
357 unsigned int num_trace_events
;
359 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
360 unsigned int num_ftrace_callsites
;
361 unsigned long *ftrace_callsites
;
364 #ifdef CONFIG_MODULE_UNLOAD
365 /* What modules depend on me? */
366 struct list_head source_list
;
367 /* What modules do I depend on? */
368 struct list_head target_list
;
370 /* Destruction function. */
373 struct module_ref __percpu
*refptr
;
376 #ifdef CONFIG_CONSTRUCTORS
377 /* Constructor functions. */
379 unsigned int num_ctors
;
382 #ifndef MODULE_ARCH_INIT
383 #define MODULE_ARCH_INIT {}
386 extern struct mutex module_mutex
;
388 /* FIXME: It'd be nice to isolate modules during init, too, so they
389 aren't used before they (may) fail. But presently too much code
390 (IDE & SCSI) require entry into the module during init.*/
391 static inline int module_is_live(struct module
*mod
)
393 return mod
->state
!= MODULE_STATE_GOING
;
396 struct module
*__module_text_address(unsigned long addr
);
397 struct module
*__module_address(unsigned long addr
);
398 bool is_module_address(unsigned long addr
);
399 bool is_module_percpu_address(unsigned long addr
);
400 bool is_module_text_address(unsigned long addr
);
402 static inline int within_module_core(unsigned long addr
, const struct module
*mod
)
404 return (unsigned long)mod
->module_core
<= addr
&&
405 addr
< (unsigned long)mod
->module_core
+ mod
->core_size
;
408 static inline int within_module_init(unsigned long addr
, const struct module
*mod
)
410 return (unsigned long)mod
->module_init
<= addr
&&
411 addr
< (unsigned long)mod
->module_init
+ mod
->init_size
;
414 /* Search for module by name: must hold module_mutex. */
415 struct module
*find_module(const char *name
);
418 const struct kernel_symbol
*start
, *stop
;
419 const unsigned long *crcs
;
428 /* Search for an exported symbol by name. */
429 const struct kernel_symbol
*find_symbol(const char *name
,
430 struct module
**owner
,
431 const unsigned long **crc
,
435 /* Walk the exported symbol table */
436 bool each_symbol_section(bool (*fn
)(const struct symsearch
*arr
,
437 struct module
*owner
,
438 void *data
), void *data
);
440 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
441 symnum out of range. */
442 int module_get_kallsym(unsigned int symnum
, unsigned long *value
, char *type
,
443 char *name
, char *module_name
, int *exported
);
445 /* Look for this name: can be of form module:name. */
446 unsigned long module_kallsyms_lookup_name(const char *name
);
448 int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
449 struct module
*, unsigned long),
452 extern void __module_put_and_exit(struct module
*mod
, long code
)
453 __attribute__((noreturn
));
454 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
456 #ifdef CONFIG_MODULE_UNLOAD
457 unsigned long module_refcount(struct module
*mod
);
458 void __symbol_put(const char *symbol
);
459 #define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
460 void symbol_put_addr(void *addr
);
462 /* Sometimes we know we already have a refcount, and it's easier not
463 to handle the error case (which only happens with rmmod --wait). */
464 extern void __module_get(struct module
*module
);
466 /* This is the Right Way to get a module: if it fails, it's being removed,
467 * so pretend it's not there. */
468 extern bool try_module_get(struct module
*module
);
470 extern void module_put(struct module
*module
);
472 #else /*!CONFIG_MODULE_UNLOAD*/
473 static inline int try_module_get(struct module
*module
)
475 return !module
|| module_is_live(module
);
477 static inline void module_put(struct module
*module
)
480 static inline void __module_get(struct module
*module
)
483 #define symbol_put(x) do { } while(0)
484 #define symbol_put_addr(p) do { } while(0)
486 #endif /* CONFIG_MODULE_UNLOAD */
487 int ref_module(struct module
*a
, struct module
*b
);
489 /* This is a #define so the string doesn't get put in every .o file */
490 #define module_name(mod) \
492 struct module *__mod = (mod); \
493 __mod ? __mod->name : "kernel"; \
496 /* For kallsyms to ask for address resolution. namebuf should be at
497 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
498 * found, otherwise NULL. */
499 const char *module_address_lookup(unsigned long addr
,
500 unsigned long *symbolsize
,
501 unsigned long *offset
,
504 int lookup_module_symbol_name(unsigned long addr
, char *symname
);
505 int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
);
507 /* For extable.c to search modules' exception tables. */
508 const struct exception_table_entry
*search_module_extables(unsigned long addr
);
510 int register_module_notifier(struct notifier_block
* nb
);
511 int unregister_module_notifier(struct notifier_block
* nb
);
513 extern void print_modules(void);
515 #else /* !CONFIG_MODULES... */
517 /* Given an address, look for it in the exception tables. */
518 static inline const struct exception_table_entry
*
519 search_module_extables(unsigned long addr
)
524 static inline struct module
*__module_address(unsigned long addr
)
529 static inline struct module
*__module_text_address(unsigned long addr
)
534 static inline bool is_module_address(unsigned long addr
)
539 static inline bool is_module_percpu_address(unsigned long addr
)
544 static inline bool is_module_text_address(unsigned long addr
)
549 /* Get/put a kernel symbol (calls should be symmetric) */
550 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
551 #define symbol_put(x) do { } while(0)
552 #define symbol_put_addr(x) do { } while(0)
554 static inline void __module_get(struct module
*module
)
558 static inline int try_module_get(struct module
*module
)
563 static inline void module_put(struct module
*module
)
567 #define module_name(mod) "kernel"
569 /* For kallsyms to ask for address resolution. NULL means not found. */
570 static inline const char *module_address_lookup(unsigned long addr
,
571 unsigned long *symbolsize
,
572 unsigned long *offset
,
579 static inline int lookup_module_symbol_name(unsigned long addr
, char *symname
)
584 static inline int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
)
589 static inline int module_get_kallsym(unsigned int symnum
, unsigned long *value
,
590 char *type
, char *name
,
591 char *module_name
, int *exported
)
596 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
601 static inline int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
609 static inline int register_module_notifier(struct notifier_block
* nb
)
611 /* no events will happen anyway, so this can always succeed */
615 static inline int unregister_module_notifier(struct notifier_block
* nb
)
620 #define module_put_and_exit(code) do_exit(code)
622 static inline void print_modules(void)
625 #endif /* CONFIG_MODULES */
628 extern struct kset
*module_kset
;
629 extern struct kobj_type module_ktype
;
630 extern int module_sysfs_initialized
;
631 #endif /* CONFIG_SYSFS */
633 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
635 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
637 #define __MODULE_STRING(x) __stringify(x)
639 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
640 extern void set_all_modules_text_rw(void);
641 extern void set_all_modules_text_ro(void);
643 static inline void set_all_modules_text_rw(void) { }
644 static inline void set_all_modules_text_ro(void) { }
647 #ifdef CONFIG_GENERIC_BUG
648 void module_bug_finalize(const Elf_Ehdr
*, const Elf_Shdr
*,
650 void module_bug_cleanup(struct module
*);
652 #else /* !CONFIG_GENERIC_BUG */
654 static inline void module_bug_finalize(const Elf_Ehdr
*hdr
,
655 const Elf_Shdr
*sechdrs
,
659 static inline void module_bug_cleanup(struct module
*mod
) {}
660 #endif /* CONFIG_GENERIC_BUG */
662 #endif /* _LINUX_MODULE_H */