src/include/gnunet_psycstore_service.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 include/gnunet_psycstore_service.h
  23  * @brief PSYCstore service; implements persistent storage for the PSYC service
  24  * @author Gabor X Toth
  25  * @author Christian Grothoff
  26  */
  27 #ifndef GNUNET_PSYCSTORE_SERVICE_H
  28 #define GNUNET_PSYCSTORE_SERVICE_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 #include "gnunet_util_lib.h"
  39 #include "gnunet_env_lib.h"
  40 #include "gnunet_multicast_service.h"
  41 #include "gnunet_psyc_service.h"
  42
  43 /**
  44  * Version number of GNUnet PSYCstore API.
  45  */
  46 #define GNUNET_PSYCSTORE_VERSION 0x00000000
  47
  48 /**
  49  * Flags for stored messages.
  50  */
  51 enum GNUNET_PSYCSTORE_MessageFlags
  52 {
  53   /**
  54    * The message contains state modifiers.
  55    */
  56   GNUNET_PSYCSTORE_MESSAGE_STATE = 1 << 0,
  57
  58   /**
  59    * The state modifiers have been applied to the state store.
  60    */
  61   GNUNET_PSYCSTORE_MESSAGE_STATE_APPLIED = 1 << 1,
  62
  63   /**
  64    * The message contains a state hash.
  65    */
  66   GNUNET_PSYCSTORE_MESSAGE_STATE_HASH = 1 << 2
  67 };
  68
  69
  70 /**
  71  * Handle for a PSYCstore
  72  */
  73 struct GNUNET_PSYCSTORE_Handle;
  74
  75
  76 /**
  77  * Connect to the PSYCstore service.
  78  *
  79  * @param cfg Configuration to use.
  80  *
  81  * @return Handle for the connecton.
  82  */
  83 struct GNUNET_PSYCSTORE_Handle *
  84 GNUNET_PSYCSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
  85
  86
  87 /**
  88  * Disconnect from the PSYCstore service.
  89  *
  90  * @param h Handle for the connection.
  91  */
  92 void
  93 GNUNET_PSYCSTORE_disconnect (struct GNUNET_PSYCSTORE_Handle *h);
  94
  95
  96 /**
  97  * Handle for an operation on the PSYCSTORE (useful to cancel the operation).
  98  */
  99 struct GNUNET_PSYCSTORE_OperationHandle;
 100
 101
 102 /**
 103  * Function called with the result of an asynchronous operation.
 104  *
 105  * @param result #GNUNET_SYSERR on error,
 106  *        #GNUNET_YES on success or if the peer was a member,
 107  *        #GNUNET_NO if the peer was not a member
 108  */
 109 typedef void
 110 (*GNUNET_PSYCSTORE_ResultCallback) (void *cls,
 111                                     int64_t result,
 112                                     const char *err_msg);
 113
 114
 115 /**
 116  * Store join/leave events for a PSYC channel in order to be able to answer
 117  * membership test queries later.
 118  *
 119  * @param h Handle for the PSYCstore.
 120  * @param channel_key The channel where the event happened.
 121  * @param slave_key Public key of joining/leaving slave.
 122  * @param did_join #GNUNET_YES on join, #GNUNET_NO on part.
 123  * @param announced_at ID of the message that announced the membership change.
 124  * @param effective_since Message ID this membership change is in effect since.
 125  *        For joins it is <= announced_at, for parts it is always 0.
 126  * @param group_generation In case of a part, the last group generation the
 127  *        slave has access to.  It has relevance when a larger message have
 128  *        fragments with different group generations.
 129  * @param rcb Callback to call with the result of the storage operation.
 130  * @param rcb_cls Closure for the callback.
 131  *
 132  * @return Operation handle that can be used to cancel the operation.
 133  */
 134 struct GNUNET_PSYCSTORE_OperationHandle *
 135 GNUNET_PSYCSTORE_membership_store (struct GNUNET_PSYCSTORE_Handle *h,
 136                                    const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 137                                    const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
 138                                    int did_join,
 139                                    uint64_t announced_at,
 140                                    uint64_t effective_since,
 141                                    uint64_t group_generation,
 142                                    GNUNET_PSYCSTORE_ResultCallback rcb,
 143                                    void *rcb_cls);
 144
 145
 146 /**
 147  * Test if a member was admitted to the channel at the given message ID.
 148  *
 149  * This is useful when relaying and replaying messages to check if a particular
 150  * slave has access to the message fragment with a given group generation.  It
 151  * is also used when handling join requests to determine whether the slave is
 152  * currently admitted to the channel.
 153  *
 154  * @param h Handle for the PSYCstore.
 155  * @param channel_key The channel we are interested in.
 156  * @param slave_key Public key of slave whose membership to check.
 157  * @param message_id Message ID for which to do the membership test.
 158  * @param group_generation Group generation of the fragment of the message to
 159  *        test.  It has relevance if the message consists of multiple fragments
 160  *        with different group generations.
 161  * @param rcb Callback to call with the test result.
 162  * @param rcb_cls Closure for the callback.
 163  *
 164  * @return Operation handle that can be used to cancel the operation.
 165  */
 166 struct GNUNET_PSYCSTORE_OperationHandle *
 167 GNUNET_PSYCSTORE_membership_test (struct GNUNET_PSYCSTORE_Handle *h,
 168                                   const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 169                                   const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
 170                                   uint64_t message_id,
 171                                   uint64_t group_generation,
 172                                   GNUNET_PSYCSTORE_ResultCallback rcb,
 173                                   void *rcb_cls);
 174
 175
 176 /**
 177  * Store a message fragment sent to a channel.
 178  *
 179  * @param h Handle for the PSYCstore.
 180  * @param channel_key The channel the message belongs to.
 181  * @param message Message to store.
 182  * @param psycstore_flags Flags indicating whether the PSYC message contains
 183  *        state modifiers.
 184  * @param rcb Callback to call with the result of the operation.
 185  * @param rcb_cls Closure for the callback.
 186  *
 187  * @return Handle that can be used to cancel the operation.
 188  */
 189 struct GNUNET_PSYCSTORE_OperationHandle *
 190 GNUNET_PSYCSTORE_fragment_store (struct GNUNET_PSYCSTORE_Handle *h,
 191                                  const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 192                                  const struct GNUNET_MULTICAST_MessageHeader *message,
 193                                  uint32_t psycstore_flags,
 194                                  GNUNET_PSYCSTORE_ResultCallback rcb,
 195                                  void *rcb_cls);
 196
 197
 198 /**
 199  * Function called with one message fragment, as the result of a
 200  * GNUNET_PSYCSTORE_fragment_get() or GNUNET_PSYCSTORE_message_get() call.
 201  *
 202  * @param cls Closure.
 203  * @param message The retrieved message fragment.  A NULL value indicates that
 204  *        there are no more results to be returned.
 205  * @param psycstore_flags Flags stored with the message.
 206  *
 207  * @return #GNUNET_NO to stop calling this callback with further fragments,
 208  *         #GNUNET_YES to continue.
 209  */
 210 typedef int
 211 (*GNUNET_PSYCSTORE_FragmentCallback) (void *cls,
 212                                       struct GNUNET_MULTICAST_MessageHeader *message,
 213                                       enum GNUNET_PSYCSTORE_MessageFlags psycstore_flags);
 214
 215
 216 /**
 217  * Retrieve a message fragment by fragment ID.
 218  *
 219  * @param h Handle for the PSYCstore.
 220  * @param channel_key The channel we are interested in.
 221  * @param fragment_id Fragment ID to check.  Use 0 to get the latest message fragment.
 222  * @param fcb Callback to call with the retrieved fragment.
 223  * @param rcb Callback to call with the result of the operation.
 224  * @param cls Closure for the callbacks.
 225  *
 226  * @return Handle that can be used to cancel the operation.
 227  */
 228 struct GNUNET_PSYCSTORE_OperationHandle *
 229 GNUNET_PSYCSTORE_fragment_get (struct GNUNET_PSYCSTORE_Handle *h,
 230                                const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 231                                uint64_t fragment_id,
 232                                GNUNET_PSYCSTORE_FragmentCallback fcb,
 233                                GNUNET_PSYCSTORE_ResultCallback rcb,
 234                                void *cls);
 235
 236
 237 /**
 238  * Retrieve all fragments of a message.
 239  *
 240  * @param h Handle for the PSYCstore.
 241  * @param channel_key The channel we are interested in.
 242  * @param message_id Message ID to check.  Use 0 to get the latest message.
 243  * @param fcb Callback to call with the retrieved fragments.
 244  * @param rcb Callback to call with the result of the operation.
 245  * @param cls Closure for the callbacks.
 246  *
 247  * @return Handle that can be used to cancel the operation.
 248  */
 249 struct GNUNET_PSYCSTORE_OperationHandle *
 250 GNUNET_PSYCSTORE_message_get (struct GNUNET_PSYCSTORE_Handle *h,
 251                               const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 252                               uint64_t message_id,
 253                               GNUNET_PSYCSTORE_FragmentCallback fcb,
 254                               GNUNET_PSYCSTORE_ResultCallback rcb,
 255                               void *cls);
 256
 257
 258 /**
 259  * Retrieve a fragment of message specified by its message ID and fragment
 260  * offset.
 261  *
 262  * @param h Handle for the PSYCstore.
 263  * @param channel_key The channel we are interested in.
 264  * @param message_id Message ID to check.  Use 0 to get the latest message.
 265  * @param fragment_offset Offset of the fragment to retrieve.
 266  * @param fcb Callback to call with the retrieved fragments.
 267  * @param rcb Callback to call with the result of the operation.
 268  * @param cls Closure for the callbacks.
 269  *
 270  * @return Handle that can be used to cancel the operation.
 271  */
 272 struct GNUNET_PSYCSTORE_OperationHandle *
 273 GNUNET_PSYCSTORE_message_get_fragment (struct GNUNET_PSYCSTORE_Handle *h,
 274                                        const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 275                                        uint64_t message_id,
 276                                        uint64_t fragment_offset,
 277                                        GNUNET_PSYCSTORE_FragmentCallback fcb,
 278                                        GNUNET_PSYCSTORE_ResultCallback rcb,
 279                                        void *cls);
 280
 281
 282 /**
 283  * Callback used to return the latest value of counters for the channel master.
 284  *
 285  * @see GNUNET_PSYCSTORE_counters_get()
 286  *
 287  * @param cls Closure.
 288  * @param result_code Status code for the operation:
 289  *        #GNUNET_OK: success, counter values are returned.
 290  *        #GNUNET_NO: no message has been sent to the channel yet.
 291  *        #GNUNET_SYSERR: an error occurred.
 292  * @param max_fragment_id Latest message fragment ID, used by multicast.
 293  * @param max_message_id Latest message ID, used by PSYC.
 294  * @param max_group_generation Latest group generation, used by PSYC.
 295  * @param max_state_message_id Latest message ID containing state modifiers that
 296  *        was applied to the state store.  Used for the state sync process.
 297  */
 298 typedef void
 299 (*GNUNET_PSYCSTORE_CountersCallback) (void *cls,
 300                                       int result_code,
 301                                       uint64_t max_fragment_id,
 302                                       uint64_t max_message_id,
 303                                       uint64_t max_group_generation,
 304                                       uint64_t max_state_message_id);
 305
 306
 307 /**
 308  * Retrieve latest values of counters for a channel.
 309  *
 310  * The current value of counters are needed
 311  * - when a channel master is restarted, so that it can continue incrementing
 312  *   the counters from their last value.
 313  * - when a channel slave rejoins and starts the state synchronization process.
 314  *
 315  * @param h Handle for the PSYCstore.
 316  * @param channel_key Public key that identifies the channel.
 317  * @param ccb Callback to call with the result.
 318  * @param ccb_cls Closure for the @a ccb callback.
 319  *
 320  * @return Handle that can be used to cancel the operation.
 321  */
 322 struct GNUNET_PSYCSTORE_OperationHandle *
 323 GNUNET_PSYCSTORE_counters_get (struct GNUNET_PSYCSTORE_Handle *h,
 324                                struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 325                                GNUNET_PSYCSTORE_CountersCallback ccb,
 326                                void *ccb_cls);
 327
 328
 329 /**
 330  * Apply modifiers of a message to the current channel state.
 331  *
 332  * An error is returned if there are missing messages containing state
 333  * operations before the current one.
 334  *
 335  * @param h Handle for the PSYCstore.
 336  * @param channel_key The channel we are interested in.
 337  * @param message_id ID of the message that contains the @a modifiers.
 338  * @param state_delta Value of the @e state_delta PSYC header variable of the message.
 339  * @param modifier_count Number of elements in the @a modifiers array.
 340  * @param modifiers List of modifiers to apply.
 341  * @param rcb Callback to call with the result of the operation.
 342  * @param rcb_cls Closure for the @a rcb callback.
 343  *
 344  * @return Handle that can be used to cancel the operation.
 345  */
 346 struct GNUNET_PSYCSTORE_OperationHandle *
 347 GNUNET_PSYCSTORE_state_modify (struct GNUNET_PSYCSTORE_Handle *h,
 348                                const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 349                                uint64_t message_id,
 350                                uint64_t state_delta,
 351                                size_t modifier_count,
 352                                const struct GNUNET_ENV_Modifier *modifiers,
 353                                GNUNET_PSYCSTORE_ResultCallback rcb,
 354                                void *rcb_cls);
 355
 356
 357 /**
 358  * Store synchronized state.
 359  *
 360  * @param h Handle for the PSYCstore.
 361  * @param channel_key The channel we are interested in.
 362  * @param message_id ID of the message that contains the state_hash PSYC header variable.
 363  * @param modifier_count Number of elements in the @a modifiers array.
 364  * @param modifiers Full state to store.
 365  * @param rcb Callback to call with the result of the operation.
 366  * @param rcb_cls Closure for the callback.
 367  *
 368  * @return Handle that can be used to cancel the operation.
 369  */
 370 struct GNUNET_PSYCSTORE_OperationHandle *
 371 GNUNET_PSYCSTORE_state_sync (struct GNUNET_PSYCSTORE_Handle *h,
 372                              const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 373                              uint64_t message_id,
 374                              size_t modifier_count,
 375                              const struct GNUNET_ENV_Modifier *modifiers,
 376                              GNUNET_PSYCSTORE_ResultCallback rcb,
 377                              void *rcb_cls);
 378
 379
 380
 381 /**
 382  * Reset the state of a channel.
 383  *
 384  * Delete all state variables stored for the given channel.
 385  *
 386  * @param h Handle for the PSYCstore.
 387  * @param channel_key The channel we are interested in.
 388  * @param rcb Callback to call with the result of the operation.
 389  * @param rcb_cls Closure for the callback.
 390  *
 391  * @return Handle that can be used to cancel the operation.
 392  */
 393 struct GNUNET_PSYCSTORE_OperationHandle *
 394 GNUNET_PSYCSTORE_state_reset (struct GNUNET_PSYCSTORE_Handle *h,
 395                               const struct GNUNET_CRYPTO_EddsaPublicKey
 396                               *channel_key,
 397                               GNUNET_PSYCSTORE_ResultCallback rcb,
 398                               void *rcb_cls);
 399
 400
 401 /**
 402  * Update signed values of state variables in the state store.
 403  *
 404  * @param h Handle for the PSYCstore.
 405  * @param channel_key The channel we are interested in.
 406  * @param message_id Message ID that contained the state @a hash.
 407  * @param hash Hash of the serialized full state.
 408  * @param rcb Callback to call with the result of the operation.
 409  * @param rcb_cls Closure for the callback.
 410  *
 411  */
 412 struct GNUNET_PSYCSTORE_OperationHandle *
 413 GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h,
 414                                     const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 415                                     uint64_t message_id,
 416                                     const struct GNUNET_HashCode *hash,
 417                                     GNUNET_PSYCSTORE_ResultCallback rcb,
 418                                     void *rcb_cls);
 419
 420
 421 /**
 422  * Function called with the value of a state variable.
 423  *
 424  * @param cls Closure.
 425  * @param name Name of the state variable.  A NULL value indicates that there are no more
 426  *        state variables to be returned.
 427  * @param value Value of the state variable.
 428  * @param value_size Number of bytes in @a value.
 429  *
 430  * @return #GNUNET_NO to stop calling this callback with further variables,
 431  *         #GNUNET_YES to continue.
 432  */;
 433 typedef int
 434 (*GNUNET_PSYCSTORE_StateCallback) (void *cls, const char *name,
 435                                    const void *value, size_t value_size);
 436
 437
 438 /**
 439  * Retrieve the best matching state variable.
 440  *
 441  * @param h Handle for the PSYCstore.
 442  * @param channel_key The channel we are interested in.
 443  * @param name Name of variable to match, the returned variable might be less specific.
 444  * @param scb Callback to return the matching state variable.
 445  * @param rcb Callback to call with the result of the operation.
 446  * @param cls Closure for the callbacks.
 447  *
 448  * @return Handle that can be used to cancel the operation.
 449  */
 450 struct GNUNET_PSYCSTORE_OperationHandle *
 451 GNUNET_PSYCSTORE_state_get (struct GNUNET_PSYCSTORE_Handle *h,
 452                             const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 453                             const char *name,
 454                             GNUNET_PSYCSTORE_StateCallback scb,
 455                             GNUNET_PSYCSTORE_ResultCallback rcb,
 456                             void *cls);
 457
 458
 459 /**
 460  * Retrieve all state variables for a channel with the given prefix.
 461  *
 462  * @param h Handle for the PSYCstore.
 463  * @param channel_key The channel we are interested in.
 464  * @param name_prefix Prefix of state variable names to match.
 465  * @param scb Callback to return matching state variables.
 466  * @param rcb Callback to call with the result of the operation.
 467  * @param cls Closure for the callbacks.
 468  *
 469  * @return Handle that can be used to cancel the operation.
 470  */
 471 struct GNUNET_PSYCSTORE_OperationHandle *
 472 GNUNET_PSYCSTORE_state_get_prefix (struct GNUNET_PSYCSTORE_Handle *h,
 473                                    const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
 474                                    const char *name_prefix,
 475                                    GNUNET_PSYCSTORE_StateCallback scb,
 476                                    GNUNET_PSYCSTORE_ResultCallback rcb,
 477                                    void *cls);
 478
 479
 480 /**
 481  * Cancel an operation.
 482  *
 483  * @param op Handle for the operation to cancel.
 484  */
 485 void
 486 GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *op);
 487
 488
 489
 490
 491 #if 0                           /* keep Emacsens' auto-indent happy */
 492 {
 493 #endif
 494 #ifdef __cplusplus
 495 }
 496 #endif
 497
 498 /* ifndef GNUNET_PSYCSTORE_SERVICE_H */
 499 #endif
 500 /* end of gnunet_psycstore_service.h */