sys/sys/elf32.h

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