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