Fully synchronize sys/boot from FreeBSD-5.x, but add / to the module path
[dragonfly.git] / sys / cpu / i386 / include / elf.h
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 $
27  * $DragonFly: src/sys/cpu/i386/include/elf.h,v 1.3 2003/11/10 06:12:12 dillon Exp $
28  */
29
30 #ifndef _MACHINE_ELF_H_
31 #define _MACHINE_ELF_H_ 1
32
33 /*
34  * ELF definitions for the i386 architecture.
35  */
36
37 #include <sys/elf32.h>  /* Definitions common to all 32 bit architectures. */
38 #include <sys/elf64.h>  /* Definitions common to all 32 bit architectures. */
39
40 #ifndef __ELF_WORD_SIZE
41 #define __ELF_WORD_SIZE 32      /* Used by <sys/elf_generic.h> */
42 #endif
43
44 #include <sys/elf_generic.h>
45
46 #define ELF_ARCH        EM_386
47
48 #define ELF_MACHINE_OK(x) ((x) == EM_386 || (x) == EM_486)
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
66 #if __ELF_WORD_SIZE == 64
67 /* Fake for amd64 loader support */
68 typedef struct {
69         int fake;
70 } Elf64_Auxinfo;
71 #endif
72
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. */
124
125 #define R_386_COUNT     11      /* Count of defined relocation types. */
126
127 /* Define "machine" characteristics */
128 #define ELF_TARG_CLASS  ELFCLASS32
129 #define ELF_TARG_DATA   ELFDATA2LSB
130 #define ELF_TARG_MACH   EM_386
131 #define ELF_TARG_VER    1
132
133 #ifdef _KERNEL
134
135 /*
136  * On the i386 we load the dynamic linker where a userland call
137  * to mmap(0, ...) would put it.  The rationale behind this
138  * calculation is that it leaves room for the heap to grow to
139  * its maximum allowed size.
140  */
141 #define ELF_RTLD_ADDR(vmspace) \
142     (round_page((vm_offset_t)(vmspace)->vm_daddr + maxdsiz))
143
144 #endif /* _KERNEL */
145 #endif /* !_MACHINE_ELF_H_ */