blob: 5f147dd5e7099ad90029310f508c29b88d5a9626 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/list.h>
10#include <linux/stat.h>
11#include <linux/compiler.h>
12#include <linux/cache.h>
13#include <linux/kmod.h>
Paul Gortmaker0fd972a2015-05-01 20:13:42 -040014#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/elf.h>
16#include <linux/stringify.h>
17#include <linux/kobject.h>
18#include <linux/moduleparam.h>
Steven Rostedt (Red Hat)b2e285f2014-02-26 13:12:06 -050019#include <linux/jump_label.h>
Paul Gortmakerf5016932011-05-23 14:11:39 -040020#include <linux/export.h>
Peter Zijlstra93c2e102015-05-27 11:09:37 +093021#include <linux/rbtree_latch.h>
Masami Hiramatsu663faf92018-01-13 02:55:33 +090022#include <linux/error-injection.h>
Mathieu Desnoyers9c0be3f2018-10-13 15:10:50 -040023#include <linux/tracepoint-defs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Christoph Lametere1783a22010-01-05 15:34:50 +090025#include <linux/percpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <asm/module.h>
27
Rusty Russell106a4ee2012-09-26 10:09:40 +010028/* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
29#define MODULE_SIG_STRING "~Module signature appended~\n"
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031/* Not Yet Implemented */
32#define MODULE_SUPPORTED_DEVICE(name)
33
Rusty Russell730b69d2008-10-22 10:00:22 -050034#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Seunghun Leee865d062014-01-16 10:18:49 +103036struct modversion_info {
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 unsigned long crc;
38 char name[MODULE_NAME_LEN];
39};
40
41struct module;
Paul Gortmaker0ef76532016-07-27 12:06:34 +093042struct exception_table_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Kay Sievers4befb022011-07-24 22:06:04 +093044struct module_kobject {
45 struct kobject kobj;
46 struct module *mod;
47 struct kobject *drivers_dir;
48 struct module_param_attrs *mp;
Li Zhong942e4432013-09-03 16:33:57 +093049 struct completion *kobj_completion;
Kees Cook3859a272016-10-28 01:22:25 -070050} __randomize_layout;
Kay Sievers4befb022011-07-24 22:06:04 +093051
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct module_attribute {
Kay Sievers4befb022011-07-24 22:06:04 +093053 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 *,
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 const char *, size_t count);
Matt Domschc988d2b2005-06-23 22:05:15 -070058 void (*setup)(struct module *, const char *);
59 int (*test)(struct module *);
60 void (*free)(struct module *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061};
62
Dmitry Torokhove94965e2010-12-15 14:00:19 -080063struct module_version_attribute {
64 struct module_attribute mattr;
65 const char *module_name;
66 const char *version;
Dmitry Torokhov98562ad2011-02-04 13:30:10 -080067} __attribute__ ((__aligned__(sizeof(void *))));
Dmitry Torokhove94965e2010-12-15 14:00:19 -080068
Dmitry Torokhov9b73a582011-02-07 16:02:27 -080069extern ssize_t __modver_version_show(struct module_attribute *,
Kay Sievers4befb022011-07-24 22:06:04 +093070 struct module_kobject *, char *);
Dmitry Torokhov9b73a582011-02-07 16:02:27 -080071
Kay Sievers88bfa322011-07-24 22:06:04 +093072extern struct module_attribute module_uevent;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74/* These are either module local, or the kernel's dummy ones. */
75extern int init_module(void);
76extern void cleanup_module(void);
77
Paul Gortmaker0fd972a2015-05-01 20:13:42 -040078#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)
Paul Gortmaker0fd972a2015-05-01 20:13:42 -0400127
128/* Each module must use one module_init(). */
129#define module_init(initfn) \
Arnd Bergmann1f318a82017-02-01 18:00:14 +0100130 static inline initcall_t __maybe_unused __inittest(void) \
Paul Gortmaker0fd972a2015-05-01 20:13:42 -0400131 { 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) \
Arnd Bergmann1f318a82017-02-01 18:00:14 +0100136 static inline exitcall_t __maybe_unused __exittest(void) \
Paul Gortmaker0fd972a2015-05-01 20:13:42 -0400137 { 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160/* 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
Andreas Robinson7cb14ba2013-08-20 15:33:19 +0930166/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171/*
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]
Xose Vazquez Perez8d27e902006-06-23 02:05:13 -0700180 * "Dual MIT/GPL" [GNU Public License v2
181 * or MIT license choice]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 * "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
Seunghun Leee865d062014-01-16 10:18:49 +1030194 * 1. So modinfo can show license info for users wanting to vet their setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 * 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
Johannes Berg1d7015c2009-09-25 00:32:58 -0600201/*
202 * Author(s), use "Name <email>" or just "Name", for multiple
203 * authors use multiple MODULE_AUTHOR() statements/lines.
204 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
Seunghun Leee865d062014-01-16 10:18:49 +1030206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207/* What your module does. */
208#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
209
Rusty Russellcff26a52014-02-03 11:15:13 +1030210#ifdef MODULE
211/* Creates an alias so file2alias.c can find device table. */
212#define MODULE_DEVICE_TABLE(type, name) \
Matthias Kaehlcke0bf8bf52017-07-24 18:27:25 -0700213extern typeof(name) __mod_##type##__##name##_device_table \
Rusty Russellcff26a52014-02-03 11:15:13 +1030214 __attribute__ ((unused, alias(__stringify(name))))
215#else /* !MODULE */
216#define MODULE_DEVICE_TABLE(type, name)
217#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219/* Version of form [<epoch>:]<version>[-<extra-version>].
Seunghun Leee865d062014-01-16 10:18:49 +1030220 * 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".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Seunghun Leee865d062014-01-16 10:18:49 +1030225 * <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 */
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800235
Rusty Russell3b90a5b2011-01-24 14:32:51 -0600236#if defined(MODULE) || !defined(CONFIG_SYSFS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800238#else
239#define MODULE_VERSION(_version) \
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800240 static struct module_version_attribute ___modver_attr = { \
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800241 .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, \
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800250 }; \
251 static const struct module_version_attribute \
252 __used __attribute__ ((__section__ ("__modver"))) \
253 * __moduleparam_const __modver_attr = &___modver_attr
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800254#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Jon Masters187afbe2006-08-28 17:08:21 -0500256/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261struct notifier_block;
262
263#ifdef CONFIG_MODULES
264
Dave Young5ed10912010-03-10 15:24:06 -0800265extern int modules_disabled; /* for sysctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266/* Get/put a kernel symbol (calls must be symmetric) */
267void *__symbol_get(const char *symbol);
268void *__symbol_get_gpl(const char *symbol);
Masahiro Yamada996302c2018-06-24 00:37:44 +0900269#define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Rusty Russellc8e21ce2010-06-05 11:17:35 -0600271/* 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
Rusty Russell0d21b0e2013-01-12 11:38:44 +1030278enum 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. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283};
284
Peter Zijlstra93c2e102015-05-27 11:09:37 +0930285struct mod_tree_node {
286 struct module *mod;
287 struct latch_tree_node node;
288};
289
Rusty Russell7523e4d2015-11-26 09:44:08 +1030290struct 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;
Jessica Yu444d13f2016-07-27 12:06:21 +0930299 /* Size of RO after init section */
300 unsigned int ro_after_init_size;
Rusty Russell7523e4d2015-11-26 09:44:08 +1030301
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
Rusty Russell82440622016-02-03 16:55:26 +1030314struct mod_kallsyms {
315 Elf_Sym *symtab;
316 unsigned int num_symtab;
317 char *strtab;
318};
319
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400320#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
Seunghun Leee865d062014-01-16 10:18:49 +1030329struct module {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 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;
Greg Kroah-Hartman03e88ae12006-02-16 13:50:23 -0800340 struct module_attribute *modinfo_attrs;
Matt Domschc988d2b2005-06-23 22:05:15 -0700341 const char *version;
342 const char *srcversion;
Kay Sievers270a6c42007-01-18 13:26:15 +0100343 struct kobject *holders_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
345 /* Exported symbols */
346 const struct kernel_symbol *syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000347 const s32 *crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500348 unsigned int num_syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
Rusty Russelle180a6b2009-03-31 13:05:29 -0600350 /* Kernel parameters. */
Rusty Russellcf2fde72015-06-26 06:44:38 +0930351#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930352 struct mutex param_lock;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930353#endif
Rusty Russelle180a6b2009-03-31 13:05:29 -0600354 struct kernel_param *kp;
355 unsigned int num_kp;
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 /* GPL-only exported symbols. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 unsigned int num_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500359 const struct kernel_symbol *gpl_syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000360 const s32 *gpl_crcs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500362#ifdef CONFIG_UNUSED_SYMBOLS
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700363 /* unused exported symbols. */
364 const struct kernel_symbol *unused_syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000365 const s32 *unused_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500366 unsigned int num_unused_syms;
367
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700368 /* GPL-only, unused exported symbols. */
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700369 unsigned int num_unused_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500370 const struct kernel_symbol *unused_gpl_syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000371 const s32 *unused_gpl_crcs;
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500372#endif
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700373
Rusty Russell106a4ee2012-09-26 10:09:40 +0100374#ifdef CONFIG_MODULE_SIG
375 /* Signature was verified. */
376 bool sig_ok;
377#endif
378
Luis R. Rodriguezf2411da2015-03-30 16:20:05 -0700379 bool async_probe_requested;
380
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800381 /* symbols that will be GPL-only in the near future. */
382 const struct kernel_symbol *gpl_future_syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000383 const s32 *gpl_future_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500384 unsigned int num_gpl_future_syms;
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 /* Exception table */
387 unsigned int num_exentries;
Rusty Russell5e458cc2008-10-22 10:00:13 -0500388 struct exception_table_entry *extable;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390 /* Startup function. */
391 int (*init)(void);
392
Rusty Russell7523e4d2015-11-26 09:44:08 +1030393 /* Core layout: rbtree is accessed frequently, so keep together. */
394 struct module_layout core_layout __module_layout_align;
395 struct module_layout init_layout;
matthieu castet84e1c6b2010-11-16 22:35:16 +0100396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 /* Arch-specific module values */
398 struct mod_arch_specific arch;
399
Petr Mladek7fd83292016-09-21 13:47:22 +0200400 unsigned long taints; /* same bits as kernel:taint_flags */
Randy Dunlap2bc2d612006-10-02 02:17:02 -0700401
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800402#ifdef CONFIG_GENERIC_BUG
403 /* Support for BUG */
Richard Kennedyaf540682008-07-22 19:24:26 -0500404 unsigned num_bugs;
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800405 struct list_head bug_list;
406 struct bug_entry *bug_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407#endif
408
409#ifdef CONFIG_KALLSYMS
Rusty Russell82440622016-02-03 16:55:26 +1030410 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
411 struct mod_kallsyms *kallsyms;
412 struct mod_kallsyms core_kallsyms;
Anson Jacobc7149652016-10-19 19:12:18 -0400413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 /* Section attributes */
415 struct module_sect_attrs *sect_attrs;
Roland McGrath6d760132007-10-16 23:26:40 -0700416
417 /* Notes attributes */
418 struct module_notes_attrs *notes_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419#endif
420
Richard Kennedya288bd62011-05-19 16:55:25 -0600421 /* The command line arguments (may be mangled). People like
422 keeping pointers to this stuff */
423 char *args;
424
Tejun Heo259354d2010-03-10 18:56:10 +0900425#ifdef CONFIG_SMP
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 /* Per-cpu data. */
Tejun Heo259354d2010-03-10 18:56:10 +0900427 void __percpu *percpu;
428 unsigned int percpu_size;
429#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400431#ifdef CONFIG_TRACEPOINTS
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400432 unsigned int num_tracepoints;
Mathieu Desnoyers9c0be3f2018-10-13 15:10:50 -0400433 tracepoint_ptr_t *tracepoints_ptrs;
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400434#endif
Matt Mullinsa38d1102018-12-12 16:42:37 -0800435#ifdef CONFIG_BPF_EVENTS
436 unsigned int num_bpf_raw_events;
437 struct bpf_raw_event_map *bpf_raw_events;
438#endif
Jason Baronbf5438fc2010-09-17 11:09:00 -0400439#ifdef HAVE_JUMP_LABEL
440 struct jump_entry *jump_entries;
441 unsigned int num_jump_entries;
442#endif
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100443#ifdef CONFIG_TRACING
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100444 unsigned int num_trace_bprintk_fmt;
Richard Kennedya288bd62011-05-19 16:55:25 -0600445 const char **trace_bprintk_fmt_start;
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100446#endif
Steven Rostedt6d723732009-04-10 14:53:50 -0400447#ifdef CONFIG_EVENT_TRACING
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -0400448 struct trace_event_call **trace_events;
Steven Rostedt6d723732009-04-10 14:53:50 -0400449 unsigned int num_trace_events;
Jeremy Linton99be6472017-05-31 16:56:44 -0500450 struct trace_eval_map **trace_evals;
451 unsigned int num_trace_evals;
Steven Rostedt6d723732009-04-10 14:53:50 -0400452#endif
Steven Rostedt93eb6772009-04-15 13:24:06 -0400453#ifdef CONFIG_FTRACE_MCOUNT_RECORD
Steven Rostedt93eb6772009-04-15 13:24:06 -0400454 unsigned int num_ftrace_callsites;
Richard Kennedya288bd62011-05-19 16:55:25 -0600455 unsigned long *ftrace_callsites;
Steven Rostedt93eb6772009-04-15 13:24:06 -0400456#endif
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100457
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100458#ifdef CONFIG_LIVEPATCH
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400459 bool klp; /* Is this a livepatch module? */
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100460 bool klp_alive;
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400461
462 /* Elf information */
463 struct klp_modinfo *klp_info;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100464#endif
465
Richard Kennedyaf540682008-07-22 19:24:26 -0500466#ifdef CONFIG_MODULE_UNLOAD
467 /* What modules depend on me? */
Linus Torvalds2c02dfe2010-05-31 12:19:37 -0700468 struct list_head source_list;
469 /* What modules do I depend on? */
470 struct list_head target_list;
Richard Kennedyaf540682008-07-22 19:24:26 -0500471
Richard Kennedyaf540682008-07-22 19:24:26 -0500472 /* Destruction function. */
473 void (*exit)(void);
474
Masami Hiramatsu2f35c412014-11-10 09:29:29 +1030475 atomic_t refcnt;
Richard Kennedyaf540682008-07-22 19:24:26 -0500476#endif
Peter Oberparleiterb99b87f2009-06-17 16:28:03 -0700477
478#ifdef CONFIG_CONSTRUCTORS
479 /* Constructor functions. */
480 ctor_fn_t *ctors;
481 unsigned int num_ctors;
482#endif
Josef Bacik92ace992017-12-11 11:36:46 -0500483
Masami Hiramatsu540adea2018-01-13 02:55:03 +0900484#ifdef CONFIG_FUNCTION_ERROR_INJECTION
Masami Hiramatsu663faf92018-01-13 02:55:33 +0900485 struct error_injection_entry *ei_funcs;
Masami Hiramatsu540adea2018-01-13 02:55:03 +0900486 unsigned int num_ei_funcs;
Josef Bacik92ace992017-12-11 11:36:46 -0500487#endif
Kees Cook3859a272016-10-28 01:22:25 -0700488} ____cacheline_aligned __randomize_layout;
Roman Zippele61a1c12007-05-09 02:35:15 -0700489#ifndef MODULE_ARCH_INIT
490#define MODULE_ARCH_INIT {}
491#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
Tim Abbottc6b37802008-12-05 19:03:59 -0500493extern struct mutex module_mutex;
494
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495/* FIXME: It'd be nice to isolate modules during init, too, so they
496 aren't used before they (may) fail. But presently too much code
497 (IDE & SCSI) require entry into the module during init.*/
Yaowei Bai171d8642018-02-06 15:41:31 -0800498static inline bool module_is_live(struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499{
500 return mod->state != MODULE_STATE_GOING;
501}
502
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503struct module *__module_text_address(unsigned long addr);
Rusty Russelle6104992009-03-31 13:05:31 -0600504struct module *__module_address(unsigned long addr);
505bool is_module_address(unsigned long addr);
Thomas Gleixner383776f2017-02-27 15:37:36 +0100506bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
Tejun Heo10fad5e2010-03-10 18:57:54 +0900507bool is_module_percpu_address(unsigned long addr);
Rusty Russelle6104992009-03-31 13:05:31 -0600508bool is_module_text_address(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Petr Mladek76681c82014-07-27 07:25:01 +0930510static inline bool within_module_core(unsigned long addr,
511 const struct module *mod)
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800512{
Rusty Russell7523e4d2015-11-26 09:44:08 +1030513 return (unsigned long)mod->core_layout.base <= addr &&
514 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800515}
516
Petr Mladek76681c82014-07-27 07:25:01 +0930517static inline bool within_module_init(unsigned long addr,
518 const struct module *mod)
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800519{
Rusty Russell7523e4d2015-11-26 09:44:08 +1030520 return (unsigned long)mod->init_layout.base <= addr &&
521 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800522}
523
Petr Mladek76681c82014-07-27 07:25:01 +0930524static inline bool within_module(unsigned long addr, const struct module *mod)
Petr Mladek9b20a352014-07-27 07:24:01 +0930525{
526 return within_module_init(addr, mod) || within_module_core(addr, mod);
527}
528
Tim Abbottc6b37802008-12-05 19:03:59 -0500529/* Search for module by name: must hold module_mutex. */
530struct module *find_module(const char *name);
531
532struct symsearch {
533 const struct kernel_symbol *start, *stop;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000534 const s32 *crcs;
Tim Abbottc6b37802008-12-05 19:03:59 -0500535 enum {
536 NOT_GPL_ONLY,
537 GPL_ONLY,
538 WILL_BE_GPL_ONLY,
539 } licence;
540 bool unused;
541};
542
Peter Zijlstra0be964b2015-05-27 11:09:35 +0930543/*
544 * Search for an exported symbol by name.
545 *
546 * Must be called with module_mutex held or preemption disabled.
547 */
Tim Abbottc6b37802008-12-05 19:03:59 -0500548const struct kernel_symbol *find_symbol(const char *name,
549 struct module **owner,
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000550 const s32 **crc,
Tim Abbottc6b37802008-12-05 19:03:59 -0500551 bool gplok,
552 bool warn);
553
Peter Zijlstra0be964b2015-05-27 11:09:35 +0930554/*
555 * Walk the exported symbol table
556 *
557 * Must be called with module_mutex held or preemption disabled.
558 */
Rusty Russellde4d8d52011-04-19 21:49:58 +0200559bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
560 struct module *owner,
561 void *data), void *data);
Tim Abbottc6b37802008-12-05 19:03:59 -0500562
Alexey Dobriyanea078902007-05-08 00:28:39 -0700563/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 symnum out of range. */
Alexey Dobriyanea078902007-05-08 00:28:39 -0700565int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
566 char *name, char *module_name, int *exported);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
568/* Look for this name: can be of form module:name. */
569unsigned long module_kallsyms_lookup_name(const char *name);
570
Anders Kaseorg75a66612008-12-05 19:03:58 -0500571int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
572 struct module *, unsigned long),
573 void *data);
574
Jiri Kosinabf262dc2016-04-12 05:02:09 +0930575extern void __noreturn __module_put_and_exit(struct module *mod,
576 long code);
Joe Perches74e22fa2013-12-04 14:09:38 +1030577#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
579#ifdef CONFIG_MODULE_UNLOAD
Rusty Russelld5db1392015-01-22 11:13:14 +1030580int module_refcount(struct module *mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581void __symbol_put(const char *symbol);
Masahiro Yamada996302c2018-06-24 00:37:44 +0900582#define symbol_put(x) __symbol_put(__stringify(x))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583void symbol_put_addr(void *addr);
584
585/* Sometimes we know we already have a refcount, and it's easier not
586 to handle the error case (which only happens with rmmod --wait). */
Steven Rostedtd53799b2012-03-26 12:50:52 +1030587extern void __module_get(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Steven Rostedtd53799b2012-03-26 12:50:52 +1030589/* This is the Right Way to get a module: if it fails, it's being removed,
590 * so pretend it's not there. */
591extern bool try_module_get(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Al Virof6a57032006-10-18 01:47:25 -0400593extern void module_put(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
595#else /*!CONFIG_MODULE_UNLOAD*/
Gao Feng8ba4fcd2017-04-19 09:47:22 +0800596static inline bool try_module_get(struct module *module)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597{
598 return !module || module_is_live(module);
599}
600static inline void module_put(struct module *module)
601{
602}
603static inline void __module_get(struct module *module)
604{
605}
Seunghun Leee865d062014-01-16 10:18:49 +1030606#define symbol_put(x) do { } while (0)
607#define symbol_put_addr(p) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
609#endif /* CONFIG_MODULE_UNLOAD */
Anders Kaseorgdfd62d12010-11-24 15:21:10 -0600610int ref_module(struct module *a, struct module *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
612/* This is a #define so the string doesn't get put in every .o file */
613#define module_name(mod) \
614({ \
615 struct module *__mod = (mod); \
616 __mod ? __mod->name : "kernel"; \
617})
618
Sergey Senozhatskyb865ea62017-11-10 08:48:25 +0900619/* Dereference module function descriptor */
620void *dereference_module_function_descriptor(struct module *mod, void *ptr);
621
Rusty Russell6dd06c92008-01-29 17:13:22 -0500622/* For kallsyms to ask for address resolution. namebuf should be at
623 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
624 * found, otherwise NULL. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800625const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500626 unsigned long *symbolsize,
627 unsigned long *offset,
628 char **modname,
629 char *namebuf);
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700630int lookup_module_symbol_name(unsigned long addr, char *symname);
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700631int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Seunghun Leee865d062014-01-16 10:18:49 +1030633int register_module_notifier(struct notifier_block *nb);
634int unregister_module_notifier(struct notifier_block *nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
636extern void print_modules(void);
637
Dmitry Torokhov80c6e142015-05-21 15:49:37 -0700638static inline bool module_requested_async_probing(struct module *module)
639{
640 return module && module->async_probe_requested;
641}
642
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400643#ifdef CONFIG_LIVEPATCH
644static inline bool is_livepatch_module(struct module *mod)
645{
646 return mod->klp;
647}
648#else /* !CONFIG_LIVEPATCH */
649static inline bool is_livepatch_module(struct module *mod)
650{
651 return false;
652}
653#endif /* CONFIG_LIVEPATCH */
654
Bruno E. O. Meneguelefda784e2017-10-24 15:37:00 -0200655bool is_module_sig_enforced(void);
656
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657#else /* !CONFIG_MODULES... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
Rusty Russelle6104992009-03-31 13:05:31 -0600659static inline struct module *__module_address(unsigned long addr)
660{
661 return NULL;
662}
663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664static inline struct module *__module_text_address(unsigned long addr)
665{
666 return NULL;
667}
668
Rusty Russelle6104992009-03-31 13:05:31 -0600669static inline bool is_module_address(unsigned long addr)
Ingo Molnar4d435f92006-07-03 00:24:24 -0700670{
Rusty Russelle6104992009-03-31 13:05:31 -0600671 return false;
672}
673
Randy Dunlapd5e50da2010-03-31 11:33:42 +0900674static inline bool is_module_percpu_address(unsigned long addr)
675{
676 return false;
677}
678
Thomas Gleixner383776f2017-02-27 15:37:36 +0100679static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
680{
681 return false;
682}
683
Rusty Russelle6104992009-03-31 13:05:31 -0600684static inline bool is_module_text_address(unsigned long addr)
685{
686 return false;
Ingo Molnar4d435f92006-07-03 00:24:24 -0700687}
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689/* Get/put a kernel symbol (calls should be symmetric) */
690#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
Seunghun Leee865d062014-01-16 10:18:49 +1030691#define symbol_put(x) do { } while (0)
692#define symbol_put_addr(x) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
694static inline void __module_get(struct module *module)
695{
696}
697
Gao Feng8ba4fcd2017-04-19 09:47:22 +0800698static inline bool try_module_get(struct module *module)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699{
Gao Feng8ba4fcd2017-04-19 09:47:22 +0800700 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701}
702
703static inline void module_put(struct module *module)
704{
705}
706
707#define module_name(mod) "kernel"
708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709/* For kallsyms to ask for address resolution. NULL means not found. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800710static inline const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500711 unsigned long *symbolsize,
712 unsigned long *offset,
713 char **modname,
714 char *namebuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715{
716 return NULL;
717}
718
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700719static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
720{
721 return -ERANGE;
722}
723
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700724static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
725{
726 return -ERANGE;
727}
728
Alexey Dobriyanea078902007-05-08 00:28:39 -0700729static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
730 char *type, char *name,
731 char *module_name, int *exported)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732{
Alexey Dobriyanea078902007-05-08 00:28:39 -0700733 return -ERANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734}
735
736static inline unsigned long module_kallsyms_lookup_name(const char *name)
737{
738 return 0;
739}
740
Anders Kaseorg75a66612008-12-05 19:03:58 -0500741static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
742 struct module *,
743 unsigned long),
744 void *data)
745{
746 return 0;
747}
748
Seunghun Leee865d062014-01-16 10:18:49 +1030749static inline int register_module_notifier(struct notifier_block *nb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750{
751 /* no events will happen anyway, so this can always succeed */
752 return 0;
753}
754
Seunghun Leee865d062014-01-16 10:18:49 +1030755static inline int unregister_module_notifier(struct notifier_block *nb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
757 return 0;
758}
759
760#define module_put_and_exit(code) do_exit(code)
761
762static inline void print_modules(void)
763{
764}
Dmitry Torokhov80c6e142015-05-21 15:49:37 -0700765
766static inline bool module_requested_async_probing(struct module *module)
767{
768 return false;
769}
770
Bruno E. O. Meneguelefda784e2017-10-24 15:37:00 -0200771static inline bool is_module_sig_enforced(void)
772{
773 return false;
774}
775
Sergey Senozhatskyb865ea62017-11-10 08:48:25 +0900776/* Dereference module function descriptor */
777static inline
778void *dereference_module_function_descriptor(struct module *mod, void *ptr)
779{
780 return ptr;
781}
782
Randy Dunlapef665c12007-02-13 15:19:06 -0800783#endif /* CONFIG_MODULES */
784
Randy Dunlapef665c12007-02-13 15:19:06 -0800785#ifdef CONFIG_SYSFS
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700786extern struct kset *module_kset;
787extern struct kobj_type module_ktype;
788extern int module_sysfs_initialized;
Randy Dunlapef665c12007-02-13 15:19:06 -0800789#endif /* CONFIG_SYSFS */
790
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
792
793/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
794
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795#define __MODULE_STRING(x) __stringify(x)
796
Laura Abbott0f5bf6d2017-02-06 16:31:58 -0800797#ifdef CONFIG_STRICT_MODULE_RWX
matthieu castet84e1c6b2010-11-16 22:35:16 +0100798extern void set_all_modules_text_rw(void);
799extern void set_all_modules_text_ro(void);
Jessica Yu444d13f2016-07-27 12:06:21 +0930800extern void module_enable_ro(const struct module *mod, bool after_init);
Rusty Russell85c898d2015-11-26 09:45:08 +1030801extern void module_disable_ro(const struct module *mod);
matthieu castet84e1c6b2010-11-16 22:35:16 +0100802#else
803static inline void set_all_modules_text_rw(void) { }
804static inline void set_all_modules_text_ro(void) { }
Jessica Yu444d13f2016-07-27 12:06:21 +0930805static inline void module_enable_ro(const struct module *mod, bool after_init) { }
Rusty Russell85c898d2015-11-26 09:45:08 +1030806static inline void module_disable_ro(const struct module *mod) { }
matthieu castet84e1c6b2010-11-16 22:35:16 +0100807#endif
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700808
809#ifdef CONFIG_GENERIC_BUG
Linus Torvalds53363772010-10-05 11:29:27 -0700810void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700811 struct module *);
812void module_bug_cleanup(struct module *);
813
814#else /* !CONFIG_GENERIC_BUG */
815
Linus Torvalds53363772010-10-05 11:29:27 -0700816static inline void module_bug_finalize(const Elf_Ehdr *hdr,
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700817 const Elf_Shdr *sechdrs,
818 struct module *mod)
819{
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700820}
821static inline void module_bug_cleanup(struct module *mod) {}
822#endif /* CONFIG_GENERIC_BUG */
823
Andi Kleencaf75012018-01-25 15:50:28 -0800824#ifdef RETPOLINE
825extern bool retpoline_module_ok(bool has_retpoline);
826#else
827static inline bool retpoline_module_ok(bool has_retpoline)
828{
829 return true;
830}
831#endif
832
Herbert Xu59afdc72015-04-22 11:28:46 +0800833#ifdef CONFIG_MODULE_SIG
834static inline bool module_sig_ok(struct module *module)
835{
836 return module->sig_ok;
837}
838#else /* !CONFIG_MODULE_SIG */
839static inline bool module_sig_ok(struct module *module)
840{
841 return true;
842}
843#endif /* CONFIG_MODULE_SIG */
844
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845#endif /* _LINUX_MODULE_H */