2 This file is part of GNUnet
3 (C) 2004, 2005, 2006, 2007, 2009 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 2, 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 * How much space are we allowed to use?
147 static unsigned long long quota;
150 * Should the database be dropped on exit?
155 * Name of our plugin.
157 static char *plugin_name;
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 * Number of updates that were made to the
180 * payload value since we last synchronized
181 * it with the statistics service.
183 static unsigned int lastSync;
186 * Did we get an answer from statistics?
188 static int stats_worked;
191 * Identity of the task that is used to delete
194 static GNUNET_SCHEDULER_TaskIdentifier expired_kill_task;
199 const struct GNUNET_CONFIGURATION_Handle *cfg;
202 * Minimum time that content should have to not be discarded instantly
203 * (time stamp of any content that we've been discarding recently to
204 * stay below the quota). FOREVER if we had to expire content with
207 static struct GNUNET_TIME_Absolute min_expiration;
210 * Handle for reporting statistics.
212 static struct GNUNET_STATISTICS_Handle *stats;
216 * Synchronize our utilization statistics with the
217 * statistics service.
222 GNUNET_STATISTICS_set (stats, quota_stat_name, payload, GNUNET_YES);
223 GNUNET_STATISTICS_set (stats, "# utilization by current datastore", payload, GNUNET_NO);
230 * Context for transmitting replies to clients.
232 struct TransmitCallbackContext
236 * We keep these in a doubly-linked list (for cleanup).
238 struct TransmitCallbackContext *next;
241 * We keep these in a doubly-linked list (for cleanup).
243 struct TransmitCallbackContext *prev;
246 * The message that we're asked to transmit.
248 struct GNUNET_MessageHeader *msg;
251 * Handle for the transmission request.
253 struct GNUNET_CONNECTION_TransmitHandle *th;
256 * Client that we are transmitting to.
258 struct GNUNET_SERVER_Client *client;
264 * Head of the doubly-linked list (for cleanup).
266 static struct TransmitCallbackContext *tcc_head;
269 * Tail of the doubly-linked list (for cleanup).
271 static struct TransmitCallbackContext *tcc_tail;
274 * Have we already cleaned up the TCCs and are hence no longer
275 * willing (or able) to transmit anything to anyone?
277 static int cleaning_done;
280 * Handle for pending get request.
282 static struct GNUNET_STATISTICS_GetHandle *stat_get;
286 * Task that is used to remove expired entries from
287 * the datastore. This task will schedule itself
288 * again automatically to always delete all expired
291 * @param cls not used
292 * @param tc task context
295 delete_expired (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
299 * Iterate over the expired items stored in the datastore.
300 * Delete all expired items; once we have processed all
301 * expired items, re-schedule the "delete_expired" task.
303 * @param cls not used
304 * @param key key for the content
305 * @param size number of bytes in data
306 * @param data content stored
307 * @param type type of the content
308 * @param priority priority of the content
309 * @param anonymity anonymity-level for the content
310 * @param expiration expiration time for the content
311 * @param uid unique identifier for the datum;
312 * maybe 0 if no unique identifier is available
314 * @return GNUNET_SYSERR to abort the iteration, GNUNET_OK to continue
315 * (continue on call to "next", of course),
316 * GNUNET_NO to delete the item and continue (if supported)
319 expired_processor (void *cls, const GNUNET_HashCode * key, uint32_t size,
320 const void *data, enum GNUNET_BLOCK_Type type,
321 uint32_t priority, uint32_t anonymity,
322 struct GNUNET_TIME_Absolute expiration, uint64_t uid)
324 struct GNUNET_TIME_Absolute now;
329 GNUNET_SCHEDULER_add_delayed (MAX_EXPIRE_DELAY, &delete_expired, NULL);
330 return GNUNET_SYSERR;
332 now = GNUNET_TIME_absolute_get ();
333 if (expiration.abs_value > now.abs_value)
335 /* finished processing */
337 GNUNET_SCHEDULER_add_delayed (MAX_EXPIRE_DELAY, &delete_expired, NULL);
338 return GNUNET_SYSERR;
341 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
342 "Deleting content `%s' of type %u that expired %llu ms ago\n",
343 GNUNET_h2s (key), type,
344 (unsigned long long) (now.abs_value - expiration.abs_value));
346 min_expiration = now;
347 GNUNET_STATISTICS_update (stats, gettext_noop ("# bytes expired"), size,
349 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
351 GNUNET_SCHEDULER_add_delayed (MIN_EXPIRE_DELAY, &delete_expired, NULL);
357 * Task that is used to remove expired entries from
358 * the datastore. This task will schedule itself
359 * again automatically to always delete all expired
362 * @param cls not used
363 * @param tc task context
366 delete_expired (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
368 expired_kill_task = GNUNET_SCHEDULER_NO_TASK;
369 plugin->api->get_expiration (plugin->api->cls, &expired_processor, NULL);
374 * An iterator over a set of items stored in the datastore
375 * that deletes until we're happy with respect to our quota.
378 * @param key key for the content
379 * @param size number of bytes in data
380 * @param data content stored
381 * @param type type of the content
382 * @param priority priority of the content
383 * @param anonymity anonymity-level for the content
384 * @param expiration expiration time for the content
385 * @param uid unique identifier for the datum;
386 * maybe 0 if no unique identifier is available
388 * @return GNUNET_SYSERR to abort the iteration, GNUNET_OK to continue
389 * (continue on call to "next", of course),
390 * GNUNET_NO to delete the item and continue (if supported)
393 quota_processor (void *cls, const GNUNET_HashCode * key, uint32_t size,
394 const void *data, enum GNUNET_BLOCK_Type type,
395 uint32_t priority, uint32_t anonymity,
396 struct GNUNET_TIME_Absolute expiration, uint64_t uid)
398 unsigned long long *need = cls;
401 return GNUNET_SYSERR;
403 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
404 "Deleting %llu bytes of low-priority (%u) content `%s' of type %u at %llu ms prior to expiration (still trying to free another %llu bytes)\n",
405 (unsigned long long) (size + GNUNET_DATASTORE_ENTRY_OVERHEAD),
406 (unsigned int) priority,
407 GNUNET_h2s (key), type,
408 (unsigned long long) GNUNET_TIME_absolute_get_remaining (expiration).rel_value,
411 if (size + GNUNET_DATASTORE_ENTRY_OVERHEAD > *need)
414 *need -= size + GNUNET_DATASTORE_ENTRY_OVERHEAD;
416 min_expiration = GNUNET_TIME_UNIT_FOREVER_ABS;
418 min_expiration = expiration;
419 GNUNET_STATISTICS_update (stats,
420 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;
445 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
446 "Asked to free up %llu bytes of cache space\n", need);
449 while ((need > 0) && (last != need))
452 plugin->api->get_expiration (plugin->api->cls, "a_processor, &need);
458 * Function called to notify a client about the socket
459 * begin ready to queue more data. "buf" will be
460 * NULL and "size" zero if the socket was closed for
461 * writing in the meantime.
464 * @param size number of bytes available in buf
465 * @param buf where the callee should write the message
466 * @return number of bytes written to buf
469 transmit_callback (void *cls, size_t size, void *buf)
471 struct TransmitCallbackContext *tcc = cls;
475 GNUNET_CONTAINER_DLL_remove (tcc_head, tcc_tail, tcc);
476 msize = ntohs (tcc->msg->size);
479 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
480 _("Transmission to client failed!\n"));
481 GNUNET_SERVER_receive_done (tcc->client, GNUNET_SYSERR);
482 GNUNET_SERVER_client_drop (tcc->client);
483 GNUNET_free (tcc->msg);
487 GNUNET_assert (size >= msize);
488 memcpy (buf, tcc->msg, msize);
489 GNUNET_SERVER_receive_done (tcc->client, GNUNET_OK);
490 GNUNET_SERVER_client_drop (tcc->client);
491 GNUNET_free (tcc->msg);
498 * Transmit the given message to the client.
500 * @param client target of the message
501 * @param msg message to transmit, will be freed!
504 transmit (struct GNUNET_SERVER_Client *client, struct GNUNET_MessageHeader *msg)
506 struct TransmitCallbackContext *tcc;
508 if (GNUNET_YES == cleaning_done)
511 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
512 "Shutdown in progress, aborting transmission.\n");
514 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
518 tcc = GNUNET_malloc (sizeof (struct TransmitCallbackContext));
520 tcc->client = client;
523 GNUNET_SERVER_notify_transmit_ready (client, ntohs (msg->size),
524 GNUNET_TIME_UNIT_FOREVER_REL,
525 &transmit_callback, tcc)))
528 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
533 GNUNET_SERVER_client_keep (client);
534 GNUNET_CONTAINER_DLL_insert (tcc_head, tcc_tail, tcc);
539 * Transmit a status code to the client.
541 * @param client receiver of the response
542 * @param code status code
543 * @param msg optional error message (can be NULL)
546 transmit_status (struct GNUNET_SERVER_Client *client, int code, const char *msg)
548 struct StatusMessage *sm;
552 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
553 "Transmitting `%s' message with value %d and message `%s'\n",
554 "STATUS", code, msg != NULL ? msg : "(none)");
556 slen = (msg == NULL) ? 0 : strlen (msg) + 1;
557 sm = GNUNET_malloc (sizeof (struct StatusMessage) + slen);
558 sm->header.size = htons (sizeof (struct StatusMessage) + slen);
559 sm->header.type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_STATUS);
560 sm->status = htonl (code);
561 sm->min_expiration = GNUNET_TIME_absolute_hton (min_expiration);
563 memcpy (&sm[1], msg, slen);
564 transmit (client, &sm->header);
570 * Function that will transmit the given datastore entry
573 * @param cls closure, pointer to the client (of type GNUNET_SERVER_Client).
574 * @param key key for the content
575 * @param size number of bytes in data
576 * @param data content stored
577 * @param type type of the content
578 * @param priority priority of the content
579 * @param anonymity anonymity-level for the content
580 * @param expiration expiration time for the content
581 * @param uid unique identifier for the datum;
582 * maybe 0 if no unique identifier is available
584 * @return GNUNET_SYSERR to abort the iteration, GNUNET_OK to continue,
585 * GNUNET_NO to delete the item and continue (if supported)
588 transmit_item (void *cls, const GNUNET_HashCode * key, uint32_t size,
589 const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
590 uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
593 struct GNUNET_SERVER_Client *client = cls;
594 struct GNUNET_MessageHeader *end;
595 struct DataMessage *dm;
599 /* transmit 'DATA_END' */
601 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting `%s' message\n",
604 end = GNUNET_malloc (sizeof (struct GNUNET_MessageHeader));
605 end->size = htons (sizeof (struct GNUNET_MessageHeader));
606 end->type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END);
607 transmit (client, end);
608 GNUNET_SERVER_client_drop (client);
611 GNUNET_assert (sizeof (struct DataMessage) + size <
612 GNUNET_SERVER_MAX_MESSAGE_SIZE);
613 dm = GNUNET_malloc (sizeof (struct DataMessage) + size);
614 dm->header.size = htons (sizeof (struct DataMessage) + size);
615 dm->header.type = htons (GNUNET_MESSAGE_TYPE_DATASTORE_DATA);
617 dm->size = htonl (size);
618 dm->type = htonl (type);
619 dm->priority = htonl (priority);
620 dm->anonymity = htonl (anonymity);
621 dm->replication = htonl (0);
622 dm->reserved = htonl (0);
623 dm->expiration = GNUNET_TIME_absolute_hton (expiration);
624 dm->uid = GNUNET_htonll (uid);
626 memcpy (&dm[1], data, size);
628 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
629 "Transmitting `%s' message for `%s' of type %u with expiration %llu (now: %llu)\n",
630 "DATA", GNUNET_h2s (key), type,
631 (unsigned long long) expiration.abs_value,
632 (unsigned long long) GNUNET_TIME_absolute_get ().abs_value);
634 GNUNET_STATISTICS_update (stats, gettext_noop ("# results found"), 1,
636 transmit (client, &dm->header);
637 GNUNET_SERVER_client_drop (client);
643 * Handle RESERVE-message.
646 * @param client identification of the client
647 * @param message the actual message
650 handle_reserve (void *cls, struct GNUNET_SERVER_Client *client,
651 const struct GNUNET_MessageHeader *message)
654 * Static counter to produce reservation identifiers.
656 static int reservation_gen;
658 const struct ReserveMessage *msg = (const struct ReserveMessage *) message;
659 struct ReservationList *e;
660 unsigned long long used;
661 unsigned long long req;
666 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n", "RESERVE");
668 amount = GNUNET_ntohll (msg->amount);
669 entries = ntohl (msg->entries);
670 used = payload + reserved;
672 amount + ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * entries;
673 if (used + req > quota)
676 used = quota; /* cheat a bit for error message (to avoid negative numbers) */
677 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
679 ("Insufficient space (%llu bytes are available) to satisfy `%s' request for %llu bytes\n"),
680 quota - used, "RESERVE", req);
681 if (cache_size < req)
683 /* TODO: document this in the FAQ; essentially, if this
684 * message happens, the insertion request could be blocked
685 * by less-important content from migration because it is
686 * larger than 1/8th of the overall available space, and
687 * we only reserve 1/8th for "fresh" insertions */
688 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
690 ("The requested amount (%llu bytes) is larger than the cache size (%llu bytes)\n"),
692 transmit_status (client, 0,
694 ("Insufficient space to satisfy request and "
695 "requested amount is larger than cache size"));
699 transmit_status (client, 0,
700 gettext_noop ("Insufficient space to satisfy request"));
705 GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
707 e = GNUNET_malloc (sizeof (struct ReservationList));
708 e->next = reservations;
712 e->entries = entries;
713 e->rid = ++reservation_gen;
714 if (reservation_gen < 0)
715 reservation_gen = 0; /* wrap around */
716 transmit_status (client, e->rid, NULL);
721 * Handle RELEASE_RESERVE-message.
724 * @param client identification of the client
725 * @param message the actual message
728 handle_release_reserve (void *cls, struct GNUNET_SERVER_Client *client,
729 const struct GNUNET_MessageHeader *message)
731 const struct ReleaseReserveMessage *msg =
732 (const struct ReleaseReserveMessage *) message;
733 struct ReservationList *pos;
734 struct ReservationList *prev;
735 struct ReservationList *next;
736 int rid = ntohl (msg->rid);
737 unsigned long long rem;
740 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n",
745 while (NULL != (pos = next))
756 ((unsigned long long) GNUNET_DATASTORE_ENTRY_OVERHEAD) * pos->entries;
757 GNUNET_assert (reserved >= rem);
759 GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
762 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
763 "Returning %llu remaining reserved bytes to storage pool\n",
767 transmit_status (client, GNUNET_OK, NULL);
773 transmit_status (client, GNUNET_SYSERR,
774 gettext_noop ("Could not find matching reservation"));
779 * Check that the given message is a valid data message.
781 * @return NULL if the message is not well-formed, otherwise the message
783 static const struct DataMessage *
784 check_data (const struct GNUNET_MessageHeader *message)
788 const struct DataMessage *dm;
790 size = ntohs (message->size);
791 if (size < sizeof (struct DataMessage))
796 dm = (const struct DataMessage *) message;
797 dsize = ntohl (dm->size);
798 if (size != dsize + sizeof (struct DataMessage))
808 * Context for a PUT request used to see if the content is
814 * Client to notify on completion.
816 struct GNUNET_SERVER_Client *client;
818 #if ! HAVE_UNALIGNED_64_ACCESS
822 /* followed by the 'struct DataMessage' */
827 * Actually put the data message.
829 * @param client sender of the message
830 * @param dm message with the data to store
833 execute_put (struct GNUNET_SERVER_Client *client, const struct DataMessage *dm)
839 size = ntohl (dm->size);
842 plugin->api->put (plugin->api->cls, &dm->key, size, &dm[1],
843 ntohl (dm->type), ntohl (dm->priority),
844 ntohl (dm->anonymity), ntohl (dm->replication),
845 GNUNET_TIME_absolute_ntoh (dm->expiration), &msg);
846 if (GNUNET_OK == ret)
848 GNUNET_STATISTICS_update (stats, gettext_noop ("# bytes stored"), size,
850 GNUNET_CONTAINER_bloomfilter_add (filter, &dm->key);
852 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
853 "Successfully stored %u bytes of type %u under key `%s'\n",
854 size, ntohl (dm->type), GNUNET_h2s (&dm->key));
857 transmit_status (client, ret, msg);
858 GNUNET_free_non_null (msg);
859 if (quota - reserved - cache_size < payload)
861 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
862 _("Need %llu bytes more space (%llu allowed, using %llu)\n"),
863 (unsigned long long) size + GNUNET_DATASTORE_ENTRY_OVERHEAD,
864 (unsigned long long) (quota - reserved - cache_size),
865 (unsigned long long) payload);
866 manage_space (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
872 * Function that will check if the given datastore entry
873 * matches the put and if none match executes the put.
875 * @param cls closure, pointer to the client (of type 'struct PutContext').
876 * @param key key for the content
877 * @param size number of bytes in data
878 * @param data content stored
879 * @param type type of the content
880 * @param priority priority of the content
881 * @param anonymity anonymity-level for the content
882 * @param expiration expiration time for the content
883 * @param uid unique identifier for the datum;
884 * maybe 0 if no unique identifier is available
886 * @return GNUNET_OK usually
887 * GNUNET_NO to delete the item
890 check_present (void *cls, const GNUNET_HashCode * key, uint32_t size,
891 const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
892 uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
895 struct PutContext *pc = cls;
896 const struct DataMessage *dm;
898 dm = (const struct DataMessage *) &pc[1];
901 execute_put (pc->client, dm);
902 GNUNET_SERVER_client_drop (pc->client);
906 if ((GNUNET_BLOCK_TYPE_FS_DBLOCK == type) ||
907 (GNUNET_BLOCK_TYPE_FS_IBLOCK == type) || ((size == ntohl (dm->size)) &&
909 memcmp (&dm[1], data, size))))
912 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
913 "Result already present in datastore\n");
915 /* FIXME: change API to allow increasing 'replication' counter */
916 if ((ntohl (dm->priority) > 0) ||
917 (GNUNET_TIME_absolute_ntoh (dm->expiration).abs_value >
918 expiration.abs_value))
919 plugin->api->update (plugin->api->cls, uid,
920 (int32_t) ntohl (dm->priority),
921 GNUNET_TIME_absolute_ntoh (dm->expiration), NULL);
922 transmit_status (pc->client, GNUNET_NO, NULL);
923 GNUNET_SERVER_client_drop (pc->client);
928 execute_put (pc->client, dm);
929 GNUNET_SERVER_client_drop (pc->client);
937 * Handle PUT-message.
940 * @param client identification of the client
941 * @param message the actual message
944 handle_put (void *cls, struct GNUNET_SERVER_Client *client,
945 const struct GNUNET_MessageHeader *message)
947 const struct DataMessage *dm = check_data (message);
949 struct ReservationList *pos;
950 struct PutContext *pc;
951 GNUNET_HashCode vhash;
954 if ((dm == NULL) || (ntohl (dm->type) == 0))
957 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
961 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
962 "Processing `%s' request for `%s' of type %u\n", "PUT",
963 GNUNET_h2s (&dm->key), ntohl (dm->type));
965 rid = ntohl (dm->rid);
966 size = ntohl (dm->size);
970 while ((NULL != pos) && (rid != pos->rid))
972 GNUNET_break (pos != NULL);
975 GNUNET_break (pos->entries > 0);
976 GNUNET_break (pos->amount >= size);
979 reserved -= (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
980 GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
984 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (filter, &dm->key))
986 GNUNET_CRYPTO_hash (&dm[1], size, &vhash);
987 pc = GNUNET_malloc (sizeof (struct PutContext) + size +
988 sizeof (struct DataMessage));
990 GNUNET_SERVER_client_keep (client);
991 memcpy (&pc[1], dm, size + sizeof (struct DataMessage));
992 plugin->api->get_key (plugin->api->cls, 0, &dm->key, &vhash,
993 ntohl (dm->type), &check_present, pc);
996 execute_put (client, dm);
1001 * Handle GET-message.
1003 * @param cls closure
1004 * @param client identification of the client
1005 * @param message the actual message
1008 handle_get (void *cls, struct GNUNET_SERVER_Client *client,
1009 const struct GNUNET_MessageHeader *message)
1011 const struct GetMessage *msg;
1014 size = ntohs (message->size);
1015 if ((size != sizeof (struct GetMessage)) &&
1016 (size != sizeof (struct GetMessage) - sizeof (GNUNET_HashCode)))
1019 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1022 msg = (const struct GetMessage *) message;
1024 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1025 "Processing `%s' request for `%s' of type %u\n", "GET",
1026 GNUNET_h2s (&msg->key), ntohl (msg->type));
1028 GNUNET_STATISTICS_update (stats, gettext_noop ("# GET requests received"), 1,
1030 GNUNET_SERVER_client_keep (client);
1031 if ((size == sizeof (struct GetMessage)) &&
1032 (GNUNET_YES != GNUNET_CONTAINER_bloomfilter_test (filter, &msg->key)))
1034 /* 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));
1040 GNUNET_STATISTICS_update (stats,
1042 ("# requests filtered by bloomfilter"), 1,
1044 transmit_item (client, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS,
1048 plugin->api->get_key (plugin->api->cls, GNUNET_ntohll (msg->offset),
1050 sizeof (struct GetMessage)) ? &msg->key : NULL), NULL,
1051 ntohl (msg->type), &transmit_item, client);
1056 * Handle UPDATE-message.
1058 * @param cls closure
1059 * @param client identification of the client
1060 * @param message the actual message
1063 handle_update (void *cls, struct GNUNET_SERVER_Client *client,
1064 const struct GNUNET_MessageHeader *message)
1066 const struct UpdateMessage *msg;
1070 GNUNET_STATISTICS_update (stats, gettext_noop ("# UPDATE requests received"),
1072 msg = (const struct UpdateMessage *) message;
1075 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request for %llu\n",
1076 "UPDATE", (unsigned long long) GNUNET_ntohll (msg->uid));
1079 plugin->api->update (plugin->api->cls, GNUNET_ntohll (msg->uid),
1080 (int32_t) ntohl (msg->priority),
1081 GNUNET_TIME_absolute_ntoh (msg->expiration), &emsg);
1082 transmit_status (client, ret, emsg);
1083 GNUNET_free_non_null (emsg);
1088 * Handle GET_REPLICATION-message.
1090 * @param cls closure
1091 * @param client identification of the client
1092 * @param message the actual message
1095 handle_get_replication (void *cls, struct GNUNET_SERVER_Client *client,
1096 const struct GNUNET_MessageHeader *message)
1099 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n",
1102 GNUNET_STATISTICS_update (stats,
1104 ("# GET REPLICATION requests received"), 1,
1106 GNUNET_SERVER_client_keep (client);
1107 plugin->api->get_replication (plugin->api->cls, &transmit_item, client);
1112 * Handle GET_ZERO_ANONYMITY-message.
1114 * @param cls closure
1115 * @param client identification of the client
1116 * @param message the actual message
1119 handle_get_zero_anonymity (void *cls, struct GNUNET_SERVER_Client *client,
1120 const struct GNUNET_MessageHeader *message)
1122 const struct GetZeroAnonymityMessage *msg =
1123 (const struct GetZeroAnonymityMessage *) message;
1124 enum GNUNET_BLOCK_Type type;
1126 type = (enum GNUNET_BLOCK_Type) ntohl (msg->type);
1127 if (type == GNUNET_BLOCK_TYPE_ANY)
1130 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1134 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n",
1135 "GET_ZERO_ANONYMITY");
1137 GNUNET_STATISTICS_update (stats,
1139 ("# GET ZERO ANONYMITY requests received"), 1,
1141 GNUNET_SERVER_client_keep (client);
1142 plugin->api->get_zero_anonymity (plugin->api->cls,
1143 GNUNET_ntohll (msg->offset), type,
1144 &transmit_item, client);
1149 * Callback function that will cause the item that is passed
1150 * in to be deleted (by returning GNUNET_NO).
1153 remove_callback (void *cls, const GNUNET_HashCode * key, uint32_t size,
1154 const void *data, enum GNUNET_BLOCK_Type type,
1155 uint32_t priority, uint32_t anonymity,
1156 struct GNUNET_TIME_Absolute expiration, uint64_t uid)
1158 struct GNUNET_SERVER_Client *client = cls;
1163 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1164 "No further matches for `%s' request.\n", "REMOVE");
1166 transmit_status (client, GNUNET_NO, _("Content not found"));
1167 GNUNET_SERVER_client_drop (client);
1168 return GNUNET_OK; /* last item */
1171 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1172 "Item %llu matches `%s' request for key `%s' and type %u.\n",
1173 (unsigned long long) uid, "REMOVE", GNUNET_h2s (key), type);
1175 GNUNET_STATISTICS_update (stats,
1176 gettext_noop ("# bytes removed (explicit request)"),
1178 GNUNET_CONTAINER_bloomfilter_remove (filter, key);
1179 transmit_status (client, GNUNET_OK, NULL);
1180 GNUNET_SERVER_client_drop (client);
1186 * Handle REMOVE-message.
1188 * @param cls closure
1189 * @param client identification of the client
1190 * @param message the actual message
1193 handle_remove (void *cls, struct GNUNET_SERVER_Client *client,
1194 const struct GNUNET_MessageHeader *message)
1196 const struct DataMessage *dm = check_data (message);
1197 GNUNET_HashCode vhash;
1202 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1206 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1207 "Processing `%s' request for `%s' of type %u\n", "REMOVE",
1208 GNUNET_h2s (&dm->key), ntohl (dm->type));
1210 GNUNET_STATISTICS_update (stats, gettext_noop ("# REMOVE requests received"),
1212 GNUNET_SERVER_client_keep (client);
1213 GNUNET_CRYPTO_hash (&dm[1], ntohl (dm->size), &vhash);
1214 plugin->api->get_key (plugin->api->cls, 0, &dm->key, &vhash,
1215 (enum GNUNET_BLOCK_Type) ntohl (dm->type),
1216 &remove_callback, client);
1221 * Handle DROP-message.
1223 * @param cls closure
1224 * @param client identification of the client
1225 * @param message the actual message
1228 handle_drop (void *cls, struct GNUNET_SERVER_Client *client,
1229 const struct GNUNET_MessageHeader *message)
1232 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing `%s' request\n", "DROP");
1234 do_drop = GNUNET_YES;
1235 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1240 * Function called by plugins to notify us about a
1241 * change in their disk utilization.
1243 * @param cls closure (NULL)
1244 * @param delta change in disk utilization,
1245 * 0 for "reset to empty"
1248 disk_utilization_change_cb (void *cls, int delta)
1250 if ((delta < 0) && (payload < -delta))
1252 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1254 ("Datastore payload inaccurate (%lld < %lld). Trying to fix.\n"),
1255 (long long) payload, (long long) -delta);
1256 payload = plugin->api->estimate_size (plugin->api->cls);
1262 if (lastSync >= MAX_STAT_SYNC_LAG)
1268 * Callback function to process statistic values.
1270 * @param cls closure (struct Plugin*)
1271 * @param subsystem name of subsystem that created the statistic
1272 * @param name the name of the datum
1273 * @param value the current value
1274 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
1275 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
1278 process_stat_in (void *cls, const char *subsystem, const char *name,
1279 uint64_t value, int is_persistent)
1281 GNUNET_assert (stats_worked == GNUNET_NO);
1282 stats_worked = GNUNET_YES;
1285 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1286 "Notification from statistics about existing payload (%llu), new payload is %llu\n",
1287 abs_value, payload);
1294 process_stat_done (void *cls, int success)
1296 struct DatastorePlugin *plugin = cls;
1299 if (stats_worked == GNUNET_NO)
1300 payload = plugin->api->estimate_size (plugin->api->cls);
1305 * Load the datastore plugin.
1307 static struct DatastorePlugin *
1310 struct DatastorePlugin *ret;
1313 ret = GNUNET_malloc (sizeof (struct DatastorePlugin));
1315 ret->env.duc = &disk_utilization_change_cb;
1316 ret->env.cls = NULL;
1317 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Loading `%s' datastore plugin\n"),
1319 GNUNET_asprintf (&libname, "libgnunet_plugin_datastore_%s", plugin_name);
1320 ret->short_name = GNUNET_strdup (plugin_name);
1321 ret->lib_name = libname;
1322 ret->api = GNUNET_PLUGIN_load (libname, &ret->env);
1323 if (ret->api == NULL)
1325 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1326 _("Failed to load datastore plugin for `%s'\n"), plugin_name);
1327 GNUNET_free (ret->short_name);
1328 GNUNET_free (libname);
1337 * Function called when the service shuts
1338 * down. Unloads our datastore plugin.
1340 * @param plug plugin to unload
1343 unload_plugin (struct DatastorePlugin *plug)
1346 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1347 "Datastore service is unloading plugin...\n");
1349 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
1350 GNUNET_free (plug->lib_name);
1351 GNUNET_free (plug->short_name);
1353 GNUNET_free (quota_stat_name);
1354 quota_stat_name = NULL;
1359 * Final task run after shutdown. Unloads plugins and disconnects us from
1363 unload_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1367 if (GNUNET_YES == do_drop)
1368 plugin->api->drop (plugin->api->cls);
1369 unload_plugin (plugin);
1373 GNUNET_CONTAINER_bloomfilter_free (filter);
1376 if (stat_get != NULL)
1378 GNUNET_STATISTICS_get_cancel (stat_get);
1383 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1386 GNUNET_free_non_null (plugin_name);
1392 * Last task run during shutdown. Disconnects us from
1393 * the transport and core.
1396 cleaning_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1398 struct TransmitCallbackContext *tcc;
1400 cleaning_done = GNUNET_YES;
1401 while (NULL != (tcc = tcc_head))
1403 GNUNET_CONTAINER_DLL_remove (tcc_head, tcc_tail, tcc);
1404 if (tcc->th != NULL)
1406 GNUNET_CONNECTION_notify_transmit_ready_cancel (tcc->th);
1407 GNUNET_SERVER_client_drop (tcc->client);
1409 GNUNET_free (tcc->msg);
1412 if (expired_kill_task != GNUNET_SCHEDULER_NO_TASK)
1414 GNUNET_SCHEDULER_cancel (expired_kill_task);
1415 expired_kill_task = GNUNET_SCHEDULER_NO_TASK;
1417 GNUNET_SCHEDULER_add_continuation (&unload_task, NULL,
1418 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
1423 * Function that removes all active reservations made
1424 * by the given client and releases the space for other
1427 * @param cls closure
1428 * @param client identification of the client
1431 cleanup_reservations (void *cls, struct GNUNET_SERVER_Client *client)
1433 struct ReservationList *pos;
1434 struct ReservationList *prev;
1435 struct ReservationList *next;
1444 if (pos->client == client)
1447 reservations = next;
1450 reserved -= pos->amount + pos->entries * GNUNET_DATASTORE_ENTRY_OVERHEAD;
1459 GNUNET_STATISTICS_set (stats, gettext_noop ("# reserved"), reserved,
1465 * Adds a given key to the bloomfilter 'count' times.
1467 * @param cls the bloomfilter
1468 * @param key key to add
1469 * @param count number of times to add key
1472 add_key_to_bloomfilter (void *cls,
1473 const GNUNET_HashCode *key,
1476 struct GNUNET_CONTAINER_BloomFilter *bf = cls;
1478 GNUNET_CONTAINER_bloomfilter_add (bf, key);
1483 * Process datastore requests.
1485 * @param cls closure
1486 * @param server the initialized server
1487 * @param c configuration to use
1490 run (void *cls, struct GNUNET_SERVER_Handle *server,
1491 const struct GNUNET_CONFIGURATION_Handle *c)
1493 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1494 {&handle_reserve, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE,
1495 sizeof (struct ReserveMessage)},
1496 {&handle_release_reserve, NULL,
1497 GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE,
1498 sizeof (struct ReleaseReserveMessage)},
1499 {&handle_put, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_PUT, 0},
1500 {&handle_update, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE,
1501 sizeof (struct UpdateMessage)},
1502 {&handle_get, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_GET, 0},
1503 {&handle_get_replication, NULL,
1504 GNUNET_MESSAGE_TYPE_DATASTORE_GET_REPLICATION,
1505 sizeof (struct GNUNET_MessageHeader)},
1506 {&handle_get_zero_anonymity, NULL,
1507 GNUNET_MESSAGE_TYPE_DATASTORE_GET_ZERO_ANONYMITY,
1508 sizeof (struct GetZeroAnonymityMessage)},
1509 {&handle_remove, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE, 0},
1510 {&handle_drop, NULL, GNUNET_MESSAGE_TYPE_DATASTORE_DROP,
1511 sizeof (struct GNUNET_MessageHeader)},
1516 unsigned int bf_size;
1521 GNUNET_CONFIGURATION_get_value_string (cfg, "DATASTORE", "DATABASE",
1524 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1525 _("No `%s' specified for `%s' in configuration!\n"), "DATABASE",
1529 GNUNET_asprintf ("a_stat_name,
1530 _("# bytes used in file-sharing datastore `%s'"),
1533 GNUNET_CONFIGURATION_get_value_size (cfg, "DATASTORE", "QUOTA", "a))
1535 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1536 _("No `%s' specified for `%s' in configuration!\n"), "QUOTA",
1540 stats = GNUNET_STATISTICS_create ("datastore", cfg);
1541 GNUNET_STATISTICS_set (stats, gettext_noop ("# quota"), quota, GNUNET_NO);
1542 cache_size = quota / 8; /* Or should we make this an option? */
1543 GNUNET_STATISTICS_set (stats, gettext_noop ("# cache size"), cache_size,
1545 if (quota / (32 * 1024LL) > (1 << 31))
1546 bf_size = (1 << 31); /* absolute limit: ~2 GB, beyond that BF just won't help anyway */
1548 bf_size = quota / (32 * 1024LL); /* 8 bit per entry, 1 bit per 32 kb in DB */
1551 GNUNET_CONFIGURATION_get_value_filename (cfg, "DATASTORE", "BLOOMFILTER",
1553 (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn)))
1555 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1556 _("Could not use specified filename `%s' for bloomfilter.\n"),
1557 fn != NULL ? fn : "");
1558 GNUNET_free_non_null (fn);
1563 GNUNET_asprintf (&pfn, "%s.%s", fn, plugin_name);
1564 if (GNUNET_YES == GNUNET_DISK_file_test (pfn))
1566 filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5); /* approx. 3% false positives at max use */
1569 /* file exists but not valid, remove and try again, but refresh */
1570 if (0 != UNLINK (pfn))
1572 /* failed to remove, run without file */
1573 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1574 _("Failed to remove bogus bloomfilter file `%s'\n"),
1578 filter = GNUNET_CONTAINER_bloomfilter_load (NULL, bf_size, 5); /* approx. 3% false positives at max use */
1579 refresh_bf = GNUNET_YES;
1583 /* try again after remove */
1584 filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5); /* approx. 3% false positives at max use */
1585 refresh_bf = GNUNET_YES;
1588 /* failed yet again, give up on using file */
1589 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1590 _("Failed to remove bogus bloomfilter file `%s'\n"),
1594 filter = GNUNET_CONTAINER_bloomfilter_load (NULL, bf_size, 5); /* approx. 3% false positives at max use */
1600 /* normal case: have an existing valid bf file, no need to refresh */
1601 refresh_bf = GNUNET_NO;
1606 filter = GNUNET_CONTAINER_bloomfilter_load (pfn, bf_size, 5); /* approx. 3% false positives at max use */
1607 refresh_bf = GNUNET_YES;
1613 filter = GNUNET_CONTAINER_bloomfilter_init (NULL, bf_size, 5); /* approx. 3% false positives at max use */
1614 refresh_bf = GNUNET_YES;
1616 GNUNET_free_non_null (fn);
1619 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1620 _("Failed to initialize bloomfilter.\n"));
1623 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1628 plugin = load_plugin ();
1631 GNUNET_CONTAINER_bloomfilter_free (filter);
1635 GNUNET_STATISTICS_destroy (stats, GNUNET_YES);
1641 GNUNET_STATISTICS_get (stats, "datastore", quota_stat_name,
1642 GNUNET_TIME_UNIT_SECONDS, &process_stat_done,
1643 &process_stat_in, plugin);
1644 GNUNET_SERVER_disconnect_notify (server, &cleanup_reservations, NULL);
1645 GNUNET_SERVER_add_handlers (server, handlers);
1646 if (GNUNET_YES == refresh_bf)
1648 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1649 _("Rebuilding bloomfilter. Please be patient.\n"));
1650 if (NULL != plugin->api->get_keys)
1651 plugin->api->get_keys (plugin->api->cls, &add_key_to_bloomfilter, filter);
1653 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1654 _("Plugin does not support get_keys function. Please fix!\n"));
1656 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1657 _("Bloomfilter construction complete.\n"));
1660 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1661 &delete_expired, NULL);
1662 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &cleaning_task,
1668 * The main function for the datastore service.
1670 * @param argc number of arguments from the command line
1671 * @param argv command line arguments
1672 * @return 0 ok, 1 on error
1675 main (int argc, char *const *argv)
1681 GNUNET_SERVICE_run (argc, argv, "datastore", GNUNET_SERVICE_OPTION_NONE,
1682 &run, NULL)) ? 0 : 1;
1687 /* end of gnunet-service-datastore.c */