include/linux/module.h

   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  */
   9 #include <linux/config.h>
  10 #include <linux/sched.h>
  11 #include <linux/spinlock.h>
  12 #include <linux/list.h>
  13 #include <linux/stat.h>
  14 #include <linux/compiler.h>
  15 #include <linux/cache.h>
  16 #include <linux/kmod.h>
  17 #include <linux/elf.h>
  18 #include <linux/stringify.h>
  19 #include <linux/kobject.h>
  20 #include <linux/moduleparam.h>
  21 #include <asm/local.h>
  22
  23 #include <asm/module.h>
  24
  25 /* Not Yet Implemented */
  26 #define MODULE_SUPPORTED_DEVICE(name)
  27
  28 /* v850 toolchain uses a `_' prefix for all user symbols */
  29 #ifndef MODULE_SYMBOL_PREFIX
  30 #define MODULE_SYMBOL_PREFIX ""
  31 #endif
  32
  33 #define MODULE_NAME_LEN (64 - sizeof(unsigned long))
  34
  35 struct kernel_symbol
  36 {
  37         unsigned long value;
  38         const char *name;
  39 };
  40
  41 struct modversion_info
  42 {
  43         unsigned long crc;
  44         char name[MODULE_NAME_LEN];
  45 };
  46
  47 struct module;
  48
  49 struct module_attribute {
  50         struct attribute attr;
  51         ssize_t (*show)(struct module *, char *);
  52         ssize_t (*store)(struct module *, const char *, size_t count);
  53 };
  54
  55 struct module_kobject
  56 {
  57         struct kobject kobj;
  58         struct module *mod;
  59 };
  60
  61 /* These are either module local, or the kernel's dummy ones. */
  62 extern int init_module(void);
  63 extern void cleanup_module(void);
  64
  65 /* Archs provide a method of finding the correct exception table. */
  66 struct exception_table_entry;
  67
  68 const struct exception_table_entry *
  69 search_extable(const struct exception_table_entry *first,
  70                const struct exception_table_entry *last,
  71                unsigned long value);
  72 void sort_extable(struct exception_table_entry *start,
  73                   struct exception_table_entry *finish);
  74 void sort_main_extable(void);
  75
  76 extern struct subsystem module_subsys;
  77
  78 #ifdef MODULE
  79 #define ___module_cat(a,b) __mod_ ## a ## b
  80 #define __module_cat(a,b) ___module_cat(a,b)
  81 #define __MODULE_INFO(tag, name, info)                                    \
  82 static const char __module_cat(name,__LINE__)[]                           \
  83   __attribute_used__                                                      \
  84   __attribute__((section(".modinfo"),unused)) = __stringify(tag) "=" info
  85
  86 #define MODULE_GENERIC_TABLE(gtype,name)                        \
  87 extern const struct gtype##_id __mod_##gtype##_table            \
  88   __attribute__ ((unused, alias(__stringify(name))))
  89
  90 extern struct module __this_module;
  91 #define THIS_MODULE (&__this_module)
  92
  93 #else  /* !MODULE */
  94
  95 #define MODULE_GENERIC_TABLE(gtype,name)
  96 #define __MODULE_INFO(tag, name, info)
  97 #define THIS_MODULE ((struct module *)0)
  98 #endif
  99
 100 /* Generic info of form tag = "info" */
 101 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
 102
 103 /* For userspace: you can also call me... */
 104 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
 105
 106 /*
 107  * The following license idents are currently accepted as indicating free
 108  * software modules
 109  *
 110  *      "GPL"                           [GNU Public License v2 or later]
 111  *      "GPL v2"                        [GNU Public License v2]
 112  *      "GPL and additional rights"     [GNU Public License v2 rights and more]
 113  *      "Dual BSD/GPL"                  [GNU Public License v2
 114  *                                       or BSD license choice]
 115  *      "Dual MPL/GPL"                  [GNU Public License v2
 116  *                                       or Mozilla license choice]
 117  *
 118  * The following other idents are available
 119  *
 120  *      "Proprietary"                   [Non free products]
 121  *
 122  * There are dual licensed components, but when running with Linux it is the
 123  * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
 124  * is a GPL combined work.
 125  *
 126  * This exists for several reasons
 127  * 1.   So modinfo can show license info for users wanting to vet their setup
 128  *      is free
 129  * 2.   So the community can ignore bug reports including proprietary modules
 130  * 3.   So vendors can do likewise based on their own policies
 131  */
 132 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
 133
 134 /* Author, ideally of form NAME <EMAIL>[, NAME <EMAIL>]*[ and NAME <EMAIL>] */
 135 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
 136
 137 /* What your module does. */
 138 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
 139
 140 /* One for each parameter, describing how to use it.  Some files do
 141    multiple of these per line, so can't just use MODULE_INFO. */
 142 #define MODULE_PARM_DESC(_parm, desc) \
 143         __MODULE_INFO(parm, _parm, #_parm ":" desc)
 144
 145 #define MODULE_DEVICE_TABLE(type,name)          \
 146   MODULE_GENERIC_TABLE(type##_device,name)
 147
 148 /* Version of form [<epoch>:]<version>[-<extra-version>].
 149    Or for CVS/RCS ID version, everything but the number is stripped.
 150   <epoch>: A (small) unsigned integer which allows you to start versions
 151            anew. If not mentioned, it's zero.  eg. "2:1.0" is after
 152            "1:2.0".
 153   <version>: The <version> may contain only alphanumerics and the
 154            character `.'.  Ordered by numeric sort for numeric parts,
 155            ascii sort for ascii parts (as per RPM or DEB algorithm).
 156   <extraversion>: Like <version>, but inserted for local
 157            customizations, eg "rh3" or "rusty1".
 158
 159   Using this automatically adds a checksum of the .c files and the
 160   local headers in "srcversion".
 161 */
 162 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
 163
 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              \
 183         __attribute_used__                                      \
 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)                               \
 192         __CRC_SYMBOL(sym, sec)                                  \
 193         static const char __kstrtab_##sym[]                     \
 194         __attribute__((section("__ksymtab_strings")))           \
 195         = MODULE_SYMBOL_PREFIX #sym;                            \
 196         static const struct kernel_symbol __ksymtab_##sym       \
 197         __attribute_used__                                      \
 198         __attribute__((section("__ksymtab" sec), unused))       \
 199         = { (unsigned long)&sym, __kstrtab_##sym }
 200
 201 #define EXPORT_SYMBOL(sym)                                      \
 202         __EXPORT_SYMBOL(sym, "")
 203
 204 #define EXPORT_SYMBOL_GPL(sym)                                  \
 205         __EXPORT_SYMBOL(sym, "_gpl")
 206
 207 #endif
 208
 209 /* We don't mangle the actual symbol anymore, so no need for
 210  * special casing EXPORT_SYMBOL_NOVERS.  FIXME: Deprecated */
 211 #define EXPORT_SYMBOL_NOVERS(sym) EXPORT_SYMBOL(sym)
 212
 213 struct module_ref
 214 {
 215         local_t count;
 216 } ____cacheline_aligned;
 217
 218 enum module_state
 219 {
 220         MODULE_STATE_LIVE,
 221         MODULE_STATE_COMING,
 222         MODULE_STATE_GOING,
 223 };
 224
 225 /* Similar stuff for section attributes. */
 226 #define MODULE_SECT_NAME_LEN 32
 227 struct module_sect_attr
 228 {
 229         struct attribute attr;
 230         char name[MODULE_SECT_NAME_LEN];
 231         unsigned long address;
 232 };
 233
 234 struct module_sections
 235 {
 236         struct kobject kobj;
 237         struct module_sect_attr attrs[0];
 238 };
 239
 240 struct param_kobject;
 241
 242 struct module
 243 {
 244         enum module_state state;
 245
 246         /* Member of list of modules */
 247         struct list_head list;
 248
 249         /* Unique handle for this module */
 250         char name[MODULE_NAME_LEN];
 251
 252         /* Sysfs stuff. */
 253         struct module_kobject *mkobj;
 254         struct param_kobject *params_kobject;
 255
 256         /* Exported symbols */
 257         const struct kernel_symbol *syms;
 258         unsigned int num_syms;
 259         const unsigned long *crcs;
 260
 261         /* GPL-only exported symbols. */
 262         const struct kernel_symbol *gpl_syms;
 263         unsigned int num_gpl_syms;
 264         const unsigned long *gpl_crcs;
 265
 266         /* Exception table */
 267         unsigned int num_exentries;
 268         const struct exception_table_entry *extable;
 269
 270         /* Startup function. */
 271         int (*init)(void);
 272
 273         /* If this is non-NULL, vfree after init() returns */
 274         void *module_init;
 275
 276         /* Here is the actual code + data, vfree'd on unload. */
 277         void *module_core;
 278
 279         /* Here are the sizes of the init and core sections */
 280         unsigned long init_size, core_size;
 281
 282         /* The size of the executable code in each section.  */
 283         unsigned long init_text_size, core_text_size;
 284
 285         /* Arch-specific module values */
 286         struct mod_arch_specific arch;
 287
 288         /* Am I unsafe to unload? */
 289         int unsafe;
 290
 291         /* Am I GPL-compatible */
 292         int license_gplok;
 293
 294         /* Am I gpg signed */
 295         int gpgsig_ok;
 296
 297 #ifdef CONFIG_MODULE_UNLOAD
 298         /* Reference counts */
 299         struct module_ref ref[NR_CPUS];
 300
 301         /* What modules depend on me? */
 302         struct list_head modules_which_use_me;
 303
 304         /* Who is waiting for us to be unloaded */
 305         struct task_struct *waiter;
 306
 307         /* Destruction function. */
 308         void (*exit)(void);
 309 #endif
 310
 311 #ifdef CONFIG_KALLSYMS
 312         /* We keep the symbol and string tables for kallsyms. */
 313         Elf_Sym *symtab;
 314         unsigned long num_symtab;
 315         char *strtab;
 316
 317         /* Section attributes */
 318         struct module_sections *sect_attrs;
 319 #endif
 320
 321         /* Per-cpu data. */
 322         void *percpu;
 323
 324         /* The command line arguments (may be mangled).  People like
 325            keeping pointers to this stuff */
 326         char *args;
 327 };
 328
 329 /* FIXME: It'd be nice to isolate modules during init, too, so they
 330    aren't used before they (may) fail.  But presently too much code
 331    (IDE & SCSI) require entry into the module during init.*/
 332 static inline int module_is_live(struct module *mod)
 333 {
 334         return mod->state != MODULE_STATE_GOING;
 335 }
 336
 337 /* Is this address in a module? (second is with no locks, for oops) */
 338 struct module *module_text_address(unsigned long addr);
 339 struct module *__module_text_address(unsigned long addr);
 340
 341 /* Returns module and fills in value, defined and namebuf, or NULL if
 342    symnum out of range. */
 343 struct module *module_get_kallsym(unsigned int symnum,
 344                                   unsigned long *value,
 345                                   char *type,
 346                                   char namebuf[128]);
 347
 348 /* Look for this name: can be of form module:name. */
 349 unsigned long module_kallsyms_lookup_name(const char *name);
 350
 351 int is_exported(const char *name, const struct module *mod);
 352
 353 extern void __module_put_and_exit(struct module *mod, long code)
 354         __attribute__((noreturn));
 355 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
 356
 357 #ifdef CONFIG_MODULE_UNLOAD
 358 unsigned int module_refcount(struct module *mod);
 359 void __symbol_put(const char *symbol);
 360 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
 361 void symbol_put_addr(void *addr);
 362
 363 /* Sometimes we know we already have a refcount, and it's easier not
 364    to handle the error case (which only happens with rmmod --wait). */
 365 static inline void __module_get(struct module *module)
 366 {
 367         if (module) {
 368                 BUG_ON(module_refcount(module) == 0);
 369                 local_inc(&module->ref[get_cpu()].count);
 370                 put_cpu();
 371         }
 372 }
 373
 374 static inline int try_module_get(struct module *module)
 375 {
 376         int ret = 1;
 377
 378         if (module) {
 379                 unsigned int cpu = get_cpu();
 380                 if (likely(module_is_live(module)))
 381                         local_inc(&module->ref[cpu].count);
 382                 else
 383                         ret = 0;
 384                 put_cpu();
 385         }
 386         return ret;
 387 }
 388
 389 static inline void module_put(struct module *module)
 390 {
 391         if (module) {
 392                 unsigned int cpu = get_cpu();
 393                 local_dec(&module->ref[cpu].count);
 394                 /* Maybe they're waiting for us to drop reference? */
 395                 if (unlikely(!module_is_live(module)))
 396                         wake_up_process(module->waiter);
 397                 put_cpu();
 398         }
 399 }
 400
 401 #else /*!CONFIG_MODULE_UNLOAD*/
 402 static inline int try_module_get(struct module *module)
 403 {
 404         return !module || module_is_live(module);
 405 }
 406 static inline void module_put(struct module *module)
 407 {
 408 }
 409 static inline void __module_get(struct module *module)
 410 {
 411 }
 412 #define symbol_put(x) do { } while(0)
 413 #define symbol_put_addr(p) do { } while(0)
 414
 415 #endif /* CONFIG_MODULE_UNLOAD */
 416
 417 /* This is a #define so the string doesn't get put in every .o file */
 418 #define module_name(mod)                        \
 419 ({                                              \
 420         struct module *__mod = (mod);           \
 421         __mod ? __mod->name : "kernel";         \
 422 })
 423
 424 #define __unsafe(mod)                                                        \
 425 do {                                                                         \
 426         if (mod && !(mod)->unsafe) {                                         \
 427                 printk(KERN_WARNING                                          \
 428                        "Module %s cannot be unloaded due to unsafe usage in" \
 429                        " %s:%u\n", (mod)->name, __FILE__, __LINE__);         \
 430                 (mod)->unsafe = 1;                                           \
 431         }                                                                    \
 432 } while(0)
 433
 434 /* For kallsyms to ask for address resolution.  NULL means not found. */
 435 const char *module_address_lookup(unsigned long addr,
 436                                   unsigned long *symbolsize,
 437                                   unsigned long *offset,
 438                                   char **modname);
 439
 440 /* For extable.c to search modules' exception tables. */
 441 const struct exception_table_entry *search_module_extables(unsigned long addr);
 442
 443 int register_module_notifier(struct notifier_block * nb);
 444 int unregister_module_notifier(struct notifier_block * nb);
 445
 446 extern void print_modules(void);
 447
 448 struct device_driver;
 449 void module_add_driver(struct module *, struct device_driver *);
 450 void module_remove_driver(struct device_driver *);
 451
 452 #else /* !CONFIG_MODULES... */
 453 #define EXPORT_SYMBOL(sym)
 454 #define EXPORT_SYMBOL_GPL(sym)
 455 #define EXPORT_SYMBOL_NOVERS(sym)
 456
 457 /* Given an address, look for it in the exception tables. */
 458 static inline const struct exception_table_entry *
 459 search_module_extables(unsigned long addr)
 460 {
 461         return NULL;
 462 }
 463
 464 /* Is this address in a module? */
 465 static inline struct module *module_text_address(unsigned long addr)
 466 {
 467         return NULL;
 468 }
 469
 470 /* Is this address in a module? (don't take a lock, we're oopsing) */
 471 static inline struct module *__module_text_address(unsigned long addr)
 472 {
 473         return NULL;
 474 }
 475
 476 /* Get/put a kernel symbol (calls should be symmetric) */
 477 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
 478 #define symbol_put(x) do { } while(0)
 479 #define symbol_put_addr(x) do { } while(0)
 480
 481 static inline void __module_get(struct module *module)
 482 {
 483 }
 484
 485 static inline int try_module_get(struct module *module)
 486 {
 487         return 1;
 488 }
 489
 490 static inline void module_put(struct module *module)
 491 {
 492 }
 493
 494 #define module_name(mod) "kernel"
 495
 496 #define __unsafe(mod)
 497
 498 /* For kallsyms to ask for address resolution.  NULL means not found. */
 499 static inline const char *module_address_lookup(unsigned long addr,
 500                                                 unsigned long *symbolsize,
 501                                                 unsigned long *offset,
 502                                                 char **modname)
 503 {
 504         return NULL;
 505 }
 506
 507 static inline struct module *module_get_kallsym(unsigned int symnum,
 508                                                 unsigned long *value,
 509                                                 char *type,
 510                                                 char namebuf[128])
 511 {
 512         return NULL;
 513 }
 514
 515 static inline unsigned long module_kallsyms_lookup_name(const char *name)
 516 {
 517         return 0;
 518 }
 519
 520 static inline int is_exported(const char *name, const struct module *mod)
 521 {
 522         return 0;
 523 }
 524
 525 static inline int register_module_notifier(struct notifier_block * nb)
 526 {
 527         /* no events will happen anyway, so this can always succeed */
 528         return 0;
 529 }
 530
 531 static inline int unregister_module_notifier(struct notifier_block * nb)
 532 {
 533         return 0;
 534 }
 535
 536 #define module_put_and_exit(code) do_exit(code)
 537
 538 static inline void print_modules(void)
 539 {
 540 }
 541
 542 struct device_driver;
 543 struct module;
 544
 545 static inline void module_add_driver(struct module *module, struct device_driver *driver)
 546 {
 547 }
 548
 549 static inline void module_remove_driver(struct device_driver *driver)
 550 {
 551 }
 552
 553 #endif /* CONFIG_MODULES */
 554
 555 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
 556
 557 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
 558
 559 struct obsolete_modparm {
 560         char name[64];
 561         char type[64-sizeof(void *)];
 562         void *addr;
 563 };
 564
 565 static inline void MODULE_PARM_(void) { }
 566 #ifdef MODULE
 567 /* DEPRECATED: Do not use. */
 568 #define MODULE_PARM(var,type)                                               \
 569 struct obsolete_modparm __parm_##var __attribute__((section("__obsparm"))) = \
 570 { __stringify(var), type, &MODULE_PARM_ };
 571 #else
 572 #define MODULE_PARM(var,type) static void __attribute__((__unused__)) *__parm_##var = &MODULE_PARM_;
 573 #endif
 574
 575 #define __MODULE_STRING(x) __stringify(x)
 576
 577 /* Use symbol_get and symbol_put instead.  You'll thank me. */
 578 #define HAVE_INTER_MODULE
 579 extern void __deprecated inter_module_register(const char *,
 580                 struct module *, const void *);
 581 extern void __deprecated inter_module_unregister(const char *);
 582 extern const void * __deprecated inter_module_get(const char *);
 583 extern const void * __deprecated inter_module_get_request(const char *,
 584                 const char *);
 585 extern void __deprecated inter_module_put(const char *);
 586
 587 #endif /* _LINUX_MODULE_H */