2 This file is part of GNUnet.
3 Copyright (C) 2009-2013 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file util/program.c
23 * @brief standard code for GNUnet startup and shutdown
24 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet_resolver_service.h"
30 #include "gnunet_constants.h"
34 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
36 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
39 * Context for the command.
49 * Name of the configuration file used, can be NULL!
54 * Main function to run.
56 GNUNET_PROGRAM_Main task;
59 * Closure for @e task.
64 * Configuration to use.
66 const struct GNUNET_CONFIGURATION_Handle *cfg;
72 * Initial task called by the scheduler for each
73 * program. Runs the program-specific main task.
76 program_main (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
78 struct CommandContext *cc = cls;
80 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
82 GNUNET_SPEEDUP_start_(cc->cfg);
83 GNUNET_RESOLVER_connect (cc->cfg);
84 cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
89 * Compare function for 'qsort' to sort command-line arguments by the
92 * @param a1 first command line option
93 * @param a2 second command line option
96 cmd_sorter (const void *a1, const void *a2)
98 const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
99 const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
101 if (toupper ((unsigned char) c1->shortName) >
102 toupper ((unsigned char) c2->shortName))
104 if (toupper ((unsigned char) c1->shortName) <
105 toupper ((unsigned char) c2->shortName))
107 if (c1->shortName > c2->shortName)
109 if (c1->shortName < c2->shortName)
116 * Run a standard GNUnet command startup sequence (initialize loggers
117 * and configuration, parse options).
119 * @param argc number of command line arguments in @a argv
120 * @param argv command line arguments
121 * @param binaryName our expected name
122 * @param binaryHelp help text for the program
123 * @param options command line options
124 * @param task main function to run
125 * @param task_cls closure for @a task
126 * @param run_without_scheduler #GNUNET_NO start the scheduler, #GNUNET_YES do not
127 * start the scheduler just run the main task
128 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
131 GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName,
132 const char *binaryHelp,
133 const struct GNUNET_GETOPT_CommandLineOption *options,
134 GNUNET_PROGRAM_Main task, void *task_cls,
135 int run_without_scheduler)
137 struct CommandContext cc;
147 unsigned long long skew_offset;
148 unsigned long long skew_variance;
149 long long clock_offset;
150 struct GNUNET_CONFIGURATION_Handle *cfg;
152 struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
153 GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
154 GNUNET_GETOPT_OPTION_HELP (binaryHelp),
155 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
156 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
157 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION " " VCS_VERSION)
159 struct GNUNET_GETOPT_CommandLineOption *allopts;
165 gargs = getenv ("GNUNET_ARGS");
176 for (i = 0; i < argc; i++)
177 GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
178 cargs = GNUNET_strdup (gargs);
179 for (tok = strtok (cargs, " "); NULL != tok; tok = strtok (NULL, " "))
180 GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
182 GNUNET_array_append (gargv, gargc, NULL);
183 argv = (char *const *) gargv;
186 memset (&cc, 0, sizeof (cc));
189 cc.task_cls = task_cls;
190 cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
193 setlocale (LC_ALL, "");
194 path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
197 BINDTEXTDOMAIN ("GNUnet", path);
200 textdomain ("GNUnet");
203 while (NULL != options[cnt].name)
206 GNUNET_malloc ((cnt +
207 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
208 sizeof (defoptions));
209 memcpy (allopts, defoptions, sizeof (defoptions));
211 [sizeof (defoptions) /
212 sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
213 (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
214 cnt += sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
215 qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
218 xdg = getenv ("XDG_CONFIG_HOME");
220 GNUNET_asprintf (&cfg_fn,
226 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
227 lpfx = GNUNET_strdup (binaryName);
228 if (NULL != (spc = strstr (lpfx, " ")))
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)))
234 GNUNET_free (allopts);
238 if (NULL == cc.cfgfile)
239 cc.cfgfile = GNUNET_strdup (cfg_fn);
241 GNUNET_DISK_file_test (cc.cfgfile))
243 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cc.cfgfile))
245 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
246 _("Malformed configuration file `%s', exit ...\n"),
249 GNUNET_free (allopts);
256 if (0 != strcmp (cc.cfgfile, cfg_fn))
257 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
258 _("Could not access configuration file `%s'\n"),
260 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, NULL))
262 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
263 _("Malformed configuration, exit ...\n"));
265 GNUNET_free (allopts);
270 GNUNET_free (allopts);
273 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing", "skew_offset",
276 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing",
277 "skew_variance", &skew_variance)))
279 clock_offset = skew_offset - skew_variance;
280 GNUNET_TIME_set_offset (clock_offset);
282 /* ARM needs to know which configuration file to use when starting
283 services. If we got a command-line option *and* if nothing is
284 specified in the configuration, remember the command-line option
285 in "cfg". This is typically really only having an effect if we
286 are running code in src/arm/, as obviously the rest of the code
287 has little business with ARM-specific options. */
289 GNUNET_CONFIGURATION_have_value (cfg,
293 GNUNET_CONFIGURATION_set_value_string (cfg,
299 cc.args = &argv[ret];
300 if (GNUNET_NO == run_without_scheduler)
302 GNUNET_SCHEDULER_run (&program_main, &cc);
306 GNUNET_RESOLVER_connect (cc.cfg);
307 cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
311 GNUNET_SPEEDUP_stop_ ();
312 GNUNET_CONFIGURATION_destroy (cfg);
313 GNUNET_free_non_null (cc.cfgfile);
314 GNUNET_free (cfg_fn);
315 GNUNET_free_non_null (loglev);
316 GNUNET_free_non_null (logfile);
321 * Run a standard GNUnet command startup sequence (initialize loggers
322 * and configuration, parse options).
324 * @param argc number of command line arguments
325 * @param argv command line arguments
326 * @param binaryName our expected name
327 * @param binaryHelp help text for the program
328 * @param options command line options
329 * @param task main function to run
330 * @param task_cls closure for @a task
331 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
334 GNUNET_PROGRAM_run (int argc, char *const *argv,
335 const char *binaryName,
336 const char *binaryHelp,
337 const struct GNUNET_GETOPT_CommandLineOption *options,
338 GNUNET_PROGRAM_Main task,
341 return GNUNET_PROGRAM_run2 (argc, argv,
342 binaryName, binaryHelp,
349 /* end of program.c */