Fix a MP lock race. The MP locking state can change when lwkt_chktokens()

[dragonfly.git] / sys / kern / lwkt_thread.c

/*
 * Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
 * 
 * This code is derived from software contributed to The DragonFly Project
 * by Matthew Dillon <dillon@backplane.com>
 * 
 * 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.
 * 3. Neither the name of The DragonFly Project nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific, prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
 * COPYRIGHT HOLDERS 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.
 * 
 * $DragonFly: src/sys/kern/lwkt_thread.c,v 1.77 2005/07/19 19:08:05 dillon Exp $
 */

/*
 * Each cpu in a system has its own self-contained light weight kernel
 * thread scheduler, which means that generally speaking we only need
 * to use a critical section to avoid problems.  Foreign thread 
 * scheduling is queued via (async) IPIs.
 */

#ifdef _KERNEL

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/proc.h>
#include <sys/rtprio.h>
#include <sys/queue.h>
#include <sys/thread2.h>
#include <sys/sysctl.h>
#include <sys/kthread.h>
#include <machine/cpu.h>
#include <sys/lock.h>
#include <sys/caps.h>

#include <vm/vm.h>
#include <vm/vm_param.h>
#include <vm/vm_kern.h>
#include <vm/vm_object.h>
#include <vm/vm_page.h>
#include <vm/vm_map.h>
#include <vm/vm_pager.h>
#include <vm/vm_extern.h>
#include <vm/vm_zone.h>

#include <machine/stdarg.h>
#include <machine/ipl.h>
#include <machine/smp.h>

#else

#include <sys/stdint.h>
#include <libcaps/thread.h>
#include <sys/thread.h>
#include <sys/msgport.h>
#include <sys/errno.h>
#include <libcaps/globaldata.h>
#include <machine/cpufunc.h>
#include <sys/thread2.h>
#include <sys/msgport2.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <machine/lock.h>
#include <machine/atomic.h>
#include <machine/cpu.h>

#endif

static int untimely_switch = 0;
#ifdef  INVARIANTS
static int panic_on_cscount = 0;
#endif
static __int64_t switch_count = 0;
static __int64_t preempt_hit = 0;
static __int64_t preempt_miss = 0;
static __int64_t preempt_weird = 0;
static __int64_t token_contention_count = 0;
static __int64_t mplock_contention_count = 0;

#ifdef _KERNEL

SYSCTL_INT(_lwkt, OID_AUTO, untimely_switch, CTLFLAG_RW, &untimely_switch, 0, "");
#ifdef  INVARIANTS
SYSCTL_INT(_lwkt, OID_AUTO, panic_on_cscount, CTLFLAG_RW, &panic_on_cscount, 0, "");
#endif
SYSCTL_QUAD(_lwkt, OID_AUTO, switch_count, CTLFLAG_RW, &switch_count, 0, "");
SYSCTL_QUAD(_lwkt, OID_AUTO, preempt_hit, CTLFLAG_RW, &preempt_hit, 0, "");
SYSCTL_QUAD(_lwkt, OID_AUTO, preempt_miss, CTLFLAG_RW, &preempt_miss, 0, "");
SYSCTL_QUAD(_lwkt, OID_AUTO, preempt_weird, CTLFLAG_RW, &preempt_weird, 0, "");
#ifdef  INVARIANTS
SYSCTL_QUAD(_lwkt, OID_AUTO, token_contention_count, CTLFLAG_RW,
        &token_contention_count, 0, "spinning due to token contention");
SYSCTL_QUAD(_lwkt, OID_AUTO, mplock_contention_count, CTLFLAG_RW,
        &mplock_contention_count, 0, "spinning due to MPLOCK contention");
#endif
#endif

/*
 * These helper procedures handle the runq, they can only be called from
 * within a critical section.
 *
 * WARNING!  Prior to SMP being brought up it is possible to enqueue and
 * dequeue threads belonging to other cpus, so be sure to use td->td_gd
 * instead of 'mycpu' when referencing the globaldata structure.   Once
 * SMP live enqueuing and dequeueing only occurs on the current cpu.
 */
static __inline
void
_lwkt_dequeue(thread_t td)
{
    if (td->td_flags & TDF_RUNQ) {
        int nq = td->td_pri & TDPRI_MASK;
        struct globaldata *gd = td->td_gd;

        td->td_flags &= ~TDF_RUNQ;
        TAILQ_REMOVE(&gd->gd_tdrunq[nq], td, td_threadq);
        /* runqmask is passively cleaned up by the switcher */
    }
}

static __inline
void
_lwkt_enqueue(thread_t td)
{
    if ((td->td_flags & (TDF_RUNQ|TDF_MIGRATING)) == 0) {
        int nq = td->td_pri & TDPRI_MASK;
        struct globaldata *gd = td->td_gd;

        td->td_flags |= TDF_RUNQ;
        TAILQ_INSERT_TAIL(&gd->gd_tdrunq[nq], td, td_threadq);
        gd->gd_runqmask |= 1 << nq;
    }
}

/*
 * Schedule a thread to run.  As the current thread we can always safely
 * schedule ourselves, and a shortcut procedure is provided for that
 * function.
 *
 * (non-blocking, self contained on a per cpu basis)
 */
void
lwkt_schedule_self(thread_t td)
{
    crit_enter_quick(td);
    KASSERT(td->td_wait == NULL, ("lwkt_schedule_self(): td_wait not NULL!"));
    KASSERT(td != &td->td_gd->gd_idlethread, ("lwkt_schedule_self(): scheduling gd_idlethread is illegal!"));
    _lwkt_enqueue(td);
#ifdef _KERNEL
    if (td->td_proc && td->td_proc->p_stat == SSLEEP)
        panic("SCHED SELF PANIC");
#endif
    crit_exit_quick(td);
}

/*
 * Deschedule a thread.
 *
 * (non-blocking, self contained on a per cpu basis)
 */
void
lwkt_deschedule_self(thread_t td)
{
    crit_enter_quick(td);
    KASSERT(td->td_wait == NULL, ("lwkt_schedule_self(): td_wait not NULL!"));
    _lwkt_dequeue(td);
    crit_exit_quick(td);
}

#ifdef _KERNEL

/*
 * LWKTs operate on a per-cpu basis
 *
 * WARNING!  Called from early boot, 'mycpu' may not work yet.
 */
void
lwkt_gdinit(struct globaldata *gd)
{
    int i;

    for (i = 0; i < sizeof(gd->gd_tdrunq)/sizeof(gd->gd_tdrunq[0]); ++i)
        TAILQ_INIT(&gd->gd_tdrunq[i]);
    gd->gd_runqmask = 0;
    TAILQ_INIT(&gd->gd_tdallq);
}

#endif /* _KERNEL */

/*
 * Initialize a thread wait structure prior to first use.
 *
 * NOTE!  called from low level boot code, we cannot do anything fancy!
 */
void
lwkt_wait_init(lwkt_wait_t w)
{
    lwkt_token_init(&w->wa_token);
    TAILQ_INIT(&w->wa_waitq);
    w->wa_gen = 0;
    w->wa_count = 0;
}

/*
 * Create a new thread.  The thread must be associated with a process context
 * or LWKT start address before it can be scheduled.  If the target cpu is
 * -1 the thread will be created on the current cpu.
 *
 * If you intend to create a thread without a process context this function
 * does everything except load the startup and switcher function.
 */
thread_t
lwkt_alloc_thread(struct thread *td, int stksize, int cpu)
{
    void *stack;
    int flags = 0;
    globaldata_t gd = mycpu;

    if (td == NULL) {
        crit_enter_gd(gd);
        if (gd->gd_tdfreecount > 0) {
            --gd->gd_tdfreecount;
            td = TAILQ_FIRST(&gd->gd_tdfreeq);
            KASSERT(td != NULL && (td->td_flags & TDF_RUNNING) == 0,
                ("lwkt_alloc_thread: unexpected NULL or corrupted td"));
            TAILQ_REMOVE(&gd->gd_tdfreeq, td, td_threadq);
            crit_exit_gd(gd);
            flags = td->td_flags & (TDF_ALLOCATED_STACK|TDF_ALLOCATED_THREAD);
        } else {
            crit_exit_gd(gd);
#ifdef _KERNEL
            td = zalloc(thread_zone);
#else
            td = malloc(sizeof(struct thread));
#endif
            td->td_kstack = NULL;
            td->td_kstack_size = 0;
            flags |= TDF_ALLOCATED_THREAD;
        }
    }
    if ((stack = td->td_kstack) != NULL && td->td_kstack_size != stksize) {
        if (flags & TDF_ALLOCATED_STACK) {
#ifdef _KERNEL
            kmem_free(kernel_map, (vm_offset_t)stack, td->td_kstack_size);
#else
            libcaps_free_stack(stack, td->td_kstack_size);
#endif
            stack = NULL;
        }
    }
    if (stack == NULL) {
#ifdef _KERNEL
        stack = (void *)kmem_alloc(kernel_map, stksize);
#else
        stack = libcaps_alloc_stack(stksize);
#endif
        flags |= TDF_ALLOCATED_STACK;
    }
    if (cpu < 0)
        lwkt_init_thread(td, stack, stksize, flags, mycpu);
    else
        lwkt_init_thread(td, stack, stksize, flags, globaldata_find(cpu));
    return(td);
}

#ifdef _KERNEL

/*
 * Initialize a preexisting thread structure.  This function is used by
 * lwkt_alloc_thread() and also used to initialize the per-cpu idlethread.
 *
 * All threads start out in a critical section at a priority of
 * TDPRI_KERN_DAEMON.  Higher level code will modify the priority as
 * appropriate.  This function may send an IPI message when the 
 * requested cpu is not the current cpu and consequently gd_tdallq may
 * not be initialized synchronously from the point of view of the originating
 * cpu.
 *
 * NOTE! we have to be careful in regards to creating threads for other cpus
 * if SMP has not yet been activated.
 */
#ifdef SMP

static void
lwkt_init_thread_remote(void *arg)
{
    thread_t td = arg;

    TAILQ_INSERT_TAIL(&td->td_gd->gd_tdallq, td, td_allq);
}

#endif

void
lwkt_init_thread(thread_t td, void *stack, int stksize, int flags,
                struct globaldata *gd)
{
    globaldata_t mygd = mycpu;

    bzero(td, sizeof(struct thread));
    td->td_kstack = stack;
    td->td_kstack_size = stksize;
    td->td_flags |= flags;
    td->td_gd = gd;
    td->td_pri = TDPRI_KERN_DAEMON + TDPRI_CRIT;
    lwkt_initport(&td->td_msgport, td);
    pmap_init_thread(td);
#ifdef SMP
    /*
     * Normally initializing a thread for a remote cpu requires sending an
     * IPI.  However, the idlethread is setup before the other cpus are
     * activated so we have to treat it as a special case.  XXX manipulation
     * of gd_tdallq requires the BGL.
     */
    if (gd == mygd || td == &gd->gd_idlethread) {
        crit_enter_gd(mygd);
        TAILQ_INSERT_TAIL(&gd->gd_tdallq, td, td_allq);
        crit_exit_gd(mygd);
    } else {
        lwkt_send_ipiq(gd, lwkt_init_thread_remote, td);
    }
#else
    crit_enter_gd(mygd);
    TAILQ_INSERT_TAIL(&gd->gd_tdallq, td, td_allq);
    crit_exit_gd(mygd);
#endif
}

#endif /* _KERNEL */

void
lwkt_set_comm(thread_t td, const char *ctl, ...)
{
    __va_list va;

    __va_start(va, ctl);
    vsnprintf(td->td_comm, sizeof(td->td_comm), ctl, va);
    __va_end(va);
}

void
lwkt_hold(thread_t td)
{
    ++td->td_refs;
}

void
lwkt_rele(thread_t td)
{
    KKASSERT(td->td_refs > 0);
    --td->td_refs;
}

#ifdef _KERNEL

void
lwkt_wait_free(thread_t td)
{
    while (td->td_refs)
        tsleep(td, 0, "tdreap", hz);
}

#endif

void
lwkt_free_thread(thread_t td)
{
    struct globaldata *gd = mycpu;

    KASSERT((td->td_flags & TDF_RUNNING) == 0,
        ("lwkt_free_thread: did not exit! %p", td));

    crit_enter_gd(gd);
    TAILQ_REMOVE(&gd->gd_tdallq, td, td_allq);
    if (gd->gd_tdfreecount < CACHE_NTHREADS &&
        (td->td_flags & TDF_ALLOCATED_THREAD)
    ) {
        ++gd->gd_tdfreecount;
        TAILQ_INSERT_HEAD(&gd->gd_tdfreeq, td, td_threadq);
        crit_exit_gd(gd);
    } else {
        crit_exit_gd(gd);
        if (td->td_kstack && (td->td_flags & TDF_ALLOCATED_STACK)) {
#ifdef _KERNEL
            kmem_free(kernel_map, (vm_offset_t)td->td_kstack, td->td_kstack_size);
#else
            libcaps_free_stack(td->td_kstack, td->td_kstack_size);
#endif
            /* gd invalid */
            td->td_kstack = NULL;
            td->td_kstack_size = 0;
        }
        if (td->td_flags & TDF_ALLOCATED_THREAD) {
#ifdef _KERNEL
            zfree(thread_zone, td);
#else
            free(td);
#endif
        }
    }
}


/*
 * Switch to the next runnable lwkt.  If no LWKTs are runnable then 
 * switch to the idlethread.  Switching must occur within a critical
 * section to avoid races with the scheduling queue.
 *
 * We always have full control over our cpu's run queue.  Other cpus
 * that wish to manipulate our queue must use the cpu_*msg() calls to
 * talk to our cpu, so a critical section is all that is needed and
 * the result is very, very fast thread switching.
 *
 * The LWKT scheduler uses a fixed priority model and round-robins at
 * each priority level.  User process scheduling is a totally
 * different beast and LWKT priorities should not be confused with
 * user process priorities.
 *
 * The MP lock may be out of sync with the thread's td_mpcount.  lwkt_switch()
 * cleans it up.  Note that the td_switch() function cannot do anything that
 * requires the MP lock since the MP lock will have already been setup for
 * the target thread (not the current thread).  It's nice to have a scheduler
 * that does not need the MP lock to work because it allows us to do some
 * really cool high-performance MP lock optimizations.
 */

void
lwkt_switch(void)
{
    globaldata_t gd = mycpu;
    thread_t td = gd->gd_curthread;
    thread_t ntd;
#ifdef SMP
    int mpheld;
#endif

    /*
     * Switching from within a 'fast' (non thread switched) interrupt is
     * illegal.
     */
    if (gd->gd_intr_nesting_level && panicstr == NULL) {
        panic("lwkt_switch: cannot switch from within a fast interrupt, yet, td %p\n", td);
    }

    /*
     * Passive release (used to transition from user to kernel mode
     * when we block or switch rather then when we enter the kernel).
     * This function is NOT called if we are switching into a preemption
     * or returning from a preemption.  Typically this causes us to lose
     * our current process designation (if we have one) and become a true
     * LWKT thread, and may also hand the current process designation to
     * another process and schedule thread.
     */
    if (td->td_release)
            td->td_release(td);

    crit_enter_gd(gd);

#ifdef SMP
    /*
     * td_mpcount cannot be used to determine if we currently hold the
     * MP lock because get_mplock() will increment it prior to attempting
     * to get the lock, and switch out if it can't.  Our ownership of 
     * the actual lock will remain stable while we are in a critical section
     * (but, of course, another cpu may own or release the lock so the
     * actual value of mp_lock is not stable).
     */
    mpheld = MP_LOCK_HELD();
#ifdef  INVARIANTS
    if (td->td_cscount) {
        printf("Diagnostic: attempt to switch while mastering cpusync: %p\n",
                td);
        if (panic_on_cscount)
            panic("switching while mastering cpusync");
    }
#endif
#endif
    if ((ntd = td->td_preempted) != NULL) {
        /*
         * We had preempted another thread on this cpu, resume the preempted
         * thread.  This occurs transparently, whether the preempted thread
         * was scheduled or not (it may have been preempted after descheduling
         * itself). 
         *
         * We have to setup the MP lock for the original thread after backing
         * out the adjustment that was made to curthread when the original
         * was preempted.
         */
        KKASSERT(ntd->td_flags & TDF_PREEMPT_LOCK);
#ifdef SMP
        if (ntd->td_mpcount && mpheld == 0) {
            panic("MPLOCK NOT HELD ON RETURN: %p %p %d %d",
               td, ntd, td->td_mpcount, ntd->td_mpcount);
        }
        if (ntd->td_mpcount) {
            td->td_mpcount -= ntd->td_mpcount;
            KKASSERT(td->td_mpcount >= 0);
        }
#endif
        ntd->td_flags |= TDF_PREEMPT_DONE;

        /*
         * XXX.  The interrupt may have woken a thread up, we need to properly
         * set the reschedule flag if the originally interrupted thread is at
         * a lower priority.
         */
        if (gd->gd_runqmask > (2 << (ntd->td_pri & TDPRI_MASK)) - 1)
            need_lwkt_resched();
        /* YYY release mp lock on switchback if original doesn't need it */
    } else {
        /*
         * Priority queue / round-robin at each priority.  Note that user
         * processes run at a fixed, low priority and the user process
         * scheduler deals with interactions between user processes
         * by scheduling and descheduling them from the LWKT queue as
         * necessary.
         *
         * We have to adjust the MP lock for the target thread.  If we 
         * need the MP lock and cannot obtain it we try to locate a
         * thread that does not need the MP lock.  If we cannot, we spin
         * instead of HLT.
         *
         * A similar issue exists for the tokens held by the target thread.
         * If we cannot obtain ownership of the tokens we cannot immediately
         * schedule the thread.
         */

        /*
         * We are switching threads.  If there are any pending requests for
         * tokens we can satisfy all of them here.
         */
#ifdef SMP
        if (gd->gd_tokreqbase)
                lwkt_drain_token_requests();
#endif

        /*
         * If an LWKT reschedule was requested, well that is what we are
         * doing now so clear it.
         */
        clear_lwkt_resched();
again:
        if (gd->gd_runqmask) {
            int nq = bsrl(gd->gd_runqmask);
            if ((ntd = TAILQ_FIRST(&gd->gd_tdrunq[nq])) == NULL) {
                gd->gd_runqmask &= ~(1 << nq);
                goto again;
            }
#ifdef SMP
            /*
             * If the target needs the MP lock and we couldn't get it,
             * or if the target is holding tokens and we could not 
             * gain ownership of the tokens, continue looking for a
             * thread to schedule and spin instead of HLT if we can't.
             *
             * NOTE: the mpheld variable invalid after this conditional, it
             * can change due to both cpu_try_mplock() returning success
             * AND interactions in lwkt_chktokens() due to the fact that
             * we are trying to check the mpcount of a thread other then
             * the current thread.  Because of this, if the current thread
             * is not holding td_mpcount, an IPI indirectly run via
             * lwkt_chktokens() can obtain and release the MP lock and
             * cause the core MP lock to be released. 
             */
            if ((ntd->td_mpcount && mpheld == 0 && !cpu_try_mplock()) ||
                (ntd->td_toks && lwkt_chktokens(ntd) == 0)
            ) {
                u_int32_t rqmask = gd->gd_runqmask;

                mpheld = MP_LOCK_HELD();
                ntd = NULL;
                while (rqmask) {
                    TAILQ_FOREACH(ntd, &gd->gd_tdrunq[nq], td_threadq) {
                        if (ntd->td_mpcount && !mpheld && !cpu_try_mplock()) {
                            /* spinning due to MP lock being held */
#ifdef  INVARIANTS
                            ++mplock_contention_count;
#endif
                            /* mplock still not held, 'mpheld' still valid */
                            continue;
                        }

                        /*
                         * mpheld state invalid after chktokens call returns
                         * failure, but the variable is only needed for
                         * the loop.
                         */
                        if (ntd->td_toks && !lwkt_chktokens(ntd)) {
                            /* spinning due to token contention */
#ifdef  INVARIANTS
                            ++token_contention_count;
#endif
                            mpheld = MP_LOCK_HELD();
                            continue;
                        }
                        break;
                    }
                    if (ntd)
                        break;
                    rqmask &= ~(1 << nq);
                    nq = bsrl(rqmask);
                }
                if (ntd == NULL) {
                    ntd = &gd->gd_idlethread;
                    ntd->td_flags |= TDF_IDLE_NOHLT;
                    KASSERT(ntd->td_mpcount == 0, ("Idlex thread %p was holding the BGL!", ntd));
                } else {
                    TAILQ_REMOVE(&gd->gd_tdrunq[nq], ntd, td_threadq);
                    TAILQ_INSERT_TAIL(&gd->gd_tdrunq[nq], ntd, td_threadq);
                }
            } else {
                TAILQ_REMOVE(&gd->gd_tdrunq[nq], ntd, td_threadq);
                TAILQ_INSERT_TAIL(&gd->gd_tdrunq[nq], ntd, td_threadq);
            }
#else
            TAILQ_REMOVE(&gd->gd_tdrunq[nq], ntd, td_threadq);
            TAILQ_INSERT_TAIL(&gd->gd_tdrunq[nq], ntd, td_threadq);
#endif
        } else {
            /*
             * We have nothing to run but only let the idle loop halt
             * the cpu if there are no pending interrupts.
             */
            ntd = &gd->gd_idlethread;
            if (gd->gd_reqflags & RQF_IDLECHECK_MASK)
                ntd->td_flags |= TDF_IDLE_NOHLT;
#ifdef SMP
            KASSERT(ntd->td_mpcount == 0, ("Idley thread %p was holding the BGL!", ntd));
#endif
        }
    }
    KASSERT(ntd->td_pri >= TDPRI_CRIT,
        ("priority problem in lwkt_switch %d %d", td->td_pri, ntd->td_pri));

    /*
     * Do the actual switch.  If the new target does not need the MP lock
     * and we are holding it, release the MP lock.  If the new target requires
     * the MP lock we have already acquired it for the target.
     */
#ifdef SMP
    if (ntd->td_mpcount == 0 ) {
        if (MP_LOCK_HELD())
            cpu_rel_mplock();
    } else {
        ASSERT_MP_LOCK_HELD(ntd);
    }
#endif
    if (td != ntd) {
        ++switch_count;
        td->td_switch(ntd);
    }
    /* NOTE: current cpu may have changed after switch */
    crit_exit_quick(td);
}

/*
 * Request that the target thread preempt the current thread.  Preemption
 * only works under a specific set of conditions:
 *
 *      - We are not preempting ourselves
 *      - The target thread is owned by the current cpu
 *      - We are not currently being preempted
 *      - The target is not currently being preempted
 *      - We are able to satisfy the target's MP lock requirements (if any).
 *
 * THE CALLER OF LWKT_PREEMPT() MUST BE IN A CRITICAL SECTION.  Typically
 * this is called via lwkt_schedule() through the td_preemptable callback.
 * critpri is the managed critical priority that we should ignore in order
 * to determine whether preemption is possible (aka usually just the crit
 * priority of lwkt_schedule() itself).
 *
 * XXX at the moment we run the target thread in a critical section during
 * the preemption in order to prevent the target from taking interrupts
 * that *WE* can't.  Preemption is strictly limited to interrupt threads
 * and interrupt-like threads, outside of a critical section, and the
 * preempted source thread will be resumed the instant the target blocks
 * whether or not the source is scheduled (i.e. preemption is supposed to
 * be as transparent as possible).
 *
 * The target thread inherits our MP count (added to its own) for the
 * duration of the preemption in order to preserve the atomicy of the
 * MP lock during the preemption.  Therefore, any preempting targets must be
 * careful in regards to MP assertions.  Note that the MP count may be
 * out of sync with the physical mp_lock, but we do not have to preserve
 * the original ownership of the lock if it was out of synch (that is, we
 * can leave it synchronized on return).
 */
void
lwkt_preempt(thread_t ntd, int critpri)
{
    struct globaldata *gd = mycpu;
    thread_t td;
#ifdef SMP
    int mpheld;
    int savecnt;
#endif

    /*
     * The caller has put us in a critical section.  We can only preempt
     * if the caller of the caller was not in a critical section (basically
     * a local interrupt), as determined by the 'critpri' parameter. 
     *
     * YYY The target thread must be in a critical section (else it must
     * inherit our critical section?  I dunno yet).
     *
     * Any tokens held by the target may not be held by thread(s) being
     * preempted.  We take the easy way out and do not preempt if
     * the target is holding tokens.
     *
     * Set need_lwkt_resched() unconditionally for now YYY.
     */
    KASSERT(ntd->td_pri >= TDPRI_CRIT, ("BADCRIT0 %d", ntd->td_pri));

    td = gd->gd_curthread;
    if ((ntd->td_pri & TDPRI_MASK) <= (td->td_pri & TDPRI_MASK)) {
        ++preempt_miss;
        return;
    }
    if ((td->td_pri & ~TDPRI_MASK) > critpri) {
        ++preempt_miss;
        need_lwkt_resched();
        return;
    }
#ifdef SMP
    if (ntd->td_gd != gd) {
        ++preempt_miss;
        need_lwkt_resched();
        return;
    }
#endif
    /*
     * Take the easy way out and do not preempt if the target is holding
     * one or more tokens.  We could test whether the thread(s) being
     * preempted interlock against the target thread's tokens and whether
     * we can get all the target thread's tokens, but this situation 
     * should not occur very often so its easier to simply not preempt.
     */
    if (ntd->td_toks != NULL) {
        ++preempt_miss;
        need_lwkt_resched();
        return;
    }
    if (td == ntd || ((td->td_flags | ntd->td_flags) & TDF_PREEMPT_LOCK)) {
        ++preempt_weird;
        need_lwkt_resched();
        return;
    }
    if (ntd->td_preempted) {
        ++preempt_hit;
        need_lwkt_resched();
        return;
    }
#ifdef SMP
    /*
     * note: an interrupt might have occured just as we were transitioning
     * to or from the MP lock.  In this case td_mpcount will be pre-disposed
     * (non-zero) but not actually synchronized with the actual state of the
     * lock.  We can use it to imply an MP lock requirement for the
     * preemption but we cannot use it to test whether we hold the MP lock
     * or not.
     */
    savecnt = td->td_mpcount;
    mpheld = MP_LOCK_HELD();
    ntd->td_mpcount += td->td_mpcount;
    if (mpheld == 0 && ntd->td_mpcount && !cpu_try_mplock()) {
        ntd->td_mpcount -= td->td_mpcount;
        ++preempt_miss;
        need_lwkt_resched();
        return;
    }
#endif

    /*
     * Since we are able to preempt the current thread, there is no need to
     * call need_lwkt_resched().
     */
    ++preempt_hit;
    ntd->td_preempted = td;
    td->td_flags |= TDF_PREEMPT_LOCK;
    td->td_switch(ntd);
    KKASSERT(ntd->td_preempted && (td->td_flags & TDF_PREEMPT_DONE));
#ifdef SMP
    KKASSERT(savecnt == td->td_mpcount);
    mpheld = MP_LOCK_HELD();
    if (mpheld && td->td_mpcount == 0)
        cpu_rel_mplock();
    else if (mpheld == 0 && td->td_mpcount)
        panic("lwkt_preempt(): MP lock was not held through");
#endif
    ntd->td_preempted = NULL;
    td->td_flags &= ~(TDF_PREEMPT_LOCK|TDF_PREEMPT_DONE);
}

/*
 * Yield our thread while higher priority threads are pending.  This is
 * typically called when we leave a critical section but it can be safely
 * called while we are in a critical section.
 *
 * This function will not generally yield to equal priority threads but it
 * can occur as a side effect.  Note that lwkt_switch() is called from
 * inside the critical section to prevent its own crit_exit() from reentering
 * lwkt_yield_quick().
 *
 * gd_reqflags indicates that *something* changed, e.g. an interrupt or softint
 * came along but was blocked and made pending.
 *
 * (self contained on a per cpu basis)
 */
void
lwkt_yield_quick(void)
{
    globaldata_t gd = mycpu;
    thread_t td = gd->gd_curthread;

    /*
     * gd_reqflags is cleared in splz if the cpl is 0.  If we were to clear
     * it with a non-zero cpl then we might not wind up calling splz after
     * a task switch when the critical section is exited even though the
     * new task could accept the interrupt.
     *
     * XXX from crit_exit() only called after last crit section is released.
     * If called directly will run splz() even if in a critical section.
     *
     * td_nest_count prevent deep nesting via splz() or doreti().  Note that
     * except for this special case, we MUST call splz() here to handle any
     * pending ints, particularly after we switch, or we might accidently
     * halt the cpu with interrupts pending.
     */
    if (gd->gd_reqflags && td->td_nest_count < 2)
        splz();

    /*
     * YYY enabling will cause wakeup() to task-switch, which really
     * confused the old 4.x code.  This is a good way to simulate
     * preemption and MP without actually doing preemption or MP, because a
     * lot of code assumes that wakeup() does not block.
     */
    if (untimely_switch && td->td_nest_count == 0 &&
        gd->gd_intr_nesting_level == 0
    ) {
        crit_enter_quick(td);
        /*
         * YYY temporary hacks until we disassociate the userland scheduler
         * from the LWKT scheduler.
         */
        if (td->td_flags & TDF_RUNQ) {
            lwkt_switch();              /* will not reenter yield function */
        } else {
            lwkt_schedule_self(td);     /* make sure we are scheduled */
            lwkt_switch();              /* will not reenter yield function */
            lwkt_deschedule_self(td);   /* make sure we are descheduled */
        }
        crit_exit_noyield(td);
    }
}

/*
 * This implements a normal yield which, unlike _quick, will yield to equal
 * priority threads as well.  Note that gd_reqflags tests will be handled by
 * the crit_exit() call in lwkt_switch().
 *
 * (self contained on a per cpu basis)
 */
void
lwkt_yield(void)
{
    lwkt_schedule_self(curthread);
    lwkt_switch();
}

/*
 * Generic schedule.  Possibly schedule threads belonging to other cpus and
 * deal with threads that might be blocked on a wait queue.
 *
 * We have a little helper inline function which does additional work after
 * the thread has been enqueued, including dealing with preemption and
 * setting need_lwkt_resched() (which prevents the kernel from returning
 * to userland until it has processed higher priority threads).
 */
static __inline
void
_lwkt_schedule_post(globaldata_t gd, thread_t ntd, int cpri)
{
    if (ntd->td_preemptable) {
        ntd->td_preemptable(ntd, cpri); /* YYY +token */
    } else if ((ntd->td_flags & TDF_NORESCHED) == 0 &&
        (ntd->td_pri & TDPRI_MASK) > (gd->gd_curthread->td_pri & TDPRI_MASK)
    ) {
        need_lwkt_resched();
    }
}

void
lwkt_schedule(thread_t td)
{
    globaldata_t mygd = mycpu;

#ifdef  INVARIANTS
    KASSERT(td != &td->td_gd->gd_idlethread, ("lwkt_schedule(): scheduling gd_idlethread is illegal!"));
    if ((td->td_flags & TDF_PREEMPT_LOCK) == 0 && td->td_proc 
        && td->td_proc->p_stat == SSLEEP
    ) {
        printf("PANIC schedule curtd = %p (%d %d) target %p (%d %d)\n",
            curthread,
            curthread->td_proc ? curthread->td_proc->p_pid : -1,
            curthread->td_proc ? curthread->td_proc->p_stat : -1,
            td,
            td->td_proc ? curthread->td_proc->p_pid : -1,
            td->td_proc ? curthread->td_proc->p_stat : -1
        );
        panic("SCHED PANIC");
    }
#endif
    crit_enter_gd(mygd);
    if (td == mygd->gd_curthread) {
        _lwkt_enqueue(td);
    } else {
        lwkt_wait_t w;

        /*
         * If the thread is on a wait list we have to send our scheduling
         * request to the owner of the wait structure.  Otherwise we send
         * the scheduling request to the cpu owning the thread.  Races
         * are ok, the target will forward the message as necessary (the
         * message may chase the thread around before it finally gets
         * acted upon).
         *
         * (remember, wait structures use stable storage)
         *
         * NOTE: we have to account for the number of critical sections
         * under our control when calling _lwkt_schedule_post() so it
         * can figure out whether preemption is allowed.
         *
         * NOTE: The wait structure algorithms are a mess and need to be
         * rewritten.
         *
         * NOTE: We cannot safely acquire or release a token, even 
         * non-blocking, because this routine may be called in the context
         * of a thread already holding the token and thus not provide any
         * interlock protection.  We cannot safely manipulate the td_toks
         * list for the same reason.  Instead we depend on our critical
         * section if the token is owned by our cpu.
         */
        if ((w = td->td_wait) != NULL) {
            if (w->wa_token.t_cpu == mygd) {
                TAILQ_REMOVE(&w->wa_waitq, td, td_threadq);
                --w->wa_count;
                td->td_wait = NULL;
#ifdef SMP
                if (td->td_gd == mygd) {
                    _lwkt_enqueue(td);
                    _lwkt_schedule_post(mygd, td, TDPRI_CRIT);
                } else {
                    lwkt_send_ipiq(td->td_gd, (ipifunc_t)lwkt_schedule, td);
                }
#else
                _lwkt_enqueue(td);
                _lwkt_schedule_post(mygd, td, TDPRI_CRIT);
#endif
            } else {
                lwkt_send_ipiq(w->wa_token.t_cpu, (ipifunc_t)lwkt_schedule, td);
            }
        } else {
            /*
             * If the wait structure is NULL and we own the thread, there
             * is no race (since we are in a critical section).  If we
             * do not own the thread there might be a race but the
             * target cpu will deal with it.
             */
#ifdef SMP
            if (td->td_gd == mygd) {
                _lwkt_enqueue(td);
                _lwkt_schedule_post(mygd, td, TDPRI_CRIT);
            } else {
                lwkt_send_ipiq(td->td_gd, (ipifunc_t)lwkt_schedule, td);
            }
#else
            _lwkt_enqueue(td);
            _lwkt_schedule_post(mygd, td, TDPRI_CRIT);
#endif
        }
    }
    crit_exit_gd(mygd);
}

/*
 * Managed acquisition.  This code assumes that the MP lock is held for
 * the tdallq operation and that the thread has been descheduled from its
 * original cpu.  We also have to wait for the thread to be entirely switched
 * out on its original cpu (this is usually fast enough that we never loop)
 * since the LWKT system does not have to hold the MP lock while switching
 * and the target may have released it before switching.
 */
void
lwkt_acquire(thread_t td)
{
    globaldata_t gd;
    globaldata_t mygd;

    gd = td->td_gd;
    mygd = mycpu;
    cpu_lfence();
    KKASSERT((td->td_flags & TDF_RUNQ) == 0);
    while (td->td_flags & TDF_RUNNING)  /* XXX spin */
        cpu_lfence();
    if (gd != mygd) {
        crit_enter_gd(mygd);
        TAILQ_REMOVE(&gd->gd_tdallq, td, td_allq);      /* protected by BGL */
        td->td_gd = mygd;
        TAILQ_INSERT_TAIL(&mygd->gd_tdallq, td, td_allq); /* protected by BGL */
        crit_exit_gd(mygd);
    }
}

/*
 * Generic deschedule.  Descheduling threads other then your own should be
 * done only in carefully controlled circumstances.  Descheduling is 
 * asynchronous.  
 *
 * This function may block if the cpu has run out of messages.
 */
void
lwkt_deschedule(thread_t td)
{
    crit_enter();
    if (td == curthread) {
        _lwkt_dequeue(td);
    } else {
        if (td->td_gd == mycpu) {
            _lwkt_dequeue(td);
        } else {
            lwkt_send_ipiq(td->td_gd, (ipifunc_t)lwkt_deschedule, td);
        }
    }
    crit_exit();
}

/*
 * Set the target thread's priority.  This routine does not automatically
 * switch to a higher priority thread, LWKT threads are not designed for
 * continuous priority changes.  Yield if you want to switch.
 *
 * We have to retain the critical section count which uses the high bits
 * of the td_pri field.  The specified priority may also indicate zero or
 * more critical sections by adding TDPRI_CRIT*N.
 *
 * Note that we requeue the thread whether it winds up on a different runq
 * or not.  uio_yield() depends on this and the routine is not normally
 * called with the same priority otherwise.
 */
void
lwkt_setpri(thread_t td, int pri)
{
    KKASSERT(pri >= 0);
    KKASSERT(td->td_gd == mycpu);
    crit_enter();
    if (td->td_flags & TDF_RUNQ) {
        _lwkt_dequeue(td);
        td->td_pri = (td->td_pri & ~TDPRI_MASK) + pri;
        _lwkt_enqueue(td);
    } else {
        td->td_pri = (td->td_pri & ~TDPRI_MASK) + pri;
    }
    crit_exit();
}

void
lwkt_setpri_self(int pri)
{
    thread_t td = curthread;

    KKASSERT(pri >= 0 && pri <= TDPRI_MAX);
    crit_enter();
    if (td->td_flags & TDF_RUNQ) {
        _lwkt_dequeue(td);
        td->td_pri = (td->td_pri & ~TDPRI_MASK) + pri;
        _lwkt_enqueue(td);
    } else {
        td->td_pri = (td->td_pri & ~TDPRI_MASK) + pri;
    }
    crit_exit();
}

/*
 * Determine if there is a runnable thread at a higher priority then
 * the current thread.  lwkt_setpri() does not check this automatically.
 * Return 1 if there is, 0 if there isn't.
 *
 * Example: if bit 31 of runqmask is set and the current thread is priority
 * 30, then we wind up checking the mask: 0x80000000 against 0x7fffffff.  
 *
 * If nq reaches 31 the shift operation will overflow to 0 and we will wind
 * up comparing against 0xffffffff, a comparison that will always be false.
 */
int
lwkt_checkpri_self(void)
{
    globaldata_t gd = mycpu;
    thread_t td = gd->gd_curthread;
    int nq = td->td_pri & TDPRI_MASK;

    while (gd->gd_runqmask > (__uint32_t)(2 << nq) - 1) {
        if (TAILQ_FIRST(&gd->gd_tdrunq[nq + 1]))
            return(1);
        ++nq;
    }
    return(0);
}

/*
 * Migrate the current thread to the specified cpu.  The BGL must be held
 * (for the gd_tdallq manipulation XXX).  This is accomplished by 
 * descheduling ourselves from the current cpu, moving our thread to the
 * tdallq of the target cpu, IPI messaging the target cpu, and switching out.
 * TDF_MIGRATING prevents scheduling races while the thread is being migrated.
 */
#ifdef SMP
static void lwkt_setcpu_remote(void *arg);
#endif

void
lwkt_setcpu_self(globaldata_t rgd)
{
#ifdef SMP
    thread_t td = curthread;

    if (td->td_gd != rgd) {
        crit_enter_quick(td);
        td->td_flags |= TDF_MIGRATING;
        lwkt_deschedule_self(td);
        TAILQ_REMOVE(&td->td_gd->gd_tdallq, td, td_allq); /* protected by BGL */
        TAILQ_INSERT_TAIL(&rgd->gd_tdallq, td, td_allq); /* protected by BGL */
        lwkt_send_ipiq(rgd, (ipifunc_t)lwkt_setcpu_remote, td);
        lwkt_switch();
        /* we are now on the target cpu */
        crit_exit_quick(td);
    }
#endif
}

/*
 * Remote IPI for cpu migration (called while in a critical section so we
 * do not have to enter another one).  The thread has already been moved to
 * our cpu's allq, but we must wait for the thread to be completely switched
 * out on the originating cpu before we schedule it on ours or the stack
 * state may be corrupt.  We clear TDF_MIGRATING after flushing the GD
 * change to main memory.
 *
 * XXX The use of TDF_MIGRATING might not be sufficient to avoid races
 * against wakeups.  It is best if this interface is used only when there
 * are no pending events that might try to schedule the thread.
 */
#ifdef SMP
static void
lwkt_setcpu_remote(void *arg)
{
    thread_t td = arg;
    globaldata_t gd = mycpu;

    while (td->td_flags & TDF_RUNNING)
        cpu_lfence();
    td->td_gd = gd;
    cpu_sfence();
    td->td_flags &= ~TDF_MIGRATING;
    _lwkt_enqueue(td);
}
#endif

struct proc *
lwkt_preempted_proc(void)
{
    thread_t td = curthread;
    while (td->td_preempted)
        td = td->td_preempted;
    return(td->td_proc);
}

/*
 * Block on the specified wait queue until signaled.  A generation number
 * must be supplied to interlock the wait queue.  The function will
 * return immediately if the generation number does not match the wait
 * structure's generation number.
 */
void
lwkt_block(lwkt_wait_t w, const char *wmesg, int *gen)
{
    thread_t td = curthread;
    lwkt_tokref ilock;

    lwkt_gettoken(&ilock, &w->wa_token);
    crit_enter();
    if (w->wa_gen == *gen) {
        _lwkt_dequeue(td);
        TAILQ_INSERT_TAIL(&w->wa_waitq, td, td_threadq);
        ++w->wa_count;
        td->td_wait = w;
        td->td_wmesg = wmesg;
    again:
        lwkt_switch();
        if (td->td_wmesg != NULL) {
            _lwkt_dequeue(td);
            goto again;
        }
    }
    crit_exit();
    *gen = w->wa_gen;
    lwkt_reltoken(&ilock);
}

/*
 * Signal a wait queue.  We gain ownership of the wait queue in order to
 * signal it.  Once a thread is removed from the wait queue we have to
 * deal with the cpu owning the thread.
 *
 * Note: alternatively we could message the target cpu owning the wait
 * queue.  YYY implement as sysctl.
 */
void
lwkt_signal(lwkt_wait_t w, int count)
{
    thread_t td;
    lwkt_tokref ilock;

    lwkt_gettoken(&ilock, &w->wa_token);
    ++w->wa_gen;
    crit_enter();
    if (count < 0)
        count = w->wa_count;
    while ((td = TAILQ_FIRST(&w->wa_waitq)) != NULL && count) {
        --count;
        --w->wa_count;
        TAILQ_REMOVE(&w->wa_waitq, td, td_threadq);
        td->td_wait = NULL;
        td->td_wmesg = NULL;
        if (td->td_gd == mycpu) {
            _lwkt_enqueue(td);
        } else {
            lwkt_send_ipiq(td->td_gd, (ipifunc_t)lwkt_schedule, td);
        }
    }
    crit_exit();
    lwkt_reltoken(&ilock);
}

/*
 * Create a kernel process/thread/whatever.  It shares it's address space
 * with proc0 - ie: kernel only.
 *
 * NOTE!  By default new threads are created with the MP lock held.  A 
 * thread which does not require the MP lock should release it by calling
 * rel_mplock() at the start of the new thread.
 */
int
lwkt_create(void (*func)(void *), void *arg,
    struct thread **tdp, thread_t template, int tdflags, int cpu,
    const char *fmt, ...)
{
    thread_t td;
    __va_list ap;

    td = lwkt_alloc_thread(template, LWKT_THREAD_STACK, cpu);
    if (tdp)
        *tdp = td;
    cpu_set_thread_handler(td, lwkt_exit, func, arg);
    td->td_flags |= TDF_VERBOSE | tdflags;
#ifdef SMP
    td->td_mpcount = 1;
#endif

    /*
     * Set up arg0 for 'ps' etc
     */
    __va_start(ap, fmt);
    vsnprintf(td->td_comm, sizeof(td->td_comm), fmt, ap);
    __va_end(ap);

    /*
     * Schedule the thread to run
     */
    if ((td->td_flags & TDF_STOPREQ) == 0)
        lwkt_schedule(td);
    else
        td->td_flags &= ~TDF_STOPREQ;
    return 0;
}

/*
 * kthread_* is specific to the kernel and is not needed by userland.
 */
#ifdef _KERNEL

/*
 * Destroy an LWKT thread.   Warning!  This function is not called when
 * a process exits, cpu_proc_exit() directly calls cpu_thread_exit() and
 * uses a different reaping mechanism.
 */
void
lwkt_exit(void)
{
    thread_t td = curthread;
    globaldata_t gd;

    if (td->td_flags & TDF_VERBOSE)
        printf("kthread %p %s has exited\n", td, td->td_comm);
    caps_exit(td);
    crit_enter_quick(td);
    lwkt_deschedule_self(td);
    gd = mycpu;
    KKASSERT(gd == td->td_gd);
    TAILQ_REMOVE(&gd->gd_tdallq, td, td_allq);
    if (td->td_flags & TDF_ALLOCATED_THREAD) {
        ++gd->gd_tdfreecount;
        TAILQ_INSERT_TAIL(&gd->gd_tdfreeq, td, td_threadq);
    }
    cpu_thread_exit();
}

#endif /* _KERNEL */

void
crit_panic(void)
{
    thread_t td = curthread;
    int lpri = td->td_pri;

    td->td_pri = 0;
    panic("td_pri is/would-go negative! %p %d", td, lpri);
}