blob: e19ae08c7fb84fb8c0172639324f5f80cfeb6ea5 [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)
127#define security_initcall(fn) module_init(fn)
128
129/* Each module must use one module_init(). */
130#define module_init(initfn) \
Arnd Bergmann1f318a82017-02-01 18:00:14 +0100131 static inline initcall_t __maybe_unused __inittest(void) \
Paul Gortmaker0fd972a2015-05-01 20:13:42 -0400132 { return initfn; } \
133 int init_module(void) __attribute__((alias(#initfn)));
134
135/* This is only required if you want to be unloadable. */
136#define module_exit(exitfn) \
Arnd Bergmann1f318a82017-02-01 18:00:14 +0100137 static inline exitcall_t __maybe_unused __exittest(void) \
Paul Gortmaker0fd972a2015-05-01 20:13:42 -0400138 { return exitfn; } \
139 void cleanup_module(void) __attribute__((alias(#exitfn)));
140
141#endif
142
143/* This means "can be init if no module support, otherwise module load
144 may call it." */
145#ifdef CONFIG_MODULES
146#define __init_or_module
147#define __initdata_or_module
148#define __initconst_or_module
149#define __INIT_OR_MODULE .text
150#define __INITDATA_OR_MODULE .data
151#define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
152#else
153#define __init_or_module __init
154#define __initdata_or_module __initdata
155#define __initconst_or_module __initconst
156#define __INIT_OR_MODULE __INIT
157#define __INITDATA_OR_MODULE __INITDATA
158#define __INITRODATA_OR_MODULE __INITRODATA
159#endif /*CONFIG_MODULES*/
160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161/* Generic info of form tag = "info" */
162#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
163
164/* For userspace: you can also call me... */
165#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
166
Andreas Robinson7cb14ba2013-08-20 15:33:19 +0930167/* Soft module dependencies. See man modprobe.d for details.
168 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
169 */
170#define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
171
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172/*
173 * The following license idents are currently accepted as indicating free
174 * software modules
175 *
176 * "GPL" [GNU Public License v2 or later]
177 * "GPL v2" [GNU Public License v2]
178 * "GPL and additional rights" [GNU Public License v2 rights and more]
179 * "Dual BSD/GPL" [GNU Public License v2
180 * or BSD license choice]
Xose Vazquez Perez8d27e902006-06-23 02:05:13 -0700181 * "Dual MIT/GPL" [GNU Public License v2
182 * or MIT license choice]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 * "Dual MPL/GPL" [GNU Public License v2
184 * or Mozilla license choice]
185 *
186 * The following other idents are available
187 *
188 * "Proprietary" [Non free products]
189 *
190 * There are dual licensed components, but when running with Linux it is the
191 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
192 * is a GPL combined work.
193 *
194 * This exists for several reasons
Seunghun Leee865d062014-01-16 10:18:49 +1030195 * 1. So modinfo can show license info for users wanting to vet their setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 * is free
197 * 2. So the community can ignore bug reports including proprietary modules
198 * 3. So vendors can do likewise based on their own policies
199 */
200#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
201
Johannes Berg1d7015c2009-09-25 00:32:58 -0600202/*
203 * Author(s), use "Name <email>" or just "Name", for multiple
204 * authors use multiple MODULE_AUTHOR() statements/lines.
205 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
Seunghun Leee865d062014-01-16 10:18:49 +1030207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208/* What your module does. */
209#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
210
Rusty Russellcff26a52014-02-03 11:15:13 +1030211#ifdef MODULE
212/* Creates an alias so file2alias.c can find device table. */
213#define MODULE_DEVICE_TABLE(type, name) \
Matthias Kaehlcke0bf8bf52017-07-24 18:27:25 -0700214extern typeof(name) __mod_##type##__##name##_device_table \
Rusty Russellcff26a52014-02-03 11:15:13 +1030215 __attribute__ ((unused, alias(__stringify(name))))
216#else /* !MODULE */
217#define MODULE_DEVICE_TABLE(type, name)
218#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220/* Version of form [<epoch>:]<version>[-<extra-version>].
Seunghun Leee865d062014-01-16 10:18:49 +1030221 * Or for CVS/RCS ID version, everything but the number is stripped.
222 * <epoch>: A (small) unsigned integer which allows you to start versions
223 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
224 * "1:2.0".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Seunghun Leee865d062014-01-16 10:18:49 +1030226 * <version>: The <version> may contain only alphanumerics and the
227 * character `.'. Ordered by numeric sort for numeric parts,
228 * ascii sort for ascii parts (as per RPM or DEB algorithm).
229
230 * <extraversion>: Like <version>, but inserted for local
231 * customizations, eg "rh3" or "rusty1".
232
233 * Using this automatically adds a checksum of the .c files and the
234 * local headers in "srcversion".
235 */
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800236
Rusty Russell3b90a5b2011-01-24 14:32:51 -0600237#if defined(MODULE) || !defined(CONFIG_SYSFS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800239#else
240#define MODULE_VERSION(_version) \
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800241 static struct module_version_attribute ___modver_attr = { \
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800242 .mattr = { \
243 .attr = { \
244 .name = "version", \
245 .mode = S_IRUGO, \
246 }, \
247 .show = __modver_version_show, \
248 }, \
249 .module_name = KBUILD_MODNAME, \
250 .version = _version, \
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800251 }; \
252 static const struct module_version_attribute \
253 __used __attribute__ ((__section__ ("__modver"))) \
254 * __moduleparam_const __modver_attr = &___modver_attr
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800255#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Jon Masters187afbe2006-08-28 17:08:21 -0500257/* Optional firmware file (or files) needed by the module
258 * format is simply firmware file name. Multiple firmware
259 * files require multiple MODULE_FIRMWARE() specifiers */
260#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262struct notifier_block;
263
264#ifdef CONFIG_MODULES
265
Dave Young5ed10912010-03-10 15:24:06 -0800266extern int modules_disabled; /* for sysctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267/* Get/put a kernel symbol (calls must be symmetric) */
268void *__symbol_get(const char *symbol);
269void *__symbol_get_gpl(const char *symbol);
Masahiro Yamada996302c2018-06-24 00:37:44 +0900270#define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Rusty Russellc8e21ce2010-06-05 11:17:35 -0600272/* modules using other modules: kdb wants to see this. */
273struct module_use {
274 struct list_head source_list;
275 struct list_head target_list;
276 struct module *source, *target;
277};
278
Rusty Russell0d21b0e2013-01-12 11:38:44 +1030279enum module_state {
280 MODULE_STATE_LIVE, /* Normal state. */
281 MODULE_STATE_COMING, /* Full formed, running module_init. */
282 MODULE_STATE_GOING, /* Going away. */
283 MODULE_STATE_UNFORMED, /* Still setting it up. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284};
285
Peter Zijlstra93c2e102015-05-27 11:09:37 +0930286struct mod_tree_node {
287 struct module *mod;
288 struct latch_tree_node node;
289};
290
Rusty Russell7523e4d2015-11-26 09:44:08 +1030291struct module_layout {
292 /* The actual code + data. */
293 void *base;
294 /* Total size. */
295 unsigned int size;
296 /* The size of the executable code. */
297 unsigned int text_size;
298 /* Size of RO section of the module (text+rodata) */
299 unsigned int ro_size;
Jessica Yu444d13f2016-07-27 12:06:21 +0930300 /* Size of RO after init section */
301 unsigned int ro_after_init_size;
Rusty Russell7523e4d2015-11-26 09:44:08 +1030302
303#ifdef CONFIG_MODULES_TREE_LOOKUP
304 struct mod_tree_node mtn;
305#endif
306};
307
308#ifdef CONFIG_MODULES_TREE_LOOKUP
309/* Only touch one cacheline for common rbtree-for-core-layout case. */
310#define __module_layout_align ____cacheline_aligned
311#else
312#define __module_layout_align
313#endif
314
Rusty Russell82440622016-02-03 16:55:26 +1030315struct mod_kallsyms {
316 Elf_Sym *symtab;
317 unsigned int num_symtab;
318 char *strtab;
319};
320
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400321#ifdef CONFIG_LIVEPATCH
322struct klp_modinfo {
323 Elf_Ehdr hdr;
324 Elf_Shdr *sechdrs;
325 char *secstrings;
326 unsigned int symndx;
327};
328#endif
329
Seunghun Leee865d062014-01-16 10:18:49 +1030330struct module {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 enum module_state state;
332
333 /* Member of list of modules */
334 struct list_head list;
335
336 /* Unique handle for this module */
337 char name[MODULE_NAME_LEN];
338
339 /* Sysfs stuff. */
340 struct module_kobject mkobj;
Greg Kroah-Hartman03e88ae12006-02-16 13:50:23 -0800341 struct module_attribute *modinfo_attrs;
Matt Domschc988d2b2005-06-23 22:05:15 -0700342 const char *version;
343 const char *srcversion;
Kay Sievers270a6c42007-01-18 13:26:15 +0100344 struct kobject *holders_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346 /* Exported symbols */
347 const struct kernel_symbol *syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000348 const s32 *crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500349 unsigned int num_syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Rusty Russelle180a6b2009-03-31 13:05:29 -0600351 /* Kernel parameters. */
Rusty Russellcf2fde72015-06-26 06:44:38 +0930352#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930353 struct mutex param_lock;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930354#endif
Rusty Russelle180a6b2009-03-31 13:05:29 -0600355 struct kernel_param *kp;
356 unsigned int num_kp;
357
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 /* GPL-only exported symbols. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 unsigned int num_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500360 const struct kernel_symbol *gpl_syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000361 const s32 *gpl_crcs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500363#ifdef CONFIG_UNUSED_SYMBOLS
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700364 /* unused exported symbols. */
365 const struct kernel_symbol *unused_syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000366 const s32 *unused_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500367 unsigned int num_unused_syms;
368
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700369 /* GPL-only, unused exported symbols. */
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700370 unsigned int num_unused_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500371 const struct kernel_symbol *unused_gpl_syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000372 const s32 *unused_gpl_crcs;
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500373#endif
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700374
Rusty Russell106a4ee2012-09-26 10:09:40 +0100375#ifdef CONFIG_MODULE_SIG
376 /* Signature was verified. */
377 bool sig_ok;
378#endif
379
Luis R. Rodriguezf2411da2015-03-30 16:20:05 -0700380 bool async_probe_requested;
381
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800382 /* symbols that will be GPL-only in the near future. */
383 const struct kernel_symbol *gpl_future_syms;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000384 const s32 *gpl_future_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500385 unsigned int num_gpl_future_syms;
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 /* Exception table */
388 unsigned int num_exentries;
Rusty Russell5e458cc2008-10-22 10:00:13 -0500389 struct exception_table_entry *extable;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 /* Startup function. */
392 int (*init)(void);
393
Rusty Russell7523e4d2015-11-26 09:44:08 +1030394 /* Core layout: rbtree is accessed frequently, so keep together. */
395 struct module_layout core_layout __module_layout_align;
396 struct module_layout init_layout;
matthieu castet84e1c6b2010-11-16 22:35:16 +0100397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 /* Arch-specific module values */
399 struct mod_arch_specific arch;
400
Petr Mladek7fd83292016-09-21 13:47:22 +0200401 unsigned long taints; /* same bits as kernel:taint_flags */
Randy Dunlap2bc2d612006-10-02 02:17:02 -0700402
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800403#ifdef CONFIG_GENERIC_BUG
404 /* Support for BUG */
Richard Kennedyaf540682008-07-22 19:24:26 -0500405 unsigned num_bugs;
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800406 struct list_head bug_list;
407 struct bug_entry *bug_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408#endif
409
410#ifdef CONFIG_KALLSYMS
Rusty Russell82440622016-02-03 16:55:26 +1030411 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
412 struct mod_kallsyms *kallsyms;
413 struct mod_kallsyms core_kallsyms;
Anson Jacobc7149652016-10-19 19:12:18 -0400414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 /* Section attributes */
416 struct module_sect_attrs *sect_attrs;
Roland McGrath6d760132007-10-16 23:26:40 -0700417
418 /* Notes attributes */
419 struct module_notes_attrs *notes_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420#endif
421
Richard Kennedya288bd62011-05-19 16:55:25 -0600422 /* The command line arguments (may be mangled). People like
423 keeping pointers to this stuff */
424 char *args;
425
Tejun Heo259354d2010-03-10 18:56:10 +0900426#ifdef CONFIG_SMP
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 /* Per-cpu data. */
Tejun Heo259354d2010-03-10 18:56:10 +0900428 void __percpu *percpu;
429 unsigned int percpu_size;
430#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400432#ifdef CONFIG_TRACEPOINTS
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400433 unsigned int num_tracepoints;
Mathieu Desnoyers9c0be3f2018-10-13 15:10:50 -0400434 tracepoint_ptr_t *tracepoints_ptrs;
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400435#endif
Jason Baronbf5438fc2010-09-17 11:09:00 -0400436#ifdef HAVE_JUMP_LABEL
437 struct jump_entry *jump_entries;
438 unsigned int num_jump_entries;
439#endif
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100440#ifdef CONFIG_TRACING
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100441 unsigned int num_trace_bprintk_fmt;
Richard Kennedya288bd62011-05-19 16:55:25 -0600442 const char **trace_bprintk_fmt_start;
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100443#endif
Steven Rostedt6d723732009-04-10 14:53:50 -0400444#ifdef CONFIG_EVENT_TRACING
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -0400445 struct trace_event_call **trace_events;
Steven Rostedt6d723732009-04-10 14:53:50 -0400446 unsigned int num_trace_events;
Jeremy Linton99be6472017-05-31 16:56:44 -0500447 struct trace_eval_map **trace_evals;
448 unsigned int num_trace_evals;
Steven Rostedt6d723732009-04-10 14:53:50 -0400449#endif
Steven Rostedt93eb6772009-04-15 13:24:06 -0400450#ifdef CONFIG_FTRACE_MCOUNT_RECORD
Steven Rostedt93eb6772009-04-15 13:24:06 -0400451 unsigned int num_ftrace_callsites;
Richard Kennedya288bd62011-05-19 16:55:25 -0600452 unsigned long *ftrace_callsites;
Steven Rostedt93eb6772009-04-15 13:24:06 -0400453#endif
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100454
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100455#ifdef CONFIG_LIVEPATCH
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400456 bool klp; /* Is this a livepatch module? */
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100457 bool klp_alive;
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400458
459 /* Elf information */
460 struct klp_modinfo *klp_info;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100461#endif
462
Richard Kennedyaf540682008-07-22 19:24:26 -0500463#ifdef CONFIG_MODULE_UNLOAD
464 /* What modules depend on me? */
Linus Torvalds2c02dfe2010-05-31 12:19:37 -0700465 struct list_head source_list;
466 /* What modules do I depend on? */
467 struct list_head target_list;
Richard Kennedyaf540682008-07-22 19:24:26 -0500468
Richard Kennedyaf540682008-07-22 19:24:26 -0500469 /* Destruction function. */
470 void (*exit)(void);
471
Masami Hiramatsu2f35c412014-11-10 09:29:29 +1030472 atomic_t refcnt;
Richard Kennedyaf540682008-07-22 19:24:26 -0500473#endif
Peter Oberparleiterb99b87f2009-06-17 16:28:03 -0700474
475#ifdef CONFIG_CONSTRUCTORS
476 /* Constructor functions. */
477 ctor_fn_t *ctors;
478 unsigned int num_ctors;
479#endif
Josef Bacik92ace992017-12-11 11:36:46 -0500480
Masami Hiramatsu540adea2018-01-13 02:55:03 +0900481#ifdef CONFIG_FUNCTION_ERROR_INJECTION
Masami Hiramatsu663faf92018-01-13 02:55:33 +0900482 struct error_injection_entry *ei_funcs;
Masami Hiramatsu540adea2018-01-13 02:55:03 +0900483 unsigned int num_ei_funcs;
Josef Bacik92ace992017-12-11 11:36:46 -0500484#endif
Kees Cook3859a272016-10-28 01:22:25 -0700485} ____cacheline_aligned __randomize_layout;
Roman Zippele61a1c12007-05-09 02:35:15 -0700486#ifndef MODULE_ARCH_INIT
487#define MODULE_ARCH_INIT {}
488#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
Tim Abbottc6b37802008-12-05 19:03:59 -0500490extern struct mutex module_mutex;
491
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492/* FIXME: It'd be nice to isolate modules during init, too, so they
493 aren't used before they (may) fail. But presently too much code
494 (IDE & SCSI) require entry into the module during init.*/
Yaowei Bai171d8642018-02-06 15:41:31 -0800495static inline bool module_is_live(struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496{
497 return mod->state != MODULE_STATE_GOING;
498}
499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500struct module *__module_text_address(unsigned long addr);
Rusty Russelle6104992009-03-31 13:05:31 -0600501struct module *__module_address(unsigned long addr);
502bool is_module_address(unsigned long addr);
Thomas Gleixner383776f2017-02-27 15:37:36 +0100503bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
Tejun Heo10fad5e2010-03-10 18:57:54 +0900504bool is_module_percpu_address(unsigned long addr);
Rusty Russelle6104992009-03-31 13:05:31 -0600505bool is_module_text_address(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Petr Mladek76681c82014-07-27 07:25:01 +0930507static inline bool within_module_core(unsigned long addr,
508 const struct module *mod)
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800509{
Rusty Russell7523e4d2015-11-26 09:44:08 +1030510 return (unsigned long)mod->core_layout.base <= addr &&
511 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800512}
513
Petr Mladek76681c82014-07-27 07:25:01 +0930514static inline bool within_module_init(unsigned long addr,
515 const struct module *mod)
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800516{
Rusty Russell7523e4d2015-11-26 09:44:08 +1030517 return (unsigned long)mod->init_layout.base <= addr &&
518 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800519}
520
Petr Mladek76681c82014-07-27 07:25:01 +0930521static inline bool within_module(unsigned long addr, const struct module *mod)
Petr Mladek9b20a352014-07-27 07:24:01 +0930522{
523 return within_module_init(addr, mod) || within_module_core(addr, mod);
524}
525
Tim Abbottc6b37802008-12-05 19:03:59 -0500526/* Search for module by name: must hold module_mutex. */
527struct module *find_module(const char *name);
528
529struct symsearch {
530 const struct kernel_symbol *start, *stop;
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000531 const s32 *crcs;
Tim Abbottc6b37802008-12-05 19:03:59 -0500532 enum {
533 NOT_GPL_ONLY,
534 GPL_ONLY,
535 WILL_BE_GPL_ONLY,
536 } licence;
537 bool unused;
538};
539
Peter Zijlstra0be964b2015-05-27 11:09:35 +0930540/*
541 * Search for an exported symbol by name.
542 *
543 * Must be called with module_mutex held or preemption disabled.
544 */
Tim Abbottc6b37802008-12-05 19:03:59 -0500545const struct kernel_symbol *find_symbol(const char *name,
546 struct module **owner,
Ard Biesheuvel71810db2017-02-03 09:54:06 +0000547 const s32 **crc,
Tim Abbottc6b37802008-12-05 19:03:59 -0500548 bool gplok,
549 bool warn);
550
Peter Zijlstra0be964b2015-05-27 11:09:35 +0930551/*
552 * Walk the exported symbol table
553 *
554 * Must be called with module_mutex held or preemption disabled.
555 */
Rusty Russellde4d8d52011-04-19 21:49:58 +0200556bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
557 struct module *owner,
558 void *data), void *data);
Tim Abbottc6b37802008-12-05 19:03:59 -0500559
Alexey Dobriyanea078902007-05-08 00:28:39 -0700560/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 symnum out of range. */
Alexey Dobriyanea078902007-05-08 00:28:39 -0700562int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
563 char *name, char *module_name, int *exported);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
565/* Look for this name: can be of form module:name. */
566unsigned long module_kallsyms_lookup_name(const char *name);
567
Anders Kaseorg75a66612008-12-05 19:03:58 -0500568int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
569 struct module *, unsigned long),
570 void *data);
571
Jiri Kosinabf262dc2016-04-12 05:02:09 +0930572extern void __noreturn __module_put_and_exit(struct module *mod,
573 long code);
Joe Perches74e22fa2013-12-04 14:09:38 +1030574#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
576#ifdef CONFIG_MODULE_UNLOAD
Rusty Russelld5db1392015-01-22 11:13:14 +1030577int module_refcount(struct module *mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578void __symbol_put(const char *symbol);
Masahiro Yamada996302c2018-06-24 00:37:44 +0900579#define symbol_put(x) __symbol_put(__stringify(x))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580void symbol_put_addr(void *addr);
581
582/* Sometimes we know we already have a refcount, and it's easier not
583 to handle the error case (which only happens with rmmod --wait). */
Steven Rostedtd53799b2012-03-26 12:50:52 +1030584extern void __module_get(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Steven Rostedtd53799b2012-03-26 12:50:52 +1030586/* This is the Right Way to get a module: if it fails, it's being removed,
587 * so pretend it's not there. */
588extern bool try_module_get(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Al Virof6a57032006-10-18 01:47:25 -0400590extern void module_put(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
592#else /*!CONFIG_MODULE_UNLOAD*/
Gao Feng8ba4fcd2017-04-19 09:47:22 +0800593static inline bool try_module_get(struct module *module)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
595 return !module || module_is_live(module);
596}
597static inline void module_put(struct module *module)
598{
599}
600static inline void __module_get(struct module *module)
601{
602}
Seunghun Leee865d062014-01-16 10:18:49 +1030603#define symbol_put(x) do { } while (0)
604#define symbol_put_addr(p) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
606#endif /* CONFIG_MODULE_UNLOAD */
Anders Kaseorgdfd62d12010-11-24 15:21:10 -0600607int ref_module(struct module *a, struct module *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
609/* This is a #define so the string doesn't get put in every .o file */
610#define module_name(mod) \
611({ \
612 struct module *__mod = (mod); \
613 __mod ? __mod->name : "kernel"; \
614})
615
Sergey Senozhatskyb865ea62017-11-10 08:48:25 +0900616/* Dereference module function descriptor */
617void *dereference_module_function_descriptor(struct module *mod, void *ptr);
618
Rusty Russell6dd06c92008-01-29 17:13:22 -0500619/* For kallsyms to ask for address resolution. namebuf should be at
620 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
621 * found, otherwise NULL. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800622const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500623 unsigned long *symbolsize,
624 unsigned long *offset,
625 char **modname,
626 char *namebuf);
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700627int lookup_module_symbol_name(unsigned long addr, char *symname);
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700628int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
Seunghun Leee865d062014-01-16 10:18:49 +1030630int register_module_notifier(struct notifier_block *nb);
631int unregister_module_notifier(struct notifier_block *nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633extern void print_modules(void);
634
Dmitry Torokhov80c6e142015-05-21 15:49:37 -0700635static inline bool module_requested_async_probing(struct module *module)
636{
637 return module && module->async_probe_requested;
638}
639
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400640#ifdef CONFIG_LIVEPATCH
641static inline bool is_livepatch_module(struct module *mod)
642{
643 return mod->klp;
644}
645#else /* !CONFIG_LIVEPATCH */
646static inline bool is_livepatch_module(struct module *mod)
647{
648 return false;
649}
650#endif /* CONFIG_LIVEPATCH */
651
Bruno E. O. Meneguelefda784e2017-10-24 15:37:00 -0200652bool is_module_sig_enforced(void);
653
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654#else /* !CONFIG_MODULES... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Rusty Russelle6104992009-03-31 13:05:31 -0600656static inline struct module *__module_address(unsigned long addr)
657{
658 return NULL;
659}
660
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661static inline struct module *__module_text_address(unsigned long addr)
662{
663 return NULL;
664}
665
Rusty Russelle6104992009-03-31 13:05:31 -0600666static inline bool is_module_address(unsigned long addr)
Ingo Molnar4d435f92006-07-03 00:24:24 -0700667{
Rusty Russelle6104992009-03-31 13:05:31 -0600668 return false;
669}
670
Randy Dunlapd5e50da2010-03-31 11:33:42 +0900671static inline bool is_module_percpu_address(unsigned long addr)
672{
673 return false;
674}
675
Thomas Gleixner383776f2017-02-27 15:37:36 +0100676static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
677{
678 return false;
679}
680
Rusty Russelle6104992009-03-31 13:05:31 -0600681static inline bool is_module_text_address(unsigned long addr)
682{
683 return false;
Ingo Molnar4d435f92006-07-03 00:24:24 -0700684}
685
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686/* Get/put a kernel symbol (calls should be symmetric) */
687#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
Seunghun Leee865d062014-01-16 10:18:49 +1030688#define symbol_put(x) do { } while (0)
689#define symbol_put_addr(x) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
691static inline void __module_get(struct module *module)
692{
693}
694
Gao Feng8ba4fcd2017-04-19 09:47:22 +0800695static inline bool try_module_get(struct module *module)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696{
Gao Feng8ba4fcd2017-04-19 09:47:22 +0800697 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698}
699
700static inline void module_put(struct module *module)
701{
702}
703
704#define module_name(mod) "kernel"
705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706/* For kallsyms to ask for address resolution. NULL means not found. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800707static inline const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500708 unsigned long *symbolsize,
709 unsigned long *offset,
710 char **modname,
711 char *namebuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712{
713 return NULL;
714}
715
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700716static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
717{
718 return -ERANGE;
719}
720
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700721static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
722{
723 return -ERANGE;
724}
725
Alexey Dobriyanea078902007-05-08 00:28:39 -0700726static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
727 char *type, char *name,
728 char *module_name, int *exported)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
Alexey Dobriyanea078902007-05-08 00:28:39 -0700730 return -ERANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731}
732
733static inline unsigned long module_kallsyms_lookup_name(const char *name)
734{
735 return 0;
736}
737
Anders Kaseorg75a66612008-12-05 19:03:58 -0500738static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
739 struct module *,
740 unsigned long),
741 void *data)
742{
743 return 0;
744}
745
Seunghun Leee865d062014-01-16 10:18:49 +1030746static inline int register_module_notifier(struct notifier_block *nb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747{
748 /* no events will happen anyway, so this can always succeed */
749 return 0;
750}
751
Seunghun Leee865d062014-01-16 10:18:49 +1030752static inline int unregister_module_notifier(struct notifier_block *nb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
754 return 0;
755}
756
757#define module_put_and_exit(code) do_exit(code)
758
759static inline void print_modules(void)
760{
761}
Dmitry Torokhov80c6e142015-05-21 15:49:37 -0700762
763static inline bool module_requested_async_probing(struct module *module)
764{
765 return false;
766}
767
Bruno E. O. Meneguelefda784e2017-10-24 15:37:00 -0200768static inline bool is_module_sig_enforced(void)
769{
770 return false;
771}
772
Sergey Senozhatskyb865ea62017-11-10 08:48:25 +0900773/* Dereference module function descriptor */
774static inline
775void *dereference_module_function_descriptor(struct module *mod, void *ptr)
776{
777 return ptr;
778}
779
Randy Dunlapef665c12007-02-13 15:19:06 -0800780#endif /* CONFIG_MODULES */
781
Randy Dunlapef665c12007-02-13 15:19:06 -0800782#ifdef CONFIG_SYSFS
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700783extern struct kset *module_kset;
784extern struct kobj_type module_ktype;
785extern int module_sysfs_initialized;
Randy Dunlapef665c12007-02-13 15:19:06 -0800786#endif /* CONFIG_SYSFS */
787
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
789
790/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792#define __MODULE_STRING(x) __stringify(x)
793
Laura Abbott0f5bf6d2017-02-06 16:31:58 -0800794#ifdef CONFIG_STRICT_MODULE_RWX
matthieu castet84e1c6b2010-11-16 22:35:16 +0100795extern void set_all_modules_text_rw(void);
796extern void set_all_modules_text_ro(void);
Jessica Yu444d13f2016-07-27 12:06:21 +0930797extern void module_enable_ro(const struct module *mod, bool after_init);
Rusty Russell85c898d2015-11-26 09:45:08 +1030798extern void module_disable_ro(const struct module *mod);
matthieu castet84e1c6b2010-11-16 22:35:16 +0100799#else
800static inline void set_all_modules_text_rw(void) { }
801static inline void set_all_modules_text_ro(void) { }
Jessica Yu444d13f2016-07-27 12:06:21 +0930802static inline void module_enable_ro(const struct module *mod, bool after_init) { }
Rusty Russell85c898d2015-11-26 09:45:08 +1030803static inline void module_disable_ro(const struct module *mod) { }
matthieu castet84e1c6b2010-11-16 22:35:16 +0100804#endif
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700805
806#ifdef CONFIG_GENERIC_BUG
Linus Torvalds53363772010-10-05 11:29:27 -0700807void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700808 struct module *);
809void module_bug_cleanup(struct module *);
810
811#else /* !CONFIG_GENERIC_BUG */
812
Linus Torvalds53363772010-10-05 11:29:27 -0700813static inline void module_bug_finalize(const Elf_Ehdr *hdr,
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700814 const Elf_Shdr *sechdrs,
815 struct module *mod)
816{
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700817}
818static inline void module_bug_cleanup(struct module *mod) {}
819#endif /* CONFIG_GENERIC_BUG */
820
Andi Kleencaf75012018-01-25 15:50:28 -0800821#ifdef RETPOLINE
822extern bool retpoline_module_ok(bool has_retpoline);
823#else
824static inline bool retpoline_module_ok(bool has_retpoline)
825{
826 return true;
827}
828#endif
829
Herbert Xu59afdc72015-04-22 11:28:46 +0800830#ifdef CONFIG_MODULE_SIG
831static inline bool module_sig_ok(struct module *module)
832{
833 return module->sig_ok;
834}
835#else /* !CONFIG_MODULE_SIG */
836static inline bool module_sig_ok(struct module *module)
837{
838 return true;
839}
840#endif /* CONFIG_MODULE_SIG */
841
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842#endif /* _LINUX_MODULE_H */