signal/signal.h

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