src/cadet/cadet_api.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011, 2017 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18 /**
  19  * @file cadet/cadet_api.c
  20  * @brief cadet api: client implementation of cadet service
  21  * @author Bartlomiej Polot
  22  * @author Christian Grothoff
  23  */
  24 #include "platform.h"
  25 #include "gnunet_util_lib.h"
  26 #include "gnunet_constants.h"
  27 #include "gnunet_cadet_service.h"
  28 #include "cadet.h"
  29 #include "cadet_protocol.h"
  30
  31 #define LOG(kind,...) GNUNET_log_from (kind, "cadet-api",__VA_ARGS__)
  32
  33 /**
  34  * Ugly legacy hack.
  35  */
  36 union CadetInfoCB
  37 {
  38
  39   /**
  40    * Channel callback.
  41    */
  42   GNUNET_CADET_ChannelCB channel_cb;
  43
  44   /**
  45    * Monitor callback
  46    */
  47   GNUNET_CADET_PeersCB peers_cb;
  48
  49   /**
  50    * Monitor callback
  51    */
  52   GNUNET_CADET_PeerCB peer_cb;
  53
  54   /**
  55    * Monitor callback
  56    */
  57   GNUNET_CADET_TunnelsCB tunnels_cb;
  58
  59   /**
  60    * Tunnel callback.
  61    */
  62   GNUNET_CADET_TunnelCB tunnel_cb;
  63 };
  64
  65
  66 /**
  67  * Opaque handle to the service.
  68  */
  69 struct GNUNET_CADET_Handle
  70 {
  71   /**
  72    * Message queue.
  73    */
  74   struct GNUNET_MQ_Handle *mq;
  75
  76   /**
  77    * Ports open.
  78    */
  79   struct GNUNET_CONTAINER_MultiHashMap *ports;
  80
  81   /**
  82    * Channels open.
  83    */
  84   struct GNUNET_CONTAINER_MultiHashMap32 *channels;
  85
  86   /**
  87    * child of the next channel to create (to avoid reusing IDs often)
  88    */
  89   struct GNUNET_CADET_ClientChannelNumber next_ccn;
  90
  91   /**
  92    * Configuration given by the client, in case of reconnection
  93    */
  94   const struct GNUNET_CONFIGURATION_Handle *cfg;
  95
  96   /**
  97    * Task for trying to reconnect.
  98    */
  99   struct GNUNET_SCHEDULER_Task *reconnect_task;
 100
 101   /**
 102    * Callback for an info task (only one active at a time).
 103    */
 104   union CadetInfoCB info_cb;
 105
 106   /**
 107    * Info callback closure for @c info_cb.
 108    */
 109   void *info_cls;
 110
 111   /**
 112    * Time to the next reconnect in case one reconnect fails
 113    */
 114   struct GNUNET_TIME_Relative reconnect_time;
 115
 116 };
 117
 118
 119 /**
 120  * Opaque handle to a channel.
 121  */
 122 struct GNUNET_CADET_Channel
 123 {
 124
 125   /**
 126    * Other end of the channel.
 127    */
 128   struct GNUNET_PeerIdentity peer;
 129
 130   /**
 131    * Handle to the cadet this channel belongs to
 132    */
 133   struct GNUNET_CADET_Handle *cadet;
 134
 135   /**
 136    * Channel's port, if incoming.
 137    */
 138   struct GNUNET_CADET_Port *incoming_port;
 139
 140   /**
 141    * Any data the caller wants to put in here, used for the
 142    * various callbacks (@e disconnects, @e window_changes, handlers).
 143    */
 144   void *ctx;
 145
 146   /**
 147    * Message Queue for the channel (which we are implementing).
 148    */
 149   struct GNUNET_MQ_Handle *mq;
 150
 151   /**
 152    * Task to allow mq to send more traffic.
 153    */
 154   struct GNUNET_SCHEDULER_Task *mq_cont;
 155
 156   /**
 157    * Pending envelope with a message to be transmitted to the
 158    * service as soon as we are allowed to.  Should only be
 159    * non-NULL if @e allow_send is 0.
 160    */
 161   struct GNUNET_MQ_Envelope *pending_env;
 162
 163   /**
 164    * Window change handler.
 165    */
 166   GNUNET_CADET_WindowSizeEventHandler window_changes;
 167
 168   /**
 169    * Disconnect handler.
 170    */
 171   GNUNET_CADET_DisconnectEventHandler disconnects;
 172
 173   /**
 174    * Local ID of the channel, #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI bit is set if outbound.
 175    */
 176   struct GNUNET_CADET_ClientChannelNumber ccn;
 177
 178   /**
 179    * Channel options: reliability, etc.
 180    */
 181   enum GNUNET_CADET_ChannelOption options;
 182
 183   /**
 184    * How many messages are we allowed to send to the service right now?
 185    */
 186   unsigned int allow_send;
 187
 188 };
 189
 190
 191 /**
 192  * Opaque handle to a port.
 193  */
 194 struct GNUNET_CADET_Port
 195 {
 196
 197   /**
 198    * Port "number"
 199    */
 200   struct GNUNET_HashCode id;
 201
 202   /**
 203    * Handle to the CADET session this port belongs to.
 204    */
 205   struct GNUNET_CADET_Handle *cadet;
 206
 207   /**
 208    * Closure for @a handler.
 209    */
 210   void *cls;
 211
 212   /**
 213    * Handler for incoming channels on this port
 214    */
 215   GNUNET_CADET_ConnectEventHandler connects;
 216
 217   /**
 218    * Closure for @ref connects
 219    */
 220   void *connects_cls;
 221
 222   /**
 223    * Window size change handler.
 224    */
 225   GNUNET_CADET_WindowSizeEventHandler window_changes;
 226
 227   /**
 228    * Handler called when an incoming channel is destroyed.
 229    */
 230   GNUNET_CADET_DisconnectEventHandler disconnects;
 231
 232   /**
 233    * Payload handlers for incoming channels.
 234    */
 235   struct GNUNET_MQ_MessageHandler *handlers;
 236 };
 237
 238
 239 /**
 240  * Find the Port struct for a hash.
 241  *
 242  * @param h CADET handle.
 243  * @param hash HashCode for the port number.
 244  * @return The port handle if known, NULL otherwise.
 245  */
 246 static struct GNUNET_CADET_Port *
 247 find_port (const struct GNUNET_CADET_Handle *h,
 248            const struct GNUNET_HashCode *hash)
 249 {
 250   return GNUNET_CONTAINER_multihashmap_get (h->ports,
 251                                             hash);
 252 }
 253
 254
 255 /**
 256  * Get the channel handler for the channel specified by id from the given handle
 257  *
 258  * @param h Cadet handle
 259  * @param ccn ID of the wanted channel
 260  * @return handle to the required channel or NULL if not found
 261  */
 262 static struct GNUNET_CADET_Channel *
 263 find_channel (struct GNUNET_CADET_Handle *h,
 264               struct GNUNET_CADET_ClientChannelNumber ccn)
 265 {
 266   return GNUNET_CONTAINER_multihashmap32_get (h->channels,
 267                                               ntohl (ccn.channel_of_client));
 268 }
 269
 270
 271 /**
 272  * Create a new channel and insert it in the channel list of the cadet handle
 273  *
 274  * @param h Cadet handle
 275  * @param ccnp pointer to desired ccn of the channel, NULL to assign one automatically.
 276  * @return Handle to the created channel.
 277  */
 278 static struct GNUNET_CADET_Channel *
 279 create_channel (struct GNUNET_CADET_Handle *h,
 280                 const struct GNUNET_CADET_ClientChannelNumber *ccnp)
 281 {
 282   struct GNUNET_CADET_Channel *ch;
 283   struct GNUNET_CADET_ClientChannelNumber ccn;
 284
 285   ch = GNUNET_new (struct GNUNET_CADET_Channel);
 286   ch->cadet = h;
 287   if (NULL == ccnp)
 288   {
 289     while (NULL !=
 290            find_channel (h,
 291                          h->next_ccn))
 292       h->next_ccn.channel_of_client
 293         = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI | (1 + ntohl (h->next_ccn.channel_of_client)));
 294     ccn = h->next_ccn;
 295   }
 296   else
 297   {
 298     ccn = *ccnp;
 299   }
 300   ch->ccn = ccn;
 301   GNUNET_assert (GNUNET_OK ==
 302                  GNUNET_CONTAINER_multihashmap32_put (h->channels,
 303                                                       ntohl (ch->ccn.channel_of_client),
 304                                                       ch,
 305                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 306   return ch;
 307 }
 308
 309
 310 /**
 311  * Destroy the specified channel.
 312  * - Destroys all peers, calling the disconnect callback on each if needed
 313  * - Cancels all outgoing traffic for that channel, calling respective notifys
 314  * - Calls cleaner if channel was inbound
 315  * - Frees all memory used
 316  *
 317  * @param ch Pointer to the channel.
 318  * @param call_cleaner Whether to call the cleaner handler.
 319  */
 320 static void
 321 destroy_channel (struct GNUNET_CADET_Channel *ch)
 322 {
 323   struct GNUNET_CADET_Handle *h = ch->cadet;
 324
 325   LOG (GNUNET_ERROR_TYPE_DEBUG,
 326        "Destroying channel %X of %p\n",
 327        htonl (ch->ccn.channel_of_client),
 328        h);
 329   GNUNET_assert (GNUNET_YES ==
 330                  GNUNET_CONTAINER_multihashmap32_remove (h->channels,
 331                                                          ntohl (ch->ccn.channel_of_client),
 332                                                          ch));
 333   if (NULL != ch->mq_cont)
 334   {
 335     GNUNET_SCHEDULER_cancel (ch->mq_cont);
 336     ch->mq_cont = NULL;
 337   }
 338   /* signal channel destruction */
 339   if (NULL != ch->disconnects)
 340     ch->disconnects (ch->ctx,
 341                      ch);
 342   if (NULL != ch->pending_env)
 343     GNUNET_MQ_discard (ch->pending_env);
 344   GNUNET_MQ_destroy (ch->mq);
 345   GNUNET_free (ch);
 346 }
 347
 348
 349 /**
 350  * Reconnect to the service, retransmit all infomation to try to restore the
 351  * original state.
 352  *
 353  * @param h handle to the cadet
 354  */
 355 static void
 356 reconnect (struct GNUNET_CADET_Handle *h);
 357
 358
 359 /**
 360  * Function called during #reconnect_cbk() to (re)open
 361  * all ports that are still open.
 362  *
 363  * @param cls the `struct GNUNET_CADET_Handle`
 364  * @param id port ID
 365  * @param value a `struct GNUNET_CADET_Channel` to open
 366  * @return #GNUNET_OK (continue to iterate)
 367  */
 368 static int
 369 open_port_cb (void *cls,
 370               const struct GNUNET_HashCode *id,
 371               void *value)
 372 {
 373   struct GNUNET_CADET_Handle *h = cls;
 374   struct GNUNET_CADET_Port *port = value;
 375   struct GNUNET_CADET_PortMessage *msg;
 376   struct GNUNET_MQ_Envelope *env;
 377
 378   (void) id;
 379   env = GNUNET_MQ_msg (msg,
 380                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN);
 381   msg->port = port->id;
 382   GNUNET_MQ_send (h->mq,
 383                   env);
 384   return GNUNET_OK;
 385 }
 386
 387
 388 /**
 389  * Reconnect callback: tries to reconnect again after a failer previous
 390  * reconnecttion
 391  *
 392  * @param cls closure (cadet handle)
 393  */
 394 static void
 395 reconnect_cbk (void *cls)
 396 {
 397   struct GNUNET_CADET_Handle *h = cls;
 398
 399   h->reconnect_task = NULL;
 400   h->reconnect_time
 401     = GNUNET_TIME_STD_BACKOFF (h->reconnect_time);
 402   reconnect (h);
 403   GNUNET_CONTAINER_multihashmap_iterate (h->ports,
 404                                          &open_port_cb,
 405                                          h);
 406 }
 407
 408
 409 /**
 410  * Notify the application about a change in the window size (if needed).
 411  *
 412  * @param ch Channel to notify about.
 413  */
 414 static void
 415 notify_window_size (struct GNUNET_CADET_Channel *ch)
 416 {
 417   if (NULL != ch->window_changes)
 418     ch->window_changes (ch->ctx,
 419                         ch, /* FIXME: remove 'ch'? */
 420                         ch->allow_send);
 421 }
 422
 423
 424 /**
 425  * Transmit the next message from our queue.
 426  *
 427  * @param cls Closure (channel whose mq to activate).
 428  */
 429 static void
 430 cadet_mq_send_now (void *cls)
 431 {
 432   struct GNUNET_CADET_Channel *ch = cls;
 433   struct GNUNET_MQ_Envelope *env = ch->pending_env;
 434
 435   ch->mq_cont = NULL;
 436   if (0 == ch->allow_send)
 437   {
 438     /* how did we get here? */
 439     GNUNET_break (0);
 440     return;
 441   }
 442   if (NULL == env)
 443   {
 444     /* how did we get here? */
 445     GNUNET_break (0);
 446     return;
 447   }
 448   ch->allow_send--;
 449   ch->pending_env = NULL;
 450   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 451               "Sending message on channel %s to CADET, new window size is %u\n",
 452               GNUNET_i2s (&ch->peer),
 453               ch->allow_send);
 454   GNUNET_MQ_send (ch->cadet->mq,
 455                   env);
 456   GNUNET_MQ_impl_send_continue (ch->mq);
 457 }
 458
 459
 460 /**
 461  * Implement sending functionality of a message queue for
 462  * us sending messages to a peer.
 463  *
 464  * Encapsulates the payload message in a #GNUNET_CADET_LocalData message
 465  * in order to label the message with the channel ID and send the
 466  * encapsulated message to the service.
 467  *
 468  * @param mq the message queue
 469  * @param msg the message to send
 470  * @param impl_state state of the implementation
 471  */
 472 static void
 473 cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq,
 474                     const struct GNUNET_MessageHeader *msg,
 475                     void *impl_state)
 476 {
 477   struct GNUNET_CADET_Channel *ch = impl_state;
 478   struct GNUNET_CADET_Handle *h = ch->cadet;
 479   uint16_t msize;
 480   struct GNUNET_MQ_Envelope *env;
 481   struct GNUNET_CADET_LocalData *cadet_msg = NULL;
 482
 483   if (NULL == h->mq)
 484   {
 485     /* We're currently reconnecting, pretend this worked */
 486     GNUNET_MQ_impl_send_continue (mq);
 487     return;
 488   }
 489
 490   /* check message size for sanity */
 491   msize = ntohs (msg->size);
 492   if (msize > GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE)
 493   {
 494     GNUNET_break (0);
 495     GNUNET_MQ_impl_send_continue (mq);
 496     return;
 497   }
 498   env = GNUNET_MQ_msg_nested_mh (cadet_msg,
 499                                  GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
 500                                  msg);
 501   cadet_msg->ccn = ch->ccn;
 502   GNUNET_assert (NULL == ch->pending_env);
 503   ch->pending_env = env;
 504   if (0 < ch->allow_send)
 505     ch->mq_cont
 506       = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
 507                                   ch);
 508 }
 509
 510
 511 /**
 512  * Handle destruction of a message queue.  Implementations must not
 513  * free @a mq, but should take care of @a impl_state.
 514  *
 515  * @param mq the message queue to destroy
 516  * @param impl_state state of the implementation
 517  */
 518 static void
 519 cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq,
 520                        void *impl_state)
 521 {
 522   struct GNUNET_CADET_Channel *ch = impl_state;
 523
 524   GNUNET_assert (mq == ch->mq);
 525   ch->mq = NULL;
 526 }
 527
 528
 529 /**
 530  * We had an error processing a message we forwarded from a peer to
 531  * the CADET service.  We should just complain about it but otherwise
 532  * continue processing.
 533  *
 534  * @param cls closure with our `struct GNUNET_CADET_Channel`
 535  * @param error error code
 536  */
 537 static void
 538 cadet_mq_error_handler (void *cls,
 539                         enum GNUNET_MQ_Error error)
 540 {
 541   struct GNUNET_CADET_Channel *ch = cls;
 542
 543   if (GNUNET_MQ_ERROR_NO_MATCH == error)
 544   {
 545     /* Got a message we did not understand, still try to continue! */
 546     GNUNET_break_op (0);
 547     GNUNET_CADET_receive_done (ch);
 548   }
 549   else
 550   {
 551     GNUNET_break (0);
 552     GNUNET_CADET_channel_destroy (ch);
 553   }
 554 }
 555
 556
 557 /**
 558  * Implementation function that cancels the currently sent message.
 559  * Should basically undo whatever #mq_send_impl() did.
 560  *
 561  * @param mq message queue
 562  * @param impl_state state specific to the implementation
 563  */
 564 static void
 565 cadet_mq_cancel_impl (struct GNUNET_MQ_Handle *mq,
 566                      void *impl_state)
 567 {
 568   struct GNUNET_CADET_Channel *ch = impl_state;
 569
 570   (void) mq;
 571   GNUNET_assert (NULL != ch->pending_env);
 572   GNUNET_MQ_discard (ch->pending_env);
 573   ch->pending_env = NULL;
 574   if (NULL != ch->mq_cont)
 575   {
 576     GNUNET_SCHEDULER_cancel (ch->mq_cont);
 577     ch->mq_cont = NULL;
 578   }
 579 }
 580
 581
 582 /**
 583  * Process the new channel notification and add it to the channels in the handle
 584  *
 585  * @param h     The cadet handle
 586  * @param msg   A message with the details of the new incoming channel
 587  */
 588 static void
 589 handle_channel_created (void *cls,
 590                         const struct GNUNET_CADET_LocalChannelCreateMessage *msg)
 591 {
 592   struct GNUNET_CADET_Handle *h = cls;
 593   struct GNUNET_CADET_Channel *ch;
 594   struct GNUNET_CADET_Port *port;
 595   const struct GNUNET_HashCode *port_number;
 596   struct GNUNET_CADET_ClientChannelNumber ccn;
 597
 598   ccn = msg->ccn;
 599   port_number = &msg->port;
 600   if (ntohl (ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
 601   {
 602     GNUNET_break (0);
 603     return;
 604   }
 605   port = find_port (h,
 606                     port_number);
 607   if (NULL == port)
 608   {
 609     /* We could have closed the port but the service didn't know about it yet
 610      * This is not an error.
 611      */
 612     struct GNUNET_CADET_LocalChannelDestroyMessage *d_msg;
 613     struct GNUNET_MQ_Envelope *env;
 614
 615     LOG (GNUNET_ERROR_TYPE_DEBUG,
 616          "No handler for incoming channel %X (on port %s, recently closed?)\n",
 617          ntohl (ccn.channel_of_client),
 618          GNUNET_h2s (port_number));
 619     env = GNUNET_MQ_msg (d_msg,
 620                          GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
 621     d_msg->ccn = msg->ccn;
 622     GNUNET_MQ_send (h->mq,
 623                     env);
 624     return;
 625   }
 626
 627   ch = create_channel (h,
 628                        &ccn);
 629   ch->peer = msg->peer;
 630   ch->incoming_port = port;
 631   ch->options = ntohl (msg->opt);
 632   LOG (GNUNET_ERROR_TYPE_DEBUG,
 633        "Creating incoming channel %X [%s] %p\n",
 634        ntohl (ccn.channel_of_client),
 635        GNUNET_h2s (port_number),
 636        ch);
 637
 638   GNUNET_assert (NULL != port->connects);
 639   ch->window_changes = port->window_changes;
 640   ch->disconnects = port->disconnects;
 641   ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
 642                                           &cadet_mq_destroy_impl,
 643                                           &cadet_mq_cancel_impl,
 644                                           ch,
 645                                           port->handlers,
 646                                           &cadet_mq_error_handler,
 647                                           ch);
 648   ch->ctx = port->connects (port->cls,
 649                             ch,
 650                             &msg->peer);
 651   GNUNET_MQ_set_handlers_closure (ch->mq,
 652                                   ch->ctx);
 653 }
 654
 655
 656 /**
 657  * Process the channel destroy notification and free associated resources
 658  *
 659  * @param h     The cadet handle
 660  * @param msg   A message with the details of the channel being destroyed
 661  */
 662 static void
 663 handle_channel_destroy (void *cls,
 664                         const struct GNUNET_CADET_LocalChannelDestroyMessage *msg)
 665 {
 666   struct GNUNET_CADET_Handle *h = cls;
 667   struct GNUNET_CADET_Channel *ch;
 668
 669   ch = find_channel (h,
 670                      msg->ccn);
 671   if (NULL == ch)
 672   {
 673     LOG (GNUNET_ERROR_TYPE_DEBUG,
 674          "Received channel destroy for unknown channel %X from CADET service (recently close?)\n",
 675          ntohl (msg->ccn.channel_of_client));
 676     return;
 677   }
 678   LOG (GNUNET_ERROR_TYPE_DEBUG,
 679        "Received channel destroy for channel %X from CADET service\n",
 680        ntohl (msg->ccn.channel_of_client));
 681   destroy_channel (ch);
 682 }
 683
 684
 685 /**
 686  * Check that message received from CADET service is well-formed.
 687  *
 688  * @param cls the `struct GNUNET_CADET_Handle`
 689  * @param message the message we got
 690  * @return #GNUNET_OK if the message is well-formed,
 691  *         #GNUNET_SYSERR otherwise
 692  */
 693 static int
 694 check_local_data (void *cls,
 695                   const struct GNUNET_CADET_LocalData *message)
 696 {
 697   uint16_t size;
 698
 699   (void) cls;
 700   size = ntohs (message->header.size);
 701   if (sizeof (*message) + sizeof (struct GNUNET_MessageHeader) > size)
 702   {
 703     GNUNET_break (0);
 704     return GNUNET_SYSERR;
 705   }
 706   return GNUNET_OK;
 707 }
 708
 709
 710 /**
 711  * Process the incoming data packets, call appropriate handlers.
 712  *
 713  * @param h       The cadet handle
 714  * @param message A message encapsulating the data
 715  */
 716 static void
 717 handle_local_data (void *cls,
 718                    const struct GNUNET_CADET_LocalData *message)
 719 {
 720   struct GNUNET_CADET_Handle *h = cls;
 721   const struct GNUNET_MessageHeader *payload;
 722   struct GNUNET_CADET_Channel *ch;
 723   uint16_t type;
 724   int fwd;
 725
 726   ch = find_channel (h,
 727                      message->ccn);
 728   if (NULL == ch)
 729   {
 730     LOG (GNUNET_ERROR_TYPE_DEBUG,
 731          "Unknown channel %X for incoming data (recently closed?)\n",
 732          ntohl (message->ccn.channel_of_client));
 733     return;
 734   }
 735
 736   payload = (const struct GNUNET_MessageHeader *) &message[1];
 737   type = ntohs (payload->type);
 738   fwd = ntohl (ch->ccn.channel_of_client) <= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
 739   LOG (GNUNET_ERROR_TYPE_DEBUG,
 740        "Got a %s data on channel %s [%X] of type %u\n",
 741        fwd ? "FWD" : "BWD",
 742        GNUNET_i2s (&ch->peer),
 743        ntohl (message->ccn.channel_of_client),
 744        type);
 745   GNUNET_MQ_inject_message (ch->mq,
 746                             payload);
 747 }
 748
 749
 750 /**
 751  * Process a local ACK message, enabling the client to send
 752  * more data to the service.
 753  *
 754  * @param h Cadet handle.
 755  * @param message Message itself.
 756  */
 757 static void
 758 handle_local_ack (void *cls,
 759                   const struct GNUNET_CADET_LocalAck *message)
 760 {
 761   struct GNUNET_CADET_Handle *h = cls;
 762   struct GNUNET_CADET_Channel *ch;
 763
 764   ch = find_channel (h,
 765                      message->ccn);
 766   if (NULL == ch)
 767   {
 768     LOG (GNUNET_ERROR_TYPE_DEBUG,
 769          "ACK on unknown channel %X\n",
 770          ntohl (message->ccn.channel_of_client));
 771     return;
 772   }
 773   ch->allow_send++;
 774   LOG (GNUNET_ERROR_TYPE_DEBUG,
 775        "Got an ACK on mq channel %X (peer %s); new window size is %u!\n",
 776        ntohl (ch->ccn.channel_of_client),
 777        GNUNET_i2s (&ch->peer),
 778        ch->allow_send);
 779   if (NULL == ch->pending_env)
 780   {
 781     LOG (GNUNET_ERROR_TYPE_DEBUG,
 782          "Got an ACK on mq channel %X, allow send now %u!\n",
 783          ntohl (ch->ccn.channel_of_client),
 784          ch->allow_send);
 785     notify_window_size (ch);
 786     return;
 787   }
 788   if (NULL != ch->mq_cont)
 789     return; /* already working on it! */
 790   ch->mq_cont
 791     = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
 792                                 ch);
 793 }
 794
 795
 796 /**
 797  * Function called during #GNUNET_CADET_disconnect() to destroy
 798  * all channels that are still open.
 799  *
 800  * @param cls the `struct GNUNET_CADET_Handle`
 801  * @param cid chanenl ID
 802  * @param value a `struct GNUNET_CADET_Channel` to destroy
 803  * @return #GNUNET_OK (continue to iterate)
 804  */
 805 static int
 806 destroy_channel_cb (void *cls,
 807                     uint32_t cid,
 808                     void *value)
 809 {
 810   /* struct GNUNET_CADET_Handle *handle = cls; */
 811   struct GNUNET_CADET_Channel *ch = value;
 812
 813   (void) cls;
 814   (void) cid;
 815   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 816               "Destroying channel due to GNUNET_CADET_disconnect()\n");
 817   destroy_channel (ch);
 818   return GNUNET_OK;
 819 }
 820
 821
 822 /**
 823  * Generic error handler, called with the appropriate error code and
 824  * the same closure specified at the creation of the message queue.
 825  * Not every message queue implementation supports an error handler.
 826  *
 827  * @param cls closure, a `struct GNUNET_CORE_Handle *`
 828  * @param error error code
 829  */
 830 static void
 831 handle_mq_error (void *cls,
 832                  enum GNUNET_MQ_Error error)
 833 {
 834   struct GNUNET_CADET_Handle *h = cls;
 835
 836   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 837               "MQ ERROR: %u\n",
 838               error);
 839   GNUNET_CONTAINER_multihashmap32_iterate (h->channels,
 840                                            &destroy_channel_cb,
 841                                            h);
 842   GNUNET_MQ_destroy (h->mq);
 843   h->mq = NULL;
 844   GNUNET_assert (NULL == h->reconnect_task);
 845   h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
 846                                                     &reconnect_cbk,
 847                                                     h);
 848 }
 849
 850
 851 /**
 852  * Check that message received from CADET service is well-formed.
 853  *
 854  * @param cls the `struct GNUNET_CADET_Handle`
 855  * @param message the message we got
 856  * @return #GNUNET_OK if the message is well-formed,
 857  *         #GNUNET_SYSERR otherwise
 858  */
 859 static int
 860 check_get_peers (void *cls,
 861                  const struct GNUNET_MessageHeader *message)
 862 {
 863   size_t esize;
 864
 865   (void) cls;
 866   esize = ntohs (message->size);
 867   if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == esize)
 868     return GNUNET_OK;
 869   if (sizeof (struct GNUNET_MessageHeader) == esize)
 870     return GNUNET_OK;
 871   return GNUNET_SYSERR;
 872 }
 873
 874
 875 /**
 876  * Process a local reply about info on all tunnels, pass info to the user.
 877  *
 878  * @param cls Closure (Cadet handle).
 879  * @param msg Message itself.
 880  */
 881 static void
 882 handle_get_peers (void *cls,
 883                   const struct GNUNET_MessageHeader *msg)
 884 {
 885   struct GNUNET_CADET_Handle *h = cls;
 886   const struct GNUNET_CADET_LocalInfoPeer *info =
 887     (const struct GNUNET_CADET_LocalInfoPeer *) msg;
 888
 889   if (NULL == h->info_cb.peers_cb)
 890     return;
 891   if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == ntohs (msg->size))
 892     h->info_cb.peers_cb (h->info_cls,
 893                          &info->destination,
 894                          (int) ntohs (info->tunnel),
 895                          (unsigned int) ntohs (info->paths),
 896                          0);
 897   else
 898     h->info_cb.peers_cb (h->info_cls,
 899                          NULL,
 900                          0,
 901                          0,
 902                          0);
 903 }
 904
 905
 906 /**
 907  * Check that message received from CADET service is well-formed.
 908  *
 909  * @param cls the `struct GNUNET_CADET_Handle`
 910  * @param message the message we got
 911  * @return #GNUNET_OK if the message is well-formed,
 912  *         #GNUNET_SYSERR otherwise
 913  */
 914 static int
 915 check_get_peer (void *cls,
 916                 const struct GNUNET_CADET_LocalInfoPeer *message)
 917 {
 918   size_t msize = sizeof (struct GNUNET_CADET_LocalInfoPeer);
 919   size_t esize;
 920
 921   (void) cls;
 922   esize = ntohs (message->header.size);
 923   if (esize < msize)
 924   {
 925     GNUNET_break (0);
 926     return GNUNET_SYSERR;
 927   }
 928   if (0 != ((esize - msize) % sizeof (struct GNUNET_PeerIdentity)))
 929   {
 930     GNUNET_break (0);
 931     return GNUNET_SYSERR;
 932   }
 933   return GNUNET_OK;
 934 }
 935
 936
 937 /**
 938  * Process a local peer info reply, pass info to the user.
 939  *
 940  * @param cls Closure (Cadet handle).
 941  * @param message Message itself.
 942  */
 943 static void
 944 handle_get_peer (void *cls,
 945                  const struct GNUNET_CADET_LocalInfoPeer *message)
 946 {
 947   struct GNUNET_CADET_Handle *h = cls;
 948   const struct GNUNET_PeerIdentity *paths_array;
 949   unsigned int paths;
 950   unsigned int path_length;
 951   int neighbor;
 952   unsigned int peers;
 953
 954   if (NULL == h->info_cb.peer_cb)
 955     return;
 956
 957   LOG (GNUNET_ERROR_TYPE_DEBUG,
 958     "number of paths %u\n",
 959     ntohs (message->paths));
 960
 961   paths = ntohs (message->paths);
 962   paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
 963   peers = (ntohs (message->header.size) - sizeof (*message))
 964           / sizeof (struct GNUNET_PeerIdentity);
 965   path_length = 0;
 966   neighbor = GNUNET_NO;
 967
 968   for (unsigned int i = 0; i < peers; i++)
 969   {
 970     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 971                 " %s\n",
 972                 GNUNET_i2s (&paths_array[i]));
 973     path_length++;
 974     if (0 == memcmp (&paths_array[i], &message->destination,
 975                      sizeof (struct GNUNET_PeerIdentity)))
 976     {
 977       if (1 == path_length)
 978         neighbor = GNUNET_YES;
 979       path_length = 0;
 980     }
 981   }
 982
 983   /* Call Callback with tunnel info. */
 984   paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
 985   h->info_cb.peer_cb (h->info_cls,
 986                       &message->destination,
 987                       (int) ntohs (message->tunnel),
 988                       neighbor,
 989                       paths,
 990                       paths_array,
 991                       (int) ntohs (message->offset),
 992                       (int) ntohs (message->finished_with_paths));
 993 }
 994
 995
 996 /**
 997  * Check that message received from CADET service is well-formed.
 998  *
 999  * @param cls the `struct GNUNET_CADET_Handle`
1000  * @param message the message we got
1001  * @return #GNUNET_OK if the message is well-formed,
1002  *         #GNUNET_SYSERR otherwise
1003  */
1004 static int
1005 check_get_tunnels (void *cls,
1006                    const struct GNUNET_MessageHeader *message)
1007 {
1008   size_t esize;
1009
1010   (void) cls;
1011   esize = ntohs (message->size);
1012   if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == esize)
1013     return GNUNET_OK;
1014   if (sizeof (struct GNUNET_MessageHeader) == esize)
1015     return GNUNET_OK;
1016   return GNUNET_SYSERR;
1017 }
1018
1019
1020 /**
1021  * Process a local reply about info on all tunnels, pass info to the user.
1022  *
1023  * @param cls Closure (Cadet handle).
1024  * @param message Message itself.
1025  */
1026 static void
1027 handle_get_tunnels (void *cls,
1028                     const struct GNUNET_MessageHeader *msg)
1029 {
1030   struct GNUNET_CADET_Handle *h = cls;
1031   const struct GNUNET_CADET_LocalInfoTunnel *info =
1032     (const struct GNUNET_CADET_LocalInfoTunnel *) msg;
1033
1034   if (NULL == h->info_cb.tunnels_cb)
1035     return;
1036   if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == ntohs (msg->size))
1037     h->info_cb.tunnels_cb (h->info_cls,
1038                            &info->destination,
1039                            ntohl (info->channels),
1040                            ntohl (info->connections),
1041                            ntohs (info->estate),
1042                            ntohs (info->cstate));
1043   else
1044     h->info_cb.tunnels_cb (h->info_cls,
1045                            NULL,
1046                            0,
1047                            0,
1048                            0,
1049                            0);
1050 }
1051
1052
1053 /**
1054  * Check that message received from CADET service is well-formed.
1055  *
1056  * @param cls the `struct GNUNET_CADET_Handle`
1057  * @param msg the message we got
1058  * @return #GNUNET_OK if the message is well-formed,
1059  *         #GNUNET_SYSERR otherwise
1060  */
1061 static int
1062 check_get_tunnel (void *cls,
1063                   const struct GNUNET_CADET_LocalInfoTunnel *msg)
1064 {
1065   unsigned int ch_n;
1066   unsigned int c_n;
1067   size_t esize;
1068   size_t msize;
1069
1070   (void) cls;
1071   /* Verify message sanity */
1072   msize = ntohs (msg->header.size);
1073   esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1074   if (esize > msize)
1075   {
1076     GNUNET_break (0);
1077     return GNUNET_SYSERR;
1078   }
1079   ch_n = ntohl (msg->channels);
1080   c_n = ntohl (msg->connections);
1081   esize += ch_n * sizeof (struct GNUNET_CADET_ChannelTunnelNumber);
1082   esize += c_n * sizeof (struct GNUNET_CADET_ConnectionTunnelIdentifier);
1083   if (msize != esize)
1084   {
1085     GNUNET_break_op (0);
1086     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1087                 "m:%u, e: %u (%u ch, %u conn)\n",
1088                 (unsigned int) msize,
1089                 (unsigned int) esize,
1090                 ch_n,
1091                 c_n);
1092     return GNUNET_SYSERR;
1093   }
1094   return GNUNET_OK;
1095 }
1096
1097
1098 /**
1099  * Process a local tunnel info reply, pass info to the user.
1100  *
1101  * @param cls Closure (Cadet handle).
1102  * @param msg Message itself.
1103  */
1104 static void
1105 handle_get_tunnel (void *cls,
1106                    const struct GNUNET_CADET_LocalInfoTunnel *msg)
1107 {
1108   struct GNUNET_CADET_Handle *h = cls;
1109   unsigned int ch_n;
1110   unsigned int c_n;
1111   const struct GNUNET_CADET_ConnectionTunnelIdentifier *conns;
1112   const struct GNUNET_CADET_ChannelTunnelNumber *chns;
1113
1114   if (NULL == h->info_cb.tunnel_cb)
1115     return;
1116   ch_n = ntohl (msg->channels);
1117   c_n = ntohl (msg->connections);
1118
1119   /* Call Callback with tunnel info. */
1120   conns = (const struct GNUNET_CADET_ConnectionTunnelIdentifier *) &msg[1];
1121   chns = (const struct GNUNET_CADET_ChannelTunnelNumber *) &conns[c_n];
1122   h->info_cb.tunnel_cb (h->info_cls,
1123                         &msg->destination,
1124                         ch_n,
1125                         c_n,
1126                         chns,
1127                         conns,
1128                         ntohs (msg->estate),
1129                         ntohs (msg->cstate));
1130 }
1131
1132
1133 /**
1134  * Reconnect to the service, retransmit all infomation to try to restore the
1135  * original state.
1136  *
1137  * @param h handle to the cadet
1138  */
1139 static void
1140 reconnect (struct GNUNET_CADET_Handle *h)
1141 {
1142   struct GNUNET_MQ_MessageHandler handlers[] = {
1143     GNUNET_MQ_hd_fixed_size (channel_created,
1144                              GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE,
1145                              struct GNUNET_CADET_LocalChannelCreateMessage,
1146                              h),
1147     GNUNET_MQ_hd_fixed_size (channel_destroy,
1148                              GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY,
1149                              struct GNUNET_CADET_LocalChannelDestroyMessage,
1150                              h),
1151     GNUNET_MQ_hd_var_size (local_data,
1152                            GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
1153                            struct GNUNET_CADET_LocalData,
1154                            h),
1155     GNUNET_MQ_hd_fixed_size (local_ack,
1156                              GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK,
1157                              struct GNUNET_CADET_LocalAck,
1158                              h),
1159     GNUNET_MQ_hd_var_size (get_peers,
1160                            GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS,
1161                            struct GNUNET_MessageHeader,
1162                            h),
1163     GNUNET_MQ_hd_var_size (get_peer,
1164                            GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER,
1165                            struct GNUNET_CADET_LocalInfoPeer,
1166                            h),
1167     GNUNET_MQ_hd_var_size (get_tunnels,
1168                            GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS,
1169                            struct GNUNET_MessageHeader,
1170                            h),
1171     GNUNET_MQ_hd_var_size (get_tunnel,
1172                            GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL,
1173                            struct GNUNET_CADET_LocalInfoTunnel,
1174                            h),
1175     GNUNET_MQ_handler_end ()
1176   };
1177
1178   GNUNET_assert (NULL == h->mq);
1179   h->mq = GNUNET_CLIENT_connect (h->cfg,
1180                                  "cadet",
1181                                  handlers,
1182                                  &handle_mq_error,
1183                                  h);
1184 }
1185
1186
1187 /**
1188  * Function called during #GNUNET_CADET_disconnect() to destroy
1189  * all ports that are still open.
1190  *
1191  * @param cls the `struct GNUNET_CADET_Handle`
1192  * @param id port ID
1193  * @param value a `struct GNUNET_CADET_Channel` to destroy
1194  * @return #GNUNET_OK (continue to iterate)
1195  */
1196 static int
1197 destroy_port_cb (void *cls,
1198                  const struct GNUNET_HashCode *id,
1199                  void *value)
1200 {
1201   /* struct GNUNET_CADET_Handle *handle = cls; */
1202   struct GNUNET_CADET_Port *port = value;
1203
1204   (void) cls;
1205   (void) id;
1206   /* This is a warning, the app should have cleanly closed all open ports */
1207   GNUNET_break (0);
1208   GNUNET_CADET_close_port (port);
1209   return GNUNET_OK;
1210 }
1211
1212
1213 /**
1214  * Disconnect from the cadet service. All channels will be destroyed. All channel
1215  * disconnect callbacks will be called on any still connected peers, notifying
1216  * about their disconnection. The registered inbound channel cleaner will be
1217  * called should any inbound channels still exist.
1218  *
1219  * @param handle connection to cadet to disconnect
1220  */
1221 void
1222 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
1223 {
1224   GNUNET_CONTAINER_multihashmap_iterate (handle->ports,
1225                                          &destroy_port_cb,
1226                                          handle);
1227   GNUNET_CONTAINER_multihashmap_destroy (handle->ports);
1228   handle->ports = NULL;
1229   GNUNET_CONTAINER_multihashmap32_iterate (handle->channels,
1230                                            &destroy_channel_cb,
1231                                            handle);
1232   GNUNET_CONTAINER_multihashmap32_destroy (handle->channels);
1233   handle->channels = NULL;
1234   if (NULL != handle->mq)
1235   {
1236     GNUNET_MQ_destroy (handle->mq);
1237     handle->mq = NULL;
1238   }
1239   if (NULL != handle->reconnect_task)
1240   {
1241     GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1242     handle->reconnect_task = NULL;
1243   }
1244   GNUNET_free (handle);
1245 }
1246
1247
1248 /**
1249  * Close a port opened with @a GNUNET_CADET_open_port().
1250  * The @a new_channel callback will no longer be called.
1251  *
1252  * @param p Port handle.
1253  */
1254 void
1255 GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p)
1256 {
1257   GNUNET_assert (GNUNET_YES ==
1258                  GNUNET_CONTAINER_multihashmap_remove (p->cadet->ports,
1259                                                        &p->id,
1260                                                        p));
1261   if (NULL != p->cadet->mq)
1262   {
1263     struct GNUNET_CADET_PortMessage *msg;
1264     struct GNUNET_MQ_Envelope *env;
1265
1266     env = GNUNET_MQ_msg (msg,
1267                          GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE);
1268     msg->port = p->id;
1269     GNUNET_MQ_send (p->cadet->mq,
1270                     env);
1271   }
1272   GNUNET_free_non_null (p->handlers);
1273   GNUNET_free (p);
1274 }
1275
1276
1277 /**
1278  * Destroy an existing channel.
1279  *
1280  * The existing end callback for the channel will NOT be called.
1281  * Any pending outgoing messages will be sent but no incoming messages will be
1282  * accepted and no data callbacks will be called.
1283  *
1284  * @param channel Channel handle, becomes invalid after this call.
1285  */
1286 void
1287 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
1288 {
1289   struct GNUNET_CADET_Handle *h = channel->cadet;
1290   struct GNUNET_CADET_LocalChannelDestroyMessage *msg;
1291   struct GNUNET_MQ_Envelope *env;
1292
1293   if (NULL != h->mq)
1294   {
1295     env = GNUNET_MQ_msg (msg,
1296                          GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
1297     msg->ccn = channel->ccn;
1298     GNUNET_MQ_send (h->mq,
1299                     env);
1300   }
1301   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1302               "Destroying channel due to GNUNET_CADET_channel_destroy()\n");
1303   channel->disconnects = NULL;
1304   destroy_channel (channel);
1305 }
1306
1307
1308 /**
1309  * Get information about a channel.
1310  *
1311  * @param channel Channel handle.
1312  * @param option Query (GNUNET_CADET_OPTION_*).
1313  * @param ... dependant on option, currently not used
1314  *
1315  * @return Union with an answer to the query.
1316  */
1317 const union GNUNET_CADET_ChannelInfo *
1318 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
1319                                enum GNUNET_CADET_ChannelOption option,
1320                                ...)
1321 {
1322   static int bool_flag;
1323
1324   switch (option)
1325   {
1326     case GNUNET_CADET_OPTION_NOBUFFER:
1327     case GNUNET_CADET_OPTION_RELIABLE:
1328     case GNUNET_CADET_OPTION_OUT_OF_ORDER:
1329       if (0 != (option & channel->options))
1330         bool_flag = GNUNET_YES;
1331       else
1332         bool_flag = GNUNET_NO;
1333       return (const union GNUNET_CADET_ChannelInfo *) &bool_flag;
1334       break;
1335     case GNUNET_CADET_OPTION_PEER:
1336       return (const union GNUNET_CADET_ChannelInfo *) &channel->peer;
1337       break;
1338     default:
1339       GNUNET_break (0);
1340       return NULL;
1341   }
1342 }
1343
1344
1345 /**
1346  * Send an ack on the channel to confirm the processing of a message.
1347  *
1348  * @param ch Channel on which to send the ACK.
1349  */
1350 void
1351 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
1352 {
1353   struct GNUNET_CADET_LocalAck *msg;
1354   struct GNUNET_MQ_Envelope *env;
1355
1356   env = GNUNET_MQ_msg (msg,
1357                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
1358   LOG (GNUNET_ERROR_TYPE_DEBUG,
1359        "Sending ACK on channel %X\n",
1360        ntohl (channel->ccn.channel_of_client));
1361   msg->ccn = channel->ccn;
1362   GNUNET_MQ_send (channel->cadet->mq,
1363                   env);
1364 }
1365
1366
1367 /**
1368  * Send message of @a type to CADET service of @a h
1369  *
1370  * @param h handle to CADET service
1371  * @param type message type of trivial information request to send
1372  */
1373 static void
1374 send_info_request (struct GNUNET_CADET_Handle *h,
1375                    uint16_t type)
1376 {
1377   struct GNUNET_MessageHeader *msg;
1378   struct GNUNET_MQ_Envelope *env;
1379
1380   env = GNUNET_MQ_msg (msg,
1381                        type);
1382   GNUNET_MQ_send (h->mq,
1383                   env);
1384 }
1385
1386
1387 /**
1388  * Request a debug dump on the service's STDERR.
1389  *
1390  * WARNING: unstable API, likely to change in the future!
1391  *
1392  * @param h cadet handle
1393  */
1394 void
1395 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h)
1396 {
1397   send_info_request (h,
1398                      GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP);
1399 }
1400
1401
1402 /**
1403  * Request information about peers known to the running cadet service.
1404  * The callback will be called for every peer known to the service.
1405  * Only one info request (of any kind) can be active at once.
1406  *
1407  * WARNING: unstable API, likely to change in the future!
1408  *
1409  * @param h Handle to the cadet peer.
1410  * @param callback Function to call with the requested data.
1411  * @param callback_cls Closure for @c callback.
1412  * @return #GNUNET_OK / #GNUNET_SYSERR
1413  */
1414 int
1415 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
1416                        GNUNET_CADET_PeersCB callback,
1417                        void *callback_cls)
1418 {
1419   if (NULL != h->info_cb.peers_cb)
1420   {
1421     GNUNET_break (0);
1422     return GNUNET_SYSERR;
1423   }
1424   send_info_request (h,
1425                      GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
1426   h->info_cb.peers_cb = callback;
1427   h->info_cls = callback_cls;
1428   return GNUNET_OK;
1429 }
1430
1431
1432 /**
1433  * Cancel a peer info request. The callback will not be called (anymore).
1434  *
1435  * WARNING: unstable API, likely to change in the future!
1436  *
1437  * @param h Cadet handle.
1438  * @return Closure given to GNUNET_CADET_get_peers().
1439  */
1440 void *
1441 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h)
1442 {
1443   void *cls = h->info_cls;
1444
1445   h->info_cb.peers_cb = NULL;
1446   h->info_cls = NULL;
1447   return cls;
1448 }
1449
1450
1451 /**
1452  * Request information about a peer known to the running cadet peer.
1453  * The callback will be called for the tunnel once.
1454  * Only one info request (of any kind) can be active at once.
1455  *
1456  * WARNING: unstable API, likely to change in the future!
1457  *
1458  * @param h Handle to the cadet peer.
1459  * @param id Peer whose tunnel to examine.
1460  * @param callback Function to call with the requested data.
1461  * @param callback_cls Closure for @c callback.
1462  * @return #GNUNET_OK / #GNUNET_SYSERR
1463  */
1464 int
1465 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
1466                        const struct GNUNET_PeerIdentity *id,
1467                        GNUNET_CADET_PeerCB callback,
1468                        void *callback_cls)
1469 {
1470   struct GNUNET_CADET_LocalInfo *msg;
1471   struct GNUNET_MQ_Envelope *env;
1472
1473   if (NULL != h->info_cb.peer_cb)
1474   {
1475     GNUNET_break (0);
1476     return GNUNET_SYSERR;
1477   }
1478   env = GNUNET_MQ_msg (msg,
1479                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
1480   msg->peer = *id;
1481   GNUNET_MQ_send (h->mq,
1482                   env);
1483   h->info_cb.peer_cb = callback;
1484   h->info_cls = callback_cls;
1485   return GNUNET_OK;
1486 }
1487
1488
1489 /**
1490  * Request information about tunnels of the running cadet peer.
1491  * The callback will be called for every tunnel of the service.
1492  * Only one info request (of any kind) can be active at once.
1493  *
1494  * WARNING: unstable API, likely to change in the future!
1495  *
1496  * @param h Handle to the cadet peer.
1497  * @param callback Function to call with the requested data.
1498  * @param callback_cls Closure for @c callback.
1499  * @return #GNUNET_OK / #GNUNET_SYSERR
1500  */
1501 int
1502 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
1503                          GNUNET_CADET_TunnelsCB callback,
1504                          void *callback_cls)
1505 {
1506   if (NULL != h->info_cb.tunnels_cb)
1507   {
1508     GNUNET_break (0);
1509     return GNUNET_SYSERR;
1510   }
1511   send_info_request (h,
1512                      GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
1513   h->info_cb.tunnels_cb = callback;
1514   h->info_cls = callback_cls;
1515   return GNUNET_OK;
1516 }
1517
1518
1519 /**
1520  * Cancel a monitor request. The monitor callback will not be called.
1521  *
1522  * @param h Cadet handle.
1523  * @return Closure given to GNUNET_CADET_get_tunnels().
1524  */
1525 void *
1526 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h)
1527 {
1528   void *cls = h->info_cls;
1529
1530   h->info_cb.tunnels_cb = NULL;
1531   h->info_cls = NULL;
1532   return cls;
1533 }
1534
1535
1536 /**
1537  * Request information about a tunnel of the running cadet peer.
1538  * The callback will be called for the tunnel once.
1539  * Only one info request (of any kind) can be active at once.
1540  *
1541  * WARNING: unstable API, likely to change in the future!
1542  *
1543  * @param h Handle to the cadet peer.
1544  * @param id Peer whose tunnel to examine.
1545  * @param callback Function to call with the requested data.
1546  * @param callback_cls Closure for @c callback.
1547  * @return #GNUNET_OK / #GNUNET_SYSERR
1548  */
1549 int
1550 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
1551                         const struct GNUNET_PeerIdentity *id,
1552                         GNUNET_CADET_TunnelCB callback,
1553                         void *callback_cls)
1554 {
1555   struct GNUNET_CADET_LocalInfo *msg;
1556   struct GNUNET_MQ_Envelope *env;
1557
1558   if (NULL != h->info_cb.tunnel_cb)
1559   {
1560     GNUNET_break (0);
1561     return GNUNET_SYSERR;
1562   }
1563   env = GNUNET_MQ_msg (msg,
1564                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
1565   msg->peer = *id;
1566   GNUNET_MQ_send (h->mq,
1567                   env);
1568   h->info_cb.tunnel_cb = callback;
1569   h->info_cls = callback_cls;
1570   return GNUNET_OK;
1571 }
1572
1573
1574 /**
1575  * Transitional function to convert an unsigned int port to a hash value.
1576  * WARNING: local static value returned, NOT reentrant!
1577  * WARNING: do not use this function for new code!
1578  *
1579  * @param port Numerical port (unsigned int format).
1580  *
1581  * @return A GNUNET_HashCode usable for the new CADET API.
1582  */
1583 const struct GNUNET_HashCode *
1584 GC_u2h (uint32_t port)
1585 {
1586   static struct GNUNET_HashCode hash;
1587
1588   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1589               "This is a transitional function, use proper crypto hashes as CADET ports\n");
1590   GNUNET_CRYPTO_hash (&port,
1591                       sizeof (port),
1592                       &hash);
1593   return &hash;
1594 }
1595
1596
1597 /**
1598  * Connect to the MQ-based cadet service.
1599  *
1600  * @param cfg Configuration to use.
1601  *
1602  * @return Handle to the cadet service NULL on error.
1603  */
1604 struct GNUNET_CADET_Handle *
1605 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
1606 {
1607   struct GNUNET_CADET_Handle *h;
1608
1609   LOG (GNUNET_ERROR_TYPE_DEBUG,
1610        "GNUNET_CADET_connect()\n");
1611   h = GNUNET_new (struct GNUNET_CADET_Handle);
1612   h->cfg = cfg;
1613   h->ports = GNUNET_CONTAINER_multihashmap_create (4,
1614                                                    GNUNET_YES);
1615   h->channels = GNUNET_CONTAINER_multihashmap32_create (4);
1616   reconnect (h);
1617   if (NULL == h->mq)
1618   {
1619     GNUNET_break (0);
1620     GNUNET_CADET_disconnect (h);
1621     return NULL;
1622   }
1623   h->next_ccn.channel_of_client = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
1624   return h;
1625 }
1626
1627
1628 /**
1629  * Open a port to receive incomming MQ-based channels.
1630  *
1631  * @param h CADET handle.
1632  * @param port Hash identifying the port.
1633  * @param connects Function called when an incoming channel is connected.
1634  * @param connects_cls Closure for the @a connects handler.
1635  * @param window_changes Function called when the transmit window size changes.
1636  * @param disconnects Function called when a channel is disconnected.
1637  * @param handlers Callbacks for messages we care about, NULL-terminated.
1638  * @return Port handle, NULL if port is in use
1639  */
1640 struct GNUNET_CADET_Port *
1641 GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
1642                         const struct GNUNET_HashCode *port,
1643                         GNUNET_CADET_ConnectEventHandler connects,
1644                         void * connects_cls,
1645                         GNUNET_CADET_WindowSizeEventHandler window_changes,
1646                         GNUNET_CADET_DisconnectEventHandler disconnects,
1647                         const struct GNUNET_MQ_MessageHandler *handlers)
1648 {
1649   struct GNUNET_CADET_Port *p;
1650
1651   GNUNET_assert (NULL != connects);
1652   GNUNET_assert (NULL != disconnects);
1653   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1654               "Listening to CADET port %s\n",
1655               GNUNET_h2s (port));
1656
1657   p = GNUNET_new (struct GNUNET_CADET_Port);
1658   p->cadet = h;
1659   p->id = *port;
1660   if (GNUNET_OK !=
1661       GNUNET_CONTAINER_multihashmap_put (h->ports,
1662                                          &p->id,
1663                                          p,
1664                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1665   {
1666     GNUNET_free (p);
1667     return NULL;
1668   }
1669   p->connects = connects;
1670   p->cls = connects_cls;
1671   p->window_changes = window_changes;
1672   p->disconnects = disconnects;
1673   p->handlers = GNUNET_MQ_copy_handlers (handlers);
1674
1675   GNUNET_assert (GNUNET_OK ==
1676                  open_port_cb (h,
1677                                &p->id,
1678                                p));
1679   return p;
1680 }
1681
1682
1683 /**
1684  * Create a new channel towards a remote peer.
1685  *
1686  * If the destination port is not open by any peer or the destination peer
1687  * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
1688  * for this channel.
1689  *
1690  * @param h CADET handle.
1691  * @param channel_cls Closure for the channel. It's given to:
1692  *                    - The disconnect handler @a disconnects
1693  *                    - Each message type callback in @a handlers
1694  * @param destination Peer identity the channel should go to.
1695  * @param port Identification of the destination port.
1696  * @param options CadetOption flag field, with all desired option bits set to 1.
1697  * @param window_changes Function called when the transmit window size changes.
1698  * @param disconnects Function called when the channel is disconnected.
1699  * @param handlers Callbacks for messages we care about, NULL-terminated.
1700  * @return Handle to the channel.
1701  */
1702 struct GNUNET_CADET_Channel *
1703 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
1704                              void *channel_cls,
1705                              const struct GNUNET_PeerIdentity *destination,
1706                              const struct GNUNET_HashCode *port,
1707                              enum GNUNET_CADET_ChannelOption options,
1708                              GNUNET_CADET_WindowSizeEventHandler window_changes,
1709                              GNUNET_CADET_DisconnectEventHandler disconnects,
1710                              const struct GNUNET_MQ_MessageHandler *handlers)
1711 {
1712   struct GNUNET_CADET_Channel *ch;
1713   struct GNUNET_CADET_LocalChannelCreateMessage *msg;
1714   struct GNUNET_MQ_Envelope *env;
1715
1716   GNUNET_assert (NULL != disconnects);
1717   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1718               "Creating channel to peer %s at port %s\n",
1719               GNUNET_i2s (destination),
1720               GNUNET_h2s (port));
1721   ch = create_channel (h,
1722                        NULL);
1723   ch->ctx = channel_cls;
1724   ch->peer = *destination;
1725   ch->options = options;
1726   ch->window_changes = window_changes;
1727   ch->disconnects = disconnects;
1728
1729   /* Create MQ for channel */
1730   ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
1731                                           &cadet_mq_destroy_impl,
1732                                           &cadet_mq_cancel_impl,
1733                                           ch,
1734                                           handlers,
1735                                           &cadet_mq_error_handler,
1736                                           ch);
1737   GNUNET_MQ_set_handlers_closure (ch->mq,
1738                                   channel_cls);
1739
1740   /* Request channel creation to service */
1741   env = GNUNET_MQ_msg (msg,
1742                        GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE);
1743   msg->ccn = ch->ccn;
1744   msg->port = *port;
1745   msg->peer = *destination;
1746   msg->opt = htonl (options);
1747   GNUNET_MQ_send (h->mq,
1748                   env);
1749   return ch;
1750 }
1751
1752
1753 /**
1754  * Obtain the message queue for a connected peer.
1755  *
1756  * @param channel The channel handle from which to get the MQ.
1757  *
1758  * @return NULL if @a channel is not yet connected.
1759  */
1760 struct GNUNET_MQ_Handle *
1761 GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel)
1762 {
1763   return channel->mq;
1764 }
1765
1766 /* end of cadet_api.c */