carp: add carp_group_demote_adj()
[dragonfly.git] / sys / kern / lwkt_ipiq.c
1 /*
2  * Copyright (c) 2003,2004 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  * $DragonFly: src/sys/kern/lwkt_ipiq.c,v 1.27 2008/05/18 20:57:56 nth Exp $
35  */
36
37 /*
38  * This module implements IPI message queueing and the MI portion of IPI
39  * message processing.
40  */
41
42 #include "opt_ddb.h"
43
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/proc.h>
48 #include <sys/rtprio.h>
49 #include <sys/queue.h>
50 #include <sys/thread2.h>
51 #include <sys/sysctl.h>
52 #include <sys/ktr.h>
53 #include <sys/kthread.h>
54 #include <machine/cpu.h>
55 #include <sys/lock.h>
56 #include <sys/caps.h>
57
58 #include <vm/vm.h>
59 #include <vm/vm_param.h>
60 #include <vm/vm_kern.h>
61 #include <vm/vm_object.h>
62 #include <vm/vm_page.h>
63 #include <vm/vm_map.h>
64 #include <vm/vm_pager.h>
65 #include <vm/vm_extern.h>
66 #include <vm/vm_zone.h>
67
68 #include <machine/stdarg.h>
69 #include <machine/smp.h>
70 #include <machine/atomic.h>
71
72 #ifdef SMP
73 static __int64_t ipiq_count;    /* total calls to lwkt_send_ipiq*() */
74 static __int64_t ipiq_fifofull; /* number of fifo full conditions detected */
75 static __int64_t ipiq_avoided;  /* interlock with target avoids cpu ipi */
76 static __int64_t ipiq_passive;  /* passive IPI messages */
77 static __int64_t ipiq_cscount;  /* number of cpu synchronizations */
78 static int ipiq_optimized = 1;  /* XXX temporary sysctl */
79 #ifdef PANIC_DEBUG
80 static int      panic_ipiq_cpu = -1;
81 static int      panic_ipiq_count = 100;
82 #endif
83 #endif
84
85 #ifdef SMP
86 SYSCTL_QUAD(_lwkt, OID_AUTO, ipiq_count, CTLFLAG_RW, &ipiq_count, 0, "");
87 SYSCTL_QUAD(_lwkt, OID_AUTO, ipiq_fifofull, CTLFLAG_RW, &ipiq_fifofull, 0, "");
88 SYSCTL_QUAD(_lwkt, OID_AUTO, ipiq_avoided, CTLFLAG_RW, &ipiq_avoided, 0, "");
89 SYSCTL_QUAD(_lwkt, OID_AUTO, ipiq_passive, CTLFLAG_RW, &ipiq_passive, 0, "");
90 SYSCTL_QUAD(_lwkt, OID_AUTO, ipiq_cscount, CTLFLAG_RW, &ipiq_cscount, 0, "");
91 SYSCTL_INT(_lwkt, OID_AUTO, ipiq_optimized, CTLFLAG_RW, &ipiq_optimized, 0, "");
92 #ifdef PANIC_DEBUG
93 SYSCTL_INT(_lwkt, OID_AUTO, panic_ipiq_cpu, CTLFLAG_RW, &panic_ipiq_cpu, 0, "");
94 SYSCTL_INT(_lwkt, OID_AUTO, panic_ipiq_count, CTLFLAG_RW, &panic_ipiq_count, 0, "");
95 #endif
96
97 #define IPIQ_STRING     "func=%p arg1=%p arg2=%d scpu=%d dcpu=%d"
98 #define IPIQ_ARG_SIZE   (sizeof(void *) * 2 + sizeof(int) * 3)
99
100 #if !defined(KTR_IPIQ)
101 #define KTR_IPIQ        KTR_ALL
102 #endif
103 KTR_INFO_MASTER(ipiq);
104 KTR_INFO(KTR_IPIQ, ipiq, send_norm, 0, IPIQ_STRING, IPIQ_ARG_SIZE);
105 KTR_INFO(KTR_IPIQ, ipiq, send_pasv, 1, IPIQ_STRING, IPIQ_ARG_SIZE);
106 KTR_INFO(KTR_IPIQ, ipiq, send_nbio, 2, IPIQ_STRING, IPIQ_ARG_SIZE);
107 KTR_INFO(KTR_IPIQ, ipiq, send_fail, 3, IPIQ_STRING, IPIQ_ARG_SIZE);
108 KTR_INFO(KTR_IPIQ, ipiq, receive, 4, IPIQ_STRING, IPIQ_ARG_SIZE);
109 KTR_INFO(KTR_IPIQ, ipiq, sync_start, 5, "cpumask=%08x", sizeof(cpumask_t));
110 KTR_INFO(KTR_IPIQ, ipiq, sync_add, 6, "cpumask=%08x", sizeof(cpumask_t));
111 KTR_INFO(KTR_IPIQ, ipiq, cpu_send, 7, IPIQ_STRING, IPIQ_ARG_SIZE);
112 KTR_INFO(KTR_IPIQ, ipiq, send_end, 8, IPIQ_STRING, IPIQ_ARG_SIZE);
113
114 #define logipiq(name, func, arg1, arg2, sgd, dgd)       \
115         KTR_LOG(ipiq_ ## name, func, arg1, arg2, sgd->gd_cpuid, dgd->gd_cpuid)
116 #define logipiq2(name, arg)     \
117         KTR_LOG(ipiq_ ## name, arg)
118
119 #endif  /* SMP */
120
121 #ifdef SMP
122
123 static int lwkt_process_ipiq_core(globaldata_t sgd, lwkt_ipiq_t ip, 
124                                   struct intrframe *frame);
125 static void lwkt_cpusync_remote1(lwkt_cpusync_t poll);
126 static void lwkt_cpusync_remote2(lwkt_cpusync_t poll);
127
128 /*
129  * Send a function execution request to another cpu.  The request is queued
130  * on the cpu<->cpu ipiq matrix.  Each cpu owns a unique ipiq FIFO for every
131  * possible target cpu.  The FIFO can be written.
132  *
133  * If the FIFO fills up we have to enable interrupts to avoid an APIC
134  * deadlock and process pending IPIQs while waiting for it to empty.   
135  * Otherwise we may soft-deadlock with another cpu whos FIFO is also full.
136  *
137  * We can safely bump gd_intr_nesting_level because our crit_exit() at the
138  * end will take care of any pending interrupts.
139  *
140  * The actual hardware IPI is avoided if the target cpu is already processing
141  * the queue from a prior IPI.  It is possible to pipeline IPI messages
142  * very quickly between cpus due to the FIFO hysteresis.
143  *
144  * Need not be called from a critical section.
145  */
146 int
147 lwkt_send_ipiq3(globaldata_t target, ipifunc3_t func, void *arg1, int arg2)
148 {
149     lwkt_ipiq_t ip;
150     int windex;
151     struct globaldata *gd = mycpu;
152
153     logipiq(send_norm, func, arg1, arg2, gd, target);
154
155     if (target == gd) {
156         func(arg1, arg2, NULL);
157         logipiq(send_end, func, arg1, arg2, gd, target);
158         return(0);
159     } 
160     crit_enter();
161     ++gd->gd_intr_nesting_level;
162 #ifdef INVARIANTS
163     if (gd->gd_intr_nesting_level > 20)
164         panic("lwkt_send_ipiq: TOO HEAVILY NESTED!");
165 #endif
166     KKASSERT(curthread->td_pri >= TDPRI_CRIT);
167     ++ipiq_count;
168     ip = &gd->gd_ipiq[target->gd_cpuid];
169
170     /*
171      * Do not allow the FIFO to become full.  Interrupts must be physically
172      * enabled while we liveloop to avoid deadlocking the APIC.
173      */
174     if (ip->ip_windex - ip->ip_rindex > MAXCPUFIFO / 2) {
175 #if defined(__i386__)
176         unsigned int eflags = read_eflags();
177 #elif defined(__x86_64__)
178         unsigned long rflags = read_rflags();
179 #endif
180
181         if (atomic_poll_acquire_int(&ip->ip_npoll) || ipiq_optimized == 0) {
182             logipiq(cpu_send, func, arg1, arg2, gd, target);
183             cpu_send_ipiq(target->gd_cpuid);
184         }
185         cpu_enable_intr();
186         ++ipiq_fifofull;
187         while (ip->ip_windex - ip->ip_rindex > MAXCPUFIFO / 4) {
188             KKASSERT(ip->ip_windex - ip->ip_rindex != MAXCPUFIFO - 1);
189             lwkt_process_ipiq();
190         }
191 #if defined(__i386__)
192         write_eflags(eflags);
193 #elif defined(__x86_64__)
194         write_rflags(rflags);
195 #endif
196     }
197
198     /*
199      * Queue the new message
200      */
201     windex = ip->ip_windex & MAXCPUFIFO_MASK;
202     ip->ip_func[windex] = func;
203     ip->ip_arg1[windex] = arg1;
204     ip->ip_arg2[windex] = arg2;
205     cpu_sfence();
206     ++ip->ip_windex;
207     --gd->gd_intr_nesting_level;
208
209     /*
210      * signal the target cpu that there is work pending.
211      */
212     if (atomic_poll_acquire_int(&ip->ip_npoll)) {
213         logipiq(cpu_send, func, arg1, arg2, gd, target);
214         cpu_send_ipiq(target->gd_cpuid);
215     } else {
216         if (ipiq_optimized == 0) {
217             logipiq(cpu_send, func, arg1, arg2, gd, target);
218             cpu_send_ipiq(target->gd_cpuid);
219         } else {
220             ++ipiq_avoided;
221         }
222     }
223     crit_exit();
224
225     logipiq(send_end, func, arg1, arg2, gd, target);
226     return(ip->ip_windex);
227 }
228
229 /*
230  * Similar to lwkt_send_ipiq() but this function does not actually initiate
231  * the IPI to the target cpu unless the FIFO has become too full, so it is
232  * very fast.
233  *
234  * This function is used for non-critical IPI messages, such as memory
235  * deallocations.  The queue will typically be flushed by the target cpu at
236  * the next clock interrupt.
237  *
238  * Need not be called from a critical section.
239  */
240 int
241 lwkt_send_ipiq3_passive(globaldata_t target, ipifunc3_t func,
242                         void *arg1, int arg2)
243 {
244     lwkt_ipiq_t ip;
245     int windex;
246     struct globaldata *gd = mycpu;
247
248     KKASSERT(target != gd);
249     crit_enter();
250     logipiq(send_pasv, func, arg1, arg2, gd, target);
251     ++gd->gd_intr_nesting_level;
252 #ifdef INVARIANTS
253     if (gd->gd_intr_nesting_level > 20)
254         panic("lwkt_send_ipiq: TOO HEAVILY NESTED!");
255 #endif
256     KKASSERT(curthread->td_pri >= TDPRI_CRIT);
257     ++ipiq_count;
258     ++ipiq_passive;
259     ip = &gd->gd_ipiq[target->gd_cpuid];
260
261     /*
262      * Do not allow the FIFO to become full.  Interrupts must be physically
263      * enabled while we liveloop to avoid deadlocking the APIC.
264      */
265     if (ip->ip_windex - ip->ip_rindex > MAXCPUFIFO / 2) {
266 #if defined(__i386__)
267         unsigned int eflags = read_eflags();
268 #elif defined(__x86_64__)
269         unsigned long rflags = read_rflags();
270 #endif
271
272         if (atomic_poll_acquire_int(&ip->ip_npoll) || ipiq_optimized == 0) {
273             logipiq(cpu_send, func, arg1, arg2, gd, target);
274             cpu_send_ipiq(target->gd_cpuid);
275         }
276         cpu_enable_intr();
277         ++ipiq_fifofull;
278         while (ip->ip_windex - ip->ip_rindex > MAXCPUFIFO / 4) {
279             KKASSERT(ip->ip_windex - ip->ip_rindex != MAXCPUFIFO - 1);
280             lwkt_process_ipiq();
281         }
282 #if defined(__i386__)
283         write_eflags(eflags);
284 #elif defined(__x86_64__)
285         write_rflags(rflags);
286 #endif
287     }
288
289     /*
290      * Queue the new message
291      */
292     windex = ip->ip_windex & MAXCPUFIFO_MASK;
293     ip->ip_func[windex] = func;
294     ip->ip_arg1[windex] = arg1;
295     ip->ip_arg2[windex] = arg2;
296     cpu_sfence();
297     ++ip->ip_windex;
298     --gd->gd_intr_nesting_level;
299
300     /*
301      * Do not signal the target cpu, it will pick up the IPI when it next
302      * polls (typically on the next tick).
303      */
304     crit_exit();
305
306     logipiq(send_end, func, arg1, arg2, gd, target);
307     return(ip->ip_windex);
308 }
309
310 /*
311  * Send an IPI request without blocking, return 0 on success, ENOENT on 
312  * failure.  The actual queueing of the hardware IPI may still force us
313  * to spin and process incoming IPIs but that will eventually go away
314  * when we've gotten rid of the other general IPIs.
315  */
316 int
317 lwkt_send_ipiq3_nowait(globaldata_t target, ipifunc3_t func, 
318                        void *arg1, int arg2)
319 {
320     lwkt_ipiq_t ip;
321     int windex;
322     struct globaldata *gd = mycpu;
323
324     logipiq(send_nbio, func, arg1, arg2, gd, target);
325     KKASSERT(curthread->td_pri >= TDPRI_CRIT);
326     if (target == gd) {
327         func(arg1, arg2, NULL);
328         logipiq(send_end, func, arg1, arg2, gd, target);
329         return(0);
330     } 
331     ++ipiq_count;
332     ip = &gd->gd_ipiq[target->gd_cpuid];
333
334     if (ip->ip_windex - ip->ip_rindex >= MAXCPUFIFO * 2 / 3) {
335         logipiq(send_fail, func, arg1, arg2, gd, target);
336         return(ENOENT);
337     }
338     windex = ip->ip_windex & MAXCPUFIFO_MASK;
339     ip->ip_func[windex] = func;
340     ip->ip_arg1[windex] = arg1;
341     ip->ip_arg2[windex] = arg2;
342     cpu_sfence();
343     ++ip->ip_windex;
344
345     /*
346      * This isn't a passive IPI, we still have to signal the target cpu.
347      */
348     if (atomic_poll_acquire_int(&ip->ip_npoll)) {
349         logipiq(cpu_send, func, arg1, arg2, gd, target);
350         cpu_send_ipiq(target->gd_cpuid);
351     } else {
352         if (ipiq_optimized == 0) {
353             logipiq(cpu_send, func, arg1, arg2, gd, target);
354             cpu_send_ipiq(target->gd_cpuid);
355         } else {
356             ++ipiq_avoided;
357         }
358     }
359
360     logipiq(send_end, func, arg1, arg2, gd, target);
361     return(0);
362 }
363
364 /*
365  * deprecated, used only by fast int forwarding.
366  */
367 int
368 lwkt_send_ipiq3_bycpu(int dcpu, ipifunc3_t func, void *arg1, int arg2)
369 {
370     return(lwkt_send_ipiq3(globaldata_find(dcpu), func, arg1, arg2));
371 }
372
373 /*
374  * Send a message to several target cpus.  Typically used for scheduling.
375  * The message will not be sent to stopped cpus.
376  */
377 int
378 lwkt_send_ipiq3_mask(u_int32_t mask, ipifunc3_t func, void *arg1, int arg2)
379 {
380     int cpuid;
381     int count = 0;
382
383     mask &= ~stopped_cpus;
384     while (mask) {
385         cpuid = bsfl(mask);
386         lwkt_send_ipiq3(globaldata_find(cpuid), func, arg1, arg2);
387         mask &= ~(1 << cpuid);
388         ++count;
389     }
390     return(count);
391 }
392
393 /*
394  * Wait for the remote cpu to finish processing a function.
395  *
396  * YYY we have to enable interrupts and process the IPIQ while waiting
397  * for it to empty or we may deadlock with another cpu.  Create a CPU_*()
398  * function to do this!  YYY we really should 'block' here.
399  *
400  * MUST be called from a critical section.  This routine may be called
401  * from an interrupt (for example, if an interrupt wakes a foreign thread
402  * up).
403  */
404 void
405 lwkt_wait_ipiq(globaldata_t target, int seq)
406 {
407     lwkt_ipiq_t ip;
408     int maxc = 100000000;
409
410     if (target != mycpu) {
411         ip = &mycpu->gd_ipiq[target->gd_cpuid];
412         if ((int)(ip->ip_xindex - seq) < 0) {
413 #if defined(__i386__)
414             unsigned int eflags = read_eflags();
415 #elif defined(__x86_64__)
416             unsigned long rflags = read_rflags();
417 #endif
418             cpu_enable_intr();
419             while ((int)(ip->ip_xindex - seq) < 0) {
420                 crit_enter();
421                 lwkt_process_ipiq();
422                 crit_exit();
423                 if (--maxc == 0)
424                         kprintf("LWKT_WAIT_IPIQ WARNING! %d wait %d (%d)\n", mycpu->gd_cpuid, target->gd_cpuid, ip->ip_xindex - seq);
425                 if (maxc < -1000000)
426                         panic("LWKT_WAIT_IPIQ");
427                 /*
428                  * xindex may be modified by another cpu, use a load fence
429                  * to ensure that the loop does not use a speculative value
430                  * (which may improve performance).
431                  */
432                 cpu_lfence();
433             }
434 #if defined(__i386__)
435             write_eflags(eflags);
436 #elif defined(__x86_64__)
437             write_rflags(rflags);
438 #endif
439         }
440     }
441 }
442
443 int
444 lwkt_seq_ipiq(globaldata_t target)
445 {
446     lwkt_ipiq_t ip;
447
448     ip = &mycpu->gd_ipiq[target->gd_cpuid];
449     return(ip->ip_windex);
450 }
451
452 /*
453  * Called from IPI interrupt (like a fast interrupt), which has placed
454  * us in a critical section.  The MP lock may or may not be held.
455  * May also be called from doreti or splz, or be reentrantly called
456  * indirectly through the ip_func[] we run.
457  *
458  * There are two versions, one where no interrupt frame is available (when
459  * called from the send code and from splz, and one where an interrupt
460  * frame is available.
461  */
462 void
463 lwkt_process_ipiq(void)
464 {
465     globaldata_t gd = mycpu;
466     globaldata_t sgd;
467     lwkt_ipiq_t ip;
468     int n;
469
470 again:
471     for (n = 0; n < ncpus; ++n) {
472         if (n != gd->gd_cpuid) {
473             sgd = globaldata_find(n);
474             ip = sgd->gd_ipiq;
475             if (ip != NULL) {
476                 while (lwkt_process_ipiq_core(sgd, &ip[gd->gd_cpuid], NULL))
477                     ;
478             }
479         }
480     }
481     if (gd->gd_cpusyncq.ip_rindex != gd->gd_cpusyncq.ip_windex) {
482         if (lwkt_process_ipiq_core(gd, &gd->gd_cpusyncq, NULL)) {
483             if (gd->gd_curthread->td_cscount == 0)
484                 goto again;
485             need_ipiq();
486         }
487     }
488 }
489
490 void
491 lwkt_process_ipiq_frame(struct intrframe *frame)
492 {
493     globaldata_t gd = mycpu;
494     globaldata_t sgd;
495     lwkt_ipiq_t ip;
496     int n;
497
498 again:
499     for (n = 0; n < ncpus; ++n) {
500         if (n != gd->gd_cpuid) {
501             sgd = globaldata_find(n);
502             ip = sgd->gd_ipiq;
503             if (ip != NULL) {
504                 while (lwkt_process_ipiq_core(sgd, &ip[gd->gd_cpuid], frame))
505                     ;
506             }
507         }
508     }
509     if (gd->gd_cpusyncq.ip_rindex != gd->gd_cpusyncq.ip_windex) {
510         if (lwkt_process_ipiq_core(gd, &gd->gd_cpusyncq, frame)) {
511             if (gd->gd_curthread->td_cscount == 0)
512                 goto again;
513             need_ipiq();
514         }
515     }
516 }
517
518 static int
519 lwkt_process_ipiq_core(globaldata_t sgd, lwkt_ipiq_t ip, 
520                        struct intrframe *frame)
521 {
522     int ri;
523     int wi;
524     ipifunc3_t copy_func;
525     void *copy_arg1;
526     int copy_arg2;
527
528     /*
529      * Obtain the current write index, which is modified by a remote cpu.
530      * Issue a load fence to prevent speculative reads of e.g. data written
531      * by the other cpu prior to it updating the index.
532      */
533     KKASSERT(curthread->td_pri >= TDPRI_CRIT);
534     wi = ip->ip_windex;
535     cpu_lfence();
536
537     /*
538      * Note: xindex is only updated after we are sure the function has
539      * finished execution.  Beware lwkt_process_ipiq() reentrancy!  The
540      * function may send an IPI which may block/drain.
541      *
542      * Note: due to additional IPI operations that the callback function
543      * may make, it is possible for both rindex and windex to advance and
544      * thus for rindex to advance passed our cached windex.
545      */
546     while (wi - (ri = ip->ip_rindex) > 0) {
547         ri &= MAXCPUFIFO_MASK;
548         copy_func = ip->ip_func[ri];
549         copy_arg1 = ip->ip_arg1[ri];
550         copy_arg2 = ip->ip_arg2[ri];
551         cpu_mfence();
552         ++ip->ip_rindex;
553         KKASSERT((ip->ip_rindex & MAXCPUFIFO_MASK) == ((ri + 1) & MAXCPUFIFO_MASK));
554         logipiq(receive, copy_func, copy_arg1, copy_arg2, sgd, mycpu);
555         copy_func(copy_arg1, copy_arg2, frame);
556         cpu_sfence();
557         ip->ip_xindex = ip->ip_rindex;
558
559 #ifdef PANIC_DEBUG
560         /*
561          * Simulate panics during the processing of an IPI
562          */
563         if (mycpu->gd_cpuid == panic_ipiq_cpu && panic_ipiq_count) {
564                 if (--panic_ipiq_count == 0) {
565 #ifdef DDB
566                         Debugger("PANIC_DEBUG");
567 #else
568                         panic("PANIC_DEBUG");
569 #endif
570                 }
571         }
572 #endif
573     }
574
575     /*
576      * Return non-zero if there are more IPI messages pending on this
577      * ipiq.  ip_npoll is left set as long as possible to reduce the
578      * number of IPIs queued by the originating cpu, but must be cleared
579      * *BEFORE* checking windex.
580      */
581     atomic_poll_release_int(&ip->ip_npoll);
582     return(wi != ip->ip_windex);
583 }
584
585 static void
586 lwkt_sync_ipiq(void *arg)
587 {
588     cpumask_t *cpumask = arg;
589
590     atomic_clear_int(cpumask, mycpu->gd_cpumask);
591     if (*cpumask == 0)
592         wakeup(cpumask);
593 }
594
595 void
596 lwkt_synchronize_ipiqs(const char *wmesg)
597 {
598     cpumask_t other_cpumask;
599
600     other_cpumask = mycpu->gd_other_cpus & smp_active_mask;
601     lwkt_send_ipiq_mask(other_cpumask, lwkt_sync_ipiq, &other_cpumask);
602
603     while (other_cpumask != 0) {
604         tsleep_interlock(&other_cpumask, 0);
605         if (other_cpumask != 0)
606             tsleep(&other_cpumask, PINTERLOCKED, wmesg, 0);
607     }
608 }
609
610 #endif
611
612 /*
613  * CPU Synchronization Support
614  *
615  * lwkt_cpusync_simple()
616  *
617  *      The function is executed synchronously before return on remote cpus.
618  *      A lwkt_cpusync_t pointer is passed as an argument.  The data can
619  *      be accessed via arg->cs_data.
620  *
621  *      XXX should I just pass the data as an argument to be consistent?
622  */
623
624 void
625 lwkt_cpusync_simple(cpumask_t mask, cpusync_func_t func, void *data)
626 {
627     struct lwkt_cpusync cmd;
628
629     cmd.cs_run_func = NULL;
630     cmd.cs_fin1_func = func;
631     cmd.cs_fin2_func = NULL;
632     cmd.cs_data = data;
633     lwkt_cpusync_start(mask & mycpu->gd_other_cpus, &cmd);
634     if (mask & (1 << mycpu->gd_cpuid))
635         func(&cmd);
636     lwkt_cpusync_finish(&cmd);
637 }
638
639 /*
640  * lwkt_cpusync_fastdata()
641  *
642  *      The function is executed in tandem with return on remote cpus.
643  *      The data is directly passed as an argument.  Do not pass pointers to
644  *      temporary storage as the storage might have
645  *      gone poof by the time the target cpu executes
646  *      the function.
647  *
648  *      At the moment lwkt_cpusync is declared on the stack and we must wait
649  *      for all remote cpus to ack in lwkt_cpusync_finish(), but as a future
650  *      optimization we should be able to put a counter in the globaldata
651  *      structure (if it is not otherwise being used) and just poke it and
652  *      return without waiting. XXX
653  */
654 void
655 lwkt_cpusync_fastdata(cpumask_t mask, cpusync_func2_t func, void *data)
656 {
657     struct lwkt_cpusync cmd;
658
659     cmd.cs_run_func = NULL;
660     cmd.cs_fin1_func = NULL;
661     cmd.cs_fin2_func = func;
662     cmd.cs_data = NULL;
663     lwkt_cpusync_start(mask & mycpu->gd_other_cpus, &cmd);
664     if (mask & (1 << mycpu->gd_cpuid))
665         func(data);
666     lwkt_cpusync_finish(&cmd);
667 }
668
669 /*
670  * lwkt_cpusync_start()
671  *
672  *      Start synchronization with a set of target cpus, return once they are
673  *      known to be in a synchronization loop.  The target cpus will execute
674  *      poll->cs_run_func() IN TANDEM WITH THE RETURN.
675  *
676  *      XXX future: add lwkt_cpusync_start_quick() and require a call to
677  *      lwkt_cpusync_add() or lwkt_cpusync_wait(), allowing the caller to
678  *      potentially absorb the IPI latency doing something useful.
679  */
680 void
681 lwkt_cpusync_start(cpumask_t mask, lwkt_cpusync_t poll)
682 {
683     globaldata_t gd = mycpu;
684
685     poll->cs_count = 0;
686     poll->cs_mask = mask;
687 #ifdef SMP
688     logipiq2(sync_start, mask & gd->gd_other_cpus);
689     poll->cs_maxcount = lwkt_send_ipiq_mask(
690                 mask & gd->gd_other_cpus & smp_active_mask,
691                 (ipifunc1_t)lwkt_cpusync_remote1, poll);
692 #endif
693     if (mask & gd->gd_cpumask) {
694         if (poll->cs_run_func)
695             poll->cs_run_func(poll);
696     }
697 #ifdef SMP
698     if (poll->cs_maxcount) {
699         ++ipiq_cscount;
700         ++gd->gd_curthread->td_cscount;
701         while (poll->cs_count != poll->cs_maxcount) {
702             crit_enter();
703             lwkt_process_ipiq();
704             crit_exit();
705         }
706     }
707 #endif
708 }
709
710 void
711 lwkt_cpusync_add(cpumask_t mask, lwkt_cpusync_t poll)
712 {
713     globaldata_t gd = mycpu;
714 #ifdef SMP
715     int count;
716 #endif
717
718     mask &= ~poll->cs_mask;
719     poll->cs_mask |= mask;
720 #ifdef SMP
721     logipiq2(sync_add, mask & gd->gd_other_cpus);
722     count = lwkt_send_ipiq_mask(
723                 mask & gd->gd_other_cpus & smp_active_mask,
724                 (ipifunc1_t)lwkt_cpusync_remote1, poll);
725 #endif
726     if (mask & gd->gd_cpumask) {
727         if (poll->cs_run_func)
728             poll->cs_run_func(poll);
729     }
730 #ifdef SMP
731     poll->cs_maxcount += count;
732     if (poll->cs_maxcount) {
733         if (poll->cs_maxcount == count)
734             ++gd->gd_curthread->td_cscount;
735         while (poll->cs_count != poll->cs_maxcount) {
736             crit_enter();
737             lwkt_process_ipiq();
738             crit_exit();
739         }
740     }
741 #endif
742 }
743
744 /*
745  * Finish synchronization with a set of target cpus.  The target cpus will
746  * execute cs_fin1_func(poll) prior to this function returning, and will
747  * execute cs_fin2_func(data) IN TANDEM WITH THIS FUNCTION'S RETURN.
748  *
749  * If cs_maxcount is non-zero then we are mastering a cpusync with one or
750  * more remote cpus and must account for it in our thread structure.
751  */
752 void
753 lwkt_cpusync_finish(lwkt_cpusync_t poll)
754 {
755     globaldata_t gd = mycpu;
756
757     poll->cs_count = -1;
758     if (poll->cs_mask & gd->gd_cpumask) {
759         if (poll->cs_fin1_func)
760             poll->cs_fin1_func(poll);
761         if (poll->cs_fin2_func)
762             poll->cs_fin2_func(poll->cs_data);
763     }
764 #ifdef SMP
765     if (poll->cs_maxcount) {
766         while (poll->cs_count != -(poll->cs_maxcount + 1)) {
767             crit_enter();
768             lwkt_process_ipiq();
769             crit_exit();
770         }
771         --gd->gd_curthread->td_cscount;
772     }
773 #endif
774 }
775
776 #ifdef SMP
777
778 /*
779  * helper IPI remote messaging function.
780  * 
781  * Called on remote cpu when a new cpu synchronization request has been
782  * sent to us.  Execute the run function and adjust cs_count, then requeue
783  * the request so we spin on it.
784  */
785 static void
786 lwkt_cpusync_remote1(lwkt_cpusync_t poll)
787 {
788     atomic_add_int(&poll->cs_count, 1);
789     if (poll->cs_run_func)
790         poll->cs_run_func(poll);
791     lwkt_cpusync_remote2(poll);
792 }
793
794 /*
795  * helper IPI remote messaging function.
796  *
797  * Poll for the originator telling us to finish.  If it hasn't, requeue
798  * our request so we spin on it.  When the originator requests that we
799  * finish we execute cs_fin1_func(poll) synchronously and cs_fin2_func(data)
800  * in tandem with the release.
801  */
802 static void
803 lwkt_cpusync_remote2(lwkt_cpusync_t poll)
804 {
805     if (poll->cs_count < 0) {
806         cpusync_func2_t savef;
807         void *saved;
808
809         if (poll->cs_fin1_func)
810             poll->cs_fin1_func(poll);
811         if (poll->cs_fin2_func) {
812             savef = poll->cs_fin2_func;
813             saved = poll->cs_data;
814             atomic_add_int(&poll->cs_count, -1);
815             savef(saved);
816         } else {
817             atomic_add_int(&poll->cs_count, -1);
818         }
819     } else {
820         globaldata_t gd = mycpu;
821         lwkt_ipiq_t ip;
822         int wi;
823
824         ip = &gd->gd_cpusyncq;
825         wi = ip->ip_windex & MAXCPUFIFO_MASK;
826         ip->ip_func[wi] = (ipifunc3_t)(ipifunc1_t)lwkt_cpusync_remote2;
827         ip->ip_arg1[wi] = poll;
828         ip->ip_arg2[wi] = 0;
829         cpu_sfence();
830         ++ip->ip_windex;
831     }
832 }
833
834 #endif