2 This file is part of GNUnet
3 Copyright (C) 2004-2014 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
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 * How long are we at most keeping "expired" content
41 * past the expiration date in the database?
43 #define MAX_EXPIRE_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
46 * How fast are we allowed to query the database for deleting
47 * expired content? (1 item per second).
49 #define MIN_EXPIRE_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
52 * Name under which we store current space consumption.
54 static char *quota_stat_name;
57 * After how many payload-changing operations
58 * do we sync our statistics?
60 #define MAX_STAT_SYNC_LAG 50
64 * Our datastore plugin.
66 struct DatastorePlugin
70 * API of the transport as returned by the plugin's
71 * initialization function.
73 struct GNUNET_DATASTORE_PluginFunctions *api;
76 * Short name for the plugin (i.e. "sqlite").
81 * Name of the library (i.e. "gnunet_plugin_datastore_sqlite").
86 * Environment this transport service is using
89 struct GNUNET_DATASTORE_PluginEnvironment env;
95 * Linked list of active reservations.
97 struct ReservationList
101 * This is a linked list.
103 struct ReservationList *next;
106 * Client that made the reservation.
108 struct GNUNET_SERVER_Client *client;
111 * Number of bytes (still) reserved.
116 * Number of items (still) reserved.
121 * Reservation identifier.
130 * Our datastore plugin (NULL if not available).
132 static struct DatastorePlugin *plugin;
135 * Linked list of space reservations made by clients.
137 static struct ReservationList *reservations;
140 * Bloomfilter to quickly tell if we don't have the content.
142 static struct GNUNET_CONTAINER_BloomFilter *filter;
145 * Name of our plugin.
147 static char *plugin_name;
152 static const struct GNUNET_CONFIGURATION_Handle *cfg;
155 * Handle for reporting statistics.
157 static struct GNUNET_STATISTICS_Handle *stats;
160 * How much space are we using for the cache? (space available for
161 * insertions that will be instantly reclaimed by discarding less
162 * important content --- or possibly whatever we just inserted into
165 static unsigned long long cache_size;
168 * How much space have we currently reserved?
170 static unsigned long long reserved;
173 * How much data are we currently storing
176 static unsigned long long payload;
179 * Identity of the task that is used to delete
182 static struct GNUNET_SCHEDULER_Task * expired_kill_task;
185 * Minimum time that content should have to not be discarded instantly
186 * (time stamp of any content that we've been discarding recently to
187 * stay below the quota). FOREVER if we had to expire content with
190 static struct GNUNET_TIME_Absolute min_expiration;
193 * How much space are we allowed to use?
195 static unsigned long long quota;
198 * Should the database be dropped on exit?
203 * Should we refresh the BF when the DB is loaded?
205 static int refresh_bf;
208 * Number of updates that were made to the
209 * payload value since we last synchronized
210 * it with the statistics service.
212 static unsigned int last_sync;
215 * Did we get an answer from statistics?
217 static int stats_worked;
221 * Synchronize our utilization statistics with the
222 * statistics service.
227 GNUNET_STATISTICS_set (stats, quota_stat_name, payload, GNUNET_YES);
228 GNUNET_STATISTICS_set (stats, "# utilization by current datastore", payload, GNUNET_NO);
234 * Context for transmitting replies to clients.
236 struct TransmitCallbackContext
240 * We keep these in a doubly-linked list (for cleanup).
242 struct TransmitCallbackContext *next;
245 * We keep these in a doubly-linked list (for cleanup).
247 struct TransmitCallbackContext *prev;
250 * The message that we're asked to transmit.
252 struct GNUNET_MessageHeader *msg;
255 * Handle for the transmission request.
257 struct GNUNET_SERVER_TransmitHandle *th;
260 * Client that we are transmitting to.
262 struct GNUNET_SERVER_Client *client;
268 * Head of the doubly-linked list (for cleanup).
270 static struct TransmitCallbackContext *tcc_head;
273 * Tail of the doubly-linked list (for cleanup).
275 static struct TransmitCallbackContext *tcc_tail;
278 * Have we already cleaned up the TCCs and are hence no longer
279 * willing (or able) to transmit anything to anyone?
281 static int cleaning_done;
284 * Handle for pending get request.
286 static struct GNUNET_STATISTICS_GetHandle *stat_get;
289 * Handle to our server.
291 static struct GNUNET_SERVER_Handle *server;
294 * Task that is used to remove expired entries from
295 * the datastore. This task will schedule itself
296 * again automatically to always delete all expired
299 * @param cls not used
300 * @param tc task context
303 delete_expired (void *cls,
304 const struct GNUNET_SCHEDULER_TaskContext *tc);
308 * Iterate over the expired items stored in the datastore.
309 * Delete all expired items; once we have processed all
310 * expired items, re-schedule the "delete_expired" task.
312 * @param cls not used
313 * @param key key for the content
314 * @param size number of bytes in data
315 * @param data content stored
316 * @param type type of the content
317 * @param priority priority of the content
318 * @param anonymity anonymity-level for the content
319 * @param expiration expiration time for the content
320 * @param uid unique identifier for the datum;
321 * maybe 0 if no unique identifier is available
323 * @return #GNUNET_SYSERR to abort the iteration, #GNUNET_OK to continue
324 * (continue on call to "next", of course),
325 * #GNUNET_NO to delete the item and continue (if supported)
328 expired_processor (void *cls,
329 const struct GNUNET_HashCode *key,
332 enum GNUNET_BLOCK_Type type,
335 struct GNUNET_TIME_Absolute expiration,
338 struct GNUNET_TIME_Absolute now;
343 GNUNET_SCHEDULER_add_delayed_with_priority (MAX_EXPIRE_DELAY,
344 GNUNET_SCHEDULER_PRIORITY_IDLE,
345 &delete_expired, NULL);
346 return GNUNET_SYSERR;
348 now = GNUNET_TIME_absolute_get ();
349 if (expiration.abs_value_us > now.abs_value_us)
351 /* finished processing */
353 GNUNET_SCHEDULER_add_delayed_with_priority (MAX_EXPIRE_DELAY,
354 GNUNET_SCHEDULER_PRIORITY_IDLE,
355 &delete_expired, NULL);
356 return GNUNET_SYSERR;
358 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
359 "Deleting content `%s' of type %u that expired %s ago\n",
360 GNUNET_h2s (key), type,
361 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_difference (expiration,
364 min_expiration = now;
365 GNUNET_STATISTICS_update (stats, gettext_noop ("# bytes expired"), size,
367 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
369 GNUNET_SCHEDULER_add_delayed_with_priority (MIN_EXPIRE_DELAY,
370 GNUNET_SCHEDULER_PRIORITY_IDLE,
371 &delete_expired, NULL);
377 * Task that is used to remove expired entries from
378 * the datastore. This task will schedule itself
379 * again automatically to always delete all expired
382 * @param cls not used
383 * @param tc task context
386 delete_expired (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
388 expired_kill_task = NULL;
389 plugin->api->get_expiration (plugin->api->cls, &expired_processor, NULL);
394 * An iterator over a set of items stored in the datastore
395 * that deletes until we're happy with respect to our quota.
398 * @param key key for the content
399 * @param size number of bytes in data
400 * @param data content stored
401 * @param type type of the content
402 * @param priority priority of the content
403 * @param anonymity anonymity-level for the content
404 * @param expiration expiration time for the content
405 * @param uid unique identifier for the datum;
406 * maybe 0 if no unique identifier is available
408 * @return GNUNET_SYSERR to abort the iteration, GNUNET_OK to continue
409 * (continue on call to "next", of course),
410 * GNUNET_NO to delete the item and continue (if supported)
413 quota_processor (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
414 const void *data, enum GNUNET_BLOCK_Type type,
415 uint32_t priority, uint32_t anonymity,
416 struct GNUNET_TIME_Absolute expiration, uint64_t uid)
418 unsigned long long *need = cls;
421 return GNUNET_SYSERR;
422 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
423 "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",
424 (unsigned long long) (size + GNUNET_DATASTORE_ENTRY_OVERHEAD),
425 (unsigned int) priority,
426 GNUNET_h2s (key), type,
427 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (expiration),
430 if (size + GNUNET_DATASTORE_ENTRY_OVERHEAD > *need)
433 *need -= size + GNUNET_DATASTORE_ENTRY_OVERHEAD;
435 min_expiration = GNUNET_TIME_UNIT_FOREVER_ABS;
437 min_expiration = expiration;
438 GNUNET_STATISTICS_update (stats,
439 gettext_noop ("# bytes purged (low-priority)"),
441 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
447 * Manage available disk space by running tasks
448 * that will discard content if necessary. This
449 * function will be run whenever a request for
450 * "need" bytes of storage could only be satisfied
451 * by eating into the "cache" (and we want our cache
454 * @param need number of bytes of content that were
455 * placed into the "cache" (and hence the
456 * number of bytes that should be removed).
459 manage_space (unsigned long long need)
461 unsigned long long last;
463 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
464 "Asked to free up %llu bytes of cache space\n", need);
466 while ((need > 0) && (last != need))
469 plugin->api->get_expiration (plugin->api->cls, "a_processor, &need);
475 * Function called to notify a client about the socket
476 * begin ready to queue more data. "buf" will be
477 * NULL and "size" zero if the socket was closed for
478 * writing in the meantime.
481 * @param size number of bytes available in buf
482 * @param buf where the callee should write the message
483 * @return number of bytes written to buf
486 transmit_callback (void *cls, size_t size, void *buf)
488 struct TransmitCallbackContext *tcc = cls;
492 GNUNET_CONTAINER_DLL_remove (tcc_head, tcc_tail, tcc);
493 msize = ntohs (tcc->msg->size);
496 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
497 _("Transmission to client failed!\n"));
498 GNUNET_SERVER_receive_done (tcc->client, GNUNET_SYSERR);
499 GNUNET_SERVER_client_drop (tcc->client);
500 GNUNET_free (tcc->msg);
504 GNUNET_assert (size >= msize);
505 memcpy (buf, tcc->msg, msize);
506 GNUNET_SERVER_receive_done (tcc->client, GNUNET_OK);
507 GNUNET_SERVER_client_drop (tcc->client);
508 GNUNET_free (tcc->msg);
515 * Transmit the given message to the client.
517 * @param client target of the message
518 * @param msg message to transmit, will be freed!
521 transmit (struct GNUNET_SERVER_Client *client, struct GNUNET_MessageHeader *msg)
523 struct TransmitCallbackContext *tcc;
525 if (GNUNET_YES == cleaning_done)
527 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
528 _("Shutdown in progress, aborting transmission.\n"));
529 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
533 tcc = GNUNET_new (struct TransmitCallbackContext);
535 tcc->client = client;
538 GNUNET_SERVER_notify_transmit_ready (client, ntohs (msg->size),
539 GNUNET_TIME_UNIT_FOREVER_REL,
540 &transmit_callback, tcc)))
543 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
548 GNUNET_SERVER_client_keep (client);
549 GNUNET_CONTAINER_DLL_insert (tcc_head, tcc_tail, tcc);
554 * Transmit a status code to the client.
556 * @param client receiver of the response
557 * @param code status code
558 * @param msg optional error message (can be NULL)
561 transmit_status (struct GNUNET_SERVER_Client *client, int code, const char *msg)
563 struct StatusMessage *sm;
566 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
567 "Transmitting `%s' message with value %d and message `%s'\n",
568 "STATUS", code, msg != NULL ? msg : "(none)");
569 slen = (msg == NULL) ? 0 : strlen (msg) + 1;
570 sm = GNUNET_malloc (sizeof (struct StatusMessage) + slen);
571 sm->header.size = htons (sizeof (struct StatusMessage) + slen);
572 sm->header.type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_STATUS);
573 sm->status = htonl (code);
574 sm->min_expiration = GNUNET_TIME_absolute_hton (min_expiration);
576 memcpy (&sm[1], msg, slen);
577 transmit (client, &sm->header);
582 * Function that will transmit the given datastore entry
585 * @param cls closure, pointer to the client (of type GNUNET_SERVER_Client).
586 * @param key key for the content
587 * @param size number of bytes in data
588 * @param data content stored
589 * @param type type of the content
590 * @param priority priority of the content
591 * @param anonymity anonymity-level for the content
592 * @param expiration expiration time for the content
593 * @param uid unique identifier for the datum;
594 * maybe 0 if no unique identifier is available
596 * @return GNUNET_SYSERR to abort the iteration, GNUNET_OK to continue,
597 * GNUNET_NO to delete the item and continue (if supported)
600 transmit_item (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
601 const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
602 uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
605 struct GNUNET_SERVER_Client *client = cls;
606 struct GNUNET_MessageHeader *end;
607 struct DataMessage *dm;
611 /* transmit 'DATA_END' */
612 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting `%s' message\n",
614 end = GNUNET_new (struct GNUNET_MessageHeader);
615 end->size = htons (sizeof (struct GNUNET_MessageHeader));
616 end->type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END);
617 transmit (client, end);
618 GNUNET_SERVER_client_drop (client);
621 GNUNET_assert (sizeof (struct DataMessage) + size <
622 GNUNET_SERVER_MAX_MESSAGE_SIZE);
623 dm = GNUNET_malloc (sizeof (struct DataMessage) + size);
624 dm->header.size = htons (sizeof (struct DataMessage) + size);
625 dm->header.type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_DATA);
627 dm->size = htonl (size);
628 dm->type = htonl (type);
629 dm->priority = htonl (priority);
630 dm->anonymity = htonl (anonymity);
631 dm->replication = htonl (0);
632 dm->reserved = htonl (0);
633 dm->expiration = GNUNET_TIME_absolute_hton (expiration);
634 dm->uid = GNUNET_htonll (uid);
636 memcpy (&dm[1], data, size);
637 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
638 "Transmitting `%s' message for `%s' of type %u with expiration %s (in: %s)\n",
639 "DATA", GNUNET_h2s (key), type,
640 GNUNET_STRINGS_absolute_time_to_string (expiration),
641 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (expiration),
643 GNUNET_STATISTICS_update (stats, gettext_noop ("# results found"), 1,
645 transmit (client, &dm->header);
646 GNUNET_SERVER_client_drop (client);
652 * Handle RESERVE-message.
655 * @param client identification of the client
656 * @param message the actual message
659 handle_reserve (void *cls, struct GNUNET_SERVER_Client *client,
660 const struct GNUNET_MessageHeader *message)
663 * Static counter to produce reservation identifiers.
665 static int reservation_gen;
667 const struct ReserveMessage *msg = (const struct ReserveMessage *) message;
668 struct ReservationList *e;
669 unsigned long long used;
670 unsigned long long req;
674 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n", "RESERVE");
675 amount = GNUNET_ntohll (msg->amount);
676 entries = ntohl (msg->entries);
677 used = payload + reserved;
679 amount + ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * entries;
680 if (used + req > quota)
683 used = quota; /* cheat a bit for error message (to avoid negative numbers) */
684 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
686 ("Insufficient space (%llu bytes are available) to satisfy `%s' request for %llu bytes\n"),
687 quota - used, "RESERVE", req);
688 if (cache_size < req)
690 /* TODO: document this in the FAQ; essentially, if this
691 * message happens, the insertion request could be blocked
692 * by less-important content from migration because it is
693 * larger than 1/8th of the overall available space, and
694 * we only reserve 1/8th for "fresh" insertions */
695 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
697 ("The requested amount (%llu bytes) is larger than the cache size (%llu bytes)\n"),
699 transmit_status (client, 0,
701 ("Insufficient space to satisfy request and "
702 "requested amount is larger than cache size"));
706 transmit_status (client, 0,
707 gettext_noop ("Insufficient space to satisfy request"));
712 GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
714 e = GNUNET_new (struct ReservationList);
715 e->next = reservations;
719 e->entries = entries;
720 e->rid = ++reservation_gen;
721 if (reservation_gen < 0)
722 reservation_gen = 0; /* wrap around */
723 transmit_status (client, e->rid, NULL);
728 * Handle RELEASE_RESERVE-message.
731 * @param client identification of the client
732 * @param message the actual message
735 handle_release_reserve (void *cls,
736 struct GNUNET_SERVER_Client *client,
737 const struct GNUNET_MessageHeader *message)
739 const struct ReleaseReserveMessage *msg =
740 (const struct ReleaseReserveMessage *) message;
741 struct ReservationList *pos;
742 struct ReservationList *prev;
743 struct ReservationList *next;
744 int rid = ntohl (msg->rid);
745 unsigned long long rem;
747 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
748 "Processing `%s' request\n",
752 while (NULL != (pos = next))
763 ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * pos->entries;
764 GNUNET_assert (reserved >= rem);
766 GNUNET_STATISTICS_set (stats,
767 gettext_noop ("# reserved"), reserved,
769 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
770 "Returning %llu remaining reserved bytes to storage pool\n",
773 transmit_status (client, GNUNET_OK, NULL);
779 transmit_status (client, GNUNET_SYSERR,
780 gettext_noop ("Could not find matching reservation"));
785 * Check that the given message is a valid data message.
787 * @return NULL if the message is not well-formed, otherwise the message
789 static const struct DataMessage *
790 check_data (const struct GNUNET_MessageHeader *message)
794 const struct DataMessage *dm;
796 size = ntohs (message->size);
797 if (size < sizeof (struct DataMessage))
802 dm = (const struct DataMessage *) message;
803 dsize = ntohl (dm->size);
804 if (size != dsize + sizeof (struct DataMessage))
814 * Context for a PUT request used to see if the content is
820 * Client to notify on completion.
822 struct GNUNET_SERVER_Client *client;
824 #if ! HAVE_UNALIGNED_64_ACCESS
828 /* followed by the 'struct DataMessage' */
833 * Actually put the data message.
835 * @param client sender of the message
836 * @param dm message with the data to store
839 execute_put (struct GNUNET_SERVER_Client *client, const struct DataMessage *dm)
845 size = ntohl (dm->size);
848 plugin->api->put (plugin->api->cls, &dm->key, size, &dm[1],
849 ntohl (dm->type), ntohl (dm->priority),
850 ntohl (dm->anonymity), ntohl (dm->replication),
851 GNUNET_TIME_absolute_ntoh (dm->expiration), &msg);
852 if (GNUNET_OK == ret)
854 GNUNET_STATISTICS_update (stats,
855 gettext_noop ("# bytes stored"), size,
857 GNUNET_CONTAINER_bloomfilter_add (filter, &dm->key);
858 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
859 "Successfully stored %u bytes of type %u under key `%s'\n",
860 size, ntohl (dm->type), GNUNET_h2s (&dm->key));
862 transmit_status (client, ret, msg);
863 GNUNET_free_non_null (msg);
864 if (quota - reserved - cache_size < payload)
866 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
867 _("Need %llu bytes more space (%llu allowed, using %llu)\n"),
868 (unsigned long long) size + GNUNET_DATASTORE_ENTRY_OVERHEAD,
869 (unsigned long long) (quota - reserved - cache_size),
870 (unsigned long long) payload);
871 manage_space (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
877 * Function that will check if the given datastore entry
878 * matches the put and if none match executes the put.
880 * @param cls closure, pointer to the client (of type 'struct PutContext').
881 * @param key key for the content
882 * @param size number of bytes in data
883 * @param data content stored
884 * @param type type of the content
885 * @param priority priority of the content
886 * @param anonymity anonymity-level for the content
887 * @param expiration expiration time for the content
888 * @param uid unique identifier for the datum;
889 * maybe 0 if no unique identifier is available
891 * @return GNUNET_OK usually
892 * GNUNET_NO to delete the item
895 check_present (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
896 const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
897 uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
900 struct PutContext *pc = cls;
901 const struct DataMessage *dm;
903 dm = (const struct DataMessage *) &pc[1];
906 execute_put (pc->client, dm);
907 GNUNET_SERVER_client_drop (pc->client);
911 if ((GNUNET_BLOCK_TYPE_FS_DBLOCK == type) ||
912 (GNUNET_BLOCK_TYPE_FS_IBLOCK == type) || ((size == ntohl (dm->size)) &&
914 memcmp (&dm[1], data, size))))
916 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
917 "Result already present in datastore\n");
918 /* FIXME: change API to allow increasing 'replication' counter */
919 if ((ntohl (dm->priority) > 0) ||
920 (GNUNET_TIME_absolute_ntoh (dm->expiration).abs_value_us >
921 expiration.abs_value_us))
922 plugin->api->update (plugin->api->cls, uid,
923 (int32_t) ntohl (dm->priority),
924 GNUNET_TIME_absolute_ntoh (dm->expiration), NULL);
925 transmit_status (pc->client, GNUNET_NO, NULL);
926 GNUNET_SERVER_client_drop (pc->client);
931 execute_put (pc->client, dm);
932 GNUNET_SERVER_client_drop (pc->client);
940 * Handle PUT-message.
943 * @param client identification of the client
944 * @param message the actual message
947 handle_put (void *cls, struct GNUNET_SERVER_Client *client,
948 const struct GNUNET_MessageHeader *message)
950 const struct DataMessage *dm = check_data (message);
952 struct ReservationList *pos;
953 struct PutContext *pc;
954 struct GNUNET_HashCode vhash;
957 if ((dm == NULL) || (ntohl (dm->type) == 0))
960 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
963 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
964 "Processing `%s' request for `%s' of type %u\n", "PUT",
965 GNUNET_h2s (&dm->key), ntohl (dm->type));
966 rid = ntohl (dm->rid);
967 size = ntohl (dm->size);
971 while ((NULL != pos) && (rid != pos->rid))
973 GNUNET_break (pos != NULL);
976 GNUNET_break (pos->entries > 0);
977 GNUNET_break (pos->amount >= size);
980 reserved -= (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
981 GNUNET_STATISTICS_set (stats,
982 gettext_noop ("# reserved"), reserved,
986 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (filter, &dm->key))
988 GNUNET_CRYPTO_hash (&dm[1], size, &vhash);
989 pc = GNUNET_malloc (sizeof (struct PutContext) + size +
990 sizeof (struct DataMessage));
992 GNUNET_SERVER_client_keep (client);
993 memcpy (&pc[1], dm, size + sizeof (struct DataMessage));
994 plugin->api->get_key (plugin->api->cls, 0, &dm->key, &vhash,
995 ntohl (dm->type), &check_present, pc);
998 execute_put (client, dm);
1003 * Handle GET-message.
1005 * @param cls closure
1006 * @param client identification of the client
1007 * @param message the actual message
1010 handle_get (void *cls, struct GNUNET_SERVER_Client *client,
1011 const struct GNUNET_MessageHeader *message)
1013 const struct GetMessage *msg;
1016 size = ntohs (message->size);
1017 if ((size != sizeof (struct GetMessage)) &&
1018 (size != sizeof (struct GetMessage) - sizeof (struct GNUNET_HashCode)))
1021 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1024 msg = (const struct GetMessage *) message;
1025 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1026 "Processing `%s' request for `%s' of type %u\n", "GET",
1027 GNUNET_h2s (&msg->key), ntohl (msg->type));
1028 GNUNET_STATISTICS_update (stats,
1029 gettext_noop ("# GET requests received"), 1,
1031 GNUNET_SERVER_client_keep (client);
1032 if ((size == sizeof (struct GetMessage)) &&
1033 (GNUNET_YES != GNUNET_CONTAINER_bloomfilter_test (filter, &msg->key)))
1035 /* don't bother database... */
1036 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1037 "Empty result set for `%s' request for `%s' (bloomfilter).\n",
1038 "GET", GNUNET_h2s (&msg->key));
1039 GNUNET_STATISTICS_update (stats,
1041 ("# requests filtered by bloomfilter"), 1,
1043 transmit_item (client, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS,
1047 plugin->api->get_key (plugin->api->cls, GNUNET_ntohll (msg->offset),
1049 sizeof (struct GetMessage)) ? &msg->key : NULL), NULL,
1050 ntohl (msg->type), &transmit_item, client);
1055 * Handle UPDATE-message.
1057 * @param cls closure
1058 * @param client identification of the client
1059 * @param message the actual message
1062 handle_update (void *cls, struct GNUNET_SERVER_Client *client,
1063 const struct GNUNET_MessageHeader *message)
1065 const struct UpdateMessage *msg;
1069 GNUNET_STATISTICS_update (stats, gettext_noop ("# UPDATE requests received"),
1071 msg = (const struct UpdateMessage *) message;
1073 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request for %llu\n",
1074 "UPDATE", (unsigned long long) GNUNET_ntohll (msg->uid));
1076 plugin->api->update (plugin->api->cls, GNUNET_ntohll (msg->uid),
1077 (int32_t) ntohl (msg->priority),
1078 GNUNET_TIME_absolute_ntoh (msg->expiration), &emsg);
1079 transmit_status (client, ret, emsg);
1080 GNUNET_free_non_null (emsg);
1085 * Handle GET_REPLICATION-message.
1087 * @param cls closure
1088 * @param client identification of the client
1089 * @param message the actual message
1092 handle_get_replication (void *cls, struct GNUNET_SERVER_Client *client,
1093 const struct GNUNET_MessageHeader *message)
1095 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n",
1097 GNUNET_STATISTICS_update (stats,
1099 ("# GET REPLICATION requests received"), 1,
1101 GNUNET_SERVER_client_keep (client);
1102 plugin->api->get_replication (plugin->api->cls, &transmit_item, client);
1107 * Handle GET_ZERO_ANONYMITY-message.
1109 * @param cls closure
1110 * @param client identification of the client
1111 * @param message the actual message
1114 handle_get_zero_anonymity (void *cls, struct GNUNET_SERVER_Client *client,
1115 const struct GNUNET_MessageHeader *message)
1117 const struct GetZeroAnonymityMessage *msg =
1118 (const struct GetZeroAnonymityMessage *) message;
1119 enum GNUNET_BLOCK_Type type;
1121 type = (enum GNUNET_BLOCK_Type) ntohl (msg->type);
1122 if (type == GNUNET_BLOCK_TYPE_ANY)
1125 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1128 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n",
1129 "GET_ZERO_ANONYMITY");
1130 GNUNET_STATISTICS_update (stats,
1132 ("# GET ZERO ANONYMITY requests received"), 1,
1134 GNUNET_SERVER_client_keep (client);
1135 plugin->api->get_zero_anonymity (plugin->api->cls,
1136 GNUNET_ntohll (msg->offset), type,
1137 &transmit_item, client);
1142 * Callback function that will cause the item that is passed
1143 * in to be deleted (by returning GNUNET_NO).
1146 remove_callback (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
1147 const void *data, enum GNUNET_BLOCK_Type type,
1148 uint32_t priority, uint32_t anonymity,
1149 struct GNUNET_TIME_Absolute expiration, uint64_t uid)
1151 struct GNUNET_SERVER_Client *client = cls;
1155 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1156 "No further matches for `%s' request.\n", "REMOVE");
1157 transmit_status (client, GNUNET_NO, _("Content not found"));
1158 GNUNET_SERVER_client_drop (client);
1159 return GNUNET_OK; /* last item */
1161 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1162 "Item %llu matches `%s' request for key `%s' and type %u.\n",
1163 (unsigned long long) uid, "REMOVE", GNUNET_h2s (key), type);
1164 GNUNET_STATISTICS_update (stats,
1165 gettext_noop ("# bytes removed (explicit request)"),
1167 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
1168 transmit_status (client, GNUNET_OK, NULL);
1169 GNUNET_SERVER_client_drop (client);
1175 * Handle REMOVE-message.
1177 * @param cls closure
1178 * @param client identification of the client
1179 * @param message the actual message
1182 handle_remove (void *cls, struct GNUNET_SERVER_Client *client,
1183 const struct GNUNET_MessageHeader *message)
1185 const struct DataMessage *dm = check_data (message);
1186 struct GNUNET_HashCode vhash;
1191 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1194 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1195 "Processing `%s' request for `%s' of type %u\n", "REMOVE",
1196 GNUNET_h2s (&dm->key), ntohl (dm->type));
1197 GNUNET_STATISTICS_update (stats, gettext_noop ("# REMOVE requests received"),
1199 GNUNET_SERVER_client_keep (client);
1200 GNUNET_CRYPTO_hash (&dm[1], ntohl (dm->size), &vhash);
1201 plugin->api->get_key (plugin->api->cls, 0, &dm->key, &vhash,
1202 (enum GNUNET_BLOCK_Type) ntohl (dm->type),
1203 &remove_callback, client);
1208 * Handle DROP-message.
1210 * @param cls closure
1211 * @param client identification of the client
1212 * @param message the actual message
1215 handle_drop (void *cls, struct GNUNET_SERVER_Client *client,
1216 const struct GNUNET_MessageHeader *message)
1218 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1219 "Processing `%s' request\n",
1221 do_drop = GNUNET_YES;
1222 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1227 * Function called by plugins to notify us about a
1228 * change in their disk utilization.
1230 * @param cls closure (NULL)
1231 * @param delta change in disk utilization,
1232 * 0 for "reset to empty"
1235 disk_utilization_change_cb (void *cls,
1238 if ((delta < 0) && (payload < -delta))
1240 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1241 _("Datastore payload must have been inaccurate (%lld < %lld). Recomputing it.\n"),
1242 (long long) payload,
1243 (long long) -delta);
1244 plugin->api->estimate_size (plugin->api->cls, &payload);
1245 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1246 _("New payload: %lld\n"),
1247 (long long) payload);
1253 if (last_sync >= MAX_STAT_SYNC_LAG)
1259 * Callback function to process statistic values.
1261 * @param cls closure (struct Plugin*)
1262 * @param subsystem name of subsystem that created the statistic
1263 * @param name the name of the datum
1264 * @param value the current value
1265 * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
1266 * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
1269 process_stat_in (void *cls,
1270 const char *subsystem,
1275 GNUNET_assert (GNUNET_NO == stats_worked);
1276 stats_worked = GNUNET_YES;
1278 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1279 "Notification from statistics about existing payload (%llu), new payload is %llu\n",
1286 * Load the datastore plugin.
1288 static struct DatastorePlugin *
1291 struct DatastorePlugin *ret;
1294 ret = GNUNET_new (struct DatastorePlugin);
1296 ret->env.duc = &disk_utilization_change_cb;
1297 ret->env.cls = NULL;
1298 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1299 _("Loading `%s' datastore plugin\n"),
1301 GNUNET_asprintf (&libname,
1302 "libgnunet_plugin_datastore_%s",
1304 ret->short_name = GNUNET_strdup (plugin_name);
1305 ret->lib_name = libname;
1306 ret->api = GNUNET_PLUGIN_load (libname, &ret->env);
1307 if (NULL == ret->api)
1309 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1310 _("Failed to load datastore plugin for `%s'\n"),
1312 GNUNET_free (ret->short_name);
1313 GNUNET_free (libname);
1322 * Function called when the service shuts
1323 * down. Unloads our datastore plugin.
1325 * @param plug plugin to unload
1328 unload_plugin (struct DatastorePlugin *plug)
1330 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1331 "Datastore service is unloading plugin...\n");
1332 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
1333 GNUNET_free (plug->lib_name);
1334 GNUNET_free (plug->short_name);
1340 * Adds a given @a key to the bloomfilter in @a cls @a count times.
1342 * @param cls the bloomfilter
1343 * @param key key to add
1344 * @param count number of times to add key
1347 add_key_to_bloomfilter (void *cls,
1348 const struct GNUNET_HashCode *key,
1351 struct GNUNET_CONTAINER_BloomFilter *bf = cls;
1354 GNUNET_CONTAINER_bloomfilter_add (bf, key);
1359 * We finished receiving the statistic. Initialize the plugin; if
1360 * loading the statistic failed, run the estimator.
1363 * @param success #GNUNET_NO if we failed to read the stat
1366 process_stat_done (void *cls, int success)
1368 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1369 {&handle_reserve, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE,
1370 sizeof (struct ReserveMessage)},
1371 {&handle_release_reserve, NULL,
1372 GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE,
1373 sizeof (struct ReleaseReserveMessage)},
1374 {&handle_put, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_PUT, 0},
1375 {&handle_update, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE,
1376 sizeof (struct UpdateMessage)},
1377 {&handle_get, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_GET, 0},
1378 {&handle_get_replication, NULL,
1379 GNUNET_MESSAGE_TYPE_DATASTORE_GET_REPLICATION,
1380 sizeof (struct GNUNET_MessageHeader)},
1381 {&handle_get_zero_anonymity, NULL,
1382 GNUNET_MESSAGE_TYPE_DATASTORE_GET_ZERO_ANONYMITY,
1383 sizeof (struct GetZeroAnonymityMessage)},
1384 {&handle_remove, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE, 0},
1385 {&handle_drop, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_DROP,
1386 sizeof (struct GNUNET_MessageHeader)},
1391 plugin = load_plugin ();
1394 GNUNET_CONTAINER_bloomfilter_free (filter);
1398 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1403 if (GNUNET_NO == stats_worked)
1405 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1406 "Failed to obtain value from statistics service, recomputing it\n");
1407 plugin->api->estimate_size (plugin->api->cls, &payload);
1409 if (GNUNET_YES == refresh_bf)
1411 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1412 _("Rebuilding bloomfilter. Please be patient.\n"));
1413 if (NULL != plugin->api->get_keys)
1414 plugin->api->get_keys (plugin->api->cls,
1415 &add_key_to_bloomfilter,
1418 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1419 _("Plugin does not support get_keys function. Please fix!\n"));
1421 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1422 _("Bloomfilter construction complete.\n"));
1425 GNUNET_SERVER_add_handlers (server, handlers);
1426 GNUNET_SERVER_resume (server);
1428 = GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1435 * Task run during shutdown.
1438 cleaning_task (void *cls,
1439 const struct GNUNET_SCHEDULER_TaskContext *tc)
1441 struct TransmitCallbackContext *tcc;
1443 cleaning_done = GNUNET_YES;
1444 while (NULL != (tcc = tcc_head))
1446 GNUNET_CONTAINER_DLL_remove (tcc_head, tcc_tail, tcc);
1447 if (tcc->th != NULL)
1449 GNUNET_SERVER_notify_transmit_ready_cancel (tcc->th);
1450 GNUNET_SERVER_client_drop (tcc->client);
1452 GNUNET_free (tcc->msg);
1455 if (NULL != expired_kill_task)
1457 GNUNET_SCHEDULER_cancel (expired_kill_task);
1458 expired_kill_task = NULL;
1460 if (GNUNET_YES == do_drop)
1461 plugin->api->drop (plugin->api->cls);
1462 unload_plugin (plugin);
1466 GNUNET_CONTAINER_bloomfilter_free (filter);
1469 if (NULL != stat_get)
1471 GNUNET_STATISTICS_get_cancel (stat_get);
1474 GNUNET_free_non_null (plugin_name);
1480 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1483 GNUNET_free (quota_stat_name);
1484 quota_stat_name = NULL;
1489 * Function that removes all active reservations made
1490 * by the given client and releases the space for other
1493 * @param cls closure
1494 * @param client identification of the client
1497 cleanup_reservations (void *cls,
1498 struct GNUNET_SERVER_Client *client)
1500 struct ReservationList *pos;
1501 struct ReservationList *prev;
1502 struct ReservationList *next;
1511 if (pos->client == client)
1514 reservations = next;
1517 reserved -= pos->amount + pos->entries * GNUNET_DATASTORE_ENTRY_OVERHEAD;
1526 GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
1532 * Process datastore requests.
1534 * @param cls closure
1535 * @param serv the initialized server
1536 * @param c configuration to use
1540 struct GNUNET_SERVER_Handle *serv,
1541 const struct GNUNET_CONFIGURATION_Handle *c)
1545 unsigned int bf_size;
1550 GNUNET_CONFIGURATION_get_value_string (cfg, "DATASTORE", "DATABASE",
1553 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1554 _("No `%s' specified for `%s' in configuration!\n"), "DATABASE",
1558 GNUNET_asprintf ("a_stat_name,
1559 _("# bytes used in file-sharing datastore `%s'"),
1562 GNUNET_CONFIGURATION_get_value_size (cfg, "DATASTORE", "QUOTA", "a))
1564 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1565 _("No `%s' specified for `%s' in configuration!\n"), "QUOTA",
1569 stats = GNUNET_STATISTICS_create ("datastore", cfg);
1570 GNUNET_STATISTICS_set (stats, gettext_noop ("# quota"), quota, GNUNET_NO);
1571 cache_size = quota / 8; /* Or should we make this an option? */
1572 GNUNET_STATISTICS_set (stats, gettext_noop ("# cache size"), cache_size,
1574 if (quota / (32 * 1024LL) > (1 << 31))
1575 bf_size = (1 << 31); /* absolute limit: ~2 GB, beyond that BF just won't help anyway */
1577 bf_size = quota / (32 * 1024LL); /* 8 bit per entry, 1 bit per 32 kb in DB */
1580 GNUNET_CONFIGURATION_get_value_filename (cfg, "DATASTORE", "BLOOMFILTER",
1582 (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn)))
1584 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1585 _("Could not use specified filename `%s' for bloomfilter.\n"),
1586 NULL != fn ? fn : "");
1587 GNUNET_free_non_null (fn);
1592 GNUNET_asprintf (&pfn, "%s.%s", fn, plugin_name);
1593 if (GNUNET_YES == GNUNET_DISK_file_test (pfn))
1595 filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5); /* approx. 3% false positives at max use */
1598 /* file exists but not valid, remove and try again, but refresh */
1599 if (0 != UNLINK (pfn))
1601 /* failed to remove, run without file */
1602 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1603 _("Failed to remove bogus bloomfilter file `%s'\n"),
1607 filter = GNUNET_CONTAINER_bloomfilter_load (NULL, bf_size, 5); /* approx. 3% false positives at max use */
1608 refresh_bf = GNUNET_YES;
1612 /* try again after remove */
1613 filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5); /* approx. 3% false positives at max use */
1614 refresh_bf = GNUNET_YES;
1617 /* failed yet again, give up on using file */
1618 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1619 _("Failed to remove bogus bloomfilter file `%s'\n"),
1623 filter = GNUNET_CONTAINER_bloomfilter_init (NULL, bf_size, 5); /* approx. 3% false positives at max use */
1629 /* normal case: have an existing valid bf file, no need to refresh */
1630 refresh_bf = GNUNET_NO;
1635 filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5); /* approx. 3% false positives at max use */
1636 refresh_bf = GNUNET_YES;
1642 filter = GNUNET_CONTAINER_bloomfilter_init (NULL, bf_size, 5); /* approx. 3% false positives at max use */
1643 refresh_bf = GNUNET_YES;
1645 GNUNET_free_non_null (fn);
1648 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1649 _("Failed to initialize bloomfilter.\n"));
1652 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1657 GNUNET_SERVER_suspend (server);
1659 GNUNET_STATISTICS_get (stats,
1662 GNUNET_TIME_UNIT_SECONDS,
1666 if (NULL == stat_get)
1667 process_stat_done (NULL, GNUNET_SYSERR);
1668 GNUNET_SERVER_disconnect_notify (server,
1669 &cleanup_reservations,
1671 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1678 * The main function for the datastore service.
1680 * @param argc number of arguments from the command line
1681 * @param argv command line arguments
1682 * @return 0 ok, 1 on error
1692 GNUNET_SERVICE_run (argc, argv, "datastore",
1693 GNUNET_SERVICE_OPTION_NONE,
1694 &run, NULL)) ? 0 : 1;
1699 /* end of gnunet-service-datastore.c */