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