include/signal.h

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