gnunet_testing_barrier.h File Reference

API to manage barriers. More...

#include "gnunet_testing_plugin.h"

Include dependency graph for gnunet_testing_barrier.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_TESTING_BarrierListEntry
	An entry for a barrier list FIXME: why is this in the public API!??! More...
struct	GNUNET_TESTING_BarrierList
	A list to hold barriers provided by plugins FIXME: why is this in the public API!??! More...

Macros
#define	GNUNET_TESTING_BARRIER_MAX   32

Functions
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...
struct GNUNET_TESTING_Command	GNUNET_TESTING_cmd_barrier_reached (const char *label, const char *barrier_label, unsigned int asynchronous_finish, unsigned int node_number, unsigned int running_on_master, GNUNET_TESTING_cmd_helper_write_cb write_message)
	If this command is executed the the process is signaling the master process that it reached a barrier. More...

Detailed Description

API to manage barriers.

Author

t3sserakt

Definition in file gnunet_testing_barrier.h.

Macro Definition Documentation

GNUNET_TESTING_BARRIER_MAX

#define GNUNET_TESTING_BARRIER_MAX   32

Definition at line 36 of file gnunet_testing_barrier.h.

Function Documentation

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:

GNUNET_TESTING_cmd_barrier_reached()

struct GNUNET_TESTING_Command GNUNET_TESTING_cmd_barrier_reached	(	const char *	label,
		const char *	barrier_label,
		unsigned int	asynchronous_finish,
		unsigned int	node_number,
		unsigned int	running_on_master,
		GNUNET_TESTING_cmd_helper_write_cb	write_message
	)

If this command is executed the the process is signaling the master process that it reached a barrier.

If this command is synchronous it will block.

FIXME: Now this, as it returns a Command, seems to me like it should be part of the public API?

Parameters

label	name for command.
barrier_label	The name of the barrier we waited for and which was reached.
asynchronous_finish	If GNUNET_YES this command will not block.
node_number	The global number of the node the cmd runs on.
running_on_master	Is this cmd running on the master loop?
write_message	Callback to write messages to the master loop.

Returns

command.

If this command is executed the the process is signaling the master process that it reached a barrier.

Parameters

label	name for command.
barrier_label	The name of the barrier we wait for (if finishing asynchronous) and which will be reached.
asynchronous_finish	If GNUNET_YES this command will not block.
node_number	The global numer of the node the cmd runs on.
running_on_master	Is this cmd running on the master loop.
write_message	Callback to write messages to the master loop.

Returns

command.

Definition at line 207 of file testing_api_cmd_barrier_reached.c.

{
  struct BarrierReachedState *brs;
 
  brs = GNUNET_new (struct BarrierReachedState);
  brs->label = label;
  brs->barrier_name = barrier_label;
  brs->asynchronous_finish = asynchronous_finish;
  brs->node_number = node_number;
  brs->running_on_master = running_on_master;
  brs->write_message = write_message;
  return GNUNET_TESTING_command_new (brs, label,
                                     &barrier_reached_run,
                                     &barrier_reached_cleanup,
                                     &barrier_reached_traits,
                                     &brs->ac);
}

References BarrierReachedState::ac, BarrierReachedState::asynchronous_finish, BarrierReachedState::barrier_name, barrier_reached_cleanup(), barrier_reached_run(), barrier_reached_traits(), GNUNET_new, GNUNET_TESTING_command_new(), BarrierReachedState::label, BarrierReachedState::node_number, BarrierReachedState::running_on_master, write_message(), and BarrierReachedState::write_message.

Here is the call graph for this function: