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 106 of file program.c.

134 {
135  struct CommandContext cc;
136 
137 #if ENABLE_NLS
138  char *path;
139 #endif
140  char *loglev;
141  char *logfile;
142  char *cfg_fn;
144  int iret;
145  unsigned int cnt;
146  unsigned long long skew_offset;
147  unsigned long long skew_variance;
148  long long clock_offset;
151  struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
152  GNUNET_GETOPT_option_cfgfile (&cc.cfgfile),
153  GNUNET_GETOPT_option_help (binaryHelp),
155  GNUNET_GETOPT_option_logfile (&logfile),
157  };
158  struct GNUNET_GETOPT_CommandLineOption *allopts;
159  const char *gargs;
160  char *lpfx;
161  char *spc;
162 
163  logfile = NULL;
164  gargs = getenv ("GNUNET_ARGS");
165  if (NULL != gargs)
166  {
167  char **gargv;
168  unsigned int gargc;
169  char *cargs;
170 
171  gargv = NULL;
172  gargc = 0;
173  for (int i = 0; i < argc; i++)
174  GNUNET_array_append (gargv, gargc, GNUNET_strdup (argv[i]));
175  cargs = GNUNET_strdup (gargs);
176  for (char *tok = strtok (cargs, " "); NULL != tok; tok = strtok (NULL, " "))
177  GNUNET_array_append (gargv, gargc, GNUNET_strdup (tok));
178  GNUNET_free (cargs);
179  GNUNET_array_append (gargv, gargc, NULL);
180  argv = (char *const *) gargv;
181  argc = gargc - 1;
182  }
183  memset (&cc, 0, sizeof(cc));
184  loglev = NULL;
185  cc.task = task;
186  cc.task_cls = task_cls;
187  cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
188  /* prepare */
189 #if ENABLE_NLS
190  if (NULL != pd->gettext_domain)
191  {
192  setlocale (LC_ALL, "");
193  path = (NULL == pd->gettext_path)
195  : GNUNET_strdup (pd->gettext_path);
196  if (NULL != path)
197  {
198  bindtextdomain (pd->gettext_domain, path);
199  GNUNET_free (path);
200  }
202  }
203 #endif
204  cnt = 0;
205  while (NULL != options[cnt].name)
206  cnt++;
207  allopts =
208  GNUNET_malloc ((cnt + 1) * sizeof(struct GNUNET_GETOPT_CommandLineOption)
209  + sizeof(defoptions));
210  GNUNET_memcpy (allopts, defoptions, sizeof(defoptions));
211  GNUNET_memcpy (&allopts[sizeof(defoptions)
212  / sizeof(struct GNUNET_GETOPT_CommandLineOption)],
213  options,
214  (cnt + 1) * sizeof(struct GNUNET_GETOPT_CommandLineOption));
215  cnt += sizeof(defoptions) / sizeof(struct GNUNET_GETOPT_CommandLineOption);
216  qsort (allopts,
217  cnt,
218  sizeof(struct GNUNET_GETOPT_CommandLineOption),
219  &cmd_sorter);
220  loglev = NULL;
221  if ((NULL != pd->config_file) && (NULL != pd->user_config_file))
223  else
224  cfg_fn = NULL;
225  lpfx = GNUNET_strdup (binaryName);
226  if (NULL != (spc = strstr (lpfx, " ")))
227  *spc = '\0';
228  iret = GNUNET_GETOPT_run (binaryName,
229  allopts,
230  (unsigned int) argc,
231  argv);
232  if ((GNUNET_OK > iret) ||
233  (GNUNET_OK != GNUNET_log_setup (lpfx,
234  loglev,
235  logfile)))
236  {
237  GNUNET_free (allopts);
238  GNUNET_free (lpfx);
239  ret = (enum GNUNET_GenericReturnValue) iret;
240  goto cleanup;
241  }
242  if (NULL != cc.cfgfile)
243  {
245  "Loading configuration from entry point specified as option (%s)\n",
246  cc.cfgfile);
247  if (GNUNET_YES !=
248  GNUNET_DISK_file_test (cc.cfgfile))
249  {
251  _ ("Unreadable configuration file `%s', exiting ...\n"),
252  cc.cfgfile);
253  ret = GNUNET_SYSERR;
254  GNUNET_free (allopts);
255  GNUNET_free (lpfx);
256  goto cleanup;
257  }
258  if (GNUNET_SYSERR ==
260  cc.cfgfile))
261  {
263  _ ("Malformed configuration file `%s', exiting ...\n"),
264  cc.cfgfile);
265  ret = GNUNET_SYSERR;
266  GNUNET_free (allopts);
267  GNUNET_free (lpfx);
268  goto cleanup;
269  }
270  }
271  else
272  {
273  if ( (NULL != cfg_fn) &&
274  (GNUNET_YES !=
275  GNUNET_DISK_file_test (cfg_fn)) )
276  {
278  _ ("Unreadable configuration file `%s'. Exiting ...\n"),
279  cfg_fn);
280  ret = GNUNET_SYSERR;
281  GNUNET_free (allopts);
282  GNUNET_free (lpfx);
283  goto cleanup;
284  }
286  "Loading configuration from entry point `%s'\n",
287  cc.cfgfile);
288  if (GNUNET_SYSERR ==
290  cfg_fn))
291  {
293  _ ("Malformed configuration. Exiting ...\n"));
294  ret = GNUNET_SYSERR;
295  GNUNET_free (allopts);
296  GNUNET_free (lpfx);
297  goto cleanup;
298  }
299  }
300  GNUNET_free (allopts);
301  GNUNET_free (lpfx);
302  if ((GNUNET_OK ==
304  "testing",
305  "skew_offset",
306  &skew_offset)) &&
307  (GNUNET_OK ==
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. */
322  if (GNUNET_YES !=
324  "arm",
325  "CONFIG"))
326  {
327  if (NULL != cc.cfgfile)
329  "arm",
330  "CONFIG",
331  cc.cfgfile);
332  else if (NULL != cfg_fn)
334  "arm",
335  "CONFIG",
336  cfg_fn);
337  }
338 
339  /* run */
340  cc.args = &argv[iret];
341  if ((NULL == cc.cfgfile) && (NULL != cfg_fn))
342  cc.cfgfile = GNUNET_strdup (cfg_fn);
343  if (GNUNET_NO == run_without_scheduler)
344  {
346  }
347  else
348  {
349  GNUNET_RESOLVER_connect (cc.cfg);
350  cc.task (cc.task_cls, cc.args, cc.cfgfile, cc.cfg);
351  }
352  ret = GNUNET_OK;
353 cleanup:
355  GNUNET_free (cc.cfgfile);
356  GNUNET_free (cfg_fn);
357  GNUNET_free (loglev);
358  GNUNET_free (logfile);
359  return ret;
360 }
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_malloc(size)
Wrapper around malloc.
#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:106
Context for the command.
Definition: program.c:43
Definition of a command line 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 106 of file program.c.

371 {
372  return GNUNET_PROGRAM_run2 (argc,
373  argv,
374  binaryName,
375  binaryHelp,
376  options,
377  task,
378  task_cls,
379  GNUNET_NO);
380 }
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:126

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

Here is the caller graph for this function: