/*
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file "COPYING" in the main directory of this archive
 * for more details.
 *
 * Much of this is taken from binutils and GNU libc ...
 */
#ifndef _ASM_ELF_H
#define _ASM_ELF_H

#include <linux/auxvec.h>
#include <linux/fs.h>
#include <linux/mm_types.h>

#include <uapi/linux/elf.h>

#include <asm/current.h>

/* ELF header e_flags defines. */
/* MIPS architecture level. */
#define EF_MIPS_ARCH_1          0x00000000      /* -mips1 code.  */
#define EF_MIPS_ARCH_2          0x10000000      /* -mips2 code.  */
#define EF_MIPS_ARCH_3          0x20000000      /* -mips3 code.  */
#define EF_MIPS_ARCH_4          0x30000000      /* -mips4 code.  */
#define EF_MIPS_ARCH_5          0x40000000      /* -mips5 code.  */
#define EF_MIPS_ARCH_32         0x50000000      /* MIPS32 code.  */
#define EF_MIPS_ARCH_64         0x60000000      /* MIPS64 code.  */
#define EF_MIPS_ARCH_32R2       0x70000000      /* MIPS32 R2 code.  */
#define EF_MIPS_ARCH_64R2       0x80000000      /* MIPS64 R2 code.  */

/* The ABI of a file. */
#define EF_MIPS_ABI_O32         0x00001000      /* O32 ABI.  */
#define EF_MIPS_ABI_O64         0x00002000      /* O32 extended for 64 bit.  */

#define PT_MIPS_REGINFO         0x70000000
#define PT_MIPS_RTPROC          0x70000001
#define PT_MIPS_OPTIONS         0x70000002
#define PT_MIPS_ABIFLAGS        0x70000003

/* Flags in the e_flags field of the header */
#define EF_MIPS_NOREORDER       0x00000001
#define EF_MIPS_PIC             0x00000002
#define EF_MIPS_CPIC            0x00000004
#define EF_MIPS_ABI2            0x00000020
#define EF_MIPS_OPTIONS_FIRST   0x00000080
#define EF_MIPS_32BITMODE       0x00000100
#define EF_MIPS_FP64            0x00000200
#define EF_MIPS_NAN2008         0x00000400
#define EF_MIPS_ABI             0x0000f000
#define EF_MIPS_ARCH            0xf0000000

#define DT_MIPS_RLD_VERSION     0x70000001
#define DT_MIPS_TIME_STAMP      0x70000002
#define DT_MIPS_ICHECKSUM       0x70000003
#define DT_MIPS_IVERSION        0x70000004
#define DT_MIPS_FLAGS           0x70000005
        #define RHF_NONE        0x00000000
        #define RHF_HARDWAY     0x00000001
        #define RHF_NOTPOT      0x00000002
        #define RHF_SGI_ONLY    0x00000010
#define DT_MIPS_BASE_ADDRESS    0x70000006
#define DT_MIPS_CONFLICT        0x70000008
#define DT_MIPS_LIBLIST         0x70000009
#define DT_MIPS_LOCAL_GOTNO     0x7000000a
#define DT_MIPS_CONFLICTNO      0x7000000b
#define DT_MIPS_LIBLISTNO       0x70000010
#define DT_MIPS_SYMTABNO        0x70000011
#define DT_MIPS_UNREFEXTNO      0x70000012
#define DT_MIPS_GOTSYM          0x70000013
#define DT_MIPS_HIPAGENO        0x70000014
#define DT_MIPS_RLD_MAP         0x70000016

#define R_MIPS_NONE             0
#define R_MIPS_16               1
#define R_MIPS_32               2
#define R_MIPS_REL32            3
#define R_MIPS_26               4
#define R_MIPS_HI16             5
#define R_MIPS_LO16             6
#define R_MIPS_GPREL16          7
#define R_MIPS_LITERAL          8
#define R_MIPS_GOT16            9
#define R_MIPS_PC16             10
#define R_MIPS_CALL16           11
#define R_MIPS_GPREL32          12
/* The remaining relocs are defined on Irix, although they are not
   in the MIPS ELF ABI.  */
#define R_MIPS_UNUSED1          13
#define R_MIPS_UNUSED2          14
#define R_MIPS_UNUSED3          15
#define R_MIPS_SHIFT5           16
#define R_MIPS_SHIFT6           17
#define R_MIPS_64               18
#define R_MIPS_GOT_DISP         19
#define R_MIPS_GOT_PAGE         20
#define R_MIPS_GOT_OFST         21
/*
 * The following two relocation types are specified in the MIPS ABI
 * conformance guide version 1.2 but not yet in the psABI.
 */
#define R_MIPS_GOTHI16          22
#define R_MIPS_GOTLO16          23
#define R_MIPS_SUB              24
#define R_MIPS_INSERT_A         25
#define R_MIPS_INSERT_B         26
#define R_MIPS_DELETE           27
#define R_MIPS_HIGHER           28
#define R_MIPS_HIGHEST          29
/*
 * The following two relocation types are specified in the MIPS ABI
 * conformance guide version 1.2 but not yet in the psABI.
 */
#define R_MIPS_CALLHI16         30
#define R_MIPS_CALLLO16         31
/*
 * Introduced for MIPSr6.
 */
#define R_MIPS_PC21_S2          60
#define R_MIPS_PC26_S2          61
/*
 * This range is reserved for vendor specific relocations.
 */
#define R_MIPS_LOVENDOR         100
#define R_MIPS_HIVENDOR         127

#define R_MIPS_PC32             248

#define SHN_MIPS_ACCOMON        0xff00          /* Allocated common symbols */
#define SHN_MIPS_TEXT           0xff01          /* Allocated test symbols.  */
#define SHN_MIPS_DATA           0xff02          /* Allocated data symbols.  */
#define SHN_MIPS_SCOMMON        0xff03          /* Small common symbols */
#define SHN_MIPS_SUNDEFINED     0xff04          /* Small undefined symbols */

#define SHT_MIPS_LIST           0x70000000
#define SHT_MIPS_CONFLICT       0x70000002
#define SHT_MIPS_GPTAB          0x70000003
#define SHT_MIPS_UCODE          0x70000004
#define SHT_MIPS_DEBUG          0x70000005
#define SHT_MIPS_REGINFO        0x70000006
#define SHT_MIPS_PACKAGE        0x70000007
#define SHT_MIPS_PACKSYM        0x70000008
#define SHT_MIPS_RELD           0x70000009
#define SHT_MIPS_IFACE          0x7000000b
#define SHT_MIPS_CONTENT        0x7000000c
#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
#define SHT_MIPS_DELTASYM       0x7000001b
#define SHT_MIPS_DELTAINST      0x7000001c
#define SHT_MIPS_DELTACLASS     0x7000001d
#define SHT_MIPS_DWARF          0x7000001e
#define SHT_MIPS_DELTADECL      0x7000001f
#define SHT_MIPS_SYMBOL_LIB     0x70000020
#define SHT_MIPS_EVENTS         0x70000021
#define SHT_MIPS_TRANSLATE      0x70000022
#define SHT_MIPS_PIXIE          0x70000023
#define SHT_MIPS_XLATE          0x70000024
#define SHT_MIPS_XLATE_DEBUG    0x70000025
#define SHT_MIPS_WHIRL          0x70000026
#define SHT_MIPS_EH_REGION      0x70000027
#define SHT_MIPS_XLATE_OLD      0x70000028
#define SHT_MIPS_PDR_EXCEPTION  0x70000029

#define SHF_MIPS_GPREL          0x10000000
#define SHF_MIPS_MERGE          0x20000000
#define SHF_MIPS_ADDR           0x40000000
#define SHF_MIPS_STRING         0x80000000
#define SHF_MIPS_NOSTRIP        0x08000000
#define SHF_MIPS_LOCAL          0x04000000
#define SHF_MIPS_NAMES          0x02000000
#define SHF_MIPS_NODUPES        0x01000000

#define MIPS_ABI_FP_ANY         0       /* FP ABI doesn't matter */
#define MIPS_ABI_FP_DOUBLE      1       /* -mdouble-float */
#define MIPS_ABI_FP_SINGLE      2       /* -msingle-float */
#define MIPS_ABI_FP_SOFT        3       /* -msoft-float */
#define MIPS_ABI_FP_OLD_64      4       /* -mips32r2 -mfp64 */
#define MIPS_ABI_FP_XX          5       /* -mfpxx */
#define MIPS_ABI_FP_64          6       /* -mips32r2 -mfp64 */
#define MIPS_ABI_FP_64A         7       /* -mips32r2 -mfp64 -mno-odd-spreg */

struct mips_elf_abiflags_v0 {
        uint16_t version;       /* Version of flags structure */
        uint8_t isa_level;      /* The level of the ISA: 1-5, 32, 64 */
        uint8_t isa_rev;        /* The revision of ISA: 0 for MIPS V and below,
                                   1-n otherwise */
        uint8_t gpr_size;       /* The size of general purpose registers */
        uint8_t cpr1_size;      /* The size of co-processor 1 registers */
        uint8_t cpr2_size;      /* The size of co-processor 2 registers */
        uint8_t fp_abi;         /* The floating-point ABI */
        uint32_t isa_ext;       /* Mask of processor-specific extensions */
        uint32_t ases;          /* Mask of ASEs used */
        uint32_t flags1;        /* Mask of general flags */
        uint32_t flags2;
};

/* ELF register definitions */
#define ELF_NGREG       45
#define ELF_NFPREG      33

typedef unsigned long elf_greg_t;
typedef elf_greg_t elf_gregset_t[ELF_NGREG];

typedef double elf_fpreg_t;
typedef elf_fpreg_t elf_fpregset_t[ELF_NFPREG];

void mips_dump_regs32(u32 *uregs, const struct pt_regs *regs);
void mips_dump_regs64(u64 *uregs, const struct pt_regs *regs);

#ifdef CONFIG_32BIT
/*
 * This is used to ensure we don't load something for the wrong architecture.
 */
#define elf_check_arch elf32_check_arch

/*
 * These are used to set parameters in the core dumps.
 */
#define ELF_CLASS       ELFCLASS32

#define ELF_CORE_COPY_REGS(dest, regs) \
        mips_dump_regs32((u32 *)&(dest), (regs));

#endif /* CONFIG_32BIT */

#ifdef CONFIG_64BIT
/*
 * This is used to ensure we don't load something for the wrong architecture.
 */
#define elf_check_arch elf64_check_arch
#define compat_elf_check_arch elf32_check_arch

/*
 * These are used to set parameters in the core dumps.
 */
#define ELF_CLASS       ELFCLASS64

#define ELF_CORE_COPY_REGS(dest, regs) \
        mips_dump_regs64((u64 *)&(dest), (regs));

#endif /* CONFIG_64BIT */

/*
 * These are used to set parameters in the core dumps.
 */
#ifdef __MIPSEB__
#define ELF_DATA        ELFDATA2MSB
#elif defined(__MIPSEL__)
#define ELF_DATA        ELFDATA2LSB
#endif
#define ELF_ARCH        EM_MIPS

/*
 * In order to be sure that we don't attempt to execute an O32 binary which
 * requires 64 bit FP (FR=1) on a system which does not support it we refuse
 * to execute any binary which has bits specified by the following macro set
 * in its ELF header flags.
 */
#ifdef CONFIG_MIPS_O32_FP64_SUPPORT
# define __MIPS_O32_FP64_MUST_BE_ZERO   0
#else
# define __MIPS_O32_FP64_MUST_BE_ZERO   EF_MIPS_FP64
#endif

#define mips_elf_check_machine(x) ((x)->e_machine == EM_MIPS)

#define vmcore_elf32_check_arch mips_elf_check_machine
#define vmcore_elf64_check_arch mips_elf_check_machine

/*
 * Return non-zero if HDR identifies an o32 or n32 ELF binary.
 */
#define elf32_check_arch(hdr)                                           \
({                                                                      \
        int __res = 1;                                                  \
        struct elfhdr *__h = (hdr);                                     \
                                                                        \
        if (!mips_elf_check_machine(__h))                               \
                __res = 0;                                              \
        if (__h->e_ident[EI_CLASS] != ELFCLASS32)                       \
                __res = 0;                                              \
        if ((__h->e_flags & EF_MIPS_ABI2) != 0) {                       \
                if (!IS_ENABLED(CONFIG_MIPS32_N32) ||                   \
                     (__h->e_flags & EF_MIPS_ABI))                      \
                        __res = 0;                                      \
        } else {                                                        \
                if (IS_ENABLED(CONFIG_64BIT) && !IS_ENABLED(CONFIG_MIPS32_O32)) \
                        __res = 0;                                      \
                if (((__h->e_flags & EF_MIPS_ABI) != 0) &&              \
                    ((__h->e_flags & EF_MIPS_ABI) != EF_MIPS_ABI_O32))  \
                        __res = 0;                                      \
                if (__h->e_flags & __MIPS_O32_FP64_MUST_BE_ZERO)        \
                        __res = 0;                                      \
        }                                                               \
        __res;                                                          \
})

/*
 * Return non-zero if HDR identifies an n64 ELF binary.
 */
#define elf64_check_arch(hdr)                                           \
({                                                                      \
        int __res = 1;                                                  \
        struct elfhdr *__h = (hdr);                                     \
                                                                        \
        if (!mips_elf_check_machine(__h))                               \
                __res = 0;                                              \
        if (__h->e_ident[EI_CLASS] != ELFCLASS64)                       \
                __res = 0;                                              \
                                                                        \
        __res;                                                          \
})

struct mips_abi;

extern struct mips_abi mips_abi;
extern struct mips_abi mips_abi_32;
extern struct mips_abi mips_abi_n32;

#ifdef CONFIG_32BIT

#define SET_PERSONALITY2(ex, state)                                     \
do {                                                                    \
        clear_thread_flag(TIF_HYBRID_FPREGS);                           \
        set_thread_flag(TIF_32BIT_FPREGS);                              \
                                                                        \
        current->thread.abi = &mips_abi;                                \
                                                                        \
        mips_set_personality_fp(state);                                 \
        mips_set_personality_nan(state);                                \
                                                                        \
        if (personality(current->personality) != PER_LINUX)             \
                set_personality(PER_LINUX);                             \
} while (0)

#endif /* CONFIG_32BIT */

#ifdef CONFIG_64BIT

#ifdef CONFIG_MIPS32_N32
#define __SET_PERSONALITY32_N32()                                       \
        do {                                                            \
                set_thread_flag(TIF_32BIT_ADDR);                        \
                                                                        \
                current->thread.abi = &mips_abi_n32;                    \
        } while (0)
#else
#define __SET_PERSONALITY32_N32()                                       \
        do { } while (0)
#endif

#ifdef CONFIG_MIPS32_O32
#define __SET_PERSONALITY32_O32(ex, state)                              \
        do {                                                            \
                set_thread_flag(TIF_32BIT_REGS);                        \
                set_thread_flag(TIF_32BIT_ADDR);                        \
                clear_thread_flag(TIF_HYBRID_FPREGS);                   \
                set_thread_flag(TIF_32BIT_FPREGS);                      \
                                                                        \
                current->thread.abi = &mips_abi_32;                     \
                                                                        \
                mips_set_personality_fp(state);                         \
        } while (0)
#else
#define __SET_PERSONALITY32_O32(ex, state)                              \
        do { } while (0)
#endif

#ifdef CONFIG_MIPS32_COMPAT
#define __SET_PERSONALITY32(ex, state)                                  \
do {                                                                    \
        if ((((ex).e_flags & EF_MIPS_ABI2) != 0) &&                     \
             ((ex).e_flags & EF_MIPS_ABI) == 0)                         \
                __SET_PERSONALITY32_N32();                              \
        else                                                            \
                __SET_PERSONALITY32_O32(ex, state);                     \
} while (0)
#else
#define __SET_PERSONALITY32(ex, state) do { } while (0)
#endif

#define SET_PERSONALITY2(ex, state)                                     \
do {                                                                    \
        unsigned int p;                                                 \
                                                                        \
        clear_thread_flag(TIF_32BIT_REGS);                              \
        clear_thread_flag(TIF_32BIT_FPREGS);                            \
        clear_thread_flag(TIF_HYBRID_FPREGS);                           \
        clear_thread_flag(TIF_32BIT_ADDR);                              \
        current->personality &= ~READ_IMPLIES_EXEC;                     \
                                                                        \
        if ((ex).e_ident[EI_CLASS] == ELFCLASS32)                       \
                __SET_PERSONALITY32(ex, state);                         \
        else                                                            \
                current->thread.abi = &mips_abi;                        \
                                                                        \
        mips_set_personality_nan(state);                                \
                                                                        \
        p = personality(current->personality);                          \
        if (p != PER_LINUX32 && p != PER_LINUX)                         \
                set_personality(PER_LINUX);                             \
} while (0)

#endif /* CONFIG_64BIT */

#define CORE_DUMP_USE_REGSET
#define ELF_EXEC_PAGESIZE       PAGE_SIZE

/* This yields a mask that user programs can use to figure out what
   instruction set this cpu supports.  This could be done in userspace,
   but it's not easy, and we've already done it here.  */

#define ELF_HWCAP       (elf_hwcap)
extern unsigned int elf_hwcap;
#include <asm/hwcap.h>

/*
 * This yields a string that ld.so will use to load implementation
 * specific libraries for optimization.  This is more specific in
 * intent than poking at uname or /proc/cpuinfo.
 */

#define ELF_PLATFORM  __elf_platform
extern const char *__elf_platform;

#define ELF_BASE_PLATFORM  __elf_base_platform
extern const char *__elf_base_platform;

/*
 * See comments in asm-alpha/elf.h, this is the same thing
 * on the MIPS.
 */
#define ELF_PLAT_INIT(_r, load_addr)    do { \
        _r->regs[1] = _r->regs[2] = _r->regs[3] = _r->regs[4] = 0;      \
        _r->regs[5] = _r->regs[6] = _r->regs[7] = _r->regs[8] = 0;      \
        _r->regs[9] = _r->regs[10] = _r->regs[11] = _r->regs[12] = 0;   \
        _r->regs[13] = _r->regs[14] = _r->regs[15] = _r->regs[16] = 0;  \
        _r->regs[17] = _r->regs[18] = _r->regs[19] = _r->regs[20] = 0;  \
        _r->regs[21] = _r->regs[22] = _r->regs[23] = _r->regs[24] = 0;  \
        _r->regs[25] = _r->regs[26] = _r->regs[27] = _r->regs[28] = 0;  \
        _r->regs[30] = _r->regs[31] = 0;                                \
} while (0)

/* This is the location that an ET_DYN program is loaded if exec'ed.  Typical
   use of this is to invoke "./ld.so someprog" to test out a new version of
   the loader.  We need to make sure that it is out of the way of the program
   that it will "exec", and that there is sufficient room for the brk.  */

#define ELF_ET_DYN_BASE         (TASK_SIZE / 3 * 2)

/* update AT_VECTOR_SIZE_ARCH if the number of NEW_AUX_ENT entries changes */
#define ARCH_DLINFO                                                     \
do {                                                                    \
        NEW_AUX_ENT(AT_SYSINFO_EHDR,                                    \
                    (unsigned long)current->mm->context.vdso);          \
} while (0)

#define ARCH_HAS_SETUP_ADDITIONAL_PAGES 1
struct linux_binprm;
extern int arch_setup_additional_pages(struct linux_binprm *bprm,
                                       int uses_interp);

#ifdef CONFIG_MIPS_FP_SUPPORT

struct arch_elf_state {
        int nan_2008;
        int fp_abi;
        int interp_fp_abi;
        int overall_fp_mode;
};

#define MIPS_ABI_FP_UNKNOWN     (-1)    /* Unknown FP ABI (kernel internal) */

#define INIT_ARCH_ELF_STATE {                   \
        .nan_2008 = -1,                         \
        .fp_abi = MIPS_ABI_FP_UNKNOWN,          \
        .interp_fp_abi = MIPS_ABI_FP_UNKNOWN,   \
        .overall_fp_mode = -1,                  \
}

extern int arch_elf_pt_proc(void *ehdr, void *phdr, struct file *elf,
                            bool is_interp, struct arch_elf_state *state);

extern int arch_check_elf(void *ehdr, bool has_interpreter, void *interp_ehdr,
                          struct arch_elf_state *state);

/* Whether to accept legacy-NaN and 2008-NaN user binaries.  */
extern bool mips_use_nan_legacy;
extern bool mips_use_nan_2008;

extern void mips_set_personality_nan(struct arch_elf_state *state);
extern void mips_set_personality_fp(struct arch_elf_state *state);

#else /* !CONFIG_MIPS_FP_SUPPORT */

struct arch_elf_state;

static inline void mips_set_personality_nan(struct arch_elf_state *state)
{
        /* no-op */
}

static inline void mips_set_personality_fp(struct arch_elf_state *state)
{
        /* no-op */
}

#endif /* !CONFIG_MIPS_FP_SUPPORT */

#define elf_read_implies_exec(ex, stk) mips_elf_read_implies_exec(&(ex), stk)
extern int mips_elf_read_implies_exec(void *elf_ex, int exstack);

#endif /* _ASM_ELF_H */