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
 200 #ifdef __FAVOR_BSD
 201 /* Set the mask of blocked signals to MASK,
 202    wait for a signal to arrive, and then restore the mask.  */
 203 /*extern int sigpause (int __mask) __THROW __attribute_deprecated__;
 204 # define sigpause(mask) __sigpause ((mask), 0)*/
 205 /* uClibc note: BSD sigpause is available as __bsd_sigpause.
 206  * It is intentionally not prototyped */
 207 #else
 208 # ifdef __USE_XOPEN
 209 /* Remove a signal from the signal mask and suspend the process.  */
 210 extern int sigpause(int __sig);
 211 /*#  define sigpause(sig) __sigpause ((sig), 1)*/
 212 # endif
 213 #endif
 214 #endif /* __UCLIBC_SUSV4_LEGACY__ */
 215
 216 #if 0 /*def __USE_BSD*/
 217 /* None of the following functions should be used anymore.  They are here
 218    only for compatibility.  A single word (`int') is not guaranteed to be
 219    enough to hold a complete signal mask and therefore these functions
 220    simply do not work in many situations.  Use `sigprocmask' instead.  */
 221
 222 /* Compute mask for signal SIG.  */
 223 # define sigmask(sig)   __sigmask(sig)
 224
 225 /* Block signals in MASK, returning the old mask.  */
 226 extern int sigblock (int __mask) __THROW __attribute_deprecated__;
 227
 228 /* Set the mask of blocked signals to MASK, returning the old mask.  */
 229 extern int sigsetmask (int __mask) __THROW __attribute_deprecated__;
 230
 231 /* Return currently selected signal mask.  */
 232 extern int siggetmask (void) __THROW __attribute_deprecated__;
 233 #endif /* Use BSD.  */
 234
 235
 236 #ifdef __USE_GNU
 237 typedef __sighandler_t sighandler_t;
 238 #endif
 239
 240 /* 4.4 BSD uses the name `sig_t' for this.  */
 241 #ifdef __USE_BSD
 242 typedef __sighandler_t sig_t;
 243 #endif
 244
 245 #ifdef __USE_POSIX
 246
 247 /* Clear all signals from SET.  */
 248 extern int sigemptyset (sigset_t *__set) __THROW __nonnull ((1));
 249
 250 /* Set all signals in SET.  */
 251 extern int sigfillset (sigset_t *__set) __THROW __nonnull ((1));
 252
 253 /* Add SIGNO to SET.  */
 254 extern int sigaddset (sigset_t *__set, int __signo) __THROW __nonnull ((1));
 255 libc_hidden_proto(sigaddset)
 256
 257 /* Remove SIGNO from SET.  */
 258 extern int sigdelset (sigset_t *__set, int __signo) __THROW __nonnull ((1));
 259 libc_hidden_proto(sigdelset)
 260
 261 /* Return 1 if SIGNO is in SET, 0 if not.  */
 262 extern int sigismember (__const sigset_t *__set, int __signo)
 263      __THROW __nonnull ((1));
 264
 265 # ifdef __USE_GNU
 266 /* Return non-empty value is SET is not empty.  */
 267 extern int sigisemptyset (__const sigset_t *__set) __THROW __nonnull ((1));
 268
 269 /* Build new signal set by combining the two inputs set using logical AND.  */
 270 extern int sigandset (sigset_t *__set, __const sigset_t *__left,
 271                       __const sigset_t *__right) __THROW __nonnull ((1, 2, 3));
 272
 273 /* Build new signal set by combining the two inputs set using logical OR.  */
 274 extern int sigorset (sigset_t *__set, __const sigset_t *__left,
 275                      __const sigset_t *__right) __THROW __nonnull ((1, 2, 3));
 276 # endif /* GNU */
 277
 278 /* Get the system-specific definitions of `struct sigaction'
 279    and the `SA_*' and `SIG_*'. constants.  */
 280 # include <bits/sigaction.h>
 281
 282 /* Get and/or change the set of blocked signals.  */
 283 extern int sigprocmask (int __how, __const sigset_t *__restrict __set,
 284                         sigset_t *__restrict __oset) __THROW;
 285 libc_hidden_proto(sigprocmask)
 286
 287 /* Change the set of blocked signals to SET,
 288    wait until a signal arrives, and restore the set of blocked signals.
 289
 290    This function is a cancellation point and therefore not marked with
 291    __THROW.  */
 292 extern int sigsuspend (__const sigset_t *__set) __nonnull ((1));
 293 #ifdef _LIBC
 294 extern __typeof(sigsuspend) __sigsuspend_nocancel attribute_hidden;
 295 libc_hidden_proto(sigsuspend)
 296 #endif
 297
 298 /* Get and/or set the action for signal SIG.  */
 299 extern int sigaction (int __sig, __const struct sigaction *__restrict __act,
 300                       struct sigaction *__restrict __oact) __THROW;
 301 #ifdef _LIBC
 302 # if 0 /* this is in headers */
 303 /* In uclibc, userspace struct sigaction is identical to
 304  * "new" struct kernel_sigaction (one from the Linux 2.1.68 kernel).
 305  * See sigaction.h
 306  */
 307 struct old_kernel_sigaction;
 308 extern int __syscall_sigaction(int, __const struct old_kernel_sigaction *,
 309         struct old_kernel_sigaction *) attribute_hidden;
 310 # else /* this is how the function is built */
 311 extern __typeof(sigaction) __syscall_sigaction attribute_hidden;
 312 # endif
 313 # define __need_size_t
 314 # include <stddef.h>
 315 /* candidate for attribute_hidden, if NPTL would behave */
 316 extern int __syscall_rt_sigaction(int, __const struct sigaction *,
 317         struct sigaction *, size_t)
 318 # ifndef __UCLIBC_HAS_THREADS_NATIVE__
 319                 attribute_hidden
 320 # endif
 321         ;
 322 extern __typeof(sigaction) __libc_sigaction;
 323 libc_hidden_proto(sigaction)
 324
 325 # ifdef __mips__
 326 #  define _KERNEL_NSIG_WORDS (_NSIG / _MIPS_SZLONG)
 327 typedef struct {
 328         unsigned long sig[_KERNEL_NSIG_WORDS];
 329 } kernel_sigset_t;
 330 #  define __SYSCALL_SIGSET_T_SIZE (sizeof(kernel_sigset_t))
 331 # else
 332 #  define __SYSCALL_SIGSET_T_SIZE (_NSIG / 8)
 333 # endif
 334 #endif
 335
 336 /* Put in SET all signals that are blocked and waiting to be delivered.  */
 337 extern int sigpending (sigset_t *__set) __THROW __nonnull ((1));
 338
 339
 340 /* Select any of pending signals from SET or wait for any to arrive.
 341
 342    This function is a cancellation point and therefore not marked with
 343    __THROW.  */
 344 extern int sigwait (__const sigset_t *__restrict __set, int *__restrict __sig)
 345      __nonnull ((1, 2));
 346
 347 # if defined __USE_POSIX199309 && defined __UCLIBC_HAS_REALTIME__
 348 /* Select any of pending signals from SET and place information in INFO.
 349
 350    This function is a cancellation point and therefore not marked with
 351    __THROW.  */
 352 extern int sigwaitinfo (__const sigset_t *__restrict __set,
 353                         siginfo_t *__restrict __info) __nonnull ((1));
 354 #ifdef _LIBC
 355 extern __typeof(sigwaitinfo) __sigwaitinfo attribute_hidden;
 356 #endif
 357
 358 /* Select any of pending signals from SET and place information in INFO.
 359    Wait the time specified by TIMEOUT if no signal is pending.
 360
 361    This function is a cancellation point and therefore not marked with
 362    __THROW.  */
 363 extern int sigtimedwait (__const sigset_t *__restrict __set,
 364                          siginfo_t *__restrict __info,
 365                          __const struct timespec *__restrict __timeout)
 366      __nonnull ((1));
 367 #ifdef _LIBC
 368 extern __typeof(sigtimedwait) __sigtimedwait_nocancel attribute_hidden;
 369 libc_hidden_proto(sigtimedwait)
 370 #endif
 371
 372 /* Send signal SIG to the process PID.  Associate data in VAL with the
 373    signal.  */
 374 extern int sigqueue (__pid_t __pid, int __sig, __const union sigval __val)
 375      __THROW;
 376 # endif /* Use POSIX 199306.  */
 377
 378 #endif /* Use POSIX.  */
 379
 380 #ifdef __USE_BSD
 381
 382 # ifdef __UCLIBC_HAS_SYS_SIGLIST__
 383 /* Names of the signals.  This variable exists only for compatibility.
 384    Use `strsignal' instead (see <string.h>).  */
 385 #  define _sys_siglist sys_siglist
 386 extern __const char *__const sys_siglist[_NSIG];
 387 # endif
 388
 389 #ifndef __UCLIBC_STRICT_HEADERS__
 390 /* Structure passed to `sigvec'.  */
 391 struct sigvec
 392   {
 393     __sighandler_t sv_handler;  /* Signal handler.  */
 394     int sv_mask;                /* Mask of signals to be blocked.  */
 395
 396     int sv_flags;               /* Flags (see below).  */
 397 # define sv_onstack     sv_flags /* 4.2 BSD compatibility.  */
 398   };
 399
 400 /* Bits in `sv_flags'.  */
 401 # define SV_ONSTACK     (1 << 0)/* Take the signal on the signal stack.  */
 402 # define SV_INTERRUPT   (1 << 1)/* Do not restart system calls.  */
 403 # define SV_RESETHAND   (1 << 2)/* Reset handler to SIG_DFL on receipt.  */
 404 #endif
 405
 406
 407 #if 0
 408 /* If VEC is non-NULL, set the handler for SIG to the `sv_handler' member
 409    of VEC.  The signals in `sv_mask' will be blocked while the handler runs.
 410    If the SV_RESETHAND bit is set in `sv_flags', the handler for SIG will be
 411    reset to SIG_DFL before `sv_handler' is entered.  If OVEC is non-NULL,
 412    it is filled in with the old information for SIG.  */
 413 extern int sigvec (int __sig, __const struct sigvec *__vec,
 414                    struct sigvec *__ovec) __THROW;
 415 #endif
 416
 417
 418 /* Get machine-dependent `struct sigcontext' and signal subcodes.  */
 419 # include <bits/sigcontext.h>
 420
 421 #if 0
 422 /* Restore the state saved in SCP.  */
 423 extern int sigreturn (struct sigcontext *__scp) __THROW;
 424 #endif
 425
 426 #endif /*  use BSD.  */
 427
 428
 429 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 430 # define __need_size_t
 431 # include <stddef.h>
 432
 433 # ifdef __UCLIBC_SUSV4_LEGACY__
 434 /* If INTERRUPT is nonzero, make signal SIG interrupt system calls
 435    (causing them to fail with EINTR); if INTERRUPT is zero, make system
 436    calls be restarted after signal SIG.  */
 437 extern int siginterrupt (int __sig, int __interrupt) __THROW;
 438 # endif
 439
 440 # include <bits/sigstack.h>
 441 # ifdef __USE_XOPEN
 442 /* This will define `ucontext_t' and `mcontext_t'.  */
 443 /* SuSv4 obsoleted include/ucontext.h */
 444 #  include <sys/ucontext.h>
 445 # endif
 446
 447 # if 0
 448 /* Run signals handlers on the stack specified by SS (if not NULL).
 449    If OSS is not NULL, it is filled in with the old signal stack status.
 450    This interface is obsolete and on many platform not implemented.  */
 451 extern int sigstack (struct sigstack *__ss, struct sigstack *__oss)
 452      __THROW __attribute_deprecated__;
 453 # endif
 454
 455 /* Alternate signal handler stack interface.
 456    This interface should always be preferred over `sigstack'.  */
 457 extern int sigaltstack (__const struct sigaltstack *__restrict __ss,
 458                         struct sigaltstack *__restrict __oss) __THROW;
 459
 460 #endif /* use BSD or X/Open Unix.  */
 461
 462 #if defined __USE_XOPEN_EXTENDED && defined __UCLIBC_HAS_OBSOLETE_BSD_SIGNAL__
 463 /* Simplified interface for signal management.  */
 464
 465 /* Add SIG to the calling process' signal mask.  */
 466 extern int sighold (int __sig) __THROW;
 467
 468 /* Remove SIG from the calling process' signal mask.  */
 469 extern int sigrelse (int __sig) __THROW;
 470
 471 /* Set the disposition of SIG to SIG_IGN.  */
 472 extern int sigignore (int __sig) __THROW;
 473
 474 /* Set the disposition of SIG.  */
 475 extern __sighandler_t sigset (int __sig, __sighandler_t __disp) __THROW;
 476 #endif
 477
 478 #if defined __UCLIBC_HAS_THREADS__ && (defined __USE_POSIX199506 || defined __USE_UNIX98)
 479 /* Some of the functions for handling signals in threaded programs must
 480    be defined here.  */
 481 # include <bits/pthreadtypes.h>
 482 # include <bits/sigthread.h>
 483 #endif
 484
 485 /* The following functions are used internally in the C library and in
 486    other code which need deep insights.  */
 487
 488 /* Return number of available real-time signal with highest priority.  */
 489 extern int __libc_current_sigrtmin (void) __THROW;
 490 /* Return number of available real-time signal with lowest priority.  */
 491 extern int __libc_current_sigrtmax (void) __THROW;
 492
 493 #ifdef _LIBC
 494 extern sigset_t _sigintr attribute_hidden;
 495 /* simplified version without parameter checking */
 496 # include <string.h>
 497 # undef __sigemptyset
 498 # define __sigemptyset(ss) (memset(ss, '\0', sizeof(sigset_t)), 0)
 499 #endif
 500 #endif /* signal.h  */
 501
 502 __END_DECLS
 503
 504 #endif /* not signal.h */