/* $NetBSD: cpu.c,v 1.84 2023/10/04 20:28:06 ad Exp $ */

/*-
* Copyright (c) 2007 Jared D. McNeill <[email protected]>
* All rights reserved.
*
* 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 "opt_cpu.h"
#include "opt_hz.h"

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: cpu.c,v 1.84 2023/10/04 20:28:06 ad Exp $");

#include <sys/param.h>
#include <sys/conf.h>
#include <sys/proc.h>
#include <sys/systm.h>
#include <sys/device.h>
#include <sys/reboot.h>
#include <sys/lwp.h>
#include <sys/cpu.h>
#include <sys/mbuf.h>
#include <sys/msgbuf.h>
#include <sys/kmem.h>
#include <sys/kernel.h>
#include <sys/mount.h>

#include <dev/cons.h>

#include <machine/cpu.h>
#include <machine/mainbus.h>
#include <machine/pcb.h>
#include <machine/machdep.h>
#include <machine/thunk.h>

#include <uvm/uvm_extern.h>
#include <uvm/uvm_page.h>

#if __GNUC_PREREQ__(4,4)
#define cpu_unreachable()       __builtin_unreachable()
#else
#define cpu_unreachable()       do { thunk_abort(); } while (0)
#endif

static int      cpu_match(device_t, cfdata_t, void *);
static void     cpu_attach(device_t, device_t, void *);

/* XXX */
//extern void *_lwp_getprivate(void);
//extern int _lwp_setprivate(void *);


struct cpu_info cpu_info_primary = {
       .ci_dev = 0,
       .ci_self = &cpu_info_primary,
       .ci_idepth = -1,
       .ci_curlwp = &lwp0,
};

typedef struct cpu_softc {
       device_t        sc_dev;
       struct cpu_info *sc_ci;

       ucontext_t      sc_ucp;
       uint8_t         sc_ucp_stack[PAGE_SIZE];
} cpu_softc_t;


/* statics */
static struct pcb lwp0pcb;
static void *um_msgbuf;


/* attachment */
CFATTACH_DECL_NEW(cpu, sizeof(cpu_softc_t), cpu_match, cpu_attach, NULL, NULL);

static int
cpu_match(device_t parent, cfdata_t match, void *opaque)
{
       struct thunkbus_attach_args *taa = opaque;

       if (taa->taa_type != THUNKBUS_TYPE_CPU)
               return 0;

       return 1;
}

static void
cpu_attach(device_t parent, device_t self, void *opaque)
{
       cpu_softc_t *sc = device_private(self);

       aprint_naive("\n");
       aprint_normal("\n");

       cpu_info_primary.ci_dev = self;
       sc->sc_dev = self;
       sc->sc_ci = &cpu_info_primary;

       thunk_getcontext(&sc->sc_ucp);
       sc->sc_ucp.uc_stack.ss_sp = sc->sc_ucp_stack;
       sc->sc_ucp.uc_stack.ss_size = PAGE_SIZE - sizeof(register_t);
       sc->sc_ucp.uc_flags = _UC_STACK | _UC_CPU | _UC_SIGMASK;
       thunk_sigaddset(&sc->sc_ucp.uc_sigmask, SIGALRM);
       thunk_sigaddset(&sc->sc_ucp.uc_sigmask, SIGIO);
       thunk_sigaddset(&sc->sc_ucp.uc_sigmask, SIGINT);
       thunk_sigaddset(&sc->sc_ucp.uc_sigmask, SIGTSTP);
}

void
cpu_configure(void)
{
       cpu_setmodel("virtual processor");
       if (config_rootfound("mainbus", NULL) == NULL)
               panic("configure: mainbus not configured");

       spl0();
}


/* main guts */
void
cpu_reboot(int howto, char *bootstr)
{
       extern void usermode_reboot(void);

       if (cold)
               howto |= RB_HALT;

       if ((howto & RB_NOSYNC) == 0)
               vfs_shutdown();
       else
               suspendsched();

       doshutdownhooks();
       pmf_system_shutdown(boothowto);

       if ((howto & RB_POWERDOWN) == RB_POWERDOWN)
               thunk_exit(0);

       splhigh();

       if (howto & RB_DUMP)
               thunk_abort();

       if (howto & RB_HALT) {
               printf("\n");
               printf("The operating system has halted.\n");
               printf("Please press any key to reboot.\n\n");
               cnpollc(1);
               cngetc();
               cnpollc(0);
       }

       printf("rebooting...\n");

       usermode_reboot();

       /* NOTREACHED */
       cpu_unreachable();
}

void
cpu_need_resched(struct cpu_info *ci, struct lwp *l, int flags)
{
       aston(ci);
}

void
cpu_need_proftick(struct lwp *l)
{
}

int
cpu_lwp_setprivate(lwp_t *l, void *ptr)
{
       struct pcb *pcb = lwp_getpcb(l);

       /* set both ucontexts up for TLS just in case */
       pcb->pcb_ucp.uc_mcontext._mc_tlsbase =
               (uintptr_t) ptr;
       pcb->pcb_ucp.uc_flags |= _UC_TLSBASE;

       pcb->pcb_userret_ucp.uc_mcontext._mc_tlsbase =
               (uintptr_t) ptr;
       pcb->pcb_userret_ucp.uc_flags |= _UC_TLSBASE;

       return 0;
}

static
void
cpu_switchto_atomic(lwp_t *oldlwp, lwp_t *newlwp)
{
       struct pcb *oldpcb;
       struct pcb *newpcb;
       struct cpu_info *ci;
       int s;

       oldpcb = oldlwp ? lwp_getpcb(oldlwp) : NULL;
       newpcb = lwp_getpcb(newlwp);
       ci = curcpu();

       s = splhigh();

       ci->ci_stash = oldlwp;
       if (oldpcb)
               oldpcb->pcb_errno = thunk_geterrno();

       thunk_seterrno(newpcb->pcb_errno);
       curlwp = newlwp;

       splx(s);

       if (thunk_setcontext(&newpcb->pcb_ucp))
               panic("setcontext failed");

       /* not reached */
}


lwp_t *
cpu_switchto(lwp_t *oldlwp, lwp_t *newlwp, bool returning)
{
       struct pcb *oldpcb = oldlwp ? lwp_getpcb(oldlwp) : NULL;
       struct pcb *newpcb = lwp_getpcb(newlwp);
       struct cpu_info *ci = curcpu();
       cpu_softc_t *sc = device_private(ci->ci_dev);

#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_switchto [%s,pid=%d,lid=%d] -> [%s,pid=%d,lid=%d]\n",
           oldlwp ? oldlwp->l_name : "none",
           oldlwp ? oldlwp->l_proc->p_pid : -1,
           oldlwp ? oldlwp->l_lid : -1,
           newlwp ? newlwp->l_name : "none",
           newlwp ? newlwp->l_proc->p_pid : -1,
           newlwp ? newlwp->l_lid : -1);
       if (oldpcb) {
               thunk_printf_debug("    oldpcb uc_link=%p, uc_stack.ss_sp=%p, "
                   "uc_stack.ss_size=%d, l_private %p, uc_mcontext._mc_tlsbase=%p(%s)\n",
                   oldpcb->pcb_ucp.uc_link,
                   oldpcb->pcb_ucp.uc_stack.ss_sp,
                   (int)oldpcb->pcb_ucp.uc_stack.ss_size,
                   (void *) oldlwp->l_private,
                   (void *) oldpcb->pcb_ucp.uc_mcontext._mc_tlsbase,
                   oldpcb->pcb_ucp.uc_flags & _UC_TLSBASE? "ON":"off");
       }
       if (newpcb) {
               thunk_printf_debug("    newpewcb uc_link=%p, uc_stack.ss_sp=%p, "
                   "uc_stack.ss_size=%d, l_private %p, uc_mcontext._mc_tlsbase=%p(%s)\n",
                   newpcb->pcb_ucp.uc_link,
                   newpcb->pcb_ucp.uc_stack.ss_sp,
                   (int)newpcb->pcb_ucp.uc_stack.ss_size,
                   (void *) newlwp->l_private,
                   (void *) newpcb->pcb_ucp.uc_mcontext._mc_tlsbase,
                   newpcb->pcb_ucp.uc_flags & _UC_TLSBASE? "ON":"off");
       }
#endif /* !CPU_DEBUG */

       /* create atomic switcher */
       KASSERT(newlwp);
       thunk_makecontext(&sc->sc_ucp, (void (*)(void)) cpu_switchto_atomic,
                       2, oldlwp, newlwp, NULL, NULL);
       KASSERT(sc);
       if (oldpcb) {
               thunk_swapcontext(&oldpcb->pcb_ucp, &sc->sc_ucp);
               /* returns here */
       } else {
               thunk_setcontext(&sc->sc_ucp);
               /* never returns */
       }

#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_switchto: returning %p (was %p)\n", ci->ci_stash, oldlwp);
#endif
       return ci->ci_stash;
}

void
cpu_dumpconf(void)
{
#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_dumpconf\n");
#endif
}

void
cpu_signotify(struct lwp *l)
{
}

void
cpu_getmcontext(struct lwp *l, mcontext_t *mcp, unsigned int *flags)
{
       struct pcb *pcb = lwp_getpcb(l);
       ucontext_t *ucp = &pcb->pcb_userret_ucp;

#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_getmcontext\n");
#endif
       memcpy(mcp, &ucp->uc_mcontext, sizeof(mcontext_t));

       /* report we have the CPU FPU and TLSBASE registers */
       mcp->_mc_tlsbase = (uintptr_t) l->l_private;
       *flags = _UC_CPU | _UC_FPU | _UC_TLSBASE;

       return;
}

int
cpu_mcontext_validate(struct lwp *l, const mcontext_t *mcp)
{
       /*
        * can we check here? or should that be done in the target
        * specific places?
        */
       /* XXX NO CHECKING! XXX */
#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_mcontext_validate\n");
#endif
       return 0;
}

int
cpu_setmcontext(struct lwp *l, const mcontext_t *mcp, unsigned int flags)
{
       struct pcb *pcb = lwp_getpcb(l);
       ucontext_t *ucp = &pcb->pcb_userret_ucp;

#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_setmcontext\n");
#endif
       if ((flags & _UC_CPU) != 0)
               memcpy(&ucp->uc_mcontext.__gregs, &mcp->__gregs, sizeof(__gregset_t));
       if ((flags & _UC_FPU) != 0)
               memcpy(&ucp->uc_mcontext.__fpregs, &mcp->__fpregs, sizeof(__fpregset_t));
       if ((flags & _UC_TLSBASE) != 0)
               lwp_setprivate(l, (void *) (uintptr_t) mcp->_mc_tlsbase);

#if 0
       /*
        * XXX we ignore the set and clear stack since signals are done
        * slightly differently.
        */
thunk_printf("%s: flags %x\n", __func__, flags);
       mutex_enter(l->l_proc->p_lock);
       if (flags & _UC_SETSTACK)
               l->l_sigstk.ss_flags |= SS_ONSTACK;
       if (flags & _UC_CLRSTACK)
               l->l_sigstk.ss_flags &= ~SS_ONSTACK;
       mutex_exit(l->l_proc->p_lock);
#endif

       ucp->uc_flags |= (flags & (_UC_CPU | _UC_FPU | _UC_TLSBASE));

       return 0;
}

void
cpu_idle(void)
{
       struct cpu_info *ci = curcpu();

       if (ci->ci_want_resched)
               return;

       thunk_idle();
}

void
cpu_lwp_free(struct lwp *l, int proc)
{
#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_lwp_free (dummy)\n");
#endif
}

void
cpu_lwp_free2(struct lwp *l)
{
       struct pcb *pcb = lwp_getpcb(l);

#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_lwp_free2\n");
#endif

       if (pcb == NULL)
               return;
       /* XXX nothing to do? */
}

static void
cpu_lwp_trampoline(ucontext_t *ucp, void (*func)(void *), void *arg)
{
#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_lwp_trampoline called with func %p, arg %p\n", (void *) func, arg);
#endif
       /* init lwp */
       lwp_startup(curcpu()->ci_stash, curlwp);

       /* actual jump */
       thunk_makecontext(ucp, (void (*)(void)) func, 1, arg, NULL, NULL, NULL);
       thunk_setcontext(ucp);
}

void
cpu_lwp_fork(struct lwp *l1, struct lwp *l2, void *stack, size_t stacksize,
   void (*func)(void *), void *arg)
{
       struct pcb *pcb1 = lwp_getpcb(l1);
       struct pcb *pcb2 = lwp_getpcb(l2);

#ifdef CPU_DEBUG
       thunk_printf_debug("cpu_lwp_fork [%s/%p] -> [%s/%p] stack=%p stacksize=%d\n",
           l1 ? l1->l_name : "none", l1,
           l2 ? l2->l_name : "none", l2,
           stack, (int)stacksize);
#endif
       if (stack)
               panic("%s: stack passed, can't handle\n", __func__);

       /* copy the PCB and its switchframes from parent */
       memcpy(pcb2, pcb1, sizeof(struct pcb));

       /* refresh context, XXX needed? */
       if (thunk_getcontext(&pcb2->pcb_ucp))
               panic("getcontext failed");

       /* set up for TLS */
       pcb2->pcb_ucp.uc_mcontext._mc_tlsbase = (intptr_t) l2->l_private;
       pcb2->pcb_ucp.uc_flags |= _UC_TLSBASE;

       /* recalculate the system stack top */
       pcb2->sys_stack_top = pcb2->sys_stack + TRAPSTACKSIZE;

       /* get l2 its own stack */
       pcb2->pcb_ucp.uc_stack.ss_sp = pcb2->sys_stack;
       pcb2->pcb_ucp.uc_stack.ss_size = pcb2->sys_stack_top - pcb2->sys_stack;
       pcb2->pcb_ucp.uc_link = &pcb2->pcb_userret_ucp;

       thunk_sigemptyset(&pcb2->pcb_ucp.uc_sigmask);

       thunk_makecontext(&pcb2->pcb_ucp,
           (void (*)(void)) cpu_lwp_trampoline,
           3, &pcb2->pcb_ucp, func, arg, NULL);
}

void
cpu_initclocks(void)
{
       extern timer_t clock_timerid;

       thunk_timer_start(clock_timerid, HZ);
}

void
cpu_startup(void)
{
       vaddr_t minaddr, maxaddr;
       size_t msgbufsize = 32 * 1024;

       /* get ourself a message buffer */
       um_msgbuf = kmem_zalloc(msgbufsize, KM_SLEEP);
       initmsgbuf(um_msgbuf, msgbufsize);

       /* allocate a submap for physio, 1Mb enough? */
       minaddr = 0;
       phys_map = uvm_km_suballoc(kernel_map, &minaddr, &maxaddr,
                                  1024 * 1024, 0, false, NULL);

       /* say hi! */
       banner();

       /* init lwp0 */
       memset(&lwp0pcb, 0, sizeof(lwp0pcb));
       thunk_getcontext(&lwp0pcb.pcb_ucp);
       thunk_sigemptyset(&lwp0pcb.pcb_ucp.uc_sigmask);
       lwp0pcb.pcb_ucp.uc_flags = _UC_STACK | _UC_CPU | _UC_SIGMASK;

       uvm_lwp_setuarea(&lwp0, (vaddr_t) &lwp0pcb);
       memcpy(&lwp0pcb.pcb_userret_ucp, &lwp0pcb.pcb_ucp, sizeof(ucontext_t));

       /* set stack top */
       lwp0pcb.sys_stack_top = lwp0pcb.sys_stack + TRAPSTACKSIZE;
}

void
cpu_rootconf(void)
{
       extern char *usermode_root_device;
       device_t rdev;

       if (usermode_root_device != NULL) {
               rdev = device_find_by_xname(usermode_root_device);
       } else {
               rdev = device_find_by_xname("ld0");
               if (rdev == NULL)
                       rdev = device_find_by_xname("md0");
       }

       aprint_normal("boot device: %s\n",
           rdev ? device_xname(rdev) : "<unknown>");
       booted_device = rdev;
       rootconf();
}

bool
cpu_intr_p(void)
{
       int idepth;
       long pctr;
       lwp_t *l;

       l = curlwp;
       do {
               pctr = lwp_pctr();
               idepth = l->l_cpu->ci_idepth;
       } while (__predict_false(pctr != lwp_pctr()));

       return idepth >= 0;
}