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 3, 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 arm/gnunet-arm.c
23 * @brief arm for writing a tool
24 * @author Christian Grothoff
27 #include "gnunet_arm_service.h"
28 #include "gnunet_constants.h"
29 #include "gnunet_util_lib.h"
32 * Timeout for stopping services. Long to give some services a real chance.
34 #define STOP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
37 * Timeout for stopping ARM. Extra-long since ARM needs to stop everyone else.
39 #define STOP_TIMEOUT_ARM GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
42 * Timeout for starting services, very short because of the strange way start works
43 * (by checking if running before starting, so really this time is always waited on
44 * startup (annoying)).
46 #define START_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
49 * Timeout for listing all running services.
51 #define LIST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
54 * Set if we are to shutdown all services (including ARM).
59 * Set if we are to start default services (including ARM).
64 * Set if we are to stop/start default services (including ARM).
69 * Set if we should delete configuration and temp directory on exit.
74 * Set if we should not print status messages.
79 * Set if we should print a list of currently running services.
84 * Set to the name of a service to start.
89 * Set to the name of a service to kill.
94 * Set to the name of the config file used.
96 static const char *config_file;
99 * Set to the directory where runtime files are stored.
109 * Connection with ARM.
111 static struct GNUNET_ARM_Handle *h;
116 static const struct GNUNET_CONFIGURATION_Handle *cfg;
119 * Processing stage that we are in. Simple counter.
121 static unsigned int phase;
124 * User defined timestamp for completing operations.
126 static struct GNUNET_TIME_Relative timeout;
130 * Main continuation-passing-style loop. Runs the various
131 * jobs that we've been asked to do in order.
133 * @param cls closure, unused
134 * @param tc context, unused
137 cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
141 * Callback invoked with the status of the last operation. Reports to the
142 * user and then runs the next phase in the FSM.
144 * @param cls pointer to "const char*" identifying service that was manipulated
145 * @param result result of the operation
148 confirm_cb (void *cls,
149 enum GNUNET_ARM_ProcessStatus result)
151 const char *service = cls;
155 case GNUNET_ARM_PROCESS_UNKNOWN:
156 FPRINTF (stderr, _("Service `%s' is unknown to ARM.\n"), service);
159 case GNUNET_ARM_PROCESS_DOWN:
160 if (quiet != GNUNET_YES)
161 FPRINTF (stdout, _("Service `%s' has been stopped.\n"), service);
163 case GNUNET_ARM_PROCESS_ALREADY_RUNNING:
164 FPRINTF (stderr, _("Service `%s' was already running.\n"), service);
167 case GNUNET_ARM_PROCESS_STARTING:
168 if (quiet != GNUNET_YES)
169 FPRINTF (stdout, _("Service `%s' has been started.\n"), service);
171 case GNUNET_ARM_PROCESS_ALREADY_STOPPING:
172 FPRINTF (stderr, _("Service `%s' was already being stopped.\n"), service);
175 case GNUNET_ARM_PROCESS_ALREADY_DOWN:
176 FPRINTF (stderr, _("Service `%s' was already not running.\n"), service);
179 case GNUNET_ARM_PROCESS_SHUTDOWN:
180 FPRINTF (stderr, "%s", _("Request ignored as ARM is shutting down.\n"));
183 case GNUNET_ARM_PROCESS_COMMUNICATION_ERROR:
184 FPRINTF (stderr, "%s", _("Error communicating with ARM service.\n"));
187 case GNUNET_ARM_PROCESS_COMMUNICATION_TIMEOUT:
188 FPRINTF (stderr, "%s", _("Timeout communicating with ARM service.\n"));
191 case GNUNET_ARM_PROCESS_FAILURE:
192 FPRINTF (stderr, "%s", _("Operation failed.\n"));
196 FPRINTF (stderr, "%s", _("Unknown response code from ARM.\n"));
199 GNUNET_SCHEDULER_add_continuation (&cps_loop, NULL,
200 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
204 * Callback invoked with the list of running services.
205 * Reports to the user and then runs the next phase in the FSM.
207 * @param cls currently not used
208 * @param result result of the operation
209 * @param count number of running services
210 * @param list copy of the list of running services
213 list_cb (void *cls, int result, unsigned int count, const char *const*list)
217 if ( (result != GNUNET_YES) || (NULL == list) )
219 FPRINTF (stderr, "%s", _("Error communicating with ARM. ARM not running?\n"));
222 FPRINTF (stdout, "%s", _("Running services:\n"));
223 for (i=0; i<count; i++)
224 FPRINTF (stdout, "%s\n", list[i]);
228 * Main function that will be run by the scheduler.
231 * @param args remaining command-line arguments
232 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
233 * @param c configuration
236 run (void *cls, char *const *args, const char *cfgfile,
237 const struct GNUNET_CONFIGURATION_Handle *c)
240 config_file = cfgfile;
241 if (GNUNET_CONFIGURATION_get_value_string
242 (cfg, "PATHS", "SERVICEHOME", &dir) != GNUNET_OK)
244 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
246 ("Fatal configuration error: `%s' option in section `%s' missing.\n"),
247 "SERVICEHOME", "PATHS");
250 h = GNUNET_ARM_connect (cfg, NULL);
253 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
254 _("Fatal error initializing ARM API.\n"));
258 GNUNET_SCHEDULER_add_continuation (&cps_loop, NULL,
259 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
263 * Attempts to delete configuration file and SERVICEHOME
264 * on arm shutdown provided the end and delete options
265 * were specified when gnunet-arm was run.
270 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
271 "Will attempt to remove configuration file %s and service directory %s\n",
274 if (UNLINK (config_file) != 0)
276 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
277 _("Failed to remove configuration file %s\n"), config_file);
280 if (GNUNET_DISK_directory_remove (dir) != GNUNET_OK)
282 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
283 _("Failed to remove servicehome directory %s\n"), dir);
289 * Main continuation-passing-style loop. Runs the various
290 * jobs that we've been asked to do in order.
292 * @param cls closure, unused
293 * @param tc context, unused
296 cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
305 GNUNET_ARM_stop_service (h, term,
307 timeout.rel_value) ? STOP_TIMEOUT :
308 timeout, &confirm_cb, term);
313 if ((end) || (restart))
315 GNUNET_ARM_stop_service (h, "arm",
317 timeout.rel_value) ? STOP_TIMEOUT_ARM
318 : timeout, &confirm_cb, "arm");
325 GNUNET_ARM_start_service (h, "arm",
327 timeout.rel_value) ? START_TIMEOUT :
328 timeout, &confirm_cb, "arm");
335 GNUNET_ARM_start_service (h, init,
337 timeout.rel_value) ? START_TIMEOUT :
338 timeout, &confirm_cb, init);
345 GNUNET_ARM_disconnect (h);
350 h = GNUNET_ARM_connect (cfg, NULL);
353 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
354 _("Fatal error initializing ARM API.\n"));
358 GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
364 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
365 "Going to list all running services controlled by ARM.\n");
369 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
370 _("Fatal error initializing ARM API.\n"));
374 GNUNET_ARM_list_running_services (h,
376 timeout.rel_value) ? LIST_TIMEOUT :
377 timeout, &list_cb, NULL);
381 default: /* last phase */
382 GNUNET_ARM_disconnect (h);
383 if ((end == GNUNET_YES) && (delete == GNUNET_YES))
392 * The main function to obtain arm from gnunetd.
394 * @param argc number of arguments from the command line
395 * @param argv command line arguments
396 * @return 0 ok, 1 on error
399 main (int argc, char *const *argv)
401 static unsigned long long temp_timeout_ms;
403 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
404 {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
405 GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
406 {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
407 GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
408 {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
409 GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
410 {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
411 GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
412 {'r', "restart", NULL,
413 gettext_noop ("stop and start all GNUnet default services"),
414 GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
415 {'d', "delete", NULL,
416 gettext_noop ("delete config file and directory on exit"),
417 GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
418 {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
419 GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
420 {'T', "timeout", NULL,
421 gettext_noop ("timeout for completing current operation"),
422 GNUNET_YES, &GNUNET_GETOPT_set_ulong, &temp_timeout_ms},
423 {'I', "info", NULL, gettext_noop ("List currently running services"),
424 GNUNET_NO, &GNUNET_GETOPT_set_one, &list},
425 GNUNET_GETOPT_OPTION_END
428 if (temp_timeout_ms > 0)
429 timeout.rel_value = temp_timeout_ms;
431 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
435 GNUNET_PROGRAM_run (argc, argv, "gnunet-arm",
437 ("Control services and the Automated Restart Manager (ARM)"),
438 options, &run, NULL))
446 /* end of gnunet-arm.c */