src/transport/transport.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 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
  76 typedef void (*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 GNUNET_NETWORK_STRUCT_BEGIN
  82
  83 /**
  84  * Message from the transport service to the library
  85  * asking to check if both processes agree about this
  86  * peers identity.
  87  */
  88 struct StartMessage
  89 {
  90
  91   /**
  92    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
  93    */
  94   struct GNUNET_MessageHeader header;
  95
  96   /**
  97    * 0: no options
  98    * 1: The 'self' field should be checked
  99    * 2: this client is interested in payload traffic
 100    */
 101   uint32_t options;
 102
 103   /**
 104    * Identity we think we have.  If it does not match, the
 105    * receiver should print out an error message and disconnect.
 106    */
 107   struct GNUNET_PeerIdentity self;
 108
 109 };
 110
 111
 112 /**
 113  * Message from the transport service to the library
 114  * informing about neighbors.
 115  */
 116 struct ConnectInfoMessage
 117 {
 118
 119   /**
 120    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
 121    */
 122   struct GNUNET_MessageHeader header;
 123
 124   /**
 125    * Identity of the new neighbour.
 126    */
 127   struct GNUNET_PeerIdentity id;
 128
 129   /**
 130    * Current inbound quota for this peer
 131    */
 132   struct GNUNET_BANDWIDTH_Value32NBO quota_in;
 133
 134   /**
 135    * Current outbound quota for this peer
 136    */
 137   struct GNUNET_BANDWIDTH_Value32NBO quota_out;
 138 };
 139
 140
 141 /**
 142  * Message from the transport service to the library
 143  * informing about disconnects.
 144  */
 145 struct DisconnectInfoMessage
 146 {
 147
 148   /**
 149    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
 150    */
 151   struct GNUNET_MessageHeader header;
 152
 153   /**
 154    * Reserved, always zero.
 155    */
 156   uint32_t reserved GNUNET_PACKED;
 157
 158   /**
 159    * Who got disconnected?
 160    */
 161   struct GNUNET_PeerIdentity peer;
 162
 163 };
 164
 165 /**
 166  * Message type for sending a request connect message
 167  * to the transport service.  Must be done before transport
 168  * api will allow messages to be queued/sent to transport
 169  * service for transmission to a peer.
 170  */
 171 struct TransportRequestConnectMessage
 172 {
 173   /**
 174    *  Message header
 175    */
 176   struct GNUNET_MessageHeader header;
 177
 178   /**
 179    * For alignment.
 180    */
 181   uint32_t reserved;
 182
 183   /**
 184    * Identity of the peer we would like to connect to.
 185    */
 186   struct GNUNET_PeerIdentity peer;
 187 };
 188
 189 /**
 190  * Message used to set a particular bandwidth quota.  Sent TO the
 191  * service to set an incoming quota, sent FROM the service to update
 192  * an outgoing quota.
 193  */
 194 struct QuotaSetMessage
 195 {
 196
 197   /**
 198    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
 199    */
 200   struct GNUNET_MessageHeader header;
 201
 202   /**
 203    * Quota.
 204    */
 205   struct GNUNET_BANDWIDTH_Value32NBO quota;
 206
 207   /**
 208    * About which peer are we talking here?
 209    */
 210   struct GNUNET_PeerIdentity peer;
 211
 212 };
 213
 214
 215 /**
 216  * Message used to notify the transport API about a message
 217  * received from the network.  The actual message follows.
 218  */
 219 struct InboundMessage
 220 {
 221
 222   /**
 223    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
 224    */
 225   struct GNUNET_MessageHeader header;
 226
 227   /**
 228    * Which peer sent the message?
 229    */
 230   struct GNUNET_PeerIdentity peer;
 231
 232 };
 233
 234
 235 /**
 236  * Message used to notify the transport API that it can
 237  * send another message to the transport service.
 238  */
 239 struct SendOkMessage
 240 {
 241
 242   /**
 243    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
 244    */
 245   struct GNUNET_MessageHeader header;
 246
 247   /**
 248    * GNUNET_OK if the transmission succeeded,
 249    * GNUNET_SYSERR if it failed (i.e. network disconnect);
 250    * in either case, it is now OK for this client to
 251    * send us another message for the given peer.
 252    */
 253   uint32_t success GNUNET_PACKED;
 254
 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    * Latency estimate.
 269    */
 270   struct GNUNET_TIME_RelativeNBO latency;
 271
 272   /**
 273    * Which peer can send more now?
 274    */
 275   struct GNUNET_PeerIdentity peer;
 276
 277 };
 278
 279
 280 /**
 281  * Message used to notify the transport service about a message
 282  * to be transmitted to another peer.  The actual message follows.
 283  */
 284 struct OutboundMessage
 285 {
 286
 287   /**
 288    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
 289    */
 290   struct GNUNET_MessageHeader header;
 291
 292   /**
 293    * Message priority.
 294    */
 295   uint32_t priority GNUNET_PACKED;
 296
 297   /**
 298    * Allowed delay.
 299    */
 300   struct GNUNET_TIME_RelativeNBO timeout;
 301
 302   /**
 303    * Which peer should receive the message?
 304    */
 305   struct GNUNET_PeerIdentity peer;
 306
 307 };
 308
 309
 310 /**
 311  * Message from the library to the transport service
 312  * asking for converting a transport address to a
 313  * human-readable UTF-8 string.
 314  */
 315 struct AddressLookupMessage
 316 {
 317
 318   /**
 319    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
 320    */
 321   struct GNUNET_MessageHeader header;
 322
 323   /**
 324    * Should the conversion use numeric IP addresses (otherwise
 325    * a reverse DNS lookup is OK -- if applicable).
 326    */
 327   int16_t numeric_only GNUNET_PACKED;
 328
 329   /**
 330    * Length of the (binary) address in bytes, in big-endian.
 331    */
 332   uint16_t addrlen GNUNET_PACKED;
 333
 334   /**
 335    * timeout to give up.
 336    */
 337   struct GNUNET_TIME_RelativeNBO timeout;
 338
 339   /* followed by 'addrlen' bytes of the actual address, then
 340    * followed by the 0-terminated name of the transport */
 341 };
 342
 343
 344 /**
 345  * Message from the library to the transport service
 346  * asking for human readable addresses known for a peer.
 347  */
 348 struct PeerAddressLookupMessage
 349 {
 350   /**
 351    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP
 352    */
 353   struct GNUNET_MessageHeader header;
 354
 355   /**
 356    * For alignment.
 357    */
 358   uint32_t reserved;
 359
 360   /**
 361    * timeout to give up.  FIXME: remove in the future.
 362    */
 363   struct GNUNET_TIME_RelativeNBO timeout;
 364
 365   /**
 366    * The identity of the peer to look up.
 367    */
 368   struct GNUNET_PeerIdentity peer;
 369 };
 370
 371
 372 /**
 373  * Message from the library to the transport service
 374  * asking for binary addresses known for a peer.
 375  */
 376 struct AddressIterateMessage
 377 {
 378   /**
 379    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE
 380    */
 381   struct GNUNET_MessageHeader header;
 382
 383   /**
 384    * One shot call or continous replies?
 385    */
 386   uint32_t one_shot;
 387
 388   /**
 389    * timeout to give up.  FIXME: remove in the future
 390    */
 391   struct GNUNET_TIME_AbsoluteNBO timeout;
 392
 393   /**
 394    * The identity of the peer to look up.
 395    */
 396   struct GNUNET_PeerIdentity peer;
 397
 398 };
 399
 400
 401 /**
 402  * Message from the library to the transport service
 403  * asking for binary addresses known for a peer.
 404  */
 405 struct TrafficMetricMessage
 406 {
 407   /**
 408    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC
 409    */
 410   struct GNUNET_MessageHeader header;
 411
 412   /**
 413    * SEND, RECEIVE or BOTH?
 414    */
 415   uint16_t direction;
 416
 417   /**
 418    * Traffic metrics count
 419    */
 420   uint16_t ats_count;
 421
 422   /**
 423    * The identity of the peer to look up.
 424    */
 425   struct GNUNET_PeerIdentity peer;
 426 };
 427
 428
 429 /**
 430  * Message from the transport service to the library
 431  * containing binary addresses known for a peer.
 432  * Memory layout:
 433  * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
 434  */
 435 struct AddressIterateResponseMessage
 436 {
 437   /**
 438    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE_RESPONSE
 439    */
 440   struct GNUNET_MessageHeader header;
 441
 442   /**
 443    * For alignment.
 444    */
 445   uint32_t reserved;
 446
 447     /**
 448    * Peer identity
 449    */
 450   struct GNUNET_PeerIdentity peer;
 451
 452   /**
 453    * address length
 454    */
 455   uint32_t addrlen GNUNET_PACKED;
 456
 457   /**
 458    * length of the plugin name
 459    */
 460   uint32_t pluginlen GNUNET_PACKED;
 461
 462 };
 463
 464
 465 /**
 466  * Change in blacklisting (either request or notification,
 467  * depending on which direction it is going).
 468  */
 469 struct BlacklistMessage
 470 {
 471
 472   /**
 473    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
 474    * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
 475    */
 476   struct GNUNET_MessageHeader header;
 477
 478   /**
 479    * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
 480    * for the response.
 481    */
 482   uint32_t is_allowed GNUNET_PACKED;
 483
 484   /**
 485    * Which peer is being blacklisted or queried?
 486    */
 487   struct GNUNET_PeerIdentity peer;
 488
 489 };
 490 GNUNET_NETWORK_STRUCT_END
 491
 492 /* end of transport.h */
 493 #endif