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   int ret;
 149   unsigned int cnt;
 150   unsigned long long skew_offset;
 151   unsigned long long skew_variance;
 152   long long clock_offset;
 153   struct GNUNET_CONFIGURATION_Handle *cfg;
 154
 155   struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
 156     GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
 157     GNUNET_GETOPT_OPTION_HELP (binaryHelp),
 158     GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
 159     GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
 160     GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION " " VCS_VERSION)
 161   };
 162   struct GNUNET_GETOPT_CommandLineOption *allopts;
 163   const char *gargs;
 164   char *lpfx;
 165   char *spc;
 166
 167   logfile = NULL;
 168   gargs = getenv ("GNUNET_ARGS");
 169   if (gargs != NULL)
 170   {
 171     char **gargv;
 172     unsigned int gargc;
 173     int i;
 174     char *tok;
 175     char *cargs;
 176
 177     gargv = NULL;
 178     gargc = 0;
 179     for (i = 0; i < argc; i++)
 180       GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
 181     cargs = GNUNET_strdup (gargs);
 182     tok = strtok (cargs, " ");
 183     while (NULL != tok)
 184     {
 185       GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
 186       tok = strtok (NULL, " ");
 187     }
 188     GNUNET_free (cargs);
 189     GNUNET_array_append (gargv, gargc, NULL);
 190     argv = (char *const *) gargv;
 191     argc = gargc - 1;
 192   }
 193   memset (&cc, 0, sizeof (cc));
 194   loglev = NULL;
 195   cc.task = task;
 196   cc.task_cls = task_cls;
 197   cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
 198
 199   /* prepare */
 200 #if ENABLE_NLS
 201   setlocale (LC_ALL, "");
 202   path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
 203   if (path != NULL)
 204   {
 205     BINDTEXTDOMAIN ("GNUnet", path);
 206     GNUNET_free (path);
 207   }
 208   textdomain ("GNUnet");
 209 #endif
 210   cnt = 0;
 211   while (options[cnt].name != NULL)
 212     cnt++;
 213   allopts =
 214       GNUNET_malloc ((cnt +
 215                       1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
 216                      sizeof (defoptions));
 217   memcpy (allopts, defoptions, sizeof (defoptions));
 218   memcpy (&allopts
 219           [sizeof (defoptions) /
 220            sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
 221           (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
 222   cnt += sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
 223   qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
 224          &cmd_sorter);
 225   loglev = NULL;
 226   cc.cfgfile = 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_CONFIGURATION_destroy (cfg);
 235     GNUNET_free_non_null (cc.cfgfile);
 236     GNUNET_free_non_null (loglev);
 237     GNUNET_free_non_null (logfile);
 238     GNUNET_free (allopts);
 239     GNUNET_free (lpfx);
 240     return (ret == GNUNET_SYSERR) ? GNUNET_SYSERR : GNUNET_OK;
 241   }
 242   if (GNUNET_YES ==
 243       GNUNET_DISK_file_test (cc.cfgfile))
 244     (void) GNUNET_CONFIGURATION_load (cfg, cc.cfgfile);
 245   else
 246   {
 247     (void) GNUNET_CONFIGURATION_load (cfg, NULL);
 248     if (0 != strcmp (cc.cfgfile, GNUNET_DEFAULT_USER_CONFIG_FILE))
 249       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 250                   _("Could not access configuration file `%s'\n"),
 251                   cc.cfgfile);
 252   }
 253   GNUNET_free (allopts);
 254   GNUNET_free (lpfx);
 255   if (GNUNET_OK ==
 256       GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing", "skew_offset",
 257                                              &skew_offset) &&
 258       (GNUNET_OK ==
 259        GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing",
 260                                               "skew_variance", &skew_variance)))
 261   {
 262     clock_offset = skew_offset - skew_variance;
 263     GNUNET_TIME_set_offset (clock_offset);
 264   }
 265   /* run */
 266   cc.args = &argv[ret];
 267   if (GNUNET_NO == run_without_scheduler)
 268   {
 269           GNUNET_SCHEDULER_run (&program_main, &cc);
 270   }
 271   else
 272   {
 273           GNUNET_RESOLVER_connect (cc.cfg);
 274           cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
 275   }
 276   /* clean up */
 277   GNUNET_SPEEDUP_stop_ ();
 278   GNUNET_CONFIGURATION_destroy (cfg);
 279   GNUNET_free_non_null (cc.cfgfile);
 280   GNUNET_free_non_null (loglev);
 281   GNUNET_free_non_null (logfile);
 282   return GNUNET_OK;
 283 }
 284
 285 /**
 286  * Run a standard GNUnet command startup sequence (initialize loggers
 287  * and configuration, parse options).
 288  *
 289  * @param argc number of command line arguments
 290  * @param argv command line arguments
 291  * @param binaryName our expected name
 292  * @param binaryHelp help text for the program
 293  * @param options command line options
 294  * @param task main function to run
 295  * @param task_cls closure for task
 296  * @return GNUNET_SYSERR on error, GNUNET_OK on success
 297  */
 298 int
 299 GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName,
 300                     const char *binaryHelp,
 301                     const struct GNUNET_GETOPT_CommandLineOption *options,
 302                     GNUNET_PROGRAM_Main task, void *task_cls)
 303 {
 304         return GNUNET_PROGRAM_run2 (argc, argv, binaryName, binaryHelp, options, task, task_cls, GNUNET_NO);
 305 }
 306
 307
 308
 309 /* end of program.c */