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 MAX_PARAM_PREFIX_LEN
  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         struct module_param_attrs *mp;
  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
  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]
 108  *      "Dual MIT/GPL"                  [GNU Public License v2
 109  *                                       or MIT license choice]
 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
 129 /* Author, ideally of form NAME[, NAME]*[ and NAME] */
 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
 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
 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         __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         extern typeof(sym) sym;                                 \
 193         __CRC_SYMBOL(sym, sec)                                  \
 194         static const char __kstrtab_##sym[]                     \
 195         __attribute__((section("__ksymtab_strings"), aligned(1))) \
 196         = MODULE_SYMBOL_PREFIX #sym;                            \
 197         static const struct kernel_symbol __ksymtab_##sym       \
 198         __used                                                  \
 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
 208 #define EXPORT_SYMBOL_GPL_FUTURE(sym)                           \
 209         __EXPORT_SYMBOL(sym, "_gpl_future")
 210
 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
 220 #endif
 221
 222 enum module_state
 223 {
 224         MODULE_STATE_LIVE,
 225         MODULE_STATE_COMING,
 226         MODULE_STATE_GOING,
 227 };
 228
 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;
 241         struct module_attribute *modinfo_attrs;
 242         const char *version;
 243         const char *srcversion;
 244         struct kobject *holders_dir;
 245
 246         /* Exported symbols */
 247         const struct kernel_symbol *syms;
 248         const unsigned long *crcs;
 249         unsigned int num_syms;
 250
 251         /* Kernel parameters. */
 252         struct kernel_param *kp;
 253         unsigned int num_kp;
 254
 255         /* GPL-only exported symbols. */
 256         unsigned int num_gpl_syms;
 257         const struct kernel_symbol *gpl_syms;
 258         const unsigned long *gpl_crcs;
 259
 260 #ifdef CONFIG_UNUSED_SYMBOLS
 261         /* unused exported symbols. */
 262         const struct kernel_symbol *unused_syms;
 263         const unsigned long *unused_crcs;
 264         unsigned int num_unused_syms;
 265
 266         /* GPL-only, unused exported symbols. */
 267         unsigned int num_unused_gpl_syms;
 268         const struct kernel_symbol *unused_gpl_syms;
 269         const unsigned long *unused_gpl_crcs;
 270 #endif
 271
 272         /* symbols that will be GPL-only in the near future. */
 273         const struct kernel_symbol *gpl_future_syms;
 274         const unsigned long *gpl_future_crcs;
 275         unsigned int num_gpl_future_syms;
 276
 277         /* Exception table */
 278         unsigned int num_exentries;
 279         struct exception_table_entry *extable;
 280
 281         /* Startup function. */
 282         int (*init)(void);
 283
 284         /* If this is non-NULL, vfree after init() returns */
 285         void *module_init;
 286
 287         /* Here is the actual code + data, vfree'd on unload. */
 288         void *module_core;
 289
 290         /* Here are the sizes of the init and core sections */
 291         unsigned int init_size, core_size;
 292
 293         /* The size of the executable code in each section.  */
 294         unsigned int init_text_size, core_text_size;
 295
 296         /* Arch-specific module values */
 297         struct mod_arch_specific arch;
 298
 299         unsigned int taints;    /* same bits as kernel:tainted */
 300
 301 #ifdef CONFIG_GENERIC_BUG
 302         /* Support for BUG */
 303         unsigned num_bugs;
 304         struct list_head bug_list;
 305         struct bug_entry *bug_table;
 306 #endif
 307
 308 #ifdef CONFIG_KALLSYMS
 309         /* We keep the symbol and string tables for kallsyms. */
 310         Elf_Sym *symtab;
 311         unsigned int num_symtab;
 312         char *strtab;
 313
 314         /* Section attributes */
 315         struct module_sect_attrs *sect_attrs;
 316
 317         /* Notes attributes */
 318         struct module_notes_attrs *notes_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 #ifdef CONFIG_MARKERS
 328         struct marker *markers;
 329         unsigned int num_markers;
 330 #endif
 331 #ifdef CONFIG_TRACEPOINTS
 332         struct tracepoint *tracepoints;
 333         unsigned int num_tracepoints;
 334 #endif
 335
 336 #ifdef CONFIG_MODULE_UNLOAD
 337         /* What modules depend on me? */
 338         struct list_head modules_which_use_me;
 339
 340         /* Who is waiting for us to be unloaded */
 341         struct task_struct *waiter;
 342
 343         /* Destruction function. */
 344         void (*exit)(void);
 345
 346 #ifdef CONFIG_SMP
 347         char *refptr;
 348 #else
 349         local_t ref;
 350 #endif
 351 #endif
 352 };
 353 #ifndef MODULE_ARCH_INIT
 354 #define MODULE_ARCH_INIT {}
 355 #endif
 356
 357 /* FIXME: It'd be nice to isolate modules during init, too, so they
 358    aren't used before they (may) fail.  But presently too much code
 359    (IDE & SCSI) require entry into the module during init.*/
 360 static inline int module_is_live(struct module *mod)
 361 {
 362         return mod->state != MODULE_STATE_GOING;
 363 }
 364
 365 struct module *__module_text_address(unsigned long addr);
 366 struct module *__module_address(unsigned long addr);
 367 bool is_module_address(unsigned long addr);
 368 bool is_module_text_address(unsigned long addr);
 369
 370 static inline int within_module_core(unsigned long addr, struct module *mod)
 371 {
 372         return (unsigned long)mod->module_core <= addr &&
 373                addr < (unsigned long)mod->module_core + mod->core_size;
 374 }
 375
 376 static inline int within_module_init(unsigned long addr, struct module *mod)
 377 {
 378         return (unsigned long)mod->module_init <= addr &&
 379                addr < (unsigned long)mod->module_init + mod->init_size;
 380 }
 381
 382 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
 383    symnum out of range. */
 384 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
 385                         char *name, char *module_name, int *exported);
 386
 387 /* Look for this name: can be of form module:name. */
 388 unsigned long module_kallsyms_lookup_name(const char *name);
 389
 390 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
 391                                              struct module *, unsigned long),
 392                                    void *data);
 393
 394 extern void __module_put_and_exit(struct module *mod, long code)
 395         __attribute__((noreturn));
 396 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
 397
 398 #ifdef CONFIG_MODULE_UNLOAD
 399 unsigned int module_refcount(struct module *mod);
 400 void __symbol_put(const char *symbol);
 401 #define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
 402 void symbol_put_addr(void *addr);
 403
 404 static inline local_t *__module_ref_addr(struct module *mod, int cpu)
 405 {
 406 #ifdef CONFIG_SMP
 407         return (local_t *) (mod->refptr + per_cpu_offset(cpu));
 408 #else
 409         return &mod->ref;
 410 #endif
 411 }
 412
 413 /* Sometimes we know we already have a refcount, and it's easier not
 414    to handle the error case (which only happens with rmmod --wait). */
 415 static inline void __module_get(struct module *module)
 416 {
 417         if (module) {
 418                 local_inc(__module_ref_addr(module, get_cpu()));
 419                 put_cpu();
 420         }
 421 }
 422
 423 static inline int try_module_get(struct module *module)
 424 {
 425         int ret = 1;
 426
 427         if (module) {
 428                 unsigned int cpu = get_cpu();
 429                 if (likely(module_is_live(module)))
 430                         local_inc(__module_ref_addr(module, cpu));
 431                 else
 432                         ret = 0;
 433                 put_cpu();
 434         }
 435         return ret;
 436 }
 437
 438 extern void module_put(struct module *module);
 439
 440 #else /*!CONFIG_MODULE_UNLOAD*/
 441 static inline int try_module_get(struct module *module)
 442 {
 443         return !module || module_is_live(module);
 444 }
 445 static inline void module_put(struct module *module)
 446 {
 447 }
 448 static inline void __module_get(struct module *module)
 449 {
 450 }
 451 #define symbol_put(x) do { } while(0)
 452 #define symbol_put_addr(p) do { } while(0)
 453
 454 #endif /* CONFIG_MODULE_UNLOAD */
 455
 456 /* This is a #define so the string doesn't get put in every .o file */
 457 #define module_name(mod)                        \
 458 ({                                              \
 459         struct module *__mod = (mod);           \
 460         __mod ? __mod->name : "kernel";         \
 461 })
 462
 463 /* For kallsyms to ask for address resolution.  namebuf should be at
 464  * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
 465  * found, otherwise NULL. */
 466 const char *module_address_lookup(unsigned long addr,
 467                             unsigned long *symbolsize,
 468                             unsigned long *offset,
 469                             char **modname,
 470                             char *namebuf);
 471 int lookup_module_symbol_name(unsigned long addr, char *symname);
 472 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
 473
 474 /* For extable.c to search modules' exception tables. */
 475 const struct exception_table_entry *search_module_extables(unsigned long addr);
 476
 477 int register_module_notifier(struct notifier_block * nb);
 478 int unregister_module_notifier(struct notifier_block * nb);
 479
 480 extern void print_modules(void);
 481
 482 extern void module_update_markers(void);
 483
 484 extern void module_update_tracepoints(void);
 485 extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);
 486
 487 #else /* !CONFIG_MODULES... */
 488 #define EXPORT_SYMBOL(sym)
 489 #define EXPORT_SYMBOL_GPL(sym)
 490 #define EXPORT_SYMBOL_GPL_FUTURE(sym)
 491 #define EXPORT_UNUSED_SYMBOL(sym)
 492 #define EXPORT_UNUSED_SYMBOL_GPL(sym)
 493
 494 /* Given an address, look for it in the exception tables. */
 495 static inline const struct exception_table_entry *
 496 search_module_extables(unsigned long addr)
 497 {
 498         return NULL;
 499 }
 500
 501 static inline struct module *__module_address(unsigned long addr)
 502 {
 503         return NULL;
 504 }
 505
 506 static inline struct module *__module_text_address(unsigned long addr)
 507 {
 508         return NULL;
 509 }
 510
 511 static inline bool is_module_address(unsigned long addr)
 512 {
 513         return false;
 514 }
 515
 516 static inline bool is_module_text_address(unsigned long addr)
 517 {
 518         return false;
 519 }
 520
 521 /* Get/put a kernel symbol (calls should be symmetric) */
 522 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
 523 #define symbol_put(x) do { } while(0)
 524 #define symbol_put_addr(x) do { } while(0)
 525
 526 static inline void __module_get(struct module *module)
 527 {
 528 }
 529
 530 static inline int try_module_get(struct module *module)
 531 {
 532         return 1;
 533 }
 534
 535 static inline void module_put(struct module *module)
 536 {
 537 }
 538
 539 #define module_name(mod) "kernel"
 540
 541 /* For kallsyms to ask for address resolution.  NULL means not found. */
 542 static inline const char *module_address_lookup(unsigned long addr,
 543                                           unsigned long *symbolsize,
 544                                           unsigned long *offset,
 545                                           char **modname,
 546                                           char *namebuf)
 547 {
 548         return NULL;
 549 }
 550
 551 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
 552 {
 553         return -ERANGE;
 554 }
 555
 556 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
 557 {
 558         return -ERANGE;
 559 }
 560
 561 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
 562                                         char *type, char *name,
 563                                         char *module_name, int *exported)
 564 {
 565         return -ERANGE;
 566 }
 567
 568 static inline unsigned long module_kallsyms_lookup_name(const char *name)
 569 {
 570         return 0;
 571 }
 572
 573 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
 574                                                            struct module *,
 575                                                            unsigned long),
 576                                                  void *data)
 577 {
 578         return 0;
 579 }
 580
 581 static inline int register_module_notifier(struct notifier_block * nb)
 582 {
 583         /* no events will happen anyway, so this can always succeed */
 584         return 0;
 585 }
 586
 587 static inline int unregister_module_notifier(struct notifier_block * nb)
 588 {
 589         return 0;
 590 }
 591
 592 #define module_put_and_exit(code) do_exit(code)
 593
 594 static inline void print_modules(void)
 595 {
 596 }
 597
 598 static inline void module_update_markers(void)
 599 {
 600 }
 601
 602 static inline void module_update_tracepoints(void)
 603 {
 604 }
 605
 606 static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
 607 {
 608         return 0;
 609 }
 610
 611 #endif /* CONFIG_MODULES */
 612
 613 struct device_driver;
 614 #ifdef CONFIG_SYSFS
 615 struct module;
 616
 617 extern struct kset *module_kset;
 618 extern struct kobj_type module_ktype;
 619 extern int module_sysfs_initialized;
 620
 621 int mod_sysfs_init(struct module *mod);
 622 int mod_sysfs_setup(struct module *mod,
 623                            struct kernel_param *kparam,
 624                            unsigned int num_params);
 625 int module_add_modinfo_attrs(struct module *mod);
 626 void module_remove_modinfo_attrs(struct module *mod);
 627
 628 #else /* !CONFIG_SYSFS */
 629
 630 static inline int mod_sysfs_init(struct module *mod)
 631 {
 632         return 0;
 633 }
 634
 635 static inline int mod_sysfs_setup(struct module *mod,
 636                            struct kernel_param *kparam,
 637                            unsigned int num_params)
 638 {
 639         return 0;
 640 }
 641
 642 static inline int module_add_modinfo_attrs(struct module *mod)
 643 {
 644         return 0;
 645 }
 646
 647 static inline void module_remove_modinfo_attrs(struct module *mod)
 648 { }
 649
 650 #endif /* CONFIG_SYSFS */
 651
 652 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
 653
 654 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
 655
 656 #define __MODULE_STRING(x) __stringify(x)
 657
 658 #endif /* _LINUX_MODULE_H */