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 it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  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) \
  37   GNUNET_log_from_strerror_file (kind, "util-program", syscall, filename)
  38
  39 /**
  40  * Context for the command.
  41  */
  42 struct CommandContext
  43 {
  44   /**
  45    * Argv argument.
  46    */
  47   char *const *args;
  48
  49   /**
  50    * Name of the configuration file used, can be NULL!
  51    */
  52   char *cfgfile;
  53
  54   /**
  55    * Main function to run.
  56    */
  57   GNUNET_PROGRAM_Main task;
  58
  59   /**
  60    * Closure for @e task.
  61    */
  62   void *task_cls;
  63
  64   /**
  65    * Configuration to use.
  66    */
  67   const struct GNUNET_CONFIGURATION_Handle *cfg;
  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   struct GNUNET_GETOPT_CommandLineOption *allopts;
 171   const char *gargs;
 172   char *lpfx;
 173   char *spc;
 174
 175   logfile = NULL;
 176   gargs = getenv ("GNUNET_ARGS");
 177   if (NULL != gargs)
 178   {
 179     char **gargv;
 180     unsigned int gargc;
 181     char *cargs;
 182
 183     gargv = NULL;
 184     gargc = 0;
 185     for (int i = 0; i < argc; i++)
 186       GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
 187     cargs = GNUNET_strdup (gargs);
 188     for (char *tok = strtok (cargs, " "); NULL != tok; tok = strtok (NULL, " "))
 189       GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
 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 (NULL != path)
 205   {
 206     BINDTEXTDOMAIN ("GNUnet", path);
 207     GNUNET_free (path);
 208   }
 209   textdomain ("GNUnet");
 210 #endif
 211   cnt = 0;
 212   while (NULL != options[cnt].name)
 213     cnt++;
 214   allopts =
 215     GNUNET_malloc ((cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
 216                    sizeof (defoptions));
 217   GNUNET_memcpy (allopts, defoptions, sizeof (defoptions));
 218   GNUNET_memcpy (&allopts[sizeof (defoptions) /
 219                           sizeof (struct GNUNET_GETOPT_CommandLineOption)],
 220                  options,
 221                  (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
 222   cnt += sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
 223   qsort (allopts,
 224          cnt,
 225          sizeof (struct GNUNET_GETOPT_CommandLineOption),
 226          &cmd_sorter);
 227   loglev = NULL;
 228   xdg = getenv ("XDG_CONFIG_HOME");
 229   if (NULL != xdg)
 230     GNUNET_asprintf (&cfg_fn,
 231                      "%s%s%s",
 232                      xdg,
 233                      DIR_SEPARATOR_STR,
 234                      GNUNET_OS_project_data_get ()->config_file);
 235   else
 236     cfg_fn = GNUNET_strdup (GNUNET_OS_project_data_get ()->user_config_file);
 237   lpfx = GNUNET_strdup (binaryName);
 238   if (NULL != (spc = strstr (lpfx, " ")))
 239     *spc = '\0';
 240   ret = GNUNET_GETOPT_run (binaryName, allopts, (unsigned int) argc, argv);
 241   if ((GNUNET_OK > ret) ||
 242       (GNUNET_OK != GNUNET_log_setup (lpfx, loglev, logfile)))
 243   {
 244     GNUNET_free (allopts);
 245     GNUNET_free (lpfx);
 246     goto cleanup;
 247   }
 248   if (NULL != cc.cfgfile)
 249   {
 250     if ((GNUNET_YES != GNUNET_DISK_file_test (cc.cfgfile)) ||
 251         (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cc.cfgfile)))
 252     {
 253       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 254                   _ (
 255                     "Unreadable or malformed configuration file `%s', exit ...\n"),
 256                   cc.cfgfile);
 257       ret = GNUNET_SYSERR;
 258       GNUNET_free (allopts);
 259       GNUNET_free (lpfx);
 260       goto cleanup;
 261     }
 262   }
 263   else
 264   {
 265     if (GNUNET_YES == GNUNET_DISK_file_test (cfg_fn))
 266     {
 267       if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cfg_fn))
 268       {
 269         GNUNET_log (
 270           GNUNET_ERROR_TYPE_ERROR,
 271           _ (
 272             "Unreadable or malformed default configuration file `%s', exit ...\n"),
 273           cfg_fn);
 274         ret = GNUNET_SYSERR;
 275         GNUNET_free (allopts);
 276         GNUNET_free (lpfx);
 277         goto cleanup;
 278       }
 279     }
 280     else
 281     {
 282       GNUNET_free (cfg_fn);
 283       cfg_fn = NULL;
 284       if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, NULL))
 285       {
 286         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 287                     _ ("Unreadable or malformed configuration, exit ...\n"));
 288         ret = GNUNET_SYSERR;
 289         GNUNET_free (allopts);
 290         GNUNET_free (lpfx);
 291         goto cleanup;
 292       }
 293     }
 294   }
 295   GNUNET_free (allopts);
 296   GNUNET_free (lpfx);
 297   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cc.cfg,
 298                                                           "testing",
 299                                                           "skew_offset",
 300                                                           &skew_offset) &&
 301       (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cc.cfg,
 302                                                            "testing",
 303                                                            "skew_variance",
 304                                                            &skew_variance)))
 305   {
 306     clock_offset = skew_offset - skew_variance;
 307     GNUNET_TIME_set_offset (clock_offset);
 308   }
 309   /* ARM needs to know which configuration file to use when starting
 310      services.  If we got a command-line option *and* if nothing is
 311      specified in the configuration, remember the command-line option
 312      in "cfg".  This is typically really only having an effect if we
 313      are running code in src/arm/, as obviously the rest of the code
 314      has little business with ARM-specific options. */
 315   if (GNUNET_YES != GNUNET_CONFIGURATION_have_value (cfg, "arm", "CONFIG"))
 316   {
 317     if (NULL != cc.cfgfile)
 318       GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG", cc.cfgfile);
 319     else if (NULL != cfg_fn)
 320       GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG", cfg_fn);
 321   }
 322
 323   /* run */
 324   cc.args = &argv[ret];
 325   if ((NULL == cc.cfgfile) && (NULL != cfg_fn))
 326     cc.cfgfile = GNUNET_strdup (cfg_fn);
 327   if (GNUNET_NO == run_without_scheduler)
 328   {
 329     GNUNET_SCHEDULER_run (&program_main, &cc);
 330   }
 331   else
 332   {
 333     GNUNET_RESOLVER_connect (cc.cfg);
 334     cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
 335   }
 336   ret = GNUNET_OK;
 337 cleanup:
 338   GNUNET_CONFIGURATION_destroy (cfg);
 339   GNUNET_free_non_null (cc.cfgfile);
 340   GNUNET_free_non_null (cfg_fn);
 341   GNUNET_free_non_null (loglev);
 342   GNUNET_free_non_null (logfile);
 343   return ret;
 344 }
 345
 346
 347 /**
 348  * Run a standard GNUnet command startup sequence (initialize loggers
 349  * and configuration, parse options).
 350  *
 351  * @param argc number of command line arguments
 352  * @param argv command line arguments
 353  * @param binaryName our expected name
 354  * @param binaryHelp help text for the program
 355  * @param options command line options
 356  * @param task main function to run
 357  * @param task_cls closure for @a task
 358  * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
 359  */
 360 int
 361 GNUNET_PROGRAM_run (int argc,
 362                     char *const *argv,
 363                     const char *binaryName,
 364                     const char *binaryHelp,
 365                     const struct GNUNET_GETOPT_CommandLineOption *options,
 366                     GNUNET_PROGRAM_Main task,
 367                     void *task_cls)
 368 {
 369   return GNUNET_PROGRAM_run2 (argc,
 370                               argv,
 371                               binaryName,
 372                               binaryHelp,
 373                               options,
 374                               task,
 375                               task_cls,
 376                               GNUNET_NO);
 377 }
 378
 379
 380 /* end of program.c */