gnunet-fs-profiler.c File Reference

tool to benchmark/profile file-sharing More...

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

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

Go to the source code of this file.

Functions
static void	shutdown_task (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg)
	Function called after we've collected the statistics. More...
static int	process_stats (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	terminate_task (void *cls)
	Task run on shutdown to terminate. More...
static void	timeout_task (void *cls)
	Task run on timeout to terminate. More...
static void	test_master (void *cls, struct GNUNET_TESTBED_RunHandle *h, unsigned int num_peers, struct GNUNET_TESTBED_Peer **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)
	Main function that will be run by the scheduler. More...
int	main (int argc, char *const *argv)
	Program to run a file-sharing testbed. More...

Variables
static int	ret
	Final status code. More...
static char *	host_filename
	Data file with the hosts for the testbed. More...
static unsigned int	num_peers
	Number of peers to run in the experiment. More...
static struct GNUNET_TIME_Relative	timeout
	After how long do we abort the test? More...
static struct GNUNET_SCHEDULER_Task *	terminate_taskid
	Handle to the task run during termination. More...

Detailed Description

tool to benchmark/profile file-sharing

Author

Christian Grothoff

Definition in file gnunet-fs-profiler.c.

Function Documentation

shutdown_task()

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

static

Function called after we've collected the statistics.

Parameters

cls	NULL
op	the operation that has been finished
emsg	error message in case the operation has failed; will be NULL if operation has executed successfully.

Definition at line 65 of file gnunet-fs-profiler.c.

{
  if (NULL != emsg)
    fprintf (stderr,
             "Error collecting statistics: %s\n",
             emsg);
  GNUNET_SCHEDULER_shutdown ();
}

References GNUNET_SCHEDULER_shutdown().

Referenced by terminate_task().

Here is the call graph for this function:

Here is the caller graph for this function:

process_stats()

static int process_stats ( 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.

Prints them out.

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 90 of file gnunet-fs-profiler.c.

{
  fprintf (stdout,
           "%p-%s: %s = %llu\n",
           peer,
           subsystem,
           name,
           (unsigned long long) value);
  return GNUNET_OK;
}

References GNUNET_OK, name, peer, subsystem, and value.

Referenced by terminate_task().

Here is the caller graph for this function:

terminate_task()

static void terminate_task ( void *  cls )

static

Task run on shutdown to terminate.

Triggers printing out all statistics.

Parameters

cls

NULL

Definition at line 114 of file gnunet-fs-profiler.c.

{
  if (NULL != terminate_taskid)
  {
    GNUNET_SCHEDULER_cancel (terminate_taskid);
    terminate_taskid = NULL;
  }
  GNUNET_TESTBED_get_statistics (0, NULL,
                                 NULL, NULL,
                                 &process_stats,
                                 &shutdown_task,
                                 NULL);
}

References GNUNET_SCHEDULER_cancel(), GNUNET_TESTBED_get_statistics(), process_stats(), shutdown_task(), and terminate_taskid.

Referenced by test_master().

Here is the call graph for this function:

Here is the caller graph for this function:

timeout_task()

static void timeout_task ( void *  cls )

static

Task run on timeout to terminate.

Triggers printing out all statistics.

Parameters

cls

NULL

Definition at line 136 of file gnunet-fs-profiler.c.

{
  terminate_taskid = NULL;
  GNUNET_SCHEDULER_shutdown ();
}

References GNUNET_SCHEDULER_shutdown(), and terminate_taskid.

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 **  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'
peers	handle to peers run in the testbed
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 156 of file gnunet-fs-profiler.c.

{
  // const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
  // FIXME: enable clients to signal 'completion' before timeout;
  // in that case, run the 'terminate_task' "immediately"
 
  if (0 != timeout.rel_value_us)
    terminate_taskid = GNUNET_SCHEDULER_add_delayed (timeout,
                                                     &timeout_task,
                                                     NULL);
  GNUNET_SCHEDULER_add_shutdown (&terminate_task,
                                 NULL);
}

References GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_add_shutdown(), GNUNET_TIME_Relative::rel_value_us, terminate_task(), terminate_taskid, timeout, and timeout_task().

Referenced by 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

Main function that will be run by the scheduler.

Parameters

cls	closure
args	remaining command-line arguments
cfgfile	name of the configuration file used (for saving, can be NULL!)
cfg	configuration

Definition at line 185 of file gnunet-fs-profiler.c.

{
  GNUNET_TESTBED_run (host_filename,
                      cfg,
                      num_peers,
                      0, NULL, NULL,
                      &test_master, (void *) cfg);
}

References cfg, GNUNET_TESTBED_run(), host_filename, num_peers, and test_master().

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 *const *	argv
	)

Program to run a file-sharing testbed.

Parameters

argc	number of arguments from the command line
argv	command line arguments

Returns

0 ok, 1 on error

Definition at line 204 of file gnunet-fs-profiler.c.

{
  struct GNUNET_GETOPT_CommandLineOption options[] = {
    GNUNET_GETOPT_option_uint ('n',
                               "num-peers",
                               "COUNT",
                               gettext_noop (
                                 "run the experiment with COUNT peers"),
                               &num_peers),
 
    GNUNET_GETOPT_option_string ('H',
                                 "hosts",
                                 "HOSTFILE",
                                 gettext_noop (
                                   "specifies name of a file with the HOSTS the testbed should use"),
                                 &host_filename),
 
    GNUNET_GETOPT_option_relative_time ('t',
                                        "timeout",
                                        "DELAY",
                                        gettext_noop (
                                          "automatically terminate experiment after DELAY"),
                                        &timeout),
 
    GNUNET_GETOPT_OPTION_END
  };
 
  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
    return 2;
 
  ret = (GNUNET_OK ==
         GNUNET_PROGRAM_run (argc, argv, "gnunet-fs-profiler",
                             gettext_noop (
                               "run a testbed to measure file-sharing performance"),
                             options, &run,
                             NULL)) ? ret : 1;
  GNUNET_free_nz ((void *) argv);
  return ret;
}

References gettext_noop, GNUNET_free_nz, GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_relative_time(), GNUNET_GETOPT_option_string(), GNUNET_GETOPT_option_uint(), GNUNET_OK, GNUNET_PROGRAM_run(), GNUNET_STRINGS_get_utf8_args(), host_filename, num_peers, options, ret, run(), and timeout.

Here is the call graph for this function:

Variable Documentation

ret

int ret

static

Final status code.

Definition at line 33 of file gnunet-fs-profiler.c.

Referenced by main().

host_filename

char* host_filename

static

Data file with the hosts for the testbed.

Definition at line 38 of file gnunet-fs-profiler.c.

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

num_peers

unsigned int num_peers

static

Number of peers to run in the experiment.

Definition at line 43 of file gnunet-fs-profiler.c.

Referenced by main(), and run().

timeout

struct GNUNET_TIME_Relative timeout

static

After how long do we abort the test?

Definition at line 43 of file gnunet-fs-profiler.c.

Referenced by main(), and test_master().

terminate_taskid

struct GNUNET_SCHEDULER_Task* terminate_taskid

static

Handle to the task run during termination.

Definition at line 53 of file gnunet-fs-profiler.c.

Referenced by terminate_task(), test_master(), and timeout_task().