added basic ssl support to ircu
[ircu2.10.12-pk.git] / ircd / ircd_signal.c
index a250dd9697fdcb6f17fd910f17593f377dad16e7..650102ed1f9bf32433c4c02843f64b0c1648353a 100644 (file)
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
+ */
+/** @file
+ * @brief Signal handlers for ircu.
+ * @version $Id$
  */
 #include "config.h"
 
 #include "ircd.h"
+#include "ircd_alloc.h"
 #include "ircd_events.h"
+#include "ircd_log.h"
 #include "ircd_signal.h"
 #include "s_conf.h"
 
-#include <assert.h>
+/* #include <assert.h> -- Now using assert in ircd_log.h */
 #include <signal.h>
+#include <string.h>
+#include <sys/wait.h>
+#include <unistd.h>
+
+/** Records a function to be called when a child process terminates. */
+struct ChildRecord {
+  struct ChildRecord *next;
+  SigChldCallBack call;
+  void *datum;
+  pid_t cpid;
+};
 
+/** Counts various types of signals that we receive. */
 static struct tag_SignalCounter {
-  unsigned int alrm;
-  unsigned int hup;
+  unsigned int alrm; /**< Received SIGALRM count. */
+  unsigned int hup;  /**< Received SIGHUP count. */
+  unsigned int chld; /**< Received SIGCHLD count. */
 } SignalCounter;
 
+/** Event generator for SIGHUP. */
 static struct Signal sig_hup;
+/** Event generator for SIGINT. */
 static struct Signal sig_int;
+/** Event generator for SIGTERM. */
 static struct Signal sig_term;
+/** Event generator for SIGCHLD. */
+static struct Signal sig_chld;
+/** List of active child process callback requests. */
+static struct ChildRecord *children;
+/** List of inactive (free) child records. */
+static struct ChildRecord *crec_freelist;
 
+/* Make sure we have a definition for SIGCHLD. */
+#if !defined(SIGCHLD)
+# define SIGCHLD SIGCLD
+#endif
+
+/** Signal handler for SIGALRM.
+ * @param[in] sig Signal number (ignored).
+ */
 static void sigalrm_handler(int sig)
 {
   ++SignalCounter.alrm;
 }
 
+/** Signal callback for SIGTERM.
+ * @param[in] ev Signal event descriptor.
+ */
 static void sigterm_callback(struct Event* ev)
 {
   assert(0 != ev_signal(ev));
@@ -53,6 +90,9 @@ static void sigterm_callback(struct Event* ev)
   server_die("received signal SIGTERM");
 }
 
+/** Signal callback for SIGHUP.
+ * @param[in] ev Signal event descriptor.
+ */
 static void sighup_callback(struct Event* ev)
 {
   assert(0 != ev_signal(ev));
@@ -64,6 +104,9 @@ static void sighup_callback(struct Event* ev)
   rehash(&me, 1);
 }
 
+/** Signal callback for SIGINT.
+ * @param[in] ev Signal event descriptor.
+ */
 static void sigint_callback(struct Event* ev)
 {
   assert(0 != ev_signal(ev));
@@ -74,6 +117,113 @@ static void sigint_callback(struct Event* ev)
   server_restart("caught signal: SIGINT");
 }
 
+/** Allocate a child callback record.
+ * @return Newly allocated callback record.
+ */
+static struct ChildRecord *alloc_crec(void)
+{
+  struct ChildRecord *crec;
+
+  if (crec_freelist)
+  {
+    crec = crec_freelist;
+    crec_freelist = crec->next;
+  }
+  else
+  {
+    crec = MyCalloc(1, sizeof(*crec));
+  }
+
+  memset(crec, 0, sizeof(*crec));
+  crec->next = NULL;
+  return crec;
+}
+
+/** Release \a crec, which is after \a prev.
+ * @param[in] crec Child process callback record to release.
+ */
+static void release_crec(struct ChildRecord *crec)
+{
+  memset(crec, 0, sizeof(*crec));
+  crec->next = crec_freelist;
+  crec_freelist = crec;
+}
+
+/** Register a function to be called when a child process terminates.
+ * @param[in] child Child process ID.
+ * @param[in] call Function to call when process \a child terminates.
+ * @param[in] datum Additional data parameter to pass to \a call.
+ */
+void register_child(pid_t child, SigChldCallBack call, void *datum)
+{
+  struct ChildRecord *crec;
+
+  crec = alloc_crec();
+  /* Link into #children list. */
+  crec->next = children;
+  children = crec;
+  /* Fill in user fields. */
+  crec->call = call;
+  crec->datum = datum;
+  crec->cpid = child;
+}
+
+/** Unregister all callbacks for a child process, optionally calling
+ * them first.
+ * @param[in] child Child process ID to unregister.
+ * @param[in] do_call If non-zero, make the callbacks.
+ * @param[in] status If \a do_call is non-zero, the child's exit status.
+ */
+static void do_unregister_child(pid_t child, int do_call, int status)
+{
+  struct ChildRecord *crec = children;
+  struct ChildRecord *prev = NULL;
+
+  while (crec != NULL)
+  {
+    if (crec->cpid == child)
+    {
+      if (do_call)
+        crec->call(child, crec->datum, status);
+
+      if (prev)
+        prev->next = crec->next;
+      else
+        children = crec->next;
+
+      release_crec(crec);
+    }
+    else
+      prev = crec;
+    crec = prev ? prev->next : children;
+  }
+}
+
+/** Unregister all callbacks for a child process.
+ * @param[in] child Child process ID to unregister.
+ */
+void unregister_child(pid_t child)
+{
+  do_unregister_child(child, 0, 0);
+}
+
+/** Signal handler for SIGCHLD.
+ * @param[in] ev Signal event descriptor.
+ */
+static void sigchld_callback(struct Event *ev)
+{
+  pid_t cpid;
+  int status;
+
+  ++SignalCounter.chld;
+  do {
+    cpid = waitpid(-1, &status, WNOHANG);
+    if (cpid > 0)
+      do_unregister_child(cpid, 1, status);
+  } while (cpid > 0);
+}
+
+/** Register all necessary signal handlers. */
 void setup_signals(void)
 {
   struct sigaction act;
@@ -95,6 +245,7 @@ void setup_signals(void)
   signal_add(&sig_hup, sighup_callback, 0, SIGHUP);
   signal_add(&sig_int, sigint_callback, 0, SIGINT);
   signal_add(&sig_term, sigterm_callback, 0, SIGTERM);
+  signal_add(&sig_chld, sigchld_callback, 0, SIGCHLD);
 
 #ifdef HAVE_RESTARTABLE_SYSCALLS
   /*
@@ -106,3 +257,13 @@ void setup_signals(void)
 #endif
 }
 
+/** Kill and clean up all child processes. */
+void reap_children(void)
+{
+  /* Send SIGTERM to all children in process group.  Sleep for a
+   * second to let them exit before we try to clean them up.
+   */
+  kill(0, SIGTERM);
+  sleep(1);
+  sigchld_callback(NULL);
+}