/* MIPS ELF support for BFD.

   Copyright (C) 1993-2023 Free Software Foundation, Inc.

   By Ian Lance Taylor, Cygnus Support, <ian@cygnus.com>, from

   information in the System V Application Binary Interface, MIPS

   Processor Supplement.

   This file is part of BFD, the Binary File Descriptor library.

   This program is free software; you can redistribute it and/or modify

   it under the terms of the GNU General Public License as published by

   the Free Software Foundation; either version 3 of the License, or

   (at your option) any later version.

   This program is distributed in the hope that it will be useful,

   but WITHOUT ANY WARRANTY; without even the implied warranty of

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License

   along with this program; if not, write to the Free Software

   Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,

   MA 02110-1301, USA.  */

/* This file holds definitions specific to the MIPS ELF ABI.  Note

   that most of this is not actually implemented by BFD.  */

#ifndef _ELF_MIPS_H

#define _ELF_MIPS_H

#include "elf/reloc-macros.h"

#ifdef __cplusplus

extern "C" {

#endif

/* Relocation types.  */

START_RELOC_NUMBERS (elf_mips_reloc_type)

  RELOC_NUMBER (R_MIPS_NONE, 0)

  RELOC_NUMBER (R_MIPS_16, 1)

  RELOC_NUMBER (R_MIPS_32, 2)   /* In Elf 64: alias R_MIPS_ADD */

  RELOC_NUMBER (R_MIPS_REL32, 3)  /* In Elf 64: alias R_MIPS_REL */

  RELOC_NUMBER (R_MIPS_26, 4)

  RELOC_NUMBER (R_MIPS_HI16, 5)

  RELOC_NUMBER (R_MIPS_LO16, 6)

  RELOC_NUMBER (R_MIPS_GPREL16, 7)  /* In Elf 64: alias R_MIPS_GPREL */

  RELOC_NUMBER (R_MIPS_LITERAL, 8)

  RELOC_NUMBER (R_MIPS_GOT16, 9)  /* In Elf 64: alias R_MIPS_GOT */

  RELOC_NUMBER (R_MIPS_PC16, 10)

  RELOC_NUMBER (R_MIPS_CALL16, 11)  /* In Elf 64: alias R_MIPS_CALL */

  RELOC_NUMBER (R_MIPS_GPREL32, 12)

  /* The remaining relocs are defined on Irix, although they are not

     in the MIPS ELF ABI.  */

  RELOC_NUMBER (R_MIPS_UNUSED1, 13)

  RELOC_NUMBER (R_MIPS_UNUSED2, 14)

  RELOC_NUMBER (R_MIPS_UNUSED3, 15)

  RELOC_NUMBER (R_MIPS_SHIFT5, 16)

  RELOC_NUMBER (R_MIPS_SHIFT6, 17)

  RELOC_NUMBER (R_MIPS_64, 18)

  RELOC_NUMBER (R_MIPS_GOT_DISP, 19)

  RELOC_NUMBER (R_MIPS_GOT_PAGE, 20)

  RELOC_NUMBER (R_MIPS_GOT_OFST, 21)

  RELOC_NUMBER (R_MIPS_GOT_HI16, 22)

  RELOC_NUMBER (R_MIPS_GOT_LO16, 23)

  RELOC_NUMBER (R_MIPS_SUB, 24)

  RELOC_NUMBER (R_MIPS_INSERT_A, 25)

  RELOC_NUMBER (R_MIPS_INSERT_B, 26)

  RELOC_NUMBER (R_MIPS_DELETE, 27)

  RELOC_NUMBER (R_MIPS_HIGHER, 28)

  RELOC_NUMBER (R_MIPS_HIGHEST, 29)

  RELOC_NUMBER (R_MIPS_CALL_HI16, 30)

  RELOC_NUMBER (R_MIPS_CALL_LO16, 31)

  RELOC_NUMBER (R_MIPS_SCN_DISP, 32)

  RELOC_NUMBER (R_MIPS_REL16, 33)

  RELOC_NUMBER (R_MIPS_ADD_IMMEDIATE, 34)

  RELOC_NUMBER (R_MIPS_PJUMP, 35)

  RELOC_NUMBER (R_MIPS_RELGOT, 36)

  RELOC_NUMBER (R_MIPS_JALR, 37)

  /* TLS relocations.  */

  RELOC_NUMBER (R_MIPS_TLS_DTPMOD32, 38)

  RELOC_NUMBER (R_MIPS_TLS_DTPREL32, 39)

  RELOC_NUMBER (R_MIPS_TLS_DTPMOD64, 40)

  RELOC_NUMBER (R_MIPS_TLS_DTPREL64, 41)

  RELOC_NUMBER (R_MIPS_TLS_GD, 42)

  RELOC_NUMBER (R_MIPS_TLS_LDM, 43)

  RELOC_NUMBER (R_MIPS_TLS_DTPREL_HI16, 44)

  RELOC_NUMBER (R_MIPS_TLS_DTPREL_LO16, 45)

  RELOC_NUMBER (R_MIPS_TLS_GOTTPREL, 46)

  RELOC_NUMBER (R_MIPS_TLS_TPREL32, 47)

  RELOC_NUMBER (R_MIPS_TLS_TPREL64, 48)

  RELOC_NUMBER (R_MIPS_TLS_TPREL_HI16, 49)

  RELOC_NUMBER (R_MIPS_TLS_TPREL_LO16, 50)

  RELOC_NUMBER (R_MIPS_GLOB_DAT, 51)

  /* Space to grow */

  RELOC_NUMBER (R_MIPS_PC21_S2, 60)

  RELOC_NUMBER (R_MIPS_PC26_S2, 61)

  RELOC_NUMBER (R_MIPS_PC18_S3, 62)

  RELOC_NUMBER (R_MIPS_PC19_S2, 63)

  RELOC_NUMBER (R_MIPS_PCHI16, 64)

  RELOC_NUMBER (R_MIPS_PCLO16, 65)

  FAKE_RELOC (R_MIPS_max, 66)

  /* These relocs are used for the mips16.  */

  FAKE_RELOC (R_MIPS16_min, 100)

  RELOC_NUMBER (R_MIPS16_26, 100)

  RELOC_NUMBER (R_MIPS16_GPREL, 101)

  RELOC_NUMBER (R_MIPS16_GOT16, 102)

  RELOC_NUMBER (R_MIPS16_CALL16, 103)

  RELOC_NUMBER (R_MIPS16_HI16, 104)

  RELOC_NUMBER (R_MIPS16_LO16, 105)

  RELOC_NUMBER (R_MIPS16_TLS_GD, 106)

  RELOC_NUMBER (R_MIPS16_TLS_LDM, 107)

  RELOC_NUMBER (R_MIPS16_TLS_DTPREL_HI16, 108)

  RELOC_NUMBER (R_MIPS16_TLS_DTPREL_LO16, 109)

  RELOC_NUMBER (R_MIPS16_TLS_GOTTPREL, 110)

  RELOC_NUMBER (R_MIPS16_TLS_TPREL_HI16, 111)

  RELOC_NUMBER (R_MIPS16_TLS_TPREL_LO16, 112)

  RELOC_NUMBER (R_MIPS16_PC16_S1, 113)

  FAKE_RELOC (R_MIPS16_max, 114)

  /* These relocations are specific to VxWorks.  */

  RELOC_NUMBER (R_MIPS_COPY, 126)

  RELOC_NUMBER (R_MIPS_JUMP_SLOT, 127)

  /* These relocations are specific to microMIPS.  */

  FAKE_RELOC (R_MICROMIPS_min, 130)

  RELOC_NUMBER (R_MICROMIPS_26_S1, 133)

  RELOC_NUMBER (R_MICROMIPS_HI16, 134)

  RELOC_NUMBER (R_MICROMIPS_LO16, 135)

  RELOC_NUMBER (R_MICROMIPS_GPREL16, 136) /* In Elf 64:

               alias R_MICROMIPS_GPREL */

  RELOC_NUMBER (R_MICROMIPS_LITERAL, 137)

  RELOC_NUMBER (R_MICROMIPS_GOT16, 138)   /* In Elf 64:

               alias R_MICROMIPS_GOT */

  RELOC_NUMBER (R_MICROMIPS_PC7_S1, 139)

  RELOC_NUMBER (R_MICROMIPS_PC10_S1, 140)

  RELOC_NUMBER (R_MICROMIPS_PC16_S1, 141)

  RELOC_NUMBER (R_MICROMIPS_CALL16, 142)  /* In Elf 64:

               alias R_MICROMIPS_CALL */

  RELOC_NUMBER (R_MICROMIPS_GOT_DISP, 145)

  RELOC_NUMBER (R_MICROMIPS_GOT_PAGE, 146)

  RELOC_NUMBER (R_MICROMIPS_GOT_OFST, 147)

  RELOC_NUMBER (R_MICROMIPS_GOT_HI16, 148)

  RELOC_NUMBER (R_MICROMIPS_GOT_LO16, 149)

  RELOC_NUMBER (R_MICROMIPS_SUB, 150)

  RELOC_NUMBER (R_MICROMIPS_HIGHER, 151)

  RELOC_NUMBER (R_MICROMIPS_HIGHEST, 152)

  RELOC_NUMBER (R_MICROMIPS_CALL_HI16, 153)

  RELOC_NUMBER (R_MICROMIPS_CALL_LO16, 154)

  RELOC_NUMBER (R_MICROMIPS_SCN_DISP, 155)

  RELOC_NUMBER (R_MICROMIPS_JALR, 156)

  RELOC_NUMBER (R_MICROMIPS_HI0_LO16, 157)

  /* TLS relocations.  */

  RELOC_NUMBER (R_MICROMIPS_TLS_GD, 162)

  RELOC_NUMBER (R_MICROMIPS_TLS_LDM, 163)

  RELOC_NUMBER (R_MICROMIPS_TLS_DTPREL_HI16, 164)

  RELOC_NUMBER (R_MICROMIPS_TLS_DTPREL_LO16, 165)

  RELOC_NUMBER (R_MICROMIPS_TLS_GOTTPREL, 166)

  RELOC_NUMBER (R_MICROMIPS_TLS_TPREL_HI16, 169)

  RELOC_NUMBER (R_MICROMIPS_TLS_TPREL_LO16, 170)

  /* microMIPS GP- and PC-relative relocations. */

  RELOC_NUMBER (R_MICROMIPS_GPREL7_S2, 172)

  RELOC_NUMBER (R_MICROMIPS_PC23_S2, 173)

  FAKE_RELOC (R_MICROMIPS_max, 174)

  /* This was a GNU extension used by embedded-PIC.  It was co-opted by

     mips-linux for exception-handling data.  GCC stopped using it in

     May, 2004, then started using it again for compact unwind tables.  */

  RELOC_NUMBER (R_MIPS_PC32, 248)

  RELOC_NUMBER (R_MIPS_EH, 249)

  /* FIXME: this relocation is used internally by gas.  */

  RELOC_NUMBER (R_MIPS_GNU_REL16_S2, 250)

  /* These are GNU extensions to enable C++ vtable garbage collection.  */

  RELOC_NUMBER (R_MIPS_GNU_VTINHERIT, 253)

  RELOC_NUMBER (R_MIPS_GNU_VTENTRY, 254)

END_RELOC_NUMBERS (R_MIPS_maxext)

/* Processor specific flags for the ELF header e_flags field.  */

/* At least one .noreorder directive appears in the source.  */

#define EF_MIPS_NOREORDER 0x00000001

/* File contains position independent code.  */

#define EF_MIPS_PIC   0x00000002

/* Code in file uses the standard calling sequence for calling

   position independent code.  */

#define EF_MIPS_CPIC    0x00000004

/* ???  Unknown flag, set in IRIX 6's BSDdup2.o in libbsd.a.  */

#define EF_MIPS_XGOT    0x00000008

/* Code in file uses UCODE (obsolete) */

#define EF_MIPS_UCODE   0x00000010

/* Code in file uses new ABI (-n32 on Irix 6).  */

#define EF_MIPS_ABI2    0x00000020

/* Process the .MIPS.options section first by ld */

#define EF_MIPS_OPTIONS_FIRST 0x00000080

/* Indicates code compiled for a 64-bit machine in 32-bit mode

   (regs are 32-bits wide).  */

#define EF_MIPS_32BITMODE 0x00000100

/* 32-bit machine but FP registers are 64 bit (-mfp64).  */

#define EF_MIPS_FP64    0x00000200

/* Code in file uses the IEEE 754-2008 NaN encoding convention.  */

#define EF_MIPS_NAN2008   0x00000400

/* Architectural Extensions used by this file */

#define EF_MIPS_ARCH_ASE  0x0f000000

/* Use MDMX multimedia extensions */

#define EF_MIPS_ARCH_ASE_MDMX 0x08000000

/* Use MIPS-16 ISA extensions */

#define EF_MIPS_ARCH_ASE_M16  0x04000000

/* Use MICROMIPS ISA extensions.  */

#define EF_MIPS_ARCH_ASE_MICROMIPS  0x02000000

/* Four bit MIPS architecture field.  */

#define EF_MIPS_ARCH    0xf0000000

/* -mips1 code.  */

#define E_MIPS_ARCH_1   0x00000000

/* -mips2 code.  */

#define E_MIPS_ARCH_2   0x10000000

/* -mips3 code.  */

#define E_MIPS_ARCH_3   0x20000000

/* -mips4 code.  */

#define E_MIPS_ARCH_4   0x30000000

/* -mips5 code.  */

#define E_MIPS_ARCH_5           0x40000000

/* -mips32 code.  */

#define E_MIPS_ARCH_32          0x50000000

/* -mips64 code.  */

#define E_MIPS_ARCH_64          0x60000000

/* -mips32r2 code.  */

#define E_MIPS_ARCH_32R2        0x70000000

/* -mips64r2 code.  */

#define E_MIPS_ARCH_64R2        0x80000000

/* -mips32r6 code.  */

#define E_MIPS_ARCH_32R6        0x90000000

/* -mips64r6 code.  */

#define E_MIPS_ARCH_64R6        0xa0000000

/* The ABI of the file.  Also see EF_MIPS_ABI2 above. */

#define EF_MIPS_ABI   0x0000F000

/* The original o32 abi. */

#define E_MIPS_ABI_O32          0x00001000

/* O32 extended to work on 64 bit architectures */

#define E_MIPS_ABI_O64          0x00002000

/* EABI in 32 bit mode */

#define E_MIPS_ABI_EABI32       0x00003000

/* EABI in 64 bit mode */

#define E_MIPS_ABI_EABI64       0x00004000

/* Machine variant if we know it.  This field was invented at Cygnus,

   but it is hoped that other vendors will adopt it.  If some standard

   is developed, this code should be changed to follow it. */

#define EF_MIPS_MACH    0x00FF0000

/* Cygnus is choosing values between 80 and 9F;

   00 - 7F should be left for a future standard;

   the rest are open. */

#define E_MIPS_MACH_3900  0x00810000

#define E_MIPS_MACH_4010  0x00820000

#define E_MIPS_MACH_4100  0x00830000

#define E_MIPS_MACH_ALLEGREX  0x00840000

#define E_MIPS_MACH_4650  0x00850000

#define E_MIPS_MACH_4120  0x00870000

#define E_MIPS_MACH_4111  0x00880000

#define E_MIPS_MACH_SB1         0x008a0000

#define E_MIPS_MACH_OCTEON  0x008b0000

#define E_MIPS_MACH_XLR       0x008c0000

#define E_MIPS_MACH_OCTEON2 0x008d0000

#define E_MIPS_MACH_OCTEON3 0x008e0000

#define E_MIPS_MACH_5400  0x00910000

#define E_MIPS_MACH_5900  0x00920000

#define E_MIPS_MACH_IAMR2 0x00930000

#define E_MIPS_MACH_5500  0x00980000

#define E_MIPS_MACH_9000  0x00990000

#define E_MIPS_MACH_LS2E        0x00A00000

#define E_MIPS_MACH_LS2F        0x00A10000

#define E_MIPS_MACH_GS464       0x00A20000

#define E_MIPS_MACH_GS464E  0x00A30000

#define E_MIPS_MACH_GS264E  0x00A40000

/* Processor specific section indices.  These sections do not actually

   exist.  Symbols with a st_shndx field corresponding to one of these

   values have a special meaning.  */

/* Defined and allocated common symbol.  Value is virtual address.  If

   relocated, alignment must be preserved.  */

#define SHN_MIPS_ACOMMON  SHN_LORESERVE

/* Defined and allocated text symbol.  Value is virtual address.

   Occur in the dynamic symbol table of Alpha OSF/1 and Irix 5 executables.  */

#define SHN_MIPS_TEXT   (SHN_LORESERVE + 1)

/* Defined and allocated data symbol.  Value is virtual address.

   Occur in the dynamic symbol table of Alpha OSF/1 and Irix 5 executables.  */

#define SHN_MIPS_DATA   (SHN_LORESERVE + 2)

/* Small common symbol.  */

#define SHN_MIPS_SCOMMON  (SHN_LORESERVE + 3)

/* Small undefined symbol.  */

#define SHN_MIPS_SUNDEFINED (SHN_LORESERVE + 4)

/* Processor specific section types.  */

/* Section contains the set of dynamic shared objects used when

   statically linking.  */

#define SHT_MIPS_LIBLIST  0x70000000

/* I'm not sure what this is, but it's used on Irix 5.  */

#define SHT_MIPS_MSYM   0x70000001

/* Section contains list of symbols whose definitions conflict with

   symbols defined in shared objects.  */

#define SHT_MIPS_CONFLICT 0x70000002

/* Section contains the global pointer table.  */

#define SHT_MIPS_GPTAB    0x70000003

/* Section contains microcode information.  The exact format is

   unspecified.  */

#define SHT_MIPS_UCODE    0x70000004

/* Section contains some sort of debugging information.  The exact

   format is unspecified.  It's probably ECOFF symbols.  */

#define SHT_MIPS_DEBUG    0x70000005

/* Section contains register usage information.  */

#define SHT_MIPS_REGINFO  0x70000006

/* ??? */

#define SHT_MIPS_PACKAGE  0x70000007

/* ??? */

#define SHT_MIPS_PACKSYM  0x70000008

/* ??? */

#define SHT_MIPS_RELD   0x70000009

/* Section contains interface information.  */

#define SHT_MIPS_IFACE    0x7000000b

/* Section contains description of contents of another section.  */

#define SHT_MIPS_CONTENT  0x7000000c

/* Section contains miscellaneous options.  */

#define SHT_MIPS_OPTIONS  0x7000000d

/* ??? */

#define SHT_MIPS_SHDR   0x70000010

/* ??? */

#define SHT_MIPS_FDESC    0x70000011

/* ??? */

#define SHT_MIPS_EXTSYM   0x70000012

/* ??? */

#define SHT_MIPS_DENSE    0x70000013

/* ??? */

#define SHT_MIPS_PDESC    0x70000014

/* ??? */

#define SHT_MIPS_LOCSYM   0x70000015

/* ??? */

#define SHT_MIPS_AUXSYM   0x70000016

/* ??? */

#define SHT_MIPS_OPTSYM   0x70000017

/* ??? */

#define SHT_MIPS_LOCSTR   0x70000018

/* ??? */

#define SHT_MIPS_LINE   0x70000019

/* ??? */

#define SHT_MIPS_RFDESC   0x7000001a

/* Delta C++: symbol table */

#define SHT_MIPS_DELTASYM 0x7000001b

/* Delta C++: instance table */

#define SHT_MIPS_DELTAINST  0x7000001c

/* Delta C++: class table */

#define SHT_MIPS_DELTACLASS 0x7000001d

/* DWARF debugging section.  */

#define SHT_MIPS_DWARF    0x7000001e

/* Delta C++: declarations */

#define SHT_MIPS_DELTADECL  0x7000001f

/* List of libraries the binary depends on.  Includes a time stamp, version

   number.  */

#define SHT_MIPS_SYMBOL_LIB 0x70000020

/* Events section.  */

#define SHT_MIPS_EVENTS   0x70000021

/* ??? */

#define SHT_MIPS_TRANSLATE  0x70000022

/* Special pixie sections */

#define SHT_MIPS_PIXIE    0x70000023

/* Address translation table (for debug info) */

#define SHT_MIPS_XLATE    0x70000024

/* SGI internal address translation table (for debug info) */

#define SHT_MIPS_XLATE_DEBUG  0x70000025

/* Intermediate code */

#define SHT_MIPS_WHIRL    0x70000026

/* C++ exception handling region info */

#define SHT_MIPS_EH_REGION  0x70000027

/* Obsolete address translation table (for debug info) */

#define SHT_MIPS_XLATE_OLD  0x70000028

/* Runtime procedure descriptor table exception information (ucode) ??? */

#define SHT_MIPS_PDR_EXCEPTION  0x70000029

/* ABI related flags section.  */

#define SHT_MIPS_ABIFLAGS 0x7000002a

/* GNU style symbol hash table with xlat.  */

#define SHT_MIPS_XHASH    0x7000002b

/* A section of type SHT_MIPS_LIBLIST contains an array of the

   following structure.  The sh_link field is the section index of the

   string table.  The sh_info field is the number of entries in the

   section.  */

typedef struct

{

  /* String table index for name of shared object.  */

  unsigned long l_name;

  /* Time stamp.  */

  unsigned long l_time_stamp;

  /* Checksum of symbol names and common sizes.  */

  unsigned long l_checksum;

  /* String table index for version.  */

  unsigned long l_version;

  /* Flags.  */

  unsigned long l_flags;

} Elf32_Lib;

/* The external version of Elf32_Lib.  */

typedef struct

{

  unsigned char l_name[4];

  unsigned char l_time_stamp[4];

  unsigned char l_checksum[4];

  unsigned char l_version[4];

  unsigned char l_flags[4];

} Elf32_External_Lib;

/* The l_flags field of an Elf32_Lib structure may contain the

   following flags.  */

/* Require an exact match at runtime.  */

#define LL_EXACT_MATCH    0x00000001

/* Ignore version incompatibilities at runtime.  */

#define LL_IGNORE_INT_VER 0x00000002

/* Require matching minor version number.  */

#define LL_REQUIRE_MINOR  0x00000004

/* ??? */

#define LL_EXPORTS    0x00000008

/* Delay loading of this library until really needed.  */

#define LL_DELAY_LOAD   0x00000010

/* ??? Delta C++ stuff ??? */

#define LL_DELTA    0x00000020

/* A section of type SHT_MIPS_CONFLICT is an array of indices into the

   .dynsym section.  Each element has the following type.  */

typedef unsigned long Elf32_Conflict;

typedef unsigned char Elf32_External_Conflict[4];

typedef unsigned long Elf64_Conflict;

typedef unsigned char Elf64_External_Conflict[8];

/* A section of type SHT_MIPS_GPTAB contains information about how

   much GP space would be required for different -G arguments.  This

   information is only used so that the linker can provide informative

   suggestions as to the best -G value to use.  The sh_info field is

   the index of the section for which this information applies.  The

   contents of the section are an array of the following union.  The

   first element uses the gt_header field.  The remaining elements use

   the gt_entry field.  */

typedef union

{

  struct

    {

      /* -G value actually used for this object file.  */

      unsigned long gt_current_g_value;

      /* Unused.  */

      unsigned long gt_unused;

    } gt_header;

  struct

    {

      /* If this -G argument has been used...  */

      unsigned long gt_g_value;

      /* ...this many GP section bytes would be required.  */

      unsigned long gt_bytes;

    } gt_entry;

} Elf32_gptab;

/* The external version of Elf32_gptab.  */

typedef union

{

  struct

    {

      unsigned char gt_current_g_value[4];

      unsigned char gt_unused[4];

    } gt_header;

  struct

    {

      unsigned char gt_g_value[4];

      unsigned char gt_bytes[4];

    } gt_entry;

} Elf32_External_gptab;

/* A section of type SHT_MIPS_REGINFO contains the following

   structure.  */

typedef struct

{

  /* Mask of general purpose registers used.  */

  uint32_t ri_gprmask;

  /* Mask of co-processor registers used.  */

  uint32_t ri_cprmask[4];

  /* GP register value for this object file.  */

  uint32_t ri_gp_value;

} Elf32_RegInfo;

/* The external version of the Elf_RegInfo structure.  */

typedef struct

{

  unsigned char ri_gprmask[4];

  unsigned char ri_cprmask[4][4];

  unsigned char ri_gp_value[4];

} Elf32_External_RegInfo;

/* MIPS ELF .reginfo swapping routines.  */

extern void bfd_mips_elf32_swap_reginfo_in

  (bfd *, const Elf32_External_RegInfo *, Elf32_RegInfo *);

extern void bfd_mips_elf32_swap_reginfo_out

  (bfd *, const Elf32_RegInfo *, Elf32_External_RegInfo *);

/* Processor specific section flags.  */

/* This section must be in the global data area.  */

#define SHF_MIPS_GPREL    0x10000000

/* This section should be merged.  */

#define SHF_MIPS_MERGE    0x20000000

/* This section contains address data of size implied by section

   element size.  */

#define SHF_MIPS_ADDR   0x40000000

/* This section contains string data.  */

#define SHF_MIPS_STRING   0x80000000

/* This section may not be stripped.  */

#define SHF_MIPS_NOSTRIP  0x08000000

/* This section is local to threads.  */

#define SHF_MIPS_LOCAL    0x04000000

/* Linker should generate implicit weak names for this section.  */

#define SHF_MIPS_NAMES    0x02000000

/* Section contais text/data which may be replicated in other sections.

   Linker should retain only one copy.  */

#define SHF_MIPS_NODUPES  0x01000000

/* Processor specific program header types.  */

/* Register usage information.  Identifies one .reginfo section.  */

#define PT_MIPS_REGINFO   0x70000000

/* Runtime procedure table.  */

#define PT_MIPS_RTPROC    0x70000001

/* .MIPS.options section.  */

#define PT_MIPS_OPTIONS   0x70000002

/* Records ABI related flags.  */

#define PT_MIPS_ABIFLAGS  0x70000003

/* Processor specific dynamic array tags.  */

/* 32 bit version number for runtime linker interface.  */

#define DT_MIPS_RLD_VERSION 0x70000001

/* Time stamp.  */

#define DT_MIPS_TIME_STAMP  0x70000002

/* Checksum of external strings and common sizes.  */

#define DT_MIPS_ICHECKSUM 0x70000003

/* Index of version string in string table.  */

#define DT_MIPS_IVERSION  0x70000004

/* 32 bits of flags.  */

#define DT_MIPS_FLAGS   0x70000005

/* Base address of the segment.  */

#define DT_MIPS_BASE_ADDRESS  0x70000006

/* ??? */

#define DT_MIPS_MSYM    0x70000007

/* Address of .conflict section.  */

#define DT_MIPS_CONFLICT  0x70000008

/* Address of .liblist section.  */

#define DT_MIPS_LIBLIST   0x70000009

/* Number of local global offset table entries.  */

#define DT_MIPS_LOCAL_GOTNO 0x7000000a

/* Number of entries in the .conflict section.  */

#define DT_MIPS_CONFLICTNO  0x7000000b

/* Number of entries in the .liblist section.  */

#define DT_MIPS_LIBLISTNO 0x70000010

/* Number of entries in the .dynsym section.  */

#define DT_MIPS_SYMTABNO  0x70000011

/* Index of first external dynamic symbol not referenced locally.  */

#define DT_MIPS_UNREFEXTNO  0x70000012

/* Index of first dynamic symbol in global offset table.  */

#define DT_MIPS_GOTSYM    0x70000013

/* Number of page table entries in global offset table.  */

#define DT_MIPS_HIPAGENO  0x70000014

/* Address of run time loader map, used for debugging.  */

#define DT_MIPS_RLD_MAP   0x70000016

/* Delta C++ class definition.  */

#define DT_MIPS_DELTA_CLASS 0x70000017

/* Number of entries in DT_MIPS_DELTA_CLASS.  */

#define DT_MIPS_DELTA_CLASS_NO  0x70000018

/* Delta C++ class instances.  */

#define DT_MIPS_DELTA_INSTANCE  0x70000019

/* Number of entries in DT_MIPS_DELTA_INSTANCE.  */

#define DT_MIPS_DELTA_INSTANCE_NO 0x7000001a

/* Delta relocations.  */

#define DT_MIPS_DELTA_RELOC 0x7000001b

/* Number of entries in DT_MIPS_DELTA_RELOC.  */

#define DT_MIPS_DELTA_RELOC_NO  0x7000001c

/* Delta symbols that Delta relocations refer to.  */

#define DT_MIPS_DELTA_SYM 0x7000001d

/* Number of entries in DT_MIPS_DELTA_SYM.  */

#define DT_MIPS_DELTA_SYM_NO  0x7000001e

/* Delta symbols that hold class declarations.  */

#define DT_MIPS_DELTA_CLASSSYM  0x70000020

/* Number of entries in DT_MIPS_DELTA_CLASSSYM.  */

#define DT_MIPS_DELTA_CLASSSYM_NO 0x70000021

/* Flags indicating information about C++ flavor.  */

#define DT_MIPS_CXX_FLAGS 0x70000022

/* Pixie information (???).  */

#define DT_MIPS_PIXIE_INIT  0x70000023

/* Address of .MIPS.symlib */

#define DT_MIPS_SYMBOL_LIB  0x70000024

/* The GOT index of the first PTE for a segment */

#define DT_MIPS_LOCALPAGE_GOTIDX  0x70000025

/* The GOT index of the first PTE for a local symbol */

#define DT_MIPS_LOCAL_GOTIDX  0x70000026

/* The GOT index of the first PTE for a hidden symbol */

#define DT_MIPS_HIDDEN_GOTIDX 0x70000027

/* The GOT index of the first PTE for a protected symbol */

#define DT_MIPS_PROTECTED_GOTIDX  0x70000028

/* Address of `.MIPS.options'.  */

#define DT_MIPS_OPTIONS   0x70000029

/* Address of `.interface'.  */

#define DT_MIPS_INTERFACE 0x7000002a

/* ??? */

#define DT_MIPS_DYNSTR_ALIGN  0x7000002b

/* Size of the .interface section.  */

#define DT_MIPS_INTERFACE_SIZE  0x7000002c

/* Size of rld_text_resolve function stored in the GOT.  */

#define DT_MIPS_RLD_TEXT_RESOLVE_ADDR 0x7000002d

/* Default suffix of DSO to be added by rld on dlopen() calls.  */

#define DT_MIPS_PERF_SUFFIX 0x7000002e

/* Size of compact relocation section (O32).  */

#define DT_MIPS_COMPACT_SIZE  0x7000002f

/* GP value for auxiliary GOTs.  */

#define DT_MIPS_GP_VALUE  0x70000030

/* Address of auxiliary .dynamic.  */

#define DT_MIPS_AUX_DYNAMIC 0x70000031

/* Address of the base of the PLTGOT.  */

#define DT_MIPS_PLTGOT         0x70000032

/* Points to the base of a writable PLT.  */

#define DT_MIPS_RWPLT          0x70000034

/* Relative offset of run time loader map, used for debugging.  */

#define DT_MIPS_RLD_MAP_REL    0x70000035

/* Address of .MIPS.xhash section.  */

#define DT_MIPS_XHASH        0x70000036

/* Flags which may appear in a DT_MIPS_FLAGS entry.  */

/* No flags.  */

#define RHF_NONE    0x00000000

/* Uses shortcut pointers.  */

#define RHF_QUICKSTART    0x00000001

/* Hash size is not a power of two.  */

#define RHF_NOTPOT    0x00000002

/* Ignore LD_LIBRARY_PATH.  */

#define RHS_NO_LIBRARY_REPLACEMENT 0x00000004

/* DSO address may not be relocated. */

#define RHF_NO_MOVE   0x00000008

/* SGI specific features. */

#define RHF_SGI_ONLY    0x00000010

/* Guarantee that .init will finish executing before any non-init

   code in DSO is called. */

#define RHF_GUARANTEE_INIT     0x00000020

/* Contains Delta C++ code. */

#define RHF_DELTA_C_PLUS_PLUS    0x00000040

/* Guarantee that .init will start executing before any non-init

   code in DSO is called. */

#define RHF_GUARANTEE_START_INIT   0x00000080

/* Generated by pixie. */

#define RHF_PIXIE      0x00000100

/* Delay-load DSO by default. */

#define RHF_DEFAULT_DELAY_LOAD     0x00000200

/* Object may be requickstarted */

#define RHF_REQUICKSTART     0x00000400

/* Object has been requickstarted */

#define RHF_REQUICKSTARTED     0x00000800

/* Generated by cord. */

#define RHF_CORD       0x00001000

/* Object contains no unresolved undef symbols. */

#define RHF_NO_UNRES_UNDEF     0x00002000

/* Symbol table is in a safe order. */

#define RHF_RLD_ORDER_SAFE     0x00004000

/* Special values for the st_other field in the symbol table.  These

   are used in an Irix 5 dynamic symbol table.  */

#define STO_DEFAULT   STV_DEFAULT

#define STO_INTERNAL    STV_INTERNAL

#define STO_HIDDEN    STV_HIDDEN

#define STO_PROTECTED   STV_PROTECTED

/* Two topmost bits denote the MIPS ISA for .text symbols:

   + 00 -- standard MIPS code,

   + 10 -- microMIPS code,

   + 11 -- MIPS16 code; requires the following two bits to be set too.

   Note that one of the MIPS16 bits overlaps with STO_MIPS_PIC.  See below

   for details.  */

#define STO_MIPS_ISA    (3 << 6)

/* The mask spanning the rest of MIPS psABI flags.  At most one is expected

   to be set except for STO_MIPS16.  */

#define STO_MIPS_FLAGS    (~(STO_MIPS_ISA | ELF_ST_VISIBILITY (-1)))

/* The MIPS psABI was updated in 2008 with support for PLTs and copy

   relocs.  There are therefore two types of nonzero SHN_UNDEF functions:

   PLT entries and traditional MIPS lazy binding stubs.  We mark the former

   with STO_MIPS_PLT to distinguish them from the latter.  */

#define STO_MIPS_PLT    0x8

#define ELF_ST_IS_MIPS_PLT(other)         \

  ((ELF_ST_IS_MIPS16 (other)            \

    ? ((other) & (~STO_MIPS16 & STO_MIPS_FLAGS))      \

    : ((other) & STO_MIPS_FLAGS)) == STO_MIPS_PLT)

#define ELF_ST_SET_MIPS_PLT(other)          \

  ((ELF_ST_IS_MIPS16 (other)            \

    ? ((other) & (STO_MIPS16 | ~STO_MIPS_FLAGS))      \

    : ((other) & ~STO_MIPS_FLAGS)) | STO_MIPS_PLT)

/* This value is used to mark PIC functions in an object that mixes

   PIC and non-PIC.  Note that this bit overlaps with STO_MIPS16,

   although MIPS16 symbols are never considered to be MIPS_PIC.  */

#define STO_MIPS_PIC    0x20

#define ELF_ST_IS_MIPS_PIC(other) (((other) & STO_MIPS_FLAGS) == STO_MIPS_PIC)

#define ELF_ST_SET_MIPS_PIC(other)          \

  ((ELF_ST_IS_MIPS16 (other)            \

    ? ((other) & ~(STO_MIPS16 | STO_MIPS_FLAGS))      \

    : ((other) & ~STO_MIPS_FLAGS)) | STO_MIPS_PIC)

/* This value is used for a mips16 .text symbol.  */

#define STO_MIPS16    0xf0

#define ELF_ST_IS_MIPS16(other) (((other) & STO_MIPS16) == STO_MIPS16)

#define ELF_ST_SET_MIPS16(other) ((other) | STO_MIPS16)

/* This value is used for a microMIPS .text symbol.  To distinguish from

   STO_MIPS16, we set top two bits to be 10 to denote STO_MICROMIPS.  The

   mask is STO_MIPS_ISA.  */

#define STO_MICROMIPS   (2 << 6)

#define ELF_ST_IS_MICROMIPS(other) (((other) & STO_MIPS_ISA) == STO_MICROMIPS)

#define ELF_ST_SET_MICROMIPS(other) (((other) & ~STO_MIPS_ISA) | STO_MICROMIPS)

/* Whether code compression (either of the MIPS16 or the microMIPS ASEs)

   has been indicated for a .text symbol.  */

#define ELF_ST_IS_COMPRESSED(other) \

  (ELF_ST_IS_MIPS16 (other) || ELF_ST_IS_MICROMIPS (other))

/* This bit is used on Irix to indicate a symbol whose definition

   is optional - if, at final link time, it cannot be found, no

   error message should be produced.  */

#define STO_OPTIONAL    (1 << 2)

/* A macro to examine the STO_OPTIONAL bit.  */

#define ELF_MIPS_IS_OPTIONAL(other) ((other) & STO_OPTIONAL)

/* The 64-bit MIPS ELF ABI uses an unusual reloc format.  Each

   relocation entry specifies up to three actual relocations, all at

   the same address.  The first relocation which required a symbol

   uses the symbol in the r_sym field.  The second relocation which

   requires a symbol uses the symbol in the r_ssym field.  If all

   three relocations require a symbol, the third one uses a zero

   value.  */

/* An entry in a 64 bit SHT_REL section.  */

typedef struct

{

  /* Address of relocation.  */

  unsigned char r_offset[8];

  /* Symbol index.  */

  unsigned char r_sym[4];

  /* Special symbol.  */

  unsigned char r_ssym[1];

  /* Third relocation.  */

  unsigned char r_type3[1];

  /* Second relocation.  */

  unsigned char r_type2[1];

  /* First relocation.  */

  unsigned char r_type[1];

} Elf64_Mips_External_Rel;

typedef struct

{

  /* Address of relocation.  */

  bfd_vma r_offset;

  /* Symbol index.  */

  unsigned long r_sym;

  /* Special symbol.  */

  unsigned char r_ssym;

  /* Third relocation.  */

  unsigned char r_type3;

  /* Second relocation.  */

  unsigned char r_type2;

  /* First relocation.  */

  unsigned char r_type;

} Elf64_Mips_Internal_Rel;

/* An entry in a 64 bit SHT_RELA section.  */

typedef struct

{

  /* Address of relocation.  */

  unsigned char r_offset[8];

  /* Symbol index.  */

  unsigned char r_sym[4];

  /* Special symbol.  */

  unsigned char r_ssym[1];

  /* Third relocation.  */

  unsigned char r_type3[1];

  /* Second relocation.  */

  unsigned char r_type2[1];

  /* First relocation.  */

  unsigned char r_type[1];

  /* Addend.  */

  unsigned char r_addend[8];

} Elf64_Mips_External_Rela;

typedef struct

{

  /* Address of relocation.  */

  bfd_vma r_offset;

  /* Symbol index.  */

  unsigned long r_sym;

  /* Special symbol.  */

  unsigned char r_ssym;

  /* Third relocation.  */

  unsigned char r_type3;

  /* Second relocation.  */

  unsigned char r_type2;

  /* First relocation.  */

  unsigned char r_type;

  /* Addend.  */

  bfd_signed_vma r_addend;

} Elf64_Mips_Internal_Rela;

/* MIPS ELF 64 relocation info access macros.  */

#define ELF64_MIPS_R_SSYM(i) (((i) >> 24) & 0xff)

#define ELF64_MIPS_R_TYPE3(i) (((i) >> 16) & 0xff)

#define ELF64_MIPS_R_TYPE2(i) (((i) >> 8) & 0xff)

#define ELF64_MIPS_R_TYPE(i) ((i) & 0xff)

/* Values found in the r_ssym field of a relocation entry.  */

/* No relocation.  */

#define RSS_UNDEF 0

/* Value of GP.  */

#define RSS_GP    1

/* Value of GP in object being relocated.  */

#define RSS_GP0   2

/* Address of location being relocated.  */

#define RSS_LOC   3

/* A SHT_MIPS_OPTIONS section contains a series of options, each of

   which starts with this header.  */

typedef struct

{

  /* Type of option.  */

  unsigned char kind[1];

  /* Size of option descriptor, including header.  */

  unsigned char size[1];

  /* Section index of affected section, or 0 for global option.  */

  unsigned char section[2];

  /* Information specific to this kind of option.  */

  unsigned char info[4];

} Elf_External_Options;

typedef struct

{

  /* Type of option.  */

  unsigned char kind;

  /* Size of option descriptor, including header.  */

  unsigned char size;

  /* Section index of affected section, or 0 for global option.  */

  uint16_t section;

  /* Information specific to this kind of option.  */

  uint32_t info;

} Elf_Internal_Options;

/* MIPS ELF option header swapping routines.  */

extern void bfd_mips_elf_swap_options_in

  (bfd *, const Elf_External_Options *, Elf_Internal_Options *);

extern void bfd_mips_elf_swap_options_out

  (bfd *, const Elf_Internal_Options *, Elf_External_Options *);

/* Values which may appear in the kind field of an Elf_Options

   structure.  */

/* Undefined.  */

#define ODK_NULL  0

/* Register usage and GP value.  */

#define ODK_REGINFO 1

/* Exception processing information.  */

#define ODK_EXCEPTIONS  2

/* Section padding information.  */

#define ODK_PAD   3

/* Hardware workarounds performed.  */

#define ODK_HWPATCH 4

/* Fill value used by the linker.  */

#define ODK_FILL  5

/* Reserved space for desktop tools.  */

#define ODK_TAGS  6

/* Hardware workarounds, AND bits when merging.  */

#define ODK_HWAND 7

/* Hardware workarounds, OR bits when merging.  */

#define ODK_HWOR  8

/* GP group to use for text/data sections.  */

#define ODK_GP_GROUP  9

/* ID information.  */

#define ODK_IDENT 10

/* In the 32 bit ABI, an ODK_REGINFO option is just a Elf32_RegInfo

   structure.  In the 64 bit ABI, it is the following structure.  The

   info field of the options header is not used.  */

typedef struct

{

  /* Mask of general purpose registers used.  */

  unsigned char ri_gprmask[4];

  /* Padding.  */

  unsigned char ri_pad[4];

  /* Mask of co-processor registers used.  */

  unsigned char ri_cprmask[4][4];

  /* GP register value for this object file.  */

  unsigned char ri_gp_value[8];

} Elf64_External_RegInfo;

typedef struct

{

  /* Mask of general purpose registers used.  */

  uint32_t ri_gprmask;

  /* Padding.  */

  uint32_t ri_pad;

  /* Mask of co-processor registers used.  */

  uint32_t ri_cprmask[4];

  /* GP register value for this object file.  */

  uint64_t ri_gp_value;

} Elf64_Internal_RegInfo;

/* ABI Flags structure version 0.  */

typedef struct

{

  /* Version of flags structure.  */

  unsigned char version[2];

  /* The level of the ISA: 1-5, 32, 64.  */

  unsigned char isa_level[1];