From ba32b87dd8c99a85ffe5d620d9ad20b43abf7345 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Mon, 13 Mar 2017 01:33:06 +0100 Subject: [PATCH] getting rid of the old cadet client library (pre-MQ) --- src/cadet/Makefile.am | 12 - src/cadet/cadet_api.c | 2648 ---------------------------- src/cadet/cadet_api_new.c | 5 - src/cadet/cadet_common.c | 370 ---- src/include/gnunet_cadet_service.h | 525 ++---- 5 files changed, 153 insertions(+), 3407 deletions(-) delete mode 100644 src/cadet/cadet_api.c delete mode 100644 src/cadet/cadet_common.c diff --git a/src/cadet/Makefile.am b/src/cadet/Makefile.am index 1fe912305..c30804e13 100644 --- a/src/cadet/Makefile.am +++ b/src/cadet/Makefile.am @@ -30,20 +30,8 @@ bin_PROGRAMS = \ lib_LTLIBRARIES = \ libgnunetcadetnew.la \ - libgnunetcadet.la \ $(EXP_LIB) -libgnunetcadet_la_SOURCES = \ - cadet_api.c cadet_common.c -libgnunetcadet_la_LIBADD = \ - $(top_builddir)/src/util/libgnunetutil.la \ - $(XLIB) \ - $(LTLIBINTL) -libgnunetcadet_la_LDFLAGS = \ - $(GN_LIB_LDFLAGS) $(WINFLAGS) \ - -version-info 5:0:0 - - libgnunetcadetnew_la_SOURCES = \ cadet_api_new.c libgnunetcadetnew_la_LIBADD = \ diff --git a/src/cadet/cadet_api.c b/src/cadet/cadet_api.c deleted file mode 100644 index 1a37f7193..000000000 --- a/src/cadet/cadet_api.c +++ /dev/null @@ -1,2648 +0,0 @@ -/* - This file is part of GNUnet. - Copyright (C) 2011, 2017 GNUnet e.V. - - GNUnet is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 3, or (at your - option) any later version. - - GNUnet is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. -*/ -/** - * @file cadet/cadet_api.c - * @brief cadet api: client implementation of cadet service - * @author Bartlomiej Polot - */ - -#include "platform.h" -#include "gnunet_util_lib.h" -#include "gnunet_constants.h" -#include "gnunet_cadet_service.h" -#include "cadet.h" -#include "cadet_protocol.h" - -#define LOG(kind,...) GNUNET_log_from (kind, "cadet-api",__VA_ARGS__) - -/******************************************************************************/ -/************************ DATA STRUCTURES ****************************/ -/******************************************************************************/ - -/** - * Transmission queue to the service - * - * @deprecated - */ -struct GNUNET_CADET_TransmitHandle -{ - /** - * Double Linked list - */ - struct GNUNET_CADET_TransmitHandle *next; - - /** - * Double Linked list - */ - struct GNUNET_CADET_TransmitHandle *prev; - - /** - * Channel this message is sent on / for (may be NULL for control messages). - */ - struct GNUNET_CADET_Channel *channel; - - /** - * Request data task. - */ - struct GNUNET_SCHEDULER_Task *request_data_task; - - /** - * Callback to obtain the message to transmit, or NULL if we - * got the message in 'data'. Notice that messages built - * by 'notify' need to be encapsulated with information about - * the 'target'. - */ - GNUNET_CONNECTION_TransmitReadyNotify notify; - - /** - * Closure for 'notify' - */ - void *notify_cls; - - /** - * Size of the payload. - */ - size_t size; -}; - - -union CadetInfoCB -{ - - /** - * Channel callback. - */ - GNUNET_CADET_ChannelCB channel_cb; - - /** - * Monitor callback - */ - GNUNET_CADET_PeersCB peers_cb; - - /** - * Monitor callback - */ - GNUNET_CADET_PeerCB peer_cb; - - /** - * Monitor callback - */ - GNUNET_CADET_TunnelsCB tunnels_cb; - - /** - * Tunnel callback. - */ - GNUNET_CADET_TunnelCB tunnel_cb; -}; - - -/** - * Opaque handle to the service. - */ -struct GNUNET_CADET_Handle -{ - /** - * Flag to indicate old or MQ API. - */ - int mq_api; - - /** - * Message queue (if available). - */ - struct GNUNET_MQ_Handle *mq; - - /** - * Set of handlers used for processing incoming messages in the channels - * - * @deprecated - */ - const struct GNUNET_CADET_MessageHandler *message_handlers; - - /** - * Number of handlers in the handlers array. - * - * @deprecated - */ - unsigned int n_handlers; - - /** - * Ports open. - */ - struct GNUNET_CONTAINER_MultiHashMap *ports; - - /** - * Double linked list of the channels this client is connected to, head. - */ - struct GNUNET_CADET_Channel *channels_head; - - /** - * Double linked list of the channels this client is connected to, tail. - */ - struct GNUNET_CADET_Channel *channels_tail; - - /** - * Callback for inbound channel disconnection - */ - GNUNET_CADET_ChannelEndHandler *cleaner; - - /** - * Closure for all the handlers given by the client - * - * @deprecated - */ - void *cls; - - /** - * Messages to send to the service, head. - * - * @deprecated - */ - struct GNUNET_CADET_TransmitHandle *th_head; - - /** - * Messages to send to the service, tail. - * - * @deprecated - */ - struct GNUNET_CADET_TransmitHandle *th_tail; - - /** - * child of the next channel to create (to avoid reusing IDs often) - */ - struct GNUNET_CADET_ClientChannelNumber next_ccn; - - /** - * Configuration given by the client, in case of reconnection - */ - const struct GNUNET_CONFIGURATION_Handle *cfg; - - /** - * Time to the next reconnect in case one reconnect fails - */ - struct GNUNET_TIME_Relative reconnect_time; - - /** - * Task for trying to reconnect. - */ - struct GNUNET_SCHEDULER_Task * reconnect_task; - - /** - * Callback for an info task (only one active at a time). - */ - union CadetInfoCB info_cb; - - /** - * Info callback closure for @c info_cb. - */ - void *info_cls; -}; - - -/** - * Description of a peer - */ -struct GNUNET_CADET_Peer -{ - /** - * ID of the peer in short form - */ - GNUNET_PEER_Id id; - - /** - * Channel this peer belongs to - */ - struct GNUNET_CADET_Channel *t; -}; - - -/** - * Opaque handle to a channel. - */ -struct GNUNET_CADET_Channel -{ - /** - * DLL next - */ - struct GNUNET_CADET_Channel *next; - - /** - * DLL prev - */ - struct GNUNET_CADET_Channel *prev; - - /** - * Handle to the cadet this channel belongs to - */ - struct GNUNET_CADET_Handle *cadet; - - /** - * Local ID of the channel - */ - struct GNUNET_CADET_ClientChannelNumber ccn; - - /** - * Channel's port, if incoming. - */ - struct GNUNET_CADET_Port *incoming_port; - - /** - * Other end of the channel. - */ - GNUNET_PEER_Id peer; - - /** - * Any data the caller wants to put in here - */ - void *ctx; - - /** - * Channel options: reliability, etc. - */ - enum GNUNET_CADET_ChannelOption options; - - /** - * Are we allowed to send to the service? - * - * @deprecated? - */ - unsigned int allow_send; - - /***************************** MQ ************************************/ - /** - * Message Queue for the channel. - */ - struct GNUNET_MQ_Handle *mq; - - /** - * Task to allow mq to send more traffic. - */ - struct GNUNET_SCHEDULER_Task *mq_cont; - - /** - * Pending envelope in case we don't have an ACK from the service. - */ - struct GNUNET_MQ_Envelope *pending_env; - - /** - * Window change handler. - */ - GNUNET_CADET_WindowSizeEventHandler window_changes; - - /** - * Disconnect handler. - */ - GNUNET_CADET_DisconnectEventHandler disconnects; - -}; - - -/** - * Opaque handle to a port. - */ -struct GNUNET_CADET_Port -{ - /** - * Handle to the CADET session this port belongs to. - */ - struct GNUNET_CADET_Handle *cadet; - - /** - * Port ID. - * - * @deprecated - */ - struct GNUNET_HashCode *hash; - - /** - * Callback handler for incoming channels on this port. - */ - GNUNET_CADET_InboundChannelNotificationHandler *handler; - - /** - * Closure for @a handler. - */ - void *cls; - - /***************************** MQ ************************************/ - - /** - * Port "number" - */ - struct GNUNET_HashCode id; - - /** - * Handler for incoming channels on this port - */ - GNUNET_CADET_ConnectEventHandler connects; - - /** - * Closure for @ref connects - */ - void * connects_cls; - - /** - * Window size change handler. - */ - GNUNET_CADET_WindowSizeEventHandler window_changes; - - /** - * Handler called when an incoming channel is destroyed.. - */ - GNUNET_CADET_DisconnectEventHandler disconnects; - - /** - * Payload handlers for incoming channels. - */ - const struct GNUNET_MQ_MessageHandler *handlers; -}; - - -/** - * Implementation state for cadet's message queue. - */ -struct CadetMQState -{ - /** - * The current transmit handle, or NULL - * if no transmit is active. - */ - struct GNUNET_CADET_TransmitHandle *th; - - /** - * Channel to send the data over. - */ - struct GNUNET_CADET_Channel *channel; -}; - - - -/******************************************************************************/ -/********************* FUNCTION DECLARATIONS *************************/ -/******************************************************************************/ - -/** - * Reconnect to the service, retransmit all infomation to try to restore the - * original state. - * - * @param h Handle to the CADET service. - */ -static void -schedule_reconnect (struct GNUNET_CADET_Handle *h); - - -/** - * Reconnect callback: tries to reconnect again after a failer previous - * reconnection. - * - * @param cls Closure (cadet handle). - */ -static void -reconnect_cbk (void *cls); - - -/** - * Reconnect to the service, retransmit all infomation to try to restore the - * original state. - * - * @param h handle to the cadet - */ -static void -reconnect (struct GNUNET_CADET_Handle *h); - - -/******************************************************************************/ -/*********************** AUXILIARY FUNCTIONS *************************/ -/******************************************************************************/ - -/** - * Check if transmission is a payload packet. - * - * @param th Transmission handle. - * - * @return #GNUNET_YES if it is a payload packet, - * #GNUNET_NO if it is a cadet management packet. - */ -static int -th_is_payload (struct GNUNET_CADET_TransmitHandle *th) -{ - return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO; -} - - -/** - * Find the Port struct for a hash. - * - * @param h CADET handle. - * @param hash HashCode for the port number. - * - * @return The port handle if known, NULL otherwise. - */ -static struct GNUNET_CADET_Port * -find_port (const struct GNUNET_CADET_Handle *h, - const struct GNUNET_HashCode *hash) -{ - struct GNUNET_CADET_Port *p; - - p = GNUNET_CONTAINER_multihashmap_get (h->ports, hash); - - return p; -} - - -/** - * Get the channel handler for the channel specified by id from the given handle - * - * @param h Cadet handle - * @param ccn ID of the wanted channel - * @return handle to the required channel or NULL if not found - */ -static struct GNUNET_CADET_Channel * -retrieve_channel (struct GNUNET_CADET_Handle *h, - struct GNUNET_CADET_ClientChannelNumber ccn) -{ - struct GNUNET_CADET_Channel *ch; - - for (ch = h->channels_head; NULL != ch; ch = ch->next) - if (ch->ccn.channel_of_client == ccn.channel_of_client) - return ch; - return NULL; -} - - -/** - * Create a new channel and insert it in the channel list of the cadet handle - * - * @param h Cadet handle - * @param ccn Desired ccn of the channel, 0 to assign one automatically. - * - * @return Handle to the created channel. - */ -static struct GNUNET_CADET_Channel * -create_channel (struct GNUNET_CADET_Handle *h, - struct GNUNET_CADET_ClientChannelNumber ccn) -{ - struct GNUNET_CADET_Channel *ch; - - ch = GNUNET_new (struct GNUNET_CADET_Channel); - GNUNET_CONTAINER_DLL_insert (h->channels_head, - h->channels_tail, - ch); - ch->cadet = h; - if (0 == ccn.channel_of_client) - { - ch->ccn = h->next_ccn; - while (NULL != retrieve_channel (h, - h->next_ccn)) - { - h->next_ccn.channel_of_client - = htonl (1 + ntohl (h->next_ccn.channel_of_client)); - if (0 == ntohl (h->next_ccn.channel_of_client)) - h->next_ccn.channel_of_client - = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI); - } - } - else - { - ch->ccn = ccn; - } - return ch; -} - - -/** - * Destroy the specified channel. - * - Destroys all peers, calling the disconnect callback on each if needed - * - Cancels all outgoing traffic for that channel, calling respective notifys - * - Calls cleaner if channel was inbound - * - Frees all memory used - * - * @param ch Pointer to the channel. - * @param call_cleaner Whether to call the cleaner handler. - * - * @return Handle to the required channel or NULL if not found. - */ -static void -destroy_channel (struct GNUNET_CADET_Channel *ch) -{ - struct GNUNET_CADET_Handle *h; - struct GNUNET_CADET_TransmitHandle *th; - struct GNUNET_CADET_TransmitHandle *next; - - if (NULL == ch) - { - GNUNET_break (0); - return; - } - h = ch->cadet; - LOG (GNUNET_ERROR_TYPE_DEBUG, - " destroy_channel %X of %p\n", - ch->ccn, - h); - - GNUNET_CONTAINER_DLL_remove (h->channels_head, - h->channels_tail, - ch); - if (NULL != ch->mq_cont) - { - GNUNET_SCHEDULER_cancel (ch->mq_cont); - ch->mq_cont = NULL; - } - /* signal channel destruction */ - if (0 != ch->peer) - { - if (NULL != h->cleaner) - { - /** @a deprecated */ - LOG (GNUNET_ERROR_TYPE_DEBUG, - " calling cleaner\n"); - h->cleaner (h->cls, ch, ch->ctx); - } - else if (NULL != ch->disconnects) - { - LOG (GNUNET_ERROR_TYPE_DEBUG, - " calling disconnect handler\n"); - ch->disconnects (ch->ctx, ch); - } - else - { - /* Application won't be aware of the channel destruction and use - * a pointer to free'd memory. - */ - GNUNET_assert (0); - } - } - - /* check that clients did not leave messages behind in the queue */ - for (th = h->th_head; NULL != th; th = next) - { - next = th->next; - if (th->channel != ch) - continue; - /* Clients should have aborted their requests already. - * Management traffic should be ok, as clients can't cancel that. - * If the service crashed and we are reconnecting, it's ok. - */ - GNUNET_break (GNUNET_NO == th_is_payload (th)); - GNUNET_CADET_notify_transmit_ready_cancel (th); - } - - if (0 != ch->peer) - GNUNET_PEER_change_rc (ch->peer, -1); - GNUNET_free (ch); -} - - -/** - * Add a transmit handle to the transmission queue and set the - * timeout if needed. - * - * @param h cadet handle with the queue head and tail - * @param th handle to the packet to be transmitted - */ -static void -add_to_queue (struct GNUNET_CADET_Handle *h, - struct GNUNET_CADET_TransmitHandle *th) -{ - GNUNET_CONTAINER_DLL_insert_tail (h->th_head, - h->th_tail, - th); -} - - -/** - * Remove a transmit handle from the transmission queue, if present. - * - * Safe to call even if not queued. - * - * @param th handle to the packet to be unqueued. - */ -static void -remove_from_queue (struct GNUNET_CADET_TransmitHandle *th) -{ - struct GNUNET_CADET_Handle *h = th->channel->cadet; - - /* It might or might not have been queued (rarely not), but check anyway. */ - if (NULL != th->next || h->th_tail == th) - { - GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th); - } -} - - -/** - * Notify the application about a change in the window size (if needed). - * - * @param ch Channel to notify about. - */ -static void -notify_window_size (struct GNUNET_CADET_Channel *ch) -{ - if (NULL != ch->window_changes) - { - ch->window_changes (ch->ctx, ch, ch->allow_send); - } -} - -/******************************************************************************/ -/*********************** MQ API CALLBACKS ****************************/ -/******************************************************************************/ - -/** - * Allow the MQ implementation to send the next message. - * - * @param cls Closure (channel whose mq to activate). - */ -static void -cadet_mq_send_continue (void *cls) -{ - struct GNUNET_CADET_Channel *ch = cls; - - ch->mq_cont = NULL; - GNUNET_MQ_impl_send_continue (ch->mq); -} - -/** - * Implement sending functionality of a message queue for - * us sending messages to a peer. - * - * Encapsulates the payload message in a #GNUNET_CADET_LocalData message - * in order to label the message with the channel ID and send the - * encapsulated message to the service. - * - * @param mq the message queue - * @param msg the message to send - * @param impl_state state of the implementation - */ -static void -cadet_mq_send_impl (struct GNUNET_MQ_Handle *mq, - const struct GNUNET_MessageHeader *msg, - void *impl_state) -{ - struct GNUNET_CADET_Channel *ch = impl_state; - struct GNUNET_CADET_Handle *h = ch->cadet; - uint16_t msize; - struct GNUNET_MQ_Envelope *env; - struct GNUNET_CADET_LocalData *cadet_msg; - - - if (NULL == h->mq) - { - /* We're currently reconnecting, pretend this worked */ - GNUNET_MQ_impl_send_continue (mq); - return; - } - - /* check message size for sanity */ - msize = ntohs (msg->size); - if (msize > GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE) - { - GNUNET_break (0); - GNUNET_MQ_impl_send_continue (mq); - return; - } - - env = GNUNET_MQ_msg_nested_mh (cadet_msg, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA, - msg); - cadet_msg->ccn = ch->ccn; - - if (0 < ch->allow_send) - { - /* Service has allowed this message, just send it and continue accepting */ - GNUNET_MQ_send (h->mq, env); - ch->allow_send--; - ch->mq_cont = GNUNET_SCHEDULER_add_now (&cadet_mq_send_continue, ch); - // notify_window_size (ch); /* FIXME add "verbose" setting? */ - } - else - { - /* Service has NOT allowed this message, queue it and wait for an ACK */ - GNUNET_assert (NULL == ch->pending_env); - ch->pending_env = env; - } -} - - -/** - * Handle destruction of a message queue. Implementations must not - * free @a mq, but should take care of @a impl_state. - * - * @param mq the message queue to destroy - * @param impl_state state of the implementation - */ -static void -cadet_mq_destroy_impl (struct GNUNET_MQ_Handle *mq, - void *impl_state) -{ - struct GNUNET_CADET_Channel *ch = impl_state; - - GNUNET_assert (mq == ch->mq); - ch->mq = NULL; -} - - -/** - * We had an error processing a message we forwarded from a peer to - * the CADET service. We should just complain about it but otherwise - * continue processing. - * - * @param cls closure - * @param error error code - */ -static void -cadet_mq_error_handler (void *cls, - enum GNUNET_MQ_Error error) -{ - GNUNET_break_op (0); -} - - -/** - * Implementation function that cancels the currently sent message. - * Should basically undo whatever #mq_send_impl() did. - * - * @param mq message queue - * @param impl_state state specific to the implementation - */ - -static void -cadet_mq_cancel_impl (struct GNUNET_MQ_Handle *mq, - void *impl_state) -{ - struct GNUNET_CADET_Channel *ch = impl_state; - - LOG (GNUNET_ERROR_TYPE_WARNING, - "Cannot cancel mq message on channel %X of %p\n", - ch->ccn.channel_of_client, ch->cadet); - - GNUNET_break (0); -} - - -/******************************************************************************/ -/*********************** RECEIVE HANDLERS ****************************/ -/******************************************************************************/ - - -/** - * Call the @a notify callback given to #GNUNET_CADET_notify_transmit_ready to - * request the data to send over MQ. Since MQ manages the queue, this function - * is scheduled immediatly after a transmit ready notification. - * - * @param cls Closure (transmit handle). - */ -static void -request_data (void *cls) -{ - struct GNUNET_CADET_TransmitHandle *th = cls; - struct GNUNET_CADET_LocalData *msg; - struct GNUNET_MQ_Envelope *env; - size_t osize; - - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Requesting Data: %u bytes (allow send is %u)\n", - th->size, - th->channel->allow_send); - - GNUNET_assert (0 < th->channel->allow_send); - th->channel->allow_send--; - /* NOTE: we may be allowed to send another packet immediately, - albeit the current logic waits for the ACK. */ - th->request_data_task = NULL; - remove_from_queue (th); - - env = GNUNET_MQ_msg_extra (msg, - th->size, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA); - msg->ccn = th->channel->ccn; - osize = th->notify (th->notify_cls, - th->size, - &msg[1]); - GNUNET_assert (osize == th->size); - - GNUNET_MQ_send (th->channel->cadet->mq, - env); - GNUNET_free (th); -} - - -/** - * Process the new channel notification and add it to the channels in the handle - * - * @param h The cadet handle - * @param msg A message with the details of the new incoming channel - */ -static void -handle_channel_created (void *cls, - const struct GNUNET_CADET_LocalChannelCreateMessage *msg) -{ - struct GNUNET_CADET_Handle *h = cls; - struct GNUNET_CADET_Channel *ch; - struct GNUNET_CADET_Port *port; - const struct GNUNET_HashCode *port_number; - struct GNUNET_CADET_ClientChannelNumber ccn; - - ccn = msg->ccn; - port_number = &msg->port; - if (ntohl (ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI) - { - GNUNET_break (0); - return; - } - port = find_port (h, port_number); - if (NULL == port) - { - /* We could have closed the port but the service didn't know about it yet - * This is not an error. - */ - struct GNUNET_CADET_LocalChannelDestroyMessage *d_msg; - struct GNUNET_MQ_Envelope *env; - - GNUNET_break (0); - LOG (GNUNET_ERROR_TYPE_DEBUG, - "No handler for incoming channel %X (on port %s, recently closed?)\n", - ntohl (ccn.channel_of_client), - GNUNET_h2s (port_number)); - env = GNUNET_MQ_msg (d_msg, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY); - d_msg->ccn = msg->ccn; - GNUNET_MQ_send (h->mq, - env); - return; - } - - ch = create_channel (h, - ccn); - ch->peer = GNUNET_PEER_intern (&msg->peer); - ch->cadet = h; - ch->ccn = ccn; - ch->incoming_port = port; - ch->options = ntohl (msg->opt); - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Creating incoming channel %X [%s] %p\n", - ntohl (ccn.channel_of_client), - GNUNET_h2s (port_number), - ch); - - if (NULL != port->handler) - { - /** @deprecated */ - /* Old style API */ - ch->ctx = port->handler (port->cls, - ch, - &msg->peer, - port->hash, - ch->options); - } - else - { - /* MQ API */ - GNUNET_assert (NULL != port->connects); - ch->window_changes = port->window_changes; - ch->disconnects = port->disconnects; - ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl, - &cadet_mq_destroy_impl, - &cadet_mq_cancel_impl, - ch, - port->handlers, - &cadet_mq_error_handler, - ch); - ch->ctx = port->connects (port->cls, - ch, - &msg->peer); - GNUNET_MQ_set_handlers_closure (ch->mq, ch->ctx); - } -} - - -/** - * Process the channel destroy notification and free associated resources - * - * @param h The cadet handle - * @param msg A message with the details of the channel being destroyed - */ -static void -handle_channel_destroy (void *cls, - const struct GNUNET_CADET_LocalChannelDestroyMessage *msg) -{ - struct GNUNET_CADET_Handle *h = cls; - struct GNUNET_CADET_Channel *ch; - struct GNUNET_CADET_ClientChannelNumber ccn; - - ccn = msg->ccn; - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Channel %X Destroy from service\n", - ntohl (ccn.channel_of_client)); - ch = retrieve_channel (h, - ccn); - - if (NULL == ch) - { - LOG (GNUNET_ERROR_TYPE_DEBUG, - "channel %X unknown\n", - ntohl (ccn.channel_of_client)); - return; - } - destroy_channel (ch); -} - - -/** - * Check that message received from CADET service is well-formed. - * - * @param cls the `struct GNUNET_CADET_Handle` - * @param message the message we got - * @return #GNUNET_OK if the message is well-formed, - * #GNUNET_SYSERR otherwise - */ -static int -check_local_data (void *cls, - const struct GNUNET_CADET_LocalData *message) -{ - struct GNUNET_CADET_Handle *h = cls; - struct GNUNET_CADET_Channel *ch; - uint16_t size; - - size = ntohs (message->header.size); - if (sizeof (*message) + sizeof (struct GNUNET_MessageHeader) > size) - { - GNUNET_break_op (0); - return GNUNET_SYSERR; - } - - ch = retrieve_channel (h, - message->ccn); - if (NULL == ch) - { - GNUNET_break_op (0); - return GNUNET_SYSERR; - } - - return GNUNET_OK; -} - - -/** - * Process the incoming data packets, call appropriate handlers. - * - * @param h The cadet handle - * @param message A message encapsulating the data - */ -static void -handle_local_data (void *cls, - const struct GNUNET_CADET_LocalData *message) -{ - struct GNUNET_CADET_Handle *h = cls; - const struct GNUNET_MessageHeader *payload; - const struct GNUNET_CADET_MessageHandler *handler; - struct GNUNET_CADET_Channel *ch; - uint16_t type; - int fwd; - - ch = retrieve_channel (h, - message->ccn); - if (NULL == ch) - { - GNUNET_break_op (0); - reconnect (h); - return; - } - - payload = (struct GNUNET_MessageHeader *) &message[1]; - type = ntohs (payload->type); - fwd = ntohl (ch->ccn.channel_of_client) <= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI; - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Got a %s data on channel %s [%X] of type %s (%u)\n", - GC_f2s (fwd), - GNUNET_i2s (GNUNET_PEER_resolve2 (ch->peer)), - ntohl (message->ccn.channel_of_client), - GC_m2s (type), - type); - if (NULL != ch->mq) - { - LOG (GNUNET_ERROR_TYPE_DEBUG, - "injecting msg %s into mq %p\n", - GC_m2s (ntohs (payload->type)), - ch->mq); - GNUNET_MQ_inject_message (ch->mq, - payload); - return; - } - /** @a deprecated */ - for (unsigned i=0;in_handlers;i++) - { - handler = &h->message_handlers[i]; - if (handler->type == type) - { - if (GNUNET_OK != - handler->callback (h->cls, - ch, - &ch->ctx, - payload)) - { - LOG (GNUNET_ERROR_TYPE_DEBUG, - "callback caused disconnection\n"); - GNUNET_CADET_channel_destroy (ch); - return; - } - return; - } - } - /* Other peer sent message we do not comprehend. */ - GNUNET_break_op (0); - GNUNET_CADET_receive_done (ch); -} - - -/** - * Process a local ACK message, enabling the client to send - * more data to the service. - * - * @param h Cadet handle. - * @param message Message itself. - */ -static void -handle_local_ack (void *cls, - const struct GNUNET_CADET_LocalAck *message) -{ - struct GNUNET_CADET_Handle *h = cls; - struct GNUNET_CADET_Channel *ch; - struct GNUNET_CADET_ClientChannelNumber ccn; - struct GNUNET_CADET_TransmitHandle *th; - - ccn = message->ccn; - ch = retrieve_channel (h, ccn); - if (NULL == ch) - { - LOG (GNUNET_ERROR_TYPE_DEBUG, - "ACK on unknown channel %X\n", - ntohl (ccn.channel_of_client)); - return; - } - ch->allow_send++; - if (NULL != ch->mq) - { - if (NULL == ch->pending_env) - { - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Got an ACK on mq channel %X, allow send now %u!\n", - ntohl (ch->ccn.channel_of_client), - ch->allow_send); - notify_window_size (ch); - } - else - { - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Got an ACK on mq channel %X, sending pending message!\n", - ntohl (ch->ccn.channel_of_client)); - GNUNET_MQ_send (h->mq, ch->pending_env); - ch->allow_send--; - ch->pending_env = NULL; - ch->mq_cont = GNUNET_SCHEDULER_add_now (&cadet_mq_send_continue, ch); - } - return; - } - - /** @deprecated */ - /* Old style API */ - for (th = h->th_head; NULL != th; th = th->next) - { - if ( (th->channel == ch) && - (NULL == th->request_data_task) ) - { - th->request_data_task - = GNUNET_SCHEDULER_add_now (&request_data, - th); - break; - } - } -} - - -/** - * Generic error handler, called with the appropriate error code and - * the same closure specified at the creation of the message queue. - * Not every message queue implementation supports an error handler. - * - * @param cls closure, a `struct GNUNET_CORE_Handle *` - * @param error error code - */ -static void -handle_mq_error (void *cls, - enum GNUNET_MQ_Error error) -{ - struct GNUNET_CADET_Handle *h = cls; - - GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "MQ ERROR: %u\n", error); - GNUNET_MQ_destroy (h->mq); - h->mq = NULL; - reconnect (h); -} - - -/* - * Process a local reply about info on all channels, pass info to the user. - * - * @param h Cadet handle. - * @param message Message itself. - */ -// static void -// process_get_channels (struct GNUNET_CADET_Handle *h, -// const struct GNUNET_MessageHeader *message) -// { -// struct GNUNET_CADET_LocalInfo *msg; -// -// GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Get Channels messasge received\n"); -// -// if (NULL == h->channels_cb) -// { -// GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n"); -// return; -// } -// -// msg = (struct GNUNET_CADET_LocalInfo *) message; -// if (ntohs (message->size) != -// (sizeof (struct GNUNET_CADET_LocalInfo) + -// sizeof (struct GNUNET_PeerIdentity))) -// { -// GNUNET_break_op (0); -// GNUNET_log (GNUNET_ERROR_TYPE_ERROR, -// "Get channels message: size %hu - expected %u\n", -// ntohs (message->size), -// sizeof (struct GNUNET_CADET_LocalInfo)); -// return; -// } -// h->channels_cb (h->channels_cls, -// ntohl (msg->channel_id), -// &msg->owner, -// &msg->destination); -// } - - - -/* - * Process a local monitor_channel reply, pass info to the user. - * - * @param h Cadet handle. - * @param message Message itself. - */ -// static void -// process_show_channel (struct GNUNET_CADET_Handle *h, -// const struct GNUNET_MessageHeader *message) -// { -// struct GNUNET_CADET_LocalInfo *msg; -// size_t esize; -// -// GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Show Channel messasge received\n"); -// -// if (NULL == h->channel_cb) -// { -// GNUNET_log (GNUNET_ERROR_TYPE_ERROR, " ignored\n"); -// return; -// } -// -// /* Verify message sanity */ -// msg = (struct GNUNET_CADET_LocalInfo *) message; -// esize = sizeof (struct GNUNET_CADET_LocalInfo); -// if (ntohs (message->size) != esize) -// { -// GNUNET_break_op (0); -// GNUNET_log (GNUNET_ERROR_TYPE_ERROR, -// "Show channel message: size %hu - expected %u\n", -// ntohs (message->size), -// esize); -// -// h->channel_cb (h->channel_cls, NULL, NULL); -// h->channel_cb = NULL; -// h->channel_cls = NULL; -// -// return; -// } -// -// h->channel_cb (h->channel_cls, -// &msg->destination, -// &msg->owner); -// } - - - -/** - * Check that message received from CADET service is well-formed. - * - * @param cls the `struct GNUNET_CADET_Handle` - * @param message the message we got - * @return #GNUNET_OK if the message is well-formed, - * #GNUNET_SYSERR otherwise - */ -static int -check_get_peers (void *cls, - const struct GNUNET_CADET_LocalInfoPeer *message) -{ - struct GNUNET_CADET_Handle *h = cls; - uint16_t size; - - if (NULL == h->info_cb.peers_cb) - { - GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - " no handler for peesr monitor message!\n"); - return GNUNET_SYSERR; - } - - size = ntohs (message->header.size); - if (sizeof (struct GNUNET_CADET_LocalInfoPeer) > size) - { - h->info_cb.peers_cb (h->info_cls, NULL, -1, 0, 0); - h->info_cb.peers_cb = NULL; - h->info_cls = NULL; - return GNUNET_SYSERR; - } - - return GNUNET_OK; -} - - -/** - * Process a local reply about info on all tunnels, pass info to the user. - * - * @param cls Closure (Cadet handle). - * @param msg Message itself. - */ -static void -handle_get_peers (void *cls, - const struct GNUNET_CADET_LocalInfoPeer *msg) -{ - struct GNUNET_CADET_Handle *h = cls; - h->info_cb.peers_cb (h->info_cls, &msg->destination, - (int) ntohs (msg->tunnel), - (unsigned int ) ntohs (msg->paths), - 0); -} - - -/** - * Check that message received from CADET service is well-formed. - * - * @param cls the `struct GNUNET_CADET_Handle` - * @param message the message we got - * @return #GNUNET_OK if the message is well-formed, - * #GNUNET_SYSERR otherwise - */ -static int -check_get_peer (void *cls, - const struct GNUNET_CADET_LocalInfoPeer *message) -{ - struct GNUNET_CADET_Handle *h = cls; - const size_t msize = sizeof (struct GNUNET_CADET_LocalInfoPeer); - struct GNUNET_PeerIdentity *paths_array; - size_t esize; - unsigned int epaths; - unsigned int paths; - unsigned int peers; - - if (NULL == h->info_cb.peer_cb) - { - GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - " no handler for peer monitor message!\n"); - goto clean_cls; - } - - /* Verify message sanity */ - esize = ntohs (message->header.size); - if (esize < msize) - { - GNUNET_break_op (0); - h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL); - goto clean_cls; - } - if (0 != ((esize - msize) % sizeof (struct GNUNET_PeerIdentity))) - { - GNUNET_break_op (0); - h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL); - goto clean_cls; - - } - peers = (esize - msize) / sizeof (struct GNUNET_PeerIdentity); - epaths = (unsigned int) ntohs (message->paths); - paths_array = (struct GNUNET_PeerIdentity *) &message[1]; - paths = 0; - for (int i = 0; i < peers; i++) - { - if (0 == memcmp (&paths_array[i], &message->destination, - sizeof (struct GNUNET_PeerIdentity))) - { - paths++; - } - } - if (paths != epaths) - { - GNUNET_break_op (0); - GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "p:%u, e: %u\n", paths, epaths); - h->info_cb.peer_cb (h->info_cls, NULL, 0, 0, 0, NULL); - goto clean_cls; - } - - return GNUNET_OK; - -clean_cls: - h->info_cb.peer_cb = NULL; - h->info_cls = NULL; - return GNUNET_SYSERR; -} - - -/** - * Process a local peer info reply, pass info to the user. - * - * @param cls Closure (Cadet handle). - * @param message Message itself. - */ -static void -handle_get_peer (void *cls, - const struct GNUNET_CADET_LocalInfoPeer *message) -{ - struct GNUNET_CADET_Handle *h = cls; - struct GNUNET_PeerIdentity *paths_array; - unsigned int paths; - unsigned int path_length; - int neighbor; - unsigned int peers; - - paths = (unsigned int) ntohs (message->paths); - paths_array = (struct GNUNET_PeerIdentity *) &message[1]; - peers = (ntohs (message->header.size) - sizeof (*message)) - / sizeof (struct GNUNET_PeerIdentity); - path_length = 0; - neighbor = GNUNET_NO; - - for (int i = 0; i < peers; i++) - { - GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (&paths_array[i])); - path_length++; - if (0 == memcmp (&paths_array[i], &message->destination, - sizeof (struct GNUNET_PeerIdentity))) - { - if (1 == path_length) - neighbor = GNUNET_YES; - path_length = 0; - } - } - - /* Call Callback with tunnel info. */ - paths_array = (struct GNUNET_PeerIdentity *) &message[1]; - h->info_cb.peer_cb (h->info_cls, - &message->destination, - (int) ntohs (message->tunnel), - neighbor, - paths, - paths_array); -} - - -/** - * Check that message received from CADET service is well-formed. - * - * @param cls the `struct GNUNET_CADET_Handle` - * @param msg the message we got - * @return #GNUNET_OK if the message is well-formed, - * #GNUNET_SYSERR otherwise - */ -static int -check_get_tunnels (void *cls, - const struct GNUNET_CADET_LocalInfoTunnel *msg) -{ - struct GNUNET_CADET_Handle *h = cls; - uint16_t size; - - if (NULL == h->info_cb.tunnels_cb) - { - GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - " no handler for tunnels monitor message!\n"); - return GNUNET_SYSERR; - } - - size = ntohs (msg->header.size); - if (sizeof (struct GNUNET_CADET_LocalInfoTunnel) > size) - { - h->info_cb.tunnels_cb (h->info_cls, NULL, 0, 0, 0, 0); - h->info_cb.tunnels_cb = NULL; - h->info_cls = NULL; - return GNUNET_SYSERR; - } - return GNUNET_OK; -} - - -/** - * Process a local reply about info on all tunnels, pass info to the user. - * - * @param cls Closure (Cadet handle). - * @param message Message itself. - */ -static void -handle_get_tunnels (void *cls, - const struct GNUNET_CADET_LocalInfoTunnel *msg) -{ - struct GNUNET_CADET_Handle *h = cls; - - h->info_cb.tunnels_cb (h->info_cls, - &msg->destination, - ntohl (msg->channels), - ntohl (msg->connections), - ntohs (msg->estate), - ntohs (msg->cstate)); - -} - - -/** - * Check that message received from CADET service is well-formed. - * - * @param cls the `struct GNUNET_CADET_Handle` - * @param msg the message we got - * @return #GNUNET_OK if the message is well-formed, - * #GNUNET_SYSERR otherwise - */ -static int -check_get_tunnel (void *cls, - const struct GNUNET_CADET_LocalInfoTunnel *msg) -{ - struct GNUNET_CADET_Handle *h = cls; - unsigned int ch_n; - unsigned int c_n; - size_t esize; - size_t msize; - - if (NULL == h->info_cb.tunnel_cb) - { - GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - " no handler for tunnel monitor message!\n"); - goto clean_cls; - } - - /* Verify message sanity */ - msize = ntohs (msg->header.size); - esize = sizeof (struct GNUNET_CADET_LocalInfoTunnel); - if (esize > msize) - { - GNUNET_break_op (0); - h->info_cb.tunnel_cb (h->info_cls, - NULL, 0, 0, NULL, NULL, 0, 0); - goto clean_cls; - } - ch_n = ntohl (msg->channels); - c_n = ntohl (msg->connections); - esize += ch_n * sizeof (struct GNUNET_CADET_ChannelTunnelNumber); - esize += c_n * sizeof (struct GNUNET_CADET_ConnectionTunnelIdentifier); - if (msize != esize) - { - GNUNET_break_op (0); - GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, - "m:%u, e: %u (%u ch, %u conn)\n", - (unsigned int) msize, - (unsigned int) esize, - ch_n, - c_n); - h->info_cb.tunnel_cb (h->info_cls, - NULL, 0, 0, NULL, NULL, 0, 0); - goto clean_cls; - } - - return GNUNET_OK; - -clean_cls: - h->info_cb.tunnel_cb = NULL; - h->info_cls = NULL; - return GNUNET_SYSERR; -} - - -/** - * Process a local tunnel info reply, pass info to the user. - * - * @param cls Closure (Cadet handle). - * @param msg Message itself. - */ -static void -handle_get_tunnel (void *cls, - const struct GNUNET_CADET_LocalInfoTunnel *msg) -{ - struct GNUNET_CADET_Handle *h = cls; - unsigned int ch_n; - unsigned int c_n; - const struct GNUNET_CADET_ConnectionTunnelIdentifier *conns; - const struct GNUNET_CADET_ChannelTunnelNumber *chns; - - ch_n = ntohl (msg->channels); - c_n = ntohl (msg->connections); - - /* Call Callback with tunnel info. */ - conns = (const struct GNUNET_CADET_ConnectionTunnelIdentifier *) &msg[1]; - chns = (const struct GNUNET_CADET_ChannelTunnelNumber *) &conns[c_n]; - h->info_cb.tunnel_cb (h->info_cls, - &msg->destination, - ch_n, - c_n, - chns, - conns, - ntohs (msg->estate), - ntohs (msg->cstate)); -} - - -/** - * Reconnect to the service, retransmit all infomation to try to restore the - * original state. - * - * @param h handle to the cadet - */ -static void -reconnect (struct GNUNET_CADET_Handle *h) -{ - struct GNUNET_MQ_MessageHandler handlers[] = { - GNUNET_MQ_hd_fixed_size (channel_created, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE, - struct GNUNET_CADET_LocalChannelCreateMessage, - h), - GNUNET_MQ_hd_fixed_size (channel_destroy, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY, - struct GNUNET_CADET_LocalChannelDestroyMessage, - h), - GNUNET_MQ_hd_var_size (local_data, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA, - struct GNUNET_CADET_LocalData, - h), - GNUNET_MQ_hd_fixed_size (local_ack, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK, - struct GNUNET_CADET_LocalAck, - h), - GNUNET_MQ_hd_var_size (get_peers, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS, - struct GNUNET_CADET_LocalInfoPeer, - h), - GNUNET_MQ_hd_var_size (get_peer, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER, - struct GNUNET_CADET_LocalInfoPeer, - h), - GNUNET_MQ_hd_var_size (get_tunnels, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS, - struct GNUNET_CADET_LocalInfoTunnel, - h), - GNUNET_MQ_hd_var_size (get_tunnel, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL, - struct GNUNET_CADET_LocalInfoTunnel, - h), -// FIXME -// GNUNET_MQ_hd_fixed_Y size (channel_destroyed, -// GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_NACK_DEPRECATED, -// struct GNUNET_CADET_ChannelDestroyMessage); - GNUNET_MQ_handler_end () - }; - struct GNUNET_CADET_Channel *ch; - - while (NULL != (ch = h->channels_head)) - { - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Destroying channel due to a reconnect\n"); - destroy_channel (ch); - } - - LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting to CADET\n"); - - if (NULL != h->mq) - { - GNUNET_MQ_destroy (h->mq); - h->mq = NULL; - } - h->mq = GNUNET_CLIENT_connect (h->cfg, - "cadet", - handlers, - &handle_mq_error, - h); - if (NULL == h->mq) - { - schedule_reconnect (h); - return; - } - else - { - h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS; - } -} - -/** - * Reconnect callback: tries to reconnect again after a failer previous - * reconnecttion - * - * @param cls closure (cadet handle) - */ -static void -reconnect_cbk (void *cls) -{ - struct GNUNET_CADET_Handle *h = cls; - - h->reconnect_task = NULL; - reconnect (h); -} - - -/** - * Reconnect to the service, retransmit all infomation to try to restore the - * original state. - * - * @param h handle to the cadet - * - * @return #GNUNET_YES in case of sucess, #GNUNET_NO otherwise (service down...) - */ -static void -schedule_reconnect (struct GNUNET_CADET_Handle *h) -{ - if (NULL == h->reconnect_task) - { - h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time, - &reconnect_cbk, h); - h->reconnect_time = GNUNET_TIME_STD_BACKOFF (h->reconnect_time); - } -} - - -/******************************************************************************/ -/********************** API CALL DEFINITIONS *************************/ -/******************************************************************************/ - -struct GNUNET_CADET_Handle * -GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, - void *cls, - GNUNET_CADET_ChannelEndHandler cleaner, - const struct GNUNET_CADET_MessageHandler *handlers) -{ - struct GNUNET_CADET_Handle *h; - - h = GNUNET_new (struct GNUNET_CADET_Handle); - LOG (GNUNET_ERROR_TYPE_DEBUG, - "GNUNET_CADET_connect() %p\n", - h); - h->cfg = cfg; - h->cleaner = cleaner; - h->ports = GNUNET_CONTAINER_multihashmap_create (4, GNUNET_YES); - reconnect (h); - if (h->mq == NULL) - { - GNUNET_break (0); - GNUNET_CADET_disconnect (h); - return NULL; - } - h->cls = cls; - h->message_handlers = handlers; - h->next_ccn.channel_of_client = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI); - h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS; - h->reconnect_task = NULL; - - /* count handlers */ - for (h->n_handlers = 0; - handlers && handlers[h->n_handlers].type; - h->n_handlers++) ; - return h; -} - - -/** - * Disconnect from the cadet service. All channels will be destroyed. All channel - * disconnect callbacks will be called on any still connected peers, notifying - * about their disconnection. The registered inbound channel cleaner will be - * called should any inbound channels still exist. - * - * @param handle connection to cadet to disconnect - */ -void -GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle) -{ - struct GNUNET_CADET_Channel *ch; - struct GNUNET_CADET_Channel *aux; - struct GNUNET_CADET_TransmitHandle *th; - - LOG (GNUNET_ERROR_TYPE_DEBUG, - "CADET DISCONNECT\n"); - ch = handle->channels_head; - while (NULL != ch) - { - aux = ch->next; - if (ntohl (ch->ccn.channel_of_client) >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI) - { - GNUNET_break (0); - LOG (GNUNET_ERROR_TYPE_DEBUG, - "channel %X not destroyed\n", - ntohl (ch->ccn.channel_of_client)); - } - destroy_channel (ch); - ch = aux; - } - while (NULL != (th = handle->th_head)) - { - struct GNUNET_MessageHeader *msg; - - /* Make sure it is an allowed packet (everything else should have been - * already canceled). - */ - GNUNET_break (GNUNET_NO == th_is_payload (th)); - msg = (struct GNUNET_MessageHeader *) &th[1]; - switch (ntohs(msg->type)) - { - case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN: - case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY: - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN: - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE: - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNELS: - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL: - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER: - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS: - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL: - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS: - break; - default: - GNUNET_break (0); - LOG (GNUNET_ERROR_TYPE_ERROR, "unexpected unsent msg %s\n", - GC_m2s (ntohs(msg->type))); - } - - GNUNET_CADET_notify_transmit_ready_cancel (th); - } - - if (NULL != handle->mq) - { - GNUNET_MQ_destroy (handle->mq); - handle->mq = NULL; - } - if (NULL != handle->reconnect_task) - { - GNUNET_SCHEDULER_cancel(handle->reconnect_task); - handle->reconnect_task = NULL; - } - - GNUNET_CONTAINER_multihashmap_destroy (handle->ports); - handle->ports = NULL; - GNUNET_free (handle); -} - - -/** - * Open a port to receive incomming channels. - * - * @param h CADET handle. - * @param port Hash representing the port number. - * @param new_channel Function called when an channel is received. - * @param new_channel_cls Closure for @a new_channel. - * @return Port handle. - */ -struct GNUNET_CADET_Port * -GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h, - const struct GNUNET_HashCode *port, - GNUNET_CADET_InboundChannelNotificationHandler - new_channel, - void *new_channel_cls) -{ - struct GNUNET_CADET_PortMessage *msg; - struct GNUNET_MQ_Envelope *env; - struct GNUNET_CADET_Port *p; - - GNUNET_assert (NULL != new_channel); - p = GNUNET_new (struct GNUNET_CADET_Port); - p->cadet = h; - p->hash = GNUNET_new (struct GNUNET_HashCode); - *p->hash = *port; - p->handler = new_channel; - p->cls = new_channel_cls; - GNUNET_assert (GNUNET_OK == - GNUNET_CONTAINER_multihashmap_put (h->ports, - p->hash, - p, - GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY)); - - env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN); - msg->port = *p->hash; - GNUNET_MQ_send (h->mq, env); - - return p; -} - -/** - * Close a port opened with @a GNUNET_CADET_open_port. - * The @a new_channel callback will no longer be called. - * - * @param p Port handle. - */ -void -GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p) -{ - struct GNUNET_CADET_PortMessage *msg; - struct GNUNET_MQ_Envelope *env; - struct GNUNET_HashCode *id; - - env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE); - - id = NULL != p->hash ? p->hash : &p->id; - msg->port = *id; - GNUNET_MQ_send (p->cadet->mq, env); - GNUNET_CONTAINER_multihashmap_remove (p->cadet->ports, id, p); - GNUNET_free_non_null (p->hash); - GNUNET_free (p); -} - - -/** - * Create a new channel towards a remote peer. - * - * If the destination port is not open by any peer or the destination peer - * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called - * for this channel. - * - * @param h cadet handle - * @param channel_ctx client's channel context to associate with the channel - * @param peer peer identity the channel should go to - * @param port Port hash (port number). - * @param options CadetOption flag field, with all desired option bits set to 1. - * @return handle to the channel - */ -struct GNUNET_CADET_Channel * -GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h, - void *channel_ctx, - const struct GNUNET_PeerIdentity *peer, - const struct GNUNET_HashCode *port, - enum GNUNET_CADET_ChannelOption options) -{ - struct GNUNET_CADET_LocalChannelCreateMessage *msg; - struct GNUNET_MQ_Envelope *env; - struct GNUNET_CADET_Channel *ch; - struct GNUNET_CADET_ClientChannelNumber ccn; - - ccn.channel_of_client = htonl (0); - ch = create_channel (h, ccn); - ch->ctx = channel_ctx; - ch->peer = GNUNET_PEER_intern (peer); - - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Creating new channel to %s:%u at %p number %X\n", - GNUNET_i2s (peer), - port, - ch, - ntohl (ch->ccn.channel_of_client)); - env = GNUNET_MQ_msg (msg, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE); - msg->ccn = ch->ccn; - msg->port = *port; - msg->peer = *peer; - msg->opt = htonl (options); - GNUNET_MQ_send (h->mq, - env); - return ch; -} - - -void -GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel) -{ - struct GNUNET_CADET_Handle *h; - struct GNUNET_CADET_LocalChannelDestroyMessage *msg; - struct GNUNET_MQ_Envelope *env; - struct GNUNET_CADET_TransmitHandle *th; - struct GNUNET_CADET_TransmitHandle *next; - - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Destroying channel\n"); - h = channel->cadet; - for (th = h->th_head; th != NULL; th = next) - { - next = th->next; - if (th->channel == channel) - { - GNUNET_break (0); - if (GNUNET_YES == th_is_payload (th)) - { - /* applications should cancel before destroying channel */ - LOG (GNUNET_ERROR_TYPE_WARNING, - "Channel destroyed without cancelling transmission requests\n"); - th->notify (th->notify_cls, 0, NULL); - } - else - { - LOG (GNUNET_ERROR_TYPE_WARNING, - "no meta-traffic should be queued\n"); - } - GNUNET_CONTAINER_DLL_remove (h->th_head, - h->th_tail, - th); - GNUNET_CADET_notify_transmit_ready_cancel (th); - } - } - - env = GNUNET_MQ_msg (msg, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY); - msg->ccn = channel->ccn; - GNUNET_MQ_send (h->mq, - env); - - destroy_channel (channel); -} - - -/** - * Get information about a channel. - * - * @param channel Channel handle. - * @param option Query (GNUNET_CADET_OPTION_*). - * @param ... dependant on option, currently not used - * - * @return Union with an answer to the query. - */ -const union GNUNET_CADET_ChannelInfo * -GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel, - enum GNUNET_CADET_ChannelOption option, ...) -{ - static int bool_flag; - const union GNUNET_CADET_ChannelInfo *ret; - - switch (option) - { - case GNUNET_CADET_OPTION_NOBUFFER: - case GNUNET_CADET_OPTION_RELIABLE: - case GNUNET_CADET_OPTION_OUT_OF_ORDER: - if (0 != (option & channel->options)) - bool_flag = GNUNET_YES; - else - bool_flag = GNUNET_NO; - ret = (const union GNUNET_CADET_ChannelInfo *) &bool_flag; - break; - case GNUNET_CADET_OPTION_PEER: - ret = (const union GNUNET_CADET_ChannelInfo *) GNUNET_PEER_resolve2 (channel->peer); - break; - default: - GNUNET_break (0); - return NULL; - } - - return ret; -} - - -struct GNUNET_CADET_TransmitHandle * -GNUNET_CADET_notify_transmit_ready (struct GNUNET_CADET_Channel *channel, - int cork, - struct GNUNET_TIME_Relative maxdelay, - size_t notify_size, - GNUNET_CONNECTION_TransmitReadyNotify notify, - void *notify_cls) -{ - struct GNUNET_CADET_TransmitHandle *th; - - GNUNET_assert (NULL != channel); - GNUNET_assert (NULL != notify); - GNUNET_assert (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE >= notify_size); - LOG (GNUNET_ERROR_TYPE_DEBUG, - "CADET NOTIFY TRANSMIT READY on channel %X allow_send is %u to %s with %u bytes\n", - ntohl (channel->ccn.channel_of_client), - channel->allow_send, - (ntohl (channel->ccn.channel_of_client) >= - GNUNET_CADET_LOCAL_CHANNEL_ID_CLI) - ? "origin" - : "destination", - (unsigned int) notify_size); - if (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us != maxdelay.rel_value_us) - { - LOG (GNUNET_ERROR_TYPE_WARNING, - "CADET transmit ready timeout is deprected (has no effect)\n"); - } - - th = GNUNET_new (struct GNUNET_CADET_TransmitHandle); - th->channel = channel; - th->size = notify_size; - th->notify = notify; - th->notify_cls = notify_cls; - if (0 != channel->allow_send) - th->request_data_task - = GNUNET_SCHEDULER_add_now (&request_data, - th); - else - add_to_queue (channel->cadet, - th); - return th; -} - - -void -GNUNET_CADET_notify_transmit_ready_cancel (struct GNUNET_CADET_TransmitHandle *th) -{ - if (NULL != th->request_data_task) - { - GNUNET_SCHEDULER_cancel (th->request_data_task); - th->request_data_task = NULL; - } - remove_from_queue (th); - GNUNET_free (th); -} - - -/** - * Send an ack on the channel to confirm the processing of a message. - * - * @param ch Channel on which to send the ACK. - */ -void -GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel) -{ - struct GNUNET_CADET_LocalAck *msg; - struct GNUNET_MQ_Envelope *env; - - env = GNUNET_MQ_msg (msg, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK); - LOG (GNUNET_ERROR_TYPE_DEBUG, - "Sending ACK on channel %X\n", - ntohl (channel->ccn.channel_of_client)); - msg->ccn = channel->ccn; - GNUNET_MQ_send (channel->cadet->mq, - env); -} - - -static void -send_info_request (struct GNUNET_CADET_Handle *h, uint16_t type) -{ - struct GNUNET_MessageHeader *msg; - struct GNUNET_MQ_Envelope *env; - - LOG (GNUNET_ERROR_TYPE_DEBUG, - " Sending %s monitor message to service\n", - GC_m2s(type)); - - env = GNUNET_MQ_msg (msg, type); - GNUNET_MQ_send (h->mq, env); -} - - -/** - * Request a debug dump on the service's STDERR. - * - * WARNING: unstable API, likely to change in the future! - * - * @param h cadet handle - */ -void -GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h) -{ - LOG (GNUNET_ERROR_TYPE_DEBUG, "requesting dump\n"); - send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP); -} - - -/** - * Request information about peers known to the running cadet service. - * The callback will be called for every peer known to the service. - * Only one info request (of any kind) can be active at once. - * - * - * WARNING: unstable API, likely to change in the future! - * - * @param h Handle to the cadet peer. - * @param callback Function to call with the requested data. - * @param callback_cls Closure for @c callback. - * - * @return #GNUNET_OK / #GNUNET_SYSERR - */ -int -GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h, - GNUNET_CADET_PeersCB callback, - void *callback_cls) -{ - if (NULL != h->info_cb.peers_cb) - { - GNUNET_break (0); - return GNUNET_SYSERR; - } - send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS); - h->info_cb.peers_cb = callback; - h->info_cls = callback_cls; - return GNUNET_OK; -} - - -/** - * Cancel a peer info request. The callback will not be called (anymore). - * - * WARNING: unstable API, likely to change in the future! - * - * @param h Cadet handle. - * - * @return Closure given to GNUNET_CADET_get_peers. - */ -void * -GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h) -{ - void *cls; - - cls = h->info_cls; - h->info_cb.peers_cb = NULL; - h->info_cls = NULL; - return cls; -} - - -/** - * Request information about a peer known to the running cadet peer. - * The callback will be called for the tunnel once. - * Only one info request (of any kind) can be active at once. - * - * WARNING: unstable API, likely to change in the future! - * - * @param h Handle to the cadet peer. - * @param id Peer whose tunnel to examine. - * @param callback Function to call with the requested data. - * @param callback_cls Closure for @c callback. - * - * @return #GNUNET_OK / #GNUNET_SYSERR - */ -int -GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h, - const struct GNUNET_PeerIdentity *id, - GNUNET_CADET_PeerCB callback, - void *callback_cls) -{ - struct GNUNET_CADET_LocalInfo *msg; - struct GNUNET_MQ_Envelope *env; - - if (NULL != h->info_cb.peer_cb) - { - GNUNET_break (0); - return GNUNET_SYSERR; - } - - env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER); - msg->peer = *id; - GNUNET_MQ_send (h->mq, env); - - h->info_cb.peer_cb = callback; - h->info_cls = callback_cls; - return GNUNET_OK; -} - - -/** - * Request information about tunnels of the running cadet peer. - * The callback will be called for every tunnel of the service. - * Only one info request (of any kind) can be active at once. - * - * WARNING: unstable API, likely to change in the future! - * - * @param h Handle to the cadet peer. - * @param callback Function to call with the requested data. - * @param callback_cls Closure for @c callback. - * - * @return #GNUNET_OK / #GNUNET_SYSERR - */ -int -GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h, - GNUNET_CADET_TunnelsCB callback, - void *callback_cls) -{ - if (NULL != h->info_cb.tunnels_cb) - { - GNUNET_break (0); - return GNUNET_SYSERR; - } - send_info_request (h, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS); - h->info_cb.tunnels_cb = callback; - h->info_cls = callback_cls; - return GNUNET_OK; -} - - -/** - * Cancel a monitor request. The monitor callback will not be called. - * - * @param h Cadet handle. - * - * @return Closure given to GNUNET_CADET_get_tunnels. - */ -void * -GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h) -{ - void *cls; - - h->info_cb.tunnels_cb = NULL; - cls = h->info_cls; - h->info_cls = NULL; - - return cls; -} - - - -/** - * Request information about a tunnel of the running cadet peer. - * The callback will be called for the tunnel once. - * Only one info request (of any kind) can be active at once. - * - * WARNING: unstable API, likely to change in the future! - * - * @param h Handle to the cadet peer. - * @param id Peer whose tunnel to examine. - * @param callback Function to call with the requested data. - * @param callback_cls Closure for @c callback. - * - * @return #GNUNET_OK / #GNUNET_SYSERR - */ -int -GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h, - const struct GNUNET_PeerIdentity *id, - GNUNET_CADET_TunnelCB callback, - void *callback_cls) -{ - struct GNUNET_CADET_LocalInfo *msg; - struct GNUNET_MQ_Envelope *env; - - if (NULL != h->info_cb.tunnel_cb) - { - GNUNET_break (0); - return GNUNET_SYSERR; - } - - env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL); - msg->peer = *id; - GNUNET_MQ_send (h->mq, env); - - h->info_cb.tunnel_cb = callback; - h->info_cls = callback_cls; - return GNUNET_OK; -} - - -/** - * Request information about a specific channel of the running cadet peer. - * - * WARNING: unstable API, likely to change in the future! - * FIXME Add destination option. - * - * @param h Handle to the cadet peer. - * @param initiator ID of the owner of the channel. - * @param channel_number Channel number. - * @param callback Function to call with the requested data. - * @param callback_cls Closure for @c callback. - * - * @return #GNUNET_OK / #GNUNET_SYSERR - */ -int -GNUNET_CADET_show_channel (struct GNUNET_CADET_Handle *h, - struct GNUNET_PeerIdentity *initiator, - unsigned int channel_number, - GNUNET_CADET_ChannelCB callback, - void *callback_cls) -{ - struct GNUNET_CADET_LocalInfo *msg; - struct GNUNET_MQ_Envelope *env; - - if (NULL != h->info_cb.channel_cb) - { - GNUNET_break (0); - return GNUNET_SYSERR; - } - - env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL); - msg->peer = *initiator; - msg->ccn.channel_of_client = htonl (channel_number); - GNUNET_MQ_send (h->mq, env); - - h->info_cb.channel_cb = callback; - h->info_cls = callback_cls; - return GNUNET_OK; -} - - -/** - * Function called to notify a client about the connection - * begin ready to queue more data. "buf" will be - * NULL and "size" zero if the connection was closed for - * writing in the meantime. - * - * @param cls closure - * @param size number of bytes available in buf - * @param buf where the callee should write the message - * @return number of bytes written to buf - */ -static size_t -cadet_mq_ntr (void *cls, size_t size, - void *buf) -{ - struct GNUNET_MQ_Handle *mq = cls; - struct CadetMQState *state = GNUNET_MQ_impl_state (mq); - const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq); - uint16_t msize; - - state->th = NULL; - if (NULL == buf) - { - GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_WRITE); - return 0; - } - msize = ntohs (msg->size); - GNUNET_assert (msize <= size); - GNUNET_memcpy (buf, msg, msize); - GNUNET_MQ_impl_send_continue (mq); - return msize; -} - - -/** - * Signature of functions implementing the - * sending functionality of a message queue. - * - * @param mq the message queue - * @param msg the message to send - * @param impl_state state of the implementation - */ -static void -cadet_mq_send_impl_old (struct GNUNET_MQ_Handle *mq, - const struct GNUNET_MessageHeader *msg, - void *impl_state) -{ - struct CadetMQState *state = impl_state; - - GNUNET_assert (NULL == state->th); - state->th = - GNUNET_CADET_notify_transmit_ready (state->channel, - /* FIXME: add option for corking */ - GNUNET_NO, - GNUNET_TIME_UNIT_FOREVER_REL, - ntohs (msg->size), - &cadet_mq_ntr, mq); - -} - - -/** - * Signature of functions implementing the - * destruction of a message queue. - * Implementations must not free 'mq', but should - * take care of 'impl_state'. - * - * @param mq the message queue to destroy - * @param impl_state state of the implementation - */ -static void -cadet_mq_destroy_impl_old (struct GNUNET_MQ_Handle *mq, - void *impl_state) -{ - struct CadetMQState *state = impl_state; - - if (NULL != state->th) - GNUNET_CADET_notify_transmit_ready_cancel (state->th); - - GNUNET_free (state); -} - - -/** - * Create a message queue for a cadet channel. - * The message queue can only be used to transmit messages, - * not to receive them. - * - * @param channel the channel to create the message qeue for - * @return a message queue to messages over the channel - */ -struct GNUNET_MQ_Handle * -GNUNET_CADET_mq_create (struct GNUNET_CADET_Channel *channel) -{ - struct GNUNET_MQ_Handle *mq; - struct CadetMQState *state; - - state = GNUNET_new (struct CadetMQState); - state->channel = channel; - - mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl_old, - &cadet_mq_destroy_impl_old, - NULL, /* FIXME: cancel impl. */ - state, - NULL, /* no msg handlers */ - NULL, /* no err handlers */ - NULL); /* no handler cls */ - return mq; -} - - -/** - * Transitional function to convert an unsigned int port to a hash value. - * WARNING: local static value returned, NOT reentrant! - * WARNING: do not use this function for new code! - * - * @param port Numerical port (unsigned int format). - * - * @return A GNUNET_HashCode usable for the new CADET API. - */ -const struct GNUNET_HashCode * -GC_u2h (uint32_t port) -{ - static struct GNUNET_HashCode hash; - - GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - "This is a transitional function, " - "use proper crypto hashes as CADET ports\n"); - GNUNET_CRYPTO_hash (&port, sizeof (port), &hash); - - return &hash; -} - - - -/******************************************************************************/ -/******************************* MQ-BASED API *********************************/ -/******************************************************************************/ - -/** - * Connect to the MQ-based cadet service. - * - * @param cfg Configuration to use. - * - * @return Handle to the cadet service NULL on error. - */ -struct GNUNET_CADET_Handle * -GNUNET_CADET_connecT (const struct GNUNET_CONFIGURATION_Handle *cfg) -{ - struct GNUNET_CADET_Handle *h; - - LOG (GNUNET_ERROR_TYPE_DEBUG, - "GNUNET_CADET_connecT()\n"); - h = GNUNET_new (struct GNUNET_CADET_Handle); - h->cfg = cfg; - h->mq_api = GNUNET_YES; - h->ports = GNUNET_CONTAINER_multihashmap_create (4, GNUNET_YES); - reconnect (h); - if (NULL == h->mq) - { - GNUNET_break (0); - GNUNET_CADET_disconnect (h); - return NULL; - } - h->next_ccn.channel_of_client = htonl (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI); - h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS; - h->reconnect_task = NULL; - - return h; -} - - -/** - * Open a port to receive incomming MQ-based channels. - * - * @param h CADET handle. - * @param port Hash identifying the port. - * @param connects Function called when an incoming channel is connected. - * @param connects_cls Closure for the @a connects handler. - * @param window_changes Function called when the transmit window size changes. - * @param disconnects Function called when a channel is disconnected. - * @param handlers Callbacks for messages we care about, NULL-terminated. - * - * @return Port handle. - */ -struct GNUNET_CADET_Port * -GNUNET_CADET_open_porT (struct GNUNET_CADET_Handle *h, - const struct GNUNET_HashCode *port, - GNUNET_CADET_ConnectEventHandler connects, - void * connects_cls, - GNUNET_CADET_WindowSizeEventHandler window_changes, - GNUNET_CADET_DisconnectEventHandler disconnects, - const struct GNUNET_MQ_MessageHandler *handlers) -{ - struct GNUNET_CADET_PortMessage *msg; - struct GNUNET_MQ_Envelope *env; - struct GNUNET_CADET_Port *p; - - GNUNET_assert (NULL != connects); - GNUNET_assert (NULL != disconnects); - - p = GNUNET_new (struct GNUNET_CADET_Port); - p->cadet = h; - p->id = *port; - p->connects = connects; - p->cls = connects_cls; - p->window_changes = window_changes; - p->disconnects = disconnects; - if (NULL != handlers) - { - unsigned int i; - for (i=0;NULL != handlers[i].cb; i++) ; - p->handlers = GNUNET_new_array (i + 1, - struct GNUNET_MQ_MessageHandler); - GNUNET_memcpy ((struct GNUNET_MQ_MessageHandler *) p->handlers, - handlers, - i * sizeof (struct GNUNET_MQ_MessageHandler)); - } - - GNUNET_assert (GNUNET_OK == - GNUNET_CONTAINER_multihashmap_put (h->ports, - &p->id, - p, - GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY)); - - env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN); - msg->port = p->id; - GNUNET_MQ_send (h->mq, env); - - return p; -} - - -/** - * Create a new channel towards a remote peer. - * - * If the destination port is not open by any peer or the destination peer - * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called - * for this channel. - * - * @param h CADET handle. - * @param channel_cls Closure for the channel. It's given to: - * - The disconnect handler @a disconnects - * - Each message type callback in @a handlers - * @param destination Peer identity the channel should go to. - * @param port Identification of the destination port. - * @param options CadetOption flag field, with all desired option bits set to 1. - * @param window_changes Function called when the transmit window size changes. - * @param disconnects Function called when the channel is disconnected. - * @param handlers Callbacks for messages we care about, NULL-terminated. - * - * @return Handle to the channel. - */ -struct GNUNET_CADET_Channel * -GNUNET_CADET_channel_creatE (struct GNUNET_CADET_Handle *h, - void *channel_cls, - const struct GNUNET_PeerIdentity *destination, - const struct GNUNET_HashCode *port, - enum GNUNET_CADET_ChannelOption options, - GNUNET_CADET_WindowSizeEventHandler window_changes, - GNUNET_CADET_DisconnectEventHandler disconnects, - const struct GNUNET_MQ_MessageHandler *handlers) -{ - struct GNUNET_CADET_Channel *ch; - struct GNUNET_CADET_ClientChannelNumber ccn; - struct GNUNET_CADET_LocalChannelCreateMessage *msg; - struct GNUNET_MQ_Envelope *env; - - GNUNET_assert (NULL != disconnects); - - /* Save parameters */ - ccn.channel_of_client = htonl (0); - ch = create_channel (h, ccn); - ch->ctx = channel_cls; - ch->peer = GNUNET_PEER_intern (destination); - ch->options = options; - ch->window_changes = window_changes; - ch->disconnects = disconnects; - - /* Create MQ for channel */ - ch->mq = GNUNET_MQ_queue_for_callbacks (&cadet_mq_send_impl, - &cadet_mq_destroy_impl, - &cadet_mq_cancel_impl, - ch, - handlers, - &cadet_mq_error_handler, - ch); - GNUNET_MQ_set_handlers_closure (ch->mq, channel_cls); - - /* Request channel creation to service */ - env = GNUNET_MQ_msg (msg, - GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE); - msg->ccn = ch->ccn; - msg->port = *port; - msg->peer = *destination; - msg->opt = htonl (options); - GNUNET_MQ_send (h->mq, - env); - - return ch; -} - - -/** - * Obtain the message queue for a connected peer. - * - * @param channel The channel handle from which to get the MQ. - * - * @return NULL if @a channel is not yet connected. - */ -struct GNUNET_MQ_Handle * -GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel) -{ - return channel->mq; -} diff --git a/src/cadet/cadet_api_new.c b/src/cadet/cadet_api_new.c index 2d5d853b3..c9f2a11bb 100644 --- a/src/cadet/cadet_api_new.c +++ b/src/cadet/cadet_api_new.c @@ -206,11 +206,6 @@ struct GNUNET_CADET_Port */ struct GNUNET_CADET_Handle *cadet; - /** - * Callback handler for incoming channels on this port. - */ - GNUNET_CADET_InboundChannelNotificationHandler *handler; - /** * Closure for @a handler. */ diff --git a/src/cadet/cadet_common.c b/src/cadet/cadet_common.c deleted file mode 100644 index 95a3144e4..000000000 --- a/src/cadet/cadet_common.c +++ /dev/null @@ -1,370 +0,0 @@ -/* - This file is part of GNUnet. - Copyright (C) 2012 GNUnet e.V. - - GNUnet is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 3, or (at your - option) any later version. - - GNUnet is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. -*/ - -/** - * @file cadet/cadet_common.c - * @brief CADET helper functions - * @author Bartlomiej Polot - */ - -#include "cadet.h" - -/** - * @brief Translate a fwd variable into a string representation, for logging. - * - * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO) - * - * @return String representing FWD or BCK. - */ -char * -GC_f2s (int fwd) -{ - if (GNUNET_YES == fwd) - { - return "FWD"; - } - else if (GNUNET_NO == fwd) - { - return "BCK"; - } - else - { - /* Not an error, can happen with CONNECTION_BROKEN messages. */ - return "\???"; - } -} - - -/** - * Test if @a bigger is larger than @a smaller. - * Considers the case that @a bigger just overflowed - * and is thus tiny while @a smaller is still below - * `UINT32_MAX`. - */ -int -GC_is_pid_bigger (uint32_t bigger, - uint32_t smaller) -{ - return (PID_OVERFLOW (smaller, bigger) || - ( (bigger > smaller) && - (! PID_OVERFLOW (bigger, smaller))) ); -} - - -uint32_t -GC_max_pid (uint32_t a, uint32_t b) -{ - if (GC_is_pid_bigger(a, b)) - return a; - return b; -} - - -uint32_t -GC_min_pid (uint32_t a, uint32_t b) -{ - if (GC_is_pid_bigger(a, b)) - return b; - return a; -} - - -/** - * Allocate a string with a hexdump of any binary data. - * - * @param bin Arbitrary binary data. - * @param len Length of @a bin in bytes. - * @param output Where to write the output (if *output be NULL it's allocated). - * - * @return The size of the output. - */ -size_t -GC_bin2s (void *bin, unsigned int len, char **output) -{ - char *data = bin; - char *buf; - unsigned int s_len; - unsigned int i; - - s_len = 2 * len + 1; - if (NULL == *output) - *output = GNUNET_malloc (s_len); - buf = *output; - - for (i = 0; i < len; i++) - { - SPRINTF (&buf[2 * i], "%2X", data[i]); - } - buf[s_len - 1] = '\0'; - - return s_len; -} - - -#if !defined(GNUNET_CULL_LOGGING) -const char * -GC_m2s (uint16_t m) -{ - static char buf[2][16]; - static int idx; - const char *s; - - idx = (idx + 1) % 2; - switch (m) - { - /** - * Used to mark the "payload" of a non-payload message. - */ - case 0: - s = "retransmit"; - break; - - /** - * Request the creation of a path - */ - case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE: - s = "CONN_CREAT"; - break; - - /** - * Request the modification of an existing path - */ - case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE_ACK: - s = "CONN_ACK"; - break; - - /** - * Notify that a connection of a path is no longer valid - */ - case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN: - s = "CONN_BRKN"; - break; - - /** - * At some point, the route will spontaneously change - */ - case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_PATH_CHANGED_UNIMPLEMENTED: - s = "PATH_CHNGD"; - break; - - /** - * Transport payload data. - */ - case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_APP_DATA: - s = "DATA"; - break; - - /** - * Confirm receipt of payload data. - */ - case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_APP_DATA_ACK: - s = "DATA_ACK"; - break; - - /** - * Key exchange message. - */ - case GNUNET_MESSAGE_TYPE_CADET_TUNNEL_KX: - s = "KX"; - break; - - /** - * Encrypted. - */ - case GNUNET_MESSAGE_TYPE_CADET_TUNNEL_ENCRYPTED: - s = "ENCRYPTED"; - break; - - /** - * Request the destuction of a path - */ - case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY: - s = "CONN_DSTRY"; - break; - - /** - * ACK for a data packet. - */ - case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_HOP_BY_HOP_ENCRYPTED_ACK: - s = "ACK"; - break; - - /** - * POLL for ACK. - */ - case GNUNET_MESSAGE_TYPE_CADET_TUNNEL_ENCRYPTED_POLL: - s = "POLL"; - break; - - /** - * Announce origin is still alive. - */ - case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_KEEPALIVE: - s = "KEEPALIVE"; - break; - - /** - * Open port - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN: - s = "OPEN_PORT"; - break; - - /** - * Close port - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE: - s = "CLOSE_PORT"; - break; - - /** - * Ask the cadet service to create a new tunnel - */ - case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN: - s = "CHAN_CREAT"; - break; - - /** - * Ask the cadet service to destroy a tunnel - */ - case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY: - s = "CHAN_DSTRY"; - break; - - /** - * Confirm the creation of a channel. - */ - case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_ACK: - s = "CHAN_ACK"; - break; - - /** - * Confirm the creation of a channel. - */ - case GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_NACK_DEPRECATED: - s = "CHAN_NACK"; - break; - - /** - * Local payload traffic - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA: - s = "LOC_DATA"; - break; - - /** - * Local ACK for data. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK: - s = "LOC_ACK"; - break; - - /** - * Local monitoring of channels. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNELS: - s = "INFO_CHANS"; - break; - - /** - * Local monitoring of a channel. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL: - s = "INFO_CHAN"; - break; - - /** - * Local monitoring of service. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS: - s = "INFO_TUNS"; - break; - - /** - * Local monitoring of service. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL: - s = "INFO_TUN"; - break; - - /** - * Local information about all connections of service. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CONNECTIONS: - s = "INFO_CONNS"; - break; - - /** - * Local information of service about a specific connection. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CONNECTION: - s = "INFO_CONN"; - break; - - /** - * Local information about all peers known to the service. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS: - s = "INFO_PEERS"; - break; - - /** - * Local information of service about a specific peer. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER: - s = "INFO_PEER"; - break; - - /** - * Traffic (net-cat style) used by the Command Line Interface. - */ - case GNUNET_MESSAGE_TYPE_CADET_CLI: - s = "CLI"; - break; - - /** - * Debug request. - */ - case GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP: - s = "INFO_DUMP"; - break; - - /** - * Used to mark the "payload" of a non-payload message. - */ - case UINT16_MAX: - s = " N/A"; - break; - - - default: - SPRINTF (buf[idx], "{UNK: %5u}", m); - return buf[idx]; - } - SPRINTF (buf[idx], "{%10s}", s); - return buf[idx]; -} -#else -const char * -GC_m2s (uint16_t m) -{ - return ""; -} -#endif diff --git a/src/include/gnunet_cadet_service.h b/src/include/gnunet_cadet_service.h index fd838df8d..8d3d4326b 100644 --- a/src/include/gnunet_cadet_service.h +++ b/src/include/gnunet_cadet_service.h @@ -49,7 +49,7 @@ extern "C" /** * Version number of GNUnet-cadet API. */ -#define GNUNET_CADET_VERSION 0x00000004 +#define GNUNET_CADET_VERSION 0x00000005 /** @@ -68,6 +68,33 @@ struct GNUNET_CADET_Channel; struct GNUNET_CADET_Port; +/** + * Hash uniquely identifying a connection below a tunnel. + */ +struct GNUNET_CADET_ConnectionTunnelIdentifier +{ + struct GNUNET_ShortHashCode connection_of_tunnel; +}; + + +/** + * Number identifying a CADET channel within a tunnel. + */ +struct GNUNET_CADET_ChannelTunnelNumber +{ + /** + * Which number does this channel have that uniquely identfies + * it within its tunnel, in network byte order. + * + * Given two peers, both may initiate channels over the same tunnel. + * The @e cn must be greater or equal to 0x80000000 (high-bit set) + * for tunnels initiated with the peer that has the larger peer + * identity as compared using #GNUNET_CRYPTO_cmp_peer_identity(). + */ + uint32_t cn GNUNET_PACKED; +}; + + /** * Channel options. Second line indicates filed in the * CadetChannelInfo union carrying the answer. @@ -108,118 +135,67 @@ enum GNUNET_CADET_ChannelOption /** - * Functions with this signature are called whenever a message is - * received. - * - * Each time the function must call #GNUNET_CADET_receive_done on the channel - * in order to receive the next message. This doesn't need to be immediate: - * can be delayed if some processing is done on the message. + * Method called whenever a peer connects to a port in MQ-based CADET. * - * @param cls Closure (set from #GNUNET_CADET_connect). - * @param channel Connection to the other end. - * @param channel_ctx Place to store local state associated with the channel. - * @param message The actual message. - * @return #GNUNET_OK to keep the channel open, - * #GNUNET_SYSERR to close it (signal serious error). - */ -typedef int -(*GNUNET_CADET_MessageCallback) (void *cls, - struct GNUNET_CADET_Channel *channel, - void **channel_ctx, - const struct GNUNET_MessageHeader *message); - - -/** - * Message handler. Each struct specifies how to handle on particular - * type of message received. + * @param cls Closure from #GNUNET_CADET_open_porT. + * @param channel New handle to the channel. + * @param source Peer that started this channel. + * @return Closure for the incoming @a channel. It's given to: + * - The #GNUNET_CADET_DisconnectEventHandler (given to + * #GNUNET_CADET_open_porT) when the channel dies. + * - Each the #GNUNET_MQ_MessageCallback handlers for each message + * received on the @a channel. */ -struct GNUNET_CADET_MessageHandler -{ - /** - * Function to call for messages of type @e type. - */ - GNUNET_CADET_MessageCallback callback; - - /** - * Type of the message this handler covers. - */ - uint16_t type; - - /** - * Expected size of messages of this type. Use 0 for variable-size. - * If non-zero, messages of the given type will be discarded if they - * do not have the right size. - */ - uint16_t expected_size; -}; +typedef void * +(*GNUNET_CADET_ConnectEventHandler) (void *cls, + struct GNUNET_CADET_Channel *channel, + const struct GNUNET_PeerIdentity *source); /** - * Method called whenever another peer has added us to a channel - * the other peer initiated. - * Only called (once) upon reception of data with a message type which was - * subscribed to in #GNUNET_CADET_connect. - * - * A call to #GNUNET_CADET_channel_destroy causes te channel to be ignored. In - * this case the handler MUST return NULL. + * Function called whenever an MQ-channel is destroyed, even if the destruction + * was requested by #GNUNET_CADET_channel_destroy. + * It must NOT call #GNUNET_CADET_channel_destroy on the channel. * - * @param cls closure - * @param channel new handle to the channel - * @param initiator peer that started the channel - * @param port Port this channel is for. - * @param options CadetOption flag field, with all active option bits set to 1. + * It should clean up any associated state, including cancelling any pending + * transmission on this channel. * - * @return initial channel context for the channel - * (can be NULL -- that's not an error) + * @param cls Channel closure. + * @param channel Connection to the other end (henceforth invalid). */ -typedef void * -(GNUNET_CADET_InboundChannelNotificationHandler) (void *cls, - struct GNUNET_CADET_Channel *channel, - const struct GNUNET_PeerIdentity *initiator, - const struct GNUNET_HashCode *port, - enum GNUNET_CADET_ChannelOption options); +typedef void +(*GNUNET_CADET_DisconnectEventHandler) (void *cls, + const struct GNUNET_CADET_Channel *channel); /** - * Function called whenever a channel is destroyed. Should clean up - * any associated state, including cancelling any pending transmission on this - * channel. + * Function called whenever an MQ-channel's transmission window size changes. * - * It must NOT call #GNUNET_CADET_channel_destroy on the channel. + * The first callback in an outgoing channel will be with a non-zero value + * and will mean the channel is connected to the destination. + * + * For an incoming channel it will be called immediately after the + * #GNUNET_CADET_ConnectEventHandler, also with a non-zero value. * - * @param cls closure (set from #GNUNET_CADET_connect) - * @param channel connection to the other end (henceforth invalid) - * @param channel_ctx place where local state associated - * with the channel is stored + * @param cls Channel closure. + * @param channel Connection to the other end --- FIXME: drop? + * @param window_size New window size. If the is more messages than buffer size + * this value will be negative. -- FIXME: make unsigned, we never call negative? */ typedef void -(GNUNET_CADET_ChannelEndHandler) (void *cls, - const struct GNUNET_CADET_Channel *channel, - void *channel_ctx); +(*GNUNET_CADET_WindowSizeEventHandler) (void *cls, + const struct GNUNET_CADET_Channel *channel, + int window_size); /** - * Connect to the cadet service. + * Connect to the MQ-based cadet service. * * @param cfg Configuration to use. - * @param cls Closure for the various callbacks that follow (including - * handlers in the handlers array). - * @param cleaner Function called when a channel is destroyed. - * It is called immediately if #GNUNET_CADET_channel_destroy - * is called on the channel. - * @param handlers Callbacks for messages we care about, NULL-terminated. Each - * one must call #GNUNET_CADET_receive_done on the channel to - * receive the next message. Messages of a type that is not - * in the handlers array are ignored if received. - * - * @return handle to the cadet service NULL on error - * (in this case, init is never called) + * @return Handle to the cadet service NULL on error. */ struct GNUNET_CADET_Handle * -GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, - void *cls, - GNUNET_CADET_ChannelEndHandler cleaner, - const struct GNUNET_CADET_MessageHandler *handlers); +GNUNET_CADET_connecT (const struct GNUNET_CONFIGURATION_Handle *cfg); /** @@ -233,21 +209,29 @@ GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle); + /** - * Open a port to receive incomming channels. + * Open a port to receive incomming MQ-based channels. * * @param h CADET handle. - * @param port Hash representing the port number. - * @param new_channel Function called when an channel is received. - * @param new_channel_cls Closure for @a new_channel. - * + * @param port Hash identifying the port. + * @param connects Function called when an incoming channel is connected. + * @param connects_cls Closure for the @a connects handler. + * @param window_changes Function called when the transmit window size changes. + * Can be NULL. + * @param disconnects Function called when a channel is disconnected. + * @param handlers Callbacks for messages we care about, NULL-terminated. * @return Port handle. */ struct GNUNET_CADET_Port * -GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h, - const struct GNUNET_HashCode *port, - GNUNET_CADET_InboundChannelNotificationHandler new_channel, - void *new_channel_cls); +GNUNET_CADET_open_porT (struct GNUNET_CADET_Handle *h, + const struct GNUNET_HashCode *port, + GNUNET_CADET_ConnectEventHandler connects, + void *connects_cls, + GNUNET_CADET_WindowSizeEventHandler window_changes, + GNUNET_CADET_DisconnectEventHandler disconnects, + const struct GNUNET_MQ_MessageHandler *handlers); + /** * Close a port opened with @a GNUNET_CADET_open_port. @@ -258,27 +242,38 @@ GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h, void GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p); + /** * Create a new channel towards a remote peer. * * If the destination port is not open by any peer or the destination peer - * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called + * does not accept the channel, @a disconnects will be called * for this channel. * - * @param h cadet handle - * @param channel_ctx client's channel context to associate with the channel - * @param peer peer identity the channel should go to - * @param port Port hash (port number). + * @param h CADET handle. + * @param channel_cls Closure for the channel. It's given to: + * - The management handler @a window_changes. + * - The disconnect handler @a disconnects + * - Each message type callback in @a handlers + * @param destination Peer identity the channel should go to. + * @param port Identification of the destination port. * @param options CadetOption flag field, with all desired option bits set to 1. - * - * @return handle to the channel + * @param window_changes Function called when the transmit window size changes. + * Can be NULL if this data is of no interest. + * TODO Not yet implemented. + * @param disconnects Function called when the channel is disconnected. + * @param handlers Callbacks for messages we care about, NULL-terminated. + * @return Handle to the channel. */ struct GNUNET_CADET_Channel * -GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h, - void *channel_ctx, - const struct GNUNET_PeerIdentity *peer, - const struct GNUNET_HashCode *port, - enum GNUNET_CADET_ChannelOption options); +GNUNET_CADET_channel_creatE (struct GNUNET_CADET_Handle *h, + void *channel_cls, + const struct GNUNET_PeerIdentity *destination, + const struct GNUNET_HashCode *port, + enum GNUNET_CADET_ChannelOption options, + GNUNET_CADET_WindowSizeEventHandler window_changes, + GNUNET_CADET_DisconnectEventHandler disconnects, + const struct GNUNET_MQ_MessageHandler *handlers); /** @@ -294,6 +289,52 @@ void GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel); +/** + * Obtain the message queue for a connected channel. + * + * @param channel The channel handle from which to get the MQ. + * @return The message queue of the channel. + */ +struct GNUNET_MQ_Handle * +GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel); + + +/** + * Indicate readiness to receive the next message on a channel. + * + * Should only be called once per handler called. + * + * @param channel Channel that will be allowed to call another handler. + */ +void +GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel); + + +/******************************************************************************/ +/******************** MONITORING /DEBUG API *************************/ +/******************************************************************************/ +/* The following calls are not useful for normal CADET operation, but for */ +/* debug and monitoring of the cadet state. They can be safely ignored. */ +/* The API can change at any point without notice. */ +/* Please contact the developer if you consider any of this calls useful for */ +/* normal cadet applications. */ +/******************************************************************************/ + + +/** + * Transitional function to convert an unsigned int port to a hash value. + * WARNING: local static value returned, NOT reentrant! + * WARNING: do not use this function for new code! + * + * @param port Numerical port (unsigned int format). + * + * @return A GNUNET_HashCode usable for the new CADET API. + */ +const struct GNUNET_HashCode * +GC_u2h (uint32_t port); + + + /** * Struct to retrieve info about a channel. */ @@ -326,76 +367,6 @@ GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel, ...); -/** - * Handle for a transmission request. - */ -struct GNUNET_CADET_TransmitHandle; - - -/** - * Ask the cadet to call @a notify once it is ready to transmit the - * given number of bytes to the specified channel. - * Only one call can be active at any time, to issue another request, - * wait for the callback or cancel the current request. - * - * @param channel channel to use for transmission - * @param cork is corking allowed for this transmission? - * @param maxdelay how long can the message wait? - * @param notify_size how many bytes of buffer space does notify want? - * @param notify function to call when buffer space is available; - * will be called with NULL on timeout or if the overall queue - * for this peer is larger than queue_size and this is currently - * the message with the lowest priority - * @param notify_cls closure for @a notify - * @return non-NULL if the notify callback was queued, - * NULL if we can not even queue the request (insufficient - * memory); if NULL is returned, @a notify will NOT be called. - */ -struct GNUNET_CADET_TransmitHandle * -GNUNET_CADET_notify_transmit_ready (struct GNUNET_CADET_Channel *channel, - int cork, - struct GNUNET_TIME_Relative maxdelay, - size_t notify_size, - GNUNET_CONNECTION_TransmitReadyNotify notify, - void *notify_cls); - - -/** - * Cancel the specified transmission-ready notification. - * - * #DEPRECATED - * Since soon we will send immediately with mq (via request_data), - * there will be time or need to cancel a "pending" transmission. - * - * @param th handle that was returned by "notify_transmit_ready". - */ -void -GNUNET_CADET_notify_transmit_ready_cancel (struct GNUNET_CADET_TransmitHandle *th); - - -/** - * Indicate readiness to receive the next message on a channel. - * - * Should only be called once per handler called. - * - * @param channel Channel that will be allowed to call another handler. - */ -void -GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel); - - - -/******************************************************************************/ -/******************** MONITORING /DEBUG API *************************/ -/******************************************************************************/ -/* The following calls are not useful for normal CADET operation, but for */ -/* debug and monitoring of the cadet state. They can be safely ignored. */ -/* The API can change at any point without notice. */ -/* Please contact the developer if you consider any of this calls useful for */ -/* normal cadet applications. */ -/******************************************************************************/ - - /** * Method called to retrieve information about a specific channel the cadet peer * is aware of, including all transit nodes. @@ -481,33 +452,6 @@ typedef void uint16_t cstate); -/** - * Hash uniquely identifying a connection below a tunnel. - */ -struct GNUNET_CADET_ConnectionTunnelIdentifier -{ - struct GNUNET_ShortHashCode connection_of_tunnel; -}; - - -/** - * Number identifying a CADET channel within a tunnel. - */ -struct GNUNET_CADET_ChannelTunnelNumber -{ - /** - * Which number does this channel have that uniquely identfies - * it within its tunnel, in network byte order. - * - * Given two peers, both may initiate channels over the same tunnel. - * The @e cn must be greater or equal to 0x80000000 (high-bit set) - * for tunnels initiated with the peer that has the larger peer - * identity as compared using #GNUNET_CRYPTO_cmp_peer_identity(). - */ - uint32_t cn GNUNET_PACKED; -}; - - /** * Method called to retrieve information about a specific tunnel the cadet peer * has established, o`r is trying to establish. @@ -667,169 +611,6 @@ GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h, void *callback_cls); -/** - * Create a message queue for a cadet channel. - * The message queue can only be used to transmit messages, - * not to receive them. - * - * @param channel the channel to create the message qeue for - * @return a message queue to messages over the channel - */ -struct GNUNET_MQ_Handle * -GNUNET_CADET_mq_create (struct GNUNET_CADET_Channel *channel); - - -/** - * Transitional function to convert an unsigned int port to a hash value. - * WARNING: local static value returned, NOT reentrant! - * WARNING: do not use this function for new code! - * - * @param port Numerical port (unsigned int format). - * - * @return A GNUNET_HashCode usable for the new CADET API. - */ -const struct GNUNET_HashCode * -GC_u2h (uint32_t port); - - -/******************************************************************************/ -/******************************* MQ-BASED API *********************************/ -/******************************************************************************/ - -/** - * Method called whenever a peer connects to a port in MQ-based CADET. - * - * @param cls Closure from #GNUNET_CADET_open_porT. - * @param channel New handle to the channel. - * @param source Peer that started this channel. - * @return Closure for the incoming @a channel. It's given to: - * - The #GNUNET_CADET_DisconnectEventHandler (given to - * #GNUNET_CADET_open_porT) when the channel dies. - * - Each the #GNUNET_MQ_MessageCallback handlers for each message - * received on the @a channel. - */ -typedef void * -(*GNUNET_CADET_ConnectEventHandler) (void *cls, - struct GNUNET_CADET_Channel *channel, - const struct GNUNET_PeerIdentity *source); - - -/** - * Function called whenever an MQ-channel is destroyed, even if the destruction - * was requested by #GNUNET_CADET_channel_destroy. - * It must NOT call #GNUNET_CADET_channel_destroy on the channel. - * - * It should clean up any associated state, including cancelling any pending - * transmission on this channel. - * - * @param cls Channel closure. - * @param channel Connection to the other end (henceforth invalid). - */ -typedef void -(*GNUNET_CADET_DisconnectEventHandler) (void *cls, - const struct GNUNET_CADET_Channel *channel); - - -/** - * Function called whenever an MQ-channel's transmission window size changes. - * - * The first callback in an outgoing channel will be with a non-zero value - * and will mean the channel is connected to the destination. - * - * For an incoming channel it will be called immediately after the - * #GNUNET_CADET_ConnectEventHandler, also with a non-zero value. - * - * @param cls Channel closure. - * @param channel Connection to the other end --- FIXME: drop? - * @param window_size New window size. If the is more messages than buffer size - * this value will be negative. -- FIXME: make unsigned, we never call negative? - */ -typedef void -(*GNUNET_CADET_WindowSizeEventHandler) (void *cls, - const struct GNUNET_CADET_Channel *channel, - int window_size); - - -/** - * Connect to the MQ-based cadet service. - * - * @param cfg Configuration to use. - * @return Handle to the cadet service NULL on error. - */ -struct GNUNET_CADET_Handle * -GNUNET_CADET_connecT (const struct GNUNET_CONFIGURATION_Handle *cfg); - - -/** - * Open a port to receive incomming MQ-based channels. - * - * @param h CADET handle. - * @param port Hash identifying the port. - * @param connects Function called when an incoming channel is connected. - * @param connects_cls Closure for the @a connects handler. - * @param window_changes Function called when the transmit window size changes. - * Can be NULL. - * @param disconnects Function called when a channel is disconnected. - * @param handlers Callbacks for messages we care about, NULL-terminated. - * @return Port handle. - */ -struct GNUNET_CADET_Port * -GNUNET_CADET_open_porT (struct GNUNET_CADET_Handle *h, - const struct GNUNET_HashCode *port, - GNUNET_CADET_ConnectEventHandler connects, - void *connects_cls, - GNUNET_CADET_WindowSizeEventHandler window_changes, - GNUNET_CADET_DisconnectEventHandler disconnects, - const struct GNUNET_MQ_MessageHandler *handlers); - -/** - * Create a new channel towards a remote peer. - * - * If the destination port is not open by any peer or the destination peer - * does not accept the channel, #GNUNET_CADET_ChannelEndHandler will be called - * for this channel. - * - * @param h CADET handle. - * @param channel_cls Closure for the channel. It's given to: - * - The management handler @a window_changes. - * - The disconnect handler @a disconnects - * - Each message type callback in @a handlers - * @param destination Peer identity the channel should go to. - * @param port Identification of the destination port. - * @param options CadetOption flag field, with all desired option bits set to 1. - * @param window_changes Function called when the transmit window size changes. - * Can be NULL if this data is of no interest. - * TODO Not yet implemented. - * @param disconnects Function called when the channel is disconnected. - * @param handlers Callbacks for messages we care about, NULL-terminated. - * @return Handle to the channel. - */ -struct GNUNET_CADET_Channel * -GNUNET_CADET_channel_creatE (struct GNUNET_CADET_Handle *h, - void *channel_cls, - const struct GNUNET_PeerIdentity *destination, - const struct GNUNET_HashCode *port, - enum GNUNET_CADET_ChannelOption options, - GNUNET_CADET_WindowSizeEventHandler window_changes, - GNUNET_CADET_DisconnectEventHandler disconnects, - const struct GNUNET_MQ_MessageHandler *handlers); - - -/** - * Obtain the message queue for a connected channel. - * - * @param channel The channel handle from which to get the MQ. - * @return The message queue of the channel. - */ -struct GNUNET_MQ_Handle * -GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel); - - -/******************************************************************************/ -/******************************* MQ-BASED API *********************************/ -/******************************************************************************/ - - #if 0 /* keep Emacsens' auto-indent happy */ { -- 2.25.1