Masahiro Yamada | bf49d9d | 2019-10-18 13:50:53 +0900 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2 | /* |
| 3 | * Dynamic loading of modules into the kernel. |
| 4 | * |
| 5 | * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996 |
| 6 | * Rewritten again by Rusty Russell, 2002 |
| 7 | */ |
Masahiro Yamada | bf49d9d | 2019-10-18 13:50:53 +0900 | [diff] [blame] | 8 | |
| 9 | #ifndef _LINUX_MODULE_H |
| 10 | #define _LINUX_MODULE_H |
| 11 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 12 | #include <linux/list.h> |
| 13 | #include <linux/stat.h> |
| 14 | #include <linux/compiler.h> |
| 15 | #include <linux/cache.h> |
| 16 | #include <linux/kmod.h> |
Paul Gortmaker | 0fd972a | 2015-05-01 20:13:42 -0400 | [diff] [blame] | 17 | #include <linux/init.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | #include <linux/elf.h> |
| 19 | #include <linux/stringify.h> |
| 20 | #include <linux/kobject.h> |
| 21 | #include <linux/moduleparam.h> |
Steven Rostedt (Red Hat) | b2e285f | 2014-02-26 13:12:06 -0500 | [diff] [blame] | 22 | #include <linux/jump_label.h> |
Paul Gortmaker | f501693 | 2011-05-23 14:11:39 -0400 | [diff] [blame] | 23 | #include <linux/export.h> |
Peter Zijlstra | 93c2e10 | 2015-05-27 11:09:37 +0930 | [diff] [blame] | 24 | #include <linux/rbtree_latch.h> |
Masami Hiramatsu | 663faf9 | 2018-01-13 02:55:33 +0900 | [diff] [blame] | 25 | #include <linux/error-injection.h> |
Mathieu Desnoyers | 9c0be3f | 2018-10-13 15:10:50 -0400 | [diff] [blame] | 26 | #include <linux/tracepoint-defs.h> |
Paul E. McKenney | fe15b50 | 2019-04-05 16:15:00 -0700 | [diff] [blame] | 27 | #include <linux/srcu.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | |
Christoph Lameter | e1783a2 | 2010-01-05 15:34:50 +0900 | [diff] [blame] | 29 | #include <linux/percpu.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | #include <asm/module.h> |
| 31 | |
| 32 | /* Not Yet Implemented */ |
| 33 | #define MODULE_SUPPORTED_DEVICE(name) |
| 34 | |
Rusty Russell | 730b69d | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 35 | #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 36 | |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 37 | struct modversion_info { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | unsigned long crc; |
| 39 | char name[MODULE_NAME_LEN]; |
| 40 | }; |
| 41 | |
| 42 | struct module; |
Paul Gortmaker | 0ef7653 | 2016-07-27 12:06:34 +0930 | [diff] [blame] | 43 | struct exception_table_entry; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 44 | |
Kay Sievers | 4befb02 | 2011-07-24 22:06:04 +0930 | [diff] [blame] | 45 | struct module_kobject { |
| 46 | struct kobject kobj; |
| 47 | struct module *mod; |
| 48 | struct kobject *drivers_dir; |
| 49 | struct module_param_attrs *mp; |
Li Zhong | 942e443 | 2013-09-03 16:33:57 +0930 | [diff] [blame] | 50 | struct completion *kobj_completion; |
Kees Cook | 3859a27 | 2016-10-28 01:22:25 -0700 | [diff] [blame] | 51 | } __randomize_layout; |
Kay Sievers | 4befb02 | 2011-07-24 22:06:04 +0930 | [diff] [blame] | 52 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | struct module_attribute { |
Kay Sievers | 4befb02 | 2011-07-24 22:06:04 +0930 | [diff] [blame] | 54 | struct attribute attr; |
| 55 | ssize_t (*show)(struct module_attribute *, struct module_kobject *, |
| 56 | char *); |
| 57 | ssize_t (*store)(struct module_attribute *, struct module_kobject *, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 58 | const char *, size_t count); |
Matt Domsch | c988d2b | 2005-06-23 22:05:15 -0700 | [diff] [blame] | 59 | void (*setup)(struct module *, const char *); |
| 60 | int (*test)(struct module *); |
| 61 | void (*free)(struct module *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 62 | }; |
| 63 | |
Dmitry Torokhov | e94965e | 2010-12-15 14:00:19 -0800 | [diff] [blame] | 64 | struct module_version_attribute { |
| 65 | struct module_attribute mattr; |
| 66 | const char *module_name; |
| 67 | const char *version; |
Dmitry Torokhov | 98562ad | 2011-02-04 13:30:10 -0800 | [diff] [blame] | 68 | } __attribute__ ((__aligned__(sizeof(void *)))); |
Dmitry Torokhov | e94965e | 2010-12-15 14:00:19 -0800 | [diff] [blame] | 69 | |
Dmitry Torokhov | 9b73a58 | 2011-02-07 16:02:27 -0800 | [diff] [blame] | 70 | extern ssize_t __modver_version_show(struct module_attribute *, |
Kay Sievers | 4befb02 | 2011-07-24 22:06:04 +0930 | [diff] [blame] | 71 | struct module_kobject *, char *); |
Dmitry Torokhov | 9b73a58 | 2011-02-07 16:02:27 -0800 | [diff] [blame] | 72 | |
Kay Sievers | 88bfa32 | 2011-07-24 22:06:04 +0930 | [diff] [blame] | 73 | extern struct module_attribute module_uevent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 74 | |
| 75 | /* These are either module local, or the kernel's dummy ones. */ |
| 76 | extern int init_module(void); |
| 77 | extern void cleanup_module(void); |
| 78 | |
Paul Gortmaker | 0fd972a | 2015-05-01 20:13:42 -0400 | [diff] [blame] | 79 | #ifndef MODULE |
| 80 | /** |
| 81 | * module_init() - driver initialization entry point |
| 82 | * @x: function to be run at kernel boot time or module insertion |
| 83 | * |
| 84 | * module_init() will either be called during do_initcalls() (if |
| 85 | * builtin) or at module insertion time (if a module). There can only |
| 86 | * be one per module. |
| 87 | */ |
| 88 | #define module_init(x) __initcall(x); |
| 89 | |
| 90 | /** |
| 91 | * module_exit() - driver exit entry point |
| 92 | * @x: function to be run when driver is removed |
| 93 | * |
| 94 | * module_exit() will wrap the driver clean-up code |
| 95 | * with cleanup_module() when used with rmmod when |
| 96 | * the driver is a module. If the driver is statically |
| 97 | * compiled into the kernel, module_exit() has no effect. |
| 98 | * There can only be one per module. |
| 99 | */ |
| 100 | #define module_exit(x) __exitcall(x); |
| 101 | |
| 102 | #else /* MODULE */ |
| 103 | |
| 104 | /* |
| 105 | * In most cases loadable modules do not need custom |
| 106 | * initcall levels. There are still some valid cases where |
| 107 | * a driver may be needed early if built in, and does not |
| 108 | * matter when built as a loadable module. Like bus |
| 109 | * snooping debug drivers. |
| 110 | */ |
| 111 | #define early_initcall(fn) module_init(fn) |
| 112 | #define core_initcall(fn) module_init(fn) |
| 113 | #define core_initcall_sync(fn) module_init(fn) |
| 114 | #define postcore_initcall(fn) module_init(fn) |
| 115 | #define postcore_initcall_sync(fn) module_init(fn) |
| 116 | #define arch_initcall(fn) module_init(fn) |
| 117 | #define subsys_initcall(fn) module_init(fn) |
| 118 | #define subsys_initcall_sync(fn) module_init(fn) |
| 119 | #define fs_initcall(fn) module_init(fn) |
| 120 | #define fs_initcall_sync(fn) module_init(fn) |
| 121 | #define rootfs_initcall(fn) module_init(fn) |
| 122 | #define device_initcall(fn) module_init(fn) |
| 123 | #define device_initcall_sync(fn) module_init(fn) |
| 124 | #define late_initcall(fn) module_init(fn) |
| 125 | #define late_initcall_sync(fn) module_init(fn) |
| 126 | |
| 127 | #define console_initcall(fn) module_init(fn) |
Paul Gortmaker | 0fd972a | 2015-05-01 20:13:42 -0400 | [diff] [blame] | 128 | |
| 129 | /* Each module must use one module_init(). */ |
| 130 | #define module_init(initfn) \ |
Arnd Bergmann | 1f318a8 | 2017-02-01 18:00:14 +0100 | [diff] [blame] | 131 | static inline initcall_t __maybe_unused __inittest(void) \ |
Paul Gortmaker | 0fd972a | 2015-05-01 20:13:42 -0400 | [diff] [blame] | 132 | { return initfn; } \ |
Miguel Ojeda | a6e60d8 | 2019-01-19 20:59:34 +0100 | [diff] [blame] | 133 | int init_module(void) __copy(initfn) __attribute__((alias(#initfn))); |
Paul Gortmaker | 0fd972a | 2015-05-01 20:13:42 -0400 | [diff] [blame] | 134 | |
| 135 | /* This is only required if you want to be unloadable. */ |
| 136 | #define module_exit(exitfn) \ |
Arnd Bergmann | 1f318a8 | 2017-02-01 18:00:14 +0100 | [diff] [blame] | 137 | static inline exitcall_t __maybe_unused __exittest(void) \ |
Paul Gortmaker | 0fd972a | 2015-05-01 20:13:42 -0400 | [diff] [blame] | 138 | { return exitfn; } \ |
Miguel Ojeda | a6e60d8 | 2019-01-19 20:59:34 +0100 | [diff] [blame] | 139 | void cleanup_module(void) __copy(exitfn) __attribute__((alias(#exitfn))); |
Paul Gortmaker | 0fd972a | 2015-05-01 20:13:42 -0400 | [diff] [blame] | 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 161 | /* 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 Robinson | 7cb14ba | 2013-08-20 15:33:19 +0930 | [diff] [blame] | 167 | /* 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 172 | /* |
Masahiro Yamada | 8b41fc4 | 2019-12-19 17:33:29 +0900 | [diff] [blame] | 173 | * MODULE_FILE is used for generating modules.builtin |
| 174 | * So, make it no-op when this is being built as a module |
| 175 | */ |
| 176 | #ifdef MODULE |
| 177 | #define MODULE_FILE |
| 178 | #else |
| 179 | #define MODULE_FILE MODULE_INFO(file, KBUILD_MODFILE); |
| 180 | #endif |
| 181 | |
| 182 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 183 | * The following license idents are currently accepted as indicating free |
| 184 | * software modules |
| 185 | * |
Thomas Gleixner | bf7fbee | 2019-02-08 17:02:56 +0100 | [diff] [blame] | 186 | * "GPL" [GNU Public License v2] |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 187 | * "GPL v2" [GNU Public License v2] |
| 188 | * "GPL and additional rights" [GNU Public License v2 rights and more] |
| 189 | * "Dual BSD/GPL" [GNU Public License v2 |
| 190 | * or BSD license choice] |
Xose Vazquez Perez | 8d27e90 | 2006-06-23 02:05:13 -0700 | [diff] [blame] | 191 | * "Dual MIT/GPL" [GNU Public License v2 |
| 192 | * or MIT license choice] |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | * "Dual MPL/GPL" [GNU Public License v2 |
| 194 | * or Mozilla license choice] |
| 195 | * |
| 196 | * The following other idents are available |
| 197 | * |
| 198 | * "Proprietary" [Non free products] |
| 199 | * |
Thomas Gleixner | bf7fbee | 2019-02-08 17:02:56 +0100 | [diff] [blame] | 200 | * Both "GPL v2" and "GPL" (the latter also in dual licensed strings) are |
| 201 | * merely stating that the module is licensed under the GPL v2, but are not |
| 202 | * telling whether "GPL v2 only" or "GPL v2 or later". The reason why there |
| 203 | * are two variants is a historic and failed attempt to convey more |
| 204 | * information in the MODULE_LICENSE string. For module loading the |
| 205 | * "only/or later" distinction is completely irrelevant and does neither |
| 206 | * replace the proper license identifiers in the corresponding source file |
| 207 | * nor amends them in any way. The sole purpose is to make the |
| 208 | * 'Proprietary' flagging work and to refuse to bind symbols which are |
| 209 | * exported with EXPORT_SYMBOL_GPL when a non free module is loaded. |
| 210 | * |
| 211 | * In the same way "BSD" is not a clear license information. It merely |
| 212 | * states, that the module is licensed under one of the compatible BSD |
| 213 | * license variants. The detailed and correct license information is again |
| 214 | * to be found in the corresponding source files. |
| 215 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 216 | * There are dual licensed components, but when running with Linux it is the |
| 217 | * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL |
| 218 | * is a GPL combined work. |
| 219 | * |
| 220 | * This exists for several reasons |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 221 | * 1. So modinfo can show license info for users wanting to vet their setup |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 222 | * is free |
| 223 | * 2. So the community can ignore bug reports including proprietary modules |
| 224 | * 3. So vendors can do likewise based on their own policies |
| 225 | */ |
Masahiro Yamada | 8b41fc4 | 2019-12-19 17:33:29 +0900 | [diff] [blame] | 226 | #define MODULE_LICENSE(_license) MODULE_FILE MODULE_INFO(license, _license) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 227 | |
Johannes Berg | 1d7015c | 2009-09-25 00:32:58 -0600 | [diff] [blame] | 228 | /* |
| 229 | * Author(s), use "Name <email>" or just "Name", for multiple |
| 230 | * authors use multiple MODULE_AUTHOR() statements/lines. |
| 231 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author) |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 233 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 234 | /* What your module does. */ |
| 235 | #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description) |
| 236 | |
Rusty Russell | cff26a5 | 2014-02-03 11:15:13 +1030 | [diff] [blame] | 237 | #ifdef MODULE |
| 238 | /* Creates an alias so file2alias.c can find device table. */ |
| 239 | #define MODULE_DEVICE_TABLE(type, name) \ |
Matthias Kaehlcke | 0bf8bf5 | 2017-07-24 18:27:25 -0700 | [diff] [blame] | 240 | extern typeof(name) __mod_##type##__##name##_device_table \ |
Rusty Russell | cff26a5 | 2014-02-03 11:15:13 +1030 | [diff] [blame] | 241 | __attribute__ ((unused, alias(__stringify(name)))) |
| 242 | #else /* !MODULE */ |
| 243 | #define MODULE_DEVICE_TABLE(type, name) |
| 244 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 245 | |
| 246 | /* Version of form [<epoch>:]<version>[-<extra-version>]. |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 247 | * Or for CVS/RCS ID version, everything but the number is stripped. |
| 248 | * <epoch>: A (small) unsigned integer which allows you to start versions |
| 249 | * anew. If not mentioned, it's zero. eg. "2:1.0" is after |
| 250 | * "1:2.0". |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 251 | |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 252 | * <version>: The <version> may contain only alphanumerics and the |
| 253 | * character `.'. Ordered by numeric sort for numeric parts, |
| 254 | * ascii sort for ascii parts (as per RPM or DEB algorithm). |
| 255 | |
| 256 | * <extraversion>: Like <version>, but inserted for local |
| 257 | * customizations, eg "rh3" or "rusty1". |
| 258 | |
| 259 | * Using this automatically adds a checksum of the .c files and the |
| 260 | * local headers in "srcversion". |
| 261 | */ |
Dmitry Torokhov | e94965e | 2010-12-15 14:00:19 -0800 | [diff] [blame] | 262 | |
Rusty Russell | 3b90a5b | 2011-01-24 14:32:51 -0600 | [diff] [blame] | 263 | #if defined(MODULE) || !defined(CONFIG_SYSFS) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 264 | #define MODULE_VERSION(_version) MODULE_INFO(version, _version) |
Dmitry Torokhov | e94965e | 2010-12-15 14:00:19 -0800 | [diff] [blame] | 265 | #else |
| 266 | #define MODULE_VERSION(_version) \ |
Alexey Gladkov | 898490c | 2019-04-29 18:11:14 +0200 | [diff] [blame] | 267 | MODULE_INFO(version, _version); \ |
Dmitry Torokhov | b4bc8428 | 2011-02-07 16:02:25 -0800 | [diff] [blame] | 268 | static struct module_version_attribute ___modver_attr = { \ |
Dmitry Torokhov | e94965e | 2010-12-15 14:00:19 -0800 | [diff] [blame] | 269 | .mattr = { \ |
| 270 | .attr = { \ |
| 271 | .name = "version", \ |
| 272 | .mode = S_IRUGO, \ |
| 273 | }, \ |
| 274 | .show = __modver_version_show, \ |
| 275 | }, \ |
| 276 | .module_name = KBUILD_MODNAME, \ |
| 277 | .version = _version, \ |
Dmitry Torokhov | b4bc8428 | 2011-02-07 16:02:25 -0800 | [diff] [blame] | 278 | }; \ |
| 279 | static const struct module_version_attribute \ |
| 280 | __used __attribute__ ((__section__ ("__modver"))) \ |
| 281 | * __moduleparam_const __modver_attr = &___modver_attr |
Dmitry Torokhov | e94965e | 2010-12-15 14:00:19 -0800 | [diff] [blame] | 282 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 283 | |
Jon Masters | 187afbe | 2006-08-28 17:08:21 -0500 | [diff] [blame] | 284 | /* Optional firmware file (or files) needed by the module |
| 285 | * format is simply firmware file name. Multiple firmware |
| 286 | * files require multiple MODULE_FIRMWARE() specifiers */ |
| 287 | #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware) |
| 288 | |
Linus Torvalds | 3e4d890 | 2019-09-22 11:15:14 -0700 | [diff] [blame] | 289 | #define MODULE_IMPORT_NS(ns) MODULE_INFO(import_ns, #ns) |
| 290 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 291 | struct notifier_block; |
| 292 | |
| 293 | #ifdef CONFIG_MODULES |
| 294 | |
Dave Young | 5ed1091 | 2010-03-10 15:24:06 -0800 | [diff] [blame] | 295 | extern int modules_disabled; /* for sysctl */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 296 | /* Get/put a kernel symbol (calls must be symmetric) */ |
| 297 | void *__symbol_get(const char *symbol); |
| 298 | void *__symbol_get_gpl(const char *symbol); |
Masahiro Yamada | 996302c | 2018-06-24 00:37:44 +0900 | [diff] [blame] | 299 | #define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x)))) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 300 | |
Rusty Russell | c8e21ce | 2010-06-05 11:17:35 -0600 | [diff] [blame] | 301 | /* modules using other modules: kdb wants to see this. */ |
| 302 | struct module_use { |
| 303 | struct list_head source_list; |
| 304 | struct list_head target_list; |
| 305 | struct module *source, *target; |
| 306 | }; |
| 307 | |
Rusty Russell | 0d21b0e | 2013-01-12 11:38:44 +1030 | [diff] [blame] | 308 | enum module_state { |
| 309 | MODULE_STATE_LIVE, /* Normal state. */ |
| 310 | MODULE_STATE_COMING, /* Full formed, running module_init. */ |
| 311 | MODULE_STATE_GOING, /* Going away. */ |
| 312 | MODULE_STATE_UNFORMED, /* Still setting it up. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 313 | }; |
| 314 | |
Peter Zijlstra | 93c2e10 | 2015-05-27 11:09:37 +0930 | [diff] [blame] | 315 | struct mod_tree_node { |
| 316 | struct module *mod; |
| 317 | struct latch_tree_node node; |
| 318 | }; |
| 319 | |
Rusty Russell | 7523e4d | 2015-11-26 09:44:08 +1030 | [diff] [blame] | 320 | struct module_layout { |
| 321 | /* The actual code + data. */ |
| 322 | void *base; |
| 323 | /* Total size. */ |
| 324 | unsigned int size; |
| 325 | /* The size of the executable code. */ |
| 326 | unsigned int text_size; |
| 327 | /* Size of RO section of the module (text+rodata) */ |
| 328 | unsigned int ro_size; |
Jessica Yu | 444d13f | 2016-07-27 12:06:21 +0930 | [diff] [blame] | 329 | /* Size of RO after init section */ |
| 330 | unsigned int ro_after_init_size; |
Rusty Russell | 7523e4d | 2015-11-26 09:44:08 +1030 | [diff] [blame] | 331 | |
| 332 | #ifdef CONFIG_MODULES_TREE_LOOKUP |
| 333 | struct mod_tree_node mtn; |
| 334 | #endif |
| 335 | }; |
| 336 | |
| 337 | #ifdef CONFIG_MODULES_TREE_LOOKUP |
| 338 | /* Only touch one cacheline for common rbtree-for-core-layout case. */ |
| 339 | #define __module_layout_align ____cacheline_aligned |
| 340 | #else |
| 341 | #define __module_layout_align |
| 342 | #endif |
| 343 | |
Rusty Russell | 8244062 | 2016-02-03 16:55:26 +1030 | [diff] [blame] | 344 | struct mod_kallsyms { |
| 345 | Elf_Sym *symtab; |
| 346 | unsigned int num_symtab; |
| 347 | char *strtab; |
Eugene Loh | 1c7651f | 2019-02-25 11:59:58 -0800 | [diff] [blame] | 348 | char *typetab; |
Rusty Russell | 8244062 | 2016-02-03 16:55:26 +1030 | [diff] [blame] | 349 | }; |
| 350 | |
Jessica Yu | 1ce15ef | 2016-03-22 20:03:16 -0400 | [diff] [blame] | 351 | #ifdef CONFIG_LIVEPATCH |
| 352 | struct klp_modinfo { |
| 353 | Elf_Ehdr hdr; |
| 354 | Elf_Shdr *sechdrs; |
| 355 | char *secstrings; |
| 356 | unsigned int symndx; |
| 357 | }; |
| 358 | #endif |
| 359 | |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 360 | struct module { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 361 | enum module_state state; |
| 362 | |
| 363 | /* Member of list of modules */ |
| 364 | struct list_head list; |
| 365 | |
| 366 | /* Unique handle for this module */ |
| 367 | char name[MODULE_NAME_LEN]; |
| 368 | |
| 369 | /* Sysfs stuff. */ |
| 370 | struct module_kobject mkobj; |
Greg Kroah-Hartman | 03e88ae1 | 2006-02-16 13:50:23 -0800 | [diff] [blame] | 371 | struct module_attribute *modinfo_attrs; |
Matt Domsch | c988d2b | 2005-06-23 22:05:15 -0700 | [diff] [blame] | 372 | const char *version; |
| 373 | const char *srcversion; |
Kay Sievers | 270a6c4 | 2007-01-18 13:26:15 +0100 | [diff] [blame] | 374 | struct kobject *holders_dir; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 375 | |
| 376 | /* Exported symbols */ |
| 377 | const struct kernel_symbol *syms; |
Ard Biesheuvel | 71810db | 2017-02-03 09:54:06 +0000 | [diff] [blame] | 378 | const s32 *crcs; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 379 | unsigned int num_syms; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 380 | |
Rusty Russell | e180a6b | 2009-03-31 13:05:29 -0600 | [diff] [blame] | 381 | /* Kernel parameters. */ |
Rusty Russell | cf2fde7 | 2015-06-26 06:44:38 +0930 | [diff] [blame] | 382 | #ifdef CONFIG_SYSFS |
Dan Streetman | b51d23e | 2015-06-17 06:18:52 +0930 | [diff] [blame] | 383 | struct mutex param_lock; |
Rusty Russell | cf2fde7 | 2015-06-26 06:44:38 +0930 | [diff] [blame] | 384 | #endif |
Rusty Russell | e180a6b | 2009-03-31 13:05:29 -0600 | [diff] [blame] | 385 | struct kernel_param *kp; |
| 386 | unsigned int num_kp; |
| 387 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 388 | /* GPL-only exported symbols. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 389 | unsigned int num_gpl_syms; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 390 | const struct kernel_symbol *gpl_syms; |
Ard Biesheuvel | 71810db | 2017-02-03 09:54:06 +0000 | [diff] [blame] | 391 | const s32 *gpl_crcs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 392 | |
Denys Vlasenko | f7f5b67 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 393 | #ifdef CONFIG_UNUSED_SYMBOLS |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 394 | /* unused exported symbols. */ |
| 395 | const struct kernel_symbol *unused_syms; |
Ard Biesheuvel | 71810db | 2017-02-03 09:54:06 +0000 | [diff] [blame] | 396 | const s32 *unused_crcs; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 397 | unsigned int num_unused_syms; |
| 398 | |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 399 | /* GPL-only, unused exported symbols. */ |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 400 | unsigned int num_unused_gpl_syms; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 401 | const struct kernel_symbol *unused_gpl_syms; |
Ard Biesheuvel | 71810db | 2017-02-03 09:54:06 +0000 | [diff] [blame] | 402 | const s32 *unused_gpl_crcs; |
Denys Vlasenko | f7f5b67 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 403 | #endif |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 404 | |
Rusty Russell | 106a4ee | 2012-09-26 10:09:40 +0100 | [diff] [blame] | 405 | #ifdef CONFIG_MODULE_SIG |
| 406 | /* Signature was verified. */ |
| 407 | bool sig_ok; |
| 408 | #endif |
| 409 | |
Luis R. Rodriguez | f2411da | 2015-03-30 16:20:05 -0700 | [diff] [blame] | 410 | bool async_probe_requested; |
| 411 | |
Greg Kroah-Hartman | 9f28bb7 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 412 | /* symbols that will be GPL-only in the near future. */ |
| 413 | const struct kernel_symbol *gpl_future_syms; |
Ard Biesheuvel | 71810db | 2017-02-03 09:54:06 +0000 | [diff] [blame] | 414 | const s32 *gpl_future_crcs; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 415 | unsigned int num_gpl_future_syms; |
Greg Kroah-Hartman | 9f28bb7 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 416 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 417 | /* Exception table */ |
| 418 | unsigned int num_exentries; |
Rusty Russell | 5e458cc | 2008-10-22 10:00:13 -0500 | [diff] [blame] | 419 | struct exception_table_entry *extable; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 420 | |
| 421 | /* Startup function. */ |
| 422 | int (*init)(void); |
| 423 | |
Rusty Russell | 7523e4d | 2015-11-26 09:44:08 +1030 | [diff] [blame] | 424 | /* Core layout: rbtree is accessed frequently, so keep together. */ |
| 425 | struct module_layout core_layout __module_layout_align; |
| 426 | struct module_layout init_layout; |
matthieu castet | 84e1c6b | 2010-11-16 22:35:16 +0100 | [diff] [blame] | 427 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 428 | /* Arch-specific module values */ |
| 429 | struct mod_arch_specific arch; |
| 430 | |
Petr Mladek | 7fd8329 | 2016-09-21 13:47:22 +0200 | [diff] [blame] | 431 | unsigned long taints; /* same bits as kernel:taint_flags */ |
Randy Dunlap | 2bc2d61 | 2006-10-02 02:17:02 -0700 | [diff] [blame] | 432 | |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 433 | #ifdef CONFIG_GENERIC_BUG |
| 434 | /* Support for BUG */ |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 435 | unsigned num_bugs; |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 436 | struct list_head bug_list; |
| 437 | struct bug_entry *bug_table; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 438 | #endif |
| 439 | |
| 440 | #ifdef CONFIG_KALLSYMS |
Rusty Russell | 8244062 | 2016-02-03 16:55:26 +1030 | [diff] [blame] | 441 | /* Protected by RCU and/or module_mutex: use rcu_dereference() */ |
Madhuparna Bhowmik | 6080d60 | 2020-01-22 22:34:47 +0530 | [diff] [blame] | 442 | struct mod_kallsyms __rcu *kallsyms; |
Rusty Russell | 8244062 | 2016-02-03 16:55:26 +1030 | [diff] [blame] | 443 | struct mod_kallsyms core_kallsyms; |
Anson Jacob | c714965 | 2016-10-19 19:12:18 -0400 | [diff] [blame] | 444 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 445 | /* Section attributes */ |
| 446 | struct module_sect_attrs *sect_attrs; |
Roland McGrath | 6d76013 | 2007-10-16 23:26:40 -0700 | [diff] [blame] | 447 | |
| 448 | /* Notes attributes */ |
| 449 | struct module_notes_attrs *notes_attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 450 | #endif |
| 451 | |
Richard Kennedy | a288bd6 | 2011-05-19 16:55:25 -0600 | [diff] [blame] | 452 | /* The command line arguments (may be mangled). People like |
| 453 | keeping pointers to this stuff */ |
| 454 | char *args; |
| 455 | |
Tejun Heo | 259354d | 2010-03-10 18:56:10 +0900 | [diff] [blame] | 456 | #ifdef CONFIG_SMP |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 457 | /* Per-cpu data. */ |
Tejun Heo | 259354d | 2010-03-10 18:56:10 +0900 | [diff] [blame] | 458 | void __percpu *percpu; |
| 459 | unsigned int percpu_size; |
| 460 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 461 | |
Mathieu Desnoyers | 97e1c18 | 2008-07-18 12:16:16 -0400 | [diff] [blame] | 462 | #ifdef CONFIG_TRACEPOINTS |
Mathieu Desnoyers | 97e1c18 | 2008-07-18 12:16:16 -0400 | [diff] [blame] | 463 | unsigned int num_tracepoints; |
Mathieu Desnoyers | 9c0be3f | 2018-10-13 15:10:50 -0400 | [diff] [blame] | 464 | tracepoint_ptr_t *tracepoints_ptrs; |
Mathieu Desnoyers | 97e1c18 | 2008-07-18 12:16:16 -0400 | [diff] [blame] | 465 | #endif |
Paul E. McKenney | fe15b50 | 2019-04-05 16:15:00 -0700 | [diff] [blame] | 466 | #ifdef CONFIG_TREE_SRCU |
| 467 | unsigned int num_srcu_structs; |
| 468 | struct srcu_struct **srcu_struct_ptrs; |
| 469 | #endif |
Matt Mullins | a38d110 | 2018-12-12 16:42:37 -0800 | [diff] [blame] | 470 | #ifdef CONFIG_BPF_EVENTS |
| 471 | unsigned int num_bpf_raw_events; |
| 472 | struct bpf_raw_event_map *bpf_raw_events; |
| 473 | #endif |
Masahiro Yamada | e9666d1 | 2018-12-31 00:14:15 +0900 | [diff] [blame] | 474 | #ifdef CONFIG_JUMP_LABEL |
Jason Baron | bf5438fc | 2010-09-17 11:09:00 -0400 | [diff] [blame] | 475 | struct jump_entry *jump_entries; |
| 476 | unsigned int num_jump_entries; |
| 477 | #endif |
Frederic Weisbecker | 769b044 | 2009-03-06 17:21:49 +0100 | [diff] [blame] | 478 | #ifdef CONFIG_TRACING |
Lai Jiangshan | 1ba28e0 | 2009-03-06 17:21:48 +0100 | [diff] [blame] | 479 | unsigned int num_trace_bprintk_fmt; |
Richard Kennedy | a288bd6 | 2011-05-19 16:55:25 -0600 | [diff] [blame] | 480 | const char **trace_bprintk_fmt_start; |
Lai Jiangshan | 1ba28e0 | 2009-03-06 17:21:48 +0100 | [diff] [blame] | 481 | #endif |
Steven Rostedt | 6d72373 | 2009-04-10 14:53:50 -0400 | [diff] [blame] | 482 | #ifdef CONFIG_EVENT_TRACING |
Steven Rostedt (Red Hat) | 2425bcb | 2015-05-05 11:45:27 -0400 | [diff] [blame] | 483 | struct trace_event_call **trace_events; |
Steven Rostedt | 6d72373 | 2009-04-10 14:53:50 -0400 | [diff] [blame] | 484 | unsigned int num_trace_events; |
Jeremy Linton | 99be647 | 2017-05-31 16:56:44 -0500 | [diff] [blame] | 485 | struct trace_eval_map **trace_evals; |
| 486 | unsigned int num_trace_evals; |
Steven Rostedt | 6d72373 | 2009-04-10 14:53:50 -0400 | [diff] [blame] | 487 | #endif |
Steven Rostedt | 93eb677 | 2009-04-15 13:24:06 -0400 | [diff] [blame] | 488 | #ifdef CONFIG_FTRACE_MCOUNT_RECORD |
Steven Rostedt | 93eb677 | 2009-04-15 13:24:06 -0400 | [diff] [blame] | 489 | unsigned int num_ftrace_callsites; |
Richard Kennedy | a288bd6 | 2011-05-19 16:55:25 -0600 | [diff] [blame] | 490 | unsigned long *ftrace_callsites; |
Steven Rostedt | 93eb677 | 2009-04-15 13:24:06 -0400 | [diff] [blame] | 491 | #endif |
Lai Jiangshan | 1ba28e0 | 2009-03-06 17:21:48 +0100 | [diff] [blame] | 492 | |
Petr Mladek | 8cb2c2d | 2015-03-12 12:55:13 +0100 | [diff] [blame] | 493 | #ifdef CONFIG_LIVEPATCH |
Jessica Yu | 1ce15ef | 2016-03-22 20:03:16 -0400 | [diff] [blame] | 494 | bool klp; /* Is this a livepatch module? */ |
Petr Mladek | 8cb2c2d | 2015-03-12 12:55:13 +0100 | [diff] [blame] | 495 | bool klp_alive; |
Jessica Yu | 1ce15ef | 2016-03-22 20:03:16 -0400 | [diff] [blame] | 496 | |
| 497 | /* Elf information */ |
| 498 | struct klp_modinfo *klp_info; |
Petr Mladek | 8cb2c2d | 2015-03-12 12:55:13 +0100 | [diff] [blame] | 499 | #endif |
| 500 | |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 501 | #ifdef CONFIG_MODULE_UNLOAD |
| 502 | /* What modules depend on me? */ |
Linus Torvalds | 2c02dfe | 2010-05-31 12:19:37 -0700 | [diff] [blame] | 503 | struct list_head source_list; |
| 504 | /* What modules do I depend on? */ |
| 505 | struct list_head target_list; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 506 | |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 507 | /* Destruction function. */ |
| 508 | void (*exit)(void); |
| 509 | |
Masami Hiramatsu | 2f35c41 | 2014-11-10 09:29:29 +1030 | [diff] [blame] | 510 | atomic_t refcnt; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 511 | #endif |
Peter Oberparleiter | b99b87f | 2009-06-17 16:28:03 -0700 | [diff] [blame] | 512 | |
| 513 | #ifdef CONFIG_CONSTRUCTORS |
| 514 | /* Constructor functions. */ |
| 515 | ctor_fn_t *ctors; |
| 516 | unsigned int num_ctors; |
| 517 | #endif |
Josef Bacik | 92ace99 | 2017-12-11 11:36:46 -0500 | [diff] [blame] | 518 | |
Masami Hiramatsu | 540adea | 2018-01-13 02:55:03 +0900 | [diff] [blame] | 519 | #ifdef CONFIG_FUNCTION_ERROR_INJECTION |
Masami Hiramatsu | 663faf9 | 2018-01-13 02:55:33 +0900 | [diff] [blame] | 520 | struct error_injection_entry *ei_funcs; |
Masami Hiramatsu | 540adea | 2018-01-13 02:55:03 +0900 | [diff] [blame] | 521 | unsigned int num_ei_funcs; |
Josef Bacik | 92ace99 | 2017-12-11 11:36:46 -0500 | [diff] [blame] | 522 | #endif |
Kees Cook | 3859a27 | 2016-10-28 01:22:25 -0700 | [diff] [blame] | 523 | } ____cacheline_aligned __randomize_layout; |
Roman Zippel | e61a1c1 | 2007-05-09 02:35:15 -0700 | [diff] [blame] | 524 | #ifndef MODULE_ARCH_INIT |
| 525 | #define MODULE_ARCH_INIT {} |
| 526 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 527 | |
Vincent Whitchurch | 93d77e7 | 2018-12-14 17:05:55 +0100 | [diff] [blame] | 528 | #ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE |
| 529 | static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym) |
| 530 | { |
| 531 | return sym->st_value; |
| 532 | } |
| 533 | #endif |
| 534 | |
Tim Abbott | c6b3780 | 2008-12-05 19:03:59 -0500 | [diff] [blame] | 535 | extern struct mutex module_mutex; |
| 536 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 537 | /* FIXME: It'd be nice to isolate modules during init, too, so they |
| 538 | aren't used before they (may) fail. But presently too much code |
| 539 | (IDE & SCSI) require entry into the module during init.*/ |
Yaowei Bai | 171d864 | 2018-02-06 15:41:31 -0800 | [diff] [blame] | 540 | static inline bool module_is_live(struct module *mod) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 541 | { |
| 542 | return mod->state != MODULE_STATE_GOING; |
| 543 | } |
| 544 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 545 | struct module *__module_text_address(unsigned long addr); |
Rusty Russell | e610499 | 2009-03-31 13:05:31 -0600 | [diff] [blame] | 546 | struct module *__module_address(unsigned long addr); |
| 547 | bool is_module_address(unsigned long addr); |
Thomas Gleixner | 383776f | 2017-02-27 15:37:36 +0100 | [diff] [blame] | 548 | bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr); |
Tejun Heo | 10fad5e | 2010-03-10 18:57:54 +0900 | [diff] [blame] | 549 | bool is_module_percpu_address(unsigned long addr); |
Rusty Russell | e610499 | 2009-03-31 13:05:31 -0600 | [diff] [blame] | 550 | bool is_module_text_address(unsigned long addr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 551 | |
Petr Mladek | 76681c8 | 2014-07-27 07:25:01 +0930 | [diff] [blame] | 552 | static inline bool within_module_core(unsigned long addr, |
| 553 | const struct module *mod) |
Masami Hiramatsu | a06f621 | 2009-01-06 14:41:49 -0800 | [diff] [blame] | 554 | { |
Rusty Russell | 7523e4d | 2015-11-26 09:44:08 +1030 | [diff] [blame] | 555 | return (unsigned long)mod->core_layout.base <= addr && |
| 556 | addr < (unsigned long)mod->core_layout.base + mod->core_layout.size; |
Masami Hiramatsu | a06f621 | 2009-01-06 14:41:49 -0800 | [diff] [blame] | 557 | } |
| 558 | |
Petr Mladek | 76681c8 | 2014-07-27 07:25:01 +0930 | [diff] [blame] | 559 | static inline bool within_module_init(unsigned long addr, |
| 560 | const struct module *mod) |
Masami Hiramatsu | a06f621 | 2009-01-06 14:41:49 -0800 | [diff] [blame] | 561 | { |
Rusty Russell | 7523e4d | 2015-11-26 09:44:08 +1030 | [diff] [blame] | 562 | return (unsigned long)mod->init_layout.base <= addr && |
| 563 | addr < (unsigned long)mod->init_layout.base + mod->init_layout.size; |
Masami Hiramatsu | a06f621 | 2009-01-06 14:41:49 -0800 | [diff] [blame] | 564 | } |
| 565 | |
Petr Mladek | 76681c8 | 2014-07-27 07:25:01 +0930 | [diff] [blame] | 566 | static inline bool within_module(unsigned long addr, const struct module *mod) |
Petr Mladek | 9b20a35 | 2014-07-27 07:24:01 +0930 | [diff] [blame] | 567 | { |
| 568 | return within_module_init(addr, mod) || within_module_core(addr, mod); |
| 569 | } |
| 570 | |
Tim Abbott | c6b3780 | 2008-12-05 19:03:59 -0500 | [diff] [blame] | 571 | /* Search for module by name: must hold module_mutex. */ |
| 572 | struct module *find_module(const char *name); |
| 573 | |
| 574 | struct symsearch { |
| 575 | const struct kernel_symbol *start, *stop; |
Ard Biesheuvel | 71810db | 2017-02-03 09:54:06 +0000 | [diff] [blame] | 576 | const s32 *crcs; |
Tim Abbott | c6b3780 | 2008-12-05 19:03:59 -0500 | [diff] [blame] | 577 | enum { |
| 578 | NOT_GPL_ONLY, |
| 579 | GPL_ONLY, |
| 580 | WILL_BE_GPL_ONLY, |
| 581 | } licence; |
| 582 | bool unused; |
| 583 | }; |
| 584 | |
Peter Zijlstra | 0be964b | 2015-05-27 11:09:35 +0930 | [diff] [blame] | 585 | /* |
| 586 | * Search for an exported symbol by name. |
| 587 | * |
| 588 | * Must be called with module_mutex held or preemption disabled. |
| 589 | */ |
Tim Abbott | c6b3780 | 2008-12-05 19:03:59 -0500 | [diff] [blame] | 590 | const struct kernel_symbol *find_symbol(const char *name, |
| 591 | struct module **owner, |
Ard Biesheuvel | 71810db | 2017-02-03 09:54:06 +0000 | [diff] [blame] | 592 | const s32 **crc, |
Tim Abbott | c6b3780 | 2008-12-05 19:03:59 -0500 | [diff] [blame] | 593 | bool gplok, |
| 594 | bool warn); |
| 595 | |
Peter Zijlstra | 0be964b | 2015-05-27 11:09:35 +0930 | [diff] [blame] | 596 | /* |
| 597 | * Walk the exported symbol table |
| 598 | * |
| 599 | * Must be called with module_mutex held or preemption disabled. |
| 600 | */ |
Rusty Russell | de4d8d5 | 2011-04-19 21:49:58 +0200 | [diff] [blame] | 601 | bool each_symbol_section(bool (*fn)(const struct symsearch *arr, |
| 602 | struct module *owner, |
| 603 | void *data), void *data); |
Tim Abbott | c6b3780 | 2008-12-05 19:03:59 -0500 | [diff] [blame] | 604 | |
Alexey Dobriyan | ea07890 | 2007-05-08 00:28:39 -0700 | [diff] [blame] | 605 | /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 606 | symnum out of range. */ |
Alexey Dobriyan | ea07890 | 2007-05-08 00:28:39 -0700 | [diff] [blame] | 607 | int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type, |
| 608 | char *name, char *module_name, int *exported); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 609 | |
| 610 | /* Look for this name: can be of form module:name. */ |
| 611 | unsigned long module_kallsyms_lookup_name(const char *name); |
| 612 | |
Anders Kaseorg | 75a6661 | 2008-12-05 19:03:58 -0500 | [diff] [blame] | 613 | int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *, |
| 614 | struct module *, unsigned long), |
| 615 | void *data); |
| 616 | |
Jiri Kosina | bf262dc | 2016-04-12 05:02:09 +0930 | [diff] [blame] | 617 | extern void __noreturn __module_put_and_exit(struct module *mod, |
| 618 | long code); |
Joe Perches | 74e22fa | 2013-12-04 14:09:38 +1030 | [diff] [blame] | 619 | #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 620 | |
| 621 | #ifdef CONFIG_MODULE_UNLOAD |
Rusty Russell | d5db139 | 2015-01-22 11:13:14 +1030 | [diff] [blame] | 622 | int module_refcount(struct module *mod); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 623 | void __symbol_put(const char *symbol); |
Masahiro Yamada | 996302c | 2018-06-24 00:37:44 +0900 | [diff] [blame] | 624 | #define symbol_put(x) __symbol_put(__stringify(x)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 625 | void symbol_put_addr(void *addr); |
| 626 | |
| 627 | /* Sometimes we know we already have a refcount, and it's easier not |
| 628 | to handle the error case (which only happens with rmmod --wait). */ |
Steven Rostedt | d53799b | 2012-03-26 12:50:52 +1030 | [diff] [blame] | 629 | extern void __module_get(struct module *module); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 630 | |
Steven Rostedt | d53799b | 2012-03-26 12:50:52 +1030 | [diff] [blame] | 631 | /* This is the Right Way to get a module: if it fails, it's being removed, |
| 632 | * so pretend it's not there. */ |
| 633 | extern bool try_module_get(struct module *module); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 634 | |
Al Viro | f6a5703 | 2006-10-18 01:47:25 -0400 | [diff] [blame] | 635 | extern void module_put(struct module *module); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 636 | |
| 637 | #else /*!CONFIG_MODULE_UNLOAD*/ |
Gao Feng | 8ba4fcd | 2017-04-19 09:47:22 +0800 | [diff] [blame] | 638 | static inline bool try_module_get(struct module *module) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 639 | { |
| 640 | return !module || module_is_live(module); |
| 641 | } |
| 642 | static inline void module_put(struct module *module) |
| 643 | { |
| 644 | } |
| 645 | static inline void __module_get(struct module *module) |
| 646 | { |
| 647 | } |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 648 | #define symbol_put(x) do { } while (0) |
| 649 | #define symbol_put_addr(p) do { } while (0) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 650 | |
| 651 | #endif /* CONFIG_MODULE_UNLOAD */ |
Anders Kaseorg | dfd62d1 | 2010-11-24 15:21:10 -0600 | [diff] [blame] | 652 | int ref_module(struct module *a, struct module *b); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 653 | |
| 654 | /* This is a #define so the string doesn't get put in every .o file */ |
| 655 | #define module_name(mod) \ |
| 656 | ({ \ |
| 657 | struct module *__mod = (mod); \ |
| 658 | __mod ? __mod->name : "kernel"; \ |
| 659 | }) |
| 660 | |
Sergey Senozhatsky | b865ea6 | 2017-11-10 08:48:25 +0900 | [diff] [blame] | 661 | /* Dereference module function descriptor */ |
| 662 | void *dereference_module_function_descriptor(struct module *mod, void *ptr); |
| 663 | |
Rusty Russell | 6dd06c9 | 2008-01-29 17:13:22 -0500 | [diff] [blame] | 664 | /* For kallsyms to ask for address resolution. namebuf should be at |
| 665 | * least KSYM_NAME_LEN long: a pointer to namebuf is returned if |
| 666 | * found, otherwise NULL. */ |
Andrew Morton | 92dfc9d | 2008-02-08 04:18:43 -0800 | [diff] [blame] | 667 | const char *module_address_lookup(unsigned long addr, |
Rusty Russell | 6dd06c9 | 2008-01-29 17:13:22 -0500 | [diff] [blame] | 668 | unsigned long *symbolsize, |
| 669 | unsigned long *offset, |
| 670 | char **modname, |
| 671 | char *namebuf); |
Alexey Dobriyan | 9d65cb4 | 2007-05-08 00:28:43 -0700 | [diff] [blame] | 672 | int lookup_module_symbol_name(unsigned long addr, char *symname); |
Alexey Dobriyan | a5c43da | 2007-05-08 00:28:47 -0700 | [diff] [blame] | 673 | int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 674 | |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 675 | int register_module_notifier(struct notifier_block *nb); |
| 676 | int unregister_module_notifier(struct notifier_block *nb); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 677 | |
| 678 | extern void print_modules(void); |
| 679 | |
Dmitry Torokhov | 80c6e14 | 2015-05-21 15:49:37 -0700 | [diff] [blame] | 680 | static inline bool module_requested_async_probing(struct module *module) |
| 681 | { |
| 682 | return module && module->async_probe_requested; |
| 683 | } |
| 684 | |
Jessica Yu | 1ce15ef | 2016-03-22 20:03:16 -0400 | [diff] [blame] | 685 | #ifdef CONFIG_LIVEPATCH |
| 686 | static inline bool is_livepatch_module(struct module *mod) |
| 687 | { |
| 688 | return mod->klp; |
| 689 | } |
| 690 | #else /* !CONFIG_LIVEPATCH */ |
| 691 | static inline bool is_livepatch_module(struct module *mod) |
| 692 | { |
| 693 | return false; |
| 694 | } |
| 695 | #endif /* CONFIG_LIVEPATCH */ |
| 696 | |
Bruno E. O. Meneguele | fda784e | 2017-10-24 15:37:00 -0200 | [diff] [blame] | 697 | bool is_module_sig_enforced(void); |
Mimi Zohar | 8db5da0 | 2019-01-27 19:03:45 -0500 | [diff] [blame] | 698 | void set_module_sig_enforced(void); |
Bruno E. O. Meneguele | fda784e | 2017-10-24 15:37:00 -0200 | [diff] [blame] | 699 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 700 | #else /* !CONFIG_MODULES... */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 701 | |
Rusty Russell | e610499 | 2009-03-31 13:05:31 -0600 | [diff] [blame] | 702 | static inline struct module *__module_address(unsigned long addr) |
| 703 | { |
| 704 | return NULL; |
| 705 | } |
| 706 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 707 | static inline struct module *__module_text_address(unsigned long addr) |
| 708 | { |
| 709 | return NULL; |
| 710 | } |
| 711 | |
Rusty Russell | e610499 | 2009-03-31 13:05:31 -0600 | [diff] [blame] | 712 | static inline bool is_module_address(unsigned long addr) |
Ingo Molnar | 4d435f9 | 2006-07-03 00:24:24 -0700 | [diff] [blame] | 713 | { |
Rusty Russell | e610499 | 2009-03-31 13:05:31 -0600 | [diff] [blame] | 714 | return false; |
| 715 | } |
| 716 | |
Randy Dunlap | d5e50da | 2010-03-31 11:33:42 +0900 | [diff] [blame] | 717 | static inline bool is_module_percpu_address(unsigned long addr) |
| 718 | { |
| 719 | return false; |
| 720 | } |
| 721 | |
Thomas Gleixner | 383776f | 2017-02-27 15:37:36 +0100 | [diff] [blame] | 722 | static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr) |
| 723 | { |
| 724 | return false; |
| 725 | } |
| 726 | |
Rusty Russell | e610499 | 2009-03-31 13:05:31 -0600 | [diff] [blame] | 727 | static inline bool is_module_text_address(unsigned long addr) |
| 728 | { |
| 729 | return false; |
Ingo Molnar | 4d435f9 | 2006-07-03 00:24:24 -0700 | [diff] [blame] | 730 | } |
| 731 | |
David Howells | 007ec26 | 2018-11-01 23:34:29 +0000 | [diff] [blame] | 732 | static inline bool within_module_core(unsigned long addr, |
| 733 | const struct module *mod) |
| 734 | { |
| 735 | return false; |
| 736 | } |
| 737 | |
Tri Vo | dadec06 | 2019-04-15 11:18:33 -0700 | [diff] [blame] | 738 | static inline bool within_module_init(unsigned long addr, |
| 739 | const struct module *mod) |
| 740 | { |
| 741 | return false; |
| 742 | } |
| 743 | |
| 744 | static inline bool within_module(unsigned long addr, const struct module *mod) |
| 745 | { |
| 746 | return false; |
| 747 | } |
| 748 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 749 | /* Get/put a kernel symbol (calls should be symmetric) */ |
| 750 | #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); }) |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 751 | #define symbol_put(x) do { } while (0) |
| 752 | #define symbol_put_addr(x) do { } while (0) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 753 | |
| 754 | static inline void __module_get(struct module *module) |
| 755 | { |
| 756 | } |
| 757 | |
Gao Feng | 8ba4fcd | 2017-04-19 09:47:22 +0800 | [diff] [blame] | 758 | static inline bool try_module_get(struct module *module) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 759 | { |
Gao Feng | 8ba4fcd | 2017-04-19 09:47:22 +0800 | [diff] [blame] | 760 | return true; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 761 | } |
| 762 | |
| 763 | static inline void module_put(struct module *module) |
| 764 | { |
| 765 | } |
| 766 | |
| 767 | #define module_name(mod) "kernel" |
| 768 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 769 | /* For kallsyms to ask for address resolution. NULL means not found. */ |
Andrew Morton | 92dfc9d | 2008-02-08 04:18:43 -0800 | [diff] [blame] | 770 | static inline const char *module_address_lookup(unsigned long addr, |
Rusty Russell | 6dd06c9 | 2008-01-29 17:13:22 -0500 | [diff] [blame] | 771 | unsigned long *symbolsize, |
| 772 | unsigned long *offset, |
| 773 | char **modname, |
| 774 | char *namebuf) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 775 | { |
| 776 | return NULL; |
| 777 | } |
| 778 | |
Alexey Dobriyan | 9d65cb4 | 2007-05-08 00:28:43 -0700 | [diff] [blame] | 779 | static inline int lookup_module_symbol_name(unsigned long addr, char *symname) |
| 780 | { |
| 781 | return -ERANGE; |
| 782 | } |
| 783 | |
Alexey Dobriyan | a5c43da | 2007-05-08 00:28:47 -0700 | [diff] [blame] | 784 | static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name) |
| 785 | { |
| 786 | return -ERANGE; |
| 787 | } |
| 788 | |
Alexey Dobriyan | ea07890 | 2007-05-08 00:28:39 -0700 | [diff] [blame] | 789 | static inline int module_get_kallsym(unsigned int symnum, unsigned long *value, |
| 790 | char *type, char *name, |
| 791 | char *module_name, int *exported) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 792 | { |
Alexey Dobriyan | ea07890 | 2007-05-08 00:28:39 -0700 | [diff] [blame] | 793 | return -ERANGE; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 794 | } |
| 795 | |
| 796 | static inline unsigned long module_kallsyms_lookup_name(const char *name) |
| 797 | { |
| 798 | return 0; |
| 799 | } |
| 800 | |
Anders Kaseorg | 75a6661 | 2008-12-05 19:03:58 -0500 | [diff] [blame] | 801 | static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *, |
| 802 | struct module *, |
| 803 | unsigned long), |
| 804 | void *data) |
| 805 | { |
| 806 | return 0; |
| 807 | } |
| 808 | |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 809 | static inline int register_module_notifier(struct notifier_block *nb) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 810 | { |
| 811 | /* no events will happen anyway, so this can always succeed */ |
| 812 | return 0; |
| 813 | } |
| 814 | |
Seunghun Lee | e865d06 | 2014-01-16 10:18:49 +1030 | [diff] [blame] | 815 | static inline int unregister_module_notifier(struct notifier_block *nb) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 816 | { |
| 817 | return 0; |
| 818 | } |
| 819 | |
| 820 | #define module_put_and_exit(code) do_exit(code) |
| 821 | |
| 822 | static inline void print_modules(void) |
| 823 | { |
| 824 | } |
Dmitry Torokhov | 80c6e14 | 2015-05-21 15:49:37 -0700 | [diff] [blame] | 825 | |
| 826 | static inline bool module_requested_async_probing(struct module *module) |
| 827 | { |
| 828 | return false; |
| 829 | } |
| 830 | |
Bruno E. O. Meneguele | fda784e | 2017-10-24 15:37:00 -0200 | [diff] [blame] | 831 | static inline bool is_module_sig_enforced(void) |
| 832 | { |
| 833 | return false; |
| 834 | } |
| 835 | |
Mimi Zohar | 8db5da0 | 2019-01-27 19:03:45 -0500 | [diff] [blame] | 836 | static inline void set_module_sig_enforced(void) |
| 837 | { |
| 838 | } |
| 839 | |
Sergey Senozhatsky | b865ea6 | 2017-11-10 08:48:25 +0900 | [diff] [blame] | 840 | /* Dereference module function descriptor */ |
| 841 | static inline |
| 842 | void *dereference_module_function_descriptor(struct module *mod, void *ptr) |
| 843 | { |
| 844 | return ptr; |
| 845 | } |
| 846 | |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 847 | #endif /* CONFIG_MODULES */ |
| 848 | |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 849 | #ifdef CONFIG_SYSFS |
Greg Kroah-Hartman | 7405c1e | 2007-11-01 10:39:50 -0700 | [diff] [blame] | 850 | extern struct kset *module_kset; |
| 851 | extern struct kobj_type module_ktype; |
| 852 | extern int module_sysfs_initialized; |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 853 | #endif /* CONFIG_SYSFS */ |
| 854 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 855 | #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x) |
| 856 | |
| 857 | /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */ |
| 858 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 859 | #define __MODULE_STRING(x) __stringify(x) |
| 860 | |
Laura Abbott | 0f5bf6d | 2017-02-06 16:31:58 -0800 | [diff] [blame] | 861 | #ifdef CONFIG_STRICT_MODULE_RWX |
Jessica Yu | 444d13f | 2016-07-27 12:06:21 +0930 | [diff] [blame] | 862 | extern void module_enable_ro(const struct module *mod, bool after_init); |
Rusty Russell | 85c898d | 2015-11-26 09:45:08 +1030 | [diff] [blame] | 863 | extern void module_disable_ro(const struct module *mod); |
matthieu castet | 84e1c6b | 2010-11-16 22:35:16 +0100 | [diff] [blame] | 864 | #else |
Jessica Yu | 444d13f | 2016-07-27 12:06:21 +0930 | [diff] [blame] | 865 | static inline void module_enable_ro(const struct module *mod, bool after_init) { } |
Rusty Russell | 85c898d | 2015-11-26 09:45:08 +1030 | [diff] [blame] | 866 | static inline void module_disable_ro(const struct module *mod) { } |
matthieu castet | 84e1c6b | 2010-11-16 22:35:16 +0100 | [diff] [blame] | 867 | #endif |
Andrew Morton | 0d9c25d | 2009-06-16 15:33:37 -0700 | [diff] [blame] | 868 | |
| 869 | #ifdef CONFIG_GENERIC_BUG |
Linus Torvalds | 5336377 | 2010-10-05 11:29:27 -0700 | [diff] [blame] | 870 | void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *, |
Andrew Morton | 0d9c25d | 2009-06-16 15:33:37 -0700 | [diff] [blame] | 871 | struct module *); |
| 872 | void module_bug_cleanup(struct module *); |
| 873 | |
| 874 | #else /* !CONFIG_GENERIC_BUG */ |
| 875 | |
Linus Torvalds | 5336377 | 2010-10-05 11:29:27 -0700 | [diff] [blame] | 876 | static inline void module_bug_finalize(const Elf_Ehdr *hdr, |
Andrew Morton | 0d9c25d | 2009-06-16 15:33:37 -0700 | [diff] [blame] | 877 | const Elf_Shdr *sechdrs, |
| 878 | struct module *mod) |
| 879 | { |
Andrew Morton | 0d9c25d | 2009-06-16 15:33:37 -0700 | [diff] [blame] | 880 | } |
| 881 | static inline void module_bug_cleanup(struct module *mod) {} |
| 882 | #endif /* CONFIG_GENERIC_BUG */ |
| 883 | |
WANG Chao | e4f3589 | 2018-12-11 00:37:25 +0800 | [diff] [blame] | 884 | #ifdef CONFIG_RETPOLINE |
Andi Kleen | caf7501 | 2018-01-25 15:50:28 -0800 | [diff] [blame] | 885 | extern bool retpoline_module_ok(bool has_retpoline); |
| 886 | #else |
| 887 | static inline bool retpoline_module_ok(bool has_retpoline) |
| 888 | { |
| 889 | return true; |
| 890 | } |
| 891 | #endif |
| 892 | |
Herbert Xu | 59afdc7 | 2015-04-22 11:28:46 +0800 | [diff] [blame] | 893 | #ifdef CONFIG_MODULE_SIG |
| 894 | static inline bool module_sig_ok(struct module *module) |
| 895 | { |
| 896 | return module->sig_ok; |
| 897 | } |
| 898 | #else /* !CONFIG_MODULE_SIG */ |
| 899 | static inline bool module_sig_ok(struct module *module) |
| 900 | { |
| 901 | return true; |
| 902 | } |
| 903 | #endif /* CONFIG_MODULE_SIG */ |
| 904 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 905 | #endif /* _LINUX_MODULE_H */ |