/*
This file is part of GNUnet
- (C) 2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2013-2017 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
-
/**
* @file set/gnunet-service-set.h
* @brief common components for the implementation the different set operations
* @author Florian Dold
+ * @author Christian Grothoff
*/
-
#ifndef GNUNET_SERVICE_SET_H_PRIVATE
#define GNUNET_SERVICE_SET_H_PRIVATE
#include "gnunet_protocols.h"
#include "gnunet_applications.h"
#include "gnunet_core_service.h"
-#include "gnunet_mesh_service.h"
+#include "gnunet_cadet_service.h"
#include "gnunet_set_service.h"
#include "set.h"
/**
- * Implementation-specific set state.
- * Used as opaque pointer, and specified further
- * in the respective implementation.
+ * Implementation-specific set state. Used as opaque pointer, and
+ * specified further in the respective implementation.
*/
struct SetState;
-
/**
- * Implementation-specific set operation.
- * Used as opaque pointer, and specified further
- * in the respective implementation.
+ * Implementation-specific set operation. Used as opaque pointer, and
+ * specified further in the respective implementation.
*/
struct OperationState;
-
-/* forward declarations */
+/**
+ * A set that supports a specific operation with other peers.
+ */
struct Set;
-struct ElementEntry;
-struct Operation;
-
/**
- * Detail information about an operation.
+ * Information about an element element in the set. All elements are
+ * stored in a hash-table from their hash-code to their 'struct
+ * Element', so that the remove and add operations are reasonably
+ * fast.
*/
-struct OperationSpecification
-{
- /**
- * The type of the operation.
- */
- enum GNUNET_SET_OperationType operation;
-
- /**
- * The remove peer we evaluate the operation with
- */
- struct GNUNET_PeerIdentity peer;
-
- /**
- * Application ID for the operation, used to distinguish
- * multiple operations of the same type with the same peer.
- */
- struct GNUNET_HashCode app_id;
-
- /**
- * Context message, may be NULL.
- */
- struct GNUNET_MessageHeader *context_msg;
-
- /**
- * Salt to use for the operation.
- */
- uint32_t salt;
-
- /**
- * Remote peers element count
- */
- uint32_t element_count;
-
- /**
- * ID used to identify an operation between service and client
- */
- uint32_t client_request_id;
-
- /**
- * Set associated with the operation, NULL until the spec has been associated
- * with a set.
- */
- struct Set *set;
-
- /**
- * When are elements sent to the client, and which elements are sent?
- */
- enum GNUNET_SET_ResultMode result_mode;
-};
-
+struct ElementEntry;
+/**
+ * Operation context used to execute a set operation.
+ */
+struct Operation;
/**
* Signature of functions that create the implementation-specific
* state for a set supporting a specific operation.
*
- * @return a set state specific to the supported operation
+ * @return a set state specific to the supported operation, NULL on error
*/
-typedef struct SetState *(*CreateImpl) (void);
+typedef struct SetState *
+(*SetCreateImpl) (void);
/**
* for a set supporting a specific operation.
*
* @param set implementation-specific set state
- * @param msg element message from the client
+ * @param ee element message from the client
*/
-typedef void (*AddRemoveImpl) (struct SetState *state, struct ElementEntry *ee);
+typedef void
+(*SetAddRemoveImpl) (struct SetState *state,
+ struct ElementEntry *ee);
/**
- * Signature of functions that handle disconnection
- * of the remote peer.
+ * Make a copy of a set's internal state.
*
- * @param op the set operation, contains implementation-specific data
+ * @param state set state to copy
+ * @return copy of the internal state
*/
-typedef void (*PeerDisconnectImpl) (struct Operation *op);
+typedef struct SetState *
+(*SetCopyStateImpl) (struct SetState *state);
/**
*
* @param state the set state, contains implementation-specific data
*/
-typedef void (*DestroySetImpl) (struct SetState *state);
+typedef void
+(*SetDestroyImpl) (struct SetState *state);
/**
- * Signature of functions that implement the creation of set operations
- * (currently evaluate and accept).
+ * Signature of functions that implement accepting a set operation.
*
- * @param op operation that is created, should be initialized by the implementation
+ * @param op operation that is created by accepting the operation,
+ * should be initialized by the implementation
+ * @return operation-specific state to keep in @a op
*/
-typedef void (*OpCreateImpl) (struct Operation *op);
+typedef struct OperationState *
+(*OpAcceptImpl) (struct Operation *op);
/**
- * Signature of functions that implement the message handling for
- * the different set operations.
+ * Signature of functions that implement starting the evaluation of
+ * set operations.
+ *
+ * @param op operation that is created, should be initialized to
+ * begin the evaluation
+ * @param opaque_context message to be transmitted to the listener
+ * to convince him to accept, may be NULL
+ * @return operation-specific state to keep in @a op
+ */
+typedef struct OperationState *
+(*OpEvaluateImpl) (struct Operation *op,
+ const struct GNUNET_MessageHeader *opaque_context);
+
+/**
+ * Signature of functions that implement operation cancelation.
+ * This includes notifying the client about the operation's final
+ * state.
*
* @param op operation state
- * @param msg received message
- * @return GNUNET_OK on success, GNUNET_SYSERR to
- * destroy the operation and the tunnel
*/
-typedef int (*MsgHandlerImpl) (struct Operation *op,
- const struct GNUNET_MessageHeader *msg);
+typedef void
+(*OpCancelImpl) (struct Operation *op);
+
/**
- * Signature of functions that implement operation cancellation
+ * Signature of functions called when the CADET channel died.
*
* @param op operation state
*/
-typedef void (*CancelImpl) (struct Operation *op);
+typedef void
+(*OpChannelDeathImpl) (struct Operation *op);
+
/**
- * Dispatch table for a specific set operation.
- * Every set operation has to implement the callback
- * in this struct.
+ * Dispatch table for a specific set operation. Every set operation
+ * has to implement the callback in this struct.
*/
struct SetVT
{
/**
* Callback for the set creation.
*/
- CreateImpl create;
+ SetCreateImpl create;
/**
* Callback for element insertion
*/
- AddRemoveImpl add;
+ SetAddRemoveImpl add;
/**
* Callback for element removal.
*/
- AddRemoveImpl remove;
+ SetAddRemoveImpl remove;
+
+ /**
+ * Callback for making a copy of a set's internal state.
+ */
+ SetCopyStateImpl copy_state;
+
+ /**
+ * Callback for destruction of the set state.
+ */
+ SetDestroyImpl destroy_set;
/**
* Callback for accepting a set operation request
*/
- OpCreateImpl accept;
+ OpAcceptImpl accept;
/**
* Callback for starting evaluation with a remote peer.
*/
- OpCreateImpl evaluate;
+ OpEvaluateImpl evaluate;
/**
- * Callback for destruction of the set state.
+ * Callback for canceling an operation.
*/
- DestroySetImpl destroy_set;
+ OpCancelImpl cancel;
/**
- * Callback for handling operation-specific messages.
+ * Callback called in case the CADET channel died.
*/
- MsgHandlerImpl msg_handler;
+ OpChannelDeathImpl channel_death;
+
+};
+
+/**
+ * MutationEvent gives information about changes
+ * to an element (removal / addition) in a set content.
+ */
+struct MutationEvent
+{
/**
- * Callback for handling the remote peer's
- * disconnect.
+ * First generation affected by this mutation event.
+ *
+ * If @a generation is 0, this mutation event is a list
+ * sentinel element.
*/
- PeerDisconnectImpl peer_disconnect;
+ unsigned int generation;
/**
- * Callback for canceling an operation by
- * its ID.
+ * If @a added is #GNUNET_YES, then this is a
+ * `remove` event, otherwise it is an `add` event.
*/
- CancelImpl cancel;
+ int added;
};
/**
- * Information about an element element in the set.
- * All elements are stored in a hash-table
- * from their hash-code to their 'struct Element',
- * so that the remove and add operations are reasonably
+ * Information about an element element in the set. All elements are
+ * stored in a hash-table from their hash-code to their `struct
+ * Element`, so that the remove and add operations are reasonably
* fast.
*/
struct ElementEntry
struct GNUNET_SET_Element element;
/**
- * Hash of the element.
- * For set union:
- * Will be used to derive the different IBF keys
- * for different salts.
+ * Hash of the element. For set union: Will be used to derive the
+ * different IBF keys for different salts.
*/
struct GNUNET_HashCode element_hash;
/**
- * Generation the element was added by the client.
- * Operations of earlier generations will not consider the element.
+ * If @a mutations is not NULL, it contains
+ * a list of mutations, ordered by increasing generation.
+ * The list is terminated by a sentinel event with `generation`
+ * set to 0.
+ *
+ * If @a mutations is NULL, then this element exists in all generations
+ * of the respective set content this element belongs to.
*/
- unsigned int generation_added;
+ struct MutationEvent *mutations;
/**
- * GNUNET_YES if the element has been removed in some generation.
+ * Number of elements in the array @a mutations.
*/
- int removed;
+ unsigned int mutations_size;
/**
- * Generation the element was removed by the client.
- * Operations of later generations will not consider the element.
- * Only valid if is_removed is GNUNET_YES.
+ * #GNUNET_YES if the element is a remote element, and does not belong
+ * to the operation's set.
*/
- unsigned int generation_removed;
+ int remote;
+};
+
+/**
+ * A listener is inhabited by a client, and waits for evaluation
+ * requests from remote peers.
+ */
+struct Listener;
+
+
+/**
+ * State we keep per client.
+ */
+struct ClientState
+{
/**
- * GNUNET_YES if the element is a remote element, and does not belong
- * to the operation's set.
- *
- * //TODO: Move to Union, unless additional set-operations are implemented ever
+ * Set, if associated with the client, otherwise NULL.
*/
- int remote;
+ struct Set *set;
+
+ /**
+ * Listener, if associated with the client, otherwise NULL.
+ */
+ struct Listener *listener;
+
+ /**
+ * Client handle.
+ */
+ struct GNUNET_SERVICE_Client *client;
+
+ /**
+ * Message queue.
+ */
+ struct GNUNET_MQ_Handle *mq;
+
};
+/**
+ * Operation context used to execute a set operation.
+ */
struct Operation
{
+
/**
- * V-Table for the operation belonging
- * to the tunnel contest.
- *
- * Used for all operation specific operations after receiving the ops request
+ * Kept in a DLL of the listener, if @e listener is non-NULL.
*/
- const struct SetVT *vt;
+ struct Operation *next;
+
+ /**
+ * Kept in a DLL of the listener, if @e listener is non-NULL.
+ */
+ struct Operation *prev;
/**
- * Tunnel to the peer.
+ * Channel to the peer.
*/
- struct GNUNET_MESH_Channel *channel;
+ struct GNUNET_CADET_Channel *channel;
/**
- * Message queue for the tunnel.
+ * Port this operation runs on.
+ */
+ struct Listener *listener;
+
+ /**
+ * Message queue for the channel.
*/
struct GNUNET_MQ_Handle *mq;
/**
- * GNUNET_YES if this is not a "real" set operation yet, and we still
- * need to wait for the other peer to give us more details.
- *
- * //TODO: replace with state-enum
+ * Context message, may be NULL.
*/
- int is_incoming;
+ struct GNUNET_MessageHeader *context_msg;
+
+ /**
+ * Set associated with the operation, NULL until the spec has been
+ * associated with a set.
+ */
+ struct Set *set;
+
+ /**
+ * Operation-specific operation state. Note that the exact
+ * type depends on this being a union or intersection operation
+ * (and thus on @e vt).
+ */
+ struct OperationState *state;
+
+ /**
+ * The identity of the requesting peer. Needs to
+ * be stored here as the op spec might not have been created yet.
+ */
+ struct GNUNET_PeerIdentity peer;
+
+ /**
+ * Timeout task, if the incoming peer has not been accepted
+ * after the timeout, it will be disconnected.
+ */
+ struct GNUNET_SCHEDULER_Task *timeout_task;
+
+ /**
+ * Salt to use for the operation.
+ */
+ uint32_t salt;
+
+ /**
+ * Remote peers element count
+ */
+ uint32_t remote_element_count;
+
+ /**
+ * ID used to identify an operation between service and client
+ */
+ uint32_t client_request_id;
+
+ /**
+ * When are elements sent to the client, and which elements are sent?
+ */
+ enum GNUNET_SET_ResultMode result_mode;
+
+ /**
+ * Always use delta operation instead of sending full sets,
+ * even it it's less efficient.
+ */
+ int force_delta;
+
+ /**
+ * Always send full sets, even if delta operations would
+ * be more efficient.
+ */
+ int force_full;
+
+ /**
+ * #GNUNET_YES to fail operations where Byzantine faults
+ * are suspected
+ */
+ int byzantine;
+
+ /**
+ * Lower bound for the set size, used only when
+ * byzantine mode is enabled.
+ */
+ int byzantine_lower_bound;
+
+ /**
+ * Unique request id for the request from a remote peer, sent to the
+ * client, which will accept or reject the request. Set to '0' iff
+ * the request has not been suggested yet.
+ */
+ uint32_t suggest_id;
/**
* Generation in which the operation handle
*/
unsigned int generation_created;
+};
+
+
+/**
+ * SetContent stores the actual set elements, which may be shared by
+ * multiple generations derived from one set.
+ */
+struct SetContent
+{
+
+ /**
+ * Maps `struct GNUNET_HashCode *` to `struct ElementEntry *`.
+ */
+ struct GNUNET_CONTAINER_MultiHashMap *elements;
+
/**
- * Detail information about the set operation,
- * including the set to use.
- * When 'spec' is NULL, the operation is not yet entirely
- * initialized.
+ * Mutations requested by the client that we're
+ * unable to execute right now because we're iterating
+ * over the underlying hash map of elements.
*/
- struct OperationSpecification *spec;
+ struct PendingMutation *pending_mutations_head;
/**
- * Operation-specific operation state.
+ * Mutations requested by the client that we're
+ * unable to execute right now because we're iterating
+ * over the underlying hash map of elements.
*/
- struct OperationState *state;
+ struct PendingMutation *pending_mutations_tail;
/**
- * Evaluate operations are held in
- * a linked list.
+ * Number of references to the content.
*/
- struct Operation *next;
+ unsigned int refcount;
- /**
- * Evaluate operations are held in
- * a linked list.
- */
- struct Operation *prev;
+ /**
+ * FIXME: document!
+ */
+ unsigned int latest_generation;
+
+ /**
+ * Number of concurrently active iterators.
+ */
+ int iterator_count;
+};
+
+
+struct GenerationRange
+{
+ /**
+ * First generation that is excluded.
+ */
+ unsigned int start;
+
+ /**
+ * Generation after the last excluded generation.
+ */
+ unsigned int end;
};
/**
- * A set that supports a specific operation
- * with other peers.
+ * Information about a mutation to apply to a set.
*/
-struct Set
+struct PendingMutation
{
/**
- * Client that owns the set.
- * Only one client may own a set.
+ * Mutations are kept in a DLL.
*/
- struct GNUNET_SERVER_Client *client;
+ struct PendingMutation *prev;
/**
- * Message queue for the client
+ * Mutations are kept in a DLL.
*/
- struct GNUNET_MQ_Handle *client_mq;
+ struct PendingMutation *next;
/**
- * Type of operation supported for this set
+ * Set this mutation is about.
*/
- enum GNUNET_SET_OperationType operation;
+ struct Set *set;
/**
- * Virtual table for this set.
- * Determined by the operation type of this set.
- *
- * Used only for Add/remove of elements and when receiving an incoming
- * operation from a remote peer.
+ * Message that describes the desired mutation.
+ * May only be a #GNUNET_MESSAGE_TYPE_SET_ADD or
+ * #GNUNET_MESSAGE_TYPE_SET_REMOVE.
*/
- const struct SetVT *vt;
+ struct GNUNET_SET_ElementMessage *msg;
+};
+
+
+/**
+ * A set that supports a specific operation with other peers.
+ */
+struct Set
+{
/**
- * Sets are held in a doubly linked list.
+ * Sets are held in a doubly linked list (in `sets_head` and `sets_tail`).
*/
struct Set *next;
*/
struct Set *prev;
+ /**
+ * Client that owns the set. Only one client may own a set,
+ * and there can only be one set per client.
+ */
+ struct ClientState *cs;
+
+ /**
+ * Content, possibly shared by multiple sets,
+ * and thus reference counted.
+ */
+ struct SetContent *content;
+
+ /**
+ * Virtual table for this set. Determined by the operation type of
+ * this set.
+ *
+ * Used only for Add/remove of elements and when receiving an incoming
+ * operation from a remote peer.
+ */
+ const struct SetVT *vt;
+
/**
* Implementation-specific state.
*/
struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
/**
- * Maps 'struct GNUNET_HashCode' to 'struct ElementEntry'.
+ * Evaluate operations are held in a linked list.
*/
- struct GNUNET_CONTAINER_MultiHashMap *elements;
+ struct Operation *ops_head;
+
+ /**
+ * Evaluate operations are held in a linked list.
+ */
+ struct Operation *ops_tail;
/**
- * Current generation, that is, number of
- * previously executed operations on this set
+ * List of generations we have to exclude, due to lazy copies.
+ */
+ struct GenerationRange *excluded_generations;
+
+ /**
+ * Current generation, that is, number of previously executed
+ * operations and lazy copies on the underlying set content.
*/
unsigned int current_generation;
/**
- * Evaluate operations are held in
- * a linked list.
+ * Number of elements in array @a excluded_generations.
*/
- struct Operation *ops_head;
+ unsigned int excluded_generations_size;
/**
- * Evaluate operations are held in
- * a linked list.
+ * Type of operation supported for this set
*/
- struct Operation *ops_tail;
+ enum GNUNET_SET_OperationType operation;
+
+ /**
+ * Generation we're currently iteration over.
+ */
+ unsigned int iter_generation;
+
+ /**
+ * Each @e iter is assigned a unique number, so that the client
+ * can distinguish iterations.
+ */
+ uint16_t iteration_id;
+
};
+extern struct GNUNET_STATISTICS_Handle *_GSS_statistics;
+
+
/**
- * Destroy the given operation. 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.
+ * 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.
*
* @param op operation to destroy
+ * @param gc #GNUNET_YES to perform garbage collection on the set
*/
void
-_GSS_operation_destroy (struct Operation *op);
+_GSS_operation_destroy (struct Operation *op,
+ int gc);
/**
- * Get the table with implementing functions for
- * set union.
- *
+ * Get the table with implementing functions for set union.
+ *
* @return the operation specific VTable
*/
const struct SetVT *
/**
- * Get the table with implementing functions for
- * set intersection.
- *
+ * Get the table with implementing functions for set intersection.
+ *
* @return the operation specific VTable
*/
const struct SetVT *
_GSS_intersection_vt (void);
+/**
+ * Is element @a ee part of the set used by @a op?
+ *
+ * @param ee element to test
+ * @param op operation the defines the set and its generation
+ * @return #GNUNET_YES if the element is in the set, #GNUNET_NO if not
+ */
+int
+_GSS_is_element_of_operation (struct ElementEntry *ee,
+ struct Operation *op);
+
+
#endif
projects / oweals / gnunet.git / blobdiff