BaseTools/Source/C/GenFw/elf64.h

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