xref: /dragonfly/sys/sys/elf64.h (revision f746689a)
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: src/sys/sys/elf64.h,v 1.17 2006/10/17 05:43:30 jkoshy Exp $
27  * $DragonFly: src/sys/sys/elf64.h,v 1.10 2008/08/30 17:07:17 swildner Exp $
28  */
29 
30 #ifndef _SYS_ELF64_H_
31 #define _SYS_ELF64_H_
32 
33 #ifndef _SYS_TYPES_H_
34 #include <sys/types.h>
35 #endif
36 #ifndef _SYS_ELF_COMMON_H_
37 #include <sys/elf_common.h>
38 #endif
39 
40 /*
41  * ELF definitions common to all 64-bit architectures.
42  */
43 
44 typedef uint64_t	Elf64_Addr;
45 typedef uint16_t	Elf64_Half;
46 typedef uint64_t	Elf64_Off;
47 typedef int32_t		Elf64_Sword;
48 typedef int64_t		Elf64_Sxword;
49 typedef uint32_t	Elf64_Word;
50 typedef uint64_t	Elf64_Lword;
51 typedef uint64_t	Elf64_Xword;
52 
53 /*
54  * Types of dynamic symbol hash table bucket and chain elements.
55  *
56  * This is inconsistent among 64 bit architectures, so a machine dependent
57  * typedef is required.
58  */
59 
60 typedef Elf64_Word	Elf64_Hashelt;
61 
62 /* Non-standard class-dependent datatype used for abstraction. */
63 typedef Elf64_Xword	Elf64_Size;
64 typedef Elf64_Sxword	Elf64_Ssize;
65 
66 /*
67  * ELF header.
68  */
69 
70 typedef struct {
71 	unsigned char	e_ident[EI_NIDENT];	/* File identification. */
72 	Elf64_Half	e_type;		/* File type. */
73 	Elf64_Half	e_machine;	/* Machine architecture. */
74 	Elf64_Word	e_version;	/* ELF format version. */
75 	Elf64_Addr	e_entry;	/* Entry point. */
76 	Elf64_Off	e_phoff;	/* Program header file offset. */
77 	Elf64_Off	e_shoff;	/* Section header file offset. */
78 	Elf64_Word	e_flags;	/* Architecture-specific flags. */
79 	Elf64_Half	e_ehsize;	/* Size of ELF header in bytes. */
80 	Elf64_Half	e_phentsize;	/* Size of program header entry. */
81 	Elf64_Half	e_phnum;	/* Number of program header entries. */
82 	Elf64_Half	e_shentsize;	/* Size of section header entry. */
83 	Elf64_Half	e_shnum;	/* Number of section header entries. */
84 	Elf64_Half	e_shstrndx;	/* Section name strings section. */
85 } Elf64_Ehdr;
86 
87 /*
88  * Section header.
89  */
90 
91 typedef struct {
92 	Elf64_Word	sh_name;	/* Section name (index into the
93 					   section header string table). */
94 	Elf64_Word	sh_type;	/* Section type. */
95 	Elf64_Xword	sh_flags;	/* Section flags. */
96 	Elf64_Addr	sh_addr;	/* Address in memory image. */
97 	Elf64_Off	sh_offset;	/* Offset in file. */
98 	Elf64_Xword	sh_size;	/* Size in bytes. */
99 	Elf64_Word	sh_link;	/* Index of a related section. */
100 	Elf64_Word	sh_info;	/* Depends on section type. */
101 	Elf64_Xword	sh_addralign;	/* Alignment in bytes. */
102 	Elf64_Xword	sh_entsize;	/* Size of each entry in section. */
103 } Elf64_Shdr;
104 
105 /*
106  * Program header.
107  */
108 
109 typedef struct {
110 	Elf64_Word	p_type;		/* Entry type. */
111 	Elf64_Word	p_flags;	/* Access permission flags. */
112 	Elf64_Off	p_offset;	/* File offset of contents. */
113 	Elf64_Addr	p_vaddr;	/* Virtual address in memory image. */
114 	Elf64_Addr	p_paddr;	/* Physical address (not used). */
115 	Elf64_Xword	p_filesz;	/* Size of contents in file. */
116 	Elf64_Xword	p_memsz;	/* Size of contents in memory. */
117 	Elf64_Xword	p_align;	/* Alignment in memory and file. */
118 } Elf64_Phdr;
119 
120 /*
121  * Dynamic structure.  The ".dynamic" section contains an array of them.
122  */
123 
124 typedef struct {
125 	Elf64_Sxword	d_tag;		/* Entry type. */
126 	union {
127 		Elf64_Xword	d_val;	/* Integer value. */
128 		Elf64_Addr	d_ptr;	/* Address value. */
129 	} d_un;
130 } Elf64_Dyn;
131 
132 /*
133  * Relocation entries.
134  */
135 
136 /* Relocations that don't need an addend field. */
137 typedef struct {
138 	Elf64_Addr	r_offset;	/* Location to be relocated. */
139 	Elf64_Xword	r_info;		/* Relocation type and symbol index. */
140 } Elf64_Rel;
141 
142 /* Relocations that need an addend field. */
143 typedef struct {
144 	Elf64_Addr	r_offset;	/* Location to be relocated. */
145 	Elf64_Xword	r_info;		/* Relocation type and symbol index. */
146 	Elf64_Sxword	r_addend;	/* Addend. */
147 } Elf64_Rela;
148 
149 /* Macros for accessing the fields of r_info. */
150 #define ELF64_R_SYM(info)	((info) >> 32)
151 #define ELF64_R_TYPE(info)	((info) & 0xffffffffL)
152 
153 /* Macro for constructing r_info from field values. */
154 #define ELF64_R_INFO(sym, type)	(((sym) << 32) + ((type) & 0xffffffffL))
155 
156 #define	ELF64_R_TYPE_DATA(info)	(((Elf64_Xword)(info)<<32)>>40)
157 #define	ELF64_R_TYPE_ID(info)	(((Elf64_Xword)(info)<<56)>>56)
158 #define	ELF64_R_TYPE_INFO(data, type)	\
159 		(((Elf64_Xword)(data)<<8)+(Elf64_Xword)(type))
160 
161 /*
162  * Note entry header
163  */
164 typedef Elf_Note Elf64_Nhdr;
165 
166 /*
167  * Move entry
168  */
169 typedef struct {
170 	Elf64_Lword	m_value;	/* symbol value */
171 	Elf64_Xword	m_info;		/* size + index */
172 	Elf64_Xword	m_poffset;	/* symbol offset */
173 	Elf64_Half	m_repeat;	/* repeat count */
174 	Elf64_Half	m_stride;	/* stride info */
175 } Elf64_Move;
176 
177 #define	ELF64_M_SYM(info)	((info)>>8)
178 #define	ELF64_M_SIZE(info)	((unsigned char)(info))
179 #define	ELF64_M_INFO(sym, size)	(((sym)<<8)+(unsigned char)(size))
180 
181 /*
182  * Hardware/Software capabilities entry
183  */
184 typedef struct {
185 	Elf64_Xword	c_tag;		/* how to interpret value */
186 	union {
187 		Elf64_Xword	c_val;
188 		Elf64_Addr	c_ptr;
189 	} c_un;
190 } Elf64_Cap;
191 
192 /*
193  * Symbol table entries.
194  */
195 
196 typedef struct {
197 	Elf64_Word	st_name;	/* String table index of name. */
198 	unsigned char	st_info;	/* Type and binding information. */
199 	unsigned char	st_other;	/* Reserved (not used). */
200 	Elf64_Half	st_shndx;	/* Section index of symbol. */
201 	Elf64_Addr	st_value;	/* Symbol value. */
202 	Elf64_Xword	st_size;	/* Size of associated object. */
203 } Elf64_Sym;
204 
205 /* Macros for accessing the fields of st_info. */
206 #define ELF64_ST_BIND(info)		((info) >> 4)
207 #define ELF64_ST_TYPE(info)		((info) & 0xf)
208 
209 /* Macro for constructing st_info from field values. */
210 #define ELF64_ST_INFO(bind, type)	(((bind) << 4) + ((type) & 0xf))
211 
212 /* Macro for accessing the fields of st_other. */
213 #define ELF64_ST_VISIBILITY(oth)	((oth) & 0x3)
214 
215 /* Structures used by Sun & GNU-style symbol versioning. */
216 typedef struct {
217 	Elf64_Half	vd_version;
218 	Elf64_Half	vd_flags;
219 	Elf64_Half	vd_ndx;
220 	Elf64_Half	vd_cnt;
221 	Elf64_Word	vd_hash;
222 	Elf64_Word	vd_aux;
223 	Elf64_Word	vd_next;
224 } Elf64_Verdef;
225 
226 typedef struct {
227 	Elf64_Word	vda_name;
228 	Elf64_Word	vda_next;
229 } Elf64_Verdaux;
230 
231 typedef struct {
232 	Elf64_Half	vn_version;
233 	Elf64_Half	vn_cnt;
234 	Elf64_Word	vn_file;
235 	Elf64_Word	vn_aux;
236 	Elf64_Word	vn_next;
237 } Elf64_Verneed;
238 
239 typedef struct {
240 	Elf64_Word	vna_hash;
241 	Elf64_Half	vna_flags;
242 	Elf64_Half	vna_other;
243 	Elf64_Word	vna_name;
244 	Elf64_Word	vna_next;
245 } Elf64_Vernaux;
246 
247 typedef Elf64_Half Elf64_Versym;
248 
249 typedef struct {
250 	Elf64_Half	si_boundto;	/* direct bindings - symbol bound to */
251 	Elf64_Half	si_flags;	/* per symbol flags */
252 } Elf64_Syminfo;
253 
254 #endif /* !_SYS_ELF64_H_ */
255