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/posix-timers.h>
13 #include <linux/mm_types.h>
14 #include <asm/ptrace.h>
17 * Types defining task->signal and task->sighand and APIs using them:
20 struct sighand_struct {
23 wait_queue_head_t signalfd_wqh;
24 struct k_sigaction action[_NSIG];
28 * Per-process accounting stats:
34 u64 ac_utime, ac_stime;
35 unsigned long ac_minflt, ac_majflt;
44 * This is the atomic variant of task_cputime, which can be used for
45 * storing and updating task_cputime statistics without locking.
47 struct task_cputime_atomic {
50 atomic64_t sum_exec_runtime;
53 #define INIT_CPUTIME_ATOMIC \
54 (struct task_cputime_atomic) { \
55 .utime = ATOMIC64_INIT(0), \
56 .stime = ATOMIC64_INIT(0), \
57 .sum_exec_runtime = ATOMIC64_INIT(0), \
60 * struct thread_group_cputimer - thread group interval timer counts
61 * @cputime_atomic: atomic thread group interval timers.
63 * This structure contains the version of task_cputime, above, that is
64 * used for thread group CPU timer calculations.
66 struct thread_group_cputimer {
67 struct task_cputime_atomic cputime_atomic;
70 struct multiprocess_signals {
72 struct hlist_node node;
76 * NOTE! "signal_struct" does not have its own
77 * locking, because a shared signal_struct always
78 * implies a shared sighand_struct, so locking
79 * sighand_struct is always a proper superset of
80 * the locking of signal_struct.
82 struct signal_struct {
86 struct list_head thread_head;
88 wait_queue_head_t wait_chldexit; /* for wait4() */
90 /* current thread group signal load-balancing target: */
91 struct task_struct *curr_target;
93 /* shared signal handling: */
94 struct sigpending shared_pending;
96 /* For collecting multiprocess signals during fork */
97 struct hlist_head multiprocess;
99 /* thread group exit support */
102 * - notify group_exit_task when ->count is equal to notify_count
103 * - everyone except group_exit_task is stopped during signal delivery
104 * of fatal signals, group_exit_task processes the signal.
107 struct task_struct *group_exit_task;
109 /* thread group stop support, overloads group_exit_code too */
110 int group_stop_count;
111 unsigned int flags; /* see SIGNAL_* flags below */
114 * PR_SET_CHILD_SUBREAPER marks a process, like a service
115 * manager, to re-parent orphan (double-forking) child processes
116 * to this process instead of 'init'. The service manager is
117 * able to receive SIGCHLD signals and is able to investigate
118 * the process until it calls wait(). All children of this
119 * process will inherit a flag if they should look for a
120 * child_subreaper process at exit.
122 unsigned int is_child_subreaper:1;
123 unsigned int has_child_subreaper:1;
125 #ifdef CONFIG_POSIX_TIMERS
127 /* POSIX.1b Interval Timers */
129 struct list_head posix_timers;
131 /* ITIMER_REAL timer for the process */
132 struct hrtimer real_timer;
133 ktime_t it_real_incr;
136 * ITIMER_PROF and ITIMER_VIRTUAL timers for the process, we use
137 * CPUCLOCK_PROF and CPUCLOCK_VIRT for indexing array as these
138 * values are defined to 0 and 1 respectively
140 struct cpu_itimer it[2];
143 * Thread group totals for process CPU timers.
144 * See thread_group_cputimer(), et al, for details.
146 struct thread_group_cputimer cputimer;
149 /* Empty if CONFIG_POSIX_TIMERS=n */
150 struct posix_cputimers posix_cputimers;
152 /* PID/PID hash table linkage. */
153 struct pid *pids[PIDTYPE_MAX];
155 #ifdef CONFIG_NO_HZ_FULL
156 atomic_t tick_dep_mask;
159 struct pid *tty_old_pgrp;
161 /* boolean value for session group leader */
164 struct tty_struct *tty; /* NULL if no tty */
166 #ifdef CONFIG_SCHED_AUTOGROUP
167 struct autogroup *autogroup;
170 * Cumulative resource counters for dead threads in the group,
171 * and for reaped dead child processes forked by this group.
172 * Live threads maintain their own counters and add to these
173 * in __exit_signal, except for the group leader.
175 seqlock_t stats_lock;
176 u64 utime, stime, cutime, cstime;
179 struct prev_cputime prev_cputime;
180 unsigned long nvcsw, nivcsw, cnvcsw, cnivcsw;
181 unsigned long min_flt, maj_flt, cmin_flt, cmaj_flt;
182 unsigned long inblock, oublock, cinblock, coublock;
183 unsigned long maxrss, cmaxrss;
184 struct task_io_accounting ioac;
187 * Cumulative ns of schedule CPU time fo dead threads in the
188 * group, not including a zombie group leader, (This only differs
189 * from jiffies_to_ns(utime + stime) if sched_clock uses something
190 * other than jiffies.)
192 unsigned long long sum_sched_runtime;
195 * We don't bother to synchronize most readers of this at all,
196 * because there is no reader checking a limit that actually needs
197 * to get both rlim_cur and rlim_max atomically, and either one
198 * alone is a single word that can safely be read normally.
199 * getrlimit/setrlimit use task_lock(current->group_leader) to
200 * protect this instead of the siglock, because they really
201 * have no need to disable irqs.
203 struct rlimit rlim[RLIM_NLIMITS];
205 #ifdef CONFIG_BSD_PROCESS_ACCT
206 struct pacct_struct pacct; /* per-process accounting information */
208 #ifdef CONFIG_TASKSTATS
209 struct taskstats *stats;
213 struct tty_audit_buf *tty_audit_buf;
217 * Thread is the potential origin of an oom condition; kill first on
220 bool oom_flag_origin;
221 short oom_score_adj; /* OOM kill score adjustment */
222 short oom_score_adj_min; /* OOM kill score adjustment min value.
223 * Only settable by CAP_SYS_RESOURCE. */
224 struct mm_struct *oom_mm; /* recorded mm when the thread group got
225 * killed by the oom killer */
227 struct mutex cred_guard_mutex; /* guard against foreign influences on
228 * credential calculations
229 * (notably. ptrace) */
230 } __randomize_layout;
233 * Bits in flags field of signal_struct.
235 #define SIGNAL_STOP_STOPPED 0x00000001 /* job control stop in effect */
236 #define SIGNAL_STOP_CONTINUED 0x00000002 /* SIGCONT since WCONTINUED reap */
237 #define SIGNAL_GROUP_EXIT 0x00000004 /* group exit in progress */
238 #define SIGNAL_GROUP_COREDUMP 0x00000008 /* coredump in progress */
240 * Pending notifications to parent.
242 #define SIGNAL_CLD_STOPPED 0x00000010
243 #define SIGNAL_CLD_CONTINUED 0x00000020
244 #define SIGNAL_CLD_MASK (SIGNAL_CLD_STOPPED|SIGNAL_CLD_CONTINUED)
246 #define SIGNAL_UNKILLABLE 0x00000040 /* for init: ignore fatal signals */
248 #define SIGNAL_STOP_MASK (SIGNAL_CLD_MASK | SIGNAL_STOP_STOPPED | \
249 SIGNAL_STOP_CONTINUED)
251 static inline void signal_set_stop_flags(struct signal_struct *sig,
254 WARN_ON(sig->flags & (SIGNAL_GROUP_EXIT|SIGNAL_GROUP_COREDUMP));
255 sig->flags = (sig->flags & ~SIGNAL_STOP_MASK) | flags;
258 /* If true, all threads except ->group_exit_task have pending SIGKILL */
259 static inline int signal_group_exit(const struct signal_struct *sig)
261 return (sig->flags & SIGNAL_GROUP_EXIT) ||
262 (sig->group_exit_task != NULL);
265 extern void flush_signals(struct task_struct *);
266 extern void ignore_signals(struct task_struct *);
267 extern void flush_signal_handlers(struct task_struct *, int force_default);
268 extern int dequeue_signal(struct task_struct *task,
269 sigset_t *mask, kernel_siginfo_t *info);
271 static inline int kernel_dequeue_signal(void)
273 struct task_struct *task = current;
274 kernel_siginfo_t __info;
277 spin_lock_irq(&task->sighand->siglock);
278 ret = dequeue_signal(task, &task->blocked, &__info);
279 spin_unlock_irq(&task->sighand->siglock);
284 static inline void kernel_signal_stop(void)
286 spin_lock_irq(¤t->sighand->siglock);
287 if (current->jobctl & JOBCTL_STOP_DEQUEUED)
288 set_special_state(TASK_STOPPED);
289 spin_unlock_irq(¤t->sighand->siglock);
293 #ifdef __ARCH_SI_TRAPNO
294 # define ___ARCH_SI_TRAPNO(_a1) , _a1
296 # define ___ARCH_SI_TRAPNO(_a1)
299 # define ___ARCH_SI_IA64(_a1, _a2, _a3) , _a1, _a2, _a3
301 # define ___ARCH_SI_IA64(_a1, _a2, _a3)
304 int force_sig_fault_to_task(int sig, int code, void __user *addr
305 ___ARCH_SI_TRAPNO(int trapno)
306 ___ARCH_SI_IA64(int imm, unsigned int flags, unsigned long isr)
307 , struct task_struct *t);
308 int force_sig_fault(int sig, int code, void __user *addr
309 ___ARCH_SI_TRAPNO(int trapno)
310 ___ARCH_SI_IA64(int imm, unsigned int flags, unsigned long isr));
311 int send_sig_fault(int sig, int code, void __user *addr
312 ___ARCH_SI_TRAPNO(int trapno)
313 ___ARCH_SI_IA64(int imm, unsigned int flags, unsigned long isr)
314 , struct task_struct *t);
316 int force_sig_mceerr(int code, void __user *, short);
317 int send_sig_mceerr(int code, void __user *, short, struct task_struct *);
319 int force_sig_bnderr(void __user *addr, void __user *lower, void __user *upper);
320 int force_sig_pkuerr(void __user *addr, u32 pkey);
322 int force_sig_ptrace_errno_trap(int errno, void __user *addr);
324 extern int send_sig_info(int, struct kernel_siginfo *, struct task_struct *);
325 extern void force_sigsegv(int sig);
326 extern int force_sig_info(struct kernel_siginfo *);
327 extern int __kill_pgrp_info(int sig, struct kernel_siginfo *info, struct pid *pgrp);
328 extern int kill_pid_info(int sig, struct kernel_siginfo *info, struct pid *pid);
329 extern int kill_pid_usb_asyncio(int sig, int errno, sigval_t addr, struct pid *,
330 const struct cred *);
331 extern int kill_pgrp(struct pid *pid, int sig, int priv);
332 extern int kill_pid(struct pid *pid, int sig, int priv);
333 extern __must_check bool do_notify_parent(struct task_struct *, int);
334 extern void __wake_up_parent(struct task_struct *p, struct task_struct *parent);
335 extern void force_sig(int);
336 extern int send_sig(int, struct task_struct *, int);
337 extern int zap_other_threads(struct task_struct *p);
338 extern struct sigqueue *sigqueue_alloc(void);
339 extern void sigqueue_free(struct sigqueue *);
340 extern int send_sigqueue(struct sigqueue *, struct pid *, enum pid_type);
341 extern int do_sigaction(int, struct k_sigaction *, struct k_sigaction *);
343 static inline int restart_syscall(void)
345 set_tsk_thread_flag(current, TIF_SIGPENDING);
346 return -ERESTARTNOINTR;
349 static inline int signal_pending(struct task_struct *p)
351 return unlikely(test_tsk_thread_flag(p,TIF_SIGPENDING));
354 static inline int __fatal_signal_pending(struct task_struct *p)
356 return unlikely(sigismember(&p->pending.signal, SIGKILL));
359 static inline int fatal_signal_pending(struct task_struct *p)
361 return signal_pending(p) && __fatal_signal_pending(p);
364 static inline int signal_pending_state(long state, struct task_struct *p)
366 if (!(state & (TASK_INTERRUPTIBLE | TASK_WAKEKILL)))
368 if (!signal_pending(p))
371 return (state & TASK_INTERRUPTIBLE) || __fatal_signal_pending(p);
375 * This should only be used in fault handlers to decide whether we
376 * should stop the current fault routine to handle the signals
377 * instead, especially with the case where we've got interrupted with
380 static inline bool fault_signal_pending(vm_fault_t fault_flags,
381 struct pt_regs *regs)
383 return unlikely((fault_flags & VM_FAULT_RETRY) &&
384 fatal_signal_pending(current));
388 * Reevaluate whether the task has signals pending delivery.
389 * Wake the task if so.
390 * This is required every time the blocked sigset_t changes.
391 * callers must hold sighand->siglock.
393 extern void recalc_sigpending_and_wake(struct task_struct *t);
394 extern void recalc_sigpending(void);
395 extern void calculate_sigpending(void);
397 extern void signal_wake_up_state(struct task_struct *t, unsigned int state);
399 static inline void signal_wake_up(struct task_struct *t, bool resume)
401 signal_wake_up_state(t, resume ? TASK_WAKEKILL : 0);
403 static inline void ptrace_signal_wake_up(struct task_struct *t, bool resume)
405 signal_wake_up_state(t, resume ? __TASK_TRACED : 0);
408 void task_join_group_stop(struct task_struct *task);
410 #ifdef TIF_RESTORE_SIGMASK
412 * Legacy restore_sigmask accessors. These are inefficient on
413 * SMP architectures because they require atomic operations.
417 * set_restore_sigmask() - make sure saved_sigmask processing gets done
419 * This sets TIF_RESTORE_SIGMASK and ensures that the arch signal code
420 * will run before returning to user mode, to process the flag. For
421 * all callers, TIF_SIGPENDING is already set or it's no harm to set
422 * it. TIF_RESTORE_SIGMASK need not be in the set of bits that the
423 * arch code will notice on return to user mode, in case those bits
424 * are scarce. We set TIF_SIGPENDING here to ensure that the arch
425 * signal code always gets run when TIF_RESTORE_SIGMASK is set.
427 static inline void set_restore_sigmask(void)
429 set_thread_flag(TIF_RESTORE_SIGMASK);
432 static inline void clear_tsk_restore_sigmask(struct task_struct *task)
434 clear_tsk_thread_flag(task, TIF_RESTORE_SIGMASK);
437 static inline void clear_restore_sigmask(void)
439 clear_thread_flag(TIF_RESTORE_SIGMASK);
441 static inline bool test_tsk_restore_sigmask(struct task_struct *task)
443 return test_tsk_thread_flag(task, TIF_RESTORE_SIGMASK);
445 static inline bool test_restore_sigmask(void)
447 return test_thread_flag(TIF_RESTORE_SIGMASK);
449 static inline bool test_and_clear_restore_sigmask(void)
451 return test_and_clear_thread_flag(TIF_RESTORE_SIGMASK);
454 #else /* TIF_RESTORE_SIGMASK */
456 /* Higher-quality implementation, used if TIF_RESTORE_SIGMASK doesn't exist. */
457 static inline void set_restore_sigmask(void)
459 current->restore_sigmask = true;
461 static inline void clear_tsk_restore_sigmask(struct task_struct *task)
463 task->restore_sigmask = false;
465 static inline void clear_restore_sigmask(void)
467 current->restore_sigmask = false;
469 static inline bool test_restore_sigmask(void)
471 return current->restore_sigmask;
473 static inline bool test_tsk_restore_sigmask(struct task_struct *task)
475 return task->restore_sigmask;
477 static inline bool test_and_clear_restore_sigmask(void)
479 if (!current->restore_sigmask)
481 current->restore_sigmask = false;
486 static inline void restore_saved_sigmask(void)
488 if (test_and_clear_restore_sigmask())
489 __set_current_blocked(¤t->saved_sigmask);
492 extern int set_user_sigmask(const sigset_t __user *umask, size_t sigsetsize);
494 static inline void restore_saved_sigmask_unless(bool interrupted)
497 WARN_ON(!test_thread_flag(TIF_SIGPENDING));
499 restore_saved_sigmask();
502 static inline sigset_t *sigmask_to_save(void)
504 sigset_t *res = ¤t->blocked;
505 if (unlikely(test_restore_sigmask()))
506 res = ¤t->saved_sigmask;
510 static inline int kill_cad_pid(int sig, int priv)
512 return kill_pid(cad_pid, sig, priv);
515 /* These can be the second arg to send_sig_info/send_group_sig_info. */
516 #define SEND_SIG_NOINFO ((struct kernel_siginfo *) 0)
517 #define SEND_SIG_PRIV ((struct kernel_siginfo *) 1)
520 * True if we are on the alternate signal stack.
522 static inline int on_sig_stack(unsigned long sp)
525 * If the signal stack is SS_AUTODISARM then, by construction, we
526 * can't be on the signal stack unless user code deliberately set
527 * SS_AUTODISARM when we were already on it.
529 * This improves reliability: if user state gets corrupted such that
530 * the stack pointer points very close to the end of the signal stack,
531 * then this check will enable the signal to be handled anyway.
533 if (current->sas_ss_flags & SS_AUTODISARM)
536 #ifdef CONFIG_STACK_GROWSUP
537 return sp >= current->sas_ss_sp &&
538 sp - current->sas_ss_sp < current->sas_ss_size;
540 return sp > current->sas_ss_sp &&
541 sp - current->sas_ss_sp <= current->sas_ss_size;
545 static inline int sas_ss_flags(unsigned long sp)
547 if (!current->sas_ss_size)
550 return on_sig_stack(sp) ? SS_ONSTACK : 0;
553 static inline void sas_ss_reset(struct task_struct *p)
557 p->sas_ss_flags = SS_DISABLE;
560 static inline unsigned long sigsp(unsigned long sp, struct ksignal *ksig)
562 if (unlikely((ksig->ka.sa.sa_flags & SA_ONSTACK)) && ! sas_ss_flags(sp))
563 #ifdef CONFIG_STACK_GROWSUP
564 return current->sas_ss_sp;
566 return current->sas_ss_sp + current->sas_ss_size;
571 extern void __cleanup_sighand(struct sighand_struct *);
572 extern void flush_itimer_signals(void);
574 #define tasklist_empty() \
575 list_empty(&init_task.tasks)
577 #define next_task(p) \
578 list_entry_rcu((p)->tasks.next, struct task_struct, tasks)
580 #define for_each_process(p) \
581 for (p = &init_task ; (p = next_task(p)) != &init_task ; )
583 extern bool current_is_single_threaded(void);
586 * Careful: do_each_thread/while_each_thread is a double loop so
587 * 'break' will not work as expected - use goto instead.
589 #define do_each_thread(g, t) \
590 for (g = t = &init_task ; (g = t = next_task(g)) != &init_task ; ) do
592 #define while_each_thread(g, t) \
593 while ((t = next_thread(t)) != g)
595 #define __for_each_thread(signal, t) \
596 list_for_each_entry_rcu(t, &(signal)->thread_head, thread_node)
598 #define for_each_thread(p, t) \
599 __for_each_thread((p)->signal, t)
601 /* Careful: this is a double loop, 'break' won't work as expected. */
602 #define for_each_process_thread(p, t) \
603 for_each_process(p) for_each_thread(p, t)
605 typedef int (*proc_visitor)(struct task_struct *p, void *data);
606 void walk_process_tree(struct task_struct *top, proc_visitor, void *);
609 struct pid *task_pid_type(struct task_struct *task, enum pid_type type)
612 if (type == PIDTYPE_PID)
613 pid = task_pid(task);
615 pid = task->signal->pids[type];
619 static inline struct pid *task_tgid(struct task_struct *task)
621 return task->signal->pids[PIDTYPE_TGID];
625 * Without tasklist or RCU lock it is not safe to dereference
626 * the result of task_pgrp/task_session even if task == current,
627 * we can race with another thread doing sys_setsid/sys_setpgid.
629 static inline struct pid *task_pgrp(struct task_struct *task)
631 return task->signal->pids[PIDTYPE_PGID];
634 static inline struct pid *task_session(struct task_struct *task)
636 return task->signal->pids[PIDTYPE_SID];
639 static inline int get_nr_threads(struct task_struct *task)
641 return task->signal->nr_threads;
644 static inline bool thread_group_leader(struct task_struct *p)
646 return p->exit_signal >= 0;
649 /* Do to the insanities of de_thread it is possible for a process
650 * to have the pid of the thread group leader without actually being
651 * the thread group leader. For iteration through the pids in proc
652 * all we care about is that we have a task with the appropriate
653 * pid, we don't actually care if we have the right task.
655 static inline bool has_group_leader_pid(struct task_struct *p)
657 return task_pid(p) == task_tgid(p);
661 bool same_thread_group(struct task_struct *p1, struct task_struct *p2)
663 return p1->signal == p2->signal;
666 static inline struct task_struct *next_thread(const struct task_struct *p)
668 return list_entry_rcu(p->thread_group.next,
669 struct task_struct, thread_group);
672 static inline int thread_group_empty(struct task_struct *p)
674 return list_empty(&p->thread_group);
677 #define delay_group_leader(p) \
678 (thread_group_leader(p) && !thread_group_empty(p))
680 extern struct sighand_struct *__lock_task_sighand(struct task_struct *task,
681 unsigned long *flags);
683 static inline struct sighand_struct *lock_task_sighand(struct task_struct *task,
684 unsigned long *flags)
686 struct sighand_struct *ret;
688 ret = __lock_task_sighand(task, flags);
689 (void)__cond_lock(&task->sighand->siglock, ret);
693 static inline void unlock_task_sighand(struct task_struct *task,
694 unsigned long *flags)
696 spin_unlock_irqrestore(&task->sighand->siglock, *flags);
699 static inline unsigned long task_rlimit(const struct task_struct *task,
702 return READ_ONCE(task->signal->rlim[limit].rlim_cur);
705 static inline unsigned long task_rlimit_max(const struct task_struct *task,
708 return READ_ONCE(task->signal->rlim[limit].rlim_max);
711 static inline unsigned long rlimit(unsigned int limit)
713 return task_rlimit(current, limit);
716 static inline unsigned long rlimit_max(unsigned int limit)
718 return task_rlimit_max(current, limit);
721 #endif /* _LINUX_SCHED_SIGNAL_H */