GNUnet  0.11.x
Typedefs | Functions
Program library

Start command-line programs. More...

Typedefs

typedef void(* GNUNET_PROGRAM_Main) (void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
 Main function that will be run. More...
 

Functions

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). More...
 
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). More...
 

Detailed Description

Start command-line programs.

Typedef Documentation

◆ GNUNET_PROGRAM_Main

typedef void(* GNUNET_PROGRAM_Main) (void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)

Main function that will be run.

Parameters
clsclosure
argsremaining command-line arguments
cfgfilename of the configuration file used (for saving, can be NULL!)
cfgconfiguration

Definition at line 56 of file gnunet_program_lib.h.

Function Documentation

◆ GNUNET_PROGRAM_run2()

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).

Parameters
argcnumber of command line arguments in argv
argvcommand line arguments
binaryNameour expected name
binaryHelphelp text for the program
optionscommand line options
taskmain function to run
task_clsclosure for task
run_without_schedulerGNUNET_NO start the scheduler, GNUNET_YES do not start the scheduler just run the main task
Returns
GNUNET_SYSERR on error, GNUNET_OK on success

Definition at line 141 of file program.c.

References _, CommandContext::args, bindtextdomain, CommandContext::cfg, CommandContext::cfgfile, cleanup(), cmd_sorter(), GNUNET_OS_ProjectData::config_file, DIR_SEPARATOR_STR, getenv(), GNUNET_OS_ProjectData::gettext_domain, GNUNET_OS_ProjectData::gettext_path, GNUNET_array_append, GNUNET_asprintf(), GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONFIGURATION_have_value(), GNUNET_CONFIGURATION_load(), GNUNET_CONFIGURATION_set_value_string(), GNUNET_DISK_file_test(), GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_GETOPT_option_cfgfile(), GNUNET_GETOPT_option_help(), GNUNET_GETOPT_option_logfile(), GNUNET_GETOPT_option_loglevel(), GNUNET_GETOPT_option_version(), GNUNET_GETOPT_run(), GNUNET_log, GNUNET_log_setup(), GNUNET_malloc, GNUNET_memcpy, GNUNET_NO, GNUNET_OK, GNUNET_OS_installation_get_path(), GNUNET_OS_IPK_LOCALEDIR, GNUNET_OS_project_data_get(), GNUNET_RESOLVER_connect(), GNUNET_SCHEDULER_run(), GNUNET_strdup, GNUNET_SYSERR, GNUNET_TIME_set_offset(), GNUNET_YES, name, program_main(), ret, CommandContext::task, CommandContext::task_cls, textdomain, GNUNET_OS_ProjectData::user_config_file, and GNUNET_OS_ProjectData::version.

Referenced by GNUNET_PROGRAM_run(), and main().

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;
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;
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)
208  ? GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR)
209  : GNUNET_strdup (pd->gettext_path);
210  if (NULL != path)
211  {
212  bindtextdomain (pd->gettext_domain, path);
213  GNUNET_free (path);
214  }
215  textdomain (pd->gettext_domain);
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,
240  DIR_SEPARATOR_STR,
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)) ||
258  (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, cc.cfgfile)))
259  {
260  GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
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 (
277  GNUNET_ERROR_TYPE_ERROR,
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  {
293  GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
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);
304  if ((GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cc.cfg,
305  "testing",
306  "skew_offset",
307  &skew_offset)) &&
308  (GNUNET_OK == 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. */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  {
335  GNUNET_SCHEDULER_run (&program_main, &cc);
336  }
337  else
338  {
339  GNUNET_RESOLVER_connect (cc.cfg);
340  cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
341  }
342  ret = GNUNET_OK;
343 cleanup:
344  GNUNET_CONFIGURATION_destroy (cfg);
345  GNUNET_free (cc.cfgfile);
346  GNUNET_free (cfg_fn);
347  GNUNET_free (loglev);
348  GNUNET_free (logfile);
349  return ret;
350 }
GNUNET_DISK_file_test
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
GNUNET_OS_IPK_LOCALEDIR
Return the directory where translations are installed (share/locale/)
Definition: gnunet_os_lib.h:146
GNUNET_OS_ProjectData::config_file
const char * config_file
Configuration file name (in $XDG_CONFIG_HOME) to use.
Definition: gnunet_os_lib.h:267
GNUNET_OS_ProjectData::gettext_domain
char * gettext_domain
Gettext domain for localisation, e.g.
Definition: gnunet_os_lib.h:288
GNUNET_OS_ProjectData
Project-specific data used to help the OS subsystem find installation paths.
Definition: gnunet_os_lib.h:210
GNUNET_CONFIGURATION_get_value_number
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.
Definition: configuration.c:987
cfg
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
GNUNET_array_append
#define GNUNET_array_append(arr, len, element)
Append an element to an array (growing the array by one).
Definition: gnunet_common.h:1405
GNUNET_OS_ProjectData::gettext_path
char * gettext_path
Gettext directory, e.g.
Definition: gnunet_os_lib.h:294
CommandContext
Context for the command.
Definition: program.c:42
GNUNET_GETOPT_option_help
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_help(const char *about)
Defining the option to print the command line help text (-h option).
Definition: getopt_helpers.c:202
program_main
static void program_main(void *cls)
Initial task called by the scheduler for each program.
Definition: program.c:87
GNUNET_memcpy
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
Definition: gnunet_common.h:1203
ret
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
GNUNET_SCHEDULER_run
void GNUNET_SCHEDULER_run(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Initialize and run scheduler.
Definition: scheduler.c:720
GNUNET_OS_ProjectData::user_config_file
const char * user_config_file
Configuration file name to use (if $XDG_CONFIG_HOME is not set).
Definition: gnunet_os_lib.h:272
bindtextdomain
#define bindtextdomain(Domainname, Dirname)
Definition: gettext.h:57
GNUNET_NO
Definition: gnunet_common.h:86
GNUNET_GETOPT_CommandLineOption
Definition of a command line option.
Definition: gnunet_getopt_lib.h:100
GNUNET_CONFIGURATION_create
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
Definition: configuration.c:118
GNUNET_TIME_set_offset
void GNUNET_TIME_set_offset(long long offset)
Set the timestamp offset for this instance.
Definition: time.c:53
GNUNET_strdup
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
Definition: gnunet_common.h:1335
GNUNET_GETOPT_option_logfile
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_logfile(char **logfn)
Allow user to specify log file name (-l option)
Definition: getopt_helpers.c:503
GNUNET_CONFIGURATION_load
int GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
Definition: configuration_loader.c:42
_
#define _(String)
GNU gettext support macro.
Definition: platform.h:184
GNUNET_OS_ProjectData::version
const char * version
String identifying the current project version.
Definition: gnunet_os_lib.h:277
textdomain
#define textdomain(Domainname)
Definition: gettext.h:56
GNUNET_GETOPT_option_version
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_version(const char *version)
Define the option to print the version of the application (-v option)
Definition: getopt_helpers.c:63
GNUNET_asprintf
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
Definition: common_allocation.c:475
GNUNET_OK
Definition: gnunet_common.h:87
cmd_sorter
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
DIR_SEPARATOR_STR
#define DIR_SEPARATOR_STR
Definition: platform.h:171
GNUNET_CONFIGURATION_have_value
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.
Definition: configuration.c:1219
GNUNET_OS_installation_get_path
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.
Definition: os_installation.c:444
GNUNET_CONFIGURATION_destroy
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
Definition: configuration.c:208
cleanup
static void cleanup(void *cls)
Function scheduled as very last function, cleans up after us.
Definition: gnunet-daemon-exit.c:3249
GNUNET_GETOPT_option_loglevel
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_loglevel(char **level)
Define the &#39;-L&#39; log level option.
Definition: getopt_helpers.c:423
GNUNET_CONFIGURATION_set_value_string
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.
Definition: configuration.c:915
GNUNET_SYSERR
Definition: gnunet_common.h:85
GNUNET_GETOPT_run
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
getenv
char * getenv()
GNUNET_GETOPT_option_cfgfile
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_cfgfile(char **fn)
Allow user to specify configuration file name (-c option)
Definition: getopt_helpers.c:526
GNUNET_CONFIGURATION_Handle
configuration data
Definition: configuration.c:84
name
const char * name
Definition: plugin_gnsrecord_abd.c:271
GNUNET_log
#define GNUNET_log(kind,...)
Definition: gnunet_common.h:520
GNUNET_OS_project_data_get
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_get(void)
Definition: os_installation.c:103
GNUNET_ERROR_TYPE_ERROR
Definition: gnunet_common.h:391
GNUNET_log_setup
int GNUNET_log_setup(const char *comp, const char *loglevel, const char *logfile)
Setup logging.
Definition: common_logging.c:708
GNUNET_YES
Definition: gnunet_common.h:89
GNUNET_RESOLVER_connect
void GNUNET_RESOLVER_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Create the connection to the resolver service.
Definition: resolver_api.c:257
GNUNET_malloc
#define GNUNET_malloc(size)
Wrapper around malloc.
Definition: gnunet_common.h:1261
GNUNET_free
#define GNUNET_free(ptr)
Wrapper around free.
Definition: gnunet_common.h:1321
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_PROGRAM_run()

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).

Parameters
argcnumber of command line arguments
argvcommand line arguments
binaryNameour expected name
binaryHelphelptext for "-h" option (about the app)
optionscommand line options
taskmain function to run
task_clsclosure for task
Returns
GNUNET_SYSERR on error, GNUNET_OK on success
Parameters
argcnumber of command line arguments
argvcommand line arguments
binaryNameour expected name
binaryHelphelp text for the program
optionscommand line options
taskmain function to run
task_clsclosure for task
Returns
GNUNET_SYSERR on error, GNUNET_OK on success

Definition at line 367 of file program.c.

References GNUNET_NO, and GNUNET_PROGRAM_run2().

Referenced by GNUNET_TESTBED_test_run(), GNUNET_TRANSPORT_TESTING_connect_check(), and main().

374 {
375  return GNUNET_PROGRAM_run2 (argc,
376  argv,
377  binaryName,
378  binaryHelp,
379  options,
380  task,
381  task_cls,
382  GNUNET_NO);
383 }
GNUNET_PROGRAM_run2
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
GNUNET_NO
Definition: gnunet_common.h:86
Here is the call graph for this function:
Here is the caller graph for this function:
Generated by   doxygen 1.8.13