2 This file is part of GNUnet
3 Copyright (C) 2004-2014, 2016 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 datastore/gnunet-service-datastore.c
23 * @brief Management for the datastore for files stored on a GNUnet node
24 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet_protocols.h"
30 #include "gnunet_statistics_service.h"
31 #include "gnunet_datastore_plugin.h"
32 #include "datastore.h"
35 * How many messages do we queue at most per client?
37 #define MAX_PENDING 1024
40 * Limit size of bloom filter to 2 GB.
42 #define MAX_BF_SIZE ((uint32_t) (1LL << 31))
45 * How long are we at most keeping "expired" content
46 * past the expiration date in the database?
48 #define MAX_EXPIRE_DELAY \
49 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
52 * How fast are we allowed to query the database for deleting
53 * expired content? (1 item per second).
55 #define MIN_EXPIRE_DELAY \
56 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
59 * Name under which we store current space consumption.
61 static char *quota_stat_name;
64 * Task to timeout stat GET.
66 static struct GNUNET_SCHEDULER_Task *stat_timeout_task;
69 * After how many payload-changing operations
70 * do we sync our statistics?
72 #define MAX_STAT_SYNC_LAG 50
76 * Our datastore plugin.
78 struct DatastorePlugin
81 * API of the transport as returned by the plugin's
82 * initialization function.
84 struct GNUNET_DATASTORE_PluginFunctions *api;
87 * Short name for the plugin (i.e. "sqlite").
92 * Name of the library (i.e. "gnunet_plugin_datastore_sqlite").
97 * Environment this transport service is using
100 struct GNUNET_DATASTORE_PluginEnvironment env;
105 * Linked list of active reservations.
107 struct ReservationList
110 * This is a linked list.
112 struct ReservationList *next;
115 * Client that made the reservation.
117 struct GNUNET_SERVICE_Client *client;
120 * Number of bytes (still) reserved.
125 * Number of items (still) reserved.
130 * Reservation identifier.
137 * Our datastore plugin (NULL if not available).
139 static struct DatastorePlugin *plugin;
142 * Linked list of space reservations made by clients.
144 static struct ReservationList *reservations;
147 * Bloomfilter to quickly tell if we don't have the content.
149 static struct GNUNET_CONTAINER_BloomFilter *filter;
152 * Name of our plugin.
154 static char *plugin_name;
159 static const struct GNUNET_CONFIGURATION_Handle *cfg;
162 * Handle for reporting statistics.
164 static struct GNUNET_STATISTICS_Handle *stats;
167 * How much space are we using for the cache? (space available for
168 * insertions that will be instantly reclaimed by discarding less
169 * important content --- or possibly whatever we just inserted into
172 static unsigned long long cache_size;
175 * How much space have we currently reserved?
177 static unsigned long long reserved;
180 * How much data are we currently storing
183 static unsigned long long payload;
186 * Identity of the task that is used to delete
189 static struct GNUNET_SCHEDULER_Task *expired_kill_task;
192 * Minimum time that content should have to not be discarded instantly
193 * (time stamp of any content that we've been discarding recently to
194 * stay below the quota). FOREVER if we had to expire content with
197 static struct GNUNET_TIME_Absolute min_expiration;
200 * How much space are we allowed to use?
202 static unsigned long long quota;
205 * Should the database be dropped on exit?
210 * Should we refresh the BF when the DB is loaded?
212 static int refresh_bf;
215 * Number of updates that were made to the
216 * payload value since we last synchronized
217 * it with the statistics service.
219 static unsigned int last_sync;
222 * Did we get an answer from statistics?
224 static int stats_worked;
228 * Synchronize our utilization statistics with the
229 * statistics service.
234 GNUNET_STATISTICS_set (stats, quota_stat_name, payload, GNUNET_YES);
235 GNUNET_STATISTICS_set (stats,
236 "# utilization by current datastore",
244 * Have we already cleaned up the TCCs and are hence no longer
245 * willing (or able) to transmit anything to anyone?
247 static int cleaning_done;
250 * Handle for pending get request.
252 static struct GNUNET_STATISTICS_GetHandle *stat_get;
255 * Handle to our server.
257 static struct GNUNET_SERVICE_Handle *service;
260 * Task that is used to remove expired entries from
261 * the datastore. This task will schedule itself
262 * again automatically to always delete all expired
265 * @param cls not used
268 delete_expired (void *cls);
272 * Iterate over the expired items stored in the datastore.
273 * Delete all expired items; once we have processed all
274 * expired items, re-schedule the "delete_expired" task.
276 * @param cls not used
277 * @param key key for the content
278 * @param size number of bytes in data
279 * @param data content stored
280 * @param type type of the content
281 * @param priority priority of the content
282 * @param anonymity anonymity-level for the content
283 * @param replication replication-level for the content
284 * @param expiration expiration time for the content
285 * @param uid unique identifier for the datum;
286 * maybe 0 if no unique identifier is available
288 * @return #GNUNET_SYSERR to abort the iteration, #GNUNET_OK to continue
289 * (continue on call to "next", of course),
290 * #GNUNET_NO to delete the item and continue (if supported)
293 expired_processor (void *cls,
294 const struct GNUNET_HashCode *key,
297 enum GNUNET_BLOCK_Type type,
300 uint32_t replication,
301 struct GNUNET_TIME_Absolute expiration,
304 struct GNUNET_TIME_Absolute now;
309 GNUNET_SCHEDULER_add_delayed_with_priority (MAX_EXPIRE_DELAY,
310 GNUNET_SCHEDULER_PRIORITY_IDLE,
313 return GNUNET_SYSERR;
315 now = GNUNET_TIME_absolute_get ();
316 if (expiration.abs_value_us > now.abs_value_us)
318 /* finished processing */
320 GNUNET_SCHEDULER_add_delayed_with_priority (MAX_EXPIRE_DELAY,
321 GNUNET_SCHEDULER_PRIORITY_IDLE,
324 return GNUNET_SYSERR;
326 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
327 "Deleting content `%s' of type %u that expired %s ago\n",
330 GNUNET_STRINGS_relative_time_to_string (
331 GNUNET_TIME_absolute_get_difference (expiration, now),
333 min_expiration = now;
334 GNUNET_STATISTICS_update (stats,
335 gettext_noop ("# bytes expired"),
338 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
340 GNUNET_SCHEDULER_add_delayed_with_priority (MIN_EXPIRE_DELAY,
341 GNUNET_SCHEDULER_PRIORITY_IDLE,
349 * Task that is used to remove expired entries from
350 * the datastore. This task will schedule itself
351 * again automatically to always delete all expired
354 * @param cls not used
357 delete_expired (void *cls)
359 expired_kill_task = NULL;
360 plugin->api->get_expiration (plugin->api->cls, &expired_processor, NULL);
365 * An iterator over a set of items stored in the datastore
366 * that deletes until we're happy with respect to our quota.
369 * @param key key for the content
370 * @param size number of bytes in data
371 * @param data content stored
372 * @param type type of the content
373 * @param priority priority of the content
374 * @param anonymity anonymity-level for the content
375 * @param replication replication-level for the content
376 * @param expiration expiration time for the content
377 * @param uid unique identifier for the datum;
378 * maybe 0 if no unique identifier is available
379 * @return #GNUNET_SYSERR to abort the iteration, #GNUNET_OK to continue
380 * (continue on call to "next", of course),
381 * #GNUNET_NO to delete the item and continue (if supported)
384 quota_processor (void *cls,
385 const struct GNUNET_HashCode *key,
388 enum GNUNET_BLOCK_Type type,
391 uint32_t replication,
392 struct GNUNET_TIME_Absolute expiration,
395 unsigned long long *need = cls;
398 return GNUNET_SYSERR;
400 GNUNET_ERROR_TYPE_DEBUG,
401 "Deleting %llu bytes of low-priority (%u) content `%s' of type %u at %s prior to expiration (still trying to free another %llu bytes)\n",
402 (unsigned long long) (size + GNUNET_DATASTORE_ENTRY_OVERHEAD),
403 (unsigned int) priority,
406 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (
410 if (size + GNUNET_DATASTORE_ENTRY_OVERHEAD > *need)
413 *need -= size + GNUNET_DATASTORE_ENTRY_OVERHEAD;
415 min_expiration = GNUNET_TIME_UNIT_FOREVER_ABS;
417 min_expiration = expiration;
418 GNUNET_STATISTICS_update (stats,
419 gettext_noop ("# bytes purged (low-priority)"),
422 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
428 * Manage available disk space by running tasks
429 * that will discard content if necessary. This
430 * function will be run whenever a request for
431 * "need" bytes of storage could only be satisfied
432 * by eating into the "cache" (and we want our cache
435 * @param need number of bytes of content that were
436 * placed into the "cache" (and hence the
437 * number of bytes that should be removed).
440 manage_space (unsigned long long need)
442 unsigned long long last;
444 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
445 "Asked to free up %llu bytes of cache space\n",
448 while ((need > 0) && (last != need))
451 plugin->api->get_expiration (plugin->api->cls, "a_processor, &need);
457 * Transmit a status code to the client.
459 * @param client receiver of the response
460 * @param code status code
461 * @param msg optional error message (can be NULL)
464 transmit_status (struct GNUNET_SERVICE_Client *client,
468 struct GNUNET_MQ_Envelope *env;
469 struct StatusMessage *sm;
472 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
473 "Transmitting `%s' message with value %d and message `%s'\n",
476 msg != NULL ? msg : "(none)");
477 slen = (msg == NULL) ? 0 : strlen (msg) + 1;
478 env = GNUNET_MQ_msg_extra (sm, slen, GNUNET_MESSAGE_TYPE_DATASTORE_STATUS);
479 sm->status = htonl (code);
480 sm->min_expiration = GNUNET_TIME_absolute_hton (min_expiration);
481 GNUNET_memcpy (&sm[1], msg, slen);
482 GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client), env);
487 * Function that will transmit the given datastore entry
490 * @param cls closure, pointer to the client (of type `struct GNUNET_SERVICE_Client`).
491 * @param key key for the content
492 * @param size number of bytes in data
493 * @param data content stored
494 * @param type type of the content
495 * @param priority priority of the content
496 * @param anonymity anonymity-level for the content
497 * @param replication replication-level for the content
498 * @param expiration expiration time for the content
499 * @param uid unique identifier for the datum;
500 * maybe 0 if no unique identifier is available
501 * @return #GNUNET_SYSERR to abort the iteration, #GNUNET_OK to continue,
502 * #GNUNET_NO to delete the item and continue (if supported)
505 transmit_item (void *cls,
506 const struct GNUNET_HashCode *key,
509 enum GNUNET_BLOCK_Type type,
512 uint32_t replication,
513 struct GNUNET_TIME_Absolute expiration,
516 struct GNUNET_SERVICE_Client *client = cls;
517 struct GNUNET_MQ_Envelope *env;
518 struct GNUNET_MessageHeader *end;
519 struct DataMessage *dm;
523 /* transmit 'DATA_END' */
524 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting DATA_END message\n");
525 env = GNUNET_MQ_msg (end, GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END);
526 GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client), env);
529 GNUNET_assert (sizeof(struct DataMessage) + size < GNUNET_MAX_MESSAGE_SIZE);
530 env = GNUNET_MQ_msg_extra (dm, size, GNUNET_MESSAGE_TYPE_DATASTORE_DATA);
532 dm->size = htonl (size);
533 dm->type = htonl (type);
534 dm->priority = htonl (priority);
535 dm->anonymity = htonl (anonymity);
536 dm->replication = htonl (replication);
537 dm->expiration = GNUNET_TIME_absolute_hton (expiration);
538 dm->uid = GNUNET_htonll (uid);
540 GNUNET_memcpy (&dm[1], data, size);
542 GNUNET_ERROR_TYPE_DEBUG,
543 "Transmitting DATA message for `%s' of type %u with expiration %s (in: %s)\n",
546 GNUNET_STRINGS_absolute_time_to_string (expiration),
547 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (
550 GNUNET_STATISTICS_update (stats,
551 gettext_noop ("# results found"),
554 GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client), env);
560 * Handle RESERVE-message.
562 * @param cls identification of the client
563 * @param message the actual message
566 handle_reserve (void *cls, const struct ReserveMessage *msg)
569 * Static counter to produce reservation identifiers.
571 static int reservation_gen;
572 struct GNUNET_SERVICE_Client *client = cls;
573 struct ReservationList *e;
574 unsigned long long used;
575 unsigned long long req;
579 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing RESERVE request\n");
580 amount = GNUNET_ntohll (msg->amount);
581 entries = ntohl (msg->entries);
582 used = payload + reserved;
584 amount + ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * entries;
585 if (used + req > quota)
589 quota; /* cheat a bit for error message (to avoid negative numbers) */
591 GNUNET_ERROR_TYPE_WARNING,
593 "Insufficient space (%llu bytes are available) to satisfy RESERVE request for %llu bytes\n"),
596 if (cache_size < req)
598 /* TODO: document this in the FAQ; essentially, if this
599 * message happens, the insertion request could be blocked
600 * by less-important content from migration because it is
601 * larger than 1/8th of the overall available space, and
602 * we only reserve 1/8th for "fresh" insertions */
604 GNUNET_ERROR_TYPE_WARNING,
606 "The requested amount (%llu bytes) is larger than the cache size (%llu bytes)\n"),
609 transmit_status (client,
612 "Insufficient space to satisfy request and "
613 "requested amount is larger than cache size"));
617 transmit_status (client,
619 gettext_noop ("Insufficient space to satisfy request"));
621 GNUNET_SERVICE_client_continue (client);
625 GNUNET_STATISTICS_set (stats,
626 gettext_noop ("# reserved"),
629 e = GNUNET_new (struct ReservationList);
630 e->next = reservations;
634 e->entries = entries;
635 e->rid = ++reservation_gen;
636 if (reservation_gen < 0)
637 reservation_gen = 0; /* wrap around */
638 transmit_status (client, e->rid, NULL);
639 GNUNET_SERVICE_client_continue (client);
644 * Handle RELEASE_RESERVE-message.
646 * @param cls identification of the client
647 * @param message the actual message
650 handle_release_reserve (void *cls, const struct ReleaseReserveMessage *msg)
652 struct GNUNET_SERVICE_Client *client = cls;
653 struct ReservationList *pos;
654 struct ReservationList *prev;
655 struct ReservationList *next;
656 int rid = ntohl (msg->rid);
657 unsigned long long rem;
659 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing RELEASE_RESERVE request\n");
662 while (NULL != (pos = next))
673 + ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * pos->entries;
674 GNUNET_assert (reserved >= rem);
676 GNUNET_STATISTICS_set (stats,
677 gettext_noop ("# reserved"),
680 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
681 "Returning %llu remaining reserved bytes to storage pool\n",
684 transmit_status (client, GNUNET_OK, NULL);
685 GNUNET_SERVICE_client_continue (client);
691 transmit_status (client,
693 gettext_noop ("Could not find matching reservation"));
694 GNUNET_SERVICE_client_continue (client);
699 * Check that the given message is a valid data message.
701 * @param dm message to check
702 * @return #GNUNET_SYSERR is not well-formed, otherwise #GNUNET_OK
705 check_data (const struct DataMessage *dm)
710 size = ntohs (dm->header.size);
711 dsize = ntohl (dm->size);
712 if (size != dsize + sizeof(struct DataMessage))
715 return GNUNET_SYSERR;
725 * @param key key for the item stored
726 * @param size size of the item stored
727 * @param status #GNUNET_OK if inserted, #GNUNET_NO if updated,
728 * or #GNUNET_SYSERROR if error
729 * @param msg error message on error
732 put_continuation (void *cls,
733 const struct GNUNET_HashCode *key,
738 struct GNUNET_SERVICE_Client *client = cls;
740 if (GNUNET_OK == status)
742 GNUNET_STATISTICS_update (stats,
743 gettext_noop ("# bytes stored"),
746 GNUNET_CONTAINER_bloomfilter_add (filter, key);
747 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
748 "Successfully stored %u bytes under key `%s'\n",
752 transmit_status (client,
753 GNUNET_SYSERR == status ? GNUNET_SYSERR : GNUNET_OK,
755 if (quota - reserved - cache_size < payload)
757 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
758 _ ("Need %llu bytes more space (%llu allowed, using %llu)\n"),
759 (unsigned long long) size + GNUNET_DATASTORE_ENTRY_OVERHEAD,
760 (unsigned long long) (quota - reserved - cache_size),
761 (unsigned long long) payload);
762 manage_space (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
768 * Verify PUT-message.
770 * @param cls identification of the client
771 * @param message the actual message
772 * @return #GNUNET_OK if @a dm is well-formed
775 check_put (void *cls, const struct DataMessage *dm)
777 if (GNUNET_OK != check_data (dm))
780 return GNUNET_SYSERR;
787 * Handle PUT-message.
789 * @param cls identification of the client
790 * @param message the actual message
793 handle_put (void *cls, const struct DataMessage *dm)
795 struct GNUNET_SERVICE_Client *client = cls;
797 struct ReservationList *pos;
800 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
801 "Processing PUT request for `%s' of type %u\n",
802 GNUNET_h2s (&dm->key),
803 (uint32_t) ntohl (dm->type));
804 rid = ntohl (dm->rid);
805 size = ntohl (dm->size);
809 while ((NULL != pos) && (rid != pos->rid))
811 GNUNET_break (pos != NULL);
814 GNUNET_break (pos->entries > 0);
815 GNUNET_break (pos->amount >= size);
818 reserved -= (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
819 GNUNET_STATISTICS_set (stats,
820 gettext_noop ("# reserved"),
826 GNUNET_NO == GNUNET_CONTAINER_bloomfilter_test (filter, &dm->key);
827 plugin->api->put (plugin->api->cls,
833 ntohl (dm->priority),
834 ntohl (dm->anonymity),
835 ntohl (dm->replication),
836 GNUNET_TIME_absolute_ntoh (dm->expiration),
839 GNUNET_SERVICE_client_continue (client);
844 * Handle #GNUNET_MESSAGE_TYPE_DATASTORE_GET-message.
846 * @param cls identification of the client
847 * @param msg the actual message
850 handle_get (void *cls, const struct GetMessage *msg)
852 struct GNUNET_SERVICE_Client *client = cls;
854 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
855 "Processing GET request of type %u\n",
856 (uint32_t) ntohl (msg->type));
857 GNUNET_STATISTICS_update (stats,
858 gettext_noop ("# GET requests received"),
861 plugin->api->get_key (plugin->api->cls,
862 GNUNET_ntohll (msg->next_uid),
868 GNUNET_SERVICE_client_continue (client);
873 * Handle #GNUNET_MESSAGE_TYPE_DATASTORE_GET_KEY-message.
876 * @param msg the actual message
879 handle_get_key (void *cls, const struct GetKeyMessage *msg)
881 struct GNUNET_SERVICE_Client *client = cls;
883 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
884 "Processing GET request for `%s' of type %u\n",
885 GNUNET_h2s (&msg->key),
886 (uint32_t) ntohl (msg->type));
887 GNUNET_STATISTICS_update (stats,
888 gettext_noop ("# GET KEY requests received"),
891 if (GNUNET_YES != GNUNET_CONTAINER_bloomfilter_test (filter, &msg->key))
893 /* don't bother database... */
894 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
895 "Empty result set for GET request for `%s' (bloomfilter).\n",
896 GNUNET_h2s (&msg->key));
897 GNUNET_STATISTICS_update (stats,
899 "# requests filtered by bloomfilter"),
902 transmit_item (client,
910 GNUNET_TIME_UNIT_ZERO_ABS,
912 GNUNET_SERVICE_client_continue (client);
915 plugin->api->get_key (plugin->api->cls,
916 GNUNET_ntohll (msg->next_uid),
922 GNUNET_SERVICE_client_continue (client);
927 * Handle GET_REPLICATION-message.
929 * @param cls identification of the client
930 * @param message the actual message
933 handle_get_replication (void *cls, const struct GNUNET_MessageHeader *message)
935 struct GNUNET_SERVICE_Client *client = cls;
937 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing GET_REPLICATION request\n");
938 GNUNET_STATISTICS_update (stats,
940 "# GET REPLICATION requests received"),
943 plugin->api->get_replication (plugin->api->cls, &transmit_item, client);
944 GNUNET_SERVICE_client_continue (client);
949 * Handle GET_ZERO_ANONYMITY-message.
951 * @param cls client identification of the client
952 * @param message the actual message
955 handle_get_zero_anonymity (void *cls, const struct GetZeroAnonymityMessage *msg)
957 struct GNUNET_SERVICE_Client *client = cls;
958 enum GNUNET_BLOCK_Type type;
960 type = (enum GNUNET_BLOCK_Type) ntohl (msg->type);
961 if (type == GNUNET_BLOCK_TYPE_ANY)
964 GNUNET_SERVICE_client_drop (client);
967 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
968 "Processing GET_ZERO_ANONYMITY request\n");
969 GNUNET_STATISTICS_update (stats,
971 "# GET ZERO ANONYMITY requests received"),
974 plugin->api->get_zero_anonymity (plugin->api->cls,
975 GNUNET_ntohll (msg->next_uid),
979 GNUNET_SERVICE_client_continue (client);
984 * Remove continuation.
987 * @param key key for the content
988 * @param size number of bytes in data
989 * @param status #GNUNET_OK if removed, #GNUNET_NO if not found,
990 * or #GNUNET_SYSERROR if error
991 * @param msg error message on error
994 remove_continuation (void *cls,
995 const struct GNUNET_HashCode *key,
1000 struct GNUNET_SERVICE_Client *client = cls;
1002 if (GNUNET_SYSERR == status)
1004 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "REMOVE request failed: %s.\n", msg);
1005 transmit_status (client, GNUNET_NO, msg);
1008 if (GNUNET_NO == status)
1010 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1011 "Content not found for REMOVE request.\n");
1012 transmit_status (client, GNUNET_NO, _ ("Content not found"));
1015 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1016 "Item matches REMOVE request for key `%s'.\n",
1018 GNUNET_STATISTICS_update (stats,
1019 gettext_noop ("# bytes removed (explicit request)"),
1022 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
1023 transmit_status (client, GNUNET_OK, NULL);
1028 * Verify REMOVE-message.
1030 * @param cls identification of the client
1031 * @param message the actual message
1032 * @return #GNUNET_OK if @a dm is well-formed
1035 check_remove (void *cls, const struct DataMessage *dm)
1037 if (GNUNET_OK != check_data (dm))
1040 return GNUNET_SYSERR;
1047 * Handle REMOVE-message.
1049 * @param cls closure
1050 * @param client identification of the client
1051 * @param message the actual message
1054 handle_remove (void *cls, const struct DataMessage *dm)
1056 struct GNUNET_SERVICE_Client *client = cls;
1058 GNUNET_STATISTICS_update (stats,
1059 gettext_noop ("# REMOVE requests received"),
1062 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1063 "Processing REMOVE request for `%s'\n",
1064 GNUNET_h2s (&dm->key));
1065 plugin->api->remove_key (plugin->api->cls,
1069 &remove_continuation,
1071 GNUNET_SERVICE_client_continue (client);
1076 * Handle DROP-message.
1078 * @param cls identification of the client
1079 * @param message the actual message
1082 handle_drop (void *cls, const struct GNUNET_MessageHeader *message)
1084 struct GNUNET_SERVICE_Client *client = cls;
1086 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing DROP request\n");
1087 do_drop = GNUNET_YES;
1088 GNUNET_SERVICE_client_continue (client);
1093 * Function called by plugins to notify us about a
1094 * change in their disk utilization.
1096 * @param cls closure (NULL)
1097 * @param delta change in disk utilization,
1098 * 0 for "reset to empty"
1101 disk_utilization_change_cb (void *cls, int delta)
1103 if ((delta < 0) && (payload < -delta))
1106 GNUNET_ERROR_TYPE_WARNING,
1108 "Datastore payload must have been inaccurate (%lld < %lld). Recomputing it.\n"),
1109 (long long) payload,
1110 (long long) -delta);
1111 plugin->api->estimate_size (plugin->api->cls, &payload);
1112 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1113 _ ("New payload: %lld\n"),
1114 (long long) payload);
1120 if (last_sync >= MAX_STAT_SYNC_LAG)
1126 * Callback function to process statistic values.
1128 * @param cls closure (struct Plugin*)
1129 * @param subsystem name of subsystem that created the statistic
1130 * @param name the name of the datum
1131 * @param value the current value
1132 * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
1133 * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
1136 process_stat_in (void *cls,
1137 const char *subsystem,
1142 GNUNET_assert (GNUNET_NO == stats_worked);
1143 stats_worked = GNUNET_YES;
1146 GNUNET_ERROR_TYPE_DEBUG,
1147 "Notification from statistics about existing payload (%llu), new payload is %llu\n",
1148 (unsigned long long) value,
1149 (unsigned long long) payload);
1155 * Load the datastore plugin.
1157 static struct DatastorePlugin *
1160 struct DatastorePlugin *ret;
1163 ret = GNUNET_new (struct DatastorePlugin);
1165 ret->env.duc = &disk_utilization_change_cb;
1166 ret->env.cls = NULL;
1167 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1168 _ ("Loading `%s' datastore plugin\n"),
1170 GNUNET_asprintf (&libname, "libgnunet_plugin_datastore_%s", plugin_name);
1171 ret->short_name = GNUNET_strdup (plugin_name);
1172 ret->lib_name = libname;
1173 ret->api = GNUNET_PLUGIN_load (libname, &ret->env);
1174 if (NULL == ret->api)
1176 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1177 _ ("Failed to load datastore plugin for `%s'\n"),
1179 GNUNET_free (ret->short_name);
1180 GNUNET_free (libname);
1189 * Function called when the service shuts
1190 * down. Unloads our datastore plugin.
1192 * @param plug plugin to unload
1195 unload_plugin (struct DatastorePlugin *plug)
1197 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1198 "Datastore service is unloading plugin...\n");
1199 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
1200 GNUNET_free (plug->lib_name);
1201 GNUNET_free (plug->short_name);
1207 * Initialization complete, start operating the service.
1212 GNUNET_SERVICE_resume (service);
1214 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1221 * Adds a given @a key to the bloomfilter in @a cls @a count times.
1223 * @param cls the bloomfilter
1224 * @param key key to add
1225 * @param count number of times to add key
1228 add_key_to_bloomfilter (void *cls,
1229 const struct GNUNET_HashCode *key,
1232 struct GNUNET_CONTAINER_BloomFilter *bf = cls;
1236 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1237 _ ("Bloomfilter construction complete.\n"));
1243 GNUNET_CONTAINER_bloomfilter_add (bf, key);
1248 * We finished receiving the statistic. Initialize the plugin; if
1249 * loading the statistic failed, run the estimator.
1252 * @param success #GNUNET_NO if we failed to read the stat
1255 process_stat_done (void *cls, int success)
1258 if (NULL != stat_timeout_task)
1260 GNUNET_SCHEDULER_cancel (stat_timeout_task);
1261 stat_timeout_task = NULL;
1263 plugin = load_plugin ();
1266 GNUNET_CONTAINER_bloomfilter_free (filter);
1270 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1276 if (GNUNET_NO == stats_worked)
1278 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1279 "Failed to obtain value from statistics service, recomputing it\n");
1280 plugin->api->estimate_size (plugin->api->cls, &payload);
1281 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1282 _ ("New payload: %lld\n"),
1283 (long long) payload);
1286 if (GNUNET_YES == refresh_bf)
1288 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1289 _ ("Rebuilding bloomfilter. Please be patient.\n"));
1290 if (NULL != plugin->api->get_keys)
1292 plugin->api->get_keys (plugin->api->cls, &add_key_to_bloomfilter, filter);
1297 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1299 "Plugin does not support get_keys function. Please fix!\n"));
1307 * Fetching stats took to long, run without.
1312 stat_timeout (void *cls)
1314 stat_timeout_task = NULL;
1315 GNUNET_STATISTICS_get_cancel (stat_get);
1316 process_stat_done (NULL, GNUNET_NO);
1321 * Task run during shutdown.
1324 cleaning_task (void *cls)
1326 cleaning_done = GNUNET_YES;
1327 if (NULL != expired_kill_task)
1329 GNUNET_SCHEDULER_cancel (expired_kill_task);
1330 expired_kill_task = NULL;
1332 if (GNUNET_YES == do_drop)
1334 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Dropping database!\n");
1335 plugin->api->drop (plugin->api->cls);
1341 unload_plugin (plugin);
1346 GNUNET_CONTAINER_bloomfilter_free (filter);
1349 if (NULL != stat_get)
1351 GNUNET_STATISTICS_get_cancel (stat_get);
1354 if (NULL != stat_timeout_task)
1356 GNUNET_SCHEDULER_cancel (stat_timeout_task);
1357 stat_timeout_task = NULL;
1359 GNUNET_free_non_null (plugin_name);
1365 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1368 GNUNET_free (quota_stat_name);
1369 quota_stat_name = NULL;
1374 * Add a client to our list of active clients.
1377 * @param client client to add
1378 * @param mq message queue for @a client
1382 client_connect_cb (void *cls,
1383 struct GNUNET_SERVICE_Client *client,
1384 struct GNUNET_MQ_Handle *mq)
1391 * Called whenever a client is disconnected.
1392 * Frees our resources associated with that client.
1394 * @param cls closure
1395 * @param client identification of the client
1396 * @param app_ctx must match @a client
1399 client_disconnect_cb (void *cls,
1400 struct GNUNET_SERVICE_Client *client,
1403 struct ReservationList *pos;
1404 struct ReservationList *prev;
1405 struct ReservationList *next;
1407 GNUNET_assert (app_ctx == client);
1413 if (pos->client == client)
1416 reservations = next;
1419 reserved -= pos->amount + pos->entries * GNUNET_DATASTORE_ENTRY_OVERHEAD;
1428 GNUNET_STATISTICS_set (stats,
1429 gettext_noop ("# reserved"),
1436 * Process datastore requests.
1438 * @param cls closure
1439 * @param serv the initialized service
1440 * @param c configuration to use
1444 const struct GNUNET_CONFIGURATION_Handle *c,
1445 struct GNUNET_SERVICE_Handle *serv)
1449 unsigned int bf_size;
1453 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg,
1458 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
1463 GNUNET_asprintf ("a_stat_name,
1464 _ ("# bytes used in file-sharing datastore `%s'"),
1467 GNUNET_CONFIGURATION_get_value_size (cfg, "DATASTORE", "QUOTA", "a))
1469 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "QUOTA", "DATASTORE");
1472 stats = GNUNET_STATISTICS_create ("datastore", cfg);
1473 GNUNET_STATISTICS_set (stats, gettext_noop ("# quota"), quota, GNUNET_NO);
1474 cache_size = quota / 8; /* Or should we make this an option? */
1475 GNUNET_STATISTICS_set (stats,
1476 gettext_noop ("# cache size"),
1479 if (quota / (32 * 1024LL) > MAX_BF_SIZE)
1480 bf_size = MAX_BF_SIZE;
1483 quota / (32 * 1024LL); /* 8 bit per entry, 1 bit per 32 kb in DB */
1485 if ((GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (cfg,
1489 (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn)))
1491 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1492 _ ("Could not use specified filename `%s' for bloomfilter.\n"),
1493 NULL != fn ? fn : "");
1494 GNUNET_free_non_null (fn);
1499 GNUNET_asprintf (&pfn, "%s.%s", fn, plugin_name);
1500 if (GNUNET_YES == GNUNET_DISK_file_test (pfn))
1503 GNUNET_CONTAINER_bloomfilter_load (pfn,
1505 5); /* approx. 3% false positives at max use */
1508 /* file exists but not valid, remove and try again, but refresh */
1509 if (0 != unlink (pfn))
1511 /* failed to remove, run without file */
1512 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1513 _ ("Failed to remove bogus bloomfilter file `%s'\n"),
1517 filter = GNUNET_CONTAINER_bloomfilter_load (
1520 5); /* approx. 3% false positives at max use */
1521 refresh_bf = GNUNET_YES;
1525 /* try again after remove */
1526 filter = GNUNET_CONTAINER_bloomfilter_load (
1529 5); /* approx. 3% false positives at max use */
1530 refresh_bf = GNUNET_YES;
1533 /* failed yet again, give up on using file */
1534 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1535 _ ("Failed to remove bogus bloomfilter file `%s'\n"),
1539 filter = GNUNET_CONTAINER_bloomfilter_init (
1542 5); /* approx. 3% false positives at max use */
1548 /* normal case: have an existing valid bf file, no need to refresh */
1549 refresh_bf = GNUNET_NO;
1555 GNUNET_CONTAINER_bloomfilter_load (pfn,
1557 5); /* approx. 3% false positives at max use */
1558 refresh_bf = GNUNET_YES;
1565 GNUNET_CONTAINER_bloomfilter_init (NULL,
1567 5); /* approx. 3% false positives at max use */
1568 refresh_bf = GNUNET_YES;
1570 GNUNET_free_non_null (fn);
1573 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1574 _ ("Failed to initialize bloomfilter.\n"));
1577 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1582 GNUNET_SERVICE_suspend (service);
1583 stat_get = GNUNET_STATISTICS_get (stats,
1589 if (NULL == stat_get)
1590 process_stat_done (NULL, GNUNET_SYSERR);
1592 stat_timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
1595 GNUNET_SCHEDULER_add_shutdown (&cleaning_task, NULL);
1600 * Define "main" method using service macro.
1602 GNUNET_SERVICE_MAIN (
1604 GNUNET_SERVICE_OPTION_NONE,
1607 &client_disconnect_cb,
1609 GNUNET_MQ_hd_fixed_size (reserve,
1610 GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE,
1611 struct ReserveMessage,
1613 GNUNET_MQ_hd_fixed_size (release_reserve,
1614 GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE,
1615 struct ReleaseReserveMessage,
1617 GNUNET_MQ_hd_var_size (put,
1618 GNUNET_MESSAGE_TYPE_DATASTORE_PUT,
1621 GNUNET_MQ_hd_fixed_size (get,
1622 GNUNET_MESSAGE_TYPE_DATASTORE_GET,
1625 GNUNET_MQ_hd_fixed_size (get_key,
1626 GNUNET_MESSAGE_TYPE_DATASTORE_GET_KEY,
1627 struct GetKeyMessage,
1629 GNUNET_MQ_hd_fixed_size (get_replication,
1630 GNUNET_MESSAGE_TYPE_DATASTORE_GET_REPLICATION,
1631 struct GNUNET_MessageHeader,
1633 GNUNET_MQ_hd_fixed_size (get_zero_anonymity,
1634 GNUNET_MESSAGE_TYPE_DATASTORE_GET_ZERO_ANONYMITY,
1635 struct GetZeroAnonymityMessage,
1637 GNUNET_MQ_hd_var_size (remove,
1638 GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE,
1641 GNUNET_MQ_hd_fixed_size (drop,
1642 GNUNET_MESSAGE_TYPE_DATASTORE_DROP,
1643 struct GNUNET_MessageHeader,
1645 GNUNET_MQ_handler_end ());
1648 /* end of gnunet-service-datastore.c */