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