src/arm/gnunet-arm.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2012 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file arm/gnunet-arm.c
  23  * @brief arm for writing a tool
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_arm_service.h"
  28 #include "gnunet_constants.h"
  29 #include "gnunet_util_lib.h"
  30
  31 /**
  32  * Timeout for stopping services.  Long to give some services a real chance.
  33  */
  34 #define STOP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
  35
  36 /**
  37  * Timeout for stopping ARM.  Extra-long since ARM needs to stop everyone else.
  38  */
  39 #define STOP_TIMEOUT_ARM GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
  40
  41 /**
  42  * Timeout for starting services, very short because of the strange way start works
  43  * (by checking if running before starting, so really this time is always waited on
  44  * startup (annoying)).
  45  */
  46 #define START_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
  47
  48 /**
  49  * Timeout for listing all running services.
  50  */
  51 #define LIST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
  52
  53 /**
  54  * Set if we are to shutdown all services (including ARM).
  55  */
  56 static int end;
  57
  58 /**
  59  * Set if we are to start default services (including ARM).
  60  */
  61 static int start;
  62
  63 /**
  64  * Set if we are to stop/start default services (including ARM).
  65  */
  66 static int restart;
  67
  68 /**
  69  * Set if we should delete configuration and temp directory on exit.
  70  */
  71 static int delete;
  72
  73 /**
  74  * Set if we should not print status messages.
  75  */
  76 static int quiet;
  77
  78 /**
  79  * Set if we should print a list of currently running services.
  80  */
  81 static int list;
  82
  83 /**
  84  * Set to the name of a service to start.
  85  */
  86 static char *init;
  87
  88 /**
  89  * Set to the name of a service to kill.
  90  */
  91 static char *term;
  92
  93 /**
  94  * Set to the name of the config file used.
  95  */
  96 static const char *config_file;
  97
  98 /**
  99  * Set to the directory where runtime files are stored.
 100  */
 101 static char *dir;
 102
 103 /**
 104  * Final status code.
 105  */
 106 static int ret;
 107
 108 /**
 109  * Connection with ARM.
 110  */
 111 static struct GNUNET_ARM_Handle *h;
 112
 113 /**
 114  * Our configuration.
 115  */
 116 static const struct GNUNET_CONFIGURATION_Handle *cfg;
 117
 118 /**
 119  * Processing stage that we are in.  Simple counter.
 120  */
 121 static unsigned int phase;
 122
 123 /**
 124  * User defined timestamp for completing operations.
 125  */
 126 static struct GNUNET_TIME_Relative timeout;
 127
 128 /**
 129  * Do we want to give our stdout to gnunet-service-arm?
 130  */
 131 static unsigned int no_stdout;
 132
 133 /**
 134  * Do we want to give our stderr to gnunet-service-arm?
 135  */
 136 static unsigned int no_stderr;
 137
 138
 139 /**
 140  * Main continuation-passing-style loop.  Runs the various
 141  * jobs that we've been asked to do in order.
 142  *
 143  * @param cls closure, unused
 144  * @param tc context, unused
 145  */
 146 static void
 147 cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 148
 149
 150 /**
 151  * Callback invoked with the status of the last operation.  Reports to the
 152  * user and then runs the next phase in the FSM.
 153  *
 154  * @param cls pointer to "const char*" identifying service that was manipulated
 155  * @param result result of the operation
 156  */
 157 static void
 158 confirm_cb (void *cls,
 159             enum GNUNET_ARM_ProcessStatus result)
 160 {
 161   const char *service = cls;
 162
 163   switch (result)
 164   {
 165   case GNUNET_ARM_PROCESS_UNKNOWN:
 166     FPRINTF (stderr, _("Service `%s' is unknown to ARM.\n"), service);
 167     ret = 1;
 168     break;
 169   case GNUNET_ARM_PROCESS_DOWN:
 170     if (quiet != GNUNET_YES)
 171       FPRINTF (stdout, _("Service `%s' has been stopped.\n"), service);
 172     break;
 173   case GNUNET_ARM_PROCESS_ALREADY_RUNNING:
 174     FPRINTF (stderr, _("Service `%s' was already running.\n"), service);
 175     ret = 1;
 176     break;
 177   case GNUNET_ARM_PROCESS_STARTING:
 178     if (quiet != GNUNET_YES)
 179       FPRINTF (stdout, _("Service `%s' has been started.\n"), service);
 180     break;
 181   case GNUNET_ARM_PROCESS_ALREADY_STOPPING:
 182     FPRINTF (stderr, _("Service `%s' was already being stopped.\n"), service);
 183     ret = 1;
 184     break;
 185   case GNUNET_ARM_PROCESS_ALREADY_DOWN:
 186     FPRINTF (stderr, _("Service `%s' was already not running.\n"), service);
 187     ret = 1;
 188     break;
 189   case GNUNET_ARM_PROCESS_SHUTDOWN:
 190     FPRINTF (stderr, "%s", _("Request ignored as ARM is shutting down.\n"));
 191     ret = 1;
 192     break;
 193   case GNUNET_ARM_PROCESS_COMMUNICATION_ERROR:
 194     FPRINTF (stderr, "%s", _("Error communicating with ARM service.\n"));
 195     ret = 1;
 196     break;
 197   case GNUNET_ARM_PROCESS_COMMUNICATION_TIMEOUT:
 198     FPRINTF (stderr, "%s",  _("Timeout communicating with ARM service.\n"));
 199     ret = 1;
 200     break;
 201   case GNUNET_ARM_PROCESS_FAILURE:
 202     FPRINTF (stderr, "%s",  _("Operation failed.\n"));
 203     ret = 1;
 204     break;
 205   default:
 206     FPRINTF (stderr, "%s",  _("Unknown response code from ARM.\n"));
 207     break;
 208   }
 209   GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
 210 }
 211
 212
 213 /**
 214  * Callback invoked with the list of running services.
 215  * Reports to the user and then runs the next phase in the FSM.
 216  *
 217  * @param cls currently not used
 218  * @param result result of the operation
 219  * @param count number of running services
 220  * @param list copy of the list of running services
 221  */
 222 static void
 223 list_cb (void *cls, int result, unsigned int count, const char *const*list)
 224 {
 225   unsigned int i;
 226
 227   if ( (result != GNUNET_YES) || (NULL == list) )
 228   {
 229     FPRINTF (stderr, "%s", _("Error communicating with ARM. ARM not running?\n"));
 230     return;
 231   }
 232   FPRINTF (stdout, "%s", _("Running services:\n"));
 233   for (i=0; i<count; i++)
 234     FPRINTF (stdout, "%s\n", list[i]);
 235 }
 236
 237
 238 /**
 239  * Attempts to delete configuration file and SERVICEHOME
 240  * on arm shutdown provided the end and delete options
 241  * were specified when gnunet-arm was run.
 242  */
 243 static void
 244 delete_files ()
 245 {
 246   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 247               "Will attempt to remove configuration file %s and service directory %s\n",
 248               config_file, dir);
 249
 250   if (UNLINK (config_file) != 0)
 251     {
 252       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 253                   _("Failed to remove configuration file %s\n"), config_file);
 254     }
 255
 256   if (GNUNET_DISK_directory_remove (dir) != GNUNET_OK)
 257     {
 258       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 259                   _("Failed to remove servicehome directory %s\n"), dir);
 260
 261     }
 262 }
 263
 264
 265 /**
 266  * Main continuation-passing-style loop.  Runs the various
 267  * jobs that we've been asked to do in order.
 268  *
 269  * @param cls closure, unused
 270  * @param tc context, unused
 271  */
 272 static void
 273 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 274 {
 275   GNUNET_ARM_disconnect (h);
 276   h = NULL;
 277   if ((end == GNUNET_YES) && (delete == GNUNET_YES))
 278     delete_files ();
 279 }
 280
 281
 282 /**
 283  * Main function that will be run by the scheduler.
 284  *
 285  * @param cls closure
 286  * @param args remaining command-line arguments
 287  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 288  * @param c configuration
 289  */
 290 static void
 291 run (void *cls, char *const *args, const char *cfgfile,
 292      const struct GNUNET_CONFIGURATION_Handle *c)
 293 {
 294   cfg = c;
 295   config_file = cfgfile;
 296   if (GNUNET_CONFIGURATION_get_value_string
 297       (cfg, "PATHS", "SERVICEHOME", &dir) != GNUNET_OK)
 298   {
 299     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
 300                                "PATHS", "SERVICEHOME");
 301     return;
 302     }
 303   if (NULL == (h = GNUNET_ARM_connect (cfg, NULL)))
 304   {
 305     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 306                 _("Fatal error initializing ARM API.\n"));
 307     ret = 1;
 308     return;
 309   }
 310   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 311                                 &shutdown_task, NULL);
 312   GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
 313 }
 314
 315
 316 /**
 317  * Main continuation-passing-style loop.  Runs the various
 318  * jobs that we've been asked to do in order.
 319  *
 320  * @param cls closure, unused
 321  * @param tc context, unused
 322  */
 323 static void
 324 cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 325 {
 326   if (NULL == h)
 327     return;
 328   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 329     return;
 330   while (1)
 331   {
 332     switch (phase++)
 333     {
 334     case 0:
 335       if (NULL != term)
 336       {
 337         GNUNET_ARM_stop_service (h, term,
 338                                  (0 ==
 339                                   timeout.rel_value) ? STOP_TIMEOUT :
 340                                  timeout, &confirm_cb, term);
 341         return;
 342       }
 343       break;
 344     case 1:
 345       if ((end) || (restart))
 346       {
 347         GNUNET_ARM_stop_service (h, "arm",
 348                                  (0 ==
 349                                   timeout.rel_value) ? STOP_TIMEOUT_ARM
 350                                  : timeout, &confirm_cb, "arm");
 351         return;
 352       }
 353       break;
 354     case 2:
 355       if (start)
 356       {
 357         GNUNET_ARM_start_service (h, "arm",
 358                                   (no_stdout ? 0 : GNUNET_OS_INHERIT_STD_OUT) |
 359                                   (no_stderr ? 0 : GNUNET_OS_INHERIT_STD_ERR),
 360                                   (0 ==
 361                                    timeout.rel_value) ? START_TIMEOUT :
 362                                   timeout, &confirm_cb, "arm");
 363         return;
 364       }
 365       break;
 366     case 3:
 367       if (NULL != init)
 368        {
 369          GNUNET_ARM_start_service (h, init,
 370                                    (no_stdout ? 0 : GNUNET_OS_INHERIT_STD_OUT) |
 371                                    (no_stderr ? 0 : GNUNET_OS_INHERIT_STD_ERR),
 372                                    (0 ==
 373                                     timeout.rel_value) ? START_TIMEOUT :
 374                                    timeout, &confirm_cb, init);
 375          return;
 376        }
 377       break;
 378     case 4:
 379       if (restart)
 380       {
 381         GNUNET_ARM_disconnect (h);
 382         phase = 0;
 383         end = 0;
 384         start = 1;
 385         restart = 0;
 386         if (NULL == (h = GNUNET_ARM_connect (cfg, NULL)))
 387         {
 388           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 389                       _("Fatal error initializing ARM API.\n"));
 390           ret = 1;
 391           return;
 392         }
 393         GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
 394         return;
 395       }
 396       break;
 397     case 5:
 398       if (list)
 399       {
 400         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 401                     "Going to list all running services controlled by ARM.\n");
 402
 403         if (NULL == h)
 404         {
 405           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 406                       _("Fatal error initializing ARM API.\n"));
 407           return;
 408         }
 409         GNUNET_ARM_list_running_services (h,
 410                                           (0 ==
 411                                            timeout.rel_value) ? LIST_TIMEOUT :
 412                                           timeout, &list_cb, NULL);
 413         return;
 414       }
 415       /* Fall through */
 416     default:            /* last phase */
 417       GNUNET_SCHEDULER_shutdown ();
 418       return;
 419     }
 420   }
 421 }
 422
 423
 424 /**
 425  * The main function to obtain arm from gnunetd.
 426  *
 427  * @param argc number of arguments from the command line
 428  * @param argv command line arguments
 429  * @return 0 ok, 1 on error
 430  */
 431 int
 432 main (int argc, char *const *argv)
 433 {
 434   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 435     {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
 436      GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
 437     {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
 438      GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
 439     {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
 440      GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
 441     {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
 442      GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
 443     {'r', "restart", NULL,
 444      gettext_noop ("stop and start all GNUnet default services"),
 445      GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
 446     {'d', "delete", NULL,
 447      gettext_noop ("delete config file and directory on exit"),
 448      GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
 449     {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
 450      GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
 451     {'T', "timeout", "MSECS",
 452      gettext_noop ("timeout in MSECS milliseconds for completing current operation"),
 453      GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &timeout},
 454     {'I', "info", NULL, gettext_noop ("list currently running services"),
 455      GNUNET_NO, &GNUNET_GETOPT_set_one, &list},
 456     {'O', "no-stdout", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard output"),
 457      GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stdout},
 458     {'E', "no-stderr", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard error"),
 459      GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stderr},
 460     GNUNET_GETOPT_OPTION_END
 461   };
 462
 463   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 464     return 2;
 465
 466   if (GNUNET_OK ==
 467       GNUNET_PROGRAM_run (argc, argv, "gnunet-arm",
 468                           gettext_noop
 469                           ("Control services and the Automated Restart Manager (ARM)"),
 470                           options, &run, NULL))
 471     {
 472       GNUNET_free ((void *) argv);
 473       return ret;
 474     }
 475   GNUNET_free ((void*) argv);
 476   return 1;
 477 }
 478
 479 /* end of gnunet-arm.c */