kernel - All lwkt thread now start out mpsafe part 1/2
[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 void
372 lwkt_init_thread(thread_t td, void *stack, int stksize, int flags,
373                 struct globaldata *gd)
374 {
375     globaldata_t mygd = mycpu;
376
377     /* all threads start mpsafe now */
378     KKASSERT(flags & TDF_MPSAFE);
379
380     bzero(td, sizeof(struct thread));
381     td->td_kstack = stack;
382     td->td_kstack_size = stksize;
383     td->td_flags = flags;
384     td->td_gd = gd;
385     td->td_pri = TDPRI_KERN_DAEMON;
386     td->td_critcount = 1;
387     td->td_toks_stop = &td->td_toks_base;
388 #ifdef SMP
389     if ((flags & TDF_MPSAFE) == 0)
390         td->td_mpcount = 1;
391 #endif
392     if (lwkt_use_spin_port)
393         lwkt_initport_spin(&td->td_msgport);
394     else
395         lwkt_initport_thread(&td->td_msgport, td);
396     pmap_init_thread(td);
397 #ifdef SMP
398     /*
399      * Normally initializing a thread for a remote cpu requires sending an
400      * IPI.  However, the idlethread is setup before the other cpus are
401      * activated so we have to treat it as a special case.  XXX manipulation
402      * of gd_tdallq requires the BGL.
403      */
404     if (gd == mygd || td == &gd->gd_idlethread) {
405         crit_enter_gd(mygd);
406         TAILQ_INSERT_TAIL(&gd->gd_tdallq, td, td_allq);
407         crit_exit_gd(mygd);
408     } else {
409         lwkt_send_ipiq(gd, lwkt_init_thread_remote, td);
410     }
411 #else
412     crit_enter_gd(mygd);
413     TAILQ_INSERT_TAIL(&gd->gd_tdallq, td, td_allq);
414     crit_exit_gd(mygd);
415 #endif
416
417     dsched_new_thread(td);
418 }
419
420 void
421 lwkt_set_comm(thread_t td, const char *ctl, ...)
422 {
423     __va_list va;
424
425     __va_start(va, ctl);
426     kvsnprintf(td->td_comm, sizeof(td->td_comm), ctl, va);
427     __va_end(va);
428     KTR_LOG(ctxsw_newtd, td, &td->td_comm[0]);
429 }
430
431 void
432 lwkt_hold(thread_t td)
433 {
434     ++td->td_refs;
435 }
436
437 void
438 lwkt_rele(thread_t td)
439 {
440     KKASSERT(td->td_refs > 0);
441     --td->td_refs;
442 }
443
444 void
445 lwkt_wait_free(thread_t td)
446 {
447     while (td->td_refs)
448         tsleep(td, 0, "tdreap", hz);
449 }
450
451 void
452 lwkt_free_thread(thread_t td)
453 {
454     KASSERT((td->td_flags & TDF_RUNNING) == 0,
455         ("lwkt_free_thread: did not exit! %p", td));
456
457     if (td->td_flags & TDF_ALLOCATED_THREAD) {
458         objcache_put(thread_cache, td);
459     } else if (td->td_flags & TDF_ALLOCATED_STACK) {
460         /* client-allocated struct with internally allocated stack */
461         KASSERT(td->td_kstack && td->td_kstack_size > 0,
462             ("lwkt_free_thread: corrupted stack"));
463         kmem_free(&kernel_map, (vm_offset_t)td->td_kstack, td->td_kstack_size);
464         td->td_kstack = NULL;
465         td->td_kstack_size = 0;
466     }
467     KTR_LOG(ctxsw_deadtd, td);
468 }
469
470
471 /*
472  * Switch to the next runnable lwkt.  If no LWKTs are runnable then 
473  * switch to the idlethread.  Switching must occur within a critical
474  * section to avoid races with the scheduling queue.
475  *
476  * We always have full control over our cpu's run queue.  Other cpus
477  * that wish to manipulate our queue must use the cpu_*msg() calls to
478  * talk to our cpu, so a critical section is all that is needed and
479  * the result is very, very fast thread switching.
480  *
481  * The LWKT scheduler uses a fixed priority model and round-robins at
482  * each priority level.  User process scheduling is a totally
483  * different beast and LWKT priorities should not be confused with
484  * user process priorities.
485  *
486  * The MP lock may be out of sync with the thread's td_mpcount.  lwkt_switch()
487  * cleans it up.  Note that the td_switch() function cannot do anything that
488  * requires the MP lock since the MP lock will have already been setup for
489  * the target thread (not the current thread).  It's nice to have a scheduler
490  * that does not need the MP lock to work because it allows us to do some
491  * really cool high-performance MP lock optimizations.
492  *
493  * PREEMPTION NOTE: Preemption occurs via lwkt_preempt().  lwkt_switch()
494  * is not called by the current thread in the preemption case, only when
495  * the preempting thread blocks (in order to return to the original thread).
496  */
497 void
498 lwkt_switch(void)
499 {
500     globaldata_t gd = mycpu;
501     thread_t td = gd->gd_curthread;
502     thread_t ntd;
503     thread_t xtd;
504     thread_t nlast;
505     int nquserok;
506 #ifdef SMP
507     int mpheld;
508 #endif
509     int didaccumulate;
510     const char *lmsg;   /* diagnostic - 'systat -pv 1' */
511     const void *laddr;
512
513     /*
514      * Switching from within a 'fast' (non thread switched) interrupt or IPI
515      * is illegal.  However, we may have to do it anyway if we hit a fatal
516      * kernel trap or we have paniced.
517      *
518      * If this case occurs save and restore the interrupt nesting level.
519      */
520     if (gd->gd_intr_nesting_level) {
521         int savegdnest;
522         int savegdtrap;
523
524         if (gd->gd_trap_nesting_level == 0 && panicstr == NULL) {
525             panic("lwkt_switch: cannot switch from within "
526                   "a fast interrupt, yet, td %p\n", 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 or IPI, "
535                         "thread %p (%s)\n", td, td->td_comm);
536                 print_backtrace(-1);
537             }
538             lwkt_switch();
539             gd->gd_intr_nesting_level = savegdnest;
540             gd->gd_trap_nesting_level = savegdtrap;
541             return;
542         }
543     }
544
545     /*
546      * Passive release (used to transition from user to kernel mode
547      * when we block or switch rather then when we enter the kernel).
548      * This function is NOT called if we are switching into a preemption
549      * or returning from a preemption.  Typically this causes us to lose
550      * our current process designation (if we have one) and become a true
551      * LWKT thread, and may also hand the current process designation to
552      * another process and schedule thread.
553      */
554     if (td->td_release)
555             td->td_release(td);
556
557     crit_enter_gd(gd);
558     if (TD_TOKS_HELD(td))
559             lwkt_relalltokens(td);
560
561     /*
562      * We had better not be holding any spin locks, but don't get into an
563      * endless panic loop.
564      */
565     KASSERT(gd->gd_spinlock_rd == NULL || panicstr != NULL, 
566             ("lwkt_switch: still holding a shared spinlock %p!", 
567              gd->gd_spinlock_rd));
568     KASSERT(gd->gd_spinlocks_wr == 0 || panicstr != NULL, 
569             ("lwkt_switch: still holding %d exclusive spinlocks!",
570              gd->gd_spinlocks_wr));
571
572
573 #ifdef SMP
574     /*
575      * td_mpcount cannot be used to determine if we currently hold the
576      * MP lock because get_mplock() will increment it prior to attempting
577      * to get the lock, and switch out if it can't.  Our ownership of 
578      * the actual lock will remain stable while we are in a critical section
579      * (but, of course, another cpu may own or release the lock so the
580      * actual value of mp_lock is not stable).
581      */
582     mpheld = MP_LOCK_HELD(gd);
583 #ifdef  INVARIANTS
584     if (td->td_cscount) {
585         kprintf("Diagnostic: attempt to switch while mastering cpusync: %p\n",
586                 td);
587         if (panic_on_cscount)
588             panic("switching while mastering cpusync");
589     }
590 #endif
591 #endif
592
593     /*
594      * If we had preempted another thread on this cpu, resume the preempted
595      * thread.  This occurs transparently, whether the preempted thread
596      * was scheduled or not (it may have been preempted after descheduling
597      * itself).
598      *
599      * We have to setup the MP lock for the original thread after backing
600      * out the adjustment that was made to curthread when the original
601      * was preempted.
602      */
603     if ((ntd = td->td_preempted) != NULL) {
604         KKASSERT(ntd->td_flags & TDF_PREEMPT_LOCK);
605 #ifdef SMP
606         if (ntd->td_mpcount && mpheld == 0) {
607             panic("MPLOCK NOT HELD ON RETURN: %p %p %d %d",
608                td, ntd, td->td_mpcount, ntd->td_mpcount);
609         }
610         if (ntd->td_mpcount) {
611             td->td_mpcount -= ntd->td_mpcount;
612             KKASSERT(td->td_mpcount >= 0);
613         }
614 #endif
615         ntd->td_flags |= TDF_PREEMPT_DONE;
616
617         /*
618          * The interrupt may have woken a thread up, we need to properly
619          * set the reschedule flag if the originally interrupted thread is
620          * at a lower priority.
621          */
622         if (TAILQ_FIRST(&gd->gd_tdrunq) &&
623             TAILQ_FIRST(&gd->gd_tdrunq)->td_pri > ntd->td_pri) {
624             need_lwkt_resched();
625         }
626         /* YYY release mp lock on switchback if original doesn't need it */
627         goto havethread_preempted;
628     }
629
630     /*
631      * Implement round-robin fairq with priority insertion.  The priority
632      * insertion is handled by _lwkt_enqueue()
633      *
634      * We have to adjust the MP lock for the target thread.  If we
635      * need the MP lock and cannot obtain it we try to locate a
636      * thread that does not need the MP lock.  If we cannot, we spin
637      * instead of HLT.
638      *
639      * A similar issue exists for the tokens held by the target thread.
640      * If we cannot obtain ownership of the tokens we cannot immediately
641      * schedule the thread.
642      */
643     for (;;) {
644         clear_lwkt_resched();
645         didaccumulate = 0;
646         ntd = TAILQ_FIRST(&gd->gd_tdrunq);
647
648         /*
649          * Hotpath if we can get all necessary resources.
650          *
651          * If nothing is runnable switch to the idle thread
652          */
653         if (ntd == NULL) {
654             ntd = &gd->gd_idlethread;
655             if (gd->gd_reqflags & RQF_IDLECHECK_MASK)
656                     ntd->td_flags |= TDF_IDLE_NOHLT;
657 #ifdef SMP
658             if (ntd->td_mpcount) {
659                 if (gd->gd_trap_nesting_level == 0 && panicstr == NULL)
660                     panic("Idle thread %p was holding the BGL!", ntd);
661                 if (mpheld == 0) {
662                     set_cpu_contention_mask(gd);
663                     handle_cpu_contention_mask();
664                     cpu_try_mplock();
665                     mpheld = MP_LOCK_HELD(gd);
666                     cpu_pause();
667                     continue;
668                 }
669             }
670             clr_cpu_contention_mask(gd);
671 #endif
672             cpu_time.cp_msg[0] = 0;
673             cpu_time.cp_stallpc = 0;
674             goto haveidle;
675         }
676
677         /*
678          * Hotpath schedule
679          *
680          * NOTE: For UP there is no mplock and lwkt_getalltokens()
681          *           always succeeds.
682          */
683         if (ntd->td_fairq_accum >= 0 &&
684 #ifdef SMP
685             (ntd->td_mpcount == 0 || mpheld || cpu_try_mplock()) &&
686 #endif
687             (!TD_TOKS_HELD(ntd) || lwkt_getalltokens(ntd, &lmsg, &laddr))
688         ) {
689 #ifdef SMP
690             clr_cpu_contention_mask(gd);
691 #endif
692             goto havethread;
693         }
694
695         lmsg = NULL;
696         laddr = NULL;
697
698 #ifdef SMP
699         if (ntd->td_fairq_accum >= 0)
700                 set_cpu_contention_mask(gd);
701         /* Reload mpheld (it become stale after mplock/token ops) */
702         mpheld = MP_LOCK_HELD(gd);
703         if (ntd->td_mpcount && mpheld == 0) {
704             lmsg = "mplock";
705             laddr = ntd->td_mplock_stallpc;
706         }
707 #endif
708
709         /*
710          * Coldpath - unable to schedule ntd, continue looking for threads
711          * to schedule.  This is only allowed of the (presumably) kernel
712          * thread exhausted its fair share.  A kernel thread stuck on
713          * resources does not currently allow a user thread to get in
714          * front of it.
715          */
716 #ifdef SMP
717         nquserok = ((ntd->td_pri < TDPRI_KERN_LPSCHED) ||
718                     (ntd->td_fairq_accum < 0));
719 #else
720         nquserok = 1;
721 #endif
722         nlast = NULL;
723
724         for (;;) {
725             /*
726              * If the fair-share scheduler ran out ntd gets moved to the
727              * end and its accumulator will be bumped, if it didn't we
728              * maintain the same queue position.
729              *
730              * nlast keeps track of the last element prior to any moves.
731              */
732             if (ntd->td_fairq_accum < 0) {
733                 lwkt_fairq_accumulate(gd, ntd);
734                 didaccumulate = 1;
735
736                 /*
737                  * Move to end
738                  */
739                 xtd = TAILQ_NEXT(ntd, td_threadq);
740                 TAILQ_REMOVE(&gd->gd_tdrunq, ntd, td_threadq);
741                 TAILQ_INSERT_TAIL(&gd->gd_tdrunq, ntd, td_threadq);
742
743                 /*
744                  * Set terminal element (nlast)
745                  */
746                 if (nlast == NULL) {
747                     nlast = ntd;
748                     if (xtd == NULL)
749                         xtd = ntd;
750                 }
751                 ntd = xtd;
752             } else {
753                 ntd = TAILQ_NEXT(ntd, td_threadq);
754             }
755
756             /*
757              * If we exhausted the run list switch to the idle thread.
758              * Since one or more threads had resource acquisition issues
759              * we do not allow the idle thread to halt.
760              *
761              * NOTE: nlast can be NULL.
762              */
763             if (ntd == nlast) {
764                 cpu_pause();
765                 ntd = &gd->gd_idlethread;
766                 ntd->td_flags |= TDF_IDLE_NOHLT;
767 #ifdef SMP
768                 if (ntd->td_mpcount) {
769                     mpheld = MP_LOCK_HELD(gd);
770                     if (gd->gd_trap_nesting_level == 0 && panicstr == NULL)
771                         panic("Idle thread %p was holding the BGL!", ntd);
772                     if (mpheld == 0) {
773                         set_cpu_contention_mask(gd);
774                         handle_cpu_contention_mask();
775                         cpu_try_mplock();
776                         mpheld = MP_LOCK_HELD(gd);
777                         cpu_pause();
778                         break;          /* try again from the top, almost */
779                     }
780                 }
781 #endif
782
783                 /*
784                  * If fairq accumulations occured we do not schedule the
785                  * idle thread.  This will cause us to try again from
786                  * the (almost) top.
787                  */
788                 if (didaccumulate)
789                         break;          /* try again from the top, almost */
790                 if (lmsg)
791                     strlcpy(cpu_time.cp_msg, lmsg, sizeof(cpu_time.cp_msg));
792                 cpu_time.cp_stallpc = (uintptr_t)laddr;
793                 goto haveidle;
794             }
795
796             /*
797              * Try to switch to this thread.
798              *
799              * NOTE: For UP there is no mplock and lwkt_getalltokens()
800              *       always succeeds.
801              */
802             if ((ntd->td_pri >= TDPRI_KERN_LPSCHED || nquserok ||
803                 user_pri_sched) && ntd->td_fairq_accum >= 0 &&
804 #ifdef SMP
805                 (ntd->td_mpcount == 0 || mpheld || cpu_try_mplock()) &&
806 #endif
807                 (!TD_TOKS_HELD(ntd) || lwkt_getalltokens(ntd, &lmsg, &laddr))
808             ) {
809 #ifdef SMP
810                     clr_cpu_contention_mask(gd);
811 #endif
812                     goto havethread;
813             }
814 #ifdef SMP
815             if (ntd->td_fairq_accum >= 0)
816                     set_cpu_contention_mask(gd);
817             /*
818              * Reload mpheld (it become stale after mplock/token ops).
819              */
820             mpheld = MP_LOCK_HELD(gd);
821             if (ntd->td_mpcount && mpheld == 0) {
822                 lmsg = "mplock";
823                 laddr = ntd->td_mplock_stallpc;
824             }
825             if (ntd->td_pri >= TDPRI_KERN_LPSCHED && ntd->td_fairq_accum >= 0)
826                 nquserok = 0;
827 #endif
828         }
829
830         /*
831          * All threads exhausted but we can loop due to a negative
832          * accumulator.
833          *
834          * While we are looping in the scheduler be sure to service
835          * any interrupts which were made pending due to our critical
836          * section, otherwise we could livelock (e.g.) IPIs.
837          *
838          * NOTE: splz can enter and exit the mplock so mpheld is
839          * stale after this call.
840          */
841         splz_check();
842
843 #ifdef SMP
844         /*
845          * Our mplock can be cached and cause other cpus to livelock
846          * if we loop due to e.g. not being able to acquire tokens.
847          */
848         if (MP_LOCK_HELD(gd))
849             cpu_rel_mplock(gd->gd_cpuid);
850         mpheld = 0;
851 #endif
852     }
853
854     /*
855      * Do the actual switch.  WARNING: mpheld is stale here.
856      *
857      * We must always decrement td_fairq_accum on non-idle threads just
858      * in case a thread never gets a tick due to being in a continuous
859      * critical section.  The page-zeroing code does that.
860      *
861      * If the thread we came up with is a higher or equal priority verses
862      * the thread at the head of the queue we move our thread to the
863      * front.  This way we can always check the front of the queue.
864      */
865 havethread:
866     ++gd->gd_cnt.v_swtch;
867     --ntd->td_fairq_accum;
868     xtd = TAILQ_FIRST(&gd->gd_tdrunq);
869     if (ntd != xtd && ntd->td_pri >= xtd->td_pri) {
870         TAILQ_REMOVE(&gd->gd_tdrunq, ntd, td_threadq);
871         TAILQ_INSERT_HEAD(&gd->gd_tdrunq, ntd, td_threadq);
872     }
873 havethread_preempted:
874     ;
875     /*
876      * If the new target does not need the MP lock and we are holding it,
877      * release the MP lock.  If the new target requires the MP lock we have
878      * already acquired it for the target.
879      *
880      * WARNING: mpheld is stale here.
881      */
882 haveidle:
883     KASSERT(ntd->td_critcount,
884             ("priority problem in lwkt_switch %d %d", td->td_pri, ntd->td_pri));
885 #ifdef SMP
886     if (ntd->td_mpcount == 0 ) {
887         if (MP_LOCK_HELD(gd))
888             cpu_rel_mplock(gd->gd_cpuid);
889     } else {
890         ASSERT_MP_LOCK_HELD(ntd);
891     }
892 #endif
893     if (td != ntd) {
894         ++switch_count;
895 #ifdef __x86_64__
896         {
897             int tos_ok __debugvar = jg_tos_ok(ntd);
898             KKASSERT(tos_ok);
899         }
900 #endif
901         KTR_LOG(ctxsw_sw, gd->gd_cpuid, ntd);
902         td->td_switch(ntd);
903     }
904     /* NOTE: current cpu may have changed after switch */
905     crit_exit_quick(td);
906 }
907
908 /*
909  * Request that the target thread preempt the current thread.  Preemption
910  * only works under a specific set of conditions:
911  *
912  *      - We are not preempting ourselves
913  *      - The target thread is owned by the current cpu
914  *      - We are not currently being preempted
915  *      - The target is not currently being preempted
916  *      - We are not holding any spin locks
917  *      - The target thread is not holding any tokens
918  *      - We are able to satisfy the target's MP lock requirements (if any).
919  *
920  * THE CALLER OF LWKT_PREEMPT() MUST BE IN A CRITICAL SECTION.  Typically
921  * this is called via lwkt_schedule() through the td_preemptable callback.
922  * critcount is the managed critical priority that we should ignore in order
923  * to determine whether preemption is possible (aka usually just the crit
924  * priority of lwkt_schedule() itself).
925  *
926  * XXX at the moment we run the target thread in a critical section during
927  * the preemption in order to prevent the target from taking interrupts
928  * that *WE* can't.  Preemption is strictly limited to interrupt threads
929  * and interrupt-like threads, outside of a critical section, and the
930  * preempted source thread will be resumed the instant the target blocks
931  * whether or not the source is scheduled (i.e. preemption is supposed to
932  * be as transparent as possible).
933  *
934  * The target thread inherits our MP count (added to its own) for the
935  * duration of the preemption in order to preserve the atomicy of the
936  * MP lock during the preemption.  Therefore, any preempting targets must be
937  * careful in regards to MP assertions.  Note that the MP count may be
938  * out of sync with the physical mp_lock, but we do not have to preserve
939  * the original ownership of the lock if it was out of synch (that is, we
940  * can leave it synchronized on return).
941  */
942 void
943 lwkt_preempt(thread_t ntd, int critcount)
944 {
945     struct globaldata *gd = mycpu;
946     thread_t td;
947 #ifdef SMP
948     int mpheld;
949     int savecnt;
950 #endif
951
952     /*
953      * The caller has put us in a critical section.  We can only preempt
954      * if the caller of the caller was not in a critical section (basically
955      * a local interrupt), as determined by the 'critcount' parameter.  We
956      * also can't preempt if the caller is holding any spinlocks (even if
957      * he isn't in a critical section).  This also handles the tokens test.
958      *
959      * YYY The target thread must be in a critical section (else it must
960      * inherit our critical section?  I dunno yet).
961      *
962      * Set need_lwkt_resched() unconditionally for now YYY.
963      */
964     KASSERT(ntd->td_critcount, ("BADCRIT0 %d", ntd->td_pri));
965
966     td = gd->gd_curthread;
967     if (ntd->td_pri <= td->td_pri) {
968         ++preempt_miss;
969         return;
970     }
971     if (td->td_critcount > critcount) {
972         ++preempt_miss;
973         need_lwkt_resched();
974         return;
975     }
976 #ifdef SMP
977     if (ntd->td_gd != gd) {
978         ++preempt_miss;
979         need_lwkt_resched();
980         return;
981     }
982 #endif
983     /*
984      * We don't have to check spinlocks here as they will also bump
985      * td_critcount.
986      *
987      * Do not try to preempt if the target thread is holding any tokens.
988      * We could try to acquire the tokens but this case is so rare there
989      * is no need to support it.
990      */
991     KKASSERT(gd->gd_spinlock_rd == NULL);
992     KKASSERT(gd->gd_spinlocks_wr == 0);
993
994     if (TD_TOKS_HELD(ntd)) {
995         ++preempt_miss;
996         need_lwkt_resched();
997         return;
998     }
999     if (td == ntd || ((td->td_flags | ntd->td_flags) & TDF_PREEMPT_LOCK)) {
1000         ++preempt_weird;
1001         need_lwkt_resched();
1002         return;
1003     }
1004     if (ntd->td_preempted) {
1005         ++preempt_hit;
1006         need_lwkt_resched();
1007         return;
1008     }
1009 #ifdef SMP
1010     /*
1011      * note: an interrupt might have occured just as we were transitioning
1012      * to or from the MP lock.  In this case td_mpcount will be pre-disposed
1013      * (non-zero) but not actually synchronized with the actual state of the
1014      * lock.  We can use it to imply an MP lock requirement for the
1015      * preemption but we cannot use it to test whether we hold the MP lock
1016      * or not.
1017      */
1018     savecnt = td->td_mpcount;
1019     mpheld = MP_LOCK_HELD(gd);
1020     ntd->td_mpcount += td->td_mpcount;
1021     if (mpheld == 0 && ntd->td_mpcount && !cpu_try_mplock()) {
1022         ntd->td_mpcount -= td->td_mpcount;
1023         ++preempt_miss;
1024         need_lwkt_resched();
1025         return;
1026     }
1027 #endif
1028
1029     /*
1030      * Since we are able to preempt the current thread, there is no need to
1031      * call need_lwkt_resched().
1032      */
1033     ++preempt_hit;
1034     ntd->td_preempted = td;
1035     td->td_flags |= TDF_PREEMPT_LOCK;
1036     KTR_LOG(ctxsw_pre, gd->gd_cpuid, ntd);
1037     td->td_switch(ntd);
1038
1039     KKASSERT(ntd->td_preempted && (td->td_flags & TDF_PREEMPT_DONE));
1040 #ifdef SMP
1041     KKASSERT(savecnt == td->td_mpcount);
1042     mpheld = MP_LOCK_HELD(gd);
1043     if (mpheld && td->td_mpcount == 0)
1044         cpu_rel_mplock(gd->gd_cpuid);
1045     else if (mpheld == 0 && td->td_mpcount)
1046         panic("lwkt_preempt(): MP lock was not held through");
1047 #endif
1048     ntd->td_preempted = NULL;
1049     td->td_flags &= ~(TDF_PREEMPT_LOCK|TDF_PREEMPT_DONE);
1050 }
1051
1052 /*
1053  * Conditionally call splz() if gd_reqflags indicates work is pending.
1054  *
1055  * td_nest_count prevents deep nesting via splz() or doreti() which
1056  * might otherwise blow out the kernel stack.  Note that except for
1057  * this special case, we MUST call splz() here to handle any
1058  * pending ints, particularly after we switch, or we might accidently
1059  * halt the cpu with interrupts pending.
1060  *
1061  * (self contained on a per cpu basis)
1062  */
1063 void
1064 splz_check(void)
1065 {
1066     globaldata_t gd = mycpu;
1067     thread_t td = gd->gd_curthread;
1068
1069     if ((gd->gd_reqflags & RQF_IDLECHECK_MASK) && td->td_nest_count < 2)
1070         splz();
1071 }
1072
1073 /*
1074  * This function is used to negotiate a passive release of the current
1075  * process/lwp designation with the user scheduler, allowing the user
1076  * scheduler to schedule another user thread.  The related kernel thread
1077  * (curthread) continues running in the released state.
1078  */
1079 void
1080 lwkt_passive_release(struct thread *td)
1081 {
1082     struct lwp *lp = td->td_lwp;
1083
1084     td->td_release = NULL;
1085     lwkt_setpri_self(TDPRI_KERN_USER);
1086     lp->lwp_proc->p_usched->release_curproc(lp);
1087 }
1088
1089
1090 /*
1091  * This implements a normal yield.  This routine is virtually a nop if
1092  * there is nothing to yield to but it will always run any pending interrupts
1093  * if called from a critical section.
1094  *
1095  * This yield is designed for kernel threads without a user context.
1096  *
1097  * (self contained on a per cpu basis)
1098  */
1099 void
1100 lwkt_yield(void)
1101 {
1102     globaldata_t gd = mycpu;
1103     thread_t td = gd->gd_curthread;
1104     thread_t xtd;
1105
1106     if ((gd->gd_reqflags & RQF_IDLECHECK_MASK) && td->td_nest_count < 2)
1107         splz();
1108     if (td->td_fairq_accum < 0) {
1109         lwkt_schedule_self(curthread);
1110         lwkt_switch();
1111     } else {
1112         xtd = TAILQ_FIRST(&gd->gd_tdrunq);
1113         if (xtd && xtd->td_pri > td->td_pri) {
1114             lwkt_schedule_self(curthread);
1115             lwkt_switch();
1116         }
1117     }
1118 }
1119
1120 /*
1121  * This yield is designed for kernel threads with a user context.
1122  *
1123  * The kernel acting on behalf of the user is potentially cpu-bound,
1124  * this function will efficiently allow other threads to run and also
1125  * switch to other processes by releasing.
1126  *
1127  * The lwkt_user_yield() function is designed to have very low overhead
1128  * if no yield is determined to be needed.
1129  */
1130 void
1131 lwkt_user_yield(void)
1132 {
1133     globaldata_t gd = mycpu;
1134     thread_t td = gd->gd_curthread;
1135
1136     /*
1137      * Always run any pending interrupts in case we are in a critical
1138      * section.
1139      */
1140     if ((gd->gd_reqflags & RQF_IDLECHECK_MASK) && td->td_nest_count < 2)
1141         splz();
1142
1143 #ifdef SMP
1144     /*
1145      * XXX SEVERE TEMPORARY HACK.  A cpu-bound operation running in the
1146      * kernel can prevent other cpus from servicing interrupt threads
1147      * which still require the MP lock (which is a lot of them).  This
1148      * has a chaining effect since if the interrupt is blocked, so is
1149      * the event, so normal scheduling will not pick up on the problem.
1150      */
1151     if (cpu_contention_mask && td->td_mpcount) {
1152         yield_mplock(td);
1153     }
1154 #endif
1155
1156     /*
1157      * Switch (which forces a release) if another kernel thread needs
1158      * the cpu, if userland wants us to resched, or if our kernel
1159      * quantum has run out.
1160      */
1161     if (lwkt_resched_wanted() ||
1162         user_resched_wanted() ||
1163         td->td_fairq_accum < 0)
1164     {
1165         lwkt_switch();
1166     }
1167
1168 #if 0
1169     /*
1170      * Reacquire the current process if we are released.
1171      *
1172      * XXX not implemented atm.  The kernel may be holding locks and such,
1173      *     so we want the thread to continue to receive cpu.
1174      */
1175     if (td->td_release == NULL && lp) {
1176         lp->lwp_proc->p_usched->acquire_curproc(lp);
1177         td->td_release = lwkt_passive_release;
1178         lwkt_setpri_self(TDPRI_USER_NORM);
1179     }
1180 #endif
1181 }
1182
1183 /*
1184  * Generic schedule.  Possibly schedule threads belonging to other cpus and
1185  * deal with threads that might be blocked on a wait queue.
1186  *
1187  * We have a little helper inline function which does additional work after
1188  * the thread has been enqueued, including dealing with preemption and
1189  * setting need_lwkt_resched() (which prevents the kernel from returning
1190  * to userland until it has processed higher priority threads).
1191  *
1192  * It is possible for this routine to be called after a failed _enqueue
1193  * (due to the target thread migrating, sleeping, or otherwise blocked).
1194  * We have to check that the thread is actually on the run queue!
1195  *
1196  * reschedok is an optimized constant propagated from lwkt_schedule() or
1197  * lwkt_schedule_noresched().  By default it is non-zero, causing a
1198  * reschedule to be requested if the target thread has a higher priority.
1199  * The port messaging code will set MSG_NORESCHED and cause reschedok to
1200  * be 0, prevented undesired reschedules.
1201  */
1202 static __inline
1203 void
1204 _lwkt_schedule_post(globaldata_t gd, thread_t ntd, int ccount, int reschedok)
1205 {
1206     thread_t otd;
1207
1208     if (ntd->td_flags & TDF_RUNQ) {
1209         if (ntd->td_preemptable && reschedok) {
1210             ntd->td_preemptable(ntd, ccount);   /* YYY +token */
1211         } else if (reschedok) {
1212             otd = curthread;
1213             if (ntd->td_pri > otd->td_pri)
1214                 need_lwkt_resched();
1215         }
1216
1217         /*
1218          * Give the thread a little fair share scheduler bump if it
1219          * has been asleep for a while.  This is primarily to avoid
1220          * a degenerate case for interrupt threads where accumulator
1221          * crosses into negative territory unnecessarily.
1222          */
1223         if (ntd->td_fairq_lticks != ticks) {
1224             ntd->td_fairq_lticks = ticks;
1225             ntd->td_fairq_accum += gd->gd_fairq_total_pri;
1226             if (ntd->td_fairq_accum > TDFAIRQ_MAX(gd))
1227                     ntd->td_fairq_accum = TDFAIRQ_MAX(gd);
1228         }
1229     }
1230 }
1231
1232 static __inline
1233 void
1234 _lwkt_schedule(thread_t td, int reschedok)
1235 {
1236     globaldata_t mygd = mycpu;
1237
1238     KASSERT(td != &td->td_gd->gd_idlethread, ("lwkt_schedule(): scheduling gd_idlethread is illegal!"));
1239     crit_enter_gd(mygd);
1240     KKASSERT(td->td_lwp == NULL || (td->td_lwp->lwp_flag & LWP_ONRUNQ) == 0);
1241     if (td == mygd->gd_curthread) {
1242         _lwkt_enqueue(td);
1243     } else {
1244         /*
1245          * If we own the thread, there is no race (since we are in a
1246          * critical section).  If we do not own the thread there might
1247          * be a race but the target cpu will deal with it.
1248          */
1249 #ifdef SMP
1250         if (td->td_gd == mygd) {
1251             _lwkt_enqueue(td);
1252             _lwkt_schedule_post(mygd, td, 1, reschedok);
1253         } else {
1254             lwkt_send_ipiq3(td->td_gd, lwkt_schedule_remote, td, 0);
1255         }
1256 #else
1257         _lwkt_enqueue(td);
1258         _lwkt_schedule_post(mygd, td, 1, reschedok);
1259 #endif
1260     }
1261     crit_exit_gd(mygd);
1262 }
1263
1264 void
1265 lwkt_schedule(thread_t td)
1266 {
1267     _lwkt_schedule(td, 1);
1268 }
1269
1270 void
1271 lwkt_schedule_noresched(thread_t td)
1272 {
1273     _lwkt_schedule(td, 0);
1274 }
1275
1276 #ifdef SMP
1277
1278 /*
1279  * When scheduled remotely if frame != NULL the IPIQ is being
1280  * run via doreti or an interrupt then preemption can be allowed.
1281  *
1282  * To allow preemption we have to drop the critical section so only
1283  * one is present in _lwkt_schedule_post.
1284  */
1285 static void
1286 lwkt_schedule_remote(void *arg, int arg2, struct intrframe *frame)
1287 {
1288     thread_t td = curthread;
1289     thread_t ntd = arg;
1290
1291     if (frame && ntd->td_preemptable) {
1292         crit_exit_noyield(td);
1293         _lwkt_schedule(ntd, 1);
1294         crit_enter_quick(td);
1295     } else {
1296         _lwkt_schedule(ntd, 1);
1297     }
1298 }
1299
1300 /*
1301  * Thread migration using a 'Pull' method.  The thread may or may not be
1302  * the current thread.  It MUST be descheduled and in a stable state.
1303  * lwkt_giveaway() must be called on the cpu owning the thread.
1304  *
1305  * At any point after lwkt_giveaway() is called, the target cpu may
1306  * 'pull' the thread by calling lwkt_acquire().
1307  *
1308  * We have to make sure the thread is not sitting on a per-cpu tsleep
1309  * queue or it will blow up when it moves to another cpu.
1310  *
1311  * MPSAFE - must be called under very specific conditions.
1312  */
1313 void
1314 lwkt_giveaway(thread_t td)
1315 {
1316     globaldata_t gd = mycpu;
1317
1318     crit_enter_gd(gd);
1319     if (td->td_flags & TDF_TSLEEPQ)
1320         tsleep_remove(td);
1321     KKASSERT(td->td_gd == gd);
1322     TAILQ_REMOVE(&gd->gd_tdallq, td, td_allq);
1323     td->td_flags |= TDF_MIGRATING;
1324     crit_exit_gd(gd);
1325 }
1326
1327 void
1328 lwkt_acquire(thread_t td)
1329 {
1330     globaldata_t gd;
1331     globaldata_t mygd;
1332
1333     KKASSERT(td->td_flags & TDF_MIGRATING);
1334     gd = td->td_gd;
1335     mygd = mycpu;
1336     if (gd != mycpu) {
1337         cpu_lfence();
1338         KKASSERT((td->td_flags & TDF_RUNQ) == 0);
1339         crit_enter_gd(mygd);
1340         while (td->td_flags & (TDF_RUNNING|TDF_PREEMPT_LOCK)) {
1341 #ifdef SMP
1342             lwkt_process_ipiq();
1343 #endif
1344             cpu_lfence();
1345         }
1346         td->td_gd = mygd;
1347         TAILQ_INSERT_TAIL(&mygd->gd_tdallq, td, td_allq);
1348         td->td_flags &= ~TDF_MIGRATING;
1349         crit_exit_gd(mygd);
1350     } else {
1351         crit_enter_gd(mygd);
1352         TAILQ_INSERT_TAIL(&mygd->gd_tdallq, td, td_allq);
1353         td->td_flags &= ~TDF_MIGRATING;
1354         crit_exit_gd(mygd);
1355     }
1356 }
1357
1358 #endif
1359
1360 /*
1361  * Generic deschedule.  Descheduling threads other then your own should be
1362  * done only in carefully controlled circumstances.  Descheduling is 
1363  * asynchronous.  
1364  *
1365  * This function may block if the cpu has run out of messages.
1366  */
1367 void
1368 lwkt_deschedule(thread_t td)
1369 {
1370     crit_enter();
1371 #ifdef SMP
1372     if (td == curthread) {
1373         _lwkt_dequeue(td);
1374     } else {
1375         if (td->td_gd == mycpu) {
1376             _lwkt_dequeue(td);
1377         } else {
1378             lwkt_send_ipiq(td->td_gd, (ipifunc1_t)lwkt_deschedule, td);
1379         }
1380     }
1381 #else
1382     _lwkt_dequeue(td);
1383 #endif
1384     crit_exit();
1385 }
1386
1387 /*
1388  * Set the target thread's priority.  This routine does not automatically
1389  * switch to a higher priority thread, LWKT threads are not designed for
1390  * continuous priority changes.  Yield if you want to switch.
1391  */
1392 void
1393 lwkt_setpri(thread_t td, int pri)
1394 {
1395     KKASSERT(td->td_gd == mycpu);
1396     if (td->td_pri != pri) {
1397         KKASSERT(pri >= 0);
1398         crit_enter();
1399         if (td->td_flags & TDF_RUNQ) {
1400             _lwkt_dequeue(td);
1401             td->td_pri = pri;
1402             _lwkt_enqueue(td);
1403         } else {
1404             td->td_pri = pri;
1405         }
1406         crit_exit();
1407     }
1408 }
1409
1410 /*
1411  * Set the initial priority for a thread prior to it being scheduled for
1412  * the first time.  The thread MUST NOT be scheduled before or during
1413  * this call.  The thread may be assigned to a cpu other then the current
1414  * cpu.
1415  *
1416  * Typically used after a thread has been created with TDF_STOPPREQ,
1417  * and before the thread is initially scheduled.
1418  */
1419 void
1420 lwkt_setpri_initial(thread_t td, int pri)
1421 {
1422     KKASSERT(pri >= 0);
1423     KKASSERT((td->td_flags & TDF_RUNQ) == 0);
1424     td->td_pri = pri;
1425 }
1426
1427 void
1428 lwkt_setpri_self(int pri)
1429 {
1430     thread_t td = curthread;
1431
1432     KKASSERT(pri >= 0 && pri <= TDPRI_MAX);
1433     crit_enter();
1434     if (td->td_flags & TDF_RUNQ) {
1435         _lwkt_dequeue(td);
1436         td->td_pri = pri;
1437         _lwkt_enqueue(td);
1438     } else {
1439         td->td_pri = pri;
1440     }
1441     crit_exit();
1442 }
1443
1444 /*
1445  * 1/hz tick (typically 10ms) x TDFAIRQ_SCALE (typ 8) = 80ms full cycle.
1446  *
1447  * Example: two competing threads, same priority N.  decrement by (2*N)
1448  * increment by N*8, each thread will get 4 ticks.
1449  */
1450 void
1451 lwkt_fairq_schedulerclock(thread_t td)
1452 {
1453     if (fairq_enable) {
1454         while (td) {
1455             if (td != &td->td_gd->gd_idlethread) {
1456                 td->td_fairq_accum -= td->td_gd->gd_fairq_total_pri;
1457                 if (td->td_fairq_accum < -TDFAIRQ_MAX(td->td_gd))
1458                         td->td_fairq_accum = -TDFAIRQ_MAX(td->td_gd);
1459                 if (td->td_fairq_accum < 0)
1460                         need_lwkt_resched();
1461                 td->td_fairq_lticks = ticks;
1462             }
1463             td = td->td_preempted;
1464         }
1465     }
1466 }
1467
1468 static void
1469 lwkt_fairq_accumulate(globaldata_t gd, thread_t td)
1470 {
1471         td->td_fairq_accum += td->td_pri * TDFAIRQ_SCALE;
1472         if (td->td_fairq_accum > TDFAIRQ_MAX(td->td_gd))
1473                 td->td_fairq_accum = TDFAIRQ_MAX(td->td_gd);
1474 }
1475
1476 /*
1477  * Migrate the current thread to the specified cpu. 
1478  *
1479  * This is accomplished by descheduling ourselves from the current cpu,
1480  * moving our thread to the tdallq of the target cpu, IPI messaging the
1481  * target cpu, and switching out.  TDF_MIGRATING prevents scheduling
1482  * races while the thread is being migrated.
1483  *
1484  * We must be sure to remove ourselves from the current cpu's tsleepq
1485  * before potentially moving to another queue.  The thread can be on
1486  * a tsleepq due to a left-over tsleep_interlock().
1487  */
1488 #ifdef SMP
1489 static void lwkt_setcpu_remote(void *arg);
1490 #endif
1491
1492 void
1493 lwkt_setcpu_self(globaldata_t rgd)
1494 {
1495 #ifdef SMP
1496     thread_t td = curthread;
1497
1498     if (td->td_gd != rgd) {
1499         crit_enter_quick(td);
1500         if (td->td_flags & TDF_TSLEEPQ)
1501             tsleep_remove(td);
1502         td->td_flags |= TDF_MIGRATING;
1503         lwkt_deschedule_self(td);
1504         TAILQ_REMOVE(&td->td_gd->gd_tdallq, td, td_allq);
1505         lwkt_send_ipiq(rgd, (ipifunc1_t)lwkt_setcpu_remote, td);
1506         lwkt_switch();
1507         /* we are now on the target cpu */
1508         TAILQ_INSERT_TAIL(&rgd->gd_tdallq, td, td_allq);
1509         crit_exit_quick(td);
1510     }
1511 #endif
1512 }
1513
1514 void
1515 lwkt_migratecpu(int cpuid)
1516 {
1517 #ifdef SMP
1518         globaldata_t rgd;
1519
1520         rgd = globaldata_find(cpuid);
1521         lwkt_setcpu_self(rgd);
1522 #endif
1523 }
1524
1525 /*
1526  * Remote IPI for cpu migration (called while in a critical section so we
1527  * do not have to enter another one).  The thread has already been moved to
1528  * our cpu's allq, but we must wait for the thread to be completely switched
1529  * out on the originating cpu before we schedule it on ours or the stack
1530  * state may be corrupt.  We clear TDF_MIGRATING after flushing the GD
1531  * change to main memory.
1532  *
1533  * XXX The use of TDF_MIGRATING might not be sufficient to avoid races
1534  * against wakeups.  It is best if this interface is used only when there
1535  * are no pending events that might try to schedule the thread.
1536  */
1537 #ifdef SMP
1538 static void
1539 lwkt_setcpu_remote(void *arg)
1540 {
1541     thread_t td = arg;
1542     globaldata_t gd = mycpu;
1543
1544     while (td->td_flags & (TDF_RUNNING|TDF_PREEMPT_LOCK)) {
1545 #ifdef SMP
1546         lwkt_process_ipiq();
1547 #endif
1548         cpu_lfence();
1549     }
1550     td->td_gd = gd;
1551     cpu_sfence();
1552     td->td_flags &= ~TDF_MIGRATING;
1553     KKASSERT(td->td_lwp == NULL || (td->td_lwp->lwp_flag & LWP_ONRUNQ) == 0);
1554     _lwkt_enqueue(td);
1555 }
1556 #endif
1557
1558 struct lwp *
1559 lwkt_preempted_proc(void)
1560 {
1561     thread_t td = curthread;
1562     while (td->td_preempted)
1563         td = td->td_preempted;
1564     return(td->td_lwp);
1565 }
1566
1567 /*
1568  * Create a kernel process/thread/whatever.  It shares it's address space
1569  * with proc0 - ie: kernel only.
1570  *
1571  * NOTE!  By default new threads are created with the MP lock held.  A 
1572  * thread which does not require the MP lock should release it by calling
1573  * rel_mplock() at the start of the new thread.
1574  */
1575 int
1576 lwkt_create(void (*func)(void *), void *arg, struct thread **tdp,
1577             thread_t template, int tdflags, int cpu, const char *fmt, ...)
1578 {
1579     thread_t td;
1580     __va_list ap;
1581
1582     td = lwkt_alloc_thread(template, LWKT_THREAD_STACK, cpu,
1583                            tdflags);
1584     if (tdp)
1585         *tdp = td;
1586     cpu_set_thread_handler(td, lwkt_exit, func, arg);
1587
1588     /*
1589      * Set up arg0 for 'ps' etc
1590      */
1591     __va_start(ap, fmt);
1592     kvsnprintf(td->td_comm, sizeof(td->td_comm), fmt, ap);
1593     __va_end(ap);
1594
1595     /*
1596      * Schedule the thread to run
1597      */
1598     if ((td->td_flags & TDF_STOPREQ) == 0)
1599         lwkt_schedule(td);
1600     else
1601         td->td_flags &= ~TDF_STOPREQ;
1602     return 0;
1603 }
1604
1605 /*
1606  * Destroy an LWKT thread.   Warning!  This function is not called when
1607  * a process exits, cpu_proc_exit() directly calls cpu_thread_exit() and
1608  * uses a different reaping mechanism.
1609  */
1610 void
1611 lwkt_exit(void)
1612 {
1613     thread_t td = curthread;
1614     thread_t std;
1615     globaldata_t gd;
1616
1617     if (td->td_flags & TDF_VERBOSE)
1618         kprintf("kthread %p %s has exited\n", td, td->td_comm);
1619     caps_exit(td);
1620
1621     /*
1622      * Get us into a critical section to interlock gd_freetd and loop
1623      * until we can get it freed.
1624      *
1625      * We have to cache the current td in gd_freetd because objcache_put()ing
1626      * it would rip it out from under us while our thread is still active.
1627      */
1628     gd = mycpu;
1629     crit_enter_quick(td);
1630     while ((std = gd->gd_freetd) != NULL) {
1631         gd->gd_freetd = NULL;
1632         objcache_put(thread_cache, std);
1633     }
1634
1635     /*
1636      * Remove thread resources from kernel lists and deschedule us for
1637      * the last time.
1638      */
1639     if (td->td_flags & TDF_TSLEEPQ)
1640         tsleep_remove(td);
1641     biosched_done(td);
1642     dsched_exit_thread(td);
1643     lwkt_deschedule_self(td);
1644     lwkt_remove_tdallq(td);
1645     if (td->td_flags & TDF_ALLOCATED_THREAD)
1646         gd->gd_freetd = td;
1647     cpu_thread_exit();
1648 }
1649
1650 void
1651 lwkt_remove_tdallq(thread_t td)
1652 {
1653     KKASSERT(td->td_gd == mycpu);
1654     TAILQ_REMOVE(&td->td_gd->gd_tdallq, td, td_allq);
1655 }
1656
1657 void
1658 crit_panic(void)
1659 {
1660     thread_t td = curthread;
1661     int lcrit = td->td_critcount;
1662
1663     td->td_critcount = 0;
1664     panic("td_critcount is/would-go negative! %p %d", td, lcrit);
1665 }
1666
1667 #ifdef SMP
1668
1669 /*
1670  * Called from debugger/panic on cpus which have been stopped.  We must still
1671  * process the IPIQ while stopped, even if we were stopped while in a critical
1672  * section (XXX).
1673  *
1674  * If we are dumping also try to process any pending interrupts.  This may
1675  * or may not work depending on the state of the cpu at the point it was
1676  * stopped.
1677  */
1678 void
1679 lwkt_smp_stopped(void)
1680 {
1681     globaldata_t gd = mycpu;
1682
1683     crit_enter_gd(gd);
1684     if (dumping) {
1685         lwkt_process_ipiq();
1686         splz();
1687     } else {
1688         lwkt_process_ipiq();
1689     }
1690     crit_exit_gd(gd);
1691 }
1692
1693 #endif