542c35f190c98070179b2ef2445c340a06f1890b
[kopensolaris-gnu/glibc.git] / sysdeps / i386 / dl-machine.h
1 /* Machine-dependent ELF dynamic relocation inline functions.  i386 version.
2    Copyright (C) 1995, 1996, 1997, 1998 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 not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #ifndef dl_machine_h
21 #define dl_machine_h
22
23 #define ELF_MACHINE_NAME "i386"
24
25 #include <sys/param.h>
26
27 #include <assert.h>
28
29 /* Return nonzero iff E_MACHINE is compatible with the running host.  */
30 static inline int __attribute__ ((unused))
31 elf_machine_matches_host (Elf32_Half e_machine)
32 {
33   switch (e_machine)
34     {
35     case EM_386:
36     case EM_486:
37       return 1;
38     default:
39       return 0;
40     }
41 }
42
43
44 /* Return the link-time address of _DYNAMIC.  Conveniently, this is the
45    first element of the GOT.  This must be inlined in a function which
46    uses global data.  */
47 static inline Elf32_Addr __attribute__ ((unused))
48 elf_machine_dynamic (void)
49 {
50   register Elf32_Addr *got asm ("%ebx");
51   return *got;
52 }
53
54
55 /* Return the run-time load address of the shared object.  */
56 static inline Elf32_Addr __attribute__ ((unused))
57 elf_machine_load_address (void)
58 {
59   Elf32_Addr addr;
60   asm ("leal _dl_start@GOTOFF(%%ebx), %0\n"
61        "subl _dl_start@GOT(%%ebx), %0"
62        : "=r" (addr) : : "cc");
63   return addr;
64 }
65
66 #ifndef PROF
67 /* We add a declaration of this function here so that in dl-runtime.c
68    the ELF_MACHINE_RUNTIME_TRAMPOLINE macro really can pass the parameters
69    in registers.
70
71    We cannot use this scheme for profiling because the _mcount call
72    destroys the passed register information.  */
73 static ElfW(Addr) fixup (struct link_map *l, ElfW(Word) reloc_offset)
74      __attribute__ ((regparm (2), unused));
75 static ElfW(Addr) profile_fixup (struct link_map *l, ElfW(Word) reloc_offset,
76                                  ElfW(Addr) retaddr)
77      __attribute__ ((regparm (3), unused));
78 #endif
79
80 /* Set up the loaded object described by L so its unrelocated PLT
81    entries will jump to the on-demand fixup code in dl-runtime.c.  */
82
83 static inline int __attribute__ ((unused))
84 elf_machine_runtime_setup (struct link_map *l, int lazy, int profile)
85 {
86   Elf32_Addr *got;
87   extern void _dl_runtime_resolve (Elf32_Word);
88   extern void _dl_runtime_profile (Elf32_Word);
89
90   if (l->l_info[DT_JMPREL] && lazy)
91     {
92       /* The GOT entries for functions in the PLT have not yet been filled
93          in.  Their initial contents will arrange when called to push an
94          offset into the .rel.plt section, push _GLOBAL_OFFSET_TABLE_[1],
95          and then jump to _GLOBAL_OFFSET_TABLE[2].  */
96       got = (Elf32_Addr *) (l->l_addr + l->l_info[DT_PLTGOT]->d_un.d_ptr);
97       got[1] = (Elf32_Addr) l;  /* Identify this shared object.  */
98
99       /* The got[2] entry contains the address of a function which gets
100          called to get the address of a so far unresolved function and
101          jump to it.  The profiling extension of the dynamic linker allows
102          to intercept the calls to collect information.  In this case we
103          don't store the address in the GOT so that all future calls also
104          end in this function.  */
105       if (profile)
106         {
107           got[2] = (Elf32_Addr) &_dl_runtime_profile;
108
109           if (_dl_name_match_p (_dl_profile, l))
110             /* This is the object we are looking for.  Say that we really
111                want profiling and the timers are started.  */
112             _dl_profile_map = l;
113         }
114       else
115         /* This function will get called to fix up the GOT entry indicated by
116            the offset on the stack, and then jump to the resolved address.  */
117         got[2] = (Elf32_Addr) &_dl_runtime_resolve;
118     }
119
120   return lazy;
121 }
122
123 /* This code is used in dl-runtime.c to call the `fixup' function
124    and then redirect to the address it returns.  */
125 #ifndef PROF
126 # define ELF_MACHINE_RUNTIME_TRAMPOLINE asm ("\
127         .text
128         .globl _dl_runtime_resolve
129         .type _dl_runtime_resolve, @function
130         .align 16
131 _dl_runtime_resolve:
132         pushl %eax              # Preserve registers otherwise clobbered.
133         pushl %ecx
134         pushl %edx
135         movl 16(%esp), %edx     # Copy args pushed by PLT in register.  Note
136         movl 12(%esp), %eax     # that `fixup' takes its parameters in regs.
137         call fixup              # Call resolver.
138         popl %edx               # Get register content back.
139         popl %ecx
140         xchgl %eax, (%esp)      # Get %eax contents end store function address.
141         ret $8                  # Jump to function address.
142         .size _dl_runtime_resolve, .-_dl_runtime_resolve
143
144         .globl _dl_runtime_profile
145         .type _dl_runtime_profile, @function
146         .align 16
147 _dl_runtime_profile:
148         pushl %eax              # Preserve registers otherwise clobbered.
149         pushl %ecx
150         pushl %edx
151         movl 20(%esp), %ecx     # Load return address
152         movl 16(%esp), %edx     # Copy args pushed by PLT in register.  Note
153         movl 12(%esp), %eax     # that `fixup' takes its parameters in regs.
154         call profile_fixup      # Call resolver.
155         popl %edx               # Get register content back.
156         popl %ecx
157         xchgl %eax, (%esp)      # Get %eax contents end store function address.
158         ret $8                  # Jump to function address.
159         .size _dl_runtime_profile, .-_dl_runtime_profile
160         .previous
161 ");
162 #else
163 # define ELF_MACHINE_RUNTIME_TRAMPOLINE asm ("\
164         .text
165         .globl _dl_runtime_resolve
166         .globl _dl_runtime_profile
167         .type _dl_runtime_resolve, @function
168         .type _dl_runtime_profile, @function
169         .align 16
170 _dl_runtime_resolve:
171 _dl_runtime_profile:
172         pushl %eax              # Preserve registers otherwise clobbered.
173         pushl %ecx
174         pushl %edx
175         movl 16(%esp), %edx     # Push the arguments for `fixup'
176         movl 12(%esp), %eax
177         pushl %edx
178         pushl %eax
179         call fixup              # Call resolver.
180         popl %edx               # Pop the parameters
181         popl %ecx
182         popl %edx               # Get register content back.
183         popl %ecx
184         xchgl %eax, (%esp)      # Get %eax contents end store function address.
185         ret $8                  # Jump to function address.
186         .size _dl_runtime_resolve, .-_dl_runtime_resolve
187         .size _dl_runtime_profile, .-_dl_runtime_profile
188         .previous
189 ");
190 #endif
191
192 /* Mask identifying addresses reserved for the user program,
193    where the dynamic linker should not map anything.  */
194 #define ELF_MACHINE_USER_ADDRESS_MASK   0xf8000000UL
195
196 /* Initial entry point code for the dynamic linker.
197    The C function `_dl_start' is the real entry point;
198    its return value is the user program's entry point.  */
199
200 #define RTLD_START asm ("\
201 .text\n\
202 .globl _start\n\
203 .globl _dl_start_user\n\
204 _start:\n\
205         pushl %esp\n\
206         call _dl_start\n\
207         popl %ebx\n\
208 _dl_start_user:\n\
209         # Save the user entry point address in %edi.\n\
210         movl %eax, %edi\n\
211         # Point %ebx at the GOT.
212         call 0f\n\
213 0:      popl %ebx\n\
214         addl $_GLOBAL_OFFSET_TABLE_+[.-0b], %ebx\n\
215         # Store the highest stack address\n\
216         movl %esp,__libc_stack_end@GOT(%ebx)\n\
217         # See if we were run as a command with the executable file\n\
218         # name as an extra leading argument.\n\
219         movl _dl_skip_args@GOT(%ebx), %eax\n\
220         movl (%eax), %eax\n\
221         # Pop the original argument count.\n\
222         popl %ecx\n\
223         # Subtract _dl_skip_args from it.\n\
224         subl %eax, %ecx\n\
225         # Adjust the stack pointer to skip _dl_skip_args words.\n\
226         leal (%esp,%eax,4), %esp\n\
227         # Push back the modified argument count.\n\
228         pushl %ecx\n\
229         # Push _dl_default_scope[2] as argument in _dl_init_next call below.\n\
230         movl _dl_default_scope@GOT(%ebx), %eax\n\
231         movl 8(%eax), %esi\n\
232 0:      movl %esi,%eax\n\
233         # Call _dl_init_next to return the address of an initializer\n\
234         # function to run.\n\
235         call _dl_init_next@PLT\n\
236         # Check for zero return, when out of initializers.\n\
237         testl %eax, %eax\n\
238         jz 1f\n\
239         # Call the shared object initializer function.\n\
240         # NOTE: We depend only on the registers (%ebx, %esi and %edi)\n\
241         # and the return address pushed by this call;\n\
242         # the initializer is called with the stack just\n\
243         # as it appears on entry, and it is free to move\n\
244         # the stack around, as long as it winds up jumping to\n\
245         # the return address on the top of the stack.\n\
246         call *%eax\n\
247         # Loop to call _dl_init_next for the next initializer.\n\
248         jmp 0b\n\
249 1:      # Clear the startup flag.\n\
250         movl _dl_starting_up@GOT(%ebx), %eax\n\
251         movl $0, (%eax)\n\
252         # Pass our finalizer function to the user in %edx, as per ELF ABI.\n\
253         movl _dl_fini@GOT(%ebx), %edx\n\
254         # Jump to the user's entry point.\n\
255         jmp *%edi\n\
256 .previous\n\
257 ");
258
259 /* Nonzero iff TYPE should not be allowed to resolve to one of
260    the main executable's symbols, as for a COPY reloc.  */
261 #define elf_machine_lookup_noexec_p(type) ((type) == R_386_COPY)
262
263 /* Nonzero iff TYPE describes relocation of a PLT entry, so
264    PLT entries should not be allowed to define the value.  */
265 #define elf_machine_lookup_noplt_p(type) ((type) == R_386_JMP_SLOT)
266
267 /* A reloc type used for ld.so cmdline arg lookups to reject PLT entries.  */
268 #define ELF_MACHINE_JMP_SLOT    R_386_JMP_SLOT
269
270 /* The i386 never uses Elf32_Rela relocations.  */
271 #define ELF_MACHINE_NO_RELA 1
272
273 /* We define an initialization functions.  This is called very early in
274    _dl_sysdep_start.  */
275 #define DL_PLATFORM_INIT dl_platform_init ()
276
277 extern const char *_dl_platform;
278
279 static inline void __attribute__ ((unused))
280 dl_platform_init (void)
281 {
282   if (_dl_platform != NULL && *_dl_platform == '\0')
283     /* Avoid an empty string which would disturb us.  */
284     _dl_platform = NULL;
285 }
286
287 static inline void
288 elf_machine_fixup_plt (struct link_map *map, const Elf32_Rel *reloc,
289                        Elf32_Addr *reloc_addr, Elf32_Addr value)
290 {
291   *reloc_addr = value;
292 }
293
294 /* Return the final value of a plt relocation.  */
295 static inline Elf32_Addr
296 elf_machine_plt_value (struct link_map *map, const Elf32_Rel *reloc,
297                        Elf32_Addr value)
298 {
299   return value;
300 }
301
302 #endif /* !dl_machine_h */
303
304 #ifdef RESOLVE
305
306 /* Perform the relocation specified by RELOC and SYM (which is fully resolved).
307    MAP is the object containing the reloc.  */
308
309 static inline void
310 elf_machine_rel (struct link_map *map, const Elf32_Rel *reloc,
311                  const Elf32_Sym *sym, const struct r_found_version *version,
312                  Elf32_Addr *const reloc_addr)
313 {
314   if (ELF32_R_TYPE (reloc->r_info) == R_386_RELATIVE)
315     {
316 #ifndef RTLD_BOOTSTRAP
317       if (map != &_dl_rtld_map) /* Already done in rtld itself.  */
318 #endif
319         *reloc_addr += map->l_addr;
320     }
321   else if (ELF32_R_TYPE (reloc->r_info) != R_386_NONE)
322     {
323       const Elf32_Sym *const refsym = sym;
324       Elf32_Addr value = RESOLVE (&sym, version, ELF32_R_TYPE (reloc->r_info));
325       if (sym)
326         value += sym->st_value;
327
328       switch (ELF32_R_TYPE (reloc->r_info))
329         {
330         case R_386_COPY:
331           if (sym == NULL)
332             /* This can happen in trace mode if an object could not be
333                found.  */
334             break;
335           if (sym->st_size > refsym->st_size
336               || (_dl_verbose && sym->st_size < refsym->st_size))
337             {
338               const char *strtab;
339
340               strtab = ((const char *) map->l_addr
341                         + map->l_info[DT_STRTAB]->d_un.d_ptr);
342               _dl_sysdep_error (_dl_argv[0] ?: "<program name unknown>",
343                                 ": Symbol `", strtab + refsym->st_name,
344                                 "' has different size in shared object, "
345                                 "consider re-linking\n", NULL);
346             }
347           memcpy (reloc_addr, (void *) value, MIN (sym->st_size,
348                                                    refsym->st_size));
349           break;
350         case R_386_GLOB_DAT:
351         case R_386_JMP_SLOT:
352           *reloc_addr = value;
353           break;
354         case R_386_32:
355           {
356 #ifndef RTLD_BOOTSTRAP
357            /* This is defined in rtld.c, but nowhere in the static
358               libc.a; make the reference weak so static programs can
359               still link.  This declaration cannot be done when
360               compiling rtld.c (i.e.  #ifdef RTLD_BOOTSTRAP) because
361               rtld.c contains the common defn for _dl_rtld_map, which
362               is incompatible with a weak decl in the same file.  */
363             weak_extern (_dl_rtld_map);
364             if (map == &_dl_rtld_map)
365               /* Undo the relocation done here during bootstrapping.
366                  Now we will relocate it anew, possibly using a
367                  binding found in the user program or a loaded library
368                  rather than the dynamic linker's built-in definitions
369                  used while loading those libraries.  */
370               value -= map->l_addr + refsym->st_value;
371 #endif
372             *reloc_addr += value;
373             break;
374           }
375         case R_386_PC32:
376           *reloc_addr += (value - (Elf32_Addr) reloc_addr);
377           break;
378         default:
379           assert (! "unexpected dynamic reloc type");
380           break;
381         }
382     }
383 }
384
385 static inline void
386 elf_machine_lazy_rel (struct link_map *map, const Elf32_Rel *reloc)
387 {
388   Elf32_Addr *const reloc_addr = (void *) (map->l_addr + reloc->r_offset);
389   switch (ELF32_R_TYPE (reloc->r_info))
390     {
391     case R_386_JMP_SLOT:
392       *reloc_addr += map->l_addr;
393       break;
394     default:
395       assert (! "unexpected PLT reloc type");
396       break;
397     }
398 }
399
400 #endif /* RESOLVE */