linux/include/linux/module.h
<<
>>
Prefs
   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/init.h>
  15#include <linux/elf.h>
  16#include <linux/stringify.h>
  17#include <linux/kobject.h>
  18#include <linux/moduleparam.h>
  19#include <linux/jump_label.h>
  20#include <linux/export.h>
  21#include <linux/rbtree_latch.h>
  22#include <linux/error-injection.h>
  23#include <linux/tracepoint-defs.h>
  24
  25#include <linux/percpu.h>
  26#include <asm/module.h>
  27
  28/* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
  29#define MODULE_SIG_STRING "~Module signature appended~\n"
  30
  31/* Not Yet Implemented */
  32#define MODULE_SUPPORTED_DEVICE(name)
  33
  34#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
  35
  36struct modversion_info {
  37        unsigned long crc;
  38        char name[MODULE_NAME_LEN];
  39};
  40
  41struct module;
  42struct exception_table_entry;
  43
  44struct module_kobject {
  45        struct kobject kobj;
  46        struct module *mod;
  47        struct kobject *drivers_dir;
  48        struct module_param_attrs *mp;
  49        struct completion *kobj_completion;
  50} __randomize_layout;
  51
  52struct module_attribute {
  53        struct attribute attr;
  54        ssize_t (*show)(struct module_attribute *, struct module_kobject *,
  55                        char *);
  56        ssize_t (*store)(struct module_attribute *, struct module_kobject *,
  57                         const char *, size_t count);
  58        void (*setup)(struct module *, const char *);
  59        int (*test)(struct module *);
  60        void (*free)(struct module *);
  61};
  62
  63struct module_version_attribute {
  64        struct module_attribute mattr;
  65        const char *module_name;
  66        const char *version;
  67} __attribute__ ((__aligned__(sizeof(void *))));
  68
  69extern ssize_t __modver_version_show(struct module_attribute *,
  70                                     struct module_kobject *, char *);
  71
  72extern struct module_attribute module_uevent;
  73
  74/* These are either module local, or the kernel's dummy ones. */
  75extern int init_module(void);
  76extern void cleanup_module(void);
  77
  78#ifndef MODULE
  79/**
  80 * module_init() - driver initialization entry point
  81 * @x: function to be run at kernel boot time or module insertion
  82 *
  83 * module_init() will either be called during do_initcalls() (if
  84 * builtin) or at module insertion time (if a module).  There can only
  85 * be one per module.
  86 */
  87#define module_init(x)  __initcall(x);
  88
  89/**
  90 * module_exit() - driver exit entry point
  91 * @x: function to be run when driver is removed
  92 *
  93 * module_exit() will wrap the driver clean-up code
  94 * with cleanup_module() when used with rmmod when
  95 * the driver is a module.  If the driver is statically
  96 * compiled into the kernel, module_exit() has no effect.
  97 * There can only be one per module.
  98 */
  99#define module_exit(x)  __exitcall(x);
 100
 101#else /* MODULE */
 102
 103/*
 104 * In most cases loadable modules do not need custom
 105 * initcall levels. There are still some valid cases where
 106 * a driver may be needed early if built in, and does not
 107 * matter when built as a loadable module. Like bus
 108 * snooping debug drivers.
 109 */
 110#define early_initcall(fn)              module_init(fn)
 111#define core_initcall(fn)               module_init(fn)
 112#define core_initcall_sync(fn)          module_init(fn)
 113#define postcore_initcall(fn)           module_init(fn)
 114#define postcore_initcall_sync(fn)      module_init(fn)
 115#define arch_initcall(fn)               module_init(fn)
 116#define subsys_initcall(fn)             module_init(fn)
 117#define subsys_initcall_sync(fn)        module_init(fn)
 118#define fs_initcall(fn)                 module_init(fn)
 119#define fs_initcall_sync(fn)            module_init(fn)
 120#define rootfs_initcall(fn)             module_init(fn)
 121#define device_initcall(fn)             module_init(fn)
 122#define device_initcall_sync(fn)        module_init(fn)
 123#define late_initcall(fn)               module_init(fn)
 124#define late_initcall_sync(fn)          module_init(fn)
 125
 126#define console_initcall(fn)            module_init(fn)
 127
 128/* Each module must use one module_init(). */
 129#define module_init(initfn)                                     \
 130        static inline initcall_t __maybe_unused __inittest(void)                \
 131        { return initfn; }                                      \
 132        int init_module(void) __copy(initfn) __attribute__((alias(#initfn)));
 133
 134/* This is only required if you want to be unloadable. */
 135#define module_exit(exitfn)                                     \
 136        static inline exitcall_t __maybe_unused __exittest(void)                \
 137        { return exitfn; }                                      \
 138        void cleanup_module(void) __copy(exitfn) __attribute__((alias(#exitfn)));
 139
 140#endif
 141
 142/* This means "can be init if no module support, otherwise module load
 143   may call it." */
 144#ifdef CONFIG_MODULES
 145#define __init_or_module
 146#define __initdata_or_module
 147#define __initconst_or_module
 148#define __INIT_OR_MODULE        .text
 149#define __INITDATA_OR_MODULE    .data
 150#define __INITRODATA_OR_MODULE  .section ".rodata","a",%progbits
 151#else
 152#define __init_or_module __init
 153#define __initdata_or_module __initdata
 154#define __initconst_or_module __initconst
 155#define __INIT_OR_MODULE __INIT
 156#define __INITDATA_OR_MODULE __INITDATA
 157#define __INITRODATA_OR_MODULE __INITRODATA
 158#endif /*CONFIG_MODULES*/
 159
 160/* Generic info of form tag = "info" */
 161#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
 162
 163/* For userspace: you can also call me... */
 164#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
 165
 166/* Soft module dependencies. See man modprobe.d for details.
 167 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
 168 */
 169#define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
 170
 171/*
 172 * The following license idents are currently accepted as indicating free
 173 * software modules
 174 *
 175 *      "GPL"                           [GNU Public License v2 or later]
 176 *      "GPL v2"                        [GNU Public License v2]
 177 *      "GPL and additional rights"     [GNU Public License v2 rights and more]
 178 *      "Dual BSD/GPL"                  [GNU Public License v2
 179 *                                       or BSD license choice]
 180 *      "Dual MIT/GPL"                  [GNU Public License v2
 181 *                                       or MIT license choice]
 182 *      "Dual MPL/GPL"                  [GNU Public License v2
 183 *                                       or Mozilla license choice]
 184 *
 185 * The following other idents are available
 186 *
 187 *      "Proprietary"                   [Non free products]
 188 *
 189 * There are dual licensed components, but when running with Linux it is the
 190 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
 191 * is a GPL combined work.
 192 *
 193 * This exists for several reasons
 194 * 1.   So modinfo can show license info for users wanting to vet their setup
 195 *      is free
 196 * 2.   So the community can ignore bug reports including proprietary modules
 197 * 3.   So vendors can do likewise based on their own policies
 198 */
 199#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
 200
 201/*
 202 * Author(s), use "Name <email>" or just "Name", for multiple
 203 * authors use multiple MODULE_AUTHOR() statements/lines.
 204 */
 205#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
 206
 207/* What your module does. */
 208#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
 209
 210#ifdef MODULE
 211/* Creates an alias so file2alias.c can find device table. */
 212#define MODULE_DEVICE_TABLE(type, name)                                 \
 213extern typeof(name) __mod_##type##__##name##_device_table               \
 214  __attribute__ ((unused, alias(__stringify(name))))
 215#else  /* !MODULE */
 216#define MODULE_DEVICE_TABLE(type, name)
 217#endif
 218
 219/* Version of form [<epoch>:]<version>[-<extra-version>].
 220 * Or for CVS/RCS ID version, everything but the number is stripped.
 221 * <epoch>: A (small) unsigned integer which allows you to start versions
 222 * anew. If not mentioned, it's zero.  eg. "2:1.0" is after
 223 * "1:2.0".
 224
 225 * <version>: The <version> may contain only alphanumerics and the
 226 * character `.'.  Ordered by numeric sort for numeric parts,
 227 * ascii sort for ascii parts (as per RPM or DEB algorithm).
 228
 229 * <extraversion>: Like <version>, but inserted for local
 230 * customizations, eg "rh3" or "rusty1".
 231
 232 * Using this automatically adds a checksum of the .c files and the
 233 * local headers in "srcversion".
 234 */
 235
 236#if defined(MODULE) || !defined(CONFIG_SYSFS)
 237#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
 238#else
 239#define MODULE_VERSION(_version)                                        \
 240        static struct module_version_attribute ___modver_attr = {       \
 241                .mattr  = {                                             \
 242                        .attr   = {                                     \
 243                                .name   = "version",                    \
 244                                .mode   = S_IRUGO,                      \
 245                        },                                              \
 246                        .show   = __modver_version_show,                \
 247                },                                                      \
 248                .module_name    = KBUILD_MODNAME,                       \
 249                .version        = _version,                             \
 250        };                                                              \
 251        static const struct module_version_attribute                    \
 252        __used __attribute__ ((__section__ ("__modver")))               \
 253        * __moduleparam_const __modver_attr = &___modver_attr
 254#endif
 255
 256/* Optional firmware file (or files) needed by the module
 257 * format is simply firmware file name.  Multiple firmware
 258 * files require multiple MODULE_FIRMWARE() specifiers */
 259#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
 260
 261struct notifier_block;
 262
 263#ifdef CONFIG_MODULES
 264
 265extern int modules_disabled; /* for sysctl */
 266/* Get/put a kernel symbol (calls must be symmetric) */
 267void *__symbol_get(const char *symbol);
 268void *__symbol_get_gpl(const char *symbol);
 269#define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
 270
 271/* modules using other modules: kdb wants to see this. */
 272struct module_use {
 273        struct list_head source_list;
 274        struct list_head target_list;
 275        struct module *source, *target;
 276};
 277
 278enum module_state {
 279        MODULE_STATE_LIVE,      /* Normal state. */
 280        MODULE_STATE_COMING,    /* Full formed, running module_init. */
 281        MODULE_STATE_GOING,     /* Going away. */
 282        MODULE_STATE_UNFORMED,  /* Still setting it up. */
 283};
 284
 285struct mod_tree_node {
 286        struct module *mod;
 287        struct latch_tree_node node;
 288};
 289
 290struct module_layout {
 291        /* The actual code + data. */
 292        void *base;
 293        /* Total size. */
 294        unsigned int size;
 295        /* The size of the executable code.  */
 296        unsigned int text_size;
 297        /* Size of RO section of the module (text+rodata) */
 298        unsigned int ro_size;
 299        /* Size of RO after init section */
 300        unsigned int ro_after_init_size;
 301
 302#ifdef CONFIG_MODULES_TREE_LOOKUP
 303        struct mod_tree_node mtn;
 304#endif
 305};
 306
 307#ifdef CONFIG_MODULES_TREE_LOOKUP
 308/* Only touch one cacheline for common rbtree-for-core-layout case. */
 309#define __module_layout_align ____cacheline_aligned
 310#else
 311#define __module_layout_align
 312#endif
 313
 314struct mod_kallsyms {
 315        Elf_Sym *symtab;
 316        unsigned int num_symtab;
 317        char *strtab;
 318};
 319
 320#ifdef CONFIG_LIVEPATCH
 321struct klp_modinfo {
 322        Elf_Ehdr hdr;
 323        Elf_Shdr *sechdrs;
 324        char *secstrings;
 325        unsigned int symndx;
 326};
 327#endif
 328
 329struct module {
 330        enum module_state state;
 331
 332        /* Member of list of modules */
 333        struct list_head list;
 334
 335        /* Unique handle for this module */
 336        char name[MODULE_NAME_LEN];
 337
 338        /* Sysfs stuff. */
 339        struct module_kobject mkobj;
 340        struct module_attribute *modinfo_attrs;
 341        const char *version;
 342        const char *srcversion;
 343        struct kobject *holders_dir;
 344
 345        /* Exported symbols */
 346        const struct kernel_symbol *syms;
 347        const s32 *crcs;
 348        unsigned int num_syms;
 349
 350        /* Kernel parameters. */
 351#ifdef CONFIG_SYSFS
 352        struct mutex param_lock;
 353#endif
 354        struct kernel_param *kp;
 355        unsigned int num_kp;
 356
 357        /* GPL-only exported symbols. */
 358        unsigned int num_gpl_syms;
 359        const struct kernel_symbol *gpl_syms;
 360        const s32 *gpl_crcs;
 361
 362#ifdef CONFIG_UNUSED_SYMBOLS
 363        /* unused exported symbols. */
 364        const struct kernel_symbol *unused_syms;
 365        const s32 *unused_crcs;
 366        unsigned int num_unused_syms;
 367
 368        /* GPL-only, unused exported symbols. */
 369        unsigned int num_unused_gpl_syms;
 370        const struct kernel_symbol *unused_gpl_syms;
 371        const s32 *unused_gpl_crcs;
 372#endif
 373
 374#ifdef CONFIG_MODULE_SIG
 375        /* Signature was verified. */
 376        bool sig_ok;
 377#endif
 378
 379        bool async_probe_requested;
 380
 381        /* symbols that will be GPL-only in the near future. */
 382        const struct kernel_symbol *gpl_future_syms;
 383        const s32 *gpl_future_crcs;
 384        unsigned int num_gpl_future_syms;
 385
 386        /* Exception table */
 387        unsigned int num_exentries;
 388        struct exception_table_entry *extable;
 389
 390        /* Startup function. */
 391        int (*init)(void);
 392
 393        /* Core layout: rbtree is accessed frequently, so keep together. */
 394        struct module_layout core_layout __module_layout_align;
 395        struct module_layout init_layout;
 396
 397        /* Arch-specific module values */
 398        struct mod_arch_specific arch;
 399
 400        unsigned long taints;   /* same bits as kernel:taint_flags */
 401
 402#ifdef CONFIG_GENERIC_BUG
 403        /* Support for BUG */
 404        unsigned num_bugs;
 405        struct list_head bug_list;
 406        struct bug_entry *bug_table;
 407#endif
 408
 409#ifdef CONFIG_KALLSYMS
 410        /* Protected by RCU and/or module_mutex: use rcu_dereference() */
 411        struct mod_kallsyms *kallsyms;
 412        struct mod_kallsyms core_kallsyms;
 413
 414        /* Section attributes */
 415        struct module_sect_attrs *sect_attrs;
 416
 417        /* Notes attributes */
 418        struct module_notes_attrs *notes_attrs;
 419#endif
 420
 421        /* The command line arguments (may be mangled).  People like
 422           keeping pointers to this stuff */
 423        char *args;
 424
 425#ifdef CONFIG_SMP
 426        /* Per-cpu data. */
 427        void __percpu *percpu;
 428        unsigned int percpu_size;
 429#endif
 430
 431#ifdef CONFIG_TRACEPOINTS
 432        unsigned int num_tracepoints;
 433        tracepoint_ptr_t *tracepoints_ptrs;
 434#endif
 435#ifdef CONFIG_BPF_EVENTS
 436        unsigned int num_bpf_raw_events;
 437        struct bpf_raw_event_map *bpf_raw_events;
 438#endif
 439#ifdef CONFIG_JUMP_LABEL
 440        struct jump_entry *jump_entries;
 441        unsigned int num_jump_entries;
 442#endif
 443#ifdef CONFIG_TRACING
 444        unsigned int num_trace_bprintk_fmt;
 445        const char **trace_bprintk_fmt_start;
 446#endif
 447#ifdef CONFIG_EVENT_TRACING
 448        struct trace_event_call **trace_events;
 449        unsigned int num_trace_events;
 450        struct trace_eval_map **trace_evals;
 451        unsigned int num_trace_evals;
 452#endif
 453#ifdef CONFIG_FTRACE_MCOUNT_RECORD
 454        unsigned int num_ftrace_callsites;
 455        unsigned long *ftrace_callsites;
 456#endif
 457
 458#ifdef CONFIG_LIVEPATCH
 459        bool klp; /* Is this a livepatch module? */
 460        bool klp_alive;
 461
 462        /* Elf information */
 463        struct klp_modinfo *klp_info;
 464#endif
 465
 466#ifdef CONFIG_MODULE_UNLOAD
 467        /* What modules depend on me? */
 468        struct list_head source_list;
 469        /* What modules do I depend on? */
 470        struct list_head target_list;
 471
 472        /* Destruction function. */
 473        void (*exit)(void);
 474
 475        atomic_t refcnt;
 476#endif
 477
 478#ifdef CONFIG_CONSTRUCTORS
 479        /* Constructor functions. */
 480        ctor_fn_t *ctors;
 481        unsigned int num_ctors;
 482#endif
 483
 484#ifdef CONFIG_FUNCTION_ERROR_INJECTION
 485        struct error_injection_entry *ei_funcs;
 486        unsigned int num_ei_funcs;
 487#endif
 488} ____cacheline_aligned __randomize_layout;
 489#ifndef MODULE_ARCH_INIT
 490#define MODULE_ARCH_INIT {}
 491#endif
 492
 493#ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
 494static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
 495{
 496        return sym->st_value;
 497}
 498#endif
 499
 500extern struct mutex module_mutex;
 501
 502/* FIXME: It'd be nice to isolate modules during init, too, so they
 503   aren't used before they (may) fail.  But presently too much code
 504   (IDE & SCSI) require entry into the module during init.*/
 505static inline bool module_is_live(struct module *mod)
 506{
 507        return mod->state != MODULE_STATE_GOING;
 508}
 509
 510struct module *__module_text_address(unsigned long addr);
 511struct module *__module_address(unsigned long addr);
 512bool is_module_address(unsigned long addr);
 513bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
 514bool is_module_percpu_address(unsigned long addr);
 515bool is_module_text_address(unsigned long addr);
 516
 517static inline bool within_module_core(unsigned long addr,
 518                                      const struct module *mod)
 519{
 520        return (unsigned long)mod->core_layout.base <= addr &&
 521               addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
 522}
 523
 524static inline bool within_module_init(unsigned long addr,
 525                                      const struct module *mod)
 526{
 527        return (unsigned long)mod->init_layout.base <= addr &&
 528               addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
 529}
 530
 531static inline bool within_module(unsigned long addr, const struct module *mod)
 532{
 533        return within_module_init(addr, mod) || within_module_core(addr, mod);
 534}
 535
 536/* Search for module by name: must hold module_mutex. */
 537struct module *find_module(const char *name);
 538
 539struct symsearch {
 540        const struct kernel_symbol *start, *stop;
 541        const s32 *crcs;
 542        enum {
 543                NOT_GPL_ONLY,
 544                GPL_ONLY,
 545                WILL_BE_GPL_ONLY,
 546        } licence;
 547        bool unused;
 548};
 549
 550/*
 551 * Search for an exported symbol by name.
 552 *
 553 * Must be called with module_mutex held or preemption disabled.
 554 */
 555const struct kernel_symbol *find_symbol(const char *name,
 556                                        struct module **owner,
 557                                        const s32 **crc,
 558                                        bool gplok,
 559                                        bool warn);
 560
 561/*
 562 * Walk the exported symbol table
 563 *
 564 * Must be called with module_mutex held or preemption disabled.
 565 */
 566bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
 567                                    struct module *owner,
 568                                    void *data), void *data);
 569
 570/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
 571   symnum out of range. */
 572int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
 573                        char *name, char *module_name, int *exported);
 574
 575/* Look for this name: can be of form module:name. */
 576unsigned long module_kallsyms_lookup_name(const char *name);
 577
 578int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
 579                                             struct module *, unsigned long),
 580                                   void *data);
 581
 582extern void __noreturn __module_put_and_exit(struct module *mod,
 583                        long code);
 584#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
 585
 586#ifdef CONFIG_MODULE_UNLOAD
 587int module_refcount(struct module *mod);
 588void __symbol_put(const char *symbol);
 589#define symbol_put(x) __symbol_put(__stringify(x))
 590void symbol_put_addr(void *addr);
 591
 592/* Sometimes we know we already have a refcount, and it's easier not
 593   to handle the error case (which only happens with rmmod --wait). */
 594extern void __module_get(struct module *module);
 595
 596/* This is the Right Way to get a module: if it fails, it's being removed,
 597 * so pretend it's not there. */
 598extern bool try_module_get(struct module *module);
 599
 600extern void module_put(struct module *module);
 601
 602#else /*!CONFIG_MODULE_UNLOAD*/
 603static inline bool try_module_get(struct module *module)
 604{
 605        return !module || module_is_live(module);
 606}
 607static inline void module_put(struct module *module)
 608{
 609}
 610static inline void __module_get(struct module *module)
 611{
 612}
 613#define symbol_put(x) do { } while (0)
 614#define symbol_put_addr(p) do { } while (0)
 615
 616#endif /* CONFIG_MODULE_UNLOAD */
 617int ref_module(struct module *a, struct module *b);
 618
 619/* This is a #define so the string doesn't get put in every .o file */
 620#define module_name(mod)                        \
 621({                                              \
 622        struct module *__mod = (mod);           \
 623        __mod ? __mod->name : "kernel";         \
 624})
 625
 626/* Dereference module function descriptor */
 627void *dereference_module_function_descriptor(struct module *mod, void *ptr);
 628
 629/* For kallsyms to ask for address resolution.  namebuf should be at
 630 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
 631 * found, otherwise NULL. */
 632const char *module_address_lookup(unsigned long addr,
 633                            unsigned long *symbolsize,
 634                            unsigned long *offset,
 635                            char **modname,
 636                            char *namebuf);
 637int lookup_module_symbol_name(unsigned long addr, char *symname);
 638int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
 639
 640int register_module_notifier(struct notifier_block *nb);
 641int unregister_module_notifier(struct notifier_block *nb);
 642
 643extern void print_modules(void);
 644
 645static inline bool module_requested_async_probing(struct module *module)
 646{
 647        return module && module->async_probe_requested;
 648}
 649
 650#ifdef CONFIG_LIVEPATCH
 651static inline bool is_livepatch_module(struct module *mod)
 652{
 653        return mod->klp;
 654}
 655#else /* !CONFIG_LIVEPATCH */
 656static inline bool is_livepatch_module(struct module *mod)
 657{
 658        return false;
 659}
 660#endif /* CONFIG_LIVEPATCH */
 661
 662bool is_module_sig_enforced(void);
 663
 664#else /* !CONFIG_MODULES... */
 665
 666static inline struct module *__module_address(unsigned long addr)
 667{
 668        return NULL;
 669}
 670
 671static inline struct module *__module_text_address(unsigned long addr)
 672{
 673        return NULL;
 674}
 675
 676static inline bool is_module_address(unsigned long addr)
 677{
 678        return false;
 679}
 680
 681static inline bool is_module_percpu_address(unsigned long addr)
 682{
 683        return false;
 684}
 685
 686static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
 687{
 688        return false;
 689}
 690
 691static inline bool is_module_text_address(unsigned long addr)
 692{
 693        return false;
 694}
 695
 696/* Get/put a kernel symbol (calls should be symmetric) */
 697#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
 698#define symbol_put(x) do { } while (0)
 699#define symbol_put_addr(x) do { } while (0)
 700
 701static inline void __module_get(struct module *module)
 702{
 703}
 704
 705static inline bool try_module_get(struct module *module)
 706{
 707        return true;
 708}
 709
 710static inline void module_put(struct module *module)
 711{
 712}
 713
 714#define module_name(mod) "kernel"
 715
 716/* For kallsyms to ask for address resolution.  NULL means not found. */
 717static inline const char *module_address_lookup(unsigned long addr,
 718                                          unsigned long *symbolsize,
 719                                          unsigned long *offset,
 720                                          char **modname,
 721                                          char *namebuf)
 722{
 723        return NULL;
 724}
 725
 726static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
 727{
 728        return -ERANGE;
 729}
 730
 731static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
 732{
 733        return -ERANGE;
 734}
 735
 736static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
 737                                        char *type, char *name,
 738                                        char *module_name, int *exported)
 739{
 740        return -ERANGE;
 741}
 742
 743static inline unsigned long module_kallsyms_lookup_name(const char *name)
 744{
 745        return 0;
 746}
 747
 748static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
 749                                                           struct module *,
 750                                                           unsigned long),
 751                                                 void *data)
 752{
 753        return 0;
 754}
 755
 756static inline int register_module_notifier(struct notifier_block *nb)
 757{
 758        /* no events will happen anyway, so this can always succeed */
 759        return 0;
 760}
 761
 762static inline int unregister_module_notifier(struct notifier_block *nb)
 763{
 764        return 0;
 765}
 766
 767#define module_put_and_exit(code) do_exit(code)
 768
 769static inline void print_modules(void)
 770{
 771}
 772
 773static inline bool module_requested_async_probing(struct module *module)
 774{
 775        return false;
 776}
 777
 778static inline bool is_module_sig_enforced(void)
 779{
 780        return false;
 781}
 782
 783/* Dereference module function descriptor */
 784static inline
 785void *dereference_module_function_descriptor(struct module *mod, void *ptr)
 786{
 787        return ptr;
 788}
 789
 790#endif /* CONFIG_MODULES */
 791
 792#ifdef CONFIG_SYSFS
 793extern struct kset *module_kset;
 794extern struct kobj_type module_ktype;
 795extern int module_sysfs_initialized;
 796#endif /* CONFIG_SYSFS */
 797
 798#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
 799
 800/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
 801
 802#define __MODULE_STRING(x) __stringify(x)
 803
 804#ifdef CONFIG_STRICT_MODULE_RWX
 805extern void set_all_modules_text_rw(void);
 806extern void set_all_modules_text_ro(void);
 807extern void module_enable_ro(const struct module *mod, bool after_init);
 808extern void module_disable_ro(const struct module *mod);
 809#else
 810static inline void set_all_modules_text_rw(void) { }
 811static inline void set_all_modules_text_ro(void) { }
 812static inline void module_enable_ro(const struct module *mod, bool after_init) { }
 813static inline void module_disable_ro(const struct module *mod) { }
 814#endif
 815
 816#ifdef CONFIG_GENERIC_BUG
 817void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
 818                         struct module *);
 819void module_bug_cleanup(struct module *);
 820
 821#else   /* !CONFIG_GENERIC_BUG */
 822
 823static inline void module_bug_finalize(const Elf_Ehdr *hdr,
 824                                        const Elf_Shdr *sechdrs,
 825                                        struct module *mod)
 826{
 827}
 828static inline void module_bug_cleanup(struct module *mod) {}
 829#endif  /* CONFIG_GENERIC_BUG */
 830
 831#ifdef CONFIG_RETPOLINE
 832extern bool retpoline_module_ok(bool has_retpoline);
 833#else
 834static inline bool retpoline_module_ok(bool has_retpoline)
 835{
 836        return true;
 837}
 838#endif
 839
 840#ifdef CONFIG_MODULE_SIG
 841static inline bool module_sig_ok(struct module *module)
 842{
 843        return module->sig_ok;
 844}
 845#else   /* !CONFIG_MODULE_SIG */
 846static inline bool module_sig_ok(struct module *module)
 847{
 848        return true;
 849}
 850#endif  /* CONFIG_MODULE_SIG */
 851
 852#endif /* _LINUX_MODULE_H */
 853