2 This file is part of GNUnet.
3 (C) 2009, 2012, 2013 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;
114 * Monitor connection with ARM.
116 static struct GNUNET_ARM_MonitorHandle *m;
121 static struct GNUNET_CONFIGURATION_Handle *cfg;
124 * Processing stage that we are in. Simple counter.
126 static unsigned int phase;
129 * User defined timestamp for completing operations.
131 static struct GNUNET_TIME_Relative timeout;
134 * Do we want to give our stdout to gnunet-service-arm?
136 static unsigned int no_stdout;
139 * Do we want to give our stderr to gnunet-service-arm?
141 static unsigned int no_stderr;
145 * Attempts to delete configuration file and SERVICEHOME
146 * on arm shutdown provided the end and delete options
147 * were specified when gnunet-arm was run.
152 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
153 "Will attempt to remove configuration file %s and service directory %s\n",
156 if (UNLINK (config_file) != 0)
158 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
159 _("Failed to remove configuration file %s\n"), config_file);
162 if (GNUNET_DISK_directory_remove (dir) != GNUNET_OK)
164 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
165 _("Failed to remove servicehome directory %s\n"), dir);
172 * Main continuation-passing-style loop. Runs the various
173 * jobs that we've been asked to do in order.
175 * @param cls closure, unused
176 * @param tc context, unused
179 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
181 GNUNET_ARM_disconnect_and_free (h);
182 GNUNET_ARM_monitor_disconnect_and_free (m);
185 if ((end == GNUNET_YES) && (delete == GNUNET_YES))
187 GNUNET_CONFIGURATION_destroy (cfg);
193 * Returns a string interpretation of 'rs'
195 * @param rs the request status from ARM
196 * @return a string interpretation of the request status
199 req_string (enum GNUNET_ARM_RequestStatus rs)
203 case GNUNET_ARM_REQUEST_SENT_OK:
204 return _("Message was sent successfully");
205 case GNUNET_ARM_REQUEST_CONFIGURATION_ERROR:
206 return _("Misconfiguration (can't connect to the ARM service)");
207 case GNUNET_ARM_REQUEST_DISCONNECTED:
208 return _("We disconnected from ARM before we could send a request");
209 case GNUNET_ARM_REQUEST_BUSY:
210 return _("ARM API is busy");
211 case GNUNET_ARM_REQUEST_TOO_LONG:
212 return _("Request doesn't fit into a message");
213 case GNUNET_ARM_REQUEST_TIMEOUT:
214 return _("Request timed out");
216 return _("Unknown request status");
221 * Returns a string interpretation of the 'result'
223 * @param result the arm result
224 * @return a string interpretation
227 ret_string (enum GNUNET_ARM_Result result)
231 case GNUNET_ARM_RESULT_STOPPED:
232 return _("%s is stopped");
233 case GNUNET_ARM_RESULT_STARTING:
234 return _("%s is starting");
235 case GNUNET_ARM_RESULT_STOPPING:
236 return _("%s is stopping");
237 case GNUNET_ARM_RESULT_IS_STARTING_ALREADY:
238 return _("%s is starting already");
239 case GNUNET_ARM_RESULT_IS_STOPPING_ALREADY:
240 return _("%s is stopping already");
241 case GNUNET_ARM_RESULT_IS_STARTED_ALREADY:
242 return _("%s is started already");
243 case GNUNET_ARM_RESULT_IS_STOPPED_ALREADY:
244 return _("%s is stopped already");
245 case GNUNET_ARM_RESULT_IS_NOT_KNOWN:
246 return _("%s service is not known to ARM");
247 case GNUNET_ARM_RESULT_START_FAILED:
248 return _("%s service failed to start");
249 case GNUNET_ARM_RESULT_IN_SHUTDOWN:
250 return _("%s service can't be started because ARM is shutting down");
252 return _("%.s Unknown result code.");
255 static void action_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
258 * Function called whenever we connect to or disconnect from ARM.
261 * @param connected GNUNET_YES if connected, GNUNET_NO if disconnected,
262 * GNUNET_SYSERR on error.
265 conn_status (void *cls,
268 if (GNUNET_SYSERR == connected)
270 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
271 _("Fatal error initializing ARM API.\n"));
272 GNUNET_SCHEDULER_shutdown ();
277 GNUNET_SCHEDULER_add_now (action_loop, NULL);
283 term_callback (void *cls,
284 enum GNUNET_ARM_RequestStatus rs, const char *service,
285 enum GNUNET_ARM_Result result)
287 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
290 GNUNET_asprintf (&msg,
291 _("Failed to send a request to kill the `%s' service: %%s\n"),
293 FPRINTF (stdout, msg, req_string (rs));
295 GNUNET_SCHEDULER_shutdown ();
297 if ((GNUNET_ARM_RESULT_STOPPED == result) ||
298 (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY == result))
300 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Service %s shutdown successful\n", term);
302 GNUNET_SCHEDULER_add_now (action_loop, NULL);
307 GNUNET_asprintf (&msg, _("Failed to kill the `%s' service: %s\n"),
308 term, ret_string (result));
309 FPRINTF (stdout, msg, service);
311 GNUNET_SCHEDULER_shutdown ();
316 end_callback (void *cls,
317 enum GNUNET_ARM_RequestStatus rs, const char *service,
318 enum GNUNET_ARM_Result result)
320 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
323 GNUNET_asprintf (&msg, "%s", _("Failed to send a stop request to the ARM service: %s\n"));
324 FPRINTF (stdout, msg, req_string (rs));
326 GNUNET_SCHEDULER_shutdown ();
328 if ((GNUNET_ARM_RESULT_STOPPING == result) ||
329 (GNUNET_ARM_RESULT_STOPPED == result) ||
330 (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY == result))
332 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM service shutdown successful\n");
338 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Initiating an ARM restart\n");
340 GNUNET_SCHEDULER_add_now (action_loop, NULL);
345 GNUNET_asprintf (&msg, "%s", _("Failed to stop the ARM service: %s\n"));
346 FPRINTF (stdout, msg, ret_string (result));
348 GNUNET_SCHEDULER_shutdown ();
353 start_callback (void *cls,
354 enum GNUNET_ARM_RequestStatus rs, const char *service,
355 enum GNUNET_ARM_Result result)
359 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
361 GNUNET_asprintf (&msg, "%s", _("Failed to start the ARM service: %s\n"));
362 FPRINTF (stdout, msg, req_string (rs));
364 GNUNET_SCHEDULER_shutdown ();
367 if (! ((GNUNET_ARM_RESULT_STARTING == result) ||
368 (GNUNET_ARM_RESULT_IS_STARTED_ALREADY == result)) )
370 GNUNET_asprintf (&msg, "%s", _("Failed to start the ARM service: %s\n"));
371 FPRINTF (stdout, msg, ret_string (result));
373 GNUNET_SCHEDULER_shutdown ();
375 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM service [re]start successful\n");
377 GNUNET_SCHEDULER_add_now (action_loop, NULL);
383 init_callback (void *cls,
384 enum GNUNET_ARM_RequestStatus rs, const char *service,
385 enum GNUNET_ARM_Result result)
387 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
390 GNUNET_asprintf (&msg, _("Failed to send a request to start the `%s' service: %%s\n"), init);
391 FPRINTF (stdout, msg, req_string (rs));
393 GNUNET_SCHEDULER_shutdown ();
395 if ((GNUNET_ARM_RESULT_STARTING == result) ||
396 (GNUNET_ARM_RESULT_IS_STARTED_ALREADY == result))
398 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Service %s [re]start successful\n", init);
400 GNUNET_SCHEDULER_add_now (action_loop, NULL);
405 GNUNET_asprintf (&msg, _("Failed to start the `%s' service: %s\n"),
406 init, ret_string (result));
407 FPRINTF (stdout, msg, service);
409 GNUNET_SCHEDULER_shutdown ();
415 list_callback (void *cls,
416 enum GNUNET_ARM_RequestStatus rs, unsigned int count,
417 const char *const*list)
420 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
423 GNUNET_asprintf (&msg, "%s", _("Failed to request a list of services: %s\n"));
424 FPRINTF (stdout, msg, req_string (rs));
426 GNUNET_SCHEDULER_shutdown ();
430 FPRINTF (stderr, "%s", _("Error communicating with ARM. ARM not running?\n"));
433 FPRINTF (stdout, "%s", _("Running services:\n"));
434 for (i = 0; i < count; i++)
435 FPRINTF (stdout, "%s\n", list[i]);
436 GNUNET_SCHEDULER_add_now (action_loop, NULL);
441 * Main action loop. Runs the various
442 * jobs that we've been asked to do in order.
444 * @param cls closure, unused
445 * @param tc context, unused
448 action_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
450 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
452 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Running requested actions\n");
460 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Termination action\n");
461 GNUNET_ARM_request_service_stop (h, term, (0 ==
462 timeout.rel_value) ? STOP_TIMEOUT : timeout,
463 term_callback, NULL);
470 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "End action\n");
471 GNUNET_ARM_request_service_stop (h, "arm", (0 ==
472 timeout.rel_value) ? STOP_TIMEOUT_ARM : timeout,
480 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start action\n");
481 GNUNET_ARM_request_service_start (h, "arm",
482 (no_stdout ? 0 : GNUNET_OS_INHERIT_STD_OUT) |
483 (no_stderr ? 0 : GNUNET_OS_INHERIT_STD_ERR),
484 (0 == timeout.rel_value) ? START_TIMEOUT: timeout,
485 start_callback, NULL);
492 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Initialization action\n");
493 GNUNET_ARM_request_service_start (h, init, GNUNET_OS_INHERIT_STD_NONE,
494 (0 == timeout.rel_value) ? STOP_TIMEOUT : timeout,
495 init_callback, NULL);
502 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
503 "Going to list all running services controlled by ARM.\n");
505 GNUNET_ARM_request_service_list (h,
506 (0 == timeout.rel_value) ? LIST_TIMEOUT : timeout,
507 list_callback, &list);
511 default: /* last phase */
512 GNUNET_SCHEDULER_shutdown ();
520 * Function called when a service starts or stops.
523 * @param service service name
524 * @param status status of the service
527 srv_status (void *cls,
528 const char *service, enum GNUNET_ARM_ServiceStatus status)
533 case GNUNET_ARM_SERVICE_MONITORING_STARTED:
534 msg = _("Began monitoring ARM for service status changes\n");
536 case GNUNET_ARM_SERVICE_STOPPED:
537 msg = _("Stopped %s.\n");
539 case GNUNET_ARM_SERVICE_STARTING:
540 msg = _("Starting %s...\n");
542 case GNUNET_ARM_SERVICE_STOPPING:
543 msg = _("Stopping %s...\n");
550 FPRINTF (stderr, msg, service);
552 FPRINTF (stderr, _("Unknown status %u for service %s.\n"), status, service);
553 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got service %s status %u\n", service, status);
558 * Main function that will be run by the scheduler.
561 * @param args remaining command-line arguments
562 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
563 * @param c configuration
566 run (void *cls, char *const *args, const char *cfgfile,
567 const struct GNUNET_CONFIGURATION_Handle *c)
571 cfg = GNUNET_CONFIGURATION_dup (c);
572 config_file = cfgfile;
573 if (GNUNET_CONFIGURATION_get_value_string
574 (cfg, "PATHS", "SERVICEHOME", &dir) != GNUNET_OK)
576 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
577 "PATHS", "SERVICEHOME");
583 GNUNET_CONFIGURATION_get_value_filename (cfg, "arm", "CONFIG",
586 GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG",
590 GNUNET_free (armconfig);
592 h = GNUNET_ARM_connect (cfg, &conn_status, NULL);
595 m = GNUNET_ARM_monitor (cfg, &srv_status, NULL);
598 GNUNET_SCHEDULER_add_now (&action_loop, NULL);
599 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
600 shutdown_task, NULL);
604 GNUNET_ARM_disconnect_and_free (h);
612 * The main function to obtain arm from gnunetd.
614 * @param argc number of arguments from the command line
615 * @param argv command line arguments
616 * @return 0 ok, 1 on error
619 main (int argc, char *const *argv)
621 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
622 {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
623 GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
624 {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
625 GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
626 {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
627 GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
628 {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
629 GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
630 {'r', "restart", NULL,
631 gettext_noop ("stop and start all GNUnet default services"),
632 GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
633 {'d', "delete", NULL,
634 gettext_noop ("delete config file and directory on exit"),
635 GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
636 {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
637 GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
638 {'T', "timeout", "MSECS",
639 gettext_noop ("timeout in MSECS milliseconds for completing current operation"),
640 GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &timeout},
641 {'I', "info", NULL, gettext_noop ("list currently running services"),
642 GNUNET_NO, &GNUNET_GETOPT_set_one, &list},
643 {'O', "no-stdout", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard output"),
644 GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stdout},
645 {'E', "no-stderr", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard error"),
646 GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stderr},
647 GNUNET_GETOPT_OPTION_END
650 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
654 GNUNET_PROGRAM_run (argc, argv, "gnunet-arm",
656 ("Control services and the Automated Restart Manager (ARM)"),
657 options, &run, NULL))
659 GNUNET_free ((void *) argv);
662 GNUNET_free ((void*) argv);
666 /* end of gnunet-arm.c */