(elf_machine_rela): Don't define refsym if in dl-conflict.c.
[kopensolaris-gnu/glibc.git] / sysdeps / s390 / s390-64 / dl-machine.h
1 /* Machine-dependent ELF dynamic relocation inline functions.
2    64 bit S/390 Version.
3    Copyright (C) 2001, 2002, 2003 Free Software Foundation, Inc.
4    Contributed by Martin Schwidefsky (schwidefsky@de.ibm.com).
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 "s390x"
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 E_MACHINE is compatible with the running host.  */
35 static inline int
36 elf_machine_matches_host (const Elf64_Ehdr *ehdr)
37 {
38   return (ehdr->e_machine == EM_S390 || ehdr->e_machine == EM_S390_OLD)
39          && ehdr->e_ident[EI_CLASS] == ELFCLASS64;
40 }
41
42 /* Return the link-time address of _DYNAMIC.  Conveniently, this is the
43    first element of the GOT.  This must be inlined in a function which
44    uses global data.  */
45
46 static inline Elf64_Addr
47 elf_machine_dynamic (void)
48 {
49   register Elf64_Addr *got;
50
51   asm( "        larl   %0,_GLOBAL_OFFSET_TABLE_\n"
52        : "=&a" (got) : : "0" );
53
54   return *got;
55 }
56
57 /* Return the run-time load address of the shared object.  */
58 static inline Elf64_Addr
59 elf_machine_load_address (void)
60 {
61   Elf64_Addr addr;
62
63   asm( "   larl  %0,_dl_start\n"
64        "   larl  1,_GLOBAL_OFFSET_TABLE_\n"
65        "   lghi  2,_dl_start@GOT\n"
66        "   slg   %0,0(2,1)"
67        : "=&d" (addr) : : "1", "2" );
68   return addr;
69 }
70
71 /* Set up the loaded object described by L so its unrelocated PLT
72    entries will jump to the on-demand fixup code in dl-runtime.c.  */
73
74 static inline int __attribute__ ((unused))
75 elf_machine_runtime_setup (struct link_map *l, int lazy, int profile)
76 {
77   extern void _dl_runtime_resolve (Elf64_Word);
78   extern void _dl_runtime_profile (Elf64_Word);
79
80   if (l->l_info[DT_JMPREL] && lazy)
81     {
82       /* The GOT entries for functions in the PLT have not yet been filled
83          in.  Their initial contents will arrange when called to push an
84          offset into the .rela.plt section, push _GLOBAL_OFFSET_TABLE_[1],
85          and then jump to _GLOBAL_OFFSET_TABLE[2].  */
86       Elf64_Addr *got;
87       got = (Elf64_Addr *) D_PTR (l, l_info[DT_PLTGOT]);
88       /* If a library is prelinked but we have to relocate anyway,
89          we have to be able to undo the prelinking of .got.plt.
90          The prelinker saved us here address of .plt + 0x2e.  */
91       if (got[1])
92         {
93           l->l_mach.plt = got[1] + l->l_addr;
94           l->l_mach.gotplt = (Elf64_Addr) &got[3];
95         }
96       got[1] = (Elf64_Addr) l;  /* Identify this shared object.  */
97
98       /* The got[2] entry contains the address of a function which gets
99          called to get the address of a so far unresolved function and
100          jump to it.  The profiling extension of the dynamic linker allows
101          to intercept the calls to collect information.  In this case we
102          don't store the address in the GOT so that all future calls also
103          end in this function.  */
104       if (__builtin_expect (profile, 0))
105         {
106           got[2] = (Elf64_Addr) &_dl_runtime_profile;
107
108           if (_dl_name_match_p (GL(dl_profile), l))
109             /* This is the object we are looking for.  Say that we really
110                want profiling and the timers are started.  */
111             GL(dl_profile_map) = l;
112         }
113       else
114         /* This function will get called to fix up the GOT entry indicated by
115            the offset on the stack, and then jump to the resolved address.  */
116         got[2] = (Elf64_Addr) &_dl_runtime_resolve;
117     }
118
119   return lazy;
120 }
121
122 /* This code is used in dl-runtime.c to call the `fixup' function
123    and then redirect to the address it returns.  */
124
125 /* s390:
126    Arguments are in register.
127    r2 - r7 holds the original parameters for the function call, fixup
128    and trampoline code use r0-r5 and r14-15. For the correct function
129    call r2-r5 and r14-15 must be restored.
130    Arguments from the PLT are stored at 48(r15) and 56(r15)
131    and must be moved to r2 and r3 for the fixup call (see elf32-s390.c
132    in the binutils for the PLT code).
133    Fixup function address in r2.
134 */
135 #ifndef PROF
136 #define ELF_MACHINE_RUNTIME_TRAMPOLINE \
137   asm ( "\
138     .text\n\
139     .globl _dl_runtime_resolve\n\
140     .type _dl_runtime_resolve, @function\n\
141     .align 16\n\
142 _dl_runtime_resolve:\n\
143     # save registers\n\
144     stmg   2,5,64(15)\n\
145     stg    14,96(15)\n\
146     lgr    0,15\n\
147     aghi   15,-160\n\
148     stg    0,0(15)\n\
149     # load args saved by PLT\n\
150     lmg    2,3,208(15)\n\
151     brasl  14,fixup     # call fixup\n\
152     lgr    1,2          # function addr returned in r2\n\
153     # restore registers\n\
154     aghi   15,160\n\
155     lg     14,96(15)\n\
156     lmg    2,5,64(15)\n\
157     br     1\n\
158     .size _dl_runtime_resolve, .-_dl_runtime_resolve\n\
159 \n\
160     .globl _dl_runtime_profile\n\
161     .type _dl_runtime_profile, @function\n\
162     .align 16\n\
163 _dl_runtime_profile:\n\
164     # save registers\n\
165     stmg   2,5,64(15)\n\
166     stg    14,96(15)\n\
167     lgr    0,15\n\
168     aghi   15,-160\n\
169     stg    0,0(15)\n\
170     # load args saved by PLT\n\
171     lmg    2,3,208(15)\n\
172     # load return address as third parameter\n\
173     lgr    4,14\n\
174     brasl  14,profile_fixup  # call fixup\n\
175     lgr    1,2          # function addr returned in r2\n\
176     # restore registers\n\
177     aghi   15,160\n\
178     lg     14,96(15)\n\
179     lmg    2,5,64(15)\n\
180     br     1\n\
181     .size _dl_runtime_profile, .-_dl_runtime_profile\n\
182 ");
183 #else
184 #define ELF_MACHINE_RUNTIME_TRAMPOLINE \
185   asm ( "\
186     .text\n\
187     .globl _dl_runtime_resolve\n\
188     .globl _dl_runtime_profile\n\
189     .type _dl_runtime_resolve, @function\n\
190     .type _dl_runtime_profile, @function\n\
191     .align 16\n\
192 _dl_runtime_resolve:\n\
193 _dl_runtime_profile:\n\
194     # save registers\n\
195     stmg   2,5,64(15)\n\
196     stg    14,96(15)\n\
197     lgr    0,15\n\
198     aghi   15,-160\n\
199     stg    0,0(15)\n\
200     # load args saved by PLT\n\
201     lmg    2,3,208(15)\n\
202     # load return address as third parameter\n\
203     lgr    4,14\n\
204     brasl  14,profile_fixup      # call fixup\n\
205     lgr    1,2          # function addr returned in r2\n\
206     # restore registers\n\
207     aghi   15,160\n\
208     lg     14,96(15)\n\
209     lmg    2,5,64(15)\n\
210     br     1\n\
211     .size _dl_runtime_resolve, .-_dl_runtime_resolve\n\
212     .size _dl_runtime_profile, .-_dl_runtime_profile\n\
213 ");
214 #endif
215
216 /* Initial entry point code for the dynamic linker.
217    The C function `_dl_start' is the real entry point;
218    its return value is the user program's entry point.  */
219
220 #define RTLD_START asm ("\n\
221 .text\n\
222 .align 4\n\
223 .globl _start\n\
224 .globl _dl_start_user\n\
225 _start:\n\
226         lgr   %r2,%r15\n\
227         # Alloc stack frame\n\
228         aghi  %r15,-160\n\
229         # Set the back chain to zero\n\
230         xc    0(8,%r15),0(%r15)\n\
231         # Call _dl_start with %r2 pointing to arg on stack\n\
232         brasl %r14,_dl_start         # call _dl_start\n\
233 _dl_start_user:\n\
234         # Save the user entry point address in %r8.\n\
235         lgr   %r8,%r2\n\
236         # Point %r12 at the GOT.\n\
237         larl  %r12,_GLOBAL_OFFSET_TABLE_\n\
238         # Store the highest stack address\n\
239         lghi  %r1,__libc_stack_end@GOT\n\
240         lg    %r1,0(%r1,%r12)\n\
241         stg   %r15, 0(%r1)\n\
242         # See if we were run as a command with the executable file\n\
243         # name as an extra leading argument.\n\
244         lghi  %r1,_dl_skip_args@GOT\n\
245         lg    %r1,0(%r1,%r12)\n\
246         lgf   %r1,0(%r1)          # load _dl_skip_args\n\
247         # Get the original argument count.\n\
248         lg    %r0,160(%r15)\n\
249         # Subtract _dl_skip_args from it.\n\
250         sgr   %r0,%r1\n\
251         # Adjust the stack pointer to skip _dl_skip_args words.\n\
252         sllg  %r1,%r1,3\n\
253         agr   %r15,%r1\n\
254         # Set the back chain to zero again\n\
255         xc    0(8,%r15),0(%r15)\n\
256         # Store back the modified argument count.\n\
257         stg   %r0,160(%r15)\n\
258         # The special initializer gets called with the stack just\n\
259         # as the application's entry point will see it; it can\n\
260         # switch stacks if it moves these contents over.\n\
261 " RTLD_START_SPECIAL_INIT "\n\
262         # Call the function to run the initializers.\n\
263         # Load the parameters:\n\
264         # (%r2, %r3, %r4, %r5) = (_dl_loaded, argc, argv, envp)\n\
265         lghi  %r2,_rtld_local@GOT\n\
266         lg    %r2,0(%r2,%r12)\n\
267         lg    %r2,0(%r2)\n\
268         lg    %r3,160(%r15)\n\
269         la    %r4,168(%r15)\n\
270         lgr   %r5,%r3\n\
271         sllg  %r5,%r5,3\n\
272         la    %r5,176(%r5,%r15)\n\
273         brasl %r14,_dl_init_internal@PLT\n\
274         # Pass our finalizer function to the user in %r14, as per ELF ABI.\n\
275         lghi  %r14,_dl_fini@GOT\n\
276         lg    %r14,0(%r14,%r12)\n\
277         # Free stack frame\n\
278         aghi  %r15,160\n\
279         # Jump to the user's entry point (saved in %r8).\n\
280         br    %r8\n\
281 ");
282
283 #ifndef RTLD_START_SPECIAL_INIT
284 #define RTLD_START_SPECIAL_INIT /* nothing */
285 #endif
286
287 /* ELF_RTYPE_CLASS_PLT iff TYPE describes relocation of a PLT entry or
288    TLS variable, so undefined references should not be allowed to
289    define the value.
290    ELF_RTYPE_CLASS_NOCOPY iff TYPE should not be allowed to resolve to one
291    of the main executable's symbols, as for a COPY reloc.  */
292 #ifdef USE_TLS
293 # define elf_machine_type_class(type) \
294   ((((type) == R_390_JMP_SLOT || (type) == R_390_TLS_DTPMOD                   \
295      || (type) == R_390_TLS_DTPOFF || (type) == R_390_TLS_TPOFF)              \
296     * ELF_RTYPE_CLASS_PLT)                                                    \
297    | (((type) == R_390_COPY) * ELF_RTYPE_CLASS_COPY))
298 #else
299 # define elf_machine_type_class(type) \
300   ((((type) == R_390_JMP_SLOT) * ELF_RTYPE_CLASS_PLT)   \
301    | (((type) == R_390_COPY) * ELF_RTYPE_CLASS_COPY))
302 #endif
303
304 /* A reloc type used for ld.so cmdline arg lookups to reject PLT entries.  */
305 #define ELF_MACHINE_JMP_SLOT    R_390_JMP_SLOT
306
307 /* The 64 bit S/390 never uses Elf64_Rel relocations.  */
308 #define ELF_MACHINE_NO_REL 1
309
310 /* We define an initialization functions.  This is called very early in
311    _dl_sysdep_start.  */
312 #define DL_PLATFORM_INIT dl_platform_init ()
313
314 static inline void __attribute__ ((unused))
315 dl_platform_init (void)
316 {
317   if (GL(dl_platform) != NULL && *GL(dl_platform) == '\0')
318     /* Avoid an empty string which would disturb us.  */
319     GL(dl_platform) = NULL;
320 }
321
322 static inline Elf64_Addr
323 elf_machine_fixup_plt (struct link_map *map, lookup_t t,
324                        const Elf64_Rela *reloc,
325                        Elf64_Addr *reloc_addr, Elf64_Addr value)
326 {
327   return *reloc_addr = value;
328 }
329
330 /* Return the final value of a plt relocation.  */
331 static inline Elf64_Addr
332 elf_machine_plt_value (struct link_map *map, const Elf64_Rela *reloc,
333                        Elf64_Addr value)
334 {
335   return value;
336 }
337
338 #endif /* !dl_machine_h */
339
340 #ifdef RESOLVE
341
342 /* Perform the relocation specified by RELOC and SYM (which is fully resolved).
343    MAP is the object containing the reloc.  */
344
345 static inline void
346 elf_machine_rela (struct link_map *map, const Elf64_Rela *reloc,
347                   const Elf64_Sym *sym, const struct r_found_version *version,
348                   void *const reloc_addr_arg)
349 {
350   Elf64_Addr *const reloc_addr = reloc_addr_arg;
351   const unsigned int r_type = ELF64_R_TYPE (reloc->r_info);
352
353 #if !defined RTLD_BOOTSTRAP || !defined HAVE_Z_COMBRELOC
354   if (__builtin_expect (r_type == R_390_RELATIVE, 0))
355     {
356 # if !defined RTLD_BOOTSTRAP && !defined HAVE_Z_COMBRELOC
357       /* This is defined in rtld.c, but nowhere in the static libc.a;
358          make the reference weak so static programs can still link.
359          This declaration cannot be done when compiling rtld.c
360          (i.e. #ifdef RTLD_BOOTSTRAP) because rtld.c contains the
361          common defn for _dl_rtld_map, which is incompatible with a
362          weak decl in the same file.  */
363 #  ifndef SHARED
364       weak_extern (GL(dl_rtld_map));
365 #  endif
366       if (map != &GL(dl_rtld_map)) /* Already done in rtld itself.  */
367 # endif
368         *reloc_addr = map->l_addr + reloc->r_addend;
369     }
370   else
371 #endif
372   if (__builtin_expect (r_type == R_390_NONE, 0))
373     return;
374   else
375     {
376 #ifndef RESOLVE_CONFLICT_FIND_MAP
377       const Elf64_Sym *const refsym = sym;
378 #endif
379 #if defined USE_TLS && !defined RTLD_BOOTSTRAP
380       struct link_map *sym_map = RESOLVE_MAP (&sym, version, r_type);
381       Elf64_Addr value = sym == NULL ? 0 : sym_map->l_addr + sym->st_value;
382 #else
383       Elf64_Addr value = RESOLVE (&sym, version, r_type);
384
385 # ifndef RTLD_BOOTSTRAP
386       if (sym)
387 # endif
388         value += sym->st_value;
389 #endif /* use TLS and !RTLD_BOOTSTRAP */
390
391       switch (r_type)
392         {
393         case R_390_GLOB_DAT:
394         case R_390_JMP_SLOT:
395           *reloc_addr = value + reloc->r_addend;
396           break;
397
398 #if defined USE_TLS && (!defined RTLD_BOOTSTRAP || USE___THREAD) \
399     && !defined RESOLVE_CONFLICT_FIND_MAP
400         case R_390_TLS_DTPMOD:
401 # ifdef RTLD_BOOTSTRAP
402           /* During startup the dynamic linker is always the module
403              with index 1.
404              XXX If this relocation is necessary move before RESOLVE
405              call.  */
406           *reloc_addr = 1;
407 # else
408           /* Get the information from the link map returned by the
409              resolv function.  */
410           if (sym_map != NULL)
411             *reloc_addr = sym_map->l_tls_modid;
412 # endif
413           break;
414         case R_390_TLS_DTPOFF:
415 # ifndef RTLD_BOOTSTRAP
416           /* During relocation all TLS symbols are defined and used.
417              Therefore the offset is already correct.  */
418           if (sym != NULL)
419             *reloc_addr = sym->st_value + reloc->r_addend;
420 # endif
421           break;
422         case R_390_TLS_TPOFF:
423           /* The offset is negative, forward from the thread pointer.  */
424 # ifdef RTLD_BOOTSTRAP
425           *reloc_addr = sym->st_value + reloc->r_addend - map->l_tls_offset;
426 # else
427           /* We know the offset of the object the symbol is contained in.
428              It is a negative value which will be added to the
429              thread pointer.  */
430           if (sym != NULL)
431             {
432               CHECK_STATIC_TLS (map, sym_map);
433               *reloc_addr = (sym->st_value + reloc->r_addend
434                              - sym_map->l_tls_offset);
435             }
436 #endif
437           break;
438 #endif  /* use TLS */
439
440 #ifndef RTLD_BOOTSTRAP
441 # ifndef RESOLVE_CONFLICT_FIND_MAP
442         /* Not needed for dl-conflict.c.  */
443         case R_390_COPY:
444           if (sym == NULL)
445             /* This can happen in trace mode if an object could not be
446                found.  */
447             break;
448           if (__builtin_expect (sym->st_size > refsym->st_size, 0)
449               || (__builtin_expect (sym->st_size < refsym->st_size, 0)
450                   && __builtin_expect (GL(dl_verbose), 0)))
451             {
452               const char *strtab;
453
454               strtab = (const char *) D_PTR (map,l_info[DT_STRTAB]);
455               _dl_error_printf ("\
456 %s: Symbol `%s' has different size in shared object, consider re-linking\n",
457                                 rtld_progname ?: "<program name unknown>",
458                                 strtab + refsym->st_name);
459             }
460           memcpy (reloc_addr_arg, (void *) value,
461                   MIN (sym->st_size, refsym->st_size));
462           break;
463 # endif
464         case R_390_64:
465           *reloc_addr = value + reloc->r_addend;
466           break;
467         case R_390_32:
468           *(unsigned int *) reloc_addr = value + reloc->r_addend;
469           break;
470         case R_390_16:
471           *(unsigned short *) reloc_addr = value + reloc->r_addend;
472           break;
473         case R_390_8:
474           *(char *) reloc_addr = value + reloc->r_addend;
475           break;
476 # ifndef RESOLVE_CONFLICT_FIND_MAP
477         case R_390_PC64:
478           *reloc_addr = value +reloc->r_addend - (Elf64_Addr) reloc_addr;
479           break;
480         case R_390_PC32DBL:
481         case R_390_PLT32DBL:
482           *(unsigned int *) reloc_addr = (unsigned int)
483             ((int) (value + reloc->r_addend - (Elf64_Addr) reloc_addr) >> 1);
484           break;
485         case R_390_PC32:
486           *(unsigned int *) reloc_addr =
487             value + reloc->r_addend - (Elf64_Addr) reloc_addr;
488           break;
489         case R_390_PC16DBL:
490         case R_390_PLT16DBL:
491           *(unsigned short *) reloc_addr = (unsigned short)
492             ((short) (value + reloc->r_addend - (Elf64_Addr) reloc_addr) >> 1);
493           break;
494         case R_390_PC16:
495           *(unsigned short *) reloc_addr =
496             value + reloc->r_addend - (Elf64_Addr) reloc_addr;
497           break;
498         case R_390_NONE:
499           break;
500 # endif
501 #endif
502 #if !defined(RTLD_BOOTSTRAP) || defined(_NDEBUG)
503         default:
504           /* We add these checks in the version to relocate ld.so only
505              if we are still debugging.  */
506           _dl_reloc_bad_type (map, r_type, 0);
507           break;
508 #endif
509         }
510     }
511 }
512
513 static inline void
514 elf_machine_rela_relative (Elf64_Addr l_addr, const Elf64_Rela *reloc,
515                            void *const reloc_addr_arg)
516 {
517   Elf64_Addr *const reloc_addr = reloc_addr_arg;
518   *reloc_addr = l_addr + reloc->r_addend;
519 }
520
521 static inline void
522 elf_machine_lazy_rel (struct link_map *map,
523                       Elf64_Addr l_addr, const Elf64_Rela *reloc)
524 {
525   Elf64_Addr *const reloc_addr = (void *) (l_addr + reloc->r_offset);
526   const unsigned int r_type = ELF64_R_TYPE (reloc->r_info);
527   /* Check for unexpected PLT reloc type.  */
528   if (__builtin_expect (r_type == R_390_JMP_SLOT, 1))
529     {
530       if (__builtin_expect (map->l_mach.plt, 0) == 0)
531         *reloc_addr += l_addr;
532       else
533         *reloc_addr =
534           map->l_mach.plt
535           + (((Elf64_Addr) reloc_addr) - map->l_mach.gotplt) * 4;
536     }
537   else
538     _dl_reloc_bad_type (map, r_type, 1);
539 }
540
541 #endif /* RESOLVE */