2 This file is part of GNUnet.
3 Copyright (C) 2012, 2013, 2014, 2018 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file namestore/gnunet-service-namestore.c
23 * @brief namestore for the GNUnet naming system
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet_dnsparser_lib.h"
30 #include "gnunet_gns_service.h"
31 #include "gnunet_namecache_service.h"
32 #include "gnunet_namestore_service.h"
33 #include "gnunet_namestore_plugin.h"
34 #include "gnunet_statistics_service.h"
35 #include "gnunet_signatures.h"
36 #include "namestore.h"
38 #define LOG_STRERROR_FILE(kind, syscall, filename) \
39 GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
42 * If a monitor takes more than 1 minute to process an event, print a warning.
44 #define MONITOR_STALL_WARN_DELAY GNUNET_TIME_UNIT_MINUTES
47 * Size of the cache used by #get_nick_record()
54 struct NamestoreClient;
58 * A namestore iteration operation.
63 * Next element in the DLL
65 struct ZoneIteration *next;
68 * Previous element in the DLL
70 struct ZoneIteration *prev;
73 * Namestore client which intiated this zone iteration
75 struct NamestoreClient *nc;
78 * The nick to add to the records
80 struct GNUNET_GNSRECORD_Data *nick;
83 * Key of the zone we are iterating over.
85 struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
88 * Last sequence number in the zone iteration used to address next
89 * result of the zone iteration in the store
92 * Updated in #zone_iterate_proc()
97 * The operation id fot the zone iteration in the response for the client
102 * Offset of the zone iteration used to address next result of the zone
103 * iteration in the store
105 * Initialy set to 0 in #handle_iteration_start
106 * Incremented with by every call to #handle_iteration_next
111 * Number of pending cache operations triggered by this zone iteration which we
112 * need to wait for before allowing the client to continue.
114 unsigned int cache_ops;
117 * Set to #GNUNET_YES if the last iteration exhausted the limit set by the
118 * client and we should send the #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT_END
119 * message and free the data structure once @e cache_ops is zero.
128 struct NamestoreClient
133 struct GNUNET_SERVICE_Client *client;
136 * Message queue for transmission to @e client
138 struct GNUNET_MQ_Handle *mq;
142 * Zone iteration operations in progress initiated by this client
144 struct ZoneIteration *op_head;
148 * Zone iteration operations in progress initiated by this client
150 struct ZoneIteration *op_tail;
155 * A namestore monitor.
160 * Next element in the DLL
162 struct ZoneMonitor *next;
165 * Previous element in the DLL
167 struct ZoneMonitor *prev;
170 * Namestore client which intiated this zone monitor
172 struct NamestoreClient *nc;
175 * Private key of the zone.
177 struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
180 * Task active during initial iteration.
182 struct GNUNET_SCHEDULER_Task *task;
185 * Task to warn about slow monitors.
187 struct GNUNET_SCHEDULER_Task *sa_wait_warning;
190 * Since when are we blocked on this monitor?
192 struct GNUNET_TIME_Absolute sa_waiting_start;
195 * Last sequence number in the zone iteration used to address next
196 * result of the zone iteration in the store
199 * Updated in #monitor_iterate_cb()
204 * Current limit of how many more messages we are allowed
205 * to queue to this monitor.
210 * How many more requests may we receive from the iterator
211 * before it is at the limit we gave it? Will be below or
212 * equal to @e limit. The effective limit for monitor
213 * events is thus @e iteration_cnt - @e limit!
215 uint64_t iteration_cnt;
218 * Are we (still) in the initial iteration pass?
220 int in_first_iteration;
223 * Is there a store activity waiting for this monitor? We only raise the
224 * flag when it happens and search the DLL for the store activity when we
225 * had a limit increase. If we cannot find any waiting store activity at
226 * that time, we clear the flag again.
233 * Pending operation on the namecache.
235 struct CacheOperation
240 struct CacheOperation *prev;
245 struct CacheOperation *next;
248 * Handle to namecache queue.
250 struct GNUNET_NAMECACHE_QueueEntry *qe;
253 * Client to notify about the result, can be NULL.
255 struct NamestoreClient *nc;
258 * Zone iteration to call #zone_iteration_done_client_continue()
259 * for if applicable, can be NULL.
261 struct ZoneIteration *zi;
264 * Client's request ID.
271 * Information for an ongoing #handle_record_store() operation.
272 * Needed as we may wait for monitors to be ready for the notification.
279 struct StoreActivity *next;
284 struct StoreActivity *prev;
287 * Which client triggered the store activity?
289 struct NamestoreClient *nc;
292 * Copy of the original store message (as data fields in @e rd will
295 const struct RecordStoreMessage *rsm;
298 * Next zone monitor that still needs to be notified about this PUT.
300 struct ZoneMonitor *zm_pos;
303 * Label nicely canonicalized (lower case).
310 * Entry in list of cached nick resolutions.
315 * Zone the cache entry is for.
317 struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
320 * Cached record data.
322 struct GNUNET_GNSRECORD_Data *rd;
325 * Timestamp when this cache entry was used last.
327 struct GNUNET_TIME_Absolute last_used;
332 * We cache nick records to reduce DB load.
334 static struct NickCache nick_cache[NC_SIZE];
337 * Public key of all zeros.
339 static const struct GNUNET_CRYPTO_EcdsaPrivateKey zero;
342 * Configuration handle.
344 static const struct GNUNET_CONFIGURATION_Handle *GSN_cfg;
347 * Handle to the statistics service
349 static struct GNUNET_STATISTICS_Handle *statistics;
354 static struct GNUNET_NAMECACHE_Handle *namecache;
359 static struct GNUNET_NAMESTORE_PluginFunctions *GSN_database;
362 * Name of the database plugin
364 static char *db_lib_name;
369 static struct CacheOperation *cop_head;
374 static struct CacheOperation *cop_tail;
377 * First active zone monitor.
379 static struct ZoneMonitor *monitor_head;
382 * Last active zone monitor.
384 static struct ZoneMonitor *monitor_tail;
387 * Head of DLL of monitor-blocked store activities.
389 static struct StoreActivity *sa_head;
392 * Tail of DLL of monitor-blocked store activities.
394 static struct StoreActivity *sa_tail;
397 * Notification context shared by all monitors.
399 static struct GNUNET_NotificationContext *monitor_nc;
402 * Optimize block insertion by caching map of private keys to
403 * public keys in memory?
405 static int cache_keys;
408 * Use the namecache? Doing so creates additional cryptographic
409 * operations whenever we touch a record.
411 static int disable_namecache;
415 * Task run during shutdown.
420 cleanup_task (void *cls)
422 struct CacheOperation *cop;
425 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping namestore service\n");
426 while (NULL != (cop = cop_head))
428 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
429 "Aborting incomplete namecache operation\n");
430 GNUNET_NAMECACHE_cancel (cop->qe);
431 GNUNET_CONTAINER_DLL_remove (cop_head, cop_tail, cop);
434 if (NULL != namecache)
436 GNUNET_NAMECACHE_disconnect (namecache);
439 GNUNET_break (NULL == GNUNET_PLUGIN_unload (db_lib_name, GSN_database));
440 GNUNET_free (db_lib_name);
442 if (NULL != monitor_nc)
444 GNUNET_notification_context_destroy (monitor_nc);
447 if (NULL != statistics)
449 GNUNET_STATISTICS_destroy (statistics, GNUNET_NO);
456 * Release memory used by @a sa.
458 * @param sa activity to free
461 free_store_activity (struct StoreActivity *sa)
463 GNUNET_CONTAINER_DLL_remove (sa_head, sa_tail, sa);
464 GNUNET_free (sa->conv_name);
470 * Function called with the records for the #GNUNET_GNS_EMPTY_LABEL_AT
471 * label in the zone. Used to locate the #GNUNET_GNSRECORD_TYPE_NICK
472 * record, which (if found) is then copied to @a cls for future use.
474 * @param cls a `struct GNUNET_GNSRECORD_Data **` for storing the nick (if found)
475 * @param seq sequence number of the record, MUST NOT BE ZERO
476 * @param private_key the private key of the zone (unused)
477 * @param label should be #GNUNET_GNS_EMPTY_LABEL_AT
478 * @param rd_count number of records in @a rd
479 * @param rd records stored under @a label in the zone
482 lookup_nick_it (void *cls,
484 const struct GNUNET_CRYPTO_EcdsaPrivateKey *private_key,
486 unsigned int rd_count,
487 const struct GNUNET_GNSRECORD_Data *rd)
489 struct GNUNET_GNSRECORD_Data **res = cls;
492 GNUNET_assert (0 != seq);
493 if (0 != strcmp (label, GNUNET_GNS_EMPTY_LABEL_AT))
498 for (unsigned int c = 0; c < rd_count; c++)
500 if (GNUNET_GNSRECORD_TYPE_NICK == rd[c].record_type)
503 GNUNET_malloc (rd[c].data_size + sizeof(struct GNUNET_GNSRECORD_Data));
504 (*res)->data = &(*res)[1];
505 GNUNET_memcpy ((void *) (*res)->data, rd[c].data, rd[c].data_size);
506 (*res)->data_size = rd[c].data_size;
507 (*res)->expiration_time = rd[c].expiration_time;
508 (*res)->flags = rd[c].flags;
509 (*res)->record_type = GNUNET_GNSRECORD_TYPE_NICK;
518 * Add entry to the cache for @a zone and @a nick
520 * @param zone zone key to cache under
521 * @param nick nick entry to cache
524 cache_nick (const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
525 const struct GNUNET_GNSRECORD_Data *nick)
527 struct NickCache *oldest;
530 for (unsigned int i = 0; i < NC_SIZE; i++)
532 struct NickCache *pos = &nick_cache[i];
534 if ((NULL == oldest) ||
535 (oldest->last_used.abs_value_us > pos->last_used.abs_value_us))
537 if (0 == GNUNET_memcmp (zone, &pos->zone))
543 GNUNET_free_non_null (oldest->rd);
544 oldest->zone = *zone;
547 oldest->rd = GNUNET_malloc (sizeof(*nick) + nick->data_size);
549 oldest->rd->data = &oldest->rd[1];
550 memcpy (&oldest->rd[1], nick->data, nick->data_size);
556 oldest->last_used = GNUNET_TIME_absolute_get ();
561 * Return the NICK record for the zone (if it exists).
563 * @param zone private key for the zone to look for nick
564 * @return NULL if no NICK record was found
566 static struct GNUNET_GNSRECORD_Data *
567 get_nick_record (const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone)
569 struct GNUNET_CRYPTO_EcdsaPublicKey pub;
570 struct GNUNET_GNSRECORD_Data *nick;
573 /* check cache first */
574 for (unsigned int i = 0; i < NC_SIZE; i++)
576 struct NickCache *pos = &nick_cache[i];
577 if ((NULL != pos->rd) && (0 == GNUNET_memcmp (zone, &pos->zone)))
581 nick = GNUNET_malloc (sizeof(*nick) + pos->rd->data_size);
583 nick->data = &nick[1];
584 memcpy (&nick[1], pos->rd->data, pos->rd->data_size);
585 pos->last_used = GNUNET_TIME_absolute_get ();
591 res = GSN_database->lookup_records (GSN_database->cls,
593 GNUNET_GNS_EMPTY_LABEL_AT,
596 if ((GNUNET_OK != res) || (NULL == nick))
598 #if ! defined(GNUNET_CULL_LOGGING)
599 static int do_log = GNUNET_LOG_CALL_STATUS;
602 do_log = GNUNET_get_log_call_status (GNUNET_ERROR_TYPE_DEBUG,
609 GNUNET_CRYPTO_ecdsa_key_get_public (zone, &pub);
610 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
611 "No nick name set for zone `%s'\n",
612 GNUNET_GNSRECORD_z2s (&pub));
616 cache_nick (zone, NULL);
621 cache_nick (zone, nick);
627 * Merge the nick record @a nick_rd with the rest of the
628 * record set given in @a rd2. Store the result in @a rdc_res
629 * and @a rd_res. The @a nick_rd's expiration time is set to
630 * the maximum expiration time of all of the records in @a rd2.
632 * @param nick_rd the nick record to integrate
633 * @param rd2_length length of the @a rd2 array
634 * @param rd2 array of records
635 * @param rdc_res[out] length of the resulting @a rd_res array
636 * @param rd_res[out] set to an array of records,
637 * including @a nick_rd and @a rd2;
638 * all of the variable-size 'data' fields in @a rd2 are
639 * allocated in the same chunk of memory!
642 merge_with_nick_records (const struct GNUNET_GNSRECORD_Data *nick_rd,
643 unsigned int rd2_length,
644 const struct GNUNET_GNSRECORD_Data *rd2,
645 unsigned int *rdc_res,
646 struct GNUNET_GNSRECORD_Data **rd_res)
648 uint64_t latest_expiration;
652 struct GNUNET_GNSRECORD_Data *target;
654 (*rdc_res) = 1 + rd2_length;
655 if (0 == 1 + rd2_length)
661 req = sizeof(struct GNUNET_GNSRECORD_Data) + nick_rd->data_size;
662 for (unsigned int i = 0; i < rd2_length; i++)
664 const struct GNUNET_GNSRECORD_Data *orig = &rd2[i];
666 if (req + sizeof(struct GNUNET_GNSRECORD_Data) + orig->data_size < req)
672 req += sizeof(struct GNUNET_GNSRECORD_Data) + orig->data_size;
674 target = GNUNET_malloc (req);
676 data = (char *) &target[1 + rd2_length];
678 latest_expiration = 0;
679 for (unsigned int i = 0; i < rd2_length; i++)
681 const struct GNUNET_GNSRECORD_Data *orig = &rd2[i];
683 if (0 != (orig->flags & GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION))
685 if ((GNUNET_TIME_absolute_get ().abs_value_us + orig->expiration_time) >
687 latest_expiration = orig->expiration_time;
689 else if (orig->expiration_time > latest_expiration)
690 latest_expiration = orig->expiration_time;
692 target[i].data = (void *) &data[data_offset];
693 GNUNET_memcpy (&data[data_offset], orig->data, orig->data_size);
694 data_offset += orig->data_size;
697 target[rd2_length] = *nick_rd;
698 /* Mark as supplemental */
699 target[rd2_length].flags = nick_rd->flags | GNUNET_GNSRECORD_RF_SUPPLEMENTAL;
700 target[rd2_length].expiration_time = latest_expiration;
701 target[rd2_length].data = (void *) &data[data_offset];
702 GNUNET_memcpy (&data[data_offset], nick_rd->data, nick_rd->data_size);
703 data_offset += nick_rd->data_size;
704 GNUNET_assert (req == (sizeof(struct GNUNET_GNSRECORD_Data)) * (*rdc_res)
710 * Generate a `struct LookupNameResponseMessage` and send it to the
711 * given client using the given notification context.
713 * @param nc client to unicast to
714 * @param request_id request ID to use
715 * @param zone_key zone key of the zone
717 * @param rd_count number of records in @a rd
718 * @param rd array of records
721 send_lookup_response (struct NamestoreClient *nc,
723 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
725 unsigned int rd_count,
726 const struct GNUNET_GNSRECORD_Data *rd)
728 struct GNUNET_MQ_Envelope *env;
729 struct RecordResultMessage *zir_msg;
730 struct GNUNET_GNSRECORD_Data *nick;
731 struct GNUNET_GNSRECORD_Data *res;
732 unsigned int res_count;
738 nick = get_nick_record (zone_key);
739 GNUNET_assert (-1 != GNUNET_GNSRECORD_records_get_size (rd_count, rd));
741 if ((NULL != nick) && (0 != strcmp (name, GNUNET_GNS_EMPTY_LABEL_AT)))
744 (nick->flags | GNUNET_GNSRECORD_RF_PRIVATE) ^ GNUNET_GNSRECORD_RF_PRIVATE;
745 merge_with_nick_records (nick, rd_count, rd, &res_count, &res);
750 res_count = rd_count;
751 res = (struct GNUNET_GNSRECORD_Data *) rd;
754 GNUNET_assert (-1 != GNUNET_GNSRECORD_records_get_size (res_count, res));
757 name_len = strlen (name) + 1;
758 rd_ser_len = GNUNET_GNSRECORD_records_get_size (res_count, res);
762 GNUNET_SERVICE_client_drop (nc->client);
765 if (((size_t) rd_ser_len) >= UINT16_MAX - name_len - sizeof(*zir_msg))
768 GNUNET_SERVICE_client_drop (nc->client);
771 env = GNUNET_MQ_msg_extra (zir_msg,
772 name_len + rd_ser_len,
773 GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT);
774 zir_msg->gns_header.r_id = htonl (request_id);
775 zir_msg->name_len = htons (name_len);
776 zir_msg->rd_count = htons (res_count);
777 zir_msg->rd_len = htons ((uint16_t) rd_ser_len);
778 zir_msg->private_key = *zone_key;
779 name_tmp = (char *) &zir_msg[1];
780 GNUNET_memcpy (name_tmp, name, name_len);
781 rd_ser = &name_tmp[name_len];
784 GNUNET_GNSRECORD_records_serialize (res_count, res, rd_ser_len, rd_ser));
785 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
786 "Sending RECORD_RESULT message with %u records\n",
788 GNUNET_STATISTICS_update (statistics,
789 "Record sets sent to clients",
792 GNUNET_MQ_send (nc->mq, env);
799 * Send response to the store request to the client.
801 * @param client client to talk to
802 * @param res status of the operation
803 * @param rid client's request ID
806 send_store_response (struct NamestoreClient *nc, int res, uint32_t rid)
808 struct GNUNET_MQ_Envelope *env;
809 struct RecordStoreResponseMessage *rcr_msg;
811 GNUNET_assert (NULL != nc);
812 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
813 "Sending RECORD_STORE_RESPONSE message\n");
814 GNUNET_STATISTICS_update (statistics,
815 "Store requests completed",
818 env = GNUNET_MQ_msg (rcr_msg,
819 GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE);
820 rcr_msg->gns_header.r_id = htonl (rid);
821 rcr_msg->op_result = htonl (res);
822 GNUNET_MQ_send (nc->mq, env);
827 * Function called once we are done with the zone iteration and
828 * allow the zone iteration client to send us more messages.
830 * @param zi zone iteration we are processing
833 zone_iteration_done_client_continue (struct ZoneIteration *zi)
835 struct GNUNET_MQ_Envelope *env;
836 struct GNUNET_NAMESTORE_Header *em;
838 GNUNET_SERVICE_client_continue (zi->nc->client);
841 /* send empty response to indicate end of list */
842 env = GNUNET_MQ_msg (em, GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT_END);
843 em->r_id = htonl (zi->request_id);
844 GNUNET_MQ_send (zi->nc->mq, env);
846 GNUNET_CONTAINER_DLL_remove (zi->nc->op_head, zi->nc->op_tail, zi);
852 * Cache operation complete, clean up.
854 * @param cls the `struct CacheOperation`
855 * @param success success
856 * @param emsg error messages
859 finish_cache_operation (void *cls, int32_t success, const char *emsg)
861 struct CacheOperation *cop = cls;
862 struct ZoneIteration *zi;
865 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
866 _ ("Failed to replicate block in namecache: %s\n"),
869 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "CACHE operation completed\n");
870 GNUNET_CONTAINER_DLL_remove (cop_head, cop_tail, cop);
872 send_store_response (cop->nc, success, cop->rid);
873 if (NULL != (zi = cop->zi))
876 if (0 == zi->cache_ops)
878 /* unchoke zone iteration, cache has caught up */
879 zone_iteration_done_client_continue (zi);
887 * We just touched the plaintext information about a name in our zone;
888 * refresh the corresponding (encrypted) block in the namecache.
890 * @param nc client responsible for the request, can be NULL
891 * @param zi zone iteration response for the request, can be NULL
892 * @param rid request ID of the client
893 * @param zone_key private key of the zone
894 * @param name label for the records
895 * @param rd_count number of records
896 * @param rd records stored under the given @a name
899 refresh_block (struct NamestoreClient *nc,
900 struct ZoneIteration *zi,
902 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
904 unsigned int rd_count,
905 const struct GNUNET_GNSRECORD_Data *rd)
907 struct GNUNET_GNSRECORD_Block *block;
908 struct CacheOperation *cop;
909 struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
910 struct GNUNET_GNSRECORD_Data *nick;
911 struct GNUNET_GNSRECORD_Data *res;
912 unsigned int res_count;
913 struct GNUNET_TIME_Absolute exp_time;
915 nick = get_nick_record (zone_key);
916 res_count = rd_count;
917 res = (struct GNUNET_GNSRECORD_Data *) rd; /* fixme: a bit unclean... */
918 if (NULL != nick && (0 != strcmp (name, GNUNET_GNS_EMPTY_LABEL_AT)))
921 (nick->flags | GNUNET_GNSRECORD_RF_PRIVATE) ^ GNUNET_GNSRECORD_RF_PRIVATE;
922 merge_with_nick_records (nick, rd_count, rd, &res_count, &res);
928 send_store_response (nc, GNUNET_OK, rid);
929 return; /* no data, no need to update cache */
931 if (GNUNET_YES == disable_namecache)
933 GNUNET_STATISTICS_update (statistics,
934 "Namecache updates skipped (NC disabled)",
938 send_store_response (nc, GNUNET_OK, rid);
941 exp_time = GNUNET_GNSRECORD_record_get_expiration_time (res_count, res);
944 GNUNET_GNSRECORD_block_create2 (zone_key, exp_time, name, res, res_count);
947 GNUNET_GNSRECORD_block_create (zone_key, exp_time, name, res, res_count);
948 GNUNET_assert (NULL != block);
949 GNUNET_CRYPTO_ecdsa_key_get_public (zone_key, &pkey);
951 GNUNET_ERROR_TYPE_DEBUG,
952 "Caching block for label `%s' with %u records and expiration %s in zone `%s' in namecache\n",
955 GNUNET_STRINGS_absolute_time_to_string (exp_time),
956 GNUNET_GNSRECORD_z2s (&pkey));
957 GNUNET_STATISTICS_update (statistics,
958 "Namecache updates pushed",
961 cop = GNUNET_new (struct CacheOperation);
967 GNUNET_CONTAINER_DLL_insert (cop_head, cop_tail, cop);
968 cop->qe = GNUNET_NAMECACHE_block_cache (namecache,
970 &finish_cache_operation,
977 * Print a warning that one of our monitors is no longer reacting.
979 * @param cls a `struct ZoneMonitor` to warn about
982 warn_monitor_slow (void *cls)
984 struct ZoneMonitor *zm = cls;
986 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
987 "No response from monitor since %s\n",
988 GNUNET_STRINGS_absolute_time_to_string (zm->sa_waiting_start));
989 zm->sa_wait_warning = GNUNET_SCHEDULER_add_delayed (MONITOR_STALL_WARN_DELAY,
996 * Continue processing the @a sa.
998 * @param sa store activity to process
1001 continue_store_activity (struct StoreActivity *sa)
1003 const struct RecordStoreMessage *rp_msg = sa->rsm;
1004 unsigned int rd_count;
1008 const char *name_tmp;
1011 rid = ntohl (rp_msg->gns_header.r_id);
1012 name_len = ntohs (rp_msg->name_len);
1013 rd_count = ntohs (rp_msg->rd_count);
1014 rd_ser_len = ntohs (rp_msg->rd_len);
1015 name_tmp = (const char *) &rp_msg[1];
1016 rd_ser = &name_tmp[name_len];
1018 struct GNUNET_GNSRECORD_Data rd[GNUNET_NZL (rd_count)];
1020 /* We did this before, must succeed again */
1023 GNUNET_GNSRECORD_records_deserialize (rd_ser_len, rd_ser, rd_count, rd));
1025 for (struct ZoneMonitor *zm = sa->zm_pos; NULL != zm; zm = sa->zm_pos)
1027 if ((0 != GNUNET_memcmp (&rp_msg->private_key, &zm->zone)) &&
1028 (0 != GNUNET_memcmp (&zm->zone, &zero)))
1030 sa->zm_pos = zm->next; /* not interesting to this monitor */
1033 if (zm->limit == zm->iteration_cnt)
1035 zm->sa_waiting = GNUNET_YES;
1036 zm->sa_waiting_start = GNUNET_TIME_absolute_get ();
1037 if (NULL != zm->sa_wait_warning)
1038 GNUNET_SCHEDULER_cancel (zm->sa_wait_warning);
1039 zm->sa_wait_warning =
1040 GNUNET_SCHEDULER_add_delayed (MONITOR_STALL_WARN_DELAY,
1043 return; /* blocked on zone monitor */
1045 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1046 "Notifying monitor about changes under label `%s'\n",
1049 send_lookup_response (zm->nc,
1051 &rp_msg->private_key,
1055 sa->zm_pos = zm->next;
1057 /* great, done with the monitors, unpack (again) for refresh_block operation */
1058 refresh_block (sa->nc,
1061 &rp_msg->private_key,
1066 GNUNET_SERVICE_client_continue (sa->nc->client);
1067 free_store_activity (sa);
1072 * Called whenever a client is disconnected.
1073 * Frees our resources associated with that client.
1075 * @param cls closure
1076 * @param client identification of the client
1077 * @param app_ctx the `struct NamestoreClient` of @a client
1080 client_disconnect_cb (void *cls,
1081 struct GNUNET_SERVICE_Client *client,
1084 struct NamestoreClient *nc = app_ctx;
1085 struct ZoneIteration *no;
1086 struct CacheOperation *cop;
1089 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Client %p disconnected\n", client);
1090 for (struct ZoneMonitor *zm = monitor_head; NULL != zm; zm = zm->next)
1092 struct StoreActivity *san;
1096 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, zm);
1097 if (NULL != zm->task)
1099 GNUNET_SCHEDULER_cancel (zm->task);
1102 if (NULL != zm->sa_wait_warning)
1104 GNUNET_SCHEDULER_cancel (zm->sa_wait_warning);
1105 zm->sa_wait_warning = NULL;
1107 for (struct StoreActivity *sa = sa_head; NULL != sa; sa = san)
1110 if (zm == sa->zm_pos)
1112 sa->zm_pos = zm->next;
1113 /* this may free sa */
1114 continue_store_activity (sa);
1120 for (struct StoreActivity *sa = sa_head; NULL != sa; sa = sa->next)
1124 /* this may free sa */
1125 free_store_activity (sa);
1126 break; /* there can only be one per nc */
1129 while (NULL != (no = nc->op_head))
1131 GNUNET_CONTAINER_DLL_remove (nc->op_head, nc->op_tail, no);
1134 for (cop = cop_head; NULL != cop; cop = cop->next)
1142 * Add a client to our list of active clients.
1145 * @param client client to add
1146 * @param mq message queue for @a client
1147 * @return internal namestore client structure for this client
1150 client_connect_cb (void *cls,
1151 struct GNUNET_SERVICE_Client *client,
1152 struct GNUNET_MQ_Handle *mq)
1154 struct NamestoreClient *nc;
1157 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Client %p connected\n", client);
1158 nc = GNUNET_new (struct NamestoreClient);
1159 nc->client = client;
1166 * Closure for #lookup_it().
1168 struct RecordLookupContext
1183 struct GNUNET_GNSRECORD_Data *nick;
1193 unsigned int res_rd_count;
1203 * Function called by the namestore plugin when we are trying to lookup
1204 * a record as part of #handle_record_lookup(). Merges all results into
1207 * @param cls closure with a `struct RecordLookupContext`
1208 * @param seq unique serial number of the record, MUST NOT BE ZERO
1209 * @param zone_key private key of the zone
1210 * @param label name that is being mapped (at most 255 characters long)
1211 * @param rd_count number of entries in @a rd array
1212 * @param rd array of records with data to store
1215 lookup_it (void *cls,
1217 const struct GNUNET_CRYPTO_EcdsaPrivateKey *private_key,
1219 unsigned int rd_count,
1220 const struct GNUNET_GNSRECORD_Data *rd)
1222 struct RecordLookupContext *rlc = cls;
1225 GNUNET_assert (0 != seq);
1226 if (0 != strcmp (label, rlc->label))
1228 rlc->found = GNUNET_YES;
1231 rlc->rd_ser_len = 0;
1232 rlc->res_rd_count = 0;
1236 if ((NULL != rlc->nick) && (0 != strcmp (label, GNUNET_GNS_EMPTY_LABEL_AT)))
1239 struct GNUNET_GNSRECORD_Data *rd_res;
1240 unsigned int rdc_res;
1244 rlc->nick->flags = (rlc->nick->flags | GNUNET_GNSRECORD_RF_PRIVATE)
1245 ^ GNUNET_GNSRECORD_RF_PRIVATE;
1246 merge_with_nick_records (rlc->nick, rd_count, rd, &rdc_res, &rd_res);
1247 rlc->rd_ser_len = GNUNET_GNSRECORD_records_get_size (rdc_res, rd_res);
1248 if (rlc->rd_ser_len < 0)
1251 GNUNET_free (rd_res);
1252 rlc->found = GNUNET_NO;
1253 rlc->rd_ser_len = 0;
1256 rlc->res_rd_count = rdc_res;
1257 rlc->res_rd = GNUNET_malloc (rlc->rd_ser_len);
1258 if (rlc->rd_ser_len != GNUNET_GNSRECORD_records_serialize (rdc_res,
1264 GNUNET_free (rlc->res_rd);
1266 rlc->res_rd_count = 0;
1267 rlc->rd_ser_len = 0;
1268 GNUNET_free (rd_res);
1269 rlc->found = GNUNET_NO;
1272 GNUNET_free (rd_res);
1273 GNUNET_free (rlc->nick);
1278 rlc->rd_ser_len = GNUNET_GNSRECORD_records_get_size (rd_count, rd);
1279 if (rlc->rd_ser_len < 0)
1282 rlc->found = GNUNET_NO;
1283 rlc->rd_ser_len = 0;
1286 rlc->res_rd_count = rd_count;
1287 rlc->res_rd = GNUNET_malloc (rlc->rd_ser_len);
1288 if (rlc->rd_ser_len != GNUNET_GNSRECORD_records_serialize (rd_count,
1294 GNUNET_free (rlc->res_rd);
1296 rlc->res_rd_count = 0;
1297 rlc->rd_ser_len = 0;
1298 rlc->found = GNUNET_NO;
1306 * Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP message
1308 * @param cls client sending the message
1309 * @param ll_msg message of type `struct LabelLookupMessage`
1310 * @return #GNUNET_OK if @a ll_msg is well-formed
1313 check_record_lookup (void *cls, const struct LabelLookupMessage *ll_msg)
1319 name_len = ntohl (ll_msg->label_len);
1320 src_size = ntohs (ll_msg->gns_header.header.size);
1321 if (name_len != src_size - sizeof(struct LabelLookupMessage))
1324 return GNUNET_SYSERR;
1326 GNUNET_MQ_check_zero_termination (ll_msg);
1332 * Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP message
1334 * @param cls client sending the message
1335 * @param ll_msg message of type `struct LabelLookupMessage`
1338 handle_record_lookup (void *cls, const struct LabelLookupMessage *ll_msg)
1340 struct NamestoreClient *nc = cls;
1341 struct GNUNET_MQ_Envelope *env;
1342 struct LabelLookupResponseMessage *llr_msg;
1343 struct RecordLookupContext rlc;
1344 const char *name_tmp;
1350 name_len = ntohl (ll_msg->label_len);
1351 name_tmp = (const char *) &ll_msg[1];
1352 GNUNET_SERVICE_client_continue (nc->client);
1353 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1354 "Received NAMESTORE_RECORD_LOOKUP message for name `%s'\n",
1357 conv_name = GNUNET_GNSRECORD_string_to_lowercase (name_tmp);
1358 if (NULL == conv_name)
1360 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1361 "Error converting name `%s'\n",
1363 GNUNET_SERVICE_client_drop (nc->client);
1366 rlc.label = conv_name;
1367 rlc.found = GNUNET_NO;
1368 rlc.res_rd_count = 0;
1371 rlc.nick = get_nick_record (&ll_msg->zone);
1372 res = GSN_database->lookup_records (GSN_database->cls,
1377 GNUNET_free (conv_name);
1379 GNUNET_MQ_msg_extra (llr_msg,
1380 name_len + rlc.rd_ser_len,
1381 GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE);
1382 llr_msg->gns_header.r_id = ll_msg->gns_header.r_id;
1383 llr_msg->private_key = ll_msg->zone;
1384 llr_msg->name_len = htons (name_len);
1385 llr_msg->rd_count = htons (rlc.res_rd_count);
1386 llr_msg->rd_len = htons (rlc.rd_ser_len);
1387 res_name = (char *) &llr_msg[1];
1388 if ((GNUNET_YES == rlc.found) && (GNUNET_OK == res))
1389 llr_msg->found = ntohs (GNUNET_YES);
1391 llr_msg->found = ntohs (GNUNET_NO);
1392 GNUNET_memcpy (&llr_msg[1], name_tmp, name_len);
1393 GNUNET_memcpy (&res_name[name_len], rlc.res_rd, rlc.rd_ser_len);
1394 GNUNET_MQ_send (nc->mq, env);
1395 GNUNET_free_non_null (rlc.res_rd);
1400 * Checks a #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE message
1402 * @param cls client sending the message
1403 * @param rp_msg message of type `struct RecordStoreMessage`
1404 * @return #GNUNET_OK if @a rp_msg is well-formed
1407 check_record_store (void *cls, const struct RecordStoreMessage *rp_msg)
1411 size_t msg_size_exp;
1413 const char *name_tmp;
1416 name_len = ntohs (rp_msg->name_len);
1417 msg_size = ntohs (rp_msg->gns_header.header.size);
1418 rd_ser_len = ntohs (rp_msg->rd_len);
1419 msg_size_exp = sizeof(struct RecordStoreMessage) + name_len + rd_ser_len;
1420 if (msg_size != msg_size_exp)
1423 return GNUNET_SYSERR;
1425 if ((0 == name_len) || (name_len > MAX_NAME_LEN))
1428 return GNUNET_SYSERR;
1430 name_tmp = (const char *) &rp_msg[1];
1431 if ('\0' != name_tmp[name_len - 1])
1434 return GNUNET_SYSERR;
1441 * Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE message
1443 * @param cls client sending the message
1444 * @param rp_msg message of type `struct RecordStoreMessage`
1447 handle_record_store (void *cls, const struct RecordStoreMessage *rp_msg)
1449 struct NamestoreClient *nc = cls;
1453 const char *name_tmp;
1456 unsigned int rd_count;
1458 struct StoreActivity *sa;
1460 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1461 "Received NAMESTORE_RECORD_STORE message\n");
1462 rid = ntohl (rp_msg->gns_header.r_id);
1463 name_len = ntohs (rp_msg->name_len);
1464 rd_count = ntohs (rp_msg->rd_count);
1465 rd_ser_len = ntohs (rp_msg->rd_len);
1466 GNUNET_break (0 == ntohs (rp_msg->reserved));
1467 name_tmp = (const char *) &rp_msg[1];
1468 rd_ser = &name_tmp[name_len];
1470 struct GNUNET_GNSRECORD_Data rd[GNUNET_NZL (rd_count)];
1473 GNUNET_GNSRECORD_records_deserialize (rd_ser_len, rd_ser, rd_count, rd))
1476 GNUNET_SERVICE_client_drop (nc->client);
1480 /* Extracting and converting private key */
1481 conv_name = GNUNET_GNSRECORD_string_to_lowercase (name_tmp);
1482 if (NULL == conv_name)
1484 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1485 "Error converting name `%s'\n",
1487 GNUNET_SERVICE_client_drop (nc->client);
1490 GNUNET_STATISTICS_update (statistics,
1491 "Well-formed store requests received",
1494 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1495 "Creating %u records for name `%s'\n",
1496 (unsigned int) rd_count,
1498 if ((0 == rd_count) &&
1499 (GNUNET_NO == GSN_database->lookup_records (GSN_database->cls,
1500 &rp_msg->private_key,
1505 /* This name does not exist, so cannot be removed */
1506 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1507 "Name `%s' does not exist, no deletion required\n",
1513 /* remove "NICK" records, unless this is for the
1514 #GNUNET_GNS_EMPTY_LABEL_AT label */
1515 struct GNUNET_GNSRECORD_Data rd_clean[GNUNET_NZL (rd_count)];
1516 unsigned int rd_clean_off;
1520 have_nick = GNUNET_NO;
1521 for (unsigned int i = 0; i < rd_count; i++)
1523 rd_clean[rd_clean_off] = rd[i];
1524 if ((0 == strcmp (GNUNET_GNS_EMPTY_LABEL_AT, conv_name)) ||
1525 (GNUNET_GNSRECORD_TYPE_NICK != rd[i].record_type))
1528 if ((0 == strcmp (GNUNET_GNS_EMPTY_LABEL_AT, conv_name)) &&
1529 (GNUNET_GNSRECORD_TYPE_NICK == rd[i].record_type))
1531 cache_nick (&rp_msg->private_key, &rd[i]);
1532 have_nick = GNUNET_YES;
1535 if ((0 == strcmp (GNUNET_GNS_EMPTY_LABEL_AT, conv_name)) &&
1536 (GNUNET_NO == have_nick))
1538 /* remove nick record from cache, in case we have one there */
1539 cache_nick (&rp_msg->private_key, NULL);
1541 res = GSN_database->store_records (GSN_database->cls,
1542 &rp_msg->private_key,
1548 if (GNUNET_OK != res)
1550 /* store not successful, not need to tell monitors */
1551 send_store_response (nc, res, rid);
1552 GNUNET_SERVICE_client_continue (nc->client);
1553 GNUNET_free (conv_name);
1557 sa = GNUNET_malloc (sizeof(struct StoreActivity)
1558 + ntohs (rp_msg->gns_header.header.size));
1559 GNUNET_CONTAINER_DLL_insert (sa_head, sa_tail, sa);
1561 sa->rsm = (const struct RecordStoreMessage *) &sa[1];
1562 GNUNET_memcpy (&sa[1], rp_msg, ntohs (rp_msg->gns_header.header.size));
1563 sa->zm_pos = monitor_head;
1564 sa->conv_name = conv_name;
1565 continue_store_activity (sa);
1571 * Context for record remove operations passed from #handle_zone_to_name to
1572 * #handle_zone_to_name_it as closure
1574 struct ZoneToNameCtx
1579 struct NamestoreClient *nc;
1582 * Request id (to be used in the response to the client).
1587 * Set to #GNUNET_OK on success, #GNUNET_SYSERR on error. Note that
1588 * not finding a name for the zone still counts as a 'success' here,
1589 * as this field is about the success of executing the IPC protocol.
1596 * Zone to name iterator
1598 * @param cls struct ZoneToNameCtx *
1599 * @param seq sequence number of the record, MUST NOT BE ZERO
1600 * @param zone_key the zone key
1602 * @param rd_count number of records in @a rd
1603 * @param rd record data
1606 handle_zone_to_name_it (void *cls,
1608 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
1610 unsigned int rd_count,
1611 const struct GNUNET_GNSRECORD_Data *rd)
1613 struct ZoneToNameCtx *ztn_ctx = cls;
1614 struct GNUNET_MQ_Envelope *env;
1615 struct ZoneToNameResponseMessage *ztnr_msg;
1623 GNUNET_assert (0 != seq);
1624 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1625 "Found result for zone-to-name lookup: `%s'\n",
1628 name_len = (NULL == name) ? 0 : strlen (name) + 1;
1629 rd_ser_len = GNUNET_GNSRECORD_records_get_size (rd_count, rd);
1633 ztn_ctx->success = GNUNET_SYSERR;
1636 msg_size = sizeof(struct ZoneToNameResponseMessage) + name_len + rd_ser_len;
1637 if (msg_size >= GNUNET_MAX_MESSAGE_SIZE)
1640 ztn_ctx->success = GNUNET_SYSERR;
1644 GNUNET_MQ_msg_extra (ztnr_msg,
1645 name_len + rd_ser_len,
1646 GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE);
1647 ztnr_msg->gns_header.header.size = htons (msg_size);
1648 ztnr_msg->gns_header.r_id = htonl (ztn_ctx->rid);
1649 ztnr_msg->res = htons (res);
1650 ztnr_msg->rd_len = htons (rd_ser_len);
1651 ztnr_msg->rd_count = htons (rd_count);
1652 ztnr_msg->name_len = htons (name_len);
1653 ztnr_msg->zone = *zone_key;
1654 name_tmp = (char *) &ztnr_msg[1];
1655 GNUNET_memcpy (name_tmp, name, name_len);
1656 rd_tmp = &name_tmp[name_len];
1659 GNUNET_GNSRECORD_records_serialize (rd_count, rd, rd_ser_len, rd_tmp));
1660 ztn_ctx->success = GNUNET_OK;
1661 GNUNET_MQ_send (ztn_ctx->nc->mq, env);
1666 * Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME message
1668 * @param cls client client sending the message
1669 * @param ztn_msg message of type 'struct ZoneToNameMessage'
1672 handle_zone_to_name (void *cls, const struct ZoneToNameMessage *ztn_msg)
1674 struct NamestoreClient *nc = cls;
1675 struct ZoneToNameCtx ztn_ctx;
1676 struct GNUNET_MQ_Envelope *env;
1677 struct ZoneToNameResponseMessage *ztnr_msg;
1679 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received ZONE_TO_NAME message\n");
1680 ztn_ctx.rid = ntohl (ztn_msg->gns_header.r_id);
1682 ztn_ctx.success = GNUNET_NO;
1683 if (GNUNET_SYSERR == GSN_database->zone_to_name (GSN_database->cls,
1685 &ztn_msg->value_zone,
1686 &handle_zone_to_name_it,
1689 /* internal error, hang up instead of signalling something
1690 that might be wrong */
1692 GNUNET_SERVICE_client_drop (nc->client);
1695 if (GNUNET_NO == ztn_ctx.success)
1697 /* no result found, send empty response */
1698 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1699 "Found no result for zone-to-name lookup.\n");
1700 env = GNUNET_MQ_msg (ztnr_msg,
1701 GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE);
1702 ztnr_msg->gns_header.r_id = ztn_msg->gns_header.r_id;
1703 ztnr_msg->res = htons (GNUNET_NO);
1704 GNUNET_MQ_send (nc->mq, env);
1706 GNUNET_SERVICE_client_continue (nc->client);
1711 * Context for record remove operations passed from
1712 * #run_zone_iteration_round to #zone_iterate_proc as closure
1714 struct ZoneIterationProcResult
1717 * The zone iteration handle
1719 struct ZoneIteration *zi;
1722 * Number of results left to be returned in this iteration.
1729 * Process results for zone iteration from database
1731 * @param cls struct ZoneIterationProcResult
1732 * @param seq sequence number of the record, MUST NOT BE ZERO
1733 * @param zone_key the zone key
1735 * @param rd_count number of records for this name
1736 * @param rd record data
1739 zone_iterate_proc (void *cls,
1741 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
1743 unsigned int rd_count,
1744 const struct GNUNET_GNSRECORD_Data *rd)
1746 struct ZoneIterationProcResult *proc = cls;
1747 int do_refresh_block;
1749 GNUNET_assert (0 != seq);
1750 if ((NULL == zone_key) && (NULL == name))
1752 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Iteration done\n");
1755 if ((NULL == zone_key) || (NULL == name))
1757 /* what is this!? should never happen */
1761 if (0 == proc->limit)
1763 /* what is this!? should never happen */
1768 proc->zi->seq = seq;
1769 send_lookup_response (proc->zi->nc,
1770 proc->zi->request_id,
1777 do_refresh_block = GNUNET_NO;
1778 for (unsigned int i = 0; i < rd_count; i++)
1779 if (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION))
1781 do_refresh_block = GNUNET_YES;
1784 if (GNUNET_YES == do_refresh_block)
1785 refresh_block (NULL, proc->zi, 0, zone_key, name, rd_count, rd);
1790 * Perform the next round of the zone iteration.
1792 * @param zi zone iterator to process
1793 * @param limit number of results to return in one pass
1796 run_zone_iteration_round (struct ZoneIteration *zi, uint64_t limit)
1798 struct ZoneIterationProcResult proc;
1799 struct GNUNET_TIME_Absolute start;
1800 struct GNUNET_TIME_Relative duration;
1802 memset (&proc, 0, sizeof(proc));
1803 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1804 "Asked to return up to %llu records at position %llu\n",
1805 (unsigned long long) limit,
1806 (unsigned long long) zi->seq);
1809 start = GNUNET_TIME_absolute_get ();
1810 GNUNET_break (GNUNET_SYSERR !=
1811 GSN_database->iterate_records (GSN_database->cls,
1812 (0 == GNUNET_is_zero (&zi->zone))
1819 duration = GNUNET_TIME_absolute_get_duration (start);
1820 duration = GNUNET_TIME_relative_divide (duration, limit - proc.limit);
1821 GNUNET_STATISTICS_set (statistics,
1822 "NAMESTORE iteration delay (μs/record)",
1823 duration.rel_value_us,
1825 if (0 == proc.limit)
1826 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1827 "Returned %llu results, more results available\n",
1828 (unsigned long long) limit);
1829 zi->send_end = (0 != proc.limit);
1830 if (0 == zi->cache_ops)
1831 zone_iteration_done_client_continue (zi);
1836 * Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START message
1838 * @param cls the client sending the message
1839 * @param zis_msg message from the client
1842 handle_iteration_start (void *cls,
1843 const struct ZoneIterationStartMessage *zis_msg)
1845 struct NamestoreClient *nc = cls;
1846 struct ZoneIteration *zi;
1848 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1849 "Received ZONE_ITERATION_START message\n");
1850 zi = GNUNET_new (struct ZoneIteration);
1851 zi->request_id = ntohl (zis_msg->gns_header.r_id);
1854 zi->zone = zis_msg->zone;
1856 GNUNET_CONTAINER_DLL_insert (nc->op_head, nc->op_tail, zi);
1857 run_zone_iteration_round (zi, 1);
1862 * Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP message
1864 * @param cls the client sending the message
1865 * @param zis_msg message from the client
1868 handle_iteration_stop (void *cls,
1869 const struct ZoneIterationStopMessage *zis_msg)
1871 struct NamestoreClient *nc = cls;
1872 struct ZoneIteration *zi;
1875 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1876 "Received ZONE_ITERATION_STOP message\n");
1877 rid = ntohl (zis_msg->gns_header.r_id);
1878 for (zi = nc->op_head; NULL != zi; zi = zi->next)
1879 if (zi->request_id == rid)
1884 GNUNET_SERVICE_client_drop (nc->client);
1887 GNUNET_CONTAINER_DLL_remove (nc->op_head, nc->op_tail, zi);
1889 GNUNET_SERVICE_client_continue (nc->client);
1894 * Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT message
1896 * @param cls the client sending the message
1897 * @param message message from the client
1900 handle_iteration_next (void *cls,
1901 const struct ZoneIterationNextMessage *zis_msg)
1903 struct NamestoreClient *nc = cls;
1904 struct ZoneIteration *zi;
1908 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1909 "Received ZONE_ITERATION_NEXT message\n");
1910 GNUNET_STATISTICS_update (statistics,
1911 "Iteration NEXT messages received",
1914 rid = ntohl (zis_msg->gns_header.r_id);
1915 limit = GNUNET_ntohll (zis_msg->limit);
1916 for (zi = nc->op_head; NULL != zi; zi = zi->next)
1917 if (zi->request_id == rid)
1922 GNUNET_SERVICE_client_drop (nc->client);
1925 run_zone_iteration_round (zi, limit);
1930 * Function called when the monitor is ready for more data, and we
1931 * should thus unblock PUT operations that were blocked on the
1932 * monitor not being ready.
1935 monitor_unblock (struct ZoneMonitor *zm)
1937 struct StoreActivity *sa = sa_head;
1939 while ((NULL != sa) && (zm->limit > zm->iteration_cnt))
1941 struct StoreActivity *sn = sa->next;
1943 if (sa->zm_pos == zm)
1944 continue_store_activity (sa);
1947 if (zm->limit > zm->iteration_cnt)
1949 zm->sa_waiting = GNUNET_NO;
1950 if (NULL != zm->sa_wait_warning)
1952 GNUNET_SCHEDULER_cancel (zm->sa_wait_warning);
1953 zm->sa_wait_warning = NULL;
1956 else if (GNUNET_YES == zm->sa_waiting)
1958 zm->sa_waiting_start = GNUNET_TIME_absolute_get ();
1959 if (NULL != zm->sa_wait_warning)
1960 GNUNET_SCHEDULER_cancel (zm->sa_wait_warning);
1961 zm->sa_wait_warning =
1962 GNUNET_SCHEDULER_add_delayed (MONITOR_STALL_WARN_DELAY,
1970 * Send 'sync' message to zone monitor, we're now in sync.
1972 * @param zm monitor that is now in sync
1975 monitor_sync (struct ZoneMonitor *zm)
1977 struct GNUNET_MQ_Envelope *env;
1978 struct GNUNET_MessageHeader *sync;
1980 env = GNUNET_MQ_msg (sync, GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_SYNC);
1981 GNUNET_MQ_send (zm->nc->mq, env);
1982 /* mark iteration done */
1983 zm->in_first_iteration = GNUNET_NO;
1984 zm->iteration_cnt = 0;
1985 if ((zm->limit > 0) && (zm->sa_waiting))
1986 monitor_unblock (zm);
1991 * Obtain the next datum during the zone monitor's zone initial iteration.
1993 * @param cls zone monitor that does its initial iteration
1996 monitor_iteration_next (void *cls);
2000 * A #GNUNET_NAMESTORE_RecordIterator for monitors.
2002 * @param cls a 'struct ZoneMonitor *' with information about the monitor
2003 * @param seq sequence number of the record, MUST NOT BE ZERO
2004 * @param zone_key zone key of the zone
2006 * @param rd_count number of records in @a rd
2007 * @param rd array of records
2010 monitor_iterate_cb (void *cls,
2012 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
2014 unsigned int rd_count,
2015 const struct GNUNET_GNSRECORD_Data *rd)
2017 struct ZoneMonitor *zm = cls;
2019 GNUNET_assert (0 != seq);
2021 GNUNET_assert (NULL != name);
2022 GNUNET_STATISTICS_update (statistics,
2023 "Monitor notifications sent",
2027 zm->iteration_cnt--;
2028 send_lookup_response (zm->nc, 0, zone_key, name, rd_count, rd);
2029 if ((0 == zm->iteration_cnt) && (0 != zm->limit))
2031 /* We are done with the current iteration batch, AND the
2032 client would right now accept more, so go again! */
2033 GNUNET_assert (NULL == zm->task);
2034 zm->task = GNUNET_SCHEDULER_add_now (&monitor_iteration_next, zm);
2040 * Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START message
2042 * @param cls the client sending the message
2043 * @param zis_msg message from the client
2046 handle_monitor_start (void *cls, const struct ZoneMonitorStartMessage *zis_msg)
2048 struct NamestoreClient *nc = cls;
2049 struct ZoneMonitor *zm;
2051 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received ZONE_MONITOR_START message\n");
2052 zm = GNUNET_new (struct ZoneMonitor);
2054 zm->zone = zis_msg->zone;
2056 zm->in_first_iteration = (GNUNET_YES == ntohl (zis_msg->iterate_first));
2057 GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, zm);
2058 GNUNET_SERVICE_client_mark_monitor (nc->client);
2059 GNUNET_SERVICE_client_continue (nc->client);
2060 GNUNET_notification_context_add (monitor_nc, nc->mq);
2061 if (zm->in_first_iteration)
2062 zm->task = GNUNET_SCHEDULER_add_now (&monitor_iteration_next, zm);
2069 * Obtain the next datum during the zone monitor's zone initial iteration.
2071 * @param cls zone monitor that does its initial iteration
2074 monitor_iteration_next (void *cls)
2076 struct ZoneMonitor *zm = cls;
2080 GNUNET_assert (0 == zm->iteration_cnt);
2082 zm->iteration_cnt = zm->limit / 2; /* leave half for monitor events */
2084 zm->iteration_cnt = zm->limit; /* use it all */
2085 ret = GSN_database->iterate_records (GSN_database->cls,
2086 (0 == GNUNET_is_zero (&zm->zone))
2091 &monitor_iterate_cb,
2093 if (GNUNET_SYSERR == ret)
2095 GNUNET_SERVICE_client_drop (zm->nc->client);
2098 if (GNUNET_NO == ret)
2108 * Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_NEXT message
2110 * @param cls the client sending the message
2111 * @param nm message from the client
2114 handle_monitor_next (void *cls, const struct ZoneMonitorNextMessage *nm)
2116 struct NamestoreClient *nc = cls;
2117 struct ZoneMonitor *zm;
2120 inc = GNUNET_ntohll (nm->limit);
2121 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2122 "Received ZONE_MONITOR_NEXT message with limit %llu\n",
2123 (unsigned long long) inc);
2124 for (zm = monitor_head; NULL != zm; zm = zm->next)
2130 GNUNET_SERVICE_client_drop (nc->client);
2133 GNUNET_SERVICE_client_continue (nc->client);
2134 if (zm->limit + inc < zm->limit)
2137 GNUNET_SERVICE_client_drop (nc->client);
2141 if ((zm->in_first_iteration) && (zm->limit == inc))
2143 /* We are still iterating, and the previous iteration must
2144 have stopped due to the client's limit, so continue it! */
2145 GNUNET_assert (NULL == zm->task);
2146 zm->task = GNUNET_SCHEDULER_add_now (&monitor_iteration_next, zm);
2148 GNUNET_assert (zm->iteration_cnt <= zm->limit);
2149 if ((zm->limit > zm->iteration_cnt) && (zm->sa_waiting))
2151 monitor_unblock (zm);
2153 else if (GNUNET_YES == zm->sa_waiting)
2155 if (NULL != zm->sa_wait_warning)
2156 GNUNET_SCHEDULER_cancel (zm->sa_wait_warning);
2157 zm->sa_waiting_start = GNUNET_TIME_absolute_get ();
2158 zm->sa_wait_warning =
2159 GNUNET_SCHEDULER_add_delayed (MONITOR_STALL_WARN_DELAY,
2167 * Process namestore requests.
2169 * @param cls closure
2170 * @param cfg configuration to use
2171 * @param service the initialized service
2175 const struct GNUNET_CONFIGURATION_Handle *cfg,
2176 struct GNUNET_SERVICE_Handle *service)
2182 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting namestore service\n");
2184 GNUNET_CONFIGURATION_get_value_yesno (cfg, "namestore", "CACHE_KEYS");
2186 GNUNET_CONFIGURATION_get_value_yesno (cfg, "namecache", "DISABLE");
2188 monitor_nc = GNUNET_notification_context_create (1);
2189 if (GNUNET_YES != disable_namecache)
2191 namecache = GNUNET_NAMECACHE_connect (cfg);
2192 GNUNET_assert (NULL != namecache);
2194 /* Loading database plugin */
2195 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg,
2199 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "No database backend configured\n");
2201 GNUNET_asprintf (&db_lib_name, "libgnunet_plugin_namestore_%s", database);
2202 GSN_database = GNUNET_PLUGIN_load (db_lib_name, (void *) GSN_cfg);
2203 GNUNET_free (database);
2204 statistics = GNUNET_STATISTICS_create ("namestore", cfg);
2205 GNUNET_SCHEDULER_add_shutdown (&cleanup_task, NULL);
2206 if (NULL == GSN_database)
2208 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2209 "Could not load database backend `%s'\n",
2211 GNUNET_SCHEDULER_shutdown ();
2218 * Define "main" method using service macro.
2220 GNUNET_SERVICE_MAIN (
2222 GNUNET_SERVICE_OPTION_NONE,
2225 &client_disconnect_cb,
2227 GNUNET_MQ_hd_var_size (record_store,
2228 GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE,
2229 struct RecordStoreMessage,
2231 GNUNET_MQ_hd_var_size (record_lookup,
2232 GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP,
2233 struct LabelLookupMessage,
2235 GNUNET_MQ_hd_fixed_size (zone_to_name,
2236 GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME,
2237 struct ZoneToNameMessage,
2239 GNUNET_MQ_hd_fixed_size (iteration_start,
2240 GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START,
2241 struct ZoneIterationStartMessage,
2243 GNUNET_MQ_hd_fixed_size (iteration_next,
2244 GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT,
2245 struct ZoneIterationNextMessage,
2247 GNUNET_MQ_hd_fixed_size (iteration_stop,
2248 GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP,
2249 struct ZoneIterationStopMessage,
2251 GNUNET_MQ_hd_fixed_size (monitor_start,
2252 GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START,
2253 struct ZoneMonitorStartMessage,
2255 GNUNET_MQ_hd_fixed_size (monitor_next,
2256 GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_NEXT,
2257 struct ZoneMonitorNextMessage,
2259 GNUNET_MQ_handler_end ());
2262 /* end of gnunet-service-namestore.c */