-doxygen
[oweals/gnunet.git] / src / dv / plugin_transport_dv.c
index 76c823b178d87fec63de177f0438ad8fcf33a140..e90604086417c24f646bf3d83bdf456fa5963d70 100644 (file)
@@ -38,6 +38,7 @@
 
 #define LOG(kind,...) GNUNET_log_from (kind, "transport-dv",__VA_ARGS__)
 
+#define PLUGIN_NAME "dv"
 
 /**
  * Encapsulation of all of the state of the plugin.
@@ -122,9 +123,14 @@ struct Session
    */
   uint32_t distance;
 
+  /**
+   * Current network the next hop peer is located in
+   */
+  uint32_t network;
+
   /**
    * Does the transport service know about this session (and we thus
-   * need to call 'session_end' when it is released?)
+   * need to call `session_end` when it is released?)
    */
   int active;
 
@@ -160,7 +166,7 @@ struct Plugin
   /**
    * Tokenizer for boxed messages.
    */
-  struct GNUNET_SERVER_MessageStreamTokenizer *mst; 
+  struct GNUNET_SERVER_MessageStreamTokenizer *mst;
 
 };
 
@@ -176,11 +182,13 @@ notify_distance_change (struct Session *session)
   struct Plugin *plugin = session->plugin;
   struct GNUNET_ATS_Information ats;
 
+  if (GNUNET_YES != session->active)
+    return;
   ats.type = htonl ((uint32_t) GNUNET_ATS_QUALITY_NET_DISTANCE);
   ats.value = htonl (session->distance);
   plugin->env->update_address_metrics (plugin->env->cls,
                                       &session->sender,
-                                      "", 0,
+                                      NULL, 0,
                                       session,
                                       &ats, 1);
 }
@@ -189,10 +197,10 @@ notify_distance_change (struct Session *session)
 /**
  * Function called by MST on each message from the box.
  *
- * @param cls closure with the 'struct Plugin'
+ * @param cls closure with the `struct Plugin *`
  * @param client identification of the client (with the 'struct Session')
  * @param message the actual message
- * @return GNUNET_OK on success
+ * @return #GNUNET_OK on success
  */
 static int
 unbox_cb (void *cls,
@@ -202,16 +210,18 @@ unbox_cb (void *cls,
   struct Plugin *plugin = cls;
   struct Session *session = client;
   struct GNUNET_ATS_Information ats;
-  
+
   ats.type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
   ats.value = htonl (session->distance);
   session->active = GNUNET_YES;
-  plugin->env->receive (plugin->env->cls, 
+  plugin->env->receive (plugin->env->cls,
                        &session->sender,
                         message,
                        session, "", 0);
   plugin->env->update_address_metrics (plugin->env->cls,
-               &session->sender, "", 0, session, &ats, 1);
+                                       &session->sender, NULL,
+                                       0, session,
+                                       &ats, 1);
   return GNUNET_OK;
 }
 
@@ -222,7 +232,7 @@ unbox_cb (void *cls,
  * @param cls closure with the plugin
  * @param sender sender of the message
  * @param distance how far did the message travel
- * @param msg actual message payload 
+ * @param msg actual message payload
  */
 static void
 handle_dv_message_received (void *cls,
@@ -234,9 +244,13 @@ handle_dv_message_received (void *cls,
   struct GNUNET_ATS_Information ats;
   struct Session *session;
 
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Received `%s' message for peer `%s': new distance %u\n",
+       "DV_MESSAGE_RECEIVED",
+       GNUNET_i2s (sender), distance);
   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
                                               sender);
-  if (NULL == session)    
+  if (NULL == session)
   {
     GNUNET_break (0);
     return;
@@ -244,7 +258,7 @@ handle_dv_message_received (void *cls,
   if (GNUNET_MESSAGE_TYPE_DV_BOX == ntohs (msg->type))
   {
     /* need to unbox using MST */
-    GNUNET_SERVER_mst_receive (plugin->mst, 
+    GNUNET_SERVER_mst_receive (plugin->mst,
                               session,
                               (const char *) &msg[1],
                               ntohs (msg->size) - sizeof (struct GNUNET_MessageHeader),
@@ -259,54 +273,85 @@ handle_dv_message_received (void *cls,
                         msg,
                         session, "", 0);
   plugin->env->update_address_metrics (plugin->env->cls,
-                                      sender, "", 0, session, &ats, 1);
+                                      sender, "",
+                                       0, session,
+                                       &ats, 1);
 }
 
 
 /**
  * Function called if DV starts to be able to talk to a peer.
  *
- * @param cls closure with 'struct Plugin'
+ * @param cls closure with `struct Plugin *`
  * @param peer newly connected peer
  * @param distance distance to the peer
+ * @param network the network the next hop is located in
  */
-static void 
+static void
 handle_dv_connect (void *cls,
                   const struct GNUNET_PeerIdentity *peer,
-                  uint32_t distance)
+                  uint32_t distance, uint32_t network)
 {
   struct Plugin *plugin = cls;
   struct Session *session;
+  struct GNUNET_ATS_Information ats[2];
+
+  /**
+   * This requires transport plugin to be linked to libgnunetats.
+   * If you remove it, also remove libgnunetats linkage from Makefile.am
+   */
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Received `%s' message for peer `%s' with next hop in network %s\n",
+       "DV_CONNECT",
+       GNUNET_i2s (peer),
+       GNUNET_ATS_print_network_type (network));
 
   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
                                               peer);
-  if (NULL != session)    
+  if (NULL != session)
   {
     GNUNET_break (0);
     session->distance = distance;
-    if (GNUNET_YES == session->active)
-      notify_distance_change (session);
-    return; /* nothing to do */  
+    notify_distance_change (session);
+    return; /* nothing to do */
   }
+
   session = GNUNET_new (struct Session);
   session->sender = *peer;
+  session->plugin = plugin;
   session->distance = distance;
-  GNUNET_assert (GNUNET_YES ==
-                GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
-                                                   &session->sender,
-                                                   session,
-                                                   GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
+  session->network = network;
+  GNUNET_assert(GNUNET_YES ==
+                GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
+                                                   &session->sender, session,
+                                                   GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
+
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Creating new session %p for peer `%s'\n",
+       session,
+       GNUNET_i2s (peer));
+
+  /* Notify transport and ats about new connection */
+  ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
+  ats[0].value = htonl (distance);
+  ats[1].type = htonl (GNUNET_ATS_NETWORK_TYPE);
+  ats[1].value = htonl (network);
+  session->active = GNUNET_YES;
+  plugin->env->session_start (plugin->env->cls, peer,
+                              PLUGIN_NAME,
+                              NULL, 0,
+                              session, ats, 2);
 }
 
 
 /**
  * Function called if DV distance to a peer is changed.
  *
- * @param cls closure with 'struct Plugin'
+ * @param cls closure with `struct Plugin *`
  * @param peer connected peer
  * @param distance new distance to the peer
  */
-static void 
+static void
 handle_dv_distance_changed (void *cls,
                            const struct GNUNET_PeerIdentity *peer,
                            uint32_t distance)
@@ -314,17 +359,21 @@ handle_dv_distance_changed (void *cls,
   struct Plugin *plugin = cls;
   struct Session *session;
 
+  LOG (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message for peer `%s': new distance %u\n",
+      "DV_DISTANCE_CHANGED",
+      GNUNET_i2s (peer), distance);
+
   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
                                               peer);
-  if (NULL == session)    
+  if (NULL == session)
   {
     GNUNET_break (0);
-    handle_dv_connect (plugin, peer, distance);
+    /* FIXME */
+    handle_dv_connect (plugin, peer, distance, 0);
     return;
   }
   session->distance = distance;
-  if (GNUNET_YES == session->active)
-    notify_distance_change (session);
+  notify_distance_change (session);
 }
 
 
@@ -343,10 +392,18 @@ free_session (struct Session *session)
                 GNUNET_CONTAINER_multipeermap_remove (plugin->sessions,
                                                       &session->sender,
                                                       session));
+
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Freeing session %p for peer `%s'\n",
+       session,
+       GNUNET_i2s (&session->sender));
   if (GNUNET_YES == session->active)
+  {
     plugin->env->session_end (plugin->env->cls,
                              &session->sender,
                              session);
+    session->active = GNUNET_NO;
+  }
   while (NULL != (pr = session->pr_head))
   {
     GNUNET_CONTAINER_DLL_remove (session->pr_head,
@@ -367,19 +424,23 @@ free_session (struct Session *session)
 /**
  * Function called if DV is no longer able to talk to a peer.
  *
- * @param cls closure with 'struct Plugin'
+ * @param cls closure with `struct Plugin *`
  * @param peer peer that disconnected
  */
-static void 
+static void
 handle_dv_disconnect (void *cls,
                      const struct GNUNET_PeerIdentity *peer)
 {
   struct Plugin *plugin = cls;
   struct Session *session;
 
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Received `%s' message for peer `%s'\n",
+       "DV_DISCONNECT",
+       GNUNET_i2s (peer));
   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
                                               peer);
-  if (NULL == session)    
+  if (NULL == session)
     return; /* nothing to do */
   free_session (session);
 }
@@ -390,7 +451,7 @@ handle_dv_disconnect (void *cls,
  * Clean up the pending request, and call continuations.
  *
  * @param cls closure
- * @param ok GNUNET_OK on success, GNUNET_SYSERR on error
+ * @param ok #GNUNET_OK on success, #GNUNET_SYSERR on error
  */
 static void
 send_finished (void *cls,
@@ -425,18 +486,21 @@ send_finished (void *cls,
  *        been transmitted (or if the transport is ready
  *        for the next transmission call; or if the
  *        peer disconnected...)
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
  * @return number of bytes used (on the physical network, with overheads);
  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
  *         and does NOT mean that the message was not transmitted (DV)
  */
 static ssize_t
-dv_plugin_send (void *cls, 
+dv_plugin_send (void *cls,
                struct Session *session,
-                const char *msgbuf, size_t msgbuf_size, unsigned int priority,
-                struct GNUNET_TIME_Relative timeout, 
+                const char *msgbuf,
+                size_t msgbuf_size,
+                unsigned int priority,
+                struct GNUNET_TIME_Relative timeout,
                 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
 {
+  struct Plugin *plugin = cls;
   struct PendingRequest *pr;
   const struct GNUNET_MessageHeader *msg;
   struct GNUNET_MessageHeader *box;
@@ -459,9 +523,10 @@ dv_plugin_send (void *cls,
   GNUNET_CONTAINER_DLL_insert_tail (session->pr_head,
                                    session->pr_tail,
                                    pr);
-  pr->th = GNUNET_DV_send (session->plugin->dvh,
+
+  pr->th = GNUNET_DV_send (plugin->dvh,
                           &session->sender,
-                          msg,
+                          msg ,
                           &send_finished,
                           pr);
   GNUNET_free_non_null (box);
@@ -474,11 +539,12 @@ dv_plugin_send (void *cls,
  * from the given peer and cancel all previous transmissions
  * (and their continuations).
  *
- * @param cls closure
+ * @param cls closure with the `struct Plugin *`
  * @param target peer from which to disconnect
  */
 static void
-dv_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
+dv_plugin_disconnect (void *cls,
+                      const struct GNUNET_PeerIdentity *target)
 {
   struct Plugin *plugin = cls;
   struct Session *session;
@@ -486,8 +552,8 @@ dv_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
 
   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
                                               target);
-  if (NULL == session)    
-    return; /* nothing to do */  
+  if (NULL == session)
+    return; /* nothing to do */
   while (NULL != (pr = session->pr_head))
   {
     GNUNET_CONTAINER_DLL_remove (session->pr_head,
@@ -517,10 +583,11 @@ dv_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
  * @param numeric should (IP) addresses be displayed in numeric form?
  * @param timeout after how long should we give up?
  * @param asc function to call on each string
- * @param asc_cls closure for asc
+ * @param asc_cls closure for @a asc
  */
 static void
-dv_plugin_address_pretty_printer (void *cls, const char *type, const void *addr,
+dv_plugin_address_pretty_printer (void *cls, const char *type,
+                                  const void *addr,
                                   size_t addrlen, int numeric,
                                   struct GNUNET_TIME_Relative timeout,
                                   GNUNET_TRANSPORT_AddressStringCallback asc,
@@ -538,17 +605,18 @@ dv_plugin_address_pretty_printer (void *cls, const char *type, const void *addr,
  *
  * @param cls closure
  * @param addr the (hopefully) DV address
- * @param addrlen the length of the address
- *
+ * @param addrlen the length of the @a addr
  * @return string representing the DV address
  */
 static const char *
-dv_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
+dv_plugin_address_to_string (void *cls,
+                             const void *addr,
+                             size_t addrlen)
 {
   if (0 != addrlen)
   {
     GNUNET_break (0); /* malformed */
-    return NULL; 
+    return NULL;
   }
   return "dv";
 }
@@ -566,12 +634,14 @@ dv_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
  * @param cls closure
  * @param addr pointer to the address
  * @param addrlen length of addr
- * @return GNUNET_OK if this is a plausible address for this peer
- *         and transport, GNUNET_SYSERR if not
+ * @return #GNUNET_OK if this is a plausible address for this peer
+ *         and transport, #GNUNET_SYSERR if not
  *
  */
 static int
-dv_plugin_check_address (void *cls, const void *addr, size_t addrlen)
+dv_plugin_check_address (void *cls,
+                         const void *addr,
+                         size_t addrlen)
 {
   if (0 != addrlen)
     return GNUNET_SYSERR;
@@ -588,7 +658,7 @@ dv_plugin_check_address (void *cls, const void *addr, size_t addrlen)
  * @param address the address
  * @return the session if the address is valid, NULL otherwise
  */
-static struct Session * 
+static struct Session *
 dv_get_session (void *cls,
                const struct GNUNET_HELLO_Address *address)
 {
@@ -612,13 +682,13 @@ dv_get_session (void *cls,
  *
  * @param cls closure ('struct Plugin*')
  * @param addr string address
- * @param addrlen length of the address including \0 termination
+ * @param addrlen length of the @a addr including \0 termination
  * @param buf location to store the buffer
- *        If the function returns GNUNET_SYSERR, its contents are undefined.
+ *        If the function returns #GNUNET_SYSERR, its contents are undefined.
  * @param added length of created address
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
  */
-static int 
+static int
 dv_plugin_string_to_address (void *cls,
                             const char *addr,
                             uint16_t addrlen,
@@ -642,16 +712,16 @@ dv_plugin_string_to_address (void *cls,
  * used by the next hop here.  Or find some other way
  * to properly allow ATS-DV resource allocation.
  *
- * @param cls closure ('struct Plugin*')
+ * @param cls closure (`struct Plugin *`)
  * @param session the session
  * @return the network type
  */
-static enum GNUNET_ATS_Network_Type 
+static enum GNUNET_ATS_Network_Type
 dv_get_network (void *cls,
                struct Session *session)
 {
   GNUNET_assert (NULL != session);
-  return GNUNET_ATS_NET_UNSPECIFIED;
+  return session->network;
 }
 
 
@@ -682,7 +752,7 @@ libgnunet_plugin_transport_dv_init (void *cls)
   if (NULL == plugin->dvh)
   {
     GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
-    GNUNET_SERVER_mst_destroy (plugin->mst);    
+    GNUNET_SERVER_mst_destroy (plugin->mst);
     GNUNET_free (plugin);
     return NULL;
   }
@@ -737,7 +807,7 @@ libgnunet_plugin_transport_dv_done (void *cls)
                                         &free_session_iterator,
                                         NULL);
   GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
-  GNUNET_SERVER_mst_destroy (plugin->mst);    
+  GNUNET_SERVER_mst_destroy (plugin->mst);
   GNUNET_free (plugin);
   GNUNET_free (api);
   return NULL;