-fix (C) notices
[oweals/gnunet.git] / src / ats-tests / perf_ats.h
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2010-2013 GNUnet e.V.
4
5  GNUnet is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published
7  by the Free Software Foundation; either version 3, or (at your
8  option) any later version.
9
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  General Public License for more details.
14
15  You should have received a copy of the GNU General Public License
16  along with GNUnet; see the file COPYING.  If not, write to the
17  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  Boston, MA 02110-1301, USA.
19  */
20 /**
21  * @file ats/perf_ats.c
22  * @brief ats benchmark: start peers and modify preferences, monitor change over time
23  * @author Christian Grothoff
24  * @author Matthias Wachs
25  */
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet_testbed_service.h"
29 #include "gnunet_ats_service.h"
30 #include "gnunet_core_service.h"
31 #include "ats-testing.h"
32
33 #define TEST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
34 #define BENCHMARK_DURATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
35 #define LOGGING_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 500)
36 #define TESTNAME_PREFIX "perf_ats_"
37 #define DEFAULT_SLAVES_NUM 2
38 #define DEFAULT_MASTERS_NUM 1
39
40 #define TEST_ATS_PREFRENCE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
41 #define TEST_ATS_PREFRENCE_START 1.0
42 #define TEST_ATS_PREFRENCE_DELTA 1.0
43
44 #define TEST_MESSAGE_TYPE_PING 12345
45 #define TEST_MESSAGE_TYPE_PONG 12346
46 #define TEST_MESSAGE_SIZE 1000
47 #define TEST_MESSAGE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
48
49 /**
50  * Information about a benchmarking partner
51  */
52 struct BenchmarkPartner
53 {
54   /**
55    * The peer itself this partner belongs to
56    */
57   struct BenchmarkPeer *me;
58
59   /**
60    * The partner peer
61    */
62   struct BenchmarkPeer *dest;
63
64   /**
65    * Core transmit handles
66    */
67   struct GNUNET_CORE_TransmitHandle *cth;
68
69   /**
70    * Transport transmit handles
71    */
72   struct GNUNET_TRANSPORT_TransmitHandle *tth;
73
74   /**
75    * Timestamp to calculate communication layer delay
76    */
77   struct GNUNET_TIME_Absolute last_message_sent;
78
79   /**
80    * Accumulated RTT for all messages
81    */
82   unsigned int total_app_rtt;
83
84   /**
85    * Number of messages sent to this partner
86    */
87   unsigned int messages_sent;
88
89   /**
90    * Number of bytes sent to this partner
91    */
92   unsigned int bytes_sent;
93
94   /**
95    * Number of messages received from this partner
96    */
97   unsigned int messages_received;
98
99   /**
100    * Number of bytes received from this partner
101    */
102   unsigned int bytes_received;
103
104   /* Current ATS properties */
105
106   uint32_t ats_distance;
107
108   uint32_t ats_delay;
109
110   uint32_t bandwidth_in;
111
112   uint32_t bandwidth_out;
113
114   uint32_t ats_utilization_up;
115
116   uint32_t ats_utilization_down;
117
118   uint32_t ats_network_type;
119
120   uint32_t ats_cost_wan;
121
122   uint32_t ats_cost_lan;
123
124   uint32_t ats_cost_wlan;
125 };
126
127
128 /**
129  * Information we track for a peer in the testbed.
130  */
131 struct BenchmarkPeer
132 {
133   /**
134    * Handle with testbed.
135    */
136   struct GNUNET_TESTBED_Peer *peer;
137
138   /**
139    * Unique identifier
140    */
141   int no;
142
143   /**
144    * Is this peer a measter: GNUNET_YES/GNUNET_NO
145    */
146   int master;
147
148   /**
149    *  Peer ID
150    */
151   struct GNUNET_PeerIdentity id;
152
153   /**
154    * Testbed operation to get peer information
155    */
156   struct GNUNET_TESTBED_Operation *peer_id_op;
157
158   /**
159    * Testbed operation to connect to ATS performance service
160    */
161   struct GNUNET_TESTBED_Operation *ats_perf_op;
162
163   /**
164    * Testbed operation to connect to core
165    */
166   struct GNUNET_TESTBED_Operation *comm_op;
167
168   /**
169    * ATS performance handle
170    */
171   struct GNUNET_ATS_PerformanceHandle *ats_perf_handle;
172
173   /**
174    * Masters only:
175    * Testbed connect operations to connect masters to slaves
176    */
177   struct TestbedConnectOperation *core_connect_ops;
178
179   /**
180    *  Core handle
181    */
182   struct GNUNET_CORE_Handle *ch;
183
184   /**
185    *  Core handle
186    */
187   struct GNUNET_TRANSPORT_Handle *th;
188
189   /**
190    * Masters only:
191    * Peer to set ATS preferences for
192    */
193   struct BenchmarkPeer *pref_partner;
194
195   /**
196    * Masters only
197    * Progress task
198    */
199   struct GNUNET_SCHEDULER_Task * ats_task;
200
201   /**
202    * Masters only
203    * Progress task
204    */
205   double pref_value;
206
207   /**
208    * Array of partners with num_slaves entries (if master) or
209    * num_master entries (if slave)
210    */
211   struct BenchmarkPartner *partners;
212
213   /**
214    * Number of partners
215    */
216   int num_partners;
217
218   /**
219    * Number of core connections
220    */
221   int core_connections;
222
223   /**
224    * Masters only:
225    * Number of connections to slave peers
226    */
227   int core_slave_connections;
228
229   /**
230    * Total number of messages this peer has sent
231    */
232   unsigned int total_messages_sent;
233
234   /**
235    * Total number of bytes this peer has sent
236    */
237   unsigned int total_bytes_sent;
238
239   /**
240    * Total number of messages this peer has received
241    */
242   unsigned int total_messages_received;
243
244   /**
245    * Total number of bytes this peer has received
246    */
247   unsigned int total_bytes_received;
248 };
249
250
251 /* end of file perf_ats.h */