src/include/gnunet_set_service.h

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2013, 2014 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, USA.
  19  */
  20
  21 /**
  22  * @author Florian Dold
  23  * @author Christian Grothoff
  24  *
  25  * @file
  26  * Two-peer set operations
  27  *
  28  * @defgroup set  Set service
  29  * Two-peer set operations
  30  *
  31  * @see [Documentation](https://gnunet.org/set-subsystem)
  32  *
  33  * @{
  34  */
  35
  36 #ifndef GNUNET_SET_SERVICE_H
  37 #define GNUNET_SET_SERVICE_H
  38
  39 #ifdef __cplusplus
  40 extern "C"
  41 {
  42 #if 0                           /* keep Emacsens' auto-indent happy */
  43 }
  44 #endif
  45 #endif
  46
  47 #include "gnunet_common.h"
  48 #include "gnunet_time_lib.h"
  49 #include "gnunet_configuration_lib.h"
  50
  51
  52 /**
  53  * Maximum size of a context message for set operation requests.
  54  */
  55 #define GNUNET_SET_CONTEXT_MESSAGE_MAX_SIZE ((1<<16) - 1024)
  56
  57
  58 /**
  59  * Opaque handle to a set.
  60  */
  61 struct GNUNET_SET_Handle;
  62
  63 /**
  64  * Opaque handle to a set operation request from another peer.
  65  */
  66 struct GNUNET_SET_Request;
  67
  68 /**
  69  * Opaque handle to a listen operation.
  70  */
  71 struct GNUNET_SET_ListenHandle;
  72
  73 /**
  74  * Opaque handle to a set operation.
  75  */
  76 struct GNUNET_SET_OperationHandle;
  77
  78
  79 /**
  80  * The operation that a set set supports.
  81  */
  82 enum GNUNET_SET_OperationType
  83 {
  84   /**
  85    * A purely local set that does not support any operation.
  86    */
  87   GNUNET_SET_OPERATION_NONE,
  88
  89   /**
  90    * Set intersection, only return elements that are in both sets.
  91    */
  92   GNUNET_SET_OPERATION_INTERSECTION,
  93
  94   /**
  95    * Set union, return all elements that are in at least one of the sets.
  96    */
  97   GNUNET_SET_OPERATION_UNION
  98 };
  99
 100
 101 /**
 102  * Status for the result callback
 103  */
 104 enum GNUNET_SET_Status
 105 {
 106   /**
 107    * Everything went ok, we are transmitting an element of the
 108    * result (in set, or to be removed from set, depending on
 109    * the `enum GNUNET_SET_ResultMode`).
 110    *
 111    * Only applies to
 112    * #GNUNET_SET_RESULT_FULL,
 113    * #GNUNET_SET_RESULT_ADDED,
 114    * #GNUNET_SET_RESULT_REMOVED,
 115    */
 116   GNUNET_SET_STATUS_OK,
 117
 118   /**
 119    * Element should be added to the result set
 120    * of the local peer, i.e. the local peer is
 121    * missing an element.
 122    *
 123    * Only applies to #GNUNET_SET_RESULT_SYMMETRIC
 124    */
 125   GNUNET_SET_STATUS_ADD_LOCAL,
 126
 127   /**
 128    * Element should be added to the result set
 129    * of the remote peer, i.e. the remote peer is
 130    * missing an element.
 131    *
 132    * Only applies to #GNUNET_SET_RESULT_SYMMETRIC
 133    */
 134   GNUNET_SET_STATUS_ADD_REMOTE,
 135
 136   /**
 137    * The other peer refused to to the operation with us,
 138    * or something went wrong.
 139    */
 140   GNUNET_SET_STATUS_FAILURE,
 141
 142   /**
 143    * Success, all elements have been returned (but the other peer
 144    * might still be receiving some from us, so we are not done).  Only
 145    * used during UNION operation.
 146    */
 147   GNUNET_SET_STATUS_HALF_DONE,
 148
 149   /**
 150    * Success, all elements have been sent (and received).
 151    */
 152   GNUNET_SET_STATUS_DONE
 153 };
 154
 155
 156
 157 /**
 158  * The way results are given to the client.
 159  */
 160 enum GNUNET_SET_ResultMode
 161 {
 162   /**
 163    * Client gets every element in the resulting set.
 164    *
 165    * Only supported for set intersection.
 166    */
 167   GNUNET_SET_RESULT_FULL,
 168
 169   /**
 170    * Client gets notified of the required changes
 171    * for both the local and the remote set.
 172    *
 173    * Only supported for set
 174    */
 175   GNUNET_SET_RESULT_SYMMETRIC,
 176
 177   /**
 178    * Client gets only elements that have been removed from the set.
 179    *
 180    * Only supported for set intersection.
 181    */
 182   GNUNET_SET_RESULT_REMOVED,
 183
 184   /**
 185    * Client gets only elements that have been added to the set.
 186    *
 187    * Only supported for set union.
 188    */
 189   GNUNET_SET_RESULT_ADDED
 190 };
 191
 192
 193 /**
 194  * Element stored in a set.
 195  */
 196 struct GNUNET_SET_Element
 197 {
 198   /**
 199    * Number of bytes in the buffer pointed to by data.
 200    */
 201   uint16_t size;
 202
 203   /**
 204    * Application-specific element type.
 205    */
 206   uint16_t element_type;
 207
 208   /**
 209    * Actual data of the element
 210    */
 211   const void *data;
 212 };
 213
 214
 215 /**
 216  * Possible options to pass to a set operation.
 217  *
 218  * Used as tag for struct #GNUNET_SET_Option.
 219  */
 220 enum GNUNET_SET_OptionType
 221 {
 222   /**
 223    * List terminator.
 224    */
 225   GNUNET_SET_OPTION_END=0,
 226   /**
 227    * Fail set operations when the other peer shows weird behavior
 228    * that might by a Byzantine fault.
 229    *
 230    * For set union, 'v.num' is a lower bound on elements
 231    * that the other peer must have in common with us.
 232    */
 233   GNUNET_SET_OPTION_BYZANTINE=1,
 234   /**
 235    * Do not use the optimized set operation, but send full sets.
 236    * Might trigger Byzantine fault detection.
 237    */
 238   GNUNET_SET_OPTION_FORCE_FULL=2,
 239   /**
 240    * Only use optimized set operations, even though for this
 241    * particular set operation they might be much slower.
 242    * Might trigger Byzantine fault detection.
 243    */
 244   GNUNET_SET_OPTION_FORCE_DELTA=4,
 245 };
 246
 247
 248 /**
 249  * Option for set operations.
 250  */
 251 struct GNUNET_SET_Option
 252 {
 253   /**
 254    * Type of the option.
 255    */
 256   enum GNUNET_SET_OptionType type;
 257
 258   /**
 259    * Value for the option, only used with some options.
 260    */
 261   union {
 262     uint64_t num;
 263   } v;
 264 };
 265
 266
 267 /**
 268  * Continuation used for some of the set operations
 269  *
 270  * @param cls closure
 271  */
 272 typedef void
 273 (*GNUNET_SET_Continuation) (void *cls);
 274
 275
 276 /**
 277  * Callback for set operation results. Called for each element
 278  * in the result set.
 279  *
 280  * @param cls closure
 281  * @param element a result element, only valid if status is #GNUNET_SET_STATUS_OK
 282  * @param current_size current set size
 283  * @param status see `enum GNUNET_SET_Status`
 284  */
 285 typedef void
 286 (*GNUNET_SET_ResultIterator) (void *cls,
 287                               const struct GNUNET_SET_Element *element,
 288                               uint64_t current_size,
 289                               enum GNUNET_SET_Status status);
 290
 291 /**
 292  * Iterator for set elements.
 293  *
 294  * @param cls closure
 295  * @param element the current element, NULL if all elements have been
 296  *        iterated over
 297  * @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop.
 298  */
 299 typedef int
 300 (*GNUNET_SET_ElementIterator) (void *cls,
 301                                const struct GNUNET_SET_Element *element);
 302
 303
 304 /**
 305  * Called when another peer wants to do a set operation with the
 306  * local peer. If a listen error occurs, the @a request is NULL.
 307  *
 308  * @param cls closure
 309  * @param other_peer the other peer
 310  * @param context_msg message with application specific information from
 311  *        the other peer
 312  * @param request request from the other peer (never NULL), use GNUNET_SET_accept()
 313  *        to accept it, otherwise the request will be refused
 314  *        Note that we can't just return value from the listen callback,
 315  *        as it is also necessary to specify the set we want to do the
 316  *        operation with, whith sometimes can be derived from the context
 317  *        message. It's necessary to specify the timeout.
 318  */
 319 typedef void
 320 (*GNUNET_SET_ListenCallback) (void *cls,
 321                               const struct GNUNET_PeerIdentity *other_peer,
 322                               const struct GNUNET_MessageHeader *context_msg,
 323                               struct GNUNET_SET_Request *request);
 324
 325
 326
 327 typedef void
 328 (*GNUNET_SET_CopyReadyCallback) (void *cls,
 329                                  struct GNUNET_SET_Handle *copy);
 330
 331
 332 /**
 333  * Create an empty set, supporting the specified operation.
 334  *
 335  * @param cfg configuration to use for connecting to the
 336  *        set service
 337  * @param op operation supported by the set
 338  *        Note that the operation has to be specified
 339  *        beforehand, as certain set operations need to maintain
 340  *        data structures spefific to the operation
 341  * @return a handle to the set
 342  */
 343 struct GNUNET_SET_Handle *
 344 GNUNET_SET_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
 345                    enum GNUNET_SET_OperationType op);
 346
 347
 348 /**
 349  * Add an element to the given set.
 350  * After the element has been added (in the sense of being
 351  * transmitted to the set service), @a cont will be called.
 352  * Calls to #GNUNET_SET_add_element can be queued
 353  *
 354  * @param set set to add element to
 355  * @param element element to add to the set
 356  * @param cont continuation called after the element has been added
 357  * @param cont_cls closure for @a cont
 358  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
 359  *         set is invalid (e.g. the set service crashed)
 360  */
 361 int
 362 GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
 363                         const struct GNUNET_SET_Element *element,
 364                         GNUNET_SET_Continuation cont,
 365                         void *cont_cls);
 366
 367
 368 /**
 369  * Remove an element to the given set.
 370  * After the element has been removed (in the sense of the
 371  * request being transmitted to the set service), cont will be called.
 372  * Calls to remove_element can be queued
 373  *
 374  * @param set set to remove element from
 375  * @param element element to remove from the set
 376  * @param cont continuation called after the element has been removed
 377  * @param cont_cls closure for @a cont
 378  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
 379  *         set is invalid (e.g. the set service crashed)
 380  */
 381 int
 382 GNUNET_SET_remove_element (struct GNUNET_SET_Handle *set,
 383                            const struct GNUNET_SET_Element *element,
 384                            GNUNET_SET_Continuation cont,
 385                            void *cont_cls);
 386
 387
 388 void
 389 GNUNET_SET_copy_lazy (struct GNUNET_SET_Handle *set,
 390                       GNUNET_SET_CopyReadyCallback cb,
 391                       void *cls);
 392
 393
 394 /**
 395  * Destroy the set handle, and free all associated resources.
 396  * Iterations must have completed (or be explicitly canceled)
 397  * before destroying the corresponding set.  Operations may
 398  * still be pending when a set is destroyed.
 399  *
 400  * @param set set to destroy
 401  */
 402 void
 403 GNUNET_SET_destroy (struct GNUNET_SET_Handle *set);
 404
 405
 406 /**
 407  * Prepare a set operation to be evaluated with another peer.
 408  * The evaluation will not start until the client provides
 409  * a local set with GNUNET_SET_commit().
 410  *
 411  * @param other_peer peer with the other set
 412  * @param app_id hash for the application using the set
 413  * @param context_msg additional information for the request
 414  * @param result_mode specified how results will be returned,
 415  *        see `enum GNUNET_SET_ResultMode`.
 416  * @param result_cb called on error or success
 417  * @param result_cls closure for @a result_cb
 418  * @return a handle to cancel the operation
 419  */
 420 struct GNUNET_SET_OperationHandle *
 421 GNUNET_SET_prepare (const struct GNUNET_PeerIdentity *other_peer,
 422                     const struct GNUNET_HashCode *app_id,
 423                     const struct GNUNET_MessageHeader *context_msg,
 424                     enum GNUNET_SET_ResultMode result_mode,
 425                     struct GNUNET_SET_Option options[],
 426                     GNUNET_SET_ResultIterator result_cb,
 427                     void *result_cls);
 428
 429
 430 /**
 431  * Wait for set operation requests for the given application ID.
 432  * If the connection to the set service is lost, the listener is
 433  * re-created transparently with exponential backoff.
 434  *
 435  * @param cfg configuration to use for connecting to
 436  *            the set service
 437  * @param operation operation we want to listen for
 438  * @param app_id id of the application that handles set operation requests
 439  * @param listen_cb called for each incoming request matching the operation
 440  *                  and application id
 441  * @param listen_cls handle for @a listen_cb
 442  * @return a handle that can be used to cancel the listen operation
 443  */
 444 struct GNUNET_SET_ListenHandle *
 445 GNUNET_SET_listen (const struct GNUNET_CONFIGURATION_Handle *cfg,
 446                    enum GNUNET_SET_OperationType op_type,
 447                    const struct GNUNET_HashCode *app_id,
 448                    GNUNET_SET_ListenCallback listen_cb,
 449                    void *listen_cls);
 450
 451
 452 /**
 453  * Cancel the given listen operation.  After calling cancel, the
 454  * listen callback for this listen handle will not be called again.
 455  *
 456  * @param lh handle for the listen operation
 457  */
 458 void
 459 GNUNET_SET_listen_cancel (struct GNUNET_SET_ListenHandle *lh);
 460
 461
 462 /**
 463  * Accept a request we got via GNUNET_SET_listen().  Must be called during
 464  * GNUNET_SET_listen(), as the `struct GNUNET_SET_Request` becomes invalid
 465  * afterwards.
 466  * Call GNUNET_SET_commit() to provide the local set to use for the operation,
 467  * and to begin the exchange with the remote peer.
 468  *
 469  * @param request request to accept
 470  * @param result_mode specified how results will be returned,
 471  *        see `enum GNUNET_SET_ResultMode`.
 472  * @param result_cb callback for the results
 473  * @param result_cls closure for @a result_cb
 474  * @return a handle to cancel the operation
 475  */
 476 struct GNUNET_SET_OperationHandle *
 477 GNUNET_SET_accept (struct GNUNET_SET_Request *request,
 478                    enum GNUNET_SET_ResultMode result_mode,
 479                    struct GNUNET_SET_Option options[],
 480                    GNUNET_SET_ResultIterator result_cb,
 481                    void *result_cls);
 482
 483
 484 /**
 485  * Commit a set to be used with a set operation.
 486  * This function is called once we have fully constructed
 487  * the set that we want to use for the operation.  At this
 488  * time, the P2P protocol can then begin to exchange the
 489  * set information and call the result callback with the
 490  * result information.
 491  *
 492  * @param oh handle to the set operation
 493  * @param set the set to use for the operation
 494  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
 495  *         set is invalid (e.g. the set service crashed)
 496  */
 497 int
 498 GNUNET_SET_commit (struct GNUNET_SET_OperationHandle *oh,
 499                    struct GNUNET_SET_Handle *set);
 500
 501
 502 /**
 503  * Cancel the given set operation.  May not be called after the
 504  * operation's `GNUNET_SET_ResultIterator` has been called with a
 505  * status that indicates error, timeout or done.
 506  *
 507  * @param oh set operation to cancel
 508  */
 509 void
 510 GNUNET_SET_operation_cancel (struct GNUNET_SET_OperationHandle *oh);
 511
 512
 513 /**
 514  * Iterate over all elements in the given set.
 515  * Note that this operation involves transferring every element of the set
 516  * from the service to the client, and is thus costly.
 517  * Only one iteration per set may be active at the same time.
 518  *
 519  * @param set the set to iterate over
 520  * @param iter the iterator to call for each element
 521  * @param iter_cls closure for @a iter
 522  * @return #GNUNET_YES if the iteration started successfuly,
 523  *         #GNUNET_NO if another iteration was still active,
 524  *         #GNUNET_SYSERR if the set is invalid (e.g. the server crashed, disconnected)
 525  */
 526 int
 527 GNUNET_SET_iterate (struct GNUNET_SET_Handle *set,
 528                     GNUNET_SET_ElementIterator iter,
 529                     void *iter_cls);
 530
 531 /**
 532  * Stop iteration over all elements in the given set.  Can only
 533  * be called before the iteration has "naturally" completed its
 534  * turn.
 535  *
 536  * @param set the set to stop iterating over
 537  */
 538 void
 539 GNUNET_SET_iterate_cancel (struct GNUNET_SET_Handle *set);
 540
 541 /**
 542  * Create a copy of an element.  The copy
 543  * must be GNUNET_free-d by the caller.
 544  *
 545  * @param element the element to copy
 546  * @return the copied element
 547  */
 548 struct GNUNET_SET_Element *
 549 GNUNET_SET_element_dup (const struct GNUNET_SET_Element *element);
 550
 551 /**
 552  * Hash a set element.
 553  *
 554  * @param element the element that should be hashed
 555  * @param ret_hash a pointer to where the hash of @a element
 556  *        should be stored
 557  */
 558 void
 559 GNUNET_SET_element_hash (const struct GNUNET_SET_Element *element, struct GNUNET_HashCode *ret_hash);
 560
 561
 562 #if 0                           /* keep Emacsens' auto-indent happy */
 563 {
 564 #endif
 565 #ifdef __cplusplus
 566 }
 567 #endif
 568
 569 #endif
 570
 571 /** @} */  /* end of group */