]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/linux/module.h
4c1b02e1361d625fcaaf772f05c8e9db398ab810
[mirror_ubuntu-bionic-kernel.git] / include / linux / module.h
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 */
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>
18 #include <linux/jump_label.h>
19 #include <linux/export.h>
20 #include <linux/rbtree_latch.h>
21
22 #include <linux/percpu.h>
23 #include <asm/module.h>
24
25 /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
26 #define MODULE_SIG_STRING "~Module signature appended~\n"
27
28 /* Not Yet Implemented */
29 #define MODULE_SUPPORTED_DEVICE(name)
30
31 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
32
33 struct modversion_info {
34 unsigned long crc;
35 char name[MODULE_NAME_LEN];
36 };
37
38 struct module;
39
40 struct module_kobject {
41 struct kobject kobj;
42 struct module *mod;
43 struct kobject *drivers_dir;
44 struct module_param_attrs *mp;
45 struct completion *kobj_completion;
46 };
47
48 struct module_attribute {
49 struct attribute attr;
50 ssize_t (*show)(struct module_attribute *, struct module_kobject *,
51 char *);
52 ssize_t (*store)(struct module_attribute *, struct module_kobject *,
53 const char *, size_t count);
54 void (*setup)(struct module *, const char *);
55 int (*test)(struct module *);
56 void (*free)(struct module *);
57 };
58
59 struct module_version_attribute {
60 struct module_attribute mattr;
61 const char *module_name;
62 const char *version;
63 } __attribute__ ((__aligned__(sizeof(void *))));
64
65 extern ssize_t __modver_version_show(struct module_attribute *,
66 struct module_kobject *, char *);
67
68 extern struct module_attribute module_uevent;
69
70 /* These are either module local, or the kernel's dummy ones. */
71 extern int init_module(void);
72 extern void cleanup_module(void);
73
74 /* Archs provide a method of finding the correct exception table. */
75 struct exception_table_entry;
76
77 const struct exception_table_entry *
78 search_extable(const struct exception_table_entry *first,
79 const struct exception_table_entry *last,
80 unsigned long value);
81 void sort_extable(struct exception_table_entry *start,
82 struct exception_table_entry *finish);
83 void sort_main_extable(void);
84 void trim_init_extable(struct module *m);
85
86 /* Generic info of form tag = "info" */
87 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
88
89 /* For userspace: you can also call me... */
90 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
91
92 /* Soft module dependencies. See man modprobe.d for details.
93 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
94 */
95 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
96
97 /*
98 * The following license idents are currently accepted as indicating free
99 * software modules
100 *
101 * "GPL" [GNU Public License v2 or later]
102 * "GPL v2" [GNU Public License v2]
103 * "GPL and additional rights" [GNU Public License v2 rights and more]
104 * "Dual BSD/GPL" [GNU Public License v2
105 * or BSD license choice]
106 * "Dual MIT/GPL" [GNU Public License v2
107 * or MIT license choice]
108 * "Dual MPL/GPL" [GNU Public License v2
109 * or Mozilla license choice]
110 *
111 * The following other idents are available
112 *
113 * "Proprietary" [Non free products]
114 *
115 * There are dual licensed components, but when running with Linux it is the
116 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
117 * is a GPL combined work.
118 *
119 * This exists for several reasons
120 * 1. So modinfo can show license info for users wanting to vet their setup
121 * is free
122 * 2. So the community can ignore bug reports including proprietary modules
123 * 3. So vendors can do likewise based on their own policies
124 */
125 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
126
127 /*
128 * Author(s), use "Name <email>" or just "Name", for multiple
129 * authors use multiple MODULE_AUTHOR() statements/lines.
130 */
131 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
132
133 /* What your module does. */
134 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
135
136 #ifdef MODULE
137 /* Creates an alias so file2alias.c can find device table. */
138 #define MODULE_DEVICE_TABLE(type, name) \
139 extern const typeof(name) __mod_##type##__##name##_device_table \
140 __attribute__ ((unused, alias(__stringify(name))))
141 #else /* !MODULE */
142 #define MODULE_DEVICE_TABLE(type, name)
143 #endif
144
145 /* Version of form [<epoch>:]<version>[-<extra-version>].
146 * Or for CVS/RCS ID version, everything but the number is stripped.
147 * <epoch>: A (small) unsigned integer which allows you to start versions
148 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
149 * "1:2.0".
150
151 * <version>: The <version> may contain only alphanumerics and the
152 * character `.'. Ordered by numeric sort for numeric parts,
153 * ascii sort for ascii parts (as per RPM or DEB algorithm).
154
155 * <extraversion>: Like <version>, but inserted for local
156 * customizations, eg "rh3" or "rusty1".
157
158 * Using this automatically adds a checksum of the .c files and the
159 * local headers in "srcversion".
160 */
161
162 #if defined(MODULE) || !defined(CONFIG_SYSFS)
163 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
164 #else
165 #define MODULE_VERSION(_version) \
166 static struct module_version_attribute ___modver_attr = { \
167 .mattr = { \
168 .attr = { \
169 .name = "version", \
170 .mode = S_IRUGO, \
171 }, \
172 .show = __modver_version_show, \
173 }, \
174 .module_name = KBUILD_MODNAME, \
175 .version = _version, \
176 }; \
177 static const struct module_version_attribute \
178 __used __attribute__ ((__section__ ("__modver"))) \
179 * __moduleparam_const __modver_attr = &___modver_attr
180 #endif
181
182 /* Optional firmware file (or files) needed by the module
183 * format is simply firmware file name. Multiple firmware
184 * files require multiple MODULE_FIRMWARE() specifiers */
185 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
186
187 /* Given an address, look for it in the exception tables */
188 const struct exception_table_entry *search_exception_tables(unsigned long add);
189
190 struct notifier_block;
191
192 #ifdef CONFIG_MODULES
193
194 extern int modules_disabled; /* for sysctl */
195 /* Get/put a kernel symbol (calls must be symmetric) */
196 void *__symbol_get(const char *symbol);
197 void *__symbol_get_gpl(const char *symbol);
198 #define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
199
200 /* modules using other modules: kdb wants to see this. */
201 struct module_use {
202 struct list_head source_list;
203 struct list_head target_list;
204 struct module *source, *target;
205 };
206
207 enum module_state {
208 MODULE_STATE_LIVE, /* Normal state. */
209 MODULE_STATE_COMING, /* Full formed, running module_init. */
210 MODULE_STATE_GOING, /* Going away. */
211 MODULE_STATE_UNFORMED, /* Still setting it up. */
212 };
213
214 struct module;
215
216 struct mod_tree_node {
217 struct module *mod;
218 struct latch_tree_node node;
219 };
220
221 struct module {
222 enum module_state state;
223
224 /* Member of list of modules */
225 struct list_head list;
226
227 /* Unique handle for this module */
228 char name[MODULE_NAME_LEN];
229
230 /* Sysfs stuff. */
231 struct module_kobject mkobj;
232 struct module_attribute *modinfo_attrs;
233 const char *version;
234 const char *srcversion;
235 struct kobject *holders_dir;
236
237 /* Exported symbols */
238 const struct kernel_symbol *syms;
239 const unsigned long *crcs;
240 unsigned int num_syms;
241
242 /* Kernel parameters. */
243 struct kernel_param *kp;
244 unsigned int num_kp;
245
246 /* GPL-only exported symbols. */
247 unsigned int num_gpl_syms;
248 const struct kernel_symbol *gpl_syms;
249 const unsigned long *gpl_crcs;
250
251 #ifdef CONFIG_UNUSED_SYMBOLS
252 /* unused exported symbols. */
253 const struct kernel_symbol *unused_syms;
254 const unsigned long *unused_crcs;
255 unsigned int num_unused_syms;
256
257 /* GPL-only, unused exported symbols. */
258 unsigned int num_unused_gpl_syms;
259 const struct kernel_symbol *unused_gpl_syms;
260 const unsigned long *unused_gpl_crcs;
261 #endif
262
263 #ifdef CONFIG_MODULE_SIG
264 /* Signature was verified. */
265 bool sig_ok;
266 #endif
267
268 /* symbols that will be GPL-only in the near future. */
269 const struct kernel_symbol *gpl_future_syms;
270 const unsigned long *gpl_future_crcs;
271 unsigned int num_gpl_future_syms;
272
273 /* Exception table */
274 unsigned int num_exentries;
275 struct exception_table_entry *extable;
276
277 /* Startup function. */
278 int (*init)(void);
279
280 /*
281 * If this is non-NULL, vfree() after init() returns.
282 *
283 * Cacheline align here, such that:
284 * module_init, module_core, init_size, core_size,
285 * init_text_size, core_text_size and mtn_core::{mod,node[0]}
286 * are on the same cacheline.
287 */
288 void *module_init ____cacheline_aligned;
289
290 /* Here is the actual code + data, vfree'd on unload. */
291 void *module_core;
292
293 /* Here are the sizes of the init and core sections */
294 unsigned int init_size, core_size;
295
296 /* The size of the executable code in each section. */
297 unsigned int init_text_size, core_text_size;
298
299 #ifdef CONFIG_MODULES_TREE_LOOKUP
300 /*
301 * We want mtn_core::{mod,node[0]} to be in the same cacheline as the
302 * above entries such that a regular lookup will only touch one
303 * cacheline.
304 */
305 struct mod_tree_node mtn_core;
306 struct mod_tree_node mtn_init;
307 #endif
308
309 /* Size of RO sections of the module (text+rodata) */
310 unsigned int init_ro_size, core_ro_size;
311
312 /* Arch-specific module values */
313 struct mod_arch_specific arch;
314
315 unsigned int taints; /* same bits as kernel:tainted */
316
317 #ifdef CONFIG_GENERIC_BUG
318 /* Support for BUG */
319 unsigned num_bugs;
320 struct list_head bug_list;
321 struct bug_entry *bug_table;
322 #endif
323
324 #ifdef CONFIG_KALLSYMS
325 /*
326 * We keep the symbol and string tables for kallsyms.
327 * The core_* fields below are temporary, loader-only (they
328 * could really be discarded after module init).
329 */
330 Elf_Sym *symtab, *core_symtab;
331 unsigned int num_symtab, core_num_syms;
332 char *strtab, *core_strtab;
333
334 /* Section attributes */
335 struct module_sect_attrs *sect_attrs;
336
337 /* Notes attributes */
338 struct module_notes_attrs *notes_attrs;
339 #endif
340
341 /* The command line arguments (may be mangled). People like
342 keeping pointers to this stuff */
343 char *args;
344
345 #ifdef CONFIG_SMP
346 /* Per-cpu data. */
347 void __percpu *percpu;
348 unsigned int percpu_size;
349 #endif
350
351 #ifdef CONFIG_TRACEPOINTS
352 unsigned int num_tracepoints;
353 struct tracepoint * const *tracepoints_ptrs;
354 #endif
355 #ifdef HAVE_JUMP_LABEL
356 struct jump_entry *jump_entries;
357 unsigned int num_jump_entries;
358 #endif
359 #ifdef CONFIG_TRACING
360 unsigned int num_trace_bprintk_fmt;
361 const char **trace_bprintk_fmt_start;
362 #endif
363 #ifdef CONFIG_EVENT_TRACING
364 struct ftrace_event_call **trace_events;
365 unsigned int num_trace_events;
366 struct trace_enum_map **trace_enums;
367 unsigned int num_trace_enums;
368 #endif
369 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
370 unsigned int num_ftrace_callsites;
371 unsigned long *ftrace_callsites;
372 #endif
373
374 #ifdef CONFIG_LIVEPATCH
375 bool klp_alive;
376 #endif
377
378 #ifdef CONFIG_MODULE_UNLOAD
379 /* What modules depend on me? */
380 struct list_head source_list;
381 /* What modules do I depend on? */
382 struct list_head target_list;
383
384 /* Destruction function. */
385 void (*exit)(void);
386
387 atomic_t refcnt;
388 #endif
389
390 #ifdef CONFIG_CONSTRUCTORS
391 /* Constructor functions. */
392 ctor_fn_t *ctors;
393 unsigned int num_ctors;
394 #endif
395 } ____cacheline_aligned;
396 #ifndef MODULE_ARCH_INIT
397 #define MODULE_ARCH_INIT {}
398 #endif
399
400 extern struct mutex module_mutex;
401
402 /* FIXME: It'd be nice to isolate modules during init, too, so they
403 aren't used before they (may) fail. But presently too much code
404 (IDE & SCSI) require entry into the module during init.*/
405 static inline int module_is_live(struct module *mod)
406 {
407 return mod->state != MODULE_STATE_GOING;
408 }
409
410 struct module *__module_text_address(unsigned long addr);
411 struct module *__module_address(unsigned long addr);
412 bool is_module_address(unsigned long addr);
413 bool is_module_percpu_address(unsigned long addr);
414 bool is_module_text_address(unsigned long addr);
415
416 static inline bool within_module_core(unsigned long addr,
417 const struct module *mod)
418 {
419 return (unsigned long)mod->module_core <= addr &&
420 addr < (unsigned long)mod->module_core + mod->core_size;
421 }
422
423 static inline bool within_module_init(unsigned long addr,
424 const struct module *mod)
425 {
426 return (unsigned long)mod->module_init <= addr &&
427 addr < (unsigned long)mod->module_init + mod->init_size;
428 }
429
430 static inline bool within_module(unsigned long addr, const struct module *mod)
431 {
432 return within_module_init(addr, mod) || within_module_core(addr, mod);
433 }
434
435 /* Search for module by name: must hold module_mutex. */
436 struct module *find_module(const char *name);
437
438 struct symsearch {
439 const struct kernel_symbol *start, *stop;
440 const unsigned long *crcs;
441 enum {
442 NOT_GPL_ONLY,
443 GPL_ONLY,
444 WILL_BE_GPL_ONLY,
445 } licence;
446 bool unused;
447 };
448
449 /*
450 * Search for an exported symbol by name.
451 *
452 * Must be called with module_mutex held or preemption disabled.
453 */
454 const struct kernel_symbol *find_symbol(const char *name,
455 struct module **owner,
456 const unsigned long **crc,
457 bool gplok,
458 bool warn);
459
460 /*
461 * Walk the exported symbol table
462 *
463 * Must be called with module_mutex held or preemption disabled.
464 */
465 bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
466 struct module *owner,
467 void *data), void *data);
468
469 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
470 symnum out of range. */
471 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
472 char *name, char *module_name, int *exported);
473
474 /* Look for this name: can be of form module:name. */
475 unsigned long module_kallsyms_lookup_name(const char *name);
476
477 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
478 struct module *, unsigned long),
479 void *data);
480
481 extern void __module_put_and_exit(struct module *mod, long code)
482 __attribute__((noreturn));
483 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
484
485 #ifdef CONFIG_MODULE_UNLOAD
486 int module_refcount(struct module *mod);
487 void __symbol_put(const char *symbol);
488 #define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
489 void symbol_put_addr(void *addr);
490
491 /* Sometimes we know we already have a refcount, and it's easier not
492 to handle the error case (which only happens with rmmod --wait). */
493 extern void __module_get(struct module *module);
494
495 /* This is the Right Way to get a module: if it fails, it's being removed,
496 * so pretend it's not there. */
497 extern bool try_module_get(struct module *module);
498
499 extern void module_put(struct module *module);
500
501 #else /*!CONFIG_MODULE_UNLOAD*/
502 static inline int try_module_get(struct module *module)
503 {
504 return !module || module_is_live(module);
505 }
506 static inline void module_put(struct module *module)
507 {
508 }
509 static inline void __module_get(struct module *module)
510 {
511 }
512 #define symbol_put(x) do { } while (0)
513 #define symbol_put_addr(p) do { } while (0)
514
515 #endif /* CONFIG_MODULE_UNLOAD */
516 int ref_module(struct module *a, struct module *b);
517
518 /* This is a #define so the string doesn't get put in every .o file */
519 #define module_name(mod) \
520 ({ \
521 struct module *__mod = (mod); \
522 __mod ? __mod->name : "kernel"; \
523 })
524
525 /* For kallsyms to ask for address resolution. namebuf should be at
526 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
527 * found, otherwise NULL. */
528 const char *module_address_lookup(unsigned long addr,
529 unsigned long *symbolsize,
530 unsigned long *offset,
531 char **modname,
532 char *namebuf);
533 int lookup_module_symbol_name(unsigned long addr, char *symname);
534 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
535
536 /* For extable.c to search modules' exception tables. */
537 const struct exception_table_entry *search_module_extables(unsigned long addr);
538
539 int register_module_notifier(struct notifier_block *nb);
540 int unregister_module_notifier(struct notifier_block *nb);
541
542 extern void print_modules(void);
543
544 #else /* !CONFIG_MODULES... */
545
546 /* Given an address, look for it in the exception tables. */
547 static inline const struct exception_table_entry *
548 search_module_extables(unsigned long addr)
549 {
550 return NULL;
551 }
552
553 static inline struct module *__module_address(unsigned long addr)
554 {
555 return NULL;
556 }
557
558 static inline struct module *__module_text_address(unsigned long addr)
559 {
560 return NULL;
561 }
562
563 static inline bool is_module_address(unsigned long addr)
564 {
565 return false;
566 }
567
568 static inline bool is_module_percpu_address(unsigned long addr)
569 {
570 return false;
571 }
572
573 static inline bool is_module_text_address(unsigned long addr)
574 {
575 return false;
576 }
577
578 /* Get/put a kernel symbol (calls should be symmetric) */
579 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
580 #define symbol_put(x) do { } while (0)
581 #define symbol_put_addr(x) do { } while (0)
582
583 static inline void __module_get(struct module *module)
584 {
585 }
586
587 static inline int try_module_get(struct module *module)
588 {
589 return 1;
590 }
591
592 static inline void module_put(struct module *module)
593 {
594 }
595
596 #define module_name(mod) "kernel"
597
598 /* For kallsyms to ask for address resolution. NULL means not found. */
599 static inline const char *module_address_lookup(unsigned long addr,
600 unsigned long *symbolsize,
601 unsigned long *offset,
602 char **modname,
603 char *namebuf)
604 {
605 return NULL;
606 }
607
608 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
609 {
610 return -ERANGE;
611 }
612
613 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
614 {
615 return -ERANGE;
616 }
617
618 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
619 char *type, char *name,
620 char *module_name, int *exported)
621 {
622 return -ERANGE;
623 }
624
625 static inline unsigned long module_kallsyms_lookup_name(const char *name)
626 {
627 return 0;
628 }
629
630 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
631 struct module *,
632 unsigned long),
633 void *data)
634 {
635 return 0;
636 }
637
638 static inline int register_module_notifier(struct notifier_block *nb)
639 {
640 /* no events will happen anyway, so this can always succeed */
641 return 0;
642 }
643
644 static inline int unregister_module_notifier(struct notifier_block *nb)
645 {
646 return 0;
647 }
648
649 #define module_put_and_exit(code) do_exit(code)
650
651 static inline void print_modules(void)
652 {
653 }
654 #endif /* CONFIG_MODULES */
655
656 #ifdef CONFIG_SYSFS
657 extern struct kset *module_kset;
658 extern struct kobj_type module_ktype;
659 extern int module_sysfs_initialized;
660 #endif /* CONFIG_SYSFS */
661
662 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
663
664 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
665
666 #define __MODULE_STRING(x) __stringify(x)
667
668 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
669 extern void set_all_modules_text_rw(void);
670 extern void set_all_modules_text_ro(void);
671 #else
672 static inline void set_all_modules_text_rw(void) { }
673 static inline void set_all_modules_text_ro(void) { }
674 #endif
675
676 #ifdef CONFIG_GENERIC_BUG
677 void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
678 struct module *);
679 void module_bug_cleanup(struct module *);
680
681 #else /* !CONFIG_GENERIC_BUG */
682
683 static inline void module_bug_finalize(const Elf_Ehdr *hdr,
684 const Elf_Shdr *sechdrs,
685 struct module *mod)
686 {
687 }
688 static inline void module_bug_cleanup(struct module *mod) {}
689 #endif /* CONFIG_GENERIC_BUG */
690
691 #endif /* _LINUX_MODULE_H */