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