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;
467 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
471 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
472 "Error receiving data from GNS service, reconnecting\n");
473 force_reconnect (handle);
477 type = ntohs (msg->type);
479 if (type == GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT)
481 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
483 lookup_msg = (const struct GNUNET_GNS_ClientLookupResultMessage *) msg;
484 r_id = ntohl (lookup_msg->id);
486 if (r_id > handle->r_id)
488 /** no request found */
490 GNUNET_CLIENT_receive (handle->client, &process_message, handle,
491 GNUNET_TIME_UNIT_FOREVER_REL);
494 for (qe = handle->lookup_head; qe != NULL; qe = qe->next)
496 if (qe->r_id == r_id)
500 process_lookup_reply(qe, lookup_msg);
504 else if (type == GNUNET_MESSAGE_TYPE_GNS_SHORTEN_RESULT)
506 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
507 "Got SHORTEN_RESULT msg\n");
508 shorten_msg = (struct GNUNET_GNS_ClientShortenResultMessage *) msg;
510 r_id = ntohl (shorten_msg->id);
512 if (r_id > handle->r_id)
514 /** no request found */
516 GNUNET_CLIENT_receive (handle->client, &process_message, handle,
517 GNUNET_TIME_UNIT_FOREVER_REL);
520 for (qe = handle->shorten_head; qe != NULL; qe = qe->next)
522 if (qe->r_id == r_id)
526 process_shorten_reply(qe, shorten_msg);
528 else if (type == GNUNET_MESSAGE_TYPE_GNS_GET_AUTH_RESULT)
530 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
531 "Got GET_AUTH_RESULT msg\n");
532 get_auth_msg = (struct GNUNET_GNS_ClientGetAuthResultMessage *) msg;
534 r_id = ntohl (get_auth_msg->id);
536 if (r_id > handle->r_id)
538 /** no request found */
540 GNUNET_CLIENT_receive (handle->client, &process_message, handle,
541 GNUNET_TIME_UNIT_FOREVER_REL);
544 for (qe = handle->get_auth_head; qe != NULL; qe = qe->next)
546 if (qe->r_id == r_id)
550 process_get_auth_reply(qe, get_auth_msg);
553 GNUNET_CLIENT_receive (handle->client, &process_message, handle,
554 GNUNET_TIME_UNIT_FOREVER_REL);
556 if (GNUNET_YES == handle->reconnect)
557 force_reconnect (handle);
563 * Initialize the connection with the GNS service.
565 * @param cfg configuration to use
566 * @param ht_len size of the internal hash table to use for parallel requests
567 * @return handle to the GNS service, or NULL on error
569 struct GNUNET_GNS_Handle *
570 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
572 struct GNUNET_GNS_Handle *handle;
574 handle = GNUNET_malloc (sizeof (struct GNUNET_GNS_Handle));
577 //handle->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect_task, handle);
579 handle->in_receive = GNUNET_NO;
585 * Shutdown connection with the GNS service.
587 * @param handle handle of the GNS connection to stop
590 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle)
592 GNUNET_CLIENT_disconnect (handle->client, 0);
597 * Helper function to generate request ids
603 get_request_id (struct GNUNET_GNS_Handle *h)
605 uint32_t r_id = h->r_id;
611 * Perform an asynchronous Lookup operation on the GNS.
613 * @param handle handle to the GNS service
614 * @param name the name to look up
615 * @param iter function to call on each result
616 * @param iter_cls closure for iter
617 * @return handle to stop the async get
619 struct GNUNET_GNS_QueueEntry *
620 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
622 enum GNUNET_GNS_RecordType type,
623 GNUNET_GNS_LookupResultProcessor proc,
626 /* IPC to shorten gns names, return shorten_handle */
627 struct GNUNET_GNS_ClientLookupMessage *lookup_msg;
628 struct GNUNET_GNS_QueueEntry *qe;
630 struct PendingMessage *pending;
637 msize = sizeof (struct GNUNET_GNS_ClientLookupMessage) + strlen(name) + 1;
638 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Trying to lookup %s in GNS\n", name);
640 qe = GNUNET_malloc(sizeof (struct GNUNET_GNS_QueueEntry));
641 qe->gns_handle = handle;
642 qe->lookup_proc = proc;
643 qe->proc_cls = proc_cls;
644 qe->r_id = get_request_id(handle);
645 GNUNET_CONTAINER_DLL_insert_tail(handle->lookup_head,
646 handle->lookup_tail, qe);
648 pending = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
649 memset(pending, 0, (sizeof (struct PendingMessage) + msize));
651 pending->size = msize;
653 lookup_msg = (struct GNUNET_GNS_ClientLookupMessage *) &pending[1];
654 lookup_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_LOOKUP);
655 lookup_msg->header.size = htons (msize);
656 lookup_msg->id = htonl(qe->r_id);
657 lookup_msg->type = htonl(type);
659 memcpy(&lookup_msg[1], name, strlen(name));
661 GNUNET_CONTAINER_DLL_insert (handle->pending_head, handle->pending_tail,
664 process_pending_messages (handle);
670 * Perform a name shortening operation on the GNS.
672 * @param handle handle to the GNS service
673 * @param name the name to look up
674 * @param proc function to call on result
675 * @param proc_cls closure for processor
676 * @return handle to the operation
678 struct GNUNET_GNS_QueueEntry *
679 GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
681 GNUNET_GNS_ShortenResultProcessor proc,
684 /* IPC to shorten gns names, return shorten_handle */
685 struct GNUNET_GNS_ClientShortenMessage *shorten_msg;
686 struct GNUNET_GNS_QueueEntry *qe;
688 struct PendingMessage *pending;
695 msize = sizeof (struct GNUNET_GNS_ClientShortenMessage) + strlen(name) + 1;
696 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Trying to shorten %s in GNS\n", name);
698 qe = GNUNET_malloc(sizeof (struct GNUNET_GNS_QueueEntry));
699 qe->gns_handle = handle;
700 qe->shorten_proc = proc;
701 qe->proc_cls = proc_cls;
702 qe->r_id = get_request_id(handle);
703 GNUNET_CONTAINER_DLL_insert_tail(handle->shorten_head,
704 handle->shorten_tail, qe);
706 pending = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
707 memset(pending, 0, (sizeof (struct PendingMessage) + msize));
709 pending->size = msize;
711 shorten_msg = (struct GNUNET_GNS_ClientShortenMessage *) &pending[1];
712 shorten_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_SHORTEN);
713 shorten_msg->header.size = htons (msize);
714 shorten_msg->id = htonl(qe->r_id);
716 memcpy(&shorten_msg[1], name, strlen(name));
718 GNUNET_CONTAINER_DLL_insert (handle->pending_head, handle->pending_tail,
721 process_pending_messages (handle);
727 * Perform an authority lookup for a given name.
729 * @param handle handle to the GNS service
730 * @param name the name to look up authority for
731 * @param proc function to call on result
732 * @param proc_cls closure for processor
733 * @return handle to the operation
735 struct GNUNET_GNS_QueueEntry *
736 GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
738 GNUNET_GNS_GetAuthResultProcessor proc,
741 struct GNUNET_GNS_ClientGetAuthMessage *get_auth_msg;
742 struct GNUNET_GNS_QueueEntry *qe;
744 struct PendingMessage *pending;
751 msize = sizeof (struct GNUNET_GNS_ClientGetAuthMessage) + strlen(name) + 1;
752 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
753 "Trying to look up authority for %s in GNS\n", name);
755 qe = GNUNET_malloc(sizeof (struct GNUNET_GNS_QueueEntry));
756 qe->gns_handle = handle;
757 qe->auth_proc = proc;
758 qe->proc_cls = proc_cls;
759 qe->r_id = get_request_id(handle);
760 GNUNET_CONTAINER_DLL_insert_tail(handle->get_auth_head,
761 handle->get_auth_tail, qe);
763 pending = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
764 memset(pending, 0, (sizeof (struct PendingMessage) + msize));
766 pending->size = msize;
768 get_auth_msg = (struct GNUNET_GNS_ClientGetAuthMessage *) &pending[1];
769 get_auth_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_GET_AUTH);
770 get_auth_msg->header.size = htons (msize);
771 get_auth_msg->id = htonl(qe->r_id);
773 memcpy(&get_auth_msg[1], name, strlen(name));
775 GNUNET_CONTAINER_DLL_insert (handle->pending_head, handle->pending_tail,
778 process_pending_messages (handle);
783 /* end of gns_api.c */