Profiling driver for the testbed. More...

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

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

Macros
#define	LOG(kind, ...) GNUNET_log (kind, __VA_ARGS__)
	Generic loggins shorthand. More...

Functions
static void	do_shutdown (void *cls)
	Shutdown nicely. More...

static void	do_abort (void *cls)
	abort task to run on test timed out More...

static void	print_overlay_links_summary ()
	Function to print summary about how many overlay links we have made and how many failed. More...

static void	controller_event_cb (void cls, const struct GNUNET_TESTBED_EventInformation event)
	Controller event callback. More...

static void	test_run (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 *config)
	Main function that will be run by the scheduler. More...

int	main (int argc, char const argv)
	Main function. More...

Variables
struct GNUNET_CONFIGURATION_Handle *	cfg
	Handle to global configuration. More...

struct GNUNET_TESTBED_Operation *	topology_op
	Peer linking - topology operation. More...

static char *	hosts_file
	Name of the file with the hosts to run the test over (configuration option). More...

static struct GNUNET_SCHEDULER_Task *	abort_task
	Abort task identifier. More...

uint64_t	event_mask
	Global event mask for all testbed events. More...

static unsigned int	num_peers
	Number of peers to be started by the profiler. More...

static unsigned int	num_cont_fails
	Number of timeout failures to tolerate. More...

static unsigned int	cont_fails
	Continuous failures during overlay connect operations. More...

static unsigned int	established_links
	Links which are successfully established. More...

static unsigned int	failed_links
	Links which are not successfully established. More...

static int	result
	Global testing status. More...

static int	noninteractive
	Are we running non interactively. More...

Detailed Description

Profiling driver for the testbed.

Author: Sree Harsha Totakura sreeh.nosp@m.arsh.nosp@m.a@tot.nosp@m.akur.nosp@m.a.in

Definition in file gnunet-testbed-profiler.c.

Macro Definition Documentation

◆ LOG

#define LOG	(	kind,
		...
	)	GNUNET_log (kind, __VA_ARGS__)

Generic loggins shorthand.

Definition at line 35 of file gnunet-testbed-profiler.c.

Function Documentation

◆ do_shutdown()

static void do_shutdown ( void * cls )

static

Shutdown nicely.

Parameters

cls NULL

Definition at line 107 of file gnunet-testbed-profiler.c.

 {
   if (NULL != abort_task)
   {
     GNUNET_SCHEDULER_cancel (abort_task);
     abort_task = NULL;
   }
   if (NULL != cfg)
   {
     GNUNET_CONFIGURATION_destroy (cfg);
     cfg = NULL;
   }
 }

References abort_task, cfg, GNUNET_CONFIGURATION_destroy(), and GNUNET_SCHEDULER_cancel().

Referenced by test_run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ do_abort()

static void do_abort ( void * cls )

static

abort task to run on test timed out

Parameters

cls NULL

Definition at line 128 of file gnunet-testbed-profiler.c.

 {
   abort_task = NULL;
   LOG (GNUNET_ERROR_TYPE_WARNING,
        "Aborting\n");
   result = GNUNET_SYSERR;
   GNUNET_SCHEDULER_shutdown ();
 }

References abort_task, GNUNET_ERROR_TYPE_WARNING, GNUNET_SCHEDULER_shutdown(), GNUNET_SYSERR, LOG, and result.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print_overlay_links_summary()

static void print_overlay_links_summary ( )

static

Function to print summary about how many overlay links we have made and how many failed.

Definition at line 143 of file gnunet-testbed-profiler.c.

 {
   static int printed_already;
  
   if (GNUNET_YES == printed_already)
     return;
   printed_already = GNUNET_YES;
   printf ("%u links succeeded\n", established_links);
   printf ("%u links failed due to timeouts\n", failed_links);
 }

References established_links, failed_links, and GNUNET_YES.

Referenced by controller_event_cb(), and test_run().

Here is the caller graph for this function:

◆ controller_event_cb()

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

static

Controller event callback.

Parameters

cls	NULL
event	the controller event

Definition at line 162 of file gnunet-testbed-profiler.c.

 {
   switch (event->type)
   {
   case GNUNET_TESTBED_ET_OPERATION_FINISHED:
     /* Control reaches here when a peer linking operation fails */
     if (NULL != event->details.operation_finished.emsg)
     {
       printf ("F");
       fflush (stdout);
       failed_links++;
       if (++cont_fails > num_cont_fails)
       {
         printf ("\nAborting due to very high failure rate\n");
         print_overlay_links_summary ();
         GNUNET_SCHEDULER_shutdown ();
         return;
       }
     }
     break;
  
   case GNUNET_TESTBED_ET_CONNECT:
     {
       if (0 != cont_fails)
         cont_fails--;
       if (0 == established_links)
         printf ("Establishing links. Please wait\n");
       printf (".");
       fflush (stdout);
       established_links++;
     }
     break;
  
   default:
     GNUNET_break (0);
   }
 }

References cont_fails, GNUNET_TESTBED_EventInformation::details, established_links, failed_links, GNUNET_break, GNUNET_SCHEDULER_shutdown(), GNUNET_TESTBED_ET_CONNECT, GNUNET_TESTBED_ET_OPERATION_FINISHED, num_cont_fails, GNUNET_TESTBED_EventInformation::operation_finished, print_overlay_links_summary(), and GNUNET_TESTBED_EventInformation::type.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ test_run()

static void test_run	(	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

Definition at line 214 of file gnunet-testbed-profiler.c.

 {
   result = GNUNET_OK;
   fprintf (stdout, "\n");
   print_overlay_links_summary ();
   GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
   if (noninteractive)
   {
     GNUNET_SCHEDULER_cancel (abort_task);
     abort_task = NULL;
     return;
   }
   fprintf (stdout, "Testbed running, waiting for keystroke to shut down\n");
   fflush (stdout);
   (void) getc (stdin);
   fprintf (stdout, "Shutting down. Please wait\n");
   fflush (stdout);
   GNUNET_SCHEDULER_shutdown ();
 }

References abort_task, do_shutdown(), GNUNET_OK, GNUNET_SCHEDULER_add_shutdown(), GNUNET_SCHEDULER_cancel(), GNUNET_SCHEDULER_shutdown(), noninteractive, print_overlay_links_summary(), and result.

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 *	config
	)

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!)
config	configuration

Definition at line 248 of file gnunet-testbed-profiler.c.

 {
   if (0 == num_peers)
   {
     LOG (GNUNET_ERROR_TYPE_ERROR, _ ("Exiting as the number of peers is %u\n"),
          num_peers);
     return;
   }
   cfg = GNUNET_CONFIGURATION_dup (config);
   event_mask = 0;
   event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
   event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
   GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask,
                       &controller_event_cb, NULL,
                       &test_run, NULL);
   abort_task =
     GNUNET_SCHEDULER_add_shutdown (&do_abort,
                                    NULL);
 }

References _, abort_task, cfg, config, controller_event_cb(), do_abort(), event_mask, GNUNET_CONFIGURATION_dup(), GNUNET_ERROR_TYPE_ERROR, GNUNET_SCHEDULER_add_shutdown(), GNUNET_TESTBED_ET_CONNECT, GNUNET_TESTBED_ET_OPERATION_FINISHED, GNUNET_TESTBED_run(), hosts_file, LOG, num_peers, and test_run().

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
	)

Main function.

Returns: 0 on success

Definition at line 276 of file gnunet-testbed-profiler.c.

 {
   struct GNUNET_GETOPT_CommandLineOption options[] = {
     GNUNET_GETOPT_option_uint ('p',
                                "num-peers",
                                "COUNT",
                                gettext_noop ("create COUNT number of peers"),
                                &num_peers),
     GNUNET_GETOPT_option_uint ('e',
                                "num-errors",
                                "COUNT",
                                gettext_noop (
                                  "tolerate COUNT number of continuous timeout failures"),
                                &num_cont_fails),
     GNUNET_GETOPT_option_flag ('n',
                                "non-interactive",
                                gettext_noop (
                                  "run profiler in non-interactive mode where upon "
                                  "testbed setup the profiler does not wait for a "
                                  "keystroke but continues to run until a termination "
                                  "signal is received"),
                                &noninteractive),
     GNUNET_GETOPT_option_string ('H',
                                  "hosts",
                                  "FILENAME",
                                  gettext_noop (
                                    "name of the file with the login information for the testbed"),
                                  &hosts_file),
     GNUNET_GETOPT_OPTION_END
   };
   const char *binaryHelp = "gnunet-testbed-profiler [OPTIONS]";
   int ret;
  
   unsetenv ("XDG_DATA_HOME");
   unsetenv ("XDG_CONFIG_HOME");
   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
     return 2;
   result = GNUNET_SYSERR;
   ret =
     GNUNET_PROGRAM_run (argc, argv, "gnunet-testbed-profiler", binaryHelp,
                         options, &run, NULL);
   GNUNET_free_nz ((void *) argv);
   if (GNUNET_OK != ret)
     return ret;
   if (GNUNET_OK != result)
     return 1;
   return 0;
 }

References gettext_noop, GNUNET_free_nz, GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_flag(), GNUNET_GETOPT_option_string(), GNUNET_GETOPT_option_uint(), GNUNET_OK, GNUNET_PROGRAM_run(), GNUNET_STRINGS_get_utf8_args(), GNUNET_SYSERR, hosts_file, noninteractive, num_cont_fails, num_peers, options, result, ret, and run().

Here is the call graph for this function:

Variable Documentation

◆ cfg

struct GNUNET_CONFIGURATION_Handle* cfg

Handle to global configuration.

Handle to our configuration.

Definition at line 42 of file gnunet-testbed-profiler.c.

Referenced by do_shutdown(), and run().

◆ topology_op

struct GNUNET_TESTBED_Operation* topology_op

Peer linking - topology operation.

Definition at line 47 of file gnunet-testbed-profiler.c.

◆ hosts_file

char* hosts_file

static

Name of the file with the hosts to run the test over (configuration option).

It will be NULL if ENABLE_LL is set

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

Referenced by main(), and run().

◆ abort_task

struct GNUNET_SCHEDULER_Task* abort_task

static

Abort task identifier.

Definition at line 58 of file gnunet-testbed-profiler.c.

Referenced by do_abort(), do_shutdown(), run(), and test_run().

◆ event_mask

uint64_t event_mask

Global event mask for all testbed events.

Definition at line 63 of file gnunet-testbed-profiler.c.

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

◆ num_peers

unsigned int num_peers

static

Number of peers to be started by the profiler.

Definition at line 68 of file gnunet-testbed-profiler.c.

Referenced by main(), and run().

◆ num_cont_fails

unsigned int num_cont_fails

static

Number of timeout failures to tolerate.

Definition at line 73 of file gnunet-testbed-profiler.c.

Referenced by controller_event_cb(), and main().

◆ cont_fails

unsigned int cont_fails

static

Continuous failures during overlay connect operations.

Definition at line 78 of file gnunet-testbed-profiler.c.

Referenced by controller_event_cb().

◆ established_links

unsigned int established_links

static

Links which are successfully established.

Definition at line 83 of file gnunet-testbed-profiler.c.

Referenced by controller_event_cb(), and print_overlay_links_summary().

◆ failed_links

unsigned int failed_links

static

Links which are not successfully established.

Definition at line 88 of file gnunet-testbed-profiler.c.

Referenced by controller_event_cb(), and print_overlay_links_summary().

◆ result

int result

static

Global testing status.

Definition at line 93 of file gnunet-testbed-profiler.c.

Referenced by do_abort(), main(), and test_run().

◆ noninteractive

int noninteractive

static

Are we running non interactively.

Definition at line 98 of file gnunet-testbed-profiler.c.

Referenced by main(), and test_run().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ LOG

Function Documentation

◆ do_shutdown()

◆ do_abort()

◆ print_overlay_links_summary()

◆ controller_event_cb()

◆ test_run()

◆ run()

◆ main()

Variable Documentation

◆ cfg

◆ topology_op

◆ hosts_file

◆ abort_task

◆ event_mask

◆ num_peers

◆ num_cont_fails

◆ cont_fails

◆ established_links

◆ failed_links

◆ result

◆ noninteractive