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, 60)
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[2];
104 struct GNUNET_PeerIdentity *p_id[2];
112 * Is the setup initialized?
114 static int initialized;
117 * Number of payload packes sent
119 static int data_sent;
122 * Number of payload packets received
124 static int data_received;
127 * Number of payload packed explicitly (app level) acknowledged
132 * Total number of currently running peers.
134 static unsigned long long peers_running;
137 * Test context (to shut down).
139 struct GNUNET_MESH_TEST_Context *test_ctx;
142 * Task called to disconnect peers.
144 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
147 * Task To perform tests
149 static GNUNET_SCHEDULER_TaskIdentifier test_task;
152 * Task called to shutdown test.
154 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
157 * Mesh handle for the root peer
159 static struct GNUNET_MESH_Handle *h1;
162 * Mesh handle for the first leaf peer
164 static struct GNUNET_MESH_Handle *h2;
167 * Tunnel handle for the root peer
169 static struct GNUNET_MESH_Tunnel *t;
172 * Tunnel handle for the first leaf peer
174 static struct GNUNET_MESH_Tunnel *incoming_t;
177 * Time we started the data transmission (after tunnel has been established
180 static struct GNUNET_TIME_Absolute start_time;
184 * Show the results of the test (banwidth acheived) and log them to GAUGER
189 static struct GNUNET_TIME_Absolute end_time;
190 static struct GNUNET_TIME_Relative total_time;
192 end_time = GNUNET_TIME_absolute_get();
193 total_time = GNUNET_TIME_absolute_get_difference(start_time, end_time);
194 FPRINTF (stderr, "\nResults of test \"%s\"\n", test_name);
195 FPRINTF (stderr, "Test time %llu ms\n",
196 (unsigned long long) total_time.rel_value);
197 FPRINTF (stderr, "Test bandwidth: %f kb/s\n",
198 4 * TOTAL_PACKETS * 1.0 / total_time.rel_value); // 4bytes * ms
199 FPRINTF (stderr, "Test throughput: %f packets/s\n\n",
200 TOTAL_PACKETS * 1000.0 / total_time.rel_value); // packets * ms
201 GAUGER ("MESH", test_name,
202 TOTAL_PACKETS * 1000.0 / total_time.rel_value,
208 * Shut down peergroup, clean up.
210 * @param cls Closure (unused).
211 * @param tc Task Context.
214 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
216 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending test.\n");
217 shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
222 * Disconnect from mesh services af all peers, call shutdown.
224 * @param cls Closure (unused).
225 * @param tc Task Context.
228 disconnect_mesh_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
230 long line = (long) cls;
233 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
234 "disconnecting mesh service of peers, called from line %ld\n",
236 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
237 for (i = 0; i < 2; i++)
239 GNUNET_TESTBED_operation_done (t_op[i]);
243 GNUNET_MESH_tunnel_destroy (t);
246 if (NULL != incoming_t)
248 GNUNET_MESH_tunnel_destroy (incoming_t);
251 GNUNET_MESH_TEST_cleanup (test_ctx);
252 if (GNUNET_SCHEDULER_NO_TASK != shutdown_handle)
254 GNUNET_SCHEDULER_cancel (shutdown_handle);
256 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
261 * Abort test: schedule disconnect and shutdown immediately
263 * @param line Line in the code the abort is requested from (__LINE__).
266 abort_test (long line)
268 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
270 GNUNET_SCHEDULER_cancel (disconnect_task);
271 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
277 * Transmit ready callback.
279 * @param cls Closure (message type).
280 * @param size Size of the tranmist buffer.
281 * @param buf Pointer to the beginning of the buffer.
283 * @return Number of bytes written to buf.
286 tmt_rdy (void *cls, size_t size, void *buf);
290 * Task to schedule a new data transmission.
292 * @param cls Closure (peer #).
293 * @param tc Task Context.
296 data_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
298 struct GNUNET_MESH_TransmitHandle *th;
299 struct GNUNET_MESH_Tunnel *tunnel;
301 if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
304 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Data task\n");
305 if (GNUNET_YES == test_backwards)
313 th = GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
314 GNUNET_TIME_UNIT_FOREVER_REL,
315 size_payload, &tmt_rdy, (void *) 1L);
318 unsigned long i = (unsigned long) cls;
320 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Retransmission\n");
323 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " in 1 ms\n");
324 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MILLISECONDS,
325 &data_task, (void *)1UL);
330 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "in %u ms\n", i);
331 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(
332 GNUNET_TIME_UNIT_MILLISECONDS,
334 &data_task, (void *)i);
341 * Transmit ready callback
343 * @param cls Closure (message type).
344 * @param size Size of the buffer we have.
345 * @param buf Buffer to copy data to.
348 tmt_rdy (void *cls, size_t size, void *buf)
350 struct GNUNET_MessageHeader *msg = buf;
353 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
354 " tmt_rdy called\n");
355 if (size < size_payload || NULL == buf)
358 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
359 "size %u, buf %p, data_sent %u, data_received %u\n",
366 msg->size = htons (size);
367 msg->type = htons ((long) cls);
368 data = (uint32_t *) &msg[1];
369 *data = htonl (data_sent);
370 if (SPEED == test && GNUNET_YES == initialized)
373 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
374 " Sent packet %d\n", data_sent);
375 if (data_sent < TOTAL_PACKETS)
377 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
378 " Scheduling packet %d\n", data_sent + 1);
379 GNUNET_SCHEDULER_add_now(&data_task, NULL);
387 * Function is called whenever a message is received.
389 * @param cls closure (set from GNUNET_MESH_connect)
390 * @param tunnel connection to the other end
391 * @param tunnel_ctx place to store local state associated with the tunnel
392 * @param message the actual message
393 * @return GNUNET_OK to keep the connection open,
394 * GNUNET_SYSERR to close it (signal serious error)
397 data_callback (void *cls, struct GNUNET_MESH_Tunnel *tunnel, void **tunnel_ctx,
398 const struct GNUNET_MessageHeader *message)
400 long client = (long) cls;
401 long expected_target_client;
406 GNUNET_MESH_receive_done (tunnel);
410 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
412 GNUNET_SCHEDULER_cancel (disconnect_task);
413 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
414 &disconnect_mesh_peers,
422 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Root client got a message!\n");
425 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
426 "Leaf client %li got a message.\n",
433 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: (%d/%d)\n", ok, ok_goal);
434 data = (uint32_t *) &message[1];
435 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " payload: (%u)\n", ntohl (*data));
436 if (SPEED == test && GNUNET_YES == test_backwards)
438 expected_target_client = 0L;
442 expected_target_client = 4L;
445 if (GNUNET_NO == initialized)
447 initialized = GNUNET_YES;
448 start_time = GNUNET_TIME_absolute_get ();
451 GNUNET_assert (4L == client);
452 GNUNET_SCHEDULER_add_now (&data_task, NULL);
457 if (client == expected_target_client) // Normally 4
460 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
461 " received data %u\n", data_received);
462 if (SPEED != test || (ok_goal - 2) == ok)
464 GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
465 GNUNET_TIME_UNIT_FOREVER_REL,
466 size_payload, &tmt_rdy, (void *) 1L);
471 if (data_received < TOTAL_PACKETS)
477 if (test == SPEED_ACK || test == SPEED)
480 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
481 " received ack %u\n", data_ack);
482 GNUNET_MESH_notify_transmit_ready (tunnel, GNUNET_NO,
483 GNUNET_TIME_UNIT_FOREVER_REL,
484 size_payload, &tmt_rdy, (void *) 1L);
485 if (data_ack < TOTAL_PACKETS && SPEED != test)
487 if (ok == 2 && SPEED == test)
491 if (test == P2P_SIGNAL)
493 GNUNET_MESH_tunnel_destroy (incoming_t);
498 GNUNET_MESH_tunnel_destroy (t);
503 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
505 GNUNET_SCHEDULER_cancel (disconnect_task);
506 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
507 &disconnect_mesh_peers,
516 * Handlers, for diverse services
518 static struct GNUNET_MESH_MessageHandler handlers[] = {
519 {&data_callback, 1, sizeof (struct GNUNET_MessageHeader)},
525 * Method called whenever another peer has added us to a tunnel
526 * the other peer initiated.
528 * @param cls Closure.
529 * @param tunnel New handle to the tunnel.
530 * @param initiator Peer that started the tunnel.
531 * @param port Port this tunnels is connected to.
532 * @return Initial tunnel context for the tunnel
533 * (can be NULL -- that's not an error).
536 incoming_tunnel (void *cls, struct GNUNET_MESH_Tunnel *tunnel,
537 const struct GNUNET_PeerIdentity *initiator,
540 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
541 "Incoming tunnel from %s to peer %d\n",
542 GNUNET_i2s (initiator), (long) cls);
544 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
545 if ((long) cls == 4L)
549 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
550 "Incoming tunnel for unknown client %lu\n", (long) cls);
553 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
555 GNUNET_SCHEDULER_cancel (disconnect_task);
556 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
557 &disconnect_mesh_peers,
565 * Function called whenever an inbound tunnel is destroyed. Should clean up
566 * any associated state.
568 * @param cls closure (set from GNUNET_MESH_connect)
569 * @param tunnel connection to the other end (henceforth invalid)
570 * @param tunnel_ctx place where local state associated
571 * with the tunnel is stored
574 tunnel_cleaner (void *cls, const struct GNUNET_MESH_Tunnel *tunnel,
579 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
580 "Incoming tunnel disconnected at peer %d\n",
587 else if (0L == i && P2P_SIGNAL == test)
593 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
594 "Unknown peer! %d\n", i);
595 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
597 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
599 GNUNET_SCHEDULER_cancel (disconnect_task);
600 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
609 * START THE TESTCASE ITSELF, AS WE ARE CONNECTED TO THE MESH SERVICES.
611 * Testcase continues when the root receives confirmation of connected peers,
612 * on callback funtion ch.
614 * @param cls Closure (unsued).
615 * @param tc Task Context.
618 do_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
623 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test_task\n");
624 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "add peer 2\n");
626 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
627 "schedule timeout in TIMEOUT\n");
628 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
630 GNUNET_SCHEDULER_cancel (disconnect_task);
632 if (SPEED_NOBUF == test)
640 if (SPEED_REL == test)
647 t = GNUNET_MESH_tunnel_create (h1, NULL, p_id[1], 1, nobuf, rel);
649 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
650 &disconnect_mesh_peers,
652 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
653 "Sending data initializer...\n");
657 GNUNET_MESH_notify_transmit_ready (t, GNUNET_NO,
658 GNUNET_TIME_UNIT_FOREVER_REL,
659 size_payload, &tmt_rdy, (void *) 1L);
663 * Callback to be called when the requested peer information is available
665 * @param cls the closure from GNUNET_TESTBED_peer_get_information()
666 * @param op the operation this callback corresponds to
667 * @param pinfo the result; will be NULL if the operation has failed
668 * @param emsg error message if the operation has failed;
669 * NULL if the operation is successfull
673 struct GNUNET_TESTBED_Operation *op,
674 const struct GNUNET_TESTBED_PeerInformation *pinfo,
679 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "id callback for %ld\n", i);
681 if (NULL == pinfo || NULL != emsg)
683 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "pi_cb: %s\n", emsg);
684 abort_test (__LINE__);
687 p_id[i] = pinfo->result.id;
688 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " id: %s\n", GNUNET_i2s (p_id[i]));
692 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got all IDs, starting test\n");
693 test_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
698 * test main: start test when all peers are connected
700 * @param cls Closure.
701 * @param ctx Argument to give to GNUNET_MESH_TEST_cleanup on test end.
702 * @param num_peers Number of peers that are running.
703 * @param peers Array of peers.
704 * @param meshes Handle to each of the MESHs of the peers.
708 struct GNUNET_MESH_TEST_Context *ctx,
709 unsigned int num_peers,
710 struct GNUNET_TESTBED_Peer **peers,
711 struct GNUNET_MESH_Handle **meshes)
713 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test main\n");
716 peers_running = num_peers;
718 h2 = meshes[num_peers - 1];
719 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
720 &disconnect_mesh_peers,
722 shutdown_handle = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
723 &shutdown_task, NULL);
724 t_op[0] = GNUNET_TESTBED_peer_get_information (peers[0],
725 GNUNET_TESTBED_PIT_IDENTITY,
726 &pi_cb, (void *) 0L);
727 t_op[1] = GNUNET_TESTBED_peer_get_information (peers[num_peers - 1],
728 GNUNET_TESTBED_PIT_IDENTITY,
729 &pi_cb, (void *) 1L);
730 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "requested peer ids\n");
738 main (int argc, char *argv[])
740 initialized = GNUNET_NO;
742 const char *config_file;
744 GNUNET_log_setup ("test", "DEBUG", NULL);
745 config_file = "test_mesh.conf";
747 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start\n");
748 if (strstr (argv[0], "_small_forward") != NULL)
750 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "FORWARD\n");
752 test_name = "unicast";
755 else if (strstr (argv[0], "_small_signal") != NULL)
757 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SIGNAL\n");
759 test_name = "signal";
762 else if (strstr (argv[0], "_small_speed_ack") != NULL)
764 /* Each peer is supposed to generate the following callbacks:
765 * 1 incoming tunnel (@dest)
766 * TOTAL_PACKETS received data packet (@dest)
767 * TOTAL_PACKETS received data packet (@orig)
768 * 1 received tunnel destroy (@dest)
769 * _________________________________
770 * 5 x ok expected per peer
772 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED_ACK\n");
774 test_name = "speed ack";
775 ok_goal = TOTAL_PACKETS * 2 + 2;
777 else if (strstr (argv[0], "_small_speed") != NULL)
779 /* Each peer is supposed to generate the following callbacks:
780 * 1 incoming tunnel (@dest)
781 * 1 initial packet (@dest)
782 * TOTAL_PACKETS received data packet (@dest)
783 * 1 received data packet (@orig)
784 * 1 received tunnel destroy (@dest)
785 * _________________________________
787 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED\n");
788 ok_goal = TOTAL_PACKETS + 4;
789 if (strstr (argv[0], "_nobuf") != NULL)
792 test_name = "speed nobuf";
794 else if (strstr (argv[0], "_reliable") != NULL)
797 test_name = "speed reliable";
798 config_file = "test_mesh_drop.conf";
808 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "UNKNOWN\n");
813 if (strstr (argv[0], "backwards") != NULL)
817 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "BACKWARDS (LEAF TO ROOT)\n");
818 test_backwards = GNUNET_YES;
819 aux = GNUNET_malloc (32);
820 sprintf (aux, "backwards %s", test_name);
827 GNUNET_MESH_TEST_run ("test_mesh_small",
831 NULL, /* tmain cls */
839 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
840 "FAILED! (%d/%d)\n", ok, ok_goal);
843 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "success\n");
847 /* end of test_mesh_small.c */