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