Open64: osprey/libelf/lib/private.h Source File

00001 /*
00002  * Copyright 2005 PathScale, Inc.  All Rights Reserved.
00003  */
00004 
00005 /*
00006 private.h - private definitions for libelf.
00007 Copyright (C) 1995 - 2003 Michael Riepe <michael@stud.uni-hannover.de>
00008 
00009 This library is free software; you can redistribute it and/or
00010 modify it under the terms of the GNU Library General Public
00011 License as published by the Free Software Foundation; either
00012 version 2 of the License, or (at your option) any later version.
00013 
00014 This library is distributed in the hope that it will be useful,
00015 but WITHOUT ANY WARRANTY; without even the implied warranty of
00016 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017 Library General Public License for more details.
00018 
00019 You should have received a copy of the GNU Library General Public
00020 License along with this library; if not, write to the Free Software
00021 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00022 */
00023 
00024 /* @(#) $Id: private.h,v 1.1.1.1 2005/10/21 19:00:00 marcel Exp $ */
00025 
00026 #ifndef _PRIVATE_H
00027 #define _PRIVATE_H
00028 
00029 #define __LIBELF_INTERNAL__ 1
00030 
00031 #if HAVE_CONFIG_H
00032 # include <config.h>
00033 #endif /* HAVE_CONFIG_H */
00034 
00035 #include <sys/types.h>
00036 
00037 #if STDC_HEADERS
00038 # include <stdlib.h>
00039 # include <string.h>
00040 #else /* STDC_HEADERS */
00041 extern void *malloc(), *realloc();
00042 extern void free(), bcopy(), abort();
00043 extern int strcmp(), strncmp(), memcmp();
00044 extern void *memcpy(), *memmove(), *memset();
00045 #endif /* STDC_HEADERS */
00046 
00047 #if HAVE_UNISTD_H
00048 # include <unistd.h>
00049 #else /* HAVE_UNISTD_H */
00050 extern int read(), write(), close();
00051 extern off_t lseek();
00052 #if HAVE_FTRUNCATE
00053 extern int ftruncate();
00054 #endif /* HAVE_FTRUNCATE */
00055 #endif /* HAVE_UNISTD_H */
00056 
00057 #ifndef SEEK_SET
00058 #define SEEK_SET  0
00059 #endif /* SEEK_SET */
00060 #ifndef SEEK_CUR
00061 #define SEEK_CUR  1
00062 #endif /* SEEK_CUR */
00063 #ifndef SEEK_END
00064 #define SEEK_END  2
00065 #endif /* SEEK_END */
00066 
00067 #if !HAVE_MEMCMP
00068 # define memcmp strncmp
00069 #endif /* !HAVE_MEMCMP */
00070 #if !HAVE_MEMCPY
00071 # define memcpy(d,s,n)  bcopy(s,d,n)
00072 #endif /* !HAVE_MEMCPY */
00073 #if !HAVE_MEMMOVE
00074 # define memmove(d,s,n) bcopy(s,d,n)
00075 #endif /* !HAVE_MEMMOVE */
00076 
00077 #if !HAVE_MEMSET
00078 # define memset _elf_memset
00079 extern void *_elf_memset();
00080 #endif /* !HAVE_MEMSET */
00081 
00082 #if HAVE_STRUCT_NLIST_DECLARATION
00083 # define nlist __override_nlist_declaration
00084 #endif /* HAVE_STRUCT_NLIST_DECLARATION */
00085 
00086 #if __LIBELF_NEED_LINK_H
00087 # include <link.h>
00088 #endif /* __LIBELF_NEED_LINK_H */
00089 
00090 #include <libelf.h>
00091 
00092 #if HAVE_STRUCT_NLIST_DECLARATION
00093 # undef nlist
00094 #endif /* HAVE_STRUCT_NLIST_DECLARATION */
00095 
00096 #if __LIBELF64
00097 #include <gelf.h>
00098 #endif /* __LIBELF64 */
00099 
00100 typedef struct Scn_Data Scn_Data;
00101 
00102 /*
00103  * ELF descriptor
00104  */
00105 struct Elf {
00106     /* common */
00107     size_t  e_size;     /* file/member size */
00108     size_t  e_dsize;    /* size of memory image */
00109     Elf_Kind  e_kind;     /* kind of file */
00110     char* e_data;     /* file/member data */
00111     char* e_rawdata;    /* file/member raw data */
00112     size_t  e_idlen;    /* identifier size */
00113     int   e_fd;     /* file descriptor */
00114     unsigned  e_count;    /* activation count */
00115     /* archive members (still common) */
00116     Elf*  e_parent;   /* NULL if not an archive member */
00117     size_t  e_next;     /* 0 if not an archive member */
00118     size_t  e_base;     /* 0 if not an archive member */
00119     Elf*  e_link;     /* next archive member or NULL */
00120     Elf_Arhdr*  e_arhdr;    /* archive member header or NULL */
00121     /* archives */
00122     size_t  e_off;      /* current member offset (for elf_begin) */
00123     Elf*  e_members;    /* linked list of active archive members */
00124     char* e_symtab;   /* archive symbol table */
00125     size_t  e_symlen;   /* length of archive symbol table */
00126     char* e_strtab;   /* archive string table */
00127     size_t  e_strlen;   /* length of archive string table */
00128     /* ELF files */
00129     unsigned  e_class;    /* ELF class */
00130     unsigned  e_encoding;   /* ELF data encoding */
00131     unsigned  e_version;    /* ELF version */
00132     char* e_ehdr;     /* ELF header */
00133     char* e_phdr;     /* ELF program header table */
00134     size_t  e_phnum;    /* size of program header table */
00135     Elf_Scn*  e_scn_1;    /* first section */
00136     Elf_Scn*  e_scn_n;    /* last section */
00137     unsigned  e_elf_flags;    /* elf flags (ELF_F_*) */
00138     unsigned  e_ehdr_flags;   /* ehdr flags (ELF_F_*) */
00139     unsigned  e_phdr_flags;   /* phdr flags (ELF_F_*) */
00140     /* misc flags */
00141     unsigned  e_readable : 1;   /* file is readable */
00142     unsigned  e_writable : 1;   /* file is writable */
00143     unsigned  e_disabled : 1;   /* e_fd has been disabled */
00144     unsigned  e_cooked : 1;   /* e_data was modified */
00145     unsigned  e_free_syms : 1;  /* e_symtab is malloc'ed */
00146     unsigned  e_free_ehdr : 1;  /* e_ehdr is malloc'ed */
00147     unsigned  e_free_phdr : 1;  /* e_phdr is malloc'ed */
00148     unsigned  e_unmap_data : 1; /* e_data is mmap'ed */
00149     unsigned  e_memory : 1;   /* created by elf_memory() */
00150     /* magic number for debugging */
00151     long  e_magic;
00152 };
00153 
00154 #define ELF_MAGIC 0x012b649e
00155 
00156 #define INIT_ELF  {\
00157     /* e_size */  0,\
00158     /* e_dsize */ 0,\
00159     /* e_kind */  ELF_K_NONE,\
00160     /* e_data */  NULL,\
00161     /* e_rawdata */ NULL,\
00162     /* e_idlen */ 0,\
00163     /* e_fd */    -1,\
00164     /* e_count */ 1,\
00165     /* e_parent */  NULL,\
00166     /* e_next */  0,\
00167     /* e_base */  0,\
00168     /* e_link */  NULL,\
00169     /* e_arhdr */ NULL,\
00170     /* e_off */   0,\
00171     /* e_members */ NULL,\
00172     /* e_symtab */  NULL,\
00173     /* e_symlen */  0,\
00174     /* e_strtab */  NULL,\
00175     /* e_strlen */  0,\
00176     /* e_class */ ELFCLASSNONE,\
00177     /* e_encoding */  ELFDATANONE,\
00178     /* e_version */ EV_NONE,\
00179     /* e_ehdr */  NULL,\
00180     /* e_phdr */  NULL,\
00181     /* e_phnum */ 0,\
00182     /* e_scn_1 */ NULL,\
00183     /* e_scn_n */ NULL,\
00184     /* e_elf_flags */ 0,\
00185     /* e_ehdr_flags */  0,\
00186     /* e_phdr_flags */  0,\
00187     /* e_readable */  0,\
00188     /* e_writable */  0,\
00189     /* e_disabled */  0,\
00190     /* e_cooked */  0,\
00191     /* e_free_syms */ 0,\
00192     /* e_free_ehdr */ 0,\
00193     /* e_free_phdr */ 0,\
00194     /* e_unmap_data */  0,\
00195     /* e_memory */  0,\
00196     /* e_magic */ ELF_MAGIC\
00197 }
00198 
00199 /*
00200  * Section descriptor
00201  */
00202 struct Elf_Scn {
00203     Elf_Scn*  s_link;     /* pointer to next Elf_Scn */
00204     Elf*  s_elf;      /* pointer to elf descriptor */
00205     size_t  s_index;    /* number of this section */
00206     unsigned  s_scn_flags;    /* section flags (ELF_F_*) */
00207     unsigned  s_shdr_flags;   /* shdr flags (ELF_F_*) */
00208     Scn_Data* s_data_1;   /* first data buffer */
00209     Scn_Data* s_data_n;   /* last data buffer */
00210     Scn_Data* s_rawdata;    /* raw data buffer */
00211     /* data copied from shdr */
00212     unsigned  s_type;     /* section type */
00213     size_t  s_offset;   /* section offset */
00214     size_t  s_size;     /* section size */
00215     /* misc flags */
00216     unsigned  s_freeme : 1;   /* this Elf_Scn was malloc'ed */
00217     /* section header */
00218     union {
00219 #if __LIBELF64
00220   Elf64_Shdr  u_shdr64;
00221 #endif /* __LIBELF64 */
00222   Elf32_Shdr  u_shdr32;
00223     }   s_uhdr;
00224     /* magic number for debugging */
00225     long  s_magic;
00226 };
00227 #define s_shdr32  s_uhdr.u_shdr32
00228 #define s_shdr64  s_uhdr.u_shdr64
00229 
00230 #define SCN_MAGIC 0x012c747d
00231 
00232 #define INIT_SCN  {\
00233     /* s_link */  NULL,\
00234     /* s_elf */   NULL,\
00235     /* s_index */ 0,\
00236     /* s_scn_flags */ 0,\
00237     /* s_shdr_flags */  0,\
00238     /* s_data_1 */  NULL,\
00239     /* s_data_n */  NULL,\
00240     /* s_rawdata */ NULL,\
00241     /* s_type */  SHT_NULL,\
00242     /* s_offset */  0,\
00243     /* s_size */  0,\
00244     /* s_freeme */  0,\
00245     /* s_uhdr */  {{0,}},\
00246     /* s_magic */ SCN_MAGIC\
00247 }
00248 
00249 /*
00250  * Data descriptor
00251  */
00252 struct Scn_Data {
00253     Elf_Data  sd_data;    /* must be first! */
00254     Scn_Data* sd_link;    /* pointer to next Scn_Data */
00255     Elf_Scn*  sd_scn;     /* pointer to section */
00256     char* sd_memdata;   /* memory image of section */
00257     unsigned  sd_data_flags;    /* data flags (ELF_F_*) */
00258     /* misc flags */
00259     unsigned  sd_freeme : 1;    /* this Scn_Data was malloc'ed */
00260     unsigned  sd_free_data : 1; /* sd_memdata is malloc'ed */
00261     /* magic number for debugging */
00262     long  sd_magic;
00263 };
00264 
00265 #define DATA_MAGIC  0x01072639
00266 
00267 #define INIT_DATA {\
00268     {\
00269     /* d_buf */   NULL,\
00270     /* d_type */  ELF_T_BYTE,\
00271     /* d_size */  0,\
00272     /* d_off */   0,\
00273     /* d_align */ 0,\
00274     /* d_version */ EV_NONE\
00275     },\
00276     /* sd_link */ NULL,\
00277     /* sd_scn */  NULL,\
00278     /* sd_memdata */  NULL,\
00279     /* sd_data_flags */ 0,\
00280     /* sd_freeme */ 0,\
00281     /* sd_free_data */  0,\
00282     /* sd_magic */  DATA_MAGIC\
00283 }
00284 
00285 /*
00286  * Private status variables
00287  */
00288 extern unsigned _elf_version;
00289 extern int _elf_errno;
00290 extern int _elf_fill;
00291 
00292 /*
00293  * Private functions
00294  */
00295 extern void *_elf_read __P((Elf*, void*, size_t, size_t));
00296 extern void *_elf_mmap __P((Elf*));
00297 extern int _elf_cook __P((Elf*));
00298 extern char *_elf_getehdr __P((Elf*, unsigned));
00299 extern char *_elf_getphdr __P((Elf*, unsigned));
00300 extern Elf_Data *_elf_xlatetom __P((const Elf*, Elf_Data*, const Elf_Data*));
00301 extern Elf_Type _elf_scn_type __P((unsigned));
00302 extern size_t _elf32_xltsize __P((const Elf_Data *__src, unsigned __dv, unsigned __encode, int __tof));
00303 extern size_t _elf64_xltsize __P((const Elf_Data *__src, unsigned __dv, unsigned __encode, int __tof));
00304 extern int _elf_update_shnum(Elf *__elf, size_t __shnum);
00305 
00306 /*
00307  * Special translators
00308  */
00309 extern size_t _elf_verdef_32L11_tof __P((unsigned char *dst, const unsigned char *src, size_t n));
00310 extern size_t _elf_verdef_32L11_tom __P((unsigned char *dst, const unsigned char *src, size_t n));
00311 extern size_t _elf_verdef_32M11_tof __P((unsigned char *dst, const unsigned char *src, size_t n));
00312 extern size_t _elf_verdef_32M11_tom __P((unsigned char *dst, const unsigned char *src, size_t n));
00313 extern size_t _elf_verdef_64L11_tof __P((unsigned char *dst, const unsigned char *src, size_t n));
00314 extern size_t _elf_verdef_64L11_tom __P((unsigned char *dst, const unsigned char *src, size_t n));
00315 extern size_t _elf_verdef_64M11_tof __P((unsigned char *dst, const unsigned char *src, size_t n));
00316 extern size_t _elf_verdef_64M11_tom __P((unsigned char *dst, const unsigned char *src, size_t n));
00317 extern size_t _elf_verneed_32L11_tof __P((unsigned char *dst, const unsigned char *src, size_t n));
00318 extern size_t _elf_verneed_32L11_tom __P((unsigned char *dst, const unsigned char *src, size_t n));
00319 extern size_t _elf_verneed_32M11_tof __P((unsigned char *dst, const unsigned char *src, size_t n));
00320 extern size_t _elf_verneed_32M11_tom __P((unsigned char *dst, const unsigned char *src, size_t n));
00321 extern size_t _elf_verneed_64L11_tof __P((unsigned char *dst, const unsigned char *src, size_t n));
00322 extern size_t _elf_verneed_64L11_tom __P((unsigned char *dst, const unsigned char *src, size_t n));
00323 extern size_t _elf_verneed_64M11_tof __P((unsigned char *dst, const unsigned char *src, size_t n));
00324 extern size_t _elf_verneed_64M11_tom __P((unsigned char *dst, const unsigned char *src, size_t n));
00325 
00326 /*
00327  * Private data
00328  */
00329 extern const Elf_Scn _elf_scn_init;
00330 extern const Scn_Data _elf_data_init;
00331 extern const size_t _elf_fmsize[2][EV_CURRENT - EV_NONE][ELF_T_NUM][2];
00332 
00333 /*
00334  * Access macros for _elf_fmsize[]
00335  */
00336 #define _fmsize(c,v,t,w)  \
00337   (_elf_fmsize[(c)-ELFCLASS32][(v)-EV_NONE-1][(t)-ELF_T_BYTE][(w)])
00338 #define _fsize(c,v,t)   _fmsize((c),(v),(t),1)
00339 #define _msize(c,v,t)   _fmsize((c),(v),(t),0)
00340 
00341 /*
00342  * Various checks
00343  */
00344 #define valid_class(c)    ((c) >= ELFCLASS32 && (c) <= ELFCLASS64)
00345 #define valid_encoding(e) ((e) >= ELFDATA2LSB && (e) <= ELFDATA2MSB)
00346 #define valid_version(v)  ((v) > EV_NONE && (v) <= EV_CURRENT)
00347 #define valid_type(t)   ((t) >= ELF_T_BYTE && (t) < ELF_T_NUM)
00348 
00349 /*
00350  * Error codes
00351  */
00352 enum {
00353 #define __err__(a,b)  a,
00354 #include <errors.h>   /* include constants from errors.h */
00355 #undef __err__
00356 ERROR_NUM
00357 };
00358 
00359 #define seterr(err) (_elf_errno = (err))
00360 
00361 /*
00362  * Sizes of data types (external representation)
00363  * These definitions should be in <elf.h>, but...
00364  */
00365 #ifndef ELF32_FSZ_ADDR
00366 # define ELF32_FSZ_ADDR   4
00367 # define ELF32_FSZ_HALF   2
00368 # define ELF32_FSZ_OFF    4
00369 # define ELF32_FSZ_SWORD  4
00370 # define ELF32_FSZ_WORD   4
00371 #endif /* ELF32_FSZ_ADDR */
00372 #ifndef ELF64_FSZ_ADDR
00373 # define ELF64_FSZ_ADDR   8
00374 # define ELF64_FSZ_HALF   2
00375 # define ELF64_FSZ_OFF    8
00376 # define ELF64_FSZ_SWORD  4
00377 # define ELF64_FSZ_SXWORD 8
00378 # define ELF64_FSZ_WORD   4
00379 # define ELF64_FSZ_XWORD  8
00380 #endif /* ELF64_FSZ_ADDR */
00381 
00382 /*
00383  * More missing pieces, in no particular order
00384  */
00385 #ifndef SHT_SYMTAB_SHNDX
00386 #define SHT_SYMTAB_SHNDX  18
00387 #endif
00388 
00389 /*
00390  * Debugging
00391  */
00392 #if ENABLE_DEBUG
00393 extern void __elf_assert __P((const char*, unsigned, const char*));
00394 # if __STDC__
00395 #  define elf_assert(x) do{if(!(x))__elf_assert(__FILE__,__LINE__,#x);}while(0)
00396 # else /* __STDC__ */
00397 #  define elf_assert(x) do{if(!(x))__elf_assert(__FILE__,__LINE__,"x");}while(0)
00398 # endif /* __STDC__ */
00399 #else /* ENABLE_DEBUG */
00400 # define elf_assert(x)  do{}while(0)
00401 #endif /* ENABLE_DEBUG */
00402 
00403 #endif /* _PRIVATE_H */