Add parameter checks and extend documentation of estream.
[gnupg.git] / common / signal.c
1 /* signal.c - signal handling
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002,
3  *               2005 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #ifdef HAVE_SIGNAL_H
25 # include <signal.h>
26 #endif
27 #include <unistd.h>
28 #include <string.h>
29 #include <errno.h>
30 #include <assert.h>
31
32 #include "util.h"
33
34
35 #ifndef HAVE_DOSISH_SYSTEM
36 static volatile int caught_fatal_sig;
37 static volatile int caught_sigusr1;
38 #endif
39 static void (*cleanup_fnc)(void);
40
41
42 #ifndef HAVE_DOSISH_SYSTEM
43 static void
44 init_one_signal (int sig, RETSIGTYPE (*handler)(int), int check_ign )
45 {
46 # ifdef HAVE_SIGACTION
47   struct sigaction oact, nact;
48
49   if (check_ign)
50     {
51       /* we don't want to change an IGN handler */
52       sigaction (sig, NULL, &oact );
53       if (oact.sa_handler == SIG_IGN )
54         return;
55     }
56
57   nact.sa_handler = handler;
58   sigemptyset (&nact.sa_mask);
59   nact.sa_flags = 0;
60   sigaction ( sig, &nact, NULL);
61 # else
62   RETSIGTYPE (*ohandler)(int);
63
64   ohandler = signal (sig, handler);
65   if (check_ign && ohandler == SIG_IGN)
66     {
67       /* Change it back if it was already set to IGN */
68       signal (sig, SIG_IGN);
69     }
70 # endif
71 }
72 #endif /*!HAVE_DOSISH_SYSTEM*/
73
74 #ifndef HAVE_DOSISH_SYSTEM
75 static const char *
76 get_signal_name( int signum )
77 {
78   /* Note that we can't use strsignal(), because it is not
79      reentrant. */
80 #if HAVE_DECL_SYS_SIGLIST && defined(NSIG)
81   return (signum >= 0 && signum < NSIG) ? sys_siglist[signum] : "?";
82 #else
83   return NULL;
84 #endif
85 }
86 #endif /*!HAVE_DOSISH_SYSTEM*/
87
88 #ifndef HAVE_DOSISH_SYSTEM
89 static RETSIGTYPE
90 got_fatal_signal (int sig)
91 {
92   const char *s;
93
94   if (caught_fatal_sig)
95     raise (sig);
96   caught_fatal_sig = 1;
97
98   if (cleanup_fnc)
99     cleanup_fnc ();
100   /* Better don't translate these messages. */
101   (void)write (2, "\n", 1 );
102   s = log_get_prefix (NULL);
103   if (s)
104     (void)write(2, s, strlen (s));
105   (void)write (2, ": signal ", 9 );
106   s = get_signal_name(sig);
107   if (s)
108     (void) write (2, s, strlen(s) );
109   else
110     {
111       /* We are in a signal handler so we can't use any kind of printf
112          even not sprintf.  So we use a straightforward algorithm.  We
113          got a report that on one particular system, raising a signal
114          while in this handler, the parameter SIG get sclobbered and
115          things are messed up because we modify its value.  Although
116          this is a bug in that system, we will protect against it.  */
117       if (sig < 0 || sig >= 100000)
118         (void)write (2, "?", 1);
119       else
120         {
121           int i, value, any=0;
122
123           for (value=sig,i=10000; i; i /= 10)
124             {
125               if (value >= i || ((any || i==1) && !(value/i)))
126                 {
127                   (void)write (2, "0123456789"+(value/i), 1);
128                   if ((value/i))
129                     any = 1;
130                   value %= i;
131                 }
132             }
133         }
134     }
135   (void)write (2, " caught ... exiting\n", 20);
136
137   /* Reset action to default action and raise signal again */
138   init_one_signal (sig, SIG_DFL, 0);
139   /* Fixme: remove_lockfiles ();*/
140 #ifdef __riscos__
141   close_fds ();
142 #endif /* __riscos__ */
143   raise( sig );
144 }
145 #endif /*!HAVE_DOSISH_SYSTEM*/
146
147 #ifndef HAVE_DOSISH_SYSTEM
148 static RETSIGTYPE
149 got_usr_signal (int sig)
150 {
151   (void)sig;
152   caught_sigusr1 = 1;
153 }
154 #endif /*!HAVE_DOSISH_SYSTEM*/
155
156 void
157 gnupg_init_signals (int mode, void (*fast_cleanup)(void))
158 {
159   assert (!mode);
160
161   cleanup_fnc = fast_cleanup;
162 #ifndef HAVE_DOSISH_SYSTEM
163   init_one_signal (SIGINT, got_fatal_signal, 1 );
164   init_one_signal (SIGHUP, got_fatal_signal, 1 );
165   init_one_signal (SIGTERM, got_fatal_signal, 1 );
166   init_one_signal (SIGQUIT, got_fatal_signal, 1 );
167   init_one_signal (SIGSEGV, got_fatal_signal, 1 );
168   init_one_signal (SIGUSR1, got_usr_signal, 0 );
169   init_one_signal (SIGPIPE, SIG_IGN, 0 );
170 #endif
171 }
172
173
174 static void
175 do_block (int block)
176 {
177 #ifdef HAVE_DOSISH_SYSTEM
178   (void)block;
179 #else /*!HAVE_DOSISH_SYSTEM*/
180   static int is_blocked;
181 #ifdef HAVE_SIGPROCMASK
182   static sigset_t oldmask;
183
184   if (block)
185     {
186       sigset_t newmask;
187
188       if (is_blocked)
189         log_bug ("signals are already blocked\n");
190       sigfillset( &newmask );
191       sigprocmask( SIG_BLOCK, &newmask, &oldmask );
192       is_blocked = 1;
193     }
194   else
195     {
196       if (!is_blocked)
197         log_bug("signals are not blocked\n");
198       sigprocmask (SIG_SETMASK, &oldmask, NULL);
199       is_blocked = 0;
200     }
201 #else /*!HAVE_SIGPROCMASK*/
202   static void (*disposition[MAXSIG])();
203   int sig;
204
205   if (block)
206     {
207       if (is_blocked)
208         log_bug("signals are already blocked\n");
209       for (sig=1; sig < MAXSIG; sig++)
210         {
211           disposition[sig] = sigset (sig, SIG_HOLD);
212         }
213       is_blocked = 1;
214     }
215   else
216     {
217       if (!is_blocked)
218         log_bug ("signals are not blocked\n");
219       for (sig=1; sig < MAXSIG; sig++) {
220         sigset (sig, disposition[sig]);
221       }
222       is_blocked = 0;
223     }
224 #endif /*!HAVE_SIGPROCMASK*/
225 #endif /*!HAVE_DOSISH_SYSTEM*/
226 }
227
228
229 void
230 gnupg_block_all_signals ()
231 {
232   do_block(1);
233 }
234
235 void
236 gnupg_unblock_all_signals ()
237 {
238   do_block(0);
239 }