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
#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_mesh_service.h"
#include "gnunet_set_service.h"
/* forward declarations */
struct Set;
-struct TunnelContext;
+struct ElementEntry;
+struct Operation;
/**
uint32_t salt;
/**
- * ID used to identify responses to a client.
+ * Remote peers element count
+ */
+ uint32_t remote_element_count;
+
+ /**
+ * ID used to identify an operation between service and client
*/
uint32_t client_request_id;
* with a set.
*/
struct Set *set;
+
+ /**
+ * When are elements sent to the client, and which elements are sent?
+ */
+ enum GNUNET_SET_ResultMode result_mode;
};
+
+
/**
* Signature of functions that create the implementation-specific
* state 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, const struct GNUNET_SET_Element *element);
+typedef void (*AddRemoveImpl) (struct SetState *state, struct ElementEntry *ee);
/**
*
* @param op the set operation, contains implementation-specific data
*/
-typedef void (*PeerDisconnectImpl) (struct OperationState *op);
+typedef void (*PeerDisconnectImpl) (struct Operation *op);
/**
* Signature of functions that implement the creation of set operations
* (currently evaluate and accept).
*
- * @param spec specification of the set operation to be created
- * @param tunnel the tunnel with the other peer
- * @param tc tunnel context
+ * @param op operation that is created, should be initialized by the implementation
*/
-typedef void (*OpCreateImpl) (struct OperationSpecification *spec,
- struct GNUNET_MESH_Tunnel *tunnel,
- struct TunnelContext *tc);
+typedef void (*OpCreateImpl) (struct Operation *op);
/**
* @return GNUNET_OK on success, GNUNET_SYSERR to
* destroy the operation and the tunnel
*/
-typedef int (*MsgHandlerImpl) (struct OperationState *op,
+typedef int (*MsgHandlerImpl) (struct Operation *op,
const struct GNUNET_MessageHeader *msg);
-typedef void (*CancelImpl) (struct SetState *set,
- uint32_t request_id);
+/**
+ * Signature of functions that implement operation cancellation
+ *
+ * @param op operation state
+ */
+typedef void (*CancelImpl) (struct Operation *op);
/**
};
+/**
+ * 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
+{
+ /**
+ * The actual element. The data for the element
+ * should be allocated at the end of this struct.
+ */
+ struct GNUNET_SET_Element element;
+
+ /**
+ * 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.
+ */
+ unsigned int generation_added;
+
+ /**
+ * GNUNET_YES if the element has been removed in some generation.
+ */
+ int removed;
+
+ /**
+ * 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.
+ */
+ unsigned int generation_removed;
+
+ /**
+ * 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
+ */
+ int remote;
+};
+
+
+struct Operation
+{
+ /**
+ * V-Table for the operation belonging
+ * to the tunnel contest.
+ *
+ * Used for all operation specific operations after receiving the ops request
+ */
+ const struct SetVT *vt;
+
+ /**
+ * Tunnel to the peer.
+ */
+ struct GNUNET_MESH_Channel *channel;
+
+ /**
+ * Message queue for the tunnel.
+ */
+ 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.
+ */
+ int is_incoming;
+
+ /**
+ * Generation in which the operation handle
+ * was created.
+ */
+ unsigned int generation_created;
+
+ /**
+ * Detail information about the set operation,
+ * including the set to use.
+ * When 'spec' is NULL, the operation is not yet entirely
+ * initialized.
+ */
+ struct OperationSpecification *spec;
+
+ /**
+ * Operation-specific operation state.
+ */
+ struct OperationState *state;
+
+ /**
+ * Evaluate operations are held in
+ * a linked list.
+ */
+ struct Operation *next;
+
+ /**
+ * Evaluate operations are held in
+ * a linked list.
+ */
+ struct Operation *prev;
+
+ /**
+ * Set to GNUNET_YES if the set service should not free
+ * the operation, as it is still needed (e.g. in some scheduled task).
+ */
+ int keep;
+};
+
+
/**
* A set that supports a specific operation
* with other peers.
/**
* 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 SetState *state;
-};
+ /**
+ * Current state of iterating elements for the client.
+ * NULL if we are not currently iterating.
+ */
+ struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
-/**
- * Information about a tunnel we are connected to.
- * Used as tunnel context with mesh.
- */
-struct TunnelContext
-{
/**
- * V-Table for the operation belonging
- * to the tunnel contest.
+ * Maps 'struct GNUNET_HashCode' to 'struct ElementEntry'.
*/
- const struct SetVT *vt;
+ struct GNUNET_CONTAINER_MultiHashMap *elements;
+
+ /**
+ * 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;
/**
- * Implementation-specific operation state.
+ * Evaluate operations are held in
+ * a linked list.
*/
- struct OperationState *op;
+ 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
+_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