Merge branch 'master' of ssh://crater.dragonflybsd.org/repository/git/dragonfly
[dragonfly.git] / sys / kern / lwkt_thread.c
1 /*
2  * Copyright (c) 2003-2010 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34
35 /*
36  * Each cpu in a system has its own self-contained light weight kernel
37  * thread scheduler, which means that generally speaking we only need
38  * to use a critical section to avoid problems.  Foreign thread 
39  * scheduling is queued via (async) IPIs.
40  */
41
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/proc.h>
46 #include <sys/rtprio.h>
47 #include <sys/kinfo.h>
48 #include <sys/queue.h>
49 #include <sys/sysctl.h>
50 #include <sys/kthread.h>
51 #include <machine/cpu.h>
52 #include <sys/lock.h>
53 #include <sys/caps.h>
54 #include <sys/spinlock.h>
55 #include <sys/ktr.h>
56
57 #include <sys/thread2.h>
58 #include <sys/spinlock2.h>
59 #include <sys/mplock2.h>
60
61 #include <sys/dsched.h>
62
63 #include <vm/vm.h>
64 #include <vm/vm_param.h>
65 #include <vm/vm_kern.h>
66 #include <vm/vm_object.h>
67 #include <vm/vm_page.h>
68 #include <vm/vm_map.h>
69 #include <vm/vm_pager.h>
70 #include <vm/vm_extern.h>
71
72 #include <machine/stdarg.h>
73 #include <machine/smp.h>
74
75 #if !defined(KTR_CTXSW)
76 #define KTR_CTXSW KTR_ALL
77 #endif
78 KTR_INFO_MASTER(ctxsw);
79 KTR_INFO(KTR_CTXSW, ctxsw, sw, 0, "#cpu[%d].td = %p",
80          sizeof(int) + sizeof(struct thread *));
81 KTR_INFO(KTR_CTXSW, ctxsw, pre, 1, "#cpu[%d].td = %p",
82          sizeof(int) + sizeof(struct thread *));
83 KTR_INFO(KTR_CTXSW, ctxsw, newtd, 2, "#threads[%p].name = %s",
84          sizeof (struct thread *) + sizeof(char *));
85 KTR_INFO(KTR_CTXSW, ctxsw, deadtd, 3, "#threads[%p].name = <dead>", sizeof (struct thread *));
86
87 static MALLOC_DEFINE(M_THREAD, "thread", "lwkt threads");
88
89 #ifdef  INVARIANTS
90 static int panic_on_cscount = 0;
91 #endif
92 static __int64_t switch_count = 0;
93 static __int64_t preempt_hit = 0;
94 static __int64_t preempt_miss = 0;
95 static __int64_t preempt_weird = 0;
96 static __int64_t token_contention_count __debugvar = 0;
97 static int lwkt_use_spin_port;
98 static struct objcache *thread_cache;
99
100 #ifdef SMP
101 static void lwkt_schedule_remote(void *arg, int arg2, struct intrframe *frame);
102 #endif
103 static void lwkt_fairq_accumulate(globaldata_t gd, thread_t td);
104
105 extern void cpu_heavy_restore(void);
106 extern void cpu_lwkt_restore(void);
107 extern void cpu_kthread_restore(void);
108 extern void cpu_idle_restore(void);
109
110 #ifdef __x86_64__
111
112 static int
113 jg_tos_ok(struct thread *td)
114 {
115         void *tos;
116         int tos_ok;
117
118         if (td == NULL) {
119                 return 1;
120         }
121         KKASSERT(td->td_sp != NULL);
122         tos = ((void **)td->td_sp)[0];
123         tos_ok = 0;
124         if ((tos == cpu_heavy_restore) || (tos == cpu_lwkt_restore) ||
125             (tos == cpu_kthread_restore) || (tos == cpu_idle_restore)) {
126                 tos_ok = 1;
127         }
128         return tos_ok;
129 }
130
131 #endif
132
133 /*
134  * We can make all thread ports use the spin backend instead of the thread
135  * backend.  This should only be set to debug the spin backend.
136  */
137 TUNABLE_INT("lwkt.use_spin_port", &lwkt_use_spin_port);
138
139 #ifdef  INVARIANTS
140 SYSCTL_INT(_lwkt, OID_AUTO, panic_on_cscount, CTLFLAG_RW, &panic_on_cscount, 0, "");
141 #endif
142 SYSCTL_QUAD(_lwkt, OID_AUTO, switch_count, CTLFLAG_RW, &switch_count, 0, "");
143 SYSCTL_QUAD(_lwkt, OID_AUTO, preempt_hit, CTLFLAG_RW, &preempt_hit, 0, 
144             "Successful preemption events");
145 SYSCTL_QUAD(_lwkt, OID_AUTO, preempt_miss, CTLFLAG_RW, &preempt_miss, 0, 
146             "Failed preemption events");
147 SYSCTL_QUAD(_lwkt, OID_AUTO, preempt_weird, CTLFLAG_RW, &preempt_weird, 0, "");
148 #ifdef  INVARIANTS
149 SYSCTL_QUAD(_lwkt, OID_AUTO, token_contention_count, CTLFLAG_RW,
150         &token_contention_count, 0, "spinning due to token contention");
151 #endif
152 static int fairq_enable = 1;
153 SYSCTL_INT(_lwkt, OID_AUTO, fairq_enable, CTLFLAG_RW, &fairq_enable, 0, "");
154 static int user_pri_sched = 0;
155 SYSCTL_INT(_lwkt, OID_AUTO, user_pri_sched, CTLFLAG_RW, &user_pri_sched, 0, "");
156
157 /*
158  * These helper procedures handle the runq, they can only be called from
159  * within a critical section.
160  *
161  * WARNING!  Prior to SMP being brought up it is possible to enqueue and
162  * dequeue threads belonging to other cpus, so be sure to use td->td_gd
163  * instead of 'mycpu' when referencing the globaldata structure.   Once
164  * SMP live enqueuing and dequeueing only occurs on the current cpu.
165  */
166 static __inline
167 void
168 _lwkt_dequeue(thread_t td)
169 {
170     if (td->td_flags & TDF_RUNQ) {
171         struct globaldata *gd = td->td_gd;
172
173         td->td_flags &= ~TDF_RUNQ;
174         TAILQ_REMOVE(&gd->gd_tdrunq, td, td_threadq);
175         gd->gd_fairq_total_pri -= td->td_pri;
176         if (TAILQ_FIRST(&gd->gd_tdrunq) == NULL)
177                 atomic_clear_int_nonlocked(&gd->gd_reqflags, RQF_RUNNING);
178     }
179 }
180
181 /*
182  * Priority enqueue.
183  *
184  * NOTE: There are a limited number of lwkt threads runnable since user
185  *       processes only schedule one at a time per cpu.
186  */
187 static __inline
188 void
189 _lwkt_enqueue(thread_t td)
190 {
191     thread_t xtd;
192
193     if ((td->td_flags & (TDF_RUNQ|TDF_MIGRATING|TDF_BLOCKQ)) == 0) {
194         struct globaldata *gd = td->td_gd;
195
196         td->td_flags |= TDF_RUNQ;
197         xtd = TAILQ_FIRST(&gd->gd_tdrunq);
198         if (xtd == NULL) {
199                 TAILQ_INSERT_TAIL(&gd->gd_tdrunq, td, td_threadq);
200                 atomic_set_int_nonlocked(&gd->gd_reqflags, RQF_RUNNING);
201         } else {
202                 while (xtd && xtd->td_pri > td->td_pri)
203                         xtd = TAILQ_NEXT(xtd, td_threadq);
204                 if (xtd)
205                         TAILQ_INSERT_BEFORE(xtd, td, td_threadq);
206                 else
207                         TAILQ_INSERT_TAIL(&gd->gd_tdrunq, td, td_threadq);
208         }
209         gd->gd_fairq_total_pri += td->td_pri;
210     }
211 }
212
213 static __boolean_t
214 _lwkt_thread_ctor(void *obj, void *privdata, int ocflags)
215 {
216         struct thread *td = (struct thread *)obj;
217
218         td->td_kstack = NULL;
219         td->td_kstack_size = 0;
220         td->td_flags = TDF_ALLOCATED_THREAD;
221         return (1);
222 }
223
224 static void
225 _lwkt_thread_dtor(void *obj, void *privdata)
226 {
227         struct thread *td = (struct thread *)obj;
228
229         KASSERT(td->td_flags & TDF_ALLOCATED_THREAD,
230             ("_lwkt_thread_dtor: not allocated from objcache"));
231         KASSERT((td->td_flags & TDF_ALLOCATED_STACK) && td->td_kstack &&
232                 td->td_kstack_size > 0,
233             ("_lwkt_thread_dtor: corrupted stack"));
234         kmem_free(&kernel_map, (vm_offset_t)td->td_kstack, td->td_kstack_size);
235 }
236
237 /*
238  * Initialize the lwkt s/system.
239  */
240 void
241 lwkt_init(void)
242 {
243     /* An objcache has 2 magazines per CPU so divide cache size by 2. */
244     thread_cache = objcache_create_mbacked(M_THREAD, sizeof(struct thread),
245                         NULL, CACHE_NTHREADS/2,
246                         _lwkt_thread_ctor, _lwkt_thread_dtor, NULL);
247 }
248
249 /*
250  * Schedule a thread to run.  As the current thread we can always safely
251  * schedule ourselves, and a shortcut procedure is provided for that
252  * function.
253  *
254  * (non-blocking, self contained on a per cpu basis)
255  */
256 void
257 lwkt_schedule_self(thread_t td)
258 {
259     crit_enter_quick(td);
260     KASSERT(td != &td->td_gd->gd_idlethread,
261             ("lwkt_schedule_self(): scheduling gd_idlethread is illegal!"));
262     KKASSERT(td->td_lwp == NULL || (td->td_lwp->lwp_flag & LWP_ONRUNQ) == 0);
263     _lwkt_enqueue(td);
264     crit_exit_quick(td);
265 }
266
267 /*
268  * Deschedule a thread.
269  *
270  * (non-blocking, self contained on a per cpu basis)
271  */
272 void
273 lwkt_deschedule_self(thread_t td)
274 {
275     crit_enter_quick(td);
276     _lwkt_dequeue(td);
277     crit_exit_quick(td);
278 }
279
280 /*
281  * LWKTs operate on a per-cpu basis
282  *
283  * WARNING!  Called from early boot, 'mycpu' may not work yet.
284  */
285 void
286 lwkt_gdinit(struct globaldata *gd)
287 {
288     TAILQ_INIT(&gd->gd_tdrunq);
289     TAILQ_INIT(&gd->gd_tdallq);
290 }
291
292 /*
293  * Create a new thread.  The thread must be associated with a process context
294  * or LWKT start address before it can be scheduled.  If the target cpu is
295  * -1 the thread will be created on the current cpu.
296  *
297  * If you intend to create a thread without a process context this function
298  * does everything except load the startup and switcher function.
299  */
300 thread_t
301 lwkt_alloc_thread(struct thread *td, int stksize, int cpu, int flags)
302 {
303     globaldata_t gd = mycpu;
304     void *stack;
305
306     /*
307      * If static thread storage is not supplied allocate a thread.  Reuse
308      * a cached free thread if possible.  gd_freetd is used to keep an exiting
309      * thread intact through the exit.
310      */
311     if (td == NULL) {
312         if ((td = gd->gd_freetd) != NULL)
313             gd->gd_freetd = NULL;
314         else
315             td = objcache_get(thread_cache, M_WAITOK);
316         KASSERT((td->td_flags &
317                  (TDF_ALLOCATED_THREAD|TDF_RUNNING)) == TDF_ALLOCATED_THREAD,
318                 ("lwkt_alloc_thread: corrupted td flags 0x%X", td->td_flags));
319         flags |= td->td_flags & (TDF_ALLOCATED_THREAD|TDF_ALLOCATED_STACK);
320     }
321
322     /*
323      * Try to reuse cached stack.
324      */
325     if ((stack = td->td_kstack) != NULL && td->td_kstack_size != stksize) {
326         if (flags & TDF_ALLOCATED_STACK) {
327             kmem_free(&kernel_map, (vm_offset_t)stack, td->td_kstack_size);
328             stack = NULL;
329         }
330     }
331     if (stack == NULL) {
332         stack = (void *)kmem_alloc(&kernel_map, stksize);
333         flags |= TDF_ALLOCATED_STACK;
334     }
335     if (cpu < 0)
336         lwkt_init_thread(td, stack, stksize, flags, gd);
337     else
338         lwkt_init_thread(td, stack, stksize, flags, globaldata_find(cpu));
339     return(td);
340 }
341
342 /*
343  * Initialize a preexisting thread structure.  This function is used by
344  * lwkt_alloc_thread() and also used to initialize the per-cpu idlethread.
345  *
346  * All threads start out in a critical section at a priority of
347  * TDPRI_KERN_DAEMON.  Higher level code will modify the priority as
348  * appropriate.  This function may send an IPI message when the 
349  * requested cpu is not the current cpu and consequently gd_tdallq may
350  * not be initialized synchronously from the point of view of the originating
351  * cpu.
352  *
353  * NOTE! we have to be careful in regards to creating threads for other cpus
354  * if SMP has not yet been activated.
355  */
356 #ifdef SMP
357
358 static void
359 lwkt_init_thread_remote(void *arg)
360 {
361     thread_t td = arg;
362
363     /*
364      * Protected by critical section held by IPI dispatch
365      */
366     TAILQ_INSERT_TAIL(&td->td_gd->gd_tdallq, td, td_allq);
367 }
368
369 #endif
370
371 /*
372  * lwkt core thread structural initialization.
373  *
374  * NOTE: All threads are initialized as mpsafe threads.
375  */
376 void
377 lwkt_init_thread(thread_t td, void *stack, int stksize, int flags,
378                 struct globaldata *gd)
379 {
380     globaldata_t mygd = mycpu;
381
382     bzero(td, sizeof(struct thread));
383     td->td_kstack = stack;
384     td->td_kstack_size = stksize;
385     td->td_flags = flags;
386     td->td_gd = gd;
387     td->td_pri = TDPRI_KERN_DAEMON;
388     td->td_critcount = 1;
389     td->td_toks_stop = &td->td_toks_base;
390     if (lwkt_use_spin_port)
391         lwkt_initport_spin(&td->td_msgport);
392     else
393         lwkt_initport_thread(&td->td_msgport, td);
394     pmap_init_thread(td);
395 #ifdef SMP
396     /*
397      * Normally initializing a thread for a remote cpu requires sending an
398      * IPI.  However, the idlethread is setup before the other cpus are
399      * activated so we have to treat it as a special case.  XXX manipulation
400      * of gd_tdallq requires the BGL.
401      */
402     if (gd == mygd || td == &gd->gd_idlethread) {
403         crit_enter_gd(mygd);
404         TAILQ_INSERT_TAIL(&gd->gd_tdallq, td, td_allq);
405         crit_exit_gd(mygd);
406     } else {
407         lwkt_send_ipiq(gd, lwkt_init_thread_remote, td);
408     }
409 #else
410     crit_enter_gd(mygd);
411     TAILQ_INSERT_TAIL(&gd->gd_tdallq, td, td_allq);
412     crit_exit_gd(mygd);
413 #endif
414
415     dsched_new_thread(td);
416 }
417
418 void
419 lwkt_set_comm(thread_t td, const char *ctl, ...)
420 {
421     __va_list va;
422
423     __va_start(va, ctl);
424     kvsnprintf(td->td_comm, sizeof(td->td_comm), ctl, va);
425     __va_end(va);
426     KTR_LOG(ctxsw_newtd, td, &td->td_comm[0]);
427 }
428
429 void
430 lwkt_hold(thread_t td)
431 {
432     ++td->td_refs;
433 }
434
435 void
436 lwkt_rele(thread_t td)
437 {
438     KKASSERT(td->td_refs > 0);
439     --td->td_refs;
440 }
441
442 void
443 lwkt_wait_free(thread_t td)
444 {
445     while (td->td_refs)
446         tsleep(td, 0, "tdreap", hz);
447 }
448
449 void
450 lwkt_free_thread(thread_t td)
451 {
452     KASSERT((td->td_flags & TDF_RUNNING) == 0,
453         ("lwkt_free_thread: did not exit! %p", td));
454
455     if (td->td_flags & TDF_ALLOCATED_THREAD) {
456         objcache_put(thread_cache, td);
457     } else if (td->td_flags & TDF_ALLOCATED_STACK) {
458         /* client-allocated struct with internally allocated stack */
459         KASSERT(td->td_kstack && td->td_kstack_size > 0,
460             ("lwkt_free_thread: corrupted stack"));
461         kmem_free(&kernel_map, (vm_offset_t)td->td_kstack, td->td_kstack_size);
462         td->td_kstack = NULL;
463         td->td_kstack_size = 0;
464     }
465     KTR_LOG(ctxsw_deadtd, td);
466 }
467
468
469 /*
470  * Switch to the next runnable lwkt.  If no LWKTs are runnable then 
471  * switch to the idlethread.  Switching must occur within a critical
472  * section to avoid races with the scheduling queue.
473  *
474  * We always have full control over our cpu's run queue.  Other cpus
475  * that wish to manipulate our queue must use the cpu_*msg() calls to
476  * talk to our cpu, so a critical section is all that is needed and
477  * the result is very, very fast thread switching.
478  *
479  * The LWKT scheduler uses a fixed priority model and round-robins at
480  * each priority level.  User process scheduling is a totally
481  * different beast and LWKT priorities should not be confused with
482  * user process priorities.
483  *
484  * The MP lock may be out of sync with the thread's td_mpcount.  lwkt_switch()
485  * cleans it up.  Note that the td_switch() function cannot do anything that
486  * requires the MP lock since the MP lock will have already been setup for
487  * the target thread (not the current thread).  It's nice to have a scheduler
488  * that does not need the MP lock to work because it allows us to do some
489  * really cool high-performance MP lock optimizations.
490  *
491  * PREEMPTION NOTE: Preemption occurs via lwkt_preempt().  lwkt_switch()
492  * is not called by the current thread in the preemption case, only when
493  * the preempting thread blocks (in order to return to the original thread).
494  */
495 void
496 lwkt_switch(void)
497 {
498     globaldata_t gd = mycpu;
499     thread_t td = gd->gd_curthread;
500     thread_t ntd;
501     thread_t xtd;
502     thread_t nlast;
503     int nquserok;
504 #ifdef SMP
505     int mpheld;
506 #endif
507     int didaccumulate;
508     const char *lmsg;   /* diagnostic - 'systat -pv 1' */
509     const void *laddr;
510
511     /*
512      * Switching from within a 'fast' (non thread switched) interrupt or IPI
513      * is illegal.  However, we may have to do it anyway if we hit a fatal
514      * kernel trap or we have paniced.
515      *
516      * If this case occurs save and restore the interrupt nesting level.
517      */
518     if (gd->gd_intr_nesting_level) {
519         int savegdnest;
520         int savegdtrap;
521
522         if (gd->gd_trap_nesting_level == 0 && panic_cpu_gd != mycpu) {
523             panic("lwkt_switch: Attempt to switch from a "
524                   "a fast interrupt, ipi, or hard code section, "
525                   "td %p\n",
526                   td);
527         } else {
528             savegdnest = gd->gd_intr_nesting_level;
529             savegdtrap = gd->gd_trap_nesting_level;
530             gd->gd_intr_nesting_level = 0;
531             gd->gd_trap_nesting_level = 0;
532             if ((td->td_flags & TDF_PANICWARN) == 0) {
533                 td->td_flags |= TDF_PANICWARN;
534                 kprintf("Warning: thread switch from interrupt, IPI, "
535                         "or hard code section.\n"
536                         "thread %p (%s)\n", td, td->td_comm);
537                 print_backtrace(-1);
538             }
539             lwkt_switch();
540             gd->gd_intr_nesting_level = savegdnest;
541             gd->gd_trap_nesting_level = savegdtrap;
542             return;
543         }
544     }
545
546     /*
547      * Passive release (used to transition from user to kernel mode
548      * when we block or switch rather then when we enter the kernel).
549      * This function is NOT called if we are switching into a preemption
550      * or returning from a preemption.  Typically this causes us to lose
551      * our current process designation (if we have one) and become a true
552      * LWKT thread, and may also hand the current process designation to
553      * another process and schedule thread.
554      */
555     if (td->td_release)
556             td->td_release(td);
557
558     crit_enter_gd(gd);
559     if (TD_TOKS_HELD(td))
560             lwkt_relalltokens(td);
561
562     /*
563      * We had better not be holding any spin locks, but don't get into an
564      * endless panic loop.
565      */
566     KASSERT(gd->gd_spinlocks_wr == 0 || panicstr != NULL, 
567             ("lwkt_switch: still holding %d exclusive spinlocks!",
568              gd->gd_spinlocks_wr));
569
570
571 #ifdef SMP
572     /*
573      * td_mpcount cannot be used to determine if we currently hold the
574      * MP lock because get_mplock() will increment it prior to attempting
575      * to get the lock, and switch out if it can't.  Our ownership of 
576      * the actual lock will remain stable while we are in a critical section
577      * (but, of course, another cpu may own or release the lock so the
578      * actual value of mp_lock is not stable).
579      */
580     mpheld = MP_LOCK_HELD(gd);
581 #ifdef  INVARIANTS
582     if (td->td_cscount) {
583         kprintf("Diagnostic: attempt to switch while mastering cpusync: %p\n",
584                 td);
585         if (panic_on_cscount)
586             panic("switching while mastering cpusync");
587     }
588 #endif
589 #endif
590
591     /*
592      * If we had preempted another thread on this cpu, resume the preempted
593      * thread.  This occurs transparently, whether the preempted thread
594      * was scheduled or not (it may have been preempted after descheduling
595      * itself).
596      *
597      * We have to setup the MP lock for the original thread after backing
598      * out the adjustment that was made to curthread when the original
599      * was preempted.
600      */
601     if ((ntd = td->td_preempted) != NULL) {
602         KKASSERT(ntd->td_flags & TDF_PREEMPT_LOCK);
603 #ifdef SMP
604         if (ntd->td_mpcount && mpheld == 0) {
605             panic("MPLOCK NOT HELD ON RETURN: %p %p %d %d",
606                td, ntd, td->td_mpcount, ntd->td_mpcount);
607         }
608         if (ntd->td_mpcount) {
609             td->td_mpcount -= ntd->td_mpcount;
610             KKASSERT(td->td_mpcount >= 0);
611         }
612 #endif
613         ntd->td_flags |= TDF_PREEMPT_DONE;
614
615         /*
616          * The interrupt may have woken a thread up, we need to properly
617          * set the reschedule flag if the originally interrupted thread is
618          * at a lower priority.
619          */
620         if (TAILQ_FIRST(&gd->gd_tdrunq) &&
621             TAILQ_FIRST(&gd->gd_tdrunq)->td_pri > ntd->td_pri) {
622             need_lwkt_resched();
623         }
624         /* YYY release mp lock on switchback if original doesn't need it */
625         goto havethread_preempted;
626     }
627
628     /*
629      * Implement round-robin fairq with priority insertion.  The priority
630      * insertion is handled by _lwkt_enqueue()
631      *
632      * We have to adjust the MP lock for the target thread.  If we
633      * need the MP lock and cannot obtain it we try to locate a
634      * thread that does not need the MP lock.  If we cannot, we spin
635      * instead of HLT.
636      *
637      * A similar issue exists for the tokens held by the target thread.
638      * If we cannot obtain ownership of the tokens we cannot immediately
639      * schedule the thread.
640      */
641     for (;;) {
642         clear_lwkt_resched();
643         didaccumulate = 0;
644         ntd = TAILQ_FIRST(&gd->gd_tdrunq);
645
646         /*
647          * Hotpath if we can get all necessary resources.
648          *
649          * If nothing is runnable switch to the idle thread
650          */
651         if (ntd == NULL) {
652             ntd = &gd->gd_idlethread;
653             if (gd->gd_reqflags & RQF_IDLECHECK_MASK)
654                     ntd->td_flags |= TDF_IDLE_NOHLT;
655 #ifdef SMP
656             if (ntd->td_mpcount) {
657                 if (gd->gd_trap_nesting_level == 0 && panicstr == NULL)
658                     panic("Idle thread %p was holding the BGL!", ntd);
659                 if (mpheld == 0) {
660                     set_cpu_contention_mask(gd);
661                     handle_cpu_contention_mask();
662                     cpu_try_mplock();
663                     mpheld = MP_LOCK_HELD(gd);
664                     cpu_pause();
665                     continue;
666                 }
667             }
668             clr_cpu_contention_mask(gd);
669 #endif
670             cpu_time.cp_msg[0] = 0;
671             cpu_time.cp_stallpc = 0;
672             goto haveidle;
673         }
674
675         /*
676          * Hotpath schedule
677          *
678          * NOTE: For UP there is no mplock and lwkt_getalltokens()
679          *           always succeeds.
680          */
681         if (ntd->td_fairq_accum >= 0 &&
682 #ifdef SMP
683             (ntd->td_mpcount == 0 || mpheld || cpu_try_mplock()) &&
684 #endif
685             (!TD_TOKS_HELD(ntd) || lwkt_getalltokens(ntd, &lmsg, &laddr))
686         ) {
687 #ifdef SMP
688             clr_cpu_contention_mask(gd);
689 #endif
690             goto havethread;
691         }
692
693         lmsg = NULL;
694         laddr = NULL;
695
696 #ifdef SMP
697         if (ntd->td_fairq_accum >= 0)
698                 set_cpu_contention_mask(gd);
699         /* Reload mpheld (it become stale after mplock/token ops) */
700         mpheld = MP_LOCK_HELD(gd);
701         if (ntd->td_mpcount && mpheld == 0) {
702             lmsg = "mplock";
703             laddr = ntd->td_mplock_stallpc;
704         }
705 #endif
706
707         /*
708          * Coldpath - unable to schedule ntd, continue looking for threads
709          * to schedule.  This is only allowed of the (presumably) kernel
710          * thread exhausted its fair share.  A kernel thread stuck on
711          * resources does not currently allow a user thread to get in
712          * front of it.
713          */
714 #ifdef SMP
715         nquserok = ((ntd->td_pri < TDPRI_KERN_LPSCHED) ||
716                     (ntd->td_fairq_accum < 0));
717 #else
718         nquserok = 1;
719 #endif
720         nlast = NULL;
721
722         for (;;) {
723             /*
724              * If the fair-share scheduler ran out ntd gets moved to the
725              * end and its accumulator will be bumped, if it didn't we
726              * maintain the same queue position.
727              *
728              * nlast keeps track of the last element prior to any moves.
729              */
730             if (ntd->td_fairq_accum < 0) {
731                 lwkt_fairq_accumulate(gd, ntd);
732                 didaccumulate = 1;
733
734                 /*
735                  * Move to end
736                  */
737                 xtd = TAILQ_NEXT(ntd, td_threadq);
738                 TAILQ_REMOVE(&gd->gd_tdrunq, ntd, td_threadq);
739                 TAILQ_INSERT_TAIL(&gd->gd_tdrunq, ntd, td_threadq);
740
741                 /*
742                  * Set terminal element (nlast)
743                  */
744                 if (nlast == NULL) {
745                     nlast = ntd;
746                     if (xtd == NULL)
747                         xtd = ntd;
748                 }
749                 ntd = xtd;
750             } else {
751                 ntd = TAILQ_NEXT(ntd, td_threadq);
752             }
753
754             /*
755              * If we exhausted the run list switch to the idle thread.
756              * Since one or more threads had resource acquisition issues
757              * we do not allow the idle thread to halt.
758              *
759              * NOTE: nlast can be NULL.
760              */
761             if (ntd == nlast) {
762                 cpu_pause();
763                 ntd = &gd->gd_idlethread;
764                 ntd->td_flags |= TDF_IDLE_NOHLT;
765 #ifdef SMP
766                 if (ntd->td_mpcount) {
767                     mpheld = MP_LOCK_HELD(gd);
768                     if (gd->gd_trap_nesting_level == 0 && panicstr == NULL)
769                         panic("Idle thread %p was holding the BGL!", ntd);
770                     if (mpheld == 0) {
771                         set_cpu_contention_mask(gd);
772                         handle_cpu_contention_mask();
773                         cpu_try_mplock();
774                         mpheld = MP_LOCK_HELD(gd);
775                         cpu_pause();
776                         break;          /* try again from the top, almost */
777                     }
778                 }
779 #endif
780
781                 /*
782                  * If fairq accumulations occured we do not schedule the
783                  * idle thread.  This will cause us to try again from
784                  * the (almost) top.
785                  */
786                 if (didaccumulate)
787                         break;          /* try again from the top, almost */
788                 if (lmsg)
789                     strlcpy(cpu_time.cp_msg, lmsg, sizeof(cpu_time.cp_msg));
790                 cpu_time.cp_stallpc = (uintptr_t)laddr;
791                 goto haveidle;
792             }
793
794             /*
795              * Try to switch to this thread.
796              *
797              * NOTE: For UP there is no mplock and lwkt_getalltokens()
798              *       always succeeds.
799              */
800             if ((ntd->td_pri >= TDPRI_KERN_LPSCHED || nquserok ||
801                 user_pri_sched) && ntd->td_fairq_accum >= 0 &&
802 #ifdef SMP
803                 (ntd->td_mpcount == 0 || mpheld || cpu_try_mplock()) &&
804 #endif
805                 (!TD_TOKS_HELD(ntd) || lwkt_getalltokens(ntd, &lmsg, &laddr))
806             ) {
807 #ifdef SMP
808                     clr_cpu_contention_mask(gd);
809 #endif
810                     goto havethread;
811             }
812 #ifdef SMP
813             if (ntd->td_fairq_accum >= 0)
814                     set_cpu_contention_mask(gd);
815             /*
816              * Reload mpheld (it become stale after mplock/token ops).
817              */
818             mpheld = MP_LOCK_HELD(gd);
819             if (ntd->td_mpcount && mpheld == 0) {
820                 lmsg = "mplock";
821                 laddr = ntd->td_mplock_stallpc;
822             }
823             if (ntd->td_pri >= TDPRI_KERN_LPSCHED && ntd->td_fairq_accum >= 0)
824                 nquserok = 0;
825 #endif
826         }
827
828         /*
829          * All threads exhausted but we can loop due to a negative
830          * accumulator.
831          *
832          * While we are looping in the scheduler be sure to service
833          * any interrupts which were made pending due to our critical
834          * section, otherwise we could livelock (e.g.) IPIs.
835          *
836          * NOTE: splz can enter and exit the mplock so mpheld is
837          * stale after this call.
838          */
839         splz_check();
840
841 #ifdef SMP
842         /*
843          * Our mplock can be cached and cause other cpus to livelock
844          * if we loop due to e.g. not being able to acquire tokens.
845          */
846         if (MP_LOCK_HELD(gd))
847             cpu_rel_mplock(gd->gd_cpuid);
848         mpheld = 0;
849 #endif
850     }
851
852     /*
853      * Do the actual switch.  WARNING: mpheld is stale here.
854      *
855      * We must always decrement td_fairq_accum on non-idle threads just
856      * in case a thread never gets a tick due to being in a continuous
857      * critical section.  The page-zeroing code does that.
858      *
859      * If the thread we came up with is a higher or equal priority verses
860      * the thread at the head of the queue we move our thread to the
861      * front.  This way we can always check the front of the queue.
862      */
863 havethread:
864     ++gd->gd_cnt.v_swtch;
865     --ntd->td_fairq_accum;
866     xtd = TAILQ_FIRST(&gd->gd_tdrunq);
867     if (ntd != xtd && ntd->td_pri >= xtd->td_pri) {
868         TAILQ_REMOVE(&gd->gd_tdrunq, ntd, td_threadq);
869         TAILQ_INSERT_HEAD(&gd->gd_tdrunq, ntd, td_threadq);
870     }
871 havethread_preempted:
872     ;
873     /*
874      * If the new target does not need the MP lock and we are holding it,
875      * release the MP lock.  If the new target requires the MP lock we have
876      * already acquired it for the target.
877      *
878      * WARNING: mpheld is stale here.
879      */
880 haveidle:
881     KASSERT(ntd->td_critcount,
882             ("priority problem in lwkt_switch %d %d", td->td_pri, ntd->td_pri));
883 #ifdef SMP
884     if (ntd->td_mpcount == 0 ) {
885         if (MP_LOCK_HELD(gd))
886             cpu_rel_mplock(gd->gd_cpuid);
887     } else {
888         ASSERT_MP_LOCK_HELD(ntd);
889     }
890 #endif
891     if (td != ntd) {
892         ++switch_count;
893 #ifdef __x86_64__
894         {
895             int tos_ok __debugvar = jg_tos_ok(ntd);
896             KKASSERT(tos_ok);
897         }
898 #endif
899         KTR_LOG(ctxsw_sw, gd->gd_cpuid, ntd);
900         td->td_switch(ntd);
901     }
902     /* NOTE: current cpu may have changed after switch */
903     crit_exit_quick(td);
904 }
905
906 /*
907  * Request that the target thread preempt the current thread.  Preemption
908  * only works under a specific set of conditions:
909  *
910  *      - We are not preempting ourselves
911  *      - The target thread is owned by the current cpu
912  *      - We are not currently being preempted
913  *      - The target is not currently being preempted
914  *      - We are not holding any spin locks
915  *      - The target thread is not holding any tokens
916  *      - We are able to satisfy the target's MP lock requirements (if any).
917  *
918  * THE CALLER OF LWKT_PREEMPT() MUST BE IN A CRITICAL SECTION.  Typically
919  * this is called via lwkt_schedule() through the td_preemptable callback.
920  * critcount is the managed critical priority that we should ignore in order
921  * to determine whether preemption is possible (aka usually just the crit
922  * priority of lwkt_schedule() itself).
923  *
924  * XXX at the moment we run the target thread in a critical section during
925  * the preemption in order to prevent the target from taking interrupts
926  * that *WE* can't.  Preemption is strictly limited to interrupt threads
927  * and interrupt-like threads, outside of a critical section, and the
928  * preempted source thread will be resumed the instant the target blocks
929  * whether or not the source is scheduled (i.e. preemption is supposed to
930  * be as transparent as possible).
931  *
932  * The target thread inherits our MP count (added to its own) for the
933  * duration of the preemption in order to preserve the atomicy of the
934  * MP lock during the preemption.  Therefore, any preempting targets must be
935  * careful in regards to MP assertions.  Note that the MP count may be
936  * out of sync with the physical mp_lock, but we do not have to preserve
937  * the original ownership of the lock if it was out of synch (that is, we
938  * can leave it synchronized on return).
939  */
940 void
941 lwkt_preempt(thread_t ntd, int critcount)
942 {
943     struct globaldata *gd = mycpu;
944     thread_t td;
945 #ifdef SMP
946     int mpheld;
947     int savecnt;
948 #endif
949
950     /*
951      * The caller has put us in a critical section.  We can only preempt
952      * if the caller of the caller was not in a critical section (basically
953      * a local interrupt), as determined by the 'critcount' parameter.  We
954      * also can't preempt if the caller is holding any spinlocks (even if
955      * he isn't in a critical section).  This also handles the tokens test.
956      *
957      * YYY The target thread must be in a critical section (else it must
958      * inherit our critical section?  I dunno yet).
959      *
960      * Set need_lwkt_resched() unconditionally for now YYY.
961      */
962     KASSERT(ntd->td_critcount, ("BADCRIT0 %d", ntd->td_pri));
963
964     td = gd->gd_curthread;
965     if (ntd->td_pri <= td->td_pri) {
966         ++preempt_miss;
967         return;
968     }
969     if (td->td_critcount > critcount) {
970         ++preempt_miss;
971         need_lwkt_resched();
972         return;
973     }
974 #ifdef SMP
975     if (ntd->td_gd != gd) {
976         ++preempt_miss;
977         need_lwkt_resched();
978         return;
979     }
980 #endif
981     /*
982      * We don't have to check spinlocks here as they will also bump
983      * td_critcount.
984      *
985      * Do not try to preempt if the target thread is holding any tokens.
986      * We could try to acquire the tokens but this case is so rare there
987      * is no need to support it.
988      */
989     KKASSERT(gd->gd_spinlocks_wr == 0);
990
991     if (TD_TOKS_HELD(ntd)) {
992         ++preempt_miss;
993         need_lwkt_resched();
994         return;
995     }
996     if (td == ntd || ((td->td_flags | ntd->td_flags) & TDF_PREEMPT_LOCK)) {
997         ++preempt_weird;
998         need_lwkt_resched();
999         return;
1000     }
1001     if (ntd->td_preempted) {
1002         ++preempt_hit;
1003         need_lwkt_resched();
1004         return;
1005     }
1006 #ifdef SMP
1007     /*
1008      * note: an interrupt might have occured just as we were transitioning
1009      * to or from the MP lock.  In this case td_mpcount will be pre-disposed
1010      * (non-zero) but not actually synchronized with the actual state of the
1011      * lock.  We can use it to imply an MP lock requirement for the
1012      * preemption but we cannot use it to test whether we hold the MP lock
1013      * or not.
1014      */
1015     savecnt = td->td_mpcount;
1016     mpheld = MP_LOCK_HELD(gd);
1017     ntd->td_mpcount += td->td_mpcount;
1018     if (mpheld == 0 && ntd->td_mpcount && !cpu_try_mplock()) {
1019         ntd->td_mpcount -= td->td_mpcount;
1020         ++preempt_miss;
1021         need_lwkt_resched();
1022         return;
1023     }
1024 #endif
1025
1026     /*
1027      * Since we are able to preempt the current thread, there is no need to
1028      * call need_lwkt_resched().
1029      */
1030     ++preempt_hit;
1031     ntd->td_preempted = td;
1032     td->td_flags |= TDF_PREEMPT_LOCK;
1033     KTR_LOG(ctxsw_pre, gd->gd_cpuid, ntd);
1034     td->td_switch(ntd);
1035
1036     KKASSERT(ntd->td_preempted && (td->td_flags & TDF_PREEMPT_DONE));
1037 #ifdef SMP
1038     KKASSERT(savecnt == td->td_mpcount);
1039     mpheld = MP_LOCK_HELD(gd);
1040     if (mpheld && td->td_mpcount == 0)
1041         cpu_rel_mplock(gd->gd_cpuid);
1042     else if (mpheld == 0 && td->td_mpcount)
1043         panic("lwkt_preempt(): MP lock was not held through");
1044 #endif
1045     ntd->td_preempted = NULL;
1046     td->td_flags &= ~(TDF_PREEMPT_LOCK|TDF_PREEMPT_DONE);
1047 }
1048
1049 /*
1050  * Conditionally call splz() if gd_reqflags indicates work is pending.
1051  * This will work inside a critical section but not inside a hard code
1052  * section.
1053  *
1054  * (self contained on a per cpu basis)
1055  */
1056 void
1057 splz_check(void)
1058 {
1059     globaldata_t gd = mycpu;
1060     thread_t td = gd->gd_curthread;
1061
1062     if ((gd->gd_reqflags & RQF_IDLECHECK_MASK) &&
1063         gd->gd_intr_nesting_level == 0 &&
1064         td->td_nest_count < 2)
1065     {
1066         splz();
1067     }
1068 }
1069
1070 /*
1071  * This version is integrated into crit_exit, reqflags has already
1072  * been tested but td_critcount has not.
1073  *
1074  * We only want to execute the splz() on the 1->0 transition of
1075  * critcount and not in a hard code section or if too deeply nested.
1076  */
1077 void
1078 lwkt_maybe_splz(thread_t td)
1079 {
1080     globaldata_t gd = td->td_gd;
1081
1082     if (td->td_critcount == 0 &&
1083         gd->gd_intr_nesting_level == 0 &&
1084         td->td_nest_count < 2)
1085     {
1086         splz();
1087     }
1088 }
1089
1090 /*
1091  * This function is used to negotiate a passive release of the current
1092  * process/lwp designation with the user scheduler, allowing the user
1093  * scheduler to schedule another user thread.  The related kernel thread
1094  * (curthread) continues running in the released state.
1095  */
1096 void
1097 lwkt_passive_release(struct thread *td)
1098 {
1099     struct lwp *lp = td->td_lwp;
1100
1101     td->td_release = NULL;
1102     lwkt_setpri_self(TDPRI_KERN_USER);
1103     lp->lwp_proc->p_usched->release_curproc(lp);
1104 }
1105
1106
1107 /*
1108  * This implements a normal yield.  This routine is virtually a nop if
1109  * there is nothing to yield to but it will always run any pending interrupts
1110  * if called from a critical section.
1111  *
1112  * This yield is designed for kernel threads without a user context.
1113  *
1114  * (self contained on a per cpu basis)
1115  */
1116 void
1117 lwkt_yield(void)
1118 {
1119     globaldata_t gd = mycpu;
1120     thread_t td = gd->gd_curthread;
1121     thread_t xtd;
1122
1123     if ((gd->gd_reqflags & RQF_IDLECHECK_MASK) && td->td_nest_count < 2)
1124         splz();
1125     if (td->td_fairq_accum < 0) {
1126         lwkt_schedule_self(curthread);
1127         lwkt_switch();
1128     } else {
1129         xtd = TAILQ_FIRST(&gd->gd_tdrunq);
1130         if (xtd && xtd->td_pri > td->td_pri) {
1131             lwkt_schedule_self(curthread);
1132             lwkt_switch();
1133         }
1134     }
1135 }
1136
1137 /*
1138  * This yield is designed for kernel threads with a user context.
1139  *
1140  * The kernel acting on behalf of the user is potentially cpu-bound,
1141  * this function will efficiently allow other threads to run and also
1142  * switch to other processes by releasing.
1143  *
1144  * The lwkt_user_yield() function is designed to have very low overhead
1145  * if no yield is determined to be needed.
1146  */
1147 void
1148 lwkt_user_yield(void)
1149 {
1150     globaldata_t gd = mycpu;
1151     thread_t td = gd->gd_curthread;
1152
1153     /*
1154      * Always run any pending interrupts in case we are in a critical
1155      * section.
1156      */
1157     if ((gd->gd_reqflags & RQF_IDLECHECK_MASK) && td->td_nest_count < 2)
1158         splz();
1159
1160 #ifdef SMP
1161     /*
1162      * XXX SEVERE TEMPORARY HACK.  A cpu-bound operation running in the
1163      * kernel can prevent other cpus from servicing interrupt threads
1164      * which still require the MP lock (which is a lot of them).  This
1165      * has a chaining effect since if the interrupt is blocked, so is
1166      * the event, so normal scheduling will not pick up on the problem.
1167      */
1168     if (cpu_contention_mask && td->td_mpcount) {
1169         yield_mplock(td);
1170     }
1171 #endif
1172
1173     /*
1174      * Switch (which forces a release) if another kernel thread needs
1175      * the cpu, if userland wants us to resched, or if our kernel
1176      * quantum has run out.
1177      */
1178     if (lwkt_resched_wanted() ||
1179         user_resched_wanted() ||
1180         td->td_fairq_accum < 0)
1181     {
1182         lwkt_switch();
1183     }
1184
1185 #if 0
1186     /*
1187      * Reacquire the current process if we are released.
1188      *
1189      * XXX not implemented atm.  The kernel may be holding locks and such,
1190      *     so we want the thread to continue to receive cpu.
1191      */
1192     if (td->td_release == NULL && lp) {
1193         lp->lwp_proc->p_usched->acquire_curproc(lp);
1194         td->td_release = lwkt_passive_release;
1195         lwkt_setpri_self(TDPRI_USER_NORM);
1196     }
1197 #endif
1198 }
1199
1200 /*
1201  * Generic schedule.  Possibly schedule threads belonging to other cpus and
1202  * deal with threads that might be blocked on a wait queue.
1203  *
1204  * We have a little helper inline function which does additional work after
1205  * the thread has been enqueued, including dealing with preemption and
1206  * setting need_lwkt_resched() (which prevents the kernel from returning
1207  * to userland until it has processed higher priority threads).
1208  *
1209  * It is possible for this routine to be called after a failed _enqueue
1210  * (due to the target thread migrating, sleeping, or otherwise blocked).
1211  * We have to check that the thread is actually on the run queue!
1212  *
1213  * reschedok is an optimized constant propagated from lwkt_schedule() or
1214  * lwkt_schedule_noresched().  By default it is non-zero, causing a
1215  * reschedule to be requested if the target thread has a higher priority.
1216  * The port messaging code will set MSG_NORESCHED and cause reschedok to
1217  * be 0, prevented undesired reschedules.
1218  */
1219 static __inline
1220 void
1221 _lwkt_schedule_post(globaldata_t gd, thread_t ntd, int ccount, int reschedok)
1222 {
1223     thread_t otd;
1224
1225     if (ntd->td_flags & TDF_RUNQ) {
1226         if (ntd->td_preemptable && reschedok) {
1227             ntd->td_preemptable(ntd, ccount);   /* YYY +token */
1228         } else if (reschedok) {
1229             otd = curthread;
1230             if (ntd->td_pri > otd->td_pri)
1231                 need_lwkt_resched();
1232         }
1233
1234         /*
1235          * Give the thread a little fair share scheduler bump if it
1236          * has been asleep for a while.  This is primarily to avoid
1237          * a degenerate case for interrupt threads where accumulator
1238          * crosses into negative territory unnecessarily.
1239          */
1240         if (ntd->td_fairq_lticks != ticks) {
1241             ntd->td_fairq_lticks = ticks;
1242             ntd->td_fairq_accum += gd->gd_fairq_total_pri;
1243             if (ntd->td_fairq_accum > TDFAIRQ_MAX(gd))
1244                     ntd->td_fairq_accum = TDFAIRQ_MAX(gd);
1245         }
1246     }
1247 }
1248
1249 static __inline
1250 void
1251 _lwkt_schedule(thread_t td, int reschedok)
1252 {
1253     globaldata_t mygd = mycpu;
1254
1255     KASSERT(td != &td->td_gd->gd_idlethread, ("lwkt_schedule(): scheduling gd_idlethread is illegal!"));
1256     crit_enter_gd(mygd);
1257     KKASSERT(td->td_lwp == NULL || (td->td_lwp->lwp_flag & LWP_ONRUNQ) == 0);
1258     if (td == mygd->gd_curthread) {
1259         _lwkt_enqueue(td);
1260     } else {
1261         /*
1262          * If we own the thread, there is no race (since we are in a
1263          * critical section).  If we do not own the thread there might
1264          * be a race but the target cpu will deal with it.
1265          */
1266 #ifdef SMP
1267         if (td->td_gd == mygd) {
1268             _lwkt_enqueue(td);
1269             _lwkt_schedule_post(mygd, td, 1, reschedok);
1270         } else {
1271             lwkt_send_ipiq3(td->td_gd, lwkt_schedule_remote, td, 0);
1272         }
1273 #else
1274         _lwkt_enqueue(td);
1275         _lwkt_schedule_post(mygd, td, 1, reschedok);
1276 #endif
1277     }
1278     crit_exit_gd(mygd);
1279 }
1280
1281 void
1282 lwkt_schedule(thread_t td)
1283 {
1284     _lwkt_schedule(td, 1);
1285 }
1286
1287 void
1288 lwkt_schedule_noresched(thread_t td)
1289 {
1290     _lwkt_schedule(td, 0);
1291 }
1292
1293 #ifdef SMP
1294
1295 /*
1296  * When scheduled remotely if frame != NULL the IPIQ is being
1297  * run via doreti or an interrupt then preemption can be allowed.
1298  *
1299  * To allow preemption we have to drop the critical section so only
1300  * one is present in _lwkt_schedule_post.
1301  */
1302 static void
1303 lwkt_schedule_remote(void *arg, int arg2, struct intrframe *frame)
1304 {
1305     thread_t td = curthread;
1306     thread_t ntd = arg;
1307
1308     if (frame && ntd->td_preemptable) {
1309         crit_exit_noyield(td);
1310         _lwkt_schedule(ntd, 1);
1311         crit_enter_quick(td);
1312     } else {
1313         _lwkt_schedule(ntd, 1);
1314     }
1315 }
1316
1317 /*
1318  * Thread migration using a 'Pull' method.  The thread may or may not be
1319  * the current thread.  It MUST be descheduled and in a stable state.
1320  * lwkt_giveaway() must be called on the cpu owning the thread.
1321  *
1322  * At any point after lwkt_giveaway() is called, the target cpu may
1323  * 'pull' the thread by calling lwkt_acquire().
1324  *
1325  * We have to make sure the thread is not sitting on a per-cpu tsleep
1326  * queue or it will blow up when it moves to another cpu.
1327  *
1328  * MPSAFE - must be called under very specific conditions.
1329  */
1330 void
1331 lwkt_giveaway(thread_t td)
1332 {
1333     globaldata_t gd = mycpu;
1334
1335     crit_enter_gd(gd);
1336     if (td->td_flags & TDF_TSLEEPQ)
1337         tsleep_remove(td);
1338     KKASSERT(td->td_gd == gd);
1339     TAILQ_REMOVE(&gd->gd_tdallq, td, td_allq);
1340     td->td_flags |= TDF_MIGRATING;
1341     crit_exit_gd(gd);
1342 }
1343
1344 void
1345 lwkt_acquire(thread_t td)
1346 {
1347     globaldata_t gd;
1348     globaldata_t mygd;
1349
1350     KKASSERT(td->td_flags & TDF_MIGRATING);
1351     gd = td->td_gd;
1352     mygd = mycpu;
1353     if (gd != mycpu) {
1354         cpu_lfence();
1355         KKASSERT((td->td_flags & TDF_RUNQ) == 0);
1356         crit_enter_gd(mygd);
1357         while (td->td_flags & (TDF_RUNNING|TDF_PREEMPT_LOCK)) {
1358 #ifdef SMP
1359             lwkt_process_ipiq();
1360 #endif
1361             cpu_lfence();
1362         }
1363         td->td_gd = mygd;
1364         TAILQ_INSERT_TAIL(&mygd->gd_tdallq, td, td_allq);
1365         td->td_flags &= ~TDF_MIGRATING;
1366         crit_exit_gd(mygd);
1367     } else {
1368         crit_enter_gd(mygd);
1369         TAILQ_INSERT_TAIL(&mygd->gd_tdallq, td, td_allq);
1370         td->td_flags &= ~TDF_MIGRATING;
1371         crit_exit_gd(mygd);
1372     }
1373 }
1374
1375 #endif
1376
1377 /*
1378  * Generic deschedule.  Descheduling threads other then your own should be
1379  * done only in carefully controlled circumstances.  Descheduling is 
1380  * asynchronous.  
1381  *
1382  * This function may block if the cpu has run out of messages.
1383  */
1384 void
1385 lwkt_deschedule(thread_t td)
1386 {
1387     crit_enter();
1388 #ifdef SMP
1389     if (td == curthread) {
1390         _lwkt_dequeue(td);
1391     } else {
1392         if (td->td_gd == mycpu) {
1393             _lwkt_dequeue(td);
1394         } else {
1395             lwkt_send_ipiq(td->td_gd, (ipifunc1_t)lwkt_deschedule, td);
1396         }
1397     }
1398 #else
1399     _lwkt_dequeue(td);
1400 #endif
1401     crit_exit();
1402 }
1403
1404 /*
1405  * Set the target thread's priority.  This routine does not automatically
1406  * switch to a higher priority thread, LWKT threads are not designed for
1407  * continuous priority changes.  Yield if you want to switch.
1408  */
1409 void
1410 lwkt_setpri(thread_t td, int pri)
1411 {
1412     KKASSERT(td->td_gd == mycpu);
1413     if (td->td_pri != pri) {
1414         KKASSERT(pri >= 0);
1415         crit_enter();
1416         if (td->td_flags & TDF_RUNQ) {
1417             _lwkt_dequeue(td);
1418             td->td_pri = pri;
1419             _lwkt_enqueue(td);
1420         } else {
1421             td->td_pri = pri;
1422         }
1423         crit_exit();
1424     }
1425 }
1426
1427 /*
1428  * Set the initial priority for a thread prior to it being scheduled for
1429  * the first time.  The thread MUST NOT be scheduled before or during
1430  * this call.  The thread may be assigned to a cpu other then the current
1431  * cpu.
1432  *
1433  * Typically used after a thread has been created with TDF_STOPPREQ,
1434  * and before the thread is initially scheduled.
1435  */
1436 void
1437 lwkt_setpri_initial(thread_t td, int pri)
1438 {
1439     KKASSERT(pri >= 0);
1440     KKASSERT((td->td_flags & TDF_RUNQ) == 0);
1441     td->td_pri = pri;
1442 }
1443
1444 void
1445 lwkt_setpri_self(int pri)
1446 {
1447     thread_t td = curthread;
1448
1449     KKASSERT(pri >= 0 && pri <= TDPRI_MAX);
1450     crit_enter();
1451     if (td->td_flags & TDF_RUNQ) {
1452         _lwkt_dequeue(td);
1453         td->td_pri = pri;
1454         _lwkt_enqueue(td);
1455     } else {
1456         td->td_pri = pri;
1457     }
1458     crit_exit();
1459 }
1460
1461 /*
1462  * 1/hz tick (typically 10ms) x TDFAIRQ_SCALE (typ 8) = 80ms full cycle.
1463  *
1464  * Example: two competing threads, same priority N.  decrement by (2*N)
1465  * increment by N*8, each thread will get 4 ticks.
1466  */
1467 void
1468 lwkt_fairq_schedulerclock(thread_t td)
1469 {
1470     if (fairq_enable) {
1471         while (td) {
1472             if (td != &td->td_gd->gd_idlethread) {
1473                 td->td_fairq_accum -= td->td_gd->gd_fairq_total_pri;
1474                 if (td->td_fairq_accum < -TDFAIRQ_MAX(td->td_gd))
1475                         td->td_fairq_accum = -TDFAIRQ_MAX(td->td_gd);
1476                 if (td->td_fairq_accum < 0)
1477                         need_lwkt_resched();
1478                 td->td_fairq_lticks = ticks;
1479             }
1480             td = td->td_preempted;
1481         }
1482     }
1483 }
1484
1485 static void
1486 lwkt_fairq_accumulate(globaldata_t gd, thread_t td)
1487 {
1488         td->td_fairq_accum += td->td_pri * TDFAIRQ_SCALE;
1489         if (td->td_fairq_accum > TDFAIRQ_MAX(td->td_gd))
1490                 td->td_fairq_accum = TDFAIRQ_MAX(td->td_gd);
1491 }
1492
1493 /*
1494  * Migrate the current thread to the specified cpu. 
1495  *
1496  * This is accomplished by descheduling ourselves from the current cpu,
1497  * moving our thread to the tdallq of the target cpu, IPI messaging the
1498  * target cpu, and switching out.  TDF_MIGRATING prevents scheduling
1499  * races while the thread is being migrated.
1500  *
1501  * We must be sure to remove ourselves from the current cpu's tsleepq
1502  * before potentially moving to another queue.  The thread can be on
1503  * a tsleepq due to a left-over tsleep_interlock().
1504  */
1505 #ifdef SMP
1506 static void lwkt_setcpu_remote(void *arg);
1507 #endif
1508
1509 void
1510 lwkt_setcpu_self(globaldata_t rgd)
1511 {
1512 #ifdef SMP
1513     thread_t td = curthread;
1514
1515     if (td->td_gd != rgd) {
1516         crit_enter_quick(td);
1517         if (td->td_flags & TDF_TSLEEPQ)
1518             tsleep_remove(td);
1519         td->td_flags |= TDF_MIGRATING;
1520         lwkt_deschedule_self(td);
1521         TAILQ_REMOVE(&td->td_gd->gd_tdallq, td, td_allq);
1522         lwkt_send_ipiq(rgd, (ipifunc1_t)lwkt_setcpu_remote, td);
1523         lwkt_switch();
1524         /* we are now on the target cpu */
1525         TAILQ_INSERT_TAIL(&rgd->gd_tdallq, td, td_allq);
1526         crit_exit_quick(td);
1527     }
1528 #endif
1529 }
1530
1531 void
1532 lwkt_migratecpu(int cpuid)
1533 {
1534 #ifdef SMP
1535         globaldata_t rgd;
1536
1537         rgd = globaldata_find(cpuid);
1538         lwkt_setcpu_self(rgd);
1539 #endif
1540 }
1541
1542 /*
1543  * Remote IPI for cpu migration (called while in a critical section so we
1544  * do not have to enter another one).  The thread has already been moved to
1545  * our cpu's allq, but we must wait for the thread to be completely switched
1546  * out on the originating cpu before we schedule it on ours or the stack
1547  * state may be corrupt.  We clear TDF_MIGRATING after flushing the GD
1548  * change to main memory.
1549  *
1550  * XXX The use of TDF_MIGRATING might not be sufficient to avoid races
1551  * against wakeups.  It is best if this interface is used only when there
1552  * are no pending events that might try to schedule the thread.
1553  */
1554 #ifdef SMP
1555 static void
1556 lwkt_setcpu_remote(void *arg)
1557 {
1558     thread_t td = arg;
1559     globaldata_t gd = mycpu;
1560
1561     while (td->td_flags & (TDF_RUNNING|TDF_PREEMPT_LOCK)) {
1562 #ifdef SMP
1563         lwkt_process_ipiq();
1564 #endif
1565         cpu_lfence();
1566     }
1567     td->td_gd = gd;
1568     cpu_sfence();
1569     td->td_flags &= ~TDF_MIGRATING;
1570     KKASSERT(td->td_lwp == NULL || (td->td_lwp->lwp_flag & LWP_ONRUNQ) == 0);
1571     _lwkt_enqueue(td);
1572 }
1573 #endif
1574
1575 struct lwp *
1576 lwkt_preempted_proc(void)
1577 {
1578     thread_t td = curthread;
1579     while (td->td_preempted)
1580         td = td->td_preempted;
1581     return(td->td_lwp);
1582 }
1583
1584 /*
1585  * Create a kernel process/thread/whatever.  It shares it's address space
1586  * with proc0 - ie: kernel only.
1587  *
1588  * NOTE!  By default new threads are created with the MP lock held.  A 
1589  * thread which does not require the MP lock should release it by calling
1590  * rel_mplock() at the start of the new thread.
1591  */
1592 int
1593 lwkt_create(void (*func)(void *), void *arg, struct thread **tdp,
1594             thread_t template, int tdflags, int cpu, const char *fmt, ...)
1595 {
1596     thread_t td;
1597     __va_list ap;
1598
1599     td = lwkt_alloc_thread(template, LWKT_THREAD_STACK, cpu,
1600                            tdflags);
1601     if (tdp)
1602         *tdp = td;
1603     cpu_set_thread_handler(td, lwkt_exit, func, arg);
1604
1605     /*
1606      * Set up arg0 for 'ps' etc
1607      */
1608     __va_start(ap, fmt);
1609     kvsnprintf(td->td_comm, sizeof(td->td_comm), fmt, ap);
1610     __va_end(ap);
1611
1612     /*
1613      * Schedule the thread to run
1614      */
1615     if ((td->td_flags & TDF_STOPREQ) == 0)
1616         lwkt_schedule(td);
1617     else
1618         td->td_flags &= ~TDF_STOPREQ;
1619     return 0;
1620 }
1621
1622 /*
1623  * Destroy an LWKT thread.   Warning!  This function is not called when
1624  * a process exits, cpu_proc_exit() directly calls cpu_thread_exit() and
1625  * uses a different reaping mechanism.
1626  */
1627 void
1628 lwkt_exit(void)
1629 {
1630     thread_t td = curthread;
1631     thread_t std;
1632     globaldata_t gd;
1633
1634     if (td->td_flags & TDF_VERBOSE)
1635         kprintf("kthread %p %s has exited\n", td, td->td_comm);
1636     caps_exit(td);
1637
1638     /*
1639      * Get us into a critical section to interlock gd_freetd and loop
1640      * until we can get it freed.
1641      *
1642      * We have to cache the current td in gd_freetd because objcache_put()ing
1643      * it would rip it out from under us while our thread is still active.
1644      */
1645     gd = mycpu;
1646     crit_enter_quick(td);
1647     while ((std = gd->gd_freetd) != NULL) {
1648         gd->gd_freetd = NULL;
1649         objcache_put(thread_cache, std);
1650     }
1651
1652     /*
1653      * Remove thread resources from kernel lists and deschedule us for
1654      * the last time.
1655      */
1656     if (td->td_flags & TDF_TSLEEPQ)
1657         tsleep_remove(td);
1658     biosched_done(td);
1659     dsched_exit_thread(td);
1660     lwkt_deschedule_self(td);
1661     lwkt_remove_tdallq(td);
1662     if (td->td_flags & TDF_ALLOCATED_THREAD)
1663         gd->gd_freetd = td;
1664     cpu_thread_exit();
1665 }
1666
1667 void
1668 lwkt_remove_tdallq(thread_t td)
1669 {
1670     KKASSERT(td->td_gd == mycpu);
1671     TAILQ_REMOVE(&td->td_gd->gd_tdallq, td, td_allq);
1672 }
1673
1674 /*
1675  * Code reduction and branch prediction improvements.  Call/return
1676  * overhead on modern cpus often degenerates into 0 cycles due to
1677  * the cpu's branch prediction hardware and return pc cache.  We
1678  * can take advantage of this by not inlining medium-complexity
1679  * functions and we can also reduce the branch prediction impact
1680  * by collapsing perfectly predictable branches into a single
1681  * procedure instead of duplicating it.
1682  *
1683  * Is any of this noticeable?  Probably not, so I'll take the
1684  * smaller code size.
1685  */
1686 void
1687 crit_exit_wrapper(__DEBUG_CRIT_ARG__)
1688 {
1689     _crit_exit(mycpu __DEBUG_CRIT_PASS_ARG__);
1690 }
1691
1692 void
1693 crit_panic(void)
1694 {
1695     thread_t td = curthread;
1696     int lcrit = td->td_critcount;
1697
1698     td->td_critcount = 0;
1699     panic("td_critcount is/would-go negative! %p %d", td, lcrit);
1700     /* NOT REACHED */
1701 }
1702
1703 #ifdef SMP
1704
1705 /*
1706  * Called from debugger/panic on cpus which have been stopped.  We must still
1707  * process the IPIQ while stopped, even if we were stopped while in a critical
1708  * section (XXX).
1709  *
1710  * If we are dumping also try to process any pending interrupts.  This may
1711  * or may not work depending on the state of the cpu at the point it was
1712  * stopped.
1713  */
1714 void
1715 lwkt_smp_stopped(void)
1716 {
1717     globaldata_t gd = mycpu;
1718
1719     crit_enter_gd(gd);
1720     if (dumping) {
1721         lwkt_process_ipiq();
1722         splz();
1723     } else {
1724         lwkt_process_ipiq();
1725     }
1726     crit_exit_gd(gd);
1727 }
1728
1729 #endif