rename NETWORK_socket API to NETWORK_connection (to make room for the new actual...
[oweals/gnunet.git] / src / transport / transport_api.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009 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 2, 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  * - set_quota with low bandwidth should cause peer
28  *   disconnects (currently never does that) (MINOR)
29  */
30 #include "platform.h"
31 #include "gnunet_client_lib.h"
32 #include "gnunet_arm_service.h"
33 #include "gnunet_hello_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_server_lib.h"
36 #include "gnunet_time_lib.h"
37 #include "gnunet_transport_service.h"
38 #include "transport.h"
39
40 /**
41  * After how long do we give up on transmitting a HELLO
42  * to the service?
43  */
44 #define OFFER_HELLO_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
45
46 /**
47  * After how long do we give automatically retry an unsuccessful
48  * CONNECT request?
49  */
50 #define CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 750)
51
52 /**
53  * How long should ARM wait when starting up the
54  * transport service before reporting back?
55  */
56 #define START_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
57
58 /**
59  * How long should ARM wait when stopping the
60  * transport service before reporting back?
61  */
62 #define STOP_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
63
64 /**
65  * Entry in linked list of all of our current neighbours.
66  */
67 struct NeighbourList
68 {
69
70   /**
71    * This is a linked list.
72    */
73   struct NeighbourList *next;
74
75   /**
76    * Active transmit handle, can be NULL.  Used to move
77    * from ready to wait list on disconnect and to block
78    * two transmissions to the same peer from being scheduled
79    * at the same time.
80    */
81   struct GNUNET_TRANSPORT_TransmitHandle *transmit_handle;
82
83   /**
84    * Identity of this neighbour.
85    */
86   struct GNUNET_PeerIdentity id;
87
88   /**
89    * At what time did we reset last_sent last?
90    */
91   struct GNUNET_TIME_Absolute last_quota_update;
92
93   /**
94    * How many bytes have we sent since the "last_quota_update"
95    * timestamp?
96    */
97   uint64_t last_sent;
98
99   /**
100    * Quota for outbound traffic to the neighbour in bytes/ms.
101    */
102   uint32_t quota_out;
103
104   /**
105    * Set to GNUNET_YES if we are currently allowed to
106    * transmit a message to the transport service for this
107    * peer, GNUNET_NO otherwise.
108    */
109   int transmit_ok;
110
111   /**
112    * Set to GNUNET_YES if we have received an ACK for the
113    * given peer.  Peers that receive our HELLO always respond
114    * with an ACK to let us know that we are successfully
115    * communicating.  Note that a PING can not be used for this
116    * since PINGs are only send if a HELLO address requires
117    * confirmation (and also, PINGs are not passed to the
118    * transport API itself).
119    */
120   int received_ack;
121
122 };
123
124
125 /**
126  * Linked list of requests from clients for our HELLO
127  * that were deferred.
128  */
129 struct HelloWaitList
130 {
131
132   /**
133    * This is a linked list.
134    */
135   struct HelloWaitList *next;
136
137   /**
138    * Reference back to our transport handle.
139    */
140   struct GNUNET_TRANSPORT_Handle *handle;
141
142   /**
143    * Callback to call once we got our HELLO.
144    */
145   GNUNET_TRANSPORT_ReceiveCallback rec;
146
147   /**
148    * Closure for rec.
149    */
150   void *rec_cls;
151
152   /**
153    * When to time out (call rec with NULL).
154    */
155   struct GNUNET_TIME_Absolute timeout;
156
157   /**
158    * Timeout task (used to trigger timeout,
159    * cancel if we get the HELLO in time).
160    */
161   GNUNET_SCHEDULER_TaskIdentifier task;
162
163
164 };
165
166
167 /**
168  * Opaque handle for a transmission-ready request.
169  */
170 struct GNUNET_TRANSPORT_TransmitHandle
171 {
172
173   /**
174    * We keep the transmit handles that are waiting for
175    * a transport-level connection in a doubly linked list.
176    */
177   struct GNUNET_TRANSPORT_TransmitHandle *next;
178
179   /**
180    * We keep the transmit handles that are waiting for
181    * a transport-level connection in a doubly linked list.
182    */
183   struct GNUNET_TRANSPORT_TransmitHandle *prev;
184
185   /**
186    * Handle of the main transport data structure.
187    */
188   struct GNUNET_TRANSPORT_Handle *handle;
189
190   /**
191    * Neighbour for this handle, can be NULL if the service
192    * is not yet connected to the target.
193    */
194   struct NeighbourList *neighbour;
195
196   /**
197    * Which peer is this transmission going to be for?  All
198    * zeros if it is control-traffic to the service.
199    */
200   struct GNUNET_PeerIdentity target;
201
202   /**
203    * Function to call when notify_size bytes are available
204    * for transmission.
205    */
206   GNUNET_NETWORK_TransmitReadyNotify notify;
207
208   /**
209    * Closure for notify.
210    */
211   void *notify_cls;
212
213   /**
214    * transmit_ready task Id.  The task is used to introduce the
215    * artificial delay that may be required to maintain the bandwidth
216    * limits.  Later, this will be the ID of the "transmit_timeout"
217    * task which is used to signal a timeout if the transmission could
218    * not be done in a timely fashion.
219    */
220   GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
221
222   /**
223    * Timeout for this request.
224    */
225   struct GNUNET_TIME_Absolute timeout;
226
227   /**
228    * How many bytes is our notify callback waiting for?
229    */
230   size_t notify_size;
231
232   /**
233    * How important is this message?
234    */
235   unsigned int priority;
236
237 };
238
239
240 /**
241  * Handle for the transport service (includes all of the
242  * state for the transport service).
243  */
244 struct GNUNET_TRANSPORT_Handle
245 {
246
247   /**
248    * Closure for the callbacks.
249    */
250   void *cls;
251
252   /**
253    * Function to call for received data.
254    */
255   GNUNET_TRANSPORT_ReceiveCallback rec;
256
257   /**
258    * function to call on connect events
259    */
260   GNUNET_TRANSPORT_NotifyConnect nc_cb;
261
262   /**
263    * function to call on disconnect events
264    */
265   GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
266
267   /**
268    * The current HELLO message for this peer.  Updated
269    * whenever transports change their addresses.
270    */
271   struct GNUNET_HELLO_Message *my_hello;
272
273   /**
274    * My client connection to the transport service.
275    */
276   struct GNUNET_CLIENT_Connection *client;
277
278   /**
279    * Handle to our registration with the client for notification.
280    */
281   struct GNUNET_NETWORK_TransmitHandle *network_handle;
282
283   /**
284    * Linked list of transmit handles that are waiting for the
285    * transport to connect to the respective peer.  When we
286    * receive notification that the transport connected to a
287    * peer, we go over this list and check if someone has already
288    * requested a transmission to the new peer; if so, we trigger
289    * the next step.
290    */
291   struct GNUNET_TRANSPORT_TransmitHandle *connect_wait_head;
292
293   /**
294    * Linked list of transmit handles that are waiting for the
295    * transport to be ready for transmission to the respective
296    * peer.  When we
297    * receive notification that the transport disconnected from
298    * a peer, we go over this list and move the entry back to
299    * the connect_wait list.
300    */
301   struct GNUNET_TRANSPORT_TransmitHandle *connect_ready_head;
302
303   /**
304    * Linked list of pending requests for our HELLO.
305    */
306   struct HelloWaitList *hwl_head;
307
308   /**
309    * My scheduler.
310    */
311   struct GNUNET_SCHEDULER_Handle *sched;
312
313   /**
314    * My configuration.
315    */
316   const struct GNUNET_CONFIGURATION_Handle *cfg;
317
318   /**
319    * Linked list of the current neighbours of this peer.
320    */
321   struct NeighbourList *neighbours;
322
323   /**
324    * ID of the task trying to reconnect to the
325    * service.
326    */
327   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
328
329   /**
330    * Delay until we try to reconnect.
331    */
332   struct GNUNET_TIME_Relative reconnect_delay;
333
334   /**
335    * Do we currently have a transmission pending?
336    * (schedule transmission was called but has not
337    * yet succeeded)?
338    */
339   int transmission_scheduled;
340 };
341
342
343 static struct NeighbourList *
344 find_neighbour (struct GNUNET_TRANSPORT_Handle *h,
345                 const struct GNUNET_PeerIdentity *peer)
346 {
347   struct NeighbourList *pos;
348
349   pos = h->neighbours;
350   while ((pos != NULL) &&
351          (0 != memcmp (peer, &pos->id, sizeof (struct GNUNET_PeerIdentity))))
352     pos = pos->next;
353   return pos;
354 }
355
356
357 /**
358  * Schedule the task to send one message from the
359  * connect_ready list to the service.
360  */
361 static void schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
362
363
364 /**
365  * Transmit message to client...
366  */
367 static size_t
368 transport_notify_ready (void *cls, size_t size, void *buf)
369 {
370   struct GNUNET_TRANSPORT_Handle *h = cls;
371   struct GNUNET_TRANSPORT_TransmitHandle *th;
372   struct NeighbourList *n;
373   size_t ret;
374   char *cbuf;
375
376   h->network_handle = NULL;
377   h->transmission_scheduled = GNUNET_NO;
378   if (buf == NULL)
379     {
380 #if DEBUG_TRANSPORT
381       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
382                   "Could not transmit to transport service, cancelling pending requests\n");
383 #endif
384       th = h->connect_ready_head;
385       if (th->next != NULL)
386         th->next->prev = NULL;
387       h->connect_ready_head = th->next;
388       if (NULL != (n = th->neighbour))
389         {
390           GNUNET_assert (n->transmit_handle == th);
391           n->transmit_handle = NULL;
392         }
393       GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
394       GNUNET_free (th);
395       return 0;
396     } 
397 #if DEBUG_TRANSPORT
398   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
399               "Ready to transmit %u bytes to transport service\n", size);
400 #endif
401   cbuf = buf;
402   ret = 0;
403   h->network_handle = NULL;
404   h->transmission_scheduled = GNUNET_NO;
405   do
406     {
407       th = h->connect_ready_head;
408       if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
409         {
410           /* remove existing time out task (only applies if
411              this is not the first iteration of the loop) */
412           GNUNET_SCHEDULER_cancel (h->sched,
413                                    th->notify_delay_task);
414           th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
415         }
416       GNUNET_assert (th->notify_size <= size);
417       if (th->next != NULL)
418         th->next->prev = NULL;
419       h->connect_ready_head = th->next;
420       if (NULL != (n = th->neighbour))
421         {
422           GNUNET_assert (n->transmit_handle == th);
423           n->transmit_handle = NULL;
424         }
425       ret += th->notify (th->notify_cls, size, &cbuf[ret]);
426       GNUNET_free (th);
427       if (n != NULL)
428         n->last_sent += ret;
429       size -= ret;
430     }
431   while ((h->connect_ready_head != NULL) &&
432          (h->connect_ready_head->notify_size <= size));
433   if (h->connect_ready_head != NULL)
434     schedule_transmission (h);
435 #if DEBUG_TRANSPORT
436   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
437               "Transmitting %u bytes to transport service\n", ret);
438 #endif
439   return ret;
440 }
441
442
443 /**
444  * Schedule the task to send one message from the
445  * connect_ready list to the service.
446  */
447 static void
448 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
449 {
450   struct GNUNET_TRANSPORT_TransmitHandle *th;
451
452   GNUNET_assert (NULL == h->network_handle);
453   if (h->client == NULL)
454     {
455       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
456                   "Could not yet schedule transmission: we are not yet connected to the transport service!\n");
457       return; /* not yet connected */
458     }
459   th = h->connect_ready_head;
460   if (th == NULL)
461     return; /* no request pending */
462   if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
463     {
464       /* remove existing time out task, will be integrated
465          with transmit_ready notification! */
466       GNUNET_SCHEDULER_cancel (h->sched,
467                                th->notify_delay_task);
468       th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
469     }
470   h->transmission_scheduled = GNUNET_YES;
471   h->network_handle = GNUNET_CLIENT_notify_transmit_ready (h->client,
472                                                            th->notify_size,
473                                                            GNUNET_TIME_absolute_get_remaining
474                                                            (th->timeout),
475                                                            &transport_notify_ready,
476                                                            h);
477   GNUNET_assert (NULL != h->network_handle);
478 }
479
480
481 /**
482  * Insert the given transmit handle in the given sorted
483  * doubly linked list based on timeout.
484  *
485  * @param head pointer to the head of the linked list
486  * @param th element to insert into the list
487  */
488 static void
489 insert_transmit_handle (struct GNUNET_TRANSPORT_TransmitHandle **head,
490                         struct GNUNET_TRANSPORT_TransmitHandle *th)
491 {
492   struct GNUNET_TRANSPORT_TransmitHandle *pos;
493   struct GNUNET_TRANSPORT_TransmitHandle *prev;
494
495   pos = *head;
496   prev = NULL;
497   while ((pos != NULL) && (pos->timeout.value < th->timeout.value))
498     {
499       prev = pos;
500       pos = pos->next;
501     }
502   if (prev == NULL)
503     {
504       th->next = *head;
505       if (th->next != NULL)
506         th->next->prev = th;
507       *head = th;
508     }
509   else
510     {
511       th->next = pos;
512       th->prev = prev;
513       prev->next = th;
514       if (pos != NULL)
515         pos->prev = th;
516     }
517 }
518
519
520 /**
521  * Cancel a pending notify delay task (if pending) and also remove the
522  * given transmit handle from whatever list is on.
523  *
524  * @param th handle for the transmission request to manipulate
525  */
526 static void
527 remove_from_any_list (struct GNUNET_TRANSPORT_TransmitHandle *th)
528 {
529   struct GNUNET_TRANSPORT_Handle *h;
530
531   h = th->handle;
532   if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
533     {
534       GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
535       th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
536     }
537   if (th->prev == NULL)
538     {
539       if (th == h->connect_wait_head)
540         h->connect_wait_head = th->next;
541       else
542         h->connect_ready_head = th->next;
543     }
544   else
545     {
546       th->prev->next = th->next;
547     }
548   if (th->next != NULL)
549     th->next->prev = th->prev;
550 }
551
552
553 /**
554  * Schedule a request to connect to the given
555  * neighbour (and if successful, add the specified
556  * handle to the wait list).
557  *
558  * @param th handle for a request to transmit once we
559  *        have connected
560  */
561 static void
562 try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th);
563
564
565 /**
566  * Called when our transmit request timed out before any transport
567  * reported success connecting to the desired peer or before the
568  * transport was ready to receive.  Signal error and free
569  * TransmitHandle.
570  */
571 static void
572 transmit_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
573 {
574   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
575
576   th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
577   if (th->neighbour != NULL)
578     th->neighbour->transmit_handle = NULL;
579 #if DEBUG_TRANSPORT
580   GNUNET_log (GNUNET_ERROR_TYPE_INFO, 
581               "Request for transmission to peer `%s' timed out.\n",
582               GNUNET_i2s(&th->target));
583 #endif
584   remove_from_any_list (th);
585   th->notify (th->notify_cls, 0, NULL);
586   GNUNET_free (th);
587 }
588
589
590
591
592 /**
593  * Queue control request for transmission to the transport
594  * service.
595  *
596  * @param size number of bytes to be transmitted
597  * @param at_head request must be added to the head of the queue
598  *        (otherwise request will be appended)
599  * @param timeout how long this transmission can wait (at most)
600  * @param notify function to call to get the content
601  * @param notify_cls closure for notify
602  */
603 static void
604 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
605                            size_t size,
606                            int at_head,
607                            struct GNUNET_TIME_Relative timeout,
608                            GNUNET_NETWORK_TransmitReadyNotify notify,
609                            void *notify_cls)
610 {
611   struct GNUNET_TRANSPORT_TransmitHandle *th;
612
613   th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
614   th->handle = h;
615   th->notify = notify;
616   th->notify_cls = notify_cls;
617   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
618   th->notify_size = size;
619   th->notify_delay_task 
620     = GNUNET_SCHEDULER_add_delayed (h->sched,
621                                     GNUNET_NO,
622                                     GNUNET_SCHEDULER_PRIORITY_KEEP,
623                                     GNUNET_SCHEDULER_NO_TASK,
624                                     timeout,
625                                     &transmit_timeout, th);    
626   if (at_head)
627     {
628       th->next = h->connect_ready_head;
629       h->connect_ready_head = th;
630       if (th->next != NULL)
631         th->next->prev = th;
632     }
633   else
634     {
635       insert_transmit_handle (&h->connect_ready_head, th);
636     }
637   if (GNUNET_NO == h->transmission_scheduled)
638     schedule_transmission (h);
639 }
640
641
642 /**
643  * Update the quota values for the given neighbour now.
644  */
645 static void
646 update_quota (struct NeighbourList *n)
647 {
648   struct GNUNET_TIME_Relative delta;
649   uint64_t allowed;
650   uint64_t remaining;
651
652   delta = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
653   allowed = delta.value * n->quota_out;
654   if (n->last_sent < allowed)
655     {
656       remaining = allowed - n->last_sent;
657       if (n->quota_out > 0)
658         remaining /= n->quota_out;
659       else
660         remaining = 0;
661       if (remaining > MAX_BANDWIDTH_CARRY)
662         remaining = MAX_BANDWIDTH_CARRY;
663       n->last_sent = 0;
664       n->last_quota_update = GNUNET_TIME_absolute_get ();
665       n->last_quota_update.value -= remaining;
666     }
667   else
668     {
669       n->last_sent -= allowed;
670       n->last_quota_update = GNUNET_TIME_absolute_get ();
671     }
672 }
673
674
675 struct SetQuotaContext
676 {
677   struct GNUNET_TRANSPORT_Handle *handle;
678
679   struct GNUNET_PeerIdentity target;
680
681   GNUNET_SCHEDULER_Task cont;
682
683   void *cont_cls;
684
685   struct GNUNET_TIME_Absolute timeout;
686
687   uint32_t quota_in;
688 };
689
690
691 static size_t
692 send_set_quota (void *cls, size_t size, void *buf)
693 {
694   struct SetQuotaContext *sqc = cls;
695   struct QuotaSetMessage *msg;
696
697   if (buf == NULL)
698     {
699       GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
700                                          GNUNET_NO,
701                                          sqc->cont,
702                                          sqc->cont_cls,
703                                          GNUNET_SCHEDULER_REASON_TIMEOUT);
704       GNUNET_free (sqc);
705       return 0;
706     }
707 #if DEBUG_TRANSPORT
708   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
709               "Transmitting `%s' request with respect to `%4s'.\n",
710               "SET_QUOTA", GNUNET_i2s (&sqc->target));
711 #endif
712   GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
713   msg = buf;
714   msg->header.size = htons (sizeof (struct QuotaSetMessage));
715   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
716   msg->quota_in = htonl (sqc->quota_in);
717   memcpy (&msg->peer, &sqc->target, sizeof (struct GNUNET_PeerIdentity));
718   if (sqc->cont != NULL)
719     GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
720                                        GNUNET_NO,
721                                        sqc->cont,
722                                        sqc->cont_cls,
723                                        GNUNET_SCHEDULER_REASON_PREREQ_DONE);
724   GNUNET_free (sqc);
725   return sizeof (struct QuotaSetMessage);
726 }
727
728
729 /**
730  * Set the share of incoming bandwidth for the given
731  * peer to the specified amount.
732  *
733  * @param handle connection to transport service
734  * @param target who's bandwidth quota is being changed
735  * @param quota_in incoming bandwidth quota in bytes per ms; 0 can
736  *        be used to force all traffic to be discarded
737  * @param quota_out outgoing bandwidth quota in bytes per ms; 0 can
738  *        be used to force all traffic to be discarded
739  * @param timeout how long to wait until signaling failure if
740  *        we can not communicate the quota change
741  * @param cont continuation to call when done, will be called
742  *        either with reason "TIMEOUT" or with reason "PREREQ_DONE"
743  * @param cont_cls closure for continuation
744  */
745 void
746 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
747                             const struct GNUNET_PeerIdentity *target,
748                             uint32_t quota_in,
749                             uint32_t quota_out,
750                             struct GNUNET_TIME_Relative timeout,
751                             GNUNET_SCHEDULER_Task cont, void *cont_cls)
752 {
753   struct NeighbourList *n;
754   struct SetQuotaContext *sqc;
755
756   n = find_neighbour (handle, target);
757   if (n != NULL)
758     {
759       update_quota (n);
760       if (n->quota_out < quota_out)
761         n->last_quota_update = GNUNET_TIME_absolute_get ();
762       n->quota_out = quota_out;
763     }
764   sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
765   sqc->handle = handle;
766   sqc->target = *target;
767   sqc->cont = cont;
768   sqc->cont_cls = cont_cls;
769   sqc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
770   sqc->quota_in = quota_in;
771   schedule_control_transmit (handle,
772                              sizeof (struct QuotaSetMessage),
773                              GNUNET_NO, timeout, &send_set_quota, sqc);
774 }
775
776
777 /**
778  * A "get_hello" request has timed out.  Signal the client
779  * and clean up.
780  */
781 static void
782 hello_wait_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
783 {
784   struct HelloWaitList *hwl = cls;
785   struct HelloWaitList *pos;
786   struct HelloWaitList *prev;
787
788   hwl->task = GNUNET_SCHEDULER_NO_TASK;
789   if (GNUNET_TIME_absolute_get_remaining (hwl->timeout).value > 0)
790     {
791 #if DEBUG_TRANSPORT
792       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
793                   _("First attempt to obtain `%s' from transport service failed, will try again for %llums.\n"),
794                   "HELLO",
795                   GNUNET_TIME_absolute_get_remaining (hwl->timeout).value);
796 #endif
797       hwl->task = GNUNET_SCHEDULER_add_delayed (hwl->handle->sched,
798                                                 GNUNET_YES,
799                                                 GNUNET_SCHEDULER_PRIORITY_KEEP,
800                                                 GNUNET_SCHEDULER_NO_TASK,
801                                                 GNUNET_TIME_absolute_get_remaining (hwl->timeout),
802                                                 &hello_wait_timeout, hwl);
803       return;      
804     }
805   /* signal timeout */
806   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
807               _("Timeout trying to obtain `%s' from transport service.\n"),
808               "HELLO");
809   prev = NULL;
810   pos = hwl->handle->hwl_head;
811   while (pos != hwl)
812     {
813       GNUNET_assert (pos != NULL);
814       prev = pos;
815       pos = pos->next;
816     }
817   if (prev == NULL)
818     hwl->handle->hwl_head = hwl->next;
819   else
820     prev->next = hwl->next;
821   if (hwl->rec != NULL)
822     hwl->rec (hwl->rec_cls, GNUNET_TIME_UNIT_ZERO, NULL, NULL);
823   GNUNET_free (hwl);
824 }
825
826
827 /**
828  * Obtain the HELLO message for this peer.
829  *
830  * @param handle connection to transport service
831  * @param timeout how long to wait for the HELLO
832  * @param rec function to call with the HELLO, sender will be our peer
833  *            identity; message and sender will be NULL on timeout
834  *            (handshake with transport service pending/failed).
835  *             cost estimate will be 0.
836  * @param rec_cls closure for rec
837  */
838 void
839 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
840                             struct GNUNET_TIME_Relative timeout,
841                             GNUNET_TRANSPORT_ReceiveCallback rec,
842                             void *rec_cls)
843 {
844   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pk;
845   struct GNUNET_PeerIdentity me;
846   struct HelloWaitList *hwl;
847
848   if (handle->my_hello == NULL)
849     {
850       hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
851       hwl->next = handle->hwl_head;
852       handle->hwl_head = hwl;
853       hwl->handle = handle;
854       hwl->rec = rec;
855       hwl->rec_cls = rec_cls;
856       hwl->timeout = GNUNET_TIME_relative_to_absolute (timeout);
857       hwl->task = GNUNET_SCHEDULER_add_delayed (handle->sched,
858                                                 GNUNET_YES,
859                                                 GNUNET_SCHEDULER_PRIORITY_KEEP,
860                                                 GNUNET_SCHEDULER_NO_TASK,
861                                                 timeout,
862                                                 &hello_wait_timeout, hwl);
863       return;
864     }
865   GNUNET_assert (GNUNET_OK == GNUNET_HELLO_get_key (handle->my_hello, &pk));
866   GNUNET_CRYPTO_hash (&pk,
867                       sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
868                       &me.hashPubKey);
869
870   rec (rec_cls,
871        GNUNET_TIME_UNIT_ZERO,
872        &me, (const struct GNUNET_MessageHeader *) handle->my_hello);
873 }
874
875
876 static size_t
877 send_hello (void *cls, size_t size, void *buf)
878 {
879   struct GNUNET_MessageHeader *hello = cls;
880   uint16_t msize;
881
882   if (buf == NULL)
883     {
884 #if DEBUG_TRANSPORT
885       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
886                   "Timeout while trying to transmit `%s' request.\n",
887                   "HELLO");
888 #endif
889       GNUNET_free (hello);
890       return 0;
891     }
892 #if DEBUG_TRANSPORT
893   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
894               "Transmitting `%s' request.\n", "HELLO");
895 #endif
896   msize = ntohs (hello->size);
897   GNUNET_assert (size >= msize);
898   memcpy (buf, hello, msize);
899   GNUNET_free (hello);
900   return msize;
901 }
902
903
904 /**
905  * Offer the transport service the HELLO of another peer.  Note that
906  * the transport service may just ignore this message if the HELLO is
907  * malformed or useless due to our local configuration.
908  *
909  * @param handle connection to transport service
910  * @param hello the hello message
911  */
912 void
913 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
914                               const struct GNUNET_MessageHeader *hello)
915 {
916   struct GNUNET_MessageHeader *hc;
917   uint16_t size;
918
919   if (handle->client == NULL)
920     {
921 #if DEBUG_TRANSPORT
922       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
923                   "Not connected to transport service, dropping offered HELLO\n");
924 #endif
925       return;
926     }
927   GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
928   size = ntohs (hello->size);
929   GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
930   hc = GNUNET_malloc (size);
931   memcpy (hc, hello, size);
932   schedule_control_transmit (handle,
933                              size,
934                              GNUNET_NO, OFFER_HELLO_TIMEOUT, &send_hello, hc);
935 }
936
937
938 /**
939  * Function we use for handling incoming messages.
940  */
941 static void demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg);
942
943
944 static size_t
945 send_start (void *cls, size_t size, void *buf)
946 {
947   struct GNUNET_MessageHeader *s = buf;
948
949   if (buf == NULL)
950     {
951 #if DEBUG_TRANSPORT
952       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
953                   "Timeout while trying to transmit `%s' request.\n",
954                   "START");
955 #endif
956       return 0;
957     }
958 #if DEBUG_TRANSPORT
959   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
960               "Transmitting `%s' request.\n", "START");
961 #endif
962   GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
963   s->size = htons (sizeof (struct GNUNET_MessageHeader));
964   s->type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
965   return sizeof (struct GNUNET_MessageHeader);
966 }
967
968
969 /**
970  * We're ready to transmit the request that the transport service
971  * should connect to a new peer.  In addition to sending the
972  * request, schedule the next phase for the transmission processing
973  * that caused the connect request in the first place.
974  */
975 static size_t
976 request_connect (void *cls, size_t size, void *buf)
977 {
978   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
979   struct TryConnectMessage *tcm;
980   struct GNUNET_TRANSPORT_Handle *h;
981
982   GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
983   h = th->handle;
984   if (buf == NULL)
985     {
986 #if DEBUG_TRANSPORT
987       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
988                   "Failed to transmit `%s' request for `%4s' to service.\n",
989                   "TRY_CONNECT",
990                   GNUNET_i2s(&th->target));
991 #endif
992       th->notify (th->notify_cls, 0, NULL);
993       GNUNET_free (th);
994       return 0;
995     }
996 #if DEBUG_TRANSPORT
997   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
998               "Transmitting `%s' message for `%4s'.\n",
999               "TRY_CONNECT", GNUNET_i2s (&th->target));
1000 #endif
1001   GNUNET_assert (size >= sizeof (struct TryConnectMessage));
1002   tcm = buf;
1003   tcm->header.size = htons (sizeof (struct TryConnectMessage));
1004   tcm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT);
1005   tcm->reserved = htonl (0);
1006   memcpy (&tcm->peer, &th->target, sizeof (struct GNUNET_PeerIdentity));
1007   th->notify_delay_task
1008     = GNUNET_SCHEDULER_add_delayed (h->sched,
1009                                     GNUNET_NO,
1010                                     GNUNET_SCHEDULER_PRIORITY_KEEP,
1011                                     GNUNET_SCHEDULER_NO_TASK,
1012                                     GNUNET_TIME_absolute_get_remaining
1013                                     (th->timeout),
1014                                     &transmit_timeout, th);
1015   insert_transmit_handle (&h->connect_wait_head, th);
1016   return sizeof (struct TryConnectMessage);
1017 }
1018
1019
1020 /**
1021  * Schedule a request to connect to the given
1022  * neighbour (and if successful, add the specified
1023  * handle to the wait list).
1024  *
1025  * @param th handle for a request to transmit once we
1026  *        have connected
1027  */
1028 static void
1029 try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th)
1030 {
1031   GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);  
1032   schedule_control_transmit (th->handle,
1033                              sizeof (struct TryConnectMessage),
1034                              GNUNET_NO,
1035                              GNUNET_TIME_absolute_get_remaining (th->timeout),
1036                              &request_connect, th);
1037 }
1038
1039
1040 /**
1041  * Task for delayed attempts to reconnect to a peer.
1042  *
1043  * @param cls must be a transmit handle that determines the peer
1044  *        to which we will try to connect
1045  * @param tc scheduler information about why we were triggered (not used)
1046  */
1047 static void
1048 try_connect_task (void *cls,
1049                   const struct GNUNET_SCHEDULER_TaskContext *tc)
1050 {
1051   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;  
1052
1053   th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1054   try_connect (th);
1055 }
1056
1057
1058 /**
1059  * Remove neighbour from our list.  Will automatically
1060  * trigger a re-connect attempt if we have messages pending
1061  * for this peer.
1062  * 
1063  * @param h our state
1064  * @param peer the peer to remove
1065  */
1066 static void
1067 remove_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1068                   const struct GNUNET_PeerIdentity *peer)
1069 {
1070   struct NeighbourList *prev;
1071   struct NeighbourList *pos;
1072   struct GNUNET_TRANSPORT_TransmitHandle *th;
1073
1074 #if DEBUG_TRANSPORT
1075   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1076               "Removing neighbour `%s' from list of connected peers.\n",
1077               GNUNET_i2s (peer));
1078 #endif
1079   prev = NULL;
1080   pos = h->neighbours;
1081   while ((pos != NULL) &&
1082          (0 != memcmp (peer, 
1083                        &pos->id, 
1084                        sizeof (struct GNUNET_PeerIdentity))))
1085     {
1086       prev = pos;
1087       pos = pos->next;
1088     }
1089   if (pos == NULL)
1090     {
1091       GNUNET_break (0);
1092       return;
1093     }
1094   if (prev == NULL)
1095     h->neighbours = pos->next;
1096   else
1097     prev->next = pos->next;
1098   if (NULL != (th = pos->transmit_handle))
1099     {
1100       pos->transmit_handle = NULL;
1101       th->neighbour = NULL;
1102       remove_from_any_list (th);
1103       if (GNUNET_TIME_absolute_get_remaining (th->timeout).value <= CONNECT_RETRY_TIMEOUT.value)
1104         {
1105           /* signal error */
1106           GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == th->notify_delay_task);
1107           transmit_timeout (th, NULL);    
1108         }
1109       else
1110         {
1111           /* try again in a bit */
1112           GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == th->notify_delay_task);
1113           th->notify_delay_task 
1114             = GNUNET_SCHEDULER_add_delayed (h->sched,
1115                                             GNUNET_NO,
1116                                             GNUNET_SCHEDULER_PRIORITY_KEEP,
1117                                             GNUNET_SCHEDULER_NO_TASK,
1118                                             CONNECT_RETRY_TIMEOUT,
1119                                             &try_connect_task,
1120                                             th);
1121         }
1122     }
1123   if (h->nc_cb != NULL)
1124     h->nd_cb (h->cls, peer);
1125   GNUNET_free (pos);
1126 }
1127
1128
1129 /**
1130  * Try again to connect to transport service.
1131  */
1132 static void
1133 reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1134 {
1135   struct GNUNET_TRANSPORT_Handle *h = cls;
1136   struct GNUNET_TRANSPORT_TransmitHandle *pos;
1137   struct NeighbourList *n;
1138
1139   /* Forget about all neighbours that we used to be connected
1140      to */
1141   while (NULL != (n = h->neighbours))
1142     remove_neighbour (h, &n->id);
1143 #if DEBUG_TRANSPORT
1144   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
1145 #endif
1146   GNUNET_assert (h->client == NULL);
1147   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1148   h->client = GNUNET_CLIENT_connect (h->sched, "transport", h->cfg);
1149   GNUNET_assert (h->client != NULL);
1150   /* make sure we don't send "START" twice,
1151      remove existing entry from queue (if present) */
1152   pos = h->connect_ready_head;
1153   while (pos != NULL)
1154     {
1155       if (pos->notify == &send_start)
1156         {
1157           if (pos->prev == NULL)
1158             h->connect_ready_head = pos->next;
1159           else
1160             pos->prev->next = pos->next;
1161           if (pos->next != NULL)
1162             pos->next->prev = pos->prev;
1163           GNUNET_assert (pos->neighbour == NULL);
1164           GNUNET_free (pos);
1165           break;
1166         }
1167       pos = pos->next;
1168     }
1169   schedule_control_transmit (h,
1170                              sizeof (struct GNUNET_MessageHeader),
1171                              GNUNET_YES,
1172                              GNUNET_TIME_UNIT_FOREVER_REL, 
1173                              &send_start, NULL);
1174   GNUNET_CLIENT_receive (h->client,
1175                          &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1176 }
1177
1178
1179 /**
1180  * Function that will schedule the job that will try
1181  * to connect us again to the client.
1182  */
1183 static void
1184 schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1185 {
1186 #if DEBUG_TRANSPORT
1187   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1188               "Scheduling task to reconnect to transport service in %llu ms.\n",
1189               h->reconnect_delay.value);
1190 #endif
1191   GNUNET_assert (h->client == NULL);
1192   GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1193   h->reconnect_task
1194     = GNUNET_SCHEDULER_add_delayed (h->sched,
1195                                     GNUNET_NO,
1196                                     GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1197                                     GNUNET_SCHEDULER_NO_TASK,
1198                                     h->reconnect_delay, &reconnect, h);
1199   h->reconnect_delay = GNUNET_TIME_UNIT_SECONDS;
1200 }
1201
1202
1203 /**
1204  * We are connected to the respective peer, check the
1205  * bandwidth limits and schedule the transmission.
1206  */
1207 static void schedule_request (struct GNUNET_TRANSPORT_TransmitHandle *th);
1208
1209
1210 /**
1211  * Function called by the scheduler when the timeout
1212  * for bandwidth availablility for the target
1213  * neighbour is reached.
1214  */
1215 static void
1216 transmit_ready (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1217 {
1218   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1219
1220   th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1221   schedule_request (th);
1222 }
1223
1224
1225 /**
1226  * Remove the given transmit handle from the wait list.  Does NOT free
1227  * it.
1228  */
1229 static void
1230 remove_from_wait_list (struct GNUNET_TRANSPORT_TransmitHandle *th)
1231 {
1232   if (th->prev == NULL)
1233     th->handle->connect_wait_head = th->next;
1234   else
1235     th->prev->next = th->next;
1236   if (th->next != NULL)
1237     th->next->prev = th->prev;
1238 }
1239
1240
1241 /**
1242  * We are connected to the respective peer, check the
1243  * bandwidth limits and schedule the transmission.
1244  */
1245 static void
1246 schedule_request (struct GNUNET_TRANSPORT_TransmitHandle *th)
1247 {
1248   struct GNUNET_TRANSPORT_Handle *h;
1249   struct GNUNET_TIME_Relative duration;
1250   struct NeighbourList *n;
1251   uint64_t available;
1252
1253   h = th->handle;
1254   n = th->neighbour;
1255   if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1256     {
1257       GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
1258       th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1259     }
1260   /* check outgoing quota */
1261   duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
1262   if (duration.value > MIN_QUOTA_REFRESH_TIME)
1263     {
1264       update_quota (n);
1265       duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
1266     }
1267   available = duration.value * n->quota_out;
1268   if (available < n->last_sent + th->notify_size)
1269     {
1270       /* calculate how much bandwidth we'd still need to
1271          accumulate and based on that how long we'll have
1272          to wait... */
1273       available = n->last_sent + th->notify_size - available;
1274       duration = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1275                                                 available / n->quota_out);
1276       if (th->timeout.value <
1277           GNUNET_TIME_relative_to_absolute (duration).value)
1278         {
1279           /* signal timeout! */
1280 #if DEBUG_TRANSPORT
1281           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1282                       "Would need %llu ms before bandwidth is available for delivery to `%4s', that is too long.  Signaling timeout.\n",
1283                       duration.value,
1284                       GNUNET_i2s(&th->target));
1285 #endif
1286           remove_from_wait_list (th);
1287           th->notify (th->notify_cls, 0, NULL);
1288           GNUNET_free (th);
1289           return;
1290         }
1291 #if DEBUG_TRANSPORT
1292       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1293                   "Need more bandwidth, delaying delivery to `%4s' by %llu ms\n",
1294                   GNUNET_i2s(&th->target),
1295                   duration.value);
1296 #endif
1297       th->notify_delay_task
1298         = GNUNET_SCHEDULER_add_delayed (h->sched,
1299                                         GNUNET_NO,
1300                                         GNUNET_SCHEDULER_PRIORITY_KEEP,
1301                                         GNUNET_SCHEDULER_NO_TASK,
1302                                         duration, &transmit_ready, th);
1303       return;
1304     }
1305 #if DEBUG_TRANSPORT
1306   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1307               "Bandwidth available for transmission to `%4s'\n",
1308               GNUNET_i2s (&n->id));
1309 #endif
1310   if (GNUNET_NO == n->transmit_ok)
1311     {
1312       /* we may be ready, but transport service is not;
1313          wait for SendOkMessage or timeout */
1314 #if DEBUG_TRANSPORT
1315       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1316                   "Need to wait for transport service `%s' message\n",
1317                   "SEND_OK");
1318 #endif
1319       th->notify_delay_task
1320         = GNUNET_SCHEDULER_add_delayed (h->sched,
1321                                         GNUNET_NO,
1322                                         GNUNET_SCHEDULER_PRIORITY_KEEP,
1323                                         GNUNET_SCHEDULER_NO_TASK,
1324                                         GNUNET_TIME_absolute_get_remaining
1325                                         (th->timeout), &transmit_timeout, th);
1326       return;
1327     }
1328   n->transmit_ok = GNUNET_NO;
1329   remove_from_wait_list (th);
1330 #if DEBUG_TRANSPORT
1331   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Moving message for `%4s' to ready list\n",
1332               GNUNET_i2s(&n->id));
1333 #endif
1334   insert_transmit_handle (&h->connect_ready_head, th);
1335   if (GNUNET_NO == h->transmission_scheduled)
1336     schedule_transmission (h);
1337 }
1338
1339
1340 /**
1341  * Add neighbour to our list
1342  */
1343 static void
1344 add_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1345                uint32_t quota_out,
1346                struct GNUNET_TIME_Relative latency,
1347                const struct GNUNET_PeerIdentity *pid)
1348 {
1349   struct NeighbourList *n;
1350   struct GNUNET_TRANSPORT_TransmitHandle *prev;
1351   struct GNUNET_TRANSPORT_TransmitHandle *pos;
1352   struct GNUNET_TRANSPORT_TransmitHandle *next;
1353
1354   /* check for duplicates */
1355   if (NULL != find_neighbour (h, pid))
1356     {
1357       GNUNET_break (0);
1358       return;
1359     }
1360 #if DEBUG_TRANSPORT
1361   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1362               "Creating entry for new neighbour `%4s'.\n", GNUNET_i2s (pid));
1363 #endif
1364   n = GNUNET_malloc (sizeof (struct NeighbourList));
1365   n->id = *pid;
1366   n->last_quota_update = GNUNET_TIME_absolute_get ();
1367   n->quota_out = quota_out;
1368   n->next = h->neighbours;
1369   n->transmit_ok = GNUNET_YES;
1370   h->neighbours = n;
1371   if (h->nc_cb != NULL)
1372     h->nc_cb (h->cls, &n->id, latency);
1373   prev = NULL;
1374   pos = h->connect_wait_head;
1375   while (pos != NULL)
1376     {
1377       next = pos->next;
1378       if (0 == memcmp (pid,
1379                        &pos->target, sizeof (struct GNUNET_PeerIdentity)))
1380         {
1381           pos->neighbour = n;
1382           GNUNET_assert (NULL == n->transmit_handle);
1383           n->transmit_handle = pos;
1384           if (prev == NULL)
1385             h->connect_wait_head = next;
1386           else
1387             prev->next = next;
1388           if (GNUNET_YES == n->received_ack)
1389             {
1390 #if DEBUG_TRANSPORT
1391               GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1392                           "Found pending request for `%4s' will trigger it now.\n",
1393                           GNUNET_i2s (&pos->target));
1394 #endif
1395               if (pos->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1396                 {
1397                   GNUNET_SCHEDULER_cancel (h->sched, pos->notify_delay_task);
1398                   pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1399                 }
1400               schedule_request (pos);
1401             }
1402           else
1403             {
1404 #if DEBUG_TRANSPORT
1405               GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1406                           "Found pending request for `%4s' but still need `%s' before proceeding.\n",
1407                           GNUNET_i2s (&pos->target),
1408                           "ACK");
1409 #endif
1410             }
1411           break;
1412         }
1413       prev = pos;
1414       pos = next;
1415     }
1416 }
1417
1418
1419 /**
1420  * Connect to the transport service.  Note that the connection may
1421  * complete (or fail) asynchronously.
1422  *
1423
1424  * @param sched scheduler to use
1425  * @param cfg configuration to use
1426  * @param cls closure for the callbacks
1427  * @param rec receive function to call
1428  * @param nc function to call on connect events
1429  * @param dc function to call on disconnect events
1430  */
1431 struct GNUNET_TRANSPORT_Handle *
1432 GNUNET_TRANSPORT_connect (struct GNUNET_SCHEDULER_Handle *sched,
1433                           const struct GNUNET_CONFIGURATION_Handle *cfg,
1434                           void *cls,
1435                           GNUNET_TRANSPORT_ReceiveCallback rec,
1436                           GNUNET_TRANSPORT_NotifyConnect nc,
1437                           GNUNET_TRANSPORT_NotifyDisconnect nd)
1438 {
1439   struct GNUNET_TRANSPORT_Handle *ret;
1440
1441   GNUNET_ARM_start_service ("peerinfo",
1442                             cfg, sched, START_SERVICE_TIMEOUT, NULL, NULL);
1443   GNUNET_ARM_start_service ("transport",
1444                             cfg, sched, START_SERVICE_TIMEOUT, NULL, NULL);
1445   ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1446   ret->sched = sched;
1447   ret->cfg = cfg;
1448   ret->cls = cls;
1449   ret->rec = rec;
1450   ret->nc_cb = nc;
1451   ret->nd_cb = nd;
1452   ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1453   schedule_reconnect (ret);
1454   return ret;
1455 }
1456
1457
1458 /**
1459  * These stop activities must be run in a fresh
1460  * scheduler that is NOT in shutdown mode.
1461  */
1462 static void
1463 stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1464 {
1465   struct GNUNET_TRANSPORT_Handle *handle = cls;
1466   GNUNET_ARM_stop_service ("transport",
1467                            handle->cfg,
1468                            tc->sched, STOP_SERVICE_TIMEOUT, NULL, NULL);
1469   GNUNET_ARM_stop_service ("peerinfo",
1470                            handle->cfg,
1471                            tc->sched, STOP_SERVICE_TIMEOUT, NULL, NULL);
1472 }
1473
1474
1475 /**
1476  * Disconnect from the transport service.
1477  */
1478 void
1479 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1480 {
1481   struct GNUNET_TRANSPORT_TransmitHandle *th;
1482   struct NeighbourList *n;
1483   struct HelloWaitList *hwl;
1484   struct GNUNET_CLIENT_Connection *client;
1485
1486 #if DEBUG_TRANSPORT
1487   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transport disconnect called!\n");
1488 #endif
1489   while (NULL != (th = handle->connect_ready_head))
1490     {
1491       handle->connect_ready_head = th->next;
1492       th->notify (th->notify_cls, 0, NULL);
1493       GNUNET_free (th);
1494     }
1495   while (NULL != (th = handle->connect_wait_head))
1496     {
1497       handle->connect_wait_head = th->next;
1498       if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1499         {
1500           GNUNET_SCHEDULER_cancel (handle->sched, th->notify_delay_task);
1501           th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1502         }
1503       th->notify (th->notify_cls, 0, NULL);
1504       GNUNET_free (th);
1505     }
1506   while (NULL != (n = handle->neighbours))
1507     {
1508       handle->neighbours = n->next;
1509       GNUNET_free (n);
1510     }
1511   while (NULL != (hwl = handle->hwl_head))
1512     {
1513       handle->hwl_head = hwl->next;
1514       GNUNET_SCHEDULER_cancel (handle->sched, hwl->task);
1515       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1516                   _("Disconnect while trying to obtain `%s' from transport service.\n"),
1517                   "HELLO");
1518       if (hwl->rec != NULL)
1519         hwl->rec (hwl->rec_cls, GNUNET_TIME_UNIT_ZERO, NULL, NULL);
1520       GNUNET_free (hwl);
1521     }
1522   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1523     {
1524       GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
1525       handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1526     }
1527   GNUNET_free_non_null (handle->my_hello);
1528   handle->my_hello = NULL;
1529   GNUNET_SCHEDULER_run (&stop_task, handle);
1530   if (NULL != (client = handle->client))
1531     {
1532 #if DEBUG_TRANSPORT
1533       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1534                   "Disconnecting from transport service for good.\n");
1535 #endif
1536       handle->client = NULL;
1537       GNUNET_CLIENT_disconnect (client);
1538     }
1539   if (client == NULL)
1540     GNUNET_free (handle);
1541 }
1542
1543
1544 /**
1545  * Type of a function to call when we receive a message
1546  * from the service.
1547  *
1548  * @param cls closure
1549  * @param msg message received, NULL on timeout or fatal error
1550  */
1551 static void
1552 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
1553 {
1554   struct GNUNET_TRANSPORT_Handle *h = cls;
1555   const struct DisconnectInfoMessage *dim;
1556   const struct ConnectInfoMessage *cim;
1557   const struct InboundMessage *im;
1558   const struct GNUNET_MessageHeader *imm;
1559   const struct SendOkMessage *okm;
1560   struct HelloWaitList *hwl;
1561   struct NeighbourList *n;
1562   struct GNUNET_PeerIdentity me;
1563   struct GNUNET_TRANSPORT_TransmitHandle *th;
1564   uint16_t size;
1565
1566   if ((msg == NULL) || (h->client == NULL))
1567     {
1568       if (h->client != NULL)
1569         {
1570 #if DEBUG_TRANSPORT
1571           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1572                       "Error receiving from transport service, disconnecting temporarily.\n");
1573 #endif
1574           if (h->network_handle != NULL)
1575             {
1576               GNUNET_NETWORK_connection_notify_transmit_ready_cancel (h->network_handle);
1577               h->network_handle = NULL;
1578               h->transmission_scheduled = GNUNET_NO;
1579               th = h->connect_ready_head;
1580               /* add timeout again, we cancelled the transmit_ready task! */
1581               GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
1582               th->notify_delay_task 
1583                 = GNUNET_SCHEDULER_add_delayed (h->sched,
1584                                                 GNUNET_NO,
1585                                                 GNUNET_SCHEDULER_PRIORITY_KEEP,
1586                                                 GNUNET_SCHEDULER_NO_TASK,
1587                                                 GNUNET_TIME_absolute_get_remaining(th->timeout),
1588                                                 &transmit_timeout, 
1589                                                 th);    
1590             }
1591           GNUNET_CLIENT_disconnect (h->client);
1592           h->client = NULL;
1593           schedule_reconnect (h);
1594         }
1595       else
1596         {
1597           /* shutdown initiated from 'GNUNET_TRANSPORT_disconnect',
1598              finish clean up work! */
1599           GNUNET_free (h);
1600         }
1601       return;
1602     }
1603   GNUNET_CLIENT_receive (h->client,
1604                          &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1605   size = ntohs (msg->size);
1606   switch (ntohs (msg->type))
1607     {
1608     case GNUNET_MESSAGE_TYPE_HELLO:
1609       if (GNUNET_OK !=
1610           GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
1611                                &me))
1612         {
1613           GNUNET_break (0);
1614           break;
1615         }
1616 #if DEBUG_TRANSPORT
1617       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1618                   "Receiving (my own) `%s' message, I am `%4s'.\n",
1619                   "HELLO", GNUNET_i2s (&me));
1620 #endif
1621       GNUNET_free_non_null (h->my_hello);
1622       h->my_hello = NULL;
1623       if (size < sizeof (struct GNUNET_MessageHeader))
1624         {
1625           GNUNET_break (0);
1626           break;
1627         }
1628       h->my_hello = GNUNET_malloc (size);
1629       memcpy (h->my_hello, msg, size);
1630       while (NULL != (hwl = h->hwl_head))
1631         {
1632           h->hwl_head = hwl->next;
1633           GNUNET_SCHEDULER_cancel (h->sched, hwl->task);
1634           GNUNET_TRANSPORT_get_hello (h,
1635                                       GNUNET_TIME_UNIT_ZERO,
1636                                       hwl->rec, hwl->rec_cls);
1637           GNUNET_free (hwl);
1638         }
1639       break;
1640     case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
1641       if (size != sizeof (struct ConnectInfoMessage))
1642         {
1643           GNUNET_break (0);
1644           break;
1645         }
1646       cim = (const struct ConnectInfoMessage *) msg;
1647 #if DEBUG_TRANSPORT
1648       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1649                   "Receiving `%s' message for `%4s'.\n",
1650                   "CONNECT", GNUNET_i2s (&cim->id));
1651 #endif
1652       add_neighbour (h,
1653                      ntohl (cim->quota_out),
1654                      GNUNET_TIME_relative_ntoh (cim->latency), &cim->id);
1655       break;
1656     case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
1657       if (size != sizeof (struct DisconnectInfoMessage))
1658         {
1659           GNUNET_break (0);
1660           break;
1661         }
1662       dim = (const struct DisconnectInfoMessage *) msg;
1663 #if DEBUG_TRANSPORT
1664       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1665                   "Receiving `%s' message for `%4s'.\n",
1666                   "DISCONNECT", GNUNET_i2s (&dim->peer));
1667 #endif
1668       remove_neighbour (h, &dim->peer);
1669       break;
1670     case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
1671       if (size != sizeof (struct SendOkMessage))
1672         {
1673           GNUNET_break (0);
1674           break;
1675         }
1676       okm = (const struct SendOkMessage *) msg;
1677 #if DEBUG_TRANSPORT
1678       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1679                   "Receiving `%s' message, transmission %s.\n", "SEND_OK",
1680                   ntohl(okm->success) == GNUNET_OK ? "succeeded" : "failed");
1681 #endif
1682       n = find_neighbour (h, &okm->peer);
1683       GNUNET_assert (n != NULL);
1684       n->transmit_ok = GNUNET_YES;
1685       if (n->transmit_handle != NULL)
1686         {
1687 #if DEBUG_TRANSPORT
1688           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1689                       "Processing pending message for `%4s'\n",
1690                       GNUNET_i2s(&n->id));
1691 #endif
1692           GNUNET_SCHEDULER_cancel (h->sched,
1693                                    n->transmit_handle->notify_delay_task);
1694           n->transmit_handle->notify_delay_task =
1695             GNUNET_SCHEDULER_NO_TASK;
1696           GNUNET_assert (GNUNET_YES == n->received_ack);
1697           schedule_request (n->transmit_handle);
1698         }
1699       break;
1700     case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
1701 #if DEBUG_TRANSPORT
1702       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1703                   "Receiving `%s' message.\n", "RECV");
1704 #endif
1705       if (size <
1706           sizeof (struct InboundMessage) +
1707           sizeof (struct GNUNET_MessageHeader))
1708         {
1709           GNUNET_break (0);
1710           break;
1711         }
1712       im = (const struct InboundMessage *) msg;
1713       imm = (const struct GNUNET_MessageHeader *) &im[1];
1714       if (ntohs (imm->size) + sizeof (struct InboundMessage) != size)
1715         {
1716           GNUNET_break (0);
1717           break;
1718         }
1719       switch (ntohs (imm->type))
1720         {
1721         case GNUNET_MESSAGE_TYPE_TRANSPORT_ACK:
1722 #if DEBUG_TRANSPORT
1723           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1724                       "Receiving `%s' message from `%4s'.\n",
1725                       "ACK", GNUNET_i2s (&im->peer));
1726 #endif
1727           n = find_neighbour (h, &im->peer);
1728           if (n == NULL)
1729             {
1730               GNUNET_break (0);
1731               break;
1732             }
1733           if (n->received_ack == GNUNET_NO)
1734             {
1735               n->received_ack = GNUNET_YES;
1736               if (NULL != n->transmit_handle)
1737                 {
1738 #if DEBUG_TRANSPORT
1739                   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1740                               "Peer connected, scheduling delayed message for deliverery now.\n");
1741 #endif
1742                   schedule_request (n->transmit_handle);
1743                 }
1744             }
1745           break;
1746         default:
1747 #if DEBUG_TRANSPORT
1748           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1749                       "Received message of type %u from `%4s'.\n",
1750                       ntohs (imm->type), GNUNET_i2s (&im->peer));
1751 #endif
1752           if (h->rec != NULL)
1753             h->rec (h->cls,
1754                     GNUNET_TIME_relative_ntoh (im->latency), &im->peer, imm);
1755           break;
1756         }
1757       break;
1758     default:
1759       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1760                   _
1761                   ("Received unexpected message of type %u in %s:%u\n"),
1762                   ntohs (msg->type), __FILE__, __LINE__);
1763       GNUNET_break (0);
1764       break;
1765     }
1766 }
1767
1768
1769 struct ClientTransmitWrapper
1770 {
1771   GNUNET_NETWORK_TransmitReadyNotify notify;
1772   void *notify_cls;
1773   struct GNUNET_TRANSPORT_TransmitHandle *th;
1774 };
1775
1776
1777 /**
1778  * Transmit message of a client destined for another
1779  * peer to the service.
1780  */
1781 static size_t
1782 client_notify_wrapper (void *cls, size_t size, void *buf)
1783 {
1784   struct ClientTransmitWrapper *ctw = cls;
1785   struct OutboundMessage *obm;
1786   struct GNUNET_MessageHeader *hdr;
1787   size_t ret;
1788
1789   if (size == 0)
1790     {
1791 #if DEBUG_TRANSPORT
1792       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1793                   "Transmission request could not be satisfied.\n");
1794 #endif
1795       ret = ctw->notify (ctw->notify_cls, 0, NULL);
1796       GNUNET_assert (ret == 0);
1797       GNUNET_free (ctw);
1798       return 0;
1799     }
1800   GNUNET_assert (size >= sizeof (struct OutboundMessage));
1801   obm = buf;
1802   ret = ctw->notify (ctw->notify_cls,
1803                      size - sizeof (struct OutboundMessage),
1804                      (void *) &obm[1]);
1805   if (ret == 0)
1806     {
1807       /* Need to reset flag, no SEND means no SEND_OK! */
1808       ctw->th->neighbour->transmit_ok = GNUNET_YES;
1809       GNUNET_free (ctw);
1810       return 0;
1811     }
1812   GNUNET_assert (ret >= sizeof (struct GNUNET_MessageHeader));
1813   hdr = (struct GNUNET_MessageHeader *) &obm[1];
1814   GNUNET_assert (ntohs (hdr->size) == ret);
1815   GNUNET_assert (ret + sizeof (struct OutboundMessage) <
1816                  GNUNET_SERVER_MAX_MESSAGE_SIZE);
1817 #if DEBUG_TRANSPORT
1818   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1819               "Transmitting `%s' message with data for `%4s'\n",
1820               "SEND", GNUNET_i2s (&ctw->th->target));
1821 #endif
1822   ret += sizeof (struct OutboundMessage);
1823   obm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
1824   obm->header.size = htons (ret);
1825   obm->priority = htonl (ctw->th->priority);
1826   obm->peer = ctw->th->target;
1827   GNUNET_free (ctw);
1828   return ret;
1829 }
1830
1831
1832
1833 /**
1834  * Check if we could queue a message of the given size for
1835  * transmission.  The transport service will take both its
1836  * internal buffers and bandwidth limits imposed by the
1837  * other peer into consideration when answering this query.
1838  *
1839  * @param handle connection to transport service
1840  * @param target who should receive the message
1841  * @param size how big is the message we want to transmit?
1842  * @param priority how important is the message?
1843  * @param timeout after how long should we give up (and call
1844  *        notify with buf NULL and size 0)?
1845  * @param notify function to call when we are ready to
1846  *        send such a message
1847  * @param notify_cls closure for notify
1848  * @return NULL if someone else is already waiting to be notified
1849  *         non-NULL if the notify callback was queued (can be used to cancel
1850  *         using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1851  */
1852 struct GNUNET_TRANSPORT_TransmitHandle *
1853 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
1854                                         *handle,
1855                                         const struct GNUNET_PeerIdentity
1856                                         *target, size_t size,
1857                                         unsigned int priority,
1858                                         struct GNUNET_TIME_Relative timeout,
1859                                         GNUNET_NETWORK_TransmitReadyNotify
1860                                         notify, void *notify_cls)
1861 {
1862   struct GNUNET_TRANSPORT_TransmitHandle *pos;
1863   struct GNUNET_TRANSPORT_TransmitHandle *th;
1864   struct NeighbourList *n;
1865   struct ClientTransmitWrapper *ctw;
1866
1867   if (size + sizeof (struct OutboundMessage) >=
1868       GNUNET_SERVER_MAX_MESSAGE_SIZE)
1869     {
1870       GNUNET_break (0);
1871       return NULL;
1872     }
1873 #if DEBUG_TRANSPORT
1874   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1875               "Asking transport service for transmission of %u bytes to peer `%4s'.\n",
1876               size, GNUNET_i2s (target));
1877 #endif
1878   n = find_neighbour (handle, target);
1879   if ( (n != NULL) &&
1880        (n->transmit_handle != NULL) )
1881     return NULL; /* already have a request pending for this peer! */
1882   ctw = GNUNET_malloc (sizeof (struct ClientTransmitWrapper));
1883   th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
1884   ctw->notify = notify;
1885   ctw->notify_cls = notify_cls;
1886   ctw->th = th;
1887   th->handle = handle;
1888   th->neighbour = n;
1889   th->target = *target;
1890   th->notify = &client_notify_wrapper;
1891   th->notify_cls = ctw;
1892   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1893   th->notify_size = size + sizeof (struct OutboundMessage);
1894   th->priority = priority;
1895   if (NULL == n)
1896     {
1897       pos = handle->connect_wait_head;
1898       while (pos != NULL)
1899         {
1900           GNUNET_assert (0 != memcmp (target,
1901                                       &pos->target,
1902                                       sizeof (struct GNUNET_PeerIdentity)));
1903           pos = pos->next;
1904         }
1905 #if DEBUG_TRANSPORT
1906       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1907                   "Will now try to connect to `%4s'.\n", GNUNET_i2s (target));
1908 #endif
1909       try_connect (th);
1910       return th;
1911     }
1912
1913 #if DEBUG_TRANSPORT
1914   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1915               "Transmission request queued for transmission to transport service.\n");
1916 #endif
1917   GNUNET_assert (NULL == n->transmit_handle);
1918   n->transmit_handle = th;
1919   if (GNUNET_YES != n->received_ack)
1920     {
1921 #if DEBUG_TRANSPORT
1922       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1923                   "Connection to `%4s' is not yet confirmed connected, scheduling timeout (%llu ms) only.\n",
1924                   GNUNET_i2s (target), timeout.value);
1925 #endif
1926       th->notify_delay_task
1927         = GNUNET_SCHEDULER_add_delayed (handle->sched,
1928                                         GNUNET_NO,
1929                                         GNUNET_SCHEDULER_PRIORITY_KEEP,
1930                                         GNUNET_SCHEDULER_NO_TASK,
1931                                         timeout, &transmit_timeout, th);
1932       return th;
1933     }
1934   
1935 #if DEBUG_TRANSPORT
1936   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1937               "Peer `%4s' is ready to receive, scheduling message for delivery now.\n",
1938               GNUNET_i2s (target));
1939 #endif
1940   schedule_request (th);
1941   return th;
1942 }
1943
1944
1945 /**
1946  * Cancel the specified transmission-ready
1947  * notification.
1948  */
1949 void
1950 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
1951                                                GNUNET_TRANSPORT_TransmitHandle
1952                                                *th)
1953 {
1954   struct GNUNET_TRANSPORT_Handle *h;
1955
1956 #if DEBUG_TRANSPORT
1957   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1958               "Transmission request of %u bytes to `%4s' was cancelled.\n",
1959               th->notify_size - sizeof(struct OutboundMessage),
1960               GNUNET_i2s (&th->target));
1961 #endif
1962   GNUNET_assert (th->notify == &client_notify_wrapper);
1963   remove_from_any_list (th);
1964   h = th->handle;
1965   if ((h->connect_ready_head == NULL) && (h->network_handle != NULL))
1966     {
1967       GNUNET_NETWORK_connection_notify_transmit_ready_cancel (h->network_handle);
1968       h->network_handle = NULL;
1969       h->transmission_scheduled = GNUNET_NO;
1970     }
1971   GNUNET_free (th->notify_cls);
1972   GNUNET_free (th);
1973 }
1974
1975
1976 /* end of transport_api.c */