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> |
| 14 | #include <linux/elf.h> |
| 15 | #include <linux/stringify.h> |
| 16 | #include <linux/kobject.h> |
| 17 | #include <linux/moduleparam.h> |
Mathieu Desnoyers | 8256e47 | 2007-10-18 23:41:06 -0700 | [diff] [blame] | 18 | #include <linux/marker.h> |
Mathieu Desnoyers | 97e1c18 | 2008-07-18 12:16:16 -0400 | [diff] [blame] | 19 | #include <linux/tracepoint.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | #include <asm/local.h> |
| 21 | |
| 22 | #include <asm/module.h> |
| 23 | |
| 24 | /* Not Yet Implemented */ |
| 25 | #define MODULE_SUPPORTED_DEVICE(name) |
| 26 | |
Adrian Bunk | f606ddf | 2008-07-23 21:28:50 -0700 | [diff] [blame] | 27 | /* some toolchains uses a `_' prefix for all user symbols */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | #ifndef MODULE_SYMBOL_PREFIX |
| 29 | #define MODULE_SYMBOL_PREFIX "" |
| 30 | #endif |
| 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 | |
| 34 | struct kernel_symbol |
| 35 | { |
| 36 | unsigned long value; |
| 37 | const char *name; |
| 38 | }; |
| 39 | |
| 40 | struct modversion_info |
| 41 | { |
| 42 | unsigned long crc; |
| 43 | char name[MODULE_NAME_LEN]; |
| 44 | }; |
| 45 | |
| 46 | struct module; |
| 47 | |
| 48 | struct module_attribute { |
| 49 | struct attribute attr; |
| 50 | ssize_t (*show)(struct module_attribute *, struct module *, char *); |
| 51 | ssize_t (*store)(struct module_attribute *, struct module *, |
| 52 | const char *, size_t count); |
Matt Domsch | c988d2b | 2005-06-23 22:05:15 -0700 | [diff] [blame] | 53 | void (*setup)(struct module *, const char *); |
| 54 | int (*test)(struct module *); |
| 55 | void (*free)(struct module *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | }; |
| 57 | |
| 58 | struct module_kobject |
| 59 | { |
| 60 | struct kobject kobj; |
| 61 | struct module *mod; |
Kay Sievers | f30c53a | 2007-01-15 20:22:02 +0100 | [diff] [blame] | 62 | struct kobject *drivers_dir; |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 63 | struct module_param_attrs *mp; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 64 | }; |
| 65 | |
| 66 | /* These are either module local, or the kernel's dummy ones. */ |
| 67 | extern int init_module(void); |
| 68 | extern void cleanup_module(void); |
| 69 | |
| 70 | /* Archs provide a method of finding the correct exception table. */ |
| 71 | struct exception_table_entry; |
| 72 | |
| 73 | const struct exception_table_entry * |
| 74 | search_extable(const struct exception_table_entry *first, |
| 75 | const struct exception_table_entry *last, |
| 76 | unsigned long value); |
| 77 | void sort_extable(struct exception_table_entry *start, |
| 78 | struct exception_table_entry *finish); |
| 79 | void sort_main_extable(void); |
| 80 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | #ifdef MODULE |
| 82 | #define MODULE_GENERIC_TABLE(gtype,name) \ |
| 83 | extern const struct gtype##_id __mod_##gtype##_table \ |
| 84 | __attribute__ ((unused, alias(__stringify(name)))) |
| 85 | |
| 86 | extern struct module __this_module; |
| 87 | #define THIS_MODULE (&__this_module) |
| 88 | #else /* !MODULE */ |
| 89 | #define MODULE_GENERIC_TABLE(gtype,name) |
| 90 | #define THIS_MODULE ((struct module *)0) |
| 91 | #endif |
| 92 | |
| 93 | /* Generic info of form tag = "info" */ |
| 94 | #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info) |
| 95 | |
| 96 | /* For userspace: you can also call me... */ |
| 97 | #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias) |
| 98 | |
| 99 | /* |
| 100 | * The following license idents are currently accepted as indicating free |
| 101 | * software modules |
| 102 | * |
| 103 | * "GPL" [GNU Public License v2 or later] |
| 104 | * "GPL v2" [GNU Public License v2] |
| 105 | * "GPL and additional rights" [GNU Public License v2 rights and more] |
| 106 | * "Dual BSD/GPL" [GNU Public License v2 |
| 107 | * or BSD license choice] |
Xose Vazquez Perez | 8d27e90 | 2006-06-23 02:05:13 -0700 | [diff] [blame] | 108 | * "Dual MIT/GPL" [GNU Public License v2 |
| 109 | * or MIT license choice] |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 110 | * "Dual MPL/GPL" [GNU Public License v2 |
| 111 | * or Mozilla license choice] |
| 112 | * |
| 113 | * The following other idents are available |
| 114 | * |
| 115 | * "Proprietary" [Non free products] |
| 116 | * |
| 117 | * There are dual licensed components, but when running with Linux it is the |
| 118 | * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL |
| 119 | * is a GPL combined work. |
| 120 | * |
| 121 | * This exists for several reasons |
| 122 | * 1. So modinfo can show license info for users wanting to vet their setup |
| 123 | * is free |
| 124 | * 2. So the community can ignore bug reports including proprietary modules |
| 125 | * 3. So vendors can do likewise based on their own policies |
| 126 | */ |
| 127 | #define MODULE_LICENSE(_license) MODULE_INFO(license, _license) |
| 128 | |
Rene Herman | 108f39a | 2007-05-10 22:22:50 -0700 | [diff] [blame] | 129 | /* Author, ideally of form NAME[, NAME]*[ and NAME] */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author) |
| 131 | |
| 132 | /* What your module does. */ |
| 133 | #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description) |
| 134 | |
| 135 | /* One for each parameter, describing how to use it. Some files do |
| 136 | multiple of these per line, so can't just use MODULE_INFO. */ |
| 137 | #define MODULE_PARM_DESC(_parm, desc) \ |
| 138 | __MODULE_INFO(parm, _parm, #_parm ":" desc) |
| 139 | |
| 140 | #define MODULE_DEVICE_TABLE(type,name) \ |
| 141 | MODULE_GENERIC_TABLE(type##_device,name) |
| 142 | |
| 143 | /* Version of form [<epoch>:]<version>[-<extra-version>]. |
| 144 | Or for CVS/RCS ID version, everything but the number is stripped. |
| 145 | <epoch>: A (small) unsigned integer which allows you to start versions |
| 146 | anew. If not mentioned, it's zero. eg. "2:1.0" is after |
| 147 | "1:2.0". |
| 148 | <version>: The <version> may contain only alphanumerics and the |
| 149 | character `.'. Ordered by numeric sort for numeric parts, |
| 150 | ascii sort for ascii parts (as per RPM or DEB algorithm). |
| 151 | <extraversion>: Like <version>, but inserted for local |
| 152 | customizations, eg "rh3" or "rusty1". |
| 153 | |
| 154 | Using this automatically adds a checksum of the .c files and the |
| 155 | local headers in "srcversion". |
| 156 | */ |
| 157 | #define MODULE_VERSION(_version) MODULE_INFO(version, _version) |
| 158 | |
Jon Masters | 187afbe | 2006-08-28 17:08:21 -0500 | [diff] [blame] | 159 | /* Optional firmware file (or files) needed by the module |
| 160 | * format is simply firmware file name. Multiple firmware |
| 161 | * files require multiple MODULE_FIRMWARE() specifiers */ |
| 162 | #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware) |
| 163 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | /* Given an address, look for it in the exception tables */ |
| 165 | const struct exception_table_entry *search_exception_tables(unsigned long add); |
| 166 | |
| 167 | struct notifier_block; |
| 168 | |
| 169 | #ifdef CONFIG_MODULES |
| 170 | |
| 171 | /* Get/put a kernel symbol (calls must be symmetric) */ |
| 172 | void *__symbol_get(const char *symbol); |
| 173 | void *__symbol_get_gpl(const char *symbol); |
| 174 | #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x))) |
| 175 | |
| 176 | #ifndef __GENKSYMS__ |
| 177 | #ifdef CONFIG_MODVERSIONS |
| 178 | /* Mark the CRC weak since genksyms apparently decides not to |
| 179 | * generate a checksums for some symbols */ |
| 180 | #define __CRC_SYMBOL(sym, sec) \ |
| 181 | extern void *__crc_##sym __attribute__((weak)); \ |
| 182 | static const unsigned long __kcrctab_##sym \ |
Adrian Bunk | 3ff6eec | 2008-01-24 22:16:20 +0100 | [diff] [blame] | 183 | __used \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 184 | __attribute__((section("__kcrctab" sec), unused)) \ |
| 185 | = (unsigned long) &__crc_##sym; |
| 186 | #else |
| 187 | #define __CRC_SYMBOL(sym, sec) |
| 188 | #endif |
| 189 | |
| 190 | /* For every exported symbol, place a struct in the __ksymtab section */ |
| 191 | #define __EXPORT_SYMBOL(sym, sec) \ |
Patrick McHardy | a1a8fee | 2006-03-23 22:07:34 -0800 | [diff] [blame] | 192 | extern typeof(sym) sym; \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | __CRC_SYMBOL(sym, sec) \ |
| 194 | static const char __kstrtab_##sym[] \ |
Rusty Russell | ea01e79 | 2008-03-13 09:02:17 +0000 | [diff] [blame] | 195 | __attribute__((section("__ksymtab_strings"), aligned(1))) \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 196 | = MODULE_SYMBOL_PREFIX #sym; \ |
| 197 | static const struct kernel_symbol __ksymtab_##sym \ |
Adrian Bunk | 3ff6eec | 2008-01-24 22:16:20 +0100 | [diff] [blame] | 198 | __used \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | __attribute__((section("__ksymtab" sec), unused)) \ |
| 200 | = { (unsigned long)&sym, __kstrtab_##sym } |
| 201 | |
| 202 | #define EXPORT_SYMBOL(sym) \ |
| 203 | __EXPORT_SYMBOL(sym, "") |
| 204 | |
| 205 | #define EXPORT_SYMBOL_GPL(sym) \ |
| 206 | __EXPORT_SYMBOL(sym, "_gpl") |
| 207 | |
Greg Kroah-Hartman | 9f28bb7 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 208 | #define EXPORT_SYMBOL_GPL_FUTURE(sym) \ |
| 209 | __EXPORT_SYMBOL(sym, "_gpl_future") |
| 210 | |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 211 | |
| 212 | #ifdef CONFIG_UNUSED_SYMBOLS |
| 213 | #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused") |
| 214 | #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl") |
| 215 | #else |
| 216 | #define EXPORT_UNUSED_SYMBOL(sym) |
| 217 | #define EXPORT_UNUSED_SYMBOL_GPL(sym) |
| 218 | #endif |
| 219 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 220 | #endif |
| 221 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 222 | enum module_state |
| 223 | { |
| 224 | MODULE_STATE_LIVE, |
| 225 | MODULE_STATE_COMING, |
| 226 | MODULE_STATE_GOING, |
| 227 | }; |
| 228 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 229 | struct module |
| 230 | { |
| 231 | enum module_state state; |
| 232 | |
| 233 | /* Member of list of modules */ |
| 234 | struct list_head list; |
| 235 | |
| 236 | /* Unique handle for this module */ |
| 237 | char name[MODULE_NAME_LEN]; |
| 238 | |
| 239 | /* Sysfs stuff. */ |
| 240 | struct module_kobject mkobj; |
Greg Kroah-Hartman | 03e88ae1 | 2006-02-16 13:50:23 -0800 | [diff] [blame] | 241 | struct module_attribute *modinfo_attrs; |
Matt Domsch | c988d2b | 2005-06-23 22:05:15 -0700 | [diff] [blame] | 242 | const char *version; |
| 243 | const char *srcversion; |
Kay Sievers | 270a6c4 | 2007-01-18 13:26:15 +0100 | [diff] [blame] | 244 | struct kobject *holders_dir; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 245 | |
| 246 | /* Exported symbols */ |
| 247 | const struct kernel_symbol *syms; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 248 | const unsigned long *crcs; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 249 | unsigned int num_syms; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 250 | |
| 251 | /* GPL-only exported symbols. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 252 | unsigned int num_gpl_syms; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 253 | const struct kernel_symbol *gpl_syms; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 254 | const unsigned long *gpl_crcs; |
| 255 | |
Denys Vlasenko | f7f5b67 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 256 | #ifdef CONFIG_UNUSED_SYMBOLS |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 257 | /* unused exported symbols. */ |
| 258 | const struct kernel_symbol *unused_syms; |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 259 | const unsigned long *unused_crcs; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 260 | unsigned int num_unused_syms; |
| 261 | |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 262 | /* GPL-only, unused exported symbols. */ |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 263 | unsigned int num_unused_gpl_syms; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 264 | const struct kernel_symbol *unused_gpl_syms; |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 265 | const unsigned long *unused_gpl_crcs; |
Denys Vlasenko | f7f5b67 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 266 | #endif |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 267 | |
Greg Kroah-Hartman | 9f28bb7 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 268 | /* symbols that will be GPL-only in the near future. */ |
| 269 | const struct kernel_symbol *gpl_future_syms; |
Greg Kroah-Hartman | 9f28bb7 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 270 | const unsigned long *gpl_future_crcs; |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 271 | unsigned int num_gpl_future_syms; |
Greg Kroah-Hartman | 9f28bb7 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 272 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 273 | /* Exception table */ |
| 274 | unsigned int num_exentries; |
Rusty Russell | 5e458cc | 2008-10-22 10:00:13 -0500 | [diff] [blame] | 275 | struct exception_table_entry *extable; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 276 | |
| 277 | /* Startup function. */ |
| 278 | int (*init)(void); |
| 279 | |
| 280 | /* If this is non-NULL, vfree after init() returns */ |
| 281 | void *module_init; |
| 282 | |
| 283 | /* Here is the actual code + data, vfree'd on unload. */ |
| 284 | void *module_core; |
| 285 | |
| 286 | /* Here are the sizes of the init and core sections */ |
Denys Vlasenko | 2f0f2a3 | 2008-07-22 19:24:27 -0500 | [diff] [blame] | 287 | unsigned int init_size, core_size; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 288 | |
| 289 | /* The size of the executable code in each section. */ |
Denys Vlasenko | 2f0f2a3 | 2008-07-22 19:24:27 -0500 | [diff] [blame] | 290 | unsigned int init_text_size, core_text_size; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 291 | |
| 292 | /* Arch-specific module values */ |
| 293 | struct mod_arch_specific arch; |
| 294 | |
Randy Dunlap | 2bc2d61 | 2006-10-02 02:17:02 -0700 | [diff] [blame] | 295 | unsigned int taints; /* same bits as kernel:tainted */ |
| 296 | |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 297 | #ifdef CONFIG_GENERIC_BUG |
| 298 | /* Support for BUG */ |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 299 | unsigned num_bugs; |
Jeremy Fitzhardinge | 7664c5a | 2006-12-08 02:36:19 -0800 | [diff] [blame] | 300 | struct list_head bug_list; |
| 301 | struct bug_entry *bug_table; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 302 | #endif |
| 303 | |
| 304 | #ifdef CONFIG_KALLSYMS |
| 305 | /* We keep the symbol and string tables for kallsyms. */ |
| 306 | Elf_Sym *symtab; |
Denys Vlasenko | 2f0f2a3 | 2008-07-22 19:24:27 -0500 | [diff] [blame] | 307 | unsigned int num_symtab; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 308 | char *strtab; |
| 309 | |
| 310 | /* Section attributes */ |
| 311 | struct module_sect_attrs *sect_attrs; |
Roland McGrath | 6d76013 | 2007-10-16 23:26:40 -0700 | [diff] [blame] | 312 | |
| 313 | /* Notes attributes */ |
| 314 | struct module_notes_attrs *notes_attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 315 | #endif |
| 316 | |
| 317 | /* Per-cpu data. */ |
| 318 | void *percpu; |
| 319 | |
| 320 | /* The command line arguments (may be mangled). People like |
| 321 | keeping pointers to this stuff */ |
| 322 | char *args; |
Mathieu Desnoyers | 8256e47 | 2007-10-18 23:41:06 -0700 | [diff] [blame] | 323 | #ifdef CONFIG_MARKERS |
| 324 | struct marker *markers; |
| 325 | unsigned int num_markers; |
| 326 | #endif |
Mathieu Desnoyers | 97e1c18 | 2008-07-18 12:16:16 -0400 | [diff] [blame] | 327 | #ifdef CONFIG_TRACEPOINTS |
| 328 | struct tracepoint *tracepoints; |
| 329 | unsigned int num_tracepoints; |
| 330 | #endif |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 331 | |
| 332 | #ifdef CONFIG_MODULE_UNLOAD |
| 333 | /* What modules depend on me? */ |
| 334 | struct list_head modules_which_use_me; |
| 335 | |
| 336 | /* Who is waiting for us to be unloaded */ |
| 337 | struct task_struct *waiter; |
| 338 | |
| 339 | /* Destruction function. */ |
| 340 | void (*exit)(void); |
| 341 | |
Eric Dumazet | 720eba3 | 2009-02-03 13:31:36 +1030 | [diff] [blame] | 342 | #ifdef CONFIG_SMP |
| 343 | char *refptr; |
| 344 | #else |
| 345 | local_t ref; |
| 346 | #endif |
Richard Kennedy | af54068 | 2008-07-22 19:24:26 -0500 | [diff] [blame] | 347 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 348 | }; |
Roman Zippel | e61a1c1 | 2007-05-09 02:35:15 -0700 | [diff] [blame] | 349 | #ifndef MODULE_ARCH_INIT |
| 350 | #define MODULE_ARCH_INIT {} |
| 351 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 352 | |
| 353 | /* FIXME: It'd be nice to isolate modules during init, too, so they |
| 354 | aren't used before they (may) fail. But presently too much code |
| 355 | (IDE & SCSI) require entry into the module during init.*/ |
| 356 | static inline int module_is_live(struct module *mod) |
| 357 | { |
| 358 | return mod->state != MODULE_STATE_GOING; |
| 359 | } |
| 360 | |
| 361 | /* Is this address in a module? (second is with no locks, for oops) */ |
| 362 | struct module *module_text_address(unsigned long addr); |
| 363 | struct module *__module_text_address(unsigned long addr); |
Ingo Molnar | 4d435f9 | 2006-07-03 00:24:24 -0700 | [diff] [blame] | 364 | int is_module_address(unsigned long addr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 365 | |
Masami Hiramatsu | a06f621 | 2009-01-06 14:41:49 -0800 | [diff] [blame] | 366 | static inline int within_module_core(unsigned long addr, struct module *mod) |
| 367 | { |
| 368 | return (unsigned long)mod->module_core <= addr && |
| 369 | addr < (unsigned long)mod->module_core + mod->core_size; |
| 370 | } |
| 371 | |
| 372 | static inline int within_module_init(unsigned long addr, struct module *mod) |
| 373 | { |
| 374 | return (unsigned long)mod->module_init <= addr && |
| 375 | addr < (unsigned long)mod->module_init + mod->init_size; |
| 376 | } |
| 377 | |
Alexey Dobriyan | ea07890 | 2007-05-08 00:28:39 -0700 | [diff] [blame] | 378 | /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 379 | symnum out of range. */ |
Alexey Dobriyan | ea07890 | 2007-05-08 00:28:39 -0700 | [diff] [blame] | 380 | int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type, |
| 381 | char *name, char *module_name, int *exported); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 382 | |
| 383 | /* Look for this name: can be of form module:name. */ |
| 384 | unsigned long module_kallsyms_lookup_name(const char *name); |
| 385 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 386 | extern void __module_put_and_exit(struct module *mod, long code) |
| 387 | __attribute__((noreturn)); |
| 388 | #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code); |
| 389 | |
| 390 | #ifdef CONFIG_MODULE_UNLOAD |
| 391 | unsigned int module_refcount(struct module *mod); |
| 392 | void __symbol_put(const char *symbol); |
| 393 | #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x) |
| 394 | void symbol_put_addr(void *addr); |
| 395 | |
Eric Dumazet | 720eba3 | 2009-02-03 13:31:36 +1030 | [diff] [blame] | 396 | static inline local_t *__module_ref_addr(struct module *mod, int cpu) |
| 397 | { |
| 398 | #ifdef CONFIG_SMP |
| 399 | return (local_t *) (mod->refptr + per_cpu_offset(cpu)); |
| 400 | #else |
| 401 | return &mod->ref; |
| 402 | #endif |
| 403 | } |
| 404 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 405 | /* Sometimes we know we already have a refcount, and it's easier not |
| 406 | to handle the error case (which only happens with rmmod --wait). */ |
| 407 | static inline void __module_get(struct module *module) |
| 408 | { |
| 409 | if (module) { |
Eric Dumazet | 720eba3 | 2009-02-03 13:31:36 +1030 | [diff] [blame] | 410 | local_inc(__module_ref_addr(module, get_cpu())); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 411 | put_cpu(); |
| 412 | } |
| 413 | } |
| 414 | |
| 415 | static inline int try_module_get(struct module *module) |
| 416 | { |
| 417 | int ret = 1; |
| 418 | |
| 419 | if (module) { |
| 420 | unsigned int cpu = get_cpu(); |
| 421 | if (likely(module_is_live(module))) |
Eric Dumazet | 720eba3 | 2009-02-03 13:31:36 +1030 | [diff] [blame] | 422 | local_inc(__module_ref_addr(module, cpu)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 423 | else |
| 424 | ret = 0; |
| 425 | put_cpu(); |
| 426 | } |
| 427 | return ret; |
| 428 | } |
| 429 | |
Al Viro | f6a5703 | 2006-10-18 01:47:25 -0400 | [diff] [blame] | 430 | extern void module_put(struct module *module); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 431 | |
| 432 | #else /*!CONFIG_MODULE_UNLOAD*/ |
| 433 | static inline int try_module_get(struct module *module) |
| 434 | { |
| 435 | return !module || module_is_live(module); |
| 436 | } |
| 437 | static inline void module_put(struct module *module) |
| 438 | { |
| 439 | } |
| 440 | static inline void __module_get(struct module *module) |
| 441 | { |
| 442 | } |
| 443 | #define symbol_put(x) do { } while(0) |
| 444 | #define symbol_put_addr(p) do { } while(0) |
| 445 | |
| 446 | #endif /* CONFIG_MODULE_UNLOAD */ |
| 447 | |
| 448 | /* This is a #define so the string doesn't get put in every .o file */ |
| 449 | #define module_name(mod) \ |
| 450 | ({ \ |
| 451 | struct module *__mod = (mod); \ |
| 452 | __mod ? __mod->name : "kernel"; \ |
| 453 | }) |
| 454 | |
Rusty Russell | 6dd06c9 | 2008-01-29 17:13:22 -0500 | [diff] [blame] | 455 | /* For kallsyms to ask for address resolution. namebuf should be at |
| 456 | * least KSYM_NAME_LEN long: a pointer to namebuf is returned if |
| 457 | * found, otherwise NULL. */ |
Andrew Morton | 92dfc9d | 2008-02-08 04:18:43 -0800 | [diff] [blame] | 458 | const char *module_address_lookup(unsigned long addr, |
Rusty Russell | 6dd06c9 | 2008-01-29 17:13:22 -0500 | [diff] [blame] | 459 | unsigned long *symbolsize, |
| 460 | unsigned long *offset, |
| 461 | char **modname, |
| 462 | char *namebuf); |
Alexey Dobriyan | 9d65cb4 | 2007-05-08 00:28:43 -0700 | [diff] [blame] | 463 | int lookup_module_symbol_name(unsigned long addr, char *symname); |
Alexey Dobriyan | a5c43da | 2007-05-08 00:28:47 -0700 | [diff] [blame] | 464 | 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] | 465 | |
| 466 | /* For extable.c to search modules' exception tables. */ |
| 467 | const struct exception_table_entry *search_module_extables(unsigned long addr); |
| 468 | |
| 469 | int register_module_notifier(struct notifier_block * nb); |
| 470 | int unregister_module_notifier(struct notifier_block * nb); |
| 471 | |
| 472 | extern void print_modules(void); |
| 473 | |
Mathieu Desnoyers | fb40bd7 | 2008-02-13 15:03:37 -0800 | [diff] [blame] | 474 | extern void module_update_markers(void); |
Mathieu Desnoyers | 8256e47 | 2007-10-18 23:41:06 -0700 | [diff] [blame] | 475 | |
Mathieu Desnoyers | 97e1c18 | 2008-07-18 12:16:16 -0400 | [diff] [blame] | 476 | extern void module_update_tracepoints(void); |
| 477 | extern int module_get_iter_tracepoints(struct tracepoint_iter *iter); |
| 478 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 479 | #else /* !CONFIG_MODULES... */ |
| 480 | #define EXPORT_SYMBOL(sym) |
| 481 | #define EXPORT_SYMBOL_GPL(sym) |
Greg Kroah-Hartman | 9f28bb7 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 482 | #define EXPORT_SYMBOL_GPL_FUTURE(sym) |
Arjan van de Ven | f71d20e | 2006-06-28 04:26:45 -0700 | [diff] [blame] | 483 | #define EXPORT_UNUSED_SYMBOL(sym) |
| 484 | #define EXPORT_UNUSED_SYMBOL_GPL(sym) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 485 | |
| 486 | /* Given an address, look for it in the exception tables. */ |
| 487 | static inline const struct exception_table_entry * |
| 488 | search_module_extables(unsigned long addr) |
| 489 | { |
| 490 | return NULL; |
| 491 | } |
| 492 | |
| 493 | /* Is this address in a module? */ |
| 494 | static inline struct module *module_text_address(unsigned long addr) |
| 495 | { |
| 496 | return NULL; |
| 497 | } |
| 498 | |
| 499 | /* Is this address in a module? (don't take a lock, we're oopsing) */ |
| 500 | static inline struct module *__module_text_address(unsigned long addr) |
| 501 | { |
| 502 | return NULL; |
| 503 | } |
| 504 | |
Ingo Molnar | 4d435f9 | 2006-07-03 00:24:24 -0700 | [diff] [blame] | 505 | static inline int is_module_address(unsigned long addr) |
| 506 | { |
| 507 | return 0; |
| 508 | } |
| 509 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 510 | /* Get/put a kernel symbol (calls should be symmetric) */ |
| 511 | #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); }) |
| 512 | #define symbol_put(x) do { } while(0) |
| 513 | #define symbol_put_addr(x) do { } while(0) |
| 514 | |
| 515 | static inline void __module_get(struct module *module) |
| 516 | { |
| 517 | } |
| 518 | |
| 519 | static inline int try_module_get(struct module *module) |
| 520 | { |
| 521 | return 1; |
| 522 | } |
| 523 | |
| 524 | static inline void module_put(struct module *module) |
| 525 | { |
| 526 | } |
| 527 | |
| 528 | #define module_name(mod) "kernel" |
| 529 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 530 | /* For kallsyms to ask for address resolution. NULL means not found. */ |
Andrew Morton | 92dfc9d | 2008-02-08 04:18:43 -0800 | [diff] [blame] | 531 | static inline const char *module_address_lookup(unsigned long addr, |
Rusty Russell | 6dd06c9 | 2008-01-29 17:13:22 -0500 | [diff] [blame] | 532 | unsigned long *symbolsize, |
| 533 | unsigned long *offset, |
| 534 | char **modname, |
| 535 | char *namebuf) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 536 | { |
| 537 | return NULL; |
| 538 | } |
| 539 | |
Alexey Dobriyan | 9d65cb4 | 2007-05-08 00:28:43 -0700 | [diff] [blame] | 540 | static inline int lookup_module_symbol_name(unsigned long addr, char *symname) |
| 541 | { |
| 542 | return -ERANGE; |
| 543 | } |
| 544 | |
Alexey Dobriyan | a5c43da | 2007-05-08 00:28:47 -0700 | [diff] [blame] | 545 | static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name) |
| 546 | { |
| 547 | return -ERANGE; |
| 548 | } |
| 549 | |
Alexey Dobriyan | ea07890 | 2007-05-08 00:28:39 -0700 | [diff] [blame] | 550 | static inline int module_get_kallsym(unsigned int symnum, unsigned long *value, |
| 551 | char *type, char *name, |
| 552 | char *module_name, int *exported) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 553 | { |
Alexey Dobriyan | ea07890 | 2007-05-08 00:28:39 -0700 | [diff] [blame] | 554 | return -ERANGE; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 555 | } |
| 556 | |
| 557 | static inline unsigned long module_kallsyms_lookup_name(const char *name) |
| 558 | { |
| 559 | return 0; |
| 560 | } |
| 561 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 562 | static inline int register_module_notifier(struct notifier_block * nb) |
| 563 | { |
| 564 | /* no events will happen anyway, so this can always succeed */ |
| 565 | return 0; |
| 566 | } |
| 567 | |
| 568 | static inline int unregister_module_notifier(struct notifier_block * nb) |
| 569 | { |
| 570 | return 0; |
| 571 | } |
| 572 | |
| 573 | #define module_put_and_exit(code) do_exit(code) |
| 574 | |
| 575 | static inline void print_modules(void) |
| 576 | { |
| 577 | } |
| 578 | |
Adrian Bunk | 1387d0d | 2008-02-14 19:31:20 -0800 | [diff] [blame] | 579 | static inline void module_update_markers(void) |
Mathieu Desnoyers | 8256e47 | 2007-10-18 23:41:06 -0700 | [diff] [blame] | 580 | { |
| 581 | } |
| 582 | |
Mathieu Desnoyers | 97e1c18 | 2008-07-18 12:16:16 -0400 | [diff] [blame] | 583 | static inline void module_update_tracepoints(void) |
| 584 | { |
| 585 | } |
| 586 | |
| 587 | static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter) |
| 588 | { |
| 589 | return 0; |
| 590 | } |
| 591 | |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 592 | #endif /* CONFIG_MODULES */ |
| 593 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 594 | struct device_driver; |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 595 | #ifdef CONFIG_SYSFS |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 596 | struct module; |
| 597 | |
Greg Kroah-Hartman | 7405c1e | 2007-11-01 10:39:50 -0700 | [diff] [blame] | 598 | extern struct kset *module_kset; |
| 599 | extern struct kobj_type module_ktype; |
| 600 | extern int module_sysfs_initialized; |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 601 | |
| 602 | int mod_sysfs_init(struct module *mod); |
| 603 | int mod_sysfs_setup(struct module *mod, |
| 604 | struct kernel_param *kparam, |
| 605 | unsigned int num_params); |
| 606 | int module_add_modinfo_attrs(struct module *mod); |
| 607 | void module_remove_modinfo_attrs(struct module *mod); |
| 608 | |
| 609 | #else /* !CONFIG_SYSFS */ |
| 610 | |
| 611 | static inline int mod_sysfs_init(struct module *mod) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 612 | { |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 613 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 614 | } |
| 615 | |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 616 | static inline int mod_sysfs_setup(struct module *mod, |
| 617 | struct kernel_param *kparam, |
| 618 | unsigned int num_params) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 619 | { |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 620 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 621 | } |
| 622 | |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 623 | static inline int module_add_modinfo_attrs(struct module *mod) |
| 624 | { |
| 625 | return 0; |
| 626 | } |
| 627 | |
| 628 | static inline void module_remove_modinfo_attrs(struct module *mod) |
| 629 | { } |
| 630 | |
| 631 | #endif /* CONFIG_SYSFS */ |
| 632 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 633 | #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x) |
| 634 | |
| 635 | /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */ |
| 636 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 637 | #define __MODULE_STRING(x) __stringify(x) |
| 638 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 639 | #endif /* _LINUX_MODULE_H */ |