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 /**
 231  * Lookup a neighbour entry in the neighbours hash map.
 232  *
 233  * @param pid identity of the peer to look up
 234  * @return the entry, NULL if there is no existing record
 235  */
 236 static struct NeighbourMapEntry *
 237 lookup_neighbour (const struct GNUNET_PeerIdentity *pid)
 238 {
 239   return GNUNET_CONTAINER_multihashmap_get (neighbours, &pid->hashPubKey);
 240 }
 241
 242
 243 /**
 244  * Task invoked to start a transmission to another peer.
 245  *
 246  * @param cls the 'struct NeighbourMapEntry'
 247  * @param tc scheduler context
 248  */
 249 static void
 250 transmission_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 251
 252
 253 /**
 254  * We're done with our transmission attempt, continue processing.
 255  *
 256  * @param cls the 'struct MessageQueue' of the message
 257  * @param receiver intended receiver
 258  * @param success whether it worked or not
 259  */
 260 static void
 261 transmit_send_continuation (void *cls,
 262                             const struct GNUNET_PeerIdentity *receiver,
 263                             int success)
 264 {
 265   struct MessageQueue *mq;
 266   struct NeighbourMapEntry *n;
 267
 268   mq = cls;
 269   n = mq->n;
 270   if (NULL != n)
 271   {
 272     GNUNET_assert (n->is_active == mq);
 273     n->is_active = NULL;
 274     GNUNET_assert (n->transmission_task == GNUNET_SCHEDULER_NO_TASK);
 275     n->transmission_task = GNUNET_SCHEDULER_add_now (&transmission_task, n);
 276   }
 277   if (NULL != mq->cont)
 278     mq->cont (mq->cont_cls, success);
 279   GNUNET_free (mq);
 280 }
 281
 282
 283 /**
 284  * Check the ready list for the given neighbour and if a plugin is
 285  * ready for transmission (and if we have a message), do so!
 286  *
 287  * @param neighbour target peer for which to transmit
 288  */
 289 static void
 290 try_transmission_to_peer (struct NeighbourMapEntry *n)
 291 {
 292   struct MessageQueue *mq;
 293   struct GNUNET_TIME_Relative timeout;
 294   ssize_t ret;
 295   struct GNUNET_TRANSPORT_PluginFunctions *papi;
 296
 297   if (n->is_active != NULL)
 298     return;                     /* transmission already pending */
 299   if (n->transmission_task != GNUNET_SCHEDULER_NO_TASK)
 300     return;                     /* currently waiting for bandwidth */
 301   mq = n->messages_head;
 302   while (NULL != (mq = n->messages_head))
 303   {
 304     timeout = GNUNET_TIME_absolute_get_remaining (mq->timeout);
 305     if (timeout.rel_value > 0)
 306       break;
 307     transmit_send_continuation (mq, &n->id, GNUNET_SYSERR);     /* timeout */
 308   }
 309   if (NULL == mq)
 310     return;                     /* no more messages */
 311
 312   papi = GST_plugins_find (n->plugin_name);
 313   if (papi == NULL)
 314   {
 315     GNUNET_break (0);
 316     return;
 317   }
 318   GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
 319   n->is_active = mq;
 320   mq->n = n;
 321   ret =
 322       papi->send (papi->cls, &n->id, mq->message_buf, mq->message_buf_size,
 323                   0 /* priority -- remove from plugin API? */ ,
 324                   timeout, n->session, n->addr, n->addrlen, GNUNET_YES,
 325                   &transmit_send_continuation, mq);
 326   if (ret == -1)
 327   {
 328     /* failure, but 'send' would not call continuation in this case,
 329      * so we need to do it here! */
 330     transmit_send_continuation (mq, &n->id, GNUNET_SYSERR);
 331     n->transmission_task = GNUNET_SCHEDULER_add_now (&transmission_task, n);
 332   }
 333 }
 334
 335
 336 /**
 337  * Task invoked to start a transmission to another peer.
 338  *
 339  * @param cls the 'struct NeighbourMapEntry'
 340  * @param tc scheduler context
 341  */
 342 static void
 343 transmission_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 344 {
 345   struct NeighbourMapEntry *n = cls;
 346
 347   n->transmission_task = GNUNET_SCHEDULER_NO_TASK;
 348   try_transmission_to_peer (n);
 349 }
 350
 351
 352 /**
 353  * Initialize the neighbours subsystem.
 354  *
 355  * @param cls closure for callbacks
 356  * @param connect_cb function to call if we connect to a peer
 357  * @param disconnect_cb function to call if we disconnect from a peer
 358  */
 359 void
 360 GST_neighbours_start (void *cls, GNUNET_TRANSPORT_NotifyConnect connect_cb,
 361                       GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb)
 362 {
 363   callback_cls = cls;
 364   connect_notify_cb = connect_cb;
 365   disconnect_notify_cb = disconnect_cb;
 366   neighbours = GNUNET_CONTAINER_multihashmap_create (NEIGHBOUR_TABLE_SIZE);
 367 }
 368
 369
 370 /**
 371  * Disconnect from the given neighbour, clean up the record.
 372  *
 373  * @param n neighbour to disconnect from
 374  */
 375 static void
 376 disconnect_neighbour (struct NeighbourMapEntry *n)
 377 {
 378   struct MessageQueue *mq;
 379
 380   if (GNUNET_YES == n->in_disconnect)
 381     return;
 382   n->in_disconnect = GNUNET_YES;
 383   while (NULL != (mq = n->messages_head))
 384   {
 385     GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
 386     mq->cont (mq->cont_cls, GNUNET_SYSERR);
 387     GNUNET_free (mq);
 388   }
 389   if (NULL != n->is_active)
 390   {
 391     n->is_active->n = NULL;
 392     n->is_active = NULL;
 393   }
 394   if (GNUNET_YES == n->is_connected)
 395   {
 396     n->is_connected = GNUNET_NO;
 397     disconnect_notify_cb (callback_cls, &n->id);
 398   }
 399   GNUNET_assert (GNUNET_YES ==
 400                  GNUNET_CONTAINER_multihashmap_remove (neighbours,
 401                                                        &n->id.hashPubKey, n));
 402   if (GNUNET_SCHEDULER_NO_TASK != n->timeout_task)
 403   {
 404     GNUNET_SCHEDULER_cancel (n->timeout_task);
 405     n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 406   }
 407   if (GNUNET_SCHEDULER_NO_TASK != n->transmission_task)
 408   {
 409     GNUNET_SCHEDULER_cancel (n->timeout_task);
 410     n->transmission_task = GNUNET_SCHEDULER_NO_TASK;
 411   }
 412   if (NULL != n->asc)
 413   {
 414     GNUNET_ATS_suggest_address_cancel (n->asc);
 415     n->asc = NULL;
 416   }
 417   GNUNET_array_grow (n->ats, n->ats_count, 0);
 418   if (NULL != n->plugin_name)
 419   {
 420     GNUNET_free (n->plugin_name);
 421     n->plugin_name = NULL;
 422   }
 423   if (NULL != n->addr)
 424   {
 425     GNUNET_free (n->addr);
 426     n->addr = NULL;
 427     n->addrlen = 0;
 428   }
 429   n->session = NULL;
 430   GNUNET_free (n);
 431 }
 432
 433
 434 /**
 435  * Peer has been idle for too long. Disconnect.
 436  *
 437  * @param cls the 'struct NeighbourMapEntry' of the neighbour that went idle
 438  * @param tc scheduler context
 439  */
 440 static void
 441 neighbour_timeout_task (void *cls,
 442                         const struct GNUNET_SCHEDULER_TaskContext *tc)
 443 {
 444   struct NeighbourMapEntry *n = cls;
 445
 446   n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 447   disconnect_neighbour (n);
 448 }
 449
 450
 451 /**
 452  * Disconnect from the given neighbour.
 453  *
 454  * @param cls unused
 455  * @param key hash of neighbour's public key (not used)
 456  * @param value the 'struct NeighbourMapEntry' of the neighbour
 457  */
 458 static int
 459 disconnect_all_neighbours (void *cls, const GNUNET_HashCode * key, void *value)
 460 {
 461   struct NeighbourMapEntry *n = value;
 462
 463 #if DEBUG_TRANSPORT
 464   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s', %s\n",
 465               GNUNET_i2s (&n->id), "SHUTDOWN_TASK");
 466 #endif
 467   disconnect_neighbour (n);
 468   return GNUNET_OK;
 469 }
 470
 471
 472 /**
 473  * Cleanup the neighbours subsystem.
 474  */
 475 void
 476 GST_neighbours_stop ()
 477 {
 478   GNUNET_CONTAINER_multihashmap_iterate (neighbours, &disconnect_all_neighbours,
 479                                          NULL);
 480   GNUNET_CONTAINER_multihashmap_destroy (neighbours);
 481   neighbours = NULL;
 482   callback_cls = NULL;
 483   connect_notify_cb = NULL;
 484   disconnect_notify_cb = NULL;
 485 }
 486
 487
 488 /**
 489  * For an existing neighbour record, set the active connection to
 490  * the given address.
 491  *
 492  * @param peer identity of the peer to switch the address for
 493  * @param plugin_name name of transport that delivered the PONG
 494  * @param address address of the other peer, NULL if other peer
 495  *                       connected to us
 496  * @param address_len number of bytes in address
 497  * @param session session to use (or NULL)
 498  * @param ats performance data
 499  * @param ats_count number of entries in ats (excluding 0-termination)
 500  */
 501 void
 502 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
 503                                   const char *plugin_name, const void *address,
 504                                   size_t address_len, struct Session *session,
 505                                   const struct GNUNET_TRANSPORT_ATS_Information
 506                                   *ats, uint32_t ats_count)
 507 {
 508   struct NeighbourMapEntry *n;
 509   struct GNUNET_MessageHeader connect_msg;
 510
 511   n = lookup_neighbour (peer);
 512   if (NULL == n)
 513   {
 514     GNUNET_break (0);
 515     return;
 516   }
 517   GNUNET_free_non_null (n->addr);
 518   n->addr = GNUNET_malloc (address_len);
 519   memcpy (n->addr, address, address_len);
 520   n->addrlen = address_len;
 521   n->session = session;
 522   GNUNET_array_grow (n->ats, n->ats_count, ats_count);
 523   memcpy (n->ats, ats,
 524           ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
 525   GNUNET_free_non_null (n->plugin_name);
 526   n->plugin_name = GNUNET_strdup (plugin_name);
 527   GNUNET_SCHEDULER_cancel (n->timeout_task);
 528   n->timeout_task =
 529       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 530                                     &neighbour_timeout_task, n);
 531   connect_msg.size = htons (sizeof (struct GNUNET_MessageHeader));
 532   connect_msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
 533   GST_neighbours_send (peer, &connect_msg, sizeof (connect_msg),
 534                        GNUNET_TIME_UNIT_FOREVER_REL, NULL, NULL);
 535 }
 536
 537
 538 /**
 539  * Try to connect to the target peer using the given address
 540  *
 541  * @param cls the 'struct NeighbourMapEntry' of the target
 542  * @param target identity of the target peer
 543  * @param plugin_name name of the plugin
 544  * @param plugin_address binary address
 545  * @param plugin_address_len length of address
 546  * @param bandwidth available bandwidth
 547  * @param ats performance data for the address (as far as known)
 548  * @param ats_count number of performance records in 'ats'
 549  */
 550 static void
 551 try_connect_using_address (void *cls, const struct GNUNET_PeerIdentity *target,
 552                            const char *plugin_name, const void *plugin_address,
 553                            size_t plugin_address_len,
 554                            struct GNUNET_BANDWIDTH_Value32NBO bandwidth,
 555                            const struct GNUNET_TRANSPORT_ATS_Information *ats,
 556                            uint32_t ats_count)
 557 {
 558   struct NeighbourMapEntry *n = cls;
 559
 560   n->asc = NULL;
 561   GST_neighbours_switch_to_address (target, plugin_name, plugin_address,
 562                                     plugin_address_len, NULL, ats, ats_count);
 563   if (GNUNET_YES == n->is_connected)
 564     return;
 565   n->is_connected = GNUNET_YES;
 566   connect_notify_cb (callback_cls, target, n->ats, n->ats_count);
 567 }
 568
 569
 570 /**
 571  * Try to create a connection to the given target (eventually).
 572  *
 573  * @param target peer to try to connect to
 574  */
 575 void
 576 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target)
 577 {
 578   struct NeighbourMapEntry *n;
 579
 580   GNUNET_assert (0 !=
 581                  memcmp (target, &GST_my_identity,
 582                          sizeof (struct GNUNET_PeerIdentity)));
 583   n = lookup_neighbour (target);
 584   if ((NULL != n) && (GNUNET_YES == n->is_connected))
 585     return;                     /* already connected */
 586   if (n == NULL)
 587   {
 588     n = GNUNET_malloc (sizeof (struct NeighbourMapEntry));
 589     n->id = *target;
 590     GNUNET_BANDWIDTH_tracker_init (&n->in_tracker,
 591                                    GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
 592                                    MAX_BANDWIDTH_CARRY_S);
 593     n->timeout_task =
 594         GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 595                                       &neighbour_timeout_task, n);
 596     GNUNET_assert (GNUNET_OK ==
 597                    GNUNET_CONTAINER_multihashmap_put (neighbours,
 598                                                       &n->id.hashPubKey, n,
 599                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 600   }
 601   if (n->asc != NULL)
 602     return;                     /* already trying */
 603   n->asc =
 604       GNUNET_ATS_suggest_address (GST_ats, target, &try_connect_using_address,
 605                                   n);
 606 }
 607
 608
 609 /**
 610  * Test if we're connected to the given peer.
 611  *
 612  * @param target peer to test
 613  * @return GNUNET_YES if we are connected, GNUNET_NO if not
 614  */
 615 int
 616 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target)
 617 {
 618   struct NeighbourMapEntry *n;
 619
 620   n = lookup_neighbour (target);
 621   if ((NULL == n) || (n->is_connected == GNUNET_YES))
 622     return GNUNET_NO;           /* not connected */
 623   return GNUNET_YES;
 624 }
 625
 626
 627 /**
 628  * A session was terminated. Take note.
 629  *
 630  * @param peer identity of the peer where the session died
 631  * @param session session that is gone
 632  */
 633 void
 634 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
 635                                    struct Session *session)
 636 {
 637   struct NeighbourMapEntry *n;
 638
 639   n = lookup_neighbour (peer);
 640   if (NULL == n)
 641     return;
 642   if (session != n->session)
 643     return;                     /* doesn't affect us */
 644   n->session = NULL;
 645   if (GNUNET_YES != n->is_connected)
 646     return;                     /* not connected anymore anyway, shouldn't matter */
 647   /* try QUICKLY to re-establish a connection, reduce timeout! */
 648   if (NULL != n->ats)
 649   {
 650     /* how can this be!? */
 651     GNUNET_break (0);
 652     return;
 653   }
 654   GNUNET_SCHEDULER_cancel (n->timeout_task);
 655   n->timeout_task =
 656       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 657                                     &neighbour_timeout_task, n);
 658   n->asc =
 659       GNUNET_ATS_suggest_address (GST_ats, peer, &try_connect_using_address, n);
 660 }
 661
 662
 663 /**
 664  * Transmit a message to the given target using the active connection.
 665  *
 666  * @param target destination
 667  * @param msg message to send
 668  * @param msg_size number of bytes in msg
 669  * @param timeout when to fail with timeout
 670  * @param cont function to call when done
 671  * @param cont_cls closure for 'cont'
 672  */
 673 void
 674 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
 675                      size_t msg_size, struct GNUNET_TIME_Relative timeout,
 676                      GST_NeighbourSendContinuation cont, void *cont_cls)
 677 {
 678   struct NeighbourMapEntry *n;
 679   struct MessageQueue *mq;
 680
 681   n = lookup_neighbour (target);
 682   if ((n == NULL) || (GNUNET_YES != n->is_connected))
 683   {
 684     GNUNET_STATISTICS_update (GST_stats,
 685                               gettext_noop
 686                               ("# SET QUOTA messages ignored (no such peer)"),
 687                               1, GNUNET_NO);
 688     if (NULL != cont)
 689       cont (cont_cls, GNUNET_SYSERR);
 690     return;
 691   }
 692   GNUNET_assert (msg_size >= sizeof (struct GNUNET_MessageHeader));
 693   GNUNET_STATISTICS_update (GST_stats,
 694                             gettext_noop
 695                             ("# bytes in message queue for other peers"),
 696                             msg_size, GNUNET_NO);
 697   mq = GNUNET_malloc (sizeof (struct MessageQueue) + msg_size);
 698   mq->cont = cont;
 699   mq->cont_cls = cont_cls;
 700   /* FIXME: this memcpy can be up to 7% of our total runtime! */
 701   memcpy (&mq[1], msg, msg_size);
 702   mq->message_buf = (const char *) &mq[1];
 703   mq->message_buf_size = msg_size;
 704   mq->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 705   GNUNET_CONTAINER_DLL_insert_tail (n->messages_head, n->messages_tail, mq);
 706   if ((GNUNET_SCHEDULER_NO_TASK == n->transmission_task) &&
 707       (NULL == n->is_active))
 708     n->transmission_task = GNUNET_SCHEDULER_add_now (&transmission_task, n);
 709 }
 710
 711
 712 /**
 713  * We have received a message from the given sender.  How long should
 714  * we delay before receiving more?  (Also used to keep the peer marked
 715  * as live).
 716  *
 717  * @param sender sender of the message
 718  * @param size size of the message
 719  * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
 720  *                   GNUNET_NO if the neighbour is not connected or violates the quota
 721  * @return how long to wait before reading more from this sender
 722  */
 723 struct GNUNET_TIME_Relative
 724 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
 725                                         *sender, ssize_t size, int *do_forward)
 726 {
 727   struct NeighbourMapEntry *n;
 728   struct GNUNET_TIME_Relative ret;
 729
 730   n = lookup_neighbour (sender);
 731   if (n == NULL)
 732   {
 733     *do_forward = GNUNET_NO;
 734     return GNUNET_TIME_UNIT_ZERO;
 735   }
 736   if (GNUNET_YES == GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, size))
 737   {
 738     n->quota_violation_count++;
 739 #if DEBUG_TRANSPORT
 740     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 741                 "Bandwidth quota (%u b/s) violation detected (total of %u).\n",
 742                 n->in_tracker.available_bytes_per_s__,
 743                 n->quota_violation_count);
 744 #endif
 745     /* Discount 32k per violation */
 746     GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, -32 * 1024);
 747   }
 748   else
 749   {
 750     if (n->quota_violation_count > 0)
 751     {
 752       /* try to add 32k back */
 753       GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, 32 * 1024);
 754       n->quota_violation_count--;
 755     }
 756   }
 757   if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
 758   {
 759     GNUNET_STATISTICS_update (GST_stats,
 760                               gettext_noop
 761                               ("# bandwidth quota violations by other peers"),
 762                               1, GNUNET_NO);
 763     *do_forward = GNUNET_NO;
 764     return GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT;
 765   }
 766   *do_forward = GNUNET_YES;
 767   ret = GNUNET_BANDWIDTH_tracker_get_delay (&n->in_tracker, 0);
 768   if (ret.rel_value > 0)
 769   {
 770 #if DEBUG_TRANSPORT
 771     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 772                 "Throttling read (%llu bytes excess at %u b/s), waiting %llu ms before reading more.\n",
 773                 (unsigned long long) n->
 774                 in_tracker.consumption_since_last_update__,
 775                 (unsigned int) n->in_tracker.available_bytes_per_s__,
 776                 (unsigned long long) ret.rel_value);
 777 #endif
 778     GNUNET_STATISTICS_update (GST_stats,
 779                               gettext_noop ("# ms throttling suggested"),
 780                               (int64_t) ret.rel_value, GNUNET_NO);
 781   }
 782   return ret;
 783 }
 784
 785
 786 /**
 787  * Keep the connection to the given neighbour alive longer,
 788  * we received a KEEPALIVE (or equivalent).
 789  *
 790  * @param neighbour neighbour to keep alive
 791  */
 792 void
 793 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour)
 794 {
 795   struct NeighbourMapEntry *n;
 796
 797   n = lookup_neighbour (neighbour);
 798   if (NULL == n)
 799   {
 800     GNUNET_STATISTICS_update (GST_stats,
 801                               gettext_noop
 802                               ("# KEEPALIVE messages discarded (not connected)"),
 803                               1, GNUNET_NO);
 804     return;
 805   }
 806   GNUNET_SCHEDULER_cancel (n->timeout_task);
 807   n->timeout_task =
 808       GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 809                                     &neighbour_timeout_task, n);
 810 }
 811
 812
 813 /**
 814  * Change the incoming quota for the given peer.
 815  *
 816  * @param neighbour identity of peer to change qutoa for
 817  * @param quota new quota
 818  */
 819 void
 820 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
 821                                    struct GNUNET_BANDWIDTH_Value32NBO quota)
 822 {
 823   struct NeighbourMapEntry *n;
 824
 825   n = lookup_neighbour (neighbour);
 826   if (n == NULL)
 827   {
 828     GNUNET_STATISTICS_update (GST_stats,
 829                               gettext_noop
 830                               ("# SET QUOTA messages ignored (no such peer)"),
 831                               1, GNUNET_NO);
 832     return;
 833   }
 834   GNUNET_BANDWIDTH_tracker_update_quota (&n->in_tracker, quota);
 835   if (0 != ntohl (quota.value__))
 836     return;
 837 #if DEBUG_TRANSPORT
 838   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s' due to `%s'\n",
 839               GNUNET_i2s (&n->id), "SET_QUOTA");
 840 #endif
 841   GNUNET_STATISTICS_update (GST_stats,
 842                             gettext_noop ("# disconnects due to quota of 0"), 1,
 843                             GNUNET_NO);
 844   disconnect_neighbour (n);
 845 }
 846
 847
 848 /**
 849  * Closure for the neighbours_iterate function.
 850  */
 851 struct IteratorContext
 852 {
 853   /**
 854    * Function to call on each connected neighbour.
 855    */
 856   GST_NeighbourIterator cb;
 857
 858   /**
 859    * Closure for 'cb'.
 860    */
 861   void *cb_cls;
 862 };
 863
 864
 865 /**
 866  * Call the callback from the closure for each connected neighbour.
 867  *
 868  * @param cls the 'struct IteratorContext'
 869  * @param key the hash of the public key of the neighbour
 870  * @param value the 'struct NeighbourMapEntry'
 871  * @return GNUNET_OK (continue to iterate)
 872  */
 873 static int
 874 neighbours_iterate (void *cls, const GNUNET_HashCode * key, void *value)
 875 {
 876   struct IteratorContext *ic = cls;
 877   struct NeighbourMapEntry *n = value;
 878
 879   if (GNUNET_YES != n->is_connected)
 880     return GNUNET_OK;
 881   GNUNET_assert (n->ats_count > 0);
 882   ic->cb (ic->cb_cls, &n->id, n->ats, n->ats_count - 1);
 883   return GNUNET_OK;
 884 }
 885
 886
 887 /**
 888  * Iterate over all connected neighbours.
 889  *
 890  * @param cb function to call
 891  * @param cb_cls closure for cb
 892  */
 893 void
 894 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls)
 895 {
 896   struct IteratorContext ic;
 897
 898   ic.cb = cb;
 899   ic.cb_cls = cb_cls;
 900   GNUNET_CONTAINER_multihashmap_iterate (neighbours, &neighbours_iterate, &ic);
 901 }
 902
 903
 904 /**
 905  * If we have an active connection to the given target, it must be shutdown.
 906  *
 907  * @param target peer to disconnect from
 908  */
 909 void
 910 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target)
 911 {
 912   struct NeighbourMapEntry *n;
 913   struct GNUNET_TRANSPORT_PluginFunctions *papi;
 914   struct GNUNET_MessageHeader disconnect_msg;
 915
 916   n = lookup_neighbour (target);
 917   if (NULL == n)
 918     return;                     /* not active */
 919   if (GNUNET_YES == n->is_connected)
 920   {
 921     /* we're actually connected, send DISCONNECT message */
 922     disconnect_msg.size = htons (sizeof (struct GNUNET_MessageHeader));
 923     disconnect_msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
 924     papi = GST_plugins_find (n->plugin_name);
 925     if (papi != NULL)
 926       papi->send (papi->cls, target, (const void *) &disconnect_msg,
 927                   sizeof (struct GNUNET_MessageHeader),
 928                   UINT32_MAX /* priority */ ,
 929                   GNUNET_TIME_UNIT_FOREVER_REL, n->session, n->addr, n->addrlen,
 930                   GNUNET_YES, NULL, NULL);
 931   }
 932   disconnect_neighbour (n);
 933 }
 934
 935
 936 /* end of file gnunet-service-transport_neighbours.c */