2 This file is part of GNUnet.
3 (C) 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 2, or (at your
8 option) any later version.
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 PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file util/program.c
23 * @brief standard code for GNUnet startup and shutdown
24 * @author Christian Grothoff
28 #include "gnunet_common.h"
29 #include "gnunet_configuration_lib.h"
30 #include "gnunet_crypto_lib.h"
31 #include "gnunet_directories.h"
32 #include "gnunet_getopt_lib.h"
33 #include "gnunet_os_lib.h"
34 #include "gnunet_program_lib.h"
35 #include "gnunet_scheduler_lib.h"
41 #include "program_lib_strnlen.c"
42 #include "program_lib_strndup.c"
43 #include "program_lib_mempcpy.c"
44 #include "program_lib_argz.c"
48 * Context for the command.
58 * Name of the configuration file used, can be NULL!
63 * Main function to run.
65 GNUNET_PROGRAM_Main task;
73 * Configuration to use.
75 const struct GNUNET_CONFIGURATION_Handle *cfg;
81 * Initial task called by the scheduler for each
82 * program. Runs the program-specific main task.
85 program_main (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
87 struct CommandContext *cc = cls;
89 cc->task (cc->task_cls, tc->sched, cc->args, cc->cfgfile, cc->cfg);
94 * Compare function for 'qsort' to sort command-line arguments by the
97 * @param a1 first command line option
98 * @param a2 second command line option
101 cmd_sorter (__const void *a1, __const void *a2)
103 __const struct GNUNET_GETOPT_CommandLineOption *c1 = a1;
104 __const struct GNUNET_GETOPT_CommandLineOption *c2 = a2;
105 if (toupper (c1->shortName) > toupper (c2->shortName))
107 if (toupper (c1->shortName) < toupper (c2->shortName))
109 if (c1->shortName > c2->shortName)
111 if (c1->shortName < c2->shortName)
118 * Run a standard GNUnet command startup sequence (initialize loggers
119 * and configuration, parse options).
121 * @param argc number of command line arguments
122 * @param argv command line arguments
123 * @param binaryName our expected name
124 * @param binaryHelp help text for the program
125 * @param options command line options
126 * @param task main function to run
127 * @param task_cls closure for task
128 * @return GNUNET_SYSERR on error, GNUNET_OK on success
131 GNUNET_PROGRAM_run (int argc,
133 const char *binaryName,
134 const char *binaryHelp,
135 const struct GNUNET_GETOPT_CommandLineOption *options,
136 GNUNET_PROGRAM_Main task, void *task_cls)
138 struct CommandContext cc;
144 struct GNUNET_CONFIGURATION_Handle *cfg;
145 struct GNUNET_GETOPT_CommandLineOption defoptions[] = {
146 GNUNET_GETOPT_OPTION_CFG_FILE (&cc.cfgfile),
147 GNUNET_GETOPT_OPTION_HELP (binaryHelp),
148 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
149 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
150 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION)
152 struct GNUNET_GETOPT_CommandLineOption *allopts;
156 gargs = getenv ("GNUNET_ARGS");
164 argz_create_sep (gargs, ' ', &gargz, &gargl);
166 argz_insert (&gargz, &gargl, gargz, argv[i]);
167 gargv = GNUNET_malloc (sizeof (char*) * (gargl+1));
168 argz_extract (gargz, gargl, gargv);
169 argc = argz_count (gargz, gargl);
171 argv = (char *const *) gargv;
173 memset (&cc, 0, sizeof (cc));
176 cc.task_cls = task_cls;
177 cc.cfg = cfg = GNUNET_CONFIGURATION_create ();
181 setlocale (LC_ALL, "");
182 path = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_LOCALEDIR);
185 BINDTEXTDOMAIN ("GNUnet", path);
188 textdomain ("GNUnet");
191 while (options[cnt].name != NULL)
194 GNUNET_malloc ((cnt +
195 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption) +
196 sizeof (defoptions));
197 memcpy (allopts, defoptions, sizeof (defoptions));
199 [sizeof (defoptions) /
200 sizeof (struct GNUNET_GETOPT_CommandLineOption)], options,
201 (cnt + 1) * sizeof (struct GNUNET_GETOPT_CommandLineOption));
203 sizeof (defoptions) / sizeof (struct GNUNET_GETOPT_CommandLineOption);
204 qsort (allopts, cnt, sizeof (struct GNUNET_GETOPT_CommandLineOption),
206 loglev = GNUNET_strdup ("WARNING");
207 cc.cfgfile = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE);
208 if ((-1 == (ret = GNUNET_GETOPT_run (binaryName,
210 (unsigned int) argc, argv))) ||
212 GNUNET_log_setup (binaryName,
215 (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cc.cfgfile))))
218 GNUNET_free_non_null (cc.cfgfile);
219 GNUNET_free (loglev);
220 GNUNET_free (allopts);
221 return GNUNET_SYSERR;
223 GNUNET_free (allopts);
226 cc.args = &argv[ret];
227 GNUNET_SCHEDULER_run (&program_main, &cc);
230 GNUNET_CONFIGURATION_destroy (cfg);
231 GNUNET_free_non_null (cc.cfgfile);
232 GNUNET_free (loglev);
237 /* end of program.c */