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