2 This file is part of GNUnet.
3 Copyright (C) 2010-2013 GNUnet e.V.
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.
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.
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.
21 * @file ats-tests/ats-testing.h
22 * @brief ats testing library: setup topology and provide logging to test ats
23 * @author Christian Grothoff
24 * @author Matthias Wachs
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 "gnunet_transport_core_service.h"
33 #define TEST_ATS_PREFERENCE_DEFAULT 1.0
36 * Message type sent for traffic generation
38 #define TEST_MESSAGE_TYPE_PING 12345
41 * Message type sent as response during traffic generation
43 #define TEST_MESSAGE_TYPE_PONG 12346
46 * Size of test messages
48 #define TEST_MESSAGE_SIZE 100
53 struct GNUNET_MessageHeader header;
55 uint8_t padding[TEST_MESSAGE_SIZE - sizeof (struct GNUNET_MessageHeader)];
59 struct BenchmarkPartner;
63 struct GNUNET_ATS_TEST_Topology;
65 struct TrafficGenerator;
71 GNUNET_ATS_TEST_TG_LINEAR,
72 GNUNET_ATS_TEST_TG_CONSTANT,
73 GNUNET_ATS_TEST_TG_RANDOM,
74 GNUNET_ATS_TEST_TG_SINUS
79 * Callback to call when topology setup is completed
81 * @param cls the closure
82 * @param masters array of master peers
83 * @param slaves array of master peers
86 (*GNUNET_ATS_TEST_TopologySetupDoneCallback) (void *cls,
87 struct BenchmarkPeer *masters,
88 struct BenchmarkPeer *slaves);
91 * Callback called when logging is required for the data contained
93 * @param cls the closure
94 * @param address an address
95 * @param address_active is address active
96 * @param bandwidth_out bandwidth outbound
97 * @param bandwidth_in bandwidth inbound
98 * @param prop performance information
101 (*GNUNET_ATS_TEST_LogRequest) (void *cls,
102 const struct GNUNET_HELLO_Address *address,
104 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
105 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
106 const struct GNUNET_ATS_Properties *prop);
109 * Information we track for a peer in the testbed.
114 * Handle with testbed.
116 struct GNUNET_TESTBED_Peer *peer;
124 * Is this peer a measter: GNUNET_YES/GNUNET_NO
131 struct GNUNET_PeerIdentity id;
134 * Testbed operation to get peer information
136 struct GNUNET_TESTBED_Operation *peer_id_op;
139 * Testbed operation to connect to ATS performance service
141 struct GNUNET_TESTBED_Operation *ats_perf_op;
144 * Testbed operation to connect to core
146 struct GNUNET_TESTBED_Operation *comm_op;
149 * ATS performance handle
151 struct GNUNET_ATS_PerformanceHandle *ats_perf_handle;
155 * Testbed connect operations to connect masters to slaves
157 struct TestbedConnectOperation *core_connect_ops;
162 struct GNUNET_CORE_Handle *ch;
167 struct GNUNET_TRANSPORT_CoreHandle *th;
171 * Peer to set ATS preferences for
173 struct BenchmarkPeer *pref_partner;
179 struct GNUNET_SCHEDULER_Task * ats_task;
188 * Array of partners with num_slaves entries (if master) or
189 * num_master entries (if slave)
191 struct BenchmarkPartner *partners;
199 * Number of core connections
201 int core_connections;
205 * Number of connections to slave peers
207 int core_slave_connections;
210 * Total number of messages this peer has sent
212 unsigned int total_messages_sent;
215 * Total number of bytes this peer has sent
217 unsigned int total_bytes_sent;
220 * Total number of messages this peer has received
222 unsigned int total_messages_received;
225 * Total number of bytes this peer has received
227 unsigned int total_bytes_received;
230 struct TrafficGenerator
232 struct TrafficGenerator *prev;
233 struct TrafficGenerator *next;
235 enum GeneratorType type;
237 struct BenchmarkPeer *src;
238 struct BenchmarkPartner *dest;
242 struct GNUNET_TIME_Relative duration_period;
244 struct GNUNET_SCHEDULER_Task * send_task;
245 struct GNUNET_TIME_Absolute next_ping_transmission;
246 struct GNUNET_TIME_Absolute time_start;
250 struct PreferenceGenerator
252 struct PreferenceGenerator *prev;
253 struct PreferenceGenerator *next;
255 enum GeneratorType type;
257 struct BenchmarkPeer *src;
258 struct BenchmarkPartner *dest;
260 enum GNUNET_ATS_PreferenceKind kind;
264 struct GNUNET_TIME_Relative duration_period;
265 struct GNUNET_TIME_Relative frequency;
267 struct GNUNET_SCHEDULER_Task * set_task;
268 struct GNUNET_TIME_Absolute next_ping_transmission;
269 struct GNUNET_TIME_Absolute time_start;
273 * Information about a benchmarking partner
275 struct BenchmarkPartner
278 * The peer itself this partner belongs to
280 struct BenchmarkPeer *me;
285 struct BenchmarkPeer *dest;
288 * Core transmit handles
290 struct GNUNET_CORE_TransmitHandle *cth;
293 * Message queue handle.
295 struct GNUNET_MQ_Handle *mq;
298 * Handle for traffic generator
300 struct TrafficGenerator *tg;
303 * Handle for preference generator
305 struct PreferenceGenerator *pg;
308 * Timestamp to calculate communication layer delay
310 struct GNUNET_TIME_Absolute last_message_sent;
313 * Accumulated RTT for all messages
315 unsigned int total_app_rtt;
318 * Number of messages sent to this partner
320 unsigned int messages_sent;
323 * Number of bytes sent to this partner
325 unsigned int bytes_sent;
328 * Number of messages received from this partner
330 unsigned int messages_received;
333 * Number of bytes received from this partner
335 unsigned int bytes_received;
338 * Current ATS properties
340 struct GNUNET_ATS_Properties props;
343 * Bandwidth assigned inbound
345 uint32_t bandwidth_in;
348 * Bandwidth assigned outbound
350 uint32_t bandwidth_out;
353 * Current preference values for bandwidth
355 double pref_bandwidth;
358 * Current preference values for delay
366 * Overall state of the performance benchmark
368 struct BenchmarkState
371 * Are we connected to ATS service of all peers: GNUNET_YES/NO
373 int connected_ATS_service;
376 * Are we connected to CORE service of all peers: GNUNET_YES/NO
378 int connected_COMM_service;
381 * Are we connected to all peers: GNUNET_YES/NO
386 * Are we connected to all slave peers on CORE level: GNUNET_YES/NO
391 * Are we connected to CORE service of all peers: GNUNET_YES/NO
397 struct GNUNET_ATS_TEST_Topology
402 struct GNUNET_SCHEDULER_Task *progress_task;
410 * Test core (#GNUNET_YES) or transport (#GNUNET_NO)
430 * ATS preference value
435 * Number master peers
437 unsigned int num_masters;
440 * Array of master peers
442 struct BenchmarkPeer *mps;
447 unsigned int num_slaves;
450 * Array of slave peers
452 struct BenchmarkPeer *sps;
457 struct GNUNET_TIME_Relative perf_duration;
462 struct GNUNET_TIME_Relative log_frequency;
467 struct BenchmarkState state;
469 GNUNET_ATS_TEST_TopologySetupDoneCallback done_cb;
471 GNUNET_ATS_AddressInformationCallback ats_perf_cb;
489 (*GNUNET_ATS_TESTING_EpisodeDoneCallback) (struct Episode *e);
492 (*GNUNET_ATS_TESTING_ExperimentDoneCallback) (struct Experiment *e,
493 struct GNUNET_TIME_Relative duration,
497 * An operation in an experiment
499 struct GNUNET_ATS_TEST_Operation
501 struct GNUNET_ATS_TEST_Operation *next;
502 struct GNUNET_ATS_TEST_Operation *prev;
504 long long unsigned int src_id;
505 long long unsigned int dest_id;
507 long long unsigned int base_rate;
508 long long unsigned int max_rate;
509 struct GNUNET_TIME_Relative period;
510 struct GNUNET_TIME_Relative frequency;
512 enum OperationType type;
513 enum GeneratorType gen_type;
514 enum GNUNET_ATS_PreferenceKind pref_type;
520 struct Episode *next;
521 struct GNUNET_TIME_Relative duration;
523 struct GNUNET_ATS_TEST_Operation *head;
524 struct GNUNET_ATS_TEST_Operation *tail;
532 unsigned long long int num_masters;
533 unsigned long long int num_slaves;
534 struct GNUNET_TIME_Relative log_freq;
535 struct GNUNET_TIME_Relative max_duration;
536 struct GNUNET_TIME_Relative total_duration;
537 struct GNUNET_TIME_Absolute start_time;
538 unsigned int num_episodes;
539 struct Episode *start;
541 struct GNUNET_SCHEDULER_Task * experiment_timeout_task;
542 struct GNUNET_SCHEDULER_Task * episode_timeout_task;
545 GNUNET_ATS_TESTING_EpisodeDoneCallback ep_done_cb;
546 GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb;
550 extern struct GNUNET_CONFIGURATION_Handle *cfg;
553 * Execute the specified experiment
555 * @param e the Experiment
556 * @param ep_done_cb a episode is completed
557 * @param e_done_cb the experiment is completed
560 GNUNET_ATS_TEST_experimentation_run (struct Experiment *e,
561 GNUNET_ATS_TESTING_EpisodeDoneCallback ep_done_cb,
562 GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb);
566 * Load an experiment from a file
568 * @param filename the file
569 * @return the Experiment or NULL on failure
572 GNUNET_ATS_TEST_experimentation_load (const char *filename);
578 * @param e the experiment
581 GNUNET_ATS_TEST_experimentation_stop (struct Experiment *e);
585 GNUNET_ATS_TEST_traffic_handle_ping (struct BenchmarkPartner *p);
589 GNUNET_ATS_TEST_traffic_handle_pong (struct BenchmarkPartner *p);
593 * Generate between the source master and the partner and send traffic with a
596 * @param src traffic source
597 * @param dest traffic partner
598 * @param type type of traffic to generate
599 * @param base_rate traffic base rate to send data with
600 * @param max_rate traffic maximum rate to send data with
601 * @param period duration of a period of traffic generation (~ 1/frequency)
602 * @param duration how long to generate traffic
603 * @return the traffic generator
605 struct TrafficGenerator *
606 GNUNET_ATS_TEST_generate_traffic_start (struct BenchmarkPeer *src,
607 struct BenchmarkPartner *dest,
608 enum GeneratorType type,
609 unsigned int base_rate,
610 unsigned int max_rate,
611 struct GNUNET_TIME_Relative period,
612 struct GNUNET_TIME_Relative duration);
616 GNUNET_ATS_TEST_generate_traffic_stop (struct TrafficGenerator *tg);
620 * Stop all traffic generators
623 GNUNET_ATS_TEST_generate_traffic_stop_all (void);
627 * Generate between the source master and the partner and set preferences with a
628 * value depending on the generator.
631 * @param dest partner
632 * @param type type of preferences to generate
633 * @param base_value traffic base rate to send data with
634 * @param value_rate traffic maximum rate to send data with
635 * @param period duration of a period of preferences generation (~ 1/frequency)
636 * @param frequency how long to generate preferences
637 * @param kind ATS preference to generate
638 * @return the traffic generator
640 struct PreferenceGenerator *
641 GNUNET_ATS_TEST_generate_preferences_start (struct BenchmarkPeer *src,
642 struct BenchmarkPartner *dest,
643 enum GeneratorType type,
644 unsigned int base_value,
645 unsigned int value_rate,
646 struct GNUNET_TIME_Relative period,
647 struct GNUNET_TIME_Relative frequency,
648 enum GNUNET_ATS_PreferenceKind kind);
652 GNUNET_ATS_TEST_generate_preferences_stop (struct PreferenceGenerator *pg);
656 GNUNET_ATS_TEST_generate_preferences_stop_all (void);
662 * @param log_frequency the logging frequency
663 * @param testname the testname
664 * @param masters the master peers used for benchmarking
665 * @param num_masters the number of master peers
666 * @param num_slaves the number of slave peers
667 * @param verbose verbose logging
668 * @return the logging handle or NULL on error
670 struct LoggingHandle *
671 GNUNET_ATS_TEST_logging_start (struct GNUNET_TIME_Relative log_frequency,
672 const char *testname,
673 struct BenchmarkPeer *masters,
682 * @param l the logging handle
685 GNUNET_ATS_TEST_logging_clean_up (struct LoggingHandle *l);
691 * @param l the logging handle
694 GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *l);
700 * @param l logging handle to use
703 GNUNET_ATS_TEST_logging_now (struct LoggingHandle *l);
707 * Write logging data to file
709 * @param l logging handle to use
710 * @param test_name name of the current test
711 * @param plots create gnuplots: #GNUNET_YES or #GNUNET_NO
714 GNUNET_ATS_TEST_logging_write_to_file (struct LoggingHandle *l,
715 const char *test_name,
720 * Topology related functions
722 struct BenchmarkPeer *
723 GNUNET_ATS_TEST_get_peer (int src);
726 struct BenchmarkPartner *
727 GNUNET_ATS_TEST_get_partner (int src, int dest);
731 * Create a topology for ats testing
733 * @param name test name
734 * @param cfg_file configuration file to use for the peers
735 * @param num_slaves number of slaves
736 * @param num_masters number of masters
737 * @param test_core connect to CORE service (#GNUNET_YES) or transport (#GNUNET_NO)
738 * @param done_cb function to call when topology is setup
739 * @param done_cb_cls cls for callback
740 * @param log_request_cb callback to call when logging is required
743 GNUNET_ATS_TEST_create_topology (char *name,
745 unsigned int num_slaves,
746 unsigned int num_masters,
748 GNUNET_ATS_TEST_TopologySetupDoneCallback done_cb,
750 GNUNET_ATS_TEST_LogRequest ats_perf_cb);
757 GNUNET_ATS_TEST_shutdown_topology (void);
760 /* end of file ats-testing.h */