2 This file is part of GNUnet.
3 Copyright (C) 2009-2013 GNUnet e.V.
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-program", __VA_ARGS__)
36 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util-program", 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 * task run when the scheduler shuts down
75 shutdown_task (void *cls)
77 GNUNET_SPEEDUP_stop_ ();
82 * Initial task called by the scheduler for each
83 * program. Runs the program-specific main task.
86 program_main (void *cls)
88 struct CommandContext *cc = cls;
90 GNUNET_SPEEDUP_start_(cc->cfg);
91 GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
92 GNUNET_RESOLVER_connect (cc->cfg);
93 cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
98 * Compare function for 'qsort' to sort command-line arguments by the
101 * @param a1 first command line option
102 * @param a2 second command line option
105 cmd_sorter (const void *a1, const void *a2)
107 const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
108 const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
110 if (toupper ((unsigned char) c1->shortName) >
111 toupper ((unsigned char) c2->shortName))
113 if (toupper ((unsigned char) c1->shortName) <
114 toupper ((unsigned char) c2->shortName))
116 if (c1->shortName > c2->shortName)
118 if (c1->shortName < c2->shortName)
125 * Run a standard GNUnet command startup sequence (initialize loggers
126 * and configuration, parse options).
128 * @param argc number of command line arguments in @a argv
129 * @param argv command line arguments
130 * @param binaryName our expected name
131 * @param binaryHelp help text for the program
132 * @param options command line options
133 * @param task main function to run
134 * @param task_cls closure for @a task
135 * @param run_without_scheduler #GNUNET_NO start the scheduler, #GNUNET_YES do not
136 * start the scheduler just run the main task
137 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
140 GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName,
141 const char *binaryHelp,
142 const struct GNUNET_GETOPT_CommandLineOption *options,
143 GNUNET_PROGRAM_Main task, void *task_cls,
144 int run_without_scheduler)
146 struct CommandContext cc;
156 unsigned long long skew_offset;
157 unsigned long long skew_variance;
158 long long clock_offset;
159 struct GNUNET_CONFIGURATION_Handle *cfg;
161 struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
162 GNUNET_GETOPT_option_cfgfile (&cc.cfgfile),
163 GNUNET_GETOPT_option_help (binaryHelp),
164 GNUNET_GETOPT_option_loglevel (&loglev),
165 GNUNET_GETOPT_option_logfile (&logfile),
166 GNUNET_GETOPT_option_version (PACKAGE_VERSION " " VCS_VERSION)
168 struct GNUNET_GETOPT_CommandLineOption *allopts;
174 gargs = getenv ("GNUNET_ARGS");
185 for (i = 0; i < argc; i++)
186 GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
187 cargs = GNUNET_strdup (gargs);
188 for (tok = strtok (cargs, " "); NULL != tok; tok = strtok (NULL, " "))
189 GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
191 GNUNET_array_append (gargv, gargc, NULL);
192 argv = (char *const *) gargv;
195 memset (&cc, 0, sizeof (cc));
198 cc.task_cls = task_cls;
199 cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
202 setlocale (LC_ALL, "");
203 path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
206 BINDTEXTDOMAIN ("GNUnet", path);
209 textdomain ("GNUnet");
212 while (NULL != options[cnt].name)
215 GNUNET_malloc ((cnt +
216 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
217 sizeof (defoptions));
218 GNUNET_memcpy (allopts, defoptions, sizeof (defoptions));
219 GNUNET_memcpy (&allopts
220 [sizeof (defoptions) /
221 sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
222 (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
223 cnt += sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
224 qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
227 xdg = getenv ("XDG_CONFIG_HOME");
229 GNUNET_asprintf (&cfg_fn,
233 GNUNET_OS_project_data_get ()->config_file);
235 cfg_fn = GNUNET_strdup (GNUNET_OS_project_data_get ()->user_config_file);
236 lpfx = GNUNET_strdup (binaryName);
237 if (NULL != (spc = strstr (lpfx, " ")))
239 ret = GNUNET_GETOPT_run (binaryName, allopts, (unsigned int) argc, argv);
240 if ((GNUNET_OK > ret) ||
241 (GNUNET_OK != GNUNET_log_setup (lpfx, loglev, logfile)))
243 GNUNET_free (allopts);
247 if (NULL == cc.cfgfile)
248 cc.cfgfile = GNUNET_strdup (cfg_fn);
250 GNUNET_DISK_file_test (cc.cfgfile))
252 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cc.cfgfile))
254 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
255 _("Malformed configuration file `%s', exit ...\n"),
258 GNUNET_free (allopts);
265 if (0 != strcmp (cc.cfgfile, cfg_fn))
266 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
267 _("Could not access configuration file `%s'\n"),
269 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, NULL))
271 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
272 _("Malformed configuration, exit ...\n"));
274 GNUNET_free (allopts);
279 GNUNET_free (allopts);
282 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing", "skew_offset",
285 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing",
286 "skew_variance", &skew_variance)))
288 clock_offset = skew_offset - skew_variance;
289 GNUNET_TIME_set_offset (clock_offset);
291 /* ARM needs to know which configuration file to use when starting
292 services. If we got a command-line option *and* if nothing is
293 specified in the configuration, remember the command-line option
294 in "cfg". This is typically really only having an effect if we
295 are running code in src/arm/, as obviously the rest of the code
296 has little business with ARM-specific options. */
298 GNUNET_CONFIGURATION_have_value (cfg,
302 GNUNET_CONFIGURATION_set_value_string (cfg,
308 cc.args = &argv[ret];
309 if (GNUNET_NO == run_without_scheduler)
311 GNUNET_SCHEDULER_run (&program_main, &cc);
315 GNUNET_RESOLVER_connect (cc.cfg);
316 cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
320 GNUNET_CONFIGURATION_destroy (cfg);
321 GNUNET_free_non_null (cc.cfgfile);
322 GNUNET_free (cfg_fn);
323 GNUNET_free_non_null (loglev);
324 GNUNET_free_non_null (logfile);
329 * Run a standard GNUnet command startup sequence (initialize loggers
330 * and configuration, parse options).
332 * @param argc number of command line arguments
333 * @param argv command line arguments
334 * @param binaryName our expected name
335 * @param binaryHelp help text for the program
336 * @param options command line options
337 * @param task main function to run
338 * @param task_cls closure for @a task
339 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
342 GNUNET_PROGRAM_run (int argc, char *const *argv,
343 const char *binaryName,
344 const char *binaryHelp,
345 const struct GNUNET_GETOPT_CommandLineOption *options,
346 GNUNET_PROGRAM_Main task,
349 return GNUNET_PROGRAM_run2 (argc, argv,
350 binaryName, binaryHelp,
357 /* end of program.c */