2 This file is part of GNUnet.
3 (C) 2009 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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, 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_directories.h"
33 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
35 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
38 * Context for the command.
48 * Name of the configuration file used, can be NULL!
53 * Main function to run.
55 GNUNET_PROGRAM_Main task;
63 * Configuration to use.
65 const struct GNUNET_CONFIGURATION_Handle *cfg;
70 GNUNET_SPEEDUP_start_ (const struct GNUNET_CONFIGURATION_Handle *cfg);
73 GNUNET_SPEEDUP_stop_ (void);
77 * Initial task called by the scheduler for each
78 * program. Runs the program-specific main task.
81 program_main (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
83 struct CommandContext *cc = cls;
85 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
87 GNUNET_SPEEDUP_start_(cc->cfg);
88 GNUNET_RESOLVER_connect (cc->cfg);
89 cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
94 * Compare function for 'qsort' to sort command-line arguments by the
97 * @param a1 first command line option
98 * @param a2 second command line option
101 cmd_sorter (const void *a1, const void *a2)
103 const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
104 const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
106 if (toupper ((unsigned char) c1->shortName) >
107 toupper ((unsigned char) c2->shortName))
109 if (toupper ((unsigned char) c1->shortName) <
110 toupper ((unsigned char) c2->shortName))
112 if (c1->shortName > c2->shortName)
114 if (c1->shortName < c2->shortName)
121 * Run a standard GNUnet command startup sequence (initialize loggers
122 * and configuration, parse options).
124 * @param argc number of command line arguments
125 * @param argv command line arguments
126 * @param binaryName our expected name
127 * @param binaryHelp help text for the program
128 * @param options command line options
129 * @param task main function to run
130 * @param task_cls closure for task
131 * @param run_without_scheduler GNUNET_NO start the scheduler, GNUNET_YES do not
132 * start the scheduler just run the main task
133 * @return GNUNET_SYSERR on error, GNUNET_OK on success
136 GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName,
137 const char *binaryHelp,
138 const struct GNUNET_GETOPT_CommandLineOption *options,
139 GNUNET_PROGRAM_Main task, void *task_cls,
140 int run_without_scheduler)
142 struct CommandContext cc;
152 unsigned long long skew_offset;
153 unsigned long long skew_variance;
154 long long clock_offset;
155 struct GNUNET_CONFIGURATION_Handle *cfg;
157 struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
158 GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
159 GNUNET_GETOPT_OPTION_HELP (binaryHelp),
160 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
161 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
162 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION " " VCS_VERSION)
164 struct GNUNET_GETOPT_CommandLineOption *allopts;
170 gargs = getenv ("GNUNET_ARGS");
181 for (i = 0; i < argc; i++)
182 GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
183 cargs = GNUNET_strdup (gargs);
184 tok = strtok (cargs, " ");
187 GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
188 tok = strtok (NULL, " ");
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 (options[cnt].name != NULL)
215 GNUNET_malloc ((cnt +
216 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
217 sizeof (defoptions));
218 memcpy (allopts, defoptions, sizeof (defoptions));
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,
235 cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_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_CONFIGURATION_destroy (cfg);
244 GNUNET_free_non_null (cc.cfgfile);
245 GNUNET_free_non_null (loglev);
246 GNUNET_free_non_null (logfile);
247 GNUNET_free (allopts);
249 return (ret == GNUNET_SYSERR) ? GNUNET_SYSERR : GNUNET_OK;
251 if (NULL == cc.cfgfile)
252 cc.cfgfile = GNUNET_strdup (cfg_fn);
254 GNUNET_DISK_file_test (cc.cfgfile))
255 (void) GNUNET_CONFIGURATION_load (cfg, cc.cfgfile);
258 (void) GNUNET_CONFIGURATION_load (cfg, NULL);
259 if (0 != strcmp (cc.cfgfile, cfg_fn))
260 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
261 _("Could not access configuration file `%s'\n"),
264 GNUNET_free (allopts);
267 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing", "skew_offset",
270 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing",
271 "skew_variance", &skew_variance)))
273 clock_offset = skew_offset - skew_variance;
274 GNUNET_TIME_set_offset (clock_offset);
277 cc.args = &argv[ret];
278 if (GNUNET_NO == run_without_scheduler)
280 GNUNET_SCHEDULER_run (&program_main, &cc);
284 GNUNET_RESOLVER_connect (cc.cfg);
285 cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
288 GNUNET_SPEEDUP_stop_ ();
289 GNUNET_CONFIGURATION_destroy (cfg);
290 GNUNET_free (cc.cfgfile);
291 GNUNET_free (cfg_fn);
292 GNUNET_free_non_null (loglev);
293 GNUNET_free_non_null (logfile);
298 * Run a standard GNUnet command startup sequence (initialize loggers
299 * and configuration, parse options).
301 * @param argc number of command line arguments
302 * @param argv command line arguments
303 * @param binaryName our expected name
304 * @param binaryHelp help text for the program
305 * @param options command line options
306 * @param task main function to run
307 * @param task_cls closure for @a task
308 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
311 GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName,
312 const char *binaryHelp,
313 const struct GNUNET_GETOPT_CommandLineOption *options,
314 GNUNET_PROGRAM_Main task, void *task_cls)
316 return GNUNET_PROGRAM_run2 (argc, argv, binaryName, binaryHelp, options, task, task_cls, GNUNET_NO);
321 /* end of program.c */