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 "mesh2_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
58 * Which test are we running?
63 * String with test name
68 * Flag to send traffic leaf->root in speed tests to test BCK_ACK logic.
70 static int test_backwards = GNUNET_NO;
73 * How many events have happened
78 * Each peer is supposed to generate the following callbacks:
79 * 1 incoming tunnel (@dest)
80 * 1 connected peer (@orig)
81 * 1 received data packet (@dest)
82 * 1 received data packet (@orig)
83 * 1 received tunnel destroy (@dest)
84 * _________________________________
85 * 5 x ok expected per peer
91 * Size of each test packet
93 size_t size_payload = sizeof (struct GNUNET_MessageHeader) + sizeof (uint32_t);
96 * Operation to get peer ids.
98 struct GNUNET_TESTBED_Operation *t_op[2];
103 struct GNUNET_PeerIdentity *p_id[2];
111 * Is the setup initialized?
113 static int initialized;
116 * Peers that have been connected
118 static int peers_in_tunnel;
121 * Peers that have responded
123 static int peers_responded;
126 * Number of payload packes sent
128 static int data_sent;
131 * Number of payload packets received
133 static int data_received;
136 * Number of payload packed explicitly (app level) acknowledged
141 * Total number of currently running peers.
143 static unsigned long long peers_running;
146 * Test context (to shut down).
148 struct GNUNET_MESH_TEST_Context *test_ctx;
151 * Task called to disconnect peers.
153 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
156 * Task To perform tests
158 static GNUNET_SCHEDULER_TaskIdentifier test_task;
161 * Task called to shutdown test.
163 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
166 * Mesh handle for the root peer
168 static struct GNUNET_MESH_Handle *h1;
171 * Mesh handle for the first leaf peer
173 static struct GNUNET_MESH_Handle *h2;
176 * Tunnel handle for the root peer
178 static struct GNUNET_MESH_Tunnel *t;
181 * Tunnel handle for the first leaf peer
183 static struct GNUNET_MESH_Tunnel *incoming_t;
186 * Time we started the data transmission (after tunnel has been established
189 static struct GNUNET_TIME_Absolute start_time;
193 * Show the results of the test (banwidth acheived) and log them to GAUGER
198 static struct GNUNET_TIME_Absolute end_time;
199 static struct GNUNET_TIME_Relative total_time;
201 end_time = GNUNET_TIME_absolute_get();
202 total_time = GNUNET_TIME_absolute_get_difference(start_time, end_time);
203 FPRINTF (stderr, "\nResults of test \"%s\"\n", test_name);
204 FPRINTF (stderr, "Test time %llu ms\n",
205 (unsigned long long) total_time.rel_value);
206 FPRINTF (stderr, "Test bandwidth: %f kb/s\n",
207 4 * TOTAL_PACKETS * 1.0 / total_time.rel_value); // 4bytes * ms
208 FPRINTF (stderr, "Test throughput: %f packets/s\n\n",
209 TOTAL_PACKETS * 1000.0 / total_time.rel_value); // packets * ms
210 GAUGER ("MESH", test_name,
211 TOTAL_PACKETS * 1000.0 / total_time.rel_value,
217 * Shut down peergroup, clean up.
219 * @param cls Closure (unused).
220 * @param tc Task Context.
223 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
225 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending test.\n");
226 shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
231 * Disconnect from mesh services af all peers, call shutdown.
233 * @param cls Closure (unused).
234 * @param tc Task Context.
237 disconnect_mesh_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
239 long line = (long) cls;
242 for (i = 0; i < 3; i++)
245 GNUNET_TESTBED_operation_done (t_op[i]);
248 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
249 "disconnecting mesh service of peers, called from line %ld\n",
251 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
254 GNUNET_MESH_tunnel_destroy (t);
257 if (NULL != incoming_t)
259 GNUNET_MESH_tunnel_destroy (incoming_t);
262 GNUNET_MESH_TEST_cleanup (test_ctx);
263 if (GNUNET_SCHEDULER_NO_TASK != shutdown_handle)
265 GNUNET_SCHEDULER_cancel (shutdown_handle);
267 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
272 * Abort test: schedule disconnect and shutdown immediately
274 * @param line Line in the code the abort is requested from (__LINE__).
277 abort_test (long line)
279 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
281 GNUNET_SCHEDULER_cancel (disconnect_task);
283 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
284 &disconnect_mesh_peers,
289 * Transmit ready callback.
291 * @param cls Closure (message type).
292 * @param size Size of the tranmist buffer.
293 * @param buf Pointer to the beginning of the buffer.
295 * @return Number of bytes written to buf.
298 tmt_rdy (void *cls, size_t size, void *buf);
302 * Task to schedule a new data transmission.
304 * @param cls Closure (peer #).
305 * @param tc Task Context.
308 data_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
310 struct GNUNET_MESH_TransmitHandle *th;
311 struct GNUNET_MESH_Tunnel *tunnel;
313 if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
316 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Data task\n");
317 if (GNUNET_YES == test_backwards)
325 th = GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
326 GNUNET_TIME_UNIT_FOREVER_REL,
327 size_payload, &tmt_rdy, (void *) 1L);
330 unsigned long i = (unsigned long) cls;
332 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Retransmission\n");
335 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " in 1 ms\n");
336 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MILLISECONDS,
337 &data_task, (void *)1UL);
342 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "in %u ms\n", i);
343 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(
344 GNUNET_TIME_UNIT_MILLISECONDS,
346 &data_task, (void *)i);
353 * Transmit ready callback
355 * @param cls Closure (message type).
356 * @param size Size of the buffer we have.
357 * @param buf Buffer to copy data to.
360 tmt_rdy (void *cls, size_t size, void *buf)
362 struct GNUNET_MessageHeader *msg = buf;
365 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
366 " tmt_rdy called\n");
367 if (size < size_payload || NULL == buf)
370 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
371 "size %u, buf %p, data_sent %u, data_received %u\n",
378 msg->size = htons (size);
379 msg->type = htons ((long) cls);
380 data = (uint32_t *) &msg[1];
381 *data = htonl (data_sent);
382 if (SPEED == test && GNUNET_YES == initialized)
385 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
386 " Sent packet %d\n", data_sent);
387 if (data_sent < TOTAL_PACKETS)
389 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
390 " Scheduling packet %d\n", data_sent + 1);
391 GNUNET_SCHEDULER_add_now(&data_task, NULL);
399 * Function is called whenever a message is received.
401 * @param cls closure (set from GNUNET_MESH_connect)
402 * @param tunnel connection to the other end
403 * @param tunnel_ctx place to store local state associated with the tunnel
404 * @param sender who sent the message
405 * @param message the actual message
406 * @return GNUNET_OK to keep the connection open,
407 * GNUNET_SYSERR to close it (signal serious error)
410 data_callback (void *cls, struct GNUNET_MESH_Tunnel *tunnel, void **tunnel_ctx,
411 const struct GNUNET_PeerIdentity *sender,
412 const struct GNUNET_MessageHeader *message)
414 long client = (long) cls;
415 long expected_target_client;
420 GNUNET_MESH_receive_done (tunnel);
424 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
426 GNUNET_SCHEDULER_cancel (disconnect_task);
429 GNUNET_SCHEDULER_add_delayed (SHORT_TIME, &disconnect_mesh_peers,
436 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Root client got a message!\n");
440 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
441 "Leaf client %li got a message.\n",
449 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: (%d/%d)\n", ok, ok_goal);
450 data = (uint32_t *) &message[1];
451 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " payload: (%u)\n", ntohl (*data));
452 if (SPEED == test && GNUNET_YES == test_backwards)
454 expected_target_client = 0L;
458 expected_target_client = 4L;
461 if (GNUNET_NO == initialized)
463 initialized = GNUNET_YES;
464 start_time = GNUNET_TIME_absolute_get ();
467 GNUNET_assert (4L == client);
468 GNUNET_SCHEDULER_add_now (&data_task, NULL);
473 if (client == expected_target_client) // Normally 3 or 4
476 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
477 " received data %u\n", data_received);
478 if (SPEED != test || (ok_goal - 2) == ok)
480 GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
481 GNUNET_TIME_UNIT_FOREVER_REL,
482 size_payload, &tmt_rdy, (void *) 1L);
487 if (data_received < TOTAL_PACKETS)
493 if (test == SPEED_ACK || test == SPEED)
496 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
497 " received ack %u\n", data_ack);
498 GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
499 GNUNET_TIME_UNIT_FOREVER_REL,
500 size_payload, &tmt_rdy, (void *) 1L);
501 if (data_ack < TOTAL_PACKETS && SPEED != test)
503 if (ok == 2 && SPEED == test)
507 if (test == P2P_SIGNAL)
509 GNUNET_MESH_tunnel_destroy (incoming_t);
514 GNUNET_MESH_tunnel_destroy (t);
519 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
521 GNUNET_SCHEDULER_cancel (disconnect_task);
524 GNUNET_SCHEDULER_add_delayed (SHORT_TIME, &disconnect_mesh_peers,
532 * Handlers, for diverse services
534 static struct GNUNET_MESH_MessageHandler handlers[] = {
535 {&data_callback, 1, sizeof (struct GNUNET_MessageHeader)},
541 * Method called whenever another peer has added us to a tunnel
542 * the other peer initiated.
544 * @param cls Closure.
545 * @param tunnel New handle to the tunnel.
546 * @param initiator Peer that started the tunnel.
547 * @param port Port this tunnels is connected to.
548 * @return Initial tunnel context for the tunnel
549 * (can be NULL -- that's not an error).
552 incoming_tunnel (void *cls, struct GNUNET_MESH_Tunnel *tunnel,
553 const struct GNUNET_PeerIdentity *initiator,
556 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
557 "Incoming tunnel from %s to peer %d\n",
558 GNUNET_i2s (initiator), (long) cls);
560 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
561 if ((long) cls == 4L)
565 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
566 "Incoming tunnel for unknown client %lu\n", (long) cls);
569 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
571 GNUNET_SCHEDULER_cancel (disconnect_task);
574 GNUNET_SCHEDULER_add_delayed (SHORT_TIME, &disconnect_mesh_peers,
581 * Function called whenever an inbound tunnel is destroyed. Should clean up
582 * any associated state.
584 * @param cls closure (set from GNUNET_MESH_connect)
585 * @param tunnel connection to the other end (henceforth invalid)
586 * @param tunnel_ctx place where local state associated
587 * with the tunnel is stored
590 tunnel_cleaner (void *cls, const struct GNUNET_MESH_Tunnel *tunnel,
595 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
596 "Incoming tunnel disconnected at peer %d\n",
603 else if (0L == i && P2P_SIGNAL == test)
606 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
608 GNUNET_SCHEDULER_cancel (disconnect_task);
610 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
614 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
615 "Unknown peer! %d\n", i);
616 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
618 if (peers_in_tunnel > 0)
621 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
623 GNUNET_SCHEDULER_cancel (disconnect_task);
625 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
633 * START THE TESTCASE ITSELF, AS WE ARE CONNECTED TO THE MESH SERVICES.
635 * Testcase continues when the root receives confirmation of connected peers,
636 * on callback funtion ch.
638 * @param cls Closure (unsued).
639 * @param tc Task Context.
642 do_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
644 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test_task\n");
645 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "add peer 2\n");
647 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
648 "schedule timeout in TIMEOUT\n");
649 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
651 GNUNET_SCHEDULER_cancel (disconnect_task);
653 t = GNUNET_MESH_tunnel_create (h1, NULL, p_id[1], 1);
654 if (SPEED_NOBUF == test)
656 GNUNET_MESH_tunnel_buffer(t, GNUNET_NO);
661 GNUNET_SCHEDULER_add_delayed (SHORT_TIME, &disconnect_mesh_peers,
663 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
664 "Sending data initializer...\n");
669 GNUNET_MESH_notify_transmit_ready (t, GNUNET_NO,
670 GNUNET_TIME_UNIT_FOREVER_REL,
671 size_payload, &tmt_rdy, (void *) 1L);
675 * Callback to be called when the requested peer information is available
677 * @param cls the closure from GNUNET_TESTBED_peer_get_information()
678 * @param op the operation this callback corresponds to
679 * @param pinfo the result; will be NULL if the operation has failed
680 * @param emsg error message if the operation has failed;
681 * NULL if the operation is successfull
685 struct GNUNET_TESTBED_Operation *op,
686 const struct GNUNET_TESTBED_PeerInformation *pinfo,
691 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "id callback for %ld\n", i);
692 if (NULL == pinfo || NULL != emsg)
694 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "pi_cb: %s\n", emsg);
695 abort_test (__LINE__);
698 p_id[i] = pinfo->result.id;
699 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " id: %s\n", GNUNET_i2s (p_id[i]));
703 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got all IDs, starting test\n");
704 test_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
709 * test main: start test when all peers are connected
711 * @param cls Closure.
712 * @param ctx Argument to give to GNUNET_MESH_TEST_cleanup on test end.
713 * @param num_peers Number of peers that are running.
714 * @param peers Array of peers.
715 * @param meshes Handle to each of the MESHs of the peers.
719 struct GNUNET_MESH_TEST_Context *ctx,
720 unsigned int num_peers,
721 struct GNUNET_TESTBED_Peer **peers,
722 struct GNUNET_MESH_Handle **meshes)
724 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test main\n");
727 peers_running = num_peers;
729 h2 = meshes[num_peers - 1];
731 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
732 &disconnect_mesh_peers,
734 shutdown_handle = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
735 &shutdown_task, NULL);
736 t_op[0] = GNUNET_TESTBED_peer_get_information (peers[0],
737 GNUNET_TESTBED_PIT_IDENTITY,
738 &pi_cb, (void *) 0L);
739 t_op[1] = GNUNET_TESTBED_peer_get_information (peers[num_peers - 1],
740 GNUNET_TESTBED_PIT_IDENTITY,
741 &pi_cb, (void *) 1L);
742 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "requested peer ids\n");
750 main (int argc, char *argv[])
752 initialized = GNUNET_NO;
754 GNUNET_log_setup ("test", "DEBUG", NULL);
756 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start\n");
757 if (strstr (argv[0], "test_mesh2_small_forward") != NULL)
759 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "FORWARD\n");
761 test_name = "unicast";
764 else if (strstr (argv[0], "test_mesh_small_signal") != NULL)
766 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SIGNAL\n");
768 test_name = "signal";
771 else if (strstr (argv[0], "test_mesh_small_speed_ack") != NULL)
773 /* Each peer is supposed to generate the following callbacks:
774 * 1 incoming tunnel (@dest)
775 * TOTAL_PACKETS received data packet (@dest)
776 * TOTAL_PACKETS received data packet (@orig)
777 * 1 received tunnel destroy (@dest)
778 * _________________________________
779 * 5 x ok expected per peer
781 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED_ACK\n");
783 test_name = "speed ack";
784 ok_goal = TOTAL_PACKETS * 2 + 2;
786 else if (strstr (argv[0], "test_mesh_small_speed") != NULL)
788 /* Each peer is supposed to generate the following callbacks:
789 * 1 incoming tunnel (@dest)
790 * 1 initial packet (@dest)
791 * TOTAL_PACKETS received data packet (@dest)
792 * 1 received data packet (@orig)
793 * 1 received tunnel destroy (@dest)
794 * _________________________________
796 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED\n");
797 ok_goal = TOTAL_PACKETS + 4;
798 if (strstr (argv[0], "_nobuf") != NULL)
801 test_name = "speed nobuf";
811 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "UNKNOWN\n");
816 if (strstr (argv[0], "backwards") != NULL)
820 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "BACKWARDS (LEAF TO ROOT)\n");
821 test_backwards = GNUNET_YES;
822 aux = GNUNET_malloc (32);
823 sprintf (aux, "backwards %s", test_name);
828 GNUNET_MESH_TEST_run ("test_mesh_small",
829 "test_mesh_small.conf",
840 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
841 "FAILED! (%d/%d)\n", ok, ok_goal);
844 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "success\n");
848 /* end of test_mesh_small.c */