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