X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Ftransport%2Ftransport.h;h=17e4f3c215d5659a5231cfddd9e815618df6df0f;hb=547d531bb3088bf00a0ae5777fa09c7893b7b370;hp=6717d5640d0f994084f9f550e1d1af2589ae4a1e;hpb=ff5e94e712ab79a7c4347450f05f52986a22391a;p=oweals%2Fgnunet.git diff --git a/src/transport/transport.h b/src/transport/transport.h index 6717d5640..17e4f3c21 100644 --- a/src/transport/transport.h +++ b/src/transport/transport.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet. - (C) 2009 Christian Grothoff (and other contributing authors) + Copyright (C) 2009-2014 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 @@ -14,8 +14,8 @@ 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., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. */ /** @@ -29,49 +29,16 @@ #include "gnunet_crypto_lib.h" #include "gnunet_time_lib.h" #include "gnunet_transport_service.h" +#include "gnunet_constants.h" -/* Minimum time between to calculations*/ -#define ATS_MIN_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 1) -#define ATS_EXEC_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 5) -#define ATS_MAX_EXEC_DURATION GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 500) -#define ATS_MAX_ITERATIONS INT_MAX +#define DEBUG_TRANSPORT GNUNET_EXTRA_LOGGING -struct ATS_info -{ - struct GNUNET_CONTAINER_MultiHashMap * peers; - /** - * Time of last execution - */ - struct GNUNET_TIME_Absolute last; - /** - * Minimum intervall between two executions - */ - struct GNUNET_TIME_Relative min_delta; - /** - * Regular intervall when execution is triggered - */ - struct GNUNET_TIME_Relative exec_intervall; - /** - * Maximum execution time per calculation - */ - struct GNUNET_TIME_Relative max_exec_duration; - /** - * Maximum number of LP iterations per calculation - */ - int max_iterations; - - GNUNET_SCHEDULER_TaskIdentifier ats_task; -}; - -#define DEBUG_TRANSPORT GNUNET_NO -#define DEBUG_TRANSPORT_TIMEOUT GNUNET_NO -#define DEBUG_TRANSPORT_DISCONNECT GNUNET_NO /** * For how long do we allow unused bandwidth * from the past to carry over into the future? (in seconds) */ -#define MAX_BANDWIDTH_CARRY_S 5 +#define MAX_BANDWIDTH_CARRY_S GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S /** * How often do we (at most) do a full quota @@ -79,6 +46,41 @@ struct ATS_info */ #define MIN_QUOTA_REFRESH_TIME 2000 +/** + * What's the maximum number of sockets transport uses for validation and + * neighbors + */ +#define DEFAULT_MAX_FDS 256 + +/** + * Maximum frequency for re-evaluating latencies for all transport addresses. + */ +#define LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1) + +/** + * Maximum frequency for re-evaluating latencies for connected addresses. + */ +#define CONNECTED_LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1) + +/** + * Similiar to GNUNET_TRANSPORT_NotifyDisconnect but in and out quotas are + * included here. These values are not required outside transport_api + * + * @param cls closure + * @param peer the peer that connected + * @param bandwidth_in inbound bandwidth in NBO + * @param bandwidth_out outbound bandwidth in NBO + * + */ +typedef void +(*NotifyConnect) (void *cls, + const struct GNUNET_PeerIdentity *peer, + struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in, + struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out); + + +GNUNET_NETWORK_STRUCT_BEGIN + /** * Message from the transport service to the library * asking to check if both processes agree about this @@ -88,14 +90,16 @@ struct StartMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_START */ struct GNUNET_MessageHeader header; /** - * Should the 'self' field be checked? + * 0: no options + * 1: The 'self' field should be checked + * 2: this client is interested in payload traffic */ - uint32_t do_check; + uint32_t options; /** * Identity we think we have. If it does not match, the @@ -114,26 +118,24 @@ struct ConnectInfoMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT */ struct GNUNET_MessageHeader header; /** - * Number of ATS key-value pairs that follow this struct - * (excluding the 0-terminator). + * Identity of the new neighbour. */ - uint32_t ats_count GNUNET_PACKED; + struct GNUNET_PeerIdentity id; /** - * Identity of the new neighbour. + * Current inbound quota for this peer */ - struct GNUNET_PeerIdentity id; + struct GNUNET_BANDWIDTH_Value32NBO quota_in; /** - * First of the ATS information blocks (we must have at least - * one due to the 0-termination requirement). + * Current outbound quota for this peer */ - struct GNUNET_TRANSPORT_ATS_Information ats; + struct GNUNET_BANDWIDTH_Value32NBO quota_out; }; @@ -145,7 +147,7 @@ struct DisconnectInfoMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT */ struct GNUNET_MessageHeader header; @@ -161,35 +163,17 @@ struct DisconnectInfoMessage }; -/** - * Message type for sending a request connect message - * to the transport service. Must be done before transport - * api will allow messages to be queued/sent to transport - * service for transmission to a peer. - */ -struct TransportRequestConnectMessage -{ - /** - * Message header - */ - struct GNUNET_MessageHeader header; - - /** - * Identity of the peer we would like to connect to. - */ - struct GNUNET_PeerIdentity peer; -}; /** - * Message used to set a particular bandwidth quota. Send TO the - * service to set an incoming quota, send FROM the service to update + * Message used to set a particular bandwidth quota. Sent TO the + * service to set an incoming quota, sent FROM the service to update * an outgoing quota. */ struct QuotaSetMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA */ struct GNUNET_MessageHeader header; @@ -214,31 +198,15 @@ struct InboundMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_RECV */ struct GNUNET_MessageHeader header; - /** - * Always zero. - */ - uint32_t reserved GNUNET_PACKED; - - /** - * Number of ATS key-value pairs that follow this struct - * (excluding the 0-terminator). - */ - uint32_t ats_count GNUNET_PACKED; - /** * Which peer sent the message? */ struct GNUNET_PeerIdentity peer; - /** - * First of the ATS information blocks (we must have at least - * one due to the 0-termination requirement). - */ - struct GNUNET_TRANSPORT_ATS_Information ats; }; @@ -250,22 +218,28 @@ struct SendOkMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK */ struct GNUNET_MessageHeader header; /** - * GNUNET_OK if the transmission succeeded, - * GNUNET_SYSERR if it failed (i.e. network disconnect); + * #GNUNET_OK if the transmission succeeded, + * #GNUNET_SYSERR if it failed (i.e. network disconnect); * in either case, it is now OK for this client to * send us another message for the given peer. */ uint32_t success GNUNET_PACKED; /** - * Latency estimate. + * Size of message sent */ - struct GNUNET_TIME_RelativeNBO latency; + uint32_t bytes_msg GNUNET_PACKED; + + /** + * Size of message sent over wire + * Includes plugin and protocol specific overhead + */ + uint32_t bytes_physical GNUNET_PACKED; /** * Which peer can send more now? @@ -274,6 +248,33 @@ struct SendOkMessage }; +/** + * Message used to notify the transport API about an address to string + * conversion. Message is followed by the string with the humand-readable + * address. For each lookup, multiple results may be returned. The + * last message must have a @e res of #GNUNET_OK and an @e addr_len + * of zero. + */ +struct AddressToStringResultMessage +{ + + /** + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY + */ + struct GNUNET_MessageHeader header; + + /** + * #GNUNET_OK if the conversion succeeded, + * #GNUNET_SYSERR if it failed + */ + uint32_t res GNUNET_PACKED; + + /** + * Length of the following string, zero if @e is #GNUNET_SYSERR + */ + uint32_t addr_len GNUNET_PACKED; +}; + /** * Message used to notify the transport service about a message @@ -283,14 +284,14 @@ struct OutboundMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND */ struct GNUNET_MessageHeader header; /** - * Message priority. + * Always zero. */ - uint32_t priority GNUNET_PACKED; + uint32_t reserved GNUNET_PACKED; /** * Allowed delay. @@ -314,7 +315,7 @@ struct AddressLookupMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING */ struct GNUNET_MessageHeader header; @@ -322,22 +323,228 @@ struct AddressLookupMessage * Should the conversion use numeric IP addresses (otherwise * a reverse DNS lookup is OK -- if applicable). */ - int32_t numeric_only GNUNET_PACKED; + int16_t numeric_only GNUNET_PACKED; /** - * timeout to give up. + * Length of the (binary) address in bytes, in big-endian. */ - struct GNUNET_TIME_AbsoluteNBO timeout; + uint16_t addrlen GNUNET_PACKED; /** - * Length of the (binary) address in bytes, in big-endian. + * timeout to give up (for DNS resolution timeout mostly) + */ + struct GNUNET_TIME_RelativeNBO timeout; + + /* followed by @e addrlen bytes of the actual address, then + * followed by the 0-terminated name of the transport */ +}; + + +/** + * Message from the transport service to the library containing information + * about a peer. Information contained are: + * - current address used to communicate with this peer + * - state + * - state timeout + * + * Memory layout: + * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]] + */ +struct ValidationIterateResponseMessage +{ + /** + * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE + */ + struct GNUNET_MessageHeader header; + + /** + * For alignment. + */ + uint32_t reserved; + + /** + * Peer identity + */ + struct GNUNET_PeerIdentity peer; + + /** + * Local info about the address + */ + uint32_t local_address_info GNUNET_PACKED; + + /** + * Address length */ uint32_t addrlen GNUNET_PACKED; - /* followed by 'addrlen' bytes of the actual address, then - followed by the 0-terminated name of the transport */ + /** + * Length of the plugin name + */ + uint32_t pluginlen GNUNET_PACKED; + + /** + * State + */ + uint32_t state GNUNET_PACKED; + + /** + * At what time did we successfully validate the address last. + * Will be NEVER if the address failed validation. + */ + struct GNUNET_TIME_AbsoluteNBO last_validation; + + /** + * Until when is the address believed to be valid. + * Will be ZERO if the address is not belived to be valid. + */ + struct GNUNET_TIME_AbsoluteNBO valid_until; + + /** + * When will we next try to validate the address (typically + * done before @e valid_until happens). + */ + struct GNUNET_TIME_AbsoluteNBO next_validation; }; +/** + * Message from the library to the transport service + * asking for binary addresses known for a peer. + */ +struct ValidationMonitorMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST + */ + struct GNUNET_MessageHeader header; + + /** + * One shot call or continous replies? + */ + uint32_t one_shot GNUNET_PACKED; + + /** + * The identity of the peer to look up. + */ + struct GNUNET_PeerIdentity peer; + +}; + + +/** + * Message from the library to the transport service + * asking for binary addresses known for a peer. + */ +struct PeerMonitorMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST + */ + struct GNUNET_MessageHeader header; + + /** + * One shot call or continous replies? + */ + uint32_t one_shot GNUNET_PACKED; + + /** + * The identity of the peer to look up. + */ + struct GNUNET_PeerIdentity peer; + +}; + + +/** + * Message from the library to the transport service + * asking for binary addresses known for a peer. + */ +struct TrafficMetricMessage +{ + /** + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC + */ + struct GNUNET_MessageHeader header; + + /** + * Always zero. + */ + uint32_t reserved GNUNET_PACKED; + + /** + * The identity of the peer to look up. + */ + struct GNUNET_PeerIdentity peer; + + /** + * Fake properties to generate. + */ + struct GNUNET_ATS_PropertiesNBO properties; + + /** + * Fake delay to add on inbound traffic. + */ + struct GNUNET_TIME_RelativeNBO delay_in; + + /** + * Fake delay to add on outbound traffic. + */ + struct GNUNET_TIME_RelativeNBO delay_out; +}; + + +/** + * Message from the transport service to the library containing information + * about a peer. Information contained are: + * - current address used to communicate with this peer + * - state + * - state timeout + * + * Memory layout: + * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]] + */ +struct PeerIterateResponseMessage +{ + /** + * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE + */ + struct GNUNET_MessageHeader header; + + /** + * For alignment. + */ + uint32_t reserved; + + /** + * Peer identity + */ + struct GNUNET_PeerIdentity peer; + + /** + * Timeout for the state this peer is in + */ + struct GNUNET_TIME_AbsoluteNBO state_timeout; + + /** + * Local info about the address + */ + uint32_t local_address_info GNUNET_PACKED; + + /** + * State this peer is in as an `enum GNUNET_TRANSPORT_PeerState` + */ + uint32_t state GNUNET_PACKED; + + /** + * Address length + */ + uint32_t addrlen GNUNET_PACKED; + + /** + * Length of the plugin name + */ + uint32_t pluginlen GNUNET_PACKED; + +}; /** @@ -348,13 +555,13 @@ struct BlacklistMessage { /** - * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or - * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY. + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or + * #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY. */ struct GNUNET_MessageHeader header; /** - * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed) + * 0 for the query, #GNUNET_OK (allowed) or #GNUNET_SYSERR (disallowed) * for the response. */ uint32_t is_allowed GNUNET_PACKED; @@ -367,5 +574,79 @@ struct BlacklistMessage }; +/** + * Transport-level connection status update. + */ +struct TransportPluginMonitorMessage +{ + + /** + * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT. + */ + struct GNUNET_MessageHeader header; + + /** + * An `enum GNUNET_TRANSPORT_SessionState` in NBO. + */ + uint16_t session_state GNUNET_PACKED; + + /** + * #GNUNET_YES if this is an inbound connection, + * #GNUNET_NO if this is an outbound connection, + * #GNUNET_SYSERR if connections of this plugin + * are so fundamentally bidirectional + * that they have no 'initiator' + * Value given in NBO. + */ + int16_t is_inbound GNUNET_PACKED; + + /** + * Number of messages waiting transmission. + */ + uint32_t msgs_pending GNUNET_PACKED; + + /** + * Number of bytes waiting for transmission. + */ + uint32_t bytes_pending GNUNET_PACKED; + + /** + * When will this transport plugin session time out? + */ + struct GNUNET_TIME_AbsoluteNBO timeout; + + /** + * Until how long is this plugin currently blocked from reading? + */ + struct GNUNET_TIME_AbsoluteNBO delay; + + /** + * Which peer is this connection for? + */ + struct GNUNET_PeerIdentity peer; + + /** + * Unique identifier for the session. + */ + uint64_t session_id; + + /** + * Length of the plugin name in bytes, including 0-termination. + */ + uint16_t plugin_name_len GNUNET_PACKED; + + /** + * Length of the plugin address in bytes. + */ + uint16_t plugin_address_len GNUNET_PACKED; + + /* followed by 0-terminated plugin name and + @e plugin_address_len bytes of plugin address */ + +}; + + +GNUNET_NETWORK_STRUCT_END + /* end of transport.h */ #endif