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