X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Ffatal-signal.c;h=ef3fbc047127b72005176c97db88b245353a7b5c;hb=HEAD;hp=60a188e6fd1f9bfecae44f627bd7de9c33756349;hpb=e3830e909d210145cbe52a1da66058ebf2581fd6;p=sliver-openvswitch.git diff --git a/lib/fatal-signal.c b/lib/fatal-signal.c index 60a188e6f..ef3fbc047 100644 --- a/lib/fatal-signal.c +++ b/lib/fatal-signal.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -15,7 +15,6 @@ */ #include #include "fatal-signal.h" -#include #include #include #include @@ -24,19 +23,29 @@ #include #include #include +#include "ovs-thread.h" #include "poll-loop.h" #include "shash.h" +#include "sset.h" +#include "signals.h" #include "socket-util.h" #include "util.h" - -#define THIS_MODULE VLM_fatal_signal #include "vlog.h" +#include "type-props.h" + +#ifndef SIG_ATOMIC_MAX +#define SIG_ATOMIC_MAX TYPE_MAXIMUM(sig_atomic_t) +#endif + +VLOG_DEFINE_THIS_MODULE(fatal_signal); + /* Signals to catch. */ +#ifndef _WIN32 static const int fatal_signals[] = { SIGTERM, SIGINT, SIGHUP, SIGALRM }; - -/* Signals to catch as a sigset_t. */ -static sigset_t fatal_signal_set; +#else +static const int fatal_signals[] = { SIGTERM }; +#endif /* Hooks to call upon catching a signal */ struct hook { @@ -50,13 +59,22 @@ static struct hook hooks[MAX_HOOKS]; static size_t n_hooks; static int signal_fds[2]; +static HANDLE wevent; static volatile sig_atomic_t stored_sig_nr = SIG_ATOMIC_MAX; -static void fatal_signal_init(void); +static struct ovs_mutex mutex; + static void atexit_handler(void); static void call_hooks(int sig_nr); - -static void +#ifdef _WIN32 +static BOOL WINAPI ConsoleHandlerRoutine(DWORD dwCtrlType); +#endif + +/* Initializes the fatal signal handling module. Calling this function is + * optional, because calling any other function in the module will also + * initialize it. However, in a multithreaded program, the module must be + * initialized while the process is still single-threaded. */ +void fatal_signal_init(void) { static bool inited = false; @@ -64,39 +82,50 @@ fatal_signal_init(void) if (!inited) { size_t i; + assert_single_threaded(); inited = true; - if (pipe(signal_fds)) { - ovs_fatal(errno, "could not create pipe"); + ovs_mutex_init_recursive(&mutex); +#ifndef _WIN32 + xpipe_nonblocking(signal_fds); +#else + wevent = CreateEvent(NULL, TRUE, FALSE, NULL); + if (!wevent) { + char *msg_buf = ovs_lasterror_to_string(); + VLOG_FATAL("Failed to create a event (%s).", msg_buf); } - set_nonblocking(signal_fds[0]); - set_nonblocking(signal_fds[1]); - sigemptyset(&fatal_signal_set); + /* Register a function to handle Ctrl+C. */ + SetConsoleCtrlHandler(ConsoleHandlerRoutine, true); +#endif + for (i = 0; i < ARRAY_SIZE(fatal_signals); i++) { int sig_nr = fatal_signals[i]; +#ifndef _WIN32 struct sigaction old_sa; - sigaddset(&fatal_signal_set, sig_nr); - if (sigaction(sig_nr, NULL, &old_sa)) { - ovs_fatal(errno, "sigaction"); - } + xsigaction(sig_nr, NULL, &old_sa); if (old_sa.sa_handler == SIG_DFL && signal(sig_nr, fatal_signal_handler) == SIG_ERR) { - ovs_fatal(errno, "signal"); + VLOG_FATAL("signal failed (%s)", ovs_strerror(errno)); + } +#else + if (signal(sig_nr, fatal_signal_handler) == SIG_ERR) { + VLOG_FATAL("signal failed (%s)", ovs_strerror(errno)); } +#endif } atexit(atexit_handler); } } -/* Registers 'hook_cb' to be called when a process termination signal is - * raised. If 'run_at_exit' is true, 'hook_cb' is also called during normal - * process termination, e.g. when exit() is called or when main() returns. +/* Registers 'hook_cb' to be called from inside poll_block() following a fatal + * signal. 'hook_cb' does not need to be async-signal-safe. In a + * multithreaded program 'hook_cb' might be called from any thread, with + * threads other than the one running 'hook_cb' in unknown states. * - * 'hook_cb' is not called immediately from the signal handler but rather the - * next time the poll loop iterates, so it is freed from the usual restrictions - * on signal handler functions. + * If 'run_at_exit' is true, 'hook_cb' is also called during normal process + * termination, e.g. when exit() is called or when main() returns. * * If the current process forks, fatal_signal_fork() may be called to clear the * parent process's fatal signal hooks, so that 'hook_cb' is only called when @@ -110,12 +139,14 @@ fatal_signal_add_hook(void (*hook_cb)(void *aux), void (*cancel_cb)(void *aux), { fatal_signal_init(); - assert(n_hooks < MAX_HOOKS); + ovs_mutex_lock(&mutex); + ovs_assert(n_hooks < MAX_HOOKS); hooks[n_hooks].hook_cb = hook_cb; hooks[n_hooks].cancel_cb = cancel_cb; hooks[n_hooks].aux = aux; hooks[n_hooks].run_at_exit = run_at_exit; n_hooks++; + ovs_mutex_unlock(&mutex); } /* Handles fatal signal number 'sig_nr'. @@ -130,29 +161,69 @@ fatal_signal_add_hook(void (*hook_cb)(void *aux), void (*cancel_cb)(void *aux), void fatal_signal_handler(int sig_nr) { +#ifndef _WIN32 ignore(write(signal_fds[1], "", 1)); +#else + SetEvent(wevent); +#endif stored_sig_nr = sig_nr; } +/* Check whether a fatal signal has occurred and, if so, call the fatal signal + * hooks and exit. + * + * This function is called automatically by poll_block(), but specialized + * programs that may not always call poll_block() on a regular basis should + * also call it periodically. (Therefore, any function with "block" in its + * name should call fatal_signal_run() each time it is called, either directly + * or through poll_block(), because such functions can only used by specialized + * programs that can afford to block outside their main loop around + * poll_block().) + */ void fatal_signal_run(void) { - int sig_nr = stored_sig_nr; + sig_atomic_t sig_nr; + fatal_signal_init(); + + sig_nr = stored_sig_nr; if (sig_nr != SIG_ATOMIC_MAX) { + char namebuf[SIGNAL_NAME_BUFSIZE]; + + ovs_mutex_lock(&mutex); + +#ifndef _WIN32 + VLOG_WARN("terminating with signal %d (%s)", + (int)sig_nr, signal_name(sig_nr, namebuf, sizeof namebuf)); +#else + VLOG_WARN("terminating with signal %d", (int)sig_nr); +#endif call_hooks(sig_nr); /* Re-raise the signal with the default handling so that the program * termination status reflects that we were killed by this signal */ signal(sig_nr, SIG_DFL); raise(sig_nr); + + ovs_mutex_unlock(&mutex); + OVS_NOT_REACHED(); } } void fatal_signal_wait(void) { - poll_fd_wait(signal_fds[0], POLLIN); + fatal_signal_init(); + poll_fd_wait_event(signal_fds[0], wevent, POLLIN); +} + +void +fatal_ignore_sigpipe(void) +{ +#ifndef _WIN32 + signal(SIGPIPE, SIG_IGN); +#endif } static void @@ -178,9 +249,18 @@ call_hooks(int sig_nr) } } } + +#ifdef _WIN32 +BOOL WINAPI ConsoleHandlerRoutine(DWORD dwCtrlType) +{ + stored_sig_nr = SIGINT; + SetEvent(wevent); + return true; +} +#endif -/* Files to delete on exit. (The 'data' member of each node is unused.) */ -static struct shash files = SHASH_INITIALIZER(&files); +/* Files to delete on exit. */ +static struct sset files = SSET_INITIALIZER(&files); /* Has a hook function been registered with fatal_signal_add_hook() (and not * cleared by fatal_signal_fork())? */ @@ -195,14 +275,16 @@ static void do_unlink_files(void); void fatal_signal_add_file_to_unlink(const char *file) { + fatal_signal_init(); + + ovs_mutex_lock(&mutex); if (!added_hook) { added_hook = true; fatal_signal_add_hook(unlink_files, cancel_files, NULL, true); } - if (!shash_find(&files, file)) { - shash_add(&files, file, NULL); - } + sset_add(&files, file); + ovs_mutex_unlock(&mutex); } /* Unregisters 'file' from being unlinked when the program terminates via @@ -210,12 +292,11 @@ fatal_signal_add_file_to_unlink(const char *file) void fatal_signal_remove_file_to_unlink(const char *file) { - struct shash_node *node; + fatal_signal_init(); - node = shash_find(&files, file); - if (node) { - shash_delete(&files, node); - } + ovs_mutex_lock(&mutex); + sset_find_and_delete(&files, file); + ovs_mutex_unlock(&mutex); } /* Like fatal_signal_remove_file_to_unlink(), but also unlinks 'file'. @@ -223,36 +304,44 @@ fatal_signal_remove_file_to_unlink(const char *file) int fatal_signal_unlink_file_now(const char *file) { - int error = unlink(file) ? errno : 0; + int error; + + fatal_signal_init(); + + ovs_mutex_lock(&mutex); + + error = unlink(file) ? errno : 0; if (error) { - VLOG_WARN("could not unlink \"%s\" (%s)", file, strerror(error)); + VLOG_WARN("could not unlink \"%s\" (%s)", file, ovs_strerror(error)); } fatal_signal_remove_file_to_unlink(file); + ovs_mutex_unlock(&mutex); + return error; } static void -unlink_files(void *aux UNUSED) +unlink_files(void *aux OVS_UNUSED) { - do_unlink_files(); + do_unlink_files(); } static void -cancel_files(void *aux UNUSED) +cancel_files(void *aux OVS_UNUSED) { - shash_clear(&files); + sset_clear(&files); added_hook = false; } static void do_unlink_files(void) { - struct shash_node *node; + const char *file; - SHASH_FOR_EACH (node, &files) { - unlink(node->name); + SSET_FOR_EACH (file, &files) { + unlink(file); } } @@ -269,6 +358,8 @@ fatal_signal_fork(void) { size_t i; + assert_single_threaded(); + for (i = 0; i < n_hooks; i++) { struct hook *h = &hooks[i]; if (h->cancel_cb) {