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