root/sys/sys/signal.h
/*
 * Copyright (c) 1982, 1986, 1989, 1991, 1993
 *      The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      @(#)signal.h    8.4 (Berkeley) 5/4/95
 * $FreeBSD: src/sys/sys/signal.h,v 1.23.2.2 2001/04/19 01:38:35 alfred Exp $
 */

#ifndef _SYS_SIGNAL_H_
#define _SYS_SIGNAL_H_

#include <sys/cdefs.h>
#include <sys/_siginfo.h>
#include <sys/_sigset.h>
#include <machine/stdint.h>

#ifndef _PID_T_DECLARED
typedef __pid_t         pid_t;
#define _PID_T_DECLARED
#endif

#ifndef _SIZE_T_DECLARED
typedef __size_t        size_t;
#define _SIZE_T_DECLARED
#endif

#ifndef _UID_T_DECLARED
typedef __uint32_t      uid_t;
#define _UID_T_DECLARED
#endif

/*
 * sigset_t macros.
 */
#define _SIG_MAXSIG     128
#define _SIG_IDX(sig)   ((sig) - 1)
#define _SIG_WORD(sig)  (_SIG_IDX(sig) >> 5)
#define _SIG_BIT(sig)   (1 << (_SIG_IDX(sig) & 31))
#define _SIG_VALID(sig) ((sig) < _SIG_MAXSIG && (sig) > 0)

/*
 * System defined signals.
 */
#if __POSIX_VISIBLE
#define SIGHUP          1       /* hangup */
#endif
#define SIGINT          2       /* interrupt */
#if __POSIX_VISIBLE
#define SIGQUIT         3       /* quit */
#endif
#define SIGILL          4       /* illegal instr. (not reset when caught) */
#if __XSI_VISIBLE
#define SIGTRAP         5       /* trace trap (not reset when caught) */
#endif
#define SIGABRT         6       /* abort() */
#if __BSD_VISIBLE
#define SIGIOT          SIGABRT /* compatibility */
#define SIGEMT          7       /* EMT instruction */
#endif
#define SIGFPE          8       /* floating point exception */
#if __POSIX_VISIBLE
#define SIGKILL         9       /* kill (cannot be caught or ignored) */
#endif
#if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
#define SIGBUS          10      /* bus error */
#endif
#define SIGSEGV         11      /* segmentation violation */
#if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
#define SIGSYS          12      /* non-existent system call invoked */
#endif
#if __POSIX_VISIBLE
#define SIGPIPE         13      /* write on a pipe with no one to read it */
#define SIGALRM         14      /* alarm clock */
#endif
#define SIGTERM         15      /* software termination signal from kill */
#if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
#define SIGURG          16      /* urgent condition on IO channel */
#endif
#if __POSIX_VISIBLE
#define SIGSTOP         17      /* sendable stop signal not from tty */
#define SIGTSTP         18      /* stop signal from tty */
#define SIGCONT         19      /* continue a stopped process */
#define SIGCHLD         20      /* to parent on child stop or exit */
#define SIGTTIN         21      /* to readers pgrp upon background tty read */
#define SIGTTOU         22      /* like TTIN if (tp->t_local&LTOSTOP) */
#endif
#if __BSD_VISIBLE
#define SIGIO           23      /* input/output possible signal */
#endif
#if __XSI_VISIBLE
#define SIGXCPU         24      /* exceeded CPU time limit */
#define SIGXFSZ         25      /* exceeded file size limit */
#define SIGVTALRM       26      /* virtual time alarm */
#define SIGPROF         27      /* profiling time alarm */
#endif
#if __BSD_VISIBLE
#define SIGWINCH        28      /* window size changes */
#define SIGINFO         29      /* information request */
#endif
#if __POSIX_VISIBLE
#define SIGUSR1         30      /* user defined signal 1 */
#define SIGUSR2         31      /* user defined signal 2 */
#endif
#if __BSD_VISIBLE
#define SIGTHR          32      /* Thread interrupt (FreeBSD-5 reserved) */
#define SIGCKPT         33      /* checkpoint and continue */
#define SIGCKPTEXIT     34      /* checkpoint and exit */
#endif

#define SIGRTMIN        65      /* min realtime signal */
#define SIGRTMAX        126     /* max realtime signal */

/*-
 * Type of a signal handling function.
 *
 * Language spec sez signal handlers take exactly one arg, even though we
 * actually supply three.  Ugh!
 *
 * We don't try to hide the difference by leaving out the args because
 * that would cause warnings about conformant programs.  Nonconformant
 * programs can avoid the warnings by casting to (__sighandler_t *) or
 * sig_t before calling signal() or assigning to sa_handler or sv_handler.
 *
 * The kernel should reverse the cast before calling the function.  It
 * has no way to do this, but on most machines 1-arg and 3-arg functions
 * have the same calling protocol so there is no problem in practice.
 * A bit in sa_flags could be used to specify the number of args.
 *
 * SIG_EINTR causes system calls to interrupt but generates no signal
 * delivery.  The caller is responsible for polling the event.
 */
typedef void __sighandler_t (int);

#define SIG_DFL         ((__sighandler_t *)0)
#define SIG_IGN         ((__sighandler_t *)1)
#define SIG_ERR         ((__sighandler_t *)-1)

#if __POSIX_VISIBLE >= 199309
#if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
#ifndef _PTHREAD_ATTR_T_DECLARED
struct __pthread_attr_s;
typedef struct __pthread_attr_s         *pthread_attr_t;
#define _PTHREAD_ATTR_T_DECLARED
#endif
#endif

struct sigevent {
        int     sigev_notify;           /* Notification type */
        union {
                int     __sigev_signo;  /* Signal number */
                int     __sigev_notify_kqueue;
#ifdef _KERNEL
                void    *__sigev_notify_attributes;
#else
                pthread_attr_t *__sigev_notify_attributes;
#endif
        } __sigev_u;
        union sigval sigev_value;       /* Signal value */
        void (*sigev_notify_function)(union sigval);
};
#define sigev_signo             __sigev_u.__sigev_signo
#define sigev_notify_attributes __sigev_u.__sigev_notify_attributes
#if __BSD_VISIBLE
#define sigev_notify_kqueue     __sigev_u.__sigev_notify_kqueue
#endif

#define SIGEV_NONE      0               /* No async notification */
#define SIGEV_SIGNAL    1               /* Generate a queued signal */
#define SIGEV_THREAD    2               /* Call back in a pthread */
#if __BSD_VISIBLE
#define SIGEV_KEVENT    3               /* Generate a kevent */
#endif
#endif /* __POSIX_VISIBLE >= 199309 */

#ifndef _SIGSET_T_DECLARED
typedef struct __sigset sigset_t;
#define _SIGSET_T_DECLARED
#endif

/*
 * XXX - there are some nasty dependencies on include file order. Now that
 * sigset_t has been defined we can include the MD header.
 */
#include <machine/signal.h>     /* sig_atomic_t; trap codes; sigcontext */

#if __POSIX_VISIBLE
struct __siginfo;

/*
 * Signal vector "template" used in sigaction call.
 */
struct  sigaction {
        union {
                void    (*__sa_handler) (int);
                void    (*__sa_sigaction) (int, struct __siginfo *, void *);
        } __sigaction_u;                /* signal handler */
        int     sa_flags;               /* see signal options below */
        sigset_t sa_mask;               /* signal mask to apply */
};

/* if SA_SIGINFO is set, sa_sigaction is to be used instead of sa_handler. */
#define sa_handler      __sigaction_u.__sa_handler

#define SA_NOCLDSTOP    0x0008  /* do not generate SIGCHLD on child stop */
#endif /* __POSIX_VISIBLE */

#if __XSI_VISIBLE
#define sa_sigaction    __sigaction_u.__sa_sigaction
#endif

#if __XSI_VISIBLE
#define SA_ONSTACK      0x0001  /* take signal on signal stack */
#define SA_RESTART      0x0002  /* restart system call on signal return */
#define SA_RESETHAND    0x0004  /* reset to SIG_DFL when taking signal */
#define SA_NODEFER      0x0010  /* don't mask the signal we're delivering */
#define SA_NOCLDWAIT    0x0020  /* don't keep zombies around */
#define SA_SIGINFO      0x0040  /* signal handler with SA_SIGINFO args */
#endif

#if __BSD_VISIBLE
#define NSIG            64      /* size of sigptbl */

/* Additional FreeBSD values. */
#define SI_UNDEFINED    0

typedef void __siginfohandler_t (int, siginfo_t *, void *);

typedef __sighandler_t  *sig_t; /* type of pointer to a signal function */
#endif

#define SS_ONSTACK      0x0001  /* take signal on alternate stack */
#define SS_DISABLE      0x0004  /* disable taking signals on alternate stack */
#define MINSIGSTKSZ     8192                    /* minimum allowable stack */
#define SIGSTKSZ        (MINSIGSTKSZ + 32768)   /* recommended stack size */

#ifdef _KERNEL
#include <sys/ucontext.h>
#elif __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
#include <sys/_ucontext.h>
#endif

#if __BSD_VISIBLE
/*
 * 4.3 compatibility:
 * Signal vector "template" used in sigvec call.
 */
struct  sigvec {
        __sighandler_t *sv_handler;     /* signal handler */
        int     sv_mask;                /* signal mask to apply */
        int     sv_flags;               /* see signal options below */
};

#define SV_ONSTACK      SA_ONSTACK
#define SV_INTERRUPT    SA_RESTART      /* same bit, opposite sense */
#define SV_RESETHAND    SA_RESETHAND
#define SV_NODEFER      SA_NODEFER
#define SV_NOCLDSTOP    SA_NOCLDSTOP
#define SV_SIGINFO      SA_SIGINFO
#define sv_onstack      sv_flags        /* isn't compatibility wonderful! */

/*
 * Macro for converting signal number to a mask suitable for
 * sigblock().
 */
#define sigmask(m)      (1 << ((m)-1))

#define BADSIG          SIG_ERR
#endif /* __BSD_VISIBLE */

#if __POSIX_VISIBLE
/*
 * Flags for sigprocmask:
 */
#define SIG_BLOCK       1       /* block specified signal set */
#define SIG_UNBLOCK     2       /* unblock specified signal set */
#define SIG_SETMASK     3       /* set specified signal set */
#endif

/*
 * For historical reasons, programs expect signal's return value to be
 * defined by <sys/signal.h>.
 */
__BEGIN_DECLS
__sighandler_t *signal(int, __sighandler_t *);
#if __BSD_VISIBLE
int sigblockall(void);
int sigunblockall(void);
#endif
__END_DECLS

#endif  /* !_SYS_SIGNAL_H_ */