src/mesh/mesh_tunnel_tree.h

   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_tree_tree.h
  23  * @brief Tunnel tree handling functions
  24  * @author Bartlomiej Polot
  25  */
  26
  27 #include "mesh.h"
  28
  29 /******************************************************************************/
  30 /************************      DATA STRUCTURES     ****************************/
  31 /******************************************************************************/
  32
  33 /**
  34  * Information regarding a possible path to reach a single peer
  35  */
  36 struct MeshPeerPath
  37 {
  38
  39     /**
  40      * Linked list
  41      */
  42   struct MeshPeerPath *next;
  43   struct MeshPeerPath *prev;
  44
  45     /**
  46      * List of all the peers that form the path from origin to target.
  47      */
  48   GNUNET_PEER_Id *peers;
  49
  50     /**
  51      * Number of peers (hops) in the path
  52      */
  53   unsigned int length;
  54
  55 };
  56
  57
  58 /**
  59  * Node of path tree for a tunnel
  60  */
  61 struct MeshTunnelTreeNode;
  62
  63
  64 /**
  65  * Tree to reach all peers in the tunnel
  66  */
  67 struct MeshTunnelTree;
  68
  69
  70 /******************************************************************************/
  71 /*************************        FUNCTIONS       *****************************/
  72 /******************************************************************************/
  73
  74 /**
  75  * Create a new path
  76  *
  77  * @param lenght How many hops will the path have.
  78  *
  79  * @return A newly allocated path with a peer array of the specified length.
  80  */
  81 struct MeshPeerPath *
  82 path_new (unsigned int length);
  83
  84
  85 /**
  86  * Invert the path
  87  *
  88  * @param p the path to invert
  89  */
  90 void
  91 path_invert (struct MeshPeerPath *p);
  92
  93
  94 /**
  95  * Duplicate a path, incrementing short peer's rc.
  96  *
  97  * @param p The path to duplicate.
  98  */
  99 struct MeshPeerPath *
 100 path_duplicate (struct MeshPeerPath *path);
 101
 102
 103 /**
 104  * Get the length of a path
 105  *
 106  * @param p The path to measure, with the local peer at any point of it
 107  *
 108  * @return Number of hops to reach destination
 109  *         UINT_MAX in case the peer is not in the path
 110  */
 111 unsigned int
 112 path_get_length (struct MeshPeerPath *p);
 113
 114
 115 /**
 116  * Destroy the path and free any allocated resources linked to it
 117  *
 118  * @param p the path to destroy
 119  *
 120  * @return GNUNET_OK on success
 121  */
 122 int
 123 path_destroy (struct MeshPeerPath *p);
 124
 125
 126 /******************************************************************************/
 127
 128 /**
 129  * Method called whenever a node has been marked as disconnected.
 130  *
 131  * @param cls Closure.
 132  * @param peer_id short ID of peer that is no longer reachable.
 133  */
 134 typedef void (*MeshTreeCallback) (void *cls, GNUNET_PEER_Id peer_id);
 135
 136
 137 /**
 138  * Create a new tunnel tree associated to a tunnel
 139  *
 140  * @param peer A short peer id of the root of the tree
 141  *
 142  * @return A newly allocated and initialized tunnel tree
 143  */
 144 struct MeshTunnelTree *
 145 tree_new (GNUNET_PEER_Id peer);
 146
 147
 148 /**
 149  * Set the status of a node.
 150  *
 151  * @param tree Tree.
 152  * @param peer A short peer id of local peer.
 153  */
 154 void
 155 tree_set_status (struct MeshTunnelTree *tree, GNUNET_PEER_Id peer,
 156                  enum MeshPeerState status);
 157
 158
 159 /**
 160  * Get the status of a node.
 161  *
 162  * @param tree Tree whose local id we want to now.
 163  *
 164  * @return Short peer id of local peer.
 165  */
 166 enum MeshPeerState
 167 tree_get_status (struct MeshTunnelTree *tree, GNUNET_PEER_Id peer);
 168
 169
 170 /**
 171  * Get the id of the predecessor of the local node.
 172  *
 173  * @param tree Tree whose local id we want to now.
 174  *
 175  * @return Short peer id of local peer.
 176  */
 177 GNUNET_PEER_Id
 178 tree_get_predecessor (struct MeshTunnelTree *tree);
 179
 180
 181 /**
 182  * Find the first peer whom to send a packet to go down this path
 183  *
 184  * @param t The tunnel tree to use
 185  * @param peer The peerinfo of the peer we are trying to reach
 186  *
 187  * @return peerinfo of the peer who is the first hop in the tunnel
 188  *         NULL on error
 189  */
 190 struct GNUNET_PeerIdentity *
 191 tree_get_first_hop (struct MeshTunnelTree *t, GNUNET_PEER_Id peer);
 192
 193
 194 /**
 195  * Find the given peer in the tree.
 196  *
 197  * @param tree Tree where to look for the peer.
 198  * @param peer Peer to find.
 199  *
 200  * @return Pointer to the node of the peer. NULL if not found.
 201  */
 202 struct MeshTunnelTreeNode *
 203 tree_find_peer (struct MeshTunnelTree *tree, GNUNET_PEER_Id peer_id);
 204
 205
 206 /**
 207  * Iterate over all children of the local node.
 208  *
 209  * @param tree Tree to use. Must have "me" set.
 210  * @param cb Callback to call over each child.
 211  * @param cls Closure.
 212  */
 213 void
 214 tree_iterate_children (struct MeshTunnelTree *tree, MeshTreeCallback cb,
 215                        void *cls);
 216
 217
 218 /**
 219  * Recusively update the info about what is the first hop to reach the node
 220  *
 221  * @param tree Tree this nodes belongs to.
 222  * @param parent_id Short ID from node form which to start updating.
 223  * @param hop If known, ID of the first hop.
 224  *            If not known, NULL to find out and pass on children.
 225  */
 226 void
 227 tree_update_first_hops (struct MeshTunnelTree *tree, GNUNET_PEER_Id parent_id,
 228                         struct GNUNET_PeerIdentity *hop);
 229
 230 /**
 231  * Delete the current path to the peer, including all now unused relays.
 232  * The destination peer is NOT destroyed, it is returned in order to either set
 233  * a new path to it or destroy it explicitly, taking care of it's child nodes.
 234  *
 235  * @param t Tunnel tree where to delete the path from.
 236  * @param peer Destination peer whose path we want to remove.
 237  * @param cb Callback to use to notify about which peers are going to be
 238  *           disconnected.
 239  * @param cbcls Closure for cb.
 240  *
 241  * @return pointer to the pathless node.
 242  *         NULL when not found
 243  */
 244 struct MeshTunnelTreeNode *
 245 tree_del_path (struct MeshTunnelTree *t, GNUNET_PEER_Id peer,
 246                MeshTreeCallback cb, void *cbcls);
 247
 248
 249 /**
 250  * Return a newly allocated individual path to reach a peer from the local peer,
 251  * according to the path tree of some tunnel.
 252  *
 253  * @param t Tunnel from which to read the path tree
 254  * @param peer Destination peer to whom we want a path
 255  *
 256  * @return A newly allocated individual path to reach the destination peer.
 257  *         Path must be destroyed afterwards.
 258  */
 259 struct MeshPeerPath *
 260 tree_get_path_to_peer (struct MeshTunnelTree *t, GNUNET_PEER_Id peer);
 261
 262
 263 /**
 264  * Integrate a stand alone path into the tunnel tree.
 265  *
 266  * @param t Tunnel where to add the new path.
 267  * @param p Path to be integrated.
 268  * @param cb Callback to use to notify about peers temporarily disconnecting.
 269  * @param cbcls Closure for cb.
 270  *
 271  * @return GNUNET_OK in case of success.
 272  *         GNUNET_SYSERR in case of error.
 273  */
 274 int
 275 tree_add_path (struct MeshTunnelTree *t, const struct MeshPeerPath *p,
 276                MeshTreeCallback cb, void *cbcls);
 277
 278
 279 /**
 280  * Notifies a tree that a connection it might be using is broken.
 281  * Marks all peers down the paths as disconnected and notifies the client.
 282  *
 283  * @param t Tree to use.
 284  * @param p1 Short id of one of the peers (order unimportant)
 285  * @param p2 Short id of one of the peers (order unimportant)
 286  * @param cb Function to call for every peer that is marked as disconnected.
 287  * @param cbcls Closure for cb.
 288  *
 289  * @return Short ID of the first disconnected peer in the tree.
 290  */
 291 GNUNET_PEER_Id
 292 tree_notify_connection_broken (struct MeshTunnelTree *t, GNUNET_PEER_Id p1,
 293                                GNUNET_PEER_Id p2, MeshTreeCallback cb,
 294                                void *cbcls);
 295
 296
 297 /**
 298  * Deletes a peer from a tunnel, liberating all unused resources on the path to
 299  * it. It shouldn't have children, if it has they will be destroyed as well.
 300  * If the tree is not local and no longer has any paths, the root node will be
 301  * destroyed and marked as NULL.
 302  *
 303  * @param t Tunnel tree to use.
 304  * @param peer Short ID of the peer to remove from the tunnel tree.
 305  * @param cb Callback to notify client of disconnected peers.
 306  * @param cbcls Closure for cb.
 307  *
 308  * @return GNUNET_YES if the tunnel still has nodes
 309  */
 310 int
 311 tree_del_peer (struct MeshTunnelTree *t, GNUNET_PEER_Id peer,
 312                MeshTreeCallback cb, void *cbcls);
 313
 314
 315 /**
 316  * Get the cost of the path relative to the already built tunnel tree
 317  *
 318  * @param t The tunnel tree to which compare
 319  * @param path The individual path to reach a peer
 320  *
 321  * @return Number of hops to reach destination, UINT_MAX in case the peer is not
 322  * in the path
 323  */
 324 unsigned int
 325 tree_get_path_cost (struct MeshTunnelTree *t, struct MeshPeerPath *path);
 326
 327
 328 /**
 329  * Print the tree on stderr
 330  *
 331  * @param t The tree
 332  */
 333 void
 334 tree_debug (struct MeshTunnelTree *t);
 335
 336
 337 /**
 338  * Destroy the whole tree and free all used memory and Peer_Ids
 339  *
 340  * @param t Tree to be destroyed
 341  */
 342 void
 343 tree_destroy (struct MeshTunnelTree *t);