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,
742 GNUNET_ARM_RESULT_IN_SHUTDOWN);
743 GNUNET_SERVER_receive_done (client, GNUNET_OK);
746 sl = find_service (servicename);
749 signal_result (client, servicename, request_id,
750 GNUNET_ARM_RESULT_IS_NOT_KNOWN);
751 GNUNET_SERVER_receive_done (client, GNUNET_OK);
754 sl->is_default = GNUNET_YES;
755 if (NULL != sl->proc)
757 signal_result (client, servicename, request_id,
758 GNUNET_ARM_RESULT_IS_STARTED_ALREADY);
759 GNUNET_SERVER_receive_done (client, GNUNET_OK);
762 start_process (sl, client, request_id);
763 GNUNET_SERVER_receive_done (client, GNUNET_OK);
768 * Start a shutdown sequence.
770 * @param cls closure (refers to service)
771 * @param tc task context
774 trigger_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
776 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Triggering shutdown\n");
777 GNUNET_SCHEDULER_shutdown ();
782 * Handle STOP-message.
784 * @param cls closure (always NULL)
785 * @param client identification of the client
786 * @param message the actual message
787 * @return #GNUNET_OK to keep the connection open,
788 * #GNUNET_SYSERR to close it (signal serious error)
791 handle_stop (void *cls, struct GNUNET_SERVER_Client *client,
792 const struct GNUNET_MessageHeader *message)
794 struct ServiceList *sl;
795 const char *servicename;
798 struct GNUNET_ARM_Message *amsg;
800 amsg = (struct GNUNET_ARM_Message *) message;
801 request_id = GNUNET_ntohll (amsg->request_id);
802 size = ntohs (amsg->header.size);
803 size -= sizeof (struct GNUNET_ARM_Message);
804 servicename = (const char *) &amsg[1];
805 if ((size == 0) || (servicename[size - 1] != '\0'))
808 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
811 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
812 _("Preparing to stop `%s'\n"),
814 if (0 == strcasecmp (servicename, "arm"))
816 broadcast_status (servicename, GNUNET_ARM_SERVICE_STOPPING, NULL);
817 signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_STOPPING);
818 GNUNET_SERVER_client_persist_ (client);
819 GNUNET_SCHEDULER_add_now (trigger_shutdown, NULL);
820 GNUNET_SERVER_receive_done (client, GNUNET_OK);
823 sl = find_service (servicename);
826 signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_IS_NOT_KNOWN);
827 GNUNET_SERVER_receive_done (client, GNUNET_OK);
830 sl->is_default = GNUNET_NO;
831 if (GNUNET_YES == in_shutdown)
833 /* shutdown in progress */
834 signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_IN_SHUTDOWN);
835 GNUNET_SERVER_receive_done (client, GNUNET_OK);
838 if (NULL != sl->killing_client)
840 /* killing already in progress */
841 signal_result (client, servicename, request_id,
842 GNUNET_ARM_RESULT_IS_STOPPING_ALREADY);
843 GNUNET_SERVER_receive_done (client, GNUNET_OK);
846 if (NULL == sl->proc)
848 /* process is down */
849 signal_result (client, servicename, request_id,
850 GNUNET_ARM_RESULT_IS_STOPPED_ALREADY);
851 GNUNET_SERVER_receive_done (client, GNUNET_OK);
854 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
855 "Sending kill signal to service `%s', waiting for process to die.\n",
857 broadcast_status (servicename, GNUNET_ARM_SERVICE_STOPPING, NULL);
858 /* no signal_start - only when it's STOPPED */
859 sl->killed_at = GNUNET_TIME_absolute_get ();
860 if (0 != GNUNET_OS_process_kill (sl->proc, GNUNET_TERM_SIG))
861 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
862 sl->killing_client = client;
863 sl->killing_client_request_id = request_id;
864 GNUNET_SERVER_client_keep (client);
865 GNUNET_SERVER_receive_done (client, GNUNET_OK);
870 * Handle LIST-message.
872 * @param cls closure (always NULL)
873 * @param client identification of the client
874 * @param message the actual message
877 handle_list (void *cls, struct GNUNET_SERVER_Client *client,
878 const struct GNUNET_MessageHeader *message)
880 struct GNUNET_ARM_ListResultMessage *msg;
881 struct GNUNET_ARM_Message *request;
882 size_t string_list_size;
884 struct ServiceList *sl;
890 request = (struct GNUNET_ARM_Message *) message;
891 GNUNET_break (0 == ntohl (request->reserved));
893 string_list_size = 0;
894 /* first count the running processes get their name's size */
895 for (sl = running_head; NULL != sl; sl = sl->next)
897 if (sl->proc != NULL)
899 string_list_size += strlen (sl->name);
900 string_list_size += strlen (sl->binary);
901 string_list_size += 4;
906 total_size = sizeof (struct GNUNET_ARM_ListResultMessage)
908 msg = GNUNET_malloc (total_size);
909 msg->arm_msg.header.size = total_size;
910 msg->arm_msg.header.type = GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT;
911 msg->arm_msg.reserved = htonl (0);
912 msg->arm_msg.request_id = GNUNET_ntohll (request->request_id);
915 char *pos = (char *)&msg[1];
916 for (sl = running_head; sl != NULL; sl = sl->next)
918 if (sl->proc != NULL)
920 size_t s = strlen (sl->name) + strlen (sl->binary) + 4;
921 GNUNET_snprintf(pos, s, "%s (%s)", sl->name, sl->binary);
926 GNUNET_SERVER_notify_transmit_ready (client,
928 GNUNET_TIME_UNIT_FOREVER_REL,
929 write_list_result, msg);
930 GNUNET_SERVER_receive_done (client, GNUNET_OK);
935 * We are done with everything. Stop remaining
936 * tasks, signal handler and the server.
941 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Last shutdown phase\n");
942 if (NULL != notifier)
944 GNUNET_SERVER_notification_context_destroy (notifier);
949 GNUNET_SERVER_destroy (server);
952 if (GNUNET_SCHEDULER_NO_TASK != child_death_task)
954 GNUNET_SCHEDULER_cancel (child_death_task);
955 child_death_task = GNUNET_SCHEDULER_NO_TASK;
961 list_count (struct ServiceList *running_head)
963 struct ServiceList *i;
964 unsigned int res = 0;
966 for (res = 0, i = running_head; i; i = i->next, res++)
967 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
975 * Task run for shutdown.
977 * @param cls closure, NULL if we need to self-restart
981 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
983 struct ServiceList *pos;
984 struct ServiceList *nxt;
985 struct ServiceListeningInfo *sli;
987 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
988 "First shutdown phase\n");
989 if (GNUNET_SCHEDULER_NO_TASK != child_restart_task)
991 GNUNET_SCHEDULER_cancel (child_restart_task);
992 child_restart_task = GNUNET_SCHEDULER_NO_TASK;
994 in_shutdown = GNUNET_YES;
995 /* first, stop listening */
996 for (pos = running_head; NULL != pos; pos = pos->next)
998 while (NULL != (sli = pos->listen_head))
1000 GNUNET_CONTAINER_DLL_remove (pos->listen_head,
1001 pos->listen_tail, sli);
1002 if (sli->accept_task != GNUNET_SCHEDULER_NO_TASK)
1004 GNUNET_SCHEDULER_cancel (sli->accept_task);
1005 sli->accept_task = GNUNET_SCHEDULER_NO_TASK;
1007 GNUNET_break (GNUNET_OK ==
1008 GNUNET_NETWORK_socket_close (sli->listen_socket));
1009 GNUNET_free (sli->service_addr);
1013 /* then, shutdown all existing service processes */
1015 while (NULL != (pos = nxt))
1018 if (pos->proc != NULL)
1020 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1021 "Stopping service `%s'\n",
1023 pos->killed_at = GNUNET_TIME_absolute_get ();
1024 if (0 != GNUNET_OS_process_kill (pos->proc, GNUNET_TERM_SIG))
1025 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
1032 /* finally, should all service processes be already gone, terminate for real */
1033 if (running_head == NULL)
1036 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1037 "Delaying shutdown, have %u childs still running\n",
1038 list_count (running_head));
1043 * Task run whenever it is time to restart a child that died.
1045 * @param cls closure, always NULL
1049 delayed_restart_task (void *cls,
1050 const struct GNUNET_SCHEDULER_TaskContext *tc)
1052 struct ServiceList *sl;
1053 struct GNUNET_TIME_Relative lowestRestartDelay;
1054 struct ServiceListeningInfo *sli;
1056 child_restart_task = GNUNET_SCHEDULER_NO_TASK;
1057 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1059 GNUNET_assert (GNUNET_NO == in_shutdown);
1060 lowestRestartDelay = GNUNET_TIME_UNIT_FOREVER_REL;
1062 /* check for services that need to be restarted due to
1063 * configuration changes or because the last restart failed */
1064 for (sl = running_head; NULL != sl; sl = sl->next)
1066 if (NULL != sl->proc)
1068 /* service is currently not running */
1069 if (0 == GNUNET_TIME_absolute_get_remaining (sl->restart_at).rel_value_us)
1071 /* restart is now allowed */
1074 /* process should run by default, start immediately */
1075 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1076 _("Restarting service `%s'.\n"), sl->name);
1077 start_process (sl, NULL, 0);
1081 /* process is run on-demand, ensure it is re-started if there is demand */
1082 for (sli = sl->listen_head; NULL != sli; sli = sli->next)
1083 if (GNUNET_SCHEDULER_NO_TASK == sli->accept_task)
1085 /* accept was actually paused, so start it again */
1087 GNUNET_SCHEDULER_add_read_net
1088 (GNUNET_TIME_UNIT_FOREVER_REL, sli->listen_socket,
1089 &accept_connection, sli);
1095 /* update calculation for earliest time to reactivate a service */
1096 lowestRestartDelay =
1097 GNUNET_TIME_relative_min (lowestRestartDelay,
1098 GNUNET_TIME_absolute_get_remaining
1102 if (lowestRestartDelay.rel_value_us != GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
1104 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1105 "Will restart process in %s\n",
1106 GNUNET_STRINGS_relative_time_to_string (lowestRestartDelay, GNUNET_YES));
1107 child_restart_task =
1108 GNUNET_SCHEDULER_add_delayed_with_priority (lowestRestartDelay,
1109 GNUNET_SCHEDULER_PRIORITY_IDLE,
1110 &delayed_restart_task, NULL);
1116 * Task triggered whenever we receive a SIGCHLD (child
1119 * @param cls closure, NULL if we need to self-restart
1123 maint_child_death (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1125 struct ServiceList *pos;
1126 struct ServiceList *next;
1127 struct ServiceListeningInfo *sli;
1128 const char *statstr;
1132 enum GNUNET_OS_ProcessStatusType statusType;
1133 unsigned long statusCode;
1134 const struct GNUNET_DISK_FileHandle *pr;
1136 pr = GNUNET_DISK_pipe_handle (sigpipe, GNUNET_DISK_PIPE_END_READ);
1137 child_death_task = GNUNET_SCHEDULER_NO_TASK;
1138 if (0 == (tc->reason & GNUNET_SCHEDULER_REASON_READ_READY))
1140 /* shutdown scheduled us, ignore! */
1142 GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1143 pr, &maint_child_death, NULL);
1146 /* consume the signal */
1147 GNUNET_break (0 < GNUNET_DISK_file_read (pr, &c, sizeof (c)));
1149 /* check for services that died (WAITPID) */
1150 next = running_head;
1151 while (NULL != (pos = next))
1155 if (pos->proc == NULL)
1157 if (GNUNET_YES == in_shutdown)
1161 if ((GNUNET_SYSERR ==
1163 GNUNET_OS_process_status (pos->proc, &statusType, &statusCode)))
1164 || ((ret == GNUNET_NO) || (statusType == GNUNET_OS_PROCESS_STOPPED)
1165 || (statusType == GNUNET_OS_PROCESS_RUNNING)))
1167 if (statusType == GNUNET_OS_PROCESS_EXITED)
1169 statstr = _( /* process termination method */ "exit");
1170 statcode = statusCode;
1172 else if (statusType == GNUNET_OS_PROCESS_SIGNALED)
1174 statstr = _( /* process termination method */ "signal");
1175 statcode = statusCode;
1179 statstr = _( /* process termination method */ "unknown");
1182 if (0 != pos->killed_at.abs_value_us)
1184 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1185 _("Service `%s' took %s to terminate\n"),
1187 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (pos->killed_at), GNUNET_YES));
1189 GNUNET_OS_process_destroy (pos->proc);
1191 broadcast_status (pos->name, GNUNET_ARM_SERVICE_STOPPED, NULL);
1192 if (NULL != pos->killing_client)
1194 signal_result (pos->killing_client, pos->name,
1195 pos->killing_client_request_id, GNUNET_ARM_RESULT_STOPPED);
1196 GNUNET_SERVER_client_drop (pos->killing_client);
1197 pos->killing_client = NULL;
1198 pos->killing_client_request_id = 0;
1200 if (GNUNET_YES != in_shutdown)
1202 if ((statusType == GNUNET_OS_PROCESS_EXITED) && (statcode == 0))
1204 /* process terminated normally, allow restart at any time */
1205 pos->restart_at.abs_value_us = 0;
1206 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1207 _("Service `%s' terminated normally, will restart at any time\n"),
1209 /* process can still be re-started on-demand, ensure it is re-started if there is demand */
1210 for (sli = pos->listen_head; NULL != sli; sli = sli->next)
1212 GNUNET_break (GNUNET_SCHEDULER_NO_TASK == sli->accept_task);
1214 GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
1215 sli->listen_socket, &accept_connection, sli);
1220 if (0 == (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1221 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1222 _("Service `%s' terminated with status %s/%d, will restart in %s\n"),
1223 pos->name, statstr, statcode,
1224 GNUNET_STRINGS_relative_time_to_string (pos->backoff, GNUNET_YES));
1225 /* schedule restart */
1226 pos->restart_at = GNUNET_TIME_relative_to_absolute (pos->backoff);
1227 pos->backoff = GNUNET_TIME_STD_BACKOFF (pos->backoff);
1228 if (GNUNET_SCHEDULER_NO_TASK != child_restart_task)
1229 GNUNET_SCHEDULER_cancel (child_restart_task);
1230 child_restart_task = GNUNET_SCHEDULER_add_with_priority (
1231 GNUNET_SCHEDULER_PRIORITY_IDLE, &delayed_restart_task, NULL);
1239 child_death_task = GNUNET_SCHEDULER_add_read_file (
1240 GNUNET_TIME_UNIT_FOREVER_REL, pr, &maint_child_death, NULL);
1241 if ((NULL == running_head) && (GNUNET_YES == in_shutdown))
1243 else if (GNUNET_YES == in_shutdown)
1244 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1245 "Delaying shutdown after child's death, still have %u children\n",
1246 list_count (running_head));
1252 * Signal handler called for SIGCHLD. Triggers the
1253 * respective handler by writing to the trigger pipe.
1256 sighandler_child_death ()
1259 int old_errno = errno; /* back-up errno */
1262 GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
1263 (sigpipe, GNUNET_DISK_PIPE_END_WRITE),
1265 errno = old_errno; /* restore errno */
1270 * Setup our service record for the given section in the configuration file
1271 * (assuming the section is for a service).
1274 * @param section a section in the configuration file
1275 * @return #GNUNET_OK (continue)
1278 setup_service (void *cls, const char *section)
1280 struct ServiceList *sl;
1284 struct sockaddr **addrs;
1285 socklen_t *addr_lens;
1289 if (strcasecmp (section, "arm") == 0)
1292 GNUNET_CONFIGURATION_get_value_string (cfg, section, "BINARY", &binary))
1294 /* not a service section */
1298 GNUNET_CONFIGURATION_have_value (cfg, section, "USER_SERVICE")) &&
1300 GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "USER_SERVICE")))
1302 if (GNUNET_NO == start_user)
1303 return; /* user service, and we don't deal with those */
1307 if (GNUNET_NO == start_system)
1308 return; /* system service, and we don't deal with those */
1310 sl = find_service (section);
1313 /* got the same section twice!? */
1315 GNUNET_free (binary);
1320 GNUNET_CONFIGURATION_get_value_filename (cfg, section, "CONFIG",
1323 GNUNET_CONFIGURATION_get_value_filename (cfg, "PATHS", "DEFAULTCONFIG",
1325 (0 != STAT (config, &sbuf)))
1329 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1332 GNUNET_free (config);
1336 sl = GNUNET_new (struct ServiceList);
1337 sl->name = GNUNET_strdup (section);
1338 sl->binary = binary;
1339 sl->config = config;
1340 sl->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
1341 sl->restart_at = GNUNET_TIME_UNIT_FOREVER_ABS;
1343 sl->pipe_control = GNUNET_YES;
1345 if (GNUNET_CONFIGURATION_have_value (cfg, section, "PIPECONTROL"))
1346 sl->pipe_control = GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "PIPECONTROL");
1348 GNUNET_CONTAINER_DLL_insert (running_head, running_tail, sl);
1351 GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "AUTOSTART"))
1353 if (0 >= (ret = GNUNET_SERVICE_get_server_addresses (section, cfg,
1354 &addrs, &addr_lens)))
1356 /* this will free (or capture) addrs[i] */
1357 for (i = 0; i < ret; i++)
1358 create_listen_socket (addrs[i], addr_lens[i], sl);
1359 GNUNET_free (addrs);
1360 GNUNET_free (addr_lens);
1365 * A client connected, add it to the notification context.
1367 * @param cls closure
1368 * @param client identification of the client
1371 handle_client_connecting (void *cls, struct GNUNET_SERVER_Client *client)
1373 /* All clients are considered to be of the "monitor" kind
1374 * (that is, they don't affect ARM shutdown).
1377 GNUNET_SERVER_client_mark_monitor (client);
1382 * Handle MONITOR-message.
1384 * @param cls closure (always NULL)
1385 * @param client identification of the client
1386 * @param message the actual message
1387 * @return #GNUNET_OK to keep the connection open,
1388 * #GNUNET_SYSERR to close it (signal serious error)
1391 handle_monitor (void *cls, struct GNUNET_SERVER_Client *client,
1392 const struct GNUNET_MessageHeader *message)
1394 /* Removal is handled by the server implementation, internally. */
1395 if ((NULL != client) && (NULL != notifier))
1397 GNUNET_SERVER_notification_context_add (notifier, client);
1398 broadcast_status ("arm", GNUNET_ARM_SERVICE_MONITORING_STARTED, client);
1399 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1405 * Process arm requests.
1407 * @param cls closure
1408 * @param serv the initialized server
1409 * @param c configuration to use
1412 run (void *cls, struct GNUNET_SERVER_Handle *serv,
1413 const struct GNUNET_CONFIGURATION_Handle *c)
1415 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1416 {&handle_start, NULL, GNUNET_MESSAGE_TYPE_ARM_START, 0},
1417 {&handle_stop, NULL, GNUNET_MESSAGE_TYPE_ARM_STOP, 0},
1418 {&handle_monitor, NULL, GNUNET_MESSAGE_TYPE_ARM_MONITOR,
1419 sizeof (struct GNUNET_MessageHeader)},
1420 {&handle_list, NULL, GNUNET_MESSAGE_TYPE_ARM_LIST,
1421 sizeof (struct GNUNET_ARM_Message)},
1424 char *defaultservices;
1426 struct ServiceList *sl;
1430 GNUNET_assert (serv != NULL);
1431 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
1434 GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
1435 GNUNET_DISK_pipe_handle (sigpipe,
1436 GNUNET_DISK_PIPE_END_READ),
1437 &maint_child_death, NULL);
1440 GNUNET_CONFIGURATION_get_value_string (cfg, "ARM", "GLOBAL_PREFIX",
1442 prefix_command = GNUNET_strdup ("");
1444 GNUNET_CONFIGURATION_get_value_string (cfg, "ARM", "GLOBAL_POSTFIX",
1446 final_option = GNUNET_strdup ("");
1448 GNUNET_CONFIGURATION_get_value_yesno (cfg, "ARM", "USER_ONLY"))
1450 GNUNET_break (GNUNET_YES == start_user);
1451 start_system = GNUNET_NO;
1455 GNUNET_CONFIGURATION_get_value_yesno (cfg, "ARM", "SYSTEM_ONLY"))
1457 GNUNET_break (GNUNET_YES == start_system);
1458 start_user = GNUNET_NO;
1461 GNUNET_CONFIGURATION_iterate_sections (cfg, &setup_service, NULL);
1463 /* start default services... */
1465 GNUNET_CONFIGURATION_get_value_string (cfg, "ARM", "DEFAULTSERVICES",
1468 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1469 _("Starting default services `%s'\n"), defaultservices);
1470 if (0 < strlen (defaultservices))
1472 for (pos = strtok (defaultservices, " "); NULL != pos;
1473 pos = strtok (NULL, " "))
1475 sl = find_service (pos);
1478 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1480 ("Default service `%s' not configured correctly!\n"),
1484 sl->is_default = GNUNET_YES;
1485 start_process (sl, NULL, 0);
1488 GNUNET_free (defaultservices);
1492 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1494 ("No default services configured, GNUnet will not really start right now.\n"));
1498 GNUNET_SERVER_notification_context_create (server, MAX_NOTIFY_QUEUE);
1499 GNUNET_SERVER_connect_notify (server, handle_client_connecting, NULL);
1500 /* process client requests */
1501 GNUNET_SERVER_add_handlers (server, handlers);
1506 * The main function for the arm service.
1508 * @param argc number of arguments from the command line
1509 * @param argv command line arguments
1510 * @return 0 ok, 1 on error
1513 main (int argc, char *const *argv)
1516 struct GNUNET_SIGNAL_Context *shc_chld;
1518 sigpipe = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_NO, GNUNET_NO);
1519 GNUNET_assert (sigpipe != NULL);
1521 GNUNET_SIGNAL_handler_install (GNUNET_SIGCHLD, &sighandler_child_death);
1524 GNUNET_SERVICE_run (argc, argv, "arm",
1525 GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN, &run, NULL)) ? 0 : 1;
1526 GNUNET_SIGNAL_handler_uninstall (shc_chld);
1528 GNUNET_DISK_pipe_close (sigpipe);
1538 * MINIMIZE heap size (way below 128k) since this process doesn't need much.
1540 void __attribute__ ((constructor)) GNUNET_ARM_memory_init ()
1542 mallopt (M_TRIM_THRESHOLD, 4 * 1024);
1543 mallopt (M_TOP_PAD, 1 * 1024);
1549 /* end of gnunet-service-arm.c */