1#ifndef _LINUX_MODULE_H
2#define _LINUX_MODULE_H
3
4
5
6
7
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/init.h>
15#include <linux/elf.h>
16#include <linux/stringify.h>
17#include <linux/kobject.h>
18#include <linux/moduleparam.h>
19#include <linux/jump_label.h>
20#include <linux/export.h>
21#include <linux/rbtree_latch.h>
22#include <linux/error-injection.h>
23#include <linux/tracepoint-defs.h>
24
25#include <linux/percpu.h>
26#include <asm/module.h>
27
28
29#define MODULE_SIG_STRING "~Module signature appended~\n"
30
31
32#define MODULE_SUPPORTED_DEVICE(name)
33
34#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
35
36struct modversion_info {
37 unsigned long crc;
38 char name[MODULE_NAME_LEN];
39};
40
41struct module;
42struct exception_table_entry;
43
44struct module_kobject {
45 struct kobject kobj;
46 struct module *mod;
47 struct kobject *drivers_dir;
48 struct module_param_attrs *mp;
49 struct completion *kobj_completion;
50} __randomize_layout;
51
52struct module_attribute {
53 struct attribute attr;
54 ssize_t (*show)(struct module_attribute *, struct module_kobject *,
55 char *);
56 ssize_t (*store)(struct module_attribute *, struct module_kobject *,
57 const char *, size_t count);
58 void (*setup)(struct module *, const char *);
59 int (*test)(struct module *);
60 void (*free)(struct module *);
61};
62
63struct module_version_attribute {
64 struct module_attribute mattr;
65 const char *module_name;
66 const char *version;
67} __attribute__ ((__aligned__(sizeof(void *))));
68
69extern ssize_t __modver_version_show(struct module_attribute *,
70 struct module_kobject *, char *);
71
72extern struct module_attribute module_uevent;
73
74
75extern int init_module(void);
76extern void cleanup_module(void);
77
78#ifndef MODULE
79
80
81
82
83
84
85
86
87#define module_init(x) __initcall(x);
88
89
90
91
92
93
94
95
96
97
98
99#define module_exit(x) __exitcall(x);
100
101#else
102
103
104
105
106
107
108
109
110#define early_initcall(fn) module_init(fn)
111#define core_initcall(fn) module_init(fn)
112#define core_initcall_sync(fn) module_init(fn)
113#define postcore_initcall(fn) module_init(fn)
114#define postcore_initcall_sync(fn) module_init(fn)
115#define arch_initcall(fn) module_init(fn)
116#define subsys_initcall(fn) module_init(fn)
117#define subsys_initcall_sync(fn) module_init(fn)
118#define fs_initcall(fn) module_init(fn)
119#define fs_initcall_sync(fn) module_init(fn)
120#define rootfs_initcall(fn) module_init(fn)
121#define device_initcall(fn) module_init(fn)
122#define device_initcall_sync(fn) module_init(fn)
123#define late_initcall(fn) module_init(fn)
124#define late_initcall_sync(fn) module_init(fn)
125
126#define console_initcall(fn) module_init(fn)
127#define security_initcall(fn) module_init(fn)
128
129
130#define module_init(initfn) \
131 static inline initcall_t __maybe_unused __inittest(void) \
132 { return initfn; } \
133 int init_module(void) __attribute__((alias(#initfn)));
134
135
136#define module_exit(exitfn) \
137 static inline exitcall_t __maybe_unused __exittest(void) \
138 { return exitfn; } \
139 void cleanup_module(void) __attribute__((alias(#exitfn)));
140
141#endif
142
143
144
145#ifdef CONFIG_MODULES
146#define __init_or_module
147#define __initdata_or_module
148#define __initconst_or_module
149#define __INIT_OR_MODULE .text
150#define __INITDATA_OR_MODULE .data
151#define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
152#else
153#define __init_or_module __init
154#define __initdata_or_module __initdata
155#define __initconst_or_module __initconst
156#define __INIT_OR_MODULE __INIT
157#define __INITDATA_OR_MODULE __INITDATA
158#define __INITRODATA_OR_MODULE __INITRODATA
159#endif
160
161
162#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
163
164
165#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
166
167
168
169
170#define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
201
202
203
204
205
206#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
207
208
209#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
210
211#ifdef MODULE
212
213#define MODULE_DEVICE_TABLE(type, name) \
214extern typeof(name) __mod_##type##__##name##_device_table \
215 __attribute__ ((unused, alias(__stringify(name))))
216#else
217#define MODULE_DEVICE_TABLE(type, name)
218#endif
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237#if defined(MODULE) || !defined(CONFIG_SYSFS)
238#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
239#else
240#define MODULE_VERSION(_version) \
241 static struct module_version_attribute ___modver_attr = { \
242 .mattr = { \
243 .attr = { \
244 .name = "version", \
245 .mode = S_IRUGO, \
246 }, \
247 .show = __modver_version_show, \
248 }, \
249 .module_name = KBUILD_MODNAME, \
250 .version = _version, \
251 }; \
252 static const struct module_version_attribute \
253 __used __attribute__ ((__section__ ("__modver"))) \
254 * __moduleparam_const __modver_attr = &___modver_attr
255#endif
256
257
258
259
260#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
261
262struct notifier_block;
263
264#ifdef CONFIG_MODULES
265
266extern int modules_disabled;
267
268void *__symbol_get(const char *symbol);
269void *__symbol_get_gpl(const char *symbol);
270#define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
271
272
273struct module_use {
274 struct list_head source_list;
275 struct list_head target_list;
276 struct module *source, *target;
277};
278
279enum module_state {
280 MODULE_STATE_LIVE,
281 MODULE_STATE_COMING,
282 MODULE_STATE_GOING,
283 MODULE_STATE_UNFORMED,
284};
285
286struct mod_tree_node {
287 struct module *mod;
288 struct latch_tree_node node;
289};
290
291struct module_layout {
292
293 void *base;
294
295 unsigned int size;
296
297 unsigned int text_size;
298
299 unsigned int ro_size;
300
301 unsigned int ro_after_init_size;
302
303#ifdef CONFIG_MODULES_TREE_LOOKUP
304 struct mod_tree_node mtn;
305#endif
306};
307
308#ifdef CONFIG_MODULES_TREE_LOOKUP
309
310#define __module_layout_align ____cacheline_aligned
311#else
312#define __module_layout_align
313#endif
314
315struct mod_kallsyms {
316 Elf_Sym *symtab;
317 unsigned int num_symtab;
318 char *strtab;
319};
320
321#ifdef CONFIG_LIVEPATCH
322struct klp_modinfo {
323 Elf_Ehdr hdr;
324 Elf_Shdr *sechdrs;
325 char *secstrings;
326 unsigned int symndx;
327};
328#endif
329
330struct module {
331 enum module_state state;
332
333
334 struct list_head list;
335
336
337 char name[MODULE_NAME_LEN];
338
339
340 struct module_kobject mkobj;
341 struct module_attribute *modinfo_attrs;
342 const char *version;
343 const char *srcversion;
344 struct kobject *holders_dir;
345
346
347 const struct kernel_symbol *syms;
348 const s32 *crcs;
349 unsigned int num_syms;
350
351
352#ifdef CONFIG_SYSFS
353 struct mutex param_lock;
354#endif
355 struct kernel_param *kp;
356 unsigned int num_kp;
357
358
359 unsigned int num_gpl_syms;
360 const struct kernel_symbol *gpl_syms;
361 const s32 *gpl_crcs;
362
363#ifdef CONFIG_UNUSED_SYMBOLS
364
365 const struct kernel_symbol *unused_syms;
366 const s32 *unused_crcs;
367 unsigned int num_unused_syms;
368
369
370 unsigned int num_unused_gpl_syms;
371 const struct kernel_symbol *unused_gpl_syms;
372 const s32 *unused_gpl_crcs;
373#endif
374
375#ifdef CONFIG_MODULE_SIG
376
377 bool sig_ok;
378#endif
379
380 bool async_probe_requested;
381
382
383 const struct kernel_symbol *gpl_future_syms;
384 const s32 *gpl_future_crcs;
385 unsigned int num_gpl_future_syms;
386
387
388 unsigned int num_exentries;
389 struct exception_table_entry *extable;
390
391
392 int (*init)(void);
393
394
395 struct module_layout core_layout __module_layout_align;
396 struct module_layout init_layout;
397
398
399 struct mod_arch_specific arch;
400
401 unsigned long taints;
402
403#ifdef CONFIG_GENERIC_BUG
404
405 unsigned num_bugs;
406 struct list_head bug_list;
407 struct bug_entry *bug_table;
408#endif
409
410#ifdef CONFIG_KALLSYMS
411
412 struct mod_kallsyms *kallsyms;
413 struct mod_kallsyms core_kallsyms;
414
415
416 struct module_sect_attrs *sect_attrs;
417
418
419 struct module_notes_attrs *notes_attrs;
420#endif
421
422
423
424 char *args;
425
426#ifdef CONFIG_SMP
427
428 void __percpu *percpu;
429 unsigned int percpu_size;
430#endif
431
432#ifdef CONFIG_TRACEPOINTS
433 unsigned int num_tracepoints;
434 tracepoint_ptr_t *tracepoints_ptrs;
435#endif
436#ifdef HAVE_JUMP_LABEL
437 struct jump_entry *jump_entries;
438 unsigned int num_jump_entries;
439#endif
440#ifdef CONFIG_TRACING
441 unsigned int num_trace_bprintk_fmt;
442 const char **trace_bprintk_fmt_start;
443#endif
444#ifdef CONFIG_EVENT_TRACING
445 struct trace_event_call **trace_events;
446 unsigned int num_trace_events;
447 struct trace_eval_map **trace_evals;
448 unsigned int num_trace_evals;
449#endif
450#ifdef CONFIG_FTRACE_MCOUNT_RECORD
451 unsigned int num_ftrace_callsites;
452 unsigned long *ftrace_callsites;
453#endif
454
455#ifdef CONFIG_LIVEPATCH
456 bool klp;
457 bool klp_alive;
458
459
460 struct klp_modinfo *klp_info;
461#endif
462
463#ifdef CONFIG_MODULE_UNLOAD
464
465 struct list_head source_list;
466
467 struct list_head target_list;
468
469
470 void (*exit)(void);
471
472 atomic_t refcnt;
473#endif
474
475#ifdef CONFIG_CONSTRUCTORS
476
477 ctor_fn_t *ctors;
478 unsigned int num_ctors;
479#endif
480
481#ifdef CONFIG_FUNCTION_ERROR_INJECTION
482 struct error_injection_entry *ei_funcs;
483 unsigned int num_ei_funcs;
484#endif
485} ____cacheline_aligned __randomize_layout;
486#ifndef MODULE_ARCH_INIT
487#define MODULE_ARCH_INIT {}
488#endif
489
490extern struct mutex module_mutex;
491
492
493
494
495static inline bool module_is_live(struct module *mod)
496{
497 return mod->state != MODULE_STATE_GOING;
498}
499
500struct module *__module_text_address(unsigned long addr);
501struct module *__module_address(unsigned long addr);
502bool is_module_address(unsigned long addr);
503bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
504bool is_module_percpu_address(unsigned long addr);
505bool is_module_text_address(unsigned long addr);
506
507static inline bool within_module_core(unsigned long addr,
508 const struct module *mod)
509{
510 return (unsigned long)mod->core_layout.base <= addr &&
511 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
512}
513
514static inline bool within_module_init(unsigned long addr,
515 const struct module *mod)
516{
517 return (unsigned long)mod->init_layout.base <= addr &&
518 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
519}
520
521static inline bool within_module(unsigned long addr, const struct module *mod)
522{
523 return within_module_init(addr, mod) || within_module_core(addr, mod);
524}
525
526
527struct module *find_module(const char *name);
528
529struct symsearch {
530 const struct kernel_symbol *start, *stop;
531 const s32 *crcs;
532 enum {
533 NOT_GPL_ONLY,
534 GPL_ONLY,
535 WILL_BE_GPL_ONLY,
536 } licence;
537 bool unused;
538};
539
540
541
542
543
544
545const struct kernel_symbol *find_symbol(const char *name,
546 struct module **owner,
547 const s32 **crc,
548 bool gplok,
549 bool warn);
550
551
552
553
554
555
556bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
557 struct module *owner,
558 void *data), void *data);
559
560
561
562int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
563 char *name, char *module_name, int *exported);
564
565
566unsigned long module_kallsyms_lookup_name(const char *name);
567
568int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
569 struct module *, unsigned long),
570 void *data);
571
572extern void __noreturn __module_put_and_exit(struct module *mod,
573 long code);
574#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
575
576#ifdef CONFIG_MODULE_UNLOAD
577int module_refcount(struct module *mod);
578void __symbol_put(const char *symbol);
579#define symbol_put(x) __symbol_put(__stringify(x))
580void symbol_put_addr(void *addr);
581
582
583
584extern void __module_get(struct module *module);
585
586
587
588extern bool try_module_get(struct module *module);
589
590extern void module_put(struct module *module);
591
592#else
593static inline bool try_module_get(struct module *module)
594{
595 return !module || module_is_live(module);
596}
597static inline void module_put(struct module *module)
598{
599}
600static inline void __module_get(struct module *module)
601{
602}
603#define symbol_put(x) do { } while (0)
604#define symbol_put_addr(p) do { } while (0)
605
606#endif
607int ref_module(struct module *a, struct module *b);
608
609
610#define module_name(mod) \
611({ \
612 struct module *__mod = (mod); \
613 __mod ? __mod->name : "kernel"; \
614})
615
616
617void *dereference_module_function_descriptor(struct module *mod, void *ptr);
618
619
620
621
622const char *module_address_lookup(unsigned long addr,
623 unsigned long *symbolsize,
624 unsigned long *offset,
625 char **modname,
626 char *namebuf);
627int lookup_module_symbol_name(unsigned long addr, char *symname);
628int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
629
630int register_module_notifier(struct notifier_block *nb);
631int unregister_module_notifier(struct notifier_block *nb);
632
633extern void print_modules(void);
634
635static inline bool module_requested_async_probing(struct module *module)
636{
637 return module && module->async_probe_requested;
638}
639
640#ifdef CONFIG_LIVEPATCH
641static inline bool is_livepatch_module(struct module *mod)
642{
643 return mod->klp;
644}
645#else
646static inline bool is_livepatch_module(struct module *mod)
647{
648 return false;
649}
650#endif
651
652bool is_module_sig_enforced(void);
653
654#else
655
656static inline struct module *__module_address(unsigned long addr)
657{
658 return NULL;
659}
660
661static inline struct module *__module_text_address(unsigned long addr)
662{
663 return NULL;
664}
665
666static inline bool is_module_address(unsigned long addr)
667{
668 return false;
669}
670
671static inline bool is_module_percpu_address(unsigned long addr)
672{
673 return false;
674}
675
676static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
677{
678 return false;
679}
680
681static inline bool is_module_text_address(unsigned long addr)
682{
683 return false;
684}
685
686
687#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
688#define symbol_put(x) do { } while (0)
689#define symbol_put_addr(x) do { } while (0)
690
691static inline void __module_get(struct module *module)
692{
693}
694
695static inline bool try_module_get(struct module *module)
696{
697 return true;
698}
699
700static inline void module_put(struct module *module)
701{
702}
703
704#define module_name(mod) "kernel"
705
706
707static inline const char *module_address_lookup(unsigned long addr,
708 unsigned long *symbolsize,
709 unsigned long *offset,
710 char **modname,
711 char *namebuf)
712{
713 return NULL;
714}
715
716static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
717{
718 return -ERANGE;
719}
720
721static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
722{
723 return -ERANGE;
724}
725
726static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
727 char *type, char *name,
728 char *module_name, int *exported)
729{
730 return -ERANGE;
731}
732
733static inline unsigned long module_kallsyms_lookup_name(const char *name)
734{
735 return 0;
736}
737
738static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
739 struct module *,
740 unsigned long),
741 void *data)
742{
743 return 0;
744}
745
746static inline int register_module_notifier(struct notifier_block *nb)
747{
748
749 return 0;
750}
751
752static inline int unregister_module_notifier(struct notifier_block *nb)
753{
754 return 0;
755}
756
757#define module_put_and_exit(code) do_exit(code)
758
759static inline void print_modules(void)
760{
761}
762
763static inline bool module_requested_async_probing(struct module *module)
764{
765 return false;
766}
767
768static inline bool is_module_sig_enforced(void)
769{
770 return false;
771}
772
773
774static inline
775void *dereference_module_function_descriptor(struct module *mod, void *ptr)
776{
777 return ptr;
778}
779
780#endif
781
782#ifdef CONFIG_SYSFS
783extern struct kset *module_kset;
784extern struct kobj_type module_ktype;
785extern int module_sysfs_initialized;
786#endif
787
788#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
789
790
791
792#define __MODULE_STRING(x) __stringify(x)
793
794#ifdef CONFIG_STRICT_MODULE_RWX
795extern void set_all_modules_text_rw(void);
796extern void set_all_modules_text_ro(void);
797extern void module_enable_ro(const struct module *mod, bool after_init);
798extern void module_disable_ro(const struct module *mod);
799#else
800static inline void set_all_modules_text_rw(void) { }
801static inline void set_all_modules_text_ro(void) { }
802static inline void module_enable_ro(const struct module *mod, bool after_init) { }
803static inline void module_disable_ro(const struct module *mod) { }
804#endif
805
806#ifdef CONFIG_GENERIC_BUG
807void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
808 struct module *);
809void module_bug_cleanup(struct module *);
810
811#else
812
813static inline void module_bug_finalize(const Elf_Ehdr *hdr,
814 const Elf_Shdr *sechdrs,
815 struct module *mod)
816{
817}
818static inline void module_bug_cleanup(struct module *mod) {}
819#endif
820
821#ifdef RETPOLINE
822extern bool retpoline_module_ok(bool has_retpoline);
823#else
824static inline bool retpoline_module_ok(bool has_retpoline)
825{
826 return true;
827}
828#endif
829
830#ifdef CONFIG_MODULE_SIG
831static inline bool module_sig_ok(struct module *module)
832{
833 return module->sig_ok;
834}
835#else
836static inline bool module_sig_ok(struct module *module)
837{
838 return true;
839}
840#endif
841
842#endif
843