Merge "master" into "next".
[openvswitch] / lib / fatal-signal.c
1 /*
2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #include <config.h>
17 #include "fatal-signal.h"
18 #include <assert.h>
19 #include <errno.h>
20 #include <signal.h>
21 #include <stdbool.h>
22 #include <stdio.h>
23 #include <stdint.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <unistd.h>
27 #include "poll-loop.h"
28 #include "shash.h"
29 #include "socket-util.h"
30 #include "util.h"
31
32 #define THIS_MODULE VLM_fatal_signal
33 #include "vlog.h"
34
35 /* Signals to catch. */
36 static const int fatal_signals[] = { SIGTERM, SIGINT, SIGHUP, SIGALRM };
37
38 /* Signals to catch as a sigset_t. */
39 static sigset_t fatal_signal_set;
40
41 /* Hooks to call upon catching a signal */
42 struct hook {
43     void (*hook_cb)(void *aux);
44     void (*cancel_cb)(void *aux);
45     void *aux;
46     bool run_at_exit;
47 };
48 #define MAX_HOOKS 32
49 static struct hook hooks[MAX_HOOKS];
50 static size_t n_hooks;
51
52 static int signal_fds[2];
53 static volatile sig_atomic_t stored_sig_nr = SIG_ATOMIC_MAX;
54
55 static void fatal_signal_init(void);
56 static void atexit_handler(void);
57 static void call_hooks(int sig_nr);
58
59 static void
60 fatal_signal_init(void)
61 {
62     static bool inited = false;
63
64     if (!inited) {
65         size_t i;
66
67         inited = true;
68
69         if (pipe(signal_fds)) {
70             ovs_fatal(errno, "could not create pipe");
71         }
72         set_nonblocking(signal_fds[0]);
73         set_nonblocking(signal_fds[1]);
74
75         sigemptyset(&fatal_signal_set);
76         for (i = 0; i < ARRAY_SIZE(fatal_signals); i++) {
77             int sig_nr = fatal_signals[i];
78             struct sigaction old_sa;
79
80             sigaddset(&fatal_signal_set, sig_nr);
81             if (sigaction(sig_nr, NULL, &old_sa)) {
82                 ovs_fatal(errno, "sigaction");
83             }
84             if (old_sa.sa_handler == SIG_DFL
85                 && signal(sig_nr, fatal_signal_handler) == SIG_ERR) {
86                 ovs_fatal(errno, "signal");
87             }
88         }
89         atexit(atexit_handler);
90     }
91 }
92
93 /* Registers 'hook_cb' to be called when a process termination signal is
94  * raised.  If 'run_at_exit' is true, 'hook_cb' is also called during normal
95  * process termination, e.g. when exit() is called or when main() returns.
96  *
97  * 'hook_cb' is not called immediately from the signal handler but rather the
98  * next time the poll loop iterates, so it is freed from the usual restrictions
99  * on signal handler functions.
100  *
101  * If the current process forks, fatal_signal_fork() may be called to clear the
102  * parent process's fatal signal hooks, so that 'hook_cb' is only called when
103  * the child terminates, not when the parent does.  When fatal_signal_fork() is
104  * called, it calls the 'cancel_cb' function if it is nonnull, passing 'aux',
105  * to notify that the hook has been canceled.  This allows the hook to free
106  * memory, etc. */
107 void
108 fatal_signal_add_hook(void (*hook_cb)(void *aux), void (*cancel_cb)(void *aux),
109                       void *aux, bool run_at_exit)
110 {
111     fatal_signal_init();
112
113     assert(n_hooks < MAX_HOOKS);
114     hooks[n_hooks].hook_cb = hook_cb;
115     hooks[n_hooks].cancel_cb = cancel_cb;
116     hooks[n_hooks].aux = aux;
117     hooks[n_hooks].run_at_exit = run_at_exit;
118     n_hooks++;
119 }
120
121 /* Handles fatal signal number 'sig_nr'.
122  *
123  * Ordinarily this is the actual signal handler.  When other code needs to
124  * handle one of our signals, however, it can register for that signal and, if
125  * and when necessary, call this function to do fatal signal processing for it
126  * and terminate the process.  Currently only timeval.c does this, for SIGALRM.
127  * (It is not important whether the other code sets up its signal handler
128  * before or after this file, because this file will only set up a signal
129  * handler in the case where the signal has its default handling.)  */
130 void
131 fatal_signal_handler(int sig_nr)
132 {
133     ignore(write(signal_fds[1], "", 1));
134     stored_sig_nr = sig_nr;
135 }
136
137 void
138 fatal_signal_run(void)
139 {
140     int sig_nr = stored_sig_nr;
141
142     if (sig_nr != SIG_ATOMIC_MAX) {
143         call_hooks(sig_nr);
144
145         /* Re-raise the signal with the default handling so that the program
146          * termination status reflects that we were killed by this signal */
147         signal(sig_nr, SIG_DFL);
148         raise(sig_nr);
149     }
150 }
151
152 void
153 fatal_signal_wait(void)
154 {
155     poll_fd_wait(signal_fds[0], POLLIN);
156 }
157
158 static void
159 atexit_handler(void)
160 {
161     call_hooks(0);
162 }
163
164 static void
165 call_hooks(int sig_nr)
166 {
167     static volatile sig_atomic_t recurse = 0;
168     if (!recurse) {
169         size_t i;
170
171         recurse = 1;
172
173         for (i = 0; i < n_hooks; i++) {
174             struct hook *h = &hooks[i];
175             if (sig_nr || h->run_at_exit) {
176                 h->hook_cb(h->aux);
177             }
178         }
179     }
180 }
181 \f
182 /* Files to delete on exit.  (The 'data' member of each node is unused.) */
183 static struct shash files = SHASH_INITIALIZER(&files);
184
185 /* Has a hook function been registered with fatal_signal_add_hook() (and not
186  * cleared by fatal_signal_fork())? */
187 static bool added_hook;
188
189 static void unlink_files(void *aux);
190 static void cancel_files(void *aux);
191 static void do_unlink_files(void);
192
193 /* Registers 'file' to be unlinked when the program terminates via exit() or a
194  * fatal signal. */
195 void
196 fatal_signal_add_file_to_unlink(const char *file)
197 {
198     if (!added_hook) {
199         added_hook = true;
200         fatal_signal_add_hook(unlink_files, cancel_files, NULL, true);
201     }
202
203     if (!shash_find(&files, file)) {
204         shash_add(&files, file, NULL);
205     }
206 }
207
208 /* Unregisters 'file' from being unlinked when the program terminates via
209  * exit() or a fatal signal. */
210 void
211 fatal_signal_remove_file_to_unlink(const char *file)
212 {
213     struct shash_node *node;
214
215     node = shash_find(&files, file);
216     if (node) {
217         shash_delete(&files, node);
218     }
219 }
220
221 /* Like fatal_signal_remove_file_to_unlink(), but also unlinks 'file'.
222  * Returns 0 if successful, otherwise a positive errno value. */
223 int
224 fatal_signal_unlink_file_now(const char *file)
225 {
226     int error = unlink(file) ? errno : 0;
227     if (error) {
228         VLOG_WARN("could not unlink \"%s\" (%s)", file, strerror(error));
229     }
230
231     fatal_signal_remove_file_to_unlink(file);
232
233     return error;
234 }
235
236 static void
237 unlink_files(void *aux OVS_UNUSED)
238 {
239     do_unlink_files(); 
240 }
241
242 static void
243 cancel_files(void *aux OVS_UNUSED)
244 {
245     shash_clear(&files);
246     added_hook = false;
247 }
248
249 static void
250 do_unlink_files(void)
251 {
252     struct shash_node *node;
253
254     SHASH_FOR_EACH (node, &files) {
255         unlink(node->name);
256     }
257 }
258 \f
259 /* Clears all of the fatal signal hooks without executing them.  If any of the
260  * hooks passed a 'cancel_cb' function to fatal_signal_add_hook(), then those
261  * functions will be called, allowing them to free resources, etc.
262  *
263  * Following a fork, one of the resulting processes can call this function to
264  * allow it to terminate without calling the hooks registered before calling
265  * this function.  New hooks registered after calling this function will take
266  * effect normally. */
267 void
268 fatal_signal_fork(void)
269 {
270     size_t i;
271
272     for (i = 0; i < n_hooks; i++) {
273         struct hook *h = &hooks[i];
274         if (h->cancel_cb) {
275             h->cancel_cb(h->aux);
276         }
277     }
278     n_hooks = 0;
279
280     /* Raise any signals that we have already received with the default
281      * handler. */
282     if (stored_sig_nr != SIG_ATOMIC_MAX) {
283         raise(stored_sig_nr);
284     }
285 }