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