Define siginfo_t in signal.h for XPG4 (bug 14835).
[platform/upstream/glibc.git] / signal / signal.h
index 015f0f0..36720d4 100644 (file)
-/* Copyright (C) 1991,92,93,94,95,96,97,98 Free Software Foundation, Inc.
+/* Copyright (C) 1991-2004,2007,2009,2010,2012 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Library General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
    The GNU C Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Library General Public License for more details.
+   Lesser General Public License for more details.
 
-   You should have received a copy of the GNU Library General Public
-   License along with the GNU C Library; see the file COPYING.LIB.  If not,
-   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, see
+   <http://www.gnu.org/licenses/>.  */
 
 /*
- *     ISO C Standard: 4.7 SIGNAL HANDLING <signal.h>
+ *     ISO C99 Standard: 7.14 Signal handling <signal.h>
  */
 
 #ifndef        _SIGNAL_H
 
 #if !defined __need_sig_atomic_t && !defined __need_sigset_t
-# define _SIGNAL_H     1
-# include <features.h>
+# define _SIGNAL_H
 #endif
 
+#include <features.h>
+
 __BEGIN_DECLS
 
-#include <bits/types.h>
 #include <bits/sigset.h>               /* __sigset_t, __sig_atomic_t.  */
 
-#if defined _SIGNAL_H && defined __USE_UNIX98 && !defined pid_t
-typedef __pid_t pid_t;
-# define pid_t pid_t
-#endif /* Unix98 */
-
-#if !defined __sig_atomic_t_defined \
-    && (defined _SIGNAL_H || defined __need_sig_atomic_t)
 /* An integral type that can be modified atomically, without the
    possibility of a signal arriving in the middle of the operation.  */
+#if defined __need_sig_atomic_t || defined _SIGNAL_H
+# ifndef __sig_atomic_t_defined
+#  define __sig_atomic_t_defined
+__BEGIN_NAMESPACE_STD
 typedef __sig_atomic_t sig_atomic_t;
-# define __sig_atomic_t_defined
-#endif /* `sig_atomic_t' undefined and <signal.h> or need `sig_atomic_t'.  */
-#undef __need_sig_atomic_t
+__END_NAMESPACE_STD
+# endif
+# undef __need_sig_atomic_t
+#endif
+
+#if defined __need_sigset_t || (defined _SIGNAL_H && defined __USE_POSIX)
+# ifndef __sigset_t_defined
+#  define __sigset_t_defined
+typedef __sigset_t sigset_t;
+# endif
+# undef __need_sigset_t
+#endif
 
 #ifdef _SIGNAL_H
 
+#include <bits/types.h>
 #include <bits/signum.h>
 
+#if defined __USE_XOPEN || defined __USE_XOPEN2K
+# ifndef __pid_t_defined
+typedef __pid_t pid_t;
+#  define __pid_t_defined
+#endif
+#ifdef __USE_XOPEN
+# endif
+# ifndef __uid_t_defined
+typedef __uid_t uid_t;
+#  define __uid_t_defined
+# endif
+#endif /* Unix98 */
+
+#ifdef __USE_POSIX199309
+/* We need `struct timespec' later on.  */
+# define __need_timespec
+# include <time.h>
+#endif
+
+#if defined __USE_POSIX199309 || defined __USE_XOPEN_EXTENDED
+/* Get the `siginfo_t' type plus the needed symbols.  */
+# include <bits/siginfo.h>
+#endif
+
+
 /* Type of a signal handler.  */
-typedef void (*__sighandler_t) __P ((int));
+typedef void (*__sighandler_t) (int);
 
 /* The X/Open definition of `signal' specifies the SVID semantic.  Use
    the additional function `sysv_signal' when X/Open compatibility is
    requested.  */
-extern __sighandler_t __sysv_signal __P ((int __sig,
-                                         __sighandler_t __handler));
+extern __sighandler_t __sysv_signal (int __sig, __sighandler_t __handler)
+     __THROW;
+#ifdef __USE_GNU
+extern __sighandler_t sysv_signal (int __sig, __sighandler_t __handler)
+     __THROW;
+#endif
 
 /* Set the handler for the signal SIG to HANDLER, returning the old
    handler, or SIG_ERR on error.
    By default `signal' has the BSD semantic.  */
+__BEGIN_NAMESPACE_STD
 #ifdef __USE_BSD
-extern __sighandler_t signal __P ((int __sig, __sighandler_t __handler));
+extern __sighandler_t signal (int __sig, __sighandler_t __handler)
+     __THROW;
 #else
-/* Make sure the used `signal' implementation is the SVID version.
-   When GNU CC is used we have a clean way to write this.  */
-# if defined __GNUC__ && __GNUC__ >= 2
-extern __sighandler_t signal __P ((int __sig, __sighandler_t __handler))
-     __asm__ ("__sysv_signal");
+/* Make sure the used `signal' implementation is the SVID version. */
+# ifdef __REDIRECT_NTH
+extern __sighandler_t __REDIRECT_NTH (signal,
+                                     (int __sig, __sighandler_t __handler),
+                                     __sysv_signal);
 # else
-#  define signal(sig, handler) __sysv_signal ((sig), (handler))
+#  define signal __sysv_signal
 # endif
 #endif
+__END_NAMESPACE_STD
 
 #ifdef __USE_XOPEN
 /* The X/Open definition of `signal' conflicts with the BSD version.
    So they defined another function `bsd_signal'.  */
-extern __sighandler_t __bsd_signal __P ((int __sig, __sighandler_t __handler));
-extern __sighandler_t bsd_signal __P ((int __sig, __sighandler_t __handler));
+extern __sighandler_t bsd_signal (int __sig, __sighandler_t __handler)
+     __THROW;
 #endif
 
 /* Send signal SIG to process number PID.  If PID is zero,
    send SIG to all processes in the current process's process group.
    If PID is < -1, send SIG to all processes in process group - PID.  */
-extern int __kill __P ((__pid_t __pid, int __sig));
 #ifdef __USE_POSIX
-extern int kill __P ((__pid_t __pid, int __sig));
+extern int kill (__pid_t __pid, int __sig) __THROW;
 #endif /* Use POSIX.  */
 
 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 /* Send SIG to all processes in process group PGRP.
    If PGRP is zero, send SIG to all processes in
    the current process's process group.  */
-extern int killpg __P ((__pid_t __pgrp, int __sig));
+extern int killpg (__pid_t __pgrp, int __sig) __THROW;
 #endif /* Use BSD || X/Open Unix.  */
 
+__BEGIN_NAMESPACE_STD
 /* Raise signal SIG, i.e., send SIG to yourself.  */
-extern int raise __P ((int __sig));
+extern int raise (int __sig) __THROW;
+__END_NAMESPACE_STD
 
 #ifdef __USE_SVID
 /* SVID names for the same things.  */
-extern __sighandler_t ssignal __P ((int __sig, __sighandler_t __handler));
-extern int gsignal __P ((int __sig));
+extern __sighandler_t ssignal (int __sig, __sighandler_t __handler)
+     __THROW;
+extern int gsignal (int __sig) __THROW;
 #endif /* Use SVID.  */
 
-#ifdef __USE_MISC
+#if defined __USE_MISC || defined __USE_XOPEN2K
 /* Print a message describing the meaning of the given signal number.  */
-extern void psignal __P ((int __sig, __const char *__s));
-#endif /* Use misc.  */
-
+extern void psignal (int __sig, const char *__s);
+#endif /* Use misc or POSIX 2008.  */
 
-/* Block signals in MASK, returning the old mask.  */
-extern int __sigblock __P ((int __mask));
+#ifdef __USE_XOPEN2K
+/* Print a message describing the meaning of the given signal information.  */
+extern void psiginfo (const siginfo_t *__pinfo, const char *__s);
+#endif /* POSIX 2008.  */
 
-/* Set the mask of blocked signals to MASK, returning the old mask.  */
-extern int __sigsetmask __P ((int __mask));
 
 
 /* The `sigpause' function has two different interfaces.  The original
    BSD definition defines the argument as a mask of the signal, while
    the more modern interface in X/Open defines it as the signal
    number.  We go with the BSD version unless the user explicitly
-   selects the X/Open version.  */
-extern int __sigpause __P ((int __sig_or_mask, int __is_sig));
+   selects the X/Open version.
 
-#if defined __USE_BSD || defined __USE_GNU
+   This function is a cancellation point and therefore not marked with
+   __THROW.  */
+extern int __sigpause (int __sig_or_mask, int __is_sig);
+
+#ifdef __FAVOR_BSD
 /* Set the mask of blocked signals to MASK,
    wait for a signal to arrive, and then restore the mask.  */
-extern int sigpause __P ((int __mask));
-# define sigpause(mask) __sigpause ((mask), 0)
+extern int sigpause (int __mask) __THROW __attribute_deprecated__;
 #else
 # ifdef __USE_XOPEN
+#  ifdef __GNUC__
+extern int sigpause (int __sig) __asm__ ("__xpg_sigpause");
+#  else
 /* Remove a signal from the signal mask and suspend the process.  */
-#  define sigpause(sig) __sigpause ((sig), 1)
+#   define sigpause(sig) __sigpause ((sig), 1)
+#  endif
 # endif
 #endif
 
 
 #ifdef __USE_BSD
+/* None of the following functions should be used anymore.  They are here
+   only for compatibility.  A single word (`int') is not guaranteed to be
+   enough to hold a complete signal mask and therefore these functions
+   simply do not work in many situations.  Use `sigprocmask' instead.  */
+
+/* Compute mask for signal SIG.  */
 # define sigmask(sig)  __sigmask(sig)
 
-extern int sigblock __P ((int __mask));
-extern int sigsetmask __P ((int __mask));
+/* Block signals in MASK, returning the old mask.  */
+extern int sigblock (int __mask) __THROW __attribute_deprecated__;
+
+/* Set the mask of blocked signals to MASK, returning the old mask.  */
+extern int sigsetmask (int __mask) __THROW __attribute_deprecated__;
 
-/* This function is here only for compatibility.
-   Use `sigprocmask' instead.  */
-extern int siggetmask __P ((void));
+/* Return currently selected signal mask.  */
+extern int siggetmask (void) __THROW __attribute_deprecated__;
 #endif /* Use BSD.  */
 
 
@@ -164,112 +217,99 @@ typedef __sighandler_t sighandler_t;
 typedef __sighandler_t sig_t;
 #endif
 
-#endif /* <signal.h> included.  */
-
-
 #ifdef __USE_POSIX
 
-# if !defined __sigset_t_defined \
-    && (defined _SIGNAL_H  || defined __need_sigset_t)
-typedef __sigset_t sigset_t;
-#  define __sigset_t_defined   1
-# endif /* `sigset_t' not defined and <signal.h> or need `sigset_t'.  */
-# undef __need_sigset_t
-
-# ifdef _SIGNAL_H
-
-/* We need `struct timespec' later on.  */
-#  define __need_timespec
-#  include <time.h>
-
-/* Get the `siginfo_t' type plus the needed symbols.  */
-#  include <bits/siginfo.h>
-
 /* Clear all signals from SET.  */
-extern int sigemptyset __P ((sigset_t *__set));
+extern int sigemptyset (sigset_t *__set) __THROW __nonnull ((1));
 
 /* Set all signals in SET.  */
-extern int sigfillset __P ((sigset_t *__set));
+extern int sigfillset (sigset_t *__set) __THROW __nonnull ((1));
 
 /* Add SIGNO to SET.  */
-extern int sigaddset __P ((sigset_t *__set, int __signo));
+extern int sigaddset (sigset_t *__set, int __signo) __THROW __nonnull ((1));
 
 /* Remove SIGNO from SET.  */
-extern int sigdelset __P ((sigset_t *__set, int __signo));
+extern int sigdelset (sigset_t *__set, int __signo) __THROW __nonnull ((1));
 
 /* Return 1 if SIGNO is in SET, 0 if not.  */
-extern int sigismember __P ((__const sigset_t *__set, int __signo));
+extern int sigismember (const sigset_t *__set, int __signo)
+     __THROW __nonnull ((1));
 
-#  ifdef __USE_GNU
+# ifdef __USE_GNU
 /* Return non-empty value is SET is not empty.  */
-extern int sigisemptyset __P ((__const sigset_t *__set));
+extern int sigisemptyset (const sigset_t *__set) __THROW __nonnull ((1));
 
 /* Build new signal set by combining the two inputs set using logical AND.  */
-extern int sigandset __P ((sigset_t *__set, __const sigset_t *__left,
-                          __const sigset_t *__right));
+extern int sigandset (sigset_t *__set, const sigset_t *__left,
+                     const sigset_t *__right) __THROW __nonnull ((1, 2, 3));
 
 /* Build new signal set by combining the two inputs set using logical OR.  */
-extern int sigorset __P ((sigset_t *__set, __const sigset_t *__left,
-                         __const sigset_t *__right));
-#  endif /* GNU */
+extern int sigorset (sigset_t *__set, const sigset_t *__left,
+                    const sigset_t *__right) __THROW __nonnull ((1, 2, 3));
+# endif /* GNU */
 
 /* Get the system-specific definitions of `struct sigaction'
    and the `SA_*' and `SIG_*'. constants.  */
-#  include <bits/sigaction.h>
+# include <bits/sigaction.h>
 
 /* Get and/or change the set of blocked signals.  */
-extern int __sigprocmask __P ((int __how,
-                              __const sigset_t *__set, sigset_t *__oset));
-extern int sigprocmask __P ((int __how,
-                            __const sigset_t *__set, sigset_t *__oset));
+extern int sigprocmask (int __how, const sigset_t *__restrict __set,
+                       sigset_t *__restrict __oset) __THROW;
 
 /* Change the set of blocked signals to SET,
-   wait until a signal arrives, and restore the set of blocked signals.  */
-extern int __sigsuspend __P ((__const sigset_t *__set));
-extern int sigsuspend __P ((__const sigset_t *__set));
+   wait until a signal arrives, and restore the set of blocked signals.
+
+   This function is a cancellation point and therefore not marked with
+   __THROW.  */
+extern int sigsuspend (const sigset_t *__set) __nonnull ((1));
 
 /* Get and/or set the action for signal SIG.  */
-extern int __sigaction __P ((int __sig, __const struct sigaction *__act,
-                            struct sigaction *__oact));
-extern int sigaction __P ((int __sig, __const struct sigaction *__act,
-                          struct sigaction *__oact));
+extern int sigaction (int __sig, const struct sigaction *__restrict __act,
+                     struct sigaction *__restrict __oact) __THROW;
 
 /* Put in SET all signals that are blocked and waiting to be delivered.  */
-extern int sigpending __P ((sigset_t *__set));
+extern int sigpending (sigset_t *__set) __THROW __nonnull ((1));
 
 
-/* Select any of pending signals from SET or wait for any to arrive.  */
-extern int __sigwait __P ((__const sigset_t *__set, int *__sig));
-extern int sigwait __P ((__const sigset_t *__set, int *__sig));
+/* Select any of pending signals from SET or wait for any to arrive.
 
-/* Select any of pending signals from SET and place information in INFO.  */
-extern int __sigwaitinfo __P ((__const sigset_t *__set, siginfo_t *__info));
-extern int sigwaitinfo __P ((__const sigset_t *__set, siginfo_t *__info));
+   This function is a cancellation point and therefore not marked with
+   __THROW.  */
+extern int sigwait (const sigset_t *__restrict __set, int *__restrict __sig)
+     __nonnull ((1, 2));
 
+# ifdef __USE_POSIX199309
 /* Select any of pending signals from SET and place information in INFO.
-   Wait the imte specified by TIMEOUT if no signal is pending.  */
-extern int __sigtimedwait __P ((__const sigset_t *__set, siginfo_t *__info,
-                               __const struct timespec *__timeout));
-extern int sigtimedwait __P ((__const sigset_t *__set, siginfo_t *__info,
-                             __const struct timespec *__timeout));
+
+   This function is a cancellation point and therefore not marked with
+   __THROW.  */
+extern int sigwaitinfo (const sigset_t *__restrict __set,
+                       siginfo_t *__restrict __info) __nonnull ((1));
+
+/* Select any of pending signals from SET and place information in INFO.
+   Wait the time specified by TIMEOUT if no signal is pending.
+
+   This function is a cancellation point and therefore not marked with
+   __THROW.  */
+extern int sigtimedwait (const sigset_t *__restrict __set,
+                        siginfo_t *__restrict __info,
+                        const struct timespec *__restrict __timeout)
+     __nonnull ((1));
 
 /* Send signal SIG to the process PID.  Associate data in VAL with the
    signal.  */
-extern int __sigqueue __P ((__pid_t __pid, int __sig,
-                           __const union sigval __val));
-extern int sigqueue __P ((__pid_t __pid, int __sig,
-                         __const union sigval __val));
-
-# endif /* <signal.h> included.  */
+extern int sigqueue (__pid_t __pid, int __sig, const union sigval __val)
+     __THROW;
+# endif        /* Use POSIX 199306.  */
 
 #endif /* Use POSIX.  */
 
-#if defined _SIGNAL_H && defined __USE_BSD
+#ifdef __USE_BSD
 
 /* Names of the signals.  This variable exists only for compatibility.
    Use `strsignal' instead (see <string.h>).  */
-extern __const char *__const _sys_siglist[_NSIG + 1];
-extern __const char *__const sys_siglist[_NSIG + 1];
+extern const char *const _sys_siglist[_NSIG];
+extern const char *const sys_siglist[_NSIG];
 
 /* Structure passed to `sigvec'.  */
 struct sigvec
@@ -292,87 +332,80 @@ struct sigvec
    If the SV_RESETHAND bit is set in `sv_flags', the handler for SIG will be
    reset to SIG_DFL before `sv_handler' is entered.  If OVEC is non-NULL,
    it is filled in with the old information for SIG.  */
-extern int __sigvec __P ((int __sig, __const struct sigvec *__vec,
-                         struct sigvec *__ovec));
-extern int sigvec __P ((int __sig, __const struct sigvec *__vec,
-                       struct sigvec *__ovec));
+extern int sigvec (int __sig, const struct sigvec *__vec,
+                  struct sigvec *__ovec) __THROW;
 
 
 /* Get machine-dependent `struct sigcontext' and signal subcodes.  */
 # include <bits/sigcontext.h>
 
 /* Restore the state saved in SCP.  */
-extern int __sigreturn __P ((struct sigcontext *__scp));
-extern int sigreturn __P ((struct sigcontext *__scp));
+extern int sigreturn (struct sigcontext *__scp) __THROW;
 
-#endif /* signal.h included and use BSD.  */
+#endif /*  use BSD.  */
 
 
-#if defined _SIGNAL_H && (defined __USE_BSD || defined __USE_XOPEN_EXTENDED)
-
+#if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
 # define __need_size_t
 # include <stddef.h>
 
 /* If INTERRUPT is nonzero, make signal SIG interrupt system calls
    (causing them to fail with EINTR); if INTERRUPT is zero, make system
    calls be restarted after signal SIG.  */
-extern int siginterrupt __P ((int __sig, int __interrupt));
-
+extern int siginterrupt (int __sig, int __interrupt) __THROW;
 
-/* Structure describing a signal stack.  */
-struct sigstack
-  {
-    __ptr_t ss_sp;             /* Signal stack pointer.  */
-    int ss_onstack;            /* Nonzero if executing on this stack.  */
-  };
+# include <bits/sigstack.h>
+# if defined __USE_XOPEN || defined __USE_XOPEN2K8
+/* This will define `ucontext_t' and `mcontext_t'.  */
+#  include <sys/ucontext.h>
+# endif
 
 /* Run signals handlers on the stack specified by SS (if not NULL).
-   If OSS is not NULL, it is filled in with the old signal stack status.  */
-extern int sigstack __P ((__const struct sigstack *__ss,
-                         struct sigstack *__oss));
-
-/* Alternate interface.  */
-typedef struct sigaltstack
-  {
-    __ptr_t ss_sp;
-    size_t ss_size;
-    int ss_flags;
-  } stack_t;
-
-extern int sigaltstack __P ((__const struct sigaltstack *__ss,
-                            struct sigaltstack *__oss));
+   If OSS is not NULL, it is filled in with the old signal stack status.
+   This interface is obsolete and on many platform not implemented.  */
+extern int sigstack (struct sigstack *__ss, struct sigstack *__oss)
+     __THROW __attribute_deprecated__;
 
-#endif /* signal.h included and use BSD or X/Open Unix.  */
+/* Alternate signal handler stack interface.
+   This interface should always be preferred over `sigstack'.  */
+extern int sigaltstack (const struct sigaltstack *__restrict __ss,
+                       struct sigaltstack *__restrict __oss) __THROW;
 
+#endif /* use BSD or X/Open Unix.  */
 
-#if defined _SIGNAL_H && defined __USE_UNIX98
+#ifdef __USE_XOPEN_EXTENDED
 /* Simplified interface for signal management.  */
 
 /* Add SIG to the calling process' signal mask.  */
-extern int sighold __P ((int __sig));
+extern int sighold (int __sig) __THROW;
 
 /* Remove SIG from the calling process' signal mask.  */
-extern int sigrelse __P ((int __sig));
+extern int sigrelse (int __sig) __THROW;
 
 /* Set the disposition of SIG to SIG_IGN.  */
-extern int sigignore __P ((int __sig));
+extern int sigignore (int __sig) __THROW;
 
 /* Set the disposition of SIG.  */
-extern __sighandler_t sigset __P ((int __sig, __sighandler_t __disp));
+extern __sighandler_t sigset (int __sig, __sighandler_t __disp) __THROW;
 #endif
 
+#if defined __USE_POSIX199506 || defined __USE_UNIX98
+/* Some of the functions for handling signals in threaded programs must
+   be defined here.  */
+# include <bits/pthreadtypes.h>
+# include <bits/sigthread.h>
+#endif /* use Unix98 */
 
 /* The following functions are used internally in the C library and in
    other code which need deep insights.  */
 
 /* Return number of available real-time signal with highest priority.  */
-extern int __libc_current_sigrtmin __P ((void));
+extern int __libc_current_sigrtmin (void) __THROW;
 /* Return number of available real-time signal with lowest priority.  */
-extern int __libc_current_sigrtmax __P ((void));
+extern int __libc_current_sigrtmax (void) __THROW;
 
-/* Allocate real-time signal with highest/lowest available priority.  */
-extern int __libc_allocate_rtsig __P ((int __high));
+#endif /* signal.h  */
 
 __END_DECLS
 
-#endif /* signal.h  */
+#endif /* not signal.h */