lib/libelf/_libelf.h

   1 /*-
   2  * Copyright (c) 2006,2008-2010 Joseph Koshy
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $Id$
  27  */
  28
  29 #ifndef __LIBELF_H_
  30 #define __LIBELF_H_
  31
  32 #include <sys/queue.h>
  33
  34 #include "_libelf_config.h"
  35
  36 #include "_elftc.h"
  37
  38 #include "libelf_compat.h"
  39
  40 /*
  41  * Library-private data structures.
  42  */
  43
  44 #define LIBELF_MSG_SIZE 256
  45
  46 struct _libelf_globals {
  47         int             libelf_arch;
  48         unsigned int    libelf_byteorder;
  49         int             libelf_class;
  50         int             libelf_error;
  51         int             libelf_fillchar;
  52         unsigned int    libelf_version;
  53         char            libelf_msg[LIBELF_MSG_SIZE];
  54 };
  55
  56 extern struct _libelf_globals _libelf;
  57
  58 #define LIBELF_PRIVATE(N)       (_libelf.libelf_##N)
  59
  60 #define LIBELF_ELF_ERROR_MASK                   0xFF
  61 #define LIBELF_OS_ERROR_SHIFT                   8
  62
  63 #define LIBELF_SET_ERROR(E, O) do {                                     \
  64         LIBELF_PRIVATE(error) = ((ELF_E_##E & LIBELF_ELF_ERROR_MASK)|   \
  65             ((O) << LIBELF_OS_ERROR_SHIFT));                            \
  66         } while (0)
  67
  68 #define LIBELF_ADJUST_AR_SIZE(S)        (((S) + 1U) & ~1U)
  69
  70 /*
  71  * Flags for library internal use.  These use the upper 16 bits of a
  72  * flags field.
  73  */
  74 #define LIBELF_F_DATA_MALLOCED  0x010000 /* whether data was malloc'ed */
  75 #define LIBELF_F_MMAP           0x020000 /* whether e_rawfile was mmap'ed */
  76 #define LIBELF_F_SHDRS_LOADED   0x040000 /* whether all shdrs were read in */
  77 #define LIBELF_F_AR_VARIANT_SVR4 0x080000 /* BSD style ar(1) archive */
  78 #define LIBELF_F_AR_HEADER      0x100000  /* translated header available */
  79
  80 struct _Elf {
  81         int             e_activations;  /* activation count */
  82         unsigned int    e_byteorder;    /* ELFDATA* */
  83         int             e_class;        /* ELFCLASS*  */
  84         Elf_Cmd         e_cmd;          /* ELF_C_* used at creation time */
  85         int             e_fd;           /* associated file descriptor */
  86         unsigned int    e_flags;        /* ELF_F_*, LIBELF_F_* flags */
  87         Elf_Kind        e_kind;         /* ELF_K_* */
  88         Elf             *e_parent;      /* non-NULL for archive members */
  89         char            *e_rawfile;     /* uninterpreted bytes */
  90         size_t          e_rawsize;      /* size of uninterpreted bytes */
  91         unsigned int    e_version;      /* file version */
  92
  93         /*
  94          * Header information for archive members.  See the
  95          * LIBELF_F_AR_HEADER flag.
  96          */
  97         union {
  98                 Elf_Arhdr       *e_arhdr;       /* translated header */
  99                 char            *e_rawhdr;      /* untranslated header */
 100         } e_hdr;
 101
 102         union {
 103                 struct {                /* ar(1) archives */
 104                         off_t   e_next; /* set by elf_rand()/elf_next() */
 105                         int     e_nchildren;
 106                         char    *e_rawstrtab;   /* file name strings */
 107                         size_t  e_rawstrtabsz;
 108                         char    *e_rawsymtab;   /* symbol table */
 109                         size_t  e_rawsymtabsz;
 110                         Elf_Arsym *e_symtab;
 111                         size_t  e_symtabsz;
 112                 } e_ar;
 113                 struct {                /* regular ELF files */
 114                         union {
 115                                 Elf32_Ehdr *e_ehdr32;
 116                                 Elf64_Ehdr *e_ehdr64;
 117                         } e_ehdr;
 118                         union {
 119                                 Elf32_Phdr *e_phdr32;
 120                                 Elf64_Phdr *e_phdr64;
 121                         } e_phdr;
 122                         STAILQ_HEAD(, _Elf_Scn) e_scn;  /* section list */
 123                         size_t  e_nphdr;        /* number of Phdr entries */
 124                         size_t  e_nscn;         /* number of sections */
 125                         size_t  e_strndx;       /* string table section index */
 126                 } e_elf;
 127         } e_u;
 128 };
 129
 130 struct _Elf_Scn {
 131         union {
 132                 Elf32_Shdr      s_shdr32;
 133                 Elf64_Shdr      s_shdr64;
 134         } s_shdr;
 135         STAILQ_HEAD(, _Elf_Data) s_data;        /* list of Elf_Data descriptors */
 136         STAILQ_HEAD(, _Elf_Data) s_rawdata;     /* raw data for this section */
 137         STAILQ_ENTRY(_Elf_Scn) s_next;
 138         struct _Elf     *s_elf;         /* parent ELF descriptor */
 139         unsigned int    s_flags;        /* flags for the section as a whole */
 140         size_t          s_ndx;          /* index# for this section */
 141         uint64_t        s_offset;       /* managed by elf_update() */
 142         uint64_t        s_rawoff;       /* original offset in the file */
 143         uint64_t        s_size;         /* managed by elf_update() */
 144 };
 145
 146
 147 enum {
 148         ELF_TOFILE,
 149         ELF_TOMEMORY
 150 };
 151
 152 #define LIBELF_COPY_U32(DST,SRC,NAME)   do {            \
 153                 if ((SRC)->NAME > UINT_MAX) {           \
 154                         LIBELF_SET_ERROR(RANGE, 0);     \
 155                         return (0);                     \
 156                 }                                       \
 157                 (DST)->NAME = (SRC)->NAME;              \
 158         } while (0)
 159
 160 #define LIBELF_COPY_S32(DST,SRC,NAME)   do {            \
 161                 if ((SRC)->NAME > INT_MAX ||            \
 162                     (SRC)->NAME < INT_MIN) {            \
 163                         LIBELF_SET_ERROR(RANGE, 0);     \
 164                         return (0);                     \
 165                 }                                       \
 166                 (DST)->NAME = (SRC)->NAME;              \
 167         } while (0)
 168
 169
 170 /*
 171  * Prototypes
 172  */
 173
 174 Elf_Data *_libelf_allocate_data(Elf_Scn *_s);
 175 Elf     *_libelf_allocate_elf(void);
 176 Elf_Scn *_libelf_allocate_scn(Elf *_e, size_t _ndx);
 177 Elf_Arhdr *_libelf_ar_gethdr(Elf *_e);
 178 Elf     *_libelf_ar_open(Elf *_e);
 179 Elf     *_libelf_ar_open_member(int _fd, Elf_Cmd _c, Elf *_ar);
 180 int     _libelf_ar_get_member(char *_s, size_t _sz, int _base, size_t *_ret);
 181 Elf_Arsym *_libelf_ar_process_bsd_symtab(Elf *_ar, size_t *_dst);
 182 Elf_Arsym *_libelf_ar_process_svr4_symtab(Elf *_ar, size_t *_dst);
 183 unsigned long _libelf_checksum(Elf *_e, int _elfclass);
 184 void    *_libelf_ehdr(Elf *_e, int _elfclass, int _allocate);
 185 int     _libelf_falign(Elf_Type _t, int _elfclass);
 186 size_t  _libelf_fsize(Elf_Type _t, int _elfclass, unsigned int _version,
 187     size_t count);
 188 int     (*_libelf_get_translator(Elf_Type _t, int _direction, int _elfclass))
 189             (char *_dst, size_t dsz, char *_src, size_t _cnt, int _byteswap);
 190 void    *_libelf_getphdr(Elf *_e, int _elfclass);
 191 void    *_libelf_getshdr(Elf_Scn *_scn, int _elfclass);
 192 void    _libelf_init_elf(Elf *_e, Elf_Kind _kind);
 193 int     _libelf_load_section_headers(Elf *e, void *ehdr);
 194 int     _libelf_malign(Elf_Type _t, int _elfclass);
 195 size_t  _libelf_msize(Elf_Type _t, int _elfclass, unsigned int _version);
 196 void    *_libelf_newphdr(Elf *_e, int _elfclass, size_t _count);
 197 Elf_Data *_libelf_release_data(Elf_Data *_d);
 198 Elf     *_libelf_release_elf(Elf *_e);
 199 Elf_Scn *_libelf_release_scn(Elf_Scn *_s);
 200 int     _libelf_setphnum(Elf *_e, void *_eh, int _elfclass, size_t _phnum);
 201 int     _libelf_setshnum(Elf *_e, void *_eh, int _elfclass, size_t _shnum);
 202 int     _libelf_setshstrndx(Elf *_e, void *_eh, int _elfclass,
 203     size_t _shstrndx);
 204 Elf_Data *_libelf_xlate(Elf_Data *_d, const Elf_Data *_s,
 205     unsigned int _encoding, int _elfclass, int _direction);
 206 int     _libelf_xlate_shtype(uint32_t _sht);
 207
 208 #endif  /* __LIBELF_H_ */