2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
21 * @file mesh/test_mesh2_small.c
23 * @brief Test for the mesh service: retransmission of traffic.
27 #include "mesh_test_lib.h"
28 #include "gnunet_mesh2_service.h"
33 * How namy messages to send
35 #define TOTAL_PACKETS 1000
38 * How long until we give up on connecting the peers?
40 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
43 * Time to wait for stuff that should be rather fast
45 #define SHORT_TIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 20)
48 * DIFFERENT TESTS TO RUN
59 * Which test are we running?
64 * String with test name
69 * Flag to send traffic leaf->root in speed tests to test BCK_ACK logic.
71 static int test_backwards = GNUNET_NO;
74 * How many events have happened
79 * Each peer is supposed to generate the following callbacks:
80 * 1 incoming tunnel (@dest)
81 * 1 connected peer (@orig)
82 * 1 received data packet (@dest)
83 * 1 received data packet (@orig)
84 * 1 received tunnel destroy (@dest)
85 * _________________________________
86 * 5 x ok expected per peer
92 * Size of each test packet
94 size_t size_payload = sizeof (struct GNUNET_MessageHeader) + sizeof (uint32_t);
97 * Operation to get peer ids.
99 struct GNUNET_TESTBED_Operation *t_op[3];
104 struct GNUNET_PeerIdentity *p_id[3];
112 * Is the setup initialized?
114 static int initialized;
117 * Peers that have been connected
119 static int peers_in_tunnel;
122 * Peers that have responded
124 static int peers_responded;
127 * Number of payload packes sent
129 static int data_sent;
132 * Number of payload packets received
134 static int data_received;
137 * Number of payload packed explicitly (app level) acknowledged
142 * Total number of currently running peers.
144 static unsigned long long peers_running;
147 * Test context (to shut down).
149 struct GNUNET_MESH_TEST_Context *test_ctx;
152 * Task called to disconnect peers.
154 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
157 * Task To perform tests
159 static GNUNET_SCHEDULER_TaskIdentifier test_task;
162 * Task called to shutdown test.
164 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
167 * Mesh handle for the root peer
169 static struct GNUNET_MESH_Handle *h1;
172 * Mesh handle for the first leaf peer
174 static struct GNUNET_MESH_Handle *h2;
177 * Mesh handle for the second leaf peer
179 static struct GNUNET_MESH_Handle *h3;
182 * Tunnel handle for the root peer
184 static struct GNUNET_MESH_Tunnel *t;
187 * Tunnel handle for the first leaf peer
189 static struct GNUNET_MESH_Tunnel *incoming_t;
192 * Tunnel handle for the second leaf peer
194 static struct GNUNET_MESH_Tunnel *incoming_t2;
197 * Time we started the data transmission (after tunnel has been established
200 static struct GNUNET_TIME_Absolute start_time;
204 * Show the results of the test (banwidth acheived) and log them to GAUGER
209 static struct GNUNET_TIME_Absolute end_time;
210 static struct GNUNET_TIME_Relative total_time;
212 end_time = GNUNET_TIME_absolute_get();
213 total_time = GNUNET_TIME_absolute_get_difference(start_time, end_time);
214 FPRINTF (stderr, "\nResults of test \"%s\"\n", test_name);
215 FPRINTF (stderr, "Test time %llu ms\n",
216 (unsigned long long) total_time.rel_value);
217 FPRINTF (stderr, "Test bandwidth: %f kb/s\n",
218 4 * TOTAL_PACKETS * 1.0 / total_time.rel_value); // 4bytes * ms
219 FPRINTF (stderr, "Test throughput: %f packets/s\n\n",
220 TOTAL_PACKETS * 1000.0 / total_time.rel_value); // packets * ms
221 GAUGER ("MESH", test_name,
222 TOTAL_PACKETS * 1000.0 / total_time.rel_value,
228 * Shut down peergroup, clean up.
230 * @param cls Closure (unused).
231 * @param tc Task Context.
234 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
236 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending test.\n");
237 shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
242 * Disconnect from mesh services af all peers, call shutdown.
244 * @param cls Closure (unused).
245 * @param tc Task Context.
248 disconnect_mesh_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
250 long line = (long) cls;
253 for (i = 0; i < 3; i++)
256 GNUNET_TESTBED_operation_done (t_op[i]);
259 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
260 "disconnecting mesh service of peers, called from line %ld\n",
262 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
265 GNUNET_MESH_tunnel_destroy (t);
268 if (NULL != incoming_t)
270 GNUNET_MESH_tunnel_destroy (incoming_t);
273 if (NULL != incoming_t2)
275 GNUNET_MESH_tunnel_destroy (incoming_t2);
278 GNUNET_MESH_TEST_cleanup (test_ctx);
279 if (GNUNET_SCHEDULER_NO_TASK != shutdown_handle)
281 GNUNET_SCHEDULER_cancel (shutdown_handle);
283 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
288 * Abort test: schedule disconnect and shutdown immediately
290 * @param line Line in the code the abort is requested from (__LINE__).
293 abort_test (long line)
295 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
297 GNUNET_SCHEDULER_cancel (disconnect_task);
299 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
300 &disconnect_mesh_peers,
305 * Transmit ready callback.
307 * @param cls Closure (message type).
308 * @param size Size of the tranmist buffer.
309 * @param buf Pointer to the beginning of the buffer.
311 * @return Number of bytes written to buf.
314 tmt_rdy (void *cls, size_t size, void *buf);
318 * Task to schedule a new data transmission.
320 * @param cls Closure (peer #).
321 * @param tc Task Context.
324 data_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
326 struct GNUNET_MESH_TransmitHandle *th;
327 struct GNUNET_MESH_Tunnel *tunnel;
328 struct GNUNET_PeerIdentity *destination;
330 if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
333 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Data task\n");
334 if (GNUNET_YES == test_backwards)
337 destination = p_id[0];
342 destination = p_id[2];
344 th = GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
345 GNUNET_TIME_UNIT_FOREVER_REL,
348 &tmt_rdy, (void *) 1L);
351 unsigned long i = (unsigned long) cls;
353 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Retransmission\n");
356 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " in 1 ms\n");
357 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MILLISECONDS,
358 &data_task, (void *)1UL);
363 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "in %u ms\n", i);
364 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(
365 GNUNET_TIME_UNIT_MILLISECONDS,
367 &data_task, (void *)i);
374 * Transmit ready callback
376 * @param cls Closure (message type).
377 * @param size Size of the buffer we have.
378 * @param buf Buffer to copy data to.
381 tmt_rdy (void *cls, size_t size, void *buf)
383 struct GNUNET_MessageHeader *msg = buf;
386 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
387 " tmt_rdy called\n");
388 if (size < size_payload || NULL == buf)
391 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
392 "size %u, buf %p, data_sent %u, data_received %u\n",
399 msg->size = htons (size);
400 msg->type = htons ((long) cls);
401 data = (uint32_t *) &msg[1];
402 *data = htonl (data_sent);
403 if (SPEED == test && GNUNET_YES == initialized)
406 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
407 " Sent packet %d\n", data_sent);
408 if (data_sent < TOTAL_PACKETS)
410 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
411 " Scheduling packet %d\n", data_sent + 1);
412 GNUNET_SCHEDULER_add_now(&data_task, NULL);
420 * Function is called whenever a message is received.
422 * @param cls closure (set from GNUNET_MESH_connect)
423 * @param tunnel connection to the other end
424 * @param tunnel_ctx place to store local state associated with the tunnel
425 * @param sender who sent the message
426 * @param message the actual message
427 * @param atsi performance data for the connection
428 * @return GNUNET_OK to keep the connection open,
429 * GNUNET_SYSERR to close it (signal serious error)
432 data_callback (void *cls, struct GNUNET_MESH_Tunnel *tunnel, void **tunnel_ctx,
433 const struct GNUNET_PeerIdentity *sender,
434 const struct GNUNET_MessageHeader *message,
435 const struct GNUNET_ATS_Information *atsi)
437 long client = (long) cls;
438 long expected_target_client;
445 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
447 GNUNET_SCHEDULER_cancel (disconnect_task);
450 GNUNET_SCHEDULER_add_delayed (SHORT_TIME, &disconnect_mesh_peers,
457 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Root client got a message!\n");
462 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
463 "Leaf client %li got a message.\n",
471 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: (%d/%d)\n", ok, ok_goal);
472 data = (uint32_t *) &message[1];
473 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " payload: (%u)\n", ntohl (*data));
474 if (SPEED == test && GNUNET_YES == test_backwards)
476 expected_target_client = 0L;
480 expected_target_client = 4L;
483 if (GNUNET_NO == initialized)
485 initialized = GNUNET_YES;
486 start_time = GNUNET_TIME_absolute_get ();
489 GNUNET_assert (4L == client);
490 GNUNET_SCHEDULER_add_now (&data_task, NULL);
495 if (client == expected_target_client) // Normally 3 or 4
498 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
499 " received data %u\n", data_received);
500 if (SPEED != test || (ok_goal - 2) == ok)
502 GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
503 GNUNET_TIME_UNIT_FOREVER_REL, sender,
505 &tmt_rdy, (void *) 1L);
510 if (data_received < TOTAL_PACKETS)
516 if (test == SPEED_ACK || test == SPEED)
519 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
520 " received ack %u\n", data_ack);
521 GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
522 GNUNET_TIME_UNIT_FOREVER_REL, sender,
524 &tmt_rdy, (void *) 1L);
525 if (data_ack < TOTAL_PACKETS && SPEED != test)
527 if (ok == 2 && SPEED == test)
531 if (test == P2P_SIGNAL)
533 GNUNET_MESH_tunnel_destroy (incoming_t);
538 GNUNET_MESH_tunnel_destroy (t);
543 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
545 GNUNET_SCHEDULER_cancel (disconnect_task);
548 GNUNET_SCHEDULER_add_delayed (SHORT_TIME, &disconnect_mesh_peers,
556 * Handlers, for diverse services
558 static struct GNUNET_MESH_MessageHandler handlers[] = {
559 {&data_callback, 1, sizeof (struct GNUNET_MessageHeader)},
565 * Method called whenever another peer has added us to a tunnel
566 * the other peer initiated.
569 * @param tunnel new handle to the tunnel
570 * @param initiator peer that started the tunnel
571 * @param atsi performance information for the tunnel
572 * @return initial tunnel context for the tunnel
573 * (can be NULL -- that's not an error)
576 incoming_tunnel (void *cls, struct GNUNET_MESH_Tunnel *tunnel,
577 const struct GNUNET_PeerIdentity *initiator,
578 const struct GNUNET_ATS_Information *atsi)
580 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
581 "Incoming tunnel from %s to peer %d\n",
582 GNUNET_i2s (initiator), (long) cls);
584 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
585 if ((long) cls == 4L)
587 else if ((long) cls == 3L)
588 incoming_t2 = tunnel;
591 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
592 "Incoming tunnel for unknown client %lu\n", (long) cls);
595 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
597 GNUNET_SCHEDULER_cancel (disconnect_task);
600 GNUNET_SCHEDULER_add_delayed (SHORT_TIME, &disconnect_mesh_peers,
607 * Function called whenever an inbound tunnel is destroyed. Should clean up
608 * any associated state.
610 * @param cls closure (set from GNUNET_MESH_connect)
611 * @param tunnel connection to the other end (henceforth invalid)
612 * @param tunnel_ctx place where local state associated
613 * with the tunnel is stored
616 tunnel_cleaner (void *cls, const struct GNUNET_MESH_Tunnel *tunnel,
621 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
622 "Incoming tunnel disconnected at peer %d\n",
635 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
636 "Unknown peer! %d\n", i);
637 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
639 if (peers_in_tunnel > 0)
642 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
644 GNUNET_SCHEDULER_cancel (disconnect_task);
646 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
654 * Method called whenever a tunnel falls apart.
657 * @param peer peer identity the tunnel stopped working with
660 dh (void *cls, const struct GNUNET_PeerIdentity *peer)
662 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
663 "peer %s disconnected\n",
665 if (P2P_SIGNAL == test)
668 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
670 GNUNET_SCHEDULER_cancel (disconnect_task);
672 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
680 * Method called whenever a peer connects to a tunnel.
683 * @param peer peer identity the tunnel was created to, NULL on timeout
684 * @param atsi performance data for the connection
687 ch (void *cls, const struct GNUNET_PeerIdentity *peer,
688 const struct GNUNET_ATS_Information *atsi)
692 struct GNUNET_PeerIdentity *dest;
694 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
695 "%ld peer %s connected\n", i, GNUNET_i2s (peer));
697 if (0 == memcmp (p_id[2], peer, sizeof (struct GNUNET_PeerIdentity)) &&
702 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
709 // incoming_t is NULL unless we send a relevant data packet
716 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
718 GNUNET_SCHEDULER_cancel (disconnect_task);
720 GNUNET_SCHEDULER_add_delayed (SHORT_TIME, &disconnect_mesh_peers,
722 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
723 "Sending data initializer...\n");
728 GNUNET_MESH_notify_transmit_ready (t, GNUNET_NO,
729 GNUNET_TIME_UNIT_FOREVER_REL, dest,
731 &tmt_rdy, (void *) 1L);
735 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
736 "Disconnect already run?\n");
737 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
745 * START THE TESTCASE ITSELF, AS WE ARE CONNECTED TO THE MESH SERVICES.
747 * Testcase continues when the root receives confirmation of connected peers,
748 * on callback funtion ch.
750 * @param cls Closure (unsued).
751 * @param tc Task Context.
754 do_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
756 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test_task\n");
757 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "add peer 2\n");
758 GNUNET_MESH_peer_request_connect_add (t, p_id[2]);
760 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
761 "schedule timeout in TIMEOUT\n");
762 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
764 GNUNET_SCHEDULER_cancel (disconnect_task);
766 disconnect_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
767 &disconnect_mesh_peers,
772 * Callback to be called when the requested peer information is available
774 * @param cls the closure from GNUNET_TESTBED_peer_get_information()
775 * @param op the operation this callback corresponds to
776 * @param pinfo the result; will be NULL if the operation has failed
777 * @param emsg error message if the operation has failed;
778 * NULL if the operation is successfull
782 struct GNUNET_TESTBED_Operation *op,
783 const struct GNUNET_TESTBED_PeerInformation *pinfo,
788 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "id callback for %ld\n", i);
789 if (NULL == pinfo || NULL != emsg)
791 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "pi_cb: %s\n", emsg);
792 abort_test (__LINE__);
795 p_id[i] = pinfo->result.id;
796 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " id: %s\n", GNUNET_i2s (p_id[i]));
800 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got all IDs, starting test\n");
801 test_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
806 * test main: start test when all peers are connected
808 * @param cls Closure.
809 * @param ctx Argument to give to GNUNET_MESH_TEST_cleanup on test end.
810 * @param num_peers Number of peers that are running.
811 * @param peers Array of peers.
812 * @param meshes Handle to each of the MESHs of the peers.
816 struct GNUNET_MESH_TEST_Context *ctx,
817 unsigned int num_peers,
818 struct GNUNET_TESTBED_Peer **peers,
819 struct GNUNET_MESH_Handle **meshes)
821 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test main\n");
824 peers_running = num_peers;
826 h2 = meshes[num_peers - 1];
827 t = GNUNET_MESH_tunnel_create (h1, NULL, &ch, &dh, (void *) 0L);
828 if (SPEED_MIN == test)
830 GNUNET_MESH_tunnel_speed_min(t);
833 if (SPEED_NOBUF == test)
835 GNUNET_MESH_tunnel_buffer(t, GNUNET_NO);
839 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
840 &disconnect_mesh_peers,
842 shutdown_handle = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
843 &shutdown_task, NULL);
844 t_op[0] = GNUNET_TESTBED_peer_get_information (peers[0],
845 GNUNET_TESTBED_PIT_IDENTITY,
846 &pi_cb, (void *) 0L);
847 t_op[2] = GNUNET_TESTBED_peer_get_information (peers[num_peers - 1],
848 GNUNET_TESTBED_PIT_IDENTITY,
849 &pi_cb, (void *) 2L);
851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "requested peer ids\n");
859 main (int argc, char *argv[])
861 initialized = GNUNET_NO;
863 GNUNET_log_setup ("test", "DEBUG", NULL);
865 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start\n");
866 if (strstr (argv[0], "test_mesh2_small_forward") != NULL)
868 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "UNICAST\n");
870 test_name = "unicast";
873 else if (strstr (argv[0], "test_mesh_small_signal") != NULL)
875 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SIGNAL\n");
877 test_name = "signal";
880 else if (strstr (argv[0], "test_mesh_small_speed_ack") != NULL)
882 /* Each peer is supposed to generate the following callbacks:
883 * 1 incoming tunnel (@dest)
884 * 1 connected peer (@orig)
885 * TOTAL_PACKETS received data packet (@dest)
886 * TOTAL_PACKETS received data packet (@orig)
887 * 1 received tunnel destroy (@dest)
888 * _________________________________
889 * 5 x ok expected per peer
891 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED_ACK\n");
893 test_name = "speed ack";
894 ok_goal = TOTAL_PACKETS * 2 + 3;
896 else if (strstr (argv[0], "test_mesh_small_speed") != NULL)
898 /* Each peer is supposed to generate the following callbacks:
899 * 1 incoming tunnel (@dest)
900 * 1 connected peer (@orig)
901 * 1 initial packet (@dest)
902 * TOTAL_PACKETS received data packet (@dest)
903 * 1 received data packet (@orig)
904 * 1 received tunnel destroy (@dest)
905 * _________________________________
907 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED\n");
908 ok_goal = TOTAL_PACKETS + 5;
909 if (strstr (argv[0], "_min") != NULL)
912 test_name = "speed min";
914 else if (strstr (argv[0], "_nobuf") != NULL)
917 test_name = "speed nobuf";
927 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "UNKNOWN\n");
932 if (strstr (argv[0], "backwards") != NULL)
936 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "BACKWARDS (LEAF TO ROOT)\n");
937 test_backwards = GNUNET_YES;
938 aux = GNUNET_malloc (32);
939 sprintf (aux, "backwards %s", test_name);
944 GNUNET_MESH_TEST_run ("test_mesh_small",
945 "test_mesh_small.conf",
956 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
957 "FAILED! (%d/%d)\n", ok, ok_goal);
960 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "success\n");
964 /* end of test_mesh_small.c */