sys/sys/signal.h

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