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/jump_label.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
{
34 char name
[MODULE_NAME_LEN
];
39 struct module_kobject
{
42 struct kobject
*drivers_dir
;
43 struct module_param_attrs
*mp
;
44 struct completion
*kobj_completion
;
47 struct module_attribute
{
48 struct attribute attr
;
49 ssize_t (*show
)(struct module_attribute
*, struct module_kobject
*,
51 ssize_t (*store
)(struct module_attribute
*, struct module_kobject
*,
52 const char *, size_t count
);
53 void (*setup
)(struct module
*, const char *);
54 int (*test
)(struct module
*);
55 void (*free
)(struct module
*);
58 struct module_version_attribute
{
59 struct module_attribute mattr
;
60 const char *module_name
;
62 } __attribute__ ((__aligned__(sizeof(void *))));
64 extern ssize_t
__modver_version_show(struct module_attribute
*,
65 struct module_kobject
*, char *);
67 extern struct module_attribute module_uevent
;
69 /* These are either module local, or the kernel's dummy ones. */
70 extern int init_module(void);
71 extern void cleanup_module(void);
73 /* Archs provide a method of finding the correct exception table. */
74 struct exception_table_entry
;
76 const struct exception_table_entry
*
77 search_extable(const struct exception_table_entry
*first
,
78 const struct exception_table_entry
*last
,
80 void sort_extable(struct exception_table_entry
*start
,
81 struct exception_table_entry
*finish
);
82 void sort_main_extable(void);
83 void trim_init_extable(struct module
*m
);
85 /* Generic info of form tag = "info" */
86 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
88 /* For userspace: you can also call me... */
89 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
91 /* Soft module dependencies. See man modprobe.d for details.
92 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
94 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
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)
127 * Author(s), use "Name <email>" or just "Name", for multiple
128 * authors use multiple MODULE_AUTHOR() statements/lines.
130 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
132 /* What your module does. */
133 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
136 /* Creates an alias so file2alias.c can find device table. */
137 #define MODULE_DEVICE_TABLE(type, name) \
138 extern const typeof(name) __mod_##type##__##name##_device_table \
139 __attribute__ ((unused, alias(__stringify(name))))
141 #define MODULE_DEVICE_TABLE(type, name)
144 /* Version of form [<epoch>:]<version>[-<extra-version>].
145 * Or for CVS/RCS ID version, everything but the number is stripped.
146 * <epoch>: A (small) unsigned integer which allows you to start versions
147 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
150 * <version>: The <version> may contain only alphanumerics and the
151 * character `.'. Ordered by numeric sort for numeric parts,
152 * ascii sort for ascii parts (as per RPM or DEB algorithm).
154 * <extraversion>: Like <version>, but inserted for local
155 * customizations, eg "rh3" or "rusty1".
157 * Using this automatically adds a checksum of the .c files and the
158 * local headers in "srcversion".
161 #if defined(MODULE) || !defined(CONFIG_SYSFS)
162 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
164 #define MODULE_VERSION(_version) \
165 static struct module_version_attribute ___modver_attr = { \
171 .show = __modver_version_show, \
173 .module_name = KBUILD_MODNAME, \
174 .version = _version, \
176 static const struct module_version_attribute \
177 __used __attribute__ ((__section__ ("__modver"))) \
178 * __moduleparam_const __modver_attr = &___modver_attr
181 /* Optional firmware file (or files) needed by the module
182 * format is simply firmware file name. Multiple firmware
183 * files require multiple MODULE_FIRMWARE() specifiers */
184 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
186 /* Given an address, look for it in the exception tables */
187 const struct exception_table_entry
*search_exception_tables(unsigned long add
);
189 struct notifier_block
;
191 #ifdef CONFIG_MODULES
193 extern int modules_disabled
; /* for sysctl */
194 /* Get/put a kernel symbol (calls must be symmetric) */
195 void *__symbol_get(const char *symbol
);
196 void *__symbol_get_gpl(const char *symbol
);
197 #define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
199 /* modules using other modules: kdb wants to see this. */
201 struct list_head source_list
;
202 struct list_head target_list
;
203 struct module
*source
, *target
;
207 MODULE_STATE_LIVE
, /* Normal state. */
208 MODULE_STATE_COMING
, /* Full formed, running module_init. */
209 MODULE_STATE_GOING
, /* Going away. */
210 MODULE_STATE_UNFORMED
, /* Still setting it up. */
214 enum module_state state
;
216 /* Member of list of modules */
217 struct list_head list
;
219 /* Unique handle for this module */
220 char name
[MODULE_NAME_LEN
];
223 struct module_kobject mkobj
;
224 struct module_attribute
*modinfo_attrs
;
226 const char *srcversion
;
227 struct kobject
*holders_dir
;
229 /* Exported symbols */
230 const struct kernel_symbol
*syms
;
231 const unsigned long *crcs
;
232 unsigned int num_syms
;
234 /* Kernel parameters. */
235 struct kernel_param
*kp
;
238 /* GPL-only exported symbols. */
239 unsigned int num_gpl_syms
;
240 const struct kernel_symbol
*gpl_syms
;
241 const unsigned long *gpl_crcs
;
243 #ifdef CONFIG_UNUSED_SYMBOLS
244 /* unused exported symbols. */
245 const struct kernel_symbol
*unused_syms
;
246 const unsigned long *unused_crcs
;
247 unsigned int num_unused_syms
;
249 /* GPL-only, unused exported symbols. */
250 unsigned int num_unused_gpl_syms
;
251 const struct kernel_symbol
*unused_gpl_syms
;
252 const unsigned long *unused_gpl_crcs
;
255 #ifdef CONFIG_MODULE_SIG
256 /* Signature was verified. */
260 /* symbols that will be GPL-only in the near future. */
261 const struct kernel_symbol
*gpl_future_syms
;
262 const unsigned long *gpl_future_crcs
;
263 unsigned int num_gpl_future_syms
;
265 /* Exception table */
266 unsigned int num_exentries
;
267 struct exception_table_entry
*extable
;
269 /* Startup function. */
272 /* If this is non-NULL, vfree after init() returns */
275 /* Here is the actual code + data, vfree'd on unload. */
278 /* Here are the sizes of the init and core sections */
279 unsigned int init_size
, core_size
;
281 /* The size of the executable code in each section. */
282 unsigned int init_text_size
, core_text_size
;
284 /* Size of RO sections of the module (text+rodata) */
285 unsigned int init_ro_size
, core_ro_size
;
287 /* Arch-specific module values */
288 struct mod_arch_specific arch
;
290 unsigned int taints
; /* same bits as kernel:tainted */
292 #ifdef CONFIG_GENERIC_BUG
293 /* Support for BUG */
295 struct list_head bug_list
;
296 struct bug_entry
*bug_table
;
299 #ifdef CONFIG_KALLSYMS
301 * We keep the symbol and string tables for kallsyms.
302 * The core_* fields below are temporary, loader-only (they
303 * could really be discarded after module init).
305 Elf_Sym
*symtab
, *core_symtab
;
306 unsigned int num_symtab
, core_num_syms
;
307 char *strtab
, *core_strtab
;
309 /* Section attributes */
310 struct module_sect_attrs
*sect_attrs
;
312 /* Notes attributes */
313 struct module_notes_attrs
*notes_attrs
;
316 /* The command line arguments (may be mangled). People like
317 keeping pointers to this stuff */
322 void __percpu
*percpu
;
323 unsigned int percpu_size
;
326 #ifdef CONFIG_TRACEPOINTS
327 unsigned int num_tracepoints
;
328 struct tracepoint
* const *tracepoints_ptrs
;
330 #ifdef HAVE_JUMP_LABEL
331 struct jump_entry
*jump_entries
;
332 unsigned int num_jump_entries
;
334 #ifdef CONFIG_TRACING
335 unsigned int num_trace_bprintk_fmt
;
336 const char **trace_bprintk_fmt_start
;
338 #ifdef CONFIG_EVENT_TRACING
339 struct ftrace_event_call
**trace_events
;
340 unsigned int num_trace_events
;
342 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
343 unsigned int num_ftrace_callsites
;
344 unsigned long *ftrace_callsites
;
347 #ifdef CONFIG_MODULE_UNLOAD
348 /* What modules depend on me? */
349 struct list_head source_list
;
350 /* What modules do I depend on? */
351 struct list_head target_list
;
353 /* Destruction function. */
359 #ifdef CONFIG_CONSTRUCTORS
360 /* Constructor functions. */
362 unsigned int num_ctors
;
365 #ifndef MODULE_ARCH_INIT
366 #define MODULE_ARCH_INIT {}
369 extern struct mutex module_mutex
;
371 /* FIXME: It'd be nice to isolate modules during init, too, so they
372 aren't used before they (may) fail. But presently too much code
373 (IDE & SCSI) require entry into the module during init.*/
374 static inline int module_is_live(struct module
*mod
)
376 return mod
->state
!= MODULE_STATE_GOING
;
379 struct module
*__module_text_address(unsigned long addr
);
380 struct module
*__module_address(unsigned long addr
);
381 bool is_module_address(unsigned long addr
);
382 bool is_module_percpu_address(unsigned long addr
);
383 bool is_module_text_address(unsigned long addr
);
385 static inline bool within_module_core(unsigned long addr
,
386 const struct module
*mod
)
388 return (unsigned long)mod
->module_core
<= addr
&&
389 addr
< (unsigned long)mod
->module_core
+ mod
->core_size
;
392 static inline bool within_module_init(unsigned long addr
,
393 const struct module
*mod
)
395 return (unsigned long)mod
->module_init
<= addr
&&
396 addr
< (unsigned long)mod
->module_init
+ mod
->init_size
;
399 static inline bool within_module(unsigned long addr
, const struct module
*mod
)
401 return within_module_init(addr
, mod
) || within_module_core(addr
, mod
);
404 /* Search for module by name: must hold module_mutex. */
405 struct module
*find_module(const char *name
);
408 const struct kernel_symbol
*start
, *stop
;
409 const unsigned long *crcs
;
418 /* Search for an exported symbol by name. */
419 const struct kernel_symbol
*find_symbol(const char *name
,
420 struct module
**owner
,
421 const unsigned long **crc
,
425 /* Walk the exported symbol table */
426 bool each_symbol_section(bool (*fn
)(const struct symsearch
*arr
,
427 struct module
*owner
,
428 void *data
), void *data
);
430 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
431 symnum out of range. */
432 int module_get_kallsym(unsigned int symnum
, unsigned long *value
, char *type
,
433 char *name
, char *module_name
, int *exported
);
435 /* Look for this name: can be of form module:name. */
436 unsigned long module_kallsyms_lookup_name(const char *name
);
438 int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
439 struct module
*, unsigned long),
442 extern void __module_put_and_exit(struct module
*mod
, long code
)
443 __attribute__((noreturn
));
444 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
446 #ifdef CONFIG_MODULE_UNLOAD
447 int module_refcount(struct module
*mod
);
448 void __symbol_put(const char *symbol
);
449 #define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
450 void symbol_put_addr(void *addr
);
452 /* Sometimes we know we already have a refcount, and it's easier not
453 to handle the error case (which only happens with rmmod --wait). */
454 extern void __module_get(struct module
*module
);
456 /* This is the Right Way to get a module: if it fails, it's being removed,
457 * so pretend it's not there. */
458 extern bool try_module_get(struct module
*module
);
460 extern void module_put(struct module
*module
);
462 #else /*!CONFIG_MODULE_UNLOAD*/
463 static inline int try_module_get(struct module
*module
)
465 return !module
|| module_is_live(module
);
467 static inline void module_put(struct module
*module
)
470 static inline void __module_get(struct module
*module
)
473 #define symbol_put(x) do { } while (0)
474 #define symbol_put_addr(p) do { } while (0)
476 #endif /* CONFIG_MODULE_UNLOAD */
477 int ref_module(struct module
*a
, struct module
*b
);
479 /* This is a #define so the string doesn't get put in every .o file */
480 #define module_name(mod) \
482 struct module *__mod = (mod); \
483 __mod ? __mod->name : "kernel"; \
486 /* For kallsyms to ask for address resolution. namebuf should be at
487 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
488 * found, otherwise NULL. */
489 const char *module_address_lookup(unsigned long addr
,
490 unsigned long *symbolsize
,
491 unsigned long *offset
,
494 int lookup_module_symbol_name(unsigned long addr
, char *symname
);
495 int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
);
497 /* For extable.c to search modules' exception tables. */
498 const struct exception_table_entry
*search_module_extables(unsigned long addr
);
500 int register_module_notifier(struct notifier_block
*nb
);
501 int unregister_module_notifier(struct notifier_block
*nb
);
503 extern void print_modules(void);
505 #else /* !CONFIG_MODULES... */
507 /* Given an address, look for it in the exception tables. */
508 static inline const struct exception_table_entry
*
509 search_module_extables(unsigned long addr
)
514 static inline struct module
*__module_address(unsigned long addr
)
519 static inline struct module
*__module_text_address(unsigned long addr
)
524 static inline bool is_module_address(unsigned long addr
)
529 static inline bool is_module_percpu_address(unsigned long addr
)
534 static inline bool is_module_text_address(unsigned long addr
)
539 /* Get/put a kernel symbol (calls should be symmetric) */
540 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
541 #define symbol_put(x) do { } while (0)
542 #define symbol_put_addr(x) do { } while (0)
544 static inline void __module_get(struct module
*module
)
548 static inline int try_module_get(struct module
*module
)
553 static inline void module_put(struct module
*module
)
557 #define module_name(mod) "kernel"
559 /* For kallsyms to ask for address resolution. NULL means not found. */
560 static inline const char *module_address_lookup(unsigned long addr
,
561 unsigned long *symbolsize
,
562 unsigned long *offset
,
569 static inline int lookup_module_symbol_name(unsigned long addr
, char *symname
)
574 static inline int lookup_module_symbol_attrs(unsigned long addr
, unsigned long *size
, unsigned long *offset
, char *modname
, char *name
)
579 static inline int module_get_kallsym(unsigned int symnum
, unsigned long *value
,
580 char *type
, char *name
,
581 char *module_name
, int *exported
)
586 static inline unsigned long module_kallsyms_lookup_name(const char *name
)
591 static inline int module_kallsyms_on_each_symbol(int (*fn
)(void *, const char *,
599 static inline int register_module_notifier(struct notifier_block
*nb
)
601 /* no events will happen anyway, so this can always succeed */
605 static inline int unregister_module_notifier(struct notifier_block
*nb
)
610 #define module_put_and_exit(code) do_exit(code)
612 static inline void print_modules(void)
615 #endif /* CONFIG_MODULES */
618 extern struct kset
*module_kset
;
619 extern struct kobj_type module_ktype
;
620 extern int module_sysfs_initialized
;
621 #endif /* CONFIG_SYSFS */
623 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
625 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
627 #define __MODULE_STRING(x) __stringify(x)
629 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
630 extern void set_all_modules_text_rw(void);
631 extern void set_all_modules_text_ro(void);
633 static inline void set_all_modules_text_rw(void) { }
634 static inline void set_all_modules_text_ro(void) { }
637 #ifdef CONFIG_GENERIC_BUG
638 void module_bug_finalize(const Elf_Ehdr
*, const Elf_Shdr
*,
640 void module_bug_cleanup(struct module
*);
642 #else /* !CONFIG_GENERIC_BUG */
644 static inline void module_bug_finalize(const Elf_Ehdr
*hdr
,
645 const Elf_Shdr
*sechdrs
,
649 static inline void module_bug_cleanup(struct module
*mod
) {}
650 #endif /* CONFIG_GENERIC_BUG */
652 #endif /* _LINUX_MODULE_H */