2 This file is part of GNUnet.
3 Copyright (C) 2011 Christian Grothoff (and other contributing authors)
4 GNUnet is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published
6 by the Free Software Foundation; either version 3, or (at your
7 option) any later version.
8 GNUnet is distributed in the hope that it will be useful, but
9 WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 General Public License for more details.
12 You should have received a copy of the GNU General Public License
13 along with GNUnet; see the file COPYING. If not, write to the
14 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
15 Boston, MA 02110-1301, USA.
19 * @file cadet/cadet_api.c
20 * @brief cadet api: client implementation of new cadet service
21 * @author Bartlomiej Polot
25 #include "gnunet_util_lib.h"
26 #include "gnunet_cadet_service.h"
28 #include "cadet_protocol.h"
30 #define LOG(kind,...) GNUNET_log_from (kind, "cadet-api",__VA_ARGS__)
31 #define DATA_OVERHEAD sizeof(struct GNUNET_CADET_LocalData)
33 /******************************************************************************/
34 /************************ DATA STRUCTURES ****************************/
35 /******************************************************************************/
38 * Transmission queue to the service
40 struct GNUNET_CADET_TransmitHandle
46 struct GNUNET_CADET_TransmitHandle *next;
51 struct GNUNET_CADET_TransmitHandle *prev;
54 * Channel this message is sent on / for (may be NULL for control messages).
56 struct GNUNET_CADET_Channel *channel;
59 * Callback to obtain the message to transmit, or NULL if we
60 * got the message in 'data'. Notice that messages built
61 * by 'notify' need to be encapsulated with information about
64 GNUNET_CONNECTION_TransmitReadyNotify notify;
67 * Closure for 'notify'
72 * How long is this message valid. Once the timeout has been
73 * reached, the message must no longer be sent. If this
74 * is a message with a 'notify' callback set, the 'notify'
75 * function should be called with 'buf' NULL and size 0.
77 struct GNUNET_TIME_Absolute timeout;
80 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
82 struct GNUNET_SCHEDULER_Task * timeout_task;
85 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
95 GNUNET_CADET_ChannelCB channel_cb;
100 GNUNET_CADET_PeersCB peers_cb;
105 GNUNET_CADET_PeerCB peer_cb;
110 GNUNET_CADET_TunnelsCB tunnels_cb;
115 GNUNET_CADET_TunnelCB tunnel_cb;
120 * Opaque handle to the service.
122 struct GNUNET_CADET_Handle
126 * Handle to the server connection, to send messages later
128 struct GNUNET_CLIENT_Connection *client;
131 * Set of handlers used for processing incoming messages in the channels
133 const struct GNUNET_CADET_MessageHandler *message_handlers;
136 * Number of handlers in the handlers array.
138 unsigned int n_handlers;
143 const uint32_t *ports;
148 unsigned int n_ports;
151 * Double linked list of the channels this client is connected to, head.
153 struct GNUNET_CADET_Channel *channels_head;
156 * Double linked list of the channels this client is connected to, tail.
158 struct GNUNET_CADET_Channel *channels_tail;
161 * Callback for inbound channel creation
163 GNUNET_CADET_InboundChannelNotificationHandler *new_channel;
166 * Callback for inbound channel disconnection
168 GNUNET_CADET_ChannelEndHandler *cleaner;
171 * Handle to cancel pending transmissions in case of disconnection
173 struct GNUNET_CLIENT_TransmitHandle *th;
176 * Closure for all the handlers given by the client
181 * Messages to send to the service, head.
183 struct GNUNET_CADET_TransmitHandle *th_head;
186 * Messages to send to the service, tail.
188 struct GNUNET_CADET_TransmitHandle *th_tail;
191 * chid of the next channel to create (to avoid reusing IDs often)
193 CADET_ChannelNumber next_chid;
196 * Have we started the task to receive messages from the service
197 * yet? We do this after we send the 'CADET_LOCAL_CONNECT' message.
202 * Configuration given by the client, in case of reconnection
204 const struct GNUNET_CONFIGURATION_Handle *cfg;
207 * Time to the next reconnect in case one reconnect fails
209 struct GNUNET_TIME_Relative reconnect_time;
212 * Task for trying to reconnect.
214 struct GNUNET_SCHEDULER_Task * reconnect_task;
217 * Callback for an info task (only one active at a time).
219 union CadetInfoCB info_cb;
222 * Info callback closure for @c info_cb.
229 * Description of a peer
231 struct GNUNET_CADET_Peer
234 * ID of the peer in short form
239 * Channel this peer belongs to
241 struct GNUNET_CADET_Channel *t;
246 * Opaque handle to a channel.
248 struct GNUNET_CADET_Channel
254 struct GNUNET_CADET_Channel *next;
259 struct GNUNET_CADET_Channel *prev;
262 * Handle to the cadet this channel belongs to
264 struct GNUNET_CADET_Handle *cadet;
267 * Local ID of the channel
269 CADET_ChannelNumber chid;
277 * Other end of the channel.
282 * Any data the caller wants to put in here
287 * Size of packet queued in this channel
289 unsigned int packet_size;
292 * Channel options: reliability, etc.
294 enum GNUNET_CADET_ChannelOption options;
297 * Are we allowed to send to the service?
305 * Implementation state for cadet's message queue.
310 * The current transmit handle, or NULL
311 * if no transmit is active.
313 struct GNUNET_CADET_TransmitHandle *th;
316 * Channel to send the data over.
318 struct GNUNET_CADET_Channel *channel;
322 /******************************************************************************/
323 /*********************** DECLARATIONS *************************/
324 /******************************************************************************/
327 * Function called to send a message to the service.
328 * "buf" will be NULL and "size" zero if the socket was closed for writing in
331 * @param cls closure, the cadet handle
332 * @param size number of bytes available in buf
333 * @param buf where the callee should write the connect message
334 * @return number of bytes written to buf
337 send_callback (void *cls, size_t size, void *buf);
340 /******************************************************************************/
341 /*********************** AUXILIARY FUNCTIONS *************************/
342 /******************************************************************************/
345 * Check if transmission is a payload packet.
347 * @param th Transmission handle.
349 * @return #GNUNET_YES if it is a payload packet,
350 * #GNUNET_NO if it is a cadet management packet.
353 th_is_payload (struct GNUNET_CADET_TransmitHandle *th)
355 return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
360 * Check whether there is any message ready in the queue and find the size.
362 * @param h Cadet handle.
364 * @return The size of the first ready message in the queue, including overhead.
365 * 0 if there is none.
368 message_ready_size (struct GNUNET_CADET_Handle *h)
370 struct GNUNET_CADET_TransmitHandle *th;
371 struct GNUNET_CADET_Channel *ch;
373 for (th = h->th_head; NULL != th; th = th->next)
376 if (GNUNET_NO == th_is_payload (th) || GNUNET_YES == ch->allow_send)
384 * Get the channel handler for the channel specified by id from the given handle
385 * @param h Cadet handle
386 * @param chid ID of the wanted channel
387 * @return handle to the required channel or NULL if not found
389 static struct GNUNET_CADET_Channel *
390 retrieve_channel (struct GNUNET_CADET_Handle *h, CADET_ChannelNumber chid)
392 struct GNUNET_CADET_Channel *ch;
394 ch = h->channels_head;
397 if (ch->chid == chid)
406 * Create a new channel and insert it in the channel list of the cadet handle
408 * @param h Cadet handle
409 * @param chid Desired chid of the channel, 0 to assign one automatically.
411 * @return Handle to the created channel.
413 static struct GNUNET_CADET_Channel *
414 create_channel (struct GNUNET_CADET_Handle *h, CADET_ChannelNumber chid)
416 struct GNUNET_CADET_Channel *ch;
418 ch = GNUNET_new (struct GNUNET_CADET_Channel);
419 GNUNET_CONTAINER_DLL_insert (h->channels_head, h->channels_tail, ch);
423 ch->chid = h->next_chid;
424 while (NULL != retrieve_channel (h, h->next_chid))
427 h->next_chid &= ~GNUNET_CADET_LOCAL_CHANNEL_ID_SERV;
428 h->next_chid |= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
435 ch->allow_send = GNUNET_NO;
441 * Destroy the specified channel.
442 * - Destroys all peers, calling the disconnect callback on each if needed
443 * - Cancels all outgoing traffic for that channel, calling respective notifys
444 * - Calls cleaner if channel was inbound
445 * - Frees all memory used
447 * @param ch Pointer to the channel.
448 * @param call_cleaner Whether to call the cleaner handler.
450 * @return Handle to the required channel or NULL if not found.
453 destroy_channel (struct GNUNET_CADET_Channel *ch, int call_cleaner)
455 struct GNUNET_CADET_Handle *h;
456 struct GNUNET_CADET_TransmitHandle *th;
457 struct GNUNET_CADET_TransmitHandle *next;
459 LOG (GNUNET_ERROR_TYPE_DEBUG, " destroy_channel %X\n", ch->chid);
468 GNUNET_CONTAINER_DLL_remove (h->channels_head, h->channels_tail, ch);
470 /* signal channel destruction */
471 if ( (NULL != h->cleaner) && (0 != ch->peer) && (GNUNET_YES == call_cleaner) )
473 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling cleaner\n");
474 h->cleaner (h->cls, ch, ch->ctx);
477 /* check that clients did not leave messages behind in the queue */
478 for (th = h->th_head; NULL != th; th = next)
481 if (th->channel != ch)
483 /* Clients should have aborted their requests already.
484 * Management traffic should be ok, as clients can't cancel that.
485 * If the service crashed and we are reconnecting, it's ok.
487 GNUNET_break (GNUNET_NO == th_is_payload (th)
488 || GNUNET_NO == h->in_receive);
489 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
491 /* clean up request */
492 if (NULL != th->timeout_task)
493 GNUNET_SCHEDULER_cancel (th->timeout_task);
497 /* if there are no more pending requests with cadet service, cancel active request */
498 /* Note: this should be unnecessary... */
499 if ((0 == message_ready_size (h)) && (NULL != h->th))
501 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
506 GNUNET_PEER_change_rc (ch->peer, -1);
513 * Notify client that the transmission has timed out
516 * @param tc task context
519 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
521 struct GNUNET_CADET_TransmitHandle *th = cls;
522 struct GNUNET_CADET_Handle *cadet = th->channel->cadet;
524 th->timeout_task = NULL;
525 th->channel->packet_size = 0;
526 GNUNET_CONTAINER_DLL_remove (cadet->th_head, cadet->th_tail, th);
527 if (GNUNET_YES == th_is_payload (th))
528 GNUNET_break (0 == th->notify (th->notify_cls, 0, NULL));
530 if ((0 == message_ready_size (cadet)) && (NULL != cadet->th))
532 /* nothing ready to transmit, no point in asking for transmission */
533 GNUNET_CLIENT_notify_transmit_ready_cancel (cadet->th);
540 * Add a transmit handle to the transmission queue and set the
543 * @param h cadet handle with the queue head and tail
544 * @param th handle to the packet to be transmitted
547 add_to_queue (struct GNUNET_CADET_Handle *h,
548 struct GNUNET_CADET_TransmitHandle *th)
550 GNUNET_CONTAINER_DLL_insert_tail (h->th_head, h->th_tail, th);
551 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us == th->timeout.abs_value_us)
554 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
555 (th->timeout), &timeout_transmission, th);
560 * Auxiliary function to send an already constructed packet to the service.
561 * Takes care of creating a new queue element, copying the message and
562 * calling the tmt_rdy function if necessary.
564 * @param h cadet handle
565 * @param msg message to transmit
566 * @param channel channel this send is related to (NULL if N/A)
569 send_packet (struct GNUNET_CADET_Handle *h,
570 const struct GNUNET_MessageHeader *msg,
571 struct GNUNET_CADET_Channel *channel);
575 * Send an ack on the channel to confirm the processing of a message.
577 * @param ch Channel on which to send the ACK.
580 send_ack (struct GNUNET_CADET_Channel *ch)
582 struct GNUNET_CADET_LocalAck msg;
584 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending ACK on channel %X\n", ch->chid);
585 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
586 msg.header.size = htons (sizeof (msg));
587 msg.channel_id = htonl (ch->chid);
589 send_packet (ch->cadet, &msg.header, ch);
596 * Reconnect callback: tries to reconnect again after a failer previous
598 * @param cls closure (cadet handle)
599 * @param tc task context
602 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
606 * Send a connect packet to the service with the applications and types
607 * requested by the user.
609 * @param h The cadet handle.
613 send_connect (struct GNUNET_CADET_Handle *h)
617 size = sizeof (struct GNUNET_CADET_ClientConnect);
618 size += h->n_ports * sizeof (uint32_t);
620 char buf[size] GNUNET_ALIGN;
621 struct GNUNET_CADET_ClientConnect *msg;
625 /* build connection packet */
626 msg = (struct GNUNET_CADET_ClientConnect *) buf;
627 msg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_CONNECT);
628 msg->header.size = htons (size);
629 ports = (uint32_t *) &msg[1];
630 for (i = 0; i < h->n_ports; i++)
632 ports[i] = htonl (h->ports[i]);
633 LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n",
636 LOG (GNUNET_ERROR_TYPE_DEBUG,
637 "Sending %lu bytes long message with %u ports\n",
638 ntohs (msg->header.size), h->n_ports);
639 send_packet (h, &msg->header, NULL);
645 * Reconnect to the service, retransmit all infomation to try to restore the
648 * @param h handle to the cadet
650 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
653 do_reconnect (struct GNUNET_CADET_Handle *h)
655 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
656 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
657 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
658 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
659 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
664 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
667 if (NULL != h->client)
669 GNUNET_CLIENT_disconnect (h->client);
673 h->client = GNUNET_CLIENT_connect ("cadet", h->cfg);
674 if (h->client == NULL)
676 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
679 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
680 GNUNET_TIME_relative_multiply
681 (h->reconnect_time, 2));
682 LOG (GNUNET_ERROR_TYPE_DEBUG, "Next retry in %s\n",
683 GNUNET_STRINGS_relative_time_to_string (h->reconnect_time,
690 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
697 * Reconnect callback: tries to reconnect again after a failer previous
699 * @param cls closure (cadet handle)
700 * @param tc task context
703 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
705 struct GNUNET_CADET_Handle *h = cls;
707 h->reconnect_task = NULL;
708 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
715 * Reconnect to the service, retransmit all infomation to try to restore the
718 * @param h handle to the cadet
720 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
723 reconnect (struct GNUNET_CADET_Handle *h)
725 struct GNUNET_CADET_Channel *ch;
727 LOG (GNUNET_ERROR_TYPE_DEBUG,
728 "Requested RECONNECT, destroying all channels\n");
729 h->in_receive = GNUNET_NO;
730 for (ch = h->channels_head; NULL != ch; ch = h->channels_head)
731 destroy_channel (ch, GNUNET_YES);
732 if (NULL == h->reconnect_task)
733 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
738 /******************************************************************************/
739 /*********************** RECEIVE HANDLERS ****************************/
740 /******************************************************************************/
743 * Process the new channel notification and add it to the channels in the handle
745 * @param h The cadet handle
746 * @param msg A message with the details of the new incoming channel
749 process_channel_created (struct GNUNET_CADET_Handle *h,
750 const struct GNUNET_CADET_ChannelMessage *msg)
752 struct GNUNET_CADET_Channel *ch;
753 CADET_ChannelNumber chid;
756 chid = ntohl (msg->channel_id);
757 port = ntohl (msg->port);
758 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating incoming channel %X:%u\n", chid, port);
759 if (chid < GNUNET_CADET_LOCAL_CHANNEL_ID_SERV)
764 if (NULL != h->new_channel)
768 ch = create_channel (h, chid);
769 ch->allow_send = GNUNET_NO;
770 ch->peer = GNUNET_PEER_intern (&msg->peer);
774 ch->options = ntohl (msg->opt);
776 LOG (GNUNET_ERROR_TYPE_DEBUG, " created channel %p\n", ch);
777 ctx = h->new_channel (h->cls, ch, &msg->peer, ch->port, ch->options);
780 LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
784 struct GNUNET_CADET_ChannelMessage d_msg;
786 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming channels\n");
788 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY);
789 d_msg.header.size = htons (sizeof (struct GNUNET_CADET_ChannelMessage));
790 d_msg.channel_id = msg->channel_id;
791 memset (&d_msg.peer, 0, sizeof (struct GNUNET_PeerIdentity));
795 send_packet (h, &d_msg.header, NULL);
802 * Process the channel destroy notification and free associated resources
804 * @param h The cadet handle
805 * @param msg A message with the details of the channel being destroyed
808 process_channel_destroy (struct GNUNET_CADET_Handle *h,
809 const struct GNUNET_CADET_ChannelMessage *msg)
811 struct GNUNET_CADET_Channel *ch;
812 CADET_ChannelNumber chid;
814 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel Destroy received from service\n");
815 chid = ntohl (msg->channel_id);
816 ch = retrieve_channel (h, chid);
820 LOG (GNUNET_ERROR_TYPE_DEBUG, "channel %X unknown\n", chid);
823 LOG (GNUNET_ERROR_TYPE_DEBUG, " destroying channel %X\n", ch->chid);
824 destroy_channel (ch, GNUNET_YES);
829 * Process the incoming data packets, call appropriate handlers.
831 * @param h The cadet handle
832 * @param message A message encapsulating the data
835 process_incoming_data (struct GNUNET_CADET_Handle *h,
836 const struct GNUNET_MessageHeader *message)
838 const struct GNUNET_MessageHeader *payload;
839 const struct GNUNET_CADET_MessageHandler *handler;
840 struct GNUNET_CADET_LocalData *dmsg;
841 struct GNUNET_CADET_Channel *ch;
846 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
847 dmsg = (struct GNUNET_CADET_LocalData *) message;
848 ch = retrieve_channel (h, ntohl (dmsg->id));
855 payload = (struct GNUNET_MessageHeader *) &dmsg[1];
856 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s data on channel %s [%X]\n",
857 GC_f2s (ch->chid >= GNUNET_CADET_LOCAL_CHANNEL_ID_SERV),
858 GNUNET_i2s (GNUNET_PEER_resolve2 (ch->peer)), ntohl (dmsg->id));
860 size = ntohs (message->size);
861 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u bytes\n", size);
863 type = ntohs (payload->type);
864 size = ntohs (payload->size);
865 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload type %s\n", GC_m2s (type));
866 for (i = 0; i < h->n_handlers; i++)
868 handler = &h->message_handlers[i];
869 LOG (GNUNET_ERROR_TYPE_DEBUG, " checking handler for type %u\n",
871 if (handler->type == type)
874 handler->callback (h->cls, ch, &ch->ctx, payload))
876 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
877 GNUNET_CADET_channel_destroy (ch);
882 LOG (GNUNET_ERROR_TYPE_DEBUG,
883 "callback completed successfully\n");
892 * Process a local ACK message, enabling the client to send
893 * more data to the service.
895 * @param h Cadet handle.
896 * @param message Message itself.
899 process_ack (struct GNUNET_CADET_Handle *h,
900 const struct GNUNET_MessageHeader *message)
902 struct GNUNET_CADET_LocalAck *msg;
903 struct GNUNET_CADET_Channel *ch;
904 CADET_ChannelNumber chid;
906 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
907 msg = (struct GNUNET_CADET_LocalAck *) message;
908 chid = ntohl (msg->channel_id);
909 ch = retrieve_channel (h, chid);
912 LOG (GNUNET_ERROR_TYPE_DEBUG, "ACK on unknown channel %X\n", chid);
915 LOG (GNUNET_ERROR_TYPE_DEBUG, " on channel %X!\n", ch->chid);
916 ch->allow_send = GNUNET_YES;
917 if (NULL == h->th && 0 < ch->packet_size)
919 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n");
920 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client, ch->packet_size,
921 GNUNET_TIME_UNIT_FOREVER_REL,
922 GNUNET_YES, &send_callback, h);
928 * Process a local reply about info on all channels, pass info to the user.
930 * @param h Cadet handle.
931 * @param message Message itself.
934 // process_get_channels (struct GNUNET_CADET_Handle *h,
935 // const struct GNUNET_MessageHeader *message)
937 // struct GNUNET_CADET_LocalInfo *msg;
939 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Get Channels messasge received\n");
941 // if (NULL == h->channels_cb)
943 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
947 // msg = (struct GNUNET_CADET_LocalInfo *) message;
948 // if (ntohs (message->size) !=
949 // (sizeof (struct GNUNET_CADET_LocalInfo) +
950 // sizeof (struct GNUNET_PeerIdentity)))
952 // GNUNET_break_op (0);
953 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
954 // "Get channels message: size %hu - expected %u\n",
955 // ntohs (message->size),
956 // sizeof (struct GNUNET_CADET_LocalInfo));
959 // h->channels_cb (h->channels_cls,
960 // ntohl (msg->channel_id),
962 // &msg->destination);
968 * Process a local monitor_channel reply, pass info to the user.
970 * @param h Cadet handle.
971 * @param message Message itself.
974 // process_show_channel (struct GNUNET_CADET_Handle *h,
975 // const struct GNUNET_MessageHeader *message)
977 // struct GNUNET_CADET_LocalInfo *msg;
980 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Show Channel messasge received\n");
982 // if (NULL == h->channel_cb)
984 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n");
988 // /* Verify message sanity */
989 // msg = (struct GNUNET_CADET_LocalInfo *) message;
990 // esize = sizeof (struct GNUNET_CADET_LocalInfo);
991 // if (ntohs (message->size) != esize)
993 // GNUNET_break_op (0);
994 // GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
995 // "Show channel message: size %hu - expected %u\n",
996 // ntohs (message->size),
999 // h->channel_cb (h->channel_cls, NULL, NULL);
1000 // h->channel_cb = NULL;
1001 // h->channel_cls = NULL;
1006 // h->channel_cb (h->channel_cls,
1007 // &msg->destination,
1014 * Process a local reply about info on all tunnels, pass info to the user.
1016 * @param h Cadet handle.
1017 * @param message Message itself.
1020 process_get_peers (struct GNUNET_CADET_Handle *h,
1021 const struct GNUNET_MessageHeader *message)
1023 struct GNUNET_CADET_LocalInfoPeer *msg;
1026 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Get Peer messasge received\n");
1028 if (NULL == h->info_cb.peers_cb)
1030 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " ignored\n");
1034 size = ntohs (message->size);
1035 if (sizeof (struct GNUNET_CADET_LocalInfoPeer) > size)
1037 h->info_cb.peers_cb (h->info_cls, NULL, -1, 0, 0);
1038 h->info_cb.peers_cb = NULL;
1043 msg = (struct GNUNET_CADET_LocalInfoPeer *) message;
1044 h->info_cb.peers_cb (h->info_cls, &msg->destination,
1045 (int) ntohs (msg->tunnel),
1046 (unsigned int ) ntohs (msg->paths),
1052 * Process a local peer info reply, pass info to the user.
1054 * @param h Cadet handle.
1055 * @param message Message itself.
1058 process_get_peer (struct GNUNET_CADET_Handle *h,
1059 const struct GNUNET_MessageHeader *message)
1061 struct GNUNET_CADET_LocalInfoPeer *msg;
1062 struct GNUNET_PeerIdentity *id;
1063 unsigned int epaths;
1065 unsigned int path_length;
1071 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Info Peer messasge received\n");
1072 if (NULL == h->info_cb.peer_cb)
1074 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " ignored\n");
1078 /* Verify message sanity */
1079 msg = (struct GNUNET_CADET_LocalInfoPeer *) message;
1080 esize = ntohs (message->size);
1081 msize = sizeof (struct GNUNET_CADET_LocalInfoPeer);
1084 GNUNET_break_op (0);
1085 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1088 epaths = (unsigned int) ntohs (msg->paths);
1091 neighbor = GNUNET_NO;
1092 id = (struct GNUNET_PeerIdentity *) &msg[1];
1093 for (i = 0; msize < esize; i++)
1095 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (&id[i]));
1096 msize += sizeof (struct GNUNET_PeerIdentity);
1098 if (0 == memcmp (&id[i], &msg->destination,
1099 sizeof (struct GNUNET_PeerIdentity)))
1101 if (1 == path_length)
1102 neighbor = GNUNET_YES;
1109 GNUNET_break_op (0);
1110 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "m:%u, e: %u\n", msize, esize);
1111 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1114 if (paths != epaths)
1116 GNUNET_break_op (0);
1117 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "p:%u, e: %u\n", paths, epaths);
1118 h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL);
1122 /* Call Callback with tunnel info. */
1123 id = (struct GNUNET_PeerIdentity *) &msg[1];
1124 h->info_cb.peer_cb (h->info_cls,
1126 (int) ntohs (msg->tunnel),
1132 h->info_cb.peer_cb = NULL;
1138 * Process a local reply about info on all tunnels, pass info to the user.
1140 * @param h Cadet handle.
1141 * @param message Message itself.
1144 process_get_tunnels (struct GNUNET_CADET_Handle *h,
1145 const struct GNUNET_MessageHeader *message)
1147 struct GNUNET_CADET_LocalInfoTunnel *msg;
1150 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Get Tunnels messasge received\n");
1152 if (NULL == h->info_cb.tunnels_cb)
1154 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " ignored\n");
1158 size = ntohs (message->size);
1159 if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) > size)
1161 h->info_cb.tunnels_cb (h->info_cls, NULL, 0, 0, 0, 0);
1162 h->info_cb.tunnels_cb = NULL;
1167 msg = (struct GNUNET_CADET_LocalInfoTunnel *) message;
1168 h->info_cb.tunnels_cb (h->info_cls, &msg->destination,
1169 ntohl (msg->channels), ntohl (msg->connections),
1170 ntohs (msg->estate), ntohs (msg->cstate));
1176 * Process a local tunnel info reply, pass info to the user.
1178 * @param h Cadet handle.
1179 * @param message Message itself.
1182 process_get_tunnel (struct GNUNET_CADET_Handle *h,
1183 const struct GNUNET_MessageHeader *message)
1185 struct GNUNET_CADET_LocalInfoTunnel *msg;
1190 struct GNUNET_CADET_Hash *conns;
1191 CADET_ChannelNumber *chns;
1193 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Get Tunnel messasge received\n");
1194 if (NULL == h->info_cb.tunnel_cb)
1196 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " ignored\n");
1200 /* Verify message sanity */
1201 msg = (struct GNUNET_CADET_LocalInfoTunnel *) message;
1202 msize = ntohs (message->size);
1203 esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1206 GNUNET_break_op (0);
1207 h->info_cb.tunnel_cb (h->info_cls, NULL, 0, 0, NULL, NULL, 0, 0);
1210 ch_n = ntohl (msg->channels);
1211 c_n = ntohl (msg->connections);
1212 esize += ch_n * sizeof (CADET_ChannelNumber);
1213 esize += c_n * sizeof (struct GNUNET_CADET_Hash);
1216 GNUNET_break_op (0);
1217 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "m:%u, e: %u (%u ch, %u conn)\n",
1218 msize, esize, ch_n, c_n);
1219 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%u (%u ch, %u conn)\n",
1220 sizeof (struct GNUNET_CADET_LocalInfoTunnel),
1221 sizeof (CADET_ChannelNumber), sizeof (struct GNUNET_HashCode));
1222 h->info_cb.tunnel_cb (h->info_cls, NULL, 0, 0, NULL, NULL, 0, 0);
1226 /* Call Callback with tunnel info. */
1227 conns = (struct GNUNET_CADET_Hash *) &msg[1];
1228 chns = (CADET_ChannelNumber *) &conns[c_n];
1229 h->info_cb.tunnel_cb (h->info_cls, &msg->destination,
1230 ch_n, c_n, chns, conns,
1231 ntohs (msg->estate), ntohs (msg->cstate));
1234 h->info_cb.tunnel_cb = NULL;
1240 * Function to process all messages received from the service
1242 * @param cls closure
1243 * @param msg message received, NULL on timeout or fatal error
1246 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1248 struct GNUNET_CADET_Handle *h = cls;
1253 LOG (GNUNET_ERROR_TYPE_DEBUG,
1254 "Cadet service disconnected, reconnecting\n", h);
1258 type = ntohs (msg->type);
1259 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1260 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a message: %s\n",
1264 /* Notify of a new incoming channel */
1265 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE:
1266 process_channel_created (h, (struct GNUNET_CADET_ChannelMessage *) msg);
1268 /* Notify of a channel disconnection */
1269 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY: /* TODO separate(gid problem)*/
1270 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_NACK:
1271 process_channel_destroy (h, (struct GNUNET_CADET_ChannelMessage *) msg);
1273 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA:
1274 process_incoming_data (h, msg);
1276 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK:
1277 process_ack (h, msg);
1279 // case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNELS:
1280 // process_get_channels (h, msg);
1282 // case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL:
1283 // process_show_channel (h, msg);
1285 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS:
1286 process_get_peers (h, msg);
1288 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER:
1289 process_get_peer (h, msg);
1291 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS:
1292 process_get_tunnels (h, msg);
1294 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL:
1295 process_get_tunnel (h, msg);
1297 // case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL:
1298 // process_show_channel (h, msg);
1301 /* We shouldn't get any other packages, log and ignore */
1302 LOG (GNUNET_ERROR_TYPE_WARNING,
1303 "unsolicited message form service (type %s)\n",
1304 GC_m2s (ntohs (msg->type)));
1306 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1307 if (GNUNET_YES == h->in_receive)
1309 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1310 GNUNET_TIME_UNIT_FOREVER_REL);
1314 LOG (GNUNET_ERROR_TYPE_DEBUG,
1315 "in receive off, not calling CLIENT_receive\n");
1320 /******************************************************************************/
1321 /************************ SEND FUNCTIONS ****************************/
1322 /******************************************************************************/
1325 * Function called to send a message to the service.
1326 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1329 * @param cls closure, the cadet handle
1330 * @param size number of bytes available in buf
1331 * @param buf where the callee should write the connect message
1332 * @return number of bytes written to buf
1335 send_callback (void *cls, size_t size, void *buf)
1337 struct GNUNET_CADET_Handle *h = cls;
1338 struct GNUNET_CADET_TransmitHandle *th;
1339 struct GNUNET_CADET_TransmitHandle *next;
1340 struct GNUNET_CADET_Channel *ch;
1346 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1347 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send callback, buffer %u\n", size);
1348 if ((0 == size) || (NULL == buf))
1350 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Received NULL send callback on %p\n", h);
1357 nsize = message_ready_size (h);
1358 while ((NULL != (th = next)) && (0 < nsize) && (size >= nsize))
1361 if (GNUNET_YES == th_is_payload (th))
1363 struct GNUNET_CADET_LocalData *dmsg;
1364 struct GNUNET_MessageHeader *mh;
1366 LOG (GNUNET_ERROR_TYPE_DEBUG, "# payload, %u bytes on %X (%p)\n",
1367 th->size, ch->chid, ch);
1368 if (GNUNET_NO == ch->allow_send)
1370 /* This channel is not ready to transmit yet, Try the next message */
1374 ch->packet_size = 0;
1375 GNUNET_assert (size >= th->size);
1376 dmsg = (struct GNUNET_CADET_LocalData *) cbuf;
1377 mh = (struct GNUNET_MessageHeader *) &dmsg[1];
1378 psize = th->notify (th->notify_cls, size - DATA_OVERHEAD, mh);
1382 GNUNET_assert (sizeof (struct GNUNET_MessageHeader) <= psize);
1383 psize += DATA_OVERHEAD;
1384 GNUNET_assert (size >= psize);
1385 dmsg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA);
1386 dmsg->header.size = htons (psize);
1387 dmsg->id = htonl (ch->chid);
1388 LOG (GNUNET_ERROR_TYPE_DEBUG, "# sending, type %s\n",
1389 GC_m2s (ntohs (mh->type)));
1390 ch->allow_send = GNUNET_NO;
1394 LOG (GNUNET_ERROR_TYPE_DEBUG,
1395 "# callback returned size 0, "
1396 "application canceled transmission\n");
1401 const struct GNUNET_MessageHeader *mh;
1403 mh = (const struct GNUNET_MessageHeader *) &th[1];
1404 LOG (GNUNET_ERROR_TYPE_DEBUG, "# cadet internal traffic, type %s\n",
1405 GC_m2s (ntohs (mh->type)));
1406 memcpy (cbuf, &th[1], th->size);
1409 GNUNET_assert (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE >= psize);
1410 if (th->timeout_task != NULL)
1411 GNUNET_SCHEDULER_cancel (th->timeout_task);
1413 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1415 nsize = message_ready_size (h);
1420 LOG (GNUNET_ERROR_TYPE_DEBUG, "# total size: %u\n", tsize);
1422 size = message_ready_size (h);
1425 LOG (GNUNET_ERROR_TYPE_DEBUG, "# next size: %u\n", size);
1427 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1428 GNUNET_TIME_UNIT_FOREVER_REL,
1429 GNUNET_YES, &send_callback, h);
1433 if (NULL != h->th_head)
1434 LOG (GNUNET_ERROR_TYPE_DEBUG, "# nothing ready to transmit\n");
1436 LOG (GNUNET_ERROR_TYPE_DEBUG, "# nothing left to transmit\n");
1438 if (GNUNET_NO == h->in_receive)
1440 LOG (GNUNET_ERROR_TYPE_DEBUG, "# start receiving from service\n");
1441 h->in_receive = GNUNET_YES;
1442 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1443 GNUNET_TIME_UNIT_FOREVER_REL);
1445 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Send callback() END\n");
1451 * Auxiliary function to send an already constructed packet to the service.
1452 * Takes care of creating a new queue element, copying the message and
1453 * calling the tmt_rdy function if necessary.
1455 * @param h cadet handle
1456 * @param msg message to transmit
1457 * @param channel channel this send is related to (NULL if N/A)
1460 send_packet (struct GNUNET_CADET_Handle *h,
1461 const struct GNUNET_MessageHeader *msg,
1462 struct GNUNET_CADET_Channel *channel)
1464 struct GNUNET_CADET_TransmitHandle *th;
1467 LOG (GNUNET_ERROR_TYPE_DEBUG, " Sending message to service: %s\n",
1468 GC_m2s(ntohs(msg->type)));
1469 msize = ntohs (msg->size);
1470 th = GNUNET_malloc (sizeof (struct GNUNET_CADET_TransmitHandle) + msize);
1471 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1473 th->channel = channel;
1474 memcpy (&th[1], msg, msize);
1475 add_to_queue (h, th);
1478 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling ntfy tmt rdy for %u bytes\n", msize);
1480 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1481 GNUNET_TIME_UNIT_FOREVER_REL,
1482 GNUNET_YES, &send_callback, h);
1486 /******************************************************************************/
1487 /********************** API CALL DEFINITIONS *************************/
1488 /******************************************************************************/
1490 struct GNUNET_CADET_Handle *
1491 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1492 GNUNET_CADET_InboundChannelNotificationHandler new_channel,
1493 GNUNET_CADET_ChannelEndHandler cleaner,
1494 const struct GNUNET_CADET_MessageHandler *handlers,
1495 const uint32_t *ports)
1497 struct GNUNET_CADET_Handle *h;
1499 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_CADET_connect()\n");
1500 h = GNUNET_new (struct GNUNET_CADET_Handle);
1501 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1503 h->new_channel = new_channel;
1504 h->cleaner = cleaner;
1505 h->client = GNUNET_CLIENT_connect ("cadet", cfg);
1506 if (h->client == NULL)
1513 h->message_handlers = handlers;
1515 h->next_chid = GNUNET_CADET_LOCAL_CHANNEL_ID_CLI;
1516 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1517 h->reconnect_task = NULL;
1519 if (NULL != ports && ports[0] != 0 && NULL == new_channel)
1522 LOG (GNUNET_ERROR_TYPE_DEBUG,
1523 "no new channel handler given, ports parameter is useless!!\n");
1525 if ((NULL == ports || ports[0] == 0) && NULL != new_channel)
1528 LOG (GNUNET_ERROR_TYPE_DEBUG,
1529 "no ports given, new channel handler will never be called!!\n");
1531 /* count handlers */
1532 for (h->n_handlers = 0;
1533 handlers && handlers[h->n_handlers].type;
1535 for (h->n_ports = 0;
1536 ports && ports[h->n_ports];
1539 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_CADET_connect() END\n");
1545 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
1547 struct GNUNET_CADET_Channel *ch;
1548 struct GNUNET_CADET_Channel *aux;
1549 struct GNUNET_CADET_TransmitHandle *th;
1551 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET DISCONNECT\n");
1553 ch = handle->channels_head;
1557 if (ch->chid < GNUNET_CADET_LOCAL_CHANNEL_ID_SERV)
1560 LOG (GNUNET_ERROR_TYPE_DEBUG, "channel %X not destroyed\n", ch->chid);
1562 destroy_channel (ch, GNUNET_YES);
1565 while ( (th = handle->th_head) != NULL)
1567 struct GNUNET_MessageHeader *msg;
1569 /* Make sure it is an allowed packet (everything else should have been
1570 * already canceled).
1572 GNUNET_break (GNUNET_NO == th_is_payload (th));
1573 msg = (struct GNUNET_MessageHeader *) &th[1];
1574 switch (ntohs(msg->type))
1576 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_CONNECT:
1577 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE:
1578 case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY:
1579 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNELS:
1580 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL:
1581 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER:
1582 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS:
1583 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL:
1584 case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS:
1588 LOG (GNUNET_ERROR_TYPE_ERROR, "unexpected unsent msg %s\n",
1589 GC_m2s (ntohs(msg->type)));
1592 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1596 if (NULL != handle->th)
1598 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1601 if (NULL != handle->client)
1603 GNUNET_CLIENT_disconnect (handle->client);
1604 handle->client = NULL;
1606 if (NULL != handle->reconnect_task)
1608 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1609 handle->reconnect_task = NULL;
1611 GNUNET_free (handle);
1616 * Create a new channel towards a remote peer.
1618 * If the destination port is not open by any peer or the destination peer
1619 * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called
1622 * @param h cadet handle
1623 * @param channel_ctx client's channel context to associate with the channel
1624 * @param peer peer identity the channel should go to
1625 * @param port Port number.
1626 * @param options CadetOption flag field, with all desired option bits set to 1.
1628 * @return handle to the channel
1630 struct GNUNET_CADET_Channel *
1631 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
1633 const struct GNUNET_PeerIdentity *peer,
1635 enum GNUNET_CADET_ChannelOption options)
1637 struct GNUNET_CADET_Channel *ch;
1638 struct GNUNET_CADET_ChannelMessage msg;
1640 LOG (GNUNET_ERROR_TYPE_DEBUG,
1641 "Creating new channel to %s:%u\n",
1642 GNUNET_i2s (peer), port);
1643 ch = create_channel (h, 0);
1644 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", ch);
1645 LOG (GNUNET_ERROR_TYPE_DEBUG, " number %X\n", ch->chid);
1646 ch->ctx = channel_ctx;
1647 ch->peer = GNUNET_PEER_intern (peer);
1648 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE);
1649 msg.header.size = htons (sizeof (struct GNUNET_CADET_ChannelMessage));
1650 msg.channel_id = htonl (ch->chid);
1651 msg.port = htonl (port);
1653 msg.opt = htonl (options);
1654 ch->allow_send = GNUNET_NO;
1655 send_packet (h, &msg.header, ch);
1661 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
1663 struct GNUNET_CADET_Handle *h;
1664 struct GNUNET_CADET_ChannelMessage msg;
1665 struct GNUNET_CADET_TransmitHandle *th;
1667 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying channel\n");
1670 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY);
1671 msg.header.size = htons (sizeof (struct GNUNET_CADET_ChannelMessage));
1672 msg.channel_id = htonl (channel->chid);
1673 memset (&msg.peer, 0, sizeof (struct GNUNET_PeerIdentity));
1679 struct GNUNET_CADET_TransmitHandle *aux;
1680 if (th->channel == channel)
1683 if (GNUNET_YES == th_is_payload (th))
1685 /* applications should cancel before destroying channel */
1687 th->notify (th->notify_cls, 0, NULL);
1689 GNUNET_CADET_notify_transmit_ready_cancel (th);
1696 destroy_channel (channel, GNUNET_YES);
1697 send_packet (h, &msg.header, NULL);
1702 * Get information about a channel.
1704 * @param channel Channel handle.
1705 * @param option Query (GNUNET_CADET_OPTION_*).
1706 * @param ... dependant on option, currently not used
1708 * @return Union with an answer to the query.
1710 const union GNUNET_CADET_ChannelInfo *
1711 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
1712 enum GNUNET_CADET_ChannelOption option, ...)
1714 static int bool_flag;
1715 const union GNUNET_CADET_ChannelInfo *ret;
1719 case GNUNET_CADET_OPTION_NOBUFFER:
1720 case GNUNET_CADET_OPTION_RELIABLE:
1721 case GNUNET_CADET_OPTION_OOORDER:
1722 if (0 != (option & channel->options))
1723 bool_flag = GNUNET_YES;
1725 bool_flag = GNUNET_NO;
1726 ret = (const union GNUNET_CADET_ChannelInfo *) &bool_flag;
1728 case GNUNET_CADET_OPTION_PEER:
1729 ret = (const union GNUNET_CADET_ChannelInfo *) GNUNET_PEER_resolve2 (channel->peer);
1739 struct GNUNET_CADET_TransmitHandle *
1740 GNUNET_CADET_notify_transmit_ready (struct GNUNET_CADET_Channel *channel, int cork,
1741 struct GNUNET_TIME_Relative maxdelay,
1743 GNUNET_CONNECTION_TransmitReadyNotify notify,
1746 struct GNUNET_CADET_TransmitHandle *th;
1748 GNUNET_assert (NULL != channel);
1749 GNUNET_assert (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE >= notify_size);
1750 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY\n");
1751 LOG (GNUNET_ERROR_TYPE_DEBUG, " on channel %X\n", channel->chid);
1752 LOG (GNUNET_ERROR_TYPE_DEBUG, " allow_send %d\n", channel->allow_send);
1753 if (channel->chid >= GNUNET_CADET_LOCAL_CHANNEL_ID_SERV)
1754 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin\n");
1756 LOG (GNUNET_ERROR_TYPE_DEBUG, " to destination\n");
1757 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
1758 GNUNET_assert (NULL != notify);
1759 GNUNET_assert (0 == channel->packet_size); // Only one data packet allowed
1760 th = GNUNET_new (struct GNUNET_CADET_TransmitHandle);
1761 th->channel = channel;
1762 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1763 th->size = notify_size + DATA_OVERHEAD;
1764 channel->packet_size = th->size;
1765 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
1766 th->notify = notify;
1767 th->notify_cls = notify_cls;
1768 add_to_queue (channel->cadet, th);
1769 if (NULL != channel->cadet->th)
1771 if (GNUNET_NO == channel->allow_send)
1773 LOG (GNUNET_ERROR_TYPE_DEBUG, " call client notify tmt rdy\n");
1774 channel->cadet->th =
1775 GNUNET_CLIENT_notify_transmit_ready (channel->cadet->client, th->size,
1776 GNUNET_TIME_UNIT_FOREVER_REL,
1777 GNUNET_YES, &send_callback,
1779 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY END\n");
1785 GNUNET_CADET_notify_transmit_ready_cancel (struct GNUNET_CADET_TransmitHandle *th)
1787 struct GNUNET_CADET_Handle *cadet;
1789 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY CANCEL\n");
1790 LOG (GNUNET_ERROR_TYPE_DEBUG, " on channel %X (%p)\n",
1791 th->channel->chid, th->channel);
1792 LOG (GNUNET_ERROR_TYPE_DEBUG, " size %u bytes\n", th->size);
1793 th->channel->packet_size = 0;
1794 cadet = th->channel->cadet;
1795 if (th->timeout_task != NULL)
1796 GNUNET_SCHEDULER_cancel (th->timeout_task);
1797 GNUNET_CONTAINER_DLL_remove (cadet->th_head, cadet->th_tail, th);
1799 if ((0 == message_ready_size (cadet)) && (NULL != cadet->th))
1801 /* queue empty, no point in asking for transmission */
1802 GNUNET_CLIENT_notify_transmit_ready_cancel (cadet->th);
1805 LOG (GNUNET_ERROR_TYPE_DEBUG, "CADET NOTIFY TRANSMIT READY CANCEL END\n");
1810 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
1817 send_info_request (struct GNUNET_CADET_Handle *h, uint16_t type)
1819 struct GNUNET_MessageHeader msg;
1821 msg.size = htons (sizeof (msg));
1822 msg.type = htons (type);
1823 send_packet (h, &msg, NULL);
1828 * Request a debug dump on the service's STDERR.
1830 * WARNING: unstable API, likely to change in the future!
1832 * @param h cadet handle
1835 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h)
1837 LOG (GNUNET_ERROR_TYPE_DEBUG, "requesting dump\n");
1838 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP);
1843 * Request information about peers known to the running cadet service.
1844 * The callback will be called for every peer known to the service.
1845 * Only one info request (of any kind) can be active at once.
1848 * WARNING: unstable API, likely to change in the future!
1850 * @param h Handle to the cadet peer.
1851 * @param callback Function to call with the requested data.
1852 * @param callback_cls Closure for @c callback.
1854 * @return #GNUNET_OK / #GNUNET_SYSERR
1857 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
1858 GNUNET_CADET_PeersCB callback,
1861 if (NULL != h->info_cb.peers_cb)
1864 return GNUNET_SYSERR;
1866 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
1867 h->info_cb.peers_cb = callback;
1868 h->info_cls = callback_cls;
1874 * Cancel a peer info request. The callback will not be called (anymore).
1876 * WARNING: unstable API, likely to change in the future!
1878 * @param h Cadet handle.
1880 * @return Closure given to GNUNET_CADET_get_peers.
1883 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h)
1888 h->info_cb.peers_cb = NULL;
1895 * Request information about a peer known to the running cadet peer.
1896 * The callback will be called for the tunnel once.
1897 * Only one info request (of any kind) can be active at once.
1899 * WARNING: unstable API, likely to change in the future!
1901 * @param h Handle to the cadet peer.
1902 * @param id Peer whose tunnel to examine.
1903 * @param callback Function to call with the requested data.
1904 * @param callback_cls Closure for @c callback.
1906 * @return #GNUNET_OK / #GNUNET_SYSERR
1909 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
1910 const struct GNUNET_PeerIdentity *id,
1911 GNUNET_CADET_PeerCB callback,
1914 struct GNUNET_CADET_LocalInfo msg;
1916 if (NULL != h->info_cb.peer_cb)
1919 return GNUNET_SYSERR;
1922 memset (&msg, 0, sizeof (msg));
1923 msg.header.size = htons (sizeof (msg));
1924 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
1926 send_packet (h, &msg.header, NULL);
1927 h->info_cb.peer_cb = callback;
1928 h->info_cls = callback_cls;
1934 * Request information about tunnels of the running cadet peer.
1935 * The callback will be called for every tunnel of the service.
1936 * Only one info request (of any kind) can be active at once.
1938 * WARNING: unstable API, likely to change in the future!
1940 * @param h Handle to the cadet peer.
1941 * @param callback Function to call with the requested data.
1942 * @param callback_cls Closure for @c callback.
1944 * @return #GNUNET_OK / #GNUNET_SYSERR
1947 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
1948 GNUNET_CADET_TunnelsCB callback,
1951 if (NULL != h->info_cb.tunnels_cb)
1954 return GNUNET_SYSERR;
1956 send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
1957 h->info_cb.tunnels_cb = callback;
1958 h->info_cls = callback_cls;
1964 * Cancel a monitor request. The monitor callback will not be called.
1966 * @param h Cadet handle.
1968 * @return Closure given to GNUNET_CADET_get_tunnels.
1971 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h)
1975 h->info_cb.tunnels_cb = NULL;
1985 * Request information about a tunnel of the running cadet peer.
1986 * The callback will be called for the tunnel once.
1987 * Only one info request (of any kind) can be active at once.
1989 * WARNING: unstable API, likely to change in the future!
1991 * @param h Handle to the cadet peer.
1992 * @param id Peer whose tunnel to examine.
1993 * @param callback Function to call with the requested data.
1994 * @param callback_cls Closure for @c callback.
1996 * @return #GNUNET_OK / #GNUNET_SYSERR
1999 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
2000 const struct GNUNET_PeerIdentity *id,
2001 GNUNET_CADET_TunnelCB callback,
2004 struct GNUNET_CADET_LocalInfo msg;
2006 if (NULL != h->info_cb.tunnel_cb)
2009 return GNUNET_SYSERR;
2012 memset (&msg, 0, sizeof (msg));
2013 msg.header.size = htons (sizeof (msg));
2014 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
2016 send_packet (h, &msg.header, NULL);
2017 h->info_cb.tunnel_cb = callback;
2018 h->info_cls = callback_cls;
2024 * Request information about a specific channel of the running cadet peer.
2026 * WARNING: unstable API, likely to change in the future!
2027 * FIXME Add destination option.
2029 * @param h Handle to the cadet peer.
2030 * @param initiator ID of the owner of the channel.
2031 * @param channel_number Channel number.
2032 * @param callback Function to call with the requested data.
2033 * @param callback_cls Closure for @c callback.
2035 * @return #GNUNET_OK / #GNUNET_SYSERR
2038 GNUNET_CADET_show_channel (struct GNUNET_CADET_Handle *h,
2039 struct GNUNET_PeerIdentity *initiator,
2040 unsigned int channel_number,
2041 GNUNET_CADET_ChannelCB callback,
2044 struct GNUNET_CADET_LocalInfo msg;
2046 if (NULL != h->info_cb.channel_cb)
2049 return GNUNET_SYSERR;
2052 msg.header.size = htons (sizeof (msg));
2053 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL);
2054 msg.peer = *initiator;
2055 msg.channel_id = htonl (channel_number);
2056 // msg.reserved = 0;
2057 send_packet (h, &msg.header, NULL);
2058 h->info_cb.channel_cb = callback;
2059 h->info_cls = callback_cls;
2065 * Function called to notify a client about the connection
2066 * begin ready to queue more data. "buf" will be
2067 * NULL and "size" zero if the connection was closed for
2068 * writing in the meantime.
2070 * @param cls closure
2071 * @param size number of bytes available in buf
2072 * @param buf where the callee should write the message
2073 * @return number of bytes written to buf
2076 cadet_mq_ntr (void *cls, size_t size,
2079 struct GNUNET_MQ_Handle *mq = cls;
2080 struct CadetMQState *state = GNUNET_MQ_impl_state (mq);
2081 const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq);
2087 GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_WRITE);
2090 msize = ntohs (msg->size);
2091 GNUNET_assert (msize <= size);
2092 memcpy (buf, msg, msize);
2093 GNUNET_MQ_impl_send_continue (mq);
2099 * Signature of functions implementing the
2100 * sending functionality of a message queue.
2102 * @param mq the message queue
2103 * @param msg the message to send
2104 * @param impl_state state of the implementation
2107 cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq,
2108 const struct GNUNET_MessageHeader *msg,
2111 struct CadetMQState *state = impl_state;
2113 GNUNET_assert (NULL == state->th);
2115 GNUNET_CADET_notify_transmit_ready (state->channel,
2116 /* FIXME: add option for corking */
2118 GNUNET_TIME_UNIT_FOREVER_REL,
2126 * Signature of functions implementing the
2127 * destruction of a message queue.
2128 * Implementations must not free 'mq', but should
2129 * take care of 'impl_state'.
2131 * @param mq the message queue to destroy
2132 * @param impl_state state of the implementation
2135 cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq,
2138 struct CadetMQState *state = impl_state;
2140 if (NULL != state->th)
2141 GNUNET_CADET_notify_transmit_ready_cancel (state->th);
2143 GNUNET_free (state);
2148 * Create a message queue for a cadet channel.
2149 * The message queue can only be used to transmit messages,
2150 * not to receive them.
2152 * @param channel the channel to create the message qeue for
2153 * @return a message queue to messages over the channel
2155 struct GNUNET_MQ_Handle *
2156 GNUNET_CADET_mq_create (struct GNUNET_CADET_Channel *channel)
2158 struct GNUNET_MQ_Handle *mq;
2159 struct CadetMQState *state;
2161 state = GNUNET_new (struct CadetMQState);
2162 state->channel = channel;
2164 mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl,
2165 &cadet_mq_destroy_impl,
2166 NULL, /* FIXME: cancel impl. */
2168 NULL, /* no msg handlers */
2169 NULL, /* no err handlers */
2170 NULL); /* no handler cls */