Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef _LINUX_MODULE_H |
2 | #define _LINUX_MODULE_H | |
3 | /* | |
4 | * Dynamic loading of modules into the kernel. | |
5 | * | |
6 | * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996 | |
7 | * Rewritten again by Rusty Russell, 2002 | |
8 | */ | |
1da177e4 LT |
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> | |
b2e285fc | 18 | #include <linux/jump_label.h> |
f5016932 | 19 | #include <linux/export.h> |
93c2e105 | 20 | #include <linux/rbtree_latch.h> |
1da177e4 | 21 | |
e1783a24 | 22 | #include <linux/percpu.h> |
1da177e4 LT |
23 | #include <asm/module.h> |
24 | ||
106a4ee2 RR |
25 | /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */ |
26 | #define MODULE_SIG_STRING "~Module signature appended~\n" | |
27 | ||
1da177e4 LT |
28 | /* Not Yet Implemented */ |
29 | #define MODULE_SUPPORTED_DEVICE(name) | |
30 | ||
730b69d2 | 31 | #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN |
1da177e4 | 32 | |
e865d06b | 33 | struct modversion_info { |
1da177e4 LT |
34 | unsigned long crc; |
35 | char name[MODULE_NAME_LEN]; | |
36 | }; | |
37 | ||
38 | struct module; | |
39 | ||
4befb026 KS |
40 | struct module_kobject { |
41 | struct kobject kobj; | |
42 | struct module *mod; | |
43 | struct kobject *drivers_dir; | |
44 | struct module_param_attrs *mp; | |
942e4431 | 45 | struct completion *kobj_completion; |
4befb026 KS |
46 | }; |
47 | ||
1da177e4 | 48 | struct module_attribute { |
4befb026 KS |
49 | struct attribute attr; |
50 | ssize_t (*show)(struct module_attribute *, struct module_kobject *, | |
51 | char *); | |
52 | ssize_t (*store)(struct module_attribute *, struct module_kobject *, | |
1da177e4 | 53 | const char *, size_t count); |
c988d2b2 MD |
54 | void (*setup)(struct module *, const char *); |
55 | int (*test)(struct module *); | |
56 | void (*free)(struct module *); | |
1da177e4 LT |
57 | }; |
58 | ||
e94965ed DT |
59 | struct module_version_attribute { |
60 | struct module_attribute mattr; | |
61 | const char *module_name; | |
62 | const char *version; | |
98562ad8 | 63 | } __attribute__ ((__aligned__(sizeof(void *)))); |
e94965ed | 64 | |
9b73a584 | 65 | extern ssize_t __modver_version_show(struct module_attribute *, |
4befb026 | 66 | struct module_kobject *, char *); |
9b73a584 | 67 | |
88bfa324 | 68 | extern struct module_attribute module_uevent; |
1da177e4 LT |
69 | |
70 | /* These are either module local, or the kernel's dummy ones. */ | |
71 | extern int init_module(void); | |
72 | extern void cleanup_module(void); | |
73 | ||
74 | /* Archs provide a method of finding the correct exception table. */ | |
75 | struct exception_table_entry; | |
76 | ||
77 | const struct exception_table_entry * | |
78 | search_extable(const struct exception_table_entry *first, | |
79 | const struct exception_table_entry *last, | |
80 | unsigned long value); | |
81 | void sort_extable(struct exception_table_entry *start, | |
82 | struct exception_table_entry *finish); | |
83 | void sort_main_extable(void); | |
ad6561df | 84 | void trim_init_extable(struct module *m); |
1da177e4 | 85 | |
1da177e4 LT |
86 | /* Generic info of form tag = "info" */ |
87 | #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info) | |
88 | ||
89 | /* For userspace: you can also call me... */ | |
90 | #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias) | |
91 | ||
7cb14ba7 AR |
92 | /* Soft module dependencies. See man modprobe.d for details. |
93 | * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz") | |
94 | */ | |
95 | #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep) | |
96 | ||
1da177e4 LT |
97 | /* |
98 | * The following license idents are currently accepted as indicating free | |
99 | * software modules | |
100 | * | |
101 | * "GPL" [GNU Public License v2 or later] | |
102 | * "GPL v2" [GNU Public License v2] | |
103 | * "GPL and additional rights" [GNU Public License v2 rights and more] | |
104 | * "Dual BSD/GPL" [GNU Public License v2 | |
105 | * or BSD license choice] | |
8d27e908 XVP |
106 | * "Dual MIT/GPL" [GNU Public License v2 |
107 | * or MIT license choice] | |
1da177e4 LT |
108 | * "Dual MPL/GPL" [GNU Public License v2 |
109 | * or Mozilla license choice] | |
110 | * | |
111 | * The following other idents are available | |
112 | * | |
113 | * "Proprietary" [Non free products] | |
114 | * | |
115 | * There are dual licensed components, but when running with Linux it is the | |
116 | * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL | |
117 | * is a GPL combined work. | |
118 | * | |
119 | * This exists for several reasons | |
e865d06b | 120 | * 1. So modinfo can show license info for users wanting to vet their setup |
1da177e4 LT |
121 | * is free |
122 | * 2. So the community can ignore bug reports including proprietary modules | |
123 | * 3. So vendors can do likewise based on their own policies | |
124 | */ | |
125 | #define MODULE_LICENSE(_license) MODULE_INFO(license, _license) | |
126 | ||
1d7015ca JB |
127 | /* |
128 | * Author(s), use "Name <email>" or just "Name", for multiple | |
129 | * authors use multiple MODULE_AUTHOR() statements/lines. | |
130 | */ | |
1da177e4 | 131 | #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author) |
e865d06b | 132 | |
1da177e4 LT |
133 | /* What your module does. */ |
134 | #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description) | |
135 | ||
cff26a51 RR |
136 | #ifdef MODULE |
137 | /* Creates an alias so file2alias.c can find device table. */ | |
138 | #define MODULE_DEVICE_TABLE(type, name) \ | |
6301939d | 139 | extern const typeof(name) __mod_##type##__##name##_device_table \ |
cff26a51 RR |
140 | __attribute__ ((unused, alias(__stringify(name)))) |
141 | #else /* !MODULE */ | |
142 | #define MODULE_DEVICE_TABLE(type, name) | |
143 | #endif | |
1da177e4 LT |
144 | |
145 | /* Version of form [<epoch>:]<version>[-<extra-version>]. | |
e865d06b SL |
146 | * Or for CVS/RCS ID version, everything but the number is stripped. |
147 | * <epoch>: A (small) unsigned integer which allows you to start versions | |
148 | * anew. If not mentioned, it's zero. eg. "2:1.0" is after | |
149 | * "1:2.0". | |
150 | ||
151 | * <version>: The <version> may contain only alphanumerics and the | |
152 | * character `.'. Ordered by numeric sort for numeric parts, | |
153 | * ascii sort for ascii parts (as per RPM or DEB algorithm). | |
154 | ||
155 | * <extraversion>: Like <version>, but inserted for local | |
156 | * customizations, eg "rh3" or "rusty1". | |
157 | ||
158 | * Using this automatically adds a checksum of the .c files and the | |
159 | * local headers in "srcversion". | |
160 | */ | |
e94965ed | 161 | |
3b90a5b2 | 162 | #if defined(MODULE) || !defined(CONFIG_SYSFS) |
1da177e4 | 163 | #define MODULE_VERSION(_version) MODULE_INFO(version, _version) |
e94965ed DT |
164 | #else |
165 | #define MODULE_VERSION(_version) \ | |
b4bc8428 | 166 | static struct module_version_attribute ___modver_attr = { \ |
e94965ed DT |
167 | .mattr = { \ |
168 | .attr = { \ | |
169 | .name = "version", \ | |
170 | .mode = S_IRUGO, \ | |
171 | }, \ | |
172 | .show = __modver_version_show, \ | |
173 | }, \ | |
174 | .module_name = KBUILD_MODNAME, \ | |
175 | .version = _version, \ | |
b4bc8428 DT |
176 | }; \ |
177 | static const struct module_version_attribute \ | |
178 | __used __attribute__ ((__section__ ("__modver"))) \ | |
179 | * __moduleparam_const __modver_attr = &___modver_attr | |
e94965ed | 180 | #endif |
1da177e4 | 181 | |
187afbed JM |
182 | /* Optional firmware file (or files) needed by the module |
183 | * format is simply firmware file name. Multiple firmware | |
184 | * files require multiple MODULE_FIRMWARE() specifiers */ | |
185 | #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware) | |
186 | ||
1da177e4 LT |
187 | /* Given an address, look for it in the exception tables */ |
188 | const struct exception_table_entry *search_exception_tables(unsigned long add); | |
189 | ||
190 | struct notifier_block; | |
191 | ||
192 | #ifdef CONFIG_MODULES | |
193 | ||
5ed10910 | 194 | extern int modules_disabled; /* for sysctl */ |
1da177e4 LT |
195 | /* Get/put a kernel symbol (calls must be symmetric) */ |
196 | void *__symbol_get(const char *symbol); | |
197 | void *__symbol_get_gpl(const char *symbol); | |
b92021b0 | 198 | #define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x)))) |
1da177e4 | 199 | |
c8e21ced RR |
200 | /* modules using other modules: kdb wants to see this. */ |
201 | struct module_use { | |
202 | struct list_head source_list; | |
203 | struct list_head target_list; | |
204 | struct module *source, *target; | |
205 | }; | |
206 | ||
0d21b0e3 RR |
207 | enum module_state { |
208 | MODULE_STATE_LIVE, /* Normal state. */ | |
209 | MODULE_STATE_COMING, /* Full formed, running module_init. */ | |
210 | MODULE_STATE_GOING, /* Going away. */ | |
211 | MODULE_STATE_UNFORMED, /* Still setting it up. */ | |
1da177e4 LT |
212 | }; |
213 | ||
93c2e105 PZ |
214 | struct module; |
215 | ||
216 | struct mod_tree_node { | |
217 | struct module *mod; | |
218 | struct latch_tree_node node; | |
219 | }; | |
220 | ||
e865d06b | 221 | struct module { |
1da177e4 LT |
222 | enum module_state state; |
223 | ||
224 | /* Member of list of modules */ | |
225 | struct list_head list; | |
226 | ||
227 | /* Unique handle for this module */ | |
228 | char name[MODULE_NAME_LEN]; | |
229 | ||
230 | /* Sysfs stuff. */ | |
231 | struct module_kobject mkobj; | |
03e88ae1 | 232 | struct module_attribute *modinfo_attrs; |
c988d2b2 MD |
233 | const char *version; |
234 | const char *srcversion; | |
270a6c4c | 235 | struct kobject *holders_dir; |
1da177e4 LT |
236 | |
237 | /* Exported symbols */ | |
238 | const struct kernel_symbol *syms; | |
1da177e4 | 239 | const unsigned long *crcs; |
af540689 | 240 | unsigned int num_syms; |
1da177e4 | 241 | |
e180a6b7 | 242 | /* Kernel parameters. */ |
b51d23e4 | 243 | struct mutex param_lock; |
e180a6b7 RR |
244 | struct kernel_param *kp; |
245 | unsigned int num_kp; | |
246 | ||
1da177e4 | 247 | /* GPL-only exported symbols. */ |
1da177e4 | 248 | unsigned int num_gpl_syms; |
af540689 | 249 | const struct kernel_symbol *gpl_syms; |
1da177e4 LT |
250 | const unsigned long *gpl_crcs; |
251 | ||
f7f5b675 | 252 | #ifdef CONFIG_UNUSED_SYMBOLS |
f71d20e9 AV |
253 | /* unused exported symbols. */ |
254 | const struct kernel_symbol *unused_syms; | |
f71d20e9 | 255 | const unsigned long *unused_crcs; |
af540689 RK |
256 | unsigned int num_unused_syms; |
257 | ||
f71d20e9 | 258 | /* GPL-only, unused exported symbols. */ |
f71d20e9 | 259 | unsigned int num_unused_gpl_syms; |
af540689 | 260 | const struct kernel_symbol *unused_gpl_syms; |
f71d20e9 | 261 | const unsigned long *unused_gpl_crcs; |
f7f5b675 | 262 | #endif |
f71d20e9 | 263 | |
106a4ee2 RR |
264 | #ifdef CONFIG_MODULE_SIG |
265 | /* Signature was verified. */ | |
266 | bool sig_ok; | |
267 | #endif | |
268 | ||
9f28bb7e GKH |
269 | /* symbols that will be GPL-only in the near future. */ |
270 | const struct kernel_symbol *gpl_future_syms; | |
9f28bb7e | 271 | const unsigned long *gpl_future_crcs; |
af540689 | 272 | unsigned int num_gpl_future_syms; |
9f28bb7e | 273 | |
1da177e4 LT |
274 | /* Exception table */ |
275 | unsigned int num_exentries; | |
5e458cc0 | 276 | struct exception_table_entry *extable; |
1da177e4 LT |
277 | |
278 | /* Startup function. */ | |
279 | int (*init)(void); | |
280 | ||
93c2e105 PZ |
281 | /* |
282 | * If this is non-NULL, vfree() after init() returns. | |
283 | * | |
284 | * Cacheline align here, such that: | |
285 | * module_init, module_core, init_size, core_size, | |
6c9692e2 | 286 | * init_text_size, core_text_size and mtn_core::{mod,node[0]} |
93c2e105 PZ |
287 | * are on the same cacheline. |
288 | */ | |
289 | void *module_init ____cacheline_aligned; | |
1da177e4 LT |
290 | |
291 | /* Here is the actual code + data, vfree'd on unload. */ | |
292 | void *module_core; | |
293 | ||
294 | /* Here are the sizes of the init and core sections */ | |
2f0f2a33 | 295 | unsigned int init_size, core_size; |
1da177e4 LT |
296 | |
297 | /* The size of the executable code in each section. */ | |
2f0f2a33 | 298 | unsigned int init_text_size, core_text_size; |
1da177e4 | 299 | |
6c9692e2 | 300 | #ifdef CONFIG_MODULES_TREE_LOOKUP |
93c2e105 PZ |
301 | /* |
302 | * We want mtn_core::{mod,node[0]} to be in the same cacheline as the | |
303 | * above entries such that a regular lookup will only touch one | |
304 | * cacheline. | |
305 | */ | |
306 | struct mod_tree_node mtn_core; | |
307 | struct mod_tree_node mtn_init; | |
6c9692e2 | 308 | #endif |
93c2e105 | 309 | |
84e1c6bb | 310 | /* Size of RO sections of the module (text+rodata) */ |
311 | unsigned int init_ro_size, core_ro_size; | |
312 | ||
1da177e4 LT |
313 | /* Arch-specific module values */ |
314 | struct mod_arch_specific arch; | |
315 | ||
2bc2d61a RD |
316 | unsigned int taints; /* same bits as kernel:tainted */ |
317 | ||
7664c5a1 JF |
318 | #ifdef CONFIG_GENERIC_BUG |
319 | /* Support for BUG */ | |
af540689 | 320 | unsigned num_bugs; |
7664c5a1 JF |
321 | struct list_head bug_list; |
322 | struct bug_entry *bug_table; | |
1da177e4 LT |
323 | #endif |
324 | ||
325 | #ifdef CONFIG_KALLSYMS | |
4a496226 JB |
326 | /* |
327 | * We keep the symbol and string tables for kallsyms. | |
328 | * The core_* fields below are temporary, loader-only (they | |
329 | * could really be discarded after module init). | |
330 | */ | |
331 | Elf_Sym *symtab, *core_symtab; | |
332 | unsigned int num_symtab, core_num_syms; | |
554bdfe5 | 333 | char *strtab, *core_strtab; |
1da177e4 LT |
334 | |
335 | /* Section attributes */ | |
336 | struct module_sect_attrs *sect_attrs; | |
6d760133 RM |
337 | |
338 | /* Notes attributes */ | |
339 | struct module_notes_attrs *notes_attrs; | |
1da177e4 LT |
340 | #endif |
341 | ||
a288bd65 RK |
342 | /* The command line arguments (may be mangled). People like |
343 | keeping pointers to this stuff */ | |
344 | char *args; | |
345 | ||
259354de | 346 | #ifdef CONFIG_SMP |
1da177e4 | 347 | /* Per-cpu data. */ |
259354de TH |
348 | void __percpu *percpu; |
349 | unsigned int percpu_size; | |
350 | #endif | |
1da177e4 | 351 | |
97e1c18e | 352 | #ifdef CONFIG_TRACEPOINTS |
97e1c18e | 353 | unsigned int num_tracepoints; |
a288bd65 | 354 | struct tracepoint * const *tracepoints_ptrs; |
97e1c18e | 355 | #endif |
bf5438fc JB |
356 | #ifdef HAVE_JUMP_LABEL |
357 | struct jump_entry *jump_entries; | |
358 | unsigned int num_jump_entries; | |
359 | #endif | |
769b0441 | 360 | #ifdef CONFIG_TRACING |
1ba28e02 | 361 | unsigned int num_trace_bprintk_fmt; |
a288bd65 | 362 | const char **trace_bprintk_fmt_start; |
1ba28e02 | 363 | #endif |
6d723736 | 364 | #ifdef CONFIG_EVENT_TRACING |
e4a9ea5e | 365 | struct ftrace_event_call **trace_events; |
6d723736 | 366 | unsigned int num_trace_events; |
3673b8e4 SRRH |
367 | struct trace_enum_map **trace_enums; |
368 | unsigned int num_trace_enums; | |
6d723736 | 369 | #endif |
93eb677d | 370 | #ifdef CONFIG_FTRACE_MCOUNT_RECORD |
93eb677d | 371 | unsigned int num_ftrace_callsites; |
a288bd65 | 372 | unsigned long *ftrace_callsites; |
93eb677d | 373 | #endif |
1ba28e02 | 374 | |
8cb2c2dc PM |
375 | #ifdef CONFIG_LIVEPATCH |
376 | bool klp_alive; | |
377 | #endif | |
378 | ||
af540689 RK |
379 | #ifdef CONFIG_MODULE_UNLOAD |
380 | /* What modules depend on me? */ | |
2c02dfe7 LT |
381 | struct list_head source_list; |
382 | /* What modules do I depend on? */ | |
383 | struct list_head target_list; | |
af540689 | 384 | |
af540689 RK |
385 | /* Destruction function. */ |
386 | void (*exit)(void); | |
387 | ||
2f35c41f | 388 | atomic_t refcnt; |
af540689 | 389 | #endif |
b99b87f7 PO |
390 | |
391 | #ifdef CONFIG_CONSTRUCTORS | |
392 | /* Constructor functions. */ | |
393 | ctor_fn_t *ctors; | |
394 | unsigned int num_ctors; | |
395 | #endif | |
93c2e105 | 396 | } ____cacheline_aligned; |
e61a1c1c RZ |
397 | #ifndef MODULE_ARCH_INIT |
398 | #define MODULE_ARCH_INIT {} | |
399 | #endif | |
1da177e4 | 400 | |
c6b37801 TA |
401 | extern struct mutex module_mutex; |
402 | ||
1da177e4 LT |
403 | /* FIXME: It'd be nice to isolate modules during init, too, so they |
404 | aren't used before they (may) fail. But presently too much code | |
405 | (IDE & SCSI) require entry into the module during init.*/ | |
406 | static inline int module_is_live(struct module *mod) | |
407 | { | |
408 | return mod->state != MODULE_STATE_GOING; | |
409 | } | |
410 | ||
1da177e4 | 411 | struct module *__module_text_address(unsigned long addr); |
e610499e RR |
412 | struct module *__module_address(unsigned long addr); |
413 | bool is_module_address(unsigned long addr); | |
10fad5e4 | 414 | bool is_module_percpu_address(unsigned long addr); |
e610499e | 415 | bool is_module_text_address(unsigned long addr); |
1da177e4 | 416 | |
76681c8f PM |
417 | static inline bool within_module_core(unsigned long addr, |
418 | const struct module *mod) | |
a06f6211 MH |
419 | { |
420 | return (unsigned long)mod->module_core <= addr && | |
421 | addr < (unsigned long)mod->module_core + mod->core_size; | |
422 | } | |
423 | ||
76681c8f PM |
424 | static inline bool within_module_init(unsigned long addr, |
425 | const struct module *mod) | |
a06f6211 MH |
426 | { |
427 | return (unsigned long)mod->module_init <= addr && | |
428 | addr < (unsigned long)mod->module_init + mod->init_size; | |
429 | } | |
430 | ||
76681c8f | 431 | static inline bool within_module(unsigned long addr, const struct module *mod) |
9b20a352 PM |
432 | { |
433 | return within_module_init(addr, mod) || within_module_core(addr, mod); | |
434 | } | |
435 | ||
c6b37801 TA |
436 | /* Search for module by name: must hold module_mutex. */ |
437 | struct module *find_module(const char *name); | |
438 | ||
439 | struct symsearch { | |
440 | const struct kernel_symbol *start, *stop; | |
441 | const unsigned long *crcs; | |
442 | enum { | |
443 | NOT_GPL_ONLY, | |
444 | GPL_ONLY, | |
445 | WILL_BE_GPL_ONLY, | |
446 | } licence; | |
447 | bool unused; | |
448 | }; | |
449 | ||
0be964be PZ |
450 | /* |
451 | * Search for an exported symbol by name. | |
452 | * | |
453 | * Must be called with module_mutex held or preemption disabled. | |
454 | */ | |
c6b37801 TA |
455 | const struct kernel_symbol *find_symbol(const char *name, |
456 | struct module **owner, | |
457 | const unsigned long **crc, | |
458 | bool gplok, | |
459 | bool warn); | |
460 | ||
0be964be PZ |
461 | /* |
462 | * Walk the exported symbol table | |
463 | * | |
464 | * Must be called with module_mutex held or preemption disabled. | |
465 | */ | |
de4d8d53 RR |
466 | bool each_symbol_section(bool (*fn)(const struct symsearch *arr, |
467 | struct module *owner, | |
468 | void *data), void *data); | |
c6b37801 | 469 | |
ea07890a | 470 | /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if |
1da177e4 | 471 | symnum out of range. */ |
ea07890a AD |
472 | int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type, |
473 | char *name, char *module_name, int *exported); | |
1da177e4 LT |
474 | |
475 | /* Look for this name: can be of form module:name. */ | |
476 | unsigned long module_kallsyms_lookup_name(const char *name); | |
477 | ||
75a66614 AK |
478 | int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *, |
479 | struct module *, unsigned long), | |
480 | void *data); | |
481 | ||
1da177e4 LT |
482 | extern void __module_put_and_exit(struct module *mod, long code) |
483 | __attribute__((noreturn)); | |
74e22fac | 484 | #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code) |
1da177e4 LT |
485 | |
486 | #ifdef CONFIG_MODULE_UNLOAD | |
d5db139a | 487 | int module_refcount(struct module *mod); |
1da177e4 | 488 | void __symbol_put(const char *symbol); |
b92021b0 | 489 | #define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x)) |
1da177e4 LT |
490 | void symbol_put_addr(void *addr); |
491 | ||
492 | /* Sometimes we know we already have a refcount, and it's easier not | |
493 | to handle the error case (which only happens with rmmod --wait). */ | |
d53799be | 494 | extern void __module_get(struct module *module); |
e1783a24 | 495 | |
d53799be SR |
496 | /* This is the Right Way to get a module: if it fails, it's being removed, |
497 | * so pretend it's not there. */ | |
498 | extern bool try_module_get(struct module *module); | |
1da177e4 | 499 | |
f6a57033 | 500 | extern void module_put(struct module *module); |
1da177e4 LT |
501 | |
502 | #else /*!CONFIG_MODULE_UNLOAD*/ | |
503 | static inline int try_module_get(struct module *module) | |
504 | { | |
505 | return !module || module_is_live(module); | |
506 | } | |
507 | static inline void module_put(struct module *module) | |
508 | { | |
509 | } | |
510 | static inline void __module_get(struct module *module) | |
511 | { | |
512 | } | |
e865d06b SL |
513 | #define symbol_put(x) do { } while (0) |
514 | #define symbol_put_addr(p) do { } while (0) | |
1da177e4 LT |
515 | |
516 | #endif /* CONFIG_MODULE_UNLOAD */ | |
dfd62d1d | 517 | int ref_module(struct module *a, struct module *b); |
1da177e4 LT |
518 | |
519 | /* This is a #define so the string doesn't get put in every .o file */ | |
520 | #define module_name(mod) \ | |
521 | ({ \ | |
522 | struct module *__mod = (mod); \ | |
523 | __mod ? __mod->name : "kernel"; \ | |
524 | }) | |
525 | ||
6dd06c9f RR |
526 | /* For kallsyms to ask for address resolution. namebuf should be at |
527 | * least KSYM_NAME_LEN long: a pointer to namebuf is returned if | |
528 | * found, otherwise NULL. */ | |
92dfc9dc | 529 | const char *module_address_lookup(unsigned long addr, |
6dd06c9f RR |
530 | unsigned long *symbolsize, |
531 | unsigned long *offset, | |
532 | char **modname, | |
533 | char *namebuf); | |
9d65cb4a | 534 | int lookup_module_symbol_name(unsigned long addr, char *symname); |
a5c43dae | 535 | int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name); |
1da177e4 LT |
536 | |
537 | /* For extable.c to search modules' exception tables. */ | |
538 | const struct exception_table_entry *search_module_extables(unsigned long addr); | |
539 | ||
e865d06b SL |
540 | int register_module_notifier(struct notifier_block *nb); |
541 | int unregister_module_notifier(struct notifier_block *nb); | |
1da177e4 LT |
542 | |
543 | extern void print_modules(void); | |
544 | ||
1da177e4 | 545 | #else /* !CONFIG_MODULES... */ |
1da177e4 LT |
546 | |
547 | /* Given an address, look for it in the exception tables. */ | |
548 | static inline const struct exception_table_entry * | |
549 | search_module_extables(unsigned long addr) | |
550 | { | |
551 | return NULL; | |
552 | } | |
553 | ||
e610499e RR |
554 | static inline struct module *__module_address(unsigned long addr) |
555 | { | |
556 | return NULL; | |
557 | } | |
558 | ||
1da177e4 LT |
559 | static inline struct module *__module_text_address(unsigned long addr) |
560 | { | |
561 | return NULL; | |
562 | } | |
563 | ||
e610499e RR |
564 | static inline bool is_module_address(unsigned long addr) |
565 | { | |
566 | return false; | |
567 | } | |
568 | ||
d5e50daf RD |
569 | static inline bool is_module_percpu_address(unsigned long addr) |
570 | { | |
571 | return false; | |
572 | } | |
573 | ||
e610499e | 574 | static inline bool is_module_text_address(unsigned long addr) |
4d435f9d | 575 | { |
e610499e | 576 | return false; |
4d435f9d IM |
577 | } |
578 | ||
1da177e4 LT |
579 | /* Get/put a kernel symbol (calls should be symmetric) */ |
580 | #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); }) | |
e865d06b SL |
581 | #define symbol_put(x) do { } while (0) |
582 | #define symbol_put_addr(x) do { } while (0) | |
1da177e4 LT |
583 | |
584 | static inline void __module_get(struct module *module) | |
585 | { | |
586 | } | |
587 | ||
588 | static inline int try_module_get(struct module *module) | |
589 | { | |
590 | return 1; | |
591 | } | |
592 | ||
593 | static inline void module_put(struct module *module) | |
594 | { | |
595 | } | |
596 | ||
597 | #define module_name(mod) "kernel" | |
598 | ||
1da177e4 | 599 | /* For kallsyms to ask for address resolution. NULL means not found. */ |
92dfc9dc | 600 | static inline const char *module_address_lookup(unsigned long addr, |
6dd06c9f RR |
601 | unsigned long *symbolsize, |
602 | unsigned long *offset, | |
603 | char **modname, | |
604 | char *namebuf) | |
1da177e4 LT |
605 | { |
606 | return NULL; | |
607 | } | |
608 | ||
9d65cb4a AD |
609 | static inline int lookup_module_symbol_name(unsigned long addr, char *symname) |
610 | { | |
611 | return -ERANGE; | |
612 | } | |
613 | ||
a5c43dae AD |
614 | static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name) |
615 | { | |
616 | return -ERANGE; | |
617 | } | |
618 | ||
ea07890a AD |
619 | static inline int module_get_kallsym(unsigned int symnum, unsigned long *value, |
620 | char *type, char *name, | |
621 | char *module_name, int *exported) | |
1da177e4 | 622 | { |
ea07890a | 623 | return -ERANGE; |
1da177e4 LT |
624 | } |
625 | ||
626 | static inline unsigned long module_kallsyms_lookup_name(const char *name) | |
627 | { | |
628 | return 0; | |
629 | } | |
630 | ||
75a66614 AK |
631 | static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *, |
632 | struct module *, | |
633 | unsigned long), | |
634 | void *data) | |
635 | { | |
636 | return 0; | |
637 | } | |
638 | ||
e865d06b | 639 | static inline int register_module_notifier(struct notifier_block *nb) |
1da177e4 LT |
640 | { |
641 | /* no events will happen anyway, so this can always succeed */ | |
642 | return 0; | |
643 | } | |
644 | ||
e865d06b | 645 | static inline int unregister_module_notifier(struct notifier_block *nb) |
1da177e4 LT |
646 | { |
647 | return 0; | |
648 | } | |
649 | ||
650 | #define module_put_and_exit(code) do_exit(code) | |
651 | ||
652 | static inline void print_modules(void) | |
653 | { | |
654 | } | |
ef665c1a RD |
655 | #endif /* CONFIG_MODULES */ |
656 | ||
ef665c1a | 657 | #ifdef CONFIG_SYSFS |
7405c1e1 GKH |
658 | extern struct kset *module_kset; |
659 | extern struct kobj_type module_ktype; | |
660 | extern int module_sysfs_initialized; | |
ef665c1a RD |
661 | #endif /* CONFIG_SYSFS */ |
662 | ||
1da177e4 LT |
663 | #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x) |
664 | ||
665 | /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */ | |
666 | ||
1da177e4 LT |
667 | #define __MODULE_STRING(x) __stringify(x) |
668 | ||
84e1c6bb | 669 | #ifdef CONFIG_DEBUG_SET_MODULE_RONX |
670 | extern void set_all_modules_text_rw(void); | |
671 | extern void set_all_modules_text_ro(void); | |
672 | #else | |
673 | static inline void set_all_modules_text_rw(void) { } | |
674 | static inline void set_all_modules_text_ro(void) { } | |
675 | #endif | |
0d9c25dd AM |
676 | |
677 | #ifdef CONFIG_GENERIC_BUG | |
5336377d | 678 | void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *, |
0d9c25dd AM |
679 | struct module *); |
680 | void module_bug_cleanup(struct module *); | |
681 | ||
682 | #else /* !CONFIG_GENERIC_BUG */ | |
683 | ||
5336377d | 684 | static inline void module_bug_finalize(const Elf_Ehdr *hdr, |
0d9c25dd AM |
685 | const Elf_Shdr *sechdrs, |
686 | struct module *mod) | |
687 | { | |
0d9c25dd AM |
688 | } |
689 | static inline void module_bug_cleanup(struct module *mod) {} | |
690 | #endif /* CONFIG_GENERIC_BUG */ | |
691 | ||
1da177e4 | 692 | #endif /* _LINUX_MODULE_H */ |