sys/sys/elf_generic.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 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
  29 #ifndef _SYS_ELF_GENERIC_H_
  30 #define _SYS_ELF_GENERIC_H_ 1
  31
  32 #include <sys/cdefs.h>
  33
  34 /*
  35  * Definitions of generic ELF names which relieve applications from
  36  * needing to know the word size.
  37  */
  38
  39 #if __ELF_WORD_SIZE != 32 && __ELF_WORD_SIZE != 64
  40 #error "__ELF_WORD_SIZE must be defined as 32 or 64"
  41 #endif
  42
  43 #define ELF_CLASS       __CONCAT(ELFCLASS,__ELF_WORD_SIZE)
  44
  45 #if BYTE_ORDER == LITTLE_ENDIAN
  46 #define ELF_DATA        ELFDATA2LSB
  47 #elif BYTE_ORDER == BIG_ENDIAN
  48 #define ELF_DATA        ELFDATA2MSB
  49 #else
  50 #error "Unknown byte order"
  51 #endif
  52
  53 #define __elfN(x)       __CONCAT(__CONCAT(__CONCAT(elf,__ELF_WORD_SIZE),_),x)
  54 #define __ElfN(x)       __CONCAT(__CONCAT(__CONCAT(Elf,__ELF_WORD_SIZE),_),x)
  55 #define __ELFN(x)       __CONCAT(__CONCAT(__CONCAT(ELF,__ELF_WORD_SIZE),_),x)
  56 #define __ElfType(x)    typedef __ElfN(x) __CONCAT(Elf_,x)
  57
  58 /* Define ElfW for compatibility with Linux, prefer __ElfN() in FreeBSD code */
  59 #define ElfW(x)         __ElfN(x)
  60
  61 __ElfType(Addr);
  62 __ElfType(Half);
  63 __ElfType(Off);
  64 __ElfType(Sword);
  65 __ElfType(Word);
  66 __ElfType(Ehdr);
  67 __ElfType(Shdr);
  68 __ElfType(Phdr);
  69 __ElfType(Dyn);
  70 __ElfType(Rel);
  71 __ElfType(Rela);
  72 __ElfType(Relr);
  73 __ElfType(Sym);
  74 __ElfType(Verdef);
  75 __ElfType(Verdaux);
  76 __ElfType(Verneed);
  77 __ElfType(Vernaux);
  78 __ElfType(Versym);
  79
  80 /* Non-standard ELF types. */
  81 __ElfType(Hashelt);
  82 __ElfType(Size);
  83 __ElfType(Ssize);
  84
  85 #define ELF_R_SYM       __ELFN(R_SYM)
  86 #define ELF_R_TYPE      __ELFN(R_TYPE)
  87 #define ELF_R_INFO      __ELFN(R_INFO)
  88 #define ELF_ST_BIND     __ELFN(ST_BIND)
  89 #define ELF_ST_TYPE     __ELFN(ST_TYPE)
  90 #define ELF_ST_INFO     __ELFN(ST_INFO)
  91 #define ELF_ST_VISIBILITY       __ELFN(ST_VISIBILITY)
  92
  93 #endif /* !_SYS_ELF_GENERIC_H_ */