src/dv/plugin_transport_dv.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2002--2013 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 dv/plugin_transport_dv.c
  23  * @brief DV transport service, takes incoming DV requests and deals with
  24  * the DV service
  25  * @author Nathan Evans
  26  * @author Christian Grothoff
  27  */
  28
  29 #include "platform.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_protocols.h"
  32 #include "gnunet_statistics_service.h"
  33 #include "gnunet_dv_service.h"
  34 #include "gnunet_transport_service.h"
  35 #include "gnunet_transport_plugin.h"
  36 #include "dv.h"
  37
  38
  39 #define LOG(kind,...) GNUNET_log_from (kind, "transport-dv",__VA_ARGS__)
  40
  41 #define PLUGIN_NAME "dv"
  42
  43 /**
  44  * Encapsulation of all of the state of the plugin.
  45  */
  46 struct Plugin;
  47
  48
  49 /**
  50  * An active request for transmission via DV.
  51  */
  52 struct PendingRequest
  53 {
  54
  55   /**
  56    * This is a DLL.
  57    */
  58   struct PendingRequest *next;
  59
  60   /**
  61    * This is a DLL.
  62    */
  63   struct PendingRequest *prev;
  64
  65   /**
  66    * Continuation function to call once the transmission buffer
  67    * has again space available.  NULL if there is no
  68    * continuation to call.
  69    */
  70   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
  71
  72   /**
  73    * Closure for transmit_cont.
  74    */
  75   void *transmit_cont_cls;
  76
  77   /**
  78    * Transmission handle from DV client library.
  79    */
  80   struct GNUNET_DV_TransmitHandle *th;
  81
  82   /**
  83    * Session of this request.
  84    */
  85   struct Session *session;
  86
  87 };
  88
  89
  90 /**
  91  * Session handle for connections.
  92  */
  93 struct Session
  94 {
  95
  96   /**
  97    * Mandatory session header.
  98    */
  99   struct SessionHeader header;
 100
 101   /**
 102    * Pointer to the global plugin struct.
 103    */
 104   struct Plugin *plugin;
 105
 106   /**
 107    * Head of pending requests.
 108    */
 109   struct PendingRequest *pr_head;
 110
 111   /**
 112    * Tail of pending requests.
 113    */
 114   struct PendingRequest *pr_tail;
 115
 116   /**
 117    * To whom are we talking to.
 118    */
 119   struct GNUNET_PeerIdentity sender;
 120
 121   /**
 122    * Current distance to the given peer.
 123    */
 124   uint32_t distance;
 125
 126   /**
 127    * Current network the next hop peer is located in
 128    */
 129   enum GNUNET_ATS_Network_Type network;
 130
 131   /**
 132    * Does the transport service know about this session (and we thus
 133    * need to call `session_end` when it is released?)
 134    */
 135   int active;
 136
 137 };
 138
 139
 140 /**
 141  * Encapsulation of all of the state of the plugin.
 142  */
 143 struct Plugin
 144 {
 145   /**
 146    * Our environment.
 147    */
 148   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 149
 150   /**
 151    * Hash map of sessions (active and inactive).
 152    */
 153   struct GNUNET_CONTAINER_MultiPeerMap *sessions;
 154
 155   /**
 156    * Copy of the handler array where the closures are
 157    * set to this struct's instance.
 158    */
 159   struct GNUNET_SERVER_MessageHandler *handlers;
 160
 161   /**
 162    * Handle to the DV service
 163    */
 164   struct GNUNET_DV_ServiceHandle *dvh;
 165
 166   /**
 167    * Tokenizer for boxed messages.
 168    */
 169   struct GNUNET_SERVER_MessageStreamTokenizer *mst;
 170
 171 };
 172
 173
 174 /**
 175  * Notify transport service about the change in distance.
 176  *
 177  * @param session session where the distance changed
 178  */
 179 static void
 180 notify_distance_change (struct Session *session)
 181 {
 182   struct Plugin *plugin = session->plugin;
 183   struct GNUNET_ATS_Information ats;
 184
 185   if (GNUNET_YES != session->active)
 186     return;
 187   ats.type = htonl ((uint32_t) GNUNET_ATS_QUALITY_NET_DISTANCE);
 188   ats.value = htonl (session->distance);
 189   plugin->env->update_address_metrics (plugin->env->cls,
 190                                        &session->sender,
 191                                        NULL, 0,
 192                                        session,
 193                                        &ats, 1);
 194 }
 195
 196
 197 /**
 198  * Function called by MST on each message from the box.
 199  *
 200  * @param cls closure with the `struct Plugin *`
 201  * @param client identification of the client (with the 'struct Session')
 202  * @param message the actual message
 203  * @return #GNUNET_OK on success
 204  */
 205 static int
 206 unbox_cb (void *cls,
 207           void *client,
 208           const struct GNUNET_MessageHeader *message)
 209 {
 210   struct Plugin *plugin = cls;
 211   struct Session *session = client;
 212   struct GNUNET_ATS_Information ats;
 213
 214   ats.type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
 215   ats.value = htonl (session->distance);
 216   session->active = GNUNET_YES;
 217   plugin->env->receive (plugin->env->cls,
 218                         &session->sender,
 219                         message,
 220                         session, "", 0);
 221   plugin->env->update_address_metrics (plugin->env->cls,
 222                                        &session->sender, NULL,
 223                                        0, session,
 224                                        &ats, 1);
 225   return GNUNET_OK;
 226 }
 227
 228
 229 /**
 230  * Handler for messages received from the DV service.
 231  *
 232  * @param cls closure with the plugin
 233  * @param sender sender of the message
 234  * @param distance how far did the message travel
 235  * @param msg actual message payload
 236  */
 237 static void
 238 handle_dv_message_received (void *cls,
 239                             const struct GNUNET_PeerIdentity *sender,
 240                             uint32_t distance,
 241                             const struct GNUNET_MessageHeader *msg)
 242 {
 243   struct Plugin *plugin = cls;
 244   struct GNUNET_ATS_Information ats;
 245   struct Session *session;
 246
 247   LOG (GNUNET_ERROR_TYPE_DEBUG,
 248        "Received `%s' message for peer `%s': new distance %u\n",
 249        "DV_MESSAGE_RECEIVED",
 250        GNUNET_i2s (sender), distance);
 251   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
 252                                                sender);
 253   if (NULL == session)
 254   {
 255     GNUNET_break (0);
 256     return;
 257   }
 258   if (GNUNET_MESSAGE_TYPE_DV_BOX == ntohs (msg->type))
 259   {
 260     /* need to unbox using MST */
 261     GNUNET_SERVER_mst_receive (plugin->mst,
 262                                session,
 263                                (const char *) &msg[1],
 264                                ntohs (msg->size) - sizeof (struct GNUNET_MessageHeader),
 265                                GNUNET_YES,
 266                                GNUNET_NO);
 267     return;
 268   }
 269   ats.type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
 270   ats.value = htonl (distance);
 271   session->active = GNUNET_YES;
 272   plugin->env->receive (plugin->env->cls, sender,
 273                         msg,
 274                         session, "", 0);
 275   plugin->env->update_address_metrics (plugin->env->cls,
 276                                        sender, "",
 277                                        0, session,
 278                                        &ats, 1);
 279 }
 280
 281
 282 /**
 283  * Function called if DV starts to be able to talk to a peer.
 284  *
 285  * @param cls closure with `struct Plugin *`
 286  * @param peer newly connected peer
 287  * @param distance distance to the peer
 288  * @param network the network the next hop is located in
 289  */
 290 static void
 291 handle_dv_connect (void *cls,
 292                    const struct GNUNET_PeerIdentity *peer,
 293                    uint32_t distance,
 294                    enum GNUNET_ATS_Network_Type network)
 295 {
 296   struct Plugin *plugin = cls;
 297   struct Session *session;
 298   struct GNUNET_ATS_Information ats[2];
 299
 300   GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != network);
 301   /**
 302    * This requires transport plugin to be linked to libgnunetats.
 303    * If you remove it, also remove libgnunetats linkage from Makefile.am
 304    */
 305   LOG (GNUNET_ERROR_TYPE_DEBUG,
 306        "Received `%s' message for peer `%s' with next hop in network %s\n",
 307        "DV_CONNECT",
 308        GNUNET_i2s (peer),
 309        GNUNET_ATS_print_network_type (network));
 310
 311   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
 312                                                peer);
 313   if (NULL != session)
 314   {
 315     GNUNET_break (0);
 316     session->distance = distance;
 317     notify_distance_change (session);
 318     return; /* nothing to do */
 319   }
 320
 321   session = GNUNET_new (struct Session);
 322   session->sender = *peer;
 323   session->plugin = plugin;
 324   session->distance = distance;
 325   session->network = network;
 326   GNUNET_assert(GNUNET_YES ==
 327                 GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
 328                                                    &session->sender, session,
 329                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 330
 331   LOG (GNUNET_ERROR_TYPE_DEBUG,
 332        "Creating new session %p for peer `%s'\n",
 333        session,
 334        GNUNET_i2s (peer));
 335
 336   /* Notify transport and ats about new connection */
 337   ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
 338   ats[0].value = htonl (distance);
 339   ats[1].type = htonl (GNUNET_ATS_NETWORK_TYPE);
 340   ats[1].value = htonl ((uint32_t) network);
 341   session->active = GNUNET_YES;
 342   plugin->env->session_start (plugin->env->cls, peer,
 343                               PLUGIN_NAME,
 344                               NULL, 0,
 345                               session, ats, 2);
 346 }
 347
 348
 349 /**
 350  * Function called if DV distance to a peer is changed.
 351  *
 352  * @param cls closure with `struct Plugin *`
 353  * @param peer connected peer
 354  * @param distance new distance to the peer
 355  * @param network network type used for the connection
 356  */
 357 static void
 358 handle_dv_distance_changed (void *cls,
 359                             const struct GNUNET_PeerIdentity *peer,
 360                             uint32_t distance,
 361                             enum GNUNET_ATS_Network_Type network)
 362 {
 363   struct Plugin *plugin = cls;
 364   struct Session *session;
 365
 366   GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != network);
 367   LOG (GNUNET_ERROR_TYPE_DEBUG,
 368        "Received `%s' message for peer `%s': new distance %u\n",
 369        "DV_DISTANCE_CHANGED",
 370        GNUNET_i2s (peer),
 371        distance);
 372   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
 373                                                peer);
 374   if (NULL == session)
 375   {
 376     GNUNET_break (0);
 377     handle_dv_connect (plugin, peer, distance, network);
 378     return;
 379   }
 380   session->distance = distance;
 381   notify_distance_change (session);
 382 }
 383
 384
 385 /**
 386  * Release session object and clean up associated resources.
 387  *
 388  * @param session session to clean up
 389  */
 390 static void
 391 free_session (struct Session *session)
 392 {
 393   struct Plugin *plugin = session->plugin;
 394   struct PendingRequest *pr;
 395
 396   GNUNET_assert (GNUNET_YES ==
 397                  GNUNET_CONTAINER_multipeermap_remove (plugin->sessions,
 398                                                        &session->sender,
 399                                                        session));
 400
 401   LOG (GNUNET_ERROR_TYPE_DEBUG,
 402        "Freeing session %p for peer `%s'\n",
 403        session,
 404        GNUNET_i2s (&session->sender));
 405   if (GNUNET_YES == session->active)
 406   {
 407     plugin->env->session_end (plugin->env->cls,
 408                               &session->sender,
 409                               session);
 410     session->active = GNUNET_NO;
 411   }
 412   while (NULL != (pr = session->pr_head))
 413   {
 414     GNUNET_CONTAINER_DLL_remove (session->pr_head,
 415                                  session->pr_tail,
 416                                  pr);
 417     GNUNET_DV_send_cancel (pr->th);
 418     pr->th = NULL;
 419     if (NULL != pr->transmit_cont)
 420       pr->transmit_cont (pr->transmit_cont_cls,
 421                          &session->sender,
 422                          GNUNET_SYSERR, 0, 0);
 423     GNUNET_free (pr);
 424   }
 425   GNUNET_free (session);
 426 }
 427
 428
 429 /**
 430  * Function called if DV is no longer able to talk to a peer.
 431  *
 432  * @param cls closure with `struct Plugin *`
 433  * @param peer peer that disconnected
 434  */
 435 static void
 436 handle_dv_disconnect (void *cls,
 437                       const struct GNUNET_PeerIdentity *peer)
 438 {
 439   struct Plugin *plugin = cls;
 440   struct Session *session;
 441
 442   LOG (GNUNET_ERROR_TYPE_DEBUG,
 443        "Received `%s' message for peer `%s'\n",
 444        "DV_DISCONNECT",
 445        GNUNET_i2s (peer));
 446   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
 447                                                peer);
 448   if (NULL == session)
 449     return; /* nothing to do */
 450   free_session (session);
 451 }
 452
 453
 454 /**
 455  * Function called once the delivery of a message has been successful.
 456  * Clean up the pending request, and call continuations.
 457  *
 458  * @param cls closure
 459  * @param ok #GNUNET_OK on success, #GNUNET_SYSERR on error
 460  */
 461 static void
 462 send_finished (void *cls,
 463                int ok)
 464 {
 465   struct PendingRequest *pr = cls;
 466   struct Session *session = pr->session;
 467
 468   pr->th = NULL;
 469   GNUNET_CONTAINER_DLL_remove (session->pr_head,
 470                                session->pr_tail,
 471                                pr);
 472   if (NULL != pr->transmit_cont)
 473     pr->transmit_cont (pr->transmit_cont_cls,
 474                        &session->sender,
 475                        ok, 0, 0);
 476   GNUNET_free (pr);
 477 }
 478
 479
 480 /**
 481  * Function that can be used by the transport service to transmit
 482  * a message using the plugin.
 483  *
 484  * @param cls closure
 485  * @param session the session used
 486  * @param priority how important is the message
 487  * @param msgbuf the message to transmit
 488  * @param msgbuf_size number of bytes in 'msgbuf'
 489  * @param timeout when should we time out
 490  * @param cont continuation to call once the message has
 491  *        been transmitted (or if the transport is ready
 492  *        for the next transmission call; or if the
 493  *        peer disconnected...)
 494  * @param cont_cls closure for @a cont
 495  * @return number of bytes used (on the physical network, with overheads);
 496  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 497  *         and does NOT mean that the message was not transmitted (DV)
 498  */
 499 static ssize_t
 500 dv_plugin_send (void *cls,
 501                 struct Session *session,
 502                 const char *msgbuf,
 503                 size_t msgbuf_size,
 504                 unsigned int priority,
 505                 struct GNUNET_TIME_Relative timeout,
 506                 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
 507 {
 508   struct Plugin *plugin = cls;
 509   struct PendingRequest *pr;
 510   const struct GNUNET_MessageHeader *msg;
 511   struct GNUNET_MessageHeader *box;
 512
 513   box = NULL;
 514   msg = (const struct GNUNET_MessageHeader *) msgbuf;
 515   if (ntohs (msg->size) != msgbuf_size)
 516   {
 517     /* need to box */
 518     box = GNUNET_malloc (sizeof (struct GNUNET_MessageHeader) + msgbuf_size);
 519     box->type = htons (GNUNET_MESSAGE_TYPE_DV_BOX);
 520     box->size = htons (sizeof (struct GNUNET_MessageHeader) + msgbuf_size);
 521     memcpy (&box[1], msgbuf, msgbuf_size);
 522     msg = box;
 523   }
 524   pr = GNUNET_new (struct PendingRequest);
 525   pr->transmit_cont = cont;
 526   pr->transmit_cont_cls = cont_cls;
 527   pr->session = session;
 528   GNUNET_CONTAINER_DLL_insert_tail (session->pr_head,
 529                                     session->pr_tail,
 530                                     pr);
 531
 532   pr->th = GNUNET_DV_send (plugin->dvh,
 533                            &session->sender,
 534                            msg ,
 535                            &send_finished,
 536                            pr);
 537   GNUNET_free_non_null (box);
 538   return 0; /* DV */
 539 }
 540
 541
 542 /**
 543  * Function that can be used to force the plugin to disconnect
 544  * from the given peer and cancel all previous transmissions
 545  * (and their continuations).
 546  *
 547  * @param cls closure with the `struct Plugin *`
 548  * @param target peer from which to disconnect
 549  */
 550 static void
 551 dv_plugin_disconnect_peer (void *cls,
 552                            const struct GNUNET_PeerIdentity *target)
 553 {
 554   struct Plugin *plugin = cls;
 555   struct Session *session;
 556   struct PendingRequest *pr;
 557
 558   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
 559                                                target);
 560   if (NULL == session)
 561     return; /* nothing to do */
 562   while (NULL != (pr = session->pr_head))
 563   {
 564     GNUNET_CONTAINER_DLL_remove (session->pr_head,
 565                                  session->pr_tail,
 566                                  pr);
 567     GNUNET_DV_send_cancel (pr->th);
 568     pr->th = NULL;
 569     if (NULL != pr->transmit_cont)
 570       pr->transmit_cont (pr->transmit_cont_cls,
 571                          &session->sender,
 572                          GNUNET_SYSERR, 0, 0);
 573     GNUNET_free (pr);
 574   }
 575   session->active = GNUNET_NO;
 576 }
 577
 578
 579 /**
 580  * Function that can be used to force the plugin to disconnect
 581  * from the given peer and cancel all previous transmissions
 582  * (and their continuations).
 583  *
 584  * @param cls closure with the `struct Plugin *`
 585  * @param session which session to disconnect
 586  * @return #GNUNET_OK
 587  */
 588 static int
 589 dv_plugin_disconnect_session (void *cls,
 590                               struct Session *session)
 591 {
 592   struct PendingRequest *pr;
 593
 594   while (NULL != (pr = session->pr_head))
 595   {
 596     GNUNET_CONTAINER_DLL_remove (session->pr_head,
 597                                  session->pr_tail,
 598                                  pr);
 599     GNUNET_DV_send_cancel (pr->th);
 600     pr->th = NULL;
 601     if (NULL != pr->transmit_cont)
 602       pr->transmit_cont (pr->transmit_cont_cls,
 603                          &session->sender,
 604                          GNUNET_SYSERR, 0, 0);
 605     GNUNET_free (pr);
 606   }
 607   session->active = GNUNET_NO;
 608   return GNUNET_OK;
 609 }
 610
 611
 612 /**
 613  * Convert the transports address to a nice, human-readable
 614  * format.
 615  *
 616  * @param cls closure
 617  * @param type name of the transport that generated the address
 618  * @param addr one of the addresses of the host, NULL for the last address
 619  *        the specific address format depends on the transport
 620  * @param addrlen length of the address
 621  * @param numeric should (IP) addresses be displayed in numeric form?
 622  * @param timeout after how long should we give up?
 623  * @param asc function to call on each string
 624  * @param asc_cls closure for @a asc
 625  */
 626 static void
 627 dv_plugin_address_pretty_printer (void *cls, const char *type,
 628                                   const void *addr,
 629                                   size_t addrlen, int numeric,
 630                                   struct GNUNET_TIME_Relative timeout,
 631                                   GNUNET_TRANSPORT_AddressStringCallback asc,
 632                                   void *asc_cls)
 633 {
 634   if ( (0 == addrlen) &&
 635        (0 == strcmp (type, "dv")) )
 636     asc (asc_cls, "dv");
 637   asc (asc_cls, NULL);
 638 }
 639
 640
 641 /**
 642  * Convert the DV address to a pretty string.
 643  *
 644  * @param cls closure
 645  * @param addr the (hopefully) DV address
 646  * @param addrlen the length of the @a addr
 647  * @return string representing the DV address
 648  */
 649 static const char *
 650 dv_plugin_address_to_string (void *cls,
 651                              const void *addr,
 652                              size_t addrlen)
 653 {
 654   if (0 != addrlen)
 655   {
 656     GNUNET_break (0); /* malformed */
 657     return NULL;
 658   }
 659   return "dv";
 660 }
 661
 662
 663 /**
 664  * Another peer has suggested an address for this peer and transport
 665  * plugin.  Check that this could be a valid address.  This function
 666  * is not expected to 'validate' the address in the sense of trying to
 667  * connect to it but simply to see if the binary format is technically
 668  * legal for establishing a connection to this peer (and make sure that
 669  * the address really corresponds to our network connection/settings
 670  * and not some potential man-in-the-middle).
 671  *
 672  * @param cls closure
 673  * @param addr pointer to the address
 674  * @param addrlen length of addr
 675  * @return #GNUNET_OK if this is a plausible address for this peer
 676  *         and transport, #GNUNET_SYSERR if not
 677  *
 678  */
 679 static int
 680 dv_plugin_check_address (void *cls,
 681                          const void *addr,
 682                          size_t addrlen)
 683 {
 684   if (0 != addrlen)
 685     return GNUNET_SYSERR;
 686   return GNUNET_OK;
 687 }
 688
 689
 690 /**
 691  * Create a new session to transmit data to the target
 692  * This session will used to send data to this peer and the plugin will
 693  * notify us by calling the env->session_end function
 694  *
 695  * @param cls the plugin
 696  * @param address the address
 697  * @return the session if the address is valid, NULL otherwise
 698  */
 699 static struct Session *
 700 dv_get_session (void *cls,
 701                 const struct GNUNET_HELLO_Address *address)
 702 {
 703   struct Plugin *plugin = cls;
 704   struct Session *session;
 705
 706   if (0 != address->address_length)
 707     return NULL;
 708   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
 709                                                &address->peer);
 710   if (NULL == session)
 711     return NULL; /* not valid right now */
 712   session->active = GNUNET_YES;
 713   return session;
 714 }
 715
 716
 717 /**
 718  * Function called to convert a string address to
 719  * a binary address.
 720  *
 721  * @param cls closure ('struct Plugin*')
 722  * @param addr string address
 723  * @param addrlen length of the @a addr including \0 termination
 724  * @param buf location to store the buffer
 725  *        If the function returns #GNUNET_SYSERR, its contents are undefined.
 726  * @param added length of created address
 727  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
 728  */
 729 static int
 730 dv_plugin_string_to_address (void *cls,
 731                              const char *addr,
 732                              uint16_t addrlen,
 733                              void **buf,
 734                              size_t *added)
 735 {
 736   if ( (addrlen == 3) &&
 737        (0 == strcmp ("dv", addr)) )
 738   {
 739     *added = 0;
 740     return GNUNET_OK;
 741   }
 742   return GNUNET_SYSERR;
 743 }
 744
 745
 746
 747 /**
 748  * Function to obtain the network type for a session
 749  * FIXME: we should probably look at the network type
 750  * used by the next hop here.  Or find some other way
 751  * to properly allow ATS-DV resource allocation.
 752  *
 753  * @param cls closure (`struct Plugin *`)
 754  * @param session the session
 755  * @return the network type
 756  */
 757 static enum GNUNET_ATS_Network_Type
 758 dv_get_network (void *cls,
 759                 struct Session *session)
 760 {
 761   GNUNET_assert (NULL != session);
 762   return session->network;
 763 }
 764
 765
 766 /**
 767  * Entry point for the plugin.
 768  *
 769  * @param cls closure with the plugin environment
 770  * @return plugin API
 771  */
 772 void *
 773 libgnunet_plugin_transport_dv_init (void *cls)
 774 {
 775   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
 776   struct GNUNET_TRANSPORT_PluginFunctions *api;
 777   struct Plugin *plugin;
 778
 779   plugin = GNUNET_new (struct Plugin);
 780   plugin->env = env;
 781   plugin->sessions = GNUNET_CONTAINER_multipeermap_create (1024 * 8, GNUNET_YES);
 782   plugin->mst = GNUNET_SERVER_mst_create (&unbox_cb,
 783                                           plugin);
 784   plugin->dvh = GNUNET_DV_service_connect (env->cfg,
 785                                            plugin,
 786                                            &handle_dv_connect,
 787                                            &handle_dv_distance_changed,
 788                                            &handle_dv_disconnect,
 789                                            &handle_dv_message_received);
 790   if (NULL == plugin->dvh)
 791   {
 792     GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
 793     GNUNET_SERVER_mst_destroy (plugin->mst);
 794     GNUNET_free (plugin);
 795     return NULL;
 796   }
 797   api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
 798   api->cls = plugin;
 799   api->send = &dv_plugin_send;
 800   api->disconnect_peer = &dv_plugin_disconnect_peer;
 801   api->disconnect_session = &dv_plugin_disconnect_session;
 802   api->address_pretty_printer = &dv_plugin_address_pretty_printer;
 803   api->check_address = &dv_plugin_check_address;
 804   api->address_to_string = &dv_plugin_address_to_string;
 805   api->string_to_address = &dv_plugin_string_to_address;
 806   api->get_session = &dv_get_session;
 807   api->get_network = &dv_get_network;
 808   return api;
 809 }
 810
 811
 812 /**
 813  * Function called to free a session.
 814  *
 815  * @param cls NULL
 816  * @param key unused
 817  * @param value session to free
 818  * @return #GNUNET_OK (continue to iterate)
 819  */
 820 static int
 821 free_session_iterator (void *cls,
 822                        const struct GNUNET_PeerIdentity *key,
 823                        void *value)
 824 {
 825   struct Session *session = value;
 826
 827   free_session (session);
 828   return GNUNET_OK;
 829 }
 830
 831
 832 /**
 833  * Exit point from the plugin.
 834  *
 835  * @param cls plugin API
 836  * @return NULL
 837  */
 838 void *
 839 libgnunet_plugin_transport_dv_done (void *cls)
 840 {
 841   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 842   struct Plugin *plugin = api->cls;
 843
 844   GNUNET_DV_service_disconnect (plugin->dvh);
 845   GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
 846                                          &free_session_iterator,
 847                                          NULL);
 848   GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
 849   GNUNET_SERVER_mst_destroy (plugin->mst);
 850   GNUNET_free (plugin);
 851   GNUNET_free (api);
 852   return NULL;
 853 }
 854
 855 /* end of plugin_transport_dv.c */