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