projects / oweals / gnunet.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
fix state when requesting full IBF
[oweals/gnunet.git] / src / set / gnunet-service-set.h
diff --git a/src/set/gnunet-service-set.h b/src/set/gnunet-service-set.h
index 685fc47a4fb1e97f64dfe63a632aa007f6ea4fb2..68d8fe81f60a6a75fcffdaa7247765fca3a1ffc8 100644 (file)
--- a/src/set/gnunet-service-set.h
+++ b/src/set/gnunet-service-set.h
@@ -1,10 +1,10 @@
 /*
       This file is part of GNUnet
 /*
       This file is part of GNUnet
-      (C) 2013 Christian Grothoff (and other contributing authors)
+      Copyright (C) 2013, 2014 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
 
       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
       option) any later version.
 
       GNUnet is distributed in the hope that it will be useful, but
@@ -14,280 +14,655 @@
 
       You should have received a copy of the GNU General Public License
       along with GNUnet; see the file COPYING.  If not, write to the
 
       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.
 */
 */
-
 /**
 /**
- * @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
+ * @author Christian Grothoff
  */
  */
-
 #ifndef GNUNET_SERVICE_SET_H_PRIVATE
 #define GNUNET_SERVICE_SET_H_PRIVATE
 
 #include "platform.h"
 #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_protocols.h"
 #include "gnunet_applications.h"
-#include "gnunet_util_lib.h"
 #include "gnunet_core_service.h"
 #include "gnunet_core_service.h"
-#include "gnunet_stream_lib.h"
+#include "gnunet_cadet_service.h"
 #include "gnunet_set_service.h"
 #include "set.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;
 
 
+/**
+ * Implementation-specific set operation.  Used as opaque pointer, and
+ * specified further in the respective implementation.
+ */
+struct OperationState;
 
 /**
 
 /**
- * Extra state required for set union.
+ * A set that supports a specific operation with other peers.
  */
  */
-struct UnionState;
+struct Set;
 
 
+/**
+ * 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;
 
 /**
 
 /**
- * A set that supports a specific operation
- * with other peers.
+ * Operation context used to execute a set operation.
  */
  */
-struct Set
+struct Operation;
+
+
+/**
+ * Detail information about an operation.
+ */
+struct OperationSpecification
 {
 {
+
   /**
   /**
-   * Client that owns the set.
-   * Only one client may own a set.
+   * The remove peer we evaluate the operation with.
    */
    */
-  struct GNUNET_SERVER_Client *client;
+  struct GNUNET_PeerIdentity peer;
 
   /**
 
   /**
-   * Message queue for the client
+   * Application ID for the operation, used to distinguish
+   * multiple operations of the same type with the same peer.
    */
    */
-  struct GNUNET_MQ_MessageQueue *client_mq;
+  struct GNUNET_HashCode app_id;
 
   /**
 
   /**
-   * Type of operation supported for this set
+   * Context message, may be NULL.
    */
    */
-  uint32_t operation; // use enum from API
+  struct GNUNET_MessageHeader *context_msg;
 
   /**
 
   /**
-   * Sets are held in a doubly linked list.
+   * Set associated with the operation, NULL until the spec has been
+   * associated with a set.
    */
    */
-  struct Set *next;
+  struct Set *set;
 
   /**
 
   /**
-   * 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;
+
+  /**
+   * The type of the operation.
+   */
+  enum GNUNET_SET_OperationType operation;
+
+  /**
+   * 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;
 
   /**
 
   /**
-   * Appropriate state for each type of
-   * operation.
+   * #GNUNET_YES to fail operations where Byzantine faults
+   * are suspected
    */
    */
-  union {
-    struct IntersectionState *i;
-    struct UnionState *u;
-  } extra;
+  int byzantine;
+
+  /**
+   * Lower bound for the set size, used only when
+   * byzantine mode is enabled.
+   */
+  int byzantine_lower_bound;
 };
 
 
 /**
 };
 
 
 /**
- * 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, NULL on error
  */
  */
-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 ee element message from the client
+ */
+typedef void
+(*AddRemoveImpl) (struct SetState *state,
+                  struct ElementEntry *ee);
 
 
 /**
 
 
 /**
- * State of evaluation a set operation with
- * another peer
+ * Signature of functions that handle disconnection of the remote
+ * peer.
+ *
+ * @param op the set operation, contains implementation-specific data
  */
  */
-struct EvaluateOperation
+typedef void
+(*PeerDisconnectImpl) (struct Operation *op);
+
+
+/**
+ * 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 accepting a set operation.
+ *
+ * @param op operation that is created by accepting the operation,
+ *        should be initialized by the implementation
+ */
+typedef void
+(*OpAcceptImpl) (struct Operation *op);
+
+
+/**
+ * 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
+ */
+typedef void
+(*OpEvaluateImpl) (struct Operation *op,
+                   const struct GNUNET_MessageHeader *opaque_context);
+
+
+/**
+ * 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
+ */
+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);
+
+
+typedef struct SetState *
+(*CopyStateImpl) (struct Set *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;
+  OpAcceptImpl accept;
 
   /**
 
   /**
-   * Stream socket connected to the other peer
+   * Callback for starting evaluation with a remote peer.
    */
    */
-  struct GNUNET_STREAM_Socket *socket;
+  OpEvaluateImpl 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;
+  CancelImpl cancel;
 
 
-  union {
-    struct UnionEvaluateOperation *u;
-    struct IntersectionEvaluateOperation *i;
-  } extra;
+  CopyStateImpl copy_state;
 };
 
 
 };
 
 
-struct Listener
+/**
+ * MutationEvent gives information about changes
+ * to an element (removal / addition) in a set content.
+ */
+struct MutationEvent
 {
   /**
 {
   /**
-   * Listeners are held in a doubly linked list.
+   * First generation affected by this mutation event.
+   *
+   * If @a generation is 0, this mutation event is a list
+   * sentinel element.
    */
    */
-  struct Listener *next;
+  unsigned int generation;
 
   /**
 
   /**
-   * Listeners are held in a doubly linked list.
+   * If @a added is #GNUNET_YES, then this is a
+   * `remove` event, otherwise it is an `add` event.
    */
    */
-  struct Listener *prev;
+  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
+ * fast.
+ */
+struct ElementEntry
+{
   /**
   /**
-   * Client that owns the set.
-   * Only one client may own a set.
+   * The actual element. The data for the element
+   * should be allocated at the end of this struct.
    */
    */
-  struct GNUNET_SERVER_Client *client;
+  struct GNUNET_SET_Element element;
 
   /**
 
   /**
-   * Message queue for the client
+   * Hash of the element.  For set union: Will be used to derive the
+   * different IBF keys for different salts.
    */
    */
-  struct GNUNET_MQ_MessageQueue *client_mq;
+  struct GNUNET_HashCode element_hash;
 
   /**
 
   /**
-   * Type of operation supported for this set
+   * 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.
    */
    */
-  enum GNUNET_SET_OperationType operation;
+  struct MutationEvent *mutations;
 
   /**
 
   /**
-   * Application id of intereset for this listener.
+   * Number of elements in the array @a mutations.
    */
    */
-  struct GNUNET_HashCode app_id;
+  unsigned int mutations_size;
+
+  /**
+   * #GNUNET_YES if the element is a remote element, and does not belong
+   * to the operation's set.
+   */
+  int remote;
 };
 
 
 };
 
 
+struct Listener;
+
+
 /**
 /**
- * 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.
+ * Operation context used to execute a set operation.
  */
  */
-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
+   */
+  const struct SetVT *vt;
+
+  /**
+   * Channel to the peer.
+   */
+  struct GNUNET_CADET_Channel *channel;
+
+  /**
+   * Port this operation runs on.
+   */
+  struct Listener *listener;
+
+  /**
+   * Message queue for the channel.
+   */
+  struct GNUNET_MQ_Handle *mq;
+
+  /**
+   * 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.  Note that the exact
+   * type depends on this being a union or intersection operation
+   * (and thus on @e vt).
+   */
+  struct OperationState *state;
+
+  /**
+   * Evaluate operations are held in a linked list.
    */
    */
-  struct Incoming *next;
+  struct Operation *next;
 
   /**
 
   /**
-   * Incoming peers are held in a linked list
+   * Evaluate operations are held in a linked list.
    */
    */
-  struct Incoming *prev;
+  struct Operation *prev;
 
   /**
 
   /**
-   * Identity of the peer that connected to us
+   * 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;
 
   /**
    */
   struct GNUNET_PeerIdentity peer;
 
   /**
-   * Socket connected to the peer
+   * Timeout task, if the incoming peer has not been accepted
+   * after the timeout, it will be disconnected.
    */
    */
-  struct GNUNET_STREAM_Socket *socket;
+  struct GNUNET_SCHEDULER_Task *timeout_task;
 
   /**
 
   /**
-   * Message queue for the peer
+   * 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.
    */
    */
-  struct GNUNET_MQ_MessageQueue *mq;
+  uint32_t suggest_id;
 
   /**
 
   /**
-   * App code, set once the peer has
-   * requested an operation
+   * #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_HashCode app_id;
+  int is_incoming;
 
   /**
 
   /**
-   * Context message, set once the peer
-   * has requested an operation.
+   * Generation in which the operation handle
+   * was created.
    */
    */
-  struct GNUNET_MessageHeader *context_msg;
+  unsigned int generation_created;
 
   /**
 
   /**
-   * Operation the other peer wants to do
+   * Incremented whenever (during shutdown) some component still
+   * needs to do something with this before the operation is freed.
+   * (Used as a reference counter, but only during termination.)
    */
    */
-  enum GNUNET_SET_OperationType operation;
+  unsigned int keep;
+};
+
+
+/**
+ * SetContent stores the actual set elements,
+ * which may be shared by multiple generations derived
+ * from one set.
+ */
+struct SetContent
+{
+  /**
+   * Number of references to the content.
+   */
+  unsigned int refcount;
+
+  /**
+   * Maps `struct GNUNET_HashCode *` to `struct ElementEntry *`.
+   */
+  struct GNUNET_CONTAINER_MultiHashMap *elements;
+
+  unsigned int latest_generation;
+
+  /**
+   * 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 PendingMutation *pending_mutations_head;
+
+  /**
+   * 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 PendingMutation *pending_mutations_tail;
 
   /**
 
   /**
-   * Request id associated with the
-   * request coming from this client
+   * Number of concurrently active iterators.
    */
    */
-  uint32_t request_id;
+  int iterator_count;
+};
+
+
+struct GenerationRange
+{
+  /**
+   * First generation that is excluded.
+   */
+  unsigned int start;
+
+  /**
+   * Generation after the last excluded generation.
+   */
+  unsigned int end;
+};
+
+
+struct PendingMutation
+{
+  struct PendingMutation *prev;
+  struct PendingMutation *next;
+
+  struct Set *set;
+
+  /**
+   * Message that describes the desired mutation.
+   * May only be a #GNUNET_MESSAGE_TYPE_SET_ADD or
+   * #GNUNET_MESSAGE_TYPE_SET_REMOVE.
+   */
+  struct GNUNET_MessageHeader *mutation_message;
 };
 
 
 /**
 };
 
 
 /**
- * Configuration of the local peer
+ * A set that supports a specific operation with other peers.
  */
  */
-extern const struct GNUNET_CONFIGURATION_Handle *configuration;
+struct Set
+{
+
+  /**
+   * Sets are held in a doubly linked list (in `sets_head` and `sets_tail`).
+   */
+  struct Set *next;
+
+  /**
+   * Sets are held in a doubly linked list.
+   */
+  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 GNUNET_SERVICE_Client *client;
+
+  /**
+   * Message queue for the client.
+   */
+  struct GNUNET_MQ_Handle *client_mq;
+
+  /**
+   * 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;
+
+  /**
+   * Evaluate operations are held in a linked list.
+   */
+  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 and lazy copies on the underlying set content.
+   */
+  unsigned int current_generation;
+
+  /**
+   * List of generations we have to exclude, due to lazy copies.
+   */
+  struct GenerationRange *excluded_generations;
+
+  /**
+   * Number of elements in array @a excluded_generations.
+   */
+  unsigned int excluded_generations_size;
+
+  /**
+   * Type of operation supported for this set
+   */
+  enum GNUNET_SET_OperationType operation;
+
+  /**
+   * Each @e iter is assigned a unique number, so that the client
+   * can distinguish iterations.
+   */
+  uint16_t iteration_id;
+
+  /**
+   * Generation we're currently iteration over.
+   */
+  unsigned int iter_generation;
+
+  /**
+   * Content, possibly shared by multiple sets,
+   * and thus reference counted.
+   */
+  struct SetContent *content;
+};
+
+
+extern struct GNUNET_STATISTICS_Handle *_GSS_statistics;
 
 
 /**
 
 
 /**
- * Disconnect a client and free all resources
- * that the client allocated (e.g. Sets or Listeners)
+ * 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 client the client to disconnect
+ * @param op operation to destroy
+ * @param gc #GNUNET_YES to perform garbage collection on the set
  */
 void
  */
 void
-client_disconnect (struct GNUNET_SERVER_Client *client);
+_GSS_operation_destroy (struct Operation *op,
+                        int gc);
 
 
 
 
-struct Set *
-union_set_create (void);
-
+/**
+ * Get the table with implementing functions for set union.
+ *
+ * @return the operation specific VTable
+ */
+const struct SetVT *
+_GSS_union_vt (void);
 
 
-void
-union_evaluate (struct EvaluateOperation *eo);
 
 
+/**
+ * Get the table with implementing functions for set intersection.
+ *
+ * @return the operation specific VTable
+ */
+const struct SetVT *
+_GSS_intersection_vt (void);
 
 
-void
-union_add (struct Set *set, struct ElementMessage *m);
 
 
+int
+_GSS_is_element_of_set (struct ElementEntry *ee,
+                        struct Set *set);
 
 
-void
-union_accept (struct EvaluateOperation *eo, struct Incoming *incoming);
+int
+_GSS_is_element_of_operation (struct ElementEntry *ee,
+                              struct Operation *op);
 
 
 #endif
 
 
 #endif
Unnamed repository; edit this file 'description' to name the repository.