2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 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-service-arm.c
23 * @brief the automated restart manager service
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_arm_service.h"
29 #include "gnunet_protocols.h"
33 * How many messages do we queue up at most for optional
34 * notifications to a client? (this can cause notifications
35 * about outgoing messages to be dropped).
37 #define MAX_NOTIFY_QUEUE 1024
41 * List of our services.
47 * Record with information about a listen socket we have open.
49 struct ServiceListeningInfo
52 * This is a linked list.
54 struct ServiceListeningInfo *next;
57 * This is a linked list.
59 struct ServiceListeningInfo *prev;
62 * Address this socket is listening on.
64 struct sockaddr *service_addr;
67 * Service this listen socket is for.
69 struct ServiceList *sl;
72 * Number of bytes in 'service_addr'
74 socklen_t service_addr_len;
77 * Our listening socket.
79 struct GNUNET_NETWORK_Handle *listen_socket;
82 * Task doing the accepting.
84 GNUNET_SCHEDULER_TaskIdentifier accept_task;
90 * List of our services.
95 * This is a doubly-linked list.
97 struct ServiceList *next;
100 * This is a doubly-linked list.
102 struct ServiceList *prev;
105 * Linked list of listen sockets associated with this service.
107 struct ServiceListeningInfo *listen_head;
110 * Linked list of listen sockets associated with this service.
112 struct ServiceListeningInfo *listen_tail;
115 * Name of the service.
120 * Name of the binary used.
125 * Name of the configuration file used.
130 * Client to notify upon kill completion (waitpid), NULL
131 * if we should simply restart the process.
133 struct GNUNET_SERVER_Client *killing_client;
136 * ID of the request that killed the service (for reporting back).
138 uint64_t killing_client_request_id;
141 * Process structure pointer of the child.
143 struct GNUNET_OS_Process *proc;
146 * Process exponential backoff time
148 struct GNUNET_TIME_Relative backoff;
151 * Absolute time at which the process is scheduled to restart in case of death
153 struct GNUNET_TIME_Absolute restart_at;
156 * Time we asked the service to shut down (used to calculate time it took
157 * the service to terminate).
159 struct GNUNET_TIME_Absolute killed_at;
162 * Is this service to be started by default (or did a client tell us explicitly
163 * to start it)? #GNUNET_NO if the service is started only upon 'accept' on a
164 * listen socket or possibly explicitly by a client changing the value.
169 * Should we use pipes to signal this process? (YES for Java binaries and if we
176 * List of running services.
178 static struct ServiceList *running_head;
181 * List of running services.
183 static struct ServiceList *running_tail;
188 static const struct GNUNET_CONFIGURATION_Handle *cfg;
191 * Command to prepend to each actual command.
193 static char *prefix_command;
196 * Option to append to each actual command.
198 static char *final_option;
201 * ID of task called whenever we get a SIGCHILD.
203 static GNUNET_SCHEDULER_TaskIdentifier child_death_task;
206 * ID of task called whenever the timeout for restarting a child
209 static GNUNET_SCHEDULER_TaskIdentifier child_restart_task;
212 * Pipe used to communicate shutdown via signal.
214 static struct GNUNET_DISK_PipeHandle *sigpipe;
217 * Are we in shutdown mode?
219 static int in_shutdown;
222 * Are we starting user services?
224 static int start_user = GNUNET_YES;
227 * Are we starting system services?
229 static int start_system = GNUNET_YES;
232 * Handle to our server instance. Our server is a bit special in that
233 * its service is not immediately stopped once we get a shutdown
234 * request (since we need to continue service until all of our child
235 * processes are dead). This handle is used to shut down the server
236 * (and thus trigger process termination) once all child processes are
237 * also dead. A special option in the ARM configuration modifies the
238 * behaviour of the service implementation to not do the shutdown
241 static struct GNUNET_SERVER_Handle *server;
244 * Context for notifications we need to send to our clients.
246 static struct GNUNET_SERVER_NotificationContext *notifier;
249 #include "do_start_process.c"
252 * Transmit a status result message.
254 * @param cls a `unit16_t *` with message type
255 * @param size number of bytes available in @a buf
256 * @param buf where to copy the message, NULL on error
257 * @return number of bytes copied to @a buf
260 write_result (void *cls, size_t size, void *buf)
262 struct GNUNET_ARM_ResultMessage *msg = cls;
267 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
268 _("Could not send status result to client\n"));
270 return 0; /* error, not much we can do */
272 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
273 "Sending status response %u to client\n",
274 (unsigned int) msg->result);
275 msize = msg->arm_msg.header.size;
276 GNUNET_assert (size >= msize);
277 msg->arm_msg.header.size = htons (msg->arm_msg.header.size);
278 msg->arm_msg.header.type = htons (msg->arm_msg.header.type);
279 msg->result = htonl (msg->result);
280 msg->arm_msg.request_id = GNUNET_htonll (msg->arm_msg.request_id);
281 memcpy (buf, msg, msize);
288 * Transmit the list of running services.
290 * @param cls pointer to `struct GNUNET_ARM_ListResultMessage` with the message
291 * @param size number of bytes available in @a buf
292 * @param buf where to copy the message, NULL on error
293 * @return number of bytes copied to @a buf
296 write_list_result (void *cls, size_t size, void *buf)
298 struct GNUNET_ARM_ListResultMessage *msg = cls;
303 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
304 _("Could not send list result to client\n"));
306 return 0; /* error, not much we can do */
309 rslt_size = msg->arm_msg.header.size;
310 GNUNET_assert (size >= rslt_size);
311 msg->arm_msg.header.size = htons (msg->arm_msg.header.size);
312 msg->arm_msg.header.type = htons (msg->arm_msg.header.type);
313 msg->arm_msg.request_id = GNUNET_htonll (msg->arm_msg.request_id);
314 msg->count = htons (msg->count);
316 memcpy (buf, msg, rslt_size);
323 * Signal our client that we will start or stop the
326 * @param client who is being signalled
327 * @param name name of the service
328 * @param request_id id of the request that is being responded to.
329 * @param result message type to send
330 * @return NULL if it was not found
333 signal_result (struct GNUNET_SERVER_Client *client,
336 enum GNUNET_ARM_Result result)
338 struct GNUNET_ARM_ResultMessage *msg;
341 msize = sizeof (struct GNUNET_ARM_ResultMessage);
342 msg = GNUNET_malloc (msize);
343 msg->arm_msg.header.size = msize;
344 msg->arm_msg.header.type = GNUNET_MESSAGE_TYPE_ARM_RESULT;
345 msg->result = result;
346 msg->arm_msg.request_id = request_id;
348 GNUNET_SERVER_notify_transmit_ready (client, msize,
349 GNUNET_TIME_UNIT_FOREVER_REL,
355 * Tell all clients about status change of a service.
357 * @param name name of the service
358 * @param status message type to send
359 * @param unicast if not NULL, send to this client only.
360 * otherwise, send to all clients in the notifier
363 broadcast_status (const char *name,
364 enum GNUNET_ARM_ServiceStatus status,
365 struct GNUNET_SERVER_Client *unicast)
367 struct GNUNET_ARM_StatusMessage *msg;
370 if (NULL == notifier)
372 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
373 "Sending status %u of service `%s' to client\n",
374 (unsigned int) status, name);
375 namelen = strlen (name);
376 msg = GNUNET_malloc (sizeof (struct GNUNET_ARM_StatusMessage) + namelen + 1);
377 msg->header.size = htons (sizeof (struct GNUNET_ARM_StatusMessage) + namelen + 1);
378 msg->header.type = htons (GNUNET_MESSAGE_TYPE_ARM_STATUS);
379 msg->status = htonl ((uint32_t) (status));
380 memcpy ((char *) &msg[1], name, namelen + 1);
383 GNUNET_SERVER_notification_context_broadcast (notifier,
384 (struct GNUNET_MessageHeader *) msg, GNUNET_YES);
386 GNUNET_SERVER_notification_context_unicast (notifier, unicast,
387 (const struct GNUNET_MessageHeader *) msg, GNUNET_NO);
393 * Actually start the process for the given service.
395 * @param sl identifies service to start
396 * @param client that asked to start the service (may be NULL)
397 * @param request_id id of the request in response to which the process is
398 * being started. 0 if starting was not requested.
401 start_process (struct ServiceList *sl,
402 struct GNUNET_SERVER_Client *client,
413 struct ServiceListeningInfo *sli;
418 /* calculate listen socket list */
421 for (sli = sl->listen_head; NULL != sli; sli = sli->next)
423 GNUNET_array_append (lsocks, ls,
424 GNUNET_NETWORK_get_fd (sli->listen_socket));
425 if (sli->accept_task != GNUNET_SCHEDULER_NO_TASK)
427 GNUNET_SCHEDULER_cancel (sli->accept_task);
428 sli->accept_task = GNUNET_SCHEDULER_NO_TASK;
432 GNUNET_array_append (lsocks, ls, INVALID_SOCKET);
434 GNUNET_array_append (lsocks, ls, -1);
437 /* obtain configuration */
439 GNUNET_CONFIGURATION_get_value_string (cfg, sl->name, "PREFIX",
441 loprefix = GNUNET_strdup (prefix_command);
443 GNUNET_CONFIGURATION_get_value_string (cfg, sl->name, "OPTIONS",
446 options = GNUNET_strdup (final_option);
447 if (NULL == strstr (options, "%"))
449 /* replace '{}' with service name */
450 while (NULL != (optpos = strstr (options, "{}")))
454 GNUNET_asprintf (&optpos, options, sl->name);
455 GNUNET_free (options);
458 /* replace '$PATH' with value associated with "PATH" */
459 while (NULL != (optpos = strstr (options, "$")))
462 while (isupper ((unsigned char) *optend))
471 GNUNET_CONFIGURATION_get_value_string (cfg, "PATHS",
473 val = GNUNET_strdup ("");
475 GNUNET_asprintf (&optpos, "%s%s%c%s", options, val, b, next);
476 GNUNET_free (options);
482 use_debug = GNUNET_CONFIGURATION_get_value_yesno (cfg, sl->name, "DEBUG");
484 /* actually start process */
485 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
486 "Starting service `%s' using binary `%s' and configuration `%s'\n",
487 sl->name, sl->binary, sl->config);
488 binary = GNUNET_OS_get_libexec_binary_path (sl->binary);
489 GNUNET_assert (NULL == sl->proc);
490 if (GNUNET_YES == use_debug)
492 if (NULL == sl->config)
494 do_start_process (sl->pipe_control, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
495 lsocks, loprefix, binary, "-L",
496 "DEBUG", options, NULL);
499 do_start_process (sl->pipe_control, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
500 lsocks, loprefix, binary, "-c", sl->config, "-L",
501 "DEBUG", options, NULL);
505 if (NULL == sl->config)
507 do_start_process (sl->pipe_control, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
508 lsocks, loprefix, binary,
512 do_start_process (sl->pipe_control, GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
513 lsocks, loprefix, binary, "-c", sl->config,
516 GNUNET_free (binary);
517 if (sl->proc == NULL)
519 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Failed to start service `%s'\n"),
522 signal_result (client, sl->name, request_id, GNUNET_ARM_RESULT_START_FAILED);
526 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Starting service `%s'\n"),
528 broadcast_status (sl->name, GNUNET_ARM_SERVICE_STARTING, NULL);
530 signal_result (client, sl->name, request_id, GNUNET_ARM_RESULT_STARTING);
533 GNUNET_free (loprefix);
534 GNUNET_free (options);
535 GNUNET_array_grow (lsocks, ls, 0);
540 * Find the process with the given service
541 * name in the given list and return it.
543 * @param name which service entry to look up
544 * @return NULL if it was not found
546 static struct ServiceList *
547 find_service (const char *name)
549 struct ServiceList *sl;
554 if (0 == strcasecmp (sl->name, name))
563 * First connection has come to the listening socket associated with the service,
564 * create the service in order to relay the incoming connection to it
566 * @param cls callback data, `struct ServiceListeningInfo` describing a listen socket
570 accept_connection (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
572 struct ServiceListeningInfo *sli = cls;
573 struct ServiceList *sl = sli->sl;
575 sli->accept_task = GNUNET_SCHEDULER_NO_TASK;
576 GNUNET_assert (GNUNET_NO == in_shutdown);
577 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
579 start_process (sl, NULL, 0);
584 * Creating a listening socket for each of the service's addresses and
585 * wait for the first incoming connection to it
587 * @param sa address associated with the service
588 * @param addr_len length of @a sa
589 * @param sl service entry for the service in question
592 create_listen_socket (struct sockaddr *sa, socklen_t addr_len,
593 struct ServiceList *sl)
596 struct GNUNET_NETWORK_Handle *sock;
597 struct ServiceListeningInfo *sli;
603 switch (sa->sa_family)
606 sock = GNUNET_NETWORK_socket_create (PF_INET, SOCK_STREAM, 0);
609 sock = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
612 if (strcmp (GNUNET_a2s (sa, addr_len), "@") == 0) /* Do not bind to blank UNIX path! */
614 sock = GNUNET_NETWORK_socket_create (PF_UNIX, SOCK_STREAM, 0);
619 errno = EAFNOSUPPORT;
624 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
625 _("Unable to create socket for service `%s': %s\n"),
626 sl->name, STRERROR (errno));
630 if (GNUNET_NETWORK_socket_setsockopt
631 (sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof (on)) != GNUNET_OK)
632 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
635 if ((sa->sa_family == AF_INET6) &&
636 (GNUNET_NETWORK_socket_setsockopt
637 (sock, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof (on)) != GNUNET_OK))
638 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
643 GNUNET_NETWORK_socket_bind (sock, (const struct sockaddr *) sa, addr_len))
645 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
647 ("Unable to bind listening socket for service `%s' to address `%s': %s\n"),
648 sl->name, GNUNET_a2s (sa, addr_len), STRERROR (errno));
649 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
654 if (AF_UNIX == sa->sa_family)
657 GNUNET_CONFIGURATION_get_value_yesno (cfg, sl->name,
660 GNUNET_CONFIGURATION_get_value_yesno (cfg, sl->name,
662 GNUNET_DISK_fix_permissions (((const struct sockaddr_un *)sa)->sun_path,
668 if (GNUNET_NETWORK_socket_listen (sock, 5) != GNUNET_OK)
670 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
671 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
675 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
676 _("ARM now monitors connections to service `%s' at `%s'\n"),
677 sl->name, GNUNET_a2s (sa, addr_len));
678 sli = GNUNET_new (struct ServiceListeningInfo);
679 sli->service_addr = sa;
680 sli->service_addr_len = addr_len;
681 sli->listen_socket = sock;
684 GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL, sock,
685 &accept_connection, sli);
686 GNUNET_CONTAINER_DLL_insert (sl->listen_head, sl->listen_tail, sli);
691 * Remove and free an entry in the service list. Listen sockets
692 * must have already been cleaned up. Only to be called during shutdown.
694 * @param sl entry to free
697 free_service (struct ServiceList *sl)
699 GNUNET_assert (GNUNET_YES == in_shutdown);
700 GNUNET_CONTAINER_DLL_remove (running_head, running_tail, sl);
701 GNUNET_assert (NULL == sl->listen_head);
702 GNUNET_free_non_null (sl->config);
703 GNUNET_free_non_null (sl->binary);
704 GNUNET_free (sl->name);
710 * Handle START-message.
712 * @param cls closure (always NULL)
713 * @param client identification of the client
714 * @param message the actual message
715 * @return #GNUNET_OK to keep the connection open,
716 * #GNUNET_SYSERR to close it (signal serious error)
719 handle_start (void *cls, struct GNUNET_SERVER_Client *client,
720 const struct GNUNET_MessageHeader *message)
722 const char *servicename;
723 struct ServiceList *sl;
726 struct GNUNET_ARM_Message *amsg;
728 amsg = (struct GNUNET_ARM_Message *) message;
729 request_id = GNUNET_ntohll (amsg->request_id);
730 size = ntohs (amsg->header.size);
731 size -= sizeof (struct GNUNET_ARM_Message);
732 servicename = (const char *) &amsg[1];
733 if ((size == 0) || (servicename[size - 1] != '\0'))
736 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
739 if (GNUNET_YES == in_shutdown)
741 signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_IN_SHUTDOWN);
742 GNUNET_SERVER_receive_done (client, GNUNET_OK);
745 sl = find_service (servicename);
748 signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_IS_NOT_KNOWN);
749 GNUNET_SERVER_receive_done (client, GNUNET_OK);
752 sl->is_default = GNUNET_YES;
753 if (sl->proc != NULL)
755 signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_IS_STARTED_ALREADY);
756 GNUNET_SERVER_receive_done (client, GNUNET_OK);
759 start_process (sl, client, request_id);
760 GNUNET_SERVER_receive_done (client, GNUNET_OK);
765 * Start a shutdown sequence.
767 * @param cls closure (refers to service)
768 * @param tc task context
771 trigger_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
773 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Triggering shutdown\n");
774 GNUNET_SCHEDULER_shutdown ();
779 * Handle STOP-message.
781 * @param cls closure (always NULL)
782 * @param client identification of the client
783 * @param message the actual message
784 * @return #GNUNET_OK to keep the connection open,
785 * #GNUNET_SYSERR to close it (signal serious error)
788 handle_stop (void *cls, struct GNUNET_SERVER_Client *client,
789 const struct GNUNET_MessageHeader *message)
791 struct ServiceList *sl;
792 const char *servicename;
795 struct GNUNET_ARM_Message *amsg;
797 amsg = (struct GNUNET_ARM_Message *) message;
798 request_id = GNUNET_ntohll (amsg->request_id);
799 size = ntohs (amsg->header.size);
800 size -= sizeof (struct GNUNET_ARM_Message);
801 servicename = (const char *) &amsg[1];
802 if ((size == 0) || (servicename[size - 1] != '\0'))
805 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
808 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
809 _("Preparing to stop `%s'\n"), servicename);
810 if (0 == strcasecmp (servicename, "arm"))
812 broadcast_status (servicename, GNUNET_ARM_SERVICE_STOPPING, NULL);
813 signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_STOPPING);
814 GNUNET_SERVER_client_persist_ (client);
815 GNUNET_SCHEDULER_add_now (trigger_shutdown, NULL);
816 GNUNET_SERVER_receive_done (client, GNUNET_OK);
819 sl = find_service (servicename);
822 signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_IS_NOT_KNOWN);
823 GNUNET_SERVER_receive_done (client, GNUNET_OK);
826 sl->is_default = GNUNET_NO;
827 if (GNUNET_YES == in_shutdown)
829 /* shutdown in progress */
830 signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_IN_SHUTDOWN);
831 GNUNET_SERVER_receive_done (client, GNUNET_OK);
834 if (sl->killing_client != NULL)
836 /* killing already in progress */
837 signal_result (client, servicename, request_id,
838 GNUNET_ARM_RESULT_IS_STOPPING_ALREADY);
839 GNUNET_SERVER_receive_done (client, GNUNET_OK);
842 if (sl->proc == NULL)
844 /* process is down */
845 signal_result (client, servicename, request_id,
846 GNUNET_ARM_RESULT_IS_STOPPED_ALREADY);
847 GNUNET_SERVER_receive_done (client, GNUNET_OK);
850 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
851 "Sending kill signal to service `%s', waiting for process to die.\n",
853 broadcast_status (servicename, GNUNET_ARM_SERVICE_STOPPING, NULL);
854 /* no signal_start - only when it's STOPPED */
855 sl->killed_at = GNUNET_TIME_absolute_get ();
856 if (0 != GNUNET_OS_process_kill (sl->proc, GNUNET_TERM_SIG))
857 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
858 sl->killing_client = client;
859 sl->killing_client_request_id = request_id;
860 GNUNET_SERVER_client_keep (client);
861 GNUNET_SERVER_receive_done (client, GNUNET_OK);
866 * Handle LIST-message.
868 * @param cls closure (always NULL)
869 * @param client identification of the client
870 * @param message the actual message
873 handle_list (void *cls, struct GNUNET_SERVER_Client *client,
874 const struct GNUNET_MessageHeader *message)
876 struct GNUNET_ARM_ListResultMessage *msg;
877 struct GNUNET_ARM_Message *request;
878 size_t string_list_size;
880 struct ServiceList *sl;
886 request = (struct GNUNET_ARM_Message *) message;
888 string_list_size = 0;
889 /* first count the running processes get their name's size */
890 for (sl = running_head; sl != NULL; sl = sl->next)
892 if (sl->proc != NULL)
894 string_list_size += strlen (sl->name);
895 string_list_size += strlen (sl->binary);
896 string_list_size += 4;
901 total_size = sizeof (struct GNUNET_ARM_ListResultMessage)
903 msg = GNUNET_malloc (total_size);
904 msg->arm_msg.header.size = total_size;
905 msg->arm_msg.header.type = GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT;
906 msg->arm_msg.request_id = GNUNET_ntohll (request->request_id);
909 char *pos = (char *)&msg[1];
910 for (sl = running_head; sl != NULL; sl = sl->next)
912 if (sl->proc != NULL)
914 size_t s = strlen (sl->name) + strlen (sl->binary) + 4;
915 GNUNET_snprintf(pos, s, "%s (%s)", sl->name, sl->binary);
920 GNUNET_SERVER_notify_transmit_ready (client,
922 GNUNET_TIME_UNIT_FOREVER_REL,
923 write_list_result, msg);
924 GNUNET_SERVER_receive_done (client, GNUNET_OK);
929 * We are done with everything. Stop remaining
930 * tasks, signal handler and the server.
935 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Last shutdown phase\n");
936 if (NULL != notifier)
938 GNUNET_SERVER_notification_context_destroy (notifier);
943 GNUNET_SERVER_destroy (server);
946 if (GNUNET_SCHEDULER_NO_TASK != child_death_task)
948 GNUNET_SCHEDULER_cancel (child_death_task);
949 child_death_task = GNUNET_SCHEDULER_NO_TASK;
955 list_count (struct ServiceList *running_head)
957 struct ServiceList *i;
958 unsigned int res = 0;
960 for (res = 0, i = running_head; i; i = i->next, res++)
961 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
969 * Task run for shutdown.
971 * @param cls closure, NULL if we need to self-restart
975 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
977 struct ServiceList *pos;
978 struct ServiceList *nxt;
979 struct ServiceListeningInfo *sli;
981 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
982 "First shutdown phase\n");
983 if (GNUNET_SCHEDULER_NO_TASK != child_restart_task)
985 GNUNET_SCHEDULER_cancel (child_restart_task);
986 child_restart_task = GNUNET_SCHEDULER_NO_TASK;
988 in_shutdown = GNUNET_YES;
989 /* first, stop listening */
990 for (pos = running_head; NULL != pos; pos = pos->next)
992 while (NULL != (sli = pos->listen_head))
994 GNUNET_CONTAINER_DLL_remove (pos->listen_head,
995 pos->listen_tail, sli);
996 if (sli->accept_task != GNUNET_SCHEDULER_NO_TASK)
998 GNUNET_SCHEDULER_cancel (sli->accept_task);
999 sli->accept_task = GNUNET_SCHEDULER_NO_TASK;
1001 GNUNET_break (GNUNET_OK ==
1002 GNUNET_NETWORK_socket_close (sli->listen_socket));
1003 GNUNET_free (sli->service_addr);
1007 /* then, shutdown all existing service processes */
1009 while (NULL != (pos = nxt))
1012 if (pos->proc != NULL)
1014 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1015 "Stopping service `%s'\n",
1017 pos->killed_at = GNUNET_TIME_absolute_get ();
1018 if (0 != GNUNET_OS_process_kill (pos->proc, GNUNET_TERM_SIG))
1019 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
1026 /* finally, should all service processes be already gone, terminate for real */
1027 if (running_head == NULL)
1030 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1031 "Delaying shutdown, have %u childs still running\n",
1032 list_count (running_head));
1037 * Task run whenever it is time to restart a child that died.
1039 * @param cls closure, always NULL
1043 delayed_restart_task (void *cls,
1044 const struct GNUNET_SCHEDULER_TaskContext *tc)
1046 struct ServiceList *sl;
1047 struct GNUNET_TIME_Relative lowestRestartDelay;
1048 struct ServiceListeningInfo *sli;
1050 child_restart_task = GNUNET_SCHEDULER_NO_TASK;
1051 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1053 GNUNET_assert (GNUNET_NO == in_shutdown);
1054 lowestRestartDelay = GNUNET_TIME_UNIT_FOREVER_REL;
1056 /* check for services that need to be restarted due to
1057 * configuration changes or because the last restart failed */
1058 for (sl = running_head; NULL != sl; sl = sl->next)
1060 if (NULL != sl->proc)
1062 /* service is currently not running */
1063 if (0 == GNUNET_TIME_absolute_get_remaining (sl->restart_at).rel_value_us)
1065 /* restart is now allowed */
1068 /* process should run by default, start immediately */
1069 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1070 _("Restarting service `%s'.\n"), sl->name);
1071 start_process (sl, NULL, 0);
1075 /* process is run on-demand, ensure it is re-started if there is demand */
1076 for (sli = sl->listen_head; NULL != sli; sli = sli->next)
1077 if (GNUNET_SCHEDULER_NO_TASK == sli->accept_task)
1079 /* accept was actually paused, so start it again */
1081 GNUNET_SCHEDULER_add_read_net
1082 (GNUNET_TIME_UNIT_FOREVER_REL, sli->listen_socket,
1083 &accept_connection, sli);
1089 /* update calculation for earliest time to reactivate a service */
1090 lowestRestartDelay =
1091 GNUNET_TIME_relative_min (lowestRestartDelay,
1092 GNUNET_TIME_absolute_get_remaining
1096 if (lowestRestartDelay.rel_value_us != GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
1098 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1099 "Will restart process in %s\n",
1100 GNUNET_STRINGS_relative_time_to_string (lowestRestartDelay, GNUNET_YES));
1101 child_restart_task =
1102 GNUNET_SCHEDULER_add_delayed_with_priority (lowestRestartDelay,
1103 GNUNET_SCHEDULER_PRIORITY_IDLE,
1104 &delayed_restart_task, NULL);
1110 * Task triggered whenever we receive a SIGCHLD (child
1113 * @param cls closure, NULL if we need to self-restart
1117 maint_child_death (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1119 struct ServiceList *pos;
1120 struct ServiceList *next;
1121 struct ServiceListeningInfo *sli;
1122 const char *statstr;
1126 enum GNUNET_OS_ProcessStatusType statusType;
1127 unsigned long statusCode;
1128 const struct GNUNET_DISK_FileHandle *pr;
1130 pr = GNUNET_DISK_pipe_handle (sigpipe, GNUNET_DISK_PIPE_END_READ);
1131 child_death_task = GNUNET_SCHEDULER_NO_TASK;
1132 if (0 == (tc->reason & GNUNET_SCHEDULER_REASON_READ_READY))
1134 /* shutdown scheduled us, ignore! */
1136 GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1137 pr, &maint_child_death, NULL);
1140 /* consume the signal */
1141 GNUNET_break (0 < GNUNET_DISK_file_read (pr, &c, sizeof (c)));
1143 /* check for services that died (WAITPID) */
1144 next = running_head;
1145 while (NULL != (pos = next))
1149 if (pos->proc == NULL)
1151 if (GNUNET_YES == in_shutdown)
1155 if ((GNUNET_SYSERR ==
1157 GNUNET_OS_process_status (pos->proc, &statusType, &statusCode)))
1158 || ((ret == GNUNET_NO) || (statusType == GNUNET_OS_PROCESS_STOPPED)
1159 || (statusType == GNUNET_OS_PROCESS_RUNNING)))
1161 if (statusType == GNUNET_OS_PROCESS_EXITED)
1163 statstr = _( /* process termination method */ "exit");
1164 statcode = statusCode;
1166 else if (statusType == GNUNET_OS_PROCESS_SIGNALED)
1168 statstr = _( /* process termination method */ "signal");
1169 statcode = statusCode;
1173 statstr = _( /* process termination method */ "unknown");
1176 if (0 != pos->killed_at.abs_value_us)
1178 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1179 _("Service `%s' took %s to terminate\n"),
1181 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (pos->killed_at), GNUNET_YES));
1183 GNUNET_OS_process_destroy (pos->proc);
1185 broadcast_status (pos->name, GNUNET_ARM_SERVICE_STOPPED, NULL);
1186 if (NULL != pos->killing_client)
1188 signal_result (pos->killing_client, pos->name,
1189 pos->killing_client_request_id, GNUNET_ARM_RESULT_STOPPED);
1190 GNUNET_SERVER_client_drop (pos->killing_client);
1191 pos->killing_client = NULL;
1192 pos->killing_client_request_id = 0;
1194 if (GNUNET_YES != in_shutdown)
1196 if ((statusType == GNUNET_OS_PROCESS_EXITED) && (statcode == 0))
1198 /* process terminated normally, allow restart at any time */
1199 pos->restart_at.abs_value_us = 0;
1200 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1201 _("Service `%s' terminated normally, will restart at any time\n"),
1203 /* process can still be re-started on-demand, ensure it is re-started if there is demand */
1204 for (sli = pos->listen_head; NULL != sli; sli = sli->next)
1206 GNUNET_break (GNUNET_SCHEDULER_NO_TASK == sli->accept_task);
1208 GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
1209 sli->listen_socket, &accept_connection, sli);
1214 if (0 == (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1215 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1216 _("Service `%s' terminated with status %s/%d, will restart in %s\n"),
1217 pos->name, statstr, statcode,
1218 GNUNET_STRINGS_relative_time_to_string (pos->backoff, GNUNET_YES));
1219 /* schedule restart */
1220 pos->restart_at = GNUNET_TIME_relative_to_absolute (pos->backoff);
1221 pos->backoff = GNUNET_TIME_STD_BACKOFF (pos->backoff);
1222 if (GNUNET_SCHEDULER_NO_TASK != child_restart_task)
1223 GNUNET_SCHEDULER_cancel (child_restart_task);
1224 child_restart_task = GNUNET_SCHEDULER_add_with_priority (
1225 GNUNET_SCHEDULER_PRIORITY_IDLE, &delayed_restart_task, NULL);
1233 child_death_task = GNUNET_SCHEDULER_add_read_file (
1234 GNUNET_TIME_UNIT_FOREVER_REL, pr, &maint_child_death, NULL);
1235 if ((NULL == running_head) && (GNUNET_YES == in_shutdown))
1237 else if (GNUNET_YES == in_shutdown)
1238 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1239 "Delaying shutdown after child's death, still have %u children\n",
1240 list_count (running_head));
1246 * Signal handler called for SIGCHLD. Triggers the
1247 * respective handler by writing to the trigger pipe.
1250 sighandler_child_death ()
1253 int old_errno = errno; /* back-up errno */
1256 GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
1257 (sigpipe, GNUNET_DISK_PIPE_END_WRITE),
1259 errno = old_errno; /* restore errno */
1264 * Setup our service record for the given section in the configuration file
1265 * (assuming the section is for a service).
1268 * @param section a section in the configuration file
1269 * @return #GNUNET_OK (continue)
1272 setup_service (void *cls, const char *section)
1274 struct ServiceList *sl;
1278 struct sockaddr **addrs;
1279 socklen_t *addr_lens;
1283 if (strcasecmp (section, "arm") == 0)
1286 GNUNET_CONFIGURATION_get_value_string (cfg, section, "BINARY", &binary))
1288 /* not a service section */
1292 GNUNET_CONFIGURATION_have_value (cfg, section, "USER_SERVICE")) &&
1294 GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "USER_SERVICE")))
1296 if (GNUNET_NO == start_user)
1297 return; /* user service, and we don't deal with those */
1301 if (GNUNET_NO == start_system)
1302 return; /* system service, and we don't deal with those */
1304 sl = find_service (section);
1307 /* got the same section twice!? */
1309 GNUNET_free (binary);
1314 GNUNET_CONFIGURATION_get_value_filename (cfg, section, "CONFIG",
1317 GNUNET_CONFIGURATION_get_value_filename (cfg, "PATHS", "DEFAULTCONFIG",
1319 (0 != STAT (config, &sbuf)))
1323 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1326 GNUNET_free (config);
1330 sl = GNUNET_new (struct ServiceList);
1331 sl->name = GNUNET_strdup (section);
1332 sl->binary = binary;
1333 sl->config = config;
1334 sl->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
1335 sl->restart_at = GNUNET_TIME_UNIT_FOREVER_ABS;
1337 sl->pipe_control = GNUNET_YES;
1339 if (GNUNET_CONFIGURATION_have_value (cfg, section, "PIPECONTROL"))
1340 sl->pipe_control = GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "PIPECONTROL");
1342 GNUNET_CONTAINER_DLL_insert (running_head, running_tail, sl);
1345 GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "AUTOSTART"))
1347 if (0 >= (ret = GNUNET_SERVICE_get_server_addresses (section, cfg,
1348 &addrs, &addr_lens)))
1350 /* this will free (or capture) addrs[i] */
1351 for (i = 0; i < ret; i++)
1352 create_listen_socket (addrs[i], addr_lens[i], sl);
1353 GNUNET_free (addrs);
1354 GNUNET_free (addr_lens);
1359 * A client connected, add it to the notification context.
1361 * @param cls closure
1362 * @param client identification of the client
1365 handle_client_connecting (void *cls, struct GNUNET_SERVER_Client *client)
1367 /* All clients are considered to be of the "monitor" kind
1368 * (that is, they don't affect ARM shutdown).
1371 GNUNET_SERVER_client_mark_monitor (client);
1376 * Handle MONITOR-message.
1378 * @param cls closure (always NULL)
1379 * @param client identification of the client
1380 * @param message the actual message
1381 * @return #GNUNET_OK to keep the connection open,
1382 * #GNUNET_SYSERR to close it (signal serious error)
1385 handle_monitor (void *cls, struct GNUNET_SERVER_Client *client,
1386 const struct GNUNET_MessageHeader *message)
1388 /* Removal is handled by the server implementation, internally. */
1389 if ((NULL != client) && (NULL != notifier))
1391 GNUNET_SERVER_notification_context_add (notifier, client);
1392 broadcast_status ("arm", GNUNET_ARM_SERVICE_MONITORING_STARTED, client);
1393 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1399 * Process arm requests.
1401 * @param cls closure
1402 * @param serv the initialized server
1403 * @param c configuration to use
1406 run (void *cls, struct GNUNET_SERVER_Handle *serv,
1407 const struct GNUNET_CONFIGURATION_Handle *c)
1409 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1410 {&handle_start, NULL, GNUNET_MESSAGE_TYPE_ARM_START, 0},
1411 {&handle_stop, NULL, GNUNET_MESSAGE_TYPE_ARM_STOP, 0},
1412 {&handle_monitor, NULL, GNUNET_MESSAGE_TYPE_ARM_MONITOR,
1413 sizeof (struct GNUNET_MessageHeader)},
1414 {&handle_list, NULL, GNUNET_MESSAGE_TYPE_ARM_LIST,
1415 sizeof (struct GNUNET_ARM_Message)},
1418 char *defaultservices;
1420 struct ServiceList *sl;
1424 GNUNET_assert (serv != NULL);
1425 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
1428 GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1429 GNUNET_DISK_pipe_handle (sigpipe,
1430 GNUNET_DISK_PIPE_END_READ),
1431 &maint_child_death, NULL);
1434 GNUNET_CONFIGURATION_get_value_string (cfg, "ARM", "GLOBAL_PREFIX",
1436 prefix_command = GNUNET_strdup ("");
1438 GNUNET_CONFIGURATION_get_value_string (cfg, "ARM", "GLOBAL_POSTFIX",
1440 final_option = GNUNET_strdup ("");
1442 GNUNET_CONFIGURATION_get_value_yesno (cfg, "ARM", "USER_ONLY"))
1444 GNUNET_break (GNUNET_YES == start_user);
1445 start_system = GNUNET_NO;
1449 GNUNET_CONFIGURATION_get_value_yesno (cfg, "ARM", "SYSTEM_ONLY"))
1451 GNUNET_break (GNUNET_YES == start_system);
1452 start_user = GNUNET_NO;
1455 GNUNET_CONFIGURATION_iterate_sections (cfg, &setup_service, NULL);
1457 /* start default services... */
1459 GNUNET_CONFIGURATION_get_value_string (cfg, "ARM", "DEFAULTSERVICES",
1462 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1463 _("Starting default services `%s'\n"), defaultservices);
1464 if (0 < strlen (defaultservices))
1466 for (pos = strtok (defaultservices, " "); NULL != pos;
1467 pos = strtok (NULL, " "))
1469 sl = find_service (pos);
1472 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1474 ("Default service `%s' not configured correctly!\n"),
1478 sl->is_default = GNUNET_YES;
1479 start_process (sl, NULL, 0);
1482 GNUNET_free (defaultservices);
1486 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1488 ("No default services configured, GNUnet will not really start right now.\n"));
1492 GNUNET_SERVER_notification_context_create (server, MAX_NOTIFY_QUEUE);
1493 GNUNET_SERVER_connect_notify (server, handle_client_connecting, NULL);
1494 /* process client requests */
1495 GNUNET_SERVER_add_handlers (server, handlers);
1500 * The main function for the arm service.
1502 * @param argc number of arguments from the command line
1503 * @param argv command line arguments
1504 * @return 0 ok, 1 on error
1507 main (int argc, char *const *argv)
1510 struct GNUNET_SIGNAL_Context *shc_chld;
1512 sigpipe = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_NO, GNUNET_NO);
1513 GNUNET_assert (sigpipe != NULL);
1515 GNUNET_SIGNAL_handler_install (GNUNET_SIGCHLD, &sighandler_child_death);
1518 GNUNET_SERVICE_run (argc, argv, "arm",
1519 GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN, &run, NULL)) ? 0 : 1;
1520 GNUNET_SIGNAL_handler_uninstall (shc_chld);
1522 GNUNET_DISK_pipe_close (sigpipe);
1532 * MINIMIZE heap size (way below 128k) since this process doesn't need much.
1534 void __attribute__ ((constructor)) GNUNET_ARM_memory_init ()
1536 mallopt (M_TRIM_THRESHOLD, 4 * 1024);
1537 mallopt (M_TOP_PAD, 1 * 1024);
1543 /* end of gnunet-service-arm.c */