From b8ca2af15579933b2acca79908a19e08535abe26 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Thu, 23 Feb 2012 13:33:26 +0000 Subject: [PATCH] -revised plugin API --- src/include/gnunet_namestore_plugin.h | 196 ++++++-------------------- 1 file changed, 46 insertions(+), 150 deletions(-) diff --git a/src/include/gnunet_namestore_plugin.h b/src/include/gnunet_namestore_plugin.h index 8ff2adf4a..5eb01684b 100644 --- a/src/include/gnunet_namestore_plugin.h +++ b/src/include/gnunet_namestore_plugin.h @@ -22,9 +22,6 @@ * @file include/gnunet_namestore_plugin.h * @brief plugin API for the namestore database backend * @author Christian Grothoff - * - * Other functions we might want: - * - enumerate all known zones */ #ifndef GNUNET_NAMESTORE_PLUGIN_H #define GNUNET_NAMESTORE_PLUGIN_H @@ -46,62 +43,22 @@ extern "C" * Function called by for each matching record. * * @param cls closure - * @param zone hash of the public key of the zone - * @param loc location of the signature for this record + * @param zone_key public key of the zone + * @param expire when does the corresponding block in the DHT expire (until + * when should we never do a DHT lookup for the same name again)? * @param name name that is being mapped (at most 255 characters long) - * @param record_type type of the record (A, AAAA, PKEY, etc.) - * @param expiration expiration time for the content - * @param flags flags for the content - * @param data_size number of bytes in data - * @param data value, semantics depend on 'record_type' (see RFCs for DNS and - * GNS specification for GNS extensions) + * @param rd_count number of entries in 'rd' array + * @param rd array of records with data to store + * @param signature signature of the record block, NULL if signature is unavailable (i.e. + * because the user queried for a particular record type only) */ typedef void (*GNUNET_NAMESTORE_RecordIterator) (void *cls, - const GNUNET_HashCode *zone, - const struct GNUNET_NAMESTORE_SignatureLocation *loc, + const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key, + struct GNUNET_TIME_Absolute expire, const char *name, - uint32_t record_type, - struct GNUNET_TIME_Absolute expiration, - enum GNUNET_NAMESTORE_RecordFlags flags, - size_t data_size, - const void *data); - - -/** - * Function called with the matching node. - * - * @param cls closure - * @param zone hash of public key of the zone - * @param loc location in the B-tree - * @param ploc parent's location in the B-tree (must have depth = loc.depth - 1), NULL for root - * @param num_entries number of entries at this node in the B-tree - * @param entries the 'num_entries' entries to store (hashes over the - * records) - */ -typedef void (*GNUNET_NAMESTORE_NodeCallback) (void *cls, - const GNUNET_HashCode *zone, - const struct GNUNET_NAMESTORE_SignatureLocation *loc, - const struct GNUNET_NAMESTORE_SignatureLocation *ploc, - unsigned int num_entries, - const GNUNET_HashCode *entries); - - -/** - * Function called with the matching signature. - * - * @param cls closure - * @param zone public key of the zone - * @param loc location of the root in the B-tree (depth, revision) - * @param top_sig signature signing the zone - * @param zone_time time the signature was created - * @param root_hash top level hash that is being signed - */ -typedef void (*GNUNET_NAMESTORE_SignatureCallback) (void *cls, - const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key, - const struct GNUNET_NAMESTORE_SignatureLocation *loc, - const struct GNUNET_CRYPTO_RsaSignature *top_sig, - struct GNUNET_TIME_Absolute zone_time, - const GNUNET_HashCode *root_hash); + unsigned int rd_count, + const struct GNUNET_NAMESTORE_RecordData *rd, + const struct GNUNET_CRYPTO_RsaSignature *signature); /** @@ -116,124 +73,63 @@ struct GNUNET_NAMESTORE_PluginFunctions void *cls; /** - * Store a record in the datastore. + * Store a record in the datastore. Removes any existing record in the + * same zone with the same name. * * @param cls closure (internal context for the plugin) - * @param zone hash of the public key of the zone + * @param zone_key public key of the zone + * @param expire when does the corresponding block in the DHT expire (until + * when should we never do a DHT lookup for the same name again)? * @param name name that is being mapped (at most 255 characters long) - * @param record_type type of the record (A, AAAA, PKEY, etc.) - * @param loc location of the signature for the record - * @param expiration expiration time for the content - * @param flags flags for the content - * @param data_size number of bytes in data - * @param data value, semantics depend on 'record_type' (see RFCs for DNS and - * GNS specification for GNS extensions) + * @param rd_count number of entries in 'rd' array + * @param rd array of records with data to store + * @param signature signature of the record block, NULL if signature is unavailable (i.e. + * because the user queried for a particular record type only) * @return GNUNET_OK on success */ - int (*put_record) (void *cls, - const GNUNET_HashCode *zone, - const char *name, - uint32_t record_type, - const struct GNUNET_NAMESTORE_SignatureLocation *loc, - struct GNUNET_TIME_Absolute expiration, - enum GNUNET_NAMESTORE_RecordFlags flags, - size_t data_size, - const void *data); + int (*put_records) (void *cls, + const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key, + struct GNUNET_TIME_Absolute expire, + const char *name, + unsigned int rd_count, + const struct GNUNET_NAMESTORE_RecordData *rd, + const struct GNUNET_CRYPTO_RsaSignature *signature); /** - * Store a Merkle tree node in the datastore. + * Removes any existing record in the given zone with the same name. * * @param cls closure (internal context for the plugin) - * @param zone hash of public key of the zone - * @param loc location in the B-tree - * @param ploc parent's location in the B-tree (must have depth = loc.depth + 1) and the - * revision must also match loc's revision; NULL for root - * @param num_entries number of entries at this node in the B-tree - * @param entries the 'num_entries' entries to store (hashes over the - * records) + * @param zone hash of the public key of the zone + * @param name name that is being mapped (at most 255 characters long) * @return GNUNET_OK on success */ - int (*put_node) (void *cls, - const GNUNET_HashCode *zone, - const struct GNUNET_NAMESTORE_SignatureLocation *loc, - const struct GNUNET_NAMESTORE_SignatureLocation *ploc, - unsigned int num_entries, - const GNUNET_HashCode *entries); - + int (*remove_records) (void *cls, + const GNUNET_HashCode *zone, + const char *name); + - /** - * Store a zone signature in the datastore. If a signature for the zone with a - * lower depth exists, the old signature is removed. If a signature for an - * older revision of the zone exists, this will delete all records, nodes - * and signatures for the older revision of the zone. - * - * @param cls closure (internal context for the plugin) - * @param zone_key public key of the zone - * @param loc location in the B-tree (top of the tree, offset 0, depth at 'maximum') - * @param top_sig signature at the top - * @param root_hash top level hash that is signed - * @param zone_time time the zone was signed - * @return GNUNET_OK on success - */ - int (*put_signature) (void *cls, - const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key, - const struct GNUNET_NAMESTORE_SignatureLocation *loc, - const struct GNUNET_CRYPTO_RsaSignature *top_sig, - const GNUNET_HashCode *root_hash, - struct GNUNET_TIME_Absolute zone_time); - - /** * Iterate over the results for a particular key and zone in the - * datastore. Will only query the latest revision known for the - * zone (as adding a new zone revision will cause the plugin to - * delete all records from previous revisions). + * datastore. Will return at most one result to the iterator. * * @param cls closure (internal context for the plugin) - * @param zone hash of public key of the zone + * @param zone hash of public key of the zone, NULL to iterate over all zones * @param name_hash hash of name, NULL to iterate over all records of the zone - * @param iter maybe NULL (to just count) + * @param offset offset in the list of all matching records + * @param iter function to call with the result * @param iter_cls closure for iter - * @return the number of results found - */ - unsigned int (*iterate_records) (void *cls, - const GNUNET_HashCode *zone, - const GNUNET_HashCode *name_hash, - GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls); - - - /** - * Get a particular node from the signature tree. - * - * @param cls closure (internal context for the plugin) - * @param zone hash of public key of the zone - * @param loc location of the node in the signature tree - * @param cb function to call with the result - * @param cb_cls closure for cont + * @return GNUNET_OK on success, GNUNET_NO if there were no results, GNUNET_SYSERR on error */ - int (*get_node) (void *cls, - const GNUNET_HashCode *zone, - const struct GNUNET_NAMESTORE_SignatureLocation *loc, - GNUNET_NAMESTORE_NodeCallback cb, void *cb_cls); - - - /** - * Get the current signature for a zone. - * - * @param cls closure (internal context for the plugin) - * @param zone hash of public key of the zone - * @param cb function to call with the result - * @param cb_cls closure for cont - */ - int (*get_signature) (void *cls, - const GNUNET_HashCode *zone, - GNUNET_NAMESTORE_SignatureCallback cb, void *cb_cls); + int (*iterate_records) (void *cls, + const GNUNET_HashCode *zone, + const GNUNET_HashCode *name_hash, + uint64_t offset, + GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls); /** - * Delete an entire zone (all revisions, all records, all nodes, - * all signatures). Not used in normal operation. + * Delete an entire zone (all records). Not used in normal operation. * * @param cls closure (internal context for the plugin) * @param zone zone to delete -- 2.25.1