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