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/gnunet-mesh-profiler.c
23 * @brief Profiler for mesh experiments.
27 #include "mesh_test_lib.h"
28 #include "gnunet_mesh_service.h"
29 #include "gnunet_statistics_service.h"
36 * How namy peers to run
38 #define TOTAL_PEERS 10
41 * How long until we give up on connecting the peers?
43 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
46 * Time to wait for stuff that should be rather fast
48 #define SHORT_TIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
54 * Testbed Operation (to get peer id, etc).
56 struct GNUNET_TESTBED_Operation *op;
61 struct GNUNET_PeerIdentity id;
64 * Mesh handle for the root peer
66 struct GNUNET_MESH_Handle *mesh;
69 * Channel handle for the root peer
71 struct GNUNET_MESH_Channel *ch;
74 * Channel handle for the dest peer
76 struct GNUNET_MESH_Channel *incoming_ch;
79 * Number of payload packes sent
84 * Number of payload packets received
88 struct MeshPeer *dest;
89 struct MeshPeer *incoming;
90 GNUNET_SCHEDULER_TaskIdentifier ping_task;
91 struct GNUNET_TIME_Absolute timestamp;
95 * GNUNET_PeerIdentity -> MeshPeer
97 static struct GNUNET_CONTAINER_MultiPeerMap *ids;
100 * Testbed peer handles.
102 static struct GNUNET_TESTBED_Peer **testbed_handles;
105 * Testbed Operation (to get stats).
107 static struct GNUNET_TESTBED_Operation *stats_op;
110 * How many events have happened
115 * Number of events expected to conclude the test successfully.
120 * Size of each test packet
122 size_t size_payload = sizeof (struct GNUNET_MessageHeader) + sizeof (uint32_t);
125 * Operation to get peer ids.
127 struct MeshPeer peers[TOTAL_PEERS];
132 static unsigned int p_ids;
135 * Total number of currently running peers.
137 static unsigned long long peers_running;
140 * Test context (to shut down).
142 static struct GNUNET_MESH_TEST_Context *test_ctx;
145 * Task called to shutdown test.
147 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
150 * Task called to disconnect peers, before shutdown.
152 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
155 * Task to perform tests
157 static GNUNET_SCHEDULER_TaskIdentifier test_task;
161 * Flag to notify callbacks not to generate any new traffic anymore.
163 static int test_finished;
166 * Calculate a random delay.
168 * @param max Exclusive maximum, in ms.
170 * @return A time between 0 a max-1 ms.
172 static struct GNUNET_TIME_Relative
173 delay_ms_rnd (unsigned int max)
177 rnd = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, max);
178 return GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, rnd);
183 * Get the index of a peer in the peers array.
185 * @param peer Peer whose index to get.
187 * @return Index of peer in peers.
190 get_index (struct MeshPeer *peer)
197 * Show the results of the test (banwidth acheived) and log them to GAUGER
206 * Shut down peergroup, clean up.
208 * @param cls Closure (unused).
209 * @param tc Task Context.
212 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
214 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Ending test.\n");
215 shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
220 * Disconnect from mesh services af all peers, call shutdown.
222 * @param cls Closure (unused).
223 * @param tc Task Context.
226 disconnect_mesh_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
228 long line = (long) cls;
231 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
232 "disconnecting mesh service of peers, called from line %ld\n",
234 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
235 for (i = 0; i < TOTAL_PEERS; i++)
237 GNUNET_TESTBED_operation_done (peers[i].op);
238 GNUNET_MESH_channel_destroy (peers[i].ch);
239 GNUNET_MESH_channel_destroy (peers[i].incoming_ch);
241 GNUNET_MESH_TEST_cleanup (test_ctx);
242 if (GNUNET_SCHEDULER_NO_TASK != shutdown_handle)
244 GNUNET_SCHEDULER_cancel (shutdown_handle);
246 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
251 * Finish test normally: schedule disconnect and shutdown
253 * @param line Line in the code the abort is requested from (__LINE__).
256 abort_test (long line)
258 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
260 GNUNET_SCHEDULER_cancel (disconnect_task);
261 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
267 * Stats callback. Finish the stats testbed operation and when all stats have
268 * been iterated, shutdown the test.
271 * @param op the operation that has been finished
272 * @param emsg error message in case the operation has failed; will be NULL if
273 * operation has executed successfully.
276 stats_cont (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg)
278 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "... collecting statistics done.\n");
279 GNUNET_TESTBED_operation_done (stats_op);
281 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
282 GNUNET_SCHEDULER_cancel (disconnect_task);
283 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
290 * Process statistic values.
293 * @param peer the peer the statistic belong to
294 * @param subsystem name of subsystem that created the statistic
295 * @param name the name of the datum
296 * @param value the current value
297 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
298 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
301 stats_iterator (void *cls, const struct GNUNET_TESTBED_Peer *peer,
302 const char *subsystem, const char *name,
303 uint64_t value, int is_persistent)
307 i = GNUNET_TESTBED_get_index (peer);
308 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " STATS %u - %s [%s]: %llu\n",
309 i, subsystem, name, value);
316 * Task check that keepalives were sent and received.
318 * @param cls Closure (NULL).
319 * @param tc Task Context.
322 collect_stats (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
324 if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
327 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
328 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Start collecting statistics...\n");
329 stats_op = GNUNET_TESTBED_get_statistics (TOTAL_PEERS, testbed_handles,
331 stats_iterator, stats_cont, NULL);
336 * @brief Finish profiler normally.
338 * @param cls Closure (unused).
339 * @param tc Task context.
342 finish_profiler (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
344 if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
347 test_finished = GNUNET_YES;
349 GNUNET_SCHEDULER_add_now (&collect_stats, NULL);
355 * Transmit ready callback.
357 * @param cls Closure (peer for PING, NULL for PONG).
358 * @param size Size of the tranmist buffer.
359 * @param buf Pointer to the beginning of the buffer.
361 * @return Number of bytes written to buf.
364 tmt_rdy (void *cls, size_t size, void *buf);
368 * @brief Send a ping to destination
370 * @param cls Closure (peer).
371 * @param tc Task context.
374 ping (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
376 struct MeshPeer *peer = (struct MeshPeer *) cls;
378 peer->ping_task = GNUNET_SCHEDULER_NO_TASK;
379 if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0
380 || GNUNET_YES == test_finished)
383 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "%u -> %u\n",
384 get_index (peer), get_index (peer->dest));
386 GNUNET_MESH_notify_transmit_ready (peer->ch, GNUNET_NO,
387 GNUNET_TIME_UNIT_FOREVER_REL,
388 size_payload, &tmt_rdy, peer);
392 * @brief Reply with a pong to origin.
394 * @param cls Closure (peer).
395 * @param tc Task context.
398 pong (struct GNUNET_MESH_Channel *channel)
400 GNUNET_MESH_notify_transmit_ready (channel, GNUNET_NO,
401 GNUNET_TIME_UNIT_FOREVER_REL,
402 size_payload, &tmt_rdy, NULL);
407 * Transmit ready callback
409 * @param cls Closure (peer for PING, NULL for PONG).
410 * @param size Size of the buffer we have.
411 * @param buf Buffer to copy data to.
414 tmt_rdy (void *cls, size_t size, void *buf)
416 struct MeshPeer *peer = (struct MeshPeer *) cls;
417 struct GNUNET_MessageHeader *msg = buf;
421 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "tmt_rdy called, filling buffer\n");
422 if (size < size_payload || NULL == buf)
425 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
426 "size %u, buf %p, data_sent %u, data_received %u\n",
427 size, buf, peer->data_sent, peer->data_received);
431 msg->size = htons (size);
434 msg->type = htons (PONG);
435 return sizeof (*msg);
438 msg->type = htons (PING);
439 data = (uint32_t *) &msg[1];
440 *data = htonl (peer->data_sent);
441 if (0 == peer->data_sent)
443 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sent: initializer\n");
448 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sent: msg %d\n", peer->data_sent);
452 peer->timestamp = GNUNET_TIME_absolute_get ();
453 peer->ping_task = GNUNET_SCHEDULER_add_delayed (delay_ms_rnd (s * 1000),
461 * Function is called whenever a PING message is received.
463 * @param cls closure (peer #, set from GNUNET_MESH_connect)
464 * @param channel connection to the other end
465 * @param channel_ctx place to store local state associated with the channel
466 * @param message the actual message
467 * @return GNUNET_OK to keep the connection open,
468 * GNUNET_SYSERR to close it (signal serious error)
471 ping_handler (void *cls, struct GNUNET_MESH_Channel *channel,
473 const struct GNUNET_MessageHeader *message)
477 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%u got PING\n", n);
478 GNUNET_MESH_receive_done (channel);
479 if (GNUNET_NO == test_finished)
487 * Function is called whenever a PONG message is received.
489 * @param cls closure (peer #, set from GNUNET_MESH_connect)
490 * @param channel connection to the other end
491 * @param channel_ctx place to store local state associated with the channel
492 * @param message the actual message
493 * @return GNUNET_OK to keep the connection open,
494 * GNUNET_SYSERR to close it (signal serious error)
497 pong_handler (void *cls, struct GNUNET_MESH_Channel *channel,
499 const struct GNUNET_MessageHeader *message)
502 struct MeshPeer *peer;
503 struct GNUNET_TIME_Relative latency;
505 GNUNET_MESH_receive_done (channel);
508 GNUNET_assert (0 != peer->timestamp.abs_value_us);
509 latency = GNUNET_TIME_absolute_get_duration (peer->incoming->timestamp);
510 FPRINTF (stderr, "%u -> %ld latency: %s\n",
511 get_index (peer->incoming), n,
512 GNUNET_STRINGS_relative_time_to_string (latency, GNUNET_NO));
513 peer->timestamp.abs_value_us = 0;
520 * Handlers, for diverse services
522 static struct GNUNET_MESH_MessageHandler handlers[] = {
523 {&ping_handler, PING, sizeof (struct GNUNET_MessageHeader)},
524 {&pong_handler, PONG, sizeof (struct GNUNET_MessageHeader)},
530 * Method called whenever another peer has added us to a channel
531 * the other peer initiated.
533 * @param cls Closure.
534 * @param channel New handle to the channel.
535 * @param initiator Peer that started the channel.
536 * @param port Port this channel is connected to.
537 * @param options channel option flags
538 * @return Initial channel context for the channel
539 * (can be NULL -- that's not an error).
542 incoming_channel (void *cls, struct GNUNET_MESH_Channel *channel,
543 const struct GNUNET_PeerIdentity *initiator,
544 uint32_t port, enum GNUNET_MESH_ChannelOption options)
547 struct MeshPeer *peer;
549 peer = GNUNET_CONTAINER_multipeermap_get (ids, initiator);
550 GNUNET_assert (NULL != peer);
551 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "%u <= %u\n", n, get_index (peer));
552 peers[n].incoming_ch = channel;
554 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
556 GNUNET_SCHEDULER_cancel (disconnect_task);
557 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
558 &disconnect_mesh_peers,
566 * Function called whenever an inbound channel is destroyed. Should clean up
567 * any associated state.
569 * @param cls closure (set from GNUNET_MESH_connect)
570 * @param channel connection to the other end (henceforth invalid)
571 * @param channel_ctx place where local state associated
572 * with the channel is stored
575 channel_cleaner (void *cls, const struct GNUNET_MESH_Channel *channel,
580 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
581 "Incoming channel disconnected at peer %ld\n", n);
582 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
584 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
586 GNUNET_SCHEDULER_cancel (disconnect_task);
587 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_mesh_peers,
593 static struct MeshPeer *
594 select_random_peer (struct MeshPeer *peer)
600 r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, TOTAL_PEERS);
601 } while (NULL != peers[r].incoming);
602 peers[r].incoming = peer;
608 * START THE TESTCASE ITSELF, AS WE ARE CONNECTED TO THE MESH SERVICES.
610 * Testcase continues when the root receives confirmation of connected peers,
611 * on callback funtion ch.
613 * @param cls Closure (unsued).
614 * @param tc Task Context.
617 do_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
619 enum GNUNET_MESH_ChannelOption flags;
622 if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
625 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Start profiler\n");
627 if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
628 GNUNET_SCHEDULER_cancel (disconnect_task);
629 disconnect_task = GNUNET_SCHEDULER_add_delayed (SHORT_TIME,
630 &disconnect_mesh_peers,
633 flags = GNUNET_MESH_OPTION_DEFAULT;
634 for (i = 0; i < TOTAL_PEERS; i++)
637 peers[i].dest = select_random_peer (&peers[i]);
638 peers[i].ch = GNUNET_MESH_channel_create (peers[i].mesh, NULL,
641 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "%u => %u\n",
642 i, get_index (peers[i].dest));
643 peers[i].ping_task = GNUNET_SCHEDULER_add_delayed (delay_ms_rnd (2000),
650 * Callback to be called when the requested peer information is available
652 * @param cls the closure from GNUNET_TESTBED_peer_get_information()
653 * @param op the operation this callback corresponds to
654 * @param pinfo the result; will be NULL if the operation has failed
655 * @param emsg error message if the operation has failed;
656 * NULL if the operation is successfull
659 peer_id_cb (void *cls,
660 struct GNUNET_TESTBED_Operation *op,
661 const struct GNUNET_TESTBED_PeerInformation *pinfo,
666 if (NULL == pinfo || NULL != emsg)
668 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "pi_cb: %s\n", emsg);
669 abort_test (__LINE__);
672 peers[n].id = *(pinfo->result.id);
673 GNUNET_log (GNUNET_ERROR_TYPE_INFO, " %u id: %s\n",
674 n, GNUNET_i2s (&peers[n].id));
675 GNUNET_break (GNUNET_OK ==
676 GNUNET_CONTAINER_multipeermap_put (ids, &peers[n].id, &peers[n],
677 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
679 if (p_ids < TOTAL_PEERS)
681 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Got all IDs, starting profiler\n");
682 test_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
687 * test main: start test when all peers are connected
689 * @param cls Closure.
690 * @param ctx Argument to give to GNUNET_MESH_TEST_cleanup on test end.
691 * @param num_peers Number of peers that are running.
692 * @param testbed_peers Array of peers.
693 * @param meshes Handle to each of the MESHs of the peers.
697 struct GNUNET_MESH_TEST_Context *ctx,
698 unsigned int num_peers,
699 struct GNUNET_TESTBED_Peer **testbed_peers,
700 struct GNUNET_MESH_Handle **meshes)
704 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test main\n");
707 GNUNET_assert (TOTAL_PEERS == num_peers);
708 peers_running = num_peers;
709 testbed_handles = testbed_peers;
710 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
711 &finish_profiler, NULL);
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 for (i = 0; i < TOTAL_PEERS; i++)
719 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "requesting id %ld\n", i);
720 peers[i].mesh = meshes[i];
722 GNUNET_TESTBED_peer_get_information (testbed_handles[i],
723 GNUNET_TESTBED_PIT_IDENTITY,
724 &peer_id_cb, (void *) i);
726 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "requested peer ids\n");
727 /* Continues from pi_cb -> do_test */
732 * Main: start profiler.
735 main (int argc, char *argv[])
737 static uint32_t ports[2];
738 const char *config_file;
740 config_file = "test_mesh.conf";
742 ids = GNUNET_CONTAINER_multipeermap_create (2 * TOTAL_PEERS, GNUNET_YES);
743 GNUNET_assert (NULL != ids);
745 test_finished = GNUNET_NO;
748 GNUNET_MESH_TEST_run ("mesh-profiler", config_file, TOTAL_PEERS,
749 &tmain, NULL, /* tmain cls */
750 &incoming_channel, &channel_cleaner,
755 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
756 "FAILED! (%d/%d)\n", ok, ok_goal);
759 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "success\n");
763 /* end of gnunet-mesh-profiler.c */