/*
 *  Emulation of Linux signals
 *
 *  Copyright (c) 2003 Fabrice Bellard
 *  Copyright(c) 2019-2021 Qualcomm Innovation Center, Inc. All Rights Reserved.
 *
 *  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 2 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, see <http://www.gnu.org/licenses/>.
 */
#include "qemu/osdep.h"
#include "qemu.h"
#include "user-internals.h"
#include "signal-common.h"
#include "linux-user/trace.h"

struct target_user_regs_struct {
    abi_ulong gpr[32];
    abi_ulong sa0;
    abi_ulong lc0;
    abi_ulong sa1;
    abi_ulong lc1;
    abi_ulong m0;
    abi_ulong m1;
    abi_ulong usr;
    abi_ulong p3_0;
    abi_ulong gp;
    abi_ulong ugp;
    abi_ulong pc;
    abi_ulong cause;
    abi_ulong badva;
    abi_ulong cs0;
    abi_ulong cs1;
    abi_ulong pad1; /* pad to 48 words */
};

QEMU_BUILD_BUG_ON(sizeof(struct target_user_regs_struct) != 48 * 4);

struct target_sigcontext {
    struct target_user_regs_struct sc_regs;
} QEMU_ALIGNED(8);

struct target_ucontext {
    unsigned long uc_flags;
    target_ulong uc_link; /* target pointer */
    target_stack_t uc_stack;
    struct target_sigcontext uc_mcontext;
    target_sigset_t uc_sigmask;
};

struct target_rt_sigframe {
    uint32_t tramp[2];
    struct target_siginfo info;
    struct target_ucontext uc;
};

static abi_ulong get_sigframe(struct target_sigaction *ka,
                              CPUHexagonState *regs, size_t framesize)
{
    abi_ulong sp = get_sp_from_cpustate(regs);

    /* This is the X/Open sanctioned signal stack switching.  */
    sp = target_sigsp(sp, ka) - framesize;

    sp = QEMU_ALIGN_DOWN(sp, 8);

    return sp;
}

static void setup_sigcontext(struct target_sigcontext *sc, CPUHexagonState *env)
{
    abi_ulong preds = 0;

    for (int i = 0; i < 32; i++) {
        __put_user(env->gpr[HEX_REG_R00 + i], &sc->sc_regs.gpr[i]);
    }
    __put_user(env->gpr[HEX_REG_SA0], &sc->sc_regs.sa0);
    __put_user(env->gpr[HEX_REG_LC0], &sc->sc_regs.lc0);
    __put_user(env->gpr[HEX_REG_SA1], &sc->sc_regs.sa1);
    __put_user(env->gpr[HEX_REG_LC1], &sc->sc_regs.lc1);
    __put_user(env->gpr[HEX_REG_M0], &sc->sc_regs.m0);
    __put_user(env->gpr[HEX_REG_M1], &sc->sc_regs.m1);
    __put_user(env->gpr[HEX_REG_USR], &sc->sc_regs.usr);
    __put_user(env->gpr[HEX_REG_GP], &sc->sc_regs.gp);
    __put_user(env->gpr[HEX_REG_UGP], &sc->sc_regs.ugp);
    __put_user(env->gpr[HEX_REG_PC], &sc->sc_regs.pc);

    /* Consolidate predicates into p3_0 */
    for (int i = 0; i < NUM_PREGS; i++) {
        preds |= (env->pred[i] & 0xff) << (i * 8);
    }
    __put_user(preds, &sc->sc_regs.p3_0);

    /* Set cause and badva to 0 - these are set by kernel on exceptions */
    __put_user(0, &sc->sc_regs.cause);
    __put_user(0, &sc->sc_regs.badva);

    __put_user(env->gpr[HEX_REG_CS0], &sc->sc_regs.cs0);
    __put_user(env->gpr[HEX_REG_CS1], &sc->sc_regs.cs1);
}

static void setup_ucontext(struct target_ucontext *uc,
                           CPUHexagonState *env, target_sigset_t *set)
{
    __put_user(0,    &(uc->uc_flags));
    __put_user(0,    &(uc->uc_link));

    target_save_altstack(&uc->uc_stack, env);

    int i;
    for (i = 0; i < TARGET_NSIG_WORDS; i++) {
        __put_user(set->sig[i], &(uc->uc_sigmask.sig[i]));
    }

    setup_sigcontext(&uc->uc_mcontext, env);
}

static inline void install_sigtramp(uint32_t *tramp)
{
    __put_user(0x7800d166, tramp + 0); /*  { r6=#__NR_rt_sigreturn } */
    __put_user(0x5400c004, tramp + 1); /*  { trap0(#1) } */
}

void setup_rt_frame(int sig, struct target_sigaction *ka,
                    target_siginfo_t *info,
                    target_sigset_t *set, CPUHexagonState *env)
{
    abi_ulong frame_addr;
    struct target_rt_sigframe *frame;

    frame_addr = get_sigframe(ka, env, sizeof(*frame));
    trace_user_setup_rt_frame(env, frame_addr);

    if (!lock_user_struct(VERIFY_WRITE, frame, frame_addr, 0)) {
        goto badframe;
    }

    setup_ucontext(&frame->uc, env, set);
    frame->info = *info;
    /*
     * The on-stack signal trampoline is no longer executed;
     * however, the libgcc signal frame unwinding code checks
     * for the presence of these two numeric magic values.
     */
    install_sigtramp(frame->tramp);

    env->gpr[HEX_REG_PC] = ka->_sa_handler;
    env->gpr[HEX_REG_SP] = frame_addr;
    env->gpr[HEX_REG_R00] = sig;
    env->gpr[HEX_REG_R01] =
        frame_addr + offsetof(struct target_rt_sigframe, info);
    env->gpr[HEX_REG_R02] =
        frame_addr + offsetof(struct target_rt_sigframe, uc);
    env->gpr[HEX_REG_LR] = default_rt_sigreturn;

    return;

badframe:
    unlock_user_struct(frame, frame_addr, 1);
    if (sig == TARGET_SIGSEGV) {
        ka->_sa_handler = TARGET_SIG_DFL;
    }
    force_sig(TARGET_SIGSEGV);
}

static void restore_sigcontext(CPUHexagonState *env,
                               struct target_sigcontext *sc)
{
    abi_ulong preds;

    for (int i = 0; i < 32; i++) {
        __get_user(env->gpr[HEX_REG_R00 + i], &sc->sc_regs.gpr[i]);
    }
    __get_user(env->gpr[HEX_REG_SA0], &sc->sc_regs.sa0);
    __get_user(env->gpr[HEX_REG_LC0], &sc->sc_regs.lc0);
    __get_user(env->gpr[HEX_REG_SA1], &sc->sc_regs.sa1);
    __get_user(env->gpr[HEX_REG_LC1], &sc->sc_regs.lc1);
    __get_user(env->gpr[HEX_REG_M0], &sc->sc_regs.m0);
    __get_user(env->gpr[HEX_REG_M1], &sc->sc_regs.m1);
    __get_user(env->gpr[HEX_REG_USR], &sc->sc_regs.usr);
    __get_user(env->gpr[HEX_REG_GP], &sc->sc_regs.gp);
    __get_user(env->gpr[HEX_REG_UGP], &sc->sc_regs.ugp);
    __get_user(env->gpr[HEX_REG_PC], &sc->sc_regs.pc);

    /* Restore predicates from p3_0 */
    __get_user(preds, &sc->sc_regs.p3_0);
    for (int i = 0; i < NUM_PREGS; i++) {
        env->pred[i] = (preds >> (i * 8)) & 0xff;
    }

    __get_user(env->gpr[HEX_REG_CS0], &sc->sc_regs.cs0);
    __get_user(env->gpr[HEX_REG_CS1], &sc->sc_regs.cs1);
}

static void restore_ucontext(CPUHexagonState *env, struct target_ucontext *uc)
{
    sigset_t blocked;
    target_sigset_t target_set;
    int i;

    target_sigemptyset(&target_set);
    for (i = 0; i < TARGET_NSIG_WORDS; i++) {
        __get_user(target_set.sig[i], &(uc->uc_sigmask.sig[i]));
    }

    target_to_host_sigset_internal(&blocked, &target_set);
    set_sigmask(&blocked);

    restore_sigcontext(env, &uc->uc_mcontext);
}

long do_rt_sigreturn(CPUHexagonState *env)
{
    struct target_rt_sigframe *frame;
    abi_ulong frame_addr;

    frame_addr = env->gpr[HEX_REG_SP];
    trace_user_do_sigreturn(env, frame_addr);
    if (!lock_user_struct(VERIFY_READ, frame, frame_addr, 1)) {
        goto badframe;
    }

    restore_ucontext(env, &frame->uc);
    target_restore_altstack(&frame->uc.uc_stack, env);

    unlock_user_struct(frame, frame_addr, 0);
    return -QEMU_ESIGRETURN;

badframe:
    unlock_user_struct(frame, frame_addr, 0);
    force_sig(TARGET_SIGSEGV);
    return 0;
}

void setup_sigtramp(abi_ulong sigtramp_page)
{
    uint32_t *tramp = lock_user(VERIFY_WRITE, sigtramp_page, 4 * 2, 0);
    assert(tramp != NULL);

    default_rt_sigreturn = sigtramp_page;
    install_sigtramp(tramp);

    unlock_user(tramp, sigtramp_page, 4 * 2);
}