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.c418
1 files changed, 0 insertions, 418 deletions
diff --git a/src/util/program.c b/src/util/program.c
deleted file mode 100644
index fb7929b98..000000000
--- a/src/util/program.c
+++ /dev/null
@@ -1,418 +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,
93 NULL);
94 GNUNET_RESOLVER_connect (cc->cfg);
95 cc->task (cc->task_cls,
96 cc->args,
97 cc->cfgfile,
98 cc->cfg);
99}
100
101
102/**
103 * Compare function for 'qsort' to sort command-line arguments by the
104 * short option.
105 *
106 * @param a1 first command line option
107 * @param a2 second command line option
108 */
109static int
110cmd_sorter (const void *a1,
111 const void *a2)
112{
113 const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
114 const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
115
116 if (toupper ((unsigned char) c1->shortName) >
117 toupper ((unsigned char) c2->shortName))
118 return 1;
119 if (toupper ((unsigned char) c1->shortName) <
120 toupper ((unsigned char) c2->shortName))
121 return -1;
122 if (c1->shortName > c2->shortName)
123 return 1;
124 if (c1->shortName < c2->shortName)
125 return -1;
126 return 0;
127}
128
129
130enum GNUNET_GenericReturnValue
131GNUNET_PROGRAM_run2 (int argc,
132 char *const *argv,
133 const char *binaryName,
134 const char *binaryHelp,
135 const struct GNUNET_GETOPT_CommandLineOption *options,
136 GNUNET_PROGRAM_Main task,
137 void *task_cls,
138 int run_without_scheduler)
139{
140 struct CommandContext cc;
141
142#if ENABLE_NLS
143 char *path;
144#endif
145 char *loglev;
146 char *logfile;
147 char *cfg_fn;
148 enum GNUNET_GenericReturnValue ret;
149 int iret;
150 unsigned int cnt;
151 unsigned long long skew_offset;
152 unsigned long long skew_variance;
153 long long clock_offset;
154 struct GNUNET_CONFIGURATION_Handle *cfg;
155 const struct GNUNET_OS_ProjectData *pd = GNUNET_OS_project_data_get ();
156 const struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
157 GNUNET_GETOPT_option_cfgfile (&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 (pd->version)
162 };
163 unsigned int deflen = sizeof(defoptions) / sizeof(defoptions[0]);
164 struct GNUNET_GETOPT_CommandLineOption *allopts;
165 const char *gargs;
166 char *lpfx;
167 char *spc;
168
169 logfile = NULL;
170 gargs = getenv ("GNUNET_ARGS");
171 if (NULL != gargs)
172 {
173 char **gargv;
174 unsigned int gargc;
175 char *cargs;
176
177 gargv = NULL;
178 gargc = 0;
179 for (int i = 0; i < argc; i++)
180 GNUNET_array_append (gargv,
181 gargc,
182 GNUNET_strdup (argv[i]));
183 cargs = GNUNET_strdup (gargs);
184 for (char *tok = strtok (cargs, " ");
185 NULL != tok;
186 tok = strtok (NULL, " "))
187 GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
188 GNUNET_free (cargs);
189 GNUNET_array_append (gargv, gargc, NULL);
190 argv = (char *const *) gargv;
191 argc = gargc - 1;
192 }
193 memset (&cc, 0, sizeof(cc));
194 loglev = NULL;
195 cc.task = task;
196 cc.task_cls = task_cls;
197 cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
198 /* prepare */
199#if ENABLE_NLS
200 if (NULL != pd->gettext_domain)
201 {
202 setlocale (LC_ALL, "");
203 path = (NULL == pd->gettext_path)
204 ? GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR)
205 : GNUNET_strdup (pd->gettext_path);
206 if (NULL != path)
207 {
208 bindtextdomain (pd->gettext_domain, path);
209 GNUNET_free (path);
210 }
211 textdomain (pd->gettext_domain);
212 }
213#endif
214 cnt = 0;
215 while (NULL != options[cnt].name)
216 cnt++;
217 allopts = GNUNET_new_array (cnt + deflen + 1,
218 struct GNUNET_GETOPT_CommandLineOption);
219 GNUNET_memcpy (allopts,
220 options,
221 cnt * sizeof(struct GNUNET_GETOPT_CommandLineOption));
222 {
223 unsigned int xtra = 0;
224
225 for (unsigned int i = 0;
226 i<sizeof (defoptions) / sizeof(struct GNUNET_GETOPT_CommandLineOption);
227 i++)
228 {
229 bool found = false;
230
231 for (unsigned int j = 0; j<cnt; j++)
232 {
233 found |= ( (options[j].shortName == defoptions[i].shortName) &&
234 (0 != options[j].shortName) );
235 found |= ( (NULL != options[j].name) &&
236 (NULL != defoptions[i].name) &&
237 (0 == strcmp (options[j].name,
238 defoptions[i].name)) );
239 if (found)
240 break;
241 }
242 if (found)
243 continue;
244 GNUNET_memcpy (&allopts[cnt + xtra],
245 &defoptions[i],
246 sizeof (struct GNUNET_GETOPT_CommandLineOption));
247 xtra++;
248 }
249 cnt += xtra;
250 }
251 qsort (allopts,
252 cnt,
253 sizeof(struct GNUNET_GETOPT_CommandLineOption),
254 &cmd_sorter);
255 loglev = NULL;
256 if ((NULL != pd->config_file) && (NULL != pd->user_config_file))
257 cfg_fn = GNUNET_CONFIGURATION_default_filename ();
258 else
259 cfg_fn = NULL;
260 lpfx = GNUNET_strdup (binaryName);
261 if (NULL != (spc = strstr (lpfx, " ")))
262 *spc = '\0';
263 iret = GNUNET_GETOPT_run (binaryName,
264 allopts,
265 (unsigned int) argc,
266 argv);
267 if ((GNUNET_OK > iret) ||
268 (GNUNET_OK != GNUNET_log_setup (lpfx,
269 loglev,
270 logfile)))
271 {
272 GNUNET_free (allopts);
273 GNUNET_free (lpfx);
274 ret = (enum GNUNET_GenericReturnValue) iret;
275 goto cleanup;
276 }
277 if (NULL != cc.cfgfile)
278 {
279 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
280 "Loading configuration from entry point specified as option (%s)\n",
281 cc.cfgfile);
282 if (GNUNET_YES !=
283 GNUNET_DISK_file_test (cc.cfgfile))
284 {
285 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
286 _ ("Unreadable configuration file `%s', exiting ...\n"),
287 cc.cfgfile);
288 ret = GNUNET_SYSERR;
289 GNUNET_free (allopts);
290 GNUNET_free (lpfx);
291 goto cleanup;
292 }
293 if (GNUNET_SYSERR ==
294 GNUNET_CONFIGURATION_load (cfg,
295 cc.cfgfile))
296 {
297 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
298 _ ("Malformed configuration file `%s', exiting ...\n"),
299 cc.cfgfile);
300 ret = GNUNET_SYSERR;
301 GNUNET_free (allopts);
302 GNUNET_free (lpfx);
303 goto cleanup;
304 }
305 }
306 else
307 {
308 if ( (NULL != cfg_fn) &&
309 (GNUNET_YES !=
310 GNUNET_DISK_file_test (cfg_fn)) )
311 {
312 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
313 _ ("Unreadable configuration file `%s'. Exiting ...\n"),
314 cfg_fn);
315 ret = GNUNET_SYSERR;
316 GNUNET_free (allopts);
317 GNUNET_free (lpfx);
318 goto cleanup;
319 }
320 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
321 "Loading configuration from entry point `%s'\n",
322 cc.cfgfile);
323 if (GNUNET_SYSERR ==
324 GNUNET_CONFIGURATION_load (cfg,
325 cfg_fn))
326 {
327 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
328 _ ("Malformed configuration. Exiting ...\n"));
329 ret = GNUNET_SYSERR;
330 GNUNET_free (allopts);
331 GNUNET_free (lpfx);
332 goto cleanup;
333 }
334 }
335 GNUNET_free (allopts);
336 GNUNET_free (lpfx);
337 if ((GNUNET_OK ==
338 GNUNET_CONFIGURATION_get_value_number (cc.cfg,
339 "testing",
340 "skew_offset",
341 &skew_offset)) &&
342 (GNUNET_OK ==
343 GNUNET_CONFIGURATION_get_value_number (cc.cfg,
344 "testing",
345 "skew_variance",
346 &skew_variance)))
347 {
348 clock_offset = skew_offset - skew_variance;
349 GNUNET_TIME_set_offset (clock_offset);
350 }
351 /* ARM needs to know which configuration file to use when starting
352 services. If we got a command-line option *and* if nothing is
353 specified in the configuration, remember the command-line option
354 in "cfg". This is typically really only having an effect if we
355 are running code in src/arm/, as obviously the rest of the code
356 has little business with ARM-specific options. */
357 if (GNUNET_YES !=
358 GNUNET_CONFIGURATION_have_value (cfg,
359 "arm",
360 "CONFIG"))
361 {
362 if (NULL != cc.cfgfile)
363 GNUNET_CONFIGURATION_set_value_string (cfg,
364 "arm",
365 "CONFIG",
366 cc.cfgfile);
367 else if (NULL != cfg_fn)
368 GNUNET_CONFIGURATION_set_value_string (cfg,
369 "arm",
370 "CONFIG",
371 cfg_fn);
372 }
373
374 /* run */
375 cc.args = &argv[iret];
376 if ((NULL == cc.cfgfile) && (NULL != cfg_fn))
377 cc.cfgfile = GNUNET_strdup (cfg_fn);
378 if (GNUNET_NO == run_without_scheduler)
379 {
380 GNUNET_SCHEDULER_run (&program_main, &cc);
381 }
382 else
383 {
384 GNUNET_RESOLVER_connect (cc.cfg);
385 cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
386 }
387 ret = GNUNET_OK;
388cleanup:
389 GNUNET_CONFIGURATION_destroy (cfg);
390 GNUNET_free (cc.cfgfile);
391 GNUNET_free (cfg_fn);
392 GNUNET_free (loglev);
393 GNUNET_free (logfile);
394 return ret;
395}
396
397
398enum GNUNET_GenericReturnValue
399GNUNET_PROGRAM_run (int argc,
400 char *const *argv,
401 const char *binaryName,
402 const char *binaryHelp,
403 const struct GNUNET_GETOPT_CommandLineOption *options,
404 GNUNET_PROGRAM_Main task,
405 void *task_cls)
406{
407 return GNUNET_PROGRAM_run2 (argc,
408 argv,
409 binaryName,
410 binaryHelp,
411 options,
412 task,
413 task_cls,
414 GNUNET_NO);
415}
416
417
418/* end of program.c */
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-24 10:40:29 +0000