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