Don't pass NULL to destroy_route
[oweals/gnunet.git] / src / cadet / gnunet-service-cadet-new_paths.c
index bbe9af8b413f4c0a5df75c7ef1b81fd88b7bf7c8..5bb658797a2177d7e35c695f535ff0e109b29252 100644 (file)
  * @brief Information we track per path.
  * @author Bartlomiej Polot
  * @author Christian Grothoff
- *
- * TODO:
- * - path desirability score calculations are not done
- *   (and will be tricky to have during path changes)
  */
 #include "platform.h"
 #include "gnunet-service-cadet-new_connection.h"
+#include "gnunet-service-cadet-new_tunnels.h"
 #include "gnunet-service-cadet-new_peer.h"
 #include "gnunet-service-cadet-new_paths.h"
 
@@ -46,7 +43,7 @@ struct CadetPeerPath
    * Array of all the peers on the path.  If @e hn is non-NULL, the
    * last one is our owner.
    */
-  struct CadetPeerPathEntry *entries;
+  struct CadetPeerPathEntry **entries;
 
   /**
    * Node of this path in the owner's heap.  Used to update our position
@@ -54,13 +51,6 @@ struct CadetPeerPath
    */
   struct GNUNET_CONTAINER_HeapNode *hn;
 
-  /**
-   * Connections using this path, by destination peer
-   * (each hop of the path could correspond to an
-   * active connection).
-   */
-  struct GNUNET_CONTAINER_MultiPeerMap *connections;
-
   /**
    * Desirability of the path. How unique is it for the various peers
    * on it?
@@ -75,6 +65,27 @@ struct CadetPeerPath
 };
 
 
+/**
+ * Calculate the path's desirability score.
+ *
+ * @param path path to calculate the score for
+ */
+static void
+recalculate_path_desirability (struct CadetPeerPath *path)
+{
+  double result = 0.0;
+
+  for (unsigned int i=0;i<path->entries_length;i++)
+  {
+    struct CadetPeer *cp = path->entries[i]->peer;
+
+    result += GCP_get_desirability_of_path (cp,
+                                            i);
+  }
+  path->desirability = (GNUNET_CONTAINER_HeapCostType) result;
+}
+
+
 /**
  * Return how much we like keeping the path.  This is an aggregate
  * score based on various factors, including the age of the path
@@ -113,7 +124,7 @@ GCPP_get_connection (struct CadetPeerPath *path,
   struct CadetPeerPathEntry *entry;
 
   GNUNET_assert (off < path->entries_length);
-  entry = &path->entries[off];
+  entry = path->entries[off];
   GNUNET_assert (entry->peer == destination);
   return entry->cc;
 }
@@ -140,7 +151,7 @@ GCPP_add_connection (struct CadetPeerPath *path,
        GCPP_2s (path),
        off);
   GNUNET_assert (off < path->entries_length);
-  entry = &path->entries[off];
+  entry = path->entries[off];
   GNUNET_assert (NULL == entry->cc);
   entry->cc = cc;
 }
@@ -168,7 +179,7 @@ GCPP_del_connection (struct CadetPeerPath *path,
        GCPP_2s (path),
        off);
   GNUNET_assert (off < path->entries_length);
-  entry = &path->entries[off];
+  entry = path->entries[off];
   GNUNET_assert (cc == entry->cc);
   entry->cc = NULL;
 }
@@ -185,9 +196,21 @@ path_destroy (struct CadetPeerPath *path)
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Destroying path %s\n",
        GCPP_2s (path));
-  GNUNET_assert (0 ==
-                 GNUNET_CONTAINER_multipeermap_size (path->connections));
-  GNUNET_CONTAINER_multipeermap_destroy (path->connections);
+  for (unsigned int i=0;i<path->entries_length;i++)
+  {
+    struct CadetPeerPathEntry *entry = path->entries[i];
+
+    if (NULL != entry->cc)
+    {
+      struct CadetTConnection *ct;
+
+      ct = GCC_get_ct (entry->cc);
+      if (NULL != ct)
+        GCT_connection_lost (ct);
+      GCC_destroy_without_tunnel (entry->cc);
+    }
+    GNUNET_free (entry);
+  }
   GNUNET_free (path->entries);
   GNUNET_free (path);
 }
@@ -209,26 +232,24 @@ GCPP_release (struct CadetPeerPath *path)
        "Owner releases path %s\n",
        GCPP_2s (path));
   path->hn = NULL;
-  entry = &path->entries[path->entries_length - 1];
+  entry = path->entries[path->entries_length - 1];
   while (1)
   {
-    /* cut 'off' end of path, verifying it is not in use */
-    GNUNET_assert (NULL ==
-                   GNUNET_CONTAINER_multipeermap_get (path->connections,
-                                                      GCP_get_id (entry->peer)));
+    /* cut 'off' end of path */
     GCP_path_entry_remove (entry->peer,
                            entry,
                            path->entries_length - 1);
     path->entries_length--; /* We don't bother shrinking the 'entries' array,
                                as it's probably not worth it. */
+    GNUNET_free (entry);
     if (0 == path->entries_length)
       break; /* the end */
 
     /* see if new peer at the end likes this path any better */
-    entry = &path->entries[path->entries_length - 1];
+    entry = path->entries[path->entries_length - 1];
     path->hn = GCP_attach_path (entry->peer,
                                 path,
-                                path->entries_length,
+                                path->entries_length - 1,
                                 GNUNET_NO);
     if (NULL != path->hn)
       return; /* yep, got attached, we are done. */
@@ -255,7 +276,7 @@ GCPP_update_score (struct CadetPeerPath *path,
   struct CadetPeerPathEntry *entry;
 
   GNUNET_assert (off < path->entries_length);
-  entry = &path->entries[off];
+  entry = path->entries[off];
 
   /* Add delta, with checks for overflows */
   if (delta >= 0)
@@ -272,8 +293,7 @@ GCPP_update_score (struct CadetPeerPath *path,
     else
       entry->score += delta;
   }
-
-  /* FIXME: update path desirability! */
+  recalculate_path_desirability (path);
 }
 
 
@@ -293,6 +313,11 @@ struct CheckMatchContext
    */
   struct CadetPeer **cpath;
 
+  /**
+   * How long is the @e cpath array?
+   */
+  unsigned int cpath_length;
+
 };
 
 
@@ -313,13 +338,32 @@ check_match (void *cls,
 {
   struct CheckMatchContext *cm_ctx = cls;
 
-  if (path->entries_length > off)
-    return GNUNET_YES; /* too long, cannot be useful */
+  GNUNET_assert (path->entries_length > off);
+  if ( (path->entries_length != off + 1) &&
+       (off + 1 != cm_ctx->cpath_length) )
+  {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "check_match missmatch because path %s is too long (%u vs. %u vs. %u)\n",
+         GCPP_2s (path),
+         path->entries_length,
+         off + 1,
+         cm_ctx->cpath_length);
+    return GNUNET_YES; /* too long, goes somewhere else already, thus cannot be useful */
+  }
   for (unsigned int i=0;i<off;i++)
     if (cm_ctx->cpath[i] !=
         GCPP_get_peer_at_offset (path,
                                  i))
+    {
+      LOG (GNUNET_ERROR_TYPE_DEBUG,
+           "check_match path %s missmatches at offset %u\n",
+           GCPP_2s (path),
+           i);
       return GNUNET_YES; /* missmatch, ignore */
+    }
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "check_match found match with path %s\n",
+       GCPP_2s (path));
   cm_ctx->match = path;
   return GNUNET_NO; /* match, we are done! */
 }
@@ -345,38 +389,61 @@ extend_path (struct CadetPeerPath *path,
   struct GNUNET_CONTAINER_HeapNode *hn;
   int i;
 
+  /* Expand path */
+  GNUNET_array_grow (path->entries,
+                     path->entries_length,
+                     old_len + num_peers);
+  for (i=num_peers-1;i >= 0;i--)
+  {
+    struct CadetPeerPathEntry *entry = GNUNET_new (struct CadetPeerPathEntry);
+
+    path->entries[old_len + i] = entry;
+    entry->peer = peers[i];
+    entry->path = path;
+  }
+  for (i=num_peers-1;i >= 0;i--)
+  {
+    struct CadetPeerPathEntry *entry = path->entries[old_len + i];
+
+    GCP_path_entry_add (entry->peer,
+                        entry,
+                        old_len + i);
+  }
+
   /* If we extend an existing path, detach it from the
      old owner and re-attach to the new one */
   hn = NULL;
   for (i=num_peers-1;i>=0;i--)
   {
-    /* FIXME: note that path->desirability is used, but not yet updated here! */
+    struct CadetPeerPathEntry *entry = path->entries[old_len + i];
+
+    path->entries_length = old_len + i + 1;
+    recalculate_path_desirability (path);
     hn = GCP_attach_path (peers[i],
                           path,
                           old_len + (unsigned int) i,
                           GNUNET_YES);
     if (NULL != hn)
       break;
+    GCP_path_entry_remove (entry->peer,
+                           entry,
+                           old_len + i);
+    GNUNET_free (entry);
+    path->entries[old_len + i] = NULL;
   }
   if (NULL == hn)
-    return; /* none of the peers is interested in this path */
-  GCP_detach_path (path->entries[old_len-1].peer,
+  {
+    /* none of the peers is interested in this path;
+       shrink path back */
+    GNUNET_array_grow (path->entries,
+                       path->entries_length,
+                       old_len);
+    return;
+  }
+  GCP_detach_path (path->entries[old_len-1]->peer,
                    path,
                    path->hn);
   path->hn = hn;
-  GNUNET_array_grow (path->entries,
-                     path->entries_length,
-                     old_len + i);
-  for (;i >= 0;i--)
-  {
-    struct CadetPeerPathEntry *entry = &path->entries[old_len + i];
-
-    entry->peer = peers[i];
-    entry->path = path;
-    GCP_path_entry_add (entry->peer,
-                        entry,
-                        old_len + i);
-  }
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Extended path %s\n",
        GCPP_2s (path));
@@ -406,24 +473,39 @@ GCPP_try_path_from_dht (const struct GNUNET_PeerIdentity *get_path,
   struct CadetPeerPath *path;
   struct GNUNET_CONTAINER_HeapNode *hn;
   int i;
+  unsigned int skip;
+  unsigned int total_len;
 
   /* precompute 'cpath' so we can avoid doing the lookups lots of times */
-  for (unsigned int off=0;off<get_path_length + put_path_length;off++)
+  skip = 0;
+  total_len = get_path_length + put_path_length;
+  for (unsigned int off=0;off<total_len;off++)
   {
     const struct GNUNET_PeerIdentity *pid;
 
     pid = (off < get_path_length)
       ? &get_path[get_path_length - off]
       : &put_path[get_path_length + put_path_length - off];
-    cpath[off] = GCP_get (pid,
-                          GNUNET_YES);
+    cpath[off - skip] = GCP_get (pid,
+                                 GNUNET_YES);
+    /* Check that no peer is twice on the path */
+    for (unsigned int i=0;i<off;i++)
+    {
+      if (cpath[i] == cpath[off])
+      {
+        skip = off - i;
+        break;
+      }
+    }
   }
+  total_len -= skip;
 
   /* First figure out if this path is a subset of an existing path, an
      extension of an existing path, or a new path. */
+  cm_ctx.cpath_length = total_len;
   cm_ctx.cpath = cpath;
   cm_ctx.match = NULL;
-  for (i=get_path_length + put_path_length-1;i>=0;i--)
+  for (i=total_len-1;i>=0;i--)
   {
     GCP_iterate_paths_at (cpath[i],
                           (unsigned int) i,
@@ -431,7 +513,7 @@ GCPP_try_path_from_dht (const struct GNUNET_PeerIdentity *get_path,
                           &cm_ctx);
     if (NULL != cm_ctx.match)
     {
-      if (i == get_path_length + put_path_length - 1)
+      if (i == total_len - 1)
       {
         /* Existing path includes this one, nothing to do! */
         LOG (GNUNET_ERROR_TYPE_DEBUG,
@@ -445,8 +527,8 @@ GCPP_try_path_from_dht (const struct GNUNET_PeerIdentity *get_path,
              "Trying to extend existing path %s by additional links discovered from DHT\n",
              GCPP_2s (cm_ctx.match));
         extend_path (cm_ctx.match,
-                     &cpath[i],
-                     get_path_length + put_path_length - i,
+                     &cpath[i + 1],
+                     total_len - i - 1,
                      GNUNET_NO);
         return;
       }
@@ -455,42 +537,60 @@ GCPP_try_path_from_dht (const struct GNUNET_PeerIdentity *get_path,
 
   /* No match at all, create completely new path */
   path = GNUNET_new (struct CadetPeerPath);
+  path->entries_length = total_len;
+  path->entries = GNUNET_new_array (path->entries_length,
+                                    struct CadetPeerPathEntry *);
+  for (i=path->entries_length-1;i>=0;i--)
+  {
+    struct CadetPeerPathEntry *entry = GNUNET_new (struct CadetPeerPathEntry);
+
+    path->entries[i] = entry;
+    entry->peer = cpath[i];
+    entry->path = path;
+  }
+  for (i=path->entries_length-1;i>=0;i--)
+  {
+    struct CadetPeerPathEntry *entry = path->entries[i];
+
+    GCP_path_entry_add (entry->peer,
+                        entry,
+                        i);
+  }
 
-  /* First, try to attach it */
+  /* Finally, try to attach it */
   hn = NULL;
-  for (i=get_path_length + put_path_length-1;i>=0;i--)
+  for (i=total_len-1;i>=0;i--)
   {
-    path->entries_length = i;
-    /* FIXME: note that path->desirability is used, but not yet initialized here! */
+    struct CadetPeerPathEntry *entry = path->entries[i];
+
+    path->entries_length = i + 1;
+    recalculate_path_desirability (path);
     hn = GCP_attach_path (cpath[i],
                           path,
                           (unsigned int) i,
                           GNUNET_NO);
     if (NULL != hn)
       break;
+    GCP_path_entry_remove (entry->peer,
+                           entry,
+                           i);
+    GNUNET_free (entry);
+    path->entries[i] = NULL;
   }
   if (NULL == hn)
   {
     /* None of the peers on the path care about it. */
     LOG (GNUNET_ERROR_TYPE_DEBUG,
          "Path discovered from DHT is not interesting to us\n");
+    GNUNET_free (path->entries);
     GNUNET_free (path);
     return;
   }
   path->hn = hn;
-  path->entries_length = i;
-  path->entries = GNUNET_new_array (path->entries_length,
-                                    struct CadetPeerPathEntry);
-  for (;i>=0;i--)
-  {
-    struct CadetPeerPathEntry *entry = &path->entries[i];
-
-    entry->peer = cpath[i];
-    entry->path = path;
-    GCP_path_entry_add (entry->peer,
-                        entry,
-                        i);
-  }
+  /* Shrink path to actual useful length */
+  GNUNET_array_grow (path->entries,
+                     path->entries_length,
+                     i + 1);
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Created new path %s based on information from DHT\n",
        GCPP_2s (path));
@@ -521,6 +621,7 @@ GCPP_get_path_from_route (unsigned int path_length,
   /* First figure out if this path is a subset of an existing path, an
      extension of an existing path, or a new path. */
   cm_ctx.cpath = cpath;
+  cm_ctx.cpath_length = path_length;
   cm_ctx.match = NULL;
   for (int i=path_length-1;i>=0;i--)
   {
@@ -545,13 +646,15 @@ GCPP_get_path_from_route (unsigned int path_length,
              "Extending existing path %s to create inverse for incoming connection\n",
              GCPP_2s (cm_ctx.match));
         extend_path (cm_ctx.match,
-                     &cpath[i],
-                     path_length - i,
+                     &cpath[i + 1],
+                     path_length - i - 1,
                      GNUNET_YES);
         /* Check that extension was successful */
         GNUNET_assert (cm_ctx.match->entries_length == path_length);
         return cm_ctx.match;
       }
+      /* Eh, we found a match but couldn't use it? Something is wrong. */
+      GNUNET_break (0);
     }
   }
 
@@ -559,24 +662,31 @@ GCPP_get_path_from_route (unsigned int path_length,
   path = GNUNET_new (struct CadetPeerPath);
   path->entries_length = path_length;
   path->entries = GNUNET_new_array (path->entries_length,
-                                    struct CadetPeerPathEntry);
+                                    struct CadetPeerPathEntry *);
   for (int i=path_length-1;i>=0;i--)
   {
-    struct CadetPeerPathEntry *entry = &path->entries[i];
+    struct CadetPeerPathEntry *entry = GNUNET_new (struct CadetPeerPathEntry);
 
+    path->entries[i] = entry;
     entry->peer = cpath[i];
     entry->path = path;
+  }
+  for (int i=path_length-1;i>=0;i--)
+  {
+    struct CadetPeerPathEntry *entry = path->entries[i];
+
     GCP_path_entry_add (entry->peer,
                         entry,
                         i);
   }
+  recalculate_path_desirability (path);
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Created new path %s to create inverse for incoming connection\n",
+       GCPP_2s (path));
   path->hn = GCP_attach_path (cpath[path_length - 1],
                               path,
                               path_length - 1,
                               GNUNET_YES);
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Created new path %s to create inverse for incoming connection\n",
-       GCPP_2s (path));
   return path;
 }
 
@@ -628,7 +738,7 @@ GCPP_get_peer_at_offset (struct CadetPeerPath *path,
                          unsigned int off)
 {
   GNUNET_assert (off < path->entries_length);
-  return path->entries[off].peer;
+  return path->entries[off]->peer;
 }
 
 
@@ -643,7 +753,7 @@ GCPP_2s (struct CadetPeerPath *path)
 {
   static char buf[2048];
   size_t off;
-  const unsigned int max_plen = sizeof(buf) / 5 - 2; /* 5 characters per entry */
+  const unsigned int max_plen = (sizeof(buf) - 16) / 5 - 2; /* 5 characters per entry */
 
   off = 0;
   for (unsigned int i = 0;
@@ -654,17 +764,22 @@ GCPP_2s (struct CadetPeerPath *path)
          (i == max_plen / 2) )
       off += GNUNET_snprintf (&buf[off],
                               sizeof (buf) - off,
-                              "... ");
+                              "...-");
     if ( (path->entries_length > max_plen) &&
          (i > max_plen / 2) &&
          (i < path->entries_length - max_plen / 2) )
       continue;
     off += GNUNET_snprintf (&buf[off],
                             sizeof (buf) - off,
-                            "%s ",
+                            "%s%s",
                             GNUNET_i2s (GCP_get_id (GCPP_get_peer_at_offset (path,
-                                                                             i))));
+                                                                             i))),
+                            (i == path->entries_length -1) ? "" : "-");
   }
+  GNUNET_snprintf (&buf[off],
+                   sizeof (buf) - off,
+                   "(%p)",
+                   path);
   return buf;
 }