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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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) \
37 GNUNET_log_from_strerror_file (kind, "util-program", syscall, filename)
40 * Context for the command.
50 * Name of the configuration file used, can be NULL!
55 * Main function to run.
57 GNUNET_PROGRAM_Main task;
60 * Closure for @e task.
65 * Configuration to use.
67 const struct GNUNET_CONFIGURATION_Handle *cfg;
72 * task run when the scheduler shuts down
75 shutdown_task (void *cls)
78 GNUNET_SPEEDUP_stop_ ();
83 * Initial task called by the scheduler for each
84 * program. Runs the program-specific main task.
87 program_main (void *cls)
89 struct CommandContext *cc = cls;
91 GNUNET_SPEEDUP_start_ (cc->cfg);
92 GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
93 GNUNET_RESOLVER_connect (cc->cfg);
94 cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
99 * Compare function for 'qsort' to sort command-line arguments by the
102 * @param a1 first command line option
103 * @param a2 second command line option
106 cmd_sorter (const void *a1, const void *a2)
108 const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
109 const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
111 if (toupper ((unsigned char) c1->shortName) >
112 toupper ((unsigned char) c2->shortName))
114 if (toupper ((unsigned char) c1->shortName) <
115 toupper ((unsigned char) c2->shortName))
117 if (c1->shortName > c2->shortName)
119 if (c1->shortName < c2->shortName)
126 * Run a standard GNUnet command startup sequence (initialize loggers
127 * and configuration, parse options).
129 * @param argc number of command line arguments in @a argv
130 * @param argv command line arguments
131 * @param binaryName our expected name
132 * @param binaryHelp help text for the program
133 * @param options command line options
134 * @param task main function to run
135 * @param task_cls closure for @a task
136 * @param run_without_scheduler #GNUNET_NO start the scheduler, #GNUNET_YES do not
137 * start the scheduler just run the main task
138 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
141 GNUNET_PROGRAM_run2 (int argc,
143 const char *binaryName,
144 const char *binaryHelp,
145 const struct GNUNET_GETOPT_CommandLineOption *options,
146 GNUNET_PROGRAM_Main task,
148 int run_without_scheduler)
150 struct CommandContext cc;
161 unsigned long long skew_offset;
162 unsigned long long skew_variance;
163 long long clock_offset;
164 struct GNUNET_CONFIGURATION_Handle *cfg;
165 const struct GNUNET_OS_ProjectData *pd = GNUNET_OS_project_data_get ();
166 struct GNUNET_GETOPT_CommandLineOption defoptions[] =
167 { GNUNET_GETOPT_option_cfgfile (&cc.cfgfile),
168 GNUNET_GETOPT_option_help (binaryHelp),
169 GNUNET_GETOPT_option_loglevel (&loglev),
170 GNUNET_GETOPT_option_logfile (&logfile),
171 GNUNET_GETOPT_option_version (pd->version) };
172 struct GNUNET_GETOPT_CommandLineOption *allopts;
178 gargs = getenv ("GNUNET_ARGS");
187 for (int i = 0; i < argc; i++)
188 GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
189 cargs = GNUNET_strdup (gargs);
190 for (char *tok = strtok (cargs, " "); NULL != tok; tok = strtok (NULL, " "))
191 GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
193 GNUNET_array_append (gargv, gargc, NULL);
194 argv = (char *const *) gargv;
197 memset (&cc, 0, sizeof(cc));
200 cc.task_cls = task_cls;
201 cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
204 if (NULL != pd->gettext_domain)
206 setlocale (LC_ALL, "");
207 path = (NULL == pd->gettext_path)
208 ? GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR)
209 : GNUNET_strdup (pd->gettext_path);
212 bindtextdomain (pd->gettext_domain, path);
215 textdomain (pd->gettext_domain);
219 while (NULL != options[cnt].name)
222 GNUNET_malloc ((cnt + 1) * sizeof(struct GNUNET_GETOPT_CommandLineOption)
223 + sizeof(defoptions));
224 GNUNET_memcpy (allopts, defoptions, sizeof(defoptions));
225 GNUNET_memcpy (&allopts[sizeof(defoptions)
226 / sizeof(struct GNUNET_GETOPT_CommandLineOption)],
228 (cnt + 1) * sizeof(struct GNUNET_GETOPT_CommandLineOption));
229 cnt += sizeof(defoptions) / sizeof(struct GNUNET_GETOPT_CommandLineOption);
232 sizeof(struct GNUNET_GETOPT_CommandLineOption),
235 xdg = getenv ("XDG_CONFIG_HOME");
237 GNUNET_asprintf (&cfg_fn,
243 cfg_fn = GNUNET_strdup (pd->user_config_file);
244 lpfx = GNUNET_strdup (binaryName);
245 if (NULL != (spc = strstr (lpfx, " ")))
247 ret = GNUNET_GETOPT_run (binaryName, allopts, (unsigned int) argc, argv);
248 if ((GNUNET_OK > ret) ||
249 (GNUNET_OK != GNUNET_log_setup (lpfx, loglev, logfile)))
251 GNUNET_free (allopts);
255 if (NULL != cc.cfgfile)
257 if ((GNUNET_YES != GNUNET_DISK_file_test (cc.cfgfile)) ||
258 (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cc.cfgfile)))
260 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
262 "Unreadable or malformed configuration file `%s', exit ...\n"),
265 GNUNET_free (allopts);
272 if (GNUNET_YES == GNUNET_DISK_file_test (cfg_fn))
274 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cfg_fn))
277 GNUNET_ERROR_TYPE_ERROR,
279 "Unreadable or malformed default configuration file `%s', exit ...\n"),
282 GNUNET_free (allopts);
289 GNUNET_free (cfg_fn);
291 if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, NULL))
293 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
294 _ ("Unreadable or malformed configuration, exit ...\n"));
296 GNUNET_free (allopts);
302 GNUNET_free (allopts);
304 if ((GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cc.cfg,
308 (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cc.cfg,
313 clock_offset = skew_offset - skew_variance;
314 GNUNET_TIME_set_offset (clock_offset);
316 /* ARM needs to know which configuration file to use when starting
317 services. If we got a command-line option *and* if nothing is
318 specified in the configuration, remember the command-line option
319 in "cfg". This is typically really only having an effect if we
320 are running code in src/arm/, as obviously the rest of the code
321 has little business with ARM-specific options. */if (GNUNET_YES != GNUNET_CONFIGURATION_have_value (cfg, "arm", "CONFIG"))
323 if (NULL != cc.cfgfile)
324 GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG", cc.cfgfile);
325 else if (NULL != cfg_fn)
326 GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG", cfg_fn);
330 cc.args = &argv[ret];
331 if ((NULL == cc.cfgfile) && (NULL != cfg_fn))
332 cc.cfgfile = GNUNET_strdup (cfg_fn);
333 if (GNUNET_NO == run_without_scheduler)
335 GNUNET_SCHEDULER_run (&program_main, &cc);
339 GNUNET_RESOLVER_connect (cc.cfg);
340 cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
344 GNUNET_CONFIGURATION_destroy (cfg);
345 GNUNET_free_non_null (cc.cfgfile);
346 GNUNET_free_non_null (cfg_fn);
347 GNUNET_free_non_null (loglev);
348 GNUNET_free_non_null (logfile);
354 * Run a standard GNUnet command startup sequence (initialize loggers
355 * and configuration, parse options).
357 * @param argc number of command line arguments
358 * @param argv command line arguments
359 * @param binaryName our expected name
360 * @param binaryHelp help text for the program
361 * @param options command line options
362 * @param task main function to run
363 * @param task_cls closure for @a task
364 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
367 GNUNET_PROGRAM_run (int argc,
369 const char *binaryName,
370 const char *binaryHelp,
371 const struct GNUNET_GETOPT_CommandLineOption *options,
372 GNUNET_PROGRAM_Main task,
375 return GNUNET_PROGRAM_run2 (argc,
386 /* end of program.c */