src/transport/transport.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009-2014 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file transport/transport.h
  23  * @brief common internal definitions for transport service
  24  * @author Christian Grothoff
  25  */
  26 #ifndef TRANSPORT_H
  27 #define TRANSPORT_H
  28
  29 #include "gnunet_crypto_lib.h"
  30 #include "gnunet_time_lib.h"
  31 #include "gnunet_transport_service.h"
  32 #include "gnunet_constants.h"
  33
  34 #define DEBUG_TRANSPORT GNUNET_EXTRA_LOGGING
  35
  36
  37 /**
  38  * For how long do we allow unused bandwidth
  39  * from the past to carry over into the future? (in seconds)
  40  */
  41 #define MAX_BANDWIDTH_CARRY_S GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S
  42
  43 /**
  44  * How often do we (at most) do a full quota
  45  * recalculation? (in ms)
  46  */
  47 #define MIN_QUOTA_REFRESH_TIME 2000
  48
  49 /**
  50  * What's the maximum number of sockets transport uses for validation and
  51  * neighbors
  52  */
  53 #define DEFAULT_MAX_FDS 256
  54
  55 /**
  56  * Maximum frequency for re-evaluating latencies for all transport addresses.
  57  */
  58 #define LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
  59
  60 /**
  61  * Maximum frequency for re-evaluating latencies for connected addresses.
  62  */
  63 #define CONNECTED_LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
  64
  65 /**
  66  * Similiar to GNUNET_TRANSPORT_NotifyDisconnect but in and out quotas are
  67  * included here. These values are not required outside transport_api
  68  *
  69  * @param cls closure
  70  * @param peer the peer that connected
  71  * @param bandwidth_in inbound bandwidth in NBO
  72  * @param bandwidth_out outbound bandwidth in NBO
  73  *
  74  */
  75 typedef void
  76 (*NotifyConnect) (void *cls,
  77                   const struct GNUNET_PeerIdentity *peer,
  78                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
  79                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
  80
  81
  82 GNUNET_NETWORK_STRUCT_BEGIN
  83
  84 /**
  85  * Message from the transport service to the library
  86  * asking to check if both processes agree about this
  87  * peers identity.
  88  */
  89 struct StartMessage
  90 {
  91
  92   /**
  93    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_START
  94    */
  95   struct GNUNET_MessageHeader header;
  96
  97   /**
  98    * 0: no options
  99    * 1: The 'self' field should be checked
 100    * 2: this client is interested in payload traffic
 101    */
 102   uint32_t options;
 103
 104   /**
 105    * Identity we think we have.  If it does not match, the
 106    * receiver should print out an error message and disconnect.
 107    */
 108   struct GNUNET_PeerIdentity self;
 109
 110 };
 111
 112
 113 /**
 114  * Message from the transport service to the library
 115  * informing about neighbors.
 116  */
 117 struct ConnectInfoMessage
 118 {
 119
 120   /**
 121    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
 122    */
 123   struct GNUNET_MessageHeader header;
 124
 125   /**
 126    * Identity of the new neighbour.
 127    */
 128   struct GNUNET_PeerIdentity id;
 129
 130   /**
 131    * Current inbound quota for this peer
 132    */
 133   struct GNUNET_BANDWIDTH_Value32NBO quota_in;
 134
 135   /**
 136    * Current outbound quota for this peer
 137    */
 138   struct GNUNET_BANDWIDTH_Value32NBO quota_out;
 139 };
 140
 141
 142 /**
 143  * Message from the transport service to the library
 144  * informing about disconnects.
 145  */
 146 struct DisconnectInfoMessage
 147 {
 148
 149   /**
 150    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
 151    */
 152   struct GNUNET_MessageHeader header;
 153
 154   /**
 155    * Reserved, always zero.
 156    */
 157   uint32_t reserved GNUNET_PACKED;
 158
 159   /**
 160    * Who got disconnected?
 161    */
 162   struct GNUNET_PeerIdentity peer;
 163
 164 };
 165
 166 /**
 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.
 171  */
 172 struct TransportRequestConnectMessage
 173 {
 174   /**
 175    *  Message header
 176    */
 177   struct GNUNET_MessageHeader header;
 178
 179   /**
 180    * Connect (#GNUNET_YES) or connect (#GNUNET_NO).
 181    */
 182   uint32_t connect;
 183
 184   /**
 185    * Identity of the peer we would like to connect to.
 186    */
 187   struct GNUNET_PeerIdentity peer;
 188 };
 189
 190 /**
 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
 193  * an outgoing quota.
 194  */
 195 struct QuotaSetMessage
 196 {
 197
 198   /**
 199    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
 200    */
 201   struct GNUNET_MessageHeader header;
 202
 203   /**
 204    * Quota.
 205    */
 206   struct GNUNET_BANDWIDTH_Value32NBO quota;
 207
 208   /**
 209    * About which peer are we talking here?
 210    */
 211   struct GNUNET_PeerIdentity peer;
 212
 213 };
 214
 215
 216 /**
 217  * Message used to notify the transport API about a message
 218  * received from the network.  The actual message follows.
 219  */
 220 struct InboundMessage
 221 {
 222
 223   /**
 224    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
 225    */
 226   struct GNUNET_MessageHeader header;
 227
 228   /**
 229    * Which peer sent the message?
 230    */
 231   struct GNUNET_PeerIdentity peer;
 232
 233 };
 234
 235
 236 /**
 237  * Message used to notify the transport API that it can
 238  * send another message to the transport service.
 239  */
 240 struct SendOkMessage
 241 {
 242
 243   /**
 244    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
 245    */
 246   struct GNUNET_MessageHeader header;
 247
 248   /**
 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.
 253    */
 254   uint32_t success GNUNET_PACKED;
 255
 256   /**
 257    * Size of message sent
 258    */
 259   uint32_t bytes_msg GNUNET_PACKED;
 260
 261   /**
 262    * Size of message sent over wire
 263    * Includes plugin and protocol specific overhead
 264    */
 265   uint32_t bytes_physical GNUNET_PACKED;
 266
 267   /**
 268    * Which peer can send more now?
 269    */
 270   struct GNUNET_PeerIdentity peer;
 271
 272 };
 273
 274 /**
 275  * Message used to notify the transport API about an address to string
 276  * conversion. Message is followed by the string with the humand-readable
 277  * address.  For each lookup, multiple results may be returned.  The
 278  * last message must have a @e res of #GNUNET_OK and an @e addr_len
 279  * of zero.
 280  */
 281 struct AddressToStringResultMessage
 282 {
 283
 284   /**
 285    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY
 286    */
 287   struct GNUNET_MessageHeader header;
 288
 289   /**
 290    * #GNUNET_OK if the conversion succeeded,
 291    * #GNUNET_SYSERR if it failed
 292    */
 293   uint32_t res GNUNET_PACKED;
 294
 295   /**
 296    * Length of the following string, zero if @e is #GNUNET_SYSERR
 297    */
 298   uint32_t addr_len GNUNET_PACKED;
 299 };
 300
 301
 302 /**
 303  * Message used to notify the transport service about a message
 304  * to be transmitted to another peer.  The actual message follows.
 305  */
 306 struct OutboundMessage
 307 {
 308
 309   /**
 310    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
 311    */
 312   struct GNUNET_MessageHeader header;
 313
 314   /**
 315    * Always zero.
 316    */
 317   uint32_t reserved GNUNET_PACKED;
 318
 319   /**
 320    * Allowed delay.
 321    */
 322   struct GNUNET_TIME_RelativeNBO timeout;
 323
 324   /**
 325    * Which peer should receive the message?
 326    */
 327   struct GNUNET_PeerIdentity peer;
 328
 329 };
 330
 331
 332 /**
 333  * Message from the library to the transport service
 334  * asking for converting a transport address to a
 335  * human-readable UTF-8 string.
 336  */
 337 struct AddressLookupMessage
 338 {
 339
 340   /**
 341    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
 342    */
 343   struct GNUNET_MessageHeader header;
 344
 345   /**
 346    * Should the conversion use numeric IP addresses (otherwise
 347    * a reverse DNS lookup is OK -- if applicable).
 348    */
 349   int16_t numeric_only GNUNET_PACKED;
 350
 351   /**
 352    * Length of the (binary) address in bytes, in big-endian.
 353    */
 354   uint16_t addrlen GNUNET_PACKED;
 355
 356   /**
 357    * timeout to give up (for DNS resolution timeout mostly)
 358    */
 359   struct GNUNET_TIME_RelativeNBO timeout;
 360
 361   /* followed by @e addrlen bytes of the actual address, then
 362    * followed by the 0-terminated name of the transport */
 363 };
 364
 365
 366 /**
 367  * Message from the transport service to the library containing information
 368  * about a peer. Information contained are:
 369  * - current address used to communicate with this peer
 370  * - state
 371  * - state timeout
 372  *
 373  * Memory layout:
 374  * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
 375  */
 376 struct ValidationIterateResponseMessage
 377 {
 378   /**
 379    * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE
 380    */
 381   struct GNUNET_MessageHeader header;
 382
 383   /**
 384    * For alignment.
 385    */
 386   uint32_t reserved;
 387
 388   /**
 389    * Peer identity
 390    */
 391   struct GNUNET_PeerIdentity peer;
 392
 393   /**
 394    * Local info about the address
 395    */
 396   uint32_t local_address_info GNUNET_PACKED;
 397
 398   /**
 399    * Address length
 400    */
 401   uint32_t addrlen GNUNET_PACKED;
 402
 403   /**
 404    * Length of the plugin name
 405    */
 406   uint32_t pluginlen GNUNET_PACKED;
 407
 408   /**
 409    * State
 410    */
 411   uint32_t state GNUNET_PACKED;
 412
 413   /**
 414    * At what time did we successfully validate the address last.
 415    * Will be NEVER if the address failed validation.
 416    */
 417   struct GNUNET_TIME_AbsoluteNBO last_validation;
 418
 419   /**
 420    * Until when is the address believed to be valid.
 421    * Will be ZERO if the address is not belived to be valid.
 422    */
 423   struct GNUNET_TIME_AbsoluteNBO valid_until;
 424
 425   /**
 426    * When will we next try to validate the address (typically
 427    * done before @e valid_until happens).
 428    */
 429   struct GNUNET_TIME_AbsoluteNBO next_validation;
 430 };
 431
 432 /**
 433  * Message from the library to the transport service
 434  * asking for binary addresses known for a peer.
 435  */
 436 struct ValidationMonitorMessage
 437 {
 438   /**
 439    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST
 440    */
 441   struct GNUNET_MessageHeader header;
 442
 443   /**
 444    * One shot call or continous replies?
 445    */
 446   uint32_t one_shot;
 447
 448   /**
 449    * The identity of the peer to look up.
 450    */
 451   struct GNUNET_PeerIdentity peer;
 452
 453 };
 454
 455
 456 /**
 457  * Message from the library to the transport service
 458  * asking for binary addresses known for a peer.
 459  */
 460 struct PeerMonitorMessage
 461 {
 462   /**
 463    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST
 464    */
 465   struct GNUNET_MessageHeader header;
 466
 467   /**
 468    * One shot call or continous replies?
 469    */
 470   uint32_t one_shot;
 471
 472   /**
 473    * The identity of the peer to look up.
 474    */
 475   struct GNUNET_PeerIdentity peer;
 476
 477 };
 478
 479
 480 /**
 481  * Message from the library to the transport service
 482  * asking for binary addresses known for a peer.
 483  */
 484 struct TrafficMetricMessage
 485 {
 486   /**
 487    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC
 488    */
 489   struct GNUNET_MessageHeader header;
 490
 491   /**
 492    * SEND, RECEIVE or BOTH?
 493    */
 494   uint16_t direction;
 495
 496   /**
 497    * Traffic metrics count
 498    */
 499   uint16_t ats_count;
 500
 501   /**
 502    * The identity of the peer to look up.
 503    */
 504   struct GNUNET_PeerIdentity peer;
 505 };
 506
 507
 508 /**
 509  * Message from the transport service to the library containing information
 510  * about a peer. Information contained are:
 511  * - current address used to communicate with this peer
 512  * - state
 513  * - state timeout
 514  *
 515  * Memory layout:
 516  * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
 517  */
 518 struct PeerIterateResponseMessage
 519 {
 520   /**
 521    * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE
 522    */
 523   struct GNUNET_MessageHeader header;
 524
 525   /**
 526    * For alignment.
 527    */
 528   uint32_t reserved;
 529
 530   /**
 531    * Peer identity
 532    */
 533   struct GNUNET_PeerIdentity peer;
 534
 535   /**
 536    * Timeout for the state this peer is in
 537    */
 538   struct GNUNET_TIME_AbsoluteNBO state_timeout;
 539
 540   /**
 541    * Local info about the address
 542    */
 543   uint32_t local_address_info GNUNET_PACKED;
 544
 545   /**
 546    * State this peer is in as an `enum GNUNET_TRANSPORT_PeerState`
 547    */
 548   uint32_t state GNUNET_PACKED;
 549
 550   /**
 551    * Address length
 552    */
 553   uint32_t addrlen GNUNET_PACKED;
 554
 555   /**
 556    * Length of the plugin name
 557    */
 558   uint32_t pluginlen GNUNET_PACKED;
 559
 560 };
 561
 562
 563 /**
 564  * Change in blacklisting (either request or notification,
 565  * depending on which direction it is going).
 566  */
 567 struct BlacklistMessage
 568 {
 569
 570   /**
 571    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
 572    * #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
 573    */
 574   struct GNUNET_MessageHeader header;
 575
 576   /**
 577    * 0 for the query, #GNUNET_OK (allowed) or #GNUNET_SYSERR (disallowed)
 578    * for the response.
 579    */
 580   uint32_t is_allowed GNUNET_PACKED;
 581
 582   /**
 583    * Which peer is being blacklisted or queried?
 584    */
 585   struct GNUNET_PeerIdentity peer;
 586
 587 };
 588
 589
 590 /**
 591  * Transport-level connection status update.
 592  */
 593 struct TransportPluginMonitorMessage
 594 {
 595
 596   /**
 597    * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT.
 598    */
 599   struct GNUNET_MessageHeader header;
 600
 601   /**
 602    * An `enum GNUNET_TRANSPORT_SessionState` in NBO.
 603    */
 604   uint16_t session_state GNUNET_PACKED;
 605
 606   /**
 607    * #GNUNET_YES if this is an inbound connection,
 608    * #GNUNET_NO if this is an outbound connection,
 609    * #GNUNET_SYSERR if connections of this plugin
 610    *             are so fundamentally bidirectional
 611    *             that they have no 'initiator'
 612    * Value given in NBO.
 613    */
 614   int16_t is_inbound GNUNET_PACKED;
 615
 616   /**
 617    * Number of messages waiting transmission.
 618    */
 619   uint32_t msgs_pending GNUNET_PACKED;
 620
 621   /**
 622    * Number of bytes waiting for transmission.
 623    */
 624   uint32_t bytes_pending GNUNET_PACKED;
 625
 626   /**
 627    * When will this transport plugin session time out?
 628    */
 629   struct GNUNET_TIME_AbsoluteNBO timeout;
 630
 631   /**
 632    * Until how long is this plugin currently blocked from reading?
 633    */
 634   struct GNUNET_TIME_AbsoluteNBO delay;
 635
 636   /**
 637    * Which peer is this connection for?
 638    */
 639   struct GNUNET_PeerIdentity peer;
 640
 641   /**
 642    * Unique identifier for the session.
 643    */
 644   uint64_t session_id;
 645
 646   /**
 647    * Length of the plugin name in bytes, including 0-termination.
 648    */
 649   uint16_t plugin_name_len GNUNET_PACKED;
 650
 651   /**
 652    * Length of the plugin address in bytes.
 653    */
 654   uint16_t plugin_address_len GNUNET_PACKED;
 655
 656   /* followed by 0-terminated plugin name and
 657      @e plugin_address_len bytes of plugin address */
 658
 659 };
 660
 661
 662 GNUNET_NETWORK_STRUCT_END
 663
 664 /* end of transport.h */
 665 #endif