Fix typo.
[external/binutils.git] / include / elf / mips.h
1 /* MIPS ELF support for BFD.
2    Copyright (C) 1993, 1994, 1995, 1996, 1998 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 2 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
23
24 /* This file holds definitions specific to the MIPS ELF ABI.  Note
25    that most of this is not actually implemented by BFD.  */
26
27 #ifndef _ELF_MIPS_H
28 #define _ELF_MIPS_H
29
30 /* Relocation types.  */
31 START_RELOC_NUMBERS (elf_mips_reloc_type)
32   RELOC_NUMBER (R_MIPS_NONE, 0)
33   RELOC_NUMBER (R_MIPS_16, 1)
34   RELOC_NUMBER (R_MIPS_32, 2)
35   RELOC_NUMBER (R_MIPS_REL32, 3)
36   RELOC_NUMBER (R_MIPS_26, 4)
37   RELOC_NUMBER (R_MIPS_HI16, 5)
38   RELOC_NUMBER (R_MIPS_LO16, 6)
39   RELOC_NUMBER (R_MIPS_GPREL16, 7)
40   RELOC_NUMBER (R_MIPS_LITERAL, 8)
41   RELOC_NUMBER (R_MIPS_GOT16, 9)
42   RELOC_NUMBER (R_MIPS_PC16, 10)
43   RELOC_NUMBER (R_MIPS_CALL16, 11)
44   RELOC_NUMBER (R_MIPS_GPREL32, 12)
45   /* The remaining relocs are defined on Irix, although they are not
46      in the MIPS ELF ABI.  */
47   RELOC_NUMBER (R_MIPS_UNUSED1, 13)
48   RELOC_NUMBER (R_MIPS_UNUSED2, 14)
49   RELOC_NUMBER (R_MIPS_UNUSED3, 15)
50   RELOC_NUMBER (R_MIPS_SHIFT5, 16)
51   RELOC_NUMBER (R_MIPS_SHIFT6, 17)
52   RELOC_NUMBER (R_MIPS_64, 18)
53   RELOC_NUMBER (R_MIPS_GOT_DISP, 19)
54   RELOC_NUMBER (R_MIPS_GOT_PAGE, 20)
55   RELOC_NUMBER (R_MIPS_GOT_OFST, 21)
56   RELOC_NUMBER (R_MIPS_GOT_HI16, 22)
57   RELOC_NUMBER (R_MIPS_GOT_LO16, 23)
58   RELOC_NUMBER (R_MIPS_SUB, 24)
59   RELOC_NUMBER (R_MIPS_INSERT_A, 25)
60   RELOC_NUMBER (R_MIPS_INSERT_B, 26)
61   RELOC_NUMBER (R_MIPS_DELETE, 27)
62   RELOC_NUMBER (R_MIPS_HIGHER, 28)
63   RELOC_NUMBER (R_MIPS_HIGHEST, 29)
64   RELOC_NUMBER (R_MIPS_CALL_HI16, 30)
65   RELOC_NUMBER (R_MIPS_CALL_LO16, 31)
66 /* start-sanitize-r5900 */
67   /* This is used by a mips co-processor instruction.  */
68   RELOC_NUMBER (R_MIPS15_S3, 32)
69 /* end-sanitize-r5900 */
70   RELOC_NUMBER (R_MIPS_max, 33)
71   /* These relocs are used for the mips16.  */
72   RELOC_NUMBER (R_MIPS16_26, 100)
73   RELOC_NUMBER (R_MIPS16_GPREL, 101)
74 /* start-sanitize-sky */
75   /* These relocs are for the dvp.  */
76   RELOC_NUMBER (R_MIPS_DVP_11_PCREL, 120)
77   RELOC_NUMBER (R_MIPS_DVP_27_S4, 121)
78   RELOC_NUMBER (R_MIPS_DVP_11_S4, 122)
79   RELOC_NUMBER (R_MIPS_DVP_U15_S3, 123)
80 /* end-sanitize-sky */
81   /* These are GNU extensions to enable C++ vtable garbage collection.  */
82   RELOC_NUMBER (R_MIPS_GNU_VTINHERIT, 253)
83   RELOC_NUMBER (R_MIPS_GNU_VTENTRY, 254)
84 END_RELOC_NUMBERS
85
86 /* Processor specific flags for the ELF header e_flags field.  */
87
88 /* At least one .noreorder directive appears in the source.  */
89 #define EF_MIPS_NOREORDER       0x00000001
90
91 /* File contains position independent code.  */
92 #define EF_MIPS_PIC             0x00000002
93
94 /* Code in file uses the standard calling sequence for calling
95    position independent code.  */
96 #define EF_MIPS_CPIC            0x00000004
97
98 /* Code in file uses new ABI (-n32 on Irix 6).  */
99 #define EF_MIPS_ABI2            0x00000020
100
101 /* Four bit MIPS architecture field.  */
102 #define EF_MIPS_ARCH            0xf0000000
103
104 /* -mips1 code.  */
105 #define E_MIPS_ARCH_1           0x00000000
106
107 /* -mips2 code.  */
108 #define E_MIPS_ARCH_2           0x10000000
109
110 /* -mips3 code.  */
111 #define E_MIPS_ARCH_3           0x20000000
112
113 /* -mips4 code.  */
114 #define E_MIPS_ARCH_4           0x30000000
115
116 /* Machine variant if we know it.  This field was invented at Cygnus,
117    but it is hoped that other vendors will adopt it.  If some standard
118    is developed, this code should be changed to follow it. */
119
120 #define EF_MIPS_MACH            0x00FF0000
121
122 /* Cygnus is choosing values between 80 and 9F;
123    00 - 7F should be left for a future standard;
124    the rest are open. */
125
126 #define E_MIPS_MACH_3900        0x00810000
127
128 #define E_MIPS_MACH_4010        0x00820000
129 #define E_MIPS_MACH_4100        0x00830000
130 /* start-sanitize-vr4320 */
131 #define E_MIPS_MACH_4320        0x00840000
132 /* end-sanitize-vr4320 */
133 #define E_MIPS_MACH_4650        0x00850000
134 /* start-sanitize-tx49 */
135 #define E_MIPS_MACH_4900        0x00860000
136 /* end-sanitize-tx49 */
137
138 /* start-sanitize-vr5400 */
139 #define E_MIPS_MACH_5400        0x00910000
140 /* end-sanitize-vr5400 */
141 /* start-sanitize-r5900 */
142 #define E_MIPS_MACH_5900        0x00920000
143 /* end-sanitize-r5900 */
144 \f
145 /* Processor specific section indices.  These sections do not actually
146    exist.  Symbols with a st_shndx field corresponding to one of these
147    values have a special meaning.  */
148
149 /* Defined and allocated common symbol.  Value is virtual address.  If
150    relocated, alignment must be preserved.  */
151 #define SHN_MIPS_ACOMMON        0xff00
152
153 /* Defined and allocated text symbol.  Value is virtual address.
154    Occur in the dynamic symbol table of Alpha OSF/1 and Irix 5 executables.  */
155 #define SHN_MIPS_TEXT           0xff01
156
157 /* Defined and allocated data symbol.  Value is virtual address.
158    Occur in the dynamic symbol table of Alpha OSF/1 and Irix 5 executables.  */
159 #define SHN_MIPS_DATA           0xff02
160
161 /* Small common symbol.  */
162 #define SHN_MIPS_SCOMMON        0xff03
163
164 /* Small undefined symbol.  */
165 #define SHN_MIPS_SUNDEFINED     0xff04
166 \f
167 /* Processor specific section types.  */
168
169 /* Section contains the set of dynamic shared objects used when
170    statically linking.  */
171 #define SHT_MIPS_LIBLIST        0x70000000
172
173 /* I'm not sure what this is, but it's used on Irix 5.  */
174 #define SHT_MIPS_MSYM           0x70000001
175
176 /* Section contains list of symbols whose definitions conflict with
177    symbols defined in shared objects.  */
178 #define SHT_MIPS_CONFLICT       0x70000002
179
180 /* Section contains the global pointer table.  */
181 #define SHT_MIPS_GPTAB          0x70000003
182
183 /* Section contains microcode information.  The exact format is
184    unspecified.  */
185 #define SHT_MIPS_UCODE          0x70000004
186
187 /* Section contains some sort of debugging information.  The exact
188    format is unspecified.  It's probably ECOFF symbols.  */
189 #define SHT_MIPS_DEBUG          0x70000005
190
191 /* Section contains register usage information.  */
192 #define SHT_MIPS_REGINFO        0x70000006
193
194 /* ??? */
195 #define SHT_MIPS_PACKAGE        0x70000007
196
197 /* ??? */
198 #define SHT_MIPS_PACKSYM        0x70000008
199
200 /* ??? */
201 #define SHT_MIPS_RELD           0x70000009
202
203 /* Section contains interface information.  */
204 #define SHT_MIPS_IFACE          0x7000000b
205
206 /* Section contains description of contents of another section.  */
207 #define SHT_MIPS_CONTENT        0x7000000c
208
209 /* Section contains miscellaneous options.  */
210 #define SHT_MIPS_OPTIONS        0x7000000d
211
212 /* ??? */
213 #define SHT_MIPS_SHDR           0x70000010
214
215 /* ??? */
216 #define SHT_MIPS_FDESC          0x70000011
217
218 /* ??? */
219 #define SHT_MIPS_EXTSYM         0x70000012
220
221 /* ??? */
222 #define SHT_MIPS_DENSE          0x70000013
223
224 /* ??? */
225 #define SHT_MIPS_PDESC          0x70000014
226
227 /* ??? */
228 #define SHT_MIPS_LOCSYM         0x70000015
229
230 /* ??? */
231 #define SHT_MIPS_AUXSYM         0x70000016
232
233 /* ??? */
234 #define SHT_MIPS_OPTSYM         0x70000017
235
236 /* ??? */
237 #define SHT_MIPS_LOCSTR         0x70000018
238
239 /* ??? */
240 #define SHT_MIPS_LINE           0x70000019
241
242 /* ??? */
243 #define SHT_MIPS_RFDESC         0x7000001a
244
245 /* ??? */
246 #define SHT_MIPS_DELTASYM       0x7000001b
247
248 /* ??? */
249 #define SHT_MIPS_DELTAINST      0x7000001c
250
251 /* ??? */
252 #define SHT_MIPS_DELTACLASS     0x7000001d
253
254 /* DWARF debugging section.  */
255 #define SHT_MIPS_DWARF          0x7000001e
256
257 /* ??? */
258 #define SHT_MIPS_DELTADECL      0x7000001f
259
260 /* List of libraries the binary depends on.  Includes a time stamp, version
261    number.  */
262 #define SHT_MIPS_SYMBOL_LIB     0x70000020
263
264 /* Events section.  */
265 #define SHT_MIPS_EVENTS         0x70000021
266
267 /* ??? */
268 #define SHT_MIPS_TRANSLATE      0x70000022
269
270 /* ??? */
271 #define SHT_MIPS_PIXIE          0x70000023
272
273 /* ??? */
274 #define SHT_MIPS_XLATE          0x70000024
275
276 /* ??? */
277 #define SHT_MIPS_XLATE_DEBUG    0x70000025
278
279 /* ??? */
280 #define SHT_MIPS_WHIRL          0x70000026
281
282 /* ??? */
283 #define SHT_MIPS_EH_REGION      0x70000027
284
285 /* ??? */
286 #define SHT_MIPS_XLATE_OLD      0x70000028
287
288 /* ??? */
289 #define SHT_MIPS_PDR_EXCEPTION  0x70000029
290
291 /* start-sanitize-sky */
292 /* The VU overlay table.  */
293 #define SHT_DVP_OVERLAY_TABLE           0x7ffff420
294 #define SHNAME_DVP_OVERLAY_TABLE        ".DVP.ovlytab"
295 #define SHNAME_DVP_OVERLAY_STRTAB       ".DVP.ovlystrtab"
296 /* A VU overlay.  */
297 #define SHT_DVP_OVERLAY                 0x7ffff421
298 /* Prefix of VU overlay sections.  */
299 #define SHNAME_DVP_OVERLAY_PREFIX       ".DVP.overlay."
300 /* end-sanitize-sky */
301
302 /* A section of type SHT_MIPS_LIBLIST contains an array of the
303    following structure.  The sh_link field is the section index of the
304    string table.  The sh_info field is the number of entries in the
305    section.  */
306 typedef struct
307 {
308   /* String table index for name of shared object.  */
309   unsigned long l_name;
310   /* Time stamp.  */
311   unsigned long l_time_stamp;
312   /* Checksum of symbol names and common sizes.  */
313   unsigned long l_checksum;
314   /* String table index for version.  */
315   unsigned long l_version;
316   /* Flags.  */
317   unsigned long l_flags;
318 } Elf32_Lib;
319
320 /* The external version of Elf32_Lib.  */
321 typedef struct
322 {
323   unsigned char l_name[4];
324   unsigned char l_time_stamp[4];
325   unsigned char l_checksum[4];
326   unsigned char l_version[4];
327   unsigned char l_flags[4];
328 } Elf32_External_Lib;
329
330 /* The l_flags field of an Elf32_Lib structure may contain the
331    following flags.  */
332
333 /* Require an exact match at runtime.  */
334 #define LL_EXACT_MATCH          0x00000001
335
336 /* Ignore version incompatibilities at runtime.  */
337 #define LL_IGNORE_INT_VER       0x00000002
338
339 /* A section of type SHT_MIPS_CONFLICT is an array of indices into the
340    .dynsym section.  Each element has the following type.  */
341 typedef unsigned long Elf32_Conflict;
342
343 /* A section of type SHT_MIPS_GPTAB contains information about how
344    much GP space would be required for different -G arguments.  This
345    information is only used so that the linker can provide informative
346    suggestions as to the best -G value to use.  The sh_info field is
347    the index of the section for which this information applies.  The
348    contents of the section are an array of the following union.  The
349    first element uses the gt_header field.  The remaining elements use
350    the gt_entry field.  */
351 typedef union
352 {
353   struct
354     {
355       /* -G value actually used for this object file.  */
356       unsigned long gt_current_g_value;
357       /* Unused.  */
358       unsigned long gt_unused;
359     } gt_header;
360   struct
361     {
362       /* If this -G argument has been used...  */
363       unsigned long gt_g_value;
364       /* ...this many GP section bytes would be required.  */
365       unsigned long gt_bytes;
366     } gt_entry;
367 } Elf32_gptab;
368
369 /* The external version of Elf32_gptab.  */
370
371 typedef union
372 {
373   struct
374     {
375       unsigned char gt_current_g_value[4];
376       unsigned char gt_unused[4];
377     } gt_header;
378   struct
379     {
380       unsigned char gt_g_value[4];
381       unsigned char gt_bytes[4];
382     } gt_entry;
383 } Elf32_External_gptab;
384
385 /* A section of type SHT_MIPS_REGINFO contains the following
386    structure.  */
387 typedef struct
388 {
389   /* Mask of general purpose registers used.  */
390   unsigned long ri_gprmask;
391   /* Mask of co-processor registers used.  */
392   unsigned long ri_cprmask[4];
393   /* GP register value for this object file.  */
394   long ri_gp_value;
395 } Elf32_RegInfo;
396
397 /* The external version of the Elf_RegInfo structure.  */
398 typedef struct
399 {
400   unsigned char ri_gprmask[4];
401   unsigned char ri_cprmask[4][4];
402   unsigned char ri_gp_value[4];
403 } Elf32_External_RegInfo;
404
405 /* MIPS ELF .reginfo swapping routines.  */
406 extern void bfd_mips_elf32_swap_reginfo_in
407   PARAMS ((bfd *, const Elf32_External_RegInfo *, Elf32_RegInfo *));
408 extern void bfd_mips_elf32_swap_reginfo_out
409   PARAMS ((bfd *, const Elf32_RegInfo *, Elf32_External_RegInfo *));
410 \f
411 /* Processor specific section flags.  */
412
413 /* This section must be in the global data area.  */
414 #define SHF_MIPS_GPREL          0x10000000
415
416 /* This section should be merged.  */
417 #define SHF_MIPS_MERGE          0x20000000
418
419 /* This section contains 32 bit addresses.  */
420 #define SHF_MIPS_ADDR32         0x40000000
421
422 /* This section contains 64 bit addresses.  */
423 #define SHF_MIPS_ADDR64         0x80000000
424
425 /* This section may not be stripped.  */
426 #define SHF_MIPS_NOSTRIP        0x08000000
427
428 /* This section is local to threads.  */
429 #define SHF_MIPS_LOCAL          0x04000000
430
431 /* Linker should generate implicit weak names for this section.  */
432 #define SHF_MIPS_NAMES          0x02000000
433 \f
434 /* Processor specific program header types.  */
435
436 /* Register usage information.  Identifies one .reginfo section.  */
437 #define PT_MIPS_REGINFO         0x70000000
438
439 /* Runtime procedure table.  */
440 #define PT_MIPS_RTPROC          0x70000001
441
442 /* Options (for what ???).  */
443 #define PT_MIPS_OPTIONS         0x70000002
444 \f
445 /* Processor specific dynamic array tags.  */
446
447 /* 32 bit version number for runtime linker interface.  */
448 #define DT_MIPS_RLD_VERSION     0x70000001
449
450 /* Time stamp.  */
451 #define DT_MIPS_TIME_STAMP      0x70000002
452
453 /* Checksum of external strings and common sizes.  */
454 #define DT_MIPS_ICHECKSUM       0x70000003
455
456 /* Index of version string in string table.  */
457 #define DT_MIPS_IVERSION        0x70000004
458
459 /* 32 bits of flags.  */
460 #define DT_MIPS_FLAGS           0x70000005
461
462 /* Base address of the segment.  */
463 #define DT_MIPS_BASE_ADDRESS    0x70000006
464
465 /* ??? */
466 #define DT_MIPS_MSYM            0x70000007
467
468 /* Address of .conflict section.  */
469 #define DT_MIPS_CONFLICT        0x70000008
470
471 /* Address of .liblist section.  */
472 #define DT_MIPS_LIBLIST         0x70000009
473
474 /* Number of local global offset table entries.  */
475 #define DT_MIPS_LOCAL_GOTNO     0x7000000a
476
477 /* Number of entries in the .conflict section.  */
478 #define DT_MIPS_CONFLICTNO      0x7000000b
479
480 /* Number of entries in the .liblist section.  */
481 #define DT_MIPS_LIBLISTNO       0x70000010
482
483 /* Number of entries in the .dynsym section.  */
484 #define DT_MIPS_SYMTABNO        0x70000011
485
486 /* Index of first external dynamic symbol not referenced locally.  */
487 #define DT_MIPS_UNREFEXTNO      0x70000012
488
489 /* Index of first dynamic symbol in global offset table.  */
490 #define DT_MIPS_GOTSYM          0x70000013
491
492 /* Number of page table entries in global offset table.  */
493 #define DT_MIPS_HIPAGENO        0x70000014
494
495 /* Address of run time loader map, used for debugging.  */
496 #define DT_MIPS_RLD_MAP         0x70000016
497
498 /* Delta C++ class definition.  */
499 #define DT_MIPS_DELTA_CLASS     0x70000017
500
501 /* Number of entries in DT_MIPS_DELTA_CLASS.  */
502 #define DT_MIPS_DELTA_CLASS_NO  0x70000018
503
504 /* Delta C++ class instances.  */
505 #define DT_MIPS_DELTA_INSTANCE  0x70000019
506
507 /* Number of entries in DT_MIPS_DELTA_INSTANCE.  */
508 #define DT_MIPS_DELTA_INSTANCE_NO       0x7000001a
509
510 /* Delta relocations.  */
511 #define DT_MIPS_DELTA_RELOC     0x7000001b
512
513 /* Number of entries in DT_MIPS_DELTA_RELOC.  */
514 #define DT_MIPS_DELTA_RELOC_NO  0x7000001c
515
516 /* Delta symbols that Delta relocations refer to.  */
517 #define DT_MIPS_DELTA_SYM       0x7000001d
518
519 /* Number of entries in DT_MIPS_DELTA_SYM.  */
520 #define DT_MIPS_DELTA_SYM_NO    0x7000001e
521
522 /* Delta symbols that hold class declarations.  */
523 #define DT_MIPS_DELTA_CLASSSYM  0x70000020
524
525 /* Number of entries in DT_MIPS_DELTA_CLASSSYM.  */
526 #define DT_MIPS_DELTA_CLASSSYM_NO       0x70000021
527
528 /* Flags indicating information about C++ flavor.  */
529 #define DT_MIPS_CXX_FLAGS       0x70000022
530
531 /* Pixie information (???).  */
532 #define DT_MIPS_PIXIE_INIT      0x70000023
533
534 /* ??? */
535 #define DT_MIPS_SYMBOL_LIB      0x70000024
536
537 /* ??? */
538 #define DT_MIPS_LOCALPAGE_GOTIDX        0x70000025
539
540 /* ??? */
541 #define DT_MIPS_LOCAL_GOTIDX    0x70000026
542
543 /* ??? */
544 #define DT_MIPS_HIDDEN_GOTIDX   0x70000027
545
546 /* ??? */
547 #define DT_MIPS_PROTECTED_GOTIDX        0x70000028
548
549 /* Address of `.MIPS.options'.  */
550 #define DT_MIPS_OPTIONS         0x70000029
551
552 /* Address of `.interface'.  */
553 #define DT_MIPS_INTERFACE       0x7000002a
554
555 /* ??? */
556 #define DT_MIPS_DYNSTR_ALIGN    0x7000002b
557
558 /* Size of the .interface section.  */
559 #define DT_MIPS_INTERFACE_SIZE  0x7000002c
560
561 /* Size of rld_text_resolve function stored in the GOT.  */
562 #define DT_MIPS_RLD_TEXT_RESOLVE_ADDR   0x7000002d
563
564 /* Default suffix of DSO to be added by rld on dlopen() calls.  */
565 #define DT_MIPS_PERF_SUFFIX     0x7000002e
566
567 /* Size of compact relocation section (O32).  */
568 #define DT_MIPS_COMPACT_SIZE    0x7000002f
569
570 /* GP value for auxiliary GOTs.  */
571 #define DT_MIPS_GP_VALUE        0x70000030
572
573 /* Address of auxiliary .dynamic.  */
574 #define DT_MIPS_AUX_DYNAMIC     0x70000031
575 \f
576 /* Flags which may appear in a DT_MIPS_FLAGS entry.  */
577
578 /* No flags.  */
579 #define RHF_NONE                0x00000000
580
581 /* Uses shortcut pointers.  */
582 #define RHF_QUICKSTART          0x00000001
583
584 /* Hash size is not a power of two.  */
585 #define RHF_NOTPOT              0x00000002
586
587 /* Ignore LD_LIBRARY_PATH.  */
588 #define RHS_NO_LIBRARY_REPLACEMENT \
589                                 0x00000004
590 \f
591 /* Special values for the st_other field in the symbol table.  These
592    are used in an Irix 5 dynamic symbol table.  */
593
594 #define STO_DEFAULT             0x00
595 #define STO_INTERNAL            0x01
596 #define STO_HIDDEN              0x02
597 #define STO_PROTECTED           0x03
598
599 /* start-sanitize-sky */
600 /* These values are used for the dvp.  */
601 #define STO_DVP_DMA             0xe8
602 #define STO_DVP_VIF             0xe9
603 #define STO_DVP_GIF             0xea
604 #define STO_DVP_VU              0xeb
605 /* Reserve a couple in case we need them.  */
606 #define STO_DVP_RES1            0xec
607 #define STO_DVP_RES2            0xed
608 #define STO_DVP_P(sto) ((sto) >= STO_DVP_DMA && (sto) <= STO_DVP_RES2)
609
610 /* end-sanitize-sky */
611 /* This value is used for a mips16 .text symbol.  */
612 #define STO_MIPS16              0xf0
613 \f
614 /* The 64-bit MIPS ELF ABI uses an unusual reloc format.  Each
615    relocation entry specifies up to three actual relocations, all at
616    the same address.  The first relocation which required a symbol
617    uses the symbol in the r_sym field.  The second relocation which
618    requires a symbol uses the symbol in the r_ssym field.  If all
619    three relocations require a symbol, the third one uses a zero
620    value.  */
621
622 /* An entry in a 64 bit SHT_REL section.  */
623
624 typedef struct
625 {
626   /* Address of relocation.  */
627   unsigned char r_offset[8];
628   /* Symbol index.  */
629   unsigned char r_sym[4];
630   /* Special symbol.  */
631   unsigned char r_ssym[1];
632   /* Third relocation.  */
633   unsigned char r_type3[1];
634   /* Second relocation.  */
635   unsigned char r_type2[1];
636   /* First relocation.  */
637   unsigned char r_type[1];
638 } Elf64_Mips_External_Rel;
639
640 typedef struct
641 {
642   /* Address of relocation.  */
643   bfd_vma r_offset;
644   /* Symbol index.  */
645   unsigned long r_sym;
646   /* Special symbol.  */
647   unsigned char r_ssym;
648   /* Third relocation.  */
649   unsigned char r_type3;
650   /* Second relocation.  */
651   unsigned char r_type2;
652   /* First relocation.  */
653   unsigned char r_type;
654 } Elf64_Mips_Internal_Rel;
655
656 /* An entry in a 64 bit SHT_RELA section.  */
657
658 typedef struct
659 {
660   /* Address of relocation.  */
661   unsigned char r_offset[8];
662   /* Symbol index.  */
663   unsigned char r_sym[4];
664   /* Special symbol.  */
665   unsigned char r_ssym[1];
666   /* Third relocation.  */
667   unsigned char r_type3[1];
668   /* Second relocation.  */
669   unsigned char r_type2[1];
670   /* First relocation.  */
671   unsigned char r_type[1];
672   /* Addend.  */
673   unsigned char r_addend[8];
674 } Elf64_Mips_External_Rela;
675
676 typedef struct
677 {
678   /* Address of relocation.  */
679   bfd_vma r_offset;
680   /* Symbol index.  */
681   unsigned long r_sym;
682   /* Special symbol.  */
683   unsigned char r_ssym;
684   /* Third relocation.  */
685   unsigned char r_type3;
686   /* Second relocation.  */
687   unsigned char r_type2;
688   /* First relocation.  */
689   unsigned char r_type;
690   /* Addend.  */
691   bfd_signed_vma r_addend;
692 } Elf64_Mips_Internal_Rela;
693
694 /* Values found in the r_ssym field of a relocation entry.  */
695
696 /* No relocation.  */
697 #define RSS_UNDEF       0
698
699 /* Value of GP.  */
700 #define RSS_GP          1
701
702 /* Value of GP in object being relocated.  */
703 #define RSS_GP0         2
704
705 /* Address of location being relocated.  */
706 #define RSS_LOC         3
707 \f
708 /* A SHT_MIPS_OPTIONS section contains a series of options, each of
709    which starts with this header.  */
710
711 typedef struct
712 {
713   /* Type of option.  */
714   unsigned char kind[1];
715   /* Size of option descriptor, including header.  */
716   unsigned char size[1];
717   /* Section index of affected section, or 0 for global option.  */
718   unsigned char section[2];
719   /* Information specific to this kind of option.  */
720   unsigned char info[4];
721 } Elf_External_Options;
722
723 typedef struct
724 {
725   /* Type of option.  */
726   unsigned char kind;
727   /* Size of option descriptor, including header.  */
728   unsigned char size;
729   /* Section index of affected section, or 0 for global option.  */
730   unsigned short section;
731   /* Information specific to this kind of option.  */
732   unsigned long info;
733 } Elf_Internal_Options;
734
735 /* MIPS ELF option header swapping routines.  */
736 extern void bfd_mips_elf_swap_options_in
737   PARAMS ((bfd *, const Elf_External_Options *, Elf_Internal_Options *));
738 extern void bfd_mips_elf_swap_options_out
739   PARAMS ((bfd *, const Elf_Internal_Options *, Elf_External_Options *));
740
741 /* Values which may appear in the kind field of an Elf_Options
742    structure.  */
743
744 /* Undefined.  */
745 #define ODK_NULL        0
746
747 /* Register usage and GP value.  */
748 #define ODK_REGINFO     1
749
750 /* Exception processing information.  */
751 #define ODK_EXCEPTIONS  2
752
753 /* Section padding information.  */
754 #define ODK_PAD         3
755
756 /* Hardware workarounds performed.  */
757 #define ODK_HWPATCH     4
758
759 /* Fill value used by the linker.  */
760 #define ODK_FILL        5
761
762 /* Reserved space for desktop tools.  */
763 #define ODK_TAGS        6
764
765 /* Hardware workarounds, AND bits when merging.  */
766 #define ODK_HWAND       7
767
768 /* Hardware workarounds, OR bits when merging.  */
769 #define ODK_HWOR        8
770
771 /* GP group to use for text/data sections.  */
772 #define ODK_GP_GROUP    9
773
774 /* ID information.  */
775 #define ODK_IDENT       10
776
777 /* In the 32 bit ABI, an ODK_REGINFO option is just a Elf32_RegInfo
778    structure.  In the 64 bit ABI, it is the following structure.  The
779    info field of the options header is not used.  */
780
781 typedef struct
782 {
783   /* Mask of general purpose registers used.  */
784   unsigned char ri_gprmask[4];
785   /* Padding.  */
786   unsigned char ri_pad[4];
787   /* Mask of co-processor registers used.  */
788   unsigned char ri_cprmask[4][4];
789   /* GP register value for this object file.  */
790   unsigned char ri_gp_value[8];
791 } Elf64_External_RegInfo;
792
793 typedef struct
794 {
795   /* Mask of general purpose registers used.  */
796   unsigned long ri_gprmask;
797   /* Padding.  */
798   unsigned long ri_pad;
799   /* Mask of co-processor registers used.  */
800   unsigned long ri_cprmask[4];
801   /* GP register value for this object file.  */
802   bfd_vma ri_gp_value;
803 } Elf64_Internal_RegInfo;
804
805 /* MIPS ELF reginfo swapping routines.  */
806 extern void bfd_mips_elf64_swap_reginfo_in
807   PARAMS ((bfd *, const Elf64_External_RegInfo *, Elf64_Internal_RegInfo *));
808 extern void bfd_mips_elf64_swap_reginfo_out
809   PARAMS ((bfd *, const Elf64_Internal_RegInfo *, Elf64_External_RegInfo *));
810
811 /* Masks for the info work of an ODK_EXCEPTIONS descriptor.  */
812 #define OEX_FPU_MIN     0x1f    /* FPEs which must be enabled.  */
813 #define OEX_FPU_MAX     0x1f00  /* FPEs which may be enabled.  */
814 #define OEX_PAGE0       0x10000 /* Page zero must be mapped.  */
815 #define OEX_SMM         0x20000 /* Force sequential memory mode.  */
816 #define OEX_FPDBUG      0x40000 /* Force floating-point debug mode.  */
817 #define OEX_DISMISS     0x80000 /* Dismiss invalid address faults.  */
818
819 /* Masks of the FP exceptions for OEX_FPU_MIN and OEX_FPU_MAX.  */
820 #define OEX_FPU_INVAL   0x10    /* Invalid operation exception.  */
821 #define OEX_FPU_DIV0    0x08    /* Division by zero exception.  */
822 #define OEX_FPU_OFLO    0x04    /* Overflow exception.  */
823 #define OEX_FPU_UFLO    0x02    /* Underflow exception.  */
824 #define OEX_FPU_INEX    0x01    /* Inexact exception.  */
825
826 /* Masks for the info word of an ODK_PAD descriptor.  */
827 #define OPAD_PREFIX     0x01
828 #define OPAD_POSTFIX    0x02
829 #define OPAD_SYMBOL     0x04
830
831 /* Masks for the info word of an ODK_HWPATCH descriptor.  */
832 #define OHW_R4KEOP      0x01    /* R4000 end-of-page patch.  */
833 #define OHW_R8KPFETCH   0x02    /* May need R8000 prefetch patch.  */
834 #define OHW_R5KEOP      0x04    /* R5000 end-of-page patch.  */
835 #define OHW_R5KCVTL     0x08    /* R5000 cvt.[ds].l bug (clean == 1).  */
836
837 /* Masks for the info word of an ODK_IDENT/ODK_GP_GROUP descriptor.  */
838 #define OGP_GROUP       0x0000ffff      /* GP group number.  */
839 #define OGP_SELF        0xffff0000      /* Self-contained GP groups.  */
840
841 /* Masks for the info word of an ODK_HWAND/ODK_HWOR descriptor.  */
842 #define OHWA0_R4KEOP_CHECKED    0x00000001
843 #define OHWA0_R4KEOP_CLEAN      0x00000002
844 \f
845 /* start-sanitize-sky */
846 /* The vu overlay table is an array of this.  */
847
848 typedef struct
849 {
850   /* `name' is offset into overlay string table section.  */
851   char name[4];
852   char lma[4];
853   char vma[4];
854 } Elf32_Dvp_External_Overlay;
855
856 typedef struct
857 {
858   bfd_vma name;
859   bfd_vma lma;
860   bfd_vma vma;
861 } Elf32_Dvp_Internal_Overlay;
862
863 /* overlay swapping routines.  */
864 extern void bfd_dvp_elf32_swap_overlay_in
865   PARAMS ((bfd *, const Elf32_Dvp_External_Overlay *,
866            Elf32_Dvp_Internal_Overlay *));
867 extern void bfd_dvp_elf32_swap_overlay_out
868   PARAMS ((bfd *, const Elf32_Dvp_Internal_Overlay *,
869            Elf32_Dvp_External_Overlay *));
870
871 /* end-sanitize-sky */
872
873 #endif /* _ELF_MIPS_H */