aboutsummaryrefslogtreecommitdiff
path: root/src/util/program.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/util/program.c')
-rw-r--r--src/util/program.c383
1 files changed, 0 insertions, 383 deletions
diff --git a/src/util/program.c b/src/util/program.c
deleted file mode 100644
index b9da14572..000000000
--- a/src/util/program.c
+++ /dev/null
@@ -1,383 +0,0 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2009-2013 GNUnet e.V.
4
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.
9
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.
14
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/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
19 */
20
21/**
22 * @file util/program.c
23 * @brief standard code for GNUnet startup and shutdown
24 * @author Christian Grothoff
25 */
26
27#include "platform.h"
28#include "gnunet_util_lib.h"
29#include "gnunet_resolver_service.h"
30#include "gnunet_constants.h"
31#include "speedup.h"
32#include <gcrypt.h>
33
34#define LOG(kind, ...) GNUNET_log_from (kind, "util-program", __VA_ARGS__)
35
36#define LOG_STRERROR_FILE(kind, syscall, filename) \
37 GNUNET_log_from_strerror_file (kind, "util-program", syscall, filename)
38
39/**
40 * Context for the command.
41 */
42struct CommandContext
43{
44 /**
45 * Argv argument.
46 */
47 char *const *args;
48
49 /**
50 * Name of the configuration file used, can be NULL!
51 */
52 char *cfgfile;
53
54 /**
55 * Main function to run.
56 */
57 GNUNET_PROGRAM_Main task;
58
59 /**
60 * Closure for @e task.
61 */
62 void *task_cls;
63
64 /**
65 * Configuration to use.
66 */
67 const struct GNUNET_CONFIGURATION_Handle *cfg;
68};
69
70
71/**
72 * task run when the scheduler shuts down
73 */
74static void
75shutdown_task (void *cls)
76{
77 (void) cls;
78 GNUNET_SPEEDUP_stop_ ();
79}
80
81
82/**
83 * Initial task called by the scheduler for each
84 * program. Runs the program-specific main task.
85 */
86static void
87program_main (void *cls)
88{
89 struct CommandContext *cc = cls;
90
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);
95}
96
97
98/**
99 * Compare function for 'qsort' to sort command-line arguments by the
100 * short option.
101 *
102 * @param a1 first command line option
103 * @param a2 second command line option
104 */
105static int
106cmd_sorter (const void *a1, const void *a2)
107{
108 const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
109 const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
110
111 if (toupper ((unsigned char) c1->shortName) >
112 toupper ((unsigned char) c2->shortName))
113 return 1;
114 if (toupper ((unsigned char) c1->shortName) <
115 toupper ((unsigned char) c2->shortName))
116 return -1;
117 if (c1->shortName > c2->shortName)
118 return 1;
119 if (c1->shortName < c2->shortName)
120 return -1;
121 return 0;
122}
123
124
125enum GNUNET_GenericReturnValue
126GNUNET_PROGRAM_run2 (int argc,
127 char *const *argv,
128 const char *binaryName,
129 const char *binaryHelp,
130 const struct GNUNET_GETOPT_CommandLineOption *options,
131 GNUNET_PROGRAM_Main task,
132 void *task_cls,
133 int run_without_scheduler)
134{
135 struct CommandContext cc;
136
137#if ENABLE_NLS
138 char *path;
139#endif
140 char *loglev;
141 char *logfile;
142 char *cfg_fn;
143 enum GNUNET_GenericReturnValue ret;
144 int iret;
145 unsigned int cnt;
146 unsigned long long skew_offset;
147 unsigned long long skew_variance;
148 long long clock_offset;
149 struct GNUNET_CONFIGURATION_Handle *cfg;
150 const struct GNUNET_OS_ProjectData *pd = GNUNET_OS_project_data_get ();
151 struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
152 GNUNET_GETOPT_option_cfgfile (&cc.cfgfile),
153 GNUNET_GETOPT_option_help (binaryHelp),
154 GNUNET_GETOPT_option_loglevel (&loglev),
155 GNUNET_GETOPT_option_logfile (&logfile),
156 GNUNET_GETOPT_option_version (pd->version)
157 };
158 struct GNUNET_GETOPT_CommandLineOption *allopts;
159 const char *gargs;
160 char *lpfx;
161 char *spc;
162
163 logfile = NULL;
164 gargs = getenv ("GNUNET_ARGS");
165 if (NULL != gargs)
166 {
167 char **gargv;
168 unsigned int gargc;
169 char *cargs;
170
171 gargv = NULL;
172 gargc = 0;
173 for (int i = 0; i < argc; i++)
174 GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
175 cargs = GNUNET_strdup (gargs);
176 for (char *tok = strtok (cargs, " "); NULL != tok; tok = strtok (NULL, " "))
177 GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
178 GNUNET_free (cargs);
179 GNUNET_array_append (gargv, gargc, NULL);
180 argv = (char *const *) gargv;
181 argc = gargc - 1;
182 }
183 memset (&cc, 0, sizeof(cc));
184 loglev = NULL;
185 cc.task = task;
186 cc.task_cls = task_cls;
187 cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
188 /* prepare */
189#if ENABLE_NLS
190 if (NULL != pd->gettext_domain)
191 {
192 setlocale (LC_ALL, "");
193 path = (NULL == pd->gettext_path)
194 ? GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR)
195 : GNUNET_strdup (pd->gettext_path);
196 if (NULL != path)
197 {
198 bindtextdomain (pd->gettext_domain, path);
199 GNUNET_free (path);
200 }
201 textdomain (pd->gettext_domain);
202 }
203#endif
204 cnt = 0;
205 while (NULL != options[cnt].name)
206 cnt++;
207 allopts =
208 GNUNET_malloc ((cnt + 1) * sizeof(struct GNUNET_GETOPT_CommandLineOption)
209 + sizeof(defoptions));
210 GNUNET_memcpy (allopts, defoptions, sizeof(defoptions));
211 GNUNET_memcpy (&allopts[sizeof(defoptions)
212 / sizeof(struct GNUNET_GETOPT_CommandLineOption)],
213 options,
214 (cnt + 1) * sizeof(struct GNUNET_GETOPT_CommandLineOption));
215 cnt += sizeof(defoptions) / sizeof(struct GNUNET_GETOPT_CommandLineOption);
216 qsort (allopts,
217 cnt,
218 sizeof(struct GNUNET_GETOPT_CommandLineOption),
219 &cmd_sorter);
220 loglev = NULL;
221 if ((NULL != pd->config_file) && (NULL != pd->user_config_file))
222 cfg_fn = GNUNET_CONFIGURATION_default_filename ();
223 else
224 cfg_fn = NULL;
225 lpfx = GNUNET_strdup (binaryName);
226 if (NULL != (spc = strstr (lpfx, " ")))
227 *spc = '\0';
228 iret = GNUNET_GETOPT_run (binaryName,
229 allopts,
230 (unsigned int) argc,
231 argv);
232 if ((GNUNET_OK > iret) ||
233 (GNUNET_OK != GNUNET_log_setup (lpfx,
234 loglev,
235 logfile)))
236 {
237 GNUNET_free (allopts);
238 GNUNET_free (lpfx);
239 ret = (enum GNUNET_GenericReturnValue) iret;
240 goto cleanup;
241 }
242 if (NULL != cc.cfgfile)
243 {
244 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
245 "Loading configuration from entry point specified as option (%s)\n",
246 cc.cfgfile);
247 if (GNUNET_YES !=
248 GNUNET_DISK_file_test (cc.cfgfile))
249 {
250 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
251 _ ("Unreadable configuration file `%s', exiting ...\n"),
252 cc.cfgfile);
253 ret = GNUNET_SYSERR;
254 GNUNET_free (allopts);
255 GNUNET_free (lpfx);
256 goto cleanup;
257 }
258 if (GNUNET_SYSERR ==
259 GNUNET_CONFIGURATION_load (cfg,
260 cc.cfgfile))
261 {
262 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
263 _ ("Malformed configuration file `%s', exiting ...\n"),
264 cc.cfgfile);
265 ret = GNUNET_SYSERR;
266 GNUNET_free (allopts);
267 GNUNET_free (lpfx);
268 goto cleanup;
269 }
270 }
271 else
272 {
273 if ( (NULL != cfg_fn) &&
274 (GNUNET_YES !=
275 GNUNET_DISK_file_test (cfg_fn)) )
276 {
277 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
278 _ ("Unreadable configuration file `%s'. Exiting ...\n"),
279 cfg_fn);
280 ret = GNUNET_SYSERR;
281 GNUNET_free (allopts);
282 GNUNET_free (lpfx);
283 goto cleanup;
284 }
285 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
286 "Loading configuration from entry point `%s'\n",
287 cc.cfgfile);
288 if (GNUNET_SYSERR ==
289 GNUNET_CONFIGURATION_load (cfg,
290 cfg_fn))
291 {
292 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
293 _ ("Malformed configuration. Exiting ...\n"));
294 ret = GNUNET_SYSERR;
295 GNUNET_free (allopts);
296 GNUNET_free (lpfx);
297 goto cleanup;
298 }
299 }
300 GNUNET_free (allopts);
301 GNUNET_free (lpfx);
302 if ((GNUNET_OK ==
303 GNUNET_CONFIGURATION_get_value_number (cc.cfg,
304 "testing",
305 "skew_offset",
306 &skew_offset)) &&
307 (GNUNET_OK ==
308 GNUNET_CONFIGURATION_get_value_number (cc.cfg,
309 "testing",
310 "skew_variance",
311 &skew_variance)))
312 {
313 clock_offset = skew_offset - skew_variance;
314 GNUNET_TIME_set_offset (clock_offset);
315 }
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. */
322 if (GNUNET_YES !=
323 GNUNET_CONFIGURATION_have_value (cfg,
324 "arm",
325 "CONFIG"))
326 {
327 if (NULL != cc.cfgfile)
328 GNUNET_CONFIGURATION_set_value_string (cfg,
329 "arm",
330 "CONFIG",
331 cc.cfgfile);
332 else if (NULL != cfg_fn)
333 GNUNET_CONFIGURATION_set_value_string (cfg,
334 "arm",
335 "CONFIG",
336 cfg_fn);
337 }
338
339 /* run */
340 cc.args = &argv[iret];
341 if ((NULL == cc.cfgfile) && (NULL != cfg_fn))
342 cc.cfgfile = GNUNET_strdup (cfg_fn);
343 if (GNUNET_NO == run_without_scheduler)
344 {
345 GNUNET_SCHEDULER_run (&program_main, &cc);
346 }
347 else
348 {
349 GNUNET_RESOLVER_connect (cc.cfg);
350 cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
351 }
352 ret = GNUNET_OK;
353cleanup:
354 GNUNET_CONFIGURATION_destroy (cfg);
355 GNUNET_free (cc.cfgfile);
356 GNUNET_free (cfg_fn);
357 GNUNET_free (loglev);
358 GNUNET_free (logfile);
359 return ret;
360}
361
362
363enum GNUNET_GenericReturnValue
364GNUNET_PROGRAM_run (int argc,
365 char *const *argv,
366 const char *binaryName,
367 const char *binaryHelp,
368 const struct GNUNET_GETOPT_CommandLineOption *options,
369 GNUNET_PROGRAM_Main task,
370 void *task_cls)
371{
372 return GNUNET_PROGRAM_run2 (argc,
373 argv,
374 binaryName,
375 binaryHelp,
376 options,
377 task,
378 task_cls,
379 GNUNET_NO);
380}
381
382
383/* end of program.c */