transport_api_cmd_start_peer.c File Reference

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testing_ng_lib.h"
#include "gnunet_testing_netjail_lib.h"
#include "gnunet_peerstore_service.h"
#include "gnunet_transport_core_service.h"
#include "gnunet_transport_application_service.h"
#include "transport-testing-cmds.h"

Include dependency graph for transport_api_cmd_start_peer.c:

Go to the source code of this file.

Macros
#define	LOG(kind, ...)   GNUNET_log (kind, __VA_ARGS__)
	Generic logging shortcut. More...

Functions
static void	retrieve_hello (void *cls)
	Function to start the retrieval task to retrieve the hello of this peer from the peerstore. More...
static void	hello_iter_cb (void *cb_cls, const struct GNUNET_PEERSTORE_Record *record, const char *emsg)
	Callback delivering the hello of this peer from peerstore. More...
static void	notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer, void *handler_cls)
	Disconnect callback for the connection to the core service. More...
static void *	notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer, struct GNUNET_MQ_Handle *mq)
	Connect callback for the connection to the core service. More...
static void	start_peer_run (void *cls, struct GNUNET_TESTING_Interpreter *is)
	The run method of this cmd will start all services of a peer to test the transport service. More...
static void	start_peer_cleanup (void *cls)
	The cleanup function of this cmd frees resources the cmd allocated. More...
static int	start_peer_traits (void *cls, const void **ret, const char *trait, unsigned int index)
	This function prepares an array with traits. More...
struct GNUNET_TESTING_Command	GNUNET_TRANSPORT_cmd_start_peer (const char *label, const char *system_label, uint32_t no, const char *node_ip, struct GNUNET_MQ_MessageHandler *handlers, const char *cfgname, GNUNET_TRANSPORT_notify_connect_cb notify_connect, unsigned int broadcast)
	Create command. More...

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log (kind, __VA_ARGS__)

Generic logging shortcut.

Definition at line 38 of file transport_api_cmd_start_peer.c.

Function Documentation

retrieve_hello()

static void retrieve_hello ( void *  cls )

static

Function to start the retrieval task to retrieve the hello of this peer from the peerstore.

Definition at line 82 of file transport_api_cmd_start_peer.c.

{
  struct StartPeerState *sps = cls;
  sps->rh_task = NULL;
  sps->pic = GNUNET_PEERSTORE_iterate (sps->ph,
                                       "transport",
                                       &sps->id,
                                       GNUNET_PEERSTORE_TRANSPORT_HELLO_KEY,
                                       hello_iter_cb,
                                       sps);
 
}

References GNUNET_PEERSTORE_iterate(), GNUNET_PEERSTORE_TRANSPORT_HELLO_KEY, hello_iter_cb(), StartPeerState::id, StartPeerState::ph, StartPeerState::pic, and StartPeerState::rh_task.

Referenced by hello_iter_cb(), and start_peer_run().

Here is the call graph for this function:

Here is the caller graph for this function:

hello_iter_cb()

static void hello_iter_cb ( void *  cb_cls, const struct GNUNET_PEERSTORE_Record *  record, const char *  emsg  )

static

Callback delivering the hello of this peer from peerstore.

Definition at line 50 of file transport_api_cmd_start_peer.c.

{
  struct StartPeerState *sps = cb_cls;
  if (NULL == record)
  {
    sps->pic = NULL;
    sps->rh_task = GNUNET_SCHEDULER_add_now (retrieve_hello, sps);
    return;
  }
  // Check record type et al?
  sps->hello_size = record->value_size;
  sps->hello = GNUNET_malloc (sps->hello_size);
  memcpy (sps->hello, record->value, sps->hello_size);
  sps->hello[sps->hello_size - 1] = '\0';
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Our hello %s\n",
       sps->hello);
  GNUNET_PEERSTORE_iterate_cancel (sps->pic);
  sps->pic = NULL;
  GNUNET_TESTING_async_finish (&sps->ac);
}

References StartPeerState::ac, GNUNET_ERROR_TYPE_DEBUG, GNUNET_malloc, GNUNET_PEERSTORE_iterate_cancel(), GNUNET_SCHEDULER_add_now(), GNUNET_TESTING_async_finish(), StartPeerState::hello, StartPeerState::hello_size, LOG, StartPeerState::pic, record(), retrieve_hello(), and StartPeerState::rh_task.

Referenced by retrieve_hello().

Here is the call graph for this function:

Here is the caller graph for this function:

notify_disconnect()

static void notify_disconnect ( void *  cls, const struct GNUNET_PeerIdentity *  peer, void *  handler_cls  )

static

Disconnect callback for the connection to the core service.

Definition at line 101 of file transport_api_cmd_start_peer.c.

{
  struct StartPeerState *sps = cls;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Peer %s disconnected from peer %u (`%s')\n",
       GNUNET_i2s (peer),
       sps->no,
       GNUNET_i2s (&sps->id));
 
}

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), StartPeerState::id, LOG, StartPeerState::no, and peer.

Referenced by start_peer_run().

Here is the call graph for this function:

Here is the caller graph for this function:

notify_connect()

static void* notify_connect ( void *  cls, const struct GNUNET_PeerIdentity *  peer, struct GNUNET_MQ_Handle *  mq  )

static

Connect callback for the connection to the core service.

Definition at line 121 of file transport_api_cmd_start_peer.c.

{
  struct StartPeerState *sps = cls;
  struct GNUNET_ShortHashCode *key = GNUNET_new (struct GNUNET_ShortHashCode);
  struct GNUNET_HashCode hc;
  struct GNUNET_CRYPTO_EddsaPublicKey public_key = peer->public_key;
 
  void *ret = (struct GNUNET_PeerIdentity *) peer;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "This Peer %s \n",
       GNUNET_i2s (&sps->id));
 
 
  GNUNET_CRYPTO_hash (&public_key, sizeof(public_key), &hc);
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Peer %s connected to peer number %u with mq %p\n",
       GNUNET_i2s (peer),
       sps->no,
       mq);
 
 
  memcpy (key,
          &hc,
          sizeof (*key));
  GNUNET_CONTAINER_multishortmap_put (sps->connected_peers_map,
                                      key,
                                      mq,
                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 
  GNUNET_free (key);
 
  sps->notify_connect (sps->ac.is,
                       peer);
 
  return ret;
}

References StartPeerState::ac, StartPeerState::connected_peers_map, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE, GNUNET_CONTAINER_multishortmap_put(), GNUNET_CRYPTO_hash(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_i2s(), GNUNET_new, StartPeerState::id, GNUNET_TESTING_AsyncContext::is, key, LOG, mq, StartPeerState::no, StartPeerState::notify_connect, peer, GNUNET_PeerIdentity::public_key, and ret.

Referenced by start_peer_run().

Here is the call graph for this function:

Here is the caller graph for this function:

start_peer_run()

static void start_peer_run ( void *  cls, struct GNUNET_TESTING_Interpreter *  is  )

static

The run method of this cmd will start all services of a peer to test the transport service.

Definition at line 168 of file transport_api_cmd_start_peer.c.

{
  struct StartPeerState *sps = cls;
  char *emsg = NULL;
  struct GNUNET_PeerIdentity dummy;
  const struct GNUNET_TESTING_Command *system_cmd;
  const struct GNUNET_TESTING_System *tl_system;
  char *home;
  char *transport_unix_path;
  char *tcp_communicator_unix_path;
  char *udp_communicator_unix_path;
  char *bindto;
  char *bindto_udp;
 
  if (GNUNET_NO == GNUNET_DISK_file_test (sps->cfgname))
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "File not found: `%s'\n",
         sps->cfgname);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
 
 
  sps->cfg = GNUNET_CONFIGURATION_create ();
  GNUNET_assert (GNUNET_OK ==
                 GNUNET_CONFIGURATION_load (sps->cfg, sps->cfgname));
 
  GNUNET_asprintf (&home,
                   "$GNUNET_TMP/test-transport/api-tcp-p%u",
                   sps->no);
 
  GNUNET_asprintf (&transport_unix_path,
                   "$GNUNET_RUNTIME_DIR/tng-p%u.sock",
                   sps->no);
 
  GNUNET_asprintf (&tcp_communicator_unix_path,
                   "$GNUNET_RUNTIME_DIR/tcp-comm-p%u.sock",
                   sps->no);
 
  GNUNET_asprintf (&udp_communicator_unix_path,
                   "$GNUNET_RUNTIME_DIR/tcp-comm-p%u.sock",
                   sps->no);
 
  GNUNET_asprintf (&bindto,
                   "%s:60002",
                   sps->node_ip);
 
  GNUNET_asprintf (&bindto_udp,
                   "2086");
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "node_ip %s\n",
       bindto);
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "bind_udp %s\n",
       GNUNET_YES == sps->broadcast ?
       bindto_udp : bindto);
 
  GNUNET_CONFIGURATION_set_value_string (sps->cfg, "PATHS", "GNUNET_TEST_HOME",
                                         home);
  GNUNET_CONFIGURATION_set_value_string (sps->cfg, "transport", "UNIXPATH",
                                         transport_unix_path);
  GNUNET_CONFIGURATION_set_value_string (sps->cfg, "communicator-tcp",
                                         "BINDTO",
                                         bindto);
  GNUNET_CONFIGURATION_set_value_string (sps->cfg, "communicator-udp",
                                         "BINDTO",
                                         GNUNET_YES == sps->broadcast ?
                                         bindto_udp : bindto);
  GNUNET_CONFIGURATION_set_value_string (sps->cfg, "communicator-tcp",
                                         "UNIXPATH",
                                         tcp_communicator_unix_path);
  GNUNET_CONFIGURATION_set_value_string (sps->cfg, "communicator-udp",
                                         "UNIXPATH",
                                         udp_communicator_unix_path);
 
 
  system_cmd = GNUNET_TESTING_interpreter_lookup_command (is,
                                                          sps->system_label);
  GNUNET_TESTING_get_trait_test_system (system_cmd,
                                        &tl_system);
 
  sps->tl_system = tl_system;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Creating testing library with key number %u\n",
       sps->no);
 
  if (GNUNET_SYSERR ==
      GNUNET_TESTING_configuration_create ((struct
                                            GNUNET_TESTING_System *) tl_system,
                                           sps->cfg))
  {
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Testing library failed to create unique configuration based on `%s'\n",
         sps->cfgname);
    GNUNET_CONFIGURATION_destroy (sps->cfg);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
 
  sps->peer = GNUNET_TESTING_peer_configure ((struct
                                              GNUNET_TESTING_System *) sps->
                                             tl_system,
                                             sps->cfg,
                                             sps->no,
                                             NULL,
                                             &emsg);
  if (NULL == sps->peer)
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Testing library failed to create unique configuration based on `%s': `%s' with key number %u\n",
         sps->cfgname,
         emsg,
         sps->no);
    GNUNET_free (emsg);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
 
  if (GNUNET_OK != GNUNET_TESTING_peer_start (sps->peer))
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Testing library failed to create unique configuration based on `%s'\n",
         sps->cfgname);
    GNUNET_free (emsg);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
 
  memset (&dummy,
          '\0',
          sizeof(dummy));
 
  GNUNET_TESTING_peer_get_identity (sps->peer,
                                    &sps->id);
 
  if (0 == memcmp (&dummy,
                   &sps->id,
                   sizeof(struct GNUNET_PeerIdentity)))
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Testing library failed to obtain peer identity for peer %u\n",
         sps->no);
    GNUNET_free (emsg);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Peer %u configured with identity `%s'\n",
       sps->no,
       GNUNET_i2s_full (&sps->id));
 
  sps->th = GNUNET_TRANSPORT_core_connect (sps->cfg,
                                           NULL,
                                           sps->handlers,
                                           sps,
                                           &notify_connect,
                                           &notify_disconnect);
  if (NULL == sps->th)
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Failed to connect to transport service for peer `%s': `%s'\n",
         sps->cfgname,
         emsg);
    GNUNET_free (emsg);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
 
  sps->ph = GNUNET_PEERSTORE_connect (sps->cfg);
  if (NULL == sps->th)
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Failed to connect to peerstore service for peer `%s': `%s'\n",
         sps->cfgname,
         emsg);
    GNUNET_free (emsg);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
 
  sps->ah = GNUNET_TRANSPORT_application_init (sps->cfg);
  if (NULL == sps->ah)
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Failed to initialize the TRANSPORT application suggestion client handle for peer `%s': `%s'\n",
         sps->cfgname,
         emsg);
    GNUNET_free (emsg);
    GNUNET_TESTING_interpreter_fail (is);
    return;
  }
  sps->rh_task = GNUNET_SCHEDULER_add_now (retrieve_hello, sps);
  GNUNET_free (home);
  GNUNET_free (transport_unix_path);
  GNUNET_free (tcp_communicator_unix_path);
  GNUNET_free (udp_communicator_unix_path);
  GNUNET_free (bindto);
  GNUNET_free (bindto_udp);
}

References StartPeerState::ah, StartPeerState::broadcast, StartPeerState::cfg, StartPeerState::cfgname, dummy, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_load(), GNUNET_CONFIGURATION_set_value_string(), GNUNET_DISK_file_test(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_i2s_full(), GNUNET_NO, GNUNET_OK, GNUNET_PEERSTORE_connect(), GNUNET_SCHEDULER_add_now(), GNUNET_SYSERR, GNUNET_TESTING_configuration_create(), GNUNET_TESTING_get_trait_test_system(), GNUNET_TESTING_interpreter_fail(), GNUNET_TESTING_interpreter_lookup_command(), GNUNET_TESTING_peer_configure(), GNUNET_TESTING_peer_get_identity(), GNUNET_TESTING_peer_start(), GNUNET_TRANSPORT_application_init(), GNUNET_TRANSPORT_core_connect(), GNUNET_YES, StartPeerState::handlers, StartPeerState::id, is, LOG, StartPeerState::no, StartPeerState::node_ip, notify_connect(), notify_disconnect(), StartPeerState::peer, StartPeerState::ph, retrieve_hello(), StartPeerState::rh_task, StartPeerState::system_label, StartPeerState::th, and StartPeerState::tl_system.

Here is the call graph for this function:

start_peer_cleanup()

static void start_peer_cleanup ( void *  cls )

static

The cleanup function of this cmd frees resources the cmd allocated.

Definition at line 379 of file transport_api_cmd_start_peer.c.

{
  struct StartPeerState *sps = cls;
 
  if (NULL != sps->handlers)
  {
    GNUNET_free (sps->handlers);
    sps->handlers = NULL;
  }
  // TODO Investigate why this caused problems during shutdown.
  /*if (NULL != sps->cfg)
  {
    GNUNET_CONFIGURATION_destroy (sps->cfg);
    sps->cfg = NULL;
    }*/
  GNUNET_free (sps->cfgname);
  GNUNET_free (sps->node_ip);
  GNUNET_free (sps->system_label);
  GNUNET_free (sps->hello);
  GNUNET_free (sps->connected_peers_map);
  GNUNET_free (sps);
}

References StartPeerState::cfgname, StartPeerState::connected_peers_map, GNUNET_free, StartPeerState::handlers, StartPeerState::hello, StartPeerState::node_ip, and StartPeerState::system_label.

start_peer_traits()

static int start_peer_traits ( void *  cls, const void **  ret, const char *  trait, unsigned int  index  )

static

This function prepares an array with traits.

Definition at line 408 of file transport_api_cmd_start_peer.c.

{
  struct StartPeerState *sps = cls;
  struct GNUNET_TRANSPORT_ApplicationHandle *ah = sps->ah;
  struct GNUNET_PeerIdentity *id = &sps->id;
  struct GNUNET_CONTAINER_MultiShortmap *connected_peers_map =
    sps->connected_peers_map;
  char *hello = sps->hello;
  size_t hello_size = sps->hello_size;
 
 
  struct GNUNET_TESTING_Trait traits[] = {
    GNUNET_TRANSPORT_make_trait_application_handle ((const void *) ah),
    GNUNET_TRANSPORT_make_trait_peer_id ((const void *) id),
    GNUNET_TRANSPORT_make_trait_connected_peers_map ((const
                                                      void *)
                                                     connected_peers_map),
    GNUNET_TRANSPORT_make_trait_hello ((const void *) hello),
    GNUNET_TRANSPORT_make_trait_hello_size ((const void *) hello_size),
    GNUNET_TRANSPORT_make_trait_state ((const void *) sps),
    GNUNET_TRANSPORT_make_trait_broadcast ((const void *) &sps->broadcast),
    GNUNET_TESTING_trait_end ()
  };
 
  return GNUNET_TESTING_get_trait (traits,
                                   ret,
                                   trait,
                                   index);
}

References ah, StartPeerState::ah, StartPeerState::connected_peers_map, GNUNET_TESTING_get_trait(), GNUNET_TESTING_trait_end(), GNUNET_TRANSPORT_make_trait_application_handle(), GNUNET_TRANSPORT_make_trait_broadcast(), GNUNET_TRANSPORT_make_trait_connected_peers_map(), GNUNET_TRANSPORT_make_trait_hello(), GNUNET_TRANSPORT_make_trait_hello_size(), GNUNET_TRANSPORT_make_trait_peer_id(), GNUNET_TRANSPORT_make_trait_state(), StartPeerState::hello, StartPeerState::hello_size, StartPeerState::id, GNUNET_TESTING_Trait::index, and ret.

Here is the call graph for this function:

GNUNET_TRANSPORT_cmd_start_peer()

struct GNUNET_TESTING_Command GNUNET_TRANSPORT_cmd_start_peer	(	const char *	label,
		const char *	system_label,
		uint32_t	no,
		const char *	node_ip,
		struct GNUNET_MQ_MessageHandler *	handlers,
		const char *	cfgname,
		GNUNET_TRANSPORT_notify_connect_cb	notify_connect,
		unsigned int	broadcast
	)

Create command.

Parameters

label	name for command.
system_label	Label of the cmd to setup a test environment.
no	Decimal number representing the last byte of the IP address of this peer.
node_ip	The IP address of this node.
handlers	Handler for messages received by this peer.
cfgname	Configuration file name for this peer.
notify_connect	Method which will be called, when a peer connects.
broadcast	Flag indicating, if broadcast should be switched on.

Returns

command.

Definition at line 408 of file transport_api_cmd_start_peer.c.

{
  struct StartPeerState *sps;
  struct GNUNET_CONTAINER_MultiShortmap *connected_peers_map =
    GNUNET_CONTAINER_multishortmap_create (1,GNUNET_NO);
  unsigned int i;
 
  sps = GNUNET_new (struct StartPeerState);
  sps->no = no;
  sps->system_label = GNUNET_strdup (system_label);
  sps->connected_peers_map = connected_peers_map;
  sps->cfgname = GNUNET_strdup (cfgname);
  sps->node_ip = GNUNET_strdup (node_ip);
  sps->notify_connect = notify_connect;
  sps->broadcast = broadcast;
 
  if (NULL != handlers)
  {
    for (i = 0; NULL != handlers[i].cb; i++)
      ;
    sps->handlers = GNUNET_new_array (i + 1,
                                      struct GNUNET_MQ_MessageHandler);
    GNUNET_memcpy (sps->handlers,
                   handlers,
                   i * sizeof(struct GNUNET_MQ_MessageHandler));
  }
  return GNUNET_TESTING_command_new (sps,
                                     label,
                                     &start_peer_run,
                                     &start_peer_cleanup,
                                     &start_peer_traits,
                                     &sps->ac);
}