2 This file is part of GNUnet.
3 Copyright (C) 2011, 2017 GNUnet e.V.
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.
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.
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/>.
19 * @file cadet/cadet_api.c
20 * @brief cadet api: client implementation of cadet service
21 * @author Bartlomiej Polot
22 * @author Christian Grothoff
25 #include "gnunet_util_lib.h"
26 #include "gnunet_constants.h"
27 #include "gnunet_cadet_service.h"
29 #include "cadet_protocol.h"
31 #define LOG(kind,...) GNUNET_log_from (kind, "cadet-api",__VA_ARGS__)
42 GNUNET_CADET_ChannelCB channel_cb;
47 GNUNET_CADET_PeersCB peers_cb;
52 GNUNET_CADET_PeerCB peer_cb;
57 GNUNET_CADET_TunnelsCB tunnels_cb;
62 GNUNET_CADET_TunnelCB tunnel_cb;
67 * Opaque handle to the service.
69 struct GNUNET_CADET_Handle
74 struct GNUNET_MQ_Handle *mq;
79 struct GNUNET_CONTAINER_MultiHashMap *ports;
84 struct GNUNET_CONTAINER_MultiHashMap32 *channels;
87 * child of the next channel to create (to avoid reusing IDs often)
89 struct GNUNET_CADET_ClientChannelNumber next_ccn;
92 * Configuration given by the client, in case of reconnection
94 const struct GNUNET_CONFIGURATION_Handle *cfg;
97 * Task for trying to reconnect.
99 struct GNUNET_SCHEDULER_Task *reconnect_task;
102 * Callback for an info task (only one active at a time).
104 union CadetInfoCB info_cb;
107 * Info callback closure for @c info_cb.
112 * Time to the next reconnect in case one reconnect fails
114 struct GNUNET_TIME_Relative reconnect_time;
120 * Opaque handle to a channel.
122 struct GNUNET_CADET_Channel
126 * Other end of the channel.
128 struct GNUNET_PeerIdentity peer;
131 * Handle to the cadet this channel belongs to
133 struct GNUNET_CADET_Handle *cadet;
136 * Channel's port, if incoming.
138 struct GNUNET_CADET_Port *incoming_port;
141 * Any data the caller wants to put in here, used for the
142 * various callbacks (@e disconnects, @e window_changes, handlers).
147 * Message Queue for the channel (which we are implementing).
149 struct GNUNET_MQ_Handle *mq;
152 * Task to allow mq to send more traffic.
154 struct GNUNET_SCHEDULER_Task *mq_cont;
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.
161 struct GNUNET_MQ_Envelope *pending_env;
164 * Window change handler.
166 GNUNET_CADET_WindowSizeEventHandler window_changes;
169 * Disconnect handler.
171 GNUNET_CADET_DisconnectEventHandler disconnects;
174 * Local ID of the channel, #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI bit is set if outbound.
176 struct GNUNET_CADET_ClientChannelNumber ccn;
179 * Channel options: reliability, etc.
181 enum GNUNET_CADET_ChannelOption options;
184 * How many messages are we allowed to send to the service right now?
186 unsigned int allow_send;
192 * Opaque handle to a port.
194 struct GNUNET_CADET_Port
200 struct GNUNET_HashCode id;
203 * Handle to the CADET session this port belongs to.
205 struct GNUNET_CADET_Handle *cadet;
208 * Closure for @a handler.
213 * Handler for incoming channels on this port
215 GNUNET_CADET_ConnectEventHandler connects;
218 * Closure for @ref connects
223 * Window size change handler.
225 GNUNET_CADET_WindowSizeEventHandler window_changes;
228 * Handler called when an incoming channel is destroyed.
230 GNUNET_CADET_DisconnectEventHandler disconnects;
233 * Payload handlers for incoming channels.
235 struct GNUNET_MQ_MessageHandler *handlers;
240 * Find the Port struct for a hash.
242 * @param h CADET handle.
243 * @param hash HashCode for the port number.
244 * @return The port handle if known, NULL otherwise.
246 static struct GNUNET_CADET_Port *
247 find_port (const struct GNUNET_CADET_Handle *h,
248 const struct GNUNET_HashCode *hash)
250 return GNUNET_CONTAINER_multihashmap_get (h->ports,
256 * Get the channel handler for the channel specified by id from the given handle
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
262 static struct GNUNET_CADET_Channel *
263 find_channel (struct GNUNET_CADET_Handle *h,
264 struct GNUNET_CADET_ClientChannelNumber ccn)
266 return GNUNET_CONTAINER_multihashmap32_get (h->channels,
267 ntohl (ccn.channel_of_client));
272 * Create a new channel and insert it in the channel list of the cadet handle
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.
278 static struct GNUNET_CADET_Channel *
279 create_channel (struct GNUNET_CADET_Handle *h,
280 const struct GNUNET_CADET_ClientChannelNumber *ccnp)
282 struct GNUNET_CADET_Channel *ch;
283 struct GNUNET_CADET_ClientChannelNumber ccn;
285 ch = GNUNET_new (struct GNUNET_CADET_Channel);
292 h->next_ccn.channel_of_client
293 = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI | (1 + ntohl (h->next_ccn.channel_of_client)));
301 GNUNET_assert (GNUNET_OK ==
302 GNUNET_CONTAINER_multihashmap32_put (h->channels,
303 ntohl (ch->ccn.channel_of_client),
305 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
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
317 * @param ch Pointer to the channel.
318 * @param call_cleaner Whether to call the cleaner handler.
321 destroy_channel (struct GNUNET_CADET_Channel *ch)
323 struct GNUNET_CADET_Handle *h = ch->cadet;
325 LOG (GNUNET_ERROR_TYPE_DEBUG,
326 "Destroying channel %X of %p\n",
327 htonl (ch->ccn.channel_of_client),
329 GNUNET_assert (GNUNET_YES ==
330 GNUNET_CONTAINER_multihashmap32_remove (h->channels,
331 ntohl (ch->ccn.channel_of_client),
333 if (NULL != ch->mq_cont)
335 GNUNET_SCHEDULER_cancel (ch->mq_cont);
338 /* signal channel destruction */
339 if (NULL != ch->disconnects)
340 ch->disconnects (ch->ctx,
342 if (NULL != ch->pending_env)
343 GNUNET_MQ_discard (ch->pending_env);
344 GNUNET_MQ_destroy (ch->mq);
350 * Reconnect to the service, retransmit all infomation to try to restore the
353 * @param h handle to the cadet
356 reconnect (struct GNUNET_CADET_Handle *h);
360 * Function called during #reconnect_cbk() to (re)open
361 * all ports that are still open.
363 * @param cls the `struct GNUNET_CADET_Handle`
365 * @param value a `struct GNUNET_CADET_Channel` to open
366 * @return #GNUNET_OK (continue to iterate)
369 open_port_cb (void *cls,
370 const struct GNUNET_HashCode *id,
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;
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,
389 * Reconnect callback: tries to reconnect again after a failer previous
392 * @param cls closure (cadet handle)
395 reconnect_cbk (void *cls)
397 struct GNUNET_CADET_Handle *h = cls;
399 h->reconnect_task = NULL;
401 = GNUNET_TIME_STD_BACKOFF (h->reconnect_time);
403 GNUNET_CONTAINER_multihashmap_iterate (h->ports,
410 * Notify the application about a change in the window size (if needed).
412 * @param ch Channel to notify about.
415 notify_window_size (struct GNUNET_CADET_Channel *ch)
417 if (NULL != ch->window_changes)
418 ch->window_changes (ch->ctx,
419 ch, /* FIXME: remove 'ch'? */
425 * Transmit the next message from our queue.
427 * @param cls Closure (channel whose mq to activate).
430 cadet_mq_send_now (void *cls)
432 struct GNUNET_CADET_Channel *ch = cls;
433 struct GNUNET_MQ_Envelope *env = ch->pending_env;
436 if (0 == ch->allow_send)
438 /* how did we get here? */
444 /* how did we get here? */
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),
454 GNUNET_MQ_send (ch->cadet->mq,
456 GNUNET_MQ_impl_send_continue (ch->mq);
461 * Implement sending functionality of a message queue for
462 * us sending messages to a peer.
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.
468 * @param mq the message queue
469 * @param msg the message to send
470 * @param impl_state state of the implementation
473 cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq,
474 const struct GNUNET_MessageHeader *msg,
477 struct GNUNET_CADET_Channel *ch = impl_state;
478 struct GNUNET_CADET_Handle *h = ch->cadet;
480 struct GNUNET_MQ_Envelope *env;
481 struct GNUNET_CADET_LocalData *cadet_msg = NULL;
485 /* We're currently reconnecting, pretend this worked */
486 GNUNET_MQ_impl_send_continue (mq);
490 /* check message size for sanity */
491 msize = ntohs (msg->size);
492 if (msize > GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE)
495 GNUNET_MQ_impl_send_continue (mq);
498 env = GNUNET_MQ_msg_nested_mh (cadet_msg,
499 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
501 cadet_msg->ccn = ch->ccn;
502 GNUNET_assert (NULL == ch->pending_env);
503 ch->pending_env = env;
504 if (0 < ch->allow_send)
506 = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
512 * Handle destruction of a message queue. Implementations must not
513 * free @a mq, but should take care of @a impl_state.
515 * @param mq the message queue to destroy
516 * @param impl_state state of the implementation
519 cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq,
522 struct GNUNET_CADET_Channel *ch = impl_state;
524 GNUNET_assert (mq == ch->mq);
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.
534 * @param cls closure with our `struct GNUNET_CADET_Channel`
535 * @param error error code
538 cadet_mq_error_handler (void *cls,
539 enum GNUNET_MQ_Error error)
541 struct GNUNET_CADET_Channel *ch = cls;
543 if (GNUNET_MQ_ERROR_NO_MATCH == error)
545 /* Got a message we did not understand, still try to continue! */
547 GNUNET_CADET_receive_done (ch);
552 if (NULL != ch->disconnects)
553 ch->disconnects (ch->ctx,
555 GNUNET_CADET_channel_destroy (ch);
561 * Implementation function that cancels the currently sent message.
562 * Should basically undo whatever #mq_send_impl() did.
564 * @param mq message queue
565 * @param impl_state state specific to the implementation
568 cadet_mq_cancel_impl (struct GNUNET_MQ_Handle *mq,
571 struct GNUNET_CADET_Channel *ch = impl_state;
574 GNUNET_assert (NULL != ch->pending_env);
575 GNUNET_MQ_discard (ch->pending_env);
576 ch->pending_env = NULL;
577 if (NULL != ch->mq_cont)
579 GNUNET_SCHEDULER_cancel (ch->mq_cont);
586 * Process the new channel notification and add it to the channels in the handle
588 * @param h The cadet handle
589 * @param msg A message with the details of the new incoming channel
592 handle_channel_created (void *cls,
593 const struct GNUNET_CADET_LocalChannelCreateMessage *msg)
595 struct GNUNET_CADET_Handle *h = cls;
596 struct GNUNET_CADET_Channel *ch;
597 struct GNUNET_CADET_Port *port;
598 const struct GNUNET_HashCode *port_number;
599 struct GNUNET_CADET_ClientChannelNumber ccn;
602 port_number = &msg->port;
603 if (ntohl (ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
612 /* We could have closed the port but the service didn't know about it yet
613 * This is not an error.
615 struct GNUNET_CADET_LocalChannelDestroyMessage *d_msg;
616 struct GNUNET_MQ_Envelope *env;
618 LOG (GNUNET_ERROR_TYPE_DEBUG,
619 "No handler for incoming channel %X (on port %s, recently closed?)\n",
620 ntohl (ccn.channel_of_client),
621 GNUNET_h2s (port_number));
622 env = GNUNET_MQ_msg (d_msg,
623 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
624 d_msg->ccn = msg->ccn;
625 GNUNET_MQ_send (h->mq,
630 ch = create_channel (h,
632 ch->peer = msg->peer;
633 ch->incoming_port = port;
634 ch->options = ntohl (msg->opt);
635 LOG (GNUNET_ERROR_TYPE_DEBUG,
636 "Creating incoming channel %X [%s] %p\n",
637 ntohl (ccn.channel_of_client),
638 GNUNET_h2s (port_number),
641 GNUNET_assert (NULL != port->connects);
642 ch->window_changes = port->window_changes;
643 ch->disconnects = port->disconnects;
644 ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
645 &cadet_mq_destroy_impl,
646 &cadet_mq_cancel_impl,
649 &cadet_mq_error_handler,
651 ch->ctx = port->connects (port->cls,
654 GNUNET_MQ_set_handlers_closure (ch->mq,
660 * Process the channel destroy notification and free associated resources
662 * @param h The cadet handle
663 * @param msg A message with the details of the channel being destroyed
666 handle_channel_destroy (void *cls,
667 const struct GNUNET_CADET_LocalChannelDestroyMessage *msg)
669 struct GNUNET_CADET_Handle *h = cls;
670 struct GNUNET_CADET_Channel *ch;
672 ch = find_channel (h,
676 LOG (GNUNET_ERROR_TYPE_DEBUG,
677 "Received channel destroy for unknown channel %X from CADET service (recently close?)\n",
678 ntohl (msg->ccn.channel_of_client));
681 LOG (GNUNET_ERROR_TYPE_DEBUG,
682 "Received channel destroy for channel %X from CADET service\n",
683 ntohl (msg->ccn.channel_of_client));
684 destroy_channel (ch);
689 * Check that message received from CADET service is well-formed.
691 * @param cls the `struct GNUNET_CADET_Handle`
692 * @param message the message we got
693 * @return #GNUNET_OK if the message is well-formed,
694 * #GNUNET_SYSERR otherwise
697 check_local_data (void *cls,
698 const struct GNUNET_CADET_LocalData *message)
703 size = ntohs (message->header.size);
704 if (sizeof (*message) + sizeof (struct GNUNET_MessageHeader) > size)
707 return GNUNET_SYSERR;
714 * Process the incoming data packets, call appropriate handlers.
716 * @param h The cadet handle
717 * @param message A message encapsulating the data
720 handle_local_data (void *cls,
721 const struct GNUNET_CADET_LocalData *message)
723 struct GNUNET_CADET_Handle *h = cls;
724 const struct GNUNET_MessageHeader *payload;
725 struct GNUNET_CADET_Channel *ch;
729 ch = find_channel (h,
733 LOG (GNUNET_ERROR_TYPE_DEBUG,
734 "Unknown channel %X for incoming data (recently closed?)\n",
735 ntohl (message->ccn.channel_of_client));
739 payload = (const struct GNUNET_MessageHeader *) &message[1];
740 type = ntohs (payload->type);
741 fwd = ntohl (ch->ccn.channel_of_client) <= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
742 LOG (GNUNET_ERROR_TYPE_DEBUG,
743 "Got a %s data on channel %s [%X] of type %u\n",
745 GNUNET_i2s (&ch->peer),
746 ntohl (message->ccn.channel_of_client),
748 GNUNET_MQ_inject_message (ch->mq,
754 * Process a local ACK message, enabling the client to send
755 * more data to the service.
757 * @param h Cadet handle.
758 * @param message Message itself.
761 handle_local_ack (void *cls,
762 const struct GNUNET_CADET_LocalAck *message)
764 struct GNUNET_CADET_Handle *h = cls;
765 struct GNUNET_CADET_Channel *ch;
767 ch = find_channel (h,
771 LOG (GNUNET_ERROR_TYPE_DEBUG,
772 "ACK on unknown channel %X\n",
773 ntohl (message->ccn.channel_of_client));
777 LOG (GNUNET_ERROR_TYPE_DEBUG,
778 "Got an ACK on mq channel %X (peer %s); new window size is %u!\n",
779 ntohl (ch->ccn.channel_of_client),
780 GNUNET_i2s (&ch->peer),
782 if (NULL == ch->pending_env)
784 LOG (GNUNET_ERROR_TYPE_DEBUG,
785 "Got an ACK on mq channel %X, allow send now %u!\n",
786 ntohl (ch->ccn.channel_of_client),
788 notify_window_size (ch);
791 if (NULL != ch->mq_cont)
792 return; /* already working on it! */
794 = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
800 * Function called during #GNUNET_CADET_disconnect() to destroy
801 * all channels that are still open.
803 * @param cls the `struct GNUNET_CADET_Handle`
804 * @param cid chanenl ID
805 * @param value a `struct GNUNET_CADET_Channel` to destroy
806 * @return #GNUNET_OK (continue to iterate)
809 destroy_channel_cb (void *cls,
813 /* struct GNUNET_CADET_Handle *handle = cls; */
814 struct GNUNET_CADET_Channel *ch = value;
818 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
819 "Destroying channel due to GNUNET_CADET_disconnect()\n");
820 destroy_channel (ch);
826 * Generic error handler, called with the appropriate error code and
827 * the same closure specified at the creation of the message queue.
828 * Not every message queue implementation supports an error handler.
830 * @param cls closure, a `struct GNUNET_CORE_Handle *`
831 * @param error error code
834 handle_mq_error (void *cls,
835 enum GNUNET_MQ_Error error)
837 struct GNUNET_CADET_Handle *h = cls;
839 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
842 GNUNET_CONTAINER_multihashmap32_iterate (h->channels,
845 GNUNET_MQ_destroy (h->mq);
847 GNUNET_assert (NULL == h->reconnect_task);
848 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
855 * Check that message received from CADET service is well-formed.
857 * @param cls the `struct GNUNET_CADET_Handle`
858 * @param message the message we got
859 * @return #GNUNET_OK if the message is well-formed,
860 * #GNUNET_SYSERR otherwise
863 check_get_peers (void *cls,
864 const struct GNUNET_MessageHeader *message)
869 esize = ntohs (message->size);
870 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == esize)
872 if (sizeof (struct GNUNET_MessageHeader) == esize)
874 return GNUNET_SYSERR;
879 * Process a local reply about info on all tunnels, pass info to the user.
881 * @param cls Closure (Cadet handle).
882 * @param msg Message itself.
885 handle_get_peers (void *cls,
886 const struct GNUNET_MessageHeader *msg)
888 struct GNUNET_CADET_Handle *h = cls;
889 const struct GNUNET_CADET_LocalInfoPeer *info =
890 (const struct GNUNET_CADET_LocalInfoPeer *) msg;
892 if (NULL == h->info_cb.peers_cb)
894 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == ntohs (msg->size))
895 h->info_cb.peers_cb (h->info_cls,
897 (int) ntohs (info->tunnel),
898 (unsigned int) ntohs (info->paths),
901 h->info_cb.peers_cb (h->info_cls,
910 * Check that message received from CADET service is well-formed.
912 * @param cls the `struct GNUNET_CADET_Handle`
913 * @param message the message we got
914 * @return #GNUNET_OK if the message is well-formed,
915 * #GNUNET_SYSERR otherwise
918 check_get_peer (void *cls,
919 const struct GNUNET_CADET_LocalInfoPeer *message)
921 size_t msize = sizeof (struct GNUNET_CADET_LocalInfoPeer);
925 esize = ntohs (message->header.size);
929 return GNUNET_SYSERR;
931 if (0 != ((esize - msize) % sizeof (struct GNUNET_PeerIdentity)))
934 return GNUNET_SYSERR;
941 * Process a local peer info reply, pass info to the user.
943 * @param cls Closure (Cadet handle).
944 * @param message Message itself.
947 handle_get_peer (void *cls,
948 const struct GNUNET_CADET_LocalInfoPeer *message)
950 struct GNUNET_CADET_Handle *h = cls;
951 const struct GNUNET_PeerIdentity *paths_array;
953 unsigned int path_length;
957 if (NULL == h->info_cb.peer_cb)
960 LOG (GNUNET_ERROR_TYPE_DEBUG,
961 "number of paths %u\n",
962 ntohs (message->paths));
964 paths = ntohs (message->paths);
965 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
966 peers = (ntohs (message->header.size) - sizeof (*message))
967 / sizeof (struct GNUNET_PeerIdentity);
969 neighbor = GNUNET_NO;
971 for (unsigned int i = 0; i < peers; i++)
973 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
975 GNUNET_i2s (&paths_array[i]));
977 if (0 == memcmp (&paths_array[i], &message->destination,
978 sizeof (struct GNUNET_PeerIdentity)))
980 if (1 == path_length)
981 neighbor = GNUNET_YES;
986 /* Call Callback with tunnel info. */
987 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
988 h->info_cb.peer_cb (h->info_cls,
989 &message->destination,
990 (int) ntohs (message->tunnel),
994 (int) ntohs (message->offset),
995 (int) ntohs (message->finished_with_paths));
1000 * Check that message received from CADET service is well-formed.
1002 * @param cls the `struct GNUNET_CADET_Handle`
1003 * @param message the message we got
1004 * @return #GNUNET_OK if the message is well-formed,
1005 * #GNUNET_SYSERR otherwise
1008 check_get_tunnels (void *cls,
1009 const struct GNUNET_MessageHeader *message)
1014 esize = ntohs (message->size);
1015 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == esize)
1017 if (sizeof (struct GNUNET_MessageHeader) == esize)
1019 return GNUNET_SYSERR;
1024 * Process a local reply about info on all tunnels, pass info to the user.
1026 * @param cls Closure (Cadet handle).
1027 * @param message Message itself.
1030 handle_get_tunnels (void *cls,
1031 const struct GNUNET_MessageHeader *msg)
1033 struct GNUNET_CADET_Handle *h = cls;
1034 const struct GNUNET_CADET_LocalInfoTunnel *info =
1035 (const struct GNUNET_CADET_LocalInfoTunnel *) msg;
1037 if (NULL == h->info_cb.tunnels_cb)
1039 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == ntohs (msg->size))
1040 h->info_cb.tunnels_cb (h->info_cls,
1042 ntohl (info->channels),
1043 ntohl (info->connections),
1044 ntohs (info->estate),
1045 ntohs (info->cstate));
1047 h->info_cb.tunnels_cb (h->info_cls,
1057 * Check that message received from CADET service is well-formed.
1059 * @param cls the `struct GNUNET_CADET_Handle`
1060 * @param msg the message we got
1061 * @return #GNUNET_OK if the message is well-formed,
1062 * #GNUNET_SYSERR otherwise
1065 check_get_tunnel (void *cls,
1066 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1074 /* Verify message sanity */
1075 msize = ntohs (msg->header.size);
1076 esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1080 return GNUNET_SYSERR;
1082 ch_n = ntohl (msg->channels);
1083 c_n = ntohl (msg->connections);
1084 esize += ch_n * sizeof (struct GNUNET_CADET_ChannelTunnelNumber);
1085 esize += c_n * sizeof (struct GNUNET_CADET_ConnectionTunnelIdentifier);
1088 GNUNET_break_op (0);
1089 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1090 "m:%u, e: %u (%u ch, %u conn)\n",
1091 (unsigned int) msize,
1092 (unsigned int) esize,
1095 return GNUNET_SYSERR;
1102 * Process a local tunnel info reply, pass info to the user.
1104 * @param cls Closure (Cadet handle).
1105 * @param msg Message itself.
1108 handle_get_tunnel (void *cls,
1109 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1111 struct GNUNET_CADET_Handle *h = cls;
1114 const struct GNUNET_CADET_ConnectionTunnelIdentifier *conns;
1115 const struct GNUNET_CADET_ChannelTunnelNumber *chns;
1117 if (NULL == h->info_cb.tunnel_cb)
1119 ch_n = ntohl (msg->channels);
1120 c_n = ntohl (msg->connections);
1122 /* Call Callback with tunnel info. */
1123 conns = (const struct GNUNET_CADET_ConnectionTunnelIdentifier *) &msg[1];
1124 chns = (const struct GNUNET_CADET_ChannelTunnelNumber *) &conns[c_n];
1125 h->info_cb.tunnel_cb (h->info_cls,
1131 ntohs (msg->estate),
1132 ntohs (msg->cstate));
1137 * Reconnect to the service, retransmit all infomation to try to restore the
1140 * @param h handle to the cadet
1143 reconnect (struct GNUNET_CADET_Handle *h)
1145 struct GNUNET_MQ_MessageHandler handlers[] = {
1146 GNUNET_MQ_hd_fixed_size (channel_created,
1147 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE,
1148 struct GNUNET_CADET_LocalChannelCreateMessage,
1150 GNUNET_MQ_hd_fixed_size (channel_destroy,
1151 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY,
1152 struct GNUNET_CADET_LocalChannelDestroyMessage,
1154 GNUNET_MQ_hd_var_size (local_data,
1155 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
1156 struct GNUNET_CADET_LocalData,
1158 GNUNET_MQ_hd_fixed_size (local_ack,
1159 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK,
1160 struct GNUNET_CADET_LocalAck,
1162 GNUNET_MQ_hd_var_size (get_peers,
1163 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS,
1164 struct GNUNET_MessageHeader,
1166 GNUNET_MQ_hd_var_size (get_peer,
1167 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER,
1168 struct GNUNET_CADET_LocalInfoPeer,
1170 GNUNET_MQ_hd_var_size (get_tunnels,
1171 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS,
1172 struct GNUNET_MessageHeader,
1174 GNUNET_MQ_hd_var_size (get_tunnel,
1175 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL,
1176 struct GNUNET_CADET_LocalInfoTunnel,
1178 GNUNET_MQ_handler_end ()
1181 GNUNET_assert (NULL == h->mq);
1182 h->mq = GNUNET_CLIENT_connect (h->cfg,
1191 * Function called during #GNUNET_CADET_disconnect() to destroy
1192 * all ports that are still open.
1194 * @param cls the `struct GNUNET_CADET_Handle`
1196 * @param value a `struct GNUNET_CADET_Channel` to destroy
1197 * @return #GNUNET_OK (continue to iterate)
1200 destroy_port_cb (void *cls,
1201 const struct GNUNET_HashCode *id,
1204 /* struct GNUNET_CADET_Handle *handle = cls; */
1205 struct GNUNET_CADET_Port *port = value;
1209 /* This is a warning, the app should have cleanly closed all open ports */
1211 GNUNET_CADET_close_port (port);
1217 * Disconnect from the cadet service. All channels will be destroyed. All channel
1218 * disconnect callbacks will be called on any still connected peers, notifying
1219 * about their disconnection. The registered inbound channel cleaner will be
1220 * called should any inbound channels still exist.
1222 * @param handle connection to cadet to disconnect
1225 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
1227 GNUNET_CONTAINER_multihashmap_iterate (handle->ports,
1230 GNUNET_CONTAINER_multihashmap_destroy (handle->ports);
1231 handle->ports = NULL;
1232 GNUNET_CONTAINER_multihashmap32_iterate (handle->channels,
1233 &destroy_channel_cb,
1235 GNUNET_CONTAINER_multihashmap32_destroy (handle->channels);
1236 handle->channels = NULL;
1237 if (NULL != handle->mq)
1239 GNUNET_MQ_destroy (handle->mq);
1242 if (NULL != handle->reconnect_task)
1244 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1245 handle->reconnect_task = NULL;
1247 GNUNET_free (handle);
1252 * Close a port opened with @a GNUNET_CADET_open_port().
1253 * The @a new_channel callback will no longer be called.
1255 * @param p Port handle.
1258 GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p)
1260 GNUNET_assert (GNUNET_YES ==
1261 GNUNET_CONTAINER_multihashmap_remove (p->cadet->ports,
1264 if (NULL != p->cadet->mq)
1266 struct GNUNET_CADET_PortMessage *msg;
1267 struct GNUNET_MQ_Envelope *env;
1269 env = GNUNET_MQ_msg (msg,
1270 GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE);
1272 GNUNET_MQ_send (p->cadet->mq,
1275 GNUNET_free_non_null (p->handlers);
1281 * Destroy an existing channel.
1283 * The existing end callback for the channel will NOT be called.
1284 * Any pending outgoing messages will be sent but no incoming messages will be
1285 * accepted and no data callbacks will be called.
1287 * @param channel Channel handle, becomes invalid after this call.
1290 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
1292 struct GNUNET_CADET_Handle *h = channel->cadet;
1293 struct GNUNET_CADET_LocalChannelDestroyMessage *msg;
1294 struct GNUNET_MQ_Envelope *env;
1298 env = GNUNET_MQ_msg (msg,
1299 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
1300 msg->ccn = channel->ccn;
1301 GNUNET_MQ_send (h->mq,
1304 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1305 "Destroying channel due to GNUNET_CADET_channel_destroy()\n");
1306 channel->disconnects = NULL;
1307 destroy_channel (channel);
1312 * Get information about a channel.
1314 * @param channel Channel handle.
1315 * @param option Query (GNUNET_CADET_OPTION_*).
1316 * @param ... dependant on option, currently not used
1318 * @return Union with an answer to the query.
1320 const union GNUNET_CADET_ChannelInfo *
1321 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
1322 enum GNUNET_CADET_ChannelOption option,
1325 static int bool_flag;
1329 case GNUNET_CADET_OPTION_NOBUFFER:
1330 case GNUNET_CADET_OPTION_RELIABLE:
1331 case GNUNET_CADET_OPTION_OUT_OF_ORDER:
1332 if (0 != (option & channel->options))
1333 bool_flag = GNUNET_YES;
1335 bool_flag = GNUNET_NO;
1336 return (const union GNUNET_CADET_ChannelInfo *) &bool_flag;
1338 case GNUNET_CADET_OPTION_PEER:
1339 return (const union GNUNET_CADET_ChannelInfo *) &channel->peer;
1349 * Send an ack on the channel to confirm the processing of a message.
1351 * @param ch Channel on which to send the ACK.
1354 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
1356 struct GNUNET_CADET_LocalAck *msg;
1357 struct GNUNET_MQ_Envelope *env;
1359 env = GNUNET_MQ_msg (msg,
1360 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
1361 LOG (GNUNET_ERROR_TYPE_DEBUG,
1362 "Sending ACK on channel %X\n",
1363 ntohl (channel->ccn.channel_of_client));
1364 msg->ccn = channel->ccn;
1365 GNUNET_MQ_send (channel->cadet->mq,
1371 * Send message of @a type to CADET service of @a h
1373 * @param h handle to CADET service
1374 * @param type message type of trivial information request to send
1377 send_info_request (struct GNUNET_CADET_Handle *h,
1380 struct GNUNET_MessageHeader *msg;
1381 struct GNUNET_MQ_Envelope *env;
1383 env = GNUNET_MQ_msg (msg,
1385 GNUNET_MQ_send (h->mq,
1391 * Request a debug dump on the service's STDERR.
1393 * WARNING: unstable API, likely to change in the future!
1395 * @param h cadet handle
1398 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h)
1400 send_info_request (h,
1401 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP);
1406 * Request information about peers known to the running cadet service.
1407 * The callback will be called for every peer known to the service.
1408 * Only one info request (of any kind) can be active at once.
1410 * WARNING: unstable API, likely to change in the future!
1412 * @param h Handle to the cadet peer.
1413 * @param callback Function to call with the requested data.
1414 * @param callback_cls Closure for @c callback.
1415 * @return #GNUNET_OK / #GNUNET_SYSERR
1418 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
1419 GNUNET_CADET_PeersCB callback,
1422 if (NULL != h->info_cb.peers_cb)
1425 return GNUNET_SYSERR;
1427 send_info_request (h,
1428 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
1429 h->info_cb.peers_cb = callback;
1430 h->info_cls = callback_cls;
1436 * Cancel a peer info request. The callback will not be called (anymore).
1438 * WARNING: unstable API, likely to change in the future!
1440 * @param h Cadet handle.
1441 * @return Closure given to GNUNET_CADET_get_peers().
1444 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h)
1446 void *cls = h->info_cls;
1448 h->info_cb.peers_cb = NULL;
1455 * Request information about a peer known to the running cadet peer.
1456 * The callback will be called for the tunnel once.
1457 * Only one info request (of any kind) can be active at once.
1459 * WARNING: unstable API, likely to change in the future!
1461 * @param h Handle to the cadet peer.
1462 * @param id Peer whose tunnel to examine.
1463 * @param callback Function to call with the requested data.
1464 * @param callback_cls Closure for @c callback.
1465 * @return #GNUNET_OK / #GNUNET_SYSERR
1468 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
1469 const struct GNUNET_PeerIdentity *id,
1470 GNUNET_CADET_PeerCB callback,
1473 struct GNUNET_CADET_LocalInfo *msg;
1474 struct GNUNET_MQ_Envelope *env;
1476 if (NULL != h->info_cb.peer_cb)
1479 return GNUNET_SYSERR;
1481 env = GNUNET_MQ_msg (msg,
1482 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
1484 GNUNET_MQ_send (h->mq,
1486 h->info_cb.peer_cb = callback;
1487 h->info_cls = callback_cls;
1493 * Request information about tunnels of the running cadet peer.
1494 * The callback will be called for every tunnel of the service.
1495 * Only one info request (of any kind) can be active at once.
1497 * WARNING: unstable API, likely to change in the future!
1499 * @param h Handle to the cadet peer.
1500 * @param callback Function to call with the requested data.
1501 * @param callback_cls Closure for @c callback.
1502 * @return #GNUNET_OK / #GNUNET_SYSERR
1505 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
1506 GNUNET_CADET_TunnelsCB callback,
1509 if (NULL != h->info_cb.tunnels_cb)
1512 return GNUNET_SYSERR;
1514 send_info_request (h,
1515 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
1516 h->info_cb.tunnels_cb = callback;
1517 h->info_cls = callback_cls;
1523 * Cancel a monitor request. The monitor callback will not be called.
1525 * @param h Cadet handle.
1526 * @return Closure given to GNUNET_CADET_get_tunnels().
1529 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h)
1531 void *cls = h->info_cls;
1533 h->info_cb.tunnels_cb = NULL;
1540 * Request information about a tunnel of the running cadet peer.
1541 * The callback will be called for the tunnel once.
1542 * Only one info request (of any kind) can be active at once.
1544 * WARNING: unstable API, likely to change in the future!
1546 * @param h Handle to the cadet peer.
1547 * @param id Peer whose tunnel to examine.
1548 * @param callback Function to call with the requested data.
1549 * @param callback_cls Closure for @c callback.
1550 * @return #GNUNET_OK / #GNUNET_SYSERR
1553 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
1554 const struct GNUNET_PeerIdentity *id,
1555 GNUNET_CADET_TunnelCB callback,
1558 struct GNUNET_CADET_LocalInfo *msg;
1559 struct GNUNET_MQ_Envelope *env;
1561 if (NULL != h->info_cb.tunnel_cb)
1564 return GNUNET_SYSERR;
1566 env = GNUNET_MQ_msg (msg,
1567 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
1569 GNUNET_MQ_send (h->mq,
1571 h->info_cb.tunnel_cb = callback;
1572 h->info_cls = callback_cls;
1578 * Transitional function to convert an unsigned int port to a hash value.
1579 * WARNING: local static value returned, NOT reentrant!
1580 * WARNING: do not use this function for new code!
1582 * @param port Numerical port (unsigned int format).
1584 * @return A GNUNET_HashCode usable for the new CADET API.
1586 const struct GNUNET_HashCode *
1587 GC_u2h (uint32_t port)
1589 static struct GNUNET_HashCode hash;
1591 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1592 "This is a transitional function, use proper crypto hashes as CADET ports\n");
1593 GNUNET_CRYPTO_hash (&port,
1601 * Connect to the MQ-based cadet service.
1603 * @param cfg Configuration to use.
1605 * @return Handle to the cadet service NULL on error.
1607 struct GNUNET_CADET_Handle *
1608 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
1610 struct GNUNET_CADET_Handle *h;
1612 LOG (GNUNET_ERROR_TYPE_DEBUG,
1613 "GNUNET_CADET_connect()\n");
1614 h = GNUNET_new (struct GNUNET_CADET_Handle);
1616 h->ports = GNUNET_CONTAINER_multihashmap_create (4,
1618 h->channels = GNUNET_CONTAINER_multihashmap32_create (4);
1623 GNUNET_CADET_disconnect (h);
1626 h->next_ccn.channel_of_client = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
1632 * Open a port to receive incomming MQ-based channels.
1634 * @param h CADET handle.
1635 * @param port Hash identifying the port.
1636 * @param connects Function called when an incoming channel is connected.
1637 * @param connects_cls Closure for the @a connects handler.
1638 * @param window_changes Function called when the transmit window size changes.
1639 * @param disconnects Function called when a channel is disconnected.
1640 * @param handlers Callbacks for messages we care about, NULL-terminated.
1641 * @return Port handle, NULL if port is in use
1643 struct GNUNET_CADET_Port *
1644 GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
1645 const struct GNUNET_HashCode *port,
1646 GNUNET_CADET_ConnectEventHandler connects,
1647 void * connects_cls,
1648 GNUNET_CADET_WindowSizeEventHandler window_changes,
1649 GNUNET_CADET_DisconnectEventHandler disconnects,
1650 const struct GNUNET_MQ_MessageHandler *handlers)
1652 struct GNUNET_CADET_Port *p;
1654 GNUNET_assert (NULL != connects);
1655 GNUNET_assert (NULL != disconnects);
1656 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1657 "Listening to CADET port %s\n",
1660 p = GNUNET_new (struct GNUNET_CADET_Port);
1664 GNUNET_CONTAINER_multihashmap_put (h->ports,
1667 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1672 p->connects = connects;
1673 p->cls = connects_cls;
1674 p->window_changes = window_changes;
1675 p->disconnects = disconnects;
1676 p->handlers = GNUNET_MQ_copy_handlers (handlers);
1678 GNUNET_assert (GNUNET_OK ==
1687 * Create a new channel towards a remote peer.
1689 * If the destination port is not open by any peer or the destination peer
1690 * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
1693 * @param h CADET handle.
1694 * @param channel_cls Closure for the channel. It's given to:
1695 * - The disconnect handler @a disconnects
1696 * - Each message type callback in @a handlers
1697 * @param destination Peer identity the channel should go to.
1698 * @param port Identification of the destination port.
1699 * @param options CadetOption flag field, with all desired option bits set to 1.
1700 * @param window_changes Function called when the transmit window size changes.
1701 * @param disconnects Function called when the channel is disconnected.
1702 * @param handlers Callbacks for messages we care about, NULL-terminated.
1703 * @return Handle to the channel.
1705 struct GNUNET_CADET_Channel *
1706 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
1708 const struct GNUNET_PeerIdentity *destination,
1709 const struct GNUNET_HashCode *port,
1710 enum GNUNET_CADET_ChannelOption options,
1711 GNUNET_CADET_WindowSizeEventHandler window_changes,
1712 GNUNET_CADET_DisconnectEventHandler disconnects,
1713 const struct GNUNET_MQ_MessageHandler *handlers)
1715 struct GNUNET_CADET_Channel *ch;
1716 struct GNUNET_CADET_LocalChannelCreateMessage *msg;
1717 struct GNUNET_MQ_Envelope *env;
1719 GNUNET_assert (NULL != disconnects);
1720 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1721 "Creating channel to peer %s at port %s\n",
1722 GNUNET_i2s (destination),
1724 ch = create_channel (h,
1726 ch->ctx = channel_cls;
1727 ch->peer = *destination;
1728 ch->options = options;
1729 ch->window_changes = window_changes;
1730 ch->disconnects = disconnects;
1732 /* Create MQ for channel */
1733 ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
1734 &cadet_mq_destroy_impl,
1735 &cadet_mq_cancel_impl,
1738 &cadet_mq_error_handler,
1740 GNUNET_MQ_set_handlers_closure (ch->mq,
1743 /* Request channel creation to service */
1744 env = GNUNET_MQ_msg (msg,
1745 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE);
1748 msg->peer = *destination;
1749 msg->opt = htonl (options);
1750 GNUNET_MQ_send (h->mq,
1757 * Obtain the message queue for a connected peer.
1759 * @param channel The channel handle from which to get the MQ.
1761 * @return NULL if @a channel is not yet connected.
1763 struct GNUNET_MQ_Handle *
1764 GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel)
1769 /* end of cadet_api.c */