1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_SCHED_SIGNAL_H
3 #define _LINUX_SCHED_SIGNAL_H
5 #include <linux/rculist.h>
6 #include <linux/signal.h>
7 #include <linux/sched.h>
8 #include <linux/sched/jobctl.h>
9 #include <linux/sched/task.h>
10 #include <linux/cred.h>
11 #include <linux/refcount.h>
12 #include <linux/pid.h>
13 #include <linux/posix-timers.h>
14 #include <linux/mm_types.h>
15 #include <asm/ptrace.h>
18 * Types defining task->signal and task->sighand and APIs using them:
21 struct sighand_struct {
24 wait_queue_head_t signalfd_wqh;
25 struct k_sigaction action[_NSIG];
29 * Per-process accounting stats:
35 u64 ac_utime, ac_stime;
36 unsigned long ac_minflt, ac_majflt;
45 * This is the atomic variant of task_cputime, which can be used for
46 * storing and updating task_cputime statistics without locking.
48 struct task_cputime_atomic {
51 atomic64_t sum_exec_runtime;
54 #define INIT_CPUTIME_ATOMIC \
55 (struct task_cputime_atomic) { \
56 .utime = ATOMIC64_INIT(0), \
57 .stime = ATOMIC64_INIT(0), \
58 .sum_exec_runtime = ATOMIC64_INIT(0), \
61 * struct thread_group_cputimer - thread group interval timer counts
62 * @cputime_atomic: atomic thread group interval timers.
64 * This structure contains the version of task_cputime, above, that is
65 * used for thread group CPU timer calculations.
67 struct thread_group_cputimer {
68 struct task_cputime_atomic cputime_atomic;
71 struct multiprocess_signals {
73 struct hlist_node node;
77 struct task_struct *task;
78 struct core_thread *next;
83 struct core_thread dumper;
84 struct completion startup;
88 * NOTE! "signal_struct" does not have its own
89 * locking, because a shared signal_struct always
90 * implies a shared sighand_struct, so locking
91 * sighand_struct is always a proper superset of
92 * the locking of signal_struct.
94 struct signal_struct {
99 struct list_head thread_head;
101 wait_queue_head_t wait_chldexit; /* for wait4() */
103 /* current thread group signal load-balancing target: */
104 struct task_struct *curr_target;
106 /* shared signal handling: */
107 struct sigpending shared_pending;
109 /* For collecting multiprocess signals during fork */
110 struct hlist_head multiprocess;
112 /* thread group exit support */
114 /* notify group_exec_task when notify_count is less or equal to 0 */
116 struct task_struct *group_exec_task;
118 /* thread group stop support, overloads group_exit_code too */
119 int group_stop_count;
120 unsigned int flags; /* see SIGNAL_* flags below */
122 struct core_state *core_state; /* coredumping support */
125 * PR_SET_CHILD_SUBREAPER marks a process, like a service
126 * manager, to re-parent orphan (double-forking) child processes
127 * to this process instead of 'init'. The service manager is
128 * able to receive SIGCHLD signals and is able to investigate
129 * the process until it calls wait(). All children of this
130 * process will inherit a flag if they should look for a
131 * child_subreaper process at exit.
133 unsigned int is_child_subreaper:1;
134 unsigned int has_child_subreaper:1;
136 #ifdef CONFIG_POSIX_TIMERS
138 /* POSIX.1b Interval Timers */
139 unsigned int next_posix_timer_id;
140 struct hlist_head posix_timers;
141 struct hlist_head ignored_posix_timers;
143 /* ITIMER_REAL timer for the process */
144 struct hrtimer real_timer;
145 ktime_t it_real_incr;
148 * ITIMER_PROF and ITIMER_VIRTUAL timers for the process, we use
149 * CPUCLOCK_PROF and CPUCLOCK_VIRT for indexing array as these
150 * values are defined to 0 and 1 respectively
152 struct cpu_itimer it[2];
155 * Thread group totals for process CPU timers.
156 * See thread_group_cputimer(), et al, for details.
158 struct thread_group_cputimer cputimer;
161 /* Empty if CONFIG_POSIX_TIMERS=n */
162 struct posix_cputimers posix_cputimers;
164 /* PID/PID hash table linkage. */
165 struct pid *pids[PIDTYPE_MAX];
167 #ifdef CONFIG_NO_HZ_FULL
168 atomic_t tick_dep_mask;
171 struct pid *tty_old_pgrp;
173 /* boolean value for session group leader */
176 struct tty_struct *tty; /* NULL if no tty */
178 #ifdef CONFIG_SCHED_AUTOGROUP
179 struct autogroup *autogroup;
182 * Cumulative resource counters for dead threads in the group,
183 * and for reaped dead child processes forked by this group.
184 * Live threads maintain their own counters and add to these
185 * in __exit_signal, except for the group leader.
187 seqlock_t stats_lock;
188 u64 utime, stime, cutime, cstime;
191 struct prev_cputime prev_cputime;
192 unsigned long nvcsw, nivcsw, cnvcsw, cnivcsw;
193 unsigned long min_flt, maj_flt, cmin_flt, cmaj_flt;
194 unsigned long inblock, oublock, cinblock, coublock;
195 unsigned long maxrss, cmaxrss;
196 struct task_io_accounting ioac;
199 * Cumulative ns of schedule CPU time fo dead threads in the
200 * group, not including a zombie group leader, (This only differs
201 * from jiffies_to_ns(utime + stime) if sched_clock uses something
202 * other than jiffies.)
204 unsigned long long sum_sched_runtime;
207 * We don't bother to synchronize most readers of this at all,
208 * because there is no reader checking a limit that actually needs
209 * to get both rlim_cur and rlim_max atomically, and either one
210 * alone is a single word that can safely be read normally.
211 * getrlimit/setrlimit use task_lock(current->group_leader) to
212 * protect this instead of the siglock, because they really
213 * have no need to disable irqs.
215 struct rlimit rlim[RLIM_NLIMITS];
217 #ifdef CONFIG_BSD_PROCESS_ACCT
218 struct pacct_struct pacct; /* per-process accounting information */
220 #ifdef CONFIG_TASKSTATS
221 struct taskstats *stats;
225 struct tty_audit_buf *tty_audit_buf;
229 * Thread is the potential origin of an oom condition; kill first on
232 bool oom_flag_origin;
233 short oom_score_adj; /* OOM kill score adjustment */
234 short oom_score_adj_min; /* OOM kill score adjustment min value.
235 * Only settable by CAP_SYS_RESOURCE. */
236 struct mm_struct *oom_mm; /* recorded mm when the thread group got
237 * killed by the oom killer */
239 struct mutex cred_guard_mutex; /* guard against foreign influences on
240 * credential calculations
242 * Deprecated do not use in new code.
243 * Use exec_update_lock instead.
245 struct rw_semaphore exec_update_lock; /* Held while task_struct is
246 * being updated during exec,
247 * and may have inconsistent
250 } __randomize_layout;
253 * Bits in flags field of signal_struct.
255 #define SIGNAL_STOP_STOPPED 0x00000001 /* job control stop in effect */
256 #define SIGNAL_STOP_CONTINUED 0x00000002 /* SIGCONT since WCONTINUED reap */
257 #define SIGNAL_GROUP_EXIT 0x00000004 /* group exit in progress */
259 * Pending notifications to parent.
261 #define SIGNAL_CLD_STOPPED 0x00000010
262 #define SIGNAL_CLD_CONTINUED 0x00000020
263 #define SIGNAL_CLD_MASK (SIGNAL_CLD_STOPPED|SIGNAL_CLD_CONTINUED)
265 #define SIGNAL_UNKILLABLE 0x00000040 /* for init: ignore fatal signals */
267 #define SIGNAL_STOP_MASK (SIGNAL_CLD_MASK | SIGNAL_STOP_STOPPED | \
268 SIGNAL_STOP_CONTINUED)
270 static inline void signal_set_stop_flags(struct signal_struct *sig,
273 WARN_ON(sig->flags & SIGNAL_GROUP_EXIT);
274 sig->flags = (sig->flags & ~SIGNAL_STOP_MASK) | flags;
277 extern void flush_signals(struct task_struct *);
278 extern void ignore_signals(struct task_struct *);
279 extern void flush_signal_handlers(struct task_struct *, int force_default);
280 extern int dequeue_signal(sigset_t *mask, kernel_siginfo_t *info, enum pid_type *type);
282 static inline int kernel_dequeue_signal(void)
284 struct task_struct *task = current;
285 kernel_siginfo_t __info;
286 enum pid_type __type;
289 spin_lock_irq(&task->sighand->siglock);
290 ret = dequeue_signal(&task->blocked, &__info, &__type);
291 spin_unlock_irq(&task->sighand->siglock);
296 static inline void kernel_signal_stop(void)
298 spin_lock_irq(¤t->sighand->siglock);
299 if (current->jobctl & JOBCTL_STOP_DEQUEUED) {
300 current->jobctl |= JOBCTL_STOPPED;
301 set_special_state(TASK_STOPPED);
303 spin_unlock_irq(¤t->sighand->siglock);
308 int force_sig_fault_to_task(int sig, int code, void __user *addr,
309 struct task_struct *t);
310 int force_sig_fault(int sig, int code, void __user *addr);
311 int send_sig_fault(int sig, int code, void __user *addr, struct task_struct *t);
313 int force_sig_mceerr(int code, void __user *, short);
314 int send_sig_mceerr(int code, void __user *, short, struct task_struct *);
316 int force_sig_bnderr(void __user *addr, void __user *lower, void __user *upper);
317 int force_sig_pkuerr(void __user *addr, u32 pkey);
318 int send_sig_perf(void __user *addr, u32 type, u64 sig_data);
320 int force_sig_ptrace_errno_trap(int errno, void __user *addr);
321 int force_sig_fault_trapno(int sig, int code, void __user *addr, int trapno);
322 int send_sig_fault_trapno(int sig, int code, void __user *addr, int trapno,
323 struct task_struct *t);
324 int force_sig_seccomp(int syscall, int reason, bool force_coredump);
326 extern int send_sig_info(int, struct kernel_siginfo *, struct task_struct *);
327 extern void force_sigsegv(int sig);
328 extern int force_sig_info(struct kernel_siginfo *);
329 extern int __kill_pgrp_info(int sig, struct kernel_siginfo *info, struct pid *pgrp);
330 extern int kill_pid_info(int sig, struct kernel_siginfo *info, struct pid *pid);
331 extern int kill_pid_usb_asyncio(int sig, int errno, sigval_t addr, struct pid *,
332 const struct cred *);
333 extern int kill_pgrp(struct pid *pid, int sig, int priv);
334 extern int kill_pid(struct pid *pid, int sig, int priv);
335 extern __must_check bool do_notify_parent(struct task_struct *, int);
336 extern void __wake_up_parent(struct task_struct *p, struct task_struct *parent);
337 extern void force_sig(int);
338 extern void force_fatal_sig(int);
339 extern void force_exit_sig(int);
340 extern int send_sig(int, struct task_struct *, int);
341 extern int zap_other_threads(struct task_struct *p);
342 extern int do_sigaction(int, struct k_sigaction *, struct k_sigaction *);
344 static inline void clear_notify_signal(void)
346 clear_thread_flag(TIF_NOTIFY_SIGNAL);
347 smp_mb__after_atomic();
351 * Returns 'true' if kick_process() is needed to force a transition from
352 * user -> kernel to guarantee expedient run of TWA_SIGNAL based task_work.
354 static inline bool __set_notify_signal(struct task_struct *task)
356 return !test_and_set_tsk_thread_flag(task, TIF_NOTIFY_SIGNAL) &&
357 !wake_up_state(task, TASK_INTERRUPTIBLE);
361 * Called to break out of interruptible wait loops, and enter the
362 * exit_to_user_mode_loop().
364 static inline void set_notify_signal(struct task_struct *task)
366 if (__set_notify_signal(task))
370 static inline int restart_syscall(void)
372 set_tsk_thread_flag(current, TIF_SIGPENDING);
373 return -ERESTARTNOINTR;
376 static inline int task_sigpending(struct task_struct *p)
378 return unlikely(test_tsk_thread_flag(p,TIF_SIGPENDING));
381 static inline int signal_pending(struct task_struct *p)
384 * TIF_NOTIFY_SIGNAL isn't really a signal, but it requires the same
385 * behavior in terms of ensuring that we break out of wait loops
386 * so that notify signal callbacks can be processed.
388 if (unlikely(test_tsk_thread_flag(p, TIF_NOTIFY_SIGNAL)))
390 return task_sigpending(p);
393 static inline int __fatal_signal_pending(struct task_struct *p)
395 return unlikely(sigismember(&p->pending.signal, SIGKILL));
398 static inline int fatal_signal_pending(struct task_struct *p)
400 return task_sigpending(p) && __fatal_signal_pending(p);
403 static inline int signal_pending_state(unsigned int state, struct task_struct *p)
405 if (!(state & (TASK_INTERRUPTIBLE | TASK_WAKEKILL)))
407 if (!signal_pending(p))
410 return (state & TASK_INTERRUPTIBLE) || __fatal_signal_pending(p);
414 * This should only be used in fault handlers to decide whether we
415 * should stop the current fault routine to handle the signals
416 * instead, especially with the case where we've got interrupted with
419 static inline bool fault_signal_pending(vm_fault_t fault_flags,
420 struct pt_regs *regs)
422 return unlikely((fault_flags & VM_FAULT_RETRY) &&
423 (fatal_signal_pending(current) ||
424 (user_mode(regs) && signal_pending(current))));
428 * Reevaluate whether the task has signals pending delivery.
429 * Wake the task if so.
430 * This is required every time the blocked sigset_t changes.
431 * callers must hold sighand->siglock.
433 extern void recalc_sigpending(void);
434 extern void calculate_sigpending(void);
436 extern void signal_wake_up_state(struct task_struct *t, unsigned int state);
438 static inline void signal_wake_up(struct task_struct *t, bool fatal)
440 unsigned int state = 0;
441 if (fatal && !(t->jobctl & JOBCTL_PTRACE_FROZEN)) {
442 t->jobctl &= ~(JOBCTL_STOPPED | JOBCTL_TRACED);
443 state = TASK_WAKEKILL | __TASK_TRACED;
445 signal_wake_up_state(t, state);
447 static inline void ptrace_signal_wake_up(struct task_struct *t, bool resume)
449 unsigned int state = 0;
451 t->jobctl &= ~JOBCTL_TRACED;
452 state = __TASK_TRACED;
454 signal_wake_up_state(t, state);
457 void task_join_group_stop(struct task_struct *task);
459 #ifdef TIF_RESTORE_SIGMASK
461 * Legacy restore_sigmask accessors. These are inefficient on
462 * SMP architectures because they require atomic operations.
466 * set_restore_sigmask() - make sure saved_sigmask processing gets done
468 * This sets TIF_RESTORE_SIGMASK and ensures that the arch signal code
469 * will run before returning to user mode, to process the flag. For
470 * all callers, TIF_SIGPENDING is already set or it's no harm to set
471 * it. TIF_RESTORE_SIGMASK need not be in the set of bits that the
472 * arch code will notice on return to user mode, in case those bits
473 * are scarce. We set TIF_SIGPENDING here to ensure that the arch
474 * signal code always gets run when TIF_RESTORE_SIGMASK is set.
476 static inline void set_restore_sigmask(void)
478 set_thread_flag(TIF_RESTORE_SIGMASK);
481 static inline void clear_tsk_restore_sigmask(struct task_struct *task)
483 clear_tsk_thread_flag(task, TIF_RESTORE_SIGMASK);
486 static inline void clear_restore_sigmask(void)
488 clear_thread_flag(TIF_RESTORE_SIGMASK);
490 static inline bool test_tsk_restore_sigmask(struct task_struct *task)
492 return test_tsk_thread_flag(task, TIF_RESTORE_SIGMASK);
494 static inline bool test_restore_sigmask(void)
496 return test_thread_flag(TIF_RESTORE_SIGMASK);
498 static inline bool test_and_clear_restore_sigmask(void)
500 return test_and_clear_thread_flag(TIF_RESTORE_SIGMASK);
503 #else /* TIF_RESTORE_SIGMASK */
505 /* Higher-quality implementation, used if TIF_RESTORE_SIGMASK doesn't exist. */
506 static inline void set_restore_sigmask(void)
508 current->restore_sigmask = true;
510 static inline void clear_tsk_restore_sigmask(struct task_struct *task)
512 task->restore_sigmask = false;
514 static inline void clear_restore_sigmask(void)
516 current->restore_sigmask = false;
518 static inline bool test_restore_sigmask(void)
520 return current->restore_sigmask;
522 static inline bool test_tsk_restore_sigmask(struct task_struct *task)
524 return task->restore_sigmask;
526 static inline bool test_and_clear_restore_sigmask(void)
528 if (!current->restore_sigmask)
530 current->restore_sigmask = false;
535 static inline void restore_saved_sigmask(void)
537 if (test_and_clear_restore_sigmask())
538 __set_current_blocked(¤t->saved_sigmask);
541 extern int set_user_sigmask(const sigset_t __user *umask, size_t sigsetsize);
543 static inline void restore_saved_sigmask_unless(bool interrupted)
546 WARN_ON(!signal_pending(current));
548 restore_saved_sigmask();
551 static inline sigset_t *sigmask_to_save(void)
553 sigset_t *res = ¤t->blocked;
554 if (unlikely(test_restore_sigmask()))
555 res = ¤t->saved_sigmask;
559 static inline int kill_cad_pid(int sig, int priv)
561 return kill_pid(cad_pid, sig, priv);
564 /* These can be the second arg to send_sig_info/send_group_sig_info. */
565 #define SEND_SIG_NOINFO ((struct kernel_siginfo *) 0)
566 #define SEND_SIG_PRIV ((struct kernel_siginfo *) 1)
568 static inline int __on_sig_stack(unsigned long sp)
570 #ifdef CONFIG_STACK_GROWSUP
571 return sp >= current->sas_ss_sp &&
572 sp - current->sas_ss_sp < current->sas_ss_size;
574 return sp > current->sas_ss_sp &&
575 sp - current->sas_ss_sp <= current->sas_ss_size;
580 * True if we are on the alternate signal stack.
582 static inline int on_sig_stack(unsigned long sp)
585 * If the signal stack is SS_AUTODISARM then, by construction, we
586 * can't be on the signal stack unless user code deliberately set
587 * SS_AUTODISARM when we were already on it.
589 * This improves reliability: if user state gets corrupted such that
590 * the stack pointer points very close to the end of the signal stack,
591 * then this check will enable the signal to be handled anyway.
593 if (current->sas_ss_flags & SS_AUTODISARM)
596 return __on_sig_stack(sp);
599 static inline int sas_ss_flags(unsigned long sp)
601 if (!current->sas_ss_size)
604 return on_sig_stack(sp) ? SS_ONSTACK : 0;
607 static inline void sas_ss_reset(struct task_struct *p)
611 p->sas_ss_flags = SS_DISABLE;
614 static inline unsigned long sigsp(unsigned long sp, struct ksignal *ksig)
616 if (unlikely((ksig->ka.sa.sa_flags & SA_ONSTACK)) && ! sas_ss_flags(sp))
617 #ifdef CONFIG_STACK_GROWSUP
618 return current->sas_ss_sp;
620 return current->sas_ss_sp + current->sas_ss_size;
625 extern void __cleanup_sighand(struct sighand_struct *);
626 extern void flush_itimer_signals(void);
628 #define tasklist_empty() \
629 list_empty(&init_task.tasks)
631 #define next_task(p) \
632 list_entry_rcu((p)->tasks.next, struct task_struct, tasks)
634 #define for_each_process(p) \
635 for (p = &init_task ; (p = next_task(p)) != &init_task ; )
637 extern bool current_is_single_threaded(void);
640 * Without tasklist/siglock it is only rcu-safe if g can't exit/exec,
641 * otherwise next_thread(t) will never reach g after list_del_rcu(g).
643 #define while_each_thread(g, t) \
644 while ((t = next_thread(t)) != g)
646 #define for_other_threads(p, t) \
647 for (t = p; (t = next_thread(t)) != p; )
649 #define __for_each_thread(signal, t) \
650 list_for_each_entry_rcu(t, &(signal)->thread_head, thread_node, \
651 lockdep_is_held(&tasklist_lock))
653 #define for_each_thread(p, t) \
654 __for_each_thread((p)->signal, t)
656 /* Careful: this is a double loop, 'break' won't work as expected. */
657 #define for_each_process_thread(p, t) \
658 for_each_process(p) for_each_thread(p, t)
660 typedef int (*proc_visitor)(struct task_struct *p, void *data);
661 void walk_process_tree(struct task_struct *top, proc_visitor, void *);
664 struct pid *task_pid_type(struct task_struct *task, enum pid_type type)
667 if (type == PIDTYPE_PID)
668 pid = task_pid(task);
670 pid = task->signal->pids[type];
674 static inline struct pid *task_tgid(struct task_struct *task)
676 return task->signal->pids[PIDTYPE_TGID];
680 * Without tasklist or RCU lock it is not safe to dereference
681 * the result of task_pgrp/task_session even if task == current,
682 * we can race with another thread doing sys_setsid/sys_setpgid.
684 static inline struct pid *task_pgrp(struct task_struct *task)
686 return task->signal->pids[PIDTYPE_PGID];
689 static inline struct pid *task_session(struct task_struct *task)
691 return task->signal->pids[PIDTYPE_SID];
694 static inline int get_nr_threads(struct task_struct *task)
696 return task->signal->nr_threads;
699 static inline bool thread_group_leader(struct task_struct *p)
701 return p->exit_signal >= 0;
705 bool same_thread_group(struct task_struct *p1, struct task_struct *p2)
707 return p1->signal == p2->signal;
711 * returns NULL if p is the last thread in the thread group
713 static inline struct task_struct *__next_thread(struct task_struct *p)
715 return list_next_or_null_rcu(&p->signal->thread_head,
721 static inline struct task_struct *next_thread(struct task_struct *p)
723 return __next_thread(p) ?: p->group_leader;
726 static inline int thread_group_empty(struct task_struct *p)
728 return thread_group_leader(p) &&
729 list_is_last(&p->thread_node, &p->signal->thread_head);
732 #define delay_group_leader(p) \
733 (thread_group_leader(p) && !thread_group_empty(p))
735 extern struct sighand_struct *__lock_task_sighand(struct task_struct *task,
736 unsigned long *flags);
738 static inline struct sighand_struct *lock_task_sighand(struct task_struct *task,
739 unsigned long *flags)
741 struct sighand_struct *ret;
743 ret = __lock_task_sighand(task, flags);
744 (void)__cond_lock(&task->sighand->siglock, ret);
748 static inline void unlock_task_sighand(struct task_struct *task,
749 unsigned long *flags)
751 spin_unlock_irqrestore(&task->sighand->siglock, *flags);
754 #ifdef CONFIG_LOCKDEP
755 extern void lockdep_assert_task_sighand_held(struct task_struct *task);
757 static inline void lockdep_assert_task_sighand_held(struct task_struct *task) { }
760 static inline unsigned long task_rlimit(const struct task_struct *task,
763 return READ_ONCE(task->signal->rlim[limit].rlim_cur);
766 static inline unsigned long task_rlimit_max(const struct task_struct *task,
769 return READ_ONCE(task->signal->rlim[limit].rlim_max);
772 static inline unsigned long rlimit(unsigned int limit)
774 return task_rlimit(current, limit);
777 static inline unsigned long rlimit_max(unsigned int limit)
779 return task_rlimit_max(current, limit);
782 #endif /* _LINUX_SCHED_SIGNAL_H */