lib/signal.in.h

   1 /* A GNU-like <signal.h>.
   2
   3    Copyright (C) 2006-2011 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #if __GNUC__ >= 3
  19 @PRAGMA_SYSTEM_HEADER@
  20 #endif
  21 @PRAGMA_COLUMNS@
  22
  23 #if defined __need_sig_atomic_t || defined __need_sigset_t || defined _GL_ALREADY_INCLUDING_SIGNAL_H || (defined _SIGNAL_H && !defined __SIZEOF_PTHREAD_MUTEX_T)
  24 /* Special invocation convention:
  25    - Inside glibc header files.
  26    - On glibc systems we have a sequence of nested includes
  27      <signal.h> -> <ucontext.h> -> <signal.h>.
  28      In this situation, the functions are not yet declared, therefore we cannot
  29      provide the C++ aliases.
  30    - On glibc systems with GCC 4.3 we have a sequence of nested includes
  31      <csignal> -> </usr/include/signal.h> -> <sys/ucontext.h> -> <signal.h>.
  32      In this situation, some of the functions are not yet declared, therefore
  33      we cannot provide the C++ aliases.  */
  34
  35 # @INCLUDE_NEXT@ @NEXT_SIGNAL_H@
  36
  37 #else
  38 /* Normal invocation convention.  */
  39
  40 #ifndef _@GUARD_PREFIX@_SIGNAL_H
  41
  42 #define _GL_ALREADY_INCLUDING_SIGNAL_H
  43
  44 /* Define pid_t, uid_t.
  45    Also, mingw defines sigset_t not in <signal.h>, but in <sys/types.h>.
  46    On Solaris 10, <signal.h> includes <sys/types.h>, which eventually includes
  47    us; so include <sys/types.h> now, before the second inclusion guard.  */
  48 #include <sys/types.h>
  49
  50 /* The include_next requires a split double-inclusion guard.  */
  51 #@INCLUDE_NEXT@ @NEXT_SIGNAL_H@
  52
  53 #undef _GL_ALREADY_INCLUDING_SIGNAL_H
  54
  55 #ifndef _@GUARD_PREFIX@_SIGNAL_H
  56 #define _@GUARD_PREFIX@_SIGNAL_H
  57
  58 /* MacOS X 10.3, FreeBSD 6.4, OpenBSD 3.8, OSF/1 4.0, Solaris 2.6 declare
  59    pthread_sigmask in <pthread.h>, not in <signal.h>.
  60    But avoid namespace pollution on glibc systems.*/
  61 #if (@GNULIB_PTHREAD_SIGMASK@ || defined GNULIB_POSIXCHECK) \
  62     && ((defined __APPLE__ && defined __MACH__) || defined __FreeBSD__ || defined __OpenBSD__ || defined __osf__ || defined __sun) \
  63     && ! defined __GLIBC__
  64 # include <pthread.h>
  65 #endif
  66
  67 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here.  */
  68
  69 /* The definition of _GL_ARG_NONNULL is copied here.  */
  70
  71 /* The definition of _GL_WARN_ON_USE is copied here.  */
  72
  73 /* On AIX, sig_atomic_t already includes volatile.  C99 requires that
  74    'volatile sig_atomic_t' ignore the extra modifier, but C89 did not.
  75    Hence, redefine this to a non-volatile type as needed.  */
  76 #if ! @HAVE_TYPE_VOLATILE_SIG_ATOMIC_T@
  77 # if !GNULIB_defined_sig_atomic_t
  78 typedef int rpl_sig_atomic_t;
  79 #  undef sig_atomic_t
  80 #  define sig_atomic_t rpl_sig_atomic_t
  81 #  define GNULIB_defined_sig_atomic_t 1
  82 # endif
  83 #endif
  84
  85 /* A set or mask of signals.  */
  86 #if !@HAVE_SIGSET_T@
  87 # if !GNULIB_defined_sigset_t
  88 typedef unsigned int sigset_t;
  89 #  define GNULIB_defined_sigset_t 1
  90 # endif
  91 #endif
  92
  93 /* Define sighandler_t, the type of signal handlers.  A GNU extension.  */
  94 #if !@HAVE_SIGHANDLER_T@
  95 # ifdef __cplusplus
  96 extern "C" {
  97 # endif
  98 # if !GNULIB_defined_sighandler_t
  99 typedef void (*sighandler_t) (int);
 100 #  define GNULIB_defined_sighandler_t 1
 101 # endif
 102 # ifdef __cplusplus
 103 }
 104 # endif
 105 #endif
 106
 107
 108 #if @GNULIB_SIGNAL_H_SIGPIPE@
 109 # ifndef SIGPIPE
 110 /* Define SIGPIPE to a value that does not overlap with other signals.  */
 111 #  define SIGPIPE 13
 112 #  define GNULIB_defined_SIGPIPE 1
 113 /* To actually use SIGPIPE, you also need the gnulib modules 'sigprocmask',
 114    'write', 'stdio'.  */
 115 # endif
 116 #endif
 117
 118
 119 /* Maximum signal number + 1.  */
 120 #ifndef NSIG
 121 # if defined __TANDEM
 122 #  define NSIG 32
 123 # endif
 124 #endif
 125
 126
 127 #if @GNULIB_PTHREAD_SIGMASK@
 128 # if @REPLACE_PTHREAD_SIGMASK@
 129 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 130 #   undef pthread_sigmask
 131 #   define pthread_sigmask rpl_pthread_sigmask
 132 #  endif
 133 _GL_FUNCDECL_RPL (pthread_sigmask, int,
 134                   (int how, const sigset_t *new_mask, sigset_t *old_mask));
 135 _GL_CXXALIAS_RPL (pthread_sigmask, int,
 136                   (int how, const sigset_t *new_mask, sigset_t *old_mask));
 137 # else
 138 #  if !@HAVE_PTHREAD_SIGMASK@
 139 _GL_FUNCDECL_SYS (pthread_sigmask, int,
 140                   (int how, const sigset_t *new_mask, sigset_t *old_mask));
 141 #  endif
 142 _GL_CXXALIAS_SYS (pthread_sigmask, int,
 143                   (int how, const sigset_t *new_mask, sigset_t *old_mask));
 144 # endif
 145 _GL_CXXALIASWARN (pthread_sigmask);
 146 #elif defined GNULIB_POSIXCHECK
 147 # undef pthread_sigmask
 148 # if HAVE_RAW_DECL_PTHREAD_SIGMASK
 149 _GL_WARN_ON_USE (pthread_sigmask, "pthread_sigmask is not portable - "
 150                  "use gnulib module pthread_sigmask for portability");
 151 # endif
 152 #endif
 153
 154
 155 #if @GNULIB_RAISE@
 156 # if @REPLACE_RAISE@
 157 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 158 #   undef raise
 159 #   define raise rpl_raise
 160 #  endif
 161 _GL_FUNCDECL_RPL (raise, int, (int sig));
 162 _GL_CXXALIAS_RPL (raise, int, (int sig));
 163 # else
 164 #  if !@HAVE_RAISE@
 165 _GL_FUNCDECL_SYS (raise, int, (int sig));
 166 #  endif
 167 _GL_CXXALIAS_SYS (raise, int, (int sig));
 168 # endif
 169 _GL_CXXALIASWARN (raise);
 170 #elif defined GNULIB_POSIXCHECK
 171 # undef raise
 172 /* Assume raise is always declared.  */
 173 _GL_WARN_ON_USE (raise, "raise can crash on native Windows - "
 174                  "use gnulib module raise for portability");
 175 #endif
 176
 177
 178 #if @GNULIB_SIGPROCMASK@
 179 # if !@HAVE_POSIX_SIGNALBLOCKING@
 180
 181 #  ifndef GNULIB_defined_signal_blocking
 182 #   define GNULIB_defined_signal_blocking 1
 183 #  endif
 184
 185 /* Maximum signal number + 1.  */
 186 #  ifndef NSIG
 187 #   define NSIG 32
 188 #  endif
 189
 190 /* This code supports only 32 signals.  */
 191 #  if !GNULIB_defined_verify_NSIG_constraint
 192 typedef int verify_NSIG_constraint[NSIG <= 32 ? 1 : -1];
 193 #   define GNULIB_defined_verify_NSIG_constraint 1
 194 #  endif
 195
 196 # endif
 197
 198 /* Test whether a given signal is contained in a signal set.  */
 199 # if @HAVE_POSIX_SIGNALBLOCKING@
 200 /* This function is defined as a macro on MacOS X.  */
 201 #  if defined __cplusplus && defined GNULIB_NAMESPACE
 202 #   undef sigismember
 203 #  endif
 204 # else
 205 _GL_FUNCDECL_SYS (sigismember, int, (const sigset_t *set, int sig)
 206                                     _GL_ARG_NONNULL ((1)));
 207 # endif
 208 _GL_CXXALIAS_SYS (sigismember, int, (const sigset_t *set, int sig));
 209 _GL_CXXALIASWARN (sigismember);
 210
 211 /* Initialize a signal set to the empty set.  */
 212 # if @HAVE_POSIX_SIGNALBLOCKING@
 213 /* This function is defined as a macro on MacOS X.  */
 214 #  if defined __cplusplus && defined GNULIB_NAMESPACE
 215 #   undef sigemptyset
 216 #  endif
 217 # else
 218 _GL_FUNCDECL_SYS (sigemptyset, int, (sigset_t *set) _GL_ARG_NONNULL ((1)));
 219 # endif
 220 _GL_CXXALIAS_SYS (sigemptyset, int, (sigset_t *set));
 221 _GL_CXXALIASWARN (sigemptyset);
 222
 223 /* Add a signal to a signal set.  */
 224 # if @HAVE_POSIX_SIGNALBLOCKING@
 225 /* This function is defined as a macro on MacOS X.  */
 226 #  if defined __cplusplus && defined GNULIB_NAMESPACE
 227 #   undef sigaddset
 228 #  endif
 229 # else
 230 _GL_FUNCDECL_SYS (sigaddset, int, (sigset_t *set, int sig)
 231                                   _GL_ARG_NONNULL ((1)));
 232 # endif
 233 _GL_CXXALIAS_SYS (sigaddset, int, (sigset_t *set, int sig));
 234 _GL_CXXALIASWARN (sigaddset);
 235
 236 /* Remove a signal from a signal set.  */
 237 # if @HAVE_POSIX_SIGNALBLOCKING@
 238 /* This function is defined as a macro on MacOS X.  */
 239 #  if defined __cplusplus && defined GNULIB_NAMESPACE
 240 #   undef sigdelset
 241 #  endif
 242 # else
 243 _GL_FUNCDECL_SYS (sigdelset, int, (sigset_t *set, int sig)
 244                                   _GL_ARG_NONNULL ((1)));
 245 # endif
 246 _GL_CXXALIAS_SYS (sigdelset, int, (sigset_t *set, int sig));
 247 _GL_CXXALIASWARN (sigdelset);
 248
 249 /* Fill a signal set with all possible signals.  */
 250 # if @HAVE_POSIX_SIGNALBLOCKING@
 251 /* This function is defined as a macro on MacOS X.  */
 252 #  if defined __cplusplus && defined GNULIB_NAMESPACE
 253 #   undef sigfillset
 254 #  endif
 255 # else
 256 _GL_FUNCDECL_SYS (sigfillset, int, (sigset_t *set) _GL_ARG_NONNULL ((1)));
 257 # endif
 258 _GL_CXXALIAS_SYS (sigfillset, int, (sigset_t *set));
 259 _GL_CXXALIASWARN (sigfillset);
 260
 261 /* Return the set of those blocked signals that are pending.  */
 262 # if !@HAVE_POSIX_SIGNALBLOCKING@
 263 _GL_FUNCDECL_SYS (sigpending, int, (sigset_t *set) _GL_ARG_NONNULL ((1)));
 264 # endif
 265 _GL_CXXALIAS_SYS (sigpending, int, (sigset_t *set));
 266 _GL_CXXALIASWARN (sigpending);
 267
 268 /* If OLD_SET is not NULL, put the current set of blocked signals in *OLD_SET.
 269    Then, if SET is not NULL, affect the current set of blocked signals by
 270    combining it with *SET as indicated in OPERATION.
 271    In this implementation, you are not allowed to change a signal handler
 272    while the signal is blocked.  */
 273 # if !@HAVE_POSIX_SIGNALBLOCKING@
 274 #  define SIG_BLOCK   0  /* blocked_set = blocked_set | *set; */
 275 #  define SIG_SETMASK 1  /* blocked_set = *set; */
 276 #  define SIG_UNBLOCK 2  /* blocked_set = blocked_set & ~*set; */
 277 _GL_FUNCDECL_SYS (sigprocmask, int,
 278                   (int operation, const sigset_t *set, sigset_t *old_set));
 279 # endif
 280 _GL_CXXALIAS_SYS (sigprocmask, int,
 281                   (int operation, const sigset_t *set, sigset_t *old_set));
 282 _GL_CXXALIASWARN (sigprocmask);
 283
 284 /* Install the handler FUNC for signal SIG, and return the previous
 285    handler.  */
 286 # ifdef __cplusplus
 287 extern "C" {
 288 # endif
 289 # if !GNULIB_defined_function_taking_int_returning_void_t
 290 typedef void (*_gl_function_taking_int_returning_void_t) (int);
 291 #  define GNULIB_defined_function_taking_int_returning_void_t 1
 292 # endif
 293 # ifdef __cplusplus
 294 }
 295 # endif
 296 # if !@HAVE_POSIX_SIGNALBLOCKING@
 297 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 298 #   define signal rpl_signal
 299 #  endif
 300 _GL_FUNCDECL_RPL (signal, _gl_function_taking_int_returning_void_t,
 301                   (int sig, _gl_function_taking_int_returning_void_t func));
 302 _GL_CXXALIAS_RPL (signal, _gl_function_taking_int_returning_void_t,
 303                   (int sig, _gl_function_taking_int_returning_void_t func));
 304 # else
 305 _GL_CXXALIAS_SYS (signal, _gl_function_taking_int_returning_void_t,
 306                   (int sig, _gl_function_taking_int_returning_void_t func));
 307 # endif
 308 _GL_CXXALIASWARN (signal);
 309
 310 # if !@HAVE_POSIX_SIGNALBLOCKING@ && GNULIB_defined_SIGPIPE
 311 /* Raise signal SIGPIPE.  */
 312 _GL_EXTERN_C int _gl_raise_SIGPIPE (void);
 313 # endif
 314
 315 #elif defined GNULIB_POSIXCHECK
 316 # undef sigaddset
 317 # if HAVE_RAW_DECL_SIGADDSET
 318 _GL_WARN_ON_USE (sigaddset, "sigaddset is unportable - "
 319                  "use the gnulib module sigprocmask for portability");
 320 # endif
 321 # undef sigdelset
 322 # if HAVE_RAW_DECL_SIGDELSET
 323 _GL_WARN_ON_USE (sigdelset, "sigdelset is unportable - "
 324                  "use the gnulib module sigprocmask for portability");
 325 # endif
 326 # undef sigemptyset
 327 # if HAVE_RAW_DECL_SIGEMPTYSET
 328 _GL_WARN_ON_USE (sigemptyset, "sigemptyset is unportable - "
 329                  "use the gnulib module sigprocmask for portability");
 330 # endif
 331 # undef sigfillset
 332 # if HAVE_RAW_DECL_SIGFILLSET
 333 _GL_WARN_ON_USE (sigfillset, "sigfillset is unportable - "
 334                  "use the gnulib module sigprocmask for portability");
 335 # endif
 336 # undef sigismember
 337 # if HAVE_RAW_DECL_SIGISMEMBER
 338 _GL_WARN_ON_USE (sigismember, "sigismember is unportable - "
 339                  "use the gnulib module sigprocmask for portability");
 340 # endif
 341 # undef sigpending
 342 # if HAVE_RAW_DECL_SIGPENDING
 343 _GL_WARN_ON_USE (sigpending, "sigpending is unportable - "
 344                  "use the gnulib module sigprocmask for portability");
 345 # endif
 346 # undef sigprocmask
 347 # if HAVE_RAW_DECL_SIGPROCMASK
 348 _GL_WARN_ON_USE (sigprocmask, "sigprocmask is unportable - "
 349                  "use the gnulib module sigprocmask for portability");
 350 # endif
 351 #endif /* @GNULIB_SIGPROCMASK@ */
 352
 353
 354 #if @GNULIB_SIGACTION@
 355 # if !@HAVE_SIGACTION@
 356
 357 #  if !@HAVE_SIGINFO_T@
 358
 359 #   if !GNULIB_defined_siginfo_types
 360
 361 /* Present to allow compilation, but unsupported by gnulib.  */
 362 union sigval
 363 {
 364   int sival_int;
 365   void *sival_ptr;
 366 };
 367
 368 /* Present to allow compilation, but unsupported by gnulib.  */
 369 struct siginfo_t
 370 {
 371   int si_signo;
 372   int si_code;
 373   int si_errno;
 374   pid_t si_pid;
 375   uid_t si_uid;
 376   void *si_addr;
 377   int si_status;
 378   long si_band;
 379   union sigval si_value;
 380 };
 381 typedef struct siginfo_t siginfo_t;
 382
 383 #    define GNULIB_defined_siginfo_types 1
 384 #   endif
 385
 386 #  endif /* !@HAVE_SIGINFO_T@ */
 387
 388 /* We assume that platforms which lack the sigaction() function also lack
 389    the 'struct sigaction' type, and vice versa.  */
 390
 391 #  if !GNULIB_defined_struct_sigaction
 392
 393 struct sigaction
 394 {
 395   union
 396   {
 397     void (*_sa_handler) (int);
 398     /* Present to allow compilation, but unsupported by gnulib.  POSIX
 399        says that implementations may, but not must, make sa_sigaction
 400        overlap with sa_handler, but we know of no implementation where
 401        they do not overlap.  */
 402     void (*_sa_sigaction) (int, siginfo_t *, void *);
 403   } _sa_func;
 404   sigset_t sa_mask;
 405   /* Not all POSIX flags are supported.  */
 406   int sa_flags;
 407 };
 408 #   define sa_handler _sa_func._sa_handler
 409 #   define sa_sigaction _sa_func._sa_sigaction
 410 /* Unsupported flags are not present.  */
 411 #   define SA_RESETHAND 1
 412 #   define SA_NODEFER 2
 413 #   define SA_RESTART 4
 414
 415 #   define GNULIB_defined_struct_sigaction 1
 416 #  endif
 417
 418 _GL_FUNCDECL_SYS (sigaction, int, (int, const struct sigaction *restrict,
 419                                    struct sigaction *restrict));
 420
 421 # elif !@HAVE_STRUCT_SIGACTION_SA_SIGACTION@
 422
 423 #  define sa_sigaction sa_handler
 424
 425 # endif /* !@HAVE_SIGACTION@, !@HAVE_STRUCT_SIGACTION_SA_SIGACTION@ */
 426
 427 _GL_CXXALIAS_SYS (sigaction, int, (int, const struct sigaction *restrict,
 428                                    struct sigaction *restrict));
 429 _GL_CXXALIASWARN (sigaction);
 430
 431 #elif defined GNULIB_POSIXCHECK
 432 # undef sigaction
 433 # if HAVE_RAW_DECL_SIGACTION
 434 _GL_WARN_ON_USE (sigaction, "sigaction is unportable - "
 435                  "use the gnulib module sigaction for portability");
 436 # endif
 437 #endif
 438
 439 /* Some systems don't have SA_NODEFER.  */
 440 #ifndef SA_NODEFER
 441 # define SA_NODEFER 0
 442 #endif
 443
 444
 445 #endif /* _@GUARD_PREFIX@_SIGNAL_H */
 446 #endif /* _@GUARD_PREFIX@_SIGNAL_H */
 447 #endif