gnunet-service-arm.c File Reference

the automated restart manager service More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_arm_service.h"
#include "gnunet_protocols.h"
#include "arm.h"

Include dependency graph for gnunet-service-arm.c:

Go to the source code of this file.

Data Structures
struct	ServiceListeningInfo
	Record with information about a listen socket we have open. More...
struct	ServiceList
	List of our services. More...

Macros
#define	LOG(kind, ...)   GNUNET_log_from (kind, "util", __VA_ARGS__)
#define	LOG_STRERROR(kind, syscall)    GNUNET_log_from_strerror (kind, "util", syscall)
#define	MAX_NOTIFY_QUEUE   1024
	How many messages do we queue up at most for optional notifications to a client? (this can cause notifications about outgoing messages to be dropped). More...

Functions
static void	add_unixpath (struct sockaddr **saddrs, socklen_t *saddrlens, const char *unixpath, int abstract)
	Add the given UNIX domain path as an address to the list (as the first entry). More...
static int	get_server_addresses (const char *service_name, const struct GNUNET_CONFIGURATION_Handle *cfg, struct sockaddr ***addrs, socklen_t **addr_lens)
	Get the list of addresses that a server for the given service should bind to. More...
static void	signal_result (struct GNUNET_SERVICE_Client *client, const char *name, uint64_t request_id, enum GNUNET_ARM_Result result)
	Signal our client that we will start or stop the service. More...
static void	broadcast_status (const char *name, enum GNUNET_ARM_ServiceMonitorStatus status, struct GNUNET_SERVICE_Client *unicast)
	Tell all clients about status change of a service. More...
static void	start_process (struct ServiceList *sl, struct GNUNET_SERVICE_Client *client, uint64_t request_id)
	Actually start the process for the given service. More...
static struct ServiceList *	find_service (const char *name)
	Find the process with the given service name in the given list and return it. More...
static void	accept_connection (void *cls)
	First connection has come to the listening socket associated with the service, create the service in order to relay the incoming connection to it. More...
static void	create_listen_socket (struct sockaddr *sa, socklen_t addr_len, struct ServiceList *sl)
	Creating a listening socket for each of the service's addresses and wait for the first incoming connection to it. More...
static void	free_service (struct ServiceList *sl)
	Remove and free an entry in the service list. More...
static int	check_start (void *cls, const struct GNUNET_ARM_Message *amsg)
	Check START-message. More...
static void	handle_start (void *cls, const struct GNUNET_ARM_Message *amsg)
	Handle START-message. More...
static void	trigger_shutdown (void *cls)
	Start a shutdown sequence. More...
static int	check_stop (void *cls, const struct GNUNET_ARM_Message *amsg)
	Check STOP-message. More...
static void	handle_stop (void *cls, const struct GNUNET_ARM_Message *amsg)
	Handle STOP-message. More...
static int	pool_write (char *pool_start, size_t pool_size, size_t *pool_pos, char *str)
	Write a string to a string pool. More...
static void	handle_list (void *cls, const struct GNUNET_ARM_Message *request)
	Handle LIST-message. More...
static void	handle_test (void *cls, const struct GNUNET_MessageHeader *message)
	Handle TEST-message by sending back TEST. More...
static void	do_shutdown ()
	We are done with everything. More...
static unsigned int	list_count (struct ServiceList *running_head)
	Count how many services are still active. More...
static void	shutdown_task (void *cls)
	Task run for shutdown. More...
static void	delayed_restart_task (void *cls)
	Task run whenever it is time to restart a child that died. More...
static void	maint_child_death (void *cls)
	Task triggered whenever we receive a SIGCHLD (child process died). More...
static void	sighandler_child_death ()
	Signal handler called for SIGCHLD. More...
static void	setup_service (void *cls, const char *section)
	Setup our service record for the given section in the configuration file (assuming the section is for a service). More...
static void *	client_connect_cb (void *cls, struct GNUNET_SERVICE_Client *client, struct GNUNET_MQ_Handle *mq)
	A client connected, mark as a monitoring client. More...
static void	client_disconnect_cb (void *cls, struct GNUNET_SERVICE_Client *client, void *app_ctx)
	A client disconnected, clean up associated state. More...
static void	handle_monitor (void *cls, const struct GNUNET_MessageHeader *message)
	Handle MONITOR-message. More...
static void	run (void *cls, const struct GNUNET_CONFIGURATION_Handle *c, struct GNUNET_SERVICE_Handle *serv)
	Process arm requests. More...
int	main (int argc, char *const *argv)
	The main function for the arm service. More...

Variables
static struct ServiceList *	running_head
	List of running services. More...
static struct ServiceList *	running_tail
	List of running services. More...
static const struct GNUNET_CONFIGURATION_Handle *	cfg
	Our configuration. More...
static char *	prefix_command
	Command to prepend to each actual command. More...
static char *	final_option
	Option to append to each actual command. More...
static struct GNUNET_SCHEDULER_Task *	child_death_task
	ID of task called whenever we get a SIGCHILD. More...
static struct GNUNET_SCHEDULER_Task *	child_restart_task
	ID of task called whenever the timeout for restarting a child expires. More...
static struct GNUNET_DISK_PipeHandle *	sigpipe
	Pipe used to communicate shutdown via signal. More...
static int	in_shutdown
	Are we in shutdown mode? More...
static int	global_ret
	Return value from main. More...
static int	start_user = GNUNET_YES
	Are we starting user services? More...
static int	start_system = GNUNET_YES
	Are we starting system services? More...
static struct GNUNET_SERVICE_Handle *	service
	Handle to our service instance. More...
static struct GNUNET_NotificationContext *	notifier
	Context for notifications we need to send to our clients. More...

Detailed Description

the automated restart manager service

Author

Christian Grothoff

Definition in file gnunet-service-arm.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "util", __VA_ARGS__)

Definition at line 32 of file gnunet-service-arm.c.

LOG_STRERROR

#define LOG_STRERROR	(		kind,
			syscall
	)		GNUNET_log_from_strerror (kind, "util", syscall)

Definition at line 34 of file gnunet-service-arm.c.

MAX_NOTIFY_QUEUE

#define MAX_NOTIFY_QUEUE   1024

How many messages do we queue up at most for optional notifications to a client? (this can cause notifications about outgoing messages to be dropped).

Definition at line 56 of file gnunet-service-arm.c.

Function Documentation

add_unixpath()

static void add_unixpath ( struct sockaddr **  saddrs, socklen_t *  saddrlens, const char *  unixpath, int  abstract  )

static

Add the given UNIX domain path as an address to the list (as the first entry).

Parameters

saddrs	array to update
saddrlens	where to store the address length
unixpath	path to add
abstract	GNUNET_YES to add an abstract UNIX domain socket. This parameter is ignore on systems other than LINUX

Definition at line 293 of file gnunet-service-arm.c.

{
#ifdef AF_UNIX
  struct sockaddr_un *un;
 
  un = GNUNET_new (struct sockaddr_un);
  un->sun_family = AF_UNIX;
  GNUNET_strlcpy (un->sun_path, unixpath, sizeof(un->sun_path));
#ifdef __linux__
  if (GNUNET_YES == abstract)
    un->sun_path[0] = '\0';
#endif
#if HAVE_SOCKADDR_UN_SUN_LEN
  un->sun_len = (u_char) sizeof(struct sockaddr_un);
#endif
  *saddrs = (struct sockaddr *) un;
  *saddrlens = sizeof(struct sockaddr_un);
#else
  /* this function should never be called
   * unless AF_UNIX is defined! */
  GNUNET_assert (0);
#endif
}

References GNUNET_assert, GNUNET_new, GNUNET_strlcpy(), and GNUNET_YES.

Referenced by get_server_addresses().

Here is the call graph for this function:

Here is the caller graph for this function:

get_server_addresses()

static int get_server_addresses ( const char *  service_name, const struct GNUNET_CONFIGURATION_Handle *  cfg, struct sockaddr ***  addrs, socklen_t **  addr_lens  )

static

Get the list of addresses that a server for the given service should bind to.

Parameters

service_name	name of the service
cfg	configuration (which specifies the addresses)
addrs	set (call by reference) to an array of pointers to the addresses the server should bind to and listen on; the array will be NULL-terminated (on success)
addr_lens	set (call by reference) to an array of the lengths of the respective struct sockaddr struct in the addrs array (on success)

Returns

number of addresses found on success, GNUNET_SYSERR if the configuration did not specify reasonable finding information or if it specified a hostname that could not be resolved; GNUNET_NO if the number of addresses configured is zero (in this case, *addrs and *addr_lens will be set to NULL).

Definition at line 342 of file gnunet-service-arm.c.

{
  int disablev6;
  struct GNUNET_NETWORK_Handle *desc;
  unsigned long long port;
  char *unixpath;
  struct addrinfo hints;
  struct addrinfo *res;
  struct addrinfo *pos;
  struct addrinfo *next;
  unsigned int i;
  int resi;
  int ret;
  int abstract;
  struct sockaddr **saddrs;
  socklen_t *saddrlens;
  char *hostname;
 
  *addrs = NULL;
  *addr_lens = NULL;
  desc = NULL;
  if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "DISABLEV6"))
  {
    if (GNUNET_SYSERR ==
        (disablev6 = GNUNET_CONFIGURATION_get_value_yesno (cfg,
                                                           service_name,
                                                           "DISABLEV6")))
      return GNUNET_SYSERR;
  }
  else
    disablev6 = GNUNET_NO;
 
  if (! disablev6)
  {
    /* probe IPv6 support */
    desc = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
    if (NULL == desc)
    {
      if ((ENOBUFS == errno) || (ENOMEM == errno) || (ENFILE == errno) ||
          (EACCES == errno))
      {
        LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket");
        return GNUNET_SYSERR;
      }
      LOG (GNUNET_ERROR_TYPE_INFO,
           _ (
             "Disabling IPv6 support for service `%s', failed to create IPv6 socket: %s\n"),
           service_name,
           strerror (errno));
      disablev6 = GNUNET_YES;
    }
    else
    {
      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
      desc = NULL;
    }
  }
 
  port = 0;
  if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT"))
  {
    if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg,
                                                            service_name,
                                                            "PORT",
                                                            &port))
    {
      LOG (GNUNET_ERROR_TYPE_ERROR,
           _ ("Require valid port number for service `%s' in configuration!\n"),
           service_name);
    }
    if (port > 65535)
    {
      LOG (GNUNET_ERROR_TYPE_ERROR,
           _ ("Require valid port number for service `%s' in configuration!\n"),
           service_name);
      return GNUNET_SYSERR;
    }
  }
 
  if (GNUNET_CONFIGURATION_have_value (cfg, service_name, "BINDTO"))
  {
    GNUNET_break (GNUNET_OK ==
                  GNUNET_CONFIGURATION_get_value_string (cfg,
                                                         service_name,
                                                         "BINDTO",
                                                         &hostname));
  }
  else
    hostname = NULL;
 
  unixpath = NULL;
  abstract = GNUNET_NO;
#ifdef AF_UNIX
  if ((GNUNET_YES ==
       GNUNET_CONFIGURATION_have_value (cfg, service_name, "UNIXPATH")) &&
      (GNUNET_OK == GNUNET_CONFIGURATION_get_value_filename (cfg,
                                                             service_name,
                                                             "UNIXPATH",
                                                             &unixpath)) &&
      (0 < strlen (unixpath)))
  {
    /* probe UNIX support */
    struct sockaddr_un s_un;
 
    if (strlen (unixpath) >= sizeof(s_un.sun_path))
    {
      LOG (GNUNET_ERROR_TYPE_WARNING,
           _ ("UNIXPATH `%s' too long, maximum length is %llu\n"),
           unixpath,
           (unsigned long long) sizeof(s_un.sun_path));
      unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
      LOG (GNUNET_ERROR_TYPE_INFO, _ ("Using `%s' instead\n"), unixpath);
    }
#ifdef __linux__
    abstract = GNUNET_CONFIGURATION_get_value_yesno (cfg,
                                                     "TESTING",
                                                     "USE_ABSTRACT_SOCKETS");
    if (GNUNET_SYSERR == abstract)
      abstract = GNUNET_NO;
#endif
    if ((GNUNET_YES != abstract) &&
        (GNUNET_OK != GNUNET_DISK_directory_create_for_file (unixpath)))
      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "mkdir", unixpath);
  }
  if (NULL != unixpath)
  {
    desc = GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_STREAM, 0);
    if (NULL == desc)
    {
      if ((ENOBUFS == errno) || (ENOMEM == errno) || (ENFILE == errno) ||
          (EACCES == errno))
      {
        LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket");
        GNUNET_free (hostname);
        GNUNET_free (unixpath);
        return GNUNET_SYSERR;
      }
      LOG (GNUNET_ERROR_TYPE_INFO,
           _ (
             "Disabling UNIX domain socket support for service `%s', failed to create UNIX domain socket: %s\n"),
           service_name,
           strerror (errno));
      GNUNET_free (unixpath);
      unixpath = NULL;
    }
    else
    {
      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
      desc = NULL;
    }
  }
#endif
 
  if ((0 == port) && (NULL == unixpath))
  {
    if (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno (cfg,
                                                            service_name,
                                                            "START_ON_DEMAND"))
      LOG (GNUNET_ERROR_TYPE_ERROR,
           _ (
             "Have neither PORT nor UNIXPATH for service `%s', but one is required\n"),
           service_name);
    GNUNET_free (hostname);
    return GNUNET_SYSERR;
  }
  if (0 == port)
  {
    saddrs = GNUNET_new_array (2, struct sockaddr *);
    saddrlens = GNUNET_new_array (2, socklen_t);
    add_unixpath (saddrs, saddrlens, unixpath, abstract);
    GNUNET_free (unixpath);
    GNUNET_free (hostname);
    *addrs = saddrs;
    *addr_lens = saddrlens;
    return 1;
  }
 
  if (NULL != hostname)
  {
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Resolving `%s' since that is where `%s' will bind to.\n",
         hostname,
         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))) ||
        (NULL == res))
    {
      LOG (GNUNET_ERROR_TYPE_ERROR,
           _ ("Failed to resolve `%s': %s\n"),
           hostname,
           gai_strerror (ret));
      GNUNET_free (hostname);
      GNUNET_free (unixpath);
      return GNUNET_SYSERR;
    }
    next = res;
    i = 0;
    while (NULL != (pos = next))
    {
      next = pos->ai_next;
      if ((disablev6) && (pos->ai_family == AF_INET6))
        continue;
      i++;
    }
    if (0 == i)
    {
      LOG (GNUNET_ERROR_TYPE_ERROR,
           _ ("Failed to find %saddress for `%s'.\n"),
           disablev6 ? "IPv4 " : "",
           hostname);
      freeaddrinfo (res);
      GNUNET_free (hostname);
      GNUNET_free (unixpath);
      return GNUNET_SYSERR;
    }
    resi = i;
    if (NULL != unixpath)
      resi++;
    saddrs = GNUNET_new_array (resi + 1, struct sockaddr *);
    saddrlens = GNUNET_new_array (resi + 1, socklen_t);
    i = 0;
    if (NULL != unixpath)
    {
      add_unixpath (saddrs, saddrlens, unixpath, abstract);
      i++;
    }
    next = res;
    while (NULL != (pos = next))
    {
      next = pos->ai_next;
      if ((disablev6) && (AF_INET6 == pos->ai_family))
        continue;
      if ((IPPROTO_TCP != pos->ai_protocol) && (0 != pos->ai_protocol))
        continue;     /* not TCP */
      if ((SOCK_STREAM != pos->ai_socktype) && (0 != pos->ai_socktype))
        continue;     /* huh? */
      LOG (GNUNET_ERROR_TYPE_DEBUG,
           "Service `%s' will bind to `%s'\n",
           service_name,
           GNUNET_a2s (pos->ai_addr, pos->ai_addrlen));
      if (AF_INET == pos->ai_family)
      {
        GNUNET_assert (sizeof(struct sockaddr_in) == pos->ai_addrlen);
        saddrlens[i] = pos->ai_addrlen;
        saddrs[i] = GNUNET_malloc (saddrlens[i]);
        GNUNET_memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
        ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
      }
      else
      {
        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]);
        GNUNET_memcpy (saddrs[i], pos->ai_addr, saddrlens[i]);
        ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
      }
      i++;
    }
    GNUNET_free (hostname);
    freeaddrinfo (res);
    resi = i;
  }
  else
  {
    /* will bind against everything, just set port */
    if (disablev6)
    {
      /* V4-only */
      resi = 1;
      if (NULL != unixpath)
        resi++;
      i = 0;
      saddrs = GNUNET_new_array (resi + 1, struct sockaddr *);
      saddrlens = GNUNET_new_array (resi + 1, socklen_t);
      if (NULL != unixpath)
      {
        add_unixpath (saddrs, saddrlens, unixpath, abstract);
        i++;
      }
      saddrlens[i] = sizeof(struct sockaddr_in);
      saddrs[i] = GNUNET_malloc (saddrlens[i]);
#if HAVE_SOCKADDR_IN_SIN_LEN
      ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[i];
#endif
      ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
      ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
    }
    else
    {
      /* dual stack */
      resi = 2;
      if (NULL != unixpath)
        resi++;
      saddrs = GNUNET_new_array (resi + 1, struct sockaddr *);
      saddrlens = GNUNET_new_array (resi + 1, socklen_t);
      i = 0;
      if (NULL != unixpath)
      {
        add_unixpath (saddrs, saddrlens, unixpath, abstract);
        i++;
      }
      saddrlens[i] = sizeof(struct sockaddr_in6);
      saddrs[i] = GNUNET_malloc (saddrlens[i]);
#if HAVE_SOCKADDR_IN_SIN_LEN
      ((struct sockaddr_in6 *) saddrs[i])->sin6_len = saddrlens[0];
#endif
      ((struct sockaddr_in6 *) saddrs[i])->sin6_family = AF_INET6;
      ((struct sockaddr_in6 *) saddrs[i])->sin6_port = htons (port);
      i++;
      saddrlens[i] = sizeof(struct sockaddr_in);
      saddrs[i] = GNUNET_malloc (saddrlens[i]);
#if HAVE_SOCKADDR_IN_SIN_LEN
      ((struct sockaddr_in *) saddrs[i])->sin_len = saddrlens[1];
#endif
      ((struct sockaddr_in *) saddrs[i])->sin_family = AF_INET;
      ((struct sockaddr_in *) saddrs[i])->sin_port = htons (port);
    }
  }
  GNUNET_free (unixpath);
  *addrs = saddrs;
  *addr_lens = saddrlens;
  return resi;
}

References _, add_unixpath(), cfg, GNUNET_a2s(), GNUNET_assert, GNUNET_break, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_CONFIGURATION_have_value(), GNUNET_DISK_directory_create_for_file(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log_strerror_file, GNUNET_malloc, GNUNET_memcpy, GNUNET_NETWORK_shorten_unixpath(), GNUNET_NETWORK_socket_close(), GNUNET_NETWORK_socket_create(), GNUNET_new_array, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, LOG, LOG_STRERROR, port, res, ret, and service_name.

Referenced by setup_service().

Here is the call graph for this function:

Here is the caller graph for this function:

signal_result()

static void signal_result ( struct GNUNET_SERVICE_Client *  client, const char *  name, uint64_t  request_id, enum GNUNET_ARM_Result  result  )

static

Signal our client that we will start or stop the service.

Parameters

client	who is being signalled
name	name of the service
request_id	id of the request that is being responded to.
result	message type to send

Returns

NULL if it was not found

Definition at line 685 of file gnunet-service-arm.c.

{
  struct GNUNET_MQ_Envelope *env;
  struct GNUNET_ARM_ResultMessage *msg;
 
  (void) name;
  env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_ARM_RESULT);
  msg->result = htonl (result);
  msg->arm_msg.request_id = GNUNET_htonll (request_id);
  GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client), env);
}

References env, GNUNET_htonll(), GNUNET_MESSAGE_TYPE_ARM_RESULT, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_SERVICE_client_get_mq(), msg, name, and result.

Referenced by handle_start(), handle_stop(), maint_child_death(), and start_process().

Here is the call graph for this function:

Here is the caller graph for this function:

broadcast_status()

static void broadcast_status ( const char *  name, enum GNUNET_ARM_ServiceMonitorStatus  status, struct GNUNET_SERVICE_Client *  unicast  )

static

Tell all clients about status change of a service.

Parameters

name	name of the service
status	message type to send
unicast	if not NULL, send to this client only. otherwise, send to all clients in the notifier

Definition at line 710 of file gnunet-service-arm.c.

{
  struct GNUNET_MQ_Envelope *env;
  struct GNUNET_ARM_StatusMessage *msg;
  size_t namelen;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Sending status %u of service `%s' to client\n",
              (unsigned int) status,
              name);
  namelen = strlen (name) + 1;
  env = GNUNET_MQ_msg_extra (msg, namelen, GNUNET_MESSAGE_TYPE_ARM_STATUS);
  msg->status = htonl ((uint32_t) (status));
  GNUNET_memcpy ((char *) &msg[1], name, namelen);
  if (NULL == unicast)
  {
    if (NULL != notifier)
      GNUNET_notification_context_broadcast (notifier,
                                             &msg->header,
                                             GNUNET_YES);
    GNUNET_MQ_discard (env);
  }
  else
  {
    GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (unicast), env);
  }
}

References env, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_ARM_STATUS, GNUNET_MQ_discard(), GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_notification_context_broadcast(), GNUNET_SERVICE_client_get_mq(), GNUNET_YES, msg, name, notifier, and status.

Referenced by handle_monitor(), handle_stop(), maint_child_death(), and start_process().

Here is the call graph for this function:

Here is the caller graph for this function:

start_process()

static void start_process ( struct ServiceList *  sl, struct GNUNET_SERVICE_Client *  client, uint64_t  request_id  )

static

Actually start the process for the given service.

Parameters

sl	identifies service to start
client	that asked to start the service (may be NULL)
request_id	id of the request in response to which the process is being started. 0 if starting was not requested.

Definition at line 750 of file gnunet-service-arm.c.

{
  char *loprefix;
  char *options;
  int use_debug;
  int is_simple_service;
  struct ServiceListeningInfo *sli;
  int *lsocks;
  unsigned int ls;
  char *binary;
  char *quotedbinary;
 
  /* calculate listen socket list */
  lsocks = NULL;
  ls = 0;
  for (sli = sl->listen_head; NULL != sli; sli = sli->next)
  {
    GNUNET_array_append (lsocks,
                         ls,
                         GNUNET_NETWORK_get_fd (sli->listen_socket));
    if (NULL != sli->accept_task)
    {
      GNUNET_SCHEDULER_cancel (sli->accept_task);
      sli->accept_task = NULL;
    }
  }
 
  GNUNET_array_append (lsocks, ls, -1);
 
  /* obtain configuration */
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg,
                                                          sl->name,
                                                          "PREFIX",
                                                          &loprefix))
    loprefix = GNUNET_strdup (prefix_command);
  else
    loprefix = GNUNET_CONFIGURATION_expand_dollar (cfg, loprefix);
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg,
                                                          sl->name,
                                                          "OPTIONS",
                                                          &options))
    options = NULL;
  else
    options = GNUNET_CONFIGURATION_expand_dollar (cfg, options);
  {
    char *new_options;
    char *optpos;
    char *fin_options;
 
    fin_options = GNUNET_strdup (final_option);
    /* replace '{}' with service name */
    while (NULL != (optpos = strstr (fin_options, "{}")))
    {
      /* terminate string at opening parenthesis */
      *optpos = 0;
      GNUNET_asprintf (&new_options,
                       "%s%s%s",
                       fin_options,
                       sl->name,
                       optpos + 2);
      GNUNET_free (fin_options);
      fin_options = new_options;
    }
    if (NULL != options)
    {
      /* combine "fin_options" with "options" */
      optpos = options;
      GNUNET_asprintf (&options, "%s %s", fin_options, optpos);
      GNUNET_free (fin_options);
      GNUNET_free (optpos);
    }
    else
    {
      /* only have "fin_options", use that */
      options = fin_options;
    }
  }
  options = GNUNET_CONFIGURATION_expand_dollar (cfg, options);
  use_debug = GNUNET_CONFIGURATION_get_value_yesno (cfg, sl->name, "DEBUG");
  {
    const char *service_type = NULL;
    const char *choices[] = { "GNUNET", "SIMPLE", NULL };
 
    is_simple_service = GNUNET_NO;
    if ((GNUNET_OK == GNUNET_CONFIGURATION_get_value_choice (cfg,
                                                             sl->name,
                                                             "TYPE",
                                                             choices,
                                                             &service_type)) &&
        (0 == strcasecmp (service_type, "SIMPLE")))
      is_simple_service = GNUNET_YES;
  }
 
  GNUNET_assert (NULL == sl->proc);
  if (GNUNET_YES == is_simple_service)
  {
    /* A simple service will receive no GNUnet specific
       command line options. */
    binary = GNUNET_strdup (sl->binary);
    binary = GNUNET_CONFIGURATION_expand_dollar (cfg, binary);
    GNUNET_asprintf (&quotedbinary, "\"%s\"", sl->binary);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Starting simple service `%s' using binary `%s'\n",
                sl->name,
                sl->binary);
    /* FIXME: dollar expansion should only be done outside
     * of ''-quoted strings, escaping should be considered. */
    if (NULL != options)
      options = GNUNET_CONFIGURATION_expand_dollar (cfg, options);
    sl->proc = GNUNET_OS_start_process_s (sl->pipe_control
                                          ? GNUNET_OS_INHERIT_STD_OUT_AND_ERR
                                          | GNUNET_OS_USE_PIPE_CONTROL
                                          : GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
                                          lsocks,
                                          loprefix,
                                          quotedbinary,
                                          options,
                                          NULL);
  }
  else
  {
    /* actually start process */
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Starting service `%s' using binary `%s' and configuration `%s'\n",
                sl->name,
                sl->binary,
                sl->config);
    binary = GNUNET_OS_get_libexec_binary_path (sl->binary);
    GNUNET_asprintf (&quotedbinary, "\"%s\"", binary);
 
    if (GNUNET_YES == use_debug)
    {
      if (NULL == sl->config)
        sl->proc = GNUNET_OS_start_process_s (sl->pipe_control
                                              ?
                                              GNUNET_OS_INHERIT_STD_OUT_AND_ERR
                                              | GNUNET_OS_USE_PIPE_CONTROL
                                              :
                                              GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
                                              lsocks,
                                              loprefix,
                                              quotedbinary,
                                              "-L",
                                              "DEBUG",
                                              options,
                                              NULL);
      else
        sl->proc = GNUNET_OS_start_process_s (sl->pipe_control
                                              ?
                                              GNUNET_OS_INHERIT_STD_OUT_AND_ERR
                                              | GNUNET_OS_USE_PIPE_CONTROL
                                              :
                                              GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
                                              lsocks,
                                              loprefix,
                                              quotedbinary,
                                              "-c",
                                              sl->config,
                                              "-L",
                                              "DEBUG",
                                              options,
                                              NULL);
    }
    else
    {
      if (NULL == sl->config)
        sl->proc = GNUNET_OS_start_process_s (sl->pipe_control
                                              ?
                                              GNUNET_OS_INHERIT_STD_OUT_AND_ERR
                                              | GNUNET_OS_USE_PIPE_CONTROL
                                              :
                                              GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
                                              lsocks,
                                              loprefix,
                                              quotedbinary,
                                              options,
                                              NULL);
      else
        sl->proc = GNUNET_OS_start_process_s (sl->pipe_control
                                              ?
                                              GNUNET_OS_INHERIT_STD_OUT_AND_ERR
                                              | GNUNET_OS_USE_PIPE_CONTROL
                                              :
                                              GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
                                              lsocks,
                                              loprefix,
                                              quotedbinary,
                                              "-c",
                                              sl->config,
                                              options,
                                              NULL);
    }
  }
  GNUNET_free (binary);
  GNUNET_free (quotedbinary);
  sl->last_started_at = GNUNET_TIME_absolute_get ();
  if (NULL == sl->proc)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _ ("Failed to start service `%s'\n"),
                sl->name);
    if (client)
      signal_result (client,
                     sl->name,
                     request_id,
                     GNUNET_ARM_RESULT_START_FAILED);
  }
  else
  {
    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                _ ("Starting service `%s'\n"),
                sl->name);
    broadcast_status (sl->name, GNUNET_ARM_SERVICE_STARTING, NULL);
    if (client)
      signal_result (client, sl->name, request_id, GNUNET_ARM_RESULT_STARTING);
  }
  /* clean up */
  GNUNET_free (loprefix);
  GNUNET_free (options);
  GNUNET_array_grow (lsocks, ls, 0);
}

References _, ServiceListeningInfo::accept_task, ServiceList::binary, broadcast_status(), cfg, warningfilter::choices, ServiceList::config, final_option, GNUNET_ARM_RESULT_START_FAILED, GNUNET_ARM_RESULT_STARTING, GNUNET_ARM_SERVICE_STARTING, GNUNET_array_append, GNUNET_array_grow, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONFIGURATION_expand_dollar(), GNUNET_CONFIGURATION_get_value_choice(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_log, GNUNET_NETWORK_get_fd(), GNUNET_NO, GNUNET_OK, GNUNET_OS_get_libexec_binary_path(), GNUNET_OS_INHERIT_STD_OUT_AND_ERR, GNUNET_OS_start_process_s(), GNUNET_OS_USE_PIPE_CONTROL, GNUNET_SCHEDULER_cancel(), GNUNET_strdup, GNUNET_TIME_absolute_get(), GNUNET_YES, ServiceList::last_started_at, ServiceList::listen_head, ServiceListeningInfo::listen_socket, ls, ServiceList::name, ServiceListeningInfo::next, options, ServiceList::pipe_control, prefix_command, ServiceList::proc, signal_result(), and ServiceListeningInfo::sl.

Referenced by accept_connection(), delayed_restart_task(), handle_start(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

find_service()

static struct ServiceList * find_service ( const char *  name )

static

Find the process with the given service name in the given list and return it.

Parameters

name	which service entry to look up

Returns

NULL if it was not found

Definition at line 983 of file gnunet-service-arm.c.

{
  struct ServiceList *sl;
 
  sl = running_head;
  while (sl != NULL)
  {
    if (0 == strcasecmp (sl->name, name))
      return sl;
    sl = sl->next;
  }
  return NULL;
}

References name, ServiceList::name, ServiceList::next, and running_head.

Referenced by handle_start(), handle_stop(), and setup_service().

Here is the caller graph for this function:

accept_connection()

static void accept_connection ( void *  cls )

static

First connection has come to the listening socket associated with the service, create the service in order to relay the incoming connection to it.

Parameters

cls	callback data, struct ServiceListeningInfo describing a listen socket

Definition at line 1005 of file gnunet-service-arm.c.

{
  struct ServiceListeningInfo *sli = cls;
  struct ServiceList *sl = sli->sl;
 
  sli->accept_task = NULL;
  GNUNET_assert (GNUNET_NO == in_shutdown);
  start_process (sl, NULL, 0);
}

References ServiceListeningInfo::accept_task, GNUNET_assert, GNUNET_NO, in_shutdown, ServiceListeningInfo::sl, and start_process().

Referenced by create_listen_socket(), delayed_restart_task(), and maint_child_death().

Here is the call graph for this function:

Here is the caller graph for this function:

create_listen_socket()

static void create_listen_socket ( struct sockaddr *  sa, socklen_t  addr_len, struct ServiceList *  sl  )

static

Creating a listening socket for each of the service's addresses and wait for the first incoming connection to it.

Parameters

sa	address associated with the service
addr_len	length of sa
sl	service entry for the service in question

Definition at line 1025 of file gnunet-service-arm.c.

{
  static int on = 1;
  struct GNUNET_NETWORK_Handle *sock;
  struct ServiceListeningInfo *sli;
 
  int match_uid;
  int match_gid;
 
  switch (sa->sa_family)
  {
  case AF_INET:
    sock = GNUNET_NETWORK_socket_create (PF_INET, SOCK_STREAM, 0);
    break;
 
  case AF_INET6:
    sock = GNUNET_NETWORK_socket_create (PF_INET6, SOCK_STREAM, 0);
    break;
 
  case AF_UNIX:
    if (0 == strcmp (GNUNET_a2s (sa, addr_len),
                     "@"))  /* Do not bind to blank UNIX path! */
      return;
    sock = GNUNET_NETWORK_socket_create (PF_UNIX, SOCK_STREAM, 0);
    break;
 
  default:
    GNUNET_break (0);
    sock = NULL;
    errno = EAFNOSUPPORT;
    break;
  }
  if (NULL == sock)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _ ("Unable to create socket for service `%s': %s\n"),
                sl->name,
                strerror (errno));
    GNUNET_free (sa);
    return;
  }
  if (GNUNET_OK != GNUNET_NETWORK_socket_setsockopt (sock,
                                                     SOL_SOCKET,
                                                     SO_REUSEADDR,
                                                     &on,
                                                     sizeof(on)))
    GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
                         "setsockopt");
#ifdef IPV6_V6ONLY
  if ((sa->sa_family == AF_INET6) &&
      (GNUNET_OK != GNUNET_NETWORK_socket_setsockopt (sock,
                                                      IPPROTO_IPV6,
                                                      IPV6_V6ONLY,
                                                      &on,
                                                      sizeof(on))))
    GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
                         "setsockopt");
#endif
  if (AF_UNIX == sa->sa_family)
    GNUNET_NETWORK_unix_precheck ((struct sockaddr_un *) sa);
  if (GNUNET_OK !=
      GNUNET_NETWORK_socket_bind (sock, (const struct sockaddr *) sa, addr_len))
  {
    GNUNET_log (
      GNUNET_ERROR_TYPE_WARNING,
      _ (
        "Unable to bind listening socket for service `%s' to address `%s': %s\n"),
      sl->name,
      GNUNET_a2s (sa, addr_len),
      strerror (errno));
    GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
    GNUNET_free (sa);
    return;
  }
  if ((AF_UNIX == sa->sa_family)
#ifdef __linux__
      /* Permission settings are not required when abstract sockets are used */
      && ('\0' != ((const struct sockaddr_un *) sa)->sun_path[0])
#endif
      )
  {
    match_uid =
      GNUNET_CONFIGURATION_get_value_yesno (cfg, sl->name, "UNIX_MATCH_UID");
    match_gid =
      GNUNET_CONFIGURATION_get_value_yesno (cfg, sl->name, "UNIX_MATCH_GID");
    GNUNET_DISK_fix_permissions (((const struct sockaddr_un *) sa)->sun_path,
                                 match_uid,
                                 match_gid);
  }
  if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
  {
    GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
    GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
    GNUNET_free (sa);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              _ ("ARM now monitors connections to service `%s' at `%s'\n"),
              sl->name,
              GNUNET_a2s (sa, addr_len));
  sli = GNUNET_new (struct ServiceListeningInfo);
  sli->service_addr = sa;
  sli->service_addr_len = addr_len;
  sli->listen_socket = sock;
  sli->sl = sl;
  sli->accept_task =
    GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
                                   sock,
                                   &accept_connection,
                                   sli);
  GNUNET_CONTAINER_DLL_insert (sl->listen_head, sl->listen_tail, sli);
}

References _, accept_connection(), ServiceListeningInfo::accept_task, cfg, GNUNET_a2s(), GNUNET_break, GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_CONTAINER_DLL_insert, GNUNET_DISK_fix_permissions(), GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_strerror, GNUNET_NETWORK_socket_bind(), GNUNET_NETWORK_socket_close(), GNUNET_NETWORK_socket_create(), GNUNET_NETWORK_socket_listen(), GNUNET_NETWORK_socket_setsockopt(), GNUNET_NETWORK_unix_precheck(), GNUNET_new, GNUNET_OK, GNUNET_SCHEDULER_add_read_net(), GNUNET_TIME_UNIT_FOREVER_REL, ServiceList::listen_head, ServiceListeningInfo::listen_socket, ServiceList::listen_tail, ServiceList::name, ServiceListeningInfo::service_addr, ServiceListeningInfo::service_addr_len, and ServiceListeningInfo::sl.

Referenced by setup_service().

Here is the call graph for this function:

Here is the caller graph for this function:

free_service()

static void free_service ( struct ServiceList *  sl )

static

Remove and free an entry in the service list.

Listen sockets must have already been cleaned up. Only to be called during shutdown.

Parameters

sl	entry to free

Definition at line 1148 of file gnunet-service-arm.c.

{
  GNUNET_assert (GNUNET_YES == in_shutdown);
  GNUNET_CONTAINER_DLL_remove (running_head, running_tail, sl);
  GNUNET_assert (NULL == sl->listen_head);
  GNUNET_free (sl->config);
  GNUNET_free (sl->binary);
  GNUNET_free (sl->name);
  GNUNET_free (sl);
}

References ServiceList::binary, ServiceList::config, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_YES, in_shutdown, ServiceList::listen_head, ServiceList::name, running_head, running_tail, and ServiceListeningInfo::sl.

Referenced by maint_child_death(), and shutdown_task().

Here is the caller graph for this function:

check_start()

static int check_start ( void *  cls, const struct GNUNET_ARM_Message *  amsg  )

static

Check START-message.

Parameters

cls	identification of the client
amsg	the actual message

Returns

GNUNET_OK to keep the connection open, GNUNET_SYSERR to close it (signal serious error)

Definition at line 1169 of file gnunet-service-arm.c.

{
  (void) cls;
  GNUNET_MQ_check_zero_termination (amsg);
  return GNUNET_OK;
}

References GNUNET_MQ_check_zero_termination, and GNUNET_OK.

handle_start()

static void handle_start ( void *  cls, const struct GNUNET_ARM_Message *  amsg  )

static

Handle START-message.

Parameters

cls	identification of the client
amsg	the actual message

Definition at line 1184 of file gnunet-service-arm.c.

{
  struct GNUNET_SERVICE_Client *client = cls;
  const char *servicename;
  struct ServiceList *sl;
  uint64_t request_id;
 
  request_id = GNUNET_ntohll (amsg->request_id);
  servicename = (const char *) &amsg[1];
  GNUNET_SERVICE_client_continue (client);
  if (GNUNET_YES == in_shutdown)
  {
    signal_result (client,
                   servicename,
                   request_id,
                   GNUNET_ARM_RESULT_IN_SHUTDOWN);
    return;
  }
  sl = find_service (servicename);
  if (NULL == sl)
  {
    signal_result (client,
                   servicename,
                   request_id,
                   GNUNET_ARM_RESULT_IS_NOT_KNOWN);
    return;
  }
  sl->force_start = GNUNET_YES;
  if (NULL != sl->proc)
  {
    signal_result (client,
                   servicename,
                   request_id,
                   GNUNET_ARM_RESULT_IS_STARTED_ALREADY);
    return;
  }
  start_process (sl, client, request_id);
}

References find_service(), ServiceList::force_start, GNUNET_ARM_RESULT_IN_SHUTDOWN, GNUNET_ARM_RESULT_IS_NOT_KNOWN, GNUNET_ARM_RESULT_IS_STARTED_ALREADY, GNUNET_ntohll(), GNUNET_SERVICE_client_continue(), GNUNET_YES, in_shutdown, ServiceList::proc, GNUNET_ARM_Message::request_id, signal_result(), and start_process().

Here is the call graph for this function:

trigger_shutdown()

static void trigger_shutdown ( void *  cls )

static

Start a shutdown sequence.

Parameters

cls	closure (refers to service)

Definition at line 1230 of file gnunet-service-arm.c.

{
  (void) cls;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Triggering shutdown\n");
  GNUNET_SCHEDULER_shutdown ();
}

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, and GNUNET_SCHEDULER_shutdown().

Referenced by handle_stop().

Here is the call graph for this function:

Here is the caller graph for this function:

check_stop()

static int check_stop ( void *  cls, const struct GNUNET_ARM_Message *  amsg  )

static

Check STOP-message.

Parameters

cls	identification of the client
amsg	the actual message

Returns

GNUNET_OK to keep the connection open, GNUNET_SYSERR to close it (signal serious error)

Definition at line 1247 of file gnunet-service-arm.c.

{
  (void) cls;
  GNUNET_MQ_check_zero_termination (amsg);
  return GNUNET_OK;
}

References GNUNET_MQ_check_zero_termination, and GNUNET_OK.

handle_stop()

static void handle_stop ( void *  cls, const struct GNUNET_ARM_Message *  amsg  )

static

Handle STOP-message.

Parameters

cls	identification of the client
amsg	the actual message

Definition at line 1262 of file gnunet-service-arm.c.

{
  struct GNUNET_SERVICE_Client *client = cls;
  struct ServiceList *sl;
  const char *servicename;
  uint64_t request_id;
 
  request_id = GNUNET_ntohll (amsg->request_id);
  servicename = (const char *) &amsg[1];
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              _ ("Preparing to stop `%s'\n"),
              servicename);
  GNUNET_SERVICE_client_continue (client);
  if (0 == strcasecmp (servicename, "arm"))
  {
    broadcast_status (servicename, GNUNET_ARM_SERVICE_STOPPING, NULL);
    signal_result (client, servicename, request_id, GNUNET_ARM_RESULT_STOPPING);
    GNUNET_SERVICE_client_persist (client);
    GNUNET_SCHEDULER_add_now (&trigger_shutdown, NULL);
    return;
  }
  sl = find_service (servicename);
  if (NULL == sl)
  {
    signal_result (client,
                   servicename,
                   request_id,
                   GNUNET_ARM_RESULT_IS_NOT_KNOWN);
    return;
  }
  sl->force_start = GNUNET_NO;
  if (GNUNET_YES == in_shutdown)
  {
    /* shutdown in progress */
    signal_result (client,
                   servicename,
                   request_id,
                   GNUNET_ARM_RESULT_IN_SHUTDOWN);
    return;
  }
  if (NULL != sl->killing_client)
  {
    /* killing already in progress */
    signal_result (client,
                   servicename,
                   request_id,
                   GNUNET_ARM_RESULT_IS_STOPPING_ALREADY);
    return;
  }
  if (NULL == sl->proc)
  {
    /* process is down */
    signal_result (client,
                   servicename,
                   request_id,
                   GNUNET_ARM_RESULT_IS_STOPPED_ALREADY);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Sending kill signal to service `%s', waiting for process to die.\n",
              servicename);
  broadcast_status (servicename, GNUNET_ARM_SERVICE_STOPPING, NULL);
  /* no signal_start - only when it's STOPPED */
  sl->killed_at = GNUNET_TIME_absolute_get ();
  if (0 != GNUNET_OS_process_kill (sl->proc, GNUNET_TERM_SIG))
    GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
  sl->killing_client = client;
  sl->killing_client_request_id = request_id;
}

References _, broadcast_status(), find_service(), ServiceList::force_start, GNUNET_ARM_RESULT_IN_SHUTDOWN, GNUNET_ARM_RESULT_IS_NOT_KNOWN, GNUNET_ARM_RESULT_IS_STOPPED_ALREADY, GNUNET_ARM_RESULT_IS_STOPPING_ALREADY, GNUNET_ARM_RESULT_STOPPING, GNUNET_ARM_SERVICE_STOPPING, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_log, GNUNET_log_strerror, GNUNET_NO, GNUNET_ntohll(), GNUNET_OS_process_kill(), GNUNET_SCHEDULER_add_now(), GNUNET_SERVICE_client_continue(), GNUNET_SERVICE_client_persist(), GNUNET_TERM_SIG, GNUNET_TIME_absolute_get(), GNUNET_YES, in_shutdown, ServiceList::killed_at, ServiceList::killing_client, ServiceList::killing_client_request_id, ServiceList::proc, GNUNET_ARM_Message::request_id, signal_result(), and trigger_shutdown().

Here is the call graph for this function:

pool_write()

static int pool_write ( char *  pool_start, size_t  pool_size, size_t *  pool_pos, char *  str  )

static

Write a string to a string pool.

Parameters

	pool_start	pointer to the start of the string pool
	pool_size	size of the string pool
[in,out]	pool_pos	current position index in the string pool, will be updated
	str	string to write to the string pool

Returns

GNUNET_OK if the string fits into the pool, GNUNET_SYSERR otherwise

Definition at line 1345 of file gnunet-service-arm.c.

{
  size_t next_pos = (*pool_pos) + strlen (str) + 1;
 
  if (next_pos > pool_size)
    return GNUNET_SYSERR;
  memcpy (pool_start + *pool_pos, str, strlen (str) + 1);
  *pool_pos = next_pos;
  return GNUNET_OK;
}

References GNUNET_OK, and GNUNET_SYSERR.

Referenced by handle_list().

Here is the caller graph for this function:

handle_list()

static void handle_list ( void *  cls, const struct GNUNET_ARM_Message *  request  )

static

Handle LIST-message.

Parameters

cls	identification of the client
request	the actual message

Definition at line 1364 of file gnunet-service-arm.c.

{
  struct GNUNET_SERVICE_Client *client = cls;
  struct GNUNET_MQ_Envelope *env;
  struct GNUNET_ARM_ListResultMessage *msg;
  size_t extra_size;
  struct ServiceList *sl;
  uint16_t count;
  size_t pool_size;
  size_t pool_pos;
  char *pool_start;
  struct GNUNET_ARM_ServiceInfoMessage *ssm;
 
  GNUNET_break_op (0 == ntohl (request->reserved));
  count = 0;
  pool_size = 0;
 
  /* Do one pass over the list to compute the number of services
   * and the string pool size */
  for (sl = running_head; NULL != sl; sl = sl->next)
  {
    pool_size += strlen (sl->name) + 1;
    pool_size += strlen (sl->binary) + 1;
    count++;
  }
 
  extra_size = pool_size + (count * sizeof (struct
                                            GNUNET_ARM_ServiceInfoMessage));
  env = GNUNET_MQ_msg_extra (msg,
                             extra_size,
                             GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT);
  msg->arm_msg.request_id = request->request_id;
  msg->count = htons (count);
 
  ssm = (struct GNUNET_ARM_ServiceInfoMessage *) &msg[1];
  pool_start = (char *) (ssm + count);
  pool_pos = 0;
 
  for (sl = running_head; NULL != sl; sl = sl->next)
  {
    ssm->name_index = htons ((uint16_t) pool_pos);
    GNUNET_assert (GNUNET_OK == pool_write (pool_start, pool_size, &pool_pos,
                                            sl->name));
    ssm->binary_index = htons ((uint16_t) pool_pos);
    GNUNET_assert (GNUNET_OK == pool_write (pool_start, pool_size, &pool_pos,
                                            sl->binary));
    if (NULL == sl->proc)
    {
      if (0 == sl->last_started_at.abs_value_us)
      {
        /* Process never started */
        ssm->status = htonl (GNUNET_ARM_SERVICE_STATUS_STOPPED);
      }
      else if (0 == sl->last_exit_status)
      {
        ssm->status = htonl (GNUNET_ARM_SERVICE_STATUS_FINISHED);
      }
      else
      {
        ssm->status = htonl (GNUNET_ARM_SERVICE_STATUS_FAILED);
        ssm->last_exit_status = htons (sl->last_exit_status);
      }
    }
    else if ((NULL != sl->killing_client) || (GNUNET_YES == in_shutdown))
    {
      ssm->status = htonl (GNUNET_ARM_SERVICE_STATUS_STOPPING);
    }
    else
    {
      ssm->status = htonl (GNUNET_ARM_SERVICE_STATUS_STARTED);
    }
    ssm->last_started_at = GNUNET_TIME_absolute_hton (sl->last_started_at);
    ssm->restart_at = GNUNET_TIME_absolute_hton (sl->restart_at);
    ssm++;
  }
  GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client), env);
  GNUNET_SERVICE_client_continue (client);
}

References GNUNET_TIME_Absolute::abs_value_us, ServiceList::binary, GNUNET_ARM_ServiceInfoMessage::binary_index, env, GNUNET_ARM_SERVICE_STATUS_FAILED, GNUNET_ARM_SERVICE_STATUS_FINISHED, GNUNET_ARM_SERVICE_STATUS_STARTED, GNUNET_ARM_SERVICE_STATUS_STOPPED, GNUNET_ARM_SERVICE_STATUS_STOPPING, GNUNET_assert, GNUNET_break_op, GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_OK, GNUNET_SERVICE_client_continue(), GNUNET_SERVICE_client_get_mq(), GNUNET_TIME_absolute_hton(), GNUNET_YES, in_shutdown, ServiceList::killing_client, GNUNET_ARM_ServiceInfoMessage::last_exit_status, ServiceList::last_exit_status, GNUNET_ARM_ServiceInfoMessage::last_started_at, ServiceList::last_started_at, msg, ServiceList::name, GNUNET_ARM_ServiceInfoMessage::name_index, ServiceList::next, pool_write(), ServiceList::proc, request, GNUNET_VPN_RedirectionRequest::request_id, GNUNET_ARM_ServiceInfoMessage::restart_at, ServiceList::restart_at, running_head, and GNUNET_ARM_ServiceInfoMessage::status.

Here is the call graph for this function:

handle_test()

static void handle_test ( void *  cls, const struct GNUNET_MessageHeader *  message  )

static

Handle TEST-message by sending back TEST.

Parameters

cls	identification of the client
message	the actual message

Definition at line 1451 of file gnunet-service-arm.c.

{
  struct GNUNET_SERVICE_Client *client = cls;
  struct GNUNET_MQ_Envelope *env;
  struct GNUNET_MessageHeader *msg;
 
  (void) message;
  env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_ARM_TEST);
  GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client), env);
  GNUNET_SERVICE_client_continue (client);
}

References env, GNUNET_MESSAGE_TYPE_ARM_TEST, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_SERVICE_client_continue(), GNUNET_SERVICE_client_get_mq(), and msg.

Here is the call graph for this function:

do_shutdown()

static void do_shutdown ( )

static

We are done with everything.

Stop remaining tasks, signal handler and the server.

Definition at line 1469 of file gnunet-service-arm.c.

{
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Last shutdown phase\n");
  if (NULL != notifier)
  {
    GNUNET_notification_context_destroy (notifier);
    notifier = NULL;
  }
  if (NULL != service)
  {
    GNUNET_SERVICE_shutdown (service);
    service = NULL;
  }
  if (NULL != child_death_task)
  {
    GNUNET_SCHEDULER_cancel (child_death_task);
    child_death_task = NULL;
  }
}

References child_death_task, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_notification_context_destroy(), GNUNET_SCHEDULER_cancel(), GNUNET_SERVICE_shutdown(), notifier, and service.

Referenced by maint_child_death(), and shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

list_count()

static unsigned int list_count ( struct ServiceList *  running_head )

static

Count how many services are still active.

Parameters

running_head

list of services

Returns

number of active services found

Definition at line 1497 of file gnunet-service-arm.c.

{
  struct ServiceList *i;
  unsigned int res;
 
  for (res = 0, i = running_head; NULL != i; i = i->next, res++)
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%s\n", i->name);
  return res;
}

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, ServiceList::name, ServiceList::next, res, and running_head.

Referenced by maint_child_death(), and shutdown_task().

Here is the caller graph for this function:

shutdown_task()

static void shutdown_task ( void *  cls )

static

Task run for shutdown.

Parameters

cls	closure, NULL if we need to self-restart

Definition at line 1514 of file gnunet-service-arm.c.

{
  struct ServiceList *pos;
  struct ServiceList *nxt;
  struct ServiceListeningInfo *sli;
 
  (void) cls;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "First shutdown phase\n");
  if (NULL != child_restart_task)
  {
    GNUNET_SCHEDULER_cancel (child_restart_task);
    child_restart_task = NULL;
  }
  in_shutdown = GNUNET_YES;
  /* first, stop listening */
  for (pos = running_head; NULL != pos; pos = pos->next)
  {
    while (NULL != (sli = pos->listen_head))
    {
      GNUNET_CONTAINER_DLL_remove (pos->listen_head, pos->listen_tail, sli);
      if (NULL != sli->accept_task)
      {
        GNUNET_SCHEDULER_cancel (sli->accept_task);
        sli->accept_task = NULL;
      }
      GNUNET_break (GNUNET_OK ==
                    GNUNET_NETWORK_socket_close (sli->listen_socket));
      GNUNET_free (sli->service_addr);
      GNUNET_free (sli);
    }
  }
  /* then, shutdown all existing service processes */
  nxt = running_head;
  while (NULL != (pos = nxt))
  {
    nxt = pos->next;
    if (NULL != pos->proc)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Stopping service `%s'\n", pos->name);
      pos->killed_at = GNUNET_TIME_absolute_get ();
      if (0 != GNUNET_OS_process_kill (pos->proc, GNUNET_TERM_SIG))
        GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
    }
    else
    {
      free_service (pos);
    }
  }
  /* finally, should all service processes be already gone, terminate for real */
  if (NULL == running_head)
    do_shutdown ();
  else
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Delaying shutdown, have %u children still running\n",
                list_count (running_head));
}

References ServiceListeningInfo::accept_task, child_restart_task, do_shutdown(), free_service(), GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_strerror, GNUNET_NETWORK_socket_close(), GNUNET_OK, GNUNET_OS_process_kill(), GNUNET_SCHEDULER_cancel(), GNUNET_TERM_SIG, GNUNET_TIME_absolute_get(), GNUNET_YES, in_shutdown, ServiceList::killed_at, list_count(), ServiceList::listen_head, ServiceListeningInfo::listen_socket, ServiceList::listen_tail, ServiceList::name, ServiceList::next, ServiceList::proc, running_head, and ServiceListeningInfo::service_addr.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

delayed_restart_task()

static void delayed_restart_task ( void *  cls )

static

Task run whenever it is time to restart a child that died.

Parameters

cls	closure, always NULL

Definition at line 1578 of file gnunet-service-arm.c.

{
  struct ServiceList *sl;
  struct GNUNET_TIME_Relative lowestRestartDelay;
  struct ServiceListeningInfo *sli;
 
  (void) cls;
  child_restart_task = NULL;
  GNUNET_assert (GNUNET_NO == in_shutdown);
  lowestRestartDelay = GNUNET_TIME_UNIT_FOREVER_REL;
 
  /* check for services that need to be restarted due to
   * configuration changes or because the last restart failed */
  for (sl = running_head; NULL != sl; sl = sl->next)
  {
    if (NULL != sl->proc)
      continue;
    /* service is currently not running */
    if (0 == GNUNET_TIME_absolute_get_remaining (sl->restart_at).rel_value_us)
    {
      /* restart is now allowed */
      if (sl->force_start)
      {
        /* process should run by default, start immediately */
        GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                    _ ("Restarting service `%s'.\n"),
                    sl->name);
        start_process (sl, NULL, 0);
      }
      else
      {
        /* process is run on-demand, ensure it is re-started if there is demand */
        for (sli = sl->listen_head; NULL != sli; sli = sli->next)
          if (NULL == sli->accept_task)
          {
            /* accept was actually paused, so start it again */
            sli->accept_task =
              GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
                                             sli->listen_socket,
                                             &accept_connection,
                                             sli);
          }
      }
    }
    else
    {
      /* update calculation for earliest time to reactivate a service */
      lowestRestartDelay =
        GNUNET_TIME_relative_min (lowestRestartDelay,
                                  GNUNET_TIME_absolute_get_remaining (
                                    sl->restart_at));
    }
  }
  if (lowestRestartDelay.rel_value_us !=
      GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Will restart process in %s\n",
                GNUNET_STRINGS_relative_time_to_string (lowestRestartDelay,
                                                        GNUNET_YES));
    child_restart_task =
      GNUNET_SCHEDULER_add_delayed_with_priority (lowestRestartDelay,
                                                  GNUNET_SCHEDULER_PRIORITY_IDLE,
                                                  &delayed_restart_task,
                                                  NULL);
  }
}

References _, accept_connection(), ServiceListeningInfo::accept_task, child_restart_task, delayed_restart_task(), ServiceList::force_start, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_NO, GNUNET_SCHEDULER_add_delayed_with_priority(), GNUNET_SCHEDULER_add_read_net(), GNUNET_SCHEDULER_PRIORITY_IDLE, GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_absolute_get_remaining(), GNUNET_TIME_relative_min(), GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, in_shutdown, ServiceList::listen_head, ServiceListeningInfo::listen_socket, ServiceList::name, ServiceListeningInfo::next, ServiceList::next, ServiceList::proc, GNUNET_TIME_Relative::rel_value_us, ServiceList::restart_at, running_head, ServiceListeningInfo::sl, and start_process().

Referenced by delayed_restart_task(), and maint_child_death().

Here is the call graph for this function:

Here is the caller graph for this function:

maint_child_death()

static void maint_child_death ( void *  cls )

static

Task triggered whenever we receive a SIGCHLD (child process died).

Parameters

cls	closure, NULL

Definition at line 1655 of file gnunet-service-arm.c.

{
  struct ServiceList *pos;
  struct ServiceList *next;
  struct ServiceListeningInfo *sli;
  const char *statstr;
  int statcode;
  int ret;
  char c[16];
  enum GNUNET_OS_ProcessStatusType statusType;
  unsigned long statusCode;
  const struct GNUNET_DISK_FileHandle *pr;
 
  (void) cls;
  pr = GNUNET_DISK_pipe_handle (sigpipe, GNUNET_DISK_PIPE_END_READ);
  child_death_task = NULL;
  /* consume the signal */
  GNUNET_break (0 < GNUNET_DISK_file_read (pr, &c, sizeof(c)));
 
  /* check for services that died (WAITPID) */
  next = running_head;
  while (NULL != (pos = next))
  {
    next = pos->next;
 
    if (NULL == pos->proc)
    {
      if (GNUNET_YES == in_shutdown)
        free_service (pos);
      continue;
    }
#if HAVE_WAIT4
    if (NULL != wait_file)
    {
      /* need to use 'wait4()' to obtain and log performance data */
      struct rusage ru;
      int status;
      pid_t pid;
 
      pid = GNUNET_OS_process_get_pid (pos->proc);
      ret = wait4 (pid, &status, WNOHANG, &ru);
      if (ret <= 0)
        continue;     /* no process done */
      if (WIFEXITED (status))
      {
        statusType = GNUNET_OS_PROCESS_EXITED;
        statusCode = WEXITSTATUS (status);
      }
      else if (WIFSIGNALED (status))
      {
        statusType = GNUNET_OS_PROCESS_SIGNALED;
        statusCode = WTERMSIG (status);
      }
      else if (WIFSTOPPED (status))
      {
        statusType = GNUNET_OS_PROCESS_SIGNALED;
        statusCode = WSTOPSIG (status);
      }
#ifdef WIFCONTINUED
      else if (WIFCONTINUED (status))
      {
        statusType = GNUNET_OS_PROCESS_RUNNING;
        statusCode = 0;
      }
#endif
      else
      {
        statusType = GNUNET_OS_PROCESS_UNKNOWN;
        statusCode = 0;
      }
      if ((GNUNET_OS_PROCESS_EXITED == statusType) ||
          (GNUNET_OS_PROCESS_SIGNALED == statusType))
      {
        double utime = ru.ru_utime.tv_sec + (ru.ru_utime.tv_usec / 10e6);
        double stime = ru.ru_stime.tv_sec + (ru.ru_stime.tv_usec / 10e6);
        fprintf (wait_file,
                 "%s(%u) %.3f %.3f %llu %llu %llu %llu %llu\n",
                 pos->binary,
                 (unsigned int) pid,
                 utime,
                 stime,
                 (unsigned long long) ru.ru_maxrss,
                 (unsigned long long) ru.ru_inblock,
                 (unsigned long long) ru.ru_oublock,
                 (unsigned long long) ru.ru_nvcsw,
                 (unsigned long long) ru.ru_nivcsw);
      }
    }
    else   /* continue with JUST this "if" as "else" (intentionally no brackets!) */
#endif
    if ((GNUNET_SYSERR == (ret = GNUNET_OS_process_status (pos->proc,
                                                           &statusType,
                                                           &statusCode))) ||
        (ret == GNUNET_NO) || (statusType == GNUNET_OS_PROCESS_STOPPED) ||
        (statusType == GNUNET_OS_PROCESS_UNKNOWN) ||
        (statusType == GNUNET_OS_PROCESS_RUNNING))
      continue;
 
    if (statusType == GNUNET_OS_PROCESS_EXITED)
    {
      statstr = _ (/* process termination method */ "exit");
      statcode = statusCode;
    }
    else if (statusType == GNUNET_OS_PROCESS_SIGNALED)
    {
      statstr = _ (/* process termination method */ "signal");
      statcode = statusCode;
    }
    else
    {
      statstr = _ (/* process termination method */ "unknown");
      statcode = 0;
    }
    if (0 != pos->killed_at.abs_value_us)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                  _ ("Service `%s' took %s to terminate\n"),
                  pos->name,
                  GNUNET_STRINGS_relative_time_to_string (
                    GNUNET_TIME_absolute_get_duration (pos->killed_at),
                    GNUNET_YES));
    }
    GNUNET_OS_process_destroy (pos->proc);
    pos->proc = NULL;
    broadcast_status (pos->name, GNUNET_ARM_SERVICE_STOPPED, NULL);
    if (NULL != pos->killing_client)
    {
      signal_result (pos->killing_client,
                     pos->name,
                     pos->killing_client_request_id,
                     GNUNET_ARM_RESULT_STOPPED);
      pos->killing_client = NULL;
      pos->killing_client_request_id = 0;
    }
    if (GNUNET_YES != in_shutdown)
    {
      pos->last_exit_status = statcode;
      if ((statusType == GNUNET_OS_PROCESS_EXITED) && (statcode == 0))
      {
        /* process terminated normally, allow restart at any time */
        pos->restart_at.abs_value_us = 0;
        GNUNET_log (
          GNUNET_ERROR_TYPE_INFO,
          _ ("Service `%s' terminated normally, will restart at any time\n"),
          pos->name);
        /* process can still be re-started on-demand, ensure it is re-started if there is demand */
        for (sli = pos->listen_head; NULL != sli; sli = sli->next)
        {
          GNUNET_break (NULL == sli->accept_task);
          sli->accept_task =
            GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
                                           sli->listen_socket,
                                           &accept_connection,
                                           sli);
        }
      }
      else
      {
        GNUNET_log (
          GNUNET_ERROR_TYPE_WARNING,
          _ ("Service `%s' terminated with status %s/%d, will restart in %s\n"),
          pos->name,
          statstr,
          statcode,
          GNUNET_STRINGS_relative_time_to_string (pos->backoff, GNUNET_YES));
        {
          /* Reduce backoff based on runtime of the process,
             so that there is a cool-down if a process actually
             runs for a while. */
          struct GNUNET_TIME_Relative runtime;
          unsigned int minutes;
 
          runtime = GNUNET_TIME_absolute_get_duration (pos->restart_at);
          minutes =
            runtime.rel_value_us / GNUNET_TIME_UNIT_MINUTES.rel_value_us;
          if (minutes > 31)
            pos->backoff = GNUNET_TIME_UNIT_ZERO;
          else
            pos->backoff.rel_value_us >>= minutes;
        }
        /* schedule restart */
        pos->restart_at = GNUNET_TIME_relative_to_absolute (pos->backoff);
        pos->backoff = GNUNET_TIME_STD_BACKOFF (pos->backoff);
        if (NULL != child_restart_task)
          GNUNET_SCHEDULER_cancel (child_restart_task);
        child_restart_task =
          GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
                                              &delayed_restart_task,
                                              NULL);
      }
    }
    else
    {
      free_service (pos);
    }
  }
  child_death_task =
    GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
                                    pr,
                                    &maint_child_death,
                                    NULL);
  if ((NULL == running_head) && (GNUNET_YES == in_shutdown))
    do_shutdown ();
  else if (GNUNET_YES == in_shutdown)
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Delaying shutdown after child's death, still have %u children\n",
                list_count (running_head));
}

References _, GNUNET_TIME_Absolute::abs_value_us, accept_connection(), ServiceListeningInfo::accept_task, ServiceList::backoff, ServiceList::binary, broadcast_status(), child_death_task, child_restart_task, delayed_restart_task(), do_shutdown(), free_service(), GNUNET_ARM_RESULT_STOPPED, GNUNET_ARM_SERVICE_STOPPED, GNUNET_break, GNUNET_DISK_file_read(), GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_pipe_handle(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_log, GNUNET_NO, GNUNET_OS_process_destroy(), GNUNET_OS_PROCESS_EXITED, GNUNET_OS_process_get_pid(), GNUNET_OS_PROCESS_RUNNING, GNUNET_OS_PROCESS_SIGNALED, GNUNET_OS_process_status(), GNUNET_OS_PROCESS_STOPPED, GNUNET_OS_PROCESS_UNKNOWN, GNUNET_SCHEDULER_add_read_file(), GNUNET_SCHEDULER_add_read_net(), GNUNET_SCHEDULER_add_with_priority(), GNUNET_SCHEDULER_cancel(), GNUNET_SCHEDULER_PRIORITY_IDLE, GNUNET_STRINGS_relative_time_to_string(), GNUNET_SYSERR, GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_relative_to_absolute(), GNUNET_TIME_STD_BACKOFF, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_TIME_UNIT_MINUTES, GNUNET_TIME_UNIT_ZERO, GNUNET_YES, in_shutdown, ServiceList::killed_at, ServiceList::killing_client, ServiceList::killing_client_request_id, ServiceList::last_exit_status, list_count(), ServiceList::listen_head, ServiceListeningInfo::listen_socket, maint_child_death(), ServiceList::name, ServiceListeningInfo::next, ServiceList::next, pid, ServiceList::proc, GNUNET_TIME_Relative::rel_value_us, ServiceList::restart_at, ret, running_head, signal_result(), sigpipe, and status.

Referenced by maint_child_death(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

sighandler_child_death()

static void sighandler_child_death ( void  )

static

Signal handler called for SIGCHLD.

Triggers the respective handler by writing to the trigger pipe.

Definition at line 1870 of file gnunet-service-arm.c.

{
  static char c;
  int old_errno = errno; /* back-up errno */
 
  GNUNET_break (
    1 ==
    GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle (sigpipe,
                                                     GNUNET_DISK_PIPE_END_WRITE),
                            &c,
                            sizeof(c)));
  errno = old_errno; /* restore errno */
}

References GNUNET_break, GNUNET_DISK_file_write(), GNUNET_DISK_PIPE_END_WRITE, GNUNET_DISK_pipe_handle(), and sigpipe.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

setup_service()

static void setup_service ( void *  cls, const char *  section  )

static

Setup our service record for the given section in the configuration file (assuming the section is for a service).

Parameters

cls	unused
section	a section in the configuration file

Returns

GNUNET_OK (continue)

Definition at line 1894 of file gnunet-service-arm.c.

{
  struct ServiceList *sl;
  char *binary;
  char *config;
  struct stat sbuf;
  struct sockaddr **addrs;
  socklen_t *addr_lens;
  int ret;
 
  (void) cls;
  if (0 == strcasecmp (section, "arm"))
    return;
  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_string (cfg, section, "BINARY", &binary))
  {
    /* not a service section */
    return;
  }
  if ((GNUNET_YES ==
       GNUNET_CONFIGURATION_have_value (cfg, section, "RUN_PER_USER")) &&
      (GNUNET_YES ==
       GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "RUN_PER_USER")))
  {
    if (GNUNET_NO == start_user)
    {
      GNUNET_free (binary);
      return;     /* user service, and we don't deal with those */
    }
  }
  else
  {
    if (GNUNET_NO == start_system)
    {
      GNUNET_free (binary);
      return;     /* system service, and we don't deal with those */
    }
  }
  sl = find_service (section);
  if (NULL != sl)
  {
    /* got the same section twice!? */
    GNUNET_break (0);
    GNUNET_free (binary);
    return;
  }
  config = NULL;
  if (((GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (cfg,
                                                              section,
                                                              "CONFIG",
                                                              &config)) &&
       (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (cfg,
                                                              "PATHS",
                                                              "DEFAULTCONFIG",
                                                              &config))) ||
      (0 != stat (config, &sbuf)))
  {
    if (NULL != config)
    {
      GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
                                 section,
                                 "CONFIG",
                                 strerror (errno));
      GNUNET_free (config);
      config = NULL;
    }
  }
  sl = GNUNET_new (struct ServiceList);
  sl->name = GNUNET_strdup (section);
  sl->binary = binary;
  sl->config = config;
  sl->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
  sl->restart_at = GNUNET_TIME_UNIT_FOREVER_ABS;
  if (GNUNET_CONFIGURATION_have_value (cfg, section, "PIPECONTROL"))
    sl->pipe_control =
      GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "PIPECONTROL");
  GNUNET_CONTAINER_DLL_insert (running_head, running_tail, sl);
  if (GNUNET_YES ==
      GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "IMMEDIATE_START"))
  {
    sl->force_start = GNUNET_YES;
    if (GNUNET_YES ==
        GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "NOARMBIND"))
      return;
  }
  else
  {
    if (GNUNET_YES !=
        GNUNET_CONFIGURATION_get_value_yesno (cfg, section, "START_ON_DEMAND"))
      return;
  }
  if (0 >= (ret = get_server_addresses (section, cfg, &addrs, &addr_lens)))
    return;
  /* this will free (or capture) addrs[i] */
  for (unsigned int i = 0; i < (unsigned int) ret; i++)
    create_listen_socket (addrs[i], addr_lens[i], sl);
  GNUNET_free (addrs);
  GNUNET_free (addr_lens);
}

References ServiceList::backoff, ServiceList::binary, cfg, config, ServiceList::config, create_listen_socket(), find_service(), ServiceList::force_start, get_server_addresses(), GNUNET_break, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_CONFIGURATION_have_value(), GNUNET_CONTAINER_DLL_insert, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log_config_invalid(), GNUNET_new, GNUNET_NO, GNUNET_OK, GNUNET_strdup, GNUNET_TIME_UNIT_FOREVER_ABS, GNUNET_TIME_UNIT_MILLISECONDS, GNUNET_YES, consensus-simulation::int, ServiceList::name, ServiceList::pipe_control, ServiceList::restart_at, ret, running_head, running_tail, start_system, and start_user.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

client_connect_cb()

static void * client_connect_cb ( void *  cls, struct GNUNET_SERVICE_Client *  client, struct GNUNET_MQ_Handle *  mq  )

static

A client connected, mark as a monitoring client.

Parameters

cls	closure
client	identification of the client
mq	queue to talk to client

Returns

client

Definition at line 2004 of file gnunet-service-arm.c.

{
  /* All clients are considered to be of the "monitor" kind
   * (that is, they don't affect ARM shutdown).
   */
  (void) cls;
  (void) mq;
  GNUNET_SERVICE_client_mark_monitor (client);
  return client;
}

References GNUNET_SERVICE_client_mark_monitor(), and mq.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

client_disconnect_cb()

static void client_disconnect_cb ( void *  cls, struct GNUNET_SERVICE_Client *  client, void *  app_ctx  )

static

A client disconnected, clean up associated state.

Parameters

cls	closure
client	identification of the client
app_ctx	must match client

Definition at line 2026 of file gnunet-service-arm.c.

{
  (void) cls;
  GNUNET_assert (client == app_ctx);
  for (struct ServiceList *sl = running_head; NULL != sl; sl = sl->next)
    if (sl->killing_client == client)
      sl->killing_client = NULL;
}

References GNUNET_assert, ServiceList::next, and running_head.

Referenced by main().

Here is the caller graph for this function:

handle_monitor()

static void handle_monitor ( void *  cls, const struct GNUNET_MessageHeader *  message  )

static

Handle MONITOR-message.

Parameters

cls	identification of the client
message	the actual message

Returns

GNUNET_OK to keep the connection open, GNUNET_SYSERR to close it (signal serious error)

Definition at line 2047 of file gnunet-service-arm.c.

{
  struct GNUNET_SERVICE_Client *client = cls;
 
  (void) message;
  /* FIXME: might want to start by letting monitor know about
     services that are already running */
  /* Removal is handled by the server implementation, internally. */
  GNUNET_notification_context_add (notifier,
                                   GNUNET_SERVICE_client_get_mq (client));
  broadcast_status ("arm", GNUNET_ARM_SERVICE_MONITORING_STARTED, client);
  GNUNET_SERVICE_client_continue (client);
}

References broadcast_status(), GNUNET_ARM_SERVICE_MONITORING_STARTED, GNUNET_notification_context_add(), GNUNET_SERVICE_client_continue(), GNUNET_SERVICE_client_get_mq(), and notifier.

Here is the call graph for this function:

run()

static void run ( void *  cls, const struct GNUNET_CONFIGURATION_Handle *  c, struct GNUNET_SERVICE_Handle *  serv  )

static

Process arm requests.

Parameters

cls	closure, NULL
serv	the initialized service
c	configuration to use

Definition at line 2070 of file gnunet-service-arm.c.

{
  struct ServiceList *sl;
 
  (void) cls;
  cfg = c;
  service = serv;
  GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
  child_death_task = GNUNET_SCHEDULER_add_read_file (
    GNUNET_TIME_UNIT_FOREVER_REL,
    GNUNET_DISK_pipe_handle (sigpipe, GNUNET_DISK_PIPE_END_READ),
    &maint_child_death,
    NULL);
#if HAVE_WAIT4
  if (GNUNET_OK ==
      GNUNET_CONFIGURATION_get_value_filename (cfg,
                                               "ARM",
                                               "RESOURCE_DIAGNOSTICS",
                                               &wait_filename))
  {
    wait_file = fopen (wait_filename, "w");
    if (NULL == wait_file)
    {
      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
                                "fopen",
                                wait_filename);
    }
  }
#endif
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg,
                                                          "ARM",
                                                          "GLOBAL_PREFIX",
                                                          &prefix_command))
    prefix_command = GNUNET_strdup ("");
  else
    prefix_command = GNUNET_CONFIGURATION_expand_dollar (cfg, prefix_command);
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg,
                                                          "ARM",
                                                          "GLOBAL_POSTFIX",
                                                          &final_option))
    final_option = GNUNET_strdup ("");
  else
    final_option = GNUNET_CONFIGURATION_expand_dollar (cfg, final_option);
  start_user =
    GNUNET_CONFIGURATION_get_value_yesno (cfg, "ARM", "START_USER_SERVICES");
  start_system =
    GNUNET_CONFIGURATION_get_value_yesno (cfg, "ARM", "START_SYSTEM_SERVICES");
  if ((GNUNET_NO == start_user) && (GNUNET_NO == start_system))
  {
    GNUNET_log (
      GNUNET_ERROR_TYPE_ERROR,
      "Please configure either START_USER_SERVICES or START_SYSTEM_SERVICES or both.\n");
    GNUNET_SCHEDULER_shutdown ();
    global_ret = 1;
    return;
  }
  GNUNET_CONFIGURATION_iterate_sections (cfg, &setup_service, NULL);
 
  /* start default services... */
  for (sl = running_head; NULL != sl; sl = sl->next)
    if (GNUNET_YES == sl->force_start)
      start_process (sl, NULL, 0);
  notifier = GNUNET_notification_context_create (MAX_NOTIFY_QUEUE);
}

References cfg, child_death_task, final_option, ServiceList::force_start, global_ret, GNUNET_CONFIGURATION_expand_dollar(), GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_CONFIGURATION_iterate_sections(), GNUNET_DISK_PIPE_END_READ, GNUNET_DISK_pipe_handle(), GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_log_strerror_file, GNUNET_NO, GNUNET_notification_context_create(), GNUNET_OK, GNUNET_SCHEDULER_add_read_file(), GNUNET_SCHEDULER_add_shutdown(), GNUNET_SCHEDULER_shutdown(), GNUNET_strdup, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, maint_child_death(), MAX_NOTIFY_QUEUE, ServiceList::next, notifier, prefix_command, running_head, service, setup_service(), shutdown_task(), sigpipe, start_process(), start_system, and start_user.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

main()

int main	(	int	argc,
		char *const *	argv
	)

The main function for the arm service.

Parameters

argc	number of arguments from the command line
argv	command line arguments

Returns

0 ok, 1 on error

Definition at line 2146 of file gnunet-service-arm.c.

{
  struct GNUNET_SIGNAL_Context *shc_chld;
  struct GNUNET_MQ_MessageHandler handlers[] = {
    GNUNET_MQ_hd_var_size (start,
                           GNUNET_MESSAGE_TYPE_ARM_START,
                           struct GNUNET_ARM_Message,
                           NULL),
    GNUNET_MQ_hd_var_size (stop,
                           GNUNET_MESSAGE_TYPE_ARM_STOP,
                           struct GNUNET_ARM_Message,
                           NULL),
    GNUNET_MQ_hd_fixed_size (monitor,
                             GNUNET_MESSAGE_TYPE_ARM_MONITOR,
                             struct GNUNET_MessageHeader,
                             NULL),
    GNUNET_MQ_hd_fixed_size (list,
                             GNUNET_MESSAGE_TYPE_ARM_LIST,
                             struct GNUNET_ARM_Message,
                             NULL),
    GNUNET_MQ_hd_fixed_size (test,
                             GNUNET_MESSAGE_TYPE_ARM_TEST,
                             struct GNUNET_MessageHeader,
                             NULL),
    GNUNET_MQ_handler_end ()
  };
 
  sigpipe = GNUNET_DISK_pipe (GNUNET_DISK_PF_NONE);
  GNUNET_assert (NULL != sigpipe);
  shc_chld =
    GNUNET_SIGNAL_handler_install (GNUNET_SIGCHLD,
                                   &sighandler_child_death);
  if (0 != GNUNET_SERVICE_run_ (argc,
                                argv,
                                "arm",
                                GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN
                                | GNUNET_SERVICE_OPTION_CLOSE_LSOCKS,
                                &run,
                                &client_connect_cb,
                                &client_disconnect_cb,
                                NULL,
                                handlers))
    global_ret = 2;
#if HAVE_WAIT4
  if (NULL != wait_file)
  {
    fclose (wait_file);
    wait_file = NULL;
  }
  if (NULL != wait_filename)
  {
    GNUNET_free (wait_filename);
    wait_filename = NULL;
  }
#endif
  GNUNET_SIGNAL_handler_uninstall (shc_chld);
  shc_chld = NULL;
  GNUNET_DISK_pipe_close (sigpipe);
  sigpipe = NULL;
  return global_ret;
}

References client_connect_cb(), client_disconnect_cb(), global_ret, GNUNET_assert, GNUNET_DISK_PF_NONE, GNUNET_DISK_pipe(), GNUNET_DISK_pipe_close(), GNUNET_free, GNUNET_MESSAGE_TYPE_ARM_LIST, GNUNET_MESSAGE_TYPE_ARM_MONITOR, GNUNET_MESSAGE_TYPE_ARM_START, GNUNET_MESSAGE_TYPE_ARM_STOP, GNUNET_MESSAGE_TYPE_ARM_TEST, GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, GNUNET_SERVICE_OPTION_CLOSE_LSOCKS, GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN, GNUNET_SERVICE_run_(), GNUNET_SIGCHLD, GNUNET_SIGNAL_handler_install(), GNUNET_SIGNAL_handler_uninstall(), handlers, list, monitor, run(), shc_chld, sighandler_child_death(), sigpipe, and start.

Here is the call graph for this function:

Variable Documentation

running_head

struct ServiceList* running_head

static

List of running services.

Definition at line 206 of file gnunet-service-arm.c.

Referenced by client_disconnect_cb(), delayed_restart_task(), find_service(), free_service(), handle_list(), list_count(), maint_child_death(), run(), setup_service(), and shutdown_task().

running_tail

struct ServiceList* running_tail

static

List of running services.

Definition at line 211 of file gnunet-service-arm.c.

Referenced by free_service(), and setup_service().

cfg

const struct GNUNET_CONFIGURATION_Handle* cfg

static

Our configuration.

Definition at line 216 of file gnunet-service-arm.c.

Referenced by create_listen_socket(), get_server_addresses(), run(), setup_service(), and start_process().

prefix_command

char* prefix_command

static

Command to prepend to each actual command.

Definition at line 221 of file gnunet-service-arm.c.

Referenced by run(), and start_process().

final_option

char* final_option

static

Option to append to each actual command.

Definition at line 226 of file gnunet-service-arm.c.

Referenced by run(), and start_process().

child_death_task

struct GNUNET_SCHEDULER_Task* child_death_task

static

ID of task called whenever we get a SIGCHILD.

Definition at line 231 of file gnunet-service-arm.c.

Referenced by do_shutdown(), maint_child_death(), and run().

child_restart_task

struct GNUNET_SCHEDULER_Task* child_restart_task

static

ID of task called whenever the timeout for restarting a child expires.

Definition at line 237 of file gnunet-service-arm.c.

Referenced by delayed_restart_task(), maint_child_death(), and shutdown_task().

sigpipe

struct GNUNET_DISK_PipeHandle* sigpipe

static

Pipe used to communicate shutdown via signal.

Definition at line 242 of file gnunet-service-arm.c.

Referenced by main(), maint_child_death(), run(), and sighandler_child_death().

in_shutdown

int in_shutdown

static

Are we in shutdown mode?

Definition at line 247 of file gnunet-service-arm.c.

Referenced by accept_connection(), delayed_restart_task(), free_service(), handle_list(), handle_start(), handle_stop(), maint_child_death(), and shutdown_task().

global_ret

int global_ret

static

Return value from main.

Definition at line 252 of file gnunet-service-arm.c.

Referenced by main(), and run().

start_user

int start_user = GNUNET_YES

static

Are we starting user services?

Definition at line 257 of file gnunet-service-arm.c.

Referenced by run(), and setup_service().

start_system

int start_system = GNUNET_YES

static

Are we starting system services?

Definition at line 262 of file gnunet-service-arm.c.

Referenced by run(), and setup_service().

service

struct GNUNET_SERVICE_Handle* service

static

Handle to our service instance.

Our service is a bit special in that its service is not immediately stopped once we get a shutdown request (since we need to continue service until all of our child processes are dead). This handle is used to shut down the service (and thus trigger process termination) once all child processes are also dead. A special option in the ARM configuration modifies the behaviour of the service implementation to not do the shutdown immediately.

Definition at line 274 of file gnunet-service-arm.c.

Referenced by add_service_handle(), callback_shutdown_service(), check_get(), check_set(), check_statistics_value(), check_watch(), close_service_room(), create_message_info(), create_message_peer(), create_service(), create_srv_handle(), destroy_service(), do_shutdown(), entry_service_room(), find_subsystem_entry(), free_service_record(), get_service_contact_store(), get_service_peer_identity(), get_service_room(), gns_string_to_value(), handle_get(), handle_service_message(), handle_set(), handle_statistics_value(), handle_watch(), init_peer_store(), open_service_room(), recv_message_miss(), remove_service_handle(), resolver_lookup_get_next_label(), run(), srv_status(), and store_service().

notifier

struct GNUNET_NotificationContext* notifier

static

Context for notifications we need to send to our clients.

Definition at line 279 of file gnunet-service-arm.c.

Referenced by broadcast_status(), do_shutdown(), handle_monitor(), and run().