signal.h(0P)

๐Ÿ’– PROLOG ๐Ÿ’–

okay bestie, quick heads-up before we dive in: this manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details), or the interface may not be implemented on Linux. no cap. ๐Ÿซถ

โœจ NAME โœจ

signal.h โ€” signals. it's giving the header that handles all the signal drama. ๐Ÿ’…

๐ŸŒˆ SYNOPSIS ๐ŸŒˆ

#include <signal.h>

๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

Some of the functionality described on this reference page extends the ISO C standard. Applications shall define the appropriate feature test macro (see the System Interfaces volume of POSIX.1โ€2017, Section 2.2, The Compilation Environment) to enable the visibility of these symbols in this header.

๐ŸŽ€ Macros that go brrr

The <signal.h> header shall define the following macros, which shall expand to constant expressions with distinct values that have a type compatible with the second argument to, and the return value of, the signal() function, and whose values shall compare unequal to the address of any declarable function. periodt.

  • SIG_DFL โ€” Request for default signal handling.
  • SIG_ERR โ€” Return value from signal() in case of error.
  • SIG_HOLD โ€” Request that signal be held.
  • SIG_IGN โ€” Request that signal be ignored.

๐ŸŒŸ Types, bestie

The <signal.h> header shall define the pthread_t, size_t, and uid_t types as described in <sys/types.h>.

The <signal.h> header shall define the timespec structure as described in <time.h>.

The <signal.h> header shall define the following data types:

  • sig_atomic_t โ€” Possibly volatile-qualified integer type of an object that can be accessed as an atomic entity, even in the presence of asynchronous interrupts.
  • sigset_t โ€” Integer or structure type of an object used to represent sets of signals.
  • pid_t โ€” As described in <sys/types.h>.

The <signal.h> header shall define the pthread_attr_t type as described in <sys/types.h>.

๐Ÿงš sigevent and sigval

The <signal.h> header shall define the sigevent structure, which shall include at least the following members:

    int              sigev_notify            Notification type.
    int              sigev_signo             Signal number.
    union sigval     sigev_value             Signal value.
    void           (*sigev_notify_function)(union sigval)
                                             Notification function.
    pthread_attr_t *sigev_notify_attributes  Notification attributes.

The <signal.h> header shall define the following symbolic constants for the values of sigev_notify:

  • SIGEV_NONE โ€” No asynchronous notification is delivered when the event of interest occurs.
  • SIGEV_SIGNAL โ€” A queued signal, with an application-defined value, is generated when the event of interest occurs.
  • SIGEV_THREAD โ€” A notification function is called to perform notification.

The sigval union shall be defined as:

    int    sival_int    Integer signal value.
    void  *sival_ptr    Pointer signal value.

๐Ÿ”ฅ SIGRTMIN / SIGRTMAX

The <signal.h> header shall declare the SIGRTMIN and SIGRTMAX macros, which shall expand to positive integer expressions with type int, but which need not be constant expressions. These macros specify a range of signal numbers that are reserved for application use and for which the realtime signal behavior specified in this volume of POSIX.1โ€2017 is supported. The signal numbers in this range do not overlap any of the signals specified in the following signal list.

The range SIGRTMIN through SIGRTMAX inclusive shall include at least {RTSIG_MAX} signal numbers.

It is implementation-defined whether realtime signal behavior is supported for other signals.

๐Ÿ’… Signal names, the iconic list

The <signal.h> header shall define the following macros that are used to refer to the signals that occur in the system. Signals defined here begin with the letters SIG followed by an uppercase letter. The macros shall expand to positive integer constant expressions with type int and distinct values. The value 0 is reserved for use as the null signal (see kill()). Additional implementation-defined signals may occur in the system.

The ISO C standard only requires the signal names SIGABRT, SIGFPE, SIGILL, SIGINT, SIGSEGV, and SIGTERM to be defined. An implementation need not generate any of these six signals, except as a result of explicit use of interfaces that generate signals, such as raise(), kill(), the General Terminal Interface (see Section 11.1.9, Special Characters), and the kill utility, unless otherwise stated (see, for example, the System Interfaces volume of POSIX.1โ€2017, Section 2.8.3.3, Memory Protection).

The following signals shall be supported on all implementations (default actions are explained below this signal list):

  • SIGABRT โ€” default action: A โ€” Process abort signal.
  • SIGALRM โ€” default action: T โ€” Alarm clock.
  • SIGBUS โ€” default action: A โ€” Access to an undefined portion of a memory object.
  • SIGCHLD โ€” default action: I โ€” Child process terminated, stopped, or continued.
  • SIGCONT โ€” default action: C โ€” Continue executing, if stopped.
  • SIGFPE โ€” default action: A โ€” Erroneous arithmetic operation.
  • SIGHUP โ€” default action: T โ€” Hangup.
  • SIGILL โ€” default action: A โ€” Illegal instruction.
  • SIGINT โ€” default action: T โ€” Terminal interrupt signal.
  • SIGKILL โ€” default action: T โ€” Kill (cannot be caught or ignored).
  • SIGPIPE โ€” default action: T โ€” Write on a pipe with no one to read it.
  • SIGQUIT โ€” default action: A โ€” Terminal quit signal.
  • SIGSEGV โ€” default action: A โ€” Invalid memory reference.
  • SIGSTOP โ€” default action: S โ€” Stop executing (cannot be caught or ignored).
  • SIGTERM โ€” default action: T โ€” Termination signal.
  • SIGTSTP โ€” default action: S โ€” Terminal stop signal.
  • SIGTTIN โ€” default action: S โ€” Background process attempting read.
  • SIGTTOU โ€” default action: S โ€” Background process attempting write.
  • SIGUSR1 โ€” default action: T โ€” User-defined signal 1.
  • SIGUSR2 โ€” default action: T โ€” User-defined signal 2.
  • SIGPOLL โ€” default action: T โ€” Pollable event.
  • SIGPROF โ€” default action: T โ€” Profiling timer expired.
  • SIGSYS โ€” default action: A โ€” Bad system call.
  • SIGTRAP โ€” default action: A โ€” Trace/breakpoint trap.
  • SIGURG โ€” default action: I โ€” High bandwidth data is available at a socket.
  • SIGVTALRM โ€” default action: T โ€” Virtual timer expired.
  • SIGXCPU โ€” default action: A โ€” CPU time limit exceeded.
  • SIGXFSZ โ€” default action: A โ€” File size limit exceeded.

๐Ÿซถ Default actions

The default actions are as follows:

  • T โ€” Abnormal termination of the process.
  • A โ€” Abnormal termination of the process with additional actions.
  • I โ€” Ignore the signal.
  • S โ€” Stop the process.
  • C โ€” Continue the process, if it is stopped; otherwise, ignore the signal.

The effects on the process in each case are described in the System Interfaces volume of POSIX.1โ€2017, Section 2.4.3, Signal Actions.

๐Ÿ˜ญ sigaction struct

The <signal.h> header shall declare the sigaction structure, which shall include at least the following members:

    void   (*sa_handler)(int)  Pointer to a signal-catching function
                               or one of the SIG_IGN or SIG_DFL.
    sigset_t sa_mask           Set of signals to be blocked during execution
                               of the signal handling function.
    int      sa_flags          Special flags.
    void   (*sa_sigaction)(int, siginfo_t *, void *)
                               Pointer to a signal-catching function.

The storage occupied by sa_handler and sa_sigaction may overlap, and a conforming application shall not use both simultaneously.

๐ŸŒธ SIG_BLOCK, SIG_UNBLOCK, SIG_SETMASK

The <signal.h> header shall define the following macros which shall expand to integer constant expressions that need not be usable in #if preprocessing directives:

  • SIG_BLOCK โ€” The resulting set is the union of the current set and the signal set pointed to by the argument set.
  • SIG_UNBLOCK โ€” The resulting set is the intersection of the current set and the complement of the signal set pointed to by the argument set.
  • SIG_SETMASK โ€” The resulting set is the signal set pointed to by the argument set.

๐Ÿ’œ SA_* and SS_* and stack constants

The <signal.h> header shall also define the following symbolic constants:

  • SA_NOCLDSTOP โ€” Do not generate SIGCHLD when children stop or stopped children continue.
  • SA_ONSTACK โ€” Causes signal delivery to occur on an alternate stack.
  • SA_RESETHAND โ€” Causes signal dispositions to be set to SIG_DFL on entry to signal handlers.
  • SA_RESTART โ€” Causes certain functions to become restartable.
  • SA_SIGINFO โ€” Causes extra information to be passed to signal handlers at the time of receipt of a signal.
  • SA_NOCLDWAIT โ€” Causes implementations not to create zombie processes or status information on child termination. See sigaction().
  • SA_NODEFER โ€” Causes signal not to be automatically blocked on entry to signal handler.
  • SS_ONSTACK โ€” Process is executing on an alternate signal stack.
  • SS_DISABLE โ€” Alternate signal stack is disabled.
  • MINSIGSTKSZ โ€” Minimum stack size for a signal handler.
  • SIGSTKSZ โ€” Default size in bytes for the alternate signal stack.

โญ mcontext_t

The <signal.h> header shall define the mcontext_t type through typedef.

okay so bestie, the <signal.h> header is still going off, and now it's defining ucontext_t as a structure that has to include at least these members, no cap:

ucontext_t *uc_link     Pointer to the context that is resumed
                        when this context returns.
sigset_t    uc_sigmask  The set of signals that are blocked when this
                        context is active.
stack_t     uc_stack    The stack used by this context.
mcontext_t  uc_mcontext A machine-specific representation of the saved
                        context.

then it also defines stack_t as a structure, which shall include at least these members, periodt:

void     *ss_sp       Stack base or pointer.
size_t    ss_size     Stack size.
int       ss_flags    Flags.

and siginfo_t? also a structure, at least these members, iykyk:

int           si_signo  Signal number.
int           si_code   Signal code.
int           si_errno  If non-zero, an errno value associated with
                        this signal, as described in <errno.h>.
pid_t         si_pid    Sending process ID.
uid_t         si_uid    Real user ID of sending process.
void         *si_addr   Address of faulting instruction.
int           si_status Exit value or signal.
long          si_band   Band event for SIGPOLL.
union sigval  si_value  Signal value.

so like, the header also defines the symbolic constants in the Code column of the table below, and you use them as values of si_code โ€” they're the reasons why the signal was generated, either signal-specific or non-signal-specific. let's break it down ๐Ÿ’…


SIGILL ๐Ÿ’€

  • ILL_ILLOPC โ€” Illegal opcode.
  • ILL_ILLOPN โ€” Illegal operand.
  • ILL_ILLADR โ€” Illegal addressing mode.
  • ILL_ILLTRP โ€” Illegal trap.
  • ILL_PRVOPC โ€” Privileged opcode.
  • ILL_PRVREG โ€” Privileged register.
  • ILL_COPROC โ€” Coprocessor error.
  • ILL_BADSTK โ€” Internal stack error.

SIGFPE ๐Ÿงฎ

  • FPE_INTDIV โ€” Integer divide by zero.
  • FPE_INTOVF โ€” Integer overflow.
  • FPE_FLTDIV โ€” Floating-point divide by zero.
  • FPE_FLTOVF โ€” Floating-point overflow.
  • FPE_FLTUND โ€” Floating-point underflow.
  • FPE_FLTRES โ€” Floating-point inexact result.
  • FPE_FLTINV โ€” Invalid floating-point operation.
  • FPE_FLTSUB โ€” Subscript out of range.

SIGSEGV ๐Ÿซ 

  • SEGV_MAPERR โ€” Address not mapped to object.
  • SEGV_ACCERR โ€” Invalid permissions for mapped object.

SIGBUS ๐ŸšŒ

  • BUS_ADRALN โ€” Invalid address alignment.
  • BUS_ADRERR โ€” Nonexistent physical address.
  • BUS_OBJERR โ€” Object-specific hardware error.

SIGTRAP ๐Ÿชค

  • TRAP_BRKPT โ€” Process breakpoint.
  • TRAP_TRACE โ€” Process trace trap.

SIGCHLD ๐Ÿ‘ถ

  • CLD_EXITED โ€” Child has exited.
  • CLD_KILLED โ€” Child has terminated abnormally and did not create a core file.
  • CLD_DUMPED โ€” Child has terminated abnormally and created a core file.
  • CLD_TRAPPED โ€” Traced child has trapped.
  • CLD_STOPPED โ€” Child has stopped.
  • CLD_CONTINUED โ€” Stopped child has continued.

SIGPOLL ๐Ÿ“ก

  • POLL_IN โ€” Data input available.
  • POLL_OUT โ€” Output buffers available.
  • POLL_MSG โ€” Input message available.
  • POLL_ERR โ€” I/O error.
  • POLL_PRI โ€” High priority input available.
  • POLL_HUP โ€” Device disconnected.

Any โœจ

  • SI_USER โ€” Signal sent by kill().
  • SI_QUEUE โ€” Signal sent by sigqueue().
  • SI_TIMER โ€” Signal generated by expiration of a timer set by timer_settime().
  • SI_ASYNCIO โ€” Signal generated by completion of an asynchronous I/O request.
  • SI_MESGQ โ€” Signal generated by arrival of a message on an empty message queue.

Implementations may support extra si_code values that are not in that list, and they may also generate values that are in the list under circumstances other than the ones described there. They may also have extensions or limitations that stop some of those values from ever being generated. But โ€” and this is the important bit โ€” implementations do not generate a different value from the ones described in that list for the circumstances described in that list. No cap. ๐Ÿ’…

On top of all that, the following signal-specific info has to be available too:

  • SIGILL, SIGFPE
    • void * si_addr โ€” the address of the faulting instruction.
  • SIGSEGV, SIGBUS
    • void * si_addr โ€” the address of the faulting memory reference.
  • SIGCHLD
    • pid_t si_pid โ€” the child process ID.
    • int si_status โ€” if si_code is equal to CLD_EXITED, then si_status holds the exit value of the process; otherwise it's equal to the signal that caused the process to change state. The exit value in si_status shall be equal to the full exit value (that is, the value passed to _exit(), _Exit(), or exit(), or returned from main()); it shall not be limited to the least significant eight bits of the value.
    • uid_t si_uid โ€” the real user ID of the process that sent the signal.
  • SIGPOLL
    • long si_band โ€” the band event for POLL_IN, POLL_OUT, or POLL_MSG.
Heads up bestie: for some implementations, the value of si_addr may be inaccurate. It's giving "close enough" energy. ๐Ÿ˜ญ

โœจ THE FUNCTIONS โœจ

The following shall be declared as functions, and they may also be defined as macros. Function prototypes shall be provided. Yes, all of them. Every single one. We're not skipping. ๐Ÿซถ

int    kill(pid_t, int);
int    killpg(pid_t, int);
void   psiginfo(const siginfo_t *, const char *);
void   psignal(int, const char *);
int    pthread_kill(pthread_t, int);
int    pthread_sigmask(int, const sigset_t *restrict,
           sigset_t *restrict);
int    raise(int);
int    sigaction(int, const struct sigaction *restrict,
           struct sigaction *restrict);
int    sigaddset(sigset_t *, int);
int    sigaltstack(const stack_t *restrict, stack_t *restrict);
int    sigdelset(sigset_t *, int);
int    sigemptyset(sigset_t *);
int    sigfillset(sigset_t *);
int    sighold(int);
int    sigignore(int);
int    siginterrupt(int, int);
int    sigismember(const sigset_t *, int);
void (*signal(int, void (*)(int)))(int);
int    sigpause(int);
int    sigpending(sigset_t *);
int    sigprocmask(int, const sigset_t *restrict, sigset_t *restrict);
int    sigqueue(pid_t, int, union sigval);
int    sigrelse(int);
void (*sigset(int, void (*)(int)))(int);
int    sigsuspend(const sigset_t *);
int    sigtimedwait(const sigset_t *restrict, siginfo_t *restrict,
           const struct timespec *restrict);
int    sigwait(const sigset_t *restrict, int *restrict);
int    sigwaitinfo(const sigset_t *restrict, siginfo_t *restrict);

Also, lowkey iconic behaviour: including the <signal.h> header may make visible all symbols from the <time.h> header. Surprise crossover episode. โญ

The following sections are informative. (That's fancy speak for "this part is the tea, not the rules." ๐Ÿ“)


๐ŸŒธ APPLICATION USAGE ๐ŸŒธ

Okay so listen. On systems that do not support the XSI option, the si_pid and si_uid members of siginfo_t are only required to be valid when si_code is SI_USER or SI_QUEUE.

On XSI-conforming systems, they're also valid for all si_code values less than or equal to 0. But plot twist: it is unspecified whether SI_USER and SI_QUEUE have values less than or equal to zero. So XSI applications should check whether si_code has the value SI_USER or SI_QUEUE, or is less than or equal to 0, to figure out whether si_pid and si_uid are valid. Check all the boxes, bestie, don't get caught lacking. ๐ŸŽ€


๐Ÿ’œ RATIONALE ๐Ÿ’œ

None.

(Not me, the actual manpage being like "no thoughts, head empty" about this one. Respect. ๐Ÿ™ˆ)


๐Ÿ”ฎ FUTURE DIRECTIONS ๐Ÿ”ฎ

The SIGPOLL and SIGPROF signals may be removed in a future version. So likeโ€ฆ don't build your whole personality around them, fr fr. ๐Ÿ’€


๐Ÿ‘‘ SEE ALSO ๐Ÿ‘‘

  • <errno.h>, <stropts.h>, <sys_types.h>, <time.h>

The System Interfaces volume of POSIX.1โ€2017, Section 2.2, The Compilation Environment, and then the whole squad: alarm(), ioctl(), kill(), killpg(), psiginfo(), pthread_kill(), pthread_sigmask(), raise(), sigaction(), sigaddset(), sigaltstack(), sigdelset(), sigemptyset(), sigfillset(), sighold(), siginterrupt(), sigismember(), signal(), sigpending(), sigqueue(), sigsuspend(), sigtimedwait(), sigwait(), timer_create(), wait(), waitid()

The Shell and Utilities volume of POSIX.1โ€2017: kill


Okay legal besties, this next part is sacred text and we do not touch it. Copying it exactly, character for character, periodt. โœจ

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html . Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .

and that's the whole page, bestie!! ๐Ÿฆ‹๐Ÿ’– This one came to you from IEEE/The Open Group, dated 2017, and it lives at signal.h(0P) โ€” go forth and signal responsibly, you absolute icon. ๐Ÿ‘‘๐ŸŒธ

๐Ÿ“ฆ where this page comes from