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