2007-07-21 Samuel Thibault <samuel.thibault@ens-lyon.org>
[kopensolaris-gnu/glibc.git] / sysdeps / s390 / s390-32 / dl-machine.h
1 /* Machine-dependent ELF dynamic relocation inline functions.  S390 Version.
2    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006
3    Free Software Foundation, Inc.
4    Contributed by Carl Pederson & Martin Schwidefsky.
5    This file is part of the GNU C Library.
6
7    The GNU C Library is free software; you can redistribute it and/or
8    modify it under the terms of the GNU Lesser General Public
9    License as published by the Free Software Foundation; either
10    version 2.1 of the License, or (at your option) any later version.
11
12    The GNU C Library is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Lesser General Public License for more details.
16
17    You should have received a copy of the GNU Lesser General Public
18    License along with the GNU C Library; if not, write to the Free
19    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
20    02111-1307 USA.  */
21
22 #ifndef dl_machine_h
23 #define dl_machine_h
24
25 #define ELF_MACHINE_NAME "s390"
26
27 #include <sys/param.h>
28 #include <string.h>
29 #include <link.h>
30
31 /* This is an older, now obsolete value.  */
32 #define EM_S390_OLD     0xA390
33
34 /* Return nonzero iff ELF header is compatible with the running host.  */
35 static inline int
36 elf_machine_matches_host (const Elf32_Ehdr *ehdr)
37 {
38   return (ehdr->e_machine == EM_S390 || ehdr->e_machine == EM_S390_OLD)
39          && ehdr->e_ident[EI_CLASS] == ELFCLASS32;
40 }
41
42
43 /* Return the link-time address of _DYNAMIC.  Conveniently, this is the
44    first element of the GOT.  This must be inlined in a function which
45    uses global data.  */
46
47 static inline Elf32_Addr
48 elf_machine_dynamic (void)
49 {
50   register Elf32_Addr *got;
51
52   asm( "        bras   %0,2f\n"
53        "1:      .long  _GLOBAL_OFFSET_TABLE_-1b\n"
54        "2:      al     %0,0(%0)"
55        : "=&a" (got) : : "0" );
56
57   return *got;
58 }
59
60
61 /* Return the run-time load address of the shared object.  */
62 static inline Elf32_Addr
63 elf_machine_load_address (void)
64 {
65   Elf32_Addr addr;
66
67   asm( "   bras  1,2f\n"
68        "1: .long _GLOBAL_OFFSET_TABLE_ - 1b\n"
69        "   .long _dl_start - 1b - 0x80000000\n"
70        "2: l     %0,4(1)\n"
71        "   ar    %0,1\n"
72        "   al    1,0(1)\n"
73        "   sl    %0,_dl_start@GOT12(1)"
74        : "=&d" (addr) : : "1" );
75   return addr;
76 }
77
78 /* Set up the loaded object described by L so its unrelocated PLT
79    entries will jump to the on-demand fixup code in dl-runtime.c.  */
80
81 static inline int __attribute__ ((unused))
82 elf_machine_runtime_setup (struct link_map *l, int lazy, int profile)
83 {
84   extern void _dl_runtime_resolve (Elf32_Word);
85   extern void _dl_runtime_profile (Elf32_Word);
86
87   if (l->l_info[DT_JMPREL] && lazy)
88     {
89       /* The GOT entries for functions in the PLT have not yet been filled
90          in.  Their initial contents will arrange when called to push an
91          offset into the .rel.plt section, push _GLOBAL_OFFSET_TABLE_[1],
92          and then jump to _GLOBAL_OFFSET_TABLE[2].  */
93       Elf32_Addr *got;
94       got = (Elf32_Addr *) D_PTR (l, l_info[DT_PLTGOT]);
95       /* If a library is prelinked but we have to relocate anyway,
96          we have to be able to undo the prelinking of .got.plt.
97          The prelinker saved us here address of .plt + 0x2c.  */
98       if (got[1])
99         {
100           l->l_mach.plt = got[1] + l->l_addr;
101           l->l_mach.gotplt = (Elf32_Addr) &got[3];
102         }
103       got[1] = (Elf32_Addr) l;  /* Identify this shared object.  */
104
105       /* The got[2] entry contains the address of a function which gets
106          called to get the address of a so far unresolved function and
107          jump to it.  The profiling extension of the dynamic linker allows
108          to intercept the calls to collect information.  In this case we
109          don't store the address in the GOT so that all future calls also
110          end in this function.  */
111       if (__builtin_expect (profile, 0))
112         {
113           got[2] = (Elf32_Addr) &_dl_runtime_profile;
114
115           if (GLRO(dl_profile) != NULL
116               && _dl_name_match_p (GLRO(dl_profile), l))
117             /* This is the object we are looking for.  Say that we really
118                want profiling and the timers are started.  */
119             GL(dl_profile_map) = l;
120         }
121       else
122         /* This function will get called to fix up the GOT entry indicated by
123            the offset on the stack, and then jump to the resolved address.  */
124         got[2] = (Elf32_Addr) &_dl_runtime_resolve;
125     }
126
127   return lazy;
128 }
129
130 /* Mask identifying addresses reserved for the user program,
131    where the dynamic linker should not map anything.  */
132 #define ELF_MACHINE_USER_ADDRESS_MASK   0xf8000000UL
133
134 /* Initial entry point code for the dynamic linker.
135    The C function `_dl_start' is the real entry point;
136    its return value is the user program's entry point.  */
137
138 #define RTLD_START asm ("\n\
139 .text\n\
140 .align 4\n\
141 .globl _start\n\
142 .globl _dl_start_user\n\
143 _start:\n\
144         basr  %r13,0\n\
145 .L0:    ahi   %r13,.Llit-.L0\n\
146         lr    %r2,%r15\n\
147         # Alloc stack frame\n\
148         ahi   %r15,-96\n\
149         # Set the back chain to zero\n\
150         xc    0(4,%r15),0(%r15)\n\
151         # Call _dl_start with %r2 pointing to arg on stack\n\
152         l     %r14,.Ladr1-.Llit(%r13)\n\
153         bas   %r14,0(%r14,%r13)   # call _dl_start\n\
154 _dl_start_user:\n\
155         # Save the user entry point address in %r8.\n\
156         lr    %r8,%r2\n\
157         # Point %r12 at the GOT.\n\
158         l     %r12,.Ladr0-.Llit(%r13)\n\
159         ar    %r12,%r13\n\
160         # See if we were run as a command with the executable file\n\
161         # name as an extra leading argument.\n\
162         l     %r1,_dl_skip_args@GOT12(0,%r12)\n\
163         l     %r1,0(%r1)          # load _dl_skip_args\n\
164         # Get the original argument count.\n\
165         l     %r0,96(%r15)\n\
166         # Subtract _dl_skip_args from it.\n\
167         sr    %r0,%r1\n\
168         # Adjust the stack pointer to skip _dl_skip_args words.\n\
169         sll   %r1,2\n\
170         ar    %r15,%r1\n\
171         # Set the back chain to zero again\n\
172         xc    0(4,%r15),0(%r15)\n\
173         # Store back the modified argument count.\n\
174         st    %r0,96(%r15)\n\
175         # The special initializer gets called with the stack just\n\
176         # as the application's entry point will see it; it can\n\
177         # switch stacks if it moves these contents over.\n\
178 " RTLD_START_SPECIAL_INIT "\n\
179         # Call the function to run the initializers.\n\
180         # Load the parameters:\n\
181         # (%r2, %r3, %r4, %r5) = (_dl_loaded, argc, argv, envp)\n\
182         l     %r2,_rtld_local@GOT(%r12)\n\
183         l     %r2,0(%r2)\n\
184         l     %r3,96(%r15)\n\
185         la    %r4,100(%r15)\n\
186         lr    %r5,%r3\n\
187         sll   %r5,2\n\
188         la    %r5,104(%r5,%r15)\n\
189         l     %r1,.Ladr4-.Llit(%r13)\n\
190         bas   %r14,0(%r1,%r13)\n\
191         # Pass our finalizer function to the user in %r14, as per ELF ABI.\n\
192         l     %r14,_dl_fini@GOT(%r12)\n\
193         # Free stack frame\n\
194         ahi   %r15,96\n\
195         # Jump to the user's entry point (saved in %r8).\n\
196         br    %r8\n\
197 .Llit:\n\
198 .Ladr0: .long _GLOBAL_OFFSET_TABLE_-.Llit\n\
199 .Ladr1: .long _dl_start-.Llit\n\
200 .Ladr4: .long _dl_init_internal@PLT-.Llit\n\
201 ");
202
203 #ifndef RTLD_START_SPECIAL_INIT
204 #define RTLD_START_SPECIAL_INIT /* nothing */
205 #endif
206
207 /* ELF_RTYPE_CLASS_PLT iff TYPE describes relocation of a PLT entry or
208    TLS variable, so undefined references should not be allowed to
209    define the value.
210    ELF_RTYPE_CLASS_NOCOPY iff TYPE should not be allowed to resolve to one
211    of the main executable's symbols, as for a COPY reloc.  */
212 #define elf_machine_type_class(type) \
213   ((((type) == R_390_JMP_SLOT || (type) == R_390_TLS_DTPMOD                   \
214      || (type) == R_390_TLS_DTPOFF || (type) == R_390_TLS_TPOFF)              \
215     * ELF_RTYPE_CLASS_PLT)                                                    \
216    | (((type) == R_390_COPY) * ELF_RTYPE_CLASS_COPY))
217
218 /* A reloc type used for ld.so cmdline arg lookups to reject PLT entries.  */
219 #define ELF_MACHINE_JMP_SLOT    R_390_JMP_SLOT
220
221 /* The S390 never uses Elf32_Rel relocations.  */
222 #define ELF_MACHINE_NO_REL 1
223
224 /* The S390 overlaps DT_RELA and DT_PLTREL.  */
225 #define ELF_MACHINE_PLTREL_OVERLAP 1
226
227 /* We define an initialization functions.  This is called very early in
228    _dl_sysdep_start.  */
229 #define DL_PLATFORM_INIT dl_platform_init ()
230
231 static inline void __attribute__ ((unused))
232 dl_platform_init (void)
233 {
234   if (GLRO(dl_platform) != NULL && *GLRO(dl_platform) == '\0')
235     /* Avoid an empty string which would disturb us.  */
236     GLRO(dl_platform) = NULL;
237 }
238
239 static inline Elf32_Addr
240 elf_machine_fixup_plt (struct link_map *map, lookup_t t,
241                        const Elf32_Rela *reloc,
242                        Elf32_Addr *reloc_addr, Elf32_Addr value)
243 {
244   return *reloc_addr = value;
245 }
246
247 /* Return the final value of a plt relocation.  */
248 static inline Elf32_Addr
249 elf_machine_plt_value (struct link_map *map, const Elf32_Rela *reloc,
250                        Elf32_Addr value)
251 {
252   return value;
253 }
254
255 /* Names of the architecture-specific auditing callback functions.  */
256 #define ARCH_LA_PLTENTER s390_32_gnu_pltenter
257 #define ARCH_LA_PLTEXIT s390_32_gnu_pltexit
258
259 #endif /* !dl_machine_h */
260
261
262 #ifdef RESOLVE_MAP
263
264 /* Perform the relocation specified by RELOC and SYM (which is fully resolved).
265    MAP is the object containing the reloc.  */
266
267 auto inline void
268 __attribute__ ((always_inline))
269 elf_machine_rela (struct link_map *map, const Elf32_Rela *reloc,
270                   const Elf32_Sym *sym, const struct r_found_version *version,
271                   void *const reloc_addr_arg)
272 {
273   Elf32_Addr *const reloc_addr = reloc_addr_arg;
274   const unsigned int r_type = ELF32_R_TYPE (reloc->r_info);
275
276 #if !defined RTLD_BOOTSTRAP || !defined HAVE_Z_COMBRELOC
277   if (__builtin_expect (r_type == R_390_RELATIVE, 0))
278     {
279 # if !defined RTLD_BOOTSTRAP && !defined HAVE_Z_COMBRELOC
280       /* This is defined in rtld.c, but nowhere in the static libc.a;
281          make the reference weak so static programs can still link.
282          This declaration cannot be done when compiling rtld.c
283          (i.e. #ifdef RTLD_BOOTSTRAP) because rtld.c contains the
284          common defn for _dl_rtld_map, which is incompatible with a
285          weak decl in the same file.  */
286 #  ifndef SHARED
287       weak_extern (GL(dl_rtld_map));
288 #  endif
289       if (map != &GL(dl_rtld_map)) /* Already done in rtld itself.  */
290 # endif
291         *reloc_addr = map->l_addr + reloc->r_addend;
292     }
293   else
294 #endif
295   if (__builtin_expect (r_type == R_390_NONE, 0))
296     return;
297   else
298     {
299 #ifndef RESOLVE_CONFLICT_FIND_MAP
300       const Elf32_Sym *const refsym = sym;
301 #endif
302       struct link_map *sym_map = RESOLVE_MAP (&sym, version, r_type);
303       Elf32_Addr value = sym == NULL ? 0 : sym_map->l_addr + sym->st_value;
304
305       switch (r_type)
306         {
307         case R_390_GLOB_DAT:
308         case R_390_JMP_SLOT:
309           *reloc_addr = value + reloc->r_addend;
310           break;
311
312 #if (!defined RTLD_BOOTSTRAP || USE___THREAD) \
313     && !defined RESOLVE_CONFLICT_FIND_MAP
314         case R_390_TLS_DTPMOD:
315 # ifdef RTLD_BOOTSTRAP
316           /* During startup the dynamic linker is always the module
317              with index 1.
318              XXX If this relocation is necessary move before RESOLVE
319              call.  */
320           *reloc_addr = 1;
321 # else
322           /* Get the information from the link map returned by the
323              resolv function.  */
324           if (sym_map != NULL)
325             *reloc_addr = sym_map->l_tls_modid;
326 # endif
327           break;
328         case R_390_TLS_DTPOFF:
329 # ifndef RTLD_BOOTSTRAP
330           /* During relocation all TLS symbols are defined and used.
331              Therefore the offset is already correct.  */
332           if (sym != NULL)
333             *reloc_addr = sym->st_value + reloc->r_addend;
334 # endif
335           break;
336         case R_390_TLS_TPOFF:
337           /* The offset is negative, forward from the thread pointer.  */
338 # ifdef RTLD_BOOTSTRAP
339           *reloc_addr = sym->st_value + reloc->r_addend - map->l_tls_offset;
340 # else
341           /* We know the offset of the object the symbol is contained in.
342              It is a negative value which will be added to the
343              thread pointer.  */
344           if (sym != NULL)
345             {
346               CHECK_STATIC_TLS (map, sym_map);
347               *reloc_addr = (sym->st_value + reloc->r_addend
348                              - sym_map->l_tls_offset);
349             }
350 #endif
351           break;
352 #endif  /* use TLS */
353
354 #ifndef RTLD_BOOTSTRAP
355 # ifndef RESOLVE_CONFLICT_FIND_MAP
356         /* Not needed in dl-conflict.c.  */
357         case R_390_COPY:
358           if (sym == NULL)
359             /* This can happen in trace mode if an object could not be
360                found.  */
361             break;
362           if (__builtin_expect (sym->st_size > refsym->st_size, 0)
363               || (__builtin_expect (sym->st_size < refsym->st_size, 0)
364                   && __builtin_expect (GLRO(dl_verbose), 0)))
365             {
366               const char *strtab;
367
368               strtab = (const char *) D_PTR(map,l_info[DT_STRTAB]);
369               _dl_error_printf ("\
370 %s: Symbol `%s' has different size in shared object, consider re-linking\n",
371                                 rtld_progname ?: "<program name unknown>",
372                                 strtab + refsym->st_name);
373             }
374           memcpy (reloc_addr_arg, (void *) value,
375                   MIN (sym->st_size, refsym->st_size));
376           break;
377 # endif
378         case R_390_32:
379           *reloc_addr = value + reloc->r_addend;
380           break;
381         case R_390_16:
382           *(unsigned short *) reloc_addr = value + reloc->r_addend;
383           break;
384         case R_390_8:
385           *(char *) reloc_addr = value + reloc->r_addend;
386           break;
387 # ifndef RESOLVE_CONFLICT_FIND_MAP
388         case R_390_PC32:
389           *reloc_addr = value + reloc->r_addend - (Elf32_Addr) reloc_addr;
390           break;
391         case R_390_PC16DBL:
392         case R_390_PLT16DBL:
393           *(unsigned short *) reloc_addr = (unsigned short)
394             ((short) (value + reloc->r_addend - (Elf32_Addr) reloc_addr) >> 1);
395           break;
396         case R_390_PC16:
397           *(unsigned short *) reloc_addr =
398             value + reloc->r_addend - (Elf32_Addr) reloc_addr;
399           break;
400         case R_390_NONE:
401           break;
402 # endif
403 #endif
404 #if !defined(RTLD_BOOTSTRAP) || defined(_NDEBUG)
405         default:
406           /* We add these checks in the version to relocate ld.so only
407              if we are still debugging.  */
408           _dl_reloc_bad_type (map, r_type, 0);
409           break;
410 #endif
411         }
412     }
413 }
414
415 auto inline void
416 __attribute__ ((always_inline))
417 elf_machine_rela_relative (Elf32_Addr l_addr, const Elf32_Rela *reloc,
418                            void *const reloc_addr_arg)
419 {
420   Elf32_Addr *const reloc_addr = reloc_addr_arg;
421   *reloc_addr = l_addr + reloc->r_addend;
422 }
423
424 auto inline void
425 __attribute__ ((always_inline))
426 elf_machine_lazy_rel (struct link_map *map,
427                       Elf32_Addr l_addr, const Elf32_Rela *reloc)
428 {
429   Elf32_Addr *const reloc_addr = (void *) (l_addr + reloc->r_offset);
430   const unsigned int r_type = ELF32_R_TYPE (reloc->r_info);
431   /* Check for unexpected PLT reloc type.  */
432   if (__builtin_expect (r_type == R_390_JMP_SLOT, 1))
433     {
434       if (__builtin_expect (map->l_mach.plt, 0) == 0)
435         *reloc_addr += l_addr;
436       else
437         *reloc_addr =
438           map->l_mach.plt
439           + (((Elf32_Addr) reloc_addr) - map->l_mach.gotplt) * 8;
440     }
441   else
442     _dl_reloc_bad_type (map, r_type, 1);
443 }
444
445 #endif /* RESOLVE_MAP */