1/* PPC64 ELF support for BFD.
2   Copyright (C) 2003-2024 Free Software Foundation, Inc.
3
4   This file is part of BFD, the Binary File Descriptor library.
5
6   This program is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 3 of the License, or
9   (at your option) any later version.
10
11   This program is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program; if not, write to the Free Software
18   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
19   MA 02110-1301, USA.  */
20
21#ifndef _ELF_PPC64_H
22#define _ELF_PPC64_H
23
24#include "elf/reloc-macros.h"
25
26/* Relocations.  */
27START_RELOC_NUMBERS (elf_ppc64_reloc_type)
28  RELOC_NUMBER (R_PPC64_NONE,		     0)
29  RELOC_NUMBER (R_PPC64_ADDR32,		     1)
30  RELOC_NUMBER (R_PPC64_ADDR24,		     2)
31  RELOC_NUMBER (R_PPC64_ADDR16,		     3)
32  RELOC_NUMBER (R_PPC64_ADDR16_LO,	     4)
33  RELOC_NUMBER (R_PPC64_ADDR16_HI,	     5)
34  RELOC_NUMBER (R_PPC64_ADDR16_HA,	     6)
35  RELOC_NUMBER (R_PPC64_ADDR14,		     7)
36  RELOC_NUMBER (R_PPC64_ADDR14_BRTAKEN,	     8)
37  RELOC_NUMBER (R_PPC64_ADDR14_BRNTAKEN,     9)
38  RELOC_NUMBER (R_PPC64_REL24,		    10)
39  RELOC_NUMBER (R_PPC64_REL14,		    11)
40  RELOC_NUMBER (R_PPC64_REL14_BRTAKEN,	    12)
41  RELOC_NUMBER (R_PPC64_REL14_BRNTAKEN,	    13)
42  RELOC_NUMBER (R_PPC64_GOT16,		    14)
43  RELOC_NUMBER (R_PPC64_GOT16_LO,	    15)
44  RELOC_NUMBER (R_PPC64_GOT16_HI,	    16)
45  RELOC_NUMBER (R_PPC64_GOT16_HA,	    17)
46  /* 18 unused.  32-bit reloc is R_PPC_PLTREL24.  */
47  RELOC_NUMBER (R_PPC64_COPY,		    19)
48  RELOC_NUMBER (R_PPC64_GLOB_DAT,	    20)
49  RELOC_NUMBER (R_PPC64_JMP_SLOT,	    21)
50  RELOC_NUMBER (R_PPC64_RELATIVE,	    22)
51  /* 23 unused.  32-bit reloc is R_PPC_LOCAL24PC.  */
52  RELOC_NUMBER (R_PPC64_UADDR32,	    24)
53  RELOC_NUMBER (R_PPC64_UADDR16,	    25)
54  RELOC_NUMBER (R_PPC64_REL32,		    26)
55  RELOC_NUMBER (R_PPC64_PLT32,		    27)
56  RELOC_NUMBER (R_PPC64_PLTREL32,	    28)
57  RELOC_NUMBER (R_PPC64_PLT16_LO,	    29)
58  RELOC_NUMBER (R_PPC64_PLT16_HI,	    30)
59  RELOC_NUMBER (R_PPC64_PLT16_HA,	    31)
60  /* 32 unused.  32-bit reloc is R_PPC_SDAREL16.  */
61  RELOC_NUMBER (R_PPC64_SECTOFF,	    33)
62  RELOC_NUMBER (R_PPC64_SECTOFF_LO,	    34)
63  RELOC_NUMBER (R_PPC64_SECTOFF_HI,	    35)
64  RELOC_NUMBER (R_PPC64_SECTOFF_HA,	    36)
65  RELOC_NUMBER (R_PPC64_REL30,		    37)
66  RELOC_NUMBER (R_PPC64_ADDR64,		    38)
67  RELOC_NUMBER (R_PPC64_ADDR16_HIGHER,	    39)
68  RELOC_NUMBER (R_PPC64_ADDR16_HIGHERA,	    40)
69  RELOC_NUMBER (R_PPC64_ADDR16_HIGHEST,	    41)
70  RELOC_NUMBER (R_PPC64_ADDR16_HIGHESTA,    42)
71  RELOC_NUMBER (R_PPC64_UADDR64,	    43)
72  RELOC_NUMBER (R_PPC64_REL64,		    44)
73  RELOC_NUMBER (R_PPC64_PLT64,		    45)
74  RELOC_NUMBER (R_PPC64_PLTREL64,	    46)
75  RELOC_NUMBER (R_PPC64_TOC16,		    47)
76  RELOC_NUMBER (R_PPC64_TOC16_LO,	    48)
77  RELOC_NUMBER (R_PPC64_TOC16_HI,	    49)
78  RELOC_NUMBER (R_PPC64_TOC16_HA,	    50)
79  RELOC_NUMBER (R_PPC64_TOC,		    51)
80  RELOC_NUMBER (R_PPC64_PLTGOT16,	    52)
81  RELOC_NUMBER (R_PPC64_PLTGOT16_LO,	    53)
82  RELOC_NUMBER (R_PPC64_PLTGOT16_HI,	    54)
83  RELOC_NUMBER (R_PPC64_PLTGOT16_HA,	    55)
84
85  /* The following relocs were added in the 64-bit PowerPC ELF ABI
86     revision 1.2. */
87  RELOC_NUMBER (R_PPC64_ADDR16_DS,	    56)
88  RELOC_NUMBER (R_PPC64_ADDR16_LO_DS,	    57)
89  RELOC_NUMBER (R_PPC64_GOT16_DS,	    58)
90  RELOC_NUMBER (R_PPC64_GOT16_LO_DS,	    59)
91  RELOC_NUMBER (R_PPC64_PLT16_LO_DS,	    60)
92  RELOC_NUMBER (R_PPC64_SECTOFF_DS,	    61)
93  RELOC_NUMBER (R_PPC64_SECTOFF_LO_DS,	    62)
94  RELOC_NUMBER (R_PPC64_TOC16_DS,	    63)
95  RELOC_NUMBER (R_PPC64_TOC16_LO_DS,	    64)
96  RELOC_NUMBER (R_PPC64_PLTGOT16_DS,	    65)
97  RELOC_NUMBER (R_PPC64_PLTGOT16_LO_DS,	    66)
98
99  /* Relocs added to support TLS.  PowerPC64 ELF ABI revision 1.5.  */
100  RELOC_NUMBER (R_PPC64_TLS,		    67)
101  RELOC_NUMBER (R_PPC64_DTPMOD64,	    68)
102  RELOC_NUMBER (R_PPC64_TPREL16,	    69)
103  RELOC_NUMBER (R_PPC64_TPREL16_LO,	    70)
104  RELOC_NUMBER (R_PPC64_TPREL16_HI,	    71)
105  RELOC_NUMBER (R_PPC64_TPREL16_HA,	    72)
106  RELOC_NUMBER (R_PPC64_TPREL64,	    73)
107  RELOC_NUMBER (R_PPC64_DTPREL16,	    74)
108  RELOC_NUMBER (R_PPC64_DTPREL16_LO,	    75)
109  RELOC_NUMBER (R_PPC64_DTPREL16_HI,	    76)
110  RELOC_NUMBER (R_PPC64_DTPREL16_HA,	    77)
111  RELOC_NUMBER (R_PPC64_DTPREL64,	    78)
112  RELOC_NUMBER (R_PPC64_GOT_TLSGD16,	    79)
113  RELOC_NUMBER (R_PPC64_GOT_TLSGD16_LO,	    80)
114  RELOC_NUMBER (R_PPC64_GOT_TLSGD16_HI,	    81)
115  RELOC_NUMBER (R_PPC64_GOT_TLSGD16_HA,	    82)
116  RELOC_NUMBER (R_PPC64_GOT_TLSLD16,	    83)
117  RELOC_NUMBER (R_PPC64_GOT_TLSLD16_LO,	    84)
118  RELOC_NUMBER (R_PPC64_GOT_TLSLD16_HI,	    85)
119  RELOC_NUMBER (R_PPC64_GOT_TLSLD16_HA,	    86)
120  RELOC_NUMBER (R_PPC64_GOT_TPREL16_DS,	    87)
121  RELOC_NUMBER (R_PPC64_GOT_TPREL16_LO_DS,  88)
122  RELOC_NUMBER (R_PPC64_GOT_TPREL16_HI,	    89)
123  RELOC_NUMBER (R_PPC64_GOT_TPREL16_HA,	    90)
124  RELOC_NUMBER (R_PPC64_GOT_DTPREL16_DS,    91)
125  RELOC_NUMBER (R_PPC64_GOT_DTPREL16_LO_DS, 92)
126  RELOC_NUMBER (R_PPC64_GOT_DTPREL16_HI,    93)
127  RELOC_NUMBER (R_PPC64_GOT_DTPREL16_HA,    94)
128  RELOC_NUMBER (R_PPC64_TPREL16_DS,	    95)
129  RELOC_NUMBER (R_PPC64_TPREL16_LO_DS,	    96)
130  RELOC_NUMBER (R_PPC64_TPREL16_HIGHER,	    97)
131  RELOC_NUMBER (R_PPC64_TPREL16_HIGHERA,    98)
132  RELOC_NUMBER (R_PPC64_TPREL16_HIGHEST,    99)
133  RELOC_NUMBER (R_PPC64_TPREL16_HIGHESTA,  100)
134  RELOC_NUMBER (R_PPC64_DTPREL16_DS,	   101)
135  RELOC_NUMBER (R_PPC64_DTPREL16_LO_DS,	   102)
136  RELOC_NUMBER (R_PPC64_DTPREL16_HIGHER,   103)
137  RELOC_NUMBER (R_PPC64_DTPREL16_HIGHERA,  104)
138  RELOC_NUMBER (R_PPC64_DTPREL16_HIGHEST,  105)
139  RELOC_NUMBER (R_PPC64_DTPREL16_HIGHESTA, 106)
140  RELOC_NUMBER (R_PPC64_TLSGD,		   107)
141  RELOC_NUMBER (R_PPC64_TLSLD,		   108)
142  RELOC_NUMBER (R_PPC64_TOCSAVE,	   109)
143
144/* Added when HA and HI relocs were changed to report overflows.  */
145  RELOC_NUMBER (R_PPC64_ADDR16_HIGH,	   110)
146  RELOC_NUMBER (R_PPC64_ADDR16_HIGHA,	   111)
147  RELOC_NUMBER (R_PPC64_TPREL16_HIGH,	   112)
148  RELOC_NUMBER (R_PPC64_TPREL16_HIGHA,	   113)
149  RELOC_NUMBER (R_PPC64_DTPREL16_HIGH,	   114)
150  RELOC_NUMBER (R_PPC64_DTPREL16_HIGHA,	   115)
151
152/* Added for ELFv2.  */
153  RELOC_NUMBER (R_PPC64_REL24_NOTOC,	   116)
154  RELOC_NUMBER (R_PPC64_ADDR64_LOCAL,	   117)
155  RELOC_NUMBER (R_PPC64_ENTRY,		   118)
156
157/* Marker reloc for inline plt call insns.  */
158  RELOC_NUMBER (R_PPC64_PLTSEQ,		   119)
159  RELOC_NUMBER (R_PPC64_PLTCALL,	   120)
160
161/* Power10 support.  */
162  RELOC_NUMBER (R_PPC64_PLTSEQ_NOTOC,	   121)
163  RELOC_NUMBER (R_PPC64_PLTCALL_NOTOC,	   122)
164  RELOC_NUMBER (R_PPC64_PCREL_OPT,	   123)
165  RELOC_NUMBER (R_PPC64_REL24_P9NOTOC,	   124)
166
167  RELOC_NUMBER (R_PPC64_D34,		   128)
168  RELOC_NUMBER (R_PPC64_D34_LO,		   129)
169  RELOC_NUMBER (R_PPC64_D34_HI30,	   130)
170  RELOC_NUMBER (R_PPC64_D34_HA30,	   131)
171  RELOC_NUMBER (R_PPC64_PCREL34,	   132)
172  RELOC_NUMBER (R_PPC64_GOT_PCREL34,	   133)
173  RELOC_NUMBER (R_PPC64_PLT_PCREL34,	   134)
174  RELOC_NUMBER (R_PPC64_PLT_PCREL34_NOTOC, 135)
175  RELOC_NUMBER (R_PPC64_ADDR16_HIGHER34,   136)
176  RELOC_NUMBER (R_PPC64_ADDR16_HIGHERA34,  137)
177  RELOC_NUMBER (R_PPC64_ADDR16_HIGHEST34,  138)
178  RELOC_NUMBER (R_PPC64_ADDR16_HIGHESTA34, 139)
179  RELOC_NUMBER (R_PPC64_REL16_HIGHER34,    140)
180  RELOC_NUMBER (R_PPC64_REL16_HIGHERA34,   141)
181  RELOC_NUMBER (R_PPC64_REL16_HIGHEST34,   142)
182  RELOC_NUMBER (R_PPC64_REL16_HIGHESTA34,  143)
183  RELOC_NUMBER (R_PPC64_D28,		   144)
184  RELOC_NUMBER (R_PPC64_PCREL28,	   145)
185  RELOC_NUMBER (R_PPC64_TPREL34,	   146)
186  RELOC_NUMBER (R_PPC64_DTPREL34,	   147)
187  RELOC_NUMBER (R_PPC64_GOT_TLSGD_PCREL34, 148)
188  RELOC_NUMBER (R_PPC64_GOT_TLSLD_PCREL34, 149)
189  RELOC_NUMBER (R_PPC64_GOT_TPREL_PCREL34, 150)
190  RELOC_NUMBER (R_PPC64_GOT_DTPREL_PCREL34, 151)
191
192#ifndef RELOC_MACROS_GEN_FUNC
193/* Relocation only used internally by gas or ld.  If you need to use
194   these reloc numbers, you can change them to some other unused value
195   without affecting the ABI.  They will never appear in object files.  */
196  RELOC_NUMBER (R_PPC64_LO_DS_OPT,	   200)
197  RELOC_NUMBER (R_PPC64_16DX_HA,	   201)
198#endif
199
200  RELOC_NUMBER (R_PPC64_REL16_HIGH,	   240)
201  RELOC_NUMBER (R_PPC64_REL16_HIGHA,	   241)
202  RELOC_NUMBER (R_PPC64_REL16_HIGHER,	   242)
203  RELOC_NUMBER (R_PPC64_REL16_HIGHERA,	   243)
204  RELOC_NUMBER (R_PPC64_REL16_HIGHEST,	   244)
205  RELOC_NUMBER (R_PPC64_REL16_HIGHESTA,	   245)
206
207/* Power9 split rel16 for addpcis.  */
208  RELOC_NUMBER (R_PPC64_REL16DX_HA,	   246)
209
210/* Support STT_GNU_IFUNC plt calls.  */
211  RELOC_NUMBER (R_PPC64_JMP_IREL,	   247)
212  RELOC_NUMBER (R_PPC64_IRELATIVE,	   248)
213
214/* These are GNU extensions used in PIC code sequences.  */
215  RELOC_NUMBER (R_PPC64_REL16,		   249)
216  RELOC_NUMBER (R_PPC64_REL16_LO,	   250)
217  RELOC_NUMBER (R_PPC64_REL16_HI,	   251)
218  RELOC_NUMBER (R_PPC64_REL16_HA,	   252)
219
220  /* These are GNU extensions to enable C++ vtable garbage collection.  */
221  RELOC_NUMBER (R_PPC64_GNU_VTINHERIT,	   253)
222  RELOC_NUMBER (R_PPC64_GNU_VTENTRY,	   254)
223
224END_RELOC_NUMBERS (R_PPC64_max)
225
226#define IS_PPC64_TLS_RELOC(R)						\
227  (((R) >= R_PPC64_TLS && (R) <= R_PPC64_DTPREL16_HIGHESTA)		\
228   || ((R) >= R_PPC64_TPREL16_HIGH && (R) <= R_PPC64_DTPREL16_HIGHA)	\
229   || ((R) >= R_PPC64_TPREL34 && (R) <= R_PPC64_GOT_DTPREL_PCREL34))
230
231/* e_flags bits specifying ABI.
232   1 for original function descriptor using ABI,
233   2 for revised ABI without function descriptors,
234   0 for unspecified or not using any features affected by the differences.  */
235#define EF_PPC64_ABI	3
236
237/* The ELFv2 ABI uses three bits in the symbol st_other field of a
238   function definition to specify the number of bytes between a
239   function's global entry point and local entry point.
240   Values of two to six specify powers of two from four to sixty four
241   bytes.  For such functions:
242   The global entry point is used when it is necessary to set up the
243   toc pointer (r2) for the function.  Callers must enter the global
244   entry point with r12 set to the global entry point address.  On
245   return from the function r2 will contain the toc pointer for the
246   function.
247   The local entry point is used when r2 is known to already be valid
248   for the function.  There is no requirement on r12 when using the
249   local entry point, and on return r2 will contain the same value as
250   at entry.
251   A value of zero in these bits means that the function has a single
252   entry point with no requirement on r12 or r2, and that on return r2
253   will contain the same value as at entry.
254   A value of one means that the function has a single entry point
255   with no requirement on r12 or r2, and that r2 is *not* preserved.
256   A value of seven is reserved.  */
257#define STO_PPC64_LOCAL_BIT		5
258#define STO_PPC64_LOCAL_MASK		(7 << STO_PPC64_LOCAL_BIT)
259
260/* 3 bit other field to bytes.  */
261static inline unsigned int
262ppc64_decode_local_entry(unsigned int other)
263{
264  return ((1 << other) >> 2) << 2;
265}
266
267/* bytes to field value.  */
268static inline unsigned int
269ppc64_encode_local_entry(unsigned int val)
270{
271  return (val >= 4 * 4
272	  ? (val >= 8 * 4
273	     ? (val >= 16 * 4 ? 6 : 5)
274	     : 4)
275	  : (val >= 2 * 4
276	     ? 3
277	     : (val >= 1 * 4 ? 2 : 0)));
278}
279
280/* st_other to number of bytes.  */
281#define PPC64_LOCAL_ENTRY_OFFSET(other)				\
282  ppc64_decode_local_entry (((other) & STO_PPC64_LOCAL_MASK)	\
283			    >> STO_PPC64_LOCAL_BIT)
284/* number of bytes to st_other.  */
285#define PPC64_SET_LOCAL_ENTRY_OFFSET(val)		\
286  ppc64_encode_local_entry (val) << STO_PPC64_LOCAL_BIT
287
288/* Specify the start of the .glink section.  */
289#define DT_PPC64_GLINK		DT_LOPROC
290
291/* Specify the start and size of the .opd section.  */
292#define DT_PPC64_OPD		(DT_LOPROC + 1)
293#define DT_PPC64_OPDSZ		(DT_LOPROC + 2)
294
295/* Specify whether various optimisations are possible.  */
296#define DT_PPC64_OPT		(DT_LOPROC + 3)
297#define PPC64_OPT_TLS		1
298#define PPC64_OPT_MULTI_TOC	2
299#define PPC64_OPT_LOCALENTRY	4
300
301#endif /* _ELF_PPC64_H */
302