gnunet-service-set.h File Reference

common components for the implementation the different set operations More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_applications.h"
#include "gnunet_core_service.h"
#include "gnunet_cadet_service.h"
#include "gnunet_set_service.h"
#include "set.h"

Include dependency graph for gnunet-service-set.h:

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

Go to the source code of this file.

Data Structures
struct	SetVT
	Dispatch table for a specific set operation. More...
struct	MutationEvent
	MutationEvent gives information about changes to an element (removal / addition) in a set content. More...
struct	ElementEntry
	Information about an element element in the set. More...
struct	ClientState
	State we keep per client. More...
struct	Operation
	Operation context used to execute a set operation. More...
struct	SetContent
	SetContent stores the actual set elements, which may be shared by multiple generations derived from one set. More...
struct	GenerationRange
struct	PendingMutation
	Information about a mutation to apply to a set. More...
struct	Set
	A set that supports a specific operation with other peers. More...

Typedefs
typedef struct SetState *(*	SetCreateImpl) (void)
	Signature of functions that create the implementation-specific state for a set supporting a specific operation.
typedef void(*	SetAddRemoveImpl) (struct SetState *state, struct ElementEntry *ee)
	Signature of functions that implement the add/remove functionality for a set supporting a specific operation.
typedef struct SetState *(*	SetCopyStateImpl) (struct SetState *state)
	Make a copy of a set's internal state.
typedef void(*	SetDestroyImpl) (struct SetState *state)
	Signature of functions that implement the destruction of the implementation-specific set state.
typedef struct OperationState *(*	OpAcceptImpl) (struct Operation *op)
	Signature of functions that implement accepting a set operation.
typedef struct OperationState *(*	OpEvaluateImpl) (struct Operation *op, const struct GNUNET_MessageHeader *opaque_context)
	Signature of functions that implement starting the evaluation of set operations.
typedef void(*	OpCancelImpl) (struct Operation *op)
	Signature of functions that implement operation cancellation.
typedef void(*	OpChannelDeathImpl) (struct Operation *op)
	Signature of functions called when the CADET channel died.

Functions
void	_GSS_operation_destroy (struct Operation *op, int gc)
	Destroy the given operation.
void	_GSS_operation_destroy2 (struct Operation *op)
	This function probably should not exist and be replaced by inlining more specific logic in the various places where it is called.
const struct SetVT *	_GSS_union_vt (void)
	Get the table with implementing functions for set union.
const struct SetVT *	_GSS_intersection_vt (void)
	Get the table with implementing functions for set intersection.
int	_GSS_is_element_of_operation (struct ElementEntry *ee, struct Operation *op)
	Is element ee part of the set used by op?

Variables
struct GNUNET_STATISTICS_Handle *	_GSS_statistics
	Statistics handle.

Detailed Description

common components for the implementation the different set operations

Author

Florian Dold

Christian Grothoff

Definition in file gnunet-service-set.h.

Typedef Documentation

SetCreateImpl

typedef struct SetState *(* SetCreateImpl) (void)

Signature of functions that create the implementation-specific state for a set supporting a specific operation.

Returns

a set state specific to the supported operation, NULL on error

Definition at line 1 of file gnunet-service-set.h.

SetAddRemoveImpl

typedef void(* SetAddRemoveImpl) (struct SetState *state, struct ElementEntry *ee)

Signature of functions that implement the add/remove functionality for a set supporting a specific operation.

Parameters

set	implementation-specific set state
ee	element message from the client

Definition at line 87 of file gnunet-service-set.h.

SetCopyStateImpl

typedef struct SetState *(* SetCopyStateImpl) (struct SetState *state)

Make a copy of a set's internal state.

Parameters

state

set state to copy

Returns

copy of the internal state

Definition at line 87 of file gnunet-service-set.h.

SetDestroyImpl

typedef void(* SetDestroyImpl) (struct SetState *state)

Signature of functions that implement the destruction of the implementation-specific set state.

Parameters

state

the set state, contains implementation-specific data

Definition at line 108 of file gnunet-service-set.h.

OpAcceptImpl

typedef struct OperationState *(* OpAcceptImpl) (struct Operation *op)

Signature of functions that implement accepting a set operation.

Parameters

op	operation that is created by accepting the operation, should be initialized by the implementation

Returns

operation-specific state to keep in op

Definition at line 108 of file gnunet-service-set.h.

OpEvaluateImpl

typedef struct OperationState *(* OpEvaluateImpl) (struct Operation *op, const struct GNUNET_MessageHeader *opaque_context)

Signature of functions that implement starting the evaluation of set operations.

Parameters

op	operation that is created, should be initialized to begin the evaluation
opaque_context	message to be transmitted to the listener to convince it to accept, may be NULL

Returns

operation-specific state to keep in op

Definition at line 108 of file gnunet-service-set.h.

OpCancelImpl

typedef void(* OpCancelImpl) (struct Operation *op)

Signature of functions that implement operation cancellation.

This includes notifying the client about the operation's final state.

Parameters

op	operation state

Definition at line 144 of file gnunet-service-set.h.

OpChannelDeathImpl

typedef void(* OpChannelDeathImpl) (struct Operation *op)

Signature of functions called when the CADET channel died.

Parameters

op	operation state

Definition at line 153 of file gnunet-service-set.h.

Function Documentation

_GSS_operation_destroy()

void _GSS_operation_destroy	(	struct Operation *	op,
		int	gc
	)

Destroy the given operation.

Used for any operation where both peers were known and that thus actually had a vt and channel. Must not be used for operations where 'listener' is still set and we do not know the other peer.

Call the implementation-specific cancel function of the operation. Disconnects from the remote peer. Does not disconnect the client, as there may be multiple operations per set.

Parameters

op	operation to destroy
gc	GNUNET_YES to perform garbage collection on the set

Definition at line 421 of file gnunet-service-set.c.

{
  struct Set *set = op->set;
  struct GNUNET_CADET_Channel *channel;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Destroying operation %p\n", op);
  GNUNET_assert (NULL == op->listener);
  if (NULL != op->state)
  {
    set->vt->cancel (op);
    op->state = NULL;
  }
  if (NULL != set)
  {
    GNUNET_CONTAINER_DLL_remove (set->ops_head, set->ops_tail, op);
    op->set = NULL;
  }
  if (NULL != op->context_msg)
  {
    GNUNET_free (op->context_msg);
    op->context_msg = NULL;
  }
  if (NULL != (channel = op->channel))
  {
    /* This will free op; called conditionally as this helper function
       is also called from within the channel disconnect handler. */
    op->channel = NULL;
    GNUNET_CADET_channel_destroy (channel);
  }
  if ((NULL != set) && (GNUNET_YES == gc))
    collect_generation_garbage (set);
  /* We rely on the channel end handler to free 'op'. When 'op->channel' was NULL,
   * there was a channel end handler that will free 'op' on the call stack. */
}

References SetVT::cancel, collect_generation_garbage(), GNUNET_assert, GNUNET_CADET_channel_destroy(), GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_YES, op, Set::ops_head, Set::ops_tail, and Set::vt.

Referenced by _GSS_operation_destroy2(), client_disconnect_cb(), fail_intersection_operation(), fail_union_operation(), handle_client_cancel(), intersection_channel_death(), send_client_done_and_destroy(), and union_channel_death().

Here is the call graph for this function:

Here is the caller graph for this function:

_GSS_operation_destroy2()

void _GSS_operation_destroy2

(

struct Operation *

op

)

This function probably should not exist and be replaced by inlining more specific logic in the various places where it is called.

Definition at line 1152 of file gnunet-service-set.c.

{
  struct GNUNET_CADET_Channel *channel;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "channel_end_cb called\n");
  if (NULL != (channel = op->channel))
  {
    /* This will free op; called conditionally as this helper function
       is also called from within the channel disconnect handler. */
    op->channel = NULL;
    GNUNET_CADET_channel_destroy (channel);
  }
  if (NULL != op->listener)
  {
    incoming_destroy (op);
    return;
  }
  if (NULL != op->set)
    op->set->vt->channel_death (op);
  else
    _GSS_operation_destroy (op, GNUNET_YES);
  GNUNET_free (op);
}

References _GSS_operation_destroy(), GNUNET_CADET_channel_destroy(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_YES, incoming_destroy(), and op.

Referenced by channel_end_cb(), handle_client_reject(), handle_union_p2p_full_done(), incoming_destroy(), and maybe_finish().

Here is the call graph for this function:

Here is the caller graph for this function:

_GSS_union_vt()

const struct SetVT * _GSS_union_vt

(

void

)

Get the table with implementing functions for set union.

Returns

the operation specific VTable

Definition at line 2453 of file gnunet-service-set_union.c.

{
  static const struct SetVT union_vt = {
    .create = &union_set_create,
    .add = &union_add,
    .remove = &union_remove,
    .destroy_set = &union_set_destroy,
    .evaluate = &union_evaluate,
    .accept = &union_accept,
    .cancel = &union_op_cancel,
    .copy_state = &union_copy_state,
    .channel_death = &union_channel_death
  };
 
  return &union_vt;
}

References SetVT::create, union_accept(), union_add(), union_channel_death(), union_copy_state(), union_evaluate(), union_op_cancel(), union_remove(), union_set_create(), and union_set_destroy().

Referenced by handle_client_copy_lazy_connect(), and handle_client_create_set().

Here is the call graph for this function:

Here is the caller graph for this function:

_GSS_intersection_vt()

const struct SetVT * _GSS_intersection_vt

(

void

)

Get the table with implementing functions for set intersection.

Returns

the operation specific VTable

Definition at line 1310 of file gnunet-service-set_intersection.c.

{
  static const struct SetVT intersection_vt = {
    .create = &intersection_set_create,
    .add = &intersection_add,
    .remove = &intersection_remove,
    .destroy_set = &intersection_set_destroy,
    .evaluate = &intersection_evaluate,
    .accept = &intersection_accept,
    .cancel = &intersection_op_cancel,
    .channel_death = &intersection_channel_death,
  };
 
  return &intersection_vt;
}

References SetVT::create, intersection_accept(), intersection_add(), intersection_channel_death(), intersection_evaluate(), intersection_op_cancel(), intersection_remove(), intersection_set_create(), and intersection_set_destroy().

Referenced by handle_client_copy_lazy_connect(), and handle_client_create_set().

Here is the call graph for this function:

Here is the caller graph for this function:

_GSS_is_element_of_operation()

int _GSS_is_element_of_operation	(	struct ElementEntry *	ee,
		struct Operation *	op
	)

Is element ee part of the set used by op?

Parameters

ee	element to test
op	operation the defines the set and its generation

Returns

GNUNET_YES if the element is in the set, GNUNET_NO if not

Definition at line 398 of file gnunet-service-set.c.

{
  return is_element_of_generation (ee,
                                   op->generation_created,
                                   op->set->excluded_generations,
                                   op->set->excluded_generations_size);
}

References is_element_of_generation(), and op.

Referenced by filtered_map_initialization(), handle_union_p2p_demand(), handle_union_p2p_offer(), init_key_to_element_iterator(), and initialize_map_unfiltered().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

_GSS_statistics

struct GNUNET_STATISTICS_Handle* _GSS_statistics

extern

Statistics handle.

Definition at line 145 of file gnunet-service-set.c.

Referenced by decode_and_send(), fail_intersection_operation(), handle_union_p2p_demand(), handle_union_p2p_elements(), handle_union_p2p_full_element(), handle_union_p2p_strata_estimator(), run(), send_bloomfilter(), send_client_done(), send_client_done_and_destroy(), send_client_removed_element(), send_ibf(), shutdown_task(), union_accept(), and union_evaluate().