testing_api_topology.h

Go to the documentation of this file.

/*
      This file is part of GNUnet
      Copyright (C) 2021 GNUnet e.V.
 
      GNUnet is free software: you can redistribute it and/or modify it
      under the terms of the GNU Affero General Public License as published
      by the Free Software Foundation, either version 3 of the License,
      or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      Affero General Public License for more details.
 
      You should have received a copy of the GNU Affero General Public License
      along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef NETJAIL_H
#define NETJAIL_H
 
#include "gnunet_util_lib.h"
#include "gnunet_testing_lib.h"
 
 
struct GNUNET_TESTING_NetjailRouter
{
  unsigned int tcp_port;
 
  unsigned int udp_port;
};
 
 
enum GNUNET_TESTING_NodeType
{
  GNUNET_TESTING_SUBNET_NODE,
 
  GNUNET_TESTING_GLOBAL_NODE
};
 
struct GNUNET_TESTING_AddressPrefix
{
  struct GNUNET_TESTING_AddressPrefix *prev;
 
  struct GNUNET_TESTING_AddressPrefix *next;
 
  char *address_prefix;
};
 
 
struct GNUNET_TESTING_NetjailNode;
 
struct GNUNET_TESTING_NodeConnection
{
  struct GNUNET_TESTING_NodeConnection *prev;
 
  struct GNUNET_TESTING_NodeConnection *next;
 
  unsigned int namespace_n;
 
  unsigned int node_n;
 
  enum GNUNET_TESTING_NodeType node_type;
 
  struct GNUNET_TESTING_NetjailNode *node;
 
  struct GNUNET_TESTING_AddressPrefix *address_prefixes_head;
 
  struct GNUNET_TESTING_AddressPrefix *address_prefixes_tail;
};
 
struct GNUNET_TESTING_NetjailNode
{
  struct GNUNET_TESTING_NodeConnection *node_connections_head;
 
  struct GNUNET_TESTING_NodeConnection *node_connections_tail;
 
  char *plugin;
 
  unsigned int is_global;
 
  unsigned int namespace_n;
 
  unsigned int node_n;
 
  unsigned int node_number;
 
  unsigned int additional_connects;
 
  unsigned int expected_reaches;
};
 
struct GNUNET_TESTING_NetjailNamespace
{
  unsigned int namespace_n;
 
  struct GNUNET_TESTING_NetjailRouter *router;
 
  struct GNUNET_CONTAINER_MultiShortmap *nodes;
};
 
struct GNUNET_TESTING_NetjailBackbonePeer
{
  unsigned int number;
};
 
struct GNUNET_TESTING_NetjailCarrierPeer
{
  unsigned int number;
};
 
struct GNUNET_TESTING_NetjailCarrier
{
  unsigned int number;
 
  unsigned int index;
 
  unsigned int number_peers;
 
  unsigned int number_subnets;
 
  struct GNUNET_CONTAINER_MultiShortmap *subnets;
 
  struct GNUNET_CONTAINER_MultiShortmap *peers;
};
 
struct GNUNET_TESTING_NetjailSubnet
{
  unsigned int number;
 
  unsigned int index;
 
  unsigned int number_peers;
 
  struct GNUNET_CONTAINER_MultiShortmap *peers;
};
 
struct GNUNET_TESTING_NetjailSubnetPeer
{
  unsigned int number;
};
 
struct GNUNET_TESTING_NetjailTopology
{
 
  unsigned long long default_subnets;
 
  unsigned long long default_carrier_peers;
 
  unsigned long long default_subnet_peers;
  char *plugin;
 
  unsigned long long num_backbone_peers;
 
  unsigned long long num_carriers;
 
  struct GNUNET_CONTAINER_MultiShortmap *carriers;
 
  struct GNUNET_CONTAINER_MultiShortmap *backbone_peers;
 
  unsigned int total;
 
  unsigned int namespaces_n;
 
  unsigned int nodes_m;
 
  unsigned int nodes_x;
 
  struct GNUNET_CONTAINER_MultiShortmap *map_namespaces;
 
  struct GNUNET_CONTAINER_MultiShortmap *map_globals;
 
  unsigned int additional_connects;
};
 
 
struct GNUNET_TESTING_NetjailTopology *
GNUNET_TESTING_get_topo_from_string_ (const char *data);
 
 
unsigned int
GNUNET_TESTING_get_additional_connects (
  unsigned int num,
  struct GNUNET_TESTING_NetjailTopology *topology);
 
 
struct GNUNET_TESTING_NetjailNode *
GNUNET_TESTING_get_node (unsigned int num,
                         struct GNUNET_TESTING_NetjailTopology *topology);
 
 
struct GNUNET_TESTING_NodeConnection *
GNUNET_TESTING_get_connections (
  unsigned int num,
  const struct GNUNET_TESTING_NetjailTopology *topology);
 
 
char *
GNUNET_TESTING_get_address (
  struct GNUNET_TESTING_NodeConnection *connection,
  const char *prefix);
 
 
char *
GNUNET_TESTING_get_plugin_from_topo (
  struct GNUNET_TESTING_NetjailTopology *njt,
  const char *my_node_id);
 
 
void
GNUNET_TESTING_free_topology (struct GNUNET_TESTING_NetjailTopology *topology);
 
 
unsigned int
GNUNET_TESTING_calculate_num (
  struct GNUNET_TESTING_NodeConnection *node_connection,
  struct GNUNET_TESTING_NetjailTopology *topology);
 
 
#define GNUNET_TESTING_SIMPLE_NETJAIL_TRAITS(op, prefix)                            \
        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 *)
 
GNUNET_TESTING_SIMPLE_NETJAIL_TRAITS (GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT,
                                      GNUNET_TESTING)
 
 
#endif