/*
This file is part of GNUnet.
Copyright (C) 2001 - 2011 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @author Bartlomiej Polot
* @file cadet/cadet.h
*/
#ifndef CADET_H_
#define CADET_H_
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include
#if ! defined(GNUNET_CULL_LOGGING)
#define CADET_TIMING_START \
struct GNUNET_TIME_Absolute __timestamp; \
__timestamp = GNUNET_TIME_absolute_get ()
#define CADET_TIMING_END \
struct GNUNET_TIME_Relative __duration; \
__duration = GNUNET_TIME_absolute_get_duration (__timestamp); \
LOG (GNUNET_ERROR_TYPE_INFO, \
" %s duration %s\n", \
__FUNCTION__, \
GNUNET_STRINGS_relative_time_to_string (__duration, GNUNET_YES));
#else
#define CADET_TIMING_START
#define CADET_TIMING_END
#endif
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_peer_lib.h"
#include "gnunet_core_service.h"
#include "gnunet_cadet_service.h"
#include "gnunet_protocols.h"
#include "gnunet_cadet_service.h"
/******************************************************************************/
/************************** CONSTANTS ******************************/
/******************************************************************************/
/**
* Minimum value for channel IDs of local clients.
*/
#define GNUNET_CADET_LOCAL_CHANNEL_ID_CLI 0x80000000U
/**
* FIXME.
*/
#define HIGH_PID 0xFF000000
/**
* FIXME.
*/
#define LOW_PID 0x00FFFFFF
/**
* Test if the two PIDs (of type `uint32_t`) are in the range where we
* have to worry about overflows. This is the case when @a pid is
* large and @a max is small, useful when comparing @a pid smaller
* than @a max.
*/
#define PID_OVERFLOW(pid, max) (((pid) > HIGH_PID) && ((max) < LOW_PID))
/******************************************************************************/
/************************** MESSAGES ******************************/
/******************************************************************************/
GNUNET_NETWORK_STRUCT_BEGIN
/**
* Number uniquely identifying a channel of a client.
*/
struct GNUNET_CADET_ClientChannelNumber
{
/**
* Values for channel numbering.
* Local channel numbers given by the service (incoming) are
* smaller than #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI.
* Local channel numbers given by the client (created) are
* larger than #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI.
*/
uint32_t channel_of_client GNUNET_PACKED;
};
/**
* Opaque handle to a channel.
*/
struct GNUNET_CADET_Channel
{
/**
* Other end of the channel.
*/
struct GNUNET_PeerIdentity peer;
/**
* Handle to the cadet this channel belongs to
*/
struct GNUNET_CADET_Handle *cadet;
/**
* Channel's port, if incoming.
*/
struct GNUNET_CADET_Port *incoming_port;
/**
* Any data the caller wants to put in here, used for the
* various callbacks (@e disconnects, @e window_changes, handlers).
*/
void *ctx;
/**
* Message Queue for the channel (which we are implementing).
*/
struct GNUNET_MQ_Handle *mq;
/**
* Task to allow mq to send more traffic.
*/
struct GNUNET_SCHEDULER_Task *mq_cont;
/**
* Pending envelope with a message to be transmitted to the
* service as soon as we are allowed to. Should only be
* non-NULL if @e allow_send is 0.
*/
struct GNUNET_MQ_Envelope *pending_env;
/**
* Window change handler.
*/
GNUNET_CADET_WindowSizeEventHandler window_changes;
/**
* Disconnect handler.
*/
GNUNET_CADET_DisconnectEventHandler disconnects;
/**
* Local ID of the channel, #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI bit is set if outbound.
*/
struct GNUNET_CADET_ClientChannelNumber ccn;
/**
* How many messages are we allowed to send to the service right now?
*/
unsigned int allow_send;
};
/**
* Message for a client to create and destroy channels.
*/
struct GNUNET_CADET_PortMessage
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_OPEN
* or #GNUNET_MESSAGE_TYPE_CADET_LOCAL_PORT_CLOSE
*
* Size: sizeof(struct GNUNET_CADET_ChannelMessage)
*/
struct GNUNET_MessageHeader header;
/**
* Port to open/close.
*/
struct GNUNET_HashCode port GNUNET_PACKED;
};
/**
* Message for a client to create channels.
*/
struct GNUNET_CADET_LocalChannelCreateMessage
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_CREATE
*
* Size: sizeof(struct GNUNET_CADET_ChannelOpenMessageMessage)
*/
struct GNUNET_MessageHeader header;
/**
* ID of a channel controlled by this client.
*/
struct GNUNET_CADET_ClientChannelNumber ccn;
/**
* Channel's peer
*/
struct GNUNET_PeerIdentity peer;
/**
* Port of the channel.
*/
struct GNUNET_HashCode port;
/**
* Options.
*/
uint32_t opt GNUNET_PACKED;
};
/**
* Message for or to a client to destroy tunnel.
*/
struct GNUNET_CADET_LocalChannelDestroyMessage
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_CHANNEL_DESTROY
*/
struct GNUNET_MessageHeader header;
/**
* ID of a channel controlled by this client.
*/
struct GNUNET_CADET_ClientChannelNumber ccn;
};
/**
* Message for cadet data traffic.
*/
struct GNUNET_CADET_LocalData
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA
*/
struct GNUNET_MessageHeader header;
/**
* ID of the channel
*/
struct GNUNET_CADET_ClientChannelNumber ccn;
/**
* Priority and preferences (an enum GNUNET_MQ_PriorityPreferences)
* of the message in NBO.
*/
uint32_t pp GNUNET_PACKED;
/**
* Payload follows
*/
};
/**
* Message to allow the client send more data to the service
* (always service -> client).
*/
struct GNUNET_CADET_LocalAck
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK
*/
struct GNUNET_MessageHeader header;
/**
* ID of the channel allowed to send more data.
*/
struct GNUNET_CADET_ClientChannelNumber ccn;
};
/**
* Message to inform the client about channels in the service.
*
* TODO: split into two messages!
*/
struct GNUNET_CADET_LocalInfo
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL or
* #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER
*/
struct GNUNET_MessageHeader header;
/**
* ID of the channel allowed to send more data.
*/
struct GNUNET_CADET_ClientChannelNumber ccn;
/**
* ID of the destination of the channel (can be local peer).
*/
struct GNUNET_PeerIdentity peer;
};
/**
* Message to drop another message of specific type. Used in test context
*/
struct GNUNET_CADET_RequestDropCadetMessage
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_DROP_CADET_MESSAGE
*/
struct GNUNET_MessageHeader header;
/**
* Type of the message this handler covers, in host byte order.
*/
uint16_t type;
/**
* ID of the channel we want to drop a message for.
*/
struct GNUNET_CADET_ClientChannelNumber ccn;
};
/**
* Message to inform the client about channels in the service.
*/
struct GNUNET_CADET_RequestPathInfoMessage
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_PATH
*/
struct GNUNET_MessageHeader header;
/**
* Always zero.
*/
uint32_t resered GNUNET_PACKED;
/**
* ID of the destination of the channel (can be local peer).
*/
struct GNUNET_PeerIdentity peer;
};
/**
* Message to inform the client about channels in the service.
*/
struct GNUNET_CADET_ChannelInfoMessage
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_CHANNEL.
*/
struct GNUNET_MessageHeader header;
/**
* Root of the channel
*/
struct GNUNET_PeerIdentity root;
/**
* Destination of the channel
*/
struct GNUNET_PeerIdentity dest;
/* FIXME: expand! */
};
/**
* Message to as the service about information on a channel.
*/
struct GNUNET_CADET_RequestChannelInfoMessage
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_REQUEST_INFO_CHANNEL.
*/
struct GNUNET_MessageHeader header;
/**
* Target of the channel.
*/
struct GNUNET_PeerIdentity target;
};
/**
* Message to inform the client about one of the paths known to the service.
*/
struct GNUNET_CADET_LocalInfoPath
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PATH.
*/
struct GNUNET_MessageHeader header;
/**
* Offset of the peer that was requested.
*/
uint32_t off GNUNET_PACKED;
};
/**
* Message to inform the client about one of the peers in the service.
*/
struct GNUNET_CADET_LocalInfoPeers
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS
*/
struct GNUNET_MessageHeader header;
/**
* Number of paths.
*/
uint16_t paths GNUNET_PACKED;
/**
* Do we have a tunnel toward this peer?
*/
int16_t tunnel GNUNET_PACKED;
/**
* Shortest known path.
*/
uint32_t best_path_length GNUNET_PACKED;
/**
* ID of the peer (can be local peer).
*/
struct GNUNET_PeerIdentity destination;
};
/**
* Message to inform the client about one of the tunnels in the service.
*
* TODO: split into two messages!
*/
struct GNUNET_CADET_LocalInfoTunnel
{
/**
* Type: #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL
* or #GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS
*/
struct GNUNET_MessageHeader header;
/**
* Number of channels.
*/
uint32_t channels GNUNET_PACKED;
/**
* ID of the destination of the tunnel (can be local peer).
*/
struct GNUNET_PeerIdentity destination;
/**
* Number of connections.
*/
uint32_t connections GNUNET_PACKED;
/**
* Encryption state.
*/
uint16_t estate GNUNET_PACKED;
/**
* Connection state.
*/
uint16_t cstate GNUNET_PACKED;
/* If TUNNEL (no 'S'): struct GNUNET_CADET_ConnectionTunnelIdentifier connection_ids[connections] */
/* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */
};
GNUNET_NETWORK_STRUCT_END
/**
* @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);
/**
* Check if one pid is bigger than other, accounting for overflow.
*
* @param bigger Argument that should be bigger.
* @param smaller Argument that should be smaller.
*
* @return True if bigger (arg1) has a higher value than smaller (arg 2).
*/
int
GC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
/**
* Get the higher ACK value out of two values, taking in account overflow.
*
* @param a First ACK value.
* @param b Second ACK value.
*
* @return Highest ACK value from the two.
*/
uint32_t
GC_max_pid (uint32_t a, uint32_t b);
/**
* Get the lower ACK value out of two values, taking in account overflow.
*
* @param a First ACK value.
* @param b Second ACK value.
*
* @return Lowest ACK value from the two.
*/
uint32_t
GC_min_pid (uint32_t a, uint32_t b);
/**
* 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);
/**
* Convert a message type into a string to help debug
* Generated with:
* FIND: "#define ([^ ]+)[ ]*([0-9]+)"
* REPLACE: " case \2: return "\1"; break;"
*
* @param m Message type.
*
* @return Human readable string description.
*/
const char *
GC_m2s (uint16_t m);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif