- verboser log, faster start
[oweals/gnunet.git] / src / arm / gnunet-arm.c
index f7ff536be87f49ab5375438920f4f16b20cb156b..8a98ba06b3096433a3a42eb01b89f7252a5dfba3 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009 Christian Grothoff (and other contributing authors)
+     (C) 2009, 2012, 2013 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
  */
 #include "platform.h"
 #include "gnunet_arm_service.h"
-#include "gnunet_client_lib.h"
 #include "gnunet_constants.h"
-#include "gnunet_getopt_lib.h"
-#include "gnunet_program_lib.h"
-#include "gnunet_time_lib.h"
+#include "gnunet_util_lib.h"
 
 /**
  * Timeout for stopping services.  Long to give some services a real chance.
  */
-#define STOP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
+#define STOP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
 
 /**
  * Timeout for stopping ARM.  Extra-long since ARM needs to stop everyone else.
  */
-#define STOP_TIMEOUT_ARM GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
+#define STOP_TIMEOUT_ARM GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
 
 /**
  * Timeout for starting services, very short because of the strange way start works
 #define START_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
 
 /**
- * Timeout for starting services, very short because of the strange way start works
- * (by checking if running before starting, so really this time is always waited on
- * startup (annoying)).
+ * Timeout for listing all running services.
  */
-#define TEST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
+#define LIST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
 
 /**
  * Set if we are to shutdown all services (including ARM).
@@ -80,6 +75,11 @@ static int delete;
  */
 static int quiet;
 
+/**
+ * Set if we should print a list of currently running services.
+ */
+static int list;
+
 /**
  * Set to the name of a service to start.
  */
@@ -90,11 +90,6 @@ static char *init;
  */
 static char *term;
 
-/**
- * Set to the name of a service to test.
- */
-static char *test;
-
 /**
  * Set to the name of the config file used.
  */
@@ -118,7 +113,7 @@ static struct GNUNET_ARM_Handle *h;
 /**
  * Our configuration.
  */
-const struct GNUNET_CONFIGURATION_Handle *cfg;
+static struct GNUNET_CONFIGURATION_Handle *cfg;
 
 /**
  * Processing stage that we are in.  Simple counter.
@@ -130,6 +125,16 @@ static unsigned int phase;
  */
 static struct GNUNET_TIME_Relative timeout;
 
+/**
+ * Do we want to give our stdout to gnunet-service-arm?
+ */
+static unsigned int no_stdout;
+
+/**
+ * Do we want to give our stderr to gnunet-service-arm?
+ */
+static unsigned int no_stderr;
+
 
 /**
  * Main continuation-passing-style loop.  Runs the various
@@ -138,7 +143,8 @@ static struct GNUNET_TIME_Relative timeout;
  * @param cls closure, unused
  * @param tc context, unused
  */
-static void cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+static void
+cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 
 
 /**
@@ -146,72 +152,132 @@ static void cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
  * user and then runs the next phase in the FSM.
  *
  * @param cls pointer to "const char*" identifying service that was manipulated
- * @param success GNUNET_OK if service is now running, GNUNET_NO if not, GNUNET_SYSERR on error
+ * @param result result of the operation
  */
 static void
-confirm_cb (void *cls, int success)
+confirm_cb (void *cls, 
+           enum GNUNET_ARM_ProcessStatus result)
 {
   const char *service = cls;
 
-  switch (success)
+  switch (result)
   {
-  case GNUNET_OK:
-    if (quiet != GNUNET_YES)
-      fprintf (stdout, _("Service `%s' has been started.\n"), service);
-    if ((phase - 1 != 2) && (phase - 1 != 3))
-    {
-      if (quiet != GNUNET_YES)
-        fprintf (stdout, _("Failed to stop service `%s'!\n"), service);
-      ret = 1;
-    }
+  case GNUNET_ARM_PROCESS_UNKNOWN:
+    FPRINTF (stderr, _("Service `%s' is unknown to ARM.\n"), service);
+    ret = 1;
     break;
-  case GNUNET_NO:
+  case GNUNET_ARM_PROCESS_DOWN:
     if (quiet != GNUNET_YES)
-      fprintf (stdout, _("Service `%s' has been stopped.\n"), service);
-    if ((phase - 1 != 0) && (phase - 1 != 1))
-    {
-      if (quiet != GNUNET_YES)
-        fprintf (stdout, _("Failed to start service `%s'!\n"), service);
-      ret = 1;
-    }
+      FPRINTF (stdout, _("Service `%s' has been stopped.\n"), service);
     break;
-  case GNUNET_SYSERR:
+  case GNUNET_ARM_PROCESS_ALREADY_RUNNING:
+    FPRINTF (stderr, _("Service `%s' was already running.\n"), service);
+    ret = 1;
+    break;
+  case GNUNET_ARM_PROCESS_STARTING:
     if (quiet != GNUNET_YES)
-      fprintf (stdout,
-               _("Some error communicating with service `%s'.\n"), service);
+      FPRINTF (stdout, _("Service `%s' has been started.\n"), service);
+    break;
+  case GNUNET_ARM_PROCESS_ALREADY_STOPPING:
+    FPRINTF (stderr, _("Service `%s' was already being stopped.\n"), service);
+    ret = 1;
+    break;
+  case GNUNET_ARM_PROCESS_ALREADY_DOWN:
+    FPRINTF (stderr, _("Service `%s' was already not running.\n"), service);
+    ret = 1;
+    break;
+  case GNUNET_ARM_PROCESS_SHUTDOWN:
+    FPRINTF (stderr, "%s", _("Request ignored as ARM is shutting down.\n"));
     ret = 1;
     break;
+  case GNUNET_ARM_PROCESS_COMMUNICATION_ERROR:
+    FPRINTF (stderr, "%s", _("Error communicating with ARM service.\n"));
+    ret = 1;
+    break;
+  case GNUNET_ARM_PROCESS_COMMUNICATION_TIMEOUT:
+    FPRINTF (stderr, "%s",  _("Timeout communicating with ARM service.\n"));
+    ret = 1;
+    break;
+  case GNUNET_ARM_PROCESS_FAILURE:
+    FPRINTF (stderr, "%s",  _("Operation failed.\n"));
+    ret = 1;
+    break;
+  default:
+    FPRINTF (stderr, "%s",  _("Unknown response code from ARM.\n"));
+    break;
   }
-
-  GNUNET_SCHEDULER_add_continuation (&cps_loop,
-                                     NULL, GNUNET_SCHEDULER_REASON_PREREQ_DONE);
+  GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
 }
 
 
 /**
- * Function called to confirm that a service is running (or that
- * it is not running).
+ * Callback invoked with the list of running services.  
+ * Reports to the user and then runs the next phase in the FSM.
  *
- * @param cls pointer to "const char*" identifying service that was manipulated
- * @param tc reason determines if service is now running
+ * @param cls currently not used
+ * @param result result of the operation
+ * @param count number of running services
+ * @param list copy of the list of running services
  */
 static void
-confirm_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+list_cb (void *cls, int result, unsigned int count, const char *const*list)
 {
-  const char *service = cls;
+  unsigned int i;
 
-  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE))
+  if ( (result != GNUNET_YES) || (NULL == list) )
   {
-    if (quiet != GNUNET_YES)
-      fprintf (stdout, _("Service `%s' is running.\n"), service);
-  }
-  else
-  {
-    if (quiet != GNUNET_YES)
-      fprintf (stdout, _("Service `%s' is not running.\n"), service);
+    FPRINTF (stderr, "%s", _("Error communicating with ARM. ARM not running?\n"));
+    return;
   }
-  GNUNET_SCHEDULER_add_continuation (&cps_loop,
-                                     NULL, GNUNET_SCHEDULER_REASON_PREREQ_DONE);
+  FPRINTF (stdout, "%s", _("Running services:\n"));
+  for (i=0; i<count; i++)
+    FPRINTF (stdout, "%s\n", list[i]);
+}
+
+
+/**
+ * Attempts to delete configuration file and SERVICEHOME
+ * on arm shutdown provided the end and delete options
+ * were specified when gnunet-arm was run.
+ */
+static void
+delete_files ()
+{
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+             "Will attempt to remove configuration file %s and service directory %s\n",
+             config_file, dir);
+
+  if (UNLINK (config_file) != 0)
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+                 _("Failed to remove configuration file %s\n"), config_file);
+    }
+
+  if (GNUNET_DISK_directory_remove (dir) != GNUNET_OK)
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+                 _("Failed to remove servicehome directory %s\n"), dir);
+
+    }
+}
+
+
+/**
+ * Main continuation-passing-style loop.  Runs the various
+ * jobs that we've been asked to do in order.
+ *
+ * @param cls closure, unused
+ * @param tc context, unused
+ */
+static void
+shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+  GNUNET_ARM_disconnect (h);
+  h = NULL;
+  if ((end == GNUNET_YES) && (delete == GNUNET_YES))
+    delete_files ();   
+  GNUNET_CONFIGURATION_destroy (cfg);
+  cfg = NULL;
 }
 
 
@@ -224,58 +290,46 @@ confirm_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * @param c configuration
  */
 static void
-run (void *cls,
-     char *const *args,
-     const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
+run (void *cls, char *const *args, const char *cfgfile,
+     const struct GNUNET_CONFIGURATION_Handle *c)
 {
-  cfg = c;
+  char *armconfig;
+
+  cfg = GNUNET_CONFIGURATION_dup (c);
   config_file = cfgfile;
-  if (GNUNET_CONFIGURATION_get_value_string (cfg, "PATHS", "SERVICEHOME", &dir)
-      != GNUNET_OK)
+  if (GNUNET_CONFIGURATION_get_value_string
+      (cfg, "PATHS", "SERVICEHOME", &dir) != GNUNET_OK)
   {
-    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                _
-                ("Fatal configuration error: `%s' option in section `%s' missing.\n"),
-                "SERVICEHOME", "PATHS");
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
+                              "PATHS", "SERVICEHOME");
     return;
+    }
+  if (NULL != cfgfile)
+  {
+    if (GNUNET_OK !=
+        GNUNET_CONFIGURATION_get_value_filename (cfg, "arm", "CONFIG",
+                                                &armconfig))
+    {
+      GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG",
+                                             cfgfile);
+    }
+    else
+      GNUNET_free (armconfig);
   }
-  h = GNUNET_ARM_connect (cfg, NULL);
-  if (h == NULL)
+  if (NULL == (h = GNUNET_ARM_connect (cfg, NULL)))
   {
     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                _("Fatal error initializing ARM API.\n"));
+               _("Fatal error initializing ARM API.\n"));
     ret = 1;
+    GNUNET_CONFIGURATION_destroy (cfg);
+    cfg = NULL;
     return;
   }
-  GNUNET_SCHEDULER_add_continuation (&cps_loop,
-                                     NULL, GNUNET_SCHEDULER_REASON_PREREQ_DONE);
+  GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
+                               &shutdown_task, NULL);
+  GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
 }
 
-/**
- * Attempts to delete configuration file and SERVICEHOME
- * on arm shutdown provided the end and delete options
- * were specified when gnunet-arm was run.
- */
-static void
-delete_files ()
-{
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-              "Will attempt to remove configuration file %s and service directory %s\n",
-              config_file, dir);
-
-  if (UNLINK (config_file) != 0)
-  {
-    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                _("Failed to remove configuration file %s\n"), config_file);
-  }
-
-  if (GNUNET_DISK_directory_remove (dir) != GNUNET_OK)
-  {
-    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                _("Failed to remove servicehome directory %s\n"), dir);
-
-  }
-}
 
 /**
  * Main continuation-passing-style loop.  Runs the various
@@ -287,84 +341,98 @@ delete_files ()
 static void
 cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
+  if (NULL == h)
+    return;
+  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
+    return;
   while (1)
   {
     switch (phase++)
     {
     case 0:
-      if (term != NULL)
+      if (NULL != term)
       {
-        GNUNET_ARM_stop_service (h, term,
-                                 (0 ==
-                                  timeout.rel_value) ? STOP_TIMEOUT : timeout,
-                                 &confirm_cb, term);
-        return;
+       GNUNET_ARM_stop_service (h, term,
+                                (0 ==
+                                 timeout.rel_value) ? STOP_TIMEOUT :
+                                timeout, &confirm_cb, term);
+       return;
       }
       break;
     case 1:
       if ((end) || (restart))
       {
-        GNUNET_ARM_stop_service (h, "arm",
-                                 (0 ==
-                                  timeout.rel_value) ? STOP_TIMEOUT_ARM :
-                                 timeout, &confirm_cb, "arm");
-        return;
+       GNUNET_ARM_stop_service (h, "arm",
+                                (0 ==
+                                 timeout.rel_value) ? STOP_TIMEOUT_ARM
+                                : timeout, &confirm_cb, "arm");
+       return;
       }
       break;
     case 2:
       if (start)
       {
-        GNUNET_ARM_start_service (h, "arm",
-                                  (0 ==
-                                   timeout.rel_value) ? START_TIMEOUT : timeout,
-                                  &confirm_cb, "arm");
-        return;
+       GNUNET_ARM_start_service (h, "arm",
+                                 (no_stdout ? 0 : GNUNET_OS_INHERIT_STD_OUT) |
+                                 (no_stderr ? 0 : GNUNET_OS_INHERIT_STD_ERR),
+                                 (0 ==
+                                  timeout.rel_value) ? START_TIMEOUT :
+                                 timeout, &confirm_cb, "arm");
+       return;
       }
       break;
     case 3:
-      if (init != NULL)
-      {
-        GNUNET_ARM_start_service (h, init,
-                                  (0 ==
-                                   timeout.rel_value) ? START_TIMEOUT : timeout,
-                                  &confirm_cb, init);
-        return;
-      }
+      if (NULL != init)
+       {
+        GNUNET_ARM_start_service (h, init,
+                                  (no_stdout ? 0 : GNUNET_OS_INHERIT_STD_OUT) |
+                                  (no_stderr ? 0 : GNUNET_OS_INHERIT_STD_ERR),
+                                  (0 ==
+                                   timeout.rel_value) ? START_TIMEOUT :
+                                  timeout, &confirm_cb, init);
+        return;
+       }
       break;
     case 4:
-      if (test != NULL)
+      if (restart)
       {
-        GNUNET_CLIENT_service_test (test, cfg,
-                                    (0 ==
-                                     timeout.rel_value) ? TEST_TIMEOUT :
-                                    timeout, &confirm_task, test);
-        return;
+       GNUNET_ARM_disconnect (h);
+       phase = 0;
+       end = 0;
+       start = 1;
+       restart = 0;
+       if (NULL == (h = GNUNET_ARM_connect (cfg, NULL)))
+       {
+         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                     _("Fatal error initializing ARM API.\n"));
+         ret = 1;
+         return;
+       }
+       GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
+       return;
       }
       break;
     case 5:
-      if (restart)
+      if (list) 
       {
-        GNUNET_ARM_disconnect (h);
-        phase = 0;
-        end = 0;
-        start = 1;
-        restart = 0;
-        h = GNUNET_ARM_connect (cfg, NULL);
-        if (h == NULL)
-        {
-          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                      _("Fatal error initializing ARM API.\n"));
-          ret = 1;
-          return;
-        }
-        GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
-        return;
+       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                   "Going to list all running services controlled by ARM.\n");
+       
+       if (NULL == h) 
+       {
+         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                     _("Fatal error initializing ARM API.\n"));
+         return;
+       }       
+       GNUNET_ARM_list_running_services (h, 
+                                         (0 == 
+                                          timeout.rel_value) ? LIST_TIMEOUT : 
+                                         timeout, &list_cb, NULL);
+       return;
       }
       /* Fall through */
-    default:                   /* last phase */
-      GNUNET_ARM_disconnect (h);
-      if ((end == GNUNET_YES) && (delete == GNUNET_YES))
-        delete_files ();
+    default:           /* last phase */
+      GNUNET_SCHEDULER_shutdown ();
       return;
     }
   }
@@ -381,8 +449,6 @@ cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 int
 main (int argc, char *const *argv)
 {
-  static unsigned long long temp_timeout_ms;
-
   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
     {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
      GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
@@ -395,33 +461,36 @@ main (int argc, char *const *argv)
     {'r', "restart", NULL,
      gettext_noop ("stop and start all GNUnet default services"),
      GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
-    {'t', "test", "SERVICE",
-     gettext_noop ("test if a particular service is running"),
-     GNUNET_YES, &GNUNET_GETOPT_set_string, &test},
     {'d', "delete", NULL,
      gettext_noop ("delete config file and directory on exit"),
      GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
     {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
      GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
-    {'T', "timeout", NULL,
-     gettext_noop ("timeout for completing current operation"),
-     GNUNET_YES, &GNUNET_GETOPT_set_ulong, &temp_timeout_ms},
+    {'T', "timeout", "MSECS",
+     gettext_noop ("timeout in MSECS milliseconds for completing current operation"),
+     GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &timeout},
+    {'I', "info", NULL, gettext_noop ("list currently running services"),
+     GNUNET_NO, &GNUNET_GETOPT_set_one, &list},
+    {'O', "no-stdout", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard output"),
+     GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stdout},
+    {'E', "no-stderr", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard error"),
+     GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stderr},
     GNUNET_GETOPT_OPTION_END
   };
 
-  if (temp_timeout_ms > 0)
-    timeout.rel_value = temp_timeout_ms;
-
-  if (GNUNET_OK == GNUNET_PROGRAM_run (argc,
-                                       argv,
-                                       "gnunet-arm",
-                                       gettext_noop
-                                       ("Control services and the Automated Restart Manager (ARM)"),
-                                       options, &run, NULL))
-  {
-    return ret;
-  }
+  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
+    return 2;
 
+  if (GNUNET_OK ==
+      GNUNET_PROGRAM_run (argc, argv, "gnunet-arm",
+                         gettext_noop
+                         ("Control services and the Automated Restart Manager (ARM)"),
+                         options, &run, NULL))
+    {
+      GNUNET_free ((void *) argv);
+      return ret;
+    }
+  GNUNET_free ((void*) argv);
   return 1;
 }