testing_api_topology.h File Reference

#include "gnunet_util_lib.h"
#include "gnunet_testing_lib.h"

Include dependency graph for testing_api_topology.h:

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

Go to the source code of this file.

Data Structures
struct	GNUNET_TESTING_NetjailRouter
	API for writing an interpreter to test GNUnet components. More...
struct	GNUNET_TESTING_AddressPrefix
	Protocol address prefix für a connection between nodes. More...
struct	GNUNET_TESTING_NodeConnection
	Connection to another node. More...
struct	GNUNET_TESTING_NetjailNode
	Node in the netjail topology. More...
struct	GNUNET_TESTING_NetjailNamespace
	Subnet in a topology. More...
struct	GNUNET_TESTING_NetjailBackbonePeer
	Backbone peer. More...
struct	GNUNET_TESTING_NetjailCarrierPeer
	Backbone peer. More...
struct	GNUNET_TESTING_NetjailCarrier
	Carrier. More...
struct	GNUNET_TESTING_NetjailSubnet
	Carrier subnet. More...
struct	GNUNET_TESTING_NetjailSubnetPeer
	Subnet peer. More...
struct	GNUNET_TESTING_NetjailTopology
	Topology of our netjail setup. More...

Macros
#define	GNUNET_TESTING_SIMPLE_NETJAIL_TRAITS(op, prefix)
	Call op on all simple traits.

Enumerations
enum	GNUNET_TESTING_NodeType { GNUNET_TESTING_SUBNET_NODE , GNUNET_TESTING_GLOBAL_NODE }
	Enum for the different types of nodes. More...

Functions
struct GNUNET_TESTING_NetjailTopology *	GNUNET_TESTING_get_topo_from_string_ (const char *data)
	Parse the topology data.
unsigned int	GNUNET_TESTING_get_additional_connects (unsigned int num, struct GNUNET_TESTING_NetjailTopology *topology)
	Get the number of unintentional additional connections the node waits for.
struct GNUNET_TESTING_NetjailNode *	GNUNET_TESTING_get_node (unsigned int num, struct GNUNET_TESTING_NetjailTopology *topology)
	Get a node from the topology.
struct GNUNET_TESTING_NodeConnection *	GNUNET_TESTING_get_connections (unsigned int num, const struct GNUNET_TESTING_NetjailTopology *topology)
	Get the connections to other nodes for a specific node.
char *	GNUNET_TESTING_get_address (struct GNUNET_TESTING_NodeConnection *connection, const char *prefix)
	Get the address for a specific communicator from a connection.
const char *	GNUNET_TESTING_get_plugin_from_topo (struct GNUNET_TESTING_NetjailTopology *njt, const char *my_node_id)
	Get the global plugin name form the topology file.
void	GNUNET_TESTING_free_topology (struct GNUNET_TESTING_NetjailTopology *topology)
	Deallocate memory of the struct GNUNET_TESTING_NetjailTopology.
unsigned int	GNUNET_TESTING_calculate_num (struct GNUNET_TESTING_NodeConnection *node_connection, struct GNUNET_TESTING_NetjailTopology *topology)
	Calculate the unique id identifying a node from a given connection.
	GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT (GNUNET_TESTING, topology, const struct GNUNET_TESTING_NetjailTopology) GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT(GNUNET_TESTING
const char	GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT (GNUNET_TESTING, async_context, struct GNUNET_TESTING_AsyncContext) GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT(GNUNET_TESTING

Variables
	topology_string
const char	helper_handles

Macro Definition Documentation

GNUNET_TESTING_SIMPLE_NETJAIL_TRAITS

#define GNUNET_TESTING_SIMPLE_NETJAIL_TRAITS	(		op,
			prefix
	)

Value:

        op (prefix, topology, const struct GNUNET_TESTING_NetjailTopology)            \
        op (prefix, topology_string, const char)                                          \
        op (prefix, async_context, struct GNUNET_TESTING_AsyncContext)                    \
        op (prefix, helper_handles, const struct GNUNET_HELPER_Handle *)

Call op on all simple traits.

Definition at line 488 of file testing_api_topology.h.

Enumeration Type Documentation

GNUNET_TESTING_NodeType

enum GNUNET_TESTING_NodeType

Enum for the different types of nodes.

Enumerator
GNUNET_TESTING_SUBNET_NODE	Node in a subnet.
GNUNET_TESTING_GLOBAL_NODE	Global known node.

Definition at line 54 of file testing_api_topology.h.

{
  GNUNET_TESTING_SUBNET_NODE,
 
  GNUNET_TESTING_GLOBAL_NODE
};

Function Documentation

GNUNET_TESTING_get_topo_from_string_()

struct GNUNET_TESTING_NetjailTopology * GNUNET_TESTING_get_topo_from_string_

(

const char *

data

)

Parse the topology data.

Parameters

data	The topology data.

Returns

The GNUNET_TESTING_NetjailTopology

Definition at line 586 of file testing_api_topology.c.

{
  struct GNUNET_CONFIGURATION_Handle *cfg;
  struct GNUNET_HashCode hc = {0};
  struct GNUNET_TESTING_NetjailTopology *topology = GNUNET_new (struct
                                                                GNUNET_TESTING_NetjailTopology);
 
  topology->backbone_peers
    = GNUNET_CONTAINER_multishortmap_create (1,
                                             GNUNET_NO);
  topology->carriers
    = GNUNET_CONTAINER_multishortmap_create (1,
                                             GNUNET_NO);
  cfg = GNUNET_CONFIGURATION_create (GNUNET_OS_project_data_gnunet ());
  GNUNET_assert (NULL != topology->carriers);
 
  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_deserialize (cfg,
                                        input,
                                        strlen (input),
                                        NULL))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _ ("Failed to parse configuration.\n"));
    GNUNET_CONFIGURATION_destroy (cfg);
    return NULL;
  }
  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_number (cfg,
                                             "DEFAULTS",
                                             "SUBNETS",
                                             &topology->default_subnets))
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Missing default SUBNETS!\n");
    return NULL;
  }
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg,
                                                          "DEFAULTS",
                                                          "TESTBED_PLUGIN",
                                                          &topology->plugin))
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Missing default TESTBED_PLUGIN!\n");
    return NULL;
  }
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg,
                                                          "DEFAULTS",
                                                          "CARRIER_PEERS",
                                                          &(topology->
                                                            default_carrier_peers)))
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Missing default CARRIER_PEERS!\n");
    return NULL;
  }
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg,
                                                          "DEFAULTS",
                                                          "SUBNET_PEERS",
                                                          &(topology->
                                                            default_subnet_peers)))
  {
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Missing default SUBNET_PEERS!\n");
    return NULL;
  }
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg,
                                                          "BACKBONE",
                                                          "CARRIERS",
                                                          &(topology->
                                                            num_carriers)))
  {
    LOG (GNUNET_ERROR_TYPE_INFO,
         "No carrier configured!\n");
    return NULL;
  }
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg,
                                                          "BACKBONE",
                                                          "BACKBONE_PEERS",
                                                          &(topology->
                                                            num_backbone_peers))
      )
  {
    LOG (GNUNET_ERROR_TYPE_INFO,
         "No backbone peers configured!\n");
    return NULL;
  }
  for (int i = 0; i < topology->num_backbone_peers; i++)
  {
    struct GNUNET_TESTING_NetjailBackbonePeer *peer = GNUNET_new (struct
                                                                  GNUNET_TESTING_NetjailBackbonePeer);
    struct GNUNET_ShortHashCode hkey;
 
    topology->total++;
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Backbone peers -> Number of nodes: %u\n",
         topology->total);
    peer->number = topology->total;
    GNUNET_CRYPTO_hash (&topology->total, sizeof(topology->total), &hc);
    memcpy (&hkey,
            &hc,
            sizeof (hkey));
    GNUNET_CONTAINER_multishortmap_put (topology->backbone_peers,
                                        &hkey,
                                        peer,
                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
  }
  GNUNET_assert (NULL != topology->carriers);
  for (int i = 0; i < topology->num_carriers; i++)
  {
    struct GNUNET_TESTING_NetjailCarrier *carrier = GNUNET_new (struct
                                                                GNUNET_TESTING_NetjailCarrier);
    struct GNUNET_ShortHashCode hkey;
    char *section;
 
    topology->total++;
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Carrier -> Number of nodes: %u\n",
         topology->total);
    carrier->number = topology->total;
    GNUNET_CRYPTO_hash (&topology->total, sizeof(topology->total), &hc);
    memcpy (&hkey,
            &hc,
            sizeof (hkey));
    GNUNET_assert (NULL != topology->carriers);
    GNUNET_CONTAINER_multishortmap_put (topology->carriers,
                                        &hkey,
                                        carrier,
                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
    GNUNET_asprintf (&section, "CARRIER-%u", i);
    if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg,
                                                            section,
                                                            "SUBNETS",
                                                            (unsigned long
                                                             long *) &carrier->
                                                            number_subnets))
    {
      carrier->number_subnets = topology->default_subnets;
      LOG (GNUNET_ERROR_TYPE_DEBUG,
           "Carrier -> Default number of subnets: %u\n",
           carrier->number_subnets);
    }
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Carrier -> number of subnets: %u\n",
         carrier->number_subnets);
    if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg,
                                                            section,
                                                            "CARRIER_PEERS",
                                                            (unsigned long
                                                             long *) &carrier->
                                                            number_peers))
    {
      carrier->number_peers = topology->default_carrier_peers;
      LOG (GNUNET_ERROR_TYPE_DEBUG,
           "Carrier -> Default number of peers: %u\n",
           carrier->number_peers);
    }
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Carrier -> Default number of peers: %u\n",
         carrier->number_peers);
    create_peers  (cfg, topology, carrier);
    create_subnets (cfg, topology, carrier);
 
    GNUNET_free (section);
  }
 
  GNUNET_free (cfg);
 
  return topology;
}

References _, GNUNET_TESTING_NetjailTopology::backbone_peers, GNUNET_TESTING_NetjailTopology::carriers, cfg, create_peers(), create_subnets(), GNUNET_TESTING_NetjailTopology::default_carrier_peers, GNUNET_TESTING_NetjailTopology::default_subnets, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONFIGURATION_create(), GNUNET_CONFIGURATION_deserialize(), GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE, GNUNET_CONTAINER_multishortmap_create(), GNUNET_CONTAINER_multishortmap_put(), GNUNET_CRYPTO_hash(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_log, GNUNET_new, GNUNET_NO, GNUNET_OK, GNUNET_OS_project_data_gnunet(), LOG, GNUNET_TESTING_NetjailTopology::num_backbone_peers, GNUNET_TESTING_NetjailTopology::num_carriers, GNUNET_TESTING_NetjailBackbonePeer::number, GNUNET_TESTING_NetjailCarrier::number, GNUNET_TESTING_NetjailCarrier::number_peers, GNUNET_TESTING_NetjailCarrier::number_subnets, GNUNET_TESTING_NetjailTopology::plugin, and GNUNET_TESTING_NetjailTopology::total.

Referenced by handle_helper_init(), netjail_exec_run(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_get_additional_connects()

unsigned int GNUNET_TESTING_get_additional_connects	(	unsigned int	num,
		struct GNUNET_TESTING_NetjailTopology *	topology
	)

Get the number of unintentional additional connections the node waits for.

Parameters

num	The specific node we want the additional connects for.

Returns

The number of additional connects

Definition at line 438 of file testing_api_topology.c.

{
  struct GNUNET_TESTING_NetjailNode *node;
  struct GNUNET_TESTING_NetjailNamespace *namespace;
  struct GNUNET_TESTING_NodeConnection *node_connections;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "get_additional_connects\n");
 
  get_node_info (num, topology, &node, &namespace, &node_connections);
 
  if (NULL == node)
  {
    LOG (GNUNET_ERROR_TYPE_WARNING,
         "No info found for node %d\n", num);
    return 0;
  }
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "node additional_connects for node %p\n",
       node);
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "node additional_connects: %u\n",
       node->additional_connects);
 
  return node->additional_connects;
}

References GNUNET_TESTING_NetjailNode::additional_connects, get_node_info(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, and LOG.

Referenced by GNUNET_CORE_cmd_connect_peers(), and GNUNET_TRANSPORT_cmd_connect_peers().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_get_node()

struct GNUNET_TESTING_NetjailNode * GNUNET_TESTING_get_node	(	unsigned int	num,
		struct GNUNET_TESTING_NetjailTopology *	topology
	)

Get a node from the topology.

Parameters

num	The specific node we want the connections for.
topology	The topology we get the connections from.

Returns

The connections of the node.

Definition at line 241 of file testing_api_topology.c.

{
  struct GNUNET_TESTING_NetjailNode *node;
  struct GNUNET_TESTING_NetjailNamespace *namespace;
  struct GNUNET_TESTING_NodeConnection *node_connections;
 
  get_node_info (num, topology, &node, &namespace, &node_connections);
 
  return node;
 
}

References get_node_info(), and GNUNET_TESTING_NodeConnection::node.

Here is the call graph for this function:

GNUNET_TESTING_get_connections()

struct GNUNET_TESTING_NodeConnection * GNUNET_TESTING_get_connections	(	unsigned int	num,
		const struct GNUNET_TESTING_NetjailTopology *	topology
	)

Get the connections to other nodes for a specific node.

Parameters

num	The specific node we want the connections for.
topology	The topology we get the connections from.

Returns

The connections of the node.

Definition at line 263 of file testing_api_topology.c.

{
  struct GNUNET_TESTING_NetjailNode *node;
  struct GNUNET_TESTING_NetjailNamespace *namespace;
  struct GNUNET_TESTING_NodeConnection *node_connections;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "get_connections\n");
 
  get_node_info (num, topology, &node, &namespace, &node_connections);
 
  return node_connections;
}

References get_node_info(), GNUNET_ERROR_TYPE_DEBUG, LOG, and GNUNET_TESTING_NodeConnection::node.

Referenced by backchannel_check_run(), connect_peers_run(), connect_peers_run(), and connect_peers_run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_get_address()

char * GNUNET_TESTING_get_address	(	struct GNUNET_TESTING_NodeConnection *	connection,
		const char *	prefix
	)

Get the address for a specific communicator from a connection.

Parameters

connection	The connection we like to have the address from.
prefix	The communicator protocol prefix.

Returns

The address of the communicator.

Definition at line 378 of file testing_api_topology.c.

{
  struct GNUNET_TESTING_NetjailNode *node;
  char *addr;
  const char *template;
  unsigned int node_n;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "get address prefix: %s node_n: %u\n",
       prefix,
       connection->node_n);
 
  node = connection->node;
  if (connection->namespace_n == node->namespace_n)
  {
    template = CONNECT_ADDRESS_TEMPLATE;
    node_n = connection->node_n;
  }
  else if (0 == connection->namespace_n)
  {
    template = KNOWN_CONNECT_ADDRESS_TEMPLATE;
    node_n = connection->node_n;
  }
  else if (1 == connection->node_n)
  {
    template = ROUTER_CONNECT_ADDRESS_TEMPLATE;
    node_n = connection->namespace_n;
  }
  else
  {
    return NULL;
  }
 
  if (0 == strcmp (PREFIX_TCP, prefix) ||
      0 == strcmp (PREFIX_UDP, prefix) ||
      0 == strcmp (PREFIX_UDP_NATTED, prefix) ||
      0 == strcmp (PREFIX_TCP_NATTED, prefix))
  {
    GNUNET_asprintf (&addr,
                     template,
                     prefix,
                     node_n);
  }
  else
  {
    GNUNET_assert (0);
  }
 
  return addr;
}

References CONNECT_ADDRESS_TEMPLATE, GNUNET_asprintf(), GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, KNOWN_CONNECT_ADDRESS_TEMPLATE, LOG, GNUNET_TESTING_NodeConnection::namespace_n, GNUNET_TESTING_NetjailNode::namespace_n, GNUNET_TESTING_NodeConnection::node, GNUNET_TESTING_NodeConnection::node_n, GNUNET_TESTING_NetjailNode::node_n, prefix, PREFIX_TCP, PREFIX_TCP_NATTED, PREFIX_UDP, PREFIX_UDP_NATTED, and ROUTER_CONNECT_ADDRESS_TEMPLATE.

Referenced by connect_peers_run(), connect_peers_run(), and connect_peers_run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_get_plugin_from_topo()

const char * GNUNET_TESTING_get_plugin_from_topo	(	struct GNUNET_TESTING_NetjailTopology *	njt,
		const char *	my_node_id
	)

Get the global plugin name form the topology file.

Parameters

njt	the netjail topology.
my_node_id	the node ID.

Returns

the name of the plugin to use.

Definition at line 469 of file testing_api_topology.c.

{
  return njt->plugin;
}

References njt, and GNUNET_TESTING_NetjailTopology::plugin.

Referenced by handle_helper_init().

Here is the caller graph for this function:

GNUNET_TESTING_free_topology()

void GNUNET_TESTING_free_topology

(

struct GNUNET_TESTING_NetjailTopology *

topology

)

Deallocate memory of the struct GNUNET_TESTING_NetjailTopology.

Parameters

[in]	topology	The GNUNET_TESTING_NetjailTopology to be deallocated.
	topology	The GNUNET_TESTING_NetjailTopology to be deallocated.

Definition at line 338 of file testing_api_topology.c.

{
  GNUNET_CONTAINER_multishortmap_iterate (topology->backbone_peers,
                                          &free_value_cb,
                                          NULL);
  GNUNET_CONTAINER_multishortmap_iterate (topology->carriers,
                                          &free_carriers_cb,
                                          NULL);
  GNUNET_free (topology->plugin);
  GNUNET_free (topology);
}

References GNUNET_TESTING_NetjailTopology::backbone_peers, GNUNET_TESTING_NetjailTopology::carriers, free_carriers_cb(), free_value_cb(), GNUNET_CONTAINER_multishortmap_iterate(), GNUNET_free, and GNUNET_TESTING_NetjailTopology::plugin.

Referenced by cleanup(), do_shutdown_later(), handle_result(), handle_result(), handle_result(), handle_result(), handle_result(), handle_result(), handle_result(), handle_result(), and netjail_exec_run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_calculate_num()

unsigned int GNUNET_TESTING_calculate_num	(	struct GNUNET_TESTING_NodeConnection *	node_connection,
		struct GNUNET_TESTING_NetjailTopology *	topology
	)

Calculate the unique id identifying a node from a given connection.

Parameters

node_connection	The connection we calculate the id from.
topology	The topology we get all needed information from.

Returns

The unique id of the node from the connection.

Definition at line 352 of file testing_api_topology.c.

{
  unsigned int n, m, num;
 
  n = node_connection->namespace_n;
  m = node_connection->node_n;
 
  if (0 == n)
    num = m;
  else
    num = (n - 1) * topology->nodes_m + m + topology->nodes_x;
 
  return num;
}

References m, GNUNET_TESTING_NodeConnection::namespace_n, GNUNET_TESTING_NodeConnection::node_n, GNUNET_TESTING_NetjailTopology::nodes_m, and GNUNET_TESTING_NetjailTopology::nodes_x.

Referenced by connect_peers_run(), connect_peers_run(), connect_peers_run(), and notify_connect().

Here is the caller graph for this function:

GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT() [1/2]

GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT	(	GNUNET_TESTING	,
		topology	,
		const struct GNUNET_TESTING_NetjailTopology
	)

GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT() [2/2]

const char GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT	(	GNUNET_TESTING	,
		async_context	,
		struct GNUNET_TESTING_AsyncContext
	)

Variable Documentation

topology_string

topology_string

Definition at line 495 of file testing_api_topology.h.

Referenced by GNUNET_TESTING_cmd_load_topology_from_string().

helper_handles

const char helper_handles

Definition at line 495 of file testing_api_topology.h.