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