Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / sys / elf32.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/elf32.h,v 1.7 1999/08/28 00:51:41 peter Exp $
27  */
28
29 #ifndef _SYS_ELF32_H_
30 #define _SYS_ELF32_H_ 1
31
32 #include <sys/elf_common.h>
33
34 /*
35  * ELF definitions common to all 32-bit architectures.
36  */
37
38 typedef u_int32_t       Elf32_Addr;
39 typedef u_int16_t       Elf32_Half;
40 typedef u_int32_t       Elf32_Off;
41 typedef int32_t         Elf32_Sword;
42 typedef u_int32_t       Elf32_Word;
43 typedef u_int32_t       Elf32_Size;
44
45 /*
46  * ELF header.
47  */
48
49 typedef struct {
50         unsigned char   e_ident[EI_NIDENT];     /* File identification. */
51         Elf32_Half      e_type;         /* File type. */
52         Elf32_Half      e_machine;      /* Machine architecture. */
53         Elf32_Word      e_version;      /* ELF format version. */
54         Elf32_Addr      e_entry;        /* Entry point. */
55         Elf32_Off       e_phoff;        /* Program header file offset. */
56         Elf32_Off       e_shoff;        /* Section header file offset. */
57         Elf32_Word      e_flags;        /* Architecture-specific flags. */
58         Elf32_Half      e_ehsize;       /* Size of ELF header in bytes. */
59         Elf32_Half      e_phentsize;    /* Size of program header entry. */
60         Elf32_Half      e_phnum;        /* Number of program header entries. */
61         Elf32_Half      e_shentsize;    /* Size of section header entry. */
62         Elf32_Half      e_shnum;        /* Number of section header entries. */
63         Elf32_Half      e_shstrndx;     /* Section name strings section. */
64 } Elf32_Ehdr;
65
66 /*
67  * Section header.
68  */
69
70 typedef struct {
71         Elf32_Word      sh_name;        /* Section name (index into the
72                                            section header string table). */
73         Elf32_Word      sh_type;        /* Section type. */
74         Elf32_Word      sh_flags;       /* Section flags. */
75         Elf32_Addr      sh_addr;        /* Address in memory image. */
76         Elf32_Off       sh_offset;      /* Offset in file. */
77         Elf32_Size      sh_size;        /* Size in bytes. */
78         Elf32_Word      sh_link;        /* Index of a related section. */
79         Elf32_Word      sh_info;        /* Depends on section type. */
80         Elf32_Size      sh_addralign;   /* Alignment in bytes. */
81         Elf32_Size      sh_entsize;     /* Size of each entry in section. */
82 } Elf32_Shdr;
83
84 /*
85  * Program header.
86  */
87
88 typedef struct {
89         Elf32_Word      p_type;         /* Entry type. */
90         Elf32_Off       p_offset;       /* File offset of contents. */
91         Elf32_Addr      p_vaddr;        /* Virtual address in memory image. */
92         Elf32_Addr      p_paddr;        /* Physical address (not used). */
93         Elf32_Size      p_filesz;       /* Size of contents in file. */
94         Elf32_Size      p_memsz;        /* Size of contents in memory. */
95         Elf32_Word      p_flags;        /* Access permission flags. */
96         Elf32_Size      p_align;        /* Alignment in memory and file. */
97 } Elf32_Phdr;
98
99 /*
100  * Dynamic structure.  The ".dynamic" section contains an array of them.
101  */
102
103 typedef struct {
104         Elf32_Sword     d_tag;          /* Entry type. */
105         union {
106                 Elf32_Size      d_val;  /* Integer value. */
107                 Elf32_Addr      d_ptr;  /* Address value. */
108         } d_un;
109 } Elf32_Dyn;
110
111 /*
112  * Relocation entries.
113  */
114
115 /* Relocations that don't need an addend field. */
116 typedef struct {
117         Elf32_Addr      r_offset;       /* Location to be relocated. */
118         Elf32_Word      r_info;         /* Relocation type and symbol index. */
119 } Elf32_Rel;
120
121 /* Relocations that need an addend field. */
122 typedef struct {
123         Elf32_Addr      r_offset;       /* Location to be relocated. */
124         Elf32_Word      r_info;         /* Relocation type and symbol index. */
125         Elf32_Sword     r_addend;       /* Addend. */
126 } Elf32_Rela;
127
128 /* Macros for accessing the fields of r_info. */
129 #define ELF32_R_SYM(info)       ((info) >> 8)
130 #define ELF32_R_TYPE(info)      ((unsigned char)(info))
131
132 /* Macro for constructing r_info from field values. */
133 #define ELF32_R_INFO(sym, type) (((sym) << 8) + (unsigned char)(type))
134
135 /*
136  * Symbol table entries.
137  */
138
139 typedef struct {
140         Elf32_Word      st_name;        /* String table index of name. */
141         Elf32_Addr      st_value;       /* Symbol value. */
142         Elf32_Size      st_size;        /* Size of associated object. */
143         unsigned char   st_info;        /* Type and binding information. */
144         unsigned char   st_other;       /* Reserved (not used). */
145         Elf32_Half      st_shndx;       /* Section index of symbol. */
146 } Elf32_Sym;
147
148 /* Macros for accessing the fields of st_info. */
149 #define ELF32_ST_BIND(info)             ((info) >> 4)
150 #define ELF32_ST_TYPE(info)             ((info) & 0xf)
151
152 /* Macro for constructing st_info from field values. */
153 #define ELF32_ST_INFO(bind, type)       (((bind) << 4) + ((type) & 0xf))
154
155 #endif /* !_SYS_ELF32_H_ */