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