xref: /freebsd/sys/amd64/include/elf.h (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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$
27  */
28 
29 #ifndef _MACHINE_ELF_H_
30 #define	_MACHINE_ELF_H_ 1
31 
32 /*
33  * ELF definitions for the AMD64 architecture.
34  */
35 
36 
37 #ifndef __ELF_WORD_SIZE
38 #define	__ELF_WORD_SIZE	64	/* Used by <sys/elf_generic.h> */
39 #endif
40 #include <sys/elf32.h>	/* Definitions common to all 32 bit architectures. */
41 #include <sys/elf64.h>	/* Definitions common to all 64 bit architectures. */
42 #include <sys/elf_generic.h>
43 
44 #define	ELF_ARCH	EM_X86_64
45 
46 #define	ELF_MACHINE_OK(x) ((x) == EM_X86_64)
47 
48 /*
49  * Auxiliary vector entries for passing information to the interpreter.
50  *
51  * The i386 supplement to the SVR4 ABI specification names this "auxv_t",
52  * but POSIX lays claim to all symbols ending with "_t".
53  */
54 typedef struct {	/* Auxiliary vector entry on initial stack */
55 	int	a_type;			/* Entry type. */
56 	union {
57 		int	a_val;		/* Integer value. */
58 	} a_un;
59 } Elf32_Auxinfo;
60 
61 
62 typedef struct {	/* Auxiliary vector entry on initial stack */
63 	long	a_type;			/* Entry type. */
64 	union {
65 		long	a_val;		/* Integer value. */
66 		void	*a_ptr;		/* Address. */
67 		void	(*a_fcn)(void);	/* Function pointer (not used). */
68 	} a_un;
69 } Elf64_Auxinfo;
70 
71 __ElfType(Auxinfo);
72 
73 /* Values for a_type. */
74 #define	AT_NULL		0	/* Terminates the vector. */
75 #define	AT_IGNORE	1	/* Ignored entry. */
76 #define	AT_EXECFD	2	/* File descriptor of program to load. */
77 #define	AT_PHDR		3	/* Program header of program already loaded. */
78 #define	AT_PHENT	4	/* Size of each program header entry. */
79 #define	AT_PHNUM	5	/* Number of program header entries. */
80 #define	AT_PAGESZ	6	/* Page size in bytes. */
81 #define	AT_BASE		7	/* Interpreter's base address. */
82 #define	AT_FLAGS	8	/* Flags (unused for i386). */
83 #define	AT_ENTRY	9	/* Where interpreter should transfer control. */
84 
85 /*
86  * The following non-standard values are used for passing information
87  * from John Polstra's testbed program to the dynamic linker.  These
88  * are expected to go away soon.
89  *
90  * Unfortunately, these overlap the Linux non-standard values, so they
91  * must not be used in the same context.
92  */
93 #define	AT_BRK		10	/* Starting point for sbrk and brk. */
94 #define	AT_DEBUG	11	/* Debugging level. */
95 
96 /*
97  * The following non-standard values are used in Linux ELF binaries.
98  */
99 #define	AT_NOTELF	10	/* Program is not ELF ?? */
100 #define	AT_UID		11	/* Real uid. */
101 #define	AT_EUID		12	/* Effective uid. */
102 #define	AT_GID		13	/* Real gid. */
103 #define	AT_EGID		14	/* Effective gid. */
104 
105 #define	AT_COUNT	15	/* Count of defined aux entry types. */
106 
107 /*
108  * Relocation types.
109  */
110 
111 #define	R_X86_64_COUNT	24	/* Count of defined relocation types. */
112 
113 /* Define "machine" characteristics */
114 #if __ELF_WORD_SIZE == 32
115 #define ELF_TARG_CLASS  ELFCLASS32
116 #else
117 #define ELF_TARG_CLASS  ELFCLASS64
118 #endif
119 #define	ELF_TARG_DATA	ELFDATA2LSB
120 #define	ELF_TARG_MACH	EM_X86_64
121 #define	ELF_TARG_VER	1
122 
123 #endif /* !_MACHINE_ELF_H_ */
124