Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cleanups in the routing code
authorMartin Quinson <martin.quinson@loria.fr>
Mon, 29 Feb 2016 21:47:09 +0000 (22:47 +0100)
committerMartin Quinson <martin.quinson@loria.fr>
Tue, 1 Mar 2016 08:38:34 +0000 (09:38 +0100)
src/surf/surf_routing.cpp
src/surf/surf_routing.hpp

index 9b64a4e..6897fda 100644 (file)
@@ -55,12 +55,64 @@ namespace surf {
     sealed_ = true;
   }
 
+  /** @brief Get the common ancestor and its first childs in each line leading to src and dst */
+  static void find_common_ancestors(NetCard *src, NetCard *dst,
+      /* OUT */ As **common_ancestor, As **src_ancestor, As **dst_ancestor)
+  {
+  #define ROUTING_HIERARCHY_MAXDEPTH 32     /* increase if it is not enough */
+    simgrid::surf::As *path_src[ROUTING_HIERARCHY_MAXDEPTH];
+    simgrid::surf::As *path_dst[ROUTING_HIERARCHY_MAXDEPTH];
+    int index_src = 0;
+    int index_dst = 0;
+    simgrid::surf::As *current_src;
+    simgrid::surf::As *current_dst;
+    simgrid::surf::As *father;
+
+    /* (1) find the path to root of src and dst*/
+    simgrid::surf::As *src_as = src->containingAS();
+    simgrid::surf::As *dst_as = dst->containingAS();
+
+    xbt_assert(src_as, "Host %s must be in an AS", src->name());
+    xbt_assert(dst_as, "Host %s must be in an AS", dst->name());
+
+    /* (2) find the path to the root routing component */
+    for (simgrid::surf::As *current = src_as; current != NULL; current = current->father_) {
+      xbt_assert(index_src < ROUTING_HIERARCHY_MAXDEPTH, "ROUTING_HIERARCHY_MAXDEPTH should be increased for element %s", src->name());
+      path_src[index_src++] = current;
+    }
+    for (simgrid::surf::As *current = dst_as; current != NULL; current = current->father_) {
+      xbt_assert(index_dst < ROUTING_HIERARCHY_MAXDEPTH,"ROUTING_HIERARCHY_MAXDEPTH should be increased for path_dst");
+      path_dst[index_dst++] = current;
+    }
+
+    /* (3) find the common father.
+     * Before that, index_src and index_dst may be different, they both point to NULL in path_src/path_dst
+     * So we move them down simultaneously as long as they point to the same content.
+     */
+    do {
+      current_src = path_src[--index_src];
+      current_dst = path_dst[--index_dst];
+    } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
+
+    /* (4) if we did not find a difference (index_src or index_dst went to 0), both elements are in the same AS */
+    if (current_src == current_dst)
+      father = current_src;
+    else // we found a difference
+      father = path_src[index_src + 1];
+
+    /* (5) result generation */
+    *common_ancestor = father;    /* the common father of src and dst */
+    *src_ancestor = current_src;  /* the first different father of src */
+    *dst_ancestor = current_dst;  /* the first different father of dst */
+  #undef ROUTING_HIERARCHY_MAXDEPTH
+  }
+
+
   xbt_dynar_t As::getOneLinkRoutes() {
     return NULL;
   }
 
   int As::addComponent(NetCard *elm) {
-    XBT_DEBUG("Load component \"%s\"", elm->name());
     xbt_dynar_push_as(vertices_, NetCard*, elm);
     return xbt_dynar_length(vertices_)-1;
   }
@@ -69,6 +121,7 @@ namespace surf {
     xbt_die("AS %s does not accept new routes (wrong class).",name_);
   }
 
+  /* PRECONDITION: this is the common ancestor of src and dst */
   std::vector<Link*> *As::getBypassRoute(NetCard *src, NetCard *dst)
   {
     // If never set a bypass route return NULL without any further computations
@@ -375,92 +428,33 @@ void routing_AS_end()
   current_routing = current_routing->father_;
 }
 
-/**
- * \brief Get the AS father and the first elements of the chain
- *
- * \param src the source host name
- * \param dst the destination host name
- *
- * Get the common father of the to processing units, and the first different
- * father in the chain
- */
-static void elements_father(sg_netcard_t src, sg_netcard_t dst,
-    AS_t * res_father, AS_t * res_src, AS_t * res_dst)
-{
-  xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
-#define ROUTING_HIERARCHY_MAXDEPTH 16     /* increase if it is not enough */
-  simgrid::surf::As *path_src[ROUTING_HIERARCHY_MAXDEPTH];
-  simgrid::surf::As *path_dst[ROUTING_HIERARCHY_MAXDEPTH];
-  int index_src = 0;
-  int index_dst = 0;
-  simgrid::surf::As *current_src;
-  simgrid::surf::As *current_dst;
-  simgrid::surf::As *father;
-
-  /* (1) find the path to root of src and dst*/
-  simgrid::surf::As *src_as = src->containingAS();
-  simgrid::surf::As *dst_as = dst->containingAS();
-
-  xbt_assert(src_as, "Host %s must be in an AS", src->name());
-  xbt_assert(dst_as, "Host %s must be in an AS", dst->name());
-
-  /* (2) find the path to the root routing component */
-  for (simgrid::surf::As *current = src_as; current != NULL; current = current->father_) {
-    if (index_src >= ROUTING_HIERARCHY_MAXDEPTH)
-      xbt_die("ROUTING_HIERARCHY_MAXDEPTH should be increased for element %s", src->name());
-    path_src[index_src++] = current;
-  }
-  for (simgrid::surf::As *current = dst_as; current != NULL; current = current->father_) {
-    if (index_dst >= ROUTING_HIERARCHY_MAXDEPTH)
-      xbt_die("ROUTING_HIERARCHY_MAXDEPTH should be increased for path_dst");
-    path_dst[index_dst++] = current;
-  }
-
-  /* (3) find the common father */
-  do {
-    current_src = path_src[--index_src];
-    current_dst = path_dst[--index_dst];
-  } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
-
-  /* (4) they are not in the same routing component, make the path */
-  if (current_src == current_dst)
-    father = current_src;
-  else
-    father = path_src[index_src + 1];
-
-  /* (5) result generation */
-  *res_father = father;         /* first the common father of src and dst */
-  *res_src = current_src;       /* second the first different father of src */
-  *res_dst = current_dst;       /* three  the first different father of dst */
-
-#undef ROUTING_HIERARCHY_MAXDEPTH
-}
+namespace simgrid {
+namespace surf {
 
 /**
- * \brief Recursive function for get_route_and_latency
+ * \brief Recursive function for getRouteAndLatency
  *
- * \param src the source host name
- * \param dst the destination host name
- * \param *route the route where the links are stored. It is either NULL or a ready to use dynar
- * \param *latency the latency, if needed
+ * \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 NULL, the latency of all links will be added in it
  */
-static void _get_route_and_latency(simgrid::surf::NetCard *src, simgrid::surf::NetCard *dst,
-    std::vector<Link*> * links, double *latency)
+void As::getRouteRecursive(NetCard *src, NetCard *dst,
+    /* OUT */ std::vector<Link*> * links, double *latency)
 {
-  s_sg_platf_route_cbarg_t route = SG_PLATF_ROUTE_INITIALIZER;
+  s_sg_platf_route_cbarg_t route;
   memset(&route,0,sizeof(route));
 
-  xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
-  XBT_DEBUG("Solve route/latency  \"%s\" to \"%s\"", src->name(), dst->name());
+  XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name(), dst->name());
 
   /* Find how src and dst are interconnected */
-  simgrid::surf::As *common_father, *src_father, *dst_father;
-  elements_father(src, dst, &common_father, &src_father, &dst_father);
-  XBT_DEBUG("elements_father: common father '%s' src_father '%s' dst_father '%s'",
-      common_father->name_, src_father->name_, dst_father->name_);
+  simgrid::surf::As *common_ancestor, *src_ancestor, *dst_ancestor;
+  find_common_ancestors(src, dst, &common_ancestor, &src_ancestor, &dst_ancestor);
+  XBT_DEBUG("elements_father: common ancestor '%s' src ancestor '%s' dst ancestor '%s'",
+      common_ancestor->name_, src_ancestor->name_, dst_ancestor->name_);
 
   /* Check whether a direct bypass is defined. If so, use it and bail out */
-  std::vector<Link*> *bypassed_route = common_father->getBypassRoute(src, dst);
+  std::vector<Link*> *bypassed_route = common_ancestor->getBypassRoute(src, dst);
   if (nullptr != bypassed_route) {
     for (Link *link : *bypassed_route) {
       links->push_back(link);
@@ -471,9 +465,9 @@ static void _get_route_and_latency(simgrid::surf::NetCard *src, simgrid::surf::N
   }
 
   /* If src and dst are in the same AS, life is good */
-  if (src_father == dst_father) {       /* SURF_ROUTING_BASE */
+  if (src_ancestor == dst_ancestor) {       /* SURF_ROUTING_BASE */
     route.link_list = links;
-    common_father->getRouteAndLatency(src, dst, &route, latency);
+    common_ancestor->getRouteAndLatency(src, dst, &route, latency);
     return;
   }
 
@@ -481,25 +475,22 @@ static void _get_route_and_latency(simgrid::surf::NetCard *src, simgrid::surf::N
 
   route.link_list = new std::vector<Link*>();
 
-  common_father->getRouteAndLatency(src_father->netcard_, dst_father->netcard_, &route, latency);
+  common_ancestor->getRouteAndLatency(src_ancestor->netcard_, dst_ancestor->netcard_, &route, latency);
   xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
       "bad gateways for route from \"%s\" to \"%s\"", src->name(), dst->name());
 
   /* If source gateway is not our source, we have to recursively find our way up to this point */
   if (src != route.gw_src)
-    _get_route_and_latency(src, route.gw_src, links, latency);
+    getRouteRecursive(src, route.gw_src, links, latency);
   for (auto link: *route.link_list)
     links->push_back(link);
 
   /* If dest gateway is not our destination, we have to recursively find our way from this point */
   if (route.gw_dst != dst)
-    _get_route_and_latency(route.gw_dst, dst, links, latency);
+    getRouteRecursive(route.gw_dst, dst, links, latency);
 
 }
 
-namespace simgrid {
-namespace surf {
-
 /**
  * \brief Find a route between hosts
  *
@@ -518,7 +509,7 @@ void RoutingPlatf::getRouteAndLatency(NetCard *src, NetCard *dst, std::vector<Li
 {
   XBT_DEBUG("getRouteAndLatency from %s to %s", src->name(), dst->name());
 
-  _get_route_and_latency(src, dst, route, latency);
+  As::getRouteRecursive(src, dst, route, latency);
 }
 
 static xbt_dynar_t _recursiveGetOneLinkRoutes(As *rc)
index bd09517..8d091fe 100644 (file)
@@ -73,7 +73,11 @@ public:
 
 private:
   bool sealed_ = false; // We cannot add more content when sealed
+
+  friend RoutingPlatf;
   std::map<std::string, std::vector<Link*>*> bypassRoutes_;
+  static void getRouteRecursive(NetCard *src, NetCard *dst, /* OUT */ std::vector<Link*> * links, double *latency);
+  std::vector<Link*> *getBypassRoute(NetCard *src, NetCard *dst);
 
 public:
   /**
@@ -106,12 +110,11 @@ public:
 
   virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
 
-  std::vector<Link*> *getBypassRoute(NetCard *src, NetCard *dst);
-
   /* Add content to the AS, at parsing time. It should be sealed afterward. */
   virtual int addComponent(NetCard *elm); /* A host, a router or an AS, whatever */
   virtual void addRoute(sg_platf_route_cbarg_t route);
   void addBypassRoute(sg_platf_route_cbarg_t e_route);
+
 };
 
 struct XBT_PRIVATE NetCardImpl : public NetCard {