2 This file is part of GNUnet.
3 Copyright (C) 2009, 2012, 2013 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, 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 * Monitor ARM activity.
84 * Set if we should print a list of currently running services.
89 * Set to the name of a service to start.
94 * Set to the name of a service to kill.
99 * Set to the name of the config file used.
101 static const char *config_file;
104 * Set to the directory where runtime files are stored.
114 * Connection with ARM.
116 static struct GNUNET_ARM_Handle *h;
119 * Monitor connection with ARM.
121 static struct GNUNET_ARM_MonitorHandle *m;
126 static struct GNUNET_CONFIGURATION_Handle *cfg;
129 * Processing stage that we are in. Simple counter.
131 static unsigned int phase;
134 * User defined timestamp for completing operations.
136 static struct GNUNET_TIME_Relative timeout;
139 * Do we want to give our stdout to gnunet-service-arm?
141 static unsigned int no_stdout;
144 * Do we want to give our stderr to gnunet-service-arm?
146 static unsigned int no_stderr;
150 * Attempts to delete configuration file and GNUNET_HOME
151 * on ARM shutdown provided the end and delete options
152 * were specified when gnunet-arm was run.
157 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
158 "Will attempt to remove configuration file %s and service directory %s\n",
161 if (0 != UNLINK (config_file))
163 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
164 _("Failed to remove configuration file %s\n"),
167 if (GNUNET_OK != GNUNET_DISK_directory_remove (dir))
169 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
170 _("Failed to remove servicehome directory %s\n"),
178 * Main continuation-passing-style loop. Runs the various
179 * jobs that we've been asked to do in order.
181 * @param cls closure, unused
184 shutdown_task (void *cls)
188 GNUNET_ARM_disconnect_and_free (h);
193 GNUNET_ARM_monitor_disconnect_and_free (m);
196 if ((GNUNET_YES == end) && (GNUNET_YES == delete))
198 GNUNET_CONFIGURATION_destroy (cfg);
204 * Returns a string interpretation of 'rs'
206 * @param rs the request status from ARM
207 * @return a string interpretation of the request status
210 req_string (enum GNUNET_ARM_RequestStatus rs)
214 case GNUNET_ARM_REQUEST_SENT_OK:
215 return _("Message was sent successfully");
216 case GNUNET_ARM_REQUEST_CONFIGURATION_ERROR:
217 return _("Misconfiguration (can not connect to the ARM service)");
218 case GNUNET_ARM_REQUEST_DISCONNECTED:
219 return _("We disconnected from ARM before we could send a request");
220 case GNUNET_ARM_REQUEST_BUSY:
221 return _("ARM API is busy");
222 case GNUNET_ARM_REQUEST_TOO_LONG:
223 return _("Request does not fit into a message");
224 case GNUNET_ARM_REQUEST_TIMEOUT:
225 return _("Request timed out");
227 return _("Unknown request status");
232 * Returns a string interpretation of the 'result'
234 * @param result the arm result
235 * @return a string interpretation
238 ret_string (enum GNUNET_ARM_Result result)
242 case GNUNET_ARM_RESULT_STOPPED:
243 return _("%s is stopped");
244 case GNUNET_ARM_RESULT_STARTING:
245 return _("%s is starting");
246 case GNUNET_ARM_RESULT_STOPPING:
247 return _("%s is stopping");
248 case GNUNET_ARM_RESULT_IS_STARTING_ALREADY:
249 return _("%s is starting already");
250 case GNUNET_ARM_RESULT_IS_STOPPING_ALREADY:
251 return _("%s is stopping already");
252 case GNUNET_ARM_RESULT_IS_STARTED_ALREADY:
253 return _("%s is started already");
254 case GNUNET_ARM_RESULT_IS_STOPPED_ALREADY:
255 return _("%s is stopped already");
256 case GNUNET_ARM_RESULT_IS_NOT_KNOWN:
257 return _("%s service is not known to ARM");
258 case GNUNET_ARM_RESULT_START_FAILED:
259 return _("%s service failed to start");
260 case GNUNET_ARM_RESULT_IN_SHUTDOWN:
261 return _("%s service cannot be started because ARM is shutting down");
263 return _("%.s Unknown result code.");
268 * Main task that runs our various operations in order.
273 action_loop (void *cls);
277 * Function called whenever we connect to or disconnect from ARM.
278 * Termiantes the process if we fail to connect to the service on
282 * @param connected GNUNET_YES if connected, GNUNET_NO if disconnected,
283 * GNUNET_SYSERR on error.
286 conn_status (void *cls,
291 if ( (GNUNET_SYSERR == connected) &&
294 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
295 _("Fatal error initializing ARM API.\n"));
296 GNUNET_SCHEDULER_shutdown ();
304 * We have requested ARM to be started, this function
305 * is called with the result of the operation. Informs the
306 * use of the result; on success, we continue with the event
307 * loop, on failure we terminate the process.
309 * @param cls closure unused
310 * @param rs what happened to our request
311 * @param service name of the service we tried to start ("arm")
312 * @param result if the request was processed, this is the result
316 start_callback (void *cls,
317 enum GNUNET_ARM_RequestStatus rs, const char *service,
318 enum GNUNET_ARM_Result result)
322 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
324 GNUNET_asprintf (&msg, "%s", _("Failed to start the ARM service: %s\n"));
325 FPRINTF (stdout, msg, req_string (rs));
327 GNUNET_SCHEDULER_shutdown ();
330 if ( (GNUNET_ARM_RESULT_STARTING != result) &&
331 (GNUNET_ARM_RESULT_IS_STARTED_ALREADY != result) )
333 GNUNET_asprintf (&msg, "%s", _("Failed to start the ARM service: %s\n"));
334 FPRINTF (stdout, msg, ret_string (result));
336 GNUNET_SCHEDULER_shutdown ();
339 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM service [re]start successful\n");
341 GNUNET_SCHEDULER_add_now (action_loop, NULL);
346 * We have requested ARM to be stopped, this function
347 * is called with the result of the operation. Informs the
348 * use of the result; on success, we continue with the event
349 * loop, on failure we terminate the process.
351 * @param cls closure unused
352 * @param rs what happened to our request
353 * @param service name of the service we tried to start ("arm")
354 * @param result if the request was processed, this is the result
358 stop_callback (void *cls,
359 enum GNUNET_ARM_RequestStatus rs, const char *service,
360 enum GNUNET_ARM_Result result)
364 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
366 GNUNET_asprintf (&msg, "%s",
367 _("Failed to send a stop request to the ARM service: %s\n"));
368 FPRINTF (stdout, msg, req_string (rs));
370 GNUNET_SCHEDULER_shutdown ();
373 if ((GNUNET_ARM_RESULT_STOPPING != result) &&
374 (GNUNET_ARM_RESULT_STOPPED != result) &&
375 (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY != result))
377 GNUNET_asprintf (&msg, "%s", _("Failed to stop the ARM service: %s\n"));
378 FPRINTF (stdout, msg, ret_string (result));
380 GNUNET_SCHEDULER_shutdown ();
383 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
384 "ARM service shutdown successful\n");
390 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
391 "Initiating an ARM restart\n");
393 GNUNET_SCHEDULER_add_now (&action_loop, NULL);
398 * We have requested a service to be started, this function
399 * is called with the result of the operation. Informs the
400 * use of the result; on success, we continue with the event
401 * loop, on failure we terminate the process.
403 * @param cls closure unused
404 * @param rs what happened to our request
405 * @param service name of the service we tried to start
406 * @param result if the request was processed, this is the result
410 init_callback (void *cls,
411 enum GNUNET_ARM_RequestStatus rs, const char *service,
412 enum GNUNET_ARM_Result result)
416 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
418 GNUNET_asprintf (&msg,
419 _("Failed to send a request to start the `%s' service: %%s\n"),
421 FPRINTF (stdout, msg, req_string (rs));
423 GNUNET_SCHEDULER_shutdown ();
426 if ((GNUNET_ARM_RESULT_STARTING != result) &&
427 (GNUNET_ARM_RESULT_IS_STARTED_ALREADY != result))
429 GNUNET_asprintf (&msg, _("Failed to start the `%s' service: %s\n"),
430 init, ret_string (result));
431 FPRINTF (stdout, msg, service);
433 GNUNET_SCHEDULER_shutdown ();
436 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
437 "Service %s [re]started successfully\n",
441 GNUNET_SCHEDULER_add_now (&action_loop, NULL);
446 * We have requested a service to be stopped, this function
447 * is called with the result of the operation. Informs the
448 * use of the result; on success, we continue with the event
449 * loop, on failure we terminate the process.
451 * @param cls closure unused
452 * @param rs what happened to our request
453 * @param service name of the service we tried to start
454 * @param result if the request was processed, this is the result
458 term_callback (void *cls,
459 enum GNUNET_ARM_RequestStatus rs, const char *service,
460 enum GNUNET_ARM_Result result)
463 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
465 GNUNET_asprintf (&msg,
466 _("Failed to send a request to kill the `%s' service: %%s\n"),
468 FPRINTF (stdout, msg, req_string (rs));
470 GNUNET_SCHEDULER_shutdown ();
473 if ((GNUNET_ARM_RESULT_STOPPED != result) &&
474 (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY != result))
476 GNUNET_asprintf (&msg,
477 _("Failed to kill the `%s' service: %s\n"),
478 term, ret_string (result));
479 FPRINTF (stdout, msg, service);
481 GNUNET_SCHEDULER_shutdown ();
485 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
486 "Service %s stopped successfully\n",
490 GNUNET_SCHEDULER_add_now (&action_loop, NULL);
495 * Function called with the list of running services. Prints
496 * the list to stdout, then starts the event loop again.
497 * Prints an error message and terminates the process on errors.
499 * @param cls closure (unused)
500 * @param rs request status (success, failure, etc.)
501 * @param count number of services in the list
502 * @param list list of services that are running
505 list_callback (void *cls,
506 enum GNUNET_ARM_RequestStatus rs, unsigned int count,
507 const char *const*list)
511 if (GNUNET_ARM_REQUEST_SENT_OK != rs)
515 GNUNET_asprintf (&msg, "%s", _("Failed to request a list of services: %s\n"));
516 FPRINTF (stdout, msg, req_string (rs));
519 GNUNET_SCHEDULER_shutdown ();
523 FPRINTF (stderr, "%s", _("Error communicating with ARM. ARM not running?\n"));
524 GNUNET_SCHEDULER_shutdown ();
528 FPRINTF (stdout, "%s", _("Running services:\n"));
529 for (i = 0; i < count; i++)
530 FPRINTF (stdout, "%s\n", list[i]);
531 GNUNET_SCHEDULER_add_now (&action_loop, NULL);
536 * Main action loop. Runs the various jobs that we've been asked to
539 * @param cls closure, unused
542 action_loop (void *cls)
544 const struct GNUNET_SCHEDULER_TaskContext *tc;
546 tc = GNUNET_SCHEDULER_get_task_context ();
547 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
549 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Running requested actions\n");
557 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Termination action\n");
558 GNUNET_ARM_request_service_stop (h, term,
559 (0 == timeout.rel_value_us) ? STOP_TIMEOUT : timeout,
560 &term_callback, NULL);
567 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "End action\n");
568 GNUNET_ARM_request_service_stop (h, "arm",
569 (0 == timeout.rel_value_us) ? STOP_TIMEOUT_ARM : timeout,
570 &stop_callback, NULL);
577 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start action\n");
578 GNUNET_ARM_request_service_start (h, "arm",
579 (no_stdout ? 0 : GNUNET_OS_INHERIT_STD_OUT) |
580 (no_stderr ? 0 : GNUNET_OS_INHERIT_STD_ERR),
581 (0 == timeout.rel_value_us) ? START_TIMEOUT: timeout,
582 start_callback, NULL);
589 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Initialization action\n");
590 GNUNET_ARM_request_service_start (h, init, GNUNET_OS_INHERIT_STD_NONE,
591 (0 == timeout.rel_value_us) ? STOP_TIMEOUT : timeout,
592 &init_callback, NULL);
599 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
600 "Going to list all running services controlled by ARM.\n");
601 GNUNET_ARM_request_service_list (h,
602 (0 == timeout.rel_value_us) ? LIST_TIMEOUT : timeout,
603 &list_callback, &list);
612 _("Now only monitoring, press CTRL-C to stop.\n"));
613 quiet = 0; /* does not make sense to stay quiet in monitor mode at this time */
614 return; /* done with tasks, just monitor */
617 default: /* last phase */
618 GNUNET_SCHEDULER_shutdown ();
626 * Function called when a service starts or stops.
629 * @param service service name
630 * @param status status of the service
633 srv_status (void *cls,
634 const char *service, enum GNUNET_ARM_ServiceStatus status)
640 case GNUNET_ARM_SERVICE_MONITORING_STARTED:
641 return; /* this should be done silently */
642 case GNUNET_ARM_SERVICE_STOPPED:
643 msg = _("Stopped %s.\n");
645 case GNUNET_ARM_SERVICE_STARTING:
646 msg = _("Starting %s...\n");
648 case GNUNET_ARM_SERVICE_STOPPING:
649 msg = _("Stopping %s...\n");
658 FPRINTF (stderr, msg, service);
660 FPRINTF (stderr, _("Unknown status %u for service %s.\n"), status, service);
662 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got service %s status %d\n", service, (int) status);
667 * Main function that will be run by the scheduler.
670 * @param args remaining command-line arguments
671 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
672 * @param c configuration
678 const struct GNUNET_CONFIGURATION_Handle *c)
682 cfg = GNUNET_CONFIGURATION_dup (c);
683 config_file = cfgfile;
685 GNUNET_CONFIGURATION_get_value_string (cfg, "PATHS", "GNUNET_HOME", &dir))
687 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
688 "PATHS", "GNUNET_HOME");
694 GNUNET_CONFIGURATION_get_value_filename (cfg, "arm", "CONFIG",
697 GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG",
701 GNUNET_free (armconfig);
703 if (NULL == (h = GNUNET_ARM_connect (cfg, &conn_status, NULL)))
706 m = GNUNET_ARM_monitor (cfg, &srv_status, NULL);
707 GNUNET_SCHEDULER_add_now (&action_loop, NULL);
708 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
709 &shutdown_task, NULL);
714 * The main function to obtain arm from gnunetd.
716 * @param argc number of arguments from the command line
717 * @param argv command line arguments
718 * @return 0 ok, 1 on error
721 main (int argc, char *const *argv)
723 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
724 {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
725 GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
726 {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
727 GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
728 {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
729 GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
730 {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
731 GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
732 {'r', "restart", NULL,
733 gettext_noop ("stop and start all GNUnet default services"),
734 GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
735 {'d', "delete", NULL,
736 gettext_noop ("delete config file and directory on exit"),
737 GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
738 {'m', "monitor", NULL,
739 gettext_noop ("monitor ARM activities"),
740 GNUNET_NO, &GNUNET_GETOPT_set_one, &monitor},
741 {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
742 GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
743 {'T', "timeout", "DELAY",
744 gettext_noop ("exit with error status if operation does not finish after DELAY"),
745 GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &timeout},
746 {'I', "info", NULL, gettext_noop ("list currently running services"),
747 GNUNET_NO, &GNUNET_GETOPT_set_one, &list},
748 {'O', "no-stdout", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard output"),
749 GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stdout},
750 {'E', "no-stderr", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard error"),
751 GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stderr},
752 GNUNET_GETOPT_OPTION_END
755 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
759 GNUNET_PROGRAM_run (argc, argv, "gnunet-arm",
761 ("Control services and the Automated Restart Manager (ARM)"),
762 options, &run, NULL))
764 GNUNET_free ((void *) argv);
767 GNUNET_free ((void*) argv);
771 /* end of gnunet-arm.c */