signal/signal.h

   1 /* Copyright (C) 1991,92,93,94,95,96,97,98 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public
  15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17    Boston, MA 02111-1307, USA.  */
  18
  19 /*
  20  *      ISO C Standard: 4.7 SIGNAL HANDLING <signal.h>
  21  */
  22
  23 #ifndef _SIGNAL_H
  24
  25 #if !defined __need_sig_atomic_t && !defined __need_sigset_t
  26 # define _SIGNAL_H
  27 #endif
  28
  29 #include <features.h>
  30
  31 __BEGIN_DECLS
  32
  33 #include <bits/sigset.h>                /* __sigset_t, __sig_atomic_t.  */
  34
  35 /* An integral type that can be modified atomically, without the
  36    possibility of a signal arriving in the middle of the operation.  */
  37 #ifndef __sig_atomic_t_defined
  38 # if defined __need_sig_atomic_t || defined _SIGNAL_H
  39 #  undef __need_sig_atomic_t
  40 #  define __sig_atomic_t_defined 1
  41 typedef __sig_atomic_t sig_atomic_t;
  42 # endif
  43 #endif
  44
  45 #ifndef __sigset_t_defined
  46 # if defined __need_sigset_t || (defined _SIGNAL_H && defined __USE_POSIX)
  47 #  undef __need_sigset_t
  48 #  define __sigset_t_defined    1
  49 typedef __sigset_t sigset_t;
  50 # endif
  51 #endif
  52
  53 #ifdef _SIGNAL_H
  54
  55 #include <bits/types.h>
  56 #include <bits/signum.h>
  57
  58 #if defined __USE_XOPEN && !defined pid_t
  59 typedef __pid_t pid_t;
  60 # define pid_t pid_t
  61 #endif  /* Unix98 */
  62
  63
  64 /* Type of a signal handler.  */
  65 typedef void (*__sighandler_t) __PMT ((int));
  66
  67 /* The X/Open definition of `signal' specifies the SVID semantic.  Use
  68    the additional function `sysv_signal' when X/Open compatibility is
  69    requested.  */
  70 extern __sighandler_t __sysv_signal __P ((int __sig,
  71                                           __sighandler_t __handler));
  72 #ifdef __USE_GNU
  73 extern __sighandler_t sysv_signal __P ((int __sig, __sighandler_t __handler));
  74 #endif
  75
  76 /* Set the handler for the signal SIG to HANDLER, returning the old
  77    handler, or SIG_ERR on error.
  78    By default `signal' has the BSD semantic.  */
  79 #ifdef __USE_BSD
  80 extern __sighandler_t signal __P ((int __sig, __sighandler_t __handler));
  81 #else
  82 /* Make sure the used `signal' implementation is the SVID version. */
  83 # ifdef __REDIRECT
  84 extern __sighandler_t __REDIRECT (signal,
  85                                   __P ((int __sig, __sighandler_t __handler)),
  86                                   __sysv_signal);
  87 # else
  88 #  define signal __sysv_signal
  89 # endif
  90 #endif
  91
  92 #ifdef __USE_XOPEN
  93 /* The X/Open definition of `signal' conflicts with the BSD version.
  94    So they defined another function `bsd_signal'.  */
  95 extern __sighandler_t bsd_signal __P ((int __sig, __sighandler_t __handler));
  96 #endif
  97
  98 /* Send signal SIG to process number PID.  If PID is zero,
  99    send SIG to all processes in the current process's process group.
 100    If PID is < -1, send SIG to all processes in process group - PID.  */
 101 #ifdef __USE_POSIX
 102 extern int kill __P ((__pid_t __pid, int __sig));
 103 #endif /* Use POSIX.  */
 104
 105 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 106 /* Send SIG to all processes in process group PGRP.
 107    If PGRP is zero, send SIG to all processes in
 108    the current process's process group.  */
 109 extern int killpg __P ((__pid_t __pgrp, int __sig));
 110 #endif /* Use BSD || X/Open Unix.  */
 111
 112 /* Raise signal SIG, i.e., send SIG to yourself.  */
 113 extern int raise __P ((int __sig));
 114
 115 #ifdef __USE_SVID
 116 /* SVID names for the same things.  */
 117 extern __sighandler_t ssignal __P ((int __sig, __sighandler_t __handler));
 118 extern int gsignal __P ((int __sig));
 119 #endif /* Use SVID.  */
 120
 121 #ifdef __USE_MISC
 122 /* Print a message describing the meaning of the given signal number.  */
 123 extern void psignal __P ((int __sig, __const char *__s));
 124 #endif /* Use misc.  */
 125
 126
 127 /* The `sigpause' function has two different interfaces.  The original
 128    BSD definition defines the argument as a mask of the signal, while
 129    the more modern interface in X/Open defines it as the signal
 130    number.  We go with the BSD version unless the user explicitly
 131    selects the X/Open version.  */
 132 extern int __sigpause __P ((int __sig_or_mask, int __is_sig));
 133
 134 #ifdef __USE_BSD
 135 /* Set the mask of blocked signals to MASK,
 136    wait for a signal to arrive, and then restore the mask.  */
 137 extern int sigpause __P ((int __mask));
 138 # define sigpause(mask) __sigpause ((mask), 0)
 139 #else
 140 # ifdef __USE_XOPEN
 141 /* Remove a signal from the signal mask and suspend the process.  */
 142 #  define sigpause(sig) __sigpause ((sig), 1)
 143 # endif
 144 #endif
 145
 146
 147 #ifdef __USE_BSD
 148 /* None of the following functions should be used anymore.  They are here
 149    only for compatibility.  A single word (`int') is not guaranteed to be
 150    enough to hold a complete signal mask and therefore these functions
 151    simply do not work in many situations.  Use `sigprocmask' instead.  */
 152
 153 /* Compute mask for signal SIG.  */
 154 # define sigmask(sig)   __sigmask(sig)
 155
 156 /* Block signals in MASK, returning the old mask.  */
 157 extern int sigblock __P ((int __mask));
 158
 159 /* Set the mask of blocked signals to MASK, returning the old mask.  */
 160 extern int sigsetmask __P ((int __mask));
 161
 162 /* Return currently selected signal mask.  */
 163 extern int siggetmask __P ((void));
 164 #endif /* Use BSD.  */
 165
 166
 167 #ifdef __USE_MISC
 168 # define NSIG   _NSIG
 169 #endif
 170
 171 #ifdef __USE_GNU
 172 typedef __sighandler_t sighandler_t;
 173 #endif
 174
 175 /* 4.4 BSD uses the name `sig_t' for this.  */
 176 #ifdef __USE_BSD
 177 typedef __sighandler_t sig_t;
 178 #endif
 179
 180 #ifdef __USE_POSIX
 181
 182 # ifdef __USE_POSIX199309
 183 /* Get the `siginfo_t' type plus the needed symbols.  */
 184 #  include <bits/siginfo.h>
 185 # endif
 186
 187 /* Clear all signals from SET.  */
 188 extern int sigemptyset __P ((sigset_t *__set));
 189
 190 /* Set all signals in SET.  */
 191 extern int sigfillset __P ((sigset_t *__set));
 192
 193 /* Add SIGNO to SET.  */
 194 extern int sigaddset __P ((sigset_t *__set, int __signo));
 195
 196 /* Remove SIGNO from SET.  */
 197 extern int sigdelset __P ((sigset_t *__set, int __signo));
 198
 199 /* Return 1 if SIGNO is in SET, 0 if not.  */
 200 extern int sigismember __P ((__const sigset_t *__set, int __signo));
 201
 202 # ifdef __USE_GNU
 203 /* Return non-empty value is SET is not empty.  */
 204 extern int sigisemptyset __P ((__const sigset_t *__set));
 205
 206 /* Build new signal set by combining the two inputs set using logical AND.  */
 207 extern int sigandset __P ((sigset_t *__set, __const sigset_t *__left,
 208                            __const sigset_t *__right));
 209
 210 /* Build new signal set by combining the two inputs set using logical OR.  */
 211 extern int sigorset __P ((sigset_t *__set, __const sigset_t *__left,
 212                           __const sigset_t *__right));
 213 # endif /* GNU */
 214
 215 /* Get the system-specific definitions of `struct sigaction'
 216    and the `SA_*' and `SIG_*'. constants.  */
 217 # include <bits/sigaction.h>
 218
 219 /* Get and/or change the set of blocked signals.  */
 220 extern int sigprocmask __P ((int __how,
 221                              __const sigset_t *__set, sigset_t *__oset));
 222
 223 /* Change the set of blocked signals to SET,
 224    wait until a signal arrives, and restore the set of blocked signals.  */
 225 extern int sigsuspend __P ((__const sigset_t *__set));
 226
 227 /* Get and/or set the action for signal SIG.  */
 228 extern int __sigaction __P ((int __sig, __const struct sigaction *__act,
 229                              struct sigaction *__oact));
 230 extern int sigaction __P ((int __sig, __const struct sigaction *__act,
 231                            struct sigaction *__oact));
 232
 233 /* Put in SET all signals that are blocked and waiting to be delivered.  */
 234 extern int sigpending __P ((sigset_t *__set));
 235
 236
 237 /* Select any of pending signals from SET or wait for any to arrive.  */
 238 extern int sigwait __P ((__const sigset_t *__set, int *__sig));
 239
 240 # ifdef __USE_POSIX199309
 241 /* This type actually is defined in <time.h>.  */
 242 struct timespec;
 243
 244 /* Select any of pending signals from SET and place information in INFO.  */
 245 extern int sigwaitinfo __P ((__const sigset_t *__set, siginfo_t *__info));
 246
 247 /* Select any of pending signals from SET and place information in INFO.
 248    Wait the imte specified by TIMEOUT if no signal is pending.  */
 249 extern int sigtimedwait __P ((__const sigset_t *__set, siginfo_t *__info,
 250                               __const struct timespec *__timeout));
 251
 252 /* Send signal SIG to the process PID.  Associate data in VAL with the
 253    signal.  */
 254 extern int sigqueue __P ((__pid_t __pid, int __sig,
 255                           __const union sigval __val));
 256 # endif /* Use POSIX 199306.  */
 257
 258 #endif /* Use POSIX.  */
 259
 260 #ifdef __USE_BSD
 261
 262 /* Names of the signals.  This variable exists only for compatibility.
 263    Use `strsignal' instead (see <string.h>).  */
 264 extern __const char *__const _sys_siglist[_NSIG];
 265 extern __const char *__const sys_siglist[_NSIG];
 266
 267 /* Structure passed to `sigvec'.  */
 268 struct sigvec
 269   {
 270     __sighandler_t sv_handler;  /* Signal handler.  */
 271     int sv_mask;                /* Mask of signals to be blocked.  */
 272
 273     int sv_flags;               /* Flags (see below).  */
 274 # define sv_onstack     sv_flags /* 4.2 BSD compatibility.  */
 275   };
 276
 277 /* Bits in `sv_flags'.  */
 278 # define SV_ONSTACK     (1 << 0)/* Take the signal on the signal stack.  */
 279 # define SV_INTERRUPT   (1 << 1)/* Do not restart system calls.  */
 280 # define SV_RESETHAND   (1 << 2)/* Reset handler to SIG_DFL on receipt.  */
 281
 282
 283 /* If VEC is non-NULL, set the handler for SIG to the `sv_handler' member
 284    of VEC.  The signals in `sv_mask' will be blocked while the handler runs.
 285    If the SV_RESETHAND bit is set in `sv_flags', the handler for SIG will be
 286    reset to SIG_DFL before `sv_handler' is entered.  If OVEC is non-NULL,
 287    it is filled in with the old information for SIG.  */
 288 extern int sigvec __P ((int __sig, __const struct sigvec *__vec,
 289                         struct sigvec *__ovec));
 290
 291
 292 /* Get machine-dependent `struct sigcontext' and signal subcodes.  */
 293 # include <bits/sigcontext.h>
 294
 295 /* Restore the state saved in SCP.  */
 296 extern int sigreturn __P ((struct sigcontext *__scp));
 297
 298 #endif /*  use BSD.  */
 299
 300
 301 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 302
 303 /* If INTERRUPT is nonzero, make signal SIG interrupt system calls
 304    (causing them to fail with EINTR); if INTERRUPT is zero, make system
 305    calls be restarted after signal SIG.  */
 306 extern int siginterrupt __P ((int __sig, int __interrupt));
 307
 308 # include <bits/sigstack.h>
 309
 310 /* Run signals handlers on the stack specified by SS (if not NULL).
 311    If OSS is not NULL, it is filled in with the old signal stack status.
 312    This interface is obsolete and on many platform not implemented.  */
 313 extern int sigstack __P ((__const struct sigstack *__ss,
 314                           struct sigstack *__oss));
 315
 316 /* Alternate signal handler stack interface.
 317    This interface should always be preferred over `sigstack'.  */
 318 extern int sigaltstack __P ((__const struct sigaltstack *__ss,
 319                              struct sigaltstack *__oss));
 320
 321 #endif /* use BSD or X/Open Unix.  */
 322
 323 #ifdef __USE_UNIX98
 324 /* Simplified interface for signal management.  */
 325
 326 /* Add SIG to the calling process' signal mask.  */
 327 extern int sighold __P ((int __sig));
 328
 329 /* Remove SIG from the calling process' signal mask.  */
 330 extern int sigrelse __P ((int __sig));
 331
 332 /* Set the disposition of SIG to SIG_IGN.  */
 333 extern int sigignore __P ((int __sig));
 334
 335 /* Set the disposition of SIG.  */
 336 extern __sighandler_t sigset __P ((int __sig, __sighandler_t __disp));
 337
 338 /* Some of the functions for handling signals in threaded programs must
 339    be defined here.  */
 340 # include <bits/sigthread.h>
 341 #endif /* use Unix98 */
 342
 343 /* The following functions are used internally in the C library and in
 344    other code which need deep insights.  */
 345
 346 /* Return number of available real-time signal with highest priority.  */
 347 extern int __libc_current_sigrtmin __P ((void));
 348 /* Return number of available real-time signal with lowest priority.  */
 349 extern int __libc_current_sigrtmax __P ((void));
 350
 351 /* Allocate real-time signal with highest/lowest available priority.  */
 352 extern int __libc_allocate_rtsig __P ((int __high));
 353
 354 #endif /* signal.h  */
 355
 356 __END_DECLS
 357
 358 #endif /* not signal.h */