diff options
Diffstat (limited to 'src/util/service.c')
| -rw-r--r-- | src/util/service.c | 408 |
1 files changed, 243 insertions, 165 deletions
diff --git a/src/util/service.c b/src/util/service.c index 243e7da..6a6fb6c 100644 --- a/src/util/service.c +++ b/src/util/service.c @@ -1,6 +1,6 @@ /* This file is part of GNUnet. - (C) 2009 Christian Grothoff (and other contributing authors) + (C) 2009, 2012 Christian Grothoff (and other contributing authors) GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -42,7 +42,6 @@ #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename) -#define DEBUG_SERVICE GNUNET_EXTRA_LOGGING /* ******************* access control ******************** */ @@ -51,7 +50,14 @@ */ struct IPv4NetworkSet { + /** + * IPv4 address. + */ struct in_addr network; + + /** + * IPv4 netmask. + */ struct in_addr netmask; }; @@ -60,11 +66,25 @@ struct IPv4NetworkSet */ struct IPv6NetworkSet { + /** + * IPv6 address. + */ struct in6_addr network; + + /** + * IPv6 netmask. + */ struct in6_addr netmask; }; +int +GNUNET_SPEEDUP_start_ (const struct GNUNET_CONFIGURATION_Handle *cfg); + +int +GNUNET_SPEEDUP_stop_ (void); + + /** * Parse a network specification. The argument specifies * a list of networks. The format is @@ -72,7 +92,7 @@ struct IPv6NetworkSet * with a semicolon). The network must be given in dotted-decimal * notation. The netmask can be given in CIDR notation (/16) or * in dotted-decimal (/255.255.0.0). - * <p> + * * @param routeList a string specifying the forbidden networks * @return the converted list, NULL if the synatx is flawed */ @@ -89,27 +109,25 @@ parse_ipv4_specification (const char *routeList) int slash; struct IPv4NetworkSet *result; - if (routeList == NULL) + if (NULL == routeList) return NULL; len = strlen (routeList); - if (len == 0) + if (0 == len) return NULL; count = 0; for (i = 0; i < len; i++) if (routeList[i] == ';') count++; result = GNUNET_malloc (sizeof (struct IPv4NetworkSet) * (count + 1)); - /* add termination */ - memset (result, 0, sizeof (struct IPv4NetworkSet) * (count + 1)); i = 0; pos = 0; while (i < count) { cnt = - sscanf (&routeList[pos], "%u.%u.%u.%u/%u.%u.%u.%u;", &temps[0], + SSCANF (&routeList[pos], "%u.%u.%u.%u/%u.%u.%u.%u;", &temps[0], &temps[1], &temps[2], &temps[3], &temps[4], &temps[5], &temps[6], &temps[7]); - if (cnt == 8) + if (8 == cnt) { for (j = 0; j < 8; j++) if (temps[j] > 0xFF) @@ -133,9 +151,9 @@ parse_ipv4_specification (const char *routeList) } /* try second notation */ cnt = - sscanf (&routeList[pos], "%u.%u.%u.%u/%u;", &temps[0], &temps[1], + SSCANF (&routeList[pos], "%u.%u.%u.%u/%u;", &temps[0], &temps[1], &temps[2], &temps[3], &slash); - if (cnt == 5) + if (5 == cnt) { for (j = 0; j < 4; j++) if (temps[j] > 0xFF) @@ -158,7 +176,7 @@ parse_ipv4_specification (const char *routeList) slash--; } result[i].netmask.s_addr = htonl (result[i].netmask.s_addr); - while (routeList[pos] != ';') + while (';' != routeList[pos]) pos++; pos++; i++; @@ -176,9 +194,9 @@ parse_ipv4_specification (const char *routeList) /* try third notation */ slash = 32; cnt = - sscanf (&routeList[pos], "%u.%u.%u.%u;", &temps[0], &temps[1], + SSCANF (&routeList[pos], "%u.%u.%u.%u;", &temps[0], &temps[1], &temps[2], &temps[3]); - if (cnt == 4) + if (4 == cnt) { for (j = 0; j < 4; j++) if (temps[j] > 0xFF) @@ -227,7 +245,7 @@ parse_ipv4_specification (const char *routeList) * with a semicolon). The network must be given in colon-hex * notation. The netmask must be given in CIDR notation (/16) or * can be omitted to specify a single host. - * <p> + * * @param routeListX a string specifying the forbidden networks * @return the converted list, NULL if the synatx is flawed */ @@ -247,17 +265,17 @@ parse_ipv6_specification (const char *routeListX) unsigned int off; int save; - if (routeListX == NULL) + if (NULL == routeListX) return NULL; len = strlen (routeListX); - if (len == 0) + if (0 == len) return NULL; routeList = GNUNET_strdup (routeListX); count = 0; for (i = 0; i < len; i++) - if (routeList[i] == ';') + if (';' == routeList[i]) count++; - if (routeList[len - 1] != ';') + if (';' != routeList[len - 1]) { LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid network notation (does not end with ';': `%s')\n"), @@ -267,13 +285,12 @@ parse_ipv6_specification (const char *routeListX) } result = GNUNET_malloc (sizeof (struct IPv6NetworkSet) * (count + 1)); - memset (result, 0, sizeof (struct IPv6NetworkSet) * (count + 1)); i = 0; pos = 0; while (i < count) { start = pos; - while (routeList[pos] != ';') + while (';' != routeList[pos]) pos++; slash = pos; while ((slash >= start) && (routeList[slash] != '/')) @@ -292,7 +309,7 @@ parse_ipv6_specification (const char *routeListX) save = errno; if ((1 != SSCANF (&routeList[slash + 1], "%u", &bits)) || (bits >= 128)) { - if (ret == 0) + if (0 == ret) LOG (GNUNET_ERROR_TYPE_ERROR, _("Wrong format `%s' for netmask\n"), &routeList[slash + 1]); else @@ -322,7 +339,7 @@ parse_ipv6_specification (const char *routeListX) ret = inet_pton (AF_INET6, &routeList[start], &result[i].network); if (ret <= 0) { - if (ret == 0) + if (0 == ret) LOG (GNUNET_ERROR_TYPE_ERROR, _("Wrong format `%s' for network\n"), &routeList[slash + 1]); else @@ -349,12 +366,11 @@ parse_ipv6_specification (const char *routeListX) static int check_ipv4_listed (const struct IPv4NetworkSet *list, const struct in_addr *add) { - int i; + unsigned int i; - i = 0; - if (list == NULL) + if (NULL == list) return GNUNET_NO; - + i = 0; while ((list[i].network.s_addr != 0) || (list[i].netmask.s_addr != 0)) { if ((add->s_addr & list[i].netmask.s_addr) == @@ -365,6 +381,7 @@ check_ipv4_listed (const struct IPv4NetworkSet *list, const struct in_addr *add) return GNUNET_NO; } + /** * Check if the given IP address is in the list of IP addresses. * @@ -379,13 +396,12 @@ check_ipv6_listed (const struct IPv6NetworkSet *list, const struct in6_addr *ip) unsigned int j; struct in6_addr zero; - if (list == NULL) + if (NULL == list) return GNUNET_NO; - memset (&zero, 0, sizeof (struct in6_addr)); i = 0; NEXT: - while (memcmp (&zero, &list[i].network, sizeof (struct in6_addr)) != 0) + while (0 != memcmp (&zero, &list[i].network, sizeof (struct in6_addr))) { for (j = 0; j < sizeof (struct in6_addr) / sizeof (int); j++) if (((((int *) ip)[j] & ((int *) &list[i].netmask)[j])) != @@ -427,7 +443,7 @@ struct GNUNET_SERVICE_Context /** * Name of our service. */ - const char *serviceName; + const char *service_name; /** * Main service-specific task to run. @@ -478,6 +494,11 @@ struct GNUNET_SERVICE_Context struct GNUNET_NETWORK_Handle **lsocks; /** + * Task ID of the shutdown task. + */ + GNUNET_SCHEDULER_TaskIdentifier shutdown_task; + + /** * Idle timeout for server. */ struct GNUNET_TIME_Relative timeout; @@ -526,6 +547,14 @@ struct GNUNET_SERVICE_Context /* ****************** message handlers ****************** */ +/** + * Send a 'TEST' message back to the client. + * + * @param cls the 'struct GNUNET_SERVER_Client' to send TEST to + * @param size number of bytes available in 'buf' + * @param buf where to copy the message + * @return number of bytes written to 'buf' + */ static size_t write_test (void *cls, size_t size, void *buf) { @@ -544,6 +573,7 @@ write_test (void *cls, size_t size, void *buf) return sizeof (struct GNUNET_MessageHeader); } + /** * Handler for TEST message. * @@ -577,7 +607,6 @@ static const struct GNUNET_SERVER_MessageHandler defhandlers[] = { }; - /* ****************** service core routines ************** */ @@ -605,31 +634,32 @@ check_access (void *cls, const struct GNUNET_CONNECTION_Credentials *uc, case AF_INET: GNUNET_assert (addrlen == sizeof (struct sockaddr_in)); i4 = (const struct sockaddr_in *) addr; - ret = ((sctx->v4_allowed == NULL) || + ret = ((NULL == sctx->v4_allowed) || (check_ipv4_listed (sctx->v4_allowed, &i4->sin_addr))) && - ((sctx->v4_denied == NULL) || + ((NULL == sctx->v4_denied) || (!check_ipv4_listed (sctx->v4_denied, &i4->sin_addr))); break; case AF_INET6: GNUNET_assert (addrlen == sizeof (struct sockaddr_in6)); i6 = (const struct sockaddr_in6 *) addr; - ret = ((sctx->v6_allowed == NULL) || + ret = ((NULL == sctx->v6_allowed) || (check_ipv6_listed (sctx->v6_allowed, &i6->sin6_addr))) && - ((sctx->v6_denied == NULL) || + ((NULL == sctx->v6_denied) || (!check_ipv6_listed (sctx->v6_denied, &i6->sin6_addr))); break; #ifndef WINDOWS case AF_UNIX: ret = GNUNET_OK; /* always OK for now */ - if (sctx->match_uid == GNUNET_YES) + if (GNUNET_YES == sctx->match_uid) { /* UID match required */ - ret = (uc != NULL) && (uc->uid == geteuid ()); + ret = (NULL != uc) && (uc->uid == geteuid ()); } - else if (sctx->match_gid == GNUNET_YES) + else if ( (GNUNET_YES == sctx->match_gid) && + ( (NULL == uc) || (uc->uid != geteuid ()) ) ) { - /* group match required */ - if (uc == NULL) + /* group match required and UID does not match */ + if (NULL == uc) { /* no credentials, group match not possible */ ret = GNUNET_NO; @@ -666,7 +696,7 @@ check_access (void *cls, const struct GNUNET_CONNECTION_Credentials *uc, } if (GNUNET_NO == ret) LOG (GNUNET_ERROR_TYPE_WARNING, _("Access denied to UID %d / GID %d\n"), - (uc == NULL) ? -1 : uc->uid, (uc == NULL) ? -1 : uc->gid); + (NULL == uc) ? -1 : uc->uid, (NULL == uc) ? -1 : uc->gid); break; #endif default: @@ -674,12 +704,12 @@ check_access (void *cls, const struct GNUNET_CONNECTION_Credentials *uc, addr->sa_family); return GNUNET_SYSERR; } - if (ret != GNUNET_OK) + if (GNUNET_OK != ret) { LOG (GNUNET_ERROR_TYPE_WARNING, - _("Access from `%s' denied to service `%s'\n"), GNUNET_a2s (addr, - addrlen), - sctx->serviceName); + _("Access from `%s' denied to service `%s'\n"), + GNUNET_a2s (addr, addrlen), + sctx->service_name); } return ret; } @@ -688,15 +718,17 @@ check_access (void *cls, const struct GNUNET_CONNECTION_Credentials *uc, /** * Get the name of the file where we will * write the PID of the service. + * + * @param sctx service context + * @return name of the file for the process ID */ static char * get_pid_file_name (struct GNUNET_SERVICE_Context *sctx) { - char *pif; if (GNUNET_OK != - GNUNET_CONFIGURATION_get_value_filename (sctx->cfg, sctx->serviceName, + GNUNET_CONFIGURATION_get_value_filename (sctx->cfg, sctx->service_name, "PIDFILE", &pif)) return NULL; return pif; @@ -705,6 +737,12 @@ get_pid_file_name (struct GNUNET_SERVICE_Context *sctx) /** * Parse an IPv4 access control list. + * + * @param ret location where to write the ACL (set) + * @param sctx service context to use to get the configuration + * @param option name of the ACL option to parse + * @return GNUNET_SYSERR on parse error, GNUNET_OK on success (including + * no ACL configured) */ static int process_acl4 (struct IPv4NetworkSet **ret, struct GNUNET_SERVICE_Context *sctx, @@ -712,17 +750,20 @@ process_acl4 (struct IPv4NetworkSet **ret, struct GNUNET_SERVICE_Context *sctx, { char *opt; - if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option)) + if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->service_name, option)) + { + *ret = NULL; return GNUNET_OK; + } GNUNET_break (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (sctx->cfg, - sctx->serviceName, + sctx->service_name, option, &opt)); if (NULL == (*ret = parse_ipv4_specification (opt))) { LOG (GNUNET_ERROR_TYPE_WARNING, _("Could not parse IPv4 network specification `%s' for `%s:%s'\n"), - opt, sctx->serviceName, option); + opt, sctx->service_name, option); GNUNET_free (opt); return GNUNET_SYSERR; } @@ -732,7 +773,13 @@ process_acl4 (struct IPv4NetworkSet **ret, struct GNUNET_SERVICE_Context *sctx, /** - * Parse an IPv4 access control list. + * Parse an IPv6 access control list. + * + * @param ret location where to write the ACL (set) + * @param sctx service context to use to get the configuration + * @param option name of the ACL option to parse + * @return GNUNET_SYSERR on parse error, GNUNET_OK on success (including + * no ACL configured) */ static int process_acl6 (struct IPv6NetworkSet **ret, struct GNUNET_SERVICE_Context *sctx, @@ -740,17 +787,20 @@ process_acl6 (struct IPv6NetworkSet **ret, struct GNUNET_SERVICE_Context *sctx, { char *opt; - if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, option)) + if (!GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->service_name, option)) + { + *ret = NULL; return GNUNET_OK; + } GNUNET_break (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (sctx->cfg, - sctx->serviceName, + sctx->service_name, option, &opt)); if (NULL == (*ret = parse_ipv6_specification (opt))) { LOG (GNUNET_ERROR_TYPE_WARNING, _("Could not parse IPv6 network specification `%s' for `%s:%s'\n"), - opt, sctx->serviceName, option); + opt, sctx->service_name, option); GNUNET_free (opt); return GNUNET_SYSERR; } @@ -758,6 +808,7 @@ process_acl6 (struct IPv6NetworkSet **ret, struct GNUNET_SERVICE_Context *sctx, return GNUNET_OK; } + /** * Add the given UNIX domain path as an address to the * list (as the first entry). @@ -802,7 +853,7 @@ add_unixpath (struct sockaddr **saddrs, socklen_t * saddrlens, * Get the list of addresses that a server for the given service * should bind to. * - * @param serviceName name of the service + * @param service_name name of the service * @param cfg configuration (which specifies the addresses) * @param addrs set (call by reference) to an array of pointers to the * addresses the server should bind to and listen on; the @@ -819,7 +870,7 @@ add_unixpath (struct sockaddr **saddrs, socklen_t * saddrlens, * set to NULL). */ int -GNUNET_SERVICE_get_server_addresses (const char *serviceName, +GNUNET_SERVICE_get_server_addresses (const char *service_name, const struct GNUNET_CONFIGURATION_Handle *cfg, struct sockaddr ***addrs, socklen_t ** addr_lens) @@ -842,11 +893,11 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, *addrs = NULL; *addr_lens = NULL; desc = NULL; - if (GNUNET_CONFIGURATION_have_value (cfg, serviceName, "DISABLEV6")) + if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "DISABLEV6")) { if (GNUNET_SYSERR == (disablev6 = - GNUNET_CONFIGURATION_get_value_yesno (cfg, serviceName, "DISABLEV6"))) + GNUNET_CONFIGURATION_get_value_yesno (cfg, service_name, "DISABLEV6"))) return GNUNET_SYSERR; } else @@ -858,8 +909,8 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0); if (NULL == desc) { - if ((errno == ENOBUFS) || (errno == ENOMEM) || (errno == ENFILE) || - (errno == EACCES)) + if ((ENOBUFS == errno) || (ENOMEM == errno) || (ENFILE == errno) || + (EACCES == errno)) { LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket"); return GNUNET_SYSERR; @@ -867,7 +918,7 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, LOG (GNUNET_ERROR_TYPE_INFO, _ ("Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"), - serviceName, STRERROR (errno)); + service_name, STRERROR (errno)); disablev6 = GNUNET_YES; } else @@ -878,24 +929,24 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, } port = 0; - if (GNUNET_CONFIGURATION_have_value (cfg, serviceName, "PORT")) + if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT")) { GNUNET_break (GNUNET_OK == - GNUNET_CONFIGURATION_get_value_number (cfg, serviceName, + GNUNET_CONFIGURATION_get_value_number (cfg, service_name, "PORT", &port)); if (port > 65535) { LOG (GNUNET_ERROR_TYPE_ERROR, _("Require valid port number for service `%s' in configuration!\n"), - serviceName); + service_name); return GNUNET_SYSERR; } } - if (GNUNET_CONFIGURATION_have_value (cfg, serviceName, "BINDTO")) + if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "BINDTO")) { GNUNET_break (GNUNET_OK == - GNUNET_CONFIGURATION_get_value_string (cfg, serviceName, + GNUNET_CONFIGURATION_get_value_string (cfg, service_name, "BINDTO", &hostname)); } else @@ -904,9 +955,9 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, unixpath = NULL; #ifdef AF_UNIX if ((GNUNET_YES == - GNUNET_CONFIGURATION_have_value (cfg, serviceName, "UNIXPATH")) && + GNUNET_CONFIGURATION_have_value (cfg, service_name, "UNIXPATH")) && (GNUNET_OK == - GNUNET_CONFIGURATION_get_value_string (cfg, serviceName, "UNIXPATH", + GNUNET_CONFIGURATION_get_value_string (cfg, service_name, "UNIXPATH", &unixpath)) && (0 < strlen (unixpath))) { @@ -926,8 +977,8 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, desc = GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_STREAM, 0); if (NULL == desc) { - if ((errno == ENOBUFS) || (errno == ENOMEM) || (errno == ENFILE) || - (errno == EACCES)) + if ((ENOBUFS == errno) || (ENOMEM == errno) || (ENFILE == errno) || + (EACCES == errno)) { LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket"); GNUNET_free_non_null (hostname); @@ -937,7 +988,7 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, LOG (GNUNET_ERROR_TYPE_INFO, _ ("Disabling UNIX domain socket support for service `%s', failed to create UNIX domain socket: %s\n"), - serviceName, STRERROR (errno)); + service_name, STRERROR (errno)); GNUNET_free (unixpath); unixpath = NULL; } @@ -949,16 +1000,16 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, } #endif - if ((port == 0) && (unixpath == NULL)) + if ((0 == port) && (NULL == unixpath)) { LOG (GNUNET_ERROR_TYPE_ERROR, _ ("Have neither PORT nor UNIXPATH for service `%s', but one is required\n"), - serviceName); + service_name); GNUNET_free_non_null (hostname); return GNUNET_SYSERR; } - if (port == 0) + if (0 == port) { saddrs = GNUNET_malloc (2 * sizeof (struct sockaddr *)); saddrlens = GNUNET_malloc (2 * sizeof (socklen_t)); @@ -970,16 +1021,15 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, return 1; } - if (hostname != NULL) + if (NULL != hostname) { -#if DEBUG_SERVICE LOG (GNUNET_ERROR_TYPE_DEBUG, "Resolving `%s' since that is where `%s' will bind to.\n", hostname, - serviceName); -#endif + service_name); memset (&hints, 0, sizeof (struct addrinfo)); if (disablev6) hints.ai_family = AF_INET; + hints.ai_protocol = IPPROTO_TCP; if ((0 != (ret = getaddrinfo (hostname, NULL, &hints, &res))) || (res == NULL)) { @@ -1022,19 +1072,17 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, while (NULL != (pos = next)) { next = pos->ai_next; - if ((disablev6) && (pos->ai_family == AF_INET6)) + if ((disablev6) && (AF_INET6 == pos->ai_family)) continue; - if ((pos->ai_protocol != IPPROTO_TCP) && (pos->ai_protocol != 0)) + if ((IPPROTO_TCP != pos->ai_protocol) && (0 != pos->ai_protocol)) continue; /* not TCP */ - if ((pos->ai_socktype != SOCK_STREAM) && (pos->ai_socktype != 0)) + if ((SOCK_STREAM != pos->ai_socktype) && (0 != pos->ai_socktype)) continue; /* huh? */ -#if DEBUG_SERVICE LOG (GNUNET_ERROR_TYPE_DEBUG, "Service `%s' will bind to `%s'\n", - serviceName, GNUNET_a2s (pos->ai_addr, pos->ai_addrlen)); -#endif - if (pos->ai_family == AF_INET) + service_name, GNUNET_a2s (pos->ai_addr, pos->ai_addrlen)); + if (AF_INET == pos->ai_family) { - GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in)); + GNUNET_assert (sizeof (struct sockaddr_in) == pos->ai_addrlen); saddrlens[i] = pos->ai_addrlen; saddrs[i] = GNUNET_malloc (saddrlens[i]); memcpy (saddrs[i], pos->ai_addr, saddrlens[i]); @@ -1042,8 +1090,8 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, } else { - GNUNET_assert (pos->ai_family == AF_INET6); - GNUNET_assert (pos->ai_addrlen == sizeof (struct sockaddr_in6)); + GNUNET_assert (AF_INET6 == pos->ai_family); + GNUNET_assert (sizeof (struct sockaddr_in6) == pos->ai_addrlen); saddrlens[i] = pos->ai_addrlen; saddrs[i] = GNUNET_malloc (saddrlens[i]); memcpy (saddrs[i], pos->ai_addr, saddrlens[i]); @@ -1120,6 +1168,9 @@ GNUNET_SERVICE_get_server_addresses (const char *serviceName, #ifdef MINGW /** + * Read listen sockets from the parent process (ARM). + * + * @param sctx service context to initialize * @return GNUNET_YES if ok, GNUNET_NO if not ok (must bind yourself), * and GNUNET_SYSERR on error. */ @@ -1128,22 +1179,20 @@ receive_sockets_from_parent (struct GNUNET_SERVICE_Context *sctx) { const char *env_buf; int fail; - uint64_t count, i; + uint64_t count; + uint64_t i; HANDLE lsocks_pipe; env_buf = getenv ("GNUNET_OS_READ_LSOCKS"); - if ((env_buf == NULL) || (strlen (env_buf) <= 0)) - { + if ((NULL == env_buf) || (strlen (env_buf) <= 0)) return GNUNET_NO; - } /* Using W32 API directly here, because this pipe will * never be used outside of this function, and it's just too much of a bother * to create a GNUnet API that boxes a HANDLE (the way it is done with socks) */ lsocks_pipe = (HANDLE) strtoul (env_buf, NULL, 10); - if (lsocks_pipe == 0 || lsocks_pipe == INVALID_HANDLE_VALUE) + if ( (0 == lsocks_pipe) || (INVALID_HANDLE_VALUE == lsocks_pipe)) return GNUNET_NO; - fail = 1; do { @@ -1152,7 +1201,7 @@ receive_sockets_from_parent (struct GNUNET_SERVICE_Context *sctx) DWORD rd; ret = ReadFile (lsocks_pipe, &count, sizeof (count), &rd, NULL); - if (ret == 0 || rd != sizeof (count) || count == 0) + if ((0 == ret) || (sizeof (count) != rd) || (0 == count)) break; sctx->lsocks = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (count + 1)); @@ -1163,15 +1212,16 @@ receive_sockets_from_parent (struct GNUNET_SERVICE_Context *sctx) WSAPROTOCOL_INFOA pi; uint64_t size; SOCKET s; + ret = ReadFile (lsocks_pipe, &size, sizeof (size), &rd, NULL); - if (ret == 0 || rd != sizeof (size) || size != sizeof (pi)) + if ( (0 == ret) || (sizeof (size) != rd) || (sizeof (pi) != size) ) break; ret = ReadFile (lsocks_pipe, &pi, sizeof (pi), &rd, NULL); - if (ret == 0 || rd != sizeof (pi)) + if ( (0 == ret) || (sizeof (pi) != rd)) break; s = WSASocketA (pi.iAddressFamily, pi.iSocketType, pi.iProtocol, &pi, 0, WSA_FLAG_OVERLAPPED); sctx->lsocks[i] = GNUNET_NETWORK_socket_box_native (s); - if (sctx->lsocks[i] == NULL) + if (NULL == sctx->lsocks[i]) break; else if (i == count - 1) fail2 = 0; @@ -1189,13 +1239,12 @@ receive_sockets_from_parent (struct GNUNET_SERVICE_Context *sctx) { LOG (GNUNET_ERROR_TYPE_ERROR, _("Could not access a pre-bound socket, will try to bind myself\n")); - for (i = 0; i < count && sctx->lsocks[i] != NULL; i++) + for (i = 0; (i < count) && (NULL != sctx->lsocks[i]); i++) GNUNET_break (0 == GNUNET_NETWORK_socket_close (sctx->lsocks[i])); GNUNET_free_non_null (sctx->lsocks); sctx->lsocks = NULL; return GNUNET_NO; } - return GNUNET_YES; } #endif @@ -1216,6 +1265,7 @@ receive_sockets_from_parent (struct GNUNET_SERVICE_Context *sctx) * - REJECT_FROM (disallow allow connections from specified IPv4 subnets) * - REJECT_FROM6 (disallow allow connections from specified IPv6 subnets) * + * @param sctx service context to initialize * @return GNUNET_OK if configuration succeeded */ static int @@ -1232,15 +1282,15 @@ setup_service (struct GNUNET_SERVICE_Context *sctx) int flags; #endif - if (GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->serviceName, "TIMEOUT")) + if (GNUNET_CONFIGURATION_have_value (sctx->cfg, sctx->service_name, "TIMEOUT")) { if (GNUNET_OK != - GNUNET_CONFIGURATION_get_value_time (sctx->cfg, sctx->serviceName, + GNUNET_CONFIGURATION_get_value_time (sctx->cfg, sctx->service_name, "TIMEOUT", &idleout)) { LOG (GNUNET_ERROR_TYPE_ERROR, _("Specified value for `%s' of service `%s' is invalid\n"), - "TIMEOUT", sctx->serviceName); + "TIMEOUT", sctx->service_name); return GNUNET_SYSERR; } sctx->timeout = idleout; @@ -1249,16 +1299,16 @@ setup_service (struct GNUNET_SERVICE_Context *sctx) sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL; if (GNUNET_CONFIGURATION_have_value - (sctx->cfg, sctx->serviceName, "TOLERANT")) + (sctx->cfg, sctx->service_name, "TOLERANT")) { if (GNUNET_SYSERR == (tolerant = - GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->serviceName, + GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->service_name, "TOLERANT"))) { LOG (GNUNET_ERROR_TYPE_ERROR, _("Specified value for `%s' of service `%s' is invalid\n"), - "TOLERANT", sctx->serviceName); + "TOLERANT", sctx->service_name); return GNUNET_SYSERR; } } @@ -1268,9 +1318,9 @@ setup_service (struct GNUNET_SERVICE_Context *sctx) #ifndef MINGW errno = 0; if ((NULL != (lpid = getenv ("LISTEN_PID"))) && - (1 == sscanf (lpid, "%u", &pid)) && (getpid () == (pid_t) pid) && + (1 == SSCANF (lpid, "%u", &pid)) && (getpid () == (pid_t) pid) && (NULL != (nfds = getenv ("LISTEN_FDS"))) && - (1 == sscanf (nfds, "%u", &cnt)) && (cnt > 0) && (cnt < FD_SETSIZE) && + (1 == SSCANF (nfds, "%u", &cnt)) && (cnt > 0) && (cnt < FD_SETSIZE) && (cnt + 4 < FD_SETSIZE)) { sctx->lsocks = @@ -1305,17 +1355,17 @@ setup_service (struct GNUNET_SERVICE_Context *sctx) } #endif - if ((sctx->lsocks == NULL) && + if ((NULL == sctx->lsocks) && (GNUNET_SYSERR == - GNUNET_SERVICE_get_server_addresses (sctx->serviceName, sctx->cfg, + GNUNET_SERVICE_get_server_addresses (sctx->service_name, sctx->cfg, &sctx->addrs, &sctx->addrlens))) return GNUNET_SYSERR; sctx->require_found = tolerant ? GNUNET_NO : GNUNET_YES; sctx->match_uid = - GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->serviceName, + GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->service_name, "UNIX_MATCH_UID"); sctx->match_gid = - GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->serviceName, + GNUNET_CONFIGURATION_get_value_yesno (sctx->cfg, sctx->service_name, "UNIX_MATCH_GID"); process_acl4 (&sctx->v4_denied, sctx, "REJECT_FROM"); process_acl4 (&sctx->v4_allowed, sctx, "ACCEPT_FROM"); @@ -1329,15 +1379,17 @@ setup_service (struct GNUNET_SERVICE_Context *sctx) /** * Get the name of the user that'll be used * to provide the service. + * + * @param sctx service context + * @return value of the 'USERNAME' option */ static char * get_user_name (struct GNUNET_SERVICE_Context *sctx) { - char *un; if (GNUNET_OK != - GNUNET_CONFIGURATION_get_value_filename (sctx->cfg, sctx->serviceName, + GNUNET_CONFIGURATION_get_value_filename (sctx->cfg, sctx->service_name, "USERNAME", &un)) return NULL; return un; @@ -1345,6 +1397,10 @@ get_user_name (struct GNUNET_SERVICE_Context *sctx) /** * Write PID file. + * + * @param sctx service context + * @param pid PID to write (should be equal to 'getpid()' + * @return GNUNET_OK on success (including no work to be done) */ static int write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid) @@ -1368,7 +1424,7 @@ write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid) /* we get to create a directory -- and claim it * as ours! */ GNUNET_DISK_directory_create (rdir); - if ((user != NULL) && (0 < strlen (user))) + if ((NULL != user) && (0 < strlen (user))) GNUNET_DISK_file_change_owner (rdir, user); } if (0 != ACCESS (rdir, W_OK | X_OK)) @@ -1381,7 +1437,7 @@ write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid) } GNUNET_free (rdir); pidfd = FOPEN (pif, "w"); - if (pidfd == NULL) + if (NULL == pidfd) { LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "fopen", pif); GNUNET_free (pif); @@ -1391,7 +1447,7 @@ write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid) if (0 > FPRINTF (pidfd, "%u", pid)) LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "fprintf", pif); GNUNET_break (0 == FCLOSE (pidfd)); - if ((user != NULL) && (0 < strlen (user))) + if ((NULL != user) && (0 < strlen (user))) GNUNET_DISK_file_change_owner (pif, user); GNUNET_free_non_null (user); GNUNET_free (pif); @@ -1400,22 +1456,30 @@ write_pid_file (struct GNUNET_SERVICE_Context *sctx, pid_t pid) /** - * Task run during shutdown. + * Task run during shutdown. Stops the server/service. * - * @param cls unused + * @param cls the 'struct GNUNET_SERVICE_Context' * @param tc unused */ static void shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) { - struct GNUNET_SERVER_Handle *server = cls; + struct GNUNET_SERVICE_Context *service = cls; + struct GNUNET_SERVER_Handle *server = service->server; - GNUNET_SERVER_destroy (server); + service->shutdown_task = GNUNET_SCHEDULER_NO_TASK; + if (0 != (service->options & GNUNET_SERVICE_OPTION_SOFT_SHUTDOWN)) + GNUNET_SERVER_stop_listening (server); + else + GNUNET_SERVER_destroy (server); } /** * Initial task for the service. + * + * @param cls service context + * @param tc unused */ static void service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) @@ -1424,7 +1488,7 @@ service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) unsigned int i; GNUNET_RESOLVER_connect (sctx->cfg); - if (sctx->lsocks != NULL) + if (NULL != sctx->lsocks) sctx->server = GNUNET_SERVER_create_with_sockets (&check_access, sctx, sctx->lsocks, sctx->timeout, sctx->require_found); @@ -1432,15 +1496,15 @@ service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) sctx->server = GNUNET_SERVER_create (&check_access, sctx, sctx->addrs, sctx->addrlens, sctx->timeout, sctx->require_found); - if (sctx->server == NULL) + if (NULL == sctx->server) { - if (sctx->addrs != NULL) + if (NULL != sctx->addrs) { i = 0; - while (sctx->addrs[i] != NULL) + while (NULL != sctx->addrs[i]) { LOG (GNUNET_ERROR_TYPE_INFO, _("Failed to start `%s' at `%s'\n"), - sctx->serviceName, GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i])); + sctx->service_name, GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i])); i++; } } @@ -1451,29 +1515,29 @@ service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) { /* install a task that will kill the server * process if the scheduler ever gets a shutdown signal */ - GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task, - sctx->server); + sctx->shutdown_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task, + sctx); } sctx->my_handlers = GNUNET_malloc (sizeof (defhandlers)); memcpy (sctx->my_handlers, defhandlers, sizeof (defhandlers)); i = 0; - while ((sctx->my_handlers[i].callback != NULL)) + while (NULL != sctx->my_handlers[i].callback) sctx->my_handlers[i++].callback_cls = sctx; GNUNET_SERVER_add_handlers (sctx->server, sctx->my_handlers); - if (sctx->ready_confirm_fd != -1) + if (-1 != sctx->ready_confirm_fd) { GNUNET_break (1 == WRITE (sctx->ready_confirm_fd, ".", 1)); GNUNET_break (0 == CLOSE (sctx->ready_confirm_fd)); sctx->ready_confirm_fd = -1; write_pid_file (sctx, getpid ()); } - if (sctx->addrs != NULL) + if (NULL != sctx->addrs) { i = 0; - while (sctx->addrs[i] != NULL) + while (NULL != sctx->addrs[i]) { LOG (GNUNET_ERROR_TYPE_INFO, _("Service `%s' runs at %s\n"), - sctx->serviceName, GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i])); + sctx->service_name, GNUNET_a2s (sctx->addrs[i], sctx->addrlens[i])); i++; } } @@ -1483,6 +1547,9 @@ service_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) /** * Detach from terminal. + * + * @param sctx service context + * @return GNUNET_OK on success, GNUNET_SYSERR on error */ static int detach_terminal (struct GNUNET_SERVICE_Context *sctx) @@ -1503,7 +1570,7 @@ detach_terminal (struct GNUNET_SERVICE_Context *sctx) LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "fork"); return GNUNET_SYSERR; } - if (pid != 0) + if (0 != pid) { /* Parent */ char c; @@ -1547,7 +1614,7 @@ detach_terminal (struct GNUNET_SERVICE_Context *sctx) (void) CLOSE (nullfd); /* Detach from controlling terminal */ pid = setsid (); - if (pid == -1) + if (-1 == pid) LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "setsid"); sctx->ready_confirm_fd = filedes[1]; #else @@ -1561,6 +1628,9 @@ detach_terminal (struct GNUNET_SERVICE_Context *sctx) /** * Set user ID. + * + * @param sctx service context + * @return GNUNET_OK on success, GNUNET_SYSERR on error */ static int set_user_id (struct GNUNET_SERVICE_Context *sctx) @@ -1574,7 +1644,7 @@ set_user_id (struct GNUNET_SERVICE_Context *sctx) errno = 0; pws = getpwnam (user); - if (pws == NULL) + if (NULL == pws) { LOG (GNUNET_ERROR_TYPE_ERROR, _("Cannot obtain information about user `%s': %s\n"), user, @@ -1605,13 +1675,15 @@ set_user_id (struct GNUNET_SERVICE_Context *sctx) /** * Delete the PID file that was created by our parent. + * + * @param sctx service context */ static void pid_file_delete (struct GNUNET_SERVICE_Context *sctx) { char *pif = get_pid_file_name (sctx); - if (pif == NULL) + if (NULL == pif) return; /* no PID file */ if (0 != UNLINK (pif)) LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "unlink", pif); @@ -1625,16 +1697,16 @@ pid_file_delete (struct GNUNET_SERVICE_Context *sctx) * * @param argc number of command line arguments * @param argv command line arguments - * @param serviceName our service name - * @param opt service options + * @param service_name our service name + * @param options service options * @param task main task of the service * @param task_cls closure for task * @return GNUNET_SYSERR on error, GNUNET_OK * if we shutdown nicely */ int -GNUNET_SERVICE_run (int argc, char *const *argv, const char *serviceName, - enum GNUNET_SERVICE_Options opt, GNUNET_SERVICE_Main task, +GNUNET_SERVICE_run (int argc, char *const *argv, const char *service_name, + enum GNUNET_SERVICE_Options options, GNUNET_SERVICE_Main task, void *task_cls) { #define HANDLE_ERROR do { GNUNET_break (0); goto shutdown; } while (0) @@ -1656,7 +1728,7 @@ GNUNET_SERVICE_run (int argc, char *const *argv, const char *serviceName, {'d', "daemonize", NULL, gettext_noop ("do daemonize (detach from terminal)"), 0, GNUNET_GETOPT_set_one, &do_daemonize}, - GNUNET_GETOPT_OPTION_HELP (serviceName), + GNUNET_GETOPT_OPTION_HELP (NULL), GNUNET_GETOPT_OPTION_LOGLEVEL (&loglev), GNUNET_GETOPT_OPTION_LOGFILE (&logfile), GNUNET_GETOPT_OPTION_VERSION (PACKAGE_VERSION), @@ -1668,32 +1740,30 @@ GNUNET_SERVICE_run (int argc, char *const *argv, const char *serviceName, loglev = NULL; cfg_fn = GNUNET_strdup (GNUNET_DEFAULT_USER_CONFIG_FILE); memset (&sctx, 0, sizeof (sctx)); - sctx.options = opt; + sctx.options = options; sctx.ready_confirm_fd = -1; sctx.ret = GNUNET_OK; sctx.timeout = GNUNET_TIME_UNIT_FOREVER_REL; sctx.task = task; sctx.task_cls = task_cls; - sctx.serviceName = serviceName; + sctx.service_name = service_name; sctx.cfg = cfg = GNUNET_CONFIGURATION_create (); /* setup subsystems */ if (GNUNET_SYSERR == - GNUNET_GETOPT_run (serviceName, service_options, argc, argv)) + GNUNET_GETOPT_run (service_name, service_options, argc, argv)) goto shutdown; - if (GNUNET_OK != GNUNET_log_setup (serviceName, loglev, logfile)) + if (GNUNET_OK != GNUNET_log_setup (service_name, loglev, logfile)) HANDLE_ERROR; if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfg_fn)) goto shutdown; if (GNUNET_OK != setup_service (&sctx)) goto shutdown; - if ((do_daemonize == 1) && (GNUNET_OK != detach_terminal (&sctx))) + if ((1 == do_daemonize) && (GNUNET_OK != detach_terminal (&sctx))) HANDLE_ERROR; if (GNUNET_OK != set_user_id (&sctx)) goto shutdown; -#if DEBUG_SERVICE LOG (GNUNET_ERROR_TYPE_DEBUG, - "Service `%s' runs with configuration from `%s'\n", serviceName, cfg_fn); -#endif + "Service `%s' runs with configuration from `%s'\n", service_name, cfg_fn); if ((GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (sctx.cfg, "TESTING", "SKEW_OFFSET", &skew_offset)) && @@ -1703,31 +1773,30 @@ GNUNET_SERVICE_run (int argc, char *const *argv, const char *serviceName, { clock_offset = skew_offset - skew_variance; GNUNET_TIME_set_offset (clock_offset); -#if DEBUG_SERVICE LOG (GNUNET_ERROR_TYPE_DEBUG, "Skewing clock by %dll ms\n", clock_offset); -#endif } /* actually run service */ err = 0; GNUNET_SCHEDULER_run (&service_task, &sctx); - + GNUNET_SPEEDUP_start_ (cfg); /* shutdown */ - if ((do_daemonize == 1) && (sctx.server != NULL)) + if ((1 == do_daemonize) && (NULL != sctx.server)) pid_file_delete (&sctx); GNUNET_free_non_null (sctx.my_handlers); shutdown: - if (sctx.ready_confirm_fd != -1) + if (-1 != sctx.ready_confirm_fd) { if (1 != WRITE (sctx.ready_confirm_fd, err ? "I" : "S", 1)) LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "write"); GNUNET_break (0 == CLOSE (sctx.ready_confirm_fd)); } + GNUNET_SPEEDUP_stop_ (); GNUNET_CONFIGURATION_destroy (cfg); i = 0; - if (sctx.addrs != NULL) - while (sctx.addrs[i] != NULL) + if (NULL != sctx.addrs) + while (NULL != sctx.addrs[i]) GNUNET_free (sctx.addrs[i++]); GNUNET_free_non_null (sctx.addrs); GNUNET_free_non_null (sctx.addrlens); @@ -1747,13 +1816,15 @@ shutdown: * Run a service startup sequence within an existing * initialized system. * - * @param serviceName our service name + * @param service_name our service name * @param cfg configuration to use + * @param options service options * @return NULL on error, service handle */ struct GNUNET_SERVICE_Context * -GNUNET_SERVICE_start (const char *serviceName, - const struct GNUNET_CONFIGURATION_Handle *cfg) +GNUNET_SERVICE_start (const char *service_name, + const struct GNUNET_CONFIGURATION_Handle *cfg, + enum GNUNET_SERVICE_Options options) { int i; struct GNUNET_SERVICE_Context *sctx; @@ -1762,8 +1833,9 @@ GNUNET_SERVICE_start (const char *serviceName, sctx->ready_confirm_fd = -1; /* no daemonizing */ sctx->ret = GNUNET_OK; sctx->timeout = GNUNET_TIME_UNIT_FOREVER_REL; - sctx->serviceName = serviceName; + sctx->service_name = service_name; sctx->cfg = cfg; + sctx->options = options; /* setup subsystems */ if (GNUNET_OK != setup_service (sctx)) @@ -1771,7 +1843,7 @@ GNUNET_SERVICE_start (const char *serviceName, GNUNET_SERVICE_stop (sctx); return NULL; } - if (sctx->lsocks != NULL) + if (NULL != sctx->lsocks) sctx->server = GNUNET_SERVER_create_with_sockets (&check_access, sctx, sctx->lsocks, sctx->timeout, sctx->require_found); @@ -1794,6 +1866,7 @@ GNUNET_SERVICE_start (const char *serviceName, return sctx; } + /** * Obtain the server used by a service. Note that the server must NOT * be destroyed by the caller. @@ -1818,13 +1891,18 @@ GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx) { unsigned int i; + if (GNUNET_SCHEDULER_NO_TASK != sctx->shutdown_task) + { + GNUNET_SCHEDULER_cancel (sctx->shutdown_task); + sctx->shutdown_task = GNUNET_SCHEDULER_NO_TASK; + } if (NULL != sctx->server) GNUNET_SERVER_destroy (sctx->server); GNUNET_free_non_null (sctx->my_handlers); - if (sctx->addrs != NULL) + if (NULL != sctx->addrs) { i = 0; - while (sctx->addrs[i] != NULL) + while (NULL != sctx->addrs[i]) GNUNET_free (sctx->addrs[i++]); GNUNET_free (sctx->addrs); } |