src/set/gnunet-service-set.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2013 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 3, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file set/gnunet-service-set.h
  23  * @brief common components for the implementation the different set operations
  24  * @author Florian Dold
  25  */
  26
  27 #ifndef GNUNET_SERVICE_SET_H_PRIVATE
  28 #define GNUNET_SERVICE_SET_H_PRIVATE
  29
  30 #include "platform.h"
  31 #include "gnunet_util_lib.h"
  32 #include "gnunet_protocols.h"
  33 #include "gnunet_applications.h"
  34 #include "gnunet_core_service.h"
  35 #include "gnunet_mesh_service.h"
  36 #include "gnunet_set_service.h"
  37 #include "set.h"
  38
  39
  40 /**
  41  * Implementation-specific set state.
  42  * Used as opaque pointer, and specified further
  43  * in the respective implementation.
  44  */
  45 struct SetState;
  46
  47
  48 /**
  49  * Implementation-specific set operation.
  50  * Used as opaque pointer, and specified further
  51  * in the respective implementation.
  52  */
  53 struct OperationState;
  54
  55
  56 /* forward declarations */
  57 struct Set;
  58 struct ElementEntry;
  59 struct Operation;
  60
  61
  62 /**
  63  * Detail information about an operation.
  64  */
  65 struct OperationSpecification
  66 {
  67   /**
  68    * The type of the operation.
  69    */
  70   enum GNUNET_SET_OperationType operation;
  71
  72   /**
  73    * The remove peer we evaluate the operation with
  74    */
  75   struct GNUNET_PeerIdentity peer;
  76
  77   /**
  78    * Application ID for the operation, used to distinguish
  79    * multiple operations of the same type with the same peer.
  80    */
  81   struct GNUNET_HashCode app_id;
  82
  83   /**
  84    * Context message, may be NULL.
  85    */
  86   struct GNUNET_MessageHeader *context_msg;
  87
  88   /**
  89    * Salt to use for the operation.
  90    */
  91   uint32_t salt;
  92
  93   /**
  94    * ID used to identify responses to a client.
  95    */
  96   uint32_t client_request_id;
  97
  98   /**
  99    * Set associated with the operation, NULL until the spec has been associated
 100    * with a set.
 101    */
 102   struct Set *set;
 103
 104   /**
 105    * When are elements sent to the client, and which elements are sent?
 106    */
 107   enum GNUNET_SET_ResultMode result_mode;
 108 };
 109
 110
 111
 112
 113 /**
 114  * Signature of functions that create the implementation-specific
 115  * state for a set supporting a specific operation.
 116  *
 117  * @return a set state specific to the supported operation
 118  */
 119 typedef struct SetState *(*CreateImpl) (void);
 120
 121
 122 /**
 123  * Signature of functions that implement the add/remove functionality
 124  * for a set supporting a specific operation.
 125  *
 126  * @param set implementation-specific set state
 127  * @param msg element message from the client
 128  */
 129 typedef void (*AddRemoveImpl) (struct SetState *state, struct ElementEntry *ee);
 130
 131
 132 /**
 133  * Signature of functions that handle disconnection
 134  * of the remote peer.
 135  *
 136  * @param op the set operation, contains implementation-specific data
 137  */
 138 typedef void (*PeerDisconnectImpl) (struct Operation *op);
 139
 140
 141 /**
 142  * Signature of functions that implement the destruction of the
 143  * implementation-specific set state.
 144  *
 145  * @param state the set state, contains implementation-specific data
 146  */
 147 typedef void (*DestroySetImpl) (struct SetState *state);
 148
 149
 150 /**
 151  * Signature of functions that implement the creation of set operations
 152  * (currently evaluate and accept).
 153  *
 154  * @param op operation that is created, should be initialized by the implementation
 155  */
 156 typedef void (*OpCreateImpl) (struct Operation *op);
 157
 158
 159 /**
 160  * Signature of functions that implement the message handling for
 161  * the different set operations.
 162  *
 163  * @param op operation state
 164  * @param msg received message
 165  * @return GNUNET_OK on success, GNUNET_SYSERR to
 166  *         destroy the operation and the tunnel
 167  */
 168 typedef int (*MsgHandlerImpl) (struct Operation *op,
 169                                const struct GNUNET_MessageHeader *msg);
 170
 171 typedef void (*CancelImpl) (struct Operation *op);
 172
 173
 174 /**
 175  * Signature of functions that implement sending all the set's
 176  * elements to the client.
 177  *
 178  * @param set set that should be iterated over
 179  */
 180 typedef void (*IterateImpl) (struct Set *set);
 181
 182
 183 /**
 184  * Dispatch table for a specific set operation.
 185  * Every set operation has to implement the callback
 186  * in this struct.
 187  */
 188 struct SetVT
 189 {
 190   /**
 191    * Callback for the set creation.
 192    */
 193   CreateImpl create;
 194
 195   /**
 196    * Callback for element insertion
 197    */
 198   AddRemoveImpl add;
 199
 200   /**
 201    * Callback for element removal.
 202    */
 203   AddRemoveImpl remove;
 204
 205   /**
 206    * Callback for accepting a set operation request
 207    */
 208   OpCreateImpl accept;
 209
 210   /**
 211    * Callback for starting evaluation with a remote peer.
 212    */
 213   OpCreateImpl evaluate;
 214
 215   /**
 216    * Callback for destruction of the set state.
 217    */
 218   DestroySetImpl destroy_set;
 219
 220   /**
 221    * Callback for handling operation-specific messages.
 222    */
 223   MsgHandlerImpl msg_handler;
 224
 225   /**
 226    * Callback for handling the remote peer's
 227    * disconnect.
 228    */
 229   PeerDisconnectImpl peer_disconnect;
 230
 231   /**
 232    * Callback for canceling an operation by
 233    * its ID.
 234    */
 235   CancelImpl cancel;
 236
 237   /**
 238    * Callback for iterating over all set elements.
 239    */
 240   IterateImpl iterate;
 241 };
 242
 243
 244 /**
 245  * Information about an element element in the set.
 246  * All elements are stored in a hash-table
 247  * from their hash-code to their 'struct Element',
 248  * so that the remove and add operations are reasonably
 249  * fast.
 250  */
 251 struct ElementEntry
 252 {
 253   /**
 254    * The actual element. The data for the element
 255    * should be allocated at the end of this struct.
 256    */
 257   struct GNUNET_SET_Element element;
 258
 259   /**
 260    * Hash of the element.
 261    * For set union:
 262    * Will be used to derive the different IBF keys
 263    * for different salts.
 264    */
 265   struct GNUNET_HashCode element_hash;
 266
 267   /**
 268    * Generation the element was added by the client.
 269    * Operations of earlier generations will not consider the element.
 270    */
 271   unsigned int generation_added;
 272
 273   /**
 274    * GNUNET_YES if the element has been removed in some generation.
 275    */
 276   int removed;
 277
 278   /**
 279    * Generation the element was removed by the client.
 280    * Operations of later generations will not consider the element.
 281    * Only valid if is_removed is GNUNET_YES.
 282    */
 283   unsigned int generation_removed;
 284
 285   /**
 286    * GNUNET_YES if the element is a remote element, and does not belong
 287    * to the operation's set.
 288    */
 289   int remote;
 290 };
 291
 292
 293 struct Operation
 294 {
 295   /**
 296    * V-Table for the operation belonging
 297    * to the tunnel contest.
 298    */
 299   const struct SetVT *vt;
 300
 301   /**
 302    * Tunnel to the peer.
 303    */
 304   struct GNUNET_MESH_Tunnel *tunnel;
 305
 306   /**
 307    * Message queue for the tunnel.
 308    */
 309   struct GNUNET_MQ_Handle *mq;
 310
 311   /**
 312    * GNUNET_YES if this is not a "real" set operation yet, and we still
 313    * need to wait for the other peer to give us more details.
 314    */
 315   int is_incoming;
 316
 317   /**
 318    * Generation in which the operation handle
 319    * was created.
 320    */
 321   unsigned int generation_created;
 322
 323   /**
 324    * Detail information about the set operation,
 325    * including the set to use.
 326    * When 'spec' is NULL, the operation is not yet entirely
 327    * initialized.
 328    */
 329   struct OperationSpecification *spec;
 330
 331   /**
 332    * Operation-specific operation state.
 333    */
 334   struct OperationState *state;
 335
 336   /**
 337    * Evaluate operations are held in
 338    * a linked list.
 339    */
 340   struct Operation *next;
 341
 342    /**
 343     * Evaluate operations are held in
 344     * a linked list.
 345     */
 346   struct Operation *prev;
 347 };
 348
 349
 350 /**
 351  * A set that supports a specific operation
 352  * with other peers.
 353  */
 354 struct Set
 355 {
 356   /**
 357    * Client that owns the set.
 358    * Only one client may own a set.
 359    */
 360   struct GNUNET_SERVER_Client *client;
 361
 362   /**
 363    * Message queue for the client
 364    */
 365   struct GNUNET_MQ_Handle *client_mq;
 366
 367   /**
 368    * Type of operation supported for this set
 369    */
 370   enum GNUNET_SET_OperationType operation;
 371
 372   /**
 373    * Virtual table for this set.
 374    * Determined by the operation type of this set.
 375    */
 376   const struct SetVT *vt;
 377
 378   /**
 379    * Sets are held in a doubly linked list.
 380    */
 381   struct Set *next;
 382
 383   /**
 384    * Sets are held in a doubly linked list.
 385    */
 386   struct Set *prev;
 387
 388   /**
 389    * Implementation-specific state.
 390    */
 391   struct SetState *state;
 392
 393   /**
 394    * Current state of iterating elements for the client.
 395    * NULL if we are not currently iterating.
 396    */
 397   struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
 398
 399   /**
 400    * Maps 'struct GNUNET_HashCode' to 'struct ElementEntry'.
 401    */
 402   struct GNUNET_CONTAINER_MultiHashMap *elements;
 403
 404   /**
 405    * Current generation, that is, number of
 406    * previously executed operations on this set
 407    */
 408   unsigned int current_generation;
 409
 410   /**
 411    * Evaluate operations are held in
 412    * a linked list.
 413    */
 414   struct Operation *ops_head;
 415
 416   /**
 417    * Evaluate operations are held in
 418    * a linked list.
 419    */
 420   struct Operation *ops_tail;
 421 };
 422
 423
 424 void
 425 _GSS_operation_destroy (struct Operation *op);
 426
 427
 428 /**
 429  * Get the table with implementing functions for
 430  * set union.
 431  */
 432 const struct SetVT *
 433 _GSS_union_vt (void);
 434
 435
 436 /**
 437  * Get the table with implementing functions for
 438  * set intersection.
 439  */
 440 const struct SetVT *
 441 _GSS_intersection_vt (void);
 442
 443
 444 #endif