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