src/transport/transport_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009-2013 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/transport_api.c
  23  * @brief library to access the low-level P2P IO service
  24  * @author Christian Grothoff
  25  *
  26  * TODO:
  27  * - test test test
  28  */
  29 #include "platform.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_constants.h"
  32 #include "gnunet_arm_service.h"
  33 #include "gnunet_hello_lib.h"
  34 #include "gnunet_protocols.h"
  35 #include "gnunet_transport_service.h"
  36 #include "transport.h"
  37
  38 #define LOG(kind,...) GNUNET_log_from (kind, "transport-api",__VA_ARGS__)
  39
  40 /**
  41  * How large to start with for the hashmap of neighbours.
  42  */
  43 #define STARTING_NEIGHBOURS_SIZE 16
  44
  45 /**
  46  * Handle for a message that should be transmitted to the service.
  47  * Used for both control messages and normal messages.
  48  */
  49 struct GNUNET_TRANSPORT_TransmitHandle
  50 {
  51
  52   /**
  53    * We keep all requests in a DLL.
  54    */
  55   struct GNUNET_TRANSPORT_TransmitHandle *next;
  56
  57   /**
  58    * We keep all requests in a DLL.
  59    */
  60   struct GNUNET_TRANSPORT_TransmitHandle *prev;
  61
  62   /**
  63    * Neighbour for this handle, NULL for control messages.
  64    */
  65   struct Neighbour *neighbour;
  66
  67   /**
  68    * Function to call when notify_size bytes are available
  69    * for transmission.
  70    */
  71   GNUNET_TRANSPORT_TransmitReadyNotify notify;
  72
  73   /**
  74    * Closure for notify.
  75    */
  76   void *notify_cls;
  77
  78   /**
  79    * Timeout for this request, 0 for control messages.
  80    */
  81   struct GNUNET_TIME_Absolute timeout;
  82
  83   /**
  84    * Task to trigger request timeout if the request is stalled due to
  85    * congestion.
  86    */
  87   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
  88
  89   /**
  90    * How many bytes is our notify callback waiting for?
  91    */
  92   size_t notify_size;
  93
  94 };
  95
  96
  97 /**
  98  * Entry in hash table of all of our current neighbours.
  99  */
 100 struct Neighbour
 101 {
 102   /**
 103    * Overall transport handle.
 104    */
 105   struct GNUNET_TRANSPORT_Handle *h;
 106
 107   /**
 108    * Active transmit handle or NULL.
 109    */
 110   struct GNUNET_TRANSPORT_TransmitHandle *th;
 111
 112   /**
 113    * Identity of this neighbour.
 114    */
 115   struct GNUNET_PeerIdentity id;
 116
 117   /**
 118    * Outbound bandwidh tracker.
 119    */
 120   struct GNUNET_BANDWIDTH_Tracker out_tracker;
 121
 122   /**
 123    * Entry in our readyness heap (which is sorted by 'next_ready'
 124    * value).  NULL if there is no pending transmission request for
 125    * this neighbour or if we're waiting for 'is_ready' to become
 126    * true AFTER the 'out_tracker' suggested that this peer's quota
 127    * has been satisfied (so once 'is_ready' goes to GNUNET_YES,
 128    * we should immediately go back into the heap).
 129    */
 130   struct GNUNET_CONTAINER_HeapNode *hn;
 131
 132   /**
 133    * Is this peer currently ready to receive a message?
 134    */
 135   int is_ready;
 136
 137   /**
 138    * Sending consumed more bytes on wire than payload was announced
 139    * This overhead is added to the delay of next sending operation
 140    */
 141   size_t traffic_overhead;
 142 };
 143
 144
 145 /**
 146  * Linked list of functions to call whenever our HELLO is updated.
 147  */
 148 struct GNUNET_TRANSPORT_GetHelloHandle
 149 {
 150
 151   /**
 152    * This is a doubly linked list.
 153    */
 154   struct GNUNET_TRANSPORT_GetHelloHandle *next;
 155
 156   /**
 157    * This is a doubly linked list.
 158    */
 159   struct GNUNET_TRANSPORT_GetHelloHandle *prev;
 160
 161   /**
 162    * Transport handle.
 163    */
 164   struct GNUNET_TRANSPORT_Handle *handle;
 165
 166   /**
 167    * Callback to call once we got our HELLO.
 168    */
 169   GNUNET_TRANSPORT_HelloUpdateCallback rec;
 170
 171   /**
 172    * Task for calling the HelloUpdateCallback when we already have a HELLO
 173    */
 174   GNUNET_SCHEDULER_TaskIdentifier notify_task;
 175
 176   /**
 177    * Closure for @e rec.
 178    */
 179   void *rec_cls;
 180
 181 };
 182
 183 /**
 184  * Linked list for all try-connect requests
 185  */
 186 struct GNUNET_TRANSPORT_TryConnectHandle
 187 {
 188   /**
 189    * For the DLL.
 190    */
 191   struct GNUNET_TRANSPORT_TryConnectHandle *prev;
 192
 193   /**
 194    * For the DLL.
 195    */
 196   struct GNUNET_TRANSPORT_TryConnectHandle *next;
 197
 198   struct GNUNET_PeerIdentity pid;
 199
 200   struct GNUNET_TRANSPORT_Handle *th;
 201
 202   struct GNUNET_TRANSPORT_TransmitHandle *tth;
 203
 204   GNUNET_TRANSPORT_TryConnectCallback cb;
 205
 206   /**
 207    * Closure for @e cb.
 208    */
 209   void *cb_cls;
 210 };
 211
 212
 213 /**
 214  * Linked list for all try-connect requests
 215  */
 216 struct GNUNET_TRANSPORT_OfferHelloHandle
 217 {
 218   /**
 219    * For the DLL.
 220    */
 221   struct GNUNET_TRANSPORT_OfferHelloHandle *prev;
 222
 223   /**
 224    * For the DLL.
 225    */
 226   struct GNUNET_TRANSPORT_OfferHelloHandle *next;
 227
 228   struct GNUNET_TRANSPORT_Handle *th;
 229
 230   struct GNUNET_TRANSPORT_TransmitHandle *tth;
 231
 232   GNUNET_SCHEDULER_Task cont;
 233
 234   /**
 235    * Closure for @e cont
 236    */
 237   void *cls;
 238
 239   struct GNUNET_MessageHeader *msg;
 240 };
 241
 242
 243 /**
 244  * Handle for the transport service (includes all of the
 245  * state for the transport service).
 246  */
 247 struct GNUNET_TRANSPORT_Handle
 248 {
 249
 250   /**
 251    * Closure for the callbacks.
 252    */
 253   void *cls;
 254
 255   /**
 256    * Function to call for received data.
 257    */
 258   GNUNET_TRANSPORT_ReceiveCallback rec;
 259
 260   /**
 261    * function to call on connect events
 262    */
 263   GNUNET_TRANSPORT_NotifyConnect nc_cb;
 264
 265   /**
 266    * function to call on disconnect events
 267    */
 268   GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
 269
 270   /**
 271    * function to call on excess bandwidth events
 272    */
 273   GNUNET_TRANSPORT_NotifyExcessBandwidth neb_cb;
 274
 275   /**
 276    * Head of DLL of control messages.
 277    */
 278   struct GNUNET_TRANSPORT_TransmitHandle *control_head;
 279
 280   /**
 281    * Tail of DLL of control messages.
 282    */
 283   struct GNUNET_TRANSPORT_TransmitHandle *control_tail;
 284
 285   /**
 286    * The current HELLO message for this peer.  Updated
 287    * whenever transports change their addresses.
 288    */
 289   struct GNUNET_HELLO_Message *my_hello;
 290
 291   /**
 292    * My client connection to the transport service.
 293    */
 294   struct GNUNET_CLIENT_Connection *client;
 295
 296   /**
 297    * Handle to our registration with the client for notification.
 298    */
 299   struct GNUNET_CLIENT_TransmitHandle *cth;
 300
 301   /**
 302    * Linked list of pending requests for our HELLO.
 303    */
 304   struct GNUNET_TRANSPORT_GetHelloHandle *hwl_head;
 305
 306   /**
 307    * Linked list of pending requests for our HELLO.
 308    */
 309   struct GNUNET_TRANSPORT_GetHelloHandle *hwl_tail;
 310
 311   /**
 312    * Linked list of pending try connect requests head
 313    */
 314   struct GNUNET_TRANSPORT_TryConnectHandle *tc_head;
 315
 316   /**
 317    * Linked list of pending try connect requests tail
 318    */
 319   struct GNUNET_TRANSPORT_TryConnectHandle *tc_tail;
 320
 321   /**
 322    * Linked list of pending offer HELLO requests head
 323    */
 324   struct GNUNET_TRANSPORT_OfferHelloHandle *oh_head;
 325
 326   /**
 327    * Linked list of pending offer HELLO requests tail
 328    */
 329   struct GNUNET_TRANSPORT_OfferHelloHandle *oh_tail;
 330
 331   /**
 332    * My configuration.
 333    */
 334   const struct GNUNET_CONFIGURATION_Handle *cfg;
 335
 336   /**
 337    * Hash map of the current connected neighbours of this peer.
 338    * Maps peer identities to 'struct Neighbour' entries.
 339    */
 340   struct GNUNET_CONTAINER_MultiPeerMap *neighbours;
 341
 342   /**
 343    * Heap sorting peers with pending messages by the timestamps that
 344    * specify when we could next send a message to the respective peer.
 345    * Excludes control messages (which can always go out immediately).
 346    * Maps time stamps to 'struct Neighbour' entries.
 347    */
 348   struct GNUNET_CONTAINER_Heap *ready_heap;
 349
 350   /**
 351    * Peer identity as assumed by this process, or all zeros.
 352    */
 353   struct GNUNET_PeerIdentity self;
 354
 355   /**
 356    * ID of the task trying to reconnect to the service.
 357    */
 358   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
 359
 360   /**
 361    * ID of the task trying to trigger transmission for a peer while
 362    * maintaining bandwidth quotas.  In use if there are no control
 363    * messages and the smallest entry in the 'ready_heap' has a time
 364    * stamp in the future.
 365    */
 366   GNUNET_SCHEDULER_TaskIdentifier quota_task;
 367
 368   /**
 369    * Delay until we try to reconnect.
 370    */
 371   struct GNUNET_TIME_Relative reconnect_delay;
 372
 373   /**
 374    * Should we check that @e self matches what the service thinks?
 375    * (if #GNUNET_NO, then @e self is all zeros!).
 376    */
 377   int check_self;
 378
 379   /**
 380    * Reconnect in progress
 381    */
 382   int reconnecting;
 383 };
 384
 385
 386
 387 /**
 388  * Schedule the task to send one message, either from the control
 389  * list or the peer message queues  to the service.
 390  *
 391  * @param h transport service to schedule a transmission for
 392  */
 393 static void
 394 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
 395
 396
 397 /**
 398  * Function that will schedule the job that will try
 399  * to connect us again to the client.
 400  *
 401  * @param h transport service to reconnect
 402  */
 403 static void
 404 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h);
 405
 406
 407 /**
 408  * Get the neighbour list entry for the given peer
 409  *
 410  * @param h our context
 411  * @param peer peer to look up
 412  * @return NULL if no such peer entry exists
 413  */
 414 static struct Neighbour *
 415 neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
 416                 const struct GNUNET_PeerIdentity *peer)
 417 {
 418   return GNUNET_CONTAINER_multipeermap_get (h->neighbours, peer);
 419 }
 420
 421
 422 /**
 423  * The outbound quota has changed in a way that may require
 424  * us to reset the timeout.  Update the timeout.
 425  *
 426  * @param cls the `struct Neighbour` for which the timeout changed
 427  */
 428 static void
 429 outbound_bw_tracker_update (void *cls)
 430 {
 431   struct Neighbour *n = cls;
 432   struct GNUNET_TIME_Relative delay;
 433
 434   if (NULL == n->hn)
 435     return;
 436   delay = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
 437       n->th->notify_size + n->traffic_overhead);
 438   LOG (GNUNET_ERROR_TYPE_DEBUG,
 439        "New outbound delay %llu us\n",
 440        GNUNET_STRINGS_relative_time_to_string (delay,
 441                                                GNUNET_NO));
 442   GNUNET_CONTAINER_heap_update_cost (n->h->ready_heap,
 443       n->hn, delay.rel_value_us);
 444   schedule_transmission (n->h);
 445 }
 446
 447
 448 /**
 449  * Function called by the bandwidth tracker if we have excess
 450  * bandwidth.
 451  *
 452  * @param cls the `struct Neighbour` that has excess bandwidth
 453  */
 454 static void
 455 notify_excess_cb (void *cls)
 456 {
 457   struct Neighbour *n = cls;
 458   struct GNUNET_TRANSPORT_Handle *h = n->h;
 459
 460   if (NULL != h->neb_cb)
 461     h->neb_cb (h->cls,
 462                &n->id);
 463 }
 464
 465
 466 /**
 467  * Add neighbour to our list
 468  *
 469  * @return NULL if this API is currently disconnecting from the service
 470  */
 471 static struct Neighbour *
 472 neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
 473                const struct GNUNET_PeerIdentity *pid)
 474 {
 475   struct Neighbour *n;
 476
 477   LOG (GNUNET_ERROR_TYPE_DEBUG,
 478        "Creating entry for neighbour `%4s'.\n",
 479        GNUNET_i2s (pid));
 480   n = GNUNET_new (struct Neighbour);
 481   n->id = *pid;
 482   n->h = h;
 483   n->is_ready = GNUNET_YES;
 484   n->traffic_overhead = 0;
 485   GNUNET_BANDWIDTH_tracker_init2 (&n->out_tracker,
 486                                   &outbound_bw_tracker_update, n,
 487                                   GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
 488                                   MAX_BANDWIDTH_CARRY_S,
 489                                   &notify_excess_cb,
 490                                   n);
 491   GNUNET_assert (GNUNET_OK ==
 492                  GNUNET_CONTAINER_multipeermap_put (h->neighbours,
 493                                                     &n->id, n,
 494                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 495   return n;
 496 }
 497
 498
 499 /**
 500  * Iterator over hash map entries, for deleting state of a neighbour.
 501  *
 502  * @param cls the `struct GNUNET_TRANSPORT_Handle *`
 503  * @param key peer identity
 504  * @param value value in the hash map, the neighbour entry to delete
 505  * @return #GNUNET_YES if we should continue to
 506  *         iterate,
 507  *         #GNUNET_NO if not.
 508  */
 509 static int
 510 neighbour_delete (void *cls,
 511                   const struct GNUNET_PeerIdentity *key, void *value)
 512 {
 513   struct GNUNET_TRANSPORT_Handle *handle = cls;
 514   struct Neighbour *n = value;
 515
 516   if (NULL != handle->nd_cb)
 517     handle->nd_cb (handle->cls, &n->id);
 518   GNUNET_assert (NULL == n->th);
 519   GNUNET_assert (NULL == n->hn);
 520   GNUNET_assert (GNUNET_YES ==
 521                  GNUNET_CONTAINER_multipeermap_remove (handle->neighbours, key,
 522                                                        n));
 523   GNUNET_free (n);
 524   return GNUNET_YES;
 525 }
 526
 527
 528 /**
 529  * Function we use for handling incoming messages.
 530  *
 531  * @param cls closure, a `struct GNUNET_TRANSPORT_Handle *`
 532  * @param msg message received, NULL on timeout or fatal error
 533  */
 534 static void
 535 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
 536 {
 537   struct GNUNET_TRANSPORT_Handle *h = cls;
 538   const struct DisconnectInfoMessage *dim;
 539   const struct ConnectInfoMessage *cim;
 540   const struct InboundMessage *im;
 541   const struct GNUNET_MessageHeader *imm;
 542   const struct SendOkMessage *okm;
 543   const struct QuotaSetMessage *qm;
 544   struct GNUNET_TRANSPORT_GetHelloHandle *hwl;
 545   struct GNUNET_TRANSPORT_GetHelloHandle *next_hwl;
 546   struct Neighbour *n;
 547   struct GNUNET_PeerIdentity me;
 548   uint16_t size;
 549   uint32_t bytes_msg;
 550   uint32_t bytes_physical;
 551
 552   GNUNET_assert (NULL != h->client);
 553   if (GNUNET_YES == h->reconnecting)
 554   {
 555     return;
 556   }
 557   if (NULL == msg)
 558   {
 559     LOG (GNUNET_ERROR_TYPE_DEBUG,
 560          "Error receiving from transport service, disconnecting temporarily.\n");
 561     h->reconnecting = GNUNET_YES;
 562     disconnect_and_schedule_reconnect (h);
 563     return;
 564   }
 565   GNUNET_CLIENT_receive (h->client, &demultiplexer, h,
 566                          GNUNET_TIME_UNIT_FOREVER_REL);
 567   size = ntohs (msg->size);
 568   switch (ntohs (msg->type))
 569   {
 570   case GNUNET_MESSAGE_TYPE_HELLO:
 571     if (GNUNET_OK !=
 572         GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg, &me))
 573     {
 574       GNUNET_break (0);
 575       break;
 576     }
 577     LOG (GNUNET_ERROR_TYPE_DEBUG,
 578          "Receiving (my own) `%s' message, I am `%4s'.\n", "HELLO",
 579          GNUNET_i2s (&me));
 580     GNUNET_free_non_null (h->my_hello);
 581     h->my_hello = NULL;
 582     if (size < sizeof (struct GNUNET_MessageHeader))
 583     {
 584       GNUNET_break (0);
 585       break;
 586     }
 587     h->my_hello = GNUNET_malloc (size);
 588     memcpy (h->my_hello, msg, size);
 589     hwl = h->hwl_head;
 590     while (NULL != hwl)
 591     {
 592       next_hwl = hwl->next;
 593       hwl->rec (hwl->rec_cls,
 594                 (const struct GNUNET_MessageHeader *) h->my_hello);
 595       hwl = next_hwl;
 596     }
 597     break;
 598   case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
 599     if (size < sizeof (struct ConnectInfoMessage))
 600     {
 601       GNUNET_break (0);
 602       break;
 603     }
 604     cim = (const struct ConnectInfoMessage *) msg;
 605     if (size !=
 606         sizeof (struct ConnectInfoMessage))
 607     {
 608       GNUNET_break (0);
 609       break;
 610     }
 611     LOG (GNUNET_ERROR_TYPE_DEBUG,
 612          "Receiving `%s' message for `%4s'.\n",
 613          "CONNECT", GNUNET_i2s (&cim->id));
 614     n = neighbour_find (h, &cim->id);
 615     if (NULL != n)
 616     {
 617       GNUNET_break (0);
 618       break;
 619     }
 620     n = neighbour_add (h, &cim->id);
 621     LOG (GNUNET_ERROR_TYPE_DEBUG,
 622          "Receiving `%s' message for `%4s' with quota %u\n",
 623          "CONNECT",
 624          GNUNET_i2s (&cim->id),
 625          ntohl (cim->quota_out.value__));
 626     GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker, cim->quota_out);
 627     if (h->nc_cb != NULL)
 628       h->nc_cb (h->cls, &n->id);
 629     break;
 630   case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
 631     if (size != sizeof (struct DisconnectInfoMessage))
 632     {
 633       GNUNET_break (0);
 634       break;
 635     }
 636     dim = (const struct DisconnectInfoMessage *) msg;
 637     GNUNET_break (ntohl (dim->reserved) == 0);
 638     LOG (GNUNET_ERROR_TYPE_DEBUG,
 639          "Receiving `%s' message for `%4s'.\n",
 640          "DISCONNECT", GNUNET_i2s (&dim->peer));
 641     n = neighbour_find (h, &dim->peer);
 642     if (NULL == n)
 643     {
 644       GNUNET_break (0);
 645       break;
 646     }
 647     neighbour_delete (h, &dim->peer, n);
 648     break;
 649   case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
 650     if (size != sizeof (struct SendOkMessage))
 651     {
 652       GNUNET_break (0);
 653       break;
 654     }
 655     okm = (const struct SendOkMessage *) msg;
 656     bytes_msg = ntohl (okm->bytes_msg);
 657     bytes_physical = ntohl (okm->bytes_physical);
 658     LOG (GNUNET_ERROR_TYPE_DEBUG,
 659          "Receiving SEND_OK message, transmission %s.\n",
 660          ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
 661
 662     n = neighbour_find (h, &okm->peer);
 663     if (NULL == n)
 664       break;
 665
 666     if (bytes_physical >= bytes_msg)
 667     {
 668         LOG (GNUNET_ERROR_TYPE_DEBUG,
 669              "Overhead for %u byte message: %u\n",
 670             bytes_msg, bytes_physical - bytes_msg);
 671       n->traffic_overhead += bytes_physical - bytes_msg;
 672     }
 673     GNUNET_break (GNUNET_NO == n->is_ready);
 674     n->is_ready = GNUNET_YES;
 675     if ((NULL != n->th) && (NULL == n->hn))
 676     {
 677       GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != n->th->timeout_task);
 678       GNUNET_SCHEDULER_cancel (n->th->timeout_task);
 679       n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 680       /* we've been waiting for this (congestion, not quota,
 681        * caused delayed transmission) */
 682       n->hn = GNUNET_CONTAINER_heap_insert (h->ready_heap, n, 0);
 683       schedule_transmission (h);
 684     }
 685     break;
 686   case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
 687     LOG (GNUNET_ERROR_TYPE_DEBUG,
 688          "Receiving `%s' message.\n",
 689          "RECV");
 690     if (size <
 691         sizeof (struct InboundMessage) + sizeof (struct GNUNET_MessageHeader))
 692     {
 693       GNUNET_break (0);
 694       break;
 695     }
 696     im = (const struct InboundMessage *) msg;
 697     imm = (const struct GNUNET_MessageHeader *) &im[1];
 698     if (ntohs (imm->size) + sizeof (struct InboundMessage) != size)
 699     {
 700       GNUNET_break (0);
 701       break;
 702     }
 703     LOG (GNUNET_ERROR_TYPE_DEBUG,
 704          "Received message of type %u from `%4s'.\n",
 705          ntohs (imm->type), GNUNET_i2s (&im->peer));
 706     n = neighbour_find (h, &im->peer);
 707     if (NULL == n)
 708     {
 709       GNUNET_break (0);
 710       break;
 711     }
 712     if (NULL != h->rec)
 713       h->rec (h->cls, &im->peer, imm);
 714     break;
 715   case GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA:
 716     LOG (GNUNET_ERROR_TYPE_DEBUG,
 717          "Receiving `%s' message.\n", "SET_QUOTA");
 718     if (size != sizeof (struct QuotaSetMessage))
 719     {
 720       GNUNET_break (0);
 721       break;
 722     }
 723     qm = (const struct QuotaSetMessage *) msg;
 724     n = neighbour_find (h, &qm->peer);
 725     if (NULL == n)
 726       break;
 727     LOG (GNUNET_ERROR_TYPE_DEBUG,
 728          "Receiving `%s' message for `%4s' with quota %u\n",
 729          "SET_QUOTA",
 730          GNUNET_i2s (&qm->peer),
 731          ntohl (qm->quota.value__));
 732     GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker, qm->quota);
 733     break;
 734   default:
 735     LOG (GNUNET_ERROR_TYPE_ERROR,
 736          _("Received unexpected message of type %u in %s:%u\n"),
 737          ntohs (msg->type), __FILE__, __LINE__);
 738     GNUNET_break (0);
 739     break;
 740   }
 741 }
 742
 743
 744 /**
 745  * A transmission request could not be satisfied because of
 746  * network congestion.  Notify the initiator and clean up.
 747  *
 748  * @param cls the `struct GNUNET_TRANSPORT_TransmitHandle`
 749  * @param tc scheduler context
 750  */
 751 static void
 752 timeout_request_due_to_congestion (void *cls,
 753                                    const struct GNUNET_SCHEDULER_TaskContext *tc)
 754 {
 755   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
 756   struct Neighbour *n = th->neighbour;
 757
 758   n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 759   GNUNET_assert (th == n->th);
 760   GNUNET_assert (NULL == n->hn);
 761   n->th = NULL;
 762   th->notify (th->notify_cls, 0, NULL);
 763   GNUNET_free (th);
 764 }
 765
 766
 767 /**
 768  * Transmit message(s) to service.
 769  *
 770  * @param cls handle to transport
 771  * @param size number of bytes available in @a buf
 772  * @param buf where to copy the message
 773  * @return number of bytes copied to @a buf
 774  */
 775 static size_t
 776 transport_notify_ready (void *cls, size_t size, void *buf)
 777 {
 778   struct GNUNET_TRANSPORT_Handle *h = cls;
 779   struct GNUNET_TRANSPORT_TransmitHandle *th;
 780   struct Neighbour *n;
 781   char *cbuf;
 782   struct OutboundMessage obm;
 783   size_t ret;
 784   size_t nret;
 785   size_t mret;
 786
 787   GNUNET_assert (NULL != h->client);
 788   h->cth = NULL;
 789   if (NULL == buf)
 790   {
 791     /* transmission failed */
 792     disconnect_and_schedule_reconnect (h);
 793     return 0;
 794   }
 795
 796   cbuf = buf;
 797   ret = 0;
 798   /* first send control messages */
 799   while ((NULL != (th = h->control_head)) && (th->notify_size <= size))
 800   {
 801     GNUNET_CONTAINER_DLL_remove (h->control_head, h->control_tail, th);
 802     nret = th->notify (th->notify_cls, size, &cbuf[ret]);
 803     LOG (GNUNET_ERROR_TYPE_DEBUG,
 804          "Added %u bytes of control message at %u\n",
 805          nret, ret);
 806     GNUNET_free (th);
 807     ret += nret;
 808     size -= nret;
 809   }
 810
 811   /* then, if possible and no control messages pending, send data messages */
 812   while ((NULL == h->control_head) &&
 813          (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))))
 814   {
 815     if (GNUNET_YES != n->is_ready)
 816     {
 817       /* peer not ready, wait for notification! */
 818       GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
 819       n->hn = NULL;
 820       GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == n->th->timeout_task);
 821       n->th->timeout_task =
 822           GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
 823                                         (n->th->timeout),
 824                                         &timeout_request_due_to_congestion,
 825                                         n->th);
 826       continue;
 827     }
 828     th = n->th;
 829     if (th->notify_size + sizeof (struct OutboundMessage) > size)
 830       break;                    /* does not fit */
 831     if (GNUNET_BANDWIDTH_tracker_get_delay
 832         (&n->out_tracker, th->notify_size).rel_value_us > 0)
 833       break;                    /* too early */
 834     GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
 835     n->hn = NULL;
 836     n->th = NULL;
 837     n->is_ready = GNUNET_NO;
 838     GNUNET_assert (size >= sizeof (struct OutboundMessage));
 839     mret =
 840         th->notify (th->notify_cls, size - sizeof (struct OutboundMessage),
 841                     &cbuf[ret + sizeof (struct OutboundMessage)]);
 842     GNUNET_assert (mret <= size - sizeof (struct OutboundMessage));
 843     if (mret != 0)
 844     {
 845       GNUNET_assert (mret + sizeof (struct OutboundMessage) <
 846                      GNUNET_SERVER_MAX_MESSAGE_SIZE);
 847       obm.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
 848       obm.header.size = htons (mret + sizeof (struct OutboundMessage));
 849       obm.reserved = htonl (0);
 850       obm.timeout =
 851           GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining
 852                                      (th->timeout));
 853       obm.peer = n->id;
 854       memcpy (&cbuf[ret], &obm, sizeof (struct OutboundMessage));
 855       ret += (mret + sizeof (struct OutboundMessage));
 856       size -= (mret + sizeof (struct OutboundMessage));
 857       GNUNET_BANDWIDTH_tracker_consume (&n->out_tracker, mret);
 858     }
 859     GNUNET_free (th);
 860   }
 861   /* if there are more pending messages, try to schedule those */
 862   schedule_transmission (h);
 863   LOG (GNUNET_ERROR_TYPE_DEBUG,
 864        "Transmitting %u bytes to transport service\n",
 865        ret);
 866   return ret;
 867 }
 868
 869
 870 /**
 871  * Schedule the task to send one message, either from the control
 872  * list or the peer message queues  to the service.
 873  *
 874  * @param cls transport service to schedule a transmission for
 875  * @param tc scheduler context
 876  */
 877 static void
 878 schedule_transmission_task (void *cls,
 879                             const struct GNUNET_SCHEDULER_TaskContext *tc)
 880 {
 881   struct GNUNET_TRANSPORT_Handle *h = cls;
 882   size_t size;
 883   struct GNUNET_TRANSPORT_TransmitHandle *th;
 884   struct Neighbour *n;
 885
 886   h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 887   GNUNET_assert (NULL != h->client);
 888   /* destroy all requests that have timed out */
 889   while ((NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))) &&
 890          (0 == GNUNET_TIME_absolute_get_remaining (n->th->timeout).rel_value_us))
 891   {
 892     /* notify client that the request could not be satisfied within
 893      * the given time constraints */
 894     th = n->th;
 895     n->th = NULL;
 896     GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
 897     n->hn = NULL;
 898     LOG (GNUNET_ERROR_TYPE_DEBUG,
 899          "Signalling timeout for transmission to peer %s due to congestion\n",
 900          GNUNET_i2s (&n->id));
 901     GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
 902     GNUNET_free (th);
 903   }
 904   if (NULL != h->cth)
 905     return;
 906   if (NULL != h->control_head)
 907   {
 908     size = h->control_head->notify_size;
 909   }
 910   else
 911   {
 912     n = GNUNET_CONTAINER_heap_peek (h->ready_heap);
 913     if (NULL == n)
 914       return;                   /* no pending messages */
 915     size = n->th->notify_size + sizeof (struct OutboundMessage);
 916   }
 917   LOG (GNUNET_ERROR_TYPE_DEBUG,
 918        "Calling notify_transmit_ready\n");
 919   h->cth =
 920       GNUNET_CLIENT_notify_transmit_ready (h->client, size,
 921                                            GNUNET_TIME_UNIT_FOREVER_REL,
 922                                            GNUNET_NO, &transport_notify_ready,
 923                                            h);
 924   GNUNET_assert (NULL != h->cth);
 925 }
 926
 927
 928 /**
 929  * Schedule the task to send one message, either from the control
 930  * list or the peer message queues  to the service.
 931  *
 932  * @param h transport service to schedule a transmission for
 933  */
 934 static void
 935 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
 936 {
 937   struct GNUNET_TIME_Relative delay;
 938   struct Neighbour *n;
 939
 940   GNUNET_assert (NULL != h->client);
 941   if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
 942   {
 943     GNUNET_SCHEDULER_cancel (h->quota_task);
 944     h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 945   }
 946   if (NULL != h->control_head)
 947     delay = GNUNET_TIME_UNIT_ZERO;
 948   else if (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap)))
 949   {
 950     delay =
 951         GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
 952                                             n->th->notify_size + n->traffic_overhead);
 953     n->traffic_overhead = 0;
 954   }
 955   else
 956     return;                     /* no work to be done */
 957   LOG (GNUNET_ERROR_TYPE_DEBUG,
 958        "Scheduling next transmission to service in %s\n",
 959        GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
 960   h->quota_task =
 961       GNUNET_SCHEDULER_add_delayed (delay, &schedule_transmission_task, h);
 962 }
 963
 964
 965 /**
 966  * Queue control request for transmission to the transport
 967  * service.
 968  *
 969  * @param h handle to the transport service
 970  * @param size number of bytes to be transmitted
 971  * @param notify function to call to get the content
 972  * @param notify_cls closure for @a notify
 973  * @return a `struct GNUNET_TRANSPORT_TransmitHandle`
 974  */
 975 static struct GNUNET_TRANSPORT_TransmitHandle *
 976 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h, size_t size,
 977                            GNUNET_TRANSPORT_TransmitReadyNotify notify,
 978                            void *notify_cls)
 979 {
 980   struct GNUNET_TRANSPORT_TransmitHandle *th;
 981
 982   LOG (GNUNET_ERROR_TYPE_DEBUG,
 983        "Control transmit of %u bytes requested\n",
 984        size);
 985   th = GNUNET_new (struct GNUNET_TRANSPORT_TransmitHandle);
 986   th->notify = notify;
 987   th->notify_cls = notify_cls;
 988   th->notify_size = size;
 989   GNUNET_CONTAINER_DLL_insert_tail (h->control_head, h->control_tail, th);
 990   schedule_transmission (h);
 991   return th;
 992 }
 993
 994
 995 /**
 996  * Transmit START message to service.
 997  *
 998  * @param cls unused
 999  * @param size number of bytes available in @a buf
1000  * @param buf where to copy the message
1001  * @return number of bytes copied to @a buf
1002  */
1003 static size_t
1004 send_start (void *cls, size_t size, void *buf)
1005 {
1006   struct GNUNET_TRANSPORT_Handle *h = cls;
1007   struct StartMessage s;
1008   uint32_t options;
1009
1010   if (NULL == buf)
1011   {
1012     /* Can only be shutdown, just give up */
1013     LOG (GNUNET_ERROR_TYPE_DEBUG,
1014          "Shutdown while trying to transmit `%s' request.\n",
1015          "START");
1016     return 0;
1017   }
1018   LOG (GNUNET_ERROR_TYPE_DEBUG,
1019        "Transmitting `%s' request.\n",
1020        "START");
1021   GNUNET_assert (size >= sizeof (struct StartMessage));
1022   s.header.size = htons (sizeof (struct StartMessage));
1023   s.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
1024   options = 0;
1025   if (h->check_self)
1026     options |= 1;
1027   if (h->rec != NULL)
1028     options |= 2;
1029   s.options = htonl (options);
1030   s.self = h->self;
1031   memcpy (buf, &s, sizeof (struct StartMessage));
1032   GNUNET_CLIENT_receive (h->client, &demultiplexer, h,
1033                          GNUNET_TIME_UNIT_FOREVER_REL);
1034   return sizeof (struct StartMessage);
1035 }
1036
1037
1038 /**
1039  * Try again to connect to transport service.
1040  *
1041  * @param cls the handle to the transport service
1042  * @param tc scheduler context
1043  */
1044 static void
1045 reconnect (void *cls,
1046            const struct GNUNET_SCHEDULER_TaskContext *tc)
1047 {
1048   struct GNUNET_TRANSPORT_Handle *h = cls;
1049
1050   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1051   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1052   {
1053     /* shutdown, just give up */
1054     return;
1055   }
1056   LOG (GNUNET_ERROR_TYPE_DEBUG,
1057        "Connecting to transport service.\n");
1058   GNUNET_assert (NULL == h->client);
1059   GNUNET_assert (NULL == h->control_head);
1060   GNUNET_assert (NULL == h->control_tail);
1061   h->reconnecting = GNUNET_NO;
1062   h->client = GNUNET_CLIENT_connect ("transport", h->cfg);
1063
1064   GNUNET_assert (NULL != h->client);
1065   schedule_control_transmit (h, sizeof (struct StartMessage),
1066                              &send_start, h);
1067 }
1068
1069
1070 /**
1071  * Function that will schedule the job that will try
1072  * to connect us again to the client.
1073  *
1074  * @param h transport service to reconnect
1075  */
1076 static void
1077 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1078 {
1079   struct GNUNET_TRANSPORT_TransmitHandle *th;
1080
1081   GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1082   if (NULL != h->cth)
1083   {
1084     GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
1085     h->cth = NULL;
1086   }
1087   if (NULL != h->client)
1088   {
1089     GNUNET_CLIENT_disconnect (h->client);
1090     h->client = NULL;
1091 /*    LOG (GNUNET_ERROR_TYPE_ERROR,
1092          "Client disconnect done \n");*/
1093   }
1094   /* Forget about all neighbours that we used to be connected to */
1095   GNUNET_CONTAINER_multipeermap_iterate (h->neighbours,
1096                                          &neighbour_delete, h);
1097   if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
1098   {
1099     GNUNET_SCHEDULER_cancel (h->quota_task);
1100     h->quota_task = GNUNET_SCHEDULER_NO_TASK;
1101   }
1102   while ((NULL != (th = h->control_head)))
1103   {
1104     GNUNET_CONTAINER_DLL_remove (h->control_head, h->control_tail, th);
1105     th->notify (th->notify_cls, 0, NULL);
1106     GNUNET_free (th);
1107   }
1108   LOG (GNUNET_ERROR_TYPE_DEBUG,
1109        "Scheduling task to reconnect to transport service in %s.\n",
1110        GNUNET_STRINGS_relative_time_to_string(h->reconnect_delay, GNUNET_YES));
1111   h->reconnect_task =
1112       GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect, h);
1113   h->reconnect_delay = GNUNET_TIME_STD_BACKOFF (h->reconnect_delay);
1114 }
1115
1116
1117 /**
1118  * Cancel control request for transmission to the transport service.
1119  *
1120  * @param th handle to the transport service
1121  * @param tth transmit handle to cancel
1122  */
1123 static void
1124 cancel_control_transmit (struct GNUNET_TRANSPORT_Handle *th,
1125                          struct GNUNET_TRANSPORT_TransmitHandle *tth)
1126 {
1127   LOG (GNUNET_ERROR_TYPE_DEBUG,
1128        "Canceling transmit of contral transmission requested\n");
1129   GNUNET_CONTAINER_DLL_remove (th->control_head, th->control_tail, tth);
1130   GNUNET_free (tth);
1131 }
1132
1133
1134
1135 /**
1136  * Send REQUEST_CONNECT message to the service.
1137  *
1138  * @param cls the `struct GNUNET_PeerIdentity`
1139  * @param size number of bytes available in @a buf
1140  * @param buf where to copy the message
1141  * @return number of bytes copied to @a buf
1142  */
1143 static size_t
1144 send_try_connect (void *cls, size_t size, void *buf)
1145 {
1146   struct GNUNET_TRANSPORT_TryConnectHandle *tch = cls;
1147   struct TransportRequestConnectMessage msg;
1148
1149   if (NULL == buf)
1150   {
1151     if (NULL != tch->cb)
1152       tch->cb (tch->cb_cls, GNUNET_SYSERR);
1153     GNUNET_CONTAINER_DLL_remove (tch->th->tc_head, tch->th->tc_tail, tch);
1154     LOG (GNUNET_ERROR_TYPE_DEBUG,
1155          "Discarding  `%s' request to `%4s' due to error in transport service connection.\n",
1156          "REQUEST_CONNECT",
1157          GNUNET_i2s (&tch->pid));
1158     GNUNET_free (tch);
1159     return 0;
1160   }
1161   LOG (GNUNET_ERROR_TYPE_DEBUG,
1162        "Transmitting `%s' request with respect to `%4s'.\n",
1163        "REQUEST_CONNECT",
1164        GNUNET_i2s (&tch->pid));
1165   GNUNET_assert (size >= sizeof (struct TransportRequestConnectMessage));
1166   msg.header.size = htons (sizeof (struct TransportRequestConnectMessage));
1167   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT);
1168   msg.reserved = htonl (0);
1169   msg.peer = tch->pid;
1170   memcpy (buf, &msg, sizeof (msg));
1171   if (NULL != tch->cb)
1172     tch->cb (tch->cb_cls, GNUNET_OK);
1173   GNUNET_CONTAINER_DLL_remove (tch->th->tc_head, tch->th->tc_tail, tch);
1174   GNUNET_free (tch);
1175   return sizeof (struct TransportRequestConnectMessage);
1176 }
1177
1178 /**
1179  * Ask the transport service to establish a connection to
1180  * the given peer.
1181  *
1182  * @param handle connection to transport service
1183  * @param target who we should try to connect to
1184  * @param cb callback to be called when request was transmitted to transport
1185  *         service
1186  * @param cb_cls closure for the callback
1187  * @return a `struct GNUNET_TRANSPORT_TryConnectHandle` handle or
1188  *         NULL on failure (cb will not be called)
1189  */
1190 struct GNUNET_TRANSPORT_TryConnectHandle *
1191 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
1192                               const struct GNUNET_PeerIdentity *target,
1193                               GNUNET_TRANSPORT_TryConnectCallback cb,
1194                               void *cb_cls)
1195 {
1196   struct GNUNET_TRANSPORT_TryConnectHandle *tch = NULL;
1197
1198   if (NULL == handle->client)
1199       return NULL;
1200   tch = GNUNET_new (struct GNUNET_TRANSPORT_TryConnectHandle);
1201   tch->th = handle;
1202   tch->pid = *(target);
1203   tch->cb = cb;
1204   tch->cb_cls = cb_cls;
1205   tch->tth = schedule_control_transmit (handle,
1206                                         sizeof (struct TransportRequestConnectMessage),
1207                                         &send_try_connect, tch);
1208   GNUNET_CONTAINER_DLL_insert(handle->tc_head, handle->tc_tail, tch);
1209   return tch;
1210 }
1211
1212
1213 /**
1214  * Cancel the request to transport to try a connect
1215  * Callback will not be called
1216  *
1217  * @param tch the handle to cancel
1218  */
1219 void
1220 GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch)
1221 {
1222   struct GNUNET_TRANSPORT_Handle *th;
1223
1224   th = tch->th;
1225   cancel_control_transmit (th, tch->tth);
1226   GNUNET_CONTAINER_DLL_remove (th->tc_head, th->tc_tail, tch);
1227   GNUNET_free (tch);
1228 }
1229
1230
1231 /**
1232  * Send HELLO message to the service.
1233  *
1234  * @param cls the HELLO message to send
1235  * @param size number of bytes available in @a buf
1236  * @param buf where to copy the message
1237  * @return number of bytes copied to @a buf
1238  */
1239 static size_t
1240 send_hello (void *cls, size_t size, void *buf)
1241 {
1242   struct GNUNET_TRANSPORT_OfferHelloHandle *ohh = cls;
1243   struct GNUNET_MessageHeader *msg = ohh->msg;
1244   uint16_t ssize;
1245   struct GNUNET_SCHEDULER_TaskContext tc;
1246
1247   tc.read_ready = NULL;
1248   tc.write_ready = NULL;
1249   tc.reason = GNUNET_SCHEDULER_REASON_TIMEOUT;
1250   if (NULL == buf)
1251   {
1252     LOG (GNUNET_ERROR_TYPE_DEBUG,
1253          "Timeout while trying to transmit `%s' request.\n",
1254          "HELLO");
1255     if (NULL != ohh->cont)
1256       ohh->cont (ohh->cls, &tc);
1257     GNUNET_free (msg);
1258     GNUNET_CONTAINER_DLL_remove (ohh->th->oh_head, ohh->th->oh_tail, ohh);
1259     GNUNET_free (ohh);
1260     return 0;
1261   }
1262   LOG (GNUNET_ERROR_TYPE_DEBUG,
1263        "Transmitting `%s' request.\n",
1264        "HELLO");
1265   ssize = ntohs (msg->size);
1266   GNUNET_assert (size >= ssize);
1267   memcpy (buf, msg, ssize);
1268   GNUNET_free (msg);
1269   tc.reason = GNUNET_SCHEDULER_REASON_READ_READY;
1270   if (NULL != ohh->cont)
1271     ohh->cont (ohh->cls, &tc);
1272   GNUNET_CONTAINER_DLL_remove (ohh->th->oh_head, ohh->th->oh_tail, ohh);
1273   GNUNET_free (ohh);
1274   return ssize;
1275 }
1276
1277
1278 /**
1279  * Send traffic metric message to the service.
1280  *
1281  * @param cls the message to send
1282  * @param size number of bytes available in @a buf
1283  * @param buf where to copy the message
1284  * @return number of bytes copied to @a buf
1285  */
1286 static size_t
1287 send_metric (void *cls, size_t size, void *buf)
1288 {
1289   struct TrafficMetricMessage *msg = cls;
1290   uint16_t ssize;
1291
1292   if (NULL == buf)
1293   {
1294     LOG (GNUNET_ERROR_TYPE_DEBUG,
1295          "Timeout while trying to transmit `%s' request.\n",
1296          "TRAFFIC_METRIC");
1297     GNUNET_free (msg);
1298     return 0;
1299   }
1300   LOG (GNUNET_ERROR_TYPE_DEBUG,
1301        "Transmitting `%s' request.\n",
1302        "TRAFFIC_METRIC");
1303   ssize = ntohs (msg->header.size);
1304   GNUNET_assert (size >= ssize);
1305   memcpy (buf, msg, ssize);
1306   GNUNET_free (msg);
1307   return ssize;
1308 }
1309
1310
1311 /**
1312  * Set transport metrics for a peer and a direction
1313  *
1314  * @param handle transport handle
1315  * @param peer the peer to set the metric for
1316  * @param inbound set inbound direction (#GNUNET_YES or #GNUNET_NO)
1317  * @param outbound set outbound direction (#GNUNET_YES or #GNUNET_NO)
1318  * @param ats the metric as ATS information
1319  * @param ats_count the number of metrics
1320  *
1321  * Supported ATS values:
1322  * #GNUNET_ATS_QUALITY_NET_DELAY  (value in ms)
1323  * #GNUNET_ATS_QUALITY_NET_DISTANCE (value in count(hops))
1324  *
1325  * Example:
1326  * To enforce a delay of 10 ms for peer p1 in sending direction use:
1327  * <code>
1328  * struct GNUNET_ATS_Information ats;
1329  * ats.type = ntohl (GNUNET_ATS_QUALITY_NET_DELAY);
1330  * ats.value = ntohl (10);
1331  * GNUNET_TRANSPORT_set_traffic_metric (th, p1, TM_SEND, &ats, 1);
1332  * </code>
1333  * Note:
1334  * Delay restrictions in receiving direction will be enforced with
1335  * 1 message delay.
1336  */
1337 void
1338 GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
1339                                      const struct GNUNET_PeerIdentity *peer,
1340                                      int inbound,
1341                                      int outbound,
1342                                      const struct GNUNET_ATS_Information *ats,
1343                                      size_t ats_count)
1344 {
1345   struct TrafficMetricMessage *msg;
1346
1347   GNUNET_assert ((outbound == GNUNET_YES) || (outbound == GNUNET_NO));
1348   GNUNET_assert ((inbound == GNUNET_YES) || (inbound == GNUNET_NO));
1349   if ((GNUNET_NO == inbound) && (GNUNET_NO == outbound))
1350     return;
1351   if (0 == ats_count)
1352     return;
1353
1354   size_t len = sizeof (struct TrafficMetricMessage) +
1355     ats_count * sizeof (struct GNUNET_ATS_Information);
1356
1357   msg = GNUNET_malloc (len);
1358   msg->header.size = htons (len);
1359   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC);
1360   msg->direction = htons (0 + outbound + 2 * inbound);
1361   msg->ats_count = htons (ats_count);
1362   msg->peer = (*peer);
1363   memcpy (&msg[1], ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1364   schedule_control_transmit (handle, len,
1365                              &send_metric, msg);
1366 }
1367
1368
1369 /**
1370  * Offer the transport service the HELLO of another peer.  Note that
1371  * the transport service may just ignore this message if the HELLO is
1372  * malformed or useless due to our local configuration.
1373  *
1374  * @param handle connection to transport service
1375  * @param hello the hello message
1376  * @param cont continuation to call when HELLO has been sent,
1377  *      tc reason #GNUNET_SCHEDULER_REASON_TIMEOUT for fail
1378  *      tc reasong #GNUNET_SCHEDULER_REASON_READ_READY for success
1379  * @param cls closure for continuation
1380  * @return a `struct GNUNET_TRANSPORT_OfferHelloHandle` handle or NULL on failure,
1381  *      in case of failure cont will not be called
1382  *
1383  */
1384 struct GNUNET_TRANSPORT_OfferHelloHandle *
1385 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
1386                               const struct GNUNET_MessageHeader *hello,
1387                               GNUNET_SCHEDULER_Task cont, void *cls)
1388 {
1389   struct GNUNET_TRANSPORT_OfferHelloHandle *ohh;
1390   struct GNUNET_MessageHeader *msg;
1391   struct GNUNET_PeerIdentity peer;
1392   uint16_t size;
1393
1394   if (NULL == handle->client)
1395     return NULL;
1396   GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
1397   size = ntohs (hello->size);
1398   GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
1399   if (GNUNET_OK !=
1400       GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) hello, &peer))
1401   {
1402     GNUNET_break (0);
1403     return NULL;
1404   }
1405
1406   msg = GNUNET_malloc (size);
1407   memcpy (msg, hello, size);
1408   LOG (GNUNET_ERROR_TYPE_DEBUG,
1409        "Offering `%s' message of `%4s' to transport for validation.\n", "HELLO",
1410        GNUNET_i2s (&peer));
1411
1412   ohh = GNUNET_new (struct GNUNET_TRANSPORT_OfferHelloHandle);
1413   ohh->th = handle;
1414   ohh->cont = cont;
1415   ohh->cls = cls;
1416   ohh->msg = msg;
1417   ohh->tth = schedule_control_transmit (handle, size,
1418                                         &send_hello, ohh);
1419   GNUNET_CONTAINER_DLL_insert (handle->oh_head, handle->oh_tail, ohh);
1420   return ohh;
1421 }
1422
1423
1424 /**
1425  * Cancel the request to transport to offer the HELLO message
1426  *
1427  * @param ohh the GNUNET_TRANSPORT_OfferHelloHandle to cancel
1428  */
1429 void
1430 GNUNET_TRANSPORT_offer_hello_cancel (struct GNUNET_TRANSPORT_OfferHelloHandle *ohh)
1431 {
1432   struct GNUNET_TRANSPORT_Handle *th = ohh->th;
1433
1434   cancel_control_transmit (ohh->th, ohh->tth);
1435   GNUNET_CONTAINER_DLL_remove (th->oh_head, th->oh_tail, ohh);
1436   GNUNET_free (ohh->msg);
1437   GNUNET_free (ohh);
1438 }
1439
1440
1441 /**
1442  * Checks if a given peer is connected to us
1443  *
1444  * @param handle connection to transport service
1445  * @param peer the peer to check
1446  * @return #GNUNET_YES (connected) or #GNUNET_NO (disconnected)
1447  */
1448 int
1449 GNUNET_TRANSPORT_check_peer_connected (struct GNUNET_TRANSPORT_Handle *handle,
1450                                        const struct GNUNET_PeerIdentity *peer)
1451 {
1452   if (GNUNET_YES ==
1453       GNUNET_CONTAINER_multipeermap_contains (handle->neighbours,
1454                                               peer))
1455     return GNUNET_YES;
1456   return GNUNET_NO;
1457 }
1458
1459
1460 /**
1461  * Task to call the HelloUpdateCallback of the GetHelloHandle
1462  *
1463  * @param cls the `struct GNUNET_TRANSPORT_GetHelloHandle`
1464  * @param tc the scheduler task context
1465  */
1466 static void
1467 call_hello_update_cb_async (void *cls,
1468                             const struct GNUNET_SCHEDULER_TaskContext *tc)
1469 {
1470   struct GNUNET_TRANSPORT_GetHelloHandle *ghh = cls;
1471
1472   GNUNET_assert (NULL != ghh->handle->my_hello);
1473   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != ghh->notify_task);
1474   ghh->notify_task = GNUNET_SCHEDULER_NO_TASK;
1475   ghh->rec (ghh->rec_cls,
1476             (const struct GNUNET_MessageHeader *) ghh->handle->my_hello);
1477 }
1478
1479
1480 /**
1481  * Obtain the HELLO message for this peer.  The callback given in this function
1482  * is never called synchronously.
1483  *
1484  * @param handle connection to transport service
1485  * @param rec function to call with the HELLO, sender will be our peer
1486  *            identity; message and sender will be NULL on timeout
1487  *            (handshake with transport service pending/failed).
1488  *             cost estimate will be 0.
1489  * @param rec_cls closure for @a rec
1490  * @return handle to cancel the operation
1491  */
1492 struct GNUNET_TRANSPORT_GetHelloHandle *
1493 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
1494                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
1495                             void *rec_cls)
1496 {
1497   struct GNUNET_TRANSPORT_GetHelloHandle *hwl;
1498
1499   hwl = GNUNET_new (struct GNUNET_TRANSPORT_GetHelloHandle);
1500   hwl->rec = rec;
1501   hwl->rec_cls = rec_cls;
1502   hwl->handle = handle;
1503   GNUNET_CONTAINER_DLL_insert (handle->hwl_head, handle->hwl_tail, hwl);
1504   if (handle->my_hello != NULL)
1505     hwl->notify_task = GNUNET_SCHEDULER_add_now (&call_hello_update_cb_async,
1506                                                  hwl);
1507   return hwl;
1508 }
1509
1510
1511 /**
1512  * Stop receiving updates about changes to our HELLO message.
1513  *
1514  * @param ghh handle to cancel
1515  */
1516 void
1517 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh)
1518 {
1519   struct GNUNET_TRANSPORT_Handle *handle = ghh->handle;
1520
1521   if (GNUNET_SCHEDULER_NO_TASK != ghh->notify_task)
1522     GNUNET_SCHEDULER_cancel (ghh->notify_task);
1523   GNUNET_CONTAINER_DLL_remove (handle->hwl_head, handle->hwl_tail, ghh);
1524   GNUNET_free (ghh);
1525 }
1526
1527
1528 /**
1529  * Connect to the transport service.  Note that the connection may
1530  * complete (or fail) asynchronously.
1531  *
1532  * @param cfg configuration to use
1533  * @param self our own identity (API should check that it matches
1534  *             the identity found by transport), or NULL (no check)
1535  * @param cls closure for the callbacks
1536  * @param rec receive function to call
1537  * @param nc function to call on connect events
1538  * @param nd function to call on disconnect events
1539  * @return NULL on error
1540  */
1541 struct GNUNET_TRANSPORT_Handle *
1542 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1543                           const struct GNUNET_PeerIdentity *self, void *cls,
1544                           GNUNET_TRANSPORT_ReceiveCallback rec,
1545                           GNUNET_TRANSPORT_NotifyConnect nc,
1546                           GNUNET_TRANSPORT_NotifyDisconnect nd)
1547 {
1548   return GNUNET_TRANSPORT_connect2 (cfg, self, cls,
1549                                     rec, nc, nd, NULL);
1550 }
1551
1552
1553 /**
1554  * Connect to the transport service.  Note that the connection may
1555  * complete (or fail) asynchronously.
1556  *
1557  * @param cfg configuration to use
1558  * @param self our own identity (API should check that it matches
1559  *             the identity found by transport), or NULL (no check)
1560  * @param cls closure for the callbacks
1561  * @param rec receive function to call
1562  * @param nc function to call on connect events
1563  * @param nd function to call on disconnect events
1564  * @param neb function to call if we have excess bandwidth to a peer
1565  * @return NULL on error
1566  */
1567 struct GNUNET_TRANSPORT_Handle *
1568 GNUNET_TRANSPORT_connect2 (const struct GNUNET_CONFIGURATION_Handle *cfg,
1569                            const struct GNUNET_PeerIdentity *self, void *cls,
1570                            GNUNET_TRANSPORT_ReceiveCallback rec,
1571                            GNUNET_TRANSPORT_NotifyConnect nc,
1572                            GNUNET_TRANSPORT_NotifyDisconnect nd,
1573                            GNUNET_TRANSPORT_NotifyExcessBandwidth neb)
1574 {
1575   struct GNUNET_TRANSPORT_Handle *ret;
1576
1577   ret = GNUNET_new (struct GNUNET_TRANSPORT_Handle);
1578   if (NULL != self)
1579   {
1580     ret->self = *self;
1581     ret->check_self = GNUNET_YES;
1582   }
1583   ret->cfg = cfg;
1584   ret->cls = cls;
1585   ret->rec = rec;
1586   ret->nc_cb = nc;
1587   ret->nd_cb = nd;
1588   ret->neb_cb = neb;
1589   ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1590   LOG (GNUNET_ERROR_TYPE_DEBUG,
1591        "Connecting to transport service.\n");
1592   ret->client = GNUNET_CLIENT_connect ("transport", cfg);
1593   if (NULL == ret->client)
1594   {
1595     GNUNET_free (ret);
1596     return NULL;
1597   }
1598   ret->neighbours =
1599     GNUNET_CONTAINER_multipeermap_create (STARTING_NEIGHBOURS_SIZE,
1600                                           GNUNET_YES);
1601   ret->ready_heap =
1602       GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1603  schedule_control_transmit (ret, sizeof (struct StartMessage),
1604                             &send_start, ret);
1605   return ret;
1606 }
1607
1608
1609 /**
1610  * Disconnect from the transport service.
1611  *
1612  * @param handle handle to the service as returned from #GNUNET_TRANSPORT_connect()
1613  */
1614 void
1615 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1616 {
1617   LOG (GNUNET_ERROR_TYPE_DEBUG,
1618        "Transport disconnect called!\n");
1619   /* this disconnects all neighbours... */
1620   if (handle->reconnect_task == GNUNET_SCHEDULER_NO_TASK)
1621     disconnect_and_schedule_reconnect (handle);
1622   /* and now we stop trying to connect again... */
1623   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1624   {
1625     GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1626     handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1627   }
1628   GNUNET_CONTAINER_multipeermap_destroy (handle->neighbours);
1629   handle->neighbours = NULL;
1630   if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
1631   {
1632     GNUNET_SCHEDULER_cancel (handle->quota_task);
1633     handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
1634   }
1635   GNUNET_free_non_null (handle->my_hello);
1636   handle->my_hello = NULL;
1637   GNUNET_assert (NULL == handle->tc_head);
1638   GNUNET_assert (NULL == handle->tc_tail);
1639   GNUNET_assert (NULL == handle->hwl_head);
1640   GNUNET_assert (NULL == handle->hwl_tail);
1641   GNUNET_CONTAINER_heap_destroy (handle->ready_heap);
1642   handle->ready_heap = NULL;
1643   GNUNET_free (handle);
1644 }
1645
1646
1647 /**
1648  * Check if we could queue a message of the given size for
1649  * transmission.  The transport service will take both its
1650  * internal buffers and bandwidth limits imposed by the
1651  * other peer into consideration when answering this query.
1652  *
1653  * @param handle connection to transport service
1654  * @param target who should receive the message
1655  * @param size how big is the message we want to transmit?
1656  * @param timeout after how long should we give up (and call
1657  *        notify with buf NULL and size 0)?
1658  * @param notify function to call when we are ready to
1659  *        send such a message
1660  * @param notify_cls closure for @a notify
1661  * @return NULL if someone else is already waiting to be notified
1662  *         non-NULL if the notify callback was queued (can be used to cancel
1663  *         using #GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1664  */
1665 struct GNUNET_TRANSPORT_TransmitHandle *
1666 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
1667                                         const struct GNUNET_PeerIdentity *target,
1668                                         size_t size,
1669                                         struct GNUNET_TIME_Relative timeout,
1670                                         GNUNET_TRANSPORT_TransmitReadyNotify notify,
1671                                         void *notify_cls)
1672 {
1673   struct Neighbour *n;
1674   struct GNUNET_TRANSPORT_TransmitHandle *th;
1675   struct GNUNET_TIME_Relative delay;
1676
1677   n = neighbour_find (handle, target);
1678   if (NULL == n)
1679   {
1680     /* use GNUNET_TRANSPORT_try_connect first, only use this function
1681      * once a connection has been established */
1682     GNUNET_assert (0);
1683     return NULL;
1684   }
1685   if (NULL != n->th)
1686   {
1687     /* attempt to send two messages at the same time to the same peer */
1688     GNUNET_assert (0);
1689     return NULL;
1690   }
1691   GNUNET_assert (NULL == n->hn);
1692   th = GNUNET_new (struct GNUNET_TRANSPORT_TransmitHandle);
1693   th->neighbour = n;
1694   th->notify = notify;
1695   th->notify_cls = notify_cls;
1696   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1697   th->notify_size = size;
1698   n->th = th;
1699   /* calculate when our transmission should be ready */
1700   delay = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker, size + n->traffic_overhead);
1701   n->traffic_overhead = 0;
1702   if (delay.rel_value_us > timeout.rel_value_us)
1703     delay.rel_value_us = 0;        /* notify immediately (with failure) */
1704   LOG (GNUNET_ERROR_TYPE_DEBUG,
1705        "Bandwidth tracker allows next transmission to peer %s in %s\n",
1706        GNUNET_i2s (target),
1707        GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1708   n->hn = GNUNET_CONTAINER_heap_insert (handle->ready_heap, n, delay.rel_value_us);
1709   schedule_transmission (handle);
1710   return th;
1711 }
1712
1713
1714 /**
1715  * Cancel the specified transmission-ready notification.
1716  *
1717  * @param th handle returned from #GNUNET_TRANSPORT_notify_transmit_ready()
1718  */
1719 void
1720 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct GNUNET_TRANSPORT_TransmitHandle *th)
1721 {
1722   struct Neighbour *n;
1723
1724   GNUNET_assert (NULL == th->next);
1725   GNUNET_assert (NULL == th->prev);
1726   n = th->neighbour;
1727   GNUNET_assert (th == n->th);
1728   n->th = NULL;
1729   if (NULL != n->hn)
1730   {
1731     GNUNET_CONTAINER_heap_remove_node (n->hn);
1732     n->hn = NULL;
1733   }
1734   else
1735   {
1736     GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != th->timeout_task);
1737     GNUNET_SCHEDULER_cancel (th->timeout_task);
1738     th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1739   }
1740   GNUNET_free (th);
1741 }
1742
1743
1744 /* end of transport_api.c */