src/transport/plugin_transport_template.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file transport/plugin_transport_template.c
  23  * @brief template for a new transport service
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_protocols.h"
  29 #include "gnunet_connection_lib.h"
  30 #include "gnunet_server_lib.h"
  31 #include "gnunet_service_lib.h"
  32 #include "gnunet_statistics_service.h"
  33 #include "gnunet_transport_service.h"
  34 #include "gnunet_transport_plugin.h"
  35
  36 #define LOG(kind,...) GNUNET_log_from (kind, "transport-template",__VA_ARGS__)
  37
  38 /**
  39  * After how long do we expire an address that we
  40  * learned from another peer if it is not reconfirmed
  41  * by anyone?
  42  */
  43 #define LEARNED_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
  44
  45 #define PLUGIN_NAME "template"
  46
  47 /**
  48  * Encapsulation of all of the state of the plugin.
  49  */
  50 struct Plugin;
  51
  52
  53 /**
  54  * Session handle for connections.
  55  */
  56 struct Session
  57 {
  58   /**
  59    * To whom are we talking to (set to our identity
  60    * if we are still waiting for the welcome message)
  61    */
  62   struct GNUNET_PeerIdentity sender;
  63
  64   /**
  65    * Stored in a linked list.
  66    */
  67   struct Session *next;
  68
  69   /**
  70    * Pointer to the global plugin struct.
  71    */
  72   struct Plugin *plugin;
  73
  74   /**
  75    * The client (used to identify this connection)
  76    */
  77   /* void *client; */
  78
  79   /**
  80    * Continuation function to call once the transmission buffer
  81    * has again space available.  NULL if there is no
  82    * continuation to call.
  83    */
  84   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
  85
  86   /**
  87    * Closure for transmit_cont.
  88    */
  89   void *transmit_cont_cls;
  90
  91   /**
  92    * At what time did we reset last_received last?
  93    */
  94   struct GNUNET_TIME_Absolute last_quota_update;
  95
  96   /**
  97    * How many bytes have we received since the "last_quota_update"
  98    * timestamp?
  99    */
 100   uint64_t last_received;
 101
 102   /**
 103    * Number of bytes per ms that this peer is allowed
 104    * to send to us.
 105    */
 106   uint32_t quota;
 107
 108 };
 109
 110 #define GNUNET_NETWORK_STRUCT_BEGIN
 111
 112 struct TemplateAddress
 113 {
 114         /**
 115          * Address options in NBO
 116          */
 117         uint32_t options GNUNET_PACKED;
 118
 119         /* Add address here */
 120 };
 121
 122 GNUNET_NETWORK_STRUCT_END
 123
 124 /**
 125  * Encapsulation of all of the state of the plugin.
 126  */
 127 struct Plugin
 128 {
 129   /**
 130    * Our environment.
 131    */
 132   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 133
 134   /**
 135    * List of open sessions.
 136    */
 137   struct Session *sessions;
 138
 139   /**
 140    * Options in HBO to be used with addresses
 141    */
 142
 143 };
 144
 145
 146 /**
 147  * Function that can be used by the transport service to transmit
 148  * a message using the plugin.   Note that in the case of a
 149  * peer disconnecting, the continuation MUST be called
 150  * prior to the disconnect notification itself.  This function
 151  * will be called with this peer's HELLO message to initiate
 152  * a fresh connection to another peer.
 153  *
 154  * @param cls closure
 155  * @param session which session must be used
 156  * @param msgbuf the message to transmit
 157  * @param msgbuf_size number of bytes in 'msgbuf'
 158  * @param priority how important is the message (most plugins will
 159  *                 ignore message priority and just FIFO)
 160  * @param to how long to wait at most for the transmission (does not
 161  *                require plugins to discard the message after the timeout,
 162  *                just advisory for the desired delay; most plugins will ignore
 163  *                this as well)
 164  * @param cont continuation to call once the message has
 165  *        been transmitted (or if the transport is ready
 166  *        for the next transmission call; or if the
 167  *        peer disconnected...); can be NULL
 168  * @param cont_cls closure for cont
 169  * @return number of bytes used (on the physical network, with overheads);
 170  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 171  *         and does NOT mean that the message was not transmitted (DV)
 172  */
 173 static ssize_t
 174 template_plugin_send (void *cls,
 175                   struct Session *session,
 176                   const char *msgbuf, size_t msgbuf_size,
 177                   unsigned int priority,
 178                   struct GNUNET_TIME_Relative to,
 179                   GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
 180 {
 181   struct Plugin *plugin = cls;
 182   int bytes_sent = 0;
 183
 184   GNUNET_assert (plugin != NULL);
 185   GNUNET_assert (session != NULL);
 186
 187   /*  struct Plugin *plugin = cls; */
 188   return bytes_sent;
 189 }
 190
 191
 192
 193 /**
 194  * Function that can be used to force the plugin to disconnect
 195  * from the given peer and cancel all previous transmissions
 196  * (and their continuationc).
 197  *
 198  * @param cls closure
 199  * @param target peer from which to disconnect
 200  */
 201 static void
 202 template_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
 203 {
 204   // struct Plugin *plugin = cls;
 205   // FIXME
 206 }
 207
 208 /**
 209  * Function obtain the network type for a session
 210  *
 211  * @param cls closure ('struct Plugin*')
 212  * @param session the session
 213  * @return the network type in HBO or GNUNET_SYSERR
 214  */
 215 static enum GNUNET_ATS_Network_Type
 216 template_plugin_get_network (void *cls, void *session)
 217 {
 218         struct Session *s = (struct Session *) session;
 219         GNUNET_assert (NULL != s);
 220         return GNUNET_ATS_NET_UNSPECIFIED; /* Change to correct network type */
 221 }
 222
 223 /**
 224  * Convert the transports address to a nice, human-readable
 225  * format.
 226  *
 227  * @param cls closure
 228  * @param type name of the transport that generated the address
 229  * @param addr one of the addresses of the host, NULL for the last address
 230  *        the specific address format depends on the transport
 231  * @param addrlen length of the address
 232  * @param numeric should (IP) addresses be displayed in numeric form?
 233  * @param timeout after how long should we give up?
 234  * @param asc function to call on each string
 235  * @param asc_cls closure for asc
 236  */
 237 static void
 238 template_plugin_address_pretty_printer (void *cls, const char *type,
 239                                         const void *addr, size_t addrlen,
 240                                         int numeric,
 241                                         struct GNUNET_TIME_Relative timeout,
 242                                         GNUNET_TRANSPORT_AddressStringCallback
 243                                         asc, void *asc_cls)
 244 {
 245   asc (asc_cls, NULL);
 246 }
 247
 248
 249
 250 /**
 251  * Another peer has suggested an address for this
 252  * peer and transport plugin.  Check that this could be a valid
 253  * address.  If so, consider adding it to the list
 254  * of addresses.
 255  *
 256  * @param cls closure
 257  * @param addr pointer to the address
 258  * @param addrlen length of addr
 259  * @return GNUNET_OK if this is a plausible address for this peer
 260  *         and transport
 261  */
 262 static int
 263 template_plugin_address_suggested (void *cls, const void *addr, size_t addrlen)
 264 {
 265   /* struct Plugin *plugin = cls; */
 266
 267   /* check if the address is belonging to the plugin*/
 268   return GNUNET_OK;
 269 }
 270
 271
 272 /**
 273  * Function called for a quick conversion of the binary address to
 274  * a numeric address.  Note that the caller must not free the
 275  * address and that the next call to this function is allowed
 276  * to override the address again.
 277  *
 278  * @param cls closure
 279  * @param addr binary address
 280  * @param addrlen length of the address
 281  * @return string representing the same address
 282  */
 283 static const char *
 284 template_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
 285 {
 286         /*
 287          * Parse string in format template.options.address
 288          */
 289
 290   GNUNET_break (0);
 291   return NULL;
 292 }
 293
 294
 295 /**
 296  * Function called to convert a string address to
 297  * a binary address.
 298  *
 299  * @param cls closure ('struct Plugin*')
 300  * @param addr string address
 301  * @param addrlen length of the address
 302  * @param buf location to store the buffer
 303  * @param added location to store the number of bytes in the buffer.
 304  *        If the function returns GNUNET_SYSERR, its contents are undefined.
 305  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 306  */
 307 static int
 308 template_plugin_string_to_address (void *cls, const char *addr, uint16_t addrlen,
 309     void **buf, size_t *added)
 310 {
 311
 312         /*
 313          * Print address in format template.options.address
 314          */
 315
 316   GNUNET_break (0);
 317   return GNUNET_SYSERR;
 318 }
 319
 320
 321 /**
 322  * Create a new session to transmit data to the target
 323  * This session will used to send data to this peer and the plugin will
 324  * notify us by calling the env->session_end function
 325  *
 326  * @param cls closure
 327  * @param address pointer to the GNUNET_HELLO_Address
 328  * @return the session if the address is valid, NULL otherwise
 329  */
 330 static struct Session *
 331 template_plugin_get_session (void *cls,
 332                         const struct GNUNET_HELLO_Address *address)
 333 {
 334   GNUNET_break (0);
 335   return NULL;
 336 }
 337
 338 /**
 339  * Entry point for the plugin.
 340  */
 341 void *
 342 libgnunet_plugin_transport_template_init (void *cls)
 343 {
 344   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
 345   struct GNUNET_TRANSPORT_PluginFunctions *api;
 346   struct Plugin *plugin;
 347
 348   if (NULL == env->receive)
 349   {
 350     /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
 351        initialze the plugin or the API */
 352     api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
 353     api->cls = NULL;
 354     api->address_to_string = &template_plugin_address_to_string;
 355     api->string_to_address = &template_plugin_string_to_address;
 356     api->address_pretty_printer = &template_plugin_address_pretty_printer;
 357     return api;
 358   }
 359
 360   plugin = GNUNET_malloc (sizeof (struct Plugin));
 361   plugin->env = env;
 362   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
 363   api->cls = plugin;
 364   api->send = &template_plugin_send;
 365   api->disconnect = &template_plugin_disconnect;
 366   api->address_pretty_printer = &template_plugin_address_pretty_printer;
 367   api->check_address = &template_plugin_address_suggested;
 368   api->address_to_string = &template_plugin_address_to_string;
 369   api->string_to_address = &template_plugin_string_to_address;
 370   api->get_session = &template_plugin_get_session;
 371   api->get_network = &template_plugin_get_network;
 372   LOG (GNUNET_ERROR_TYPE_INFO, "Template plugin successfully loaded\n");
 373   return api;
 374 }
 375
 376
 377 /**
 378  * Exit point from the plugin.
 379  */
 380 void *
 381 libgnunet_plugin_transport_template_done (void *cls)
 382 {
 383   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 384   struct Plugin *plugin = api->cls;
 385
 386   GNUNET_free (plugin);
 387   GNUNET_free (api);
 388   return NULL;
 389 }
 390
 391 /* end of plugin_transport_template.c */