wip
[oweals/gnunet.git] / src / peerinfo / peerinfo_api.c
1 /*
2      This file is part of GNUnet.
3      (C) 2001, 2002, 2004, 2005, 2007, 2009, 2010 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file peerinfo/peerinfo_api.c
23  * @brief API to access peerinfo service
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet_client_lib.h"
28 #include "gnunet_container_lib.h"
29 #include "gnunet_peerinfo_service.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_time_lib.h"
32 #include "peerinfo.h"
33
34 /**
35  * Function to call after transmission has succeeded.
36  * 
37  * @param cls closure
38  * @param success GNUNET_OK if transmission worked, GNUNET_SYSERR on error
39  */
40 typedef void (*TransmissionContinuation)(void *cls,
41                                          int success);
42
43
44 /**
45  * Entry in the transmission queue to PEERINFO service.
46  */
47 struct TransmissionQueueEntry
48 {
49   /**
50    * This is a linked list.
51    */
52   struct TransmissionQueueEntry *next;
53   
54   /**
55    * This is a linked list.
56    */
57   struct TransmissionQueueEntry *prev;
58
59   /**
60    * Function to call after request has been transmitted, or NULL (in which
61    * case we must consider sending the next entry immediately).
62    */
63   TransmissionContinuation cont;
64   
65   /**
66    * Closure for 'cont'.
67    */
68   void *cont_cls;
69
70   /**
71    * Timeout for the operation.
72    */
73   struct GNUNET_TIME_Absolute timeout;
74
75   /**
76    * Number of bytes of the request message (follows after this struct).
77    */
78   size_t size;
79
80 };
81
82
83 /**
84  * Handle to the peerinfo service.
85  */
86 struct GNUNET_PEERINFO_Handle
87 {
88   /**
89    * Our configuration.
90    */
91   const struct GNUNET_CONFIGURATION_Handle *cfg;
92
93   /**
94    * Connection to the service.
95    */
96   struct GNUNET_CLIENT_Connection *client;
97
98   /**
99    * Head of transmission queue.
100    */
101   struct TransmissionQueueEntry *tq_head;
102
103   /**
104    * Tail of transmission queue.
105    */
106   struct TransmissionQueueEntry *tq_tail;
107
108   /**
109    * Handle for the current transmission request, or NULL if none is pending.
110    */
111   struct GNUNET_CLIENT_TransmitHandle *th;
112
113   /**
114    * Set to GNUNET_YES if we are currently receiving replies from the
115    * service.
116    */
117   int in_receive;
118
119 };
120
121
122 /**
123  * Connect to the peerinfo service.
124  *
125  * @param cfg configuration to use
126  * @return NULL on error (configuration related, actual connection
127  *         establishment may happen asynchronously).
128  */
129 struct GNUNET_PEERINFO_Handle *
130 GNUNET_PEERINFO_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
131 {
132   struct GNUNET_CLIENT_Connection *client;
133   struct GNUNET_PEERINFO_Handle *ret;
134
135   client = GNUNET_CLIENT_connect ("peerinfo", cfg);
136   if (client == NULL)
137     return NULL;
138   ret = GNUNET_malloc (sizeof (struct GNUNET_PEERINFO_Handle));
139   ret->client = client;
140   ret->cfg = cfg;
141   return ret;
142 }
143
144
145 /**
146  * Disconnect from the peerinfo service.  Note that all iterators must
147  * have completed or have been cancelled by the time this function is
148  * called (otherwise, calling this function is a serious error).
149  * Furthermore, if 'GNUNET_PEERINFO_add_peer' operations are still
150  * pending, they will be cancelled silently on disconnect.
151  *
152  * @param h handle to disconnect
153  */
154 void
155 GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h)
156 {
157   struct TransmissionQueueEntry *tqe;
158
159   while (NULL != (tqe = h->tq_head))
160     {     
161       GNUNET_CONTAINER_DLL_remove (h->tq_head,
162                                    h->tq_tail,
163                                    tqe);
164       if (tqe->cont != NULL)
165         tqe->cont (tqe->cont_cls, GNUNET_SYSERR);
166       GNUNET_free (tqe);
167     }
168   if (h->th != NULL)
169     {
170       GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
171       h->th = NULL;
172     }
173   GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
174   GNUNET_free (h);
175 }
176
177
178 /**
179  * Check if we have a request pending in the transmission queue and are
180  * able to transmit it right now.  If so, schedule transmission.
181  *
182  * @param h handle to the service
183  */
184 static void
185 trigger_transmit (struct GNUNET_PEERINFO_Handle *h);
186
187
188 /**
189  * Close the existing connection to PEERINFO and reconnect.
190  *
191  * @param h handle to the service
192  */
193 static void
194 reconnect (struct GNUNET_PEERINFO_Handle *h)
195 {
196   GNUNET_CLIENT_disconnect (h->client, GNUNET_SYSERR);
197   h->th = NULL;
198   h->client = GNUNET_CLIENT_connect ("peerinfo", h->cfg);
199   GNUNET_assert (h->client != NULL);
200 }
201
202
203 /**
204  * Transmit the request at the head of the transmission queue
205  * and trigger continuation (if any).
206  *
207  * @param cls the 'struct GNUNET_PEERINFO_Handle' (with the queue)
208  * @param size size of the buffer (0 on error)
209  * @param buf where to copy the message
210  * @return number of bytes copied to buf
211  */
212 static size_t
213 do_transmit (void *cls, size_t size, void *buf)
214 {
215   struct GNUNET_PEERINFO_Handle *h = cls;
216   struct TransmissionQueueEntry *tqe = h->tq_head;
217   size_t ret;
218
219   h->th = NULL;
220   if (buf == NULL)
221     {
222       GNUNET_log (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
223                   _("Failed to transmit message to `%s' service.\n"),
224                   "PEERINFO");
225       if (tqe != NULL)
226         GNUNET_CONTAINER_DLL_remove (h->tq_head,
227                                      h->tq_tail,
228                                      tqe);
229       reconnect (h);
230       trigger_transmit (h);
231       if (tqe != NULL)
232         {
233           if (tqe->cont != NULL)
234             tqe->cont (tqe->cont_cls, GNUNET_SYSERR);
235           GNUNET_free (tqe);
236         }
237       return 0;
238     }
239   /* If it can be NULL above, it can be NULL here to... */
240   if (tqe == NULL)
241     return 0;
242
243   ret = tqe->size;
244   GNUNET_assert (size >= ret);
245   memcpy (buf, &tqe[1], ret);
246 #if DEBUG_PEERINFO
247   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
248               "Transmitting request of size %u to `%s' service.\n",
249               ret, 
250               "PEERINFO");
251 #endif
252    GNUNET_CONTAINER_DLL_remove (h->tq_head,
253                                h->tq_tail,
254                                tqe);
255   if (tqe->cont != NULL)
256     tqe->cont (tqe->cont_cls, GNUNET_OK);
257   else
258     trigger_transmit (h);
259   GNUNET_free (tqe);
260   return ret;
261 }
262
263
264 /**
265  * Check if we have a request pending in the transmission queue and are
266  * able to transmit it right now.  If so, schedule transmission.
267  *
268  * @param h handle to the service
269  */
270 static void
271 trigger_transmit (struct GNUNET_PEERINFO_Handle *h)
272 {
273   struct TransmissionQueueEntry *tqe;
274
275   if (NULL == (tqe = h->tq_head))
276     return;
277   if (h->th != NULL)
278     return;
279   if (h->in_receive == GNUNET_YES)
280     return;
281   h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
282                                                tqe->size,
283                                                GNUNET_TIME_absolute_get_remaining (tqe->timeout),
284                                                GNUNET_YES,
285                                                &do_transmit, h);  
286 }
287
288
289 /**
290  * Add a host to the persistent list.  This method operates in 
291  * semi-reliable mode: if the transmission is not completed by
292  * the time 'GNUNET_PEERINFO_disconnect' is called, it will be
293  * aborted.  Furthermore, if a second HELLO is added for the
294  * same peer before the first one was transmitted, PEERINFO may
295  * merge the two HELLOs prior to transmission to the service.
296  *
297  * @param h handle to the peerinfo service
298  * @param hello the verified (!) HELLO message
299  */
300 void
301 GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h,
302                           const struct GNUNET_HELLO_Message *hello)
303 {
304   uint16_t hs = GNUNET_HELLO_size (hello);
305   struct TransmissionQueueEntry *tqe;
306   
307 #if DEBUG_PEERINFO
308   struct GNUNET_PeerIdentity peer;
309   GNUNET_assert (GNUNET_OK == GNUNET_HELLO_get_id (hello, &peer));
310   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
311               "Adding peer `%s' to PEERINFO database (%u bytes of `%s')\n",
312               GNUNET_i2s(&peer),
313               hs,
314               "HELLO");
315 #endif
316   tqe = GNUNET_malloc (sizeof (struct TransmissionQueueEntry) + hs);
317   tqe->size = hs;
318   tqe->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
319   memcpy (&tqe[1], hello, hs);
320   GNUNET_CONTAINER_DLL_insert_after (h->tq_head,
321                                      h->tq_tail,
322                                      h->tq_tail,
323                                      tqe);
324   trigger_transmit (h);
325 }
326
327
328 /**
329  * Context for an iteration request.
330  */
331 struct GNUNET_PEERINFO_IteratorContext
332 {
333   /**
334    * Handle to the PEERINFO service.
335    */
336   struct GNUNET_PEERINFO_Handle *h;
337
338   /**
339    * Function to call with the results.
340    */
341   GNUNET_PEERINFO_Processor callback;
342
343   /**
344    * Closure for 'callback'.
345    */
346   void *callback_cls;
347
348   /**
349    * Our entry in the transmission queue.
350    */
351   struct TransmissionQueueEntry *tqe;
352
353   /**
354    * Task responsible for timeout.
355    */
356   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
357
358   /**
359    * Timeout for the operation.
360    */
361   struct GNUNET_TIME_Absolute timeout;
362
363   /**
364    * Are we now receiving?
365    */
366   int in_receive;
367 };
368
369
370 /**
371  * Type of a function to call when we receive a message
372  * from the service.
373  *
374  * @param cls closure
375  * @param msg message received, NULL on timeout or fatal error
376  */
377 static void
378 peerinfo_handler (void *cls, const struct GNUNET_MessageHeader *msg)
379 {
380   struct GNUNET_PEERINFO_IteratorContext *ic = cls;
381   const struct InfoMessage *im;
382   const struct GNUNET_HELLO_Message *hello;
383   uint16_t ms;
384
385   ic->h->in_receive = GNUNET_NO;
386   if (msg == NULL)
387     {
388           char * err_msg;
389           GNUNET_asprintf(&err_msg,_("Failed to receive response from `%s' service.\n"),"PEERINFO");
390       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,err_msg);
391       reconnect (ic->h);
392       trigger_transmit (ic->h);
393       if (ic->timeout_task != GNUNET_SCHEDULER_NO_TASK)
394         GNUNET_SCHEDULER_cancel (ic->timeout_task);
395       if (ic->callback != NULL)
396           ic->callback (ic->callback_cls, NULL, NULL, err_msg);
397       GNUNET_free (err_msg);
398       GNUNET_free (ic);
399       return;
400     }
401   if (ntohs (msg->type) == GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END)
402     {
403 #if DEBUG_PEERINFO
404       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
405                   "Received end of list of peers from `%s' service\n",
406                   "PEERINFO");
407 #endif
408       trigger_transmit (ic->h);
409       if (ic->timeout_task != GNUNET_SCHEDULER_NO_TASK)
410         GNUNET_SCHEDULER_cancel (ic->timeout_task);
411       if (ic->callback != NULL)
412         ic->callback (ic->callback_cls, NULL, NULL, NULL);
413       GNUNET_free (ic);
414       return;
415     }
416   ms = ntohs (msg->size);
417   if ((ms < sizeof (struct InfoMessage)) ||
418       (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_PEERINFO_INFO))
419     {
420           char * err_msg;
421           GNUNET_asprintf(&err_msg,_("Received invalid message from `%s' service.\n"),"PEERINFO");
422       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,err_msg);
423       GNUNET_break (0);
424       reconnect (ic->h);
425       trigger_transmit (ic->h);
426       if (ic->timeout_task != GNUNET_SCHEDULER_NO_TASK)
427         GNUNET_SCHEDULER_cancel (ic->timeout_task);
428       if (ic->callback != NULL)
429         ic->callback (ic->callback_cls, NULL, NULL, err_msg);
430       GNUNET_free (err_msg);
431       GNUNET_free (ic);
432       return;
433     }
434   im = (const struct InfoMessage *) msg;
435   GNUNET_break (0 == ntohl (im->reserved));
436   hello = NULL;
437   if (ms > sizeof (struct InfoMessage) + sizeof (struct GNUNET_MessageHeader))
438     {
439       hello = (const struct GNUNET_HELLO_Message *) &im[1];
440       if (ms != sizeof (struct InfoMessage) + GNUNET_HELLO_size (hello))
441         {
442       char * err_msg;
443       GNUNET_asprintf(&err_msg,_("Received invalid message from `%s' service.\n"),"PEERINFO");
444       GNUNET_break (0);
445           reconnect (ic->h);
446           trigger_transmit (ic->h);
447           if (ic->timeout_task != GNUNET_SCHEDULER_NO_TASK)
448             GNUNET_SCHEDULER_cancel (ic->timeout_task);
449           if (ic->callback != NULL)
450             ic->callback (ic->callback_cls, NULL, NULL, err_msg);
451           GNUNET_free (ic);
452           GNUNET_free (err_msg);
453           return;
454         }
455     }
456 #if DEBUG_PEERINFO
457   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
458               "Received %u bytes of `%s' information about peer `%s' from `%s' service\n",
459               (hello == NULL) ? 0 : (unsigned int) GNUNET_HELLO_size (hello),
460               "HELLO",
461               GNUNET_i2s (&im->peer),
462               "PEERINFO");
463 #endif
464   ic->h->in_receive = GNUNET_YES;
465   if (ic->callback != NULL)
466     ic->callback (ic->callback_cls, &im->peer, hello, NULL);
467   GNUNET_CLIENT_receive (ic->h->client,
468                          &peerinfo_handler,
469                          ic,
470                          GNUNET_TIME_absolute_get_remaining (ic->timeout));
471 }
472
473
474 /**
475  * We've transmitted the iteration request.  Now get ready to process
476  * the results (or handle transmission error).
477  *
478  * @param cls the 'struct GNUNET_PEERINFO_IteratorContext'
479  * @param transmit_success GNUNET_OK if transmission worked
480  */
481 static void
482 iterator_start_receive (void *cls,
483                         int transmit_success)
484 {
485   struct GNUNET_PEERINFO_IteratorContext *ic = cls;
486
487   if (GNUNET_OK != transmit_success)
488     {
489       char * err_msg;
490       GNUNET_asprintf(&err_msg,_("Failed to transmit iteration request to `%s' service (%d).\n"),"PEERINFO",transmit_success);
491       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,err_msg);
492       if (ic->timeout_task != GNUNET_SCHEDULER_NO_TASK)
493         {
494           GNUNET_SCHEDULER_cancel (ic->timeout_task);
495           ic->timeout_task = GNUNET_SCHEDULER_NO_TASK;
496         }
497       reconnect (ic->h);
498       trigger_transmit (ic->h);
499       if (ic->callback != NULL)
500         ic->callback (ic->callback_cls, NULL, NULL, err_msg);
501       GNUNET_free (err_msg);
502       GNUNET_free (ic);
503       return;
504     }  
505 #if DEBUG_PEERINFO
506   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
507               "Waiting for response from `%s' service.\n",
508               "PEERINFO");
509 #endif
510   ic->h->in_receive = GNUNET_YES;
511   ic->in_receive = GNUNET_YES;
512   ic->tqe = NULL;
513   GNUNET_CLIENT_receive (ic->h->client,
514                          &peerinfo_handler,
515                          ic,
516                          GNUNET_TIME_absolute_get_remaining (ic->timeout));
517 }
518
519
520 /**
521  * Peerinfo iteration request has timed out.  
522  *
523  * @param cls the 'struct GNUNET_PEERINFO_IteratorContext*'
524  * @param tc scheduler context
525  */
526 static void
527 signal_timeout (void *cls,
528                 const struct GNUNET_SCHEDULER_TaskContext *tc)
529 {
530   struct GNUNET_PEERINFO_IteratorContext *ic = cls;
531   char * err_msg;
532
533   GNUNET_asprintf(&err_msg,_("Timeout transmitting iteration request to `%s' service.\n"),
534               "PEERINFO");
535
536   ic->timeout_task = GNUNET_SCHEDULER_NO_TASK;
537   if (! ic->in_receive)
538     GNUNET_CONTAINER_DLL_remove (ic->h->tq_head,
539                                  ic->h->tq_tail,
540                                  ic->tqe);
541   reconnect (ic->h);
542   ic->callback (ic->callback_cls, NULL, NULL, err_msg);
543   ic->callback = NULL;
544   GNUNET_free_non_null (ic->tqe);
545   GNUNET_free (err_msg);
546   GNUNET_free (ic);
547 }
548
549
550 /**
551  * Call a method for each known matching host and change its trust
552  * value.  The callback method will be invoked once for each matching
553  * host and then finally once with a NULL pointer.  After that final
554  * invocation, the iterator context must no longer be used.
555  *
556  * Instead of calling this function with 'peer == NULL' it is often
557  * better to use 'GNUNET_PEERINFO_notify'.
558  * 
559  * @param h handle to the peerinfo service
560  * @param peer restrict iteration to this peer only (can be NULL)
561  * @param timeout how long to wait until timing out
562  * @param callback the method to call for each peer
563  * @param callback_cls closure for callback
564  * @return iterator context
565  */
566 struct GNUNET_PEERINFO_IteratorContext *
567 GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h,
568                          const struct GNUNET_PeerIdentity *peer,
569                          struct GNUNET_TIME_Relative timeout,
570                          GNUNET_PEERINFO_Processor callback,
571                          void *callback_cls)
572 {
573   struct GNUNET_MessageHeader *lapm;
574   struct ListPeerMessage *lpm;
575   struct GNUNET_PEERINFO_IteratorContext *ic;
576   struct TransmissionQueueEntry *tqe;
577
578   if (peer == NULL)
579     {
580 #if DEBUG_PEERINFO
581       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
582                   "Requesting list of peers from PEERINFO service\n");
583 #endif
584       tqe = GNUNET_malloc (sizeof (struct TransmissionQueueEntry) +
585                            sizeof (struct GNUNET_MessageHeader));
586       tqe->size = sizeof (struct GNUNET_MessageHeader);
587       lapm = (struct GNUNET_MessageHeader *) &tqe[1];
588       lapm->size = htons (sizeof (struct GNUNET_MessageHeader));
589       lapm->type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL);
590     }
591   else
592     {
593 #if DEBUG_PEERINFO
594       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
595                   "Requesting information on peer `%4s' from PEERINFO service\n",
596                   GNUNET_i2s (peer));
597 #endif
598       tqe = GNUNET_malloc (sizeof (struct TransmissionQueueEntry) +
599                            sizeof (struct ListPeerMessage));
600       tqe->size = sizeof (struct ListPeerMessage);
601       lpm = (struct ListPeerMessage *) &tqe[1];
602       lpm->header.size = htons (sizeof (struct ListPeerMessage));
603       lpm->header.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_GET);
604       memcpy (&lpm->peer, peer, sizeof (struct GNUNET_PeerIdentity));
605     }
606   ic = GNUNET_malloc (sizeof (struct GNUNET_PEERINFO_IteratorContext));
607   ic->h = h;
608   ic->tqe = tqe;
609   ic->callback = callback;
610   ic->callback_cls = callback_cls;
611   ic->timeout = GNUNET_TIME_relative_to_absolute (timeout);
612   ic->timeout_task = GNUNET_SCHEDULER_add_delayed (timeout,
613                                                    &signal_timeout,
614                                                    ic);
615   tqe->timeout = ic->timeout;
616   tqe->cont = &iterator_start_receive;
617   tqe->cont_cls = ic;
618   tqe->timeout = ic->timeout;
619   GNUNET_CONTAINER_DLL_insert_after (h->tq_head,
620                                      h->tq_tail,
621                                      h->tq_tail,
622                                      tqe);
623   trigger_transmit (h);
624   return ic;
625 }
626
627
628
629 /**
630  * Cancel an iteration over peer information.
631  *
632  * @param ic context of the iterator to cancel
633  */
634 void
635 GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic)
636 {
637   if (ic->timeout_task != GNUNET_SCHEDULER_NO_TASK)
638     {
639       GNUNET_SCHEDULER_cancel (ic->timeout_task);
640       ic->timeout_task = GNUNET_SCHEDULER_NO_TASK;
641     }
642   ic->callback = NULL;
643   if (ic->in_receive)
644     return; /* need to finish processing */
645   GNUNET_CONTAINER_DLL_remove (ic->h->tq_head,
646                                ic->h->tq_tail,
647                                ic->tqe);
648   GNUNET_free (ic->tqe);
649   GNUNET_free (ic);
650 }
651
652
653 /* end of peerinfo_api.c */