2 This file is part of GNUnet
3 (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;
290 * Task that is used to remove expired entries from
291 * the datastore. This task will schedule itself
292 * again automatically to always delete all expired
295 * @param cls not used
296 * @param tc task context
299 delete_expired (void *cls,
300 const struct GNUNET_SCHEDULER_TaskContext *tc);
304 * Iterate over the expired items stored in the datastore.
305 * Delete all expired items; once we have processed all
306 * expired items, re-schedule the "delete_expired" task.
308 * @param cls not used
309 * @param key key for the content
310 * @param size number of bytes in data
311 * @param data content stored
312 * @param type type of the content
313 * @param priority priority of the content
314 * @param anonymity anonymity-level for the content
315 * @param expiration expiration time for the content
316 * @param uid unique identifier for the datum;
317 * maybe 0 if no unique identifier is available
319 * @return #GNUNET_SYSERR to abort the iteration, #GNUNET_OK to continue
320 * (continue on call to "next", of course),
321 * #GNUNET_NO to delete the item and continue (if supported)
324 expired_processor (void *cls,
325 const struct GNUNET_HashCode *key,
328 enum GNUNET_BLOCK_Type type,
331 struct GNUNET_TIME_Absolute expiration,
334 struct GNUNET_TIME_Absolute now;
339 GNUNET_SCHEDULER_add_delayed_with_priority (MAX_EXPIRE_DELAY,
340 GNUNET_SCHEDULER_PRIORITY_IDLE,
341 &delete_expired, NULL);
342 return GNUNET_SYSERR;
344 now = GNUNET_TIME_absolute_get ();
345 if (expiration.abs_value_us > now.abs_value_us)
347 /* finished processing */
349 GNUNET_SCHEDULER_add_delayed_with_priority (MAX_EXPIRE_DELAY,
350 GNUNET_SCHEDULER_PRIORITY_IDLE,
351 &delete_expired, NULL);
352 return GNUNET_SYSERR;
354 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
355 "Deleting content `%s' of type %u that expired %s ago\n",
356 GNUNET_h2s (key), type,
357 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_difference (expiration,
360 min_expiration = now;
361 GNUNET_STATISTICS_update (stats, gettext_noop ("# bytes expired"), size,
363 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
365 GNUNET_SCHEDULER_add_delayed_with_priority (MIN_EXPIRE_DELAY,
366 GNUNET_SCHEDULER_PRIORITY_IDLE,
367 &delete_expired, NULL);
373 * Task that is used to remove expired entries from
374 * the datastore. This task will schedule itself
375 * again automatically to always delete all expired
378 * @param cls not used
379 * @param tc task context
382 delete_expired (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
384 expired_kill_task = NULL;
385 plugin->api->get_expiration (plugin->api->cls, &expired_processor, NULL);
390 * An iterator over a set of items stored in the datastore
391 * that deletes until we're happy with respect to our quota.
394 * @param key key for the content
395 * @param size number of bytes in data
396 * @param data content stored
397 * @param type type of the content
398 * @param priority priority of the content
399 * @param anonymity anonymity-level for the content
400 * @param expiration expiration time for the content
401 * @param uid unique identifier for the datum;
402 * maybe 0 if no unique identifier is available
404 * @return GNUNET_SYSERR to abort the iteration, GNUNET_OK to continue
405 * (continue on call to "next", of course),
406 * GNUNET_NO to delete the item and continue (if supported)
409 quota_processor (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
410 const void *data, enum GNUNET_BLOCK_Type type,
411 uint32_t priority, uint32_t anonymity,
412 struct GNUNET_TIME_Absolute expiration, uint64_t uid)
414 unsigned long long *need = cls;
417 return GNUNET_SYSERR;
418 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
419 "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",
420 (unsigned long long) (size + GNUNET_DATASTORE_ENTRY_OVERHEAD),
421 (unsigned int) priority,
422 GNUNET_h2s (key), type,
423 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (expiration),
426 if (size + GNUNET_DATASTORE_ENTRY_OVERHEAD > *need)
429 *need -= size + GNUNET_DATASTORE_ENTRY_OVERHEAD;
431 min_expiration = GNUNET_TIME_UNIT_FOREVER_ABS;
433 min_expiration = expiration;
434 GNUNET_STATISTICS_update (stats,
435 gettext_noop ("# bytes purged (low-priority)"),
437 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
443 * Manage available disk space by running tasks
444 * that will discard content if necessary. This
445 * function will be run whenever a request for
446 * "need" bytes of storage could only be satisfied
447 * by eating into the "cache" (and we want our cache
450 * @param need number of bytes of content that were
451 * placed into the "cache" (and hence the
452 * number of bytes that should be removed).
455 manage_space (unsigned long long need)
457 unsigned long long last;
459 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
460 "Asked to free up %llu bytes of cache space\n", need);
462 while ((need > 0) && (last != need))
465 plugin->api->get_expiration (plugin->api->cls, "a_processor, &need);
471 * Function called to notify a client about the socket
472 * begin ready to queue more data. "buf" will be
473 * NULL and "size" zero if the socket was closed for
474 * writing in the meantime.
477 * @param size number of bytes available in buf
478 * @param buf where the callee should write the message
479 * @return number of bytes written to buf
482 transmit_callback (void *cls, size_t size, void *buf)
484 struct TransmitCallbackContext *tcc = cls;
488 GNUNET_CONTAINER_DLL_remove (tcc_head, tcc_tail, tcc);
489 msize = ntohs (tcc->msg->size);
492 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
493 _("Transmission to client failed!\n"));
494 GNUNET_SERVER_receive_done (tcc->client, GNUNET_SYSERR);
495 GNUNET_SERVER_client_drop (tcc->client);
496 GNUNET_free (tcc->msg);
500 GNUNET_assert (size >= msize);
501 memcpy (buf, tcc->msg, msize);
502 GNUNET_SERVER_receive_done (tcc->client, GNUNET_OK);
503 GNUNET_SERVER_client_drop (tcc->client);
504 GNUNET_free (tcc->msg);
511 * Transmit the given message to the client.
513 * @param client target of the message
514 * @param msg message to transmit, will be freed!
517 transmit (struct GNUNET_SERVER_Client *client, struct GNUNET_MessageHeader *msg)
519 struct TransmitCallbackContext *tcc;
521 if (GNUNET_YES == cleaning_done)
523 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
524 _("Shutdown in progress, aborting transmission.\n"));
525 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
529 tcc = GNUNET_new (struct TransmitCallbackContext);
531 tcc->client = client;
534 GNUNET_SERVER_notify_transmit_ready (client, ntohs (msg->size),
535 GNUNET_TIME_UNIT_FOREVER_REL,
536 &transmit_callback, tcc)))
539 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
544 GNUNET_SERVER_client_keep (client);
545 GNUNET_CONTAINER_DLL_insert (tcc_head, tcc_tail, tcc);
550 * Transmit a status code to the client.
552 * @param client receiver of the response
553 * @param code status code
554 * @param msg optional error message (can be NULL)
557 transmit_status (struct GNUNET_SERVER_Client *client, int code, const char *msg)
559 struct StatusMessage *sm;
562 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
563 "Transmitting `%s' message with value %d and message `%s'\n",
564 "STATUS", code, msg != NULL ? msg : "(none)");
565 slen = (msg == NULL) ? 0 : strlen (msg) + 1;
566 sm = GNUNET_malloc (sizeof (struct StatusMessage) + slen);
567 sm->header.size = htons (sizeof (struct StatusMessage) + slen);
568 sm->header.type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_STATUS);
569 sm->status = htonl (code);
570 sm->min_expiration = GNUNET_TIME_absolute_hton (min_expiration);
572 memcpy (&sm[1], msg, slen);
573 transmit (client, &sm->header);
578 * Function that will transmit the given datastore entry
581 * @param cls closure, pointer to the client (of type GNUNET_SERVER_Client).
582 * @param key key for the content
583 * @param size number of bytes in data
584 * @param data content stored
585 * @param type type of the content
586 * @param priority priority of the content
587 * @param anonymity anonymity-level for the content
588 * @param expiration expiration time for the content
589 * @param uid unique identifier for the datum;
590 * maybe 0 if no unique identifier is available
592 * @return GNUNET_SYSERR to abort the iteration, GNUNET_OK to continue,
593 * GNUNET_NO to delete the item and continue (if supported)
596 transmit_item (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
597 const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
598 uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
601 struct GNUNET_SERVER_Client *client = cls;
602 struct GNUNET_MessageHeader *end;
603 struct DataMessage *dm;
607 /* transmit 'DATA_END' */
608 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting `%s' message\n",
610 end = GNUNET_new (struct GNUNET_MessageHeader);
611 end->size = htons (sizeof (struct GNUNET_MessageHeader));
612 end->type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END);
613 transmit (client, end);
614 GNUNET_SERVER_client_drop (client);
617 GNUNET_assert (sizeof (struct DataMessage) + size <
618 GNUNET_SERVER_MAX_MESSAGE_SIZE);
619 dm = GNUNET_malloc (sizeof (struct DataMessage) + size);
620 dm->header.size = htons (sizeof (struct DataMessage) + size);
621 dm->header.type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_DATA);
623 dm->size = htonl (size);
624 dm->type = htonl (type);
625 dm->priority = htonl (priority);
626 dm->anonymity = htonl (anonymity);
627 dm->replication = htonl (0);
628 dm->reserved = htonl (0);
629 dm->expiration = GNUNET_TIME_absolute_hton (expiration);
630 dm->uid = GNUNET_htonll (uid);
632 memcpy (&dm[1], data, size);
633 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
634 "Transmitting `%s' message for `%s' of type %u with expiration %s (in: %s)\n",
635 "DATA", GNUNET_h2s (key), type,
636 GNUNET_STRINGS_absolute_time_to_string (expiration),
637 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (expiration),
639 GNUNET_STATISTICS_update (stats, gettext_noop ("# results found"), 1,
641 transmit (client, &dm->header);
642 GNUNET_SERVER_client_drop (client);
648 * Handle RESERVE-message.
651 * @param client identification of the client
652 * @param message the actual message
655 handle_reserve (void *cls, struct GNUNET_SERVER_Client *client,
656 const struct GNUNET_MessageHeader *message)
659 * Static counter to produce reservation identifiers.
661 static int reservation_gen;
663 const struct ReserveMessage *msg = (const struct ReserveMessage *) message;
664 struct ReservationList *e;
665 unsigned long long used;
666 unsigned long long req;
670 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n", "RESERVE");
671 amount = GNUNET_ntohll (msg->amount);
672 entries = ntohl (msg->entries);
673 used = payload + reserved;
675 amount + ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * entries;
676 if (used + req > quota)
679 used = quota; /* cheat a bit for error message (to avoid negative numbers) */
680 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
682 ("Insufficient space (%llu bytes are available) to satisfy `%s' request for %llu bytes\n"),
683 quota - used, "RESERVE", req);
684 if (cache_size < req)
686 /* TODO: document this in the FAQ; essentially, if this
687 * message happens, the insertion request could be blocked
688 * by less-important content from migration because it is
689 * larger than 1/8th of the overall available space, and
690 * we only reserve 1/8th for "fresh" insertions */
691 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
693 ("The requested amount (%llu bytes) is larger than the cache size (%llu bytes)\n"),
695 transmit_status (client, 0,
697 ("Insufficient space to satisfy request and "
698 "requested amount is larger than cache size"));
702 transmit_status (client, 0,
703 gettext_noop ("Insufficient space to satisfy request"));
708 GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
710 e = GNUNET_new (struct ReservationList);
711 e->next = reservations;
715 e->entries = entries;
716 e->rid = ++reservation_gen;
717 if (reservation_gen < 0)
718 reservation_gen = 0; /* wrap around */
719 transmit_status (client, e->rid, NULL);
724 * Handle RELEASE_RESERVE-message.
727 * @param client identification of the client
728 * @param message the actual message
731 handle_release_reserve (void *cls,
732 struct GNUNET_SERVER_Client *client,
733 const struct GNUNET_MessageHeader *message)
735 const struct ReleaseReserveMessage *msg =
736 (const struct ReleaseReserveMessage *) message;
737 struct ReservationList *pos;
738 struct ReservationList *prev;
739 struct ReservationList *next;
740 int rid = ntohl (msg->rid);
741 unsigned long long rem;
743 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
744 "Processing `%s' request\n",
748 while (NULL != (pos = next))
759 ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * pos->entries;
760 GNUNET_assert (reserved >= rem);
762 GNUNET_STATISTICS_set (stats,
763 gettext_noop ("# reserved"), reserved,
765 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
766 "Returning %llu remaining reserved bytes to storage pool\n",
769 transmit_status (client, GNUNET_OK, NULL);
775 transmit_status (client, GNUNET_SYSERR,
776 gettext_noop ("Could not find matching reservation"));
781 * Check that the given message is a valid data message.
783 * @return NULL if the message is not well-formed, otherwise the message
785 static const struct DataMessage *
786 check_data (const struct GNUNET_MessageHeader *message)
790 const struct DataMessage *dm;
792 size = ntohs (message->size);
793 if (size < sizeof (struct DataMessage))
798 dm = (const struct DataMessage *) message;
799 dsize = ntohl (dm->size);
800 if (size != dsize + sizeof (struct DataMessage))
810 * Context for a PUT request used to see if the content is
816 * Client to notify on completion.
818 struct GNUNET_SERVER_Client *client;
820 #if ! HAVE_UNALIGNED_64_ACCESS
824 /* followed by the 'struct DataMessage' */
829 * Actually put the data message.
831 * @param client sender of the message
832 * @param dm message with the data to store
835 execute_put (struct GNUNET_SERVER_Client *client, const struct DataMessage *dm)
841 size = ntohl (dm->size);
844 plugin->api->put (plugin->api->cls, &dm->key, size, &dm[1],
845 ntohl (dm->type), ntohl (dm->priority),
846 ntohl (dm->anonymity), ntohl (dm->replication),
847 GNUNET_TIME_absolute_ntoh (dm->expiration), &msg);
848 if (GNUNET_OK == ret)
850 GNUNET_STATISTICS_update (stats,
851 gettext_noop ("# bytes stored"), size,
853 GNUNET_CONTAINER_bloomfilter_add (filter, &dm->key);
854 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
855 "Successfully stored %u bytes of type %u under key `%s'\n",
856 size, ntohl (dm->type), GNUNET_h2s (&dm->key));
858 transmit_status (client, ret, msg);
859 GNUNET_free_non_null (msg);
860 if (quota - reserved - cache_size < payload)
862 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
863 _("Need %llu bytes more space (%llu allowed, using %llu)\n"),
864 (unsigned long long) size + GNUNET_DATASTORE_ENTRY_OVERHEAD,
865 (unsigned long long) (quota - reserved - cache_size),
866 (unsigned long long) payload);
867 manage_space (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
873 * Function that will check if the given datastore entry
874 * matches the put and if none match executes the put.
876 * @param cls closure, pointer to the client (of type 'struct PutContext').
877 * @param key key for the content
878 * @param size number of bytes in data
879 * @param data content stored
880 * @param type type of the content
881 * @param priority priority of the content
882 * @param anonymity anonymity-level for the content
883 * @param expiration expiration time for the content
884 * @param uid unique identifier for the datum;
885 * maybe 0 if no unique identifier is available
887 * @return GNUNET_OK usually
888 * GNUNET_NO to delete the item
891 check_present (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
892 const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
893 uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
896 struct PutContext *pc = cls;
897 const struct DataMessage *dm;
899 dm = (const struct DataMessage *) &pc[1];
902 execute_put (pc->client, dm);
903 GNUNET_SERVER_client_drop (pc->client);
907 if ((GNUNET_BLOCK_TYPE_FS_DBLOCK == type) ||
908 (GNUNET_BLOCK_TYPE_FS_IBLOCK == type) || ((size == ntohl (dm->size)) &&
910 memcmp (&dm[1], data, size))))
912 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
913 "Result already present in datastore\n");
914 /* FIXME: change API to allow increasing 'replication' counter */
915 if ((ntohl (dm->priority) > 0) ||
916 (GNUNET_TIME_absolute_ntoh (dm->expiration).abs_value_us >
917 expiration.abs_value_us))
918 plugin->api->update (plugin->api->cls, uid,
919 (int32_t) ntohl (dm->priority),
920 GNUNET_TIME_absolute_ntoh (dm->expiration), NULL);
921 transmit_status (pc->client, GNUNET_NO, NULL);
922 GNUNET_SERVER_client_drop (pc->client);
927 execute_put (pc->client, dm);
928 GNUNET_SERVER_client_drop (pc->client);
936 * Handle PUT-message.
939 * @param client identification of the client
940 * @param message the actual message
943 handle_put (void *cls, struct GNUNET_SERVER_Client *client,
944 const struct GNUNET_MessageHeader *message)
946 const struct DataMessage *dm = check_data (message);
948 struct ReservationList *pos;
949 struct PutContext *pc;
950 struct GNUNET_HashCode vhash;
953 if ((dm == NULL) || (ntohl (dm->type) == 0))
956 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
959 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
960 "Processing `%s' request for `%s' of type %u\n", "PUT",
961 GNUNET_h2s (&dm->key), ntohl (dm->type));
962 rid = ntohl (dm->rid);
963 size = ntohl (dm->size);
967 while ((NULL != pos) && (rid != pos->rid))
969 GNUNET_break (pos != NULL);
972 GNUNET_break (pos->entries > 0);
973 GNUNET_break (pos->amount >= size);
976 reserved -= (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
977 GNUNET_STATISTICS_set (stats,
978 gettext_noop ("# reserved"), reserved,
982 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (filter, &dm->key))
984 GNUNET_CRYPTO_hash (&dm[1], size, &vhash);
985 pc = GNUNET_malloc (sizeof (struct PutContext) + size +
986 sizeof (struct DataMessage));
988 GNUNET_SERVER_client_keep (client);
989 memcpy (&pc[1], dm, size + sizeof (struct DataMessage));
990 plugin->api->get_key (plugin->api->cls, 0, &dm->key, &vhash,
991 ntohl (dm->type), &check_present, pc);
994 execute_put (client, dm);
999 * Handle GET-message.
1001 * @param cls closure
1002 * @param client identification of the client
1003 * @param message the actual message
1006 handle_get (void *cls, struct GNUNET_SERVER_Client *client,
1007 const struct GNUNET_MessageHeader *message)
1009 const struct GetMessage *msg;
1012 size = ntohs (message->size);
1013 if ((size != sizeof (struct GetMessage)) &&
1014 (size != sizeof (struct GetMessage) - sizeof (struct GNUNET_HashCode)))
1017 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1020 msg = (const struct GetMessage *) message;
1021 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1022 "Processing `%s' request for `%s' of type %u\n", "GET",
1023 GNUNET_h2s (&msg->key), ntohl (msg->type));
1024 GNUNET_STATISTICS_update (stats,
1025 gettext_noop ("# GET requests received"), 1,
1027 GNUNET_SERVER_client_keep (client);
1028 if ((size == sizeof (struct GetMessage)) &&
1029 (GNUNET_YES != GNUNET_CONTAINER_bloomfilter_test (filter, &msg->key)))
1031 /* don't bother database... */
1032 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1033 "Empty result set for `%s' request for `%s' (bloomfilter).\n",
1034 "GET", GNUNET_h2s (&msg->key));
1035 GNUNET_STATISTICS_update (stats,
1037 ("# requests filtered by bloomfilter"), 1,
1039 transmit_item (client, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS,
1043 plugin->api->get_key (plugin->api->cls, GNUNET_ntohll (msg->offset),
1045 sizeof (struct GetMessage)) ? &msg->key : NULL), NULL,
1046 ntohl (msg->type), &transmit_item, client);
1051 * Handle UPDATE-message.
1053 * @param cls closure
1054 * @param client identification of the client
1055 * @param message the actual message
1058 handle_update (void *cls, struct GNUNET_SERVER_Client *client,
1059 const struct GNUNET_MessageHeader *message)
1061 const struct UpdateMessage *msg;
1065 GNUNET_STATISTICS_update (stats, gettext_noop ("# UPDATE requests received"),
1067 msg = (const struct UpdateMessage *) message;
1069 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request for %llu\n",
1070 "UPDATE", (unsigned long long) GNUNET_ntohll (msg->uid));
1072 plugin->api->update (plugin->api->cls, GNUNET_ntohll (msg->uid),
1073 (int32_t) ntohl (msg->priority),
1074 GNUNET_TIME_absolute_ntoh (msg->expiration), &emsg);
1075 transmit_status (client, ret, emsg);
1076 GNUNET_free_non_null (emsg);
1081 * Handle GET_REPLICATION-message.
1083 * @param cls closure
1084 * @param client identification of the client
1085 * @param message the actual message
1088 handle_get_replication (void *cls, struct GNUNET_SERVER_Client *client,
1089 const struct GNUNET_MessageHeader *message)
1091 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n",
1093 GNUNET_STATISTICS_update (stats,
1095 ("# GET REPLICATION requests received"), 1,
1097 GNUNET_SERVER_client_keep (client);
1098 plugin->api->get_replication (plugin->api->cls, &transmit_item, client);
1103 * Handle GET_ZERO_ANONYMITY-message.
1105 * @param cls closure
1106 * @param client identification of the client
1107 * @param message the actual message
1110 handle_get_zero_anonymity (void *cls, struct GNUNET_SERVER_Client *client,
1111 const struct GNUNET_MessageHeader *message)
1113 const struct GetZeroAnonymityMessage *msg =
1114 (const struct GetZeroAnonymityMessage *) message;
1115 enum GNUNET_BLOCK_Type type;
1117 type = (enum GNUNET_BLOCK_Type) ntohl (msg->type);
1118 if (type == GNUNET_BLOCK_TYPE_ANY)
1121 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1124 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n",
1125 "GET_ZERO_ANONYMITY");
1126 GNUNET_STATISTICS_update (stats,
1128 ("# GET ZERO ANONYMITY requests received"), 1,
1130 GNUNET_SERVER_client_keep (client);
1131 plugin->api->get_zero_anonymity (plugin->api->cls,
1132 GNUNET_ntohll (msg->offset), type,
1133 &transmit_item, client);
1138 * Callback function that will cause the item that is passed
1139 * in to be deleted (by returning GNUNET_NO).
1142 remove_callback (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
1143 const void *data, enum GNUNET_BLOCK_Type type,
1144 uint32_t priority, uint32_t anonymity,
1145 struct GNUNET_TIME_Absolute expiration, uint64_t uid)
1147 struct GNUNET_SERVER_Client *client = cls;
1151 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1152 "No further matches for `%s' request.\n", "REMOVE");
1153 transmit_status (client, GNUNET_NO, _("Content not found"));
1154 GNUNET_SERVER_client_drop (client);
1155 return GNUNET_OK; /* last item */
1157 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1158 "Item %llu matches `%s' request for key `%s' and type %u.\n",
1159 (unsigned long long) uid, "REMOVE", GNUNET_h2s (key), type);
1160 GNUNET_STATISTICS_update (stats,
1161 gettext_noop ("# bytes removed (explicit request)"),
1163 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
1164 transmit_status (client, GNUNET_OK, NULL);
1165 GNUNET_SERVER_client_drop (client);
1171 * Handle REMOVE-message.
1173 * @param cls closure
1174 * @param client identification of the client
1175 * @param message the actual message
1178 handle_remove (void *cls, struct GNUNET_SERVER_Client *client,
1179 const struct GNUNET_MessageHeader *message)
1181 const struct DataMessage *dm = check_data (message);
1182 struct GNUNET_HashCode vhash;
1187 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1190 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1191 "Processing `%s' request for `%s' of type %u\n", "REMOVE",
1192 GNUNET_h2s (&dm->key), ntohl (dm->type));
1193 GNUNET_STATISTICS_update (stats, gettext_noop ("# REMOVE requests received"),
1195 GNUNET_SERVER_client_keep (client);
1196 GNUNET_CRYPTO_hash (&dm[1], ntohl (dm->size), &vhash);
1197 plugin->api->get_key (plugin->api->cls, 0, &dm->key, &vhash,
1198 (enum GNUNET_BLOCK_Type) ntohl (dm->type),
1199 &remove_callback, client);
1204 * Handle DROP-message.
1206 * @param cls closure
1207 * @param client identification of the client
1208 * @param message the actual message
1211 handle_drop (void *cls, struct GNUNET_SERVER_Client *client,
1212 const struct GNUNET_MessageHeader *message)
1214 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1215 "Processing `%s' request\n",
1217 do_drop = GNUNET_YES;
1218 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1223 * Function called by plugins to notify us about a
1224 * change in their disk utilization.
1226 * @param cls closure (NULL)
1227 * @param delta change in disk utilization,
1228 * 0 for "reset to empty"
1231 disk_utilization_change_cb (void *cls,
1234 if ((delta < 0) && (payload < -delta))
1236 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1237 _("Datastore payload must have been inaccurate (%lld < %lld). Recomputing it.\n"),
1238 (long long) payload,
1239 (long long) -delta);
1240 payload = plugin->api->estimate_size (plugin->api->cls);
1241 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1242 _("New payload: %lld\n"),
1243 (long long) payload);
1249 if (last_sync >= MAX_STAT_SYNC_LAG)
1255 * Callback function to process statistic values.
1257 * @param cls closure (struct Plugin*)
1258 * @param subsystem name of subsystem that created the statistic
1259 * @param name the name of the datum
1260 * @param value the current value
1261 * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
1262 * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
1265 process_stat_in (void *cls,
1266 const char *subsystem,
1271 GNUNET_assert (GNUNET_NO == stats_worked);
1272 stats_worked = GNUNET_YES;
1274 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1275 "Notification from statistics about existing payload (%llu), new payload is %llu\n",
1282 * Load the datastore plugin.
1284 static struct DatastorePlugin *
1287 struct DatastorePlugin *ret;
1290 ret = GNUNET_new (struct DatastorePlugin);
1292 ret->env.duc = &disk_utilization_change_cb;
1293 ret->env.cls = NULL;
1294 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1295 _("Loading `%s' datastore plugin\n"),
1297 GNUNET_asprintf (&libname,
1298 "libgnunet_plugin_datastore_%s",
1300 ret->short_name = GNUNET_strdup (plugin_name);
1301 ret->lib_name = libname;
1302 ret->api = GNUNET_PLUGIN_load (libname, &ret->env);
1303 if (NULL == ret->api)
1305 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1306 _("Failed to load datastore plugin for `%s'\n"),
1308 GNUNET_free (ret->short_name);
1309 GNUNET_free (libname);
1318 * Function called when the service shuts
1319 * down. Unloads our datastore plugin.
1321 * @param plug plugin to unload
1324 unload_plugin (struct DatastorePlugin *plug)
1326 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1327 "Datastore service is unloading plugin...\n");
1328 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
1329 GNUNET_free (plug->lib_name);
1330 GNUNET_free (plug->short_name);
1336 * Adds a given @a key to the bloomfilter in @a cls @a count times.
1338 * @param cls the bloomfilter
1339 * @param key key to add
1340 * @param count number of times to add key
1343 add_key_to_bloomfilter (void *cls,
1344 const struct GNUNET_HashCode *key,
1347 struct GNUNET_CONTAINER_BloomFilter *bf = cls;
1350 GNUNET_CONTAINER_bloomfilter_add (bf, key);
1355 * We finished receiving the statistic. Initialize the plugin; if
1356 * loading the statistic failed, run the estimator.
1359 * @param success #GNUNET_NO if we failed to read the stat
1362 process_stat_done (void *cls, int success)
1365 plugin = load_plugin ();
1368 GNUNET_CONTAINER_bloomfilter_free (filter);
1372 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1377 if (GNUNET_NO == stats_worked)
1379 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1380 "Failed to obtain value from statistics service, recomputing it\n");
1381 payload = plugin->api->estimate_size (plugin->api->cls);
1383 if (GNUNET_YES == refresh_bf)
1385 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1386 _("Rebuilding bloomfilter. Please be patient.\n"));
1387 if (NULL != plugin->api->get_keys)
1388 plugin->api->get_keys (plugin->api->cls,
1389 &add_key_to_bloomfilter,
1392 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1393 _("Plugin does not support get_keys function. Please fix!\n"));
1395 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1396 _("Bloomfilter construction complete.\n"));
1399 = GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1406 * Task run during shutdown.
1409 cleaning_task (void *cls,
1410 const struct GNUNET_SCHEDULER_TaskContext *tc)
1412 struct TransmitCallbackContext *tcc;
1414 cleaning_done = GNUNET_YES;
1415 while (NULL != (tcc = tcc_head))
1417 GNUNET_CONTAINER_DLL_remove (tcc_head, tcc_tail, tcc);
1418 if (tcc->th != NULL)
1420 GNUNET_SERVER_notify_transmit_ready_cancel (tcc->th);
1421 GNUNET_SERVER_client_drop (tcc->client);
1423 GNUNET_free (tcc->msg);
1426 if (expired_kill_task != NULL)
1428 GNUNET_SCHEDULER_cancel (expired_kill_task);
1429 expired_kill_task = NULL;
1431 if (GNUNET_YES == do_drop)
1432 plugin->api->drop (plugin->api->cls);
1433 unload_plugin (plugin);
1437 GNUNET_CONTAINER_bloomfilter_free (filter);
1440 if (NULL != stat_get)
1442 GNUNET_STATISTICS_get_cancel (stat_get);
1445 GNUNET_free_non_null (plugin_name);
1451 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1454 GNUNET_free (quota_stat_name);
1455 quota_stat_name = NULL;
1460 * Function that removes all active reservations made
1461 * by the given client and releases the space for other
1464 * @param cls closure
1465 * @param client identification of the client
1468 cleanup_reservations (void *cls,
1469 struct GNUNET_SERVER_Client *client)
1471 struct ReservationList *pos;
1472 struct ReservationList *prev;
1473 struct ReservationList *next;
1482 if (pos->client == client)
1485 reservations = next;
1488 reserved -= pos->amount + pos->entries * GNUNET_DATASTORE_ENTRY_OVERHEAD;
1497 GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
1503 * Process datastore requests.
1505 * @param cls closure
1506 * @param server the initialized server
1507 * @param c configuration to use
1511 struct GNUNET_SERVER_Handle *server,
1512 const struct GNUNET_CONFIGURATION_Handle *c)
1514 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1515 {&handle_reserve, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE,
1516 sizeof (struct ReserveMessage)},
1517 {&handle_release_reserve, NULL,
1518 GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE,
1519 sizeof (struct ReleaseReserveMessage)},
1520 {&handle_put, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_PUT, 0},
1521 {&handle_update, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE,
1522 sizeof (struct UpdateMessage)},
1523 {&handle_get, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_GET, 0},
1524 {&handle_get_replication, NULL,
1525 GNUNET_MESSAGE_TYPE_DATASTORE_GET_REPLICATION,
1526 sizeof (struct GNUNET_MessageHeader)},
1527 {&handle_get_zero_anonymity, NULL,
1528 GNUNET_MESSAGE_TYPE_DATASTORE_GET_ZERO_ANONYMITY,
1529 sizeof (struct GetZeroAnonymityMessage)},
1530 {&handle_remove, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE, 0},
1531 {&handle_drop, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_DROP,
1532 sizeof (struct GNUNET_MessageHeader)},
1537 unsigned int bf_size;
1541 GNUNET_CONFIGURATION_get_value_string (cfg, "DATASTORE", "DATABASE",
1544 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1545 _("No `%s' specified for `%s' in configuration!\n"), "DATABASE",
1549 GNUNET_asprintf ("a_stat_name,
1550 _("# bytes used in file-sharing datastore `%s'"),
1553 GNUNET_CONFIGURATION_get_value_size (cfg, "DATASTORE", "QUOTA", "a))
1555 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1556 _("No `%s' specified for `%s' in configuration!\n"), "QUOTA",
1560 stats = GNUNET_STATISTICS_create ("datastore", cfg);
1561 GNUNET_STATISTICS_set (stats, gettext_noop ("# quota"), quota, GNUNET_NO);
1562 cache_size = quota / 8; /* Or should we make this an option? */
1563 GNUNET_STATISTICS_set (stats, gettext_noop ("# cache size"), cache_size,
1565 if (quota / (32 * 1024LL) > (1 << 31))
1566 bf_size = (1 << 31); /* absolute limit: ~2 GB, beyond that BF just won't help anyway */
1568 bf_size = quota / (32 * 1024LL); /* 8 bit per entry, 1 bit per 32 kb in DB */
1571 GNUNET_CONFIGURATION_get_value_filename (cfg, "DATASTORE", "BLOOMFILTER",
1573 (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn)))
1575 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1576 _("Could not use specified filename `%s' for bloomfilter.\n"),
1577 NULL != fn ? fn : "");
1578 GNUNET_free_non_null (fn);
1583 GNUNET_asprintf (&pfn, "%s.%s", fn, plugin_name);
1584 if (GNUNET_YES == GNUNET_DISK_file_test (pfn))
1586 filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5); /* approx. 3% false positives at max use */
1589 /* file exists but not valid, remove and try again, but refresh */
1590 if (0 != UNLINK (pfn))
1592 /* failed to remove, run without file */
1593 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1594 _("Failed to remove bogus bloomfilter file `%s'\n"),
1598 filter = GNUNET_CONTAINER_bloomfilter_load (NULL, bf_size, 5); /* approx. 3% false positives at max use */
1599 refresh_bf = GNUNET_YES;
1603 /* try again after remove */
1604 filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5); /* approx. 3% false positives at max use */
1605 refresh_bf = GNUNET_YES;
1608 /* failed yet again, give up on using file */
1609 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1610 _("Failed to remove bogus bloomfilter file `%s'\n"),
1614 filter = GNUNET_CONTAINER_bloomfilter_init (NULL, bf_size, 5); /* approx. 3% false positives at max use */
1620 /* normal case: have an existing valid bf file, no need to refresh */
1621 refresh_bf = GNUNET_NO;
1626 filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5); /* approx. 3% false positives at max use */
1627 refresh_bf = GNUNET_YES;
1633 filter = GNUNET_CONTAINER_bloomfilter_init (NULL, bf_size, 5); /* approx. 3% false positives at max use */
1634 refresh_bf = GNUNET_YES;
1636 GNUNET_free_non_null (fn);
1639 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1640 _("Failed to initialize bloomfilter.\n"));
1643 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1649 GNUNET_STATISTICS_get (stats,
1652 GNUNET_TIME_UNIT_SECONDS,
1656 GNUNET_SERVER_disconnect_notify (server,
1657 &cleanup_reservations,
1659 GNUNET_SERVER_add_handlers (server, handlers);
1660 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1667 * The main function for the datastore service.
1669 * @param argc number of arguments from the command line
1670 * @param argv command line arguments
1671 * @return 0 ok, 1 on error
1681 GNUNET_SERVICE_run (argc, argv, "datastore",
1682 GNUNET_SERVICE_OPTION_NONE,
1683 &run, NULL)) ? 0 : 1;
1688 /* end of gnunet-service-datastore.c */