src/dv/plugin_transport_dv.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 2, 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 dv/plugin_transport_dv.c
  23  * @brief DV transport service, takes incoming DV requests and deals with
  24  * the DV service
  25  * @author Christian Grothoff
  26  */
  27
  28 /**
  29  * TODO:
  30  *
  31  * As a start, the dv plugin needs to listen for information from the dv
  32  * service.  The plugin (?) will be notified by core (?) when a tcp/udp/whatever
  33  * message comes in that should be for dv.  The plugin will then hand off the message
  34  * to the dv service which will decrypt/validate the message (?) and then send the
  35  * result back to us (the transport) which will then send the message to the transport
  36  * service (yikes).
  37  *
  38  * Or, core will notify the dv service directly which will validate,
  39  * etc. and then just send a message to us.
  40  *
  41  * For starters, this plugin needs to have a client which will listen for messages from
  42  * the dv service that need to be sent up to the gnunet-transport-service.
  43  *
  44  * Messages sent from the dv transport get passed to the dv service which deals
  45  * with the actual sending (how much state does this transport need? should it know
  46  * which peers it is currently connected to and their distances, or just assume that
  47  * anything should be passed along to the dv service?).
  48  */
  49 #include "platform.h"
  50 #include "gnunet_protocols.h"
  51 #include "gnunet_connection_lib.h"
  52 #include "gnunet_server_lib.h"
  53 #include "gnunet_service_lib.h"
  54 #include "gnunet_statistics_service.h"
  55 #include "gnunet_dv_service.h"
  56 #include "gnunet_transport_service.h"
  57 #include "../transport/plugin_transport.h"
  58 #include "dv.h"
  59
  60 #define DEBUG_TEMPLATE GNUNET_NO
  61
  62 /**
  63  * Encapsulation of all of the state of the plugin.
  64  */
  65 struct Plugin;
  66
  67
  68 /**
  69  * Session handle for connections.
  70  */
  71 struct Session
  72 {
  73
  74   /**
  75    * Stored in a linked list.
  76    */
  77   struct Session *next;
  78
  79   /**
  80    * Pointer to the global plugin struct.
  81    */
  82   struct Plugin *plugin;
  83
  84   /**
  85    * The client (used to identify this connection)
  86    */
  87   /* void *client; */
  88
  89   /**
  90    * Continuation function to call once the transmission buffer
  91    * has again space available.  NULL if there is no
  92    * continuation to call.
  93    */
  94   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
  95
  96   /**
  97    * Closure for transmit_cont.
  98    */
  99   void *transmit_cont_cls;
 100
 101   /**
 102    * To whom are we talking to (set to our identity
 103    * if we are still waiting for the welcome message)
 104    */
 105   struct GNUNET_PeerIdentity sender;
 106
 107   /**
 108    * At what time did we reset last_received last?
 109    */
 110   struct GNUNET_TIME_Absolute last_quota_update;
 111
 112   /**
 113    * How many bytes have we received since the "last_quota_update"
 114    * timestamp?
 115    */
 116   uint64_t last_received;
 117
 118   /**
 119    * Number of bytes per ms that this peer is allowed
 120    * to send to us.
 121    */
 122   uint32_t quota;
 123
 124 };
 125
 126 /**
 127  * Encapsulation of all of the state of the plugin.
 128  */
 129 struct Plugin
 130 {
 131   /**
 132    * Our environment.
 133    */
 134   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 135
 136   /**
 137    * List of open sessions.
 138    */
 139   struct Session *sessions;
 140
 141   /**
 142    * Handle for the statistics service.
 143    */
 144   struct GNUNET_STATISTICS_Handle *statistics;
 145
 146   /**
 147    * Our server.
 148    */
 149   //struct GNUNET_SERVER_Handle *server;
 150
 151   /*
 152    * Handle to the running service.
 153    */
 154   //struct GNUNET_SERVICE_Context *service;
 155
 156   /**
 157    * Copy of the handler array where the closures are
 158    * set to this struct's instance.
 159    */
 160   struct GNUNET_SERVER_MessageHandler *handlers;
 161
 162   /**
 163    * Handle to the DV service
 164    */
 165   struct GNUNET_DV_Handle *dv_handle;
 166
 167 };
 168
 169 /**
 170  * Handler for messages received from the DV service.
 171  */
 172 void handle_dv_message_received (void *cls,
 173                                  struct GNUNET_PeerIdentity *sender,
 174                                  char *msg,
 175                                  size_t msg_len,
 176                                  uint32_t distance,
 177                                  char *sender_address,
 178                                  size_t sender_address_len)
 179 {
 180   struct Plugin *plugin = cls;
 181
 182   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 183                    "plugin_transport_dv",
 184                    _("PLUGIN Received message from %s of type %d, distance %u!\n"),
 185                    "DV SERVICE", ntohs(((struct GNUNET_MessageHeader *)msg)->type), distance);
 186
 187   plugin->env->receive(plugin->env->cls,
 188                        sender,
 189                        (struct GNUNET_MessageHeader *)msg,
 190                        distance,
 191                        NULL, /* FIXME: pass session! */
 192                        sender_address,
 193                        sender_address_len);
 194
 195 }
 196
 197
 198 /* Question: how does the transport service learn of a newly connected (gossipped about)
 199  * DV peer?  Should the plugin (here) create a HELLO for that peer and send it along,
 200  * or should the DV service create a HELLO and send it to us via the other part?
 201  */
 202
 203 /**
 204  * Function that can be used by the transport service to transmit
 205  * a message using the plugin.
 206  *
 207  * @param cls closure
 208  * @param target who should receive this message
 209  * @param priority how important is the message
 210  * @param msgbuf the message to transmit
 211  * @param msgbuf_size number of bytes in 'msgbuf'
 212  * @param timeout when should we time out
 213  * @param session the session used
 214  * @param addr the address to use (can be NULL if the plugin
 215  *                is "on its own" (i.e. re-use existing TCP connection))
 216  * @param addrlen length of the address in bytes
 217  * @param force_address GNUNET_YES if the plugin MUST use the given address,
 218  *                otherwise the plugin may use other addresses or
 219  *                existing connections (if available)
 220  * @param cont continuation to call once the message has
 221  *        been transmitted (or if the transport is ready
 222  *        for the next transmission call; or if the
 223  *        peer disconnected...)
 224  * @param cont_cls closure for cont
 225  * @return number of bytes used (on the physical network, with overheads);
 226  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 227  *         and does NOT mean that the message was not transmitted (DV)
 228  */
 229 static ssize_t
 230 dv_plugin_send (void *cls,
 231                 const struct GNUNET_PeerIdentity *target,
 232                 const char *msgbuf,
 233                 size_t msgbuf_size,
 234                 unsigned int priority,
 235                 struct GNUNET_TIME_Relative timeout,
 236                 struct Session *session,
 237                 const void *addr,
 238                 size_t addrlen,
 239                 int force_address,
 240                 GNUNET_TRANSPORT_TransmitContinuation
 241                 cont, void *cont_cls)
 242 {
 243   int ret = 0;
 244   struct Plugin *plugin = cls;
 245
 246   /* FIXME: do we want the dv plugin to remember sent messages to call continuation once message actually goes out?
 247    * Or do we just call the continuation once we've notified the plugin?
 248    */
 249   // FIXME: does it make sense for us to use sessions?
 250 #if DEBUG_DV
 251   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "DV API: Received send request from transport, calling GNUNET_DV_send\n");
 252 #endif
 253   ret = GNUNET_DV_send(plugin->dv_handle,
 254                        target,
 255                        msgbuf,
 256                        msgbuf_size,
 257                        priority,
 258                        timeout,
 259                        addr,
 260                        addrlen,
 261                        cont,
 262                        cont_cls);
 263
 264   return ret;
 265 }
 266
 267
 268
 269 /**
 270  * Function that can be used to force the plugin to disconnect
 271  * from the given peer and cancel all previous transmissions
 272  * (and their continuations).
 273  *
 274  * @param cls closure
 275  * @param target peer from which to disconnect
 276  */
 277 static void
 278 dv_plugin_disconnect (void *cls,
 279                             const struct GNUNET_PeerIdentity *target)
 280 {
 281   // struct Plugin *plugin = cls;
 282   // TODO: Add message type to send to dv service to "disconnect" a peer
 283 }
 284
 285
 286 /**
 287  * Convert the transports address to a nice, human-readable
 288  * format.
 289  *
 290  * @param cls closure
 291  * @param type name of the transport that generated the address
 292  * @param addr one of the addresses of the host, NULL for the last address
 293  *        the specific address format depends on the transport
 294  * @param addrlen length of the address
 295  * @param numeric should (IP) addresses be displayed in numeric form?
 296  * @param timeout after how long should we give up?
 297  * @param asc function to call on each string
 298  * @param asc_cls closure for asc
 299  */
 300 static void
 301 dv_plugin_address_pretty_printer (void *cls,
 302                                   const char *type,
 303                                   const void *addr,
 304                                   size_t addrlen,
 305                                   int numeric,
 306                                   struct GNUNET_TIME_Relative timeout,
 307                                   GNUNET_TRANSPORT_AddressStringCallback
 308                                   asc, void *asc_cls)
 309 {
 310   asc (asc_cls, NULL);
 311 }
 312
 313 /**
 314  * Convert the DV address to a pretty string.
 315  *
 316  * @param cls closure
 317  * @param addr the (hopefully) DV address
 318  * @param addrlen the length of the address
 319  *
 320  * @return string representing the DV address
 321  */
 322 static const char *address_to_string (void *cls,
 323                                        const void *addr,
 324                                        size_t addrlen)
 325 {
 326   static char return_buffer[2 * 4 + 2]; // Two four character peer identity prefixes a ':' and '\0'
 327
 328   struct GNUNET_CRYPTO_HashAsciiEncoded peer_hash;
 329   struct GNUNET_CRYPTO_HashAsciiEncoded via_hash;
 330   struct GNUNET_PeerIdentity *peer;
 331   struct GNUNET_PeerIdentity *via;
 332   char *addr_buf = (char *)addr;
 333
 334   if (addrlen == (2 * sizeof(struct GNUNET_PeerIdentity)))
 335     {
 336       peer = (struct GNUNET_PeerIdentity *)addr_buf;
 337       via = (struct GNUNET_PeerIdentity *)&addr_buf[sizeof(struct GNUNET_PeerIdentity)];
 338
 339       GNUNET_CRYPTO_hash_to_enc (&peer->hashPubKey, &peer_hash);
 340       peer_hash.encoding[4] = '\0';
 341       GNUNET_CRYPTO_hash_to_enc (&via->hashPubKey, &via_hash);
 342       via_hash.encoding[4] = '\0';
 343       GNUNET_snprintf (return_buffer,
 344                        sizeof (return_buffer),
 345                        "%s:%s",
 346                        &peer_hash,
 347                        &via_hash);
 348     }
 349   else
 350     return NULL;
 351
 352   return return_buffer;
 353 }
 354
 355 /**
 356  * Another peer has suggested an address for this
 357  * peer and transport plugin.  Check that this could be a valid
 358  * address.  If so, consider adding it to the list
 359  * of addresses.
 360  *
 361  * @param cls closure
 362  * @param addr pointer to the address
 363  * @param addrlen length of addr
 364  * @return GNUNET_OK if this is a plausible address for this peer
 365  *         and transport
 366  *
 367  * FIXME: does this mean anything for the DV plugin?
 368  */
 369 static int
 370 dv_plugin_address_suggested (void *cls,
 371                                   void *addr, size_t addrlen)
 372 {
 373   /* struct Plugin *plugin = cls; */
 374
 375   /* check if the address is plausible; if so,
 376      add it to our list! */
 377   return GNUNET_NO;
 378 }
 379
 380
 381 /**
 382  * Entry point for the plugin.
 383  */
 384 void *
 385 libgnunet_plugin_transport_dv_init (void *cls)
 386 {
 387   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
 388   struct GNUNET_TRANSPORT_PluginFunctions *api;
 389   struct Plugin *plugin;
 390
 391   plugin = GNUNET_malloc (sizeof (struct Plugin));
 392   plugin->env = env;
 393   plugin->statistics = NULL;
 394   //plugin->service = service;
 395   //plugin->server = GNUNET_SERVICE_get_server (service);
 396
 397   plugin->dv_handle = GNUNET_DV_connect(env->sched, env->cfg, &handle_dv_message_received, plugin);
 398
 399   if (plugin->dv_handle == NULL)
 400   {
 401     GNUNET_free(plugin);
 402     return NULL;
 403   }
 404
 405   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
 406   api->cls = plugin;
 407   api->send = &dv_plugin_send;
 408   api->disconnect = &dv_plugin_disconnect;
 409   api->address_pretty_printer = &dv_plugin_address_pretty_printer;
 410   api->check_address = &dv_plugin_address_suggested;
 411   api->address_to_string = &address_to_string;
 412   return api;
 413 }
 414
 415
 416 /**
 417  * Exit point from the plugin.
 418  */
 419 void *
 420 libgnunet_plugin_transport_dv_done (void *cls)
 421 {
 422   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 423   struct Plugin *plugin = api->cls;
 424
 425   GNUNET_free (plugin);
 426   GNUNET_free (api);
 427   return NULL;
 428 }
 429
 430 /* end of plugin_transport_template.c */