2 * Copyright (c) 2001, John Baldwin <jhb@FreeBSD.org>.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * This module holds the global variables and machine independent functions
29 * used for the kernel SMP support.
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
42 #include <sys/mutex.h>
44 #include <sys/sched.h>
46 #include <sys/sysctl.h>
48 #include <machine/cpu.h>
49 #include <machine/smp.h>
51 #include "opt_sched.h"
54 volatile cpuset_t stopped_cpus;
55 volatile cpuset_t started_cpus;
56 volatile cpuset_t suspended_cpus;
57 cpuset_t hlt_cpus_mask;
58 cpuset_t logical_cpus_mask;
60 void (*cpustop_restartfunc)(void);
63 static int sysctl_kern_smp_active(SYSCTL_HANDLER_ARGS);
65 /* This is used in modules that need to work in both SMP and UP. */
69 /* export this for libkvm consumers. */
70 int mp_maxcpus = MAXCPU;
72 volatile int smp_started;
75 static SYSCTL_NODE(_kern, OID_AUTO, smp, CTLFLAG_RD|CTLFLAG_CAPRD, NULL,
78 SYSCTL_INT(_kern_smp, OID_AUTO, maxid, CTLFLAG_RD|CTLFLAG_CAPRD, &mp_maxid, 0,
81 SYSCTL_INT(_kern_smp, OID_AUTO, maxcpus, CTLFLAG_RD|CTLFLAG_CAPRD, &mp_maxcpus,
82 0, "Max number of CPUs that the system was compiled for.");
84 SYSCTL_PROC(_kern_smp, OID_AUTO, active, CTLFLAG_RD | CTLTYPE_INT, NULL, 0,
85 sysctl_kern_smp_active, "I", "Indicates system is running in SMP mode");
87 int smp_disabled = 0; /* has smp been disabled? */
88 SYSCTL_INT(_kern_smp, OID_AUTO, disabled, CTLFLAG_RDTUN|CTLFLAG_CAPRD,
89 &smp_disabled, 0, "SMP has been disabled from the loader");
90 TUNABLE_INT("kern.smp.disabled", &smp_disabled);
92 int smp_cpus = 1; /* how many cpu's running */
93 SYSCTL_INT(_kern_smp, OID_AUTO, cpus, CTLFLAG_RD|CTLFLAG_CAPRD, &smp_cpus, 0,
94 "Number of CPUs online");
96 int smp_topology = 0; /* Which topology we're using. */
97 SYSCTL_INT(_kern_smp, OID_AUTO, topology, CTLFLAG_RD, &smp_topology, 0,
98 "Topology override setting; 0 is default provided by hardware.");
99 TUNABLE_INT("kern.smp.topology", &smp_topology);
102 /* Enable forwarding of a signal to a process running on a different CPU */
103 static int forward_signal_enabled = 1;
104 SYSCTL_INT(_kern_smp, OID_AUTO, forward_signal_enabled, CTLFLAG_RW,
105 &forward_signal_enabled, 0,
106 "Forwarding of a signal to a process on a different CPU");
108 /* Variables needed for SMP rendezvous. */
109 static volatile int smp_rv_ncpus;
110 static void (*volatile smp_rv_setup_func)(void *arg);
111 static void (*volatile smp_rv_action_func)(void *arg);
112 static void (*volatile smp_rv_teardown_func)(void *arg);
113 static void *volatile smp_rv_func_arg;
114 static volatile int smp_rv_waiters[4];
117 * Shared mutex to restrict busywaits between smp_rendezvous() and
118 * smp(_targeted)_tlb_shootdown(). A deadlock occurs if both of these
119 * functions trigger at once and cause multiple CPUs to busywait with
120 * interrupts disabled.
122 struct mtx smp_ipi_mtx;
125 * Let the MD SMP code initialize mp_maxid very early if it can.
128 mp_setmaxid(void *dummy)
132 SYSINIT(cpu_mp_setmaxid, SI_SUB_TUNABLES, SI_ORDER_FIRST, mp_setmaxid, NULL);
135 * Call the MD SMP initialization code.
138 mp_start(void *dummy)
141 mtx_init(&smp_ipi_mtx, "smp rendezvous", NULL, MTX_SPIN);
143 /* Probe for MP hardware. */
144 if (smp_disabled != 0 || cpu_mp_probe() == 0) {
146 CPU_SETOF(PCPU_GET(cpuid), &all_cpus);
151 printf("FreeBSD/SMP: Multiprocessor System Detected: %d CPUs\n",
155 SYSINIT(cpu_mp, SI_SUB_CPU, SI_ORDER_THIRD, mp_start, NULL);
158 forward_signal(struct thread *td)
163 * signotify() has already set TDF_ASTPENDING and TDF_NEEDSIGCHECK on
164 * this thread, so all we need to do is poke it if it is currently
165 * executing so that it executes ast().
167 THREAD_LOCK_ASSERT(td, MA_OWNED);
168 KASSERT(TD_IS_RUNNING(td),
169 ("forward_signal: thread is not TDS_RUNNING"));
171 CTR1(KTR_SMP, "forward_signal(%p)", td->td_proc);
173 if (!smp_started || cold || panicstr)
175 if (!forward_signal_enabled)
178 /* No need to IPI ourself. */
185 ipi_cpu(id, IPI_AST);
189 * When called the executing CPU will send an IPI to all other CPUs
190 * requesting that they halt execution.
192 * Usually (but not necessarily) called with 'other_cpus' as its arg.
194 * - Signals all CPUs in map to stop.
195 * - Waits for each to stop.
204 generic_stop_cpus(cpuset_t map, u_int type)
207 char cpusetbuf[CPUSETBUFSIZ];
209 static volatile u_int stopping_cpu = NOCPU;
211 volatile cpuset_t *cpus;
214 #if defined(__amd64__) || defined(__i386__)
215 type == IPI_STOP || type == IPI_STOP_HARD || type == IPI_SUSPEND,
217 type == IPI_STOP || type == IPI_STOP_HARD,
219 ("%s: invalid stop type", __func__));
224 CTR2(KTR_SMP, "stop_cpus(%s) with %u type",
225 cpusetobj_strprint(cpusetbuf, &map), type);
227 #if defined(__amd64__) || defined(__i386__)
229 * When suspending, ensure there are are no IPIs in progress.
230 * IPIs that have been issued, but not yet delivered (e.g.
231 * not pending on a vCPU when running under virtualization)
232 * will be lost, violating FreeBSD's assumption of reliable
235 if (type == IPI_SUSPEND)
236 mtx_lock_spin(&smp_ipi_mtx);
239 if (stopping_cpu != PCPU_GET(cpuid))
240 while (atomic_cmpset_int(&stopping_cpu, NOCPU,
241 PCPU_GET(cpuid)) == 0)
242 while (stopping_cpu != NOCPU)
243 cpu_spinwait(); /* spin */
245 /* send the stop IPI to all CPUs in map */
246 ipi_selected(map, type);
248 #if defined(__amd64__) || defined(__i386__)
249 if (type == IPI_SUSPEND)
250 cpus = &suspended_cpus;
253 cpus = &stopped_cpus;
256 while (!CPU_SUBSET(cpus, &map)) {
260 if (i == 100000000) {
261 printf("timeout stopping cpus\n");
266 #if defined(__amd64__) || defined(__i386__)
267 if (type == IPI_SUSPEND)
268 mtx_unlock_spin(&smp_ipi_mtx);
271 stopping_cpu = NOCPU;
276 stop_cpus(cpuset_t map)
279 return (generic_stop_cpus(map, IPI_STOP));
283 stop_cpus_hard(cpuset_t map)
286 return (generic_stop_cpus(map, IPI_STOP_HARD));
289 #if defined(__amd64__) || defined(__i386__)
291 suspend_cpus(cpuset_t map)
294 return (generic_stop_cpus(map, IPI_SUSPEND));
299 * Called by a CPU to restart stopped CPUs.
301 * Usually (but not necessarily) called with 'stopped_cpus' as its arg.
303 * - Signals all CPUs in map to restart.
304 * - Waits for each to restart.
312 generic_restart_cpus(cpuset_t map, u_int type)
315 char cpusetbuf[CPUSETBUFSIZ];
317 volatile cpuset_t *cpus;
320 #if defined(__amd64__) || defined(__i386__)
321 type == IPI_STOP || type == IPI_STOP_HARD || type == IPI_SUSPEND,
323 type == IPI_STOP || type == IPI_STOP_HARD,
325 ("%s: invalid stop type", __func__));
330 CTR1(KTR_SMP, "restart_cpus(%s)", cpusetobj_strprint(cpusetbuf, &map));
332 #if defined(__amd64__) || defined(__i386__)
333 if (type == IPI_SUSPEND)
334 cpus = &suspended_cpus;
337 cpus = &stopped_cpus;
339 /* signal other cpus to restart */
340 CPU_COPY_STORE_REL(&map, &started_cpus);
342 /* wait for each to clear its bit */
343 while (CPU_OVERLAP(cpus, &map))
350 restart_cpus(cpuset_t map)
353 return (generic_restart_cpus(map, IPI_STOP));
356 #if defined(__amd64__) || defined(__i386__)
358 resume_cpus(cpuset_t map)
361 return (generic_restart_cpus(map, IPI_SUSPEND));
366 * All-CPU rendezvous. CPUs are signalled, all execute the setup function
367 * (if specified), rendezvous, execute the action function (if specified),
368 * rendezvous again, execute the teardown function (if specified), and then
371 * Note that the supplied external functions _must_ be reentrant and aware
372 * that they are running in parallel and in an unknown lock context.
375 smp_rendezvous_action(void)
378 void *local_func_arg;
379 void (*local_setup_func)(void*);
380 void (*local_action_func)(void*);
381 void (*local_teardown_func)(void*);
386 /* Ensure we have up-to-date values. */
387 atomic_add_acq_int(&smp_rv_waiters[0], 1);
388 while (smp_rv_waiters[0] < smp_rv_ncpus)
391 /* Fetch rendezvous parameters after acquire barrier. */
392 local_func_arg = smp_rv_func_arg;
393 local_setup_func = smp_rv_setup_func;
394 local_action_func = smp_rv_action_func;
395 local_teardown_func = smp_rv_teardown_func;
398 * Use a nested critical section to prevent any preemptions
399 * from occurring during a rendezvous action routine.
400 * Specifically, if a rendezvous handler is invoked via an IPI
401 * and the interrupted thread was in the critical_exit()
402 * function after setting td_critnest to 0 but before
403 * performing a deferred preemption, this routine can be
404 * invoked with td_critnest set to 0 and td_owepreempt true.
405 * In that case, a critical_exit() during the rendezvous
406 * action would trigger a preemption which is not permitted in
407 * a rendezvous action. To fix this, wrap all of the
408 * rendezvous action handlers in a critical section. We
409 * cannot use a regular critical section however as having
410 * critical_exit() preempt from this routine would also be
411 * problematic (the preemption must not occur before the IPI
412 * has been acknowledged via an EOI). Instead, we
413 * intentionally ignore td_owepreempt when leaving the
414 * critical section. This should be harmless because we do
415 * not permit rendezvous action routines to schedule threads,
416 * and thus td_owepreempt should never transition from 0 to 1
417 * during this routine.
422 owepreempt = td->td_owepreempt;
426 * If requested, run a setup function before the main action
427 * function. Ensure all CPUs have completed the setup
428 * function before moving on to the action function.
430 if (local_setup_func != smp_no_rendevous_barrier) {
431 if (smp_rv_setup_func != NULL)
432 smp_rv_setup_func(smp_rv_func_arg);
433 atomic_add_int(&smp_rv_waiters[1], 1);
434 while (smp_rv_waiters[1] < smp_rv_ncpus)
438 if (local_action_func != NULL)
439 local_action_func(local_func_arg);
441 if (local_teardown_func != smp_no_rendevous_barrier) {
443 * Signal that the main action has been completed. If a
444 * full exit rendezvous is requested, then all CPUs will
445 * wait here until all CPUs have finished the main action.
447 atomic_add_int(&smp_rv_waiters[2], 1);
448 while (smp_rv_waiters[2] < smp_rv_ncpus)
451 if (local_teardown_func != NULL)
452 local_teardown_func(local_func_arg);
456 * Signal that the rendezvous is fully completed by this CPU.
457 * This means that no member of smp_rv_* pseudo-structure will be
458 * accessed by this target CPU after this point; in particular,
459 * memory pointed by smp_rv_func_arg.
461 atomic_add_int(&smp_rv_waiters[3], 1);
464 KASSERT(owepreempt == td->td_owepreempt,
465 ("rendezvous action changed td_owepreempt"));
469 smp_rendezvous_cpus(cpuset_t map,
470 void (* setup_func)(void *),
471 void (* action_func)(void *),
472 void (* teardown_func)(void *),
475 int curcpumap, i, ncpus = 0;
477 /* Look comments in the !SMP case. */
480 if (setup_func != NULL)
482 if (action_func != NULL)
484 if (teardown_func != NULL)
491 if (CPU_ISSET(i, &map))
495 panic("ncpus is 0 with non-zero map");
497 mtx_lock_spin(&smp_ipi_mtx);
499 /* Pass rendezvous parameters via global variables. */
500 smp_rv_ncpus = ncpus;
501 smp_rv_setup_func = setup_func;
502 smp_rv_action_func = action_func;
503 smp_rv_teardown_func = teardown_func;
504 smp_rv_func_arg = arg;
505 smp_rv_waiters[1] = 0;
506 smp_rv_waiters[2] = 0;
507 smp_rv_waiters[3] = 0;
508 atomic_store_rel_int(&smp_rv_waiters[0], 0);
511 * Signal other processors, which will enter the IPI with
514 curcpumap = CPU_ISSET(curcpu, &map);
515 CPU_CLR(curcpu, &map);
516 ipi_selected(map, IPI_RENDEZVOUS);
518 /* Check if the current CPU is in the map */
520 smp_rendezvous_action();
523 * Ensure that the master CPU waits for all the other
524 * CPUs to finish the rendezvous, so that smp_rv_*
525 * pseudo-structure and the arg are guaranteed to not
528 while (atomic_load_acq_int(&smp_rv_waiters[3]) < ncpus)
531 mtx_unlock_spin(&smp_ipi_mtx);
535 smp_rendezvous(void (* setup_func)(void *),
536 void (* action_func)(void *),
537 void (* teardown_func)(void *),
540 smp_rendezvous_cpus(all_cpus, setup_func, action_func, teardown_func, arg);
543 static struct cpu_group group[MAXCPU];
548 char cpusetbuf[CPUSETBUFSIZ], cpusetbuf2[CPUSETBUFSIZ];
549 struct cpu_group *top;
552 * Check for a fake topology request for debugging purposes.
554 switch (smp_topology) {
556 /* Dual core with no sharing. */
557 top = smp_topo_1level(CG_SHARE_NONE, 2, 0);
560 /* No topology, all cpus are equal. */
561 top = smp_topo_none();
564 /* Dual core with shared L2. */
565 top = smp_topo_1level(CG_SHARE_L2, 2, 0);
568 /* quad core, shared l3 among each package, private l2. */
569 top = smp_topo_1level(CG_SHARE_L3, 4, 0);
572 /* quad core, 2 dualcore parts on each package share l2. */
573 top = smp_topo_2level(CG_SHARE_NONE, 2, CG_SHARE_L2, 2, 0);
576 /* Single-core 2xHTT */
577 top = smp_topo_1level(CG_SHARE_L1, 2, CG_FLAG_HTT);
580 /* quad core with a shared l3, 8 threads sharing L2. */
581 top = smp_topo_2level(CG_SHARE_L3, 4, CG_SHARE_L2, 8,
585 /* Default, ask the system what it wants. */
590 * Verify the returned topology.
592 if (top->cg_count != mp_ncpus)
593 panic("Built bad topology at %p. CPU count %d != %d",
594 top, top->cg_count, mp_ncpus);
595 if (CPU_CMP(&top->cg_mask, &all_cpus))
596 panic("Built bad topology at %p. CPU mask (%s) != (%s)",
597 top, cpusetobj_strprint(cpusetbuf, &top->cg_mask),
598 cpusetobj_strprint(cpusetbuf2, &all_cpus));
605 struct cpu_group *top;
608 top->cg_parent = NULL;
609 top->cg_child = NULL;
610 top->cg_mask = all_cpus;
611 top->cg_count = mp_ncpus;
612 top->cg_children = 0;
613 top->cg_level = CG_SHARE_NONE;
620 smp_topo_addleaf(struct cpu_group *parent, struct cpu_group *child, int share,
621 int count, int flags, int start)
623 char cpusetbuf[CPUSETBUFSIZ], cpusetbuf2[CPUSETBUFSIZ];
628 for (i = 0; i < count; i++, start++)
629 CPU_SET(start, &mask);
630 child->cg_parent = parent;
631 child->cg_child = NULL;
632 child->cg_children = 0;
633 child->cg_level = share;
634 child->cg_count = count;
635 child->cg_flags = flags;
636 child->cg_mask = mask;
637 parent->cg_children++;
638 for (; parent != NULL; parent = parent->cg_parent) {
639 if (CPU_OVERLAP(&parent->cg_mask, &child->cg_mask))
640 panic("Duplicate children in %p. mask (%s) child (%s)",
642 cpusetobj_strprint(cpusetbuf, &parent->cg_mask),
643 cpusetobj_strprint(cpusetbuf2, &child->cg_mask));
644 CPU_OR(&parent->cg_mask, &child->cg_mask);
645 parent->cg_count += child->cg_count;
652 smp_topo_1level(int share, int count, int flags)
654 struct cpu_group *child;
655 struct cpu_group *top;
662 packages = mp_ncpus / count;
663 top->cg_child = child = &group[1];
664 top->cg_level = CG_SHARE_NONE;
665 for (i = 0; i < packages; i++, child++)
666 cpu = smp_topo_addleaf(top, child, share, count, flags, cpu);
671 smp_topo_2level(int l2share, int l2count, int l1share, int l1count,
674 struct cpu_group *top;
675 struct cpu_group *l1g;
676 struct cpu_group *l2g;
685 top->cg_level = CG_SHARE_NONE;
686 top->cg_children = mp_ncpus / (l2count * l1count);
687 l1g = l2g + top->cg_children;
688 for (i = 0; i < top->cg_children; i++, l2g++) {
689 l2g->cg_parent = top;
691 l2g->cg_level = l2share;
692 for (j = 0; j < l2count; j++, l1g++)
693 cpu = smp_topo_addleaf(l2g, l1g, l1share, l1count,
701 smp_topo_find(struct cpu_group *top, int cpu)
703 struct cpu_group *cg;
708 CPU_SETOF(cpu, &mask);
711 if (!CPU_OVERLAP(&cg->cg_mask, &mask))
713 if (cg->cg_children == 0)
715 children = cg->cg_children;
716 for (i = 0, cg = cg->cg_child; i < children; cg++, i++)
717 if (CPU_OVERLAP(&cg->cg_mask, &mask))
725 smp_rendezvous_cpus(cpuset_t map,
726 void (*setup_func)(void *),
727 void (*action_func)(void *),
728 void (*teardown_func)(void *),
732 * In the !SMP case we just need to ensure the same initial conditions
736 if (setup_func != NULL)
738 if (action_func != NULL)
740 if (teardown_func != NULL)
746 smp_rendezvous(void (*setup_func)(void *),
747 void (*action_func)(void *),
748 void (*teardown_func)(void *),
752 /* Look comments in the smp_rendezvous_cpus() case. */
754 if (setup_func != NULL)
756 if (action_func != NULL)
758 if (teardown_func != NULL)
764 * Provide dummy SMP support for UP kernels. Modules that need to use SMP
765 * APIs will still work using this dummy support.
768 mp_setvariables_for_up(void *dummy)
771 mp_maxid = PCPU_GET(cpuid);
772 CPU_SETOF(mp_maxid, &all_cpus);
773 KASSERT(PCPU_GET(cpuid) == 0, ("UP must have a CPU ID of zero"));
775 SYSINIT(cpu_mp_setvariables, SI_SUB_TUNABLES, SI_ORDER_FIRST,
776 mp_setvariables_for_up, NULL);
780 smp_no_rendevous_barrier(void *dummy)
783 KASSERT((!smp_started),("smp_no_rendevous called and smp is started"));
788 * Wait specified idle threads to switch once. This ensures that even
789 * preempted threads have cycled through the switch function once,
790 * exiting their codepaths. This allows us to change global pointers
791 * with no other synchronization.
794 quiesce_cpus(cpuset_t map, const char *wmesg, int prio)
802 for (cpu = 0; cpu <= mp_maxid; cpu++) {
803 if (!CPU_ISSET(cpu, &map) || CPU_ABSENT(cpu))
805 pcpu = pcpu_find(cpu);
806 gen[cpu] = pcpu->pc_idlethread->td_generation;
808 for (cpu = 0; cpu <= mp_maxid; cpu++) {
809 if (!CPU_ISSET(cpu, &map) || CPU_ABSENT(cpu))
811 pcpu = pcpu_find(cpu);
812 thread_lock(curthread);
813 sched_bind(curthread, cpu);
814 thread_unlock(curthread);
815 while (gen[cpu] == pcpu->pc_idlethread->td_generation) {
816 error = tsleep(quiesce_cpus, prio, wmesg, 1);
817 if (error != EWOULDBLOCK)
823 thread_lock(curthread);
824 sched_unbind(curthread);
825 thread_unlock(curthread);
831 quiesce_all_cpus(const char *wmesg, int prio)
834 return quiesce_cpus(all_cpus, wmesg, prio);
837 /* Extra care is taken with this sysctl because the data type is volatile */
839 sysctl_kern_smp_active(SYSCTL_HANDLER_ARGS)
843 active = smp_started;
844 error = SYSCTL_OUT(req, &active, sizeof(active));