src/util/program.c

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