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