testing_api_cmd_barrier.c File Reference

Barrier functionality. More...

#include "platform.h"
#include "testing.h"
#include "gnunet_testing_ng_lib.h"
#include "gnunet_testing_plugin.h"
#include "gnunet_testing_netjail_lib.h"
#include "gnunet_testing_barrier.h"

Include dependency graph for testing_api_cmd_barrier.c:

Go to the source code of this file.

Data Structures
struct	BarrierState

Macros
#define	LOG(kind, ...)   GNUNET_log (kind, __VA_ARGS__)
	Generic logging shortcut. More...

Functions
void	GNUNET_TESTING_send_barrier_attach_ (struct GNUNET_TESTING_Interpreter *is, const char *barrier_name, unsigned int global_node_number, unsigned int expected_reaches, GNUNET_TESTING_cmd_helper_write_cb write_message)
	Send message to master loop that cmds being attached to a barrier. More...
bool	GNUNET_TESTING_barrier_crossable_ (struct GNUNET_TESTING_Barrier *barrier)
	This function checks, if a barrier can be crossed, which actually means that the cmd representing the barrier is finished. More...
static enum GNUNET_GenericReturnValue	barrier_traits (void *cls, const void **ret, const char *trait, unsigned int index)
	Offer internal data from a "barrier" CMD, to other commands. More...
static void	barrier_cleanup (void *cls)
	Cleanup the state from a "barrier" CMD, and possibly cancel a pending operation thereof. More...
static void	barrier_run (void *cls, struct GNUNET_TESTING_Interpreter *is)
	Run the command. More...
struct GNUNET_TESTING_NetjailNode *	GNUNET_TESTING_barrier_get_node (struct GNUNET_TESTING_Barrier *barrier, unsigned int node_number)
	Getting a node from a map by global node number. More...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_barrier_create (const char *label, double percentage_to_be_reached, unsigned int number_to_be_reached)
	Command to create a barrier. More...

Detailed Description

Barrier functionality.

Author

t3sserakt

Definition in file testing_api_cmd_barrier.c.

Macro Definition Documentation

LOG

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

Generic logging shortcut.

Definition at line 36 of file testing_api_cmd_barrier.c.

Function Documentation

GNUNET_TESTING_send_barrier_attach_()

void GNUNET_TESTING_send_barrier_attach_	(	struct GNUNET_TESTING_Interpreter *	is,
		const char *	barrier_name,
		unsigned int	global_node_number,
		unsigned int	expected_reaches,
		GNUNET_TESTING_cmd_helper_write_cb	write_message
	)

Send message to master loop that cmds being attached to a barrier.

FIXME: Unused function

Parameters

is	The interpreter loop.
barrier_name	The name of the barrier to attach to.
subnet_number	The number of the subnet.
node_number	The node to inform.
write_message	Callback to write messages to the master loop.

Definition at line 55 of file testing_api_cmd_barrier.c.

{
  // FIXME: avoid useless malloc!
  struct CommandBarrierAttached *atm = GNUNET_new (struct
                                                   CommandBarrierAttached);
  size_t msg_length = sizeof(struct CommandBarrierAttached);
  size_t name_len;
 
  name_len = strlen (barrier_name) + 1;
  atm->header.type = htons (GNUNET_MESSAGE_TYPE_CMDS_HELPER_BARRIER_ATTACHED);
  atm->header.size = htons ((uint16_t) msg_length);
  atm->expected_reaches = expected_reaches;
  atm->node_number = global_node_number;
  memcpy (&atm[1], barrier_name, name_len);
  write_message ((struct GNUNET_MessageHeader *) atm, msg_length);
 
  GNUNET_free (atm);
}

References CommandBarrierAttached::expected_reaches, GNUNET_free, GNUNET_MESSAGE_TYPE_CMDS_HELPER_BARRIER_ATTACHED, GNUNET_new, CommandBarrierAttached::header, CommandBarrierAttached::node_number, GNUNET_MessageHeader::size, GNUNET_MessageHeader::type, and write_message().

Here is the call graph for this function:

GNUNET_TESTING_barrier_crossable_()

bool GNUNET_TESTING_barrier_crossable_

(

struct GNUNET_TESTING_Barrier *

barrier

)

This function checks, if a barrier can be crossed, which actually means that the cmd representing the barrier is finished.

Parameters

barrier

The barrier in question.

Returns

true if we can cross the barrier, false if not.

Definition at line 81 of file testing_api_cmd_barrier.c.

{
  unsigned int expected_reaches = barrier->expected_reaches;
  unsigned int reached = barrier->reached;
  double percentage_to_be_reached = barrier->percentage_to_be_reached;
  unsigned int number_to_be_reached = barrier->number_to_be_reached;
  double percentage_reached = (double) reached / expected_reaches * 100;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "%u %f %f %u %u\n",
       expected_reaches,
       percentage_to_be_reached,
       percentage_reached,
       number_to_be_reached,
       reached);
 
  return ( ( (0 < percentage_to_be_reached) &&
             (percentage_reached >= percentage_to_be_reached) ) ||
           ( (0 < number_to_be_reached) &&
             (reached >= number_to_be_reached) ) );
}

References CommandBarrierAttached::expected_reaches, GNUNET_TESTING_Barrier::expected_reaches, GNUNET_ERROR_TYPE_DEBUG, LOG, GNUNET_TESTING_Barrier::number_to_be_reached, GNUNET_TESTING_Barrier::percentage_to_be_reached, and GNUNET_TESTING_Barrier::reached.

Referenced by barrier_reached(), and barrier_reached_run().

Here is the caller graph for this function:

barrier_traits()

static enum GNUNET_GenericReturnValue barrier_traits ( void *  cls, const void **  ret, const char *  trait, unsigned int  index  )

static

Offer internal data from a "barrier" CMD, to other commands.

Parameters

	cls	closure.
[out]	ret	result.
	trait	name of the trait.
	index	index number of the object to offer.

Returns

GNUNET_OK on success.

Definition at line 114 of file testing_api_cmd_barrier.c.

{
  struct GNUNET_TESTING_Trait traits[] = {
    GNUNET_TESTING_trait_end ()
  };
 
  return GNUNET_TESTING_get_trait (traits,
                                   ret,
                                   trait,
                                   index);
}

References GNUNET_TESTING_get_trait(), GNUNET_TESTING_trait_end(), GNUNET_TESTING_Trait::index, and ret.

Referenced by GNUNET_TESTING_cmd_barrier_create().

Here is the call graph for this function:

Here is the caller graph for this function:

barrier_cleanup()

static void barrier_cleanup ( void *  cls )

static

Cleanup the state from a "barrier" CMD, and possibly cancel a pending operation thereof.

Parameters

cls

closure.

Definition at line 137 of file testing_api_cmd_barrier.c.

{
  struct BarrierState *brs = cls;
 
  GNUNET_free (brs->barrier);
  GNUNET_free (brs);
}

References BarrierState::barrier, and GNUNET_free.

Referenced by GNUNET_TESTING_cmd_barrier_create().

Here is the caller graph for this function:

barrier_run()

static void barrier_run ( void *  cls, struct GNUNET_TESTING_Interpreter *  is  )

static

Run the command.

Parameters

cls	closure.
is	the interpreter state.

Definition at line 153 of file testing_api_cmd_barrier.c.

{
  struct BarrierState *brs = cls;
 
  GNUNET_TESTING_add_barrier_ (is,
                               brs->barrier);
  brs->barrier = NULL;
}

References BarrierState::barrier, GNUNET_TESTING_add_barrier_(), and is.

Referenced by GNUNET_TESTING_cmd_barrier_create().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_barrier_get_node()

struct GNUNET_TESTING_NetjailNode * GNUNET_TESTING_barrier_get_node	(	struct GNUNET_TESTING_Barrier *	barrier,
		unsigned int	node_number
	)

Getting a node from a map by global node number.

FIXME: This is a barrier helper function not related to a command but it is implemented in the *_cmd_barrier.c file. Maybe move into a separate file like testing_barrier.c; see also can barrier advance above

Parameters

nodes	The map.
node_number	The global node number.

Returns

The node.

Definition at line 165 of file testing_api_cmd_barrier.c.

{
  struct GNUNET_HashCode hc;
  struct GNUNET_ShortHashCode key;
 
  GNUNET_CRYPTO_hash (&node_number,
                      sizeof(node_number),
                      &hc);
  memcpy (&key,
          &hc,
          sizeof (key));
  return GNUNET_CONTAINER_multishortmap_get (barrier->nodes,
                                             &key);
}

References GNUNET_CONTAINER_multishortmap_get(), GNUNET_CRYPTO_hash(), key, and GNUNET_TESTING_Barrier::nodes.

Referenced by barrier_attached().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTING_cmd_barrier_create()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_barrier_create	(	const char *	label,
		double	percentage_to_be_reached,
		unsigned int	number_to_be_reached
	)

Command to create a barrier.

FIXME: high-level it is baffling how we need both the GNUNET_TESTING_Barrier and the Command that creates barriers. Conceptually this seems to be very much separate. Can we move _Barrier completely into testing as private?

Parameters

label	The label of this command.
percentage_to_be_reached	If this percentage of processes reached this barrier, all processes waiting at this barrier can pass it. Must not be used together with number_to_be_reached.
number_to_be_reached	If this number of processes reached this barrier, all processes waiting at this barrier can pass it. Must not be used together with percentage_to_be_reached.

Definition at line 183 of file testing_api_cmd_barrier.c.

{
  struct GNUNET_TESTING_Barrier *barrier;
  struct BarrierState *bs;
 
  bs = GNUNET_new (struct BarrierState);
  bs->label = label;
  barrier = GNUNET_new (struct GNUNET_TESTING_Barrier);
  barrier->name = label;
  barrier->percentage_to_be_reached = percentage_to_be_reached;
  barrier->number_to_be_reached = number_to_be_reached;
  GNUNET_assert ((0 < percentage_to_be_reached &&
                  0 == number_to_be_reached) ||
                 (0 ==  percentage_to_be_reached &&
                  0 < number_to_be_reached));
  bs->barrier = barrier;
  return GNUNET_TESTING_command_new (bs, label,
                                     &barrier_run,
                                     &barrier_cleanup,
                                     &barrier_traits,
                                     NULL);
}

References BarrierState::barrier, barrier_cleanup(), barrier_run(), barrier_traits(), GNUNET_assert, GNUNET_new, GNUNET_TESTING_command_new(), BarrierState::label, GNUNET_TESTING_Barrier::name, GNUNET_TESTING_Barrier::number_to_be_reached, and GNUNET_TESTING_Barrier::percentage_to_be_reached.

Here is the call graph for this function: