include/linux/sched/task.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_SCHED_TASK_H
   3 #define _LINUX_SCHED_TASK_H
   4
   5 /*
   6  * Interface between the scheduler and various task lifetime (fork()/exit())
   7  * functionality:
   8  */
   9
  10 #include <linux/sched.h>
  11 #include <linux/uaccess.h>
  12
  13 struct task_struct;
  14 struct rusage;
  15 union thread_union;
  16 struct css_set;
  17
  18 /* All the bits taken by the old clone syscall. */
  19 #define CLONE_LEGACY_FLAGS 0xffffffffULL
  20
  21 struct kernel_clone_args {
  22         u64 flags;
  23         int __user *pidfd;
  24         int __user *child_tid;
  25         int __user *parent_tid;
  26         int exit_signal;
  27         unsigned long stack;
  28         unsigned long stack_size;
  29         unsigned long tls;
  30         pid_t *set_tid;
  31         /* Number of elements in *set_tid */
  32         size_t set_tid_size;
  33         int cgroup;
  34         int io_thread;
  35         struct cgroup *cgrp;
  36         struct css_set *cset;
  37 };
  38
  39 /*
  40  * This serializes "schedule()" and also protects
  41  * the run-queue from deletions/modifications (but
  42  * _adding_ to the beginning of the run-queue has
  43  * a separate lock).
  44  */
  45 extern rwlock_t tasklist_lock;
  46 extern spinlock_t mmlist_lock;
  47
  48 extern union thread_union init_thread_union;
  49 extern struct task_struct init_task;
  50
  51 #ifdef CONFIG_PROVE_RCU
  52 extern int lockdep_tasklist_lock_is_held(void);
  53 #endif /* #ifdef CONFIG_PROVE_RCU */
  54
  55 extern asmlinkage void schedule_tail(struct task_struct *prev);
  56 extern void init_idle(struct task_struct *idle, int cpu);
  57
  58 extern int sched_fork(unsigned long clone_flags, struct task_struct *p);
  59 extern void sched_post_fork(struct task_struct *p,
  60                             struct kernel_clone_args *kargs);
  61 extern void sched_dead(struct task_struct *p);
  62
  63 void __noreturn do_task_dead(void);
  64 void __noreturn make_task_dead(int signr);
  65
  66 extern void mm_cache_init(void);
  67 extern void proc_caches_init(void);
  68
  69 extern void fork_init(void);
  70
  71 extern void release_task(struct task_struct * p);
  72
  73 extern int copy_thread(unsigned long, unsigned long, unsigned long,
  74                        struct task_struct *, unsigned long);
  75
  76 extern void flush_thread(void);
  77
  78 #ifdef CONFIG_HAVE_EXIT_THREAD
  79 extern void exit_thread(struct task_struct *tsk);
  80 #else
  81 static inline void exit_thread(struct task_struct *tsk)
  82 {
  83 }
  84 #endif
  85 extern void do_group_exit(int);
  86
  87 extern void exit_files(struct task_struct *);
  88 extern void exit_itimers(struct task_struct *);
  89
  90 extern pid_t kernel_clone(struct kernel_clone_args *kargs);
  91 struct task_struct *create_io_thread(int (*fn)(void *), void *arg, int node);
  92 struct task_struct *fork_idle(int);
  93 extern pid_t kernel_thread(int (*fn)(void *), void *arg, unsigned long flags);
  94 extern long kernel_wait4(pid_t, int __user *, int, struct rusage *);
  95 int kernel_wait(pid_t pid, int *stat);
  96
  97 extern void free_task(struct task_struct *tsk);
  98
  99 /* sched_exec is called by processes performing an exec */
 100 #ifdef CONFIG_SMP
 101 extern void sched_exec(void);
 102 #else
 103 #define sched_exec()   {}
 104 #endif
 105
 106 static inline struct task_struct *get_task_struct(struct task_struct *t)
 107 {
 108         refcount_inc(&t->usage);
 109         return t;
 110 }
 111
 112 extern void __put_task_struct(struct task_struct *t);
 113 extern void __put_task_struct_rcu_cb(struct rcu_head *rhp);
 114
 115 static inline void put_task_struct(struct task_struct *t)
 116 {
 117         if (!refcount_dec_and_test(&t->usage))
 118                 return;
 119
 120         /*
 121          * under PREEMPT_RT, we can't call put_task_struct
 122          * in atomic context because it will indirectly
 123          * acquire sleeping locks.
 124          *
 125          * call_rcu() will schedule delayed_put_task_struct_rcu()
 126          * to be called in process context.
 127          *
 128          * __put_task_struct() is called when
 129          * refcount_dec_and_test(&t->usage) succeeds.
 130          *
 131          * This means that it can't "conflict" with
 132          * put_task_struct_rcu_user() which abuses ->rcu the same
 133          * way; rcu_users has a reference so task->usage can't be
 134          * zero after rcu_users 1 -> 0 transition.
 135          *
 136          * delayed_free_task() also uses ->rcu, but it is only called
 137          * when it fails to fork a process. Therefore, there is no
 138          * way it can conflict with put_task_struct().
 139          */
 140         if (IS_ENABLED(CONFIG_PREEMPT_RT) && !preemptible())
 141                 call_rcu(&t->rcu, __put_task_struct_rcu_cb);
 142         else
 143                 __put_task_struct(t);
 144 }
 145
 146 static inline void put_task_struct_many(struct task_struct *t, int nr)
 147 {
 148         if (refcount_sub_and_test(nr, &t->usage))
 149                 __put_task_struct(t);
 150 }
 151
 152 void put_task_struct_rcu_user(struct task_struct *task);
 153
 154 #ifdef CONFIG_ARCH_WANTS_DYNAMIC_TASK_STRUCT
 155 extern int arch_task_struct_size __read_mostly;
 156 #else
 157 # define arch_task_struct_size (sizeof(struct task_struct))
 158 #endif
 159
 160 #ifndef CONFIG_HAVE_ARCH_THREAD_STRUCT_WHITELIST
 161 /*
 162  * If an architecture has not declared a thread_struct whitelist we
 163  * must assume something there may need to be copied to userspace.
 164  */
 165 static inline void arch_thread_struct_whitelist(unsigned long *offset,
 166                                                 unsigned long *size)
 167 {
 168         *offset = 0;
 169         /* Handle dynamically sized thread_struct. */
 170         *size = arch_task_struct_size - offsetof(struct task_struct, thread);
 171 }
 172 #endif
 173
 174 #ifdef CONFIG_VMAP_STACK
 175 static inline struct vm_struct *task_stack_vm_area(const struct task_struct *t)
 176 {
 177         return t->stack_vm_area;
 178 }
 179 #else
 180 static inline struct vm_struct *task_stack_vm_area(const struct task_struct *t)
 181 {
 182         return NULL;
 183 }
 184 #endif
 185
 186 /*
 187  * Protects ->fs, ->files, ->mm, ->group_info, ->comm, keyring
 188  * subscriptions and synchronises with wait4().  Also used in procfs.  Also
 189  * pins the final release of task.io_context.  Also protects ->cpuset and
 190  * ->cgroup.subsys[]. And ->vfork_done. And ->sysvshm.shm_clist.
 191  *
 192  * Nests both inside and outside of read_lock(&tasklist_lock).
 193  * It must not be nested with write_lock_irq(&tasklist_lock),
 194  * neither inside nor outside.
 195  */
 196 static inline void task_lock(struct task_struct *p)
 197 {
 198         spin_lock(&p->alloc_lock);
 199 }
 200
 201 static inline void task_unlock(struct task_struct *p)
 202 {
 203         spin_unlock(&p->alloc_lock);
 204 }
 205
 206 #endif /* _LINUX_SCHED_TASK_H */