1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/*
This file is part of GNUnet
Copyright (C) 2008--2013 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
*/
/**
* @file testbed/testbed_api_topology.h
* @brief header for intra library exported functions
* @author Sree Harsha Totakura <sreeharsha@totakura.in>
*/
#ifndef TESTBED_API_TOPOLOGY_H
#define TESTBED_API_TOPOLOGY_H
/**
* Returns the number of links that are required to generate a 2d torus for the
* given number of peers. Also returns the arrangment (number of rows and the
* length of each row)
*
* @param num_peers number of peers
* @param rows number of rows in the 2d torus. Can be NULL.
* @param rows_len the length of each row. This array will be allocated
* fresh. The caller should free it. Can be NULL.
*/
unsigned int
GNUNET_TESTBED_2dtorus_calc_links (unsigned int num_peers, unsigned int *rows,
unsigned int **rows_len);
/**
* Get a topology from a string input.
*
* @param topology where to write the retrieved topology
* @param topology_string The string to attempt to
* get a configuration value from
* @return GNUNET_YES if topology string matched a
* known topology, GNUNET_NO if not
*/
int
GNUNET_TESTBED_topology_get_ (enum GNUNET_TESTBED_TopologyOption *topology,
const char *topology_string);
/**
* Returns the string corresponding to the given topology
*
* @param topology the topology
* @return the string (freshly allocated) of given topology; NULL if topology cannot be
* expressed as a string
*/
char *
GNUNET_TESTBED_topology_to_str_ (enum GNUNET_TESTBED_TopologyOption topology);
/**
* Functions of this type are called to process underlay link
*
* @param cls closure
* @param A offset of first peer
* @param B offset of second peer
* @param bandwidth the bandwidth of the link in bytes per second
* @param latency the latency of link in milliseconds
* @param loss the percentage of messages dropped on the link
* @return GNUNET_OK to continue processing; GNUNET_SYSERR to abort
*/
typedef int (*underlay_link_processor) (void *cls,
unsigned int A,
unsigned int B,
unsigned int bandwidth,
unsigned int latency,
unsigned int loss);
/**
* Function to construct an underlay topology
*
* @param num_peers the number of peers for which the topology should be
* generated
* @param proc the underlay link processor callback. Will be called for each
* underlay link generated unless a previous call to this callback
* returned GNUNET_SYSERR. Cannot be NULL.
* @param cls closure for proc
* @param ... variable arguments denoting the topology and its parameters. They
* should start with the type of topology to generate followed by their
* options. These arguments should *always* end with
* GNUNET_TESTBED_TOPOLOGY_OPTION_END option
* @return GNUNET_OK if underlay link generation is successful; GNUNET_SYSERR
* upon error in generating the underlay or if any calls to the
* underlay link processor returned GNUNET_SYSERR
*/
int
GNUNET_TESTBED_underlay_construct_ (int num_peers,
underlay_link_processor proc,
void *cls,
...);
#endif
/* end of testbed_api_topology.h */
|
