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/elf.h>
15#include <linux/stringify.h>
16#include <linux/kobject.h>
17#include <linux/moduleparam.h>
18#include <linux/tracepoint.h>
19#include <linux/export.h>
20
21#include <linux/percpu.h>
22#include <asm/module.h>
23
24
25#define MODULE_SIG_STRING "~Module signature appended~\n"
26
27
28#define MODULE_SUPPORTED_DEVICE(name)
29
30#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
31
32struct modversion_info
33{
34 unsigned long crc;
35 char name[MODULE_NAME_LEN];
36};
37
38struct module;
39
40struct 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
48struct 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
59struct module_version_attribute {
60 struct module_attribute mattr;
61 const char *module_name;
62 const char *version;
63} __attribute__ ((__aligned__(sizeof(void *))));
64
65extern ssize_t __modver_version_show(struct module_attribute *,
66 struct module_kobject *, char *);
67
68extern struct module_attribute module_uevent;
69
70
71extern int init_module(void);
72extern void cleanup_module(void);
73
74
75struct exception_table_entry;
76
77const struct exception_table_entry *
78search_extable(const struct exception_table_entry *first,
79 const struct exception_table_entry *last,
80 unsigned long value);
81void sort_extable(struct exception_table_entry *start,
82 struct exception_table_entry *finish);
83void sort_main_extable(void);
84void trim_init_extable(struct module *m);
85
86#ifdef MODULE
87#define MODULE_GENERIC_TABLE(gtype,name) \
88extern const struct gtype##_id __mod_##gtype##_table \
89 __attribute__ ((unused, alias(__stringify(name))))
90
91#else
92#define MODULE_GENERIC_TABLE(gtype,name)
93#endif
94
95
96#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
97
98
99#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
100
101
102
103
104#define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
135
136
137
138
139
140#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
141
142
143#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
144
145#define MODULE_DEVICE_TABLE(type,name) \
146 MODULE_GENERIC_TABLE(type##_device,name)
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163#if defined(MODULE) || !defined(CONFIG_SYSFS)
164#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
165#else
166#define MODULE_VERSION(_version) \
167 static struct module_version_attribute ___modver_attr = { \
168 .mattr = { \
169 .attr = { \
170 .name = "version", \
171 .mode = S_IRUGO, \
172 }, \
173 .show = __modver_version_show, \
174 }, \
175 .module_name = KBUILD_MODNAME, \
176 .version = _version, \
177 }; \
178 static const struct module_version_attribute \
179 __used __attribute__ ((__section__ ("__modver"))) \
180 * __moduleparam_const __modver_attr = &___modver_attr
181#endif
182
183
184
185
186#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
187
188
189const struct exception_table_entry *search_exception_tables(unsigned long add);
190
191struct notifier_block;
192
193#ifdef CONFIG_MODULES
194
195extern int modules_disabled;
196
197void *__symbol_get(const char *symbol);
198void *__symbol_get_gpl(const char *symbol);
199#define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
200
201
202struct module_use {
203 struct list_head source_list;
204 struct list_head target_list;
205 struct module *source, *target;
206};
207
208enum module_state {
209 MODULE_STATE_LIVE,
210 MODULE_STATE_COMING,
211 MODULE_STATE_GOING,
212 MODULE_STATE_UNFORMED,
213};
214
215
216
217
218
219
220
221
222
223
224struct module_ref {
225 unsigned long incs;
226 unsigned long decs;
227} __attribute((aligned(2 * sizeof(unsigned long))));
228
229struct module
230{
231 enum module_state state;
232
233
234 struct list_head list;
235
236
237 char name[MODULE_NAME_LEN];
238
239
240 struct module_kobject mkobj;
241 struct module_attribute *modinfo_attrs;
242 const char *version;
243 const char *srcversion;
244 struct kobject *holders_dir;
245
246
247 const struct kernel_symbol *syms;
248 const unsigned long *crcs;
249 unsigned int num_syms;
250
251
252 struct kernel_param *kp;
253 unsigned int num_kp;
254
255
256 unsigned int num_gpl_syms;
257 const struct kernel_symbol *gpl_syms;
258 const unsigned long *gpl_crcs;
259
260#ifdef CONFIG_UNUSED_SYMBOLS
261
262 const struct kernel_symbol *unused_syms;
263 const unsigned long *unused_crcs;
264 unsigned int num_unused_syms;
265
266
267 unsigned int num_unused_gpl_syms;
268 const struct kernel_symbol *unused_gpl_syms;
269 const unsigned long *unused_gpl_crcs;
270#endif
271
272#ifdef CONFIG_MODULE_SIG
273
274 bool sig_ok;
275#endif
276
277
278 const struct kernel_symbol *gpl_future_syms;
279 const unsigned long *gpl_future_crcs;
280 unsigned int num_gpl_future_syms;
281
282
283 unsigned int num_exentries;
284 struct exception_table_entry *extable;
285
286
287 int (*init)(void);
288
289
290 void *module_init;
291
292
293 void *module_core;
294
295
296 unsigned int init_size, core_size;
297
298
299 unsigned int init_text_size, core_text_size;
300
301
302 unsigned int init_ro_size, core_ro_size;
303
304
305 struct mod_arch_specific arch;
306
307 unsigned int taints;
308
309#ifdef CONFIG_GENERIC_BUG
310
311 unsigned num_bugs;
312 struct list_head bug_list;
313 struct bug_entry *bug_table;
314#endif
315
316#ifdef CONFIG_KALLSYMS
317
318
319
320
321
322 Elf_Sym *symtab, *core_symtab;
323 unsigned int num_symtab, core_num_syms;
324 char *strtab, *core_strtab;
325
326
327 struct module_sect_attrs *sect_attrs;
328
329
330 struct module_notes_attrs *notes_attrs;
331#endif
332
333
334
335 char *args;
336
337#ifdef CONFIG_SMP
338
339 void __percpu *percpu;
340 unsigned int percpu_size;
341#endif
342
343#ifdef CONFIG_TRACEPOINTS
344 unsigned int num_tracepoints;
345 struct tracepoint * const *tracepoints_ptrs;
346#endif
347#ifdef HAVE_JUMP_LABEL
348 struct jump_entry *jump_entries;
349 unsigned int num_jump_entries;
350#endif
351#ifdef CONFIG_TRACING
352 unsigned int num_trace_bprintk_fmt;
353 const char **trace_bprintk_fmt_start;
354#endif
355#ifdef CONFIG_EVENT_TRACING
356 struct ftrace_event_call **trace_events;
357 unsigned int num_trace_events;
358#endif
359#ifdef CONFIG_FTRACE_MCOUNT_RECORD
360 unsigned int num_ftrace_callsites;
361 unsigned long *ftrace_callsites;
362#endif
363
364#ifdef CONFIG_MODULE_UNLOAD
365
366 struct list_head source_list;
367
368 struct list_head target_list;
369
370
371 struct task_struct *waiter;
372
373
374 void (*exit)(void);
375
376 struct module_ref __percpu *refptr;
377#endif
378
379#ifdef CONFIG_CONSTRUCTORS
380
381 ctor_fn_t *ctors;
382 unsigned int num_ctors;
383#endif
384};
385#ifndef MODULE_ARCH_INIT
386#define MODULE_ARCH_INIT {}
387#endif
388
389extern struct mutex module_mutex;
390
391
392
393
394static inline int module_is_live(struct module *mod)
395{
396 return mod->state != MODULE_STATE_GOING;
397}
398
399struct module *__module_text_address(unsigned long addr);
400struct module *__module_address(unsigned long addr);
401bool is_module_address(unsigned long addr);
402bool is_module_percpu_address(unsigned long addr);
403bool is_module_text_address(unsigned long addr);
404
405static inline int within_module_core(unsigned long addr, const struct module *mod)
406{
407 return (unsigned long)mod->module_core <= addr &&
408 addr < (unsigned long)mod->module_core + mod->core_size;
409}
410
411static inline int within_module_init(unsigned long addr, const struct module *mod)
412{
413 return (unsigned long)mod->module_init <= addr &&
414 addr < (unsigned long)mod->module_init + mod->init_size;
415}
416
417
418struct module *find_module(const char *name);
419
420struct symsearch {
421 const struct kernel_symbol *start, *stop;
422 const unsigned long *crcs;
423 enum {
424 NOT_GPL_ONLY,
425 GPL_ONLY,
426 WILL_BE_GPL_ONLY,
427 } licence;
428 bool unused;
429};
430
431
432const struct kernel_symbol *find_symbol(const char *name,
433 struct module **owner,
434 const unsigned long **crc,
435 bool gplok,
436 bool warn);
437
438
439bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
440 struct module *owner,
441 void *data), void *data);
442
443
444
445int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
446 char *name, char *module_name, int *exported);
447
448
449unsigned long module_kallsyms_lookup_name(const char *name);
450
451int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
452 struct module *, unsigned long),
453 void *data);
454
455extern void __module_put_and_exit(struct module *mod, long code)
456 __attribute__((noreturn));
457#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
458
459#ifdef CONFIG_MODULE_UNLOAD
460unsigned long module_refcount(struct module *mod);
461void __symbol_put(const char *symbol);
462#define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
463void symbol_put_addr(void *addr);
464
465
466
467extern void __module_get(struct module *module);
468
469
470
471extern bool try_module_get(struct module *module);
472
473extern void module_put(struct module *module);
474
475#else
476static inline int try_module_get(struct module *module)
477{
478 return !module || module_is_live(module);
479}
480static inline void module_put(struct module *module)
481{
482}
483static inline void __module_get(struct module *module)
484{
485}
486#define symbol_put(x) do { } while(0)
487#define symbol_put_addr(p) do { } while(0)
488
489#endif
490int ref_module(struct module *a, struct module *b);
491
492
493#define module_name(mod) \
494({ \
495 struct module *__mod = (mod); \
496 __mod ? __mod->name : "kernel"; \
497})
498
499
500
501
502const char *module_address_lookup(unsigned long addr,
503 unsigned long *symbolsize,
504 unsigned long *offset,
505 char **modname,
506 char *namebuf);
507int lookup_module_symbol_name(unsigned long addr, char *symname);
508int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
509
510
511const struct exception_table_entry *search_module_extables(unsigned long addr);
512
513int register_module_notifier(struct notifier_block * nb);
514int unregister_module_notifier(struct notifier_block * nb);
515
516extern void print_modules(void);
517
518#else
519
520
521static inline const struct exception_table_entry *
522search_module_extables(unsigned long addr)
523{
524 return NULL;
525}
526
527static inline struct module *__module_address(unsigned long addr)
528{
529 return NULL;
530}
531
532static inline struct module *__module_text_address(unsigned long addr)
533{
534 return NULL;
535}
536
537static inline bool is_module_address(unsigned long addr)
538{
539 return false;
540}
541
542static inline bool is_module_percpu_address(unsigned long addr)
543{
544 return false;
545}
546
547static inline bool is_module_text_address(unsigned long addr)
548{
549 return false;
550}
551
552
553#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
554#define symbol_put(x) do { } while(0)
555#define symbol_put_addr(x) do { } while(0)
556
557static inline void __module_get(struct module *module)
558{
559}
560
561static inline int try_module_get(struct module *module)
562{
563 return 1;
564}
565
566static inline void module_put(struct module *module)
567{
568}
569
570#define module_name(mod) "kernel"
571
572
573static inline const char *module_address_lookup(unsigned long addr,
574 unsigned long *symbolsize,
575 unsigned long *offset,
576 char **modname,
577 char *namebuf)
578{
579 return NULL;
580}
581
582static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
583{
584 return -ERANGE;
585}
586
587static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
588{
589 return -ERANGE;
590}
591
592static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
593 char *type, char *name,
594 char *module_name, int *exported)
595{
596 return -ERANGE;
597}
598
599static inline unsigned long module_kallsyms_lookup_name(const char *name)
600{
601 return 0;
602}
603
604static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
605 struct module *,
606 unsigned long),
607 void *data)
608{
609 return 0;
610}
611
612static inline int register_module_notifier(struct notifier_block * nb)
613{
614
615 return 0;
616}
617
618static inline int unregister_module_notifier(struct notifier_block * nb)
619{
620 return 0;
621}
622
623#define module_put_and_exit(code) do_exit(code)
624
625static inline void print_modules(void)
626{
627}
628#endif
629
630#ifdef CONFIG_SYSFS
631extern struct kset *module_kset;
632extern struct kobj_type module_ktype;
633extern int module_sysfs_initialized;
634#endif
635
636#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
637
638
639
640#define __MODULE_STRING(x) __stringify(x)
641
642#ifdef CONFIG_DEBUG_SET_MODULE_RONX
643extern void set_all_modules_text_rw(void);
644extern void set_all_modules_text_ro(void);
645#else
646static inline void set_all_modules_text_rw(void) { }
647static inline void set_all_modules_text_ro(void) { }
648#endif
649
650#ifdef CONFIG_GENERIC_BUG
651void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
652 struct module *);
653void module_bug_cleanup(struct module *);
654
655#else
656
657static inline void module_bug_finalize(const Elf_Ehdr *hdr,
658 const Elf_Shdr *sechdrs,
659 struct module *mod)
660{
661}
662static inline void module_bug_cleanup(struct module *mod) {}
663#endif
664
665#endif
666