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