kernel/sched/cpupri.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  kernel/sched/cpupri.c
   4  *
   5  *  CPU priority management
   6  *
   7  *  Copyright (C) 2007-2008 Novell
   8  *
   9  *  Author: Gregory Haskins <ghaskins@novell.com>
  10  *
  11  *  This code tracks the priority of each CPU so that global migration
  12  *  decisions are easy to calculate.  Each CPU can be in a state as follows:
  13  *
  14  *                 (INVALID), NORMAL, RT1, ... RT99
  15  *
  16  *  going from the lowest priority to the highest.  CPUs in the INVALID state
  17  *  are not eligible for routing.  The system maintains this state with
  18  *  a 2 dimensional bitmap (the first for priority class, the second for CPUs
  19  *  in that class).  Therefore a typical application without affinity
  20  *  restrictions can find a suitable CPU with O(1) complexity (e.g. two bit
  21  *  searches).  For tasks with affinity restrictions, the algorithm has a
  22  *  worst case complexity of O(min(100, nr_domcpus)), though the scenario that
  23  *  yields the worst case search is fairly contrived.
  24  */
  25 #include "sched.h"
  26
  27 /* Convert between a 140 based task->prio, and our 100 based cpupri */
  28 static int convert_prio(int prio)
  29 {
  30         int cpupri;
  31
  32         if (prio == CPUPRI_INVALID)
  33                 cpupri = CPUPRI_INVALID;
  34         else if (prio >= MAX_RT_PRIO)
  35                 cpupri = CPUPRI_NORMAL;
  36         else
  37                 cpupri = MAX_RT_PRIO - prio - 1;
  38
  39         return cpupri;
  40 }
  41
  42 static inline int __cpupri_find(struct cpupri *cp, struct task_struct *p,
  43                                 struct cpumask *lowest_mask, int idx)
  44 {
  45         struct cpupri_vec *vec  = &cp->pri_to_cpu[idx];
  46         int skip = 0;
  47
  48         if (!atomic_read(&(vec)->count))
  49                 skip = 1;
  50         /*
  51          * When looking at the vector, we need to read the counter,
  52          * do a memory barrier, then read the mask.
  53          *
  54          * Note: This is still all racey, but we can deal with it.
  55          *  Ideally, we only want to look at masks that are set.
  56          *
  57          *  If a mask is not set, then the only thing wrong is that we
  58          *  did a little more work than necessary.
  59          *
  60          *  If we read a zero count but the mask is set, because of the
  61          *  memory barriers, that can only happen when the highest prio
  62          *  task for a run queue has left the run queue, in which case,
  63          *  it will be followed by a pull. If the task we are processing
  64          *  fails to find a proper place to go, that pull request will
  65          *  pull this task if the run queue is running at a lower
  66          *  priority.
  67          */
  68         smp_rmb();
  69
  70         /* Need to do the rmb for every iteration */
  71         if (skip)
  72                 return 0;
  73
  74         if (cpumask_any_and(p->cpus_ptr, vec->mask) >= nr_cpu_ids)
  75                 return 0;
  76
  77         if (lowest_mask) {
  78                 cpumask_and(lowest_mask, p->cpus_ptr, vec->mask);
  79
  80                 /*
  81                  * We have to ensure that we have at least one bit
  82                  * still set in the array, since the map could have
  83                  * been concurrently emptied between the first and
  84                  * second reads of vec->mask.  If we hit this
  85                  * condition, simply act as though we never hit this
  86                  * priority level and continue on.
  87                  */
  88                 if (cpumask_empty(lowest_mask))
  89                         return 0;
  90         }
  91
  92         return 1;
  93 }
  94
  95 int cpupri_find(struct cpupri *cp, struct task_struct *p,
  96                 struct cpumask *lowest_mask)
  97 {
  98         return cpupri_find_fitness(cp, p, lowest_mask, NULL);
  99 }
 100
 101 /**
 102  * cpupri_find_fitness - find the best (lowest-pri) CPU in the system
 103  * @cp: The cpupri context
 104  * @p: The task
 105  * @lowest_mask: A mask to fill in with selected CPUs (or NULL)
 106  * @fitness_fn: A pointer to a function to do custom checks whether the CPU
 107  *              fits a specific criteria so that we only return those CPUs.
 108  *
 109  * Note: This function returns the recommended CPUs as calculated during the
 110  * current invocation.  By the time the call returns, the CPUs may have in
 111  * fact changed priorities any number of times.  While not ideal, it is not
 112  * an issue of correctness since the normal rebalancer logic will correct
 113  * any discrepancies created by racing against the uncertainty of the current
 114  * priority configuration.
 115  *
 116  * Return: (int)bool - CPUs were found
 117  */
 118 int cpupri_find_fitness(struct cpupri *cp, struct task_struct *p,
 119                 struct cpumask *lowest_mask,
 120                 bool (*fitness_fn)(struct task_struct *p, int cpu))
 121 {
 122         int task_pri = convert_prio(p->prio);
 123         int idx, cpu;
 124
 125         BUG_ON(task_pri >= CPUPRI_NR_PRIORITIES);
 126
 127         for (idx = 0; idx < task_pri; idx++) {
 128
 129                 if (!__cpupri_find(cp, p, lowest_mask, idx))
 130                         continue;
 131
 132                 if (!lowest_mask || !fitness_fn)
 133                         return 1;
 134
 135                 /* Ensure the capacity of the CPUs fit the task */
 136                 for_each_cpu(cpu, lowest_mask) {
 137                         if (!fitness_fn(p, cpu))
 138                                 cpumask_clear_cpu(cpu, lowest_mask);
 139                 }
 140
 141                 /*
 142                  * If no CPU at the current priority can fit the task
 143                  * continue looking
 144                  */
 145                 if (cpumask_empty(lowest_mask))
 146                         continue;
 147
 148                 return 1;
 149         }
 150
 151         /*
 152          * If we failed to find a fitting lowest_mask, kick off a new search
 153          * but without taking into account any fitness criteria this time.
 154          *
 155          * This rule favours honouring priority over fitting the task in the
 156          * correct CPU (Capacity Awareness being the only user now).
 157          * The idea is that if a higher priority task can run, then it should
 158          * run even if this ends up being on unfitting CPU.
 159          *
 160          * The cost of this trade-off is not entirely clear and will probably
 161          * be good for some workloads and bad for others.
 162          *
 163          * The main idea here is that if some CPUs were overcommitted, we try
 164          * to spread which is what the scheduler traditionally did. Sys admins
 165          * must do proper RT planning to avoid overloading the system if they
 166          * really care.
 167          */
 168         if (fitness_fn)
 169                 return cpupri_find(cp, p, lowest_mask);
 170
 171         return 0;
 172 }
 173
 174 /**
 175  * cpupri_set - update the CPU priority setting
 176  * @cp: The cpupri context
 177  * @cpu: The target CPU
 178  * @newpri: The priority (INVALID-RT99) to assign to this CPU
 179  *
 180  * Note: Assumes cpu_rq(cpu)->lock is locked
 181  *
 182  * Returns: (void)
 183  */
 184 void cpupri_set(struct cpupri *cp, int cpu, int newpri)
 185 {
 186         int *currpri = &cp->cpu_to_pri[cpu];
 187         int oldpri = *currpri;
 188         int do_mb = 0;
 189
 190         newpri = convert_prio(newpri);
 191
 192         BUG_ON(newpri >= CPUPRI_NR_PRIORITIES);
 193
 194         if (newpri == oldpri)
 195                 return;
 196
 197         /*
 198          * If the CPU was currently mapped to a different value, we
 199          * need to map it to the new value then remove the old value.
 200          * Note, we must add the new value first, otherwise we risk the
 201          * cpu being missed by the priority loop in cpupri_find.
 202          */
 203         if (likely(newpri != CPUPRI_INVALID)) {
 204                 struct cpupri_vec *vec = &cp->pri_to_cpu[newpri];
 205
 206                 cpumask_set_cpu(cpu, vec->mask);
 207                 /*
 208                  * When adding a new vector, we update the mask first,
 209                  * do a write memory barrier, and then update the count, to
 210                  * make sure the vector is visible when count is set.
 211                  */
 212                 smp_mb__before_atomic();
 213                 atomic_inc(&(vec)->count);
 214                 do_mb = 1;
 215         }
 216         if (likely(oldpri != CPUPRI_INVALID)) {
 217                 struct cpupri_vec *vec  = &cp->pri_to_cpu[oldpri];
 218
 219                 /*
 220                  * Because the order of modification of the vec->count
 221                  * is important, we must make sure that the update
 222                  * of the new prio is seen before we decrement the
 223                  * old prio. This makes sure that the loop sees
 224                  * one or the other when we raise the priority of
 225                  * the run queue. We don't care about when we lower the
 226                  * priority, as that will trigger an rt pull anyway.
 227                  *
 228                  * We only need to do a memory barrier if we updated
 229                  * the new priority vec.
 230                  */
 231                 if (do_mb)
 232                         smp_mb__after_atomic();
 233
 234                 /*
 235                  * When removing from the vector, we decrement the counter first
 236                  * do a memory barrier and then clear the mask.
 237                  */
 238                 atomic_dec(&(vec)->count);
 239                 smp_mb__after_atomic();
 240                 cpumask_clear_cpu(cpu, vec->mask);
 241         }
 242
 243         *currpri = newpri;
 244 }
 245
 246 /**
 247  * cpupri_init - initialize the cpupri structure
 248  * @cp: The cpupri context
 249  *
 250  * Return: -ENOMEM on memory allocation failure.
 251  */
 252 int cpupri_init(struct cpupri *cp)
 253 {
 254         int i;
 255
 256         for (i = 0; i < CPUPRI_NR_PRIORITIES; i++) {
 257                 struct cpupri_vec *vec = &cp->pri_to_cpu[i];
 258
 259                 atomic_set(&vec->count, 0);
 260                 if (!zalloc_cpumask_var(&vec->mask, GFP_KERNEL))
 261                         goto cleanup;
 262         }
 263
 264         cp->cpu_to_pri = kcalloc(nr_cpu_ids, sizeof(int), GFP_KERNEL);
 265         if (!cp->cpu_to_pri)
 266                 goto cleanup;
 267
 268         for_each_possible_cpu(i)
 269                 cp->cpu_to_pri[i] = CPUPRI_INVALID;
 270
 271         return 0;
 272
 273 cleanup:
 274         for (i--; i >= 0; i--)
 275                 free_cpumask_var(cp->pri_to_cpu[i].mask);
 276         return -ENOMEM;
 277 }
 278
 279 /**
 280  * cpupri_cleanup - clean up the cpupri structure
 281  * @cp: The cpupri context
 282  */
 283 void cpupri_cleanup(struct cpupri *cp)
 284 {
 285         int i;
 286
 287         kfree(cp->cpu_to_pri);
 288         for (i = 0; i < CPUPRI_NR_PRIORITIES; i++)
 289                 free_cpumask_var(cp->pri_to_cpu[i].mask);
 290 }