include/linux/sched/topology.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_SCHED_TOPOLOGY_H
   3 #define _LINUX_SCHED_TOPOLOGY_H
   4
   5 #include <linux/topology.h>
   6
   7 #include <linux/sched/idle.h>
   8
   9 /*
  10  * sched-domains (multiprocessor balancing) declarations:
  11  */
  12 #ifdef CONFIG_SMP
  13
  14 #define SD_BALANCE_NEWIDLE      0x0001  /* Balance when about to become idle */
  15 #define SD_BALANCE_EXEC         0x0002  /* Balance on exec */
  16 #define SD_BALANCE_FORK         0x0004  /* Balance on fork, clone */
  17 #define SD_BALANCE_WAKE         0x0008  /* Balance on wakeup */
  18 #define SD_WAKE_AFFINE          0x0010  /* Wake task to waking CPU */
  19 #define SD_ASYM_CPUCAPACITY     0x0020  /* Domain members have different CPU capacities */
  20 #define SD_SHARE_CPUCAPACITY    0x0040  /* Domain members share CPU capacity */
  21 #define SD_SHARE_PKG_RESOURCES  0x0080  /* Domain members share CPU pkg resources */
  22 #define SD_SERIALIZE            0x0100  /* Only a single load balancing instance */
  23 #define SD_ASYM_PACKING         0x0200  /* Place busy groups earlier in the domain */
  24 #define SD_PREFER_SIBLING       0x0400  /* Prefer to place tasks in a sibling domain */
  25 #define SD_OVERLAP              0x0800  /* sched_domains of this level overlap */
  26 #define SD_NUMA                 0x1000  /* cross-node balancing */
  27
  28 #ifdef CONFIG_SCHED_SMT
  29 static inline int cpu_smt_flags(void)
  30 {
  31         return SD_SHARE_CPUCAPACITY | SD_SHARE_PKG_RESOURCES;
  32 }
  33 #endif
  34
  35 #ifdef CONFIG_SCHED_MC
  36 static inline int cpu_core_flags(void)
  37 {
  38         return SD_SHARE_PKG_RESOURCES;
  39 }
  40 #endif
  41
  42 #ifdef CONFIG_NUMA
  43 static inline int cpu_numa_flags(void)
  44 {
  45         return SD_NUMA;
  46 }
  47 #endif
  48
  49 extern int arch_asym_cpu_priority(int cpu);
  50
  51 struct sched_domain_attr {
  52         int relax_domain_level;
  53 };
  54
  55 #define SD_ATTR_INIT    (struct sched_domain_attr) {    \
  56         .relax_domain_level = -1,                       \
  57 }
  58
  59 extern int sched_domain_level_max;
  60
  61 struct sched_group;
  62
  63 struct sched_domain_shared {
  64         atomic_t        ref;
  65         atomic_t        nr_busy_cpus;
  66         int             has_idle_cores;
  67 };
  68
  69 struct sched_domain {
  70         /* These fields must be setup */
  71         struct sched_domain __rcu *parent;      /* top domain must be null terminated */
  72         struct sched_domain __rcu *child;       /* bottom domain must be null terminated */
  73         struct sched_group *groups;     /* the balancing groups of the domain */
  74         unsigned long min_interval;     /* Minimum balance interval ms */
  75         unsigned long max_interval;     /* Maximum balance interval ms */
  76         unsigned int busy_factor;       /* less balancing by factor if busy */
  77         unsigned int imbalance_pct;     /* No balance until over watermark */
  78         unsigned int cache_nice_tries;  /* Leave cache hot tasks for # tries */
  79
  80         int nohz_idle;                  /* NOHZ IDLE status */
  81         int flags;                      /* See SD_* */
  82         int level;
  83
  84         /* Runtime fields. */
  85         unsigned long last_balance;     /* init to jiffies. units in jiffies */
  86         unsigned int balance_interval;  /* initialise to 1. units in ms. */
  87         unsigned int nr_balance_failed; /* initialise to 0 */
  88
  89         /* idle_balance() stats */
  90         u64 max_newidle_lb_cost;
  91         unsigned long next_decay_max_lb_cost;
  92
  93         u64 avg_scan_cost;              /* select_idle_sibling */
  94
  95 #ifdef CONFIG_SCHEDSTATS
  96         /* load_balance() stats */
  97         unsigned int lb_count[CPU_MAX_IDLE_TYPES];
  98         unsigned int lb_failed[CPU_MAX_IDLE_TYPES];
  99         unsigned int lb_balanced[CPU_MAX_IDLE_TYPES];
 100         unsigned int lb_imbalance[CPU_MAX_IDLE_TYPES];
 101         unsigned int lb_gained[CPU_MAX_IDLE_TYPES];
 102         unsigned int lb_hot_gained[CPU_MAX_IDLE_TYPES];
 103         unsigned int lb_nobusyg[CPU_MAX_IDLE_TYPES];
 104         unsigned int lb_nobusyq[CPU_MAX_IDLE_TYPES];
 105
 106         /* Active load balancing */
 107         unsigned int alb_count;
 108         unsigned int alb_failed;
 109         unsigned int alb_pushed;
 110
 111         /* SD_BALANCE_EXEC stats */
 112         unsigned int sbe_count;
 113         unsigned int sbe_balanced;
 114         unsigned int sbe_pushed;
 115
 116         /* SD_BALANCE_FORK stats */
 117         unsigned int sbf_count;
 118         unsigned int sbf_balanced;
 119         unsigned int sbf_pushed;
 120
 121         /* try_to_wake_up() stats */
 122         unsigned int ttwu_wake_remote;
 123         unsigned int ttwu_move_affine;
 124         unsigned int ttwu_move_balance;
 125 #endif
 126 #ifdef CONFIG_SCHED_DEBUG
 127         char *name;
 128 #endif
 129         union {
 130                 void *private;          /* used during construction */
 131                 struct rcu_head rcu;    /* used during destruction */
 132         };
 133         struct sched_domain_shared *shared;
 134
 135         unsigned int span_weight;
 136         /*
 137          * Span of all CPUs in this domain.
 138          *
 139          * NOTE: this field is variable length. (Allocated dynamically
 140          * by attaching extra space to the end of the structure,
 141          * depending on how many CPUs the kernel has booted up with)
 142          */
 143         unsigned long span[];
 144 };
 145
 146 static inline struct cpumask *sched_domain_span(struct sched_domain *sd)
 147 {
 148         return to_cpumask(sd->span);
 149 }
 150
 151 extern void partition_sched_domains_locked(int ndoms_new,
 152                                            cpumask_var_t doms_new[],
 153                                            struct sched_domain_attr *dattr_new);
 154
 155 extern void partition_sched_domains(int ndoms_new, cpumask_var_t doms_new[],
 156                                     struct sched_domain_attr *dattr_new);
 157
 158 /* Allocate an array of sched domains, for partition_sched_domains(). */
 159 cpumask_var_t *alloc_sched_domains(unsigned int ndoms);
 160 void free_sched_domains(cpumask_var_t doms[], unsigned int ndoms);
 161
 162 bool cpus_share_cache(int this_cpu, int that_cpu);
 163
 164 typedef const struct cpumask *(*sched_domain_mask_f)(int cpu);
 165 typedef int (*sched_domain_flags_f)(void);
 166
 167 #define SDTL_OVERLAP    0x01
 168
 169 struct sd_data {
 170         struct sched_domain *__percpu *sd;
 171         struct sched_domain_shared *__percpu *sds;
 172         struct sched_group *__percpu *sg;
 173         struct sched_group_capacity *__percpu *sgc;
 174 };
 175
 176 struct sched_domain_topology_level {
 177         sched_domain_mask_f mask;
 178         sched_domain_flags_f sd_flags;
 179         int                 flags;
 180         int                 numa_level;
 181         struct sd_data      data;
 182 #ifdef CONFIG_SCHED_DEBUG
 183         char                *name;
 184 #endif
 185 };
 186
 187 extern void set_sched_topology(struct sched_domain_topology_level *tl);
 188
 189 #ifdef CONFIG_SCHED_DEBUG
 190 # define SD_INIT_NAME(type)             .name = #type
 191 #else
 192 # define SD_INIT_NAME(type)
 193 #endif
 194
 195 #else /* CONFIG_SMP */
 196
 197 struct sched_domain_attr;
 198
 199 static inline void
 200 partition_sched_domains_locked(int ndoms_new, cpumask_var_t doms_new[],
 201                                struct sched_domain_attr *dattr_new)
 202 {
 203 }
 204
 205 static inline void
 206 partition_sched_domains(int ndoms_new, cpumask_var_t doms_new[],
 207                         struct sched_domain_attr *dattr_new)
 208 {
 209 }
 210
 211 static inline bool cpus_share_cache(int this_cpu, int that_cpu)
 212 {
 213         return true;
 214 }
 215
 216 #endif  /* !CONFIG_SMP */
 217
 218 #ifndef arch_scale_cpu_capacity
 219 /**
 220  * arch_scale_cpu_capacity - get the capacity scale factor of a given CPU.
 221  * @cpu: the CPU in question.
 222  *
 223  * Return: the CPU scale factor normalized against SCHED_CAPACITY_SCALE, i.e.
 224  *
 225  *             max_perf(cpu)
 226  *      ----------------------------- * SCHED_CAPACITY_SCALE
 227  *      max(max_perf(c) : c \in CPUs)
 228  */
 229 static __always_inline
 230 unsigned long arch_scale_cpu_capacity(int cpu)
 231 {
 232         return SCHED_CAPACITY_SCALE;
 233 }
 234 #endif
 235
 236 #ifndef arch_scale_thermal_pressure
 237 static __always_inline
 238 unsigned long arch_scale_thermal_pressure(int cpu)
 239 {
 240         return 0;
 241 }
 242 #endif
 243
 244 #ifndef arch_set_thermal_pressure
 245 static __always_inline
 246 void arch_set_thermal_pressure(const struct cpumask *cpus,
 247                                unsigned long th_pressure)
 248 { }
 249 #endif
 250
 251 static inline int task_node(const struct task_struct *p)
 252 {
 253         return cpu_to_node(task_cpu(p));
 254 }
 255
 256 #endif /* _LINUX_SCHED_TOPOLOGY_H */