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