Mon Jul 8 00:11:15 1996 Roland McGrath <roland@delasyd.gnu.ai.mit.edu>
[kopensolaris-gnu/glibc.git] / sysdeps / i386 / dl-machine.h
1 /* Machine-dependent ELF dynamic relocation inline functions.  i386 version.
2 Copyright (C) 1995, 1996 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with the GNU C Library; see the file COPYING.LIB.  If
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, USA.  */
19
20 #define ELF_MACHINE_NAME "i386"
21
22 #include <assert.h>
23 #include <string.h>
24 #include <link.h>
25
26
27 /* Return nonzero iff E_MACHINE is compatible with the running host.  */
28 static inline int
29 elf_machine_matches_host (Elf32_Half e_machine)
30 {
31   switch (e_machine)
32     {
33     case EM_386:
34     case EM_486:
35       return 1;
36     default:
37       return 0;
38     }
39 }
40
41
42 /* Return the run-time address of the _GLOBAL_OFFSET_TABLE_.
43    Must be inlined in a function which uses global data.  */
44 static inline Elf32_Addr *
45 elf_machine_got (void)
46 {
47   register Elf32_Addr *got asm ("%ebx");
48   return got;
49 }
50
51
52 /* Return the run-time load address of the shared object.  */
53 static inline Elf32_Addr
54 elf_machine_load_address (void)
55 {
56   Elf32_Addr addr;
57   asm ("        call here\n"
58        "here:   popl %0\n"
59        "        subl $here, %0"
60        : "=r" (addr));
61   return addr;
62 }
63 /* The `subl' insn above will contain an R_386_32 relocation entry
64    intended to insert the run-time address of the label `here'.
65    This will be the first relocation in the text of the dynamic linker;
66    we skip it to avoid trying to modify read-only text in this early stage.  */
67 #define ELF_MACHINE_BEFORE_RTLD_RELOC(dynamic_info) \
68   ++(const Elf32_Rel *) (dynamic_info)[DT_REL]->d_un.d_ptr; \
69   (dynamic_info)[DT_RELSZ]->d_un.d_val -= sizeof (Elf32_Rel);
70
71 /* Perform the relocation specified by RELOC and SYM (which is fully resolved).
72    MAP is the object containing the reloc.  */
73
74 static inline void
75 elf_machine_rel (struct link_map *map,
76                  const Elf32_Rel *reloc, const Elf32_Sym *sym,
77                  Elf32_Addr (*resolve) (const Elf32_Sym **ref,
78                                         Elf32_Addr reloc_addr,
79                                         int noplt))
80 {
81   Elf32_Addr *const reloc_addr = (void *) (map->l_addr + reloc->r_offset);
82   Elf32_Addr loadbase;
83
84 #ifdef RTLD_BOOTSTRAP
85 #define RESOLVE(noplt) map->l_addr
86 #else
87 #define RESOLVE(noplt) (*resolve) (&sym, (Elf32_Addr) reloc_addr, noplt)
88 #endif
89
90   switch (ELF32_R_TYPE (reloc->r_info))
91     {
92     case R_386_COPY:
93       loadbase = RESOLVE (0);
94       memcpy (reloc_addr, (void *) (loadbase + sym->st_value), sym->st_size);
95       break;
96     case R_386_GLOB_DAT:
97       loadbase = RESOLVE (0);
98       *reloc_addr = sym ? (loadbase + sym->st_value) : 0;
99       break;
100     case R_386_JMP_SLOT:
101       loadbase = RESOLVE (1);
102       *reloc_addr = sym ? (loadbase + sym->st_value) : 0;
103       break;
104     case R_386_32:
105       {
106         Elf32_Addr undo = 0;
107 #ifndef RTLD_BOOTSTRAP
108         /* This is defined in rtld.c, but nowhere in the static libc.a;
109            make the reference weak so static programs can still link.  This
110            declaration cannot be done when compiling rtld.c (i.e.  #ifdef
111            RTLD_BOOTSTRAP) because rtld.c contains the common defn for
112            _dl_rtld_map, which is incompatible with a weak decl in the same
113            file.  */
114         weak_extern (_dl_rtld_map);
115         if (map == &_dl_rtld_map)
116           /* Undo the relocation done here during bootstrapping.  Now we will
117              relocate it anew, possibly using a binding found in the user
118              program or a loaded library rather than the dynamic linker's
119              built-in definitions used while loading those libraries.  */
120           undo = map->l_addr + sym->st_value;
121 #endif
122         loadbase = RESOLVE (0);
123         *reloc_addr += (sym ? (loadbase + sym->st_value) : 0) - undo;
124         break;
125       }
126     case R_386_RELATIVE:
127       if (!resolve || map != &_dl_rtld_map) /* Already done in rtld itself.  */
128         *reloc_addr += map->l_addr;
129       break;
130     case R_386_PC32:
131       loadbase = RESOLVE (0);
132       *reloc_addr += ((sym ? (loadbase + sym->st_value) : 0) -
133                       (Elf32_Addr) reloc_addr);
134       break;
135     case R_386_NONE:            /* Alright, Wilbur.  */
136       break;
137     default:
138       assert (! "unexpected dynamic reloc type");
139       break;
140     }
141
142 #undef RESOLVE
143 }
144
145 static inline void
146 elf_machine_lazy_rel (struct link_map *map, const Elf32_Rel *reloc)
147 {
148   Elf32_Addr *const reloc_addr = (void *) (map->l_addr + reloc->r_offset);
149   switch (ELF32_R_TYPE (reloc->r_info))
150     {
151     case R_386_JMP_SLOT:
152       *reloc_addr += map->l_addr;
153       break;
154     default:
155       assert (! "unexpected PLT reloc type");
156       break;
157     }
158 }
159
160 /* Nonzero iff TYPE describes relocation of a PLT entry, so
161    PLT entries should not be allowed to define the value.  */
162 #define elf_machine_pltrel_p(type) ((type) == R_386_JMP_SLOT)
163
164 /* The i386 never uses Elf32_Rela relocations.  */
165 #define ELF_MACHINE_NO_RELA 1
166
167
168 /* Set up the loaded object described by L so its unrelocated PLT
169    entries will jump to the on-demand fixup code in dl-runtime.c.  */
170
171 static inline void
172 elf_machine_runtime_setup (struct link_map *l, int lazy)
173 {
174   Elf32_Addr *got;
175   extern void _dl_runtime_resolve (Elf32_Word);
176
177   if (l->l_info[DT_JMPREL] && lazy)
178     {
179       /* The GOT entries for functions in the PLT have not yet been filled
180          in.  Their initial contents will arrange when called to push an
181          offset into the .rel.plt section, push _GLOBAL_OFFSET_TABLE_[1],
182          and then jump to _GLOBAL_OFFSET_TABLE[2].  */
183       got = (Elf32_Addr *) (l->l_addr + l->l_info[DT_PLTGOT]->d_un.d_ptr);
184       got[1] = (Elf32_Addr) l;  /* Identify this shared object.  */
185       /* This function will get called to fix up the GOT entry indicated by
186          the offset on the stack, and then jump to the resolved address.  */
187       got[2] = (Elf32_Addr) &_dl_runtime_resolve;
188     }
189
190   /* This code is used in dl-runtime.c to call the `fixup' function
191      and then redirect to the address it returns.  */
192 #define ELF_MACHINE_RUNTIME_TRAMPOLINE asm ("\
193         .globl _dl_runtime_resolve
194         .type _dl_runtime_resolve, @function
195 _dl_runtime_resolve:
196         call fixup      # Args pushed by PLT.
197         addl $8, %esp   # Pop args.
198         jmp *%eax       # Jump to function address.
199 ");
200 /* The PLT uses Elf32_Rel relocs.  */
201 #define elf_machine_relplt elf_machine_rel
202 }
203
204 /* Mask identifying addresses reserved for the user program,
205    where the dynamic linker should not map anything.  */
206 #define ELF_MACHINE_USER_ADDRESS_MASK   0xf8000000UL
207
208
209
210 /* Initial entry point code for the dynamic linker.
211    The C function `_dl_start' is the real entry point;
212    its return value is the user program's entry point.  */
213
214 #define RTLD_START asm ("\
215 .text\n\
216 .globl _start\n\
217 .globl _dl_start_user\n\
218 _start:\n\
219         pushl %esp\n\
220         call _dl_start\n\
221         popl %ebx\n\
222 _dl_start_user:\n\
223         # Save the user entry point address in %edi.\n\
224         movl %eax, %edi\n\
225         # Point %ebx at the GOT.
226         call 0f\n\
227 0:      popl %ebx\n\
228         addl $_GLOBAL_OFFSET_TABLE_+[.-0b], %ebx\n\
229         # See if we were run as a command with the executable file\n\
230         # name as an extra leading argument.\n\
231         movl _dl_skip_args@GOT(%ebx), %eax\n\
232         movl (%eax),%eax\n\
233         # Pop the original argument count.\n\
234         popl %ecx\n\
235         # Subtract _dl_skip_args from it.\n\
236         subl %eax, %ecx\n\
237         # Adjust the stack pointer to skip _dl_skip_args words.\n\
238         leal (%esp,%eax,4), %esp\n\
239         # Push back the modified argument count.\n\
240         pushl %ecx\n\
241         # Push _dl_default_scope[2] as argument in _dl_init_next call below.\n\
242         movl _dl_default_scope@GOT(%ebx), %eax\n\
243         movl 8(%eax), %esi\n\
244 0:      pushl %esi\n\
245         # Call _dl_init_next to return the address of an initializer\n\
246         # function to run.\n\
247         call _dl_init_next@PLT\n\
248         addl $4, %esp # Pop argument.\n\
249         # Check for zero return, when out of initializers.\n\
250         testl %eax,%eax\n\
251         jz 1f\n\
252         # Call the shared object initializer function.\n\
253         # NOTE: We depend only on the registers (%ebx, %esi and %edi)\n\
254         # and the return address pushed by this call;\n\
255         # the initializer is called with the stack just\n\
256         # as it appears on entry, and it is free to move\n\
257         # the stack around, as long as it winds up jumping to\n\
258         # the return address on the top of the stack.\n\
259         call *%eax\n\
260         # Loop to call _dl_init_next for the next initializer.\n\
261         jmp 0b\n\
262 1:      # Pass our finalizer function to the user in %edx, as per ELF ABI.\n\
263         movl _dl_fini@GOT(%ebx), %edx\n\
264         # Jump to the user's entry point.\n\
265         jmp *%edi\n\
266 ");