]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - include/linux/module.h
Merge tag '5.2-rc6-smb3-fix' of git://git.samba.org/sfrench/cifs-2.6
[mirror_ubuntu-eoan-kernel.git] / include / linux / module.h
CommitLineData
1da177e4
LT
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 */
1da177e4
LT
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>
0fd972a7 14#include <linux/init.h>
1da177e4
LT
15#include <linux/elf.h>
16#include <linux/stringify.h>
17#include <linux/kobject.h>
18#include <linux/moduleparam.h>
b2e285fc 19#include <linux/jump_label.h>
f5016932 20#include <linux/export.h>
93c2e105 21#include <linux/rbtree_latch.h>
663faf9f 22#include <linux/error-injection.h>
9c0be3f6 23#include <linux/tracepoint-defs.h>
1da177e4 24
e1783a24 25#include <linux/percpu.h>
1da177e4
LT
26#include <asm/module.h>
27
106a4ee2
RR
28/* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
29#define MODULE_SIG_STRING "~Module signature appended~\n"
30
1da177e4
LT
31/* Not Yet Implemented */
32#define MODULE_SUPPORTED_DEVICE(name)
33
730b69d2 34#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
1da177e4 35
e865d06b 36struct modversion_info {
1da177e4
LT
37 unsigned long crc;
38 char name[MODULE_NAME_LEN];
39};
40
41struct module;
0ef76537 42struct exception_table_entry;
1da177e4 43
4befb026
KS
44struct module_kobject {
45 struct kobject kobj;
46 struct module *mod;
47 struct kobject *drivers_dir;
48 struct module_param_attrs *mp;
942e4431 49 struct completion *kobj_completion;
3859a271 50} __randomize_layout;
4befb026 51
1da177e4 52struct module_attribute {
4befb026
KS
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 *,
1da177e4 57 const char *, size_t count);
c988d2b2
MD
58 void (*setup)(struct module *, const char *);
59 int (*test)(struct module *);
60 void (*free)(struct module *);
1da177e4
LT
61};
62
e94965ed
DT
63struct module_version_attribute {
64 struct module_attribute mattr;
65 const char *module_name;
66 const char *version;
98562ad8 67} __attribute__ ((__aligned__(sizeof(void *))));
e94965ed 68
9b73a584 69extern ssize_t __modver_version_show(struct module_attribute *,
4befb026 70 struct module_kobject *, char *);
9b73a584 71
88bfa324 72extern struct module_attribute module_uevent;
1da177e4
LT
73
74/* These are either module local, or the kernel's dummy ones. */
75extern int init_module(void);
76extern void cleanup_module(void);
77
0fd972a7
PG
78#ifndef MODULE
79/**
80 * module_init() - driver initialization entry point
81 * @x: function to be run at kernel boot time or module insertion
82 *
83 * module_init() will either be called during do_initcalls() (if
84 * builtin) or at module insertion time (if a module). There can only
85 * be one per module.
86 */
87#define module_init(x) __initcall(x);
88
89/**
90 * module_exit() - driver exit entry point
91 * @x: function to be run when driver is removed
92 *
93 * module_exit() will wrap the driver clean-up code
94 * with cleanup_module() when used with rmmod when
95 * the driver is a module. If the driver is statically
96 * compiled into the kernel, module_exit() has no effect.
97 * There can only be one per module.
98 */
99#define module_exit(x) __exitcall(x);
100
101#else /* MODULE */
102
103/*
104 * In most cases loadable modules do not need custom
105 * initcall levels. There are still some valid cases where
106 * a driver may be needed early if built in, and does not
107 * matter when built as a loadable module. Like bus
108 * snooping debug drivers.
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)
0fd972a7
PG
127
128/* Each module must use one module_init(). */
129#define module_init(initfn) \
1f318a8b 130 static inline initcall_t __maybe_unused __inittest(void) \
0fd972a7 131 { return initfn; } \
a6e60d84 132 int init_module(void) __copy(initfn) __attribute__((alias(#initfn)));
0fd972a7
PG
133
134/* This is only required if you want to be unloadable. */
135#define module_exit(exitfn) \
1f318a8b 136 static inline exitcall_t __maybe_unused __exittest(void) \
0fd972a7 137 { return exitfn; } \
a6e60d84 138 void cleanup_module(void) __copy(exitfn) __attribute__((alias(#exitfn)));
0fd972a7
PG
139
140#endif
141
142/* This means "can be init if no module support, otherwise module load
143 may call it." */
144#ifdef CONFIG_MODULES
145#define __init_or_module
146#define __initdata_or_module
147#define __initconst_or_module
148#define __INIT_OR_MODULE .text
149#define __INITDATA_OR_MODULE .data
150#define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
151#else
152#define __init_or_module __init
153#define __initdata_or_module __initdata
154#define __initconst_or_module __initconst
155#define __INIT_OR_MODULE __INIT
156#define __INITDATA_OR_MODULE __INITDATA
157#define __INITRODATA_OR_MODULE __INITRODATA
158#endif /*CONFIG_MODULES*/
159
1da177e4
LT
160/* Generic info of form tag = "info" */
161#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
162
163/* For userspace: you can also call me... */
164#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
165
7cb14ba7
AR
166/* Soft module dependencies. See man modprobe.d for details.
167 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
168 */
169#define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
170
1da177e4
LT
171/*
172 * The following license idents are currently accepted as indicating free
173 * software modules
174 *
bf7fbeea 175 * "GPL" [GNU Public License v2]
1da177e4
LT
176 * "GPL v2" [GNU Public License v2]
177 * "GPL and additional rights" [GNU Public License v2 rights and more]
178 * "Dual BSD/GPL" [GNU Public License v2
179 * or BSD license choice]
8d27e908
XVP
180 * "Dual MIT/GPL" [GNU Public License v2
181 * or MIT license choice]
1da177e4
LT
182 * "Dual MPL/GPL" [GNU Public License v2
183 * or Mozilla license choice]
184 *
185 * The following other idents are available
186 *
187 * "Proprietary" [Non free products]
188 *
bf7fbeea
TG
189 * Both "GPL v2" and "GPL" (the latter also in dual licensed strings) are
190 * merely stating that the module is licensed under the GPL v2, but are not
191 * telling whether "GPL v2 only" or "GPL v2 or later". The reason why there
192 * are two variants is a historic and failed attempt to convey more
193 * information in the MODULE_LICENSE string. For module loading the
194 * "only/or later" distinction is completely irrelevant and does neither
195 * replace the proper license identifiers in the corresponding source file
196 * nor amends them in any way. The sole purpose is to make the
197 * 'Proprietary' flagging work and to refuse to bind symbols which are
198 * exported with EXPORT_SYMBOL_GPL when a non free module is loaded.
199 *
200 * In the same way "BSD" is not a clear license information. It merely
201 * states, that the module is licensed under one of the compatible BSD
202 * license variants. The detailed and correct license information is again
203 * to be found in the corresponding source files.
204 *
1da177e4
LT
205 * There are dual licensed components, but when running with Linux it is the
206 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
207 * is a GPL combined work.
208 *
209 * This exists for several reasons
e865d06b 210 * 1. So modinfo can show license info for users wanting to vet their setup
1da177e4
LT
211 * is free
212 * 2. So the community can ignore bug reports including proprietary modules
213 * 3. So vendors can do likewise based on their own policies
214 */
215#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
216
1d7015ca
JB
217/*
218 * Author(s), use "Name <email>" or just "Name", for multiple
219 * authors use multiple MODULE_AUTHOR() statements/lines.
220 */
1da177e4 221#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
e865d06b 222
1da177e4
LT
223/* What your module does. */
224#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
225
cff26a51
RR
226#ifdef MODULE
227/* Creates an alias so file2alias.c can find device table. */
228#define MODULE_DEVICE_TABLE(type, name) \
0bf8bf50 229extern typeof(name) __mod_##type##__##name##_device_table \
cff26a51
RR
230 __attribute__ ((unused, alias(__stringify(name))))
231#else /* !MODULE */
232#define MODULE_DEVICE_TABLE(type, name)
233#endif
1da177e4
LT
234
235/* Version of form [<epoch>:]<version>[-<extra-version>].
e865d06b
SL
236 * Or for CVS/RCS ID version, everything but the number is stripped.
237 * <epoch>: A (small) unsigned integer which allows you to start versions
238 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
239 * "1:2.0".
240
241 * <version>: The <version> may contain only alphanumerics and the
242 * character `.'. Ordered by numeric sort for numeric parts,
243 * ascii sort for ascii parts (as per RPM or DEB algorithm).
244
245 * <extraversion>: Like <version>, but inserted for local
246 * customizations, eg "rh3" or "rusty1".
247
248 * Using this automatically adds a checksum of the .c files and the
249 * local headers in "srcversion".
250 */
e94965ed 251
3b90a5b2 252#if defined(MODULE) || !defined(CONFIG_SYSFS)
1da177e4 253#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
e94965ed
DT
254#else
255#define MODULE_VERSION(_version) \
898490c0 256 MODULE_INFO(version, _version); \
b4bc8428 257 static struct module_version_attribute ___modver_attr = { \
e94965ed
DT
258 .mattr = { \
259 .attr = { \
260 .name = "version", \
261 .mode = S_IRUGO, \
262 }, \
263 .show = __modver_version_show, \
264 }, \
265 .module_name = KBUILD_MODNAME, \
266 .version = _version, \
b4bc8428
DT
267 }; \
268 static const struct module_version_attribute \
269 __used __attribute__ ((__section__ ("__modver"))) \
270 * __moduleparam_const __modver_attr = &___modver_attr
e94965ed 271#endif
1da177e4 272
187afbed
JM
273/* Optional firmware file (or files) needed by the module
274 * format is simply firmware file name. Multiple firmware
275 * files require multiple MODULE_FIRMWARE() specifiers */
276#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
277
1da177e4
LT
278struct notifier_block;
279
280#ifdef CONFIG_MODULES
281
5ed10910 282extern int modules_disabled; /* for sysctl */
1da177e4
LT
283/* Get/put a kernel symbol (calls must be symmetric) */
284void *__symbol_get(const char *symbol);
285void *__symbol_get_gpl(const char *symbol);
996302c5 286#define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
1da177e4 287
c8e21ced
RR
288/* modules using other modules: kdb wants to see this. */
289struct module_use {
290 struct list_head source_list;
291 struct list_head target_list;
292 struct module *source, *target;
293};
294
0d21b0e3
RR
295enum module_state {
296 MODULE_STATE_LIVE, /* Normal state. */
297 MODULE_STATE_COMING, /* Full formed, running module_init. */
298 MODULE_STATE_GOING, /* Going away. */
299 MODULE_STATE_UNFORMED, /* Still setting it up. */
1da177e4
LT
300};
301
93c2e105
PZ
302struct mod_tree_node {
303 struct module *mod;
304 struct latch_tree_node node;
305};
306
7523e4dc
RR
307struct module_layout {
308 /* The actual code + data. */
309 void *base;
310 /* Total size. */
311 unsigned int size;
312 /* The size of the executable code. */
313 unsigned int text_size;
314 /* Size of RO section of the module (text+rodata) */
315 unsigned int ro_size;
444d13ff
JY
316 /* Size of RO after init section */
317 unsigned int ro_after_init_size;
7523e4dc
RR
318
319#ifdef CONFIG_MODULES_TREE_LOOKUP
320 struct mod_tree_node mtn;
321#endif
322};
323
324#ifdef CONFIG_MODULES_TREE_LOOKUP
325/* Only touch one cacheline for common rbtree-for-core-layout case. */
326#define __module_layout_align ____cacheline_aligned
327#else
328#define __module_layout_align
329#endif
330
8244062e
RR
331struct mod_kallsyms {
332 Elf_Sym *symtab;
333 unsigned int num_symtab;
334 char *strtab;
1c7651f4 335 char *typetab;
8244062e
RR
336};
337
1ce15ef4
JY
338#ifdef CONFIG_LIVEPATCH
339struct klp_modinfo {
340 Elf_Ehdr hdr;
341 Elf_Shdr *sechdrs;
342 char *secstrings;
343 unsigned int symndx;
344};
345#endif
346
e865d06b 347struct module {
1da177e4
LT
348 enum module_state state;
349
350 /* Member of list of modules */
351 struct list_head list;
352
353 /* Unique handle for this module */
354 char name[MODULE_NAME_LEN];
355
356 /* Sysfs stuff. */
357 struct module_kobject mkobj;
03e88ae1 358 struct module_attribute *modinfo_attrs;
c988d2b2
MD
359 const char *version;
360 const char *srcversion;
270a6c4c 361 struct kobject *holders_dir;
1da177e4
LT
362
363 /* Exported symbols */
364 const struct kernel_symbol *syms;
71810db2 365 const s32 *crcs;
af540689 366 unsigned int num_syms;
1da177e4 367
e180a6b7 368 /* Kernel parameters. */
cf2fde7b 369#ifdef CONFIG_SYSFS
b51d23e4 370 struct mutex param_lock;
cf2fde7b 371#endif
e180a6b7
RR
372 struct kernel_param *kp;
373 unsigned int num_kp;
374
1da177e4 375 /* GPL-only exported symbols. */
1da177e4 376 unsigned int num_gpl_syms;
af540689 377 const struct kernel_symbol *gpl_syms;
71810db2 378 const s32 *gpl_crcs;
1da177e4 379
f7f5b675 380#ifdef CONFIG_UNUSED_SYMBOLS
f71d20e9
AV
381 /* unused exported symbols. */
382 const struct kernel_symbol *unused_syms;
71810db2 383 const s32 *unused_crcs;
af540689
RK
384 unsigned int num_unused_syms;
385
f71d20e9 386 /* GPL-only, unused exported symbols. */
f71d20e9 387 unsigned int num_unused_gpl_syms;
af540689 388 const struct kernel_symbol *unused_gpl_syms;
71810db2 389 const s32 *unused_gpl_crcs;
f7f5b675 390#endif
f71d20e9 391
106a4ee2
RR
392#ifdef CONFIG_MODULE_SIG
393 /* Signature was verified. */
394 bool sig_ok;
395#endif
396
f2411da7
LR
397 bool async_probe_requested;
398
9f28bb7e
GKH
399 /* symbols that will be GPL-only in the near future. */
400 const struct kernel_symbol *gpl_future_syms;
71810db2 401 const s32 *gpl_future_crcs;
af540689 402 unsigned int num_gpl_future_syms;
9f28bb7e 403
1da177e4
LT
404 /* Exception table */
405 unsigned int num_exentries;
5e458cc0 406 struct exception_table_entry *extable;
1da177e4
LT
407
408 /* Startup function. */
409 int (*init)(void);
410
7523e4dc
RR
411 /* Core layout: rbtree is accessed frequently, so keep together. */
412 struct module_layout core_layout __module_layout_align;
413 struct module_layout init_layout;
84e1c6bb 414
1da177e4
LT
415 /* Arch-specific module values */
416 struct mod_arch_specific arch;
417
7fd8329b 418 unsigned long taints; /* same bits as kernel:taint_flags */
2bc2d61a 419
7664c5a1
JF
420#ifdef CONFIG_GENERIC_BUG
421 /* Support for BUG */
af540689 422 unsigned num_bugs;
7664c5a1
JF
423 struct list_head bug_list;
424 struct bug_entry *bug_table;
1da177e4
LT
425#endif
426
427#ifdef CONFIG_KALLSYMS
8244062e
RR
428 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
429 struct mod_kallsyms *kallsyms;
430 struct mod_kallsyms core_kallsyms;
c714965f 431
1da177e4
LT
432 /* Section attributes */
433 struct module_sect_attrs *sect_attrs;
6d760133
RM
434
435 /* Notes attributes */
436 struct module_notes_attrs *notes_attrs;
1da177e4
LT
437#endif
438
a288bd65
RK
439 /* The command line arguments (may be mangled). People like
440 keeping pointers to this stuff */
441 char *args;
442
259354de 443#ifdef CONFIG_SMP
1da177e4 444 /* Per-cpu data. */
259354de
TH
445 void __percpu *percpu;
446 unsigned int percpu_size;
447#endif
1da177e4 448
97e1c18e 449#ifdef CONFIG_TRACEPOINTS
97e1c18e 450 unsigned int num_tracepoints;
9c0be3f6 451 tracepoint_ptr_t *tracepoints_ptrs;
97e1c18e 452#endif
a38d1107
MM
453#ifdef CONFIG_BPF_EVENTS
454 unsigned int num_bpf_raw_events;
455 struct bpf_raw_event_map *bpf_raw_events;
456#endif
e9666d10 457#ifdef CONFIG_JUMP_LABEL
bf5438fc
JB
458 struct jump_entry *jump_entries;
459 unsigned int num_jump_entries;
460#endif
769b0441 461#ifdef CONFIG_TRACING
1ba28e02 462 unsigned int num_trace_bprintk_fmt;
a288bd65 463 const char **trace_bprintk_fmt_start;
1ba28e02 464#endif
6d723736 465#ifdef CONFIG_EVENT_TRACING
2425bcb9 466 struct trace_event_call **trace_events;
6d723736 467 unsigned int num_trace_events;
99be647c
JL
468 struct trace_eval_map **trace_evals;
469 unsigned int num_trace_evals;
6d723736 470#endif
93eb677d 471#ifdef CONFIG_FTRACE_MCOUNT_RECORD
93eb677d 472 unsigned int num_ftrace_callsites;
a288bd65 473 unsigned long *ftrace_callsites;
93eb677d 474#endif
1ba28e02 475
8cb2c2dc 476#ifdef CONFIG_LIVEPATCH
1ce15ef4 477 bool klp; /* Is this a livepatch module? */
8cb2c2dc 478 bool klp_alive;
1ce15ef4
JY
479
480 /* Elf information */
481 struct klp_modinfo *klp_info;
8cb2c2dc
PM
482#endif
483
af540689
RK
484#ifdef CONFIG_MODULE_UNLOAD
485 /* What modules depend on me? */
2c02dfe7
LT
486 struct list_head source_list;
487 /* What modules do I depend on? */
488 struct list_head target_list;
af540689 489
af540689
RK
490 /* Destruction function. */
491 void (*exit)(void);
492
2f35c41f 493 atomic_t refcnt;
af540689 494#endif
b99b87f7
PO
495
496#ifdef CONFIG_CONSTRUCTORS
497 /* Constructor functions. */
498 ctor_fn_t *ctors;
499 unsigned int num_ctors;
500#endif
92ace999 501
540adea3 502#ifdef CONFIG_FUNCTION_ERROR_INJECTION
663faf9f 503 struct error_injection_entry *ei_funcs;
540adea3 504 unsigned int num_ei_funcs;
92ace999 505#endif
3859a271 506} ____cacheline_aligned __randomize_layout;
e61a1c1c
RZ
507#ifndef MODULE_ARCH_INIT
508#define MODULE_ARCH_INIT {}
509#endif
1da177e4 510
93d77e7f
VW
511#ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
512static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
513{
514 return sym->st_value;
515}
516#endif
517
c6b37801
TA
518extern struct mutex module_mutex;
519
1da177e4
LT
520/* FIXME: It'd be nice to isolate modules during init, too, so they
521 aren't used before they (may) fail. But presently too much code
522 (IDE & SCSI) require entry into the module during init.*/
171d864e 523static inline bool module_is_live(struct module *mod)
1da177e4
LT
524{
525 return mod->state != MODULE_STATE_GOING;
526}
527
1da177e4 528struct module *__module_text_address(unsigned long addr);
e610499e
RR
529struct module *__module_address(unsigned long addr);
530bool is_module_address(unsigned long addr);
383776fa 531bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
10fad5e4 532bool is_module_percpu_address(unsigned long addr);
e610499e 533bool is_module_text_address(unsigned long addr);
1da177e4 534
76681c8f
PM
535static inline bool within_module_core(unsigned long addr,
536 const struct module *mod)
a06f6211 537{
7523e4dc
RR
538 return (unsigned long)mod->core_layout.base <= addr &&
539 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
a06f6211
MH
540}
541
76681c8f
PM
542static inline bool within_module_init(unsigned long addr,
543 const struct module *mod)
a06f6211 544{
7523e4dc
RR
545 return (unsigned long)mod->init_layout.base <= addr &&
546 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
a06f6211
MH
547}
548
76681c8f 549static inline bool within_module(unsigned long addr, const struct module *mod)
9b20a352
PM
550{
551 return within_module_init(addr, mod) || within_module_core(addr, mod);
552}
553
c6b37801
TA
554/* Search for module by name: must hold module_mutex. */
555struct module *find_module(const char *name);
556
557struct symsearch {
558 const struct kernel_symbol *start, *stop;
71810db2 559 const s32 *crcs;
c6b37801
TA
560 enum {
561 NOT_GPL_ONLY,
562 GPL_ONLY,
563 WILL_BE_GPL_ONLY,
564 } licence;
565 bool unused;
566};
567
0be964be
PZ
568/*
569 * Search for an exported symbol by name.
570 *
571 * Must be called with module_mutex held or preemption disabled.
572 */
c6b37801
TA
573const struct kernel_symbol *find_symbol(const char *name,
574 struct module **owner,
71810db2 575 const s32 **crc,
c6b37801
TA
576 bool gplok,
577 bool warn);
578
0be964be
PZ
579/*
580 * Walk the exported symbol table
581 *
582 * Must be called with module_mutex held or preemption disabled.
583 */
de4d8d53
RR
584bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
585 struct module *owner,
586 void *data), void *data);
c6b37801 587
ea07890a 588/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
1da177e4 589 symnum out of range. */
ea07890a
AD
590int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
591 char *name, char *module_name, int *exported);
1da177e4
LT
592
593/* Look for this name: can be of form module:name. */
594unsigned long module_kallsyms_lookup_name(const char *name);
595
75a66614
AK
596int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
597 struct module *, unsigned long),
598 void *data);
599
bf262dce
JK
600extern void __noreturn __module_put_and_exit(struct module *mod,
601 long code);
74e22fac 602#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
1da177e4
LT
603
604#ifdef CONFIG_MODULE_UNLOAD
d5db139a 605int module_refcount(struct module *mod);
1da177e4 606void __symbol_put(const char *symbol);
996302c5 607#define symbol_put(x) __symbol_put(__stringify(x))
1da177e4
LT
608void symbol_put_addr(void *addr);
609
610/* Sometimes we know we already have a refcount, and it's easier not
611 to handle the error case (which only happens with rmmod --wait). */
d53799be 612extern void __module_get(struct module *module);
e1783a24 613
d53799be
SR
614/* This is the Right Way to get a module: if it fails, it's being removed,
615 * so pretend it's not there. */
616extern bool try_module_get(struct module *module);
1da177e4 617
f6a57033 618extern void module_put(struct module *module);
1da177e4
LT
619
620#else /*!CONFIG_MODULE_UNLOAD*/
8ba4fcdf 621static inline bool try_module_get(struct module *module)
1da177e4
LT
622{
623 return !module || module_is_live(module);
624}
625static inline void module_put(struct module *module)
626{
627}
628static inline void __module_get(struct module *module)
629{
630}
e865d06b
SL
631#define symbol_put(x) do { } while (0)
632#define symbol_put_addr(p) do { } while (0)
1da177e4
LT
633
634#endif /* CONFIG_MODULE_UNLOAD */
dfd62d1d 635int ref_module(struct module *a, struct module *b);
1da177e4
LT
636
637/* This is a #define so the string doesn't get put in every .o file */
638#define module_name(mod) \
639({ \
640 struct module *__mod = (mod); \
641 __mod ? __mod->name : "kernel"; \
642})
643
b865ea64
SS
644/* Dereference module function descriptor */
645void *dereference_module_function_descriptor(struct module *mod, void *ptr);
646
6dd06c9f
RR
647/* For kallsyms to ask for address resolution. namebuf should be at
648 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
649 * found, otherwise NULL. */
92dfc9dc 650const char *module_address_lookup(unsigned long addr,
6dd06c9f
RR
651 unsigned long *symbolsize,
652 unsigned long *offset,
653 char **modname,
654 char *namebuf);
9d65cb4a 655int lookup_module_symbol_name(unsigned long addr, char *symname);
a5c43dae 656int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
1da177e4 657
e865d06b
SL
658int register_module_notifier(struct notifier_block *nb);
659int unregister_module_notifier(struct notifier_block *nb);
1da177e4
LT
660
661extern void print_modules(void);
662
80c6e146
DT
663static inline bool module_requested_async_probing(struct module *module)
664{
665 return module && module->async_probe_requested;
666}
667
1ce15ef4
JY
668#ifdef CONFIG_LIVEPATCH
669static inline bool is_livepatch_module(struct module *mod)
670{
671 return mod->klp;
672}
673#else /* !CONFIG_LIVEPATCH */
674static inline bool is_livepatch_module(struct module *mod)
675{
676 return false;
677}
678#endif /* CONFIG_LIVEPATCH */
679
fda784e5 680bool is_module_sig_enforced(void);
8db5da0b 681void set_module_sig_enforced(void);
fda784e5 682
1da177e4 683#else /* !CONFIG_MODULES... */
1da177e4 684
e610499e
RR
685static inline struct module *__module_address(unsigned long addr)
686{
687 return NULL;
688}
689
1da177e4
LT
690static inline struct module *__module_text_address(unsigned long addr)
691{
692 return NULL;
693}
694
e610499e
RR
695static inline bool is_module_address(unsigned long addr)
696{
697 return false;
698}
699
d5e50daf
RD
700static inline bool is_module_percpu_address(unsigned long addr)
701{
702 return false;
703}
704
383776fa
TG
705static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
706{
707 return false;
708}
709
e610499e 710static inline bool is_module_text_address(unsigned long addr)
4d435f9d 711{
e610499e 712 return false;
4d435f9d
IM
713}
714
007ec26c
DH
715static inline bool within_module_core(unsigned long addr,
716 const struct module *mod)
717{
718 return false;
719}
720
dadec066
TV
721static inline bool within_module_init(unsigned long addr,
722 const struct module *mod)
723{
724 return false;
725}
726
727static inline bool within_module(unsigned long addr, const struct module *mod)
728{
729 return false;
730}
731
1da177e4
LT
732/* Get/put a kernel symbol (calls should be symmetric) */
733#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
e865d06b
SL
734#define symbol_put(x) do { } while (0)
735#define symbol_put_addr(x) do { } while (0)
1da177e4
LT
736
737static inline void __module_get(struct module *module)
738{
739}
740
8ba4fcdf 741static inline bool try_module_get(struct module *module)
1da177e4 742{
8ba4fcdf 743 return true;
1da177e4
LT
744}
745
746static inline void module_put(struct module *module)
747{
748}
749
750#define module_name(mod) "kernel"
751
1da177e4 752/* For kallsyms to ask for address resolution. NULL means not found. */
92dfc9dc 753static inline const char *module_address_lookup(unsigned long addr,
6dd06c9f
RR
754 unsigned long *symbolsize,
755 unsigned long *offset,
756 char **modname,
757 char *namebuf)
1da177e4
LT
758{
759 return NULL;
760}
761
9d65cb4a
AD
762static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
763{
764 return -ERANGE;
765}
766
a5c43dae
AD
767static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
768{
769 return -ERANGE;
770}
771
ea07890a
AD
772static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
773 char *type, char *name,
774 char *module_name, int *exported)
1da177e4 775{
ea07890a 776 return -ERANGE;
1da177e4
LT
777}
778
779static inline unsigned long module_kallsyms_lookup_name(const char *name)
780{
781 return 0;
782}
783
75a66614
AK
784static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
785 struct module *,
786 unsigned long),
787 void *data)
788{
789 return 0;
790}
791
e865d06b 792static inline int register_module_notifier(struct notifier_block *nb)
1da177e4
LT
793{
794 /* no events will happen anyway, so this can always succeed */
795 return 0;
796}
797
e865d06b 798static inline int unregister_module_notifier(struct notifier_block *nb)
1da177e4
LT
799{
800 return 0;
801}
802
803#define module_put_and_exit(code) do_exit(code)
804
805static inline void print_modules(void)
806{
807}
80c6e146
DT
808
809static inline bool module_requested_async_probing(struct module *module)
810{
811 return false;
812}
813
fda784e5
BM
814static inline bool is_module_sig_enforced(void)
815{
816 return false;
817}
818
8db5da0b
MZ
819static inline void set_module_sig_enforced(void)
820{
821}
822
b865ea64
SS
823/* Dereference module function descriptor */
824static inline
825void *dereference_module_function_descriptor(struct module *mod, void *ptr)
826{
827 return ptr;
828}
829
ef665c1a
RD
830#endif /* CONFIG_MODULES */
831
ef665c1a 832#ifdef CONFIG_SYSFS
7405c1e1
GKH
833extern struct kset *module_kset;
834extern struct kobj_type module_ktype;
835extern int module_sysfs_initialized;
ef665c1a
RD
836#endif /* CONFIG_SYSFS */
837
1da177e4
LT
838#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
839
840/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
841
1da177e4
LT
842#define __MODULE_STRING(x) __stringify(x)
843
0f5bf6d0 844#ifdef CONFIG_STRICT_MODULE_RWX
84e1c6bb
MC
845extern void set_all_modules_text_rw(void);
846extern void set_all_modules_text_ro(void);
444d13ff 847extern void module_enable_ro(const struct module *mod, bool after_init);
85c898db 848extern void module_disable_ro(const struct module *mod);
84e1c6bb
MC
849#else
850static inline void set_all_modules_text_rw(void) { }
851static inline void set_all_modules_text_ro(void) { }
444d13ff 852static inline void module_enable_ro(const struct module *mod, bool after_init) { }
85c898db 853static inline void module_disable_ro(const struct module *mod) { }
84e1c6bb 854#endif
0d9c25dd
AM
855
856#ifdef CONFIG_GENERIC_BUG
5336377d 857void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
0d9c25dd
AM
858 struct module *);
859void module_bug_cleanup(struct module *);
860
861#else /* !CONFIG_GENERIC_BUG */
862
5336377d 863static inline void module_bug_finalize(const Elf_Ehdr *hdr,
0d9c25dd
AM
864 const Elf_Shdr *sechdrs,
865 struct module *mod)
866{
0d9c25dd
AM
867}
868static inline void module_bug_cleanup(struct module *mod) {}
869#endif /* CONFIG_GENERIC_BUG */
870
e4f35891 871#ifdef CONFIG_RETPOLINE
caf7501a
AK
872extern bool retpoline_module_ok(bool has_retpoline);
873#else
874static inline bool retpoline_module_ok(bool has_retpoline)
875{
876 return true;
877}
878#endif
879
59afdc7b
HX
880#ifdef CONFIG_MODULE_SIG
881static inline bool module_sig_ok(struct module *module)
882{
883 return module->sig_ok;
884}
885#else /* !CONFIG_MODULE_SIG */
886static inline bool module_sig_ok(struct module *module)
887{
888 return true;
889}
890#endif /* CONFIG_MODULE_SIG */
891
1da177e4 892#endif /* _LINUX_MODULE_H */