GNUnet  0.11.x
program.c
Go to the documentation of this file.
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 
27 #include "platform.h"
28 #include "gnunet_util_lib.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 
43 {
47  char *const *args;
48 
52  char *cfgfile;
53 
58 
62  void *task_cls;
63 
68 };
69 
70 
74 static void
75 shutdown_task (void *cls)
76 {
77  (void) cls;
79 }
80 
81 
86 static void
87 program_main (void *cls)
88 {
89  struct CommandContext *cc = cls;
90 
94  cc->task (cc->task_cls, cc->args, cc->cfgfile, cc->cfg);
95 }
96 
97 
105 static int
106 cmd_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 
140 int
142  char *const *argv,
143  const char *binaryName,
144  const char *binaryHelp,
147  void *task_cls,
148  int run_without_scheduler)
149 {
150  struct CommandContext cc;
151 
152 #if ENABLE_NLS
153  char *path;
154 #endif
155  char *loglev;
156  char *logfile;
157  char *cfg_fn;
158  const char *xdg;
159  int ret;
160  unsigned int cnt;
161  unsigned long long skew_offset;
162  unsigned long long skew_variance;
163  long long clock_offset;
166  struct GNUNET_GETOPT_CommandLineOption defoptions[] =
168  GNUNET_GETOPT_option_help (binaryHelp),
170  GNUNET_GETOPT_option_logfile (&logfile),
172  struct GNUNET_GETOPT_CommandLineOption *allopts;
173  const char *gargs;
174  char *lpfx;
175  char *spc;
176 
177  logfile = NULL;
178  gargs = getenv ("GNUNET_ARGS");
179  if (NULL != gargs)
180  {
181  char **gargv;
182  unsigned int gargc;
183  char *cargs;
184 
185  gargv = NULL;
186  gargc = 0;
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));
192  GNUNET_free (cargs);
193  GNUNET_array_append (gargv, gargc, NULL);
194  argv = (char *const *) gargv;
195  argc = gargc - 1;
196  }
197  memset (&cc, 0, sizeof(cc));
198  loglev = NULL;
199  cc.task = task;
200  cc.task_cls = task_cls;
201  cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
202  /* prepare */
203 #if ENABLE_NLS
204  if (NULL != pd->gettext_domain)
205  {
206  setlocale (LC_ALL, "");
207  path = (NULL == pd->gettext_path)
209  : GNUNET_strdup (pd->gettext_path);
210  if (NULL != path)
211  {
212  bindtextdomain (pd->gettext_domain, path);
213  GNUNET_free (path);
214  }
216  }
217 #endif
218  cnt = 0;
219  while (NULL != options[cnt].name)
220  cnt++;
221  allopts =
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)],
227  options,
228  (cnt + 1) * sizeof(struct GNUNET_GETOPT_CommandLineOption));
229  cnt += sizeof(defoptions) / sizeof(struct GNUNET_GETOPT_CommandLineOption);
230  qsort (allopts,
231  cnt,
232  sizeof(struct GNUNET_GETOPT_CommandLineOption),
233  &cmd_sorter);
234  loglev = NULL;
235  xdg = getenv ("XDG_CONFIG_HOME");
236  if (NULL != xdg)
237  GNUNET_asprintf (&cfg_fn,
238  "%s%s%s",
239  xdg,
241  pd->config_file);
242  else
243  cfg_fn = GNUNET_strdup (pd->user_config_file);
244  lpfx = GNUNET_strdup (binaryName);
245  if (NULL != (spc = strstr (lpfx, " ")))
246  *spc = '\0';
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)))
250  {
251  GNUNET_free (allopts);
252  GNUNET_free (lpfx);
253  goto cleanup;
254  }
255  if (NULL != cc.cfgfile)
256  {
257  if ((GNUNET_YES != GNUNET_DISK_file_test (cc.cfgfile)) ||
259  {
261  _ (
262  "Unreadable or malformed configuration file `%s', exit ...\n"),
263  cc.cfgfile);
264  ret = GNUNET_SYSERR;
265  GNUNET_free (allopts);
266  GNUNET_free (lpfx);
267  goto cleanup;
268  }
269  }
270  else
271  {
272  if (GNUNET_YES == GNUNET_DISK_file_test (cfg_fn))
273  {
274  if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cfg_fn))
275  {
276  GNUNET_log (
278  _ (
279  "Unreadable or malformed default configuration file `%s', exit ...\n"),
280  cfg_fn);
281  ret = GNUNET_SYSERR;
282  GNUNET_free (allopts);
283  GNUNET_free (lpfx);
284  goto cleanup;
285  }
286  }
287  else
288  {
289  GNUNET_free (cfg_fn);
290  cfg_fn = NULL;
291  if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, NULL))
292  {
294  _ ("Unreadable or malformed configuration, exit ...\n"));
295  ret = GNUNET_SYSERR;
296  GNUNET_free (allopts);
297  GNUNET_free (lpfx);
298  goto cleanup;
299  }
300  }
301  }
302  GNUNET_free (allopts);
303  GNUNET_free (lpfx);
305  "testing",
306  "skew_offset",
307  &skew_offset)) &&
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. */if (GNUNET_YES != GNUNET_CONFIGURATION_have_value (cfg, "arm", "CONFIG"))
322  {
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);
327  }
328 
329  /* run */
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)
334  {
336  }
337  else
338  {
340  cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
341  }
342  ret = GNUNET_OK;
343 cleanup:
346  GNUNET_free_non_null (cfg_fn);
347  GNUNET_free_non_null (loglev);
348  GNUNET_free_non_null (logfile);
349  return ret;
350 }
351 
352 
366 int
368  char *const *argv,
369  const char *binaryName,
370  const char *binaryHelp,
373  void *task_cls)
374 {
375  return GNUNET_PROGRAM_run2 (argc,
376  argv,
377  binaryName,
378  binaryHelp,
379  options,
380  task,
381  task_cls,
382  GNUNET_NO);
383 }
384 
385 
386 /* end of program.c */
int GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory)...
Definition: disk.c:544
Return the directory where translations are installed (share/locale/)
const char * config_file
Configuration file name (in $XDG_CONFIG_HOME) to use.
char * gettext_domain
Gettext domain for localisation, e.g.
Project-specific data used to help the OS subsystem find installation paths.
void(* GNUNET_PROGRAM_Main)(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
Main function that will be run.
int GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
char * gettext_path
Gettext directory, e.g.
Context for the command.
Definition: program.c:42
int GNUNET_PROGRAM_run2(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls, int run_without_scheduler)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:141
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_help(const char *about)
Defining the option to print the command line help text (-h option).
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1300
static void program_main(void *cls)
Initial task called by the scheduler for each program.
Definition: program.c:87
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
void GNUNET_SCHEDULER_run(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Initialize and run scheduler.
Definition: scheduler.c:717
const char * user_config_file
Configuration file name to use (if $XDG_CONFIG_HOME is not set).
#define GNUNET_NO
Definition: gnunet_common.h:78
#define bindtextdomain(Domainname, Dirname)
Definition: gettext.h:57
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
Definition of a command line option.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
void GNUNET_TIME_set_offset(long long offset)
Set the timestamp offset for this instance.
Definition: time.c:53
const char shortName
Short name of the option.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_logfile(char **logfn)
Allow user to specify log file name (-l option)
char *const * args
Argv argument.
Definition: program.c:47
int GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
const char * version
String identifying the current project version.
#define textdomain(Domainname)
Definition: gettext.h:56
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_version(const char *version)
Define the option to print the version of the application (-v option)
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
static void shutdown_task(void *cls)
task run when the scheduler shuts down
Definition: program.c:75
static int cmd_sorter(const void *a1, const void *a2)
Compare function for &#39;qsort&#39; to sort command-line arguments by the short option.
Definition: program.c:106
#define DIR_SEPARATOR_STR
Definition: platform.h:168
int GNUNET_CONFIGURATION_have_value(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Test if we have a value for a particular option.
char * GNUNET_OS_installation_get_path(enum GNUNET_OS_InstallationPathKind dirkind)
Get the path to a specific GNUnet installation directory or, with GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation directory.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
static void cleanup(void *cls)
Function scheduled as very last function, cleans up after us.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_loglevel(char **level)
Define the &#39;-L&#39; log level option.
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
char * cfgfile
Name of the configuration file used, can be NULL!
Definition: program.c:52
int GNUNET_GETOPT_run(const char *binaryOptions, const struct GNUNET_GETOPT_CommandLineOption *allOptions, unsigned int argc, char *const *argv)
Parse the command line.
Definition: getopt.c:892
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
void * task_cls
Closure for task.
Definition: program.c:62
GNUNET_PROGRAM_Main task
Main function to run.
Definition: program.c:57
char * getenv()
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_cfgfile(char **fn)
Allow user to specify configuration file name (-c option)
#define GNUNET_array_append(arr, size, element)
Append an element to a list (growing the list by one).
int GNUNET_SPEEDUP_start_(const struct GNUNET_CONFIGURATION_Handle *cfg)
Start task that may speed up our system clock artificially.
Definition: speedup.c:65
configuration data
Definition: configuration.c:85
const char * name
#define GNUNET_log(kind,...)
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_get(void)
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:367
#define GNUNET_YES
Definition: gnunet_common.h:77
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration to use.
Definition: program.c:67
int GNUNET_log_setup(const char *comp, const char *loglevel, const char *logfile)
Setup logging.
void GNUNET_RESOLVER_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Create the connection to the resolver service.
Definition: resolver_api.c:257
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
void GNUNET_SPEEDUP_stop_()
Stop tasks that modify clock behavior.
Definition: speedup.c:105