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 from peer `%4s'\n",
 434                   ntohs (em->type), GNUNET_i2s (&ntm->peer));
 435 #endif
 436       if ((GNUNET_NO == h->inbound_hdr_only) &&
 437           (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
 438         {
 439           GNUNET_break (0);
 440           break;
 441         }
 442       et = ntohs (em->type);
 443       for (hpos = 0; hpos < h->hcnt; hpos++)
 444         {
 445           mh = &h->handlers[hpos];
 446           if (mh->type != et)
 447             continue;
 448           if ((mh->expected_size != ntohs (em->size)) &&
 449               (mh->expected_size != 0))
 450             {
 451               GNUNET_break (0);
 452               continue;
 453             }
 454           if (GNUNET_OK !=
 455               h->handlers[hpos].callback (h->cls, &ntm->peer, em,
 456                                           GNUNET_TIME_relative_ntoh (ntm->latency),
 457                                           ntohl (ntm->distance)))
 458             {
 459               /* error in processing, disconnect ! */
 460               reconnect (h);
 461               return;
 462             }
 463         }
 464       if (NULL != h->inbound_notify)
 465         h->inbound_notify (h->cls, &ntm->peer, em,
 466                            GNUNET_TIME_relative_ntoh (ntm->latency),
 467                            ntohl (ntm->distance));
 468       break;
 469     case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND:
 470       if (msize <
 471           sizeof (struct NotifyTrafficMessage) +
 472           sizeof (struct GNUNET_MessageHeader))
 473         {
 474           GNUNET_break (0);
 475           break;
 476         }
 477       ntm = (const struct NotifyTrafficMessage *) msg;
 478       em = (const struct GNUNET_MessageHeader *) &ntm[1];
 479       if ((GNUNET_NO == h->outbound_hdr_only) &&
 480           (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
 481         {
 482           GNUNET_break (0);
 483           break;
 484         }
 485       if (NULL == h->outbound_notify)
 486         {
 487           GNUNET_break (0);
 488           break;
 489         }
 490       h->outbound_notify (h->cls, &ntm->peer, em,
 491                           GNUNET_TIME_relative_ntoh (ntm->latency),
 492                           ntohl (ntm->distance));
 493       break;
 494     default:
 495       GNUNET_break (0);
 496       break;
 497     }
 498   GNUNET_CLIENT_receive (h->client_notifications,
 499                          &main_notify_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
 500 }
 501
 502
 503 /**
 504  * Function called when we are ready to transmit our
 505  * "START" message (or when this operation timed out).
 506  *
 507  * @param cls closure
 508  * @param size number of bytes available in buf
 509  * @param buf where the callee should write the message
 510  * @return number of bytes written to buf
 511  */
 512 static size_t transmit_start (void *cls, size_t size, void *buf);
 513
 514
 515 /**
 516  * Function called on the first message received from
 517  * the service (contains our public key, etc.).
 518  * Should trigger calling the init callback
 519  * and then start our regular message processing.
 520  *
 521  * @param cls closure
 522  * @param msg message received, NULL on timeout or fatal error
 523  */
 524 static void
 525 init_reply_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 526 {
 527   struct GNUNET_CORE_Handle *h = cls;
 528   const struct InitReplyMessage *m;
 529   GNUNET_CORE_StartupCallback init;
 530   struct GNUNET_PeerIdentity my_identity;
 531
 532   if ((msg == NULL) ||
 533       (ntohs (msg->size) != sizeof (struct InitReplyMessage)) ||
 534       (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY))
 535     {
 536       if (msg != NULL)
 537         {
 538           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 539                       _
 540                       ("Error connecting to core service (failed to receive `%s' message, got message of type %u and size %u).\n"),
 541                       "INIT_REPLY",
 542                       ntohs (msg->type),
 543                       ntohs (msg->size));
 544           GNUNET_break (0);
 545         }
 546       else
 547         {
 548 #if DEBUG_CORE
 549           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 550                       _("Failed to connect to core service, will retry.\n"));
 551 #endif
 552         }
 553       transmit_start (h, 0, NULL);
 554       return;
 555     }
 556   m = (const struct InitReplyMessage *) msg;
 557   /* start our message processing loop */
 558 #if DEBUG_CORE
 559   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 560               "Successfully connected to core service, starting processing loop.\n");
 561 #endif
 562   h->currently_down = GNUNET_NO;
 563   trigger_next_request (h);
 564   GNUNET_CLIENT_receive (h->client_notifications,
 565                          &main_notify_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
 566   if (NULL != (init = h->init))
 567     {
 568       /* mark so we don't call init on reconnect */
 569       h->init = NULL;
 570       GNUNET_CRYPTO_hash (&m->publicKey,
 571                           sizeof (struct
 572                                   GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
 573                           &my_identity.hashPubKey);
 574       init (h->cls, h, &my_identity, &m->publicKey);
 575     }
 576 }
 577
 578
 579 static void
 580 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 581 {
 582   struct GNUNET_CORE_Handle *h = cls;
 583   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 584   reconnect (h);
 585 }
 586
 587
 588 /**
 589  * Function called when we are ready to transmit our
 590  * "START" message (or when this operation timed out).
 591  *
 592  * @param cls closure
 593  * @param size number of bytes available in buf
 594  * @param buf where the callee should write the message
 595  * @return number of bytes written to buf
 596  */
 597 static size_t
 598 transmit_start (void *cls, size_t size, void *buf)
 599 {
 600   struct GNUNET_CORE_Handle *h = cls;
 601   struct InitMessage *init;
 602   uint16_t *ts;
 603   uint16_t msize;
 604   uint32_t opt;
 605   unsigned int hpos;
 606   struct GNUNET_TIME_Relative delay;
 607
 608   h->cth = NULL;
 609   if (size == 0)
 610     {
 611       if ((h->init == NULL) ||
 612           (GNUNET_TIME_absolute_get ().value < h->startup_timeout.value))
 613         {
 614           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 615                       _("Failed to connect to core service, retrying.\n"));
 616           delay = GNUNET_TIME_absolute_get_remaining (h->startup_timeout);
 617           if ((h->init == NULL) || (delay.value > 1000))
 618             delay = GNUNET_TIME_UNIT_SECONDS;
 619           if (h->init == NULL)
 620             h->startup_timeout =
 621               GNUNET_TIME_relative_to_absolute (GNUNET_TIME_UNIT_MINUTES);
 622           h->reconnect_task =
 623             GNUNET_SCHEDULER_add_delayed (h->sched,
 624                                           delay, &reconnect_task, h);
 625           return 0;
 626         }
 627       /* timeout on initial connect */
 628       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 629                   _("Failed to connect to core service, giving up.\n"));
 630       h->init (h->cls, NULL, NULL, NULL);
 631       GNUNET_CORE_disconnect (h);
 632       return 0;
 633     }
 634   msize = h->hcnt * sizeof (uint16_t) + sizeof (struct InitMessage);
 635   GNUNET_assert (size >= msize);
 636   init = buf;
 637   init->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT);
 638   init->header.size = htons (msize);
 639   opt = GNUNET_CORE_OPTION_NOTHING;
 640   if (h->connects != NULL)
 641     opt |= GNUNET_CORE_OPTION_SEND_CONNECT;
 642   if (h->disconnects != NULL)
 643     opt |= GNUNET_CORE_OPTION_SEND_DISCONNECT;
 644   if (h->inbound_notify != NULL)
 645     {
 646       if (h->inbound_hdr_only)
 647         opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
 648       else
 649         opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
 650     }
 651   if (h->outbound_notify != NULL)
 652     {
 653       if (h->outbound_hdr_only)
 654         opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
 655       else
 656         opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
 657     }
 658   init->options = htonl (opt);
 659   ts = (uint16_t *) & init[1];
 660   for (hpos = 0; hpos < h->hcnt; hpos++)
 661     ts[hpos] = htons (h->handlers[hpos].type);
 662   GNUNET_CLIENT_receive (h->client_notifications,
 663                          &init_reply_handler,
 664                          h,
 665                          GNUNET_TIME_absolute_get_remaining
 666                          (h->startup_timeout));
 667   return sizeof (struct InitMessage) + h->hcnt * sizeof (uint16_t);
 668 }
 669
 670
 671 /**
 672  * Connect to the core service.  Note that the connection may
 673  * complete (or fail) asynchronously.
 674  *
 675  * @param sched scheduler to use
 676  * @param cfg configuration to use
 677  * @param timeout after how long should we give up trying to connect to the core service?
 678  * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
 679  * @param init callback to call on timeout or once we have successfully
 680  *        connected to the core service; note that timeout is only meaningful if init is not NULL
 681  * @param connects function to call on peer connect, can be NULL
 682  * @param disconnects function to call on peer disconnect / timeout, can be NULL
 683  * @param inbound_notify function to call for all inbound messages, can be NULL
 684  * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
 685  *                GNUNET_MessageHeader and hence we do not need to give it the full message;
 686  *                can be used to improve efficiency, ignored if inbound_notify is NULLL
 687  * @param outbound_notify function to call for all outbound messages, can be NULL
 688  * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
 689  *                GNUNET_MessageHeader and hence we do not need to give it the full message
 690  *                can be used to improve efficiency, ignored if outbound_notify is NULLL
 691  * @param handlers callbacks for messages we care about, NULL-terminated
 692  * @return handle to the core service (only useful for disconnect until 'init' is called);
 693  *                NULL on error (in this case, init is never called)
 694  */
 695 struct GNUNET_CORE_Handle *
 696 GNUNET_CORE_connect (struct GNUNET_SCHEDULER_Handle *sched,
 697                      const struct GNUNET_CONFIGURATION_Handle *cfg,
 698                      struct GNUNET_TIME_Relative timeout,
 699                      void *cls,
 700                      GNUNET_CORE_StartupCallback init,
 701                      GNUNET_CORE_ConnectEventHandler connects,
 702                      GNUNET_CORE_DisconnectEventHandler disconnects,
 703                      GNUNET_CORE_MessageCallback inbound_notify,
 704                      int inbound_hdr_only,
 705                      GNUNET_CORE_MessageCallback outbound_notify,
 706                      int outbound_hdr_only,
 707                      const struct GNUNET_CORE_MessageHandler *handlers)
 708 {
 709   struct GNUNET_CORE_Handle *h;
 710
 711   h = GNUNET_malloc (sizeof (struct GNUNET_CORE_Handle));
 712   h->sched = sched;
 713   h->cfg = cfg;
 714   h->cls = cls;
 715   h->init = init;
 716   h->connects = connects;
 717   h->disconnects = disconnects;
 718   h->inbound_notify = inbound_notify;
 719   h->outbound_notify = outbound_notify;
 720   h->inbound_hdr_only = inbound_hdr_only;
 721   h->outbound_hdr_only = outbound_hdr_only;
 722   h->handlers = handlers;
 723   h->client_notifications = GNUNET_CLIENT_connect (sched, "core", cfg);
 724   if (h->client_notifications == NULL)
 725     {
 726       GNUNET_free (h);
 727       return NULL;
 728     }
 729   h->startup_timeout = GNUNET_TIME_relative_to_absolute (timeout);
 730   h->hcnt = 0;
 731   while (handlers[h->hcnt].callback != NULL)
 732     h->hcnt++;
 733   GNUNET_assert (h->hcnt <
 734                  (GNUNET_SERVER_MAX_MESSAGE_SIZE -
 735                   sizeof (struct InitMessage)) / sizeof (uint16_t));
 736 #if DEBUG_CORE
 737   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 738               "Trying to connect to core service in next %llu ms.\n",
 739               timeout.value);
 740 #endif
 741   h->cth =
 742     GNUNET_CLIENT_notify_transmit_ready (h->client_notifications,
 743                                          sizeof (struct InitMessage) +
 744                                          sizeof (uint16_t) * h->hcnt, timeout,
 745                                          GNUNET_YES,
 746                                          &transmit_start, h);
 747   return h;
 748 }
 749
 750
 751 /**
 752  * Disconnect from the core service.
 753  *
 754  * @param handle connection to core to disconnect
 755  */
 756 void
 757 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
 758 {
 759   if (handle->cth != NULL)
 760     GNUNET_CLIENT_notify_transmit_ready_cancel (handle->cth);
 761   if (handle->solicit_transmit_req != NULL)
 762     GNUNET_CORE_notify_transmit_ready_cancel (handle->solicit_transmit_req);
 763   if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
 764     GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
 765   if (handle->client_notifications != NULL)
 766     GNUNET_CLIENT_disconnect (handle->client_notifications, GNUNET_NO);
 767   GNUNET_free_non_null (handle->solicit_buffer);
 768   GNUNET_free (handle);
 769 }
 770
 771
 772 /**
 773  * Build the message requesting data transmission.
 774  */
 775 static size_t
 776 produce_send (void *cls, size_t size, void *buf)
 777 {
 778   struct GNUNET_CORE_TransmitHandle *th = cls;
 779   struct GNUNET_CORE_Handle *h;
 780   struct SendMessage *sm;
 781   size_t dt;
 782   GNUNET_CONNECTION_TransmitReadyNotify notify;
 783   void *notify_cls;
 784
 785   h = th->ch;
 786   if (buf == NULL)
 787     {
 788       /* timeout or error */
 789 #if DEBUG_CORE
 790       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 791                   "P2P transmission request for `%4s' timed out.\n",
 792                   GNUNET_i2s(&th->peer));
 793 #endif
 794       GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
 795       GNUNET_CORE_notify_transmit_ready_cancel (th);
 796       trigger_next_request (h);
 797       return 0;
 798     }
 799 #if DEBUG_CORE
 800   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 801               "Preparing for P2P transmission to `%4s'.\n",
 802               GNUNET_i2s(&th->peer));
 803 #endif
 804   sm = (struct SendMessage *) buf;
 805   sm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND);
 806   sm->priority = htonl (th->priority);
 807   sm->deadline = GNUNET_TIME_absolute_hton (th->timeout);
 808   sm->peer = th->peer;
 809   notify = th->notify;
 810   notify_cls = th->notify_cls;
 811   GNUNET_CORE_notify_transmit_ready_cancel (th);
 812   trigger_next_request (h);
 813   GNUNET_assert (size >= sizeof (struct SendMessage));
 814   dt = notify (notify_cls, size - sizeof (struct SendMessage), &sm[1]);
 815   if (0 == dt)
 816     {
 817 #if DEBUG_CORE
 818   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 819               "Size of clients message to peer %s is 0!\n",
 820               GNUNET_i2s(&th->peer));
 821 #endif
 822       /* client decided to send nothing! */
 823       return 0;
 824     }
 825   GNUNET_assert (dt >= sizeof (struct GNUNET_MessageHeader));
 826   if (dt + sizeof (struct SendMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 827     {
 828       GNUNET_break (0);
 829       return 0;
 830     }
 831   sm->header.size = htons (dt + sizeof (struct SendMessage));
 832   GNUNET_assert (dt + sizeof (struct SendMessage) <= size);
 833   return dt + sizeof (struct SendMessage);
 834 }
 835
 836
 837 /**
 838  * Ask the core to call "notify" once it is ready to transmit the
 839  * given number of bytes to the specified "target".  If we are not yet
 840  * connected to the specified peer, a call to this function will cause
 841  * us to try to establish a connection.
 842  *
 843  * @param handle connection to core service
 844  * @param priority how important is the message?
 845  * @param maxdelay how long can the message wait?
 846  * @param target who should receive the message,
 847  *        use NULL for this peer (loopback)
 848  * @param notify_size how many bytes of buffer space does notify want?
 849  * @param notify function to call when buffer space is available
 850  * @param notify_cls closure for notify
 851  * @return non-NULL if the notify callback was queued,
 852  *         NULL if we can not even queue the request (insufficient
 853  *         memory); if NULL is returned, "notify" will NOT be called.
 854  */
 855 struct GNUNET_CORE_TransmitHandle *
 856 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
 857                                    unsigned int priority,
 858                                    struct GNUNET_TIME_Relative maxdelay,
 859                                    const struct GNUNET_PeerIdentity *target,
 860                                    size_t notify_size,
 861                                    GNUNET_CONNECTION_TransmitReadyNotify notify,
 862                                    void *notify_cls)
 863 {
 864   struct GNUNET_CORE_TransmitHandle *th;
 865
 866   GNUNET_assert (notify_size + sizeof (struct SendMessage) <
 867                  GNUNET_SERVER_MAX_MESSAGE_SIZE);
 868   th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle));
 869   th->ch = handle;
 870   GNUNET_CONTAINER_DLL_insert_after (handle->pending_head,
 871                                      handle->pending_tail,
 872                                      handle->pending_tail,
 873                                      th);
 874   th->get_message = &produce_send;
 875   th->get_message_cls = th;
 876   th->notify = notify;
 877   th->notify_cls = notify_cls;
 878   th->peer = *target;
 879   th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
 880   th->timeout_task = GNUNET_SCHEDULER_add_delayed (handle->sched,
 881                                                    maxdelay,
 882                                                    &timeout_request, th);
 883   th->priority = priority;
 884   th->msize = sizeof (struct SendMessage) + notify_size;
 885   /* was the request queue previously empty? */
 886   if ( (handle->pending_head == th) &&
 887        (handle->cth == NULL) )
 888     trigger_next_request (handle);
 889   return th;
 890 }
 891
 892
 893 /**
 894  * Cancel the specified transmission-ready notification.
 895  *
 896  * @param th handle that was returned by "notify_transmit_ready".
 897  */
 898 void
 899 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
 900                                           *th)
 901 {
 902   struct GNUNET_CORE_Handle *h = th->ch;
 903
 904   if (h->submitted == th)
 905     h->submitted = NULL;
 906   else
 907     GNUNET_CONTAINER_DLL_remove (h->pending_head,
 908                                  h->pending_tail,
 909                                  th);
 910   if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
 911     GNUNET_SCHEDULER_cancel (h->sched, th->timeout_task);
 912   GNUNET_free (th);
 913 }
 914
 915
 916 /* end of core_api.c */