9baeb1a2dfdd450eda93297bf457f53787835c88
[linux-2.6-microblaze.git] / kernel / sched / sched.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Scheduler internal types and methods:
4  */
5 #ifndef _KERNEL_SCHED_SCHED_H
6 #define _KERNEL_SCHED_SCHED_H
7
8 #include <linux/sched/affinity.h>
9 #include <linux/sched/autogroup.h>
10 #include <linux/sched/cpufreq.h>
11 #include <linux/sched/deadline.h>
12 #include <linux/sched.h>
13 #include <linux/sched/loadavg.h>
14 #include <linux/sched/mm.h>
15 #include <linux/sched/rseq_api.h>
16 #include <linux/sched/signal.h>
17 #include <linux/sched/smt.h>
18 #include <linux/sched/stat.h>
19 #include <linux/sched/sysctl.h>
20 #include <linux/sched/task_flags.h>
21 #include <linux/sched/task.h>
22 #include <linux/sched/topology.h>
23
24 #include <linux/atomic.h>
25 #include <linux/bitmap.h>
26 #include <linux/bug.h>
27 #include <linux/capability.h>
28 #include <linux/cgroup_api.h>
29 #include <linux/cgroup.h>
30 #include <linux/context_tracking.h>
31 #include <linux/cpufreq.h>
32 #include <linux/cpumask_api.h>
33 #include <linux/ctype.h>
34 #include <linux/file.h>
35 #include <linux/fs_api.h>
36 #include <linux/hrtimer_api.h>
37 #include <linux/interrupt.h>
38 #include <linux/irq_work.h>
39 #include <linux/jiffies.h>
40 #include <linux/kref_api.h>
41 #include <linux/kthread.h>
42 #include <linux/ktime_api.h>
43 #include <linux/lockdep_api.h>
44 #include <linux/lockdep.h>
45 #include <linux/minmax.h>
46 #include <linux/mm.h>
47 #include <linux/module.h>
48 #include <linux/mutex_api.h>
49 #include <linux/plist.h>
50 #include <linux/poll.h>
51 #include <linux/proc_fs.h>
52 #include <linux/profile.h>
53 #include <linux/psi.h>
54 #include <linux/rcupdate.h>
55 #include <linux/seq_file.h>
56 #include <linux/seqlock.h>
57 #include <linux/softirq.h>
58 #include <linux/spinlock_api.h>
59 #include <linux/static_key.h>
60 #include <linux/stop_machine.h>
61 #include <linux/syscalls_api.h>
62 #include <linux/syscalls.h>
63 #include <linux/tick.h>
64 #include <linux/topology.h>
65 #include <linux/types.h>
66 #include <linux/u64_stats_sync_api.h>
67 #include <linux/uaccess.h>
68 #include <linux/wait_api.h>
69 #include <linux/wait_bit.h>
70 #include <linux/workqueue_api.h>
71
72 #include <trace/events/power.h>
73 #include <trace/events/sched.h>
74
75 #include "../workqueue_internal.h"
76
77 #ifdef CONFIG_CGROUP_SCHED
78 #include <linux/cgroup.h>
79 #include <linux/psi.h>
80 #endif
81
82 #ifdef CONFIG_SCHED_DEBUG
83 # include <linux/static_key.h>
84 #endif
85
86 #ifdef CONFIG_PARAVIRT
87 # include <asm/paravirt.h>
88 # include <asm/paravirt_api_clock.h>
89 #endif
90
91 #include "cpupri.h"
92 #include "cpudeadline.h"
93
94 #ifdef CONFIG_SCHED_DEBUG
95 # define SCHED_WARN_ON(x)      WARN_ONCE(x, #x)
96 #else
97 # define SCHED_WARN_ON(x)      ({ (void)(x), 0; })
98 #endif
99
100 struct rq;
101 struct cpuidle_state;
102
103 /* task_struct::on_rq states: */
104 #define TASK_ON_RQ_QUEUED       1
105 #define TASK_ON_RQ_MIGRATING    2
106
107 extern __read_mostly int scheduler_running;
108
109 extern unsigned long calc_load_update;
110 extern atomic_long_t calc_load_tasks;
111
112 extern unsigned int sysctl_sched_child_runs_first;
113
114 extern void calc_global_load_tick(struct rq *this_rq);
115 extern long calc_load_fold_active(struct rq *this_rq, long adjust);
116
117 extern void call_trace_sched_update_nr_running(struct rq *rq, int count);
118
119 extern unsigned int sysctl_sched_rt_period;
120 extern int sysctl_sched_rt_runtime;
121 extern int sched_rr_timeslice;
122
123 /*
124  * Helpers for converting nanosecond timing to jiffy resolution
125  */
126 #define NS_TO_JIFFIES(TIME)     ((unsigned long)(TIME) / (NSEC_PER_SEC / HZ))
127
128 /*
129  * Increase resolution of nice-level calculations for 64-bit architectures.
130  * The extra resolution improves shares distribution and load balancing of
131  * low-weight task groups (eg. nice +19 on an autogroup), deeper taskgroup
132  * hierarchies, especially on larger systems. This is not a user-visible change
133  * and does not change the user-interface for setting shares/weights.
134  *
135  * We increase resolution only if we have enough bits to allow this increased
136  * resolution (i.e. 64-bit). The costs for increasing resolution when 32-bit
137  * are pretty high and the returns do not justify the increased costs.
138  *
139  * Really only required when CONFIG_FAIR_GROUP_SCHED=y is also set, but to
140  * increase coverage and consistency always enable it on 64-bit platforms.
141  */
142 #ifdef CONFIG_64BIT
143 # define NICE_0_LOAD_SHIFT      (SCHED_FIXEDPOINT_SHIFT + SCHED_FIXEDPOINT_SHIFT)
144 # define scale_load(w)          ((w) << SCHED_FIXEDPOINT_SHIFT)
145 # define scale_load_down(w) \
146 ({ \
147         unsigned long __w = (w); \
148         if (__w) \
149                 __w = max(2UL, __w >> SCHED_FIXEDPOINT_SHIFT); \
150         __w; \
151 })
152 #else
153 # define NICE_0_LOAD_SHIFT      (SCHED_FIXEDPOINT_SHIFT)
154 # define scale_load(w)          (w)
155 # define scale_load_down(w)     (w)
156 #endif
157
158 /*
159  * Task weight (visible to users) and its load (invisible to users) have
160  * independent resolution, but they should be well calibrated. We use
161  * scale_load() and scale_load_down(w) to convert between them. The
162  * following must be true:
163  *
164  *  scale_load(sched_prio_to_weight[NICE_TO_PRIO(0)-MAX_RT_PRIO]) == NICE_0_LOAD
165  *
166  */
167 #define NICE_0_LOAD             (1L << NICE_0_LOAD_SHIFT)
168
169 /*
170  * Single value that decides SCHED_DEADLINE internal math precision.
171  * 10 -> just above 1us
172  * 9  -> just above 0.5us
173  */
174 #define DL_SCALE                10
175
176 /*
177  * Single value that denotes runtime == period, ie unlimited time.
178  */
179 #define RUNTIME_INF             ((u64)~0ULL)
180
181 static inline int idle_policy(int policy)
182 {
183         return policy == SCHED_IDLE;
184 }
185 static inline int fair_policy(int policy)
186 {
187         return policy == SCHED_NORMAL || policy == SCHED_BATCH;
188 }
189
190 static inline int rt_policy(int policy)
191 {
192         return policy == SCHED_FIFO || policy == SCHED_RR;
193 }
194
195 static inline int dl_policy(int policy)
196 {
197         return policy == SCHED_DEADLINE;
198 }
199 static inline bool valid_policy(int policy)
200 {
201         return idle_policy(policy) || fair_policy(policy) ||
202                 rt_policy(policy) || dl_policy(policy);
203 }
204
205 static inline int task_has_idle_policy(struct task_struct *p)
206 {
207         return idle_policy(p->policy);
208 }
209
210 static inline int task_has_rt_policy(struct task_struct *p)
211 {
212         return rt_policy(p->policy);
213 }
214
215 static inline int task_has_dl_policy(struct task_struct *p)
216 {
217         return dl_policy(p->policy);
218 }
219
220 #define cap_scale(v, s) ((v)*(s) >> SCHED_CAPACITY_SHIFT)
221
222 static inline void update_avg(u64 *avg, u64 sample)
223 {
224         s64 diff = sample - *avg;
225         *avg += diff / 8;
226 }
227
228 /*
229  * Shifting a value by an exponent greater *or equal* to the size of said value
230  * is UB; cap at size-1.
231  */
232 #define shr_bound(val, shift)                                                   \
233         (val >> min_t(typeof(shift), shift, BITS_PER_TYPE(typeof(val)) - 1))
234
235 /*
236  * !! For sched_setattr_nocheck() (kernel) only !!
237  *
238  * This is actually gross. :(
239  *
240  * It is used to make schedutil kworker(s) higher priority than SCHED_DEADLINE
241  * tasks, but still be able to sleep. We need this on platforms that cannot
242  * atomically change clock frequency. Remove once fast switching will be
243  * available on such platforms.
244  *
245  * SUGOV stands for SchedUtil GOVernor.
246  */
247 #define SCHED_FLAG_SUGOV        0x10000000
248
249 #define SCHED_DL_FLAGS (SCHED_FLAG_RECLAIM | SCHED_FLAG_DL_OVERRUN | SCHED_FLAG_SUGOV)
250
251 static inline bool dl_entity_is_special(const struct sched_dl_entity *dl_se)
252 {
253 #ifdef CONFIG_CPU_FREQ_GOV_SCHEDUTIL
254         return unlikely(dl_se->flags & SCHED_FLAG_SUGOV);
255 #else
256         return false;
257 #endif
258 }
259
260 /*
261  * Tells if entity @a should preempt entity @b.
262  */
263 static inline bool dl_entity_preempt(const struct sched_dl_entity *a,
264                                      const struct sched_dl_entity *b)
265 {
266         return dl_entity_is_special(a) ||
267                dl_time_before(a->deadline, b->deadline);
268 }
269
270 /*
271  * This is the priority-queue data structure of the RT scheduling class:
272  */
273 struct rt_prio_array {
274         DECLARE_BITMAP(bitmap, MAX_RT_PRIO+1); /* include 1 bit for delimiter */
275         struct list_head queue[MAX_RT_PRIO];
276 };
277
278 struct rt_bandwidth {
279         /* nests inside the rq lock: */
280         raw_spinlock_t          rt_runtime_lock;
281         ktime_t                 rt_period;
282         u64                     rt_runtime;
283         struct hrtimer          rt_period_timer;
284         unsigned int            rt_period_active;
285 };
286
287 void __dl_clear_params(struct task_struct *p);
288
289 static inline int dl_bandwidth_enabled(void)
290 {
291         return sysctl_sched_rt_runtime >= 0;
292 }
293
294 /*
295  * To keep the bandwidth of -deadline tasks under control
296  * we need some place where:
297  *  - store the maximum -deadline bandwidth of each cpu;
298  *  - cache the fraction of bandwidth that is currently allocated in
299  *    each root domain;
300  *
301  * This is all done in the data structure below. It is similar to the
302  * one used for RT-throttling (rt_bandwidth), with the main difference
303  * that, since here we are only interested in admission control, we
304  * do not decrease any runtime while the group "executes", neither we
305  * need a timer to replenish it.
306  *
307  * With respect to SMP, bandwidth is given on a per root domain basis,
308  * meaning that:
309  *  - bw (< 100%) is the deadline bandwidth of each CPU;
310  *  - total_bw is the currently allocated bandwidth in each root domain;
311  */
312 struct dl_bw {
313         raw_spinlock_t          lock;
314         u64                     bw;
315         u64                     total_bw;
316 };
317
318 extern void init_dl_bw(struct dl_bw *dl_b);
319 extern int  sched_dl_global_validate(void);
320 extern void sched_dl_do_global(void);
321 extern int  sched_dl_overflow(struct task_struct *p, int policy, const struct sched_attr *attr);
322 extern void __setparam_dl(struct task_struct *p, const struct sched_attr *attr);
323 extern void __getparam_dl(struct task_struct *p, struct sched_attr *attr);
324 extern bool __checkparam_dl(const struct sched_attr *attr);
325 extern bool dl_param_changed(struct task_struct *p, const struct sched_attr *attr);
326 extern int  dl_cpuset_cpumask_can_shrink(const struct cpumask *cur, const struct cpumask *trial);
327 extern int  dl_bw_check_overflow(int cpu);
328
329 #ifdef CONFIG_CGROUP_SCHED
330
331 struct cfs_rq;
332 struct rt_rq;
333
334 extern struct list_head task_groups;
335
336 struct cfs_bandwidth {
337 #ifdef CONFIG_CFS_BANDWIDTH
338         raw_spinlock_t          lock;
339         ktime_t                 period;
340         u64                     quota;
341         u64                     runtime;
342         u64                     burst;
343         u64                     runtime_snap;
344         s64                     hierarchical_quota;
345
346         u8                      idle;
347         u8                      period_active;
348         u8                      slack_started;
349         struct hrtimer          period_timer;
350         struct hrtimer          slack_timer;
351         struct list_head        throttled_cfs_rq;
352
353         /* Statistics: */
354         int                     nr_periods;
355         int                     nr_throttled;
356         int                     nr_burst;
357         u64                     throttled_time;
358         u64                     burst_time;
359 #endif
360 };
361
362 /* Task group related information */
363 struct task_group {
364         struct cgroup_subsys_state css;
365
366 #ifdef CONFIG_FAIR_GROUP_SCHED
367         /* schedulable entities of this group on each CPU */
368         struct sched_entity     **se;
369         /* runqueue "owned" by this group on each CPU */
370         struct cfs_rq           **cfs_rq;
371         unsigned long           shares;
372
373         /* A positive value indicates that this is a SCHED_IDLE group. */
374         int                     idle;
375
376 #ifdef  CONFIG_SMP
377         /*
378          * load_avg can be heavily contended at clock tick time, so put
379          * it in its own cacheline separated from the fields above which
380          * will also be accessed at each tick.
381          */
382         atomic_long_t           load_avg ____cacheline_aligned;
383 #endif
384 #endif
385
386 #ifdef CONFIG_RT_GROUP_SCHED
387         struct sched_rt_entity  **rt_se;
388         struct rt_rq            **rt_rq;
389
390         struct rt_bandwidth     rt_bandwidth;
391 #endif
392
393         struct rcu_head         rcu;
394         struct list_head        list;
395
396         struct task_group       *parent;
397         struct list_head        siblings;
398         struct list_head        children;
399
400 #ifdef CONFIG_SCHED_AUTOGROUP
401         struct autogroup        *autogroup;
402 #endif
403
404         struct cfs_bandwidth    cfs_bandwidth;
405
406 #ifdef CONFIG_UCLAMP_TASK_GROUP
407         /* The two decimal precision [%] value requested from user-space */
408         unsigned int            uclamp_pct[UCLAMP_CNT];
409         /* Clamp values requested for a task group */
410         struct uclamp_se        uclamp_req[UCLAMP_CNT];
411         /* Effective clamp values used for a task group */
412         struct uclamp_se        uclamp[UCLAMP_CNT];
413 #endif
414
415 };
416
417 #ifdef CONFIG_FAIR_GROUP_SCHED
418 #define ROOT_TASK_GROUP_LOAD    NICE_0_LOAD
419
420 /*
421  * A weight of 0 or 1 can cause arithmetics problems.
422  * A weight of a cfs_rq is the sum of weights of which entities
423  * are queued on this cfs_rq, so a weight of a entity should not be
424  * too large, so as the shares value of a task group.
425  * (The default weight is 1024 - so there's no practical
426  *  limitation from this.)
427  */
428 #define MIN_SHARES              (1UL <<  1)
429 #define MAX_SHARES              (1UL << 18)
430 #endif
431
432 typedef int (*tg_visitor)(struct task_group *, void *);
433
434 extern int walk_tg_tree_from(struct task_group *from,
435                              tg_visitor down, tg_visitor up, void *data);
436
437 /*
438  * Iterate the full tree, calling @down when first entering a node and @up when
439  * leaving it for the final time.
440  *
441  * Caller must hold rcu_lock or sufficient equivalent.
442  */
443 static inline int walk_tg_tree(tg_visitor down, tg_visitor up, void *data)
444 {
445         return walk_tg_tree_from(&root_task_group, down, up, data);
446 }
447
448 extern int tg_nop(struct task_group *tg, void *data);
449
450 extern void free_fair_sched_group(struct task_group *tg);
451 extern int alloc_fair_sched_group(struct task_group *tg, struct task_group *parent);
452 extern void online_fair_sched_group(struct task_group *tg);
453 extern void unregister_fair_sched_group(struct task_group *tg);
454 extern void init_tg_cfs_entry(struct task_group *tg, struct cfs_rq *cfs_rq,
455                         struct sched_entity *se, int cpu,
456                         struct sched_entity *parent);
457 extern void init_cfs_bandwidth(struct cfs_bandwidth *cfs_b);
458
459 extern void __refill_cfs_bandwidth_runtime(struct cfs_bandwidth *cfs_b);
460 extern void start_cfs_bandwidth(struct cfs_bandwidth *cfs_b);
461 extern void unthrottle_cfs_rq(struct cfs_rq *cfs_rq);
462
463 extern void init_tg_rt_entry(struct task_group *tg, struct rt_rq *rt_rq,
464                 struct sched_rt_entity *rt_se, int cpu,
465                 struct sched_rt_entity *parent);
466 extern int sched_group_set_rt_runtime(struct task_group *tg, long rt_runtime_us);
467 extern int sched_group_set_rt_period(struct task_group *tg, u64 rt_period_us);
468 extern long sched_group_rt_runtime(struct task_group *tg);
469 extern long sched_group_rt_period(struct task_group *tg);
470 extern int sched_rt_can_attach(struct task_group *tg, struct task_struct *tsk);
471
472 extern struct task_group *sched_create_group(struct task_group *parent);
473 extern void sched_online_group(struct task_group *tg,
474                                struct task_group *parent);
475 extern void sched_destroy_group(struct task_group *tg);
476 extern void sched_release_group(struct task_group *tg);
477
478 extern void sched_move_task(struct task_struct *tsk);
479
480 #ifdef CONFIG_FAIR_GROUP_SCHED
481 extern int sched_group_set_shares(struct task_group *tg, unsigned long shares);
482
483 extern int sched_group_set_idle(struct task_group *tg, long idle);
484
485 #ifdef CONFIG_SMP
486 extern void set_task_rq_fair(struct sched_entity *se,
487                              struct cfs_rq *prev, struct cfs_rq *next);
488 #else /* !CONFIG_SMP */
489 static inline void set_task_rq_fair(struct sched_entity *se,
490                              struct cfs_rq *prev, struct cfs_rq *next) { }
491 #endif /* CONFIG_SMP */
492 #endif /* CONFIG_FAIR_GROUP_SCHED */
493
494 #else /* CONFIG_CGROUP_SCHED */
495
496 struct cfs_bandwidth { };
497
498 #endif  /* CONFIG_CGROUP_SCHED */
499
500 extern void unregister_rt_sched_group(struct task_group *tg);
501 extern void free_rt_sched_group(struct task_group *tg);
502 extern int alloc_rt_sched_group(struct task_group *tg, struct task_group *parent);
503
504 /*
505  * u64_u32_load/u64_u32_store
506  *
507  * Use a copy of a u64 value to protect against data race. This is only
508  * applicable for 32-bits architectures.
509  */
510 #ifdef CONFIG_64BIT
511 # define u64_u32_load_copy(var, copy)       var
512 # define u64_u32_store_copy(var, copy, val) (var = val)
513 #else
514 # define u64_u32_load_copy(var, copy)                                   \
515 ({                                                                      \
516         u64 __val, __val_copy;                                          \
517         do {                                                            \
518                 __val_copy = copy;                                      \
519                 /*                                                      \
520                  * paired with u64_u32_store_copy(), ordering access    \
521                  * to var and copy.                                     \
522                  */                                                     \
523                 smp_rmb();                                              \
524                 __val = var;                                            \
525         } while (__val != __val_copy);                                  \
526         __val;                                                          \
527 })
528 # define u64_u32_store_copy(var, copy, val)                             \
529 do {                                                                    \
530         typeof(val) __val = (val);                                      \
531         var = __val;                                                    \
532         /*                                                              \
533          * paired with u64_u32_load_copy(), ordering access to var and  \
534          * copy.                                                        \
535          */                                                             \
536         smp_wmb();                                                      \
537         copy = __val;                                                   \
538 } while (0)
539 #endif
540 # define u64_u32_load(var)      u64_u32_load_copy(var, var##_copy)
541 # define u64_u32_store(var, val) u64_u32_store_copy(var, var##_copy, val)
542
543 /* CFS-related fields in a runqueue */
544 struct cfs_rq {
545         struct load_weight      load;
546         unsigned int            nr_running;
547         unsigned int            h_nr_running;      /* SCHED_{NORMAL,BATCH,IDLE} */
548         unsigned int            idle_nr_running;   /* SCHED_IDLE */
549         unsigned int            idle_h_nr_running; /* SCHED_IDLE */
550
551         u64                     exec_clock;
552         u64                     min_vruntime;
553 #ifdef CONFIG_SCHED_CORE
554         unsigned int            forceidle_seq;
555         u64                     min_vruntime_fi;
556 #endif
557
558 #ifndef CONFIG_64BIT
559         u64                     min_vruntime_copy;
560 #endif
561
562         struct rb_root_cached   tasks_timeline;
563
564         /*
565          * 'curr' points to currently running entity on this cfs_rq.
566          * It is set to NULL otherwise (i.e when none are currently running).
567          */
568         struct sched_entity     *curr;
569         struct sched_entity     *next;
570         struct sched_entity     *last;
571         struct sched_entity     *skip;
572
573 #ifdef  CONFIG_SCHED_DEBUG
574         unsigned int            nr_spread_over;
575 #endif
576
577 #ifdef CONFIG_SMP
578         /*
579          * CFS load tracking
580          */
581         struct sched_avg        avg;
582 #ifndef CONFIG_64BIT
583         u64                     last_update_time_copy;
584 #endif
585         struct {
586                 raw_spinlock_t  lock ____cacheline_aligned;
587                 int             nr;
588                 unsigned long   load_avg;
589                 unsigned long   util_avg;
590                 unsigned long   runnable_avg;
591         } removed;
592
593 #ifdef CONFIG_FAIR_GROUP_SCHED
594         unsigned long           tg_load_avg_contrib;
595         long                    propagate;
596         long                    prop_runnable_sum;
597
598         /*
599          *   h_load = weight * f(tg)
600          *
601          * Where f(tg) is the recursive weight fraction assigned to
602          * this group.
603          */
604         unsigned long           h_load;
605         u64                     last_h_load_update;
606         struct sched_entity     *h_load_next;
607 #endif /* CONFIG_FAIR_GROUP_SCHED */
608 #endif /* CONFIG_SMP */
609
610 #ifdef CONFIG_FAIR_GROUP_SCHED
611         struct rq               *rq;    /* CPU runqueue to which this cfs_rq is attached */
612
613         /*
614          * leaf cfs_rqs are those that hold tasks (lowest schedulable entity in
615          * a hierarchy). Non-leaf lrqs hold other higher schedulable entities
616          * (like users, containers etc.)
617          *
618          * leaf_cfs_rq_list ties together list of leaf cfs_rq's in a CPU.
619          * This list is used during load balance.
620          */
621         int                     on_list;
622         struct list_head        leaf_cfs_rq_list;
623         struct task_group       *tg;    /* group that "owns" this runqueue */
624
625         /* Locally cached copy of our task_group's idle value */
626         int                     idle;
627
628 #ifdef CONFIG_CFS_BANDWIDTH
629         int                     runtime_enabled;
630         s64                     runtime_remaining;
631
632         u64                     throttled_pelt_idle;
633 #ifndef CONFIG_64BIT
634         u64                     throttled_pelt_idle_copy;
635 #endif
636         u64                     throttled_clock;
637         u64                     throttled_clock_pelt;
638         u64                     throttled_clock_pelt_time;
639         u64                     throttled_clock_self;
640         u64                     throttled_clock_self_time;
641         int                     throttled;
642         int                     throttle_count;
643         struct list_head        throttled_list;
644 #ifdef CONFIG_SMP
645         struct list_head        throttled_csd_list;
646 #endif
647 #endif /* CONFIG_CFS_BANDWIDTH */
648 #endif /* CONFIG_FAIR_GROUP_SCHED */
649 };
650
651 static inline int rt_bandwidth_enabled(void)
652 {
653         return sysctl_sched_rt_runtime >= 0;
654 }
655
656 /* RT IPI pull logic requires IRQ_WORK */
657 #if defined(CONFIG_IRQ_WORK) && defined(CONFIG_SMP)
658 # define HAVE_RT_PUSH_IPI
659 #endif
660
661 /* Real-Time classes' related field in a runqueue: */
662 struct rt_rq {
663         struct rt_prio_array    active;
664         unsigned int            rt_nr_running;
665         unsigned int            rr_nr_running;
666 #if defined CONFIG_SMP || defined CONFIG_RT_GROUP_SCHED
667         struct {
668                 int             curr; /* highest queued rt task prio */
669 #ifdef CONFIG_SMP
670                 int             next; /* next highest */
671 #endif
672         } highest_prio;
673 #endif
674 #ifdef CONFIG_SMP
675         unsigned int            rt_nr_migratory;
676         unsigned int            rt_nr_total;
677         int                     overloaded;
678         struct plist_head       pushable_tasks;
679
680 #endif /* CONFIG_SMP */
681         int                     rt_queued;
682
683         int                     rt_throttled;
684         u64                     rt_time;
685         u64                     rt_runtime;
686         /* Nests inside the rq lock: */
687         raw_spinlock_t          rt_runtime_lock;
688
689 #ifdef CONFIG_RT_GROUP_SCHED
690         unsigned int            rt_nr_boosted;
691
692         struct rq               *rq;
693         struct task_group       *tg;
694 #endif
695 };
696
697 static inline bool rt_rq_is_runnable(struct rt_rq *rt_rq)
698 {
699         return rt_rq->rt_queued && rt_rq->rt_nr_running;
700 }
701
702 /* Deadline class' related fields in a runqueue */
703 struct dl_rq {
704         /* runqueue is an rbtree, ordered by deadline */
705         struct rb_root_cached   root;
706
707         unsigned int            dl_nr_running;
708
709 #ifdef CONFIG_SMP
710         /*
711          * Deadline values of the currently executing and the
712          * earliest ready task on this rq. Caching these facilitates
713          * the decision whether or not a ready but not running task
714          * should migrate somewhere else.
715          */
716         struct {
717                 u64             curr;
718                 u64             next;
719         } earliest_dl;
720
721         unsigned int            dl_nr_migratory;
722         int                     overloaded;
723
724         /*
725          * Tasks on this rq that can be pushed away. They are kept in
726          * an rb-tree, ordered by tasks' deadlines, with caching
727          * of the leftmost (earliest deadline) element.
728          */
729         struct rb_root_cached   pushable_dl_tasks_root;
730 #else
731         struct dl_bw            dl_bw;
732 #endif
733         /*
734          * "Active utilization" for this runqueue: increased when a
735          * task wakes up (becomes TASK_RUNNING) and decreased when a
736          * task blocks
737          */
738         u64                     running_bw;
739
740         /*
741          * Utilization of the tasks "assigned" to this runqueue (including
742          * the tasks that are in runqueue and the tasks that executed on this
743          * CPU and blocked). Increased when a task moves to this runqueue, and
744          * decreased when the task moves away (migrates, changes scheduling
745          * policy, or terminates).
746          * This is needed to compute the "inactive utilization" for the
747          * runqueue (inactive utilization = this_bw - running_bw).
748          */
749         u64                     this_bw;
750         u64                     extra_bw;
751
752         /*
753          * Maximum available bandwidth for reclaiming by SCHED_FLAG_RECLAIM
754          * tasks of this rq. Used in calculation of reclaimable bandwidth(GRUB).
755          */
756         u64                     max_bw;
757
758         /*
759          * Inverse of the fraction of CPU utilization that can be reclaimed
760          * by the GRUB algorithm.
761          */
762         u64                     bw_ratio;
763 };
764
765 #ifdef CONFIG_FAIR_GROUP_SCHED
766 /* An entity is a task if it doesn't "own" a runqueue */
767 #define entity_is_task(se)      (!se->my_q)
768
769 static inline void se_update_runnable(struct sched_entity *se)
770 {
771         if (!entity_is_task(se))
772                 se->runnable_weight = se->my_q->h_nr_running;
773 }
774
775 static inline long se_runnable(struct sched_entity *se)
776 {
777         if (entity_is_task(se))
778                 return !!se->on_rq;
779         else
780                 return se->runnable_weight;
781 }
782
783 #else
784 #define entity_is_task(se)      1
785
786 static inline void se_update_runnable(struct sched_entity *se) {}
787
788 static inline long se_runnable(struct sched_entity *se)
789 {
790         return !!se->on_rq;
791 }
792 #endif
793
794 #ifdef CONFIG_SMP
795 /*
796  * XXX we want to get rid of these helpers and use the full load resolution.
797  */
798 static inline long se_weight(struct sched_entity *se)
799 {
800         return scale_load_down(se->load.weight);
801 }
802
803
804 static inline bool sched_asym_prefer(int a, int b)
805 {
806         return arch_asym_cpu_priority(a) > arch_asym_cpu_priority(b);
807 }
808
809 struct perf_domain {
810         struct em_perf_domain *em_pd;
811         struct perf_domain *next;
812         struct rcu_head rcu;
813 };
814
815 /* Scheduling group status flags */
816 #define SG_OVERLOAD             0x1 /* More than one runnable task on a CPU. */
817 #define SG_OVERUTILIZED         0x2 /* One or more CPUs are over-utilized. */
818
819 /*
820  * We add the notion of a root-domain which will be used to define per-domain
821  * variables. Each exclusive cpuset essentially defines an island domain by
822  * fully partitioning the member CPUs from any other cpuset. Whenever a new
823  * exclusive cpuset is created, we also create and attach a new root-domain
824  * object.
825  *
826  */
827 struct root_domain {
828         atomic_t                refcount;
829         atomic_t                rto_count;
830         struct rcu_head         rcu;
831         cpumask_var_t           span;
832         cpumask_var_t           online;
833
834         /*
835          * Indicate pullable load on at least one CPU, e.g:
836          * - More than one runnable task
837          * - Running task is misfit
838          */
839         int                     overload;
840
841         /* Indicate one or more cpus over-utilized (tipping point) */
842         int                     overutilized;
843
844         /*
845          * The bit corresponding to a CPU gets set here if such CPU has more
846          * than one runnable -deadline task (as it is below for RT tasks).
847          */
848         cpumask_var_t           dlo_mask;
849         atomic_t                dlo_count;
850         struct dl_bw            dl_bw;
851         struct cpudl            cpudl;
852
853         /*
854          * Indicate whether a root_domain's dl_bw has been checked or
855          * updated. It's monotonously increasing value.
856          *
857          * Also, some corner cases, like 'wrap around' is dangerous, but given
858          * that u64 is 'big enough'. So that shouldn't be a concern.
859          */
860         u64 visit_gen;
861
862 #ifdef HAVE_RT_PUSH_IPI
863         /*
864          * For IPI pull requests, loop across the rto_mask.
865          */
866         struct irq_work         rto_push_work;
867         raw_spinlock_t          rto_lock;
868         /* These are only updated and read within rto_lock */
869         int                     rto_loop;
870         int                     rto_cpu;
871         /* These atomics are updated outside of a lock */
872         atomic_t                rto_loop_next;
873         atomic_t                rto_loop_start;
874 #endif
875         /*
876          * The "RT overload" flag: it gets set if a CPU has more than
877          * one runnable RT task.
878          */
879         cpumask_var_t           rto_mask;
880         struct cpupri           cpupri;
881
882         unsigned long           max_cpu_capacity;
883
884         /*
885          * NULL-terminated list of performance domains intersecting with the
886          * CPUs of the rd. Protected by RCU.
887          */
888         struct perf_domain __rcu *pd;
889 };
890
891 extern void init_defrootdomain(void);
892 extern int sched_init_domains(const struct cpumask *cpu_map);
893 extern void rq_attach_root(struct rq *rq, struct root_domain *rd);
894 extern void sched_get_rd(struct root_domain *rd);
895 extern void sched_put_rd(struct root_domain *rd);
896
897 #ifdef HAVE_RT_PUSH_IPI
898 extern void rto_push_irq_work_func(struct irq_work *work);
899 #endif
900 #endif /* CONFIG_SMP */
901
902 #ifdef CONFIG_UCLAMP_TASK
903 /*
904  * struct uclamp_bucket - Utilization clamp bucket
905  * @value: utilization clamp value for tasks on this clamp bucket
906  * @tasks: number of RUNNABLE tasks on this clamp bucket
907  *
908  * Keep track of how many tasks are RUNNABLE for a given utilization
909  * clamp value.
910  */
911 struct uclamp_bucket {
912         unsigned long value : bits_per(SCHED_CAPACITY_SCALE);
913         unsigned long tasks : BITS_PER_LONG - bits_per(SCHED_CAPACITY_SCALE);
914 };
915
916 /*
917  * struct uclamp_rq - rq's utilization clamp
918  * @value: currently active clamp values for a rq
919  * @bucket: utilization clamp buckets affecting a rq
920  *
921  * Keep track of RUNNABLE tasks on a rq to aggregate their clamp values.
922  * A clamp value is affecting a rq when there is at least one task RUNNABLE
923  * (or actually running) with that value.
924  *
925  * There are up to UCLAMP_CNT possible different clamp values, currently there
926  * are only two: minimum utilization and maximum utilization.
927  *
928  * All utilization clamping values are MAX aggregated, since:
929  * - for util_min: we want to run the CPU at least at the max of the minimum
930  *   utilization required by its currently RUNNABLE tasks.
931  * - for util_max: we want to allow the CPU to run up to the max of the
932  *   maximum utilization allowed by its currently RUNNABLE tasks.
933  *
934  * Since on each system we expect only a limited number of different
935  * utilization clamp values (UCLAMP_BUCKETS), use a simple array to track
936  * the metrics required to compute all the per-rq utilization clamp values.
937  */
938 struct uclamp_rq {
939         unsigned int value;
940         struct uclamp_bucket bucket[UCLAMP_BUCKETS];
941 };
942
943 DECLARE_STATIC_KEY_FALSE(sched_uclamp_used);
944 #endif /* CONFIG_UCLAMP_TASK */
945
946 struct rq;
947 struct balance_callback {
948         struct balance_callback *next;
949         void (*func)(struct rq *rq);
950 };
951
952 /*
953  * This is the main, per-CPU runqueue data structure.
954  *
955  * Locking rule: those places that want to lock multiple runqueues
956  * (such as the load balancing or the thread migration code), lock
957  * acquire operations must be ordered by ascending &runqueue.
958  */
959 struct rq {
960         /* runqueue lock: */
961         raw_spinlock_t          __lock;
962
963         /*
964          * nr_running and cpu_load should be in the same cacheline because
965          * remote CPUs use both these fields when doing load calculation.
966          */
967         unsigned int            nr_running;
968 #ifdef CONFIG_NUMA_BALANCING
969         unsigned int            nr_numa_running;
970         unsigned int            nr_preferred_running;
971         unsigned int            numa_migrate_on;
972 #endif
973 #ifdef CONFIG_NO_HZ_COMMON
974 #ifdef CONFIG_SMP
975         unsigned long           last_blocked_load_update_tick;
976         unsigned int            has_blocked_load;
977         call_single_data_t      nohz_csd;
978 #endif /* CONFIG_SMP */
979         unsigned int            nohz_tick_stopped;
980         atomic_t                nohz_flags;
981 #endif /* CONFIG_NO_HZ_COMMON */
982
983 #ifdef CONFIG_SMP
984         unsigned int            ttwu_pending;
985 #endif
986         u64                     nr_switches;
987
988 #ifdef CONFIG_UCLAMP_TASK
989         /* Utilization clamp values based on CPU's RUNNABLE tasks */
990         struct uclamp_rq        uclamp[UCLAMP_CNT] ____cacheline_aligned;
991         unsigned int            uclamp_flags;
992 #define UCLAMP_FLAG_IDLE 0x01
993 #endif
994
995         struct cfs_rq           cfs;
996         struct rt_rq            rt;
997         struct dl_rq            dl;
998
999 #ifdef CONFIG_FAIR_GROUP_SCHED
1000         /* list of leaf cfs_rq on this CPU: */
1001         struct list_head        leaf_cfs_rq_list;
1002         struct list_head        *tmp_alone_branch;
1003 #endif /* CONFIG_FAIR_GROUP_SCHED */
1004
1005         /*
1006          * This is part of a global counter where only the total sum
1007          * over all CPUs matters. A task can increase this counter on
1008          * one CPU and if it got migrated afterwards it may decrease
1009          * it on another CPU. Always updated under the runqueue lock:
1010          */
1011         unsigned int            nr_uninterruptible;
1012
1013         struct task_struct __rcu        *curr;
1014         struct task_struct      *idle;
1015         struct task_struct      *stop;
1016         unsigned long           next_balance;
1017         struct mm_struct        *prev_mm;
1018
1019         unsigned int            clock_update_flags;
1020         u64                     clock;
1021         /* Ensure that all clocks are in the same cache line */
1022         u64                     clock_task ____cacheline_aligned;
1023         u64                     clock_pelt;
1024         unsigned long           lost_idle_time;
1025         u64                     clock_pelt_idle;
1026         u64                     clock_idle;
1027 #ifndef CONFIG_64BIT
1028         u64                     clock_pelt_idle_copy;
1029         u64                     clock_idle_copy;
1030 #endif
1031
1032         atomic_t                nr_iowait;
1033
1034 #ifdef CONFIG_SCHED_DEBUG
1035         u64 last_seen_need_resched_ns;
1036         int ticks_without_resched;
1037 #endif
1038
1039 #ifdef CONFIG_MEMBARRIER
1040         int membarrier_state;
1041 #endif
1042
1043 #ifdef CONFIG_SMP
1044         struct root_domain              *rd;
1045         struct sched_domain __rcu       *sd;
1046
1047         unsigned long           cpu_capacity;
1048         unsigned long           cpu_capacity_orig;
1049
1050         struct balance_callback *balance_callback;
1051
1052         unsigned char           nohz_idle_balance;
1053         unsigned char           idle_balance;
1054
1055         unsigned long           misfit_task_load;
1056
1057         /* For active balancing */
1058         int                     active_balance;
1059         int                     push_cpu;
1060         struct cpu_stop_work    active_balance_work;
1061
1062         /* CPU of this runqueue: */
1063         int                     cpu;
1064         int                     online;
1065
1066         struct list_head cfs_tasks;
1067
1068         struct sched_avg        avg_rt;
1069         struct sched_avg        avg_dl;
1070 #ifdef CONFIG_HAVE_SCHED_AVG_IRQ
1071         struct sched_avg        avg_irq;
1072 #endif
1073 #ifdef CONFIG_SCHED_THERMAL_PRESSURE
1074         struct sched_avg        avg_thermal;
1075 #endif
1076         u64                     idle_stamp;
1077         u64                     avg_idle;
1078
1079         unsigned long           wake_stamp;
1080         u64                     wake_avg_idle;
1081
1082         /* This is used to determine avg_idle's max value */
1083         u64                     max_idle_balance_cost;
1084
1085 #ifdef CONFIG_HOTPLUG_CPU
1086         struct rcuwait          hotplug_wait;
1087 #endif
1088 #endif /* CONFIG_SMP */
1089
1090 #ifdef CONFIG_IRQ_TIME_ACCOUNTING
1091         u64                     prev_irq_time;
1092 #endif
1093 #ifdef CONFIG_PARAVIRT
1094         u64                     prev_steal_time;
1095 #endif
1096 #ifdef CONFIG_PARAVIRT_TIME_ACCOUNTING
1097         u64                     prev_steal_time_rq;
1098 #endif
1099
1100         /* calc_load related fields */
1101         unsigned long           calc_load_update;
1102         long                    calc_load_active;
1103
1104 #ifdef CONFIG_SCHED_HRTICK
1105 #ifdef CONFIG_SMP
1106         call_single_data_t      hrtick_csd;
1107 #endif
1108         struct hrtimer          hrtick_timer;
1109         ktime_t                 hrtick_time;
1110 #endif
1111
1112 #ifdef CONFIG_SCHEDSTATS
1113         /* latency stats */
1114         struct sched_info       rq_sched_info;
1115         unsigned long long      rq_cpu_time;
1116         /* could above be rq->cfs_rq.exec_clock + rq->rt_rq.rt_runtime ? */
1117
1118         /* sys_sched_yield() stats */
1119         unsigned int            yld_count;
1120
1121         /* schedule() stats */
1122         unsigned int            sched_count;
1123         unsigned int            sched_goidle;
1124
1125         /* try_to_wake_up() stats */
1126         unsigned int            ttwu_count;
1127         unsigned int            ttwu_local;
1128 #endif
1129
1130 #ifdef CONFIG_CPU_IDLE
1131         /* Must be inspected within a rcu lock section */
1132         struct cpuidle_state    *idle_state;
1133 #endif
1134
1135 #ifdef CONFIG_SMP
1136         unsigned int            nr_pinned;
1137 #endif
1138         unsigned int            push_busy;
1139         struct cpu_stop_work    push_work;
1140
1141 #ifdef CONFIG_SCHED_CORE
1142         /* per rq */
1143         struct rq               *core;
1144         struct task_struct      *core_pick;
1145         unsigned int            core_enabled;
1146         unsigned int            core_sched_seq;
1147         struct rb_root          core_tree;
1148
1149         /* shared state -- careful with sched_core_cpu_deactivate() */
1150         unsigned int            core_task_seq;
1151         unsigned int            core_pick_seq;
1152         unsigned long           core_cookie;
1153         unsigned int            core_forceidle_count;
1154         unsigned int            core_forceidle_seq;
1155         unsigned int            core_forceidle_occupation;
1156         u64                     core_forceidle_start;
1157 #endif
1158
1159         /* Scratch cpumask to be temporarily used under rq_lock */
1160         cpumask_var_t           scratch_mask;
1161
1162 #if defined(CONFIG_CFS_BANDWIDTH) && defined(CONFIG_SMP)
1163         call_single_data_t      cfsb_csd;
1164         struct list_head        cfsb_csd_list;
1165 #endif
1166 };
1167
1168 #ifdef CONFIG_FAIR_GROUP_SCHED
1169
1170 /* CPU runqueue to which this cfs_rq is attached */
1171 static inline struct rq *rq_of(struct cfs_rq *cfs_rq)
1172 {
1173         return cfs_rq->rq;
1174 }
1175
1176 #else
1177
1178 static inline struct rq *rq_of(struct cfs_rq *cfs_rq)
1179 {
1180         return container_of(cfs_rq, struct rq, cfs);
1181 }
1182 #endif
1183
1184 static inline int cpu_of(struct rq *rq)
1185 {
1186 #ifdef CONFIG_SMP
1187         return rq->cpu;
1188 #else
1189         return 0;
1190 #endif
1191 }
1192
1193 #define MDF_PUSH        0x01
1194
1195 static inline bool is_migration_disabled(struct task_struct *p)
1196 {
1197 #ifdef CONFIG_SMP
1198         return p->migration_disabled;
1199 #else
1200         return false;
1201 #endif
1202 }
1203
1204 DECLARE_PER_CPU_SHARED_ALIGNED(struct rq, runqueues);
1205
1206 #define cpu_rq(cpu)             (&per_cpu(runqueues, (cpu)))
1207 #define this_rq()               this_cpu_ptr(&runqueues)
1208 #define task_rq(p)              cpu_rq(task_cpu(p))
1209 #define cpu_curr(cpu)           (cpu_rq(cpu)->curr)
1210 #define raw_rq()                raw_cpu_ptr(&runqueues)
1211
1212 struct sched_group;
1213 #ifdef CONFIG_SCHED_CORE
1214 static inline struct cpumask *sched_group_span(struct sched_group *sg);
1215
1216 DECLARE_STATIC_KEY_FALSE(__sched_core_enabled);
1217
1218 static inline bool sched_core_enabled(struct rq *rq)
1219 {
1220         return static_branch_unlikely(&__sched_core_enabled) && rq->core_enabled;
1221 }
1222
1223 static inline bool sched_core_disabled(void)
1224 {
1225         return !static_branch_unlikely(&__sched_core_enabled);
1226 }
1227
1228 /*
1229  * Be careful with this function; not for general use. The return value isn't
1230  * stable unless you actually hold a relevant rq->__lock.
1231  */
1232 static inline raw_spinlock_t *rq_lockp(struct rq *rq)
1233 {
1234         if (sched_core_enabled(rq))
1235                 return &rq->core->__lock;
1236
1237         return &rq->__lock;
1238 }
1239
1240 static inline raw_spinlock_t *__rq_lockp(struct rq *rq)
1241 {
1242         if (rq->core_enabled)
1243                 return &rq->core->__lock;
1244
1245         return &rq->__lock;
1246 }
1247
1248 bool cfs_prio_less(const struct task_struct *a, const struct task_struct *b,
1249                         bool fi);
1250
1251 /*
1252  * Helpers to check if the CPU's core cookie matches with the task's cookie
1253  * when core scheduling is enabled.
1254  * A special case is that the task's cookie always matches with CPU's core
1255  * cookie if the CPU is in an idle core.
1256  */
1257 static inline bool sched_cpu_cookie_match(struct rq *rq, struct task_struct *p)
1258 {
1259         /* Ignore cookie match if core scheduler is not enabled on the CPU. */
1260         if (!sched_core_enabled(rq))
1261                 return true;
1262
1263         return rq->core->core_cookie == p->core_cookie;
1264 }
1265
1266 static inline bool sched_core_cookie_match(struct rq *rq, struct task_struct *p)
1267 {
1268         bool idle_core = true;
1269         int cpu;
1270
1271         /* Ignore cookie match if core scheduler is not enabled on the CPU. */
1272         if (!sched_core_enabled(rq))
1273                 return true;
1274
1275         for_each_cpu(cpu, cpu_smt_mask(cpu_of(rq))) {
1276                 if (!available_idle_cpu(cpu)) {
1277                         idle_core = false;
1278                         break;
1279                 }
1280         }
1281
1282         /*
1283          * A CPU in an idle core is always the best choice for tasks with
1284          * cookies.
1285          */
1286         return idle_core || rq->core->core_cookie == p->core_cookie;
1287 }
1288
1289 static inline bool sched_group_cookie_match(struct rq *rq,
1290                                             struct task_struct *p,
1291                                             struct sched_group *group)
1292 {
1293         int cpu;
1294
1295         /* Ignore cookie match if core scheduler is not enabled on the CPU. */
1296         if (!sched_core_enabled(rq))
1297                 return true;
1298
1299         for_each_cpu_and(cpu, sched_group_span(group), p->cpus_ptr) {
1300                 if (sched_core_cookie_match(cpu_rq(cpu), p))
1301                         return true;
1302         }
1303         return false;
1304 }
1305
1306 static inline bool sched_core_enqueued(struct task_struct *p)
1307 {
1308         return !RB_EMPTY_NODE(&p->core_node);
1309 }
1310
1311 extern void sched_core_enqueue(struct rq *rq, struct task_struct *p);
1312 extern void sched_core_dequeue(struct rq *rq, struct task_struct *p, int flags);
1313
1314 extern void sched_core_get(void);
1315 extern void sched_core_put(void);
1316
1317 #else /* !CONFIG_SCHED_CORE */
1318
1319 static inline bool sched_core_enabled(struct rq *rq)
1320 {
1321         return false;
1322 }
1323
1324 static inline bool sched_core_disabled(void)
1325 {
1326         return true;
1327 }
1328
1329 static inline raw_spinlock_t *rq_lockp(struct rq *rq)
1330 {
1331         return &rq->__lock;
1332 }
1333
1334 static inline raw_spinlock_t *__rq_lockp(struct rq *rq)
1335 {
1336         return &rq->__lock;
1337 }
1338
1339 static inline bool sched_cpu_cookie_match(struct rq *rq, struct task_struct *p)
1340 {
1341         return true;
1342 }
1343
1344 static inline bool sched_core_cookie_match(struct rq *rq, struct task_struct *p)
1345 {
1346         return true;
1347 }
1348
1349 static inline bool sched_group_cookie_match(struct rq *rq,
1350                                             struct task_struct *p,
1351                                             struct sched_group *group)
1352 {
1353         return true;
1354 }
1355 #endif /* CONFIG_SCHED_CORE */
1356
1357 static inline void lockdep_assert_rq_held(struct rq *rq)
1358 {
1359         lockdep_assert_held(__rq_lockp(rq));
1360 }
1361
1362 extern void raw_spin_rq_lock_nested(struct rq *rq, int subclass);
1363 extern bool raw_spin_rq_trylock(struct rq *rq);
1364 extern void raw_spin_rq_unlock(struct rq *rq);
1365
1366 static inline void raw_spin_rq_lock(struct rq *rq)
1367 {
1368         raw_spin_rq_lock_nested(rq, 0);
1369 }
1370
1371 static inline void raw_spin_rq_lock_irq(struct rq *rq)
1372 {
1373         local_irq_disable();
1374         raw_spin_rq_lock(rq);
1375 }
1376
1377 static inline void raw_spin_rq_unlock_irq(struct rq *rq)
1378 {
1379         raw_spin_rq_unlock(rq);
1380         local_irq_enable();
1381 }
1382
1383 static inline unsigned long _raw_spin_rq_lock_irqsave(struct rq *rq)
1384 {
1385         unsigned long flags;
1386         local_irq_save(flags);
1387         raw_spin_rq_lock(rq);
1388         return flags;
1389 }
1390
1391 static inline void raw_spin_rq_unlock_irqrestore(struct rq *rq, unsigned long flags)
1392 {
1393         raw_spin_rq_unlock(rq);
1394         local_irq_restore(flags);
1395 }
1396
1397 #define raw_spin_rq_lock_irqsave(rq, flags)     \
1398 do {                                            \
1399         flags = _raw_spin_rq_lock_irqsave(rq);  \
1400 } while (0)
1401
1402 #ifdef CONFIG_SCHED_SMT
1403 extern void __update_idle_core(struct rq *rq);
1404
1405 static inline void update_idle_core(struct rq *rq)
1406 {
1407         if (static_branch_unlikely(&sched_smt_present))
1408                 __update_idle_core(rq);
1409 }
1410
1411 #else
1412 static inline void update_idle_core(struct rq *rq) { }
1413 #endif
1414
1415 #ifdef CONFIG_FAIR_GROUP_SCHED
1416 static inline struct task_struct *task_of(struct sched_entity *se)
1417 {
1418         SCHED_WARN_ON(!entity_is_task(se));
1419         return container_of(se, struct task_struct, se);
1420 }
1421
1422 static inline struct cfs_rq *task_cfs_rq(struct task_struct *p)
1423 {
1424         return p->se.cfs_rq;
1425 }
1426
1427 /* runqueue on which this entity is (to be) queued */
1428 static inline struct cfs_rq *cfs_rq_of(const struct sched_entity *se)
1429 {
1430         return se->cfs_rq;
1431 }
1432
1433 /* runqueue "owned" by this group */
1434 static inline struct cfs_rq *group_cfs_rq(struct sched_entity *grp)
1435 {
1436         return grp->my_q;
1437 }
1438
1439 #else
1440
1441 #define task_of(_se)    container_of(_se, struct task_struct, se)
1442
1443 static inline struct cfs_rq *task_cfs_rq(const struct task_struct *p)
1444 {
1445         return &task_rq(p)->cfs;
1446 }
1447
1448 static inline struct cfs_rq *cfs_rq_of(const struct sched_entity *se)
1449 {
1450         const struct task_struct *p = task_of(se);
1451         struct rq *rq = task_rq(p);
1452
1453         return &rq->cfs;
1454 }
1455
1456 /* runqueue "owned" by this group */
1457 static inline struct cfs_rq *group_cfs_rq(struct sched_entity *grp)
1458 {
1459         return NULL;
1460 }
1461 #endif
1462
1463 extern void update_rq_clock(struct rq *rq);
1464
1465 /*
1466  * rq::clock_update_flags bits
1467  *
1468  * %RQCF_REQ_SKIP - will request skipping of clock update on the next
1469  *  call to __schedule(). This is an optimisation to avoid
1470  *  neighbouring rq clock updates.
1471  *
1472  * %RQCF_ACT_SKIP - is set from inside of __schedule() when skipping is
1473  *  in effect and calls to update_rq_clock() are being ignored.
1474  *
1475  * %RQCF_UPDATED - is a debug flag that indicates whether a call has been
1476  *  made to update_rq_clock() since the last time rq::lock was pinned.
1477  *
1478  * If inside of __schedule(), clock_update_flags will have been
1479  * shifted left (a left shift is a cheap operation for the fast path
1480  * to promote %RQCF_REQ_SKIP to %RQCF_ACT_SKIP), so you must use,
1481  *
1482  *      if (rq-clock_update_flags >= RQCF_UPDATED)
1483  *
1484  * to check if %RQCF_UPDATED is set. It'll never be shifted more than
1485  * one position though, because the next rq_unpin_lock() will shift it
1486  * back.
1487  */
1488 #define RQCF_REQ_SKIP           0x01
1489 #define RQCF_ACT_SKIP           0x02
1490 #define RQCF_UPDATED            0x04
1491
1492 static inline void assert_clock_updated(struct rq *rq)
1493 {
1494         /*
1495          * The only reason for not seeing a clock update since the
1496          * last rq_pin_lock() is if we're currently skipping updates.
1497          */
1498         SCHED_WARN_ON(rq->clock_update_flags < RQCF_ACT_SKIP);
1499 }
1500
1501 static inline u64 rq_clock(struct rq *rq)
1502 {
1503         lockdep_assert_rq_held(rq);
1504         assert_clock_updated(rq);
1505
1506         return rq->clock;
1507 }
1508
1509 static inline u64 rq_clock_task(struct rq *rq)
1510 {
1511         lockdep_assert_rq_held(rq);
1512         assert_clock_updated(rq);
1513
1514         return rq->clock_task;
1515 }
1516
1517 /**
1518  * By default the decay is the default pelt decay period.
1519  * The decay shift can change the decay period in
1520  * multiples of 32.
1521  *  Decay shift         Decay period(ms)
1522  *      0                       32
1523  *      1                       64
1524  *      2                       128
1525  *      3                       256
1526  *      4                       512
1527  */
1528 extern int sched_thermal_decay_shift;
1529
1530 static inline u64 rq_clock_thermal(struct rq *rq)
1531 {
1532         return rq_clock_task(rq) >> sched_thermal_decay_shift;
1533 }
1534
1535 static inline void rq_clock_skip_update(struct rq *rq)
1536 {
1537         lockdep_assert_rq_held(rq);
1538         rq->clock_update_flags |= RQCF_REQ_SKIP;
1539 }
1540
1541 /*
1542  * See rt task throttling, which is the only time a skip
1543  * request is canceled.
1544  */
1545 static inline void rq_clock_cancel_skipupdate(struct rq *rq)
1546 {
1547         lockdep_assert_rq_held(rq);
1548         rq->clock_update_flags &= ~RQCF_REQ_SKIP;
1549 }
1550
1551 /*
1552  * During cpu offlining and rq wide unthrottling, we can trigger
1553  * an update_rq_clock() for several cfs and rt runqueues (Typically
1554  * when using list_for_each_entry_*)
1555  * rq_clock_start_loop_update() can be called after updating the clock
1556  * once and before iterating over the list to prevent multiple update.
1557  * After the iterative traversal, we need to call rq_clock_stop_loop_update()
1558  * to clear RQCF_ACT_SKIP of rq->clock_update_flags.
1559  */
1560 static inline void rq_clock_start_loop_update(struct rq *rq)
1561 {
1562         lockdep_assert_rq_held(rq);
1563         SCHED_WARN_ON(rq->clock_update_flags & RQCF_ACT_SKIP);
1564         rq->clock_update_flags |= RQCF_ACT_SKIP;
1565 }
1566
1567 static inline void rq_clock_stop_loop_update(struct rq *rq)
1568 {
1569         lockdep_assert_rq_held(rq);
1570         rq->clock_update_flags &= ~RQCF_ACT_SKIP;
1571 }
1572
1573 struct rq_flags {
1574         unsigned long flags;
1575         struct pin_cookie cookie;
1576 #ifdef CONFIG_SCHED_DEBUG
1577         /*
1578          * A copy of (rq::clock_update_flags & RQCF_UPDATED) for the
1579          * current pin context is stashed here in case it needs to be
1580          * restored in rq_repin_lock().
1581          */
1582         unsigned int clock_update_flags;
1583 #endif
1584 };
1585
1586 extern struct balance_callback balance_push_callback;
1587
1588 /*
1589  * Lockdep annotation that avoids accidental unlocks; it's like a
1590  * sticky/continuous lockdep_assert_held().
1591  *
1592  * This avoids code that has access to 'struct rq *rq' (basically everything in
1593  * the scheduler) from accidentally unlocking the rq if they do not also have a
1594  * copy of the (on-stack) 'struct rq_flags rf'.
1595  *
1596  * Also see Documentation/locking/lockdep-design.rst.
1597  */
1598 static inline void rq_pin_lock(struct rq *rq, struct rq_flags *rf)
1599 {
1600         rf->cookie = lockdep_pin_lock(__rq_lockp(rq));
1601
1602 #ifdef CONFIG_SCHED_DEBUG
1603         rq->clock_update_flags &= (RQCF_REQ_SKIP|RQCF_ACT_SKIP);
1604         rf->clock_update_flags = 0;
1605 #ifdef CONFIG_SMP
1606         SCHED_WARN_ON(rq->balance_callback && rq->balance_callback != &balance_push_callback);
1607 #endif
1608 #endif
1609 }
1610
1611 static inline void rq_unpin_lock(struct rq *rq, struct rq_flags *rf)
1612 {
1613 #ifdef CONFIG_SCHED_DEBUG
1614         if (rq->clock_update_flags > RQCF_ACT_SKIP)
1615                 rf->clock_update_flags = RQCF_UPDATED;
1616 #endif
1617
1618         lockdep_unpin_lock(__rq_lockp(rq), rf->cookie);
1619 }
1620
1621 static inline void rq_repin_lock(struct rq *rq, struct rq_flags *rf)
1622 {
1623         lockdep_repin_lock(__rq_lockp(rq), rf->cookie);
1624
1625 #ifdef CONFIG_SCHED_DEBUG
1626         /*
1627          * Restore the value we stashed in @rf for this pin context.
1628          */
1629         rq->clock_update_flags |= rf->clock_update_flags;
1630 #endif
1631 }
1632
1633 struct rq *__task_rq_lock(struct task_struct *p, struct rq_flags *rf)
1634         __acquires(rq->lock);
1635
1636 struct rq *task_rq_lock(struct task_struct *p, struct rq_flags *rf)
1637         __acquires(p->pi_lock)
1638         __acquires(rq->lock);
1639
1640 static inline void __task_rq_unlock(struct rq *rq, struct rq_flags *rf)
1641         __releases(rq->lock)
1642 {
1643         rq_unpin_lock(rq, rf);
1644         raw_spin_rq_unlock(rq);
1645 }
1646
1647 static inline void
1648 task_rq_unlock(struct rq *rq, struct task_struct *p, struct rq_flags *rf)
1649         __releases(rq->lock)
1650         __releases(p->pi_lock)
1651 {
1652         rq_unpin_lock(rq, rf);
1653         raw_spin_rq_unlock(rq);
1654         raw_spin_unlock_irqrestore(&p->pi_lock, rf->flags);
1655 }
1656
1657 static inline void
1658 rq_lock_irqsave(struct rq *rq, struct rq_flags *rf)
1659         __acquires(rq->lock)
1660 {
1661         raw_spin_rq_lock_irqsave(rq, rf->flags);
1662         rq_pin_lock(rq, rf);
1663 }
1664
1665 static inline void
1666 rq_lock_irq(struct rq *rq, struct rq_flags *rf)
1667         __acquires(rq->lock)
1668 {
1669         raw_spin_rq_lock_irq(rq);
1670         rq_pin_lock(rq, rf);
1671 }
1672
1673 static inline void
1674 rq_lock(struct rq *rq, struct rq_flags *rf)
1675         __acquires(rq->lock)
1676 {
1677         raw_spin_rq_lock(rq);
1678         rq_pin_lock(rq, rf);
1679 }
1680
1681 static inline void
1682 rq_unlock_irqrestore(struct rq *rq, struct rq_flags *rf)
1683         __releases(rq->lock)
1684 {
1685         rq_unpin_lock(rq, rf);
1686         raw_spin_rq_unlock_irqrestore(rq, rf->flags);
1687 }
1688
1689 static inline void
1690 rq_unlock_irq(struct rq *rq, struct rq_flags *rf)
1691         __releases(rq->lock)
1692 {
1693         rq_unpin_lock(rq, rf);
1694         raw_spin_rq_unlock_irq(rq);
1695 }
1696
1697 static inline void
1698 rq_unlock(struct rq *rq, struct rq_flags *rf)
1699         __releases(rq->lock)
1700 {
1701         rq_unpin_lock(rq, rf);
1702         raw_spin_rq_unlock(rq);
1703 }
1704
1705 static inline struct rq *
1706 this_rq_lock_irq(struct rq_flags *rf)
1707         __acquires(rq->lock)
1708 {
1709         struct rq *rq;
1710
1711         local_irq_disable();
1712         rq = this_rq();
1713         rq_lock(rq, rf);
1714         return rq;
1715 }
1716
1717 #ifdef CONFIG_NUMA
1718 enum numa_topology_type {
1719         NUMA_DIRECT,
1720         NUMA_GLUELESS_MESH,
1721         NUMA_BACKPLANE,
1722 };
1723 extern enum numa_topology_type sched_numa_topology_type;
1724 extern int sched_max_numa_distance;
1725 extern bool find_numa_distance(int distance);
1726 extern void sched_init_numa(int offline_node);
1727 extern void sched_update_numa(int cpu, bool online);
1728 extern void sched_domains_numa_masks_set(unsigned int cpu);
1729 extern void sched_domains_numa_masks_clear(unsigned int cpu);
1730 extern int sched_numa_find_closest(const struct cpumask *cpus, int cpu);
1731 #else
1732 static inline void sched_init_numa(int offline_node) { }
1733 static inline void sched_update_numa(int cpu, bool online) { }
1734 static inline void sched_domains_numa_masks_set(unsigned int cpu) { }
1735 static inline void sched_domains_numa_masks_clear(unsigned int cpu) { }
1736 static inline int sched_numa_find_closest(const struct cpumask *cpus, int cpu)
1737 {
1738         return nr_cpu_ids;
1739 }
1740 #endif
1741
1742 #ifdef CONFIG_NUMA_BALANCING
1743 /* The regions in numa_faults array from task_struct */
1744 enum numa_faults_stats {
1745         NUMA_MEM = 0,
1746         NUMA_CPU,
1747         NUMA_MEMBUF,
1748         NUMA_CPUBUF
1749 };
1750 extern void sched_setnuma(struct task_struct *p, int node);
1751 extern int migrate_task_to(struct task_struct *p, int cpu);
1752 extern int migrate_swap(struct task_struct *p, struct task_struct *t,
1753                         int cpu, int scpu);
1754 extern void init_numa_balancing(unsigned long clone_flags, struct task_struct *p);
1755 #else
1756 static inline void
1757 init_numa_balancing(unsigned long clone_flags, struct task_struct *p)
1758 {
1759 }
1760 #endif /* CONFIG_NUMA_BALANCING */
1761
1762 #ifdef CONFIG_SMP
1763
1764 static inline void
1765 queue_balance_callback(struct rq *rq,
1766                        struct balance_callback *head,
1767                        void (*func)(struct rq *rq))
1768 {
1769         lockdep_assert_rq_held(rq);
1770
1771         /*
1772          * Don't (re)queue an already queued item; nor queue anything when
1773          * balance_push() is active, see the comment with
1774          * balance_push_callback.
1775          */
1776         if (unlikely(head->next || rq->balance_callback == &balance_push_callback))
1777                 return;
1778
1779         head->func = func;
1780         head->next = rq->balance_callback;
1781         rq->balance_callback = head;
1782 }
1783
1784 #define rcu_dereference_check_sched_domain(p) \
1785         rcu_dereference_check((p), \
1786                               lockdep_is_held(&sched_domains_mutex))
1787
1788 /*
1789  * The domain tree (rq->sd) is protected by RCU's quiescent state transition.
1790  * See destroy_sched_domains: call_rcu for details.
1791  *
1792  * The domain tree of any CPU may only be accessed from within
1793  * preempt-disabled sections.
1794  */
1795 #define for_each_domain(cpu, __sd) \
1796         for (__sd = rcu_dereference_check_sched_domain(cpu_rq(cpu)->sd); \
1797                         __sd; __sd = __sd->parent)
1798
1799 /* A mask of all the SD flags that have the SDF_SHARED_CHILD metaflag */
1800 #define SD_FLAG(name, mflags) (name * !!((mflags) & SDF_SHARED_CHILD)) |
1801 static const unsigned int SD_SHARED_CHILD_MASK =
1802 #include <linux/sched/sd_flags.h>
1803 0;
1804 #undef SD_FLAG
1805
1806 /**
1807  * highest_flag_domain - Return highest sched_domain containing flag.
1808  * @cpu:        The CPU whose highest level of sched domain is to
1809  *              be returned.
1810  * @flag:       The flag to check for the highest sched_domain
1811  *              for the given CPU.
1812  *
1813  * Returns the highest sched_domain of a CPU which contains @flag. If @flag has
1814  * the SDF_SHARED_CHILD metaflag, all the children domains also have @flag.
1815  */
1816 static inline struct sched_domain *highest_flag_domain(int cpu, int flag)
1817 {
1818         struct sched_domain *sd, *hsd = NULL;
1819
1820         for_each_domain(cpu, sd) {
1821                 if (sd->flags & flag) {
1822                         hsd = sd;
1823                         continue;
1824                 }
1825
1826                 /*
1827                  * Stop the search if @flag is known to be shared at lower
1828                  * levels. It will not be found further up.
1829                  */
1830                 if (flag & SD_SHARED_CHILD_MASK)
1831                         break;
1832         }
1833
1834         return hsd;
1835 }
1836
1837 static inline struct sched_domain *lowest_flag_domain(int cpu, int flag)
1838 {
1839         struct sched_domain *sd;
1840
1841         for_each_domain(cpu, sd) {
1842                 if (sd->flags & flag)
1843                         break;
1844         }
1845
1846         return sd;
1847 }
1848
1849 DECLARE_PER_CPU(struct sched_domain __rcu *, sd_llc);
1850 DECLARE_PER_CPU(int, sd_llc_size);
1851 DECLARE_PER_CPU(int, sd_llc_id);
1852 DECLARE_PER_CPU(struct sched_domain_shared __rcu *, sd_llc_shared);
1853 DECLARE_PER_CPU(struct sched_domain __rcu *, sd_numa);
1854 DECLARE_PER_CPU(struct sched_domain __rcu *, sd_asym_packing);
1855 DECLARE_PER_CPU(struct sched_domain __rcu *, sd_asym_cpucapacity);
1856 extern struct static_key_false sched_asym_cpucapacity;
1857
1858 static __always_inline bool sched_asym_cpucap_active(void)
1859 {
1860         return static_branch_unlikely(&sched_asym_cpucapacity);
1861 }
1862
1863 struct sched_group_capacity {
1864         atomic_t                ref;
1865         /*
1866          * CPU capacity of this group, SCHED_CAPACITY_SCALE being max capacity
1867          * for a single CPU.
1868          */
1869         unsigned long           capacity;
1870         unsigned long           min_capacity;           /* Min per-CPU capacity in group */
1871         unsigned long           max_capacity;           /* Max per-CPU capacity in group */
1872         unsigned long           next_update;
1873         int                     imbalance;              /* XXX unrelated to capacity but shared group state */
1874
1875 #ifdef CONFIG_SCHED_DEBUG
1876         int                     id;
1877 #endif
1878
1879         unsigned long           cpumask[];              /* Balance mask */
1880 };
1881
1882 struct sched_group {
1883         struct sched_group      *next;                  /* Must be a circular list */
1884         atomic_t                ref;
1885
1886         unsigned int            group_weight;
1887         unsigned int            cores;
1888         struct sched_group_capacity *sgc;
1889         int                     asym_prefer_cpu;        /* CPU of highest priority in group */
1890         int                     flags;
1891
1892         /*
1893          * The CPUs this group covers.
1894          *
1895          * NOTE: this field is variable length. (Allocated dynamically
1896          * by attaching extra space to the end of the structure,
1897          * depending on how many CPUs the kernel has booted up with)
1898          */
1899         unsigned long           cpumask[];
1900 };
1901
1902 static inline struct cpumask *sched_group_span(struct sched_group *sg)
1903 {
1904         return to_cpumask(sg->cpumask);
1905 }
1906
1907 /*
1908  * See build_balance_mask().
1909  */
1910 static inline struct cpumask *group_balance_mask(struct sched_group *sg)
1911 {
1912         return to_cpumask(sg->sgc->cpumask);
1913 }
1914
1915 extern int group_balance_cpu(struct sched_group *sg);
1916
1917 #ifdef CONFIG_SCHED_DEBUG
1918 void update_sched_domain_debugfs(void);
1919 void dirty_sched_domain_sysctl(int cpu);
1920 #else
1921 static inline void update_sched_domain_debugfs(void)
1922 {
1923 }
1924 static inline void dirty_sched_domain_sysctl(int cpu)
1925 {
1926 }
1927 #endif
1928
1929 extern int sched_update_scaling(void);
1930
1931 static inline const struct cpumask *task_user_cpus(struct task_struct *p)
1932 {
1933         if (!p->user_cpus_ptr)
1934                 return cpu_possible_mask; /* &init_task.cpus_mask */
1935         return p->user_cpus_ptr;
1936 }
1937 #endif /* CONFIG_SMP */
1938
1939 #include "stats.h"
1940
1941 #if defined(CONFIG_SCHED_CORE) && defined(CONFIG_SCHEDSTATS)
1942
1943 extern void __sched_core_account_forceidle(struct rq *rq);
1944
1945 static inline void sched_core_account_forceidle(struct rq *rq)
1946 {
1947         if (schedstat_enabled())
1948                 __sched_core_account_forceidle(rq);
1949 }
1950
1951 extern void __sched_core_tick(struct rq *rq);
1952
1953 static inline void sched_core_tick(struct rq *rq)
1954 {
1955         if (sched_core_enabled(rq) && schedstat_enabled())
1956                 __sched_core_tick(rq);
1957 }
1958
1959 #else
1960
1961 static inline void sched_core_account_forceidle(struct rq *rq) {}
1962
1963 static inline void sched_core_tick(struct rq *rq) {}
1964
1965 #endif /* CONFIG_SCHED_CORE && CONFIG_SCHEDSTATS */
1966
1967 #ifdef CONFIG_CGROUP_SCHED
1968
1969 /*
1970  * Return the group to which this tasks belongs.
1971  *
1972  * We cannot use task_css() and friends because the cgroup subsystem
1973  * changes that value before the cgroup_subsys::attach() method is called,
1974  * therefore we cannot pin it and might observe the wrong value.
1975  *
1976  * The same is true for autogroup's p->signal->autogroup->tg, the autogroup
1977  * core changes this before calling sched_move_task().
1978  *
1979  * Instead we use a 'copy' which is updated from sched_move_task() while
1980  * holding both task_struct::pi_lock and rq::lock.
1981  */
1982 static inline struct task_group *task_group(struct task_struct *p)
1983 {
1984         return p->sched_task_group;
1985 }
1986
1987 /* Change a task's cfs_rq and parent entity if it moves across CPUs/groups */
1988 static inline void set_task_rq(struct task_struct *p, unsigned int cpu)
1989 {
1990 #if defined(CONFIG_FAIR_GROUP_SCHED) || defined(CONFIG_RT_GROUP_SCHED)
1991         struct task_group *tg = task_group(p);
1992 #endif
1993
1994 #ifdef CONFIG_FAIR_GROUP_SCHED
1995         set_task_rq_fair(&p->se, p->se.cfs_rq, tg->cfs_rq[cpu]);
1996         p->se.cfs_rq = tg->cfs_rq[cpu];
1997         p->se.parent = tg->se[cpu];
1998         p->se.depth = tg->se[cpu] ? tg->se[cpu]->depth + 1 : 0;
1999 #endif
2000
2001 #ifdef CONFIG_RT_GROUP_SCHED
2002         p->rt.rt_rq  = tg->rt_rq[cpu];
2003         p->rt.parent = tg->rt_se[cpu];
2004 #endif
2005 }
2006
2007 #else /* CONFIG_CGROUP_SCHED */
2008
2009 static inline void set_task_rq(struct task_struct *p, unsigned int cpu) { }
2010 static inline struct task_group *task_group(struct task_struct *p)
2011 {
2012         return NULL;
2013 }
2014
2015 #endif /* CONFIG_CGROUP_SCHED */
2016
2017 static inline void __set_task_cpu(struct task_struct *p, unsigned int cpu)
2018 {
2019         set_task_rq(p, cpu);
2020 #ifdef CONFIG_SMP
2021         /*
2022          * After ->cpu is set up to a new value, task_rq_lock(p, ...) can be
2023          * successfully executed on another CPU. We must ensure that updates of
2024          * per-task data have been completed by this moment.
2025          */
2026         smp_wmb();
2027         WRITE_ONCE(task_thread_info(p)->cpu, cpu);
2028         p->wake_cpu = cpu;
2029 #endif
2030 }
2031
2032 /*
2033  * Tunables that become constants when CONFIG_SCHED_DEBUG is off:
2034  */
2035 #ifdef CONFIG_SCHED_DEBUG
2036 # define const_debug __read_mostly
2037 #else
2038 # define const_debug const
2039 #endif
2040
2041 #define SCHED_FEAT(name, enabled)       \
2042         __SCHED_FEAT_##name ,
2043
2044 enum {
2045 #include "features.h"
2046         __SCHED_FEAT_NR,
2047 };
2048
2049 #undef SCHED_FEAT
2050
2051 #ifdef CONFIG_SCHED_DEBUG
2052
2053 /*
2054  * To support run-time toggling of sched features, all the translation units
2055  * (but core.c) reference the sysctl_sched_features defined in core.c.
2056  */
2057 extern const_debug unsigned int sysctl_sched_features;
2058
2059 #ifdef CONFIG_JUMP_LABEL
2060 #define SCHED_FEAT(name, enabled)                                       \
2061 static __always_inline bool static_branch_##name(struct static_key *key) \
2062 {                                                                       \
2063         return static_key_##enabled(key);                               \
2064 }
2065
2066 #include "features.h"
2067 #undef SCHED_FEAT
2068
2069 extern struct static_key sched_feat_keys[__SCHED_FEAT_NR];
2070 #define sched_feat(x) (static_branch_##x(&sched_feat_keys[__SCHED_FEAT_##x]))
2071
2072 #else /* !CONFIG_JUMP_LABEL */
2073
2074 #define sched_feat(x) (sysctl_sched_features & (1UL << __SCHED_FEAT_##x))
2075
2076 #endif /* CONFIG_JUMP_LABEL */
2077
2078 #else /* !SCHED_DEBUG */
2079
2080 /*
2081  * Each translation unit has its own copy of sysctl_sched_features to allow
2082  * constants propagation at compile time and compiler optimization based on
2083  * features default.
2084  */
2085 #define SCHED_FEAT(name, enabled)       \
2086         (1UL << __SCHED_FEAT_##name) * enabled |
2087 static const_debug __maybe_unused unsigned int sysctl_sched_features =
2088 #include "features.h"
2089         0;
2090 #undef SCHED_FEAT
2091
2092 #define sched_feat(x) !!(sysctl_sched_features & (1UL << __SCHED_FEAT_##x))
2093
2094 #endif /* SCHED_DEBUG */
2095
2096 extern struct static_key_false sched_numa_balancing;
2097 extern struct static_key_false sched_schedstats;
2098
2099 static inline u64 global_rt_period(void)
2100 {
2101         return (u64)sysctl_sched_rt_period * NSEC_PER_USEC;
2102 }
2103
2104 static inline u64 global_rt_runtime(void)
2105 {
2106         if (sysctl_sched_rt_runtime < 0)
2107                 return RUNTIME_INF;
2108
2109         return (u64)sysctl_sched_rt_runtime * NSEC_PER_USEC;
2110 }
2111
2112 static inline int task_current(struct rq *rq, struct task_struct *p)
2113 {
2114         return rq->curr == p;
2115 }
2116
2117 static inline int task_on_cpu(struct rq *rq, struct task_struct *p)
2118 {
2119 #ifdef CONFIG_SMP
2120         return p->on_cpu;
2121 #else
2122         return task_current(rq, p);
2123 #endif
2124 }
2125
2126 static inline int task_on_rq_queued(struct task_struct *p)
2127 {
2128         return p->on_rq == TASK_ON_RQ_QUEUED;
2129 }
2130
2131 static inline int task_on_rq_migrating(struct task_struct *p)
2132 {
2133         return READ_ONCE(p->on_rq) == TASK_ON_RQ_MIGRATING;
2134 }
2135
2136 /* Wake flags. The first three directly map to some SD flag value */
2137 #define WF_EXEC     0x02 /* Wakeup after exec; maps to SD_BALANCE_EXEC */
2138 #define WF_FORK     0x04 /* Wakeup after fork; maps to SD_BALANCE_FORK */
2139 #define WF_TTWU     0x08 /* Wakeup;            maps to SD_BALANCE_WAKE */
2140
2141 #define WF_SYNC     0x10 /* Waker goes to sleep after wakeup */
2142 #define WF_MIGRATED 0x20 /* Internal use, task got migrated */
2143
2144 #ifdef CONFIG_SMP
2145 static_assert(WF_EXEC == SD_BALANCE_EXEC);
2146 static_assert(WF_FORK == SD_BALANCE_FORK);
2147 static_assert(WF_TTWU == SD_BALANCE_WAKE);
2148 #endif
2149
2150 /*
2151  * To aid in avoiding the subversion of "niceness" due to uneven distribution
2152  * of tasks with abnormal "nice" values across CPUs the contribution that
2153  * each task makes to its run queue's load is weighted according to its
2154  * scheduling class and "nice" value. For SCHED_NORMAL tasks this is just a
2155  * scaled version of the new time slice allocation that they receive on time
2156  * slice expiry etc.
2157  */
2158
2159 #define WEIGHT_IDLEPRIO         3
2160 #define WMULT_IDLEPRIO          1431655765
2161
2162 extern const int                sched_prio_to_weight[40];
2163 extern const u32                sched_prio_to_wmult[40];
2164
2165 /*
2166  * {de,en}queue flags:
2167  *
2168  * DEQUEUE_SLEEP  - task is no longer runnable
2169  * ENQUEUE_WAKEUP - task just became runnable
2170  *
2171  * SAVE/RESTORE - an otherwise spurious dequeue/enqueue, done to ensure tasks
2172  *                are in a known state which allows modification. Such pairs
2173  *                should preserve as much state as possible.
2174  *
2175  * MOVE - paired with SAVE/RESTORE, explicitly does not preserve the location
2176  *        in the runqueue.
2177  *
2178  * ENQUEUE_HEAD      - place at front of runqueue (tail if not specified)
2179  * ENQUEUE_REPLENISH - CBS (replenish runtime and postpone deadline)
2180  * ENQUEUE_MIGRATED  - the task was migrated during wakeup
2181  *
2182  */
2183
2184 #define DEQUEUE_SLEEP           0x01
2185 #define DEQUEUE_SAVE            0x02 /* Matches ENQUEUE_RESTORE */
2186 #define DEQUEUE_MOVE            0x04 /* Matches ENQUEUE_MOVE */
2187 #define DEQUEUE_NOCLOCK         0x08 /* Matches ENQUEUE_NOCLOCK */
2188
2189 #define ENQUEUE_WAKEUP          0x01
2190 #define ENQUEUE_RESTORE         0x02
2191 #define ENQUEUE_MOVE            0x04
2192 #define ENQUEUE_NOCLOCK         0x08
2193
2194 #define ENQUEUE_HEAD            0x10
2195 #define ENQUEUE_REPLENISH       0x20
2196 #ifdef CONFIG_SMP
2197 #define ENQUEUE_MIGRATED        0x40
2198 #else
2199 #define ENQUEUE_MIGRATED        0x00
2200 #endif
2201
2202 #define RETRY_TASK              ((void *)-1UL)
2203
2204 struct affinity_context {
2205         const struct cpumask *new_mask;
2206         struct cpumask *user_mask;
2207         unsigned int flags;
2208 };
2209
2210 struct sched_class {
2211
2212 #ifdef CONFIG_UCLAMP_TASK
2213         int uclamp_enabled;
2214 #endif
2215
2216         void (*enqueue_task) (struct rq *rq, struct task_struct *p, int flags);
2217         void (*dequeue_task) (struct rq *rq, struct task_struct *p, int flags);
2218         void (*yield_task)   (struct rq *rq);
2219         bool (*yield_to_task)(struct rq *rq, struct task_struct *p);
2220
2221         void (*check_preempt_curr)(struct rq *rq, struct task_struct *p, int flags);
2222
2223         struct task_struct *(*pick_next_task)(struct rq *rq);
2224
2225         void (*put_prev_task)(struct rq *rq, struct task_struct *p);
2226         void (*set_next_task)(struct rq *rq, struct task_struct *p, bool first);
2227
2228 #ifdef CONFIG_SMP
2229         int (*balance)(struct rq *rq, struct task_struct *prev, struct rq_flags *rf);
2230         int  (*select_task_rq)(struct task_struct *p, int task_cpu, int flags);
2231
2232         struct task_struct * (*pick_task)(struct rq *rq);
2233
2234         void (*migrate_task_rq)(struct task_struct *p, int new_cpu);
2235
2236         void (*task_woken)(struct rq *this_rq, struct task_struct *task);
2237
2238         void (*set_cpus_allowed)(struct task_struct *p, struct affinity_context *ctx);
2239
2240         void (*rq_online)(struct rq *rq);
2241         void (*rq_offline)(struct rq *rq);
2242
2243         struct rq *(*find_lock_rq)(struct task_struct *p, struct rq *rq);
2244 #endif
2245
2246         void (*task_tick)(struct rq *rq, struct task_struct *p, int queued);
2247         void (*task_fork)(struct task_struct *p);
2248         void (*task_dead)(struct task_struct *p);
2249
2250         /*
2251          * The switched_from() call is allowed to drop rq->lock, therefore we
2252          * cannot assume the switched_from/switched_to pair is serialized by
2253          * rq->lock. They are however serialized by p->pi_lock.
2254          */
2255         void (*switched_from)(struct rq *this_rq, struct task_struct *task);
2256         void (*switched_to)  (struct rq *this_rq, struct task_struct *task);
2257         void (*prio_changed) (struct rq *this_rq, struct task_struct *task,
2258                               int oldprio);
2259
2260         unsigned int (*get_rr_interval)(struct rq *rq,
2261                                         struct task_struct *task);
2262
2263         void (*update_curr)(struct rq *rq);
2264
2265 #ifdef CONFIG_FAIR_GROUP_SCHED
2266         void (*task_change_group)(struct task_struct *p);
2267 #endif
2268
2269 #ifdef CONFIG_SCHED_CORE
2270         int (*task_is_throttled)(struct task_struct *p, int cpu);
2271 #endif
2272 };
2273
2274 static inline void put_prev_task(struct rq *rq, struct task_struct *prev)
2275 {
2276         WARN_ON_ONCE(rq->curr != prev);
2277         prev->sched_class->put_prev_task(rq, prev);
2278 }
2279
2280 static inline void set_next_task(struct rq *rq, struct task_struct *next)
2281 {
2282         next->sched_class->set_next_task(rq, next, false);
2283 }
2284
2285
2286 /*
2287  * Helper to define a sched_class instance; each one is placed in a separate
2288  * section which is ordered by the linker script:
2289  *
2290  *   include/asm-generic/vmlinux.lds.h
2291  *
2292  * *CAREFUL* they are laid out in *REVERSE* order!!!
2293  *
2294  * Also enforce alignment on the instance, not the type, to guarantee layout.
2295  */
2296 #define DEFINE_SCHED_CLASS(name) \
2297 const struct sched_class name##_sched_class \
2298         __aligned(__alignof__(struct sched_class)) \
2299         __section("__" #name "_sched_class")
2300
2301 /* Defined in include/asm-generic/vmlinux.lds.h */
2302 extern struct sched_class __sched_class_highest[];
2303 extern struct sched_class __sched_class_lowest[];
2304
2305 #define for_class_range(class, _from, _to) \
2306         for (class = (_from); class < (_to); class++)
2307
2308 #define for_each_class(class) \
2309         for_class_range(class, __sched_class_highest, __sched_class_lowest)
2310
2311 #define sched_class_above(_a, _b)       ((_a) < (_b))
2312
2313 extern const struct sched_class stop_sched_class;
2314 extern const struct sched_class dl_sched_class;
2315 extern const struct sched_class rt_sched_class;
2316 extern const struct sched_class fair_sched_class;
2317 extern const struct sched_class idle_sched_class;
2318
2319 static inline bool sched_stop_runnable(struct rq *rq)
2320 {
2321         return rq->stop && task_on_rq_queued(rq->stop);
2322 }
2323
2324 static inline bool sched_dl_runnable(struct rq *rq)
2325 {
2326         return rq->dl.dl_nr_running > 0;
2327 }
2328
2329 static inline bool sched_rt_runnable(struct rq *rq)
2330 {
2331         return rq->rt.rt_queued > 0;
2332 }
2333
2334 static inline bool sched_fair_runnable(struct rq *rq)
2335 {
2336         return rq->cfs.nr_running > 0;
2337 }
2338
2339 extern struct task_struct *pick_next_task_fair(struct rq *rq, struct task_struct *prev, struct rq_flags *rf);
2340 extern struct task_struct *pick_next_task_idle(struct rq *rq);
2341
2342 #define SCA_CHECK               0x01
2343 #define SCA_MIGRATE_DISABLE     0x02
2344 #define SCA_MIGRATE_ENABLE      0x04
2345 #define SCA_USER                0x08
2346
2347 #ifdef CONFIG_SMP
2348
2349 extern void update_group_capacity(struct sched_domain *sd, int cpu);
2350
2351 extern void trigger_load_balance(struct rq *rq);
2352
2353 extern void set_cpus_allowed_common(struct task_struct *p, struct affinity_context *ctx);
2354
2355 static inline struct task_struct *get_push_task(struct rq *rq)
2356 {
2357         struct task_struct *p = rq->curr;
2358
2359         lockdep_assert_rq_held(rq);
2360
2361         if (rq->push_busy)
2362                 return NULL;
2363
2364         if (p->nr_cpus_allowed == 1)
2365                 return NULL;
2366
2367         if (p->migration_disabled)
2368                 return NULL;
2369
2370         rq->push_busy = true;
2371         return get_task_struct(p);
2372 }
2373
2374 extern int push_cpu_stop(void *arg);
2375
2376 #endif
2377
2378 #ifdef CONFIG_CPU_IDLE
2379 static inline void idle_set_state(struct rq *rq,
2380                                   struct cpuidle_state *idle_state)
2381 {
2382         rq->idle_state = idle_state;
2383 }
2384
2385 static inline struct cpuidle_state *idle_get_state(struct rq *rq)
2386 {
2387         SCHED_WARN_ON(!rcu_read_lock_held());
2388
2389         return rq->idle_state;
2390 }
2391 #else
2392 static inline void idle_set_state(struct rq *rq,
2393                                   struct cpuidle_state *idle_state)
2394 {
2395 }
2396
2397 static inline struct cpuidle_state *idle_get_state(struct rq *rq)
2398 {
2399         return NULL;
2400 }
2401 #endif
2402
2403 extern void schedule_idle(void);
2404
2405 extern void sysrq_sched_debug_show(void);
2406 extern void sched_init_granularity(void);
2407 extern void update_max_interval(void);
2408
2409 extern void init_sched_dl_class(void);
2410 extern void init_sched_rt_class(void);
2411 extern void init_sched_fair_class(void);
2412
2413 extern void reweight_task(struct task_struct *p, int prio);
2414
2415 extern void resched_curr(struct rq *rq);
2416 extern void resched_cpu(int cpu);
2417
2418 extern struct rt_bandwidth def_rt_bandwidth;
2419 extern void init_rt_bandwidth(struct rt_bandwidth *rt_b, u64 period, u64 runtime);
2420 extern bool sched_rt_bandwidth_account(struct rt_rq *rt_rq);
2421
2422 extern void init_dl_task_timer(struct sched_dl_entity *dl_se);
2423 extern void init_dl_inactive_task_timer(struct sched_dl_entity *dl_se);
2424
2425 #define BW_SHIFT                20
2426 #define BW_UNIT                 (1 << BW_SHIFT)
2427 #define RATIO_SHIFT             8
2428 #define MAX_BW_BITS             (64 - BW_SHIFT)
2429 #define MAX_BW                  ((1ULL << MAX_BW_BITS) - 1)
2430 unsigned long to_ratio(u64 period, u64 runtime);
2431
2432 extern void init_entity_runnable_average(struct sched_entity *se);
2433 extern void post_init_entity_util_avg(struct task_struct *p);
2434
2435 #ifdef CONFIG_NO_HZ_FULL
2436 extern bool sched_can_stop_tick(struct rq *rq);
2437 extern int __init sched_tick_offload_init(void);
2438
2439 /*
2440  * Tick may be needed by tasks in the runqueue depending on their policy and
2441  * requirements. If tick is needed, lets send the target an IPI to kick it out of
2442  * nohz mode if necessary.
2443  */
2444 static inline void sched_update_tick_dependency(struct rq *rq)
2445 {
2446         int cpu = cpu_of(rq);
2447
2448         if (!tick_nohz_full_cpu(cpu))
2449                 return;
2450
2451         if (sched_can_stop_tick(rq))
2452                 tick_nohz_dep_clear_cpu(cpu, TICK_DEP_BIT_SCHED);
2453         else
2454                 tick_nohz_dep_set_cpu(cpu, TICK_DEP_BIT_SCHED);
2455 }
2456 #else
2457 static inline int sched_tick_offload_init(void) { return 0; }
2458 static inline void sched_update_tick_dependency(struct rq *rq) { }
2459 #endif
2460
2461 static inline void add_nr_running(struct rq *rq, unsigned count)
2462 {
2463         unsigned prev_nr = rq->nr_running;
2464
2465         rq->nr_running = prev_nr + count;
2466         if (trace_sched_update_nr_running_tp_enabled()) {
2467                 call_trace_sched_update_nr_running(rq, count);
2468         }
2469
2470 #ifdef CONFIG_SMP
2471         if (prev_nr < 2 && rq->nr_running >= 2) {
2472                 if (!READ_ONCE(rq->rd->overload))
2473                         WRITE_ONCE(rq->rd->overload, 1);
2474         }
2475 #endif
2476
2477         sched_update_tick_dependency(rq);
2478 }
2479
2480 static inline void sub_nr_running(struct rq *rq, unsigned count)
2481 {
2482         rq->nr_running -= count;
2483         if (trace_sched_update_nr_running_tp_enabled()) {
2484                 call_trace_sched_update_nr_running(rq, -count);
2485         }
2486
2487         /* Check if we still need preemption */
2488         sched_update_tick_dependency(rq);
2489 }
2490
2491 extern void activate_task(struct rq *rq, struct task_struct *p, int flags);
2492 extern void deactivate_task(struct rq *rq, struct task_struct *p, int flags);
2493
2494 extern void check_preempt_curr(struct rq *rq, struct task_struct *p, int flags);
2495
2496 #ifdef CONFIG_PREEMPT_RT
2497 #define SCHED_NR_MIGRATE_BREAK 8
2498 #else
2499 #define SCHED_NR_MIGRATE_BREAK 32
2500 #endif
2501
2502 extern const_debug unsigned int sysctl_sched_nr_migrate;
2503 extern const_debug unsigned int sysctl_sched_migration_cost;
2504
2505 #ifdef CONFIG_SCHED_DEBUG
2506 extern unsigned int sysctl_sched_latency;
2507 extern unsigned int sysctl_sched_min_granularity;
2508 extern unsigned int sysctl_sched_idle_min_granularity;
2509 extern unsigned int sysctl_sched_wakeup_granularity;
2510 extern int sysctl_resched_latency_warn_ms;
2511 extern int sysctl_resched_latency_warn_once;
2512
2513 extern unsigned int sysctl_sched_tunable_scaling;
2514
2515 extern unsigned int sysctl_numa_balancing_scan_delay;
2516 extern unsigned int sysctl_numa_balancing_scan_period_min;
2517 extern unsigned int sysctl_numa_balancing_scan_period_max;
2518 extern unsigned int sysctl_numa_balancing_scan_size;
2519 extern unsigned int sysctl_numa_balancing_hot_threshold;
2520 #endif
2521
2522 #ifdef CONFIG_SCHED_HRTICK
2523
2524 /*
2525  * Use hrtick when:
2526  *  - enabled by features
2527  *  - hrtimer is actually high res
2528  */
2529 static inline int hrtick_enabled(struct rq *rq)
2530 {
2531         if (!cpu_active(cpu_of(rq)))
2532                 return 0;
2533         return hrtimer_is_hres_active(&rq->hrtick_timer);
2534 }
2535
2536 static inline int hrtick_enabled_fair(struct rq *rq)
2537 {
2538         if (!sched_feat(HRTICK))
2539                 return 0;
2540         return hrtick_enabled(rq);
2541 }
2542
2543 static inline int hrtick_enabled_dl(struct rq *rq)
2544 {
2545         if (!sched_feat(HRTICK_DL))
2546                 return 0;
2547         return hrtick_enabled(rq);
2548 }
2549
2550 void hrtick_start(struct rq *rq, u64 delay);
2551
2552 #else
2553
2554 static inline int hrtick_enabled_fair(struct rq *rq)
2555 {
2556         return 0;
2557 }
2558
2559 static inline int hrtick_enabled_dl(struct rq *rq)
2560 {
2561         return 0;
2562 }
2563
2564 static inline int hrtick_enabled(struct rq *rq)
2565 {
2566         return 0;
2567 }
2568
2569 #endif /* CONFIG_SCHED_HRTICK */
2570
2571 #ifndef arch_scale_freq_tick
2572 static __always_inline
2573 void arch_scale_freq_tick(void)
2574 {
2575 }
2576 #endif
2577
2578 #ifndef arch_scale_freq_capacity
2579 /**
2580  * arch_scale_freq_capacity - get the frequency scale factor of a given CPU.
2581  * @cpu: the CPU in question.
2582  *
2583  * Return: the frequency scale factor normalized against SCHED_CAPACITY_SCALE, i.e.
2584  *
2585  *     f_curr
2586  *     ------ * SCHED_CAPACITY_SCALE
2587  *     f_max
2588  */
2589 static __always_inline
2590 unsigned long arch_scale_freq_capacity(int cpu)
2591 {
2592         return SCHED_CAPACITY_SCALE;
2593 }
2594 #endif
2595
2596 #ifdef CONFIG_SCHED_DEBUG
2597 /*
2598  * In double_lock_balance()/double_rq_lock(), we use raw_spin_rq_lock() to
2599  * acquire rq lock instead of rq_lock(). So at the end of these two functions
2600  * we need to call double_rq_clock_clear_update() to clear RQCF_UPDATED of
2601  * rq->clock_update_flags to avoid the WARN_DOUBLE_CLOCK warning.
2602  */
2603 static inline void double_rq_clock_clear_update(struct rq *rq1, struct rq *rq2)
2604 {
2605         rq1->clock_update_flags &= (RQCF_REQ_SKIP|RQCF_ACT_SKIP);
2606         /* rq1 == rq2 for !CONFIG_SMP, so just clear RQCF_UPDATED once. */
2607 #ifdef CONFIG_SMP
2608         rq2->clock_update_flags &= (RQCF_REQ_SKIP|RQCF_ACT_SKIP);
2609 #endif
2610 }
2611 #else
2612 static inline void double_rq_clock_clear_update(struct rq *rq1, struct rq *rq2) {}
2613 #endif
2614
2615 #ifdef CONFIG_SMP
2616
2617 static inline bool rq_order_less(struct rq *rq1, struct rq *rq2)
2618 {
2619 #ifdef CONFIG_SCHED_CORE
2620         /*
2621          * In order to not have {0,2},{1,3} turn into into an AB-BA,
2622          * order by core-id first and cpu-id second.
2623          *
2624          * Notably:
2625          *
2626          *      double_rq_lock(0,3); will take core-0, core-1 lock
2627          *      double_rq_lock(1,2); will take core-1, core-0 lock
2628          *
2629          * when only cpu-id is considered.
2630          */
2631         if (rq1->core->cpu < rq2->core->cpu)
2632                 return true;
2633         if (rq1->core->cpu > rq2->core->cpu)
2634                 return false;
2635
2636         /*
2637          * __sched_core_flip() relies on SMT having cpu-id lock order.
2638          */
2639 #endif
2640         return rq1->cpu < rq2->cpu;
2641 }
2642
2643 extern void double_rq_lock(struct rq *rq1, struct rq *rq2);
2644
2645 #ifdef CONFIG_PREEMPTION
2646
2647 /*
2648  * fair double_lock_balance: Safely acquires both rq->locks in a fair
2649  * way at the expense of forcing extra atomic operations in all
2650  * invocations.  This assures that the double_lock is acquired using the
2651  * same underlying policy as the spinlock_t on this architecture, which
2652  * reduces latency compared to the unfair variant below.  However, it
2653  * also adds more overhead and therefore may reduce throughput.
2654  */
2655 static inline int _double_lock_balance(struct rq *this_rq, struct rq *busiest)
2656         __releases(this_rq->lock)
2657         __acquires(busiest->lock)
2658         __acquires(this_rq->lock)
2659 {
2660         raw_spin_rq_unlock(this_rq);
2661         double_rq_lock(this_rq, busiest);
2662
2663         return 1;
2664 }
2665
2666 #else
2667 /*
2668  * Unfair double_lock_balance: Optimizes throughput at the expense of
2669  * latency by eliminating extra atomic operations when the locks are
2670  * already in proper order on entry.  This favors lower CPU-ids and will
2671  * grant the double lock to lower CPUs over higher ids under contention,
2672  * regardless of entry order into the function.
2673  */
2674 static inline int _double_lock_balance(struct rq *this_rq, struct rq *busiest)
2675         __releases(this_rq->lock)
2676         __acquires(busiest->lock)
2677         __acquires(this_rq->lock)
2678 {
2679         if (__rq_lockp(this_rq) == __rq_lockp(busiest) ||
2680             likely(raw_spin_rq_trylock(busiest))) {
2681                 double_rq_clock_clear_update(this_rq, busiest);
2682                 return 0;
2683         }
2684
2685         if (rq_order_less(this_rq, busiest)) {
2686                 raw_spin_rq_lock_nested(busiest, SINGLE_DEPTH_NESTING);
2687                 double_rq_clock_clear_update(this_rq, busiest);
2688                 return 0;
2689         }
2690
2691         raw_spin_rq_unlock(this_rq);
2692         double_rq_lock(this_rq, busiest);
2693
2694         return 1;
2695 }
2696
2697 #endif /* CONFIG_PREEMPTION */
2698
2699 /*
2700  * double_lock_balance - lock the busiest runqueue, this_rq is locked already.
2701  */
2702 static inline int double_lock_balance(struct rq *this_rq, struct rq *busiest)
2703 {
2704         lockdep_assert_irqs_disabled();
2705
2706         return _double_lock_balance(this_rq, busiest);
2707 }
2708
2709 static inline void double_unlock_balance(struct rq *this_rq, struct rq *busiest)
2710         __releases(busiest->lock)
2711 {
2712         if (__rq_lockp(this_rq) != __rq_lockp(busiest))
2713                 raw_spin_rq_unlock(busiest);
2714         lock_set_subclass(&__rq_lockp(this_rq)->dep_map, 0, _RET_IP_);
2715 }
2716
2717 static inline void double_lock(spinlock_t *l1, spinlock_t *l2)
2718 {
2719         if (l1 > l2)
2720                 swap(l1, l2);
2721
2722         spin_lock(l1);
2723         spin_lock_nested(l2, SINGLE_DEPTH_NESTING);
2724 }
2725
2726 static inline void double_lock_irq(spinlock_t *l1, spinlock_t *l2)
2727 {
2728         if (l1 > l2)
2729                 swap(l1, l2);
2730
2731         spin_lock_irq(l1);
2732         spin_lock_nested(l2, SINGLE_DEPTH_NESTING);
2733 }
2734
2735 static inline void double_raw_lock(raw_spinlock_t *l1, raw_spinlock_t *l2)
2736 {
2737         if (l1 > l2)
2738                 swap(l1, l2);
2739
2740         raw_spin_lock(l1);
2741         raw_spin_lock_nested(l2, SINGLE_DEPTH_NESTING);
2742 }
2743
2744 /*
2745  * double_rq_unlock - safely unlock two runqueues
2746  *
2747  * Note this does not restore interrupts like task_rq_unlock,
2748  * you need to do so manually after calling.
2749  */
2750 static inline void double_rq_unlock(struct rq *rq1, struct rq *rq2)
2751         __releases(rq1->lock)
2752         __releases(rq2->lock)
2753 {
2754         if (__rq_lockp(rq1) != __rq_lockp(rq2))
2755                 raw_spin_rq_unlock(rq2);
2756         else
2757                 __release(rq2->lock);
2758         raw_spin_rq_unlock(rq1);
2759 }
2760
2761 extern void set_rq_online (struct rq *rq);
2762 extern void set_rq_offline(struct rq *rq);
2763 extern bool sched_smp_initialized;
2764
2765 #else /* CONFIG_SMP */
2766
2767 /*
2768  * double_rq_lock - safely lock two runqueues
2769  *
2770  * Note this does not disable interrupts like task_rq_lock,
2771  * you need to do so manually before calling.
2772  */
2773 static inline void double_rq_lock(struct rq *rq1, struct rq *rq2)
2774         __acquires(rq1->lock)
2775         __acquires(rq2->lock)
2776 {
2777         WARN_ON_ONCE(!irqs_disabled());
2778         WARN_ON_ONCE(rq1 != rq2);
2779         raw_spin_rq_lock(rq1);
2780         __acquire(rq2->lock);   /* Fake it out ;) */
2781         double_rq_clock_clear_update(rq1, rq2);
2782 }
2783
2784 /*
2785  * double_rq_unlock - safely unlock two runqueues
2786  *
2787  * Note this does not restore interrupts like task_rq_unlock,
2788  * you need to do so manually after calling.
2789  */
2790 static inline void double_rq_unlock(struct rq *rq1, struct rq *rq2)
2791         __releases(rq1->lock)
2792         __releases(rq2->lock)
2793 {
2794         WARN_ON_ONCE(rq1 != rq2);
2795         raw_spin_rq_unlock(rq1);
2796         __release(rq2->lock);
2797 }
2798
2799 #endif
2800
2801 extern struct sched_entity *__pick_first_entity(struct cfs_rq *cfs_rq);
2802 extern struct sched_entity *__pick_last_entity(struct cfs_rq *cfs_rq);
2803
2804 #ifdef  CONFIG_SCHED_DEBUG
2805 extern bool sched_debug_verbose;
2806
2807 extern void print_cfs_stats(struct seq_file *m, int cpu);
2808 extern void print_rt_stats(struct seq_file *m, int cpu);
2809 extern void print_dl_stats(struct seq_file *m, int cpu);
2810 extern void print_cfs_rq(struct seq_file *m, int cpu, struct cfs_rq *cfs_rq);
2811 extern void print_rt_rq(struct seq_file *m, int cpu, struct rt_rq *rt_rq);
2812 extern void print_dl_rq(struct seq_file *m, int cpu, struct dl_rq *dl_rq);
2813
2814 extern void resched_latency_warn(int cpu, u64 latency);
2815 #ifdef CONFIG_NUMA_BALANCING
2816 extern void
2817 show_numa_stats(struct task_struct *p, struct seq_file *m);
2818 extern void
2819 print_numa_stats(struct seq_file *m, int node, unsigned long tsf,
2820         unsigned long tpf, unsigned long gsf, unsigned long gpf);
2821 #endif /* CONFIG_NUMA_BALANCING */
2822 #else
2823 static inline void resched_latency_warn(int cpu, u64 latency) {}
2824 #endif /* CONFIG_SCHED_DEBUG */
2825
2826 extern void init_cfs_rq(struct cfs_rq *cfs_rq);
2827 extern void init_rt_rq(struct rt_rq *rt_rq);
2828 extern void init_dl_rq(struct dl_rq *dl_rq);
2829
2830 extern void cfs_bandwidth_usage_inc(void);
2831 extern void cfs_bandwidth_usage_dec(void);
2832
2833 #ifdef CONFIG_NO_HZ_COMMON
2834 #define NOHZ_BALANCE_KICK_BIT   0
2835 #define NOHZ_STATS_KICK_BIT     1
2836 #define NOHZ_NEWILB_KICK_BIT    2
2837 #define NOHZ_NEXT_KICK_BIT      3
2838
2839 /* Run rebalance_domains() */
2840 #define NOHZ_BALANCE_KICK       BIT(NOHZ_BALANCE_KICK_BIT)
2841 /* Update blocked load */
2842 #define NOHZ_STATS_KICK         BIT(NOHZ_STATS_KICK_BIT)
2843 /* Update blocked load when entering idle */
2844 #define NOHZ_NEWILB_KICK        BIT(NOHZ_NEWILB_KICK_BIT)
2845 /* Update nohz.next_balance */
2846 #define NOHZ_NEXT_KICK          BIT(NOHZ_NEXT_KICK_BIT)
2847
2848 #define NOHZ_KICK_MASK  (NOHZ_BALANCE_KICK | NOHZ_STATS_KICK | NOHZ_NEXT_KICK)
2849
2850 #define nohz_flags(cpu) (&cpu_rq(cpu)->nohz_flags)
2851
2852 extern void nohz_balance_exit_idle(struct rq *rq);
2853 #else
2854 static inline void nohz_balance_exit_idle(struct rq *rq) { }
2855 #endif
2856
2857 #if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON)
2858 extern void nohz_run_idle_balance(int cpu);
2859 #else
2860 static inline void nohz_run_idle_balance(int cpu) { }
2861 #endif
2862
2863 #ifdef CONFIG_IRQ_TIME_ACCOUNTING
2864 struct irqtime {
2865         u64                     total;
2866         u64                     tick_delta;
2867         u64                     irq_start_time;
2868         struct u64_stats_sync   sync;
2869 };
2870
2871 DECLARE_PER_CPU(struct irqtime, cpu_irqtime);
2872
2873 /*
2874  * Returns the irqtime minus the softirq time computed by ksoftirqd.
2875  * Otherwise ksoftirqd's sum_exec_runtime is subtracted its own runtime
2876  * and never move forward.
2877  */
2878 static inline u64 irq_time_read(int cpu)
2879 {
2880         struct irqtime *irqtime = &per_cpu(cpu_irqtime, cpu);
2881         unsigned int seq;
2882         u64 total;
2883
2884         do {
2885                 seq = __u64_stats_fetch_begin(&irqtime->sync);
2886                 total = irqtime->total;
2887         } while (__u64_stats_fetch_retry(&irqtime->sync, seq));
2888
2889         return total;
2890 }
2891 #endif /* CONFIG_IRQ_TIME_ACCOUNTING */
2892
2893 #ifdef CONFIG_CPU_FREQ
2894 DECLARE_PER_CPU(struct update_util_data __rcu *, cpufreq_update_util_data);
2895
2896 /**
2897  * cpufreq_update_util - Take a note about CPU utilization changes.
2898  * @rq: Runqueue to carry out the update for.
2899  * @flags: Update reason flags.
2900  *
2901  * This function is called by the scheduler on the CPU whose utilization is
2902  * being updated.
2903  *
2904  * It can only be called from RCU-sched read-side critical sections.
2905  *
2906  * The way cpufreq is currently arranged requires it to evaluate the CPU
2907  * performance state (frequency/voltage) on a regular basis to prevent it from
2908  * being stuck in a completely inadequate performance level for too long.
2909  * That is not guaranteed to happen if the updates are only triggered from CFS
2910  * and DL, though, because they may not be coming in if only RT tasks are
2911  * active all the time (or there are RT tasks only).
2912  *
2913  * As a workaround for that issue, this function is called periodically by the
2914  * RT sched class to trigger extra cpufreq updates to prevent it from stalling,
2915  * but that really is a band-aid.  Going forward it should be replaced with
2916  * solutions targeted more specifically at RT tasks.
2917  */
2918 static inline void cpufreq_update_util(struct rq *rq, unsigned int flags)
2919 {
2920         struct update_util_data *data;
2921
2922         data = rcu_dereference_sched(*per_cpu_ptr(&cpufreq_update_util_data,
2923                                                   cpu_of(rq)));
2924         if (data)
2925                 data->func(data, rq_clock(rq), flags);
2926 }
2927 #else
2928 static inline void cpufreq_update_util(struct rq *rq, unsigned int flags) {}
2929 #endif /* CONFIG_CPU_FREQ */
2930
2931 #ifdef arch_scale_freq_capacity
2932 # ifndef arch_scale_freq_invariant
2933 #  define arch_scale_freq_invariant()   true
2934 # endif
2935 #else
2936 # define arch_scale_freq_invariant()    false
2937 #endif
2938
2939 #ifdef CONFIG_SMP
2940 static inline unsigned long capacity_orig_of(int cpu)
2941 {
2942         return cpu_rq(cpu)->cpu_capacity_orig;
2943 }
2944
2945 /**
2946  * enum cpu_util_type - CPU utilization type
2947  * @FREQUENCY_UTIL:     Utilization used to select frequency
2948  * @ENERGY_UTIL:        Utilization used during energy calculation
2949  *
2950  * The utilization signals of all scheduling classes (CFS/RT/DL) and IRQ time
2951  * need to be aggregated differently depending on the usage made of them. This
2952  * enum is used within effective_cpu_util() to differentiate the types of
2953  * utilization expected by the callers, and adjust the aggregation accordingly.
2954  */
2955 enum cpu_util_type {
2956         FREQUENCY_UTIL,
2957         ENERGY_UTIL,
2958 };
2959
2960 unsigned long effective_cpu_util(int cpu, unsigned long util_cfs,
2961                                  enum cpu_util_type type,
2962                                  struct task_struct *p);
2963
2964 /*
2965  * Verify the fitness of task @p to run on @cpu taking into account the
2966  * CPU original capacity and the runtime/deadline ratio of the task.
2967  *
2968  * The function will return true if the original capacity of @cpu is
2969  * greater than or equal to task's deadline density right shifted by
2970  * (BW_SHIFT - SCHED_CAPACITY_SHIFT) and false otherwise.
2971  */
2972 static inline bool dl_task_fits_capacity(struct task_struct *p, int cpu)
2973 {
2974         unsigned long cap = arch_scale_cpu_capacity(cpu);
2975
2976         return cap >= p->dl.dl_density >> (BW_SHIFT - SCHED_CAPACITY_SHIFT);
2977 }
2978
2979 static inline unsigned long cpu_bw_dl(struct rq *rq)
2980 {
2981         return (rq->dl.running_bw * SCHED_CAPACITY_SCALE) >> BW_SHIFT;
2982 }
2983
2984 static inline unsigned long cpu_util_dl(struct rq *rq)
2985 {
2986         return READ_ONCE(rq->avg_dl.util_avg);
2987 }
2988
2989
2990 extern unsigned long cpu_util_cfs(int cpu);
2991 extern unsigned long cpu_util_cfs_boost(int cpu);
2992
2993 static inline unsigned long cpu_util_rt(struct rq *rq)
2994 {
2995         return READ_ONCE(rq->avg_rt.util_avg);
2996 }
2997 #endif
2998
2999 #ifdef CONFIG_UCLAMP_TASK
3000 unsigned long uclamp_eff_value(struct task_struct *p, enum uclamp_id clamp_id);
3001
3002 static inline unsigned long uclamp_rq_get(struct rq *rq,
3003                                           enum uclamp_id clamp_id)
3004 {
3005         return READ_ONCE(rq->uclamp[clamp_id].value);
3006 }
3007
3008 static inline void uclamp_rq_set(struct rq *rq, enum uclamp_id clamp_id,
3009                                  unsigned int value)
3010 {
3011         WRITE_ONCE(rq->uclamp[clamp_id].value, value);
3012 }
3013
3014 static inline bool uclamp_rq_is_idle(struct rq *rq)
3015 {
3016         return rq->uclamp_flags & UCLAMP_FLAG_IDLE;
3017 }
3018
3019 /**
3020  * uclamp_rq_util_with - clamp @util with @rq and @p effective uclamp values.
3021  * @rq:         The rq to clamp against. Must not be NULL.
3022  * @util:       The util value to clamp.
3023  * @p:          The task to clamp against. Can be NULL if you want to clamp
3024  *              against @rq only.
3025  *
3026  * Clamps the passed @util to the max(@rq, @p) effective uclamp values.
3027  *
3028  * If sched_uclamp_used static key is disabled, then just return the util
3029  * without any clamping since uclamp aggregation at the rq level in the fast
3030  * path is disabled, rendering this operation a NOP.
3031  *
3032  * Use uclamp_eff_value() if you don't care about uclamp values at rq level. It
3033  * will return the correct effective uclamp value of the task even if the
3034  * static key is disabled.
3035  */
3036 static __always_inline
3037 unsigned long uclamp_rq_util_with(struct rq *rq, unsigned long util,
3038                                   struct task_struct *p)
3039 {
3040         unsigned long min_util = 0;
3041         unsigned long max_util = 0;
3042
3043         if (!static_branch_likely(&sched_uclamp_used))
3044                 return util;
3045
3046         if (p) {
3047                 min_util = uclamp_eff_value(p, UCLAMP_MIN);
3048                 max_util = uclamp_eff_value(p, UCLAMP_MAX);
3049
3050                 /*
3051                  * Ignore last runnable task's max clamp, as this task will
3052                  * reset it. Similarly, no need to read the rq's min clamp.
3053                  */
3054                 if (uclamp_rq_is_idle(rq))
3055                         goto out;
3056         }
3057
3058         min_util = max_t(unsigned long, min_util, uclamp_rq_get(rq, UCLAMP_MIN));
3059         max_util = max_t(unsigned long, max_util, uclamp_rq_get(rq, UCLAMP_MAX));
3060 out:
3061         /*
3062          * Since CPU's {min,max}_util clamps are MAX aggregated considering
3063          * RUNNABLE tasks with _different_ clamps, we can end up with an
3064          * inversion. Fix it now when the clamps are applied.
3065          */
3066         if (unlikely(min_util >= max_util))
3067                 return min_util;
3068
3069         return clamp(util, min_util, max_util);
3070 }
3071
3072 /* Is the rq being capped/throttled by uclamp_max? */
3073 static inline bool uclamp_rq_is_capped(struct rq *rq)
3074 {
3075         unsigned long rq_util;
3076         unsigned long max_util;
3077
3078         if (!static_branch_likely(&sched_uclamp_used))
3079                 return false;
3080
3081         rq_util = cpu_util_cfs(cpu_of(rq)) + cpu_util_rt(rq);
3082         max_util = READ_ONCE(rq->uclamp[UCLAMP_MAX].value);
3083
3084         return max_util != SCHED_CAPACITY_SCALE && rq_util >= max_util;
3085 }
3086
3087 /*
3088  * When uclamp is compiled in, the aggregation at rq level is 'turned off'
3089  * by default in the fast path and only gets turned on once userspace performs
3090  * an operation that requires it.
3091  *
3092  * Returns true if userspace opted-in to use uclamp and aggregation at rq level
3093  * hence is active.
3094  */
3095 static inline bool uclamp_is_used(void)
3096 {
3097         return static_branch_likely(&sched_uclamp_used);
3098 }
3099 #else /* CONFIG_UCLAMP_TASK */
3100 static inline unsigned long uclamp_eff_value(struct task_struct *p,
3101                                              enum uclamp_id clamp_id)
3102 {
3103         if (clamp_id == UCLAMP_MIN)
3104                 return 0;
3105
3106         return SCHED_CAPACITY_SCALE;
3107 }
3108
3109 static inline
3110 unsigned long uclamp_rq_util_with(struct rq *rq, unsigned long util,
3111                                   struct task_struct *p)
3112 {
3113         return util;
3114 }
3115
3116 static inline bool uclamp_rq_is_capped(struct rq *rq) { return false; }
3117
3118 static inline bool uclamp_is_used(void)
3119 {
3120         return false;
3121 }
3122
3123 static inline unsigned long uclamp_rq_get(struct rq *rq,
3124                                           enum uclamp_id clamp_id)
3125 {
3126         if (clamp_id == UCLAMP_MIN)
3127                 return 0;
3128
3129         return SCHED_CAPACITY_SCALE;
3130 }
3131
3132 static inline void uclamp_rq_set(struct rq *rq, enum uclamp_id clamp_id,
3133                                  unsigned int value)
3134 {
3135 }
3136
3137 static inline bool uclamp_rq_is_idle(struct rq *rq)
3138 {
3139         return false;
3140 }
3141 #endif /* CONFIG_UCLAMP_TASK */
3142
3143 #ifdef CONFIG_HAVE_SCHED_AVG_IRQ
3144 static inline unsigned long cpu_util_irq(struct rq *rq)
3145 {
3146         return rq->avg_irq.util_avg;
3147 }
3148
3149 static inline
3150 unsigned long scale_irq_capacity(unsigned long util, unsigned long irq, unsigned long max)
3151 {
3152         util *= (max - irq);
3153         util /= max;
3154
3155         return util;
3156
3157 }
3158 #else
3159 static inline unsigned long cpu_util_irq(struct rq *rq)
3160 {
3161         return 0;
3162 }
3163
3164 static inline
3165 unsigned long scale_irq_capacity(unsigned long util, unsigned long irq, unsigned long max)
3166 {
3167         return util;
3168 }
3169 #endif
3170
3171 #if defined(CONFIG_ENERGY_MODEL) && defined(CONFIG_CPU_FREQ_GOV_SCHEDUTIL)
3172
3173 #define perf_domain_span(pd) (to_cpumask(((pd)->em_pd->cpus)))
3174
3175 DECLARE_STATIC_KEY_FALSE(sched_energy_present);
3176
3177 static inline bool sched_energy_enabled(void)
3178 {
3179         return static_branch_unlikely(&sched_energy_present);
3180 }
3181
3182 #else /* ! (CONFIG_ENERGY_MODEL && CONFIG_CPU_FREQ_GOV_SCHEDUTIL) */
3183
3184 #define perf_domain_span(pd) NULL
3185 static inline bool sched_energy_enabled(void) { return false; }
3186
3187 #endif /* CONFIG_ENERGY_MODEL && CONFIG_CPU_FREQ_GOV_SCHEDUTIL */
3188
3189 #ifdef CONFIG_MEMBARRIER
3190 /*
3191  * The scheduler provides memory barriers required by membarrier between:
3192  * - prior user-space memory accesses and store to rq->membarrier_state,
3193  * - store to rq->membarrier_state and following user-space memory accesses.
3194  * In the same way it provides those guarantees around store to rq->curr.
3195  */
3196 static inline void membarrier_switch_mm(struct rq *rq,
3197                                         struct mm_struct *prev_mm,
3198                                         struct mm_struct *next_mm)
3199 {
3200         int membarrier_state;
3201
3202         if (prev_mm == next_mm)
3203                 return;
3204
3205         membarrier_state = atomic_read(&next_mm->membarrier_state);
3206         if (READ_ONCE(rq->membarrier_state) == membarrier_state)
3207                 return;
3208
3209         WRITE_ONCE(rq->membarrier_state, membarrier_state);
3210 }
3211 #else
3212 static inline void membarrier_switch_mm(struct rq *rq,
3213                                         struct mm_struct *prev_mm,
3214                                         struct mm_struct *next_mm)
3215 {
3216 }
3217 #endif
3218
3219 #ifdef CONFIG_SMP
3220 static inline bool is_per_cpu_kthread(struct task_struct *p)
3221 {
3222         if (!(p->flags & PF_KTHREAD))
3223                 return false;
3224
3225         if (p->nr_cpus_allowed != 1)
3226                 return false;
3227
3228         return true;
3229 }
3230 #endif
3231
3232 extern void swake_up_all_locked(struct swait_queue_head *q);
3233 extern void __prepare_to_swait(struct swait_queue_head *q, struct swait_queue *wait);
3234
3235 #ifdef CONFIG_PREEMPT_DYNAMIC
3236 extern int preempt_dynamic_mode;
3237 extern int sched_dynamic_mode(const char *str);
3238 extern void sched_dynamic_update(int mode);
3239 #endif
3240
3241 static inline void update_current_exec_runtime(struct task_struct *curr,
3242                                                 u64 now, u64 delta_exec)
3243 {
3244         curr->se.sum_exec_runtime += delta_exec;
3245         account_group_exec_runtime(curr, delta_exec);
3246
3247         curr->se.exec_start = now;
3248         cgroup_account_cputime(curr, delta_exec);
3249 }
3250
3251 #ifdef CONFIG_SCHED_MM_CID
3252
3253 #define SCHED_MM_CID_PERIOD_NS  (100ULL * 1000000)      /* 100ms */
3254 #define MM_CID_SCAN_DELAY       100                     /* 100ms */
3255
3256 extern raw_spinlock_t cid_lock;
3257 extern int use_cid_lock;
3258
3259 extern void sched_mm_cid_migrate_from(struct task_struct *t);
3260 extern void sched_mm_cid_migrate_to(struct rq *dst_rq, struct task_struct *t);
3261 extern void task_tick_mm_cid(struct rq *rq, struct task_struct *curr);
3262 extern void init_sched_mm_cid(struct task_struct *t);
3263
3264 static inline void __mm_cid_put(struct mm_struct *mm, int cid)
3265 {
3266         if (cid < 0)
3267                 return;
3268         cpumask_clear_cpu(cid, mm_cidmask(mm));
3269 }
3270
3271 /*
3272  * The per-mm/cpu cid can have the MM_CID_LAZY_PUT flag set or transition to
3273  * the MM_CID_UNSET state without holding the rq lock, but the rq lock needs to
3274  * be held to transition to other states.
3275  *
3276  * State transitions synchronized with cmpxchg or try_cmpxchg need to be
3277  * consistent across cpus, which prevents use of this_cpu_cmpxchg.
3278  */
3279 static inline void mm_cid_put_lazy(struct task_struct *t)
3280 {
3281         struct mm_struct *mm = t->mm;
3282         struct mm_cid __percpu *pcpu_cid = mm->pcpu_cid;
3283         int cid;
3284
3285         lockdep_assert_irqs_disabled();
3286         cid = __this_cpu_read(pcpu_cid->cid);
3287         if (!mm_cid_is_lazy_put(cid) ||
3288             !try_cmpxchg(&this_cpu_ptr(pcpu_cid)->cid, &cid, MM_CID_UNSET))
3289                 return;
3290         __mm_cid_put(mm, mm_cid_clear_lazy_put(cid));
3291 }
3292
3293 static inline int mm_cid_pcpu_unset(struct mm_struct *mm)
3294 {
3295         struct mm_cid __percpu *pcpu_cid = mm->pcpu_cid;
3296         int cid, res;
3297
3298         lockdep_assert_irqs_disabled();
3299         cid = __this_cpu_read(pcpu_cid->cid);
3300         for (;;) {
3301                 if (mm_cid_is_unset(cid))
3302                         return MM_CID_UNSET;
3303                 /*
3304                  * Attempt transition from valid or lazy-put to unset.
3305                  */
3306                 res = cmpxchg(&this_cpu_ptr(pcpu_cid)->cid, cid, MM_CID_UNSET);
3307                 if (res == cid)
3308                         break;
3309                 cid = res;
3310         }
3311         return cid;
3312 }
3313
3314 static inline void mm_cid_put(struct mm_struct *mm)
3315 {
3316         int cid;
3317
3318         lockdep_assert_irqs_disabled();
3319         cid = mm_cid_pcpu_unset(mm);
3320         if (cid == MM_CID_UNSET)
3321                 return;
3322         __mm_cid_put(mm, mm_cid_clear_lazy_put(cid));
3323 }
3324
3325 static inline int __mm_cid_try_get(struct mm_struct *mm)
3326 {
3327         struct cpumask *cpumask;
3328         int cid;
3329
3330         cpumask = mm_cidmask(mm);
3331         /*
3332          * Retry finding first zero bit if the mask is temporarily
3333          * filled. This only happens during concurrent remote-clear
3334          * which owns a cid without holding a rq lock.
3335          */
3336         for (;;) {
3337                 cid = cpumask_first_zero(cpumask);
3338                 if (cid < nr_cpu_ids)
3339                         break;
3340                 cpu_relax();
3341         }
3342         if (cpumask_test_and_set_cpu(cid, cpumask))
3343                 return -1;
3344         return cid;
3345 }
3346
3347 /*
3348  * Save a snapshot of the current runqueue time of this cpu
3349  * with the per-cpu cid value, allowing to estimate how recently it was used.
3350  */
3351 static inline void mm_cid_snapshot_time(struct rq *rq, struct mm_struct *mm)
3352 {
3353         struct mm_cid *pcpu_cid = per_cpu_ptr(mm->pcpu_cid, cpu_of(rq));
3354
3355         lockdep_assert_rq_held(rq);
3356         WRITE_ONCE(pcpu_cid->time, rq->clock);
3357 }
3358
3359 static inline int __mm_cid_get(struct rq *rq, struct mm_struct *mm)
3360 {
3361         int cid;
3362
3363         /*
3364          * All allocations (even those using the cid_lock) are lock-free. If
3365          * use_cid_lock is set, hold the cid_lock to perform cid allocation to
3366          * guarantee forward progress.
3367          */
3368         if (!READ_ONCE(use_cid_lock)) {
3369                 cid = __mm_cid_try_get(mm);
3370                 if (cid >= 0)
3371                         goto end;
3372                 raw_spin_lock(&cid_lock);
3373         } else {
3374                 raw_spin_lock(&cid_lock);
3375                 cid = __mm_cid_try_get(mm);
3376                 if (cid >= 0)
3377                         goto unlock;
3378         }
3379
3380         /*
3381          * cid concurrently allocated. Retry while forcing following
3382          * allocations to use the cid_lock to ensure forward progress.
3383          */
3384         WRITE_ONCE(use_cid_lock, 1);
3385         /*
3386          * Set use_cid_lock before allocation. Only care about program order
3387          * because this is only required for forward progress.
3388          */
3389         barrier();
3390         /*
3391          * Retry until it succeeds. It is guaranteed to eventually succeed once
3392          * all newcoming allocations observe the use_cid_lock flag set.
3393          */
3394         do {
3395                 cid = __mm_cid_try_get(mm);
3396                 cpu_relax();
3397         } while (cid < 0);
3398         /*
3399          * Allocate before clearing use_cid_lock. Only care about
3400          * program order because this is for forward progress.
3401          */
3402         barrier();
3403         WRITE_ONCE(use_cid_lock, 0);
3404 unlock:
3405         raw_spin_unlock(&cid_lock);
3406 end:
3407         mm_cid_snapshot_time(rq, mm);
3408         return cid;
3409 }
3410
3411 static inline int mm_cid_get(struct rq *rq, struct mm_struct *mm)
3412 {
3413         struct mm_cid __percpu *pcpu_cid = mm->pcpu_cid;
3414         struct cpumask *cpumask;
3415         int cid;
3416
3417         lockdep_assert_rq_held(rq);
3418         cpumask = mm_cidmask(mm);
3419         cid = __this_cpu_read(pcpu_cid->cid);
3420         if (mm_cid_is_valid(cid)) {
3421                 mm_cid_snapshot_time(rq, mm);
3422                 return cid;
3423         }
3424         if (mm_cid_is_lazy_put(cid)) {
3425                 if (try_cmpxchg(&this_cpu_ptr(pcpu_cid)->cid, &cid, MM_CID_UNSET))
3426                         __mm_cid_put(mm, mm_cid_clear_lazy_put(cid));
3427         }
3428         cid = __mm_cid_get(rq, mm);
3429         __this_cpu_write(pcpu_cid->cid, cid);
3430         return cid;
3431 }
3432
3433 static inline void switch_mm_cid(struct rq *rq,
3434                                  struct task_struct *prev,
3435                                  struct task_struct *next)
3436 {
3437         /*
3438          * Provide a memory barrier between rq->curr store and load of
3439          * {prev,next}->mm->pcpu_cid[cpu] on rq->curr->mm transition.
3440          *
3441          * Should be adapted if context_switch() is modified.
3442          */
3443         if (!next->mm) {                                // to kernel
3444                 /*
3445                  * user -> kernel transition does not guarantee a barrier, but
3446                  * we can use the fact that it performs an atomic operation in
3447                  * mmgrab().
3448                  */
3449                 if (prev->mm)                           // from user
3450                         smp_mb__after_mmgrab();
3451                 /*
3452                  * kernel -> kernel transition does not change rq->curr->mm
3453                  * state. It stays NULL.
3454                  */
3455         } else {                                        // to user
3456                 /*
3457                  * kernel -> user transition does not provide a barrier
3458                  * between rq->curr store and load of {prev,next}->mm->pcpu_cid[cpu].
3459                  * Provide it here.
3460                  */
3461                 if (!prev->mm)                          // from kernel
3462                         smp_mb();
3463                 /*
3464                  * user -> user transition guarantees a memory barrier through
3465                  * switch_mm() when current->mm changes. If current->mm is
3466                  * unchanged, no barrier is needed.
3467                  */
3468         }
3469         if (prev->mm_cid_active) {
3470                 mm_cid_snapshot_time(rq, prev->mm);
3471                 mm_cid_put_lazy(prev);
3472                 prev->mm_cid = -1;
3473         }
3474         if (next->mm_cid_active)
3475                 next->last_mm_cid = next->mm_cid = mm_cid_get(rq, next->mm);
3476 }
3477
3478 #else
3479 static inline void switch_mm_cid(struct rq *rq, struct task_struct *prev, struct task_struct *next) { }
3480 static inline void sched_mm_cid_migrate_from(struct task_struct *t) { }
3481 static inline void sched_mm_cid_migrate_to(struct rq *dst_rq, struct task_struct *t) { }
3482 static inline void task_tick_mm_cid(struct rq *rq, struct task_struct *curr) { }
3483 static inline void init_sched_mm_cid(struct task_struct *t) { }
3484 #endif
3485
3486 #endif /* _KERNEL_SCHED_SCHED_H */