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

enum GNUNET_GenericReturnValue 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...
 
enum GNUNET_GenericReturnValue 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 55 of file gnunet_program_lib.h.

Function Documentation

◆ GNUNET_PROGRAM_run2()

enum GNUNET_GenericReturnValue 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_NO if successful option processing called for the program to terminate, GNUNET_OK on success (#a task was invoked)

Definition at line 110 of file program.c.

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;
149  int iret;
150  unsigned int cnt;
151  unsigned long long skew_offset;
152  unsigned long long skew_variance;
153  long long clock_offset;
156  const struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
157  GNUNET_GETOPT_option_cfgfile (&cc.cfgfile),
158  GNUNET_GETOPT_option_help (binaryHelp),
160  GNUNET_GETOPT_option_logfile (&logfile),
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)
205  : GNUNET_strdup (pd->gettext_path);
206  if (NULL != path)
207  {
208  bindtextdomain (pd->gettext_domain, path);
209  GNUNET_free (path);
210  }
212  }
213 #endif
214  cnt = 0;
215  while (NULL != options[cnt].name)
216  cnt++;
217  allopts = GNUNET_new_array (cnt + deflen + 1,
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))
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  {
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  {
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 ==
295  cc.cfgfile))
296  {
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  {
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  }
321  "Loading configuration from entry point `%s'\n",
322  cc.cfgfile);
323  if (GNUNET_SYSERR ==
325  cfg_fn))
326  {
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 ==
339  "testing",
340  "skew_offset",
341  &skew_offset)) &&
342  (GNUNET_OK ==
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 !=
359  "arm",
360  "CONFIG"))
361  {
362  if (NULL != cc.cfgfile)
364  "arm",
365  "CONFIG",
366  cc.cfgfile);
367  else if (NULL != cfg_fn)
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  {
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;
388 cleanup:
390  GNUNET_free (cc.cfgfile);
391  GNUNET_free (cfg_fn);
392  GNUNET_free (loglev);
393  GNUNET_free (logfile);
394  return ret;
395 }
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
char * getenv()
#define textdomain(Domainname)
Definition: gettext.h:56
#define bindtextdomain(Domainname, Dirname)
Definition: gettext.h:57
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
static void cleanup(void *cls)
Function scheduled as very last function, cleans up after us.
#define GNUNET_log(kind,...)
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
GNUNET_GenericReturnValue
Named constants for return values.
Definition: gnunet_common.h:92
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_YES
Definition: gnunet_common.h:97
@ GNUNET_NO
Definition: gnunet_common.h:94
@ GNUNET_SYSERR
Definition: gnunet_common.h:93
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.
enum GNUNET_GenericReturnValue 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.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
char * GNUNET_CONFIGURATION_default_filename(void)
Return the filename of the default configuration filename that is used when no explicit configuration...
enum GNUNET_GenericReturnValue 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.
enum GNUNET_GenericReturnValue 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:482
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_cfgfile(char **fn)
Allow user to specify configuration file name (-c option)
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_logfile(char **logfn)
Allow user to specify log file name (-l option)
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:883
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_GETOPT_CommandLineOption GNUNET_GETOPT_option_loglevel(char **level)
Define the '-L' log level option.
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_log_setup(const char *comp, const char *loglevel, const char *logfile)
Setup logging.
@ GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
#define GNUNET_new_array(n, type)
Allocate a size n array with structs or unions of the given type.
#define GNUNET_array_append(arr, len, element)
Append an element to an array (growing the array by one).
#define GNUNET_free(ptr)
Wrapper around free.
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_get(void)
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,...
@ GNUNET_OS_IPK_LOCALEDIR
Return the directory where translations are installed (share/locale/)
void GNUNET_RESOLVER_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Create the connection to the resolver service.
Definition: resolver_api.c:257
void GNUNET_SCHEDULER_run(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Initialize and run scheduler.
Definition: scheduler.c:720
void GNUNET_TIME_set_offset(long long offset)
Set the timestamp offset for this instance.
Definition: time.c:48
#define _(String)
GNU gettext support macro.
Definition: platform.h:177
const char * name
static void program_main(void *cls)
Initial task called by the scheduler for each program.
Definition: program.c:87
static int cmd_sorter(const void *a1, const void *a2)
Compare function for 'qsort' to sort command-line arguments by the short option.
Definition: program.c:110
Context for the command.
Definition: program.c:43
Definition of a command line option.
const char * name
Long name of the option (may not be NULL)
const char shortName
Short name of the option.
Project-specific data used to help the OS subsystem find installation paths.
char * gettext_path
Gettext directory, e.g.
const char * user_config_file
Configuration file name to use (if $XDG_CONFIG_HOME is not set).
const char * config_file
Configuration file name (in $XDG_CONFIG_HOME) to use.
char * gettext_domain
Gettext domain for localisation, e.g.
const char * version
String identifying the current project version.

Referenced by main().

Here is the caller graph for this function:

◆ GNUNET_PROGRAM_run()

enum GNUNET_GenericReturnValue 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_NO if successful option processing called for the program to terminate, GNUNET_OK on success (#a task was invoked)

Definition at line 110 of file program.c.

406 {
407  return GNUNET_PROGRAM_run2 (argc,
408  argv,
409  binaryName,
410  binaryHelp,
411  options,
412  task,
413  task_cls,
414  GNUNET_NO);
415 }
enum GNUNET_GenericReturnValue 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,...
Definition: program.c:131

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

Here is the caller graph for this function: