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