src/transport/gnunet-service-transport_neighbours.c

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