2 This file is part of GNUnet.
3 (C) 2009-2014 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file transport/transport.h
23 * @brief common internal definitions for transport service
24 * @author Christian Grothoff
29 #include "gnunet_crypto_lib.h"
30 #include "gnunet_time_lib.h"
31 #include "gnunet_transport_service.h"
32 #include "gnunet_constants.h"
34 #define DEBUG_TRANSPORT GNUNET_EXTRA_LOGGING
38 * For how long do we allow unused bandwidth
39 * from the past to carry over into the future? (in seconds)
41 #define MAX_BANDWIDTH_CARRY_S GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S
44 * How often do we (at most) do a full quota
45 * recalculation? (in ms)
47 #define MIN_QUOTA_REFRESH_TIME 2000
50 * What's the maximum number of sockets transport uses for validation and
53 #define DEFAULT_MAX_FDS 256
56 * Maximum frequency for re-evaluating latencies for all transport addresses.
58 #define LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
61 * Maximum frequency for re-evaluating latencies for connected addresses.
63 #define CONNECTED_LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
66 * Similiar to GNUNET_TRANSPORT_NotifyDisconnect but in and out quotas are
67 * included here. These values are not required outside transport_api
70 * @param peer the peer that connected
71 * @param bandwidth_in inbound bandwidth in NBO
72 * @param bandwidth_out outbound bandwidth in NBO
76 (*NotifyConnect) (void *cls,
77 const struct GNUNET_PeerIdentity *peer,
78 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
79 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
82 GNUNET_NETWORK_STRUCT_BEGIN
85 * Message from the transport service to the library
86 * asking to check if both processes agree about this
93 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_START
95 struct GNUNET_MessageHeader header;
99 * 1: The 'self' field should be checked
100 * 2: this client is interested in payload traffic
105 * Identity we think we have. If it does not match, the
106 * receiver should print out an error message and disconnect.
108 struct GNUNET_PeerIdentity self;
114 * Message from the transport service to the library
115 * informing about neighbors.
117 struct ConnectInfoMessage
121 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
123 struct GNUNET_MessageHeader header;
126 * Identity of the new neighbour.
128 struct GNUNET_PeerIdentity id;
131 * Current inbound quota for this peer
133 struct GNUNET_BANDWIDTH_Value32NBO quota_in;
136 * Current outbound quota for this peer
138 struct GNUNET_BANDWIDTH_Value32NBO quota_out;
143 * Message from the transport service to the library
144 * informing about disconnects.
146 struct DisconnectInfoMessage
150 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
152 struct GNUNET_MessageHeader header;
155 * Reserved, always zero.
157 uint32_t reserved GNUNET_PACKED;
160 * Who got disconnected?
162 struct GNUNET_PeerIdentity peer;
167 * Message type for sending a request connect message
168 * to the transport service. Must be done before transport
169 * api will allow messages to be queued/sent to transport
170 * service for transmission to a peer.
172 struct TransportRequestConnectMessage
177 struct GNUNET_MessageHeader header;
180 * Connect (#GNUNET_YES) or connect (#GNUNET_NO).
185 * Identity of the peer we would like to connect to.
187 struct GNUNET_PeerIdentity peer;
191 * Message used to set a particular bandwidth quota. Sent TO the
192 * service to set an incoming quota, sent FROM the service to update
195 struct QuotaSetMessage
199 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
201 struct GNUNET_MessageHeader header;
206 struct GNUNET_BANDWIDTH_Value32NBO quota;
209 * About which peer are we talking here?
211 struct GNUNET_PeerIdentity peer;
217 * Message used to notify the transport API about a message
218 * received from the network. The actual message follows.
220 struct InboundMessage
224 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
226 struct GNUNET_MessageHeader header;
229 * Which peer sent the message?
231 struct GNUNET_PeerIdentity peer;
237 * Message used to notify the transport API that it can
238 * send another message to the transport service.
244 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
246 struct GNUNET_MessageHeader header;
249 * #GNUNET_OK if the transmission succeeded,
250 * #GNUNET_SYSERR if it failed (i.e. network disconnect);
251 * in either case, it is now OK for this client to
252 * send us another message for the given peer.
254 uint32_t success GNUNET_PACKED;
257 * Size of message sent
259 uint32_t bytes_msg GNUNET_PACKED;
262 * Size of message sent over wire
263 * Includes plugin and protocol specific overhead
265 uint32_t bytes_physical GNUNET_PACKED;
270 struct GNUNET_TIME_RelativeNBO latency;
273 * Which peer can send more now?
275 struct GNUNET_PeerIdentity peer;
280 * Message used to notify the transport API about an address to string
281 * conversion. Message is followed by the string with the humand-readable
282 * address. For each lookup, multiple results may be returned. The
283 * last message must have a @e res of #GNUNET_OK and an @e addr_len
286 struct AddressToStringResultMessage
290 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY
292 struct GNUNET_MessageHeader header;
295 * #GNUNET_OK if the conversion succeeded,
296 * #GNUNET_SYSERR if it failed
298 uint32_t res GNUNET_PACKED;
301 * Length of the following string, zero if @e is #GNUNET_SYSERR
303 uint32_t addr_len GNUNET_PACKED;
308 * Message used to notify the transport service about a message
309 * to be transmitted to another peer. The actual message follows.
311 struct OutboundMessage
315 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
317 struct GNUNET_MessageHeader header;
322 uint32_t reserved GNUNET_PACKED;
327 struct GNUNET_TIME_RelativeNBO timeout;
330 * Which peer should receive the message?
332 struct GNUNET_PeerIdentity peer;
338 * Message from the library to the transport service
339 * asking for converting a transport address to a
340 * human-readable UTF-8 string.
342 struct AddressLookupMessage
346 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
348 struct GNUNET_MessageHeader header;
351 * Should the conversion use numeric IP addresses (otherwise
352 * a reverse DNS lookup is OK -- if applicable).
354 int16_t numeric_only GNUNET_PACKED;
357 * Length of the (binary) address in bytes, in big-endian.
359 uint16_t addrlen GNUNET_PACKED;
362 * timeout to give up (for DNS resolution timeout mostly)
364 struct GNUNET_TIME_RelativeNBO timeout;
366 /* followed by @e addrlen bytes of the actual address, then
367 * followed by the 0-terminated name of the transport */
372 * Message from the transport service to the library containing information
373 * about a peer. Information contained are:
374 * - current address used to communicate with this peer
379 * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
381 struct ValidationIterateResponseMessage
384 * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE
386 struct GNUNET_MessageHeader header;
396 struct GNUNET_PeerIdentity peer;
399 * Local info about the address
401 uint32_t local_address_info GNUNET_PACKED;
406 uint32_t addrlen GNUNET_PACKED;
409 * Length of the plugin name
411 uint32_t pluginlen GNUNET_PACKED;
416 uint32_t state GNUNET_PACKED;
419 * At what time did we successfully validate the address last.
420 * Will be NEVER if the address failed validation.
422 struct GNUNET_TIME_AbsoluteNBO last_validation;
425 * Until when is the address believed to be valid.
426 * Will be ZERO if the address is not belived to be valid.
428 struct GNUNET_TIME_AbsoluteNBO valid_until;
431 * When will we next try to validate the address (typically
432 * done before @e valid_until happens).
434 struct GNUNET_TIME_AbsoluteNBO next_validation;
438 * Message from the library to the transport service
439 * asking for binary addresses known for a peer.
441 struct ValidationMonitorMessage
444 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST
446 struct GNUNET_MessageHeader header;
449 * One shot call or continous replies?
454 * The identity of the peer to look up.
456 struct GNUNET_PeerIdentity peer;
462 * Message from the library to the transport service
463 * asking for binary addresses known for a peer.
465 struct PeerMonitorMessage
468 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST
470 struct GNUNET_MessageHeader header;
473 * One shot call or continous replies?
478 * The identity of the peer to look up.
480 struct GNUNET_PeerIdentity peer;
486 * Message from the library to the transport service
487 * asking for binary addresses known for a peer.
489 struct TrafficMetricMessage
492 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC
494 struct GNUNET_MessageHeader header;
497 * SEND, RECEIVE or BOTH?
502 * Traffic metrics count
507 * The identity of the peer to look up.
509 struct GNUNET_PeerIdentity peer;
514 * Message from the transport service to the library containing information
515 * about a peer. Information contained are:
516 * - current address used to communicate with this peer
521 * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
523 struct PeerIterateResponseMessage
526 * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE
528 struct GNUNET_MessageHeader header;
538 struct GNUNET_PeerIdentity peer;
541 * Timeout for the state this peer is in
543 struct GNUNET_TIME_AbsoluteNBO state_timeout;
546 * Local info about the address
548 uint32_t local_address_info GNUNET_PACKED;
551 * State this peer is in as an `enum GNUNET_TRANSPORT_PeerState`
553 uint32_t state GNUNET_PACKED;
558 uint32_t addrlen GNUNET_PACKED;
561 * Length of the plugin name
563 uint32_t pluginlen GNUNET_PACKED;
569 * Change in blacklisting (either request or notification,
570 * depending on which direction it is going).
572 struct BlacklistMessage
576 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
577 * #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
579 struct GNUNET_MessageHeader header;
582 * 0 for the query, #GNUNET_OK (allowed) or #GNUNET_SYSERR (disallowed)
585 uint32_t is_allowed GNUNET_PACKED;
588 * Which peer is being blacklisted or queried?
590 struct GNUNET_PeerIdentity peer;
596 * Transport-level connection status update.
598 struct TransportPluginMonitorMessage
602 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT.
604 struct GNUNET_MessageHeader header;
607 * An `enum GNUNET_TRANSPORT_SessionState` in NBO.
609 uint16_t session_state GNUNET_PACKED;
612 * #GNUNET_YES if this is an inbound connection,
613 * #GNUNET_NO if this is an outbound connection,
614 * #GNUNET_SYSERR if connections of this plugin
615 * are so fundamentally bidirectional
616 * that they have no 'initiator'
617 * Value given in NBO.
619 int16_t is_inbound GNUNET_PACKED;
622 * Number of messages waiting transmission.
624 uint32_t msgs_pending GNUNET_PACKED;
627 * Number of bytes waiting for transmission.
629 uint32_t bytes_pending GNUNET_PACKED;
632 * When will this transport plugin session time out?
634 struct GNUNET_TIME_AbsoluteNBO timeout;
637 * Until how long is this plugin currently blocked from reading?
639 struct GNUNET_TIME_AbsoluteNBO delay;
642 * Which peer is this connection for?
644 struct GNUNET_PeerIdentity peer;
647 * Length of the plugin name in bytes, including 0-termination.
649 uint16_t plugin_name_len GNUNET_PACKED;
652 * Length of the plugin address in bytes.
654 uint16_t plugin_address_len GNUNET_PACKED;
656 /* followed by 0-terminated plugin name and
657 @e plugin_address_len bytes of plugin address */
662 GNUNET_NETWORK_STRUCT_END
664 /* end of transport.h */