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/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>
  18 #include <linux/marker.h>
  19 #include <linux/tracepoint.h>
  20 #include <asm/local.h>
  21
  22 #include <asm/module.h>
  23
  24 /* Not Yet Implemented */
  25 #define MODULE_SUPPORTED_DEVICE(name)
  26
  27 /* some toolchains uses a `_' prefix for all user symbols */
  28 #ifndef MODULE_SYMBOL_PREFIX
  29 #define MODULE_SYMBOL_PREFIX ""
  30 #endif
  31
  32 #define MODULE_NAME_LEN (64 - sizeof(unsigned long))
  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);
  53         void (*setup)(struct module *, const char *);
  54         int (*test)(struct module *);
  55         void (*free)(struct module *);
  56 };
  57
  58 struct module_kobject
  59 {
  60         struct kobject kobj;
  61         struct module *mod;
  62         struct kobject *drivers_dir;
  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 #ifdef MODULE
  81 #define MODULE_GENERIC_TABLE(gtype,name)                        \
  82 extern const struct gtype##_id __mod_##gtype##_table            \
  83   __attribute__ ((unused, alias(__stringify(name))))
  84
  85 extern struct module __this_module;
  86 #define THIS_MODULE (&__this_module)
  87 #else  /* !MODULE */
  88 #define MODULE_GENERIC_TABLE(gtype,name)
  89 #define THIS_MODULE ((struct module *)0)
  90 #endif
  91
  92 /* Generic info of form tag = "info" */
  93 #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
  94
  95 /* For userspace: you can also call me... */
  96 #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
  97
  98 /*
  99  * The following license idents are currently accepted as indicating free
 100  * software modules
 101  *
 102  *      "GPL"                           [GNU Public License v2 or later]
 103  *      "GPL v2"                        [GNU Public License v2]
 104  *      "GPL and additional rights"     [GNU Public License v2 rights and more]
 105  *      "Dual BSD/GPL"                  [GNU Public License v2
 106  *                                       or BSD license choice]
 107  *      "Dual MIT/GPL"                  [GNU Public License v2
 108  *                                       or MIT 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[, NAME]*[ and NAME] */
 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 /* Optional firmware file (or files) needed by the module
 159  * format is simply firmware file name.  Multiple firmware
 160  * files require multiple MODULE_FIRMWARE() specifiers */
 161 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
 162
 163 /* Given an address, look for it in the exception tables */
 164 const struct exception_table_entry *search_exception_tables(unsigned long add);
 165
 166 struct notifier_block;
 167
 168 #ifdef CONFIG_MODULES
 169
 170 /* Get/put a kernel symbol (calls must be symmetric) */
 171 void *__symbol_get(const char *symbol);
 172 void *__symbol_get_gpl(const char *symbol);
 173 #define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
 174
 175 #ifndef __GENKSYMS__
 176 #ifdef CONFIG_MODVERSIONS
 177 /* Mark the CRC weak since genksyms apparently decides not to
 178  * generate a checksums for some symbols */
 179 #define __CRC_SYMBOL(sym, sec)                                  \
 180         extern void *__crc_##sym __attribute__((weak));         \
 181         static const unsigned long __kcrctab_##sym              \
 182         __used                                                  \
 183         __attribute__((section("__kcrctab" sec), unused))       \
 184         = (unsigned long) &__crc_##sym;
 185 #else
 186 #define __CRC_SYMBOL(sym, sec)
 187 #endif
 188
 189 /* For every exported symbol, place a struct in the __ksymtab section */
 190 #define __EXPORT_SYMBOL(sym, sec)                               \
 191         extern typeof(sym) sym;                                 \
 192         __CRC_SYMBOL(sym, sec)                                  \
 193         static const char __kstrtab_##sym[]                     \
 194         __attribute__((section("__ksymtab_strings"), aligned(1))) \
 195         = MODULE_SYMBOL_PREFIX #sym;                            \
 196         static const struct kernel_symbol __ksymtab_##sym       \
 197         __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 #define EXPORT_SYMBOL_GPL_FUTURE(sym)                           \
 208         __EXPORT_SYMBOL(sym, "_gpl_future")
 209
 210
 211 #ifdef CONFIG_UNUSED_SYMBOLS
 212 #define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
 213 #define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
 214 #else
 215 #define EXPORT_UNUSED_SYMBOL(sym)
 216 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
 217 #endif
 218
 219 #endif
 220
 221 struct module_ref
 222 {
 223         local_t count;
 224 } ____cacheline_aligned;
 225
 226 enum module_state
 227 {
 228         MODULE_STATE_LIVE,
 229         MODULE_STATE_COMING,
 230         MODULE_STATE_GOING,
 231 };
 232
 233 struct module
 234 {
 235         enum module_state state;
 236
 237         /* Member of list of modules */
 238         struct list_head list;
 239
 240         /* Unique handle for this module */
 241         char name[MODULE_NAME_LEN];
 242
 243         /* Sysfs stuff. */
 244         struct module_kobject mkobj;
 245         struct module_param_attrs *param_attrs;
 246         struct module_attribute *modinfo_attrs;
 247         const char *version;
 248         const char *srcversion;
 249         struct kobject *holders_dir;
 250
 251         /* Exported symbols */
 252         const struct kernel_symbol *syms;
 253         const unsigned long *crcs;
 254         unsigned int num_syms;
 255
 256         /* GPL-only exported symbols. */
 257         unsigned int num_gpl_syms;
 258         const struct kernel_symbol *gpl_syms;
 259         const unsigned long *gpl_crcs;
 260
 261 #ifdef CONFIG_UNUSED_SYMBOLS
 262         /* unused exported symbols. */
 263         const struct kernel_symbol *unused_syms;
 264         const unsigned long *unused_crcs;
 265         unsigned int num_unused_syms;
 266
 267         /* GPL-only, unused exported symbols. */
 268         unsigned int num_unused_gpl_syms;
 269         const struct kernel_symbol *unused_gpl_syms;
 270         const unsigned long *unused_gpl_crcs;
 271 #endif
 272
 273         /* symbols that will be GPL-only in the near future. */
 274         const struct kernel_symbol *gpl_future_syms;
 275         const unsigned long *gpl_future_crcs;
 276         unsigned int num_gpl_future_syms;
 277
 278         /* Exception table */
 279         unsigned int num_exentries;
 280         const struct exception_table_entry *extable;
 281
 282         /* Startup function. */
 283         int (*init)(void);
 284
 285         /* If this is non-NULL, vfree after init() returns */
 286         void *module_init;
 287
 288         /* Here is the actual code + data, vfree'd on unload. */
 289         void *module_core;
 290
 291         /* Here are the sizes of the init and core sections */
 292         unsigned int init_size, core_size;
 293
 294         /* The size of the executable code in each section.  */
 295         unsigned int init_text_size, core_text_size;
 296
 297         /* The handle returned from unwind_add_table. */
 298         void *unwind_info;
 299
 300         /* Arch-specific module values */
 301         struct mod_arch_specific arch;
 302
 303         unsigned int taints;    /* same bits as kernel:tainted */
 304
 305 #ifdef CONFIG_GENERIC_BUG
 306         /* Support for BUG */
 307         unsigned num_bugs;
 308         struct list_head bug_list;
 309         struct bug_entry *bug_table;
 310 #endif
 311
 312 #ifdef CONFIG_KALLSYMS
 313         /* We keep the symbol and string tables for kallsyms. */
 314         Elf_Sym *symtab;
 315         unsigned int num_symtab;
 316         char *strtab;
 317
 318         /* Section attributes */
 319         struct module_sect_attrs *sect_attrs;
 320
 321         /* Notes attributes */
 322         struct module_notes_attrs *notes_attrs;
 323 #endif
 324
 325         /* Per-cpu data. */
 326         void *percpu;
 327
 328         /* The command line arguments (may be mangled).  People like
 329            keeping pointers to this stuff */
 330         char *args;
 331 #ifdef CONFIG_MARKERS
 332         struct marker *markers;
 333         unsigned int num_markers;
 334 #endif
 335 #ifdef CONFIG_TRACEPOINTS
 336         struct tracepoint *tracepoints;
 337         unsigned int num_tracepoints;
 338 #endif
 339
 340 #ifdef CONFIG_MODULE_UNLOAD
 341         /* What modules depend on me? */
 342         struct list_head modules_which_use_me;
 343
 344         /* Who is waiting for us to be unloaded */
 345         struct task_struct *waiter;
 346
 347         /* Destruction function. */
 348         void (*exit)(void);
 349
 350         /* Reference counts */
 351         struct module_ref ref[NR_CPUS];
 352 #endif
 353
 354 };
 355 #ifndef MODULE_ARCH_INIT
 356 #define MODULE_ARCH_INIT {}
 357 #endif
 358
 359 /* FIXME: It'd be nice to isolate modules during init, too, so they
 360    aren't used before they (may) fail.  But presently too much code
 361    (IDE & SCSI) require entry into the module during init.*/
 362 static inline int module_is_live(struct module *mod)
 363 {
 364         return mod->state != MODULE_STATE_GOING;
 365 }
 366
 367 /* Is this address in a module? (second is with no locks, for oops) */
 368 struct module *module_text_address(unsigned long addr);
 369 struct module *__module_text_address(unsigned long addr);
 370 int is_module_address(unsigned long addr);
 371
 372 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
 373    symnum out of range. */
 374 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
 375                         char *name, char *module_name, int *exported);
 376
 377 /* Look for this name: can be of form module:name. */
 378 unsigned long module_kallsyms_lookup_name(const char *name);
 379
 380 extern void __module_put_and_exit(struct module *mod, long code)
 381         __attribute__((noreturn));
 382 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
 383
 384 #ifdef CONFIG_MODULE_UNLOAD
 385 unsigned int module_refcount(struct module *mod);
 386 void __symbol_put(const char *symbol);
 387 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
 388 void symbol_put_addr(void *addr);
 389
 390 /* Sometimes we know we already have a refcount, and it's easier not
 391    to handle the error case (which only happens with rmmod --wait). */
 392 static inline void __module_get(struct module *module)
 393 {
 394         if (module) {
 395                 BUG_ON(module_refcount(module) == 0);
 396                 local_inc(&module->ref[get_cpu()].count);
 397                 put_cpu();
 398         }
 399 }
 400
 401 static inline int try_module_get(struct module *module)
 402 {
 403         int ret = 1;
 404
 405         if (module) {
 406                 unsigned int cpu = get_cpu();
 407                 if (likely(module_is_live(module)))
 408                         local_inc(&module->ref[cpu].count);
 409                 else
 410                         ret = 0;
 411                 put_cpu();
 412         }
 413         return ret;
 414 }
 415
 416 extern void module_put(struct module *module);
 417
 418 #else /*!CONFIG_MODULE_UNLOAD*/
 419 static inline int try_module_get(struct module *module)
 420 {
 421         return !module || module_is_live(module);
 422 }
 423 static inline void module_put(struct module *module)
 424 {
 425 }
 426 static inline void __module_get(struct module *module)
 427 {
 428 }
 429 #define symbol_put(x) do { } while(0)
 430 #define symbol_put_addr(p) do { } while(0)
 431
 432 #endif /* CONFIG_MODULE_UNLOAD */
 433
 434 /* This is a #define so the string doesn't get put in every .o file */
 435 #define module_name(mod)                        \
 436 ({                                              \
 437         struct module *__mod = (mod);           \
 438         __mod ? __mod->name : "kernel";         \
 439 })
 440
 441 /* For kallsyms to ask for address resolution.  namebuf should be at
 442  * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
 443  * found, otherwise NULL. */
 444 const char *module_address_lookup(unsigned long addr,
 445                             unsigned long *symbolsize,
 446                             unsigned long *offset,
 447                             char **modname,
 448                             char *namebuf);
 449 int lookup_module_symbol_name(unsigned long addr, char *symname);
 450 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
 451
 452 /* For extable.c to search modules' exception tables. */
 453 const struct exception_table_entry *search_module_extables(unsigned long addr);
 454
 455 int register_module_notifier(struct notifier_block * nb);
 456 int unregister_module_notifier(struct notifier_block * nb);
 457
 458 extern void print_modules(void);
 459
 460 extern void module_update_markers(void);
 461
 462 extern void module_update_tracepoints(void);
 463 extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);
 464
 465 #else /* !CONFIG_MODULES... */
 466 #define EXPORT_SYMBOL(sym)
 467 #define EXPORT_SYMBOL_GPL(sym)
 468 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
 469 #define EXPORT_UNUSED_SYMBOL(sym)
 470 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
 471
 472 /* Given an address, look for it in the exception tables. */
 473 static inline const struct exception_table_entry *
 474 search_module_extables(unsigned long addr)
 475 {
 476         return NULL;
 477 }
 478
 479 /* Is this address in a module? */
 480 static inline struct module *module_text_address(unsigned long addr)
 481 {
 482         return NULL;
 483 }
 484
 485 /* Is this address in a module? (don't take a lock, we're oopsing) */
 486 static inline struct module *__module_text_address(unsigned long addr)
 487 {
 488         return NULL;
 489 }
 490
 491 static inline int is_module_address(unsigned long addr)
 492 {
 493         return 0;
 494 }
 495
 496 /* Get/put a kernel symbol (calls should be symmetric) */
 497 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
 498 #define symbol_put(x) do { } while(0)
 499 #define symbol_put_addr(x) do { } while(0)
 500
 501 static inline void __module_get(struct module *module)
 502 {
 503 }
 504
 505 static inline int try_module_get(struct module *module)
 506 {
 507         return 1;
 508 }
 509
 510 static inline void module_put(struct module *module)
 511 {
 512 }
 513
 514 #define module_name(mod) "kernel"
 515
 516 /* For kallsyms to ask for address resolution.  NULL means not found. */
 517 static inline const char *module_address_lookup(unsigned long addr,
 518                                           unsigned long *symbolsize,
 519                                           unsigned long *offset,
 520                                           char **modname,
 521                                           char *namebuf)
 522 {
 523         return NULL;
 524 }
 525
 526 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
 527 {
 528         return -ERANGE;
 529 }
 530
 531 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
 532 {
 533         return -ERANGE;
 534 }
 535
 536 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
 537                                         char *type, char *name,
 538                                         char *module_name, int *exported)
 539 {
 540         return -ERANGE;
 541 }
 542
 543 static inline unsigned long module_kallsyms_lookup_name(const char *name)
 544 {
 545         return 0;
 546 }
 547
 548 static inline int register_module_notifier(struct notifier_block * nb)
 549 {
 550         /* no events will happen anyway, so this can always succeed */
 551         return 0;
 552 }
 553
 554 static inline int unregister_module_notifier(struct notifier_block * nb)
 555 {
 556         return 0;
 557 }
 558
 559 #define module_put_and_exit(code) do_exit(code)
 560
 561 static inline void print_modules(void)
 562 {
 563 }
 564
 565 static inline void module_update_markers(void)
 566 {
 567 }
 568
 569 static inline void module_update_tracepoints(void)
 570 {
 571 }
 572
 573 static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
 574 {
 575         return 0;
 576 }
 577
 578 #endif /* CONFIG_MODULES */
 579
 580 struct device_driver;
 581 #ifdef CONFIG_SYSFS
 582 struct module;
 583
 584 extern struct kset *module_kset;
 585 extern struct kobj_type module_ktype;
 586 extern int module_sysfs_initialized;
 587
 588 int mod_sysfs_init(struct module *mod);
 589 int mod_sysfs_setup(struct module *mod,
 590                            struct kernel_param *kparam,
 591                            unsigned int num_params);
 592 int module_add_modinfo_attrs(struct module *mod);
 593 void module_remove_modinfo_attrs(struct module *mod);
 594
 595 #else /* !CONFIG_SYSFS */
 596
 597 static inline int mod_sysfs_init(struct module *mod)
 598 {
 599         return 0;
 600 }
 601
 602 static inline int mod_sysfs_setup(struct module *mod,
 603                            struct kernel_param *kparam,
 604                            unsigned int num_params)
 605 {
 606         return 0;
 607 }
 608
 609 static inline int module_add_modinfo_attrs(struct module *mod)
 610 {
 611         return 0;
 612 }
 613
 614 static inline void module_remove_modinfo_attrs(struct module *mod)
 615 { }
 616
 617 #endif /* CONFIG_SYSFS */
 618
 619 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
 620
 621 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
 622
 623 #define __MODULE_STRING(x) __stringify(x)
 624
 625 #endif /* _LINUX_MODULE_H */