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