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 2, 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 PURPOSE. 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_common.h"
29 #include "gnunet_configuration_lib.h"
30 #include "gnunet_crypto_lib.h"
31 #include "gnunet_directories.h"
32 #include "gnunet_getopt_lib.h"
33 #include "gnunet_os_lib.h"
34 #include "gnunet_program_lib.h"
35 #include "gnunet_resolver_service.h"
36 #include "gnunet_scheduler_lib.h"
39 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
41 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
44 * Context for the command.
54 * Name of the configuration file used, can be NULL!
59 * Main function to run.
61 GNUNET_PROGRAM_Main task;
69 * Configuration to use.
71 const struct GNUNET_CONFIGURATION_Handle *cfg;
76 GNUNET_SPEEDUP_start_ (const struct GNUNET_CONFIGURATION_Handle *cfg);
79 GNUNET_SPEEDUP_stop_ (void);
82 * Initial task called by the scheduler for each
83 * program. Runs the program-specific main task.
86 program_main (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
88 struct CommandContext *cc = cls;
89 GNUNET_SPEEDUP_start_(cc->cfg);
91 GNUNET_RESOLVER_connect (cc->cfg);
92 cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
97 * Compare function for 'qsort' to sort command-line arguments by the
100 * @param a1 first command line option
101 * @param a2 second command line option
104 cmd_sorter (const void *a1, const void *a2)
106 const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
107 const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
109 if (toupper ((unsigned char) c1->shortName) >
110 toupper ((unsigned char) c2->shortName))
112 if (toupper ((unsigned char) c1->shortName) <
113 toupper ((unsigned char) c2->shortName))
115 if (c1->shortName > c2->shortName)
117 if (c1->shortName < c2->shortName)
124 * Run a standard GNUnet command startup sequence (initialize loggers
125 * and configuration, parse options).
127 * @param argc number of command line arguments
128 * @param argv command line arguments
129 * @param binaryName our expected name
130 * @param binaryHelp help text for the program
131 * @param options command line options
132 * @param task main function to run
133 * @param task_cls closure for task
134 * @param run_without_scheduler GNUNET_NO start the scheduler, GNUNET_YES do not
135 * start the scheduler just run the main task
136 * @return GNUNET_SYSERR on error, GNUNET_OK on success
139 GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName,
140 const char *binaryHelp,
141 const struct GNUNET_GETOPT_CommandLineOption *options,
142 GNUNET_PROGRAM_Main task, void *task_cls,
143 int run_without_scheduler)
145 struct CommandContext cc;
151 unsigned long long skew_offset;
152 unsigned long long skew_variance;
153 long long clock_offset;
154 struct GNUNET_CONFIGURATION_Handle *cfg;
156 struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
157 GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
158 GNUNET_GETOPT_OPTION_HELP (binaryHelp),
159 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
160 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
161 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION)
163 struct GNUNET_GETOPT_CommandLineOption *allopts;
169 gargs = getenv ("GNUNET_ARGS");
180 for (i = 0; i < argc; i++)
181 GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
182 cargs = GNUNET_strdup (gargs);
183 tok = strtok (cargs, " ");
186 GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
187 tok = strtok (NULL, " ");
190 GNUNET_array_append (gargv, gargc, NULL);
191 argv = (char *const *) gargv;
194 memset (&cc, 0, sizeof (cc));
197 cc.task_cls = task_cls;
198 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 cc.cfgfile = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
228 lpfx = GNUNET_strdup (binaryName);
229 if (NULL != (spc = strstr (lpfx, " ")))
233 GNUNET_GETOPT_run (binaryName, allopts, (unsigned int) argc, argv))) ||
234 (GNUNET_OK != GNUNET_log_setup (lpfx, loglev, logfile)))
236 GNUNET_CONFIGURATION_destroy (cfg);
237 GNUNET_free_non_null (cc.cfgfile);
238 GNUNET_free_non_null (loglev);
239 GNUNET_free_non_null (logfile);
240 GNUNET_free (allopts);
242 return GNUNET_SYSERR;
244 (void) GNUNET_CONFIGURATION_load (cfg, cc.cfgfile);
245 GNUNET_free (allopts);
248 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing", "skew_offset",
251 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing",
252 "skew_variance", &skew_variance)))
254 clock_offset = skew_offset - skew_variance;
255 GNUNET_TIME_set_offset (clock_offset);
258 cc.args = &argv[ret];
259 if (GNUNET_NO == run_without_scheduler)
261 GNUNET_SCHEDULER_run (&program_main, &cc);
265 GNUNET_RESOLVER_connect (cc.cfg);
266 cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
269 GNUNET_SPEEDUP_stop_ ();
270 GNUNET_CONFIGURATION_destroy (cfg);
271 GNUNET_free_non_null (cc.cfgfile);
272 GNUNET_free_non_null (loglev);
273 GNUNET_free_non_null (logfile);
278 * Run a standard GNUnet command startup sequence (initialize loggers
279 * and configuration, parse options).
281 * @param argc number of command line arguments
282 * @param argv command line arguments
283 * @param binaryName our expected name
284 * @param binaryHelp help text for the program
285 * @param options command line options
286 * @param task main function to run
287 * @param task_cls closure for task
288 * @return GNUNET_SYSERR on error, GNUNET_OK on success
291 GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName,
292 const char *binaryHelp,
293 const struct GNUNET_GETOPT_CommandLineOption *options,
294 GNUNET_PROGRAM_Main task, void *task_cls)
296 return GNUNET_PROGRAM_run2 (argc, argv, binaryName, binaryHelp, options, task, task_cls, GNUNET_NO);
301 /* end of program.c */