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/tracepoint.h>
  19 #include <linux/export.h>
  20
  21 #include <linux/percpu.h>
  22 #include <asm/module.h>
  23
  24 /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
  25 #define MODULE_SIG_STRING "~Module signature appended~\n"
  26
  27 /* Not Yet Implemented */
  28 #define MODULE_SUPPORTED_DEVICE(name)
  29
  30 #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
  31
  32 struct modversion_info
  33 {
  34         unsigned long crc;
  35         char name[MODULE_NAME_LEN];
  36 };
  37
  38 struct module;
  39
  40 struct module_kobject {
  41         struct kobject kobj;
  42         struct module *mod;
  43         struct kobject *drivers_dir;
  44         struct module_param_attrs *mp;
  45 };
  46
  47 struct module_attribute {
  48         struct attribute attr;
  49         ssize_t (*show)(struct module_attribute *, struct module_kobject *,
  50                         char *);
  51         ssize_t (*store)(struct module_attribute *, struct module_kobject *,
  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_version_attribute {
  59         struct module_attribute mattr;
  60         const char *module_name;
  61         const char *version;
  62 } __attribute__ ((__aligned__(sizeof(void *))));
  63
  64 extern ssize_t __modver_version_show(struct module_attribute *,
  65                                      struct module_kobject *, char *);
  66
  67 extern struct module_attribute module_uevent;
  68
  69 /* These are either module local, or the kernel's dummy ones. */
  70 extern int init_module(void);
  71 extern void cleanup_module(void);
  72
  73 /* Archs provide a method of finding the correct exception table. */
  74 struct exception_table_entry;
  75
  76 const struct exception_table_entry *
  77 search_extable(const struct exception_table_entry *first,
  78                const struct exception_table_entry *last,
  79                unsigned long value);
  80 void sort_extable(struct exception_table_entry *start,
  81                   struct exception_table_entry *finish);
  82 void sort_main_extable(void);
  83 void trim_init_extable(struct module *m);
  84
  85 #ifdef MODULE
  86 #define MODULE_GENERIC_TABLE(gtype,name)                        \
  87 extern const struct gtype##_id __mod_##gtype##_table            \
  88   __attribute__ ((unused, alias(__stringify(name))))
  89
  90 #else  /* !MODULE */
  91 #define MODULE_GENERIC_TABLE(gtype,name)
  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 /* Soft module dependencies. See man modprobe.d for details.
 101  * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
 102  */
 103 #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
 104
 105 /*
 106  * The following license idents are currently accepted as indicating free
 107  * software modules
 108  *
 109  *      "GPL"                           [GNU Public License v2 or later]
 110  *      "GPL v2"                        [GNU Public License v2]
 111  *      "GPL and additional rights"     [GNU Public License v2 rights and more]
 112  *      "Dual BSD/GPL"                  [GNU Public License v2
 113  *                                       or BSD license choice]
 114  *      "Dual MIT/GPL"                  [GNU Public License v2
 115  *                                       or MIT license choice]
 116  *      "Dual MPL/GPL"                  [GNU Public License v2
 117  *                                       or Mozilla license choice]
 118  *
 119  * The following other idents are available
 120  *
 121  *      "Proprietary"                   [Non free products]
 122  *
 123  * There are dual licensed components, but when running with Linux it is the
 124  * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
 125  * is a GPL combined work.
 126  *
 127  * This exists for several reasons
 128  * 1.   So modinfo can show license info for users wanting to vet their setup
 129  *      is free
 130  * 2.   So the community can ignore bug reports including proprietary modules
 131  * 3.   So vendors can do likewise based on their own policies
 132  */
 133 #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
 134
 135 /*
 136  * Author(s), use "Name <email>" or just "Name", for multiple
 137  * authors use multiple MODULE_AUTHOR() statements/lines.
 138  */
 139 #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
 140
 141 /* What your module does. */
 142 #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
 143
 144 #define MODULE_DEVICE_TABLE(type,name)          \
 145   MODULE_GENERIC_TABLE(type##_device,name)
 146
 147 /* Version of form [<epoch>:]<version>[-<extra-version>].
 148    Or for CVS/RCS ID version, everything but the number is stripped.
 149   <epoch>: A (small) unsigned integer which allows you to start versions
 150            anew. If not mentioned, it's zero.  eg. "2:1.0" is after
 151            "1:2.0".
 152   <version>: The <version> may contain only alphanumerics and the
 153            character `.'.  Ordered by numeric sort for numeric parts,
 154            ascii sort for ascii parts (as per RPM or DEB algorithm).
 155   <extraversion>: Like <version>, but inserted for local
 156            customizations, eg "rh3" or "rusty1".
 157
 158   Using this automatically adds a checksum of the .c files and the
 159   local headers in "srcversion".
 160 */
 161
 162 #if defined(MODULE) || !defined(CONFIG_SYSFS)
 163 #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
 164 #else
 165 #define MODULE_VERSION(_version)                                        \
 166         static struct module_version_attribute ___modver_attr = {       \
 167                 .mattr  = {                                             \
 168                         .attr   = {                                     \
 169                                 .name   = "version",                    \
 170                                 .mode   = S_IRUGO,                      \
 171                         },                                              \
 172                         .show   = __modver_version_show,                \
 173                 },                                                      \
 174                 .module_name    = KBUILD_MODNAME,                       \
 175                 .version        = _version,                             \
 176         };                                                              \
 177         static const struct module_version_attribute                    \
 178         __used __attribute__ ((__section__ ("__modver")))               \
 179         * __moduleparam_const __modver_attr = &___modver_attr
 180 #endif
 181
 182 /* Optional firmware file (or files) needed by the module
 183  * format is simply firmware file name.  Multiple firmware
 184  * files require multiple MODULE_FIRMWARE() specifiers */
 185 #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
 186
 187 /* Given an address, look for it in the exception tables */
 188 const struct exception_table_entry *search_exception_tables(unsigned long add);
 189
 190 struct notifier_block;
 191
 192 #ifdef CONFIG_MODULES
 193
 194 extern int modules_disabled; /* for sysctl */
 195 /* Get/put a kernel symbol (calls must be symmetric) */
 196 void *__symbol_get(const char *symbol);
 197 void *__symbol_get_gpl(const char *symbol);
 198 #define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
 199
 200 /* modules using other modules: kdb wants to see this. */
 201 struct module_use {
 202         struct list_head source_list;
 203         struct list_head target_list;
 204         struct module *source, *target;
 205 };
 206
 207 enum module_state {
 208         MODULE_STATE_LIVE,      /* Normal state. */
 209         MODULE_STATE_COMING,    /* Full formed, running module_init. */
 210         MODULE_STATE_GOING,     /* Going away. */
 211         MODULE_STATE_UNFORMED,  /* Still setting it up. */
 212 };
 213
 214 /**
 215  * struct module_ref - per cpu module reference counts
 216  * @incs: number of module get on this cpu
 217  * @decs: number of module put on this cpu
 218  *
 219  * We force an alignment on 8 or 16 bytes, so that alloc_percpu()
 220  * put @incs/@decs in same cache line, with no extra memory cost,
 221  * since alloc_percpu() is fine grained.
 222  */
 223 struct module_ref {
 224         unsigned long incs;
 225         unsigned long decs;
 226 } __attribute((aligned(2 * sizeof(unsigned long))));
 227
 228 struct module
 229 {
 230         enum module_state state;
 231
 232         /* Member of list of modules */
 233         struct list_head list;
 234
 235         /* Unique handle for this module */
 236         char name[MODULE_NAME_LEN];
 237
 238         /* Sysfs stuff. */
 239         struct module_kobject mkobj;
 240         struct module_attribute *modinfo_attrs;
 241         const char *version;
 242         const char *srcversion;
 243         struct kobject *holders_dir;
 244
 245         /* Exported symbols */
 246         const struct kernel_symbol *syms;
 247         const unsigned long *crcs;
 248         unsigned int num_syms;
 249
 250         /* Kernel parameters. */
 251         struct kernel_param *kp;
 252         unsigned int num_kp;
 253
 254         /* GPL-only exported symbols. */
 255         unsigned int num_gpl_syms;
 256         const struct kernel_symbol *gpl_syms;
 257         const unsigned long *gpl_crcs;
 258
 259 #ifdef CONFIG_UNUSED_SYMBOLS
 260         /* unused exported symbols. */
 261         const struct kernel_symbol *unused_syms;
 262         const unsigned long *unused_crcs;
 263         unsigned int num_unused_syms;
 264
 265         /* GPL-only, unused exported symbols. */
 266         unsigned int num_unused_gpl_syms;
 267         const struct kernel_symbol *unused_gpl_syms;
 268         const unsigned long *unused_gpl_crcs;
 269 #endif
 270
 271 #ifdef CONFIG_MODULE_SIG
 272         /* Signature was verified. */
 273         bool sig_ok;
 274 #endif
 275
 276         /* symbols that will be GPL-only in the near future. */
 277         const struct kernel_symbol *gpl_future_syms;
 278         const unsigned long *gpl_future_crcs;
 279         unsigned int num_gpl_future_syms;
 280
 281         /* Exception table */
 282         unsigned int num_exentries;
 283         struct exception_table_entry *extable;
 284
 285         /* Startup function. */
 286         int (*init)(void);
 287
 288         /* If this is non-NULL, vfree after init() returns */
 289         void *module_init;
 290
 291         /* Here is the actual code + data, vfree'd on unload. */
 292         void *module_core;
 293
 294         /* Here are the sizes of the init and core sections */
 295         unsigned int init_size, core_size;
 296
 297         /* The size of the executable code in each section.  */
 298         unsigned int init_text_size, core_text_size;
 299
 300         /* Size of RO sections of the module (text+rodata) */
 301         unsigned int init_ro_size, core_ro_size;
 302
 303         /* Arch-specific module values */
 304         struct mod_arch_specific arch;
 305
 306         unsigned int taints;    /* same bits as kernel:tainted */
 307
 308 #ifdef CONFIG_GENERIC_BUG
 309         /* Support for BUG */
 310         unsigned num_bugs;
 311         struct list_head bug_list;
 312         struct bug_entry *bug_table;
 313 #endif
 314
 315 #ifdef CONFIG_KALLSYMS
 316         /*
 317          * We keep the symbol and string tables for kallsyms.
 318          * The core_* fields below are temporary, loader-only (they
 319          * could really be discarded after module init).
 320          */
 321         Elf_Sym *symtab, *core_symtab;
 322         unsigned int num_symtab, core_num_syms;
 323         char *strtab, *core_strtab;
 324
 325         /* Section attributes */
 326         struct module_sect_attrs *sect_attrs;
 327
 328         /* Notes attributes */
 329         struct module_notes_attrs *notes_attrs;
 330 #endif
 331
 332         /* The command line arguments (may be mangled).  People like
 333            keeping pointers to this stuff */
 334         char *args;
 335
 336 #ifdef CONFIG_SMP
 337         /* Per-cpu data. */
 338         void __percpu *percpu;
 339         unsigned int percpu_size;
 340 #endif
 341
 342 #ifdef CONFIG_TRACEPOINTS
 343         unsigned int num_tracepoints;
 344         struct tracepoint * const *tracepoints_ptrs;
 345 #endif
 346 #ifdef HAVE_JUMP_LABEL
 347         struct jump_entry *jump_entries;
 348         unsigned int num_jump_entries;
 349 #endif
 350 #ifdef CONFIG_TRACING
 351         unsigned int num_trace_bprintk_fmt;
 352         const char **trace_bprintk_fmt_start;
 353 #endif
 354 #ifdef CONFIG_EVENT_TRACING
 355         struct ftrace_event_call **trace_events;
 356         unsigned int num_trace_events;
 357 #endif
 358 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 359         unsigned int num_ftrace_callsites;
 360         unsigned long *ftrace_callsites;
 361 #endif
 362
 363 #ifdef CONFIG_MODULE_UNLOAD
 364         /* What modules depend on me? */
 365         struct list_head source_list;
 366         /* What modules do I depend on? */
 367         struct list_head target_list;
 368
 369         /* Who is waiting for us to be unloaded */
 370         struct task_struct *waiter;
 371
 372         /* Destruction function. */
 373         void (*exit)(void);
 374
 375         struct module_ref __percpu *refptr;
 376 #endif
 377
 378 #ifdef CONFIG_CONSTRUCTORS
 379         /* Constructor functions. */
 380         ctor_fn_t *ctors;
 381         unsigned int num_ctors;
 382 #endif
 383 };
 384 #ifndef MODULE_ARCH_INIT
 385 #define MODULE_ARCH_INIT {}
 386 #endif
 387
 388 extern struct mutex module_mutex;
 389
 390 /* FIXME: It'd be nice to isolate modules during init, too, so they
 391    aren't used before they (may) fail.  But presently too much code
 392    (IDE & SCSI) require entry into the module during init.*/
 393 static inline int module_is_live(struct module *mod)
 394 {
 395         return mod->state != MODULE_STATE_GOING;
 396 }
 397
 398 struct module *__module_text_address(unsigned long addr);
 399 struct module *__module_address(unsigned long addr);
 400 bool is_module_address(unsigned long addr);
 401 bool is_module_percpu_address(unsigned long addr);
 402 bool is_module_text_address(unsigned long addr);
 403
 404 static inline int within_module_core(unsigned long addr, const struct module *mod)
 405 {
 406         return (unsigned long)mod->module_core <= addr &&
 407                addr < (unsigned long)mod->module_core + mod->core_size;
 408 }
 409
 410 static inline int within_module_init(unsigned long addr, const struct module *mod)
 411 {
 412         return (unsigned long)mod->module_init <= addr &&
 413                addr < (unsigned long)mod->module_init + mod->init_size;
 414 }
 415
 416 /* Search for module by name: must hold module_mutex. */
 417 struct module *find_module(const char *name);
 418
 419 struct symsearch {
 420         const struct kernel_symbol *start, *stop;
 421         const unsigned long *crcs;
 422         enum {
 423                 NOT_GPL_ONLY,
 424                 GPL_ONLY,
 425                 WILL_BE_GPL_ONLY,
 426         } licence;
 427         bool unused;
 428 };
 429
 430 /* Search for an exported symbol by name. */
 431 const struct kernel_symbol *find_symbol(const char *name,
 432                                         struct module **owner,
 433                                         const unsigned long **crc,
 434                                         bool gplok,
 435                                         bool warn);
 436
 437 /* Walk the exported symbol table */
 438 bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
 439                                     struct module *owner,
 440                                     void *data), void *data);
 441
 442 /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
 443    symnum out of range. */
 444 int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
 445                         char *name, char *module_name, int *exported);
 446
 447 /* Look for this name: can be of form module:name. */
 448 unsigned long module_kallsyms_lookup_name(const char *name);
 449
 450 int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
 451                                              struct module *, unsigned long),
 452                                    void *data);
 453
 454 extern void __module_put_and_exit(struct module *mod, long code)
 455         __attribute__((noreturn));
 456 #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
 457
 458 #ifdef CONFIG_MODULE_UNLOAD
 459 unsigned long module_refcount(struct module *mod);
 460 void __symbol_put(const char *symbol);
 461 #define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
 462 void symbol_put_addr(void *addr);
 463
 464 /* Sometimes we know we already have a refcount, and it's easier not
 465    to handle the error case (which only happens with rmmod --wait). */
 466 extern void __module_get(struct module *module);
 467
 468 /* This is the Right Way to get a module: if it fails, it's being removed,
 469  * so pretend it's not there. */
 470 extern bool try_module_get(struct module *module);
 471
 472 extern void module_put(struct module *module);
 473
 474 #else /*!CONFIG_MODULE_UNLOAD*/
 475 static inline int try_module_get(struct module *module)
 476 {
 477         return !module || module_is_live(module);
 478 }
 479 static inline void module_put(struct module *module)
 480 {
 481 }
 482 static inline void __module_get(struct module *module)
 483 {
 484 }
 485 #define symbol_put(x) do { } while(0)
 486 #define symbol_put_addr(p) do { } while(0)
 487
 488 #endif /* CONFIG_MODULE_UNLOAD */
 489 int ref_module(struct module *a, struct module *b);
 490
 491 /* This is a #define so the string doesn't get put in every .o file */
 492 #define module_name(mod)                        \
 493 ({                                              \
 494         struct module *__mod = (mod);           \
 495         __mod ? __mod->name : "kernel";         \
 496 })
 497
 498 /* For kallsyms to ask for address resolution.  namebuf should be at
 499  * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
 500  * found, otherwise NULL. */
 501 const char *module_address_lookup(unsigned long addr,
 502                             unsigned long *symbolsize,
 503                             unsigned long *offset,
 504                             char **modname,
 505                             char *namebuf);
 506 int lookup_module_symbol_name(unsigned long addr, char *symname);
 507 int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
 508
 509 /* For extable.c to search modules' exception tables. */
 510 const struct exception_table_entry *search_module_extables(unsigned long addr);
 511
 512 int register_module_notifier(struct notifier_block * nb);
 513 int unregister_module_notifier(struct notifier_block * nb);
 514
 515 extern void print_modules(void);
 516
 517 #else /* !CONFIG_MODULES... */
 518
 519 /* Given an address, look for it in the exception tables. */
 520 static inline const struct exception_table_entry *
 521 search_module_extables(unsigned long addr)
 522 {
 523         return NULL;
 524 }
 525
 526 static inline struct module *__module_address(unsigned long addr)
 527 {
 528         return NULL;
 529 }
 530
 531 static inline struct module *__module_text_address(unsigned long addr)
 532 {
 533         return NULL;
 534 }
 535
 536 static inline bool is_module_address(unsigned long addr)
 537 {
 538         return false;
 539 }
 540
 541 static inline bool is_module_percpu_address(unsigned long addr)
 542 {
 543         return false;
 544 }
 545
 546 static inline bool is_module_text_address(unsigned long addr)
 547 {
 548         return false;
 549 }
 550
 551 /* Get/put a kernel symbol (calls should be symmetric) */
 552 #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
 553 #define symbol_put(x) do { } while(0)
 554 #define symbol_put_addr(x) do { } while(0)
 555
 556 static inline void __module_get(struct module *module)
 557 {
 558 }
 559
 560 static inline int try_module_get(struct module *module)
 561 {
 562         return 1;
 563 }
 564
 565 static inline void module_put(struct module *module)
 566 {
 567 }
 568
 569 #define module_name(mod) "kernel"
 570
 571 /* For kallsyms to ask for address resolution.  NULL means not found. */
 572 static inline const char *module_address_lookup(unsigned long addr,
 573                                           unsigned long *symbolsize,
 574                                           unsigned long *offset,
 575                                           char **modname,
 576                                           char *namebuf)
 577 {
 578         return NULL;
 579 }
 580
 581 static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
 582 {
 583         return -ERANGE;
 584 }
 585
 586 static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
 587 {
 588         return -ERANGE;
 589 }
 590
 591 static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
 592                                         char *type, char *name,
 593                                         char *module_name, int *exported)
 594 {
 595         return -ERANGE;
 596 }
 597
 598 static inline unsigned long module_kallsyms_lookup_name(const char *name)
 599 {
 600         return 0;
 601 }
 602
 603 static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
 604                                                            struct module *,
 605                                                            unsigned long),
 606                                                  void *data)
 607 {
 608         return 0;
 609 }
 610
 611 static inline int register_module_notifier(struct notifier_block * nb)
 612 {
 613         /* no events will happen anyway, so this can always succeed */
 614         return 0;
 615 }
 616
 617 static inline int unregister_module_notifier(struct notifier_block * nb)
 618 {
 619         return 0;
 620 }
 621
 622 #define module_put_and_exit(code) do_exit(code)
 623
 624 static inline void print_modules(void)
 625 {
 626 }
 627 #endif /* CONFIG_MODULES */
 628
 629 #ifdef CONFIG_SYSFS
 630 extern struct kset *module_kset;
 631 extern struct kobj_type module_ktype;
 632 extern int module_sysfs_initialized;
 633 #endif /* CONFIG_SYSFS */
 634
 635 #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
 636
 637 /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
 638
 639 #define __MODULE_STRING(x) __stringify(x)
 640
 641 #ifdef CONFIG_DEBUG_SET_MODULE_RONX
 642 extern void set_all_modules_text_rw(void);
 643 extern void set_all_modules_text_ro(void);
 644 #else
 645 static inline void set_all_modules_text_rw(void) { }
 646 static inline void set_all_modules_text_ro(void) { }
 647 #endif
 648
 649 #ifdef CONFIG_GENERIC_BUG
 650 void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
 651                          struct module *);
 652 void module_bug_cleanup(struct module *);
 653
 654 #else   /* !CONFIG_GENERIC_BUG */
 655
 656 static inline void module_bug_finalize(const Elf_Ehdr *hdr,
 657                                         const Elf_Shdr *sechdrs,
 658                                         struct module *mod)
 659 {
 660 }
 661 static inline void module_bug_cleanup(struct module *mod) {}
 662 #endif  /* CONFIG_GENERIC_BUG */
 663
 664 #endif /* _LINUX_MODULE_H */