From: Martin Quinson Date: Wed, 16 Nov 2016 07:46:51 +0000 (+0100) Subject: rename AsImpl::getRouteRecursive to AsImpl::getGlobalRoute (+doc improvment) X-Git-Tag: v3_14~191 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/19df82877ce519ee7ce4b9daee206ad6939f4710 rename AsImpl::getRouteRecursive to AsImpl::getGlobalRoute (+doc improvment) --- diff --git a/src/kernel/routing/AsImpl.cpp b/src/kernel/routing/AsImpl.cpp index 8025f70b89..7eb664b936 100644 --- a/src/kernel/routing/AsImpl.cpp +++ b/src/kernel/routing/AsImpl.cpp @@ -249,29 +249,21 @@ namespace simgrid { /* (4) If we have the bypass, use it. If not, caller will do the Right Thing. */ if (bypassedRoute) { if (src != key.first) - getRouteRecursive(src, const_cast(bypassedRoute->gw_src), links, latency); + getGlobalRoute(src, const_cast(bypassedRoute->gw_src), links, latency); for (surf::Link* link : bypassedRoute->links) { links->push_back(link); if (latency) *latency += link->latency(); } if (dst != key.second) - getRouteRecursive(const_cast(bypassedRoute->gw_dst), dst, links, latency); + getGlobalRoute(const_cast(bypassedRoute->gw_dst), dst, links, latency); return true; } return false; } - /** - * \brief Recursive function for getRouteAndLatency - * - * \param src the source host - * \param dst the destination host - * \param links Where to store the links and the gw information - * \param latency If not nullptr, the latency of all links will be added in it - */ - void AsImpl::getRouteRecursive(routing::NetCard *src, routing::NetCard *dst, - /* OUT */ std::vector * links, double *latency) + void AsImpl::getGlobalRoute(routing::NetCard* src, routing::NetCard* dst, + /* OUT */ std::vector* links, double* latency) { s_sg_platf_route_cbarg_t route; memset(&route,0,sizeof(route)); @@ -305,15 +297,14 @@ namespace simgrid { /* If source gateway is not our source, we have to recursively find our way up to this point */ if (src != route.gw_src) - getRouteRecursive(src, route.gw_src, links, latency); + getGlobalRoute(src, route.gw_src, links, latency); for (auto link: *route.link_list) links->push_back(link); delete route.link_list; /* If dest gateway is not our destination, we have to recursively find our way from this point */ if (route.gw_dst != dst) - getRouteRecursive(route.gw_dst, dst, links, latency); - + getGlobalRoute(route.gw_dst, dst, links, latency); } }}} // namespace diff --git a/src/kernel/routing/AsImpl.hpp b/src/kernel/routing/AsImpl.hpp index ce34fdf50f..ce762368d4 100644 --- a/src/kernel/routing/AsImpl.hpp +++ b/src/kernel/routing/AsImpl.hpp @@ -22,8 +22,29 @@ namespace routing { /** @brief Autonomous Systems * * An AS is a network container, in charge of routing information between elements (hosts) and to the nearby ASes. - * In SimGrid, there is a hierarchy (a tree) of ASes, with a unique root AS (that you can retrieve from the - * s4u::Engine). + * In SimGrid, there is a hierarchy of ASes, ie a tree with a unique root AS, that you can retrieve from the + * s4u::Engine. + * + * The purpose of the kernel::routing module is to retrieve the routing path between two points in a time- and + * space-efficient manner. This is done by AsImpl::getGlobalRoute(), called when creating a communication to + * retrieve both the list of links that the create communication will use, and the summed latency that these + * links represent. + * + * The network could recompute the latency by itself from the list, but it would require an additional link + * set traversal. This operation being on the critical path of SimGrid, the routing computes the latency on the + * behalf of the network. + * + * Finding the path between two nodes is rather complex because we navigate a hierarchy of ASes, each of them + * being a full network. In addition, the routing can declare shortcuts (called bypasses), either within an AS + * at the route level or directly between ASes. Also, each AS can use a differing routing algorithm, depending + * on its class. @ref{AsFull} have a full matrix giving explicitly the path between any pair of their + * contained nodes, while @ref{AsDijkstra} or @ref{AsFloyd} rely on a shortest path algorithm. @ref{AsVivaldi} + * does not even have any link but only use only coordinate information to compute the latency. + * + * So AsImpl::getGlobalRoute builds the path recursively asking its specific information to each traversed AS with + * AsImpl::getLocalRoute, that is redefined in each sub-class. + * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/ + * */ XBT_PUBLIC_CLASS AsImpl : public s4u::As { @@ -36,32 +57,15 @@ namespace routing { /** @brief Make an host within that AS */ simgrid::s4u::Host* createHost(const char* name, std::vector* speedPerPstate, int coreAmount); + protected: /** - * @brief Probe the routing path between two points - * - * The networking model uses this function when creating a communication - * to retrieve both the list of links that the create communication will use, - * and the summed latency that these links represent. - * - * The network could recompute the latency by itself from the list, but it would - * require an additional link set traversal. This operation being on the critical - * path of SimGrid, the routing computes the latency in behalf of the network. + * @brief Probe the routing path between two points that are local to the called AS. * - * Things are rather complex here because we have to find the path from ASes to ASes, and within each. - * In addition, the different ASes may use differing routing models. - * Some ASes may be routed in full, others may have only some connection information and use a shortest path on top - * of that, and so on. - * Some ASes may even not have any predefined links and use only coordinate information to compute the latency. - * - * So, the path is constructed recursively, with each traversed AS adding its information to the set. - * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/ - * - * @param src Initial point of the routing path - * @param dst Final point of the routing path - * @param into Container into which the traversed links should be pushed + * @param src where from + * @param dst where to + * @param into Container into which the traversed links and gateway informations should be pushed * @param latency Accumulator in which the latencies should be added (caller must set it to 0) */ - protected: virtual void getLocalRoute(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t into, double* latency) = 0; /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */ /* returns whether we found a bypass path */ @@ -69,10 +73,18 @@ namespace routing { /* OUT */ std::vector * links, double* latency); public: + /* @brief get the route between two nodes in the full platform + * + * @param src where from + * @param dst where to + * @param links Accumulator in which all traversed links should be pushed (caller must empty it) + * @param latency Accumulator in which the latencies should be added (caller must set it to 0) + */ + static void getGlobalRoute(routing::NetCard * src, routing::NetCard * dst, + /* OUT */ std::vector * links, double* latency); + virtual void getOneLinkRoutes(std::vector * accumulator); virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) = 0; - static void getRouteRecursive(routing::NetCard * src, routing::NetCard * dst, - /* OUT */ std::vector * links, double* latency); enum class RoutingMode { unset = 0, /**< Undefined type */ base, /**< Base case: use simple link lists for routing */ diff --git a/src/surf/surf_routing.cpp b/src/surf/surf_routing.cpp index e23d601e6a..19b30f045c 100644 --- a/src/surf/surf_routing.cpp +++ b/src/surf/surf_routing.cpp @@ -97,7 +97,7 @@ void RoutingPlatf::getRouteAndLatency(NetCard *src, NetCard *dst, std::vector
  • name().c_str(), dst->name().c_str()); - AsImpl::getRouteRecursive(src, dst, route, latency); + AsImpl::getGlobalRoute(src, dst, route, latency); } }}}