sys/sys/elf64.h

/*-
 * Copyright (c) 1996-1998 John D. Polstra.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */

#ifndef _SYS_ELF64_H_
#define _SYS_ELF64_H_ 1

#include <sys/elf_common.h>

/*
 * ELF definitions common to all 64-bit architectures.
 */

typedef uint64_t        Elf64_Addr;
typedef uint16_t        Elf64_Half;
typedef uint64_t        Elf64_Off;
typedef int32_t         Elf64_Sword;
typedef int64_t         Elf64_Sxword;
typedef uint32_t        Elf64_Word;
typedef uint64_t        Elf64_Lword;
typedef uint64_t        Elf64_Xword;

/*
 * Types of dynamic symbol hash table bucket and chain elements.
 *
 * This is inconsistent among 64 bit architectures, so a machine dependent
 * typedef is required.
 */

typedef Elf64_Word      Elf64_Hashelt;

/* Non-standard class-dependent datatype used for abstraction. */
typedef Elf64_Xword     Elf64_Size;
typedef Elf64_Sxword    Elf64_Ssize;

/*
 * ELF header.
 */

typedef struct {
        unsigned char   e_ident[EI_NIDENT];     /* File identification. */
        Elf64_Half      e_type;         /* File type. */
        Elf64_Half      e_machine;      /* Machine architecture. */
        Elf64_Word      e_version;      /* ELF format version. */
        Elf64_Addr      e_entry;        /* Entry point. */
        Elf64_Off       e_phoff;        /* Program header file offset. */
        Elf64_Off       e_shoff;        /* Section header file offset. */
        Elf64_Word      e_flags;        /* Architecture-specific flags. */
        Elf64_Half      e_ehsize;       /* Size of ELF header in bytes. */
        Elf64_Half      e_phentsize;    /* Size of program header entry. */
        Elf64_Half      e_phnum;        /* Number of program header entries. */
        Elf64_Half      e_shentsize;    /* Size of section header entry. */
        Elf64_Half      e_shnum;        /* Number of section header entries. */
        Elf64_Half      e_shstrndx;     /* Section name strings section. */
} Elf64_Ehdr;

/*
 * Shared object information, found in SHT_MIPS_LIBLIST.
 */

typedef struct {
        Elf64_Word l_name;              /* The name of a shared object. */
        Elf64_Word l_time_stamp;        /* 64-bit timestamp. */
        Elf64_Word l_checksum;          /* Checksum of visible symbols, sizes. */
        Elf64_Word l_version;           /* Interface version string index. */
        Elf64_Word l_flags;             /* Flags (LL_*). */
} Elf64_Lib;

/*
 * Section header.
 */

typedef struct {
        Elf64_Word      sh_name;        /* Section name (index into the
                                           section header string table). */
        Elf64_Word      sh_type;        /* Section type. */
        Elf64_Xword     sh_flags;       /* Section flags. */
        Elf64_Addr      sh_addr;        /* Address in memory image. */
        Elf64_Off       sh_offset;      /* Offset in file. */
        Elf64_Xword     sh_size;        /* Size in bytes. */
        Elf64_Word      sh_link;        /* Index of a related section. */
        Elf64_Word      sh_info;        /* Depends on section type. */
        Elf64_Xword     sh_addralign;   /* Alignment in bytes. */
        Elf64_Xword     sh_entsize;     /* Size of each entry in section. */
} Elf64_Shdr;

/*
 * Program header.
 */

typedef struct {
        Elf64_Word      p_type;         /* Entry type. */
        Elf64_Word      p_flags;        /* Access permission flags. */
        Elf64_Off       p_offset;       /* File offset of contents. */
        Elf64_Addr      p_vaddr;        /* Virtual address in memory image. */
        Elf64_Addr      p_paddr;        /* Physical address (not used). */
        Elf64_Xword     p_filesz;       /* Size of contents in file. */
        Elf64_Xword     p_memsz;        /* Size of contents in memory. */
        Elf64_Xword     p_align;        /* Alignment in memory and file. */
} Elf64_Phdr;

/*
 * Dynamic structure.  The ".dynamic" section contains an array of them.
 */

typedef struct {
        Elf64_Sxword    d_tag;          /* Entry type. */
        union {
                Elf64_Xword     d_val;  /* Integer value. */
                Elf64_Addr      d_ptr;  /* Address value. */
        } d_un;
} Elf64_Dyn;

/*
 * Relocation entries.
 */

/* Relocations that don't need an addend field. */
typedef struct {
        Elf64_Addr      r_offset;       /* Location to be relocated. */
        Elf64_Xword     r_info;         /* Relocation type and symbol index. */
} Elf64_Rel;

/* Relocations that need an addend field. */
typedef struct {
        Elf64_Addr      r_offset;       /* Location to be relocated. */
        Elf64_Xword     r_info;         /* Relocation type and symbol index. */
        Elf64_Sxword    r_addend;       /* Addend. */
} Elf64_Rela;

/* Macros for accessing the fields of r_info. */
#define ELF64_R_SYM(info)       ((info) >> 32)
#define ELF64_R_TYPE(info)      ((info) & 0xffffffffL)

/* Macro for constructing r_info from field values. */
#define ELF64_R_INFO(sym, type) (((sym) << 32) + ((type) & 0xffffffffL))

#define ELF64_R_TYPE_DATA(info) (((Elf64_Xword)(info)<<32)>>40)
#define ELF64_R_TYPE_ID(info)   (((Elf64_Xword)(info)<<56)>>56)
#define ELF64_R_TYPE_INFO(data, type)   \
                                (((Elf64_Xword)(data)<<8)+(Elf64_Xword)(type))

/*
 *      Note entry header
 */
typedef Elf_Note Elf64_Nhdr;

/*
 *      Move entry
 */
typedef struct {
        Elf64_Lword     m_value;        /* symbol value */
        Elf64_Xword     m_info;         /* size + index */
        Elf64_Xword     m_poffset;      /* symbol offset */
        Elf64_Half      m_repeat;       /* repeat count */
        Elf64_Half      m_stride;       /* stride info */
} Elf64_Move;

#define ELF64_M_SYM(info)       ((info)>>8)
#define ELF64_M_SIZE(info)      ((unsigned char)(info))
#define ELF64_M_INFO(sym, size) (((sym)<<8)+(unsigned char)(size))

/*
 *      Hardware/Software capabilities entry
 */
typedef struct {
        Elf64_Xword     c_tag;          /* how to interpret value */
        union {
                Elf64_Xword     c_val;
                Elf64_Addr      c_ptr;
        } c_un;
} Elf64_Cap;

/*
 * Symbol table entries.
 */

typedef struct {
        Elf64_Word      st_name;        /* String table index of name. */
        unsigned char   st_info;        /* Type and binding information. */
        unsigned char   st_other;       /* Reserved (not used). */
        Elf64_Half      st_shndx;       /* Section index of symbol. */
        Elf64_Addr      st_value;       /* Symbol value. */
        Elf64_Xword     st_size;        /* Size of associated object. */
} Elf64_Sym;

/* Macros for accessing the fields of st_info. */
#define ELF64_ST_BIND(info)             ((info) >> 4)
#define ELF64_ST_TYPE(info)             ((info) & 0xf)

/* Macro for constructing st_info from field values. */
#define ELF64_ST_INFO(bind, type)       (((bind) << 4) + ((type) & 0xf))

/* Macro for accessing the fields of st_other. */
#define ELF64_ST_VISIBILITY(oth)        ((oth) & 0x3)

/* Structures used by Sun & GNU-style symbol versioning. */
typedef struct {
        Elf64_Half      vd_version;
        Elf64_Half      vd_flags;
        Elf64_Half      vd_ndx;
        Elf64_Half      vd_cnt;
        Elf64_Word      vd_hash;
        Elf64_Word      vd_aux;
        Elf64_Word      vd_next;
} Elf64_Verdef;

typedef struct {
        Elf64_Word      vda_name;
        Elf64_Word      vda_next;
} Elf64_Verdaux;

typedef struct {
        Elf64_Half      vn_version;
        Elf64_Half      vn_cnt;
        Elf64_Word      vn_file;
        Elf64_Word      vn_aux;
        Elf64_Word      vn_next;
} Elf64_Verneed;

typedef struct {
        Elf64_Word      vna_hash;
        Elf64_Half      vna_flags;
        Elf64_Half      vna_other;
        Elf64_Word      vna_name;
        Elf64_Word      vna_next;
} Elf64_Vernaux;

typedef Elf64_Half Elf64_Versym;

typedef struct {
        Elf64_Half      si_boundto;     /* direct bindings - symbol bound to */
        Elf64_Half      si_flags;       /* per symbol flags */
} Elf64_Syminfo;

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