GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 2, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
*/
/**
- * @brief common stuff for the set service
+ * @file set/gnunet-service-set.h
+ * @brief common components for the implementation the different set operations
+ * @author Florian Dold
*/
#ifndef GNUNET_SERVICE_SET_H_PRIVATE
#define GNUNET_SERVICE_SET_H_PRIVATE
#include "platform.h"
-#include "gnunet_common.h"
+#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_applications.h"
-#include "gnunet_util_lib.h"
#include "gnunet_core_service.h"
-#include "gnunet_stream_lib.h"
+#include "gnunet_mesh_service.h"
#include "gnunet_set_service.h"
#include "set.h"
-#include "mq.h"
-/* FIXME: cfuchs */
-struct IntersectionState;
+/**
+ * Implementation-specific set state.
+ * Used as opaque pointer, and specified further
+ * in the respective implementation.
+ */
+struct SetState;
/**
- * Extra state required for set union.
+ * Implementation-specific set operation.
+ * Used as opaque pointer, and specified further
+ * in the respective implementation.
*/
-struct UnionState;
+struct OperationState;
+
+
+/* forward declarations */
+struct Set;
+struct ElementEntry;
+struct Operation;
/**
- * A set that supports a specific operation
- * with other peers.
+ * Detail information about an operation.
*/
-struct Set
+struct OperationSpecification
{
/**
- * Client that owns the set.
- * Only one client may own a set.
+ * The type of the operation.
*/
- struct GNUNET_SERVER_Client *client;
+ enum GNUNET_SET_OperationType operation;
/**
- * Message queue for the client
+ * The remove peer we evaluate the operation with
*/
- struct GNUNET_MQ_MessageQueue *client_mq;
+ struct GNUNET_PeerIdentity peer;
/**
- * Type of operation supported for this set
+ * Application ID for the operation, used to distinguish
+ * multiple operations of the same type with the same peer.
*/
- uint32_t operation; // use enum from API
+ struct GNUNET_HashCode app_id;
/**
- * Sets are held in a doubly linked list.
+ * Context message, may be NULL.
*/
- struct Set *next;
+ struct GNUNET_MessageHeader *context_msg;
/**
- * Sets are held in a doubly linked list.
+ * Salt to use for the operation.
*/
- struct Set *prev;
+ 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;
/**
- * Appropriate state for each type of
- * operation.
+ * Set associated with the operation, NULL until the spec has been associated
+ * with a set.
*/
- union {
- struct IntersectionState *i;
- struct UnionState *u;
- } extra;
+ struct Set *set;
+
+ /**
+ * When are elements sent to the client, and which elements are sent?
+ */
+ enum GNUNET_SET_ResultMode result_mode;
};
+
+
/**
- * State for an evaluate operation for a set that
- * supports set union.
+ * 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
*/
-struct UnionEvaluateOperation;
+typedef struct SetState *(*CreateImpl) (void);
-/* FIXME: cfuchs */
-struct IntersectionEvaluateOperation
-{
- /* FIXME: cfuchs */
-};
+/**
+ * Signature of functions that implement the add/remove functionality
+ * for a set supporting a specific operation.
+ *
+ * @param set implementation-specific set state
+ * @param msg element message from the client
+ */
+typedef void (*AddRemoveImpl) (struct SetState *state, struct ElementEntry *ee);
+
+
+/**
+ * Signature of functions that handle disconnection
+ * of the remote peer.
+ *
+ * @param op the set operation, contains implementation-specific data
+ */
+typedef void (*PeerDisconnectImpl) (struct Operation *op);
/**
- * State of evaluation a set operation with
- * another peer
+ * Signature of functions that implement the destruction of the
+ * implementation-specific set state.
+ *
+ * @param state the set state, contains implementation-specific data
+ */
+typedef void (*DestroySetImpl) (struct SetState *state);
+
+
+/**
+ * Signature of functions that implement the creation of set operations
+ * (currently evaluate and accept).
+ *
+ * @param op operation that is created, should be initialized by the implementation
+ */
+typedef void (*OpCreateImpl) (struct Operation *op);
+
+
+/**
+ * Signature of functions that implement the message handling for
+ * the different set operations.
+ *
+ * @param op operation state
+ * @param msg received message
+ * @return GNUNET_OK on success, GNUNET_SYSERR to
+ * destroy the operation and the tunnel
*/
-struct EvaluateOperation
+typedef int (*MsgHandlerImpl) (struct Operation *op,
+ const struct GNUNET_MessageHeader *msg);
+
+/**
+ * Signature of functions that implement operation cancellation
+ *
+ * @param op operation state
+ */
+typedef void (*CancelImpl) (struct Operation *op);
+
+
+/**
+ * Dispatch table for a specific set operation.
+ * Every set operation has to implement the callback
+ * in this struct.
+ */
+struct SetVT
{
/**
- * Local set the operation is evaluated on
+ * Callback for the set creation.
*/
- struct Set *set;
+ CreateImpl create;
/**
- * Peer with the remote set
+ * Callback for element insertion
*/
- struct GNUNET_PeerIdentity peer;
+ AddRemoveImpl add;
/**
- * Application-specific identifier
+ * Callback for element removal.
*/
- struct GNUNET_HashCode app_id;
+ AddRemoveImpl remove;
/**
- * Context message, given to us
- * by the client, may be NULL.
+ * Callback for accepting a set operation request
*/
- struct GNUNET_MessageHeader *context_msg;
+ OpCreateImpl accept;
/**
- * Stream socket connected to the other peer
+ * Callback for starting evaluation with a remote peer.
*/
- struct GNUNET_STREAM_Socket *socket;
+ OpCreateImpl evaluate;
/**
- * Message queue for the peer on the other
- * end
+ * Callback for destruction of the set state.
*/
- struct GNUNET_MQ_MessageQueue *mq;
+ DestroySetImpl destroy_set;
/**
- * Type of this operation
+ * Callback for handling operation-specific messages.
*/
- enum GNUNET_SET_OperationType operation;
+ MsgHandlerImpl msg_handler;
/**
- * GNUNET_YES if we started the operation,
- * GNUNET_NO if the other peer started it.
+ * Callback for handling the remote peer's
+ * disconnect.
*/
- int is_outgoing;
+ PeerDisconnectImpl peer_disconnect;
/**
- * Request id, so we can use one client handle
- * for multiple operations
+ * Callback for canceling an operation by
+ * its ID.
*/
- uint32_t request_id;
-
- union {
- struct UnionEvaluateOperation *u;
- struct IntersectionEvaluateOperation *i;
- } extra;
+ CancelImpl cancel;
};
-struct Listener
+/**
+ * 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
{
/**
- * Listeners are held in a doubly linked list.
+ * The actual element. The data for the element
+ * should be allocated at the end of this struct.
*/
- struct Listener *next;
+ struct GNUNET_SET_Element element;
/**
- * Listeners are held in a doubly linked list.
+ * Hash of the element.
+ * For set union:
+ * Will be used to derive the different IBF keys
+ * for different salts.
*/
- struct Listener *prev;
+ struct GNUNET_HashCode element_hash;
/**
- * Client that owns the set.
- * Only one client may own a set.
+ * Generation the element was added by the client.
+ * Operations of earlier generations will not consider the element.
*/
- struct GNUNET_SERVER_Client *client;
+ unsigned int generation_added;
/**
- * Message queue for the client
+ * GNUNET_YES if the element has been removed in some generation.
*/
- struct GNUNET_MQ_MessageQueue *client_mq;
+ int removed;
/**
- * Type of operation supported for this set
+ * 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.
*/
- enum GNUNET_SET_OperationType operation;
+ unsigned int generation_removed;
/**
- * Application id of intereset for this listener.
+ * 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
*/
- struct GNUNET_HashCode app_id;
+ int remote;
};
-/**
- * Peer that has connected to us, but is not yet evaluating a set operation.
- * Once the peer has sent a request, and the client has
- * accepted or rejected it, this information will be deleted.
- */
-struct Incoming
+struct Operation
{
/**
- * Incoming peers are held in a linked list
+ * V-Table for the operation belonging
+ * to the tunnel contest.
+ *
+ * Used for all operation specific operations after receiving the ops request
*/
- struct Incoming *next;
+ const struct SetVT *vt;
/**
- * Incoming peers are held in a linked list
+ * Tunnel to the peer.
*/
- struct Incoming *prev;
+ struct GNUNET_MESH_Channel *channel;
/**
- * Identity of the peer that connected to us
+ * Message queue for the tunnel.
*/
- struct GNUNET_PeerIdentity peer;
+ struct GNUNET_MQ_Handle *mq;
/**
- * Socket connected to the peer
+ * 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.
*/
- struct GNUNET_STREAM_Socket *socket;
+ int is_incoming;
/**
- * Message queue for the peer
+ * Generation in which the operation handle
+ * was created.
*/
- struct GNUNET_MQ_MessageQueue *mq;
+ unsigned int generation_created;
/**
- * App code, set once the peer has
- * requested an operation
+ * Detail information about the set operation,
+ * including the set to use.
+ * When 'spec' is NULL, the operation is not yet entirely
+ * initialized.
*/
- struct GNUNET_HashCode app_id;
+ struct OperationSpecification *spec;
/**
- * Context message, set once the peer
- * has requested an operation.
+ * Operation-specific operation state.
*/
- struct GNUNET_MessageHeader *context_msg;
+ struct OperationState *state;
/**
- * Operation the other peer wants to do
+ * Evaluate operations are held in
+ * a linked list.
*/
- enum GNUNET_SET_OperationType operation;
+ struct Operation *next;
+
+ /**
+ * Evaluate operations are held in
+ * a linked list.
+ */
+ struct Operation *prev;
/**
- * Request id associated with the
- * request coming from this client
+ * Set to GNUNET_YES if the set service should not free
+ * the operation, as it is still needed (e.g. in some scheduled task).
*/
- uint32_t request_id;
+ int keep;
};
/**
- * Configuration of the local peer
+ * A set that supports a specific operation
+ * with other peers.
*/
-extern const struct GNUNET_CONFIGURATION_Handle *configuration;
+struct Set
+{
+ /**
+ * Client that owns the set.
+ * Only one client may own a set.
+ */
+ struct GNUNET_SERVER_Client *client;
+ /**
+ * Message queue for the client
+ */
+ struct GNUNET_MQ_Handle *client_mq;
-/**
- * Disconnect a client and free all resources
- * that the client allocated (e.g. Sets or Listeners)
- *
- * @param client the client to disconnect
- */
-void
-client_disconnect (struct GNUNET_SERVER_Client *client);
+ /**
+ * Type of operation supported for this set
+ */
+ enum GNUNET_SET_OperationType operation;
+ /**
+ * 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;
-struct Set *
-union_set_create (void);
+ /**
+ * Sets are held in a doubly linked list.
+ */
+ struct Set *next;
+ /**
+ * Sets are held in a doubly linked list.
+ */
+ struct Set *prev;
-void
-union_evaluate (struct EvaluateOperation *eo);
+ /**
+ * Implementation-specific state.
+ */
+ struct SetState *state;
+
+ /**
+ * Current state of iterating elements for the client.
+ * NULL if we are not currently iterating.
+ */
+ struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
+ /**
+ * Maps 'struct GNUNET_HashCode' to 'struct ElementEntry'.
+ */
+ struct GNUNET_CONTAINER_MultiHashMap *elements;
-void
-union_add (struct Set *set, struct ElementMessage *m);
+ /**
+ * Current generation, that is, number of
+ * previously executed operations on this set
+ */
+ unsigned int current_generation;
+
+ /**
+ * Evaluate operations are held in
+ * a linked list.
+ */
+ struct Operation *ops_head;
+
+ /**
+ * Evaluate operations are held in
+ * a linked list.
+ */
+ struct Operation *ops_tail;
+};
+/**
+ * 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.
+ *
+ * @param op operation to destroy
+ */
void
-union_accept (struct EvaluateOperation *eo, struct Incoming *incoming);
+_GSS_operation_destroy (struct Operation *op);
+
+
+/**
+ * Get the table with implementing functions for
+ * set union.
+ *
+ * @return the operation specific VTable
+ */
+const struct SetVT *
+_GSS_union_vt (void);
+
+
+/**
+ * Get the table with implementing functions for
+ * set intersection.
+ *
+ * @return the operation specific VTable
+ */
+const struct SetVT *
+_GSS_intersection_vt (void);
#endif
projects / oweals / gnunet.git / blobdiff