d7d07aa0facfa62940d12c8d239ae8c781e52a5d
[sfrench/cifs-2.6.git] / include / linux / sched.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_SCHED_H
3 #define _LINUX_SCHED_H
4
5 /*
6  * Define 'struct task_struct' and provide the main scheduler
7  * APIs (schedule(), wakeup variants, etc.)
8  */
9
10 #include <uapi/linux/sched.h>
11
12 #include <asm/current.h>
13
14 #include <linux/pid.h>
15 #include <linux/sem.h>
16 #include <linux/shm.h>
17 #include <linux/mutex.h>
18 #include <linux/plist.h>
19 #include <linux/hrtimer.h>
20 #include <linux/irqflags.h>
21 #include <linux/seccomp.h>
22 #include <linux/nodemask.h>
23 #include <linux/rcupdate.h>
24 #include <linux/refcount.h>
25 #include <linux/resource.h>
26 #include <linux/latencytop.h>
27 #include <linux/sched/prio.h>
28 #include <linux/sched/types.h>
29 #include <linux/signal_types.h>
30 #include <linux/syscall_user_dispatch.h>
31 #include <linux/mm_types_task.h>
32 #include <linux/task_io_accounting.h>
33 #include <linux/posix-timers.h>
34 #include <linux/rseq.h>
35 #include <linux/seqlock.h>
36 #include <linux/kcsan.h>
37 #include <asm/kmap_size.h>
38
39 /* task_struct member predeclarations (sorted alphabetically): */
40 struct audit_context;
41 struct backing_dev_info;
42 struct bio_list;
43 struct blk_plug;
44 struct bpf_local_storage;
45 struct capture_control;
46 struct cfs_rq;
47 struct fs_struct;
48 struct futex_pi_state;
49 struct io_context;
50 struct io_uring_task;
51 struct mempolicy;
52 struct nameidata;
53 struct nsproxy;
54 struct perf_event_context;
55 struct pid_namespace;
56 struct pipe_inode_info;
57 struct rcu_node;
58 struct reclaim_state;
59 struct robust_list_head;
60 struct root_domain;
61 struct rq;
62 struct sched_attr;
63 struct sched_param;
64 struct seq_file;
65 struct sighand_struct;
66 struct signal_struct;
67 struct task_delay_info;
68 struct task_group;
69
70 /*
71  * Task state bitmask. NOTE! These bits are also
72  * encoded in fs/proc/array.c: get_task_state().
73  *
74  * We have two separate sets of flags: task->state
75  * is about runnability, while task->exit_state are
76  * about the task exiting. Confusing, but this way
77  * modifying one set can't modify the other one by
78  * mistake.
79  */
80
81 /* Used in tsk->state: */
82 #define TASK_RUNNING                    0x0000
83 #define TASK_INTERRUPTIBLE              0x0001
84 #define TASK_UNINTERRUPTIBLE            0x0002
85 #define __TASK_STOPPED                  0x0004
86 #define __TASK_TRACED                   0x0008
87 /* Used in tsk->exit_state: */
88 #define EXIT_DEAD                       0x0010
89 #define EXIT_ZOMBIE                     0x0020
90 #define EXIT_TRACE                      (EXIT_ZOMBIE | EXIT_DEAD)
91 /* Used in tsk->state again: */
92 #define TASK_PARKED                     0x0040
93 #define TASK_DEAD                       0x0080
94 #define TASK_WAKEKILL                   0x0100
95 #define TASK_WAKING                     0x0200
96 #define TASK_NOLOAD                     0x0400
97 #define TASK_NEW                        0x0800
98 #define TASK_STATE_MAX                  0x1000
99
100 /* Convenience macros for the sake of set_current_state: */
101 #define TASK_KILLABLE                   (TASK_WAKEKILL | TASK_UNINTERRUPTIBLE)
102 #define TASK_STOPPED                    (TASK_WAKEKILL | __TASK_STOPPED)
103 #define TASK_TRACED                     (TASK_WAKEKILL | __TASK_TRACED)
104
105 #define TASK_IDLE                       (TASK_UNINTERRUPTIBLE | TASK_NOLOAD)
106
107 /* Convenience macros for the sake of wake_up(): */
108 #define TASK_NORMAL                     (TASK_INTERRUPTIBLE | TASK_UNINTERRUPTIBLE)
109
110 /* get_task_state(): */
111 #define TASK_REPORT                     (TASK_RUNNING | TASK_INTERRUPTIBLE | \
112                                          TASK_UNINTERRUPTIBLE | __TASK_STOPPED | \
113                                          __TASK_TRACED | EXIT_DEAD | EXIT_ZOMBIE | \
114                                          TASK_PARKED)
115
116 #define task_is_traced(task)            ((task->state & __TASK_TRACED) != 0)
117
118 #define task_is_stopped(task)           ((task->state & __TASK_STOPPED) != 0)
119
120 #define task_is_stopped_or_traced(task) ((task->state & (__TASK_STOPPED | __TASK_TRACED)) != 0)
121
122 #ifdef CONFIG_DEBUG_ATOMIC_SLEEP
123
124 /*
125  * Special states are those that do not use the normal wait-loop pattern. See
126  * the comment with set_special_state().
127  */
128 #define is_special_task_state(state)                            \
129         ((state) & (__TASK_STOPPED | __TASK_TRACED | TASK_PARKED | TASK_DEAD))
130
131 #define __set_current_state(state_value)                        \
132         do {                                                    \
133                 WARN_ON_ONCE(is_special_task_state(state_value));\
134                 current->task_state_change = _THIS_IP_;         \
135                 current->state = (state_value);                 \
136         } while (0)
137
138 #define set_current_state(state_value)                          \
139         do {                                                    \
140                 WARN_ON_ONCE(is_special_task_state(state_value));\
141                 current->task_state_change = _THIS_IP_;         \
142                 smp_store_mb(current->state, (state_value));    \
143         } while (0)
144
145 #define set_special_state(state_value)                                  \
146         do {                                                            \
147                 unsigned long flags; /* may shadow */                   \
148                 WARN_ON_ONCE(!is_special_task_state(state_value));      \
149                 raw_spin_lock_irqsave(&current->pi_lock, flags);        \
150                 current->task_state_change = _THIS_IP_;                 \
151                 current->state = (state_value);                         \
152                 raw_spin_unlock_irqrestore(&current->pi_lock, flags);   \
153         } while (0)
154 #else
155 /*
156  * set_current_state() includes a barrier so that the write of current->state
157  * is correctly serialised wrt the caller's subsequent test of whether to
158  * actually sleep:
159  *
160  *   for (;;) {
161  *      set_current_state(TASK_UNINTERRUPTIBLE);
162  *      if (CONDITION)
163  *         break;
164  *
165  *      schedule();
166  *   }
167  *   __set_current_state(TASK_RUNNING);
168  *
169  * If the caller does not need such serialisation (because, for instance, the
170  * CONDITION test and condition change and wakeup are under the same lock) then
171  * use __set_current_state().
172  *
173  * The above is typically ordered against the wakeup, which does:
174  *
175  *   CONDITION = 1;
176  *   wake_up_state(p, TASK_UNINTERRUPTIBLE);
177  *
178  * where wake_up_state()/try_to_wake_up() executes a full memory barrier before
179  * accessing p->state.
180  *
181  * Wakeup will do: if (@state & p->state) p->state = TASK_RUNNING, that is,
182  * once it observes the TASK_UNINTERRUPTIBLE store the waking CPU can issue a
183  * TASK_RUNNING store which can collide with __set_current_state(TASK_RUNNING).
184  *
185  * However, with slightly different timing the wakeup TASK_RUNNING store can
186  * also collide with the TASK_UNINTERRUPTIBLE store. Losing that store is not
187  * a problem either because that will result in one extra go around the loop
188  * and our @cond test will save the day.
189  *
190  * Also see the comments of try_to_wake_up().
191  */
192 #define __set_current_state(state_value)                                \
193         current->state = (state_value)
194
195 #define set_current_state(state_value)                                  \
196         smp_store_mb(current->state, (state_value))
197
198 /*
199  * set_special_state() should be used for those states when the blocking task
200  * can not use the regular condition based wait-loop. In that case we must
201  * serialize against wakeups such that any possible in-flight TASK_RUNNING stores
202  * will not collide with our state change.
203  */
204 #define set_special_state(state_value)                                  \
205         do {                                                            \
206                 unsigned long flags; /* may shadow */                   \
207                 raw_spin_lock_irqsave(&current->pi_lock, flags);        \
208                 current->state = (state_value);                         \
209                 raw_spin_unlock_irqrestore(&current->pi_lock, flags);   \
210         } while (0)
211
212 #endif
213
214 /* Task command name length: */
215 #define TASK_COMM_LEN                   16
216
217 extern void scheduler_tick(void);
218
219 #define MAX_SCHEDULE_TIMEOUT            LONG_MAX
220
221 extern long schedule_timeout(long timeout);
222 extern long schedule_timeout_interruptible(long timeout);
223 extern long schedule_timeout_killable(long timeout);
224 extern long schedule_timeout_uninterruptible(long timeout);
225 extern long schedule_timeout_idle(long timeout);
226 asmlinkage void schedule(void);
227 extern void schedule_preempt_disabled(void);
228 asmlinkage void preempt_schedule_irq(void);
229
230 extern int __must_check io_schedule_prepare(void);
231 extern void io_schedule_finish(int token);
232 extern long io_schedule_timeout(long timeout);
233 extern void io_schedule(void);
234
235 /**
236  * struct prev_cputime - snapshot of system and user cputime
237  * @utime: time spent in user mode
238  * @stime: time spent in system mode
239  * @lock: protects the above two fields
240  *
241  * Stores previous user/system time values such that we can guarantee
242  * monotonicity.
243  */
244 struct prev_cputime {
245 #ifndef CONFIG_VIRT_CPU_ACCOUNTING_NATIVE
246         u64                             utime;
247         u64                             stime;
248         raw_spinlock_t                  lock;
249 #endif
250 };
251
252 enum vtime_state {
253         /* Task is sleeping or running in a CPU with VTIME inactive: */
254         VTIME_INACTIVE = 0,
255         /* Task is idle */
256         VTIME_IDLE,
257         /* Task runs in kernelspace in a CPU with VTIME active: */
258         VTIME_SYS,
259         /* Task runs in userspace in a CPU with VTIME active: */
260         VTIME_USER,
261         /* Task runs as guests in a CPU with VTIME active: */
262         VTIME_GUEST,
263 };
264
265 struct vtime {
266         seqcount_t              seqcount;
267         unsigned long long      starttime;
268         enum vtime_state        state;
269         unsigned int            cpu;
270         u64                     utime;
271         u64                     stime;
272         u64                     gtime;
273 };
274
275 /*
276  * Utilization clamp constraints.
277  * @UCLAMP_MIN: Minimum utilization
278  * @UCLAMP_MAX: Maximum utilization
279  * @UCLAMP_CNT: Utilization clamp constraints count
280  */
281 enum uclamp_id {
282         UCLAMP_MIN = 0,
283         UCLAMP_MAX,
284         UCLAMP_CNT
285 };
286
287 #ifdef CONFIG_SMP
288 extern struct root_domain def_root_domain;
289 extern struct mutex sched_domains_mutex;
290 #endif
291
292 struct sched_info {
293 #ifdef CONFIG_SCHED_INFO
294         /* Cumulative counters: */
295
296         /* # of times we have run on this CPU: */
297         unsigned long                   pcount;
298
299         /* Time spent waiting on a runqueue: */
300         unsigned long long              run_delay;
301
302         /* Timestamps: */
303
304         /* When did we last run on a CPU? */
305         unsigned long long              last_arrival;
306
307         /* When were we last queued to run? */
308         unsigned long long              last_queued;
309
310 #endif /* CONFIG_SCHED_INFO */
311 };
312
313 /*
314  * Integer metrics need fixed point arithmetic, e.g., sched/fair
315  * has a few: load, load_avg, util_avg, freq, and capacity.
316  *
317  * We define a basic fixed point arithmetic range, and then formalize
318  * all these metrics based on that basic range.
319  */
320 # define SCHED_FIXEDPOINT_SHIFT         10
321 # define SCHED_FIXEDPOINT_SCALE         (1L << SCHED_FIXEDPOINT_SHIFT)
322
323 /* Increase resolution of cpu_capacity calculations */
324 # define SCHED_CAPACITY_SHIFT           SCHED_FIXEDPOINT_SHIFT
325 # define SCHED_CAPACITY_SCALE           (1L << SCHED_CAPACITY_SHIFT)
326
327 struct load_weight {
328         unsigned long                   weight;
329         u32                             inv_weight;
330 };
331
332 /**
333  * struct util_est - Estimation utilization of FAIR tasks
334  * @enqueued: instantaneous estimated utilization of a task/cpu
335  * @ewma:     the Exponential Weighted Moving Average (EWMA)
336  *            utilization of a task
337  *
338  * Support data structure to track an Exponential Weighted Moving Average
339  * (EWMA) of a FAIR task's utilization. New samples are added to the moving
340  * average each time a task completes an activation. Sample's weight is chosen
341  * so that the EWMA will be relatively insensitive to transient changes to the
342  * task's workload.
343  *
344  * The enqueued attribute has a slightly different meaning for tasks and cpus:
345  * - task:   the task's util_avg at last task dequeue time
346  * - cfs_rq: the sum of util_est.enqueued for each RUNNABLE task on that CPU
347  * Thus, the util_est.enqueued of a task represents the contribution on the
348  * estimated utilization of the CPU where that task is currently enqueued.
349  *
350  * Only for tasks we track a moving average of the past instantaneous
351  * estimated utilization. This allows to absorb sporadic drops in utilization
352  * of an otherwise almost periodic task.
353  */
354 struct util_est {
355         unsigned int                    enqueued;
356         unsigned int                    ewma;
357 #define UTIL_EST_WEIGHT_SHIFT           2
358 } __attribute__((__aligned__(sizeof(u64))));
359
360 /*
361  * The load/runnable/util_avg accumulates an infinite geometric series
362  * (see __update_load_avg_cfs_rq() in kernel/sched/pelt.c).
363  *
364  * [load_avg definition]
365  *
366  *   load_avg = runnable% * scale_load_down(load)
367  *
368  * [runnable_avg definition]
369  *
370  *   runnable_avg = runnable% * SCHED_CAPACITY_SCALE
371  *
372  * [util_avg definition]
373  *
374  *   util_avg = running% * SCHED_CAPACITY_SCALE
375  *
376  * where runnable% is the time ratio that a sched_entity is runnable and
377  * running% the time ratio that a sched_entity is running.
378  *
379  * For cfs_rq, they are the aggregated values of all runnable and blocked
380  * sched_entities.
381  *
382  * The load/runnable/util_avg doesn't directly factor frequency scaling and CPU
383  * capacity scaling. The scaling is done through the rq_clock_pelt that is used
384  * for computing those signals (see update_rq_clock_pelt())
385  *
386  * N.B., the above ratios (runnable% and running%) themselves are in the
387  * range of [0, 1]. To do fixed point arithmetics, we therefore scale them
388  * to as large a range as necessary. This is for example reflected by
389  * util_avg's SCHED_CAPACITY_SCALE.
390  *
391  * [Overflow issue]
392  *
393  * The 64-bit load_sum can have 4353082796 (=2^64/47742/88761) entities
394  * with the highest load (=88761), always runnable on a single cfs_rq,
395  * and should not overflow as the number already hits PID_MAX_LIMIT.
396  *
397  * For all other cases (including 32-bit kernels), struct load_weight's
398  * weight will overflow first before we do, because:
399  *
400  *    Max(load_avg) <= Max(load.weight)
401  *
402  * Then it is the load_weight's responsibility to consider overflow
403  * issues.
404  */
405 struct sched_avg {
406         u64                             last_update_time;
407         u64                             load_sum;
408         u64                             runnable_sum;
409         u32                             util_sum;
410         u32                             period_contrib;
411         unsigned long                   load_avg;
412         unsigned long                   runnable_avg;
413         unsigned long                   util_avg;
414         struct util_est                 util_est;
415 } ____cacheline_aligned;
416
417 struct sched_statistics {
418 #ifdef CONFIG_SCHEDSTATS
419         u64                             wait_start;
420         u64                             wait_max;
421         u64                             wait_count;
422         u64                             wait_sum;
423         u64                             iowait_count;
424         u64                             iowait_sum;
425
426         u64                             sleep_start;
427         u64                             sleep_max;
428         s64                             sum_sleep_runtime;
429
430         u64                             block_start;
431         u64                             block_max;
432         u64                             exec_max;
433         u64                             slice_max;
434
435         u64                             nr_migrations_cold;
436         u64                             nr_failed_migrations_affine;
437         u64                             nr_failed_migrations_running;
438         u64                             nr_failed_migrations_hot;
439         u64                             nr_forced_migrations;
440
441         u64                             nr_wakeups;
442         u64                             nr_wakeups_sync;
443         u64                             nr_wakeups_migrate;
444         u64                             nr_wakeups_local;
445         u64                             nr_wakeups_remote;
446         u64                             nr_wakeups_affine;
447         u64                             nr_wakeups_affine_attempts;
448         u64                             nr_wakeups_passive;
449         u64                             nr_wakeups_idle;
450 #endif
451 };
452
453 struct sched_entity {
454         /* For load-balancing: */
455         struct load_weight              load;
456         struct rb_node                  run_node;
457         struct list_head                group_node;
458         unsigned int                    on_rq;
459
460         u64                             exec_start;
461         u64                             sum_exec_runtime;
462         u64                             vruntime;
463         u64                             prev_sum_exec_runtime;
464
465         u64                             nr_migrations;
466
467         struct sched_statistics         statistics;
468
469 #ifdef CONFIG_FAIR_GROUP_SCHED
470         int                             depth;
471         struct sched_entity             *parent;
472         /* rq on which this entity is (to be) queued: */
473         struct cfs_rq                   *cfs_rq;
474         /* rq "owned" by this entity/group: */
475         struct cfs_rq                   *my_q;
476         /* cached value of my_q->h_nr_running */
477         unsigned long                   runnable_weight;
478 #endif
479
480 #ifdef CONFIG_SMP
481         /*
482          * Per entity load average tracking.
483          *
484          * Put into separate cache line so it does not
485          * collide with read-mostly values above.
486          */
487         struct sched_avg                avg;
488 #endif
489 };
490
491 struct sched_rt_entity {
492         struct list_head                run_list;
493         unsigned long                   timeout;
494         unsigned long                   watchdog_stamp;
495         unsigned int                    time_slice;
496         unsigned short                  on_rq;
497         unsigned short                  on_list;
498
499         struct sched_rt_entity          *back;
500 #ifdef CONFIG_RT_GROUP_SCHED
501         struct sched_rt_entity          *parent;
502         /* rq on which this entity is (to be) queued: */
503         struct rt_rq                    *rt_rq;
504         /* rq "owned" by this entity/group: */
505         struct rt_rq                    *my_q;
506 #endif
507 } __randomize_layout;
508
509 struct sched_dl_entity {
510         struct rb_node                  rb_node;
511
512         /*
513          * Original scheduling parameters. Copied here from sched_attr
514          * during sched_setattr(), they will remain the same until
515          * the next sched_setattr().
516          */
517         u64                             dl_runtime;     /* Maximum runtime for each instance    */
518         u64                             dl_deadline;    /* Relative deadline of each instance   */
519         u64                             dl_period;      /* Separation of two instances (period) */
520         u64                             dl_bw;          /* dl_runtime / dl_period               */
521         u64                             dl_density;     /* dl_runtime / dl_deadline             */
522
523         /*
524          * Actual scheduling parameters. Initialized with the values above,
525          * they are continuously updated during task execution. Note that
526          * the remaining runtime could be < 0 in case we are in overrun.
527          */
528         s64                             runtime;        /* Remaining runtime for this instance  */
529         u64                             deadline;       /* Absolute deadline for this instance  */
530         unsigned int                    flags;          /* Specifying the scheduler behaviour   */
531
532         /*
533          * Some bool flags:
534          *
535          * @dl_throttled tells if we exhausted the runtime. If so, the
536          * task has to wait for a replenishment to be performed at the
537          * next firing of dl_timer.
538          *
539          * @dl_boosted tells if we are boosted due to DI. If so we are
540          * outside bandwidth enforcement mechanism (but only until we
541          * exit the critical section);
542          *
543          * @dl_yielded tells if task gave up the CPU before consuming
544          * all its available runtime during the last job.
545          *
546          * @dl_non_contending tells if the task is inactive while still
547          * contributing to the active utilization. In other words, it
548          * indicates if the inactive timer has been armed and its handler
549          * has not been executed yet. This flag is useful to avoid race
550          * conditions between the inactive timer handler and the wakeup
551          * code.
552          *
553          * @dl_overrun tells if the task asked to be informed about runtime
554          * overruns.
555          */
556         unsigned int                    dl_throttled      : 1;
557         unsigned int                    dl_yielded        : 1;
558         unsigned int                    dl_non_contending : 1;
559         unsigned int                    dl_overrun        : 1;
560
561         /*
562          * Bandwidth enforcement timer. Each -deadline task has its
563          * own bandwidth to be enforced, thus we need one timer per task.
564          */
565         struct hrtimer                  dl_timer;
566
567         /*
568          * Inactive timer, responsible for decreasing the active utilization
569          * at the "0-lag time". When a -deadline task blocks, it contributes
570          * to GRUB's active utilization until the "0-lag time", hence a
571          * timer is needed to decrease the active utilization at the correct
572          * time.
573          */
574         struct hrtimer inactive_timer;
575
576 #ifdef CONFIG_RT_MUTEXES
577         /*
578          * Priority Inheritance. When a DEADLINE scheduling entity is boosted
579          * pi_se points to the donor, otherwise points to the dl_se it belongs
580          * to (the original one/itself).
581          */
582         struct sched_dl_entity *pi_se;
583 #endif
584 };
585
586 #ifdef CONFIG_UCLAMP_TASK
587 /* Number of utilization clamp buckets (shorter alias) */
588 #define UCLAMP_BUCKETS CONFIG_UCLAMP_BUCKETS_COUNT
589
590 /*
591  * Utilization clamp for a scheduling entity
592  * @value:              clamp value "assigned" to a se
593  * @bucket_id:          bucket index corresponding to the "assigned" value
594  * @active:             the se is currently refcounted in a rq's bucket
595  * @user_defined:       the requested clamp value comes from user-space
596  *
597  * The bucket_id is the index of the clamp bucket matching the clamp value
598  * which is pre-computed and stored to avoid expensive integer divisions from
599  * the fast path.
600  *
601  * The active bit is set whenever a task has got an "effective" value assigned,
602  * which can be different from the clamp value "requested" from user-space.
603  * This allows to know a task is refcounted in the rq's bucket corresponding
604  * to the "effective" bucket_id.
605  *
606  * The user_defined bit is set whenever a task has got a task-specific clamp
607  * value requested from userspace, i.e. the system defaults apply to this task
608  * just as a restriction. This allows to relax default clamps when a less
609  * restrictive task-specific value has been requested, thus allowing to
610  * implement a "nice" semantic. For example, a task running with a 20%
611  * default boost can still drop its own boosting to 0%.
612  */
613 struct uclamp_se {
614         unsigned int value              : bits_per(SCHED_CAPACITY_SCALE);
615         unsigned int bucket_id          : bits_per(UCLAMP_BUCKETS);
616         unsigned int active             : 1;
617         unsigned int user_defined       : 1;
618 };
619 #endif /* CONFIG_UCLAMP_TASK */
620
621 union rcu_special {
622         struct {
623                 u8                      blocked;
624                 u8                      need_qs;
625                 u8                      exp_hint; /* Hint for performance. */
626                 u8                      need_mb; /* Readers need smp_mb(). */
627         } b; /* Bits. */
628         u32 s; /* Set of bits. */
629 };
630
631 enum perf_event_task_context {
632         perf_invalid_context = -1,
633         perf_hw_context = 0,
634         perf_sw_context,
635         perf_nr_task_contexts,
636 };
637
638 struct wake_q_node {
639         struct wake_q_node *next;
640 };
641
642 struct kmap_ctrl {
643 #ifdef CONFIG_KMAP_LOCAL
644         int                             idx;
645         pte_t                           pteval[KM_MAX_IDX];
646 #endif
647 };
648
649 struct task_struct {
650 #ifdef CONFIG_THREAD_INFO_IN_TASK
651         /*
652          * For reasons of header soup (see current_thread_info()), this
653          * must be the first element of task_struct.
654          */
655         struct thread_info              thread_info;
656 #endif
657         /* -1 unrunnable, 0 runnable, >0 stopped: */
658         volatile long                   state;
659
660         /*
661          * This begins the randomizable portion of task_struct. Only
662          * scheduling-critical items should be added above here.
663          */
664         randomized_struct_fields_start
665
666         void                            *stack;
667         refcount_t                      usage;
668         /* Per task flags (PF_*), defined further below: */
669         unsigned int                    flags;
670         unsigned int                    ptrace;
671
672 #ifdef CONFIG_SMP
673         int                             on_cpu;
674         struct __call_single_node       wake_entry;
675 #ifdef CONFIG_THREAD_INFO_IN_TASK
676         /* Current CPU: */
677         unsigned int                    cpu;
678 #endif
679         unsigned int                    wakee_flips;
680         unsigned long                   wakee_flip_decay_ts;
681         struct task_struct              *last_wakee;
682
683         /*
684          * recent_used_cpu is initially set as the last CPU used by a task
685          * that wakes affine another task. Waker/wakee relationships can
686          * push tasks around a CPU where each wakeup moves to the next one.
687          * Tracking a recently used CPU allows a quick search for a recently
688          * used CPU that may be idle.
689          */
690         int                             recent_used_cpu;
691         int                             wake_cpu;
692 #endif
693         int                             on_rq;
694
695         int                             prio;
696         int                             static_prio;
697         int                             normal_prio;
698         unsigned int                    rt_priority;
699
700         const struct sched_class        *sched_class;
701         struct sched_entity             se;
702         struct sched_rt_entity          rt;
703 #ifdef CONFIG_CGROUP_SCHED
704         struct task_group               *sched_task_group;
705 #endif
706         struct sched_dl_entity          dl;
707
708 #ifdef CONFIG_UCLAMP_TASK
709         /*
710          * Clamp values requested for a scheduling entity.
711          * Must be updated with task_rq_lock() held.
712          */
713         struct uclamp_se                uclamp_req[UCLAMP_CNT];
714         /*
715          * Effective clamp values used for a scheduling entity.
716          * Must be updated with task_rq_lock() held.
717          */
718         struct uclamp_se                uclamp[UCLAMP_CNT];
719 #endif
720
721 #ifdef CONFIG_PREEMPT_NOTIFIERS
722         /* List of struct preempt_notifier: */
723         struct hlist_head               preempt_notifiers;
724 #endif
725
726 #ifdef CONFIG_BLK_DEV_IO_TRACE
727         unsigned int                    btrace_seq;
728 #endif
729
730         unsigned int                    policy;
731         int                             nr_cpus_allowed;
732         const cpumask_t                 *cpus_ptr;
733         cpumask_t                       cpus_mask;
734         void                            *migration_pending;
735 #ifdef CONFIG_SMP
736         unsigned short                  migration_disabled;
737 #endif
738         unsigned short                  migration_flags;
739
740 #ifdef CONFIG_PREEMPT_RCU
741         int                             rcu_read_lock_nesting;
742         union rcu_special               rcu_read_unlock_special;
743         struct list_head                rcu_node_entry;
744         struct rcu_node                 *rcu_blocked_node;
745 #endif /* #ifdef CONFIG_PREEMPT_RCU */
746
747 #ifdef CONFIG_TASKS_RCU
748         unsigned long                   rcu_tasks_nvcsw;
749         u8                              rcu_tasks_holdout;
750         u8                              rcu_tasks_idx;
751         int                             rcu_tasks_idle_cpu;
752         struct list_head                rcu_tasks_holdout_list;
753 #endif /* #ifdef CONFIG_TASKS_RCU */
754
755 #ifdef CONFIG_TASKS_TRACE_RCU
756         int                             trc_reader_nesting;
757         int                             trc_ipi_to_cpu;
758         union rcu_special               trc_reader_special;
759         bool                            trc_reader_checked;
760         struct list_head                trc_holdout_list;
761 #endif /* #ifdef CONFIG_TASKS_TRACE_RCU */
762
763         struct sched_info               sched_info;
764
765         struct list_head                tasks;
766 #ifdef CONFIG_SMP
767         struct plist_node               pushable_tasks;
768         struct rb_node                  pushable_dl_tasks;
769 #endif
770
771         struct mm_struct                *mm;
772         struct mm_struct                *active_mm;
773
774         /* Per-thread vma caching: */
775         struct vmacache                 vmacache;
776
777 #ifdef SPLIT_RSS_COUNTING
778         struct task_rss_stat            rss_stat;
779 #endif
780         int                             exit_state;
781         int                             exit_code;
782         int                             exit_signal;
783         /* The signal sent when the parent dies: */
784         int                             pdeath_signal;
785         /* JOBCTL_*, siglock protected: */
786         unsigned long                   jobctl;
787
788         /* Used for emulating ABI behavior of previous Linux versions: */
789         unsigned int                    personality;
790
791         /* Scheduler bits, serialized by scheduler locks: */
792         unsigned                        sched_reset_on_fork:1;
793         unsigned                        sched_contributes_to_load:1;
794         unsigned                        sched_migrated:1;
795 #ifdef CONFIG_PSI
796         unsigned                        sched_psi_wake_requeue:1;
797 #endif
798
799         /* Force alignment to the next boundary: */
800         unsigned                        :0;
801
802         /* Unserialized, strictly 'current' */
803
804         /*
805          * This field must not be in the scheduler word above due to wakelist
806          * queueing no longer being serialized by p->on_cpu. However:
807          *
808          * p->XXX = X;                  ttwu()
809          * schedule()                     if (p->on_rq && ..) // false
810          *   smp_mb__after_spinlock();    if (smp_load_acquire(&p->on_cpu) && //true
811          *   deactivate_task()                ttwu_queue_wakelist())
812          *     p->on_rq = 0;                    p->sched_remote_wakeup = Y;
813          *
814          * guarantees all stores of 'current' are visible before
815          * ->sched_remote_wakeup gets used, so it can be in this word.
816          */
817         unsigned                        sched_remote_wakeup:1;
818
819         /* Bit to tell LSMs we're in execve(): */
820         unsigned                        in_execve:1;
821         unsigned                        in_iowait:1;
822 #ifndef TIF_RESTORE_SIGMASK
823         unsigned                        restore_sigmask:1;
824 #endif
825 #ifdef CONFIG_MEMCG
826         unsigned                        in_user_fault:1;
827 #endif
828 #ifdef CONFIG_COMPAT_BRK
829         unsigned                        brk_randomized:1;
830 #endif
831 #ifdef CONFIG_CGROUPS
832         /* disallow userland-initiated cgroup migration */
833         unsigned                        no_cgroup_migration:1;
834         /* task is frozen/stopped (used by the cgroup freezer) */
835         unsigned                        frozen:1;
836 #endif
837 #ifdef CONFIG_BLK_CGROUP
838         unsigned                        use_memdelay:1;
839 #endif
840 #ifdef CONFIG_PSI
841         /* Stalled due to lack of memory */
842         unsigned                        in_memstall:1;
843 #endif
844
845         unsigned long                   atomic_flags; /* Flags requiring atomic access. */
846
847         struct restart_block            restart_block;
848
849         pid_t                           pid;
850         pid_t                           tgid;
851
852 #ifdef CONFIG_STACKPROTECTOR
853         /* Canary value for the -fstack-protector GCC feature: */
854         unsigned long                   stack_canary;
855 #endif
856         /*
857          * Pointers to the (original) parent process, youngest child, younger sibling,
858          * older sibling, respectively.  (p->father can be replaced with
859          * p->real_parent->pid)
860          */
861
862         /* Real parent process: */
863         struct task_struct __rcu        *real_parent;
864
865         /* Recipient of SIGCHLD, wait4() reports: */
866         struct task_struct __rcu        *parent;
867
868         /*
869          * Children/sibling form the list of natural children:
870          */
871         struct list_head                children;
872         struct list_head                sibling;
873         struct task_struct              *group_leader;
874
875         /*
876          * 'ptraced' is the list of tasks this task is using ptrace() on.
877          *
878          * This includes both natural children and PTRACE_ATTACH targets.
879          * 'ptrace_entry' is this task's link on the p->parent->ptraced list.
880          */
881         struct list_head                ptraced;
882         struct list_head                ptrace_entry;
883
884         /* PID/PID hash table linkage. */
885         struct pid                      *thread_pid;
886         struct hlist_node               pid_links[PIDTYPE_MAX];
887         struct list_head                thread_group;
888         struct list_head                thread_node;
889
890         struct completion               *vfork_done;
891
892         /* CLONE_CHILD_SETTID: */
893         int __user                      *set_child_tid;
894
895         /* CLONE_CHILD_CLEARTID: */
896         int __user                      *clear_child_tid;
897
898         /* PF_IO_WORKER */
899         void                            *pf_io_worker;
900
901         u64                             utime;
902         u64                             stime;
903 #ifdef CONFIG_ARCH_HAS_SCALED_CPUTIME
904         u64                             utimescaled;
905         u64                             stimescaled;
906 #endif
907         u64                             gtime;
908         struct prev_cputime             prev_cputime;
909 #ifdef CONFIG_VIRT_CPU_ACCOUNTING_GEN
910         struct vtime                    vtime;
911 #endif
912
913 #ifdef CONFIG_NO_HZ_FULL
914         atomic_t                        tick_dep_mask;
915 #endif
916         /* Context switch counts: */
917         unsigned long                   nvcsw;
918         unsigned long                   nivcsw;
919
920         /* Monotonic time in nsecs: */
921         u64                             start_time;
922
923         /* Boot based time in nsecs: */
924         u64                             start_boottime;
925
926         /* MM fault and swap info: this can arguably be seen as either mm-specific or thread-specific: */
927         unsigned long                   min_flt;
928         unsigned long                   maj_flt;
929
930         /* Empty if CONFIG_POSIX_CPUTIMERS=n */
931         struct posix_cputimers          posix_cputimers;
932
933 #ifdef CONFIG_POSIX_CPU_TIMERS_TASK_WORK
934         struct posix_cputimers_work     posix_cputimers_work;
935 #endif
936
937         /* Process credentials: */
938
939         /* Tracer's credentials at attach: */
940         const struct cred __rcu         *ptracer_cred;
941
942         /* Objective and real subjective task credentials (COW): */
943         const struct cred __rcu         *real_cred;
944
945         /* Effective (overridable) subjective task credentials (COW): */
946         const struct cred __rcu         *cred;
947
948 #ifdef CONFIG_KEYS
949         /* Cached requested key. */
950         struct key                      *cached_requested_key;
951 #endif
952
953         /*
954          * executable name, excluding path.
955          *
956          * - normally initialized setup_new_exec()
957          * - access it with [gs]et_task_comm()
958          * - lock it with task_lock()
959          */
960         char                            comm[TASK_COMM_LEN];
961
962         struct nameidata                *nameidata;
963
964 #ifdef CONFIG_SYSVIPC
965         struct sysv_sem                 sysvsem;
966         struct sysv_shm                 sysvshm;
967 #endif
968 #ifdef CONFIG_DETECT_HUNG_TASK
969         unsigned long                   last_switch_count;
970         unsigned long                   last_switch_time;
971 #endif
972         /* Filesystem information: */
973         struct fs_struct                *fs;
974
975         /* Open file information: */
976         struct files_struct             *files;
977
978 #ifdef CONFIG_IO_URING
979         struct io_uring_task            *io_uring;
980 #endif
981
982         /* Namespaces: */
983         struct nsproxy                  *nsproxy;
984
985         /* Signal handlers: */
986         struct signal_struct            *signal;
987         struct sighand_struct __rcu             *sighand;
988         struct sigqueue                 *sigqueue_cache;
989         sigset_t                        blocked;
990         sigset_t                        real_blocked;
991         /* Restored if set_restore_sigmask() was used: */
992         sigset_t                        saved_sigmask;
993         struct sigpending               pending;
994         unsigned long                   sas_ss_sp;
995         size_t                          sas_ss_size;
996         unsigned int                    sas_ss_flags;
997
998         struct callback_head            *task_works;
999
1000 #ifdef CONFIG_AUDIT
1001 #ifdef CONFIG_AUDITSYSCALL
1002         struct audit_context            *audit_context;
1003 #endif
1004         kuid_t                          loginuid;
1005         unsigned int                    sessionid;
1006 #endif
1007         struct seccomp                  seccomp;
1008         struct syscall_user_dispatch    syscall_dispatch;
1009
1010         /* Thread group tracking: */
1011         u64                             parent_exec_id;
1012         u64                             self_exec_id;
1013
1014         /* Protection against (de-)allocation: mm, files, fs, tty, keyrings, mems_allowed, mempolicy: */
1015         spinlock_t                      alloc_lock;
1016
1017         /* Protection of the PI data structures: */
1018         raw_spinlock_t                  pi_lock;
1019
1020         struct wake_q_node              wake_q;
1021
1022 #ifdef CONFIG_RT_MUTEXES
1023         /* PI waiters blocked on a rt_mutex held by this task: */
1024         struct rb_root_cached           pi_waiters;
1025         /* Updated under owner's pi_lock and rq lock */
1026         struct task_struct              *pi_top_task;
1027         /* Deadlock detection and priority inheritance handling: */
1028         struct rt_mutex_waiter          *pi_blocked_on;
1029 #endif
1030
1031 #ifdef CONFIG_DEBUG_MUTEXES
1032         /* Mutex deadlock detection: */
1033         struct mutex_waiter             *blocked_on;
1034 #endif
1035
1036 #ifdef CONFIG_DEBUG_ATOMIC_SLEEP
1037         int                             non_block_count;
1038 #endif
1039
1040 #ifdef CONFIG_TRACE_IRQFLAGS
1041         struct irqtrace_events          irqtrace;
1042         unsigned int                    hardirq_threaded;
1043         u64                             hardirq_chain_key;
1044         int                             softirqs_enabled;
1045         int                             softirq_context;
1046         int                             irq_config;
1047 #endif
1048 #ifdef CONFIG_PREEMPT_RT
1049         int                             softirq_disable_cnt;
1050 #endif
1051
1052 #ifdef CONFIG_LOCKDEP
1053 # define MAX_LOCK_DEPTH                 48UL
1054         u64                             curr_chain_key;
1055         int                             lockdep_depth;
1056         unsigned int                    lockdep_recursion;
1057         struct held_lock                held_locks[MAX_LOCK_DEPTH];
1058 #endif
1059
1060 #if defined(CONFIG_UBSAN) && !defined(CONFIG_UBSAN_TRAP)
1061         unsigned int                    in_ubsan;
1062 #endif
1063
1064         /* Journalling filesystem info: */
1065         void                            *journal_info;
1066
1067         /* Stacked block device info: */
1068         struct bio_list                 *bio_list;
1069
1070 #ifdef CONFIG_BLOCK
1071         /* Stack plugging: */
1072         struct blk_plug                 *plug;
1073 #endif
1074
1075         /* VM state: */
1076         struct reclaim_state            *reclaim_state;
1077
1078         struct backing_dev_info         *backing_dev_info;
1079
1080         struct io_context               *io_context;
1081
1082 #ifdef CONFIG_COMPACTION
1083         struct capture_control          *capture_control;
1084 #endif
1085         /* Ptrace state: */
1086         unsigned long                   ptrace_message;
1087         kernel_siginfo_t                *last_siginfo;
1088
1089         struct task_io_accounting       ioac;
1090 #ifdef CONFIG_PSI
1091         /* Pressure stall state */
1092         unsigned int                    psi_flags;
1093 #endif
1094 #ifdef CONFIG_TASK_XACCT
1095         /* Accumulated RSS usage: */
1096         u64                             acct_rss_mem1;
1097         /* Accumulated virtual memory usage: */
1098         u64                             acct_vm_mem1;
1099         /* stime + utime since last update: */
1100         u64                             acct_timexpd;
1101 #endif
1102 #ifdef CONFIG_CPUSETS
1103         /* Protected by ->alloc_lock: */
1104         nodemask_t                      mems_allowed;
1105         /* Sequence number to catch updates: */
1106         seqcount_spinlock_t             mems_allowed_seq;
1107         int                             cpuset_mem_spread_rotor;
1108         int                             cpuset_slab_spread_rotor;
1109 #endif
1110 #ifdef CONFIG_CGROUPS
1111         /* Control Group info protected by css_set_lock: */
1112         struct css_set __rcu            *cgroups;
1113         /* cg_list protected by css_set_lock and tsk->alloc_lock: */
1114         struct list_head                cg_list;
1115 #endif
1116 #ifdef CONFIG_X86_CPU_RESCTRL
1117         u32                             closid;
1118         u32                             rmid;
1119 #endif
1120 #ifdef CONFIG_FUTEX
1121         struct robust_list_head __user  *robust_list;
1122 #ifdef CONFIG_COMPAT
1123         struct compat_robust_list_head __user *compat_robust_list;
1124 #endif
1125         struct list_head                pi_state_list;
1126         struct futex_pi_state           *pi_state_cache;
1127         struct mutex                    futex_exit_mutex;
1128         unsigned int                    futex_state;
1129 #endif
1130 #ifdef CONFIG_PERF_EVENTS
1131         struct perf_event_context       *perf_event_ctxp[perf_nr_task_contexts];
1132         struct mutex                    perf_event_mutex;
1133         struct list_head                perf_event_list;
1134 #endif
1135 #ifdef CONFIG_DEBUG_PREEMPT
1136         unsigned long                   preempt_disable_ip;
1137 #endif
1138 #ifdef CONFIG_NUMA
1139         /* Protected by alloc_lock: */
1140         struct mempolicy                *mempolicy;
1141         short                           il_prev;
1142         short                           pref_node_fork;
1143 #endif
1144 #ifdef CONFIG_NUMA_BALANCING
1145         int                             numa_scan_seq;
1146         unsigned int                    numa_scan_period;
1147         unsigned int                    numa_scan_period_max;
1148         int                             numa_preferred_nid;
1149         unsigned long                   numa_migrate_retry;
1150         /* Migration stamp: */
1151         u64                             node_stamp;
1152         u64                             last_task_numa_placement;
1153         u64                             last_sum_exec_runtime;
1154         struct callback_head            numa_work;
1155
1156         /*
1157          * This pointer is only modified for current in syscall and
1158          * pagefault context (and for tasks being destroyed), so it can be read
1159          * from any of the following contexts:
1160          *  - RCU read-side critical section
1161          *  - current->numa_group from everywhere
1162          *  - task's runqueue locked, task not running
1163          */
1164         struct numa_group __rcu         *numa_group;
1165
1166         /*
1167          * numa_faults is an array split into four regions:
1168          * faults_memory, faults_cpu, faults_memory_buffer, faults_cpu_buffer
1169          * in this precise order.
1170          *
1171          * faults_memory: Exponential decaying average of faults on a per-node
1172          * basis. Scheduling placement decisions are made based on these
1173          * counts. The values remain static for the duration of a PTE scan.
1174          * faults_cpu: Track the nodes the process was running on when a NUMA
1175          * hinting fault was incurred.
1176          * faults_memory_buffer and faults_cpu_buffer: Record faults per node
1177          * during the current scan window. When the scan completes, the counts
1178          * in faults_memory and faults_cpu decay and these values are copied.
1179          */
1180         unsigned long                   *numa_faults;
1181         unsigned long                   total_numa_faults;
1182
1183         /*
1184          * numa_faults_locality tracks if faults recorded during the last
1185          * scan window were remote/local or failed to migrate. The task scan
1186          * period is adapted based on the locality of the faults with different
1187          * weights depending on whether they were shared or private faults
1188          */
1189         unsigned long                   numa_faults_locality[3];
1190
1191         unsigned long                   numa_pages_migrated;
1192 #endif /* CONFIG_NUMA_BALANCING */
1193
1194 #ifdef CONFIG_RSEQ
1195         struct rseq __user *rseq;
1196         u32 rseq_sig;
1197         /*
1198          * RmW on rseq_event_mask must be performed atomically
1199          * with respect to preemption.
1200          */
1201         unsigned long rseq_event_mask;
1202 #endif
1203
1204         struct tlbflush_unmap_batch     tlb_ubc;
1205
1206         union {
1207                 refcount_t              rcu_users;
1208                 struct rcu_head         rcu;
1209         };
1210
1211         /* Cache last used pipe for splice(): */
1212         struct pipe_inode_info          *splice_pipe;
1213
1214         struct page_frag                task_frag;
1215
1216 #ifdef CONFIG_TASK_DELAY_ACCT
1217         struct task_delay_info          *delays;
1218 #endif
1219
1220 #ifdef CONFIG_FAULT_INJECTION
1221         int                             make_it_fail;
1222         unsigned int                    fail_nth;
1223 #endif
1224         /*
1225          * When (nr_dirtied >= nr_dirtied_pause), it's time to call
1226          * balance_dirty_pages() for a dirty throttling pause:
1227          */
1228         int                             nr_dirtied;
1229         int                             nr_dirtied_pause;
1230         /* Start of a write-and-pause period: */
1231         unsigned long                   dirty_paused_when;
1232
1233 #ifdef CONFIG_LATENCYTOP
1234         int                             latency_record_count;
1235         struct latency_record           latency_record[LT_SAVECOUNT];
1236 #endif
1237         /*
1238          * Time slack values; these are used to round up poll() and
1239          * select() etc timeout values. These are in nanoseconds.
1240          */
1241         u64                             timer_slack_ns;
1242         u64                             default_timer_slack_ns;
1243
1244 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
1245         unsigned int                    kasan_depth;
1246 #endif
1247
1248 #ifdef CONFIG_KCSAN
1249         struct kcsan_ctx                kcsan_ctx;
1250 #ifdef CONFIG_TRACE_IRQFLAGS
1251         struct irqtrace_events          kcsan_save_irqtrace;
1252 #endif
1253 #endif
1254
1255 #if IS_ENABLED(CONFIG_KUNIT)
1256         struct kunit                    *kunit_test;
1257 #endif
1258
1259 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1260         /* Index of current stored address in ret_stack: */
1261         int                             curr_ret_stack;
1262         int                             curr_ret_depth;
1263
1264         /* Stack of return addresses for return function tracing: */
1265         struct ftrace_ret_stack         *ret_stack;
1266
1267         /* Timestamp for last schedule: */
1268         unsigned long long              ftrace_timestamp;
1269
1270         /*
1271          * Number of functions that haven't been traced
1272          * because of depth overrun:
1273          */
1274         atomic_t                        trace_overrun;
1275
1276         /* Pause tracing: */
1277         atomic_t                        tracing_graph_pause;
1278 #endif
1279
1280 #ifdef CONFIG_TRACING
1281         /* State flags for use by tracers: */
1282         unsigned long                   trace;
1283
1284         /* Bitmask and counter of trace recursion: */
1285         unsigned long                   trace_recursion;
1286 #endif /* CONFIG_TRACING */
1287
1288 #ifdef CONFIG_KCOV
1289         /* See kernel/kcov.c for more details. */
1290
1291         /* Coverage collection mode enabled for this task (0 if disabled): */
1292         unsigned int                    kcov_mode;
1293
1294         /* Size of the kcov_area: */
1295         unsigned int                    kcov_size;
1296
1297         /* Buffer for coverage collection: */
1298         void                            *kcov_area;
1299
1300         /* KCOV descriptor wired with this task or NULL: */
1301         struct kcov                     *kcov;
1302
1303         /* KCOV common handle for remote coverage collection: */
1304         u64                             kcov_handle;
1305
1306         /* KCOV sequence number: */
1307         int                             kcov_sequence;
1308
1309         /* Collect coverage from softirq context: */
1310         unsigned int                    kcov_softirq;
1311 #endif
1312
1313 #ifdef CONFIG_MEMCG
1314         struct mem_cgroup               *memcg_in_oom;
1315         gfp_t                           memcg_oom_gfp_mask;
1316         int                             memcg_oom_order;
1317
1318         /* Number of pages to reclaim on returning to userland: */
1319         unsigned int                    memcg_nr_pages_over_high;
1320
1321         /* Used by memcontrol for targeted memcg charge: */
1322         struct mem_cgroup               *active_memcg;
1323 #endif
1324
1325 #ifdef CONFIG_BLK_CGROUP
1326         struct request_queue            *throttle_queue;
1327 #endif
1328
1329 #ifdef CONFIG_UPROBES
1330         struct uprobe_task              *utask;
1331 #endif
1332 #if defined(CONFIG_BCACHE) || defined(CONFIG_BCACHE_MODULE)
1333         unsigned int                    sequential_io;
1334         unsigned int                    sequential_io_avg;
1335 #endif
1336         struct kmap_ctrl                kmap_ctrl;
1337 #ifdef CONFIG_DEBUG_ATOMIC_SLEEP
1338         unsigned long                   task_state_change;
1339 #endif
1340         int                             pagefault_disabled;
1341 #ifdef CONFIG_MMU
1342         struct task_struct              *oom_reaper_list;
1343 #endif
1344 #ifdef CONFIG_VMAP_STACK
1345         struct vm_struct                *stack_vm_area;
1346 #endif
1347 #ifdef CONFIG_THREAD_INFO_IN_TASK
1348         /* A live task holds one reference: */
1349         refcount_t                      stack_refcount;
1350 #endif
1351 #ifdef CONFIG_LIVEPATCH
1352         int patch_state;
1353 #endif
1354 #ifdef CONFIG_SECURITY
1355         /* Used by LSM modules for access restriction: */
1356         void                            *security;
1357 #endif
1358 #ifdef CONFIG_BPF_SYSCALL
1359         /* Used by BPF task local storage */
1360         struct bpf_local_storage __rcu  *bpf_storage;
1361 #endif
1362
1363 #ifdef CONFIG_GCC_PLUGIN_STACKLEAK
1364         unsigned long                   lowest_stack;
1365         unsigned long                   prev_lowest_stack;
1366 #endif
1367
1368 #ifdef CONFIG_X86_MCE
1369         void __user                     *mce_vaddr;
1370         __u64                           mce_kflags;
1371         u64                             mce_addr;
1372         __u64                           mce_ripv : 1,
1373                                         mce_whole_page : 1,
1374                                         __mce_reserved : 62;
1375         struct callback_head            mce_kill_me;
1376 #endif
1377
1378 #ifdef CONFIG_KRETPROBES
1379         struct llist_head               kretprobe_instances;
1380 #endif
1381
1382         /*
1383          * New fields for task_struct should be added above here, so that
1384          * they are included in the randomized portion of task_struct.
1385          */
1386         randomized_struct_fields_end
1387
1388         /* CPU-specific state of this task: */
1389         struct thread_struct            thread;
1390
1391         /*
1392          * WARNING: on x86, 'thread_struct' contains a variable-sized
1393          * structure.  It *MUST* be at the end of 'task_struct'.
1394          *
1395          * Do not put anything below here!
1396          */
1397 };
1398
1399 static inline struct pid *task_pid(struct task_struct *task)
1400 {
1401         return task->thread_pid;
1402 }
1403
1404 /*
1405  * the helpers to get the task's different pids as they are seen
1406  * from various namespaces
1407  *
1408  * task_xid_nr()     : global id, i.e. the id seen from the init namespace;
1409  * task_xid_vnr()    : virtual id, i.e. the id seen from the pid namespace of
1410  *                     current.
1411  * task_xid_nr_ns()  : id seen from the ns specified;
1412  *
1413  * see also pid_nr() etc in include/linux/pid.h
1414  */
1415 pid_t __task_pid_nr_ns(struct task_struct *task, enum pid_type type, struct pid_namespace *ns);
1416
1417 static inline pid_t task_pid_nr(struct task_struct *tsk)
1418 {
1419         return tsk->pid;
1420 }
1421
1422 static inline pid_t task_pid_nr_ns(struct task_struct *tsk, struct pid_namespace *ns)
1423 {
1424         return __task_pid_nr_ns(tsk, PIDTYPE_PID, ns);
1425 }
1426
1427 static inline pid_t task_pid_vnr(struct task_struct *tsk)
1428 {
1429         return __task_pid_nr_ns(tsk, PIDTYPE_PID, NULL);
1430 }
1431
1432
1433 static inline pid_t task_tgid_nr(struct task_struct *tsk)
1434 {
1435         return tsk->tgid;
1436 }
1437
1438 /**
1439  * pid_alive - check that a task structure is not stale
1440  * @p: Task structure to be checked.
1441  *
1442  * Test if a process is not yet dead (at most zombie state)
1443  * If pid_alive fails, then pointers within the task structure
1444  * can be stale and must not be dereferenced.
1445  *
1446  * Return: 1 if the process is alive. 0 otherwise.
1447  */
1448 static inline int pid_alive(const struct task_struct *p)
1449 {
1450         return p->thread_pid != NULL;
1451 }
1452
1453 static inline pid_t task_pgrp_nr_ns(struct task_struct *tsk, struct pid_namespace *ns)
1454 {
1455         return __task_pid_nr_ns(tsk, PIDTYPE_PGID, ns);
1456 }
1457
1458 static inline pid_t task_pgrp_vnr(struct task_struct *tsk)
1459 {
1460         return __task_pid_nr_ns(tsk, PIDTYPE_PGID, NULL);
1461 }
1462
1463
1464 static inline pid_t task_session_nr_ns(struct task_struct *tsk, struct pid_namespace *ns)
1465 {
1466         return __task_pid_nr_ns(tsk, PIDTYPE_SID, ns);
1467 }
1468
1469 static inline pid_t task_session_vnr(struct task_struct *tsk)
1470 {
1471         return __task_pid_nr_ns(tsk, PIDTYPE_SID, NULL);
1472 }
1473
1474 static inline pid_t task_tgid_nr_ns(struct task_struct *tsk, struct pid_namespace *ns)
1475 {
1476         return __task_pid_nr_ns(tsk, PIDTYPE_TGID, ns);
1477 }
1478
1479 static inline pid_t task_tgid_vnr(struct task_struct *tsk)
1480 {
1481         return __task_pid_nr_ns(tsk, PIDTYPE_TGID, NULL);
1482 }
1483
1484 static inline pid_t task_ppid_nr_ns(const struct task_struct *tsk, struct pid_namespace *ns)
1485 {
1486         pid_t pid = 0;
1487
1488         rcu_read_lock();
1489         if (pid_alive(tsk))
1490                 pid = task_tgid_nr_ns(rcu_dereference(tsk->real_parent), ns);
1491         rcu_read_unlock();
1492
1493         return pid;
1494 }
1495
1496 static inline pid_t task_ppid_nr(const struct task_struct *tsk)
1497 {
1498         return task_ppid_nr_ns(tsk, &init_pid_ns);
1499 }
1500
1501 /* Obsolete, do not use: */
1502 static inline pid_t task_pgrp_nr(struct task_struct *tsk)
1503 {
1504         return task_pgrp_nr_ns(tsk, &init_pid_ns);
1505 }
1506
1507 #define TASK_REPORT_IDLE        (TASK_REPORT + 1)
1508 #define TASK_REPORT_MAX         (TASK_REPORT_IDLE << 1)
1509
1510 static inline unsigned int task_state_index(struct task_struct *tsk)
1511 {
1512         unsigned int tsk_state = READ_ONCE(tsk->state);
1513         unsigned int state = (tsk_state | tsk->exit_state) & TASK_REPORT;
1514
1515         BUILD_BUG_ON_NOT_POWER_OF_2(TASK_REPORT_MAX);
1516
1517         if (tsk_state == TASK_IDLE)
1518                 state = TASK_REPORT_IDLE;
1519
1520         return fls(state);
1521 }
1522
1523 static inline char task_index_to_char(unsigned int state)
1524 {
1525         static const char state_char[] = "RSDTtXZPI";
1526
1527         BUILD_BUG_ON(1 + ilog2(TASK_REPORT_MAX) != sizeof(state_char) - 1);
1528
1529         return state_char[state];
1530 }
1531
1532 static inline char task_state_to_char(struct task_struct *tsk)
1533 {
1534         return task_index_to_char(task_state_index(tsk));
1535 }
1536
1537 /**
1538  * is_global_init - check if a task structure is init. Since init
1539  * is free to have sub-threads we need to check tgid.
1540  * @tsk: Task structure to be checked.
1541  *
1542  * Check if a task structure is the first user space task the kernel created.
1543  *
1544  * Return: 1 if the task structure is init. 0 otherwise.
1545  */
1546 static inline int is_global_init(struct task_struct *tsk)
1547 {
1548         return task_tgid_nr(tsk) == 1;
1549 }
1550
1551 extern struct pid *cad_pid;
1552
1553 /*
1554  * Per process flags
1555  */
1556 #define PF_VCPU                 0x00000001      /* I'm a virtual CPU */
1557 #define PF_IDLE                 0x00000002      /* I am an IDLE thread */
1558 #define PF_EXITING              0x00000004      /* Getting shut down */
1559 #define PF_IO_WORKER            0x00000010      /* Task is an IO worker */
1560 #define PF_WQ_WORKER            0x00000020      /* I'm a workqueue worker */
1561 #define PF_FORKNOEXEC           0x00000040      /* Forked but didn't exec */
1562 #define PF_MCE_PROCESS          0x00000080      /* Process policy on mce errors */
1563 #define PF_SUPERPRIV            0x00000100      /* Used super-user privileges */
1564 #define PF_DUMPCORE             0x00000200      /* Dumped core */
1565 #define PF_SIGNALED             0x00000400      /* Killed by a signal */
1566 #define PF_MEMALLOC             0x00000800      /* Allocating memory */
1567 #define PF_NPROC_EXCEEDED       0x00001000      /* set_user() noticed that RLIMIT_NPROC was exceeded */
1568 #define PF_USED_MATH            0x00002000      /* If unset the fpu must be initialized before use */
1569 #define PF_USED_ASYNC           0x00004000      /* Used async_schedule*(), used by module init */
1570 #define PF_NOFREEZE             0x00008000      /* This thread should not be frozen */
1571 #define PF_FROZEN               0x00010000      /* Frozen for system suspend */
1572 #define PF_KSWAPD               0x00020000      /* I am kswapd */
1573 #define PF_MEMALLOC_NOFS        0x00040000      /* All allocation requests will inherit GFP_NOFS */
1574 #define PF_MEMALLOC_NOIO        0x00080000      /* All allocation requests will inherit GFP_NOIO */
1575 #define PF_LOCAL_THROTTLE       0x00100000      /* Throttle writes only against the bdi I write to,
1576                                                  * I am cleaning dirty pages from some other bdi. */
1577 #define PF_KTHREAD              0x00200000      /* I am a kernel thread */
1578 #define PF_RANDOMIZE            0x00400000      /* Randomize virtual address space */
1579 #define PF_SWAPWRITE            0x00800000      /* Allowed to write to swap */
1580 #define PF_NO_SETAFFINITY       0x04000000      /* Userland is not allowed to meddle with cpus_mask */
1581 #define PF_MCE_EARLY            0x08000000      /* Early kill for mce process policy */
1582 #define PF_MEMALLOC_NOCMA       0x10000000      /* All allocation request will have _GFP_MOVABLE cleared */
1583 #define PF_FREEZER_SKIP         0x40000000      /* Freezer should not count it as freezable */
1584 #define PF_SUSPEND_TASK         0x80000000      /* This thread called freeze_processes() and should not be frozen */
1585
1586 /*
1587  * Only the _current_ task can read/write to tsk->flags, but other
1588  * tasks can access tsk->flags in readonly mode for example
1589  * with tsk_used_math (like during threaded core dumping).
1590  * There is however an exception to this rule during ptrace
1591  * or during fork: the ptracer task is allowed to write to the
1592  * child->flags of its traced child (same goes for fork, the parent
1593  * can write to the child->flags), because we're guaranteed the
1594  * child is not running and in turn not changing child->flags
1595  * at the same time the parent does it.
1596  */
1597 #define clear_stopped_child_used_math(child)    do { (child)->flags &= ~PF_USED_MATH; } while (0)
1598 #define set_stopped_child_used_math(child)      do { (child)->flags |= PF_USED_MATH; } while (0)
1599 #define clear_used_math()                       clear_stopped_child_used_math(current)
1600 #define set_used_math()                         set_stopped_child_used_math(current)
1601
1602 #define conditional_stopped_child_used_math(condition, child) \
1603         do { (child)->flags &= ~PF_USED_MATH, (child)->flags |= (condition) ? PF_USED_MATH : 0; } while (0)
1604
1605 #define conditional_used_math(condition)        conditional_stopped_child_used_math(condition, current)
1606
1607 #define copy_to_stopped_child_used_math(child) \
1608         do { (child)->flags &= ~PF_USED_MATH, (child)->flags |= current->flags & PF_USED_MATH; } while (0)
1609
1610 /* NOTE: this will return 0 or PF_USED_MATH, it will never return 1 */
1611 #define tsk_used_math(p)                        ((p)->flags & PF_USED_MATH)
1612 #define used_math()                             tsk_used_math(current)
1613
1614 static inline bool is_percpu_thread(void)
1615 {
1616 #ifdef CONFIG_SMP
1617         return (current->flags & PF_NO_SETAFFINITY) &&
1618                 (current->nr_cpus_allowed  == 1);
1619 #else
1620         return true;
1621 #endif
1622 }
1623
1624 /* Per-process atomic flags. */
1625 #define PFA_NO_NEW_PRIVS                0       /* May not gain new privileges. */
1626 #define PFA_SPREAD_PAGE                 1       /* Spread page cache over cpuset */
1627 #define PFA_SPREAD_SLAB                 2       /* Spread some slab caches over cpuset */
1628 #define PFA_SPEC_SSB_DISABLE            3       /* Speculative Store Bypass disabled */
1629 #define PFA_SPEC_SSB_FORCE_DISABLE      4       /* Speculative Store Bypass force disabled*/
1630 #define PFA_SPEC_IB_DISABLE             5       /* Indirect branch speculation restricted */
1631 #define PFA_SPEC_IB_FORCE_DISABLE       6       /* Indirect branch speculation permanently restricted */
1632 #define PFA_SPEC_SSB_NOEXEC             7       /* Speculative Store Bypass clear on execve() */
1633
1634 #define TASK_PFA_TEST(name, func)                                       \
1635         static inline bool task_##func(struct task_struct *p)           \
1636         { return test_bit(PFA_##name, &p->atomic_flags); }
1637
1638 #define TASK_PFA_SET(name, func)                                        \
1639         static inline void task_set_##func(struct task_struct *p)       \
1640         { set_bit(PFA_##name, &p->atomic_flags); }
1641
1642 #define TASK_PFA_CLEAR(name, func)                                      \
1643         static inline void task_clear_##func(struct task_struct *p)     \
1644         { clear_bit(PFA_##name, &p->atomic_flags); }
1645
1646 TASK_PFA_TEST(NO_NEW_PRIVS, no_new_privs)
1647 TASK_PFA_SET(NO_NEW_PRIVS, no_new_privs)
1648
1649 TASK_PFA_TEST(SPREAD_PAGE, spread_page)
1650 TASK_PFA_SET(SPREAD_PAGE, spread_page)
1651 TASK_PFA_CLEAR(SPREAD_PAGE, spread_page)
1652
1653 TASK_PFA_TEST(SPREAD_SLAB, spread_slab)
1654 TASK_PFA_SET(SPREAD_SLAB, spread_slab)
1655 TASK_PFA_CLEAR(SPREAD_SLAB, spread_slab)
1656
1657 TASK_PFA_TEST(SPEC_SSB_DISABLE, spec_ssb_disable)
1658 TASK_PFA_SET(SPEC_SSB_DISABLE, spec_ssb_disable)
1659 TASK_PFA_CLEAR(SPEC_SSB_DISABLE, spec_ssb_disable)
1660
1661 TASK_PFA_TEST(SPEC_SSB_NOEXEC, spec_ssb_noexec)
1662 TASK_PFA_SET(SPEC_SSB_NOEXEC, spec_ssb_noexec)
1663 TASK_PFA_CLEAR(SPEC_SSB_NOEXEC, spec_ssb_noexec)
1664
1665 TASK_PFA_TEST(SPEC_SSB_FORCE_DISABLE, spec_ssb_force_disable)
1666 TASK_PFA_SET(SPEC_SSB_FORCE_DISABLE, spec_ssb_force_disable)
1667
1668 TASK_PFA_TEST(SPEC_IB_DISABLE, spec_ib_disable)
1669 TASK_PFA_SET(SPEC_IB_DISABLE, spec_ib_disable)
1670 TASK_PFA_CLEAR(SPEC_IB_DISABLE, spec_ib_disable)
1671
1672 TASK_PFA_TEST(SPEC_IB_FORCE_DISABLE, spec_ib_force_disable)
1673 TASK_PFA_SET(SPEC_IB_FORCE_DISABLE, spec_ib_force_disable)
1674
1675 static inline void
1676 current_restore_flags(unsigned long orig_flags, unsigned long flags)
1677 {
1678         current->flags &= ~flags;
1679         current->flags |= orig_flags & flags;
1680 }
1681
1682 extern int cpuset_cpumask_can_shrink(const struct cpumask *cur, const struct cpumask *trial);
1683 extern int task_can_attach(struct task_struct *p, const struct cpumask *cs_cpus_allowed);
1684 #ifdef CONFIG_SMP
1685 extern void do_set_cpus_allowed(struct task_struct *p, const struct cpumask *new_mask);
1686 extern int set_cpus_allowed_ptr(struct task_struct *p, const struct cpumask *new_mask);
1687 #else
1688 static inline void do_set_cpus_allowed(struct task_struct *p, const struct cpumask *new_mask)
1689 {
1690 }
1691 static inline int set_cpus_allowed_ptr(struct task_struct *p, const struct cpumask *new_mask)
1692 {
1693         if (!cpumask_test_cpu(0, new_mask))
1694                 return -EINVAL;
1695         return 0;
1696 }
1697 #endif
1698
1699 extern int yield_to(struct task_struct *p, bool preempt);
1700 extern void set_user_nice(struct task_struct *p, long nice);
1701 extern int task_prio(const struct task_struct *p);
1702
1703 /**
1704  * task_nice - return the nice value of a given task.
1705  * @p: the task in question.
1706  *
1707  * Return: The nice value [ -20 ... 0 ... 19 ].
1708  */
1709 static inline int task_nice(const struct task_struct *p)
1710 {
1711         return PRIO_TO_NICE((p)->static_prio);
1712 }
1713
1714 extern int can_nice(const struct task_struct *p, const int nice);
1715 extern int task_curr(const struct task_struct *p);
1716 extern int idle_cpu(int cpu);
1717 extern int available_idle_cpu(int cpu);
1718 extern int sched_setscheduler(struct task_struct *, int, const struct sched_param *);
1719 extern int sched_setscheduler_nocheck(struct task_struct *, int, const struct sched_param *);
1720 extern void sched_set_fifo(struct task_struct *p);
1721 extern void sched_set_fifo_low(struct task_struct *p);
1722 extern void sched_set_normal(struct task_struct *p, int nice);
1723 extern int sched_setattr(struct task_struct *, const struct sched_attr *);
1724 extern int sched_setattr_nocheck(struct task_struct *, const struct sched_attr *);
1725 extern struct task_struct *idle_task(int cpu);
1726
1727 /**
1728  * is_idle_task - is the specified task an idle task?
1729  * @p: the task in question.
1730  *
1731  * Return: 1 if @p is an idle task. 0 otherwise.
1732  */
1733 static __always_inline bool is_idle_task(const struct task_struct *p)
1734 {
1735         return !!(p->flags & PF_IDLE);
1736 }
1737
1738 extern struct task_struct *curr_task(int cpu);
1739 extern void ia64_set_curr_task(int cpu, struct task_struct *p);
1740
1741 void yield(void);
1742
1743 union thread_union {
1744 #ifndef CONFIG_ARCH_TASK_STRUCT_ON_STACK
1745         struct task_struct task;
1746 #endif
1747 #ifndef CONFIG_THREAD_INFO_IN_TASK
1748         struct thread_info thread_info;
1749 #endif
1750         unsigned long stack[THREAD_SIZE/sizeof(long)];
1751 };
1752
1753 #ifndef CONFIG_THREAD_INFO_IN_TASK
1754 extern struct thread_info init_thread_info;
1755 #endif
1756
1757 extern unsigned long init_stack[THREAD_SIZE / sizeof(unsigned long)];
1758
1759 #ifdef CONFIG_THREAD_INFO_IN_TASK
1760 static inline struct thread_info *task_thread_info(struct task_struct *task)
1761 {
1762         return &task->thread_info;
1763 }
1764 #elif !defined(__HAVE_THREAD_FUNCTIONS)
1765 # define task_thread_info(task) ((struct thread_info *)(task)->stack)
1766 #endif
1767
1768 /*
1769  * find a task by one of its numerical ids
1770  *
1771  * find_task_by_pid_ns():
1772  *      finds a task by its pid in the specified namespace
1773  * find_task_by_vpid():
1774  *      finds a task by its virtual pid
1775  *
1776  * see also find_vpid() etc in include/linux/pid.h
1777  */
1778
1779 extern struct task_struct *find_task_by_vpid(pid_t nr);
1780 extern struct task_struct *find_task_by_pid_ns(pid_t nr, struct pid_namespace *ns);
1781
1782 /*
1783  * find a task by its virtual pid and get the task struct
1784  */
1785 extern struct task_struct *find_get_task_by_vpid(pid_t nr);
1786
1787 extern int wake_up_state(struct task_struct *tsk, unsigned int state);
1788 extern int wake_up_process(struct task_struct *tsk);
1789 extern void wake_up_new_task(struct task_struct *tsk);
1790
1791 #ifdef CONFIG_SMP
1792 extern void kick_process(struct task_struct *tsk);
1793 #else
1794 static inline void kick_process(struct task_struct *tsk) { }
1795 #endif
1796
1797 extern void __set_task_comm(struct task_struct *tsk, const char *from, bool exec);
1798
1799 static inline void set_task_comm(struct task_struct *tsk, const char *from)
1800 {
1801         __set_task_comm(tsk, from, false);
1802 }
1803
1804 extern char *__get_task_comm(char *to, size_t len, struct task_struct *tsk);
1805 #define get_task_comm(buf, tsk) ({                      \
1806         BUILD_BUG_ON(sizeof(buf) != TASK_COMM_LEN);     \
1807         __get_task_comm(buf, sizeof(buf), tsk);         \
1808 })
1809
1810 #ifdef CONFIG_SMP
1811 static __always_inline void scheduler_ipi(void)
1812 {
1813         /*
1814          * Fold TIF_NEED_RESCHED into the preempt_count; anybody setting
1815          * TIF_NEED_RESCHED remotely (for the first time) will also send
1816          * this IPI.
1817          */
1818         preempt_fold_need_resched();
1819 }
1820 extern unsigned long wait_task_inactive(struct task_struct *, long match_state);
1821 #else
1822 static inline void scheduler_ipi(void) { }
1823 static inline unsigned long wait_task_inactive(struct task_struct *p, long match_state)
1824 {
1825         return 1;
1826 }
1827 #endif
1828
1829 /*
1830  * Set thread flags in other task's structures.
1831  * See asm/thread_info.h for TIF_xxxx flags available:
1832  */
1833 static inline void set_tsk_thread_flag(struct task_struct *tsk, int flag)
1834 {
1835         set_ti_thread_flag(task_thread_info(tsk), flag);
1836 }
1837
1838 static inline void clear_tsk_thread_flag(struct task_struct *tsk, int flag)
1839 {
1840         clear_ti_thread_flag(task_thread_info(tsk), flag);
1841 }
1842
1843 static inline void update_tsk_thread_flag(struct task_struct *tsk, int flag,
1844                                           bool value)
1845 {
1846         update_ti_thread_flag(task_thread_info(tsk), flag, value);
1847 }
1848
1849 static inline int test_and_set_tsk_thread_flag(struct task_struct *tsk, int flag)
1850 {
1851         return test_and_set_ti_thread_flag(task_thread_info(tsk), flag);
1852 }
1853
1854 static inline int test_and_clear_tsk_thread_flag(struct task_struct *tsk, int flag)
1855 {
1856         return test_and_clear_ti_thread_flag(task_thread_info(tsk), flag);
1857 }
1858
1859 static inline int test_tsk_thread_flag(struct task_struct *tsk, int flag)
1860 {
1861         return test_ti_thread_flag(task_thread_info(tsk), flag);
1862 }
1863
1864 static inline void set_tsk_need_resched(struct task_struct *tsk)
1865 {
1866         set_tsk_thread_flag(tsk,TIF_NEED_RESCHED);
1867 }
1868
1869 static inline void clear_tsk_need_resched(struct task_struct *tsk)
1870 {
1871         clear_tsk_thread_flag(tsk,TIF_NEED_RESCHED);
1872 }
1873
1874 static inline int test_tsk_need_resched(struct task_struct *tsk)
1875 {
1876         return unlikely(test_tsk_thread_flag(tsk,TIF_NEED_RESCHED));
1877 }
1878
1879 /*
1880  * cond_resched() and cond_resched_lock(): latency reduction via
1881  * explicit rescheduling in places that are safe. The return
1882  * value indicates whether a reschedule was done in fact.
1883  * cond_resched_lock() will drop the spinlock before scheduling,
1884  */
1885 #if !defined(CONFIG_PREEMPTION) || defined(CONFIG_PREEMPT_DYNAMIC)
1886 extern int __cond_resched(void);
1887
1888 #ifdef CONFIG_PREEMPT_DYNAMIC
1889
1890 DECLARE_STATIC_CALL(cond_resched, __cond_resched);
1891
1892 static __always_inline int _cond_resched(void)
1893 {
1894         return static_call_mod(cond_resched)();
1895 }
1896
1897 #else
1898
1899 static inline int _cond_resched(void)
1900 {
1901         return __cond_resched();
1902 }
1903
1904 #endif /* CONFIG_PREEMPT_DYNAMIC */
1905
1906 #else
1907
1908 static inline int _cond_resched(void) { return 0; }
1909
1910 #endif /* !defined(CONFIG_PREEMPTION) || defined(CONFIG_PREEMPT_DYNAMIC) */
1911
1912 #define cond_resched() ({                       \
1913         ___might_sleep(__FILE__, __LINE__, 0);  \
1914         _cond_resched();                        \
1915 })
1916
1917 extern int __cond_resched_lock(spinlock_t *lock);
1918 extern int __cond_resched_rwlock_read(rwlock_t *lock);
1919 extern int __cond_resched_rwlock_write(rwlock_t *lock);
1920
1921 #define cond_resched_lock(lock) ({                              \
1922         ___might_sleep(__FILE__, __LINE__, PREEMPT_LOCK_OFFSET);\
1923         __cond_resched_lock(lock);                              \
1924 })
1925
1926 #define cond_resched_rwlock_read(lock) ({                       \
1927         __might_sleep(__FILE__, __LINE__, PREEMPT_LOCK_OFFSET); \
1928         __cond_resched_rwlock_read(lock);                       \
1929 })
1930
1931 #define cond_resched_rwlock_write(lock) ({                      \
1932         __might_sleep(__FILE__, __LINE__, PREEMPT_LOCK_OFFSET); \
1933         __cond_resched_rwlock_write(lock);                      \
1934 })
1935
1936 static inline void cond_resched_rcu(void)
1937 {
1938 #if defined(CONFIG_DEBUG_ATOMIC_SLEEP) || !defined(CONFIG_PREEMPT_RCU)
1939         rcu_read_unlock();
1940         cond_resched();
1941         rcu_read_lock();
1942 #endif
1943 }
1944
1945 /*
1946  * Does a critical section need to be broken due to another
1947  * task waiting?: (technically does not depend on CONFIG_PREEMPTION,
1948  * but a general need for low latency)
1949  */
1950 static inline int spin_needbreak(spinlock_t *lock)
1951 {
1952 #ifdef CONFIG_PREEMPTION
1953         return spin_is_contended(lock);
1954 #else
1955         return 0;
1956 #endif
1957 }
1958
1959 /*
1960  * Check if a rwlock is contended.
1961  * Returns non-zero if there is another task waiting on the rwlock.
1962  * Returns zero if the lock is not contended or the system / underlying
1963  * rwlock implementation does not support contention detection.
1964  * Technically does not depend on CONFIG_PREEMPTION, but a general need
1965  * for low latency.
1966  */
1967 static inline int rwlock_needbreak(rwlock_t *lock)
1968 {
1969 #ifdef CONFIG_PREEMPTION
1970         return rwlock_is_contended(lock);
1971 #else
1972         return 0;
1973 #endif
1974 }
1975
1976 static __always_inline bool need_resched(void)
1977 {
1978         return unlikely(tif_need_resched());
1979 }
1980
1981 /*
1982  * Wrappers for p->thread_info->cpu access. No-op on UP.
1983  */
1984 #ifdef CONFIG_SMP
1985
1986 static inline unsigned int task_cpu(const struct task_struct *p)
1987 {
1988 #ifdef CONFIG_THREAD_INFO_IN_TASK
1989         return READ_ONCE(p->cpu);
1990 #else
1991         return READ_ONCE(task_thread_info(p)->cpu);
1992 #endif
1993 }
1994
1995 extern void set_task_cpu(struct task_struct *p, unsigned int cpu);
1996
1997 #else
1998
1999 static inline unsigned int task_cpu(const struct task_struct *p)
2000 {
2001         return 0;
2002 }
2003
2004 static inline void set_task_cpu(struct task_struct *p, unsigned int cpu)
2005 {
2006 }
2007
2008 #endif /* CONFIG_SMP */
2009
2010 /*
2011  * In order to reduce various lock holder preemption latencies provide an
2012  * interface to see if a vCPU is currently running or not.
2013  *
2014  * This allows us to terminate optimistic spin loops and block, analogous to
2015  * the native optimistic spin heuristic of testing if the lock owner task is
2016  * running or not.
2017  */
2018 #ifndef vcpu_is_preempted
2019 static inline bool vcpu_is_preempted(int cpu)
2020 {
2021         return false;
2022 }
2023 #endif
2024
2025 extern long sched_setaffinity(pid_t pid, const struct cpumask *new_mask);
2026 extern long sched_getaffinity(pid_t pid, struct cpumask *mask);
2027
2028 #ifndef TASK_SIZE_OF
2029 #define TASK_SIZE_OF(tsk)       TASK_SIZE
2030 #endif
2031
2032 #ifdef CONFIG_SMP
2033 /* Returns effective CPU energy utilization, as seen by the scheduler */
2034 unsigned long sched_cpu_util(int cpu, unsigned long max);
2035 #endif /* CONFIG_SMP */
2036
2037 #ifdef CONFIG_RSEQ
2038
2039 /*
2040  * Map the event mask on the user-space ABI enum rseq_cs_flags
2041  * for direct mask checks.
2042  */
2043 enum rseq_event_mask_bits {
2044         RSEQ_EVENT_PREEMPT_BIT  = RSEQ_CS_FLAG_NO_RESTART_ON_PREEMPT_BIT,
2045         RSEQ_EVENT_SIGNAL_BIT   = RSEQ_CS_FLAG_NO_RESTART_ON_SIGNAL_BIT,
2046         RSEQ_EVENT_MIGRATE_BIT  = RSEQ_CS_FLAG_NO_RESTART_ON_MIGRATE_BIT,
2047 };
2048
2049 enum rseq_event_mask {
2050         RSEQ_EVENT_PREEMPT      = (1U << RSEQ_EVENT_PREEMPT_BIT),
2051         RSEQ_EVENT_SIGNAL       = (1U << RSEQ_EVENT_SIGNAL_BIT),
2052         RSEQ_EVENT_MIGRATE      = (1U << RSEQ_EVENT_MIGRATE_BIT),
2053 };
2054
2055 static inline void rseq_set_notify_resume(struct task_struct *t)
2056 {
2057         if (t->rseq)
2058                 set_tsk_thread_flag(t, TIF_NOTIFY_RESUME);
2059 }
2060
2061 void __rseq_handle_notify_resume(struct ksignal *sig, struct pt_regs *regs);
2062
2063 static inline void rseq_handle_notify_resume(struct ksignal *ksig,
2064                                              struct pt_regs *regs)
2065 {
2066         if (current->rseq)
2067                 __rseq_handle_notify_resume(ksig, regs);
2068 }
2069
2070 static inline void rseq_signal_deliver(struct ksignal *ksig,
2071                                        struct pt_regs *regs)
2072 {
2073         preempt_disable();
2074         __set_bit(RSEQ_EVENT_SIGNAL_BIT, &current->rseq_event_mask);
2075         preempt_enable();
2076         rseq_handle_notify_resume(ksig, regs);
2077 }
2078
2079 /* rseq_preempt() requires preemption to be disabled. */
2080 static inline void rseq_preempt(struct task_struct *t)
2081 {
2082         __set_bit(RSEQ_EVENT_PREEMPT_BIT, &t->rseq_event_mask);
2083         rseq_set_notify_resume(t);
2084 }
2085
2086 /* rseq_migrate() requires preemption to be disabled. */
2087 static inline void rseq_migrate(struct task_struct *t)
2088 {
2089         __set_bit(RSEQ_EVENT_MIGRATE_BIT, &t->rseq_event_mask);
2090         rseq_set_notify_resume(t);
2091 }
2092
2093 /*
2094  * If parent process has a registered restartable sequences area, the
2095  * child inherits. Unregister rseq for a clone with CLONE_VM set.
2096  */
2097 static inline void rseq_fork(struct task_struct *t, unsigned long clone_flags)
2098 {
2099         if (clone_flags & CLONE_VM) {
2100                 t->rseq = NULL;
2101                 t->rseq_sig = 0;
2102                 t->rseq_event_mask = 0;
2103         } else {
2104                 t->rseq = current->rseq;
2105                 t->rseq_sig = current->rseq_sig;
2106                 t->rseq_event_mask = current->rseq_event_mask;
2107         }
2108 }
2109
2110 static inline void rseq_execve(struct task_struct *t)
2111 {
2112         t->rseq = NULL;
2113         t->rseq_sig = 0;
2114         t->rseq_event_mask = 0;
2115 }
2116
2117 #else
2118
2119 static inline void rseq_set_notify_resume(struct task_struct *t)
2120 {
2121 }
2122 static inline void rseq_handle_notify_resume(struct ksignal *ksig,
2123                                              struct pt_regs *regs)
2124 {
2125 }
2126 static inline void rseq_signal_deliver(struct ksignal *ksig,
2127                                        struct pt_regs *regs)
2128 {
2129 }
2130 static inline void rseq_preempt(struct task_struct *t)
2131 {
2132 }
2133 static inline void rseq_migrate(struct task_struct *t)
2134 {
2135 }
2136 static inline void rseq_fork(struct task_struct *t, unsigned long clone_flags)
2137 {
2138 }
2139 static inline void rseq_execve(struct task_struct *t)
2140 {
2141 }
2142
2143 #endif
2144
2145 #ifdef CONFIG_DEBUG_RSEQ
2146
2147 void rseq_syscall(struct pt_regs *regs);
2148
2149 #else
2150
2151 static inline void rseq_syscall(struct pt_regs *regs)
2152 {
2153 }
2154
2155 #endif
2156
2157 const struct sched_avg *sched_trace_cfs_rq_avg(struct cfs_rq *cfs_rq);
2158 char *sched_trace_cfs_rq_path(struct cfs_rq *cfs_rq, char *str, int len);
2159 int sched_trace_cfs_rq_cpu(struct cfs_rq *cfs_rq);
2160
2161 const struct sched_avg *sched_trace_rq_avg_rt(struct rq *rq);
2162 const struct sched_avg *sched_trace_rq_avg_dl(struct rq *rq);
2163 const struct sched_avg *sched_trace_rq_avg_irq(struct rq *rq);
2164
2165 int sched_trace_rq_cpu(struct rq *rq);
2166 int sched_trace_rq_cpu_capacity(struct rq *rq);
2167 int sched_trace_rq_nr_running(struct rq *rq);
2168
2169 const struct cpumask *sched_trace_rd_span(struct root_domain *rd);
2170
2171 #endif