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