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

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

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

~ [ 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