2 This file is part of GNUnet
3 (C) 2004, 2005, 2006, 2007, 2009, 2010 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 "datastore.h"
35 * Context for processing status messages.
40 * Continuation to call with the status.
42 GNUNET_DATASTORE_ContinuationWithStatus cont;
53 * Context for processing result messages.
58 * Iterator to call with the result.
60 GNUNET_DATASTORE_Iterator iter;
71 * Context for a queue operation.
76 struct StatusContext sc;
78 struct ResultContext rc;
85 * Entry in our priority queue.
87 struct GNUNET_DATASTORE_QueueEntry
91 * This is a linked list.
93 struct GNUNET_DATASTORE_QueueEntry *next;
96 * This is a linked list.
98 struct GNUNET_DATASTORE_QueueEntry *prev;
101 * Handle to the master context.
103 struct GNUNET_DATASTORE_Handle *h;
106 * Response processor (NULL if we are not waiting for a response).
107 * This struct should be used for the closure, function-specific
108 * arguments can be passed via 'qc'.
110 GNUNET_CLIENT_MessageHandler response_proc;
113 * Function to call after transmission of the request.
115 GNUNET_DATASTORE_ContinuationWithStatus cont;
118 * Closure for 'cont'.
123 * Context for the operation.
125 union QueueContext qc;
128 * Task for timeout signalling.
130 GNUNET_SCHEDULER_TaskIdentifier task;
133 * Timeout for the current operation.
135 struct GNUNET_TIME_Absolute timeout;
138 * Priority in the queue.
140 unsigned int priority;
143 * Maximum allowed length of queue (otherwise
144 * this request should be discarded).
146 unsigned int max_queue;
149 * Number of bytes in the request message following
150 * this struct. 32-bit value for nicer memory
151 * access (and overall struct alignment).
153 uint32_t message_size;
156 * Has this message been transmitted to the service?
157 * Only ever GNUNET_YES for the head of the queue.
158 * Note that the overall struct should end at a
159 * multiple of 64 bits.
161 int32_t was_transmitted;
166 * Handle to the datastore service.
168 struct GNUNET_DATASTORE_Handle
174 const struct GNUNET_CONFIGURATION_Handle *cfg;
179 struct GNUNET_SCHEDULER_Handle *sched;
182 * Current connection to the datastore service.
184 struct GNUNET_CLIENT_Connection *client;
187 * Current transmit handle.
189 struct GNUNET_CLIENT_TransmitHandle *th;
192 * Current head of priority queue.
194 struct GNUNET_DATASTORE_QueueEntry *queue_head;
197 * Current tail of priority queue.
199 struct GNUNET_DATASTORE_QueueEntry *queue_tail;
202 * Task for trying to reconnect.
204 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
207 * How quickly should we retry? Used for exponential back-off on
210 struct GNUNET_TIME_Relative retry_time;
213 * Number of entries in the queue.
215 unsigned int queue_size;
218 * Are we currently trying to receive from the service?
227 * Connect to the datastore service.
229 * @param cfg configuration to use
230 * @param sched scheduler to use
231 * @return handle to use to access the service
233 struct GNUNET_DATASTORE_Handle *
234 GNUNET_DATASTORE_connect (const struct
235 GNUNET_CONFIGURATION_Handle
238 GNUNET_SCHEDULER_Handle
241 struct GNUNET_CLIENT_Connection *c;
242 struct GNUNET_DATASTORE_Handle *h;
244 c = GNUNET_CLIENT_connect (sched, "datastore", cfg);
246 return NULL; /* oops */
247 h = GNUNET_malloc (sizeof(struct GNUNET_DATASTORE_Handle) +
248 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1);
257 * Transmit DROP message to datastore service.
259 * @param cls the 'struct GNUNET_DATASTORE_Handle'
260 * @param size number of bytes that can be copied to buf
261 * @param buf where to copy the drop message
262 * @return number of bytes written to buf
265 transmit_drop (void *cls,
269 struct GNUNET_DATASTORE_Handle *h = cls;
270 struct GNUNET_MessageHeader *hdr;
274 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
275 _("Failed to transmit request to drop database.\n"));
276 GNUNET_DATASTORE_disconnect (h, GNUNET_NO);
279 GNUNET_assert (size >= sizeof(struct GNUNET_MessageHeader));
281 hdr->size = htons(sizeof(struct GNUNET_MessageHeader));
282 hdr->type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_DROP);
283 GNUNET_DATASTORE_disconnect (h, GNUNET_NO);
284 return sizeof(struct GNUNET_MessageHeader);
289 * Disconnect from the datastore service (and free
290 * associated resources).
292 * @param h handle to the datastore
293 * @param drop set to GNUNET_YES to delete all data in datastore (!)
295 void GNUNET_DATASTORE_disconnect (struct GNUNET_DATASTORE_Handle *h,
298 struct GNUNET_DATASTORE_QueueEntry *qe;
300 if (h->client != NULL)
302 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
305 if (h->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
307 GNUNET_SCHEDULER_cancel (h->sched,
309 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
311 while (NULL != (qe = h->queue_head))
313 GNUNET_assert (NULL != qe->response_proc);
314 qe->response_proc (qe, NULL);
316 if (GNUNET_YES == drop)
318 h->client = GNUNET_CLIENT_connect (h->sched, "datastore", h->cfg);
319 if (h->client != NULL)
322 GNUNET_CLIENT_notify_transmit_ready (h->client,
323 sizeof(struct GNUNET_MessageHeader),
324 GNUNET_TIME_UNIT_MINUTES,
329 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
338 * A request has timed out (before being transmitted to the service).
340 * @param cls the 'struct GNUNET_DATASTORE_QueueEntry'
341 * @param tc scheduler context
344 timeout_queue_entry (void *cls,
345 const struct GNUNET_SCHEDULER_TaskContext *tc)
347 struct GNUNET_DATASTORE_QueueEntry *qe = cls;
349 qe->task = GNUNET_SCHEDULER_NO_TASK;
350 GNUNET_assert (qe->was_transmitted == GNUNET_NO);
351 qe->response_proc (qe, NULL);
356 * Create a new entry for our priority queue (and possibly discard other entires if
357 * the queue is getting too long).
359 * @param h handle to the datastore
360 * @param msize size of the message to queue
361 * @param queue_priority priority of the entry
362 * @param max_queue_size at what queue size should this request be dropped
363 * (if other requests of higher priority are in the queue)
364 * @param timeout timeout for the operation
365 * @param response_proc function to call with replies (can be NULL)
366 * @param qc client context (NOT a closure for response_proc)
367 * @return NULL if the queue is full (and this entry was dropped)
369 static struct GNUNET_DATASTORE_QueueEntry *
370 make_queue_entry (struct GNUNET_DATASTORE_Handle *h,
372 unsigned int queue_priority,
373 unsigned int max_queue_size,
374 struct GNUNET_TIME_Relative timeout,
375 GNUNET_CLIENT_MessageHandler response_proc,
376 const union QueueContext *qc)
378 struct GNUNET_DATASTORE_QueueEntry *ret;
379 struct GNUNET_DATASTORE_QueueEntry *pos;
384 while ( (pos != NULL) &&
385 (c < max_queue_size) &&
386 (pos->priority >= queue_priority) )
391 ret = GNUNET_malloc (sizeof (struct GNUNET_DATASTORE_QueueEntry) + msize);
393 ret->response_proc = response_proc;
395 ret->timeout = GNUNET_TIME_relative_to_absolute (timeout);
396 ret->priority = queue_priority;
397 ret->max_queue = max_queue_size;
398 ret->message_size = msize;
399 ret->was_transmitted = GNUNET_NO;
402 /* append at the tail */
408 /* do not insert at HEAD if HEAD query was already
409 transmitted and we are still receiving replies! */
410 if ( (pos == NULL) &&
411 (h->queue_head->was_transmitted) )
415 GNUNET_CONTAINER_DLL_insert_after (h->queue_head,
420 if (c > max_queue_size)
422 response_proc (ret, NULL);
425 ret->task = GNUNET_SCHEDULER_add_delayed (h->sched,
427 &timeout_queue_entry,
432 if (pos->max_queue < h->queue_size)
434 GNUNET_assert (pos->response_proc != NULL);
435 pos->response_proc (pos, NULL);
445 * Process entries in the queue (or do nothing if we are already
448 * @param h handle to the datastore
451 process_queue (struct GNUNET_DATASTORE_Handle *h);
455 * Try reconnecting to the datastore service.
457 * @param cls the 'struct GNUNET_DATASTORE_Handle'
458 * @param tc scheduler context
461 try_reconnect (void *cls,
462 const struct GNUNET_SCHEDULER_TaskContext *tc)
464 struct GNUNET_DATASTORE_Handle *h = cls;
466 if (h->retry_time.value < GNUNET_CONSTANTS_SERVICE_RETRY.value)
467 h->retry_time = GNUNET_CONSTANTS_SERVICE_RETRY;
469 h->retry_time = GNUNET_TIME_relative_multiply (h->retry_time, 2);
470 if (h->retry_time.value > GNUNET_CONSTANTS_SERVICE_TIMEOUT.value)
471 h->retry_time = GNUNET_CONSTANTS_SERVICE_TIMEOUT;
472 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
473 h->client = GNUNET_CLIENT_connect (h->sched, "datastore", h->cfg);
474 if (h->client == NULL)
476 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
477 "DATASTORE reconnect failed (fatally)\n");
481 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
482 "Reconnected to DATASTORE\n");
489 * Disconnect from the service and then try reconnecting to the datastore service
492 * @param h handle to datastore to disconnect and reconnect
495 do_disconnect (struct GNUNET_DATASTORE_Handle *h)
497 if (h->client == NULL)
500 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
501 "client NULL in disconnect, will not try to reconnect\n");
506 GNUNET_STATISTICS_update (stats,
507 gettext_noop ("# reconnected to DATASTORE"),
511 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
513 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->sched,
521 * Transmit request from queue to datastore service.
523 * @param cls the 'struct GNUNET_DATASTORE_Handle'
524 * @param size number of bytes that can be copied to buf
525 * @param buf where to copy the drop message
526 * @return number of bytes written to buf
529 transmit_request (void *cls,
533 struct GNUNET_DATASTORE_Handle *h = cls;
534 struct GNUNET_DATASTORE_QueueEntry *qe;
538 if (NULL == (qe = h->queue_head))
539 return 0; /* no entry in queue */
542 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
543 _("Failed to transmit request to DATASTORE.\n"));
547 if (size < (msize = qe->message_size))
553 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
554 "Transmitting %u byte request to DATASTORE\n",
557 memcpy (buf, &qe[1], msize);
558 qe->was_transmitted = GNUNET_YES;
559 GNUNET_SCHEDULER_cancel (h->sched,
561 qe->task = GNUNET_SCHEDULER_NO_TASK;
562 h->in_receive = GNUNET_YES;
563 GNUNET_CLIENT_receive (h->client,
566 GNUNET_TIME_absolute_get_remaining (qe->timeout));
572 * Process entries in the queue (or do nothing if we are already
575 * @param h handle to the datastore
578 process_queue (struct GNUNET_DATASTORE_Handle *h)
580 struct GNUNET_DATASTORE_QueueEntry *qe;
582 if (NULL == (qe = h->queue_head))
584 #if DEBUG_DATASTORE > 1
585 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
588 return; /* no entry in queue */
590 if (qe->was_transmitted == GNUNET_YES)
592 #if DEBUG_DATASTORE > 1
593 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
594 "Head request already transmitted\n");
596 return; /* waiting for replies */
600 #if DEBUG_DATASTORE > 1
601 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
602 "Pending transmission request\n");
604 return; /* request pending */
606 if (h->client == NULL)
608 #if DEBUG_DATASTORE > 1
609 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
612 return; /* waiting for reconnect */
615 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
616 "Queueing %u byte request to DATASTORE\n",
619 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
621 GNUNET_TIME_absolute_get_remaining (qe->timeout),
629 * Dummy continuation used to do nothing (but be non-zero).
632 * @param result result
633 * @param emsg error message
636 drop_status_cont (void *cls, int result, const char *emsg)
643 free_queue_entry (struct GNUNET_DATASTORE_QueueEntry *qe)
645 struct GNUNET_DATASTORE_Handle *h = qe->h;
647 GNUNET_CONTAINER_DLL_remove (h->queue_head,
650 if (qe->task != GNUNET_SCHEDULER_NO_TASK)
652 GNUNET_SCHEDULER_cancel (h->sched,
654 qe->task = GNUNET_SCHEDULER_NO_TASK;
661 * Type of a function to call when we receive a message
665 * @param msg message received, NULL on timeout or fatal error
668 process_status_message (void *cls,
670 GNUNET_MessageHeader * msg)
672 struct GNUNET_DATASTORE_QueueEntry *qe = cls;
673 struct GNUNET_DATASTORE_Handle *h = qe->h;
674 struct StatusContext rc = qe->qc.sc;
675 const struct StatusMessage *sm;
680 h->in_receive = GNUNET_NO;
681 was_transmitted = qe->was_transmitted;
684 free_queue_entry (qe);
685 if (NULL == h->client)
686 return; /* forced disconnect */
688 rc.cont (rc.cont_cls,
690 _("Failed to receive status response from database."));
691 if (was_transmitted == GNUNET_YES)
695 GNUNET_assert (GNUNET_YES == qe->was_transmitted);
696 GNUNET_assert (h->queue_head == qe);
697 free_queue_entry (qe);
698 if ( (ntohs(msg->size) < sizeof(struct StatusMessage)) ||
699 (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_DATASTORE_STATUS) )
702 h->retry_time = GNUNET_TIME_UNIT_ZERO;
705 rc.cont (rc.cont_cls,
707 _("Error reading response from datastore service"));
710 sm = (const struct StatusMessage*) msg;
711 status = ntohl(sm->status);
713 if (ntohs(msg->size) > sizeof(struct StatusMessage))
715 emsg = (const char*) &sm[1];
716 if (emsg[ntohs(msg->size) - sizeof(struct StatusMessage) - 1] != '\0')
719 emsg = _("Invalid error message received from datastore service");
722 if ( (status == GNUNET_SYSERR) &&
726 emsg = _("Invalid error message received from datastore service");
729 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
730 "Received status %d/%s\n",
736 rc.cont (rc.cont_cls,
743 * Store an item in the datastore. If the item is already present,
744 * the priorities are summed up and the higher expiration time and
745 * lower anonymity level is used.
747 * @param h handle to the datastore
748 * @param rid reservation ID to use (from "reserve"); use 0 if no
749 * prior reservation was made
750 * @param key key for the value
751 * @param size number of bytes in data
752 * @param data content stored
753 * @param type type of the content
754 * @param priority priority of the content
755 * @param anonymity anonymity-level for the content
756 * @param expiration expiration time for the content
757 * @param queue_priority ranking of this request in the priority queue
758 * @param max_queue_size at what queue size should this request be dropped
759 * (if other requests of higher priority are in the queue)
760 * @param timeout timeout for the operation
761 * @param cont continuation to call when done
762 * @param cont_cls closure for cont
763 * @return NULL if the entry was not queued, otherwise a handle that can be used to
764 * cancel; note that even if NULL is returned, the callback will be invoked
765 * (or rather, will already have been invoked)
767 struct GNUNET_DATASTORE_QueueEntry *
768 GNUNET_DATASTORE_put (struct GNUNET_DATASTORE_Handle *h,
770 const GNUNET_HashCode * key,
773 enum GNUNET_BLOCK_Type type,
776 struct GNUNET_TIME_Absolute expiration,
777 unsigned int queue_priority,
778 unsigned int max_queue_size,
779 struct GNUNET_TIME_Relative timeout,
780 GNUNET_DATASTORE_ContinuationWithStatus cont,
783 struct GNUNET_DATASTORE_QueueEntry *qe;
784 struct DataMessage *dm;
786 union QueueContext qc;
789 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
790 "Asked to put %u bytes of data under key `%s'\n",
794 msize = sizeof(struct DataMessage) + size;
795 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
797 qc.sc.cont_cls = cont_cls;
798 qe = make_queue_entry (h, msize,
799 queue_priority, max_queue_size, timeout,
800 &process_status_message, &qc);
803 dm = (struct DataMessage* ) &qe[1];
804 dm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_PUT);
805 dm->header.size = htons(msize);
806 dm->rid = htonl(rid);
807 dm->size = htonl( (uint32_t) size);
808 dm->type = htonl(type);
809 dm->priority = htonl(priority);
810 dm->anonymity = htonl(anonymity);
811 dm->uid = GNUNET_htonll(0);
812 dm->expiration = GNUNET_TIME_absolute_hton(expiration);
814 memcpy (&dm[1], data, size);
821 * Reserve space in the datastore. This function should be used
822 * to avoid "out of space" failures during a longer sequence of "put"
823 * operations (for example, when a file is being inserted).
825 * @param h handle to the datastore
826 * @param amount how much space (in bytes) should be reserved (for content only)
827 * @param entries how many entries will be created (to calculate per-entry overhead)
828 * @param queue_priority ranking of this request in the priority queue
829 * @param max_queue_size at what queue size should this request be dropped
830 * (if other requests of higher priority are in the queue)
831 * @param timeout how long to wait at most for a response (or before dying in queue)
832 * @param cont continuation to call when done; "success" will be set to
833 * a positive reservation value if space could be reserved.
834 * @param cont_cls closure for cont
835 * @return NULL if the entry was not queued, otherwise a handle that can be used to
836 * cancel; note that even if NULL is returned, the callback will be invoked
837 * (or rather, will already have been invoked)
839 struct GNUNET_DATASTORE_QueueEntry *
840 GNUNET_DATASTORE_reserve (struct GNUNET_DATASTORE_Handle *h,
843 unsigned int queue_priority,
844 unsigned int max_queue_size,
845 struct GNUNET_TIME_Relative timeout,
846 GNUNET_DATASTORE_ContinuationWithStatus cont,
849 struct GNUNET_DATASTORE_QueueEntry *qe;
850 struct ReserveMessage *rm;
851 union QueueContext qc;
854 cont = &drop_status_cont;
856 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
857 "Asked to reserve %llu bytes of data and %u entries'\n",
858 (unsigned long long) amount,
859 (unsigned int) entries);
862 qc.sc.cont_cls = cont_cls;
863 qe = make_queue_entry (h, sizeof(struct ReserveMessage),
864 queue_priority, max_queue_size, timeout,
865 &process_status_message, &qc);
868 rm = (struct ReserveMessage*) &qe[1];
869 rm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE);
870 rm->header.size = htons(sizeof (struct ReserveMessage));
871 rm->entries = htonl(entries);
872 rm->amount = GNUNET_htonll(amount);
879 * Signal that all of the data for which a reservation was made has
880 * been stored and that whatever excess space might have been reserved
881 * can now be released.
883 * @param h handle to the datastore
884 * @param rid reservation ID (value of "success" in original continuation
885 * from the "reserve" function).
886 * @param queue_priority ranking of this request in the priority queue
887 * @param max_queue_size at what queue size should this request be dropped
888 * (if other requests of higher priority are in the queue)
889 * @param queue_priority ranking of this request in the priority queue
890 * @param max_queue_size at what queue size should this request be dropped
891 * (if other requests of higher priority are in the queue)
892 * @param timeout how long to wait at most for a response
893 * @param cont continuation to call when done
894 * @param cont_cls closure for cont
895 * @return NULL if the entry was not queued, otherwise a handle that can be used to
896 * cancel; note that even if NULL is returned, the callback will be invoked
897 * (or rather, will already have been invoked)
899 struct GNUNET_DATASTORE_QueueEntry *
900 GNUNET_DATASTORE_release_reserve (struct GNUNET_DATASTORE_Handle *h,
902 unsigned int queue_priority,
903 unsigned int max_queue_size,
904 struct GNUNET_TIME_Relative timeout,
905 GNUNET_DATASTORE_ContinuationWithStatus cont,
908 struct GNUNET_DATASTORE_QueueEntry *qe;
909 struct ReleaseReserveMessage *rrm;
910 union QueueContext qc;
913 cont = &drop_status_cont;
915 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
916 "Asked to release reserve %d\n",
920 qc.sc.cont_cls = cont_cls;
921 qe = make_queue_entry (h, sizeof(struct ReleaseReserveMessage),
922 queue_priority, max_queue_size, timeout,
923 &process_status_message, &qc);
926 rrm = (struct ReleaseReserveMessage*) &qe[1];
927 rrm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE);
928 rrm->header.size = htons(sizeof (struct ReleaseReserveMessage));
929 rrm->rid = htonl(rid);
936 * Update a value in the datastore.
938 * @param h handle to the datastore
939 * @param uid identifier for the value
940 * @param priority how much to increase the priority of the value
941 * @param expiration new expiration value should be MAX of existing and this argument
942 * @param queue_priority ranking of this request in the priority queue
943 * @param max_queue_size at what queue size should this request be dropped
944 * (if other requests of higher priority are in the queue)
945 * @param timeout how long to wait at most for a response
946 * @param cont continuation to call when done
947 * @param cont_cls closure for cont
948 * @return NULL if the entry was not queued, otherwise a handle that can be used to
949 * cancel; note that even if NULL is returned, the callback will be invoked
950 * (or rather, will already have been invoked)
952 struct GNUNET_DATASTORE_QueueEntry *
953 GNUNET_DATASTORE_update (struct GNUNET_DATASTORE_Handle *h,
954 unsigned long long uid,
956 struct GNUNET_TIME_Absolute expiration,
957 unsigned int queue_priority,
958 unsigned int max_queue_size,
959 struct GNUNET_TIME_Relative timeout,
960 GNUNET_DATASTORE_ContinuationWithStatus cont,
963 struct GNUNET_DATASTORE_QueueEntry *qe;
964 struct UpdateMessage *um;
965 union QueueContext qc;
968 cont = &drop_status_cont;
970 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
971 "Asked to update entry %llu raising priority by %u and expiration to %llu\n",
973 (unsigned int) priority,
974 (unsigned long long) expiration.value);
977 qc.sc.cont_cls = cont_cls;
978 qe = make_queue_entry (h, sizeof(struct UpdateMessage),
979 queue_priority, max_queue_size, timeout,
980 &process_status_message, &qc);
983 um = (struct UpdateMessage*) &qe[1];
984 um->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE);
985 um->header.size = htons(sizeof (struct UpdateMessage));
986 um->priority = htonl(priority);
987 um->expiration = GNUNET_TIME_absolute_hton(expiration);
988 um->uid = GNUNET_htonll(uid);
995 * Explicitly remove some content from the database.
996 * The "cont"inuation will be called with status
997 * "GNUNET_OK" if content was removed, "GNUNET_NO"
998 * if no matching entry was found and "GNUNET_SYSERR"
999 * on all other types of errors.
1001 * @param h handle to the datastore
1002 * @param key key for the value
1003 * @param size number of bytes in data
1004 * @param data content stored
1005 * @param queue_priority ranking of this request in the priority queue
1006 * @param max_queue_size at what queue size should this request be dropped
1007 * (if other requests of higher priority are in the queue)
1008 * @param timeout how long to wait at most for a response
1009 * @param cont continuation to call when done
1010 * @param cont_cls closure for cont
1011 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1012 * cancel; note that even if NULL is returned, the callback will be invoked
1013 * (or rather, will already have been invoked)
1015 struct GNUNET_DATASTORE_QueueEntry *
1016 GNUNET_DATASTORE_remove (struct GNUNET_DATASTORE_Handle *h,
1017 const GNUNET_HashCode *key,
1020 unsigned int queue_priority,
1021 unsigned int max_queue_size,
1022 struct GNUNET_TIME_Relative timeout,
1023 GNUNET_DATASTORE_ContinuationWithStatus cont,
1026 struct GNUNET_DATASTORE_QueueEntry *qe;
1027 struct DataMessage *dm;
1029 union QueueContext qc;
1032 cont = &drop_status_cont;
1034 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1035 "Asked to remove %u bytes under key `%s'\n",
1040 qc.sc.cont_cls = cont_cls;
1041 msize = sizeof(struct DataMessage) + size;
1042 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
1043 qe = make_queue_entry (h, msize,
1044 queue_priority, max_queue_size, timeout,
1045 &process_status_message, &qc);
1048 dm = (struct DataMessage*) &qe[1];
1049 dm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE);
1050 dm->header.size = htons(msize);
1052 dm->size = htonl(size);
1053 dm->type = htonl(0);
1054 dm->priority = htonl(0);
1055 dm->anonymity = htonl(0);
1056 dm->uid = GNUNET_htonll(0);
1057 dm->expiration = GNUNET_TIME_absolute_hton(GNUNET_TIME_UNIT_ZERO_ABS);
1059 memcpy (&dm[1], data, size);
1066 * Type of a function to call when we receive a message
1069 * @param cls closure
1070 * @param msg message received, NULL on timeout or fatal error
1073 process_result_message (void *cls,
1074 const struct GNUNET_MessageHeader * msg)
1076 struct GNUNET_DATASTORE_QueueEntry *qe = cls;
1077 struct GNUNET_DATASTORE_Handle *h = qe->h;
1078 struct ResultContext rc = qe->qc.rc;
1079 const struct DataMessage *dm;
1080 int was_transmitted;
1082 h->in_receive = GNUNET_NO;
1085 was_transmitted = qe->was_transmitted;
1086 free_queue_entry (qe);
1087 if (was_transmitted == GNUNET_YES)
1089 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1090 _("Failed to receive response from database.\n"));
1096 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1097 "Request dropped due to finite datastore queue length.\n");
1100 if (rc.iter != NULL)
1101 rc.iter (rc.iter_cls,
1102 NULL, 0, NULL, 0, 0, 0,
1103 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1106 GNUNET_assert (GNUNET_YES == qe->was_transmitted);
1107 GNUNET_assert (h->queue_head == qe);
1108 if (ntohs(msg->type) == GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END)
1110 GNUNET_break (ntohs(msg->size) == sizeof(struct GNUNET_MessageHeader));
1112 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1113 "Received end of result set\n");
1115 free_queue_entry (qe);
1116 if (rc.iter != NULL)
1117 rc.iter (rc.iter_cls,
1118 NULL, 0, NULL, 0, 0, 0,
1119 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1123 if ( (ntohs(msg->size) < sizeof(struct DataMessage)) ||
1124 (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_DATASTORE_DATA) ||
1125 (ntohs(msg->size) != sizeof(struct DataMessage) + ntohl (((const struct DataMessage*)msg)->size)) )
1128 free_queue_entry (qe);
1129 h->retry_time = GNUNET_TIME_UNIT_ZERO;
1131 if (rc.iter != NULL)
1132 rc.iter (rc.iter_cls,
1133 NULL, 0, NULL, 0, 0, 0,
1134 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1137 if (rc.iter == NULL)
1139 /* abort iteration */
1141 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1142 "Aborting iteration via disconnect (client has cancelled)\n");
1144 free_queue_entry (qe);
1145 h->retry_time = GNUNET_TIME_UNIT_ZERO;
1149 dm = (const struct DataMessage*) msg;
1151 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1152 "Received result %llu with type %u and size %u with key %s\n",
1153 (unsigned long long) GNUNET_ntohll(dm->uid),
1156 GNUNET_h2s(&dm->key));
1158 rc.iter (rc.iter_cls,
1163 ntohl(dm->priority),
1164 ntohl(dm->anonymity),
1165 GNUNET_TIME_absolute_ntoh(dm->expiration),
1166 GNUNET_ntohll(dm->uid));
1171 * Get a random value from the datastore.
1173 * @param h handle to the datastore
1174 * @param queue_priority ranking of this request in the priority queue
1175 * @param max_queue_size at what queue size should this request be dropped
1176 * (if other requests of higher priority are in the queue)
1177 * @param timeout how long to wait at most for a response
1178 * @param iter function to call on a random value; it
1179 * will be called once with a value (if available)
1180 * and always once with a value of NULL.
1181 * @param iter_cls closure for iter
1182 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1183 * cancel; note that even if NULL is returned, the callback will be invoked
1184 * (or rather, will already have been invoked)
1186 struct GNUNET_DATASTORE_QueueEntry *
1187 GNUNET_DATASTORE_get_random (struct GNUNET_DATASTORE_Handle *h,
1188 unsigned int queue_priority,
1189 unsigned int max_queue_size,
1190 struct GNUNET_TIME_Relative timeout,
1191 GNUNET_DATASTORE_Iterator iter,
1194 struct GNUNET_DATASTORE_QueueEntry *qe;
1195 struct GNUNET_MessageHeader *m;
1196 union QueueContext qc;
1199 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1200 "Asked to get random entry in %llu ms\n",
1201 (unsigned long long) timeout.value);
1204 qc.rc.iter_cls = iter_cls;
1205 qe = make_queue_entry (h, sizeof(struct GNUNET_MessageHeader),
1206 queue_priority, max_queue_size, timeout,
1207 &process_result_message, &qc);
1210 m = (struct GNUNET_MessageHeader*) &qe[1];
1211 m->type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_GET_RANDOM);
1212 m->size = htons(sizeof (struct GNUNET_MessageHeader));
1219 * Get a zero-anonymity value from the datastore.
1221 * @param h handle to the datastore
1222 * @param queue_priority ranking of this request in the priority queue
1223 * @param max_queue_size at what queue size should this request be dropped
1224 * (if other requests of higher priority are in the queue)
1225 * @param timeout how long to wait at most for a response
1226 * @param type allowed type for the operation
1227 * @param iter function to call on a random value; it
1228 * will be called once with a value (if available)
1229 * and always once with a value of NULL.
1230 * @param iter_cls closure for iter
1231 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1232 * cancel; note that even if NULL is returned, the callback will be invoked
1233 * (or rather, will already have been invoked)
1235 struct GNUNET_DATASTORE_QueueEntry *
1236 GNUNET_DATASTORE_get_zero_anonymity (struct GNUNET_DATASTORE_Handle *h,
1237 unsigned int queue_priority,
1238 unsigned int max_queue_size,
1239 struct GNUNET_TIME_Relative timeout,
1240 enum GNUNET_BLOCK_Type type,
1241 GNUNET_DATASTORE_Iterator iter,
1244 struct GNUNET_DATASTORE_QueueEntry *qe;
1245 struct GetZeroAnonymityMessage *m;
1246 union QueueContext qc;
1249 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1250 "Asked to get zero-anonymity entry in %llu ms\n",
1251 (unsigned long long) timeout.value);
1254 qc.rc.iter_cls = iter_cls;
1255 qe = make_queue_entry (h, sizeof(struct GetZeroAnonymityMessage),
1256 queue_priority, max_queue_size, timeout,
1257 &process_result_message, &qc);
1260 m = (struct GetZeroAnonymityMessage*) &qe[1];
1261 m->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_GET_RANDOM);
1262 m->header.size = htons(sizeof (struct GetZeroAnonymityMessage));
1263 m->type = htonl ((uint32_t) type);
1271 * Iterate over the results for a particular key
1272 * in the datastore. The iterator will only be called
1273 * once initially; if the first call did contain a
1274 * result, further results can be obtained by calling
1275 * "GNUNET_DATASTORE_get_next" with the given argument.
1277 * @param h handle to the datastore
1278 * @param key maybe NULL (to match all entries)
1279 * @param type desired type, 0 for any
1280 * @param queue_priority ranking of this request in the priority queue
1281 * @param max_queue_size at what queue size should this request be dropped
1282 * (if other requests of higher priority are in the queue)
1283 * @param timeout how long to wait at most for a response
1284 * @param iter function to call on each matching value;
1285 * will be called once with a NULL value at the end
1286 * @param iter_cls closure for iter
1287 * @return NULL if the entry was not queued, otherwise a handle that can be used to
1288 * cancel; note that even if NULL is returned, the callback will be invoked
1289 * (or rather, will already have been invoked)
1291 struct GNUNET_DATASTORE_QueueEntry *
1292 GNUNET_DATASTORE_get (struct GNUNET_DATASTORE_Handle *h,
1293 const GNUNET_HashCode * key,
1294 enum GNUNET_BLOCK_Type type,
1295 unsigned int queue_priority,
1296 unsigned int max_queue_size,
1297 struct GNUNET_TIME_Relative timeout,
1298 GNUNET_DATASTORE_Iterator iter,
1301 struct GNUNET_DATASTORE_QueueEntry *qe;
1302 struct GetMessage *gm;
1303 union QueueContext qc;
1306 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1307 "Asked to look for data of type %u under key `%s'\n",
1308 (unsigned int) type,
1312 qc.rc.iter_cls = iter_cls;
1313 qe = make_queue_entry (h, sizeof(struct GetMessage),
1314 queue_priority, max_queue_size, timeout,
1315 &process_result_message, &qc);
1319 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1320 "Could not queue request for `%s'\n",
1325 gm = (struct GetMessage*) &qe[1];
1326 gm->header.type = htons(GNUNET_MESSAGE_TYPE_DATASTORE_GET);
1327 gm->type = htonl(type);
1330 gm->header.size = htons(sizeof (struct GetMessage));
1335 gm->header.size = htons(sizeof (struct GetMessage) - sizeof(GNUNET_HashCode));
1343 * Function called to trigger obtaining the next result
1344 * from the datastore.
1346 * @param h handle to the datastore
1347 * @param more GNUNET_YES to get moxre results, GNUNET_NO to abort
1348 * iteration (with a final call to "iter" with key/data == NULL).
1351 GNUNET_DATASTORE_get_next (struct GNUNET_DATASTORE_Handle *h,
1354 struct GNUNET_DATASTORE_QueueEntry *qe = h->queue_head;
1355 struct ResultContext rc = qe->qc.rc;
1357 GNUNET_assert (&process_result_message == qe->response_proc);
1358 if (GNUNET_YES == more)
1360 h->in_receive = GNUNET_YES;
1361 GNUNET_CLIENT_receive (h->client,
1364 GNUNET_TIME_absolute_get_remaining (qe->timeout));
1367 free_queue_entry (qe);
1368 h->retry_time = GNUNET_TIME_UNIT_ZERO;
1370 rc.iter (rc.iter_cls,
1371 NULL, 0, NULL, 0, 0, 0,
1372 GNUNET_TIME_UNIT_ZERO_ABS, 0);
1377 * Cancel a datastore operation. The final callback from the
1378 * operation must not have been done yet.
1380 * @param qe operation to cancel
1383 GNUNET_DATASTORE_cancel (struct GNUNET_DATASTORE_QueueEntry *qe)
1385 struct GNUNET_DATASTORE_Handle *h;
1390 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1391 "Pending DATASTORE request %p cancelled (%d, %d)\n",
1393 qe->was_transmitted,
1394 h->queue_head == qe);
1396 reconnect = GNUNET_NO;
1397 if (GNUNET_YES == qe->was_transmitted)
1399 if (qe->response_proc == &process_result_message)
1401 qe->qc.rc.iter = NULL;
1402 if (GNUNET_YES != h->in_receive)
1403 GNUNET_DATASTORE_get_next (h, GNUNET_YES);
1407 qe->qc.sc.cont = NULL;
1411 free_queue_entry (qe);
1416 /* end of datastore_api.c */