smp.h revision 236772
1/*- 2 * ---------------------------------------------------------------------------- 3 * "THE BEER-WARE LICENSE" (Revision 42): 4 * <phk@FreeBSD.org> wrote this file. As long as you retain this notice you 5 * can do whatever you want with this stuff. If we meet some day, and you think 6 * this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp 7 * ---------------------------------------------------------------------------- 8 * 9 * $FreeBSD: head/sys/sys/smp.h 236772 2012-06-09 00:37:26Z iwasaki $ 10 */ 11 12#ifndef _SYS_SMP_H_ 13#define _SYS_SMP_H_ 14 15#ifdef _KERNEL 16 17#ifndef LOCORE 18 19#include <sys/cpuset.h> 20 21/* 22 * Topology of a NUMA or HTT system. 23 * 24 * The top level topology is an array of pointers to groups. Each group 25 * contains a bitmask of cpus in its group or subgroups. It may also 26 * contain a pointer to an array of child groups. 27 * 28 * The bitmasks at non leaf groups may be used by consumers who support 29 * a smaller depth than the hardware provides. 30 * 31 * The topology may be omitted by systems where all CPUs are equal. 32 */ 33 34struct cpu_group { 35 struct cpu_group *cg_parent; /* Our parent group. */ 36 struct cpu_group *cg_child; /* Optional children groups. */ 37 cpuset_t cg_mask; /* Mask of cpus in this group. */ 38 int32_t cg_count; /* Count of cpus in this group. */ 39 int16_t cg_children; /* Number of children groups. */ 40 int8_t cg_level; /* Shared cache level. */ 41 int8_t cg_flags; /* Traversal modifiers. */ 42}; 43 44typedef struct cpu_group *cpu_group_t; 45 46/* 47 * Defines common resources for CPUs in the group. The highest level 48 * resource should be used when multiple are shared. 49 */ 50#define CG_SHARE_NONE 0 51#define CG_SHARE_L1 1 52#define CG_SHARE_L2 2 53#define CG_SHARE_L3 3 54 55/* 56 * Behavior modifiers for load balancing and affinity. 57 */ 58#define CG_FLAG_HTT 0x01 /* Schedule the alternate core last. */ 59#define CG_FLAG_SMT 0x02 /* New age htt, less crippled. */ 60#define CG_FLAG_THREAD (CG_FLAG_HTT | CG_FLAG_SMT) /* Any threading. */ 61 62/* 63 * Convenience routines for building topologies. 64 */ 65#ifdef SMP 66struct cpu_group *smp_topo(void); 67struct cpu_group *smp_topo_none(void); 68struct cpu_group *smp_topo_1level(int l1share, int l1count, int l1flags); 69struct cpu_group *smp_topo_2level(int l2share, int l2count, int l1share, 70 int l1count, int l1flags); 71struct cpu_group *smp_topo_find(struct cpu_group *top, int cpu); 72 73extern void (*cpustop_restartfunc)(void); 74extern int smp_active; 75extern int smp_cpus; 76extern volatile cpuset_t started_cpus; 77extern volatile cpuset_t stopped_cpus; 78extern volatile cpuset_t suspended_cpus; 79extern cpuset_t hlt_cpus_mask; 80extern cpuset_t logical_cpus_mask; 81#endif /* SMP */ 82 83extern u_int mp_maxid; 84extern int mp_maxcpus; 85extern int mp_ncpus; 86extern volatile int smp_started; 87 88extern cpuset_t all_cpus; 89 90/* 91 * Macro allowing us to determine whether a CPU is absent at any given 92 * time, thus permitting us to configure sparse maps of cpuid-dependent 93 * (per-CPU) structures. 94 */ 95#define CPU_ABSENT(x_cpu) (!CPU_ISSET(x_cpu, &all_cpus)) 96 97/* 98 * Macros to iterate over non-absent CPUs. CPU_FOREACH() takes an 99 * integer iterator and iterates over the available set of CPUs. 100 * CPU_FIRST() returns the id of the first non-absent CPU. CPU_NEXT() 101 * returns the id of the next non-absent CPU. It will wrap back to 102 * CPU_FIRST() once the end of the list is reached. The iterators are 103 * currently implemented via inline functions. 104 */ 105#define CPU_FOREACH(i) \ 106 for ((i) = 0; (i) <= mp_maxid; (i)++) \ 107 if (!CPU_ABSENT((i))) 108 109static __inline int 110cpu_first(void) 111{ 112 int i; 113 114 for (i = 0;; i++) 115 if (!CPU_ABSENT(i)) 116 return (i); 117} 118 119static __inline int 120cpu_next(int i) 121{ 122 123 for (;;) { 124 i++; 125 if (i > mp_maxid) 126 i = 0; 127 if (!CPU_ABSENT(i)) 128 return (i); 129 } 130} 131 132#define CPU_FIRST() cpu_first() 133#define CPU_NEXT(i) cpu_next((i)) 134 135#ifdef SMP 136/* 137 * Machine dependent functions used to initialize MP support. 138 * 139 * The cpu_mp_probe() should check to see if MP support is present and return 140 * zero if it is not or non-zero if it is. If MP support is present, then 141 * cpu_mp_start() will be called so that MP can be enabled. This function 142 * should do things such as startup secondary processors. It should also 143 * setup mp_ncpus, all_cpus, and smp_cpus. It should also ensure that 144 * smp_active and smp_started are initialized at the appropriate time. 145 * Once cpu_mp_start() returns, machine independent MP startup code will be 146 * executed and a simple message will be output to the console. Finally, 147 * cpu_mp_announce() will be called so that machine dependent messages about 148 * the MP support may be output to the console if desired. 149 * 150 * The cpu_setmaxid() function is called very early during the boot process 151 * so that the MD code may set mp_maxid to provide an upper bound on CPU IDs 152 * that other subsystems may use. If a platform is not able to determine 153 * the exact maximum ID that early, then it may set mp_maxid to MAXCPU - 1. 154 */ 155struct thread; 156 157struct cpu_group *cpu_topo(void); 158void cpu_mp_announce(void); 159int cpu_mp_probe(void); 160void cpu_mp_setmaxid(void); 161void cpu_mp_start(void); 162 163void forward_signal(struct thread *); 164int restart_cpus(cpuset_t); 165int stop_cpus(cpuset_t); 166int stop_cpus_hard(cpuset_t); 167#if defined(__amd64__) || defined(__i386__) 168int suspend_cpus(cpuset_t); 169#endif 170void smp_rendezvous_action(void); 171extern struct mtx smp_ipi_mtx; 172 173#endif /* SMP */ 174void smp_no_rendevous_barrier(void *); 175void smp_rendezvous(void (*)(void *), 176 void (*)(void *), 177 void (*)(void *), 178 void *arg); 179void smp_rendezvous_cpus(cpuset_t, 180 void (*)(void *), 181 void (*)(void *), 182 void (*)(void *), 183 void *arg); 184#endif /* !LOCORE */ 185#endif /* _KERNEL */ 186#endif /* _SYS_SMP_H_ */ 187