~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/module.h

Version: ~ [ linux-5.15-rc5 ] ~ [ linux-5.14.11 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.72 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.152 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.210 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.250 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.286 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.288 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp