]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/module.h
Merge branch 'bpf-bpftool-mount-tracefs'
[mirror_ubuntu-jammy-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
PG
131 { return initfn; } \
132 int init_module(void) __attribute__((alias(#initfn)));
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
PG
137 { return exitfn; } \
138 void cleanup_module(void) __attribute__((alias(#exitfn)));
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 *
175 * "GPL" [GNU Public License v2 or later]
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 *
189 * There are dual licensed components, but when running with Linux it is the
190 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
191 * is a GPL combined work.
192 *
193 * This exists for several reasons
e865d06b 194 * 1. So modinfo can show license info for users wanting to vet their setup
1da177e4
LT
195 * is free
196 * 2. So the community can ignore bug reports including proprietary modules
197 * 3. So vendors can do likewise based on their own policies
198 */
199#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
200
1d7015ca
JB
201/*
202 * Author(s), use "Name <email>" or just "Name", for multiple
203 * authors use multiple MODULE_AUTHOR() statements/lines.
204 */
1da177e4 205#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
e865d06b 206
1da177e4
LT
207/* What your module does. */
208#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
209
cff26a51
RR
210#ifdef MODULE
211/* Creates an alias so file2alias.c can find device table. */
212#define MODULE_DEVICE_TABLE(type, name) \
0bf8bf50 213extern typeof(name) __mod_##type##__##name##_device_table \
cff26a51
RR
214 __attribute__ ((unused, alias(__stringify(name))))
215#else /* !MODULE */
216#define MODULE_DEVICE_TABLE(type, name)
217#endif
1da177e4
LT
218
219/* Version of form [<epoch>:]<version>[-<extra-version>].
e865d06b
SL
220 * Or for CVS/RCS ID version, everything but the number is stripped.
221 * <epoch>: A (small) unsigned integer which allows you to start versions
222 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
223 * "1:2.0".
224
225 * <version>: The <version> may contain only alphanumerics and the
226 * character `.'. Ordered by numeric sort for numeric parts,
227 * ascii sort for ascii parts (as per RPM or DEB algorithm).
228
229 * <extraversion>: Like <version>, but inserted for local
230 * customizations, eg "rh3" or "rusty1".
231
232 * Using this automatically adds a checksum of the .c files and the
233 * local headers in "srcversion".
234 */
e94965ed 235
3b90a5b2 236#if defined(MODULE) || !defined(CONFIG_SYSFS)
1da177e4 237#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
e94965ed
DT
238#else
239#define MODULE_VERSION(_version) \
b4bc8428 240 static struct module_version_attribute ___modver_attr = { \
e94965ed
DT
241 .mattr = { \
242 .attr = { \
243 .name = "version", \
244 .mode = S_IRUGO, \
245 }, \
246 .show = __modver_version_show, \
247 }, \
248 .module_name = KBUILD_MODNAME, \
249 .version = _version, \
b4bc8428
DT
250 }; \
251 static const struct module_version_attribute \
252 __used __attribute__ ((__section__ ("__modver"))) \
253 * __moduleparam_const __modver_attr = &___modver_attr
e94965ed 254#endif
1da177e4 255
187afbed
JM
256/* Optional firmware file (or files) needed by the module
257 * format is simply firmware file name. Multiple firmware
258 * files require multiple MODULE_FIRMWARE() specifiers */
259#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
260
1da177e4
LT
261struct notifier_block;
262
263#ifdef CONFIG_MODULES
264
5ed10910 265extern int modules_disabled; /* for sysctl */
1da177e4
LT
266/* Get/put a kernel symbol (calls must be symmetric) */
267void *__symbol_get(const char *symbol);
268void *__symbol_get_gpl(const char *symbol);
996302c5 269#define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
1da177e4 270
c8e21ced
RR
271/* modules using other modules: kdb wants to see this. */
272struct module_use {
273 struct list_head source_list;
274 struct list_head target_list;
275 struct module *source, *target;
276};
277
0d21b0e3
RR
278enum module_state {
279 MODULE_STATE_LIVE, /* Normal state. */
280 MODULE_STATE_COMING, /* Full formed, running module_init. */
281 MODULE_STATE_GOING, /* Going away. */
282 MODULE_STATE_UNFORMED, /* Still setting it up. */
1da177e4
LT
283};
284
93c2e105
PZ
285struct mod_tree_node {
286 struct module *mod;
287 struct latch_tree_node node;
288};
289
7523e4dc
RR
290struct module_layout {
291 /* The actual code + data. */
292 void *base;
293 /* Total size. */
294 unsigned int size;
295 /* The size of the executable code. */
296 unsigned int text_size;
297 /* Size of RO section of the module (text+rodata) */
298 unsigned int ro_size;
444d13ff
JY
299 /* Size of RO after init section */
300 unsigned int ro_after_init_size;
7523e4dc
RR
301
302#ifdef CONFIG_MODULES_TREE_LOOKUP
303 struct mod_tree_node mtn;
304#endif
305};
306
307#ifdef CONFIG_MODULES_TREE_LOOKUP
308/* Only touch one cacheline for common rbtree-for-core-layout case. */
309#define __module_layout_align ____cacheline_aligned
310#else
311#define __module_layout_align
312#endif
313
8244062e
RR
314struct mod_kallsyms {
315 Elf_Sym *symtab;
316 unsigned int num_symtab;
317 char *strtab;
318};
319
1ce15ef4
JY
320#ifdef CONFIG_LIVEPATCH
321struct klp_modinfo {
322 Elf_Ehdr hdr;
323 Elf_Shdr *sechdrs;
324 char *secstrings;
325 unsigned int symndx;
326};
327#endif
328
e865d06b 329struct module {
1da177e4
LT
330 enum module_state state;
331
332 /* Member of list of modules */
333 struct list_head list;
334
335 /* Unique handle for this module */
336 char name[MODULE_NAME_LEN];
337
338 /* Sysfs stuff. */
339 struct module_kobject mkobj;
03e88ae1 340 struct module_attribute *modinfo_attrs;
c988d2b2
MD
341 const char *version;
342 const char *srcversion;
270a6c4c 343 struct kobject *holders_dir;
1da177e4
LT
344
345 /* Exported symbols */
346 const struct kernel_symbol *syms;
71810db2 347 const s32 *crcs;
af540689 348 unsigned int num_syms;
1da177e4 349
e180a6b7 350 /* Kernel parameters. */
cf2fde7b 351#ifdef CONFIG_SYSFS
b51d23e4 352 struct mutex param_lock;
cf2fde7b 353#endif
e180a6b7
RR
354 struct kernel_param *kp;
355 unsigned int num_kp;
356
1da177e4 357 /* GPL-only exported symbols. */
1da177e4 358 unsigned int num_gpl_syms;
af540689 359 const struct kernel_symbol *gpl_syms;
71810db2 360 const s32 *gpl_crcs;
1da177e4 361
f7f5b675 362#ifdef CONFIG_UNUSED_SYMBOLS
f71d20e9
AV
363 /* unused exported symbols. */
364 const struct kernel_symbol *unused_syms;
71810db2 365 const s32 *unused_crcs;
af540689
RK
366 unsigned int num_unused_syms;
367
f71d20e9 368 /* GPL-only, unused exported symbols. */
f71d20e9 369 unsigned int num_unused_gpl_syms;
af540689 370 const struct kernel_symbol *unused_gpl_syms;
71810db2 371 const s32 *unused_gpl_crcs;
f7f5b675 372#endif
f71d20e9 373
106a4ee2
RR
374#ifdef CONFIG_MODULE_SIG
375 /* Signature was verified. */
376 bool sig_ok;
377#endif
378
f2411da7
LR
379 bool async_probe_requested;
380
9f28bb7e
GKH
381 /* symbols that will be GPL-only in the near future. */
382 const struct kernel_symbol *gpl_future_syms;
71810db2 383 const s32 *gpl_future_crcs;
af540689 384 unsigned int num_gpl_future_syms;
9f28bb7e 385
1da177e4
LT
386 /* Exception table */
387 unsigned int num_exentries;
5e458cc0 388 struct exception_table_entry *extable;
1da177e4
LT
389
390 /* Startup function. */
391 int (*init)(void);
392
7523e4dc
RR
393 /* Core layout: rbtree is accessed frequently, so keep together. */
394 struct module_layout core_layout __module_layout_align;
395 struct module_layout init_layout;
84e1c6bb 396
1da177e4
LT
397 /* Arch-specific module values */
398 struct mod_arch_specific arch;
399
7fd8329b 400 unsigned long taints; /* same bits as kernel:taint_flags */
2bc2d61a 401
7664c5a1
JF
402#ifdef CONFIG_GENERIC_BUG
403 /* Support for BUG */
af540689 404 unsigned num_bugs;
7664c5a1
JF
405 struct list_head bug_list;
406 struct bug_entry *bug_table;
1da177e4
LT
407#endif
408
409#ifdef CONFIG_KALLSYMS
8244062e
RR
410 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
411 struct mod_kallsyms *kallsyms;
412 struct mod_kallsyms core_kallsyms;
c714965f 413
1da177e4
LT
414 /* Section attributes */
415 struct module_sect_attrs *sect_attrs;
6d760133
RM
416
417 /* Notes attributes */
418 struct module_notes_attrs *notes_attrs;
1da177e4
LT
419#endif
420
a288bd65
RK
421 /* The command line arguments (may be mangled). People like
422 keeping pointers to this stuff */
423 char *args;
424
259354de 425#ifdef CONFIG_SMP
1da177e4 426 /* Per-cpu data. */
259354de
TH
427 void __percpu *percpu;
428 unsigned int percpu_size;
429#endif
1da177e4 430
97e1c18e 431#ifdef CONFIG_TRACEPOINTS
97e1c18e 432 unsigned int num_tracepoints;
9c0be3f6 433 tracepoint_ptr_t *tracepoints_ptrs;
97e1c18e 434#endif
bf5438fc
JB
435#ifdef HAVE_JUMP_LABEL
436 struct jump_entry *jump_entries;
437 unsigned int num_jump_entries;
438#endif
769b0441 439#ifdef CONFIG_TRACING
1ba28e02 440 unsigned int num_trace_bprintk_fmt;
a288bd65 441 const char **trace_bprintk_fmt_start;
1ba28e02 442#endif
6d723736 443#ifdef CONFIG_EVENT_TRACING
2425bcb9 444 struct trace_event_call **trace_events;
6d723736 445 unsigned int num_trace_events;
99be647c
JL
446 struct trace_eval_map **trace_evals;
447 unsigned int num_trace_evals;
6d723736 448#endif
93eb677d 449#ifdef CONFIG_FTRACE_MCOUNT_RECORD
93eb677d 450 unsigned int num_ftrace_callsites;
a288bd65 451 unsigned long *ftrace_callsites;
93eb677d 452#endif
1ba28e02 453
8cb2c2dc 454#ifdef CONFIG_LIVEPATCH
1ce15ef4 455 bool klp; /* Is this a livepatch module? */
8cb2c2dc 456 bool klp_alive;
1ce15ef4
JY
457
458 /* Elf information */
459 struct klp_modinfo *klp_info;
8cb2c2dc
PM
460#endif
461
af540689
RK
462#ifdef CONFIG_MODULE_UNLOAD
463 /* What modules depend on me? */
2c02dfe7
LT
464 struct list_head source_list;
465 /* What modules do I depend on? */
466 struct list_head target_list;
af540689 467
af540689
RK
468 /* Destruction function. */
469 void (*exit)(void);
470
2f35c41f 471 atomic_t refcnt;
af540689 472#endif
b99b87f7
PO
473
474#ifdef CONFIG_CONSTRUCTORS
475 /* Constructor functions. */
476 ctor_fn_t *ctors;
477 unsigned int num_ctors;
478#endif
92ace999 479
540adea3 480#ifdef CONFIG_FUNCTION_ERROR_INJECTION
663faf9f 481 struct error_injection_entry *ei_funcs;
540adea3 482 unsigned int num_ei_funcs;
92ace999 483#endif
3859a271 484} ____cacheline_aligned __randomize_layout;
e61a1c1c
RZ
485#ifndef MODULE_ARCH_INIT
486#define MODULE_ARCH_INIT {}
487#endif
1da177e4 488
c6b37801
TA
489extern struct mutex module_mutex;
490
1da177e4
LT
491/* FIXME: It'd be nice to isolate modules during init, too, so they
492 aren't used before they (may) fail. But presently too much code
493 (IDE & SCSI) require entry into the module during init.*/
171d864e 494static inline bool module_is_live(struct module *mod)
1da177e4
LT
495{
496 return mod->state != MODULE_STATE_GOING;
497}
498
1da177e4 499struct module *__module_text_address(unsigned long addr);
e610499e
RR
500struct module *__module_address(unsigned long addr);
501bool is_module_address(unsigned long addr);
383776fa 502bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
10fad5e4 503bool is_module_percpu_address(unsigned long addr);
e610499e 504bool is_module_text_address(unsigned long addr);
1da177e4 505
76681c8f
PM
506static inline bool within_module_core(unsigned long addr,
507 const struct module *mod)
a06f6211 508{
7523e4dc
RR
509 return (unsigned long)mod->core_layout.base <= addr &&
510 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
a06f6211
MH
511}
512
76681c8f
PM
513static inline bool within_module_init(unsigned long addr,
514 const struct module *mod)
a06f6211 515{
7523e4dc
RR
516 return (unsigned long)mod->init_layout.base <= addr &&
517 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
a06f6211
MH
518}
519
76681c8f 520static inline bool within_module(unsigned long addr, const struct module *mod)
9b20a352
PM
521{
522 return within_module_init(addr, mod) || within_module_core(addr, mod);
523}
524
c6b37801
TA
525/* Search for module by name: must hold module_mutex. */
526struct module *find_module(const char *name);
527
528struct symsearch {
529 const struct kernel_symbol *start, *stop;
71810db2 530 const s32 *crcs;
c6b37801
TA
531 enum {
532 NOT_GPL_ONLY,
533 GPL_ONLY,
534 WILL_BE_GPL_ONLY,
535 } licence;
536 bool unused;
537};
538
0be964be
PZ
539/*
540 * Search for an exported symbol by name.
541 *
542 * Must be called with module_mutex held or preemption disabled.
543 */
c6b37801
TA
544const struct kernel_symbol *find_symbol(const char *name,
545 struct module **owner,
71810db2 546 const s32 **crc,
c6b37801
TA
547 bool gplok,
548 bool warn);
549
0be964be
PZ
550/*
551 * Walk the exported symbol table
552 *
553 * Must be called with module_mutex held or preemption disabled.
554 */
de4d8d53
RR
555bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
556 struct module *owner,
557 void *data), void *data);
c6b37801 558
ea07890a 559/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
1da177e4 560 symnum out of range. */
ea07890a
AD
561int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
562 char *name, char *module_name, int *exported);
1da177e4
LT
563
564/* Look for this name: can be of form module:name. */
565unsigned long module_kallsyms_lookup_name(const char *name);
566
75a66614
AK
567int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
568 struct module *, unsigned long),
569 void *data);
570
bf262dce
JK
571extern void __noreturn __module_put_and_exit(struct module *mod,
572 long code);
74e22fac 573#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
1da177e4
LT
574
575#ifdef CONFIG_MODULE_UNLOAD
d5db139a 576int module_refcount(struct module *mod);
1da177e4 577void __symbol_put(const char *symbol);
996302c5 578#define symbol_put(x) __symbol_put(__stringify(x))
1da177e4
LT
579void symbol_put_addr(void *addr);
580
581/* Sometimes we know we already have a refcount, and it's easier not
582 to handle the error case (which only happens with rmmod --wait). */
d53799be 583extern void __module_get(struct module *module);
e1783a24 584
d53799be
SR
585/* This is the Right Way to get a module: if it fails, it's being removed,
586 * so pretend it's not there. */
587extern bool try_module_get(struct module *module);
1da177e4 588
f6a57033 589extern void module_put(struct module *module);
1da177e4
LT
590
591#else /*!CONFIG_MODULE_UNLOAD*/
8ba4fcdf 592static inline bool try_module_get(struct module *module)
1da177e4
LT
593{
594 return !module || module_is_live(module);
595}
596static inline void module_put(struct module *module)
597{
598}
599static inline void __module_get(struct module *module)
600{
601}
e865d06b
SL
602#define symbol_put(x) do { } while (0)
603#define symbol_put_addr(p) do { } while (0)
1da177e4
LT
604
605#endif /* CONFIG_MODULE_UNLOAD */
dfd62d1d 606int ref_module(struct module *a, struct module *b);
1da177e4
LT
607
608/* This is a #define so the string doesn't get put in every .o file */
609#define module_name(mod) \
610({ \
611 struct module *__mod = (mod); \
612 __mod ? __mod->name : "kernel"; \
613})
614
b865ea64
SS
615/* Dereference module function descriptor */
616void *dereference_module_function_descriptor(struct module *mod, void *ptr);
617
6dd06c9f
RR
618/* For kallsyms to ask for address resolution. namebuf should be at
619 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
620 * found, otherwise NULL. */
92dfc9dc 621const char *module_address_lookup(unsigned long addr,
6dd06c9f
RR
622 unsigned long *symbolsize,
623 unsigned long *offset,
624 char **modname,
625 char *namebuf);
9d65cb4a 626int lookup_module_symbol_name(unsigned long addr, char *symname);
a5c43dae 627int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
1da177e4 628
e865d06b
SL
629int register_module_notifier(struct notifier_block *nb);
630int unregister_module_notifier(struct notifier_block *nb);
1da177e4
LT
631
632extern void print_modules(void);
633
80c6e146
DT
634static inline bool module_requested_async_probing(struct module *module)
635{
636 return module && module->async_probe_requested;
637}
638
1ce15ef4
JY
639#ifdef CONFIG_LIVEPATCH
640static inline bool is_livepatch_module(struct module *mod)
641{
642 return mod->klp;
643}
644#else /* !CONFIG_LIVEPATCH */
645static inline bool is_livepatch_module(struct module *mod)
646{
647 return false;
648}
649#endif /* CONFIG_LIVEPATCH */
650
fda784e5
BM
651bool is_module_sig_enforced(void);
652
1da177e4 653#else /* !CONFIG_MODULES... */
1da177e4 654
e610499e
RR
655static inline struct module *__module_address(unsigned long addr)
656{
657 return NULL;
658}
659
1da177e4
LT
660static inline struct module *__module_text_address(unsigned long addr)
661{
662 return NULL;
663}
664
e610499e
RR
665static inline bool is_module_address(unsigned long addr)
666{
667 return false;
668}
669
d5e50daf
RD
670static inline bool is_module_percpu_address(unsigned long addr)
671{
672 return false;
673}
674
383776fa
TG
675static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
676{
677 return false;
678}
679
e610499e 680static inline bool is_module_text_address(unsigned long addr)
4d435f9d 681{
e610499e 682 return false;
4d435f9d
IM
683}
684
1da177e4
LT
685/* Get/put a kernel symbol (calls should be symmetric) */
686#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
e865d06b
SL
687#define symbol_put(x) do { } while (0)
688#define symbol_put_addr(x) do { } while (0)
1da177e4
LT
689
690static inline void __module_get(struct module *module)
691{
692}
693
8ba4fcdf 694static inline bool try_module_get(struct module *module)
1da177e4 695{
8ba4fcdf 696 return true;
1da177e4
LT
697}
698
699static inline void module_put(struct module *module)
700{
701}
702
703#define module_name(mod) "kernel"
704
1da177e4 705/* For kallsyms to ask for address resolution. NULL means not found. */
92dfc9dc 706static inline const char *module_address_lookup(unsigned long addr,
6dd06c9f
RR
707 unsigned long *symbolsize,
708 unsigned long *offset,
709 char **modname,
710 char *namebuf)
1da177e4
LT
711{
712 return NULL;
713}
714
9d65cb4a
AD
715static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
716{
717 return -ERANGE;
718}
719
a5c43dae
AD
720static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
721{
722 return -ERANGE;
723}
724
ea07890a
AD
725static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
726 char *type, char *name,
727 char *module_name, int *exported)
1da177e4 728{
ea07890a 729 return -ERANGE;
1da177e4
LT
730}
731
732static inline unsigned long module_kallsyms_lookup_name(const char *name)
733{
734 return 0;
735}
736
75a66614
AK
737static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
738 struct module *,
739 unsigned long),
740 void *data)
741{
742 return 0;
743}
744
e865d06b 745static inline int register_module_notifier(struct notifier_block *nb)
1da177e4
LT
746{
747 /* no events will happen anyway, so this can always succeed */
748 return 0;
749}
750
e865d06b 751static inline int unregister_module_notifier(struct notifier_block *nb)
1da177e4
LT
752{
753 return 0;
754}
755
756#define module_put_and_exit(code) do_exit(code)
757
758static inline void print_modules(void)
759{
760}
80c6e146
DT
761
762static inline bool module_requested_async_probing(struct module *module)
763{
764 return false;
765}
766
fda784e5
BM
767static inline bool is_module_sig_enforced(void)
768{
769 return false;
770}
771
b865ea64
SS
772/* Dereference module function descriptor */
773static inline
774void *dereference_module_function_descriptor(struct module *mod, void *ptr)
775{
776 return ptr;
777}
778
ef665c1a
RD
779#endif /* CONFIG_MODULES */
780
ef665c1a 781#ifdef CONFIG_SYSFS
7405c1e1
GKH
782extern struct kset *module_kset;
783extern struct kobj_type module_ktype;
784extern int module_sysfs_initialized;
ef665c1a
RD
785#endif /* CONFIG_SYSFS */
786
1da177e4
LT
787#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
788
789/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
790
1da177e4
LT
791#define __MODULE_STRING(x) __stringify(x)
792
0f5bf6d0 793#ifdef CONFIG_STRICT_MODULE_RWX
84e1c6bb
MC
794extern void set_all_modules_text_rw(void);
795extern void set_all_modules_text_ro(void);
444d13ff 796extern void module_enable_ro(const struct module *mod, bool after_init);
85c898db 797extern void module_disable_ro(const struct module *mod);
84e1c6bb
MC
798#else
799static inline void set_all_modules_text_rw(void) { }
800static inline void set_all_modules_text_ro(void) { }
444d13ff 801static inline void module_enable_ro(const struct module *mod, bool after_init) { }
85c898db 802static inline void module_disable_ro(const struct module *mod) { }
84e1c6bb 803#endif
0d9c25dd
AM
804
805#ifdef CONFIG_GENERIC_BUG
5336377d 806void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
0d9c25dd
AM
807 struct module *);
808void module_bug_cleanup(struct module *);
809
810#else /* !CONFIG_GENERIC_BUG */
811
5336377d 812static inline void module_bug_finalize(const Elf_Ehdr *hdr,
0d9c25dd
AM
813 const Elf_Shdr *sechdrs,
814 struct module *mod)
815{
0d9c25dd
AM
816}
817static inline void module_bug_cleanup(struct module *mod) {}
818#endif /* CONFIG_GENERIC_BUG */
819
caf7501a
AK
820#ifdef RETPOLINE
821extern bool retpoline_module_ok(bool has_retpoline);
822#else
823static inline bool retpoline_module_ok(bool has_retpoline)
824{
825 return true;
826}
827#endif
828
59afdc7b
HX
829#ifdef CONFIG_MODULE_SIG
830static inline bool module_sig_ok(struct module *module)
831{
832 return module->sig_ok;
833}
834#else /* !CONFIG_MODULE_SIG */
835static inline bool module_sig_ok(struct module *module)
836{
837 return true;
838}
839#endif /* CONFIG_MODULE_SIG */
840
1da177e4 841#endif /* _LINUX_MODULE_H */