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       GNUNET_CRYPTO_hash (&m->publicKey,
 863                           sizeof (struct
 864                                   GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
 865                           &h->me.hashPubKey);
 866       if (NULL != (init = h->init))
 867         {
 868           /* mark so we don't call init on reconnect */
 869           h->init = NULL;
 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       /* fake 'connect to self' */
 885       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
 886                                               &h->me.hashPubKey);
 887       GNUNET_assert (pr == NULL);
 888       pr = GNUNET_malloc (sizeof (struct PeerRecord));
 889       pr->peer = h->me;
 890       pr->ch = h;
 891       GNUNET_assert (GNUNET_YES ==
 892                      GNUNET_CONTAINER_multihashmap_put (h->peers,
 893                                                         &h->me.hashPubKey,
 894                                                         pr,
 895                                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
 896       if (NULL != h->connects)
 897         h->connects (h->cls,
 898                      &h->me,
 899                      NULL);
 900       break;
 901     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT:
 902       if (msize < sizeof (struct ConnectNotifyMessage))
 903         {
 904           GNUNET_break (0);
 905           reconnect_later (h);
 906           return;
 907         }
 908       cnm = (const struct ConnectNotifyMessage *) msg;
 909       ats_count = ntohl (cnm->ats_count);
 910       if ( (msize != sizeof (struct ConnectNotifyMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)) ||
 911            (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR != ntohl ((&cnm->ats)[ats_count].type)) )
 912         {
 913           GNUNET_break (0);
 914           reconnect_later (h);
 915           return;
 916         }
 917 #if DEBUG_CORE
 918       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 919                   "Received notification about connection from `%s'.\n",
 920                   GNUNET_i2s (&cnm->peer));
 921 #endif
 922       if (0 == memcmp (&h->me,
 923                        &cnm->peer,
 924                        sizeof (struct GNUNET_PeerIdentity)))
 925         {
 926           /* disconnect from self!? */
 927           GNUNET_break (0);
 928           return;
 929         }
 930       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
 931                                               &cnm->peer.hashPubKey);
 932       if (pr != NULL)
 933         {
 934           GNUNET_break (0);
 935           reconnect_later (h);
 936           return;
 937         }
 938       pr = GNUNET_malloc (sizeof (struct PeerRecord));
 939       pr->peer = cnm->peer;
 940       pr->ch = h;
 941       GNUNET_assert (GNUNET_YES ==
 942                      GNUNET_CONTAINER_multihashmap_put (h->peers,
 943                                                         &cnm->peer.hashPubKey,
 944                                                         pr,
 945                                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
 946       if (NULL != h->connects)
 947         h->connects (h->cls,
 948                      &cnm->peer,
 949                      &cnm->ats);
 950       break;
 951     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT:
 952       if (msize != sizeof (struct DisconnectNotifyMessage))
 953         {
 954           GNUNET_break (0);
 955           reconnect_later (h);
 956           return;
 957         }
 958       dnm = (const struct DisconnectNotifyMessage *) msg;
 959       if (0 == memcmp (&h->me,
 960                        &dnm->peer,
 961                        sizeof (struct GNUNET_PeerIdentity)))
 962         {
 963           /* connection to self!? */
 964           GNUNET_break (0);
 965           return;
 966         }
 967 #if DEBUG_CORE
 968       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 969                   "Received notification about disconnect from `%s'.\n",
 970                   GNUNET_i2s (&dnm->peer));
 971 #endif
 972       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
 973                                               &dnm->peer.hashPubKey);
 974       if (pr == NULL)
 975         {
 976           GNUNET_break (0);
 977           reconnect_later (h);
 978           return;
 979         }
 980       trigger = ( (pr->prev != NULL) ||
 981                   (pr->next != NULL) ||
 982                   (h->ready_peer_head == pr) );
 983       disconnect_and_free_peer_entry (h, &dnm->peer.hashPubKey, pr);
 984       if (trigger)
 985         trigger_next_request (h, GNUNET_NO);
 986       break;
 987     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_STATUS_CHANGE:
 988       if (NULL == h->status_events)
 989         {
 990           GNUNET_break (0);
 991           break;
 992         }
 993       if (msize < sizeof (struct PeerStatusNotifyMessage))
 994         {
 995           GNUNET_break (0);
 996           reconnect_later (h);
 997           return;
 998         }
 999       psnm = (const struct PeerStatusNotifyMessage *) msg;
1000       if (0 == memcmp (&h->me,
1001                        &psnm->peer,
1002                        sizeof (struct GNUNET_PeerIdentity)))
1003         {
1004           /* self-change!? */
1005           GNUNET_break (0);
1006           return;
1007         }
1008       ats_count = ntohl (psnm->ats_count);
1009       if ( (msize != sizeof (struct PeerStatusNotifyMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)) ||
1010            (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR != ntohl ((&psnm->ats)[ats_count].type)) )
1011         {
1012           GNUNET_break (0);
1013           reconnect_later (h);
1014           return;
1015         }
1016 #if DEBUG_CORE
1017       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1018                   "Received notification about status change by `%s'.\n",
1019                   GNUNET_i2s (&psnm->peer));
1020 #endif
1021       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1022                                               &psnm->peer.hashPubKey);
1023       if (pr == NULL)
1024         {
1025           GNUNET_break (0);
1026           reconnect_later (h);
1027           return;
1028         }
1029       h->status_events (h->cls,
1030                         &psnm->peer,
1031                         psnm->bandwidth_in,
1032                         psnm->bandwidth_out,
1033                         GNUNET_TIME_absolute_ntoh (psnm->timeout),
1034                         &psnm->ats);
1035       break;
1036     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND:
1037       if (msize < sizeof (struct NotifyTrafficMessage))
1038         {
1039           GNUNET_break (0);
1040           reconnect_later (h);
1041           return;
1042         }
1043       ntm = (const struct NotifyTrafficMessage *) msg;
1044       if (0 == memcmp (&h->me,
1045                        &ntm->peer,
1046                        sizeof (struct GNUNET_PeerIdentity)))
1047         {
1048           /* self-change!? */
1049           GNUNET_break (0);
1050           return;
1051         }
1052       ats_count = ntohl (ntm->ats_count);
1053       if ( (msize < sizeof (struct NotifyTrafficMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)
1054             + sizeof (struct GNUNET_MessageHeader)) ||
1055            (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR != ntohl ((&ntm->ats)[ats_count].type)) )
1056         {
1057           GNUNET_break (0);
1058           reconnect_later (h);
1059           return;
1060         }
1061       em = (const struct GNUNET_MessageHeader *) &(&ntm->ats)[ats_count+1];
1062 #if DEBUG_CORE
1063       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1064                   "Received message of type %u and size %u from peer `%4s'\n",
1065                   ntohs (em->type),
1066                   ntohs (em->size),
1067                   GNUNET_i2s (&ntm->peer));
1068 #endif
1069       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1070                                               &ntm->peer.hashPubKey);
1071       if (pr == NULL)
1072         {
1073           GNUNET_break (0);
1074           reconnect_later (h);
1075           return;
1076         }
1077       if ((GNUNET_NO == h->inbound_hdr_only) &&
1078           (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage) +
1079            + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)) )
1080         {
1081           GNUNET_break (0);
1082           reconnect_later (h);
1083           return;
1084         }
1085       et = ntohs (em->type);
1086       for (hpos = 0; hpos < h->hcnt; hpos++)
1087         {
1088           mh = &h->handlers[hpos];
1089           if (mh->type != et)
1090             continue;
1091           if ((mh->expected_size != ntohs (em->size)) &&
1092               (mh->expected_size != 0))
1093             {
1094               GNUNET_break (0);
1095               continue;
1096             }
1097           if (GNUNET_OK !=
1098               h->handlers[hpos].callback (h->cls, &ntm->peer, em,
1099                                           &ntm->ats))
1100             {
1101               /* error in processing, do not process other messages! */
1102               break;
1103             }
1104         }
1105       if (NULL != h->inbound_notify)
1106         h->inbound_notify (h->cls, &ntm->peer, em,
1107                            &ntm->ats);
1108       break;
1109     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND:
1110       if (msize < sizeof (struct NotifyTrafficMessage))
1111         {
1112           GNUNET_break (0);
1113           reconnect_later (h);
1114           return;
1115         }
1116       ntm = (const struct NotifyTrafficMessage *) msg;
1117       if (0 == memcmp (&h->me,
1118                        &ntm->peer,
1119                        sizeof (struct GNUNET_PeerIdentity)))
1120         {
1121           /* self-change!? */
1122           GNUNET_break (0);
1123           return;
1124         }
1125       ats_count = ntohl (ntm->ats_count);
1126       if ( (msize < sizeof (struct NotifyTrafficMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)
1127             + sizeof (struct GNUNET_MessageHeader)) ||
1128            (GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR != ntohl ((&ntm->ats)[ats_count].type)) )
1129         {
1130           GNUNET_break (0);
1131           reconnect_later (h);
1132           return;
1133         }
1134       em = (const struct GNUNET_MessageHeader *) &(&ntm->ats)[ats_count+1];
1135       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1136                                               &ntm->peer.hashPubKey);
1137       if (pr == NULL)
1138         {
1139           GNUNET_break (0);
1140           reconnect_later (h);
1141           return;
1142         }
1143 #if DEBUG_CORE
1144       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1145                   "Received notification about transmission to `%s'.\n",
1146                   GNUNET_i2s (&ntm->peer));
1147 #endif
1148       if ((GNUNET_NO == h->outbound_hdr_only) &&
1149           (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)
1150            + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)) )
1151         {
1152           GNUNET_break (0);
1153           reconnect_later (h);
1154           return;
1155         }
1156       if (NULL == h->outbound_notify)
1157         {
1158           GNUNET_break (0);
1159           break;
1160         }
1161       h->outbound_notify (h->cls, &ntm->peer, em,
1162                           &ntm->ats);
1163       break;
1164     case GNUNET_MESSAGE_TYPE_CORE_SEND_READY:
1165       if (msize != sizeof (struct SendMessageReady))
1166         {
1167           GNUNET_break (0);
1168           reconnect_later (h);
1169           return;
1170         }
1171       smr = (const struct SendMessageReady *) msg;
1172       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1173                                               &smr->peer.hashPubKey);
1174       if (pr == NULL)
1175         {
1176           GNUNET_break (0);
1177           reconnect_later (h);
1178           return;
1179         }
1180 #if DEBUG_CORE
1181       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1182                   "Received notification about transmission readiness to `%s'.\n",
1183                   GNUNET_i2s (&smr->peer));
1184 #endif
1185       if (pr->pending_head == NULL)
1186         {
1187           /* request must have been cancelled between the original request
1188              and the response from core, ignore core's readiness */
1189           return;
1190         }
1191
1192       th = pr->pending_head;
1193       if (ntohs (smr->smr_id) != th->smr_id)
1194         {
1195           /* READY message is for expired or cancelled message,
1196              ignore! (we should have already sent another request) */
1197           break;
1198         }
1199       if ( (pr->prev != NULL) ||
1200            (pr->next != NULL) ||
1201            (h->ready_peer_head == pr) )
1202         {
1203           /* we should not already be on the ready list... */
1204           GNUNET_break (0);
1205           reconnect_later (h);
1206           return;
1207         }
1208       GNUNET_CONTAINER_DLL_insert (h->ready_peer_head,
1209                                    h->ready_peer_tail,
1210                                    pr);
1211       trigger_next_request (h, GNUNET_NO);
1212       break;
1213     case GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO:
1214       if (ntohs (msg->size) != sizeof (struct ConfigurationInfoMessage))
1215         {
1216           GNUNET_break (0);
1217           reconnect_later (h);
1218           return;
1219         }
1220       cim = (const struct ConfigurationInfoMessage*) msg;
1221       if (0 == memcmp (&h->me,
1222                        &cim->peer,
1223                        sizeof (struct GNUNET_PeerIdentity)))
1224         {
1225           /* self-change!? */
1226           GNUNET_break (0);
1227           return;
1228         }
1229 #if DEBUG_CORE
1230       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1231                   "Received notification about configuration update for `%s'.\n",
1232                   GNUNET_i2s (&cim->peer));
1233 #endif
1234       pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1235                                               &cim->peer.hashPubKey);
1236       if (pr == NULL)
1237         {
1238           GNUNET_break (0);
1239           reconnect_later (h);
1240           return;
1241         }
1242       if (pr->rim_id != ntohl (cim->rim_id))
1243         break;
1244       pcic = pr->pcic;
1245       pr->pcic = NULL;
1246       if (pcic != NULL)
1247         pcic (pr->pcic_cls,
1248               &pr->peer,
1249               cim->bw_out,
1250               ntohl (cim->reserved_amount),
1251               GNUNET_ntohll (cim->preference));
1252       break;
1253     default:
1254       reconnect_later (h);
1255       return;
1256     }
1257   GNUNET_CLIENT_receive (h->client,
1258                          &main_notify_handler, h,
1259                          GNUNET_TIME_UNIT_FOREVER_REL);
1260 }
1261
1262
1263 /**
1264  * Task executed once we are done transmitting the INIT message.
1265  * Starts our 'receive' loop.
1266  *
1267  * @param cls the 'struct GNUNET_CORE_Handle'
1268  * @param tc task context
1269  */
1270 static void
1271 init_done_task (void *cls,
1272                 const struct GNUNET_SCHEDULER_TaskContext *tc)
1273 {
1274   struct GNUNET_CORE_Handle *h = cls;
1275
1276   if (tc == NULL)
1277     return; /* error */
1278   if (0 == (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE))
1279     {
1280 #if DEBUG_CORE
1281       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1282                   "Failed to exchange INIT with core, retrying\n");
1283 #endif
1284       reconnect_later (h);
1285       return;
1286     }
1287   GNUNET_CLIENT_receive (h->client,
1288                          &main_notify_handler,
1289                          h,
1290                          GNUNET_TIME_UNIT_FOREVER_REL);
1291 }
1292
1293
1294 /**
1295  * Our current client connection went down.  Clean it up
1296  * and try to reconnect!
1297  *
1298  * @param h our handle to the core service
1299  */
1300 static void
1301 reconnect (struct GNUNET_CORE_Handle *h)
1302 {
1303   struct ControlMessage *cm;
1304   struct InitMessage *init;
1305   uint32_t opt;
1306   uint16_t msize;
1307   uint16_t *ts;
1308   unsigned int hpos;
1309
1310 #if DEBUG_CORE
1311   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1312               "Reconnecting to CORE service\n");
1313 #endif
1314   GNUNET_assert (h->client == NULL);
1315   GNUNET_assert (h->currently_down == GNUNET_YES);
1316   h->client = GNUNET_CLIENT_connect ("core", h->cfg);
1317   if (h->client == NULL)
1318     {
1319       reconnect_later (h);
1320       return;
1321     }
1322   msize = h->hcnt * sizeof (uint16_t) + sizeof (struct InitMessage);
1323   cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1324                       msize);
1325   cm->cont = &init_done_task;
1326   cm->cont_cls = h;
1327   init = (struct InitMessage*) &cm[1];
1328   init->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT);
1329   init->header.size = htons (msize);
1330   opt = GNUNET_CORE_OPTION_SEND_CONNECT | GNUNET_CORE_OPTION_SEND_DISCONNECT;
1331   if (h->status_events != NULL)
1332     opt |= GNUNET_CORE_OPTION_SEND_STATUS_CHANGE;
1333   if (h->inbound_notify != NULL)
1334     {
1335       if (h->inbound_hdr_only)
1336         opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
1337       else
1338         opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
1339     }
1340   if (h->outbound_notify != NULL)
1341     {
1342       if (h->outbound_hdr_only)
1343         opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
1344       else
1345         opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
1346     }
1347   init->options = htonl (opt);
1348   ts = (uint16_t *) &init[1];
1349   for (hpos = 0; hpos < h->hcnt; hpos++)
1350     ts[hpos] = htons (h->handlers[hpos].type);
1351   GNUNET_CONTAINER_DLL_insert (h->pending_head,
1352                                h->pending_tail,
1353                                cm);
1354   trigger_next_request (h, GNUNET_YES);
1355 }
1356
1357
1358
1359 /**
1360  * Connect to the core service.  Note that the connection may
1361  * complete (or fail) asynchronously.
1362  *
1363  * @param cfg configuration to use
1364  * @param queue_size size of the per-peer message queue
1365  * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
1366  * @param init callback to call on timeout or once we have successfully
1367  *        connected to the core service; note that timeout is only meaningful if init is not NULL
1368  * @param connects function to call on peer connect, can be NULL
1369  * @param disconnects function to call on peer disconnect / timeout, can be NULL
1370  * @param status_events function to call on changes to peer connection status, can be NULL
1371  * @param inbound_notify function to call for all inbound messages, can be NULL
1372  * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
1373  *                GNUNET_MessageHeader and hence we do not need to give it the full message;
1374  *                can be used to improve efficiency, ignored if inbound_notify is NULLL
1375  * @param outbound_notify function to call for all outbound messages, can be NULL
1376  * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
1377  *                GNUNET_MessageHeader and hence we do not need to give it the full message
1378  *                can be used to improve efficiency, ignored if outbound_notify is NULLL
1379  * @param handlers callbacks for messages we care about, NULL-terminated
1380  * @return handle to the core service (only useful for disconnect until 'init' is called);
1381  *                NULL on error (in this case, init is never called)
1382  */
1383 struct GNUNET_CORE_Handle *
1384 GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1385                      unsigned int queue_size,
1386                      void *cls,
1387                      GNUNET_CORE_StartupCallback init,
1388                      GNUNET_CORE_ConnectEventHandler connects,
1389                      GNUNET_CORE_DisconnectEventHandler disconnects,
1390                      GNUNET_CORE_PeerStatusEventHandler status_events,
1391                      GNUNET_CORE_MessageCallback inbound_notify,
1392                      int inbound_hdr_only,
1393                      GNUNET_CORE_MessageCallback outbound_notify,
1394                      int outbound_hdr_only,
1395                      const struct GNUNET_CORE_MessageHandler *handlers)
1396 {
1397   struct GNUNET_CORE_Handle *h;
1398
1399   h = GNUNET_malloc (sizeof (struct GNUNET_CORE_Handle));
1400   h->cfg = cfg;
1401   h->queue_size = queue_size;
1402   h->cls = cls;
1403   h->init = init;
1404   h->connects = connects;
1405   h->disconnects = disconnects;
1406   h->status_events = status_events;
1407   h->inbound_notify = inbound_notify;
1408   h->outbound_notify = outbound_notify;
1409   h->inbound_hdr_only = inbound_hdr_only;
1410   h->outbound_hdr_only = outbound_hdr_only;
1411   h->handlers = handlers;
1412   h->hcnt = 0;
1413   h->currently_down = GNUNET_YES;
1414   h->peers = GNUNET_CONTAINER_multihashmap_create (128);
1415   h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
1416   while (handlers[h->hcnt].callback != NULL)
1417     h->hcnt++;
1418   GNUNET_assert (h->hcnt <
1419                  (GNUNET_SERVER_MAX_MESSAGE_SIZE -
1420                   sizeof (struct InitMessage)) / sizeof (uint16_t));
1421 #if DEBUG_CORE
1422   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1423               "Connecting to CORE service\n");
1424 #endif
1425   reconnect (h);
1426   return h;
1427 }
1428
1429
1430 /**
1431  * Disconnect from the core service.  This function can only
1432  * be called *after* all pending 'GNUNET_CORE_notify_transmit_ready'
1433  * requests have been explicitly canceled.
1434  *
1435  * @param handle connection to core to disconnect
1436  */
1437 void
1438 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
1439 {
1440   struct ControlMessage *cm;
1441
1442 #if DEBUG_CORE
1443   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1444               "Disconnecting from CORE service\n");
1445 #endif
1446   if (handle->cth != NULL)
1447     {
1448       GNUNET_CLIENT_notify_transmit_ready_cancel (handle->cth);
1449       handle->cth = NULL;
1450     }
1451   if (handle->client != NULL)
1452     {
1453       GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1454       handle->client = NULL;
1455     }
1456   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1457     {
1458       GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1459       handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1460     }
1461   while (NULL != (cm = handle->pending_head))
1462     {
1463       GNUNET_CONTAINER_DLL_remove (handle->pending_head,
1464                                    handle->pending_tail,
1465                                    cm);
1466       if (cm->th != NULL)
1467         cm->th->cm = NULL;
1468       if (cm->cont != NULL)
1469         cm->cont (cm->cont_cls, NULL);
1470       GNUNET_free (cm);
1471     }
1472   GNUNET_CONTAINER_multihashmap_iterate (handle->peers,
1473                                          &disconnect_and_free_peer_entry,
1474                                          handle);
1475   GNUNET_CONTAINER_multihashmap_destroy (handle->peers);
1476   GNUNET_break (handle->ready_peer_head == NULL);
1477   GNUNET_free (handle);
1478 }
1479
1480
1481 /**
1482  * Ask the core to call "notify" once it is ready to transmit the
1483  * given number of bytes to the specified "target".  If we are not yet
1484  * connected to the specified peer, a call to this function will cause
1485  * us to try to establish a connection.
1486  *
1487  * @param handle connection to core service
1488  * @param priority how important is the message?
1489  * @param maxdelay how long can the message wait?
1490  * @param target who should receive the message,
1491  *        use NULL for this peer (loopback)
1492  * @param notify_size how many bytes of buffer space does notify want?
1493  * @param notify function to call when buffer space is available
1494  * @param notify_cls closure for notify
1495  * @return non-NULL if the notify callback was queued,
1496  *         NULL if we can not even queue the request (insufficient
1497  *         memory); if NULL is returned, "notify" will NOT be called.
1498  */
1499 struct GNUNET_CORE_TransmitHandle *
1500 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
1501                                    uint32_t priority,
1502                                    struct GNUNET_TIME_Relative maxdelay,
1503                                    const struct GNUNET_PeerIdentity *target,
1504                                    size_t notify_size,
1505                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
1506                                    void *notify_cls)
1507 {
1508   struct PeerRecord *pr;
1509   struct GNUNET_CORE_TransmitHandle *th;
1510   struct GNUNET_CORE_TransmitHandle *pos;
1511   struct GNUNET_CORE_TransmitHandle *prev;
1512   struct GNUNET_CORE_TransmitHandle *minp;
1513
1514   pr = GNUNET_CONTAINER_multihashmap_get (handle->peers,
1515                                           &target->hashPubKey);
1516   if (NULL == pr)
1517     {
1518       /* attempt to send to peer that is not connected */
1519       GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
1520                  "Attempting to send to peer `%s' from peer `%s', but not connected!\n",
1521                  GNUNET_i2s(target), GNUNET_h2s(&handle->me.hashPubKey));
1522       GNUNET_break (0);
1523       return NULL;
1524     }
1525   GNUNET_assert (notify_size + sizeof (struct SendMessage) <
1526                  GNUNET_SERVER_MAX_MESSAGE_SIZE);
1527   th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle));
1528   th->peer = pr;
1529   th->get_message = notify;
1530   th->get_message_cls = notify_cls;
1531   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1532   th->priority = priority;
1533   th->msize = notify_size;
1534   /* bound queue size */
1535   if (pr->queue_size == handle->queue_size)
1536     {
1537       /* find lowest-priority entry, but skip the head of the list */
1538       minp = pr->pending_head->next;
1539       prev = minp;
1540       while (prev != NULL)
1541         {
1542           if (prev->priority < minp->priority)
1543             minp = prev;
1544           prev = prev->next;
1545         }
1546       if (minp == NULL)
1547         {
1548           GNUNET_break (handle->queue_size != 0);
1549           GNUNET_break (pr->queue_size == 0);
1550           GNUNET_free(th);
1551           return NULL;
1552         }
1553       if (priority <= minp->priority)
1554         {
1555 #if DEBUG_CORE
1556           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1557                       "Dropping transmission request: priority too low\n");
1558 #endif
1559           return NULL; /* priority too low */
1560         }
1561       GNUNET_CONTAINER_DLL_remove (pr->pending_head,
1562                                    pr->pending_tail,
1563                                    minp);
1564       pr->queue_size--;
1565       GNUNET_assert (0 ==
1566                      minp->get_message (minp->get_message_cls,
1567                                         0, NULL));
1568       GNUNET_free (minp);
1569     }
1570
1571   /* Order entries by deadline, but SKIP 'HEAD' if
1572      we're in the 'ready_peer_*' DLL */
1573   pos = pr->pending_head;
1574   if ( (pr->prev != NULL) ||
1575        (pr->next != NULL) ||
1576        (pr == handle->ready_peer_head) )
1577     {
1578       GNUNET_assert (pos != NULL);
1579       pos = pos->next; /* skip head */
1580     }
1581
1582   /* insertion sort */
1583   prev = pos;
1584   while ( (pos != NULL) &&
1585           (pos->timeout.abs_value < th->timeout.abs_value) )
1586     {
1587       prev = pos;
1588       pos = pos->next;
1589     }
1590   GNUNET_CONTAINER_DLL_insert_after (pr->pending_head,
1591                                      pr->pending_tail,
1592                                      prev,
1593                                      th);
1594   pr->queue_size++;
1595   /* was the request queue previously empty? */
1596 #if DEBUG_CORE
1597   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1598               "Transmission request added to queue\n");
1599 #endif
1600   if (pr->pending_head == th)
1601     request_next_transmission (pr);
1602   return th;
1603 }
1604
1605
1606 /**
1607  * Cancel the specified transmission-ready notification.
1608  *
1609  * @param th handle that was returned by "notify_transmit_ready".
1610  */
1611 void
1612 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
1613                                           *th)
1614 {
1615   struct PeerRecord *pr = th->peer;
1616   struct GNUNET_CORE_Handle *h = pr->ch;
1617   int was_head;
1618
1619   was_head = (pr->pending_head == th);
1620   GNUNET_CONTAINER_DLL_remove (pr->pending_head,
1621                                pr->pending_tail,
1622                                th);
1623   pr->queue_size--;
1624   if (th->cm != NULL)
1625     {
1626       /* we're currently in the control queue, remove */
1627       GNUNET_CONTAINER_DLL_remove (h->pending_head,
1628                                    h->pending_tail,
1629                                    th->cm);
1630       GNUNET_free (th->cm);
1631     }
1632   GNUNET_free (th);
1633   if (was_head)
1634     {
1635       if ( (pr->prev != NULL) ||
1636            (pr->next != NULL) ||
1637            (pr == h->ready_peer_head) )
1638         {
1639           /* the request that was 'approved' by core was
1640              canceled before it could be transmitted; remove
1641              us from the 'ready' list */
1642           GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
1643                                        h->ready_peer_tail,
1644                                        pr);
1645         }
1646       request_next_transmission (pr);
1647     }
1648 }
1649
1650
1651 /* ****************** GNUNET_CORE_peer_request_connect ******************** */
1652
1653 /**
1654  * Handle for a request to the core to connect to
1655  * a particular peer.  Can be used to cancel the request
1656  * (before the 'cont'inuation is called).
1657  */
1658 struct GNUNET_CORE_PeerRequestHandle
1659 {
1660
1661   /**
1662    * Link to control message.
1663    */
1664   struct ControlMessage *cm;
1665
1666   /**
1667    * Core handle used.
1668    */
1669   struct GNUNET_CORE_Handle *h;
1670
1671   /**
1672    * Continuation to run when done.
1673    */
1674   GNUNET_SCHEDULER_Task cont;
1675
1676   /**
1677    * Closure for 'cont'.
1678    */
1679   void *cont_cls;
1680
1681 };
1682
1683
1684 /**
1685  * Continuation called when the control message was transmitted.
1686  * Calls the original continuation and frees the remaining
1687  * resources.
1688  *
1689  * @param cls the 'struct GNUNET_CORE_PeerRequestHandle'
1690  * @param tc scheduler context
1691  */
1692 static void
1693 peer_request_connect_cont (void *cls,
1694                            const struct GNUNET_SCHEDULER_TaskContext *tc)
1695 {
1696   struct GNUNET_CORE_PeerRequestHandle *ret = cls;
1697
1698   if (ret->cont != NULL)
1699     {
1700       if (tc == NULL)
1701         GNUNET_SCHEDULER_add_now (ret->cont,
1702                                   ret->cont_cls);
1703       else
1704         ret->cont (ret->cont_cls, tc);
1705     }
1706   GNUNET_free (ret);
1707 }
1708
1709
1710 /**
1711  * Request that the core should try to connect to a particular peer.
1712  * Once the request has been transmitted to the core, the continuation
1713  * function will be called.  Note that this does NOT mean that a
1714  * connection was successfully established -- it only means that the
1715  * core will now try.  Successful establishment of the connection
1716  * will be signalled to the 'connects' callback argument of
1717  * 'GNUNET_CORE_connect' only.  If the core service does not respond
1718  * to our connection attempt within the given time frame, 'cont' will
1719  * be called with the TIMEOUT reason code.
1720  *
1721  * @param h core handle
1722  * @param timeout how long to try to talk to core
1723  * @param peer who should we connect to
1724  * @param cont function to call once the request has been completed (or timed out)
1725  * @param cont_cls closure for cont
1726  * @return NULL on error (cont will not be called), otherwise handle for cancellation
1727  */
1728 struct GNUNET_CORE_PeerRequestHandle *
1729 GNUNET_CORE_peer_request_connect (struct GNUNET_CORE_Handle *h,
1730                                   struct GNUNET_TIME_Relative timeout,
1731                                   const struct GNUNET_PeerIdentity * peer,
1732                                   GNUNET_SCHEDULER_Task cont,
1733                                   void *cont_cls)
1734 {
1735   struct GNUNET_CORE_PeerRequestHandle *ret;
1736   struct ControlMessage *cm;
1737   struct ConnectMessage *msg;
1738
1739   cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1740                       sizeof (struct ConnectMessage));
1741   msg = (struct ConnectMessage*) &cm[1];
1742   msg->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONNECT);
1743   msg->header.size = htons (sizeof (struct ConnectMessage));
1744   msg->reserved = htonl (0);
1745   msg->timeout = GNUNET_TIME_relative_hton (timeout);
1746   msg->peer = *peer;
1747   GNUNET_CONTAINER_DLL_insert (h->pending_head,
1748                                h->pending_tail,
1749                                cm);
1750   ret = GNUNET_malloc (sizeof (struct GNUNET_CORE_PeerRequestHandle));
1751   ret->h = h;
1752   ret->cm = cm;
1753   ret->cont = cont;
1754   ret->cont_cls = cont_cls;
1755   cm->cont = &peer_request_connect_cont;
1756   cm->cont_cls = ret;
1757 #if DEBUG_CORE
1758   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1759               "Queueing REQUEST_CONNECT request\n");
1760 #endif
1761   if (h->pending_head == cm)
1762     trigger_next_request (h, GNUNET_NO);
1763   return ret;
1764 }
1765
1766
1767 /**
1768  * Cancel a pending request to connect to a particular peer.  Must not
1769  * be called after the 'cont' function was invoked.
1770  *
1771  * @param req request handle that was returned for the original request
1772  */
1773 void
1774 GNUNET_CORE_peer_request_connect_cancel (struct GNUNET_CORE_PeerRequestHandle *req)
1775 {
1776   struct GNUNET_CORE_Handle *h = req->h;
1777   struct ControlMessage *cm = req->cm;
1778
1779   GNUNET_CONTAINER_DLL_remove (h->pending_head,
1780                                h->pending_tail,
1781                                cm);
1782   GNUNET_free (cm);
1783   GNUNET_free (req);
1784 }
1785
1786
1787 /* ****************** GNUNET_CORE_peer_change_preference ******************** */
1788
1789
1790 struct GNUNET_CORE_InformationRequestContext
1791 {
1792
1793   /**
1794    * Our connection to the service.
1795    */
1796   struct GNUNET_CORE_Handle *h;
1797
1798   /**
1799    * Function to call with the information.
1800    */
1801   GNUNET_CORE_PeerConfigurationInfoCallback info;
1802
1803   /**
1804    * Closure for info.
1805    */
1806   void *info_cls;
1807
1808   /**
1809    * Link to control message, NULL if CM was sent.
1810    */
1811   struct ControlMessage *cm;
1812
1813   /**
1814    * Link to peer record.
1815    */
1816   struct PeerRecord *pr;
1817 };
1818
1819
1820 /**
1821  * CM was sent, remove link so we don't double-free.
1822  *
1823  * @param cls the 'struct GNUNET_CORE_InformationRequestContext'
1824  * @param tc scheduler context
1825  */
1826 static void
1827 change_preference_send_continuation (void *cls,
1828                                      const struct GNUNET_SCHEDULER_TaskContext *tc)
1829 {
1830   struct GNUNET_CORE_InformationRequestContext *irc = cls;
1831
1832   irc->cm = NULL;
1833 }
1834
1835
1836 /**
1837  * Obtain statistics and/or change preferences for the given peer.
1838  *
1839  * @param h core handle
1840  * @param peer identifies the peer
1841  * @param timeout after how long should we give up (and call "info" with NULL
1842  *                for "peer" to signal an error)?
1843  * @param bw_out set to the current bandwidth limit (sending) for this peer,
1844  *                caller should set "bw_out" to "-1" to avoid changing
1845  *                the current value; otherwise "bw_out" will be lowered to
1846  *                the specified value; passing a pointer to "0" can be used to force
1847  *                us to disconnect from the peer; "bw_out" might not increase
1848  *                as specified since the upper bound is generally
1849  *                determined by the other peer!
1850  * @param amount reserve N bytes for receiving, negative
1851  *                amounts can be used to undo a (recent) reservation;
1852  * @param preference increase incoming traffic share preference by this amount;
1853  *                in the absence of "amount" reservations, we use this
1854  *                preference value to assign proportional bandwidth shares
1855  *                to all connected peers
1856  * @param info function to call with the resulting configuration information
1857  * @param info_cls closure for info
1858  * @return NULL on error
1859  */
1860 struct GNUNET_CORE_InformationRequestContext *
1861 GNUNET_CORE_peer_change_preference (struct GNUNET_CORE_Handle *h,
1862                                     const struct GNUNET_PeerIdentity *peer,
1863                                     struct GNUNET_TIME_Relative timeout,
1864                                     struct GNUNET_BANDWIDTH_Value32NBO bw_out,
1865                                     int32_t amount,
1866                                     uint64_t preference,
1867                                     GNUNET_CORE_PeerConfigurationInfoCallback info,
1868                                     void *info_cls)
1869 {
1870   struct GNUNET_CORE_InformationRequestContext *irc;
1871   struct PeerRecord *pr;
1872   struct RequestInfoMessage *rim;
1873   struct ControlMessage *cm;
1874
1875   pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1876                                           &peer->hashPubKey);
1877   if (NULL == pr)
1878     {
1879       /* attempt to change preference on peer that is not connected */
1880       GNUNET_break (0);
1881       return NULL;
1882     }
1883   if (pr->pcic != NULL)
1884     {
1885       /* second change before first one is done */
1886       GNUNET_break (0);
1887       return NULL;
1888     }
1889   irc = GNUNET_malloc (sizeof (struct GNUNET_CORE_InformationRequestContext));
1890   irc->h = h;
1891   irc->pr = pr;
1892   irc->info = info;
1893   irc->info_cls = info_cls;
1894   cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1895                       sizeof (struct RequestInfoMessage));
1896   cm->cont = &change_preference_send_continuation;
1897   cm->cont_cls = irc;
1898   irc->cm = cm;
1899   rim = (struct RequestInfoMessage*) &cm[1];
1900   rim->header.size = htons (sizeof (struct RequestInfoMessage));
1901   rim->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_INFO);
1902   rim->rim_id = htonl (pr->rim_id = h->rim_id_gen++);
1903   rim->limit_outbound = bw_out;
1904   rim->reserve_inbound = htonl (amount);
1905   rim->preference_change = GNUNET_htonll(preference);
1906   rim->peer = *peer;
1907 #if DEBUG_CORE
1908   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1909               "Queueing CHANGE PREFERENCE request\n");
1910 #endif
1911   GNUNET_CONTAINER_DLL_insert (h->pending_head,
1912                                h->pending_tail,
1913                                cm);
1914   pr->pcic = info;
1915   pr->pcic_cls = info_cls;
1916   if (h->pending_head == cm)
1917     trigger_next_request (h, GNUNET_NO);
1918   return irc;
1919 }
1920
1921
1922 /**
1923  * Cancel request for getting information about a peer.
1924  * Note that an eventual change in preference, trust or bandwidth
1925  * assignment MAY have already been committed at the time,
1926  * so cancelling a request is NOT sure to undo the original
1927  * request.  The original request may or may not still commit.
1928  * The only thing cancellation ensures is that the callback
1929  * from the original request will no longer be called.
1930  *
1931  * @param irc context returned by the original GNUNET_CORE_peer_get_info call
1932  */
1933 void
1934 GNUNET_CORE_peer_change_preference_cancel (struct GNUNET_CORE_InformationRequestContext *irc)
1935 {
1936   struct GNUNET_CORE_Handle *h = irc->h;
1937   struct PeerRecord *pr = irc->pr;
1938
1939   if (irc->cm != NULL)
1940     {
1941       GNUNET_CONTAINER_DLL_remove (h->pending_head,
1942                                    h->pending_tail,
1943                                    irc->cm);
1944       GNUNET_free (irc->cm);
1945     }
1946   pr->pcic = NULL;
1947   pr->pcic_cls = NULL;
1948   GNUNET_free (irc);
1949 }
1950
1951
1952 /* end of core_api.c */