xref: /kernel/linux/linux-5.10/scripts/mod/modpost.h (revision 8c2ecf20)
1/* SPDX-License-Identifier: GPL-2.0 */
2#include <stdio.h>
3#include <stdlib.h>
4#include <stdarg.h>
5#include <stdbool.h>
6#include <string.h>
7#include <sys/types.h>
8#include <sys/stat.h>
9#include <sys/mman.h>
10#include <fcntl.h>
11#include <unistd.h>
12#include <elf.h>
13
14#include "elfconfig.h"
15
16/* On BSD-alike OSes elf.h defines these according to host's word size */
17#undef ELF_ST_BIND
18#undef ELF_ST_TYPE
19#undef ELF_R_SYM
20#undef ELF_R_TYPE
21
22#if KERNEL_ELFCLASS == ELFCLASS32
23
24#define Elf_Ehdr    Elf32_Ehdr
25#define Elf_Shdr    Elf32_Shdr
26#define Elf_Sym     Elf32_Sym
27#define Elf_Addr    Elf32_Addr
28#define Elf_Sword   Elf64_Sword
29#define Elf_Section Elf32_Half
30#define ELF_ST_BIND ELF32_ST_BIND
31#define ELF_ST_TYPE ELF32_ST_TYPE
32
33#define Elf_Rel     Elf32_Rel
34#define Elf_Rela    Elf32_Rela
35#define ELF_R_SYM   ELF32_R_SYM
36#define ELF_R_TYPE  ELF32_R_TYPE
37#else
38
39#define Elf_Ehdr    Elf64_Ehdr
40#define Elf_Shdr    Elf64_Shdr
41#define Elf_Sym     Elf64_Sym
42#define Elf_Addr    Elf64_Addr
43#define Elf_Sword   Elf64_Sxword
44#define Elf_Section Elf64_Half
45#define ELF_ST_BIND ELF64_ST_BIND
46#define ELF_ST_TYPE ELF64_ST_TYPE
47
48#define Elf_Rel     Elf64_Rel
49#define Elf_Rela    Elf64_Rela
50#define ELF_R_SYM   ELF64_R_SYM
51#define ELF_R_TYPE  ELF64_R_TYPE
52#endif
53
54/* The 64-bit MIPS ELF ABI uses an unusual reloc format. */
55typedef struct
56{
57	Elf32_Word    r_sym;	/* Symbol index */
58	unsigned char r_ssym;	/* Special symbol for 2nd relocation */
59	unsigned char r_type3;	/* 3rd relocation type */
60	unsigned char r_type2;	/* 2nd relocation type */
61	unsigned char r_type1;	/* 1st relocation type */
62} _Elf64_Mips_R_Info;
63
64typedef union
65{
66	Elf64_Xword		r_info_number;
67	_Elf64_Mips_R_Info	r_info_fields;
68} _Elf64_Mips_R_Info_union;
69
70#define ELF64_MIPS_R_SYM(i) \
71  ((__extension__ (_Elf64_Mips_R_Info_union)(i)).r_info_fields.r_sym)
72
73#define ELF64_MIPS_R_TYPE(i) \
74  ((__extension__ (_Elf64_Mips_R_Info_union)(i)).r_info_fields.r_type1)
75
76#if KERNEL_ELFDATA != HOST_ELFDATA
77
78static inline void __endian(const void *src, void *dest, unsigned int size)
79{
80	unsigned int i;
81	for (i = 0; i < size; i++)
82		((unsigned char*)dest)[i] = ((unsigned char*)src)[size - i-1];
83}
84
85#define TO_NATIVE(x)						\
86({								\
87	typeof(x) __x;						\
88	__endian(&(x), &(__x), sizeof(__x));			\
89	__x;							\
90})
91
92#else /* endianness matches */
93
94#define TO_NATIVE(x) (x)
95
96#endif
97
98#define NOFAIL(ptr)   do_nofail((ptr), #ptr)
99void *do_nofail(void *ptr, const char *expr);
100
101struct buffer {
102	char *p;
103	int pos;
104	int size;
105};
106
107void __attribute__((format(printf, 2, 3)))
108buf_printf(struct buffer *buf, const char *fmt, ...);
109
110void
111buf_write(struct buffer *buf, const char *s, int len);
112
113struct namespace_list {
114	struct namespace_list *next;
115	char namespace[];
116};
117
118struct module {
119	struct module *next;
120	int gpl_compatible;
121	struct symbol *unres;
122	int from_dump;  /* 1 if module was loaded from *.symvers */
123	int is_vmlinux;
124	int seen;
125	int has_init;
126	int has_cleanup;
127	struct buffer dev_table_buf;
128	char	     srcversion[25];
129	// Missing namespace dependencies
130	struct namespace_list *missing_namespaces;
131	// Actual imported namespaces
132	struct namespace_list *imported_namespaces;
133	char name[];
134};
135
136struct elf_info {
137	size_t size;
138	Elf_Ehdr     *hdr;
139	Elf_Shdr     *sechdrs;
140	Elf_Sym      *symtab_start;
141	Elf_Sym      *symtab_stop;
142	Elf_Section  export_sec;
143	Elf_Section  export_unused_sec;
144	Elf_Section  export_gpl_sec;
145	Elf_Section  export_unused_gpl_sec;
146	Elf_Section  export_gpl_future_sec;
147	char         *strtab;
148	char	     *modinfo;
149	unsigned int modinfo_len;
150
151	/* support for 32bit section numbers */
152
153	unsigned int num_sections; /* max_secindex + 1 */
154	unsigned int secindex_strings;
155	/* if Nth symbol table entry has .st_shndx = SHN_XINDEX,
156	 * take shndx from symtab_shndx_start[N] instead */
157	Elf32_Word   *symtab_shndx_start;
158	Elf32_Word   *symtab_shndx_stop;
159};
160
161static inline int is_shndx_special(unsigned int i)
162{
163	return i != SHN_XINDEX && i >= SHN_LORESERVE && i <= SHN_HIRESERVE;
164}
165
166/*
167 * Move reserved section indices SHN_LORESERVE..SHN_HIRESERVE out of
168 * the way to -256..-1, to avoid conflicting with real section
169 * indices.
170 */
171#define SPECIAL(i) ((i) - (SHN_HIRESERVE + 1))
172
173/* Accessor for sym->st_shndx, hides ugliness of "64k sections" */
174static inline unsigned int get_secindex(const struct elf_info *info,
175					const Elf_Sym *sym)
176{
177	if (is_shndx_special(sym->st_shndx))
178		return SPECIAL(sym->st_shndx);
179	if (sym->st_shndx != SHN_XINDEX)
180		return sym->st_shndx;
181	return info->symtab_shndx_start[sym - info->symtab_start];
182}
183
184static inline bool strends(const char *str, const char *postfix)
185{
186	if (strlen(str) < strlen(postfix))
187		return false;
188
189	return strcmp(str + strlen(str) - strlen(postfix), postfix) == 0;
190}
191
192/* file2alias.c */
193extern unsigned int cross_build;
194void handle_moddevtable(struct module *mod, struct elf_info *info,
195			Elf_Sym *sym, const char *symname);
196void add_moddevtable(struct buffer *buf, struct module *mod);
197
198/* sumversion.c */
199void get_src_version(const char *modname, char sum[], unsigned sumlen);
200
201/* from modpost.c */
202char *read_text_file(const char *filename);
203char *get_line(char **stringp);
204
205enum loglevel {
206	LOG_WARN,
207	LOG_ERROR,
208	LOG_FATAL
209};
210
211void modpost_log(enum loglevel loglevel, const char *fmt, ...);
212
213#define warn(fmt, args...)	modpost_log(LOG_WARN, fmt, ##args)
214#define merror(fmt, args...)	modpost_log(LOG_ERROR, fmt, ##args)
215#define fatal(fmt, args...)	modpost_log(LOG_FATAL, fmt, ##args)
216