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