Merge changes from emacs-23 branch
[bpt/emacs.git] / lib / signal.in.h
CommitLineData
6db30f83
PE
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
2a84b02d
PE
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. */
6db30f83
PE
34
35# @INCLUDE_NEXT@ @NEXT_SIGNAL_H@
36
37#else
38/* Normal invocation convention. */
39
40#ifndef _@GUARD_PREFIX@_SIGNAL_H
41
2a84b02d
PE
42#define _GL_ALREADY_INCLUDING_SIGNAL_H
43
6db30f83
PE
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
2a84b02d
PE
53#undef _GL_ALREADY_INCLUDING_SIGNAL_H
54
6db30f83
PE
55#ifndef _@GUARD_PREFIX@_SIGNAL_H
56#define _@GUARD_PREFIX@_SIGNAL_H
57
2a84b02d
PE
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
6db30f83
PE
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
78typedef 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
88typedef 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
96extern "C" {
97# endif
98# if !GNULIB_defined_sighandler_t
99typedef 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@
2a84b02d
PE
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));
6db30f83 144# endif
2a84b02d 145_GL_CXXALIASWARN (pthread_sigmask);
6db30f83
PE
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_SIGPROCMASK@
156# if !@HAVE_POSIX_SIGNALBLOCKING@
157
158/* Maximum signal number + 1. */
159# ifndef NSIG
160# define NSIG 32
161# endif
162
163/* This code supports only 32 signals. */
164# if !GNULIB_defined_verify_NSIG_constraint
165typedef int verify_NSIG_constraint[NSIG <= 32 ? 1 : -1];
166# define GNULIB_defined_verify_NSIG_constraint 1
167# endif
168
169# endif
170
171/* Test whether a given signal is contained in a signal set. */
172# if @HAVE_POSIX_SIGNALBLOCKING@
173/* This function is defined as a macro on MacOS X. */
174# if defined __cplusplus && defined GNULIB_NAMESPACE
175# undef sigismember
176# endif
177# else
178_GL_FUNCDECL_SYS (sigismember, int, (const sigset_t *set, int sig)
179 _GL_ARG_NONNULL ((1)));
180# endif
181_GL_CXXALIAS_SYS (sigismember, int, (const sigset_t *set, int sig));
182_GL_CXXALIASWARN (sigismember);
183
184/* Initialize a signal set to the empty set. */
185# if @HAVE_POSIX_SIGNALBLOCKING@
186/* This function is defined as a macro on MacOS X. */
187# if defined __cplusplus && defined GNULIB_NAMESPACE
188# undef sigemptyset
189# endif
190# else
191_GL_FUNCDECL_SYS (sigemptyset, int, (sigset_t *set) _GL_ARG_NONNULL ((1)));
192# endif
193_GL_CXXALIAS_SYS (sigemptyset, int, (sigset_t *set));
194_GL_CXXALIASWARN (sigemptyset);
195
196/* Add a signal to a signal set. */
197# if @HAVE_POSIX_SIGNALBLOCKING@
198/* This function is defined as a macro on MacOS X. */
199# if defined __cplusplus && defined GNULIB_NAMESPACE
200# undef sigaddset
201# endif
202# else
203_GL_FUNCDECL_SYS (sigaddset, int, (sigset_t *set, int sig)
204 _GL_ARG_NONNULL ((1)));
205# endif
206_GL_CXXALIAS_SYS (sigaddset, int, (sigset_t *set, int sig));
207_GL_CXXALIASWARN (sigaddset);
208
209/* Remove a signal from a signal set. */
210# if @HAVE_POSIX_SIGNALBLOCKING@
211/* This function is defined as a macro on MacOS X. */
212# if defined __cplusplus && defined GNULIB_NAMESPACE
213# undef sigdelset
214# endif
215# else
216_GL_FUNCDECL_SYS (sigdelset, int, (sigset_t *set, int sig)
217 _GL_ARG_NONNULL ((1)));
218# endif
219_GL_CXXALIAS_SYS (sigdelset, int, (sigset_t *set, int sig));
220_GL_CXXALIASWARN (sigdelset);
221
222/* Fill a signal set with all possible signals. */
223# if @HAVE_POSIX_SIGNALBLOCKING@
224/* This function is defined as a macro on MacOS X. */
225# if defined __cplusplus && defined GNULIB_NAMESPACE
226# undef sigfillset
227# endif
228# else
229_GL_FUNCDECL_SYS (sigfillset, int, (sigset_t *set) _GL_ARG_NONNULL ((1)));
230# endif
231_GL_CXXALIAS_SYS (sigfillset, int, (sigset_t *set));
232_GL_CXXALIASWARN (sigfillset);
233
234/* Return the set of those blocked signals that are pending. */
235# if !@HAVE_POSIX_SIGNALBLOCKING@
236_GL_FUNCDECL_SYS (sigpending, int, (sigset_t *set) _GL_ARG_NONNULL ((1)));
237# endif
238_GL_CXXALIAS_SYS (sigpending, int, (sigset_t *set));
239_GL_CXXALIASWARN (sigpending);
240
241/* If OLD_SET is not NULL, put the current set of blocked signals in *OLD_SET.
242 Then, if SET is not NULL, affect the current set of blocked signals by
243 combining it with *SET as indicated in OPERATION.
244 In this implementation, you are not allowed to change a signal handler
245 while the signal is blocked. */
246# if !@HAVE_POSIX_SIGNALBLOCKING@
247# define SIG_BLOCK 0 /* blocked_set = blocked_set | *set; */
248# define SIG_SETMASK 1 /* blocked_set = *set; */
249# define SIG_UNBLOCK 2 /* blocked_set = blocked_set & ~*set; */
250_GL_FUNCDECL_SYS (sigprocmask, int,
251 (int operation, const sigset_t *set, sigset_t *old_set));
252# endif
253_GL_CXXALIAS_SYS (sigprocmask, int,
254 (int operation, const sigset_t *set, sigset_t *old_set));
255_GL_CXXALIASWARN (sigprocmask);
256
257/* Install the handler FUNC for signal SIG, and return the previous
258 handler. */
259# ifdef __cplusplus
260extern "C" {
261# endif
262# if !GNULIB_defined_function_taking_int_returning_void_t
263typedef void (*_gl_function_taking_int_returning_void_t) (int);
264# define GNULIB_defined_function_taking_int_returning_void_t 1
265# endif
266# ifdef __cplusplus
267}
268# endif
269# if !@HAVE_POSIX_SIGNALBLOCKING@
270# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
271# define signal rpl_signal
272# endif
273_GL_FUNCDECL_RPL (signal, _gl_function_taking_int_returning_void_t,
274 (int sig, _gl_function_taking_int_returning_void_t func));
275_GL_CXXALIAS_RPL (signal, _gl_function_taking_int_returning_void_t,
276 (int sig, _gl_function_taking_int_returning_void_t func));
277# else
278_GL_CXXALIAS_SYS (signal, _gl_function_taking_int_returning_void_t,
279 (int sig, _gl_function_taking_int_returning_void_t func));
280# endif
281_GL_CXXALIASWARN (signal);
282
283/* Raise signal SIG. */
284# if !@HAVE_POSIX_SIGNALBLOCKING@ && GNULIB_defined_SIGPIPE
285# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
286# undef raise
287# define raise rpl_raise
288# endif
289_GL_FUNCDECL_RPL (raise, int, (int sig));
290_GL_CXXALIAS_RPL (raise, int, (int sig));
291# else
292_GL_CXXALIAS_SYS (raise, int, (int sig));
293# endif
294_GL_CXXALIASWARN (raise);
295
296#elif defined GNULIB_POSIXCHECK
297# undef sigaddset
298# if HAVE_RAW_DECL_SIGADDSET
299_GL_WARN_ON_USE (sigaddset, "sigaddset is unportable - "
300 "use the gnulib module sigprocmask for portability");
301# endif
302# undef sigdelset
303# if HAVE_RAW_DECL_SIGDELSET
304_GL_WARN_ON_USE (sigdelset, "sigdelset is unportable - "
305 "use the gnulib module sigprocmask for portability");
306# endif
307# undef sigemptyset
308# if HAVE_RAW_DECL_SIGEMPTYSET
309_GL_WARN_ON_USE (sigemptyset, "sigemptyset is unportable - "
310 "use the gnulib module sigprocmask for portability");
311# endif
312# undef sigfillset
313# if HAVE_RAW_DECL_SIGFILLSET
314_GL_WARN_ON_USE (sigfillset, "sigfillset is unportable - "
315 "use the gnulib module sigprocmask for portability");
316# endif
317# undef sigismember
318# if HAVE_RAW_DECL_SIGISMEMBER
319_GL_WARN_ON_USE (sigismember, "sigismember is unportable - "
320 "use the gnulib module sigprocmask for portability");
321# endif
322# undef sigpending
323# if HAVE_RAW_DECL_SIGPENDING
324_GL_WARN_ON_USE (sigpending, "sigpending is unportable - "
325 "use the gnulib module sigprocmask for portability");
326# endif
327# undef sigprocmask
328# if HAVE_RAW_DECL_SIGPROCMASK
329_GL_WARN_ON_USE (sigprocmask, "sigprocmask is unportable - "
330 "use the gnulib module sigprocmask for portability");
331# endif
332#endif /* @GNULIB_SIGPROCMASK@ */
333
334
335#if @GNULIB_SIGACTION@
336# if !@HAVE_SIGACTION@
337
338# if !@HAVE_SIGINFO_T@
339
340# if !GNULIB_defined_siginfo_types
341
342/* Present to allow compilation, but unsupported by gnulib. */
343union sigval
344{
345 int sival_int;
346 void *sival_ptr;
347};
348
349/* Present to allow compilation, but unsupported by gnulib. */
350struct siginfo_t
351{
352 int si_signo;
353 int si_code;
354 int si_errno;
355 pid_t si_pid;
356 uid_t si_uid;
357 void *si_addr;
358 int si_status;
359 long si_band;
360 union sigval si_value;
361};
362typedef struct siginfo_t siginfo_t;
363
364# define GNULIB_defined_siginfo_types 1
365# endif
366
367# endif /* !@HAVE_SIGINFO_T@ */
368
369/* We assume that platforms which lack the sigaction() function also lack
370 the 'struct sigaction' type, and vice versa. */
371
372# if !GNULIB_defined_struct_sigaction
373
374struct sigaction
375{
376 union
377 {
378 void (*_sa_handler) (int);
379 /* Present to allow compilation, but unsupported by gnulib. POSIX
380 says that implementations may, but not must, make sa_sigaction
381 overlap with sa_handler, but we know of no implementation where
382 they do not overlap. */
383 void (*_sa_sigaction) (int, siginfo_t *, void *);
384 } _sa_func;
385 sigset_t sa_mask;
386 /* Not all POSIX flags are supported. */
387 int sa_flags;
388};
389# define sa_handler _sa_func._sa_handler
390# define sa_sigaction _sa_func._sa_sigaction
391/* Unsupported flags are not present. */
392# define SA_RESETHAND 1
393# define SA_NODEFER 2
394# define SA_RESTART 4
395
396# define GNULIB_defined_struct_sigaction 1
397# endif
398
399_GL_FUNCDECL_SYS (sigaction, int, (int, const struct sigaction *restrict,
400 struct sigaction *restrict));
401
402# elif !@HAVE_STRUCT_SIGACTION_SA_SIGACTION@
403
404# define sa_sigaction sa_handler
405
406# endif /* !@HAVE_SIGACTION@, !@HAVE_STRUCT_SIGACTION_SA_SIGACTION@ */
407
408_GL_CXXALIAS_SYS (sigaction, int, (int, const struct sigaction *restrict,
409 struct sigaction *restrict));
410_GL_CXXALIASWARN (sigaction);
411
412#elif defined GNULIB_POSIXCHECK
413# undef sigaction
414# if HAVE_RAW_DECL_SIGACTION
415_GL_WARN_ON_USE (sigaction, "sigaction is unportable - "
416 "use the gnulib module sigaction for portability");
417# endif
418#endif
419
420/* Some systems don't have SA_NODEFER. */
421#ifndef SA_NODEFER
422# define SA_NODEFER 0
423#endif
424
425
426#endif /* _@GUARD_PREFIX@_SIGNAL_H */
427#endif /* _@GUARD_PREFIX@_SIGNAL_H */
428#endif