src/transport/gnunet-service-transport_neighbours.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010,2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file transport/gnunet-service-transport_neighbours.c
  23  * @brief neighbour management
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_ats_service.h"
  28 #include "gnunet-service-transport_neighbours.h"
  29 #include "gnunet-service-transport_plugins.h"
  30 #include "gnunet-service-transport_validation.h"
  31 #include "gnunet-service-transport.h"
  32 #include "gnunet_peerinfo_service.h"
  33 #include "gnunet_constants.h"
  34 #include "transport.h"
  35
  36
  37 /**
  38  * Size of the neighbour hash map.
  39  */
  40 #define NEIGHBOUR_TABLE_SIZE 256
  41
  42 /**
  43  * How often must a peer violate bandwidth quotas before we start
  44  * to simply drop its messages?
  45  */
  46 #define QUOTA_VIOLATION_DROP_THRESHOLD 10
  47
  48
  49 /**
  50  * Entry in neighbours.
  51  */
  52 struct NeighbourMapEntry;
  53
  54
  55 /**
  56  * For each neighbour we keep a list of messages
  57  * that we still want to transmit to the neighbour.
  58  */
  59 struct MessageQueue
  60 {
  61
  62   /**
  63    * This is a doubly linked list.
  64    */
  65   struct MessageQueue *next;
  66
  67   /**
  68    * This is a doubly linked list.
  69    */
  70   struct MessageQueue *prev;
  71
  72   /**
  73    * Once this message is actively being transmitted, which
  74    * neighbour is it associated with?
  75    */
  76   struct NeighbourMapEntry *n;
  77
  78   /**
  79    * Function to call once we're done.
  80    */
  81   GST_NeighbourSendContinuation cont;
  82
  83   /**
  84    * Closure for 'cont'
  85    */
  86   void *cont_cls;
  87
  88   /**
  89    * The message(s) we want to transmit, GNUNET_MessageHeader(s)
  90    * stuck together in memory.  Allocated at the end of this struct.
  91    */
  92   const char *message_buf;
  93
  94   /**
  95    * Size of the message buf
  96    */
  97   size_t message_buf_size;
  98
  99   /**
 100    * At what time should we fail?
 101    */
 102   struct GNUNET_TIME_Absolute timeout;
 103
 104 };
 105
 106
 107 /**
 108  * Entry in neighbours.
 109  */
 110 struct NeighbourMapEntry
 111 {
 112
 113   /**
 114    * Head of list of messages we would like to send to this peer;
 115    * must contain at most one message per client.
 116    */
 117   struct MessageQueue *messages_head;
 118
 119   /**
 120    * Tail of list of messages we would like to send to this peer; must
 121    * contain at most one message per client.
 122    */
 123   struct MessageQueue *messages_tail;
 124
 125   /**
 126    * Context for address suggestion.
 127    * NULL after we are connected.
 128    */
 129   struct GNUNET_ATS_SuggestionContext *asc;
 130
 131   /**
 132    * Performance data for the peer.
 133    */
 134   struct GNUNET_TRANSPORT_ATS_Information *ats;
 135
 136   /**
 137    * Are we currently trying to send a message? If so, which one?
 138    */
 139   struct MessageQueue *is_active;
 140
 141   /**
 142    * Active session for communicating with the peer.
 143    */
 144   struct Session *session;
 145
 146   /**
 147    * Name of the plugin we currently use.
 148    */
 149   char *plugin_name;
 150
 151   /**
 152    * Address used for communicating with the peer, NULL for inbound connections.
 153    */
 154   void *addr;
 155
 156   /**
 157    * Number of bytes in 'addr'.
 158    */
 159   size_t addrlen;
 160
 161   /**
 162    * Identity of this neighbour.
 163    */
 164   struct GNUNET_PeerIdentity id;
 165
 166   /**
 167    * ID of task scheduled to run when this peer is about to
 168    * time out (will free resources associated with the peer).
 169    */
 170   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 171
 172   /**
 173    * ID of task scheduled to run when we should try transmitting
 174    * the head of the message queue.
 175    */
 176   GNUNET_SCHEDULER_TaskIdentifier transmission_task;
 177
 178   /**
 179    * Tracker for inbound bandwidth.
 180    */
 181   struct GNUNET_BANDWIDTH_Tracker in_tracker;
 182
 183   /**
 184    * How often has the other peer (recently) violated the inbound
 185    * traffic limit?  Incremented by 10 per violation, decremented by 1
 186    * per non-violation (for each time interval).
 187    */
 188   unsigned int quota_violation_count;
 189
 190   /**
 191    * Number of values in 'ats' array.
 192    */
 193   unsigned int ats_count;
 194
 195   /**
 196    * Are we already in the process of disconnecting this neighbour?
 197    */
 198   int in_disconnect;
 199
 200   /**
 201    * Do we currently consider this neighbour connected? (as far as
 202    * the connect/disconnect callbacks are concerned)?
 203    */
 204   int is_connected;
 205
 206 };
 207
 208
 209 /**
 210  * All known neighbours and their HELLOs.
 211  */
 212 static struct GNUNET_CONTAINER_MultiHashMap *neighbours;
 213
 214 /**
 215  * Closure for connect_notify_cb and disconnect_notify_cb
 216  */
 217 static void *callback_cls;
 218
 219 /**
 220  * Function to call when we connected to a neighbour.
 221  */
 222 static GNUNET_TRANSPORT_NotifyConnect connect_notify_cb;
 223
 224 /**
 225  * Function to call when we disconnected from a neighbour.
 226  */
 227 static GNUNET_TRANSPORT_NotifyDisconnect disconnect_notify_cb;
 228
 229 /**
 230  * counter for connected neighbours
 231  */
 232 static int neighbours_connected;
 233
 234 /**
 235  * Lookup a neighbour entry in the neighbours hash map.
 236  *
 237  * @param pid identity of the peer to look up
 238  * @return the entry, NULL if there is no existing record
 239  */
 240 static struct NeighbourMapEntry *
 241 lookup_neighbour (const struct GNUNET_PeerIdentity *pid)
 242 {
 243   return GNUNET_CONTAINER_multihashmap_get (neighbours, &pid->hashPubKey);
 244 }
 245
 246
 247 /**
 248  * Task invoked to start a transmission to another peer.
 249  *
 250  * @param cls the 'struct NeighbourMapEntry'
 251  * @param tc scheduler context
 252  */
 253 static void
 254 transmission_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 255
 256
 257 /**
 258  * We're done with our transmission attempt, continue processing.
 259  *
 260  * @param cls the 'struct MessageQueue' of the message
 261  * @param receiver intended receiver
 262  * @param success whether it worked or not
 263  */
 264 void
 265 transmit_send_continuation (void *cls,
 266                             const struct GNUNET_PeerIdentity *receiver,
 267                             int success)
 268 {
 269   struct MessageQueue *mq;
 270   struct NeighbourMapEntry *n;
 271
 272   mq = cls;
 273   n = mq->n;
 274   if (NULL != n)
 275   {
 276     GNUNET_assert (n->is_active == mq);
 277     n->is_active = NULL;
 278     GNUNET_assert (n->transmission_task == GNUNET_SCHEDULER_NO_TASK);
 279     n->transmission_task = GNUNET_SCHEDULER_add_now (&transmission_task, n);
 280   }
 281   if (NULL != mq->cont)
 282     mq->cont (mq->cont_cls, success);
 283   GNUNET_free (mq);
 284 }
 285
 286
 287 /**
 288  * Check the ready list for the given neighbour and if a plugin is
 289  * ready for transmission (and if we have a message), do so!
 290  *
 291  * @param neighbour target peer for which to transmit
 292  */
 293 static void
 294 try_transmission_to_peer (struct NeighbourMapEntry *n)
 295 {
 296   struct MessageQueue *mq;
 297   struct GNUNET_TIME_Relative timeout;
 298   ssize_t ret;
 299   struct GNUNET_TRANSPORT_PluginFunctions *papi;
 300
 301   if (n->is_active != NULL)
 302     return;                     /* transmission already pending */
 303   if (n->transmission_task != GNUNET_SCHEDULER_NO_TASK)
 304     return;                     /* currently waiting for bandwidth */
 305   mq = n->messages_head;
 306   while (NULL != (mq = n->messages_head))
 307   {
 308     timeout = GNUNET_TIME_absolute_get_remaining (mq->timeout);
 309     if (timeout.rel_value > 0)
 310       break;
 311     transmit_send_continuation (mq, &n->id, GNUNET_SYSERR);     /* timeout */
 312   }
 313   if (NULL == mq)
 314     return;                     /* no more messages */
 315
 316   papi = GST_plugins_find (n->plugin_name);
 317   if (papi == NULL)
 318   {
 319     GNUNET_break (0);
 320     return;
 321   }
 322   GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
 323   n->is_active = mq;
 324   mq->n = n;
 325
 326   ret =
 327       papi->send (papi->cls, &n->id, mq->message_buf, mq->message_buf_size,
 328                   0 /* priority -- remove from plugin API? */ ,
 329                   timeout, n->session, n->addr, n->addrlen, GNUNET_YES,
 330                   &transmit_send_continuation, mq);
 331   if (ret == -1)
 332   {
 333     /* failure, but 'send' would not call continuation in this case,
 334      * so we need to do it here! */
 335     transmit_send_continuation (mq, &n->id, GNUNET_SYSERR);
 336     n->transmission_task = GNUNET_SCHEDULER_add_now (&transmission_task, n);
 337   }
 338 }
 339
 340
 341 /**
 342  * Task invoked to start a transmission to another peer.
 343  *
 344  * @param cls the 'struct NeighbourMapEntry'
 345  * @param tc scheduler context
 346  */
 347 static void
 348 transmission_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 349 {
 350   struct NeighbourMapEntry *n = cls;
 351
 352   n->transmission_task = GNUNET_SCHEDULER_NO_TASK;
 353   try_transmission_to_peer (n);
 354 }
 355
 356
 357 /**
 358  * Initialize the neighbours subsystem.
 359  *
 360  * @param cls closure for callbacks
 361  * @param connect_cb function to call if we connect to a peer
 362  * @param disconnect_cb function to call if we disconnect from a peer
 363  */
 364 void
 365 GST_neighbours_start (void *cls, GNUNET_TRANSPORT_NotifyConnect connect_cb,
 366                       GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb)
 367 {
 368   callback_cls = cls;
 369   connect_notify_cb = connect_cb;
 370   disconnect_notify_cb = disconnect_cb;
 371   neighbours = GNUNET_CONTAINER_multihashmap_create (NEIGHBOUR_TABLE_SIZE);
 372 }
 373
 374
 375 /**
 376  * Disconnect from the given neighbour, clean up the record.
 377  *
 378  * @param n neighbour to disconnect from
 379  */
 380 static void
 381 disconnect_neighbour (struct NeighbourMapEntry *n)
 382 {
 383   struct MessageQueue *mq;
 384
 385   if (GNUNET_YES == n->in_disconnect)
 386     return;
 387   n->in_disconnect = GNUNET_YES;
 388   while (NULL != (mq = n->messages_head))
 389   {
 390     GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
 391     mq->cont (mq->cont_cls, GNUNET_SYSERR);
 392     GNUNET_free (mq);
 393   }
 394   if (NULL != n->is_active)
 395   {
 396     n->is_active->n = NULL;
 397     n->is_active = NULL;
 398   }
 399   if (GNUNET_YES == n->is_connected)
 400   {
 401     n->is_connected = GNUNET_NO;
 402
 403     GNUNET_assert (neighbours_connected > 0);
 404     neighbours_connected--;
 405
 406     GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# peers connected"), -1,
 407                               GNUNET_NO);
 408     disconnect_notify_cb (callback_cls, &n->id);
 409   }
 410   GNUNET_assert (GNUNET_YES ==
 411                  GNUNET_CONTAINER_multihashmap_remove (neighbours,
 412                                                        &n->id.hashPubKey, n));
 413   if (GNUNET_SCHEDULER_NO_TASK != n->timeout_task)
 414   {
 415     GNUNET_SCHEDULER_cancel (n->timeout_task);
 416     n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 417   }
 418   if (GNUNET_SCHEDULER_NO_TASK != n->transmission_task)
 419   {
 420     GNUNET_SCHEDULER_cancel (n->timeout_task);
 421     n->transmission_task = GNUNET_SCHEDULER_NO_TASK;
 422   }
 423   if (NULL != n->asc)
 424   {
 425     GNUNET_ATS_suggest_address_cancel (n->asc);
 426     n->asc = NULL;
 427   }
 428   GNUNET_array_grow (n->ats, n->ats_count, 0);
 429   if (NULL != n->plugin_name)
 430   {
 431     GNUNET_free (n->plugin_name);
 432     n->plugin_name = NULL;
 433   }
 434   if (NULL != n->addr)
 435   {
 436     GNUNET_free (n->addr);
 437     n->addr = NULL;
 438     n->addrlen = 0;
 439   }
 440   n->session = NULL;
 441   GNUNET_free (n);
 442 }
 443
 444
 445 /**
 446  * Peer has been idle for too long. Disconnect.
 447  *
 448  * @param cls the 'struct NeighbourMapEntry' of the neighbour that went idle
 449  * @param tc scheduler context
 450  */
 451 static void
 452 neighbour_timeout_task (void *cls,
 453                         const struct GNUNET_SCHEDULER_TaskContext *tc)
 454 {
 455   struct NeighbourMapEntry *n = cls;
 456
 457   n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 458   disconnect_neighbour (n);
 459 }
 460
 461
 462 /**
 463  * Disconnect from the given neighbour.
 464  *
 465  * @param cls unused
 466  * @param key hash of neighbour's public key (not used)
 467  * @param value the 'struct NeighbourMapEntry' of the neighbour
 468  */
 469 static int
 470 disconnect_all_neighbours (void *cls, const GNUNET_HashCode * key, void *value)
 471 {
 472   struct NeighbourMapEntry *n = value;
 473
 474 #if DEBUG_TRANSPORT
 475   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s', %s\n",
 476               GNUNET_i2s (&n->id), "SHUTDOWN_TASK");
 477 #endif
 478   disconnect_neighbour (n);
 479   return GNUNET_OK;
 480 }
 481
 482
 483 /**
 484  * Cleanup the neighbours subsystem.
 485  */
 486 void
 487 GST_neighbours_stop ()
 488 {
 489   GNUNET_assert (neighbours != NULL);
 490
 491   GNUNET_CONTAINER_multihashmap_iterate (neighbours, &disconnect_all_neighbours,
 492                                          NULL);
 493   GNUNET_CONTAINER_multihashmap_destroy (neighbours);
 494   GNUNET_assert (neighbours_connected == 0);
 495   neighbours = NULL;
 496   callback_cls = NULL;
 497   connect_notify_cb = NULL;
 498   disconnect_notify_cb = NULL;
 499 }
 500
 501
 502 /**
 503  * For an existing neighbour record, set the active connection to
 504  * the given address.
 505  *
 506  * @param peer identity of the peer to switch the address for
 507  * @param plugin_name name of transport that delivered the PONG
 508  * @param address address of the other peer, NULL if other peer
 509  *                       connected to us
 510  * @param address_len number of bytes in address
 511  * @param session session to use (or NULL)
 512  * @param ats performance data
 513  * @param ats_count number of entries in ats (excluding 0-termination)
 514  */
 515 void
 516 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
 517                                   const char *plugin_name, const void *address,
 518                                   size_t address_len, struct Session *session,
 519                                   const struct GNUNET_TRANSPORT_ATS_Information
 520                                   *ats, uint32_t ats_count)
 521 {
 522   struct NeighbourMapEntry *n;
 523   struct GNUNET_MessageHeader connect_msg;
 524
 525   GNUNET_assert (neighbours != NULL);
 526
 527   n = lookup_neighbour (peer);
 528   if (NULL == n)
 529   {
 530     GNUNET_break (0);
 531     return;
 532   }
 533
 534 #if DEBUG_TRANSPORT
 535   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 536               "SWITCH! Peer `%4s' switches to plugin `%s' address '%s' session %X\n",
 537               GNUNET_i2s (peer), plugin_name,
 538               (address_len == 0) ? "<inbound>" : GST_plugins_a2s (plugin_name,
 539                                                                   address,
 540                                                                   address_len),
 541               session);
 542 #endif
 543
 544   GNUNET_free_non_null (n->addr);
 545   n->addr = GNUNET_malloc (address_len);
 546   memcpy (n->addr, address, address_len);
 547   n->addrlen = address_len;
 548   n->session = session;
 549   GNUNET_array_grow (n->ats, n->ats_count, ats_count);
 550   memcpy (n->ats, ats,
 551           ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
 552   GNUNET_free_non_null (n->plugin_name);
 553   n->plugin_name = GNUNET_strdup (plugin_name);
 554   GNUNET_SCHEDULER_cancel (n->timeout_task);
 555   n->timeout_task =
 556       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 557                                     &neighbour_timeout_task, n);
 558   connect_msg.size = htons (sizeof (struct GNUNET_MessageHeader));
 559   connect_msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT);
 560   GST_neighbours_send (peer, &connect_msg, sizeof (connect_msg),
 561                        GNUNET_TIME_UNIT_FOREVER_REL, NULL, NULL);
 562 }
 563
 564
 565 /**
 566  * Try to connect to the target peer using the given address
 567  *
 568  * @param cls the 'struct NeighbourMapEntry' of the target
 569  * @param target identity of the target peer
 570  * @param plugin_name name of the plugin
 571  * @param plugin_address binary address
 572  * @param plugin_address_len length of address
 573  * @param bandwidth available bandwidth
 574  * @param ats performance data for the address (as far as known)
 575  * @param ats_count number of performance records in 'ats'
 576  */
 577 static void
 578 try_connect_using_address (void *cls, const struct GNUNET_PeerIdentity *target,
 579                            const char *plugin_name, const void *plugin_address,
 580                            size_t plugin_address_len, struct Session *session,
 581                            struct GNUNET_BANDWIDTH_Value32NBO bandwidth,
 582                            const struct GNUNET_TRANSPORT_ATS_Information *ats,
 583                            uint32_t ats_count)
 584 {
 585   struct NeighbourMapEntry *n = cls;
 586   int was_connected;
 587
 588   n->asc = NULL;
 589   was_connected = n->is_connected;
 590   n->is_connected = GNUNET_YES;
 591   GST_neighbours_switch_to_address (target, plugin_name, plugin_address,
 592                                     plugin_address_len, session, ats,
 593                                     ats_count);
 594   if (GNUNET_YES == was_connected)
 595     return;
 596
 597   neighbours_connected++;
 598   GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# peers connected"), 1,
 599                             GNUNET_NO);
 600   connect_notify_cb (callback_cls, target, n->ats, n->ats_count);
 601 }
 602
 603
 604 /**
 605  * Try to create a connection to the given target (eventually).
 606  *
 607  * @param target peer to try to connect to
 608  */
 609 void
 610 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target)
 611 {
 612   struct NeighbourMapEntry *n;
 613
 614   GNUNET_assert (neighbours != NULL);
 615
 616 #if DEBUG_TRANSPORT
 617   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Trying to connect to peer `%s'\n",
 618               GNUNET_i2s (target));
 619 #endif
 620
 621   GNUNET_assert (0 !=
 622                  memcmp (target, &GST_my_identity,
 623                          sizeof (struct GNUNET_PeerIdentity)));
 624   n = lookup_neighbour (target);
 625   if ((NULL != n) && (GNUNET_YES == n->is_connected))
 626     return;                     /* already connected */
 627   if (n == NULL)
 628   {
 629 #if DEBUG_TRANSPORT
 630     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 631                 "Unknown peer `%s', creating new neighbour\n",
 632                 GNUNET_i2s (target));
 633 #endif
 634     n = GNUNET_malloc (sizeof (struct NeighbourMapEntry));
 635     n->id = *target;
 636     GNUNET_array_grow (n->ats, n->ats_count, 1);
 637     n->ats[0].type = htonl (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR);;
 638     n->ats[0].value = htonl (0);
 639     GNUNET_BANDWIDTH_tracker_init (&n->in_tracker,
 640                                    GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
 641                                    MAX_BANDWIDTH_CARRY_S);
 642     n->timeout_task =
 643         GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 644                                       &neighbour_timeout_task, n);
 645     GNUNET_assert (GNUNET_OK ==
 646                    GNUNET_CONTAINER_multihashmap_put (neighbours,
 647                                                       &n->id.hashPubKey, n,
 648                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 649   }
 650   if (n->asc != NULL)
 651     return;                     /* already trying */
 652 #if DEBUG_TRANSPORT
 653   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 654               "Asking ATS for suggested address to connect to peer `%s'\n",
 655               GNUNET_i2s (target));
 656 #endif
 657   n->asc =
 658       GNUNET_ATS_suggest_address (GST_ats, target, &try_connect_using_address,
 659                                   n);
 660 }
 661
 662
 663 /**
 664  * Test if we're connected to the given peer.
 665  *
 666  * @param target peer to test
 667  * @return GNUNET_YES if we are connected, GNUNET_NO if not
 668  */
 669 int
 670 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target)
 671 {
 672   struct NeighbourMapEntry *n;
 673
 674   GNUNET_assert (neighbours != NULL);
 675
 676   n = lookup_neighbour (target);
 677   if ((NULL == n) || (n->is_connected != GNUNET_YES))
 678     return GNUNET_NO;           /* not connected */
 679   return GNUNET_YES;
 680 }
 681
 682
 683 /**
 684  * A session was terminated. Take note.
 685  *
 686  * @param peer identity of the peer where the session died
 687  * @param session session that is gone
 688  */
 689 void
 690 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
 691                                    struct Session *session)
 692 {
 693   struct NeighbourMapEntry *n;
 694
 695   GNUNET_assert (neighbours != NULL);
 696
 697   n = lookup_neighbour (peer);
 698   if (NULL == n)
 699     return;
 700   if (session != n->session)
 701     return;                     /* doesn't affect us */
 702   n->session = NULL;
 703   if (GNUNET_YES != n->is_connected)
 704     return;                     /* not connected anymore anyway, shouldn't matter */
 705
 706   GNUNET_SCHEDULER_cancel (n->timeout_task);
 707   n->timeout_task =
 708       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 709                                     &neighbour_timeout_task, n);
 710   /* try QUICKLY to re-establish a connection, reduce timeout! */
 711   if (NULL != n->ats)
 712   {
 713     /* how can this be!? */
 714     //GNUNET_break (0);
 715     return;
 716   }
 717   n->asc =
 718       GNUNET_ATS_suggest_address (GST_ats, peer, &try_connect_using_address, n);
 719 }
 720
 721
 722 /**
 723  * Transmit a message to the given target using the active connection.
 724  *
 725  * @param target destination
 726  * @param msg message to send
 727  * @param msg_size number of bytes in msg
 728  * @param timeout when to fail with timeout
 729  * @param cont function to call when done
 730  * @param cont_cls closure for 'cont'
 731  */
 732 void
 733 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
 734                      size_t msg_size, struct GNUNET_TIME_Relative timeout,
 735                      GST_NeighbourSendContinuation cont, void *cont_cls)
 736 {
 737   struct NeighbourMapEntry *n;
 738   struct MessageQueue *mq;
 739
 740   GNUNET_assert (neighbours != NULL);
 741
 742   n = lookup_neighbour (target);
 743   if ((n == NULL) || (GNUNET_YES != n->is_connected))
 744   {
 745     GNUNET_STATISTICS_update (GST_stats,
 746                               gettext_noop
 747                               ("# messages not sent (no such peer or not connected)"),
 748                               1, GNUNET_NO);
 749 #if DEBUG_TRANSPORT
 750     if (n == NULL)
 751       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 752                   "Could not send message to peer `%s': unknown neighbor",
 753                   GNUNET_i2s (target));
 754     if (GNUNET_YES != n->is_connected)
 755       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 756                   "Could not send message to peer `%s': not connected\n",
 757                   GNUNET_i2s (target));
 758 #endif
 759     if (NULL != cont)
 760       cont (cont_cls, GNUNET_SYSERR);
 761     return;
 762   }
 763
 764   GNUNET_assert (msg_size >= sizeof (struct GNUNET_MessageHeader));
 765   GNUNET_STATISTICS_update (GST_stats,
 766                             gettext_noop
 767                             ("# bytes in message queue for other peers"),
 768                             msg_size, GNUNET_NO);
 769   mq = GNUNET_malloc (sizeof (struct MessageQueue) + msg_size);
 770   mq->cont = cont;
 771   mq->cont_cls = cont_cls;
 772   /* FIXME: this memcpy can be up to 7% of our total runtime! */
 773   memcpy (&mq[1], msg, msg_size);
 774   mq->message_buf = (const char *) &mq[1];
 775   mq->message_buf_size = msg_size;
 776   mq->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 777   GNUNET_CONTAINER_DLL_insert_tail (n->messages_head, n->messages_tail, mq);
 778   if ((GNUNET_SCHEDULER_NO_TASK == n->transmission_task) &&
 779       (NULL == n->is_active))
 780     n->transmission_task = GNUNET_SCHEDULER_add_now (&transmission_task, n);
 781 }
 782
 783
 784 /**
 785  * We have received a message from the given sender.  How long should
 786  * we delay before receiving more?  (Also used to keep the peer marked
 787  * as live).
 788  *
 789  * @param sender sender of the message
 790  * @param size size of the message
 791  * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
 792  *                   GNUNET_NO if the neighbour is not connected or violates the quota
 793  * @return how long to wait before reading more from this sender
 794  */
 795 struct GNUNET_TIME_Relative
 796 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
 797                                         *sender, ssize_t size, int *do_forward)
 798 {
 799   struct NeighbourMapEntry *n;
 800   struct GNUNET_TIME_Relative ret;
 801
 802   GNUNET_assert (neighbours != NULL);
 803
 804   n = lookup_neighbour (sender);
 805   if (n == NULL)
 806   {
 807     *do_forward = GNUNET_NO;
 808     return GNUNET_TIME_UNIT_ZERO;
 809   }
 810   if (GNUNET_YES == GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, size))
 811   {
 812     n->quota_violation_count++;
 813 #if DEBUG_TRANSPORT
 814     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 815                 "Bandwidth quota (%u b/s) violation detected (total of %u).\n",
 816                 n->in_tracker.available_bytes_per_s__,
 817                 n->quota_violation_count);
 818 #endif
 819     /* Discount 32k per violation */
 820     GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, -32 * 1024);
 821   }
 822   else
 823   {
 824     if (n->quota_violation_count > 0)
 825     {
 826       /* try to add 32k back */
 827       GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, 32 * 1024);
 828       n->quota_violation_count--;
 829     }
 830   }
 831   if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
 832   {
 833     GNUNET_STATISTICS_update (GST_stats,
 834                               gettext_noop
 835                               ("# bandwidth quota violations by other peers"),
 836                               1, GNUNET_NO);
 837     *do_forward = GNUNET_NO;
 838     return GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT;
 839   }
 840   *do_forward = GNUNET_YES;
 841   ret = GNUNET_BANDWIDTH_tracker_get_delay (&n->in_tracker, 0);
 842   if (ret.rel_value > 0)
 843   {
 844 #if DEBUG_TRANSPORT
 845     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 846                 "Throttling read (%llu bytes excess at %u b/s), waiting %llu ms before reading more.\n",
 847                 (unsigned long long) n->in_tracker.
 848                 consumption_since_last_update__,
 849                 (unsigned int) n->in_tracker.available_bytes_per_s__,
 850                 (unsigned long long) ret.rel_value);
 851 #endif
 852     GNUNET_STATISTICS_update (GST_stats,
 853                               gettext_noop ("# ms throttling suggested"),
 854                               (int64_t) ret.rel_value, GNUNET_NO);
 855   }
 856   return ret;
 857 }
 858
 859
 860 /**
 861  * Keep the connection to the given neighbour alive longer,
 862  * we received a KEEPALIVE (or equivalent).
 863  *
 864  * @param neighbour neighbour to keep alive
 865  */
 866 void
 867 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour)
 868 {
 869   struct NeighbourMapEntry *n;
 870
 871   GNUNET_assert (neighbours != NULL);
 872
 873   n = lookup_neighbour (neighbour);
 874   if (NULL == n)
 875   {
 876     GNUNET_STATISTICS_update (GST_stats,
 877                               gettext_noop
 878                               ("# KEEPALIVE messages discarded (not connected)"),
 879                               1, GNUNET_NO);
 880     return;
 881   }
 882   GNUNET_SCHEDULER_cancel (n->timeout_task);
 883   n->timeout_task =
 884       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 885                                     &neighbour_timeout_task, n);
 886 }
 887
 888
 889 /**
 890  * Change the incoming quota for the given peer.
 891  *
 892  * @param neighbour identity of peer to change qutoa for
 893  * @param quota new quota
 894  */
 895 void
 896 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
 897                                    struct GNUNET_BANDWIDTH_Value32NBO quota)
 898 {
 899   struct NeighbourMapEntry *n;
 900
 901   GNUNET_assert (neighbours != NULL);
 902
 903   n = lookup_neighbour (neighbour);
 904   if (n == NULL)
 905   {
 906     GNUNET_STATISTICS_update (GST_stats,
 907                               gettext_noop
 908                               ("# SET QUOTA messages ignored (no such peer)"),
 909                               1, GNUNET_NO);
 910     return;
 911   }
 912   GNUNET_BANDWIDTH_tracker_update_quota (&n->in_tracker, quota);
 913   if (0 != ntohl (quota.value__))
 914     return;
 915 #if DEBUG_TRANSPORT
 916   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s' due to `%s'\n",
 917               GNUNET_i2s (&n->id), "SET_QUOTA");
 918 #endif
 919   GNUNET_STATISTICS_update (GST_stats,
 920                             gettext_noop ("# disconnects due to quota of 0"), 1,
 921                             GNUNET_NO);
 922   disconnect_neighbour (n);
 923 }
 924
 925
 926 /**
 927  * Closure for the neighbours_iterate function.
 928  */
 929 struct IteratorContext
 930 {
 931   /**
 932    * Function to call on each connected neighbour.
 933    */
 934   GST_NeighbourIterator cb;
 935
 936   /**
 937    * Closure for 'cb'.
 938    */
 939   void *cb_cls;
 940 };
 941
 942
 943 /**
 944  * Call the callback from the closure for each connected neighbour.
 945  *
 946  * @param cls the 'struct IteratorContext'
 947  * @param key the hash of the public key of the neighbour
 948  * @param value the 'struct NeighbourMapEntry'
 949  * @return GNUNET_OK (continue to iterate)
 950  */
 951 static int
 952 neighbours_iterate (void *cls, const GNUNET_HashCode * key, void *value)
 953 {
 954   struct IteratorContext *ic = cls;
 955   struct NeighbourMapEntry *n = value;
 956
 957   if (GNUNET_YES != n->is_connected)
 958     return GNUNET_OK;
 959
 960   GNUNET_assert (n->ats_count > 0);
 961   ic->cb (ic->cb_cls, &n->id, n->ats, n->ats_count);
 962   return GNUNET_OK;
 963 }
 964
 965
 966 /**
 967  * Iterate over all connected neighbours.
 968  *
 969  * @param cb function to call
 970  * @param cb_cls closure for cb
 971  */
 972 void
 973 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls)
 974 {
 975   struct IteratorContext ic;
 976
 977   GNUNET_assert (neighbours != NULL);
 978
 979   ic.cb = cb;
 980   ic.cb_cls = cb_cls;
 981   GNUNET_CONTAINER_multihashmap_iterate (neighbours, &neighbours_iterate, &ic);
 982 }
 983
 984
 985 /**
 986  * If we have an active connection to the given target, it must be shutdown.
 987  *
 988  * @param target peer to disconnect from
 989  */
 990 void
 991 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target)
 992 {
 993   struct NeighbourMapEntry *n;
 994   struct GNUNET_TRANSPORT_PluginFunctions *papi;
 995   struct GNUNET_MessageHeader disconnect_msg;
 996
 997   GNUNET_assert (neighbours != NULL);
 998
 999   n = lookup_neighbour (target);
1000   if (NULL == n)
1001     return;                     /* not active */
1002   if (GNUNET_YES == n->is_connected)
1003   {
1004     /* we're actually connected, send DISCONNECT message */
1005     disconnect_msg.size = htons (sizeof (struct GNUNET_MessageHeader));
1006     disconnect_msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
1007     papi = GST_plugins_find (n->plugin_name);
1008     if (papi != NULL)
1009       papi->send (papi->cls, target, (const void *) &disconnect_msg,
1010                   sizeof (struct GNUNET_MessageHeader),
1011                   UINT32_MAX /* priority */ ,
1012                   GNUNET_TIME_UNIT_FOREVER_REL, n->session, n->addr, n->addrlen,
1013                   GNUNET_YES, NULL, NULL);
1014   }
1015   disconnect_neighbour (n);
1016 }
1017
1018
1019 /* end of file gnunet-service-transport_neighbours.c */