2 This file is part of GNUnet.
3 Copyright (C) 2010-2013, 2016, 2017 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
21 * @file ats-tests/ats-testing.c
22 * @brief ats testing library: setup topology
24 * @author Christian Grothoff
25 * @author Matthias Wachs
27 #include "ats-testing.h"
31 * Connect peers with testbed
33 struct TestbedConnectOperation
36 * The benchmarking master initiating this connection
38 struct BenchmarkPeer *master;
41 * The benchmarking slave to connect to
43 struct BenchmarkPeer *slave;
46 * Testbed operation to connect peers
48 struct GNUNET_TESTBED_Operation *connect_op;
51 struct GNUNET_CONFIGURATION_Handle *cfg;
53 struct GNUNET_ATS_TEST_Topology *top;
62 do_shutdown (void *cls)
67 struct BenchmarkPeer *p;
69 top->state.benchmarking = GNUNET_NO;
71 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
72 "Benchmarking done\n");
74 GNUNET_ATS_TEST_generate_traffic_stop_all ();
76 for (c_m = 0; c_m < top->num_masters; c_m++)
79 if (NULL != top->mps[c_m].peer_id_op)
81 GNUNET_TESTBED_operation_done (p->peer_id_op);
85 if (NULL != p->ats_task)
86 GNUNET_SCHEDULER_cancel (p->ats_task);
89 for (c_op = 0; c_op < p->num_partners; c_op++)
91 if ((NULL != p->core_connect_ops) &&
92 (NULL != p->core_connect_ops[c_op].connect_op))
94 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
95 "Failed to connect peer 0 and %u\n",
97 GNUNET_TESTBED_operation_done (p->core_connect_ops[c_op].connect_op);
98 p->core_connect_ops[c_op].connect_op = NULL;
102 if (NULL != p->ats_perf_op)
104 GNUNET_TESTBED_operation_done (p->ats_perf_op);
105 p->ats_perf_op = NULL;
108 if (NULL != p->comm_op)
110 GNUNET_TESTBED_operation_done (p->comm_op);
113 GNUNET_free_non_null (p->core_connect_ops);
114 GNUNET_free (p->partners);
118 for (c_s = 0; c_s < top->num_slaves; c_s++)
121 if (NULL != p->peer_id_op)
123 GNUNET_TESTBED_operation_done (p->peer_id_op);
124 p->peer_id_op = NULL;
126 if (NULL != p->ats_perf_op)
128 GNUNET_TESTBED_operation_done (p->ats_perf_op);
129 p->ats_perf_op = NULL;
131 if (NULL != p->comm_op)
133 GNUNET_TESTBED_operation_done (p->comm_op);
136 GNUNET_free (p->partners);
139 GNUNET_SCHEDULER_shutdown ();
145 static struct BenchmarkPartner *
146 find_partner (struct BenchmarkPeer *me,
147 const struct GNUNET_PeerIdentity *peer)
151 for (c_m = 0; c_m < me->num_partners; c_m++)
153 /* Find a partner with other as destination */
154 if (0 == GNUNET_memcmp (peer,
155 &me->partners[c_m].dest->id))
157 return &me->partners[c_m];
165 static struct BenchmarkPeer *
166 find_peer (const struct GNUNET_PeerIdentity *peer)
170 for (c_p = 0; c_p < top->num_masters; c_p++)
172 if (0 == GNUNET_memcmp (&top->mps[c_p].id,
174 return &top->mps[c_p];
177 for (c_p = 0; c_p < top->num_slaves; c_p++)
179 if (0 == GNUNET_memcmp (&top->sps[c_p].id,
181 return &top->sps[c_p];
188 * Method called whenever a given peer connects.
191 * @param peer peer identity this notification is about
192 * @param mq queue to use to send messages to @a peer
193 * @return the `struct BenchmarkPartner` of @a peer
196 comm_connect_cb (void *cls,
197 const struct GNUNET_PeerIdentity *peer,
198 struct GNUNET_MQ_Handle *mq)
200 struct BenchmarkPeer *me = cls;
201 struct BenchmarkPeer *remote;
202 struct BenchmarkPartner *p;
207 remote = find_peer (peer);
210 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
211 "Unknown peer connected: `%s'\n",
217 id = GNUNET_strdup (GNUNET_i2s (&me->id));
218 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
219 "%s [%u] `%s' connected to %s [%u] %s\n",
220 (me->master == GNUNET_YES) ? "Master" : "Slave",
223 (remote->master == GNUNET_YES) ? "Master" : "Slave",
227 me->core_connections++;
228 if ((GNUNET_YES == me->master) &&
229 (GNUNET_NO == remote->master) &&
230 (GNUNET_NO == top->state.connected_CORE))
232 me->core_slave_connections++;
234 if (me->core_slave_connections == top->num_slaves)
236 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
237 "Master [%u] connected all slaves\n",
240 completed = GNUNET_YES;
241 for (c = 0; c < top->num_masters; c++)
243 if (top->mps[c].core_slave_connections != top->num_slaves)
244 completed = GNUNET_NO;
246 if (GNUNET_YES == completed)
248 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
249 "All master peers connected all slave peers\n");
250 top->state.connected_CORE = GNUNET_YES;
251 /* Notify about setup done */
252 if (NULL != top->done_cb)
253 top->done_cb (top->done_cb_cls,
259 p = find_partner (me,
268 * @param cls this peer
269 * @param peer id of disconnecting peer
270 * @param internal_cls the `struct BenchmarkPartner` of @a peer
273 comm_disconnect_cb (void *cls,
274 const struct GNUNET_PeerIdentity *peer,
277 struct BenchmarkPeer *me = cls;
278 struct BenchmarkPartner *p = internal_cls;
284 id = GNUNET_strdup (GNUNET_i2s (&me->id));
285 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
286 "%s disconnected from %s\n",
289 GNUNET_assert (me->core_connections > 0);
290 me->core_connections--;
292 if ((GNUNET_YES == top->state.benchmarking) &&
293 ((GNUNET_YES == me->master) ||
294 (GNUNET_YES == p->dest->master)))
296 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
297 "%s disconnected from %s while benchmarking\n",
306 handle_pong (void *cls,
307 const struct TestMessage *message)
309 struct BenchmarkPartner *p = cls;
311 GNUNET_ATS_TEST_traffic_handle_pong (p);
316 handle_ping (void *cls,
317 const struct TestMessage *message)
319 struct BenchmarkPartner *p = cls;
321 GNUNET_ATS_TEST_traffic_handle_ping (p);
326 transport_connect_adapter (void *cls,
327 const struct GNUNET_CONFIGURATION_Handle *cfg)
329 struct BenchmarkPeer *me = cls;
330 struct GNUNET_MQ_MessageHandler handlers[] = {
331 GNUNET_MQ_hd_fixed_size (ping,
332 TEST_MESSAGE_TYPE_PING,
335 GNUNET_MQ_hd_fixed_size (pong,
336 TEST_MESSAGE_TYPE_PONG,
339 GNUNET_MQ_handler_end ()
342 me->th = GNUNET_TRANSPORT_core_connect (cfg,
350 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
351 "Failed to create transport connection \n");
357 transport_disconnect_adapter (void *cls,
360 struct BenchmarkPeer *me = cls;
362 GNUNET_TRANSPORT_core_disconnect (me->th);
368 core_connect_adapter (void *cls,
369 const struct GNUNET_CONFIGURATION_Handle *cfg)
371 struct BenchmarkPeer *me = cls;
372 struct GNUNET_MQ_MessageHandler handlers[] = {
373 GNUNET_MQ_hd_fixed_size (ping,
374 TEST_MESSAGE_TYPE_PING,
377 GNUNET_MQ_hd_fixed_size (pong,
378 TEST_MESSAGE_TYPE_PONG,
381 GNUNET_MQ_handler_end ()
384 me->ch = GNUNET_CORE_connect (cfg,
391 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
392 "Failed to create core connection \n");
398 core_disconnect_adapter (void *cls,
401 struct BenchmarkPeer *me = cls;
403 GNUNET_CORE_disconnect (me->ch);
409 connect_completion_callback (void *cls,
410 struct GNUNET_TESTBED_Operation *op,
413 struct TestbedConnectOperation *cop = cls;
419 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
420 _ ("Connected master [%u] with slave [%u]\n"),
426 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
427 _ ("Failed to connect master peer [%u] with slave [%u]\n"),
428 cop->master->no, cop->slave->no);
430 GNUNET_SCHEDULER_shutdown ();
432 GNUNET_TESTBED_operation_done (op);
434 for (c = 0; c < top->num_slaves; c++)
436 if (cop == &cop->master->core_connect_ops[c])
437 cop->master->core_connect_ops[c].connect_op = NULL;
439 if (ops == top->num_masters * top->num_slaves)
441 top->state.connected_PEERS = GNUNET_YES;
447 do_connect_peers (void *cls)
451 struct BenchmarkPeer *p;
453 if ((top->state.connected_ATS_service == GNUNET_NO) ||
454 (top->state.connected_COMM_service == GNUNET_NO))
457 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
458 "Connecting peers on CORE level\n");
459 for (c_m = 0; c_m < top->num_masters; c_m++)
462 p->core_connect_ops = GNUNET_malloc (top->num_slaves
464 TestbedConnectOperation));
466 for (c_s = 0; c_s < top->num_slaves; c_s++)
468 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
469 "Connecting master [%u] with slave [%u]\n",
472 p->core_connect_ops[c_s].master = p;
473 p->core_connect_ops[c_s].slave = &top->sps[c_s];
474 p->core_connect_ops[c_s].connect_op
475 = GNUNET_TESTBED_overlay_connect (NULL,
476 &connect_completion_callback,
477 &p->core_connect_ops[c_s],
480 if (NULL == p->core_connect_ops[c_s].connect_op)
482 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
483 "Could not connect master [%u] and slave [%u]\n",
487 GNUNET_SCHEDULER_shutdown ();
496 comm_connect_completion_cb (void *cls,
497 struct GNUNET_TESTBED_Operation *op,
501 static int comm_done = 0;
503 if ((NULL != emsg) || (NULL == ca_result))
505 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
506 "Initialization failed, shutdown\n");
508 GNUNET_SCHEDULER_shutdown ();
513 if (comm_done == top->num_slaves + top->num_masters)
515 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
516 "Connected to all %s services\n",
517 (GNUNET_YES == top->test_core) ? "CORE" : "TRANSPORT");
518 top->state.connected_COMM_service = GNUNET_YES;
519 GNUNET_SCHEDULER_add_now (&do_connect_peers,
526 do_comm_connect (void *cls)
531 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
532 "Connecting to all %s services\n",
533 (GNUNET_YES == top->test_core) ? "CORE" : "TRANSPORT");
534 for (c_m = 0; c_m < top->num_masters; c_m++)
536 if (GNUNET_YES == top->test_core)
537 top->mps[c_m].comm_op
538 = GNUNET_TESTBED_service_connect (NULL,
541 &comm_connect_completion_cb,
543 &core_connect_adapter,
544 &core_disconnect_adapter,
548 top->mps[c_m].comm_op
549 = GNUNET_TESTBED_service_connect (NULL,
552 &comm_connect_completion_cb,
554 &transport_connect_adapter,
555 &transport_disconnect_adapter,
560 for (c_s = 0; c_s < top->num_slaves; c_s++)
562 if (GNUNET_YES == top->test_core)
563 top->sps[c_s].comm_op
564 = GNUNET_TESTBED_service_connect (NULL,
567 &comm_connect_completion_cb,
569 &core_connect_adapter,
570 &core_disconnect_adapter,
574 top->sps[c_s].comm_op
575 = GNUNET_TESTBED_service_connect (NULL,
578 &comm_connect_completion_cb,
580 &transport_connect_adapter,
581 &transport_disconnect_adapter,
589 ats_performance_info_cb (void *cls,
590 const struct GNUNET_HELLO_Address *address,
592 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
593 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
594 const struct GNUNET_ATS_Properties *ats_prop)
596 struct BenchmarkPeer *me = cls;
597 struct BenchmarkPartner *p;
603 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
604 "Peer %u: ATS Service disconnected!\n",
609 p = find_partner (me,
613 /* This is not one of my partners
614 * Will happen since the peers will connect to each other due to gossiping
618 peer_id = GNUNET_strdup (GNUNET_i2s (&me->id));
621 if ((p->bandwidth_in != ntohl (bandwidth_in.value__)) ||
622 (p->bandwidth_out != ntohl (bandwidth_out.value__)))
624 p->bandwidth_in = ntohl (bandwidth_in.value__);
625 p->bandwidth_out = ntohl (bandwidth_out.value__);
627 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
628 "%s [%u] received ATS information: %s\n",
629 (GNUNET_YES == p->me->master) ? "Master" : "Slave",
631 GNUNET_i2s (&p->dest->id));
633 p->props.utilization_out = ats_prop->utilization_out;
634 p->props.utilization_in = ats_prop->utilization_in;
635 p->props.scope = ats_prop->scope;
636 p->props.delay = ats_prop->delay;
637 p->props.distance = ats_prop->distance;
639 if (GNUNET_YES == log)
640 top->ats_perf_cb (cls, address,
645 GNUNET_free (peer_id);
650 ats_perf_connect_adapter (void *cls,
651 const struct GNUNET_CONFIGURATION_Handle *cfg)
653 struct BenchmarkPeer *me = cls;
656 = GNUNET_ATS_performance_init (cfg,
657 &ats_performance_info_cb,
659 if (NULL == me->ats_perf_handle)
660 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
661 "Failed to create ATS performance handle \n");
662 return me->ats_perf_handle;
667 ats_perf_disconnect_adapter (void *cls,
670 struct BenchmarkPeer *me = cls;
672 GNUNET_ATS_performance_done (me->ats_perf_handle);
673 me->ats_perf_handle = NULL;
678 ats_connect_completion_cb (void *cls,
679 struct GNUNET_TESTBED_Operation *op,
683 static int op_done = 0;
685 if ((NULL != emsg) || (NULL == ca_result))
687 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
688 "Initialization failed, shutdown\n");
690 GNUNET_SCHEDULER_shutdown ();
694 if (op_done == (top->num_masters + top->num_slaves))
696 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
697 "Connected to all ATS services\n");
698 top->state.connected_ATS_service = GNUNET_YES;
699 GNUNET_SCHEDULER_add_now (&do_comm_connect,
706 do_connect_ats (void *cls)
711 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
712 "Connecting to all ATS services\n");
713 for (c_m = 0; c_m < top->num_masters; c_m++)
715 top->mps[c_m].ats_perf_op
716 = GNUNET_TESTBED_service_connect (NULL,
719 &ats_connect_completion_cb,
721 &ats_perf_connect_adapter,
722 &ats_perf_disconnect_adapter,
726 for (c_s = 0; c_s < top->num_slaves; c_s++)
728 top->sps[c_s].ats_perf_op
729 = GNUNET_TESTBED_service_connect (NULL,
732 &ats_connect_completion_cb,
734 &ats_perf_connect_adapter,
735 &ats_perf_disconnect_adapter,
743 peerinformation_cb (void *cb_cls,
744 struct GNUNET_TESTBED_Operation *op,
745 const struct GNUNET_TESTBED_PeerInformation *pinfo,
748 struct BenchmarkPeer *p = cb_cls;
751 GNUNET_assert (pinfo->pit == GNUNET_TESTBED_PIT_IDENTITY);
753 p->id = *pinfo->result.id;
754 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
755 "%s [%u] has peer id `%s'\n",
756 (p->master == GNUNET_YES) ? "Master" : "Slave",
758 GNUNET_i2s (&p->id));
760 GNUNET_TESTBED_operation_done (op);
761 p->peer_id_op = NULL;
764 if (done == top->num_slaves + top->num_masters)
766 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
767 "Retrieved all peer ID, connect to ATS\n");
768 GNUNET_SCHEDULER_add_now (&do_connect_ats,
775 * Signature of a main function for a testcase.
778 * @param h testbed handle
779 * @param num_peers number of peers in 'peers'
780 * @param peers_ handle to peers run in the testbed
781 * @param links_succeeded the number of overlay link connection attempts that
783 * @param links_failed the number of overlay link connection attempts that
788 struct GNUNET_TESTBED_RunHandle *h,
789 unsigned int num_peers,
790 struct GNUNET_TESTBED_Peer **peers_,
791 unsigned int links_succeeded,
792 unsigned int links_failed)
797 GNUNET_assert (NULL == cls);
798 GNUNET_assert (top->num_masters + top->num_slaves == num_peers);
799 GNUNET_assert (NULL != peers_);
801 GNUNET_SCHEDULER_add_shutdown (&do_shutdown,
804 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
805 "Setting up %u masters and %u slaves\n",
809 /* Setup master peers */
810 for (c_m = 0; c_m < top->num_masters; c_m++)
812 GNUNET_assert (NULL != peers_[c_m]);
813 top->mps[c_m].peer = peers_[c_m];
814 top->mps[c_m].no = c_m;
815 top->mps[c_m].master = GNUNET_YES;
816 top->mps[c_m].pref_partner = &top->sps[c_m];
817 top->mps[c_m].pref_value = TEST_ATS_PREFERENCE_DEFAULT;
818 top->mps[c_m].partners =
819 GNUNET_malloc (top->num_slaves * sizeof(struct BenchmarkPartner));
820 top->mps[c_m].num_partners = top->num_slaves;
821 /* Initialize partners */
822 for (c_s = 0; c_s < top->num_slaves; c_s++)
824 top->mps[c_m].partners[c_s].me = &top->mps[c_m];
825 top->mps[c_m].partners[c_s].dest = &top->sps[c_s];
827 /* Get configuration */
828 top->mps[c_m].peer_id_op
829 = GNUNET_TESTBED_peer_get_information (top->mps[c_m].peer,
830 GNUNET_TESTBED_PIT_IDENTITY,
835 /* Setup slave peers */
836 for (c_s = 0; c_s < top->num_slaves; c_s++)
838 GNUNET_assert (NULL != peers_[c_s + top->num_masters]);
839 top->sps[c_s].peer = peers_[c_s + top->num_masters];
840 top->sps[c_s].no = c_s + top->num_masters;
841 top->sps[c_s].master = GNUNET_NO;
842 top->sps[c_s].partners =
843 GNUNET_new_array (top->num_masters,
844 struct BenchmarkPartner);
845 top->sps[c_s].num_partners = top->num_masters;
846 /* Initialize partners */
847 for (c_m = 0; c_m < top->num_masters; c_m++)
849 top->sps[c_s].partners[c_m].me = &top->sps[c_s];
850 top->sps[c_s].partners[c_m].dest = &top->mps[c_m];
852 /* Initialize properties */
853 top->sps[c_s].partners[c_m].props.delay = GNUNET_TIME_UNIT_ZERO;
854 top->sps[c_s].partners[c_m].props.distance = 0;
855 top->sps[c_s].partners[c_m].props.scope = GNUNET_NT_UNSPECIFIED;
856 top->sps[c_s].partners[c_m].props.utilization_in = 0;
857 top->sps[c_s].partners[c_m].props.utilization_out = 0;
859 /* Get configuration */
860 top->sps[c_s].peer_id_op
861 = GNUNET_TESTBED_peer_get_information (top->sps[c_s].peer,
862 GNUNET_TESTBED_PIT_IDENTITY,
870 * Controller event callback
873 * @param event the controller event
876 controller_event_cb (void *cls,
877 const struct GNUNET_TESTBED_EventInformation *event)
881 case GNUNET_TESTBED_ET_CONNECT:
884 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
889 GNUNET_SCHEDULER_shutdown ();
894 struct BenchmarkPeer *
895 GNUNET_ATS_TEST_get_peer (int src)
897 if (src > top->num_masters)
899 return &top->mps[src];
903 struct BenchmarkPartner *
904 GNUNET_ATS_TEST_get_partner (int src,
907 if (src > top->num_masters)
909 if (dest > top->num_slaves)
911 return &top->mps[src].partners[dest];
916 * Create a topology for ats testing
918 * @param name test name
919 * @param cfg_file configuration file to use for the peers
920 * @param num_slaves number of slaves
921 * @param num_masters number of masters
922 * @param test_core connect to CORE service (GNUNET_YES) or transport (GNUNET_NO)
923 * @param done_cb function to call when topology is setup
924 * @param done_cb_cls cls for callback
925 * @param log_request_cb callback to call when logging is required
928 GNUNET_ATS_TEST_create_topology (char *name, char *cfg_file,
929 unsigned int num_slaves,
930 unsigned int num_masters,
932 GNUNET_ATS_TEST_TopologySetupDoneCallback
935 GNUNET_ATS_AddressInformationCallback
938 top = GNUNET_new (struct GNUNET_ATS_TEST_Topology);
939 top->num_masters = num_masters;
940 top->num_slaves = num_slaves;
941 top->done_cb = done_cb;
942 top->done_cb_cls = done_cb_cls;
943 top->test_core = test_core;
944 top->ats_perf_cb = log_request_cb;
945 top->mps = GNUNET_new_array (num_masters,
946 struct BenchmarkPeer);
947 top->sps = GNUNET_new_array (num_slaves,
948 struct BenchmarkPeer);
953 event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
954 event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
955 (void) GNUNET_TESTBED_test_run (name,
957 num_slaves + num_masters,
959 &controller_event_cb, NULL,
968 GNUNET_ATS_TEST_shutdown_topology (void)
972 GNUNET_SCHEDULER_shutdown ();
976 /* end of file ats-testing.c */