GNUnet  0.10.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 #if ENABLE_NLS
152  char *path;
153 #endif
154  char *loglev;
155  char *logfile;
156  char *cfg_fn;
157  const char *xdg;
158  int ret;
159  unsigned int cnt;
160  unsigned long long skew_offset;
161  unsigned long long skew_variance;
162  long long clock_offset;
164  struct GNUNET_GETOPT_CommandLineOption defoptions[] =
166  GNUNET_GETOPT_option_help (binaryHelp),
168  GNUNET_GETOPT_option_logfile (&logfile),
169  GNUNET_GETOPT_option_version (PACKAGE_VERSION " " VCS_VERSION)};
170  struct GNUNET_GETOPT_CommandLineOption *allopts;
171  const char *gargs;
172  char *lpfx;
173  char *spc;
174 
175  logfile = NULL;
176  gargs = getenv ("GNUNET_ARGS");
177  if (NULL != gargs)
178  {
179  char **gargv;
180  unsigned int gargc;
181  char *cargs;
182 
183  gargv = NULL;
184  gargc = 0;
185  for (int i = 0; i < argc; i++)
186  GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
187  cargs = GNUNET_strdup (gargs);
188  for (char *tok = strtok (cargs, " "); NULL != tok; tok = strtok (NULL, " "))
189  GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
190  GNUNET_free (cargs);
191  GNUNET_array_append (gargv, gargc, NULL);
192  argv = (char *const *) gargv;
193  argc = gargc - 1;
194  }
195  memset (&cc, 0, sizeof (cc));
196  loglev = NULL;
197  cc.task = task;
198  cc.task_cls = task_cls;
199  cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
200  /* prepare */
201 #if ENABLE_NLS
202  setlocale (LC_ALL, "");
204  if (NULL != path)
205  {
206  BINDTEXTDOMAIN ("GNUnet", path);
207  GNUNET_free (path);
208  }
209  textdomain ("GNUnet");
210 #endif
211  cnt = 0;
212  while (NULL != options[cnt].name)
213  cnt++;
214  allopts =
215  GNUNET_malloc ((cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
216  sizeof (defoptions));
217  GNUNET_memcpy (allopts, defoptions, sizeof (defoptions));
218  GNUNET_memcpy (&allopts[sizeof (defoptions) /
219  sizeof (struct GNUNET_GETOPT_CommandLineOption)],
220  options,
221  (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
222  cnt += sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
223  qsort (allopts,
224  cnt,
225  sizeof (struct GNUNET_GETOPT_CommandLineOption),
226  &cmd_sorter);
227  loglev = NULL;
228  xdg = getenv ("XDG_CONFIG_HOME");
229  if (NULL != xdg)
230  GNUNET_asprintf (&cfg_fn,
231  "%s%s%s",
232  xdg,
235  else
236  cfg_fn = GNUNET_strdup (GNUNET_OS_project_data_get ()->user_config_file);
237  lpfx = GNUNET_strdup (binaryName);
238  if (NULL != (spc = strstr (lpfx, " ")))
239  *spc = '\0';
240  ret = GNUNET_GETOPT_run (binaryName, allopts, (unsigned int) argc, argv);
241  if ((GNUNET_OK > ret) ||
242  (GNUNET_OK != GNUNET_log_setup (lpfx, loglev, logfile)))
243  {
244  GNUNET_free (allopts);
245  GNUNET_free (lpfx);
246  goto cleanup;
247  }
248  if (NULL != cc.cfgfile)
249  {
250  if ((GNUNET_YES != GNUNET_DISK_file_test (cc.cfgfile)) ||
252  {
254  _ (
255  "Unreadable or malformed configuration file `%s', exit ...\n"),
256  cc.cfgfile);
257  ret = GNUNET_SYSERR;
258  GNUNET_free (allopts);
259  GNUNET_free (lpfx);
260  goto cleanup;
261  }
262  }
263  else
264  {
265  if (GNUNET_YES == GNUNET_DISK_file_test (cfg_fn))
266  {
267  if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cfg_fn))
268  {
269  GNUNET_log (
271  _ (
272  "Unreadable or malformed default configuration file `%s', exit ...\n"),
273  cfg_fn);
274  ret = GNUNET_SYSERR;
275  GNUNET_free (allopts);
276  GNUNET_free (lpfx);
277  goto cleanup;
278  }
279  }
280  else
281  {
282  GNUNET_free (cfg_fn);
283  cfg_fn = NULL;
284  if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, NULL))
285  {
287  _ ("Unreadable or malformed configuration, exit ...\n"));
288  ret = GNUNET_SYSERR;
289  GNUNET_free (allopts);
290  GNUNET_free (lpfx);
291  goto cleanup;
292  }
293  }
294  }
295  GNUNET_free (allopts);
296  GNUNET_free (lpfx);
298  "testing",
299  "skew_offset",
300  &skew_offset) &&
302  "testing",
303  "skew_variance",
304  &skew_variance)))
305  {
306  clock_offset = skew_offset - skew_variance;
307  GNUNET_TIME_set_offset (clock_offset);
308  }
309  /* ARM needs to know which configuration file to use when starting
310  services. If we got a command-line option *and* if nothing is
311  specified in the configuration, remember the command-line option
312  in "cfg". This is typically really only having an effect if we
313  are running code in src/arm/, as obviously the rest of the code
314  has little business with ARM-specific options. */
315  if (GNUNET_YES != GNUNET_CONFIGURATION_have_value (cfg, "arm", "CONFIG"))
316  {
317  if (NULL != cc.cfgfile)
318  GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG", cc.cfgfile);
319  else if (NULL != cfg_fn)
320  GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG", cfg_fn);
321  }
322 
323  /* run */
324  cc.args = &argv[ret];
325  if ((NULL == cc.cfgfile) && (NULL != cfg_fn))
326  cc.cfgfile = GNUNET_strdup (cfg_fn);
327  if (GNUNET_NO == run_without_scheduler)
328  {
330  }
331  else
332  {
334  cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
335  }
336  ret = GNUNET_OK;
337 cleanup:
340  GNUNET_free_non_null (cfg_fn);
341  GNUNET_free_non_null (loglev);
342  GNUNET_free_non_null (logfile);
343  return ret;
344 }
345 
346 
360 int
362  char *const *argv,
363  const char *binaryName,
364  const char *binaryHelp,
367  void *task_cls)
368 {
369  return GNUNET_PROGRAM_run2 (argc,
370  argv,
371  binaryName,
372  binaryHelp,
373  options,
374  task,
375  task_cls,
376  GNUNET_NO);
377 }
378 
379 
380 /* 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:669
Return the directory where translations are installed (share/locale/)
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.
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:1293
static void program_main(void *cls)
Initial task called by the scheduler for each program.
Definition: program.c:87
static char * config_file
Set to the name of the config file used.
Definition: gnunet-arm.c:79
void GNUNET_SCHEDULER_run(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Initialize and run scheduler.
Definition: scheduler.c:716
#define GNUNET_NO
Definition: gnunet_common.h:81
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
#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
static int ret
Final status code.
Definition: gnunet-arm.c:89
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:208
#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
#define GNUNET_memcpy(dst, src, n)
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
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:893
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
void * task_cls
Closure for task.
Definition: program.c:62
GNUNET_PROGRAM_Main task
Main function to run.
Definition: program.c:57
const char * name
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
#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:361
#define GNUNET_YES
Definition: gnunet_common.h:80
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration to use.
Definition: program.c:67
#define DIR_SEPARATOR_STR
Definition: plibc.h:632
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:254
#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