bsd/sys/signal.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  23 /*
  24  * Copyright (c) 1982, 1986, 1989, 1991, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  * (c) UNIX System Laboratories, Inc.
  27  * All or some portions of this file are derived from material licensed
  28  * to the University of California by American Telephone and Telegraph
  29  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  30  * the permission of UNIX System Laboratories, Inc.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  44  * 4. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  *
  60  *      @(#)signal.h    8.2 (Berkeley) 1/21/94
  61  */
  62
  63 #ifndef _SYS_SIGNAL_H_
  64 #define _SYS_SIGNAL_H_
  65
  66 #include <sys/appleapiopts.h>
  67
  68 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
  69 #define NSIG    32              /* counting 0; could be 33 (mask is 1-32) */
  70 #endif
  71
  72 #include <machine/signal.h>     /* sigcontext; codes for SIGILL, SIGFPE */
  73
  74 #define SIGHUP  1       /* hangup */
  75 #define SIGINT  2       /* interrupt */
  76 #define SIGQUIT 3       /* quit */
  77 #define SIGILL  4       /* illegal instruction (not reset when caught) */
  78 #if  !defined(_POSIX_SOURCE)
  79 #define SIGTRAP 5       /* trace trap (not reset when caught) */
  80 #endif
  81 #define SIGABRT 6       /* abort() */
  82 #if  !defined(_POSIX_SOURCE)
  83 #define SIGIOT  SIGABRT /* compatibility */
  84 #define SIGEMT  7       /* EMT instruction */
  85 #endif
  86 #define SIGFPE  8       /* floating point exception */
  87 #define SIGKILL 9       /* kill (cannot be caught or ignored) */
  88 #if  !defined(_POSIX_SOURCE)
  89 #define SIGBUS  10      /* bus error */
  90 #endif
  91 #define SIGSEGV 11      /* segmentation violation */
  92 #if  !defined(_POSIX_SOURCE)
  93 #define SIGSYS  12      /* bad argument to system call */
  94 #endif
  95 #define SIGPIPE 13      /* write on a pipe with no one to read it */
  96 #define SIGALRM 14      /* alarm clock */
  97 #define SIGTERM 15      /* software termination signal from kill */
  98 #if  !defined(_POSIX_SOURCE)
  99 #define SIGURG  16      /* urgent condition on IO channel */
 100 #endif
 101 #define SIGSTOP 17      /* sendable stop signal not from tty */
 102 #define SIGTSTP 18      /* stop signal from tty */
 103 #define SIGCONT 19      /* continue a stopped process */
 104 #define SIGCHLD 20      /* to parent on child stop or exit */
 105 #define SIGTTIN 21      /* to readers pgrp upon background tty read */
 106 #define SIGTTOU 22      /* like TTIN for output if (tp->t_local&LTOSTOP) */
 107 #if  !defined(_POSIX_SOURCE)
 108 #define SIGIO   23      /* input/output possible signal */
 109 #define SIGXCPU 24      /* exceeded CPU time limit */
 110 #define SIGXFSZ 25      /* exceeded file size limit */
 111 #define SIGVTALRM 26    /* virtual time alarm */
 112 #define SIGPROF 27      /* profiling time alarm */
 113 #define SIGWINCH 28     /* window size changes */
 114 #define SIGINFO 29      /* information request */
 115 #endif
 116 #define SIGUSR1 30      /* user defined signal 1 */
 117 #define SIGUSR2 31      /* user defined signal 2 */
 118
 119 #if defined(_ANSI_SOURCE) || defined(__cplusplus)
 120 /*
 121  * Language spec sez we must list exactly one parameter, even though we
 122  * actually supply three.  Ugh!
 123  */
 124 #define SIG_DFL         (void (*)(int))0
 125 #define SIG_IGN         (void (*)(int))1
 126 #define SIG_ERR         (void (*)(int))-1
 127 #else
 128 #define SIG_DFL         (void (*)())0
 129 #define SIG_IGN         (void (*)())1
 130 #define SIG_ERR         (void (*)())-1
 131 #endif
 132
 133 #ifndef _ANSI_SOURCE
 134 typedef unsigned int sigset_t;
 135
 136 union sigval {
 137         /* Members as suggested by Annex C of POSIX 1003.1b. */
 138         int     sigval_int;
 139         void    *sigval_ptr;
 140 };
 141
 142 #define SIGEV_NONE      0               /* No async notification */
 143 #ifdef __APPLE_API_PRIVATE
 144 #define SIGEV_SIGNAL    1               /* Generate a queued signal */
 145 #define SIGEV_THREAD    3               /* A notification function will be called to perfrom notification */
 146 #endif /*__APPLE_API_PRIVATE */
 147
 148 typedef struct __siginfo {
 149         int     si_signo;               /* signal number */
 150         int     si_errno;               /* errno association */
 151         int     si_code;                /* signal code */
 152         int     si_pid;                 /* sending process */
 153         unsigned int si_uid;            /* sender's ruid */
 154         int     si_status;              /* exit value */
 155         void    *si_addr;               /* faulting instruction */
 156         union sigval si_value;          /* signal value */
 157         long    si_band;                /* band event for SIGPOLL */
 158         int     pad[7];                 /* RFU */
 159 } siginfo_t;
 160
 161 /*
 162  * Incase of SIGILL and SIGFPE, si_addr contains the address of
 163  *  faulting instruction.
 164  * Incase of SIGSEGV and SIGBUS, si_addr contains address of
 165  *  faulting memory reference.
 166  * Incase of SIGCHLD, si_pid willhave child process ID,
 167  *  si_status will contain exit value or signal.
 168  *  si_uid contains real user ID of the process that sent the signal
 169  */
 170
 171 /* Values for si_code */
 172
 173 /* Codes for SIGILL */
 174 #define ILL_NOOP        0       /* if only I knew... */
 175 #define ILL_ILLOPC      1       /* illegal opcode */
 176 #define ILL_ILLTRP      2       /* illegal trap */
 177 #define ILL_PRVOPC      3       /* privileged opcode */
 178
 179 /* Codes for SIGFPE */
 180 #define FPE_NOOP        0       /* if only I knew... */
 181 #define FPE_FLTDIV      1       /* floating point divide by zero */
 182 #define FPE_FLTOVF      2       /* floating point overflow */
 183 #define FPE_FLTUND      3       /* floating point underflow */
 184 #define FPE_FLTRES      4       /* floating point inexact result */
 185 #define FPE_FLTINV      5       /* invalid floating point operation */
 186
 187 /* Codes for SIGSEGV */
 188 #define SEGV_NOOP       0       /* if only I knew... */
 189 #define SEGV_MAPERR     1       /* address not mapped to object */
 190 #define SEGV_ACCERR     2       /* invalid permissions for mapped to object */
 191
 192 /* Codes for SIGBUS */
 193 #define BUS_NOOP        0       /* if only I knew... */
 194 #define BUS_ADRALN      1       /* invalid address alignment */
 195
 196 /* Codes for SIGCHLD */
 197 #define CLD_NOOP        0       /* if only I knew... */
 198 #define CLD_EXITED      1       /* child has exited */
 199 #define CLD_KILLED      2
 200         /* child has terminated abnormally and did not create a core file */
 201 #define CLD_DUMPED      3
 202         /* child has terminated abnormally and create a core file */
 203 #define CLD_TRAPPED     4       /* traced child has trapped */
 204 #define CLD_STOPPED     5       /* child has stopped */
 205 #define CLD_CONTINUED   6       /* stopped child has continued */
 206
 207 /* union for signal handlers */
 208 union __sigaction_u {
 209         void    (*__sa_handler)(int);
 210         void    (*__sa_sigaction)(int, struct __siginfo *,
 211                        void *);
 212 };
 213
 214 /* Signal vector template for Kernel user boundary */
 215 struct  __sigaction {
 216         union __sigaction_u __sigaction_u;  /* signal handler */
 217         void    (*sa_tramp)(void *, int, int, siginfo_t *, void *);
 218         sigset_t sa_mask;               /* signal mask to apply */
 219         int     sa_flags;               /* see signal options below */
 220 };
 221
 222 /*
 223  * Signal vector "template" used in sigaction call.
 224  */
 225 struct  sigaction {
 226         union __sigaction_u __sigaction_u;  /* signal handler */
 227         sigset_t sa_mask;               /* signal mask to apply */
 228         int     sa_flags;               /* see signal options below */
 229 };
 230 /* if SA_SIGINFO is set, sa_sigaction is to be used instead of sa_handler. */
 231 #define sa_handler      __sigaction_u.__sa_handler
 232 #define sa_sigaction    __sigaction_u.__sa_sigaction
 233
 234
 235 #if  !defined(_POSIX_SOURCE)
 236 #define SA_ONSTACK      0x0001  /* take signal on signal stack */
 237 #define SA_RESTART      0x0002  /* restart system on signal return */
 238 #define SA_DISABLE      0x0004  /* disable taking signals on alternate stack */
 239 #define SA_RESETHAND    0x0004  /* reset to SIG_DFL when taking signal */
 240 #define SA_NODEFER      0x0010  /* don't mask the signal we're delivering */
 241 #define SA_NOCLDWAIT    0x0020  /* don't keep zombies around */
 242 #define SA_SIGINFO      0x0040  /* signal handler with SA_SIGINFO args */
 243 #define SA_USERTRAMP    0x0100  /* do not bounce off kernel's sigtramp */
 244 #endif
 245 #define SA_NOCLDSTOP    0x0008  /* do not generate SIGCHLD on child stop */
 246
 247 /*
 248  * Flags for sigprocmask:
 249  */
 250 #define SIG_BLOCK       1       /* block specified signal set */
 251 #define SIG_UNBLOCK     2       /* unblock specified signal set */
 252 #define SIG_SETMASK     3       /* set specified signal set */
 253
 254 /* POSIX 1003.1b required values. */
 255 #define SI_USER         0x10001
 256 #define SI_QUEUE        0x10002
 257 #define SI_TIMER        0x10003
 258 #define SI_ASYNCIO      0x10004
 259 #define SI_MESGQ        0x10005
 260
 261 #if !defined(_POSIX_SOURCE)
 262 #include <sys/cdefs.h>
 263 typedef void (*sig_t) __P((int));       /* type of signal function */
 264
 265 /*
 266  * Structure used in sigaltstack call.
 267  */
 268 struct  sigaltstack {
 269         char    *ss_sp;         /* signal stack base */
 270         int     ss_size;                /* signal stack length */
 271         int     ss_flags;               /* SA_DISABLE and/or SA_ONSTACK */
 272 };
 273
 274 typedef struct  sigaltstack stack_t;
 275
 276 #define SS_ONSTACK      0x0001  /* take signal on signal stack */
 277 #define SS_DISABLE      0x0004  /* disable taking signals on alternate stack */
 278 #define MINSIGSTKSZ     8192                    /* minimum allowable stack */
 279 #define SIGSTKSZ        (MINSIGSTKSZ + 32768)   /* recommended stack size */
 280
 281 /*
 282  * 4.3 compatibility:
 283  * Signal vector "template" used in sigvec call.
 284  */
 285 struct  sigvec {
 286         void    (*sv_handler)(int);     /* signal handler */
 287         int     sv_mask;                /* signal mask to apply */
 288         int     sv_flags;               /* see signal options below */
 289 };
 290
 291 #define SV_ONSTACK      SA_ONSTACK
 292 #define SV_INTERRUPT    SA_RESTART      /* same bit, opposite sense */
 293 #define SV_RESETHAND    SA_RESETHAND
 294 #define SV_NODEFER      SA_NODEFER
 295 #define SV_NOCLDSTOP    SA_NOCLDSTOP
 296 #define SV_SIGINFO      SA_SIGINFO
 297
 298 #define sv_onstack sv_flags     /* isn't compatibility wonderful! */
 299
 300 /*
 301  * Structure used in sigstack call.
 302  */
 303 struct  sigstack {
 304         char    *ss_sp;                 /* signal stack pointer */
 305         int     ss_onstack;             /* current status */
 306 };
 307
 308 /*
 309  * Macro for converting signal number to a mask suitable for
 310  * sigblock().
 311  */
 312 #define sigmask(m)      (1 << ((m)-1))
 313
 314 #ifdef  KERNEL
 315 #ifdef __APPLE_API_PRIVATE
 316 /*
 317  *      signals delivered on a per-thread basis.
 318  */
 319 #define threadmask (sigmask(SIGILL)|sigmask(SIGTRAP)|\
 320                     sigmask(SIGIOT)|sigmask(SIGEMT)|\
 321                     sigmask(SIGFPE)|sigmask(SIGBUS)|\
 322                     sigmask(SIGSEGV)|sigmask(SIGSYS)|\
 323                     sigmask(SIGPIPE))
 324 #endif /* __APPLE_API_PRIVATE */
 325 #endif  /* KERNEL */
 326
 327 #define BADSIG          SIG_ERR
 328
 329 #endif  /* !_POSIX_SOURCE */
 330 #endif  /* !_ANSI_SOURCE */
 331
 332 /*
 333  * For historical reasons; programs expect signal's return value to be
 334  * defined by <sys/signal.h>.
 335  */
 336 __BEGIN_DECLS
 337 void    (*signal __P((int, void (*) __P((int))))) __P((int));
 338 __END_DECLS
 339 #endif  /* !_SYS_SIGNAL_H_ */