]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
10a89ef0 | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc. |
064af421 | 3 | * |
a14bc59f BP |
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: | |
064af421 | 7 | * |
a14bc59f BP |
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. | |
064af421 BP |
15 | */ |
16 | #include <config.h> | |
17 | #include "fatal-signal.h" | |
064af421 BP |
18 | #include <errno.h> |
19 | #include <signal.h> | |
20 | #include <stdbool.h> | |
21 | #include <stdio.h> | |
d8b30702 | 22 | #include <stdint.h> |
064af421 BP |
23 | #include <stdlib.h> |
24 | #include <string.h> | |
25 | #include <unistd.h> | |
b847adc6 | 26 | #include "ovs-thread.h" |
d8b30702 | 27 | #include "poll-loop.h" |
411baaac | 28 | #include "shash.h" |
b3c01ed3 | 29 | #include "sset.h" |
279c9e03 | 30 | #include "signals.h" |
d8b30702 | 31 | #include "socket-util.h" |
064af421 | 32 | #include "util.h" |
e6211adc | 33 | #include "openvswitch/vlog.h" |
6a0061cb | 34 | |
ae06a561 | 35 | #include "openvswitch/type-props.h" |
0c2c9057 SH |
36 | |
37 | #ifndef SIG_ATOMIC_MAX | |
38 | #define SIG_ATOMIC_MAX TYPE_MAXIMUM(sig_atomic_t) | |
39 | #endif | |
40 | ||
d98e6007 | 41 | VLOG_DEFINE_THIS_MODULE(fatal_signal); |
5136ce49 | 42 | |
064af421 | 43 | /* Signals to catch. */ |
84a6cbae | 44 | #ifndef _WIN32 |
064af421 | 45 | static const int fatal_signals[] = { SIGTERM, SIGINT, SIGHUP, SIGALRM }; |
84a6cbae GS |
46 | #else |
47 | static const int fatal_signals[] = { SIGTERM }; | |
48 | #endif | |
064af421 | 49 | |
064af421 BP |
50 | /* Hooks to call upon catching a signal */ |
51 | struct hook { | |
e3830e90 BP |
52 | void (*hook_cb)(void *aux); |
53 | void (*cancel_cb)(void *aux); | |
064af421 BP |
54 | void *aux; |
55 | bool run_at_exit; | |
56 | }; | |
57 | #define MAX_HOOKS 32 | |
58 | static struct hook hooks[MAX_HOOKS]; | |
59 | static size_t n_hooks; | |
60 | ||
d8b30702 JG |
61 | static int signal_fds[2]; |
62 | static volatile sig_atomic_t stored_sig_nr = SIG_ATOMIC_MAX; | |
064af421 | 63 | |
1ca3348e GS |
64 | #ifdef _WIN32 |
65 | static HANDLE wevent; | |
66 | #endif | |
67 | ||
97be1538 | 68 | static struct ovs_mutex mutex; |
b847adc6 | 69 | |
064af421 | 70 | static void call_hooks(int sig_nr); |
0c100540 GS |
71 | #ifdef _WIN32 |
72 | static BOOL WINAPI ConsoleHandlerRoutine(DWORD dwCtrlType); | |
73 | #endif | |
064af421 | 74 | |
b847adc6 BP |
75 | /* Initializes the fatal signal handling module. Calling this function is |
76 | * optional, because calling any other function in the module will also | |
77 | * initialize it. However, in a multithreaded program, the module must be | |
78 | * initialized while the process is still single-threaded. */ | |
79 | void | |
d8b30702 | 80 | fatal_signal_init(void) |
064af421 BP |
81 | { |
82 | static bool inited = false; | |
d8b30702 | 83 | |
064af421 BP |
84 | if (!inited) { |
85 | size_t i; | |
86 | ||
b847adc6 | 87 | assert_single_threaded(); |
064af421 | 88 | inited = true; |
d8b30702 | 89 | |
834d6caf | 90 | ovs_mutex_init_recursive(&mutex); |
84a6cbae | 91 | #ifndef _WIN32 |
c0d95206 | 92 | xpipe_nonblocking(signal_fds); |
84a6cbae GS |
93 | #else |
94 | wevent = CreateEvent(NULL, TRUE, FALSE, NULL); | |
95 | if (!wevent) { | |
96 | char *msg_buf = ovs_lasterror_to_string(); | |
97 | VLOG_FATAL("Failed to create a event (%s).", msg_buf); | |
98 | } | |
0c100540 GS |
99 | |
100 | /* Register a function to handle Ctrl+C. */ | |
101 | SetConsoleCtrlHandler(ConsoleHandlerRoutine, true); | |
84a6cbae | 102 | #endif |
d8b30702 | 103 | |
064af421 BP |
104 | for (i = 0; i < ARRAY_SIZE(fatal_signals); i++) { |
105 | int sig_nr = fatal_signals[i]; | |
84a6cbae | 106 | #ifndef _WIN32 |
064af421 BP |
107 | struct sigaction old_sa; |
108 | ||
279c9e03 | 109 | xsigaction(sig_nr, NULL, &old_sa); |
064af421 BP |
110 | if (old_sa.sa_handler == SIG_DFL |
111 | && signal(sig_nr, fatal_signal_handler) == SIG_ERR) { | |
10a89ef0 | 112 | VLOG_FATAL("signal failed (%s)", ovs_strerror(errno)); |
064af421 | 113 | } |
84a6cbae GS |
114 | #else |
115 | if (signal(sig_nr, fatal_signal_handler) == SIG_ERR) { | |
116 | VLOG_FATAL("signal failed (%s)", ovs_strerror(errno)); | |
117 | } | |
118 | #endif | |
064af421 | 119 | } |
02a514ef | 120 | atexit(fatal_signal_atexit_handler); |
064af421 | 121 | } |
064af421 BP |
122 | } |
123 | ||
b847adc6 BP |
124 | /* Registers 'hook_cb' to be called from inside poll_block() following a fatal |
125 | * signal. 'hook_cb' does not need to be async-signal-safe. In a | |
126 | * multithreaded program 'hook_cb' might be called from any thread, with | |
127 | * threads other than the one running 'hook_cb' in unknown states. | |
d8b30702 | 128 | * |
b847adc6 BP |
129 | * If 'run_at_exit' is true, 'hook_cb' is also called during normal process |
130 | * termination, e.g. when exit() is called or when main() returns. | |
e3830e90 BP |
131 | * |
132 | * If the current process forks, fatal_signal_fork() may be called to clear the | |
133 | * parent process's fatal signal hooks, so that 'hook_cb' is only called when | |
134 | * the child terminates, not when the parent does. When fatal_signal_fork() is | |
135 | * called, it calls the 'cancel_cb' function if it is nonnull, passing 'aux', | |
136 | * to notify that the hook has been canceled. This allows the hook to free | |
137 | * memory, etc. */ | |
064af421 | 138 | void |
e3830e90 BP |
139 | fatal_signal_add_hook(void (*hook_cb)(void *aux), void (*cancel_cb)(void *aux), |
140 | void *aux, bool run_at_exit) | |
064af421 | 141 | { |
d8b30702 | 142 | fatal_signal_init(); |
e3830e90 | 143 | |
97be1538 | 144 | ovs_mutex_lock(&mutex); |
cb22974d | 145 | ovs_assert(n_hooks < MAX_HOOKS); |
e3830e90 BP |
146 | hooks[n_hooks].hook_cb = hook_cb; |
147 | hooks[n_hooks].cancel_cb = cancel_cb; | |
d8b30702 JG |
148 | hooks[n_hooks].aux = aux; |
149 | hooks[n_hooks].run_at_exit = run_at_exit; | |
150 | n_hooks++; | |
97be1538 | 151 | ovs_mutex_unlock(&mutex); |
064af421 BP |
152 | } |
153 | ||
154 | /* Handles fatal signal number 'sig_nr'. | |
155 | * | |
156 | * Ordinarily this is the actual signal handler. When other code needs to | |
157 | * handle one of our signals, however, it can register for that signal and, if | |
158 | * and when necessary, call this function to do fatal signal processing for it | |
159 | * and terminate the process. Currently only timeval.c does this, for SIGALRM. | |
160 | * (It is not important whether the other code sets up its signal handler | |
161 | * before or after this file, because this file will only set up a signal | |
162 | * handler in the case where the signal has its default handling.) */ | |
163 | void | |
164 | fatal_signal_handler(int sig_nr) | |
165 | { | |
84a6cbae | 166 | #ifndef _WIN32 |
d8b30702 | 167 | ignore(write(signal_fds[1], "", 1)); |
84a6cbae GS |
168 | #else |
169 | SetEvent(wevent); | |
170 | #endif | |
d8b30702 JG |
171 | stored_sig_nr = sig_nr; |
172 | } | |
173 | ||
b302749b BP |
174 | /* Check whether a fatal signal has occurred and, if so, call the fatal signal |
175 | * hooks and exit. | |
176 | * | |
177 | * This function is called automatically by poll_block(), but specialized | |
178 | * programs that may not always call poll_block() on a regular basis should | |
179 | * also call it periodically. (Therefore, any function with "block" in its | |
180 | * name should call fatal_signal_run() each time it is called, either directly | |
181 | * or through poll_block(), because such functions can only used by specialized | |
182 | * programs that can afford to block outside their main loop around | |
183 | * poll_block().) | |
184 | */ | |
d8b30702 JG |
185 | void |
186 | fatal_signal_run(void) | |
187 | { | |
bf82917b | 188 | sig_atomic_t sig_nr; |
064af421 | 189 | |
c874f17f BP |
190 | fatal_signal_init(); |
191 | ||
192 | sig_nr = stored_sig_nr; | |
d8b30702 | 193 | if (sig_nr != SIG_ATOMIC_MAX) { |
eee8089c BP |
194 | char namebuf[SIGNAL_NAME_BUFSIZE]; |
195 | ||
97be1538 | 196 | ovs_mutex_lock(&mutex); |
b847adc6 | 197 | |
84a6cbae | 198 | #ifndef _WIN32 |
b67b2b0a | 199 | VLOG_WARN("terminating with signal %d (%s)", |
eee8089c | 200 | (int)sig_nr, signal_name(sig_nr, namebuf, sizeof namebuf)); |
84a6cbae GS |
201 | #else |
202 | VLOG_WARN("terminating with signal %d", (int)sig_nr); | |
203 | #endif | |
d8b30702 | 204 | call_hooks(sig_nr); |
9e784ba5 | 205 | fflush(stderr); |
d8b30702 JG |
206 | |
207 | /* Re-raise the signal with the default handling so that the program | |
208 | * termination status reflects that we were killed by this signal */ | |
209 | signal(sig_nr, SIG_DFL); | |
210 | raise(sig_nr); | |
b847adc6 | 211 | |
97be1538 | 212 | ovs_mutex_unlock(&mutex); |
428b2edd | 213 | OVS_NOT_REACHED(); |
d8b30702 JG |
214 | } |
215 | } | |
216 | ||
217 | void | |
218 | fatal_signal_wait(void) | |
219 | { | |
c874f17f | 220 | fatal_signal_init(); |
1ca3348e GS |
221 | #ifdef _WIN32 |
222 | poll_wevent_wait(wevent); | |
223 | #else | |
224 | poll_fd_wait(signal_fds[0], POLLIN); | |
225 | #endif | |
064af421 BP |
226 | } |
227 | ||
8a777cf6 GS |
228 | void |
229 | fatal_ignore_sigpipe(void) | |
230 | { | |
231 | #ifndef _WIN32 | |
232 | signal(SIGPIPE, SIG_IGN); | |
233 | #endif | |
234 | } | |
235 | ||
02a514ef GS |
236 | void |
237 | fatal_signal_atexit_handler(void) | |
064af421 | 238 | { |
e3830e90 | 239 | call_hooks(0); |
064af421 BP |
240 | } |
241 | ||
242 | static void | |
243 | call_hooks(int sig_nr) | |
244 | { | |
245 | static volatile sig_atomic_t recurse = 0; | |
246 | if (!recurse) { | |
247 | size_t i; | |
248 | ||
249 | recurse = 1; | |
250 | ||
251 | for (i = 0; i < n_hooks; i++) { | |
252 | struct hook *h = &hooks[i]; | |
253 | if (sig_nr || h->run_at_exit) { | |
e3830e90 | 254 | h->hook_cb(h->aux); |
064af421 BP |
255 | } |
256 | } | |
257 | } | |
258 | } | |
0c100540 GS |
259 | |
260 | #ifdef _WIN32 | |
261 | BOOL WINAPI ConsoleHandlerRoutine(DWORD dwCtrlType) | |
262 | { | |
263 | stored_sig_nr = SIGINT; | |
264 | SetEvent(wevent); | |
265 | return true; | |
266 | } | |
267 | #endif | |
064af421 | 268 | \f |
b3c01ed3 BP |
269 | /* Files to delete on exit. */ |
270 | static struct sset files = SSET_INITIALIZER(&files); | |
064af421 | 271 | |
e3830e90 BP |
272 | /* Has a hook function been registered with fatal_signal_add_hook() (and not |
273 | * cleared by fatal_signal_fork())? */ | |
274 | static bool added_hook; | |
275 | ||
064af421 | 276 | static void unlink_files(void *aux); |
e3830e90 | 277 | static void cancel_files(void *aux); |
064af421 BP |
278 | static void do_unlink_files(void); |
279 | ||
280 | /* Registers 'file' to be unlinked when the program terminates via exit() or a | |
281 | * fatal signal. */ | |
282 | void | |
283 | fatal_signal_add_file_to_unlink(const char *file) | |
284 | { | |
b847adc6 BP |
285 | fatal_signal_init(); |
286 | ||
97be1538 | 287 | ovs_mutex_lock(&mutex); |
064af421 BP |
288 | if (!added_hook) { |
289 | added_hook = true; | |
e3830e90 | 290 | fatal_signal_add_hook(unlink_files, cancel_files, NULL, true); |
064af421 BP |
291 | } |
292 | ||
b3c01ed3 | 293 | sset_add(&files, file); |
97be1538 | 294 | ovs_mutex_unlock(&mutex); |
064af421 BP |
295 | } |
296 | ||
297 | /* Unregisters 'file' from being unlinked when the program terminates via | |
298 | * exit() or a fatal signal. */ | |
299 | void | |
300 | fatal_signal_remove_file_to_unlink(const char *file) | |
301 | { | |
b847adc6 BP |
302 | fatal_signal_init(); |
303 | ||
97be1538 | 304 | ovs_mutex_lock(&mutex); |
b3c01ed3 | 305 | sset_find_and_delete(&files, file); |
97be1538 | 306 | ovs_mutex_unlock(&mutex); |
064af421 BP |
307 | } |
308 | ||
6a0061cb BP |
309 | /* Like fatal_signal_remove_file_to_unlink(), but also unlinks 'file'. |
310 | * Returns 0 if successful, otherwise a positive errno value. */ | |
311 | int | |
312 | fatal_signal_unlink_file_now(const char *file) | |
313 | { | |
b847adc6 BP |
314 | int error; |
315 | ||
316 | fatal_signal_init(); | |
317 | ||
97be1538 | 318 | ovs_mutex_lock(&mutex); |
b847adc6 BP |
319 | |
320 | error = unlink(file) ? errno : 0; | |
6a0061cb | 321 | if (error) { |
10a89ef0 | 322 | VLOG_WARN("could not unlink \"%s\" (%s)", file, ovs_strerror(error)); |
6a0061cb BP |
323 | } |
324 | ||
325 | fatal_signal_remove_file_to_unlink(file); | |
326 | ||
97be1538 | 327 | ovs_mutex_unlock(&mutex); |
b847adc6 | 328 | |
6a0061cb BP |
329 | return error; |
330 | } | |
331 | ||
064af421 | 332 | static void |
67a4917b | 333 | unlink_files(void *aux OVS_UNUSED) |
064af421 | 334 | { |
d295e8e9 | 335 | do_unlink_files(); |
064af421 BP |
336 | } |
337 | ||
e3830e90 | 338 | static void |
c69ee87c | 339 | cancel_files(void *aux OVS_UNUSED) |
e3830e90 | 340 | { |
b3c01ed3 | 341 | sset_clear(&files); |
e3830e90 BP |
342 | added_hook = false; |
343 | } | |
344 | ||
064af421 BP |
345 | static void |
346 | do_unlink_files(void) | |
347 | { | |
b3c01ed3 | 348 | const char *file; |
064af421 | 349 | |
b3c01ed3 BP |
350 | SSET_FOR_EACH (file, &files) { |
351 | unlink(file); | |
064af421 BP |
352 | } |
353 | } | |
354 | \f | |
e3830e90 BP |
355 | /* Clears all of the fatal signal hooks without executing them. If any of the |
356 | * hooks passed a 'cancel_cb' function to fatal_signal_add_hook(), then those | |
357 | * functions will be called, allowing them to free resources, etc. | |
358 | * | |
359 | * Following a fork, one of the resulting processes can call this function to | |
360 | * allow it to terminate without calling the hooks registered before calling | |
361 | * this function. New hooks registered after calling this function will take | |
362 | * effect normally. */ | |
064af421 BP |
363 | void |
364 | fatal_signal_fork(void) | |
365 | { | |
366 | size_t i; | |
367 | ||
b847adc6 BP |
368 | assert_single_threaded(); |
369 | ||
e3830e90 BP |
370 | for (i = 0; i < n_hooks; i++) { |
371 | struct hook *h = &hooks[i]; | |
372 | if (h->cancel_cb) { | |
373 | h->cancel_cb(h->aux); | |
064af421 BP |
374 | } |
375 | } | |
e3830e90 | 376 | n_hooks = 0; |
d8b30702 JG |
377 | |
378 | /* Raise any signals that we have already received with the default | |
379 | * handler. */ | |
380 | if (stored_sig_nr != SIG_ATOMIC_MAX) { | |
381 | raise(stored_sig_nr); | |
064af421 BP |
382 | } |
383 | } | |
1481a755 AA |
384 | |
385 | #ifndef _WIN32 | |
386 | /* Blocks all fatal signals and returns previous signal mask into | |
387 | * 'prev_mask'. */ | |
388 | void | |
389 | fatal_signal_block(sigset_t *prev_mask) | |
390 | { | |
391 | int i; | |
392 | sigset_t block_mask; | |
393 | ||
394 | sigemptyset(&block_mask); | |
395 | for (i = 0; i < ARRAY_SIZE(fatal_signals); i++) { | |
396 | int sig_nr = fatal_signals[i]; | |
397 | sigaddset(&block_mask, sig_nr); | |
398 | } | |
399 | xpthread_sigmask(SIG_BLOCK, &block_mask, prev_mask); | |
400 | } | |
401 | #endif |