use enum GNUNET_ATS_Network_Type instead of uint32_t where appropriate
[oweals/gnunet.git] / src / transport / transport_api.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009-2013 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 transport/transport_api.c
23  * @brief library to access the low-level P2P IO service
24  * @author Christian Grothoff
25  *
26  * TODO:
27  * - test test test
28  */
29 #include "platform.h"
30 #include "gnunet_util_lib.h"
31 #include "gnunet_constants.h"
32 #include "gnunet_arm_service.h"
33 #include "gnunet_hello_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_transport_service.h"
36 #include "transport.h"
37
38 #define LOG(kind,...) GNUNET_log_from (kind, "transport-api",__VA_ARGS__)
39
40 /**
41  * How large to start with for the hashmap of neighbours.
42  */
43 #define STARTING_NEIGHBOURS_SIZE 16
44
45 /**
46  * Handle for a message that should be transmitted to the service.
47  * Used for both control messages and normal messages.
48  */
49 struct GNUNET_TRANSPORT_TransmitHandle
50 {
51
52   /**
53    * We keep all requests in a DLL.
54    */
55   struct GNUNET_TRANSPORT_TransmitHandle *next;
56
57   /**
58    * We keep all requests in a DLL.
59    */
60   struct GNUNET_TRANSPORT_TransmitHandle *prev;
61
62   /**
63    * Neighbour for this handle, NULL for control messages.
64    */
65   struct Neighbour *neighbour;
66
67   /**
68    * Function to call when notify_size bytes are available
69    * for transmission.
70    */
71   GNUNET_CONNECTION_TransmitReadyNotify notify;
72
73   /**
74    * Closure for notify.
75    */
76   void *notify_cls;
77
78   /**
79    * Timeout for this request, 0 for control messages.
80    */
81   struct GNUNET_TIME_Absolute timeout;
82
83   /**
84    * Task to trigger request timeout if the request is stalled due to
85    * congestion.
86    */
87   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
88
89   /**
90    * How many bytes is our notify callback waiting for?
91    */
92   size_t notify_size;
93
94   /**
95    * How important is this message? Not used for control messages.
96    */
97   uint32_t priority;
98
99 };
100
101
102 /**
103  * Entry in hash table of all of our current neighbours.
104  */
105 struct Neighbour
106 {
107   /**
108    * Overall transport handle.
109    */
110   struct GNUNET_TRANSPORT_Handle *h;
111
112   /**
113    * Active transmit handle or NULL.
114    */
115   struct GNUNET_TRANSPORT_TransmitHandle *th;
116
117   /**
118    * Identity of this neighbour.
119    */
120   struct GNUNET_PeerIdentity id;
121
122   /**
123    * Outbound bandwidh tracker.
124    */
125   struct GNUNET_BANDWIDTH_Tracker out_tracker;
126
127   /**
128    * Entry in our readyness heap (which is sorted by 'next_ready'
129    * value).  NULL if there is no pending transmission request for
130    * this neighbour or if we're waiting for 'is_ready' to become
131    * true AFTER the 'out_tracker' suggested that this peer's quota
132    * has been satisfied (so once 'is_ready' goes to GNUNET_YES,
133    * we should immediately go back into the heap).
134    */
135   struct GNUNET_CONTAINER_HeapNode *hn;
136
137   /**
138    * Is this peer currently ready to receive a message?
139    */
140   int is_ready;
141
142   /**
143    * Sending consumed more bytes on wire than payload was announced
144    * This overhead is added to the delay of next sending operation
145    */
146   size_t traffic_overhead;
147 };
148
149
150 /**
151  * Linked list of functions to call whenever our HELLO is updated.
152  */
153 struct GNUNET_TRANSPORT_GetHelloHandle
154 {
155
156   /**
157    * This is a doubly linked list.
158    */
159   struct GNUNET_TRANSPORT_GetHelloHandle *next;
160
161   /**
162    * This is a doubly linked list.
163    */
164   struct GNUNET_TRANSPORT_GetHelloHandle *prev;
165
166   /**
167    * Transport handle.
168    */
169   struct GNUNET_TRANSPORT_Handle *handle;
170
171   /**
172    * Callback to call once we got our HELLO.
173    */
174   GNUNET_TRANSPORT_HelloUpdateCallback rec;
175
176   /**
177    * Task for calling the HelloUpdateCallback when we already have a HELLO
178    */
179   GNUNET_SCHEDULER_TaskIdentifier notify_task;
180
181   /**
182    * Closure for @e rec.
183    */
184   void *rec_cls;
185
186 };
187
188 /**
189  * Linked list for all try-connect requests
190  */
191 struct GNUNET_TRANSPORT_TryConnectHandle
192 {
193   /**
194    * For the DLL.
195    */
196   struct GNUNET_TRANSPORT_TryConnectHandle *prev;
197
198   /**
199    * For the DLL.
200    */
201   struct GNUNET_TRANSPORT_TryConnectHandle *next;
202
203   struct GNUNET_PeerIdentity pid;
204
205   struct GNUNET_TRANSPORT_Handle *th;
206
207   struct GNUNET_TRANSPORT_TransmitHandle *tth;
208
209   GNUNET_TRANSPORT_TryConnectCallback cb;
210
211   /**
212    * Closure for @e cb.
213    */
214   void *cb_cls;
215 };
216
217
218 /**
219  * Linked list for all try-connect requests
220  */
221 struct GNUNET_TRANSPORT_OfferHelloHandle
222 {
223   /**
224    * For the DLL.
225    */
226   struct GNUNET_TRANSPORT_OfferHelloHandle *prev;
227
228   /**
229    * For the DLL.
230    */
231   struct GNUNET_TRANSPORT_OfferHelloHandle *next;
232
233   struct GNUNET_TRANSPORT_Handle *th;
234
235   struct GNUNET_TRANSPORT_TransmitHandle *tth;
236
237   GNUNET_SCHEDULER_Task cont;
238
239   /**
240    * Closure for @e cont
241    */
242   void *cls;
243
244   struct GNUNET_MessageHeader *msg;
245 };
246
247
248 /**
249  * Handle for the transport service (includes all of the
250  * state for the transport service).
251  */
252 struct GNUNET_TRANSPORT_Handle
253 {
254
255   /**
256    * Closure for the callbacks.
257    */
258   void *cls;
259
260   /**
261    * Function to call for received data.
262    */
263   GNUNET_TRANSPORT_ReceiveCallback rec;
264
265   /**
266    * function to call on connect events
267    */
268   GNUNET_TRANSPORT_NotifyConnect nc_cb;
269
270   /**
271    * function to call on disconnect events
272    */
273   GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
274
275   /**
276    * Head of DLL of control messages.
277    */
278   struct GNUNET_TRANSPORT_TransmitHandle *control_head;
279
280   /**
281    * Tail of DLL of control messages.
282    */
283   struct GNUNET_TRANSPORT_TransmitHandle *control_tail;
284
285   /**
286    * The current HELLO message for this peer.  Updated
287    * whenever transports change their addresses.
288    */
289   struct GNUNET_HELLO_Message *my_hello;
290
291   /**
292    * My client connection to the transport service.
293    */
294   struct GNUNET_CLIENT_Connection *client;
295
296   /**
297    * Handle to our registration with the client for notification.
298    */
299   struct GNUNET_CLIENT_TransmitHandle *cth;
300
301   /**
302    * Linked list of pending requests for our HELLO.
303    */
304   struct GNUNET_TRANSPORT_GetHelloHandle *hwl_head;
305
306   /**
307    * Linked list of pending requests for our HELLO.
308    */
309   struct GNUNET_TRANSPORT_GetHelloHandle *hwl_tail;
310
311   /**
312    * Linked list of pending try connect requests head
313    */
314   struct GNUNET_TRANSPORT_TryConnectHandle *tc_head;
315
316   /**
317    * Linked list of pending try connect requests tail
318    */
319   struct GNUNET_TRANSPORT_TryConnectHandle *tc_tail;
320
321   /**
322    * Linked list of pending offer HELLO requests head
323    */
324   struct GNUNET_TRANSPORT_OfferHelloHandle *oh_head;
325
326   /**
327    * Linked list of pending offer HELLO requests tail
328    */
329   struct GNUNET_TRANSPORT_OfferHelloHandle *oh_tail;
330
331   /**
332    * My configuration.
333    */
334   const struct GNUNET_CONFIGURATION_Handle *cfg;
335
336   /**
337    * Hash map of the current connected neighbours of this peer.
338    * Maps peer identities to 'struct Neighbour' entries.
339    */
340   struct GNUNET_CONTAINER_MultiPeerMap *neighbours;
341
342   /**
343    * Heap sorting peers with pending messages by the timestamps that
344    * specify when we could next send a message to the respective peer.
345    * Excludes control messages (which can always go out immediately).
346    * Maps time stamps to 'struct Neighbour' entries.
347    */
348   struct GNUNET_CONTAINER_Heap *ready_heap;
349
350   /**
351    * Peer identity as assumed by this process, or all zeros.
352    */
353   struct GNUNET_PeerIdentity self;
354
355   /**
356    * ID of the task trying to reconnect to the service.
357    */
358   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
359
360   /**
361    * ID of the task trying to trigger transmission for a peer while
362    * maintaining bandwidth quotas.  In use if there are no control
363    * messages and the smallest entry in the 'ready_heap' has a time
364    * stamp in the future.
365    */
366   GNUNET_SCHEDULER_TaskIdentifier quota_task;
367
368   /**
369    * Delay until we try to reconnect.
370    */
371   struct GNUNET_TIME_Relative reconnect_delay;
372
373   /**
374    * Should we check that @e self matches what the service thinks?
375    * (if #GNUNET_NO, then @e self is all zeros!).
376    */
377   int check_self;
378
379   /**
380    * Reconnect in progress
381    */
382   int reconnecting;
383 };
384
385
386
387 /**
388  * Schedule the task to send one message, either from the control
389  * list or the peer message queues  to the service.
390  *
391  * @param h transport service to schedule a transmission for
392  */
393 static void
394 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
395
396
397 /**
398  * Function that will schedule the job that will try
399  * to connect us again to the client.
400  *
401  * @param h transport service to reconnect
402  */
403 static void
404 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h);
405
406
407 /**
408  * Get the neighbour list entry for the given peer
409  *
410  * @param h our context
411  * @param peer peer to look up
412  * @return NULL if no such peer entry exists
413  */
414 static struct Neighbour *
415 neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
416                 const struct GNUNET_PeerIdentity *peer)
417 {
418   return GNUNET_CONTAINER_multipeermap_get (h->neighbours, peer);
419 }
420
421
422 /**
423  * Add neighbour to our list
424  *
425  * @return NULL if this API is currently disconnecting from the service
426  */
427 static struct Neighbour *
428 neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
429                const struct GNUNET_PeerIdentity *pid)
430 {
431   struct Neighbour *n;
432
433   LOG (GNUNET_ERROR_TYPE_DEBUG,
434        "Creating entry for neighbour `%4s'.\n",
435        GNUNET_i2s (pid));
436   n = GNUNET_new (struct Neighbour);
437   n->id = *pid;
438   n->h = h;
439   n->is_ready = GNUNET_YES;
440   n->traffic_overhead = 0;
441   GNUNET_BANDWIDTH_tracker_init (&n->out_tracker,
442                                  GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
443                                  MAX_BANDWIDTH_CARRY_S);
444   GNUNET_assert (GNUNET_OK ==
445                  GNUNET_CONTAINER_multipeermap_put (h->neighbours,
446                                                     &n->id, n,
447                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
448   return n;
449 }
450
451
452 /**
453  * Iterator over hash map entries, for deleting state of a neighbour.
454  *
455  * @param cls the `struct GNUNET_TRANSPORT_Handle *`
456  * @param key peer identity
457  * @param value value in the hash map, the neighbour entry to delete
458  * @return #GNUNET_YES if we should continue to
459  *         iterate,
460  *         #GNUNET_NO if not.
461  */
462 static int
463 neighbour_delete (void *cls,
464                   const struct GNUNET_PeerIdentity *key, void *value)
465 {
466   struct GNUNET_TRANSPORT_Handle *handle = cls;
467   struct Neighbour *n = value;
468
469   if (NULL != handle->nd_cb)
470     handle->nd_cb (handle->cls, &n->id);
471   GNUNET_assert (NULL == n->th);
472   GNUNET_assert (NULL == n->hn);
473   GNUNET_assert (GNUNET_YES ==
474                  GNUNET_CONTAINER_multipeermap_remove (handle->neighbours, key,
475                                                        n));
476   GNUNET_free (n);
477   return GNUNET_YES;
478 }
479
480
481 /**
482  * Function we use for handling incoming messages.
483  *
484  * @param cls closure, a `struct GNUNET_TRANSPORT_Handle *`
485  * @param msg message received, NULL on timeout or fatal error
486  */
487 static void
488 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
489 {
490   struct GNUNET_TRANSPORT_Handle *h = cls;
491   const struct DisconnectInfoMessage *dim;
492   const struct ConnectInfoMessage *cim;
493   const struct InboundMessage *im;
494   const struct GNUNET_MessageHeader *imm;
495   const struct SendOkMessage *okm;
496   const struct QuotaSetMessage *qm;
497   struct GNUNET_TRANSPORT_GetHelloHandle *hwl;
498   struct GNUNET_TRANSPORT_GetHelloHandle *next_hwl;
499   struct Neighbour *n;
500   struct GNUNET_PeerIdentity me;
501   uint16_t size;
502   uint32_t bytes_msg;
503   uint32_t bytes_physical;
504
505   GNUNET_assert (NULL != h->client);
506   if (NULL == msg)
507   {
508     LOG (GNUNET_ERROR_TYPE_DEBUG,
509          "Error receiving from transport service, disconnecting temporarily.\n");
510     disconnect_and_schedule_reconnect (h);
511     return;
512   }
513   GNUNET_CLIENT_receive (h->client, &demultiplexer, h,
514                          GNUNET_TIME_UNIT_FOREVER_REL);
515   size = ntohs (msg->size);
516   switch (ntohs (msg->type))
517   {
518   case GNUNET_MESSAGE_TYPE_HELLO:
519     if (GNUNET_OK !=
520         GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg, &me))
521     {
522       GNUNET_break (0);
523       break;
524     }
525     LOG (GNUNET_ERROR_TYPE_DEBUG,
526          "Receiving (my own) `%s' message, I am `%4s'.\n", "HELLO",
527          GNUNET_i2s (&me));
528     GNUNET_free_non_null (h->my_hello);
529     h->my_hello = NULL;
530     if (size < sizeof (struct GNUNET_MessageHeader))
531     {
532       GNUNET_break (0);
533       break;
534     }
535     h->my_hello = GNUNET_malloc (size);
536     memcpy (h->my_hello, msg, size);
537     hwl = h->hwl_head;
538     while (NULL != hwl)
539     {
540       next_hwl = hwl->next;
541       hwl->rec (hwl->rec_cls,
542                 (const struct GNUNET_MessageHeader *) h->my_hello);
543       hwl = next_hwl;
544     }
545     break;
546   case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
547     if (size < sizeof (struct ConnectInfoMessage))
548     {
549       GNUNET_break (0);
550       break;
551     }
552     cim = (const struct ConnectInfoMessage *) msg;
553     if (size !=
554         sizeof (struct ConnectInfoMessage))
555     {
556       GNUNET_break (0);
557       break;
558     }
559     LOG (GNUNET_ERROR_TYPE_DEBUG,
560          "Receiving `%s' message for `%4s'.\n",
561          "CONNECT", GNUNET_i2s (&cim->id));
562     n = neighbour_find (h, &cim->id);
563     if (NULL != n)
564     {
565       GNUNET_break (0);
566       break;
567     }
568     n = neighbour_add (h, &cim->id);
569     LOG (GNUNET_ERROR_TYPE_DEBUG,
570          "Receiving `%s' message for `%4s' with quota %u\n",
571          "CONNECT",
572          GNUNET_i2s (&cim->id),
573          ntohl (cim->quota_out.value__));
574     GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker, cim->quota_out);
575     if (h->nc_cb != NULL)
576       h->nc_cb (h->cls, &n->id);
577     break;
578   case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
579     if (size != sizeof (struct DisconnectInfoMessage))
580     {
581       GNUNET_break (0);
582       break;
583     }
584     dim = (const struct DisconnectInfoMessage *) msg;
585     GNUNET_break (ntohl (dim->reserved) == 0);
586     LOG (GNUNET_ERROR_TYPE_DEBUG,
587          "Receiving `%s' message for `%4s'.\n",
588          "DISCONNECT", GNUNET_i2s (&dim->peer));
589     n = neighbour_find (h, &dim->peer);
590     if (NULL == n)
591     {
592       GNUNET_break (0);
593       break;
594     }
595     neighbour_delete (h, &dim->peer, n);
596     break;
597   case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
598     if (size != sizeof (struct SendOkMessage))
599     {
600       GNUNET_break (0);
601       break;
602     }
603     okm = (const struct SendOkMessage *) msg;
604     bytes_msg = ntohl (okm->bytes_msg);
605     bytes_physical = ntohl (okm->bytes_physical);
606     LOG (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message, transmission %s.\n",
607          "SEND_OK", ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
608
609     n = neighbour_find (h, &okm->peer);
610     if (NULL == n)
611       break;
612
613     if (bytes_physical >= bytes_msg)
614     {
615         LOG (GNUNET_ERROR_TYPE_DEBUG, "Overhead for %u byte message: %u \n",
616             bytes_msg, bytes_physical - bytes_msg);
617       n->traffic_overhead += bytes_physical - bytes_msg;
618     }
619     GNUNET_break (GNUNET_NO == n->is_ready);
620     n->is_ready = GNUNET_YES;
621     if ((NULL != n->th) && (NULL == n->hn))
622     {
623       GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != n->th->timeout_task);
624       GNUNET_SCHEDULER_cancel (n->th->timeout_task);
625       n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
626       /* we've been waiting for this (congestion, not quota,
627        * caused delayed transmission) */
628       n->hn = GNUNET_CONTAINER_heap_insert (h->ready_heap, n, 0);
629       schedule_transmission (h);
630     }
631     break;
632   case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
633     LOG (GNUNET_ERROR_TYPE_DEBUG,
634          "Receiving `%s' message.\n",
635          "RECV");
636     if (size <
637         sizeof (struct InboundMessage) + sizeof (struct GNUNET_MessageHeader))
638     {
639       GNUNET_break (0);
640       break;
641     }
642     im = (const struct InboundMessage *) msg;
643     imm = (const struct GNUNET_MessageHeader *) &im[1];
644     if (ntohs (imm->size) + sizeof (struct InboundMessage) != size)
645     {
646       GNUNET_break (0);
647       break;
648     }
649     LOG (GNUNET_ERROR_TYPE_DEBUG,
650          "Received message of type %u from `%4s'.\n",
651          ntohs (imm->type), GNUNET_i2s (&im->peer));
652     n = neighbour_find (h, &im->peer);
653     if (NULL == n)
654     {
655       GNUNET_break (0);
656       break;
657     }
658     if (NULL != h->rec)
659       h->rec (h->cls, &im->peer, imm);
660     break;
661   case GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA:
662     LOG (GNUNET_ERROR_TYPE_DEBUG,
663          "Receiving `%s' message.\n", "SET_QUOTA");
664     if (size != sizeof (struct QuotaSetMessage))
665     {
666       GNUNET_break (0);
667       break;
668     }
669     qm = (const struct QuotaSetMessage *) msg;
670     n = neighbour_find (h, &qm->peer);
671     if (NULL == n)
672       break;
673     LOG (GNUNET_ERROR_TYPE_DEBUG,
674          "Receiving `%s' message for `%4s' with quota %u\n",
675          "SET_QUOTA",
676          GNUNET_i2s (&qm->peer),
677          ntohl (qm->quota.value__));
678     GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker, qm->quota);
679     break;
680   default:
681     LOG (GNUNET_ERROR_TYPE_ERROR,
682          _("Received unexpected message of type %u in %s:%u\n"),
683          ntohs (msg->type), __FILE__, __LINE__);
684     GNUNET_break (0);
685     break;
686   }
687 }
688
689
690 /**
691  * A transmission request could not be satisfied because of
692  * network congestion.  Notify the initiator and clean up.
693  *
694  * @param cls the `struct GNUNET_TRANSPORT_TransmitHandle`
695  * @param tc scheduler context
696  */
697 static void
698 timeout_request_due_to_congestion (void *cls,
699                                    const struct GNUNET_SCHEDULER_TaskContext *tc)
700 {
701   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
702   struct Neighbour *n = th->neighbour;
703
704   n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
705   GNUNET_assert (th == n->th);
706   GNUNET_assert (NULL == n->hn);
707   n->th = NULL;
708   th->notify (th->notify_cls, 0, NULL);
709   GNUNET_free (th);
710 }
711
712
713 /**
714  * Transmit message(s) to service.
715  *
716  * @param cls handle to transport
717  * @param size number of bytes available in @a buf
718  * @param buf where to copy the message
719  * @return number of bytes copied to @a buf
720  */
721 static size_t
722 transport_notify_ready (void *cls, size_t size, void *buf)
723 {
724   struct GNUNET_TRANSPORT_Handle *h = cls;
725   struct GNUNET_TRANSPORT_TransmitHandle *th;
726   struct Neighbour *n;
727   char *cbuf;
728   struct OutboundMessage obm;
729   size_t ret;
730   size_t nret;
731   size_t mret;
732
733   GNUNET_assert (NULL != h->client);
734   h->cth = NULL;
735   if (NULL == buf)
736   {
737     /* transmission failed */
738     disconnect_and_schedule_reconnect (h);
739     return 0;
740   }
741
742   cbuf = buf;
743   ret = 0;
744   /* first send control messages */
745   while ((NULL != (th = h->control_head)) && (th->notify_size <= size))
746   {
747     GNUNET_CONTAINER_DLL_remove (h->control_head, h->control_tail, th);
748     nret = th->notify (th->notify_cls, size, &cbuf[ret]);
749     LOG (GNUNET_ERROR_TYPE_DEBUG,
750          "Added %u bytes of control message at %u\n",
751          nret, ret);
752     GNUNET_free (th);
753     ret += nret;
754     size -= nret;
755   }
756
757   /* then, if possible and no control messages pending, send data messages */
758   while ((NULL == h->control_head) &&
759          (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))))
760   {
761     if (GNUNET_YES != n->is_ready)
762     {
763       /* peer not ready, wait for notification! */
764       GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
765       n->hn = NULL;
766       GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == n->th->timeout_task);
767       n->th->timeout_task =
768           GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
769                                         (n->th->timeout),
770                                         &timeout_request_due_to_congestion,
771                                         n->th);
772       continue;
773     }
774     th = n->th;
775     if (th->notify_size + sizeof (struct OutboundMessage) > size)
776       break;                    /* does not fit */
777     if (GNUNET_BANDWIDTH_tracker_get_delay
778         (&n->out_tracker, th->notify_size).rel_value_us > 0)
779       break;                    /* too early */
780     GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
781     n->hn = NULL;
782     n->th = NULL;
783     n->is_ready = GNUNET_NO;
784     GNUNET_assert (size >= sizeof (struct OutboundMessage));
785     mret =
786         th->notify (th->notify_cls, size - sizeof (struct OutboundMessage),
787                     &cbuf[ret + sizeof (struct OutboundMessage)]);
788     GNUNET_assert (mret <= size - sizeof (struct OutboundMessage));
789     if (mret != 0)
790     {
791       GNUNET_assert (mret + sizeof (struct OutboundMessage) <
792                      GNUNET_SERVER_MAX_MESSAGE_SIZE);
793       obm.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
794       obm.header.size = htons (mret + sizeof (struct OutboundMessage));
795       obm.priority = htonl (th->priority);
796       obm.timeout =
797           GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining
798                                      (th->timeout));
799       obm.peer = n->id;
800       memcpy (&cbuf[ret], &obm, sizeof (struct OutboundMessage));
801       ret += (mret + sizeof (struct OutboundMessage));
802       size -= (mret + sizeof (struct OutboundMessage));
803       GNUNET_BANDWIDTH_tracker_consume (&n->out_tracker, mret);
804     }
805     GNUNET_free (th);
806   }
807   /* if there are more pending messages, try to schedule those */
808   schedule_transmission (h);
809   LOG (GNUNET_ERROR_TYPE_DEBUG,
810        "Transmitting %u bytes to transport service\n",
811        ret);
812   return ret;
813 }
814
815
816 /**
817  * Schedule the task to send one message, either from the control
818  * list or the peer message queues  to the service.
819  *
820  * @param cls transport service to schedule a transmission for
821  * @param tc scheduler context
822  */
823 static void
824 schedule_transmission_task (void *cls,
825                             const struct GNUNET_SCHEDULER_TaskContext *tc)
826 {
827   struct GNUNET_TRANSPORT_Handle *h = cls;
828   size_t size;
829   struct GNUNET_TRANSPORT_TransmitHandle *th;
830   struct Neighbour *n;
831
832   h->quota_task = GNUNET_SCHEDULER_NO_TASK;
833   GNUNET_assert (NULL != h->client);
834   /* destroy all requests that have timed out */
835   while ((NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))) &&
836          (0 == GNUNET_TIME_absolute_get_remaining (n->th->timeout).rel_value_us))
837   {
838     /* notify client that the request could not be satisfied within
839      * the given time constraints */
840     th = n->th;
841     n->th = NULL;
842     GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
843     n->hn = NULL;
844     LOG (GNUNET_ERROR_TYPE_DEBUG,
845          "Signalling timeout for transmission to peer %s due to congestion\n",
846          GNUNET_i2s (&n->id));
847     GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
848     GNUNET_free (th);
849   }
850   if (NULL != h->cth)
851     return;
852   if (NULL != h->control_head)
853   {
854     size = h->control_head->notify_size;
855   }
856   else
857   {
858     n = GNUNET_CONTAINER_heap_peek (h->ready_heap);
859     if (NULL == n)
860       return;                   /* no pending messages */
861     size = n->th->notify_size + sizeof (struct OutboundMessage);
862   }
863   LOG (GNUNET_ERROR_TYPE_DEBUG, "Calling notify_transmit_ready\n");
864   h->cth =
865       GNUNET_CLIENT_notify_transmit_ready (h->client, size,
866                                            GNUNET_TIME_UNIT_FOREVER_REL,
867                                            GNUNET_NO, &transport_notify_ready,
868                                            h);
869   GNUNET_assert (NULL != h->cth);
870 }
871
872
873 /**
874  * Schedule the task to send one message, either from the control
875  * list or the peer message queues  to the service.
876  *
877  * @param h transport service to schedule a transmission for
878  */
879 static void
880 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
881 {
882   struct GNUNET_TIME_Relative delay;
883   struct Neighbour *n;
884
885   GNUNET_assert (NULL != h->client);
886   if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
887   {
888     GNUNET_SCHEDULER_cancel (h->quota_task);
889     h->quota_task = GNUNET_SCHEDULER_NO_TASK;
890   }
891   if (NULL != h->control_head)
892     delay = GNUNET_TIME_UNIT_ZERO;
893   else if (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap)))
894   {
895     delay =
896         GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
897                                             n->th->notify_size + n->traffic_overhead);
898     n->traffic_overhead = 0;
899   }
900   else
901     return;                     /* no work to be done */
902   LOG (GNUNET_ERROR_TYPE_DEBUG,
903        "Scheduling next transmission to service in %s\n",
904        GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
905   h->quota_task =
906       GNUNET_SCHEDULER_add_delayed (delay, &schedule_transmission_task, h);
907 }
908
909
910 /**
911  * Queue control request for transmission to the transport
912  * service.
913  *
914  * @param h handle to the transport service
915  * @param size number of bytes to be transmitted
916  * @param notify function to call to get the content
917  * @param notify_cls closure for @a notify
918  * @return a `struct GNUNET_TRANSPORT_TransmitHandle`
919  */
920 static struct GNUNET_TRANSPORT_TransmitHandle *
921 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h, size_t size,
922                            GNUNET_CONNECTION_TransmitReadyNotify notify,
923                            void *notify_cls)
924 {
925   struct GNUNET_TRANSPORT_TransmitHandle *th;
926
927   LOG (GNUNET_ERROR_TYPE_DEBUG,
928        "Control transmit of %u bytes requested\n",
929        size);
930   th = GNUNET_new (struct GNUNET_TRANSPORT_TransmitHandle);
931   th->notify = notify;
932   th->notify_cls = notify_cls;
933   th->notify_size = size;
934   GNUNET_CONTAINER_DLL_insert_tail (h->control_head, h->control_tail, th);
935   schedule_transmission (h);
936   return th;
937 }
938
939
940 /**
941  * Transmit START message to service.
942  *
943  * @param cls unused
944  * @param size number of bytes available in @a buf
945  * @param buf where to copy the message
946  * @return number of bytes copied to @a buf
947  */
948 static size_t
949 send_start (void *cls, size_t size, void *buf)
950 {
951   struct GNUNET_TRANSPORT_Handle *h = cls;
952   struct StartMessage s;
953   uint32_t options;
954
955   if (NULL == buf)
956   {
957     /* Can only be shutdown, just give up */
958     LOG (GNUNET_ERROR_TYPE_DEBUG,
959          "Shutdown while trying to transmit `%s' request.\n",
960          "START");
961     return 0;
962   }
963   LOG (GNUNET_ERROR_TYPE_DEBUG,
964        "Transmitting `%s' request.\n",
965        "START");
966   GNUNET_assert (size >= sizeof (struct StartMessage));
967   s.header.size = htons (sizeof (struct StartMessage));
968   s.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
969   options = 0;
970   if (h->check_self)
971     options |= 1;
972   if (h->rec != NULL)
973     options |= 2;
974   s.options = htonl (options);
975   s.self = h->self;
976   memcpy (buf, &s, sizeof (struct StartMessage));
977   GNUNET_CLIENT_receive (h->client, &demultiplexer, h,
978                          GNUNET_TIME_UNIT_FOREVER_REL);
979   return sizeof (struct StartMessage);
980 }
981
982
983 /**
984  * Try again to connect to transport service.
985  *
986  * @param cls the handle to the transport service
987  * @param tc scheduler context
988  */
989 static void
990 reconnect (void *cls,
991            const struct GNUNET_SCHEDULER_TaskContext *tc)
992 {
993   struct GNUNET_TRANSPORT_Handle *h = cls;
994
995   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
996   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
997   {
998     /* shutdown, just give up */
999     return;
1000   }
1001   LOG (GNUNET_ERROR_TYPE_DEBUG,
1002        "Connecting to transport service.\n");
1003   GNUNET_assert (NULL == h->client);
1004   GNUNET_assert (NULL == h->control_head);
1005   GNUNET_assert (NULL == h->control_tail);
1006   h->client = GNUNET_CLIENT_connect ("transport", h->cfg);
1007   GNUNET_assert (NULL != h->client);
1008   schedule_control_transmit (h, sizeof (struct StartMessage), &send_start, h);
1009 }
1010
1011
1012 /**
1013  * Function that will schedule the job that will try
1014  * to connect us again to the client.
1015  *
1016  * @param h transport service to reconnect
1017  */
1018 static void
1019 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1020 {
1021   struct GNUNET_TRANSPORT_TransmitHandle *th;
1022
1023   GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1024   if (NULL != h->cth)
1025   {
1026     GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
1027     h->cth = NULL;
1028   }
1029   if (NULL != h->client)
1030   {
1031     GNUNET_CLIENT_disconnect (h->client);
1032     h->client = NULL;
1033   }
1034   /* Forget about all neighbours that we used to be connected to */
1035   GNUNET_CONTAINER_multipeermap_iterate (h->neighbours,
1036                                          &neighbour_delete, h);
1037   if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
1038   {
1039     GNUNET_SCHEDULER_cancel (h->quota_task);
1040     h->quota_task = GNUNET_SCHEDULER_NO_TASK;
1041   }
1042   while ((NULL != (th = h->control_head)))
1043   {
1044     GNUNET_CONTAINER_DLL_remove (h->control_head, h->control_tail, th);
1045     th->notify (th->notify_cls, 0, NULL);
1046     GNUNET_free (th);
1047   }
1048   LOG (GNUNET_ERROR_TYPE_DEBUG,
1049        "Scheduling task to reconnect to transport service in %s.\n",
1050        GNUNET_STRINGS_relative_time_to_string(h->reconnect_delay, GNUNET_YES));
1051   h->reconnect_task =
1052       GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect, h);
1053   h->reconnect_delay = GNUNET_TIME_STD_BACKOFF (h->reconnect_delay);
1054 }
1055
1056
1057 /**
1058  * Cancel control request for transmission to the transport service.
1059  *
1060  * @param th handle to the transport service
1061  * @param tth transmit handle to cancel
1062  */
1063 static void
1064 cancel_control_transmit (struct GNUNET_TRANSPORT_Handle *th,
1065                          struct GNUNET_TRANSPORT_TransmitHandle *tth)
1066 {
1067   LOG (GNUNET_ERROR_TYPE_DEBUG,
1068        "Canceling transmit of contral transmission requested\n");
1069   GNUNET_CONTAINER_DLL_remove (th->control_head, th->control_tail, tth);
1070   GNUNET_free (tth);
1071 }
1072
1073
1074
1075 /**
1076  * Send REQUEST_CONNECT message to the service.
1077  *
1078  * @param cls the `struct GNUNET_PeerIdentity`
1079  * @param size number of bytes available in @a buf
1080  * @param buf where to copy the message
1081  * @return number of bytes copied to @a buf
1082  */
1083 static size_t
1084 send_try_connect (void *cls, size_t size, void *buf)
1085 {
1086   struct GNUNET_TRANSPORT_TryConnectHandle *tch = cls;
1087   struct TransportRequestConnectMessage msg;
1088
1089   if (buf == NULL)
1090   {
1091     if (NULL != tch->cb)
1092       tch->cb (tch->cb_cls, GNUNET_SYSERR);
1093     GNUNET_CONTAINER_DLL_remove (tch->th->tc_head, tch->th->tc_tail, tch);
1094     LOG (GNUNET_ERROR_TYPE_DEBUG,
1095          "Discarding  `%s' request to `%4s' due to error in transport service connection.\n",
1096          "REQUEST_CONNECT",
1097          GNUNET_i2s (&tch->pid));
1098     GNUNET_free (tch);
1099     return 0;
1100   }
1101   LOG (GNUNET_ERROR_TYPE_DEBUG,
1102        "Transmitting `%s' request with respect to `%4s'.\n",
1103        "REQUEST_CONNECT",
1104        GNUNET_i2s (&tch->pid));
1105   GNUNET_assert (size >= sizeof (struct TransportRequestConnectMessage));
1106   msg.header.size = htons (sizeof (struct TransportRequestConnectMessage));
1107   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT);
1108   msg.reserved = htonl (0);
1109   msg.peer = tch->pid;
1110   memcpy (buf, &msg, sizeof (msg));
1111   if (NULL != tch->cb)
1112     tch->cb (tch->cb_cls, GNUNET_OK);
1113   GNUNET_CONTAINER_DLL_remove (tch->th->tc_head, tch->th->tc_tail, tch);
1114   GNUNET_free (tch);
1115   return sizeof (struct TransportRequestConnectMessage);
1116 }
1117
1118 /**
1119  * Ask the transport service to establish a connection to
1120  * the given peer.
1121  *
1122  * @param handle connection to transport service
1123  * @param target who we should try to connect to
1124  * @param cb callback to be called when request was transmitted to transport
1125  *         service
1126  * @param cb_cls closure for the callback
1127  * @return a `struct GNUNET_TRANSPORT_TryConnectHandle` handle or
1128  *         NULL on failure (cb will not be called)
1129  */
1130 struct GNUNET_TRANSPORT_TryConnectHandle *
1131 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
1132                               const struct GNUNET_PeerIdentity *target,
1133                               GNUNET_TRANSPORT_TryConnectCallback cb,
1134                               void *cb_cls)
1135 {
1136   struct GNUNET_TRANSPORT_TryConnectHandle *tch = NULL;
1137
1138   if (NULL == handle->client)
1139       return NULL;
1140   tch = GNUNET_new (struct GNUNET_TRANSPORT_TryConnectHandle);
1141   tch->th = handle;
1142   tch->pid = *(target);
1143   tch->cb = cb;
1144   tch->cb_cls = cb_cls;
1145   tch->tth = schedule_control_transmit (handle,
1146                                         sizeof (struct TransportRequestConnectMessage),
1147                                         &send_try_connect, tch);
1148   GNUNET_CONTAINER_DLL_insert(handle->tc_head, handle->tc_tail, tch);
1149   return tch;
1150 }
1151
1152
1153 /**
1154  * Cancel the request to transport to try a connect
1155  * Callback will not be called
1156  *
1157  * @param tch the handle to cancel
1158  */
1159 void
1160 GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch)
1161 {
1162   struct GNUNET_TRANSPORT_Handle *th;
1163
1164   th = tch->th;
1165   cancel_control_transmit (th, tch->tth);
1166   GNUNET_CONTAINER_DLL_remove (th->tc_head, th->tc_tail, tch);
1167   GNUNET_free (tch);
1168 }
1169
1170 /**
1171  * Send HELLO message to the service.
1172  *
1173  * @param cls the HELLO message to send
1174  * @param size number of bytes available in @a buf
1175  * @param buf where to copy the message
1176  * @return number of bytes copied to @a buf
1177  */
1178 static size_t
1179 send_hello (void *cls, size_t size, void *buf)
1180 {
1181   struct GNUNET_TRANSPORT_OfferHelloHandle *ohh = cls;
1182   struct GNUNET_MessageHeader *msg = ohh->msg;
1183   uint16_t ssize;
1184   struct GNUNET_SCHEDULER_TaskContext tc;
1185
1186   tc.read_ready = NULL;
1187   tc.write_ready = NULL;
1188   tc.reason = GNUNET_SCHEDULER_REASON_TIMEOUT;
1189   if (NULL == buf)
1190   {
1191     LOG (GNUNET_ERROR_TYPE_DEBUG,
1192          "Timeout while trying to transmit `%s' request.\n",
1193          "HELLO");
1194     if (NULL != ohh->cont)
1195       ohh->cont (ohh->cls, &tc);
1196     GNUNET_free (msg);
1197     GNUNET_CONTAINER_DLL_remove (ohh->th->oh_head, ohh->th->oh_tail, ohh);
1198     GNUNET_free (ohh);
1199     return 0;
1200   }
1201   LOG (GNUNET_ERROR_TYPE_DEBUG,
1202        "Transmitting `%s' request.\n",
1203        "HELLO");
1204   ssize = ntohs (msg->size);
1205   GNUNET_assert (size >= ssize);
1206   memcpy (buf, msg, ssize);
1207   GNUNET_free (msg);
1208   tc.reason = GNUNET_SCHEDULER_REASON_READ_READY;
1209   if (NULL != ohh->cont)
1210     ohh->cont (ohh->cls, &tc);
1211   GNUNET_CONTAINER_DLL_remove (ohh->th->oh_head, ohh->th->oh_tail, ohh);
1212   GNUNET_free (ohh);
1213   return ssize;
1214 }
1215
1216
1217 /**
1218  * Send traffic metric message to the service.
1219  *
1220  * @param cls the message to send
1221  * @param size number of bytes available in @a buf
1222  * @param buf where to copy the message
1223  * @return number of bytes copied to @a buf
1224  */
1225 static size_t
1226 send_metric (void *cls, size_t size, void *buf)
1227 {
1228   struct TrafficMetricMessage *msg = cls;
1229   uint16_t ssize;
1230
1231   if (NULL == buf)
1232   {
1233     LOG (GNUNET_ERROR_TYPE_DEBUG,
1234          "Timeout while trying to transmit `%s' request.\n",
1235          "TRAFFIC_METRIC");
1236     GNUNET_free (msg);
1237     return 0;
1238   }
1239   LOG (GNUNET_ERROR_TYPE_DEBUG,
1240        "Transmitting `%s' request.\n",
1241        "TRAFFIC_METRIC");
1242   ssize = ntohs (msg->header.size);
1243   GNUNET_assert (size >= ssize);
1244   memcpy (buf, msg, ssize);
1245   GNUNET_free (msg);
1246   return ssize;
1247 }
1248
1249
1250 /**
1251  * Set transport metrics for a peer and a direction
1252  *
1253  * @param handle transport handle
1254  * @param peer the peer to set the metric for
1255  * @param inbound set inbound direction (#GNUNET_YES or #GNUNET_NO)
1256  * @param outbound set outbound direction (#GNUNET_YES or #GNUNET_NO)
1257  * @param ats the metric as ATS information
1258  * @param ats_count the number of metrics
1259  *
1260  * Supported ATS values:
1261  * #GNUNET_ATS_QUALITY_NET_DELAY  (value in ms)
1262  * #GNUNET_ATS_QUALITY_NET_DISTANCE (value in count(hops))
1263  *
1264  * Example:
1265  * To enforce a delay of 10 ms for peer p1 in sending direction use:
1266  * <code>
1267  * struct GNUNET_ATS_Information ats;
1268  * ats.type = ntohl (GNUNET_ATS_QUALITY_NET_DELAY);
1269  * ats.value = ntohl (10);
1270  * GNUNET_TRANSPORT_set_traffic_metric (th, p1, TM_SEND, &ats, 1);
1271  * </code>
1272  * Note:
1273  * Delay restrictions in receiving direction will be enforced with
1274  * 1 message delay.
1275  */
1276 void
1277 GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
1278                                      const struct GNUNET_PeerIdentity *peer,
1279                                      int inbound,
1280                                      int outbound,
1281                                      const struct GNUNET_ATS_Information *ats,
1282                                      size_t ats_count)
1283 {
1284   struct TrafficMetricMessage *msg;
1285
1286   GNUNET_assert ((outbound == GNUNET_YES) || (outbound == GNUNET_NO));
1287   GNUNET_assert ((inbound == GNUNET_YES) || (inbound == GNUNET_NO));
1288   if ((GNUNET_NO == inbound) && (GNUNET_NO == outbound))
1289     return;
1290   if (0 == ats_count)
1291     return;
1292
1293   size_t len = sizeof (struct TrafficMetricMessage) +
1294     ats_count * sizeof (struct GNUNET_ATS_Information);
1295
1296   msg = GNUNET_malloc (len);
1297   msg->header.size = htons (len);
1298   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC);
1299   msg->direction = htons (0 + outbound + 2 * inbound);
1300   msg->ats_count = htons (ats_count);
1301   msg->peer = (*peer);
1302   memcpy (&msg[1], ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1303   schedule_control_transmit (handle, len, &send_metric, msg);
1304 }
1305
1306
1307
1308 /**
1309  * Offer the transport service the HELLO of another peer.  Note that
1310  * the transport service may just ignore this message if the HELLO is
1311  * malformed or useless due to our local configuration.
1312  *
1313  * @param handle connection to transport service
1314  * @param hello the hello message
1315  * @param cont continuation to call when HELLO has been sent,
1316  *      tc reason #GNUNET_SCHEDULER_REASON_TIMEOUT for fail
1317  *      tc reasong #GNUNET_SCHEDULER_REASON_READ_READY for success
1318  * @param cls closure for continuation
1319  * @return a `struct GNUNET_TRANSPORT_OfferHelloHandle` handle or NULL on failure,
1320  *      in case of failure cont will not be called
1321  *
1322  */
1323 struct GNUNET_TRANSPORT_OfferHelloHandle *
1324 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
1325                               const struct GNUNET_MessageHeader *hello,
1326                               GNUNET_SCHEDULER_Task cont, void *cls)
1327 {
1328   struct GNUNET_TRANSPORT_OfferHelloHandle *ohh;
1329   struct GNUNET_MessageHeader *msg;
1330   struct GNUNET_PeerIdentity peer;
1331   uint16_t size;
1332
1333   if (NULL == handle->client)
1334     return NULL;
1335   GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
1336   size = ntohs (hello->size);
1337   GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
1338   if (GNUNET_OK !=
1339       GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) hello, &peer))
1340   {
1341     GNUNET_break (0);
1342     return NULL;
1343   }
1344
1345   msg = GNUNET_malloc (size);
1346   memcpy (msg, hello, size);
1347   LOG (GNUNET_ERROR_TYPE_DEBUG,
1348        "Offering `%s' message of `%4s' to transport for validation.\n", "HELLO",
1349        GNUNET_i2s (&peer));
1350
1351   ohh = GNUNET_new (struct GNUNET_TRANSPORT_OfferHelloHandle);
1352   ohh->th = handle;
1353   ohh->cont = cont;
1354   ohh->cls = cls;
1355   ohh->msg = msg;
1356   ohh->tth = schedule_control_transmit (handle, size, &send_hello, ohh);
1357   GNUNET_CONTAINER_DLL_insert (handle->oh_head, handle->oh_tail, ohh);
1358   return ohh;
1359 }
1360
1361
1362 /**
1363  * Cancel the request to transport to offer the HELLO message
1364  *
1365  * @param ohh the GNUNET_TRANSPORT_OfferHelloHandle to cancel
1366  */
1367 void
1368 GNUNET_TRANSPORT_offer_hello_cancel (struct GNUNET_TRANSPORT_OfferHelloHandle *ohh)
1369 {
1370   struct GNUNET_TRANSPORT_Handle *th = ohh->th;
1371
1372   cancel_control_transmit (ohh->th, ohh->tth);
1373   GNUNET_CONTAINER_DLL_remove (th->oh_head, th->oh_tail, ohh);
1374   GNUNET_free (ohh->msg);
1375   GNUNET_free (ohh);
1376 }
1377
1378
1379 /**
1380  * Checks if a given peer is connected to us
1381  *
1382  * @param handle connection to transport service
1383  * @param peer the peer to check
1384  * @return #GNUNET_YES (connected) or #GNUNET_NO (disconnected)
1385  */
1386 int
1387 GNUNET_TRANSPORT_check_peer_connected (struct GNUNET_TRANSPORT_Handle *handle,
1388                                        const struct GNUNET_PeerIdentity *peer)
1389 {
1390   if (GNUNET_YES ==
1391       GNUNET_CONTAINER_multipeermap_contains (handle->neighbours,
1392                                               peer))
1393     return GNUNET_YES;
1394   return GNUNET_NO;
1395 }
1396
1397
1398 /**
1399  * Task to call the HelloUpdateCallback of the GetHelloHandle
1400  *
1401  * @param cls the `struct GNUNET_TRANSPORT_GetHelloHandle`
1402  * @param tc the scheduler task context
1403  */
1404 static void
1405 call_hello_update_cb_async (void *cls,
1406                             const struct GNUNET_SCHEDULER_TaskContext *tc)
1407 {
1408   struct GNUNET_TRANSPORT_GetHelloHandle *ghh = cls;
1409
1410   GNUNET_assert (NULL != ghh->handle->my_hello);
1411   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != ghh->notify_task);
1412   ghh->notify_task = GNUNET_SCHEDULER_NO_TASK;
1413   ghh->rec (ghh->rec_cls,
1414             (const struct GNUNET_MessageHeader *) ghh->handle->my_hello);
1415 }
1416
1417
1418 /**
1419  * Obtain the HELLO message for this peer.  The callback given in this function
1420  * is never called synchronously.
1421  *
1422  * @param handle connection to transport service
1423  * @param rec function to call with the HELLO, sender will be our peer
1424  *            identity; message and sender will be NULL on timeout
1425  *            (handshake with transport service pending/failed).
1426  *             cost estimate will be 0.
1427  * @param rec_cls closure for @a rec
1428  * @return handle to cancel the operation
1429  */
1430 struct GNUNET_TRANSPORT_GetHelloHandle *
1431 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
1432                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
1433                             void *rec_cls)
1434 {
1435   struct GNUNET_TRANSPORT_GetHelloHandle *hwl;
1436
1437   hwl = GNUNET_new (struct GNUNET_TRANSPORT_GetHelloHandle);
1438   hwl->rec = rec;
1439   hwl->rec_cls = rec_cls;
1440   hwl->handle = handle;
1441   GNUNET_CONTAINER_DLL_insert (handle->hwl_head, handle->hwl_tail, hwl);
1442   if (handle->my_hello != NULL)
1443     hwl->notify_task = GNUNET_SCHEDULER_add_now (&call_hello_update_cb_async,
1444                                                  hwl);
1445   return hwl;
1446 }
1447
1448
1449 /**
1450  * Stop receiving updates about changes to our HELLO message.
1451  *
1452  * @param ghh handle to cancel
1453  */
1454 void
1455 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh)
1456 {
1457   struct GNUNET_TRANSPORT_Handle *handle = ghh->handle;
1458
1459   if (GNUNET_SCHEDULER_NO_TASK != ghh->notify_task)
1460     GNUNET_SCHEDULER_cancel (ghh->notify_task);
1461   GNUNET_CONTAINER_DLL_remove (handle->hwl_head, handle->hwl_tail, ghh);
1462   GNUNET_free (ghh);
1463 }
1464
1465
1466 /**
1467  * Connect to the transport service.  Note that the connection may
1468  * complete (or fail) asynchronously.
1469  *
1470  * @param cfg configuration to use
1471  * @param self our own identity (API should check that it matches
1472  *             the identity found by transport), or NULL (no check)
1473  * @param cls closure for the callbacks
1474  * @param rec receive function to call
1475  * @param nc function to call on connect events
1476  * @param nd function to call on disconnect events
1477  */
1478 struct GNUNET_TRANSPORT_Handle *
1479 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1480                           const struct GNUNET_PeerIdentity *self, void *cls,
1481                           GNUNET_TRANSPORT_ReceiveCallback rec,
1482                           GNUNET_TRANSPORT_NotifyConnect nc,
1483                           GNUNET_TRANSPORT_NotifyDisconnect nd)
1484 {
1485   struct GNUNET_TRANSPORT_Handle *ret;
1486
1487   ret = GNUNET_new (struct GNUNET_TRANSPORT_Handle);
1488   if (NULL != self)
1489   {
1490     ret->self = *self;
1491     ret->check_self = GNUNET_YES;
1492   }
1493   ret->cfg = cfg;
1494   ret->cls = cls;
1495   ret->rec = rec;
1496   ret->nc_cb = nc;
1497   ret->nd_cb = nd;
1498   ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1499   LOG (GNUNET_ERROR_TYPE_DEBUG,
1500        "Connecting to transport service.\n");
1501   ret->client = GNUNET_CLIENT_connect ("transport", cfg);
1502   if (NULL == ret->client)
1503   {
1504     GNUNET_free (ret);
1505     return NULL;
1506   }
1507   ret->neighbours =
1508     GNUNET_CONTAINER_multipeermap_create (STARTING_NEIGHBOURS_SIZE,
1509                                           GNUNET_YES);
1510   ret->ready_heap =
1511       GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1512  schedule_control_transmit (ret, sizeof (struct StartMessage),
1513                              &send_start, ret);
1514   return ret;
1515 }
1516
1517
1518 /**
1519  * Disconnect from the transport service.
1520  *
1521  * @param handle handle to the service as returned from GNUNET_TRANSPORT_connect
1522  */
1523 void
1524 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1525 {
1526   LOG (GNUNET_ERROR_TYPE_DEBUG,
1527        "Transport disconnect called!\n");
1528   /* this disconnects all neighbours... */
1529   if (handle->reconnect_task == GNUNET_SCHEDULER_NO_TASK)
1530     disconnect_and_schedule_reconnect (handle);
1531   /* and now we stop trying to connect again... */
1532   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1533   {
1534     GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1535     handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1536   }
1537   GNUNET_CONTAINER_multipeermap_destroy (handle->neighbours);
1538   handle->neighbours = NULL;
1539   if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
1540   {
1541     GNUNET_SCHEDULER_cancel (handle->quota_task);
1542     handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
1543   }
1544   GNUNET_free_non_null (handle->my_hello);
1545   handle->my_hello = NULL;
1546   GNUNET_assert (handle->tc_head == NULL);
1547   GNUNET_assert (handle->tc_tail == NULL);
1548   GNUNET_assert (handle->hwl_head == NULL);
1549   GNUNET_assert (handle->hwl_tail == NULL);
1550   GNUNET_CONTAINER_heap_destroy (handle->ready_heap);
1551   handle->ready_heap = NULL;
1552   GNUNET_free (handle);
1553 }
1554
1555
1556 /**
1557  * Check if we could queue a message of the given size for
1558  * transmission.  The transport service will take both its
1559  * internal buffers and bandwidth limits imposed by the
1560  * other peer into consideration when answering this query.
1561  *
1562  * @param handle connection to transport service
1563  * @param target who should receive the message
1564  * @param size how big is the message we want to transmit?
1565  * @param priority how important is the message?
1566  * @param timeout after how long should we give up (and call
1567  *        notify with buf NULL and size 0)?
1568  * @param notify function to call when we are ready to
1569  *        send such a message
1570  * @param notify_cls closure for @a notify
1571  * @return NULL if someone else is already waiting to be notified
1572  *         non-NULL if the notify callback was queued (can be used to cancel
1573  *         using #GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1574  */
1575 struct GNUNET_TRANSPORT_TransmitHandle *
1576 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
1577                                         const struct GNUNET_PeerIdentity *target,
1578                                         size_t size, uint32_t priority,
1579                                         struct GNUNET_TIME_Relative timeout,
1580                                         GNUNET_CONNECTION_TransmitReadyNotify notify,
1581                                         void *notify_cls)
1582 {
1583   struct Neighbour *n;
1584   struct GNUNET_TRANSPORT_TransmitHandle *th;
1585   struct GNUNET_TIME_Relative delay;
1586
1587   n = neighbour_find (handle, target);
1588   if (NULL == n)
1589   {
1590     /* use GNUNET_TRANSPORT_try_connect first, only use this function
1591      * once a connection has been established */
1592     GNUNET_assert (0);
1593     return NULL;
1594   }
1595   if (NULL != n->th)
1596   {
1597     /* attempt to send two messages at the same time to the same peer */
1598     GNUNET_assert (0);
1599     return NULL;
1600   }
1601   GNUNET_assert (NULL == n->hn);
1602   th = GNUNET_new (struct GNUNET_TRANSPORT_TransmitHandle);
1603   th->neighbour = n;
1604   th->notify = notify;
1605   th->notify_cls = notify_cls;
1606   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1607   th->notify_size = size;
1608   th->priority = priority;
1609   n->th = th;
1610   /* calculate when our transmission should be ready */
1611   delay = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker, size + n->traffic_overhead);
1612   n->traffic_overhead = 0;
1613   if (delay.rel_value_us > timeout.rel_value_us)
1614     delay.rel_value_us = 0;        /* notify immediately (with failure) */
1615   LOG (GNUNET_ERROR_TYPE_DEBUG,
1616        "Bandwidth tracker allows next transmission to peer %s in %s\n",
1617        GNUNET_i2s (target),
1618        GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1619   n->hn = GNUNET_CONTAINER_heap_insert (handle->ready_heap, n, delay.rel_value_us);
1620   schedule_transmission (handle);
1621   return th;
1622 }
1623
1624
1625 /**
1626  * Cancel the specified transmission-ready notification.
1627  *
1628  * @param th handle returned from #GNUNET_TRANSPORT_notify_transmit_ready()
1629  */
1630 void
1631 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct GNUNET_TRANSPORT_TransmitHandle *th)
1632 {
1633   struct Neighbour *n;
1634
1635   GNUNET_assert (NULL == th->next);
1636   GNUNET_assert (NULL == th->prev);
1637   n = th->neighbour;
1638   GNUNET_assert (th == n->th);
1639   n->th = NULL;
1640   if (NULL != n->hn)
1641   {
1642     GNUNET_CONTAINER_heap_remove_node (n->hn);
1643     n->hn = NULL;
1644   }
1645   else
1646   {
1647     GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != th->timeout_task);
1648     GNUNET_SCHEDULER_cancel (th->timeout_task);
1649     th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1650   }
1651   GNUNET_free (th);
1652 }
1653
1654
1655 /* end of transport_api.c */