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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
21 * @file cadet/cadet_api.c
22 * @brief cadet api: client implementation of cadet service
23 * @author Bartlomiej Polot
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_constants.h"
29 #include "gnunet_cadet_service.h"
31 #include "cadet_protocol.h"
33 #define LOG(kind,...) GNUNET_log_from (kind, "cadet-api",__VA_ARGS__)
44 GNUNET_CADET_ChannelCB channel_cb;
49 GNUNET_CADET_PeersCB peers_cb;
54 GNUNET_CADET_PeerCB peer_cb;
59 GNUNET_CADET_TunnelsCB tunnels_cb;
64 GNUNET_CADET_TunnelCB tunnel_cb;
69 * Opaque handle to the service.
71 struct GNUNET_CADET_Handle
76 struct GNUNET_MQ_Handle *mq;
81 struct GNUNET_CONTAINER_MultiHashMap *ports;
86 struct GNUNET_CONTAINER_MultiHashMap32 *channels;
89 * child of the next channel to create (to avoid reusing IDs often)
91 struct GNUNET_CADET_ClientChannelNumber next_ccn;
94 * Configuration given by the client, in case of reconnection
96 const struct GNUNET_CONFIGURATION_Handle *cfg;
99 * Task for trying to reconnect.
101 struct GNUNET_SCHEDULER_Task *reconnect_task;
104 * Callback for an info task (only one active at a time).
106 union CadetInfoCB info_cb;
109 * Info callback closure for @c info_cb.
114 * Time to the next reconnect in case one reconnect fails
116 struct GNUNET_TIME_Relative reconnect_time;
122 * Opaque handle to a channel.
124 struct GNUNET_CADET_Channel
128 * Other end of the channel.
130 struct GNUNET_PeerIdentity peer;
133 * Handle to the cadet this channel belongs to
135 struct GNUNET_CADET_Handle *cadet;
138 * Channel's port, if incoming.
140 struct GNUNET_CADET_Port *incoming_port;
143 * Any data the caller wants to put in here, used for the
144 * various callbacks (@e disconnects, @e window_changes, handlers).
149 * Message Queue for the channel (which we are implementing).
151 struct GNUNET_MQ_Handle *mq;
154 * Task to allow mq to send more traffic.
156 struct GNUNET_SCHEDULER_Task *mq_cont;
159 * Pending envelope with a message to be transmitted to the
160 * service as soon as we are allowed to. Should only be
161 * non-NULL if @e allow_send is 0.
163 struct GNUNET_MQ_Envelope *pending_env;
166 * Window change handler.
168 GNUNET_CADET_WindowSizeEventHandler window_changes;
171 * Disconnect handler.
173 GNUNET_CADET_DisconnectEventHandler disconnects;
176 * Local ID of the channel, #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI bit is set if outbound.
178 struct GNUNET_CADET_ClientChannelNumber ccn;
181 * Channel options: reliability, etc.
183 enum GNUNET_CADET_ChannelOption options;
186 * How many messages are we allowed to send to the service right now?
188 unsigned int allow_send;
194 * Opaque handle to a port.
196 struct GNUNET_CADET_Port
202 struct GNUNET_HashCode id;
205 * Handle to the CADET session this port belongs to.
207 struct GNUNET_CADET_Handle *cadet;
210 * Closure for @a handler.
215 * Handler for incoming channels on this port
217 GNUNET_CADET_ConnectEventHandler connects;
220 * Closure for @ref connects
225 * Window size change handler.
227 GNUNET_CADET_WindowSizeEventHandler window_changes;
230 * Handler called when an incoming channel is destroyed.
232 GNUNET_CADET_DisconnectEventHandler disconnects;
235 * Payload handlers for incoming channels.
237 struct GNUNET_MQ_MessageHandler *handlers;
242 * Find the Port struct for a hash.
244 * @param h CADET handle.
245 * @param hash HashCode for the port number.
246 * @return The port handle if known, NULL otherwise.
248 static struct GNUNET_CADET_Port *
249 find_port (const struct GNUNET_CADET_Handle *h,
250 const struct GNUNET_HashCode *hash)
252 return GNUNET_CONTAINER_multihashmap_get (h->ports,
258 * Get the channel handler for the channel specified by id from the given handle
260 * @param h Cadet handle
261 * @param ccn ID of the wanted channel
262 * @return handle to the required channel or NULL if not found
264 static struct GNUNET_CADET_Channel *
265 find_channel (struct GNUNET_CADET_Handle *h,
266 struct GNUNET_CADET_ClientChannelNumber ccn)
268 return GNUNET_CONTAINER_multihashmap32_get (h->channels,
269 ntohl (ccn.channel_of_client));
274 * Create a new channel and insert it in the channel list of the cadet handle
276 * @param h Cadet handle
277 * @param ccnp pointer to desired ccn of the channel, NULL to assign one automatically.
278 * @return Handle to the created channel.
280 static struct GNUNET_CADET_Channel *
281 create_channel (struct GNUNET_CADET_Handle *h,
282 const struct GNUNET_CADET_ClientChannelNumber *ccnp)
284 struct GNUNET_CADET_Channel *ch;
285 struct GNUNET_CADET_ClientChannelNumber ccn;
287 ch = GNUNET_new (struct GNUNET_CADET_Channel);
294 h->next_ccn.channel_of_client
295 = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI | (1 + ntohl (h->next_ccn.channel_of_client)));
303 GNUNET_assert (GNUNET_OK ==
304 GNUNET_CONTAINER_multihashmap32_put (h->channels,
305 ntohl (ch->ccn.channel_of_client),
307 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
313 * Destroy the specified channel.
314 * - Destroys all peers, calling the disconnect callback on each if needed
315 * - Cancels all outgoing traffic for that channel, calling respective notifys
316 * - Calls cleaner if channel was inbound
317 * - Frees all memory used
319 * @param ch Pointer to the channel.
320 * @param call_cleaner Whether to call the cleaner handler.
323 destroy_channel (struct GNUNET_CADET_Channel *ch)
325 struct GNUNET_CADET_Handle *h = ch->cadet;
327 LOG (GNUNET_ERROR_TYPE_DEBUG,
328 "Destroying channel %X of %p\n",
329 htonl (ch->ccn.channel_of_client),
331 GNUNET_assert (GNUNET_YES ==
332 GNUNET_CONTAINER_multihashmap32_remove (h->channels,
333 ntohl (ch->ccn.channel_of_client),
335 if (NULL != ch->mq_cont)
337 GNUNET_SCHEDULER_cancel (ch->mq_cont);
340 /* signal channel destruction */
341 if (NULL != ch->disconnects)
342 ch->disconnects (ch->ctx,
344 if (NULL != ch->pending_env)
345 GNUNET_MQ_discard (ch->pending_env);
346 GNUNET_MQ_destroy (ch->mq);
352 * Reconnect to the service, retransmit all infomation to try to restore the
355 * @param h handle to the cadet
358 reconnect (struct GNUNET_CADET_Handle *h);
362 * Function called during #reconnect_cbk() to (re)open
363 * all ports that are still open.
365 * @param cls the `struct GNUNET_CADET_Handle`
367 * @param value a `struct GNUNET_CADET_Channel` to open
368 * @return #GNUNET_OK (continue to iterate)
371 open_port_cb (void *cls,
372 const struct GNUNET_HashCode *id,
375 struct GNUNET_CADET_Handle *h = cls;
376 struct GNUNET_CADET_Port *port = value;
377 struct GNUNET_CADET_PortMessage *msg;
378 struct GNUNET_MQ_Envelope *env;
381 env = GNUNET_MQ_msg (msg,
382 GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN);
383 msg->port = port->id;
384 GNUNET_MQ_send (h->mq,
391 * Reconnect callback: tries to reconnect again after a failer previous
394 * @param cls closure (cadet handle)
397 reconnect_cbk (void *cls)
399 struct GNUNET_CADET_Handle *h = cls;
401 h->reconnect_task = NULL;
403 = GNUNET_TIME_STD_BACKOFF (h->reconnect_time);
405 GNUNET_CONTAINER_multihashmap_iterate (h->ports,
412 * Notify the application about a change in the window size (if needed).
414 * @param ch Channel to notify about.
417 notify_window_size (struct GNUNET_CADET_Channel *ch)
419 if (NULL != ch->window_changes)
420 ch->window_changes (ch->ctx,
421 ch, /* FIXME: remove 'ch'? */
427 * Transmit the next message from our queue.
429 * @param cls Closure (channel whose mq to activate).
432 cadet_mq_send_now (void *cls)
434 struct GNUNET_CADET_Channel *ch = cls;
435 struct GNUNET_MQ_Envelope *env = ch->pending_env;
438 if (0 == ch->allow_send)
440 /* how did we get here? */
446 /* how did we get here? */
451 ch->pending_env = NULL;
452 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
453 "Sending message on channel %s to CADET, new window size is %u\n",
454 GNUNET_i2s (&ch->peer),
456 GNUNET_MQ_send (ch->cadet->mq,
458 GNUNET_MQ_impl_send_continue (ch->mq);
463 * Implement sending functionality of a message queue for
464 * us sending messages to a peer.
466 * Encapsulates the payload message in a #GNUNET_CADET_LocalData message
467 * in order to label the message with the channel ID and send the
468 * encapsulated message to the service.
470 * @param mq the message queue
471 * @param msg the message to send
472 * @param impl_state state of the implementation
475 cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq,
476 const struct GNUNET_MessageHeader *msg,
479 struct GNUNET_CADET_Channel *ch = impl_state;
480 struct GNUNET_CADET_Handle *h = ch->cadet;
482 struct GNUNET_MQ_Envelope *env;
483 struct GNUNET_CADET_LocalData *cadet_msg = NULL;
487 /* We're currently reconnecting, pretend this worked */
488 GNUNET_MQ_impl_send_continue (mq);
492 /* check message size for sanity */
493 msize = ntohs (msg->size);
494 if (msize > GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE)
497 GNUNET_MQ_impl_send_continue (mq);
500 env = GNUNET_MQ_msg_nested_mh (cadet_msg,
501 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
503 cadet_msg->ccn = ch->ccn;
504 GNUNET_assert (NULL == ch->pending_env);
505 ch->pending_env = env;
506 if (0 < ch->allow_send)
508 = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
514 * Handle destruction of a message queue. Implementations must not
515 * free @a mq, but should take care of @a impl_state.
517 * @param mq the message queue to destroy
518 * @param impl_state state of the implementation
521 cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq,
524 struct GNUNET_CADET_Channel *ch = impl_state;
526 GNUNET_assert (mq == ch->mq);
532 * We had an error processing a message we forwarded from a peer to
533 * the CADET service. We should just complain about it but otherwise
534 * continue processing.
536 * @param cls closure with our `struct GNUNET_CADET_Channel`
537 * @param error error code
540 cadet_mq_error_handler (void *cls,
541 enum GNUNET_MQ_Error error)
543 struct GNUNET_CADET_Channel *ch = cls;
545 if (GNUNET_MQ_ERROR_NO_MATCH == error)
547 /* Got a message we did not understand, still try to continue! */
549 GNUNET_CADET_receive_done (ch);
554 if (NULL != ch->disconnects)
555 ch->disconnects (ch->ctx,
557 GNUNET_CADET_channel_destroy (ch);
563 * Implementation function that cancels the currently sent message.
564 * Should basically undo whatever #mq_send_impl() did.
566 * @param mq message queue
567 * @param impl_state state specific to the implementation
570 cadet_mq_cancel_impl (struct GNUNET_MQ_Handle *mq,
573 struct GNUNET_CADET_Channel *ch = impl_state;
576 GNUNET_assert (NULL != ch->pending_env);
577 GNUNET_MQ_discard (ch->pending_env);
578 ch->pending_env = NULL;
579 if (NULL != ch->mq_cont)
581 GNUNET_SCHEDULER_cancel (ch->mq_cont);
588 * Process the new channel notification and add it to the channels in the handle
590 * @param h The cadet handle
591 * @param msg A message with the details of the new incoming channel
594 handle_channel_created (void *cls,
595 const struct GNUNET_CADET_LocalChannelCreateMessage *msg)
597 struct GNUNET_CADET_Handle *h = cls;
598 struct GNUNET_CADET_Channel *ch;
599 struct GNUNET_CADET_Port *port;
600 const struct GNUNET_HashCode *port_number;
601 struct GNUNET_CADET_ClientChannelNumber ccn;
604 port_number = &msg->port;
605 if (ntohl (ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
614 /* We could have closed the port but the service didn't know about it yet
615 * This is not an error.
617 struct GNUNET_CADET_LocalChannelDestroyMessage *d_msg;
618 struct GNUNET_MQ_Envelope *env;
620 LOG (GNUNET_ERROR_TYPE_DEBUG,
621 "No handler for incoming channel %X (on port %s, recently closed?)\n",
622 ntohl (ccn.channel_of_client),
623 GNUNET_h2s (port_number));
624 env = GNUNET_MQ_msg (d_msg,
625 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
626 d_msg->ccn = msg->ccn;
627 GNUNET_MQ_send (h->mq,
632 ch = create_channel (h,
634 ch->peer = msg->peer;
635 ch->incoming_port = port;
636 ch->options = ntohl (msg->opt);
637 LOG (GNUNET_ERROR_TYPE_DEBUG,
638 "Creating incoming channel %X [%s] %p\n",
639 ntohl (ccn.channel_of_client),
640 GNUNET_h2s (port_number),
643 GNUNET_assert (NULL != port->connects);
644 ch->window_changes = port->window_changes;
645 ch->disconnects = port->disconnects;
646 ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
647 &cadet_mq_destroy_impl,
648 &cadet_mq_cancel_impl,
651 &cadet_mq_error_handler,
653 ch->ctx = port->connects (port->cls,
656 GNUNET_MQ_set_handlers_closure (ch->mq,
662 * Process the channel destroy notification and free associated resources
664 * @param h The cadet handle
665 * @param msg A message with the details of the channel being destroyed
668 handle_channel_destroy (void *cls,
669 const struct GNUNET_CADET_LocalChannelDestroyMessage *msg)
671 struct GNUNET_CADET_Handle *h = cls;
672 struct GNUNET_CADET_Channel *ch;
674 ch = find_channel (h,
678 LOG (GNUNET_ERROR_TYPE_DEBUG,
679 "Received channel destroy for unknown channel %X from CADET service (recently close?)\n",
680 ntohl (msg->ccn.channel_of_client));
683 LOG (GNUNET_ERROR_TYPE_DEBUG,
684 "Received channel destroy for channel %X from CADET service\n",
685 ntohl (msg->ccn.channel_of_client));
686 destroy_channel (ch);
691 * Check that message received from CADET service is well-formed.
693 * @param cls the `struct GNUNET_CADET_Handle`
694 * @param message the message we got
695 * @return #GNUNET_OK if the message is well-formed,
696 * #GNUNET_SYSERR otherwise
699 check_local_data (void *cls,
700 const struct GNUNET_CADET_LocalData *message)
705 size = ntohs (message->header.size);
706 if (sizeof (*message) + sizeof (struct GNUNET_MessageHeader) > size)
709 return GNUNET_SYSERR;
716 * Process the incoming data packets, call appropriate handlers.
718 * @param h The cadet handle
719 * @param message A message encapsulating the data
722 handle_local_data (void *cls,
723 const struct GNUNET_CADET_LocalData *message)
725 struct GNUNET_CADET_Handle *h = cls;
726 const struct GNUNET_MessageHeader *payload;
727 struct GNUNET_CADET_Channel *ch;
731 ch = find_channel (h,
735 LOG (GNUNET_ERROR_TYPE_DEBUG,
736 "Unknown channel %X for incoming data (recently closed?)\n",
737 ntohl (message->ccn.channel_of_client));
741 payload = (const struct GNUNET_MessageHeader *) &message[1];
742 type = ntohs (payload->type);
743 fwd = ntohl (ch->ccn.channel_of_client) <= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
744 LOG (GNUNET_ERROR_TYPE_DEBUG,
745 "Got a %s data on channel %s [%X] of type %u\n",
747 GNUNET_i2s (&ch->peer),
748 ntohl (message->ccn.channel_of_client),
750 GNUNET_MQ_inject_message (ch->mq,
756 * Process a local ACK message, enabling the client to send
757 * more data to the service.
759 * @param h Cadet handle.
760 * @param message Message itself.
763 handle_local_ack (void *cls,
764 const struct GNUNET_CADET_LocalAck *message)
766 struct GNUNET_CADET_Handle *h = cls;
767 struct GNUNET_CADET_Channel *ch;
769 ch = find_channel (h,
773 LOG (GNUNET_ERROR_TYPE_DEBUG,
774 "ACK on unknown channel %X\n",
775 ntohl (message->ccn.channel_of_client));
779 LOG (GNUNET_ERROR_TYPE_DEBUG,
780 "Got an ACK on mq channel %X (peer %s); new window size is %u!\n",
781 ntohl (ch->ccn.channel_of_client),
782 GNUNET_i2s (&ch->peer),
784 if (NULL == ch->pending_env)
786 LOG (GNUNET_ERROR_TYPE_DEBUG,
787 "Got an ACK on mq channel %X, allow send now %u!\n",
788 ntohl (ch->ccn.channel_of_client),
790 notify_window_size (ch);
793 if (NULL != ch->mq_cont)
794 return; /* already working on it! */
796 = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
802 * Function called during #GNUNET_CADET_disconnect() to destroy
803 * all channels that are still open.
805 * @param cls the `struct GNUNET_CADET_Handle`
806 * @param cid chanenl ID
807 * @param value a `struct GNUNET_CADET_Channel` to destroy
808 * @return #GNUNET_OK (continue to iterate)
811 destroy_channel_cb (void *cls,
815 /* struct GNUNET_CADET_Handle *handle = cls; */
816 struct GNUNET_CADET_Channel *ch = value;
820 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
821 "Destroying channel due to GNUNET_CADET_disconnect()\n");
822 destroy_channel (ch);
828 * Generic error handler, called with the appropriate error code and
829 * the same closure specified at the creation of the message queue.
830 * Not every message queue implementation supports an error handler.
832 * @param cls closure, a `struct GNUNET_CORE_Handle *`
833 * @param error error code
836 handle_mq_error (void *cls,
837 enum GNUNET_MQ_Error error)
839 struct GNUNET_CADET_Handle *h = cls;
841 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
844 GNUNET_CONTAINER_multihashmap32_iterate (h->channels,
847 GNUNET_MQ_destroy (h->mq);
849 GNUNET_assert (NULL == h->reconnect_task);
850 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
857 * Check that message received from CADET service is well-formed.
859 * @param cls the `struct GNUNET_CADET_Handle`
860 * @param message the message we got
861 * @return #GNUNET_OK if the message is well-formed,
862 * #GNUNET_SYSERR otherwise
865 check_get_peers (void *cls,
866 const struct GNUNET_MessageHeader *message)
871 esize = ntohs (message->size);
872 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == esize)
874 if (sizeof (struct GNUNET_MessageHeader) == esize)
876 return GNUNET_SYSERR;
881 * Process a local reply about info on all tunnels, pass info to the user.
883 * @param cls Closure (Cadet handle).
884 * @param msg Message itself.
887 handle_get_peers (void *cls,
888 const struct GNUNET_MessageHeader *msg)
890 struct GNUNET_CADET_Handle *h = cls;
891 const struct GNUNET_CADET_LocalInfoPeer *info =
892 (const struct GNUNET_CADET_LocalInfoPeer *) msg;
894 if (NULL == h->info_cb.peers_cb)
896 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == ntohs (msg->size))
897 h->info_cb.peers_cb (h->info_cls,
899 (int) ntohs (info->tunnel),
900 (unsigned int) ntohs (info->paths),
903 h->info_cb.peers_cb (h->info_cls,
912 * Check that message received from CADET service is well-formed.
914 * @param cls the `struct GNUNET_CADET_Handle`
915 * @param message the message we got
916 * @return #GNUNET_OK if the message is well-formed,
917 * #GNUNET_SYSERR otherwise
920 check_get_peer (void *cls,
921 const struct GNUNET_CADET_LocalInfoPeer *message)
923 size_t msize = sizeof (struct GNUNET_CADET_LocalInfoPeer);
927 esize = ntohs (message->header.size);
931 return GNUNET_SYSERR;
933 if (0 != ((esize - msize) % sizeof (struct GNUNET_PeerIdentity)))
936 return GNUNET_SYSERR;
943 * Process a local peer info reply, pass info to the user.
945 * @param cls Closure (Cadet handle).
946 * @param message Message itself.
949 handle_get_peer (void *cls,
950 const struct GNUNET_CADET_LocalInfoPeer *message)
952 struct GNUNET_CADET_Handle *h = cls;
953 const struct GNUNET_PeerIdentity *paths_array;
955 unsigned int path_length;
959 if (NULL == h->info_cb.peer_cb)
962 LOG (GNUNET_ERROR_TYPE_DEBUG,
963 "number of paths %u\n",
964 ntohs (message->paths));
966 paths = ntohs (message->paths);
967 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
968 peers = (ntohs (message->header.size) - sizeof (*message))
969 / sizeof (struct GNUNET_PeerIdentity);
971 neighbor = GNUNET_NO;
973 for (unsigned int i = 0; i < peers; i++)
975 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
977 GNUNET_i2s (&paths_array[i]));
979 if (0 == memcmp (&paths_array[i], &message->destination,
980 sizeof (struct GNUNET_PeerIdentity)))
982 if (1 == path_length)
983 neighbor = GNUNET_YES;
988 /* Call Callback with tunnel info. */
989 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
990 h->info_cb.peer_cb (h->info_cls,
991 &message->destination,
992 (int) ntohs (message->tunnel),
996 (int) ntohs (message->offset),
997 (int) ntohs (message->finished_with_paths));
1002 * Check that message received from CADET service is well-formed.
1004 * @param cls the `struct GNUNET_CADET_Handle`
1005 * @param message the message we got
1006 * @return #GNUNET_OK if the message is well-formed,
1007 * #GNUNET_SYSERR otherwise
1010 check_get_tunnels (void *cls,
1011 const struct GNUNET_MessageHeader *message)
1016 esize = ntohs (message->size);
1017 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == esize)
1019 if (sizeof (struct GNUNET_MessageHeader) == esize)
1021 return GNUNET_SYSERR;
1026 * Process a local reply about info on all tunnels, pass info to the user.
1028 * @param cls Closure (Cadet handle).
1029 * @param message Message itself.
1032 handle_get_tunnels (void *cls,
1033 const struct GNUNET_MessageHeader *msg)
1035 struct GNUNET_CADET_Handle *h = cls;
1036 const struct GNUNET_CADET_LocalInfoTunnel *info =
1037 (const struct GNUNET_CADET_LocalInfoTunnel *) msg;
1039 if (NULL == h->info_cb.tunnels_cb)
1041 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == ntohs (msg->size))
1042 h->info_cb.tunnels_cb (h->info_cls,
1044 ntohl (info->channels),
1045 ntohl (info->connections),
1046 ntohs (info->estate),
1047 ntohs (info->cstate));
1049 h->info_cb.tunnels_cb (h->info_cls,
1059 * Check that message received from CADET service is well-formed.
1061 * @param cls the `struct GNUNET_CADET_Handle`
1062 * @param msg the message we got
1063 * @return #GNUNET_OK if the message is well-formed,
1064 * #GNUNET_SYSERR otherwise
1067 check_get_tunnel (void *cls,
1068 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1076 /* Verify message sanity */
1077 msize = ntohs (msg->header.size);
1078 esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1082 return GNUNET_SYSERR;
1084 ch_n = ntohl (msg->channels);
1085 c_n = ntohl (msg->connections);
1086 esize += ch_n * sizeof (struct GNUNET_CADET_ChannelTunnelNumber);
1087 esize += c_n * sizeof (struct GNUNET_CADET_ConnectionTunnelIdentifier);
1090 GNUNET_break_op (0);
1091 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1092 "m:%u, e: %u (%u ch, %u conn)\n",
1093 (unsigned int) msize,
1094 (unsigned int) esize,
1097 return GNUNET_SYSERR;
1104 * Process a local tunnel info reply, pass info to the user.
1106 * @param cls Closure (Cadet handle).
1107 * @param msg Message itself.
1110 handle_get_tunnel (void *cls,
1111 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1113 struct GNUNET_CADET_Handle *h = cls;
1116 const struct GNUNET_CADET_ConnectionTunnelIdentifier *conns;
1117 const struct GNUNET_CADET_ChannelTunnelNumber *chns;
1119 if (NULL == h->info_cb.tunnel_cb)
1121 ch_n = ntohl (msg->channels);
1122 c_n = ntohl (msg->connections);
1124 /* Call Callback with tunnel info. */
1125 conns = (const struct GNUNET_CADET_ConnectionTunnelIdentifier *) &msg[1];
1126 chns = (const struct GNUNET_CADET_ChannelTunnelNumber *) &conns[c_n];
1127 h->info_cb.tunnel_cb (h->info_cls,
1133 ntohs (msg->estate),
1134 ntohs (msg->cstate));
1139 * Reconnect to the service, retransmit all infomation to try to restore the
1142 * @param h handle to the cadet
1145 reconnect (struct GNUNET_CADET_Handle *h)
1147 struct GNUNET_MQ_MessageHandler handlers[] = {
1148 GNUNET_MQ_hd_fixed_size (channel_created,
1149 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE,
1150 struct GNUNET_CADET_LocalChannelCreateMessage,
1152 GNUNET_MQ_hd_fixed_size (channel_destroy,
1153 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY,
1154 struct GNUNET_CADET_LocalChannelDestroyMessage,
1156 GNUNET_MQ_hd_var_size (local_data,
1157 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
1158 struct GNUNET_CADET_LocalData,
1160 GNUNET_MQ_hd_fixed_size (local_ack,
1161 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK,
1162 struct GNUNET_CADET_LocalAck,
1164 GNUNET_MQ_hd_var_size (get_peers,
1165 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS,
1166 struct GNUNET_MessageHeader,
1168 GNUNET_MQ_hd_var_size (get_peer,
1169 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER,
1170 struct GNUNET_CADET_LocalInfoPeer,
1172 GNUNET_MQ_hd_var_size (get_tunnels,
1173 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS,
1174 struct GNUNET_MessageHeader,
1176 GNUNET_MQ_hd_var_size (get_tunnel,
1177 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL,
1178 struct GNUNET_CADET_LocalInfoTunnel,
1180 GNUNET_MQ_handler_end ()
1183 GNUNET_assert (NULL == h->mq);
1184 h->mq = GNUNET_CLIENT_connect (h->cfg,
1193 * Function called during #GNUNET_CADET_disconnect() to destroy
1194 * all ports that are still open.
1196 * @param cls the `struct GNUNET_CADET_Handle`
1198 * @param value a `struct GNUNET_CADET_Channel` to destroy
1199 * @return #GNUNET_OK (continue to iterate)
1202 destroy_port_cb (void *cls,
1203 const struct GNUNET_HashCode *id,
1206 /* struct GNUNET_CADET_Handle *handle = cls; */
1207 struct GNUNET_CADET_Port *port = value;
1211 /* This is a warning, the app should have cleanly closed all open ports */
1213 GNUNET_CADET_close_port (port);
1219 * Disconnect from the cadet service. All channels will be destroyed. All channel
1220 * disconnect callbacks will be called on any still connected peers, notifying
1221 * about their disconnection. The registered inbound channel cleaner will be
1222 * called should any inbound channels still exist.
1224 * @param handle connection to cadet to disconnect
1227 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
1229 GNUNET_CONTAINER_multihashmap_iterate (handle->ports,
1232 GNUNET_CONTAINER_multihashmap_destroy (handle->ports);
1233 handle->ports = NULL;
1234 GNUNET_CONTAINER_multihashmap32_iterate (handle->channels,
1235 &destroy_channel_cb,
1237 GNUNET_CONTAINER_multihashmap32_destroy (handle->channels);
1238 handle->channels = NULL;
1239 if (NULL != handle->mq)
1241 GNUNET_MQ_destroy (handle->mq);
1244 if (NULL != handle->reconnect_task)
1246 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1247 handle->reconnect_task = NULL;
1249 GNUNET_free (handle);
1254 * Close a port opened with @a GNUNET_CADET_open_port().
1255 * The @a new_channel callback will no longer be called.
1257 * @param p Port handle.
1260 GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p)
1262 GNUNET_assert (GNUNET_YES ==
1263 GNUNET_CONTAINER_multihashmap_remove (p->cadet->ports,
1266 if (NULL != p->cadet->mq)
1268 struct GNUNET_CADET_PortMessage *msg;
1269 struct GNUNET_MQ_Envelope *env;
1271 env = GNUNET_MQ_msg (msg,
1272 GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE);
1274 GNUNET_MQ_send (p->cadet->mq,
1277 GNUNET_free_non_null (p->handlers);
1283 * Destroy an existing channel.
1285 * The existing end callback for the channel will NOT be called.
1286 * Any pending outgoing messages will be sent but no incoming messages will be
1287 * accepted and no data callbacks will be called.
1289 * @param channel Channel handle, becomes invalid after this call.
1292 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
1294 struct GNUNET_CADET_Handle *h = channel->cadet;
1295 struct GNUNET_CADET_LocalChannelDestroyMessage *msg;
1296 struct GNUNET_MQ_Envelope *env;
1300 env = GNUNET_MQ_msg (msg,
1301 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
1302 msg->ccn = channel->ccn;
1303 GNUNET_MQ_send (h->mq,
1306 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1307 "Destroying channel due to GNUNET_CADET_channel_destroy()\n");
1308 channel->disconnects = NULL;
1309 destroy_channel (channel);
1314 * Get information about a channel.
1316 * @param channel Channel handle.
1317 * @param option Query (GNUNET_CADET_OPTION_*).
1318 * @param ... dependant on option, currently not used
1320 * @return Union with an answer to the query.
1322 const union GNUNET_CADET_ChannelInfo *
1323 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
1324 enum GNUNET_CADET_ChannelOption option,
1327 static int bool_flag;
1331 case GNUNET_CADET_OPTION_NOBUFFER:
1332 case GNUNET_CADET_OPTION_RELIABLE:
1333 case GNUNET_CADET_OPTION_OUT_OF_ORDER:
1334 if (0 != (option & channel->options))
1335 bool_flag = GNUNET_YES;
1337 bool_flag = GNUNET_NO;
1338 return (const union GNUNET_CADET_ChannelInfo *) &bool_flag;
1340 case GNUNET_CADET_OPTION_PEER:
1341 return (const union GNUNET_CADET_ChannelInfo *) &channel->peer;
1351 * Send an ack on the channel to confirm the processing of a message.
1353 * @param ch Channel on which to send the ACK.
1356 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
1358 struct GNUNET_CADET_LocalAck *msg;
1359 struct GNUNET_MQ_Envelope *env;
1361 env = GNUNET_MQ_msg (msg,
1362 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
1363 LOG (GNUNET_ERROR_TYPE_DEBUG,
1364 "Sending ACK on channel %X\n",
1365 ntohl (channel->ccn.channel_of_client));
1366 msg->ccn = channel->ccn;
1367 GNUNET_MQ_send (channel->cadet->mq,
1373 * Send message of @a type to CADET service of @a h
1375 * @param h handle to CADET service
1376 * @param type message type of trivial information request to send
1379 send_info_request (struct GNUNET_CADET_Handle *h,
1382 struct GNUNET_MessageHeader *msg;
1383 struct GNUNET_MQ_Envelope *env;
1385 env = GNUNET_MQ_msg (msg,
1387 GNUNET_MQ_send (h->mq,
1393 * Request a debug dump on the service's STDERR.
1395 * WARNING: unstable API, likely to change in the future!
1397 * @param h cadet handle
1400 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h)
1402 send_info_request (h,
1403 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP);
1408 * Request information about peers known to the running cadet service.
1409 * The callback will be called for every peer known to the service.
1410 * Only one info request (of any kind) can be active at once.
1412 * WARNING: unstable API, likely to change in the future!
1414 * @param h Handle to the cadet peer.
1415 * @param callback Function to call with the requested data.
1416 * @param callback_cls Closure for @c callback.
1417 * @return #GNUNET_OK / #GNUNET_SYSERR
1420 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
1421 GNUNET_CADET_PeersCB callback,
1424 if (NULL != h->info_cb.peers_cb)
1427 return GNUNET_SYSERR;
1429 send_info_request (h,
1430 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
1431 h->info_cb.peers_cb = callback;
1432 h->info_cls = callback_cls;
1438 * Cancel a peer info request. The callback will not be called (anymore).
1440 * WARNING: unstable API, likely to change in the future!
1442 * @param h Cadet handle.
1443 * @return Closure given to GNUNET_CADET_get_peers().
1446 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h)
1448 void *cls = h->info_cls;
1450 h->info_cb.peers_cb = NULL;
1457 * Request information about a peer known to the running cadet peer.
1458 * The callback will be called for the tunnel once.
1459 * Only one info request (of any kind) can be active at once.
1461 * WARNING: unstable API, likely to change in the future!
1463 * @param h Handle to the cadet peer.
1464 * @param id Peer whose tunnel to examine.
1465 * @param callback Function to call with the requested data.
1466 * @param callback_cls Closure for @c callback.
1467 * @return #GNUNET_OK / #GNUNET_SYSERR
1470 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
1471 const struct GNUNET_PeerIdentity *id,
1472 GNUNET_CADET_PeerCB callback,
1475 struct GNUNET_CADET_LocalInfo *msg;
1476 struct GNUNET_MQ_Envelope *env;
1478 if (NULL != h->info_cb.peer_cb)
1481 return GNUNET_SYSERR;
1483 env = GNUNET_MQ_msg (msg,
1484 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
1486 GNUNET_MQ_send (h->mq,
1488 h->info_cb.peer_cb = callback;
1489 h->info_cls = callback_cls;
1495 * Request information about tunnels of the running cadet peer.
1496 * The callback will be called for every tunnel of the service.
1497 * Only one info request (of any kind) can be active at once.
1499 * WARNING: unstable API, likely to change in the future!
1501 * @param h Handle to the cadet peer.
1502 * @param callback Function to call with the requested data.
1503 * @param callback_cls Closure for @c callback.
1504 * @return #GNUNET_OK / #GNUNET_SYSERR
1507 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
1508 GNUNET_CADET_TunnelsCB callback,
1511 if (NULL != h->info_cb.tunnels_cb)
1514 return GNUNET_SYSERR;
1516 send_info_request (h,
1517 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
1518 h->info_cb.tunnels_cb = callback;
1519 h->info_cls = callback_cls;
1525 * Cancel a monitor request. The monitor callback will not be called.
1527 * @param h Cadet handle.
1528 * @return Closure given to GNUNET_CADET_get_tunnels().
1531 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h)
1533 void *cls = h->info_cls;
1535 h->info_cb.tunnels_cb = NULL;
1542 * Request information about a tunnel of the running cadet peer.
1543 * The callback will be called for the tunnel once.
1544 * Only one info request (of any kind) can be active at once.
1546 * WARNING: unstable API, likely to change in the future!
1548 * @param h Handle to the cadet peer.
1549 * @param id Peer whose tunnel to examine.
1550 * @param callback Function to call with the requested data.
1551 * @param callback_cls Closure for @c callback.
1552 * @return #GNUNET_OK / #GNUNET_SYSERR
1555 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
1556 const struct GNUNET_PeerIdentity *id,
1557 GNUNET_CADET_TunnelCB callback,
1560 struct GNUNET_CADET_LocalInfo *msg;
1561 struct GNUNET_MQ_Envelope *env;
1563 if (NULL != h->info_cb.tunnel_cb)
1566 return GNUNET_SYSERR;
1568 env = GNUNET_MQ_msg (msg,
1569 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
1571 GNUNET_MQ_send (h->mq,
1573 h->info_cb.tunnel_cb = callback;
1574 h->info_cls = callback_cls;
1580 * Transitional function to convert an unsigned int port to a hash value.
1581 * WARNING: local static value returned, NOT reentrant!
1582 * WARNING: do not use this function for new code!
1584 * @param port Numerical port (unsigned int format).
1586 * @return A GNUNET_HashCode usable for the new CADET API.
1588 const struct GNUNET_HashCode *
1589 GC_u2h (uint32_t port)
1591 static struct GNUNET_HashCode hash;
1593 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1594 "This is a transitional function, use proper crypto hashes as CADET ports\n");
1595 GNUNET_CRYPTO_hash (&port,
1603 * Connect to the MQ-based cadet service.
1605 * @param cfg Configuration to use.
1607 * @return Handle to the cadet service NULL on error.
1609 struct GNUNET_CADET_Handle *
1610 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
1612 struct GNUNET_CADET_Handle *h;
1614 LOG (GNUNET_ERROR_TYPE_DEBUG,
1615 "GNUNET_CADET_connect()\n");
1616 h = GNUNET_new (struct GNUNET_CADET_Handle);
1618 h->ports = GNUNET_CONTAINER_multihashmap_create (4,
1620 h->channels = GNUNET_CONTAINER_multihashmap32_create (4);
1625 GNUNET_CADET_disconnect (h);
1628 h->next_ccn.channel_of_client = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
1634 * Open a port to receive incomming MQ-based channels.
1636 * @param h CADET handle.
1637 * @param port Hash identifying the port.
1638 * @param connects Function called when an incoming channel is connected.
1639 * @param connects_cls Closure for the @a connects handler.
1640 * @param window_changes Function called when the transmit window size changes.
1641 * @param disconnects Function called when a channel is disconnected.
1642 * @param handlers Callbacks for messages we care about, NULL-terminated.
1643 * @return Port handle, NULL if port is in use
1645 struct GNUNET_CADET_Port *
1646 GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
1647 const struct GNUNET_HashCode *port,
1648 GNUNET_CADET_ConnectEventHandler connects,
1649 void * connects_cls,
1650 GNUNET_CADET_WindowSizeEventHandler window_changes,
1651 GNUNET_CADET_DisconnectEventHandler disconnects,
1652 const struct GNUNET_MQ_MessageHandler *handlers)
1654 struct GNUNET_CADET_Port *p;
1656 GNUNET_assert (NULL != connects);
1657 GNUNET_assert (NULL != disconnects);
1658 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1659 "Listening to CADET port %s\n",
1662 p = GNUNET_new (struct GNUNET_CADET_Port);
1666 GNUNET_CONTAINER_multihashmap_put (h->ports,
1669 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1674 p->connects = connects;
1675 p->cls = connects_cls;
1676 p->window_changes = window_changes;
1677 p->disconnects = disconnects;
1678 p->handlers = GNUNET_MQ_copy_handlers (handlers);
1680 GNUNET_assert (GNUNET_OK ==
1689 * Create a new channel towards a remote peer.
1691 * If the destination port is not open by any peer or the destination peer
1692 * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
1695 * @param h CADET handle.
1696 * @param channel_cls Closure for the channel. It's given to:
1697 * - The disconnect handler @a disconnects
1698 * - Each message type callback in @a handlers
1699 * @param destination Peer identity the channel should go to.
1700 * @param port Identification of the destination port.
1701 * @param options CadetOption flag field, with all desired option bits set to 1.
1702 * @param window_changes Function called when the transmit window size changes.
1703 * @param disconnects Function called when the channel is disconnected.
1704 * @param handlers Callbacks for messages we care about, NULL-terminated.
1705 * @return Handle to the channel.
1707 struct GNUNET_CADET_Channel *
1708 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
1710 const struct GNUNET_PeerIdentity *destination,
1711 const struct GNUNET_HashCode *port,
1712 enum GNUNET_CADET_ChannelOption options,
1713 GNUNET_CADET_WindowSizeEventHandler window_changes,
1714 GNUNET_CADET_DisconnectEventHandler disconnects,
1715 const struct GNUNET_MQ_MessageHandler *handlers)
1717 struct GNUNET_CADET_Channel *ch;
1718 struct GNUNET_CADET_LocalChannelCreateMessage *msg;
1719 struct GNUNET_MQ_Envelope *env;
1721 GNUNET_assert (NULL != disconnects);
1722 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1723 "Creating channel to peer %s at port %s\n",
1724 GNUNET_i2s (destination),
1726 ch = create_channel (h,
1728 ch->ctx = channel_cls;
1729 ch->peer = *destination;
1730 ch->options = options;
1731 ch->window_changes = window_changes;
1732 ch->disconnects = disconnects;
1734 /* Create MQ for channel */
1735 ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
1736 &cadet_mq_destroy_impl,
1737 &cadet_mq_cancel_impl,
1740 &cadet_mq_error_handler,
1742 GNUNET_MQ_set_handlers_closure (ch->mq,
1745 /* Request channel creation to service */
1746 env = GNUNET_MQ_msg (msg,
1747 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE);
1750 msg->peer = *destination;
1751 msg->opt = htonl (options);
1752 GNUNET_MQ_send (h->mq,
1759 * Obtain the message queue for a connected peer.
1761 * @param channel The channel handle from which to get the MQ.
1763 * @return NULL if @a channel is not yet connected.
1765 struct GNUNET_MQ_Handle *
1766 GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel)
1771 /* end of cadet_api.c */