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);
483 * Add a transmit handle to the transmission queue and set the
486 * @param h cadet handle with the queue head and tail
487 * @param th handle to the packet to be transmitted
490 add_to_queue (struct GNUNET_CADET_Handle *h,
491 struct GNUNET_CADET_TransmitHandle *th)
493 GNUNET_CONTAINER_DLL_insert_tail (h->th_head, h->th_tail, th);
498 * Remove a transmit handle from the transmission queue, if present.
500 * Safe to call even if not queued.
502 * @param th handle to the packet to be unqueued.
505 remove_from_queue (struct GNUNET_CADET_TransmitHandle *th)
507 struct GNUNET_CADET_Handle *h = th->channel->cadet;
509 /* It might or might not have been queued (rarely not), but check anyway. */
510 if (NULL != th->next || h->th_tail == th)
512 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
518 * Send an ack on the channel to confirm the processing of a message.
520 * @param ch Channel on which to send the ACK.
523 send_ack (struct GNUNET_CADET_Channel *ch)
525 struct GNUNET_CADET_LocalAck *msg;
526 struct GNUNET_MQ_Envelope *env;
528 env = GNUNET_MQ_msg (msg,
529 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
531 LOG (GNUNET_ERROR_TYPE_DEBUG,
532 "Sending ACK on channel %X\n",
533 ch->ccn.channel_of_client);
535 GNUNET_MQ_send (ch->cadet->mq,
541 /******************************************************************************/
542 /*********************** RECEIVE HANDLERS ****************************/
543 /******************************************************************************/
547 * Call the @a notify callback given to #GNUNET_CADET_notify_transmit_ready to
548 * request the data to send over MQ. Since MQ manages the queue, this function
549 * is scheduled immediatly after a transmit ready notification.
551 * @param cls Closure (transmit handle).
554 request_data (void *cls)
556 struct GNUNET_CADET_TransmitHandle *th = cls;
557 struct GNUNET_CADET_LocalData *msg;
558 struct GNUNET_MQ_Envelope *env;
561 LOG (GNUNET_ERROR_TYPE_DEBUG,
562 "Requesting Data: %u bytes\n",
565 GNUNET_assert (0 < th->channel->allow_send);
566 th->channel->allow_send--;
567 /* NOTE: we may be allowed to send another packet immediately,
568 albeit the current logic waits for the ACK. */
569 th->request_data_task = NULL;
570 remove_from_queue (th);
572 env = GNUNET_MQ_msg_extra (msg,
574 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA);
575 msg->ccn = th->channel->ccn;
576 osize = th->notify (th->notify_cls,
579 GNUNET_assert (osize == th->size);
580 GNUNET_MQ_send (th->channel->cadet->mq,
587 * Process the new channel notification and add it to the channels in the handle
589 * @param h The cadet handle
590 * @param msg A message with the details of the new incoming channel
593 handle_channel_created (void *cls,
594 const struct GNUNET_CADET_LocalChannelCreateMessage *msg)
596 struct GNUNET_CADET_Handle *h = cls;
597 struct GNUNET_CADET_Channel *ch;
598 struct GNUNET_CADET_Port *port;
599 const struct GNUNET_HashCode *port_number;
600 struct GNUNET_CADET_ClientChannelNumber ccn;
603 port_number = &msg->port;
604 LOG (GNUNET_ERROR_TYPE_DEBUG,
605 "Creating incoming channel %X [%s]\n",
606 ntohl (ccn.channel_of_client),
607 GNUNET_h2s (port_number));
608 if (ntohl (ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
613 port = find_port (h, port_number);
618 ch = create_channel (h, ccn);
619 ch->peer = GNUNET_PEER_intern (&msg->peer);
623 ch->options = ntohl (msg->opt);
625 LOG (GNUNET_ERROR_TYPE_DEBUG, " created channel %p\n", ch);
626 ctx = port->handler (port->cls, ch, &msg->peer, port->hash, ch->options);
629 LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
633 struct GNUNET_CADET_LocalChannelDestroyMessage *d_msg;
634 struct GNUNET_MQ_Envelope *env;
636 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming channels\n");
637 env = GNUNET_MQ_msg (d_msg,
638 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
639 d_msg->ccn = msg->ccn;
640 GNUNET_MQ_send (h->mq, env);
647 * Process the channel destroy notification and free associated resources
649 * @param h The cadet handle
650 * @param msg A message with the details of the channel being destroyed
653 handle_channel_destroy (void *cls,
654 const struct GNUNET_CADET_LocalChannelDestroyMessage *msg)
656 struct GNUNET_CADET_Handle *h = cls;
657 struct GNUNET_CADET_Channel *ch;
658 struct GNUNET_CADET_ClientChannelNumber ccn;
661 LOG (GNUNET_ERROR_TYPE_DEBUG,
662 "Channel %X Destroy from service\n",
663 ntohl (ccn.channel_of_client));
664 ch = retrieve_channel (h,
669 LOG (GNUNET_ERROR_TYPE_DEBUG,
670 "channel %X unknown\n",
671 ntohl (ccn.channel_of_client));
680 * Check that message received from CADET service is well-formed.
682 * @param cls the `struct GNUNET_CADET_Handle`
683 * @param message the message we got
684 * @return #GNUNET_OK if the message is well-formed,
685 * #GNUNET_SYSERR otherwise
688 check_local_data (void *cls,
689 const struct GNUNET_CADET_LocalData *message)
691 struct GNUNET_CADET_Handle *h = cls;
692 struct GNUNET_CADET_Channel *ch;
695 size = ntohs (message->header.size);
696 if (sizeof (*message) + sizeof (struct GNUNET_MessageHeader) > size)
699 return GNUNET_SYSERR;
702 ch = retrieve_channel (h,
707 return GNUNET_SYSERR;
715 * Process the incoming data packets, call appropriate handlers.
717 * @param h The cadet handle
718 * @param message A message encapsulating the data
721 handle_local_data (void *cls,
722 const struct GNUNET_CADET_LocalData *message)
724 struct GNUNET_CADET_Handle *h = cls;
725 const struct GNUNET_MessageHeader *payload;
726 const struct GNUNET_CADET_MessageHandler *handler;
727 struct GNUNET_CADET_Channel *ch;
731 LOG (GNUNET_ERROR_TYPE_DEBUG,
732 "Got a data message!\n");
733 ch = retrieve_channel (h,
735 GNUNET_assert (NULL != ch);
737 payload = (struct GNUNET_MessageHeader *) &message[1];
738 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s data on channel %s [%X]\n",
739 GC_f2s (ntohl (ch->ccn.channel_of_client) >=
740 GNUNET_CADET_LOCAL_CHANNEL_ID_CLI),
741 GNUNET_i2s (GNUNET_PEER_resolve2 (ch->peer)),
742 ntohl (message->ccn.channel_of_client));
744 type = ntohs (payload->type);
745 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload type %s\n", GC_m2s (type));
746 for (i = 0; i < h->n_handlers; i++)
748 handler = &h->message_handlers[i];
749 LOG (GNUNET_ERROR_TYPE_DEBUG, " checking handler for type %u\n",
751 if (handler->type == type)
754 handler->callback (h->cls, ch, &ch->ctx, payload))
756 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
757 GNUNET_CADET_channel_destroy (ch);
762 LOG (GNUNET_ERROR_TYPE_DEBUG,
763 "callback completed successfully\n");
772 * Process a local ACK message, enabling the client to send
773 * more data to the service.
775 * @param h Cadet handle.
776 * @param message Message itself.
779 handle_local_ack (void *cls,
780 const struct GNUNET_CADET_LocalAck *message)
782 struct GNUNET_CADET_Handle *h = cls;
783 struct GNUNET_CADET_Channel *ch;
784 struct GNUNET_CADET_ClientChannelNumber ccn;
785 struct GNUNET_CADET_TransmitHandle *th;
788 ch = retrieve_channel (h, ccn);
791 LOG (GNUNET_ERROR_TYPE_DEBUG,
792 "ACK on unknown channel %X\n",
793 ntohl (ccn.channel_of_client));
796 LOG (GNUNET_ERROR_TYPE_DEBUG,
797 "Got an ACK on channel %X!\n",
798 ntohl (ch->ccn.channel_of_client));
800 LOG (GNUNET_ERROR_TYPE_DEBUG,
801 "Checking for pending data\n");
802 for (th = h->th_head; NULL != th; th = th->next)
804 if ( (th->channel == ch) &&
805 (NULL == th->request_data_task) )
807 th->request_data_task
808 = GNUNET_SCHEDULER_add_now (&request_data,
816 * Reconnect to the service, retransmit all infomation to try to restore the
819 * @param h handle to the cadet
821 * @return #GNUNET_YES in case of sucess, #GNUNET_NO otherwise (service down...)
824 reconnect (struct GNUNET_CADET_Handle *h);
828 * Reconnect callback: tries to reconnect again after a failer previous
831 * @param cls closure (cadet handle)
834 reconnect_cbk (void *cls);
838 * Generic error handler, called with the appropriate error code and
839 * the same closure specified at the creation of the message queue.
840 * Not every message queue implementation supports an error handler.
842 * @param cls closure, a `struct GNUNET_CORE_Handle *`
843 * @param error error code
846 handle_mq_error (void *cls,
847 enum GNUNET_MQ_Error error)
849 struct GNUNET_CADET_Handle *h = cls;
851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "MQ ERROR: %u\n", error);
852 GNUNET_MQ_destroy (h->mq);
859 * Process a local reply about info on all channels, pass info to the user.
861 * @param h Cadet handle.
862 * @param message Message itself.
865 // process_get_channels (struct GNUNET_CADET_Handle *h,
866 // const struct GNUNET_MessageHeader *message)
868 // struct GNUNET_CADET_LocalInfo *msg;
870 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Get Channels messasge received\n");
872 // if (NULL == h->channels_cb)
874 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
878 // msg = (struct GNUNET_CADET_LocalInfo *) message;
879 // if (ntohs (message->size) !=
880 // (sizeof (struct GNUNET_CADET_LocalInfo) +
881 // sizeof (struct GNUNET_PeerIdentity)))
883 // GNUNET_break_op (0);
884 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
885 // "Get channels message: size %hu - expected %u\n",
886 // ntohs (message->size),
887 // sizeof (struct GNUNET_CADET_LocalInfo));
890 // h->channels_cb (h->channels_cls,
891 // ntohl (msg->channel_id),
893 // &msg->destination);
899 * Process a local monitor_channel reply, pass info to the user.
901 * @param h Cadet handle.
902 * @param message Message itself.
905 // process_show_channel (struct GNUNET_CADET_Handle *h,
906 // const struct GNUNET_MessageHeader *message)
908 // struct GNUNET_CADET_LocalInfo *msg;
911 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Show Channel messasge received\n");
913 // if (NULL == h->channel_cb)
915 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
919 // /* Verify message sanity */
920 // msg = (struct GNUNET_CADET_LocalInfo *) message;
921 // esize = sizeof (struct GNUNET_CADET_LocalInfo);
922 // if (ntohs (message->size) != esize)
924 // GNUNET_break_op (0);
925 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
926 // "Show channel message: size %hu - expected %u\n",
927 // ntohs (message->size),
930 // h->channel_cb (h->channel_cls, NULL, NULL);
931 // h->channel_cb = NULL;
932 // h->channel_cls = NULL;
937 // h->channel_cb (h->channel_cls,
938 // &msg->destination,
945 * Check that message received from CADET service is well-formed.
947 * @param cls the `struct GNUNET_CADET_Handle`
948 * @param message the message we got
949 * @return #GNUNET_OK if the message is well-formed,
950 * #GNUNET_SYSERR otherwise
953 check_get_peers (void *cls,
954 const struct GNUNET_CADET_LocalInfoPeer *message)
956 struct GNUNET_CADET_Handle *h = cls;
959 if (NULL == h->info_cb.peers_cb)
961 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
962 " no handler for peesr monitor message!\n");
963 return GNUNET_SYSERR;
966 size = ntohs (message->header.size);
967 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) > size)
969 h->info_cb.peers_cb (h->info_cls, NULL, -1, 0, 0);
970 h->info_cb.peers_cb = NULL;
972 return GNUNET_SYSERR;
980 * Process a local reply about info on all tunnels, pass info to the user.
982 * @param cls Closure (Cadet handle).
983 * @param msg Message itself.
986 handle_get_peers (void *cls,
987 const struct GNUNET_CADET_LocalInfoPeer *msg)
989 struct GNUNET_CADET_Handle *h = cls;
990 h->info_cb.peers_cb (h->info_cls, &msg->destination,
991 (int) ntohs (msg->tunnel),
992 (unsigned int ) ntohs (msg->paths),
998 * Check that message received from CADET service is well-formed.
1000 * @param cls the `struct GNUNET_CADET_Handle`
1001 * @param message the message we got
1002 * @return #GNUNET_OK if the message is well-formed,
1003 * #GNUNET_SYSERR otherwise
1006 check_get_peer (void *cls,
1007 const struct GNUNET_CADET_LocalInfoPeer *message)
1009 struct GNUNET_CADET_Handle *h = cls;
1010 const size_t msize = sizeof (struct GNUNET_CADET_LocalInfoPeer);
1011 struct GNUNET_PeerIdentity *paths_array;
1013 unsigned int epaths;
1017 if (NULL == h->info_cb.peer_cb)
1019 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1020 " no handler for peer monitor message!\n");
1024 /* Verify message sanity */
1025 esize = ntohs (message->header.size);
1028 GNUNET_break_op (0);
1029 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1032 if (0 != ((esize - msize) % sizeof (struct GNUNET_PeerIdentity)))
1034 GNUNET_break_op (0);
1035 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1039 peers = (esize - msize) / sizeof (struct GNUNET_PeerIdentity);
1040 epaths = (unsigned int) ntohs (message->paths);
1041 paths_array = (struct GNUNET_PeerIdentity *) &message[1];
1043 for (int i = 0; i < peers; i++)
1045 if (0 == memcmp (&paths_array[i], &message->destination,
1046 sizeof (struct GNUNET_PeerIdentity)))
1051 if (paths != epaths)
1053 GNUNET_break_op (0);
1054 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "p:%u, e: %u\n", paths, epaths);
1055 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1062 h->info_cb.peer_cb = NULL;
1064 return GNUNET_SYSERR;
1069 * Process a local peer info reply, pass info to the user.
1071 * @param cls Closure (Cadet handle).
1072 * @param message Message itself.
1075 handle_get_peer (void *cls,
1076 const struct GNUNET_CADET_LocalInfoPeer *message)
1078 struct GNUNET_CADET_Handle *h = cls;
1079 struct GNUNET_PeerIdentity *paths_array;
1081 unsigned int path_length;
1085 paths = (unsigned int) ntohs (message->paths);
1086 paths_array = (struct GNUNET_PeerIdentity *) &message[1];
1087 peers = (ntohs (message->header.size) - sizeof (*message))
1088 / sizeof (struct GNUNET_PeerIdentity);
1090 neighbor = GNUNET_NO;
1092 for (int i = 0; i < peers; i++)
1094 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (&paths_array[i]));
1096 if (0 == memcmp (&paths_array[i], &message->destination,
1097 sizeof (struct GNUNET_PeerIdentity)))
1099 if (1 == path_length)
1100 neighbor = GNUNET_YES;
1105 /* Call Callback with tunnel info. */
1106 paths_array = (struct GNUNET_PeerIdentity *) &message[1];
1107 h->info_cb.peer_cb (h->info_cls,
1108 &message->destination,
1109 (int) ntohs (message->tunnel),
1117 * Check that message received from CADET service is well-formed.
1119 * @param cls the `struct GNUNET_CADET_Handle`
1120 * @param msg the message we got
1121 * @return #GNUNET_OK if the message is well-formed,
1122 * #GNUNET_SYSERR otherwise
1125 check_get_tunnels (void *cls,
1126 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1128 struct GNUNET_CADET_Handle *h = cls;
1131 if (NULL == h->info_cb.tunnels_cb)
1133 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1134 " no handler for tunnels monitor message!\n");
1135 return GNUNET_SYSERR;
1138 size = ntohs (msg->header.size);
1139 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) > size)
1141 h->info_cb.tunnels_cb (h->info_cls, NULL, 0, 0, 0, 0);
1142 h->info_cb.tunnels_cb = NULL;
1144 return GNUNET_SYSERR;
1151 * Process a local reply about info on all tunnels, pass info to the user.
1153 * @param cls Closure (Cadet handle).
1154 * @param message Message itself.
1157 handle_get_tunnels (void *cls,
1158 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1160 struct GNUNET_CADET_Handle *h = cls;
1162 h->info_cb.tunnels_cb (h->info_cls,
1164 ntohl (msg->channels),
1165 ntohl (msg->connections),
1166 ntohs (msg->estate),
1167 ntohs (msg->cstate));
1173 * Check that message received from CADET service is well-formed.
1175 * @param cls the `struct GNUNET_CADET_Handle`
1176 * @param msg the message we got
1177 * @return #GNUNET_OK if the message is well-formed,
1178 * #GNUNET_SYSERR otherwise
1181 check_get_tunnel (void *cls,
1182 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1184 struct GNUNET_CADET_Handle *h = cls;
1190 if (NULL == h->info_cb.tunnel_cb)
1192 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1193 " no handler for tunnel monitor message!\n");
1197 /* Verify message sanity */
1198 msize = ntohs (msg->header.size);
1199 esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1202 GNUNET_break_op (0);
1203 h->info_cb.tunnel_cb (h->info_cls,
1204 NULL, 0, 0, NULL, NULL, 0, 0);
1207 ch_n = ntohl (msg->channels);
1208 c_n = ntohl (msg->connections);
1209 esize += ch_n * sizeof (struct GNUNET_CADET_ChannelTunnelNumber);
1210 esize += c_n * sizeof (struct GNUNET_CADET_ConnectionTunnelIdentifier);
1213 GNUNET_break_op (0);
1214 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1215 "m:%u, e: %u (%u ch, %u conn)\n",
1216 (unsigned int) msize,
1217 (unsigned int) esize,
1220 h->info_cb.tunnel_cb (h->info_cls,
1221 NULL, 0, 0, NULL, NULL, 0, 0);
1228 h->info_cb.tunnel_cb = NULL;
1230 return GNUNET_SYSERR;
1235 * Process a local tunnel info reply, pass info to the user.
1237 * @param cls Closure (Cadet handle).
1238 * @param msg Message itself.
1241 handle_get_tunnel (void *cls,
1242 const struct GNUNET_CADET_LocalInfoTunnel *msg)
1244 struct GNUNET_CADET_Handle *h = cls;
1247 const struct GNUNET_CADET_ConnectionTunnelIdentifier *conns;
1248 const struct GNUNET_CADET_ChannelTunnelNumber *chns;
1250 ch_n = ntohl (msg->channels);
1251 c_n = ntohl (msg->connections);
1253 /* Call Callback with tunnel info. */
1254 conns = (const struct GNUNET_CADET_ConnectionTunnelIdentifier *) &msg[1];
1255 chns = (const struct GNUNET_CADET_ChannelTunnelNumber *) &conns[c_n];
1256 h->info_cb.tunnel_cb (h->info_cls,
1262 ntohs (msg->estate),
1263 ntohs (msg->cstate));
1269 * Reconnect to the service, retransmit all infomation to try to restore the
1272 * @param h handle to the cadet
1274 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
1277 do_reconnect (struct GNUNET_CADET_Handle *h)
1279 struct GNUNET_MQ_MessageHandler handlers[] = {
1280 GNUNET_MQ_hd_fixed_size (channel_created,
1281 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE,
1282 struct GNUNET_CADET_LocalChannelCreateMessage,
1284 GNUNET_MQ_hd_fixed_size (channel_destroy,
1285 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY,
1286 struct GNUNET_CADET_LocalChannelDestroyMessage,
1288 GNUNET_MQ_hd_var_size (local_data,
1289 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA,
1290 struct GNUNET_CADET_LocalData,
1292 GNUNET_MQ_hd_fixed_size (local_ack,
1293 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK,
1294 struct GNUNET_CADET_LocalAck,
1296 GNUNET_MQ_hd_var_size (get_peers,
1297 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS,
1298 struct GNUNET_CADET_LocalInfoPeer,
1300 GNUNET_MQ_hd_var_size (get_peer,
1301 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER,
1302 struct GNUNET_CADET_LocalInfoPeer,
1304 GNUNET_MQ_hd_var_size (get_tunnels,
1305 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS,
1306 struct GNUNET_CADET_LocalInfoTunnel,
1308 GNUNET_MQ_hd_var_size (get_tunnel,
1309 GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL,
1310 struct GNUNET_CADET_LocalInfoTunnel,
1313 // GNUNET_MQ_hd_fixed_Y size (channel_destroyed,
1314 // GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_NACK_DEPRECATED,
1315 // struct GNUNET_CADET_ChannelDestroyMessage);
1316 GNUNET_MQ_handler_end ()
1319 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting to CADET\n");
1321 GNUNET_assert (NULL == h->mq);
1322 h->mq = GNUNET_CLIENT_connect (h->cfg,
1334 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1340 * Reconnect callback: tries to reconnect again after a failer previous
1343 * @param cls closure (cadet handle)
1346 reconnect_cbk (void *cls)
1348 struct GNUNET_CADET_Handle *h = cls;
1350 h->reconnect_task = NULL;
1356 * Reconnect to the service, retransmit all infomation to try to restore the
1359 * @param h handle to the cadet
1361 * @return #GNUNET_YES in case of sucess, #GNUNET_NO otherwise (service down...)
1364 reconnect (struct GNUNET_CADET_Handle *h)
1366 struct GNUNET_CADET_Channel *ch;
1368 LOG (GNUNET_ERROR_TYPE_DEBUG,
1369 "Requested RECONNECT, destroying all channels\n");
1370 for (ch = h->channels_head; NULL != ch; ch = h->channels_head)
1371 destroy_channel (ch, GNUNET_YES);
1372 if (NULL == h->reconnect_task)
1373 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
1378 /******************************************************************************/
1379 /********************** API CALL DEFINITIONS *************************/
1380 /******************************************************************************/
1382 struct GNUNET_CADET_Handle *
1383 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1385 GNUNET_CADET_ChannelEndHandler cleaner,
1386 const struct GNUNET_CADET_MessageHandler *handlers)
1388 struct GNUNET_CADET_Handle *h;
1390 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_CADET_connect()\n");
1391 h = GNUNET_new (struct GNUNET_CADET_Handle);
1392 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1394 h->cleaner = cleaner;
1395 h->ports = GNUNET_CONTAINER_multihashmap_create (4, GNUNET_YES);
1400 GNUNET_CADET_disconnect (h);
1404 h->message_handlers = handlers;
1405 h->next_ccn.channel_of_client = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
1406 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1407 h->reconnect_task = NULL;
1409 /* count handlers */
1410 for (h->n_handlers = 0;
1411 handlers && handlers[h->n_handlers].type;
1413 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_CADET_connect() END\n");
1419 * Disconnect from the cadet service. All channels will be destroyed. All channel
1420 * disconnect callbacks will be called on any still connected peers, notifying
1421 * about their disconnection. The registered inbound channel cleaner will be
1422 * called should any inbound channels still exist.
1424 * @param handle connection to cadet to disconnect
1427 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
1429 struct GNUNET_CADET_Channel *ch;
1430 struct GNUNET_CADET_Channel *aux;
1431 struct GNUNET_CADET_TransmitHandle *th;
1433 LOG (GNUNET_ERROR_TYPE_DEBUG,
1434 "CADET DISCONNECT\n");
1435 ch = handle->channels_head;
1439 if (ntohl (ch->ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
1442 LOG (GNUNET_ERROR_TYPE_DEBUG,
1443 "channel %X not destroyed\n",
1444 ntohl (ch->ccn.channel_of_client));
1446 destroy_channel (ch,
1450 while (NULL != (th = handle->th_head))
1452 struct GNUNET_MessageHeader *msg;
1454 /* Make sure it is an allowed packet (everything else should have been
1455 * already canceled).
1457 GNUNET_break (GNUNET_NO == th_is_payload (th));
1458 msg = (struct GNUNET_MessageHeader *) &th[1];
1459 switch (ntohs(msg->type))
1461 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN:
1462 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY:
1463 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN:
1464 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE:
1465 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNELS:
1466 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL:
1467 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER:
1468 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS:
1469 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL:
1470 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS:
1474 LOG (GNUNET_ERROR_TYPE_ERROR, "unexpected unsent msg %s\n",
1475 GC_m2s (ntohs(msg->type)));
1478 GNUNET_CADET_notify_transmit_ready_cancel (th);
1481 if (NULL != handle->mq)
1483 GNUNET_MQ_destroy (handle->mq);
1486 if (NULL != handle->reconnect_task)
1488 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1489 handle->reconnect_task = NULL;
1492 GNUNET_CONTAINER_multihashmap_destroy (handle->ports);
1493 handle->ports = NULL;
1494 GNUNET_free (handle);
1499 * Open a port to receive incomming channels.
1501 * @param h CADET handle.
1502 * @param port Hash representing the port number.
1503 * @param new_channel Function called when an channel is received.
1504 * @param new_channel_cls Closure for @a new_channel.
1506 * @return Port handle.
1508 struct GNUNET_CADET_Port *
1509 GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
1510 const struct GNUNET_HashCode *port,
1511 GNUNET_CADET_InboundChannelNotificationHandler
1513 void *new_channel_cls)
1515 struct GNUNET_CADET_PortMessage *msg;
1516 struct GNUNET_MQ_Envelope *env;
1517 struct GNUNET_CADET_Port *p;
1519 GNUNET_assert (NULL != new_channel);
1520 p = GNUNET_new (struct GNUNET_CADET_Port);
1522 p->hash = GNUNET_new (struct GNUNET_HashCode);
1524 p->handler = new_channel;
1525 p->cls = new_channel_cls;
1526 GNUNET_assert (GNUNET_OK ==
1527 GNUNET_CONTAINER_multihashmap_put (h->ports,
1530 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1532 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN);
1533 msg->port = *p->hash;
1534 GNUNET_MQ_send (h->mq, env);
1540 * Close a port opened with @a GNUNET_CADET_open_port.
1541 * The @a new_channel callback will no longer be called.
1543 * @param p Port handle.
1546 GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p)
1548 struct GNUNET_CADET_PortMessage *msg;
1549 struct GNUNET_MQ_Envelope *env;
1551 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE);
1553 msg->port = *p->hash;
1554 GNUNET_MQ_send (p->cadet->mq, env);
1555 GNUNET_CONTAINER_multihashmap_remove (p->cadet->ports, p->hash, p);
1556 GNUNET_free (p->hash);
1562 * Create a new channel towards a remote peer.
1564 * If the destination port is not open by any peer or the destination peer
1565 * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
1568 * @param h cadet handle
1569 * @param channel_ctx client's channel context to associate with the channel
1570 * @param peer peer identity the channel should go to
1571 * @param port Port hash (port number).
1572 * @param options CadetOption flag field, with all desired option bits set to 1.
1573 * @return handle to the channel
1575 struct GNUNET_CADET_Channel *
1576 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
1578 const struct GNUNET_PeerIdentity *peer,
1579 const struct GNUNET_HashCode *port,
1580 enum GNUNET_CADET_ChannelOption options)
1582 struct GNUNET_CADET_LocalChannelCreateMessage *msg;
1583 struct GNUNET_MQ_Envelope *env;
1584 struct GNUNET_CADET_Channel *ch;
1585 struct GNUNET_CADET_ClientChannelNumber ccn;
1587 LOG (GNUNET_ERROR_TYPE_DEBUG,
1588 "Creating new channel to %s:%u\n",
1589 GNUNET_i2s (peer), port);
1590 ccn.channel_of_client = htonl (0);
1591 ch = create_channel (h, ccn);
1592 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", ch);
1593 LOG (GNUNET_ERROR_TYPE_DEBUG, " number %X\n",
1594 ntohl (ch->ccn.channel_of_client));
1595 ch->ctx = channel_ctx;
1596 ch->peer = GNUNET_PEER_intern (peer);
1598 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE);
1602 msg->opt = htonl (options);
1603 GNUNET_MQ_send (h->mq,
1610 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
1612 struct GNUNET_CADET_Handle *h;
1613 struct GNUNET_CADET_LocalChannelDestroyMessage *msg;
1614 struct GNUNET_MQ_Envelope *env;
1615 struct GNUNET_CADET_TransmitHandle *th;
1616 struct GNUNET_CADET_TransmitHandle *next;
1618 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying channel\n");
1620 for (th = h->th_head; th != NULL; th = next)
1623 if (th->channel == channel)
1626 if (GNUNET_YES == th_is_payload (th))
1628 /* applications should cancel before destroying channel */
1629 LOG (GNUNET_ERROR_TYPE_WARNING,
1630 "Channel destroyed without cancelling transmission requests\n");
1631 th->notify (th->notify_cls, 0, NULL);
1635 LOG (GNUNET_ERROR_TYPE_WARNING, "no meta-traffic should be queued\n");
1637 GNUNET_CONTAINER_DLL_remove (h->th_head,
1640 GNUNET_CADET_notify_transmit_ready_cancel (th);
1644 env = GNUNET_MQ_msg (msg,
1645 GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY);
1646 msg->ccn = channel->ccn;
1647 GNUNET_MQ_send (h->mq,
1650 destroy_channel (channel,
1656 * Get information about a channel.
1658 * @param channel Channel handle.
1659 * @param option Query (GNUNET_CADET_OPTION_*).
1660 * @param ... dependant on option, currently not used
1662 * @return Union with an answer to the query.
1664 const union GNUNET_CADET_ChannelInfo *
1665 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
1666 enum GNUNET_CADET_ChannelOption option, ...)
1668 static int bool_flag;
1669 const union GNUNET_CADET_ChannelInfo *ret;
1673 case GNUNET_CADET_OPTION_NOBUFFER:
1674 case GNUNET_CADET_OPTION_RELIABLE:
1675 case GNUNET_CADET_OPTION_OUT_OF_ORDER:
1676 if (0 != (option & channel->options))
1677 bool_flag = GNUNET_YES;
1679 bool_flag = GNUNET_NO;
1680 ret = (const union GNUNET_CADET_ChannelInfo *) &bool_flag;
1682 case GNUNET_CADET_OPTION_PEER:
1683 ret = (const union GNUNET_CADET_ChannelInfo *) GNUNET_PEER_resolve2 (channel->peer);
1694 struct GNUNET_CADET_TransmitHandle *
1695 GNUNET_CADET_notify_transmit_ready (struct GNUNET_CADET_Channel *channel,
1697 struct GNUNET_TIME_Relative maxdelay,
1699 GNUNET_CONNECTION_TransmitReadyNotify notify,
1702 struct GNUNET_CADET_TransmitHandle *th;
1704 GNUNET_assert (NULL != channel);
1705 GNUNET_assert (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE >= notify_size);
1706 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY\n");
1707 LOG (GNUNET_ERROR_TYPE_DEBUG, " on channel %X\n", channel->ccn);
1708 LOG (GNUNET_ERROR_TYPE_DEBUG, " allow_send %d\n", channel->allow_send);
1709 if (ntohl (channel->ccn.channel_of_client) >=
1710 GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
1711 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin\n");
1713 LOG (GNUNET_ERROR_TYPE_DEBUG, " to destination\n");
1714 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
1715 GNUNET_assert (NULL != notify);
1716 if (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us != maxdelay.rel_value_us)
1718 LOG (GNUNET_ERROR_TYPE_WARNING,
1719 "CADET transmit ready timeout is deprected (has no effect)\n");
1722 th = GNUNET_new (struct GNUNET_CADET_TransmitHandle);
1723 th->channel = channel;
1724 th->size = notify_size;
1725 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
1726 th->notify = notify;
1727 th->notify_cls = notify_cls;
1728 if (0 != channel->allow_send)
1729 th->request_data_task = GNUNET_SCHEDULER_add_now (&request_data, th);
1731 add_to_queue (channel->cadet, th);
1733 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY END\n");
1739 GNUNET_CADET_notify_transmit_ready_cancel (struct GNUNET_CADET_TransmitHandle *th)
1741 if (NULL != th->request_data_task)
1743 GNUNET_SCHEDULER_cancel (th->request_data_task);
1745 th->request_data_task = NULL;
1747 remove_from_queue (th);
1753 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
1760 send_info_request (struct GNUNET_CADET_Handle *h, uint16_t type)
1762 struct GNUNET_MessageHeader *msg;
1763 struct GNUNET_MQ_Envelope *env;
1765 LOG (GNUNET_ERROR_TYPE_DEBUG,
1766 " Sending %s monitor message to service\n",
1769 env = GNUNET_MQ_msg (msg, type);
1770 GNUNET_MQ_send (h->mq, env);
1775 * Request a debug dump on the service's STDERR.
1777 * WARNING: unstable API, likely to change in the future!
1779 * @param h cadet handle
1782 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h)
1784 LOG (GNUNET_ERROR_TYPE_DEBUG, "requesting dump\n");
1785 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP);
1790 * Request information about peers known to the running cadet service.
1791 * The callback will be called for every peer known to the service.
1792 * Only one info request (of any kind) can be active at once.
1795 * WARNING: unstable API, likely to change in the future!
1797 * @param h Handle to the cadet peer.
1798 * @param callback Function to call with the requested data.
1799 * @param callback_cls Closure for @c callback.
1801 * @return #GNUNET_OK / #GNUNET_SYSERR
1804 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
1805 GNUNET_CADET_PeersCB callback,
1808 if (NULL != h->info_cb.peers_cb)
1811 return GNUNET_SYSERR;
1813 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
1814 h->info_cb.peers_cb = callback;
1815 h->info_cls = callback_cls;
1821 * Cancel a peer info request. The callback will not be called (anymore).
1823 * WARNING: unstable API, likely to change in the future!
1825 * @param h Cadet handle.
1827 * @return Closure given to GNUNET_CADET_get_peers.
1830 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h)
1835 h->info_cb.peers_cb = NULL;
1842 * Request information about a peer known to the running cadet peer.
1843 * The callback will be called for the tunnel once.
1844 * Only one info request (of any kind) can be active at once.
1846 * WARNING: unstable API, likely to change in the future!
1848 * @param h Handle to the cadet peer.
1849 * @param id Peer whose tunnel to examine.
1850 * @param callback Function to call with the requested data.
1851 * @param callback_cls Closure for @c callback.
1853 * @return #GNUNET_OK / #GNUNET_SYSERR
1856 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
1857 const struct GNUNET_PeerIdentity *id,
1858 GNUNET_CADET_PeerCB callback,
1861 struct GNUNET_CADET_LocalInfo *msg;
1862 struct GNUNET_MQ_Envelope *env;
1864 if (NULL != h->info_cb.peer_cb)
1867 return GNUNET_SYSERR;
1870 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
1872 GNUNET_MQ_send (h->mq, env);
1874 h->info_cb.peer_cb = callback;
1875 h->info_cls = callback_cls;
1881 * Request information about tunnels of the running cadet peer.
1882 * The callback will be called for every tunnel of the service.
1883 * Only one info request (of any kind) can be active at once.
1885 * WARNING: unstable API, likely to change in the future!
1887 * @param h Handle to the cadet peer.
1888 * @param callback Function to call with the requested data.
1889 * @param callback_cls Closure for @c callback.
1891 * @return #GNUNET_OK / #GNUNET_SYSERR
1894 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
1895 GNUNET_CADET_TunnelsCB callback,
1898 if (NULL != h->info_cb.tunnels_cb)
1901 return GNUNET_SYSERR;
1903 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
1904 h->info_cb.tunnels_cb = callback;
1905 h->info_cls = callback_cls;
1911 * Cancel a monitor request. The monitor callback will not be called.
1913 * @param h Cadet handle.
1915 * @return Closure given to GNUNET_CADET_get_tunnels.
1918 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h)
1922 h->info_cb.tunnels_cb = NULL;
1932 * Request information about a tunnel of the running cadet peer.
1933 * The callback will be called for the tunnel once.
1934 * Only one info request (of any kind) can be active at once.
1936 * WARNING: unstable API, likely to change in the future!
1938 * @param h Handle to the cadet peer.
1939 * @param id Peer whose tunnel to examine.
1940 * @param callback Function to call with the requested data.
1941 * @param callback_cls Closure for @c callback.
1943 * @return #GNUNET_OK / #GNUNET_SYSERR
1946 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
1947 const struct GNUNET_PeerIdentity *id,
1948 GNUNET_CADET_TunnelCB callback,
1951 struct GNUNET_CADET_LocalInfo *msg;
1952 struct GNUNET_MQ_Envelope *env;
1954 if (NULL != h->info_cb.tunnel_cb)
1957 return GNUNET_SYSERR;
1960 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
1962 GNUNET_MQ_send (h->mq, env);
1964 h->info_cb.tunnel_cb = callback;
1965 h->info_cls = callback_cls;
1971 * Request information about a specific channel of the running cadet peer.
1973 * WARNING: unstable API, likely to change in the future!
1974 * FIXME Add destination option.
1976 * @param h Handle to the cadet peer.
1977 * @param initiator ID of the owner of the channel.
1978 * @param channel_number Channel number.
1979 * @param callback Function to call with the requested data.
1980 * @param callback_cls Closure for @c callback.
1982 * @return #GNUNET_OK / #GNUNET_SYSERR
1985 GNUNET_CADET_show_channel (struct GNUNET_CADET_Handle *h,
1986 struct GNUNET_PeerIdentity *initiator,
1987 unsigned int channel_number,
1988 GNUNET_CADET_ChannelCB callback,
1991 struct GNUNET_CADET_LocalInfo *msg;
1992 struct GNUNET_MQ_Envelope *env;
1994 if (NULL != h->info_cb.channel_cb)
1997 return GNUNET_SYSERR;
2000 env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL);
2001 msg->peer = *initiator;
2002 msg->ccn.channel_of_client = htonl (channel_number);
2003 GNUNET_MQ_send (h->mq, env);
2005 h->info_cb.channel_cb = callback;
2006 h->info_cls = callback_cls;
2012 * Function called to notify a client about the connection
2013 * begin ready to queue more data. "buf" will be
2014 * NULL and "size" zero if the connection was closed for
2015 * writing in the meantime.
2017 * @param cls closure
2018 * @param size number of bytes available in buf
2019 * @param buf where the callee should write the message
2020 * @return number of bytes written to buf
2023 cadet_mq_ntr (void *cls, size_t size,
2026 struct GNUNET_MQ_Handle *mq = cls;
2027 struct CadetMQState *state = GNUNET_MQ_impl_state (mq);
2028 const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq);
2034 GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_WRITE);
2037 msize = ntohs (msg->size);
2038 GNUNET_assert (msize <= size);
2039 GNUNET_memcpy (buf, msg, msize);
2040 GNUNET_MQ_impl_send_continue (mq);
2046 * Signature of functions implementing the
2047 * sending functionality of a message queue.
2049 * @param mq the message queue
2050 * @param msg the message to send
2051 * @param impl_state state of the implementation
2054 cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq,
2055 const struct GNUNET_MessageHeader *msg,
2058 struct CadetMQState *state = impl_state;
2060 GNUNET_assert (NULL == state->th);
2062 GNUNET_CADET_notify_transmit_ready (state->channel,
2063 /* FIXME: add option for corking */
2065 GNUNET_TIME_UNIT_FOREVER_REL,
2073 * Signature of functions implementing the
2074 * destruction of a message queue.
2075 * Implementations must not free 'mq', but should
2076 * take care of 'impl_state'.
2078 * @param mq the message queue to destroy
2079 * @param impl_state state of the implementation
2082 cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq,
2085 struct CadetMQState *state = impl_state;
2087 if (NULL != state->th)
2088 GNUNET_CADET_notify_transmit_ready_cancel (state->th);
2090 GNUNET_free (state);
2095 * Create a message queue for a cadet channel.
2096 * The message queue can only be used to transmit messages,
2097 * not to receive them.
2099 * @param channel the channel to create the message qeue for
2100 * @return a message queue to messages over the channel
2102 struct GNUNET_MQ_Handle *
2103 GNUNET_CADET_mq_create (struct GNUNET_CADET_Channel *channel)
2105 struct GNUNET_MQ_Handle *mq;
2106 struct CadetMQState *state;
2108 state = GNUNET_new (struct CadetMQState);
2109 state->channel = channel;
2111 mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
2112 &cadet_mq_destroy_impl,
2113 NULL, /* FIXME: cancel impl. */
2115 NULL, /* no msg handlers */
2116 NULL, /* no err handlers */
2117 NULL); /* no handler cls */
2123 * Transitional function to convert an unsigned int port to a hash value.
2124 * WARNING: local static value returned, NOT reentrant!
2125 * WARNING: do not use this function for new code!
2127 * @param port Numerical port (unsigned int format).
2129 * @return A GNUNET_HashCode usable for the new CADET API.
2131 const struct GNUNET_HashCode *
2132 GC_u2h (uint32_t port)
2134 static struct GNUNET_HashCode hash;
2136 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2137 "This is a transitional function, "
2138 "use proper crypto hashes as CADET ports\n");
2139 GNUNET_CRYPTO_hash (&port, sizeof (port), &hash);