BaseTools/Source/C/GenFw/elf32.h

   1 /** @file
   2 Ported ELF include files from FreeBSD
   3
   4 Copyright (c) 2009 - 2010, Apple Inc. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7
   8 **/
   9 /*-
  10  * Copyright (c) 1996-1998 John D. Polstra.
  11  * All rights reserved.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $FreeBSD: src/sys/sys/elf32.h,v 1.8.14.2 2007/12/03 21:30:36 marius Exp $
  35  */
  36
  37 #ifndef _SYS_ELF32_H_
  38 #define _SYS_ELF32_H_ 1
  39
  40
  41 /*
  42  * ELF definitions common to all 32-bit architectures.
  43  */
  44
  45 typedef UINT32  Elf32_Addr;
  46 typedef UINT16  Elf32_Half;
  47 typedef UINT32  Elf32_Off;
  48 typedef INT32    Elf32_Sword;
  49 typedef UINT32  Elf32_Word;
  50 typedef UINT64  Elf32_Lword;
  51
  52 typedef Elf32_Word  Elf32_Hashelt;
  53
  54 /* Non-standard class-dependent datatype used for abstraction. */
  55 typedef Elf32_Word  Elf32_Size;
  56 typedef Elf32_Sword  Elf32_Ssize;
  57
  58 /*
  59  * ELF header.
  60  */
  61
  62 typedef struct {
  63   unsigned char  e_ident[EI_NIDENT];  /* File identification. */
  64   Elf32_Half  e_type;    /* File type. */
  65   Elf32_Half  e_machine;  /* Machine architecture. */
  66   Elf32_Word  e_version;  /* ELF format version. */
  67   Elf32_Addr  e_entry;  /* Entry point. */
  68   Elf32_Off  e_phoff;  /* Program header file offset. */
  69   Elf32_Off  e_shoff;  /* Section header file offset. */
  70   Elf32_Word  e_flags;  /* Architecture-specific flags. */
  71   Elf32_Half  e_ehsize;  /* Size of ELF header in bytes. */
  72   Elf32_Half  e_phentsize;  /* Size of program header entry. */
  73   Elf32_Half  e_phnum;  /* Number of program header entries. */
  74   Elf32_Half  e_shentsize;  /* Size of section header entry. */
  75   Elf32_Half  e_shnum;  /* Number of section header entries. */
  76   Elf32_Half  e_shstrndx;  /* Section name strings section. */
  77 } Elf32_Ehdr;
  78
  79 /*
  80  * Section header.
  81  */
  82
  83 typedef struct {
  84   Elf32_Word  sh_name;  /* Section name (index into the
  85              section header string table). */
  86   Elf32_Word  sh_type;  /* Section type. */
  87   Elf32_Word  sh_flags;  /* Section flags. */
  88   Elf32_Addr  sh_addr;  /* Address in memory image. */
  89   Elf32_Off  sh_offset;  /* Offset in file. */
  90   Elf32_Word  sh_size;  /* Size in bytes. */
  91   Elf32_Word  sh_link;  /* Index of a related section. */
  92   Elf32_Word  sh_info;  /* Depends on section type. */
  93   Elf32_Word  sh_addralign;  /* Alignment in bytes. */
  94   Elf32_Word  sh_entsize;  /* Size of each entry in section. */
  95 } Elf32_Shdr;
  96
  97 /*
  98  * Program header.
  99  */
 100
 101 typedef struct {
 102   Elf32_Word  p_type;    /* Entry type. */
 103   Elf32_Off  p_offset;  /* File offset of contents. */
 104   Elf32_Addr  p_vaddr;  /* Virtual address in memory image. */
 105   Elf32_Addr  p_paddr;  /* Physical address (not used). */
 106   Elf32_Word  p_filesz;  /* Size of contents in file. */
 107   Elf32_Word  p_memsz;  /* Size of contents in memory. */
 108   Elf32_Word  p_flags;  /* Access permission flags. */
 109   Elf32_Word  p_align;  /* Alignment in memory and file. */
 110 } Elf32_Phdr;
 111
 112 /*
 113  * Dynamic structure.  The ".dynamic" section contains an array of them.
 114  */
 115
 116 typedef struct {
 117   Elf32_Sword  d_tag;    /* Entry type. */
 118   union {
 119     Elf32_Word  d_val;  /* Integer value. */
 120     Elf32_Addr  d_ptr;  /* Address value. */
 121   } d_un;
 122 } Elf32_Dyn;
 123
 124 /*
 125  * Relocation entries.
 126  */
 127
 128 /* Relocations that don't need an addend field. */
 129 typedef struct {
 130   Elf32_Addr  r_offset;  /* Location to be relocated. */
 131   Elf32_Word  r_info;    /* Relocation type and symbol index. */
 132 } Elf32_Rel;
 133
 134 /* Relocations that need an addend field. */
 135 typedef struct {
 136   Elf32_Addr  r_offset;  /* Location to be relocated. */
 137   Elf32_Word  r_info;    /* Relocation type and symbol index. */
 138   Elf32_Sword  r_addend;  /* Addend. */
 139 } Elf32_Rela;
 140
 141 /* Macros for accessing the fields of r_info. */
 142 #define ELF32_R_SYM(info)  ((info) >> 8)
 143 #define ELF32_R_TYPE(info)  ((unsigned char)(info))
 144
 145 /* Macro for constructing r_info from field values. */
 146 #define ELF32_R_INFO(sym, type)  (((sym) << 8) + (unsigned char)(type))
 147
 148 /*
 149  *  Note entry header
 150  */
 151 typedef Elf_Note Elf32_Nhdr;
 152
 153 /*
 154  *  Move entry
 155  */
 156 typedef struct {
 157   Elf32_Lword  m_value;  /* symbol value */
 158   Elf32_Word   m_info;    /* size + index */
 159   Elf32_Word  m_poffset;  /* symbol offset */
 160   Elf32_Half  m_repeat;  /* repeat count */
 161   Elf32_Half  m_stride;  /* stride info */
 162 } Elf32_Move;
 163
 164 /*
 165  *  The macros compose and decompose values for Move.r_info
 166  *
 167  *  sym = ELF32_M_SYM(M.m_info)
 168  *  size = ELF32_M_SIZE(M.m_info)
 169  *  M.m_info = ELF32_M_INFO(sym, size)
 170  */
 171 #define  ELF32_M_SYM(info)  ((info)>>8)
 172 #define  ELF32_M_SIZE(info)  ((unsigned char)(info))
 173 #define  ELF32_M_INFO(sym, size)  (((sym)<<8)+(unsigned char)(size))
 174
 175 /*
 176  *  Hardware/Software capabilities entry
 177  */
 178 typedef struct {
 179   Elf32_Word  c_tag;    /* how to interpret value */
 180   union {
 181     Elf32_Word  c_val;
 182     Elf32_Addr  c_ptr;
 183   } c_un;
 184 } Elf32_Cap;
 185
 186 /*
 187  * Symbol table entries.
 188  */
 189
 190 typedef struct {
 191   Elf32_Word  st_name;  /* String table index of name. */
 192   Elf32_Addr  st_value;  /* Symbol value. */
 193   Elf32_Word  st_size;  /* Size of associated object. */
 194   unsigned char  st_info;  /* Type and binding information. */
 195   unsigned char  st_other;  /* Reserved (not used). */
 196   Elf32_Half  st_shndx;  /* Section index of symbol. */
 197 } Elf32_Sym;
 198
 199 /* Macros for accessing the fields of st_info. */
 200 #define ELF32_ST_BIND(info)    ((info) >> 4)
 201 #define ELF32_ST_TYPE(info)    ((info) & 0xf)
 202
 203 /* Macro for constructing st_info from field values. */
 204 #define ELF32_ST_INFO(bind, type)  (((bind) << 4) + ((type) & 0xf))
 205
 206 /* Macro for accessing the fields of st_other. */
 207 #define ELF32_ST_VISIBILITY(oth)  ((oth) & 0x3)
 208
 209 /* Structures used by Sun & GNU symbol versioning. */
 210 typedef struct
 211 {
 212   Elf32_Half  vd_version;
 213   Elf32_Half  vd_flags;
 214   Elf32_Half  vd_ndx;
 215   Elf32_Half  vd_cnt;
 216   Elf32_Word  vd_hash;
 217   Elf32_Word  vd_aux;
 218   Elf32_Word  vd_next;
 219 } Elf32_Verdef;
 220
 221 typedef struct
 222 {
 223   Elf32_Word  vda_name;
 224   Elf32_Word  vda_next;
 225 } Elf32_Verdaux;
 226
 227 typedef struct
 228 {
 229   Elf32_Half  vn_version;
 230   Elf32_Half  vn_cnt;
 231   Elf32_Word  vn_file;
 232   Elf32_Word  vn_aux;
 233   Elf32_Word  vn_next;
 234 } Elf32_Verneed;
 235
 236 typedef struct
 237 {
 238   Elf32_Word  vna_hash;
 239   Elf32_Half  vna_flags;
 240   Elf32_Half  vna_other;
 241   Elf32_Word  vna_name;
 242   Elf32_Word  vna_next;
 243 } Elf32_Vernaux;
 244
 245 typedef Elf32_Half Elf32_Versym;
 246
 247 typedef struct {
 248   Elf32_Half  si_boundto;  /* direct bindings - symbol bound to */
 249   Elf32_Half  si_flags;  /* per symbol flags */
 250 } Elf32_Syminfo;
 251
 252 #endif /* !_SYS_ELF32_H_ */