src/transport/transport_api.c

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