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_TRANSPORT_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_NO_TASK;
 554   GNUNET_assert (GNUNET_YES == n->is_connected);
 555   GNUNET_STATISTICS_update (GST_stats,
 556                             gettext_noop ("# keepalives sent"), 1,
 557                             GNUNET_NO);
 558   m.size = htons (sizeof (struct GNUNET_MessageHeader));
 559   m.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE);
 560   papi = GST_plugins_find (n->plugin_name);
 561   if (papi != NULL)
 562     papi->send (papi->cls,
 563                 &n->id, (const void *) &m,
 564                 sizeof (m),
 565                 UINT32_MAX /* priority */ ,
 566                 GNUNET_TIME_UNIT_FOREVER_REL, n->session, n->addr, n->addrlen,
 567                 GNUNET_YES, NULL, NULL);
 568   n->keepalive_task = GNUNET_SCHEDULER_add_delayed (KEEPALIVE_FREQUENCY,
 569                                                     &neighbour_keepalive_task,
 570                                                     n);
 571 }
 572
 573
 574 /**
 575  * Disconnect from the given neighbour.
 576  *
 577  * @param cls unused
 578  * @param key hash of neighbour's public key (not used)
 579  * @param value the 'struct NeighbourMapEntry' of the neighbour
 580  */
 581 static int
 582 disconnect_all_neighbours (void *cls, const GNUNET_HashCode * key, void *value)
 583 {
 584   struct NeighbourMapEntry *n = value;
 585
 586 #if DEBUG_TRANSPORT
 587   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s', %s\n",
 588               GNUNET_i2s (&n->id), "SHUTDOWN_TASK");
 589 #endif
 590   if (GNUNET_YES == n->is_connected)
 591     GNUNET_STATISTICS_update (GST_stats,
 592                               gettext_noop ("# peers disconnected due to global disconnect"), 1,
 593                               GNUNET_NO);
 594   disconnect_neighbour (n);
 595   return GNUNET_OK;
 596 }
 597
 598
 599 /**
 600  * Cleanup the neighbours subsystem.
 601  */
 602 void
 603 GST_neighbours_stop ()
 604 {
 605   GNUNET_assert (neighbours != NULL);
 606
 607   GNUNET_CONTAINER_multihashmap_iterate (neighbours, &disconnect_all_neighbours,
 608                                          NULL);
 609   GNUNET_CONTAINER_multihashmap_destroy (neighbours);
 610   GNUNET_assert (neighbours_connected == 0);
 611   neighbours = NULL;
 612   callback_cls = NULL;
 613   connect_notify_cb = NULL;
 614   disconnect_notify_cb = NULL;
 615 }
 616
 617 struct AddressContext
 618 {
 619   struct NeighbourMapEntry * n;
 620   struct GNUNET_TRANSPORT_ATS_Information * ats;
 621   uint32_t ats_count;
 622 };
 623
 624 void neighbour_send_cb (void *cls, int success)
 625 {
 626   struct AddressContext * ac = cls;
 627   struct NeighbourMapEntry * n = ac->n;
 628   int  was_connected = n->is_connected;
 629
 630   if (success == GNUNET_YES)
 631   {
 632     n->is_connected = GNUNET_YES;
 633
 634     /* was already connected */
 635     if (was_connected == GNUNET_YES)
 636     {
 637       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 638                 "Successfully switched to address `%s' for peer `%s' \n",
 639                 GST_plugins_a2s(n->plugin_name, n->addr, n->addrlen),
 640                 GNUNET_i2s (&n->id));
 641       GNUNET_free (ac);
 642       return;
 643     }
 644
 645     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 646               "Successfully connected to peer `%s' with address `%s'\n",
 647               GNUNET_i2s (&n->id),
 648               GST_plugins_a2s(n->plugin_name, n->addr, n->addrlen));
 649
 650     neighbours_connected++;
 651     GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# peers connected"), 1,
 652                               GNUNET_NO);
 653     connect_notify_cb (callback_cls, &n->id, ac->ats, ac->ats_count);
 654     GNUNET_free (ac);
 655     return;
 656   }
 657
 658   /* Could not connecte using this address, notifying ATS about bad address */
 659   GNUNET_ATS_address_destroyed(GST_ats, &n->id, n->plugin_name, n->addr, n->addrlen, n->session);
 660   GNUNET_ATS_suggest_address(GST_ats, &n->id);
 661   GNUNET_free (ac);
 662 }
 663
 664 /**
 665  * For an existing neighbour record, set the active connection to
 666  * the given address.
 667  *
 668  * @param peer identity of the peer to switch the address for
 669  * @param plugin_name name of transport that delivered the PONG
 670  * @param address address of the other peer, NULL if other peer
 671  *                       connected to us
 672  * @param address_len number of bytes in address
 673  * @param session session to use (or NULL)
 674  * @param ats performance data
 675  * @param ats_count number of entries in ats (excluding 0-termination)
 676  */
 677 void
 678 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
 679                                   const char *plugin_name, const void *address,
 680                                   size_t address_len, struct Session *session,
 681                                   const struct GNUNET_TRANSPORT_ATS_Information
 682                                   *ats, uint32_t ats_count)
 683 {
 684   struct NeighbourMapEntry *n;
 685   struct SessionConnectMessage connect_msg;
 686   struct AddressContext *ac;
 687
 688   GNUNET_assert (neighbours != NULL);
 689
 690   n = lookup_neighbour (peer);
 691   if (NULL == n)
 692   {
 693     /* FIXME: ATS not fully implemented, once ATS only generates
 694        these events for 'connected' addresses, things should be better... */
 695     // GNUNET_break (0);
 696     return;
 697   }
 698
 699 #if DEBUG_TRANSPORT
 700   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 701               "Peer `%4s' switches to plugin `%s' address '%s' session %X\n",
 702               GNUNET_i2s (peer), plugin_name,
 703               (address_len == 0) ? "<inbound>" : GST_plugins_a2s (plugin_name,
 704                                                                   address,
 705                                                                   address_len),
 706               session);
 707 #endif
 708
 709   ac = GNUNET_malloc(sizeof (struct AddressContext) +
 710                      ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
 711   ac->n = n;
 712   ac->ats_count = ats_count;
 713   memcpy(&ac[1],ats, ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
 714
 715   GNUNET_free_non_null (n->addr);
 716   n->addr = GNUNET_malloc (address_len);
 717   memcpy (n->addr, address, address_len);
 718   n->addrlen = address_len;
 719   n->session = session;
 720   GNUNET_free_non_null (n->plugin_name);
 721   n->plugin_name = GNUNET_strdup (plugin_name);
 722   GNUNET_SCHEDULER_cancel (n->timeout_task);
 723   n->timeout_task =
 724       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 725                                     &neighbour_timeout_task, n);
 726   connect_msg.header.size = htons (sizeof (struct SessionConnectMessage));
 727   connect_msg.header.type =
 728       htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT);
 729   connect_msg.reserved = htonl (0);
 730   connect_msg.timestamp =
 731       GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
 732   GST_neighbours_send (peer, &connect_msg, sizeof (connect_msg),
 733                        GNUNET_TIME_UNIT_FOREVER_REL, &neighbour_send_cb, ac);
 734
 735   n->keepalive_task = GNUNET_SCHEDULER_add_now (&neighbour_keepalive_task,
 736                                                 n);
 737 }
 738
 739 /**
 740  * Try to create a connection to the given target (eventually).
 741  *
 742  * @param target peer to try to connect to
 743  */
 744 void
 745 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target)
 746 {
 747   struct NeighbourMapEntry *n;
 748
 749   GNUNET_assert (neighbours != NULL);
 750
 751 #if DEBUG_TRANSPORT
 752   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Trying to connect to peer `%s'\n",
 753               GNUNET_i2s (target));
 754 #endif
 755
 756   GNUNET_assert (0 !=
 757                  memcmp (target, &GST_my_identity,
 758                          sizeof (struct GNUNET_PeerIdentity)));
 759   n = lookup_neighbour (target);
 760   if ((NULL != n) && (GNUNET_YES == n->is_connected))
 761     return;                     /* already connected */
 762   if (n == NULL)
 763   {
 764 #if DEBUG_TRANSPORT
 765     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 766                 "Unknown peer `%s', creating new neighbour\n",
 767                 GNUNET_i2s (target));
 768 #endif
 769     n = GNUNET_malloc (sizeof (struct NeighbourMapEntry));
 770     n->id = *target;
 771     GNUNET_BANDWIDTH_tracker_init (&n->in_tracker,
 772                                    GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
 773                                    MAX_BANDWIDTH_CARRY_S);
 774     n->timeout_task =
 775         GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 776                                       &neighbour_timeout_task, n);
 777     GNUNET_assert (GNUNET_OK ==
 778                    GNUNET_CONTAINER_multihashmap_put (neighbours,
 779                                                       &n->id.hashPubKey, n,
 780                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 781   }
 782 #if DEBUG_TRANSPORT
 783   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 784               "Asking ATS for suggested address to connect to peer `%s'\n",
 785               GNUNET_i2s (target));
 786 #endif
 787    GNUNET_ATS_suggest_address (GST_ats, target);
 788 }
 789
 790
 791 /**
 792  * Test if we're connected to the given peer.
 793  *
 794  * @param target peer to test
 795  * @return GNUNET_YES if we are connected, GNUNET_NO if not
 796  */
 797 int
 798 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target)
 799 {
 800   struct NeighbourMapEntry *n;
 801
 802   GNUNET_assert (neighbours != NULL);
 803
 804   n = lookup_neighbour (target);
 805   if ((NULL == n) || (n->is_connected != GNUNET_YES))
 806     return GNUNET_NO;           /* not connected */
 807   return GNUNET_YES;
 808 }
 809
 810
 811 /**
 812  * A session was terminated. Take note.
 813  *
 814  * @param peer identity of the peer where the session died
 815  * @param session session that is gone
 816  */
 817 void
 818 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
 819                                    struct Session *session)
 820 {
 821   struct NeighbourMapEntry *n;
 822
 823   GNUNET_assert (neighbours != NULL);
 824
 825 #if DEBUG_TRANSPORT
 826   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 827               "Session %X to peer `%s' ended \n",
 828               session, GNUNET_i2s (peer));
 829 #endif
 830
 831   n = lookup_neighbour (peer);
 832   if (NULL == n)
 833     return;
 834   if (session != n->session)
 835     return;                     /* doesn't affect us */
 836
 837   n->session = NULL;
 838   GNUNET_free (n->addr);
 839   n->addr = NULL;
 840   n->addrlen = 0;
 841
 842
 843   if (GNUNET_YES != n->is_connected)
 844     return;                     /* not connected anymore anyway, shouldn't matter */
 845
 846   //n->is_connected = GNUNET_NO;
 847
 848   /* fast disconnect unless ATS suggests a new address */
 849   GNUNET_SCHEDULER_cancel (n->timeout_task);
 850   n->timeout_task =
 851       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_DISCONNECT_SESSION_TIMEOUT,
 852                                     &neighbour_timeout_task, n);
 853   /* try QUICKLY to re-establish a connection, reduce timeout! */
 854   GNUNET_ATS_suggest_address (GST_ats, peer);
 855 }
 856
 857
 858 /**
 859  * Transmit a message to the given target using the active connection.
 860  *
 861  * @param target destination
 862  * @param msg message to send
 863  * @param msg_size number of bytes in msg
 864  * @param timeout when to fail with timeout
 865  * @param cont function to call when done
 866  * @param cont_cls closure for 'cont'
 867  */
 868 void
 869 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
 870                      size_t msg_size, struct GNUNET_TIME_Relative timeout,
 871                      GST_NeighbourSendContinuation cont, void *cont_cls)
 872 {
 873   struct NeighbourMapEntry *n;
 874   struct MessageQueue *mq;
 875
 876   GNUNET_assert (neighbours != NULL);
 877
 878   n = lookup_neighbour (target);
 879   if ((n == NULL) || (GNUNET_YES != n->is_connected))
 880   {
 881     GNUNET_STATISTICS_update (GST_stats,
 882                               gettext_noop
 883                               ("# messages not sent (no such peer or not connected)"),
 884                               1, GNUNET_NO);
 885 #if DEBUG_TRANSPORT
 886     if (n == NULL)
 887       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 888                   "Could not send message to peer `%s': unknown neighbor",
 889                   GNUNET_i2s (target));
 890     else if (GNUNET_YES != n->is_connected)
 891       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 892                   "Could not send message to peer `%s': not connected\n",
 893                   GNUNET_i2s (target));
 894 #endif
 895     if (NULL != cont)
 896       cont (cont_cls, GNUNET_SYSERR);
 897     return;
 898   }
 899
 900   if ((n->session == NULL) && (n->addr == NULL) && (n->addrlen ==0))
 901   {
 902     GNUNET_STATISTICS_update (GST_stats,
 903                               gettext_noop
 904                               ("# messages not sent (no such peer or not connected)"),
 905                               1, GNUNET_NO);
 906 #if DEBUG_TRANSPORT
 907       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 908                   "Could not send message to peer `%s': no address available\n",
 909                   GNUNET_i2s (target));
 910 #endif
 911
 912     if (NULL != cont)
 913       cont (cont_cls, GNUNET_SYSERR);
 914     return;
 915   }
 916
 917
 918   GNUNET_assert (msg_size >= sizeof (struct GNUNET_MessageHeader));
 919   GNUNET_STATISTICS_update (GST_stats,
 920                             gettext_noop
 921                             ("# bytes in message queue for other peers"),
 922                             msg_size, GNUNET_NO);
 923   mq = GNUNET_malloc (sizeof (struct MessageQueue) + msg_size);
 924   mq->cont = cont;
 925   mq->cont_cls = cont_cls;
 926   /* FIXME: this memcpy can be up to 7% of our total runtime! */
 927   memcpy (&mq[1], msg, msg_size);
 928   mq->message_buf = (const char *) &mq[1];
 929   mq->message_buf_size = msg_size;
 930   mq->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 931   GNUNET_CONTAINER_DLL_insert_tail (n->messages_head, n->messages_tail, mq);
 932   if ((GNUNET_SCHEDULER_NO_TASK == n->transmission_task) &&
 933       (NULL == n->is_active))
 934     n->transmission_task = GNUNET_SCHEDULER_add_now (&transmission_task, n);
 935 }
 936
 937
 938 /**
 939  * We have received a message from the given sender.  How long should
 940  * we delay before receiving more?  (Also used to keep the peer marked
 941  * as live).
 942  *
 943  * @param sender sender of the message
 944  * @param size size of the message
 945  * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
 946  *                   GNUNET_NO if the neighbour is not connected or violates the quota
 947  * @return how long to wait before reading more from this sender
 948  */
 949 struct GNUNET_TIME_Relative
 950 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
 951                                         *sender, ssize_t size, int *do_forward)
 952 {
 953   struct NeighbourMapEntry *n;
 954   struct GNUNET_TIME_Relative ret;
 955
 956   GNUNET_assert (neighbours != NULL);
 957
 958   n = lookup_neighbour (sender);
 959   if (n == NULL)
 960   {
 961     *do_forward = GNUNET_NO;
 962     return GNUNET_TIME_UNIT_ZERO;
 963   }
 964   if (GNUNET_YES == GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, size))
 965   {
 966     n->quota_violation_count++;
 967 #if DEBUG_TRANSPORT
 968     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 969                 "Bandwidth quota (%u b/s) violation detected (total of %u).\n",
 970                 n->in_tracker.available_bytes_per_s__,
 971                 n->quota_violation_count);
 972 #endif
 973     /* Discount 32k per violation */
 974     GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, -32 * 1024);
 975   }
 976   else
 977   {
 978     if (n->quota_violation_count > 0)
 979     {
 980       /* try to add 32k back */
 981       GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, 32 * 1024);
 982       n->quota_violation_count--;
 983     }
 984   }
 985   if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
 986   {
 987     GNUNET_STATISTICS_update (GST_stats,
 988                               gettext_noop
 989                               ("# bandwidth quota violations by other peers"),
 990                               1, GNUNET_NO);
 991     *do_forward = GNUNET_NO;
 992     return GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT;
 993   }
 994   *do_forward = GNUNET_YES;
 995   ret = GNUNET_BANDWIDTH_tracker_get_delay (&n->in_tracker, 0);
 996   if (ret.rel_value > 0)
 997   {
 998 #if DEBUG_TRANSPORT
 999     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1000                 "Throttling read (%llu bytes excess at %u b/s), waiting %llu ms before reading more.\n",
1001                 (unsigned long long) n->in_tracker.
1002                 consumption_since_last_update__,
1003                 (unsigned int) n->in_tracker.available_bytes_per_s__,
1004                 (unsigned long long) ret.rel_value);
1005 #endif
1006     GNUNET_STATISTICS_update (GST_stats,
1007                               gettext_noop ("# ms throttling suggested"),
1008                               (int64_t) ret.rel_value, GNUNET_NO);
1009   }
1010   return ret;
1011 }
1012
1013
1014 /**
1015  * Keep the connection to the given neighbour alive longer,
1016  * we received a KEEPALIVE (or equivalent).
1017  *
1018  * @param neighbour neighbour to keep alive
1019  */
1020 void
1021 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour)
1022 {
1023   struct NeighbourMapEntry *n;
1024
1025   GNUNET_assert (neighbours != NULL);
1026
1027   n = lookup_neighbour (neighbour);
1028   if (NULL == n)
1029   {
1030     GNUNET_STATISTICS_update (GST_stats,
1031                               gettext_noop
1032                               ("# KEEPALIVE messages discarded (not connected)"),
1033                               1, GNUNET_NO);
1034     return;
1035   }
1036   GNUNET_SCHEDULER_cancel (n->timeout_task);
1037   n->timeout_task =
1038       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1039                                     &neighbour_timeout_task, n);
1040 }
1041
1042
1043 /**
1044  * Change the incoming quota for the given peer.
1045  *
1046  * @param neighbour identity of peer to change qutoa for
1047  * @param quota new quota
1048  */
1049 void
1050 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
1051                                    struct GNUNET_BANDWIDTH_Value32NBO quota)
1052 {
1053   struct NeighbourMapEntry *n;
1054
1055   GNUNET_assert (neighbours != NULL);
1056
1057   n = lookup_neighbour (neighbour);
1058   if (n == NULL)
1059   {
1060     GNUNET_STATISTICS_update (GST_stats,
1061                               gettext_noop
1062                               ("# SET QUOTA messages ignored (no such peer)"),
1063                               1, GNUNET_NO);
1064     return;
1065   }
1066   GNUNET_BANDWIDTH_tracker_update_quota (&n->in_tracker, quota);
1067   if (0 != ntohl (quota.value__))
1068     return;
1069 #if DEBUG_TRANSPORT
1070   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s' due to `%s'\n",
1071               GNUNET_i2s (&n->id), "SET_QUOTA");
1072 #endif
1073   if (GNUNET_YES == n->is_connected)
1074     GNUNET_STATISTICS_update (GST_stats,
1075                               gettext_noop ("# disconnects due to quota of 0"), 1,
1076                               GNUNET_NO);
1077   disconnect_neighbour (n);
1078 }
1079
1080
1081 /**
1082  * Closure for the neighbours_iterate function.
1083  */
1084 struct IteratorContext
1085 {
1086   /**
1087    * Function to call on each connected neighbour.
1088    */
1089   GST_NeighbourIterator cb;
1090
1091   /**
1092    * Closure for 'cb'.
1093    */
1094   void *cb_cls;
1095 };
1096
1097
1098 /**
1099  * Call the callback from the closure for each connected neighbour.
1100  *
1101  * @param cls the 'struct IteratorContext'
1102  * @param key the hash of the public key of the neighbour
1103  * @param value the 'struct NeighbourMapEntry'
1104  * @return GNUNET_OK (continue to iterate)
1105  */
1106 static int
1107 neighbours_iterate (void *cls, const GNUNET_HashCode * key, void *value)
1108 {
1109   struct IteratorContext *ic = cls;
1110   struct NeighbourMapEntry *n = value;
1111
1112   if (GNUNET_YES != n->is_connected)
1113     return GNUNET_OK;
1114
1115   ic->cb (ic->cb_cls, &n->id, NULL, 0, n->plugin_name, n->addr, n->addrlen);
1116   return GNUNET_OK;
1117 }
1118
1119
1120 /**
1121  * Iterate over all connected neighbours.
1122  *
1123  * @param cb function to call
1124  * @param cb_cls closure for cb
1125  */
1126 void
1127 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls)
1128 {
1129   struct IteratorContext ic;
1130
1131   GNUNET_assert (neighbours != NULL);
1132
1133   ic.cb = cb;
1134   ic.cb_cls = cb_cls;
1135   GNUNET_CONTAINER_multihashmap_iterate (neighbours, &neighbours_iterate, &ic);
1136 }
1137
1138
1139 /**
1140  * If we have an active connection to the given target, it must be shutdown.
1141  *
1142  * @param target peer to disconnect from
1143  */
1144 void
1145 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target)
1146 {
1147   struct NeighbourMapEntry *n;
1148   struct GNUNET_TRANSPORT_PluginFunctions *papi;
1149   struct SessionDisconnectMessage disconnect_msg;
1150
1151   GNUNET_assert (neighbours != NULL);
1152
1153   n = lookup_neighbour (target);
1154   if (NULL == n)
1155     return;                     /* not active */
1156   if (GNUNET_YES == n->is_connected)
1157   {
1158     /* we're actually connected, send DISCONNECT message */
1159     disconnect_msg.header.size = htons (sizeof (struct SessionDisconnectMessage));
1160     disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
1161     disconnect_msg.reserved = htonl (0);
1162     disconnect_msg.purpose.size = htonl (sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) +
1163                                          sizeof (struct GNUNET_TIME_AbsoluteNBO));
1164     disconnect_msg.purpose.purpose = htonl (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
1165     disconnect_msg.timestamp = GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
1166     GNUNET_assert (GNUNET_OK ==
1167                    GNUNET_CRYPTO_rsa_sign (GST_my_private_key,
1168                                            &disconnect_msg.purpose,
1169                                            &disconnect_msg.signature));
1170     papi = GST_plugins_find (n->plugin_name);
1171     if (papi != NULL)
1172       papi->send (papi->cls, target, (const void *) &disconnect_msg,
1173                   sizeof (disconnect_msg),
1174                   UINT32_MAX /* priority */ ,
1175                   GNUNET_TIME_UNIT_FOREVER_REL, n->session, n->addr, n->addrlen,
1176                   GNUNET_YES, NULL, NULL);
1177     GNUNET_STATISTICS_update (GST_stats,
1178                               gettext_noop ("# peers disconnected due to external request"), 1,
1179                               GNUNET_NO);
1180   }
1181   disconnect_neighbour (n);
1182 }
1183
1184
1185 /* end of file gnunet-service-transport_neighbours.c */