src/util/program.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009-2013 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 PURPROSE.  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 util/program.c
  23  * @brief standard code for GNUnet startup and shutdown
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_resolver_service.h"
  30 #include "gnunet_constants.h"
  31 #include "speedup.h"
  32 #include <gcrypt.h>
  33
  34 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
  35
  36 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
  37
  38 /**
  39  * Context for the command.
  40  */
  41 struct CommandContext
  42 {
  43   /**
  44    * Argv argument.
  45    */
  46   char *const *args;
  47
  48   /**
  49    * Name of the configuration file used, can be NULL!
  50    */
  51   char *cfgfile;
  52
  53   /**
  54    * Main function to run.
  55    */
  56   GNUNET_PROGRAM_Main task;
  57
  58   /**
  59    * Closure for @e task.
  60    */
  61   void *task_cls;
  62
  63   /**
  64    * Configuration to use.
  65    */
  66   const struct GNUNET_CONFIGURATION_Handle *cfg;
  67
  68 };
  69
  70
  71 /**
  72  * Initial task called by the scheduler for each
  73  * program.  Runs the program-specific main task.
  74  */
  75 static void
  76 program_main (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  77 {
  78   struct CommandContext *cc = cls;
  79
  80   if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
  81     return;
  82   GNUNET_SPEEDUP_start_(cc->cfg);
  83   GNUNET_RESOLVER_connect (cc->cfg);
  84   cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
  85 }
  86
  87
  88 /**
  89  * Compare function for 'qsort' to sort command-line arguments by the
  90  * short option.
  91  *
  92  * @param a1 first command line option
  93  * @param a2 second command line option
  94  */
  95 static int
  96 cmd_sorter (const void *a1, const void *a2)
  97 {
  98   const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
  99   const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
 100
 101   if (toupper ((unsigned char) c1->shortName) >
 102       toupper ((unsigned char) c2->shortName))
 103     return 1;
 104   if (toupper ((unsigned char) c1->shortName) <
 105       toupper ((unsigned char) c2->shortName))
 106     return -1;
 107   if (c1->shortName > c2->shortName)
 108     return 1;
 109   if (c1->shortName < c2->shortName)
 110     return -1;
 111   return 0;
 112 }
 113
 114
 115 /**
 116  * Run a standard GNUnet command startup sequence (initialize loggers
 117  * and configuration, parse options).
 118  *
 119  * @param argc number of command line arguments in @a argv
 120  * @param argv command line arguments
 121  * @param binaryName our expected name
 122  * @param binaryHelp help text for the program
 123  * @param options command line options
 124  * @param task main function to run
 125  * @param task_cls closure for @a task
 126  * @param run_without_scheduler #GNUNET_NO start the scheduler, #GNUNET_YES do not
 127  *        start the scheduler just run the main task
 128  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
 129  */
 130 int
 131 GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName,
 132                     const char *binaryHelp,
 133                     const struct GNUNET_GETOPT_CommandLineOption *options,
 134                     GNUNET_PROGRAM_Main task, void *task_cls,
 135                     int run_without_scheduler)
 136 {
 137   struct CommandContext cc;
 138 #if ENABLE_NLS
 139   char *path;
 140 #endif
 141   char *loglev;
 142   char *logfile;
 143   char *cfg_fn;
 144   const char *xdg;
 145   int ret;
 146   unsigned int cnt;
 147   unsigned long long skew_offset;
 148   unsigned long long skew_variance;
 149   long long clock_offset;
 150   struct GNUNET_CONFIGURATION_Handle *cfg;
 151
 152   struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
 153     GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
 154     GNUNET_GETOPT_OPTION_HELP (binaryHelp),
 155     GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
 156     GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
 157     GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION " " VCS_VERSION)
 158   };
 159   struct GNUNET_GETOPT_CommandLineOption *allopts;
 160   const char *gargs;
 161   char *lpfx;
 162   char *spc;
 163
 164   logfile = NULL;
 165   gargs = getenv ("GNUNET_ARGS");
 166   if (NULL != gargs)
 167   {
 168     char **gargv;
 169     unsigned int gargc;
 170     int i;
 171     char *tok;
 172     char *cargs;
 173
 174     gargv = NULL;
 175     gargc = 0;
 176     for (i = 0; i < argc; i++)
 177       GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
 178     cargs = GNUNET_strdup (gargs);
 179     for (tok = strtok (cargs, " "); NULL != tok; tok = strtok (NULL, " "))
 180       GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
 181     GNUNET_free (cargs);
 182     GNUNET_array_append (gargv, gargc, NULL);
 183     argv = (char *const *) gargv;
 184     argc = gargc - 1;
 185   }
 186   memset (&cc, 0, sizeof (cc));
 187   loglev = NULL;
 188   cc.task = task;
 189   cc.task_cls = task_cls;
 190   cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
 191   /* prepare */
 192 #if ENABLE_NLS
 193   setlocale (LC_ALL, "");
 194   path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
 195   if (NULL != path)
 196   {
 197     BINDTEXTDOMAIN ("GNUnet", path);
 198     GNUNET_free (path);
 199   }
 200   textdomain ("GNUnet");
 201 #endif
 202   cnt = 0;
 203   while (NULL != options[cnt].name)
 204     cnt++;
 205   allopts =
 206       GNUNET_malloc ((cnt +
 207                       1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
 208                      sizeof (defoptions));
 209   memcpy (allopts, defoptions, sizeof (defoptions));
 210   memcpy (&allopts
 211           [sizeof (defoptions) /
 212            sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
 213           (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
 214   cnt += sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
 215   qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
 216          &cmd_sorter);
 217   loglev = NULL;
 218   xdg = getenv ("XDG_CONFIG_HOME");
 219   if (NULL != xdg)
 220     GNUNET_asprintf (&cfg_fn,
 221                      "%s%s%s",
 222                      xdg,
 223                      DIR_SEPARATOR_STR,
 224                      "gnunet.conf");
 225   else
 226     cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
 227   lpfx = GNUNET_strdup (binaryName);
 228   if (NULL != (spc = strstr (lpfx, " ")))
 229     *spc = '\0';
 230   ret = GNUNET_GETOPT_run (binaryName, allopts, (unsigned int) argc, argv);
 231   if ((GNUNET_OK > ret) ||
 232       (GNUNET_OK != GNUNET_log_setup (lpfx, loglev, logfile)))
 233   {
 234     GNUNET_free (allopts);
 235     GNUNET_free (lpfx);
 236     goto cleanup;
 237   }
 238   if (NULL == cc.cfgfile)
 239     cc.cfgfile = GNUNET_strdup (cfg_fn);
 240   if (GNUNET_YES ==
 241       GNUNET_DISK_file_test (cc.cfgfile))
 242   {
 243     if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cc.cfgfile))
 244     {
 245       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 246                   _("Malformed configuration file `%s', exit ...\n"),
 247                   cc.cfgfile);
 248       ret = GNUNET_SYSERR;
 249       GNUNET_free (allopts);
 250       GNUNET_free (lpfx);
 251       goto cleanup;
 252     }
 253   }
 254   else
 255   {
 256     if (0 != strcmp (cc.cfgfile, cfg_fn))
 257       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 258                   _("Could not access configuration file `%s'\n"),
 259                   cc.cfgfile);
 260     if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, NULL))
 261     {
 262       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 263                   _("Malformed configuration, exit ...\n"));
 264       ret = GNUNET_SYSERR;
 265       GNUNET_free (allopts);
 266       GNUNET_free (lpfx);
 267       goto cleanup;
 268     }
 269   }
 270   GNUNET_free (allopts);
 271   GNUNET_free (lpfx);
 272   if (GNUNET_OK ==
 273       GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing", "skew_offset",
 274                                              &skew_offset) &&
 275       (GNUNET_OK ==
 276        GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing",
 277                                               "skew_variance", &skew_variance)))
 278   {
 279     clock_offset = skew_offset - skew_variance;
 280     GNUNET_TIME_set_offset (clock_offset);
 281   }
 282   /* run */
 283   cc.args = &argv[ret];
 284   if (GNUNET_NO == run_without_scheduler)
 285   {
 286     GNUNET_SCHEDULER_run (&program_main, &cc);
 287   }
 288   else
 289   {
 290     GNUNET_RESOLVER_connect (cc.cfg);
 291     cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
 292   }
 293   ret = GNUNET_OK;
 294  cleanup:
 295   GNUNET_SPEEDUP_stop_ ();
 296   GNUNET_CONFIGURATION_destroy (cfg);
 297   GNUNET_free_non_null (cc.cfgfile);
 298   GNUNET_free (cfg_fn);
 299   GNUNET_free_non_null (loglev);
 300   GNUNET_free_non_null (logfile);
 301   return ret;
 302 }
 303
 304 /**
 305  * Run a standard GNUnet command startup sequence (initialize loggers
 306  * and configuration, parse options).
 307  *
 308  * @param argc number of command line arguments
 309  * @param argv command line arguments
 310  * @param binaryName our expected name
 311  * @param binaryHelp help text for the program
 312  * @param options command line options
 313  * @param task main function to run
 314  * @param task_cls closure for @a task
 315  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
 316  */
 317 int
 318 GNUNET_PROGRAM_run (int argc, char *const *argv,
 319                     const char *binaryName,
 320                     const char *binaryHelp,
 321                     const struct GNUNET_GETOPT_CommandLineOption *options,
 322                     GNUNET_PROGRAM_Main task,
 323                     void *task_cls)
 324 {
 325   return GNUNET_PROGRAM_run2 (argc, argv,
 326                               binaryName, binaryHelp,
 327                               options,
 328                               task, task_cls,
 329                               GNUNET_NO);
 330 }
 331
 332
 333 /* end of program.c */