2 This file is part of GNUnet.
3 (C) 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.
24 * @brief library to access the GNS service
25 * @author Martin Schanzenbach
29 #include "gnunet_util_lib.h"
30 #include "gnunet_constants.h"
31 #include "gnunet_arm_service.h"
32 #include "gnunet_hello_lib.h"
33 #include "gnunet_protocols.h"
34 #include "gnunet_dht_service.h"
36 #include "gnunet_gns_service.h"
38 /* TODO into gnunet_protocols */
39 #define GNUNET_MESSAGE_TYPE_GNS_LOOKUP 23
40 #define GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT 24
41 #define GNUNET_MESSAGE_TYPE_GNS_SHORTEN 25
42 #define GNUNET_MESSAGE_TYPE_GNS_SHORTEN_RESULT 26
43 #define GNUNET_MESSAGE_TYPE_GNS_GET_AUTH 27
44 #define GNUNET_MESSAGE_TYPE_GNS_GET_AUTH_RESULT 28
49 struct GNUNET_GNS_QueueEntry
54 struct GNUNET_GNS_QueueEntry *next;
59 struct GNUNET_GNS_QueueEntry *prev;
65 struct GNUNET_GNS_Handle *gns_handle;
67 /* processor to call on shorten result */
68 GNUNET_GNS_ShortenResultProcessor shorten_proc;
70 /* processor to call on lookup result */
71 GNUNET_GNS_LookupResultProcessor lookup_proc;
73 /* processor to call on authority lookup result */
74 GNUNET_GNS_GetAuthResultProcessor auth_proc;
76 /* processor closure */
83 * Entry in our list of messages to be (re-)transmitted.
88 * This is a doubly-linked list.
90 struct PendingMessage *prev;
93 * This is a doubly-linked list.
95 struct PendingMessage *next;
98 * Size of the message.
106 * Connection to the GNS service.
108 struct GNUNET_GNS_Handle
112 * Configuration to use.
114 const struct GNUNET_CONFIGURATION_Handle *cfg;
117 * Socket (if available).
119 struct GNUNET_CLIENT_Connection *client;
122 * Currently pending transmission request (or NULL).
124 struct GNUNET_CLIENT_TransmitHandle *th;
129 * Head of linked list of shorten messages we would like to transmit.
131 struct PendingMessage *pending_head;
134 * Tail of linked list of shorten messages we would like to transmit.
136 struct PendingMessage *pending_tail;
139 * Head of linked list of shorten messages we would like to transmit.
141 struct GNUNET_GNS_QueueEntry *shorten_head;
144 * Tail of linked list of shorten messages we would like to transmit.
146 struct GNUNET_GNS_QueueEntry *shorten_tail;
149 * Head of linked list of lookup messages we would like to transmit.
151 struct GNUNET_GNS_QueueEntry *lookup_head;
154 * Tail of linked list of lookup messages we would like to transmit.
156 struct GNUNET_GNS_QueueEntry *lookup_tail;
159 * Head of linked list of authority lookup messages we would like to transmit.
161 struct GNUNET_GNS_QueueEntry *get_auth_head;
164 * Tail of linked list of authority lookup messages we would like to transmit.
166 struct GNUNET_GNS_QueueEntry *get_auth_tail;
171 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
174 * Did we start our receive loop yet?
179 * Reconnect necessary
185 * Try to send messages from list of messages to send
186 * @param handle GNS_Handle
189 process_pending_messages (struct GNUNET_GNS_Handle *handle);
193 * Reconnect to GNS service.
195 * @param h the handle to the namestore service
198 reconnect (struct GNUNET_GNS_Handle *h)
200 GNUNET_assert (NULL == h->client);
201 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
202 "Trying to connect to GNS...\n");
203 h->client = GNUNET_CLIENT_connect ("gns", h->cfg);
204 GNUNET_assert (NULL != h->client);
210 * @param cls the handle
211 * @param tc task context
214 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
216 struct GNUNET_GNS_Handle *h = cls;
218 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
224 * Disconnect from service and then reconnect.
226 * @param h our handle
229 force_reconnect (struct GNUNET_GNS_Handle *h)
231 h->reconnect = GNUNET_NO;
232 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
234 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
240 * Transmit the next pending message, called by notify_transmit_ready
243 transmit_pending (void *cls, size_t size, void *buf);
246 * Handler for messages received from the GNS service
248 * @param cls the 'struct GNUNET_GNS_Handle'
249 * @param msg the incoming message
252 process_message (void *cls, const struct GNUNET_MessageHeader *msg);
255 * Try to send messages from list of messages to send
258 process_pending_messages (struct GNUNET_GNS_Handle *handle)
260 struct PendingMessage *p;
262 if (handle->client == NULL)
264 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
265 "process_pending_messages called, but client is null\n");
269 if (handle->th != NULL)
272 if (NULL == (p = handle->pending_head))
275 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
276 "Trying to transmit %d bytes...\n", p->size);
279 GNUNET_CLIENT_notify_transmit_ready (handle->client,
281 GNUNET_TIME_UNIT_FOREVER_REL,
282 GNUNET_NO, &transmit_pending,
284 if (NULL != handle->th)
287 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
288 "notify_transmit_ready returned NULL!\n");
293 * Transmit the next pending message, called by notify_transmit_ready
296 transmit_pending (void *cls, size_t size, void *buf)
298 struct GNUNET_GNS_Handle *handle = cls;
299 struct PendingMessage *p;
305 if ((size == 0) || (buf == NULL))
307 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
308 "Transmission to GNS service failed!\n");
309 force_reconnect(handle);
316 if (NULL == (p = handle->pending_head))
319 while ((NULL != (p = handle->pending_head)) && (p->size <= size))
321 memcpy (&cbuf[tsize], &p[1], p->size);
324 GNUNET_CONTAINER_DLL_remove (handle->pending_head, handle->pending_tail, p);
325 if (GNUNET_YES != handle->in_receive)
327 GNUNET_CLIENT_receive (handle->client, &process_message, handle,
328 GNUNET_TIME_UNIT_FOREVER_REL);
329 handle->in_receive = GNUNET_YES;
334 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
335 "Sending %d bytes\n", tsize);
337 process_pending_messages(handle);
342 * Process a given reply that might match the given
345 * @param cls the 'struct GNUNET_GNS_ClientResultMessage'
346 * @param key query of the request
347 * @param value the 'struct GNUNET_GNS_LookupHandle' of a request matching the same key
350 process_shorten_reply (struct GNUNET_GNS_QueueEntry *qe,
351 const struct GNUNET_GNS_ClientShortenResultMessage *msg)
353 struct GNUNET_GNS_Handle *h = qe->gns_handle;
354 const char *short_name;
356 GNUNET_CONTAINER_DLL_remove(h->shorten_head, h->shorten_tail, qe);
358 short_name = (char*)(&msg[1]);
360 if (ntohs (((struct GNUNET_MessageHeader*)msg)->size) <
361 sizeof (struct GNUNET_GNS_ClientShortenResultMessage))
368 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
369 "Received shortened reply `%s' from GNS service\n",
372 qe->shorten_proc(qe->proc_cls, short_name);
378 * Process a given reply that might match the given
381 * @param qe the handle to the request
382 * @param msg the message to process
385 process_get_auth_reply (struct GNUNET_GNS_QueueEntry *qe,
386 const struct GNUNET_GNS_ClientGetAuthResultMessage *msg)
388 struct GNUNET_GNS_Handle *h = qe->gns_handle;
389 const char *auth_name;
391 GNUNET_CONTAINER_DLL_remove(h->get_auth_head, h->get_auth_tail, qe);
393 auth_name = (char*)(&msg[1]);
395 if (ntohs (((struct GNUNET_MessageHeader*)msg)->size) <
396 sizeof (struct GNUNET_GNS_ClientGetAuthResultMessage))
403 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
404 "Received GET_AUTH reply `%s' from GNS service\n",
407 qe->auth_proc(qe->proc_cls, auth_name);
411 * Process a given reply to the lookup request
413 * @param cls the 'struct GNUNET_GNS_ClientResultMessage'
414 * @param key query of the request
415 * @param value the 'struct GNUNET_GNS_LookupHandle' of a request matching the same key
416 * @return GNUNET_YES to continue to iterate over all results,
417 * GNUNET_NO if the reply is malformed
420 process_lookup_reply (struct GNUNET_GNS_QueueEntry *qe,
421 const struct GNUNET_GNS_ClientLookupResultMessage *msg)
423 struct GNUNET_GNS_Handle *h = qe->gns_handle;
424 int rd_count = ntohl(msg->rd_count);
425 size_t len = ntohs (((struct GNUNET_MessageHeader*)msg)->size);
426 struct GNUNET_NAMESTORE_RecordData rd[rd_count];
428 GNUNET_CONTAINER_DLL_remove(h->lookup_head, h->lookup_tail, qe);
430 if (len < sizeof (struct GNUNET_GNS_ClientLookupResultMessage))
437 len -= sizeof(struct GNUNET_GNS_ClientLookupResultMessage);
439 GNUNET_NAMESTORE_records_deserialize (len, (char*)&msg[1],
443 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
444 "Received lookup reply from GNS service (count=%d)\n",
445 ntohl(msg->rd_count));
447 qe->lookup_proc(qe->proc_cls, rd_count, rd);
451 * Handler for messages received from the GNS service
453 * @param cls the 'struct GNUNET_GNS_Handle'
454 * @param msg the incoming message
457 process_message (void *cls, const struct GNUNET_MessageHeader *msg)
459 struct GNUNET_GNS_Handle *handle = cls;
460 struct GNUNET_GNS_QueueEntry *qe;
461 const struct GNUNET_GNS_ClientLookupResultMessage *lookup_msg;
462 const struct GNUNET_GNS_ClientShortenResultMessage *shorten_msg;
463 const struct GNUNET_GNS_ClientGetAuthResultMessage *get_auth_msg;
468 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
472 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
473 "Error receiving data from GNS service, reconnecting\n");
474 force_reconnect (handle);
478 size = ntohs (msg->size);
479 type = ntohs (msg->type);
481 if (type == GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT)
483 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
485 lookup_msg = (const struct GNUNET_GNS_ClientLookupResultMessage *) msg;
486 r_id = ntohl (lookup_msg->id);
488 if (r_id > handle->r_id)
490 /** no request found */
492 GNUNET_CLIENT_receive (handle->client, &process_message, handle,
493 GNUNET_TIME_UNIT_FOREVER_REL);
496 for (qe = handle->lookup_head; qe != NULL; qe = qe->next)
498 if (qe->r_id == r_id)
502 process_lookup_reply(qe, lookup_msg);
506 else if (type == GNUNET_MESSAGE_TYPE_GNS_SHORTEN_RESULT)
508 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
509 "Got SHORTEN_RESULT msg\n");
510 shorten_msg = (struct GNUNET_GNS_ClientShortenResultMessage *) msg;
512 r_id = ntohl (shorten_msg->id);
514 if (r_id > handle->r_id)
516 /** no request found */
518 GNUNET_CLIENT_receive (handle->client, &process_message, handle,
519 GNUNET_TIME_UNIT_FOREVER_REL);
522 for (qe = handle->shorten_head; qe != NULL; qe = qe->next)
524 if (qe->r_id == r_id)
528 process_shorten_reply(qe, shorten_msg);
530 else if (type == GNUNET_MESSAGE_TYPE_GNS_GET_AUTH_RESULT)
532 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
533 "Got GET_AUTH_RESULT msg\n");
534 get_auth_msg = (struct GNUNET_GNS_ClientGetAuthResultMessage *) msg;
536 r_id = ntohl (get_auth_msg->id);
538 if (r_id > handle->r_id)
540 /** no request found */
542 GNUNET_CLIENT_receive (handle->client, &process_message, handle,
543 GNUNET_TIME_UNIT_FOREVER_REL);
546 for (qe = handle->get_auth_head; qe != NULL; qe = qe->next)
548 if (qe->r_id == r_id)
552 process_get_auth_reply(qe, get_auth_msg);
555 GNUNET_CLIENT_receive (handle->client, &process_message, handle,
556 GNUNET_TIME_UNIT_FOREVER_REL);
558 if (GNUNET_YES == handle->reconnect)
559 force_reconnect (handle);
565 * Initialize the connection with the GNS service.
567 * @param cfg configuration to use
568 * @param ht_len size of the internal hash table to use for parallel requests
569 * @return handle to the GNS service, or NULL on error
571 struct GNUNET_GNS_Handle *
572 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
574 struct GNUNET_GNS_Handle *handle;
576 handle = GNUNET_malloc (sizeof (struct GNUNET_GNS_Handle));
579 //handle->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect_task, handle);
581 handle->in_receive = GNUNET_NO;
587 * Shutdown connection with the GNS service.
589 * @param handle handle of the GNS connection to stop
592 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle)
594 GNUNET_CLIENT_disconnect (handle->client, 0);
599 * Helper function to generate request ids
605 get_request_id (struct GNUNET_GNS_Handle *h)
607 uint32_t r_id = h->r_id;
613 * Perform an asynchronous Lookup operation on the GNS.
615 * @param handle handle to the GNS service
616 * @param name the name to look up
617 * @param iter function to call on each result
618 * @param iter_cls closure for iter
619 * @return handle to stop the async get
621 struct GNUNET_GNS_QueueEntry *
622 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
624 enum GNUNET_GNS_RecordType type,
625 GNUNET_GNS_LookupResultProcessor proc,
628 /* IPC to shorten gns names, return shorten_handle */
629 struct GNUNET_GNS_ClientLookupMessage *lookup_msg;
630 struct GNUNET_GNS_QueueEntry *qe;
632 struct PendingMessage *pending;
639 msize = sizeof (struct GNUNET_GNS_ClientLookupMessage) + strlen(name) + 1;
640 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Trying to lookup %s in GNS\n", name);
642 qe = GNUNET_malloc(sizeof (struct GNUNET_GNS_QueueEntry));
643 qe->gns_handle = handle;
644 qe->lookup_proc = proc;
645 qe->proc_cls = proc_cls;
646 qe->r_id = get_request_id(handle);
647 GNUNET_CONTAINER_DLL_insert_tail(handle->lookup_head,
648 handle->lookup_tail, qe);
650 pending = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
651 memset(pending, 0, (sizeof (struct PendingMessage) + msize));
653 pending->size = msize;
655 lookup_msg = (struct GNUNET_GNS_ClientLookupMessage *) &pending[1];
656 lookup_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_LOOKUP);
657 lookup_msg->header.size = htons (msize);
658 lookup_msg->id = htonl(qe->r_id);
659 lookup_msg->type = htonl(type);
661 memcpy(&lookup_msg[1], name, strlen(name));
663 GNUNET_CONTAINER_DLL_insert (handle->pending_head, handle->pending_tail,
666 process_pending_messages (handle);
672 * Perform a name shortening operation on the GNS.
674 * @param handle handle to the GNS service
675 * @param name the name to look up
676 * @param proc function to call on result
677 * @param proc_cls closure for processor
678 * @return handle to the operation
680 struct GNUNET_GNS_QueueEntry *
681 GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
683 GNUNET_GNS_ShortenResultProcessor proc,
686 /* IPC to shorten gns names, return shorten_handle */
687 struct GNUNET_GNS_ClientShortenMessage *shorten_msg;
688 struct GNUNET_GNS_QueueEntry *qe;
690 struct PendingMessage *pending;
697 msize = sizeof (struct GNUNET_GNS_ClientShortenMessage) + strlen(name) + 1;
698 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Trying to shorten %s in GNS\n", name);
700 qe = GNUNET_malloc(sizeof (struct GNUNET_GNS_QueueEntry));
701 qe->gns_handle = handle;
702 qe->shorten_proc = proc;
703 qe->proc_cls = proc_cls;
704 qe->r_id = get_request_id(handle);
705 GNUNET_CONTAINER_DLL_insert_tail(handle->shorten_head,
706 handle->shorten_tail, qe);
708 pending = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
709 memset(pending, 0, (sizeof (struct PendingMessage) + msize));
711 pending->size = msize;
713 shorten_msg = (struct GNUNET_GNS_ClientShortenMessage *) &pending[1];
714 shorten_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_SHORTEN);
715 shorten_msg->header.size = htons (msize);
716 shorten_msg->id = htonl(qe->r_id);
718 memcpy(&shorten_msg[1], name, strlen(name));
720 GNUNET_CONTAINER_DLL_insert (handle->pending_head, handle->pending_tail,
723 process_pending_messages (handle);
729 * Perform an authority lookup for a given name.
731 * @param handle handle to the GNS service
732 * @param name the name to look up authority for
733 * @param proc function to call on result
734 * @param proc_cls closure for processor
735 * @return handle to the operation
737 struct GNUNET_GNS_QueueEntry *
738 GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
740 GNUNET_GNS_GetAuthResultProcessor proc,
743 struct GNUNET_GNS_ClientGetAuthMessage *get_auth_msg;
744 struct GNUNET_GNS_QueueEntry *qe;
746 struct PendingMessage *pending;
753 msize = sizeof (struct GNUNET_GNS_ClientGetAuthMessage) + strlen(name) + 1;
754 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
755 "Trying to look up authority for %s in GNS\n", name);
757 qe = GNUNET_malloc(sizeof (struct GNUNET_GNS_QueueEntry));
758 qe->gns_handle = handle;
759 qe->auth_proc = proc;
760 qe->proc_cls = proc_cls;
761 qe->r_id = get_request_id(handle);
762 GNUNET_CONTAINER_DLL_insert_tail(handle->get_auth_head,
763 handle->get_auth_tail, qe);
765 pending = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
766 memset(pending, 0, (sizeof (struct PendingMessage) + msize));
768 pending->size = msize;
770 get_auth_msg = (struct GNUNET_GNS_ClientGetAuthMessage *) &pending[1];
771 get_auth_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_GET_AUTH);
772 get_auth_msg->header.size = htons (msize);
773 get_auth_msg->id = htonl(qe->r_id);
775 memcpy(&get_auth_msg[1], name, strlen(name));
777 GNUNET_CONTAINER_DLL_insert (handle->pending_head, handle->pending_tail,
780 process_pending_messages (handle);
785 /* end of gns_api.c */