ext/libelf/_libelf.h - testing/jenkins-gem5-prod - Git at Google

 /*-
  * Copyright (c) 2006 Joseph Koshy
  * 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/lib/libelf/_libelf.h,v 1.2 2006/12/25 02:22:22 jkoshy Exp $
  */

 #ifndef	__LIBELF_H_
 #define	__LIBELF_H_

 #include "elf_queue.h"
 #include "libelf.h"

 #ifndef	NULL
 #define NULL 	((void *) 0)
 #endif

 /*
  * Library-private data structures.
  */

 #define LIBELF_MSG_SIZE	256

 struct _libelf_globals {
         int		libelf_arch;
         unsigned int	libelf_byteorder;
         int		libelf_class;
         int		libelf_error;
         int		libelf_fillchar;
         unsigned int	libelf_version;
         char		libelf_msg[LIBELF_MSG_SIZE];
 };

 struct _libelf_globals *_libelf_private();

 #define	LIBELF_PRIVATE(N)	(_libelf_private()->libelf_##N)

 #define	LIBELF_ELF_ERROR_MASK	0xFF
 #define	LIBELF_OS_ERROR_SHIFT	8

 #define	LIBELF_SET_ERROR(E, O) do {					\
         LIBELF_PRIVATE(error) = ((ELF_E_##E & LIBELF_ELF_ERROR_MASK)|	\
             ((O) << LIBELF_OS_ERROR_SHIFT));				\
         } while (0)

 #define	LIBELF_ADJUST_AR_SIZE(S)	(((S) + 1U) & ~1U)

 /*
  * Flags for library internal use.  These use the upper 16 bits of a
  * flags field.
  */
 #define	LIBELF_F_MALLOCED	0x010000 /* whether data was malloc'ed */
 #define	LIBELF_F_MMAP		0x020000 /* whether e_rawfile was mmap'ed */
 #define	LIBELF_F_SHDRS_LOADED	0x040000 /* whether all shdrs were read in */

 struct _Elf {
         int		e_activations;	/* activation count */
         Elf_Arhdr	*e_arhdr;	/* header for archive members */
         unsigned int	e_byteorder;	/* ELFDATA* */
         int		e_class;	/* ELFCLASS*  */
         Elf_Cmd		e_cmd;		/* ELF_C_* used at creation time */
         int		e_fd;		/* associated file descriptor */
         unsigned int	e_flags;	/* ELF_F_*, LIBELF_F_* flags */
         Elf_Kind	e_kind;		/* ELF_K_* */
         Elf		*e_parent; 	/* non-NULL for archive members */
         char	 	*e_rawfile;	/* uninterpreted bytes */
         size_t		e_rawsize;	/* size of uninterpreted bytes */
         unsigned int	e_version;	/* file version */

         union {
                 struct {		/* ar(1) archives */
                         off_t	e_next;	/* set by elf_rand()/elf_next() */
                         int	e_nchildren;
                         char	*e_rawstrtab;	/* file name strings */
                         size_t	e_rawstrtabsz;
                         char	*e_rawsymtab;	/* symbol table */
                         size_t	e_rawsymtabsz;
                         Elf_Arsym *e_symtab;
                         size_t	e_symtabsz;
                 } e_ar;
                 struct {		/* regular ELF files */
                         union {
                                 Elf32_Ehdr *e_ehdr32;
                                 Elf64_Ehdr *e_ehdr64;
                         } e_ehdr;
                         union {
                                 Elf32_Phdr *e_phdr32;
                                 Elf64_Phdr *e_phdr64;
                         } e_phdr;
                         STAILQ_HEAD(, _Elf_Scn)	e_scn;	/* section list */
                         size_t	e_nphdr;	/* number of Phdr entries */
                         size_t	e_nscn;		/* number of sections */
                         size_t	e_strndx;	/* string table section index */
                 } e_elf;
         } e_u;
 };

 struct _Elf_Scn {
         union {
                 Elf32_Shdr	s_shdr32;
                 Elf64_Shdr	s_shdr64;
         } s_shdr;
         STAILQ_HEAD(, _Elf_Data) s_data;	/* list of Elf_Data descriptors */
         STAILQ_HEAD(, _Elf_Data) s_rawdata;	/* raw data for this section */
         STAILQ_ENTRY(_Elf_Scn) s_next;
         struct _Elf	*s_elf;		/* parent ELF descriptor */
         unsigned int	s_flags;	/* flags for the section as a whole */
         size_t		s_ndx;		/* index# for this section */
         uint64_t	s_offset;	/* managed by elf_update() */
         uint64_t	s_rawoff;	/* original offset in the file */
         uint64_t	s_size;		/* managed by elf_update() */
 };


 enum {
         ELF_TOFILE,
         ELF_TOMEMORY
 };

 #define	LIBELF_COPY_U32(DST,SRC,NAME)	do {		\
                 if ((SRC)->NAME > UINT_MAX) {		\
                         LIBELF_SET_ERROR(RANGE, 0);	\
                         return (0);			\
                 }					\
                 (DST)->NAME = (SRC)->NAME;		\
         } while (0)

 #define	LIBELF_COPY_S32(DST,SRC,NAME)	do {		\
                 if ((SRC)->NAME > INT_MAX ||		\
                     (SRC)->NAME < INT_MIN) {		\
                         LIBELF_SET_ERROR(RANGE, 0);	\
                         return (0);			\
                 }					\
                 (DST)->NAME = (SRC)->NAME;		\
         } while (0)


 /*
  * Prototypes
  */

 Elf_Data *_libelf_allocate_data(Elf_Scn *_s);
 Elf	*_libelf_allocate_elf(void);
 Elf_Scn	*_libelf_allocate_scn(Elf *_e, size_t _ndx);
 Elf_Arhdr *_libelf_ar_gethdr(Elf *_e);
 Elf	*_libelf_ar_open(Elf *_e);
 Elf	*_libelf_ar_open_member(int _fd, Elf_Cmd _c, Elf *_ar);
 Elf_Arsym *_libelf_ar_process_symtab(Elf *_ar, size_t *_dst);
 unsigned long _libelf_checksum(Elf *_e, int _elfclass);
 void	*_libelf_ehdr(Elf *_e, int _elfclass, int _allocate);
 int	_libelf_falign(Elf_Type _t, int _elfclass);
 size_t	_libelf_fsize(Elf_Type _t, int _elfclass, unsigned int _version,
     size_t count);
 void	(*_libelf_get_translator(Elf_Type _t, int _direction, int _elfclass))
             (char *_dst, char *_src, size_t _cnt, int _byteswap);
 void	*_libelf_getphdr(Elf *_e, int _elfclass);
 void	*_libelf_getshdr(Elf_Scn *_scn, int _elfclass);
 void	_libelf_init_elf(Elf *_e, Elf_Kind _kind);
 int	_libelf_malign(Elf_Type _t, int _elfclass);
 size_t	_libelf_msize(Elf_Type _t, int _elfclass, unsigned int _version);
 void	*_libelf_newphdr(Elf *_e, int _elfclass, size_t _count);
 Elf_Data *_libelf_release_data(Elf_Data *_d);
 Elf	*_libelf_release_elf(Elf *_e);
 Elf_Scn	*_libelf_release_scn(Elf_Scn *_s);
 int	_libelf_setphnum(Elf *_e, void *_eh, int _elfclass, size_t _phnum);
 int	_libelf_setshnum(Elf *_e, void *_eh, int _elfclass, size_t _shnum);
 int	_libelf_setshstrndx(Elf *_e, void *_eh, int _elfclass,
     size_t _shstrndx);
 Elf_Data *_libelf_xlate(Elf_Data *_d, const Elf_Data *_s,
     unsigned int _encoding, int _elfclass, int _direction);
 int	_libelf_xlate_shtype(uint32_t _sht);

 #endif	/* __LIBELF_H_ */
	/*-
	* Copyright (c) 2006 Joseph Koshy
	* 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/lib/libelf/_libelf.h,v 1.2 2006/12/25 02:22:22 jkoshy Exp $
	*/

	#ifndef __LIBELF_H_
	#define __LIBELF_H_

	#include "elf_queue.h"
	#include "libelf.h"

	#ifndef NULL
	#define NULL ((void *) 0)
	#endif

	/*
	* Library-private data structures.
	*/

	#define LIBELF_MSG_SIZE 256

	struct _libelf_globals {
	int libelf_arch;
	unsigned int libelf_byteorder;
	int libelf_class;
	int libelf_error;
	int libelf_fillchar;
	unsigned int libelf_version;
	char libelf_msg[LIBELF_MSG_SIZE];
	};

	struct _libelf_globals *_libelf_private();

	#define LIBELF_PRIVATE(N) (_libelf_private()->libelf_##N)

	#define LIBELF_ELF_ERROR_MASK 0xFF
	#define LIBELF_OS_ERROR_SHIFT 8

	#define LIBELF_SET_ERROR(E, O) do { \
	LIBELF_PRIVATE(error) = ((ELF_E_##E & LIBELF_ELF_ERROR_MASK)\| \
	((O) << LIBELF_OS_ERROR_SHIFT)); \
	} while (0)

	#define LIBELF_ADJUST_AR_SIZE(S) (((S) + 1U) & ~1U)

	/*
	* Flags for library internal use. These use the upper 16 bits of a
	* flags field.
	*/
	#define LIBELF_F_MALLOCED 0x010000 /* whether data was malloc'ed */
	#define LIBELF_F_MMAP 0x020000 /* whether e_rawfile was mmap'ed */
	#define LIBELF_F_SHDRS_LOADED 0x040000 /* whether all shdrs were read in */

	struct _Elf {
	int e_activations; /* activation count */
	Elf_Arhdr e_arhdr; / header for archive members */
	unsigned int e_byteorder; /* ELFDATA* */
	int e_class; /* ELFCLASS* */
	Elf_Cmd e_cmd; /* ELF_C_* used at creation time */
	int e_fd; /* associated file descriptor */
	unsigned int e_flags; /* ELF_F_, LIBELF_F_ flags */
	Elf_Kind e_kind; /* ELF_K_* */
	Elf e_parent; / non-NULL for archive members */
	char e_rawfile; / uninterpreted bytes */
	size_t e_rawsize; /* size of uninterpreted bytes */
	unsigned int e_version; /* file version */

	union {
	struct { /* ar(1) archives */
	off_t e_next; /* set by elf_rand()/elf_next() */
	int e_nchildren;
	char e_rawstrtab; / file name strings */
	size_t e_rawstrtabsz;
	char e_rawsymtab; / symbol table */
	size_t e_rawsymtabsz;
	Elf_Arsym *e_symtab;
	size_t e_symtabsz;
	} e_ar;
	struct { /* regular ELF files */
	union {
	Elf32_Ehdr *e_ehdr32;
	Elf64_Ehdr *e_ehdr64;
	} e_ehdr;
	union {
	Elf32_Phdr *e_phdr32;
	Elf64_Phdr *e_phdr64;
	} e_phdr;
	STAILQ_HEAD(, _Elf_Scn) e_scn; /* section list */
	size_t e_nphdr; /* number of Phdr entries */
	size_t e_nscn; /* number of sections */
	size_t e_strndx; /* string table section index */
	} e_elf;
	} e_u;
	};

	struct _Elf_Scn {
	union {
	Elf32_Shdr s_shdr32;
	Elf64_Shdr s_shdr64;
	} s_shdr;
	STAILQ_HEAD(, _Elf_Data) s_data; /* list of Elf_Data descriptors */
	STAILQ_HEAD(, _Elf_Data) s_rawdata; /* raw data for this section */
	STAILQ_ENTRY(_Elf_Scn) s_next;
	struct _Elf s_elf; / parent ELF descriptor */
	unsigned int s_flags; /* flags for the section as a whole */
	size_t s_ndx; /* index# for this section */
	uint64_t s_offset; /* managed by elf_update() */
	uint64_t s_rawoff; /* original offset in the file */
	uint64_t s_size; /* managed by elf_update() */
	};


	enum {
	ELF_TOFILE,
	ELF_TOMEMORY
	};

	#define LIBELF_COPY_U32(DST,SRC,NAME) do { \
	if ((SRC)->NAME > UINT_MAX) { \
	LIBELF_SET_ERROR(RANGE, 0); \
	return (0); \
	} \
	(DST)->NAME = (SRC)->NAME; \
	} while (0)

	#define LIBELF_COPY_S32(DST,SRC,NAME) do { \
	if ((SRC)->NAME > INT_MAX \|\| \
	(SRC)->NAME < INT_MIN) { \
	LIBELF_SET_ERROR(RANGE, 0); \
	return (0); \
	} \
	(DST)->NAME = (SRC)->NAME; \
	} while (0)


	/*
	* Prototypes
	*/

	Elf_Data _libelf_allocate_data(Elf_Scn _s);
	Elf *_libelf_allocate_elf(void);
	Elf_Scn _libelf_allocate_scn(Elf _e, size_t _ndx);
	Elf_Arhdr _libelf_ar_gethdr(Elf _e);
	Elf _libelf_ar_open(Elf _e);
	Elf _libelf_ar_open_member(int _fd, Elf_Cmd _c, Elf _ar);
	Elf_Arsym _libelf_ar_process_symtab(Elf _ar, size_t *_dst);
	unsigned long _libelf_checksum(Elf *_e, int _elfclass);
	void _libelf_ehdr(Elf _e, int _elfclass, int _allocate);
	int _libelf_falign(Elf_Type _t, int _elfclass);
	size_t _libelf_fsize(Elf_Type _t, int _elfclass, unsigned int _version,
	size_t count);
	void (*_libelf_get_translator(Elf_Type _t, int _direction, int _elfclass))
	(char _dst, char _src, size_t _cnt, int _byteswap);
	void _libelf_getphdr(Elf _e, int _elfclass);
	void _libelf_getshdr(Elf_Scn _scn, int _elfclass);
	void _libelf_init_elf(Elf *_e, Elf_Kind _kind);
	int _libelf_malign(Elf_Type _t, int _elfclass);
	size_t _libelf_msize(Elf_Type _t, int _elfclass, unsigned int _version);
	void _libelf_newphdr(Elf _e, int _elfclass, size_t _count);
	Elf_Data _libelf_release_data(Elf_Data _d);
	Elf _libelf_release_elf(Elf _e);
	Elf_Scn _libelf_release_scn(Elf_Scn _s);
	int _libelf_setphnum(Elf _e, void _eh, int _elfclass, size_t _phnum);
	int _libelf_setshnum(Elf _e, void _eh, int _elfclass, size_t _shnum);
	int _libelf_setshstrndx(Elf _e, void _eh, int _elfclass,
	size_t _shstrndx);
	Elf_Data _libelf_xlate(Elf_Data _d, const Elf_Data *_s,
	unsigned int _encoding, int _elfclass, int _direction);
	int _libelf_xlate_shtype(uint32_t _sht);

	#endif /* __LIBELF_H_ */