src/include/gnunet_transport_plugin.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2009, 2010 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_plugin.h
  23  * @brief API for the transport services.  This header
  24  *        specifies the struct that is given to the plugin's entry
  25  *        method and the other struct that must be returned.
  26  *        Note that the destructors of transport plugins will
  27  *        be given the value returned by the constructor
  28  *        and is expected to return a NULL pointer.
  29  * @author Christian Grothoff
  30  */
  31 #ifndef PLUGIN_TRANSPORT_H
  32 #define PLUGIN_TRANSPORT_H
  33
  34 #include "gnunet_configuration_lib.h"
  35 #include "gnunet_scheduler_lib.h"
  36 #include "gnunet_statistics_service.h"
  37 #include "gnunet_transport_service.h"
  38 #include "gnunet_ats_service.h"
  39
  40 #define TRANSPORT_SESSION_INBOUND_STRING "<inbound>"
  41
  42 /**
  43  * Opaque pointer that plugins can use to distinguish specific
  44  * connections to a given peer.  Typically used by stateful plugins to
  45  * allow the service to refer to specific streams instead of a more
  46  * general notion of "some connection" to the given peer.  This is
  47  * useful since sometimes (i.e. for inbound TCP connections) a
  48  * connection may not have an address that can be used for meaningful
  49  * distinction between sessions to the same peer.
  50  *
  51  * Each 'struct Session' MUST start with the 'struct GNUNET_PeerIdentity'
  52  * of the peer the session is for (which will be used for some error
  53  * checking by the ATS code).
  54  */
  55 struct Session;
  56
  57 /**
  58  * Every 'struct Session' must begin with this header.
  59  */
  60 struct SessionHeader
  61 {
  62   /* empty, for now */
  63 };
  64
  65
  66 /**
  67  * Function that will be called whenever the plugin internally
  68  * cleans up a session pointer and hence the service needs to
  69  * discard all of those sessions as well.  Plugins that do not
  70  * use sessions can simply omit calling this function and always
  71  * use NULL wherever a session pointer is needed.  This function
  72  * should be called BEFORE a potential "TransmitContinuation"
  73  * from the "TransmitFunction".
  74  *
  75  * @param cls closure
  76  * @param peer which peer was the session for
  77  * @param session which session is being destroyed
  78  */
  79 typedef void
  80 (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
  81                                 const struct GNUNET_PeerIdentity *peer,
  82                                 struct Session *session);
  83
  84 /**
  85  * Function that will be called whenever the plugin internally
  86  * creates a new session and hence transport need to tell ATS.
  87  * This happens when we have a inbound connection we did not
  88  * initiate.
  89  *
  90  * @param cls closure
  91  * @param peer peer
  92  * @param plugin plugin
  93  * @param address address
  94  * @param address_len length of the @a address
  95  * @param session session
  96  * @param ats ATS information
  97  * @param ats_count number of entries in @a ats array
  98  */
  99 typedef void
 100 (*GNUNET_TRANSPORT_SessionStart) (void *cls,
 101                                   const struct GNUNET_PeerIdentity *peer,
 102                                   const char *plugin,
 103                                   const void *address,
 104                                   uint16_t address_len,
 105                                   struct Session *session,
 106                                   const struct GNUNET_ATS_Information *ats,
 107                                   uint32_t ats_count);
 108
 109 /**
 110  * Function called by the transport for each received message.
 111  * This function should also be called with "NULL" for the
 112  * message to signal that the other peer disconnected.
 113  *
 114  * @param cls closure
 115  * @param peer (claimed) identity of the other peer
 116  * @param message the message, NULL if we only care about
 117  *                learning about the delay until we should receive again
 118  * @param session identifier used for this session (NULL for plugins
 119  *                that do not offer bi-directional communication to the sender
 120  *                using the same "connection")
 121  * @param sender_address binary address of the sender (if we established the
 122  *                connection or are otherwise sure of it; should be NULL
 123  *                for inbound TCP/UDP connections since it it not clear
 124  *                that we could establish ourselves a connection to that
 125  *                IP address and get the same system)
 126  * @param sender_address_len number of bytes in @a sender_address
 127  * @return how long the plugin should wait until receiving more data;
 128  *         returning #GNUNET_TIME_UNIT_FOREVER_REL means that the
 129  *         connection should be closed
 130  */
 131 typedef struct GNUNET_TIME_Relative
 132 (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
 133                                            const struct GNUNET_PeerIdentity *peer,
 134                                            const struct GNUNET_MessageHeader *message,
 135                                            struct Session *session,
 136                                            const char *sender_address,
 137                                            uint16_t sender_address_len);
 138
 139
 140 /**
 141  * Function that will be called to figure if an address is an loopback,
 142  * LAN, WAN etc. address
 143  *
 144  * @param cls closure
 145  * @param addr binary address
 146  * @param addrlen length of the @a addr
 147  * @return ATS Information containing the network type
 148  */
 149 typedef struct GNUNET_ATS_Information
 150 (*GNUNET_TRANSPORT_AddressToType) (void *cls,
 151                                    const struct sockaddr *addr,
 152                                    size_t addrlen);
 153
 154
 155 /**
 156  * Function called when quality properties of an address change.
 157  *
 158  * @param cls closure
 159  * @param peer peer
 160  * @param address address
 161  * @param address_len length of the @a address
 162  * @param session session
 163  * @param ats ATS information
 164  * @param ats_count number entries in the @a ats array
 165  */
 166 typedef void
 167 (*GNUNET_TRANSPORT_UpdateAddressMetrics) (void *cls,
 168                                           const struct GNUNET_PeerIdentity *peer,
 169                                           const void *address,
 170                                           uint16_t address_len,
 171                                           struct Session *session,
 172                                           const struct GNUNET_ATS_Information *ats,
 173                                           uint32_t ats_count);
 174
 175 /**
 176  * Function that will be called for each address the transport
 177  * is aware that it might be reachable under.
 178  *
 179  * @param cls closure
 180  * @param add_remove should the address added (#GNUNET_YES) or removed (#GNUNET_NO) from the
 181  *                   set of valid addresses?
 182  * @param addr one of the addresses of the host
 183  *        the specific address format depends on the transport
 184  * @param addrlen length of the @a addr
 185  * @param dest_plugin plugin to use this address with
 186  */
 187 typedef void
 188 (*GNUNET_TRANSPORT_AddressNotification) (void *cls,
 189                                          int add_remove,
 190                                          const void *addr,
 191                                          size_t addrlen,
 192                                          const char *dest_plugin);
 193
 194
 195 /**
 196  * Function that will be called whenever the plugin receives data over
 197  * the network and wants to determine how long it should wait until
 198  * the next time it reads from the given peer.  Note that some plugins
 199  * (such as UDP) may not be able to wait (for a particular peer), so
 200  * the waiting part is optional.  Plugins that can wait should call
 201  * this function, sleep the given amount of time, and call it again
 202  * (with zero bytes read) UNTIL it returns zero and only then read.
 203  *
 204  * @param cls closure
 205  * @param peer which peer did we read data from
 206  * @param amount_recved number of bytes read (can be zero)
 207  * @return how long to wait until reading more from this peer
 208  *         (to enforce inbound quotas); returning #GNUNET_TIME_UNIT_FOREVER_REL
 209  *         means that the connection should be closed
 210  */
 211 typedef struct GNUNET_TIME_Relative
 212 (*GNUNET_TRANSPORT_TrafficReport) (void *cls,
 213                                    const struct GNUNET_PeerIdentity *peer,
 214                                    size_t amount_recved);
 215
 216
 217 /**
 218  * Function that returns a HELLO message.
 219  */
 220 typedef const struct GNUNET_MessageHeader *
 221 (*GNUNET_TRANSPORT_GetHelloCallback) (void);
 222
 223
 224 /**
 225  * The transport service will pass a pointer to a struct
 226  * of this type as the first and only argument to the
 227  * entry point of each transport plugin.
 228  */
 229 struct GNUNET_TRANSPORT_PluginEnvironment
 230 {
 231   /**
 232    * Configuration to use.
 233    */
 234   const struct GNUNET_CONFIGURATION_Handle *cfg;
 235
 236   /**
 237    * Identity of this peer.
 238    */
 239   const struct GNUNET_PeerIdentity *my_identity;
 240
 241   /**
 242    * Closure for the various callbacks.
 243    */
 244   void *cls;
 245
 246   /**
 247    * Handle for reporting statistics.
 248    */
 249   struct GNUNET_STATISTICS_Handle *stats;
 250
 251   /**
 252    * Function that should be called by the transport plugin
 253    * whenever a message is received.  If this field is "NULL",
 254    * the plugin should load in 'stub' mode and NOT fully
 255    * initialize and instead only return an API with the
 256    * 'address_pretty_printer', 'address_to_string' and
 257    * 'string_to_address' functions.
 258    */
 259   GNUNET_TRANSPORT_PluginReceiveCallback receive;
 260
 261   /**
 262    * Function that returns our HELLO.
 263    */
 264   GNUNET_TRANSPORT_GetHelloCallback get_our_hello;
 265
 266   /**
 267    * Function that must be called by each plugin to notify the
 268    * transport service about the addresses under which the transport
 269    * provided by the plugin can be reached.
 270    */
 271   GNUNET_TRANSPORT_AddressNotification notify_address;
 272
 273   /**
 274    * Function that must be called by the plugin when a non-NULL
 275    * session handle stops being valid (is destroyed).
 276    */
 277   GNUNET_TRANSPORT_SessionEnd session_end;
 278
 279   /**
 280    * Function called by the plugin when a new (incoming) session was created
 281    * not explicitly created using the the get_session function
 282    */
 283   GNUNET_TRANSPORT_SessionStart session_start;
 284
 285   /**
 286    * Function that will be called to figure if an address is an loopback,
 287    * LAN, WAN etc. address
 288    */
 289   GNUNET_TRANSPORT_AddressToType get_address_type;
 290
 291   /**
 292    * Function that will be called to figure if an address is an loopback,
 293    * LAN, WAN etc. address
 294    */
 295   GNUNET_TRANSPORT_UpdateAddressMetrics update_address_metrics;
 296
 297
 298   /**
 299    * What is the maximum number of connections that this transport
 300    * should allow?  Transports that do not have sessions (such as
 301    * UDP) can ignore this value.
 302    */
 303   uint32_t max_connections;
 304
 305 };
 306
 307
 308 /**
 309  * Function called by the #GNUNET_TRANSPORT_TransmitFunction
 310  * upon "completion".  In the case that a peer disconnects,
 311  * this function must be called for each pending request
 312  * (with a 'failure' indication) AFTER notifying the service
 313  * about the disconnect event (so that the service won't try
 314  * to transmit more messages, believing the connection still
 315  * exists...).
 316  *
 317  * @param cls closure
 318  * @param target who was the recipient of the message?
 319  * @param result #GNUNET_OK on success
 320  *               #GNUNET_SYSERR if the target disconnected;
 321  *               disconnect will ALSO be signalled using
 322  *               the ReceiveCallback.
 323  * @param size_payload bytes of payload from transport service in message
 324  * @param size_on_wire bytes required on wire for transmission,
 325  *               0 if result == #GNUNET_SYSERR
 326  */
 327 typedef void
 328 (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
 329                                           const struct GNUNET_PeerIdentity *target,
 330                                           int result,
 331                                           size_t size_payload,
 332                                           size_t size_on_wire);
 333
 334
 335 /**
 336  * The new send function with just the session and no address
 337  *
 338  * Function that can be used by the transport service to transmit
 339  * a message using the plugin.   Note that in the case of a
 340  * peer disconnecting, the continuation MUST be called
 341  * prior to the disconnect notification itself.  This function
 342  * will be called with this peer's HELLO message to initiate
 343  * a fresh connection to another peer.
 344  *
 345  * @param cls closure
 346  * @param session which session must be used
 347  * @param msgbuf the message to transmit
 348  * @param msgbuf_size number of bytes in @a msgbuf
 349  * @param priority how important is the message (most plugins will
 350  *                 ignore message priority and just FIFO)
 351  * @param to how long to wait at most for the transmission (does not
 352  *                require plugins to discard the message after the timeout,
 353  *                just advisory for the desired delay; most plugins will ignore
 354  *                this as well)
 355  * @param cont continuation to call once the message has
 356  *        been transmitted (or if the transport is ready
 357  *        for the next transmission call; or if the
 358  *        peer disconnected...); can be NULL
 359  * @param cont_cls closure for @a cont
 360  * @return number of bytes used (on the physical network, with overheads);
 361  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 362  *         and does NOT mean that the message was not transmitted (DV)
 363  */
 364 typedef ssize_t
 365 (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
 366                                       struct Session *session,
 367                                       const char *msgbuf,
 368                                       size_t msgbuf_size,
 369                                       unsigned int priority,
 370                                       struct GNUNET_TIME_Relative to,
 371                                       GNUNET_TRANSPORT_TransmitContinuation cont,
 372                                       void *cont_cls);
 373
 374
 375 /**
 376  * Function that can be called to force a disconnect from the
 377  * specified neighbour for the given session only.  .  This should
 378  * also cancel all previously scheduled transmissions for this
 379  * session.  Obviously the transmission may have been partially
 380  * completed already, which is OK.  The plugin is supposed to close
 381  * the connection (if applicable).
 382  *
 383  * @param cls closure with the `struct Plugin`
 384  * @param session session to destroy
 385  * @return #GNUNET_OK on success
 386  */
 387 typedef int
 388 (*GNUNET_TRANSPORT_DisconnectSessionFunction) (void *cls,
 389                                                struct Session *session);
 390
 391 /**
 392  * Function that is called to get the keepalive factor.
 393  * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
 394  * calculate the interval between keepalive packets.
 395  *
 396  * @param cls closure with the `struct Plugin`
 397  * @return keepalive factor
 398  */
 399 typedef unsigned int
 400 (*GNUNET_TRANSPORT_QueryKeepaliveFactorFunction) (void *cls);
 401
 402
 403 /**
 404  * Function that can be called to force a disconnect from the
 405  * specified neighbour.  This should also cancel all previously
 406  * scheduled transmissions.  Obviously the transmission may have been
 407  * partially completed already, which is OK.  The plugin is supposed
 408  * to close the connection (if applicable) and no longer call the
 409  * transmit continuation(s).
 410  *
 411  * @param cls closure
 412  * @param target peer for which the last transmission is
 413  *        to be cancelled
 414  */
 415 typedef void
 416 (*GNUNET_TRANSPORT_DisconnectPeerFunction) (void *cls,
 417                                             const struct GNUNET_PeerIdentity *target);
 418
 419
 420 /**
 421  * Function called by the pretty printer for the resolved address for
 422  * each human-readable address obtained.
 423  *
 424  * @param cls closure
 425  * @param address one of the names for the host, NULL
 426  *        on the last call to the callback
 427  */
 428 typedef void
 429 (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
 430                                            const char *address);
 431
 432
 433 /**
 434  * Convert the transports address to a nice, human-readable
 435  * format.
 436  *
 437  * @param cls closure
 438  * @param type name of the transport that generated the address
 439  * @param addr one of the addresses of the host, NULL for the last address
 440  *        the specific address format depends on the transport
 441  * @param addrlen length of the @a addr
 442  * @param numeric should (IP) addresses be displayed in numeric form?
 443  * @param timeout after how long should we give up?
 444  * @param asc function to call on each string
 445  * @param asc_cls closure for @a asc
 446  */
 447 typedef void
 448 (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
 449                                           const char *type,
 450                                           const void *addr,
 451                                           size_t addrlen,
 452                                           int numeric,
 453                                           struct GNUNET_TIME_Relative timeout,
 454                                           GNUNET_TRANSPORT_AddressStringCallback asc,
 455                                           void *asc_cls);
 456
 457
 458 /**
 459  * Another peer has suggested an address for this peer and transport
 460  * plugin.  Check that this could be a valid address.  This function
 461  * is not expected to 'validate' the address in the sense of trying to
 462  * connect to it but simply to see if the binary format is technically
 463  * legal for establishing a connection to this peer (and make sure that
 464  * the address really corresponds to our network connection/settings
 465  * and not some potential man-in-the-middle).
 466  *
 467  * @param addr pointer to the address
 468  * @param addrlen length of @a addr
 469  * @return #GNUNET_OK if this is a plausible address for this peer
 470  *         and transport, #GNUNET_SYSERR if not
 471  */
 472 typedef int
 473 (*GNUNET_TRANSPORT_CheckAddress) (void *cls,
 474                                   const void *addr,
 475                                   size_t addrlen);
 476
 477
 478 /**
 479  * Create a new session to transmit data to the target
 480  * This session will used to send data to this peer and the plugin will
 481  * notify us by calling the env->session_end function
 482  *
 483  * @param cls the plugin
 484  * @param address the hello address
 485  * @return the session if the address is valid, NULL otherwise
 486  */
 487 typedef struct Session *
 488 (*GNUNET_TRANSPORT_CreateSession) (void *cls,
 489                                    const struct GNUNET_HELLO_Address *address);
 490
 491
 492 /**
 493  * Function that will be called whenever the transport service wants to
 494  * notify the plugin that a session is still active and in use and
 495  * therefore the session timeout for this session has to be updated
 496  *
 497  * @param cls closure
 498  * @param peer which peer was the session for
 499  * @param session which session is being updated
 500  */
 501 typedef void
 502 (*GNUNET_TRANSPORT_UpdateSessionTimeout) (void *cls,
 503                                           const struct GNUNET_PeerIdentity *peer,
 504                                           struct Session *session);
 505
 506 /**
 507  * Function called for a quick conversion of the binary address to
 508  * a numeric address.  Note that the caller must not free the
 509  * address and that the next call to this function is allowed
 510  * to override the address again.
 511  *
 512  * @param cls closure
 513  * @param addr binary address
 514  * @param addr_len length of the @a addr
 515  * @return string representing the same address
 516  */
 517 typedef const char *
 518 (*GNUNET_TRANSPORT_AddressToString) (void *cls,
 519                                      const void *addr,
 520                                      size_t addrlen);
 521
 522
 523 /**
 524  * Function called to convert a string address to
 525  * a binary address.
 526  *
 527  * @param cls closure (`struct Plugin*`)
 528  * @param addr string address
 529  * @param addrlen length of the @a addr including \0 termination
 530  * @param buf location to store the buffer
 531  *        If the function returns #GNUNET_SYSERR, its contents are undefined.
 532  * @param added length of created address
 533  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
 534  */
 535 typedef int
 536 (*GNUNET_TRANSPORT_StringToAddress) (void *cls,
 537                                      const char *addr,
 538                                      uint16_t addrlen,
 539                                      void **buf,
 540                                      size_t *added);
 541
 542
 543 /**
 544  * Function to obtain the network type for a session
 545  *
 546  * @param cls closure ('struct Plugin*')
 547  * @param session the session
 548  * @return the network type
 549  */
 550 typedef enum GNUNET_ATS_Network_Type
 551 (*GNUNET_TRANSPORT_GetNetworkType) (void *cls,
 552                                     struct Session *session);
 553
 554
 555 /**
 556  * Each plugin is required to return a pointer to a struct of this
 557  * type as the return value from its entry point.
 558  */
 559 struct GNUNET_TRANSPORT_PluginFunctions
 560 {
 561
 562   /**
 563    * Closure for all of the callbacks.
 564    */
 565   void *cls;
 566
 567   /**
 568    * Function that the transport service will use to transmit data to
 569    * another peer.  May be NULL for plugins that only support
 570    * receiving data.  After this call, the plugin call the specified
 571    * continuation with success or error before notifying us about the
 572    * target having disconnected.
 573    */
 574   GNUNET_TRANSPORT_TransmitFunction send;
 575
 576   /**
 577    * Function that can be used to force the plugin to disconnect from
 578    * the given peer and cancel all previous transmissions (and their
 579    * continuations).
 580    */
 581   GNUNET_TRANSPORT_DisconnectPeerFunction disconnect_peer;
 582
 583   /**
 584    * Function that can be used to force the plugin to disconnect from
 585    * the given peer and cancel all previous transmissions (and their
 586    * continuations).
 587    */
 588   GNUNET_TRANSPORT_DisconnectSessionFunction disconnect_session;
 589
 590   /**
 591    * Function that will be called whenever the transport service wants to
 592    * notify the plugin that a session is still active and in use and
 593    * therefore the session timeout for this session has to be updated
 594    */
 595   GNUNET_TRANSPORT_UpdateSessionTimeout update_session_timeout;
 596
 597   /**
 598    * Function that is used to query keepalive factor.
 599    * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
 600    * calculate the interval between keepalive packets.
 601    */
 602   GNUNET_TRANSPORT_QueryKeepaliveFactorFunction query_keepalive_factor;
 603
 604   /**
 605    * Function to pretty-print addresses.  NOTE: this function is not
 606    * yet used by transport-service, but will be used in the future
 607    * once the transport-API has been completed.
 608    */
 609   GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer;
 610
 611   /**
 612    * Function that will be called to check if a binary address
 613    * for this plugin is well-formed and corresponds to an
 614    * address for THIS peer (as per our configuration).  Naturally,
 615    * if absolutely necessary, plugins can be a bit conservative in
 616    * their answer, but in general plugins should make sure that the
 617    * address does not redirect traffic to a 3rd party that might
 618    * try to man-in-the-middle our traffic.
 619    */
 620   GNUNET_TRANSPORT_CheckAddress check_address;
 621
 622   /**
 623    * Function that will be called to convert a binary address
 624    * to a string (numeric conversion only).
 625    */
 626   GNUNET_TRANSPORT_AddressToString address_to_string;
 627
 628   /**
 629    * Function that will be called to convert a string address
 630    * to binary (numeric conversion only).
 631    */
 632   GNUNET_TRANSPORT_StringToAddress string_to_address;
 633
 634   /**
 635    * Function that will be called tell the plugin to create a session
 636    * object
 637    */
 638   GNUNET_TRANSPORT_CreateSession get_session;
 639
 640   /**
 641    * Function to obtain the network type for a session
 642    */
 643   GNUNET_TRANSPORT_GetNetworkType get_network;
 644 };
 645
 646
 647 #endif