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