rt-thread/bsp/phytium/libraries/standalone/common/felf.c

/*
 * Copyright : (C) 2022 Phytium Information Technology, Inc.
 * All Rights Reserved.
 *
 * This program is OPEN SOURCE software: you can redistribute it and/or modify it
 * under the terms of the Phytium Public License as published by the Phytium Technology Co.,Ltd,
 * either version 1.0 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 Phytium Public License for more details.
 *
 *
 * FilePath: felf.c
 * Date: 2021-08-31 11:16:59
 * LastEditTime: 2022-02-17 18:05:16
 * Description:  This file is for providing elf functions.
 *
 * Modify History:
 *  Ver   Who        Date         Changes
 * ----- ------     --------    --------------------------------------
 * 1.0  zhugengyu  2022/10/27   rename file name
 */

#include <string.h>
#include "fkernel.h"
#include "felf.h"
#include "fcache.h"
#include "fdebug.h"
#include "fprintk.h"
/* This version doesn't work for 64-bit ABIs - Erik */

/* These typedefs need to be handled better */
typedef u32 Elf32_Addr;  /* Unsigned program address */
typedef u32 Elf32_Off;   /* Unsigned file offset */
typedef s32 Elf32_Sword; /* Signed large integer */
typedef u32 Elf32_Word;  /* Unsigned large integer */
typedef u16 Elf32_Half;  /* Unsigned medium integer */

/* 64-bit ELF base types */
typedef u64 Elf64_Addr;
typedef u16 Elf64_Half;
typedef s16 Elf64_SHalf;
typedef u64 Elf64_Off;
typedef s32 Elf64_Sword;
typedef u32 Elf64_Word;
typedef u64 Elf64_Xword;
typedef s64 Elf64_Sxword;

/* e_ident[] identification indexes */
#define EI_MAG0 0       /* file ID */
#define EI_MAG1 1       /* file ID */
#define EI_MAG2 2       /* file ID */
#define EI_MAG3 3       /* file ID */
#define EI_CLASS 4      /* file class */
#define EI_DATA 5       /* data encoding */
#define EI_VERSION 6    /* ELF header version */
#define EI_OSABI 7      /* OS/ABI specific ELF extensions */
#define EI_ABIVERSION 8 /* ABI target version */
#define EI_PAD 9        /* start of pad bytes */
#define EI_NIDENT 16    /* Size of e_ident[] */

/* ELF Header */
typedef struct
{
    unsigned char e_ident[EI_NIDENT]; /* ELF Identification */
    Elf32_Half e_type;                /* object file type */
    Elf32_Half e_machine;             /* machine */
    Elf32_Word e_version;             /* object file version */
    Elf32_Addr e_entry;               /* virtual entry point */
    Elf32_Off e_phoff;                /* program header table offset */
    Elf32_Off e_shoff;                /* section header table offset */
    Elf32_Word e_flags;               /* processor-specific flags */
    Elf32_Half e_ehsize;              /* ELF header size */
    Elf32_Half e_phentsize;           /* program header entry size */
    Elf32_Half e_phnum;               /* number of program header entries */
    Elf32_Half e_shentsize;           /* section header entry size */
    Elf32_Half e_shnum;               /* number of section header entries */
    Elf32_Half e_shstrndx;            /* section header table's "section
                       header string table" entry offset */
} Elf32_Ehdr;

typedef struct
{
    unsigned char e_ident[EI_NIDENT]; /* ELF Identification */
    Elf64_Half e_type;                /* object file type */
    Elf64_Half e_machine;             /* machine */
    Elf64_Word e_version;             /* object file version */
    Elf64_Addr e_entry;               /* virtual entry point */
    Elf64_Off e_phoff;                /* program header table offset */
    Elf64_Off e_shoff;                /* section header table offset */
    Elf64_Word e_flags;               /* processor-specific flags */
    Elf64_Half e_ehsize;              /* ELF header size */
    Elf64_Half e_phentsize;           /* program header entry size */
    Elf64_Half e_phnum;               /* number of program header entries */
    Elf64_Half e_shentsize;           /* section header entry size */
    Elf64_Half e_shnum;               /* number of section header entries */
    Elf64_Half e_shstrndx;            /* section header table's "section
                       header string table" entry offset */
} Elf64_Ehdr;

/* Section Header */
typedef struct
{
    Elf32_Word sh_name;      /* name - index into section header
                       string table section */
    Elf32_Word sh_type;      /* type */
    Elf32_Word sh_flags;     /* flags */
    Elf32_Addr sh_addr;      /* address */
    Elf32_Off sh_offset;     /* file offset */
    Elf32_Word sh_size;      /* section size */
    Elf32_Word sh_link;      /* section header table index link */
    Elf32_Word sh_info;      /* extra information */
    Elf32_Word sh_addralign; /* address alignment */
    Elf32_Word sh_entsize;   /* section entry size */
} Elf32_Shdr;

typedef struct
{
    Elf64_Word sh_name;       /* name - index into section header
                       string table section */
    Elf64_Word sh_type;       /* type */
    Elf64_Xword sh_flags;     /* flags */
    Elf64_Addr sh_addr;       /* address */
    Elf64_Off sh_offset;      /* file offset */
    Elf64_Xword sh_size;      /* section size */
    Elf64_Word sh_link;       /* section header table index link */
    Elf64_Word sh_info;       /* extra information */
    Elf64_Xword sh_addralign; /* address alignment */
    Elf64_Xword sh_entsize;   /* section entry size */
} Elf64_Shdr;

/* Symbol Table Entry */
typedef struct
{
    Elf32_Word st_name;     /* name - index into string table */
    Elf32_Addr st_value;    /* symbol value */
    Elf32_Word st_size;     /* symbol size */
    unsigned char st_info;  /* type and binding */
    unsigned char st_other; /* 0 - no defined meaning */
    Elf32_Half st_shndx;    /* section header index */
} Elf32_Sym;

/* Relocation entry with implicit addend */
typedef struct
{
    Elf32_Addr r_offset; /* offset of relocation */
    Elf32_Word r_info;   /* symbol table index and type */
} Elf32_Rel;

/* Relocation entry with explicit addend */
typedef struct
{
    Elf32_Addr r_offset; /* offset of relocation */
    Elf32_Word r_info;   /* symbol table index and type */
    Elf32_Sword r_addend;
} Elf32_Rela;

typedef struct
{
    Elf64_Addr r_offset; /* Location at which to apply the action */
    Elf64_Xword r_info;  /* index and type of relocation */
} Elf64_Rel;

typedef struct
{
    Elf64_Addr r_offset;   /* Location at which to apply the action */
    Elf64_Xword r_info;    /* index and type of relocation */
    Elf64_Sxword r_addend; /* Constant addend used to compute value */
} Elf64_Rela;

/* Program Header */
typedef struct
{
    Elf32_Word p_type;   /* segment type */
    Elf32_Off p_offset;  /* segment offset */
    Elf32_Addr p_vaddr;  /* virtual address of segment */
    Elf32_Addr p_paddr;  /* physical address of segment */
    Elf32_Word p_filesz; /* number of bytes in file for seg */
    Elf32_Word p_memsz;  /* number of bytes in mem. for seg */
    Elf32_Word p_flags;  /* flags */
    Elf32_Word p_align;  /* memory alignment */
} Elf32_Phdr;

typedef struct
{
    Elf64_Word p_type;    /* segment type */
    Elf64_Word p_flags;   /* flags */
    Elf64_Off p_offset;   /* segment offset */
    Elf64_Addr p_vaddr;   /* virtual address of segment */
    Elf64_Addr p_paddr;   /* physical address of segment */
    Elf64_Xword p_filesz; /* number of bytes in file for seg */
    Elf64_Xword p_memsz;  /* number of bytes in mem. for seg */
    Elf64_Xword p_align;  /* memory alignment */
} Elf64_Phdr;

/* Dynamic structure */
typedef struct
{
    Elf32_Sword d_tag; /* controls meaning of d_val */
    union
    {
        Elf32_Word d_val; /* Multiple meanings - see d_tag */
        Elf32_Addr d_ptr; /* program virtual address */
    } d_un;
} Elf32_Dyn;

extern Elf32_Dyn _DYNAMIC[];

typedef struct
{
    Elf64_Sxword d_tag; /* entry tag value */
    union
    {
        Elf64_Xword d_val;
        Elf64_Addr d_ptr;
    } d_un;
} Elf64_Dyn;

/* e_ident[] magic number */
#define ELFMAG0 0x7f     /* e_ident[EI_MAG0] */
#define ELFMAG1 'E'      /* e_ident[EI_MAG1] */
#define ELFMAG2 'L'      /* e_ident[EI_MAG2] */
#define ELFMAG3 'F'      /* e_ident[EI_MAG3] */
#define ELFMAG "\177ELF" /* magic */
#define SELFMAG 4        /* size of magic */

/* e_ident[] file class */
#define ELFCLASSNONE 0 /* invalid */
#define ELFCLASS32 1   /* 32-bit objs */
#define ELFCLASS64 2   /* 64-bit objs */
#define ELFCLASSNUM 3  /* number of classes */

/* e_ident[] data encoding */
#define ELFDATANONE 0 /* invalid */
#define ELFDATA2LSB 1 /* Little-Endian */
#define ELFDATA2MSB 2 /* Big-Endian */
#define ELFDATANUM 3  /* number of data encode defines */

/* e_ident[] OS/ABI specific ELF extensions */
#define ELFOSABI_NONE 0     /* No extension specified */
#define ELFOSABI_HPUX 1     /* Hewlett-Packard HP-UX */
#define ELFOSABI_NETBSD 2   /* NetBSD */
#define ELFOSABI_LINUX 3    /* Linux */
#define ELFOSABI_SOLARIS 6  /* Sun Solaris */
#define ELFOSABI_AIX 7      /* AIX */
#define ELFOSABI_IRIX 8     /* IRIX */
#define ELFOSABI_FREEBSD 9  /* FreeBSD */
#define ELFOSABI_TRU64 10   /* Compaq TRU64 UNIX */
#define ELFOSABI_MODESTO 11 /* Novell Modesto */
#define ELFOSABI_OPENBSD 12 /* OpenBSD */
/* 64-255 Architecture-specific value range */

/* e_ident[] ABI Version */
#define ELFABIVERSION 0

/* e_ident */
#define IS_ELF(ehdr) ((ehdr).e_ident[EI_MAG0] == ELFMAG0 && \
                      (ehdr).e_ident[EI_MAG1] == ELFMAG1 && \
                      (ehdr).e_ident[EI_MAG2] == ELFMAG2 && \
                      (ehdr).e_ident[EI_MAG3] == ELFMAG3)

/* e_type */
#define ET_NONE 0        /* No file type */
#define ET_REL 1         /* relocatable file */
#define ET_EXEC 2        /* executable file */
#define ET_DYN 3         /* shared object file */
#define ET_CORE 4        /* core file */
#define ET_NUM 5         /* number of types */
#define ET_LOOS 0xfe00   /* reserved range for operating */
#define ET_HIOS 0xfeff   /* system specific e_type */
#define ET_LOPROC 0xff00 /* reserved range for processor */
#define ET_HIPROC 0xffff /* specific e_type */

/* e_machine */
#define EM_NONE 0  /* No Machine */
#define EM_M32 1   /* AT&T WE 32100 */
#define EM_SPARC 2 /* SPARC */
#define EM_386 3   /* Intel 80386 */
#define EM_68K 4   /* Motorola 68000 */
#define EM_88K 5   /* Motorola 88000 */
#if 0
    #define EM_486 6 /* RESERVED - was Intel 80486 */
#endif
#define EM_860 7          /* Intel 80860 */
#define EM_MIPS 8         /* MIPS R3000 Big-Endian only */
#define EM_S370 9         /* IBM System/370 Processor */
#define EM_MIPS_RS4_BE 10 /* MIPS R4000 Big-Endian */
#if 0
#define EM_SPARC64 11 /* RESERVED - was SPARC v9 \
64-bit unoffical */
#endif
/* RESERVED 11-14 for future use */
#define EM_PARISC 15 /* HPPA */
/* RESERVED 16 for future use */
#define EM_VPP500 17      /* Fujitsu VPP500 */
#define EM_SPARC32PLUS 18 /* Enhanced instruction set SPARC */
#define EM_960 19         /* Intel 80960 */
#define EM_PPC 20         /* PowerPC */
#define EM_PPC64 21       /* 64-bit PowerPC */
#define EM_S390 22        /* IBM System/390 Processor */
/* RESERVED 23-35 for future use */
#define EM_V800 36     /* NEC V800 */
#define EM_FR20 37     /* Fujitsu FR20 */
#define EM_RH32 38     /* TRW RH-32 */
#define EM_RCE 39      /* Motorola RCE */
#define EM_ARM 40      /* Advanced Risc Machines ARM */
#define EM_ALPHA 41    /* Digital Alpha */
#define EM_SH 42       /* Hitachi SH */
#define EM_SPARCV9 43  /* SPARC Version 9 */
#define EM_TRICORE 44  /* Siemens TriCore embedded processor */
#define EM_ARC 45      /* Argonaut RISC Core */
#define EM_H8_300 46   /* Hitachi H8/300 */
#define EM_H8_300H 47  /* Hitachi H8/300H */
#define EM_H8S 48      /* Hitachi H8S */
#define EM_H8_500 49   /* Hitachi H8/500 */
#define EM_IA_64 50    /* Intel Merced */
#define EM_MIPS_X 51   /* Stanford MIPS-X */
#define EM_COLDFIRE 52 /* Motorola Coldfire */
#define EM_68HC12 53   /* Motorola M68HC12 */
#define EM_MMA 54      /* Fujitsu MMA Multimedia Accelerator*/
#define EM_PCP 55      /* Siemens PCP */
#define EM_NCPU 56     /* Sony nCPU embeeded RISC */
#define EM_NDR1 57     /* Denso NDR1 microprocessor */
#define EM_STARCORE 58 /* Motorola Start*Core processor */
#define EM_ME16 59     /* Toyota ME16 processor */
#define EM_ST100 60    /* STMicroelectronic ST100 processor */
#define EM_TINYJ 61    /* Advanced Logic Corp. Tinyj emb.fam*/
#define EM_X86_64 62   /* AMD x86-64 */
#define EM_PDSP 63     /* Sony DSP Processor */
/* RESERVED 64,65 for future use */
#define EM_FX66 66     /* Siemens FX66 microcontroller */
#define EM_ST9PLUS 67  /* STMicroelectronics ST9+ 8/16 mc */
#define EM_ST7 68      /* STmicroelectronics ST7 8 bit mc */
#define EM_68HC16 69   /* Motorola MC68HC16 microcontroller */
#define EM_68HC11 70   /* Motorola MC68HC11 microcontroller */
#define EM_68HC08 71   /* Motorola MC68HC08 microcontroller */
#define EM_68HC05 72   /* Motorola MC68HC05 microcontroller */
#define EM_SVX 73      /* Silicon Graphics SVx */
#define EM_ST19 74     /* STMicroelectronics ST19 8 bit mc */
#define EM_VAX 75      /* Digital VAX */
#define EM_CHRIS 76    /* Axis Communications embedded proc. */
#define EM_JAVELIN 77  /* Infineon Technologies emb. proc. */
#define EM_FIREPATH 78 /* Element 14 64-bit DSP Processor */
#define EM_ZSP 79      /* LSI Logic 16-bit DSP Processor */
#define EM_MMIX 80     /* Donald Knuth's edu 64-bit proc. */
#define EM_HUANY 81    /* Harvard University mach-indep objs */
#define EM_PRISM 82    /* SiTera Prism */
#define EM_AVR 83      /* Atmel AVR 8-bit microcontroller */
#define EM_FR30 84     /* Fujitsu FR30 */
#define EM_D10V 85     /* Mitsubishi DV10V */
#define EM_D30V 86     /* Mitsubishi DV30V */
#define EM_V850 87     /* NEC v850 */
#define EM_M32R 88     /* Mitsubishi M32R */
#define EM_MN10300 89  /* Matsushita MN10200 */
#define EM_MN10200 90  /* Matsushita MN10200 */
#define EM_PJ 91       /* picoJava */
#define EM_NUM 92      /* number of machine types */

/* Version */
#define EV_NONE 0    /* Invalid */
#define EV_CURRENT 1 /* Current */
#define EV_NUM 2     /* number of versions */

/* Special Section Indexes */
#define SHN_UNDEF 0          /* undefined */
#define SHN_LORESERVE 0xff00 /* lower bounds of reserved indexes */
#define SHN_LOPROC 0xff00    /* reserved range for processor */
#define SHN_HIPROC 0xff1f    /* specific section indexes */
#define SHN_LOOS 0xff20      /* reserved range for operating */
#define SHN_HIOS 0xff3f      /* specific semantics */
#define SHN_ABS 0xfff1       /* absolute value */
#define SHN_COMMON 0xfff2    /* common symbol */
#define SHN_XINDEX 0xffff    /* Index is an extra table */
#define SHN_HIRESERVE 0xffff /* upper bounds of reserved indexes */

/* sh_type */
#define SHT_NULL 0            /* inactive */
#define SHT_PROGBITS 1        /* program defined information */
#define SHT_SYMTAB 2          /* symbol table section */
#define SHT_STRTAB 3          /* string table section */
#define SHT_RELA 4            /* relocation section with addends*/
#define SHT_HASH 5            /* symbol hash table section */
#define SHT_DYNAMIC 6         /* dynamic section */
#define SHT_NOTE 7            /* note section */
#define SHT_NOBITS 8          /* no space section */
#define SHT_REL 9             /* relation section without addends */
#define SHT_SHLIB 10          /* reserved - purpose unknown */
#define SHT_DYNSYM 11         /* dynamic symbol table section */
#define SHT_INIT_ARRAY 14     /* Array of constructors */
#define SHT_FINI_ARRAY 15     /* Array of destructors */
#define SHT_PREINIT_ARRAY 16  /* Array of pre-constructors */
#define SHT_GROUP 17          /* Section group */
#define SHT_SYMTAB_SHNDX 18   /* Extended section indeces */
#define SHT_NUM 19            /* number of section types */
#define SHT_LOOS 0x60000000   /* Start OS-specific */
#define SHT_HIOS 0x6fffffff   /* End OS-specific */
#define SHT_LOPROC 0x70000000 /* reserved range for processor */
#define SHT_HIPROC 0x7fffffff /* specific section header types */
#define SHT_LOUSER 0x80000000 /* reserved range for application */
#define SHT_HIUSER 0xffffffff /* specific indexes */

/* Section names */
#define ELF_BSS ".bss"                     /* uninitialized data */
#define ELF_COMMENT ".comment"             /* version control information */
#define ELF_DATA ".data"                   /* initialized data */
#define ELF_DATA1 ".data1"                 /* initialized data */
#define ELF_DEBUG ".debug"                 /* debug */
#define ELF_DYNAMIC ".dynamic"             /* dynamic linking information */
#define ELF_DYNSTR ".dynstr"               /* dynamic string table */
#define ELF_DYNSYM ".dynsym"               /* dynamic symbol table */
#define ELF_FINI ".fini"                   /* termination code */
#define ELF_FINI_ARRAY ".fini_array"       /* Array of destructors */
#define ELF_GOT ".got"                     /* global offset table */
#define ELF_HASH ".hash"                   /* symbol hash table */
#define ELF_INIT ".init"                   /* initialization code */
#define ELF_INIT_ARRAY ".init_array"       /* Array of constuctors */
#define ELF_INTERP ".interp"               /* Pathname of program interpreter */
#define ELF_LINE ".line"                   /* Symbolic line numnber information */
#define ELF_NOTE ".note"                   /* Contains note section */
#define ELF_PLT ".plt"                     /* Procedure linkage table */
#define ELF_PREINIT_ARRAY ".preinit_array" /* Array of pre-constructors */
#define ELF_REL_DATA ".rel.data"           /* relocation data */
#define ELF_REL_FINI ".rel.fini"           /* relocation termination code */
#define ELF_REL_INIT ".rel.init"           /* relocation initialization code */
#define ELF_REL_DYN ".rel.dyn"             /* relocaltion dynamic link info */
#define ELF_REL_RODATA ".rel.rodata"       /* relocation read-only data */
#define ELF_REL_TEXT ".rel.text"           /* relocation code */
#define ELF_RODATA ".rodata"               /* read-only data */
#define ELF_RODATA1 ".rodata1"             /* read-only data */
#define ELF_SHSTRTAB ".shstrtab"           /* section header string table */
#define ELF_STRTAB ".strtab"               /* string table */
#define ELF_SYMTAB ".symtab"               /* symbol table */
#define ELF_SYMTAB_SHNDX ".symtab_shndx"   /* symbol table section index */
#define ELF_TBSS ".tbss"                   /* thread local uninit data */
#define ELF_TDATA ".tdata"                 /* thread local init data */
#define ELF_TDATA1 ".tdata1"               /* thread local init data */
#define ELF_TEXT ".text"                   /* code */

/* Section Attribute Flags - sh_flags */
#define SHF_WRITE 0x1              /* Writable */
#define SHF_ALLOC 0x2              /* occupies memory */
#define SHF_EXECINSTR 0x4          /* executable */
#define SHF_MERGE 0x10             /* Might be merged */
#define SHF_STRINGS 0x20           /* Contains NULL terminated strings */
#define SHF_INFO_LINK 0x40         /* sh_info contains SHT index */
#define SHF_LINK_ORDER 0x80        /* Preserve order after combining*/
#define SHF_OS_NONCONFORMING 0x100 /* Non-standard OS specific handling */
#define SHF_GROUP 0x200            /* Member of section group */
#define SHF_TLS 0x400              /* Thread local storage */
#define SHF_MASKOS 0x0ff00000      /* OS specific */
#define SHF_MASKPROC 0xf0000000    /* reserved bits for processor */
/* specific section attributes */

/* Section Group Flags */
#define GRP_COMDAT 0x1          /* COMDAT group */
#define GRP_MASKOS 0x0ff00000   /* Mask OS specific flags */
#define GRP_MASKPROC 0xf0000000 /* Mask processor specific flags */

/* Symbol table index */
#define STN_UNDEF 0 /* undefined */

/* Extract symbol info - st_info */
#define ELF32_ST_BIND(x) ((x) >> 4)
#define ELF32_ST_TYPE(x) (((unsigned int)x) & 0xf)
#define ELF32_ST_INFO(b, t) (((b) << 4) + ((t)&0xf))
#define ELF32_ST_VISIBILITY(x) ((x)&0x3)

/* Symbol Binding - ELF32_ST_BIND - st_info */
#define STB_LOCAL 0   /* Local symbol */
#define STB_GLOBAL 1  /* Global symbol */
#define STB_WEAK 2    /* like global - lower precedence */
#define STB_NUM 3     /* number of symbol bindings */
#define STB_LOOS 10   /* reserved range for operating */
#define STB_HIOS 12   /* system specific symbol bindings */
#define STB_LOPROC 13 /* reserved range for processor */
#define STB_HIPROC 15 /* specific symbol bindings */

/* Symbol type - ELF32_ST_TYPE - st_info */
#define STT_NOTYPE 0  /* not specified */
#define STT_OBJECT 1  /* data object */
#define STT_FUNC 2    /* function */
#define STT_SECTION 3 /* section */
#define STT_FILE 4    /* file */
#define STT_NUM 5     /* number of symbol types */
#define STT_TLS 6     /* Thread local storage symbol */
#define STT_LOOS 10   /* reserved range for operating */
#define STT_HIOS 12   /* system specific symbol types */
#define STT_LOPROC 13 /* reserved range for processor */
#define STT_HIPROC 15 /* specific symbol types */

/* Symbol visibility - ELF32_ST_VISIBILITY - st_other */
#define STV_DEFAULT 0   /* Normal visibility rules */
#define STV_INTERNAL 1  /* Processor specific hidden class */
#define STV_HIDDEN 2    /* Symbol unavailable in other mods */
#define STV_PROTECTED 3 /* Not preemptible, not exported */

/* Extract relocation info - r_info */
#define ELF32_R_SYM(i) ((i) >> 8)
#define ELF32_R_TYPE(i) ((unsigned char)(i))
#define ELF32_R_INFO(s, t) (((s) << 8) + (unsigned char)(t))

/* Segment types - p_type */
#define PT_NULL 0            /* unused */
#define PT_LOAD 1            /* loadable segment */
#define PT_DYNAMIC 2         /* dynamic linking section */
#define PT_INTERP 3          /* the RTLD */
#define PT_NOTE 4            /* auxiliary information */
#define PT_SHLIB 5           /* reserved - purpose undefined */
#define PT_PHDR 6            /* program header */
#define PT_TLS 7             /* Thread local storage template */
#define PT_NUM 8             /* Number of segment types */
#define PT_LOOS 0x60000000   /* reserved range for operating */
#define PT_HIOS 0x6fffffff   /* system specific segment types */
#define PT_LOPROC 0x70000000 /* reserved range for processor */
#define PT_HIPROC 0x7fffffff /* specific segment types */

/* Segment flags - p_flags */
#define PF_X 0x1               /* Executable */
#define PF_W 0x2               /* Writable */
#define PF_R 0x4               /* Readable */
#define PF_MASKOS 0x0ff00000   /* OS specific segment flags */
#define PF_MASKPROC 0xf0000000 /* reserved bits for processor */
/* specific segment flags */

#define ELF64_R_SYM(i) ((i) >> 32)
#define ELF64_R_TYPE(i) ((i)&0xffffffff)

/* Dynamic Array Tags - d_tag */
#define DT_NULL 0             /* marks end of _DYNAMIC array */
#define DT_NEEDED 1           /* string table offset of needed lib */
#define DT_PLTRELSZ 2         /* size of relocation entries in PLT */
#define DT_PLTGOT 3           /* address PLT/GOT */
#define DT_HASH 4             /* address of symbol hash table */
#define DT_STRTAB 5           /* address of string table */
#define DT_SYMTAB 6           /* address of symbol table */
#define DT_RELA 7             /* address of relocation table */
#define DT_RELASZ 8           /* size of relocation table */
#define DT_RELAENT 9          /* size of relocation entry */
#define DT_STRSZ 10           /* size of string table */
#define DT_SYMENT 11          /* size of symbol table entry */
#define DT_INIT 12            /* address of initialization func */
#define DT_FINI 13            /* address of termination function */
#define DT_SONAME 14          /* string table offset of shared obj */
#define DT_RPATH 15           /* string table offset of library \
search path */
#define DT_SYMBOLIC 16        /* start sym search in shared obj */
#define DT_REL 17             /* address of rel. tbl. w addends */
#define DT_RELSZ 18           /* size of DT_REL relocation table */
#define DT_RELENT 19          /* size of DT_REL relocation entry */
#define DT_PLTREL 20          /* PLT referenced relocation entry */
#define DT_DEBUG 21           /* bugger */
#define DT_TEXTREL 22         /* Allow rel. mod. to unwritable seg */
#define DT_JMPREL 23          /* add. of PLT's relocation entries */
#define DT_BIND_NOW 24        /* Process relocations of object */
#define DT_INIT_ARRAY 25      /* Array with addresses of init fct */
#define DT_FINI_ARRAY 26      /* Array with addresses of fini fct */
#define DT_INIT_ARRAYSZ 27    /* Size in bytes of DT_INIT_ARRAY */
#define DT_FINI_ARRAYSZ 28    /* Size in bytes of DT_FINI_ARRAY */
#define DT_RUNPATH 29         /* Library search path */
#define DT_FLAGS 30           /* Flags for the object being loaded */
#define DT_ENCODING 32        /* Start of encoded range */
#define DT_PREINIT_ARRAY 32   /* Array with addresses of preinit fct*/
#define DT_PREINIT_ARRAYSZ 33 /* size in bytes of DT_PREINIT_ARRAY */
#define DT_NUM 34             /* Number used */
#define DT_LOOS 0x60000000    /* reserved range for OS */
#define DT_HIOS 0x6fffffff    /* specific dynamic array tags */
#define DT_LOPROC 0x70000000  /* reserved range for processor */
#define DT_HIPROC 0x7fffffff  /* specific dynamic array tags */

/* Dynamic Tag Flags - d_un.d_val */
#define DF_ORIGIN 0x01     /* Object may use DF_ORIGIN */
#define DF_SYMBOLIC 0x02   /* Symbol resolutions starts here */
#define DF_TEXTREL 0x04    /* Object contains text relocations */
#define DF_BIND_NOW 0x08   /* No lazy binding for this object */
#define DF_STATIC_TLS 0x10 /* Static thread local storage */

/* Standard ELF hashing function */
unsigned long elf_hash(const unsigned char *name);

#define ELF_TARG_VER 1 /* The ver for which this code is intended */

/* ELF register definitions */
#define R_386_NONE 0
#define R_386_32 1
#define R_386_PC32 2
#define R_386_GOT32 3
#define R_386_PLT32 4
#define R_386_COPY 5
#define R_386_GLOB_DAT 6
#define R_386_JMP_SLOT 7
#define R_386_RELATIVE 8
#define R_386_GOTOFF 9
#define R_386_GOTPC 10
#define R_386_NUM 11

/* x86-64 relocation types */
#define R_X86_64_NONE 0      /* No reloc */
#define R_X86_64_64 1        /* Direct 64 bit  */
#define R_X86_64_PC32 2      /* PC relative 32 bit signed */
#define R_X86_64_GOT32 3     /* 32 bit GOT entry */
#define R_X86_64_PLT32 4     /* 32 bit PLT address */
#define R_X86_64_COPY 5      /* Copy symbol at runtime */
#define R_X86_64_GLOB_DAT 6  /* Create GOT entry */
#define R_X86_64_JUMP_SLOT 7 /* Create PLT entry */
#define R_X86_64_RELATIVE 8  /* Adjust by program base */
/* 32 bit signed pc relative offset to GOT */
#define R_X86_64_GOTPCREL 9
#define R_X86_64_32 10   /* Direct 32 bit zero extended */
#define R_X86_64_32S 11  /* Direct 32 bit sign extended */
#define R_X86_64_16 12   /* Direct 16 bit zero extended */
#define R_X86_64_PC16 13 /* 16 bit sign extended pc relative */
#define R_X86_64_8 14    /* Direct 8 bit sign extended  */
#define R_X86_64_PC8 15  /* 8 bit sign extended pc relative */

#define R_X86_64_NUM 16

/*
 * XXX - PowerPC defines really don't belong in here,
 * but we'll put them in for simplicity.
 */

/* Values for Elf32/64_Ehdr.e_flags */
#define EF_PPC_EMB 0x80000000 /* PowerPC embedded flag */

#define EF_PPC64_ELFV1_ABI 0x00000001
#define EF_PPC64_ELFV2_ABI 0x00000002

/* Cygnus local bits below */
#define EF_PPC_RELOCATABLE 0x00010000     /* PowerPC -mrelocatable flag*/
#define EF_PPC_RELOCATABLE_LIB 0x00008000 /* PowerPC -mrelocatable-lib \
flag */

/* PowerPC relocations defined by the ABIs */
#define R_PPC_NONE 0
#define R_PPC_ADDR32 1    /* 32bit absolute address */
#define R_PPC_ADDR24 2    /* 26bit address, 2 bits ignored */
#define R_PPC_ADDR16 3    /* 16bit absolute address */
#define R_PPC_ADDR16_LO 4 /* lower 16bit of absolute address */
#define R_PPC_ADDR16_HI 5 /* high 16bit of absolute address */
#define R_PPC_ADDR16_HA 6 /* adjusted high 16bit */
#define R_PPC_ADDR14 7    /* 16bit address, 2 bits ignored */
#define R_PPC_ADDR14_BRTAKEN 8
#define R_PPC_ADDR14_BRNTAKEN 9
#define R_PPC_REL24 10 /* PC relative 26 bit */
#define R_PPC_REL14 11 /* PC relative 16 bit */
#define R_PPC_REL14_BRTAKEN 12
#define R_PPC_REL14_BRNTAKEN 13
#define R_PPC_GOT16 14
#define R_PPC_GOT16_LO 15
#define R_PPC_GOT16_HI 16
#define R_PPC_GOT16_HA 17
#define R_PPC_PLTREL24 18
#define R_PPC_COPY 19
#define R_PPC_GLOB_DAT 20
#define R_PPC_JMP_SLOT 21
#define R_PPC_RELATIVE 22
#define R_PPC_LOCAL24PC 23
#define R_PPC_UADDR32 24
#define R_PPC_UADDR16 25
#define R_PPC_REL32 26
#define R_PPC_PLT32 27
#define R_PPC_PLTREL32 28
#define R_PPC_PLT16_LO 29
#define R_PPC_PLT16_HI 30
#define R_PPC_PLT16_HA 31
#define R_PPC_SDAREL16 32
#define R_PPC_SECTOFF 33
#define R_PPC_SECTOFF_LO 34
#define R_PPC_SECTOFF_HI 35
#define R_PPC_SECTOFF_HA 36
/* Keep this the last entry */
#define R_PPC_NUM 37

/*
 * The remaining relocs are from the Embedded ELF ABI, and are not
 * in the SVR4 ELF ABI.
 */
#define R_PPC_EMB_NADDR32 101
#define R_PPC_EMB_NADDR16 102
#define R_PPC_EMB_NADDR16_LO 103
#define R_PPC_EMB_NADDR16_HI 104
#define R_PPC_EMB_NADDR16_HA 105
#define R_PPC_EMB_SDAI16 106
#define R_PPC_EMB_SDA2I16 107
#define R_PPC_EMB_SDA2REL 108
#define R_PPC_EMB_SDA21 109 /* 16 bit offset in SDA */
#define R_PPC_EMB_MRKREF 110
#define R_PPC_EMB_RELSEC16 111
#define R_PPC_EMB_RELST_LO 112
#define R_PPC_EMB_RELST_HI 113
#define R_PPC_EMB_RELST_HA 114
#define R_PPC_EMB_BIT_FLD 115
#define R_PPC_EMB_RELSDA 116 /* 16 bit relative offset in SDA */

/* Diab tool relocations */
#define R_PPC_DIAB_SDA21_LO 180  /* like EMB_SDA21, but lower 16 bit */
#define R_PPC_DIAB_SDA21_HI 181  /* like EMB_SDA21, but high 16 bit */
#define R_PPC_DIAB_SDA21_HA 182  /* like EMB_SDA21, adjusted high 16 */
#define R_PPC_DIAB_RELSDA_LO 183 /* like EMB_RELSDA, but lower 16 bit */
#define R_PPC_DIAB_RELSDA_HI 184 /* like EMB_RELSDA, but high 16 bit */
#define R_PPC_DIAB_RELSDA_HA 185 /* like EMB_RELSDA, adjusted high 16 */

/*
 * This is a phony reloc to handle any old fashioned TOC16 references
 * that may still be in object files.
 */
#define R_PPC_TOC16 255

/* ARM relocs */
#define R_ARM_NONE 0      /* No reloc */
#define R_ARM_RELATIVE 23 /* Adjust by program base */

/* AArch64 relocs */
#define R_AARCH64_NONE 0        /* No relocation */
#define R_AARCH64_RELATIVE 1027 /* Adjust by program base */

/* RISC-V relocations */
#define R_RISCV_32 1
#define R_RISCV_64 2
#define R_RISCV_RELATIVE 3

/*
 * A very simple ELF64 loader, assumes the image is valid, returns the
 * entry point address.
 *
 * Note if U-Boot is 32-bit, the loader assumes the to segment's
 * physical address and size is within the lower 32-bit address space.
 */
static unsigned long ElfLoadElf64ImagePhdr(unsigned long addr)
{
    Elf64_Ehdr *ehdr; /* Elf header structure pointer */
    Elf64_Phdr *phdr; /* Program header structure pointer */
    int i;

    ehdr = (Elf64_Ehdr *)addr;
    phdr = (Elf64_Phdr *)(addr + (unsigned long)ehdr->e_phoff);

    /* Load each program header */
    for (i = 0; i < ehdr->e_phnum; ++i)
    {
        void *dst = (void *)(unsigned long)phdr->p_paddr;
        void *src = (void *)addr + phdr->p_offset;

        f_printk("Loading phdr %i to 0x%p (%lu bytes)",
                      i, dst, (unsigned long)phdr->p_filesz);
        if (phdr->p_filesz)
        {
            memcpy(dst, src, phdr->p_filesz);
        }

        if (phdr->p_filesz != phdr->p_memsz)
        {
            memset(dst + phdr->p_filesz, 0x00,
                   phdr->p_memsz - phdr->p_filesz);
        }

        FCacheDCacheFlushRange((uintptr)dst, phdr->p_memsz);
        ++phdr;
    }

    if (ehdr->e_machine == EM_PPC64 && (ehdr->e_flags & EF_PPC64_ELFV1_ABI))
    {
        /*
         * For the 64-bit PowerPC ELF V1 ABI, e_entry is a function
         * descriptor pointer with the first double word being the
         * address of the entry point of the function.
         */
        uintptr_t addr = ehdr->e_entry;

        return *(Elf64_Addr *)addr;
    }

    return ehdr->e_entry;
}

static unsigned long ElfLoadElf64ImageShdr(unsigned long addr)
{
    Elf64_Ehdr *ehdr;          /* Elf header structure pointer */
    Elf64_Shdr *shdr;          /* Section header structure pointer */
    unsigned char *strtab = 0; /* String table pointer */
    unsigned char *image;      /* Binary image pointer */
    int i;                     /* Loop counter */

    ehdr = (Elf64_Ehdr *)addr;

    /* Find the section header string table for output info */
    shdr = (Elf64_Shdr *)(addr + (unsigned long)ehdr->e_shoff +
                          (ehdr->e_shstrndx * sizeof(Elf64_Shdr)));

    if (shdr->sh_type == SHT_STRTAB)
    {
        strtab = (unsigned char *)(addr + (unsigned long)shdr->sh_offset);
    }

    /* Load each appropriate section */
    for (i = 0; i < ehdr->e_shnum; ++i)
    {
        shdr = (Elf64_Shdr *)(addr + (unsigned long)ehdr->e_shoff +
                              (i * sizeof(Elf64_Shdr)));

        if (!(shdr->sh_flags & SHF_ALLOC) ||
            shdr->sh_addr == 0 || shdr->sh_size == 0)
        {
            continue;
        }

        if (strtab)
        {
            f_printk("%sing %s @ 0x%08lx (%ld bytes)",
                          (shdr->sh_type == SHT_NOBITS) ? "Clear" : "Load",
                          &strtab[shdr->sh_name],
                          (unsigned long)shdr->sh_addr,
                          (long)shdr->sh_size);
        }

        if (shdr->sh_type == SHT_NOBITS)
        {
            memset((void *)(uintptr)shdr->sh_addr, 0,
                   shdr->sh_size);
        }
        else
        {
            image = (unsigned char *)addr + (unsigned long)shdr->sh_offset;
            memcpy((void *)(uintptr)shdr->sh_addr,
                   (const void *)image, shdr->sh_size);
        }
        FCacheDCacheFlushRange((uintptr)shdr->sh_addr, shdr->sh_size);
    }

    if (ehdr->e_machine == EM_PPC64 && (ehdr->e_flags &
                                        EF_PPC64_ELFV1_ABI))
    {
        /*
         * For the 64-bit PowerPC ELF V1 ABI, e_entry is a function
         * descriptor pointer with the first double word being the
         * address of the entry point of the function.
         */
        uintptr addr = ehdr->e_entry;

        return *(Elf64_Addr *)addr;
    }

    return ehdr->e_entry;
}

unsigned long ElfLoadElfImagePhdr(unsigned long addr)
{
    Elf32_Ehdr *ehdr; /* Elf header structure pointer */
    Elf32_Phdr *phdr; /* Program header structure pointer */
    int i;

    ehdr = (Elf32_Ehdr *)addr;
    if (ehdr->e_ident[EI_CLASS] == ELFCLASS64)
    {
        return ElfLoadElf64ImagePhdr(addr);
    }

    phdr = (Elf32_Phdr *)(addr + ehdr->e_phoff);

    /* Load each program header */
    for (i = 0; i < ehdr->e_phnum; ++i)
    {
        void *dst = (void *)(uintptr)phdr->p_paddr;
        void *src = (void *)addr + phdr->p_offset;

        f_printk("Loading phdr %i to 0x%p (%i bytes)",
                      i, dst, phdr->p_filesz);
        if (phdr->p_filesz)
        {
            memcpy(dst, src, phdr->p_filesz);
        }
        if (phdr->p_filesz != phdr->p_memsz)
        {
            memset(dst + phdr->p_filesz, 0x00,
                   phdr->p_memsz - phdr->p_filesz);
        }

        FCacheDCacheFlushRange((uintptr)dst, phdr->p_memsz);
        ++phdr;
    }

    return ehdr->e_entry;
}

unsigned long ElfLoadElfImageShdr(unsigned long addr)
{
    Elf32_Ehdr *ehdr;          /* Elf header structure pointer */
    Elf32_Shdr *shdr;          /* Section header structure pointer */
    unsigned char *strtab = 0; /* String table pointer */
    unsigned char *image;      /* Binary image pointer */
    int i;                     /* Loop counter */

    ehdr = (Elf32_Ehdr *)addr;
    if (ehdr->e_ident[EI_CLASS] == ELFCLASS64)
    {
        return ElfLoadElf64ImageShdr(addr);
    }

    /* Find the section header string table for output info */
    shdr = (Elf32_Shdr *)(addr + ehdr->e_shoff +
                          (ehdr->e_shstrndx * sizeof(Elf32_Shdr)));

    if (shdr->sh_type == SHT_STRTAB)
    {
        strtab = (unsigned char *)(addr + shdr->sh_offset);
    }

    /* Load each appropriate section */
    for (i = 0; i < ehdr->e_shnum; ++i)
    {
        shdr = (Elf32_Shdr *)(addr + ehdr->e_shoff +
                              (i * sizeof(Elf32_Shdr)));

        if (!(shdr->sh_flags & SHF_ALLOC) ||
            shdr->sh_addr == 0 || shdr->sh_size == 0)
        {
            continue;
        }

        if (strtab)
        {
            f_printk("%sing %s @ 0x%08lx (%ld bytes)",
                          (shdr->sh_type == SHT_NOBITS) ? "Clear" : "Load",
                          &strtab[shdr->sh_name],
                          (unsigned long)shdr->sh_addr,
                          (long)shdr->sh_size);
        }

        if (shdr->sh_type == SHT_NOBITS)
        {
            memset((void *)(uintptr)shdr->sh_addr, 0,
                   shdr->sh_size);
        }
        else
        {
            image = (unsigned char *)addr + shdr->sh_offset;
            memcpy((void *)(uintptr)shdr->sh_addr,
                   (const void *)image, shdr->sh_size);
        }

        FCacheDCacheFlushRange((uintptr)shdr->sh_addr, shdr->sh_size);
    }

    return ehdr->e_entry;
}

/*
 * Determine if a valid ELF image exists at the given memory location.
 * First look at the ELF header magic field, then make sure that it is
 * executable.
 */
int ElfIsImageValid(unsigned long addr)
{
    Elf32_Ehdr *ehdr; /* Elf header structure pointer */

    ehdr = (Elf32_Ehdr *)addr;

    if (!IS_ELF(*ehdr))
    {
        f_printk("## No elf image at address 0x%08lx.", addr);
        return 0;
    }

    if (ehdr->e_type != ET_EXEC)
    {
        f_printk("## Not a 32-bit elf image at address 0x%08lx.", addr);
        return 0;
    }

    return 1;
}

/* Allow ports to override the default behavior */
unsigned long ElfExecBootElf(unsigned long (*entry)(int, char *const[]),
                             int argc, char *const argv[])
{
    unsigned long ret;

    /*
     * pass address parameter as argv[0] (aka command name),
     * and all remaining args
     */
    ret = entry(argc, argv);

    return ret;
}