c4886520b0d3a045be2b90d862c6745775c28451
[oweals/gnunet.git] / src / transport / gnunet-service-transport_neighbours.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2010-2015 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/gnunet-service-transport_neighbours.c
23  * @brief neighbour management
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet_ats_service.h"
28 #include "gnunet-service-transport_ats.h"
29 #include "gnunet-service-transport_blacklist.h"
30 #include "gnunet-service-transport_clients.h"
31 #include "gnunet-service-transport_neighbours.h"
32 #include "gnunet-service-transport_manipulation.h"
33 #include "gnunet-service-transport_plugins.h"
34 #include "gnunet-service-transport_validation.h"
35 #include "gnunet-service-transport.h"
36 #include "gnunet_peerinfo_service.h"
37 #include "gnunet_constants.h"
38 #include "transport.h"
39
40
41 /**
42  * Size of the neighbour hash map.
43  */
44 #define NEIGHBOUR_TABLE_SIZE 256
45
46 /**
47  * Time we give plugin to transmit DISCONNECT message before the
48  * neighbour entry self-destructs.
49  */
50 #define DISCONNECT_SENT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 500)
51
52 /**
53  * How often must a peer violate bandwidth quotas before we start
54  * to simply drop its messages?
55  */
56 #define QUOTA_VIOLATION_DROP_THRESHOLD 10
57
58 /**
59  * How long are we willing to wait for a response from ATS before timing out?
60  */
61 #define ATS_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
62
63 /**
64  * How long are we willing to wait for an ACK from the other peer before
65  * giving up on our connect operation?
66  */
67 #define SETUP_CONNECTION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
68
69 /**
70  * How long are we willing to wait for a successful reconnect if
71  * an existing connection went down?  Much shorter than the
72  * usual SETUP_CONNECTION_TIMEOUT as we do not inform the
73  * higher layers about the disconnect during this period.
74  */
75 #define FAST_RECONNECT_TIMEOUT GNUNET_TIME_UNIT_SECONDS
76
77 /**
78  * Interval to send utilization data
79  */
80 #define UTIL_TRANSMISSION_INTERVAL GNUNET_TIME_UNIT_SECONDS
81
82 /**
83  * State describing which kind a reply this neighbour should send
84  */
85 enum GST_ACK_State
86 {
87   /**
88    * We did not receive a SYN message for this neighbour
89    */
90   ACK_UNDEFINED = 0,
91
92   /**
93    * The neighbour received a SYN message and has to send a SYN_ACK
94    * as reply
95    */
96   ACK_SEND_SYN_ACK = 1,
97
98   /**
99    * The neighbour sent a SYN_ACK message and has to send a ACK
100    * as reply
101    */
102   ACK_SEND_ACK = 2
103 };
104
105
106 GNUNET_NETWORK_STRUCT_BEGIN
107
108 /**
109  * Message a peer sends to another to indicate that it intends to
110  * setup a connection/session for data exchange.  A 'SESSION_SYN'
111  * should be answered with a 'SESSION_SYN_ACK' with the same body
112  * to confirm.  A 'SESSION_SYN_ACK' should then be followed with
113  * a 'ACK'.  Once the 'ACK' is received, both peers
114  * should be connected.
115  */
116 struct TransportSynMessage
117 {
118   /**
119    * Header of type #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN
120    * or #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN_ACK
121    */
122   struct GNUNET_MessageHeader header;
123
124   /**
125    * Always zero.
126    */
127   uint32_t reserved GNUNET_PACKED;
128
129   /**
130    * Absolute time at the sender.  Only the most recent connect
131    * message implies which session is preferred by the sender.
132    */
133   struct GNUNET_TIME_AbsoluteNBO timestamp;
134
135 };
136
137
138 /**
139  * Message a peer sends to another when connected to indicate that a
140  * session is in use and the peer is still alive or to respond to a keep alive.
141  * A peer sends a message with type #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE
142  * to request a message with #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE.
143  * When the keep alive response with type is received, transport service
144  * will call the respective plugin to update the session timeout
145  */
146 struct SessionKeepAliveMessage
147 {
148   /**
149    * Header of type #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE or
150    * #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE.
151    */
152   struct GNUNET_MessageHeader header;
153
154   /**
155    * A nonce to identify the session the keep alive is used for
156    */
157   uint32_t nonce GNUNET_PACKED;
158 };
159
160 /**
161  * Message we send to the other peer to notify him that we intentionally
162  * are disconnecting (to reduce timeouts).  This is just a friendly
163  * notification, peers must not rely on always receiving disconnect
164  * messages.
165  */
166 struct SessionDisconnectMessage
167 {
168   /**
169    * Header of type #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT
170    */
171   struct GNUNET_MessageHeader header;
172
173   /**
174    * Always zero.
175    */
176   uint32_t reserved GNUNET_PACKED;
177
178   /**
179    * Purpose of the signature.  Extends over the timestamp.
180    * Purpose should be #GNUNET_SIGNATURE_PURPOSE_TRANSPORT_DISCONNECT.
181    */
182   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
183
184   /**
185    * Absolute time at the sender.  Only the most recent connect
186    * message implies which session is preferred by the sender.
187    */
188   struct GNUNET_TIME_AbsoluteNBO timestamp;
189
190   /**
191    * Public key of the sender.
192    */
193   struct GNUNET_CRYPTO_EddsaPublicKey public_key;
194
195   /**
196    * Signature of the peer that sends us the disconnect.  Only
197    * valid if the timestamp is AFTER the timestamp from the
198    * corresponding 'SYN' message.
199    */
200   struct GNUNET_CRYPTO_EddsaSignature signature;
201
202 };
203
204 GNUNET_NETWORK_STRUCT_END
205
206
207 /**
208  * For each neighbour we keep a list of messages
209  * that we still want to transmit to the neighbour.
210  */
211 struct MessageQueue
212 {
213
214   /**
215    * This is a doubly linked list.
216    */
217   struct MessageQueue *next;
218
219   /**
220    * This is a doubly linked list.
221    */
222   struct MessageQueue *prev;
223
224   /**
225    * Function to call once we're done.
226    */
227   GST_NeighbourSendContinuation cont;
228
229   /**
230    * Closure for @e cont
231    */
232   void *cont_cls;
233
234   /**
235    * The message(s) we want to transmit, GNUNET_MessageHeader(s)
236    * stuck together in memory.  Allocated at the end of this struct.
237    */
238   const char *message_buf;
239
240   /**
241    * Size of the message buf
242    */
243   size_t message_buf_size;
244
245   /**
246    * At what time should we fail?
247    */
248   struct GNUNET_TIME_Absolute timeout;
249
250 };
251
252
253 /**
254  * A possible address we could use to communicate with a neighbour.
255  */
256 struct NeighbourAddress
257 {
258
259   /**
260    * Active session for this address.
261    */
262   struct Session *session;
263
264   /**
265    * Network-level address information.
266    */
267   struct GNUNET_HELLO_Address *address;
268
269   /**
270    * Timestamp of the 'SESSION_CONNECT' message we sent to the other
271    * peer for this address.  Use to check that the ACK is in response
272    * to our most recent 'SYN'.
273    */
274   struct GNUNET_TIME_Absolute connect_timestamp;
275
276   /**
277    * Inbound bandwidth from ATS for this address.
278    */
279   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
280
281   /**
282    * Outbound bandwidth from ATS for this address.
283    */
284   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
285
286   /**
287    * Did we tell ATS that this is our 'active' address?
288    */
289   int ats_active;
290
291   /**
292    * The current nonce sent in the last keep alive messages
293    */
294   uint32_t keep_alive_nonce;
295 };
296
297
298 /**
299  * Entry in neighbours.
300  */
301 struct NeighbourMapEntry
302 {
303
304   /**
305    * Head of list of messages we would like to send to this peer;
306    * must contain at most one message per client.
307    */
308   struct MessageQueue *messages_head;
309
310   /**
311    * Tail of list of messages we would like to send to this peer; must
312    * contain at most one message per client.
313    */
314   struct MessageQueue *messages_tail;
315
316   /**
317    * Are we currently trying to send a message? If so, which one?
318    */
319   struct MessageQueue *is_active;
320
321   /**
322    * Primary address we currently use to communicate with the neighbour.
323    */
324   struct NeighbourAddress primary_address;
325
326   /**
327    * Alternative address currently under consideration for communicating
328    * with the neighbour.
329    */
330   struct NeighbourAddress alternative_address;
331
332   /**
333    * Identity of this neighbour.
334    */
335   struct GNUNET_PeerIdentity id;
336
337   /**
338    * Main task that drives this peer (timeouts, keepalives, etc.).
339    * Always runs the 'master_task'.
340    */
341   struct GNUNET_SCHEDULER_Task *task;
342
343   /**
344    * Task to disconnect neighbour after we received a DISCONNECT message
345    */
346   struct GNUNET_SCHEDULER_Task *delayed_disconnect_task;
347
348   /**
349    * At what time should we sent the next keep-alive message?
350    */
351   struct GNUNET_TIME_Absolute keep_alive_time;
352
353   /**
354    * At what time did we sent the last keep-alive message?  Used
355    * to calculate round-trip time ("latency").
356    */
357   struct GNUNET_TIME_Absolute last_keep_alive_time;
358
359   /**
360    * Timestamp we should include in our next SYN_ACK message.
361    * (only valid if 'send_connect_ack' is #GNUNET_YES).  Used to build
362    * our SYN_ACK message.
363    */
364   struct GNUNET_TIME_Absolute connect_ack_timestamp;
365
366   /**
367    * ATS address suggest handle
368    */
369   struct GNUNET_ATS_ConnectivitySuggestHandle *suggest_handle;
370
371   /**
372    * Time where we should cut the connection (timeout) if we don't
373    * make progress in the state machine (or get a KEEPALIVE_RESPONSE
374    * if we are in #S_CONNECTED).
375    */
376   struct GNUNET_TIME_Absolute timeout;
377
378   /**
379    * Tracker for inbound bandwidth.
380    */
381   struct GNUNET_BANDWIDTH_Tracker in_tracker;
382
383   /**
384    * How often has the other peer (recently) violated the inbound
385    * traffic limit?  Incremented by 10 per violation, decremented by 1
386    * per non-violation (for each time interval).
387    */
388   unsigned int quota_violation_count;
389
390   /**
391    * The current state of the peer.
392    */
393   enum GNUNET_TRANSPORT_PeerState state;
394
395   /**
396    * Did we sent an KEEP_ALIVE message and are we expecting a response?
397    */
398   int expect_latency_response;
399
400   /**
401    * When a peer wants to connect we have to reply to the 1st SYN message
402    * with a SYN_ACK message. But sometime we cannot send this message
403    * immediately since we do not have an address and then we have to remember
404    * to send this message as soon as we have an address.
405    *
406    * Flag to set if we still need to send a SYN_ACK message to the other peer
407    * (once we have an address to use and the peer has been allowed by our
408    * blacklist).  Initially set to #ACK_UNDEFINED. Set to #ACK_SEND_SYN_ACK
409    * if we need to send a SYN_ACK.  Set to #ACK_SEND_ACK if we did
410    * send a SYN_ACK and should go to #S_CONNECTED upon receiving a
411    * 'ACK' (regardless of what our own state machine might say).
412    */
413   enum GST_ACK_State ack_state;
414
415   /**
416    * Tracking utilization of outbound bandwidth
417    */
418   uint32_t util_total_bytes_sent;
419
420   /**
421    * Tracking utilization of inbound bandwidth
422    */
423   uint32_t util_total_bytes_recv;
424
425   /**
426    * Date of last utilization transmission
427    */
428   struct GNUNET_TIME_Absolute last_util_transmission;
429 };
430
431
432 /**
433  * Context for blacklist checks and the #try_connect_bl_check_cont()
434  * function.  Stores information about ongoing blacklist checks.
435  */
436 struct BlackListCheckContext
437 {
438
439   /**
440    * We keep blacklist checks in a DLL.
441    */
442   struct BlackListCheckContext *next;
443
444   /**
445    * We keep blacklist checks in a DLL.
446    */
447   struct BlackListCheckContext *prev;
448
449   /**
450    * Address that is being checked.
451    */
452   struct NeighbourAddress na;
453
454   /**
455    * Handle to the ongoing blacklist check.
456    */
457   struct GST_BlacklistCheck *bc;
458 };
459
460
461 /**
462  * Hash map from peer identities to the respective `struct NeighbourMapEntry`.
463  */
464 static struct GNUNET_CONTAINER_MultiPeerMap *neighbours;
465
466 /**
467  * We keep blacklist checks in a DLL so that we can find
468  * the 'sessions' in their 'struct NeighbourAddress' if
469  * a session goes down.
470  */
471 static struct BlackListCheckContext *bc_head;
472
473 /**
474  * We keep blacklist checks in a DLL.
475  */
476 static struct BlackListCheckContext *bc_tail;
477
478 /**
479  * List of pending blacklist checks: head
480  */
481 static struct BlacklistCheckSwitchContext *pending_bc_head;
482
483 /**
484  * List of pending blacklist checks: tail
485  */
486 static struct BlacklistCheckSwitchContext *pending_bc_tail;
487
488 /**
489  * counter for connected neighbours
490  */
491 static unsigned int neighbours_connected;
492
493 /**
494  * Number of bytes we have currently queued for transmission.
495  */
496 static unsigned long long bytes_in_send_queue;
497
498 /**
499  * Task transmitting utilization data
500  */
501 static struct GNUNET_SCHEDULER_Task *util_transmission_tk;
502
503
504 /**
505  * Convert the given ACK state to a string.
506  *
507  * @param s state
508  * @return corresponding human-readable string
509  */
510 static char *
511 print_ack_state (enum GST_ACK_State s)
512 {
513   switch (s) {
514     case ACK_UNDEFINED:
515       return "UNDEFINED";
516     case ACK_SEND_SYN_ACK:
517       return "SEND_SYN_ACK";
518     case ACK_SEND_ACK:
519       return "SEND_ACK";
520     default:
521       GNUNET_break (0);
522       return "N/A";
523   }
524 }
525
526
527 /**
528  * Notify our clients that another peer connected to us.
529  *
530  * @param peer the peer that connected
531  * @param bandwidth_in inbound bandwidth in NBO
532  * @param bandwidth_out outbound bandwidth in NBO
533  */
534 static void
535 neighbours_connect_notification (const struct GNUNET_PeerIdentity *peer,
536                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
537                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
538 {
539   size_t len = sizeof(struct ConnectInfoMessage);
540   char buf[len] GNUNET_ALIGN;
541   struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
542
543   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
544               "We are now connected to peer `%s'\n",
545               GNUNET_i2s (peer));
546   connect_msg->header.size = htons (sizeof(buf));
547   connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
548   connect_msg->id = *peer;
549   connect_msg->quota_in = bandwidth_in;
550   connect_msg->quota_out = bandwidth_out;
551   GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
552 }
553
554
555 /**
556  * Notify our clients (and manipulation) that a peer disconnected from
557  * us.
558  *
559  * @param peer the peer that disconnected
560  */
561 static void
562 neighbours_disconnect_notification (const struct GNUNET_PeerIdentity *peer)
563 {
564   struct DisconnectInfoMessage disconnect_msg;
565
566   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
567               "Peer `%s' disconnected\n",
568               GNUNET_i2s (peer));
569   GST_manipulation_peer_disconnect (peer);
570   disconnect_msg.header.size = htons (sizeof(struct DisconnectInfoMessage));
571   disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
572   disconnect_msg.reserved = htonl (0);
573   disconnect_msg.peer = *peer;
574   GST_clients_broadcast (&disconnect_msg.header,
575                          GNUNET_NO);
576 }
577
578
579 /**
580  * Notify transport clients that a neighbour peer changed its active
581  * address.
582  *
583  * @param peer identity of the peer
584  * @param address address possibly NULL if peer is not connected
585  * @param state current state this peer is in
586  * @param state_timeout timeout for the current state of the peer
587  * @param bandwidth_in bandwidth assigned inbound, 0 on disconnect
588  * @param bandwidth_out bandwidth assigned outbound, 0 on disconnect
589  */
590 static void
591 neighbours_changed_notification (const struct GNUNET_PeerIdentity *peer,
592                                  const struct GNUNET_HELLO_Address *address,
593                                  enum GNUNET_TRANSPORT_PeerState state,
594                                  struct GNUNET_TIME_Absolute state_timeout,
595                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
596                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
597 {
598   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
599               "Notifying about change for peer `%s' with address `%s' in state `%s' timing out at %s\n",
600               GNUNET_i2s (peer),
601               GST_plugins_a2s (address),
602               GNUNET_TRANSPORT_ps2s (state),
603               GNUNET_STRINGS_absolute_time_to_string (state_timeout));
604   /* FIXME: include bandwidth in notification! */
605   GST_clients_broadcast_peer_notification (peer,
606                                            address,
607                                            state,
608                                            state_timeout);
609 }
610
611
612 /**
613  * Lookup a neighbour entry in the neighbours hash map.
614  *
615  * @param pid identity of the peer to look up
616  * @return the entry, NULL if there is no existing record
617  */
618 static struct NeighbourMapEntry *
619 lookup_neighbour (const struct GNUNET_PeerIdentity *pid)
620 {
621   if (NULL == neighbours)
622     return NULL;
623   return GNUNET_CONTAINER_multipeermap_get (neighbours, pid);
624 }
625
626
627 /**
628  * Test if we're connected to the given peer.
629  *
630  * @param n neighbour entry of peer to test
631  * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
632  */
633 static int
634 test_connected (struct NeighbourMapEntry *n)
635 {
636   if (NULL == n)
637     return GNUNET_NO;
638   return GNUNET_TRANSPORT_is_connected (n->state);
639 }
640
641
642 /**
643  * Send information about a new outbound quota to our clients.
644  *
645  * @param target affected peer
646  * @param quota new quota
647  */
648 static void
649 send_outbound_quota (const struct GNUNET_PeerIdentity *target,
650                      struct GNUNET_BANDWIDTH_Value32NBO quota)
651 {
652   struct QuotaSetMessage q_msg;
653
654   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
655               "Sending outbound quota of %u Bps for peer `%s' to all clients\n",
656               ntohl (quota.value__),
657               GNUNET_i2s (target));
658   q_msg.header.size = htons (sizeof (struct QuotaSetMessage));
659   q_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
660   q_msg.quota = quota;
661   q_msg.peer = (*target);
662   GST_clients_broadcast (&q_msg.header, GNUNET_NO);
663 }
664
665
666 /**
667  * We don't need a given neighbour address any more.
668  * Release its resources and give appropriate notifications
669  * to ATS and other subsystems.
670  *
671  * @param na address we are done with; @a na itself must NOT be 'free'd, only the contents!
672  */
673 static void
674 free_address (struct NeighbourAddress *na)
675 {
676   if (GNUNET_YES == na->ats_active)
677     GST_validation_set_address_use (na->address,
678                                     GNUNET_NO);
679   if (NULL != na->address)
680   {
681     GST_ats_block_address (na->address,
682                            na->session);
683     GNUNET_HELLO_address_free (na->address);
684     na->address = NULL;
685   }
686   na->bandwidth_in = GNUNET_BANDWIDTH_value_init (0);
687   na->bandwidth_out = GNUNET_BANDWIDTH_value_init (0);
688   na->ats_active = GNUNET_NO;
689   na->keep_alive_nonce = 0;
690   na->session = NULL;
691 }
692
693
694 /**
695  * Master task run for every neighbour.  Performs all of the time-related
696  * activities (keep alive, send next message, disconnect if idle, finish
697  * clean up after disconnect).
698  *
699  * @param cls the `struct NeighbourMapEntry` for which we are running
700  * @param tc scheduler context (unused)
701  */
702 static void
703 master_task (void *cls,
704              const struct GNUNET_SCHEDULER_TaskContext *tc);
705
706
707 /**
708  * Set net state and state timeout for this neighbour and notify monitoring
709  *
710  * @param n the respective neighbour
711  * @param s the new state
712  * @param timeout the new timeout
713  */
714 static void
715 set_state_and_timeout (struct NeighbourMapEntry *n,
716                        enum GNUNET_TRANSPORT_PeerState s,
717                        struct GNUNET_TIME_Absolute timeout)
718 {
719   if (GNUNET_TRANSPORT_is_connected (s) &&
720       ! GNUNET_TRANSPORT_is_connected (n->state) )
721   {
722     neighbours_connect_notification (&n->id,
723                                      n->primary_address.bandwidth_in,
724                                      n->primary_address.bandwidth_out);
725     GNUNET_STATISTICS_set (GST_stats,
726                            gettext_noop ("# peers connected"),
727                            ++neighbours_connected,
728                            GNUNET_NO);
729   }
730   if (! GNUNET_TRANSPORT_is_connected (s) &&
731         GNUNET_TRANSPORT_is_connected (n->state) )
732   {
733     GNUNET_STATISTICS_set (GST_stats,
734                            gettext_noop ("# peers connected"),
735                            --neighbours_connected,
736                            GNUNET_NO);
737     neighbours_disconnect_notification (&n->id);
738   }
739   n->state = s;
740   if ( (timeout.abs_value_us < n->timeout.abs_value_us) &&
741        (NULL != n->task ) )
742   {
743     /* new timeout is earlier, reschedule master task */
744     GNUNET_SCHEDULER_cancel (n->task);
745     n->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (timeout),
746                                             &master_task,
747                                             n);
748   }
749   n->timeout = timeout;
750   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
751               "Neighbour `%s' changed state to %s with timeout %s\n",
752               GNUNET_i2s (&n->id),
753               GNUNET_TRANSPORT_ps2s(s),
754               GNUNET_STRINGS_absolute_time_to_string (timeout));
755   neighbours_changed_notification (&n->id,
756                                    n->primary_address.address,
757                                    n->state,
758                                    n->timeout,
759                                    n->primary_address.bandwidth_in,
760                                    n->primary_address.bandwidth_out);
761 }
762
763
764 /**
765  * Initialize the alternative address of a neighbour
766  *
767  * @param n the neighbour
768  * @param address address of the other peer, NULL if other peer
769  *                       connected to us
770  * @param session session to use (or NULL, in which case an
771  *        address must be setup)
772  * @param bandwidth_in inbound quota to be used when connection is up
773  * @param bandwidth_out outbound quota to be used when connection is up
774  */
775 static void
776 set_alternative_address (struct NeighbourMapEntry *n,
777                          const struct GNUNET_HELLO_Address *address,
778                          struct Session *session,
779                          struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
780                          struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
781 {
782   struct GNUNET_TRANSPORT_PluginFunctions *papi;
783
784   if (NULL == (papi = GST_plugins_find (address->transport_name)))
785   {
786     GNUNET_break (0);
787     return;
788   }
789   if (session == n->alternative_address.session)
790   {
791     n->alternative_address.bandwidth_in = bandwidth_in;
792     n->alternative_address.bandwidth_out = bandwidth_out;
793     return;
794   }
795   if (NULL != n->alternative_address.address)
796   {
797     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
798                 "Replacing existing alternative address with another one\n");
799     free_address (&n->alternative_address);
800   }
801   if (NULL == session)
802     session = papi->get_session (papi->cls,
803                                  address);
804   if (NULL == session)
805   {
806     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
807                 "Failed to obtain new session for peer `%s' and  address '%s'\n",
808                 GNUNET_i2s (&address->peer),
809                 GST_plugins_a2s (address));
810     GNUNET_STATISTICS_update (GST_stats,
811                               gettext_noop ("# session creation failed"),
812                               1,
813                               GNUNET_NO);
814     return;
815   }
816   GST_ats_new_session (address,
817                        session);
818   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
819               "Neighbour `%s' configured alternative address %s\n",
820               GNUNET_i2s (&n->id),
821               GST_plugins_a2s(address));
822
823   n->alternative_address.address = GNUNET_HELLO_address_copy (address);
824   n->alternative_address.bandwidth_in = bandwidth_in;
825   n->alternative_address.bandwidth_out = bandwidth_out;
826   n->alternative_address.session = session;
827   n->alternative_address.ats_active = GNUNET_NO;
828   n->alternative_address.keep_alive_nonce = 0;
829 }
830
831
832 /**
833  * Initialize the primary address of a neighbour
834  *
835  * @param n the neighbour
836  * @param address address of the other peer, NULL if other peer
837  *                       connected to us
838  * @param session session to use (or NULL, in which case an
839  *        address must be setup)
840  * @param bandwidth_in inbound quota to be used when connection is up
841  * @param bandwidth_out outbound quota to be used when connection is up
842  */
843 static void
844 set_primary_address (struct NeighbourMapEntry *n,
845                      const struct GNUNET_HELLO_Address *address,
846                      struct Session *session,
847                      struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
848                      struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
849 {
850   if (session == n->primary_address.session)
851   {
852     GST_validation_set_address_use (n->primary_address.address,
853                                     GNUNET_YES);
854     if (n->primary_address.bandwidth_in.value__ != bandwidth_in.value__)
855     {
856       n->primary_address.bandwidth_in = bandwidth_in;
857       GST_neighbours_set_incoming_quota (&address->peer,
858                                          bandwidth_in);
859     }
860     if (n->primary_address.bandwidth_out.value__ != bandwidth_out.value__)
861     {
862       n->primary_address.bandwidth_out = bandwidth_out;
863       send_outbound_quota (&address->peer,
864                            bandwidth_out);
865     }
866     return;
867   }
868   if ( (NULL != n->primary_address.address) &&
869        (0 == GNUNET_HELLO_address_cmp (address,
870                                        n->primary_address.address)) )
871   {
872     GNUNET_break (0);
873     return;
874   }
875   if (NULL == session)
876   {
877     GNUNET_break (0);
878     GST_ats_block_address (address,
879                            session);
880     return;
881   }
882   if (NULL != n->primary_address.address)
883   {
884     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
885                 "Replacing existing primary address with another one\n");
886     free_address (&n->primary_address);
887   }
888   n->primary_address.address = GNUNET_HELLO_address_copy (address);
889   n->primary_address.bandwidth_in = bandwidth_in;
890   n->primary_address.bandwidth_out = bandwidth_out;
891   n->primary_address.session = session;
892   n->primary_address.keep_alive_nonce = 0;
893   /* subsystems about address use */
894   GST_validation_set_address_use (n->primary_address.address,
895                                   GNUNET_YES);
896   GST_neighbours_set_incoming_quota (&address->peer,
897                                      bandwidth_in);
898   send_outbound_quota (&address->peer,
899                        bandwidth_out);
900   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
901               "Neighbour `%s' switched to address `%s'\n",
902               GNUNET_i2s (&n->id),
903               GST_plugins_a2s(address));
904
905   neighbours_changed_notification (&n->id,
906                                    n->primary_address.address,
907                                    n->state,
908                                    n->timeout,
909                                    n->primary_address.bandwidth_in,
910                                    n->primary_address.bandwidth_out);
911 }
912
913
914 /**
915  * Clear the primary address of a neighbour since this address is not
916  * valid anymore and notify monitoring about it
917  *
918  * @param n the neighbour
919  */
920 static void
921 unset_primary_address (struct NeighbourMapEntry *n)
922 {
923   /* Notify monitoring about change */
924   if (NULL == n->primary_address.address)
925     return;
926   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
927               "Disabling primary address\n");
928   neighbours_changed_notification (&n->id,
929                                    n->primary_address.address,
930                                    n->state,
931                                    n->timeout,
932                                    GNUNET_BANDWIDTH_value_init (0),
933                                    GNUNET_BANDWIDTH_value_init (0));
934   free_address (&n->primary_address);
935 }
936
937
938 /**
939  * Free a neighbour map entry.
940  *
941  * @param n entry to free
942  */
943 static void
944 free_neighbour (struct NeighbourMapEntry *n)
945 {
946   struct MessageQueue *mq;
947
948   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
949               "Freeing neighbour state of peer `%s'\n",
950               GNUNET_i2s (&n->id));
951   n->is_active = NULL; /* always free'd by its own continuation! */
952
953   /* fail messages currently in the queue */
954   while (NULL != (mq = n->messages_head))
955   {
956     GNUNET_CONTAINER_DLL_remove (n->messages_head,
957                                  n->messages_tail,
958                                  mq);
959     if (NULL != mq->cont)
960       mq->cont (mq->cont_cls,
961                 GNUNET_SYSERR,
962                 mq->message_buf_size,
963                 0);
964     GNUNET_free (mq);
965   }
966   /* Mark peer as disconnected */
967   set_state_and_timeout (n,
968                          GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED,
969                          GNUNET_TIME_UNIT_FOREVER_ABS);
970   /* free addresses and mark as unused */
971   unset_primary_address (n);
972
973   if (NULL != n->alternative_address.address)
974   {
975     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
976                 "Cleaning up alternative address\n");
977     free_address (&n->alternative_address);
978   }
979   GNUNET_assert (GNUNET_YES ==
980                  GNUNET_CONTAINER_multipeermap_remove (neighbours,
981                                                        &n->id, n));
982
983   /* Cancel address requests for this peer */
984   if (NULL != n->suggest_handle)
985   {
986     GNUNET_ATS_connectivity_suggest_cancel (n->suggest_handle);
987     n->suggest_handle = NULL;
988   }
989
990   /* Cancel the disconnect task */
991   if (NULL != n->delayed_disconnect_task)
992   {
993     GNUNET_SCHEDULER_cancel (n->delayed_disconnect_task);
994     n->delayed_disconnect_task = NULL;
995   }
996
997   /* Cancel the master task */
998   if (NULL != n->task)
999   {
1000     GNUNET_SCHEDULER_cancel (n->task);
1001     n->task = NULL;
1002   }
1003   /* free rest of memory */
1004   GNUNET_free (n);
1005 }
1006
1007
1008 /**
1009  * Transmit a message using the current session of the given
1010  * neighbour.
1011  *
1012  * @param n entry for the recipient
1013  * @param msgbuf buffer to transmit
1014  * @param msgbuf_size number of bytes in @a msgbuf buffer
1015  * @param priority transmission priority
1016  * @param timeout transmission timeout
1017  * @param use_keepalive_timeout #GNUNET_YES to use plugin-specific keep-alive
1018  *        timeout (@a timeout is ignored in that case), #GNUNET_NO otherwise
1019  * @param cont continuation to call when finished (can be NULL)
1020  * @param cont_cls closure for @a cont
1021  * @return timeout (copy of @a timeout or a calculated one if
1022  *         @a use_keepalive_timeout is #GNUNET_YES.
1023  */
1024 static struct GNUNET_TIME_Relative
1025 send_with_session (struct NeighbourMapEntry *n,
1026                    const void *msgbuf,
1027                    size_t msgbuf_size,
1028                    uint32_t priority,
1029                    struct GNUNET_TIME_Relative timeout,
1030                    unsigned int use_keepalive_timeout,
1031                    GNUNET_TRANSPORT_TransmitContinuation cont,
1032                    void *cont_cls)
1033 {
1034   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1035   struct GNUNET_TIME_Relative result = GNUNET_TIME_UNIT_FOREVER_REL;
1036
1037   GNUNET_assert (NULL != n->primary_address.session);
1038   if ( ((NULL == (papi = GST_plugins_find (n->primary_address.address->transport_name)) ||
1039          (-1 == papi->send (papi->cls,
1040                             n->primary_address.session,
1041                             msgbuf,
1042                             msgbuf_size,
1043                             priority,
1044                             (result = (GNUNET_NO == use_keepalive_timeout) ? timeout :
1045                              GNUNET_TIME_relative_divide (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1046                                                           papi->query_keepalive_factor (papi->cls))),
1047                             cont,
1048                             cont_cls)))) &&
1049        (NULL != cont))
1050     cont (cont_cls,
1051           &n->id,
1052           GNUNET_SYSERR,
1053           msgbuf_size,
1054           0);
1055   GST_neighbours_notify_data_sent (n->primary_address.address,
1056                                    n->primary_address.session,
1057                                    msgbuf_size);
1058   GNUNET_break (NULL != papi);
1059   return result;
1060 }
1061
1062
1063 /**
1064  * Function called when the 'DISCONNECT' message has been sent by the
1065  * plugin.  Frees the neighbour --- if the entry still exists.
1066  *
1067  * @param cls NULL
1068  * @param target identity of the neighbour that was disconnected
1069  * @param result #GNUNET_OK if the disconnect got out successfully
1070  * @param payload bytes payload
1071  * @param physical bytes on wire
1072  */
1073 static void
1074 send_disconnect_cont (void *cls,
1075                       const struct GNUNET_PeerIdentity *target,
1076                       int result,
1077                       size_t payload,
1078                       size_t physical)
1079 {
1080   struct NeighbourMapEntry *n;
1081
1082   n = lookup_neighbour (target);
1083   if (NULL == n)
1084     return; /* already gone */
1085   if (GNUNET_TRANSPORT_PS_DISCONNECT != n->state)
1086     return; /* have created a fresh entry since */
1087   if (NULL != n->task)
1088     GNUNET_SCHEDULER_cancel (n->task);
1089   n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1090 }
1091
1092
1093 /**
1094  * Transmit a DISCONNECT message to the other peer.
1095  *
1096  * @param n neighbour to send DISCONNECT message.
1097  */
1098 static void
1099 send_disconnect (struct NeighbourMapEntry *n)
1100 {
1101   struct SessionDisconnectMessage disconnect_msg;
1102
1103   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1104               "Sending DISCONNECT message to peer `%4s'\n",
1105               GNUNET_i2s (&n->id));
1106   disconnect_msg.header.size = htons (sizeof (struct SessionDisconnectMessage));
1107   disconnect_msg.header.type =
1108       htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
1109   disconnect_msg.reserved = htonl (0);
1110   disconnect_msg.purpose.size =
1111       htonl (sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
1112              sizeof (struct GNUNET_CRYPTO_EddsaPublicKey) +
1113              sizeof (struct GNUNET_TIME_AbsoluteNBO));
1114   disconnect_msg.purpose.purpose =
1115       htonl (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
1116   disconnect_msg.timestamp =
1117       GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
1118   disconnect_msg.public_key = GST_my_identity.public_key;
1119   GNUNET_assert (GNUNET_OK ==
1120                  GNUNET_CRYPTO_eddsa_sign (GST_my_private_key,
1121                                          &disconnect_msg.purpose,
1122                                          &disconnect_msg.signature));
1123
1124   (void) send_with_session (n,
1125                             &disconnect_msg,
1126                             sizeof (disconnect_msg),
1127                             UINT32_MAX,
1128                             GNUNET_TIME_UNIT_FOREVER_REL,
1129                             GNUNET_NO,
1130                             &send_disconnect_cont,
1131                             NULL);
1132   GNUNET_STATISTICS_update (GST_stats,
1133                             gettext_noop ("# DISCONNECT messages sent"),
1134                             1,
1135                             GNUNET_NO);
1136 }
1137
1138
1139 /**
1140  * Disconnect from the given neighbour, clean up the record.
1141  *
1142  * @param n neighbour to disconnect from
1143  */
1144 static void
1145 disconnect_neighbour (struct NeighbourMapEntry *n)
1146 {
1147   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1148               "Disconnecting from peer %s in state %s\n",
1149               GNUNET_i2s (&n->id),
1150               GNUNET_TRANSPORT_ps2s (n->state));
1151   /* depending on state, notify neighbour and/or upper layers of this peer
1152      about disconnect */
1153   switch (n->state)
1154   {
1155   case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
1156   case GNUNET_TRANSPORT_PS_INIT_ATS:
1157     /* other peer is completely unaware of us, no need to send DISCONNECT */
1158     free_neighbour (n);
1159     return;
1160   case GNUNET_TRANSPORT_PS_SYN_SENT:
1161     send_disconnect (n);
1162     set_state_and_timeout (n,
1163                            GNUNET_TRANSPORT_PS_DISCONNECT,
1164                            GNUNET_TIME_UNIT_FOREVER_ABS);
1165     break;
1166   case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
1167     /* we never ACK'ed the other peer's request, no need to send DISCONNECT */
1168     free_neighbour (n);
1169     return;
1170   case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
1171     /* we DID ACK the other peer's request, must send DISCONNECT */
1172     send_disconnect (n);
1173     set_state_and_timeout (n,
1174                            GNUNET_TRANSPORT_PS_DISCONNECT,
1175                            GNUNET_TIME_UNIT_FOREVER_ABS);
1176     break;
1177   case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
1178   case GNUNET_TRANSPORT_PS_CONNECTED:
1179   case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
1180     /* we are currently connected, need to send disconnect and do
1181        internal notifications and update statistics */
1182     send_disconnect (n);
1183     set_state_and_timeout (n,
1184                            GNUNET_TRANSPORT_PS_DISCONNECT,
1185                            GNUNET_TIME_UNIT_FOREVER_ABS);
1186     break;
1187   case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
1188     /* Disconnecting while waiting for an ATS address to reconnect,
1189      * cannot send DISCONNECT */
1190     free_neighbour (n);
1191     return;
1192   case GNUNET_TRANSPORT_PS_DISCONNECT:
1193     /* already disconnected, ignore */
1194     break;
1195   case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
1196     /* already cleaned up, how did we get here!? */
1197     GNUNET_assert (0);
1198     break;
1199   default:
1200     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1201                 "Unhandled state `%s'\n",
1202                 GNUNET_TRANSPORT_ps2s (n->state));
1203     GNUNET_break (0);
1204     break;
1205   }
1206   /* schedule timeout to clean up */
1207   if (NULL != n->task)
1208     GNUNET_SCHEDULER_cancel (n->task);
1209   n->task = GNUNET_SCHEDULER_add_delayed (DISCONNECT_SENT_TIMEOUT,
1210                                           &master_task,
1211                                           n);
1212 }
1213
1214
1215 /**
1216  * We're done with our transmission attempt, continue processing.
1217  *
1218  * @param cls the `struct MessageQueue` of the message
1219  * @param receiver intended receiver
1220  * @param success whether it worked or not
1221  * @param size_payload bytes payload sent
1222  * @param physical bytes sent on wire
1223  */
1224 static void
1225 transmit_send_continuation (void *cls,
1226                             const struct GNUNET_PeerIdentity *receiver,
1227                             int success, size_t size_payload, size_t physical)
1228 {
1229   struct MessageQueue *mq = cls;
1230   struct NeighbourMapEntry *n;
1231
1232   if (NULL == (n = lookup_neighbour (receiver)))
1233   {
1234     GNUNET_free (mq);
1235     return; /* disconnect or other error while transmitting, can happen */
1236   }
1237   if (n->is_active == mq)
1238   {
1239     /* this is still "our" neighbour, remove us from its queue
1240        and allow it to send the next message now */
1241     n->is_active = NULL;
1242     if (NULL != n->task)
1243       GNUNET_SCHEDULER_cancel (n->task);
1244     n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1245   }
1246   if (bytes_in_send_queue < mq->message_buf_size)
1247   {
1248     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1249                 "Bytes_in_send_queue `%u', Message_size %u, result: %s, payload %u, on wire %u\n",
1250                 bytes_in_send_queue,
1251                 mq->message_buf_size,
1252                 (GNUNET_OK == success) ? "OK" : "FAIL",
1253                 size_payload,
1254                 physical);
1255     GNUNET_break (0);
1256   }
1257
1258
1259   GNUNET_break (size_payload == mq->message_buf_size);
1260   bytes_in_send_queue -= mq->message_buf_size;
1261   GNUNET_STATISTICS_set (GST_stats,
1262                         gettext_noop
1263                          ("# bytes in message queue for other peers"),
1264                          bytes_in_send_queue, GNUNET_NO);
1265   if (GNUNET_OK == success)
1266     GNUNET_STATISTICS_update (GST_stats,
1267                               gettext_noop
1268                               ("# messages transmitted to other peers"),
1269                               1, GNUNET_NO);
1270   else
1271     GNUNET_STATISTICS_update (GST_stats,
1272                               gettext_noop
1273                               ("# transmission failures for messages to other peers"),
1274                               1, GNUNET_NO);
1275   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1276               "Sending message to `%s' of type %u with %u bytes was a %s\n",
1277               GNUNET_i2s (receiver),
1278               ntohs (((struct GNUNET_MessageHeader *) mq->message_buf)->type),
1279               mq->message_buf_size,
1280               (success == GNUNET_OK) ? "success" : "FAILURE");
1281   if (NULL != mq->cont)
1282     mq->cont (mq->cont_cls, success, size_payload, physical);
1283   GNUNET_free (mq);
1284 }
1285
1286
1287 /**
1288  * Check the message list for the given neighbour and if we can
1289  * send a message, do so.  This function should only be called
1290  * if the connection is at least generally ready for transmission.
1291  * While we will only send one message at a time, no bandwidth
1292  * quota management is performed here.  If a message was given to
1293  * the plugin, the continuation will automatically re-schedule
1294  * the 'master' task once the next message might be transmitted.
1295  *
1296  * @param n target peer for which to transmit
1297  */
1298 static void
1299 try_transmission_to_peer (struct NeighbourMapEntry *n)
1300 {
1301   struct MessageQueue *mq;
1302   struct GNUNET_TIME_Relative timeout;
1303
1304   if (NULL == n->primary_address.address)
1305   {
1306     /* no address, why are we here? */
1307     GNUNET_break (0);
1308     return;
1309   }
1310   if ((0 == n->primary_address.address->address_length) &&
1311       (NULL == n->primary_address.session))
1312   {
1313     /* no address, why are we here? */
1314     GNUNET_break (0);
1315     return;
1316   }
1317   if (NULL != n->is_active)
1318   {
1319     /* transmission already pending */
1320     return;
1321   }
1322
1323   /* timeout messages from the queue that are past their due date */
1324   while (NULL != (mq = n->messages_head))
1325   {
1326     timeout = GNUNET_TIME_absolute_get_remaining (mq->timeout);
1327     if (timeout.rel_value_us > 0)
1328       break;
1329     GNUNET_STATISTICS_update (GST_stats,
1330                               gettext_noop
1331                               ("# messages timed out while in transport queue"),
1332                               1, GNUNET_NO);
1333     GNUNET_CONTAINER_DLL_remove (n->messages_head,
1334                                  n->messages_tail,
1335                                  mq);
1336     n->is_active = mq;
1337     transmit_send_continuation (mq,
1338                                 &n->id,
1339                                 GNUNET_SYSERR,
1340                                 mq->message_buf_size,
1341                                 0);     /* timeout */
1342   }
1343   if (NULL == mq)
1344     return;                     /* no more messages */
1345   GNUNET_CONTAINER_DLL_remove (n->messages_head,
1346                                n->messages_tail,
1347                                mq);
1348   n->is_active = mq;
1349
1350   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1351               "Giving message with %u bytes to plugin session %p\n",
1352               mq->message_buf_size,
1353               n->primary_address.session);
1354   (void) send_with_session (n,
1355                             mq->message_buf,
1356                             mq->message_buf_size,
1357                             0 /* priority */,
1358                             timeout,
1359                             GNUNET_NO,
1360                             &transmit_send_continuation,
1361                             mq);
1362 }
1363
1364
1365 /**
1366  * Send keepalive message to the neighbour.  Must only be called
1367  * if we are on 'connected' state or while trying to switch addresses.
1368  * Will internally determine if a keepalive is truly needed (so can
1369  * always be called).
1370  *
1371  * @param n neighbour that went idle and needs a keepalive
1372  */
1373 static void
1374 send_keepalive (struct NeighbourMapEntry *n)
1375 {
1376   struct SessionKeepAliveMessage m;
1377   struct GNUNET_TIME_Relative timeout;
1378   uint32_t nonce;
1379
1380   GNUNET_assert ((GNUNET_TRANSPORT_PS_CONNECTED == n->state) ||
1381                  (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT == n->state));
1382   if (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time).rel_value_us > 0)
1383     return; /* no keepalive needed at this time */
1384
1385   nonce = 0; /* 0 indicates 'not set' */
1386   while (0 == nonce)
1387     nonce = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE, UINT32_MAX);
1388
1389   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1390               "Sending keep alive to peer `%s' with nonce %u\n",
1391               GNUNET_i2s (&n->id),
1392               nonce);
1393   m.header.size = htons (sizeof (struct SessionKeepAliveMessage));
1394   m.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE);
1395   m.nonce = htonl (nonce);
1396
1397   timeout = send_with_session (n,
1398                                &m,
1399                                sizeof (m),
1400                                UINT32_MAX /* priority */,
1401                                GNUNET_TIME_UNIT_FOREVER_REL,
1402                                GNUNET_YES,
1403                                NULL, NULL);
1404   GNUNET_STATISTICS_update (GST_stats,
1405                             gettext_noop ("# KEEPALIVES sent"),
1406                             1,
1407                             GNUNET_NO);
1408   n->primary_address.keep_alive_nonce = nonce;
1409   n->expect_latency_response = GNUNET_YES;
1410   n->last_keep_alive_time = GNUNET_TIME_absolute_get ();
1411   n->keep_alive_time = GNUNET_TIME_relative_to_absolute (timeout);
1412 }
1413
1414
1415 /**
1416  * Keep the connection to the given neighbour alive longer,
1417  * we received a KEEPALIVE (or equivalent); send a response.
1418  *
1419  * @param neighbour neighbour to keep alive (by sending keep alive response)
1420  * @param m the keep alive message containing the nonce to respond to
1421  */
1422 void
1423 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour,
1424                           const struct GNUNET_MessageHeader *m)
1425 {
1426   struct NeighbourMapEntry *n;
1427   const struct SessionKeepAliveMessage *msg_in;
1428   struct SessionKeepAliveMessage msg;
1429
1430   if (sizeof (struct SessionKeepAliveMessage) != ntohs (m->size))
1431   {
1432     GNUNET_break_op (0);
1433     return;
1434   }
1435
1436   msg_in = (const struct SessionKeepAliveMessage *) m;
1437   if (NULL == (n = lookup_neighbour (neighbour)))
1438   {
1439     GNUNET_STATISTICS_update (GST_stats,
1440                               gettext_noop
1441                               ("# KEEPALIVE messages discarded (peer unknown)"),
1442                               1, GNUNET_NO);
1443     return;
1444   }
1445   if (NULL == n->primary_address.session)
1446   {
1447     GNUNET_STATISTICS_update (GST_stats,
1448                               gettext_noop
1449                               ("# KEEPALIVE messages discarded (no session)"),
1450                               1, GNUNET_NO);
1451     return;
1452   }
1453
1454   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1455               "Received KEEPALIVE request from peer `%s' with nonce %u\n",
1456               GNUNET_i2s (&n->id),
1457               ntohl (msg_in->nonce));
1458
1459   /* send reply to allow neighbour to measure latency */
1460   msg.header.size = htons (sizeof (struct SessionKeepAliveMessage));
1461   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE);
1462   msg.nonce = msg_in->nonce;
1463   (void) send_with_session (n,
1464                             &msg,
1465                             sizeof (struct SessionKeepAliveMessage),
1466                             UINT32_MAX /* priority */,
1467                             GNUNET_TIME_UNIT_FOREVER_REL,
1468                             GNUNET_YES,
1469                             NULL, NULL);
1470 }
1471
1472
1473 /**
1474  * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
1475  * latency to this peer.  Pass the updated information (existing ats
1476  * plus calculated latency) to ATS.
1477  *
1478  * @param neighbour neighbour to keep alive
1479  * @param m the message containing the keep alive response
1480  */
1481 void
1482 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
1483                                    const struct GNUNET_MessageHeader *m)
1484 {
1485   struct NeighbourMapEntry *n;
1486   const struct SessionKeepAliveMessage *msg;
1487   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1488   struct GNUNET_TIME_Relative latency;
1489
1490   if (sizeof (struct SessionKeepAliveMessage) != ntohs (m->size))
1491   {
1492     GNUNET_break_op (0);
1493     return;
1494   }
1495
1496   msg = (const struct SessionKeepAliveMessage *) m;
1497   if (NULL == (n = lookup_neighbour (neighbour)))
1498   {
1499     GNUNET_STATISTICS_update (GST_stats,
1500                               gettext_noop ("# KEEPALIVE_RESPONSE messages discarded (not connected)"),
1501                               1,
1502                               GNUNET_NO);
1503     return;
1504   }
1505   if ( (GNUNET_TRANSPORT_PS_CONNECTED != n->state) ||
1506        (GNUNET_YES != n->expect_latency_response) )
1507   {
1508     GNUNET_STATISTICS_update (GST_stats,
1509                               gettext_noop ("# KEEPALIVE_RESPONSE messages discarded (not expected)"),
1510                               1,
1511                               GNUNET_NO);
1512     return;
1513   }
1514   if (NULL == n->primary_address.address)
1515   {
1516     GNUNET_STATISTICS_update (GST_stats,
1517                               gettext_noop ("# KEEPALIVE_RESPONSE messages discarded (address changed)"),
1518                               1,
1519                               GNUNET_NO);
1520     return;
1521   }
1522   if (n->primary_address.keep_alive_nonce != ntohl (msg->nonce))
1523   {
1524     GNUNET_STATISTICS_update (GST_stats,
1525                               gettext_noop ("# KEEPALIVE_RESPONSE messages discarded (wrong nonce)"),
1526                               1,
1527                               GNUNET_NO);
1528     return;
1529   }
1530   GNUNET_STATISTICS_update (GST_stats,
1531                             gettext_noop ("# KEEPALIVE_RESPONSE messages received in good order"),
1532                             1,
1533                             GNUNET_NO);
1534
1535
1536   /* Update session timeout here */
1537   if (NULL != (papi = GST_plugins_find (n->primary_address.address->transport_name)))
1538   {
1539     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1540                 "Updating session for peer `%s' for session %p\n",
1541                 GNUNET_i2s (&n->id),
1542                 n->primary_address.session);
1543     papi->update_session_timeout (papi->cls,
1544                                   &n->id,
1545                                   n->primary_address.session);
1546   }
1547   else
1548   {
1549     GNUNET_break (0);
1550   }
1551
1552   n->primary_address.keep_alive_nonce = 0;
1553   n->expect_latency_response = GNUNET_NO;
1554   set_state_and_timeout (n,
1555                          n->state,
1556                          GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
1557
1558   latency = GNUNET_TIME_absolute_get_duration (n->last_keep_alive_time);
1559   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1560               "Received KEEPALIVE_RESPONSE from peer `%s', latency is %s\n",
1561               GNUNET_i2s (&n->id),
1562               GNUNET_STRINGS_relative_time_to_string (latency,
1563                                                       GNUNET_YES));
1564   GST_ats_update_delay (n->primary_address.address,
1565                         GNUNET_TIME_relative_divide (latency,
1566                                                      2));
1567 }
1568
1569
1570 /**
1571  * We have received a message from the given sender.  How long should
1572  * we delay before receiving more?  (Also used to keep the peer marked
1573  * as live).
1574  *
1575  * @param sender sender of the message
1576  * @param size size of the message
1577  * @param do_forward set to #GNUNET_YES if the message should be forwarded to clients
1578  *                   #GNUNET_NO if the neighbour is not connected or violates the quota,
1579  *                   #GNUNET_SYSERR if the connection is not fully up yet
1580  * @return how long to wait before reading more from this sender
1581  */
1582 struct GNUNET_TIME_Relative
1583 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity *sender,
1584                                         ssize_t size,
1585                                         int *do_forward)
1586 {
1587   struct NeighbourMapEntry *n;
1588   struct GNUNET_TIME_Relative ret;
1589
1590   if (NULL == neighbours)
1591   {
1592     *do_forward = GNUNET_NO;
1593     return GNUNET_TIME_UNIT_FOREVER_REL; /* This can happen during shutdown */
1594   }
1595   if (NULL == (n = lookup_neighbour (sender)))
1596   {
1597     GST_neighbours_try_connect (sender);
1598     if (NULL == (n = lookup_neighbour (sender)))
1599     {
1600       GNUNET_STATISTICS_update (GST_stats,
1601                                 gettext_noop
1602                                 ("# messages discarded due to lack of neighbour record"),
1603                                 1, GNUNET_NO);
1604       *do_forward = GNUNET_NO;
1605       return GNUNET_TIME_UNIT_ZERO;
1606     }
1607   }
1608   if (! test_connected (n))
1609   {
1610     *do_forward = GNUNET_SYSERR;
1611     return GNUNET_TIME_UNIT_ZERO;
1612   }
1613   if (GNUNET_YES == GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, size))
1614   {
1615     n->quota_violation_count++;
1616     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1617                 "Bandwidth quota (%u b/s) violation detected (total of %u).\n",
1618                 n->in_tracker.available_bytes_per_s__,
1619                 n->quota_violation_count);
1620     /* Discount 32k per violation */
1621     GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, -32 * 1024);
1622   }
1623   else
1624   {
1625     if (n->quota_violation_count > 0)
1626     {
1627       /* try to add 32k back */
1628       GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, 32 * 1024);
1629       n->quota_violation_count--;
1630     }
1631   }
1632   if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
1633   {
1634     GNUNET_STATISTICS_update (GST_stats,
1635                               gettext_noop
1636                               ("# bandwidth quota violations by other peers"),
1637                               1, GNUNET_NO);
1638     *do_forward = GNUNET_NO;
1639     return GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT;
1640   }
1641   *do_forward = GNUNET_YES;
1642   ret = GNUNET_BANDWIDTH_tracker_get_delay (&n->in_tracker, 32 * 1024);
1643   if (ret.rel_value_us > 0)
1644   {
1645     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1646                 "Throttling read (%lld bytes excess at %u b/s), waiting %s before reading more.\n",
1647                 (long long) n->in_tracker.consumption_since_last_update__,
1648                 (unsigned int) n->in_tracker.available_bytes_per_s__,
1649                 GNUNET_STRINGS_relative_time_to_string (ret, GNUNET_YES));
1650     GNUNET_STATISTICS_update (GST_stats,
1651                               gettext_noop ("# ms throttling suggested"),
1652                               (int64_t) ret.rel_value_us / 1000LL,
1653                               GNUNET_NO);
1654   }
1655   return ret;
1656 }
1657
1658
1659 /**
1660  * Transmit a message to the given target using the active connection.
1661  *
1662  * @param target destination
1663  * @param msg message to send
1664  * @param msg_size number of bytes in msg
1665  * @param timeout when to fail with timeout
1666  * @param cont function to call when done
1667  * @param cont_cls closure for @a cont
1668  */
1669 void
1670 GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
1671                      const void *msg,
1672                      size_t msg_size,
1673                      struct GNUNET_TIME_Relative timeout,
1674                      GST_NeighbourSendContinuation cont,
1675                      void *cont_cls)
1676 {
1677   struct NeighbourMapEntry *n;
1678   struct MessageQueue *mq;
1679
1680   /* All ove these cases should never happen; they are all API violations.
1681      But we check anyway, just to be sure. */
1682   if (NULL == (n = lookup_neighbour (target)))
1683   {
1684     GNUNET_break (0);
1685     if (NULL != cont)
1686       cont (cont_cls,
1687             GNUNET_SYSERR,
1688             msg_size,
1689             0);
1690     return;
1691   }
1692   if (GNUNET_YES != test_connected (n))
1693   {
1694     GNUNET_break (0);
1695     if (NULL != cont)
1696       cont (cont_cls,
1697             GNUNET_SYSERR,
1698             msg_size,
1699             0);
1700     return;
1701   }
1702   bytes_in_send_queue += msg_size;
1703   GNUNET_STATISTICS_set (GST_stats,
1704                          gettext_noop
1705                          ("# bytes in message queue for other peers"),
1706                          bytes_in_send_queue, GNUNET_NO);
1707   mq = GNUNET_malloc (sizeof (struct MessageQueue) + msg_size);
1708   mq->cont = cont;
1709   mq->cont_cls = cont_cls;
1710   memcpy (&mq[1], msg, msg_size);
1711   mq->message_buf = (const char *) &mq[1];
1712   mq->message_buf_size = msg_size;
1713   mq->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1714
1715   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1716               "Enqueueing %u bytes to send to peer %s\n",
1717               msg_size,
1718               GNUNET_i2s (target));
1719   GNUNET_CONTAINER_DLL_insert_tail (n->messages_head,
1720                                     n->messages_tail,
1721                                     mq);
1722   if (NULL != n->task)
1723     GNUNET_SCHEDULER_cancel (n->task);
1724   n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1725 }
1726
1727
1728 /**
1729  * Continuation called from our attempt to transmitted our
1730  * #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN to the specified @a
1731  * target.  Continue processing based on the @a result.  Specifically,
1732  * if we failed to transmit, discard the address we used.
1733  *
1734  * @param cls NULL
1735  * @param target which peer received the transmission
1736  * @param result #GNUNET_OK if sending worked
1737  * @param size_payload how many bytes of payload were sent (ignored)
1738  * @param size_on_wire how much bandwidth was consumed on the wire (ignored)
1739  */
1740 static void
1741 send_session_syn_cont (void *cls,
1742                        const struct GNUNET_PeerIdentity *target,
1743                        int result,
1744                        size_t size_payload,
1745                        size_t size_on_wire)
1746 {
1747   struct NeighbourMapEntry *n;
1748
1749   n = lookup_neighbour (target);
1750   if (NULL == n)
1751   {
1752     /* SYN continuation was called after neighbor was freed,
1753      * for example due to a time out for the state or the session
1754      * used was already terminated: nothing to do here... */
1755     return;
1756   }
1757
1758   if ( (GNUNET_TRANSPORT_PS_SYN_SENT != n->state) &&
1759        (GNUNET_TRANSPORT_PS_RECONNECT_SENT != n->state) &&
1760        (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT != n->state))
1761   {
1762     /* SYN continuation was called after neighbor changed state,
1763      * for example due to a time out for the state or the session
1764      * used was already terminated: nothing to do here... */
1765     return;
1766   }
1767   if (GNUNET_OK == result)
1768     return;
1769
1770   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1771               _("Failed to send SYN message to peer `%s'\n"),
1772               GNUNET_i2s (target));
1773   switch (n->state) {
1774   case GNUNET_TRANSPORT_PS_SYN_SENT:
1775     /* Remove address and request an additional one */
1776     unset_primary_address (n);
1777     set_state_and_timeout (n,
1778                            GNUNET_TRANSPORT_PS_INIT_ATS,
1779                            GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
1780     break;
1781   case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
1782     /* Remove address and request an additional one */
1783     unset_primary_address (n);
1784     set_state_and_timeout (n,
1785                            GNUNET_TRANSPORT_PS_RECONNECT_ATS,
1786                            GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1787     break;
1788   case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
1789     /* Remove address and request and go back to primary address */
1790     GNUNET_STATISTICS_update (GST_stats,
1791                               gettext_noop ("# Failed attempts to switch addresses (failed to send SYN CONT)"),
1792                               1,
1793                               GNUNET_NO);
1794     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1795                 "Switch failed, cleaning up alternative address\n");
1796     free_address (&n->alternative_address);
1797     set_state_and_timeout (n,
1798                            GNUNET_TRANSPORT_PS_CONNECTED,
1799                            GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1800     break;
1801   default:
1802     disconnect_neighbour (n);
1803     break;
1804   }
1805 }
1806
1807
1808 /**
1809  * Send a SYN message via the given address.
1810  *
1811  * @param na address to use
1812  */
1813 static void
1814 send_syn (struct NeighbourAddress *na)
1815 {
1816   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1817   struct TransportSynMessage connect_msg;
1818   struct NeighbourMapEntry *n;
1819
1820   GNUNET_assert (NULL != na->session);
1821   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1822               "Sending SYN message to peer `%s' at %s\n",
1823               GNUNET_i2s (&na->address->peer),
1824               GST_plugins_a2s (na->address));
1825
1826   papi = GST_plugins_find (na->address->transport_name);
1827   GNUNET_assert (NULL != papi);
1828   GNUNET_STATISTICS_update (GST_stats,
1829                             gettext_noop
1830                             ("# SYN messages sent"),
1831                             1, GNUNET_NO);
1832   na->connect_timestamp = GNUNET_TIME_absolute_get ();
1833   connect_msg.header.size = htons (sizeof (struct TransportSynMessage));
1834   connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN);
1835   connect_msg.reserved = htonl (0);
1836   connect_msg.timestamp = GNUNET_TIME_absolute_hton (na->connect_timestamp);
1837   if (-1 ==
1838       papi->send (papi->cls,
1839                   na->session,
1840                   (const char *) &connect_msg,
1841                   sizeof (struct TransportSynMessage),
1842                   UINT_MAX,
1843                   SETUP_CONNECTION_TIMEOUT,
1844                   &send_session_syn_cont, NULL))
1845   {
1846     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1847                 _("Failed to transmit SYN message to %s\n"),
1848                 GST_plugins_a2s (na->address));
1849     n = lookup_neighbour (&na->address->peer);
1850     if (NULL == n)
1851     {
1852       GNUNET_break (0);
1853       return;
1854     }
1855     switch (n->state) {
1856       case GNUNET_TRANSPORT_PS_SYN_SENT:
1857         /* Remove address and request and additional one */
1858         GNUNET_assert (na == &n->primary_address);
1859         unset_primary_address (n);
1860         set_state_and_timeout (n,
1861                                GNUNET_TRANSPORT_PS_INIT_ATS,
1862                                GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
1863         /* Hard failure to send the SYN message with this address:
1864            Destroy address and session */
1865         break;
1866       case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
1867         /* Remove address and request an additional one */
1868         GNUNET_assert (na == &n->primary_address);
1869         unset_primary_address (n);
1870         set_state_and_timeout (n,
1871                                GNUNET_TRANSPORT_PS_RECONNECT_ATS,
1872                                GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1873         break;
1874       case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
1875         GNUNET_assert (na == &n->alternative_address);
1876         GNUNET_STATISTICS_update (GST_stats,
1877                                   gettext_noop ("# Failed attempts to switch addresses (failed to send SYN)"),
1878                                   1,
1879                                   GNUNET_NO);
1880         /* Remove address and request an additional one */
1881         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1882                     "Switch failed, cleaning up alternative address\n");
1883         free_address (&n->alternative_address);
1884         set_state_and_timeout (n,
1885                                GNUNET_TRANSPORT_PS_CONNECTED,
1886                                GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1887         break;
1888       default:
1889         GNUNET_break (0);
1890         disconnect_neighbour (n);
1891         break;
1892     }
1893     return;
1894   }
1895   GST_neighbours_notify_data_sent (na->address,
1896                                    na->session,
1897                                    sizeof (struct TransportSynMessage));
1898 }
1899
1900
1901 /**
1902  * Continuation called from our attempt to transmitted our
1903  * #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN_ACK to the specified @a
1904  * target.  Continue processing based on the @a result.  Specifically,
1905  * if we failed to transmit, discard the address we used.
1906  *
1907  * @param cls NULL
1908  * @param target which peer received the transmission
1909  * @param result #GNUNET_OK if sending worked
1910  * @param size_payload how many bytes of payload were sent (ignored)
1911  * @param size_on_wire how much bandwidth was consumed on the wire (ignored)
1912  */
1913 static void
1914 send_session_syn_ack_cont (void *cls,
1915                            const struct GNUNET_PeerIdentity *target,
1916                            int result,
1917                            size_t size_payload,
1918                            size_t size_on_wire)
1919 {
1920   struct NeighbourMapEntry *n;
1921
1922   n = lookup_neighbour (target);
1923   if (NULL == n)
1924   {
1925     /* SYN_ACK continuation was called after neighbor was freed,
1926      * for example due to a time out for the state or the session
1927      * used was already terminated: nothing to do here... */
1928     return;
1929   }
1930
1931   if (GNUNET_TRANSPORT_PS_SYN_RECV_ACK != n->state)
1932   {
1933     /* SYN_ACK continuation was called after neighbor changed state,
1934      * for example due to a time out for the state or the session
1935      * used was already terminated: nothing to do here... */
1936     return;
1937   }
1938   if (GNUNET_OK == result)
1939     return;
1940
1941   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1942             _("Failed to send SYN_ACK message to peer `%s' using address `%s'\n"),
1943             GNUNET_i2s (target),
1944             GST_plugins_a2s (n->primary_address.address));
1945
1946   /* Remove address and request and additional one */
1947   /* FIXME: what if the neighbour's primary address
1948      changed in the meantime? Might want to instead
1949      pass "something" around in closure to be sure. */
1950   unset_primary_address (n);
1951   n->ack_state = ACK_SEND_SYN_ACK;
1952   set_state_and_timeout (n,
1953                          GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
1954                          GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1955 }
1956
1957
1958 /**
1959  * Send a SYN_ACK message via the given address.
1960  *
1961  * @param na address and session to use
1962  * @param timestamp timestamp to use for the ACK message
1963  * @return #GNUNET_SYSERR if sending immediately failed, #GNUNET_OK otherwise
1964  */
1965 static void
1966 send_syn_ack_message (struct NeighbourAddress *na,
1967                       struct GNUNET_TIME_Absolute timestamp)
1968 {
1969   const struct GNUNET_HELLO_Address *address = na->address;
1970   struct Session *session = na->session;
1971   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1972   struct TransportSynMessage connect_msg;
1973   struct NeighbourMapEntry *n;
1974
1975   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1976               "Sending SYN_ACK to peer `%s'\n",
1977               GNUNET_i2s (&address->peer));
1978
1979   if (NULL == (papi = GST_plugins_find (address->transport_name)))
1980   {
1981     GNUNET_break (0);
1982     return;
1983   }
1984   if (NULL == session)
1985     session = papi->get_session (papi->cls,
1986                                  address);
1987   if (NULL == session)
1988   {
1989     GNUNET_break (0);
1990     return;
1991   }
1992   GST_ats_new_session (address,
1993                        session);
1994   GNUNET_STATISTICS_update (GST_stats,
1995                             gettext_noop
1996                             ("# SYN_ACK messages sent"),
1997                             1, GNUNET_NO);
1998   connect_msg.header.size = htons (sizeof (struct TransportSynMessage));
1999   connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN_ACK);
2000   connect_msg.reserved = htonl (0);
2001   connect_msg.timestamp = GNUNET_TIME_absolute_hton (timestamp);
2002
2003   if (GNUNET_SYSERR ==
2004       papi->send (papi->cls,
2005                   session,
2006                   (const char *) &connect_msg,
2007                   sizeof (struct TransportSynMessage),
2008                   UINT_MAX,
2009                   GNUNET_TIME_UNIT_FOREVER_REL,
2010                   &send_session_syn_ack_cont, NULL))
2011   {
2012     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2013                 _("Failed to transmit SYN_ACK message to %s\n"),
2014                 GST_plugins_a2s (address));
2015
2016     n = lookup_neighbour (&address->peer);
2017     if (NULL == n)
2018     {
2019       GNUNET_break (0);
2020       return;
2021     }
2022     /* Remove address and request and additional one */
2023     unset_primary_address (n);
2024     n->ack_state = ACK_SEND_SYN_ACK;
2025     set_state_and_timeout (n,
2026                            GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
2027                            GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2028     return;
2029   }
2030 }
2031
2032
2033 /**
2034  * Function called by the bandwidth tracker for a peer whenever
2035  * the tracker's state changed such that we need to recalculate
2036  * the delay for flow control.  We calculate the latest delay
2037  * and inform the plugin (if applicable).
2038  *
2039  * @param cls the `struct NeighbourMapEntry` to update calculations for
2040  */
2041 static void
2042 inbound_bw_tracker_update (void *cls)
2043 {
2044   struct NeighbourMapEntry *n = cls;
2045   struct GNUNET_TRANSPORT_PluginFunctions *papi;
2046   struct GNUNET_TIME_Relative delay;
2047   int do_forward;
2048
2049   if (NULL == n->primary_address.address)
2050     return; /* not active, ignore */
2051   papi = GST_plugins_find (n->primary_address.address->transport_name);
2052   GNUNET_assert (NULL != papi);
2053   if (NULL == papi->update_inbound_delay)
2054     return;
2055   delay = GST_neighbours_calculate_receive_delay (&n->id,
2056                                                   0,
2057                                                   &do_forward);
2058   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2059               "New inbound delay for peer `%s' is %llu ms\n",
2060               GNUNET_i2s (&n->id),
2061               delay.rel_value_us / 1000);
2062   papi->update_inbound_delay (papi->cls,
2063                               &n->id,
2064                               n->primary_address.session,
2065                               delay);
2066 }
2067
2068
2069 /**
2070  * Create a fresh entry in the neighbour map for the given peer
2071  *
2072  * @param peer peer to create an entry for
2073  * @return new neighbour map entry
2074  */
2075 static struct NeighbourMapEntry *
2076 setup_neighbour (const struct GNUNET_PeerIdentity *peer)
2077 {
2078   struct NeighbourMapEntry *n;
2079
2080   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2081               "Creating new neighbour entry for `%s'\n",
2082               GNUNET_i2s (peer));
2083   n = GNUNET_new (struct NeighbourMapEntry);
2084   n->id = *peer;
2085   n->ack_state = ACK_UNDEFINED;
2086   n->last_util_transmission = GNUNET_TIME_absolute_get();
2087   GNUNET_BANDWIDTH_tracker_init (&n->in_tracker,
2088                                  &inbound_bw_tracker_update,
2089                                  n,
2090                                  GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
2091                                  MAX_BANDWIDTH_CARRY_S);
2092   n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
2093   set_state_and_timeout (n,
2094                          GNUNET_TRANSPORT_PS_NOT_CONNECTED,
2095                          GNUNET_TIME_UNIT_FOREVER_ABS);
2096   GNUNET_assert (GNUNET_OK ==
2097                  GNUNET_CONTAINER_multipeermap_put (neighbours,
2098                                                     &n->id, n,
2099                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2100   n->suggest_handle = GNUNET_ATS_connectivity_suggest (GST_ats_connect,
2101                                                        peer);
2102
2103   return n;
2104 }
2105
2106
2107 /**
2108  * Entry in a DLL we use to keep track of pending blacklist checks.
2109  */
2110 struct BlacklistCheckSwitchContext
2111 {
2112   /**
2113    * DLL prev pointer.
2114    */
2115   struct BlacklistCheckSwitchContext *prev;
2116
2117   /**
2118    * DLL next pointer.
2119    */
2120   struct BlacklistCheckSwitchContext *next;
2121
2122   /**
2123    * Handle to the blacklist check we are performing.
2124    */
2125   struct GST_BlacklistCheck *blc;
2126
2127   /**
2128    * Address we are asking the blacklist subsystem about.
2129    */
2130   struct GNUNET_HELLO_Address *address;
2131
2132   /**
2133    * Session we should use in conjunction with @e address, can be NULL.
2134    */
2135   struct Session *session;
2136
2137   /**
2138    * Inbound bandwidth that was assigned to @e address.
2139    */
2140   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
2141
2142   /**
2143    * Outbound bandwidth that was assigned to @e address.
2144    */
2145   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
2146 };
2147
2148
2149 /**
2150  * Black list check result for try_connect call
2151  * If connection to the peer is allowed request adddress and
2152  *
2153  * @param cls blc_ctx bl context
2154  * @param peer the peer
2155  * @param result the result
2156  */
2157 static void
2158 try_connect_bl_check_cont (void *cls,
2159                            const struct GNUNET_PeerIdentity *peer,
2160                            int result)
2161 {
2162   struct BlacklistCheckSwitchContext *blc_ctx = cls;
2163   struct NeighbourMapEntry *n;
2164
2165   GNUNET_CONTAINER_DLL_remove (pending_bc_head,
2166                                pending_bc_tail,
2167                                blc_ctx);
2168   GNUNET_free (blc_ctx);
2169   if (GNUNET_OK != result)
2170   {
2171     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2172                 _("Blacklisting disapproved to connect to peer `%s'\n"),
2173                 GNUNET_i2s (peer));
2174     return;
2175   }
2176
2177   /* Setup a new neighbour */
2178   if (NULL != lookup_neighbour(peer))
2179     return; /* The neighbor was created in the meantime while waited for BL clients */
2180
2181   n = setup_neighbour (peer);
2182
2183   /* Request address suggestions for this peer */
2184   set_state_and_timeout (n,
2185                          GNUNET_TRANSPORT_PS_INIT_ATS,
2186                          GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2187 }
2188
2189
2190 /**
2191  * Try to create a connection to the given target (eventually).
2192  *
2193  * @param target peer to try to connect to
2194  */
2195 void
2196 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target)
2197 {
2198   struct NeighbourMapEntry *n;
2199   struct GST_BlacklistCheck *blc;
2200   struct BlacklistCheckSwitchContext *blc_ctx;
2201
2202   if (NULL == neighbours)
2203   {
2204     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2205                 "Asked to connect to peer `%s' during shutdown\n",
2206                 GNUNET_i2s (target));
2207     return; /* during shutdown, do nothing */
2208   }
2209   n = lookup_neighbour (target);
2210   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2211               "Asked to connect to peer `%s' (state: %s)\n",
2212               GNUNET_i2s (target),
2213               (NULL != n) ? GNUNET_TRANSPORT_ps2s(n->state) : "NEW PEER");
2214   if (NULL != n)
2215   {
2216     switch (n->state)
2217     {
2218     case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
2219       /* this should not be possible */
2220       GNUNET_break (0);
2221       free_neighbour (n);
2222       break;
2223     case GNUNET_TRANSPORT_PS_INIT_ATS:
2224     case GNUNET_TRANSPORT_PS_SYN_SENT:
2225     case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
2226     case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
2227       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2228                   "Ignoring request to try to connect to `%s', already trying!\n",
2229                   GNUNET_i2s (target));
2230       return; /* already trying */
2231     case GNUNET_TRANSPORT_PS_CONNECTED:
2232     case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
2233     case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
2234     case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
2235       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2236                   "Ignoring request to try to connect, already connected to `%s'!\n",
2237                   GNUNET_i2s (target));
2238       return; /* already connected */
2239     case GNUNET_TRANSPORT_PS_DISCONNECT:
2240       /* get rid of remains, ready to re-try immediately */
2241       free_neighbour (n);
2242       break;
2243     case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
2244       /* should not be possible */
2245       GNUNET_assert (0);
2246       return;
2247     default:
2248       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2249                   "Unhandled state `%s'\n",
2250                   GNUNET_TRANSPORT_ps2s (n->state));
2251       GNUNET_break (0);
2252       free_neighbour (n);
2253       break;
2254     }
2255   }
2256
2257   /* Do blacklist check if connecting to this peer is allowed */
2258   blc_ctx = GNUNET_new (struct BlacklistCheckSwitchContext);
2259   GNUNET_CONTAINER_DLL_insert (pending_bc_head,
2260                                pending_bc_tail,
2261                                blc_ctx);
2262
2263   if (NULL !=
2264       (blc = GST_blacklist_test_allowed (target,
2265                                          NULL,
2266                                          &try_connect_bl_check_cont,
2267                                          blc_ctx)))
2268   {
2269     blc_ctx->blc = blc;
2270   }
2271 }
2272
2273
2274 /**
2275  * We received a 'SYN' message from the other peer.
2276  * Consider switching to it.
2277  *
2278  * @param message possibly a 'struct TransportSynMessage' (check format)
2279  * @param peer identity of the peer to switch the address for
2280  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
2281  */
2282 int
2283 GST_neighbours_handle_session_syn (const struct GNUNET_MessageHeader *message,
2284                                    const struct GNUNET_PeerIdentity *peer)
2285 {
2286   const struct TransportSynMessage *scm;
2287   struct NeighbourMapEntry *n;
2288   struct GNUNET_TIME_Absolute ts;
2289
2290   if (ntohs (message->size) != sizeof (struct TransportSynMessage))
2291   {
2292     GNUNET_break_op (0);
2293     return GNUNET_SYSERR;
2294   }
2295   GNUNET_STATISTICS_update (GST_stats,
2296                             gettext_noop
2297                             ("# SYN messages received"),
2298                             1, GNUNET_NO);
2299   if (NULL == neighbours)
2300   {
2301     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2302                 _("SYN request from peer `%s' ignored due impending shutdown\n"),
2303                 GNUNET_i2s (peer));
2304     return GNUNET_OK; /* we're shutting down */
2305   }
2306   scm = (const struct TransportSynMessage *) message;
2307   GNUNET_break_op (0 == ntohl (scm->reserved));
2308   ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
2309   n = lookup_neighbour (peer);
2310   if (NULL == n)
2311   {
2312     /* This is a new neighbour and set to not connected */
2313     n = setup_neighbour (peer);
2314   }
2315
2316   /* Remember this SYN message in neighbour */
2317   n->ack_state = ACK_SEND_SYN_ACK;
2318   n->connect_ack_timestamp = ts;
2319
2320   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2321               "Received SYN for peer `%s' in state %s/%s\n",
2322               GNUNET_i2s (peer),
2323               GNUNET_TRANSPORT_ps2s (n->state),
2324               print_ack_state (n->ack_state));
2325
2326   switch (n->state)
2327   {
2328   case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
2329     /* Request an address from ATS to send SYN_ACK to this peer */
2330     set_state_and_timeout (n,
2331                            GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
2332                            GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2333     break;
2334   case GNUNET_TRANSPORT_PS_INIT_ATS:
2335     /* SYN message takes priority over us asking ATS for address:
2336      * Wait for ATS to suggest an address and send SYN_ACK */
2337     set_state_and_timeout (n,
2338                            GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
2339                            GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2340     break;
2341   case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
2342     /* We already wait for an address to send an SYN_ACK */
2343     break;
2344   case GNUNET_TRANSPORT_PS_SYN_SENT:
2345   case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
2346     /* Send ACK immediately */
2347     n->ack_state = ACK_SEND_ACK;
2348     send_syn_ack_message (&n->primary_address,
2349                           ts);
2350     break;
2351   case GNUNET_TRANSPORT_PS_CONNECTED:
2352     /* we are already connected and can thus send the ACK immediately */
2353     GNUNET_assert (NULL != n->primary_address.address);
2354     GNUNET_assert (NULL != n->primary_address.session);
2355     n->ack_state = ACK_SEND_ACK;
2356     send_syn_ack_message (&n->primary_address,
2357                           ts);
2358     break;
2359   case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
2360     /* We wait for ATS address suggestion */
2361     break;
2362   case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
2363     /* We received a SYN message while waiting for a SYN_ACK in fast
2364      * reconnect. Send SYN_ACK immediately */
2365     n->ack_state = ACK_SEND_ACK;
2366     send_syn_ack_message (&n->primary_address,
2367                           n->connect_ack_timestamp);
2368     break;
2369   case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
2370     /* We are already connected and can thus send the ACK immediately;
2371        still, it can never hurt to have an alternative address, so also
2372        tell ATS  about it */
2373     GNUNET_assert (NULL != n->primary_address.address);
2374     GNUNET_assert (NULL != n->primary_address.session);
2375     n->ack_state = ACK_SEND_ACK;
2376     send_syn_ack_message (&n->primary_address,
2377                           ts);
2378     break;
2379   case GNUNET_TRANSPORT_PS_DISCONNECT:
2380     /* Get rid of remains and re-try */
2381     free_neighbour (n);
2382     n = setup_neighbour (peer);
2383     /* Remember the SYN time stamp for ACK message */
2384     n->ack_state = ACK_SEND_SYN_ACK;
2385     n->connect_ack_timestamp = ts;
2386     /* Request an address for the peer */
2387     set_state_and_timeout (n,
2388                            GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
2389                            GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2390     break;
2391   case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
2392     /* should not be possible */
2393     GNUNET_assert (0);
2394     break;
2395   default:
2396     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2397                 "Unhandled state `%s'\n",
2398                 GNUNET_TRANSPORT_ps2s (n->state));
2399     GNUNET_break (0);
2400     return GNUNET_SYSERR;
2401   }
2402   return GNUNET_OK;
2403 }
2404
2405
2406 /**
2407  * Check if the given @a address is the same that we are already
2408  * using for the respective neighbour. If so, update the bandwidth
2409  * assignment and possibly the session and return #GNUNET_OK.
2410  * If the new address is different from what the neighbour is
2411  * using right now, return #GNUNET_NO.
2412  *
2413  * @param address address of the other peer,
2414  * @param session session to use or NULL if transport should initiate a session
2415  * @param bandwidth_in inbound quota to be used when connection is up,
2416  *      0 to disconnect from peer
2417  * @param bandwidth_out outbound quota to be used when connection is up,
2418  *      0 to disconnect from peer
2419  * @return #GNUNET_OK if we were able to just update the bandwidth and session,
2420  *         #GNUNET_NO if more extensive changes are required (address changed)
2421  */
2422 static int
2423 try_run_fast_ats_update (const struct GNUNET_HELLO_Address *address,
2424                          struct Session *session,
2425                          struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
2426                          struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
2427 {
2428   struct NeighbourMapEntry *n;
2429
2430   n = lookup_neighbour (&address->peer);
2431   if ( (NULL == n) ||
2432        (NULL == n->primary_address.address) ||
2433        (0 != GNUNET_HELLO_address_cmp (address,
2434                                        n->primary_address.address)) )
2435     return GNUNET_NO;
2436   /* We are not really switching addresses, but merely adjusting
2437      session and/or bandwidth, can do fast ATS update! */
2438   if (session != n->primary_address.session)
2439   {
2440     /* switch to a different session, but keeping same address; could
2441        happen if there is a 2nd inbound connection */
2442     n->primary_address.session = session;
2443   }
2444   n->primary_address.bandwidth_in = bandwidth_in;
2445   n->primary_address.bandwidth_out = bandwidth_out;
2446   GST_neighbours_set_incoming_quota (&address->peer,
2447                                      bandwidth_in);
2448   send_outbound_quota (&address->peer,
2449                        bandwidth_out);
2450   return GNUNET_OK;
2451 }
2452
2453
2454 /**
2455  * We've been asked to switch addresses, and just now got the result
2456  * from the blacklist check to see if this is allowed.
2457  *
2458  * @param cls the `struct BlacklistCheckSwitchContext` with
2459  *        the information about the future address
2460  * @param peer the peer we may switch addresses on
2461  * @param result #GNUNET_NO if we are not allowed to use the new
2462  *        address
2463  */
2464 static void
2465 switch_address_bl_check_cont (void *cls,
2466                               const struct GNUNET_PeerIdentity *peer,
2467                               int result)
2468 {
2469   struct BlacklistCheckSwitchContext *blc_ctx = cls;
2470   struct GNUNET_TRANSPORT_PluginFunctions *papi;
2471   struct NeighbourMapEntry *n;
2472
2473   if (result == GNUNET_NO)
2474   {
2475     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2476                 "Blacklist denied to switch to suggested address `%s' session %p for peer `%s'\n",
2477                 GST_plugins_a2s (blc_ctx->address),
2478                 blc_ctx->session,
2479                 GNUNET_i2s (&blc_ctx->address->peer));
2480     GNUNET_STATISTICS_update (GST_stats,
2481                               "# ATS suggestions ignored (blacklist denied)",
2482                               1,
2483                               GNUNET_NO);
2484     /* FIXME: tell plugin to force killing session here and now
2485        (note: _proper_ plugin API for this does not yet exist) */
2486     GST_ats_block_address (blc_ctx->address,
2487                            blc_ctx->session);
2488     goto cleanup;
2489   }
2490
2491   papi = GST_plugins_find (blc_ctx->address->transport_name);
2492   GNUNET_assert (NULL != papi);
2493
2494   if (NULL == blc_ctx->session)
2495   {
2496     /* need to create a session, ATS only gave us an address */
2497     blc_ctx->session = papi->get_session (papi->cls,
2498                                           blc_ctx->address);
2499     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2500                 "Obtained new session for peer `%s' and  address '%s': %p\n",
2501                 GNUNET_i2s (&blc_ctx->address->peer),
2502                 GST_plugins_a2s (blc_ctx->address),
2503                 blc_ctx->session);
2504     if (NULL != blc_ctx->session)
2505       GST_ats_new_session (blc_ctx->address,
2506                            blc_ctx->session);
2507   }
2508   if (NULL == blc_ctx->session)
2509   {
2510     /* session creation failed, bad!, fail! */
2511     GNUNET_STATISTICS_update (GST_stats,
2512                               "# ATS suggestions ignored (failed to create session)",
2513                               1,
2514                               GNUNET_NO);
2515     /* No session could be obtained, remove blacklist check and clean up */
2516     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2517                 "Failed to obtain new session for peer `%s' and address '%s'\n",
2518                 GNUNET_i2s (&blc_ctx->address->peer),
2519                 GST_plugins_a2s (blc_ctx->address));
2520     GST_ats_block_address (blc_ctx->address,
2521                            blc_ctx->session);
2522     goto cleanup;
2523   }
2524
2525   /* We did this check already before going into blacklist, but
2526      it is theoretically possible that the situation changed in
2527      the meantime, hence we check again here */
2528   if (GNUNET_OK ==
2529       try_run_fast_ats_update (blc_ctx->address,
2530                                blc_ctx->session,
2531                                blc_ctx->bandwidth_in,
2532                                blc_ctx->bandwidth_out))
2533     goto cleanup; /* was just a minor update, we're done */
2534
2535   /* check if we also need to setup the neighbour entry */
2536   if (NULL == (n = lookup_neighbour (peer)))
2537   {
2538     n = setup_neighbour (peer);
2539     n->state = GNUNET_TRANSPORT_PS_INIT_ATS;
2540   }
2541
2542   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2543               "Peer `%s' switches to address `%s'\n",
2544               GNUNET_i2s (&blc_ctx->address->peer),
2545               GST_plugins_a2s (blc_ctx->address));
2546
2547   switch (n->state)
2548   {
2549   case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
2550     GNUNET_break (0);
2551     GST_ats_block_address (blc_ctx->address,
2552                            blc_ctx->session);
2553     free_neighbour (n);
2554     return;
2555   case GNUNET_TRANSPORT_PS_INIT_ATS:
2556     /* We requested an address and ATS suggests one:
2557      * set primary address and send SYN message*/
2558     set_primary_address (n,
2559                          blc_ctx->address,
2560                          blc_ctx->session,
2561                          blc_ctx->bandwidth_in,
2562                          blc_ctx->bandwidth_out);
2563     if (ACK_SEND_SYN_ACK == n->ack_state)
2564     {
2565       /* Send pending SYN_ACK message */
2566       n->ack_state = ACK_SEND_ACK;
2567       send_syn_ack_message (&n->primary_address,
2568                             n->connect_ack_timestamp);
2569     }
2570     set_state_and_timeout (n,
2571                            GNUNET_TRANSPORT_PS_SYN_SENT,
2572                            GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2573     send_syn (&n->primary_address);
2574     break;
2575   case GNUNET_TRANSPORT_PS_SYN_SENT:
2576     /* ATS suggested a new address while waiting for an SYN_ACK:
2577      * Switch and send new SYN */
2578     /* ATS suggests a different address, switch again */
2579     set_primary_address (n,
2580                          blc_ctx->address,
2581                          blc_ctx->session,
2582                          blc_ctx->bandwidth_in,
2583                          blc_ctx->bandwidth_out);
2584     if (ACK_SEND_SYN_ACK == n->ack_state)
2585     {
2586       /* Send pending SYN_ACK message */
2587       n->ack_state = ACK_SEND_ACK;
2588       send_syn_ack_message (&n->primary_address,
2589                             n->connect_ack_timestamp);
2590     }
2591     set_state_and_timeout (n,
2592                            GNUNET_TRANSPORT_PS_SYN_SENT,
2593                            GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2594     send_syn (&n->primary_address);
2595     break;
2596   case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
2597     /* We requested an address and ATS suggests one:
2598      * set primary address and send SYN_ACK message*/
2599     set_primary_address (n,
2600                          blc_ctx->address,
2601                          blc_ctx->session,
2602                          blc_ctx->bandwidth_in,
2603                          blc_ctx->bandwidth_out);
2604     /* Send an ACK message as a response to the SYN msg */
2605     set_state_and_timeout (n,
2606                            GNUNET_TRANSPORT_PS_SYN_RECV_ACK,
2607                            GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2608     send_syn_ack_message (&n->primary_address,
2609                           n->connect_ack_timestamp);
2610     if ( (ACK_SEND_SYN_ACK == n->ack_state) ||
2611          (ACK_UNDEFINED == n->ack_state) )
2612       n->ack_state = ACK_SEND_ACK;
2613     break;
2614   case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
2615     /* ATS asks us to switch while we were trying to connect; switch to new
2616        address and check blacklist again */
2617     if ( (ACK_SEND_SYN_ACK == n->ack_state) )
2618     {
2619       n->ack_state = ACK_SEND_ACK;
2620       send_syn_ack_message (&n->primary_address,
2621                             n->connect_ack_timestamp);
2622     }
2623     set_primary_address (n,
2624                          blc_ctx->address,
2625                          blc_ctx->session,
2626                          blc_ctx->bandwidth_in,
2627                          blc_ctx->bandwidth_out);
2628     set_state_and_timeout (n,
2629                            GNUNET_TRANSPORT_PS_SYN_RECV_ACK,
2630                            GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2631     break;
2632   case GNUNET_TRANSPORT_PS_CONNECTED:
2633     GNUNET_assert (NULL != n->primary_address.address);
2634     GNUNET_assert (NULL != n->primary_address.session);
2635     GNUNET_break (n->primary_address.session != blc_ctx->session);
2636     /* ATS asks us to switch a life connection; see if we can get
2637        a SYN_ACK on it before we actually do this! */
2638     set_alternative_address (n,
2639                              blc_ctx->address,
2640                              blc_ctx->session,
2641                              blc_ctx->bandwidth_in,
2642                              blc_ctx->bandwidth_out);
2643     set_state_and_timeout (n,
2644                            GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT,
2645                            GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2646     GNUNET_STATISTICS_update (GST_stats,
2647                               gettext_noop ("# Attempts to switch addresses"),
2648                               1,
2649                               GNUNET_NO);
2650     send_syn (&n->alternative_address);
2651     break;
2652   case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
2653     set_primary_address (n,
2654                          blc_ctx->address,
2655                          blc_ctx->session,
2656                          blc_ctx->bandwidth_in,
2657                          blc_ctx->bandwidth_out);
2658     if (ACK_SEND_SYN_ACK == n->ack_state)
2659     {
2660       /* Send pending SYN_ACK message */
2661       n->ack_state = ACK_SEND_ACK;
2662       send_syn_ack_message (&n->primary_address,
2663                             n->connect_ack_timestamp);
2664     }
2665     set_state_and_timeout (n,
2666                            GNUNET_TRANSPORT_PS_RECONNECT_SENT,
2667                            GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
2668     send_syn (&n->primary_address);
2669     break;
2670   case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
2671     /* ATS asks us to switch while we were trying to reconnect; switch to new
2672        address and send SYN again */
2673     set_primary_address (n,
2674                          blc_ctx->address,
2675                          blc_ctx->session,
2676                          blc_ctx->bandwidth_in,
2677                          blc_ctx->bandwidth_out);
2678     set_state_and_timeout (n,
2679                            GNUNET_TRANSPORT_PS_RECONNECT_SENT,
2680                            GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
2681     send_syn (&n->primary_address);
2682     break;
2683   case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
2684     if ( (0 == GNUNET_HELLO_address_cmp (n->primary_address.address,
2685                                          blc_ctx->address)) &&
2686          (n->primary_address.session == blc_ctx->session) )
2687     {
2688       /* ATS switches back to still-active session */
2689       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2690                   "ATS double-switched, cleaning up alternative address\n");
2691       free_address (&n->alternative_address);
2692       set_state_and_timeout (n,
2693                              GNUNET_TRANSPORT_PS_CONNECTED,
2694                              n->timeout);
2695       break;
2696     }
2697     /* ATS asks us to switch a life connection, send */
2698     set_alternative_address (n,
2699                              blc_ctx->address,
2700                              blc_ctx->session,
2701                              blc_ctx->bandwidth_in,
2702                              blc_ctx->bandwidth_out);
2703     set_state_and_timeout (n,
2704                            GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT,
2705                            GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2706     send_syn (&n->alternative_address);
2707     break;
2708   case GNUNET_TRANSPORT_PS_DISCONNECT:
2709     /* not going to switch addresses while disconnecting */
2710     GNUNET_STATISTICS_update (GST_stats,
2711                               "# ATS suggestion ignored (disconnecting)",
2712                               1,
2713                               GNUNET_NO);
2714     return;
2715   case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
2716     GNUNET_assert (0);
2717     break;
2718   default:
2719     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2720                 "Unhandled state `%s'\n",
2721                 GNUNET_TRANSPORT_ps2s (n->state));
2722     GNUNET_break (0);
2723     break;
2724   }
2725  cleanup:
2726   GNUNET_CONTAINER_DLL_remove (pending_bc_head,
2727                                pending_bc_tail,
2728                                blc_ctx);
2729   GNUNET_HELLO_address_free (blc_ctx->address);
2730   GNUNET_free (blc_ctx);
2731 }
2732
2733
2734 /**
2735  * For the given peer, switch to this address.
2736  *
2737  * Before accepting this addresses and actively using it, a blacklist check
2738  * is performed.
2739  *
2740  * If any check fails or the suggestion can somehow not be followed, we
2741  * MUST call #GST_ats_block_address() to tell ATS that the suggestion
2742  * could not be satisfied and force ATS to do something else.
2743  *
2744  * @param address address of the other peer,
2745  * @param session session to use or NULL if transport should initiate a session
2746  * @param bandwidth_in inbound quota to be used when connection is up,
2747  *      0 to disconnect from peer
2748  * @param bandwidth_out outbound quota to be used when connection is up,
2749  *      0 to disconnect from peer
2750  */
2751 void
2752 GST_neighbours_switch_to_address (const struct GNUNET_HELLO_Address *address,
2753                                   struct Session *session,
2754                                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
2755                                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
2756 {
2757   struct GST_BlacklistCheck *blc;
2758   struct BlacklistCheckSwitchContext *blc_ctx;
2759
2760   GNUNET_assert (NULL != address->transport_name);
2761   if (GNUNET_OK ==
2762       try_run_fast_ats_update (address,
2763                                session,
2764                                bandwidth_in,
2765                                bandwidth_out))
2766     return;
2767
2768   /* Check if plugin is available */
2769   if (NULL == (GST_plugins_find (address->transport_name)))
2770   {
2771     /* we don't have the plugin for this address */
2772     GNUNET_break (0);
2773     GST_ats_block_address (address,
2774                            session);
2775     return;
2776   }
2777   if ((NULL == session) &&
2778       (GNUNET_HELLO_address_check_option (address,
2779                                           GNUNET_HELLO_ADDRESS_INFO_INBOUND)))
2780   {
2781     /* This is a inbound address and we do not have a session to use! */
2782     GNUNET_break (0);
2783     GST_ats_block_address (address,
2784                            session);
2785     return;
2786   }
2787
2788   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2789               "ATS suggests address '%s' for peer `%s' at %u/%u speed\n",
2790               GST_plugins_a2s (address),
2791               GNUNET_i2s (&address->peer),
2792               (unsigned int) ntohl (bandwidth_in.value__),
2793               (unsigned int) ntohl (bandwidth_out.value__));
2794
2795   /* Perform blacklist check */
2796   blc_ctx = GNUNET_new (struct BlacklistCheckSwitchContext);
2797   blc_ctx->address = GNUNET_HELLO_address_copy (address);
2798   blc_ctx->session = session;
2799   blc_ctx->bandwidth_in = bandwidth_in;
2800   blc_ctx->bandwidth_out = bandwidth_out;
2801   GNUNET_CONTAINER_DLL_insert (pending_bc_head,
2802                                pending_bc_tail,
2803                                blc_ctx);
2804   if (NULL != (blc = GST_blacklist_test_allowed (&address->peer,
2805                                                  address->transport_name,
2806                                                  &switch_address_bl_check_cont,
2807                                                  blc_ctx)))
2808   {
2809     blc_ctx->blc = blc;
2810   }
2811 }
2812
2813
2814 /**
2815  * Function called to send network utilization data to ATS for
2816  * each active connection.
2817  *
2818  * @param cls NULL
2819  * @param key peer we send utilization data for
2820  * @param value the `struct NeighbourMapEntry *` with data to send
2821  * @return #GNUNET_OK (continue to iterate)
2822  */
2823 static int
2824 send_utilization_data (void *cls,
2825                        const struct GNUNET_PeerIdentity *key,
2826                        void *value)
2827 {
2828   struct NeighbourMapEntry *n = value;
2829   uint32_t bps_in;
2830   uint32_t bps_out;
2831   struct GNUNET_TIME_Relative delta;
2832
2833   if ( (GNUNET_YES != test_connected (n)) ||
2834        (NULL == n->primary_address.address) )
2835     return GNUNET_OK;
2836   delta = GNUNET_TIME_absolute_get_difference (n->last_util_transmission,
2837                                                GNUNET_TIME_absolute_get ());
2838   bps_in = 0;
2839   if ((0 != n->util_total_bytes_recv) && (0 != delta.rel_value_us))
2840     bps_in =  (1000LL * 1000LL *  n->util_total_bytes_recv) / (delta.rel_value_us);
2841   bps_out = 0;
2842   if ((0 != n->util_total_bytes_sent) && (0 != delta.rel_value_us))
2843     bps_out = (1000LL * 1000LL * n->util_total_bytes_sent) / delta.rel_value_us;
2844
2845   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2846               "`%s' total: received %u Bytes/s, sent %u Bytes/s\n",
2847               GNUNET_i2s (key),
2848               bps_in,
2849               bps_out);
2850   GST_ats_update_utilization (n->primary_address.address,
2851                               bps_in,
2852                               bps_out);
2853   n->util_total_bytes_recv = 0;
2854   n->util_total_bytes_sent = 0;
2855   n->last_util_transmission = GNUNET_TIME_absolute_get ();
2856   return GNUNET_OK;
2857 }
2858
2859
2860 /**
2861  * Task transmitting utilization in a regular interval
2862  *
2863  * @param cls the 'struct NeighbourMapEntry' for which we are running
2864  * @param tc scheduler context (unused)
2865  */
2866 static void
2867 utilization_transmission (void *cls,
2868                           const struct GNUNET_SCHEDULER_TaskContext *tc)
2869 {
2870   util_transmission_tk = NULL;
2871   GNUNET_CONTAINER_multipeermap_iterate (neighbours,
2872                                          &send_utilization_data,
2873                                          NULL);
2874   util_transmission_tk
2875     = GNUNET_SCHEDULER_add_delayed (UTIL_TRANSMISSION_INTERVAL,
2876                                     &utilization_transmission,
2877                                     NULL);
2878 }
2879
2880
2881 /**
2882  * Track information about data we received from the
2883  * given address (used to notify ATS about our utilization
2884  * of allocated resources).
2885  *
2886  * @param address the address we got data from
2887  * @param message the message we received (really only the size is used)
2888  */
2889 void
2890 GST_neighbours_notify_data_recv (const struct GNUNET_HELLO_Address *address,
2891                                  const struct GNUNET_MessageHeader *message)
2892 {
2893   struct NeighbourMapEntry *n;
2894
2895   n = lookup_neighbour (&address->peer);
2896   if (NULL == n)
2897     return;
2898   n->util_total_bytes_recv += ntohs (message->size);
2899 }
2900
2901
2902 /**
2903  * Track information about data we transmitted using the given @a
2904  * address and @a session (used to notify ATS about our utilization of
2905  * allocated resources).
2906  *
2907  * @param address the address we transmitted data to
2908  * @param session session we used to transmit data
2909  * @param message the message we sent (really only the size is used)
2910  */
2911 void
2912 GST_neighbours_notify_data_sent (const struct GNUNET_HELLO_Address *address,
2913                                  struct Session *session,
2914                                  size_t size)
2915 {
2916   struct NeighbourMapEntry *n;
2917
2918   n = lookup_neighbour (&address->peer);
2919   if (NULL == n)
2920       return;
2921   if (n->primary_address.session != session)
2922     return;
2923   n->util_total_bytes_sent += size;
2924 }
2925
2926
2927 /**
2928  * Master task run for every neighbour.  Performs all of the time-related
2929  * activities (keep alive, send next message, disconnect if idle, finish
2930  * clean up after disconnect).
2931  *
2932  * @param cls the 'struct NeighbourMapEntry' for which we are running
2933  * @param tc scheduler context (unused)
2934  */
2935 static void
2936 master_task (void *cls,
2937              const struct GNUNET_SCHEDULER_TaskContext *tc)
2938 {
2939   struct NeighbourMapEntry *n = cls;
2940   struct GNUNET_TIME_Relative delay;
2941
2942   n->task = NULL;
2943   delay = GNUNET_TIME_absolute_get_remaining (n->timeout);
2944   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2945               "Master task runs for neighbour `%s' in state %s with timeout in %s\n",
2946               GNUNET_i2s (&n->id),
2947               GNUNET_TRANSPORT_ps2s(n->state),
2948               GNUNET_STRINGS_relative_time_to_string (delay,
2949                                                       GNUNET_YES));
2950   switch (n->state)
2951   {
2952   case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
2953     /* invalid state for master task, clean up */
2954     GNUNET_break (0);
2955     free_neighbour (n);
2956     return;
2957   case GNUNET_TRANSPORT_PS_INIT_ATS:
2958     if (0 == delay.rel_value_us)
2959     {
2960       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2961                   "Connection to `%s' timed out waiting for ATS to provide address\n",
2962                   GNUNET_i2s (&n->id));
2963       free_neighbour (n);
2964       return;
2965     }
2966     break;
2967   case GNUNET_TRANSPORT_PS_SYN_SENT:
2968     if (0 == delay.rel_value_us)
2969     {
2970       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2971                   "Connection to `%s' timed out waiting for other peer to send SYN_ACK\n",
2972                   GNUNET_i2s (&n->id));
2973       /* Remove address and request and additional one */
2974       unset_primary_address (n);
2975       set_state_and_timeout (n,
2976                              GNUNET_TRANSPORT_PS_INIT_ATS,
2977                              GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2978       return;
2979     }
2980     break;
2981   case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
2982     if (0 == delay.rel_value_us)
2983     {
2984       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2985                   "Connection to `%s' timed out waiting ATS to provide address to use for SYN_ACK\n",
2986                   GNUNET_i2s (&n->id));
2987       free_neighbour (n);
2988       return;
2989     }
2990     break;
2991   case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
2992     if (0 == delay.rel_value_us)
2993     {
2994       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2995                   "Connection to `%s' timed out waiting for other peer to send ACK\n",
2996                   GNUNET_i2s (&n->id));
2997       disconnect_neighbour (n);
2998       return;
2999     }
3000     break;
3001   case GNUNET_TRANSPORT_PS_CONNECTED:
3002     if (0 == delay.rel_value_us)
3003     {
3004       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3005                   "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
3006                   GNUNET_i2s (&n->id));
3007       disconnect_neighbour (n);
3008       return;
3009     }
3010     try_transmission_to_peer (n);
3011     send_keepalive (n);
3012     break;
3013   case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
3014     if (0 == delay.rel_value_us)
3015     {
3016       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3017                   "Connection to `%s' timed out, waiting for ATS replacement address\n",
3018                   GNUNET_i2s (&n->id));
3019       disconnect_neighbour (n);
3020       return;
3021     }
3022     break;
3023   case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
3024     if (0 == delay.rel_value_us)
3025     {
3026       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3027                   "Connection to `%s' timed out, waiting for other peer to SYN_ACK replacement address\n",
3028                   GNUNET_i2s (&n->id));
3029       disconnect_neighbour (n);
3030       return;
3031     }
3032     break;
3033   case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
3034     if (0 == delay.rel_value_us)
3035     {
3036       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3037                   "Switch failed, cleaning up alternative address\n");
3038       free_address (&n->alternative_address);
3039       set_state_and_timeout (n,
3040                              GNUNET_TRANSPORT_PS_CONNECTED,
3041                              GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
3042     }
3043     try_transmission_to_peer (n);
3044     send_keepalive (n);
3045     break;
3046   case GNUNET_TRANSPORT_PS_DISCONNECT:
3047     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3048                 "Cleaning up connection to `%s' after sending DISCONNECT\n",
3049                 GNUNET_i2s (&n->id));
3050     free_neighbour (n);
3051     return;
3052   case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
3053     /* how did we get here!? */
3054     GNUNET_assert (0);
3055     break;
3056   default:
3057     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3058                 "Unhandled state `%s'\n",
3059                 GNUNET_TRANSPORT_ps2s (n->state));
3060     GNUNET_break (0);
3061     break;
3062   }
3063   delay = GNUNET_TIME_absolute_get_remaining (n->timeout);
3064   if ( (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT == n->state) ||
3065        (GNUNET_TRANSPORT_PS_CONNECTED == n->state) )
3066   {
3067     /* if we are *now* in one of the two states, we're sending
3068        keep alive messages, so we need to consider the keepalive
3069        delay, not just the connection timeout */
3070     delay = GNUNET_TIME_relative_min (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time),
3071                                       delay);
3072   }
3073   if (NULL == n->task)
3074     n->task = GNUNET_SCHEDULER_add_delayed (delay,
3075                                             &master_task,
3076                                             n);
3077 }
3078
3079
3080 /**
3081  * Send a ACK message to the neighbour to confirm that we
3082  * got his SYN_ACK.
3083  *
3084  * @param n neighbour to send the ACK to
3085  */
3086 static void
3087 send_session_ack_message (struct NeighbourMapEntry *n)
3088 {
3089   struct GNUNET_MessageHeader msg;
3090
3091   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3092               "Sending ACK message to peer `%s'\n",
3093               GNUNET_i2s (&n->id));
3094
3095   msg.size = htons (sizeof (struct GNUNET_MessageHeader));
3096   msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK);
3097   (void) send_with_session (n,
3098                             &msg,
3099                             sizeof (struct GNUNET_MessageHeader),
3100                             UINT32_MAX,
3101                             GNUNET_TIME_UNIT_FOREVER_REL,
3102                             GNUNET_NO,
3103                             NULL, NULL);
3104 }
3105
3106
3107 /**
3108  * We received a 'SESSION_SYN_ACK' message from the other peer.
3109  * Consider switching to it.
3110  *
3111  * @param message possibly a `struct SessionConnectMessage` (check format)
3112  * @param peer identity of the peer to switch the address for
3113  * @param address address of the other peer, NULL if other peer
3114  *                       connected to us
3115  * @param session session to use (or NULL)
3116  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
3117  */
3118 int
3119 GST_neighbours_handle_session_syn_ack (const struct GNUNET_MessageHeader *message,
3120                                        const struct GNUNET_HELLO_Address *address,
3121                                        struct Session *session)
3122 {
3123   const struct TransportSynMessage *scm;
3124   struct GNUNET_TIME_Absolute ts;
3125   struct NeighbourMapEntry *n;
3126
3127   if (ntohs (message->size) != sizeof (struct TransportSynMessage))
3128   {
3129     GNUNET_break_op (0);
3130     return GNUNET_SYSERR;
3131   }
3132   GNUNET_STATISTICS_update (GST_stats,
3133                             gettext_noop
3134                             ("# SYN_ACK messages received"),
3135                             1, GNUNET_NO);
3136   scm = (const struct TransportSynMessage *) message;
3137   GNUNET_break_op (ntohl (scm->reserved) == 0);
3138   if (NULL == (n = lookup_neighbour (&address->peer)))
3139   {
3140     GNUNET_STATISTICS_update (GST_stats,
3141                               gettext_noop
3142                               ("# unexpected SYN_ACK messages (no peer)"),
3143                               1, GNUNET_NO);
3144     return GNUNET_SYSERR;
3145   }
3146   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3147               "Received SYN_ACK message from peer `%s' in state %s/%s\n",
3148               GNUNET_i2s (&address->peer),
3149               GNUNET_TRANSPORT_ps2s (n->state),
3150               print_ack_state (n->ack_state));
3151   ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
3152   switch (n->state)
3153   {
3154   case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
3155     GNUNET_break (0);
3156     free_neighbour (n);
3157     return GNUNET_SYSERR;
3158   case GNUNET_TRANSPORT_PS_INIT_ATS:
3159     GNUNET_STATISTICS_update (GST_stats,
3160                               gettext_noop ("# unexpected SYN_ACK messages (not ready)"),
3161                               1,
3162                               GNUNET_NO);
3163     break;
3164   case GNUNET_TRANSPORT_PS_SYN_SENT:
3165     if (ts.abs_value_us != n->primary_address.connect_timestamp.abs_value_us)
3166     {
3167       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3168                   "SYN_ACK ignored as the timestamp does not match our SYN request\n");
3169       return GNUNET_OK;
3170     }
3171     set_state_and_timeout (n,
3172                            GNUNET_TRANSPORT_PS_CONNECTED,
3173                            GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
3174     set_primary_address (n,
3175                          n->primary_address.address,
3176                          n->primary_address.session,
3177                          n->primary_address.bandwidth_in,
3178                          n->primary_address.bandwidth_out);
3179     send_session_ack_message (n);
3180     break;
3181   case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
3182   case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
3183     GNUNET_STATISTICS_update (GST_stats,
3184                               gettext_noop ("# unexpected SYN_ACK messages (not ready)"),
3185                               1,
3186                               GNUNET_NO);
3187     break;
3188   case GNUNET_TRANSPORT_PS_CONNECTED:
3189     /* duplicate SYN_ACK, let's answer by duplicate ACK just in case */
3190     send_session_ack_message (n);
3191     break;
3192   case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
3193     /* we didn't expect any SYN_ACK, as we are waiting for ATS
3194        to give us a new address... */
3195     GNUNET_STATISTICS_update (GST_stats,
3196                               gettext_noop ("# unexpected SYN_ACK messages (waiting on ATS)"),
3197                               1,
3198                               GNUNET_NO);
3199     break;
3200   case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
3201     /* Reconnecting with new address address worked; go back to connected! */
3202     set_state_and_timeout (n,
3203                            GNUNET_TRANSPORT_PS_CONNECTED,
3204                            GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
3205     send_session_ack_message (n);
3206     break;
3207   case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
3208     /* new address worked; adopt it and go back to connected! */
3209     set_state_and_timeout (n,
3210                            GNUNET_TRANSPORT_PS_CONNECTED,
3211                            GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
3212     GNUNET_break (GNUNET_NO == n->alternative_address.ats_active);
3213
3214     /* Set primary addresses */
3215     set_primary_address (n,
3216                          n->alternative_address.address,
3217                          n->alternative_address.session,
3218                          n->alternative_address.bandwidth_in,
3219                          n->alternative_address.bandwidth_out);
3220     GNUNET_STATISTICS_update (GST_stats,
3221                               gettext_noop ("# Successful attempts to switch addresses"),
3222                               1,
3223                               GNUNET_NO);
3224
3225     GNUNET_HELLO_address_free (n->alternative_address.address);
3226     memset (&n->alternative_address,
3227             0,
3228             sizeof (n->alternative_address));
3229     send_session_ack_message (n);
3230     break;
3231   case GNUNET_TRANSPORT_PS_DISCONNECT:
3232     GNUNET_STATISTICS_update (GST_stats,
3233                               gettext_noop
3234                               ("# unexpected SYN_ACK messages (disconnecting)"),
3235                               1, GNUNET_NO);
3236     return GNUNET_SYSERR;
3237   case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
3238     GNUNET_assert (0);
3239     break;
3240   default:
3241     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3242                 "Unhandled state `%s'\n",
3243                 GNUNET_TRANSPORT_ps2s (n->state));
3244     GNUNET_break (0);
3245     return GNUNET_SYSERR;
3246   }
3247   return GNUNET_OK;
3248 }
3249
3250
3251 /**
3252  * A session was terminated. Take note; if needed, try to get
3253  * an alternative address from ATS.
3254  *
3255  * @param peer identity of the peer where the session died
3256  * @param session session that is gone
3257  * @return #GNUNET_YES if this was a session used, #GNUNET_NO if
3258  *        this session was not in use
3259  */
3260 int
3261 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
3262                                    struct Session *session)
3263 {
3264   struct NeighbourMapEntry *n;
3265   struct BlackListCheckContext *bcc;
3266   struct BlackListCheckContext *bcc_next;
3267
3268   /* make sure to cancel all ongoing blacklist checks involving 'session' */
3269   bcc_next = bc_head;
3270   while (NULL != (bcc = bcc_next))
3271   {
3272     bcc_next = bcc->next;
3273     if (bcc->na.session == session)
3274     {
3275       if (NULL != bcc->bc)
3276         GST_blacklist_test_cancel (bcc->bc);
3277       GNUNET_HELLO_address_free (bcc->na.address);
3278       GNUNET_CONTAINER_DLL_remove (bc_head,
3279                                    bc_tail,
3280                                    bcc);
3281       GNUNET_free (bcc);
3282     }
3283   }
3284   if (NULL == (n = lookup_neighbour (peer)))
3285     return GNUNET_NO; /* can't affect us */
3286   if (session != n->primary_address.session)
3287   {
3288     /* Free alternative address */
3289     if (session == n->alternative_address.session)
3290     {
3291       if (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT == n->state)
3292         set_state_and_timeout (n,
3293                                GNUNET_TRANSPORT_PS_CONNECTED,
3294                                n->timeout);
3295       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3296                   "Session died, cleaning up alternative address\n");
3297       free_address (&n->alternative_address);
3298     }
3299     return GNUNET_NO; /* doesn't affect us further */
3300   }
3301
3302   n->expect_latency_response = GNUNET_NO;
3303   /* The session for neighbour's primary address died */
3304   switch (n->state)
3305   {
3306   case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
3307     GNUNET_break (0);
3308     free_neighbour (n);
3309     return GNUNET_YES;
3310   case GNUNET_TRANSPORT_PS_INIT_ATS:
3311     GNUNET_break (0);
3312     free_neighbour (n);
3313     return GNUNET_YES;
3314   case GNUNET_TRANSPORT_PS_SYN_SENT:
3315     /* The session used to send the SYN terminated:
3316      * this implies a connect error*/
3317     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3318                 "Failed to send SYN in %s with `%s' %p: session terminated\n",
3319                 "CONNECT_SENT",
3320                 GST_plugins_a2s (n->primary_address.address),
3321                 n->primary_address.session,
3322                 GNUNET_i2s (peer));
3323
3324     /* Destroy the address since it cannot be used */
3325     unset_primary_address (n);
3326     set_state_and_timeout (n,
3327                            GNUNET_TRANSPORT_PS_INIT_ATS,
3328                            GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
3329     break;
3330   case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
3331   case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
3332     /* error on inbound session; free neighbour entirely */
3333     free_neighbour (n);
3334     return GNUNET_YES;
3335   case GNUNET_TRANSPORT_PS_CONNECTED:
3336     /* Our primary connection died, try a fast reconnect */
3337     unset_primary_address (n);
3338     set_state_and_timeout (n,
3339                            GNUNET_TRANSPORT_PS_RECONNECT_ATS,
3340                            GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
3341     break;
3342   case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
3343     /* we don't have an address, how can it go down? */
3344     GNUNET_break (0);
3345     break;
3346   case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
3347     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3348                 "Failed to send SYN in %s with `%s' %p: session terminated\n",
3349                 "RECONNECT_SENT",
3350                 GST_plugins_a2s (n->primary_address.address),
3351                 n->primary_address.session,
3352                 GNUNET_i2s (peer));
3353     /* Destroy the address since it cannot be used */
3354     unset_primary_address (n);
3355     set_state_and_timeout (n,
3356                            GNUNET_TRANSPORT_PS_RECONNECT_ATS,
3357                            GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
3358     break;
3359   case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
3360     /* primary went down while we were waiting for SYN_ACK on secondary;
3361        secondary as primary */
3362
3363     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3364                 "Connection `%s' %p to peer `%s' was terminated while switching, "
3365                 "switching to alternative address `%s' %p\n",
3366                 GST_plugins_a2s (n->primary_address.address),
3367                 n->primary_address.session,
3368                 GNUNET_i2s (peer),
3369                 GST_plugins_a2s (n->alternative_address.address),
3370                 n->alternative_address.session);
3371
3372     /* Destroy the inbound address since it cannot be used */
3373     free_address (&n->primary_address);
3374     n->primary_address = n->alternative_address;
3375     memset (&n->alternative_address,
3376             0,
3377             sizeof (struct NeighbourAddress));
3378     set_state_and_timeout (n,
3379                            GNUNET_TRANSPORT_PS_RECONNECT_SENT,
3380                            GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
3381     break;
3382   case GNUNET_TRANSPORT_PS_DISCONNECT:
3383     unset_primary_address (n);
3384     break;
3385   case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
3386     /* neighbour was freed and plugins told to terminate session */
3387     return GNUNET_NO;
3388   default:
3389     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3390                 "Unhandled state `%s'\n",
3391                 GNUNET_TRANSPORT_ps2s (n->state));
3392     GNUNET_break (0);
3393     break;
3394   }
3395   if (NULL != n->task)
3396     GNUNET_SCHEDULER_cancel (n->task);
3397   n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
3398   return GNUNET_YES;
3399 }
3400
3401
3402 /**
3403  * We received a 'ACK' message from the other peer.
3404  * If we sent a 'SYN_ACK' last, this means we are now
3405  * connected.  Otherwise, do nothing.
3406  *
3407  * @param message possibly a 'struct SessionConnectMessage' (check format)
3408  * @param address address of the other peer
3409  * @param session session to use (or NULL)
3410  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
3411  */
3412 int
3413 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
3414                                    const struct GNUNET_HELLO_Address *address,
3415                                    struct Session *session)
3416 {
3417   struct NeighbourMapEntry *n;
3418
3419   if (ntohs (message->size) != sizeof (struct GNUNET_MessageHeader))
3420   {
3421     GNUNET_break_op (0);
3422     return GNUNET_SYSERR;
3423   }
3424   GNUNET_STATISTICS_update (GST_stats,
3425                             gettext_noop ("# ACK messages received"),
3426                             1,
3427                             GNUNET_NO);
3428   if (NULL == (n = lookup_neighbour (&address->peer)))
3429   {
3430     GNUNET_break_op (0);
3431     return GNUNET_SYSERR;
3432   }
3433   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3434               "Received ACK for peer `%s' in state %s/%s\n",
3435               GNUNET_i2s (&address->peer),
3436               GNUNET_TRANSPORT_ps2s (n->state),
3437               print_ack_state (n->ack_state));
3438
3439   /* Check if we are in a plausible state for having sent
3440      a SYN_ACK.  If not, return, otherwise break.
3441
3442      The remote peers sends a ACK as a response for a SYN_ACK
3443      message.
3444
3445      We expect a ACK:
3446      - If a remote peer has sent a SYN, we responded with a SYN_ACK and
3447      now wait for the ACK to finally be connected
3448      - If we sent a SYN_ACK to this peer before */
3449
3450   if ( (GNUNET_TRANSPORT_PS_SYN_RECV_ACK != n->state) &&
3451        (ACK_SEND_ACK != n->ack_state))
3452   {
3453     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
3454                 "Received unexpected ACK message from peer `%s' in state %s/%s\n",
3455                 GNUNET_i2s (&address->peer),
3456                 GNUNET_TRANSPORT_ps2s (n->state),
3457                 print_ack_state (n->ack_state));
3458
3459     GNUNET_STATISTICS_update (GST_stats,
3460                               gettext_noop ("# unexpected ACK messages"), 1,
3461                               GNUNET_NO);
3462     return GNUNET_OK;
3463   }
3464   if (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT == n->state)
3465   {
3466     /* We tried to switch addresses while being connect. We explicitly wait
3467      * for a SYN_ACK before going to GNUNET_TRANSPORT_PS_CONNECTED,
3468      * so we do not want to set the address as in use! */
3469     return GNUNET_OK;
3470   }
3471   set_state_and_timeout (n,
3472                          GNUNET_TRANSPORT_PS_CONNECTED,
3473                          GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
3474
3475   /* Reset backoff for primary address  */
3476   GST_ats_block_reset (n->primary_address.address,
3477                        n->primary_address.session);
3478   return GNUNET_OK;
3479 }
3480
3481
3482 /**
3483  * Test if we're connected to the given peer.
3484  *
3485  * @param target peer to test
3486  * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
3487  */
3488 int
3489 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target)
3490 {
3491   return test_connected (lookup_neighbour (target));
3492 }
3493
3494
3495 /**
3496  * Change the incoming quota for the given peer.
3497  *
3498  * @param neighbour identity of peer to change qutoa for
3499  * @param quota new quota
3500  */
3501 void
3502 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
3503                                    struct GNUNET_BANDWIDTH_Value32NBO quota)
3504 {
3505   struct NeighbourMapEntry *n;
3506
3507   if (NULL == (n = lookup_neighbour (neighbour)))
3508   {
3509     GNUNET_STATISTICS_update (GST_stats,
3510                               gettext_noop
3511                               ("# SET QUOTA messages ignored (no such peer)"),
3512                               1, GNUNET_NO);
3513     return;
3514   }
3515   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3516               "Setting inbound quota of %u Bps for peer `%s' to all clients\n",
3517               ntohl (quota.value__), GNUNET_i2s (&n->id));
3518   GNUNET_BANDWIDTH_tracker_update_quota (&n->in_tracker, quota);
3519   if (0 != ntohl (quota.value__))
3520     return;
3521   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3522               "Disconnecting peer `%4s' due to SET_QUOTA\n",
3523               GNUNET_i2s (&n->id));
3524   if (GNUNET_YES == test_connected (n))
3525     GNUNET_STATISTICS_update (GST_stats,
3526                               gettext_noop ("# disconnects due to quota of 0"),
3527                               1, GNUNET_NO);
3528   disconnect_neighbour (n);
3529 }
3530
3531
3532 /**
3533  * Task to asynchronously run #free_neighbour().
3534  *
3535  * @param cls the `struct NeighbourMapEntry` to free
3536  * @param tc unused
3537  */
3538 static void
3539 delayed_disconnect (void *cls,
3540                     const struct GNUNET_SCHEDULER_TaskContext* tc)
3541 {
3542   struct NeighbourMapEntry *n = cls;
3543
3544   n->delayed_disconnect_task = NULL;
3545   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3546               "Disconnecting by request from peer %s\n",
3547               GNUNET_i2s (&n->id));
3548   free_neighbour (n);
3549 }
3550
3551
3552 /**
3553  * We received a disconnect message from the given peer,
3554  * validate and process.
3555  *
3556  * @param peer sender of the message
3557  * @param msg the disconnect message
3558  */
3559 void
3560 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity *peer,
3561                                           const struct GNUNET_MessageHeader *msg)
3562 {
3563   struct NeighbourMapEntry *n;
3564   const struct SessionDisconnectMessage *sdm;
3565
3566   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3567               "Received DISCONNECT message from peer `%s'\n",
3568               GNUNET_i2s (peer));
3569   if (ntohs (msg->size) != sizeof (struct SessionDisconnectMessage))
3570   {
3571     GNUNET_break_op (0);
3572     GNUNET_STATISTICS_update (GST_stats,
3573                               gettext_noop
3574                               ("# disconnect messages ignored (malformed)"), 1,
3575                               GNUNET_NO);
3576     return;
3577   }
3578   GNUNET_STATISTICS_update (GST_stats,
3579                             gettext_noop
3580                             ("# DISCONNECT messages received"),
3581                             1, GNUNET_NO);
3582   sdm = (const struct SessionDisconnectMessage *) msg;
3583   if (NULL == (n = lookup_neighbour (peer)))
3584   {
3585     /* gone already */
3586     return;
3587   }
3588   if (GNUNET_TIME_absolute_ntoh (sdm->timestamp).abs_value_us <= n->connect_ack_timestamp.abs_value_us)
3589   {
3590     GNUNET_STATISTICS_update (GST_stats,
3591                               gettext_noop ("# disconnect messages ignored (timestamp)"),
3592                               1,
3593                               GNUNET_NO);
3594     return;
3595   }
3596   if (0 != memcmp (peer,
3597                    &sdm->public_key,
3598                    sizeof (struct GNUNET_PeerIdentity)))
3599   {
3600     GNUNET_break_op (0);
3601     return;
3602   }
3603   if (ntohl (sdm->purpose.size) !=
3604       sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
3605       sizeof (struct GNUNET_CRYPTO_EddsaPublicKey) +
3606       sizeof (struct GNUNET_TIME_AbsoluteNBO))
3607   {
3608     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3609                 "DISCONNECT message from peer `%s' has invalid size\n",
3610                 GNUNET_i2s (peer));
3611     GNUNET_break_op (0);
3612     return;
3613   }
3614   if (GNUNET_OK !=
3615       GNUNET_CRYPTO_eddsa_verify (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT,
3616                                   &sdm->purpose,
3617                                   &sdm->signature,
3618                                   &sdm->public_key))
3619   {
3620     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3621                 "DISCONNECT message from peer `%s' cannot be verified \n",
3622                 GNUNET_i2s (peer));
3623     GNUNET_break_op (0);
3624     return;
3625   }
3626   n->delayed_disconnect_task = GNUNET_SCHEDULER_add_now (&delayed_disconnect, n);
3627 }
3628
3629
3630 /**
3631  * Closure for the #neighbours_iterate() function.
3632  */
3633 struct IteratorContext
3634 {
3635   /**
3636    * Function to call on each connected neighbour.
3637    */
3638   GST_NeighbourIterator cb;
3639
3640   /**
3641    * Closure for @e cb.
3642    */
3643   void *cb_cls;
3644 };
3645
3646
3647 /**
3648  * Call the callback from the closure for each neighbour.
3649  *
3650  * @param cls the `struct IteratorContext`
3651  * @param key the hash of the public key of the neighbour
3652  * @param value the `struct NeighbourMapEntry`
3653  * @return #GNUNET_OK (continue to iterate)
3654  */
3655 static int
3656 neighbours_iterate (void *cls,
3657                     const struct GNUNET_PeerIdentity *key,
3658                     void *value)
3659 {
3660   struct IteratorContext *ic = cls;
3661   struct NeighbourMapEntry *n = value;
3662   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
3663   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
3664
3665   if (NULL != n->primary_address.address)
3666   {
3667     bandwidth_in = n->primary_address.bandwidth_in;
3668     bandwidth_out = n->primary_address.bandwidth_out;
3669   }
3670   else
3671   {
3672     bandwidth_in = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3673     bandwidth_out = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3674   }
3675   ic->cb (ic->cb_cls,
3676           &n->id,
3677           n->primary_address.address,
3678           n->state,
3679           n->timeout,
3680           bandwidth_in, bandwidth_out);
3681   return GNUNET_OK;
3682 }
3683
3684
3685 /**
3686  * Iterate over all connected neighbours.
3687  *
3688  * @param cb function to call
3689  * @param cb_cls closure for cb
3690  */
3691 void
3692 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls)
3693 {
3694   struct IteratorContext ic;
3695
3696   if (NULL == neighbours)
3697     return; /* can happen during shutdown */
3698   ic.cb = cb;
3699   ic.cb_cls = cb_cls;
3700   GNUNET_CONTAINER_multipeermap_iterate (neighbours,
3701                                          &neighbours_iterate,
3702                                          &ic);
3703 }
3704
3705
3706 /**
3707  * If we have an active connection to the given target, it must be shutdown.
3708  *
3709  * @param target peer to disconnect from
3710  */
3711 void
3712 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target)
3713 {
3714   struct NeighbourMapEntry *n;
3715
3716   if (NULL == (n = lookup_neighbour (target)))
3717     return;  /* not active */
3718   if (GNUNET_YES == test_connected (n))
3719     GNUNET_STATISTICS_update (GST_stats,
3720                               gettext_noop ("# disconnected from peer upon explicit request"),
3721                               1,
3722                               GNUNET_NO);
3723   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3724               "Forced disconnect from peer %s\n",
3725               GNUNET_i2s (target));
3726   disconnect_neighbour (n);
3727 }
3728
3729
3730 /**
3731  * Obtain current address information for the given neighbour.
3732  *
3733  * @param peer
3734  * @return address currently used
3735  */
3736 struct GNUNET_HELLO_Address *
3737 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer)
3738 {
3739   struct NeighbourMapEntry *n;
3740
3741   n = lookup_neighbour (peer);
3742   if (NULL == n)
3743     return NULL;
3744   return n->primary_address.address;
3745 }
3746
3747
3748 /**
3749  * Initialize the neighbours subsystem.
3750  *
3751  * @param max_fds maximum number of fds to use
3752  */
3753 void
3754 GST_neighbours_start (unsigned int max_fds)
3755 {
3756   neighbours = GNUNET_CONTAINER_multipeermap_create (NEIGHBOUR_TABLE_SIZE,
3757                                                      GNUNET_NO);
3758   util_transmission_tk = GNUNET_SCHEDULER_add_delayed (UTIL_TRANSMISSION_INTERVAL,
3759                                                        &utilization_transmission,
3760                                                        NULL);
3761 }
3762
3763
3764 /**
3765  * Disconnect from the given neighbour.
3766  *
3767  * @param cls unused
3768  * @param key hash of neighbour's public key (not used)
3769  * @param value the 'struct NeighbourMapEntry' of the neighbour
3770  * @return #GNUNET_OK (continue to iterate)
3771  */
3772 static int
3773 disconnect_all_neighbours (void *cls,
3774                            const struct GNUNET_PeerIdentity *key,
3775                            void *value)
3776 {
3777   struct NeighbourMapEntry *n = value;
3778
3779   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3780               "Disconnecting peer `%4s' during shutdown\n",
3781               GNUNET_i2s (&n->id));
3782   free_neighbour (n);
3783   return GNUNET_OK;
3784 }
3785
3786
3787 /**
3788  * Cleanup the neighbours subsystem.
3789  */
3790 void
3791 GST_neighbours_stop ()
3792 {
3793   struct BlacklistCheckSwitchContext *cur;
3794   struct BlacklistCheckSwitchContext *next;
3795
3796   if (NULL == neighbours)
3797     return;
3798   if (NULL != util_transmission_tk)
3799   {
3800     GNUNET_SCHEDULER_cancel (util_transmission_tk);
3801     util_transmission_tk = NULL;
3802   }
3803   GNUNET_CONTAINER_multipeermap_iterate (neighbours,
3804                                          &disconnect_all_neighbours,
3805                                          NULL);
3806   GNUNET_CONTAINER_multipeermap_destroy (neighbours);
3807   neighbours = NULL;
3808   next = pending_bc_head;
3809   for (cur = next; NULL != cur; cur = next)
3810   {
3811     next = cur->next;
3812     GNUNET_CONTAINER_DLL_remove (pending_bc_head,
3813                                  pending_bc_tail,
3814                                  cur);
3815
3816     if (NULL != cur->blc)
3817     {
3818       GST_blacklist_test_cancel (cur->blc);
3819       cur->blc = NULL;
3820     }
3821     if (NULL != cur->address)
3822       GNUNET_HELLO_address_free (cur->address);
3823     GNUNET_free (cur);
3824   }
3825 }
3826
3827
3828 /* end of file gnunet-service-transport_neighbours.c */