src/transport/transport_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 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/transport_api.c
  23  * @brief library to access the low-level P2P IO service
  24  * @author Christian Grothoff
  25  *
  26  * TODO:
  27  * - adjust testcases to use new 'try connect' style (should be easy, breaks API compatibility!)
  28  * - adjust core service to use new 'try connect' style (should be MUCH nicer there as well!)
  29  * - test test test
  30  */
  31 #include "platform.h"
  32 #include "gnunet_bandwidth_lib.h"
  33 #include "gnunet_client_lib.h"
  34 #include "gnunet_constants.h"
  35 #include "gnunet_container_lib.h"
  36 #include "gnunet_arm_service.h"
  37 #include "gnunet_hello_lib.h"
  38 #include "gnunet_protocols.h"
  39 #include "gnunet_server_lib.h"
  40 #include "gnunet_time_lib.h"
  41 #include "gnunet_transport_service.h"
  42 #include "transport.h"
  43
  44 /**
  45  * How large to start with for the hashmap of neighbours.
  46  */
  47 #define STARTING_NEIGHBOURS_SIZE 16
  48
  49
  50 /**
  51  * Handle for a message that should be transmitted to the service.
  52  * Used for both control messages and normal messages.
  53  */
  54 struct GNUNET_TRANSPORT_TransmitHandle
  55 {
  56
  57   /**
  58    * We keep all requests in a DLL.
  59    */
  60   struct GNUNET_TRANSPORT_TransmitHandle *next;
  61
  62   /**
  63    * We keep all requests in a DLL.
  64    */
  65   struct GNUNET_TRANSPORT_TransmitHandle *prev;
  66
  67   /**
  68    * Neighbour for this handle, NULL for control messages.
  69    */
  70   struct Neighbour *neighbour;
  71
  72   /**
  73    * Function to call when notify_size bytes are available
  74    * for transmission.
  75    */
  76   GNUNET_CONNECTION_TransmitReadyNotify notify;
  77
  78   /**
  79    * Closure for notify.
  80    */
  81   void *notify_cls;
  82
  83   /**
  84    * Timeout for this request, 0 for control messages.
  85    */
  86   struct GNUNET_TIME_Absolute timeout;
  87
  88   /**
  89    * Task to trigger request timeout if the request is stalled due to
  90    * congestion.
  91    */
  92   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
  93
  94   /**
  95    * How many bytes is our notify callback waiting for?
  96    */
  97   size_t notify_size;
  98
  99   /**
 100    * How important is this message? Not used for control messages.
 101    */
 102   uint32_t priority;
 103
 104 };
 105
 106
 107 /**
 108  * Entry in hash table of all of our current neighbours.
 109  */
 110 struct Neighbour
 111 {
 112   /**
 113    * Overall transport handle.
 114    */
 115   struct GNUNET_TRANSPORT_Handle *h;
 116
 117   /**
 118    * Active transmit handle or NULL.
 119    */
 120   struct GNUNET_TRANSPORT_TransmitHandle *th;
 121
 122   /**
 123    * Identity of this neighbour.
 124    */
 125   struct GNUNET_PeerIdentity id;
 126
 127   /**
 128    * Outbound bandwidh tracker.
 129    */
 130   struct GNUNET_BANDWIDTH_Tracker out_tracker;
 131
 132   /**
 133    * Entry in our readyness heap (which is sorted by 'next_ready'
 134    * value).  NULL if there is no pending transmission request for
 135    * this neighbour or if we're waiting for 'is_ready' to become
 136    * true AFTER the 'out_tracker' suggested that this peer's quota
 137    * has been satisfied (so once 'is_ready' goes to GNUNET_YES,
 138    * we should immediately go back into the heap).
 139    */
 140   struct GNUNET_CONTAINER_HeapNode *hn;
 141
 142   /**
 143    * Is this peer currently ready to receive a message?
 144    */
 145   int is_ready;
 146
 147 };
 148
 149
 150 /**
 151  * Linked list of functions to call whenever our HELLO is updated.
 152  */
 153 struct GNUNET_TRANSPORT_GetHelloHandle
 154 {
 155
 156   /**
 157    * This is a doubly linked list.
 158    */
 159   struct GNUNET_TRANSPORT_GetHelloHandle *next;
 160
 161   /**
 162    * This is a doubly linked list.
 163    */
 164   struct GNUNET_TRANSPORT_GetHelloHandle *prev;
 165
 166   /**
 167    * Transport handle.
 168    */
 169   struct GNUNET_TRANSPORT_Handle *handle;
 170
 171   /**
 172    * Callback to call once we got our HELLO.
 173    */
 174   GNUNET_TRANSPORT_HelloUpdateCallback rec;
 175
 176   /**
 177    * Closure for rec.
 178    */
 179   void *rec_cls;
 180
 181 };
 182
 183
 184 /**
 185  * Handle for the transport service (includes all of the
 186  * state for the transport service).
 187  */
 188 struct GNUNET_TRANSPORT_Handle
 189 {
 190
 191   /**
 192    * Closure for the callbacks.
 193    */
 194   void *cls;
 195
 196   /**
 197    * Function to call for received data.
 198    */
 199   GNUNET_TRANSPORT_ReceiveCallback rec;
 200
 201   /**
 202    * function to call on connect events
 203    */
 204   GNUNET_TRANSPORT_NotifyConnect nc_cb;
 205
 206   /**
 207    * function to call on disconnect events
 208    */
 209   GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
 210
 211   /**
 212    * Head of DLL of control messages.
 213    */
 214   struct GNUNET_TRANSPORT_TransmitHandle *control_head;
 215
 216   /**
 217    * Tail of DLL of control messages.
 218    */
 219   struct GNUNET_TRANSPORT_TransmitHandle *control_tail;
 220
 221   /**
 222    * The current HELLO message for this peer.  Updated
 223    * whenever transports change their addresses.
 224    */
 225   struct GNUNET_HELLO_Message *my_hello;
 226
 227   /**
 228    * My client connection to the transport service.
 229    */
 230   struct GNUNET_CLIENT_Connection *client;
 231
 232   /**
 233    * Handle to our registration with the client for notification.
 234    */
 235   struct GNUNET_CLIENT_TransmitHandle *cth;
 236
 237   /**
 238    * Linked list of pending requests for our HELLO.
 239    */
 240   struct GNUNET_TRANSPORT_GetHelloHandle *hwl_head;
 241
 242   /**
 243    * Linked list of pending requests for our HELLO.
 244    */
 245   struct GNUNET_TRANSPORT_GetHelloHandle *hwl_tail;
 246
 247   /**
 248    * My configuration.
 249    */
 250   const struct GNUNET_CONFIGURATION_Handle *cfg;
 251
 252   /**
 253    * Hash map of the current connected neighbours of this peer.
 254    * Maps peer identities to 'struct Neighbour' entries.
 255    */
 256   struct GNUNET_CONTAINER_MultiHashMap *neighbours;
 257
 258   /**
 259    * Heap sorting peers with pending messages by the timestamps that
 260    * specify when we could next send a message to the respective peer.
 261    * Excludes control messages (which can always go out immediately).
 262    * Maps time stamps to 'struct Neighbour' entries.
 263    */
 264   struct GNUNET_CONTAINER_Heap *ready_heap;
 265
 266   /**
 267    * Peer identity as assumed by this process, or all zeros.
 268    */
 269   struct GNUNET_PeerIdentity self;
 270
 271   /**
 272    * ID of the task trying to reconnect to the service.
 273    */
 274   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
 275
 276   /**
 277    * ID of the task trying to trigger transmission for a peer while
 278    * maintaining bandwidth quotas.  In use if there are no control
 279    * messages and the smallest entry in the 'ready_heap' has a time
 280    * stamp in the future.
 281    */
 282   GNUNET_SCHEDULER_TaskIdentifier quota_task;
 283
 284   /**
 285    * Delay until we try to reconnect.
 286    */
 287   struct GNUNET_TIME_Relative reconnect_delay;
 288
 289   /**
 290    * Should we check that 'self' matches what the service thinks?
 291    * (if GNUNET_NO, then 'self' is all zeros!).
 292    */
 293   int check_self;
 294 };
 295
 296
 297 /**
 298  * Schedule the task to send one message, either from the control
 299  * list or the peer message queues  to the service.
 300  *
 301  * @param h transport service to schedule a transmission for
 302  */
 303 static void
 304 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
 305
 306
 307 /**
 308  * Function that will schedule the job that will try
 309  * to connect us again to the client.
 310  *
 311  * @param h transport service to reconnect
 312  */
 313 static void
 314 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h);
 315
 316
 317 /**
 318  * Get the neighbour list entry for the given peer
 319  *
 320  * @param h our context
 321  * @param peer peer to look up
 322  * @return NULL if no such peer entry exists
 323  */
 324 static struct Neighbour *
 325 neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
 326                 const struct GNUNET_PeerIdentity *peer)
 327 {
 328   return GNUNET_CONTAINER_multihashmap_get (h->neighbours, &peer->hashPubKey);
 329 }
 330
 331
 332 /**
 333  * Add neighbour to our list
 334  *
 335  * @return NULL if this API is currently disconnecting from the service
 336  */
 337 static struct Neighbour *
 338 neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
 339                const struct GNUNET_PeerIdentity *pid)
 340 {
 341   struct Neighbour *n;
 342
 343 #if DEBUG_TRANSPORT
 344   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating entry for neighbour `%4s'.\n",
 345               GNUNET_i2s (pid));
 346 #endif
 347   n = GNUNET_malloc (sizeof (struct Neighbour));
 348   n->id = *pid;
 349   n->h = h;
 350   n->is_ready = GNUNET_YES;
 351   GNUNET_BANDWIDTH_tracker_init (&n->out_tracker,
 352                                  GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
 353                                  MAX_BANDWIDTH_CARRY_S);
 354   GNUNET_assert (GNUNET_OK ==
 355                  GNUNET_CONTAINER_multihashmap_put (h->neighbours,
 356                                                     &pid->hashPubKey, n,
 357                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 358   return n;
 359 }
 360
 361
 362 /**
 363  * Iterator over hash map entries, for deleting state of a neighbour.
 364  *
 365  * @param cls the 'struct GNUNET_TRANSPORT_Handle*'
 366  * @param key peer identity
 367  * @param value value in the hash map, the neighbour entry to delete
 368  * @return GNUNET_YES if we should continue to
 369  *         iterate,
 370  *         GNUNET_NO if not.
 371  */
 372 static int
 373 neighbour_delete (void *cls, const GNUNET_HashCode * key, void *value)
 374 {
 375   struct GNUNET_TRANSPORT_Handle *handle = cls;
 376   struct Neighbour *n = value;
 377
 378   if (NULL != handle->nd_cb)
 379     handle->nd_cb (handle->cls, &n->id);
 380   GNUNET_assert (NULL == n->th);
 381   GNUNET_assert (NULL == n->hn);
 382   GNUNET_assert (GNUNET_YES ==
 383                  GNUNET_CONTAINER_multihashmap_remove (handle->neighbours, key,
 384                                                        n));
 385   GNUNET_free (n);
 386   return GNUNET_YES;
 387 }
 388
 389
 390 /**
 391  * Function we use for handling incoming messages.
 392  *
 393  * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
 394  * @param msg message received, NULL on timeout or fatal error
 395  */
 396 static void
 397 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
 398 {
 399   struct GNUNET_TRANSPORT_Handle *h = cls;
 400   const struct DisconnectInfoMessage *dim;
 401   const struct ConnectInfoMessage *cim;
 402   const struct InboundMessage *im;
 403   const struct GNUNET_MessageHeader *imm;
 404   const struct SendOkMessage *okm;
 405   struct GNUNET_TRANSPORT_GetHelloHandle *hwl;
 406   struct GNUNET_TRANSPORT_GetHelloHandle *next_hwl;
 407   struct Neighbour *n;
 408   struct GNUNET_PeerIdentity me;
 409   uint16_t size;
 410   uint32_t ats_count;
 411
 412   GNUNET_assert (h->client != NULL);
 413   if (msg == NULL)
 414   {
 415 #if DEBUG_TRANSPORT
 416     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 417                 "Error receiving from transport service, disconnecting temporarily.\n");
 418 #endif
 419     disconnect_and_schedule_reconnect (h);
 420     return;
 421   }
 422   GNUNET_CLIENT_receive (h->client, &demultiplexer, h,
 423                          GNUNET_TIME_UNIT_FOREVER_REL);
 424   size = ntohs (msg->size);
 425   switch (ntohs (msg->type))
 426   {
 427   case GNUNET_MESSAGE_TYPE_HELLO:
 428     if (GNUNET_OK !=
 429         GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg, &me))
 430     {
 431       GNUNET_break (0);
 432       break;
 433     }
 434 #if DEBUG_TRANSPORT
 435     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 436                 "Receiving (my own) `%s' message, I am `%4s'.\n", "HELLO",
 437                 GNUNET_i2s (&me));
 438 #endif
 439     GNUNET_free_non_null (h->my_hello);
 440     h->my_hello = NULL;
 441     if (size < sizeof (struct GNUNET_MessageHeader))
 442     {
 443       GNUNET_break (0);
 444       break;
 445     }
 446     h->my_hello = GNUNET_malloc (size);
 447     memcpy (h->my_hello, msg, size);
 448     hwl = h->hwl_head;
 449     while (NULL != hwl)
 450     {
 451       next_hwl = hwl->next;
 452       hwl->rec (hwl->rec_cls,
 453                 (const struct GNUNET_MessageHeader *) h->my_hello);
 454       hwl = next_hwl;
 455     }
 456     break;
 457   case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
 458     if (size < sizeof (struct ConnectInfoMessage))
 459     {
 460       GNUNET_break (0);
 461       break;
 462     }
 463     cim = (const struct ConnectInfoMessage *) msg;
 464     ats_count = ntohl (cim->ats_count);
 465     if (size !=
 466         sizeof (struct ConnectInfoMessage) +
 467         ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information))
 468     {
 469       GNUNET_break (0);
 470       break;
 471     }
 472 #if DEBUG_TRANSPORT
 473     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message for `%4s'.\n",
 474                 "CONNECT", GNUNET_i2s (&cim->id));
 475 #endif
 476     n = neighbour_find (h, &cim->id);
 477     if (n != NULL)
 478     {
 479       GNUNET_break (0);
 480       break;
 481     }
 482     n = neighbour_add (h, &cim->id);
 483     if (h->nc_cb != NULL)
 484       h->nc_cb (h->cls, &n->id, &cim->ats, ats_count);
 485     break;
 486   case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
 487     if (size != sizeof (struct DisconnectInfoMessage))
 488     {
 489       GNUNET_break (0);
 490       break;
 491     }
 492     dim = (const struct DisconnectInfoMessage *) msg;
 493     GNUNET_break (ntohl (dim->reserved) == 0);
 494 #if DEBUG_TRANSPORT_DISCONNECT
 495     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message for `%4s'.\n",
 496                 "DISCONNECT", GNUNET_i2s (&dim->peer));
 497 #endif
 498     n = neighbour_find (h, &dim->peer);
 499     if (n == NULL)
 500     {
 501       GNUNET_break (0);
 502       break;
 503     }
 504     neighbour_delete (h, &dim->peer.hashPubKey, n);
 505     break;
 506   case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
 507     if (size != sizeof (struct SendOkMessage))
 508     {
 509       GNUNET_break (0);
 510       break;
 511     }
 512     okm = (const struct SendOkMessage *) msg;
 513 #if DEBUG_TRANSPORT
 514     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 515                 "Receiving `%s' message, transmission %s.\n", "SEND_OK",
 516                 ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
 517 #endif
 518     n = neighbour_find (h, &okm->peer);
 519     if (n == NULL)
 520       break;
 521     GNUNET_break (GNUNET_NO == n->is_ready);
 522     n->is_ready = GNUNET_YES;
 523     if ((n->th != NULL) && (n->hn == NULL))
 524     {
 525       GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != n->th->timeout_task);
 526       GNUNET_SCHEDULER_cancel (n->th->timeout_task);
 527       n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 528       /* we've been waiting for this (congestion, not quota,
 529        * caused delayed transmission) */
 530       n->hn = GNUNET_CONTAINER_heap_insert (h->ready_heap, n, 0);
 531       schedule_transmission (h);
 532     }
 533     break;
 534   case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
 535 #if DEBUG_TRANSPORT
 536     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Receiving `%s' message.\n", "RECV");
 537 #endif
 538     if (size <
 539         sizeof (struct InboundMessage) + sizeof (struct GNUNET_MessageHeader))
 540     {
 541       GNUNET_break (0);
 542       break;
 543     }
 544     im = (const struct InboundMessage *) msg;
 545     GNUNET_break (0 == ntohl (im->reserved));
 546     ats_count = ntohl (im->ats_count);
 547     imm = (const struct GNUNET_MessageHeader *) &((&(im->ats))[ats_count + 1]);
 548
 549     if (ntohs (imm->size) + sizeof (struct InboundMessage) +
 550         ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information) != size)
 551     {
 552       GNUNET_break (0);
 553       break;
 554     }
 555 #if DEBUG_TRANSPORT
 556     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 557                 "Received message of type %u from `%4s'.\n", ntohs (imm->type),
 558                 GNUNET_i2s (&im->peer));
 559 #endif
 560     n = neighbour_find (h, &im->peer);
 561     if (n == NULL)
 562     {
 563       GNUNET_break (0);
 564       break;
 565     }
 566     if (h->rec != NULL)
 567       h->rec (h->cls, &im->peer, imm, &im->ats, ats_count);
 568     break;
 569   default:
 570     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 571                 _("Received unexpected message of type %u in %s:%u\n"),
 572                 ntohs (msg->type), __FILE__, __LINE__);
 573     GNUNET_break (0);
 574     break;
 575   }
 576 }
 577
 578
 579 /**
 580  * A transmission request could not be satisfied because of
 581  * network congestion.  Notify the initiator and clean up.
 582  *
 583  * @param cls the 'struct GNUNET_TRANSPORT_TransmitHandle'
 584  * @param tc scheduler context
 585  */
 586 static void
 587 timeout_request_due_to_congestion (void *cls,
 588                                    const struct GNUNET_SCHEDULER_TaskContext
 589                                    *tc)
 590 {
 591   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
 592   struct Neighbour *n = th->neighbour;
 593
 594   n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 595   GNUNET_assert (th == n->th);
 596   GNUNET_assert (NULL == n->hn);
 597   n->th = NULL;
 598   th->notify (th->notify_cls, 0, NULL);
 599   GNUNET_free (th);
 600 }
 601
 602
 603 /**
 604  * Transmit message(s) to service.
 605  *
 606  * @param cls handle to transport
 607  * @param size number of bytes available in buf
 608  * @param buf where to copy the message
 609  * @return number of bytes copied to buf
 610  */
 611 static size_t
 612 transport_notify_ready (void *cls, size_t size, void *buf)
 613 {
 614   struct GNUNET_TRANSPORT_Handle *h = cls;
 615   struct GNUNET_TRANSPORT_TransmitHandle *th;
 616   struct Neighbour *n;
 617   char *cbuf;
 618   struct OutboundMessage obm;
 619   size_t ret;
 620   size_t nret;
 621   size_t mret;
 622
 623   GNUNET_assert (NULL != h->client);
 624   h->cth = NULL;
 625   if (NULL == buf)
 626   {
 627     /* transmission failed */
 628     disconnect_and_schedule_reconnect (h);
 629     return 0;
 630   }
 631
 632   cbuf = buf;
 633   ret = 0;
 634   /* first send control messages */
 635   while ((NULL != (th = h->control_head)) && (th->notify_size <= size))
 636   {
 637     GNUNET_CONTAINER_DLL_remove (h->control_head, h->control_tail, th);
 638     nret = th->notify (th->notify_cls, size, &cbuf[ret]);
 639 #if DEBUG_TRANSPORT
 640     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 641                 "Added %u bytes of control message at %u\n", nret, ret);
 642 #endif
 643     GNUNET_free (th);
 644     ret += nret;
 645     size -= nret;
 646   }
 647
 648   /* then, if possible and no control messages pending, send data messages */
 649   while ((NULL == h->control_head) &&
 650          (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))))
 651   {
 652     if (GNUNET_YES != n->is_ready)
 653     {
 654       /* peer not ready, wait for notification! */
 655       GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
 656       n->hn = NULL;
 657       GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == n->th->timeout_task);
 658       n->th->timeout_task =
 659           GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
 660                                         (n->th->timeout),
 661                                         &timeout_request_due_to_congestion,
 662                                         n->th);
 663       continue;
 664     }
 665     th = n->th;
 666     if (th->notify_size + sizeof (struct OutboundMessage) > size)
 667       break;                    /* does not fit */
 668     if (GNUNET_BANDWIDTH_tracker_get_delay
 669         (&n->out_tracker, th->notify_size).rel_value > 0)
 670       break;                    /* too early */
 671     GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
 672     n->hn = NULL;
 673     n->th = NULL;
 674     n->is_ready = GNUNET_NO;
 675     GNUNET_assert (size >= sizeof (struct OutboundMessage));
 676     mret =
 677         th->notify (th->notify_cls, size - sizeof (struct OutboundMessage),
 678                     &cbuf[ret + sizeof (struct OutboundMessage)]);
 679     GNUNET_assert (mret <= size - sizeof (struct OutboundMessage));
 680     if (mret != 0)
 681     {
 682       GNUNET_assert (mret + sizeof (struct OutboundMessage) <
 683                      GNUNET_SERVER_MAX_MESSAGE_SIZE);
 684       obm.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
 685       obm.header.size = htons (mret + sizeof (struct OutboundMessage));
 686       obm.priority = htonl (th->priority);
 687       obm.timeout =
 688           GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining
 689                                      (th->timeout));
 690       obm.peer = n->id;
 691       memcpy (&cbuf[ret], &obm, sizeof (struct OutboundMessage));
 692       ret += (mret + sizeof (struct OutboundMessage));
 693       size -= (mret + sizeof (struct OutboundMessage));
 694       GNUNET_BANDWIDTH_tracker_consume (&n->out_tracker, mret);
 695     }
 696     GNUNET_free (th);
 697   }
 698   /* if there are more pending messages, try to schedule those */
 699   schedule_transmission (h);
 700 #if DEBUG_TRANSPORT
 701   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 702               "Transmitting %u bytes to transport service\n", ret);
 703 #endif
 704   return ret;
 705 }
 706
 707
 708 /**
 709  * Schedule the task to send one message, either from the control
 710  * list or the peer message queues  to the service.
 711  *
 712  * @param cls transport service to schedule a transmission for
 713  * @param tc scheduler context
 714  */
 715 static void
 716 schedule_transmission_task (void *cls,
 717                             const struct GNUNET_SCHEDULER_TaskContext *tc)
 718 {
 719   struct GNUNET_TRANSPORT_Handle *h = cls;
 720   size_t size;
 721   struct GNUNET_TRANSPORT_TransmitHandle *th;
 722   struct Neighbour *n;
 723
 724   h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 725   GNUNET_assert (NULL != h->client);
 726   /* destroy all requests that have timed out */
 727   while ((NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))) &&
 728          (GNUNET_TIME_absolute_get_remaining (n->th->timeout).rel_value == 0))
 729   {
 730     /* notify client that the request could not be satisfied within
 731      * the given time constraints */
 732     th = n->th;
 733     n->th = NULL;
 734     GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
 735     n->hn = NULL;
 736 #if DEBUG_TRANSPORT
 737     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 738                 "Signalling timeout for transmission to peer %s due to congestion\n",
 739                 GNUNET_i2s (&n->id));
 740 #endif
 741     GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
 742     GNUNET_free (th);
 743   }
 744   if (NULL != h->cth)
 745     return;
 746   if (NULL != h->control_head)
 747   {
 748     size = h->control_head->notify_size;
 749   }
 750   else
 751   {
 752     n = GNUNET_CONTAINER_heap_peek (h->ready_heap);
 753     if (NULL == n)
 754       return;                   /* no pending messages */
 755     size = n->th->notify_size + sizeof (struct OutboundMessage);
 756   }
 757 #if DEBUG_TRANSPORT
 758   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Calling notify_transmit_ready\n");
 759 #endif
 760   h->cth =
 761       GNUNET_CLIENT_notify_transmit_ready (h->client, size,
 762                                            GNUNET_TIME_UNIT_FOREVER_REL,
 763                                            GNUNET_NO, &transport_notify_ready,
 764                                            h);
 765   GNUNET_assert (NULL != h->cth);
 766 }
 767
 768
 769 /**
 770  * Schedule the task to send one message, either from the control
 771  * list or the peer message queues  to the service.
 772  *
 773  * @param h transport service to schedule a transmission for
 774  */
 775 static void
 776 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
 777 {
 778   struct GNUNET_TIME_Relative delay;
 779   struct Neighbour *n;
 780
 781   GNUNET_assert (NULL != h->client);
 782   if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
 783   {
 784     GNUNET_SCHEDULER_cancel (h->quota_task);
 785     h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 786   }
 787   if (NULL != h->control_head)
 788     delay = GNUNET_TIME_UNIT_ZERO;
 789   else if (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap)))
 790     delay =
 791         GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
 792                                             n->th->notify_size);
 793   else
 794     return;                     /* no work to be done */
 795   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 796               "Scheduling next transmission to service in %llu ms\n",
 797               (unsigned long long) delay.rel_value);
 798   h->quota_task =
 799       GNUNET_SCHEDULER_add_delayed (delay, &schedule_transmission_task, h);
 800 }
 801
 802
 803 /**
 804  * Queue control request for transmission to the transport
 805  * service.
 806  *
 807  * @param h handle to the transport service
 808  * @param size number of bytes to be transmitted
 809  * @param notify function to call to get the content
 810  * @param notify_cls closure for notify
 811  */
 812 static void
 813 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h, size_t size,
 814                            GNUNET_CONNECTION_TransmitReadyNotify notify,
 815                            void *notify_cls)
 816 {
 817   struct GNUNET_TRANSPORT_TransmitHandle *th;
 818
 819 #if DEBUG_TRANSPORT
 820   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 821               "Control transmit of %u bytes requested\n", size);
 822 #endif
 823   th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
 824   th->notify = notify;
 825   th->notify_cls = notify_cls;
 826   th->notify_size = size;
 827   GNUNET_CONTAINER_DLL_insert_tail (h->control_head, h->control_tail, th);
 828   schedule_transmission (h);
 829 }
 830
 831
 832 /**
 833  * Transmit START message to service.
 834  *
 835  * @param cls unused
 836  * @param size number of bytes available in buf
 837  * @param buf where to copy the message
 838  * @return number of bytes copied to buf
 839  */
 840 static size_t
 841 send_start (void *cls, size_t size, void *buf)
 842 {
 843   struct GNUNET_TRANSPORT_Handle *h = cls;
 844   struct StartMessage s;
 845
 846   if (buf == NULL)
 847   {
 848     /* Can only be shutdown, just give up */
 849 #if DEBUG_TRANSPORT
 850     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 851                 "Shutdown while trying to transmit `%s' request.\n", "START");
 852 #endif
 853     return 0;
 854   }
 855 #if DEBUG_TRANSPORT
 856   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting `%s' request.\n", "START");
 857 #endif
 858   GNUNET_assert (size >= sizeof (struct StartMessage));
 859   s.header.size = htons (sizeof (struct StartMessage));
 860   s.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
 861   s.do_check = htonl (h->check_self);
 862   s.self = h->self;
 863   memcpy (buf, &s, sizeof (struct StartMessage));
 864   GNUNET_CLIENT_receive (h->client, &demultiplexer, h,
 865                          GNUNET_TIME_UNIT_FOREVER_REL);
 866   return sizeof (struct StartMessage);
 867 }
 868
 869
 870 /**
 871  * Try again to connect to transport service.
 872  *
 873  * @param cls the handle to the transport service
 874  * @param tc scheduler context
 875  */
 876 static void
 877 reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 878 {
 879   struct GNUNET_TRANSPORT_Handle *h = cls;
 880
 881   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 882   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 883   {
 884     /* shutdown, just give up */
 885     return;
 886   }
 887 #if DEBUG_TRANSPORT
 888   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
 889 #endif
 890   GNUNET_assert (h->client == NULL);
 891   GNUNET_assert (h->control_head == NULL);
 892   GNUNET_assert (h->control_tail == NULL);
 893   h->client = GNUNET_CLIENT_connect ("transport", h->cfg);
 894   GNUNET_assert (h->client != NULL);
 895   schedule_control_transmit (h, sizeof (struct StartMessage), &send_start, h);
 896 }
 897
 898
 899 /**
 900  * Function that will schedule the job that will try
 901  * to connect us again to the client.
 902  *
 903  * @param h transport service to reconnect
 904  */
 905 static void
 906 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
 907 {
 908   struct GNUNET_TRANSPORT_TransmitHandle *th;
 909
 910   GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
 911   /* Forget about all neighbours that we used to be connected to */
 912   GNUNET_CONTAINER_multihashmap_iterate (h->neighbours, &neighbour_delete, h);
 913   if (NULL != h->cth)
 914   {
 915     GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
 916     h->cth = NULL;
 917   }
 918   if (NULL != h->client)
 919   {
 920     GNUNET_CLIENT_disconnect (h->client, GNUNET_YES);
 921     h->client = NULL;
 922   }
 923   if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
 924   {
 925     GNUNET_SCHEDULER_cancel (h->quota_task);
 926     h->quota_task = GNUNET_SCHEDULER_NO_TASK;
 927   }
 928   while ((NULL != (th = h->control_head)))
 929   {
 930     GNUNET_CONTAINER_DLL_remove (h->control_head, h->control_tail, th);
 931     th->notify (th->notify_cls, 0, NULL);
 932     GNUNET_free (th);
 933   }
 934 #if DEBUG_TRANSPORT
 935   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 936               "Scheduling task to reconnect to transport service in %llu ms.\n",
 937               h->reconnect_delay.rel_value);
 938 #endif
 939   h->reconnect_task =
 940       GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect, h);
 941   if (h->reconnect_delay.rel_value == 0)
 942   {
 943     h->reconnect_delay = GNUNET_TIME_UNIT_MILLISECONDS;
 944   }
 945   else
 946   {
 947     h->reconnect_delay = GNUNET_TIME_relative_multiply (h->reconnect_delay, 2);
 948     h->reconnect_delay =
 949         GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS, h->reconnect_delay);
 950   }
 951 }
 952
 953
 954 /**
 955  * Closure for 'send_set_quota'.
 956  */
 957 struct SetQuotaContext
 958 {
 959
 960   /**
 961    * Identity of the peer impacted by the quota change.
 962    */
 963   struct GNUNET_PeerIdentity target;
 964
 965   /**
 966    * Quota to transmit.
 967    */
 968   struct GNUNET_BANDWIDTH_Value32NBO quota_in;
 969 };
 970
 971
 972 /**
 973  * Send SET_QUOTA message to the service.
 974  *
 975  * @param cls the 'struct SetQuotaContext'
 976  * @param size number of bytes available in buf
 977  * @param buf where to copy the message
 978  * @return number of bytes copied to buf
 979  */
 980 static size_t
 981 send_set_quota (void *cls, size_t size, void *buf)
 982 {
 983   struct SetQuotaContext *sqc = cls;
 984   struct QuotaSetMessage msg;
 985
 986   if (buf == NULL)
 987   {
 988     GNUNET_free (sqc);
 989     return 0;
 990   }
 991 #if DEBUG_TRANSPORT
 992   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 993               "Transmitting `%s' request with respect to `%4s'.\n", "SET_QUOTA",
 994               GNUNET_i2s (&sqc->target));
 995 #endif
 996   GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
 997   msg.header.size = htons (sizeof (struct QuotaSetMessage));
 998   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
 999   msg.quota = sqc->quota_in;
1000   msg.peer = sqc->target;
1001   memcpy (buf, &msg, sizeof (msg));
1002   GNUNET_free (sqc);
1003   return sizeof (struct QuotaSetMessage);
1004 }
1005
1006
1007 /**
1008  * Set the share of incoming bandwidth for the given
1009  * peer to the specified amount.
1010  *
1011  * @param handle connection to transport service
1012  * @param target who's bandwidth quota is being changed
1013  * @param quota_in incoming bandwidth quota in bytes per ms
1014  * @param quota_out outgoing bandwidth quota in bytes per ms
1015  */
1016 void
1017 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
1018                             const struct GNUNET_PeerIdentity *target,
1019                             struct GNUNET_BANDWIDTH_Value32NBO quota_in,
1020                             struct GNUNET_BANDWIDTH_Value32NBO quota_out)
1021 {
1022   struct Neighbour *n;
1023   struct SetQuotaContext *sqc;
1024
1025   n = neighbour_find (handle, target);
1026   if (NULL == n)
1027   {
1028     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1029                 "Quota changed to %u for peer `%s', but I have no such neighbour!\n",
1030                 (unsigned int) ntohl (quota_out.value__), GNUNET_i2s (target));
1031     return;
1032   }
1033   GNUNET_assert (NULL != handle->client);
1034 #if DEBUG_TRANSPORT
1035   if (ntohl (quota_out.value__) != n->out_tracker.available_bytes_per_s__)
1036     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1037                 "Quota changed from %u to %u for peer `%s'\n",
1038                 (unsigned int) n->out_tracker.available_bytes_per_s__,
1039                 (unsigned int) ntohl (quota_out.value__), GNUNET_i2s (target));
1040   else
1041     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Quota remains at %u for peer `%s'\n",
1042                 (unsigned int) n->out_tracker.available_bytes_per_s__,
1043                 GNUNET_i2s (target));
1044 #endif
1045   GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker, quota_out);
1046   sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
1047   sqc->target = *target;
1048   sqc->quota_in = quota_in;
1049   schedule_control_transmit (handle, sizeof (struct QuotaSetMessage),
1050                              &send_set_quota, sqc);
1051 }
1052
1053
1054 /**
1055  * Send REQUEST_CONNECT message to the service.
1056  *
1057  * @param cls the 'struct GNUNET_PeerIdentity'
1058  * @param size number of bytes available in buf
1059  * @param buf where to copy the message
1060  * @return number of bytes copied to buf
1061  */
1062 static size_t
1063 send_try_connect (void *cls, size_t size, void *buf)
1064 {
1065   struct GNUNET_PeerIdentity *pid = cls;
1066   struct TransportRequestConnectMessage msg;
1067
1068   if (buf == NULL)
1069   {
1070     GNUNET_free (pid);
1071     return 0;
1072   }
1073 #if DEBUG_TRANSPORT
1074   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1075               "Transmitting `%s' request with respect to `%4s'.\n",
1076               "REQUEST_CONNECT", GNUNET_i2s (pid));
1077 #endif
1078   GNUNET_assert (size >= sizeof (struct TransportRequestConnectMessage));
1079   msg.header.size = htons (sizeof (struct TransportRequestConnectMessage));
1080   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT);
1081   msg.reserved = htonl (0);
1082   msg.peer = *pid;
1083   memcpy (buf, &msg, sizeof (msg));
1084   GNUNET_free (pid);
1085   return sizeof (struct TransportRequestConnectMessage);
1086 }
1087
1088
1089 /**
1090  * Ask the transport service to establish a connection to
1091  * the given peer.
1092  *
1093  * @param handle connection to transport service
1094  * @param target who we should try to connect to
1095  */
1096 void
1097 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
1098                               const struct GNUNET_PeerIdentity *target)
1099 {
1100   struct GNUNET_PeerIdentity *pid;
1101
1102   if (NULL == handle->client)
1103     return;
1104   pid = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
1105   *pid = *target;
1106   schedule_control_transmit (handle,
1107                              sizeof (struct TransportRequestConnectMessage),
1108                              &send_try_connect, pid);
1109 }
1110
1111
1112 /**
1113  * Send HELLO message to the service.
1114  *
1115  * @param cls the HELLO message to send
1116  * @param size number of bytes available in buf
1117  * @param buf where to copy the message
1118  * @return number of bytes copied to buf
1119  */
1120 static size_t
1121 send_hello (void *cls, size_t size, void *buf)
1122 {
1123   struct GNUNET_MessageHeader *msg = cls;
1124   uint16_t ssize;
1125
1126   if (buf == NULL)
1127   {
1128 #if DEBUG_TRANSPORT_TIMEOUT
1129     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1130                 "Timeout while trying to transmit `%s' request.\n", "HELLO");
1131 #endif
1132     GNUNET_free (msg);
1133     return 0;
1134   }
1135 #if DEBUG_TRANSPORT
1136   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting `%s' request.\n", "HELLO");
1137 #endif
1138   ssize = ntohs (msg->size);
1139   GNUNET_assert (size >= ssize);
1140   memcpy (buf, msg, ssize);
1141   GNUNET_free (msg);
1142   return ssize;
1143 }
1144
1145
1146 /**
1147  * Offer the transport service the HELLO of another peer.  Note that
1148  * the transport service may just ignore this message if the HELLO is
1149  * malformed or useless due to our local configuration.
1150  *
1151  * @param handle connection to transport service
1152  * @param hello the hello message
1153  * @param cont continuation to call when HELLO has been sent
1154  * @param cls closure for continuation
1155  *
1156  */
1157 void
1158 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
1159                               const struct GNUNET_MessageHeader *hello,
1160                               GNUNET_SCHEDULER_Task cont, void *cls)
1161 {
1162   uint16_t size;
1163   struct GNUNET_PeerIdentity peer;
1164   struct GNUNET_MessageHeader *msg;
1165
1166   if (NULL == handle->client)
1167     return;
1168   GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
1169   size = ntohs (hello->size);
1170   GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
1171   if (GNUNET_OK !=
1172       GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) hello, &peer))
1173   {
1174     GNUNET_break (0);
1175     return;
1176   }
1177   msg = GNUNET_malloc (size);
1178   memcpy (msg, hello, size);
1179 #if DEBUG_TRANSPORT
1180   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1181               "Offering `%s' message of `%4s' to transport for validation.\n",
1182               "HELLO", GNUNET_i2s (&peer));
1183 #endif
1184   schedule_control_transmit (handle, size, &send_hello, msg);
1185 }
1186
1187
1188 /**
1189  * Obtain the HELLO message for this peer.
1190  *
1191  * @param handle connection to transport service
1192  * @param rec function to call with the HELLO, sender will be our peer
1193  *            identity; message and sender will be NULL on timeout
1194  *            (handshake with transport service pending/failed).
1195  *             cost estimate will be 0.
1196  * @param rec_cls closure for rec
1197  * @return handle to cancel the operation
1198  */
1199 struct GNUNET_TRANSPORT_GetHelloHandle *
1200 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
1201                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
1202                             void *rec_cls)
1203 {
1204   struct GNUNET_TRANSPORT_GetHelloHandle *hwl;
1205
1206   hwl = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_GetHelloHandle));
1207   hwl->rec = rec;
1208   hwl->rec_cls = rec_cls;
1209   hwl->handle = handle;
1210   GNUNET_CONTAINER_DLL_insert (handle->hwl_head, handle->hwl_tail, hwl);
1211   if (handle->my_hello != NULL)
1212     rec (rec_cls, (const struct GNUNET_MessageHeader *) handle->my_hello);
1213   return hwl;
1214 }
1215
1216
1217 /**
1218  * Stop receiving updates about changes to our HELLO message.
1219  *
1220  * @param ghh handle to cancel
1221  */
1222 void
1223 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh)
1224 {
1225   struct GNUNET_TRANSPORT_Handle *handle = ghh->handle;
1226
1227   GNUNET_CONTAINER_DLL_remove (handle->hwl_head, handle->hwl_tail, ghh);
1228   GNUNET_free (ghh);
1229 }
1230
1231
1232 /**
1233  * Connect to the transport service.  Note that the connection may
1234  * complete (or fail) asynchronously.
1235  *
1236  * @param cfg configuration to use
1237  * @param self our own identity (API should check that it matches
1238  *             the identity found by transport), or NULL (no check)
1239  * @param cls closure for the callbacks
1240  * @param rec receive function to call
1241  * @param nc function to call on connect events
1242  * @param nd function to call on disconnect events
1243  */
1244 struct GNUNET_TRANSPORT_Handle *
1245 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1246                           const struct GNUNET_PeerIdentity *self, void *cls,
1247                           GNUNET_TRANSPORT_ReceiveCallback rec,
1248                           GNUNET_TRANSPORT_NotifyConnect nc,
1249                           GNUNET_TRANSPORT_NotifyDisconnect nd)
1250 {
1251   struct GNUNET_TRANSPORT_Handle *ret;
1252
1253   ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1254   if (self != NULL)
1255   {
1256     ret->self = *self;
1257     ret->check_self = GNUNET_YES;
1258   }
1259   ret->cfg = cfg;
1260   ret->cls = cls;
1261   ret->rec = rec;
1262   ret->nc_cb = nc;
1263   ret->nd_cb = nd;
1264   ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1265   ret->neighbours =
1266       GNUNET_CONTAINER_multihashmap_create (STARTING_NEIGHBOURS_SIZE);
1267   ret->ready_heap =
1268       GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1269   ret->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect, ret);
1270   return ret;
1271 }
1272
1273
1274 /**
1275  * Disconnect from the transport service.
1276  *
1277  * @param handle handle to the service as returned from GNUNET_TRANSPORT_connect
1278  */
1279 void
1280 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1281 {
1282 #if DEBUG_TRANSPORT
1283   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transport disconnect called!\n");
1284 #endif
1285   /* this disconnects all neighbours... */
1286   if (handle->reconnect_task == GNUNET_SCHEDULER_NO_TASK)
1287     disconnect_and_schedule_reconnect (handle);
1288   /* and now we stop trying to connect again... */
1289   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1290   {
1291     GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1292     handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1293   }
1294   GNUNET_CONTAINER_multihashmap_destroy (handle->neighbours);
1295   handle->neighbours = NULL;
1296   if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
1297   {
1298     GNUNET_SCHEDULER_cancel (handle->quota_task);
1299     handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
1300   }
1301   GNUNET_free_non_null (handle->my_hello);
1302   handle->my_hello = NULL;
1303   GNUNET_assert (handle->hwl_head == NULL);
1304   GNUNET_assert (handle->hwl_tail == NULL);
1305   GNUNET_CONTAINER_heap_destroy (handle->ready_heap);
1306   handle->ready_heap = NULL;
1307   GNUNET_free (handle);
1308 }
1309
1310
1311 /**
1312  * Check if we could queue a message of the given size for
1313  * transmission.  The transport service will take both its
1314  * internal buffers and bandwidth limits imposed by the
1315  * other peer into consideration when answering this query.
1316  *
1317  * @param handle connection to transport service
1318  * @param target who should receive the message
1319  * @param size how big is the message we want to transmit?
1320  * @param priority how important is the message?
1321  * @param timeout after how long should we give up (and call
1322  *        notify with buf NULL and size 0)?
1323  * @param notify function to call when we are ready to
1324  *        send such a message
1325  * @param notify_cls closure for notify
1326  * @return NULL if someone else is already waiting to be notified
1327  *         non-NULL if the notify callback was queued (can be used to cancel
1328  *         using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1329  */
1330 struct GNUNET_TRANSPORT_TransmitHandle *
1331 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
1332                                         const struct GNUNET_PeerIdentity
1333                                         *target, size_t size, uint32_t priority,
1334                                         struct GNUNET_TIME_Relative timeout,
1335                                         GNUNET_CONNECTION_TransmitReadyNotify
1336                                         notify, void *notify_cls)
1337 {
1338   struct Neighbour *n;
1339   struct GNUNET_TRANSPORT_TransmitHandle *th;
1340   struct GNUNET_TIME_Relative delay;
1341
1342   n = neighbour_find (handle, target);
1343   if (NULL == n)
1344   {
1345     /* use GNUNET_TRANSPORT_try_connect first, only use this function
1346      * once a connection has been established */
1347     GNUNET_assert (0);
1348     return NULL;
1349   }
1350   if (NULL != n->th)
1351   {
1352     /* attempt to send two messages at the same time to the same peer */
1353     GNUNET_assert (0);
1354     return NULL;
1355   }
1356   GNUNET_assert (NULL == n->hn);
1357   th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
1358   th->neighbour = n;
1359   th->notify = notify;
1360   th->notify_cls = notify_cls;
1361   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1362   th->notify_size = size;
1363   th->priority = priority;
1364   n->th = th;
1365   /* calculate when our transmission should be ready */
1366   delay = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker, size);
1367   if (delay.rel_value > timeout.rel_value)
1368     delay.rel_value = 0;        /* notify immediately (with failure) */
1369 #if DEBUG_TRANSPORT
1370   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1371               "Bandwidth tracker allows next transmission to peer %s in %llu ms\n",
1372               GNUNET_i2s (target), (unsigned long long) delay.rel_value);
1373 #endif
1374   n->hn = GNUNET_CONTAINER_heap_insert (handle->ready_heap, n, delay.rel_value);
1375   schedule_transmission (handle);
1376   return th;
1377 }
1378
1379
1380 /**
1381  * Cancel the specified transmission-ready notification.
1382  *
1383  * @param th handle returned from GNUNET_TRANSPORT_notify_transmit_ready
1384  */
1385 void
1386 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
1387                                                GNUNET_TRANSPORT_TransmitHandle
1388                                                *th)
1389 {
1390   struct Neighbour *n;
1391
1392   GNUNET_assert (NULL == th->next);
1393   GNUNET_assert (NULL == th->prev);
1394   n = th->neighbour;
1395   GNUNET_assert (th == n->th);
1396   n->th = NULL;
1397   if (n->hn != NULL)
1398   {
1399     GNUNET_CONTAINER_heap_remove_node (n->hn);
1400     n->hn = NULL;
1401   }
1402   else
1403   {
1404     GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != th->timeout_task);
1405     GNUNET_SCHEDULER_cancel (th->timeout_task);
1406     th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1407   }
1408   GNUNET_free (th);
1409 }
1410
1411
1412 /* end of transport_api.c */