transport-testing-communicator.h File Reference

functions and structures related to testing-tng More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_transport_communication_service.h"
#include "transport.h"

Include dependency graph for transport-testing-communicator.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle
	Handle to a transport communicator. More...

Typedefs
typedef struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *(*	GNUNET_TRANSPORT_TESTING_BackchannelCallback) (void *cls, struct GNUNET_MessageHeader *msg, struct GNUNET_PeerIdentity *pid)
	Function signature for callbacks that are called when new backchannel message arrived. More...
typedef void(*	GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, enum GNUNET_TRANSPORT_CommunicatorCharacteristics cc, char *address_prefix)
	Function signature for callbacks that are called when new communicators become available. More...
typedef void(*	GNUNET_TRANSPORT_TESTING_AddAddressCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const char *address, struct GNUNET_TIME_Relative expiration, uint32_t aid, enum GNUNET_NetworkType nt)
	Receive information about the address of a communicator. More...
typedef void(*	GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, int will_try)
	Get informed about the success of a queue request. More...
typedef void(*	GNUNET_TRANSPORT_TESTING_AddQueueCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *tc_queue, size_t mtu)
	Handle opening of queue. More...
typedef void(*	GNUNET_TRANSPORT_TESTING_IncomingMessageCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const char *payload, size_t payload_len)
	Handle an incoming message. More...

Functions
struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *	GNUNET_TRANSPORT_TESTING_transport_communicator_service_start (const char *service_name, const char *binary_name, const char *cfg_filename, const struct GNUNET_PeerIdentity *peer_id, GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback communicator_available_cb, GNUNET_TRANSPORT_TESTING_AddAddressCallback add_address_cb, GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback queue_create_reply_cb, GNUNET_TRANSPORT_TESTING_AddQueueCallback add_queue_cb, GNUNET_TRANSPORT_TESTING_IncomingMessageCallback incoming_message_cb, GNUNET_TRANSPORT_TESTING_BackchannelCallback bc_cb, void *cb_cls)
	Start communicator part of transport service and communicator. More...
void	GNUNET_TRANSPORT_TESTING_transport_communicator_service_stop (struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h)
void	GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue (struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const struct GNUNET_PeerIdentity *peer_id, const char *address)
	Instruct communicator to open a queue. More...
void	GNUNET_TRANSPORT_TESTING_transport_communicator_send (struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, GNUNET_SCHEDULER_TaskCallback cont, void *cont_cls, const void *payload, size_t payload_size)
	Instruct communicator to send data. More...

Detailed Description

functions and structures related to testing-tng

Author

Christian Grothoff

Julius Bünger

Definition in file transport-testing-communicator.h.

Typedef Documentation

GNUNET_TRANSPORT_TESTING_BackchannelCallback

typedef struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *(* GNUNET_TRANSPORT_TESTING_BackchannelCallback) (void *cls, struct GNUNET_MessageHeader *msg, struct GNUNET_PeerIdentity *pid)

Function signature for callbacks that are called when new backchannel message arrived.

Parameters

cls	Closure
msg	Backchannel message
pid	Target peer

Definition at line 1 of file transport-testing-communicator.h.

GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback

typedef void(* GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, enum GNUNET_TRANSPORT_CommunicatorCharacteristics cc, char *address_prefix)

Function signature for callbacks that are called when new communicators become available.

Parameters

cls	Closure
tc_h	Communicator handle
cc	Characteristics of communicator
address_prefix	Prefix of the address

Definition at line 66 of file transport-testing-communicator.h.

GNUNET_TRANSPORT_TESTING_AddAddressCallback

typedef void(* GNUNET_TRANSPORT_TESTING_AddAddressCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const char *address, struct GNUNET_TIME_Relative expiration, uint32_t aid, enum GNUNET_NetworkType nt)

Receive information about the address of a communicator.

Parameters

cls	Closure
tc_h	Communicator handle
address	Address represented as string
expiration	Expiration
aid	Aid
nt	Network Type

Definition at line 87 of file transport-testing-communicator.h.

GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback

typedef void(* GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, int will_try)

Get informed about the success of a queue request.

Parameters

cls	Closure
tc_h	Communicator handle
will_try	GNUNET_YES if communicator will try to create queue

Definition at line 106 of file transport-testing-communicator.h.

GNUNET_TRANSPORT_TESTING_AddQueueCallback

typedef void(* GNUNET_TRANSPORT_TESTING_AddQueueCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *tc_queue, size_t mtu)

Handle opening of queue.

Parameters

cls	Closure
tc_h	Communicator handle
tc_queue	Handle to newly opened queue

Definition at line 121 of file transport-testing-communicator.h.

GNUNET_TRANSPORT_TESTING_IncomingMessageCallback

typedef void(* GNUNET_TRANSPORT_TESTING_IncomingMessageCallback) (void *cls, struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h, const char *payload, size_t payload_len)

Handle an incoming message.

Parameters

cls	Closure
tc_h	Handle to the receiving communicator
msg	Received message

Definition at line 139 of file transport-testing-communicator.h.

Function Documentation

GNUNET_TRANSPORT_TESTING_transport_communicator_service_start()

struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle * GNUNET_TRANSPORT_TESTING_transport_communicator_service_start	(	const char *	service_name,
		const char *	binary_name,
		const char *	cfg_filename,
		const struct GNUNET_PeerIdentity *	peer_id,
		GNUNET_TRANSPORT_TESTING_CommunicatorAvailableCallback	communicator_available_cb,
		GNUNET_TRANSPORT_TESTING_AddAddressCallback	add_address_cb,
		GNUNET_TRANSPORT_TESTING_QueueCreateReplyCallback	queue_create_reply_cb,
		GNUNET_TRANSPORT_TESTING_AddQueueCallback	add_queue_cb,
		GNUNET_TRANSPORT_TESTING_IncomingMessageCallback	incoming_message_cb,
		GNUNET_TRANSPORT_TESTING_BackchannelCallback	bc_cb,
		void *	cb_cls
	)

Start communicator part of transport service and communicator.

Parameters

service_name	Name of the service
cfg	Configuration handle
communicator_available	Callback that is called when a new communicator becomes available
add_address_cb	Callback handling new addresses
queue_create_reply_cb	Callback handling success of queue requests
add_queue_cb	Callback handling freshly created queues
incoming_message_cb	Callback handling incoming messages
cb_cls	Closure to communicator_available

Returns

Handle to the communicator duo

Parameters

service_name	Name of the service
cfg	Configuration handle
communicator_available_cb	Callback that is called when a new
add_address_cb	Callback that is called when a new communicator becomes available
cb_cls	Closure to communicator_available_cb and

Returns

Handle to the communicator duo

Definition at line 1031 of file transport-testing-communicator.c.

{
  struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Starting new transport/communicator combo with config %s\n",
       cfg_filename);
  tc_h =
    GNUNET_new (struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle);
  tc_h->cfg_filename = GNUNET_strdup (cfg_filename);
  tc_h->cfg = GNUNET_CONFIGURATION_create ();
  if ((GNUNET_SYSERR == GNUNET_CONFIGURATION_load (tc_h->cfg, cfg_filename)))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _ ("Malformed configuration file `%s', exit ...\n"),
                cfg_filename);
    GNUNET_free (tc_h->cfg_filename);
    GNUNET_CONFIGURATION_destroy (tc_h->cfg);
    GNUNET_free (tc_h);
    return NULL;
  }
  tc_h->bc_enabled = GNUNET_CONFIGURATION_get_value_yesno (tc_h->cfg,
                                                           "communicator-test",
                                                           "BACKCHANNEL_ENABLED");
  tc_h->communicator_available_cb = communicator_available_cb;
  tc_h->add_address_cb = add_address_cb;
  tc_h->queue_create_reply_cb = queue_create_reply_cb;
  tc_h->add_queue_cb = add_queue_cb;
  tc_h->incoming_msg_cb = incoming_message_cb;
  tc_h->bc_cb = bc_cb;
  tc_h->peer_id = *peer_id;
  tc_h->cb_cls = cb_cls;
 
  /* Start communicator part of service */
  transport_communicator_start (tc_h);
  /* Start NAT */
  nat_start (tc_h);
  /* Start resolver service */
  resolver_start (tc_h);
  /* Start peerstore service */
  peerstore_start (tc_h);
  /* Start statistic service */
  statistics_start (tc_h);
  /* Schedule start communicator */
  communicator_start (tc_h,
                      binary_name);
  return tc_h;
}

References _, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::add_address_cb, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::add_queue_cb, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::bc_cb, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::bc_enabled, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::cb_cls, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::cfg, cfg_filename, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::cfg_filename, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::communicator_available_cb, communicator_start(), GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_CONFIGURATION_load(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log, GNUNET_new, GNUNET_strdup, GNUNET_SYSERR, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::incoming_msg_cb, LOG, nat_start(), peer_id, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::peer_id, peerstore_start(), GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::queue_create_reply_cb, resolver_start(), statistics_start(), and transport_communicator_start().

Here is the call graph for this function:

GNUNET_TRANSPORT_TESTING_transport_communicator_service_stop()

void GNUNET_TRANSPORT_TESTING_transport_communicator_service_stop

(

struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *

tc_h

)

Definition at line 1094 of file transport-testing-communicator.c.

{
  struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *queue;
  shutdown_communicator (tc_h->c_proc);
  shutdown_service (tc_h->sh);
  shutdown_nat (tc_h->nat_proc);
  shutdown_resolver (tc_h->resolver_proc);
  shutdown_peerstore (tc_h->ps_proc);
  shutdown_statistics (tc_h->stat_proc);
  GNUNET_CONFIGURATION_destroy (tc_h->cfg);
  while (NULL != (queue = tc_h->queue_head))
  {
    GNUNET_CONTAINER_DLL_remove (tc_h->queue_head, tc_h->queue_tail, queue);
    GNUNET_free (queue);
  }
  GNUNET_free (tc_h->c_address);
  GNUNET_free (tc_h->cfg_filename);
  GNUNET_free (tc_h->c_addr_prefix);
  GNUNET_free (tc_h);
}

References GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::c_addr_prefix, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::c_address, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::c_proc, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::cfg, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::cfg_filename, GNUNET_CONFIGURATION_destroy(), GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::nat_proc, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::ps_proc, queue(), GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::queue_head, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::queue_tail, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::resolver_proc, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::sh, shutdown_communicator(), shutdown_nat(), shutdown_peerstore(), shutdown_resolver(), shutdown_service(), shutdown_statistics(), GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::stat_proc, and GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::tc_h.

Here is the call graph for this function:

GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue()

void GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue	(	struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *	tc_h,
		const struct GNUNET_PeerIdentity *	peer_id,
		const char *	address
	)

Instruct communicator to open a queue.

Parameters

tc_h	Handle to communicator which shall open queue
peer_id	Towards which peer
address	For which address

Definition at line 1125 of file transport-testing-communicator.c.

{
  struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *tc_queue;
  static uint32_t idgen;
  char *prefix;
  struct GNUNET_TRANSPORT_CreateQueue *msg;
  struct GNUNET_MQ_Envelope *env;
  size_t alen;
 
  tc_queue =
    GNUNET_new (struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue);
  tc_queue->tc_h = tc_h;
  prefix = GNUNET_HELLO_address_to_prefix (address);
  if (NULL == prefix)
  {
    GNUNET_break (0);  /* We got an invalid address!? */
    GNUNET_free (tc_queue);
    return;
  }
  GNUNET_free (prefix);
  alen = strlen (address) + 1;
  env =
    GNUNET_MQ_msg_extra (msg, alen, GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_CREATE);
  msg->request_id = htonl (idgen++);
  tc_queue->qid = msg->request_id;
  msg->receiver = *peer_id;
  tc_queue->peer_id = *peer_id;
  memcpy (&msg[1], address, alen);
  if (NULL != tc_h->c_mq)
  {
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Sending queue create immediately\n");
    GNUNET_MQ_send (tc_h->c_mq, env);
  }
  else
  {
    tc_queue->open_queue_env = env;
  }
  GNUNET_CONTAINER_DLL_insert (tc_h->queue_head, tc_h->queue_tail, tc_queue);
}

References address, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::c_mq, env, GNUNET_break, GNUNET_CONTAINER_DLL_insert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_HELLO_address_to_prefix(), GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_CREATE, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_new, LOG, msg, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::open_queue_env, peer_id, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::peer_id, prefix, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::qid, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::queue_head, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::queue_tail, and GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::tc_h.

Here is the call graph for this function:

GNUNET_TRANSPORT_TESTING_transport_communicator_send()

void GNUNET_TRANSPORT_TESTING_transport_communicator_send	(	struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *	tc_h,
		GNUNET_SCHEDULER_TaskCallback	cont,
		void *	cont_cls,
		const void *	payload,
		size_t	payload_size
	)

Instruct communicator to send data.

Parameters

tc_queue	The queue to use for sending
cont	function to call when done sending
cont_cls	closure for cont
payload	Data to send
payload_size	Size of the payload

Definition at line 1171 of file transport-testing-communicator.c.

{
  struct GNUNET_MessageHeader *mh;
  struct GNUNET_TRANSPORT_SendMessageTo *msg;
  struct GNUNET_MQ_Envelope *env;
  size_t inbox_size;
  struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *tc_queue;
  struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *tc_queue_tmp;
  static struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue *last_queue;
  tc_queue = NULL;
 
  for (tc_queue_tmp = tc_h->queue_head;
       NULL != tc_queue_tmp;
       tc_queue_tmp = tc_queue_tmp->next)
  {
    if (tc_queue_tmp->q_len <= 0)
      continue;
    if (NULL == tc_queue)
    {
      LOG (GNUNET_ERROR_TYPE_DEBUG,
           "Selecting queue with prio %u, len %" PRIu64 " and MTU %u\n",
           tc_queue_tmp->priority,
           tc_queue_tmp->q_len,
           tc_queue_tmp->mtu);
      tc_queue = tc_queue_tmp;
      continue;
    }
    if (tc_queue->priority < tc_queue_tmp->priority)
    {
      LOG (GNUNET_ERROR_TYPE_DEBUG,
           "Selecting queue with prio %u, len %" PRIu64 " and MTU %u\n",
           tc_queue_tmp->priority,
           tc_queue_tmp->q_len,
           tc_queue_tmp->mtu);
      tc_queue = tc_queue_tmp;
    }
  }
  if (last_queue != tc_queue)
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Selected sending queue changed to %u with length %lu and MTU %u\n",
                ntohl (tc_queue->qid), (unsigned long) tc_queue->q_len, tc_queue->mtu);
  GNUNET_assert (NULL != tc_queue);
  last_queue = tc_queue;
  // Uncomment this for alternative 1 of backchannel functionality
  if (tc_queue->q_len != GNUNET_TRANSPORT_QUEUE_LENGTH_UNLIMITED)
    tc_queue->q_len--;
  // Until here for alternative 1
  static int msg_count = 0;
  msg_count++;
  if (msg_count % 100 == 0)
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Sending %u-th (%lu-th for queue) message on queue %u\n",
                msg_count, (unsigned long) tc_queue->mid, ntohl (tc_queue->qid));
  inbox_size = sizeof (struct GNUNET_MessageHeader) + payload_size;
  env = GNUNET_MQ_msg_extra (msg,
                             inbox_size,
                             GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_MSG);
  GNUNET_assert (NULL != env);
  msg->qid = tc_queue->qid;
  msg->mid = tc_queue->mid++;
  msg->receiver = tc_queue->peer_id;
  mh = (struct GNUNET_MessageHeader *) &msg[1];
  mh->size = htons (inbox_size);
  mh->type = GNUNET_MESSAGE_TYPE_DUMMY;
  memcpy (&mh[1],
          payload,
          payload_size);
  if (NULL != cont)
    GNUNET_MQ_notify_sent (env,
                           cont,
                           cont_cls);
  GNUNET_MQ_send (tc_queue->tc_h->c_mq,
                  env);
}

References GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::c_mq, env, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_MESSAGE_TYPE_DUMMY, GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_MSG, GNUNET_MQ_msg_extra, GNUNET_MQ_notify_sent(), GNUNET_MQ_send(), GNUNET_TRANSPORT_QUEUE_LENGTH_UNLIMITED, LOG, mh, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::mid, msg, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::mtu, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::next, payload, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::peer_id, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::priority, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::q_len, GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::qid, GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle::queue_head, and GNUNET_TRANSPORT_TESTING_TransportCommunicatorQueue::tc_h.

Here is the call graph for this function: