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