xref: /linux-6.15/include/linux/moduleloader.h (revision 74e08fcf)
11da177e4SLinus Torvalds #ifndef _LINUX_MODULELOADER_H
21da177e4SLinus Torvalds #define _LINUX_MODULELOADER_H
31da177e4SLinus Torvalds /* The stuff needed for archs to support modules. */
41da177e4SLinus Torvalds 
51da177e4SLinus Torvalds #include <linux/module.h>
61da177e4SLinus Torvalds #include <linux/elf.h>
71da177e4SLinus Torvalds 
8*74e08fcfSJonas Bonn /* These may be implemented by architectures that need to hook into the
9*74e08fcfSJonas Bonn  * module loader code.  Architectures that don't need to do anything special
10*74e08fcfSJonas Bonn  * can just rely on the 'weak' default hooks defined in kernel/module.c.
11*74e08fcfSJonas Bonn  * Note, however, that at least one of apply_relocate or apply_relocate_add
12*74e08fcfSJonas Bonn  * must be implemented by each architecture.
13*74e08fcfSJonas Bonn  */
141da177e4SLinus Torvalds 
151da177e4SLinus Torvalds /* Adjust arch-specific sections.  Return 0 on success.  */
161da177e4SLinus Torvalds int module_frob_arch_sections(Elf_Ehdr *hdr,
171da177e4SLinus Torvalds 			      Elf_Shdr *sechdrs,
181da177e4SLinus Torvalds 			      char *secstrings,
191da177e4SLinus Torvalds 			      struct module *mod);
201da177e4SLinus Torvalds 
21088af9a6SHelge Deller /* Additional bytes needed by arch in front of individual sections */
22088af9a6SHelge Deller unsigned int arch_mod_section_prepend(struct module *mod, unsigned int section);
23088af9a6SHelge Deller 
241da177e4SLinus Torvalds /* Allocator used for allocating struct module, core sections and init
251da177e4SLinus Torvalds    sections.  Returns NULL on failure. */
261da177e4SLinus Torvalds void *module_alloc(unsigned long size);
271da177e4SLinus Torvalds 
281da177e4SLinus Torvalds /* Free memory returned from module_alloc. */
291da177e4SLinus Torvalds void module_free(struct module *mod, void *module_region);
301da177e4SLinus Torvalds 
311da177e4SLinus Torvalds /* Apply the given relocation to the (simplified) ELF.  Return -error
321da177e4SLinus Torvalds    or 0. */
331da177e4SLinus Torvalds int apply_relocate(Elf_Shdr *sechdrs,
341da177e4SLinus Torvalds 		   const char *strtab,
351da177e4SLinus Torvalds 		   unsigned int symindex,
361da177e4SLinus Torvalds 		   unsigned int relsec,
371da177e4SLinus Torvalds 		   struct module *mod);
381da177e4SLinus Torvalds 
391da177e4SLinus Torvalds /* Apply the given add relocation to the (simplified) ELF.  Return
401da177e4SLinus Torvalds    -error or 0 */
411da177e4SLinus Torvalds int apply_relocate_add(Elf_Shdr *sechdrs,
421da177e4SLinus Torvalds 		       const char *strtab,
431da177e4SLinus Torvalds 		       unsigned int symindex,
441da177e4SLinus Torvalds 		       unsigned int relsec,
451da177e4SLinus Torvalds 		       struct module *mod);
461da177e4SLinus Torvalds 
471da177e4SLinus Torvalds /* Any final processing of module before access.  Return -error or 0. */
481da177e4SLinus Torvalds int module_finalize(const Elf_Ehdr *hdr,
491da177e4SLinus Torvalds 		    const Elf_Shdr *sechdrs,
501da177e4SLinus Torvalds 		    struct module *mod);
511da177e4SLinus Torvalds 
521da177e4SLinus Torvalds /* Any cleanup needed when module leaves. */
531da177e4SLinus Torvalds void module_arch_cleanup(struct module *mod);
541da177e4SLinus Torvalds 
551da177e4SLinus Torvalds #endif
56