1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_MODULELOADER_H
3 #define _LINUX_MODULELOADER_H
4 /* The stuff needed for archs to support modules. */
5
6 #include <linux/module.h>
7 #include <linux/elf.h>
8
9 /* These may be implemented by architectures that need to hook into the
10 * module loader code. Architectures that don't need to do anything special
11 * can just rely on the 'weak' default hooks defined in kernel/module.c.
12 * Note, however, that at least one of apply_relocate or apply_relocate_add
13 * must be implemented by each architecture.
14 */
15
16 /* Adjust arch-specific sections. Return 0 on success. */
17 int module_frob_arch_sections(Elf_Ehdr *hdr,
18 Elf_Shdr *sechdrs,
19 char *secstrings,
20 struct module *mod);
21
22 /* Additional bytes needed by arch in front of individual sections */
23 unsigned int arch_mod_section_prepend(struct module *mod, unsigned int section);
24
25 /* Allocator used for allocating struct module, core sections and init
26 sections. Returns NULL on failure. */
27 void *module_alloc(unsigned long size);
28
29 /* Free memory returned from module_alloc. */
30 void module_memfree(void *module_region);
31
32 /* Determines if the section name is an init section (that is only used during
33 * module loading).
34 */
35 bool module_init_section(const char *name);
36
37 /* Determines if the section name is an exit section (that is only used during
38 * module unloading)
39 */
40 bool module_exit_section(const char *name);
41
42 /* Describes whether within_module_init() will consider this an init section
43 * or not. This behaviour changes with CONFIG_MODULE_UNLOAD.
44 */
45 bool module_init_layout_section(const char *sname);
46
47 /*
48 * Apply the given relocation to the (simplified) ELF. Return -error
49 * or 0.
50 */
51 #ifdef CONFIG_MODULES_USE_ELF_REL
52 int apply_relocate(Elf_Shdr *sechdrs,
53 const char *strtab,
54 unsigned int symindex,
55 unsigned int relsec,
56 struct module *mod);
57 #else
apply_relocate(Elf_Shdr * sechdrs,const char * strtab,unsigned int symindex,unsigned int relsec,struct module * me)58 static inline int apply_relocate(Elf_Shdr *sechdrs,
59 const char *strtab,
60 unsigned int symindex,
61 unsigned int relsec,
62 struct module *me)
63 {
64 printk(KERN_ERR "module %s: REL relocation unsupported\n",
65 module_name(me));
66 return -ENOEXEC;
67 }
68 #endif
69
70 /*
71 * Apply the given add relocation to the (simplified) ELF. Return
72 * -error or 0
73 */
74 #ifdef CONFIG_MODULES_USE_ELF_RELA
75 int apply_relocate_add(Elf_Shdr *sechdrs,
76 const char *strtab,
77 unsigned int symindex,
78 unsigned int relsec,
79 struct module *mod);
80 #else
apply_relocate_add(Elf_Shdr * sechdrs,const char * strtab,unsigned int symindex,unsigned int relsec,struct module * me)81 static inline int apply_relocate_add(Elf_Shdr *sechdrs,
82 const char *strtab,
83 unsigned int symindex,
84 unsigned int relsec,
85 struct module *me)
86 {
87 printk(KERN_ERR "module %s: REL relocation unsupported\n",
88 module_name(me));
89 return -ENOEXEC;
90 }
91 #endif
92
93 /* Any final processing of module before access. Return -error or 0. */
94 int module_finalize(const Elf_Ehdr *hdr,
95 const Elf_Shdr *sechdrs,
96 struct module *mod);
97
98 /* Any cleanup needed when module leaves. */
99 void module_arch_cleanup(struct module *mod);
100
101 /* Any cleanup before freeing mod->module_init */
102 void module_arch_freeing_init(struct module *mod);
103
104 #if (defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)) && \
105 !defined(CONFIG_KASAN_VMALLOC)
106 #include <linux/kasan.h>
107 #define MODULE_ALIGN (PAGE_SIZE << KASAN_SHADOW_SCALE_SHIFT)
108 #else
109 #define MODULE_ALIGN PAGE_SIZE
110 #endif
111
112 #endif
113