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
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__)
35 /******************************************************************************/
36 /************************ DATA STRUCTURES ****************************/
37 /******************************************************************************/
40 * Transmission queue to the service
42 struct GNUNET_CADET_TransmitHandle
47 struct GNUNET_CADET_TransmitHandle *next;
52 struct GNUNET_CADET_TransmitHandle *prev;
55 * Channel this message is sent on / for (may be NULL for control messages).
57 struct GNUNET_CADET_Channel *channel;
62 struct GNUNET_SCHEDULER_Task *request_data_task;
65 * Callback to obtain the message to transmit, or NULL if we
66 * got the message in 'data'. Notice that messages built
67 * by 'notify' need to be encapsulated with information about
70 GNUNET_CONNECTION_TransmitReadyNotify notify;
73 * Closure for 'notify'
78 * Size of the payload.
90 GNUNET_CADET_ChannelCB channel_cb;
95 GNUNET_CADET_PeersCB peers_cb;
100 GNUNET_CADET_PeerCB peer_cb;
105 GNUNET_CADET_TunnelsCB tunnels_cb;
110 GNUNET_CADET_TunnelCB tunnel_cb;
115 * Opaque handle to the service.
117 struct GNUNET_CADET_Handle
120 * Message queue (if available).
122 struct GNUNET_MQ_Handle *mq;
125 * Set of handlers used for processing incoming messages in the channels
127 const struct GNUNET_CADET_MessageHandler *message_handlers;
130 * Number of handlers in the handlers array.
132 unsigned int n_handlers;
137 struct GNUNET_CONTAINER_MultiHashMap *ports;
140 * Double linked list of the channels this client is connected to, head.
142 struct GNUNET_CADET_Channel *channels_head;
145 * Double linked list of the channels this client is connected to, tail.
147 struct GNUNET_CADET_Channel *channels_tail;
150 * Callback for inbound channel disconnection
152 GNUNET_CADET_ChannelEndHandler *cleaner;
155 * Closure for all the handlers given by the client
160 * Messages to send to the service, head.
162 struct GNUNET_CADET_TransmitHandle *th_head;
165 * Messages to send to the service, tail.
167 struct GNUNET_CADET_TransmitHandle *th_tail;
170 * child of the next channel to create (to avoid reusing IDs often)
172 struct GNUNET_CADET_ClientChannelNumber next_ccn;
175 * Configuration given by the client, in case of reconnection
177 const struct GNUNET_CONFIGURATION_Handle *cfg;
180 * Time to the next reconnect in case one reconnect fails
182 struct GNUNET_TIME_Relative reconnect_time;
185 * Task for trying to reconnect.
187 struct GNUNET_SCHEDULER_Task * reconnect_task;
190 * Callback for an info task (only one active at a time).
192 union CadetInfoCB info_cb;
195 * Info callback closure for @c info_cb.
202 * Description of a peer
204 struct GNUNET_CADET_Peer
207 * ID of the peer in short form
212 * Channel this peer belongs to
214 struct GNUNET_CADET_Channel *t;
219 * Opaque handle to a channel.
221 struct GNUNET_CADET_Channel
226 struct GNUNET_CADET_Channel *next;
231 struct GNUNET_CADET_Channel *prev;
234 * Handle to the cadet this channel belongs to
236 struct GNUNET_CADET_Handle *cadet;
239 * Local ID of the channel
241 struct GNUNET_CADET_ClientChannelNumber ccn;
244 * Channel's port, if any.
246 struct GNUNET_CADET_Port *port;
249 * Other end of the channel.
254 * Any data the caller wants to put in here
259 * Channel options: reliability, etc.
261 enum GNUNET_CADET_ChannelOption options;
264 * Are we allowed to send to the service?
266 unsigned int allow_send;
272 * Opaque handle to a port.
274 struct GNUNET_CADET_Port
277 * Handle to the CADET session this port belongs to.
279 struct GNUNET_CADET_Handle *cadet;
284 struct GNUNET_HashCode *hash;
287 * Callback handler for incoming channels on this port.
289 GNUNET_CADET_InboundChannelNotificationHandler *handler;
292 * Closure for @a handler.
299 * Implementation state for cadet's message queue.
304 * The current transmit handle, or NULL
305 * if no transmit is active.
307 struct GNUNET_CADET_TransmitHandle *th;
310 * Channel to send the data over.
312 struct GNUNET_CADET_Channel *channel;
316 /******************************************************************************/
317 /*********************** AUXILIARY FUNCTIONS *************************/
318 /******************************************************************************/
321 * Check if transmission is a payload packet.
323 * @param th Transmission handle.
325 * @return #GNUNET_YES if it is a payload packet,
326 * #GNUNET_NO if it is a cadet management packet.
329 th_is_payload (struct GNUNET_CADET_TransmitHandle *th)
331 return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
336 * Find the Port struct for a hash.
338 * @param h CADET handle.
339 * @param hash HashCode for the port number.
341 * @return The port handle if known, NULL otherwise.
343 static struct GNUNET_CADET_Port *
344 find_port (const struct GNUNET_CADET_Handle *h,
345 const struct GNUNET_HashCode *hash)
347 struct GNUNET_CADET_Port *p;
349 p = GNUNET_CONTAINER_multihashmap_get (h->ports, hash);
356 * Get the channel handler for the channel specified by id from the given handle
358 * @param h Cadet handle
359 * @param ccn ID of the wanted channel
360 * @return handle to the required channel or NULL if not found
362 static struct GNUNET_CADET_Channel *
363 retrieve_channel (struct GNUNET_CADET_Handle *h,
364 struct GNUNET_CADET_ClientChannelNumber ccn)
366 struct GNUNET_CADET_Channel *ch;
368 for (ch = h->channels_head; NULL != ch; ch = ch->next)
369 if (ch->ccn.channel_of_client == ccn.channel_of_client)
376 * Create a new channel and insert it in the channel list of the cadet handle
378 * @param h Cadet handle
379 * @param ccn Desired ccn of the channel, 0 to assign one automatically.
381 * @return Handle to the created channel.
383 static struct GNUNET_CADET_Channel *
384 create_channel (struct GNUNET_CADET_Handle *h,
385 struct GNUNET_CADET_ClientChannelNumber ccn)
387 struct GNUNET_CADET_Channel *ch;
389 ch = GNUNET_new (struct GNUNET_CADET_Channel);
390 GNUNET_CONTAINER_DLL_insert (h->channels_head,
394 if (0 == ccn.channel_of_client)
396 ch->ccn = h->next_ccn;
397 while (NULL != retrieve_channel (h,
400 h->next_ccn.channel_of_client
401 = htonl (1 + ntohl (h->next_ccn.channel_of_client));
402 if (0 == ntohl (h->next_ccn.channel_of_client))
403 h->next_ccn.channel_of_client
404 = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
416 * Destroy the specified channel.
417 * - Destroys all peers, calling the disconnect callback on each if needed
418 * - Cancels all outgoing traffic for that channel, calling respective notifys
419 * - Calls cleaner if channel was inbound
420 * - Frees all memory used
422 * @param ch Pointer to the channel.
423 * @param call_cleaner Whether to call the cleaner handler.
425 * @return Handle to the required channel or NULL if not found.
427 // FIXME: simplify: call_cleaner is always #GNUNET_YES!!!
429 destroy_channel (struct GNUNET_CADET_Channel *ch,
432 struct GNUNET_CADET_Handle *h;
433 struct GNUNET_CADET_TransmitHandle *th;
434 struct GNUNET_CADET_TransmitHandle *next;
442 LOG (GNUNET_ERROR_TYPE_DEBUG,
443 " destroy_channel %X of %p\n",
447 GNUNET_CONTAINER_DLL_remove (h->channels_head,
451 /* signal channel destruction */
452 if ( (NULL != h->cleaner) &&
454 (GNUNET_YES == call_cleaner) )
456 LOG (GNUNET_ERROR_TYPE_DEBUG,
457 " calling cleaner\n");
458 h->cleaner (h->cls, ch, ch->ctx);
461 /* check that clients did not leave messages behind in the queue */
462 for (th = h->th_head; NULL != th; th = next)
465 if (th->channel != ch)
467 /* Clients should have aborted their requests already.
468 * Management traffic should be ok, as clients can't cancel that.
469 * If the service crashed and we are reconnecting, it's ok.
471 GNUNET_break (GNUNET_NO == th_is_payload (th));
472 GNUNET_CADET_notify_transmit_ready_cancel (th);
476 GNUNET_PEER_change_rc (ch->peer, -1);
482 * Add a transmit handle to the transmission queue and set the
485 * @param h cadet handle with the queue head and tail
486 * @param th handle to the packet to be transmitted
489 add_to_queue (struct GNUNET_CADET_Handle *h,
490 struct GNUNET_CADET_TransmitHandle *th)
492 GNUNET_CONTAINER_DLL_insert_tail (h->th_head,
499 * Remove a transmit handle from the transmission queue, if present.
501 * Safe to call even if not queued.
503 * @param th handle to the packet to be unqueued.
506 remove_from_queue (struct GNUNET_CADET_TransmitHandle *th)
508 struct GNUNET_CADET_Handle *h = th->channel->cadet;
510 /* It might or might not have been queued (rarely not), but check anyway. */
511 if (NULL != th->next || h->th_tail == th)
513 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
519 /******************************************************************************/
520 /*********************** RECEIVE HANDLERS ****************************/
521 /******************************************************************************/
525 * Call the @a notify callback given to #GNUNET_CADET_notify_transmit_ready to
526 * request the data to send over MQ. Since MQ manages the queue, this function
527 * is scheduled immediatly after a transmit ready notification.
529 * @param cls Closure (transmit handle).
532 request_data (void *cls)
534 struct GNUNET_CADET_TransmitHandle *th = cls;
535 struct GNUNET_CADET_LocalData *msg;
536 struct GNUNET_MQ_Envelope *env;
539 LOG (GNUNET_ERROR_TYPE_DEBUG,
540 "Requesting Data: %u bytes (allow send is %u)\n",
542 th->channel->allow_send);
544 GNUNET_assert (0 < th->channel->allow_send);
545 th->channel->allow_send--;
546 /* NOTE: we may be allowed to send another packet immediately,
547 albeit the current logic waits for the ACK. */
548 th->request_data_task = NULL;
549 remove_from_queue (th);
551 env = GNUNET_MQ_msg_extra (msg,
553 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA);
554 msg->ccn = th->channel->ccn;
555 osize = th->notify (th->notify_cls,
558 GNUNET_assert (osize == th->size);
560 GNUNET_MQ_send (th->channel->cadet->mq,
567 * Process the new channel notification and add it to the channels in the handle
569 * @param h The cadet handle
570 * @param msg A message with the details of the new incoming channel
573 handle_channel_created (void *cls,
574 const struct GNUNET_CADET_LocalChannelCreateMessage *msg)
576 struct GNUNET_CADET_Handle *h = cls;
577 struct GNUNET_CADET_Channel *ch;
578 struct GNUNET_CADET_Port *port;
579 const struct GNUNET_HashCode *port_number;
580 struct GNUNET_CADET_ClientChannelNumber ccn;
583 port_number = &msg->port;
584 if (ntohl (ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
589 port = find_port (h, port_number);
592 struct GNUNET_CADET_LocalChannelDestroyMessage *d_msg;
593 struct GNUNET_MQ_Envelope *env;
596 LOG (GNUNET_ERROR_TYPE_DEBUG,
597 "No handler for incoming channel %X [%s]\n",
598 ntohl (ccn.channel_of_client),
599 GNUNET_h2s (port_number));
600 /* FIXME: should disconnect instead, this is a serious error! */
601 env = GNUNET_MQ_msg (d_msg,
602 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
603 d_msg->ccn = msg->ccn;
604 GNUNET_MQ_send (h->mq,
609 ch = create_channel (h,
611 ch->peer = GNUNET_PEER_intern (&msg->peer);
615 ch->options = ntohl (msg->opt);
617 LOG (GNUNET_ERROR_TYPE_DEBUG,
618 "Creating incoming channel %X [%s] %p\n",
619 ntohl (ccn.channel_of_client),
620 GNUNET_h2s (port_number),
622 ch->ctx = port->handler (port->cls,
631 * Process the channel destroy notification and free associated resources
633 * @param h The cadet handle
634 * @param msg A message with the details of the channel being destroyed
637 handle_channel_destroy (void *cls,
638 const struct GNUNET_CADET_LocalChannelDestroyMessage *msg)
640 struct GNUNET_CADET_Handle *h = cls;
641 struct GNUNET_CADET_Channel *ch;
642 struct GNUNET_CADET_ClientChannelNumber ccn;
645 LOG (GNUNET_ERROR_TYPE_DEBUG,
646 "Channel %X Destroy from service\n",
647 ntohl (ccn.channel_of_client));
648 ch = retrieve_channel (h,
653 LOG (GNUNET_ERROR_TYPE_DEBUG,
654 "channel %X unknown\n",
655 ntohl (ccn.channel_of_client));
664 * Check that message received from CADET service is well-formed.
666 * @param cls the `struct GNUNET_CADET_Handle`
667 * @param message the message we got
668 * @return #GNUNET_OK if the message is well-formed,
669 * #GNUNET_SYSERR otherwise
672 check_local_data (void *cls,
673 const struct GNUNET_CADET_LocalData *message)
675 struct GNUNET_CADET_Handle *h = cls;
676 struct GNUNET_CADET_Channel *ch;
679 size = ntohs (message->header.size);
680 if (sizeof (*message) + sizeof (struct GNUNET_MessageHeader) > size)
683 return GNUNET_SYSERR;
686 ch = retrieve_channel (h,
691 return GNUNET_SYSERR;
699 * Process the incoming data packets, call appropriate handlers.
701 * @param h The cadet handle
702 * @param message A message encapsulating the data
705 handle_local_data (void *cls,
706 const struct GNUNET_CADET_LocalData *message)
708 struct GNUNET_CADET_Handle *h = cls;
709 const struct GNUNET_MessageHeader *payload;
710 const struct GNUNET_CADET_MessageHandler *handler;
711 struct GNUNET_CADET_Channel *ch;
714 ch = retrieve_channel (h,
716 GNUNET_assert (NULL != ch);
718 payload = (struct GNUNET_MessageHeader *) &message[1];
719 type = ntohs (payload->type);
720 LOG (GNUNET_ERROR_TYPE_DEBUG,
721 "Got a %s data on channel %s [%X] of type %s (%u)\n",
722 GC_f2s (ntohl (ch->ccn.channel_of_client) >=
723 GNUNET_CADET_LOCAL_CHANNEL_ID_CLI),
724 GNUNET_i2s (GNUNET_PEER_resolve2 (ch->peer)),
725 ntohl (message->ccn.channel_of_client),
728 for (unsigned i=0;i<h->n_handlers;i++)
730 handler = &h->message_handlers[i];
731 if (handler->type == type)
734 handler->callback (h->cls,
739 LOG (GNUNET_ERROR_TYPE_DEBUG,
740 "callback caused disconnection\n");
741 GNUNET_CADET_channel_destroy (ch);
747 /* Other peer sent message we do not comprehend. */
749 GNUNET_CADET_receive_done (ch);
754 * Process a local ACK message, enabling the client to send
755 * more data to the service.
757 * @param h Cadet handle.
758 * @param message Message itself.
761 handle_local_ack (void *cls,
762 const struct GNUNET_CADET_LocalAck *message)
764 struct GNUNET_CADET_Handle *h = cls;
765 struct GNUNET_CADET_Channel *ch;
766 struct GNUNET_CADET_ClientChannelNumber ccn;
767 struct GNUNET_CADET_TransmitHandle *th;
770 ch = retrieve_channel (h, ccn);
773 LOG (GNUNET_ERROR_TYPE_DEBUG,
774 "ACK on unknown channel %X\n",
775 ntohl (ccn.channel_of_client));
779 LOG (GNUNET_ERROR_TYPE_DEBUG,
780 "Got an ACK on channel %X, allow send now %u!\n",
781 ntohl (ch->ccn.channel_of_client),
783 for (th = h->th_head; NULL != th; th = th->next)
785 if ( (th->channel == ch) &&
786 (NULL == th->request_data_task) )
788 th->request_data_task
789 = GNUNET_SCHEDULER_add_now (&request_data,
797 * Reconnect to the service, retransmit all infomation to try to restore the
800 * @param h handle to the cadet
802 * @return #GNUNET_YES in case of sucess, #GNUNET_NO otherwise (service down...)
805 reconnect (struct GNUNET_CADET_Handle *h);
809 * Reconnect callback: tries to reconnect again after a failer previous
812 * @param cls closure (cadet handle)
815 reconnect_cbk (void *cls);
819 * Generic error handler, called with the appropriate error code and
820 * the same closure specified at the creation of the message queue.
821 * Not every message queue implementation supports an error handler.
823 * @param cls closure, a `struct GNUNET_CORE_Handle *`
824 * @param error error code
827 handle_mq_error (void *cls,
828 enum GNUNET_MQ_Error error)
830 struct GNUNET_CADET_Handle *h = cls;
832 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "MQ ERROR: %u\n", error);
833 GNUNET_MQ_destroy (h->mq);
840 * Process a local reply about info on all channels, pass info to the user.
842 * @param h Cadet handle.
843 * @param message Message itself.
846 // process_get_channels (struct GNUNET_CADET_Handle *h,
847 // const struct GNUNET_MessageHeader *message)
849 // struct GNUNET_CADET_LocalInfo *msg;
851 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Get Channels messasge received\n");
853 // if (NULL == h->channels_cb)
855 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
859 // msg = (struct GNUNET_CADET_LocalInfo *) message;
860 // if (ntohs (message->size) !=
861 // (sizeof (struct GNUNET_CADET_LocalInfo) +
862 // sizeof (struct GNUNET_PeerIdentity)))
864 // GNUNET_break_op (0);
865 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
866 // "Get channels message: size %hu - expected %u\n",
867 // ntohs (message->size),
868 // sizeof (struct GNUNET_CADET_LocalInfo));
871 // h->channels_cb (h->channels_cls,
872 // ntohl (msg->channel_id),
874 // &msg->destination);
880 * Process a local monitor_channel reply, pass info to the user.
882 * @param h Cadet handle.
883 * @param message Message itself.
886 // process_show_channel (struct GNUNET_CADET_Handle *h,
887 // const struct GNUNET_MessageHeader *message)
889 // struct GNUNET_CADET_LocalInfo *msg;
892 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Show Channel messasge received\n");
894 // if (NULL == h->channel_cb)
896 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
900 // /* Verify message sanity */
901 // msg = (struct GNUNET_CADET_LocalInfo *) message;
902 // esize = sizeof (struct GNUNET_CADET_LocalInfo);
903 // if (ntohs (message->size) != esize)
905 // GNUNET_break_op (0);
906 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
907 // "Show channel message: size %hu - expected %u\n",
908 // ntohs (message->size),
911 // h->channel_cb (h->channel_cls, NULL, NULL);
912 // h->channel_cb = NULL;
913 // h->channel_cls = NULL;
918 // h->channel_cb (h->channel_cls,
919 // &msg->destination,
926 * Check that message received from CADET service is well-formed.
928 * @param cls the `struct GNUNET_CADET_Handle`
929 * @param message the message we got
930 * @return #GNUNET_OK if the message is well-formed,
931 * #GNUNET_SYSERR otherwise
934 check_get_peers (void *cls,
935 const struct GNUNET_CADET_LocalInfoPeer *message)
937 struct GNUNET_CADET_Handle *h = cls;
940 if (NULL == h->info_cb.peers_cb)
942 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
943 " no handler for peesr monitor message!\n");
944 return GNUNET_SYSERR;
947 size = ntohs (message->header.size);
948 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) > size)
950 h->info_cb.peers_cb (h->info_cls, NULL, -1, 0, 0);
951 h->info_cb.peers_cb = NULL;
953 return GNUNET_SYSERR;
961 * Process a local reply about info on all tunnels, pass info to the user.
963 * @param cls Closure (Cadet handle).
964 * @param msg Message itself.
967 handle_get_peers (void *cls,
968 const struct GNUNET_CADET_LocalInfoPeer *msg)
970 struct GNUNET_CADET_Handle *h = cls;
971 h->info_cb.peers_cb (h->info_cls, &msg->destination,
972 (int) ntohs (msg->tunnel),
973 (unsigned int ) ntohs (msg->paths),
979 * Check that message received from CADET service is well-formed.
981 * @param cls the `struct GNUNET_CADET_Handle`
982 * @param message the message we got
983 * @return #GNUNET_OK if the message is well-formed,
984 * #GNUNET_SYSERR otherwise
987 check_get_peer (void *cls,
988 const struct GNUNET_CADET_LocalInfoPeer *message)
990 struct GNUNET_CADET_Handle *h = cls;
991 const size_t msize = sizeof (struct GNUNET_CADET_LocalInfoPeer);
992 struct GNUNET_PeerIdentity *paths_array;
998 if (NULL == h->info_cb.peer_cb)
1000 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1001 " no handler for peer monitor message!\n");
1005 /* Verify message sanity */
1006 esize = ntohs (message->header.size);
1009 GNUNET_break_op (0);
1010 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1013 if (0 != ((esize - msize) % sizeof (struct GNUNET_PeerIdentity)))
1015 GNUNET_break_op (0);
1016 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1020 peers = (esize - msize) / sizeof (struct GNUNET_PeerIdentity);
1021 epaths = (unsigned int) ntohs (message->paths);
1022 paths_array = (struct GNUNET_PeerIdentity *) &message[1];
1024 for (int i = 0; i < peers; i++)
1026 if (0 == memcmp (&paths_array[i], &message->destination,
1027 sizeof (struct GNUNET_PeerIdentity)))
1032 if (paths != epaths)
1034 GNUNET_break_op (0);
1035 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "p:%u, e: %u\n", paths, epaths);
1036 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1043 h->info_cb.peer_cb = NULL;
1045 return GNUNET_SYSERR;
1050 * Process a local peer info reply, pass info to the user.
1052 * @param cls Closure (Cadet handle).
1053 * @param message Message itself.
1056 handle_get_peer (void *cls,
1057 const struct GNUNET_CADET_LocalInfoPeer *message)
1059 struct GNUNET_CADET_Handle *h = cls;
1060 struct GNUNET_PeerIdentity *paths_array;
1062 unsigned int path_length;
1066 paths = (unsigned int) ntohs (message->paths);
1067 paths_array = (struct GNUNET_PeerIdentity *) &message[1];
1068 peers = (ntohs (message->header.size) - sizeof (*message))
1069 / sizeof (struct GNUNET_PeerIdentity);
1071 neighbor = GNUNET_NO;
1073 for (int i = 0; i < peers; i++)
1075 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (&paths_array[i]));
1077 if (0 == memcmp (&paths_array[i], &message->destination,
1078 sizeof (struct GNUNET_PeerIdentity)))
1080 if (1 == path_length)
1081 neighbor = GNUNET_YES;
1086 /* Call Callback with tunnel info. */
1087 paths_array = (struct GNUNET_PeerIdentity *) &message[1];
1088 h->info_cb.peer_cb (h->info_cls,
1089 &message->destination,
1090 (int) ntohs (message->tunnel),
1098 * Check that message received from CADET service is well-formed.
1100 * @param cls the `struct GNUNET_CADET_Handle`
1101 * @param msg the message we got
1102 * @return #GNUNET_OK if the message is well-formed,
1103 * #GNUNET_SYSERR otherwise
1106 check_get_tunnels (void *cls,
1107 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1109 struct GNUNET_CADET_Handle *h = cls;
1112 if (NULL == h->info_cb.tunnels_cb)
1114 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1115 " no handler for tunnels monitor message!\n");
1116 return GNUNET_SYSERR;
1119 size = ntohs (msg->header.size);
1120 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) > size)
1122 h->info_cb.tunnels_cb (h->info_cls, NULL, 0, 0, 0, 0);
1123 h->info_cb.tunnels_cb = NULL;
1125 return GNUNET_SYSERR;
1132 * Process a local reply about info on all tunnels, pass info to the user.
1134 * @param cls Closure (Cadet handle).
1135 * @param message Message itself.
1138 handle_get_tunnels (void *cls,
1139 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1141 struct GNUNET_CADET_Handle *h = cls;
1143 h->info_cb.tunnels_cb (h->info_cls,
1145 ntohl (msg->channels),
1146 ntohl (msg->connections),
1147 ntohs (msg->estate),
1148 ntohs (msg->cstate));
1154 * Check that message received from CADET service is well-formed.
1156 * @param cls the `struct GNUNET_CADET_Handle`
1157 * @param msg the message we got
1158 * @return #GNUNET_OK if the message is well-formed,
1159 * #GNUNET_SYSERR otherwise
1162 check_get_tunnel (void *cls,
1163 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1165 struct GNUNET_CADET_Handle *h = cls;
1171 if (NULL == h->info_cb.tunnel_cb)
1173 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1174 " no handler for tunnel monitor message!\n");
1178 /* Verify message sanity */
1179 msize = ntohs (msg->header.size);
1180 esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1183 GNUNET_break_op (0);
1184 h->info_cb.tunnel_cb (h->info_cls,
1185 NULL, 0, 0, NULL, NULL, 0, 0);
1188 ch_n = ntohl (msg->channels);
1189 c_n = ntohl (msg->connections);
1190 esize += ch_n * sizeof (struct GNUNET_CADET_ChannelTunnelNumber);
1191 esize += c_n * sizeof (struct GNUNET_CADET_ConnectionTunnelIdentifier);
1194 GNUNET_break_op (0);
1195 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1196 "m:%u, e: %u (%u ch, %u conn)\n",
1197 (unsigned int) msize,
1198 (unsigned int) esize,
1201 h->info_cb.tunnel_cb (h->info_cls,
1202 NULL, 0, 0, NULL, NULL, 0, 0);
1209 h->info_cb.tunnel_cb = NULL;
1211 return GNUNET_SYSERR;
1216 * Process a local tunnel info reply, pass info to the user.
1218 * @param cls Closure (Cadet handle).
1219 * @param msg Message itself.
1222 handle_get_tunnel (void *cls,
1223 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1225 struct GNUNET_CADET_Handle *h = cls;
1228 const struct GNUNET_CADET_ConnectionTunnelIdentifier *conns;
1229 const struct GNUNET_CADET_ChannelTunnelNumber *chns;
1231 ch_n = ntohl (msg->channels);
1232 c_n = ntohl (msg->connections);
1234 /* Call Callback with tunnel info. */
1235 conns = (const struct GNUNET_CADET_ConnectionTunnelIdentifier *) &msg[1];
1236 chns = (const struct GNUNET_CADET_ChannelTunnelNumber *) &conns[c_n];
1237 h->info_cb.tunnel_cb (h->info_cls,
1243 ntohs (msg->estate),
1244 ntohs (msg->cstate));
1250 * Reconnect to the service, retransmit all infomation to try to restore the
1253 * @param h handle to the cadet
1254 * @return #GNUNET_YES in case of success, #GNUNET_NO otherwise (service down...)
1257 do_reconnect (struct GNUNET_CADET_Handle *h)
1259 struct GNUNET_MQ_MessageHandler handlers[] = {
1260 GNUNET_MQ_hd_fixed_size (channel_created,
1261 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE,
1262 struct GNUNET_CADET_LocalChannelCreateMessage,
1264 GNUNET_MQ_hd_fixed_size (channel_destroy,
1265 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY,
1266 struct GNUNET_CADET_LocalChannelDestroyMessage,
1268 GNUNET_MQ_hd_var_size (local_data,
1269 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
1270 struct GNUNET_CADET_LocalData,
1272 GNUNET_MQ_hd_fixed_size (local_ack,
1273 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK,
1274 struct GNUNET_CADET_LocalAck,
1276 GNUNET_MQ_hd_var_size (get_peers,
1277 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS,
1278 struct GNUNET_CADET_LocalInfoPeer,
1280 GNUNET_MQ_hd_var_size (get_peer,
1281 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER,
1282 struct GNUNET_CADET_LocalInfoPeer,
1284 GNUNET_MQ_hd_var_size (get_tunnels,
1285 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS,
1286 struct GNUNET_CADET_LocalInfoTunnel,
1288 GNUNET_MQ_hd_var_size (get_tunnel,
1289 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL,
1290 struct GNUNET_CADET_LocalInfoTunnel,
1293 // GNUNET_MQ_hd_fixed_Y size (channel_destroyed,
1294 // GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_NACK_DEPRECATED,
1295 // struct GNUNET_CADET_ChannelDestroyMessage);
1296 GNUNET_MQ_handler_end ()
1299 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting to CADET\n");
1301 GNUNET_assert (NULL == h->mq);
1302 h->mq = GNUNET_CLIENT_connect (h->cfg,
1314 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1320 * Reconnect callback: tries to reconnect again after a failer previous
1323 * @param cls closure (cadet handle)
1326 reconnect_cbk (void *cls)
1328 struct GNUNET_CADET_Handle *h = cls;
1330 h->reconnect_task = NULL;
1336 * Reconnect to the service, retransmit all infomation to try to restore the
1339 * @param h handle to the cadet
1341 * @return #GNUNET_YES in case of sucess, #GNUNET_NO otherwise (service down...)
1344 reconnect (struct GNUNET_CADET_Handle *h)
1346 struct GNUNET_CADET_Channel *ch;
1348 LOG (GNUNET_ERROR_TYPE_DEBUG,
1349 "Requested RECONNECT, destroying all channels\n");
1350 while (NULL != (ch = h->channels_head))
1351 destroy_channel (ch, GNUNET_YES);
1352 if (NULL == h->reconnect_task)
1353 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
1358 /******************************************************************************/
1359 /********************** API CALL DEFINITIONS *************************/
1360 /******************************************************************************/
1362 struct GNUNET_CADET_Handle *
1363 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1365 GNUNET_CADET_ChannelEndHandler cleaner,
1366 const struct GNUNET_CADET_MessageHandler *handlers)
1368 struct GNUNET_CADET_Handle *h;
1370 h = GNUNET_new (struct GNUNET_CADET_Handle);
1371 LOG (GNUNET_ERROR_TYPE_DEBUG,
1372 "GNUNET_CADET_connect() %p\n",
1375 h->cleaner = cleaner;
1376 h->ports = GNUNET_CONTAINER_multihashmap_create (4, GNUNET_YES);
1381 GNUNET_CADET_disconnect (h);
1385 h->message_handlers = handlers;
1386 h->next_ccn.channel_of_client = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
1387 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1388 h->reconnect_task = NULL;
1390 /* count handlers */
1391 for (h->n_handlers = 0;
1392 handlers && handlers[h->n_handlers].type;
1399 * Disconnect from the cadet service. All channels will be destroyed. All channel
1400 * disconnect callbacks will be called on any still connected peers, notifying
1401 * about their disconnection. The registered inbound channel cleaner will be
1402 * called should any inbound channels still exist.
1404 * @param handle connection to cadet to disconnect
1407 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
1409 struct GNUNET_CADET_Channel *ch;
1410 struct GNUNET_CADET_Channel *aux;
1411 struct GNUNET_CADET_TransmitHandle *th;
1413 LOG (GNUNET_ERROR_TYPE_DEBUG,
1414 "CADET DISCONNECT\n");
1415 ch = handle->channels_head;
1419 if (ntohl (ch->ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
1422 LOG (GNUNET_ERROR_TYPE_DEBUG,
1423 "channel %X not destroyed\n",
1424 ntohl (ch->ccn.channel_of_client));
1426 destroy_channel (ch,
1430 while (NULL != (th = handle->th_head))
1432 struct GNUNET_MessageHeader *msg;
1434 /* Make sure it is an allowed packet (everything else should have been
1435 * already canceled).
1437 GNUNET_break (GNUNET_NO == th_is_payload (th));
1438 msg = (struct GNUNET_MessageHeader *) &th[1];
1439 switch (ntohs(msg->type))
1441 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN:
1442 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY:
1443 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN:
1444 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE:
1445 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNELS:
1446 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL:
1447 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER:
1448 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS:
1449 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL:
1450 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS:
1454 LOG (GNUNET_ERROR_TYPE_ERROR, "unexpected unsent msg %s\n",
1455 GC_m2s (ntohs(msg->type)));
1458 GNUNET_CADET_notify_transmit_ready_cancel (th);
1461 if (NULL != handle->mq)
1463 GNUNET_MQ_destroy (handle->mq);
1466 if (NULL != handle->reconnect_task)
1468 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1469 handle->reconnect_task = NULL;
1472 GNUNET_CONTAINER_multihashmap_destroy (handle->ports);
1473 handle->ports = NULL;
1474 GNUNET_free (handle);
1479 * Open a port to receive incomming channels.
1481 * @param h CADET handle.
1482 * @param port Hash representing the port number.
1483 * @param new_channel Function called when an channel is received.
1484 * @param new_channel_cls Closure for @a new_channel.
1485 * @return Port handle.
1487 struct GNUNET_CADET_Port *
1488 GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
1489 const struct GNUNET_HashCode *port,
1490 GNUNET_CADET_InboundChannelNotificationHandler
1492 void *new_channel_cls)
1494 struct GNUNET_CADET_PortMessage *msg;
1495 struct GNUNET_MQ_Envelope *env;
1496 struct GNUNET_CADET_Port *p;
1498 GNUNET_assert (NULL != new_channel);
1499 p = GNUNET_new (struct GNUNET_CADET_Port);
1501 p->hash = GNUNET_new (struct GNUNET_HashCode);
1503 p->handler = new_channel;
1504 p->cls = new_channel_cls;
1505 GNUNET_assert (GNUNET_OK ==
1506 GNUNET_CONTAINER_multihashmap_put (h->ports,
1509 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1511 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN);
1512 msg->port = *p->hash;
1513 GNUNET_MQ_send (h->mq, env);
1519 * Close a port opened with @a GNUNET_CADET_open_port.
1520 * The @a new_channel callback will no longer be called.
1522 * @param p Port handle.
1525 GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p)
1527 struct GNUNET_CADET_PortMessage *msg;
1528 struct GNUNET_MQ_Envelope *env;
1530 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE);
1532 msg->port = *p->hash;
1533 GNUNET_MQ_send (p->cadet->mq, env);
1534 GNUNET_CONTAINER_multihashmap_remove (p->cadet->ports, p->hash, p);
1535 GNUNET_free (p->hash);
1541 * Create a new channel towards a remote peer.
1543 * If the destination port is not open by any peer or the destination peer
1544 * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
1547 * @param h cadet handle
1548 * @param channel_ctx client's channel context to associate with the channel
1549 * @param peer peer identity the channel should go to
1550 * @param port Port hash (port number).
1551 * @param options CadetOption flag field, with all desired option bits set to 1.
1552 * @return handle to the channel
1554 struct GNUNET_CADET_Channel *
1555 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
1557 const struct GNUNET_PeerIdentity *peer,
1558 const struct GNUNET_HashCode *port,
1559 enum GNUNET_CADET_ChannelOption options)
1561 struct GNUNET_CADET_LocalChannelCreateMessage *msg;
1562 struct GNUNET_MQ_Envelope *env;
1563 struct GNUNET_CADET_Channel *ch;
1564 struct GNUNET_CADET_ClientChannelNumber ccn;
1566 ccn.channel_of_client = htonl (0);
1567 ch = create_channel (h, ccn);
1568 ch->ctx = channel_ctx;
1569 ch->peer = GNUNET_PEER_intern (peer);
1571 LOG (GNUNET_ERROR_TYPE_DEBUG,
1572 "Creating new channel to %s:%u at %p number %X\n",
1576 ntohl (ch->ccn.channel_of_client));
1577 env = GNUNET_MQ_msg (msg,
1578 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE);
1582 msg->opt = htonl (options);
1583 GNUNET_MQ_send (h->mq,
1590 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
1592 struct GNUNET_CADET_Handle *h;
1593 struct GNUNET_CADET_LocalChannelDestroyMessage *msg;
1594 struct GNUNET_MQ_Envelope *env;
1595 struct GNUNET_CADET_TransmitHandle *th;
1596 struct GNUNET_CADET_TransmitHandle *next;
1598 LOG (GNUNET_ERROR_TYPE_DEBUG,
1599 "Destroying channel\n");
1601 for (th = h->th_head; th != NULL; th = next)
1604 if (th->channel == channel)
1607 if (GNUNET_YES == th_is_payload (th))
1609 /* applications should cancel before destroying channel */
1610 LOG (GNUNET_ERROR_TYPE_WARNING,
1611 "Channel destroyed without cancelling transmission requests\n");
1612 th->notify (th->notify_cls, 0, NULL);
1616 LOG (GNUNET_ERROR_TYPE_WARNING,
1617 "no meta-traffic should be queued\n");
1619 GNUNET_CONTAINER_DLL_remove (h->th_head,
1622 GNUNET_CADET_notify_transmit_ready_cancel (th);
1626 env = GNUNET_MQ_msg (msg,
1627 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
1628 msg->ccn = channel->ccn;
1629 GNUNET_MQ_send (h->mq,
1632 destroy_channel (channel,
1638 * Get information about a channel.
1640 * @param channel Channel handle.
1641 * @param option Query (GNUNET_CADET_OPTION_*).
1642 * @param ... dependant on option, currently not used
1644 * @return Union with an answer to the query.
1646 const union GNUNET_CADET_ChannelInfo *
1647 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
1648 enum GNUNET_CADET_ChannelOption option, ...)
1650 static int bool_flag;
1651 const union GNUNET_CADET_ChannelInfo *ret;
1655 case GNUNET_CADET_OPTION_NOBUFFER:
1656 case GNUNET_CADET_OPTION_RELIABLE:
1657 case GNUNET_CADET_OPTION_OUT_OF_ORDER:
1658 if (0 != (option & channel->options))
1659 bool_flag = GNUNET_YES;
1661 bool_flag = GNUNET_NO;
1662 ret = (const union GNUNET_CADET_ChannelInfo *) &bool_flag;
1664 case GNUNET_CADET_OPTION_PEER:
1665 ret = (const union GNUNET_CADET_ChannelInfo *) GNUNET_PEER_resolve2 (channel->peer);
1676 struct GNUNET_CADET_TransmitHandle *
1677 GNUNET_CADET_notify_transmit_ready (struct GNUNET_CADET_Channel *channel,
1679 struct GNUNET_TIME_Relative maxdelay,
1681 GNUNET_CONNECTION_TransmitReadyNotify notify,
1684 struct GNUNET_CADET_TransmitHandle *th;
1686 GNUNET_assert (NULL != channel);
1687 GNUNET_assert (NULL != notify);
1688 GNUNET_assert (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE >= notify_size);
1689 LOG (GNUNET_ERROR_TYPE_DEBUG,
1690 "CADET NOTIFY TRANSMIT READY on channel %X allow_send is %u to %s with %u bytes\n",
1691 ntohl (channel->ccn.channel_of_client),
1692 channel->allow_send,
1693 (ntohl (channel->ccn.channel_of_client) >=
1694 GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
1697 (unsigned int) notify_size);
1698 if (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us != maxdelay.rel_value_us)
1700 LOG (GNUNET_ERROR_TYPE_WARNING,
1701 "CADET transmit ready timeout is deprected (has no effect)\n");
1704 th = GNUNET_new (struct GNUNET_CADET_TransmitHandle);
1705 th->channel = channel;
1706 th->size = notify_size;
1707 th->notify = notify;
1708 th->notify_cls = notify_cls;
1709 if (0 != channel->allow_send)
1710 th->request_data_task
1711 = GNUNET_SCHEDULER_add_now (&request_data,
1714 add_to_queue (channel->cadet,
1721 GNUNET_CADET_notify_transmit_ready_cancel (struct GNUNET_CADET_TransmitHandle *th)
1723 if (NULL != th->request_data_task)
1725 GNUNET_SCHEDULER_cancel (th->request_data_task);
1726 th->request_data_task = NULL;
1728 remove_from_queue (th);
1734 * Send an ack on the channel to confirm the processing of a message.
1736 * @param ch Channel on which to send the ACK.
1739 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
1741 struct GNUNET_CADET_LocalAck *msg;
1742 struct GNUNET_MQ_Envelope *env;
1744 env = GNUNET_MQ_msg (msg,
1745 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
1746 LOG (GNUNET_ERROR_TYPE_DEBUG,
1747 "Sending ACK on channel %X\n",
1748 ntohl (channel->ccn.channel_of_client));
1749 msg->ccn = channel->ccn;
1750 GNUNET_MQ_send (channel->cadet->mq,
1756 send_info_request (struct GNUNET_CADET_Handle *h, uint16_t type)
1758 struct GNUNET_MessageHeader *msg;
1759 struct GNUNET_MQ_Envelope *env;
1761 LOG (GNUNET_ERROR_TYPE_DEBUG,
1762 " Sending %s monitor message to service\n",
1765 env = GNUNET_MQ_msg (msg, type);
1766 GNUNET_MQ_send (h->mq, env);
1771 * Request a debug dump on the service's STDERR.
1773 * WARNING: unstable API, likely to change in the future!
1775 * @param h cadet handle
1778 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h)
1780 LOG (GNUNET_ERROR_TYPE_DEBUG, "requesting dump\n");
1781 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP);
1786 * Request information about peers known to the running cadet service.
1787 * The callback will be called for every peer known to the service.
1788 * Only one info request (of any kind) can be active at once.
1791 * WARNING: unstable API, likely to change in the future!
1793 * @param h Handle to the cadet peer.
1794 * @param callback Function to call with the requested data.
1795 * @param callback_cls Closure for @c callback.
1797 * @return #GNUNET_OK / #GNUNET_SYSERR
1800 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
1801 GNUNET_CADET_PeersCB callback,
1804 if (NULL != h->info_cb.peers_cb)
1807 return GNUNET_SYSERR;
1809 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
1810 h->info_cb.peers_cb = callback;
1811 h->info_cls = callback_cls;
1817 * Cancel a peer info request. The callback will not be called (anymore).
1819 * WARNING: unstable API, likely to change in the future!
1821 * @param h Cadet handle.
1823 * @return Closure given to GNUNET_CADET_get_peers.
1826 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h)
1831 h->info_cb.peers_cb = NULL;
1838 * Request information about a peer known to the running cadet peer.
1839 * The callback will be called for the tunnel once.
1840 * Only one info request (of any kind) can be active at once.
1842 * WARNING: unstable API, likely to change in the future!
1844 * @param h Handle to the cadet peer.
1845 * @param id Peer whose tunnel to examine.
1846 * @param callback Function to call with the requested data.
1847 * @param callback_cls Closure for @c callback.
1849 * @return #GNUNET_OK / #GNUNET_SYSERR
1852 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
1853 const struct GNUNET_PeerIdentity *id,
1854 GNUNET_CADET_PeerCB callback,
1857 struct GNUNET_CADET_LocalInfo *msg;
1858 struct GNUNET_MQ_Envelope *env;
1860 if (NULL != h->info_cb.peer_cb)
1863 return GNUNET_SYSERR;
1866 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
1868 GNUNET_MQ_send (h->mq, env);
1870 h->info_cb.peer_cb = callback;
1871 h->info_cls = callback_cls;
1877 * Request information about tunnels of the running cadet peer.
1878 * The callback will be called for every tunnel of the service.
1879 * Only one info request (of any kind) can be active at once.
1881 * WARNING: unstable API, likely to change in the future!
1883 * @param h Handle to the cadet peer.
1884 * @param callback Function to call with the requested data.
1885 * @param callback_cls Closure for @c callback.
1887 * @return #GNUNET_OK / #GNUNET_SYSERR
1890 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
1891 GNUNET_CADET_TunnelsCB callback,
1894 if (NULL != h->info_cb.tunnels_cb)
1897 return GNUNET_SYSERR;
1899 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
1900 h->info_cb.tunnels_cb = callback;
1901 h->info_cls = callback_cls;
1907 * Cancel a monitor request. The monitor callback will not be called.
1909 * @param h Cadet handle.
1911 * @return Closure given to GNUNET_CADET_get_tunnels.
1914 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h)
1918 h->info_cb.tunnels_cb = NULL;
1928 * Request information about a tunnel of the running cadet peer.
1929 * The callback will be called for the tunnel once.
1930 * Only one info request (of any kind) can be active at once.
1932 * WARNING: unstable API, likely to change in the future!
1934 * @param h Handle to the cadet peer.
1935 * @param id Peer whose tunnel to examine.
1936 * @param callback Function to call with the requested data.
1937 * @param callback_cls Closure for @c callback.
1939 * @return #GNUNET_OK / #GNUNET_SYSERR
1942 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
1943 const struct GNUNET_PeerIdentity *id,
1944 GNUNET_CADET_TunnelCB callback,
1947 struct GNUNET_CADET_LocalInfo *msg;
1948 struct GNUNET_MQ_Envelope *env;
1950 if (NULL != h->info_cb.tunnel_cb)
1953 return GNUNET_SYSERR;
1956 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
1958 GNUNET_MQ_send (h->mq, env);
1960 h->info_cb.tunnel_cb = callback;
1961 h->info_cls = callback_cls;
1967 * Request information about a specific channel of the running cadet peer.
1969 * WARNING: unstable API, likely to change in the future!
1970 * FIXME Add destination option.
1972 * @param h Handle to the cadet peer.
1973 * @param initiator ID of the owner of the channel.
1974 * @param channel_number Channel number.
1975 * @param callback Function to call with the requested data.
1976 * @param callback_cls Closure for @c callback.
1978 * @return #GNUNET_OK / #GNUNET_SYSERR
1981 GNUNET_CADET_show_channel (struct GNUNET_CADET_Handle *h,
1982 struct GNUNET_PeerIdentity *initiator,
1983 unsigned int channel_number,
1984 GNUNET_CADET_ChannelCB callback,
1987 struct GNUNET_CADET_LocalInfo *msg;
1988 struct GNUNET_MQ_Envelope *env;
1990 if (NULL != h->info_cb.channel_cb)
1993 return GNUNET_SYSERR;
1996 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL);
1997 msg->peer = *initiator;
1998 msg->ccn.channel_of_client = htonl (channel_number);
1999 GNUNET_MQ_send (h->mq, env);
2001 h->info_cb.channel_cb = callback;
2002 h->info_cls = callback_cls;
2008 * Function called to notify a client about the connection
2009 * begin ready to queue more data. "buf" will be
2010 * NULL and "size" zero if the connection was closed for
2011 * writing in the meantime.
2013 * @param cls closure
2014 * @param size number of bytes available in buf
2015 * @param buf where the callee should write the message
2016 * @return number of bytes written to buf
2019 cadet_mq_ntr (void *cls, size_t size,
2022 struct GNUNET_MQ_Handle *mq = cls;
2023 struct CadetMQState *state = GNUNET_MQ_impl_state (mq);
2024 const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq);
2030 GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_WRITE);
2033 msize = ntohs (msg->size);
2034 GNUNET_assert (msize <= size);
2035 GNUNET_memcpy (buf, msg, msize);
2036 GNUNET_MQ_impl_send_continue (mq);
2042 * Signature of functions implementing the
2043 * sending functionality of a message queue.
2045 * @param mq the message queue
2046 * @param msg the message to send
2047 * @param impl_state state of the implementation
2050 cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq,
2051 const struct GNUNET_MessageHeader *msg,
2054 struct CadetMQState *state = impl_state;
2056 GNUNET_assert (NULL == state->th);
2058 GNUNET_CADET_notify_transmit_ready (state->channel,
2059 /* FIXME: add option for corking */
2061 GNUNET_TIME_UNIT_FOREVER_REL,
2069 * Signature of functions implementing the
2070 * destruction of a message queue.
2071 * Implementations must not free 'mq', but should
2072 * take care of 'impl_state'.
2074 * @param mq the message queue to destroy
2075 * @param impl_state state of the implementation
2078 cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq,
2081 struct CadetMQState *state = impl_state;
2083 if (NULL != state->th)
2084 GNUNET_CADET_notify_transmit_ready_cancel (state->th);
2086 GNUNET_free (state);
2091 * Create a message queue for a cadet channel.
2092 * The message queue can only be used to transmit messages,
2093 * not to receive them.
2095 * @param channel the channel to create the message qeue for
2096 * @return a message queue to messages over the channel
2098 struct GNUNET_MQ_Handle *
2099 GNUNET_CADET_mq_create (struct GNUNET_CADET_Channel *channel)
2101 struct GNUNET_MQ_Handle *mq;
2102 struct CadetMQState *state;
2104 state = GNUNET_new (struct CadetMQState);
2105 state->channel = channel;
2107 mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
2108 &cadet_mq_destroy_impl,
2109 NULL, /* FIXME: cancel impl. */
2111 NULL, /* no msg handlers */
2112 NULL, /* no err handlers */
2113 NULL); /* no handler cls */
2119 * Transitional function to convert an unsigned int port to a hash value.
2120 * WARNING: local static value returned, NOT reentrant!
2121 * WARNING: do not use this function for new code!
2123 * @param port Numerical port (unsigned int format).
2125 * @return A GNUNET_HashCode usable for the new CADET API.
2127 const struct GNUNET_HashCode *
2128 GC_u2h (uint32_t port)
2130 static struct GNUNET_HashCode hash;
2132 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2133 "This is a transitional function, "
2134 "use proper crypto hashes as CADET ports\n");
2135 GNUNET_CRYPTO_hash (&port, sizeof (port), &hash);