1 /* MIPS ELF support for BFD.
2    Copyright (C) 1993-2016 Free Software Foundation, Inc.
3 
4    By Ian Lance Taylor, Cygnus Support, <ian@cygnus.com>, from
5    information in the System V Application Binary Interface, MIPS
6    Processor Supplement.
7 
8    This file is part of BFD, the Binary File Descriptor library.
9 
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 3 of the License, or
13    (at your option) any later version.
14 
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19 
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
23    MA 02110-1301, USA.  */
24 
25 /* This file holds definitions specific to the MIPS ELF ABI.  Note
26    that most of this is not actually implemented by BFD.  */
27 
28 #ifndef _ELF_MIPS_H
29 #define _ELF_MIPS_H
30 
31 #include "elf/reloc-macros.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 /* Relocation types.  */
38 START_RELOC_NUMBERS (elf_mips_reloc_type)
39   RELOC_NUMBER (R_MIPS_NONE, 0)
40   RELOC_NUMBER (R_MIPS_16, 1)
41   RELOC_NUMBER (R_MIPS_32, 2)		/* In Elf 64: alias R_MIPS_ADD */
42   RELOC_NUMBER (R_MIPS_REL32, 3)	/* In Elf 64: alias R_MIPS_REL */
43   RELOC_NUMBER (R_MIPS_26, 4)
44   RELOC_NUMBER (R_MIPS_HI16, 5)
45   RELOC_NUMBER (R_MIPS_LO16, 6)
46   RELOC_NUMBER (R_MIPS_GPREL16, 7)	/* In Elf 64: alias R_MIPS_GPREL */
47   RELOC_NUMBER (R_MIPS_LITERAL, 8)
48   RELOC_NUMBER (R_MIPS_GOT16, 9)	/* In Elf 64: alias R_MIPS_GOT */
49   RELOC_NUMBER (R_MIPS_PC16, 10)
50   RELOC_NUMBER (R_MIPS_CALL16, 11)	/* In Elf 64: alias R_MIPS_CALL */
51   RELOC_NUMBER (R_MIPS_GPREL32, 12)
52   /* The remaining relocs are defined on Irix, although they are not
53      in the MIPS ELF ABI.  */
54   RELOC_NUMBER (R_MIPS_UNUSED1, 13)
55   RELOC_NUMBER (R_MIPS_UNUSED2, 14)
56   RELOC_NUMBER (R_MIPS_UNUSED3, 15)
57   RELOC_NUMBER (R_MIPS_SHIFT5, 16)
58   RELOC_NUMBER (R_MIPS_SHIFT6, 17)
59   RELOC_NUMBER (R_MIPS_64, 18)
60   RELOC_NUMBER (R_MIPS_GOT_DISP, 19)
61   RELOC_NUMBER (R_MIPS_GOT_PAGE, 20)
62   RELOC_NUMBER (R_MIPS_GOT_OFST, 21)
63   RELOC_NUMBER (R_MIPS_GOT_HI16, 22)
64   RELOC_NUMBER (R_MIPS_GOT_LO16, 23)
65   RELOC_NUMBER (R_MIPS_SUB, 24)
66   RELOC_NUMBER (R_MIPS_INSERT_A, 25)
67   RELOC_NUMBER (R_MIPS_INSERT_B, 26)
68   RELOC_NUMBER (R_MIPS_DELETE, 27)
69   RELOC_NUMBER (R_MIPS_HIGHER, 28)
70   RELOC_NUMBER (R_MIPS_HIGHEST, 29)
71   RELOC_NUMBER (R_MIPS_CALL_HI16, 30)
72   RELOC_NUMBER (R_MIPS_CALL_LO16, 31)
73   RELOC_NUMBER (R_MIPS_SCN_DISP, 32)
74   RELOC_NUMBER (R_MIPS_REL16, 33)
75   RELOC_NUMBER (R_MIPS_ADD_IMMEDIATE, 34)
76   RELOC_NUMBER (R_MIPS_PJUMP, 35)
77   RELOC_NUMBER (R_MIPS_RELGOT, 36)
78   RELOC_NUMBER (R_MIPS_JALR, 37)
79   /* TLS relocations.  */
80   RELOC_NUMBER (R_MIPS_TLS_DTPMOD32, 38)
81   RELOC_NUMBER (R_MIPS_TLS_DTPREL32, 39)
82   RELOC_NUMBER (R_MIPS_TLS_DTPMOD64, 40)
83   RELOC_NUMBER (R_MIPS_TLS_DTPREL64, 41)
84   RELOC_NUMBER (R_MIPS_TLS_GD, 42)
85   RELOC_NUMBER (R_MIPS_TLS_LDM, 43)
86   RELOC_NUMBER (R_MIPS_TLS_DTPREL_HI16, 44)
87   RELOC_NUMBER (R_MIPS_TLS_DTPREL_LO16, 45)
88   RELOC_NUMBER (R_MIPS_TLS_GOTTPREL, 46)
89   RELOC_NUMBER (R_MIPS_TLS_TPREL32, 47)
90   RELOC_NUMBER (R_MIPS_TLS_TPREL64, 48)
91   RELOC_NUMBER (R_MIPS_TLS_TPREL_HI16, 49)
92   RELOC_NUMBER (R_MIPS_TLS_TPREL_LO16, 50)
93   RELOC_NUMBER (R_MIPS_GLOB_DAT, 51)
94   /* Space to grow */
95   RELOC_NUMBER (R_MIPS_PC21_S2, 60)
96   RELOC_NUMBER (R_MIPS_PC26_S2, 61)
97   RELOC_NUMBER (R_MIPS_PC18_S3, 62)
98   RELOC_NUMBER (R_MIPS_PC19_S2, 63)
99   RELOC_NUMBER (R_MIPS_PCHI16, 64)
100   RELOC_NUMBER (R_MIPS_PCLO16, 65)
101   FAKE_RELOC (R_MIPS_max, 66)
102   /* These relocs are used for the mips16.  */
103   FAKE_RELOC (R_MIPS16_min, 100)
104   RELOC_NUMBER (R_MIPS16_26, 100)
105   RELOC_NUMBER (R_MIPS16_GPREL, 101)
106   RELOC_NUMBER (R_MIPS16_GOT16, 102)
107   RELOC_NUMBER (R_MIPS16_CALL16, 103)
108   RELOC_NUMBER (R_MIPS16_HI16, 104)
109   RELOC_NUMBER (R_MIPS16_LO16, 105)
110   RELOC_NUMBER (R_MIPS16_TLS_GD, 106)
111   RELOC_NUMBER (R_MIPS16_TLS_LDM, 107)
112   RELOC_NUMBER (R_MIPS16_TLS_DTPREL_HI16, 108)
113   RELOC_NUMBER (R_MIPS16_TLS_DTPREL_LO16, 109)
114   RELOC_NUMBER (R_MIPS16_TLS_GOTTPREL, 110)
115   RELOC_NUMBER (R_MIPS16_TLS_TPREL_HI16, 111)
116   RELOC_NUMBER (R_MIPS16_TLS_TPREL_LO16, 112)
117   RELOC_NUMBER (R_MIPS16_PC16_S1, 113)
118   FAKE_RELOC (R_MIPS16_max, 114)
119   /* These relocations are specific to VxWorks.  */
120   RELOC_NUMBER (R_MIPS_COPY, 126)
121   RELOC_NUMBER (R_MIPS_JUMP_SLOT, 127)
122 
123   /* These relocations are specific to microMIPS.  */
124   FAKE_RELOC (R_MICROMIPS_min, 130)
125   RELOC_NUMBER (R_MICROMIPS_26_S1, 133)
126   RELOC_NUMBER (R_MICROMIPS_HI16, 134)
127   RELOC_NUMBER (R_MICROMIPS_LO16, 135)
128   RELOC_NUMBER (R_MICROMIPS_GPREL16, 136)	/* In Elf 64:
129 						   alias R_MICROMIPS_GPREL */
130   RELOC_NUMBER (R_MICROMIPS_LITERAL, 137)
131   RELOC_NUMBER (R_MICROMIPS_GOT16, 138)		/* In Elf 64:
132 						   alias R_MICROMIPS_GOT */
133   RELOC_NUMBER (R_MICROMIPS_PC7_S1, 139)
134   RELOC_NUMBER (R_MICROMIPS_PC10_S1, 140)
135   RELOC_NUMBER (R_MICROMIPS_PC16_S1, 141)
136   RELOC_NUMBER (R_MICROMIPS_CALL16, 142)	/* In Elf 64:
137 						   alias R_MICROMIPS_CALL */
138   RELOC_NUMBER (R_MICROMIPS_GOT_DISP, 145)
139   RELOC_NUMBER (R_MICROMIPS_GOT_PAGE, 146)
140   RELOC_NUMBER (R_MICROMIPS_GOT_OFST, 147)
141   RELOC_NUMBER (R_MICROMIPS_GOT_HI16, 148)
142   RELOC_NUMBER (R_MICROMIPS_GOT_LO16, 149)
143   RELOC_NUMBER (R_MICROMIPS_SUB, 150)
144   RELOC_NUMBER (R_MICROMIPS_HIGHER, 151)
145   RELOC_NUMBER (R_MICROMIPS_HIGHEST, 152)
146   RELOC_NUMBER (R_MICROMIPS_CALL_HI16, 153)
147   RELOC_NUMBER (R_MICROMIPS_CALL_LO16, 154)
148   RELOC_NUMBER (R_MICROMIPS_SCN_DISP, 155)
149   RELOC_NUMBER (R_MICROMIPS_JALR, 156)
150   RELOC_NUMBER (R_MICROMIPS_HI0_LO16, 157)
151   /* TLS relocations.  */
152   RELOC_NUMBER (R_MICROMIPS_TLS_GD, 162)
153   RELOC_NUMBER (R_MICROMIPS_TLS_LDM, 163)
154   RELOC_NUMBER (R_MICROMIPS_TLS_DTPREL_HI16, 164)
155   RELOC_NUMBER (R_MICROMIPS_TLS_DTPREL_LO16, 165)
156   RELOC_NUMBER (R_MICROMIPS_TLS_GOTTPREL, 166)
157   RELOC_NUMBER (R_MICROMIPS_TLS_TPREL_HI16, 169)
158   RELOC_NUMBER (R_MICROMIPS_TLS_TPREL_LO16, 170)
159   /* microMIPS GP- and PC-relative relocations. */
160   RELOC_NUMBER (R_MICROMIPS_GPREL7_S2, 172)
161   RELOC_NUMBER (R_MICROMIPS_PC23_S2, 173)
162   FAKE_RELOC (R_MICROMIPS_max, 174)
163 
164   /* This was a GNU extension used by embedded-PIC.  It was co-opted by
165      mips-linux for exception-handling data.  GCC stopped using it in
166      May, 2004, then started using it again for compact unwind tables.  */
167   RELOC_NUMBER (R_MIPS_PC32, 248)
168   RELOC_NUMBER (R_MIPS_EH, 249)
169   /* FIXME: this relocation is used internally by gas.  */
170   RELOC_NUMBER (R_MIPS_GNU_REL16_S2, 250)
171   /* These are GNU extensions to enable C++ vtable garbage collection.  */
172   RELOC_NUMBER (R_MIPS_GNU_VTINHERIT, 253)
173   RELOC_NUMBER (R_MIPS_GNU_VTENTRY, 254)
174 END_RELOC_NUMBERS (R_MIPS_maxext)
175 
176 /* Processor specific flags for the ELF header e_flags field.  */
177 
178 /* At least one .noreorder directive appears in the source.  */
179 #define EF_MIPS_NOREORDER	0x00000001
180 
181 /* File contains position independent code.  */
182 #define EF_MIPS_PIC		0x00000002
183 
184 /* Code in file uses the standard calling sequence for calling
185    position independent code.  */
186 #define EF_MIPS_CPIC		0x00000004
187 
188 /* ???  Unknown flag, set in IRIX 6's BSDdup2.o in libbsd.a.  */
189 #define EF_MIPS_XGOT		0x00000008
190 
191 /* Code in file uses UCODE (obsolete) */
192 #define EF_MIPS_UCODE		0x00000010
193 
194 /* Code in file uses new ABI (-n32 on Irix 6).  */
195 #define EF_MIPS_ABI2		0x00000020
196 
197 /* Process the .MIPS.options section first by ld */
198 #define EF_MIPS_OPTIONS_FIRST	0x00000080
199 
200 /* Indicates code compiled for a 64-bit machine in 32-bit mode
201    (regs are 32-bits wide).  */
202 #define EF_MIPS_32BITMODE	0x00000100
203 
204 /* 32-bit machine but FP registers are 64 bit (-mfp64).  */
205 #define EF_MIPS_FP64		0x00000200
206 
207 /* Code in file uses the IEEE 754-2008 NaN encoding convention.  */
208 #define EF_MIPS_NAN2008		0x00000400
209 
210 /* Architectural Extensions used by this file */
211 #define EF_MIPS_ARCH_ASE	0x0f000000
212 
213 /* Use MDMX multimedia extensions */
214 #define EF_MIPS_ARCH_ASE_MDMX	0x08000000
215 
216 /* Use MIPS-16 ISA extensions */
217 #define EF_MIPS_ARCH_ASE_M16	0x04000000
218 
219 /* Use MICROMIPS ISA extensions.  */
220 #define EF_MIPS_ARCH_ASE_MICROMIPS	0x02000000
221 
222 /* Four bit MIPS architecture field.  */
223 #define EF_MIPS_ARCH		0xf0000000
224 
225 /* -mips1 code.  */
226 #define E_MIPS_ARCH_1		0x00000000
227 
228 /* -mips2 code.  */
229 #define E_MIPS_ARCH_2		0x10000000
230 
231 /* -mips3 code.  */
232 #define E_MIPS_ARCH_3		0x20000000
233 
234 /* -mips4 code.  */
235 #define E_MIPS_ARCH_4		0x30000000
236 
237 /* -mips5 code.  */
238 #define E_MIPS_ARCH_5           0x40000000
239 
240 /* -mips32 code.  */
241 #define E_MIPS_ARCH_32          0x50000000
242 
243 /* -mips64 code.  */
244 #define E_MIPS_ARCH_64          0x60000000
245 
246 /* -mips32r2 code.  */
247 #define E_MIPS_ARCH_32R2        0x70000000
248 
249 /* -mips64r2 code.  */
250 #define E_MIPS_ARCH_64R2        0x80000000
251 
252 /* -mips32r6 code.  */
253 #define E_MIPS_ARCH_32R6        0x90000000
254 
255 /* -mips64r6 code.  */
256 #define E_MIPS_ARCH_64R6        0xa0000000
257 
258 /* The ABI of the file.  Also see EF_MIPS_ABI2 above. */
259 #define EF_MIPS_ABI		0x0000F000
260 
261 /* The original o32 abi. */
262 #define E_MIPS_ABI_O32          0x00001000
263 
264 /* O32 extended to work on 64 bit architectures */
265 #define E_MIPS_ABI_O64          0x00002000
266 
267 /* EABI in 32 bit mode */
268 #define E_MIPS_ABI_EABI32       0x00003000
269 
270 /* EABI in 64 bit mode */
271 #define E_MIPS_ABI_EABI64       0x00004000
272 
273 
274 /* Machine variant if we know it.  This field was invented at Cygnus,
275    but it is hoped that other vendors will adopt it.  If some standard
276    is developed, this code should be changed to follow it. */
277 
278 #define EF_MIPS_MACH		0x00FF0000
279 
280 /* Cygnus is choosing values between 80 and 9F;
281    00 - 7F should be left for a future standard;
282    the rest are open. */
283 
284 #define E_MIPS_MACH_3900	0x00810000
285 #define E_MIPS_MACH_4010	0x00820000
286 #define E_MIPS_MACH_4100	0x00830000
287 #define E_MIPS_MACH_4650	0x00850000
288 #define E_MIPS_MACH_4120	0x00870000
289 #define E_MIPS_MACH_4111	0x00880000
290 #define E_MIPS_MACH_SB1         0x008a0000
291 #define E_MIPS_MACH_OCTEON	0x008b0000
292 #define E_MIPS_MACH_XLR     	0x008c0000
293 #define E_MIPS_MACH_OCTEON2	0x008d0000
294 #define E_MIPS_MACH_OCTEON3	0x008e0000
295 #define E_MIPS_MACH_5400	0x00910000
296 #define E_MIPS_MACH_5900	0x00920000
297 #define E_MIPS_MACH_5500	0x00980000
298 #define E_MIPS_MACH_9000	0x00990000
299 #define E_MIPS_MACH_LS2E        0x00A00000
300 #define E_MIPS_MACH_LS2F        0x00A10000
301 #define E_MIPS_MACH_LS3A        0x00A20000
302 
303 /* Processor specific section indices.  These sections do not actually
304    exist.  Symbols with a st_shndx field corresponding to one of these
305    values have a special meaning.  */
306 
307 /* Defined and allocated common symbol.  Value is virtual address.  If
308    relocated, alignment must be preserved.  */
309 #define SHN_MIPS_ACOMMON	SHN_LORESERVE
310 
311 /* Defined and allocated text symbol.  Value is virtual address.
312    Occur in the dynamic symbol table of Alpha OSF/1 and Irix 5 executables.  */
313 #define SHN_MIPS_TEXT		(SHN_LORESERVE + 1)
314 
315 /* Defined and allocated data symbol.  Value is virtual address.
316    Occur in the dynamic symbol table of Alpha OSF/1 and Irix 5 executables.  */
317 #define SHN_MIPS_DATA		(SHN_LORESERVE + 2)
318 
319 /* Small common symbol.  */
320 #define SHN_MIPS_SCOMMON	(SHN_LORESERVE + 3)
321 
322 /* Small undefined symbol.  */
323 #define SHN_MIPS_SUNDEFINED	(SHN_LORESERVE + 4)
324 
325 /* Processor specific section types.  */
326 
327 /* Section contains the set of dynamic shared objects used when
328    statically linking.  */
329 #define SHT_MIPS_LIBLIST	0x70000000
330 
331 /* I'm not sure what this is, but it's used on Irix 5.  */
332 #define SHT_MIPS_MSYM		0x70000001
333 
334 /* Section contains list of symbols whose definitions conflict with
335    symbols defined in shared objects.  */
336 #define SHT_MIPS_CONFLICT	0x70000002
337 
338 /* Section contains the global pointer table.  */
339 #define SHT_MIPS_GPTAB		0x70000003
340 
341 /* Section contains microcode information.  The exact format is
342    unspecified.  */
343 #define SHT_MIPS_UCODE		0x70000004
344 
345 /* Section contains some sort of debugging information.  The exact
346    format is unspecified.  It's probably ECOFF symbols.  */
347 #define SHT_MIPS_DEBUG		0x70000005
348 
349 /* Section contains register usage information.  */
350 #define SHT_MIPS_REGINFO	0x70000006
351 
352 /* ??? */
353 #define SHT_MIPS_PACKAGE	0x70000007
354 
355 /* ??? */
356 #define SHT_MIPS_PACKSYM	0x70000008
357 
358 /* ??? */
359 #define SHT_MIPS_RELD		0x70000009
360 
361 /* Section contains interface information.  */
362 #define SHT_MIPS_IFACE		0x7000000b
363 
364 /* Section contains description of contents of another section.  */
365 #define SHT_MIPS_CONTENT	0x7000000c
366 
367 /* Section contains miscellaneous options.  */
368 #define SHT_MIPS_OPTIONS	0x7000000d
369 
370 /* ??? */
371 #define SHT_MIPS_SHDR		0x70000010
372 
373 /* ??? */
374 #define SHT_MIPS_FDESC		0x70000011
375 
376 /* ??? */
377 #define SHT_MIPS_EXTSYM		0x70000012
378 
379 /* ??? */
380 #define SHT_MIPS_DENSE		0x70000013
381 
382 /* ??? */
383 #define SHT_MIPS_PDESC		0x70000014
384 
385 /* ??? */
386 #define SHT_MIPS_LOCSYM		0x70000015
387 
388 /* ??? */
389 #define SHT_MIPS_AUXSYM		0x70000016
390 
391 /* ??? */
392 #define SHT_MIPS_OPTSYM		0x70000017
393 
394 /* ??? */
395 #define SHT_MIPS_LOCSTR		0x70000018
396 
397 /* ??? */
398 #define SHT_MIPS_LINE		0x70000019
399 
400 /* ??? */
401 #define SHT_MIPS_RFDESC		0x7000001a
402 
403 /* Delta C++: symbol table */
404 #define SHT_MIPS_DELTASYM	0x7000001b
405 
406 /* Delta C++: instance table */
407 #define SHT_MIPS_DELTAINST	0x7000001c
408 
409 /* Delta C++: class table */
410 #define SHT_MIPS_DELTACLASS	0x7000001d
411 
412 /* DWARF debugging section.  */
413 #define SHT_MIPS_DWARF		0x7000001e
414 
415 /* Delta C++: declarations */
416 #define SHT_MIPS_DELTADECL	0x7000001f
417 
418 /* List of libraries the binary depends on.  Includes a time stamp, version
419    number.  */
420 #define SHT_MIPS_SYMBOL_LIB	0x70000020
421 
422 /* Events section.  */
423 #define SHT_MIPS_EVENTS		0x70000021
424 
425 /* ??? */
426 #define SHT_MIPS_TRANSLATE	0x70000022
427 
428 /* Special pixie sections */
429 #define SHT_MIPS_PIXIE		0x70000023
430 
431 /* Address translation table (for debug info) */
432 #define SHT_MIPS_XLATE		0x70000024
433 
434 /* SGI internal address translation table (for debug info) */
435 #define SHT_MIPS_XLATE_DEBUG	0x70000025
436 
437 /* Intermediate code */
438 #define SHT_MIPS_WHIRL		0x70000026
439 
440 /* C++ exception handling region info */
441 #define SHT_MIPS_EH_REGION	0x70000027
442 
443 /* Obsolete address translation table (for debug info) */
444 #define SHT_MIPS_XLATE_OLD	0x70000028
445 
446 /* Runtime procedure descriptor table exception information (ucode) ??? */
447 #define SHT_MIPS_PDR_EXCEPTION	0x70000029
448 
449 /* ABI related flags section.  */
450 #define SHT_MIPS_ABIFLAGS	0x7000002a
451 
452 /* A section of type SHT_MIPS_LIBLIST contains an array of the
453    following structure.  The sh_link field is the section index of the
454    string table.  The sh_info field is the number of entries in the
455    section.  */
456 typedef struct
457 {
458   /* String table index for name of shared object.  */
459   unsigned long l_name;
460   /* Time stamp.  */
461   unsigned long l_time_stamp;
462   /* Checksum of symbol names and common sizes.  */
463   unsigned long l_checksum;
464   /* String table index for version.  */
465   unsigned long l_version;
466   /* Flags.  */
467   unsigned long l_flags;
468 } Elf32_Lib;
469 
470 /* The external version of Elf32_Lib.  */
471 typedef struct
472 {
473   unsigned char l_name[4];
474   unsigned char l_time_stamp[4];
475   unsigned char l_checksum[4];
476   unsigned char l_version[4];
477   unsigned char l_flags[4];
478 } Elf32_External_Lib;
479 
480 /* The l_flags field of an Elf32_Lib structure may contain the
481    following flags.  */
482 
483 /* Require an exact match at runtime.  */
484 #define LL_EXACT_MATCH		0x00000001
485 
486 /* Ignore version incompatibilities at runtime.  */
487 #define LL_IGNORE_INT_VER	0x00000002
488 
489 /* Require matching minor version number.  */
490 #define LL_REQUIRE_MINOR	0x00000004
491 
492 /* ??? */
493 #define LL_EXPORTS		0x00000008
494 
495 /* Delay loading of this library until really needed.  */
496 #define LL_DELAY_LOAD		0x00000010
497 
498 /* ??? Delta C++ stuff ??? */
499 #define LL_DELTA		0x00000020
500 
501 
502 /* A section of type SHT_MIPS_CONFLICT is an array of indices into the
503    .dynsym section.  Each element has the following type.  */
504 typedef unsigned long Elf32_Conflict;
505 typedef unsigned char Elf32_External_Conflict[4];
506 
507 typedef unsigned long Elf64_Conflict;
508 typedef unsigned char Elf64_External_Conflict[8];
509 
510 /* A section of type SHT_MIPS_GPTAB contains information about how
511    much GP space would be required for different -G arguments.  This
512    information is only used so that the linker can provide informative
513    suggestions as to the best -G value to use.  The sh_info field is
514    the index of the section for which this information applies.  The
515    contents of the section are an array of the following union.  The
516    first element uses the gt_header field.  The remaining elements use
517    the gt_entry field.  */
518 typedef union
519 {
520   struct
521     {
522       /* -G value actually used for this object file.  */
523       unsigned long gt_current_g_value;
524       /* Unused.  */
525       unsigned long gt_unused;
526     } gt_header;
527   struct
528     {
529       /* If this -G argument has been used...  */
530       unsigned long gt_g_value;
531       /* ...this many GP section bytes would be required.  */
532       unsigned long gt_bytes;
533     } gt_entry;
534 } Elf32_gptab;
535 
536 /* The external version of Elf32_gptab.  */
537 
538 typedef union
539 {
540   struct
541     {
542       unsigned char gt_current_g_value[4];
543       unsigned char gt_unused[4];
544     } gt_header;
545   struct
546     {
547       unsigned char gt_g_value[4];
548       unsigned char gt_bytes[4];
549     } gt_entry;
550 } Elf32_External_gptab;
551 
552 /* A section of type SHT_MIPS_REGINFO contains the following
553    structure.  */
554 typedef struct
555 {
556   /* Mask of general purpose registers used.  */
557   unsigned long ri_gprmask;
558   /* Mask of co-processor registers used.  */
559   unsigned long ri_cprmask[4];
560   /* GP register value for this object file.  */
561   long ri_gp_value;
562 } Elf32_RegInfo;
563 
564 /* The external version of the Elf_RegInfo structure.  */
565 typedef struct
566 {
567   unsigned char ri_gprmask[4];
568   unsigned char ri_cprmask[4][4];
569   unsigned char ri_gp_value[4];
570 } Elf32_External_RegInfo;
571 
572 /* MIPS ELF .reginfo swapping routines.  */
573 extern void bfd_mips_elf32_swap_reginfo_in
574   (bfd *, const Elf32_External_RegInfo *, Elf32_RegInfo *);
575 extern void bfd_mips_elf32_swap_reginfo_out
576   (bfd *, const Elf32_RegInfo *, Elf32_External_RegInfo *);
577 
578 /* Processor specific section flags.  */
579 
580 /* This section must be in the global data area.  */
581 #define SHF_MIPS_GPREL		0x10000000
582 
583 /* This section should be merged.  */
584 #define SHF_MIPS_MERGE		0x20000000
585 
586 /* This section contains address data of size implied by section
587    element size.  */
588 #define SHF_MIPS_ADDR		0x40000000
589 
590 /* This section contains string data.  */
591 #define SHF_MIPS_STRING		0x80000000
592 
593 /* This section may not be stripped.  */
594 #define SHF_MIPS_NOSTRIP	0x08000000
595 
596 /* This section is local to threads.  */
597 #define SHF_MIPS_LOCAL		0x04000000
598 
599 /* Linker should generate implicit weak names for this section.  */
600 #define SHF_MIPS_NAMES		0x02000000
601 
602 /* Section contais text/data which may be replicated in other sections.
603    Linker should retain only one copy.  */
604 #define SHF_MIPS_NODUPES	0x01000000
605 
606 /* Processor specific program header types.  */
607 
608 /* Register usage information.  Identifies one .reginfo section.  */
609 #define PT_MIPS_REGINFO		0x70000000
610 
611 /* Runtime procedure table.  */
612 #define PT_MIPS_RTPROC		0x70000001
613 
614 /* .MIPS.options section.  */
615 #define PT_MIPS_OPTIONS		0x70000002
616 
617 /* Records ABI related flags.  */
618 #define PT_MIPS_ABIFLAGS	0x70000003
619 
620 /* Processor specific dynamic array tags.  */
621 
622 /* 32 bit version number for runtime linker interface.  */
623 #define DT_MIPS_RLD_VERSION	0x70000001
624 
625 /* Time stamp.  */
626 #define DT_MIPS_TIME_STAMP	0x70000002
627 
628 /* Checksum of external strings and common sizes.  */
629 #define DT_MIPS_ICHECKSUM	0x70000003
630 
631 /* Index of version string in string table.  */
632 #define DT_MIPS_IVERSION	0x70000004
633 
634 /* 32 bits of flags.  */
635 #define DT_MIPS_FLAGS		0x70000005
636 
637 /* Base address of the segment.  */
638 #define DT_MIPS_BASE_ADDRESS	0x70000006
639 
640 /* ??? */
641 #define DT_MIPS_MSYM		0x70000007
642 
643 /* Address of .conflict section.  */
644 #define DT_MIPS_CONFLICT	0x70000008
645 
646 /* Address of .liblist section.  */
647 #define DT_MIPS_LIBLIST		0x70000009
648 
649 /* Number of local global offset table entries.  */
650 #define DT_MIPS_LOCAL_GOTNO	0x7000000a
651 
652 /* Number of entries in the .conflict section.  */
653 #define DT_MIPS_CONFLICTNO	0x7000000b
654 
655 /* Number of entries in the .liblist section.  */
656 #define DT_MIPS_LIBLISTNO	0x70000010
657 
658 /* Number of entries in the .dynsym section.  */
659 #define DT_MIPS_SYMTABNO	0x70000011
660 
661 /* Index of first external dynamic symbol not referenced locally.  */
662 #define DT_MIPS_UNREFEXTNO	0x70000012
663 
664 /* Index of first dynamic symbol in global offset table.  */
665 #define DT_MIPS_GOTSYM		0x70000013
666 
667 /* Number of page table entries in global offset table.  */
668 #define DT_MIPS_HIPAGENO	0x70000014
669 
670 /* Address of run time loader map, used for debugging.  */
671 #define DT_MIPS_RLD_MAP		0x70000016
672 
673 /* Delta C++ class definition.  */
674 #define DT_MIPS_DELTA_CLASS	0x70000017
675 
676 /* Number of entries in DT_MIPS_DELTA_CLASS.  */
677 #define DT_MIPS_DELTA_CLASS_NO	0x70000018
678 
679 /* Delta C++ class instances.  */
680 #define DT_MIPS_DELTA_INSTANCE	0x70000019
681 
682 /* Number of entries in DT_MIPS_DELTA_INSTANCE.  */
683 #define DT_MIPS_DELTA_INSTANCE_NO	0x7000001a
684 
685 /* Delta relocations.  */
686 #define DT_MIPS_DELTA_RELOC	0x7000001b
687 
688 /* Number of entries in DT_MIPS_DELTA_RELOC.  */
689 #define DT_MIPS_DELTA_RELOC_NO	0x7000001c
690 
691 /* Delta symbols that Delta relocations refer to.  */
692 #define DT_MIPS_DELTA_SYM	0x7000001d
693 
694 /* Number of entries in DT_MIPS_DELTA_SYM.  */
695 #define DT_MIPS_DELTA_SYM_NO	0x7000001e
696 
697 /* Delta symbols that hold class declarations.  */
698 #define DT_MIPS_DELTA_CLASSSYM	0x70000020
699 
700 /* Number of entries in DT_MIPS_DELTA_CLASSSYM.  */
701 #define DT_MIPS_DELTA_CLASSSYM_NO	0x70000021
702 
703 /* Flags indicating information about C++ flavor.  */
704 #define DT_MIPS_CXX_FLAGS	0x70000022
705 
706 /* Pixie information (???).  */
707 #define DT_MIPS_PIXIE_INIT	0x70000023
708 
709 /* Address of .MIPS.symlib */
710 #define DT_MIPS_SYMBOL_LIB	0x70000024
711 
712 /* The GOT index of the first PTE for a segment */
713 #define DT_MIPS_LOCALPAGE_GOTIDX	0x70000025
714 
715 /* The GOT index of the first PTE for a local symbol */
716 #define DT_MIPS_LOCAL_GOTIDX	0x70000026
717 
718 /* The GOT index of the first PTE for a hidden symbol */
719 #define DT_MIPS_HIDDEN_GOTIDX	0x70000027
720 
721 /* The GOT index of the first PTE for a protected symbol */
722 #define DT_MIPS_PROTECTED_GOTIDX	0x70000028
723 
724 /* Address of `.MIPS.options'.  */
725 #define DT_MIPS_OPTIONS		0x70000029
726 
727 /* Address of `.interface'.  */
728 #define DT_MIPS_INTERFACE	0x7000002a
729 
730 /* ??? */
731 #define DT_MIPS_DYNSTR_ALIGN	0x7000002b
732 
733 /* Size of the .interface section.  */
734 #define DT_MIPS_INTERFACE_SIZE	0x7000002c
735 
736 /* Size of rld_text_resolve function stored in the GOT.  */
737 #define DT_MIPS_RLD_TEXT_RESOLVE_ADDR	0x7000002d
738 
739 /* Default suffix of DSO to be added by rld on dlopen() calls.  */
740 #define DT_MIPS_PERF_SUFFIX	0x7000002e
741 
742 /* Size of compact relocation section (O32).  */
743 #define DT_MIPS_COMPACT_SIZE	0x7000002f
744 
745 /* GP value for auxiliary GOTs.  */
746 #define DT_MIPS_GP_VALUE	0x70000030
747 
748 /* Address of auxiliary .dynamic.  */
749 #define DT_MIPS_AUX_DYNAMIC	0x70000031
750 
751 /* Address of the base of the PLTGOT.  */
752 #define DT_MIPS_PLTGOT         0x70000032
753 
754 /* Points to the base of a writable PLT.  */
755 #define DT_MIPS_RWPLT          0x70000034
756 
757 /* Relative offset of run time loader map, used for debugging.  */
758 #define DT_MIPS_RLD_MAP_REL    0x70000035
759 
760 /* Flags which may appear in a DT_MIPS_FLAGS entry.  */
761 
762 /* No flags.  */
763 #define RHF_NONE		0x00000000
764 
765 /* Uses shortcut pointers.  */
766 #define RHF_QUICKSTART		0x00000001
767 
768 /* Hash size is not a power of two.  */
769 #define RHF_NOTPOT		0x00000002
770 
771 /* Ignore LD_LIBRARY_PATH.  */
772 #define RHS_NO_LIBRARY_REPLACEMENT 0x00000004
773 
774 /* DSO address may not be relocated. */
775 #define RHF_NO_MOVE		0x00000008
776 
777 /* SGI specific features. */
778 #define RHF_SGI_ONLY		0x00000010
779 
780 /* Guarantee that .init will finish executing before any non-init
781    code in DSO is called. */
782 #define RHF_GUARANTEE_INIT	   0x00000020
783 
784 /* Contains Delta C++ code. */
785 #define RHF_DELTA_C_PLUS_PLUS	   0x00000040
786 
787 /* Guarantee that .init will start executing before any non-init
788    code in DSO is called. */
789 #define RHF_GUARANTEE_START_INIT   0x00000080
790 
791 /* Generated by pixie. */
792 #define RHF_PIXIE		   0x00000100
793 
794 /* Delay-load DSO by default. */
795 #define RHF_DEFAULT_DELAY_LOAD	   0x00000200
796 
797 /* Object may be requickstarted */
798 #define RHF_REQUICKSTART	   0x00000400
799 
800 /* Object has been requickstarted */
801 #define RHF_REQUICKSTARTED	   0x00000800
802 
803 /* Generated by cord. */
804 #define RHF_CORD		   0x00001000
805 
806 /* Object contains no unresolved undef symbols. */
807 #define RHF_NO_UNRES_UNDEF	   0x00002000
808 
809 /* Symbol table is in a safe order. */
810 #define RHF_RLD_ORDER_SAFE	   0x00004000
811 
812 /* Special values for the st_other field in the symbol table.  These
813    are used in an Irix 5 dynamic symbol table.  */
814 
815 #define STO_DEFAULT		STV_DEFAULT
816 #define STO_INTERNAL		STV_INTERNAL
817 #define STO_HIDDEN		STV_HIDDEN
818 #define STO_PROTECTED		STV_PROTECTED
819 
820 /* Two topmost bits denote the MIPS ISA for .text symbols:
821    + 00 -- standard MIPS code,
822    + 10 -- microMIPS code,
823    + 11 -- MIPS16 code; requires the following two bits to be set too.
824    Note that one of the MIPS16 bits overlaps with STO_MIPS_PIC.  See below
825    for details.  */
826 #define STO_MIPS_ISA		(3 << 6)
827 
828 /* The mask spanning the rest of MIPS psABI flags.  At most one is expected
829    to be set except for STO_MIPS16.  */
830 #define STO_MIPS_FLAGS		(~(STO_MIPS_ISA | ELF_ST_VISIBILITY (-1)))
831 
832 /* The MIPS psABI was updated in 2008 with support for PLTs and copy
833    relocs.  There are therefore two types of nonzero SHN_UNDEF functions:
834    PLT entries and traditional MIPS lazy binding stubs.  We mark the former
835    with STO_MIPS_PLT to distinguish them from the latter.  */
836 #define STO_MIPS_PLT		0x8
837 #define ELF_ST_IS_MIPS_PLT(other)					\
838   ((ELF_ST_IS_MIPS16 (other)						\
839     ? ((other) & (~STO_MIPS16 & STO_MIPS_FLAGS))			\
840     : ((other) & STO_MIPS_FLAGS)) == STO_MIPS_PLT)
841 #define ELF_ST_SET_MIPS_PLT(other)					\
842   ((ELF_ST_IS_MIPS16 (other)						\
843     ? ((other) & (STO_MIPS16 | ~STO_MIPS_FLAGS))			\
844     : ((other) & ~STO_MIPS_FLAGS)) | STO_MIPS_PLT)
845 
846 /* This value is used to mark PIC functions in an object that mixes
847    PIC and non-PIC.  Note that this bit overlaps with STO_MIPS16,
848    although MIPS16 symbols are never considered to be MIPS_PIC.  */
849 #define STO_MIPS_PIC		0x20
850 #define ELF_ST_IS_MIPS_PIC(other) (((other) & STO_MIPS_FLAGS) == STO_MIPS_PIC)
851 #define ELF_ST_SET_MIPS_PIC(other)					\
852   ((ELF_ST_IS_MIPS16 (other)						\
853     ? ((other) & ~(STO_MIPS16 | STO_MIPS_FLAGS))			\
854     : ((other) & ~STO_MIPS_FLAGS)) | STO_MIPS_PIC)
855 
856 /* This value is used for a mips16 .text symbol.  */
857 #define STO_MIPS16		0xf0
858 #define ELF_ST_IS_MIPS16(other) (((other) & STO_MIPS16) == STO_MIPS16)
859 #define ELF_ST_SET_MIPS16(other) ((other) | STO_MIPS16)
860 
861 /* This value is used for a microMIPS .text symbol.  To distinguish from
862    STO_MIPS16, we set top two bits to be 10 to denote STO_MICROMIPS.  The
863    mask is STO_MIPS_ISA.  */
864 #define STO_MICROMIPS		(2 << 6)
865 #define ELF_ST_IS_MICROMIPS(other) (((other) & STO_MIPS_ISA) == STO_MICROMIPS)
866 #define ELF_ST_SET_MICROMIPS(other) (((other) & ~STO_MIPS_ISA) | STO_MICROMIPS)
867 
868 /* Whether code compression (either of the MIPS16 or the microMIPS ASEs)
869    has been indicated for a .text symbol.  */
870 #define ELF_ST_IS_COMPRESSED(other) \
871   (ELF_ST_IS_MIPS16 (other) || ELF_ST_IS_MICROMIPS (other))
872 
873 /* This bit is used on Irix to indicate a symbol whose definition
874    is optional - if, at final link time, it cannot be found, no
875    error message should be produced.  */
876 #define STO_OPTIONAL		(1 << 2)
877 /* A macro to examine the STO_OPTIONAL bit.  */
878 #define ELF_MIPS_IS_OPTIONAL(other)	((other) & STO_OPTIONAL)
879 
880 /* The 64-bit MIPS ELF ABI uses an unusual reloc format.  Each
881    relocation entry specifies up to three actual relocations, all at
882    the same address.  The first relocation which required a symbol
883    uses the symbol in the r_sym field.  The second relocation which
884    requires a symbol uses the symbol in the r_ssym field.  If all
885    three relocations require a symbol, the third one uses a zero
886    value.  */
887 
888 /* An entry in a 64 bit SHT_REL section.  */
889 
890 typedef struct
891 {
892   /* Address of relocation.  */
893   unsigned char r_offset[8];
894   /* Symbol index.  */
895   unsigned char r_sym[4];
896   /* Special symbol.  */
897   unsigned char r_ssym[1];
898   /* Third relocation.  */
899   unsigned char r_type3[1];
900   /* Second relocation.  */
901   unsigned char r_type2[1];
902   /* First relocation.  */
903   unsigned char r_type[1];
904 } Elf64_Mips_External_Rel;
905 
906 typedef struct
907 {
908   /* Address of relocation.  */
909   bfd_vma r_offset;
910   /* Symbol index.  */
911   unsigned long r_sym;
912   /* Special symbol.  */
913   unsigned char r_ssym;
914   /* Third relocation.  */
915   unsigned char r_type3;
916   /* Second relocation.  */
917   unsigned char r_type2;
918   /* First relocation.  */
919   unsigned char r_type;
920 } Elf64_Mips_Internal_Rel;
921 
922 /* An entry in a 64 bit SHT_RELA section.  */
923 
924 typedef struct
925 {
926   /* Address of relocation.  */
927   unsigned char r_offset[8];
928   /* Symbol index.  */
929   unsigned char r_sym[4];
930   /* Special symbol.  */
931   unsigned char r_ssym[1];
932   /* Third relocation.  */
933   unsigned char r_type3[1];
934   /* Second relocation.  */
935   unsigned char r_type2[1];
936   /* First relocation.  */
937   unsigned char r_type[1];
938   /* Addend.  */
939   unsigned char r_addend[8];
940 } Elf64_Mips_External_Rela;
941 
942 typedef struct
943 {
944   /* Address of relocation.  */
945   bfd_vma r_offset;
946   /* Symbol index.  */
947   unsigned long r_sym;
948   /* Special symbol.  */
949   unsigned char r_ssym;
950   /* Third relocation.  */
951   unsigned char r_type3;
952   /* Second relocation.  */
953   unsigned char r_type2;
954   /* First relocation.  */
955   unsigned char r_type;
956   /* Addend.  */
957   bfd_signed_vma r_addend;
958 } Elf64_Mips_Internal_Rela;
959 
960 /* MIPS ELF 64 relocation info access macros.  */
961 #define ELF64_MIPS_R_SSYM(i) (((i) >> 24) & 0xff)
962 #define ELF64_MIPS_R_TYPE3(i) (((i) >> 16) & 0xff)
963 #define ELF64_MIPS_R_TYPE2(i) (((i) >> 8) & 0xff)
964 #define ELF64_MIPS_R_TYPE(i) ((i) & 0xff)
965 
966 /* Values found in the r_ssym field of a relocation entry.  */
967 
968 /* No relocation.  */
969 #define RSS_UNDEF	0
970 
971 /* Value of GP.  */
972 #define RSS_GP		1
973 
974 /* Value of GP in object being relocated.  */
975 #define RSS_GP0		2
976 
977 /* Address of location being relocated.  */
978 #define RSS_LOC		3
979 
980 /* A SHT_MIPS_OPTIONS section contains a series of options, each of
981    which starts with this header.  */
982 
983 typedef struct
984 {
985   /* Type of option.  */
986   unsigned char kind[1];
987   /* Size of option descriptor, including header.  */
988   unsigned char size[1];
989   /* Section index of affected section, or 0 for global option.  */
990   unsigned char section[2];
991   /* Information specific to this kind of option.  */
992   unsigned char info[4];
993 } Elf_External_Options;
994 
995 typedef struct
996 {
997   /* Type of option.  */
998   unsigned char kind;
999   /* Size of option descriptor, including header.  */
1000   unsigned char size;
1001   /* Section index of affected section, or 0 for global option.  */
1002   unsigned short section;
1003   /* Information specific to this kind of option.  */
1004   unsigned long info;
1005 } Elf_Internal_Options;
1006 
1007 /* MIPS ELF option header swapping routines.  */
1008 extern void bfd_mips_elf_swap_options_in
1009   (bfd *, const Elf_External_Options *, Elf_Internal_Options *);
1010 extern void bfd_mips_elf_swap_options_out
1011   (bfd *, const Elf_Internal_Options *, Elf_External_Options *);
1012 
1013 /* Values which may appear in the kind field of an Elf_Options
1014    structure.  */
1015 
1016 /* Undefined.  */
1017 #define ODK_NULL	0
1018 
1019 /* Register usage and GP value.  */
1020 #define ODK_REGINFO	1
1021 
1022 /* Exception processing information.  */
1023 #define ODK_EXCEPTIONS	2
1024 
1025 /* Section padding information.  */
1026 #define ODK_PAD		3
1027 
1028 /* Hardware workarounds performed.  */
1029 #define ODK_HWPATCH	4
1030 
1031 /* Fill value used by the linker.  */
1032 #define ODK_FILL	5
1033 
1034 /* Reserved space for desktop tools.  */
1035 #define ODK_TAGS	6
1036 
1037 /* Hardware workarounds, AND bits when merging.  */
1038 #define ODK_HWAND	7
1039 
1040 /* Hardware workarounds, OR bits when merging.  */
1041 #define ODK_HWOR	8
1042 
1043 /* GP group to use for text/data sections.  */
1044 #define ODK_GP_GROUP	9
1045 
1046 /* ID information.  */
1047 #define ODK_IDENT	10
1048 
1049 /* In the 32 bit ABI, an ODK_REGINFO option is just a Elf32_RegInfo
1050    structure.  In the 64 bit ABI, it is the following structure.  The
1051    info field of the options header is not used.  */
1052 
1053 typedef struct
1054 {
1055   /* Mask of general purpose registers used.  */
1056   unsigned char ri_gprmask[4];
1057   /* Padding.  */
1058   unsigned char ri_pad[4];
1059   /* Mask of co-processor registers used.  */
1060   unsigned char ri_cprmask[4][4];
1061   /* GP register value for this object file.  */
1062   unsigned char ri_gp_value[8];
1063 } Elf64_External_RegInfo;
1064 
1065 typedef struct
1066 {
1067   /* Mask of general purpose registers used.  */
1068   unsigned long ri_gprmask;
1069   /* Padding.  */
1070   unsigned long ri_pad;
1071   /* Mask of co-processor registers used.  */
1072   unsigned long ri_cprmask[4];
1073   /* GP register value for this object file.  */
1074   bfd_vma ri_gp_value;
1075 } Elf64_Internal_RegInfo;
1076 
1077 /* ABI Flags structure version 0.  */
1078 
1079 typedef struct
1080 {
1081   /* Version of flags structure.  */
1082   unsigned char version[2];
1083   /* The level of the ISA: 1-5, 32, 64.  */
1084   unsigned char isa_level[1];
1085   /* The revision of ISA: 0 for MIPS V and below, 1-n otherwise.  */
1086   unsigned char isa_rev[1];
1087   /* The size of general purpose registers.  */
1088   unsigned char gpr_size[1];
1089   /* The size of co-processor 1 registers.  */
1090   unsigned char cpr1_size[1];
1091   /* The size of co-processor 2 registers.  */
1092   unsigned char cpr2_size[1];
1093   /* The floating-point ABI.  */
1094   unsigned char fp_abi[1];
1095   /* Processor-specific extension.  */
1096   unsigned char isa_ext[4];
1097   /* Mask of ASEs used.  */
1098   unsigned char ases[4];
1099   /* Mask of general flags.  */
1100   unsigned char flags1[4];
1101   unsigned char flags2[4];
1102 } Elf_External_ABIFlags_v0;
1103 
1104 typedef struct
1105 {
1106   /* Version of flags structure.  */
1107   unsigned short version;
1108   /* The level of the ISA: 1-5, 32, 64.  */
1109   unsigned char isa_level;
1110   /* The revision of ISA: 0 for MIPS V and below, 1-n otherwise.  */
1111   unsigned char isa_rev;
1112   /* The size of general purpose registers.  */
1113   unsigned char gpr_size;
1114   /* The size of co-processor 1 registers.  */
1115   unsigned char cpr1_size;
1116   /* The size of co-processor 2 registers.  */
1117   unsigned char cpr2_size;
1118   /* The floating-point ABI.  */
1119   unsigned char fp_abi;
1120   /* Processor-specific extension.  */
1121   unsigned long isa_ext;
1122   /* Mask of ASEs used.  */
1123   unsigned long ases;
1124   /* Mask of general flags.  */
1125   unsigned long flags1;
1126   unsigned long flags2;
1127 } Elf_Internal_ABIFlags_v0;
1128 
1129 typedef struct
1130 {
1131   /* The hash value computed from the name of the corresponding
1132      dynamic symbol.  */
1133   unsigned char ms_hash_value[4];
1134   /* Contains both the dynamic relocation index and the symbol flags
1135      field.  The macros ELF32_MS_REL_INDEX and ELF32_MS_FLAGS are used
1136      to access the individual values.  The dynamic relocation index
1137      identifies the first entry in the .rel.dyn section that
1138      references the dynamic symbol corresponding to this msym entry.
1139      If the index is 0, no dynamic relocations are associated with the
1140      symbol.  The symbol flags field is reserved for future use.  */
1141   unsigned char ms_info[4];
1142 } Elf32_External_Msym;
1143 
1144 typedef struct
1145 {
1146   /* The hash value computed from the name of the corresponding
1147      dynamic symbol.  */
1148   unsigned long ms_hash_value;
1149   /* Contains both the dynamic relocation index and the symbol flags
1150      field.  The macros ELF32_MS_REL_INDEX and ELF32_MS_FLAGS are used
1151      to access the individual values.  The dynamic relocation index
1152      identifies the first entry in the .rel.dyn section that
1153      references the dynamic symbol corresponding to this msym entry.
1154      If the index is 0, no dynamic relocations are associated with the
1155      symbol.  The symbol flags field is reserved for future use.  */
1156   unsigned long ms_info;
1157 } Elf32_Internal_Msym;
1158 
1159 #define ELF32_MS_REL_INDEX(i) ((i) >> 8)
1160 #define ELF32_MS_FLAGS(i)     (i) & 0xff)
1161 #define ELF32_MS_INFO(r, f)   (((r) << 8) + ((f) & 0xff))
1162 
1163 /* MIPS ELF reginfo swapping routines.  */
1164 extern void bfd_mips_elf64_swap_reginfo_in
1165   (bfd *, const Elf64_External_RegInfo *, Elf64_Internal_RegInfo *);
1166 extern void bfd_mips_elf64_swap_reginfo_out
1167   (bfd *, const Elf64_Internal_RegInfo *, Elf64_External_RegInfo *);
1168 
1169 /* MIPS ELF flags swapping routines.  */
1170 extern void bfd_mips_elf_swap_abiflags_v0_in
1171   (bfd *, const Elf_External_ABIFlags_v0 *, Elf_Internal_ABIFlags_v0 *);
1172 extern void bfd_mips_elf_swap_abiflags_v0_out
1173   (bfd *, const Elf_Internal_ABIFlags_v0 *, Elf_External_ABIFlags_v0 *);
1174 
1175 /* Masks for the info work of an ODK_EXCEPTIONS descriptor.  */
1176 #define OEX_FPU_MIN	0x1f	/* FPEs which must be enabled.  */
1177 #define OEX_FPU_MAX	0x1f00	/* FPEs which may be enabled.  */
1178 #define OEX_PAGE0	0x10000	/* Page zero must be mapped.  */
1179 #define OEX_SMM		0x20000	/* Force sequential memory mode.  */
1180 #define OEX_FPDBUG	0x40000	/* Force precise floating-point
1181 				   exceptions (debug mode).  */
1182 #define OEX_DISMISS	0x80000	/* Dismiss invalid address faults.  */
1183 
1184 /* Masks of the FP exceptions for OEX_FPU_MIN and OEX_FPU_MAX.  */
1185 #define OEX_FPU_INVAL	0x10	/* Invalid operation exception.  */
1186 #define OEX_FPU_DIV0	0x08	/* Division by zero exception.  */
1187 #define OEX_FPU_OFLO	0x04	/* Overflow exception.  */
1188 #define OEX_FPU_UFLO	0x02	/* Underflow exception.  */
1189 #define OEX_FPU_INEX	0x01	/* Inexact exception.  */
1190 
1191 /* Masks for the info word of an ODK_PAD descriptor.  */
1192 #define OPAD_PREFIX	0x01
1193 #define OPAD_POSTFIX	0x02
1194 #define OPAD_SYMBOL	0x04
1195 
1196 /* Masks for the info word of an ODK_HWPATCH descriptor.  */
1197 #define OHW_R4KEOP	0x00000001	/* R4000 end-of-page patch.  */
1198 #define OHW_R8KPFETCH	0x00000002	/* May need R8000 prefetch patch.  */
1199 #define OHW_R5KEOP	0x00000004	/* R5000 end-of-page patch.  */
1200 #define OHW_R5KCVTL	0x00000008	/* R5000 cvt.[ds].l bug
1201 					   (clean == 1).  */
1202 #define OHW_R10KLDL	0x00000010	/* Needs R10K misaligned
1203 					   load patch. */
1204 
1205 /* Masks for the info word of an ODK_IDENT/ODK_GP_GROUP descriptor.  */
1206 #define OGP_GROUP	0x0000ffff	/* GP group number.  */
1207 #define OGP_SELF	0xffff0000	/* Self-contained GP groups.  */
1208 
1209 /* Masks for the info word of an ODK_HWAND/ODK_HWOR descriptor.  */
1210 #define OHWA0_R4KEOP_CHECKED	0x00000001
1211 #define OHWA0_R4KEOP_CLEAN	0x00000002
1212 
1213 /* Values for the xxx_size bytes of an ABI flags structure.  */
1214 
1215 #define AFL_REG_NONE	     0x00	/* No registers.  */
1216 #define AFL_REG_32	     0x01	/* 32-bit registers.  */
1217 #define AFL_REG_64	     0x02	/* 64-bit registers.  */
1218 #define AFL_REG_128	     0x03	/* 128-bit registers.  */
1219 
1220 /* Masks for the ases word of an ABI flags structure.  */
1221 
1222 #define AFL_ASE_DSP          0x00000001 /* DSP ASE.  */
1223 #define AFL_ASE_DSPR2        0x00000002 /* DSP R2 ASE.  */
1224 #define AFL_ASE_EVA          0x00000004 /* Enhanced VA Scheme.  */
1225 #define AFL_ASE_MCU          0x00000008 /* MCU (MicroController) ASE.  */
1226 #define AFL_ASE_MDMX         0x00000010 /* MDMX ASE.  */
1227 #define AFL_ASE_MIPS3D       0x00000020 /* MIPS-3D ASE.  */
1228 #define AFL_ASE_MT           0x00000040 /* MT ASE.  */
1229 #define AFL_ASE_SMARTMIPS    0x00000080 /* SmartMIPS ASE.  */
1230 #define AFL_ASE_VIRT         0x00000100 /* VZ ASE.  */
1231 #define AFL_ASE_MSA          0x00000200 /* MSA ASE.  */
1232 #define AFL_ASE_MIPS16       0x00000400 /* MIPS16 ASE.  */
1233 #define AFL_ASE_MICROMIPS    0x00000800 /* MICROMIPS ASE.  */
1234 #define AFL_ASE_XPA          0x00001000 /* XPA ASE.  */
1235 #define AFL_ASE_DSPR3        0x00002000 /* DSP R3 ASE.  */
1236 #define AFL_ASE_MASK         0x00003fff /* All ASEs.  */
1237 
1238 /* Values for the isa_ext word of an ABI flags structure.  */
1239 
1240 #define AFL_EXT_XLR           1  /* RMI Xlr instruction.  */
1241 #define AFL_EXT_OCTEON2       2  /* Cavium Networks Octeon2.  */
1242 #define AFL_EXT_OCTEONP       3  /* Cavium Networks OcteonP.  */
1243 #define AFL_EXT_LOONGSON_3A   4  /* Loongson 3A.  */
1244 #define AFL_EXT_OCTEON        5  /* Cavium Networks Octeon.  */
1245 #define AFL_EXT_5900          6  /* MIPS R5900 instruction.  */
1246 #define AFL_EXT_4650          7  /* MIPS R4650 instruction.  */
1247 #define AFL_EXT_4010          8  /* LSI R4010 instruction.  */
1248 #define AFL_EXT_4100          9  /* NEC VR4100 instruction.  */
1249 #define AFL_EXT_3900         10  /* Toshiba R3900 instruction.  */
1250 #define AFL_EXT_10000        11  /* MIPS R10000 instruction.  */
1251 #define AFL_EXT_SB1          12  /* Broadcom SB-1 instruction.  */
1252 #define AFL_EXT_4111         13  /* NEC VR4111/VR4181 instruction.  */
1253 #define AFL_EXT_4120         14  /* NEC VR4120 instruction.  */
1254 #define AFL_EXT_5400         15  /* NEC VR5400 instruction.  */
1255 #define AFL_EXT_5500         16  /* NEC VR5500 instruction.  */
1256 #define AFL_EXT_LOONGSON_2E  17  /* ST Microelectronics Loongson 2E.  */
1257 #define AFL_EXT_LOONGSON_2F  18  /* ST Microelectronics Loongson 2F.  */
1258 #define AFL_EXT_OCTEON3      19  /* Cavium Networks Octeon3.  */
1259 
1260 /* Masks for the flags1 word of an ABI flags structure.  */
1261 #define AFL_FLAGS1_ODDSPREG   1	 /* Uses odd single-precision registers.  */
1262 
1263 extern unsigned int bfd_mips_isa_ext (bfd *);
1264 
1265 
1266 /* Object attribute tags.  */
1267 enum
1268 {
1269   /* 0-3 are generic.  */
1270 
1271   /* Floating-point ABI used by this object file.  */
1272   Tag_GNU_MIPS_ABI_FP = 4,
1273 
1274   /* MSA ABI used by this object file.  */
1275   Tag_GNU_MIPS_ABI_MSA = 8,
1276 };
1277 
1278 /* Object attribute values.  */
1279 enum
1280 {
1281   /* Values defined for Tag_GNU_MIPS_ABI_FP.  */
1282 
1283   /* Not tagged or not using any ABIs affected by the differences.  */
1284   Val_GNU_MIPS_ABI_FP_ANY = 0,
1285 
1286   /* Using hard-float -mdouble-float.  */
1287   Val_GNU_MIPS_ABI_FP_DOUBLE = 1,
1288 
1289   /* Using hard-float -msingle-float.  */
1290   Val_GNU_MIPS_ABI_FP_SINGLE = 2,
1291 
1292   /* Using soft-float.  */
1293   Val_GNU_MIPS_ABI_FP_SOFT = 3,
1294 
1295   /* Using -mips32r2 -mfp64.  */
1296   Val_GNU_MIPS_ABI_FP_OLD_64 = 4,
1297 
1298   /* Using -mfpxx */
1299   Val_GNU_MIPS_ABI_FP_XX = 5,
1300 
1301   /* Using -mips32r2 -mfp64.  */
1302   Val_GNU_MIPS_ABI_FP_64 = 6,
1303 
1304   /* Using -mips32r2 -mfp64 -mno-odd-spreg.  */
1305   Val_GNU_MIPS_ABI_FP_64A = 7,
1306 
1307   /* This is reserved for backward-compatibility with an earlier
1308      implementation of the MIPS NaN2008 functionality.  */
1309   Val_GNU_MIPS_ABI_FP_NAN2008 = 8,
1310 
1311   /* Values defined for Tag_GNU_MIPS_ABI_MSA.  */
1312 
1313   /* Not tagged or not using any ABIs affected by the differences.  */
1314   Val_GNU_MIPS_ABI_MSA_ANY = 0,
1315 
1316   /* Using 128-bit MSA.  */
1317   Val_GNU_MIPS_ABI_MSA_128 = 1,
1318 };
1319 
1320 #ifdef __cplusplus
1321 }
1322 #endif
1323 
1324 #endif /* _ELF_MIPS_H */
1325