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