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