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 (NULL == (qe = h->queue_head))
594 qe->response_proc (h, msg);
599 * Transmit request from queue to datastore service.
601 * @param cls the 'struct GNUNET_DATASTORE_Handle'
602 * @param size number of bytes that can be copied to buf
603 * @param buf where to copy the drop message
604 * @return number of bytes written to buf
607 transmit_request (void *cls,
611 struct GNUNET_DATASTORE_Handle *h = cls;
612 struct GNUNET_DATASTORE_QueueEntry *qe;
616 if (NULL == (qe = h->queue_head))
617 return 0; /* no entry in queue */
620 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
621 _("Failed to transmit request to DATASTORE.\n"));
622 GNUNET_STATISTICS_update (h->stats,
623 gettext_noop ("# transmission request failures"),
629 if (size < (msize = qe->message_size))
635 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
636 "Transmitting %u byte request to DATASTORE\n",
639 memcpy (buf, &qe[1], msize);
640 qe->was_transmitted = GNUNET_YES;
641 GNUNET_SCHEDULER_cancel (qe->task);
642 qe->task = GNUNET_SCHEDULER_NO_TASK;
643 GNUNET_assert (GNUNET_NO == h->in_receive);
644 h->in_receive = GNUNET_YES;
645 GNUNET_CLIENT_receive (h->client,
648 GNUNET_TIME_absolute_get_remaining (qe->timeout));
649 GNUNET_STATISTICS_update (h->stats,
650 gettext_noop ("# bytes sent to datastore"),
658 * Process entries in the queue (or do nothing if we are already
661 * @param h handle to the datastore
664 process_queue (struct GNUNET_DATASTORE_Handle *h)
666 struct GNUNET_DATASTORE_QueueEntry *qe;
668 if (NULL == (qe = h->queue_head))
670 #if DEBUG_DATASTORE > 1
671 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
674 return; /* no entry in queue */
676 if (qe->was_transmitted == GNUNET_YES)
678 #if DEBUG_DATASTORE > 1
679 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
680 "Head request already transmitted\n");
682 return; /* waiting for replies */
686 #if DEBUG_DATASTORE > 1
687 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
688 "Pending transmission request\n");
690 return; /* request pending */
692 if (h->client == NULL)
694 #if DEBUG_DATASTORE > 1
695 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
698 return; /* waiting for reconnect */
700 if (GNUNET_YES == h->in_receive)
702 /* wait for response to previous query */
706 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
707 "Queueing %u byte request to DATASTORE\n",
710 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
712 GNUNET_TIME_absolute_get_remaining (qe->timeout),
716 GNUNET_assert (GNUNET_NO == h->in_receive);
717 GNUNET_break (NULL != h->th);
722 * Dummy continuation used to do nothing (but be non-zero).
725 * @param result result
726 * @param emsg error message
729 drop_status_cont (void *cls, int32_t result, const char *emsg)
736 * Free a queue entry. Removes the given entry from the
737 * queue and releases associated resources. Does NOT
740 * @param qe entry to free.
743 free_queue_entry (struct GNUNET_DATASTORE_QueueEntry *qe)
745 struct GNUNET_DATASTORE_Handle *h = qe->h;
747 GNUNET_CONTAINER_DLL_remove (h->queue_head,
750 if (qe->task != GNUNET_SCHEDULER_NO_TASK)
752 GNUNET_SCHEDULER_cancel (qe->task);
753 qe->task = GNUNET_SCHEDULER_NO_TASK;
756 qe->was_transmitted = GNUNET_SYSERR; /* use-after-free warning */
762 * Type of a function to call when we receive a message
766 * @param msg message received, NULL on timeout or fatal error
769 process_status_message (void *cls,
771 GNUNET_MessageHeader * msg)
773 struct GNUNET_DATASTORE_Handle *h = cls;
774 struct GNUNET_DATASTORE_QueueEntry *qe;
775 struct StatusContext rc;
776 const struct StatusMessage *sm;
781 if (h->skip_next_messages > 0)
783 h->skip_next_messages--;
787 if (NULL == (qe = h->queue_head))
796 was_transmitted = qe->was_transmitted;
797 free_queue_entry (qe);
798 if (NULL == h->client)
799 return; /* forced disconnect */
801 rc.cont (rc.cont_cls,
803 _("Failed to receive status response from database."));
804 if (was_transmitted == GNUNET_YES)
810 GNUNET_assert (GNUNET_YES == qe->was_transmitted);
811 free_queue_entry (qe);
812 if ( (ntohs(msg->size) < sizeof(struct StatusMessage)) ||
813 (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_DATASTORE_STATUS) )
816 h->retry_time = GNUNET_TIME_UNIT_ZERO;
819 rc.cont (rc.cont_cls,
821 _("Error reading response from datastore service"));
824 sm = (const struct StatusMessage*) msg;
825 status = ntohl(sm->status);
827 if (ntohs(msg->size) > sizeof(struct StatusMessage))
829 emsg = (const char*) &sm[1];
830 if (emsg[ntohs(msg->size) - sizeof(struct StatusMessage) - 1] != '\0')
833 emsg = _("Invalid error message received from datastore service");
836 if ( (status == GNUNET_SYSERR) &&
840 emsg = _("Invalid error message received from datastore service");
843 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
844 "Received status %d/%s\n",
848 GNUNET_STATISTICS_update (h->stats,
849 gettext_noop ("# status messages received"),
852 h->retry_time.rel_value = 0;
855 rc.cont (rc.cont_cls,
862 * Store an item in the datastore. If the item is already present,
863 * the priorities are summed up and the higher expiration time and
864 * lower anonymity level is used.
866 * @param h handle to the datastore
867 * @param rid reservation ID to use (from "reserve"); use 0 if no
868 * prior reservation was made
869 * @param key key for the value
870 * @param size number of bytes in data
871 * @param data content stored
872 * @param type type of the content
873 * @param priority priority of the content
874 * @param anonymity anonymity-level for the content
875 * @param replication how often should the content be replicated to other peers?
876 * @param expiration expiration time for the content
877 * @param queue_priority ranking of this request in the priority queue
878 * @param max_queue_size at what queue size should this request be dropped
879 * (if other requests of higher priority are in the queue)
880 * @param timeout timeout for the operation
881 * @param cont continuation to call when done
882 * @param cont_cls closure for cont
883 * @return NULL if the entry was not queued, otherwise a handle that can be used to
884 * cancel; note that even if NULL is returned, the callback will be invoked
885 * (or rather, will already have been invoked)
887 struct GNUNET_DATASTORE_QueueEntry *
888 GNUNET_DATASTORE_put (struct GNUNET_DATASTORE_Handle *h,
890 const GNUNET_HashCode * key,
893 enum GNUNET_BLOCK_Type type,
896 uint32_t replication,
897 struct GNUNET_TIME_Absolute expiration,
898 unsigned int queue_priority,
899 unsigned int max_queue_size,
900 struct GNUNET_TIME_Relative timeout,
901 GNUNET_DATASTORE_ContinuationWithStatus cont,
904 struct GNUNET_DATASTORE_QueueEntry *qe;
905 struct DataMessage *dm;
907 union QueueContext qc;
910 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
911 "Asked to put %u bytes of data under key `%s' for %llu ms\n",
914 GNUNET_TIME_absolute_get_remaining (expiration).rel_value);
916 msize = sizeof(struct DataMessage) + size;
917 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
919 qc.sc.cont_cls = cont_cls;
920 qe = make_queue_entry (h, msize,
921 queue_priority, max_queue_size, timeout,
922 &process_status_message, &qc);
926 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
927 "Could not create queue entry for PUT\n");
931 GNUNET_STATISTICS_update (h->stats,
932 gettext_noop ("# PUT requests executed"),
935 dm = (struct DataMessage* ) &qe[1];
936 dm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_PUT);
937 dm->header.size = htons(msize);
938 dm->rid = htonl(rid);
939 dm->size = htonl( (uint32_t) size);
940 dm->type = htonl(type);
941 dm->priority = htonl(priority);
942 dm->anonymity = htonl(anonymity);
943 dm->replication = htonl (replication);
944 dm->reserved = htonl (0);
945 dm->uid = GNUNET_htonll(0);
946 dm->expiration = GNUNET_TIME_absolute_hton(expiration);
948 memcpy (&dm[1], data, size);
955 * Reserve space in the datastore. This function should be used
956 * to avoid "out of space" failures during a longer sequence of "put"
957 * operations (for example, when a file is being inserted).
959 * @param h handle to the datastore
960 * @param amount how much space (in bytes) should be reserved (for content only)
961 * @param entries how many entries will be created (to calculate per-entry overhead)
962 * @param queue_priority ranking of this request in the priority queue
963 * @param max_queue_size at what queue size should this request be dropped
964 * (if other requests of higher priority are in the queue)
965 * @param timeout how long to wait at most for a response (or before dying in queue)
966 * @param cont continuation to call when done; "success" will be set to
967 * a positive reservation value if space could be reserved.
968 * @param cont_cls closure for cont
969 * @return NULL if the entry was not queued, otherwise a handle that can be used to
970 * cancel; note that even if NULL is returned, the callback will be invoked
971 * (or rather, will already have been invoked)
973 struct GNUNET_DATASTORE_QueueEntry *
974 GNUNET_DATASTORE_reserve (struct GNUNET_DATASTORE_Handle *h,
977 unsigned int queue_priority,
978 unsigned int max_queue_size,
979 struct GNUNET_TIME_Relative timeout,
980 GNUNET_DATASTORE_ContinuationWithStatus cont,
983 struct GNUNET_DATASTORE_QueueEntry *qe;
984 struct ReserveMessage *rm;
985 union QueueContext qc;
988 cont = &drop_status_cont;
990 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
991 "Asked to reserve %llu bytes of data and %u entries'\n",
992 (unsigned long long) amount,
993 (unsigned int) entries);
996 qc.sc.cont_cls = cont_cls;
997 qe = make_queue_entry (h, sizeof(struct ReserveMessage),
998 queue_priority, max_queue_size, timeout,
999 &process_status_message, &qc);
1003 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1004 "Could not create queue entry to reserve\n");
1008 GNUNET_STATISTICS_update (h->stats,
1009 gettext_noop ("# RESERVE requests executed"),
1012 rm = (struct ReserveMessage*) &qe[1];
1013 rm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE);
1014 rm->header.size = htons(sizeof (struct ReserveMessage));
1015 rm->entries = htonl(entries);
1016 rm->amount = GNUNET_htonll(amount);
1023 * Signal that all of the data for which a reservation was made has
1024 * been stored and that whatever excess space might have been reserved
1025 * can now be released.
1027 * @param h handle to the datastore
1028 * @param rid reservation ID (value of "success" in original continuation
1029 * from the "reserve" function).
1030 * @param queue_priority ranking of this request in the priority queue
1031 * @param max_queue_size at what queue size should this request be dropped
1032 * (if other requests of higher priority are in the queue)
1033 * @param queue_priority ranking of this request in the priority queue
1034 * @param max_queue_size at what queue size should this request be dropped
1035 * (if other requests of higher priority are in the queue)
1036 * @param timeout how long to wait at most for a response
1037 * @param cont continuation to call when done
1038 * @param cont_cls closure for cont
1039 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1040 * cancel; note that even if NULL is returned, the callback will be invoked
1041 * (or rather, will already have been invoked)
1043 struct GNUNET_DATASTORE_QueueEntry *
1044 GNUNET_DATASTORE_release_reserve (struct GNUNET_DATASTORE_Handle *h,
1046 unsigned int queue_priority,
1047 unsigned int max_queue_size,
1048 struct GNUNET_TIME_Relative timeout,
1049 GNUNET_DATASTORE_ContinuationWithStatus cont,
1052 struct GNUNET_DATASTORE_QueueEntry *qe;
1053 struct ReleaseReserveMessage *rrm;
1054 union QueueContext qc;
1057 cont = &drop_status_cont;
1059 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1060 "Asked to release reserve %d\n",
1064 qc.sc.cont_cls = cont_cls;
1065 qe = make_queue_entry (h, sizeof(struct ReleaseReserveMessage),
1066 queue_priority, max_queue_size, timeout,
1067 &process_status_message, &qc);
1071 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1072 "Could not create queue entry to release reserve\n");
1076 GNUNET_STATISTICS_update (h->stats,
1077 gettext_noop ("# RELEASE RESERVE requests executed"),
1080 rrm = (struct ReleaseReserveMessage*) &qe[1];
1081 rrm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE);
1082 rrm->header.size = htons(sizeof (struct ReleaseReserveMessage));
1083 rrm->rid = htonl(rid);
1090 * Update a value in the datastore.
1092 * @param h handle to the datastore
1093 * @param uid identifier for the value
1094 * @param priority how much to increase the priority of the value
1095 * @param expiration new expiration value should be MAX of existing and this argument
1096 * @param queue_priority ranking of this request in the priority queue
1097 * @param max_queue_size at what queue size should this request be dropped
1098 * (if other requests of higher priority are in the queue)
1099 * @param timeout how long to wait at most for a response
1100 * @param cont continuation to call when done
1101 * @param cont_cls closure for cont
1102 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1103 * cancel; note that even if NULL is returned, the callback will be invoked
1104 * (or rather, will already have been invoked)
1106 struct GNUNET_DATASTORE_QueueEntry *
1107 GNUNET_DATASTORE_update (struct GNUNET_DATASTORE_Handle *h,
1110 struct GNUNET_TIME_Absolute expiration,
1111 unsigned int queue_priority,
1112 unsigned int max_queue_size,
1113 struct GNUNET_TIME_Relative timeout,
1114 GNUNET_DATASTORE_ContinuationWithStatus cont,
1117 struct GNUNET_DATASTORE_QueueEntry *qe;
1118 struct UpdateMessage *um;
1119 union QueueContext qc;
1122 cont = &drop_status_cont;
1124 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1125 "Asked to update entry %llu raising priority by %u and expiration to %llu\n",
1127 (unsigned int) priority,
1128 (unsigned long long) expiration.abs_value);
1131 qc.sc.cont_cls = cont_cls;
1132 qe = make_queue_entry (h, sizeof(struct UpdateMessage),
1133 queue_priority, max_queue_size, timeout,
1134 &process_status_message, &qc);
1138 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1139 "Could not create queue entry for UPDATE\n");
1143 GNUNET_STATISTICS_update (h->stats,
1144 gettext_noop ("# UPDATE requests executed"),
1147 um = (struct UpdateMessage*) &qe[1];
1148 um->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE);
1149 um->header.size = htons(sizeof (struct UpdateMessage));
1150 um->priority = htonl(priority);
1151 um->expiration = GNUNET_TIME_absolute_hton(expiration);
1152 um->uid = GNUNET_htonll(uid);
1159 * Explicitly remove some content from the database.
1160 * The "cont"inuation will be called with status
1161 * "GNUNET_OK" if content was removed, "GNUNET_NO"
1162 * if no matching entry was found and "GNUNET_SYSERR"
1163 * on all other types of errors.
1165 * @param h handle to the datastore
1166 * @param key key for the value
1167 * @param size number of bytes in data
1168 * @param data content stored
1169 * @param queue_priority ranking of this request in the priority queue
1170 * @param max_queue_size at what queue size should this request be dropped
1171 * (if other requests of higher priority are in the queue)
1172 * @param timeout how long to wait at most for a response
1173 * @param cont continuation to call when done
1174 * @param cont_cls closure for cont
1175 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1176 * cancel; note that even if NULL is returned, the callback will be invoked
1177 * (or rather, will already have been invoked)
1179 struct GNUNET_DATASTORE_QueueEntry *
1180 GNUNET_DATASTORE_remove (struct GNUNET_DATASTORE_Handle *h,
1181 const GNUNET_HashCode *key,
1184 unsigned int queue_priority,
1185 unsigned int max_queue_size,
1186 struct GNUNET_TIME_Relative timeout,
1187 GNUNET_DATASTORE_ContinuationWithStatus cont,
1190 struct GNUNET_DATASTORE_QueueEntry *qe;
1191 struct DataMessage *dm;
1193 union QueueContext qc;
1196 cont = &drop_status_cont;
1198 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1199 "Asked to remove %u bytes under key `%s'\n",
1204 qc.sc.cont_cls = cont_cls;
1205 msize = sizeof(struct DataMessage) + size;
1206 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
1207 qe = make_queue_entry (h, msize,
1208 queue_priority, max_queue_size, timeout,
1209 &process_status_message, &qc);
1213 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1214 "Could not create queue entry for REMOVE\n");
1218 GNUNET_STATISTICS_update (h->stats,
1219 gettext_noop ("# REMOVE requests executed"),
1222 dm = (struct DataMessage*) &qe[1];
1223 dm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE);
1224 dm->header.size = htons(msize);
1226 dm->size = htonl(size);
1227 dm->type = htonl(0);
1228 dm->priority = htonl(0);
1229 dm->anonymity = htonl(0);
1230 dm->uid = GNUNET_htonll(0);
1231 dm->expiration = GNUNET_TIME_absolute_hton(GNUNET_TIME_UNIT_ZERO_ABS);
1233 memcpy (&dm[1], data, size);
1240 * Type of a function to call when we receive a message
1243 * @param cls closure
1244 * @param msg message received, NULL on timeout or fatal error
1247 process_result_message (void *cls,
1248 const struct GNUNET_MessageHeader *msg)
1250 struct GNUNET_DATASTORE_Handle *h = cls;
1251 struct GNUNET_DATASTORE_QueueEntry *qe;
1252 struct ResultContext rc;
1253 const struct DataMessage *dm;
1255 if (h->skip_next_messages > 0)
1257 h->skip_next_messages--;
1264 GNUNET_assert (NULL != qe);
1265 if (qe->was_transmitted == GNUNET_YES)
1268 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1269 _("Failed to receive response from database.\n"));
1271 free_queue_entry (qe);
1272 if (rc.proc != NULL)
1273 rc.proc (rc.proc_cls,
1274 NULL, 0, NULL, 0, 0, 0,
1275 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1281 if (ntohs(msg->type) == GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END)
1283 GNUNET_break (ntohs(msg->size) == sizeof(struct GNUNET_MessageHeader));
1286 GNUNET_assert (GNUNET_YES == qe->was_transmitted);
1287 free_queue_entry (qe);
1289 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1290 "Received end of result set, new queue size is %u\n",
1293 if (rc.proc != NULL)
1294 rc.proc (rc.proc_cls,
1295 NULL, 0, NULL, 0, 0, 0,
1296 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1297 h->retry_time.rel_value = 0;
1298 h->result_count = 0;
1304 GNUNET_assert (GNUNET_YES == qe->was_transmitted);
1305 if ( (ntohs(msg->size) < sizeof(struct DataMessage)) ||
1306 (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_DATASTORE_DATA) ||
1307 (ntohs(msg->size) != sizeof(struct DataMessage) + ntohl (((const struct DataMessage*)msg)->size)) )
1310 free_queue_entry (qe);
1311 h->retry_time = GNUNET_TIME_UNIT_ZERO;
1313 if (rc.proc != NULL)
1314 rc.proc (rc.proc_cls,
1315 NULL, 0, NULL, 0, 0, 0,
1316 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1319 GNUNET_STATISTICS_update (h->stats,
1320 gettext_noop ("# Results received"),
1323 dm = (const struct DataMessage*) msg;
1325 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1326 "Received result %llu with type %u and size %u with key %s\n",
1327 (unsigned long long) GNUNET_ntohll(dm->uid),
1330 GNUNET_h2s(&dm->key));
1332 free_queue_entry (qe);
1333 h->retry_time.rel_value = 0;
1335 if (rc.proc != NULL)
1336 rc.proc (rc.proc_cls,
1341 ntohl(dm->priority),
1342 ntohl(dm->anonymity),
1343 GNUNET_TIME_absolute_ntoh(dm->expiration),
1344 GNUNET_ntohll(dm->uid));
1349 * Get a random value from the datastore for content replication.
1350 * Returns a single, random value among those with the highest
1351 * replication score, lowering positive replication scores by one for
1352 * the chosen value (if only content with a replication score exists,
1353 * a random value is returned and replication scores are not changed).
1355 * @param h handle to the datastore
1356 * @param queue_priority ranking of this request in the priority queue
1357 * @param max_queue_size at what queue size should this request be dropped
1358 * (if other requests of higher priority are in the queue)
1359 * @param timeout how long to wait at most for a response
1360 * @param proc function to call on a random value; it
1361 * will be called once with a value (if available)
1362 * and always once with a value of NULL.
1363 * @param proc_cls closure for proc
1364 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1367 struct GNUNET_DATASTORE_QueueEntry *
1368 GNUNET_DATASTORE_get_for_replication (struct GNUNET_DATASTORE_Handle *h,
1369 unsigned int queue_priority,
1370 unsigned int max_queue_size,
1371 struct GNUNET_TIME_Relative timeout,
1372 GNUNET_DATASTORE_DatumProcessor proc,
1375 struct GNUNET_DATASTORE_QueueEntry *qe;
1376 struct GNUNET_MessageHeader *m;
1377 union QueueContext qc;
1379 GNUNET_assert (NULL != proc);
1381 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1382 "Asked to get replication entry in %llu ms\n",
1383 (unsigned long long) timeout.rel_value);
1386 qc.rc.proc_cls = proc_cls;
1387 qe = make_queue_entry (h, sizeof(struct GNUNET_MessageHeader),
1388 queue_priority, max_queue_size, timeout,
1389 &process_result_message, &qc);
1393 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1394 "Could not create queue entry for GET REPLICATION\n");
1398 GNUNET_STATISTICS_update (h->stats,
1399 gettext_noop ("# GET REPLICATION requests executed"),
1402 m = (struct GNUNET_MessageHeader*) &qe[1];
1403 m->type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_GET_REPLICATION);
1404 m->size = htons(sizeof (struct GNUNET_MessageHeader));
1411 * Get a single zero-anonymity value from the datastore.
1413 * @param h handle to the datastore
1414 * @param offset offset of the result (mod #num-results); set to
1415 * a random 64-bit value initially; then increment by
1416 * one each time; detect that all results have been found by uid
1417 * being again the first uid ever returned.
1418 * @param queue_priority ranking of this request in the priority queue
1419 * @param max_queue_size at what queue size should this request be dropped
1420 * (if other requests of higher priority are in the queue)
1421 * @param timeout how long to wait at most for a response
1422 * @param type allowed type for the operation (never zero)
1423 * @param proc function to call on a random value; it
1424 * will be called once with a value (if available)
1425 * or with NULL if none value exists.
1426 * @param proc_cls closure for proc
1427 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1430 struct GNUNET_DATASTORE_QueueEntry *
1431 GNUNET_DATASTORE_get_zero_anonymity (struct GNUNET_DATASTORE_Handle *h,
1433 unsigned int queue_priority,
1434 unsigned int max_queue_size,
1435 struct GNUNET_TIME_Relative timeout,
1436 enum GNUNET_BLOCK_Type type,
1437 GNUNET_DATASTORE_DatumProcessor proc,
1440 struct GNUNET_DATASTORE_QueueEntry *qe;
1441 struct GetZeroAnonymityMessage *m;
1442 union QueueContext qc;
1444 GNUNET_assert (NULL != proc);
1445 GNUNET_assert (type != GNUNET_BLOCK_TYPE_ANY);
1447 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1448 "Asked to get %llu-th zero-anonymity entry of type %d in %llu ms\n",
1449 (unsigned long long) offset,
1451 (unsigned long long) timeout.rel_value);
1454 qc.rc.proc_cls = proc_cls;
1455 qe = make_queue_entry (h, sizeof(struct GetZeroAnonymityMessage),
1456 queue_priority, max_queue_size, timeout,
1457 &process_result_message, &qc);
1461 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1462 "Could not create queue entry for zero-anonymity procation\n");
1466 GNUNET_STATISTICS_update (h->stats,
1467 gettext_noop ("# GET ZERO ANONYMITY requests executed"),
1470 m = (struct GetZeroAnonymityMessage*) &qe[1];
1471 m->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_GET_ZERO_ANONYMITY);
1472 m->header.size = htons(sizeof (struct GetZeroAnonymityMessage));
1473 m->type = htonl ((uint32_t) type);
1474 m->offset = GNUNET_htonll (offset);
1481 * Get a result for a particular key from the datastore. The processor
1482 * will only be called once.
1484 * @param h handle to the datastore
1485 * @param offset offset of the result (mod #num-results); set to
1486 * a random 64-bit value initially; then increment by
1487 * one each time; detect that all results have been found by uid
1488 * being again the first uid ever returned.
1489 * @param key maybe NULL (to match all entries)
1490 * @param type desired type, 0 for any
1491 * @param queue_priority ranking of this request in the priority queue
1492 * @param max_queue_size at what queue size should this request be dropped
1493 * (if other requests of higher priority are in the queue)
1494 * @param timeout how long to wait at most for a response
1495 * @param proc function to call on each matching value;
1496 * will be called once with a NULL value at the end
1497 * @param proc_cls closure for proc
1498 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1501 struct GNUNET_DATASTORE_QueueEntry *
1502 GNUNET_DATASTORE_get_key (struct GNUNET_DATASTORE_Handle *h,
1504 const GNUNET_HashCode * key,
1505 enum GNUNET_BLOCK_Type type,
1506 unsigned int queue_priority,
1507 unsigned int max_queue_size,
1508 struct GNUNET_TIME_Relative timeout,
1509 GNUNET_DATASTORE_DatumProcessor proc,
1512 struct GNUNET_DATASTORE_QueueEntry *qe;
1513 struct GetMessage *gm;
1514 union QueueContext qc;
1516 GNUNET_assert (NULL != proc);
1518 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1519 "Asked to look for data of type %u under key `%s'\n",
1520 (unsigned int) type,
1524 qc.rc.proc_cls = proc_cls;
1525 qe = make_queue_entry (h, sizeof(struct GetMessage),
1526 queue_priority, max_queue_size, timeout,
1527 &process_result_message, &qc);
1531 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1532 "Could not queue request for `%s'\n",
1537 GNUNET_STATISTICS_update (h->stats,
1538 gettext_noop ("# GET requests executed"),
1541 gm = (struct GetMessage*) &qe[1];
1542 gm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_GET);
1543 gm->type = htonl(type);
1544 gm->offset = GNUNET_htonll (offset);
1547 gm->header.size = htons(sizeof (struct GetMessage));
1552 gm->header.size = htons(sizeof (struct GetMessage) - sizeof(GNUNET_HashCode));
1560 * Cancel a datastore operation. The final callback from the
1561 * operation must not have been done yet.
1563 * @param qe operation to cancel
1566 GNUNET_DATASTORE_cancel (struct GNUNET_DATASTORE_QueueEntry *qe)
1568 struct GNUNET_DATASTORE_Handle *h;
1570 GNUNET_assert (GNUNET_SYSERR != qe->was_transmitted);
1573 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1574 "Pending DATASTORE request %p cancelled (%d, %d)\n",
1576 qe->was_transmitted,
1577 h->queue_head == qe);
1579 if (GNUNET_YES == qe->was_transmitted)
1581 free_queue_entry (qe);
1582 h->skip_next_messages++;
1585 free_queue_entry (qe);
1590 /* end of datastore_api.c */