src/core/core_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file 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_core_service.h"
  29 #include "core.h"
  30
  31
  32 /**
  33  * Context for the core service connection.
  34  */
  35 struct GNUNET_CORE_Handle
  36 {
  37
  38   /**
  39    * Our scheduler.
  40    */
  41   struct GNUNET_SCHEDULER_Handle *sched;
  42
  43   /**
  44    * Configuration we're using.
  45    */
  46   const struct GNUNET_CONFIGURATION_Handle *cfg;
  47
  48   /**
  49    * Closure for the various callbacks.
  50    */
  51   void *cls;
  52
  53   /**
  54    * Function to call once we've handshaked with the core service.
  55    */
  56   GNUNET_CORE_StartupCallback init;
  57
  58   /**
  59    * Function to call whenever we're notified about a peer connecting.
  60    */
  61   GNUNET_CORE_ConnectEventHandler connects;
  62
  63   /**
  64    * Function to call whenever we're notified about a peer disconnecting.
  65    */
  66   GNUNET_CORE_DisconnectEventHandler disconnects;
  67
  68   /**
  69    * Function to call whenever we receive an inbound message.
  70    */
  71   GNUNET_CORE_MessageCallback inbound_notify;
  72
  73   /**
  74    * Function to call whenever we receive an outbound message.
  75    */
  76   GNUNET_CORE_MessageCallback outbound_notify;
  77
  78   /**
  79    * Function handlers for messages of particular type.
  80    */
  81   const struct GNUNET_CORE_MessageHandler *handlers;
  82
  83   /**
  84    * Our connection to the service for notifications.
  85    */
  86   struct GNUNET_CLIENT_Connection *client_notifications;
  87
  88   /**
  89    * Handle for our current transmission request.
  90    */
  91   struct GNUNET_CLIENT_TransmitHandle *cth;
  92
  93   /**
  94    * Head of doubly-linked list of pending requests.
  95    */
  96   struct GNUNET_CORE_TransmitHandle *pending_head;
  97
  98   /**
  99    * Tail of doubly-linked list of pending requests.
 100    */
 101   struct GNUNET_CORE_TransmitHandle *pending_tail;
 102
 103   /**
 104    * Currently submitted request (or NULL)
 105    */
 106   struct GNUNET_CORE_TransmitHandle *submitted;
 107
 108   /**
 109    * Currently submitted request based on solicitation (or NULL)
 110    */
 111   struct GNUNET_CORE_TransmitHandle *solicit_transmit_req;
 112
 113   /**
 114    * Buffer where we store a message for transmission in response
 115    * to a traffic solicitation (or NULL).
 116    */
 117   char *solicit_buffer;
 118
 119   /**
 120    * How long to wait until we time out the connection attempt?
 121    */
 122   struct GNUNET_TIME_Absolute startup_timeout;
 123
 124   /**
 125    * ID of reconnect task (if any).
 126    */
 127   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
 128
 129   /**
 130    * Number of entries in the handlers array.
 131    */
 132   unsigned int hcnt;
 133
 134   /**
 135    * For inbound notifications without a specific handler, do
 136    * we expect to only receive headers?
 137    */
 138   int inbound_hdr_only;
 139
 140   /**
 141    * For outbound notifications without a specific handler, do
 142    * we expect to only receive headers?
 143    */
 144   int outbound_hdr_only;
 145
 146   /**
 147    * Are we currently disconnected and hence unable to forward
 148    * requests?
 149    */
 150   int currently_down;
 151 };
 152
 153
 154 /**
 155  * Handle for a transmission request.
 156  */
 157 struct GNUNET_CORE_TransmitHandle
 158 {
 159
 160   /**
 161    * We keep active transmit handles in a doubly-linked list.
 162    */
 163   struct GNUNET_CORE_TransmitHandle *next;
 164
 165   /**
 166    * We keep active transmit handles in a doubly-linked list.
 167    */
 168   struct GNUNET_CORE_TransmitHandle *prev;
 169
 170   /**
 171    * Corresponding core handle.
 172    */
 173   struct GNUNET_CORE_Handle *ch;
 174
 175   /**
 176    * Function that will be called to get the actual request
 177    * (once we are ready to transmit this request to the core).
 178    * The function will be called with a NULL buffer to signal
 179    * timeout.
 180    */
 181   GNUNET_CONNECTION_TransmitReadyNotify get_message;
 182
 183   /**
 184    * Closure for get_message.
 185    */
 186   void *get_message_cls;
 187
 188   /**
 189    * If this entry is for a transmission request, pointer
 190    * to the notify callback; otherwise NULL.
 191    */
 192   GNUNET_CONNECTION_TransmitReadyNotify notify;
 193
 194   /**
 195    * Closure for notify.
 196    */
 197   void *notify_cls;
 198
 199   /**
 200    * Peer the request is about.
 201    */
 202   struct GNUNET_PeerIdentity peer;
 203
 204   /**
 205    * Timeout for this handle.
 206    */
 207   struct GNUNET_TIME_Absolute timeout;
 208
 209   /**
 210    * ID of timeout task.
 211    */
 212   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 213
 214   /**
 215    * How important is this message?
 216    */
 217   uint32_t priority;
 218
 219   /**
 220    * Size of this request.
 221    */
 222   uint16_t msize;
 223
 224
 225 };
 226
 227
 228 static void
 229 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 230
 231
 232 /**
 233  * Function called when we are ready to transmit our
 234  * "START" message (or when this operation timed out).
 235  *
 236  * @param cls closure
 237  * @param size number of bytes available in buf
 238  * @param buf where the callee should write the message
 239  * @return number of bytes written to buf
 240  */
 241 static size_t transmit_start (void *cls, size_t size, void *buf);
 242
 243
 244 /**
 245  * Our current client connection went down.  Clean it up
 246  * and try to reconnect!
 247  *
 248  * @param h our handle to the core service
 249  */
 250 static void
 251 reconnect (struct GNUNET_CORE_Handle *h)
 252 {
 253   if (h->client_notifications != NULL)
 254     GNUNET_CLIENT_disconnect (h->client_notifications, GNUNET_NO);
 255   h->currently_down = GNUNET_YES;
 256   h->client_notifications = GNUNET_CLIENT_connect (h->sched, "core", h->cfg);
 257   if (h->client_notifications == NULL)
 258     h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->sched,
 259                                                       GNUNET_TIME_UNIT_SECONDS,
 260                                                       &reconnect_task,
 261                                                       h);
 262   else
 263     h->cth = GNUNET_CLIENT_notify_transmit_ready (h->client_notifications,
 264                                                   sizeof (struct InitMessage) +
 265                                                   sizeof (uint16_t) * h->hcnt,
 266                                                   GNUNET_TIME_UNIT_SECONDS,
 267                                                   GNUNET_NO,
 268                                                   &transmit_start, h);
 269 }
 270
 271
 272 /**
 273  * The given request hit its timeout.  Remove from the
 274  * doubly-linked list and call the respective continuation.
 275  *
 276  * @param cls the transmit handle of the request that timed out
 277  * @param tc context, can be NULL (!)
 278  */
 279 static void
 280 timeout_request (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 281 {
 282   struct GNUNET_CORE_TransmitHandle *th = cls;
 283
 284   th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 285   GNUNET_assert (0 == th->get_message (th->get_message_cls, 0, NULL));
 286 }
 287
 288
 289 /**
 290  * Function called when we are ready to transmit a request from our
 291  * request list (or when this operation timed out).
 292  *
 293  * @param cls closure
 294  * @param size number of bytes available in buf
 295  * @param buf where the callee should write the message
 296  * @return number of bytes written to buf
 297  */
 298 static size_t
 299 request_start (void *cls, size_t size, void *buf)
 300 {
 301   struct GNUNET_CORE_Handle *h = cls;
 302   struct GNUNET_CORE_TransmitHandle *th;
 303   size_t ret;
 304
 305   h->cth = NULL;
 306   th = h->pending_head;
 307   if (buf == NULL)
 308     {
 309       timeout_request (th, NULL);
 310       return 0;
 311     }
 312   GNUNET_CONTAINER_DLL_remove (h->pending_head,
 313                                h->pending_tail,
 314                                th);
 315   GNUNET_assert (h->submitted == NULL);
 316   h->submitted = th;
 317   GNUNET_assert (size >= th->msize);
 318   ret = th->get_message (th->get_message_cls, size, buf);
 319   GNUNET_assert (ret <= size);
 320   return ret;
 321 }
 322
 323
 324 /**
 325  * Check the list of pending requests, send the next
 326  * one to the core.
 327  */
 328 static void
 329 trigger_next_request (struct GNUNET_CORE_Handle *h)
 330 {
 331   struct GNUNET_CORE_TransmitHandle *th;
 332
 333   if (h->currently_down)
 334     {
 335 #if DEBUG_CORE
 336       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 337                   "In trigger_next_request, connection currently down...\n");
 338 #endif
 339       return;                     /* connection temporarily down */
 340     }
 341   if (NULL == (th = h->pending_head))
 342     return;                     /* no requests pending */
 343   GNUNET_assert (NULL == h->cth);
 344   h->cth = GNUNET_CLIENT_notify_transmit_ready (h->client_notifications,
 345                                                 th->msize,
 346                                                 GNUNET_TIME_absolute_get_remaining
 347                                                 (th->timeout),
 348                                                 GNUNET_NO,
 349                                                 &request_start,
 350                                                 h);
 351 }
 352
 353
 354 /**
 355  * Handler for notification messages received from the core.
 356  *
 357  * @param cls our "struct GNUNET_CORE_Handle"
 358  * @param msg the message received from the core service
 359  */
 360 static void
 361 main_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 362 {
 363   struct GNUNET_CORE_Handle *h = cls;
 364   unsigned int hpos;
 365   const struct ConnectNotifyMessage *cnm;
 366   const struct DisconnectNotifyMessage *dnm;
 367   const struct NotifyTrafficMessage *ntm;
 368   const struct GNUNET_MessageHeader *em;
 369   uint16_t msize;
 370   uint16_t et;
 371   const struct GNUNET_CORE_MessageHandler *mh;
 372
 373   if (msg == NULL)
 374     {
 375       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 376                   _
 377                   ("Client was disconnected from core service, trying to reconnect.\n"));
 378       reconnect (h);
 379       return;
 380     }
 381   msize = ntohs (msg->size);
 382 #if DEBUG_CORE
 383   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 384               "Processing message of type %u and size %u from core service\n",
 385               ntohs (msg->type), msize);
 386 #endif
 387   switch (ntohs (msg->type))
 388     {
 389     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT:
 390       if (NULL == h->connects)
 391         {
 392           GNUNET_break (0);
 393           break;
 394         }
 395       if (msize != sizeof (struct ConnectNotifyMessage))
 396         {
 397           GNUNET_break (0);
 398           break;
 399         }
 400       cnm = (const struct ConnectNotifyMessage *) msg;
 401       h->connects (h->cls,
 402                    &cnm->peer,
 403                    GNUNET_TIME_relative_ntoh (cnm->latency),
 404                    ntohl (cnm->distance));
 405       break;
 406     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT:
 407       if (NULL == h->disconnects)
 408         {
 409           GNUNET_break (0);
 410           break;
 411         }
 412       if (msize != sizeof (struct DisconnectNotifyMessage))
 413         {
 414           GNUNET_break (0);
 415           break;
 416         }
 417       dnm = (const struct DisconnectNotifyMessage *) msg;
 418       h->disconnects (h->cls,
 419                       &dnm->peer);
 420       break;
 421     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND:
 422       if (msize <
 423           sizeof (struct NotifyTrafficMessage) +
 424           sizeof (struct GNUNET_MessageHeader))
 425         {
 426           GNUNET_break (0);
 427           break;
 428         }
 429       ntm = (const struct NotifyTrafficMessage *) msg;
 430       em = (const struct GNUNET_MessageHeader *) &ntm[1];
 431 #if DEBUG_CORE
 432       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 433                   "Received message of type %u and size %u from peer `%4s'\n",
 434                   ntohs (em->type),
 435                   ntohs (em->size),
 436                   GNUNET_i2s (&ntm->peer));
 437 #endif
 438       if ((GNUNET_NO == h->inbound_hdr_only) &&
 439           (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
 440         {
 441           GNUNET_break (0);
 442           break;
 443         }
 444       et = ntohs (em->type);
 445       for (hpos = 0; hpos < h->hcnt; hpos++)
 446         {
 447           mh = &h->handlers[hpos];
 448           if (mh->type != et)
 449             continue;
 450           if ((mh->expected_size != ntohs (em->size)) &&
 451               (mh->expected_size != 0))
 452             {
 453               GNUNET_break (0);
 454               continue;
 455             }
 456           if (GNUNET_OK !=
 457               h->handlers[hpos].callback (h->cls, &ntm->peer, em,
 458                                           GNUNET_TIME_relative_ntoh (ntm->latency),
 459                                           ntohl (ntm->distance)))
 460             {
 461               /* error in processing, disconnect ! */
 462               reconnect (h);
 463               return;
 464             }
 465         }
 466       if (NULL != h->inbound_notify)
 467         h->inbound_notify (h->cls, &ntm->peer, em,
 468                            GNUNET_TIME_relative_ntoh (ntm->latency),
 469                            ntohl (ntm->distance));
 470       break;
 471     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND:
 472       if (msize <
 473           sizeof (struct NotifyTrafficMessage) +
 474           sizeof (struct GNUNET_MessageHeader))
 475         {
 476           GNUNET_break (0);
 477           break;
 478         }
 479       ntm = (const struct NotifyTrafficMessage *) msg;
 480       em = (const struct GNUNET_MessageHeader *) &ntm[1];
 481       if ((GNUNET_NO == h->outbound_hdr_only) &&
 482           (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
 483         {
 484           GNUNET_break (0);
 485           break;
 486         }
 487       if (NULL == h->outbound_notify)
 488         {
 489           GNUNET_break (0);
 490           break;
 491         }
 492       h->outbound_notify (h->cls, &ntm->peer, em,
 493                           GNUNET_TIME_relative_ntoh (ntm->latency),
 494                           ntohl (ntm->distance));
 495       break;
 496     default:
 497       GNUNET_break (0);
 498       break;
 499     }
 500   GNUNET_CLIENT_receive (h->client_notifications,
 501                          &main_notify_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
 502 }
 503
 504
 505 /**
 506  * Function called when we are ready to transmit our
 507  * "START" message (or when this operation timed out).
 508  *
 509  * @param cls closure
 510  * @param size number of bytes available in buf
 511  * @param buf where the callee should write the message
 512  * @return number of bytes written to buf
 513  */
 514 static size_t transmit_start (void *cls, size_t size, void *buf);
 515
 516
 517 /**
 518  * Function called on the first message received from
 519  * the service (contains our public key, etc.).
 520  * Should trigger calling the init callback
 521  * and then start our regular message processing.
 522  *
 523  * @param cls closure
 524  * @param msg message received, NULL on timeout or fatal error
 525  */
 526 static void
 527 init_reply_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 528 {
 529   struct GNUNET_CORE_Handle *h = cls;
 530   const struct InitReplyMessage *m;
 531   GNUNET_CORE_StartupCallback init;
 532   struct GNUNET_PeerIdentity my_identity;
 533
 534   if ((msg == NULL) ||
 535       (ntohs (msg->size) != sizeof (struct InitReplyMessage)) ||
 536       (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY))
 537     {
 538       if (msg != NULL)
 539         {
 540           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 541                       _
 542                       ("Error connecting to core service (failed to receive `%s' message, got message of type %u and size %u).\n"),
 543                       "INIT_REPLY",
 544                       ntohs (msg->type),
 545                       ntohs (msg->size));
 546           GNUNET_break (0);
 547         }
 548       else
 549         {
 550 #if DEBUG_CORE
 551           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 552                       _("Failed to connect to core service, will retry.\n"));
 553 #endif
 554         }
 555       transmit_start (h, 0, NULL);
 556       return;
 557     }
 558   m = (const struct InitReplyMessage *) msg;
 559   /* start our message processing loop */
 560 #if DEBUG_CORE
 561   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 562               "Successfully connected to core service, starting processing loop.\n");
 563 #endif
 564   h->currently_down = GNUNET_NO;
 565   trigger_next_request (h);
 566   GNUNET_CLIENT_receive (h->client_notifications,
 567                          &main_notify_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
 568   if (NULL != (init = h->init))
 569     {
 570       /* mark so we don't call init on reconnect */
 571       h->init = NULL;
 572       GNUNET_CRYPTO_hash (&m->publicKey,
 573                           sizeof (struct
 574                                   GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
 575                           &my_identity.hashPubKey);
 576       init (h->cls, h, &my_identity, &m->publicKey);
 577     }
 578 }
 579
 580
 581 static void
 582 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 583 {
 584   struct GNUNET_CORE_Handle *h = cls;
 585   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 586   reconnect (h);
 587 }
 588
 589
 590 /**
 591  * Function called when we are ready to transmit our
 592  * "START" message (or when this operation timed out).
 593  *
 594  * @param cls closure
 595  * @param size number of bytes available in buf
 596  * @param buf where the callee should write the message
 597  * @return number of bytes written to buf
 598  */
 599 static size_t
 600 transmit_start (void *cls, size_t size, void *buf)
 601 {
 602   struct GNUNET_CORE_Handle *h = cls;
 603   struct InitMessage *init;
 604   uint16_t *ts;
 605   uint16_t msize;
 606   uint32_t opt;
 607   unsigned int hpos;
 608   struct GNUNET_TIME_Relative delay;
 609
 610   h->cth = NULL;
 611   if (size == 0)
 612     {
 613       if ((h->init == NULL) ||
 614           (GNUNET_TIME_absolute_get ().value < h->startup_timeout.value))
 615         {
 616           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 617                       _("Failed to connect to core service, retrying.\n"));
 618           delay = GNUNET_TIME_absolute_get_remaining (h->startup_timeout);
 619           if ((h->init == NULL) || (delay.value > 1000))
 620             delay = GNUNET_TIME_UNIT_SECONDS;
 621           if (h->init == NULL)
 622             h->startup_timeout =
 623               GNUNET_TIME_relative_to_absolute (GNUNET_TIME_UNIT_MINUTES);
 624           h->reconnect_task =
 625             GNUNET_SCHEDULER_add_delayed (h->sched,
 626                                           delay, &reconnect_task, h);
 627           return 0;
 628         }
 629       /* timeout on initial connect */
 630       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 631                   _("Failed to connect to core service, giving up.\n"));
 632       h->init (h->cls, NULL, NULL, NULL);
 633       GNUNET_CORE_disconnect (h);
 634       return 0;
 635     }
 636   msize = h->hcnt * sizeof (uint16_t) + sizeof (struct InitMessage);
 637   GNUNET_assert (size >= msize);
 638   init = buf;
 639   init->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT);
 640   init->header.size = htons (msize);
 641   opt = GNUNET_CORE_OPTION_NOTHING;
 642   if (h->connects != NULL)
 643     opt |= GNUNET_CORE_OPTION_SEND_CONNECT;
 644   if (h->disconnects != NULL)
 645     opt |= GNUNET_CORE_OPTION_SEND_DISCONNECT;
 646   if (h->inbound_notify != NULL)
 647     {
 648       if (h->inbound_hdr_only)
 649         opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
 650       else
 651         opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
 652     }
 653   if (h->outbound_notify != NULL)
 654     {
 655       if (h->outbound_hdr_only)
 656         opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
 657       else
 658         opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
 659     }
 660   init->options = htonl (opt);
 661   ts = (uint16_t *) & init[1];
 662   for (hpos = 0; hpos < h->hcnt; hpos++)
 663     ts[hpos] = htons (h->handlers[hpos].type);
 664   GNUNET_CLIENT_receive (h->client_notifications,
 665                          &init_reply_handler,
 666                          h,
 667                          GNUNET_TIME_absolute_get_remaining
 668                          (h->startup_timeout));
 669   return sizeof (struct InitMessage) + h->hcnt * sizeof (uint16_t);
 670 }
 671
 672
 673 /**
 674  * Connect to the core service.  Note that the connection may
 675  * complete (or fail) asynchronously.
 676  *
 677  * @param sched scheduler to use
 678  * @param cfg configuration to use
 679  * @param timeout after how long should we give up trying to connect to the core service?
 680  * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
 681  * @param init callback to call on timeout or once we have successfully
 682  *        connected to the core service; note that timeout is only meaningful if init is not NULL
 683  * @param connects function to call on peer connect, can be NULL
 684  * @param disconnects function to call on peer disconnect / timeout, can be NULL
 685  * @param inbound_notify function to call for all inbound messages, can be NULL
 686  * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
 687  *                GNUNET_MessageHeader and hence we do not need to give it the full message;
 688  *                can be used to improve efficiency, ignored if inbound_notify is NULLL
 689  * @param outbound_notify function to call for all outbound messages, can be NULL
 690  * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
 691  *                GNUNET_MessageHeader and hence we do not need to give it the full message
 692  *                can be used to improve efficiency, ignored if outbound_notify is NULLL
 693  * @param handlers callbacks for messages we care about, NULL-terminated
 694  * @return handle to the core service (only useful for disconnect until 'init' is called);
 695  *                NULL on error (in this case, init is never called)
 696  */
 697 struct GNUNET_CORE_Handle *
 698 GNUNET_CORE_connect (struct GNUNET_SCHEDULER_Handle *sched,
 699                      const struct GNUNET_CONFIGURATION_Handle *cfg,
 700                      struct GNUNET_TIME_Relative timeout,
 701                      void *cls,
 702                      GNUNET_CORE_StartupCallback init,
 703                      GNUNET_CORE_ConnectEventHandler connects,
 704                      GNUNET_CORE_DisconnectEventHandler disconnects,
 705                      GNUNET_CORE_MessageCallback inbound_notify,
 706                      int inbound_hdr_only,
 707                      GNUNET_CORE_MessageCallback outbound_notify,
 708                      int outbound_hdr_only,
 709                      const struct GNUNET_CORE_MessageHandler *handlers)
 710 {
 711   struct GNUNET_CORE_Handle *h;
 712
 713   h = GNUNET_malloc (sizeof (struct GNUNET_CORE_Handle));
 714   h->sched = sched;
 715   h->cfg = cfg;
 716   h->cls = cls;
 717   h->init = init;
 718   h->connects = connects;
 719   h->disconnects = disconnects;
 720   h->inbound_notify = inbound_notify;
 721   h->outbound_notify = outbound_notify;
 722   h->inbound_hdr_only = inbound_hdr_only;
 723   h->outbound_hdr_only = outbound_hdr_only;
 724   h->handlers = handlers;
 725   h->client_notifications = GNUNET_CLIENT_connect (sched, "core", cfg);
 726   if (h->client_notifications == NULL)
 727     {
 728       GNUNET_free (h);
 729       return NULL;
 730     }
 731   h->startup_timeout = GNUNET_TIME_relative_to_absolute (timeout);
 732   h->hcnt = 0;
 733   while (handlers[h->hcnt].callback != NULL)
 734     h->hcnt++;
 735   GNUNET_assert (h->hcnt <
 736                  (GNUNET_SERVER_MAX_MESSAGE_SIZE -
 737                   sizeof (struct InitMessage)) / sizeof (uint16_t));
 738 #if DEBUG_CORE
 739   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 740               "Trying to connect to core service in next %llu ms.\n",
 741               timeout.value);
 742 #endif
 743   h->cth =
 744     GNUNET_CLIENT_notify_transmit_ready (h->client_notifications,
 745                                          sizeof (struct InitMessage) +
 746                                          sizeof (uint16_t) * h->hcnt, timeout,
 747                                          GNUNET_YES,
 748                                          &transmit_start, h);
 749   return h;
 750 }
 751
 752
 753 /**
 754  * Disconnect from the core service.
 755  *
 756  * @param handle connection to core to disconnect
 757  */
 758 void
 759 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
 760 {
 761   if (handle->cth != NULL)
 762     GNUNET_CLIENT_notify_transmit_ready_cancel (handle->cth);
 763   if (handle->solicit_transmit_req != NULL)
 764     GNUNET_CORE_notify_transmit_ready_cancel (handle->solicit_transmit_req);
 765   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
 766     GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
 767   if (handle->client_notifications != NULL)
 768     GNUNET_CLIENT_disconnect (handle->client_notifications, GNUNET_NO);
 769   GNUNET_free_non_null (handle->solicit_buffer);
 770   GNUNET_free (handle);
 771 }
 772
 773
 774 /**
 775  * Build the message requesting data transmission.
 776  */
 777 static size_t
 778 produce_send (void *cls, size_t size, void *buf)
 779 {
 780   struct GNUNET_CORE_TransmitHandle *th = cls;
 781   struct GNUNET_CORE_Handle *h;
 782   struct SendMessage *sm;
 783   size_t dt;
 784   GNUNET_CONNECTION_TransmitReadyNotify notify;
 785   void *notify_cls;
 786
 787   h = th->ch;
 788   if (buf == NULL)
 789     {
 790       /* timeout or error */
 791 #if DEBUG_CORE
 792       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 793                   "P2P transmission request for `%4s' timed out.\n",
 794                   GNUNET_i2s(&th->peer));
 795 #endif
 796       GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
 797       GNUNET_CORE_notify_transmit_ready_cancel (th);
 798       trigger_next_request (h);
 799       return 0;
 800     }
 801 #if DEBUG_CORE
 802   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 803               "Preparing for P2P transmission to `%4s'.\n",
 804               GNUNET_i2s(&th->peer));
 805 #endif
 806   sm = (struct SendMessage *) buf;
 807   sm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND);
 808   sm->priority = htonl (th->priority);
 809   sm->deadline = GNUNET_TIME_absolute_hton (th->timeout);
 810   sm->peer = th->peer;
 811   notify = th->notify;
 812   notify_cls = th->notify_cls;
 813   GNUNET_CORE_notify_transmit_ready_cancel (th);
 814   trigger_next_request (h);
 815   GNUNET_assert (size >= sizeof (struct SendMessage));
 816   dt = notify (notify_cls, size - sizeof (struct SendMessage), &sm[1]);
 817   if (0 == dt)
 818     {
 819 #if DEBUG_CORE
 820   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 821               "Size of clients message to peer %s is 0!\n",
 822               GNUNET_i2s(&th->peer));
 823 #endif
 824       /* client decided to send nothing! */
 825       return 0;
 826     }
 827   GNUNET_assert (dt >= sizeof (struct GNUNET_MessageHeader));
 828   if (dt + sizeof (struct SendMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 829     {
 830       GNUNET_break (0);
 831       return 0;
 832     }
 833   sm->header.size = htons (dt + sizeof (struct SendMessage));
 834   GNUNET_assert (dt + sizeof (struct SendMessage) <= size);
 835   return dt + sizeof (struct SendMessage);
 836 }
 837
 838
 839 /**
 840  * Ask the core to call "notify" once it is ready to transmit the
 841  * given number of bytes to the specified "target".  If we are not yet
 842  * connected to the specified peer, a call to this function will cause
 843  * us to try to establish a connection.
 844  *
 845  * @param handle connection to core service
 846  * @param priority how important is the message?
 847  * @param maxdelay how long can the message wait?
 848  * @param target who should receive the message,
 849  *        use NULL for this peer (loopback)
 850  * @param notify_size how many bytes of buffer space does notify want?
 851  * @param notify function to call when buffer space is available
 852  * @param notify_cls closure for notify
 853  * @return non-NULL if the notify callback was queued,
 854  *         NULL if we can not even queue the request (insufficient
 855  *         memory); if NULL is returned, "notify" will NOT be called.
 856  */
 857 struct GNUNET_CORE_TransmitHandle *
 858 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
 859                                    unsigned int priority,
 860                                    struct GNUNET_TIME_Relative maxdelay,
 861                                    const struct GNUNET_PeerIdentity *target,
 862                                    size_t notify_size,
 863                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
 864                                    void *notify_cls)
 865 {
 866   struct GNUNET_CORE_TransmitHandle *th;
 867
 868   GNUNET_assert (notify_size + sizeof (struct SendMessage) <
 869                  GNUNET_SERVER_MAX_MESSAGE_SIZE);
 870   th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle));
 871   th->ch = handle;
 872   GNUNET_CONTAINER_DLL_insert_after (handle->pending_head,
 873                                      handle->pending_tail,
 874                                      handle->pending_tail,
 875                                      th);
 876   th->get_message = &produce_send;
 877   th->get_message_cls = th;
 878   th->notify = notify;
 879   th->notify_cls = notify_cls;
 880   th->peer = *target;
 881   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
 882   th->timeout_task = GNUNET_SCHEDULER_add_delayed (handle->sched,
 883                                                    maxdelay,
 884                                                    &timeout_request, th);
 885   th->priority = priority;
 886   th->msize = sizeof (struct SendMessage) + notify_size;
 887   /* was the request queue previously empty? */
 888   if ( (handle->pending_head == th) &&
 889        (handle->cth == NULL) )
 890     trigger_next_request (handle);
 891   return th;
 892 }
 893
 894
 895 /**
 896  * Cancel the specified transmission-ready notification.
 897  *
 898  * @param th handle that was returned by "notify_transmit_ready".
 899  */
 900 void
 901 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
 902                                           *th)
 903 {
 904   struct GNUNET_CORE_Handle *h = th->ch;
 905
 906   if (h->submitted == th)
 907     h->submitted = NULL;
 908   else
 909     GNUNET_CONTAINER_DLL_remove (h->pending_head,
 910                                  h->pending_tail,
 911                                  th);
 912   if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
 913     GNUNET_SCHEDULER_cancel (h->sched, th->timeout_task);
 914   GNUNET_free (th);
 915 }
 916
 917
 918 /* end of core_api.c */