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_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);
83 * Initial task called by the scheduler for each
84 * program. Runs the program-specific main task.
87 program_main (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
89 struct CommandContext *cc = cls;
91 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
93 GNUNET_SPEEDUP_start_(cc->cfg);
94 GNUNET_RESOLVER_connect (cc->cfg);
95 cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
100 * Compare function for 'qsort' to sort command-line arguments by the
103 * @param a1 first command line option
104 * @param a2 second command line option
107 cmd_sorter (const void *a1, const void *a2)
109 const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
110 const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
112 if (toupper ((unsigned char) c1->shortName) >
113 toupper ((unsigned char) c2->shortName))
115 if (toupper ((unsigned char) c1->shortName) <
116 toupper ((unsigned char) c2->shortName))
118 if (c1->shortName > c2->shortName)
120 if (c1->shortName < c2->shortName)
127 * Run a standard GNUnet command startup sequence (initialize loggers
128 * and configuration, parse options).
130 * @param argc number of command line arguments
131 * @param argv command line arguments
132 * @param binaryName our expected name
133 * @param binaryHelp help text for the program
134 * @param options command line options
135 * @param task main function to run
136 * @param task_cls closure for task
137 * @param run_without_scheduler GNUNET_NO start the scheduler, GNUNET_YES do not
138 * start the scheduler just run the main task
139 * @return GNUNET_SYSERR on error, GNUNET_OK on success
142 GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName,
143 const char *binaryHelp,
144 const struct GNUNET_GETOPT_CommandLineOption *options,
145 GNUNET_PROGRAM_Main task, void *task_cls,
146 int run_without_scheduler)
148 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_CFG_FILE (&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 tok = strtok (cargs, " ");
191 GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
192 tok = strtok (NULL, " ");
195 GNUNET_array_append (gargv, gargc, NULL);
196 argv = (char *const *) gargv;
199 memset (&cc, 0, sizeof (cc));
202 cc.task_cls = task_cls;
203 cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
207 setlocale (LC_ALL, "");
208 path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
211 BINDTEXTDOMAIN ("GNUnet", path);
214 textdomain ("GNUnet");
217 while (options[cnt].name != NULL)
220 GNUNET_malloc ((cnt +
221 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
222 sizeof (defoptions));
223 memcpy (allopts, defoptions, sizeof (defoptions));
225 [sizeof (defoptions) /
226 sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
227 (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
228 cnt += sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
229 qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
232 cc.cfgfile = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
233 lpfx = GNUNET_strdup (binaryName);
234 if (NULL != (spc = strstr (lpfx, " ")))
236 ret = GNUNET_GETOPT_run (binaryName, allopts, (unsigned int) argc, argv);
237 if ((GNUNET_OK > ret) ||
238 (GNUNET_OK != GNUNET_log_setup (lpfx, loglev, logfile)))
240 GNUNET_CONFIGURATION_destroy (cfg);
241 GNUNET_free_non_null (cc.cfgfile);
242 GNUNET_free_non_null (loglev);
243 GNUNET_free_non_null (logfile);
244 GNUNET_free (allopts);
246 return (ret == GNUNET_SYSERR) ? GNUNET_SYSERR : GNUNET_OK;
249 GNUNET_DISK_file_test (cc.cfgfile))
250 (void) GNUNET_CONFIGURATION_load (cfg, cc.cfgfile);
253 (void) GNUNET_CONFIGURATION_load (cfg, NULL);
254 if (0 != strcmp (cc.cfgfile, GNUNET_DEFAULT_USER_CONFIG_FILE))
255 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
256 _("Could not access configuration file `%s'\n"),
259 GNUNET_free (allopts);
262 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing", "skew_offset",
265 GNUNET_CONFIGURATION_get_value_number (cc.cfg, "testing",
266 "skew_variance", &skew_variance)))
268 clock_offset = skew_offset - skew_variance;
269 GNUNET_TIME_set_offset (clock_offset);
272 cc.args = &argv[ret];
273 if (GNUNET_NO == run_without_scheduler)
275 GNUNET_SCHEDULER_run (&program_main, &cc);
279 GNUNET_RESOLVER_connect (cc.cfg);
280 cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
283 GNUNET_SPEEDUP_stop_ ();
284 GNUNET_CONFIGURATION_destroy (cfg);
285 GNUNET_free_non_null (cc.cfgfile);
286 GNUNET_free_non_null (loglev);
287 GNUNET_free_non_null (logfile);
292 * Run a standard GNUnet command startup sequence (initialize loggers
293 * and configuration, parse options).
295 * @param argc number of command line arguments
296 * @param argv command line arguments
297 * @param binaryName our expected name
298 * @param binaryHelp help text for the program
299 * @param options command line options
300 * @param task main function to run
301 * @param task_cls closure for task
302 * @return GNUNET_SYSERR on error, GNUNET_OK on success
305 GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName,
306 const char *binaryHelp,
307 const struct GNUNET_GETOPT_CommandLineOption *options,
308 GNUNET_PROGRAM_Main task, void *task_cls)
310 return GNUNET_PROGRAM_run2 (argc, argv, binaryName, binaryHelp, options, task, task_cls, GNUNET_NO);
315 /* end of program.c */