struct MeshTunnelTreeNode *parent;
/**
- * Array of children
+ * DLL of siblings
*/
- struct MeshTunnelTreeNode *children;
+ struct MeshTunnelTreeNode *next;
/**
- * Number of children
+ * DLL of siblings
*/
- unsigned int nchildren;
+ struct MeshTunnelTreeNode *prev;
+
+ /**
+ * DLL of children
+ */
+ struct MeshTunnelTreeNode *children_head;
+
+ /**
+ * DLL of children
+ */
+ struct MeshTunnelTreeNode *children_tail;
/**
* Status of the peer in the tunnel
*/
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
/************************* FUNCTIONS *****************************/
/******************************************************************************/
-
/**
- * Method called whenever a node has been marked as disconnected.
+ * Create a new path
*
- * @param node peer identity the tunnel stopped working with
+ * @param lenght How many hops will the path have.
+ *
+ * @return A newly allocated path with a peer array of the specified length.
*/
-typedef void (*MeshNodeDisconnectCB) (const struct MeshTunnelTreeNode * node);
+struct MeshPeerPath *
+path_new (unsigned int length);
/**
* @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 MeshTunnelTree *t, GNUNET_PEER_Id 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);
/**
* in the path
*/
unsigned int
-path_get_cost (struct MeshTunnelTree *t, struct MeshPeerPath *path);
+path_get_cost (struct MeshTunnelTree *t,
+ struct MeshPeerPath *path);
+
+
+/**
+ * Destroy the path and free any allocated resources linked to it
+ *
+ * @param p the path to destroy
+ *
+ * @return GNUNET_OK on success
+ */
+int
+path_destroy (struct MeshPeerPath *p);
+
+
+/******************************************************************************/
+
+/**
+ * Method called whenever a node has been marked as disconnected.
+ *
+ * @param node peer identity the tunnel stopped working with
+ */
+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 MeshTunnelTreeNode *
-tree_find_peer (struct MeshTunnelTreeNode *root, GNUNET_PEER_Id peer_id);
+tree_find_peer (struct MeshTunnelTreeNode *parent,
+ GNUNET_PEER_Id peer);
+
+/**
+ * Recusively update the info about what is the first hop to reach the node
+ *
+ * @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
+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 cb Callback to use to notify about 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 MeshTunnelTreeNode *
-tree_del_path (struct MeshTunnelTree *t, GNUNET_PEER_Id peer_id,
- MeshNodeDisconnectCB cb);
+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 *
-tree_get_path_to_peer(struct MeshTunnelTree *t, GNUNET_PEER_Id peer);
+tree_get_path_to_peer(struct MeshTunnelTree *t,
+ GNUNET_PEER_Id peer);
/**
* GNUNET_SYSERR in case of error.
*/
int
-tree_add_path (struct MeshTunnelTree *t, const struct MeshPeerPath *p,
- MeshNodeDisconnectCB cb);
+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);
/**
- * Destroy the node and all children
- *
- * @param n Parent node to be destroyed
+ * 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);
+
+/**
+ * Print the tree on stderr
+ *
+ * @param t The tree
*/
void
-tree_node_destroy (struct MeshTunnelTreeNode *n);
+tree_debug(struct MeshTunnelTree *t);
/**
* Destroy the whole tree and free all used memory and Peer_Ids
- *
+ *
* @param t Tree to be destroyed
*/
void
-tree_destroy (struct MeshTunnelTree *t);
\ No newline at end of file
+tree_destroy (struct MeshTunnelTree *t);
projects / oweals / gnunet.git / blobdiff