[dragonfly.git] / sys / cpu / i386 / include / elf.h

/*-
 * Copyright (c) 1996-1997 John D. Polstra.
 * 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/sys/i386/include/elf.h,v 1.9.2.1 2001/11/03 01:41:08 ps Exp $
 * $DragonFly: src/sys/cpu/i386/include/elf.h,v 1.8 2006/11/07 06:43:22 dillon Exp $
 */

#ifndef _CPU_ELF_H_
#define _CPU_ELF_H_

/*
 * ELF definitions for the i386 architecture.
 */

#include <sys/elf32.h>	/* Definitions common to all 32 bit architectures. */
#include <sys/elf64.h>	/* Definitions common to all 64 bit architectures. */

#ifndef __ELF_WORD_SIZE
#define __ELF_WORD_SIZE	32	/* Used by <sys/elf_generic.h> */
#endif

#include <sys/elf_generic.h>

#define ELF_ARCH	EM_386

#define ELF_MACHINE_OK(x) ((x) == EM_386)

/*
 * Auxiliary vector entries for passing information to the interpreter.
 *
 * The i386 supplement to the SVR4 ABI specification names this "auxv_t",
 * but POSIX lays claim to all symbols ending with "_t".
 */

typedef struct {	/* Auxiliary vector entry on initial stack */
	int	a_type;			/* Entry type. */
	union {
		long	a_val;		/* Integer value. */
		void	*a_ptr;		/* Address. */
		void	(*a_fcn)(void);	/* Function pointer (not used). */
	} a_un;
} Elf32_Auxinfo;

#if __ELF_WORD_SIZE == 64
/* Fake for x86_64 loader support */
typedef struct {
        int fake;
} Elf64_Auxinfo;
#endif

__ElfType(Auxinfo);

/* Values for a_type. */
#define AT_NULL		0	/* Terminates the vector. */
#define AT_IGNORE	1	/* Ignored entry. */
#define AT_EXECFD	2	/* File descriptor of program to load. */
#define AT_PHDR		3	/* Program header of program already loaded. */
#define AT_PHENT	4	/* Size of each program header entry. */
#define AT_PHNUM	5	/* Number of program header entries. */
#define AT_PAGESZ	6	/* Page size in bytes. */
#define AT_BASE		7	/* Interpreter's base address. */
#define AT_FLAGS	8	/* Flags (unused for i386). */
#define AT_ENTRY	9	/* Where interpreter should transfer control. */

/*
 * The following non-standard values are used for passing information
 * from John Polstra's testbed program to the dynamic linker.  These
 * are expected to go away soon.
 *
 * Unfortunately, these overlap the Linux non-standard values, so they
 * must not be used in the same context.
 */
#define AT_BRK		10	/* Starting point for sbrk and brk. */
#define AT_DEBUG	11	/* Debugging level. */

/*
 * The following non-standard values are used in Linux ELF binaries.
 */
#define AT_NOTELF	10	/* Program is not ELF ?? */
#define AT_UID		11	/* Real uid. */
#define AT_EUID		12	/* Effective uid. */
#define AT_GID		13	/* Real gid. */
#define AT_EGID		14	/* Effective gid. */

#define AT_COUNT	15	/* Count of defined aux entry types. */

/*
 * Relocation types.
 */

#define R_386_NONE	0	/* No relocation. */
#define R_386_32	1	/* Add symbol value. */
#define R_386_PC32	2	/* Add PC-relative symbol value. */
#define R_386_GOT32	3	/* Add PC-relative GOT offset. */
#define R_386_PLT32	4	/* Add PC-relative PLT offset. */
#define R_386_COPY	5	/* Copy data from shared object. */
#define R_386_GLOB_DAT	6	/* Set GOT entry to data address. */
#define R_386_JMP_SLOT	7	/* Set GOT entry to code address. */
#define R_386_RELATIVE	8	/* Add load address of shared object. */
#define R_386_GOTOFF	9	/* Add GOT-relative symbol address. */
#define R_386_GOTPC	10	/* Add PC-relative GOT table address. */
#define R_386_TLS_TPOFF	14	/* Negative offset in static TLS block */
#define R_386_TLS_IE	15	/* Absolute address of GOT for -ve static TLS */
#define R_386_TLS_GOTIE	16	/* GOT entry for negative static TLS block */
#define R_386_TLS_LE	17	/* Negative offset relative to static TLS */
#define R_386_TLS_GD	18	/* 32 bit offset to GOT (index,off) pair */
#define R_386_TLS_LDM	19	/* 32 bit offset to GOT (index,zero) pair */
#define R_386_TLS_GD_32	24	/* 32 bit offset to GOT (index,off) pair */
#define R_386_TLS_GD_PUSH 25	/* pushl instruction for Sun ABI GD sequence */
#define R_386_TLS_GD_CALL 26	/* call instruction for Sun ABI GD sequence */
#define R_386_TLS_GD_POP 27	/* popl instruction for Sun ABI GD sequence */
#define R_386_TLS_LDM_32 28	/* 32 bit offset to GOT (index,zero) pair */
#define R_386_TLS_LDM_PUSH 29	/* pushl instruction for Sun ABI LD sequence */
#define R_386_TLS_LDM_CALL 30	/* call instruction for Sun ABI LD sequence */
#define R_386_TLS_LDM_POP 31	/* popl instruction for Sun ABI LD sequence */
#define R_386_TLS_LDO_32 32	/* 32 bit offset from start of TLS block */
#define R_386_TLS_IE_32	33	/* 32 bit offset to GOT static TLS offset entry */
#define R_386_TLS_LE_32	34	/* 32 bit offset within static TLS block */
#define R_386_TLS_DTPMOD32 35	/* GOT entry containing TLS index */
#define R_386_TLS_DTPOFF32 36	/* GOT entry containing TLS offset */
#define R_386_TLS_TPOFF32 37	/* GOT entry of -ve static TLS offset */

#define R_386_COUNT	38	/* Count of defined relocation types. */

/* Define "machine" characteristics */
#define ELF_TARG_CLASS	ELFCLASS32
#define ELF_TARG_DATA	ELFDATA2LSB
#define ELF_TARG_MACH	EM_386
#define ELF_TARG_VER	1

#ifdef _KERNEL

/*
 * On the i386 we load the dynamic linker where a userland call
 * to mmap(0, ...) would put it.  The rationale behind this
 * calculation is that it leaves room for the heap to grow to
 * its maximum allowed size.
 */
#define ELF_RTLD_ADDR(vmspace) \
    (round_page((vm_offset_t)(vmspace)->vm_daddr + maxdsiz))

#endif /* _KERNEL */
#endif /* !_CPU_ELF_H_ */
Commit	Line	Data
984263bc MD	1	/*-
	2	* Copyright (c) 1996-1997 John D. Polstra.
	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	* $FreeBSD: src/sys/i386/include/elf.h,v 1.9.2.1 2001/11/03 01:41:08 ps Exp $
a9295349	27	* $DragonFly: src/sys/cpu/i386/include/elf.h,v 1.8 2006/11/07 06:43:22 dillon Exp $
984263bc MD	28	*/
984263bc MD	29
a9295349 MD	30	#ifndef _CPU_ELF_H_
a9295349 MD	31	#define _CPU_ELF_H_
984263bc MD	32
	33	/*
	34	* ELF definitions for the i386 architecture.
	35	*/
	36
	37	#include <sys/elf32.h> /* Definitions common to all 32 bit architectures. */
88dec172	38	#include <sys/elf64.h> /* Definitions common to all 64 bit architectures. */
984263bc	39
dc62b251	40	#ifndef __ELF_WORD_SIZE
984263bc	41	#define __ELF_WORD_SIZE 32 /* Used by <sys/elf_generic.h> */
dc62b251 MD	42	#endif
dc62b251 MD	43
984263bc MD	44	#include <sys/elf_generic.h>
	45
	46	#define ELF_ARCH EM_386
	47
18cdf88c	48	#define ELF_MACHINE_OK(x) ((x) == EM_386)
984263bc MD	49
	50	/*
	51	* Auxiliary vector entries for passing information to the interpreter.
	52	*
	53	* The i386 supplement to the SVR4 ABI specification names this "auxv_t",
	54	* but POSIX lays claim to all symbols ending with "_t".
	55	*/
	56
	57	typedef struct { /* Auxiliary vector entry on initial stack */
	58	int a_type; /* Entry type. */
	59	union {
	60	long a_val; /* Integer value. */
	61	void a_ptr; / Address. */
	62	void (a_fcn)(void); / Function pointer (not used). */
	63	} a_un;
	64	} Elf32_Auxinfo;
	65
dc62b251	66	#if __ELF_WORD_SIZE == 64
c1543a89	67	/* Fake for x86_64 loader support */
dc62b251 MD	68	typedef struct {
	69	int fake;
	70	} Elf64_Auxinfo;
	71	#endif
	72
984263bc MD	73	__ElfType(Auxinfo);
	74
	75	/* Values for a_type. */
	76	#define AT_NULL 0 /* Terminates the vector. */
	77	#define AT_IGNORE 1 /* Ignored entry. */
	78	#define AT_EXECFD 2 /* File descriptor of program to load. */
	79	#define AT_PHDR 3 /* Program header of program already loaded. */
	80	#define AT_PHENT 4 /* Size of each program header entry. */
	81	#define AT_PHNUM 5 /* Number of program header entries. */
	82	#define AT_PAGESZ 6 /* Page size in bytes. */
	83	#define AT_BASE 7 /* Interpreter's base address. */
	84	#define AT_FLAGS 8 /* Flags (unused for i386). */
	85	#define AT_ENTRY 9 /* Where interpreter should transfer control. */
	86
	87	/*
	88	* The following non-standard values are used for passing information
	89	* from John Polstra's testbed program to the dynamic linker. These
	90	* are expected to go away soon.
	91	*
	92	* Unfortunately, these overlap the Linux non-standard values, so they
	93	* must not be used in the same context.
	94	*/
	95	#define AT_BRK 10 /* Starting point for sbrk and brk. */
	96	#define AT_DEBUG 11 /* Debugging level. */
	97
	98	/*
	99	* The following non-standard values are used in Linux ELF binaries.
	100	*/
	101	#define AT_NOTELF 10 /* Program is not ELF ?? */
	102	#define AT_UID 11 /* Real uid. */
	103	#define AT_EUID 12 /* Effective uid. */
	104	#define AT_GID 13 /* Real gid. */
	105	#define AT_EGID 14 /* Effective gid. */
	106
	107	#define AT_COUNT 15 /* Count of defined aux entry types. */
	108
	109	/*
	110	* Relocation types.
	111	*/
	112
	113	#define R_386_NONE 0 /* No relocation. */
	114	#define R_386_32 1 /* Add symbol value. */
	115	#define R_386_PC32 2 /* Add PC-relative symbol value. */
	116	#define R_386_GOT32 3 /* Add PC-relative GOT offset. */
	117	#define R_386_PLT32 4 /* Add PC-relative PLT offset. */
	118	#define R_386_COPY 5 /* Copy data from shared object. */
	119	#define R_386_GLOB_DAT 6 /* Set GOT entry to data address. */
	120	#define R_386_JMP_SLOT 7 /* Set GOT entry to code address. */
	121	#define R_386_RELATIVE 8 /* Add load address of shared object. */
	122	#define R_386_GOTOFF 9 /* Add GOT-relative symbol address. */
	123	#define R_386_GOTPC 10 /* Add PC-relative GOT table address. */
b561add2 DX	124	#define R_386_TLS_TPOFF 14 /* Negative offset in static TLS block */
	125	#define R_386_TLS_IE 15 /* Absolute address of GOT for -ve static TLS */
	126	#define R_386_TLS_GOTIE 16 /* GOT entry for negative static TLS block */
	127	#define R_386_TLS_LE 17 /* Negative offset relative to static TLS */
	128	#define R_386_TLS_GD 18 /* 32 bit offset to GOT (index,off) pair */
	129	#define R_386_TLS_LDM 19 /* 32 bit offset to GOT (index,zero) pair */
	130	#define R_386_TLS_GD_32 24 /* 32 bit offset to GOT (index,off) pair */
	131	#define R_386_TLS_GD_PUSH 25 /* pushl instruction for Sun ABI GD sequence */
	132	#define R_386_TLS_GD_CALL 26 /* call instruction for Sun ABI GD sequence */
	133	#define R_386_TLS_GD_POP 27 /* popl instruction for Sun ABI GD sequence */
	134	#define R_386_TLS_LDM_32 28 /* 32 bit offset to GOT (index,zero) pair */
	135	#define R_386_TLS_LDM_PUSH 29 /* pushl instruction for Sun ABI LD sequence */
	136	#define R_386_TLS_LDM_CALL 30 /* call instruction for Sun ABI LD sequence */
	137	#define R_386_TLS_LDM_POP 31 /* popl instruction for Sun ABI LD sequence */
	138	#define R_386_TLS_LDO_32 32 /* 32 bit offset from start of TLS block */
	139	#define R_386_TLS_IE_32 33 /* 32 bit offset to GOT static TLS offset entry */
	140	#define R_386_TLS_LE_32 34 /* 32 bit offset within static TLS block */
	141	#define R_386_TLS_DTPMOD32 35 /* GOT entry containing TLS index */
	142	#define R_386_TLS_DTPOFF32 36 /* GOT entry containing TLS offset */
	143	#define R_386_TLS_TPOFF32 37 /* GOT entry of -ve static TLS offset */
	144
	145	#define R_386_COUNT 38 /* Count of defined relocation types. */
984263bc MD	146
	147	/* Define "machine" characteristics */
	148	#define ELF_TARG_CLASS ELFCLASS32
	149	#define ELF_TARG_DATA ELFDATA2LSB
	150	#define ELF_TARG_MACH EM_386
	151	#define ELF_TARG_VER 1
	152
	153	#ifdef _KERNEL
	154
	155	/*
	156	* On the i386 we load the dynamic linker where a userland call
	157	* to mmap(0, ...) would put it. The rationale behind this
	158	* calculation is that it leaves room for the heap to grow to
	159	* its maximum allowed size.
	160	*/
	161	#define ELF_RTLD_ADDR(vmspace) \
	162	(round_page((vm_offset_t)(vmspace)->vm_daddr + maxdsiz))
	163
	164	#endif /* _KERNEL */
a9295349	165	#endif /* !_CPU_ELF_H_ */