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
  39 /**
  40  * Opaque pointer that plugins can use to distinguish specific
  41  * connections to a given peer.  Typically used by stateful plugins to
  42  * allow the service to refer to specific streams instead of a more
  43  * general notion of "some connection" to the given peer.  This is
  44  * useful since sometimes (i.e. for inbound TCP connections) a
  45  * connection may not have an address that can be used for meaningful
  46  * distinction between sessions to the same peer.
  47  */
  48 struct Session;
  49
  50 /**
  51  * Every 'struct Session' must begin with this header.
  52  */
  53 struct SessionHeader
  54 {
  55
  56   /**
  57    * Cached signature for PONG generation for the session.  Do not use
  58    * in the plugin!
  59    */
  60   struct GNUNET_CRYPTO_RsaSignature pong_signature;
  61
  62   /**
  63    * Expiration time for signature.  Do not use in the plugin!
  64    */
  65   struct GNUNET_TIME_Absolute pong_sig_expires;
  66
  67 };
  68
  69 /**
  70  * Function that will be called whenever the plugin internally
  71  * cleans up a session pointer and hence the service needs to
  72  * discard all of those sessions as well.  Plugins that do not
  73  * use sessions can simply omit calling this function and always
  74  * use NULL wherever a session pointer is needed.
  75  *
  76  * @param cls closure
  77  * @param peer which peer was the session for
  78  * @param session which session is being destoyed
  79  */
  80 typedef void (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
  81                                              const struct GNUNET_PeerIdentity *peer,
  82                                              struct Session *session);
  83
  84
  85 /**
  86  * Function called by the transport for each received message.
  87  * This function should also be called with "NULL" for the
  88  * message to signal that the other peer disconnected.
  89  *
  90  * @param cls closure
  91  * @param peer (claimed) identity of the other peer
  92  * @param message the message, NULL if we only care about
  93  *                learning about the delay until we should receive again -- FIXME!
  94  * @param distance in overlay hops; use 1 unless DV (or 0 if message == NULL)
  95  * @param session identifier used for this session (NULL for plugins
  96  *                that do not offer bi-directional communication to the sender
  97  *                using the same "connection")
  98  * @param sender_address binary address of the sender (if we established the
  99  *                connection or are otherwise sure of it; should be NULL
 100  *                for inbound TCP/UDP connections since it it not clear
 101  *                that we could establish ourselves a connection to that
 102  *                IP address and get the same system)
 103  * @param sender_address_len number of bytes in sender_address
 104  * @return how long the plugin should wait until receiving more data
 105  *         (plugins that do not support this, can ignore the return value)
 106  */
 107 typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
 108                                                                                const struct
 109                                                                                GNUNET_PeerIdentity *
 110                                                                                peer,
 111                                                                                const struct
 112                                                                                GNUNET_MessageHeader *
 113                                                                                message,
 114                                                                                const struct GNUNET_TRANSPORT_ATS_Information *ats,
 115                                                                                uint32_t ats_count,
 116                                                                                struct Session *session,
 117                                                                                const char *sender_address,
 118                                                                                uint16_t sender_address_len);
 119
 120
 121 /**
 122  * Function that will be called for each address the transport
 123  * is aware that it might be reachable under.
 124  *
 125  * @param cls closure
 126  * @param add_remove should the address added (YES) or removed (NO) from the
 127  *                   set of valid addresses?
 128  * @param addr one of the addresses of the host
 129  *        the specific address format depends on the transport
 130  * @param addrlen length of the address
 131  */
 132 typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls,
 133                                                       int add_remove,
 134                                                       const void *addr,
 135                                                       size_t addrlen);
 136
 137
 138 /**
 139  * Function that will be called whenever the plugin receives data over
 140  * the network and wants to determine how long it should wait until
 141  * the next time it reads from the given peer.  Note that some plugins
 142  * (such as UDP) may not be able to wait (for a particular peer), so
 143  * the waiting part is optional.  Plugins that can wait should call
 144  * this function, sleep the given amount of time, and call it again
 145  * (with zero bytes read) UNTIL it returns zero and only then read.
 146  *
 147  * @param cls closure
 148  * @param peer which peer did we read data from
 149  * @param amount_recved number of bytes read (can be zero)
 150  * @return how long to wait until reading more from this peer
 151  *         (to enforce inbound quotas)
 152  */
 153 typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_TrafficReport) (void *cls,
 154                                                                       const struct
 155                                                                       GNUNET_PeerIdentity *peer,
 156                                                                       size_t amount_recved);
 157
 158
 159 /**
 160  * Function called whenever the plugin has to notify ATS about costs for using this transport
 161  *
 162  * The cost will be passed as struct GNUNET_TRANSPORT_ATS_Cost_Information[]
 163  * This array is 0-terminated, so the last element will be a pair:
 164  * ((cost->cost_type==GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR) && cost->cost_value==0))
 165  *
 166  * @param cls closure
 167  * @param peer peer
 168  * @param addr peer address
 169  * @param addrlen address length
 170  * @param cost pointer to the first element of struct GNUNET_TRANSPORT_ATS_Cost_Information[]
 171  */
 172 typedef void (*GNUNET_TRANSPORT_CostReport) (void *cls,
 173                                              const struct GNUNET_PeerIdentity *peer,
 174                                              const void *addr,
 175                                              uint16_t addrlen,
 176                                              struct GNUNET_TRANSPORT_ATS_Information * cost);
 177
 178
 179 /**
 180  * Function that returns a HELLO message.
 181  */
 182 typedef const struct GNUNET_MessageHeader * (*GNUNET_TRANSPORT_GetHelloCallback)(void);
 183
 184
 185 /**
 186  * The transport service will pass a pointer to a struct
 187  * of this type as the first and only argument to the
 188  * entry point of each transport plugin.
 189  */
 190 struct GNUNET_TRANSPORT_PluginEnvironment
 191 {
 192   /**
 193    * Configuration to use.
 194    */
 195   const struct GNUNET_CONFIGURATION_Handle *cfg;
 196
 197   /**
 198    * Identity of this peer.
 199    */
 200   const struct GNUNET_PeerIdentity *my_identity;
 201
 202   /**
 203    * Closure for the various callbacks.
 204    */
 205   void *cls;
 206
 207   /**
 208    * Handle for reporting statistics.
 209    */
 210   struct GNUNET_STATISTICS_Handle *stats;
 211
 212   /**
 213    * Function that should be called by the transport plugin
 214    * whenever a message is received.
 215    */
 216   GNUNET_TRANSPORT_PluginReceiveCallback receive;
 217
 218
 219   /**
 220    * Function that returns our HELLO.
 221    */
 222   GNUNET_TRANSPORT_GetHelloCallback get_our_hello;
 223
 224   /**
 225    * Function that must be called by each plugin to notify the
 226    * transport service about the addresses under which the transport
 227    * provided by the plugin can be reached.
 228    */
 229   GNUNET_TRANSPORT_AddressNotification notify_address;
 230
 231   /**
 232    * Inform service about traffic received, get information
 233    * about when we might be willing to receive more.
 234    */
 235   GNUNET_TRANSPORT_TrafficReport traffic_report;
 236
 237   /**
 238    * Function that must be called by the plugin when a non-NULL
 239    * session handle stops being valid (is destroyed).
 240    */
 241   GNUNET_TRANSPORT_SessionEnd session_end;
 242
 243   /**
 244    * Inform service about costs for using this transport plugin
 245    */
 246   GNUNET_TRANSPORT_CostReport cost_report;
 247
 248   /**
 249    * What is the maximum number of connections that this transport
 250    * should allow?  Transports that do not have sessions (such as
 251    * UDP) can ignore this value.
 252    */
 253   uint32_t max_connections;
 254
 255 };
 256
 257
 258 /**
 259  * Function called by the GNUNET_TRANSPORT_TransmitFunction
 260  * upon "completion".  In the case that a peer disconnects,
 261  * this function must be called for each pending request
 262  * (with a 'failure' indication) AFTER notifying the service
 263  * about the disconnect event (so that the service won't try
 264  * to transmit more messages, believing the connection still
 265  * exists...).
 266  *
 267  * @param cls closure
 268  * @param target who was the recipient of the message?
 269  * @param result GNUNET_OK on success
 270  *               GNUNET_SYSERR if the target disconnected;
 271  *               disconnect will ALSO be signalled using
 272  *               the ReceiveCallback.
 273  */
 274 typedef void
 275   (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
 276                                             const struct GNUNET_PeerIdentity *
 277                                             target, int result);
 278
 279
 280 /**
 281  * Function that can be used by the transport service to transmit
 282  * a message using the plugin.   Note that in the case of a
 283  * peer disconnecting, the continuation MUST be called
 284  * prior to the disconnect notification itself.  This function
 285  * will be called with this peer's HELLO message to initiate
 286  * a fresh connection to another peer.
 287  *
 288  * @param cls closure
 289  * @param target who should receive this message
 290  * @param msgbuf the message to transmit
 291  * @param msgbuf_size number of bytes in 'msgbuf'
 292  * @param priority how important is the message (most plugins will
 293  *                 ignore message priority and just FIFO)
 294  * @param timeout how long to wait at most for the transmission (does not
 295  *                require plugins to discard the message after the timeout,
 296  *                just advisory for the desired delay; most plugins will ignore
 297  *                this as well)
 298  * @param session which session must be used (or NULL for "any")
 299  * @param addr the address to use (can be NULL if the plugin
 300  *                is "on its own" (i.e. re-use existing TCP connection))
 301  * @param addrlen length of the address in bytes
 302  * @param force_address GNUNET_YES if the plugin MUST use the given address,
 303  *                GNUNET_NO means the plugin may use any other address and
 304  *                GNUNET_SYSERR means that only reliable existing
 305  *                bi-directional connections should be used (regardless
 306  *                of address)
 307  * @param cont continuation to call once the message has
 308  *        been transmitted (or if the transport is ready
 309  *        for the next transmission call; or if the
 310  *        peer disconnected...); can be NULL
 311  * @param cont_cls closure for cont
 312  * @return number of bytes used (on the physical network, with overheads);
 313  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 314  *         and does NOT mean that the message was not transmitted (DV)
 315  */
 316 typedef ssize_t
 317   (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
 318                                         const struct GNUNET_PeerIdentity *
 319                                         target,
 320                                         const char *msgbuf,
 321                                         size_t msgbuf_size,
 322                                         uint32_t priority,
 323                                         struct GNUNET_TIME_Relative timeout,
 324                                         struct Session *session,
 325                                         const void *addr,
 326                                         size_t addrlen,
 327                                         int force_address,
 328                                         GNUNET_TRANSPORT_TransmitContinuation
 329                                         cont, void *cont_cls);
 330
 331
 332 /**
 333  * Function that can be called to force a disconnect from the
 334  * specified neighbour.  This should also cancel all previously
 335  * scheduled transmissions.  Obviously the transmission may have been
 336  * partially completed already, which is OK.  The plugin is supposed
 337  * to close the connection (if applicable) and no longer call the
 338  * transmit continuation(s).
 339  *
 340  * Finally, plugin MUST NOT call the services's receive function to
 341  * notify the service that the connection to the specified target was
 342  * closed after a getting this call.
 343  *
 344  * @param cls closure
 345  * @param target peer for which the last transmission is
 346  *        to be cancelled
 347  */
 348 typedef void
 349   (*GNUNET_TRANSPORT_DisconnectFunction) (void *cls,
 350                                           const struct GNUNET_PeerIdentity *
 351                                           target);
 352
 353
 354 /**
 355  * Function called by the pretty printer for the resolved address for
 356  * each human-readable address obtained.
 357  *
 358  * @param cls closure
 359  * @param hostname one of the names for the host, NULL
 360  *        on the last call to the callback
 361  */
 362 typedef void (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
 363                                                         const char *address);
 364
 365
 366 /**
 367  * Convert the transports address to a nice, human-readable
 368  * format.
 369  *
 370  * @param cls closure
 371  * @param name name of the transport that generated the address
 372  * @param addr one of the addresses of the host, NULL for the last address
 373  *        the specific address format depends on the transport
 374  * @param addrlen length of the address
 375  * @param numeric should (IP) addresses be displayed in numeric form?
 376  * @param timeout after how long should we give up?
 377  * @param asc function to call on each string
 378  * @param asc_cls closure for asc
 379  */
 380 typedef void
 381   (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
 382                                             const char *type,
 383                                             const void *addr,
 384                                             size_t addrlen,
 385                                             int numeric,
 386                                             struct GNUNET_TIME_Relative
 387                                             timeout,
 388                                             GNUNET_TRANSPORT_AddressStringCallback
 389                                             asc, void *asc_cls);
 390
 391
 392 /**
 393  * Another peer has suggested an address for this peer and transport
 394  * plugin.  Check that this could be a valid address.  This function
 395  * is not expected to 'validate' the address in the sense of trying to
 396  * connect to it but simply to see if the binary format is technically
 397  * legal for establishing a connection to this peer (and make sure that
 398  * the address really corresponds to our network connection/settings
 399  * and not some potential man-in-the-middle).
 400  *
 401  * @param addr pointer to the address
 402  * @param addrlen length of addr
 403  * @return GNUNET_OK if this is a plausible address for this peer
 404  *         and transport, GNUNET_SYSERR if not
 405  */
 406 typedef int
 407 (*GNUNET_TRANSPORT_CheckAddress) (void *cls,
 408                                   const void *addr, size_t addrlen);
 409
 410
 411 /**
 412  * Function called for a quick conversion of the binary address to
 413  * a numeric address.  Note that the caller must not free the
 414  * address and that the next call to this function is allowed
 415  * to override the address again.
 416  *
 417  * @param cls closure
 418  * @param addr binary address
 419  * @param addr_len length of the address
 420  * @return string representing the same address
 421  */
 422 typedef const char* (*GNUNET_TRANSPORT_AddressToString) (void *cls,
 423                                                          const void *addr,
 424                                                          size_t addrlen);
 425
 426
 427 /**
 428  * Each plugin is required to return a pointer to a struct of this
 429  * type as the return value from its entry point.
 430  */
 431 struct GNUNET_TRANSPORT_PluginFunctions
 432 {
 433
 434   /**
 435    * Closure for all of the callbacks.
 436    */
 437   void *cls;
 438
 439   /**
 440    * Function that the transport service will use to transmit data to
 441    * another peer.  May be NULL for plugins that only support
 442    * receiving data.  After this call, the plugin call the specified
 443    * continuation with success or error before notifying us about the
 444    * target having disconnected.
 445    */
 446   GNUNET_TRANSPORT_TransmitFunction send;
 447
 448   /**
 449    * Function that can be used to force the plugin to disconnect from
 450    * the given peer and cancel all previous transmissions (and their
 451    * continuations).
 452    */
 453   GNUNET_TRANSPORT_DisconnectFunction disconnect;
 454
 455   /**
 456    * Function to pretty-print addresses.  NOTE: this function is not
 457    * yet used by transport-service, but will be used in the future
 458    * once the transport-API has been completed.
 459    */
 460   GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer;
 461
 462   /**
 463    * Function that will be called to check if a binary address
 464    * for this plugin is well-formed and corresponds to an
 465    * address for THIS peer (as per our configuration).  Naturally,
 466    * if absolutely necessary, plugins can be a bit conservative in
 467    * their answer, but in general plugins should make sure that the
 468    * address does not redirect traffic to a 3rd party that might
 469    * try to man-in-the-middle our traffic.
 470    */
 471   GNUNET_TRANSPORT_CheckAddress check_address;
 472
 473   /**
 474    * Function that will be called to convert a binary address
 475    * to a string (numeric conversion only).
 476    */
 477   GNUNET_TRANSPORT_AddressToString address_to_string;
 478
 479 };
 480
 481
 482 #endif