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