sys/sys/smp.h

   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$
  10  */
  11
  12 #ifndef _SYS_SMP_H_
  13 #define _SYS_SMP_H_
  14
  15 #ifdef _KERNEL
  16
  17 #ifndef LOCORE
  18
  19 #ifdef SMP
  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
  34 struct cpu_group {
  35         struct cpu_group *cg_parent;    /* Our parent group. */
  36         struct cpu_group *cg_child;     /* Optional children groups. */
  37         cpumask_t       cg_mask;        /* Mask of cpus in this group. */
  38         int8_t          cg_count;       /* Count of cpus in this group. */
  39         int8_t          cg_children;    /* Number of children groups. */
  40         int8_t          cg_level;       /* Shared cache level. */
  41         int8_t          cg_flags;       /* Traversal modifiers. */
  42 };
  43
  44 /*
  45  * Defines common resources for CPUs in the group.  The highest level
  46  * resource should be used when multiple are shared.
  47  */
  48 #define CG_SHARE_NONE   0
  49 #define CG_SHARE_L1     1
  50 #define CG_SHARE_L2     2
  51 #define CG_SHARE_L3     3
  52
  53 /*
  54  * Behavior modifiers for load balancing and affinity.
  55  */
  56 #define CG_FLAG_HTT     0x01            /* Schedule the alternate core last. */
  57 #define CG_FLAG_SMT     0x02            /* New age htt, less crippled. */
  58 #define CG_FLAG_THREAD  (CG_FLAG_HTT | CG_FLAG_SMT)     /* Any threading. */
  59
  60 /*
  61  * Convenience routines for building topologies.
  62  */
  63 struct cpu_group *smp_topo(void);
  64 struct cpu_group *smp_topo_none(void);
  65 struct cpu_group *smp_topo_1level(int l1share, int l1count, int l1flags);
  66 struct cpu_group *smp_topo_2level(int l2share, int l2count, int l1share,
  67     int l1count, int l1flags);
  68 struct cpu_group *smp_topo_find(struct cpu_group *top, int cpu);
  69
  70 extern void (*cpustop_restartfunc)(void);
  71 extern int smp_active;
  72 extern int smp_cpus;
  73 extern volatile cpumask_t started_cpus;
  74 extern volatile cpumask_t stopped_cpus;
  75 extern cpumask_t idle_cpus_mask;
  76 extern cpumask_t hlt_cpus_mask;
  77 extern cpumask_t logical_cpus_mask;
  78 #endif /* SMP */
  79
  80 extern u_int mp_maxid;
  81 extern int mp_maxcpus;
  82 extern int mp_ncpus;
  83 extern volatile int smp_started;
  84
  85 extern cpumask_t all_cpus;
  86
  87 /*
  88  * Macro allowing us to determine whether a CPU is absent at any given
  89  * time, thus permitting us to configure sparse maps of cpuid-dependent
  90  * (per-CPU) structures.
  91  */
  92 #define CPU_ABSENT(x_cpu)       ((all_cpus & (1 << (x_cpu))) == 0)
  93
  94 /*
  95  * Macros to iterate over non-absent CPUs.  CPU_FOREACH() takes an
  96  * integer iterator and iterates over the available set of CPUs.
  97  * CPU_FIRST() returns the id of the first non-absent CPU.  CPU_NEXT()
  98  * returns the id of the next non-absent CPU.  It will wrap back to
  99  * CPU_FIRST() once the end of the list is reached.  The iterators are
 100  * currently implemented via inline functions.
 101  */
 102 #define CPU_FOREACH(i)                                                  \
 103         for ((i) = 0; (i) <= mp_maxid; (i)++)                           \
 104                 if (!CPU_ABSENT((i)))
 105
 106 static __inline int
 107 cpu_first(void)
 108 {
 109         int i;
 110
 111         for (i = 0;; i++)
 112                 if (!CPU_ABSENT(i))
 113                         return (i);
 114 }
 115
 116 static __inline int
 117 cpu_next(int i)
 118 {
 119
 120         for (;;) {
 121                 i++;
 122                 if (i > mp_maxid)
 123                         i = 0;
 124                 if (!CPU_ABSENT(i))
 125                         return (i);
 126         }
 127 }
 128
 129 #define CPU_FIRST()     cpu_first()
 130 #define CPU_NEXT(i)     cpu_next((i))
 131
 132 #ifdef SMP
 133 /*
 134  * Machine dependent functions used to initialize MP support.
 135  *
 136  * The cpu_mp_probe() should check to see if MP support is present and return
 137  * zero if it is not or non-zero if it is.  If MP support is present, then
 138  * cpu_mp_start() will be called so that MP can be enabled.  This function
 139  * should do things such as startup secondary processors.  It should also
 140  * setup mp_ncpus, all_cpus, and smp_cpus.  It should also ensure that
 141  * smp_active and smp_started are initialized at the appropriate time.
 142  * Once cpu_mp_start() returns, machine independent MP startup code will be
 143  * executed and a simple message will be output to the console.  Finally,
 144  * cpu_mp_announce() will be called so that machine dependent messages about
 145  * the MP support may be output to the console if desired.
 146  *
 147  * The cpu_setmaxid() function is called very early during the boot process
 148  * so that the MD code may set mp_maxid to provide an upper bound on CPU IDs
 149  * that other subsystems may use.  If a platform is not able to determine
 150  * the exact maximum ID that early, then it may set mp_maxid to MAXCPU - 1.
 151  */
 152 struct thread;
 153
 154 struct cpu_group *cpu_topo(void);
 155 void    cpu_mp_announce(void);
 156 int     cpu_mp_probe(void);
 157 void    cpu_mp_setmaxid(void);
 158 void    cpu_mp_start(void);
 159
 160 void    forward_signal(struct thread *);
 161 int     restart_cpus(cpumask_t);
 162 int     stop_cpus(cpumask_t);
 163 int     stop_cpus_hard(cpumask_t);
 164 #if defined(__amd64__)
 165 int     suspend_cpus(cpumask_t);
 166 #endif
 167 void    smp_rendezvous_action(void);
 168 extern  struct mtx smp_ipi_mtx;
 169
 170 #endif /* SMP */
 171 void    smp_no_rendevous_barrier(void *);
 172 void    smp_rendezvous(void (*)(void *),
 173                        void (*)(void *),
 174                        void (*)(void *),
 175                        void *arg);
 176 void    smp_rendezvous_cpus(cpumask_t,
 177                        void (*)(void *),
 178                        void (*)(void *),
 179                        void (*)(void *),
 180                        void *arg);
 181 #endif /* !LOCORE */
 182 #endif /* _KERNEL */
 183 #endif /* _SYS_SMP_H_ */