Merge branch 'master' into next
[paraslash.git] / signal.c
index bf0cd5c..5d3e2c9 100644 (file)
--- a/signal.c
+++ b/signal.c
@@ -1,9 +1,9 @@
 /*
- * Copyright (C) 2004-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2004-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
-/** \file signal.c signal handling functions */
+/** \file signal.c Signal handling functions. */
 
 #include <signal.h>
 #include <sys/types.h>
@@ -16,7 +16,7 @@
 static int signal_pipe[2];
 
 /**
- * initialize the paraslash signal subsystem
+ * Initialize the paraslash signal subsystem.
  *
  * This function creates a pipe, the signal pipe, to deliver pending
  * signals to the application (Bernstein's trick). It should be called
@@ -35,18 +35,20 @@ static int signal_pipe[2];
  */
 int para_signal_init(void)
 {
-       int ret = -E_SIGNAL_PIPE;
-       if (pipe(signal_pipe))
+       int ret;
+       if (pipe(signal_pipe) < 0) {
+               ret = -ERRNO_TO_PARA_ERROR(errno);
                goto err_out;
-       ret = mark_fd_nonblock(signal_pipe[0]);
+       }
+       ret = mark_fd_nonblocking(signal_pipe[0]);
        if (ret < 0)
                goto err_out;
-       ret = mark_fd_nonblock(signal_pipe[1]);
+       ret = mark_fd_nonblocking(signal_pipe[1]);
        if (ret < 0)
                goto err_out;
        return signal_pipe[0];
 err_out:
-       PARA_EMERG_LOG("%s\n", PARA_STRERROR(-ret));
+       PARA_EMERG_LOG("%s\n", para_strerror(-ret));
        exit(EXIT_FAILURE);
 }
 
@@ -55,84 +57,129 @@ err_out:
  */
 static void generic_signal_handler(int s)
 {
-       write(signal_pipe[1], &s, sizeof(int));
-       //fprintf(stderr, "got sig %i, write returned %d\n", s, ret);
+       ssize_t ret = write(signal_pipe[1], &s, sizeof(int));
+
+       if (ret == sizeof(int))
+               return;
+       if (ret < 0)
+               PARA_EMERG_LOG("%s\n", strerror(errno));
+       else
+               PARA_EMERG_LOG("short write to signal pipe\n");
+       exit(EXIT_FAILURE);
 }
 
 /**
- * reap one child
+ * Reap one child.
+ *
+ * \param pid In case a child died, its pid is returned here.
  *
- * call waitpid() and print a log message containing the pid
- * and the cause of the child's death.
+ * Call waitpid() and print a log message containing the pid and the cause of
+ * the child's death.
  *
- * \return Like \p waitpid(), this function returns the process ID of the
- * terminated child; on error, \p -E_WAITPID is returned.
- * \sa waitpid(2)
+ * \return A (negative) paraslash error code on errors, zero, if no child died,
+ * one otherwise. If and only if the function returns one, the content of \a
+ * pid is meaningful.
+ *
+ * \sa waitpid(2).
  */
-pid_t para_reap_child(void)
+int para_reap_child(pid_t *pid)
 {
        int status;
-       pid_t pid = waitpid(-1, &status, WNOHANG);
+       *pid = waitpid(-1, &status, WNOHANG);
 
-       if (pid <= 0) {
-               if (pid < 0)
-                       pid = -E_WAITPID;
-               return pid;
-       }
+       if (!*pid)
+               return 0;
+       if (*pid < 0)
+               return -ERRNO_TO_PARA_ERROR(errno);
        if (WIFEXITED(status))
-               PARA_DEBUG_LOG("child %i exited. Exit status: %i\n", pid,
+               PARA_DEBUG_LOG("child %i exited. Exit status: %i\n", (int)*pid,
                        WEXITSTATUS(status));
        else if (WIFSIGNALED(status))
-               PARA_DEBUG_LOG("child %i was killed by signal %i\n", pid,
+               PARA_DEBUG_LOG("child %i was killed by signal %i\n", (int)*pid,
                        WTERMSIG(status));
        else
-               PARA_WARNING_LOG("child %i terminated abormally\n", pid);
-       return pid;
+               PARA_WARNING_LOG("child %i terminated abormally\n", (int)*pid);
+       return 1;
 }
 
 /**
- * paraslash's zombie killer
+ * Install the given handler for the given signal.
+ *
+ * \param sig The number of the signal to catch.
+ * \param handler to be installed, \p SIG_IGN, or \p SIG_DFL.
  *
- * It just calls \p para_reap_child() until there are no more children left to
- * reap.
+ * This either succeeds or calls exit(EXIT_FAILURE).
+ *
+ * \sa sigaction(2).
  */
-void para_reap_children(void)
+void para_sigaction(int sig, void (*handler)(int))
 {
-       while (para_reap_child() > 0)
-               ; /* nothing */
+       struct sigaction act;
+
+       PARA_DEBUG_LOG("catching signal %d\n", sig);
+       act.sa_handler = handler;
+       sigemptyset(&act.sa_mask);
+       act.sa_flags = 0;
+       if (sig == SIGALRM) {
+               #ifdef SA_INTERRUPT /* SunOS */
+                       act.sa_flags |= SA_INTERRUPT;
+               #endif
+       } else {
+               #ifdef SA_RESTART /* BSD */
+                       act.sa_flags |= SA_RESTART;
+               #endif
+       }
+       if (sigaction(sig, &act, NULL) >= 0)
+               return;
+       PARA_EMERG_LOG("failed to install signal handler for signal %d\n",
+               sig);
+       exit(EXIT_FAILURE);
 }
 
 /**
- * wrapper around signal(2)
- * \param sig the number of the signal to catch
+ * Install the generic signal handler for the given signal number.
  *
- * This installs the generic signal handler for the given signal.
- * \return This function returns 1 on success and \p -E_SIGNAL_SIG_ERR on errors.
- * \sa signal(2)
+ * \param sig The number of the signal to catch.
+ *
+ * \sa signal(2), sigaction(2).
  */
-int para_install_sighandler(int sig)
+void para_install_sighandler(int sig)
 {
-       PARA_DEBUG_LOG("catching signal %d\n", sig);
-       return signal(sig, &generic_signal_handler) == SIG_ERR?  -E_SIGNAL_SIG_ERR : 1;
+       para_sigaction(sig, &generic_signal_handler);
 }
 
 /**
- * return number of next pending signal
+ * Return the number of the next pending signal.
  *
  * This should be called if the fd for the signal pipe is ready for reading.
  *
- * \return On success, the number of the received signal is returned. \p
- * -E_SIGNAL_READ is returned if a read error occured while reading the signal
- * pipe.  If the read was interrupted by another signal the function returns 0.
+ * \return On success, the number of the received signal is returned.  If the
+ * read returned zero or was interrupted by another signal the function returns
+ * 0.  Otherwise, a negative error value is returned.
  */
 int para_next_signal(void)
 {
        int s;
-       ssize_t r;
+       ssize_t r = read(signal_pipe[0], &s, sizeof(s));
 
-       if ((r = read(signal_pipe[0], &s, sizeof(s)) == sizeof(s)) > 0) {
-               PARA_DEBUG_LOG("next signal: %d\n", s);
-               return s;
+       if (!r) {
+               PARA_CRIT_LOG("read from signal pipe returned zero\n");
+               return 0;
+       }
+       if (r < 0) {
+               if (errno == EAGAIN || errno == EINTR)
+                       return 0;
+               return -ERRNO_TO_PARA_ERROR(errno);
        }
-       return r < 0 && (errno != EAGAIN)? 0 : -E_SIGNAL_READ;
+       assert(r == sizeof(s));
+       PARA_DEBUG_LOG("next signal: %d\n", s);
+       return s;
+}
+
+/**
+ * Close the write end of the signal pipe.
+ */
+void para_signal_shutdown(void)
+{
+       close(signal_pipe[1]);
 }