src/util/program.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009-2013 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, 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-program", __VA_ARGS__)
  35
  36 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util-program", 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  * task run when the scheduler shuts down
  73  */
  74 static void
  75 shutdown_task (void *cls)
  76 {
  77   (void) cls;
  78   GNUNET_SPEEDUP_stop_ ();
  79 }
  80
  81
  82 /**
  83  * Initial task called by the scheduler for each
  84  * program.  Runs the program-specific main task.
  85  */
  86 static void
  87 program_main (void *cls)
  88 {
  89   struct CommandContext *cc = cls;
  90
  91   GNUNET_SPEEDUP_start_(cc->cfg);
  92   GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
  93   GNUNET_RESOLVER_connect (cc->cfg);
  94   cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
  95 }
  96
  97
  98 /**
  99  * Compare function for 'qsort' to sort command-line arguments by the
 100  * short option.
 101  *
 102  * @param a1 first command line option
 103  * @param a2 second command line option
 104  */
 105 static int
 106 cmd_sorter (const void *a1, const void *a2)
 107 {
 108   const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
 109   const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
 110
 111   if (toupper ((unsigned char) c1->shortName) >
 112       toupper ((unsigned char) c2->shortName))
 113     return 1;
 114   if (toupper ((unsigned char) c1->shortName) <
 115       toupper ((unsigned char) c2->shortName))
 116     return -1;
 117   if (c1->shortName > c2->shortName)
 118     return 1;
 119   if (c1->shortName < c2->shortName)
 120     return -1;
 121   return 0;
 122 }
 123
 124
 125 /**
 126  * Run a standard GNUnet command startup sequence (initialize loggers
 127  * and configuration, parse options).
 128  *
 129  * @param argc number of command line arguments in @a argv
 130  * @param argv command line arguments
 131  * @param binaryName our expected name
 132  * @param binaryHelp help text for the program
 133  * @param options command line options
 134  * @param task main function to run
 135  * @param task_cls closure for @a task
 136  * @param run_without_scheduler #GNUNET_NO start the scheduler, #GNUNET_YES do not
 137  *        start the scheduler just run the main task
 138  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
 139  */
 140 int
 141 GNUNET_PROGRAM_run2 (int argc,
 142                      char *const *argv,
 143                      const char *binaryName,
 144                      const char *binaryHelp,
 145                      const struct GNUNET_GETOPT_CommandLineOption *options,
 146                      GNUNET_PROGRAM_Main task,
 147                      void *task_cls,
 148                      int run_without_scheduler)
 149 {
 150   struct CommandContext cc;
 151 #if ENABLE_NLS
 152   char *path;
 153 #endif
 154   char *loglev;
 155   char *logfile;
 156   char *cfg_fn;
 157   const char *xdg;
 158   int ret;
 159   unsigned int cnt;
 160   unsigned long long skew_offset;
 161   unsigned long long skew_variance;
 162   long long clock_offset;
 163   struct GNUNET_CONFIGURATION_Handle *cfg;
 164   struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
 165     GNUNET_GETOPT_option_cfgfile (&cc.cfgfile),
 166     GNUNET_GETOPT_option_help (binaryHelp),
 167     GNUNET_GETOPT_option_loglevel (&loglev),
 168     GNUNET_GETOPT_option_logfile (&logfile),
 169     GNUNET_GETOPT_option_version (PACKAGE_VERSION " " VCS_VERSION)
 170   };
 171   struct GNUNET_GETOPT_CommandLineOption *allopts;
 172   const char *gargs;
 173   char *lpfx;
 174   char *spc;
 175
 176   logfile = NULL;
 177   gargs = getenv ("GNUNET_ARGS");
 178   if (NULL != gargs)
 179   {
 180     char **gargv;
 181     unsigned int gargc;
 182     char *cargs;
 183
 184     gargv = NULL;
 185     gargc = 0;
 186     for (int i = 0; i < argc; i++)
 187       GNUNET_array_append (gargv,
 188                            gargc,
 189                            GNUNET_strdup (argv[i]));
 190     cargs = GNUNET_strdup (gargs);
 191     for (char *tok = strtok (cargs, " ");
 192          NULL != tok;
 193          tok = strtok (NULL, " "))
 194       GNUNET_array_append (gargv,
 195                            gargc,
 196                            GNUNET_strdup (tok));
 197     GNUNET_free (cargs);
 198     GNUNET_array_append (gargv,
 199                          gargc,
 200                          NULL);
 201     argv = (char *const *) gargv;
 202     argc = gargc - 1;
 203   }
 204   memset (&cc,
 205           0,
 206           sizeof (cc));
 207   loglev = NULL;
 208   cc.task = task;
 209   cc.task_cls = task_cls;
 210   cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
 211   /* prepare */
 212 #if ENABLE_NLS
 213   setlocale (LC_ALL, "");
 214   path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
 215   if (NULL != path)
 216   {
 217     BINDTEXTDOMAIN ("GNUnet",
 218                     path);
 219     GNUNET_free (path);
 220   }
 221   textdomain ("GNUnet");
 222 #endif
 223   cnt = 0;
 224   while (NULL != options[cnt].name)
 225     cnt++;
 226   allopts =
 227       GNUNET_malloc ((cnt +
 228                       1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
 229                      sizeof (defoptions));
 230   GNUNET_memcpy (allopts,
 231                  defoptions,
 232                  sizeof (defoptions));
 233   GNUNET_memcpy (&allopts
 234                  [sizeof (defoptions) /
 235                   sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
 236                  (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
 237   cnt += sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
 238   qsort (allopts,
 239          cnt,
 240          sizeof (struct GNUNET_GETOPT_CommandLineOption),
 241          &cmd_sorter);
 242   loglev = NULL;
 243   xdg = getenv ("XDG_CONFIG_HOME");
 244   if (NULL != xdg)
 245     GNUNET_asprintf (&cfg_fn,
 246                      "%s%s%s",
 247                      xdg,
 248                      DIR_SEPARATOR_STR,
 249                      GNUNET_OS_project_data_get ()->config_file);
 250   else
 251     cfg_fn = GNUNET_strdup (GNUNET_OS_project_data_get ()->user_config_file);
 252   lpfx = GNUNET_strdup (binaryName);
 253   if (NULL != (spc = strstr (lpfx, " ")))
 254     *spc = '\0';
 255   ret = GNUNET_GETOPT_run (binaryName,
 256                            allopts,
 257                            (unsigned int) argc,
 258                            argv);
 259   if ((GNUNET_OK > ret) ||
 260       (GNUNET_OK !=
 261        GNUNET_log_setup (lpfx,
 262                          loglev,
 263                          logfile)))
 264   {
 265     GNUNET_free (allopts);
 266     GNUNET_free (lpfx);
 267     goto cleanup;
 268   }
 269   if (NULL == cc.cfgfile)
 270     cc.cfgfile = GNUNET_strdup (cfg_fn);
 271   if (GNUNET_YES ==
 272       GNUNET_DISK_file_test (cc.cfgfile))
 273   {
 274     if (GNUNET_SYSERR ==
 275         GNUNET_CONFIGURATION_load (cfg,
 276                                    cc.cfgfile))
 277     {
 278       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 279                   _("Malformed configuration file `%s', exit ...\n"),
 280                   cc.cfgfile);
 281       ret = GNUNET_SYSERR;
 282       GNUNET_free (allopts);
 283       GNUNET_free (lpfx);
 284       goto cleanup;
 285     }
 286   }
 287   else
 288   {
 289     if (0 != strcmp (cc.cfgfile,
 290                      cfg_fn))
 291       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 292                   _("Could not access configuration file `%s'\n"),
 293                   cc.cfgfile);
 294     if (GNUNET_SYSERR ==
 295         GNUNET_CONFIGURATION_load (cfg,
 296                                    NULL))
 297     {
 298       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 299                   _("Malformed configuration, exit ...\n"));
 300       ret = GNUNET_SYSERR;
 301       GNUNET_free (allopts);
 302       GNUNET_free (lpfx);
 303       goto cleanup;
 304     }
 305   }
 306   GNUNET_free (allopts);
 307   GNUNET_free (lpfx);
 308   if (GNUNET_OK ==
 309       GNUNET_CONFIGURATION_get_value_number (cc.cfg,
 310                                              "testing",
 311                                              "skew_offset",
 312                                              &skew_offset) &&
 313       (GNUNET_OK ==
 314        GNUNET_CONFIGURATION_get_value_number (cc.cfg,
 315                                               "testing",
 316                                               "skew_variance",
 317                                               &skew_variance)))
 318   {
 319     clock_offset = skew_offset - skew_variance;
 320     GNUNET_TIME_set_offset (clock_offset);
 321   }
 322   /* ARM needs to know which configuration file to use when starting
 323      services.  If we got a command-line option *and* if nothing is
 324      specified in the configuration, remember the command-line option
 325      in "cfg".  This is typically really only having an effect if we
 326      are running code in src/arm/, as obviously the rest of the code
 327      has little business with ARM-specific options. */
 328   if (GNUNET_YES !=
 329       GNUNET_CONFIGURATION_have_value (cfg,
 330                                        "arm",
 331                                        "CONFIG"))
 332   {
 333     GNUNET_CONFIGURATION_set_value_string (cfg,
 334                                            "arm",
 335                                            "CONFIG",
 336                                            cc.cfgfile);
 337   }
 338
 339   /* run */
 340   cc.args = &argv[ret];
 341   if (GNUNET_NO == run_without_scheduler)
 342   {
 343     GNUNET_SCHEDULER_run (&program_main, &cc);
 344   }
 345   else
 346   {
 347     GNUNET_RESOLVER_connect (cc.cfg);
 348     cc.task (cc.task_cls,
 349              cc.args,
 350              cc.cfgfile,
 351              cc.cfg);
 352   }
 353   ret = GNUNET_OK;
 354  cleanup:
 355   GNUNET_CONFIGURATION_destroy (cfg);
 356   GNUNET_free_non_null (cc.cfgfile);
 357   GNUNET_free (cfg_fn);
 358   GNUNET_free_non_null (loglev);
 359   GNUNET_free_non_null (logfile);
 360   return ret;
 361 }
 362
 363
 364 /**
 365  * Run a standard GNUnet command startup sequence (initialize loggers
 366  * and configuration, parse options).
 367  *
 368  * @param argc number of command line arguments
 369  * @param argv command line arguments
 370  * @param binaryName our expected name
 371  * @param binaryHelp help text for the program
 372  * @param options command line options
 373  * @param task main function to run
 374  * @param task_cls closure for @a task
 375  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
 376  */
 377 int
 378 GNUNET_PROGRAM_run (int argc, char *const *argv,
 379                     const char *binaryName,
 380                     const char *binaryHelp,
 381                     const struct GNUNET_GETOPT_CommandLineOption *options,
 382                     GNUNET_PROGRAM_Main task,
 383                     void *task_cls)
 384 {
 385   return GNUNET_PROGRAM_run2 (argc, argv,
 386                               binaryName, binaryHelp,
 387                               options,
 388                               task, task_cls,
 389                               GNUNET_NO);
 390 }
 391
 392
 393 /* end of program.c */