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_enc.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 channel (@dest)
81 * 1 connected peer (@orig)
82 * 1 received data packet (@dest)
83 * 1 received data packet (@orig)
84 * 1 received channel 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 * Channel handle for the root peer
169 static struct GNUNET_MESH_Channel *ch;
172 * Channel handle for the dest peer
174 static struct GNUNET_MESH_Channel *incoming_ch;
177 * Time we started the data transmission (after channel 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 %s\n",
196 GNUNET_STRINGS_relative_time_to_string (total_time,
198 FPRINTF (stderr, "Test bandwidth: %f kb/s\n",
199 4 * TOTAL_PACKETS * 1.0 / (total_time.rel_value_us / 1000)); // 4bytes * ms
200 FPRINTF (stderr, "Test throughput: %f packets/s\n\n",
201 TOTAL_PACKETS * 1000.0 / (total_time.rel_value_us / 1000)); // packets * ms
202 GAUGER ("MESH", test_name,
203 TOTAL_PACKETS * 1000.0 / (total_time.rel_value_us / 1000),
209 * Shut down peergroup, clean up.
211 * @param cls Closure (unused).
212 * @param tc Task Context.
215 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
217 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending test.\n");
218 shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
223 * Disconnect from mesh services af all peers, call shutdown.
225 * @param cls Closure (unused).
226 * @param tc Task Context.
229 disconnect_mesh_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
231 long line = (long) cls;
234 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
235 "disconnecting mesh service of peers, called from line %ld\n",
237 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
238 for (i = 0; i < 2; i++)
240 GNUNET_TESTBED_operation_done (t_op[i]);
244 GNUNET_MESH_channel_destroy (ch);
247 if (NULL != incoming_ch)
249 GNUNET_MESH_channel_destroy (incoming_ch);
252 GNUNET_MESH_TEST_cleanup (test_ctx);
253 if (GNUNET_SCHEDULER_NO_TASK != shutdown_handle)
255 GNUNET_SCHEDULER_cancel (shutdown_handle);
257 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
262 * Abort test: schedule disconnect and shutdown immediately
264 * @param line Line in the code the abort is requested from (__LINE__).
267 abort_test (long line)
269 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
271 GNUNET_SCHEDULER_cancel (disconnect_task);
272 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
278 * Transmit ready callback.
280 * @param cls Closure (message type).
281 * @param size Size of the tranmist buffer.
282 * @param buf Pointer to the beginning of the buffer.
284 * @return Number of bytes written to buf.
287 tmt_rdy (void *cls, size_t size, void *buf);
291 * Task to schedule a new data transmission.
293 * @param cls Closure (peer #).
294 * @param tc Task Context.
297 data_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
299 struct GNUNET_MESH_TransmitHandle *th;
300 struct GNUNET_MESH_Channel *channel;
302 if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Data task\n");
306 if (GNUNET_YES == test_backwards)
308 channel = incoming_ch;
314 th = GNUNET_MESH_notify_transmit_ready (channel, GNUNET_NO,
315 GNUNET_TIME_UNIT_FOREVER_REL,
316 size_payload, &tmt_rdy, (void *) 1L);
319 unsigned long i = (unsigned long) cls;
321 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Retransmission\n");
324 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " in 1 ms\n");
325 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MILLISECONDS,
326 &data_task, (void *)1UL);
331 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "in %u ms\n", i);
332 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(
333 GNUNET_TIME_UNIT_MILLISECONDS,
335 &data_task, (void *)i);
342 * Transmit ready callback
344 * @param cls Closure (message type).
345 * @param size Size of the buffer we have.
346 * @param buf Buffer to copy data to.
349 tmt_rdy (void *cls, size_t size, void *buf)
351 struct GNUNET_MessageHeader *msg = buf;
354 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
355 "tmt_rdy called, filling buffer\n");
356 if (size < size_payload || NULL == buf)
359 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
360 "size %u, buf %p, data_sent %u, data_received %u\n",
367 msg->size = htons (size);
368 msg->type = htons ((long) cls);
369 data = (uint32_t *) &msg[1];
370 *data = htonl (data_sent);
371 if (GNUNET_NO == initialized)
373 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
374 "sending initializer\n");
376 else if (SPEED == test)
379 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
380 " Sent packet %d\n", data_sent);
381 if (data_sent < TOTAL_PACKETS)
383 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
384 " Scheduling packet %d\n", data_sent + 1);
385 GNUNET_SCHEDULER_add_now (&data_task, NULL);
394 * Function is called whenever a message is received.
396 * @param cls closure (set from GNUNET_MESH_connect)
397 * @param channel connection to the other end
398 * @param channel_ctx place to store local state associated with the channel
399 * @param message the actual message
400 * @return GNUNET_OK to keep the connection open,
401 * GNUNET_SYSERR to close it (signal serious error)
404 data_callback (void *cls, struct GNUNET_MESH_Channel *channel,
406 const struct GNUNET_MessageHeader *message)
408 long client = (long) cls;
409 long expected_target_client;
414 GNUNET_MESH_receive_done (channel);
418 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
420 GNUNET_SCHEDULER_cancel (disconnect_task);
421 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
422 &disconnect_mesh_peers,
430 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Root client got a message!\n");
433 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
434 "Leaf client %li got a message.\n",
441 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: (%d/%d)\n", ok, ok_goal);
442 data = (uint32_t *) &message[1];
443 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " payload: (%u)\n", ntohl (*data));
444 if (SPEED == test && GNUNET_YES == test_backwards)
446 expected_target_client = 0L;
450 expected_target_client = 4L;
453 if (GNUNET_NO == initialized)
455 initialized = GNUNET_YES;
456 start_time = GNUNET_TIME_absolute_get ();
459 GNUNET_assert (4L == client);
460 GNUNET_SCHEDULER_add_now (&data_task, NULL);
465 if (client == expected_target_client) // Normally 4
468 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
469 " received data %u\n", data_received);
470 if (SPEED != test || (ok_goal - 2) == ok)
472 GNUNET_MESH_notify_transmit_ready (channel, GNUNET_NO,
473 GNUNET_TIME_UNIT_FOREVER_REL,
474 size_payload, &tmt_rdy, (void *) 1L);
479 if (data_received < TOTAL_PACKETS)
485 if (test == SPEED_ACK || test == SPEED)
488 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
489 " received ack %u\n", data_ack);
490 GNUNET_MESH_notify_transmit_ready (channel, GNUNET_NO,
491 GNUNET_TIME_UNIT_FOREVER_REL,
492 size_payload, &tmt_rdy, (void *) 1L);
493 if (data_ack < TOTAL_PACKETS && SPEED != test)
495 if (ok == 2 && SPEED == test)
499 if (test == P2P_SIGNAL)
501 GNUNET_MESH_channel_destroy (incoming_ch);
506 GNUNET_MESH_channel_destroy (ch);
511 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
513 GNUNET_SCHEDULER_cancel (disconnect_task);
514 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
515 &disconnect_mesh_peers,
524 * Handlers, for diverse services
526 static struct GNUNET_MESH_MessageHandler handlers[] = {
527 {&data_callback, 1, sizeof (struct GNUNET_MessageHeader)},
533 * Method called whenever another peer has added us to a channel
534 * the other peer initiated.
536 * @param cls Closure.
537 * @param channel New handle to the channel.
538 * @param initiator Peer that started the channel.
539 * @param port Port this channel is connected to.
540 * @return Initial channel context for the channel
541 * (can be NULL -- that's not an error).
544 incoming_channel (void *cls, struct GNUNET_MESH_Channel *channel,
545 const struct GNUNET_PeerIdentity *initiator,
548 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
549 "Incoming channel from %s to peer %d\n",
550 GNUNET_i2s (initiator), (long) cls);
552 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
553 if ((long) cls == 4L)
554 incoming_ch = channel;
557 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
558 "Incoming channel for unknown client %lu\n", (long) cls);
561 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
563 GNUNET_SCHEDULER_cancel (disconnect_task);
564 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
565 &disconnect_mesh_peers,
573 * Function called whenever an inbound channel is destroyed. Should clean up
574 * any associated state.
576 * @param cls closure (set from GNUNET_MESH_connect)
577 * @param channel connection to the other end (henceforth invalid)
578 * @param channel_ctx place where local state associated
579 * with the channel is stored
582 channel_cleaner (void *cls, const struct GNUNET_MESH_Channel *channel,
587 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
588 "Incoming channel disconnected at peer %d\n",
595 else if (0L == i && P2P_SIGNAL == test)
601 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
602 "Unknown peer! %d\n", i);
603 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
605 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
607 GNUNET_SCHEDULER_cancel (disconnect_task);
608 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
617 * START THE TESTCASE ITSELF, AS WE ARE CONNECTED TO THE MESH SERVICES.
619 * Testcase continues when the root receives confirmation of connected peers,
620 * on callback funtion ch.
622 * @param cls Closure (unsued).
623 * @param tc Task Context.
626 do_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
631 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test_task\n");
632 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "add peer 2\n");
634 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
635 "schedule timeout in TIMEOUT\n");
636 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
638 GNUNET_SCHEDULER_cancel (disconnect_task);
640 if (SPEED_NOBUF == test)
648 if (SPEED_REL == test)
655 ch = GNUNET_MESH_channel_create (h1, NULL, p_id[1], 1, nobuf, rel);
657 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
658 &disconnect_mesh_peers,
660 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
661 "Sending data initializer...\n");
665 GNUNET_MESH_notify_transmit_ready (ch, GNUNET_NO,
666 GNUNET_TIME_UNIT_FOREVER_REL,
667 size_payload, &tmt_rdy, (void *) 1L);
671 * Callback to be called when the requested peer information is available
673 * @param cls the closure from GNUNET_TESTBED_peer_get_information()
674 * @param op the operation this callback corresponds to
675 * @param pinfo the result; will be NULL if the operation has failed
676 * @param emsg error message if the operation has failed;
677 * NULL if the operation is successfull
681 struct GNUNET_TESTBED_Operation *op,
682 const struct GNUNET_TESTBED_PeerInformation *pinfo,
687 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "id callback for %ld\n", i);
689 if (NULL == pinfo || NULL != emsg)
691 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "pi_cb: %s\n", emsg);
692 abort_test (__LINE__);
695 p_id[i] = pinfo->result.id;
696 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " id: %s\n", GNUNET_i2s (p_id[i]));
700 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got all IDs, starting test\n");
701 test_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
706 * test main: start test when all peers are connected
708 * @param cls Closure.
709 * @param ctx Argument to give to GNUNET_MESH_TEST_cleanup on test end.
710 * @param num_peers Number of peers that are running.
711 * @param peers Array of peers.
712 * @param meshes Handle to each of the MESHs of the peers.
716 struct GNUNET_MESH_TEST_Context *ctx,
717 unsigned int num_peers,
718 struct GNUNET_TESTBED_Peer **peers,
719 struct GNUNET_MESH_Handle **meshes)
721 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test main\n");
724 peers_running = num_peers;
726 h2 = meshes[num_peers - 1];
727 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
728 &disconnect_mesh_peers,
730 shutdown_handle = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
731 &shutdown_task, NULL);
732 t_op[0] = GNUNET_TESTBED_peer_get_information (peers[0],
733 GNUNET_TESTBED_PIT_IDENTITY,
734 &pi_cb, (void *) 0L);
735 t_op[1] = GNUNET_TESTBED_peer_get_information (peers[num_peers - 1],
736 GNUNET_TESTBED_PIT_IDENTITY,
737 &pi_cb, (void *) 1L);
738 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "requested peer ids\n");
746 main (int argc, char *argv[])
748 initialized = GNUNET_NO;
750 const char *config_file;
752 GNUNET_log_setup ("test", "DEBUG", NULL);
753 config_file = "test_mesh.conf";
755 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start\n");
756 if (strstr (argv[0], "_small_forward") != NULL)
758 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "FORWARD\n");
760 test_name = "unicast";
763 else if (strstr (argv[0], "_small_signal") != NULL)
765 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SIGNAL\n");
767 test_name = "signal";
770 else if (strstr (argv[0], "_small_speed_ack") != NULL)
772 /* Each peer is supposed to generate the following callbacks:
773 * 1 incoming channel (@dest)
774 * TOTAL_PACKETS received data packet (@dest)
775 * TOTAL_PACKETS received data packet (@orig)
776 * 1 received channel destroy (@dest)
777 * _________________________________
778 * 5 x ok expected per peer
780 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED_ACK\n");
782 test_name = "speed ack";
783 ok_goal = TOTAL_PACKETS * 2 + 2;
785 else if (strstr (argv[0], "_small_speed") != NULL)
787 /* Each peer is supposed to generate the following callbacks:
788 * 1 incoming channel (@dest)
789 * 1 initial packet (@dest)
790 * TOTAL_PACKETS received data packet (@dest)
791 * 1 received data packet (@orig)
792 * 1 received channel destroy (@dest)
793 * _________________________________
795 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "SPEED\n");
796 ok_goal = TOTAL_PACKETS + 4;
797 if (strstr (argv[0], "_nobuf") != NULL)
800 test_name = "speed nobuf";
802 else if (strstr (argv[0], "_reliable") != NULL)
805 test_name = "speed reliable";
806 config_file = "test_mesh_drop.conf";
816 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "UNKNOWN\n");
821 if (strstr (argv[0], "backwards") != NULL)
825 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "BACKWARDS (LEAF TO ROOT)\n");
826 test_backwards = GNUNET_YES;
827 aux = GNUNET_malloc (32);
828 sprintf (aux, "backwards %s", test_name);
835 GNUNET_MESH_TEST_run ("test_mesh_small",
839 NULL, /* tmain cls */
847 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
848 "FAILED! (%d/%d)\n", ok, ok_goal);
851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "success\n");
855 /* end of test_mesh_small.c */