2 This file is part of GNUnet.
3 Copyright (C) 2016 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 util/service_new.c
23 * @brief functions related to starting services (redesign)
24 * @author Christian Grothoff
25 * @author Florian Dold
28 #include "gnunet_util_lib.h"
29 #include "gnunet_protocols.h"
30 #include "gnunet_constants.h"
31 #include "gnunet_resolver_service.h"
40 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
42 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
44 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
48 * Information the service tracks per listen operation.
50 struct ServiceListenContext
56 struct ServiceListenContext *next;
61 struct ServiceListenContext *prev;
64 * Service this listen context belongs to.
66 struct GNUNET_SERVICE_Handle *sh;
69 * Socket we are listening on.
71 struct GNUNET_NETWORK_Handle *listen_socket;
74 * Task scheduled to do the listening.
76 struct GNUNET_SCHEDULER_Task *listen_task;
82 * Handle to a service.
84 struct GNUNET_SERVICE_Handle
89 const struct GNUNET_CONFIGURATION_Handle *cfg;
92 * Name of our service.
94 const char *service_name;
97 * Main service-specific task to run.
99 GNUNET_SERVICE_InitCallback service_init_cb;
102 * Function to call when clients connect.
104 GNUNET_SERVICE_ConnectHandler connect_cb;
107 * Function to call when clients disconnect / are disconnected.
109 GNUNET_SERVICE_DisconnectHandler disconnect_cb;
112 * Closure for @e service_init_cb, @e connect_cb, @e disconnect_cb.
117 * DLL of listen sockets used to accept new connections.
119 struct ServiceListenContext *slc_head;
122 * DLL of listen sockets used to accept new connections.
124 struct ServiceListenContext *slc_tail;
127 * Our clients, kept in a DLL.
129 struct GNUNET_SERVICE_Client *clients_head;
132 * Our clients, kept in a DLL.
134 struct GNUNET_SERVICE_Client *clients_tail;
137 * Message handlers to use for all clients.
139 const struct GNUNET_MQ_MessageHandler *handlers;
142 * Closure for @e task.
147 * IPv4 addresses that are not allowed to connect.
149 struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_denied;
152 * IPv6 addresses that are not allowed to connect.
154 struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_denied;
157 * IPv4 addresses that are allowed to connect (if not
158 * set, all are allowed).
160 struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_allowed;
163 * IPv6 addresses that are allowed to connect (if not
164 * set, all are allowed).
166 struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_allowed;
169 * Do we require a matching UID for UNIX domain socket connections?
170 * #GNUNET_NO means that the UID does not have to match (however,
171 * @e match_gid may still impose other access control checks).
176 * Do we require a matching GID for UNIX domain socket connections?
177 * Ignored if @e match_uid is #GNUNET_YES. Note that this is about
178 * checking that the client's UID is in our group OR that the
179 * client's GID is our GID. If both "match_gid" and @e match_uid are
180 * #GNUNET_NO, all users on the local system have access.
185 * Set to #GNUNET_YES if we got a shutdown signal and terminate
186 * the service if #have_non_monitor_clients() returns #GNUNET_YES.
193 enum GNUNET_SERVICE_Options options;
196 * If we are daemonizing, this FD is set to the
197 * pipe to the parent. Send '.' if we started
198 * ok, '!' if not. -1 if we are not daemonizing.
200 int ready_confirm_fd;
203 * Overall success/failure of the service start.
208 * If #GNUNET_YES, consider unknown message types an error where the
209 * client is disconnected.
216 * Handle to a client that is connected to a service.
218 struct GNUNET_SERVICE_Client
224 struct GNUNET_SERVICE_Client *next;
229 struct GNUNET_SERVICE_Client *prev;
232 * Service that this client belongs to.
234 struct GNUNET_SERVICE_Handle *sh;
237 * Socket of this client.
239 struct GNUNET_NETWORK_Handle *sock;
242 * Message queue for the client.
244 struct GNUNET_MQ_Handle *mq;
247 * Tokenizer we use for processing incoming data.
249 struct GNUNET_MessageStreamTokenizer *mst;
252 * Task that warns about missing calls to
253 * #GNUNET_SERVICE_client_continue().
255 struct GNUNET_SCHEDULER_Task *warn_task;
258 * Task run to finish dropping the client after the stack has
261 struct GNUNET_SCHEDULER_Task *drop_task;
264 * Task that receives data from the client to
265 * pass it to the handlers.
267 struct GNUNET_SCHEDULER_Task *recv_task;
270 * Task that transmit data to the client.
272 struct GNUNET_SCHEDULER_Task *send_task;
275 * Pointer to the message to be transmitted by @e send_task.
277 const struct GNUNET_MessageHeader *msg;
280 * User context value, value returned from
281 * the connect callback.
286 * Time when we last gave a message from this client
287 * to the application.
289 struct GNUNET_TIME_Absolute warn_start;
292 * Current position in @e msg at which we are transmitting.
297 * Persist the file handle for this client no matter what happens,
298 * force the OS to close once the process actually dies. Should only
299 * be used in special cases!
304 * Is this client a 'monitor' client that should not be counted
305 * when deciding on destroying the server during soft shutdown?
306 * (see also #GNUNET_SERVICE_start)
311 * Are we waiting for the application to call #GNUNET_SERVICE_client_continue()?
316 * Type of last message processed (for warn_no_receive_done).
323 * Check if any of the clients we have left are unrelated to
326 * @param sh service to check clients for
327 * @return #GNUNET_YES if we have non-monitoring clients left
330 have_non_monitor_clients (struct GNUNET_SERVICE_Handle *sh)
332 struct GNUNET_SERVICE_Client *client;
334 for (client = sh->clients_head;NULL != client; client = client->next)
336 if (client->is_monitor)
345 * Shutdown task triggered when a service should be terminated.
346 * This considers active clients and the service options to see
347 * how this specific service is to be terminated, and depending
348 * on this proceeds with the shutdown logic.
350 * @param cls our `struct GNUNET_SERVICE_Handle`
353 service_shutdown (void *cls)
355 struct GNUNET_SERVICE_Handle *sh = cls;
359 case GNUNET_SERVICE_OPTION_NONE:
360 GNUNET_SERVICE_shutdown (sh);
362 case GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN:
363 /* This task should never be run if we are using
364 the manual shutdown. */
367 case GNUNET_SERVICE_OPTION_SOFT_SHUTDOWN:
368 sh->got_shutdown = GNUNET_YES;
369 GNUNET_SERVICE_suspend (sh);
370 if (GNUNET_NO == have_non_monitor_clients (sh))
371 GNUNET_SERVICE_shutdown (sh);
378 * First task run by any service. Initializes our shutdown task,
379 * starts the listening operation on our listen sockets and launches
380 * the custom logic of the application service.
382 * @param cls our `struct GNUNET_SERVICE_Handle`
385 service_main (void *cls)
387 struct GNUNET_SERVICE_Handle *sh = cls;
389 if (GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN != sh->options)
390 GNUNET_SCHEDULER_add_shutdown (&service_shutdown,
392 GNUNET_SERVICE_resume (sh);
393 if (NULL != sh->service_init_cb)
394 sh->service_init_cb (sh->cb_cls,
401 * Parse an IPv4 access control list.
403 * @param ret location where to write the ACL (set)
404 * @param sh service context to use to get the configuration
405 * @param option name of the ACL option to parse
406 * @return #GNUNET_SYSERR on parse error, #GNUNET_OK on success (including
410 process_acl4 (struct GNUNET_STRINGS_IPv4NetworkPolicy **ret,
411 struct GNUNET_SERVICE_Handle *sh,
416 if (! GNUNET_CONFIGURATION_have_value (sh->cfg,
423 GNUNET_break (GNUNET_OK ==
424 GNUNET_CONFIGURATION_get_value_string (sh->cfg,
428 if (NULL == (*ret = GNUNET_STRINGS_parse_ipv4_policy (opt)))
430 LOG (GNUNET_ERROR_TYPE_WARNING,
431 _("Could not parse IPv4 network specification `%s' for `%s:%s'\n"),
436 return GNUNET_SYSERR;
444 * Parse an IPv6 access control list.
446 * @param ret location where to write the ACL (set)
447 * @param sh service context to use to get the configuration
448 * @param option name of the ACL option to parse
449 * @return #GNUNET_SYSERR on parse error, #GNUNET_OK on success (including
453 process_acl6 (struct GNUNET_STRINGS_IPv6NetworkPolicy **ret,
454 struct GNUNET_SERVICE_Handle *sh,
459 if (! GNUNET_CONFIGURATION_have_value (sh->cfg,
466 GNUNET_break (GNUNET_OK ==
467 GNUNET_CONFIGURATION_get_value_string (sh->cfg,
471 if (NULL == (*ret = GNUNET_STRINGS_parse_ipv6_policy (opt)))
473 LOG (GNUNET_ERROR_TYPE_WARNING,
474 _("Could not parse IPv6 network specification `%s' for `%s:%s'\n"),
479 return GNUNET_SYSERR;
487 * Add the given UNIX domain path as an address to the
488 * list (as the first entry).
490 * @param saddrs array to update
491 * @param saddrlens where to store the address length
492 * @param unixpath path to add
493 * @param abstract #GNUNET_YES to add an abstract UNIX domain socket. This
494 * parameter is ignore on systems other than LINUX
497 add_unixpath (struct sockaddr **saddrs,
498 socklen_t *saddrlens,
499 const char *unixpath,
503 struct sockaddr_un *un;
505 un = GNUNET_new (struct sockaddr_un);
506 un->sun_family = AF_UNIX;
507 strncpy (un->sun_path,
509 sizeof (un->sun_path) - 1);
511 if (GNUNET_YES == abstract)
512 un->sun_path[0] = '\0';
514 #if HAVE_SOCKADDR_IN_SIN_LEN
515 un->sun_len = (u_char) sizeof (struct sockaddr_un);
517 *saddrs = (struct sockaddr *) un;
518 *saddrlens = sizeof (struct sockaddr_un);
520 /* this function should never be called
521 * unless AF_UNIX is defined! */
528 * Get the list of addresses that a server for the given service
531 * @param service_name name of the service
532 * @param cfg configuration (which specifies the addresses)
533 * @param addrs set (call by reference) to an array of pointers to the
534 * addresses the server should bind to and listen on; the
535 * array will be NULL-terminated (on success)
536 * @param addr_lens set (call by reference) to an array of the lengths
537 * of the respective `struct sockaddr` struct in the @a addrs
539 * @return number of addresses found on success,
540 * #GNUNET_SYSERR if the configuration
541 * did not specify reasonable finding information or
542 * if it specified a hostname that could not be resolved;
543 * #GNUNET_NO if the number of addresses configured is
544 * zero (in this case, `*addrs` and `*addr_lens` will be
548 get_server_addresses (const char *service_name,
549 const struct GNUNET_CONFIGURATION_Handle *cfg,
550 struct sockaddr ***addrs,
551 socklen_t **addr_lens)
554 struct GNUNET_NETWORK_Handle *desc;
555 unsigned long long port;
557 struct addrinfo hints;
558 struct addrinfo *res;
559 struct addrinfo *pos;
560 struct addrinfo *next;
565 struct sockaddr **saddrs;
566 socklen_t *saddrlens;
572 if (GNUNET_CONFIGURATION_have_value (cfg,
578 GNUNET_CONFIGURATION_get_value_yesno (cfg,
581 return GNUNET_SYSERR;
584 disablev6 = GNUNET_NO;
588 /* probe IPv6 support */
589 desc = GNUNET_NETWORK_socket_create (PF_INET6,
594 if ( (ENOBUFS == errno) ||
599 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
601 return GNUNET_SYSERR;
603 LOG (GNUNET_ERROR_TYPE_INFO,
604 _("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
607 disablev6 = GNUNET_YES;
611 GNUNET_break (GNUNET_OK ==
612 GNUNET_NETWORK_socket_close (desc));
618 if (GNUNET_CONFIGURATION_have_value (cfg,
623 GNUNET_CONFIGURATION_get_value_number (cfg,
628 LOG (GNUNET_ERROR_TYPE_ERROR,
629 _("Require valid port number for service `%s' in configuration!\n"),
634 LOG (GNUNET_ERROR_TYPE_ERROR,
635 _("Require valid port number for service `%s' in configuration!\n"),
637 return GNUNET_SYSERR;
641 if (GNUNET_CONFIGURATION_have_value (cfg,
645 GNUNET_break (GNUNET_OK ==
646 GNUNET_CONFIGURATION_get_value_string (cfg,
655 abstract = GNUNET_NO;
658 GNUNET_CONFIGURATION_have_value (cfg,
662 GNUNET_CONFIGURATION_get_value_filename (cfg,
666 (0 < strlen (unixpath)))
668 /* probe UNIX support */
669 struct sockaddr_un s_un;
671 if (strlen (unixpath) >= sizeof (s_un.sun_path))
673 LOG (GNUNET_ERROR_TYPE_WARNING,
674 _("UNIXPATH `%s' too long, maximum length is %llu\n"),
676 (unsigned long long) sizeof (s_un.sun_path));
677 unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
678 LOG (GNUNET_ERROR_TYPE_INFO,
679 _("Using `%s' instead\n"),
683 abstract = GNUNET_CONFIGURATION_get_value_yesno (cfg,
685 "USE_ABSTRACT_SOCKETS");
686 if (GNUNET_SYSERR == abstract)
687 abstract = GNUNET_NO;
689 if ( (GNUNET_YES != abstract) &&
691 GNUNET_DISK_directory_create_for_file (unixpath)) )
692 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
696 if (NULL != unixpath)
698 desc = GNUNET_NETWORK_socket_create (AF_UNIX,
703 if ((ENOBUFS == errno) ||
708 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
710 GNUNET_free_non_null (hostname);
711 GNUNET_free (unixpath);
712 return GNUNET_SYSERR;
714 LOG (GNUNET_ERROR_TYPE_INFO,
715 _("Disabling UNIX domain socket support for service `%s', failed to create UNIX domain socket: %s\n"),
718 GNUNET_free (unixpath);
723 GNUNET_break (GNUNET_OK ==
724 GNUNET_NETWORK_socket_close (desc));
730 if ((0 == port) && (NULL == unixpath))
732 LOG (GNUNET_ERROR_TYPE_ERROR,
733 _("Have neither PORT nor UNIXPATH for service `%s', but one is required\n"),
735 GNUNET_free_non_null (hostname);
736 return GNUNET_SYSERR;
740 saddrs = GNUNET_new_array (2,
742 saddrlens = GNUNET_new_array (2,
744 add_unixpath (saddrs,
748 GNUNET_free_non_null (unixpath);
749 GNUNET_free_non_null (hostname);
751 *addr_lens = saddrlens;
755 if (NULL != hostname)
757 LOG (GNUNET_ERROR_TYPE_DEBUG,
758 "Resolving `%s' since that is where `%s' will bind to.\n",
763 sizeof (struct addrinfo));
765 hints.ai_family = AF_INET;
766 hints.ai_protocol = IPPROTO_TCP;
767 if ((0 != (ret = getaddrinfo (hostname,
773 LOG (GNUNET_ERROR_TYPE_ERROR,
774 _("Failed to resolve `%s': %s\n"),
777 GNUNET_free (hostname);
778 GNUNET_free_non_null (unixpath);
779 return GNUNET_SYSERR;
783 while (NULL != (pos = next))
787 (pos->ai_family == AF_INET6) )
793 LOG (GNUNET_ERROR_TYPE_ERROR,
794 _("Failed to find %saddress for `%s'.\n"),
795 disablev6 ? "IPv4 " : "",
798 GNUNET_free (hostname);
799 GNUNET_free_non_null (unixpath);
800 return GNUNET_SYSERR;
803 if (NULL != unixpath)
805 saddrs = GNUNET_new_array (resi + 1,
807 saddrlens = GNUNET_new_array (resi + 1,
810 if (NULL != unixpath)
812 add_unixpath (saddrs,
819 while (NULL != (pos = next))
823 (AF_INET6 == pos->ai_family) )
825 if ( (IPPROTO_TCP != pos->ai_protocol) &&
826 (0 != pos->ai_protocol) )
827 continue; /* not TCP */
828 if ( (SOCK_STREAM != pos->ai_socktype) &&
829 (0 != pos->ai_socktype) )
831 LOG (GNUNET_ERROR_TYPE_DEBUG,
832 "Service `%s' will bind to `%s'\n",
834 GNUNET_a2s (pos->ai_addr,
836 if (AF_INET == pos->ai_family)
838 GNUNET_assert (sizeof (struct sockaddr_in) == pos->ai_addrlen);
839 saddrlens[i] = pos->ai_addrlen;
840 saddrs[i] = GNUNET_malloc (saddrlens[i]);
841 GNUNET_memcpy (saddrs[i],
844 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
848 GNUNET_assert (AF_INET6 == pos->ai_family);
849 GNUNET_assert (sizeof (struct sockaddr_in6) == pos->ai_addrlen);
850 saddrlens[i] = pos->ai_addrlen;
851 saddrs[i] = GNUNET_malloc (saddrlens[i]);
852 GNUNET_memcpy (saddrs[i],
855 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
859 GNUNET_free (hostname);
865 /* will bind against everything, just set port */
870 if (NULL != unixpath)
873 saddrs = GNUNET_new_array (resi + 1,
875 saddrlens = GNUNET_new_array (resi + 1,
877 if (NULL != unixpath)
879 add_unixpath (saddrs,
885 saddrlens[i] = sizeof (struct sockaddr_in);
886 saddrs[i] = GNUNET_malloc (saddrlens[i]);
887 #if HAVE_SOCKADDR_IN_SIN_LEN
888 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
890 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
891 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
897 if (NULL != unixpath)
899 saddrs = GNUNET_new_array (resi + 1,
901 saddrlens = GNUNET_new_array (resi + 1,
904 if (NULL != unixpath)
906 add_unixpath (saddrs,
912 saddrlens[i] = sizeof (struct sockaddr_in6);
913 saddrs[i] = GNUNET_malloc (saddrlens[i]);
914 #if HAVE_SOCKADDR_IN_SIN_LEN
915 ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
917 ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
918 ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
920 saddrlens[i] = sizeof (struct sockaddr_in);
921 saddrs[i] = GNUNET_malloc (saddrlens[i]);
922 #if HAVE_SOCKADDR_IN_SIN_LEN
923 ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
925 ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
926 ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
929 GNUNET_free_non_null (unixpath);
931 *addr_lens = saddrlens;
938 * Read listen sockets from the parent process (ARM).
940 * @param sh service context to initialize
941 * @return NULL-terminated array of sockets on success,
942 * NULL if not ok (must bind yourself)
944 static struct GNUNET_NETWORK_Handle **
945 receive_sockets_from_parent (struct GNUNET_SERVICE_Handle *sh)
947 static struct GNUNET_NETWORK_Handle **lsocks;
954 env_buf = getenv ("GNUNET_OS_READ_LSOCKS");
955 if ( (NULL == env_buf) ||
956 (strlen (env_buf) <= 0) )
958 /* Using W32 API directly here, because this pipe will
959 * never be used outside of this function, and it's just too much of a bother
960 * to create a GNUnet API that boxes a HANDLE (the way it is done with socks)
962 lsocks_pipe = (HANDLE) strtoul (env_buf,
965 if ( (0 == lsocks_pipe) ||
966 (INVALID_HANDLE_VALUE == lsocks_pipe))
975 ret = ReadFile (lsocks_pipe,
981 (sizeof (count) != rd) ||
984 lsocks = GNUNET_new_array (count + 1,
985 struct GNUNET_NETWORK_Handle *);
988 for (i = 0; i < count; i++)
990 WSAPROTOCOL_INFOA pi;
994 ret = ReadFile (lsocks_pipe,
1000 (sizeof (size) != rd) ||
1001 (sizeof (pi) != size) )
1003 ret = ReadFile (lsocks_pipe,
1009 (sizeof (pi) != rd))
1011 s = WSASocketA (pi.iAddressFamily,
1016 WSA_FLAG_OVERLAPPED);
1017 lsocks[i] = GNUNET_NETWORK_socket_box_native (s);
1018 if (NULL == lsocks[i])
1020 else if (i == count - 1)
1025 lsocks[count] = NULL;
1029 CloseHandle (lsocks_pipe);
1033 LOG (GNUNET_ERROR_TYPE_ERROR,
1034 _("Could not access a pre-bound socket, will try to bind myself\n"));
1035 for (i = 0; (i < count) && (NULL != lsocks[i]); i++)
1036 GNUNET_break (GNUNET_OK ==
1037 GNUNET_NETWORK_socket_close (lsocks[i]));
1038 GNUNET_free (lsocks);
1047 * Create and initialize a listen socket for the server.
1049 * @param server_addr address to listen on
1050 * @param socklen length of @a server_addr
1051 * @return NULL on error, otherwise the listen socket
1053 static struct GNUNET_NETWORK_Handle *
1054 open_listen_socket (const struct sockaddr *server_addr,
1057 struct GNUNET_NETWORK_Handle *sock;
1061 switch (server_addr->sa_family)
1064 port = ntohs (((const struct sockaddr_in *) server_addr)->sin_port);
1067 port = ntohs (((const struct sockaddr_in6 *) server_addr)->sin6_port);
1077 sock = GNUNET_NETWORK_socket_create (server_addr->sa_family,
1082 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1087 /* bind the socket */
1088 if (GNUNET_OK != GNUNET_NETWORK_socket_bind (sock,
1093 if (EADDRINUSE != errno)
1095 /* we don't log 'EADDRINUSE' here since an IPv4 bind may
1096 * fail if we already took the port on IPv6; if both IPv4 and
1097 * IPv6 binds fail, then our caller will log using the
1098 * errno preserved in 'eno' */
1099 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1102 LOG (GNUNET_ERROR_TYPE_ERROR,
1103 _("`%s' failed for port %d (%s).\n"),
1106 (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
1112 LOG (GNUNET_ERROR_TYPE_WARNING,
1113 _("`%s' failed for port %d (%s): address already in use\n"),
1115 (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
1116 else if (AF_UNIX == server_addr->sa_family)
1118 LOG (GNUNET_ERROR_TYPE_WARNING,
1119 _("`%s' failed for `%s': address already in use\n"),
1121 GNUNET_a2s (server_addr, socklen));
1124 GNUNET_break (GNUNET_OK ==
1125 GNUNET_NETWORK_socket_close (sock));
1129 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock,
1132 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1134 GNUNET_break (GNUNET_OK ==
1135 GNUNET_NETWORK_socket_close (sock));
1140 LOG (GNUNET_ERROR_TYPE_DEBUG,
1141 "Server starts to listen on port %u.\n",
1148 * Setup service handle
1150 * Configuration may specify:
1151 * - PORT (where to bind to for TCP)
1152 * - UNIXPATH (where to bind to for UNIX domain sockets)
1153 * - DISABLEV6 (disable support for IPv6, otherwise we use dual-stack)
1154 * - BINDTO (hostname or IP address to bind to, otherwise we take everything)
1155 * - ACCEPT_FROM (only allow connections from specified IPv4 subnets)
1156 * - ACCEPT_FROM6 (only allow connections from specified IPv6 subnets)
1157 * - REJECT_FROM (disallow allow connections from specified IPv4 subnets)
1158 * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets)
1160 * @param sh service context to initialize
1161 * @return #GNUNET_OK if configuration succeeded
1164 setup_service (struct GNUNET_SERVICE_Handle *sh)
1167 struct GNUNET_NETWORK_Handle **lsocks;
1174 if (GNUNET_CONFIGURATION_have_value
1179 if (GNUNET_SYSERR ==
1181 GNUNET_CONFIGURATION_get_value_yesno (sh->cfg,
1185 LOG (GNUNET_ERROR_TYPE_ERROR,
1186 _("Specified value for `%s' of service `%s' is invalid\n"),
1189 return GNUNET_SYSERR;
1193 tolerant = GNUNET_NO;
1198 if ( (NULL != (nfds = getenv ("LISTEN_FDS"))) &&
1203 (cnt < FD_SETSIZE) &&
1204 (cnt + 4 < FD_SETSIZE) )
1206 lsocks = GNUNET_new_array (cnt + 1,
1207 struct GNUNET_NETWORK_Handle *);
1210 flags = fcntl (3 + cnt,
1213 (0 != (flags & FD_CLOEXEC)) ||
1215 (lsocks[cnt] = GNUNET_NETWORK_socket_box_native (3 + cnt))))
1217 LOG (GNUNET_ERROR_TYPE_ERROR,
1218 _("Could not access pre-bound socket %u, will try to bind myself\n"),
1219 (unsigned int) 3 + cnt);
1221 while (NULL != lsocks[cnt])
1222 GNUNET_break (GNUNET_OK ==
1223 GNUNET_NETWORK_socket_close (lsocks[cnt++]));
1224 GNUNET_free (lsocks);
1229 unsetenv ("LISTEN_FDS");
1232 if (NULL != getenv ("GNUNET_OS_READ_LSOCKS"))
1234 lsocks = receive_sockets_from_parent (sh);
1235 putenv ("GNUNET_OS_READ_LSOCKS=");
1241 /* listen only on inherited sockets if we have any */
1242 struct GNUNET_NETWORK_Handle **ls;
1244 for (ls = lsocks; NULL != *ls; ls++)
1246 struct ServiceListenContext *slc;
1248 slc = GNUNET_new (struct ServiceListenContext);
1250 slc->listen_socket = *ls;
1251 GNUNET_CONTAINER_DLL_insert (sh->slc_head,
1255 GNUNET_free (lsocks);
1259 struct sockaddr **addrs;
1260 socklen_t *addrlens;
1263 num = get_server_addresses (sh->service_name,
1267 if (GNUNET_SYSERR == num)
1268 return GNUNET_SYSERR;
1270 for (int i = 0; i < num; i++)
1272 struct ServiceListenContext *slc;
1274 slc = GNUNET_new (struct ServiceListenContext);
1276 slc->listen_socket = open_listen_socket (addrs[i],
1278 if (NULL == slc->listen_socket)
1280 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
1282 GNUNET_free (addrs[i++]);
1286 GNUNET_free (addrs[i++]);
1287 GNUNET_CONTAINER_DLL_insert (sh->slc_head,
1291 GNUNET_free_non_null (addrlens);
1292 GNUNET_free_non_null (addrs);
1294 (NULL == sh->slc_head) )
1296 /* All attempts to bind failed, hard failure */
1297 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1298 _("Could not bind to any of the ports I was supposed to, refusing to run!\n"));
1299 return GNUNET_SYSERR;
1303 sh->require_found = tolerant ? GNUNET_NO : GNUNET_YES;
1305 = GNUNET_CONFIGURATION_get_value_yesno (sh->cfg,
1309 = GNUNET_CONFIGURATION_get_value_yesno (sh->cfg,
1312 process_acl4 (&sh->v4_denied,
1315 process_acl4 (&sh->v4_allowed,
1318 process_acl6 (&sh->v6_denied,
1321 process_acl6 (&sh->v6_allowed,
1329 * Get the name of the user that'll be used
1330 * to provide the service.
1332 * @param sh service context
1333 * @return value of the 'USERNAME' option
1336 get_user_name (struct GNUNET_SERVICE_Handle *sh)
1341 GNUNET_CONFIGURATION_get_value_filename (sh->cfg,
1353 * @param sh service context
1354 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1357 set_user_id (struct GNUNET_SERVICE_Handle *sh)
1361 if (NULL == (user = get_user_name (sh)))
1362 return GNUNET_OK; /* keep */
1367 pws = getpwnam (user);
1370 LOG (GNUNET_ERROR_TYPE_ERROR,
1371 _("Cannot obtain information about user `%s': %s\n"),
1373 errno == 0 ? _("No such user") : STRERROR (errno));
1375 return GNUNET_SYSERR;
1377 if ( (0 != setgid (pws->pw_gid)) ||
1378 (0 != setegid (pws->pw_gid)) ||
1380 (0 != initgroups (user,
1383 (0 != setuid (pws->pw_uid)) ||
1384 (0 != seteuid (pws->pw_uid)))
1386 if ((0 != setregid (pws->pw_gid,
1388 (0 != setreuid (pws->pw_uid,
1391 LOG (GNUNET_ERROR_TYPE_ERROR,
1392 _("Cannot change user/group to `%s': %s\n"),
1396 return GNUNET_SYSERR;
1406 * Get the name of the file where we will
1407 * write the PID of the service.
1409 * @param sh service context
1410 * @return name of the file for the process ID
1413 get_pid_file_name (struct GNUNET_SERVICE_Handle *sh)
1418 GNUNET_CONFIGURATION_get_value_filename (sh->cfg,
1428 * Delete the PID file that was created by our parent.
1430 * @param sh service context
1433 pid_file_delete (struct GNUNET_SERVICE_Handle *sh)
1435 char *pif = get_pid_file_name (sh);
1438 return; /* no PID file */
1439 if (0 != UNLINK (pif))
1440 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
1448 * Detach from terminal.
1450 * @param sh service context
1451 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1454 detach_terminal (struct GNUNET_SERVICE_Handle *sh)
1461 if (0 != PIPE (filedes))
1463 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1465 return GNUNET_SYSERR;
1470 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1472 return GNUNET_SYSERR;
1479 GNUNET_break (0 == CLOSE (filedes[1]));
1481 if (1 != READ (filedes[0],
1484 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1492 LOG (GNUNET_ERROR_TYPE_INFO,
1493 _("Service process failed to initialize\n"));
1496 LOG (GNUNET_ERROR_TYPE_INFO,
1497 _("Service process could not initialize server function\n"));
1500 LOG (GNUNET_ERROR_TYPE_INFO,
1501 _("Service process failed to report status\n"));
1504 exit (1); /* child reported error */
1506 GNUNET_break (0 == CLOSE (0));
1507 GNUNET_break (0 == CLOSE (1));
1508 GNUNET_break (0 == CLOSE (filedes[0]));
1509 nullfd = OPEN ("/dev/null",
1512 return GNUNET_SYSERR;
1513 /* set stdin/stdout to /dev/null */
1514 if ( (dup2 (nullfd, 0) < 0) ||
1515 (dup2 (nullfd, 1) < 0) )
1517 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1519 (void) CLOSE (nullfd);
1520 return GNUNET_SYSERR;
1522 (void) CLOSE (nullfd);
1523 /* Detach from controlling terminal */
1526 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1528 sh->ready_confirm_fd = filedes[1];
1530 /* FIXME: we probably need to do something else
1531 * elsewhere in order to fork the process itself... */
1539 * Tear down the service, closing the listen sockets and
1542 * @param sh handle to the service to tear down.
1545 teardown_service (struct GNUNET_SERVICE_Handle *sh)
1547 struct ServiceListenContext *slc;
1549 GNUNET_free_non_null (sh->v4_denied);
1550 GNUNET_free_non_null (sh->v6_denied);
1551 GNUNET_free_non_null (sh->v4_allowed);
1552 GNUNET_free_non_null (sh->v6_allowed);
1553 while (NULL != (slc = sh->slc_head))
1555 GNUNET_CONTAINER_DLL_remove (sh->slc_head,
1558 if (NULL != slc->listen_task)
1559 GNUNET_SCHEDULER_cancel (slc->listen_task);
1560 GNUNET_break (GNUNET_OK ==
1561 GNUNET_NETWORK_socket_close (slc->listen_socket));
1568 * Low-level function to start a service if the scheduler
1569 * is already running. Should only be used directly in
1572 * The function will launch the service with the name @a service_name
1573 * using the @a service_options to configure its shutdown
1574 * behavior. When clients connect or disconnect, the respective
1575 * @a connect_cb or @a disconnect_cb functions will be called. For
1576 * messages received from the clients, the respective @a handlers will
1577 * be invoked; for the closure of the handlers we use the return value
1578 * from the @a connect_cb invocation of the respective client.
1580 * Each handler MUST call #GNUNET_SERVICE_client_continue() after each
1581 * message to receive further messages from this client. If
1582 * #GNUNET_SERVICE_client_continue() is not called within a short
1583 * time, a warning will be logged. If delays are expected, services
1584 * should call #GNUNET_SERVICE_client_disable_continue_warning() to
1585 * disable the warning.
1587 * Clients sending invalid messages (based on @a handlers) will be
1588 * dropped. Additionally, clients can be dropped at any time using
1589 * #GNUNET_SERVICE_client_drop().
1591 * The service must be stopped using #GNUNET_SERVICE_stoP().
1593 * @param service_name name of the service to run
1594 * @param cfg configuration to use
1595 * @param connect_cb function to call whenever a client connects
1596 * @param disconnect_cb function to call whenever a client disconnects
1597 * @param cls closure argument for @a connect_cb and @a disconnect_cb
1598 * @param handlers NULL-terminated array of message handlers for the service,
1599 * the closure will be set to the value returned by
1600 * the @a connect_cb for the respective connection
1601 * @return NULL on error
1603 struct GNUNET_SERVICE_Handle *
1604 GNUNET_SERVICE_starT (const char *service_name,
1605 const struct GNUNET_CONFIGURATION_Handle *cfg,
1606 GNUNET_SERVICE_ConnectHandler connect_cb,
1607 GNUNET_SERVICE_DisconnectHandler disconnect_cb,
1609 const struct GNUNET_MQ_MessageHandler *handlers)
1611 struct GNUNET_SERVICE_Handle *sh;
1613 sh = GNUNET_new (struct GNUNET_SERVICE_Handle);
1614 sh->service_name = service_name;
1616 sh->connect_cb = connect_cb;
1617 sh->disconnect_cb = disconnect_cb;
1619 sh->handlers = handlers;
1620 if (GNUNET_OK != setup_service (sh))
1630 * Stops a service that was started with #GNUNET_SERVICE_starT().
1632 * @param srv service to stop
1635 GNUNET_SERVICE_stoP (struct GNUNET_SERVICE_Handle *srv)
1637 teardown_service (srv);
1643 * Creates the "main" function for a GNUnet service. You
1644 * should almost always use the #GNUNET_SERVICE_MAIN macro
1645 * instead of calling this function directly (except
1646 * for ARM, which should call this function directly).
1648 * The function will launch the service with the name @a service_name
1649 * using the @a service_options to configure its shutdown
1650 * behavior. Once the service is ready, the @a init_cb will be called
1651 * for service-specific initialization. @a init_cb will be given the
1652 * service handler which can be used to control the service's
1653 * availability. When clients connect or disconnect, the respective
1654 * @a connect_cb or @a disconnect_cb functions will be called. For
1655 * messages received from the clients, the respective @a handlers will
1656 * be invoked; for the closure of the handlers we use the return value
1657 * from the @a connect_cb invocation of the respective client.
1659 * Each handler MUST call #GNUNET_SERVICE_client_continue() after each
1660 * message to receive further messages from this client. If
1661 * #GNUNET_SERVICE_client_continue() is not called within a short
1662 * time, a warning will be logged. If delays are expected, services
1663 * should call #GNUNET_SERVICE_client_disable_continue_warning() to
1664 * disable the warning.
1666 * Clients sending invalid messages (based on @a handlers) will be
1667 * dropped. Additionally, clients can be dropped at any time using
1668 * #GNUNET_SERVICE_client_drop().
1670 * @param argc number of command-line arguments in @a argv
1671 * @param argv array of command-line arguments
1672 * @param service_name name of the service to run
1673 * @param options options controlling shutdown of the service
1674 * @param service_init_cb function to call once the service is ready
1675 * @param connect_cb function to call whenever a client connects
1676 * @param disconnect_cb function to call whenever a client disconnects
1677 * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb
1678 * @param handlers NULL-terminated array of message handlers for the service,
1679 * the closure will be set to the value returned by
1680 * the @a connect_cb for the respective connection
1681 * @return 0 on success, non-zero on error
1684 GNUNET_SERVICE_ruN_ (int argc,
1686 const char *service_name,
1687 enum GNUNET_SERVICE_Options options,
1688 GNUNET_SERVICE_InitCallback service_init_cb,
1689 GNUNET_SERVICE_ConnectHandler connect_cb,
1690 GNUNET_SERVICE_DisconnectHandler disconnect_cb,
1692 const struct GNUNET_MQ_MessageHandler *handlers)
1694 struct GNUNET_SERVICE_Handle sh;
1696 char *opt_cfg_filename;
1701 unsigned long long skew_offset;
1702 unsigned long long skew_variance;
1703 long long clock_offset;
1704 struct GNUNET_CONFIGURATION_Handle *cfg;
1708 struct GNUNET_GETOPT_CommandLineOption service_options[] = {
1709 GNUNET_GETOPT_OPTION_CFG_FILE (&opt_cfg_filename),
1710 {'d', "daemonize", NULL,
1711 gettext_noop ("do daemonize (detach from terminal)"), 0,
1712 GNUNET_GETOPT_set_one, &do_daemonize},
1713 GNUNET_GETOPT_OPTION_HELP (NULL),
1714 GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev),
1715 GNUNET_GETOPT_OPTION_LOGFILE (&logfile),
1716 GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION " " VCS_VERSION),
1717 GNUNET_GETOPT_OPTION_END
1723 xdg = getenv ("XDG_CONFIG_HOME");
1725 GNUNET_asprintf (&cfg_filename,
1729 GNUNET_OS_project_data_get ()->config_file);
1731 cfg_filename = GNUNET_strdup (GNUNET_OS_project_data_get ()->user_config_file);
1732 sh.ready_confirm_fd = -1;
1733 sh.options = options;
1734 sh.cfg = cfg = GNUNET_CONFIGURATION_create ();
1735 sh.service_init_cb = service_init_cb;
1736 sh.connect_cb = connect_cb;
1737 sh.disconnect_cb = disconnect_cb;
1739 sh.handlers = handlers;
1740 sh.service_name = service_name;
1742 /* setup subsystems */
1745 opt_cfg_filename = NULL;
1747 ret = GNUNET_GETOPT_run (service_name,
1751 if (GNUNET_SYSERR == ret)
1753 if (GNUNET_NO == ret)
1758 if (GNUNET_OK != GNUNET_log_setup (service_name,
1765 if (NULL == opt_cfg_filename)
1766 opt_cfg_filename = GNUNET_strdup (cfg_filename);
1767 if (GNUNET_YES == GNUNET_DISK_file_test (opt_cfg_filename))
1769 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg,
1772 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1773 _("Malformed configuration file `%s', exit ...\n"),
1780 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg,
1783 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1784 _("Malformed configuration, exit ...\n"));
1787 if (0 != strcmp (opt_cfg_filename,
1789 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1790 _("Could not access configuration file `%s'\n"),
1793 if (GNUNET_OK != setup_service (&sh))
1795 if ( (1 == do_daemonize) &&
1796 (GNUNET_OK != detach_terminal (&sh)) )
1801 if (GNUNET_OK != set_user_id (&sh))
1803 LOG (GNUNET_ERROR_TYPE_DEBUG,
1804 "Service `%s' runs with configuration from `%s'\n",
1808 GNUNET_CONFIGURATION_get_value_number (sh.cfg,
1813 GNUNET_CONFIGURATION_get_value_number (sh.cfg,
1818 clock_offset = skew_offset - skew_variance;
1819 GNUNET_TIME_set_offset (clock_offset);
1820 LOG (GNUNET_ERROR_TYPE_DEBUG,
1821 "Skewing clock by %dll ms\n",
1824 GNUNET_RESOLVER_connect (sh.cfg);
1826 /* actually run service */
1828 GNUNET_SCHEDULER_run (&service_main,
1831 if (1 == do_daemonize)
1832 pid_file_delete (&sh);
1835 if (-1 != sh.ready_confirm_fd)
1837 if (1 != WRITE (sh.ready_confirm_fd,
1840 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1842 GNUNET_break (0 == CLOSE (sh.ready_confirm_fd));
1849 GNUNET_CONFIGURATION_have_value (sh.cfg,
1853 GNUNET_CONFIGURATION_get_value_string (sh.cfg,
1861 GAUGER (service_name,
1865 GNUNET_free (counter);
1869 teardown_service (&sh);
1871 GNUNET_SPEEDUP_stop_ ();
1872 GNUNET_CONFIGURATION_destroy (cfg);
1873 GNUNET_free_non_null (logfile);
1874 GNUNET_free_non_null (loglev);
1875 GNUNET_free (cfg_filename);
1876 GNUNET_free_non_null (opt_cfg_filename);
1878 return err ? GNUNET_SYSERR : sh.ret;
1883 * Suspend accepting connections from the listen socket temporarily.
1884 * Resume activity using #GNUNET_SERVICE_resume.
1886 * @param sh service to stop accepting connections.
1889 GNUNET_SERVICE_suspend (struct GNUNET_SERVICE_Handle *sh)
1891 struct ServiceListenContext *slc;
1893 for (slc = sh->slc_head; NULL != slc; slc = slc->next)
1895 if (NULL != slc->listen_task)
1897 GNUNET_SCHEDULER_cancel (slc->listen_task);
1898 slc->listen_task = NULL;
1905 * Task run when we are ready to transmit data to the
1908 * @param cls the `struct GNUNET_SERVICE_Client *` to send to
1913 struct GNUNET_SERVICE_Client *client = cls;
1918 client->send_task = NULL;
1919 buf = (const char *) client->msg;
1920 left = ntohs (client->msg->size) - client->msg_pos;
1921 ret = GNUNET_NETWORK_socket_send (client->sock,
1922 &buf[client->msg_pos],
1924 GNUNET_assert (ret <= (ssize_t) left);
1927 GNUNET_MQ_inject_error (client->mq,
1928 GNUNET_MQ_ERROR_WRITE);
1933 if ( (EAGAIN == errno) ||
1942 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
1944 GNUNET_MQ_inject_error (client->mq,
1945 GNUNET_MQ_ERROR_WRITE);
1949 client->msg_pos += ret;
1953 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
1959 GNUNET_MQ_impl_send_continue (client->mq);
1964 * Signature of functions implementing the sending functionality of a
1967 * @param mq the message queue
1968 * @param msg the message to send
1969 * @param impl_state our `struct GNUNET_SERVICE_Client *`
1972 service_mq_send (struct GNUNET_MQ_Handle *mq,
1973 const struct GNUNET_MessageHeader *msg,
1976 struct GNUNET_SERVICE_Client *client = impl_state;
1978 GNUNET_assert (NULL == client->send_task);
1980 client->msg_pos = 0;
1982 = GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
1990 * Implementation function that cancels the currently sent message.
1992 * @param mq message queue
1993 * @param impl_state state specific to the implementation
1996 service_mq_cancel (struct GNUNET_MQ_Handle *mq,
1999 struct GNUNET_SERVICE_Client *client = impl_state;
2001 GNUNET_assert (0); // not implemented
2002 // FIXME: stop transmission! (must be possible, otherwise
2003 // we must have told MQ that the message was sent!)
2008 * Generic error handler, called with the appropriate
2009 * error code and the same closure specified at the creation of
2010 * the message queue.
2011 * Not every message queue implementation supports an error handler.
2013 * @param cls closure with our `struct GNUNET_SERVICE_Client`
2014 * @param error error code
2017 service_mq_error_handler (void *cls,
2018 enum GNUNET_MQ_Error error)
2020 struct GNUNET_SERVICE_Client *client = cls;
2021 struct GNUNET_SERVICE_Handle *sh = client->sh;
2023 if ( (GNUNET_MQ_ERROR_NO_MATCH == error) &&
2024 (GNUNET_NO == sh->require_found) )
2026 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2027 "No handler for message of type %u found\n",
2028 (unsigned int) client->warn_type);
2029 GNUNET_SERVICE_client_continue (client);
2030 return; /* ignore error */
2032 GNUNET_SERVICE_client_drop (client);
2037 * Task run to warn about missing calls to #GNUNET_SERVICE_client_continue().
2039 * @param cls our `struct GNUNET_SERVICE_Client *` to process more requests from
2042 warn_no_client_continue (void *cls)
2044 struct GNUNET_SERVICE_Client *client = cls;
2046 GNUNET_break (0 != client->warn_type); /* type should never be 0 here, as we don't use 0 */
2048 = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
2049 &warn_no_client_continue,
2051 LOG (GNUNET_ERROR_TYPE_WARNING,
2052 _("Processing code for message of type %u did not call `GNUNET_SERVICE_client_continue' after %s\n"),
2053 (unsigned int) client->warn_type,
2054 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (client->warn_start),
2060 * Functions with this signature are called whenever a
2061 * complete message is received by the tokenizer for a client.
2063 * Do not call #GNUNET_MST_destroy() from within
2064 * the scope of this callback.
2066 * @param cls closure with the `struct GNUNET_SERVICE_Client *`
2067 * @param message the actual message
2068 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the client was dropped
2071 service_client_mst_cb (void *cls,
2072 const struct GNUNET_MessageHeader *message)
2074 struct GNUNET_SERVICE_Client *client = cls;
2076 GNUNET_assert (GNUNET_NO == client->needs_continue);
2077 client->needs_continue = GNUNET_YES;
2078 client->warn_type = ntohs (message->type);
2079 client->warn_start = GNUNET_TIME_absolute_get ();
2080 GNUNET_assert (NULL == client->warn_task);
2082 = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
2083 &warn_no_client_continue,
2085 GNUNET_MQ_inject_message (client->mq,
2087 if (NULL != client->drop_task)
2088 return GNUNET_SYSERR;
2094 * A client sent us data. Receive and process it. If we are done,
2095 * reschedule this task.
2097 * @param cls the `struct GNUNET_SERVICE_Client` that sent us data.
2100 service_client_recv (void *cls)
2102 struct GNUNET_SERVICE_Client *client = cls;
2105 client->recv_task = NULL;
2106 ret = GNUNET_MST_read (client->mst,
2110 if (GNUNET_SYSERR == ret)
2112 /* client closed connection (or IO error) */
2113 if (NULL == client->drop_task)
2115 GNUNET_assert (GNUNET_NO == client->needs_continue);
2116 GNUNET_SERVICE_client_drop (client);
2120 if (GNUNET_NO == ret)
2121 return; /* more messages in buffer, wait for application
2122 to be done processing */
2123 GNUNET_assert (GNUNET_OK == ret);
2124 if (GNUNET_YES == client->needs_continue)
2126 if (NULL != client->recv_task)
2128 /* MST needs more data, re-schedule read job */
2130 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2132 &service_client_recv,
2138 * We have successfully accepted a connection from a client. Now
2139 * setup the client (with the scheduler) and tell the application.
2141 * @param sh service that accepted the client
2142 * @param sock socket associated with the client
2145 start_client (struct GNUNET_SERVICE_Handle *sh,
2146 struct GNUNET_NETWORK_Handle *csock)
2148 struct GNUNET_SERVICE_Client *client;
2150 client = GNUNET_new (struct GNUNET_SERVICE_Client);
2151 GNUNET_CONTAINER_DLL_insert (sh->clients_head,
2155 client->sock = csock;
2156 client->mq = GNUNET_MQ_queue_for_callbacks (&service_mq_send,
2161 &service_mq_error_handler,
2163 client->mst = GNUNET_MST_create (&service_client_mst_cb,
2165 client->user_context = sh->connect_cb (sh->cb_cls,
2168 GNUNET_MQ_set_handlers_closure (client->mq,
2169 client->user_context);
2171 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2173 &service_client_recv,
2179 * Check if the given IP address is in the list of IP addresses.
2181 * @param list a list of networks
2182 * @param add the IP to check (in network byte order)
2183 * @return #GNUNET_NO if the IP is not in the list, #GNUNET_YES if it it is
2186 check_ipv4_listed (const struct GNUNET_STRINGS_IPv4NetworkPolicy *list,
2187 const struct in_addr *add)
2194 while ( (0 != list[i].network.s_addr) ||
2195 (0 != list[i].netmask.s_addr) )
2197 if ((add->s_addr & list[i].netmask.s_addr) ==
2198 (list[i].network.s_addr & list[i].netmask.s_addr))
2207 * Check if the given IP address is in the list of IP addresses.
2209 * @param list a list of networks
2210 * @param ip the IP to check (in network byte order)
2211 * @return #GNUNET_NO if the IP is not in the list, #GNUNET_YES if it it is
2214 check_ipv6_listed (const struct GNUNET_STRINGS_IPv6NetworkPolicy *list,
2215 const struct in6_addr *ip)
2219 struct in6_addr zero;
2225 sizeof (struct in6_addr));
2228 while (0 != memcmp (&zero,
2230 sizeof (struct in6_addr)))
2232 for (j = 0; j < sizeof (struct in6_addr) / sizeof (int); j++)
2233 if (((((int *) ip)[j] & ((int *) &list[i].netmask)[j])) !=
2234 (((int *) &list[i].network)[j] & ((int *) &list[i].netmask)[j]))
2246 * We have a client. Accept the incoming socket(s) (and reschedule
2249 * @param cls the `struct ServiceListenContext` of the ready listen socket
2252 accept_client (void *cls)
2254 struct ServiceListenContext *slc = cls;
2255 struct GNUNET_SERVICE_Handle *sh = slc->sh;
2257 slc->listen_task = NULL;
2260 struct GNUNET_NETWORK_Handle *sock;
2261 const struct sockaddr_in *v4;
2262 const struct sockaddr_in6 *v6;
2263 struct sockaddr_storage sa;
2267 addrlen = sizeof (sa);
2268 sock = GNUNET_NETWORK_socket_accept (slc->listen_socket,
2269 (struct sockaddr *) &sa,
2273 switch (sa.ss_family)
2276 GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
2277 v4 = (const struct sockaddr_in *) &sa;
2278 ok = ( ( (NULL == sh->v4_allowed) ||
2279 (check_ipv4_listed (sh->v4_allowed,
2281 ( (NULL == sh->v4_denied) ||
2282 (! check_ipv4_listed (sh->v4_denied,
2283 &v4->sin_addr)) ) );
2286 GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
2287 v6 = (const struct sockaddr_in6 *) &sa;
2288 ok = ( ( (NULL == sh->v6_allowed) ||
2289 (check_ipv6_listed (sh->v6_allowed,
2290 &v6->sin6_addr))) &&
2291 ( (NULL == sh->v6_denied) ||
2292 (! check_ipv6_listed (sh->v6_denied,
2293 &v6->sin6_addr)) ) );
2297 ok = GNUNET_OK; /* controlled using file-system ACL now */
2301 LOG (GNUNET_ERROR_TYPE_WARNING,
2302 _("Unknown address family %d\n"),
2308 LOG (GNUNET_ERROR_TYPE_DEBUG,
2309 "Service rejected incoming connection from %s due to policy.\n",
2310 GNUNET_a2s ((const struct sockaddr *) &sa,
2312 GNUNET_break (GNUNET_OK ==
2313 GNUNET_NETWORK_socket_close (sock));
2316 LOG (GNUNET_ERROR_TYPE_DEBUG,
2317 "Service accepted incoming connection from %s.\n",
2318 GNUNET_a2s ((const struct sockaddr *) &sa,
2320 start_client (slc->sh,
2324 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2332 * Resume accepting connections from the listen socket.
2334 * @param sh service to resume accepting connections.
2337 GNUNET_SERVICE_resume (struct GNUNET_SERVICE_Handle *sh)
2339 struct ServiceListenContext *slc;
2341 for (slc = sh->slc_head; NULL != slc; slc = slc->next)
2343 GNUNET_assert (NULL == slc->listen_task);
2345 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2354 * Task run to resume receiving data from the client after
2355 * the client called #GNUNET_SERVICE_client_continue().
2357 * @param cls our `struct GNUNET_SERVICE_Client`
2360 resume_client_receive (void *cls)
2362 struct GNUNET_SERVICE_Client *c = cls;
2365 c->recv_task = NULL;
2366 /* first, check if there is still something in the buffer */
2367 ret = GNUNET_MST_next (c->mst,
2369 if (GNUNET_SYSERR == ret)
2372 GNUNET_SERVICE_client_drop (c);
2375 if (GNUNET_NO == ret)
2376 return; /* done processing, wait for more later */
2377 GNUNET_assert (GNUNET_OK == ret);
2378 if (GNUNET_YES == c->needs_continue)
2379 return; /* #GNUNET_MST_next() did give a message to the client */
2380 /* need to receive more data from the network first */
2381 if (NULL != c->recv_task)
2384 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
2386 &service_client_recv,
2392 * Continue receiving further messages from the given client.
2393 * Must be called after each message received.
2395 * @param c the client to continue receiving from
2398 GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c)
2400 GNUNET_assert (GNUNET_YES == c->needs_continue);
2401 GNUNET_assert (NULL == c->recv_task);
2402 c->needs_continue = GNUNET_NO;
2403 if (NULL != c->warn_task)
2405 GNUNET_SCHEDULER_cancel (c->warn_task);
2406 c->warn_task = NULL;
2409 = GNUNET_SCHEDULER_add_now (&resume_client_receive,
2415 * Disable the warning the server issues if a message is not
2416 * acknowledged in a timely fashion. Use this call if a client is
2417 * intentionally delayed for a while. Only applies to the current
2420 * @param c client for which to disable the warning
2423 GNUNET_SERVICE_client_disable_continue_warning (struct GNUNET_SERVICE_Client *c)
2425 GNUNET_break (NULL != c->warn_task);
2426 if (NULL != c->warn_task)
2428 GNUNET_SCHEDULER_cancel (c->warn_task);
2429 c->warn_task = NULL;
2435 * Asynchronously finish dropping the client.
2437 * @param cls the `struct GNUNET_SERVICE_Client`.
2440 finish_client_drop (void *cls)
2442 struct GNUNET_SERVICE_Client *c = cls;
2443 struct GNUNET_SERVICE_Handle *sh = c->sh;
2445 GNUNET_MST_destroy (c->mst);
2446 GNUNET_MQ_destroy (c->mq);
2447 if (GNUNET_NO == c->persist)
2449 GNUNET_break (GNUNET_OK ==
2450 GNUNET_NETWORK_socket_close (c->sock));
2454 GNUNET_NETWORK_socket_free_memory_only_ (c->sock);
2457 if ( (GNUNET_YES == sh->got_shutdown) &&
2458 (GNUNET_NO == have_non_monitor_clients (sh)) )
2459 GNUNET_SERVICE_shutdown (sh);
2464 * Ask the server to disconnect from the given client. This is the
2465 * same as returning #GNUNET_SYSERR within the check procedure when
2466 * handling a message, wexcept that it allows dropping of a client even
2467 * when not handling a message from that client. The `disconnect_cb`
2468 * will be called on @a c even if the application closes the connection
2469 * using this function.
2471 * @param c client to disconnect now
2474 GNUNET_SERVICE_client_drop (struct GNUNET_SERVICE_Client *c)
2476 struct GNUNET_SERVICE_Handle *sh = c->sh;
2478 if (NULL != c->drop_task)
2480 /* asked to drop twice! */
2484 GNUNET_CONTAINER_DLL_remove (sh->clients_head,
2487 sh->disconnect_cb (sh->cb_cls,
2490 if (NULL != c->warn_task)
2492 GNUNET_SCHEDULER_cancel (c->warn_task);
2493 c->warn_task = NULL;
2495 if (NULL != c->recv_task)
2497 GNUNET_SCHEDULER_cancel (c->recv_task);
2498 c->recv_task = NULL;
2500 if (NULL != c->send_task)
2502 GNUNET_SCHEDULER_cancel (c->send_task);
2503 c->send_task = NULL;
2505 c->drop_task = GNUNET_SCHEDULER_add_now (&finish_client_drop,
2511 * Explicitly stops the service.
2513 * @param sh server to shutdown
2516 GNUNET_SERVICE_shutdown (struct GNUNET_SERVICE_Handle *sh)
2518 struct GNUNET_SERVICE_Client *client;
2520 GNUNET_SERVICE_suspend (sh);
2521 sh->got_shutdown = GNUNET_NO;
2522 while (NULL != (client = sh->clients_head))
2523 GNUNET_SERVICE_client_drop (client);
2528 * Set the 'monitor' flag on this client. Clients which have been
2529 * marked as 'monitors' won't prevent the server from shutting down
2530 * once #GNUNET_SERVICE_stop_listening() has been invoked. The idea is
2531 * that for "normal" clients we likely want to allow them to process
2532 * their requests; however, monitor-clients are likely to 'never'
2533 * disconnect during shutdown and thus will not be considered when
2534 * determining if the server should continue to exist after
2535 * shutdown has been triggered.
2537 * @param c client to mark as a monitor
2540 GNUNET_SERVICE_client_mark_monitor (struct GNUNET_SERVICE_Client *c)
2542 c->is_monitor = GNUNET_YES;
2543 if ( (GNUNET_YES == c->sh->got_shutdown) &&
2544 (GNUNET_NO == have_non_monitor_clients (c->sh)) )
2545 GNUNET_SERVICE_shutdown (c->sh);
2550 * Set the persist option on this client. Indicates that the
2551 * underlying socket or fd should never really be closed. Used for
2552 * indicating process death.
2554 * @param c client to persist the socket (never to be closed)
2557 GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client *c)
2559 c->persist = GNUNET_YES;
2564 * Obtain the message queue of @a c. Convenience function.
2566 * @param c the client to continue receiving from
2567 * @return the message queue of @a c
2569 struct GNUNET_MQ_Handle *
2570 GNUNET_SERVICE_client_get_mq (struct GNUNET_SERVICE_Client *c)
2576 /* end of service_new.c */