src/core/core_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 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 core/core_api.c
  23  * @brief core service; this is the main API for encrypted P2P
  24  *        communications
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_constants.h"
  29 #include "gnunet_core_service.h"
  30 #include "core.h"
  31
  32
  33 /**
  34  * Information we track for each peer.
  35  */
  36 struct PeerRecord
  37 {
  38
  39   /**
  40    * We generally do NOT keep peer records in a DLL; this
  41    * DLL is only used IF this peer's 'pending_head' message
  42    * is ready for transmission.
  43    */
  44   struct PeerRecord *prev;
  45
  46   /**
  47    * We generally do NOT keep peer records in a DLL; this
  48    * DLL is only used IF this peer's 'pending_head' message
  49    * is ready for transmission.
  50    */
  51   struct PeerRecord *next;
  52
  53   /**
  54    * Peer the record is about.
  55    */
  56   struct GNUNET_PeerIdentity peer;
  57
  58   /**
  59    * Corresponding core handle.
  60    */
  61   struct GNUNET_CORE_Handle *ch;
  62
  63   /**
  64    * Head of doubly-linked list of pending requests.
  65    * Requests are sorted by deadline *except* for HEAD,
  66    * which is only modified upon transmission to core.
  67    */
  68   struct GNUNET_CORE_TransmitHandle *pending_head;
  69
  70   /**
  71    * Tail of doubly-linked list of pending requests.
  72    */
  73   struct GNUNET_CORE_TransmitHandle *pending_tail;
  74
  75   /**
  76    * Pending callback waiting for peer information, or NULL for none.
  77    */
  78   GNUNET_CORE_PeerConfigurationInfoCallback pcic;
  79
  80   /**
  81    * Closure for pcic.
  82    */
  83   void *pcic_cls;
  84
  85   /**
  86    * Request information ID for the given pcic (needed in case a
  87    * request is cancelled after being submitted to core and a new
  88    * one is generated; in this case, we need to avoid matching the
  89    * reply to the first (cancelled) request to the second request).
  90    */
  91   uint32_t rim_id;
  92
  93   /**
  94    * ID of timeout task for the 'pending_head' handle
  95    * which is the one with the smallest timeout.
  96    */
  97   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
  98
  99   /**
 100    * Current size of the queue of pending requests.
 101    */
 102   unsigned int queue_size;
 103
 104   /**
 105    * SendMessageRequest ID generator for this peer.
 106    */
 107   uint16_t smr_id_gen;
 108
 109 };
 110
 111
 112 /**
 113  * Entry in a doubly-linked list of control messages to be transmitted
 114  * to the core service.  Control messages include traffic allocation,
 115  * connection requests and of course our initial 'init' request.
 116  *
 117  * The actual message is allocated at the end of this struct.
 118  */
 119 struct ControlMessage
 120 {
 121   /**
 122    * This is a doubly-linked list.
 123    */
 124   struct ControlMessage *next;
 125
 126   /**
 127    * This is a doubly-linked list.
 128    */
 129   struct ControlMessage *prev;
 130
 131   /**
 132    * Function to run after transmission failed/succeeded.
 133    */
 134   GNUNET_CORE_ControlContinuation cont;
 135
 136   /**
 137    * Closure for 'cont'.
 138    */
 139   void *cont_cls;
 140
 141   /**
 142    * Transmit handle (if one is associated with this ControlMessage), or NULL.
 143    */
 144   struct GNUNET_CORE_TransmitHandle *th;
 145 };
 146
 147
 148
 149 /**
 150  * Context for the core service connection.
 151  */
 152 struct GNUNET_CORE_Handle
 153 {
 154
 155   /**
 156    * Configuration we're using.
 157    */
 158   const struct GNUNET_CONFIGURATION_Handle *cfg;
 159
 160   /**
 161    * Closure for the various callbacks.
 162    */
 163   void *cls;
 164
 165   /**
 166    * Function to call once we've handshaked with the core service.
 167    */
 168   GNUNET_CORE_StartupCallback init;
 169
 170   /**
 171    * Function to call whenever we're notified about a peer connecting.
 172    */
 173   GNUNET_CORE_ConnectEventHandler connects;
 174
 175   /**
 176    * Function to call whenever we're notified about a peer disconnecting.
 177    */
 178   GNUNET_CORE_DisconnectEventHandler disconnects;
 179
 180   /**
 181    * Function to call whenever we're notified about a peer changing status.
 182    */
 183   GNUNET_CORE_PeerStatusEventHandler status_events;
 184
 185   /**
 186    * Function to call whenever we receive an inbound message.
 187    */
 188   GNUNET_CORE_MessageCallback inbound_notify;
 189
 190   /**
 191    * Function to call whenever we receive an outbound message.
 192    */
 193   GNUNET_CORE_MessageCallback outbound_notify;
 194
 195   /**
 196    * Function handlers for messages of particular type.
 197    */
 198   const struct GNUNET_CORE_MessageHandler *handlers;
 199
 200   /**
 201    * Our connection to the service.
 202    */
 203   struct GNUNET_CLIENT_Connection *client;
 204
 205   /**
 206    * Handle for our current transmission request.
 207    */
 208   struct GNUNET_CLIENT_TransmitHandle *cth;
 209
 210   /**
 211    * Head of doubly-linked list of pending requests.
 212    */
 213   struct ControlMessage *control_pending_head;
 214
 215   /**
 216    * Tail of doubly-linked list of pending requests.
 217    */
 218   struct ControlMessage *control_pending_tail;
 219
 220   /**
 221    * Head of doubly-linked list of peers that are core-approved
 222    * to send their next message.
 223    */
 224   struct PeerRecord *ready_peer_head;
 225
 226   /**
 227    * Tail of doubly-linked list of peers that are core-approved
 228    * to send their next message.
 229    */
 230   struct PeerRecord *ready_peer_tail;
 231
 232   /**
 233    * Hash map listing all of the peers that we are currently
 234    * connected to.
 235    */
 236   struct GNUNET_CONTAINER_MultiHashMap *peers;
 237
 238   /**
 239    * Identity of this peer.
 240    */
 241   struct GNUNET_PeerIdentity me;
 242
 243   /**
 244    * ID of reconnect task (if any).
 245    */
 246   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
 247
 248   /**
 249    * Current delay we use for re-trying to connect to core.
 250    */
 251   struct GNUNET_TIME_Relative retry_backoff;
 252
 253   /**
 254    * Request information ID generator.
 255    */
 256   uint32_t rim_id_gen;
 257
 258   /**
 259    * Number of messages we are allowed to queue per target.
 260    */
 261   unsigned int queue_size;
 262
 263   /**
 264    * Number of entries in the handlers array.
 265    */
 266   unsigned int hcnt;
 267
 268   /**
 269    * For inbound notifications without a specific handler, do
 270    * we expect to only receive headers?
 271    */
 272   int inbound_hdr_only;
 273
 274   /**
 275    * For outbound notifications without a specific handler, do
 276    * we expect to only receive headers?
 277    */
 278   int outbound_hdr_only;
 279
 280   /**
 281    * Are we currently disconnected and hence unable to forward
 282    * requests?
 283    */
 284   int currently_down;
 285
 286 };
 287
 288
 289 /**
 290  * Handle for a transmission request.
 291  */
 292 struct GNUNET_CORE_TransmitHandle
 293 {
 294
 295   /**
 296    * We keep active transmit handles in a doubly-linked list.
 297    */
 298   struct GNUNET_CORE_TransmitHandle *next;
 299
 300   /**
 301    * We keep active transmit handles in a doubly-linked list.
 302    */
 303   struct GNUNET_CORE_TransmitHandle *prev;
 304
 305   /**
 306    * Corresponding peer record.
 307    */
 308   struct PeerRecord *peer;
 309
 310   /**
 311    * Corresponding SEND_REQUEST message.  Only non-NULL
 312    * while SEND_REQUEST message is pending.
 313    */
 314   struct ControlMessage *cm;
 315
 316   /**
 317    * Function that will be called to get the actual request
 318    * (once we are ready to transmit this request to the core).
 319    * The function will be called with a NULL buffer to signal
 320    * timeout.
 321    */
 322   GNUNET_CONNECTION_TransmitReadyNotify get_message;
 323
 324   /**
 325    * Closure for get_message.
 326    */
 327   void *get_message_cls;
 328
 329   /**
 330    * Timeout for this handle.
 331    */
 332   struct GNUNET_TIME_Absolute timeout;
 333
 334   /**
 335    * How important is this message?
 336    */
 337   uint32_t priority;
 338
 339   /**
 340    * Size of this request.
 341    */
 342   uint16_t msize;
 343
 344   /**
 345    * Send message request ID for this request.
 346    */
 347   uint16_t smr_id;
 348
 349 };
 350
 351
 352 /**
 353  * Our current client connection went down.  Clean it up
 354  * and try to reconnect!
 355  *
 356  * @param h our handle to the core service
 357  */
 358 static void
 359 reconnect (struct GNUNET_CORE_Handle *h);
 360
 361
 362 /**
 363  * Task schedule to try to re-connect to core.
 364  *
 365  * @param cls the 'struct GNUNET_CORE_Handle'
 366  * @param tc task context
 367  */
 368 static void
 369 reconnect_task (void *cls,
 370                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 371 {
 372   struct GNUNET_CORE_Handle *h = cls;
 373
 374   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 375 #if DEBUG_CORE
 376   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 377               "Connecting to CORE service after delay\n");
 378 #endif
 379   reconnect (h);
 380 }
 381
 382
 383 /**
 384  * Notify clients about disconnect and free
 385  * the entry for connected peer.
 386  *
 387  * @param cls the 'struct GNUNET_CORE_Handle*'
 388  * @param key the peer identity (not used)
 389  * @param value the 'struct PeerRecord' to free.
 390  * @return GNUNET_YES (continue)
 391  */
 392 static int
 393 disconnect_and_free_peer_entry (void *cls,
 394                                 const GNUNET_HashCode *key,
 395                                 void *value)
 396 {
 397   static struct GNUNET_BANDWIDTH_Value32NBO zero;
 398   struct GNUNET_CORE_Handle *h = cls;
 399   struct GNUNET_CORE_TransmitHandle *th;
 400   struct PeerRecord *pr = value;
 401   GNUNET_CORE_PeerConfigurationInfoCallback pcic;
 402
 403   while (NULL != (th = pr->pending_head))
 404     {
 405       GNUNET_CONTAINER_DLL_remove (pr->pending_head,
 406                                    pr->pending_tail,
 407                                    th);
 408       pr->queue_size--;
 409       GNUNET_assert (0 ==
 410                      th->get_message (th->get_message_cls,
 411                                       0, NULL));
 412       GNUNET_free (th);
 413     }
 414   if (NULL != (pcic = pr->pcic))
 415     {
 416       pr->pcic = NULL;
 417       pcic (pr->pcic_cls,
 418             &pr->peer,
 419             zero,
 420             0, 0);
 421     }
 422   if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
 423     {
 424       GNUNET_SCHEDULER_cancel (pr->timeout_task);
 425       pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 426     }
 427   GNUNET_assert (pr->queue_size == 0);
 428   if ( (pr->prev != NULL) ||
 429        (pr->next != NULL) ||
 430        (h->ready_peer_head == pr) )
 431     GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
 432                                  h->ready_peer_tail,
 433                                  pr);
 434   if (h->disconnects != NULL)
 435     h->disconnects (h->cls,
 436                     &pr->peer);
 437   GNUNET_assert (GNUNET_YES ==
 438                  GNUNET_CONTAINER_multihashmap_remove (h->peers,
 439                                                        key,
 440                                                        pr));
 441   GNUNET_assert (pr->pending_head == NULL);
 442   GNUNET_assert (pr->pending_tail == NULL);
 443   GNUNET_assert (pr->ch = h);
 444   GNUNET_assert (pr->queue_size == 0);
 445   GNUNET_assert (pr->timeout_task == GNUNET_SCHEDULER_NO_TASK);
 446   GNUNET_free (pr);
 447   return GNUNET_YES;
 448 }
 449
 450
 451 /**
 452  * Close down any existing connection to the CORE service and
 453  * try re-establishing it later.
 454  *
 455  * @param h our handle
 456  */
 457 static void
 458 reconnect_later (struct GNUNET_CORE_Handle *h)
 459 {
 460   struct ControlMessage *cm;
 461   struct PeerRecord *pr;
 462
 463   GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
 464   if (h->client != NULL)
 465     {
 466       GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
 467       h->client = NULL;
 468       h->cth = NULL;
 469       GNUNET_CONTAINER_multihashmap_iterate (h->peers,
 470                                              &disconnect_and_free_peer_entry,
 471                                              h);
 472     }
 473   while (NULL != (pr = h->ready_peer_head))
 474     GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
 475                                  h->ready_peer_tail,
 476                                  pr);
 477   h->currently_down = GNUNET_YES;
 478   h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->retry_backoff,
 479                                                     &reconnect_task,
 480                                                     h);
 481   while (NULL != (cm = h->control_pending_head))
 482     {
 483       GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
 484                                    h->control_pending_tail,
 485                                    cm);
 486       if (cm->th != NULL)
 487         cm->th->cm = NULL;
 488       if (cm->cont != NULL)
 489         cm->cont (cm->cont_cls, GNUNET_NO);
 490       GNUNET_free (cm);
 491     }
 492   GNUNET_assert (h->control_pending_head == NULL);
 493   h->retry_backoff = GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
 494                                                h->retry_backoff);
 495   h->retry_backoff = GNUNET_TIME_relative_multiply (h->retry_backoff, 2);
 496 }
 497
 498
 499 /**
 500  * Check the list of pending requests, send the next
 501  * one to the core.
 502  *
 503  * @param h core handle
 504  * @param ignore_currently_down transmit message even if not initialized?
 505  */
 506 static void
 507 trigger_next_request (struct GNUNET_CORE_Handle *h,
 508                       int ignore_currently_down);
 509
 510
 511 /**
 512  * The given request hit its timeout.  Remove from the
 513  * doubly-linked list and call the respective continuation.
 514  *
 515  * @param cls the transmit handle of the request that timed out
 516  * @param tc context, can be NULL (!)
 517  */
 518 static void
 519 transmission_timeout (void *cls,
 520                       const struct GNUNET_SCHEDULER_TaskContext *tc);
 521
 522
 523 /**
 524  * Send a control message to the peer asking for transmission
 525  * of the message in the given peer record.
 526  *
 527  * @param pr peer to request transmission to
 528  */
 529 static void
 530 request_next_transmission (struct PeerRecord *pr)
 531 {
 532   struct GNUNET_CORE_Handle *h = pr->ch;
 533   struct ControlMessage *cm;
 534   struct SendMessageRequest *smr;
 535   struct GNUNET_CORE_TransmitHandle *th;
 536
 537   if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
 538     {
 539       GNUNET_SCHEDULER_cancel (pr->timeout_task);
 540       pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 541     }
 542   if (NULL == (th = pr->pending_head))
 543     {
 544       trigger_next_request (h, GNUNET_NO);
 545       return;
 546     }
 547   if (th->cm != NULL)
 548     return; /* already done */
 549   GNUNET_assert (pr->prev == NULL);
 550   GNUNET_assert (pr->next == NULL);
 551   pr->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (th->timeout),
 552                                                    &transmission_timeout,
 553                                                    pr);
 554   cm = GNUNET_malloc (sizeof (struct ControlMessage) +
 555                       sizeof (struct SendMessageRequest));
 556   th->cm = cm;
 557   cm->th = th;
 558   smr = (struct SendMessageRequest*) &cm[1];
 559   smr->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST);
 560   smr->header.size = htons (sizeof (struct SendMessageRequest));
 561   smr->priority = htonl (th->priority);
 562   smr->deadline = GNUNET_TIME_absolute_hton (th->timeout);
 563   smr->peer = pr->peer;
 564   smr->queue_size = htonl (pr->queue_size);
 565   smr->size = htons (th->msize);
 566   smr->smr_id = htons (th->smr_id = pr->smr_id_gen++);
 567   GNUNET_CONTAINER_DLL_insert_after (h->control_pending_head,
 568                                      h->control_pending_tail,
 569                                      h->control_pending_tail,
 570                                      cm);
 571 #if DEBUG_CORE
 572   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 573               "Adding SEND REQUEST for peer `%s' to message queue\n",
 574               GNUNET_i2s (&pr->peer));
 575 #endif
 576   trigger_next_request (h, GNUNET_NO);
 577 }
 578
 579
 580 /**
 581  * The given request hit its timeout.  Remove from the
 582  * doubly-linked list and call the respective continuation.
 583  *
 584  * @param cls the transmit handle of the request that timed out
 585  * @param tc context, can be NULL (!)
 586  */
 587 static void
 588 transmission_timeout (void *cls,
 589                       const struct GNUNET_SCHEDULER_TaskContext *tc)
 590 {
 591   struct PeerRecord *pr = cls;
 592   struct GNUNET_CORE_Handle *h = pr->ch;
 593   struct GNUNET_CORE_TransmitHandle *th;
 594
 595   pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 596   th = pr->pending_head;
 597   GNUNET_CONTAINER_DLL_remove (pr->pending_head,
 598                                pr->pending_tail,
 599                                th);
 600   pr->queue_size--;
 601   if ( (pr->prev != NULL) ||
 602        (pr->next != NULL) ||
 603        (pr == h->ready_peer_head) )
 604     {
 605       /* the request that was 'approved' by core was
 606          canceled before it could be transmitted; remove
 607          us from the 'ready' list */
 608       GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
 609                                    h->ready_peer_tail,
 610                                    pr);
 611     }
 612 #if DEBUG_CORE
 613   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 614               "Signalling timeout of request for transmission to CORE service\n");
 615 #endif
 616   GNUNET_assert (0 == th->get_message (th->get_message_cls, 0, NULL));
 617   request_next_transmission (pr);
 618 }
 619
 620
 621 /**
 622  * Transmit the next message to the core service.
 623  */
 624 static size_t
 625 transmit_message (void *cls,
 626                   size_t size,
 627                   void *buf)
 628 {
 629   struct GNUNET_CORE_Handle *h = cls;
 630   struct ControlMessage *cm;
 631   struct GNUNET_CORE_TransmitHandle *th;
 632   struct PeerRecord *pr;
 633   struct SendMessage *sm;
 634   const struct GNUNET_MessageHeader *hdr;
 635   uint16_t msize;
 636   size_t ret;
 637
 638   GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
 639   h->cth = NULL;
 640   if (buf == NULL)
 641     {
 642 #if DEBUG_CORE
 643       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 644                   "Transmission failed, initiating reconnect\n");
 645 #endif
 646       reconnect_later (h);
 647       return 0;
 648     }
 649   /* first check for control messages */
 650   if (NULL != (cm = h->control_pending_head))
 651     {
 652       hdr = (const struct GNUNET_MessageHeader*) &cm[1];
 653       msize = ntohs (hdr->size);
 654       if (size < msize)
 655         {
 656           trigger_next_request (h, GNUNET_NO);
 657           return 0;
 658         }
 659 #if DEBUG_CORE
 660       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 661                   "Transmitting control message with %u bytes of type %u to core.\n",
 662                   (unsigned int) msize,
 663                   (unsigned int) ntohs (hdr->type));
 664 #endif
 665       memcpy (buf, hdr, msize);
 666       GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
 667                                    h->control_pending_tail,
 668                                    cm);
 669       if (cm->th != NULL)
 670         cm->th->cm = NULL;
 671       if (NULL != cm->cont)
 672         cm->cont (cm->cont_cls, GNUNET_OK);
 673       GNUNET_free (cm);
 674       trigger_next_request (h, GNUNET_NO);
 675       return msize;
 676     }
 677   /* now check for 'ready' P2P messages */
 678   if (NULL != (pr = h->ready_peer_head))
 679     {
 680       GNUNET_assert (pr->pending_head != NULL);
 681       th = pr->pending_head;
 682       if (size < th->msize + sizeof (struct SendMessage))
 683         {
 684           trigger_next_request (h, GNUNET_NO);
 685           return 0;
 686         }
 687       GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
 688                                    h->ready_peer_tail,
 689                                    pr);
 690       GNUNET_CONTAINER_DLL_remove (pr->pending_head,
 691                                    pr->pending_tail,
 692                                    th);
 693       pr->queue_size--;
 694       if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
 695         {
 696           GNUNET_SCHEDULER_cancel (pr->timeout_task);
 697           pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 698         }
 699 #if DEBUG_CORE
 700       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 701                   "Transmitting SEND request to `%s' with %u bytes.\n",
 702                   GNUNET_i2s (&pr->peer),
 703                   (unsigned int) th->msize);
 704 #endif
 705       sm = (struct SendMessage *) buf;
 706       sm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND);
 707       sm->priority = htonl (th->priority);
 708       sm->deadline = GNUNET_TIME_absolute_hton (th->timeout);
 709       sm->peer = pr->peer;
 710       ret = th->get_message (th->get_message_cls,
 711                              size - sizeof (struct SendMessage),
 712                              &sm[1]);
 713
 714       if (0 == ret)
 715         {
 716 #if DEBUG_CORE
 717           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 718                       "Size of clients message to peer %s is 0!\n",
 719                       GNUNET_i2s(&pr->peer));
 720 #endif
 721           /* client decided to send nothing! */
 722           request_next_transmission (pr);
 723           return 0;
 724         }
 725 #if DEBUG_CORE
 726       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 727                   "Produced SEND message to core with %u bytes payload\n",
 728                   (unsigned int) ret);
 729 #endif
 730       GNUNET_assert (ret >= sizeof (struct GNUNET_MessageHeader));
 731       if (ret + sizeof (struct SendMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 732         {
 733           GNUNET_break (0);
 734           request_next_transmission (pr);
 735           return 0;
 736         }
 737       ret += sizeof (struct SendMessage);
 738       sm->header.size = htons (ret);
 739       GNUNET_assert (ret <= size);
 740       GNUNET_free (th);
 741       request_next_transmission (pr);
 742       return ret;
 743     }
 744   return 0;
 745 }
 746
 747
 748 /**
 749  * Check the list of pending requests, send the next
 750  * one to the core.
 751  *
 752  * @param h core handle
 753  * @param ignore_currently_down transmit message even if not initialized?
 754  */
 755 static void
 756 trigger_next_request (struct GNUNET_CORE_Handle *h,
 757                       int ignore_currently_down)
 758 {
 759   uint16_t msize;
 760
 761   if ( (GNUNET_YES == h->currently_down) &&
 762        (ignore_currently_down == GNUNET_NO) )
 763     {
 764 #if DEBUG_CORE
 765       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 766                   "Core connection down, not processing queue\n");
 767 #endif
 768       return;
 769     }
 770   if (NULL != h->cth)
 771     {
 772 #if DEBUG_CORE
 773       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 774                   "Request pending, not processing queue\n");
 775 #endif
 776       return;
 777     }
 778   if (h->control_pending_head != NULL)
 779     msize = ntohs (((struct GNUNET_MessageHeader*) &h->control_pending_head[1])->size);
 780   else if (h->ready_peer_head != NULL)
 781     msize = h->ready_peer_head->pending_head->msize + sizeof (struct SendMessage);
 782   else
 783     {
 784 #if DEBUG_CORE
 785       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 786                   "Request queue empty, not processing queue\n");
 787 #endif
 788       return; /* no pending message */
 789     }
 790   h->cth = GNUNET_CLIENT_notify_transmit_ready (h->client,
 791                                                 msize,
 792                                                 GNUNET_TIME_UNIT_FOREVER_REL,
 793                                                 GNUNET_NO,
 794                                                 &transmit_message, h);
 795 }
 796
 797
 798 /**
 799  * Handler for notification messages received from the core.
 800  *
 801  * @param cls our "struct GNUNET_CORE_Handle"
 802  * @param msg the message received from the core service
 803  */
 804 static void
 805 main_notify_handler (void *cls,
 806                      const struct GNUNET_MessageHeader *msg)
 807 {
 808   struct GNUNET_CORE_Handle *h = cls;
 809   const struct InitReplyMessage *m;
 810   const struct ConnectNotifyMessage *cnm;
 811   const struct DisconnectNotifyMessage *dnm;
 812   const struct NotifyTrafficMessage *ntm;
 813   const struct GNUNET_MessageHeader *em;
 814   const struct ConfigurationInfoMessage *cim;
 815   const struct PeerStatusNotifyMessage *psnm;
 816   const struct SendMessageReady *smr;
 817   const struct GNUNET_CORE_MessageHandler *mh;
 818   GNUNET_CORE_StartupCallback init;
 819   GNUNET_CORE_PeerConfigurationInfoCallback pcic;
 820   struct PeerRecord *pr;
 821   struct GNUNET_CORE_TransmitHandle *th;
 822   unsigned int hpos;
 823   int trigger;
 824   uint16_t msize;
 825   uint16_t et;
 826   uint32_t ats_count;
 827
 828   if (msg == NULL)
 829     {
 830       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 831                   _
 832                   ("Client was disconnected from core service, trying to reconnect.\n"));
 833       reconnect_later (h);
 834       return;
 835     }
 836   msize = ntohs (msg->size);
 837 #if DEBUG_CORE
 838   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 839               "Processing message of type %u and size %u from core service\n",
 840               ntohs (msg->type), msize);
 841 #endif
 842   switch (ntohs (msg->type))
 843     {
 844     case GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY:
 845       if (ntohs (msg->size) != sizeof (struct InitReplyMessage))
 846         {
 847           GNUNET_break (0);
 848           reconnect_later (h);
 849           return;
 850         }
 851       m = (const struct InitReplyMessage *) msg;
 852       GNUNET_break (0 == ntohl (m->reserved));
 853       /* start our message processing loop */
 854       if (GNUNET_YES == h->currently_down)
 855         {
 856           h->currently_down = GNUNET_NO;
 857           trigger_next_request (h, GNUNET_NO);
 858         }
 859       h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
 860       GNUNET_CRYPTO_hash (&m->publicKey,
 861                           sizeof (struct
 862                                   GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
 863                           &h->me.hashPubKey);
 864       if (NULL != (init = h->init))
 865         {
 866           /* mark so we don't call init on reconnect */
 867           h->init = NULL;
 868 #if DEBUG_CORE
 869           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 870                       "Connected to core service of peer `%s'.\n",
 871                       GNUNET_i2s (&h->me));
 872 #endif
 873           init (h->cls, h, &h->me, &m->publicKey);
 874         }
 875       else
 876         {
 877 #if DEBUG_CORE
 878           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 879                       "Successfully reconnected to core service.\n");
 880 #endif
 881         }
 882       /* fake 'connect to self' */
 883       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
 884                                               &h->me.hashPubKey);
 885       GNUNET_assert (pr == NULL);
 886       pr = GNUNET_malloc (sizeof (struct PeerRecord));
 887       pr->peer = h->me;
 888       pr->ch = h;
 889       GNUNET_assert (GNUNET_YES ==
 890                      GNUNET_CONTAINER_multihashmap_put (h->peers,
 891                                                         &h->me.hashPubKey,
 892                                                         pr,
 893                                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
 894       if (NULL != h->connects)
 895         h->connects (h->cls,
 896                      &h->me,
 897                      NULL);
 898       break;
 899     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT:
 900       if (msize < sizeof (struct ConnectNotifyMessage))
 901         {
 902           GNUNET_break (0);
 903           reconnect_later (h);
 904           return;
 905         }
 906       cnm = (const struct ConnectNotifyMessage *) msg;
 907       ats_count = ntohl (cnm->ats_count);
 908       if ( (msize != sizeof (struct ConnectNotifyMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)) ||
 909            (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR != ntohl ((&cnm->ats)[ats_count].type)) )
 910         {
 911           GNUNET_break (0);
 912           reconnect_later (h);
 913           return;
 914         }
 915 #if DEBUG_CORE
 916       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 917                   "Received notification about connection from `%s'.\n",
 918                   GNUNET_i2s (&cnm->peer));
 919 #endif
 920       if (0 == memcmp (&h->me,
 921                        &cnm->peer,
 922                        sizeof (struct GNUNET_PeerIdentity)))
 923         {
 924           /* disconnect from self!? */
 925           GNUNET_break (0);
 926           return;
 927         }
 928       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
 929                                               &cnm->peer.hashPubKey);
 930       if (pr != NULL)
 931         {
 932           GNUNET_break (0);
 933           reconnect_later (h);
 934           return;
 935         }
 936       pr = GNUNET_malloc (sizeof (struct PeerRecord));
 937       pr->peer = cnm->peer;
 938       pr->ch = h;
 939       GNUNET_assert (GNUNET_YES ==
 940                      GNUNET_CONTAINER_multihashmap_put (h->peers,
 941                                                         &cnm->peer.hashPubKey,
 942                                                         pr,
 943                                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
 944       if (NULL != h->connects)
 945         h->connects (h->cls,
 946                      &cnm->peer,
 947                      &cnm->ats);
 948       break;
 949     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT:
 950       if (msize != sizeof (struct DisconnectNotifyMessage))
 951         {
 952           GNUNET_break (0);
 953           reconnect_later (h);
 954           return;
 955         }
 956       dnm = (const struct DisconnectNotifyMessage *) msg;
 957       if (0 == memcmp (&h->me,
 958                        &dnm->peer,
 959                        sizeof (struct GNUNET_PeerIdentity)))
 960         {
 961           /* connection to self!? */
 962           GNUNET_break (0);
 963           return;
 964         }
 965       GNUNET_break (0 == ntohl (dnm->reserved));
 966 #if DEBUG_CORE
 967       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 968                   "Received notification about disconnect from `%s'.\n",
 969                   GNUNET_i2s (&dnm->peer));
 970 #endif
 971       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
 972                                               &dnm->peer.hashPubKey);
 973       if (pr == NULL)
 974         {
 975           GNUNET_break (0);
 976           reconnect_later (h);
 977           return;
 978         }
 979       trigger = ( (pr->prev != NULL) ||
 980                   (pr->next != NULL) ||
 981                   (h->ready_peer_head == pr) );
 982       disconnect_and_free_peer_entry (h, &dnm->peer.hashPubKey, pr);
 983       if (trigger)
 984         trigger_next_request (h, GNUNET_NO);
 985       break;
 986     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_STATUS_CHANGE:
 987       if (NULL == h->status_events)
 988         {
 989           GNUNET_break (0);
 990         }
 991       if (msize < sizeof (struct PeerStatusNotifyMessage))
 992         {
 993           GNUNET_break (0);
 994           reconnect_later (h);
 995           return;
 996         }
 997       psnm = (const struct PeerStatusNotifyMessage *) msg;
 998       if (0 == memcmp (&h->me,
 999                        &psnm->peer,
1000                        sizeof (struct GNUNET_PeerIdentity)))
1001         {
1002           /* self-change!? */
1003           GNUNET_break (0);
1004           return;
1005         }
1006       ats_count = ntohl (psnm->ats_count);
1007       if ( (msize != sizeof (struct PeerStatusNotifyMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)) ||
1008            (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR != ntohl ((&psnm->ats)[ats_count].type)) )
1009         {
1010           GNUNET_break (0);
1011           reconnect_later (h);
1012           return;
1013         }
1014 #if DEBUG_CORE
1015       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1016                   "Received notification about status change by `%s'.\n",
1017                   GNUNET_i2s (&psnm->peer));
1018 #endif
1019       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1020                                               &psnm->peer.hashPubKey);
1021       if (pr == NULL)
1022         {
1023           GNUNET_break (0);
1024           reconnect_later (h);
1025           return;
1026         }
1027       h->status_events (h->cls,
1028                         &psnm->peer,
1029                         psnm->bandwidth_in,
1030                         psnm->bandwidth_out,
1031                         GNUNET_TIME_absolute_ntoh (psnm->timeout),
1032                         &psnm->ats);
1033       break;
1034     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND:
1035       if (msize < sizeof (struct NotifyTrafficMessage))
1036         {
1037           GNUNET_break (0);
1038           reconnect_later (h);
1039           return;
1040         }
1041       ntm = (const struct NotifyTrafficMessage *) msg;
1042
1043       ats_count = ntohl (ntm->ats_count);
1044       if ( (msize < sizeof (struct NotifyTrafficMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)
1045             + sizeof (struct GNUNET_MessageHeader)) ||
1046            (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR != ntohl ((&ntm->ats)[ats_count].type)) )
1047         {
1048           GNUNET_break (0);
1049           reconnect_later (h);
1050           return;
1051         }
1052       em = (const struct GNUNET_MessageHeader *) &(&ntm->ats)[ats_count+1];
1053 #if DEBUG_CORE
1054       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1055                   "Received message of type %u and size %u from peer `%4s'\n",
1056                   ntohs (em->type),
1057                   ntohs (em->size),
1058                   GNUNET_i2s (&ntm->peer));
1059 #endif
1060       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1061                                               &ntm->peer.hashPubKey);
1062       if (pr == NULL)
1063         {
1064           GNUNET_break (0);
1065           reconnect_later (h);
1066           return;
1067         }
1068       if ((GNUNET_NO == h->inbound_hdr_only) &&
1069           (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage) +
1070            + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)) )
1071         {
1072           GNUNET_break (0);
1073           reconnect_later (h);
1074           return;
1075         }
1076       et = ntohs (em->type);
1077       for (hpos = 0; hpos < h->hcnt; hpos++)
1078         {
1079           mh = &h->handlers[hpos];
1080           if (mh->type != et)
1081             continue;
1082           if ((mh->expected_size != ntohs (em->size)) &&
1083               (mh->expected_size != 0))
1084             {
1085               GNUNET_break (0);
1086               continue;
1087             }
1088           if (GNUNET_OK !=
1089               h->handlers[hpos].callback (h->cls, &ntm->peer, em,
1090                                           &ntm->ats))
1091             {
1092               /* error in processing, do not process other messages! */
1093               break;
1094             }
1095         }
1096       if (NULL != h->inbound_notify)
1097         h->inbound_notify (h->cls, &ntm->peer, em,
1098                            &ntm->ats);
1099       break;
1100     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND:
1101       if (msize < sizeof (struct NotifyTrafficMessage))
1102         {
1103           GNUNET_break (0);
1104           reconnect_later (h);
1105           return;
1106         }
1107       ntm = (const struct NotifyTrafficMessage *) msg;
1108       if (0 == memcmp (&h->me,
1109                        &ntm->peer,
1110                        sizeof (struct GNUNET_PeerIdentity)))
1111         {
1112           /* self-change!? */
1113           GNUNET_break (0);
1114           return;
1115         }
1116       ats_count = ntohl (ntm->ats_count);
1117       if ( (msize < sizeof (struct NotifyTrafficMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)
1118             + sizeof (struct GNUNET_MessageHeader)) ||
1119            (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR != ntohl ((&ntm->ats)[ats_count].type)) )
1120         {
1121           GNUNET_break (0);
1122           reconnect_later (h);
1123           return;
1124         }
1125       em = (const struct GNUNET_MessageHeader *) &(&ntm->ats)[ats_count+1];
1126       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1127                                               &ntm->peer.hashPubKey);
1128       if (pr == NULL)
1129         {
1130           GNUNET_break (0);
1131           reconnect_later (h);
1132           return;
1133         }
1134 #if DEBUG_CORE
1135       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1136                   "Received notification about transmission to `%s'.\n",
1137                   GNUNET_i2s (&ntm->peer));
1138 #endif
1139       if ((GNUNET_NO == h->outbound_hdr_only) &&
1140           (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)
1141            + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)) )
1142         {
1143           GNUNET_break (0);
1144           reconnect_later (h);
1145           return;
1146         }
1147       if (NULL == h->outbound_notify)
1148         {
1149           GNUNET_break (0);
1150           break;
1151         }
1152       h->outbound_notify (h->cls, &ntm->peer, em,
1153                           &ntm->ats);
1154       break;
1155     case GNUNET_MESSAGE_TYPE_CORE_SEND_READY:
1156       if (msize != sizeof (struct SendMessageReady))
1157         {
1158           GNUNET_break (0);
1159           reconnect_later (h);
1160           return;
1161         }
1162       smr = (const struct SendMessageReady *) msg;
1163       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1164                                               &smr->peer.hashPubKey);
1165       if (pr == NULL)
1166         {
1167           GNUNET_break (0);
1168           reconnect_later (h);
1169           return;
1170         }
1171 #if DEBUG_CORE
1172       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1173                   "Received notification about transmission readiness to `%s'.\n",
1174                   GNUNET_i2s (&smr->peer));
1175 #endif
1176       if (pr->pending_head == NULL)
1177         {
1178           /* request must have been cancelled between the original request
1179              and the response from core, ignore core's readiness */
1180           return;
1181         }
1182
1183       th = pr->pending_head;
1184       if (ntohs (smr->smr_id) != th->smr_id)
1185         {
1186           /* READY message is for expired or cancelled message,
1187              ignore! (we should have already sent another request) */
1188           break;
1189         }
1190       if ( (pr->prev != NULL) ||
1191            (pr->next != NULL) ||
1192            (h->ready_peer_head == pr) )
1193         {
1194           /* we should not already be on the ready list... */
1195           GNUNET_break (0);
1196           reconnect_later (h);
1197           return;
1198         }
1199       GNUNET_CONTAINER_DLL_insert (h->ready_peer_head,
1200                                    h->ready_peer_tail,
1201                                    pr);
1202       trigger_next_request (h, GNUNET_NO);
1203       break;
1204     case GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO:
1205       if (ntohs (msg->size) != sizeof (struct ConfigurationInfoMessage))
1206         {
1207           GNUNET_break (0);
1208           reconnect_later (h);
1209           return;
1210         }
1211       cim = (const struct ConfigurationInfoMessage*) msg;
1212       if (0 == memcmp (&h->me,
1213                        &cim->peer,
1214                        sizeof (struct GNUNET_PeerIdentity)))
1215         {
1216           /* self-change!? */
1217           GNUNET_break (0);
1218           return;
1219         }
1220 #if DEBUG_CORE
1221       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1222                   "Received notification about configuration update for `%s'.\n",
1223                   GNUNET_i2s (&cim->peer));
1224 #endif
1225       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1226                                               &cim->peer.hashPubKey);
1227       if (pr == NULL)
1228         {
1229           GNUNET_break (0);
1230           reconnect_later (h);
1231           return;
1232         }
1233       if (pr->rim_id != ntohl (cim->rim_id))
1234         break;
1235       pcic = pr->pcic;
1236       pr->pcic = NULL;
1237       if (pcic != NULL)
1238         pcic (pr->pcic_cls,
1239               &pr->peer,
1240               cim->bw_out,
1241               ntohl (cim->reserved_amount),
1242               GNUNET_ntohll (cim->preference));
1243       break;
1244     default:
1245       reconnect_later (h);
1246       return;
1247     }
1248   GNUNET_CLIENT_receive (h->client,
1249                          &main_notify_handler, h,
1250                          GNUNET_TIME_UNIT_FOREVER_REL);
1251 }
1252
1253
1254 /**
1255  * Task executed once we are done transmitting the INIT message.
1256  * Starts our 'receive' loop.
1257  *
1258  * @param cls the 'struct GNUNET_CORE_Handle'
1259  * @param success were we successful
1260  */
1261 static void
1262 init_done_task (void *cls,
1263                 int success)
1264 {
1265   struct GNUNET_CORE_Handle *h = cls;
1266
1267   if (success == GNUNET_SYSERR)
1268     return; /* shutdown */
1269   if (success == GNUNET_NO)
1270     {
1271 #if DEBUG_CORE
1272       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1273                   "Failed to exchange INIT with core, retrying\n");
1274 #endif
1275       if (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK)
1276         reconnect_later (h);
1277       return;
1278     }
1279   GNUNET_CLIENT_receive (h->client,
1280                          &main_notify_handler,
1281                          h,
1282                          GNUNET_TIME_UNIT_FOREVER_REL);
1283 }
1284
1285
1286 /**
1287  * Our current client connection went down.  Clean it up
1288  * and try to reconnect!
1289  *
1290  * @param h our handle to the core service
1291  */
1292 static void
1293 reconnect (struct GNUNET_CORE_Handle *h)
1294 {
1295   struct ControlMessage *cm;
1296   struct InitMessage *init;
1297   uint32_t opt;
1298   uint16_t msize;
1299   uint16_t *ts;
1300   unsigned int hpos;
1301
1302 #if DEBUG_CORE
1303   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1304               "Reconnecting to CORE service\n");
1305 #endif
1306   GNUNET_assert (h->client == NULL);
1307   GNUNET_assert (h->currently_down == GNUNET_YES);
1308   h->client = GNUNET_CLIENT_connect ("core", h->cfg);
1309   if (h->client == NULL)
1310     {
1311       reconnect_later (h);
1312       return;
1313     }
1314   msize = h->hcnt * sizeof (uint16_t) + sizeof (struct InitMessage);
1315   cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1316                       msize);
1317   cm->cont = &init_done_task;
1318   cm->cont_cls = h;
1319   init = (struct InitMessage*) &cm[1];
1320   init->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT);
1321   init->header.size = htons (msize);
1322   opt = GNUNET_CORE_OPTION_SEND_CONNECT | GNUNET_CORE_OPTION_SEND_DISCONNECT;
1323   if (h->status_events != NULL)
1324     opt |= GNUNET_CORE_OPTION_SEND_STATUS_CHANGE;
1325   if (h->inbound_notify != NULL)
1326     {
1327       if (h->inbound_hdr_only)
1328         opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
1329       else
1330         opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
1331     }
1332   if (h->outbound_notify != NULL)
1333     {
1334       if (h->outbound_hdr_only)
1335         opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
1336       else
1337         opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
1338     }
1339   init->options = htonl (opt);
1340   ts = (uint16_t *) &init[1];
1341   for (hpos = 0; hpos < h->hcnt; hpos++)
1342     ts[hpos] = htons (h->handlers[hpos].type);
1343   GNUNET_CONTAINER_DLL_insert (h->control_pending_head,
1344                                h->control_pending_tail,
1345                                cm);
1346   trigger_next_request (h, GNUNET_YES);
1347 }
1348
1349
1350
1351 /**
1352  * Connect to the core service.  Note that the connection may
1353  * complete (or fail) asynchronously.
1354  *
1355  * @param cfg configuration to use
1356  * @param queue_size size of the per-peer message queue
1357  * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
1358  * @param init callback to call on timeout or once we have successfully
1359  *        connected to the core service; note that timeout is only meaningful if init is not NULL
1360  * @param connects function to call on peer connect, can be NULL
1361  * @param disconnects function to call on peer disconnect / timeout, can be NULL
1362  * @param status_events function to call on changes to peer connection status, can be NULL
1363  * @param inbound_notify function to call for all inbound messages, can be NULL
1364  * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
1365  *                GNUNET_MessageHeader and hence we do not need to give it the full message;
1366  *                can be used to improve efficiency, ignored if inbound_notify is NULLL
1367  * @param outbound_notify function to call for all outbound messages, can be NULL
1368  * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
1369  *                GNUNET_MessageHeader and hence we do not need to give it the full message
1370  *                can be used to improve efficiency, ignored if outbound_notify is NULLL
1371  * @param handlers callbacks for messages we care about, NULL-terminated
1372  * @return handle to the core service (only useful for disconnect until 'init' is called);
1373  *                NULL on error (in this case, init is never called)
1374  */
1375 struct GNUNET_CORE_Handle *
1376 GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1377                      unsigned int queue_size,
1378                      void *cls,
1379                      GNUNET_CORE_StartupCallback init,
1380                      GNUNET_CORE_ConnectEventHandler connects,
1381                      GNUNET_CORE_DisconnectEventHandler disconnects,
1382                      GNUNET_CORE_PeerStatusEventHandler status_events,
1383                      GNUNET_CORE_MessageCallback inbound_notify,
1384                      int inbound_hdr_only,
1385                      GNUNET_CORE_MessageCallback outbound_notify,
1386                      int outbound_hdr_only,
1387                      const struct GNUNET_CORE_MessageHandler *handlers)
1388 {
1389   struct GNUNET_CORE_Handle *h;
1390
1391   h = GNUNET_malloc (sizeof (struct GNUNET_CORE_Handle));
1392   h->cfg = cfg;
1393   h->queue_size = queue_size;
1394   h->cls = cls;
1395   h->init = init;
1396   h->connects = connects;
1397   h->disconnects = disconnects;
1398   h->status_events = status_events;
1399   h->inbound_notify = inbound_notify;
1400   h->outbound_notify = outbound_notify;
1401   h->inbound_hdr_only = inbound_hdr_only;
1402   h->outbound_hdr_only = outbound_hdr_only;
1403   h->handlers = handlers;
1404   h->hcnt = 0;
1405   h->currently_down = GNUNET_YES;
1406   h->peers = GNUNET_CONTAINER_multihashmap_create (128);
1407   h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
1408   while (handlers[h->hcnt].callback != NULL)
1409     h->hcnt++;
1410   GNUNET_assert (h->hcnt <
1411                  (GNUNET_SERVER_MAX_MESSAGE_SIZE -
1412                   sizeof (struct InitMessage)) / sizeof (uint16_t));
1413 #if DEBUG_CORE
1414   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1415               "Connecting to CORE service\n");
1416 #endif
1417   reconnect (h);
1418   return h;
1419 }
1420
1421
1422 /**
1423  * Disconnect from the core service.  This function can only
1424  * be called *after* all pending 'GNUNET_CORE_notify_transmit_ready'
1425  * requests have been explicitly canceled.
1426  *
1427  * @param handle connection to core to disconnect
1428  */
1429 void
1430 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
1431 {
1432   struct ControlMessage *cm;
1433
1434 #if DEBUG_CORE
1435   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1436               "Disconnecting from CORE service\n");
1437 #endif
1438   if (handle->cth != NULL)
1439     {
1440       GNUNET_CLIENT_notify_transmit_ready_cancel (handle->cth);
1441       handle->cth = NULL;
1442     }
1443   if (handle->client != NULL)
1444     {
1445       GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1446       handle->client = NULL;
1447     }
1448   while (NULL != (cm = handle->control_pending_head))
1449     {
1450       GNUNET_CONTAINER_DLL_remove (handle->control_pending_head,
1451                                    handle->control_pending_tail,
1452                                    cm);
1453       if (cm->th != NULL)
1454         cm->th->cm = NULL;
1455       if (cm->cont != NULL)
1456         cm->cont (cm->cont_cls, GNUNET_SYSERR);
1457       GNUNET_free (cm);
1458     }
1459   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1460     {
1461       GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1462       handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1463     }
1464   GNUNET_CONTAINER_multihashmap_iterate (handle->peers,
1465                                          &disconnect_and_free_peer_entry,
1466                                          handle);
1467   GNUNET_CONTAINER_multihashmap_destroy (handle->peers);
1468   GNUNET_break (handle->ready_peer_head == NULL);
1469   GNUNET_free (handle);
1470 }
1471
1472
1473 /**
1474  * Ask the core to call "notify" once it is ready to transmit the
1475  * given number of bytes to the specified "target".  If we are not yet
1476  * connected to the specified peer, a call to this function will cause
1477  * us to try to establish a connection.
1478  *
1479  * @param handle connection to core service
1480  * @param priority how important is the message?
1481  * @param maxdelay how long can the message wait?
1482  * @param target who should receive the message,
1483  *        use NULL for this peer (loopback)
1484  * @param notify_size how many bytes of buffer space does notify want?
1485  * @param notify function to call when buffer space is available
1486  * @param notify_cls closure for notify
1487  * @return non-NULL if the notify callback was queued,
1488  *         NULL if we can not even queue the request (insufficient
1489  *         memory); if NULL is returned, "notify" will NOT be called.
1490  */
1491 struct GNUNET_CORE_TransmitHandle *
1492 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
1493                                    uint32_t priority,
1494                                    struct GNUNET_TIME_Relative maxdelay,
1495                                    const struct GNUNET_PeerIdentity *target,
1496                                    size_t notify_size,
1497                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
1498                                    void *notify_cls)
1499 {
1500   struct PeerRecord *pr;
1501   struct GNUNET_CORE_TransmitHandle *th;
1502   struct GNUNET_CORE_TransmitHandle *pos;
1503   struct GNUNET_CORE_TransmitHandle *prev;
1504   struct GNUNET_CORE_TransmitHandle *minp;
1505
1506   pr = GNUNET_CONTAINER_multihashmap_get (handle->peers,
1507                                           &target->hashPubKey);
1508   if (NULL == pr)
1509     {
1510       /* attempt to send to peer that is not connected */
1511       GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
1512                  "Attempting to send to peer `%s' from peer `%s', but not connected!\n",
1513                  GNUNET_i2s(target), GNUNET_h2s(&handle->me.hashPubKey));
1514       GNUNET_break (0);
1515       return NULL;
1516     }
1517   GNUNET_assert (notify_size + sizeof (struct SendMessage) <
1518                  GNUNET_SERVER_MAX_MESSAGE_SIZE);
1519   th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle));
1520   th->peer = pr;
1521   GNUNET_assert(NULL != notify);
1522   th->get_message = notify;
1523   th->get_message_cls = notify_cls;
1524   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1525   th->priority = priority;
1526   th->msize = notify_size;
1527   /* bound queue size */
1528   if (pr->queue_size == handle->queue_size)
1529     {
1530       /* find lowest-priority entry, but skip the head of the list */
1531       minp = pr->pending_head->next;
1532       prev = minp;
1533       while (prev != NULL)
1534         {
1535           if (prev->priority < minp->priority)
1536             minp = prev;
1537           prev = prev->next;
1538         }
1539       if (minp == NULL)
1540         {
1541           GNUNET_break (handle->queue_size != 0);
1542           GNUNET_break (pr->queue_size == 0);
1543           GNUNET_free(th);
1544           return NULL;
1545         }
1546       if (priority <= minp->priority)
1547         {
1548 #if DEBUG_CORE
1549           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1550                       "Dropping transmission request: priority too low\n");
1551 #endif
1552           return NULL; /* priority too low */
1553         }
1554       GNUNET_CONTAINER_DLL_remove (pr->pending_head,
1555                                    pr->pending_tail,
1556                                    minp);
1557       pr->queue_size--;
1558       GNUNET_assert (0 ==
1559                      minp->get_message (minp->get_message_cls,
1560                                         0, NULL));
1561       GNUNET_free (minp);
1562     }
1563
1564   /* Order entries by deadline, but SKIP 'HEAD' if
1565      we're in the 'ready_peer_*' DLL */
1566   pos = pr->pending_head;
1567   if ( (pr->prev != NULL) ||
1568        (pr->next != NULL) ||
1569        (pr == handle->ready_peer_head) )
1570     {
1571       GNUNET_assert (pos != NULL);
1572       pos = pos->next; /* skip head */
1573     }
1574
1575   /* insertion sort */
1576   prev = pos;
1577   while ( (pos != NULL) &&
1578           (pos->timeout.abs_value < th->timeout.abs_value) )
1579     {
1580       prev = pos;
1581       pos = pos->next;
1582     }
1583   GNUNET_CONTAINER_DLL_insert_after (pr->pending_head,
1584                                      pr->pending_tail,
1585                                      prev,
1586                                      th);
1587   pr->queue_size++;
1588   /* was the request queue previously empty? */
1589 #if DEBUG_CORE
1590   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1591               "Transmission request added to queue\n");
1592 #endif
1593   if (pr->pending_head == th)
1594     request_next_transmission (pr);
1595   return th;
1596 }
1597
1598
1599 /**
1600  * Cancel the specified transmission-ready notification.
1601  *
1602  * @param th handle that was returned by "notify_transmit_ready".
1603  */
1604 void
1605 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
1606                                           *th)
1607 {
1608   struct PeerRecord *pr = th->peer;
1609   struct GNUNET_CORE_Handle *h = pr->ch;
1610   int was_head;
1611
1612   was_head = (pr->pending_head == th);
1613   GNUNET_CONTAINER_DLL_remove (pr->pending_head,
1614                                pr->pending_tail,
1615                                th);
1616   pr->queue_size--;
1617   if (th->cm != NULL)
1618     {
1619       /* we're currently in the control queue, remove */
1620       GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
1621                                    h->control_pending_tail,
1622                                    th->cm);
1623       GNUNET_free (th->cm);
1624     }
1625   GNUNET_free (th);
1626   if (was_head)
1627     {
1628       if ( (pr->prev != NULL) ||
1629            (pr->next != NULL) ||
1630            (pr == h->ready_peer_head) )
1631         {
1632           /* the request that was 'approved' by core was
1633              canceled before it could be transmitted; remove
1634              us from the 'ready' list */
1635           GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
1636                                        h->ready_peer_tail,
1637                                        pr);
1638         }
1639       request_next_transmission (pr);
1640     }
1641 }
1642
1643
1644 /* ****************** GNUNET_CORE_peer_request_connect ******************** */
1645
1646 /**
1647  * Handle for a request to the core to connect to
1648  * a particular peer.  Can be used to cancel the request
1649  * (before the 'cont'inuation is called).
1650  */
1651 struct GNUNET_CORE_PeerRequestHandle
1652 {
1653
1654   /**
1655    * Link to control message.
1656    */
1657   struct ControlMessage *cm;
1658
1659   /**
1660    * Core handle used.
1661    */
1662   struct GNUNET_CORE_Handle *h;
1663
1664   /**
1665    * Continuation to run when done.
1666    */
1667   GNUNET_CORE_ControlContinuation cont;
1668
1669   /**
1670    * Closure for 'cont'.
1671    */
1672   void *cont_cls;
1673
1674 };
1675
1676
1677 /**
1678  * Continuation called when the control message was transmitted.
1679  * Calls the original continuation and frees the remaining
1680  * resources.
1681  *
1682  * @param cls the 'struct GNUNET_CORE_PeerRequestHandle'
1683  * @param success was the request transmitted?
1684  */
1685 static void
1686 peer_request_connect_cont (void *cls,
1687                            int success)
1688 {
1689   struct GNUNET_CORE_PeerRequestHandle *ret = cls;
1690
1691   if (ret->cont != NULL)
1692     ret->cont (ret->cont_cls, success);
1693   GNUNET_free (ret);
1694 }
1695
1696
1697 /**
1698  * Request that the core should try to connect to a particular peer.
1699  * Once the request has been transmitted to the core, the continuation
1700  * function will be called.  Note that this does NOT mean that a
1701  * connection was successfully established -- it only means that the
1702  * core will now try.  Successful establishment of the connection
1703  * will be signalled to the 'connects' callback argument of
1704  * 'GNUNET_CORE_connect' only.  If the core service does not respond
1705  * to our connection attempt within the given time frame, 'cont' will
1706  * be called with the TIMEOUT reason code.
1707  *
1708  * @param h core handle
1709  * @param timeout how long to try to talk to core
1710  * @param peer who should we connect to
1711  * @param cont function to call once the request has been completed (or timed out)
1712  * @param cont_cls closure for cont
1713  * @return NULL on error (cont will not be called), otherwise handle for cancellation
1714  */
1715 struct GNUNET_CORE_PeerRequestHandle *
1716 GNUNET_CORE_peer_request_connect (struct GNUNET_CORE_Handle *h,
1717                                   struct GNUNET_TIME_Relative timeout,
1718                                   const struct GNUNET_PeerIdentity * peer,
1719                                   GNUNET_CORE_ControlContinuation cont,
1720                                   void *cont_cls)
1721 {
1722   struct GNUNET_CORE_PeerRequestHandle *ret;
1723   struct ControlMessage *cm;
1724   struct ConnectMessage *msg;
1725
1726   cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1727                       sizeof (struct ConnectMessage));
1728   msg = (struct ConnectMessage*) &cm[1];
1729   msg->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONNECT);
1730   msg->header.size = htons (sizeof (struct ConnectMessage));
1731   msg->reserved = htonl (0);
1732   msg->timeout = GNUNET_TIME_relative_hton (timeout);
1733   msg->peer = *peer;
1734   GNUNET_CONTAINER_DLL_insert (h->control_pending_head,
1735                                h->control_pending_tail,
1736                                cm);
1737   ret = GNUNET_malloc (sizeof (struct GNUNET_CORE_PeerRequestHandle));
1738   ret->h = h;
1739   ret->cm = cm;
1740   ret->cont = cont;
1741   ret->cont_cls = cont_cls;
1742   cm->cont = &peer_request_connect_cont;
1743   cm->cont_cls = ret;
1744 #if DEBUG_CORE
1745   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1746               "Queueing REQUEST_CONNECT request\n");
1747 #endif
1748   if (h->control_pending_head == cm)
1749     trigger_next_request (h, GNUNET_NO);
1750   return ret;
1751 }
1752
1753
1754 /**
1755  * Cancel a pending request to connect to a particular peer.  Must not
1756  * be called after the 'cont' function was invoked.
1757  *
1758  * @param req request handle that was returned for the original request
1759  */
1760 void
1761 GNUNET_CORE_peer_request_connect_cancel (struct GNUNET_CORE_PeerRequestHandle *req)
1762 {
1763   struct GNUNET_CORE_Handle *h = req->h;
1764   struct ControlMessage *cm = req->cm;
1765
1766   GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
1767                                h->control_pending_tail,
1768                                cm);
1769   GNUNET_free (cm);
1770   GNUNET_free (req);
1771 }
1772
1773
1774 /* ****************** GNUNET_CORE_peer_change_preference ******************** */
1775
1776
1777 struct GNUNET_CORE_InformationRequestContext
1778 {
1779
1780   /**
1781    * Our connection to the service.
1782    */
1783   struct GNUNET_CORE_Handle *h;
1784
1785   /**
1786    * Function to call with the information.
1787    */
1788   GNUNET_CORE_PeerConfigurationInfoCallback info;
1789
1790   /**
1791    * Closure for info.
1792    */
1793   void *info_cls;
1794
1795   /**
1796    * Link to control message, NULL if CM was sent.
1797    */
1798   struct ControlMessage *cm;
1799
1800   /**
1801    * Link to peer record.
1802    */
1803   struct PeerRecord *pr;
1804 };
1805
1806
1807 /**
1808  * CM was sent, remove link so we don't double-free.
1809  *
1810  * @param cls the 'struct GNUNET_CORE_InformationRequestContext'
1811  * @param success were we successful?
1812  */
1813 static void
1814 change_preference_send_continuation (void *cls,
1815                                      int success)
1816 {
1817   struct GNUNET_CORE_InformationRequestContext *irc = cls;
1818
1819   irc->cm = NULL;
1820 }
1821
1822
1823 /**
1824  * Obtain statistics and/or change preferences for the given peer.
1825  *
1826  * @param h core handle
1827  * @param peer identifies the peer
1828  * @param timeout after how long should we give up (and call "info" with NULL
1829  *                for "peer" to signal an error)?
1830  * @param bw_out set to the current bandwidth limit (sending) for this peer,
1831  *                caller should set "bw_out" to "-1" to avoid changing
1832  *                the current value; otherwise "bw_out" will be lowered to
1833  *                the specified value; passing a pointer to "0" can be used to force
1834  *                us to disconnect from the peer; "bw_out" might not increase
1835  *                as specified since the upper bound is generally
1836  *                determined by the other peer!
1837  * @param amount reserve N bytes for receiving, negative
1838  *                amounts can be used to undo a (recent) reservation;
1839  * @param preference increase incoming traffic share preference by this amount;
1840  *                in the absence of "amount" reservations, we use this
1841  *                preference value to assign proportional bandwidth shares
1842  *                to all connected peers
1843  * @param info function to call with the resulting configuration information
1844  * @param info_cls closure for info
1845  * @return NULL on error
1846  */
1847 struct GNUNET_CORE_InformationRequestContext *
1848 GNUNET_CORE_peer_change_preference (struct GNUNET_CORE_Handle *h,
1849                                     const struct GNUNET_PeerIdentity *peer,
1850                                     struct GNUNET_TIME_Relative timeout,
1851                                     struct GNUNET_BANDWIDTH_Value32NBO bw_out,
1852                                     int32_t amount,
1853                                     uint64_t preference,
1854                                     GNUNET_CORE_PeerConfigurationInfoCallback info,
1855                                     void *info_cls)
1856 {
1857   struct GNUNET_CORE_InformationRequestContext *irc;
1858   struct PeerRecord *pr;
1859   struct RequestInfoMessage *rim;
1860   struct ControlMessage *cm;
1861
1862   pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1863                                           &peer->hashPubKey);
1864   if (NULL == pr)
1865     {
1866       /* attempt to change preference on peer that is not connected */
1867       GNUNET_break (0);
1868       return NULL;
1869     }
1870   if (pr->pcic != NULL)
1871     {
1872       /* second change before first one is done */
1873       GNUNET_break (0);
1874       return NULL;
1875     }
1876   irc = GNUNET_malloc (sizeof (struct GNUNET_CORE_InformationRequestContext));
1877   irc->h = h;
1878   irc->pr = pr;
1879   irc->info = info;
1880   irc->info_cls = info_cls;
1881   cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1882                       sizeof (struct RequestInfoMessage));
1883   cm->cont = &change_preference_send_continuation;
1884   cm->cont_cls = irc;
1885   irc->cm = cm;
1886   rim = (struct RequestInfoMessage*) &cm[1];
1887   rim->header.size = htons (sizeof (struct RequestInfoMessage));
1888   rim->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_INFO);
1889   rim->rim_id = htonl (pr->rim_id = h->rim_id_gen++);
1890   rim->limit_outbound = bw_out;
1891   rim->reserve_inbound = htonl (amount);
1892   rim->preference_change = GNUNET_htonll(preference);
1893   rim->peer = *peer;
1894 #if DEBUG_CORE
1895   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1896               "Queueing CHANGE PREFERENCE request\n");
1897 #endif
1898   GNUNET_CONTAINER_DLL_insert (h->control_pending_head,
1899                                h->control_pending_tail,
1900                                cm);
1901   pr->pcic = info;
1902   pr->pcic_cls = info_cls;
1903   if (h->control_pending_head == cm)
1904     trigger_next_request (h, GNUNET_NO);
1905   return irc;
1906 }
1907
1908
1909 /**
1910  * Cancel request for getting information about a peer.
1911  * Note that an eventual change in preference, trust or bandwidth
1912  * assignment MAY have already been committed at the time,
1913  * so cancelling a request is NOT sure to undo the original
1914  * request.  The original request may or may not still commit.
1915  * The only thing cancellation ensures is that the callback
1916  * from the original request will no longer be called.
1917  *
1918  * @param irc context returned by the original GNUNET_CORE_peer_get_info call
1919  */
1920 void
1921 GNUNET_CORE_peer_change_preference_cancel (struct GNUNET_CORE_InformationRequestContext *irc)
1922 {
1923   struct GNUNET_CORE_Handle *h = irc->h;
1924   struct PeerRecord *pr = irc->pr;
1925
1926   if (irc->cm != NULL)
1927     {
1928       GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
1929                                    h->control_pending_tail,
1930                                    irc->cm);
1931       GNUNET_free (irc->cm);
1932     }
1933   pr->pcic = NULL;
1934   pr->pcic_cls = NULL;
1935   GNUNET_free (irc);
1936 }
1937
1938
1939 /* end of core_api.c */