Smallers steps to keep plugin running
[oweals/gnunet.git] / src / arm / gnunet-service-arm.c
index 36fabf7f4cad75a9715808ab89f48021b66c3e32..84aad3bfd2cfa3fcc8efbe7bc9f68ab189e28bbe 100644 (file)
@@ -1,10 +1,10 @@
 /*
      This file is part of GNUnet.
-     (C) 2009 Christian Grothoff (and other contributing authors)
+     (C) 2009, 2010 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
  * @author Christian Grothoff
  *
  * TODO:
- * - multiple start-stop requests with RC>1 can result
- *   in UP/DOWN signals based on "pending" that are inaccurate...
- *   => have list of clients waiting for a resolution instead of
- *      giving instant (but incorrect) replies
  * - need to test auto-restart code on configuration changes;
  * - should refine restart code to check if *relevant* parts of the
  *   configuration were changed (anything in the section for the service)
@@ -41,6 +37,7 @@
 #include "gnunet_protocols.h"
 #include "gnunet_service_lib.h"
 #include "gnunet_signal_lib.h"
+#include "gnunet-service-arm.h"
 #include "arm.h"
 
 
@@ -61,6 +58,7 @@
  */
 struct ServiceList;
 
+
 /**
  * List of our services.
  */
@@ -113,15 +111,6 @@ struct ServiceList
    */
   struct GNUNET_TIME_Absolute restartAt;
 
-#if RC
-  /**
-   * Reference counter (counts how many times we've been
-   * asked to start the service).  We only actually stop
-   * it once rc hits zero.
-   */
-  unsigned int rc;
-#endif
-
 };
 
 /**
@@ -353,9 +342,11 @@ free_entry (struct ServiceList *pos)
  * Actually start the process for the given service.
  *
  * @param sl identifies service to start
+ * @param lsocks -1 terminated list of listen sockets to pass (systemd style), or NULL
  */
 static void
-start_process (struct ServiceList *sl)
+start_process (struct ServiceList *sl,
+              const int *lsocks)
 {
   char *loprefix;
   char *options;
@@ -393,7 +384,7 @@ start_process (struct ServiceList *sl)
          while (NULL != (optpos = strstr (options, "$")))
            {
              optend = optpos + 1;
-             while (isupper (*optend)) optend++;             
+             while (isupper ( (unsigned char) *optend)) optend++;            
              b = *optend;
              if ('\0' == b)
                next = "";
@@ -420,25 +411,30 @@ start_process (struct ServiceList *sl)
     }
   use_debug = GNUNET_CONFIGURATION_get_value_yesno (cfg, sl->name, "DEBUG");
 
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Starting service `%s'\n"), sl->name);
 #if DEBUG_ARM
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Starting service `%s' using binary `%s' and configuration `%s'\n",
              sl->name, sl->binary, sl->config);
 #endif
   if (GNUNET_YES == use_debug)
-    sl->pid = do_start_process (loprefix,
+    sl->pid = do_start_process (lsocks,
+                               loprefix,                               
                                sl->binary,
                                "-c", sl->config,
                                "-L", "DEBUG",
                                options,
                                NULL);
   else
-    sl->pid = do_start_process (loprefix,
+    sl->pid = do_start_process (lsocks,
+                               loprefix,
                                sl->binary,
                                "-c", sl->config,
                                options,
                                NULL);
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO, 
+             _("Starting service `%s' (PID: %d)\n"), 
+             sl->name,
+             (int) sl->pid);
   GNUNET_free (loprefix);
   GNUNET_free (options);
   /* FIXME: should check sl->pid */
@@ -450,9 +446,13 @@ start_process (struct ServiceList *sl)
  *
  * @param client who is asking for this
  * @param servicename name of the service to start
+ * @param lsocks -1 terminated list of listen sockets to pass (systemd style), or NULL
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
-static void
-start_service (struct GNUNET_SERVER_Client *client, const char *servicename)
+int
+start_service (struct GNUNET_SERVER_Client *client, 
+              const char *servicename,
+              const int *lsocks)
 {
   struct ServiceList *sl;
   char *binary;
@@ -465,21 +465,17 @@ start_service (struct GNUNET_SERVER_Client *client, const char *servicename)
                  _("ARM is shutting down, service `%s' not started.\n"),
                  servicename);
       signal_result (client, servicename, GNUNET_MESSAGE_TYPE_ARM_IS_DOWN);
-      return;
+      return GNUNET_SYSERR;
     }
   sl = find_name (servicename);
   if (sl != NULL)
     {
-      /* already running, just increment RC */
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  _("Service `%s' already running.\n"), servicename);
-#if RC
-      sl->rc++;
-#endif
       sl->next = running;
       running = sl;
       signal_result (client, servicename, GNUNET_MESSAGE_TYPE_ARM_IS_UP);
-      return;
+      return GNUNET_SYSERR;
     }
   if (GNUNET_OK !=
       GNUNET_CONFIGURATION_get_value_string (cfg,
@@ -489,7 +485,7 @@ start_service (struct GNUNET_SERVER_Client *client, const char *servicename)
                  _("Binary implementing service `%s' not known!\n"),
                  servicename);
       signal_result (client, servicename, GNUNET_MESSAGE_TYPE_ARM_IS_DOWN);
-      return;
+      return GNUNET_SYSERR;
     }
   if ((GNUNET_OK !=
        GNUNET_CONFIGURATION_get_value_filename (cfg,
@@ -504,14 +500,12 @@ start_service (struct GNUNET_SERVER_Client *client, const char *servicename)
       signal_result (client, servicename, GNUNET_MESSAGE_TYPE_ARM_IS_DOWN);
       GNUNET_free (binary);
       GNUNET_free_non_null (config);
-      return;
+      return GNUNET_SYSERR;
     }
+  (void) stop_listening (servicename);
   sl = GNUNET_malloc (sizeof (struct ServiceList));
   sl->name = GNUNET_strdup (servicename);
   sl->next = running;
-#if RC
-  sl->rc = 1;
-#endif
   sl->binary = binary;
   sl->config = config;
   sl->mtime = sbuf.st_mtime;
@@ -519,9 +513,10 @@ start_service (struct GNUNET_SERVER_Client *client, const char *servicename)
   sl->restartAt = GNUNET_TIME_UNIT_FOREVER_ABS;
 
   running = sl;
-  start_process (sl);
+  start_process (sl, lsocks);
   if (NULL != client)
     signal_result (client, servicename, GNUNET_MESSAGE_TYPE_ARM_IS_UP);
+  return GNUNET_OK;
 }
 
 
@@ -532,7 +527,8 @@ start_service (struct GNUNET_SERVER_Client *client, const char *servicename)
  * @param servicename name of the service to stop
  */
 static void
-stop_service (struct GNUNET_SERVER_Client *client, const char *servicename)
+stop_service (struct GNUNET_SERVER_Client *client,
+             const char *servicename)
 {
   struct ServiceList *pos;
 
@@ -541,29 +537,13 @@ stop_service (struct GNUNET_SERVER_Client *client, const char *servicename)
   pos = find_name (servicename);
   if (pos == NULL)
     {
-      signal_result (client, servicename, GNUNET_MESSAGE_TYPE_ARM_IS_UNKNOWN);
-      GNUNET_SERVER_receive_done (client, GNUNET_OK);
-      return;
-    }
-#if RC
-  if (pos->rc > 1)
-    {
-      /* RC>1, just decrement RC */
-      pos->rc--;
-      pos->next = running;
-      running = pos;
-#if DEBUG_ARM
-      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                 "Service `%s' still used by %u clients, will keep it running!\n",
-                 servicename, pos->rc);
-#endif
-      signal_result (client, servicename, GNUNET_MESSAGE_TYPE_ARM_IS_UP);
+      if (GNUNET_OK == stop_listening (servicename))
+       signal_result (client, servicename, GNUNET_MESSAGE_TYPE_ARM_IS_DOWN);
+      else
+       signal_result (client, servicename, GNUNET_MESSAGE_TYPE_ARM_IS_UNKNOWN);
       GNUNET_SERVER_receive_done (client, GNUNET_OK);
       return;
     }
-  if (pos->rc == 1)
-    pos->rc--;                 /* decrement RC to zero */
-#endif
   if (pos->killing_client != NULL)
     {
       /* killing already in progress */
@@ -639,7 +619,7 @@ handle_start (void *cls,
       GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
       return;
     }
-  start_service (client, servicename);
+  start_service (client, servicename, NULL);
   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 }
 
@@ -743,19 +723,21 @@ static void
 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct ServiceList *pos;
+
 #if DEBUG_ARM
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, _("Stopping all services\n"));
 #endif
+  stop_listening (NULL);
   in_shutdown = GNUNET_YES;
   pos = running;
   while (NULL != pos)
     {
       if (pos->pid != 0)
        {
-#if DEBUG_ARM
-         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                     "Sending SIGTERM to `%s'\n", pos->name);
-#endif
+         GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                     "Stopping service `%s' (PID: %d)\n",
+                     pos->name,
+                     pos->pid);
          if (0 != PLIBC_KILL (pos->pid, SIGTERM))
            GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
        }
@@ -803,7 +785,7 @@ delayed_restart_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
            {
              GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                          _("Restarting service `%s'.\n"), pos->name);
-             start_process (pos);
+             start_process (pos, NULL);
            }
          else
            {
@@ -962,14 +944,55 @@ maint_child_death (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 }
 
 
+static size_t
+transmit_shutdown_ack (void *cls, size_t size, void *buf)
+{
+  struct GNUNET_SERVER_Client *client = cls;
+  struct GNUNET_MessageHeader *msg;
+
+  if (size < sizeof (struct GNUNET_MessageHeader))
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                  _("Failed to transmit shutdown ACK.\n"));
+      GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+      return 0;                 /* client disconnected */
+    }
+
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+              _("Transmitting shutdown ACK.\n"));
+
+  msg = (struct GNUNET_MessageHeader *) buf;
+  msg->type = htons (GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN_ACK);
+  msg->size = htons (sizeof (struct GNUNET_MessageHeader));
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
+  GNUNET_SERVER_client_drop(client);
+  return sizeof (struct GNUNET_MessageHeader);
+}
+
 /**
- * List of handlers for the messages understood by this service.
+ * Handler for SHUTDOWN message.
+ *
+ * @param cls closure (refers to service)
+ * @param client identification of the client
+ * @param message the actual message
  */
-static struct GNUNET_SERVER_MessageHandler handlers[] = {
-  {&handle_start, NULL, GNUNET_MESSAGE_TYPE_ARM_START, 0},
-  {&handle_stop, NULL, GNUNET_MESSAGE_TYPE_ARM_STOP, 0},
-  {NULL, NULL, 0, 0}
-};
+static void
+handle_shutdown (void *cls,
+                 struct GNUNET_SERVER_Client *client,
+                 const struct GNUNET_MessageHeader *message)
+{
+  GNUNET_SERVER_client_keep(client);
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+              _("Initiating shutdown as requested by client.\n"));
+
+  GNUNET_SERVER_notify_transmit_ready (client,
+                                       sizeof(struct GNUNET_MessageHeader),
+                                       GNUNET_TIME_UNIT_FOREVER_REL,
+                                       &transmit_shutdown_ack, client);
+  GNUNET_SERVER_client_persist_ (client);
+  GNUNET_SCHEDULER_shutdown (sched);
+}
+
 
 /**
  * Signal handler called for SIGCHLD.  Triggers the
@@ -979,10 +1002,12 @@ static void
 sighandler_child_death ()
 {
   static char c;
+  int old_errno = errno; /* back-up errno */
   GNUNET_break (1 == 
                GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
                                        (sigpipe, GNUNET_DISK_PIPE_END_WRITE), &c,
                                        sizeof (c)));
+  errno = old_errno; /* restore errno */
 }
 
 
@@ -1000,6 +1025,13 @@ run (void *cls,
      struct GNUNET_SERVER_Handle *serv,
      const struct GNUNET_CONFIGURATION_Handle *c)
 {
+  static const struct GNUNET_SERVER_MessageHandler handlers[] = {
+    {&handle_start, NULL, GNUNET_MESSAGE_TYPE_ARM_START, 0},
+    {&handle_stop, NULL, GNUNET_MESSAGE_TYPE_ARM_STOP, 0},
+    {&handle_shutdown, NULL, GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN,
+     sizeof (struct GNUNET_MessageHeader)},
+    {NULL, NULL, 0, 0}
+  };
   char *defaultservices;
   char *pos;
 
@@ -1045,11 +1077,14 @@ run (void *cls,
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "Starting default services `%s'\n", defaultservices);
 #endif
-      pos = strtok (defaultservices, " ");
-      while (pos != NULL)
+      if (0 < strlen (defaultservices))
        {
-         start_service (NULL, pos);
-         pos = strtok (NULL, " ");
+         pos = strtok (defaultservices, " ");
+         while (pos != NULL)
+           {
+             start_service (NULL, pos, NULL);
+             pos = strtok (NULL, " ");
+           }
        }
       GNUNET_free (defaultservices);
     }
@@ -1061,6 +1096,9 @@ run (void *cls,
 #endif
     }
 
+  /* create listening sockets for future services*/
+  prepareServices (cfg, sched);
+  
   /* process client requests */
   GNUNET_SERVER_add_handlers (server, handlers);