/*      $NetBSD: kobj_machdep.c,v 1.8 2023/04/28 07:33:56 skrll Exp $   */

/*-
 * Copyright (c) 2001 Jake Burkholder.
 * Copyright (c) 2000 Eduardo Horvath.
 * Copyright (c) 1999, 2008 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Paul Kranenburg.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: kobj_machdep.c,v 1.8 2023/04/28 07:33:56 skrll Exp $");

#define ELFSIZE         ARCH_ELFSIZE

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kobj.h>
#include <sys/exec.h>
#include <sys/exec_elf.h>

/*
 * The following table holds for each relocation type:
 *      - the width in bits of the memory location the relocation
 *        applies to (not currently used)
 *      - the number of bits the relocation value must be shifted to the
 *        right (i.e. discard least significant bits) to fit into
 *        the appropriate field in the instruction word.
 *      - flags indicating whether
 *              * the relocation involves a symbol
 *              * the relocation is relative to the current position
 *              * the relocation is for a GOT entry
 *              * the relocation is relative to the load address
 *
 */
#define _RF_S           0x80000000              /* Resolve symbol */
#define _RF_A           0x40000000              /* Use addend */
#define _RF_P           0x20000000              /* Location relative */
#define _RF_G           0x10000000              /* GOT offset */
#define _RF_B           0x08000000              /* Load address relative */
#define _RF_U           0x04000000              /* Unaligned */
#define _RF_SZ(s)       (((s) & 0xff) << 8)     /* memory target size */
#define _RF_RS(s)       ( (s) & 0xff)           /* right shift */
static const int reloc_target_flags[] = {
        0,                                                      /* NONE */
        _RF_S|_RF_A|            _RF_SZ(8)  | _RF_RS(0),         /* RELOC_8 */
        _RF_S|_RF_A|            _RF_SZ(16) | _RF_RS(0),         /* RELOC_16 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* RELOC_32 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(8)  | _RF_RS(0),         /* DISP_8 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(16) | _RF_RS(0),         /* DISP_16 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(0),         /* DISP_32 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(2),         /* WDISP_30 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(2),         /* WDISP_22 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(10),        /* HI22 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* 22 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* 13 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* LO10 */
        _RF_G|                  _RF_SZ(32) | _RF_RS(0),         /* GOT10 */
        _RF_G|                  _RF_SZ(32) | _RF_RS(0),         /* GOT13 */
        _RF_G|                  _RF_SZ(32) | _RF_RS(10),        /* GOT22 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(0),         /* PC10 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(10),        /* PC22 */
              _RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(2),         /* WPLT30 */
                                _RF_SZ(32) | _RF_RS(0),         /* COPY */
        _RF_S|_RF_A|            _RF_SZ(64) | _RF_RS(0),         /* GLOB_DAT */
                                _RF_SZ(32) | _RF_RS(0),         /* JMP_SLOT */
              _RF_A|    _RF_B|  _RF_SZ(64) | _RF_RS(0),         /* RELATIVE */
        _RF_S|_RF_A|    _RF_U|  _RF_SZ(32) | _RF_RS(0),         /* UA_32 */

              _RF_A|            _RF_SZ(32) | _RF_RS(0),         /* PLT32 */
              _RF_A|            _RF_SZ(32) | _RF_RS(10),        /* HIPLT22 */
              _RF_A|            _RF_SZ(32) | _RF_RS(0),         /* LOPLT10 */
              _RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(0),         /* PCPLT32 */
              _RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(10),        /* PCPLT22 */
              _RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(0),         /* PCPLT10 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* 10 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* 11 */
        _RF_S|_RF_A|            _RF_SZ(64) | _RF_RS(0),         /* 64 */
        _RF_S|_RF_A|/*extra*/   _RF_SZ(32) | _RF_RS(0),         /* OLO10 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(42),        /* HH22 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(32),        /* HM10 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(10),        /* LM22 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(42),        /* PC_HH22 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(32),        /* PC_HM10 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(10),        /* PC_LM22 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(2),         /* WDISP16 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(32) | _RF_RS(2),         /* WDISP19 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* GLOB_JMP */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* 7 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* 5 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* 6 */
        _RF_S|_RF_A|_RF_P|      _RF_SZ(64) | _RF_RS(0),         /* DISP64 */
              _RF_A|            _RF_SZ(64) | _RF_RS(0),         /* PLT64 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(10),        /* HIX22 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* LOX10 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(22),        /* H44 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(12),        /* M44 */
        _RF_S|_RF_A|            _RF_SZ(32) | _RF_RS(0),         /* L44 */
        _RF_S|_RF_A|            _RF_SZ(64) | _RF_RS(0),         /* REGISTER */
        _RF_S|_RF_A|    _RF_U|  _RF_SZ(64) | _RF_RS(0),         /* UA64 */
        _RF_S|_RF_A|    _RF_U|  _RF_SZ(16) | _RF_RS(0),         /* UA16 */
};

#if 0
static const char *reloc_names[] = {
        "NONE", "RELOC_8", "RELOC_16", "RELOC_32", "DISP_8",
        "DISP_16", "DISP_32", "WDISP_30", "WDISP_22", "HI22",
        "22", "13", "LO10", "GOT10", "GOT13",
        "GOT22", "PC10", "PC22", "WPLT30", "COPY",
        "GLOB_DAT", "JMP_SLOT", "RELATIVE", "UA_32", "PLT32",
        "HIPLT22", "LOPLT10", "LOPLT10", "PCPLT22", "PCPLT32",
        "10", "11", "64", "OLO10", "HH22",
        "HM10", "LM22", "PC_HH22", "PC_HM10", "PC_LM22", 
        "WDISP16", "WDISP19", "GLOB_JMP", "7", "5", "6",
        "DISP64", "PLT64", "HIX22", "LOX10", "H44", "M44", 
        "L44", "REGISTER", "UA64", "UA16"
};
#endif

#define RELOC_RESOLVE_SYMBOL(t)         ((reloc_target_flags[t] & _RF_S) != 0)
#define RELOC_PC_RELATIVE(t)            ((reloc_target_flags[t] & _RF_P) != 0)
#define RELOC_BASE_RELATIVE(t)          ((reloc_target_flags[t] & _RF_B) != 0)
#define RELOC_UNALIGNED(t)              ((reloc_target_flags[t] & _RF_U) != 0)
#define RELOC_USE_ADDEND(t)             ((reloc_target_flags[t] & _RF_A) != 0)
#define RELOC_TARGET_SIZE(t)            ((reloc_target_flags[t] >> 8) & 0xff)
#define RELOC_VALUE_RIGHTSHIFT(t)       (reloc_target_flags[t] & 0xff)

static const long reloc_target_bitmask[] = {
#define _BM(x)  (~(-(1ULL << (x))))
        0,                              /* NONE */
        _BM(8), _BM(16), _BM(32),       /* RELOC_8, _16, _32 */
        _BM(8), _BM(16), _BM(32),       /* DISP8, DISP16, DISP32 */
        _BM(30), _BM(22),               /* WDISP30, WDISP22 */
        _BM(22), _BM(22),               /* HI22, _22 */
        _BM(13), _BM(10),               /* RELOC_13, _LO10 */
        _BM(10), _BM(13), _BM(22),      /* GOT10, GOT13, GOT22 */
        _BM(10), _BM(22),               /* _PC10, _PC22 */  
        _BM(30), 0,                     /* _WPLT30, _COPY */
        _BM(32), _BM(32), _BM(32),      /* _GLOB_DAT, JMP_SLOT, _RELATIVE */
        _BM(32), _BM(32),               /* _UA32, PLT32 */
        _BM(22), _BM(10),               /* _HIPLT22, LOPLT10 */
        _BM(32), _BM(22), _BM(10),      /* _PCPLT32, _PCPLT22, _PCPLT10 */
        _BM(10), _BM(11), -1,           /* _10, _11, _64 */
        _BM(13), _BM(22),               /* _OLO10, _HH22 */
        _BM(10), _BM(22),               /* _HM10, _LM22 */
        _BM(22), _BM(10), _BM(22),      /* _PC_HH22, _PC_HM10, _PC_LM22 */
        _BM(16), _BM(19),               /* _WDISP16, _WDISP19 */
        -1,                             /* GLOB_JMP */
        _BM(7), _BM(5), _BM(6),         /* _7, _5, _6 */
        -1, -1,                         /* DISP64, PLT64 */
        _BM(22), _BM(13),               /* HIX22, LOX10 */
        _BM(22), _BM(10), _BM(12),      /* H44, M44, L44 */
        -1, -1, _BM(16),                /* REGISTER, UA64, UA16 */
#undef _BM
};
#define RELOC_VALUE_BITMASK(t)  (reloc_target_bitmask[t])

int
kobj_reloc(kobj_t ko, uintptr_t relocbase, const void *data,
           bool isrela, bool local)
{
        const Elf_Rela *rela;
        Elf_Word *where32;
        Elf_Addr *where;
        uintptr_t rtype, symidx;
        Elf_Addr value;
        Elf_Addr mask;
        Elf_Addr addr;
        vaddr_t base;
        int error;

        if (!isrela)
                return -1;

        rela = (const Elf_Rela *)data;
        where = (Elf_Addr *)(relocbase + rela->r_offset);
        where32 = (Elf_Word *)where;
        rtype = ELF64_R_TYPE(rela->r_info);
        symidx = ELF_R_SYM(rela->r_info);

        const Elf_Sym *sym = kobj_symbol(ko, symidx);

        if (!local && ELF_ST_BIND(sym->st_info) == STB_LOCAL) {
                return 0;
        }

        if (rtype == R_SPARC_NONE)
                return 0;

        if ((rtype & 0x00ff) == R_SPARC_OLO10)
                rtype = R_SPARC_OLO10;

        if (rtype == R_SPARC_RELATIVE) {
                kobj_stat(ko, &base, NULL);
                value = rela->r_addend + (Elf_Addr)base;
                where = (Elf_Addr *)((Elf_Addr)base + rela->r_offset);
                *where = value;
                return 0;
        }

        if (rtype == R_SPARC_JMP_SLOT || rtype == R_SPARC_COPY ||
            rtype >= __arraycount(reloc_target_bitmask))
                return -1;

        if (RELOC_UNALIGNED(rtype))
                return -1;

        value = rela->r_addend;

        if (RELOC_RESOLVE_SYMBOL(rtype)) {
                error = kobj_sym_lookup(ko, symidx, &addr);
                if (error)
                        return -1;
                value += addr;
        }

        if (rtype == R_SPARC_OLO10)
                value = (value & 0x3ff) + (((Elf64_Xword)rela->r_info<<32)>>40);

        if (RELOC_PC_RELATIVE(rtype))
                value -= (Elf_Addr)where;

        if (RELOC_BASE_RELATIVE(rtype))
                value += relocbase;

        mask = RELOC_VALUE_BITMASK(rtype);
        value >>= RELOC_VALUE_RIGHTSHIFT(rtype);
        value &= mask;

        if (RELOC_TARGET_SIZE(rtype) > 32) {
                *where &= ~mask;
                *where |= value;
        } else {
                *where32 &= ~mask;
                *where32 |= value;
        }

        return 0;
}

int
kobj_machdep(kobj_t ko, void *base, size_t size, bool load)
{

        return 0;
}