include @builddir@/mk/defs.mk

DIRS=	external compat libpkg/repo libpkg src docs scripts

@if TESTS

DIRS+=	tests

@endif

include $(MK)/dir.mk

include $(MK)/common.mk

VPATH=	$(top_srcdir)

@if coverage

check: clean-profiles

clean-profiles:

	rm -f /tmp/pkg.*.profraw

@endif

configure_call: auto.def @CONF_GEN_FILES@

	sh configure_call

	${MAKE}

Makefile: configure_call

check: all

@if TESTS

all: Kyuafile Makefile

check: UndefinedBehaviour.suppress Leak.suppress

	export UBSAN_OPTIONS=print_stacktrace=1:halt_on_error=1:suppressions=$(top_builddir)/UndefinedBehaviour.suppress; \

	export LSAN_OPTIONS=print_suppressions=0:exitcode=0:suppressions=$(top_builddir)/Leak.suppress; \

	if [ "$$(uname)" != "FreeBSD" ]; then \

		export ASAN_OPTIONS=detect_leaks=1 ; \

	fi ; \

	export LLVM_PROFILE_FILE=/tmp/pkg.%p.profraw; \

	if [ "$(HTML)" != "" ]; then \

		args="-r $(top_builddir)/res.db" ; \

	fi ; \

	parallel=$$(getconf NPROCESSORS_ONLN 2>/dev/null || getconf _NPROCESSORS_ONLN ) ; \

	kyua --config=none \

		--variable parallelism=$${parallel} \

		test $$args \

		--kyuafile='$(top_builddir)/Kyuafile' \

		--build-root='$(top_builddir)' || FAILED=1 ; \

	if [ "$(HTML)" != "" ]; then \

		kyua report-html --force $$args --output=$(HTML) ; \

		rm -f $(top_builddir)/res.db ; \

	fi ; \

	exit $${FAILED}

@endif

@if coverage

check-coverage: check

	llvm-profdata merge --output=pkg.profdata /tmp/pkg.*.profraw

report-coverage:

	llvm-cov report ./src/pkg -instr-profile=pkg.profdata --use-color -ignore-filename-regex=external -ignore-filename-regex=compat

@endif

COCCI_ARGS=	-I ${top_srcdir} \

		-I /usr/include \

		-I /usr/local/include \

		-I ${top_srcdir}/compat \

		-I ${top_srcdir}/libpkg \

		-I ${top_srcdir}/src \

		-I ${top_srcdir}/external/yxml \

		-I ${top_srcdir}/external/libucl/include \

		-I ${top_srcdir}/external/uthash \

		-I ${top_srcdir}/external/sqlite  \

		-I ${top_srcdir}/external/elf

1cocci:

	spatch ${COCCI_ARGS} -in_place -sp_file $(top_srcdir)/tests/cocci/${COCCITEST} -dir ${top_srcdir}/libpkg ; \

	spatch ${COCCI_ARGS} -in_place -sp_file $(top_srcdir)/tests/cocci/${COCCITEST} -dir ${top_srcdir}/src ;

cocci:

	for c in ${top_srcdir}/tests/cocci/*.cocci ; do \

		echo "Passing $$c" ; \

		spatch ${COCCI_ARGS} -in_place -sp_file $$c -dir ${top_srcdir}/libpkg ; \

		spatch ${COCCI_ARGS} -in_place -sp_file $$c -dir ${top_srcdir}/src ; \

	done

make-config-header external/libsqlite/sqlite_generated.h

foreach dir [list . external/libblake2 external/libpicosat \

	external/liblinenoise external/libsqlite external/libfetch \

	external/liblua external/libyxml scripts external/libder \

	make-template $dir/Makefile.in

	define-append CONF_GEN_FILES $dir/Makefile.in

include @builddir@/mk/defs.mk

LIB=	bsd_compat

SRCS=	closefrom.c \

	humanize_number.c \

	strtonum.c \

	funopen.c

LOCAL_CFLAGS=	-I$(top_srcdir)/compat \

		-I$(top_srcdir)/libpkg \

		-I$(top_srcdir) \

		-I$(top_builddir)

VPATH=	$(top_srcdir)/compat

include $(MK)/static-lib.mk

include @builddir@/mk/defs.mk

MAN3=	pkg_printf.3 \

	pkg_create.3 \

	pkg_repo_create.3 \

	pkg_repos.3

MAN5=	pkg-repository.5 \

	pkg-keywords.5 \

	pkg-script.5 \

	pkg-lua-script.5 \

	pkg-triggers.5 \

	pkg.conf.5

MAN8=	pkg-add.8 \

	pkg-alias.8 \

	pkg-annotate.8 \

	pkg-audit.8 \

	pkg-autoremove.8 \

	pkg-check.8 \

	pkg-clean.8 \

	pkg-config.8 \

	pkg-create.8 \

	pkg-delete.8 \

	pkg-fetch.8 \

	pkg-help.8 \

	pkg-info.8 \

	pkg-install.8 \

	pkg-key.8 \

	pkg-lock.8 \

	pkg-plugins.8 \

	pkg-query.8 \

	pkg-register.8 \

	pkg-repo.8 \

	pkg-repositories.8 \

	pkg-rquery.8 \

	pkg-search.8 \

	pkg-set.8 \

	pkg-shell.8 \

	pkg-shlib.8 \

	pkg-ssh.8 \

	pkg-stats.8 \

	pkg-triggers.8 \

	pkg-unregister.8 \

	pkg-update.8 \

	pkg-updating.8 \

	pkg-upgrade.8 \

	pkg-version.8 \

	pkg-which.8 \

	pkg.8

MAN3GZ=	$(MAN3:.3=.3.gz)

MAN5GZ=	$(MAN5:.5=.5.gz)

MAN8GZ=	$(MAN8:.8=.8.gz)

VPATH=	$(top_srcdir)/docs

.SUFFIXES: .3.gz .5.gz .8.gz .3 .5 .8

all: $(MAN3GZ) $(MAN5GZ) $(MAN8GZ)

.3.3.gz:

	gzip -knc $< > $@

.5.5.gz:

	gzip -knc $< > $@

.8.8.gz:

	gzip -knc $< > $@

clean:

	rm -f *.gz

run-fix-xrefs:

	./fix-xrefs $(MAN3) $(MAN5) $(MAN8)

install:

	install -d $(DESTDIR)$(mandir)/man3

	install -d $(DESTDIR)$(mandir)/man5

	install -d $(DESTDIR)$(mandir)/man8

	install -m 644 *.3.gz $(DESTDIR)$(mandir)/man3/

	install -m 644 *.5.gz $(DESTDIR)$(mandir)/man5/

	install -m 644 *.8.gz $(DESTDIR)$(mandir)/man8/

	ln -sf pkg-delete.8.gz $(DESTDIR)$(mandir)/man8/pkg-remove.8.gz

	ln -sf pkg.8.gz $(DESTDIR)$(mandir)/man8/pkg-static.8.gz

	ln -sf pkg-lock.8.gz $(DESTDIR)$(mandir)/man8/pkg-unlock.8.gz

[Makefile.in]

include @builddir@/mk/defs.mk

DIRS=	libblake2 libpicosat liblinenoise libfetch libsqlite libucl liblua libyxml libder libecc

@if libelf-internal

DIRS+=	libelf

@endif

include $(MK)/dir.mk

/* $Id$ */

R1.0 {

global:

	elf32_checksum;

	elf32_fsize;

	elf32_getehdr;

	elf32_getphdr;

	elf32_getshdr;

	elf32_newehdr;

	elf32_newphdr;

	elf32_xlatetof;

	elf32_xlatetom;

	elf64_checksum;

	elf64_fsize;

	elf64_getehdr;

	elf64_getphdr;

	elf64_getshdr;

	elf64_newehdr;

	elf64_newphdr;

	elf64_xlatetof;

	elf64_xlatetom;

	elf_begin;

	elf_cntl;

	elf_end;

	elf_errmsg;

	elf_errno;

	elf_fill;

	elf_flagarhdr;

	elf_flagdata;

	elf_flagehdr;

	elf_flagelf;

	elf_flagphdr;

	elf_flagscn;

	elf_flagshdr;

	elf_getarhdr;

	elf_getarsym;

	elf_getbase;

	elf_getdata;

	elf_getident;

	elf_getphdrnum;

	elf_getphnum;

	elf_getscn;

	elf_getshdrnum;

	elf_getshdrstrndx;

	elf_getshnum;

	elf_getshstrndx;

	elf_hash;

	elf_kind;

	elf_memory;

	elf_ndxscn;

	elf_newdata;

	elf_newscn;

	elf_next;

	elf_nextscn;

	elf_open;

	elf_openmemory;

	elf_rand;

	elf_rawdata;

	elf_rawfile;

	elf_setshstrndx;

	elf_strptr;

	elf_update;

	elf_version;

	gelf_checksum;

	gelf_fsize;

	gelf_getcap;

	gelf_getclass;

	gelf_getdyn;

	gelf_getehdr;

	gelf_getmove;

	gelf_getphdr;

	gelf_getrel;

	gelf_getrela;

	gelf_getshdr;

	gelf_getsym;

	gelf_getsyminfo;

	gelf_getsymshndx;

	gelf_newehdr;

	gelf_newphdr;

	gelf_update_cap;

	gelf_update_dyn;

	gelf_update_ehdr;

	gelf_update_move;

	gelf_update_phdr;

	gelf_update_rel;

	gelf_update_rela;

	gelf_update_shdr;

	gelf_update_sym;

	gelf_update_syminfo;

	gelf_update_symshndx;

	gelf_xlatetof;

	gelf_xlatetom;

local:

	*;

};

/*-

 * Copyright (c) 2009 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.

 *

 * $Id: _elftc.h 2495 2012-04-23 05:31:56Z jkoshy $

 */

/**

 ** Miscellanous definitions needed by multiple components.

 **/

#ifndef	_ELFTC_H

#define	_ELFTC_H

#ifndef	NULL

#define NULL 	((void *) 0)

#endif

#ifndef	offsetof

#define	offsetof(T, M)		((int) &((T*) 0) -> M)

#endif

/* --QUEUE-MACROS-- [[ */

/*

 * Supply macros missing from <sys/queue.h>

 */

/*

 * Copyright (c) 1991, 1993

 *	The Regents of the University of California.  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.

 * 3. Neither the name of the University nor the names of its contributors

 *    may be used to endorse or promote products derived from this software

 *    without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.

 */

#ifndef	STAILQ_CONCAT

#define	STAILQ_CONCAT(head1, head2) do {			\

	if (!STAILQ_EMPTY((head2))) {				\

		*(head1)->stqh_last = (head2)->stqh_first;	\

		(head1)->stqh_last = (head2)->stqh_last;	\

		STAILQ_INIT((head2));				\

	}							\

} while (/*CONSTCOND*/0)

#endif

#ifndef	STAILQ_EMPTY

#define	STAILQ_EMPTY(head)	((head)->stqh_first == NULL)

#endif

#ifndef	STAILQ_ENTRY

#define	STAILQ_ENTRY(type)					\

struct {							\

	struct type *stqe_next;	/* next element */		\

}

#endif

#ifndef	STAILQ_FIRST

#define	STAILQ_FIRST(head)	((head)->stqh_first)

#endif

#ifndef	STAILQ_HEAD

#define	STAILQ_HEAD(name, type)					\

struct name {							\

	struct type *stqh_first; /* first element */		\

	struct type **stqh_last; /* addr of last next element */ \

}

#endif

#ifndef	STAILQ_HEAD_INITIALIZER

#define	STAILQ_HEAD_INITIALIZER(head)				\

	{ NULL, &(head).stqh_first }

#endif

#ifndef	STAILQ_FOREACH

#define	STAILQ_FOREACH(var, head, field)			\

	for ((var) = ((head)->stqh_first);			\

		(var);						\

		(var) = ((var)->field.stqe_next))

#endif

#ifndef	STAILQ_FOREACH_SAFE

#define STAILQ_FOREACH_SAFE(var, head, field, tvar)		\

       for ((var) = STAILQ_FIRST((head));			\

	    (var) && ((tvar) = STAILQ_NEXT((var), field), 1);	\

	    (var) = (tvar))

#endif

#ifndef	STAILQ_INIT

#define	STAILQ_INIT(head) do {					\

	(head)->stqh_first = NULL;				\

	(head)->stqh_last = &(head)->stqh_first;		\

} while (/*CONSTCOND*/0)

#endif

#ifndef	STAILQ_INSERT_HEAD

#define	STAILQ_INSERT_HEAD(head, elm, field) do {			\

	if (((elm)->field.stqe_next = (head)->stqh_first) == NULL)	\

		(head)->stqh_last = &(elm)->field.stqe_next;		\

	(head)->stqh_first = (elm);					\

} while (/*CONSTCOND*/0)

#endif

#ifndef	STAILQ_INSERT_TAIL

#define	STAILQ_INSERT_TAIL(head, elm, field) do {			\

	(elm)->field.stqe_next = NULL;					\

	*(head)->stqh_last = (elm);					\

	(head)->stqh_last = &(elm)->field.stqe_next;			\

} while (/*CONSTCOND*/0)

#endif

#ifndef	STAILQ_INSERT_AFTER

#define	STAILQ_INSERT_AFTER(head, listelm, elm, field) do {		\

	if (((elm)->field.stqe_next = (listelm)->field.stqe_next) == NULL)\

		(head)->stqh_last = &(elm)->field.stqe_next;		\

	(listelm)->field.stqe_next = (elm);				\

} while (/*CONSTCOND*/0)

#endif

#ifndef	STAILQ_LAST

#define STAILQ_LAST(head, type, field)					\

	(STAILQ_EMPTY((head)) ?					\

	    NULL : ((struct type *)(void *)				\

	    ((char *)((head)->stqh_last) - offsetof(struct type, field))))

#endif

#ifndef	STAILQ_NEXT

#define	STAILQ_NEXT(elm, field)	((elm)->field.stqe_next)

#endif

#ifndef	STAILQ_REMOVE

#define	STAILQ_REMOVE(head, elm, type, field) do {			\

	if ((head)->stqh_first == (elm)) {				\

		STAILQ_REMOVE_HEAD((head), field);			\

	} else {							\

		struct type *curelm = (head)->stqh_first;		\

		while (curelm->field.stqe_next != (elm))		\

			curelm = curelm->field.stqe_next;		\

		if ((curelm->field.stqe_next =				\

			curelm->field.stqe_next->field.stqe_next) == NULL) \

			    (head)->stqh_last = &(curelm)->field.stqe_next; \

	}								\

} while (/*CONSTCOND*/0)

#endif

#ifndef	STAILQ_REMOVE_HEAD

#define	STAILQ_REMOVE_HEAD(head, field) do {				\

	if (((head)->stqh_first = (head)->stqh_first->field.stqe_next) == \

	    NULL)							\

		(head)->stqh_last = &(head)->stqh_first;		\

} while (/*CONSTCOND*/0)

#endif

#ifndef	TAILQ_FOREACH_SAFE

#define TAILQ_FOREACH_SAFE(var, head, field, tvar)                      \

	for ((var) = TAILQ_FIRST((head));                               \

	    (var) && ((tvar) = TAILQ_NEXT((var), field), 1);            \

	    (var) = (tvar))

#endif

/* ]] --QUEUE-MACROS-- */

/*

 * VCS Ids.

 */

#ifndef	ELFTC_VCSID

#if defined(__DragonFly__)

#define	ELFTC_VCSID(ID)		__RCSID(ID)

#endif

#if defined(__FreeBSD__)

#define	ELFTC_VCSID(ID)		__FBSDID(ID)

#endif

#if defined(__linux__) || defined(__GNU__) || defined(__GLIBC__) || defined(__APPLE__)

#if defined(__GNUC__)

#define	ELFTC_VCSID(ID)		__asm__(".ident\t\"" ID "\"")

#else

#define	ELFTC_VCSID(ID)		/**/

#endif

#endif

#if defined(__minix)

#if defined(__GNUC__)

#define	ELFTC_VCSID(ID)		__asm__(".ident\t\"" ID "\"")

#else

#define	ELFTC_VCSID(ID)		/**/

#endif	/* __GNU__ */

#endif

#if defined(__NetBSD__)

#define	ELFTC_VCSID(ID)		__RCSID(ID)

#endif

#if defined(__OpenBSD__)

#if defined(__GNUC__)

#define	ELFTC_VCSID(ID)		__asm__(".ident\t\"" ID "\"")

#else

#define	ELFTC_VCSID(ID)		/**/

#endif	/* __GNUC__ */

#endif

#endif	/* ELFTC_VCSID */

/*

 * Provide an equivalent for getprogname(3).

 */

#ifndef	ELFTC_GETPROGNAME

#if defined(__DragonFly__) || defined(__FreeBSD__) || defined(__minix) || \

    defined(__NetBSD__) || defined(__APPLE__)

#include <stdlib.h>

#define	ELFTC_GETPROGNAME()	getprogname()

#endif	/* __DragonFly__ || __FreeBSD__ || __minix || __NetBSD__ */

#if defined(__GLIBC__)

/*

 * GLIBC based systems have a global 'char *' pointer referencing

 * the executable's name.

 */

/* XXX: defined in errno.h

extern const char *program_invocation_short_name;

*/

#define	ELFTC_GETPROGNAME()	program_invocation_short_name

#endif	/* __GLIBC__ */

#if defined(__OpenBSD__)

extern const char *__progname;

#define	ELFTC_GETPROGNAME()	__progname

#endif	/* __OpenBSD__ */

#endif	/* ELFTC_GETPROGNAME */

/**

 ** Per-OS configuration.

 **/

#if defined(__DragonFly__)

#include <osreldate.h>

#include <sys/endian.h>

#define	ELFTC_BYTE_ORDER			_BYTE_ORDER

#define	ELFTC_BYTE_ORDER_LITTLE_ENDIAN		_LITTLE_ENDIAN

#define	ELFTC_BYTE_ORDER_BIG_ENDIAN		_BIG_ENDIAN

#define	ELFTC_HAVE_MMAP				1

#endif

#if defined(__GLIBC__)

#include <endian.h>

#define	ELFTC_BYTE_ORDER			__BYTE_ORDER

#define	ELFTC_BYTE_ORDER_LITTLE_ENDIAN		__LITTLE_ENDIAN

#define	ELFTC_BYTE_ORDER_BIG_ENDIAN		__BIG_ENDIAN

#define	ELFTC_HAVE_MMAP				1

/*

 * Debian GNU/Linux and Debian GNU/kFreeBSD do not have strmode(3).

 */

#define	ELFTC_HAVE_STRMODE			0

/* Whether we need to supply {be,le}32dec. */

#define ELFTC_NEED_BYTEORDER_EXTENSIONS		1

#define	roundup2	roundup

#endif	/* __GLIBC__ */

#if defined(__FreeBSD__)

#include <osreldate.h>

#include <sys/endian.h>

#define	ELFTC_BYTE_ORDER			_BYTE_ORDER

#define	ELFTC_BYTE_ORDER_LITTLE_ENDIAN		_LITTLE_ENDIAN

#define	ELFTC_BYTE_ORDER_BIG_ENDIAN		_BIG_ENDIAN

#define	ELFTC_HAVE_MMAP				1

#define	ELFTC_HAVE_STRMODE			1

#if __FreeBSD_version <= 900000

#define	ELFTC_BROKEN_YY_NO_INPUT		1

#endif

#endif	/* __FreeBSD__ */

#if defined(__minix)

#define	ELFTC_HAVE_MMAP				0

#endif	/* __minix */

#if defined(__NetBSD__) || defined(__APPLE__)

#include <sys/param.h>

#ifndef __APPLE__

#include <sys/endian.h>

#else

#include <machine/endian.h>

#define	roundup2	roundup

#endif

#define	ELFTC_BYTE_ORDER			_BYTE_ORDER

#define	ELFTC_BYTE_ORDER_LITTLE_ENDIAN		_LITTLE_ENDIAN

#define	ELFTC_BYTE_ORDER_BIG_ENDIAN		_BIG_ENDIAN

#define	ELFTC_HAVE_MMAP				1

#define	ELFTC_HAVE_STRMODE			1

#if __NetBSD_Version__ <= 599002100

/* from src/doc/CHANGES: flex(1): Import flex-2.5.35 [christos 20091025] */

/* and 5.99.21 was from Wed Oct 21 21:28:36 2009 UTC */

#  define ELFTC_BROKEN_YY_NO_INPUT		1

#endif

#endif	/* __NetBSD __ */

#if defined(__OpenBSD__)

#include <sys/param.h>

#include <sys/endian.h>

#define	ELFTC_BYTE_ORDER			_BYTE_ORDER

#define	ELFTC_BYTE_ORDER_LITTLE_ENDIAN		_LITTLE_ENDIAN

#define	ELFTC_BYTE_ORDER_BIG_ENDIAN		_BIG_ENDIAN

#define	ELFTC_HAVE_MMAP				1

#define	ELFTC_HAVE_STRMODE			1

#define	ELFTC_NEED_BYTEORDER_EXTENSIONS		1

#define	roundup2	roundup

#endif	/* __OpenBSD__ */

#endif	/* _ELFTC_H */

/*-

 * Copyright (c) 2006,2008-2011 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.

 *

 * $Id$

 */

#ifndef	__LIBELF_H_

#define	__LIBELF_H_

#include <sys/queue.h>

#include "_libelf_config.h"

#include "_elftc.h"

/*

 * 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;

	unsigned char	libelf_msg[LIBELF_MSG_SIZE];

};

extern struct _libelf_globals _libelf;

#define	LIBELF_PRIVATE(N)	(_libelf.libelf_##N)

#define	LIBELF_ELF_ERROR_MASK			0xFF

#define	LIBELF_OS_ERROR_SHIFT			8

#define	LIBELF_ERROR(E, O) (((E) & LIBELF_ELF_ERROR_MASK) |	\

	((O) << LIBELF_OS_ERROR_SHIFT))

#define	LIBELF_SET_ERROR(E, O) do {					\

		LIBELF_PRIVATE(error) = LIBELF_ERROR(ELF_E_##E, (O));	\

	} while (0)

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

/*

 * Flags for library internal use.  These use the upper 16 bits of the

 * `e_flags' field.

 */

#define	LIBELF_F_API_MASK	0x00FFFFU  /* Flags defined by the API. */

#define	LIBELF_F_AR_HEADER	0x010000U  /* translated header available */

#define	LIBELF_F_AR_VARIANT_SVR4 0x020000U /* BSD style ar(1) archive */

#define	LIBELF_F_DATA_MALLOCED	0x040000U /* whether data was malloc'ed */

#define	LIBELF_F_RAWFILE_MALLOC	0x080000U /* whether e_rawfile was malloc'ed */

#define	LIBELF_F_RAWFILE_MMAP	0x100000U /* whether e_rawfile was mmap'ed */

#define	LIBELF_F_SHDRS_LOADED	0x200000U /* whether all shdrs were read in */

#define	LIBELF_F_SPECIAL_FILE	0x400000U /* non-regular file */

struct _Elf {

	int		e_activations;	/* activation count */

	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 */

	unsigned char	*e_rawfile;	/* uninterpreted bytes */

	size_t		e_rawsize;	/* size of uninterpreted bytes */

	unsigned int	e_version;	/* file version */

	/*

	 * Header information for archive members.  See the

	 * LIBELF_F_AR_HEADER flag.

	 */

	union {

		Elf_Arhdr	*e_arhdr;	/* translated header */

		unsigned char	*e_rawhdr;	/* untranslated header */

	} e_hdr;

	union {

		struct {		/* ar(1) archives */

			off_t	e_next;	/* set by elf_rand()/elf_next() */

			int	e_nchildren;

			unsigned char *e_rawstrtab; /* file name strings */

			size_t	e_rawstrtabsz;

			unsigned 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;

};

/*

 * The internal descriptor wrapping the "Elf_Data" type.

 */

struct _Libelf_Data {

	Elf_Data	d_data;		/* The exported descriptor. */

	Elf_Scn		*d_scn;		/* The containing section */

	unsigned int	d_flags;

	STAILQ_ENTRY(_Libelf_Data) d_next;

};

struct _Elf_Scn {

	union {

		Elf32_Shdr	s_shdr32;

		Elf64_Shdr	s_shdr64;

	} s_shdr;

	STAILQ_HEAD(, _Libelf_Data) s_data;	/* translated data */

	STAILQ_HEAD(, _Libelf_Data) s_rawdata;	/* raw data */

	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

};

/*

 * The LIBELF_COPY macros are used to copy fields from a GElf_*

 * structure to their 32-bit counterparts, while checking for out of

 * range values.

 *

 * - LIBELF_COPY_U32 :: copy an unsigned 32 bit field.

 * - LIBELF_COPY_S32 :: copy a signed 32 bit field.

 */

#define	LIBELF_COPY_U32(DST, SRC, NAME)	do {			\

		if ((SRC)->NAME > UINT32_MAX) {			\

			LIBELF_SET_ERROR(RANGE, 0);		\

			return (0);				\

		}						\

		(DST)->NAME = (SRC)->NAME & 0xFFFFFFFFU;	\

	} while (0)

#define	LIBELF_COPY_S32(DST, SRC, NAME)	do {			\

		if ((SRC)->NAME > INT32_MAX ||			\

		    (SRC)->NAME < INT32_MIN) {			\

			LIBELF_SET_ERROR(RANGE, 0);		\

			return (0);				\

		}						\

		(DST)->NAME = (int32_t) (SRC)->NAME;		\

	} while (0)

/*

 * Function Prototypes.

 */

__BEGIN_DECLS

struct _Libelf_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, int _reporterror);

Elf	*_libelf_ar_open_member(int _fd, Elf_Cmd _c, Elf *_ar);

Elf_Arsym *_libelf_ar_process_bsd_symtab(Elf *_ar, size_t *_dst);

Elf_Arsym *_libelf_ar_process_svr4_symtab(Elf *_ar, size_t *_dst);

long	 _libelf_checksum(Elf *_e, int _elfclass);

void	*_libelf_ehdr(Elf *_e, int _elfclass, int _allocate);

unsigned int _libelf_falign(Elf_Type _t, int _elfclass);

size_t	_libelf_fsize(Elf_Type _t, int _elfclass, unsigned int _version,

    size_t count);

int	(*_libelf_get_translator(Elf_Type _t, int _direction, int _elfclass))

	    (unsigned char *_dst, size_t dsz, unsigned 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_load_section_headers(Elf *e, void *ehdr);

unsigned int _libelf_malign(Elf_Type _t, int _elfclass);

Elf	*_libelf_memory(unsigned char *_image, size_t _sz, int _reporterror);

size_t	_libelf_msize(Elf_Type _t, int _elfclass, unsigned int _version);

void	*_libelf_newphdr(Elf *_e, int _elfclass, size_t _count);

Elf	*_libelf_open_object(int _fd, Elf_Cmd _c, int _reporterror);

struct _Libelf_Data *_libelf_release_data(struct _Libelf_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);

__END_DECLS

#endif	/* __LIBELF_H_ */

/*-

 * Copyright (c) 2010 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.

 *

 * $Id$

 */

#ifndef	__LIBELF_AR_H_

#define	__LIBELF_AR_H_

/*

 * Prototypes and declarations needed by libelf's ar(1) archive

 * handling code.

 */

#include <ar.h>

#define	LIBELF_AR_BSD_EXTENDED_NAME_PREFIX	"#1/"

#define	LIBELF_AR_BSD_SYMTAB_NAME		"__.SYMDEF"

#define	LIBELF_AR_BSD_EXTENDED_NAME_PREFIX_SIZE	\

	(sizeof(LIBELF_AR_BSD_EXTENDED_NAME_PREFIX) - 1)

#define	IS_EXTENDED_BSD_NAME(NAME)				\

	(strncmp((const char *) (NAME),				\

	 LIBELF_AR_BSD_EXTENDED_NAME_PREFIX,			\

	 LIBELF_AR_BSD_EXTENDED_NAME_PREFIX_SIZE) == 0)

unsigned char *_libelf_ar_get_string(const char *_buf, size_t _sz,

    unsigned int _rawname, int _svr4names);

char	*_libelf_ar_get_raw_name(const struct ar_hdr *_arh);

char	*_libelf_ar_get_translated_name(const struct ar_hdr *_arh, Elf *_ar);

int	_libelf_ar_get_number(const char *_buf, size_t _sz,

    unsigned int _base, size_t *_ret);

#endif	/* __LIBELF_AR_H_ */

/*-

 * Copyright (c) 2008-2011 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.

 *

 * $Id$

 */

#if defined(__APPLE__) || defined(__DragonFly__)

#if	defined(__amd64__)

#define	LIBELF_ARCH		EM_X86_64

#define	LIBELF_BYTEORDER	ELFDATA2LSB

#define	LIBELF_CLASS		ELFCLASS64

#elif	defined(__i386__)

#define	LIBELF_ARCH		EM_386

#define	LIBELF_BYTEORDER	ELFDATA2LSB

#define	LIBELF_CLASS		ELFCLASS32

#elif   defined(__aarch64__)

#define LIBELF_ARCH             EM_AARCH64

#define LIBELF_BYTEORDER        ELFDATA2LSB

#define LIBELF_CLASS            ELFCLASS64

#endif

#endif	/* __DragonFly__ */

#ifdef __FreeBSD__

/*

 * Define LIBELF_{ARCH,BYTEORDER,CLASS} based on the machine architecture.

 * See also: <machine/elf.h>.

 */

#if	defined(__amd64__)

#define	LIBELF_ARCH		EM_X86_64

#define	LIBELF_BYTEORDER	ELFDATA2LSB

#define	LIBELF_CLASS		ELFCLASS64

#elif	defined(__aarch64__)

#define	LIBELF_ARCH		EM_AARCH64

#define	LIBELF_BYTEORDER	ELFDATA2LSB

#define	LIBELF_CLASS		ELFCLASS64

#elif	defined(__arm__)

#define	LIBELF_ARCH		EM_ARM

#if	defined(__ARMEB__)	/* Big-endian ARM. */

#define	LIBELF_BYTEORDER	ELFDATA2MSB

#else

#define	LIBELF_BYTEORDER	ELFDATA2LSB

#endif

#define	LIBELF_CLASS		ELFCLASS32

#elif	defined(__i386__)

#define	LIBELF_ARCH		EM_386

#define	LIBELF_BYTEORDER	ELFDATA2LSB

#define	LIBELF_CLASS		ELFCLASS32

#elif	defined(__ia64__)

#define	LIBELF_ARCH		EM_IA_64

#define	LIBELF_BYTEORDER	ELFDATA2LSB

#define	LIBELF_CLASS		ELFCLASS64

#elif	defined(__mips__)

#define	LIBELF_ARCH		EM_MIPS

#if	defined(__MIPSEB__)

#define	LIBELF_BYTEORDER	ELFDATA2MSB

#else

#define	LIBELF_BYTEORDER	ELFDATA2LSB

#endif

#define	LIBELF_CLASS		ELFCLASS32

#elif defined(__powerpc64__)

#define LIBELF_ARCH EM_PPC64

#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__

#define LIBELF_BYTEORDER ELFDATA2LSB

#else

#define LIBELF_BYTEORDER ELFDATA2MSB

#endif

#define LIBELF_CLASS ELFCLASS64

#elif	defined(__powerpc__)

#define	LIBELF_ARCH		EM_PPC

#define	LIBELF_BYTEORDER	ELFDATA2MSB

#define	LIBELF_CLASS		ELFCLASS32

#elif	defined(__sparc__)

#define	LIBELF_ARCH		EM_SPARCV9

#define	LIBELF_BYTEORDER	ELFDATA2MSB

#define	LIBELF_CLASS		ELFCLASS64

#else

#error	Unknown FreeBSD architecture.

#endif

#endif  /* __FreeBSD__ */

/*

 * Definitions for Minix3.

 */

#ifdef __minix

#define	LIBELF_ARCH		EM_386

#define	LIBELF_BYTEORDER	ELFDATA2LSB

#define	LIBELF_CLASS		ELFCLASS32

#endif	/* __minix */

#ifdef __NetBSD__

#include <machine/elf_machdep.h>

#if	!defined(ARCH_ELFSIZE)

#error	ARCH_ELFSIZE is not defined.

#endif

#if	ARCH_ELFSIZE == 32

#define	LIBELF_ARCH		ELF32_MACHDEP_ID

#define	LIBELF_BYTEORDER	ELF32_MACHDEP_ENDIANNESS

#define	LIBELF_CLASS		ELFCLASS32

#define	Elf_Note		Elf32_Nhdr

#else

#define	LIBELF_ARCH		ELF64_MACHDEP_ID

#define	LIBELF_BYTEORDER	ELF64_MACHDEP_ENDIANNESS

#define	LIBELF_CLASS		ELFCLASS64

#define	Elf_Note		Elf64_Nhdr

#endif

#endif	/* __NetBSD__ */

#if defined(__OpenBSD__)

#include <machine/exec.h>

#define	LIBELF_ARCH		ELF_TARG_MACH

#define	LIBELF_BYTEORDER	ELF_TARG_DATA

#define	LIBELF_CLASS		ELF_TARG_CLASS

#endif

/*

 * GNU & Linux compatibility.

 *

 * `__linux__' is defined in an environment runs the Linux kernel and glibc.

 * `__GNU__' is defined in an environment runs a GNU kernel (Hurd) and glibc.

 * `__GLIBC__' is defined for an environment that runs glibc over a non-GNU

 *     kernel such as GNU/kFreeBSD.

 */

#if defined(__linux__) || defined(__GNU__) || defined(__GLIBC__)

#if defined(__linux__)

#if    defined(__amd64__)

#define LIBELF_ARCH             EM_X86_64

#define LIBELF_BYTEORDER        ELFDATA2LSB

#define LIBELF_CLASS            ELFCLASS64

#elif   defined(__aarch64__)

#define LIBELF_ARCH             EM_AARCH64

#define LIBELF_BYTEORDER        ELFDATA2LSB

#define LIBELF_CLASS            ELFCLASS64

#elif  defined(__i386__)

#define LIBELF_ARCH             EM_386

#define LIBELF_BYTEORDER        ELFDATA2LSB

#define LIBELF_CLASS            ELFCLASS32

#endif

#endif	/* defined(__linux__) */

#if	LIBELF_CLASS == ELFCLASS32

#define	Elf_Note		Elf32_Nhdr

#elif   LIBELF_CLASS == ELFCLASS64

#define	Elf_Note		Elf64_Nhdr

#else

#error  LIBELF_CLASS needs to be one of ELFCLASS32 or ELFCLASS64

#endif

#endif /* defined(__linux__) || defined(__GNU__) || defined(__GLIBC__) */

.\" Copyright (c) 2006-2008,2011 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 Joseph Koshy ``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 Joseph Koshy 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.

.\"

.\" $Id$

.\"

.Dd July 28, 2014

.Os

.Dt ELF 3

.Sh NAME

.Nm elf

.Nd API for manipulating ELF objects

.Sh LIBRARY

.Lb libelf

.Sh SYNOPSIS

.In libelf.h

.Sh DESCRIPTION

The

.Lb libelf

provides functions that allow an application to read and manipulate

ELF object files, and to read

.Xr ar 1

archives.

The library allows the manipulation of ELF objects in a byte ordering

and word-size independent way, allowing an application to read and

create ELF objects for 32 and 64 bit architectures and for little-

and big-endian machines.

The library is capable of processing ELF objects that use extended

section numbering.

.Pp

This manual page serves to provide an overview of the functionality in

the ELF library.

Further information may found in the manual pages for individual

.Xr ELF 3

functions that comprise the library.

.Ss ELF Concepts

As described in

.Xr elf 5 ,

ELF files contain several data structures that are laid out in a

specific way.

ELF files begin with an

.Dq Executable Header ,

and may contain an optional

.Dq Program Header Table ,

and optional data in the form of ELF

.Dq sections .

A

.Dq Section Header Table

describes the content of the data in these sections.

.Pp

ELF objects have an associated

.Dq "ELF class"

which denotes the natural machine word size for the architecture

the object is associated with.

Objects for 32 bit architectures have an ELF class of

.Dv ELFCLASS32 .

Objects for 64 bit architectures have an ELF class of

.Dv ELFCLASS64 .

.Pp

ELF objects also have an associated

.Dq endianness

which denotes the endianness of the machine architecture associated

with the object.

This may be

.Dv ELFDATA2LSB

for little-endian architectures and

.Dv ELFDATA2MSB

for big-endian architectures.

.Pp

ELF objects are also associated with an API version number.

This version number determines the layout of the individual components

of an ELF file and the semantics associated with these.

.Ss Data Representation And Translation

The

.Xr ELF 3

library distinguishes between

.Dq native

representations of ELF data structures and their

.Dq file

representations.

.Pp

An application would work with ELF data in its

.Dq native

representation, i.e., using the native byteorder and alignment mandated

by the processor the application is running on.

The

.Dq file

representation of the same data could use a different byte ordering

and follow different constraints on object alignment than these native

constraints.

.Pp

Accordingly, the

.Xr ELF 3

library offers translation facilities

.Xr ( elf32_xlatetof 3 ,

.Xr elf32_xlatetom 3 ,

.Xr elf64_xlatetof 3

and

.Xr elf64_xlatetom 3 )

to and from these

representations and also provides higher-level APIs that retrieve and store

data from the ELF object in a transparent manner.

.Ss Library Working Version

Conceptually, there are three version numbers associated with an

application using the ELF library to manipulate ELF objects:

.Bl -bullet -compact -offset indent

.It

The ELF version that the application was compiled against.

This version determines the ABI expected by the application.

.It

The ELF version of the ELF object being manipulated by the

application through the ELF library.

.It

The ELF version (or set of versions) supported by the ELF library itself.

.El

.Pp

In order to facilitate working with ELF objects of differing versions,

the ELF library requires the application to call the

.Fn elf_version

function before invoking many of its operations, in order to inform

the library of the application's desired working version.

.Pp

In the current implementation, all three versions have to be

.Dv EV_CURRENT .

.Ss Namespace use

The ELF library uses the following prefixes:

.Bl -tag -width "ELF_F_*"

.It Dv elf_

Used for class-independent functions.