src/include/gnunet_transport_service.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 include/gnunet_transport_service.h
  23  * @brief low-level P2P IO
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef GNUNET_TRANSPORT_SERVICE_H
  28 #define GNUNET_TRANSPORT_SERVICE_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 #include "gnunet_bandwidth_lib.h"
  39 #include "gnunet_configuration_lib.h"
  40 #include "gnunet_crypto_lib.h"
  41 #include "gnunet_connection_lib.h"
  42 #include "gnunet_scheduler_lib.h"
  43 #include "gnunet_time_lib.h"
  44
  45 /**
  46  * Version number of the transport API.
  47  */
  48 #define GNUNET_TRANSPORT_VERSION 0x00000000
  49
  50
  51 /**
  52  * Enum defining all known property types for ATS Enum values are used
  53  * in the GNUNET_TRANSPORT_ATS_Information struct as
  54  * (key,value)-pairs.
  55  *
  56  * Cost are always stored in uint32_t, so all units used to define costs
  57  * have to be normalized to fit in uint32_t [0 .. 4.294.967.295]
  58  *
  59  * To keep the elements ordered
  60  *    1..1024 : Values with a relation to cost
  61  * 1025..2048 : Values with a relation to quality
  62  * 2049..3072 : Values with a relation to availability
  63  *
  64  */
  65 enum GNUNET_TRANSPORT_ATS_Property
  66 {
  67
  68   /**
  69    * End of the array.
  70    */
  71   GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR = 0,
  72
  73   /* Cost related values */
  74   /* =================== */
  75
  76   /**
  77    * Volume based cost in financial units to transmit data
  78    *
  79    * Note: This value is not bound to a specific currency or unit and only
  80    * used locally.
  81    * "cent" just refers the smallest amount of money in the respective
  82    * currency.
  83    *
  84    * Unit: [cent/MB]
  85    *
  86    * Interpretation: less is better
  87    *
  88    * Examples:
  89    * LAN:  0 [cent/MB]
  90    * 2G : 10 [cent/MB]
  91    */
  92   GNUNET_TRANSPORT_ATS_COST_FINANCIAL_PER_VOLUME = 1,
  93
  94   /**
  95    * Time based cost in financial units to transmit data
  96    *
  97    * Note: This value is not bound to a specific currency or unit and only
  98    * used locally.
  99    * "cent" just refers the smallest amount of money in the respective
 100    * currency.
 101    *
 102    * Unit: [cent/h]
 103    *
 104    * Interpretation: less is better
 105    *
 106    * Examples:
 107    * LAN   :  0 [cent/h]
 108    * Dialup: 10 [cent/h]
 109    */
 110   GNUNET_TRANSPORT_ATS_COST_FINANCIAL_PER_TIME = 2,
 111
 112   /**
 113    * Computational costs
 114    *
 115    * Effort of preparing data to be sent with this transport
 116    * Includes encoding, encryption and conversion of data
 117    * Partial values can be summed up: c_sum = c_enc + c_enc + c_conv
 118    * Resulting values depend on local system properties, e.g. CPU
 119    *
 120    * Unit: [ms/GB]
 121    *
 122    * Interpretation: less is better
 123    *
 124    * Examples:
 125    *
 126    * HTTPS with AES CBC-256:    7,382
 127    * HTTPS with AES CBC-128:    5,279
 128    * HTTPS with RC4-1024:       2,652
 129    */
 130   GNUNET_TRANSPORT_ATS_COST_COMPUTATIONAL = 3,
 131
 132   /**
 133    * Energy consumption
 134    *
 135    * Energy consumption using this transport when sending with a certain
 136    * power at a certain bitrate. This is only an approximation based on:
 137    * Energy consumption E = P / D
 138    *
 139    * with:
 140    * Power P in Watt (J/s)
 141    * Datarate D in MBit/s
 142    *
 143    * Conversion between power P and dBm used by WLAN in radiotap's dBm TX power:
 144    *
 145    * Lp(dbm) = 10 log10 (P/ 1mW)
 146    *
 147    * => P = 1 mW  * 10^(Lp(dbm)/10)
 148    *
 149    * Unit: [mJ/MB]
 150    *
 151    * Interpretation: less is better
 152    *
 153    * Examples:
 154    *
 155    * LAN:       0
 156    * WLAN:      89 (600 mW @ 802.11g /w 54 MBit/s)
 157    * Bluetooth: 267 (100 mW @ BT2.0 EDR /w 3 MBit/s)
 158    */
 159   GNUNET_TRANSPORT_ATS_COST_ENERGY_CONSUMPTION = 4,
 160
 161   /**
 162    * Connect cost
 163    * How many bytes are transmitted to initiate a new connection using
 164    * this transport?
 165    *
 166    * Unit: [bytes]
 167    *
 168    * Interpretation: less is better
 169    *
 170    * Examples:
 171    *
 172    * UDP (No connection)      :
 173    *     0 bytes
 174    * TCP (TCP 3-Way handshake):
 175    *   220 bytes Ethernet,  172 bytes TCP/IP,  122 bytes TCP
 176    * HTTP (TCP + Header)      :
 177    *   477 bytes Ethernet,  429 bytes TCP/IP,  374 bytes TCP,  278 bytes HTTP
 178    * HTTPS  HTTP+TLS Handshake:
 179    *  2129 bytes Ethernet, 1975 bytes TCP/IP, 1755 bytes TCP, 1403 bytes HTTPS
 180    *
 181    * */
 182   GNUNET_TRANSPORT_ATS_COST_CONNECT = 5,
 183
 184   /**
 185    * Bandwidth cost
 186    *
 187    * How many bandwidth is available to consume?
 188    * Used to calculate which impact sending data with this transport has
 189    *
 190    * Unit: [kB/s]
 191    *
 192    * Interpretation: more is better
 193    *
 194    * Examples:
 195    * LAN:     12,800  (100 MBit/s)
 196    * WLAN:    6,912   (54 MBit/s)
 197    * Dial-up: 8       (64 Kbit/s)
 198    *
 199    */
 200   GNUNET_TRANSPORT_ATS_COST_BANDWITH_AVAILABLE = 6,
 201
 202   /**
 203    *  Network overhead
 204    *
 205    * How many bytes are sent over the wire when 1 kilobyte (1024 bytes)
 206    * of application data is transmitted?
 207    * A factor used with connect cost, bandwidth cost and energy cost
 208    * to describe the overhead produced by the transport protocol
 209    *
 210    * Unit: [bytes/kb]
 211    *
 212    * Interpretation: less is better
 213    *
 214    * Examples:
 215    *
 216    * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
 217    * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
 218    * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8  = 1090 [bytes/kb]
 219    * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8  = 1110 [bytes/kb]
 220    */
 221   GNUNET_TRANSPORT_ATS_COST_NETWORK_OVERHEAD = 7,
 222
 223
 224   /* Quality related values */
 225   /* ====================== */
 226
 227   /* Physical layer quality properties */
 228
 229   /**
 230    * Signal strength on physical layer
 231    *
 232    * Unit: [dBm]
 233    */
 234   GNUNET_TRANSPORT_ATS_QUALITY_PHY_SIGNAL_STRENGTH = 1025,
 235
 236   /**
 237    * Collision rate on physical layer
 238    *
 239    * Unit: [B/s]
 240    */
 241   GNUNET_TRANSPORT_ATS_QUALITY_PHY_COLLISION_RATE = 1026,
 242
 243   /**
 244    * Error rate on physical layer
 245    *
 246    * Unit: [B/s]
 247    */
 248   GNUNET_TRANSPORT_ATS_QUALITY_PHY_ERROR_RATE = 1027,
 249
 250   /* Network layer quality properties */
 251
 252   /**
 253    * Delay
 254    * Time between when the time packet is sent and the packet arrives
 255    *
 256    * Unit: [ms]
 257    *
 258    * Examples:
 259    *
 260    * LAN   :    1
 261    * WLAN  :    2
 262    * Dialup:  500
 263    */
 264   GNUNET_TRANSPORT_ATS_QUALITY_NET_DELAY = 1028,
 265
 266   /**
 267    * Jitter
 268    * Time variations of the delay
 269    * 1st derivative of a delay function
 270    *
 271    * Unit: [ms]
 272    */
 273   GNUNET_TRANSPORT_ATS_QUALITY_NET_JITTER = 1029,
 274
 275   /**
 276    * Error rate on network layer
 277    *
 278    * Unit: [B/s]
 279    *
 280    * Examples:
 281    *
 282    * LAN       :    0
 283    * WLAN      :  400
 284    * Bluetooth :  100
 285    * Note: This numbers are just assumptions as an example, not
 286    * measured or somehow determined
 287    */
 288   GNUNET_TRANSPORT_ATS_QUALITY_NET_ERRORRATE = 1030,
 289
 290   /**
 291    * Drop rate on network layer
 292    * Bytes actively dismissed by a network component during transmission
 293    * Reasons for dropped data can be full queues, congestion, quota violations...
 294    *
 295    * Unit: [B/s]
 296    *
 297    * Examples:
 298    *
 299    * LAN       :    0
 300    * WLAN      :  400
 301    * Bluetooth :  100
 302    * Note: This numbers are just assumptions as an example, not
 303    * measured or somehow determined
 304    */
 305   GNUNET_TRANSPORT_ATS_QUALITY_NET_DROPRATE = 1031,
 306
 307   /**
 308    * Loss rate on network layer
 309    * Bytes lost during transmission
 310    * Reasons can be collisions, ...
 311    *
 312    * Unit: [B/s]
 313    *
 314    * Examples:
 315    *
 316    * LAN       :    0
 317    * WLAN      :   40
 318    * Bluetooth :   10
 319    * Note: This numbers are just assumptions as an example, not measured
 320    * or somehow determined
 321    */
 322   GNUNET_TRANSPORT_ATS_QUALITY_NET_LOSSRATE = 1032,
 323
 324   /**
 325    * Throughput on network layer
 326    *
 327    * Unit: [kB/s]
 328    *
 329    * Examples:
 330    *
 331    * LAN   : 3400
 332    * WLAN  : 1200
 333    * Dialup:      4
 334    *
 335    */
 336   GNUNET_TRANSPORT_ATS_QUALITY_NET_THROUGHPUT = 1033,
 337
 338  /**
 339   * Distance on network layer
 340   *
 341   * Unit: []
 342   */
 343   GNUNET_TRANSPORT_ATS_QUALITY_NET_DISTANCE = 1034,
 344
 345
 346   /* Availability related values */
 347   /* =========================== */
 348
 349   /**
 350    * Is a peer reachable?
 351    */
 352   GNUNET_TRANSPORT_ATS_AVAILABILITY_REACHABLE = 2048,
 353
 354   /**
 355    * Is there a connection established to a peer using this transport
 356    */
 357   GNUNET_TRANSPORT_ATS_AVAILABILITY_CONNECTED = 2049
 358
 359 };
 360
 361
 362 /**
 363  * struct used to communicate the transport's properties like cost and
 364  * quality of service as well as high-level constraints on resource
 365  * consumption.
 366  *
 367  *                             +---+
 368  *  +-----------+ Constraints  |   |  Plugin properties +---------+
 369  *  | Highlevel |------------> |ATS| <------------------|Transport|
 370  *  | Component | ATS struct   |   |    ATS struct      | Plugin  |
 371  *  +-----------+              |   |                    +---------+
 372  *                             +---+
 373  *
 374  * This structure will be used by transport plugins to communicate
 375  * costs to ATS or by higher level components to tell ATS their
 376  * constraints.  Always a pair of (GNUNET_TRANSPORT_ATS_Property,
 377  * uint32_t value).  Value is always uint32_t, so all units used to
 378  * define costs have to be normalized to fit uint32_t.
 379  */
 380 struct GNUNET_TRANSPORT_ATS_Information
 381 {
 382   /**
 383    * ATS property type, in network byte order.
 384    */
 385   uint32_t type;
 386
 387   /**
 388    * ATS property value, in network byte order.
 389    */
 390   uint32_t value;
 391 };
 392
 393
 394
 395 /**
 396  * Function called by the transport for each received message.
 397  *
 398  * @param cls closure
 399  * @param peer (claimed) identity of the other peer
 400  * @param message the message
 401  * @param ats performance data
 402  * @param ats_count number of entries in ats (excluding 0-termination)
 403  */
 404 typedef void (*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
 405                                                   const struct
 406                                                   GNUNET_PeerIdentity * peer,
 407                                                   const struct
 408                                                   GNUNET_MessageHeader *
 409                                                   message,
 410                                                   const struct GNUNET_TRANSPORT_ATS_Information *ats,
 411                                                   uint32_t ats_count);
 412
 413
 414 /**
 415  * Opaque handle to the service.
 416  */
 417 struct GNUNET_TRANSPORT_Handle;
 418
 419
 420 /**
 421  * Function called to notify transport users that another
 422  * peer connected to us.
 423  *
 424  * @param cls closure
 425  * @param peer the peer that connected
 426  * @param ats performance data
 427  * @param ats_count number of entries in ats (excluding 0-termination)
 428  */
 429 typedef void
 430   (*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
 431                                      const struct GNUNET_PeerIdentity * peer,
 432                                      const struct GNUNET_TRANSPORT_ATS_Information *ats,
 433                                      uint32_t ats_count);
 434
 435 /**
 436  * Function called to notify transport users that another
 437  * peer disconnected from us.
 438  *
 439  * @param cls closure
 440  * @param peer the peer that disconnected
 441  */
 442 typedef void
 443   (*GNUNET_TRANSPORT_NotifyDisconnect) (void *cls,
 444                                         const struct GNUNET_PeerIdentity *
 445                                         peer);
 446
 447
 448 /**
 449  * Function to call with a human-readable format of an address
 450  *
 451  * @param cls closure
 452  * @param address NULL on error, otherwise 0-terminated printable UTF-8 string
 453  */
 454 typedef void
 455 (*GNUNET_TRANSPORT_AddressLookUpCallback) (void *cls,
 456                                            const char *address);
 457
 458
 459 /**
 460  * Connect to the transport service.  Note that the connection may
 461  * complete (or fail) asynchronously.
 462  *
 463  * @param cfg configuration to use
 464  * @param self our own identity (API should check that it matches
 465  *             the identity found by transport), or NULL (no check)
 466  * @param cls closure for the callbacks
 467  * @param rec receive function to call
 468  * @param nc function to call on connect events
 469  * @param nd function to call on disconnect events
 470  * @return NULL on error
 471  */
 472 struct GNUNET_TRANSPORT_Handle *GNUNET_TRANSPORT_connect (const struct
 473                                                           GNUNET_CONFIGURATION_Handle
 474                                                           *cfg,
 475                                                           const struct GNUNET_PeerIdentity *self,
 476                                                           void *cls,
 477                                                           GNUNET_TRANSPORT_ReceiveCallback
 478                                                           rec,
 479                                                           GNUNET_TRANSPORT_NotifyConnect
 480                                                           nc,
 481                                                           GNUNET_TRANSPORT_NotifyDisconnect
 482                                                           nd);
 483
 484
 485 /**
 486  * Disconnect from the transport service.
 487  *
 488  * @param handle handle returned from connect
 489  */
 490 void GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle);
 491
 492
 493 /**
 494  * Set the share of incoming/outgoing bandwidth for the given
 495  * peer to the specified amount.
 496  *
 497  * @param handle connection to transport service
 498  * @param target who's bandwidth quota is being changed
 499  * @param quota_in incoming bandwidth quota
 500  * @param quota_out outgoing bandwidth quota
 501  * @param timeout how long to wait until signaling failure if
 502  *        we can not communicate the quota change
 503  * @param cont continuation to call when done, will be called
 504  *        either with reason "TIMEOUT" or with reason "PREREQ_DONE"
 505  * @param cont_cls closure for continuation
 506  */
 507 void
 508 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
 509                             const struct GNUNET_PeerIdentity *target,
 510                             struct GNUNET_BANDWIDTH_Value32NBO quota_in,
 511                             struct GNUNET_BANDWIDTH_Value32NBO quota_out,
 512                             struct GNUNET_TIME_Relative timeout,
 513                             GNUNET_SCHEDULER_Task cont, void *cont_cls);
 514
 515
 516 /**
 517  * Opaque handle for a transmission-ready request.
 518  */
 519 struct GNUNET_TRANSPORT_TransmitHandle;
 520
 521
 522 /**
 523  * Check if we could queue a message of the given size for
 524  * transmission.  The transport service will take both its internal
 525  * buffers and bandwidth limits imposed by the other peer into
 526  * consideration when answering this query.
 527  *
 528  * @param handle connection to transport service
 529  * @param target who should receive the message
 530  * @param size how big is the message we want to transmit?
 531  * @param priority how important is the message?
 532  * @param timeout after how long should we give up (and call
 533  *        notify with buf NULL and size 0)?
 534  * @param notify function to call when we are ready to
 535  *        send such a message
 536  * @param notify_cls closure for notify
 537  * @return NULL if someone else is already waiting to be notified
 538  *         non-NULL if the notify callback was queued (can be used to cancel
 539  *         using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
 540  */
 541 struct GNUNET_TRANSPORT_TransmitHandle
 542   *GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
 543                                            *handle,
 544                                            const struct GNUNET_PeerIdentity
 545                                            *target, size_t size,
 546                                            uint32_t priority,
 547                                            struct GNUNET_TIME_Relative
 548                                            timeout,
 549                                            GNUNET_CONNECTION_TransmitReadyNotify
 550                                            notify, void *notify_cls);
 551
 552
 553 /**
 554  * Cancel the specified transmission-ready notification.
 555  *
 556  * @param h handle of the transmission notification request to cancel
 557  */
 558 void
 559 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
 560                                                GNUNET_TRANSPORT_TransmitHandle
 561                                                *h);
 562
 563
 564
 565 /**
 566  * Function called whenever there is an update to the
 567  * HELLO of this peer.
 568  *
 569  * @param cls closure
 570  * @param hello our updated HELLO
 571  */
 572 typedef void (*GNUNET_TRANSPORT_HelloUpdateCallback)(void *cls,
 573                                                      const struct GNUNET_MessageHeader *hello);
 574
 575
 576 /**
 577  * Obtain updates on changes to the HELLO message for this peer.
 578  *
 579  * @param handle connection to transport service
 580  * @param rec function to call with the HELLO
 581  * @param rec_cls closure for rec
 582  */
 583 void
 584 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
 585                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
 586                             void *rec_cls);
 587
 588
 589 /**
 590  * Stop receiving updates about changes to our HELLO message.
 591  *
 592  * @param handle connection to transport service
 593  * @param rec function previously registered to be called with the HELLOs
 594  * @param rec_cls closure for rec
 595  */
 596 void
 597 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_Handle *handle,
 598                                    GNUNET_TRANSPORT_HelloUpdateCallback rec,
 599                                    void *rec_cls);
 600
 601
 602 /**
 603  * Offer the transport service the HELLO of another peer.  Note that
 604  * the transport service may just ignore this message if the HELLO is
 605  * malformed or useless due to our local configuration.
 606  *
 607  * @param handle connection to transport service
 608  * @param hello the hello message
 609  * @param cont continuation to call when HELLO has been sent
 610  * @param cls closure for continuation
 611  *
 612  */
 613 void
 614 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
 615                               const struct GNUNET_MessageHeader *hello,
 616                               GNUNET_SCHEDULER_Task cont,
 617                               void *cls);
 618
 619
 620 /**
 621  * Convert a binary address into a human readable address.
 622  *
 623  * @param cfg configuration to use
 624  * @param address address to convert (binary format)
 625  * @param addressLen number of bytes in address
 626  * @param numeric should (IP) addresses be displayed in numeric form
 627  *                (otherwise do reverse DNS lookup)
 628  * @param nameTrans name of the transport to which the address belongs
 629  * @param timeout how long is the lookup allowed to take at most
 630  * @param aluc function to call with the results
 631  * @param aluc_cls closure for aluc
 632  */
 633 void
 634 GNUNET_TRANSPORT_address_lookup (const struct GNUNET_CONFIGURATION_Handle *cfg,
 635                                  const char * address,
 636                                  size_t addressLen,
 637                                  int numeric,
 638                                  const char * nameTrans,
 639                                  struct GNUNET_TIME_Relative timeout,
 640                                  GNUNET_TRANSPORT_AddressLookUpCallback aluc,
 641                                  void *aluc_cls);
 642
 643
 644
 645 /**
 646  * Handle for blacklisting peers.
 647  */
 648 struct GNUNET_TRANSPORT_Blacklist;
 649
 650
 651 /**
 652  * Function that decides if a connection is acceptable or not.
 653  *
 654  * @param cls closure
 655  * @param pid peer to approve or disapproave
 656  * @return GNUNET_OK if the connection is allowed
 657  */
 658 typedef int (*GNUNET_TRANSPORT_BlacklistCallback)(void *cls,
 659                                                   const struct GNUNET_PeerIdentity *pid);
 660
 661
 662 /**
 663  * Install a blacklist callback.  The service will be queried for all
 664  * existing connections as well as any fresh connections to check if
 665  * they are permitted.  If the blacklisting callback is unregistered,
 666  * all hosts that were denied in the past will automatically be
 667  * whitelisted again.  Cancelling the blacklist handle is also the
 668  * only way to re-enable connections from peers that were previously
 669  * blacklisted.
 670  *
 671  * @param cfg configuration to use
 672  * @param cb callback to invoke to check if connections are allowed
 673  * @param cb_cls closure for cb
 674  * @return NULL on error, otherwise handle for cancellation
 675  */
 676 struct GNUNET_TRANSPORT_Blacklist *
 677 GNUNET_TRANSPORT_blacklist (const struct GNUNET_CONFIGURATION_Handle *cfg,
 678                             GNUNET_TRANSPORT_BlacklistCallback cb,
 679                             void *cb_cls);
 680
 681
 682 /**
 683  * Abort the blacklist.  Note that this function is the only way for
 684  * removing a peer from the blacklist.
 685  *
 686  * @param br handle of the request that is to be cancelled
 687  */
 688 void
 689 GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br);
 690
 691
 692
 693 #if 0                           /* keep Emacsens' auto-indent happy */
 694 {
 695 #endif
 696 #ifdef __cplusplus
 697 }
 698 #endif
 699
 700 /* ifndef GNUNET_TRANSPORT_SERVICE_H */
 701 #endif
 702 /* end of gnunet_transport_service.h */