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