b93cf486b6cda5fd6c41414fbeae06f1078ea685
[platform/upstream/glibc.git] / sysdeps / powerpc / powerpc32 / dl-machine.h
1 /* Machine-dependent ELF dynamic relocation inline functions.  PowerPC version.
2    Copyright (C) 1995-2021 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 Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the 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    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with the GNU C Library; if not, see
17    <https://www.gnu.org/licenses/>.  */
18
19 #ifndef dl_machine_h
20 #define dl_machine_h
21
22 #define ELF_MACHINE_NAME "powerpc"
23
24 #include <assert.h>
25 #include <dl-tls.h>
26 #include <dl-irel.h>
27 #include <hwcapinfo.h>
28
29 /* Translate a processor specific dynamic tag to the index
30    in l_info array.  */
31 #define DT_PPC(x) (DT_PPC_##x - DT_LOPROC + DT_NUM)
32
33 /* Return nonzero iff ELF header is compatible with the running host.  */
34 static inline int
35 elf_machine_matches_host (const Elf32_Ehdr *ehdr)
36 {
37   return ehdr->e_machine == EM_PPC;
38 }
39
40 /* Return the value of the GOT pointer.  */
41 static inline Elf32_Addr * __attribute__ ((const))
42 ppc_got (void)
43 {
44   Elf32_Addr *got;
45
46   asm ("bcl 20,31,1f\n"
47        "1:      mflr %0\n"
48        "        addis %0,%0,_GLOBAL_OFFSET_TABLE_-1b@ha\n"
49        "        addi %0,%0,_GLOBAL_OFFSET_TABLE_-1b@l\n"
50        : "=b" (got) : : "lr");
51
52   return got;
53 }
54
55 /* Return the link-time address of _DYNAMIC, stored as
56    the first value in the GOT. */
57 static inline Elf32_Addr __attribute__ ((const))
58 elf_machine_dynamic (void)
59 {
60   return *ppc_got ();
61 }
62
63 /* Return the run-time load address of the shared object.  */
64 static inline Elf32_Addr __attribute__ ((const))
65 elf_machine_load_address (void)
66 {
67   Elf32_Addr *branchaddr;
68   Elf32_Addr runtime_dynamic;
69
70   /* This is much harder than you'd expect.  Possibly I'm missing something.
71      The 'obvious' way:
72
73        Apparently, "bcl 20,31,$+4" is what should be used to load LR
74        with the address of the next instruction.
75        I think this is so that machines that do bl/blr pairing don't
76        get confused.
77
78      asm ("bcl 20,31,0f ;"
79           "0: mflr 0 ;"
80           "lis %0,0b@ha;"
81           "addi %0,%0,0b@l;"
82           "subf %0,%0,0"
83           : "=b" (addr) : : "r0", "lr");
84
85      doesn't work, because the linker doesn't have to (and in fact doesn't)
86      update the @ha and @l references; the loader (which runs after this
87      code) will do that.
88
89      Instead, we use the following trick:
90
91      The linker puts the _link-time_ address of _DYNAMIC at the first
92      word in the GOT. We could branch to that address, if we wanted,
93      by using an @local reloc; the linker works this out, so it's safe
94      to use now. We can't, of course, actually branch there, because
95      we'd cause an illegal instruction exception; so we need to compute
96      the address ourselves. That gives us the following code: */
97
98   /* Get address of the 'b _DYNAMIC@local'...  */
99   asm ("bcl 20,31,0f;"
100        "b _DYNAMIC@local;"
101        "0:"
102        : "=l" (branchaddr));
103
104   /* So now work out the difference between where the branch actually points,
105      and the offset of that location in memory from the start of the file.  */
106   runtime_dynamic = ((Elf32_Addr) branchaddr
107                      + ((Elf32_Sword) (*branchaddr << 6 & 0xffffff00) >> 6));
108
109   return runtime_dynamic - elf_machine_dynamic ();
110 }
111
112 /* The PLT uses Elf32_Rela relocs.  */
113 #define elf_machine_relplt elf_machine_rela
114
115 /* Mask identifying addresses reserved for the user program,
116    where the dynamic linker should not map anything.  */
117 #define ELF_MACHINE_USER_ADDRESS_MASK   0xf0000000UL
118
119 /* The actual _start code is in dl-start.S.  Use a really
120    ugly bit of assembler to let dl-start.o see _dl_start.  */
121 #define RTLD_START asm (".globl _dl_start");
122
123 /* Decide where a relocatable object should be loaded.  */
124 extern ElfW(Addr)
125 __elf_preferred_address(struct link_map *loader, size_t maplength,
126                         ElfW(Addr) mapstartpref);
127 #define ELF_PREFERRED_ADDRESS(loader, maplength, mapstartpref) \
128   __elf_preferred_address (loader, maplength, mapstartpref)
129
130 /* ELF_RTYPE_CLASS_PLT iff TYPE describes relocation of a PLT entry, so
131    PLT entries should not be allowed to define the value.
132    ELF_RTYPE_CLASS_COPY iff TYPE should not be allowed to resolve to one
133    of the main executable's symbols, as for a COPY reloc.  */
134 /* We never want to use a PLT entry as the destination of a
135    reloc, when what is being relocated is a branch. This is
136    partly for efficiency, but mostly so we avoid loops.  */
137 #define elf_machine_type_class(type)                    \
138   ((((type) == R_PPC_JMP_SLOT                           \
139     || (type) == R_PPC_REL24                            \
140     || ((type) >= R_PPC_DTPMOD32 /* contiguous TLS */   \
141         && (type) <= R_PPC_DTPREL32)                    \
142     || (type) == R_PPC_ADDR24) * ELF_RTYPE_CLASS_PLT)   \
143    | (((type) == R_PPC_COPY) * ELF_RTYPE_CLASS_COPY))
144
145 /* A reloc type used for ld.so cmdline arg lookups to reject PLT entries.  */
146 #define ELF_MACHINE_JMP_SLOT    R_PPC_JMP_SLOT
147
148 /* The PowerPC never uses REL relocations.  */
149 #define ELF_MACHINE_NO_REL 1
150 #define ELF_MACHINE_NO_RELA 0
151
152 /* We define an initialization function to initialize HWCAP/HWCAP2 and
153    platform data so it can be copied into the TCB later.  This is called
154    very early in _dl_sysdep_start for dynamically linked binaries.  */
155 #ifdef SHARED
156 # define DL_PLATFORM_INIT dl_platform_init ()
157
158 static inline void __attribute__ ((unused))
159 dl_platform_init (void)
160 {
161   __tcb_parse_hwcap_and_convert_at_platform ();
162 }
163 #endif
164
165 /* Set up the loaded object described by MAP so its unrelocated PLT
166    entries will jump to the on-demand fixup code in dl-runtime.c.
167    Also install a small trampoline to be used by entries that have
168    been relocated to an address too far away for a single branch.  */
169 extern int __elf_machine_runtime_setup (struct link_map *map,
170                                         int lazy, int profile);
171
172 static inline int
173 elf_machine_runtime_setup (struct link_map *map,
174                            int lazy, int profile)
175 {
176   if (map->l_info[DT_JMPREL] == 0)
177     return lazy;
178
179   if (map->l_info[DT_PPC(GOT)] == 0)
180     /* Handle old style PLT.  */
181     return __elf_machine_runtime_setup (map, lazy, profile);
182
183   /* New style non-exec PLT consisting of an array of addresses.  */
184   map->l_info[DT_PPC(GOT)]->d_un.d_ptr += map->l_addr;
185   if (lazy)
186     {
187       Elf32_Addr *plt, *got, glink;
188       Elf32_Word num_plt_entries;
189       void (*dlrr) (void);
190       extern void _dl_runtime_resolve (void);
191       extern void _dl_prof_resolve (void);
192
193       if (__glibc_likely (!profile))
194         dlrr = _dl_runtime_resolve;
195       else
196         {
197           if (GLRO(dl_profile) != NULL
198               &&_dl_name_match_p (GLRO(dl_profile), map))
199             GL(dl_profile_map) = map;
200           dlrr = _dl_prof_resolve;
201         }
202       got = (Elf32_Addr *) map->l_info[DT_PPC(GOT)]->d_un.d_ptr;
203       glink = got[1];
204       got[1] = (Elf32_Addr) dlrr;
205       got[2] = (Elf32_Addr) map;
206
207       /* Relocate everything in .plt by the load address offset.  */
208       plt = (Elf32_Addr *) D_PTR (map, l_info[DT_PLTGOT]);
209       num_plt_entries = (map->l_info[DT_PLTRELSZ]->d_un.d_val
210                          / sizeof (Elf32_Rela));
211
212       /* If a library is prelinked but we have to relocate anyway,
213          we have to be able to undo the prelinking of .plt section.
214          The prelinker saved us at got[1] address of .glink
215          section's start.  */
216       if (glink)
217         {
218           glink += map->l_addr;
219           while (num_plt_entries-- != 0)
220             *plt++ = glink, glink += 4;
221         }
222       else
223         while (num_plt_entries-- != 0)
224           *plt++ += map->l_addr;
225     }
226   return lazy;
227 }
228
229 /* Change the PLT entry whose reloc is 'reloc' to call the actual routine.  */
230 extern Elf32_Addr __elf_machine_fixup_plt (struct link_map *map,
231                                            Elf32_Addr *reloc_addr,
232                                            Elf32_Addr finaladdr);
233
234 static inline Elf32_Addr
235 elf_machine_fixup_plt (struct link_map *map, lookup_t t,
236                        const ElfW(Sym) *refsym, const ElfW(Sym) *sym,
237                        const Elf32_Rela *reloc,
238                        Elf32_Addr *reloc_addr, Elf64_Addr finaladdr)
239 {
240   if (map->l_info[DT_PPC(GOT)] == 0)
241     /* Handle old style PLT.  */
242     return __elf_machine_fixup_plt (map, reloc_addr, finaladdr);
243
244   *reloc_addr = finaladdr;
245   return finaladdr;
246 }
247
248 /* Return the final value of a plt relocation.  */
249 static inline Elf32_Addr
250 elf_machine_plt_value (struct link_map *map, const Elf32_Rela *reloc,
251                        Elf32_Addr value)
252 {
253   return value + reloc->r_addend;
254 }
255
256
257 /* Names of the architecture-specific auditing callback functions.  */
258 #define ARCH_LA_PLTENTER ppc32_gnu_pltenter
259 #define ARCH_LA_PLTEXIT ppc32_gnu_pltexit
260
261 #endif /* dl_machine_h */
262
263 #ifdef RESOLVE_MAP
264
265 /* Do the actual processing of a reloc, once its target address
266    has been determined.  */
267 extern void __process_machine_rela (struct link_map *map,
268                                     const Elf32_Rela *reloc,
269                                     struct link_map *sym_map,
270                                     const Elf32_Sym *sym,
271                                     const Elf32_Sym *refsym,
272                                     Elf32_Addr *const reloc_addr,
273                                     Elf32_Addr finaladdr,
274                                     int rinfo, bool skip_ifunc)
275   attribute_hidden;
276
277 /* Call _dl_signal_error when a resolved value overflows a relocated area.  */
278 extern void _dl_reloc_overflow (struct link_map *map,
279                                 const char *name,
280                                 Elf32_Addr *const reloc_addr,
281                                 const Elf32_Sym *refsym) attribute_hidden;
282
283 /* Perform the relocation specified by RELOC and SYM (which is fully resolved).
284    LOADADDR is the load address of the object; INFO is an array indexed
285    by DT_* of the .dynamic section info.  */
286
287 auto inline void __attribute__ ((always_inline))
288 elf_machine_rela (struct link_map *map, const Elf32_Rela *reloc,
289                   const Elf32_Sym *sym, const struct r_found_version *version,
290                   void *const reloc_addr_arg, int skip_ifunc)
291 {
292   Elf32_Addr *const reloc_addr = reloc_addr_arg;
293   const Elf32_Sym *const refsym = sym;
294   Elf32_Addr value;
295   const int r_type = ELF32_R_TYPE (reloc->r_info);
296   struct link_map *sym_map = NULL;
297
298 #ifndef RESOLVE_CONFLICT_FIND_MAP
299   if (r_type == R_PPC_RELATIVE)
300     {
301       *reloc_addr = map->l_addr + reloc->r_addend;
302       return;
303     }
304
305   if (__glibc_unlikely (r_type == R_PPC_NONE))
306     return;
307
308   /* binutils on ppc32 includes st_value in r_addend for relocations
309      against local symbols.  */
310   if (__builtin_expect (ELF32_ST_BIND (sym->st_info) == STB_LOCAL, 0)
311       && sym->st_shndx != SHN_UNDEF)
312     {
313       sym_map = map;
314       value = map->l_addr;
315     }
316   else
317     {
318       sym_map = RESOLVE_MAP (&sym, version, r_type);
319       value = SYMBOL_ADDRESS (sym_map, sym, true);
320     }
321   value += reloc->r_addend;
322 #else
323   value = reloc->r_addend;
324 #endif
325
326   if (sym != NULL
327       && __builtin_expect (ELFW(ST_TYPE) (sym->st_info) == STT_GNU_IFUNC, 0)
328       && __builtin_expect (sym->st_shndx != SHN_UNDEF, 1)
329       && __builtin_expect (!skip_ifunc, 1))
330     value = elf_ifunc_invoke (value);
331
332   /* A small amount of code is duplicated here for speed.  In libc,
333      more than 90% of the relocs are R_PPC_RELATIVE; in the X11 shared
334      libraries, 60% are R_PPC_RELATIVE, 24% are R_PPC_GLOB_DAT or
335      R_PPC_ADDR32, and 16% are R_PPC_JMP_SLOT (which this routine
336      wouldn't usually handle).  As an bonus, doing this here allows
337      the switch statement in __process_machine_rela to work.  */
338   switch (r_type)
339     {
340     case R_PPC_GLOB_DAT:
341     case R_PPC_ADDR32:
342       *reloc_addr = value;
343       break;
344
345 #ifndef RESOLVE_CONFLICT_FIND_MAP
346 # ifdef RTLD_BOOTSTRAP
347 #  define NOT_BOOTSTRAP 0
348 # else
349 #  define NOT_BOOTSTRAP 1
350 # endif
351
352     case R_PPC_DTPMOD32:
353       if (map->l_info[DT_PPC(OPT)]
354           && (map->l_info[DT_PPC(OPT)]->d_un.d_val & PPC_OPT_TLS))
355         {
356           if (!NOT_BOOTSTRAP)
357             {
358               reloc_addr[0] = 0;
359               reloc_addr[1] = (sym_map->l_tls_offset - TLS_TP_OFFSET
360                                + TLS_DTV_OFFSET);
361               break;
362             }
363           else if (sym_map != NULL)
364             {
365 # ifndef SHARED
366               CHECK_STATIC_TLS (map, sym_map);
367 # else
368               if (TRY_STATIC_TLS (map, sym_map))
369 # endif
370                 {
371                   reloc_addr[0] = 0;
372                   /* Set up for local dynamic.  */
373                   reloc_addr[1] = (sym_map->l_tls_offset - TLS_TP_OFFSET
374                                    + TLS_DTV_OFFSET);
375                   break;
376                 }
377             }
378         }
379       if (!NOT_BOOTSTRAP)
380         /* During startup the dynamic linker is always index 1.  */
381         *reloc_addr = 1;
382       else if (sym_map != NULL)
383         /* Get the information from the link map returned by the
384            RESOLVE_MAP function.  */
385         *reloc_addr = sym_map->l_tls_modid;
386       break;
387     case R_PPC_DTPREL32:
388       if (map->l_info[DT_PPC(OPT)]
389           && (map->l_info[DT_PPC(OPT)]->d_un.d_val & PPC_OPT_TLS))
390         {
391           if (!NOT_BOOTSTRAP)
392             {
393               *reloc_addr = TLS_TPREL_VALUE (sym_map, sym, reloc);
394               break;
395             }
396           else if (sym_map != NULL)
397             {
398               /* This reloc is always preceded by R_PPC_DTPMOD32.  */
399 # ifndef SHARED
400               assert (HAVE_STATIC_TLS (map, sym_map));
401 # else
402               if (HAVE_STATIC_TLS (map, sym_map))
403 # endif
404                 {
405                   *reloc_addr = TLS_TPREL_VALUE (sym_map, sym, reloc);
406                   break;
407                 }
408             }
409         }
410       /* During relocation all TLS symbols are defined and used.
411          Therefore the offset is already correct.  */
412       if (NOT_BOOTSTRAP && sym_map != NULL)
413         *reloc_addr = TLS_DTPREL_VALUE (sym, reloc);
414       break;
415     case R_PPC_TPREL32:
416       if (!NOT_BOOTSTRAP || sym_map != NULL)
417         {
418           if (NOT_BOOTSTRAP)
419             CHECK_STATIC_TLS (map, sym_map);
420           *reloc_addr = TLS_TPREL_VALUE (sym_map, sym, reloc);
421         }
422       break;
423 #endif
424
425     case R_PPC_JMP_SLOT:
426 #ifdef RESOLVE_CONFLICT_FIND_MAP
427       RESOLVE_CONFLICT_FIND_MAP (map, reloc_addr);
428 #endif
429       if (map->l_info[DT_PPC(GOT)] != 0)
430         {
431           *reloc_addr = value;
432           break;
433         }
434       /* FALLTHROUGH */
435
436     default:
437       __process_machine_rela (map, reloc, sym_map, sym, refsym,
438                               reloc_addr, value, r_type, skip_ifunc);
439     }
440 }
441
442 auto inline void __attribute__ ((always_inline))
443 elf_machine_rela_relative (Elf32_Addr l_addr, const Elf32_Rela *reloc,
444                            void *const reloc_addr_arg)
445 {
446   Elf32_Addr *const reloc_addr = reloc_addr_arg;
447   *reloc_addr = l_addr + reloc->r_addend;
448 }
449
450 auto inline void __attribute__ ((always_inline))
451 elf_machine_lazy_rel (struct link_map *map,
452                       Elf32_Addr l_addr, const Elf32_Rela *reloc,
453                       int skip_ifunc)
454 {
455   /* elf_machine_runtime_setup handles this. */
456 }
457
458 #endif /* RESOLVE_MAP */