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