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