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  * Get the cost of the path relative to the already built tunnel tree
 117  *
 118  * @param t The tunnel tree to which compare
 119  * @param path The individual path to reach a peer
 120  *
 121  * @return Number of hops to reach destination, UINT_MAX in case the peer is not
 122  * in the path
 123  */
 124 unsigned int
 125 path_get_cost (struct MeshTunnelTree *t, struct MeshPeerPath *path);
 126
 127
 128 /**
 129  * Destroy the path and free any allocated resources linked to it
 130  *
 131  * @param p the path to destroy
 132  *
 133  * @return GNUNET_OK on success
 134  */
 135 int
 136 path_destroy (struct MeshPeerPath *p);
 137
 138
 139 /******************************************************************************/
 140
 141 /**
 142  * Method called whenever a node has been marked as disconnected.
 143  *
 144  * @param cls Closure.
 145  * @param peer_id short ID of peer that is no longer reachable.
 146  */
 147 typedef void (*MeshTreeCallback) (void *cls, GNUNET_PEER_Id peer_id);
 148
 149
 150 /**
 151  * Create a new tunnel tree associated to a tunnel
 152  *
 153  * @param peer A short peer id of the root of the tree
 154  *
 155  * @return A newly allocated and initialized tunnel tree
 156  */
 157 struct MeshTunnelTree *
 158 tree_new (GNUNET_PEER_Id peer);
 159
 160
 161 /**
 162  * Set the status of a node.
 163  *
 164  * @param tree Tree.
 165  * @param peer A short peer id of local peer.
 166  */
 167 void
 168 tree_set_status (struct MeshTunnelTree *tree, GNUNET_PEER_Id peer,
 169                  enum MeshPeerState status);
 170
 171
 172 /**
 173  * Get the status of a node.
 174  *
 175  * @param tree Tree whose local id we want to now.
 176  *
 177  * @return Short peer id of local peer.
 178  */
 179 enum MeshPeerState
 180 tree_get_status (struct MeshTunnelTree *tree, GNUNET_PEER_Id peer);
 181
 182
 183 /**
 184  * Get the id of the predecessor of the local node.
 185  *
 186  * @param tree Tree whose local id we want to now.
 187  *
 188  * @return Short peer id of local peer.
 189  */
 190 GNUNET_PEER_Id
 191 tree_get_predecessor (struct MeshTunnelTree *tree);
 192
 193
 194 /**
 195  * Find the first peer whom to send a packet to go down this path
 196  *
 197  * @param t The tunnel tree to use
 198  * @param peer The peerinfo of the peer we are trying to reach
 199  *
 200  * @return peerinfo of the peer who is the first hop in the tunnel
 201  *         NULL on error
 202  */
 203 struct GNUNET_PeerIdentity *
 204 tree_get_first_hop (struct MeshTunnelTree *t, GNUNET_PEER_Id peer);
 205
 206
 207 /**
 208  * Find the given peer in the tree.
 209  *
 210  * @param tree Tree where to look for the peer.
 211  * @param peer Peer to find.
 212  *
 213  * @return Pointer to the node of the peer. NULL if not found.
 214  */
 215 struct MeshTunnelTreeNode *
 216 tree_find_peer (struct MeshTunnelTree *tree, GNUNET_PEER_Id peer_id);
 217
 218
 219 /**
 220  * Iterate over all children of the local node.
 221  *
 222  * @param tree Tree to use. Must have "me" set.
 223  * @param cb Callback to call over each child.
 224  * @param cls Closure.
 225  */
 226 void
 227 tree_iterate_children (struct MeshTunnelTree *tree, MeshTreeCallback cb,
 228                        void *cls);
 229
 230
 231 /**
 232  * Recusively update the info about what is the first hop to reach the node
 233  *
 234  * @param tree Tree this nodes belongs to.
 235  * @param parent_id Short ID from node form which to start updating.
 236  * @param hop If known, ID of the first hop.
 237  *            If not known, NULL to find out and pass on children.
 238  */
 239 void
 240 tree_update_first_hops (struct MeshTunnelTree *tree, GNUNET_PEER_Id parent_id,
 241                         struct GNUNET_PeerIdentity *hop);
 242
 243 /**
 244  * Delete the current path to the peer, including all now unused relays.
 245  * The destination peer is NOT destroyed, it is returned in order to either set
 246  * a new path to it or destroy it explicitly, taking care of it's child nodes.
 247  *
 248  * @param t Tunnel tree where to delete the path from.
 249  * @param peer Destination peer whose path we want to remove.
 250  * @param cb Callback to use to notify about which peers are going to be
 251  *           disconnected.
 252  * @param cbcls Closure for cb.
 253  *
 254  * @return pointer to the pathless node.
 255  *         NULL when not found
 256  */
 257 struct MeshTunnelTreeNode *
 258 tree_del_path (struct MeshTunnelTree *t, GNUNET_PEER_Id peer,
 259                MeshTreeCallback cb, void *cbcls);
 260
 261
 262 /**
 263  * Return a newly allocated individual path to reach a peer from the local peer,
 264  * according to the path tree of some tunnel.
 265  *
 266  * @param t Tunnel from which to read the path tree
 267  * @param peer Destination peer to whom we want a path
 268  *
 269  * @return A newly allocated individual path to reach the destination peer.
 270  *         Path must be destroyed afterwards.
 271  */
 272 struct MeshPeerPath *
 273 tree_get_path_to_peer (struct MeshTunnelTree *t, GNUNET_PEER_Id peer);
 274
 275
 276 /**
 277  * Integrate a stand alone path into the tunnel tree.
 278  *
 279  * @param t Tunnel where to add the new path.
 280  * @param p Path to be integrated.
 281  * @param cb Callback to use to notify about peers temporarily disconnecting.
 282  * @param cbcls Closure for cb.
 283  *
 284  * @return GNUNET_OK in case of success.
 285  *         GNUNET_SYSERR in case of error.
 286  */
 287 int
 288 tree_add_path (struct MeshTunnelTree *t, const struct MeshPeerPath *p,
 289                MeshTreeCallback cb, void *cbcls);
 290
 291
 292 /**
 293  * Notifies a tree that a connection it might be using is broken.
 294  * Marks all peers down the paths as disconnected and notifies the client.
 295  *
 296  * @param t Tree to use.
 297  * @param p1 Short id of one of the peers (order unimportant)
 298  * @param p2 Short id of one of the peers (order unimportant)
 299  * @param cb Function to call for every peer that is marked as disconnected.
 300  * @param cbcls Closure for cb.
 301  *
 302  * @return Short ID of the first disconnected peer in the tree.
 303  */
 304 GNUNET_PEER_Id
 305 tree_notify_connection_broken (struct MeshTunnelTree *t, GNUNET_PEER_Id p1,
 306                                GNUNET_PEER_Id p2, MeshTreeCallback cb,
 307                                void *cbcls);
 308
 309
 310 /**
 311  * Deletes a peer from a tunnel, liberating all unused resources on the path to
 312  * it. It shouldn't have children, if it has they will be destroyed as well.
 313  * If the tree is not local and no longer has any paths, the root node will be
 314  * destroyed and marked as NULL.
 315  *
 316  * @param t Tunnel tree to use.
 317  * @param peer Short ID of the peer to remove from the tunnel tree.
 318  * @param cb Callback to notify client of disconnected peers.
 319  * @param cbcls Closure for cb.
 320  *
 321  * @return GNUNET_YES if the tunnel still has nodes
 322  */
 323 int
 324 tree_del_peer (struct MeshTunnelTree *t, GNUNET_PEER_Id peer,
 325                MeshTreeCallback cb, void *cbcls);
 326
 327 /**
 328  * Print the tree on stderr
 329  *
 330  * @param t The tree
 331  */
 332 void
 333 tree_debug (struct MeshTunnelTree *t);
 334
 335
 336 /**
 337  * Destroy the whole tree and free all used memory and Peer_Ids
 338  *
 339  * @param t Tree to be destroyed
 340  */
 341 void
 342 tree_destroy (struct MeshTunnelTree *t);