sys/sys/signal.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1989, 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)signal.h    8.4 (Berkeley) 5/4/95
  37  */
  38
  39 #ifndef _SYS_SIGNAL_H_
  40 #define _SYS_SIGNAL_H_
  41
  42 #include <sys/cdefs.h>
  43 #include <sys/_types.h>
  44 #include <sys/_sigset.h>
  45
  46 #include <machine/_limits.h>    /* __MINSIGSTKSZ */
  47 #include <machine/signal.h>     /* sig_atomic_t; trap codes; sigcontext */
  48
  49 #if __POSIX_VISIBLE >= 200809
  50
  51 #include <sys/_pthreadtypes.h>
  52 #include <sys/_timespec.h>
  53
  54 #ifndef _SIZE_T_DECLARED
  55 typedef __size_t        size_t;
  56 #define _SIZE_T_DECLARED
  57 #endif
  58
  59 #ifndef _UID_T_DECLARED
  60 typedef __uid_t         uid_t;
  61 #define _UID_T_DECLARED
  62 #endif
  63
  64 #endif /* __POSIX_VISIBLE >= 200809 */
  65
  66 /*
  67  * System defined signals.
  68  */
  69 #if __POSIX_VISIBLE || __XSI_VISIBLE
  70 #define SIGHUP          1       /* hangup */
  71 #endif
  72 #define SIGINT          2       /* interrupt */
  73 #if __POSIX_VISIBLE || __XSI_VISIBLE
  74 #define SIGQUIT         3       /* quit */
  75 #endif
  76 #define SIGILL          4       /* illegal instr. (not reset when caught) */
  77 #if __XSI_VISIBLE
  78 #define SIGTRAP         5       /* trace trap (not reset when caught) */
  79 #endif
  80 #define SIGABRT         6       /* abort() */
  81 #if __BSD_VISIBLE
  82 #define SIGIOT          SIGABRT /* compatibility */
  83 #define SIGEMT          7       /* EMT instruction */
  84 #endif
  85 #define SIGFPE          8       /* floating point exception */
  86 #if __POSIX_VISIBLE || __XSI_VISIBLE
  87 #define SIGKILL         9       /* kill (cannot be caught or ignored) */
  88 #endif
  89 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
  90 #define SIGBUS          10      /* bus error */
  91 #endif
  92 #define SIGSEGV         11      /* segmentation violation */
  93 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
  94 #define SIGSYS          12      /* non-existent system call invoked */
  95 #endif
  96 #if __POSIX_VISIBLE || __XSI_VISIBLE
  97 #define SIGPIPE         13      /* write on a pipe with no one to read it */
  98 #define SIGALRM         14      /* alarm clock */
  99 #endif
 100 #define SIGTERM         15      /* software termination signal from kill */
 101 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
 102 #define SIGURG          16      /* urgent condition on IO channel */
 103 #endif
 104 #if __POSIX_VISIBLE || __XSI_VISIBLE
 105 #define SIGSTOP         17      /* sendable stop signal not from tty */
 106 #define SIGTSTP         18      /* stop signal from tty */
 107 #define SIGCONT         19      /* continue a stopped process */
 108 #define SIGCHLD         20      /* to parent on child stop or exit */
 109 #define SIGTTIN         21      /* to readers pgrp upon background tty read */
 110 #define SIGTTOU         22      /* like TTIN if (tp->t_local&LTOSTOP) */
 111 #endif
 112 #if __BSD_VISIBLE
 113 #define SIGIO           23      /* input/output possible signal */
 114 #endif
 115 #if __XSI_VISIBLE
 116 #define SIGXCPU         24      /* exceeded CPU time limit */
 117 #define SIGXFSZ         25      /* exceeded file size limit */
 118 #define SIGVTALRM       26      /* virtual time alarm */
 119 #define SIGPROF         27      /* profiling time alarm */
 120 #endif
 121 #if __BSD_VISIBLE
 122 #define SIGWINCH        28      /* window size changes */
 123 #define SIGINFO         29      /* information request */
 124 #endif
 125 #if __POSIX_VISIBLE || __XSI_VISIBLE
 126 #define SIGUSR1         30      /* user defined signal 1 */
 127 #define SIGUSR2         31      /* user defined signal 2 */
 128 #endif
 129 #if __BSD_VISIBLE
 130 #define SIGTHR          32      /* reserved by thread library. */
 131 #define SIGLWP          SIGTHR
 132 #define SIGLIBRT        33      /* reserved by real-time library. */
 133 #endif
 134
 135 #define SIGRTMIN        65
 136 #define SIGRTMAX        126
 137
 138 #define SIG_DFL         ((__sighandler_t *)0)
 139 #define SIG_IGN         ((__sighandler_t *)1)
 140 #define SIG_ERR         ((__sighandler_t *)-1)
 141 /* #define      SIG_CATCH       ((__sighandler_t *)2) See signalvar.h */
 142 #define SIG_HOLD        ((__sighandler_t *)3)
 143
 144 /*
 145  * Type of a signal handling function.
 146  *
 147  * Language spec sez signal handlers take exactly one arg, even though we
 148  * actually supply three.  Ugh!
 149  *
 150  * We don't try to hide the difference by leaving out the args because
 151  * that would cause warnings about conformant programs.  Nonconformant
 152  * programs can avoid the warnings by casting to (__sighandler_t *) or
 153  * sig_t before calling signal() or assigning to sa_handler or sv_handler.
 154  *
 155  * The kernel should reverse the cast before calling the function.  It
 156  * has no way to do this, but on most machines 1-arg and 3-arg functions
 157  * have the same calling protocol so there is no problem in practice.
 158  * A bit in sa_flags could be used to specify the number of args.
 159  */
 160 typedef void __sighandler_t(int);
 161
 162 #if __POSIX_VISIBLE || __XSI_VISIBLE
 163 #ifndef _SIGSET_T_DECLARED
 164 #define _SIGSET_T_DECLARED
 165 typedef __sigset_t      sigset_t;
 166 #endif
 167 #endif
 168
 169 #if __POSIX_VISIBLE >= 199309 || __XSI_VISIBLE >= 500
 170 union sigval {
 171         /* Members as suggested by Annex C of POSIX 1003.1b. */
 172         int     sival_int;
 173         void    *sival_ptr;
 174         /* 6.0 compatibility */
 175         int     sigval_int;
 176         void    *sigval_ptr;
 177 };
 178
 179 #if defined(_WANT_LWPINFO32) || (defined(_KERNEL) && defined(__LP64__))
 180 union sigval32 {
 181         int     sival_int;
 182         uint32_t sival_ptr;
 183         /* 6.0 compatibility */
 184         int     sigval_int;
 185         uint32_t sigval_ptr;
 186 };
 187 #endif
 188 #endif
 189
 190 #if __POSIX_VISIBLE >= 199309
 191
 192 struct pthread_attr;
 193
 194 struct sigevent {
 195         int     sigev_notify;           /* Notification type */
 196         int     sigev_signo;            /* Signal number */
 197         union sigval sigev_value;       /* Signal value */
 198         union {
 199                 __lwpid_t       _threadid;
 200                 struct {
 201                         void (*_function)(union sigval);
 202                         struct pthread_attr **_attribute;
 203                 } _sigev_thread;
 204                 unsigned short _kevent_flags;
 205                 long __spare__[8];
 206         } _sigev_un;
 207 };
 208
 209 #if __BSD_VISIBLE
 210 #define sigev_notify_kqueue             sigev_signo
 211 #define sigev_notify_kevent_flags       _sigev_un._kevent_flags
 212 #define sigev_notify_thread_id          _sigev_un._threadid
 213 #endif
 214 #define sigev_notify_function           _sigev_un._sigev_thread._function
 215 #define sigev_notify_attributes         _sigev_un._sigev_thread._attribute
 216
 217 #define SIGEV_NONE      0               /* No async notification. */
 218 #define SIGEV_SIGNAL    1               /* Generate a queued signal. */
 219 #define SIGEV_THREAD    2               /* Call back from another pthread. */
 220 #if __BSD_VISIBLE
 221 #define SIGEV_KEVENT    3               /* Generate a kevent. */
 222 #define SIGEV_THREAD_ID 4               /* Send signal to a kernel thread. */
 223 #endif
 224
 225 #endif /* __POSIX_VISIBLE >= 199309 */
 226
 227 #if __POSIX_VISIBLE >= 199309 || __XSI_VISIBLE
 228 typedef struct __siginfo {
 229         int     si_signo;               /* signal number */
 230         int     si_errno;               /* errno association */
 231         /*
 232          * Cause of signal, one of the SI_ macros or signal-specific
 233          * values, i.e. one of the FPE_... values for SIGFPE.  This
 234          * value is equivalent to the second argument to an old-style
 235          * FreeBSD signal handler.
 236          */
 237         int     si_code;                /* signal code */
 238         __pid_t si_pid;                 /* sending process */
 239         __uid_t si_uid;                 /* sender's ruid */
 240         int     si_status;              /* exit value */
 241         void    *si_addr;               /* faulting instruction */
 242         union sigval si_value;          /* signal value */
 243         union   {
 244                 struct {
 245                         int     _trapno;/* machine specific trap code */
 246                 } _fault;
 247                 struct {
 248                         int     _timerid;
 249                         int     _overrun;
 250                 } _timer;
 251                 struct {
 252                         int     _mqd;
 253                 } _mesgq;
 254                 struct {
 255                         long    _band;          /* band event for SIGPOLL */
 256                 } _poll;                        /* was this ever used ? */
 257                 struct {
 258                         int     _syscall;       /* Syscall number for signals
 259                                                  * delivered as a result of
 260                                                  * system calls denied by
 261                                                  * Capsicum. */
 262                 } _capsicum;
 263                 struct {
 264                         long    __spare1__;
 265                         int     __spare2__[7];
 266                 } __spare__;
 267         } _reason;
 268 } siginfo_t;
 269
 270 #define si_trapno       _reason._fault._trapno
 271 #define si_timerid      _reason._timer._timerid
 272 #define si_overrun      _reason._timer._overrun
 273 #define si_mqd          _reason._mesgq._mqd
 274 #define si_band         _reason._poll._band
 275 #define si_syscall      _reason._capsicum._syscall
 276
 277 #if defined(_WANT_LWPINFO32) || (defined(_KERNEL) && defined(__LP64__))
 278 struct siginfo32 {
 279         int     si_signo;               /* signal number */
 280         int     si_errno;               /* errno association */
 281         int     si_code;                /* signal code */
 282         __pid_t si_pid;                 /* sending process */
 283         __uid_t si_uid;                 /* sender's ruid */
 284         int     si_status;              /* exit value */
 285         uint32_t si_addr;               /* faulting instruction */
 286         union sigval32 si_value;        /* signal value */
 287         union   {
 288                 struct {
 289                         int     _trapno;/* machine specific trap code */
 290                 } _fault;
 291                 struct {
 292                         int     _timerid;
 293                         int     _overrun;
 294                 } _timer;
 295                 struct {
 296                         int     _mqd;
 297                 } _mesgq;
 298                 struct {
 299                         int32_t _band;          /* band event for SIGPOLL */
 300                 } _poll;                        /* was this ever used ? */
 301                 struct {
 302                         int32_t __spare1__;
 303                         int     __spare2__[7];
 304                 } __spare__;
 305         } _reason;
 306 };
 307 #endif
 308
 309 /** si_code **/
 310 /* codes for SIGILL */
 311 #define ILL_ILLOPC      1       /* Illegal opcode.                      */
 312 #define ILL_ILLOPN      2       /* Illegal operand.                     */
 313 #define ILL_ILLADR      3       /* Illegal addressing mode.             */
 314 #define ILL_ILLTRP      4       /* Illegal trap.                        */
 315 #define ILL_PRVOPC      5       /* Privileged opcode.                   */
 316 #define ILL_PRVREG      6       /* Privileged register.                 */
 317 #define ILL_COPROC      7       /* Coprocessor error.                   */
 318 #define ILL_BADSTK      8       /* Internal stack error.                */
 319
 320 /* codes for SIGBUS */
 321 #define BUS_ADRALN      1       /* Invalid address alignment.           */
 322 #define BUS_ADRERR      2       /* Nonexistent physical address.        */
 323 #define BUS_OBJERR      3       /* Object-specific hardware error.      */
 324 #define BUS_OOMERR      100     /* Non-standard: No memory.             */
 325
 326 /* codes for SIGSEGV */
 327 #define SEGV_MAPERR     1       /* Address not mapped to object.        */
 328 #define SEGV_ACCERR     2       /* Invalid permissions for mapped       */
 329                                 /* object.                              */
 330 #define SEGV_PKUERR     100     /* x86: PKU violation                   */
 331
 332 /* codes for SIGFPE */
 333 #define FPE_INTOVF      1       /* Integer overflow.                    */
 334 #define FPE_INTDIV      2       /* Integer divide by zero.              */
 335 #define FPE_FLTDIV      3       /* Floating point divide by zero.       */
 336 #define FPE_FLTOVF      4       /* Floating point overflow.             */
 337 #define FPE_FLTUND      5       /* Floating point underflow.            */
 338 #define FPE_FLTRES      6       /* Floating point inexact result.       */
 339 #define FPE_FLTINV      7       /* Invalid floating point operation.    */
 340 #define FPE_FLTSUB      8       /* Subscript out of range.              */
 341 #define FPE_FLTIDO      9       /* Input denormal operation             */
 342
 343 /* codes for SIGTRAP */
 344 #define TRAP_BRKPT      1       /* Process breakpoint.                  */
 345 #define TRAP_TRACE      2       /* Process trace trap.                  */
 346 #define TRAP_DTRACE     3       /* DTrace induced trap.                 */
 347 #define TRAP_CAP        4       /* Capabilities protective trap.        */
 348
 349 /* codes for SIGCHLD */
 350 #define CLD_EXITED      1       /* Child has exited                     */
 351 #define CLD_KILLED      2       /* Child has terminated abnormally but  */
 352                                 /* did not create a core file           */
 353 #define CLD_DUMPED      3       /* Child has terminated abnormally and  */
 354                                 /* created a core file                  */
 355 #define CLD_TRAPPED     4       /* Traced child has trapped             */
 356 #define CLD_STOPPED     5       /* Child has stopped                    */
 357 #define CLD_CONTINUED   6       /* Stopped child has continued          */
 358
 359 /* codes for SIGPOLL */
 360 #define POLL_IN         1       /* Data input available                 */
 361 #define POLL_OUT        2       /* Output buffers available             */
 362 #define POLL_MSG        3       /* Input message available              */
 363 #define POLL_ERR        4       /* I/O Error                            */
 364 #define POLL_PRI        5       /* High priority input available        */
 365 #define POLL_HUP        6       /* Device disconnected                  */
 366
 367 #endif
 368
 369 #if __POSIX_VISIBLE || __XSI_VISIBLE
 370 struct __siginfo;
 371
 372 /*
 373  * Signal vector "template" used in sigaction call.
 374  */
 375 struct sigaction {
 376         union {
 377                 void    (*__sa_handler)(int);
 378                 void    (*__sa_sigaction)(int, struct __siginfo *, void *);
 379         } __sigaction_u;                /* signal handler */
 380         int     sa_flags;               /* see signal options below */
 381         sigset_t sa_mask;               /* signal mask to apply */
 382 };
 383
 384 #define sa_handler      __sigaction_u.__sa_handler
 385 #endif
 386
 387 #if __XSI_VISIBLE
 388 /* If SA_SIGINFO is set, sa_sigaction must be used instead of sa_handler. */
 389 #define sa_sigaction    __sigaction_u.__sa_sigaction
 390 #endif
 391
 392 #if __POSIX_VISIBLE || __XSI_VISIBLE
 393 #define SA_NOCLDSTOP    0x0008  /* do not generate SIGCHLD on child stop */
 394 #endif /* __POSIX_VISIBLE || __XSI_VISIBLE */
 395
 396 #if __XSI_VISIBLE
 397 #define SA_ONSTACK      0x0001  /* take signal on signal stack */
 398 #define SA_RESTART      0x0002  /* restart system call on signal return */
 399 #define SA_RESETHAND    0x0004  /* reset to SIG_DFL when taking signal */
 400 #define SA_NODEFER      0x0010  /* don't mask the signal we're delivering */
 401 #define SA_NOCLDWAIT    0x0020  /* don't keep zombies around */
 402 #define SA_SIGINFO      0x0040  /* signal handler with SA_SIGINFO args */
 403 #endif
 404
 405 #if __BSD_VISIBLE
 406 #define NSIG            32      /* number of old signals (counting 0) */
 407 #endif
 408
 409 #if __POSIX_VISIBLE || __XSI_VISIBLE
 410 #define SI_NOINFO       0               /* No signal info besides si_signo. */
 411 #define SI_USER         0x10001         /* Signal sent by kill(). */
 412 #define SI_QUEUE        0x10002         /* Signal sent by the sigqueue(). */
 413 #define SI_TIMER        0x10003         /* Signal generated by expiration of */
 414                                         /* a timer set by timer_settime(). */
 415 #define SI_ASYNCIO      0x10004         /* Signal generated by completion of */
 416                                         /* an asynchronous I/O request.*/
 417 #define SI_MESGQ        0x10005         /* Signal generated by arrival of a */
 418                                         /* message on an empty message queue. */
 419 #define SI_KERNEL       0x10006
 420 #define SI_LWP          0x10007         /* Signal sent by thr_kill */
 421 #endif
 422 #if __BSD_VISIBLE
 423 #define SI_UNDEFINED    0
 424 #endif
 425
 426 #if __BSD_VISIBLE
 427 typedef __sighandler_t  *sig_t; /* type of pointer to a signal function */
 428 typedef void __siginfohandler_t(int, struct __siginfo *, void *);
 429 #endif
 430
 431 #if __XSI_VISIBLE
 432 #if __BSD_VISIBLE
 433 #define __stack_t sigaltstack
 434 #endif
 435 typedef struct __stack_t stack_t;
 436
 437 #define SS_ONSTACK      0x0001  /* take signal on alternate stack */
 438 #define SS_DISABLE      0x0004  /* disable taking signals on alternate stack */
 439 #define MINSIGSTKSZ     __MINSIGSTKSZ           /* minimum stack size */
 440 #define SIGSTKSZ        (MINSIGSTKSZ + 32768)   /* recommended stack size */
 441 #endif
 442
 443 /*
 444  * Structure used in sigaltstack call.  Its definition is always
 445  * needed for __ucontext.  If __BSD_VISIBLE is defined, the structure
 446  * tag is actually sigaltstack.
 447  */
 448 struct __stack_t {
 449         void    *ss_sp;                 /* signal stack base */
 450         __size_t ss_size;               /* signal stack length */
 451         int     ss_flags;               /* SS_DISABLE and/or SS_ONSTACK */
 452 };
 453
 454 #if __BSD_VISIBLE
 455 /*
 456  * 4.3 compatibility:
 457  * Signal vector "template" used in sigvec call.
 458  */
 459 struct sigvec {
 460         __sighandler_t *sv_handler;     /* signal handler */
 461         int     sv_mask;                /* signal mask to apply */
 462         int     sv_flags;               /* see signal options below */
 463 };
 464
 465 #define SV_ONSTACK      SA_ONSTACK
 466 #define SV_INTERRUPT    SA_RESTART      /* same bit, opposite sense */
 467 #define SV_RESETHAND    SA_RESETHAND
 468 #define SV_NODEFER      SA_NODEFER
 469 #define SV_NOCLDSTOP    SA_NOCLDSTOP
 470 #define SV_SIGINFO      SA_SIGINFO
 471 #define sv_onstack      sv_flags        /* isn't compatibility wonderful! */
 472 #endif
 473
 474 /* Keep this in one place only */
 475 #if defined(_KERNEL) && defined(COMPAT_43) && \
 476     !defined(__i386__)
 477 struct osigcontext {
 478         int _not_used;
 479 };
 480 #endif
 481
 482 #if __XSI_VISIBLE
 483 /*
 484  * Structure used in sigstack call.
 485  */
 486 struct sigstack {
 487         void    *ss_sp;                 /* signal stack pointer */
 488         int     ss_onstack;             /* current status */
 489 };
 490 #endif
 491
 492 #if __BSD_VISIBLE || __POSIX_VISIBLE > 0 && __POSIX_VISIBLE <= 200112
 493 /*
 494  * Macro for converting signal number to a mask suitable for
 495  * sigblock().
 496  */
 497 #define sigmask(m)      (1 << ((m)-1))
 498 #endif
 499
 500 #if __BSD_VISIBLE
 501 #define BADSIG          SIG_ERR
 502 #endif
 503
 504 #if __POSIX_VISIBLE || __XSI_VISIBLE
 505 /*
 506  * Flags for sigprocmask:
 507  */
 508 #define SIG_BLOCK       1       /* block specified signal set */
 509 #define SIG_UNBLOCK     2       /* unblock specified signal set */
 510 #define SIG_SETMASK     3       /* set specified signal set */
 511 #endif
 512
 513 /*
 514  * For historical reasons; programs expect signal's return value to be
 515  * defined by <sys/signal.h>.
 516  */
 517 __BEGIN_DECLS
 518 __sighandler_t *signal(int, __sighandler_t *);
 519 __END_DECLS
 520
 521 #endif /* !_SYS_SIGNAL_H_ */