profiling tool for gnunet-consensus More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_time_lib.h"
#include "gnunet_consensus_service.h"
#include "gnunet_testbed_service.h"

Include dependency graph for gnunet-consensus-profiler.c:

Functions
static void	controller_cb (void cls, const struct GNUNET_TESTBED_EventInformation event)
	Signature of the event handler function called by the respective event controller. More...

static void	statistics_done_cb (void cls, struct GNUNET_TESTBED_Operation op, const char *emsg)

static int	statistics_cb (void cls, const struct GNUNET_TESTBED_Peer peer, const char subsystem, const char name, uint64_t value, int is_persistent)
	Callback function to process statistic values from all peers. More...

static void	destroy (void *cls)

static void	conclude_cb (void *cls)
	Called when a conclusion was successful. More...

static void	generate_indices (int *indices)

static void	do_consensus ()

static void	connect_complete (void cls, struct GNUNET_TESTBED_Operation op, void ca_result, const char emsg)
	Callback to be called when a service connect operation is completed. More...

static void	new_element_cb (void cls, const struct GNUNET_SET_Element element)

static void *	connect_adapter (void cls, const struct GNUNET_CONFIGURATION_Handle cfg)
	Adapter function called to establish a connection to a service. More...

static void	disconnect_adapter (void cls, void op_result)
	Adapter function called to destroy a connection to a service. More...

static void	peer_info_cb (void cb_cls, struct GNUNET_TESTBED_Operation op, const struct GNUNET_TESTBED_PeerInformation pinfo, const char emsg)
	Callback to be called when the requested peer information is available. More...

static void	test_master (void cls, struct GNUNET_TESTBED_RunHandle h, unsigned int num_peers, struct GNUNET_TESTBED_Peer **started_peers, unsigned int links_succeeded, unsigned int links_failed)
	Signature of a main function for a testcase. More...

static void	run (void cls, char const args, const char cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)

int	main (int argc, char **argv)

Variables
static unsigned int	num_peers = 2

static unsigned int	replication = 1

static unsigned int	num_values = 5

static struct GNUNET_TIME_Relative	conclude_timeout

static struct GNUNET_TIME_Relative	consensus_delay

static struct GNUNET_CONSENSUS_Handle **	consensus_handles

static struct GNUNET_TESTBED_Operation **	testbed_operations

static unsigned int	num_connected_handles

static struct GNUNET_TESTBED_Peer **	peers

static struct GNUNET_PeerIdentity *	peer_ids

static unsigned int	num_retrieved_peer_ids

static struct GNUNET_HashCode	session_id

static unsigned int	peers_done = 0

static int	dist_static

static unsigned *	results_for_peer

static char *	statistics_filename
	The profiler will write statistics for all peers to the file with this name. More...

static FILE *	statistics_file
	The profiler will write statistics for all peers to this file. More...

static int	verbose

static struct GNUNET_TIME_Absolute	start
	Start time for all consensuses. More...

static struct GNUNET_TIME_Absolute	deadline
	Deadline for all consensuses. More...

Detailed Description

profiling tool for gnunet-consensus

Author: Florian Dold

Definition in file gnunet-consensus-profiler.c.

Function Documentation

◆ controller_cb()

static void controller_cb	(	void *	cls,
		const struct GNUNET_TESTBED_EventInformation *	event
	)

static

Signature of the event handler function called by the respective event controller.

Parameters

cls	closure
event	information about the event

Definition at line 95 of file gnunet-consensus-profiler.c.

 {
   GNUNET_assert (0);
 }

References GNUNET_assert.

Referenced by run().

Here is the caller graph for this function:

◆ statistics_done_cb()

static void statistics_done_cb	(	void *	cls,
		struct GNUNET_TESTBED_Operation *	op,
		const char *	emsg
	)

static

Definition at line 103 of file gnunet-consensus-profiler.c.

 {
   GNUNET_assert (NULL == emsg);
   GNUNET_TESTBED_operation_done (op);
   if (NULL != statistics_file)
     fclose (statistics_file);
   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "got statistics, shutting down\n");
   GNUNET_SCHEDULER_shutdown ();
 }

References GNUNET_assert, GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_SCHEDULER_shutdown(), GNUNET_TESTBED_operation_done(), op, and statistics_file.

Referenced by destroy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ statistics_cb()

static int statistics_cb	(	void *	cls,
		const struct GNUNET_TESTBED_Peer *	peer,
		const char *	subsystem,
		const char *	name,
		uint64_t	value,
		int	is_persistent
	)

static

Callback function to process statistic values from all peers.

Parameters

cls	closure
peer	the peer the statistic belong to
subsystem	name of subsystem that created the statistic
name	the name of the datum
value	the current value
is_persistent	GNUNET_YES if the value is persistent, GNUNET_NO if not

Returns: GNUNET_OK to continue, GNUNET_SYSERR to abort iteration

Definition at line 130 of file gnunet-consensus-profiler.c.

 {
   if (NULL != statistics_file)
   {
     fprintf (statistics_file, "P%u\t%s\t%s\t%lu\n", GNUNET_TESTBED_get_index (
                peer), subsystem, name, (unsigned long) value);
   }
   return GNUNET_OK;
 }

References GNUNET_OK, GNUNET_TESTBED_get_index(), name, peer, statistics_file, subsystem, and value.

Referenced by destroy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ destroy()

static void destroy ( void * cls )

static

Definition at line 147 of file gnunet-consensus-profiler.c.

 {
   struct GNUNET_CONSENSUS_Handle *consensus = cls;
  
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
               "destroying consensus\n");
   GNUNET_CONSENSUS_destroy (consensus);
   peers_done++;
   if (peers_done == num_peers)
   {
     unsigned int i;
     for (i = 0; i < num_peers; i++)
       GNUNET_TESTBED_operation_done (testbed_operations[i]);
     for (i = 0; i < num_peers; i++)
       printf ("P%u got %u of %u elements\n",
               i,
               results_for_peer[i],
               num_values);
     if (NULL != statistics_filename)
       statistics_file = fopen (statistics_filename, "w");
     GNUNET_TESTBED_get_statistics (num_peers, peers, NULL, NULL,
                                    statistics_cb,
                                    statistics_done_cb,
                                    NULL);
   }
 }

References GNUNET_CONSENSUS_destroy(), GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_TESTBED_get_statistics(), GNUNET_TESTBED_operation_done(), num_peers, num_values, peers, peers_done, results_for_peer, statistics_cb(), statistics_done_cb(), statistics_file, statistics_filename, and testbed_operations.

Referenced by conclude_cb(), GNUNET_MQ_queue_for_callbacks(), and GNUNET_SERVER_set_callbacks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ conclude_cb()

static void conclude_cb ( void * cls )

static

Called when a conclusion was successful.

Parameters

cls	closure, the consensus handle

Returns: GNUNET_YES if more consensus groups should be offered, GNUNET_NO if not

Definition at line 183 of file gnunet-consensus-profiler.c.

 {
   struct GNUNET_CONSENSUS_Handle **chp = cls;
  
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
               "consensus %d done\n",
               (int) (chp - consensus_handles));
   GNUNET_SCHEDULER_add_now (destroy, *chp);
 }

References consensus_handles, destroy(), GNUNET_ERROR_TYPE_INFO, GNUNET_log, and GNUNET_SCHEDULER_add_now().

Referenced by do_consensus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generate_indices()

static void generate_indices ( int * indices )

static

Definition at line 195 of file gnunet-consensus-profiler.c.

 {
   int j;
  
   j = 0;
   while (j < replication)
   {
     int n;
     int k;
     int repeat;
     n = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, num_peers);
     repeat = GNUNET_NO;
     for (k = 0; k < j; k++)
       if (indices[k] == n)
       {
         repeat = GNUNET_YES;
         break;
       }
     if (GNUNET_NO == repeat)
       indices[j++] = n;
   }
 }

References GNUNET_CRYPTO_QUALITY_WEAK, GNUNET_CRYPTO_random_u32(), GNUNET_NO, GNUNET_YES, num_peers, and replication.

Referenced by do_consensus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ do_consensus()

static void do_consensus ( )

static

Definition at line 220 of file gnunet-consensus-profiler.c.

 {
   int unique_indices[replication];
   unsigned int i;
   unsigned int j;
   struct GNUNET_HashCode val;
   struct GNUNET_SET_Element element;
  
   if (dist_static)
   {
     for (i = 0; i < num_values; i++)
     {
       GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_WEAK, &val);
  
       element.data = &val;
       element.size = sizeof(val);
       for (j = 0; j < replication; j++)
       {
         GNUNET_CONSENSUS_insert (consensus_handles[j],
                                  &element,
                                  NULL, NULL);
       }
     }
   }
   else
   {
     for (i = 0; i < num_values; i++)
     {
       generate_indices (unique_indices);
       GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_WEAK, &val);
  
       element.data = &val;
       element.size = sizeof(val);
       for (j = 0; j < replication; j++)
       {
         int cid;
  
         cid = unique_indices[j];
         GNUNET_CONSENSUS_insert (consensus_handles[cid],
                                  &element,
                                  NULL, NULL);
       }
     }
   }
  
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
               "all elements inserted, calling conclude\n");
  
   for (i = 0; i < num_peers; i++)
     GNUNET_CONSENSUS_conclude (consensus_handles[i],
                                conclude_cb, &consensus_handles[i]);
 }

References conclude_cb(), consensus_handles, GNUNET_SET_Element::data, dist_static, generate_indices(), GNUNET_CONSENSUS_conclude(), GNUNET_CONSENSUS_insert(), GNUNET_CRYPTO_hash_create_random(), GNUNET_CRYPTO_QUALITY_WEAK, GNUNET_ERROR_TYPE_INFO, GNUNET_log, num_peers, num_values, replication, and GNUNET_SET_Element::size.

Referenced by connect_complete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ connect_complete()

static void connect_complete	(	void *	cls,
		struct GNUNET_TESTBED_Operation *	op,
		void *	ca_result,
		const char *	emsg
	)

static

Callback to be called when a service connect operation is completed.

Parameters

cls	the callback closure from functions generating an operation
op	the operation that has been finished
ca_result	the service handle returned from GNUNET_TESTBED_ConnectAdapter()
emsg	error message in case the operation has failed; will be NULL if operation has executed successfully.

Definition at line 284 of file gnunet-consensus-profiler.c.

 {
   if (NULL != emsg)
   {
     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                 "testbed connect emsg: %s\n",
                 emsg);
     GNUNET_assert (0);
   }
  
   num_connected_handles++;
  
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
               "connect complete\n");
  
   if (num_connected_handles == num_peers)
   {
     do_consensus ();
   }
 }

References do_consensus(), GNUNET_assert, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_log, num_connected_handles, and num_peers.

Referenced by peer_info_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ new_element_cb()

static void new_element_cb	(	void *	cls,
		const struct GNUNET_SET_Element *	element
	)

static

Definition at line 310 of file gnunet-consensus-profiler.c.

 {
   struct GNUNET_CONSENSUS_Handle **chp = cls;
   int idx = chp - consensus_handles;
  
   GNUNET_assert (NULL != cls);
  
   results_for_peer[idx]++;
  
   GNUNET_assert (sizeof(struct GNUNET_HashCode) == element->size);
  
   if (GNUNET_YES == verbose)
   {
     printf ("P%d received %s\n",
             idx,
             GNUNET_h2s ((struct GNUNET_HashCode *) element->data));
   }
 }

References consensus_handles, GNUNET_SET_Element::data, GNUNET_assert, GNUNET_h2s(), GNUNET_YES, results_for_peer, GNUNET_SET_Element::size, and verbose.

Referenced by connect_adapter(), and GNUNET_CONSENSUS_create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ connect_adapter()

static void* connect_adapter	(	void *	cls,
		const struct GNUNET_CONFIGURATION_Handle *	cfg
	)

static

Adapter function called to establish a connection to a service.

Parameters

cls	closure
cfg	configuration of the peer to connect to; will be available until GNUNET_TESTBED_operation_done() is called on the operation returned from GNUNET_TESTBED_service_connect()

Returns: service handle to return in 'op_result', NULL on error

Definition at line 342 of file gnunet-consensus-profiler.c.

 {
   struct GNUNET_CONSENSUS_Handle **chp = cls;
   struct GNUNET_CONSENSUS_Handle *consensus;
  
   chp = (struct GNUNET_CONSENSUS_Handle **) cls;
  
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
               "connect adapter, %d peers\n",
               num_peers);
   consensus = GNUNET_CONSENSUS_create (cfg,
                                        num_peers, peer_ids,
                                        &session_id,
                                        start,
                                        deadline,
                                        &new_element_cb, chp);
   *chp = (struct GNUNET_CONSENSUS_Handle *) consensus;
   return consensus;
 }

References cfg, deadline, GNUNET_CONSENSUS_create(), GNUNET_ERROR_TYPE_INFO, GNUNET_log, new_element_cb(), num_peers, peer_ids, session_id, and start.

Referenced by peer_info_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disconnect_adapter()

static void disconnect_adapter	(	void *	cls,
		void *	op_result
	)

static

Adapter function called to destroy a connection to a service.

Parameters

cls	closure
op_result	service handle returned from the connect adapter

Definition at line 372 of file gnunet-consensus-profiler.c.

 {
   /* FIXME: what to do here? */
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
               "disconnect adapter called\n");
 }

References GNUNET_ERROR_TYPE_INFO, and GNUNET_log.

Referenced by peer_info_cb().

Here is the caller graph for this function:

◆ peer_info_cb()

static void peer_info_cb	(	void *	cb_cls,
		struct GNUNET_TESTBED_Operation *	op,
		const struct GNUNET_TESTBED_PeerInformation *	pinfo,
		const char *	emsg
	)

static

Callback to be called when the requested peer information is available.

Parameters

cb_cls	the closure from GNUNET_TESTBED_peer_get_information()
op	the operation this callback corresponds to
pinfo	the result; will be NULL if the operation has failed
emsg	error message if the operation has failed; will be NULL if the operation is successful

Definition at line 390 of file gnunet-consensus-profiler.c.

 {
   struct GNUNET_PeerIdentity *p;
   int i;
  
   GNUNET_assert (NULL == emsg);
  
   p = (struct GNUNET_PeerIdentity *) cb_cls;
  
   if (pinfo->pit == GNUNET_TESTBED_PIT_IDENTITY)
   {
     *p = *pinfo->result.id;
     num_retrieved_peer_ids++;
     if (num_retrieved_peer_ids == num_peers)
       for (i = 0; i < num_peers; i++)
         testbed_operations[i] =
           GNUNET_TESTBED_service_connect (NULL, peers[i], "consensus",
                                           connect_complete, NULL,
                                           connect_adapter, disconnect_adapter,
                                           &consensus_handles[i]);
   }
   else
   {
     GNUNET_assert (0);
   }
  
   GNUNET_TESTBED_operation_done (op);
 }

References connect_adapter(), connect_complete(), consensus_handles, disconnect_adapter(), GNUNET_assert, GNUNET_TESTBED_operation_done(), GNUNET_TESTBED_PIT_IDENTITY, GNUNET_TESTBED_service_connect(), GNUNET_TESTBED_PeerInformation::id, num_peers, num_retrieved_peer_ids, op, p, peers, GNUNET_TESTBED_PeerInformation::pit, GNUNET_TESTBED_PeerInformation::result, and testbed_operations.

Referenced by test_master().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ test_master()

static void test_master	(	void *	cls,
		struct GNUNET_TESTBED_RunHandle *	h,
		unsigned int	num_peers,
		struct GNUNET_TESTBED_Peer **	started_peers,
		unsigned int	links_succeeded,
		unsigned int	links_failed
	)

static

Signature of a main function for a testcase.

Parameters

cls	closure
h	the run handle
num_peers	number of peers in 'peers'
started_peers	handle to peers run in the testbed. NULL upon timeout (see GNUNET_TESTBED_test_run()).
links_succeeded	the number of overlay link connection attempts that succeeded
links_failed	the number of overlay link connection attempts that failed

Definition at line 437 of file gnunet-consensus-profiler.c.

 {
   int i;
  
   GNUNET_log_setup ("gnunet-consensus", "INFO", NULL);
  
   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "test master\n");
  
   peers = started_peers;
  
   peer_ids = GNUNET_malloc (num_peers * sizeof(struct GNUNET_PeerIdentity));
  
   results_for_peer = GNUNET_malloc (num_peers * sizeof(unsigned int));
   consensus_handles = GNUNET_malloc (num_peers * sizeof(struct
                                                         ConsensusHandle *));
   testbed_operations = GNUNET_malloc (num_peers * sizeof(struct
                                                          ConsensusHandle *));
  
   for (i = 0; i < num_peers; i++)
     GNUNET_TESTBED_peer_get_information (peers[i],
                                          GNUNET_TESTBED_PIT_IDENTITY,
                                          peer_info_cb,
                                          &peer_ids[i]);
 }

References consensus_handles, GNUNET_ERROR_TYPE_INFO, GNUNET_log, GNUNET_log_setup(), GNUNET_malloc, GNUNET_TESTBED_peer_get_information(), GNUNET_TESTBED_PIT_IDENTITY, num_peers, peer_ids, peer_info_cb(), peers, results_for_peer, and testbed_operations.

Referenced by GNUNET_TESTBED_run(), GNUNET_TESTBED_test_run(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

static void run	(	void *	cls,
		char const	args,
		const char *	cfgfile,
		const struct GNUNET_CONFIGURATION_Handle *	cfg
	)

static

Definition at line 469 of file gnunet-consensus-profiler.c.

 {
   static char *session_str = "gnunet-consensus/test";
   char *topology;
   int topology_cmp_result;
  
   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "testbed",
                                                           "OVERLAY_TOPOLOGY",
                                                           &topology))
   {
     fprintf (stderr,
              "'OVERLAY_TOPOLOGY' not found in 'testbed' config section, "
              "seems like you passed the wrong configuration file\n");
     return;
   }
  
   topology_cmp_result = strcasecmp (topology, "NONE");
   GNUNET_free (topology);
  
   if (0 == topology_cmp_result)
   {
     fprintf (stderr,
              "'OVERLAY_TOPOLOGY' set to 'NONE', "
              "seems like you passed the wrong configuration file\n");
     return;
   }
  
   if (num_peers < replication)
   {
     fprintf (stderr, "k must be <=n\n");
     return;
   }
  
   start = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (),
                                     consensus_delay);
   deadline = GNUNET_TIME_absolute_add (start, conclude_timeout);
  
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
               "running gnunet-consensus\n");
  
   GNUNET_CRYPTO_hash (session_str, strlen (session_str), &session_id);
  
   (void) GNUNET_TESTBED_test_run ("gnunet-consensus",
                                   cfgfile,
                                   num_peers,
                                   0,
                                   controller_cb,
                                   NULL,
                                   test_master,
                                   NULL);
 }

References cfg, conclude_timeout, consensus_delay, controller_cb(), deadline, GNUNET_CONFIGURATION_get_value_string(), GNUNET_CRYPTO_hash(), GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_log, GNUNET_OK, GNUNET_TESTBED_test_run(), GNUNET_TIME_absolute_add(), GNUNET_TIME_absolute_get(), num_peers, replication, session_id, start, test_master(), and topology.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ main()

int main	(	int	argc,
		char **	argv
	)

Definition at line 524 of file gnunet-consensus-profiler.c.

 {
   struct GNUNET_GETOPT_CommandLineOption options[] = {
     GNUNET_GETOPT_option_uint ('n',
                                "num-peers",
                                NULL,
                                gettext_noop ("number of peers in consensus"),
                                &num_peers),
  
     GNUNET_GETOPT_option_uint ('k',
                                "value-replication",
                                NULL,
                                gettext_noop (
                                  "how many peers (random selection without replacement) receive one value?"),
                                &replication),
  
     GNUNET_GETOPT_option_uint ('x',
                                "num-values",
                                NULL,
                                gettext_noop ("number of values"),
                                &num_values),
  
     GNUNET_GETOPT_option_relative_time ('t',
                                         "timeout",
                                         NULL,
                                         gettext_noop ("consensus timeout"),
                                         &conclude_timeout),
  
  
     GNUNET_GETOPT_option_relative_time ('d',
                                         "delay",
                                         NULL,
                                         gettext_noop (
                                           "delay until consensus starts"),
                                         &consensus_delay),
  
     GNUNET_GETOPT_option_filename ('s',
                                    "statistics",
                                    "FILENAME",
                                    gettext_noop ("write statistics to file"),
                                    &statistics_filename),
  
     GNUNET_GETOPT_option_flag ('S',
                                "dist-static",
                                gettext_noop (
                                  "distribute elements to a static subset of good peers"),
                                &dist_static),
  
     GNUNET_GETOPT_option_flag ('V',
                                "verbose",
                                gettext_noop (
                                  "be more verbose (print received values)"),
                                &verbose),
  
     GNUNET_GETOPT_OPTION_END
   };
  
   conclude_timeout = GNUNET_TIME_UNIT_SECONDS;
   GNUNET_PROGRAM_run2 (argc, argv, "gnunet-consensus-profiler",
                        "help",
                        options, &run, NULL, GNUNET_YES);
   return 0;
 }