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_mesh_small.c
23 * @brief Test for the mesh service: retransmission of traffic.
27 #include "mesh_test_lib.h"
28 #include "gnunet_mesh_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 responded
118 static int peers_responded;
121 * Number of payload packes sent
123 static int data_sent;
126 * Number of payload packets received
128 static int data_received;
131 * Number of payload packed explicitly (app level) acknowledged
136 * Total number of currently running peers.
138 static unsigned long long peers_running;
141 * Test context (to shut down).
143 struct GNUNET_MESH_TEST_Context *test_ctx;
146 * Task called to disconnect peers.
148 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
151 * Task To perform tests
153 static GNUNET_SCHEDULER_TaskIdentifier test_task;
156 * Task called to shutdown test.
158 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
161 * Mesh handle for the root peer
163 static struct GNUNET_MESH_Handle *h1;
166 * Mesh handle for the first leaf peer
168 static struct GNUNET_MESH_Handle *h2;
171 * Tunnel handle for the root peer
173 static struct GNUNET_MESH_Tunnel *t;
176 * Tunnel handle for the first leaf peer
178 static struct GNUNET_MESH_Tunnel *incoming_t;
181 * Time we started the data transmission (after tunnel has been established
184 static struct GNUNET_TIME_Absolute start_time;
188 * Show the results of the test (banwidth acheived) and log them to GAUGER
193 static struct GNUNET_TIME_Absolute end_time;
194 static struct GNUNET_TIME_Relative total_time;
196 end_time = GNUNET_TIME_absolute_get();
197 total_time = GNUNET_TIME_absolute_get_difference(start_time, end_time);
198 FPRINTF (stderr, "\nResults of test \"%s\"\n", test_name);
199 FPRINTF (stderr, "Test time %llu ms\n",
200 (unsigned long long) total_time.rel_value);
201 FPRINTF (stderr, "Test bandwidth: %f kb/s\n",
202 4 * TOTAL_PACKETS * 1.0 / total_time.rel_value); // 4bytes * ms
203 FPRINTF (stderr, "Test throughput: %f packets/s\n\n",
204 TOTAL_PACKETS * 1000.0 / total_time.rel_value); // packets * ms
205 GAUGER ("MESH", test_name,
206 TOTAL_PACKETS * 1000.0 / total_time.rel_value,
212 * Shut down peergroup, clean up.
214 * @param cls Closure (unused).
215 * @param tc Task Context.
218 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
220 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending test.\n");
221 shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
226 * Disconnect from mesh services af all peers, call shutdown.
228 * @param cls Closure (unused).
229 * @param tc Task Context.
232 disconnect_mesh_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
234 long line = (long) cls;
237 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
238 "disconnecting mesh service of peers, called from line %ld\n",
240 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
241 for (i = 0; i < 2; i++)
243 GNUNET_TESTBED_operation_done (t_op[i]);
247 GNUNET_MESH_tunnel_destroy (t);
250 if (NULL != incoming_t)
252 GNUNET_MESH_tunnel_destroy (incoming_t);
255 GNUNET_MESH_TEST_cleanup (test_ctx);
256 if (GNUNET_SCHEDULER_NO_TASK != shutdown_handle)
258 GNUNET_SCHEDULER_cancel (shutdown_handle);
260 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
265 * Abort test: schedule disconnect and shutdown immediately
267 * @param line Line in the code the abort is requested from (__LINE__).
270 abort_test (long line)
272 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
274 GNUNET_SCHEDULER_cancel (disconnect_task);
275 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
281 * Transmit ready callback.
283 * @param cls Closure (message type).
284 * @param size Size of the tranmist buffer.
285 * @param buf Pointer to the beginning of the buffer.
287 * @return Number of bytes written to buf.
290 tmt_rdy (void *cls, size_t size, void *buf);
294 * Task to schedule a new data transmission.
296 * @param cls Closure (peer #).
297 * @param tc Task Context.
300 data_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
302 struct GNUNET_MESH_TransmitHandle *th;
303 struct GNUNET_MESH_Tunnel *tunnel;
305 if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
308 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Data task\n");
309 if (GNUNET_YES == test_backwards)
317 th = GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
318 GNUNET_TIME_UNIT_FOREVER_REL,
319 size_payload, &tmt_rdy, (void *) 1L);
322 unsigned long i = (unsigned long) cls;
324 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Retransmission\n");
327 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " in 1 ms\n");
328 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MILLISECONDS,
329 &data_task, (void *)1UL);
334 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "in %u ms\n", i);
335 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(
336 GNUNET_TIME_UNIT_MILLISECONDS,
338 &data_task, (void *)i);
345 * Transmit ready callback
347 * @param cls Closure (message type).
348 * @param size Size of the buffer we have.
349 * @param buf Buffer to copy data to.
352 tmt_rdy (void *cls, size_t size, void *buf)
354 struct GNUNET_MessageHeader *msg = buf;
357 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
358 " tmt_rdy called\n");
359 if (size < size_payload || NULL == buf)
362 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
363 "size %u, buf %p, data_sent %u, data_received %u\n",
370 msg->size = htons (size);
371 msg->type = htons ((long) cls);
372 data = (uint32_t *) &msg[1];
373 *data = htonl (data_sent);
374 if (SPEED == test && GNUNET_YES == initialized)
377 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
378 " Sent packet %d\n", data_sent);
379 if (data_sent < TOTAL_PACKETS)
381 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
382 " Scheduling packet %d\n", data_sent + 1);
383 GNUNET_SCHEDULER_add_now(&data_task, NULL);
391 * Function is called whenever a message is received.
393 * @param cls closure (set from GNUNET_MESH_connect)
394 * @param tunnel connection to the other end
395 * @param tunnel_ctx place to store local state associated with the tunnel
396 * @param message the actual message
397 * @return GNUNET_OK to keep the connection open,
398 * GNUNET_SYSERR to close it (signal serious error)
401 data_callback (void *cls, struct GNUNET_MESH_Tunnel *tunnel, void **tunnel_ctx,
402 const struct GNUNET_MessageHeader *message)
404 long client = (long) cls;
405 long expected_target_client;
410 GNUNET_MESH_receive_done (tunnel);
414 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
416 GNUNET_SCHEDULER_cancel (disconnect_task);
417 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
418 &disconnect_mesh_peers,
426 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Root client got a message!\n");
430 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
431 "Leaf client %li got a message.\n",
439 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: (%d/%d)\n", ok, ok_goal);
440 data = (uint32_t *) &message[1];
441 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " payload: (%u)\n", ntohl (*data));
442 if (SPEED == test && GNUNET_YES == test_backwards)
444 expected_target_client = 0L;
448 expected_target_client = 4L;
451 if (GNUNET_NO == initialized)
453 initialized = GNUNET_YES;
454 start_time = GNUNET_TIME_absolute_get ();
457 GNUNET_assert (4L == client);
458 GNUNET_SCHEDULER_add_now (&data_task, NULL);
463 if (client == expected_target_client) // Normally 3 or 4
466 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
467 " received data %u\n", data_received);
468 if (SPEED != test || (ok_goal - 2) == ok)
470 GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
471 GNUNET_TIME_UNIT_FOREVER_REL,
472 size_payload, &tmt_rdy, (void *) 1L);
477 if (data_received < TOTAL_PACKETS)
483 if (test == SPEED_ACK || test == SPEED)
486 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
487 " received ack %u\n", data_ack);
488 GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
489 GNUNET_TIME_UNIT_FOREVER_REL,
490 size_payload, &tmt_rdy, (void *) 1L);
491 if (data_ack < TOTAL_PACKETS && SPEED != test)
493 if (ok == 2 && SPEED == test)
497 if (test == P2P_SIGNAL)
499 GNUNET_MESH_tunnel_destroy (incoming_t);
504 GNUNET_MESH_tunnel_destroy (t);
509 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
511 GNUNET_SCHEDULER_cancel (disconnect_task);
512 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
513 &disconnect_mesh_peers,
522 * Handlers, for diverse services
524 static struct GNUNET_MESH_MessageHandler handlers[] = {
525 {&data_callback, 1, sizeof (struct GNUNET_MessageHeader)},
531 * Method called whenever another peer has added us to a tunnel
532 * the other peer initiated.
534 * @param cls Closure.
535 * @param tunnel New handle to the tunnel.
536 * @param initiator Peer that started the tunnel.
537 * @param port Port this tunnels is connected to.
538 * @return Initial tunnel context for the tunnel
539 * (can be NULL -- that's not an error).
542 incoming_tunnel (void *cls, struct GNUNET_MESH_Tunnel *tunnel,
543 const struct GNUNET_PeerIdentity *initiator,
546 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
547 "Incoming tunnel from %s to peer %d\n",
548 GNUNET_i2s (initiator), (long) cls);
550 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
551 if ((long) cls == 4L)
555 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
556 "Incoming tunnel for unknown client %lu\n", (long) cls);
559 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
561 GNUNET_SCHEDULER_cancel (disconnect_task);
562 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
563 &disconnect_mesh_peers,
571 * Function called whenever an inbound tunnel is destroyed. Should clean up
572 * any associated state.
574 * @param cls closure (set from GNUNET_MESH_connect)
575 * @param tunnel connection to the other end (henceforth invalid)
576 * @param tunnel_ctx place where local state associated
577 * with the tunnel is stored
580 tunnel_cleaner (void *cls, const struct GNUNET_MESH_Tunnel *tunnel,
585 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
586 "Incoming tunnel disconnected at peer %d\n",
593 else if (0L == i && P2P_SIGNAL == test)
598 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
599 "Unknown peer! %d\n", i);
600 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
602 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
604 GNUNET_SCHEDULER_cancel (disconnect_task);
605 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
614 * START THE TESTCASE ITSELF, AS WE ARE CONNECTED TO THE MESH SERVICES.
616 * Testcase continues when the root receives confirmation of connected peers,
617 * on callback funtion ch.
619 * @param cls Closure (unsued).
620 * @param tc Task Context.
623 do_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
625 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test_task\n");
626 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "add peer 2\n");
628 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
629 "schedule timeout in TIMEOUT\n");
630 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
632 GNUNET_SCHEDULER_cancel (disconnect_task);
634 t = GNUNET_MESH_tunnel_create (h1, NULL, p_id[1], 1, GNUNET_YES, GNUNET_NO);
635 if (SPEED_NOBUF == test)
637 GNUNET_MESH_tunnel_buffer(t, GNUNET_NO);
641 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
642 &disconnect_mesh_peers,
644 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
645 "Sending data initializer...\n");
650 GNUNET_MESH_notify_transmit_ready (t, GNUNET_NO,
651 GNUNET_TIME_UNIT_FOREVER_REL,
652 size_payload, &tmt_rdy, (void *) 1L);
656 * Callback to be called when the requested peer information is available
658 * @param cls the closure from GNUNET_TESTBED_peer_get_information()
659 * @param op the operation this callback corresponds to
660 * @param pinfo the result; will be NULL if the operation has failed
661 * @param emsg error message if the operation has failed;
662 * NULL if the operation is successfull
666 struct GNUNET_TESTBED_Operation *op,
667 const struct GNUNET_TESTBED_PeerInformation *pinfo,
672 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "id callback for %ld\n", i);
674 if (NULL == pinfo || NULL != emsg)
676 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "pi_cb: %s\n", emsg);
677 abort_test (__LINE__);
680 p_id[i] = pinfo->result.id;
681 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " id: %s\n", GNUNET_i2s (p_id[i]));
685 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got all IDs, starting test\n");
686 test_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
691 * test main: start test when all peers are connected
693 * @param cls Closure.
694 * @param ctx Argument to give to GNUNET_MESH_TEST_cleanup on test end.
695 * @param num_peers Number of peers that are running.
696 * @param peers Array of peers.
697 * @param meshes Handle to each of the MESHs of the peers.
701 struct GNUNET_MESH_TEST_Context *ctx,
702 unsigned int num_peers,
703 struct GNUNET_TESTBED_Peer **peers,
704 struct GNUNET_MESH_Handle **meshes)
706 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test main\n");
709 peers_running = num_peers;
711 h2 = meshes[num_peers - 1];
712 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
713 &disconnect_mesh_peers,
715 shutdown_handle = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
716 &shutdown_task, NULL);
717 t_op[0] = GNUNET_TESTBED_peer_get_information (peers[0],
718 GNUNET_TESTBED_PIT_IDENTITY,
719 &pi_cb, (void *) 0L);
720 t_op[1] = GNUNET_TESTBED_peer_get_information (peers[num_peers - 1],
721 GNUNET_TESTBED_PIT_IDENTITY,
722 &pi_cb, (void *) 1L);
723 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "requested peer ids\n");
731 main (int argc, char *argv[])
733 initialized = GNUNET_NO;
736 GNUNET_log_setup ("test", "DEBUG", NULL);
738 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start\n");
739 if (strstr (argv[0], "_small_forward") != NULL)
741 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "FORWARD\n");
743 test_name = "unicast2";
746 else if (strstr (argv[0], "_small_signal") != NULL)
748 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SIGNAL\n");
750 test_name = "signal2";
753 else if (strstr (argv[0], "_small_speed_ack") != NULL)
755 /* Each peer is supposed to generate the following callbacks:
756 * 1 incoming tunnel (@dest)
757 * TOTAL_PACKETS received data packet (@dest)
758 * TOTAL_PACKETS received data packet (@orig)
759 * 1 received tunnel destroy (@dest)
760 * _________________________________
761 * 5 x ok expected per peer
763 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED_ACK\n");
765 test_name = "speed2 ack";
766 ok_goal = TOTAL_PACKETS * 2 + 2;
768 else if (strstr (argv[0], "_small_speed") != NULL)
770 /* Each peer is supposed to generate the following callbacks:
771 * 1 incoming tunnel (@dest)
772 * 1 initial packet (@dest)
773 * TOTAL_PACKETS received data packet (@dest)
774 * 1 received data packet (@orig)
775 * 1 received tunnel destroy (@dest)
776 * _________________________________
778 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED\n");
779 ok_goal = TOTAL_PACKETS + 4;
780 if (strstr (argv[0], "_nobuf") != NULL)
783 test_name = "speed2 nobuf";
788 test_name = "speed2";
793 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "UNKNOWN\n");
798 if (strstr (argv[0], "backwards") != NULL)
802 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "BACKWARDS (LEAF TO ROOT)\n");
803 test_backwards = GNUNET_YES;
804 aux = GNUNET_malloc (32);
805 sprintf (aux, "backwards %s", test_name);
812 GNUNET_MESH_TEST_run ("test_mesh_small",
816 NULL, /* tmain cls */
824 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
825 "FAILED! (%d/%d)\n", ok, ok_goal);
828 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "success\n");
832 /* end of test_mesh_small.c */