2 This file is part of GNUnet
3 (C) 2004, 2005, 2006, 2007, 2009, 2010, 2011 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/datastore_api.c
23 * @brief Management for the datastore for files stored on a GNUnet node. Implements
24 * a priority queue for requests (with timeouts).
25 * @author Christian Grothoff
28 #include "gnunet_arm_service.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_datastore_service.h"
31 #include "gnunet_statistics_service.h"
32 #include "datastore.h"
35 * If a client stopped asking for more results, how many more do
36 * we receive from the DB before killing the connection? Trade-off
37 * between re-doing TCP handshakes and (needlessly) receiving
40 #define MAX_EXCESS_RESULTS 8
43 * Context for processing status messages.
48 * Continuation to call with the status.
50 GNUNET_DATASTORE_ContinuationWithStatus cont;
61 * Context for processing result messages.
66 * Function to call with the result.
68 GNUNET_DATASTORE_DatumProcessor proc;
79 * Context for a queue operation.
84 struct StatusContext sc;
86 struct ResultContext rc;
93 * Entry in our priority queue.
95 struct GNUNET_DATASTORE_QueueEntry
99 * This is a linked list.
101 struct GNUNET_DATASTORE_QueueEntry *next;
104 * This is a linked list.
106 struct GNUNET_DATASTORE_QueueEntry *prev;
109 * Handle to the master context.
111 struct GNUNET_DATASTORE_Handle *h;
114 * Response processor (NULL if we are not waiting for a response).
115 * This struct should be used for the closure, function-specific
116 * arguments can be passed via 'qc'.
118 GNUNET_CLIENT_MessageHandler response_proc;
121 * Function to call after transmission of the request.
123 GNUNET_DATASTORE_ContinuationWithStatus cont;
126 * Closure for 'cont'.
131 * Context for the operation.
133 union QueueContext qc;
136 * Task for timeout signalling.
138 GNUNET_SCHEDULER_TaskIdentifier task;
141 * Timeout for the current operation.
143 struct GNUNET_TIME_Absolute timeout;
146 * Priority in the queue.
148 unsigned int priority;
151 * Maximum allowed length of queue (otherwise
152 * this request should be discarded).
154 unsigned int max_queue;
157 * Number of bytes in the request message following
158 * this struct. 32-bit value for nicer memory
159 * access (and overall struct alignment).
161 uint32_t message_size;
164 * Has this message been transmitted to the service?
165 * Only ever GNUNET_YES for the head of the queue.
166 * Note that the overall struct should end at a
167 * multiple of 64 bits.
174 * Handle to the datastore service.
176 struct GNUNET_DATASTORE_Handle
182 const struct GNUNET_CONFIGURATION_Handle *cfg;
185 * Current connection to the datastore service.
187 struct GNUNET_CLIENT_Connection *client;
190 * Handle for statistics.
192 struct GNUNET_STATISTICS_Handle *stats;
195 * Current transmit handle.
197 struct GNUNET_CLIENT_TransmitHandle *th;
200 * Current head of priority queue.
202 struct GNUNET_DATASTORE_QueueEntry *queue_head;
205 * Current tail of priority queue.
207 struct GNUNET_DATASTORE_QueueEntry *queue_tail;
210 * Task for trying to reconnect.
212 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
215 * How quickly should we retry? Used for exponential back-off on
218 struct GNUNET_TIME_Relative retry_time;
221 * Number of entries in the queue.
223 unsigned int queue_size;
226 * Number of results we're receiving for the current query
227 * after application stopped to care. Used to determine when
228 * to reset the connection.
230 unsigned int result_count;
233 * Are we currently trying to receive from the service?
238 * We should ignore the next message(s) from the service.
240 unsigned int skip_next_messages;
247 * Connect to the datastore service.
249 * @param cfg configuration to use
250 * @return handle to use to access the service
252 struct GNUNET_DATASTORE_Handle *
253 GNUNET_DATASTORE_connect (const struct
254 GNUNET_CONFIGURATION_Handle
257 struct GNUNET_CLIENT_Connection *c;
258 struct GNUNET_DATASTORE_Handle *h;
260 c = GNUNET_CLIENT_connect ("datastore", cfg);
262 return NULL; /* oops */
263 h = GNUNET_malloc (sizeof(struct GNUNET_DATASTORE_Handle) +
264 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1);
267 h->stats = GNUNET_STATISTICS_create ("datastore-api",
274 * Transmit DROP message to datastore service.
276 * @param cls the 'struct GNUNET_DATASTORE_Handle'
277 * @param size number of bytes that can be copied to buf
278 * @param buf where to copy the drop message
279 * @return number of bytes written to buf
282 transmit_drop (void *cls,
286 struct GNUNET_DATASTORE_Handle *h = cls;
287 struct GNUNET_MessageHeader *hdr;
291 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
292 _("Failed to transmit request to drop database.\n"));
293 GNUNET_DATASTORE_disconnect (h, GNUNET_NO);
296 GNUNET_assert (size >= sizeof(struct GNUNET_MessageHeader));
298 hdr->size = htons(sizeof(struct GNUNET_MessageHeader));
299 hdr->type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_DROP);
300 GNUNET_DATASTORE_disconnect (h, GNUNET_NO);
301 return sizeof(struct GNUNET_MessageHeader);
306 * Disconnect from the datastore service (and free
307 * associated resources).
309 * @param h handle to the datastore
310 * @param drop set to GNUNET_YES to delete all data in datastore (!)
313 GNUNET_DATASTORE_disconnect (struct GNUNET_DATASTORE_Handle *h,
316 struct GNUNET_DATASTORE_QueueEntry *qe;
320 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
323 if (h->client != NULL)
325 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
328 if (h->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
330 GNUNET_SCHEDULER_cancel (h->reconnect_task);
331 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
333 while (NULL != (qe = h->queue_head))
335 GNUNET_assert (NULL != qe->response_proc);
336 qe->response_proc (h, NULL);
338 if (GNUNET_YES == drop)
340 h->client = GNUNET_CLIENT_connect ("datastore", h->cfg);
341 if (h->client != NULL)
344 GNUNET_CLIENT_notify_transmit_ready (h->client,
345 sizeof(struct GNUNET_MessageHeader),
346 GNUNET_TIME_UNIT_MINUTES,
351 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
356 GNUNET_STATISTICS_destroy (h->stats,
364 * A request has timed out (before being transmitted to the service).
366 * @param cls the 'struct GNUNET_DATASTORE_QueueEntry'
367 * @param tc scheduler context
370 timeout_queue_entry (void *cls,
371 const struct GNUNET_SCHEDULER_TaskContext *tc)
373 struct GNUNET_DATASTORE_QueueEntry *qe = cls;
375 GNUNET_STATISTICS_update (qe->h->stats,
376 gettext_noop ("# queue entry timeouts"),
379 qe->task = GNUNET_SCHEDULER_NO_TASK;
380 GNUNET_assert (qe->was_transmitted == GNUNET_NO);
381 qe->response_proc (qe->h, NULL);
386 * Create a new entry for our priority queue (and possibly discard other entires if
387 * the queue is getting too long).
389 * @param h handle to the datastore
390 * @param msize size of the message to queue
391 * @param queue_priority priority of the entry
392 * @param max_queue_size at what queue size should this request be dropped
393 * (if other requests of higher priority are in the queue)
394 * @param timeout timeout for the operation
395 * @param response_proc function to call with replies (can be NULL)
396 * @param qc client context (NOT a closure for response_proc)
397 * @return NULL if the queue is full
399 static struct GNUNET_DATASTORE_QueueEntry *
400 make_queue_entry (struct GNUNET_DATASTORE_Handle *h,
402 unsigned int queue_priority,
403 unsigned int max_queue_size,
404 struct GNUNET_TIME_Relative timeout,
405 GNUNET_CLIENT_MessageHandler response_proc,
406 const union QueueContext *qc)
408 struct GNUNET_DATASTORE_QueueEntry *ret;
409 struct GNUNET_DATASTORE_QueueEntry *pos;
414 while ( (pos != NULL) &&
415 (c < max_queue_size) &&
416 (pos->priority >= queue_priority) )
421 if (c >= max_queue_size)
423 GNUNET_STATISTICS_update (h->stats,
424 gettext_noop ("# queue overflows"),
429 ret = GNUNET_malloc (sizeof (struct GNUNET_DATASTORE_QueueEntry) + msize);
431 ret->response_proc = response_proc;
433 ret->timeout = GNUNET_TIME_relative_to_absolute (timeout);
434 ret->priority = queue_priority;
435 ret->max_queue = max_queue_size;
436 ret->message_size = msize;
437 ret->was_transmitted = GNUNET_NO;
440 /* append at the tail */
446 /* do not insert at HEAD if HEAD query was already
447 transmitted and we are still receiving replies! */
448 if ( (pos == NULL) &&
449 (h->queue_head->was_transmitted) )
453 GNUNET_STATISTICS_update (h->stats,
454 gettext_noop ("# queue entries created"),
457 GNUNET_CONTAINER_DLL_insert_after (h->queue_head,
462 ret->task = GNUNET_SCHEDULER_add_delayed (timeout,
463 &timeout_queue_entry,
468 if ( (pos->max_queue < h->queue_size) &&
469 (pos->was_transmitted == GNUNET_NO) )
471 GNUNET_assert (pos->response_proc != NULL);
472 /* move 'pos' element to head so that it will be
473 killed on 'NULL' call below */
474 GNUNET_CONTAINER_DLL_remove (h->queue_head,
477 GNUNET_CONTAINER_DLL_insert (h->queue_head,
480 GNUNET_STATISTICS_update (h->stats,
481 gettext_noop ("# Requests dropped from datastore queue"),
484 pos->response_proc (h, NULL);
494 * Process entries in the queue (or do nothing if we are already
497 * @param h handle to the datastore
500 process_queue (struct GNUNET_DATASTORE_Handle *h);
504 * Try reconnecting to the datastore service.
506 * @param cls the 'struct GNUNET_DATASTORE_Handle'
507 * @param tc scheduler context
510 try_reconnect (void *cls,
511 const struct GNUNET_SCHEDULER_TaskContext *tc)
513 struct GNUNET_DATASTORE_Handle *h = cls;
515 if (h->retry_time.rel_value < GNUNET_CONSTANTS_SERVICE_RETRY.rel_value)
516 h->retry_time = GNUNET_CONSTANTS_SERVICE_RETRY;
518 h->retry_time = GNUNET_TIME_relative_multiply (h->retry_time, 2);
519 if (h->retry_time.rel_value > GNUNET_CONSTANTS_SERVICE_TIMEOUT.rel_value)
520 h->retry_time = GNUNET_CONSTANTS_SERVICE_TIMEOUT;
521 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
522 h->client = GNUNET_CLIENT_connect ("datastore", h->cfg);
523 if (h->client == NULL)
525 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
526 "DATASTORE reconnect failed (fatally)\n");
529 GNUNET_STATISTICS_update (h->stats,
530 gettext_noop ("# datastore connections (re)created"),
534 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
535 "Reconnected to DATASTORE\n");
542 * Disconnect from the service and then try reconnecting to the datastore service
545 * @param h handle to datastore to disconnect and reconnect
548 do_disconnect (struct GNUNET_DATASTORE_Handle *h)
550 if (h->client == NULL)
553 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
554 "client NULL in disconnect, will not try to reconnect\n");
559 GNUNET_STATISTICS_update (stats,
560 gettext_noop ("# reconnected to DATASTORE"),
564 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
565 h->skip_next_messages = 0;
567 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->retry_time,
574 * Function called whenever we receive a message from
575 * the service. Calls the appropriate handler.
577 * @param cls the 'struct GNUNET_DATASTORE_Handle'
578 * @param msg the received message
581 receive_cb (void *cls,
582 const struct GNUNET_MessageHeader *msg)
584 struct GNUNET_DATASTORE_Handle *h = cls;
585 struct GNUNET_DATASTORE_QueueEntry *qe;
587 h->in_receive = GNUNET_NO;
588 if (h->skip_next_messages > 0)
590 h->skip_next_messages--;
594 if (NULL == (qe = h->queue_head))
600 qe->response_proc (h, msg);
605 * Transmit request from queue to datastore service.
607 * @param cls the 'struct GNUNET_DATASTORE_Handle'
608 * @param size number of bytes that can be copied to buf
609 * @param buf where to copy the drop message
610 * @return number of bytes written to buf
613 transmit_request (void *cls,
617 struct GNUNET_DATASTORE_Handle *h = cls;
618 struct GNUNET_DATASTORE_QueueEntry *qe;
622 if (NULL == (qe = h->queue_head))
623 return 0; /* no entry in queue */
626 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
627 _("Failed to transmit request to DATASTORE.\n"));
628 GNUNET_STATISTICS_update (h->stats,
629 gettext_noop ("# transmission request failures"),
635 if (size < (msize = qe->message_size))
641 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
642 "Transmitting %u byte request to DATASTORE\n",
645 memcpy (buf, &qe[1], msize);
646 qe->was_transmitted = GNUNET_YES;
647 GNUNET_SCHEDULER_cancel (qe->task);
648 qe->task = GNUNET_SCHEDULER_NO_TASK;
649 GNUNET_assert (GNUNET_NO == h->in_receive);
650 h->in_receive = GNUNET_YES;
651 GNUNET_CLIENT_receive (h->client,
654 GNUNET_TIME_absolute_get_remaining (qe->timeout));
655 GNUNET_STATISTICS_update (h->stats,
656 gettext_noop ("# bytes sent to datastore"),
664 * Process entries in the queue (or do nothing if we are already
667 * @param h handle to the datastore
670 process_queue (struct GNUNET_DATASTORE_Handle *h)
672 struct GNUNET_DATASTORE_QueueEntry *qe;
674 if (NULL == (qe = h->queue_head))
676 #if DEBUG_DATASTORE > 1
677 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
680 return; /* no entry in queue */
682 if (qe->was_transmitted == GNUNET_YES)
684 #if DEBUG_DATASTORE > 1
685 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
686 "Head request already transmitted\n");
688 return; /* waiting for replies */
692 #if DEBUG_DATASTORE > 1
693 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
694 "Pending transmission request\n");
696 return; /* request pending */
698 if (h->client == NULL)
700 #if DEBUG_DATASTORE > 1
701 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
704 return; /* waiting for reconnect */
706 if (GNUNET_YES == h->in_receive)
708 /* wait for response to previous query */
712 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
713 "Queueing %u byte request to DATASTORE\n",
716 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
718 GNUNET_TIME_absolute_get_remaining (qe->timeout),
722 GNUNET_assert (GNUNET_NO == h->in_receive);
723 GNUNET_break (NULL != h->th);
728 * Dummy continuation used to do nothing (but be non-zero).
731 * @param result result
732 * @param emsg error message
735 drop_status_cont (void *cls, int32_t result, const char *emsg)
742 * Free a queue entry. Removes the given entry from the
743 * queue and releases associated resources. Does NOT
746 * @param qe entry to free.
749 free_queue_entry (struct GNUNET_DATASTORE_QueueEntry *qe)
751 struct GNUNET_DATASTORE_Handle *h = qe->h;
753 GNUNET_CONTAINER_DLL_remove (h->queue_head,
756 if (qe->task != GNUNET_SCHEDULER_NO_TASK)
758 GNUNET_SCHEDULER_cancel (qe->task);
759 qe->task = GNUNET_SCHEDULER_NO_TASK;
762 qe->was_transmitted = GNUNET_SYSERR; /* use-after-free warning */
768 * Type of a function to call when we receive a message
772 * @param msg message received, NULL on timeout or fatal error
775 process_status_message (void *cls,
777 GNUNET_MessageHeader * msg)
779 struct GNUNET_DATASTORE_Handle *h = cls;
780 struct GNUNET_DATASTORE_QueueEntry *qe;
781 struct StatusContext rc;
782 const struct StatusMessage *sm;
787 if (NULL == (qe = h->queue_head))
796 was_transmitted = qe->was_transmitted;
797 free_queue_entry (qe);
798 if (was_transmitted == GNUNET_YES)
803 rc.cont (rc.cont_cls,
805 _("Failed to receive status response from database."));
808 GNUNET_assert (GNUNET_YES == qe->was_transmitted);
809 free_queue_entry (qe);
810 if ( (ntohs(msg->size) < sizeof(struct StatusMessage)) ||
811 (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_DATASTORE_STATUS) )
814 h->retry_time = GNUNET_TIME_UNIT_ZERO;
817 rc.cont (rc.cont_cls,
819 _("Error reading response from datastore service"));
822 sm = (const struct StatusMessage*) msg;
823 status = ntohl(sm->status);
825 if (ntohs(msg->size) > sizeof(struct StatusMessage))
827 emsg = (const char*) &sm[1];
828 if (emsg[ntohs(msg->size) - sizeof(struct StatusMessage) - 1] != '\0')
831 emsg = _("Invalid error message received from datastore service");
834 if ( (status == GNUNET_SYSERR) &&
838 emsg = _("Invalid error message received from datastore service");
841 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
842 "Received status %d/%s\n",
846 GNUNET_STATISTICS_update (h->stats,
847 gettext_noop ("# status messages received"),
850 h->retry_time.rel_value = 0;
853 rc.cont (rc.cont_cls,
860 * Store an item in the datastore. If the item is already present,
861 * the priorities are summed up and the higher expiration time and
862 * lower anonymity level is used.
864 * @param h handle to the datastore
865 * @param rid reservation ID to use (from "reserve"); use 0 if no
866 * prior reservation was made
867 * @param key key for the value
868 * @param size number of bytes in data
869 * @param data content stored
870 * @param type type of the content
871 * @param priority priority of the content
872 * @param anonymity anonymity-level for the content
873 * @param replication how often should the content be replicated to other peers?
874 * @param expiration expiration time for the content
875 * @param queue_priority ranking of this request in the priority queue
876 * @param max_queue_size at what queue size should this request be dropped
877 * (if other requests of higher priority are in the queue)
878 * @param timeout timeout for the operation
879 * @param cont continuation to call when done
880 * @param cont_cls closure for cont
881 * @return NULL if the entry was not queued, otherwise a handle that can be used to
882 * cancel; note that even if NULL is returned, the callback will be invoked
883 * (or rather, will already have been invoked)
885 struct GNUNET_DATASTORE_QueueEntry *
886 GNUNET_DATASTORE_put (struct GNUNET_DATASTORE_Handle *h,
888 const GNUNET_HashCode * key,
891 enum GNUNET_BLOCK_Type type,
894 uint32_t replication,
895 struct GNUNET_TIME_Absolute expiration,
896 unsigned int queue_priority,
897 unsigned int max_queue_size,
898 struct GNUNET_TIME_Relative timeout,
899 GNUNET_DATASTORE_ContinuationWithStatus cont,
902 struct GNUNET_DATASTORE_QueueEntry *qe;
903 struct DataMessage *dm;
905 union QueueContext qc;
908 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
909 "Asked to put %u bytes of data under key `%s' for %llu ms\n",
912 GNUNET_TIME_absolute_get_remaining (expiration).rel_value);
914 msize = sizeof(struct DataMessage) + size;
915 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
917 qc.sc.cont_cls = cont_cls;
918 qe = make_queue_entry (h, msize,
919 queue_priority, max_queue_size, timeout,
920 &process_status_message, &qc);
924 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
925 "Could not create queue entry for PUT\n");
929 GNUNET_STATISTICS_update (h->stats,
930 gettext_noop ("# PUT requests executed"),
933 dm = (struct DataMessage* ) &qe[1];
934 dm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_PUT);
935 dm->header.size = htons(msize);
936 dm->rid = htonl(rid);
937 dm->size = htonl( (uint32_t) size);
938 dm->type = htonl(type);
939 dm->priority = htonl(priority);
940 dm->anonymity = htonl(anonymity);
941 dm->replication = htonl (replication);
942 dm->reserved = htonl (0);
943 dm->uid = GNUNET_htonll(0);
944 dm->expiration = GNUNET_TIME_absolute_hton(expiration);
946 memcpy (&dm[1], data, size);
953 * Reserve space in the datastore. This function should be used
954 * to avoid "out of space" failures during a longer sequence of "put"
955 * operations (for example, when a file is being inserted).
957 * @param h handle to the datastore
958 * @param amount how much space (in bytes) should be reserved (for content only)
959 * @param entries how many entries will be created (to calculate per-entry overhead)
960 * @param queue_priority ranking of this request in the priority queue
961 * @param max_queue_size at what queue size should this request be dropped
962 * (if other requests of higher priority are in the queue)
963 * @param timeout how long to wait at most for a response (or before dying in queue)
964 * @param cont continuation to call when done; "success" will be set to
965 * a positive reservation value if space could be reserved.
966 * @param cont_cls closure for cont
967 * @return NULL if the entry was not queued, otherwise a handle that can be used to
968 * cancel; note that even if NULL is returned, the callback will be invoked
969 * (or rather, will already have been invoked)
971 struct GNUNET_DATASTORE_QueueEntry *
972 GNUNET_DATASTORE_reserve (struct GNUNET_DATASTORE_Handle *h,
975 unsigned int queue_priority,
976 unsigned int max_queue_size,
977 struct GNUNET_TIME_Relative timeout,
978 GNUNET_DATASTORE_ContinuationWithStatus cont,
981 struct GNUNET_DATASTORE_QueueEntry *qe;
982 struct ReserveMessage *rm;
983 union QueueContext qc;
986 cont = &drop_status_cont;
988 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
989 "Asked to reserve %llu bytes of data and %u entries'\n",
990 (unsigned long long) amount,
991 (unsigned int) entries);
994 qc.sc.cont_cls = cont_cls;
995 qe = make_queue_entry (h, sizeof(struct ReserveMessage),
996 queue_priority, max_queue_size, timeout,
997 &process_status_message, &qc);
1001 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1002 "Could not create queue entry to reserve\n");
1006 GNUNET_STATISTICS_update (h->stats,
1007 gettext_noop ("# RESERVE requests executed"),
1010 rm = (struct ReserveMessage*) &qe[1];
1011 rm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE);
1012 rm->header.size = htons(sizeof (struct ReserveMessage));
1013 rm->entries = htonl(entries);
1014 rm->amount = GNUNET_htonll(amount);
1021 * Signal that all of the data for which a reservation was made has
1022 * been stored and that whatever excess space might have been reserved
1023 * can now be released.
1025 * @param h handle to the datastore
1026 * @param rid reservation ID (value of "success" in original continuation
1027 * from the "reserve" function).
1028 * @param queue_priority ranking of this request in the priority queue
1029 * @param max_queue_size at what queue size should this request be dropped
1030 * (if other requests of higher priority are in the queue)
1031 * @param queue_priority ranking of this request in the priority queue
1032 * @param max_queue_size at what queue size should this request be dropped
1033 * (if other requests of higher priority are in the queue)
1034 * @param timeout how long to wait at most for a response
1035 * @param cont continuation to call when done
1036 * @param cont_cls closure for cont
1037 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1038 * cancel; note that even if NULL is returned, the callback will be invoked
1039 * (or rather, will already have been invoked)
1041 struct GNUNET_DATASTORE_QueueEntry *
1042 GNUNET_DATASTORE_release_reserve (struct GNUNET_DATASTORE_Handle *h,
1044 unsigned int queue_priority,
1045 unsigned int max_queue_size,
1046 struct GNUNET_TIME_Relative timeout,
1047 GNUNET_DATASTORE_ContinuationWithStatus cont,
1050 struct GNUNET_DATASTORE_QueueEntry *qe;
1051 struct ReleaseReserveMessage *rrm;
1052 union QueueContext qc;
1055 cont = &drop_status_cont;
1057 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1058 "Asked to release reserve %d\n",
1062 qc.sc.cont_cls = cont_cls;
1063 qe = make_queue_entry (h, sizeof(struct ReleaseReserveMessage),
1064 queue_priority, max_queue_size, timeout,
1065 &process_status_message, &qc);
1069 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1070 "Could not create queue entry to release reserve\n");
1074 GNUNET_STATISTICS_update (h->stats,
1075 gettext_noop ("# RELEASE RESERVE requests executed"),
1078 rrm = (struct ReleaseReserveMessage*) &qe[1];
1079 rrm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE);
1080 rrm->header.size = htons(sizeof (struct ReleaseReserveMessage));
1081 rrm->rid = htonl(rid);
1088 * Update a value in the datastore.
1090 * @param h handle to the datastore
1091 * @param uid identifier for the value
1092 * @param priority how much to increase the priority of the value
1093 * @param expiration new expiration value should be MAX of existing and this argument
1094 * @param queue_priority ranking of this request in the priority queue
1095 * @param max_queue_size at what queue size should this request be dropped
1096 * (if other requests of higher priority are in the queue)
1097 * @param timeout how long to wait at most for a response
1098 * @param cont continuation to call when done
1099 * @param cont_cls closure for cont
1100 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1101 * cancel; note that even if NULL is returned, the callback will be invoked
1102 * (or rather, will already have been invoked)
1104 struct GNUNET_DATASTORE_QueueEntry *
1105 GNUNET_DATASTORE_update (struct GNUNET_DATASTORE_Handle *h,
1108 struct GNUNET_TIME_Absolute expiration,
1109 unsigned int queue_priority,
1110 unsigned int max_queue_size,
1111 struct GNUNET_TIME_Relative timeout,
1112 GNUNET_DATASTORE_ContinuationWithStatus cont,
1115 struct GNUNET_DATASTORE_QueueEntry *qe;
1116 struct UpdateMessage *um;
1117 union QueueContext qc;
1120 cont = &drop_status_cont;
1122 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1123 "Asked to update entry %llu raising priority by %u and expiration to %llu\n",
1125 (unsigned int) priority,
1126 (unsigned long long) expiration.abs_value);
1129 qc.sc.cont_cls = cont_cls;
1130 qe = make_queue_entry (h, sizeof(struct UpdateMessage),
1131 queue_priority, max_queue_size, timeout,
1132 &process_status_message, &qc);
1136 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1137 "Could not create queue entry for UPDATE\n");
1141 GNUNET_STATISTICS_update (h->stats,
1142 gettext_noop ("# UPDATE requests executed"),
1145 um = (struct UpdateMessage*) &qe[1];
1146 um->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE);
1147 um->header.size = htons(sizeof (struct UpdateMessage));
1148 um->priority = htonl(priority);
1149 um->expiration = GNUNET_TIME_absolute_hton(expiration);
1150 um->uid = GNUNET_htonll(uid);
1157 * Explicitly remove some content from the database.
1158 * The "cont"inuation will be called with status
1159 * "GNUNET_OK" if content was removed, "GNUNET_NO"
1160 * if no matching entry was found and "GNUNET_SYSERR"
1161 * on all other types of errors.
1163 * @param h handle to the datastore
1164 * @param key key for the value
1165 * @param size number of bytes in data
1166 * @param data content stored
1167 * @param queue_priority ranking of this request in the priority queue
1168 * @param max_queue_size at what queue size should this request be dropped
1169 * (if other requests of higher priority are in the queue)
1170 * @param timeout how long to wait at most for a response
1171 * @param cont continuation to call when done
1172 * @param cont_cls closure for cont
1173 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1174 * cancel; note that even if NULL is returned, the callback will be invoked
1175 * (or rather, will already have been invoked)
1177 struct GNUNET_DATASTORE_QueueEntry *
1178 GNUNET_DATASTORE_remove (struct GNUNET_DATASTORE_Handle *h,
1179 const GNUNET_HashCode *key,
1182 unsigned int queue_priority,
1183 unsigned int max_queue_size,
1184 struct GNUNET_TIME_Relative timeout,
1185 GNUNET_DATASTORE_ContinuationWithStatus cont,
1188 struct GNUNET_DATASTORE_QueueEntry *qe;
1189 struct DataMessage *dm;
1191 union QueueContext qc;
1194 cont = &drop_status_cont;
1196 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1197 "Asked to remove %u bytes under key `%s'\n",
1202 qc.sc.cont_cls = cont_cls;
1203 msize = sizeof(struct DataMessage) + size;
1204 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
1205 qe = make_queue_entry (h, msize,
1206 queue_priority, max_queue_size, timeout,
1207 &process_status_message, &qc);
1211 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1212 "Could not create queue entry for REMOVE\n");
1216 GNUNET_STATISTICS_update (h->stats,
1217 gettext_noop ("# REMOVE requests executed"),
1220 dm = (struct DataMessage*) &qe[1];
1221 dm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE);
1222 dm->header.size = htons(msize);
1224 dm->size = htonl(size);
1225 dm->type = htonl(0);
1226 dm->priority = htonl(0);
1227 dm->anonymity = htonl(0);
1228 dm->uid = GNUNET_htonll(0);
1229 dm->expiration = GNUNET_TIME_absolute_hton(GNUNET_TIME_UNIT_ZERO_ABS);
1231 memcpy (&dm[1], data, size);
1238 * Type of a function to call when we receive a message
1241 * @param cls closure
1242 * @param msg message received, NULL on timeout or fatal error
1245 process_result_message (void *cls,
1246 const struct GNUNET_MessageHeader *msg)
1248 struct GNUNET_DATASTORE_Handle *h = cls;
1249 struct GNUNET_DATASTORE_QueueEntry *qe;
1250 struct ResultContext rc;
1251 const struct DataMessage *dm;
1256 GNUNET_assert (NULL != qe);
1258 free_queue_entry (qe);
1259 if (qe->was_transmitted == GNUNET_YES)
1261 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1262 _("Failed to receive response from database.\n"));
1269 if (rc.proc != NULL)
1270 rc.proc (rc.proc_cls,
1271 NULL, 0, NULL, 0, 0, 0,
1272 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1275 if (ntohs(msg->type) == GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END)
1277 GNUNET_break (ntohs(msg->size) == sizeof(struct GNUNET_MessageHeader));
1280 GNUNET_assert (GNUNET_YES == qe->was_transmitted);
1281 free_queue_entry (qe);
1283 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1284 "Received end of result set, new queue size is %u\n",
1287 if (rc.proc != NULL)
1288 rc.proc (rc.proc_cls,
1289 NULL, 0, NULL, 0, 0, 0,
1290 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1291 h->retry_time.rel_value = 0;
1292 h->result_count = 0;
1298 if (GNUNET_YES != qe->was_transmitted)
1301 free_queue_entry (qe);
1302 h->retry_time = GNUNET_TIME_UNIT_ZERO;
1304 if (rc.proc != NULL)
1305 rc.proc (rc.proc_cls,
1306 NULL, 0, NULL, 0, 0, 0,
1307 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1310 if ( (ntohs(msg->size) < sizeof(struct DataMessage)) ||
1311 (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_DATASTORE_DATA) ||
1312 (ntohs(msg->size) != sizeof(struct DataMessage) + ntohl (((const struct DataMessage*)msg)->size)) )
1315 free_queue_entry (qe);
1316 h->retry_time = GNUNET_TIME_UNIT_ZERO;
1318 if (rc.proc != NULL)
1319 rc.proc (rc.proc_cls,
1320 NULL, 0, NULL, 0, 0, 0,
1321 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1324 GNUNET_STATISTICS_update (h->stats,
1325 gettext_noop ("# Results received"),
1328 dm = (const struct DataMessage*) msg;
1330 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1331 "Received result %llu with type %u and size %u with key %s\n",
1332 (unsigned long long) GNUNET_ntohll(dm->uid),
1335 GNUNET_h2s(&dm->key));
1337 free_queue_entry (qe);
1338 h->retry_time.rel_value = 0;
1340 if (rc.proc != NULL)
1341 rc.proc (rc.proc_cls,
1346 ntohl(dm->priority),
1347 ntohl(dm->anonymity),
1348 GNUNET_TIME_absolute_ntoh(dm->expiration),
1349 GNUNET_ntohll(dm->uid));
1354 * Get a random value from the datastore for content replication.
1355 * Returns a single, random value among those with the highest
1356 * replication score, lowering positive replication scores by one for
1357 * the chosen value (if only content with a replication score exists,
1358 * a random value is returned and replication scores are not changed).
1360 * @param h handle to the datastore
1361 * @param queue_priority ranking of this request in the priority queue
1362 * @param max_queue_size at what queue size should this request be dropped
1363 * (if other requests of higher priority are in the queue)
1364 * @param timeout how long to wait at most for a response
1365 * @param proc function to call on a random value; it
1366 * will be called once with a value (if available)
1367 * and always once with a value of NULL.
1368 * @param proc_cls closure for proc
1369 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1372 struct GNUNET_DATASTORE_QueueEntry *
1373 GNUNET_DATASTORE_get_for_replication (struct GNUNET_DATASTORE_Handle *h,
1374 unsigned int queue_priority,
1375 unsigned int max_queue_size,
1376 struct GNUNET_TIME_Relative timeout,
1377 GNUNET_DATASTORE_DatumProcessor proc,
1380 struct GNUNET_DATASTORE_QueueEntry *qe;
1381 struct GNUNET_MessageHeader *m;
1382 union QueueContext qc;
1384 GNUNET_assert (NULL != proc);
1386 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1387 "Asked to get replication entry in %llu ms\n",
1388 (unsigned long long) timeout.rel_value);
1391 qc.rc.proc_cls = proc_cls;
1392 qe = make_queue_entry (h, sizeof(struct GNUNET_MessageHeader),
1393 queue_priority, max_queue_size, timeout,
1394 &process_result_message, &qc);
1398 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1399 "Could not create queue entry for GET REPLICATION\n");
1403 GNUNET_STATISTICS_update (h->stats,
1404 gettext_noop ("# GET REPLICATION requests executed"),
1407 m = (struct GNUNET_MessageHeader*) &qe[1];
1408 m->type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_GET_REPLICATION);
1409 m->size = htons(sizeof (struct GNUNET_MessageHeader));
1416 * Get a single zero-anonymity value from the datastore.
1418 * @param h handle to the datastore
1419 * @param offset offset of the result (modulo num-results); set to
1420 * a random 64-bit value initially; then increment by
1421 * one each time; detect that all results have been found by uid
1422 * being again the first uid ever returned.
1423 * @param queue_priority ranking of this request in the priority queue
1424 * @param max_queue_size at what queue size should this request be dropped
1425 * (if other requests of higher priority are in the queue)
1426 * @param timeout how long to wait at most for a response
1427 * @param type allowed type for the operation (never zero)
1428 * @param proc function to call on a random value; it
1429 * will be called once with a value (if available)
1430 * or with NULL if none value exists.
1431 * @param proc_cls closure for proc
1432 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1435 struct GNUNET_DATASTORE_QueueEntry *
1436 GNUNET_DATASTORE_get_zero_anonymity (struct GNUNET_DATASTORE_Handle *h,
1438 unsigned int queue_priority,
1439 unsigned int max_queue_size,
1440 struct GNUNET_TIME_Relative timeout,
1441 enum GNUNET_BLOCK_Type type,
1442 GNUNET_DATASTORE_DatumProcessor proc,
1445 struct GNUNET_DATASTORE_QueueEntry *qe;
1446 struct GetZeroAnonymityMessage *m;
1447 union QueueContext qc;
1449 GNUNET_assert (NULL != proc);
1450 GNUNET_assert (type != GNUNET_BLOCK_TYPE_ANY);
1452 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1453 "Asked to get %llu-th zero-anonymity entry of type %d in %llu ms\n",
1454 (unsigned long long) offset,
1456 (unsigned long long) timeout.rel_value);
1459 qc.rc.proc_cls = proc_cls;
1460 qe = make_queue_entry (h, sizeof(struct GetZeroAnonymityMessage),
1461 queue_priority, max_queue_size, timeout,
1462 &process_result_message, &qc);
1466 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1467 "Could not create queue entry for zero-anonymity procation\n");
1471 GNUNET_STATISTICS_update (h->stats,
1472 gettext_noop ("# GET ZERO ANONYMITY requests executed"),
1475 m = (struct GetZeroAnonymityMessage*) &qe[1];
1476 m->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_GET_ZERO_ANONYMITY);
1477 m->header.size = htons(sizeof (struct GetZeroAnonymityMessage));
1478 m->type = htonl ((uint32_t) type);
1479 m->offset = GNUNET_htonll (offset);
1486 * Get a result for a particular key from the datastore. The processor
1487 * will only be called once.
1489 * @param h handle to the datastore
1490 * @param offset offset of the result (modulo num-results); set to
1491 * a random 64-bit value initially; then increment by
1492 * one each time; detect that all results have been found by uid
1493 * being again the first uid ever returned.
1494 * @param key maybe NULL (to match all entries)
1495 * @param type desired type, 0 for any
1496 * @param queue_priority ranking of this request in the priority queue
1497 * @param max_queue_size at what queue size should this request be dropped
1498 * (if other requests of higher priority are in the queue)
1499 * @param timeout how long to wait at most for a response
1500 * @param proc function to call on each matching value;
1501 * will be called once with a NULL value at the end
1502 * @param proc_cls closure for proc
1503 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1506 struct GNUNET_DATASTORE_QueueEntry *
1507 GNUNET_DATASTORE_get_key (struct GNUNET_DATASTORE_Handle *h,
1509 const GNUNET_HashCode * key,
1510 enum GNUNET_BLOCK_Type type,
1511 unsigned int queue_priority,
1512 unsigned int max_queue_size,
1513 struct GNUNET_TIME_Relative timeout,
1514 GNUNET_DATASTORE_DatumProcessor proc,
1517 struct GNUNET_DATASTORE_QueueEntry *qe;
1518 struct GetMessage *gm;
1519 union QueueContext qc;
1521 GNUNET_assert (NULL != proc);
1523 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1524 "Asked to look for data of type %u under key `%s'\n",
1525 (unsigned int) type,
1529 qc.rc.proc_cls = proc_cls;
1530 qe = make_queue_entry (h, sizeof(struct GetMessage),
1531 queue_priority, max_queue_size, timeout,
1532 &process_result_message, &qc);
1536 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1537 "Could not queue request for `%s'\n",
1542 GNUNET_STATISTICS_update (h->stats,
1543 gettext_noop ("# GET requests executed"),
1546 gm = (struct GetMessage*) &qe[1];
1547 gm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_GET);
1548 gm->type = htonl(type);
1549 gm->offset = GNUNET_htonll (offset);
1552 gm->header.size = htons(sizeof (struct GetMessage));
1557 gm->header.size = htons(sizeof (struct GetMessage) - sizeof(GNUNET_HashCode));
1565 * Cancel a datastore operation. The final callback from the
1566 * operation must not have been done yet.
1568 * @param qe operation to cancel
1571 GNUNET_DATASTORE_cancel (struct GNUNET_DATASTORE_QueueEntry *qe)
1573 struct GNUNET_DATASTORE_Handle *h;
1575 GNUNET_assert (GNUNET_SYSERR != qe->was_transmitted);
1578 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1579 "Pending DATASTORE request %p cancelled (%d, %d)\n",
1581 qe->was_transmitted,
1582 h->queue_head == qe);
1584 if (GNUNET_YES == qe->was_transmitted)
1586 free_queue_entry (qe);
1587 h->skip_next_messages++;
1590 free_queue_entry (qe);
1595 /* end of datastore_api.c */