]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/C/GenFw/elf32.h
Sync BaseTool trunk (version r2649) into EDKII BaseTools.
[mirror_edk2.git] / BaseTools / Source / C / GenFw / elf32.h
index 63946aad841adeeacd8af6b2b91d9ce0654fb352..dd4e1325986be88520c6def8834d4d6fd3dd06cf 100644 (file)
-/** @file
-Ported ELF include files from FreeBSD
-
-Copyright (c) 2009 - 2010, Apple Inc. All rights reserved.<BR>
-This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution.  The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-
-**/
-/*-
- * Copyright (c) 1996-1998 John D. Polstra.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- *
- * $FreeBSD: src/sys/sys/elf32.h,v 1.8.14.2 2007/12/03 21:30:36 marius Exp $
- */
-
-#ifndef _SYS_ELF32_H_
-#define _SYS_ELF32_H_ 1
-
-
-/*
- * ELF definitions common to all 32-bit architectures.
- */
-
-typedef UINT32 Elf32_Addr;
-typedef UINT16 Elf32_Half;
-typedef UINT32 Elf32_Off;
-typedef INT32          Elf32_Sword;
-typedef UINT32 Elf32_Word;
-typedef UINT64 Elf32_Lword;
-
-typedef Elf32_Word     Elf32_Hashelt;
-
-/* Non-standard class-dependent datatype used for abstraction. */
-typedef Elf32_Word     Elf32_Size;
-typedef Elf32_Sword    Elf32_Ssize;
-
-/*
- * ELF header.
- */
-
-typedef struct {
-       unsigned char   e_ident[EI_NIDENT];     /* File identification. */
-       Elf32_Half      e_type;         /* File type. */
-       Elf32_Half      e_machine;      /* Machine architecture. */
-       Elf32_Word      e_version;      /* ELF format version. */
-       Elf32_Addr      e_entry;        /* Entry point. */
-       Elf32_Off       e_phoff;        /* Program header file offset. */
-       Elf32_Off       e_shoff;        /* Section header file offset. */
-       Elf32_Word      e_flags;        /* Architecture-specific flags. */
-       Elf32_Half      e_ehsize;       /* Size of ELF header in bytes. */
-       Elf32_Half      e_phentsize;    /* Size of program header entry. */
-       Elf32_Half      e_phnum;        /* Number of program header entries. */
-       Elf32_Half      e_shentsize;    /* Size of section header entry. */
-       Elf32_Half      e_shnum;        /* Number of section header entries. */
-       Elf32_Half      e_shstrndx;     /* Section name strings section. */
-} Elf32_Ehdr;
-
-/*
- * Section header.
- */
-
-typedef struct {
-       Elf32_Word      sh_name;        /* Section name (index into the
-                                          section header string table). */
-       Elf32_Word      sh_type;        /* Section type. */
-       Elf32_Word      sh_flags;       /* Section flags. */
-       Elf32_Addr      sh_addr;        /* Address in memory image. */
-       Elf32_Off       sh_offset;      /* Offset in file. */
-       Elf32_Word      sh_size;        /* Size in bytes. */
-       Elf32_Word      sh_link;        /* Index of a related section. */
-       Elf32_Word      sh_info;        /* Depends on section type. */
-       Elf32_Word      sh_addralign;   /* Alignment in bytes. */
-       Elf32_Word      sh_entsize;     /* Size of each entry in section. */
-} Elf32_Shdr;
-
-/*
- * Program header.
- */
-
-typedef struct {
-       Elf32_Word      p_type;         /* Entry type. */
-       Elf32_Off       p_offset;       /* File offset of contents. */
-       Elf32_Addr      p_vaddr;        /* Virtual address in memory image. */
-       Elf32_Addr      p_paddr;        /* Physical address (not used). */
-       Elf32_Word      p_filesz;       /* Size of contents in file. */
-       Elf32_Word      p_memsz;        /* Size of contents in memory. */
-       Elf32_Word      p_flags;        /* Access permission flags. */
-       Elf32_Word      p_align;        /* Alignment in memory and file. */
-} Elf32_Phdr;
-
-/*
- * Dynamic structure.  The ".dynamic" section contains an array of them.
- */
-
-typedef struct {
-       Elf32_Sword     d_tag;          /* Entry type. */
-       union {
-               Elf32_Word      d_val;  /* Integer value. */
-               Elf32_Addr      d_ptr;  /* Address value. */
-       } d_un;
-} Elf32_Dyn;
-
-/*
- * Relocation entries.
- */
-
-/* Relocations that don't need an addend field. */
-typedef struct {
-       Elf32_Addr      r_offset;       /* Location to be relocated. */
-       Elf32_Word      r_info;         /* Relocation type and symbol index. */
-} Elf32_Rel;
-
-/* Relocations that need an addend field. */
-typedef struct {
-       Elf32_Addr      r_offset;       /* Location to be relocated. */
-       Elf32_Word      r_info;         /* Relocation type and symbol index. */
-       Elf32_Sword     r_addend;       /* Addend. */
-} Elf32_Rela;
-
-/* Macros for accessing the fields of r_info. */
-#define ELF32_R_SYM(info)      ((info) >> 8)
-#define ELF32_R_TYPE(info)     ((unsigned char)(info))
-
-/* Macro for constructing r_info from field values. */
-#define ELF32_R_INFO(sym, type)        (((sym) << 8) + (unsigned char)(type))
-
-/*
- *     Note entry header
- */
-typedef Elf_Note Elf32_Nhdr;
-
-/*
- *     Move entry
- */
-typedef struct {
-       Elf32_Lword     m_value;        /* symbol value */
-       Elf32_Word      m_info;         /* size + index */
-       Elf32_Word      m_poffset;      /* symbol offset */
-       Elf32_Half      m_repeat;       /* repeat count */
-       Elf32_Half      m_stride;       /* stride info */
-} Elf32_Move;
-
-/*
- *     The macros compose and decompose values for Move.r_info
- *
- *     sym = ELF32_M_SYM(M.m_info)
- *     size = ELF32_M_SIZE(M.m_info)
- *     M.m_info = ELF32_M_INFO(sym, size)
- */
-#define        ELF32_M_SYM(info)       ((info)>>8)
-#define        ELF32_M_SIZE(info)      ((unsigned char)(info))
-#define        ELF32_M_INFO(sym, size) (((sym)<<8)+(unsigned char)(size))
-
-/*
- *     Hardware/Software capabilities entry
- */
-typedef struct {
-       Elf32_Word      c_tag;          /* how to interpret value */
-       union {
-               Elf32_Word      c_val;
-               Elf32_Addr      c_ptr;
-       } c_un;
-} Elf32_Cap;
-
-/*
- * Symbol table entries.
- */
-
-typedef struct {
-       Elf32_Word      st_name;        /* String table index of name. */
-       Elf32_Addr      st_value;       /* Symbol value. */
-       Elf32_Word      st_size;        /* Size of associated object. */
-       unsigned char   st_info;        /* Type and binding information. */
-       unsigned char   st_other;       /* Reserved (not used). */
-       Elf32_Half      st_shndx;       /* Section index of symbol. */
-} Elf32_Sym;
-
-/* Macros for accessing the fields of st_info. */
-#define ELF32_ST_BIND(info)            ((info) >> 4)
-#define ELF32_ST_TYPE(info)            ((info) & 0xf)
-
-/* Macro for constructing st_info from field values. */
-#define ELF32_ST_INFO(bind, type)      (((bind) << 4) + ((type) & 0xf))
-
-/* Macro for accessing the fields of st_other. */
-#define ELF32_ST_VISIBILITY(oth)       ((oth) & 0x3)
-
-/* Structures used by Sun & GNU symbol versioning. */
-typedef struct
-{
-       Elf32_Half      vd_version;
-       Elf32_Half      vd_flags;
-       Elf32_Half      vd_ndx;
-       Elf32_Half      vd_cnt;
-       Elf32_Word      vd_hash;
-       Elf32_Word      vd_aux;
-       Elf32_Word      vd_next;
-} Elf32_Verdef;
-
-typedef struct
-{
-       Elf32_Word      vda_name;
-       Elf32_Word      vda_next;
-} Elf32_Verdaux;
-
-typedef struct
-{
-       Elf32_Half      vn_version;
-       Elf32_Half      vn_cnt;
-       Elf32_Word      vn_file;
-       Elf32_Word      vn_aux;
-       Elf32_Word      vn_next;
-} Elf32_Verneed;
-
-typedef struct
-{
-       Elf32_Word      vna_hash;
-       Elf32_Half      vna_flags;
-       Elf32_Half      vna_other;
-       Elf32_Word      vna_name;
-       Elf32_Word      vna_next;
-} Elf32_Vernaux;
-
-typedef Elf32_Half Elf32_Versym;
-
-typedef struct {
-       Elf32_Half      si_boundto;     /* direct bindings - symbol bound to */
-       Elf32_Half      si_flags;       /* per symbol flags */
-} Elf32_Syminfo;
-
-#endif /* !_SYS_ELF32_H_ */
+/** @file\r
+Ported ELF include files from FreeBSD\r
+\r
+Copyright (c) 2009 - 2010, Apple Inc. All rights reserved.<BR>\r
+This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+\r
+**/\r
+/*-\r
+ * Copyright (c) 1996-1998 John D. Polstra.\r
+ * All rights reserved.\r
+ *\r
+ * Redistribution and use in source and binary forms, with or without\r
+ * modification, are permitted provided that the following conditions\r
+ * are met:\r
+ * 1. Redistributions of source code must retain the above copyright\r
+ *    notice, this list of conditions and the following disclaimer.\r
+ * 2. Redistributions in binary form must reproduce the above copyright\r
+ *    notice, this list of conditions and the following disclaimer in the\r
+ *    documentation and/or other materials provided with the distribution.\r
+ *\r
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND\r
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE\r
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
+ * SUCH DAMAGE.\r
+ *\r
+ * $FreeBSD: src/sys/sys/elf32.h,v 1.8.14.2 2007/12/03 21:30:36 marius Exp $\r
+ */\r
+\r
+#ifndef _SYS_ELF32_H_\r
+#define _SYS_ELF32_H_ 1\r
+\r
+\r
+/*\r
+ * ELF definitions common to all 32-bit architectures.\r
+ */\r
+\r
+typedef UINT32 Elf32_Addr;\r
+typedef UINT16 Elf32_Half;\r
+typedef UINT32 Elf32_Off;\r
+typedef INT32          Elf32_Sword;\r
+typedef UINT32 Elf32_Word;\r
+typedef UINT64 Elf32_Lword;\r
+\r
+typedef Elf32_Word     Elf32_Hashelt;\r
+\r
+/* Non-standard class-dependent datatype used for abstraction. */\r
+typedef Elf32_Word     Elf32_Size;\r
+typedef Elf32_Sword    Elf32_Ssize;\r
+\r
+/*\r
+ * ELF header.\r
+ */\r
+\r
+typedef struct {\r
+       unsigned char   e_ident[EI_NIDENT];     /* File identification. */\r
+       Elf32_Half      e_type;         /* File type. */\r
+       Elf32_Half      e_machine;      /* Machine architecture. */\r
+       Elf32_Word      e_version;      /* ELF format version. */\r
+       Elf32_Addr      e_entry;        /* Entry point. */\r
+       Elf32_Off       e_phoff;        /* Program header file offset. */\r
+       Elf32_Off       e_shoff;        /* Section header file offset. */\r
+       Elf32_Word      e_flags;        /* Architecture-specific flags. */\r
+       Elf32_Half      e_ehsize;       /* Size of ELF header in bytes. */\r
+       Elf32_Half      e_phentsize;    /* Size of program header entry. */\r
+       Elf32_Half      e_phnum;        /* Number of program header entries. */\r
+       Elf32_Half      e_shentsize;    /* Size of section header entry. */\r
+       Elf32_Half      e_shnum;        /* Number of section header entries. */\r
+       Elf32_Half      e_shstrndx;     /* Section name strings section. */\r
+} Elf32_Ehdr;\r
+\r
+/*\r
+ * Section header.\r
+ */\r
+\r
+typedef struct {\r
+       Elf32_Word      sh_name;        /* Section name (index into the\r
+                                          section header string table). */\r
+       Elf32_Word      sh_type;        /* Section type. */\r
+       Elf32_Word      sh_flags;       /* Section flags. */\r
+       Elf32_Addr      sh_addr;        /* Address in memory image. */\r
+       Elf32_Off       sh_offset;      /* Offset in file. */\r
+       Elf32_Word      sh_size;        /* Size in bytes. */\r
+       Elf32_Word      sh_link;        /* Index of a related section. */\r
+       Elf32_Word      sh_info;        /* Depends on section type. */\r
+       Elf32_Word      sh_addralign;   /* Alignment in bytes. */\r
+       Elf32_Word      sh_entsize;     /* Size of each entry in section. */\r
+} Elf32_Shdr;\r
+\r
+/*\r
+ * Program header.\r
+ */\r
+\r
+typedef struct {\r
+       Elf32_Word      p_type;         /* Entry type. */\r
+       Elf32_Off       p_offset;       /* File offset of contents. */\r
+       Elf32_Addr      p_vaddr;        /* Virtual address in memory image. */\r
+       Elf32_Addr      p_paddr;        /* Physical address (not used). */\r
+       Elf32_Word      p_filesz;       /* Size of contents in file. */\r
+       Elf32_Word      p_memsz;        /* Size of contents in memory. */\r
+       Elf32_Word      p_flags;        /* Access permission flags. */\r
+       Elf32_Word      p_align;        /* Alignment in memory and file. */\r
+} Elf32_Phdr;\r
+\r
+/*\r
+ * Dynamic structure.  The ".dynamic" section contains an array of them.\r
+ */\r
+\r
+typedef struct {\r
+       Elf32_Sword     d_tag;          /* Entry type. */\r
+       union {\r
+               Elf32_Word      d_val;  /* Integer value. */\r
+               Elf32_Addr      d_ptr;  /* Address value. */\r
+       } d_un;\r
+} Elf32_Dyn;\r
+\r
+/*\r
+ * Relocation entries.\r
+ */\r
+\r
+/* Relocations that don't need an addend field. */\r
+typedef struct {\r
+       Elf32_Addr      r_offset;       /* Location to be relocated. */\r
+       Elf32_Word      r_info;         /* Relocation type and symbol index. */\r
+} Elf32_Rel;\r
+\r
+/* Relocations that need an addend field. */\r
+typedef struct {\r
+       Elf32_Addr      r_offset;       /* Location to be relocated. */\r
+       Elf32_Word      r_info;         /* Relocation type and symbol index. */\r
+       Elf32_Sword     r_addend;       /* Addend. */\r
+} Elf32_Rela;\r
+\r
+/* Macros for accessing the fields of r_info. */\r
+#define ELF32_R_SYM(info)      ((info) >> 8)\r
+#define ELF32_R_TYPE(info)     ((unsigned char)(info))\r
+\r
+/* Macro for constructing r_info from field values. */\r
+#define ELF32_R_INFO(sym, type)        (((sym) << 8) + (unsigned char)(type))\r
+\r
+/*\r
+ *     Note entry header\r
+ */\r
+typedef Elf_Note Elf32_Nhdr;\r
+\r
+/*\r
+ *     Move entry\r
+ */\r
+typedef struct {\r
+       Elf32_Lword     m_value;        /* symbol value */\r
+       Elf32_Word      m_info;         /* size + index */\r
+       Elf32_Word      m_poffset;      /* symbol offset */\r
+       Elf32_Half      m_repeat;       /* repeat count */\r
+       Elf32_Half      m_stride;       /* stride info */\r
+} Elf32_Move;\r
+\r
+/*\r
+ *     The macros compose and decompose values for Move.r_info\r
+ *\r
+ *     sym = ELF32_M_SYM(M.m_info)\r
+ *     size = ELF32_M_SIZE(M.m_info)\r
+ *     M.m_info = ELF32_M_INFO(sym, size)\r
+ */\r
+#define        ELF32_M_SYM(info)       ((info)>>8)\r
+#define        ELF32_M_SIZE(info)      ((unsigned char)(info))\r
+#define        ELF32_M_INFO(sym, size) (((sym)<<8)+(unsigned char)(size))\r
+\r
+/*\r
+ *     Hardware/Software capabilities entry\r
+ */\r
+typedef struct {\r
+       Elf32_Word      c_tag;          /* how to interpret value */\r
+       union {\r
+               Elf32_Word      c_val;\r
+               Elf32_Addr      c_ptr;\r
+       } c_un;\r
+} Elf32_Cap;\r
+\r
+/*\r
+ * Symbol table entries.\r
+ */\r
+\r
+typedef struct {\r
+       Elf32_Word      st_name;        /* String table index of name. */\r
+       Elf32_Addr      st_value;       /* Symbol value. */\r
+       Elf32_Word      st_size;        /* Size of associated object. */\r
+       unsigned char   st_info;        /* Type and binding information. */\r
+       unsigned char   st_other;       /* Reserved (not used). */\r
+       Elf32_Half      st_shndx;       /* Section index of symbol. */\r
+} Elf32_Sym;\r
+\r
+/* Macros for accessing the fields of st_info. */\r
+#define ELF32_ST_BIND(info)            ((info) >> 4)\r
+#define ELF32_ST_TYPE(info)            ((info) & 0xf)\r
+\r
+/* Macro for constructing st_info from field values. */\r
+#define ELF32_ST_INFO(bind, type)      (((bind) << 4) + ((type) & 0xf))\r
+\r
+/* Macro for accessing the fields of st_other. */\r
+#define ELF32_ST_VISIBILITY(oth)       ((oth) & 0x3)\r
+\r
+/* Structures used by Sun & GNU symbol versioning. */\r
+typedef struct\r
+{\r
+       Elf32_Half      vd_version;\r
+       Elf32_Half      vd_flags;\r
+       Elf32_Half      vd_ndx;\r
+       Elf32_Half      vd_cnt;\r
+       Elf32_Word      vd_hash;\r
+       Elf32_Word      vd_aux;\r
+       Elf32_Word      vd_next;\r
+} Elf32_Verdef;\r
+\r
+typedef struct\r
+{\r
+       Elf32_Word      vda_name;\r
+       Elf32_Word      vda_next;\r
+} Elf32_Verdaux;\r
+\r
+typedef struct\r
+{\r
+       Elf32_Half      vn_version;\r
+       Elf32_Half      vn_cnt;\r
+       Elf32_Word      vn_file;\r
+       Elf32_Word      vn_aux;\r
+       Elf32_Word      vn_next;\r
+} Elf32_Verneed;\r
+\r
+typedef struct\r
+{\r
+       Elf32_Word      vna_hash;\r
+       Elf32_Half      vna_flags;\r
+       Elf32_Half      vna_other;\r
+       Elf32_Word      vna_name;\r
+       Elf32_Word      vna_next;\r
+} Elf32_Vernaux;\r
+\r
+typedef Elf32_Half Elf32_Versym;\r
+\r
+typedef struct {\r
+       Elf32_Half      si_boundto;     /* direct bindings - symbol bound to */\r
+       Elf32_Half      si_flags;       /* per symbol flags */\r
+} Elf32_Syminfo;\r
+\r
+#endif /* !_SYS_ELF32_H_ */\r