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