GNUnet  0.10.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 140 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_free_non_null, 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().

148 {
149  struct CommandContext cc;
150 
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;
165  struct GNUNET_GETOPT_CommandLineOption defoptions[] =
166  { GNUNET_GETOPT_option_cfgfile(&cc.cfgfile),
167  GNUNET_GETOPT_option_help(binaryHelp),
171  struct GNUNET_GETOPT_CommandLineOption *allopts;
172  const char *gargs;
173  char *lpfx;
174  char *spc;
175 
176  logfile = NULL;
177  gargs = getenv("GNUNET_ARGS");
178  if (NULL != gargs)
179  {
180  char **gargv;
181  unsigned int gargc;
182  char *cargs;
183 
184  gargv = NULL;
185  gargc = 0;
186  for (int i = 0; i < argc; i++)
187  GNUNET_array_append(gargv, gargc, GNUNET_strdup(argv[i]));
188  cargs = GNUNET_strdup(gargs);
189  for (char *tok = strtok(cargs, " "); NULL != tok; tok = strtok(NULL, " "))
190  GNUNET_array_append(gargv, gargc, GNUNET_strdup(tok));
191  GNUNET_free(cargs);
192  GNUNET_array_append(gargv, gargc, NULL);
193  argv = (char *const *)gargv;
194  argc = gargc - 1;
195  }
196  memset(&cc, 0, sizeof(cc));
197  loglev = NULL;
198  cc.task = task;
199  cc.task_cls = task_cls;
200  cc.cfg = cfg = GNUNET_CONFIGURATION_create();
201  /* prepare */
202 #if ENABLE_NLS
203  if (NULL != pd->gettext_domain)
204  {
205  setlocale(LC_ALL, "");
206  path = (NULL == pd->gettext_path)
209  if (NULL != path)
210  {
211  bindtextdomain(pd->gettext_domain, path);
212  GNUNET_free(path);
213  }
215  }
216 #endif
217  cnt = 0;
218  while (NULL != options[cnt].name)
219  cnt++;
220  allopts =
221  GNUNET_malloc((cnt + 1) * sizeof(struct GNUNET_GETOPT_CommandLineOption) +
222  sizeof(defoptions));
223  GNUNET_memcpy(allopts, defoptions, sizeof(defoptions));
224  GNUNET_memcpy(&allopts[sizeof(defoptions) /
225  sizeof(struct GNUNET_GETOPT_CommandLineOption)],
226  options,
227  (cnt + 1) * sizeof(struct GNUNET_GETOPT_CommandLineOption));
228  cnt += sizeof(defoptions) / sizeof(struct GNUNET_GETOPT_CommandLineOption);
229  qsort(allopts,
230  cnt,
231  sizeof(struct GNUNET_GETOPT_CommandLineOption),
232  &cmd_sorter);
233  loglev = NULL;
234  xdg = getenv("XDG_CONFIG_HOME");
235  if (NULL != xdg)
236  GNUNET_asprintf(&cfg_fn,
237  "%s%s%s",
238  xdg,
240  pd->config_file);
241  else
242  cfg_fn = GNUNET_strdup(pd->user_config_file);
243  lpfx = GNUNET_strdup(binaryName);
244  if (NULL != (spc = strstr(lpfx, " ")))
245  *spc = '\0';
246  ret = GNUNET_GETOPT_run(binaryName, allopts, (unsigned int)argc, argv);
247  if ((GNUNET_OK > ret) ||
248  (GNUNET_OK != GNUNET_log_setup(lpfx, loglev, logfile)))
249  {
250  GNUNET_free(allopts);
251  GNUNET_free(lpfx);
252  goto cleanup;
253  }
254  if (NULL != cc.cfgfile)
255  {
256  if ((GNUNET_YES != GNUNET_DISK_file_test(cc.cfgfile)) ||
257  (GNUNET_SYSERR == GNUNET_CONFIGURATION_load(cfg, cc.cfgfile)))
258  {
260  _(
261  "Unreadable or malformed configuration file `%s', exit ...\n"),
262  cc.cfgfile);
263  ret = GNUNET_SYSERR;
264  GNUNET_free(allopts);
265  GNUNET_free(lpfx);
266  goto cleanup;
267  }
268  }
269  else
270  {
271  if (GNUNET_YES == GNUNET_DISK_file_test(cfg_fn))
272  {
273  if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load(cfg, cfg_fn))
274  {
275  GNUNET_log(
277  _(
278  "Unreadable or malformed default configuration file `%s', exit ...\n"),
279  cfg_fn);
280  ret = GNUNET_SYSERR;
281  GNUNET_free(allopts);
282  GNUNET_free(lpfx);
283  goto cleanup;
284  }
285  }
286  else
287  {
288  GNUNET_free(cfg_fn);
289  cfg_fn = NULL;
290  if (GNUNET_OK != GNUNET_CONFIGURATION_load(cfg, NULL))
291  {
293  _("Unreadable or malformed configuration, exit ...\n"));
294  ret = GNUNET_SYSERR;
295  GNUNET_free(allopts);
296  GNUNET_free(lpfx);
297  goto cleanup;
298  }
299  }
300  }
301  GNUNET_free(allopts);
302  GNUNET_free(lpfx);
304  "testing",
305  "skew_offset",
306  &skew_offset) &&
308  "testing",
309  "skew_variance",
310  &skew_variance)))
311  {
312  clock_offset = skew_offset - skew_variance;
313  GNUNET_TIME_set_offset(clock_offset);
314  }
315  /* ARM needs to know which configuration file to use when starting
316  services. If we got a command-line option *and* if nothing is
317  specified in the configuration, remember the command-line option
318  in "cfg". This is typically really only having an effect if we
319  are running code in src/arm/, as obviously the rest of the code
320  has little business with ARM-specific options. */
321  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  {
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:
345  GNUNET_free_non_null(cc.cfgfile);
346  GNUNET_free_non_null(cfg_fn);
347  GNUNET_free_non_null(loglev);
348  GNUNET_free_non_null(logfile);
349  return ret;
350 }
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:541
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.
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
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_help(const char *about)
Defining the option to print the command line help text (-h option).
static void program_main(void *cls)
Initial task called by the scheduler for each program.
Definition: program.c:86
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
void GNUNET_SCHEDULER_run(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Initialize and run scheduler.
Definition: scheduler.c:707
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
static int ret
Final status code.
Definition: gnunet-arm.c:89
#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)
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 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:105
#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.
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:104
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:886
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
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).
configuration data
Definition: configuration.c:83
#define GNUNET_log(kind,...)
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_get(void)
#define GNUNET_YES
Definition: gnunet_common.h:77
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:252
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
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 }
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:140
#define GNUNET_NO
Definition: gnunet_common.h:78
Here is the call graph for this function:
Here is the caller graph for this function: