|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701 |
- /*
- This file is part of GNUnet.
- Copyright (C) 2013 GNUnet e.V.
-
- GNUnet is free software: you can redistribute it and/or modify it
- under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License,
- or (at your option) any later version.
-
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
-
- SPDX-License-Identifier: AGPL3.0-or-later
- */
-
- /**
- * @author Gabor X Toth
- * @author Christian Grothoff
- *
- * @file
- * PSYCstore service; implements persistent storage for the PSYC service
- *
- * @defgroup psycstore PSYC Store service
- * Persistent storage for the PSYC service.
- * @{
- */
- #ifndef GNUNET_PSYCSTORE_SERVICE_H
- #define GNUNET_PSYCSTORE_SERVICE_H
-
- #ifdef __cplusplus
- extern "C"
- {
- #if 0 /* keep Emacsens' auto-indent happy */
- }
- #endif
- #endif
-
- #include <gnunet/gnunet_util_lib.h>
- #include "gnunet_psyc_util_lib.h"
- #include "gnunet_multicast_service.h"
- #include "gnunet_psyc_service.h"
-
- /**
- * Version number of GNUnet PSYCstore API.
- */
- #define GNUNET_PSYCSTORE_VERSION 0x00000000
-
- /**
- * Membership test failed.
- */
- #define GNUNET_PSYCSTORE_MEMBERSHIP_TEST_FAILED -2
-
- /**
- * Flags for stored messages.
- */
- enum GNUNET_PSYCSTORE_MessageFlags
- {
- /**
- * The message contains state modifiers.
- */
- GNUNET_PSYCSTORE_MESSAGE_STATE = 1 << 0,
-
- /**
- * The state modifiers have been applied to the state store.
- */
- GNUNET_PSYCSTORE_MESSAGE_STATE_APPLIED = 1 << 1,
-
- /**
- * The message contains a state hash.
- */
- GNUNET_PSYCSTORE_MESSAGE_STATE_HASH = 1 << 2
- };
-
-
- /**
- * Handle for a PSYCstore
- */
- struct GNUNET_PSYCSTORE_Handle;
-
-
- /**
- * Connect to the PSYCstore service.
- *
- * @param cfg Configuration to use.
- *
- * @return Handle for the connecton.
- */
- struct GNUNET_PSYCSTORE_Handle *
- GNUNET_PSYCSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
-
-
- /**
- * Disconnect from the PSYCstore service.
- *
- * @param h Handle for the connection.
- */
- void
- GNUNET_PSYCSTORE_disconnect (struct GNUNET_PSYCSTORE_Handle *h);
-
-
- /**
- * Handle for an operation on the PSYCSTORE (useful to cancel the operation).
- */
- struct GNUNET_PSYCSTORE_OperationHandle;
-
-
- /**
- * Function called with the result of an asynchronous operation.
- *
- * @param cls
- * Closure.
- * @param result
- * Result of the operation.
- * @param err_msg
- * Error message, or NULL if there's no error.
- * @param err_msg_size
- * Size of @a err_msg
- */
- typedef void
- (*GNUNET_PSYCSTORE_ResultCallback) (void *cls,
- int64_t result,
- const char *err_msg,
- uint16_t err_msg_size);
-
-
- /**
- * Store join/leave events for a PSYC channel in order to be able to answer
- * membership test queries later.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel where the event happened.
- * @param slave_key
- * Public key of joining/leaving slave.
- * @param did_join
- * #GNUNET_YES on join, #GNUNET_NO on part.
- * @param announced_at
- * ID of the message that announced the membership change.
- * @param effective_since
- * Message ID this membership change is in effect since.
- * For joins it is <= announced_at, for parts it is always 0.
- * @param group_generation
- * In case of a part, the last group generation the slave has access to.
- * It has relevance when a larger message have fragments with different
- * group generations.
- * @param result_cb
- * Callback to call with the result of the storage operation.
- * @param cls
- * Closure for the callback.
- *
- * @return Operation handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_membership_store (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
- int did_join,
- uint64_t announced_at,
- uint64_t effective_since,
- uint64_t group_generation,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Test if a member was admitted to the channel at the given message ID.
- *
- * This is useful when relaying and replaying messages to check if a particular
- * slave has access to the message fragment with a given group generation. It
- * is also used when handling join requests to determine whether the slave is
- * currently admitted to the channel.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param slave_key
- * Public key of slave whose membership to check.
- * @param message_id
- * Message ID for which to do the membership test.
- * @param group_generation
- * Group generation of the fragment of the message to test.
- * It has relevance if the message consists of multiple fragments with
- * different group generations.
- * @param result_cb
- * Callback to call with the test result.
- * @param cls
- * Closure for the callback.
- *
- * @return Operation handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_membership_test (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
- uint64_t message_id,
- uint64_t group_generation,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Store a message fragment sent to a channel.
- *
- * @param h Handle for the PSYCstore.
- * @param channel_key The channel the message belongs to.
- * @param msg Message to store.
- * @param psycstore_flags Flags indicating whether the PSYC message contains
- * state modifiers.
- * @param result_cb Callback to call with the result of the operation.
- * @param cls Closure for the callback.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_fragment_store (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const struct GNUNET_MULTICAST_MessageHeader *msg,
- enum GNUNET_PSYCSTORE_MessageFlags psycstore_flags,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Function called with one message fragment, as the result of a
- * GNUNET_PSYCSTORE_fragment_get() or GNUNET_PSYCSTORE_message_get() call.
- *
- * @param cls Closure.
- * @param message The retrieved message fragment. A NULL value indicates that
- * there are no more results to be returned.
- * @param psycstore_flags Flags stored with the message.
- *
- * @return #GNUNET_NO to stop calling this callback with further fragments,
- * #GNUNET_YES to continue.
- */
- typedef int
- (*GNUNET_PSYCSTORE_FragmentCallback) (void *cls,
- struct GNUNET_MULTICAST_MessageHeader *message,
- enum GNUNET_PSYCSTORE_MessageFlags psycstore_flags);
-
-
- /**
- * Retrieve message fragments by fragment ID range.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param slave_key
- * The slave requesting the fragment. If not NULL, a membership test is
- * performed first and the fragment is only returned if the slave has
- * access to it.
- * @param first_fragment_id
- * First fragment ID to retrieve.
- * Use 0 to get the latest message fragment.
- * @param last_fragment_id
- * Last consecutive fragment ID to retrieve.
- * Use 0 to get the latest message fragment.
- * @param fragment_cb
- * Callback to call with the retrieved fragments.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callbacks.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_fragment_get (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
- uint64_t first_message_id,
- uint64_t last_message_id,
- GNUNET_PSYCSTORE_FragmentCallback fragment_cb,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Retrieve latest message fragments.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param slave_key
- * The slave requesting the fragment. If not NULL, a membership test is
- * performed first and the fragment is only returned if the slave has
- * access to it.
- * @param first_fragment_id
- * First fragment ID to retrieve.
- * Use 0 to get the latest message fragment.
- * @param last_fragment_id
- * Last consecutive fragment ID to retrieve.
- * Use 0 to get the latest message fragment.
- * @param fragment_limit
- * Maximum number of fragments to retrieve.
- * @param fragment_cb
- * Callback to call with the retrieved fragments.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callbacks.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_fragment_get_latest (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
- uint64_t fragment_limit,
- GNUNET_PSYCSTORE_FragmentCallback fragment_cb,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Retrieve all fragments of messages in a message ID range.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param slave_key
- * The slave requesting the message.
- * If not NULL, a membership test is performed first
- * and the message is only returned if the slave has access to it.
- * @param first_message_id
- * First message ID to retrieve.
- * @param last_message_id
- * Last consecutive message ID to retrieve.
- * @param fragment_limit
- * Maximum number of fragments to retrieve.
- * @param method_prefix
- * Retrieve only messages with a matching method prefix.
- * @param fragment_cb
- * Callback to call with the retrieved fragments.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callbacks.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_message_get (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
- uint64_t first_message_id,
- uint64_t last_message_id,
- uint64_t fragment_limit,
- const char *method_prefix,
- GNUNET_PSYCSTORE_FragmentCallback fragment_cb,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Retrieve all fragments of the latest messages.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param slave_key
- * The slave requesting the message.
- * If not NULL, a membership test is performed first
- * and the message is only returned if the slave has access to it.
- * @param message_limit
- * Maximum number of messages to retrieve.
- * @param method_prefix
- * Retrieve only messages with a matching method prefix.
- * @param fragment_cb
- * Callback to call with the retrieved fragments.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callbacks.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_message_get_latest (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
- uint64_t message_limit,
- const char *method_prefix,
- GNUNET_PSYCSTORE_FragmentCallback fragment_cb,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Retrieve a fragment of message specified by its message ID and fragment
- * offset.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param slave_key
- * The slave requesting the message fragment. If not NULL, a membership
- * test is performed first and the message fragment is only returned
- * if the slave has access to it.
- * @param message_id
- * Message ID to retrieve. Use 0 to get the latest message.
- * @param fragment_offset
- * Offset of the fragment to retrieve.
- * @param fragment_cb
- * Callback to call with the retrieved fragments.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callbacks.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_message_get_fragment (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
- uint64_t message_id,
- uint64_t fragment_offset,
- GNUNET_PSYCSTORE_FragmentCallback fragment_cb,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Callback used to return the latest value of counters for the channel master.
- *
- * @see GNUNET_PSYCSTORE_counters_get()
- *
- * @param cls Closure.
- * @param result_code
- * Status code for the operation:
- * #GNUNET_OK: success, counter values are returned.
- * #GNUNET_NO: no message has been sent to the channel yet.
- * #GNUNET_SYSERR: an error occurred.
- * @param max_fragment_id
- * Latest message fragment ID, used by multicast.
- * @param max_message_id
- * Latest message ID, used by PSYC.
- * @param max_group_generation
- * Latest group generation, used by PSYC.
- * @param max_state_message_id
- * Latest message ID containing state modifiers that
- * was applied to the state store. Used for the state sync process.
- */
- typedef void
- (*GNUNET_PSYCSTORE_CountersCallback) (void *cls,
- int result_code,
- uint64_t max_fragment_id,
- uint64_t max_message_id,
- uint64_t max_group_generation,
- uint64_t max_state_message_id);
-
-
- /**
- * Retrieve latest values of counters for a channel.
- *
- * The current value of counters are needed
- * - when a channel master is restarted, so that it can continue incrementing
- * the counters from their last value.
- * - when a channel slave rejoins and starts the state synchronization process.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * Public key that identifies the channel.
- * @param counters_cb
- * Callback to call with the result.
- * @param cls
- * Closure for the @a ccb callback.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_counters_get (struct GNUNET_PSYCSTORE_Handle *h,
- struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- GNUNET_PSYCSTORE_CountersCallback counters_cb,
- void *cls);
-
-
- /**
- * Apply modifiers of a message to the current channel state.
- *
- * An error is returned if there are missing messages containing state
- * operations before the current one.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param message_id
- * ID of the message that contains the @a modifiers.
- * @param state_delta
- * Value of the @e state_delta PSYC header variable of the message.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the @a result_cb callback.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_state_modify (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- uint64_t message_id,
- uint64_t state_delta,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Store synchronized state.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param max_state_message_id
- * ID of the last stateful message before @a state_hash_message_id.
- * @param state_hash_message_id
- * ID of the message that contains the state_hash PSYC header variable.
- * @param modifier_count
- * Number of elements in the @a modifiers array.
- * @param modifiers
- * Full state to store.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callback.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_state_sync (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- uint64_t max_state_message_id,
- uint64_t state_hash_message_id,
- size_t modifier_count,
- const struct GNUNET_PSYC_Modifier *modifiers,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
-
- /**
- * Reset the state of a channel.
- *
- * Delete all state variables stored for the given channel.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callback.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_state_reset (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey
- *channel_key,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Update signed values of state variables in the state store.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param message_id
- * Message ID that contained the state @a hash.
- * @param hash
- * Hash of the serialized full state.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callback.
- *
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_state_hash_update (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- uint64_t message_id,
- const struct GNUNET_HashCode *hash,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Function called with the value of a state variable.
- *
- * @param cls
- * Closure.
- * @param name
- * Name of the state variable. A NULL value indicates that there are no more
- * state variables to be returned.
- * @param value
- * Value of the state variable.
- * @param value_size
- * Number of bytes in @a value.
- *
- * @return #GNUNET_NO to stop calling this callback with further variables,
- * #GNUNET_YES to continue.
- */;
- typedef int
- (*GNUNET_PSYCSTORE_StateCallback) (void *cls, const char *name,
- const void *value, uint32_t value_size);
-
-
- /**
- * Retrieve the best matching state variable.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param name
- * Name of variable to match, the returned variable might be less specific.
- * @param state_cb
- * Callback to return the matching state variable.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callbacks.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_state_get (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const char *name,
- GNUNET_PSYCSTORE_StateCallback state_cb,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Retrieve all state variables for a channel with the given prefix.
- *
- * @param h
- * Handle for the PSYCstore.
- * @param channel_key
- * The channel we are interested in.
- * @param name_prefix
- * Prefix of state variable names to match.
- * @param state_cb
- * Callback to return matching state variables.
- * @param result_cb
- * Callback to call with the result of the operation.
- * @param cls
- * Closure for the callbacks.
- *
- * @return Handle that can be used to cancel the operation.
- */
- struct GNUNET_PSYCSTORE_OperationHandle *
- GNUNET_PSYCSTORE_state_get_prefix (struct GNUNET_PSYCSTORE_Handle *h,
- const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
- const char *name_prefix,
- GNUNET_PSYCSTORE_StateCallback state_cb,
- GNUNET_PSYCSTORE_ResultCallback result_cb,
- void *cls);
-
-
- /**
- * Cancel an operation.
- *
- * @param op Handle for the operation to cancel.
- */
- int
- GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *op);
-
-
-
-
- #if 0 /* keep Emacsens' auto-indent happy */
- {
- #endif
- #ifdef __cplusplus
- }
- #endif
-
- /* ifndef GNUNET_PSYCSTORE_SERVICE_H */
- #endif
-
- /** @} */ /* end of group */
|