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;
168 * Message type for sending a request connect message
169 * to the transport service. Must be done before transport
170 * api will allow messages to be queued/sent to transport
171 * service for transmission to a peer.
173 struct TransportRequestConnectMessage
176 * Message header with type #GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT
178 struct GNUNET_MessageHeader header;
183 uint32_t reserved GNUNET_PACKED;
186 * Identity of the peer we would like to connect to.
188 struct GNUNET_PeerIdentity peer;
193 * Message type for sending a request connection to
194 * a peer to be torn down.
196 struct TransportRequestDisconnectMessage
199 * Message header with type #GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_DISCONNECT
201 struct GNUNET_MessageHeader header;
206 uint32_t reserved GNUNET_PACKED;
209 * Identity of the peer we would like to connect to.
211 struct GNUNET_PeerIdentity peer;
216 * Message used to set a particular bandwidth quota. Sent TO the
217 * service to set an incoming quota, sent FROM the service to update
220 struct QuotaSetMessage
224 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
226 struct GNUNET_MessageHeader header;
231 struct GNUNET_BANDWIDTH_Value32NBO quota;
234 * About which peer are we talking here?
236 struct GNUNET_PeerIdentity peer;
242 * Message used to notify the transport API about a message
243 * received from the network. The actual message follows.
245 struct InboundMessage
249 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
251 struct GNUNET_MessageHeader header;
254 * Which peer sent the message?
256 struct GNUNET_PeerIdentity peer;
262 * Message used to notify the transport API that it can
263 * send another message to the transport service.
269 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
271 struct GNUNET_MessageHeader header;
274 * #GNUNET_OK if the transmission succeeded,
275 * #GNUNET_SYSERR if it failed (i.e. network disconnect);
276 * in either case, it is now OK for this client to
277 * send us another message for the given peer.
279 uint32_t success GNUNET_PACKED;
282 * Size of message sent
284 uint32_t bytes_msg GNUNET_PACKED;
287 * Size of message sent over wire
288 * Includes plugin and protocol specific overhead
290 uint32_t bytes_physical GNUNET_PACKED;
293 * Which peer can send more now?
295 struct GNUNET_PeerIdentity peer;
300 * Message used to notify the transport API about an address to string
301 * conversion. Message is followed by the string with the humand-readable
302 * address. For each lookup, multiple results may be returned. The
303 * last message must have a @e res of #GNUNET_OK and an @e addr_len
306 struct AddressToStringResultMessage
310 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY
312 struct GNUNET_MessageHeader header;
315 * #GNUNET_OK if the conversion succeeded,
316 * #GNUNET_SYSERR if it failed
318 uint32_t res GNUNET_PACKED;
321 * Length of the following string, zero if @e is #GNUNET_SYSERR
323 uint32_t addr_len GNUNET_PACKED;
328 * Message used to notify the transport service about a message
329 * to be transmitted to another peer. The actual message follows.
331 struct OutboundMessage
335 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
337 struct GNUNET_MessageHeader header;
342 uint32_t reserved GNUNET_PACKED;
347 struct GNUNET_TIME_RelativeNBO timeout;
350 * Which peer should receive the message?
352 struct GNUNET_PeerIdentity peer;
358 * Message from the library to the transport service
359 * asking for converting a transport address to a
360 * human-readable UTF-8 string.
362 struct AddressLookupMessage
366 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
368 struct GNUNET_MessageHeader header;
371 * Should the conversion use numeric IP addresses (otherwise
372 * a reverse DNS lookup is OK -- if applicable).
374 int16_t numeric_only GNUNET_PACKED;
377 * Length of the (binary) address in bytes, in big-endian.
379 uint16_t addrlen GNUNET_PACKED;
382 * timeout to give up (for DNS resolution timeout mostly)
384 struct GNUNET_TIME_RelativeNBO timeout;
386 /* followed by @e addrlen bytes of the actual address, then
387 * followed by the 0-terminated name of the transport */
392 * Message from the transport service to the library containing information
393 * about a peer. Information contained are:
394 * - current address used to communicate with this peer
399 * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
401 struct ValidationIterateResponseMessage
404 * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE
406 struct GNUNET_MessageHeader header;
416 struct GNUNET_PeerIdentity peer;
419 * Local info about the address
421 uint32_t local_address_info GNUNET_PACKED;
426 uint32_t addrlen GNUNET_PACKED;
429 * Length of the plugin name
431 uint32_t pluginlen GNUNET_PACKED;
436 uint32_t state GNUNET_PACKED;
439 * At what time did we successfully validate the address last.
440 * Will be NEVER if the address failed validation.
442 struct GNUNET_TIME_AbsoluteNBO last_validation;
445 * Until when is the address believed to be valid.
446 * Will be ZERO if the address is not belived to be valid.
448 struct GNUNET_TIME_AbsoluteNBO valid_until;
451 * When will we next try to validate the address (typically
452 * done before @e valid_until happens).
454 struct GNUNET_TIME_AbsoluteNBO next_validation;
458 * Message from the library to the transport service
459 * asking for binary addresses known for a peer.
461 struct ValidationMonitorMessage
464 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST
466 struct GNUNET_MessageHeader header;
469 * One shot call or continous replies?
474 * The identity of the peer to look up.
476 struct GNUNET_PeerIdentity peer;
482 * Message from the library to the transport service
483 * asking for binary addresses known for a peer.
485 struct PeerMonitorMessage
488 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST
490 struct GNUNET_MessageHeader header;
493 * One shot call or continous replies?
498 * The identity of the peer to look up.
500 struct GNUNET_PeerIdentity peer;
506 * Message from the library to the transport service
507 * asking for binary addresses known for a peer.
509 struct TrafficMetricMessage
512 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC
514 struct GNUNET_MessageHeader header;
517 * SEND, RECEIVE or BOTH?
522 * Traffic metrics count
527 * The identity of the peer to look up.
529 struct GNUNET_PeerIdentity peer;
534 * Message from the transport service to the library containing information
535 * about a peer. Information contained are:
536 * - current address used to communicate with this peer
541 * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
543 struct PeerIterateResponseMessage
546 * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE
548 struct GNUNET_MessageHeader header;
558 struct GNUNET_PeerIdentity peer;
561 * Timeout for the state this peer is in
563 struct GNUNET_TIME_AbsoluteNBO state_timeout;
566 * Local info about the address
568 uint32_t local_address_info GNUNET_PACKED;
571 * State this peer is in as an `enum GNUNET_TRANSPORT_PeerState`
573 uint32_t state GNUNET_PACKED;
578 uint32_t addrlen GNUNET_PACKED;
581 * Length of the plugin name
583 uint32_t pluginlen GNUNET_PACKED;
589 * Change in blacklisting (either request or notification,
590 * depending on which direction it is going).
592 struct BlacklistMessage
596 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
597 * #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
599 struct GNUNET_MessageHeader header;
602 * 0 for the query, #GNUNET_OK (allowed) or #GNUNET_SYSERR (disallowed)
605 uint32_t is_allowed GNUNET_PACKED;
608 * Which peer is being blacklisted or queried?
610 struct GNUNET_PeerIdentity peer;
616 * Transport-level connection status update.
618 struct TransportPluginMonitorMessage
622 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT.
624 struct GNUNET_MessageHeader header;
627 * An `enum GNUNET_TRANSPORT_SessionState` in NBO.
629 uint16_t session_state GNUNET_PACKED;
632 * #GNUNET_YES if this is an inbound connection,
633 * #GNUNET_NO if this is an outbound connection,
634 * #GNUNET_SYSERR if connections of this plugin
635 * are so fundamentally bidirectional
636 * that they have no 'initiator'
637 * Value given in NBO.
639 int16_t is_inbound GNUNET_PACKED;
642 * Number of messages waiting transmission.
644 uint32_t msgs_pending GNUNET_PACKED;
647 * Number of bytes waiting for transmission.
649 uint32_t bytes_pending GNUNET_PACKED;
652 * When will this transport plugin session time out?
654 struct GNUNET_TIME_AbsoluteNBO timeout;
657 * Until how long is this plugin currently blocked from reading?
659 struct GNUNET_TIME_AbsoluteNBO delay;
662 * Which peer is this connection for?
664 struct GNUNET_PeerIdentity peer;
667 * Unique identifier for the session.
672 * Length of the plugin name in bytes, including 0-termination.
674 uint16_t plugin_name_len GNUNET_PACKED;
677 * Length of the plugin address in bytes.
679 uint16_t plugin_address_len GNUNET_PACKED;
681 /* followed by 0-terminated plugin name and
682 @e plugin_address_len bytes of plugin address */
687 GNUNET_NETWORK_STRUCT_END
689 /* end of transport.h */