2 This file is part of GNUnet.
3 Copyright (C) 2009-2014 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, 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 used to set a particular bandwidth quota. Sent TO the
169 * service to set an incoming quota, sent FROM the service to update
172 struct QuotaSetMessage
176 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
178 struct GNUNET_MessageHeader header;
183 struct GNUNET_BANDWIDTH_Value32NBO quota;
186 * About which peer are we talking here?
188 struct GNUNET_PeerIdentity peer;
194 * Message used to notify the transport API about a message
195 * received from the network. The actual message follows.
197 struct InboundMessage
201 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
203 struct GNUNET_MessageHeader header;
206 * Which peer sent the message?
208 struct GNUNET_PeerIdentity peer;
214 * Message used to notify the transport API that it can
215 * send another message to the transport service.
221 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
223 struct GNUNET_MessageHeader header;
226 * #GNUNET_OK if the transmission succeeded,
227 * #GNUNET_SYSERR if it failed (i.e. network disconnect);
228 * in either case, it is now OK for this client to
229 * send us another message for the given peer.
231 uint32_t success GNUNET_PACKED;
234 * Size of message sent
236 uint32_t bytes_msg GNUNET_PACKED;
239 * Size of message sent over wire
240 * Includes plugin and protocol specific overhead
242 uint32_t bytes_physical GNUNET_PACKED;
245 * Which peer can send more now?
247 struct GNUNET_PeerIdentity peer;
252 * Message used to notify the transport API about an address to string
253 * conversion. Message is followed by the string with the humand-readable
254 * address. For each lookup, multiple results may be returned. The
255 * last message must have a @e res of #GNUNET_OK and an @e addr_len
258 struct AddressToStringResultMessage
262 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY
264 struct GNUNET_MessageHeader header;
267 * #GNUNET_OK if the conversion succeeded,
268 * #GNUNET_SYSERR if it failed
270 uint32_t res GNUNET_PACKED;
273 * Length of the following string, zero if @e is #GNUNET_SYSERR
275 uint32_t addr_len GNUNET_PACKED;
280 * Message used to notify the transport service about a message
281 * to be transmitted to another peer. The actual message follows.
283 struct OutboundMessage
287 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
289 struct GNUNET_MessageHeader header;
294 uint32_t reserved GNUNET_PACKED;
299 struct GNUNET_TIME_RelativeNBO timeout;
302 * Which peer should receive the message?
304 struct GNUNET_PeerIdentity peer;
310 * Message from the library to the transport service
311 * asking for converting a transport address to a
312 * human-readable UTF-8 string.
314 struct AddressLookupMessage
318 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
320 struct GNUNET_MessageHeader header;
323 * Should the conversion use numeric IP addresses (otherwise
324 * a reverse DNS lookup is OK -- if applicable).
326 int16_t numeric_only GNUNET_PACKED;
329 * Length of the (binary) address in bytes, in big-endian.
331 uint16_t addrlen GNUNET_PACKED;
334 * timeout to give up (for DNS resolution timeout mostly)
336 struct GNUNET_TIME_RelativeNBO timeout;
338 /* followed by @e addrlen bytes of the actual address, then
339 * followed by the 0-terminated name of the transport */
344 * Message from the transport service to the library containing information
345 * about a peer. Information contained are:
346 * - current address used to communicate with this peer
351 * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
353 struct ValidationIterateResponseMessage
356 * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE
358 struct GNUNET_MessageHeader header;
368 struct GNUNET_PeerIdentity peer;
371 * Local info about the address
373 uint32_t local_address_info GNUNET_PACKED;
378 uint32_t addrlen GNUNET_PACKED;
381 * Length of the plugin name
383 uint32_t pluginlen GNUNET_PACKED;
388 uint32_t state GNUNET_PACKED;
391 * At what time did we successfully validate the address last.
392 * Will be NEVER if the address failed validation.
394 struct GNUNET_TIME_AbsoluteNBO last_validation;
397 * Until when is the address believed to be valid.
398 * Will be ZERO if the address is not belived to be valid.
400 struct GNUNET_TIME_AbsoluteNBO valid_until;
403 * When will we next try to validate the address (typically
404 * done before @e valid_until happens).
406 struct GNUNET_TIME_AbsoluteNBO next_validation;
410 * Message from the library to the transport service
411 * asking for binary addresses known for a peer.
413 struct ValidationMonitorMessage
416 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST
418 struct GNUNET_MessageHeader header;
421 * One shot call or continous replies?
423 uint32_t one_shot GNUNET_PACKED;
426 * The identity of the peer to look up.
428 struct GNUNET_PeerIdentity peer;
434 * Message from the library to the transport service
435 * asking for binary addresses known for a peer.
437 struct PeerMonitorMessage
440 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST
442 struct GNUNET_MessageHeader header;
445 * One shot call or continous replies?
447 uint32_t one_shot GNUNET_PACKED;
450 * The identity of the peer to look up.
452 struct GNUNET_PeerIdentity peer;
458 * Message from the library to the transport service
459 * asking for binary addresses known for a peer.
461 struct TrafficMetricMessage
464 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC
466 struct GNUNET_MessageHeader header;
471 uint32_t reserved GNUNET_PACKED;
474 * The identity of the peer to look up.
476 struct GNUNET_PeerIdentity peer;
479 * Fake properties to generate.
481 struct GNUNET_ATS_PropertiesNBO properties;
484 * Fake delay to add on inbound traffic.
486 struct GNUNET_TIME_RelativeNBO delay_in;
489 * Fake delay to add on outbound traffic.
491 struct GNUNET_TIME_RelativeNBO delay_out;
496 * Message from the transport service to the library containing information
497 * about a peer. Information contained are:
498 * - current address used to communicate with this peer
503 * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
505 struct PeerIterateResponseMessage
508 * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE
510 struct GNUNET_MessageHeader header;
520 struct GNUNET_PeerIdentity peer;
523 * Timeout for the state this peer is in
525 struct GNUNET_TIME_AbsoluteNBO state_timeout;
528 * Local info about the address
530 uint32_t local_address_info GNUNET_PACKED;
533 * State this peer is in as an `enum GNUNET_TRANSPORT_PeerState`
535 uint32_t state GNUNET_PACKED;
540 uint32_t addrlen GNUNET_PACKED;
543 * Length of the plugin name
545 uint32_t pluginlen GNUNET_PACKED;
551 * Change in blacklisting (either request or notification,
552 * depending on which direction it is going).
554 struct BlacklistMessage
558 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
559 * #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
561 struct GNUNET_MessageHeader header;
564 * 0 for the query, #GNUNET_OK (allowed) or #GNUNET_SYSERR (disallowed)
567 uint32_t is_allowed GNUNET_PACKED;
570 * Which peer is being blacklisted or queried?
572 struct GNUNET_PeerIdentity peer;
578 * Transport-level connection status update.
580 struct TransportPluginMonitorMessage
584 * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT.
586 struct GNUNET_MessageHeader header;
589 * An `enum GNUNET_TRANSPORT_SessionState` in NBO.
591 uint16_t session_state GNUNET_PACKED;
594 * #GNUNET_YES if this is an inbound connection,
595 * #GNUNET_NO if this is an outbound connection,
596 * #GNUNET_SYSERR if connections of this plugin
597 * are so fundamentally bidirectional
598 * that they have no 'initiator'
599 * Value given in NBO.
601 int16_t is_inbound GNUNET_PACKED;
604 * Number of messages waiting transmission.
606 uint32_t msgs_pending GNUNET_PACKED;
609 * Number of bytes waiting for transmission.
611 uint32_t bytes_pending GNUNET_PACKED;
614 * When will this transport plugin session time out?
616 struct GNUNET_TIME_AbsoluteNBO timeout;
619 * Until how long is this plugin currently blocked from reading?
621 struct GNUNET_TIME_AbsoluteNBO delay;
624 * Which peer is this connection for?
626 struct GNUNET_PeerIdentity peer;
629 * Unique identifier for the session.
634 * Length of the plugin name in bytes, including 0-termination.
636 uint16_t plugin_name_len GNUNET_PACKED;
639 * Length of the plugin address in bytes.
641 uint16_t plugin_address_len GNUNET_PACKED;
643 /* followed by 0-terminated plugin name and
644 @e plugin_address_len bytes of plugin address */
649 GNUNET_NETWORK_STRUCT_END
651 /* end of transport.h */