xref: /freebsd/sys/sys/elf32.h (revision 535af610)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1996-1998 John D. Polstra.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _SYS_ELF32_H_
32 #define _SYS_ELF32_H_ 1
33 
34 #include <sys/elf_common.h>
35 
36 /*
37  * ELF definitions common to all 32-bit architectures.
38  */
39 
40 typedef uint32_t	Elf32_Addr;
41 typedef uint16_t	Elf32_Half;
42 typedef uint32_t	Elf32_Off;
43 typedef int32_t		Elf32_Sword;
44 typedef uint32_t	Elf32_Word;
45 typedef uint64_t	Elf32_Lword;
46 
47 typedef Elf32_Word	Elf32_Hashelt;
48 
49 /* Non-standard class-dependent datatype used for abstraction. */
50 typedef Elf32_Word	Elf32_Size;
51 typedef Elf32_Sword	Elf32_Ssize;
52 
53 /*
54  * ELF header.
55  */
56 
57 typedef struct {
58 	unsigned char	e_ident[EI_NIDENT];	/* File identification. */
59 	Elf32_Half	e_type;		/* File type. */
60 	Elf32_Half	e_machine;	/* Machine architecture. */
61 	Elf32_Word	e_version;	/* ELF format version. */
62 	Elf32_Addr	e_entry;	/* Entry point. */
63 	Elf32_Off	e_phoff;	/* Program header file offset. */
64 	Elf32_Off	e_shoff;	/* Section header file offset. */
65 	Elf32_Word	e_flags;	/* Architecture-specific flags. */
66 	Elf32_Half	e_ehsize;	/* Size of ELF header in bytes. */
67 	Elf32_Half	e_phentsize;	/* Size of program header entry. */
68 	Elf32_Half	e_phnum;	/* Number of program header entries. */
69 	Elf32_Half	e_shentsize;	/* Size of section header entry. */
70 	Elf32_Half	e_shnum;	/* Number of section header entries. */
71 	Elf32_Half	e_shstrndx;	/* Section name strings section. */
72 } Elf32_Ehdr;
73 
74 /*
75  * Shared object information, found in SHT_MIPS_LIBLIST.
76  */
77 
78 typedef struct {
79 	Elf32_Word l_name;		/* The name of a shared object. */
80 	Elf32_Word l_time_stamp;	/* 32-bit timestamp. */
81 	Elf32_Word l_checksum;		/* Checksum of visible symbols, sizes. */
82 	Elf32_Word l_version;		/* Interface version string index. */
83 	Elf32_Word l_flags;		/* Flags (LL_*). */
84 } Elf32_Lib;
85 
86 /*
87  * Section header.
88  */
89 
90 typedef struct {
91 	Elf32_Word	sh_name;	/* Section name (index into the
92 					   section header string table). */
93 	Elf32_Word	sh_type;	/* Section type. */
94 	Elf32_Word	sh_flags;	/* Section flags. */
95 	Elf32_Addr	sh_addr;	/* Address in memory image. */
96 	Elf32_Off	sh_offset;	/* Offset in file. */
97 	Elf32_Word	sh_size;	/* Size in bytes. */
98 	Elf32_Word	sh_link;	/* Index of a related section. */
99 	Elf32_Word	sh_info;	/* Depends on section type. */
100 	Elf32_Word	sh_addralign;	/* Alignment in bytes. */
101 	Elf32_Word	sh_entsize;	/* Size of each entry in section. */
102 } Elf32_Shdr;
103 
104 /*
105  * Program header.
106  */
107 
108 typedef struct {
109 	Elf32_Word	p_type;		/* Entry type. */
110 	Elf32_Off	p_offset;	/* File offset of contents. */
111 	Elf32_Addr	p_vaddr;	/* Virtual address in memory image. */
112 	Elf32_Addr	p_paddr;	/* Physical address (not used). */
113 	Elf32_Word	p_filesz;	/* Size of contents in file. */
114 	Elf32_Word	p_memsz;	/* Size of contents in memory. */
115 	Elf32_Word	p_flags;	/* Access permission flags. */
116 	Elf32_Word	p_align;	/* Alignment in memory and file. */
117 } Elf32_Phdr;
118 
119 /*
120  * Dynamic structure.  The ".dynamic" section contains an array of them.
121  */
122 
123 typedef struct {
124 	Elf32_Sword	d_tag;		/* Entry type. */
125 	union {
126 		Elf32_Word	d_val;	/* Integer value. */
127 		Elf32_Addr	d_ptr;	/* Address value. */
128 	} d_un;
129 } Elf32_Dyn;
130 
131 /*
132  * Relocation entries.
133  */
134 
135 /* Relocations that don't need an addend field. */
136 typedef struct {
137 	Elf32_Addr	r_offset;	/* Location to be relocated. */
138 	Elf32_Word	r_info;		/* Relocation type and symbol index. */
139 } Elf32_Rel;
140 
141 /* Relocations that need an addend field. */
142 typedef struct {
143 	Elf32_Addr	r_offset;	/* Location to be relocated. */
144 	Elf32_Word	r_info;		/* Relocation type and symbol index. */
145 	Elf32_Sword	r_addend;	/* Addend. */
146 } Elf32_Rela;
147 
148 /* Macros for accessing the fields of r_info. */
149 #define ELF32_R_SYM(info)	((info) >> 8)
150 #define ELF32_R_TYPE(info)	((unsigned char)(info))
151 
152 /* Macro for constructing r_info from field values. */
153 #define ELF32_R_INFO(sym, type)	(((sym) << 8) + (unsigned char)(type))
154 
155 typedef Elf32_Word Elf32_Relr;
156 
157 /*
158  *	Note entry header
159  */
160 typedef Elf_Note Elf32_Nhdr;
161 
162 /*
163  *	Move entry
164  */
165 typedef struct {
166 	Elf32_Lword	m_value;	/* symbol value */
167 	Elf32_Word 	m_info;		/* size + index */
168 	Elf32_Word	m_poffset;	/* symbol offset */
169 	Elf32_Half	m_repeat;	/* repeat count */
170 	Elf32_Half	m_stride;	/* stride info */
171 } Elf32_Move;
172 
173 /*
174  *	The macros compose and decompose values for Move.r_info
175  *
176  *	sym = ELF32_M_SYM(M.m_info)
177  *	size = ELF32_M_SIZE(M.m_info)
178  *	M.m_info = ELF32_M_INFO(sym, size)
179  */
180 #define	ELF32_M_SYM(info)	((info)>>8)
181 #define	ELF32_M_SIZE(info)	((unsigned char)(info))
182 #define	ELF32_M_INFO(sym, size)	(((sym)<<8)+(unsigned char)(size))
183 
184 /*
185  *	Hardware/Software capabilities entry
186  */
187 typedef struct {
188 	Elf32_Word	c_tag;		/* how to interpret value */
189 	union {
190 		Elf32_Word	c_val;
191 		Elf32_Addr	c_ptr;
192 	} c_un;
193 } Elf32_Cap;
194 
195 /*
196  * Symbol table entries.
197  */
198 
199 typedef struct {
200 	Elf32_Word	st_name;	/* String table index of name. */
201 	Elf32_Addr	st_value;	/* Symbol value. */
202 	Elf32_Word	st_size;	/* Size of associated object. */
203 	unsigned char	st_info;	/* Type and binding information. */
204 	unsigned char	st_other;	/* Reserved (not used). */
205 	Elf32_Half	st_shndx;	/* Section index of symbol. */
206 } Elf32_Sym;
207 
208 /* Macros for accessing the fields of st_info. */
209 #define ELF32_ST_BIND(info)		((info) >> 4)
210 #define ELF32_ST_TYPE(info)		((info) & 0xf)
211 
212 /* Macro for constructing st_info from field values. */
213 #define ELF32_ST_INFO(bind, type)	(((bind) << 4) + ((type) & 0xf))
214 
215 /* Macro for accessing the fields of st_other. */
216 #define ELF32_ST_VISIBILITY(oth)	((oth) & 0x3)
217 
218 /* Structures used by Sun & GNU symbol versioning. */
219 typedef struct
220 {
221 	Elf32_Half	vd_version;
222 	Elf32_Half	vd_flags;
223 	Elf32_Half	vd_ndx;
224 	Elf32_Half	vd_cnt;
225 	Elf32_Word	vd_hash;
226 	Elf32_Word	vd_aux;
227 	Elf32_Word	vd_next;
228 } Elf32_Verdef;
229 
230 typedef struct
231 {
232 	Elf32_Word	vda_name;
233 	Elf32_Word	vda_next;
234 } Elf32_Verdaux;
235 
236 typedef struct
237 {
238 	Elf32_Half	vn_version;
239 	Elf32_Half	vn_cnt;
240 	Elf32_Word	vn_file;
241 	Elf32_Word	vn_aux;
242 	Elf32_Word	vn_next;
243 } Elf32_Verneed;
244 
245 typedef struct
246 {
247 	Elf32_Word	vna_hash;
248 	Elf32_Half	vna_flags;
249 	Elf32_Half	vna_other;
250 	Elf32_Word	vna_name;
251 	Elf32_Word	vna_next;
252 } Elf32_Vernaux;
253 
254 typedef Elf32_Half Elf32_Versym;
255 
256 typedef struct {
257 	Elf32_Half	si_boundto;	/* direct bindings - symbol bound to */
258 	Elf32_Half	si_flags;	/* per symbol flags */
259 } Elf32_Syminfo;
260 
261 typedef struct {
262 	Elf32_Word	ch_type;
263 	Elf32_Word	ch_size;
264 	Elf32_Word	ch_addralign;
265 } Elf32_Chdr;
266 
267 #endif /* !_SYS_ELF32_H_ */
268