*/
/**
- * @file mesh/mesh_tunnel_tree.h
+ * @file mesh/mesh_tree_tree.h
* @brief Tunnel tree handling functions
* @author Bartlomiej Polot
*/
#include "mesh.h"
+/******************************************************************************/
+/************************ DATA STRUCTURES ****************************/
+/******************************************************************************/
+
+/**
+ * Information regarding a possible path to reach a single peer
+ */
+struct MeshPeerPath
+{
+
+ /**
+ * Linked list
+ */
+ struct MeshPeerPath *next;
+ struct MeshPeerPath *prev;
+
+ /**
+ * List of all the peers that form the path from origin to target.
+ */
+ GNUNET_PEER_Id *peers;
+
+ /**
+ * Number of peers (hops) in the path
+ */
+ unsigned int length;
+
+};
+
+
+/**
+ * Node of path tree for a tunnel
+ */
+struct MeshTunnelTreeNode
+{
+ /**
+ * Tunnel this node belongs to (and therefore tree)
+ */
+ struct MeshTunnel *t;
+
+ /**
+ * Peer this node describes
+ */
+ GNUNET_PEER_Id peer;
+
+ /**
+ * Parent node in the tree
+ */
+ struct MeshTunnelTreeNode *parent;
+
+ /**
+ * DLL of siblings
+ */
+ struct MeshTunnelTreeNode *next;
+
+ /**
+ * DLL of siblings
+ */
+ struct MeshTunnelTreeNode *prev;
+
+ /**
+ * DLL of children
+ */
+ struct MeshTunnelTreeNode *children_head;
+
+ /**
+ * DLL of children
+ */
+ struct MeshTunnelTreeNode *children_tail;
+
+ /**
+ * Status of the peer in the tunnel
+ */
+ enum MeshPeerState status;
+};
+
+
+/**
+ * Tree to reach all peers in the tunnel
+ */
+struct MeshTunnelTree
+{
+ /**
+ * How often to refresh the path
+ */
+ struct GNUNET_TIME_Relative refresh;
+
+ /**
+ * Tunnel this path belongs to
+ */
+ struct MeshTunnel *t;
+
+ /**
+ * Root node of peer tree
+ */
+ struct MeshTunnelTreeNode *root;
+
+ /**
+ * Node that represents our position in the tree (for non local tunnels)
+ */
+ struct MeshTunnelTreeNode *me;
+
+ /**
+ * DLL of disconneted nodes
+ */
+ struct MeshTunnelTreeNode *disconnected_head;
+
+ /**
+ * DLL of disconneted nodes
+ */
+ struct MeshTunnelTreeNode *disconnected_tail;
+
+ /**
+ * Cache of all peers and the first hop to them.
+ * Indexed by PeerIdentity, contains a pointer to the PeerIdentity
+ * of 1st hop.
+ */
+ struct GNUNET_CONTAINER_MultiHashMap *first_hops;
+
+};
+
+
+/******************************************************************************/
+/************************* FUNCTIONS *****************************/
+/******************************************************************************/
+
+/**
+ * Create a new path
+ *
+ * @param lenght How many hops will the path have.
+ *
+ * @return A newly allocated path with a peer array of the specified length.
+ */
+struct MeshPeerPath *
+path_new (unsigned int length);
+
/**
* Invert the path
* @param p the path to invert
*/
void
-path_invert (struct MeshPeerPath *path);
-
+path_invert (struct MeshPeerPath *p);
/**
- * Destroy the path and free any allocated resources linked to it
+ * Duplicate a path, incrementing short peer's rc.
*
- * @param p the path to destroy
- *
- * @return GNUNET_OK on success
+ * @param p The path to duplicate.
*/
-int
-path_destroy (struct MeshPeerPath *p);
+struct MeshPeerPath *
+path_duplicate (struct MeshPeerPath *path);
/**
* Find the first peer whom to send a packet to go down this path
*
- * @param t The tunnel to use
+ * @param t The tunnel tree to use
* @param peer The peerinfo of the peer we are trying to reach
*
* @return peerinfo of the peer who is the first hop in the tunnel
* NULL on error
*/
struct GNUNET_PeerIdentity *
-path_get_first_hop (struct MeshTunnel *t, struct MeshPeerInfo *peer);
+path_get_first_hop (struct MeshTunnelTree *t,
+ GNUNET_PEER_Id peer);
/**
* Get the length of a path
*
- * @param path The path to measure, with the local peer at any point of it
+ * @param p The path to measure, with the local peer at any point of it
*
* @return Number of hops to reach destination
* UINT_MAX in case the peer is not in the path
*/
unsigned int
-path_get_length (struct MeshPeerPath *path);
+path_get_length (struct MeshPeerPath *p);
/**
* Get the cost of the path relative to the already built tunnel tree
*
- * @param t The tunnel to which compare
+ * @param t The tunnel tree to which compare
* @param path The individual path to reach a peer
*
* @return Number of hops to reach destination, UINT_MAX in case the peer is not
* in the path
*/
unsigned int
-path_get_cost (struct MeshTunnel *t, struct MeshPeerPath *path);
+path_get_cost (struct MeshTunnelTree *t,
+ struct MeshPeerPath *path);
+
/**
- * Add the path to the peer and update the path used to reach it in case this
- * is the shortest.
+ * Destroy the path and free any allocated resources linked to it
+ *
+ * @param p the path to destroy
*
- * @param peer_info Destination peer to add the path to.
- * @param path New path to add. Last peer must be the peer in arg 1.
- * Path will be either used of freed if already known.
+ * @return GNUNET_OK on success
*/
-void
-path_add_to_peer (struct MeshPeerInfo *peer_info, struct MeshPeerPath *path);
+int
+path_destroy (struct MeshPeerPath *p);
+
+/******************************************************************************/
/**
- * Send keepalive packets for a peer
+ * Method called whenever a node has been marked as disconnected.
*
- * @param cls unused
- * @param tc unused
+ * @param node peer identity the tunnel stopped working with
*/
-void
-path_refresh (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+typedef void (*MeshNodeDisconnectCB) (const struct MeshTunnelTreeNode * node);
+
+
+/**
+ * Create a new tunnel tree associated to a tunnel
+ *
+ * @param t Tunnel this tree will represent
+ * @param peer A short peer id of the root of the tree
+ *
+ * @return A newly allocated and initialized tunnel tree
+ */
+struct MeshTunnelTree *
+tree_new (struct MeshTunnel *t, GNUNET_PEER_Id peer);
/**
* Recursively find the given peer in the tree.
*
- * @param t Tunnel where to look for the peer.
- * @param peer Peer to find
+ * @param parent Parent node where to start looking.
+ * @param peer Short ID of peer to find.
*
* @return Pointer to the node of the peer. NULL if not found.
*/
-struct MeshTunnelPathNode *
-tunnel_find_peer (struct MeshTunnelPathNode *root, GNUNET_PEER_Id peer_id);
+struct MeshTunnelTreeNode *
+tree_find_peer (struct MeshTunnelTreeNode *parent,
+ GNUNET_PEER_Id peer);
/**
- * Recusively mark peer and children as disconnected, notify client
+ * Recusively update the info about what is the first hop to reach the node
*
- * @param parent Node to be clean, potentially with children
- * @param nc Notification context to use to alert the client
+ * @param tree Tree this nodes belongs to
+ * @param parent Node to be start updating
+ * @param hop If known, ID of the first hop.
+ * If not known, NULL to find out and pass on children.
*/
void
-tunnel_mark_peers_disconnected (struct MeshTunnelPathNode *parent,
- struct GNUNET_SERVER_NotificationContext *nc);
-
+tree_update_first_hops (struct MeshTunnelTree *tree,
+ struct MeshTunnelTreeNode *parent,
+ struct GNUNET_PeerIdentity *hop);
/**
* Delete the current path to the peer, including all now unused relays.
* The destination peer is NOT destroyed, it is returned in order to either set
* a new path to it or destroy it explicitly, taking care of it's child nodes.
*
- * @param t Tunnel where to delete the path from.
+ * @param t Tunnel tree where to delete the path from.
* @param peer Destination peer whose path we want to remove.
- * @param nc Notification context to alert the client of disconnected peers.
+ * @param cb Callback to use to notify about which peers are going to be
+ * disconnected.
*
- * @return pointer to the pathless node, NULL on error
+ * @return pointer to the pathless node.
+ * NULL when not found
*/
-struct MeshTunnelPathNode *
-tunnel_del_path (struct MeshTunnel *t, GNUNET_PEER_Id peer_id,
- struct GNUNET_SERVER_NotificationContext *nc);
+struct MeshTunnelTreeNode *
+tree_del_path (struct MeshTunnelTree *t,
+ GNUNET_PEER_Id peer,
+ MeshNodeDisconnectCB cb);
/**
* according to the path tree of some tunnel.
*
* @param t Tunnel from which to read the path tree
- * @param peer_info Destination peer to whom we want a path
+ * @param peer Destination peer to whom we want a path
*
* @return A newly allocated individual path to reach the destination peer.
* Path must be destroyed afterwards.
*/
struct MeshPeerPath *
-tunnel_get_path_to_peer(struct MeshTunnel *t, struct MeshPeerInfo *peer_info);
+tree_get_path_to_peer(struct MeshTunnelTree *t,
+ GNUNET_PEER_Id peer);
/**
*
* @param t Tunnel where to add the new path.
* @param p Path to be integrated.
- * @param nc Notification context to alert clients of peers
- * temporarily disconnected
+ * @param cb Callback to use to notify about peers temporarily disconnecting
*
* @return GNUNET_OK in case of success.
* GNUNET_SYSERR in case of error.
*/
int
-tunnel_add_path (struct MeshTunnel *t, const struct MeshPeerPath *p);
+tree_add_path (struct MeshTunnelTree *t,
+ const struct MeshPeerPath *p,
+ MeshNodeDisconnectCB cb);
+
+
+/**
+ * Notifies a tree that a connection it might be using is broken.
+ * Marks all peers down the paths as disconnected and notifies the client.
+ *
+ * @param t Tree to use.
+ * @param p1 Short id of one of the peers (order unimportant)
+ * @param p2 Short id of one of the peers (order unimportant)
+ * @param cb Function to call for every peer that is marked as disconnected.
+ *
+ * @return Short ID of the first disconnected peer in the tree.
+ */
+GNUNET_PEER_Id
+tree_notify_connection_broken (struct MeshTunnelTree *t,
+ GNUNET_PEER_Id p1,
+ GNUNET_PEER_Id p2,
+ MeshNodeDisconnectCB cb);
+
+/**
+ * Deletes a peer from a tunnel, liberating all unused resources on the path to
+ * it. It shouldn't have children, if it has they will be destroyed as well.
+ * If the tree is not local and no longer has any paths, the root node will be
+ * destroyed and marked as NULL.
+ *
+ * @param t Tunnel tree to use.
+ * @param peer Short ID of the peer to remove from the tunnel tree.
+ * @param cb Callback to notify client of disconnected peers.
+ *
+ * @return GNUNET_OK or GNUNET_SYSERR
+ */
+int
+tree_del_peer (struct MeshTunnelTree *t,
+ GNUNET_PEER_Id peer,
+ MeshNodeDisconnectCB cb);
/**
- * Add a peer to a tunnel, accomodating paths accordingly and initializing all
- * needed rescources.
+ * Print the tree on stderr
*
- * @param t Tunnel we want to add a new peer to
- * @param peer PeerInfo of the peer being added
+ * @param t The tree
+ */
+void
+tree_debug(struct MeshTunnelTree *t);
+
+
+/**
+ * Destroy the whole tree and free all used memory and Peer_Ids
*
+ * @param t Tree to be destroyed
*/
void
-tunnel_add_peer (struct MeshTunnel *t, struct MeshPeerInfo *peer);
\ No newline at end of file
+tree_destroy (struct MeshTunnelTree *t);
projects / oweals / gnunet.git / blobdiff