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 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
395 "Destroying channel due to reconnect\n");
396 destroy_channel (ch);
402 * Reconnect to the service, retransmit all infomation to try to restore the
405 * @param h handle to the cadet
407 * @return #GNUNET_YES in case of sucess, #GNUNET_NO otherwise (service down...)
410 schedule_reconnect (struct GNUNET_CADET_Handle *h)
412 if (NULL != h->reconnect_task)
414 GNUNET_CONTAINER_multihashmap32_iterate (h->channels,
415 &destroy_channel_on_reconnect_cb,
418 = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
422 = GNUNET_TIME_STD_BACKOFF (h->reconnect_time);
427 * Notify the application about a change in the window size (if needed).
429 * @param ch Channel to notify about.
432 notify_window_size (struct GNUNET_CADET_Channel *ch)
434 if (NULL != ch->window_changes)
435 ch->window_changes (ch->ctx,
436 ch, /* FIXME: remove 'ch'? */
442 * Transmit the next message from our queue.
444 * @param cls Closure (channel whose mq to activate).
447 cadet_mq_send_now (void *cls)
449 struct GNUNET_CADET_Channel *ch = cls;
450 struct GNUNET_MQ_Envelope *env = ch->pending_env;
453 if (0 == ch->allow_send)
455 /* how did we get here? */
461 /* how did we get here? */
466 ch->pending_env = NULL;
467 GNUNET_MQ_send (ch->cadet->mq,
469 GNUNET_MQ_impl_send_continue (ch->mq);
474 * Implement sending functionality of a message queue for
475 * us sending messages to a peer.
477 * Encapsulates the payload message in a #GNUNET_CADET_LocalData message
478 * in order to label the message with the channel ID and send the
479 * encapsulated message to the service.
481 * @param mq the message queue
482 * @param msg the message to send
483 * @param impl_state state of the implementation
486 cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq,
487 const struct GNUNET_MessageHeader *msg,
490 struct GNUNET_CADET_Channel *ch = impl_state;
491 struct GNUNET_CADET_Handle *h = ch->cadet;
493 struct GNUNET_MQ_Envelope *env;
494 struct GNUNET_CADET_LocalData *cadet_msg;
498 /* We're currently reconnecting, pretend this worked */
499 GNUNET_MQ_impl_send_continue (mq);
503 /* check message size for sanity */
504 msize = ntohs (msg->size);
505 if (msize > GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE)
508 GNUNET_MQ_impl_send_continue (mq);
511 env = GNUNET_MQ_msg_nested_mh (cadet_msg,
512 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
514 cadet_msg->ccn = ch->ccn;
515 GNUNET_assert (NULL == ch->pending_env);
516 ch->pending_env = env;
517 if (0 < ch->allow_send)
519 = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
525 * Handle destruction of a message queue. Implementations must not
526 * free @a mq, but should take care of @a impl_state.
528 * @param mq the message queue to destroy
529 * @param impl_state state of the implementation
532 cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq,
535 struct GNUNET_CADET_Channel *ch = impl_state;
537 GNUNET_assert (mq == ch->mq);
543 * We had an error processing a message we forwarded from a peer to
544 * the CADET service. We should just complain about it but otherwise
545 * continue processing.
547 * @param cls closure with our `struct GNUNET_CADET_Channel`
548 * @param error error code
551 cadet_mq_error_handler (void *cls,
552 enum GNUNET_MQ_Error error)
554 struct GNUNET_CADET_Channel *ch = cls;
557 if (GNUNET_MQ_ERROR_NO_MATCH == error)
559 /* Got a message we did not understand, still try to continue! */
560 GNUNET_CADET_receive_done (ch);
564 schedule_reconnect (ch->cadet);
570 * Implementation function that cancels the currently sent message.
571 * Should basically undo whatever #mq_send_impl() did.
573 * @param mq message queue
574 * @param impl_state state specific to the implementation
577 cadet_mq_cancel_impl (struct GNUNET_MQ_Handle *mq,
580 struct GNUNET_CADET_Channel *ch = impl_state;
582 GNUNET_assert (NULL != ch->pending_env);
583 GNUNET_MQ_discard (ch->pending_env);
584 ch->pending_env = NULL;
585 if (NULL != ch->mq_cont)
587 GNUNET_SCHEDULER_cancel (ch->mq_cont);
594 * Process the new channel notification and add it to the channels in the handle
596 * @param h The cadet handle
597 * @param msg A message with the details of the new incoming channel
600 handle_channel_created (void *cls,
601 const struct GNUNET_CADET_LocalChannelCreateMessage *msg)
603 struct GNUNET_CADET_Handle *h = cls;
604 struct GNUNET_CADET_Channel *ch;
605 struct GNUNET_CADET_Port *port;
606 const struct GNUNET_HashCode *port_number;
607 struct GNUNET_CADET_ClientChannelNumber ccn;
610 port_number = &msg->port;
611 if (ntohl (ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
620 /* We could have closed the port but the service didn't know about it yet
621 * This is not an error.
623 struct GNUNET_CADET_LocalChannelDestroyMessage *d_msg;
624 struct GNUNET_MQ_Envelope *env;
626 LOG (GNUNET_ERROR_TYPE_DEBUG,
627 "No handler for incoming channel %X (on port %s, recently closed?)\n",
628 ntohl (ccn.channel_of_client),
629 GNUNET_h2s (port_number));
630 env = GNUNET_MQ_msg (d_msg,
631 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
632 d_msg->ccn = msg->ccn;
633 GNUNET_MQ_send (h->mq,
638 ch = create_channel (h,
640 ch->peer = msg->peer;
642 ch->incoming_port = port;
643 ch->options = ntohl (msg->opt);
644 LOG (GNUNET_ERROR_TYPE_DEBUG,
645 "Creating incoming channel %X [%s] %p\n",
646 ntohl (ccn.channel_of_client),
647 GNUNET_h2s (port_number),
650 GNUNET_assert (NULL != port->connects);
651 ch->window_changes = port->window_changes;
652 ch->disconnects = port->disconnects;
653 ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
654 &cadet_mq_destroy_impl,
655 &cadet_mq_cancel_impl,
658 &cadet_mq_error_handler,
660 ch->ctx = port->connects (port->cls,
663 GNUNET_MQ_set_handlers_closure (ch->mq,
669 * Process the channel destroy notification and free associated resources
671 * @param h The cadet handle
672 * @param msg A message with the details of the channel being destroyed
675 handle_channel_destroy (void *cls,
676 const struct GNUNET_CADET_LocalChannelDestroyMessage *msg)
678 struct GNUNET_CADET_Handle *h = cls;
679 struct GNUNET_CADET_Channel *ch;
681 ch = find_channel (h,
685 LOG (GNUNET_ERROR_TYPE_DEBUG,
686 "Received channel destroy for unknown channel %X from CADET service (recently close?)\n",
687 ntohl (msg->ccn.channel_of_client));
690 LOG (GNUNET_ERROR_TYPE_DEBUG,
691 "Received channel destroy for channel %X from CADET service\n",
692 ntohl (msg->ccn.channel_of_client));
693 destroy_channel (ch);
698 * Check that message received from CADET service is well-formed.
700 * @param cls the `struct GNUNET_CADET_Handle`
701 * @param message the message we got
702 * @return #GNUNET_OK if the message is well-formed,
703 * #GNUNET_SYSERR otherwise
706 check_local_data (void *cls,
707 const struct GNUNET_CADET_LocalData *message)
711 size = ntohs (message->header.size);
712 if (sizeof (*message) + sizeof (struct GNUNET_MessageHeader) > size)
715 return GNUNET_SYSERR;
722 * Process the incoming data packets, call appropriate handlers.
724 * @param h The cadet handle
725 * @param message A message encapsulating the data
728 handle_local_data (void *cls,
729 const struct GNUNET_CADET_LocalData *message)
731 struct GNUNET_CADET_Handle *h = cls;
732 const struct GNUNET_MessageHeader *payload;
733 struct GNUNET_CADET_Channel *ch;
737 ch = find_channel (h,
741 LOG (GNUNET_ERROR_TYPE_DEBUG,
742 "Unknown channel %X for incoming data (recently closed?)\n",
743 ntohl (message->ccn.channel_of_client));
747 payload = (const struct GNUNET_MessageHeader *) &message[1];
748 type = ntohs (payload->type);
749 fwd = ntohl (ch->ccn.channel_of_client) <= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
750 LOG (GNUNET_ERROR_TYPE_DEBUG,
751 "Got a %s data on channel %s [%X] of type %u\n",
753 GNUNET_i2s (&ch->peer),
754 ntohl (message->ccn.channel_of_client),
756 GNUNET_MQ_inject_message (ch->mq,
762 * Process a local ACK message, enabling the client to send
763 * more data to the service.
765 * @param h Cadet handle.
766 * @param message Message itself.
769 handle_local_ack (void *cls,
770 const struct GNUNET_CADET_LocalAck *message)
772 struct GNUNET_CADET_Handle *h = cls;
773 struct GNUNET_CADET_Channel *ch;
775 ch = find_channel (h,
779 LOG (GNUNET_ERROR_TYPE_DEBUG,
780 "ACK on unknown channel %X\n",
781 ntohl (message->ccn.channel_of_client));
785 if (NULL == ch->pending_env)
787 LOG (GNUNET_ERROR_TYPE_DEBUG,
788 "Got an ACK on mq channel %X, allow send now %u!\n",
789 ntohl (ch->ccn.channel_of_client),
791 notify_window_size (ch);
794 if (NULL != ch->mq_cont)
795 return; /* already working on it! */
796 LOG (GNUNET_ERROR_TYPE_DEBUG,
797 "Got an ACK on mq channel %X, sending pending message!\n",
798 ntohl (ch->ccn.channel_of_client));
800 = GNUNET_SCHEDULER_add_now (&cadet_mq_send_now,
806 * Generic error handler, called with the appropriate error code and
807 * the same closure specified at the creation of the message queue.
808 * Not every message queue implementation supports an error handler.
810 * @param cls closure, a `struct GNUNET_CORE_Handle *`
811 * @param error error code
814 handle_mq_error (void *cls,
815 enum GNUNET_MQ_Error error)
817 struct GNUNET_CADET_Handle *h = cls;
819 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
822 GNUNET_MQ_destroy (h->mq);
829 * Check that message received from CADET service is well-formed.
831 * @param cls the `struct GNUNET_CADET_Handle`
832 * @param message the message we got
833 * @return #GNUNET_OK if the message is well-formed,
834 * #GNUNET_SYSERR otherwise
837 check_get_peers (void *cls,
838 const struct GNUNET_MessageHeader *message)
842 esize = ntohs (message->size);
843 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == esize)
845 if (sizeof (struct GNUNET_MessageHeader) == esize)
847 return GNUNET_SYSERR;
852 * Process a local reply about info on all tunnels, pass info to the user.
854 * @param cls Closure (Cadet handle).
855 * @param msg Message itself.
858 handle_get_peers (void *cls,
859 const struct GNUNET_MessageHeader *msg)
861 struct GNUNET_CADET_Handle *h = cls;
862 const struct GNUNET_CADET_LocalInfoPeer *info =
863 (const struct GNUNET_CADET_LocalInfoPeer *) msg;
865 if (NULL == h->info_cb.peers_cb)
867 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) == ntohs (msg->size))
868 h->info_cb.peers_cb (h->info_cls,
870 (int) ntohs (info->tunnel),
871 (unsigned int) ntohs (info->paths),
874 h->info_cb.peers_cb (h->info_cls,
883 * Check that message received from CADET service is well-formed.
885 * @param cls the `struct GNUNET_CADET_Handle`
886 * @param message the message we got
887 * @return #GNUNET_OK if the message is well-formed,
888 * #GNUNET_SYSERR otherwise
891 check_get_peer (void *cls,
892 const struct GNUNET_CADET_LocalInfoPeer *message)
894 size_t msize = sizeof (struct GNUNET_CADET_LocalInfoPeer);
895 const struct GNUNET_PeerIdentity *paths_array;
901 esize = ntohs (message->header.size);
905 return GNUNET_SYSERR;
907 if (0 != ((esize - msize) % sizeof (struct GNUNET_PeerIdentity)))
910 return GNUNET_SYSERR;
912 peers = (esize - msize) / sizeof (struct GNUNET_PeerIdentity);
913 epaths = ntohs (message->paths);
914 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
916 for (unsigned int i = 0; i < peers; i++)
917 if (0 == memcmp (&paths_array[i],
918 &message->destination,
919 sizeof (struct GNUNET_PeerIdentity)))
924 return GNUNET_SYSERR;
931 * Process a local peer info reply, pass info to the user.
933 * @param cls Closure (Cadet handle).
934 * @param message Message itself.
937 handle_get_peer (void *cls,
938 const struct GNUNET_CADET_LocalInfoPeer *message)
940 struct GNUNET_CADET_Handle *h = cls;
941 const struct GNUNET_PeerIdentity *paths_array;
943 unsigned int path_length;
947 if (NULL == h->info_cb.peer_cb)
949 paths = ntohs (message->paths);
950 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
951 peers = (ntohs (message->header.size) - sizeof (*message))
952 / sizeof (struct GNUNET_PeerIdentity);
954 neighbor = GNUNET_NO;
956 for (unsigned int i = 0; i < peers; i++)
958 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
960 GNUNET_i2s (&paths_array[i]));
962 if (0 == memcmp (&paths_array[i], &message->destination,
963 sizeof (struct GNUNET_PeerIdentity)))
965 if (1 == path_length)
966 neighbor = GNUNET_YES;
971 /* Call Callback with tunnel info. */
972 paths_array = (const struct GNUNET_PeerIdentity *) &message[1];
973 h->info_cb.peer_cb (h->info_cls,
974 &message->destination,
975 (int) ntohs (message->tunnel),
983 * Check that message received from CADET service is well-formed.
985 * @param cls the `struct GNUNET_CADET_Handle`
986 * @param message the message we got
987 * @return #GNUNET_OK if the message is well-formed,
988 * #GNUNET_SYSERR otherwise
991 check_get_tunnels (void *cls,
992 const struct GNUNET_MessageHeader *message)
996 esize = ntohs (message->size);
997 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == esize)
999 if (sizeof (struct GNUNET_MessageHeader) == esize)
1001 return GNUNET_SYSERR;
1006 * Process a local reply about info on all tunnels, pass info to the user.
1008 * @param cls Closure (Cadet handle).
1009 * @param message Message itself.
1012 handle_get_tunnels (void *cls,
1013 const struct GNUNET_MessageHeader *msg)
1015 struct GNUNET_CADET_Handle *h = cls;
1016 const struct GNUNET_CADET_LocalInfoTunnel *info =
1017 (const struct GNUNET_CADET_LocalInfoTunnel *) msg;
1019 if (NULL == h->info_cb.tunnels_cb)
1021 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) == ntohs (msg->size))
1022 h->info_cb.tunnels_cb (h->info_cls,
1024 ntohl (info->channels),
1025 ntohl (info->connections),
1026 ntohs (info->estate),
1027 ntohs (info->cstate));
1029 h->info_cb.tunnels_cb (h->info_cls,
1039 * Check that message received from CADET service is well-formed.
1041 * @param cls the `struct GNUNET_CADET_Handle`
1042 * @param msg the message we got
1043 * @return #GNUNET_OK if the message is well-formed,
1044 * #GNUNET_SYSERR otherwise
1047 check_get_tunnel (void *cls,
1048 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1055 /* Verify message sanity */
1056 msize = ntohs (msg->header.size);
1057 esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1061 return GNUNET_SYSERR;
1063 ch_n = ntohl (msg->channels);
1064 c_n = ntohl (msg->connections);
1065 esize += ch_n * sizeof (struct GNUNET_CADET_ChannelTunnelNumber);
1066 esize += c_n * sizeof (struct GNUNET_CADET_ConnectionTunnelIdentifier);
1069 GNUNET_break_op (0);
1070 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1071 "m:%u, e: %u (%u ch, %u conn)\n",
1072 (unsigned int) msize,
1073 (unsigned int) esize,
1076 return GNUNET_SYSERR;
1083 * Process a local tunnel info reply, pass info to the user.
1085 * @param cls Closure (Cadet handle).
1086 * @param msg Message itself.
1089 handle_get_tunnel (void *cls,
1090 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1092 struct GNUNET_CADET_Handle *h = cls;
1095 const struct GNUNET_CADET_ConnectionTunnelIdentifier *conns;
1096 const struct GNUNET_CADET_ChannelTunnelNumber *chns;
1098 if (NULL == h->info_cb.tunnel_cb)
1101 ch_n = ntohl (msg->channels);
1102 c_n = ntohl (msg->connections);
1104 /* Call Callback with tunnel info. */
1105 conns = (const struct GNUNET_CADET_ConnectionTunnelIdentifier *) &msg[1];
1106 chns = (const struct GNUNET_CADET_ChannelTunnelNumber *) &conns[c_n];
1107 h->info_cb.tunnel_cb (h->info_cls,
1113 ntohs (msg->estate),
1114 ntohs (msg->cstate));
1119 * Reconnect to the service, retransmit all infomation to try to restore the
1122 * @param h handle to the cadet
1125 reconnect (struct GNUNET_CADET_Handle *h)
1127 struct GNUNET_MQ_MessageHandler handlers[] = {
1128 GNUNET_MQ_hd_fixed_size (channel_created,
1129 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE,
1130 struct GNUNET_CADET_LocalChannelCreateMessage,
1132 GNUNET_MQ_hd_fixed_size (channel_destroy,
1133 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY,
1134 struct GNUNET_CADET_LocalChannelDestroyMessage,
1136 GNUNET_MQ_hd_var_size (local_data,
1137 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
1138 struct GNUNET_CADET_LocalData,
1140 GNUNET_MQ_hd_fixed_size (local_ack,
1141 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK,
1142 struct GNUNET_CADET_LocalAck,
1144 GNUNET_MQ_hd_var_size (get_peers,
1145 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS,
1146 struct GNUNET_MessageHeader,
1148 GNUNET_MQ_hd_var_size (get_peer,
1149 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER,
1150 struct GNUNET_CADET_LocalInfoPeer,
1152 GNUNET_MQ_hd_var_size (get_tunnels,
1153 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS,
1154 struct GNUNET_MessageHeader,
1156 GNUNET_MQ_hd_var_size (get_tunnel,
1157 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL,
1158 struct GNUNET_CADET_LocalInfoTunnel,
1160 GNUNET_MQ_handler_end ()
1163 GNUNET_assert (NULL == h->mq);
1164 h->mq = GNUNET_CLIENT_connect (h->cfg,
1171 schedule_reconnect (h);
1174 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1179 * Function called during #GNUNET_CADET_disconnect() to destroy
1180 * all channels that are still open.
1182 * @param cls the `struct GNUNET_CADET_Handle`
1183 * @param cid chanenl ID
1184 * @param value a `struct GNUNET_CADET_Channel` to destroy
1185 * @return #GNUNET_OK (continue to iterate)
1188 destroy_channel_cb (void *cls,
1192 /* struct GNUNET_CADET_Handle *handle = cls; */
1193 struct GNUNET_CADET_Channel *ch = value;
1195 if (ntohl (ch->ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
1198 LOG (GNUNET_ERROR_TYPE_DEBUG,
1199 "channel %X not destroyed\n",
1200 ntohl (ch->ccn.channel_of_client));
1202 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1203 "Destroying channel due to GNUNET_CADET_disconnect()\n");
1204 destroy_channel (ch);
1210 * Function called during #GNUNET_CADET_disconnect() to destroy
1211 * all ports that are still open.
1213 * @param cls the `struct GNUNET_CADET_Handle`
1215 * @param value a `struct GNUNET_CADET_Channel` to destroy
1216 * @return #GNUNET_OK (continue to iterate)
1219 destroy_port_cb (void *cls,
1220 const struct GNUNET_HashCode *id,
1223 /* struct GNUNET_CADET_Handle *handle = cls; */
1224 struct GNUNET_CADET_Port *port = value;
1226 /* This is a warning, the app should have cleanly closed all open ports */
1228 GNUNET_CADET_close_port (port);
1234 * Disconnect from the cadet service. All channels will be destroyed. All channel
1235 * disconnect callbacks will be called on any still connected peers, notifying
1236 * about their disconnection. The registered inbound channel cleaner will be
1237 * called should any inbound channels still exist.
1239 * @param handle connection to cadet to disconnect
1242 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
1244 GNUNET_CONTAINER_multihashmap_iterate (handle->ports,
1247 GNUNET_CONTAINER_multihashmap_destroy (handle->ports);
1248 handle->ports = NULL;
1249 GNUNET_CONTAINER_multihashmap32_iterate (handle->channels,
1250 &destroy_channel_cb,
1252 GNUNET_CONTAINER_multihashmap32_destroy (handle->channels);
1253 handle->channels = NULL;
1254 if (NULL != handle->mq)
1256 GNUNET_MQ_destroy (handle->mq);
1259 if (NULL != handle->reconnect_task)
1261 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1262 handle->reconnect_task = NULL;
1264 GNUNET_free (handle);
1269 * Close a port opened with @a GNUNET_CADET_open_port().
1270 * The @a new_channel callback will no longer be called.
1272 * @param p Port handle.
1275 GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p)
1277 struct GNUNET_CADET_PortMessage *msg;
1278 struct GNUNET_MQ_Envelope *env;
1280 env = GNUNET_MQ_msg (msg,
1281 GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE);
1283 GNUNET_MQ_send (p->cadet->mq,
1285 GNUNET_assert (GNUNET_YES ==
1286 GNUNET_CONTAINER_multihashmap_remove (p->cadet->ports,
1289 GNUNET_free_non_null (p->handlers);
1295 * Destroy an existing channel.
1297 * The existing end callback for the channel will be called immediately.
1298 * Any pending outgoing messages will be sent but no incoming messages will be
1299 * accepted and no data callbacks will be called.
1301 * @param channel Channel handle, becomes invalid after this call.
1304 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
1306 struct GNUNET_CADET_Handle *h = channel->cadet;
1307 struct GNUNET_CADET_LocalChannelDestroyMessage *msg;
1308 struct GNUNET_MQ_Envelope *env;
1312 env = GNUNET_MQ_msg (msg,
1313 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
1314 msg->ccn = channel->ccn;
1315 GNUNET_MQ_send (h->mq,
1318 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1319 "Destroying channel due to GNUNET_CADET_channel_destroy()\n");
1320 destroy_channel (channel);
1325 * Get information about a channel.
1327 * @param channel Channel handle.
1328 * @param option Query (GNUNET_CADET_OPTION_*).
1329 * @param ... dependant on option, currently not used
1331 * @return Union with an answer to the query.
1333 const union GNUNET_CADET_ChannelInfo *
1334 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
1335 enum GNUNET_CADET_ChannelOption option,
1338 static int bool_flag;
1342 case GNUNET_CADET_OPTION_NOBUFFER:
1343 case GNUNET_CADET_OPTION_RELIABLE:
1344 case GNUNET_CADET_OPTION_OUT_OF_ORDER:
1345 if (0 != (option & channel->options))
1346 bool_flag = GNUNET_YES;
1348 bool_flag = GNUNET_NO;
1349 return (const union GNUNET_CADET_ChannelInfo *) &bool_flag;
1351 case GNUNET_CADET_OPTION_PEER:
1352 return (const union GNUNET_CADET_ChannelInfo *) &channel->peer;
1362 * Send an ack on the channel to confirm the processing of a message.
1364 * @param ch Channel on which to send the ACK.
1367 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
1369 struct GNUNET_CADET_LocalAck *msg;
1370 struct GNUNET_MQ_Envelope *env;
1372 env = GNUNET_MQ_msg (msg,
1373 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
1374 LOG (GNUNET_ERROR_TYPE_DEBUG,
1375 "Sending ACK on channel %X\n",
1376 ntohl (channel->ccn.channel_of_client));
1377 msg->ccn = channel->ccn;
1378 GNUNET_MQ_send (channel->cadet->mq,
1384 * Send message of @a type to CADET service of @a h
1386 * @param h handle to CADET service
1387 * @param type message type of trivial information request to send
1390 send_info_request (struct GNUNET_CADET_Handle *h,
1393 struct GNUNET_MessageHeader *msg;
1394 struct GNUNET_MQ_Envelope *env;
1396 env = GNUNET_MQ_msg (msg,
1398 GNUNET_MQ_send (h->mq,
1404 * Request a debug dump on the service's STDERR.
1406 * WARNING: unstable API, likely to change in the future!
1408 * @param h cadet handle
1411 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h)
1413 send_info_request (h,
1414 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP);
1419 * Request information about peers known to the running cadet service.
1420 * The callback will be called for every peer known to the service.
1421 * Only one info request (of any kind) can be active at once.
1423 * WARNING: unstable API, likely to change in the future!
1425 * @param h Handle to the cadet peer.
1426 * @param callback Function to call with the requested data.
1427 * @param callback_cls Closure for @c callback.
1428 * @return #GNUNET_OK / #GNUNET_SYSERR
1431 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
1432 GNUNET_CADET_PeersCB callback,
1435 if (NULL != h->info_cb.peers_cb)
1438 return GNUNET_SYSERR;
1440 send_info_request (h,
1441 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
1442 h->info_cb.peers_cb = callback;
1443 h->info_cls = callback_cls;
1449 * Cancel a peer info request. The callback will not be called (anymore).
1451 * WARNING: unstable API, likely to change in the future!
1453 * @param h Cadet handle.
1454 * @return Closure given to GNUNET_CADET_get_peers().
1457 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h)
1459 void *cls = h->info_cls;
1461 h->info_cb.peers_cb = NULL;
1468 * Request information about a peer known to the running cadet peer.
1469 * The callback will be called for the tunnel once.
1470 * Only one info request (of any kind) can be active at once.
1472 * WARNING: unstable API, likely to change in the future!
1474 * @param h Handle to the cadet peer.
1475 * @param id Peer whose tunnel to examine.
1476 * @param callback Function to call with the requested data.
1477 * @param callback_cls Closure for @c callback.
1478 * @return #GNUNET_OK / #GNUNET_SYSERR
1481 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
1482 const struct GNUNET_PeerIdentity *id,
1483 GNUNET_CADET_PeerCB callback,
1486 struct GNUNET_CADET_LocalInfo *msg;
1487 struct GNUNET_MQ_Envelope *env;
1489 if (NULL != h->info_cb.peer_cb)
1492 return GNUNET_SYSERR;
1494 env = GNUNET_MQ_msg (msg,
1495 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
1497 GNUNET_MQ_send (h->mq,
1499 h->info_cb.peer_cb = callback;
1500 h->info_cls = callback_cls;
1506 * Request information about tunnels of the running cadet peer.
1507 * The callback will be called for every tunnel of the service.
1508 * Only one info request (of any kind) can be active at once.
1510 * WARNING: unstable API, likely to change in the future!
1512 * @param h Handle to the cadet peer.
1513 * @param callback Function to call with the requested data.
1514 * @param callback_cls Closure for @c callback.
1515 * @return #GNUNET_OK / #GNUNET_SYSERR
1518 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
1519 GNUNET_CADET_TunnelsCB callback,
1522 if (NULL != h->info_cb.tunnels_cb)
1525 return GNUNET_SYSERR;
1527 send_info_request (h,
1528 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
1529 h->info_cb.tunnels_cb = callback;
1530 h->info_cls = callback_cls;
1536 * Cancel a monitor request. The monitor callback will not be called.
1538 * @param h Cadet handle.
1539 * @return Closure given to GNUNET_CADET_get_tunnels().
1542 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h)
1544 void *cls = h->info_cls;
1546 h->info_cb.tunnels_cb = NULL;
1553 * Request information about a tunnel of the running cadet peer.
1554 * The callback will be called for the tunnel once.
1555 * Only one info request (of any kind) can be active at once.
1557 * WARNING: unstable API, likely to change in the future!
1559 * @param h Handle to the cadet peer.
1560 * @param id Peer whose tunnel to examine.
1561 * @param callback Function to call with the requested data.
1562 * @param callback_cls Closure for @c callback.
1563 * @return #GNUNET_OK / #GNUNET_SYSERR
1566 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
1567 const struct GNUNET_PeerIdentity *id,
1568 GNUNET_CADET_TunnelCB callback,
1571 struct GNUNET_CADET_LocalInfo *msg;
1572 struct GNUNET_MQ_Envelope *env;
1574 if (NULL != h->info_cb.tunnel_cb)
1577 return GNUNET_SYSERR;
1579 env = GNUNET_MQ_msg (msg,
1580 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
1582 GNUNET_MQ_send (h->mq,
1584 h->info_cb.tunnel_cb = callback;
1585 h->info_cls = callback_cls;
1591 * Transitional function to convert an unsigned int port to a hash value.
1592 * WARNING: local static value returned, NOT reentrant!
1593 * WARNING: do not use this function for new code!
1595 * @param port Numerical port (unsigned int format).
1597 * @return A GNUNET_HashCode usable for the new CADET API.
1599 const struct GNUNET_HashCode *
1600 GC_u2h (uint32_t port)
1602 static struct GNUNET_HashCode hash;
1604 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1605 "This is a transitional function, use proper crypto hashes as CADET ports\n");
1606 GNUNET_CRYPTO_hash (&port,
1614 * Connect to the MQ-based cadet service.
1616 * @param cfg Configuration to use.
1618 * @return Handle to the cadet service NULL on error.
1620 struct GNUNET_CADET_Handle *
1621 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
1623 struct GNUNET_CADET_Handle *h;
1625 LOG (GNUNET_ERROR_TYPE_DEBUG,
1626 "GNUNET_CADET_connect()\n");
1627 h = GNUNET_new (struct GNUNET_CADET_Handle);
1629 h->ports = GNUNET_CONTAINER_multihashmap_create (4,
1631 h->channels = GNUNET_CONTAINER_multihashmap32_create (4);
1636 GNUNET_CADET_disconnect (h);
1639 h->next_ccn.channel_of_client = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
1640 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1641 h->reconnect_task = NULL;
1648 * Open a port to receive incomming MQ-based channels.
1650 * @param h CADET handle.
1651 * @param port Hash identifying the port.
1652 * @param connects Function called when an incoming channel is connected.
1653 * @param connects_cls Closure for the @a connects handler.
1654 * @param window_changes Function called when the transmit window size changes.
1655 * @param disconnects Function called when a channel is disconnected.
1656 * @param handlers Callbacks for messages we care about, NULL-terminated.
1657 * @return Port handle, NULL if port is in use
1659 struct GNUNET_CADET_Port *
1660 GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
1661 const struct GNUNET_HashCode *port,
1662 GNUNET_CADET_ConnectEventHandler connects,
1663 void * connects_cls,
1664 GNUNET_CADET_WindowSizeEventHandler window_changes,
1665 GNUNET_CADET_DisconnectEventHandler disconnects,
1666 const struct GNUNET_MQ_MessageHandler *handlers)
1668 struct GNUNET_CADET_PortMessage *msg;
1669 struct GNUNET_MQ_Envelope *env;
1670 struct GNUNET_CADET_Port *p;
1672 GNUNET_assert (NULL != connects);
1673 GNUNET_assert (NULL != disconnects);
1674 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1675 "Listening to CADET port %s\n",
1678 p = GNUNET_new (struct GNUNET_CADET_Port);
1682 GNUNET_CONTAINER_multihashmap_put (h->ports,
1685 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1690 p->connects = connects;
1691 p->cls = connects_cls;
1692 p->window_changes = window_changes;
1693 p->disconnects = disconnects;
1694 p->handlers = GNUNET_MQ_copy_handlers (handlers);
1697 env = GNUNET_MQ_msg (msg,
1698 GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN);
1700 GNUNET_MQ_send (h->mq,
1707 * Create a new channel towards a remote peer.
1709 * If the destination port is not open by any peer or the destination peer
1710 * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
1713 * @param h CADET handle.
1714 * @param channel_cls Closure for the channel. It's given to:
1715 * - The disconnect handler @a disconnects
1716 * - Each message type callback in @a handlers
1717 * @param destination Peer identity the channel should go to.
1718 * @param port Identification of the destination port.
1719 * @param options CadetOption flag field, with all desired option bits set to 1.
1720 * @param window_changes Function called when the transmit window size changes.
1721 * @param disconnects Function called when the channel is disconnected.
1722 * @param handlers Callbacks for messages we care about, NULL-terminated.
1723 * @return Handle to the channel.
1725 struct GNUNET_CADET_Channel *
1726 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
1728 const struct GNUNET_PeerIdentity *destination,
1729 const struct GNUNET_HashCode *port,
1730 enum GNUNET_CADET_ChannelOption options,
1731 GNUNET_CADET_WindowSizeEventHandler window_changes,
1732 GNUNET_CADET_DisconnectEventHandler disconnects,
1733 const struct GNUNET_MQ_MessageHandler *handlers)
1735 struct GNUNET_CADET_Channel *ch;
1736 struct GNUNET_CADET_LocalChannelCreateMessage *msg;
1737 struct GNUNET_MQ_Envelope *env;
1739 GNUNET_assert (NULL != disconnects);
1740 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1741 "Creating channel to peer %s at port %s\n",
1742 GNUNET_i2s (destination),
1744 ch = create_channel (h,
1746 ch->ctx = channel_cls;
1747 ch->peer = *destination;
1748 ch->options = options;
1749 ch->window_changes = window_changes;
1750 ch->disconnects = disconnects;
1752 /* Create MQ for channel */
1753 ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
1754 &cadet_mq_destroy_impl,
1755 &cadet_mq_cancel_impl,
1758 &cadet_mq_error_handler,
1760 GNUNET_MQ_set_handlers_closure (ch->mq, channel_cls);
1762 /* Request channel creation to service */
1763 env = GNUNET_MQ_msg (msg,
1764 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE);
1767 msg->peer = *destination;
1768 msg->opt = htonl (options);
1769 GNUNET_MQ_send (h->mq,
1776 * Obtain the message queue for a connected peer.
1778 * @param channel The channel handle from which to get the MQ.
1780 * @return NULL if @a channel is not yet connected.
1782 struct GNUNET_MQ_Handle *
1783 GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel)
1788 /* end of cadet_api.c */