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. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)signal.h    8.4 (Berkeley) 5/4/95
  39  * $FreeBSD: src/sys/sys/signal.h,v 1.23.2.2 2001/04/19 01:38:35 alfred Exp $
  40  */
  41
  42 #ifndef _SYS_SIGNAL_H_
  43 #define _SYS_SIGNAL_H_
  44
  45 #include <machine/stdint.h>     /* for __ types */
  46 #include <sys/cdefs.h>
  47 #include <sys/_posix.h>
  48
  49 /*
  50  * sigset_t macros.
  51  */
  52 #define _SIG_WORDS      4
  53 #define _SIG_MAXSIG     128
  54 #define _SIG_IDX(sig)   ((sig) - 1)
  55 #define _SIG_WORD(sig)  (_SIG_IDX(sig) >> 5)
  56 #define _SIG_BIT(sig)   (1 << (_SIG_IDX(sig) & 31))
  57 #define _SIG_VALID(sig) ((sig) < _SIG_MAXSIG && (sig) > 0)
  58
  59 /*
  60  * System defined signals.
  61  */
  62 #define SIGHUP          1       /* hangup */
  63 #define SIGINT          2       /* interrupt */
  64 #define SIGQUIT         3       /* quit */
  65 #define SIGILL          4       /* illegal instr. (not reset when caught) */
  66 #ifndef _POSIX_SOURCE
  67 #define SIGTRAP         5       /* trace trap (not reset when caught) */
  68 #endif
  69 #define SIGABRT         6       /* abort() */
  70 #ifndef _POSIX_SOURCE
  71 #define SIGIOT          SIGABRT /* compatibility */
  72 #define SIGEMT          7       /* EMT instruction */
  73 #endif
  74 #define SIGFPE          8       /* floating point exception */
  75 #define SIGKILL         9       /* kill (cannot be caught or ignored) */
  76 #ifndef _POSIX_SOURCE
  77 #define SIGBUS          10      /* bus error */
  78 #endif
  79 #define SIGSEGV         11      /* segmentation violation */
  80 #ifndef _POSIX_SOURCE
  81 #define SIGSYS          12      /* non-existent system call invoked */
  82 #endif
  83 #define SIGPIPE         13      /* write on a pipe with no one to read it */
  84 #define SIGALRM         14      /* alarm clock */
  85 #define SIGTERM         15      /* software termination signal from kill */
  86 #ifndef _POSIX_SOURCE
  87 #define SIGURG          16      /* urgent condition on IO channel */
  88 #endif
  89 #define SIGSTOP         17      /* sendable stop signal not from tty */
  90 #define SIGTSTP         18      /* stop signal from tty */
  91 #define SIGCONT         19      /* continue a stopped process */
  92 #define SIGCHLD         20      /* to parent on child stop or exit */
  93 #define SIGTTIN         21      /* to readers pgrp upon background tty read */
  94 #define SIGTTOU         22      /* like TTIN if (tp->t_local&LTOSTOP) */
  95 #ifndef _POSIX_SOURCE
  96 #define SIGIO           23      /* input/output possible signal */
  97 #define SIGXCPU         24      /* exceeded CPU time limit */
  98 #define SIGXFSZ         25      /* exceeded file size limit */
  99 #define SIGVTALRM       26      /* virtual time alarm */
 100 #define SIGPROF         27      /* profiling time alarm */
 101 #define SIGWINCH        28      /* window size changes */
 102 #define SIGINFO         29      /* information request */
 103 #endif
 104 #define SIGUSR1         30      /* user defined signal 1 */
 105 #define SIGUSR2         31      /* user defined signal 2 */
 106 #if __BSD_VISIBLE
 107 #define SIGTHR          32      /* Thread interrupt (FreeBSD-5 reserved) */
 108 #define SIGCKPT         33      /* checkpoint and continue */
 109 #define SIGCKPTEXIT     34      /* checkpoint and exit */
 110 #endif
 111
 112 /*
 113  * si_code stuff
 114  */
 115 /* SIGILL */
 116 #define ILL_ILLOPC      1       /* Illegal opcode                       */
 117 #define ILL_ILLOPN      2       /* Illegal operand                      */
 118 #define ILL_ILLADR      3       /* Illegal addressing mode              */
 119 #define ILL_ILLTRP      4       /* Illegal trap                         */
 120 #define ILL_PRVOPC      5       /* Privileged opcode                    */
 121 #define ILL_PRVREG      6       /* Privileged register                  */
 122 #define ILL_COPROC      7       /* Coprocessor error                    */
 123 #define ILL_BADSTK      8       /* Internal stack error                 */
 124
 125 /* SIGFPE */
 126 #define FPE_INTOVF      1       /* Integer overflow                     */
 127 #define FPE_INTDIV      2       /* Integer divide by zero               */
 128 #define FPE_FLTDIV      3       /* Floating point divide by zero        */
 129 #define FPE_FLTOVF      4       /* Floating point overflow              */
 130 #define FPE_FLTUND      5       /* Floating point underflow             */
 131 #define FPE_FLTRES      6       /* Floating point inexact result        */
 132 #define FPE_FLTINV      7       /* Invalid Floating point operation     */
 133 #define FPE_FLTSUB      8       /* Subscript out of range               */
 134
 135 /* SIGSEGV */
 136 #define SEGV_MAPERR     1       /* Address not mapped to object         */
 137 #define SEGV_ACCERR     2       /* Invalid permissions for mapped object*/
 138
 139 /* SIGBUS */
 140 #define BUS_ADRALN      1       /* Invalid address alignment            */
 141 #define BUS_ADRERR      2       /* Non-existent physical address        */
 142 #define BUS_OBJERR      3       /* Object specific hardware error       */
 143
 144 /* SIGTRAP */
 145 #define TRAP_BRKPT      1       /* Process breakpoint                   */
 146 #define TRAP_TRACE      2       /* Process trace trap                   */
 147
 148 /* SIGCHLD */
 149 #define CLD_EXITED      1       /* Child has exited                     */
 150 #define CLD_KILLED      2       /* Child has terminated abnormally but  */
 151                                 /* did not create a core file           */
 152 #define CLD_DUMPED      3       /* Child has terminated abnormally and  */
 153                                 /* created a core file                  */
 154 #define CLD_TRAPPED     4       /* Traced child has trapped             */
 155 #define CLD_STOPPED     5       /* Child has stopped                    */
 156 #define CLD_CONTINUED   6       /* Stopped child has continued          */
 157
 158 /* SIGPOLL */
 159 #define POLL_IN         1       /* Data input available                 */
 160 #define POLL_OUT        2       /* Output buffers available             */
 161 #define POLL_MSG        3       /* Input message available              */
 162 #define POLL_ERR        4       /* I/O Error                            */
 163 #define POLL_PRI        5       /* High priority input available        */
 164 #define POLL_HUP        6       /* Device disconnected                  */
 165
 166
 167 /** si_code */
 168 #define SI_USER         0       /* Sent by kill(2)                      */
 169 #define SI_QUEUE        -1      /* Sent by the sigqueue(2)              */
 170 #define SI_TIMER        -2      /* Generated by expiration of a timer   */
 171                                 /* set by timer_settime(2)              */
 172 #define SI_ASYNCIO      -3      /* Generated by completion of an        */
 173                                 /* asynchronous I/O signal              */
 174 #define SI_MESGQ        -4      /* Generated by arrival of a message on */
 175                                 /* an empty message queue               */
 176
 177 /*-
 178  * Type of a signal handling function.
 179  *
 180  * Language spec sez signal handlers take exactly one arg, even though we
 181  * actually supply three.  Ugh!
 182  *
 183  * We don't try to hide the difference by leaving out the args because
 184  * that would cause warnings about conformant programs.  Nonconformant
 185  * programs can avoid the warnings by casting to (__sighandler_t *) or
 186  * sig_t before calling signal() or assigning to sa_handler or sv_handler.
 187  *
 188  * The kernel should reverse the cast before calling the function.  It
 189  * has no way to do this, but on most machines 1-arg and 3-arg functions
 190  * have the same calling protocol so there is no problem in practice.
 191  * A bit in sa_flags could be used to specify the number of args.
 192  *
 193  * SIG_EINTR causes system calls to interrupt but generates no signal
 194  * delivery.  The caller is responsible for polling the event.
 195  */
 196 typedef void __sighandler_t (int);
 197
 198 #define SIG_DFL         ((__sighandler_t *)0)
 199 #define SIG_IGN         ((__sighandler_t *)1)
 200 #define SIG_ERR         ((__sighandler_t *)-1)
 201
 202 #if defined(_P1003_1B_VISIBLE) || defined(_KERNEL)
 203 union sigval {
 204         /* Members as suggested by SuSv2 and IEEE Std 1003.1 */
 205         int     sival_int;
 206         void    *sival_ptr;
 207         /* Leave old members for backward compatibility */
 208         int     sigval_int;
 209         void    *sigval_ptr;
 210
 211 };
 212
 213 struct sigevent {
 214         int     sigev_notify;           /* Notification type */
 215         union {
 216                 int     __sigev_signo;  /* Signal number */
 217                 int     __sigev_notify_kqueue;
 218                 void    *__sigev_notify_attributes;
 219         } __sigev_u;
 220         union sigval sigev_value;       /* Signal value */
 221         void (*sigev_notify_function)(union sigval);
 222 };
 223 #define sigev_signo             __sigev_u.__sigev_signo
 224 #define sigev_notify_attributes __sigev_u.__sigev_notify_attributes
 225 #define sigev_notify_kqueue     __sigev_u.__sigev_notify_kqueue
 226
 227 #define SIGEV_NONE      0               /* No async notification */
 228 #define SIGEV_SIGNAL    1               /* Generate a queued signal */
 229 #define SIGEV_THREAD    2               /* Call back in a pthread */
 230 #define SIGEV_KEVENT    3               /* Generate a kevent */
 231
 232 typedef struct __siginfo {
 233         int     si_signo;               /* signal number */
 234         int     si_errno;               /* errno association */
 235         /*
 236          * Cause of signal, one of the SI_ macros or signal-specific
 237          * values, i.e. one of the FPE_... values for SIGFPE. This
 238          * value is equivalent to the second argument to an old-style
 239          * FreeBSD signal handler.
 240          */
 241         int     si_code;                /* signal code */
 242         int     si_pid;                 /* sending process */
 243         unsigned int si_uid;            /* sender's ruid */
 244         int     si_status;              /* exit value */
 245         void    *si_addr;               /* faulting instruction */
 246         union sigval si_value;          /* signal value */
 247         long    si_band;                /* band event for SIGPOLL */
 248         int     __spare__[7];           /* gimme some slack */
 249 } siginfo_t;
 250 #endif /* _P1003_1B_VISIBLE */
 251
 252 typedef struct __sigset {
 253         unsigned int    __bits[_SIG_WORDS];
 254 } sigset_t;
 255
 256 /*
 257  * XXX - there are some nasty dependencies on include file order. Now that
 258  * sigset_t has been defined we can include the MD header.
 259  */
 260 #include <machine/signal.h>     /* sig_atomic_t; trap codes; sigcontext */
 261
 262 #if !defined(_ANSI_SOURCE)
 263
 264 struct __siginfo;
 265
 266 /*
 267  * Signal vector "template" used in sigaction call.
 268  */
 269 struct  sigaction {
 270         union {
 271                 void    (*__sa_handler) (int);
 272                 void    (*__sa_sigaction) (int, struct __siginfo *, void *);
 273         } __sigaction_u;                /* signal handler */
 274         int     sa_flags;               /* see signal options below */
 275         sigset_t sa_mask;               /* signal mask to apply */
 276 };
 277
 278 /* if SA_SIGINFO is set, sa_sigaction is to be used instead of sa_handler. */
 279 #define sa_handler      __sigaction_u.__sa_handler
 280
 281 #define SA_NOCLDSTOP    0x0008  /* do not generate SIGCHLD on child stop */
 282
 283 #if !defined(_POSIX_SOURCE)
 284
 285 #define sa_sigaction    __sigaction_u.__sa_sigaction
 286
 287 #define SA_ONSTACK      0x0001  /* take signal on signal stack */
 288 #define SA_RESTART      0x0002  /* restart system call on signal return */
 289 #define SA_RESETHAND    0x0004  /* reset to SIG_DFL when taking signal */
 290 #define SA_NODEFER      0x0010  /* don't mask the signal we're delivering */
 291 #define SA_NOCLDWAIT    0x0020  /* don't keep zombies around */
 292 #define SA_SIGINFO      0x0040  /* signal handler with SA_SIGINFO args */
 293 #ifdef COMPAT_SUNOS
 294 #define SA_USERTRAMP    0x0100  /* do not bounce off kernel's sigtramp */
 295 #endif
 296
 297 #define NSIG            64      /* size of sigptbl */
 298
 299 /* Additional FreeBSD values. */
 300 #define SI_UNDEFINED    0
 301
 302 typedef void __siginfohandler_t (int, struct __siginfo *, void *);
 303
 304 typedef __sighandler_t  *sig_t; /* type of pointer to a signal function */
 305
 306 /*
 307  * Structure used in sigaltstack call.
 308  */
 309 typedef struct sigaltstack {
 310         char    *ss_sp;                 /* signal stack base */
 311         __size_t ss_size;               /* signal stack length */
 312         int     ss_flags;               /* SS_DISABLE and/or SS_ONSTACK */
 313 } stack_t;
 314
 315 #define SS_ONSTACK      0x0001  /* take signal on alternate stack */
 316 #define SS_DISABLE      0x0004  /* disable taking signals on alternate stack */
 317 #define MINSIGSTKSZ     8192                    /* minimum allowable stack */
 318 #define SIGSTKSZ        (MINSIGSTKSZ + 32768)   /* recommended stack size */
 319
 320 /* Have enough typedefs for this now.  XXX */
 321 #include <sys/ucontext.h>
 322
 323 /*
 324  * 4.3 compatibility:
 325  * Signal vector "template" used in sigvec call.
 326  */
 327 struct  sigvec {
 328         __sighandler_t *sv_handler;     /* signal handler */
 329         int     sv_mask;                /* signal mask to apply */
 330         int     sv_flags;               /* see signal options below */
 331 };
 332
 333 #define SV_ONSTACK      SA_ONSTACK
 334 #define SV_INTERRUPT    SA_RESTART      /* same bit, opposite sense */
 335 #define SV_RESETHAND    SA_RESETHAND
 336 #define SV_NODEFER      SA_NODEFER
 337 #define SV_NOCLDSTOP    SA_NOCLDSTOP
 338 #define SV_SIGINFO      SA_SIGINFO
 339 #define sv_onstack sv_flags     /* isn't compatibility wonderful! */
 340
 341 /*
 342  * Structure used in sigstack call.
 343  */
 344 struct  sigstack {
 345         char    *ss_sp;                 /* signal stack pointer */
 346         int     ss_onstack;             /* current status */
 347 };
 348
 349 /*
 350  * Macro for converting signal number to a mask suitable for
 351  * sigblock().
 352  */
 353 #define sigmask(m)      (1 << ((m)-1))
 354
 355 #define BADSIG          SIG_ERR
 356
 357 #endif /* !_POSIX_SOURCE */
 358
 359 /*
 360  * Flags for sigprocmask:
 361  */
 362 #define SIG_BLOCK       1       /* block specified signal set */
 363 #define SIG_UNBLOCK     2       /* unblock specified signal set */
 364 #define SIG_SETMASK     3       /* set specified signal set */
 365
 366 #endif /* !_ANSI_SOURCE */
 367
 368 /*
 369  * For historical reasons; programs expect signal's return value to be
 370  * defined by <sys/signal.h>.
 371  */
 372 __BEGIN_DECLS
 373 __sighandler_t *signal (int, __sighandler_t *);
 374 __END_DECLS
 375
 376 #endif  /* !_SYS_SIGNAL_H_ */