src/mesh/mesh_tunnel_tree.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001 - 2011 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 mesh/mesh_tunnel_tree.c
  23  * @brief Tunnel tree handling functions
  24  * @author Bartlomiej Polot
  25  */
  26
  27 #include "mesh.h"
  28 #include "mesh_tunnel_tree.h"
  29
  30 #define MESH_TREE_DEBUG GNUNET_YES
  31
  32
  33 /**
  34  * Create a new path
  35  *
  36  * @param lenght How many hops will the path have.
  37  *
  38  * @return A newly allocated path with a peer array of the specified length.
  39  */
  40 struct MeshPeerPath *
  41 path_new (unsigned int length)
  42 {
  43   struct MeshPeerPath *p;
  44
  45   p = GNUNET_malloc (sizeof(struct MeshPeerPath));
  46   if (length > 0)
  47   {
  48     p->length = length;
  49     p->peers = GNUNET_malloc (length * sizeof(GNUNET_PEER_Id));
  50   }
  51   return p;
  52 }
  53
  54
  55 /**
  56  * Invert the path
  57  *
  58  * @param p the path to invert
  59  */
  60 void
  61 path_invert (struct MeshPeerPath *path)
  62 {
  63   GNUNET_PEER_Id aux;
  64   unsigned int i;
  65
  66   for (i = 0; i < path->length / 2; i++)
  67   {
  68     aux = path->peers[i];
  69     path->peers[i] = path->peers[path->length - i - 1];
  70     path->peers[path->length - i - 1] = aux;
  71   }
  72 }
  73
  74
  75 /**
  76  * Duplicate a path, incrementing short peer's rc.
  77  *
  78  * @param p The path to duplicate.
  79  */
  80 struct MeshPeerPath *
  81 path_duplicate (struct MeshPeerPath *path)
  82 {
  83   struct MeshPeerPath *aux;
  84   unsigned int i;
  85
  86   aux = path_new(path->length);
  87   memcpy (aux->peers, path->peers, path->length * sizeof(GNUNET_PEER_Id));
  88   for (i = 0; i < path->length; i++)
  89     GNUNET_PEER_change_rc(path->peers[i], 1);
  90   return aux;
  91 }
  92
  93
  94 /**
  95  * Find the first peer whom to send a packet to go down this path
  96  *
  97  * @param t The tunnel tree to use
  98  * @param peer The peerinfo of the peer we are trying to reach
  99  *
 100  * @return peerinfo of the peer who is the first hop in the tunnel
 101  *         NULL on error
 102  */
 103 struct GNUNET_PeerIdentity *
 104 path_get_first_hop (struct MeshTunnelTree *t, GNUNET_PEER_Id peer)
 105 {
 106   struct GNUNET_PeerIdentity id;
 107   struct GNUNET_PeerIdentity *r;
 108
 109   GNUNET_PEER_resolve (peer, &id);
 110   r = GNUNET_CONTAINER_multihashmap_get (t->first_hops, &id.hashPubKey);
 111   GNUNET_break (NULL != r);
 112
 113   return r;
 114 }
 115
 116
 117 /**
 118  * Get the length of a path
 119  *
 120  * @param path The path to measure, with the local peer at any point of it
 121  *
 122  * @return Number of hops to reach destination
 123  *         UINT_MAX in case the peer is not in the path
 124  */
 125 unsigned int
 126 path_get_length (struct MeshPeerPath *path)
 127 {
 128   if (NULL == path)
 129     return UINT_MAX;
 130   return path->length;
 131 }
 132
 133
 134 /**
 135  * Get the cost of the path relative to the already built tunnel tree
 136  *
 137  * @param t The tunnel tree to which compare
 138  * @param path The individual path to reach a peer
 139  *
 140  * @return Number of hops to reach destination, UINT_MAX in case the peer is not
 141  * in the path
 142  *
 143  * TODO: remove dummy implementation, look into the tunnel tree
 144  */
 145 unsigned int
 146 path_get_cost (struct MeshTunnelTree *t, struct MeshPeerPath *path)
 147 {
 148   return path_get_length (path);
 149 }
 150
 151
 152 /**
 153  * Destroy the path and free any allocated resources linked to it
 154  *
 155  * @param p the path to destroy
 156  *
 157  * @return GNUNET_OK on success
 158  */
 159 int
 160 path_destroy (struct MeshPeerPath *p)
 161 {
 162   if (NULL == p)
 163     return GNUNET_OK;
 164   GNUNET_PEER_decrement_rcs (p->peers, p->length);
 165   GNUNET_free (p->peers);
 166   GNUNET_free (p);
 167   return GNUNET_OK;
 168 }
 169
 170
 171
 172 /**
 173  * Allocates and initializes a new node.
 174  * Sets ID and parent of the new node and inserts it in the DLL of the parent
 175  *
 176  * @param parent Node that will be the parent from the new node, NULL for root
 177  * @param peer Short Id of the new node
 178  *
 179  * @return Newly allocated node
 180  */
 181 static struct MeshTunnelTreeNode *
 182 tree_node_new(struct MeshTunnelTreeNode *parent, GNUNET_PEER_Id peer)
 183 {
 184   struct MeshTunnelTreeNode *node;
 185
 186   node = GNUNET_malloc(sizeof(struct MeshTunnelTreeNode));
 187   node->peer = peer;
 188   GNUNET_PEER_change_rc(peer, 1);
 189   node->parent = parent;
 190   if (NULL != parent)
 191     GNUNET_CONTAINER_DLL_insert(parent->children_head,
 192                                 parent->children_tail,
 193                                 node);
 194
 195   return node;
 196 }
 197
 198
 199 static void
 200 tree_node_debug(struct MeshTunnelTreeNode *n, uint16_t level)
 201 {
 202   struct MeshTunnelTreeNode *c;
 203   struct GNUNET_PeerIdentity id;;
 204   uint16_t i;
 205
 206   for (i = 0; i < level; i++)
 207     fprintf(stderr, "  ");
 208   if (n->status == MESH_PEER_READY)
 209     fprintf(stderr, "#");
 210   if (n->status == MESH_PEER_SEARCHING)
 211     fprintf(stderr, "+");
 212   if (n->status == MESH_PEER_RELAY)
 213     fprintf(stderr, "-");
 214   if (n->status == MESH_PEER_RECONNECTING)
 215     fprintf(stderr, "*");
 216
 217   GNUNET_PEER_resolve(n->peer, &id);
 218   fprintf(stderr, "%s, [%u, %p] ", GNUNET_i2s (&id), n->peer, n);
 219   if (NULL != n->parent)
 220   {
 221     GNUNET_PEER_resolve(n->parent->peer, &id);
 222     fprintf(stderr, "(-> %s [%u])\n", GNUNET_i2s(&id), n->parent->peer);
 223   }
 224   else
 225     fprintf(stderr, "(root)\n");
 226   for (c = n->children_head; NULL != c; c = c->next)
 227     tree_node_debug(c, level + 1);
 228 }
 229
 230
 231 /**
 232  * Destroys and frees the node and all children
 233  *
 234  * @param n Parent node to be destroyed
 235  */
 236 static void
 237 tree_node_destroy (struct MeshTunnelTreeNode *parent)
 238 {
 239   struct MeshTunnelTreeNode *n;
 240   struct MeshTunnelTreeNode *next;
 241 #if MESH_TREE_DEBUG
 242   struct GNUNET_PeerIdentity id;
 243
 244   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 245               "tree: Destroying node %u\n",
 246               parent->peer);
 247   GNUNET_PEER_resolve (parent->peer, &id);
 248   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 249               "tree:   (%s)\n",
 250               GNUNET_i2s (&id));
 251 #endif
 252   n = parent->children_head;
 253   while (NULL != n)
 254   {
 255     next = n->next;
 256     tree_node_destroy(n);
 257     n = next;
 258   }
 259   GNUNET_PEER_change_rc(parent->peer, -1);
 260   if (NULL != parent->parent)
 261     GNUNET_CONTAINER_DLL_remove(parent->parent->children_head,
 262                                 parent->parent->children_tail,
 263                                 parent);
 264   GNUNET_free(parent);
 265 }
 266
 267
 268
 269 /**
 270  * Create a new tunnel tree associated to a tunnel
 271  *
 272  * @param t Tunnel this tree will represent
 273  * @param peer A short peer id of the root of the tree
 274  *
 275  * @return A newly allocated and initialized tunnel tree
 276  */
 277 struct MeshTunnelTree *
 278 tree_new (struct MeshTunnel *t, GNUNET_PEER_Id peer)
 279 {
 280   struct MeshTunnelTree *tree;
 281
 282   tree = GNUNET_malloc(sizeof (struct MeshTunnelTree));
 283   tree->first_hops = GNUNET_CONTAINER_multihashmap_create(32);
 284   tree->root = tree_node_new(NULL, peer);
 285   tree->root->status = MESH_PEER_ROOT;
 286   tree->t = t;
 287   tree->root->t = t;
 288
 289   return tree;
 290 }
 291
 292
 293 /**
 294  * Recursively find the given peer in the tree.
 295  *
 296  * @param t Tunnel where to look for the peer.
 297  * @param peer Peer to find
 298  *
 299  * @return Pointer to the node of the peer. NULL if not found.
 300  */
 301 struct MeshTunnelTreeNode *
 302 tree_find_peer (struct MeshTunnelTreeNode *parent, GNUNET_PEER_Id peer_id)
 303 {
 304   struct MeshTunnelTreeNode *n;
 305   struct MeshTunnelTreeNode *r;
 306
 307   if (parent->peer == peer_id)
 308     return parent;
 309   for (n = parent->children_head; NULL != n; n = n->next)
 310   {
 311     r = tree_find_peer (n, peer_id);
 312     if (NULL != r)
 313       return r;
 314   }
 315   return NULL;
 316 }
 317
 318
 319 /**
 320  * Recusively mark peer and children as disconnected, notify client
 321  *
 322  * @param tree Tree this node belongs to
 323  * @param parent Node to be clean, potentially with children
 324  * @param cb Callback to use to notify about disconnected peers.
 325  */
 326 static void
 327 tree_mark_peers_disconnected (struct MeshTunnelTree *tree,
 328                               struct MeshTunnelTreeNode *parent,
 329                               MeshNodeDisconnectCB cb)
 330 {
 331   struct GNUNET_PeerIdentity *pi;
 332   struct GNUNET_PeerIdentity id;
 333   struct MeshTunnelTreeNode *n;
 334
 335   for (n = parent->children_head; NULL != n; n = n->next)
 336   {
 337     tree_mark_peers_disconnected (tree, n, cb);
 338   }
 339   if (MESH_PEER_READY == parent->status)
 340   {
 341     if (NULL != cb)
 342       cb (parent);
 343     parent->status = MESH_PEER_RECONNECTING;
 344   }
 345
 346   /* Remove and free info about first hop */
 347   GNUNET_PEER_resolve(parent->peer, &id);
 348   pi = GNUNET_CONTAINER_multihashmap_get(tree->first_hops, &id.hashPubKey);
 349   GNUNET_CONTAINER_multihashmap_remove_all(tree->first_hops, &id.hashPubKey);
 350   if (NULL != pi)
 351     GNUNET_free(pi);
 352 }
 353
 354
 355 /**
 356  * Recusively update the info about what is the first hop to reach the node
 357  *
 358  * @param tree Tree this nodes belongs to
 359  * @param parent Node to be start updating
 360  * @param hop If known, ID of the first hop.
 361  *            If not known, NULL to find out and pass on children.
 362  */
 363 void
 364 tree_update_first_hops (struct MeshTunnelTree *tree,
 365                         struct MeshTunnelTreeNode *parent,
 366                         struct GNUNET_PeerIdentity *hop)
 367 {
 368   struct GNUNET_PeerIdentity pi;
 369   struct GNUNET_PeerIdentity *copy;
 370   struct GNUNET_PeerIdentity id;
 371   struct MeshTunnelTreeNode *n;
 372
 373 #if MESH_TREE_DEBUG
 374   GNUNET_PEER_resolve(parent->peer, &id);
 375   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 376           "tree:   Finding first hop for %s.\n",
 377           GNUNET_i2s (&id));
 378 #endif
 379   if (NULL == hop)
 380   {
 381     struct MeshTunnelTreeNode *aux;
 382     struct MeshTunnelTreeNode *old;
 383
 384     aux = old = parent;
 385     while (aux != tree->me)
 386     {
 387 #if MESH_TREE_DEBUG
 388       GNUNET_PEER_resolve(old->peer, &id);
 389       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 390              "tree:   ... its not %s.\n",
 391              GNUNET_i2s (&id));
 392 #endif
 393       old = aux;
 394       aux = aux->parent;
 395       GNUNET_assert(NULL != aux);
 396     }
 397 #if MESH_TREE_DEBUG
 398     GNUNET_PEER_resolve(old->peer, &id);
 399     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 400                "tree:   It's %s!\n",
 401                GNUNET_i2s (&id));
 402 #endif
 403     hop = &pi;
 404     GNUNET_PEER_resolve(old->peer, hop);
 405   }
 406   GNUNET_PEER_resolve(parent->peer, &id);
 407   copy = GNUNET_CONTAINER_multihashmap_get (tree->first_hops, &id.hashPubKey);
 408   if (NULL == copy)
 409     copy = GNUNET_malloc(sizeof(struct GNUNET_PeerIdentity));
 410   *copy = *hop;
 411
 412   (void) GNUNET_CONTAINER_multihashmap_put(
 413     tree->first_hops,
 414     &id.hashPubKey,
 415     copy,
 416     GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
 417
 418   for (n = parent->children_head; NULL != n; n = n->next)
 419   {
 420     tree_update_first_hops (tree, n, hop);
 421   }
 422 }
 423
 424
 425 /**
 426  * Delete the current path to the peer, including all now unused relays.
 427  * The destination peer is NOT destroyed, it is returned in order to either set
 428  * a new path to it or destroy it explicitly, taking care of it's child nodes.
 429  *
 430  * @param t Tunnel tree where to delete the path from.
 431  * @param peer Destination peer whose path we want to remove.
 432  * @param cb Callback to use to notify about disconnected peers.
 433  *
 434  * @return pointer to the pathless node.
 435  *         NULL when not found
 436  */
 437 struct MeshTunnelTreeNode *
 438 tree_del_path (struct MeshTunnelTree *t,
 439                GNUNET_PEER_Id peer_id,
 440                MeshNodeDisconnectCB cb)
 441 {
 442   struct MeshTunnelTreeNode *parent;
 443   struct MeshTunnelTreeNode *node;
 444   struct MeshTunnelTreeNode *n;
 445
 446 #if MESH_TREE_DEBUG
 447   struct GNUNET_PeerIdentity id;
 448   GNUNET_PEER_resolve(peer_id, &id);
 449   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 450           "tree:   Deleting path to %s.\n",
 451           GNUNET_i2s (&id));
 452 #endif
 453   if (peer_id == t->root->peer)
 454     return NULL;
 455
 456   for (n = t->disconnected_head; NULL != n; n = n->next)
 457   {
 458     if (n->peer == peer_id)
 459     {
 460       /* Was already pathless, waiting for reconnection */
 461       GNUNET_CONTAINER_DLL_remove (t->disconnected_head,
 462                                    t->disconnected_tail,
 463                                    n);
 464       return n;
 465     }
 466   }
 467   n = tree_find_peer (t->root, peer_id);
 468   if (NULL == n)
 469     return NULL;
 470   node = n;
 471
 472   parent = n->parent;
 473   GNUNET_CONTAINER_DLL_remove(parent->children_head, parent->children_tail, n);
 474   n->parent = NULL;
 475
 476   while (MESH_PEER_RELAY == parent->status && NULL == parent->children_head)
 477   {
 478 #if MESH_TREE_DEBUG
 479     GNUNET_PEER_resolve(parent->peer, &id);
 480     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 481               "tree:   Deleting node %s.\n",
 482               GNUNET_i2s (&id));
 483 #endif
 484     n = parent->parent;
 485     tree_node_destroy(parent);
 486     parent = n;
 487   }
 488 #if MESH_TREE_DEBUG
 489   GNUNET_PEER_resolve(parent->peer, &id);
 490   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 491              "tree:   Not deleted peer %s.\n",
 492              GNUNET_i2s (&id));
 493 #endif
 494
 495   tree_mark_peers_disconnected (t, node, cb);
 496
 497   return node;
 498 }
 499
 500
 501 /**
 502  * Return a newly allocated individual path to reach a peer from the local peer,
 503  * according to the path tree of some tunnel.
 504  *
 505  * @param t Tunnel from which to read the path tree
 506  * @param peer_info Destination peer to whom we want a path
 507  *
 508  * @return A newly allocated individual path to reach the destination peer.
 509  *         Path must be destroyed afterwards.
 510  */
 511 struct MeshPeerPath *
 512 tree_get_path_to_peer(struct MeshTunnelTree *t, GNUNET_PEER_Id peer)
 513 {
 514   struct MeshTunnelTreeNode *n;
 515   struct MeshPeerPath *p;
 516   GNUNET_PEER_Id myid = t->me->peer;
 517
 518   n = tree_find_peer(t->me, peer);
 519   p = path_new(0);
 520
 521   /* Building the path (inverted!) */
 522   while (n->peer != myid)
 523   {
 524     GNUNET_array_append(p->peers, p->length, n->peer);
 525     GNUNET_PEER_change_rc(n->peer, 1);
 526     n = n->parent;
 527     GNUNET_assert(NULL != n);
 528   }
 529   GNUNET_array_append(p->peers, p->length, myid);
 530   GNUNET_PEER_change_rc(myid, 1);
 531
 532   path_invert(p);
 533
 534   return p;
 535 }
 536
 537
 538
 539 /**
 540  * Integrate a stand alone path into the tunnel tree.
 541  * If the peer toward which the new path is already in the tree, the peer
 542  * and its children will be maked as disconnected and the callback
 543  * will be called on each one of them. They will be maked as online only after
 544  * receiving a PATH ACK for the new path for each one of them, so the caller
 545  * should take care of sending a new CREATE PATH message for each disconnected
 546  * peer.
 547  *
 548  * @param t Tunnel where to add the new path.
 549  * @param p Path to be integrated.
 550  * @param cb Callback to use to notify about peers temporarily disconnecting
 551  *
 552  * @return GNUNET_OK in case of success.
 553  *         GNUNET_SYSERR in case of error.
 554  *
 555  * TODO: optimize
 556  * - go backwards on path looking for each peer in the present tree
 557  * - do not disconnect peers until new path is created & connected
 558  */
 559 int
 560 tree_add_path (struct MeshTunnelTree *t,
 561                const struct MeshPeerPath *p,
 562                MeshNodeDisconnectCB cb)
 563 {
 564   struct MeshTunnelTreeNode *parent;
 565   struct MeshTunnelTreeNode *oldnode;
 566   struct MeshTunnelTreeNode *n;
 567   struct MeshTunnelTreeNode *c;
 568   struct GNUNET_PeerIdentity id;
 569   GNUNET_PEER_Id myid;
 570   int me;
 571 //   int oldnode_is_me;
 572   unsigned int i;
 573
 574 #if MESH_TREE_DEBUG
 575   GNUNET_PEER_resolve(p->peers[p->length - 1], &id);
 576   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 577              "tree:   Adding path [%u] towards peer %s.\n",
 578             p->length,
 579             GNUNET_i2s (&id));
 580 #endif
 581
 582   if (NULL != t->me)
 583     myid = t->me->peer;
 584   else
 585     myid = 0;
 586   GNUNET_assert(0 != p->length);
 587   parent = n = t->root;
 588   if (n->peer != p->peers[0])
 589   {
 590     GNUNET_break (0);
 591     return GNUNET_SYSERR;
 592   }
 593   if (1 == p->length)
 594     return GNUNET_OK;
 595   oldnode = tree_del_path (t, p->peers[p->length - 1], cb);
 596   /* Look for the first node that is not already present in the tree
 597    *
 598    * Assuming that the tree is somewhat balanced, O(log n * log N).
 599    * - Length of the path is expected to be log N (size of whole network).
 600    * - Each level of the tree is expected to have log n children (size of tree).
 601    */
 602   me = t->root->peer == myid ? 0 : -1;
 603   for (i = 1; i < p->length; i++)
 604   {
 605 #if MESH_TREE_DEBUG
 606     GNUNET_PEER_resolve(p->peers[i], &id);
 607     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 608                "tree:   Looking for peer %s.\n",
 609                GNUNET_i2s (&id));
 610 #endif
 611     parent = n;
 612     if (p->peers[i] == myid)
 613       me = i;
 614     for (c = n->children_head; NULL != c; c = c->next)
 615     {
 616       if (c->peer == p->peers[i])
 617       {
 618 #if MESH_TREE_DEBUG
 619         GNUNET_PEER_resolve(parent->peer, &id);
 620         GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 621                    "tree:   Found in children of %s.\n",
 622                    GNUNET_i2s (&id));
 623 #endif
 624         n = c;
 625         break;
 626       }
 627     }
 628     /*  If we couldn't find a child equal to path[i], we have reached the end
 629      * of the common path. */
 630     if (parent == n)
 631       break;
 632   }
 633 #if MESH_TREE_DEBUG
 634   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 635              "tree:   All childen visited.\n");
 636 #endif
 637   /* Add the rest of the path as a branch from parent. */
 638   while (i < p->length)
 639   {
 640 #if MESH_TREE_DEBUG
 641     GNUNET_PEER_resolve(p->peers[i], &id);
 642     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 643                "tree:   Adding  peer %s.\n",
 644                GNUNET_i2s (&id));
 645     GNUNET_PEER_resolve(parent->peer, &id);
 646     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 647                "tree:     to %s.\n",
 648                GNUNET_i2s (&id));
 649 #endif
 650
 651     if (i == p->length - 1 && NULL != oldnode)
 652     {
 653 #if MESH_TREE_DEBUG
 654       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 655                  "tree:   Putting old node into place.\n");
 656 #endif
 657       oldnode->parent = parent;
 658       GNUNET_CONTAINER_DLL_insert(parent->children_head,
 659                                   parent->children_tail,
 660                                   oldnode);
 661       tree_update_first_hops (t, oldnode, NULL);
 662       n = oldnode;
 663     }
 664     else
 665     {
 666 #if MESH_TREE_DEBUG
 667       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "tree:   Creating new node.\n");
 668 #endif
 669       n = tree_node_new(parent, p->peers[i]);
 670       n->t = t->t;
 671       n->status = MESH_PEER_RELAY;
 672     }
 673     i++;
 674     parent = n;
 675   }
 676   n->status = MESH_PEER_SEARCHING;
 677
 678   /* Add info about first hop into hashmap. */
 679   if (-1 != me && me < p->length - 1)
 680   {
 681 #if MESH_TREE_DEBUG
 682     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 683                 "MESH:   finding first hop (own pos %d/%u)\n",
 684                 me, p->length - 1);
 685 #endif
 686     GNUNET_PEER_resolve (p->peers[me + 1], &id);
 687     tree_update_first_hops(t,
 688                            tree_find_peer(t->root, p->peers[p->length - 1]),
 689                            &id);
 690   }
 691 #if MESH_TREE_DEBUG
 692   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "tree:   New node added.\n");
 693 #endif
 694   return GNUNET_OK;
 695 }
 696
 697
 698 /**
 699  * Notifies a tree that a connection it might be using is broken.
 700  * Marks all peers down the paths as disconnected and notifies the client.
 701  *
 702  * @param t Tree to use.
 703  * @param p1 Short id of one of the peers (order unimportant)
 704  * @param p2 Short id of one of the peers (order unimportant)
 705  * @param cb Function to call for every peer that is marked as disconnected.
 706  *
 707  * @return Short ID of the first disconnected peer in the tree.
 708  */
 709 GNUNET_PEER_Id
 710 tree_notify_connection_broken (struct MeshTunnelTree *t,
 711                                GNUNET_PEER_Id p1,
 712                                GNUNET_PEER_Id p2,
 713                                MeshNodeDisconnectCB cb)
 714 {
 715   struct MeshTunnelTreeNode *n;
 716   struct MeshTunnelTreeNode *c;
 717
 718   n = tree_find_peer(t->me, p1);
 719   if (NULL == n)
 720     return 0;
 721   if (NULL != n->parent && n->parent->peer == p2)
 722   {
 723     tree_mark_peers_disconnected(t, n, cb);
 724     GNUNET_CONTAINER_DLL_remove(n->parent->children_head,
 725                                 n->parent->children_tail,
 726                                 n);
 727     GNUNET_CONTAINER_DLL_insert(t->disconnected_head,
 728                                 t->disconnected_tail,
 729                                 n);
 730     return p1;
 731   }
 732   for (c = n->children_head; NULL != c; c = c->next)
 733   {
 734     if (c->peer == p2)
 735     {
 736       tree_mark_peers_disconnected(t, c, cb);
 737       GNUNET_CONTAINER_DLL_remove(n->children_head,
 738                                   n->children_tail,
 739                                   c);
 740       GNUNET_CONTAINER_DLL_insert(t->disconnected_head,
 741                                   t->disconnected_tail,
 742                                   c);
 743       return p2;
 744     }
 745   }
 746   return 0;
 747 }
 748
 749
 750 /**
 751  * Deletes a peer from a tunnel, liberating all unused resources on the path to
 752  * it. It shouldn't have children, if it has they will be destroyed as well.
 753  * If the tree is not local and no longer has any paths, the root node will be
 754  * destroyed and marked as NULL.
 755  *
 756  * @param t Tunnel tree to use.
 757  * @param peer Short ID of the peer to remove from the tunnel tree.
 758  * @param cb Callback to notify client of disconnected peers.
 759  *
 760  * @return GNUNET_OK or GNUNET_SYSERR
 761  */
 762 int
 763 tree_del_peer (struct MeshTunnelTree *t,
 764                GNUNET_PEER_Id peer,
 765                MeshNodeDisconnectCB cb)
 766 {
 767   struct MeshTunnelTreeNode *n;
 768
 769   n = tree_del_path(t, peer, cb);
 770   if (NULL == n)
 771     return GNUNET_SYSERR;
 772   GNUNET_break_op (NULL == n->children_head);
 773   tree_node_destroy(n);
 774   if (NULL == t->root->children_head && t->me != t->root)
 775   {
 776     tree_node_destroy (t->root);
 777     t->root = NULL;
 778   }
 779   return GNUNET_OK;
 780 }
 781
 782
 783 /**
 784  * Print the tree on stderr
 785  *
 786  * @param t The tree
 787  */
 788 void
 789 tree_debug(struct MeshTunnelTree *t)
 790 {
 791   tree_node_debug(t->root, 0);
 792 }
 793
 794
 795 /**
 796  * Iterator over hash map peer entries and frees all data in it.
 797  * Used prior to destroying a hashmap. Makes you miss anonymous functions in C.
 798  *
 799  * @param cls closure
 800  * @param key current key code (will no longer contain valid data!!)
 801  * @param value value in the hash map (treated as void *)
 802  * @return GNUNET_YES if we should continue to iterate, GNUNET_NO if not.
 803  */
 804 static int
 805 iterate_free (void *cls, const GNUNET_HashCode * key, void *value)
 806 {
 807   GNUNET_free(value);
 808   return GNUNET_YES;
 809 }
 810
 811
 812 /**
 813  * Destroy the whole tree and free all used memory and Peer_Ids
 814  *
 815  * @param t Tree to be destroyed
 816  */
 817 void
 818 tree_destroy (struct MeshTunnelTree *t)
 819 {
 820 #if MESH_TREE_DEBUG
 821   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "tree: Destroying tree\n");
 822 #endif
 823   tree_node_destroy(t->root);
 824   GNUNET_CONTAINER_multihashmap_iterate(t->first_hops, &iterate_free, NULL);
 825   GNUNET_CONTAINER_multihashmap_destroy(t->first_hops);
 826   GNUNET_free(t);
 827 }