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
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
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 * Reconnect callback: tries to reconnect again after a failer previous
365 * @param cls closure (cadet handle)
368 reconnect_cbk (void *cls)
370 struct GNUNET_CADET_Handle *h = cls;
372 h->reconnect_task = NULL;
378 * Function called during #reconnect() to destroy
379 * all channels that are still open.
381 * @param cls the `struct GNUNET_CADET_Handle`
382 * @param cid chanenl ID
383 * @param value a `struct GNUNET_CADET_Channel` to destroy
384 * @return #GNUNET_OK (continue to iterate)
387 destroy_channel_on_reconnect_cb (void *cls,
391 /* struct GNUNET_CADET_Handle *handle = cls; */
392 struct GNUNET_CADET_Channel *ch = value;
394 destroy_channel (ch);
400 * Reconnect to the service, retransmit all infomation to try to restore the
403 * @param h handle to the cadet
405 * @return #GNUNET_YES in case of sucess, #GNUNET_NO otherwise (service down...)
408 schedule_reconnect (struct GNUNET_CADET_Handle *h)
410 if (NULL != h->reconnect_task)
412 GNUNET_CONTAINER_multihashmap32_iterate (h->channels,
413 &destroy_channel_on_reconnect_cb,
416 = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
420 = GNUNET_TIME_STD_BACKOFF (h->reconnect_time);
425 * Notify the application about a change in the window size (if needed).
427 * @param ch Channel to notify about.
430 notify_window_size (struct GNUNET_CADET_Channel *ch)
432 if (NULL != ch->window_changes)
433 ch->window_changes (ch->ctx,
434 ch, /* FIXME: remove 'ch'? */
440 * Transmit the next message from our queue.
442 * @param cls Closure (channel whose mq to activate).
445 cadet_mq_send_now (void *cls)
447 struct GNUNET_CADET_Channel *ch = cls;
448 struct GNUNET_MQ_Envelope *env = ch->pending_env;
451 if (0 == ch->allow_send)
453 /* how did we get here? */
459 /* how did we get here? */
464 ch->pending_env = NULL;
465 GNUNET_MQ_send (ch->cadet->mq,
467 GNUNET_MQ_impl_send_continue (ch->mq);
472 * Implement sending functionality of a message queue for
473 * us sending messages to a peer.
475 * Encapsulates the payload message in a #GNUNET_CADET_LocalData message
476 * in order to label the message with the channel ID and send the
477 * encapsulated message to the service.
479 * @param mq the message queue
480 * @param msg the message to send
481 * @param impl_state state of the implementation
484 cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq,
485 const struct GNUNET_MessageHeader *msg,
488 struct GNUNET_CADET_Channel *ch = impl_state;
489 struct GNUNET_CADET_Handle *h = ch->cadet;
491 struct GNUNET_MQ_Envelope *env;
492 struct GNUNET_CADET_LocalData *cadet_msg;
496 /* We're currently reconnecting, pretend this worked */
497 GNUNET_MQ_impl_send_continue (mq);
501 /* check message size for sanity */
502 msize = ntohs (msg->size);
503 if (msize > GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE)
506 GNUNET_MQ_impl_send_continue (mq);
509 env = GNUNET_MQ_msg_nested_mh (cadet_msg,
510 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
512 cadet_msg->ccn = ch->ccn;
513 GNUNET_assert (NULL == ch->pending_env);
514 ch->pending_env = env;
515 if (0 < ch->allow_send)
517 = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
523 * Handle destruction of a message queue. Implementations must not
524 * free @a mq, but should take care of @a impl_state.
526 * @param mq the message queue to destroy
527 * @param impl_state state of the implementation
530 cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq,
533 struct GNUNET_CADET_Channel *ch = impl_state;
535 GNUNET_assert (mq == ch->mq);
541 * We had an error processing a message we forwarded from a peer to
542 * the CADET service. We should just complain about it but otherwise
543 * continue processing.
545 * @param cls closure with our `struct GNUNET_CADET_Channel`
546 * @param error error code
549 cadet_mq_error_handler (void *cls,
550 enum GNUNET_MQ_Error error)
552 struct GNUNET_CADET_Channel *ch = cls;
555 if (GNUNET_MQ_ERROR_NO_MATCH == error)
557 /* Got a message we did not understand, still try to continue! */
558 GNUNET_CADET_receive_done (ch);
562 schedule_reconnect (ch->cadet);
568 * Implementation function that cancels the currently sent message.
569 * Should basically undo whatever #mq_send_impl() did.
571 * @param mq message queue
572 * @param impl_state state specific to the implementation
575 cadet_mq_cancel_impl (struct GNUNET_MQ_Handle *mq,
578 struct GNUNET_CADET_Channel *ch = impl_state;
580 GNUNET_assert (NULL != ch->pending_env);
581 GNUNET_MQ_discard (ch->pending_env);
582 ch->pending_env = NULL;
583 if (NULL != ch->mq_cont)
585 GNUNET_SCHEDULER_cancel (ch->mq_cont);
592 * Process the new channel notification and add it to the channels in the handle
594 * @param h The cadet handle
595 * @param msg A message with the details of the new incoming channel
598 handle_channel_created (void *cls,
599 const struct GNUNET_CADET_LocalChannelCreateMessage *msg)
601 struct GNUNET_CADET_Handle *h = cls;
602 struct GNUNET_CADET_Channel *ch;
603 struct GNUNET_CADET_Port *port;
604 const struct GNUNET_HashCode *port_number;
605 struct GNUNET_CADET_ClientChannelNumber ccn;
608 port_number = &msg->port;
609 if (ntohl (ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
618 /* We could have closed the port but the service didn't know about it yet
619 * This is not an error.
621 struct GNUNET_CADET_LocalChannelDestroyMessage *d_msg;
622 struct GNUNET_MQ_Envelope *env;
624 LOG (GNUNET_ERROR_TYPE_DEBUG,
625 "No handler for incoming channel %X (on port %s, recently closed?)\n",
626 ntohl (ccn.channel_of_client),
627 GNUNET_h2s (port_number));
628 env = GNUNET_MQ_msg (d_msg,
629 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
630 d_msg->ccn = msg->ccn;
631 GNUNET_MQ_send (h->mq,
636 ch = create_channel (h,
638 ch->peer = msg->peer;
640 ch->incoming_port = port;
641 ch->options = ntohl (msg->opt);
642 LOG (GNUNET_ERROR_TYPE_DEBUG,
643 "Creating incoming channel %X [%s] %p\n",
644 ntohl (ccn.channel_of_client),
645 GNUNET_h2s (port_number),
648 GNUNET_assert (NULL != port->connects);
649 ch->window_changes = port->window_changes;
650 ch->disconnects = port->disconnects;
651 ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
652 &cadet_mq_destroy_impl,
653 &cadet_mq_cancel_impl,
656 &cadet_mq_error_handler,
658 ch->ctx = port->connects (port->cls,
661 GNUNET_MQ_set_handlers_closure (ch->mq,
667 * Process the channel destroy notification and free associated resources
669 * @param h The cadet handle
670 * @param msg A message with the details of the channel being destroyed
673 handle_channel_destroy (void *cls,
674 const struct GNUNET_CADET_LocalChannelDestroyMessage *msg)
676 struct GNUNET_CADET_Handle *h = cls;
677 struct GNUNET_CADET_Channel *ch;
679 ch = find_channel (h,
683 LOG (GNUNET_ERROR_TYPE_DEBUG,
684 "Received channel destroy for unknown channel %X from CADET service (recently close?)\n",
685 ntohl (msg->ccn.channel_of_client));
688 LOG (GNUNET_ERROR_TYPE_DEBUG,
689 "Received channel destroy for channel %X from CADET service\n",
690 ntohl (msg->ccn.channel_of_client));
691 destroy_channel (ch);
696 * Check that message received from CADET service is well-formed.
698 * @param cls the `struct GNUNET_CADET_Handle`
699 * @param message the message we got
700 * @return #GNUNET_OK if the message is well-formed,
701 * #GNUNET_SYSERR otherwise
704 check_local_data (void *cls,
705 const struct GNUNET_CADET_LocalData *message)
709 size = ntohs (message->header.size);
710 if (sizeof (*message) + sizeof (struct GNUNET_MessageHeader) > size)
713 return GNUNET_SYSERR;
720 * Process the incoming data packets, call appropriate handlers.
722 * @param h The cadet handle
723 * @param message A message encapsulating the data
726 handle_local_data (void *cls,
727 const struct GNUNET_CADET_LocalData *message)
729 struct GNUNET_CADET_Handle *h = cls;
730 const struct GNUNET_MessageHeader *payload;
731 struct GNUNET_CADET_Channel *ch;
735 ch = find_channel (h,
739 LOG (GNUNET_ERROR_TYPE_DEBUG,
740 "Unknown channel %X for incoming data (recently closed?)\n",
741 ntohl (message->ccn.channel_of_client));
745 payload = (const struct GNUNET_MessageHeader *) &message[1];
746 type = ntohs (payload->type);
747 fwd = ntohl (ch->ccn.channel_of_client) <= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
748 LOG (GNUNET_ERROR_TYPE_DEBUG,
749 "Got a %s data on channel %s [%X] of type %u\n",
751 GNUNET_i2s (&ch->peer),
752 ntohl (message->ccn.channel_of_client),
754 GNUNET_MQ_inject_message (ch->mq,
760 * Process a local ACK message, enabling the client to send
761 * more data to the service.
763 * @param h Cadet handle.
764 * @param message Message itself.
767 handle_local_ack (void *cls,
768 const struct GNUNET_CADET_LocalAck *message)
770 struct GNUNET_CADET_Handle *h = cls;
771 struct GNUNET_CADET_Channel *ch;
773 ch = find_channel (h,
777 LOG (GNUNET_ERROR_TYPE_DEBUG,
778 "ACK on unknown channel %X\n",
779 ntohl (message->ccn.channel_of_client));
783 if (NULL == ch->pending_env)
785 LOG (GNUNET_ERROR_TYPE_DEBUG,
786 "Got an ACK on mq channel %X, allow send now %u!\n",
787 ntohl (ch->ccn.channel_of_client),
789 notify_window_size (ch);
792 if (NULL != ch->mq_cont)
793 return; /* already working on it! */
794 LOG (GNUNET_ERROR_TYPE_DEBUG,
795 "Got an ACK on mq channel %X, sending pending message!\n",
796 ntohl (ch->ccn.channel_of_client));
798 = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
804 * Generic error handler, called with the appropriate error code and
805 * the same closure specified at the creation of the message queue.
806 * Not every message queue implementation supports an error handler.
808 * @param cls closure, a `struct GNUNET_CORE_Handle *`
809 * @param error error code
812 handle_mq_error (void *cls,
813 enum GNUNET_MQ_Error error)
815 struct GNUNET_CADET_Handle *h = cls;
817 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
820 GNUNET_MQ_destroy (h->mq);
827 * Check that message received from CADET service is well-formed.
829 * @param cls the `struct GNUNET_CADET_Handle`
830 * @param message the message we got
831 * @return #GNUNET_OK if the message is well-formed,
832 * #GNUNET_SYSERR otherwise
835 check_get_peers (void *cls,
836 const struct GNUNET_MessageHeader *message)
840 esize = ntohs (message->size);
841 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == esize)
843 if (sizeof (struct GNUNET_MessageHeader) == esize)
845 return GNUNET_SYSERR;
850 * Process a local reply about info on all tunnels, pass info to the user.
852 * @param cls Closure (Cadet handle).
853 * @param msg Message itself.
856 handle_get_peers (void *cls,
857 const struct GNUNET_MessageHeader *msg)
859 struct GNUNET_CADET_Handle *h = cls;
860 const struct GNUNET_CADET_LocalInfoPeer *info =
861 (const struct GNUNET_CADET_LocalInfoPeer *) msg;
863 if (NULL == h->info_cb.peers_cb)
865 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == ntohs (msg->size))
866 h->info_cb.peers_cb (h->info_cls,
868 (int) ntohs (info->tunnel),
869 (unsigned int) ntohs (info->paths),
872 h->info_cb.peers_cb (h->info_cls,
881 * Check that message received from CADET service is well-formed.
883 * @param cls the `struct GNUNET_CADET_Handle`
884 * @param message the message we got
885 * @return #GNUNET_OK if the message is well-formed,
886 * #GNUNET_SYSERR otherwise
889 check_get_peer (void *cls,
890 const struct GNUNET_CADET_LocalInfoPeer *message)
892 size_t msize = sizeof (struct GNUNET_CADET_LocalInfoPeer);
893 const struct GNUNET_PeerIdentity *paths_array;
899 esize = ntohs (message->header.size);
903 return GNUNET_SYSERR;
905 if (0 != ((esize - msize) % sizeof (struct GNUNET_PeerIdentity)))
908 return GNUNET_SYSERR;
910 peers = (esize - msize) / sizeof (struct GNUNET_PeerIdentity);
911 epaths = ntohs (message->paths);
912 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
914 for (unsigned int i = 0; i < peers; i++)
915 if (0 == memcmp (&paths_array[i],
916 &message->destination,
917 sizeof (struct GNUNET_PeerIdentity)))
922 return GNUNET_SYSERR;
929 * Process a local peer info reply, pass info to the user.
931 * @param cls Closure (Cadet handle).
932 * @param message Message itself.
935 handle_get_peer (void *cls,
936 const struct GNUNET_CADET_LocalInfoPeer *message)
938 struct GNUNET_CADET_Handle *h = cls;
939 const struct GNUNET_PeerIdentity *paths_array;
941 unsigned int path_length;
945 if (NULL == h->info_cb.peer_cb)
947 paths = ntohs (message->paths);
948 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
949 peers = (ntohs (message->header.size) - sizeof (*message))
950 / sizeof (struct GNUNET_PeerIdentity);
952 neighbor = GNUNET_NO;
954 for (unsigned int i = 0; i < peers; i++)
956 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
958 GNUNET_i2s (&paths_array[i]));
960 if (0 == memcmp (&paths_array[i], &message->destination,
961 sizeof (struct GNUNET_PeerIdentity)))
963 if (1 == path_length)
964 neighbor = GNUNET_YES;
969 /* Call Callback with tunnel info. */
970 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
971 h->info_cb.peer_cb (h->info_cls,
972 &message->destination,
973 (int) ntohs (message->tunnel),
981 * Check that message received from CADET service is well-formed.
983 * @param cls the `struct GNUNET_CADET_Handle`
984 * @param message the message we got
985 * @return #GNUNET_OK if the message is well-formed,
986 * #GNUNET_SYSERR otherwise
989 check_get_tunnels (void *cls,
990 const struct GNUNET_MessageHeader *message)
994 esize = ntohs (message->size);
995 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == esize)
997 if (sizeof (struct GNUNET_MessageHeader) == esize)
999 return GNUNET_SYSERR;
1004 * Process a local reply about info on all tunnels, pass info to the user.
1006 * @param cls Closure (Cadet handle).
1007 * @param message Message itself.
1010 handle_get_tunnels (void *cls,
1011 const struct GNUNET_MessageHeader *msg)
1013 struct GNUNET_CADET_Handle *h = cls;
1014 const struct GNUNET_CADET_LocalInfoTunnel *info =
1015 (const struct GNUNET_CADET_LocalInfoTunnel *) msg;
1017 if (NULL == h->info_cb.tunnels_cb)
1019 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == ntohs (msg->size))
1020 h->info_cb.tunnels_cb (h->info_cls,
1022 ntohl (info->channels),
1023 ntohl (info->connections),
1024 ntohs (info->estate),
1025 ntohs (info->cstate));
1027 h->info_cb.tunnels_cb (h->info_cls,
1037 * Check that message received from CADET service is well-formed.
1039 * @param cls the `struct GNUNET_CADET_Handle`
1040 * @param msg the message we got
1041 * @return #GNUNET_OK if the message is well-formed,
1042 * #GNUNET_SYSERR otherwise
1045 check_get_tunnel (void *cls,
1046 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1053 /* Verify message sanity */
1054 msize = ntohs (msg->header.size);
1055 esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1059 return GNUNET_SYSERR;
1061 ch_n = ntohl (msg->channels);
1062 c_n = ntohl (msg->connections);
1063 esize += ch_n * sizeof (struct GNUNET_CADET_ChannelTunnelNumber);
1064 esize += c_n * sizeof (struct GNUNET_CADET_ConnectionTunnelIdentifier);
1067 GNUNET_break_op (0);
1068 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1069 "m:%u, e: %u (%u ch, %u conn)\n",
1070 (unsigned int) msize,
1071 (unsigned int) esize,
1074 return GNUNET_SYSERR;
1081 * Process a local tunnel info reply, pass info to the user.
1083 * @param cls Closure (Cadet handle).
1084 * @param msg Message itself.
1087 handle_get_tunnel (void *cls,
1088 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1090 struct GNUNET_CADET_Handle *h = cls;
1093 const struct GNUNET_CADET_ConnectionTunnelIdentifier *conns;
1094 const struct GNUNET_CADET_ChannelTunnelNumber *chns;
1096 if (NULL == h->info_cb.tunnel_cb)
1099 ch_n = ntohl (msg->channels);
1100 c_n = ntohl (msg->connections);
1102 /* Call Callback with tunnel info. */
1103 conns = (const struct GNUNET_CADET_ConnectionTunnelIdentifier *) &msg[1];
1104 chns = (const struct GNUNET_CADET_ChannelTunnelNumber *) &conns[c_n];
1105 h->info_cb.tunnel_cb (h->info_cls,
1111 ntohs (msg->estate),
1112 ntohs (msg->cstate));
1117 * Reconnect to the service, retransmit all infomation to try to restore the
1120 * @param h handle to the cadet
1123 reconnect (struct GNUNET_CADET_Handle *h)
1125 struct GNUNET_MQ_MessageHandler handlers[] = {
1126 GNUNET_MQ_hd_fixed_size (channel_created,
1127 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE,
1128 struct GNUNET_CADET_LocalChannelCreateMessage,
1130 GNUNET_MQ_hd_fixed_size (channel_destroy,
1131 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY,
1132 struct GNUNET_CADET_LocalChannelDestroyMessage,
1134 GNUNET_MQ_hd_var_size (local_data,
1135 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
1136 struct GNUNET_CADET_LocalData,
1138 GNUNET_MQ_hd_fixed_size (local_ack,
1139 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK,
1140 struct GNUNET_CADET_LocalAck,
1142 GNUNET_MQ_hd_var_size (get_peers,
1143 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS,
1144 struct GNUNET_MessageHeader,
1146 GNUNET_MQ_hd_var_size (get_peer,
1147 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER,
1148 struct GNUNET_CADET_LocalInfoPeer,
1150 GNUNET_MQ_hd_var_size (get_tunnels,
1151 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS,
1152 struct GNUNET_MessageHeader,
1154 GNUNET_MQ_hd_var_size (get_tunnel,
1155 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL,
1156 struct GNUNET_CADET_LocalInfoTunnel,
1158 GNUNET_MQ_handler_end ()
1161 GNUNET_assert (NULL == h->mq);
1162 h->mq = GNUNET_CLIENT_connect (h->cfg,
1169 schedule_reconnect (h);
1172 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1177 * Function called during #GNUNET_CADET_disconnect() to destroy
1178 * all channels that are still open.
1180 * @param cls the `struct GNUNET_CADET_Handle`
1181 * @param cid chanenl ID
1182 * @param value a `struct GNUNET_CADET_Channel` to destroy
1183 * @return #GNUNET_OK (continue to iterate)
1186 destroy_channel_cb (void *cls,
1190 /* struct GNUNET_CADET_Handle *handle = cls; */
1191 struct GNUNET_CADET_Channel *ch = value;
1193 if (ntohl (ch->ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
1196 LOG (GNUNET_ERROR_TYPE_DEBUG,
1197 "channel %X not destroyed\n",
1198 ntohl (ch->ccn.channel_of_client));
1200 destroy_channel (ch);
1206 * Function called during #GNUNET_CADET_disconnect() to destroy
1207 * all ports that are still open.
1209 * @param cls the `struct GNUNET_CADET_Handle`
1211 * @param value a `struct GNUNET_CADET_Channel` to destroy
1212 * @return #GNUNET_OK (continue to iterate)
1215 destroy_port_cb (void *cls,
1216 const struct GNUNET_HashCode *id,
1219 /* struct GNUNET_CADET_Handle *handle = cls; */
1220 struct GNUNET_CADET_Port *port = value;
1222 /* This is a warning, the app should have cleanly closed all open ports */
1224 GNUNET_CADET_close_port (port);
1230 * Disconnect from the cadet service. All channels will be destroyed. All channel
1231 * disconnect callbacks will be called on any still connected peers, notifying
1232 * about their disconnection. The registered inbound channel cleaner will be
1233 * called should any inbound channels still exist.
1235 * @param handle connection to cadet to disconnect
1238 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
1240 GNUNET_CONTAINER_multihashmap_iterate (handle->ports,
1243 GNUNET_CONTAINER_multihashmap_destroy (handle->ports);
1244 handle->ports = NULL;
1245 GNUNET_CONTAINER_multihashmap32_iterate (handle->channels,
1246 &destroy_channel_cb,
1248 GNUNET_CONTAINER_multihashmap32_destroy (handle->channels);
1249 handle->channels = NULL;
1250 if (NULL != handle->mq)
1252 GNUNET_MQ_destroy (handle->mq);
1255 if (NULL != handle->reconnect_task)
1257 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1258 handle->reconnect_task = NULL;
1260 GNUNET_free (handle);
1265 * Close a port opened with @a GNUNET_CADET_open_port().
1266 * The @a new_channel callback will no longer be called.
1268 * @param p Port handle.
1271 GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p)
1273 struct GNUNET_CADET_PortMessage *msg;
1274 struct GNUNET_MQ_Envelope *env;
1276 env = GNUNET_MQ_msg (msg,
1277 GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE);
1279 GNUNET_MQ_send (p->cadet->mq,
1281 GNUNET_assert (GNUNET_YES ==
1282 GNUNET_CONTAINER_multihashmap_remove (p->cadet->ports,
1285 GNUNET_free_non_null (p->handlers);
1291 * Destroy an existing channel.
1293 * The existing end callback for the channel will be called immediately.
1294 * Any pending outgoing messages will be sent but no incoming messages will be
1295 * accepted and no data callbacks will be called.
1297 * @param channel Channel handle, becomes invalid after this call.
1300 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
1302 struct GNUNET_CADET_Handle *h = channel->cadet;
1303 struct GNUNET_CADET_LocalChannelDestroyMessage *msg;
1304 struct GNUNET_MQ_Envelope *env;
1308 env = GNUNET_MQ_msg (msg,
1309 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
1310 msg->ccn = channel->ccn;
1311 GNUNET_MQ_send (h->mq,
1314 destroy_channel (channel);
1319 * Get information about a channel.
1321 * @param channel Channel handle.
1322 * @param option Query (GNUNET_CADET_OPTION_*).
1323 * @param ... dependant on option, currently not used
1325 * @return Union with an answer to the query.
1327 const union GNUNET_CADET_ChannelInfo *
1328 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
1329 enum GNUNET_CADET_ChannelOption option,
1332 static int bool_flag;
1336 case GNUNET_CADET_OPTION_NOBUFFER:
1337 case GNUNET_CADET_OPTION_RELIABLE:
1338 case GNUNET_CADET_OPTION_OUT_OF_ORDER:
1339 if (0 != (option & channel->options))
1340 bool_flag = GNUNET_YES;
1342 bool_flag = GNUNET_NO;
1343 return (const union GNUNET_CADET_ChannelInfo *) &bool_flag;
1345 case GNUNET_CADET_OPTION_PEER:
1346 return (const union GNUNET_CADET_ChannelInfo *) &channel->peer;
1356 * Send an ack on the channel to confirm the processing of a message.
1358 * @param ch Channel on which to send the ACK.
1361 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
1363 struct GNUNET_CADET_LocalAck *msg;
1364 struct GNUNET_MQ_Envelope *env;
1366 env = GNUNET_MQ_msg (msg,
1367 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
1368 LOG (GNUNET_ERROR_TYPE_DEBUG,
1369 "Sending ACK on channel %X\n",
1370 ntohl (channel->ccn.channel_of_client));
1371 msg->ccn = channel->ccn;
1372 GNUNET_MQ_send (channel->cadet->mq,
1378 * Send message of @a type to CADET service of @a h
1380 * @param h handle to CADET service
1381 * @param type message type of trivial information request to send
1384 send_info_request (struct GNUNET_CADET_Handle *h,
1387 struct GNUNET_MessageHeader *msg;
1388 struct GNUNET_MQ_Envelope *env;
1390 env = GNUNET_MQ_msg (msg,
1392 GNUNET_MQ_send (h->mq,
1398 * Request a debug dump on the service's STDERR.
1400 * WARNING: unstable API, likely to change in the future!
1402 * @param h cadet handle
1405 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h)
1407 send_info_request (h,
1408 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP);
1413 * Request information about peers known to the running cadet service.
1414 * The callback will be called for every peer known to the service.
1415 * Only one info request (of any kind) can be active at once.
1417 * WARNING: unstable API, likely to change in the future!
1419 * @param h Handle to the cadet peer.
1420 * @param callback Function to call with the requested data.
1421 * @param callback_cls Closure for @c callback.
1422 * @return #GNUNET_OK / #GNUNET_SYSERR
1425 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
1426 GNUNET_CADET_PeersCB callback,
1429 if (NULL != h->info_cb.peers_cb)
1432 return GNUNET_SYSERR;
1434 send_info_request (h,
1435 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
1436 h->info_cb.peers_cb = callback;
1437 h->info_cls = callback_cls;
1443 * Cancel a peer info request. The callback will not be called (anymore).
1445 * WARNING: unstable API, likely to change in the future!
1447 * @param h Cadet handle.
1448 * @return Closure given to GNUNET_CADET_get_peers().
1451 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h)
1453 void *cls = h->info_cls;
1455 h->info_cb.peers_cb = NULL;
1462 * Request information about a peer known to the running cadet peer.
1463 * The callback will be called for the tunnel once.
1464 * Only one info request (of any kind) can be active at once.
1466 * WARNING: unstable API, likely to change in the future!
1468 * @param h Handle to the cadet peer.
1469 * @param id Peer whose tunnel to examine.
1470 * @param callback Function to call with the requested data.
1471 * @param callback_cls Closure for @c callback.
1472 * @return #GNUNET_OK / #GNUNET_SYSERR
1475 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
1476 const struct GNUNET_PeerIdentity *id,
1477 GNUNET_CADET_PeerCB callback,
1480 struct GNUNET_CADET_LocalInfo *msg;
1481 struct GNUNET_MQ_Envelope *env;
1483 if (NULL != h->info_cb.peer_cb)
1486 return GNUNET_SYSERR;
1488 env = GNUNET_MQ_msg (msg,
1489 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
1491 GNUNET_MQ_send (h->mq,
1493 h->info_cb.peer_cb = callback;
1494 h->info_cls = callback_cls;
1500 * Request information about tunnels of the running cadet peer.
1501 * The callback will be called for every tunnel of the service.
1502 * Only one info request (of any kind) can be active at once.
1504 * WARNING: unstable API, likely to change in the future!
1506 * @param h Handle to the cadet peer.
1507 * @param callback Function to call with the requested data.
1508 * @param callback_cls Closure for @c callback.
1509 * @return #GNUNET_OK / #GNUNET_SYSERR
1512 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
1513 GNUNET_CADET_TunnelsCB callback,
1516 if (NULL != h->info_cb.tunnels_cb)
1519 return GNUNET_SYSERR;
1521 send_info_request (h,
1522 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
1523 h->info_cb.tunnels_cb = callback;
1524 h->info_cls = callback_cls;
1530 * Cancel a monitor request. The monitor callback will not be called.
1532 * @param h Cadet handle.
1533 * @return Closure given to GNUNET_CADET_get_tunnels().
1536 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h)
1538 void *cls = h->info_cls;
1540 h->info_cb.tunnels_cb = NULL;
1547 * Request information about a tunnel of the running cadet peer.
1548 * The callback will be called for the tunnel once.
1549 * Only one info request (of any kind) can be active at once.
1551 * WARNING: unstable API, likely to change in the future!
1553 * @param h Handle to the cadet peer.
1554 * @param id Peer whose tunnel to examine.
1555 * @param callback Function to call with the requested data.
1556 * @param callback_cls Closure for @c callback.
1557 * @return #GNUNET_OK / #GNUNET_SYSERR
1560 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
1561 const struct GNUNET_PeerIdentity *id,
1562 GNUNET_CADET_TunnelCB callback,
1565 struct GNUNET_CADET_LocalInfo *msg;
1566 struct GNUNET_MQ_Envelope *env;
1568 if (NULL != h->info_cb.tunnel_cb)
1571 return GNUNET_SYSERR;
1573 env = GNUNET_MQ_msg (msg,
1574 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
1576 GNUNET_MQ_send (h->mq,
1578 h->info_cb.tunnel_cb = callback;
1579 h->info_cls = callback_cls;
1585 * Transitional function to convert an unsigned int port to a hash value.
1586 * WARNING: local static value returned, NOT reentrant!
1587 * WARNING: do not use this function for new code!
1589 * @param port Numerical port (unsigned int format).
1591 * @return A GNUNET_HashCode usable for the new CADET API.
1593 const struct GNUNET_HashCode *
1594 GC_u2h (uint32_t port)
1596 static struct GNUNET_HashCode hash;
1598 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1599 "This is a transitional function, use proper crypto hashes as CADET ports\n");
1600 GNUNET_CRYPTO_hash (&port,
1608 * Connect to the MQ-based cadet service.
1610 * @param cfg Configuration to use.
1612 * @return Handle to the cadet service NULL on error.
1614 struct GNUNET_CADET_Handle *
1615 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
1617 struct GNUNET_CADET_Handle *h;
1619 LOG (GNUNET_ERROR_TYPE_DEBUG,
1620 "GNUNET_CADET_connect()\n");
1621 h = GNUNET_new (struct GNUNET_CADET_Handle);
1623 h->ports = GNUNET_CONTAINER_multihashmap_create (4,
1625 h->channels = GNUNET_CONTAINER_multihashmap32_create (4);
1630 GNUNET_CADET_disconnect (h);
1633 h->next_ccn.channel_of_client = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
1634 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1635 h->reconnect_task = NULL;
1642 * Open a port to receive incomming MQ-based channels.
1644 * @param h CADET handle.
1645 * @param port Hash identifying the port.
1646 * @param connects Function called when an incoming channel is connected.
1647 * @param connects_cls Closure for the @a connects handler.
1648 * @param window_changes Function called when the transmit window size changes.
1649 * @param disconnects Function called when a channel is disconnected.
1650 * @param handlers Callbacks for messages we care about, NULL-terminated.
1651 * @return Port handle, NULL if port is in use
1653 struct GNUNET_CADET_Port *
1654 GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
1655 const struct GNUNET_HashCode *port,
1656 GNUNET_CADET_ConnectEventHandler connects,
1657 void * connects_cls,
1658 GNUNET_CADET_WindowSizeEventHandler window_changes,
1659 GNUNET_CADET_DisconnectEventHandler disconnects,
1660 const struct GNUNET_MQ_MessageHandler *handlers)
1662 struct GNUNET_CADET_PortMessage *msg;
1663 struct GNUNET_MQ_Envelope *env;
1664 struct GNUNET_CADET_Port *p;
1666 GNUNET_assert (NULL != connects);
1667 GNUNET_assert (NULL != disconnects);
1668 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1669 "Listening to CADET port %s\n",
1672 p = GNUNET_new (struct GNUNET_CADET_Port);
1676 GNUNET_CONTAINER_multihashmap_put (h->ports,
1679 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1684 p->connects = connects;
1685 p->cls = connects_cls;
1686 p->window_changes = window_changes;
1687 p->disconnects = disconnects;
1688 p->handlers = GNUNET_MQ_copy_handlers (handlers);
1691 env = GNUNET_MQ_msg (msg,
1692 GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN);
1694 GNUNET_MQ_send (h->mq,
1701 * Create a new channel towards a remote peer.
1703 * If the destination port is not open by any peer or the destination peer
1704 * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
1707 * @param h CADET handle.
1708 * @param channel_cls Closure for the channel. It's given to:
1709 * - The disconnect handler @a disconnects
1710 * - Each message type callback in @a handlers
1711 * @param destination Peer identity the channel should go to.
1712 * @param port Identification of the destination port.
1713 * @param options CadetOption flag field, with all desired option bits set to 1.
1714 * @param window_changes Function called when the transmit window size changes.
1715 * @param disconnects Function called when the channel is disconnected.
1716 * @param handlers Callbacks for messages we care about, NULL-terminated.
1717 * @return Handle to the channel.
1719 struct GNUNET_CADET_Channel *
1720 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
1722 const struct GNUNET_PeerIdentity *destination,
1723 const struct GNUNET_HashCode *port,
1724 enum GNUNET_CADET_ChannelOption options,
1725 GNUNET_CADET_WindowSizeEventHandler window_changes,
1726 GNUNET_CADET_DisconnectEventHandler disconnects,
1727 const struct GNUNET_MQ_MessageHandler *handlers)
1729 struct GNUNET_CADET_Channel *ch;
1730 struct GNUNET_CADET_LocalChannelCreateMessage *msg;
1731 struct GNUNET_MQ_Envelope *env;
1733 GNUNET_assert (NULL != disconnects);
1734 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1735 "Creating channel to peer %s at port %s\n",
1736 GNUNET_i2s (destination),
1738 ch = create_channel (h,
1740 ch->ctx = channel_cls;
1741 ch->peer = *destination;
1742 ch->options = options;
1743 ch->window_changes = window_changes;
1744 ch->disconnects = disconnects;
1746 /* Create MQ for channel */
1747 ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
1748 &cadet_mq_destroy_impl,
1749 &cadet_mq_cancel_impl,
1752 &cadet_mq_error_handler,
1754 GNUNET_MQ_set_handlers_closure (ch->mq, channel_cls);
1756 /* Request channel creation to service */
1757 env = GNUNET_MQ_msg (msg,
1758 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE);
1761 msg->peer = *destination;
1762 msg->opt = htonl (options);
1763 GNUNET_MQ_send (h->mq,
1770 * Obtain the message queue for a connected peer.
1772 * @param channel The channel handle from which to get the MQ.
1774 * @return NULL if @a channel is not yet connected.
1776 struct GNUNET_MQ_Handle *
1777 GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel)
1782 /* end of cadet_api.c */