lib/signals.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2011 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
  17 #include <config.h>
  18 #include "signals.h"
  19 #include <assert.h>
  20 #include <errno.h>
  21 #include <limits.h>
  22 #include <signal.h>
  23 #include <unistd.h>
  24 #include "poll-loop.h"
  25 #include "socket-util.h"
  26 #include "type-props.h"
  27 #include "util.h"
  28 #include "vlog.h"
  29
  30 VLOG_DEFINE_THIS_MODULE(signals);
  31
  32 #if defined(_NSIG)
  33 #define N_SIGNALS _NSIG
  34 #elif defined(NSIG)
  35 #define N_SIGNALS NSIG
  36 #else
  37 /* We could try harder to get the maximum signal number, but in practice we
  38  * only care about SIGHUP, which is normally signal 1 anyway. */
  39 #define N_SIGNALS 32
  40 #endif
  41
  42 struct signal {
  43     int signr;
  44 };
  45
  46 static volatile sig_atomic_t signaled[N_SIGNALS];
  47
  48 static int fds[2];
  49
  50 static void signal_handler(int signr);
  51
  52 /* Initializes the signals subsystem (if it is not already initialized).  Calls
  53  * exit() if initialization fails.
  54  *
  55  * Calling this function is optional; it will be called automatically by
  56  * signal_start() if necessary.  Calling it explicitly allows the client to
  57  * prevent the process from exiting at an unexpected time. */
  58 void
  59 signal_init(void)
  60 {
  61     static bool inited;
  62     if (!inited) {
  63         inited = true;
  64         xpipe(fds);
  65         set_nonblocking(fds[0]);
  66         set_nonblocking(fds[1]);
  67     }
  68 }
  69
  70 /* Sets up a handler for 'signr' and returns a structure that represents it.
  71  *
  72  * Only one handler for a given signal may be registered at a time. */
  73 struct signal *
  74 signal_register(int signr)
  75 {
  76     struct sigaction sa;
  77     struct signal *s;
  78
  79     signal_init();
  80
  81     /* Set up signal handler. */
  82     assert(signr >= 1 && signr < N_SIGNALS);
  83     memset(&sa, 0, sizeof sa);
  84     sa.sa_handler = signal_handler;
  85     sigemptyset(&sa.sa_mask);
  86     sa.sa_flags = SA_RESTART;
  87     xsigaction(signr, &sa, NULL);
  88
  89     /* Return structure. */
  90     s = xmalloc(sizeof *s);
  91     s->signr = signr;
  92     return s;
  93 }
  94
  95 /* Returns true if signal 's' has been received since the last call to this
  96  * function with argument 's'. */
  97 bool
  98 signal_poll(struct signal *s)
  99 {
 100     char buf[_POSIX_PIPE_BUF];
 101     ignore(read(fds[0], buf, sizeof buf));
 102     if (signaled[s->signr]) {
 103         signaled[s->signr] = 0;
 104         return true;
 105     }
 106     return false;
 107 }
 108
 109 /* Causes the next call to poll_block() to wake up when signal_poll(s) would
 110  * return true. */
 111 void
 112 signal_wait(struct signal *s)
 113 {
 114     if (signaled[s->signr]) {
 115         poll_immediate_wake();
 116     } else {
 117         poll_fd_wait(fds[0], POLLIN);
 118     }
 119 }
 120 \f
 121 static void
 122 signal_handler(int signr)
 123 {
 124     if (signr >= 1 && signr < N_SIGNALS) {
 125         ignore(write(fds[1], "", 1));
 126         signaled[signr] = true;
 127     }
 128 }
 129
 130 /* Returns the name of signal 'signum' as a string.  The string may be in a
 131  * static buffer that is reused from one call to the next.
 132  *
 133  * The string is probably a (possibly multi-word) description of the signal
 134  * (e.g. "Hangup") instead of just the stringified version of the macro
 135  * (e.g. "SIGHUP"). */
 136 const char *
 137 signal_name(int signum)
 138 {
 139     const char *name = NULL;
 140 #ifdef HAVE_STRSIGNAL
 141     name = strsignal(signum);
 142 #endif
 143     if (!name) {
 144         static char buffer[7 + INT_STRLEN(int) + 1];
 145         sprintf(buffer, "signal %d", signum);
 146         name = buffer;
 147     }
 148     return name;
 149 }
 150
 151 void
 152 xsigaction(int signum, const struct sigaction *new, struct sigaction *old)
 153 {
 154     if (sigaction(signum, new, old)) {
 155         VLOG_FATAL("sigaction(%s) failed (%s)",
 156                    signal_name(signum), strerror(errno));
 157     }
 158 }
 159
 160 void
 161 xsigprocmask(int how, const sigset_t *new, sigset_t *old)
 162 {
 163     if (sigprocmask(how, new, old)) {
 164         VLOG_FATAL("sigprocmask failed (%s)", strerror(errno));
 165     }
 166 }