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