617fe39a9fa3477dce55b86cd6da80b3b185f3e3
[dragonfly.git] / sys / 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: src/sys/sys/elf64.h,v 1.9 1999/08/28 00:51:42 peter Exp $
27  * $DragonFly: src/sys/sys/elf64.h,v 1.4 2006/05/20 02:42:13 dillon Exp $
28  */
29
30 #ifndef _SYS_ELF64_H_
31 #define _SYS_ELF64_H_ 1
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 u_int64_t       Elf64_Addr;
45 typedef u_int32_t       Elf64_Half;
46 typedef u_int64_t       Elf64_Off;
47 typedef int64_t         Elf64_Sword;
48 typedef u_int64_t       Elf64_Word;
49 typedef u_int64_t       Elf64_Size;
50 typedef u_int16_t       Elf64_Quarter;
51 typedef Elf64_Half      Elf64_Hashelt;
52
53 /*
54  * ELF header.
55  */
56
57 typedef struct {
58         unsigned char   e_ident[EI_NIDENT];     /* File identification. */
59         Elf64_Quarter   e_type;         /* File type. */
60         Elf64_Quarter   e_machine;      /* Machine architecture. */
61         Elf64_Half      e_version;      /* ELF format version. */
62         Elf64_Addr      e_entry;        /* Entry point. */
63         Elf64_Off       e_phoff;        /* Program header file offset. */
64         Elf64_Off       e_shoff;        /* Section header file offset. */
65         Elf64_Half      e_flags;        /* Architecture-specific flags. */
66         Elf64_Quarter   e_ehsize;       /* Size of ELF header in bytes. */
67         Elf64_Quarter   e_phentsize;    /* Size of program header entry. */
68         Elf64_Quarter   e_phnum;        /* Number of program header entries. */
69         Elf64_Quarter   e_shentsize;    /* Size of section header entry. */
70         Elf64_Quarter   e_shnum;        /* Number of section header entries. */
71         Elf64_Quarter   e_shstrndx;     /* Section name strings section. */
72 } Elf64_Ehdr;
73
74 /*
75  * Section header.
76  */
77
78 typedef struct {
79         Elf64_Half      sh_name;        /* Section name (index into the
80                                            section header string table). */
81         Elf64_Half      sh_type;        /* Section type. */
82         Elf64_Size      sh_flags;       /* Section flags. */
83         Elf64_Addr      sh_addr;        /* Address in memory image. */
84         Elf64_Off       sh_offset;      /* Offset in file. */
85         Elf64_Size      sh_size;        /* Size in bytes. */
86         Elf64_Half      sh_link;        /* Index of a related section. */
87         Elf64_Half      sh_info;        /* Depends on section type. */
88         Elf64_Size      sh_addralign;   /* Alignment in bytes. */
89         Elf64_Size      sh_entsize;     /* Size of each entry in section. */
90 } Elf64_Shdr;
91
92 /*
93  * Program header.
94  */
95
96 typedef struct {
97         Elf64_Half      p_type;         /* Entry type. */
98         Elf64_Half      p_flags;        /* Access permission flags. */
99         Elf64_Off       p_offset;       /* File offset of contents. */
100         Elf64_Addr      p_vaddr;        /* Virtual address in memory image. */
101         Elf64_Addr      p_paddr;        /* Physical address (not used). */
102         Elf64_Size      p_filesz;       /* Size of contents in file. */
103         Elf64_Size      p_memsz;        /* Size of contents in memory. */
104         Elf64_Size      p_align;        /* Alignment in memory and file. */
105 } Elf64_Phdr;
106
107 /*
108  * Dynamic structure.  The ".dynamic" section contains an array of them.
109  */
110
111 typedef struct {
112         Elf64_Size      d_tag;          /* Entry type. */
113         union {
114                 Elf64_Size      d_val;  /* Integer value. */
115                 Elf64_Addr      d_ptr;  /* Address value. */
116         } d_un;
117 } Elf64_Dyn;
118
119 /*
120  * Relocation entries.
121  */
122
123 /* Relocations that don't need an addend field. */
124 typedef struct {
125         Elf64_Addr      r_offset;       /* Location to be relocated. */
126         Elf64_Size      r_info;         /* Relocation type and symbol index. */
127 } Elf64_Rel;
128
129 /* Relocations that need an addend field. */
130 typedef struct {
131         Elf64_Addr      r_offset;       /* Location to be relocated. */
132         Elf64_Size      r_info;         /* Relocation type and symbol index. */
133         Elf64_Off       r_addend;       /* Addend. */
134 } Elf64_Rela;
135
136 /* Macros for accessing the fields of r_info. */
137 #define ELF64_R_SYM(info)       ((info) >> 32)
138 #define ELF64_R_TYPE(info)      ((unsigned char)(info))
139
140 /* Macro for constructing r_info from field values. */
141 #define ELF64_R_INFO(sym, type) (((sym) << 32) + (unsigned char)(type))
142
143 /*
144  * Symbol table entries.
145  */
146
147 typedef struct {
148         Elf64_Half      st_name;        /* String table index of name. */
149         unsigned char   st_info;        /* Type and binding information. */
150         unsigned char   st_other;       /* Reserved (not used). */
151         Elf64_Quarter   st_shndx;       /* Section index of symbol. */
152         Elf64_Addr      st_value;       /* Symbol value. */
153         Elf64_Size      st_size;        /* Size of associated object. */
154 } Elf64_Sym;
155
156 /* Macros for accessing the fields of st_info. */
157 #define ELF64_ST_BIND(info)             ((info) >> 4)
158 #define ELF64_ST_TYPE(info)             ((info) & 0xf)
159
160 /* Macro for constructing st_info from field values. */
161 #define ELF64_ST_INFO(bind, type)       (((bind) << 4) + ((type) & 0xf))
162
163 #endif /* !_SYS_ELF64_H_ */