Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
improve the doc of the routing API
[simgrid.git] / src / kernel / routing / AsImpl.cpp
index c6ab319..75d2dc2 100644 (file)
@@ -5,6 +5,7 @@
 
 #include "xbt/log.h"
 
+#include "simgrid/s4u/host.hpp"
 #include "src/kernel/routing/AsImpl.hpp"
 #include "src/surf/network_interface.hpp" // Link FIXME: move to proper header
 
@@ -14,85 +15,133 @@ namespace simgrid {
   namespace kernel {
   namespace routing {
 
-    AsImpl::AsImpl(const char *name) : As(name) { }
-    AsImpl::~AsImpl() = default;
-
-    xbt_dynar_t AsImpl::getOneLinkRoutes() {
-      return nullptr;
+  AsImpl::AsImpl(As* father, const char* name) : As(father, name)
+  {
+    xbt_assert(nullptr == xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL),
+               "Refusing to create a second AS called '%s'.", name);
+
+    netcard_ = new NetCardImpl(name, NetCard::Type::As, static_cast<AsImpl*>(father));
+    xbt_lib_set(as_router_lib, name, ROUTING_ASR_LEVEL, static_cast<void*>(netcard_));
+    XBT_DEBUG("AS '%s' created with the id '%d'", name, netcard_->id());
+  }
+  AsImpl::~AsImpl() = default;
+
+  void AsImpl::attachHost(s4u::Host* host)
+  {
+    if (hierarchy_ == RoutingMode::unset)
+      hierarchy_ = RoutingMode::base;
+
+    host->pimpl_netcard = new NetCardImpl(host->name().c_str(), NetCard::Type::Host, this);
+  }
+
+  xbt_dynar_t AsImpl::getOneLinkRoutes()
+  {
+    return nullptr;
+  }
+
+  /** @brief Get the common ancestor and its first children in each line leading to src and dst
+   *
+   * After this call, common_ancestor, src_ancestor and dst_ancestor are set as follows.
+   * @verbatim
+   *         platform root
+   *               |
+   *              ...
+   *               |
+   *         common_ancestor
+   *          /           \
+   *         /             \
+   *        /               \
+   *       /                 \
+   *  src_ancestor     dst_ancestor
+   *      |                   |
+   *     ...                 ...  <-- possibly long pathes
+   *      |                   |
+   *     src                 dst
+   *  @endverbatim
+   */
+  static void find_common_ancestors(NetCard* src, NetCard* dst,
+                                    /* OUT */ AsImpl** common_ancestor, AsImpl** src_ancestor, AsImpl** dst_ancestor)
+  {
+#define ROUTING_HIERARCHY_MAXDEPTH 32 /* increase if it is not enough */
+    AsImpl* path_src[ROUTING_HIERARCHY_MAXDEPTH];
+    AsImpl* path_dst[ROUTING_HIERARCHY_MAXDEPTH];
+    int index_src = 0;
+    int index_dst = 0;
+    AsImpl* current_src;
+    AsImpl* current_dst;
+    AsImpl* father;
+
+    /* (1) find the path to root of src and dst*/
+    AsImpl* src_as = src->containingAS();
+    AsImpl* 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 (AsImpl* current = src_as; current != nullptr; current = static_cast<AsImpl*>(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;
     }
-
-    /** @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 */ AsImpl **common_ancestor, AsImpl **src_ancestor, AsImpl **dst_ancestor)
-    {
-    #define ROUTING_HIERARCHY_MAXDEPTH 32     /* increase if it is not enough */
-      AsImpl *path_src[ROUTING_HIERARCHY_MAXDEPTH];
-      AsImpl *path_dst[ROUTING_HIERARCHY_MAXDEPTH];
-      int index_src = 0;
-      int index_dst = 0;
-      AsImpl *current_src;
-      AsImpl *current_dst;
-      AsImpl *father;
-
-      /* (1) find the path to root of src and dst*/
-      AsImpl *src_as = src->containingAS();
-      AsImpl *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 (AsImpl *current = src_as; current != nullptr; current = static_cast<AsImpl*>(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 (AsImpl *current = dst_as; current != nullptr; current = static_cast<AsImpl*>(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 nullptr 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
+    for (AsImpl* current = dst_as; current != nullptr; current = static_cast<AsImpl*>(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 nullptr in path_src/path_dst
+     * So we move them down simultaneously as long as they point to the same content.
+     *
+     * This works because all SimGrid platform have a unique root element (that is the last element of both paths).
+     */
+    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
+    }
 
     /* PRECONDITION: this is the common ancestor of src and dst */
-    std::vector<surf::Link*> *AsImpl::getBypassRoute(routing::NetCard *src, routing::NetCard *dst)
+    bool AsImpl::getBypassRoute(routing::NetCard* src, routing::NetCard* dst,
+                                /* OUT */ std::vector<surf::Link*>* links, double* latency)
     {
       // If never set a bypass route return nullptr without any further computations
       XBT_DEBUG("generic_get_bypassroute from %s to %s", src->name(), dst->name());
       if (bypassRoutes_.empty())
-        return nullptr;
-
-      std::vector<surf::Link*> *bypassedRoute = nullptr;
+        return false;
 
+      /* Base case, no recursion is needed */
       if(dst->containingAS() == this && src->containingAS() == this ){
         if (bypassRoutes_.find({src->name(),dst->name()}) != bypassRoutes_.end()) {
-          bypassedRoute = bypassRoutes_.at({src->name(),dst->name()});
+          std::vector<surf::Link*>* bypassedRoute = bypassRoutes_.at({src->name(), dst->name()});
+          for (surf::Link* link : *bypassedRoute) {
+            links->push_back(link);
+            if (latency)
+              *latency += link->latency();
+          }
           XBT_DEBUG("Found a bypass route with %zu links",bypassedRoute->size());
+          return true;
         }
-        return bypassedRoute;
+        return false;
       }
 
-      /* (2) find the path to the root routing component */
+      /* Engage recursive search */
+
+      std::vector<surf::Link*>* bypassedRoute = nullptr;
+
+      /* (1) find the path to the root routing component */
       std::vector<As*> path_src;
       As *current = src->containingAS();
       while (current != nullptr) {
@@ -107,7 +156,7 @@ namespace simgrid {
         current = current->father_;
       }
 
-      /* (3) find the common father */
+      /* (2) find the common father */
       while (path_src.size() > 1 && path_dst.size() >1
           && path_src.at(path_src.size() -1) == path_dst.at(path_dst.size() -1)) {
         path_src.pop_back();
@@ -123,18 +172,18 @@ namespace simgrid {
         for (int i = 0; i < max; i++) {
           if (i <= max_index_src && max <= max_index_dst) {
             const std::pair<std::string, std::string> key = {path_src.at(i)->name(), path_dst.at(max)->name()};
-            if (bypassRoutes_.find(key) != bypassRoutes_.end())
+            if (bypassRoutes_.find(key) != bypassRoutes_.end()) {
               bypassedRoute = bypassRoutes_.at(key);
+              break;
+            }
           }
-          if (bypassedRoute)
-            break;
           if (max <= max_index_src && i <= max_index_dst) {
             const std::pair<std::string, std::string> key = {path_src.at(max)->name(), path_dst.at(i)->name()};
-            if (bypassRoutes_.find(key) != bypassRoutes_.end())
+            if (bypassRoutes_.find(key) != bypassRoutes_.end()) {
               bypassedRoute = bypassRoutes_.at(key);
+              break;
+            }
           }
-          if (bypassedRoute)
-            break;
         }
 
         if (bypassedRoute)
@@ -142,14 +191,22 @@ namespace simgrid {
 
         if (max <= max_index_src && max <= max_index_dst) {
           const std::pair<std::string, std::string> key = {path_src.at(max)->name(), path_dst.at(max)->name()};
-          if (bypassRoutes_.find(key) != bypassRoutes_.end())
+          if (bypassRoutes_.find(key) != bypassRoutes_.end()) {
             bypassedRoute = bypassRoutes_.at(key);
+            break;
+          }
         }
-        if (bypassedRoute)
-          break;
       }
 
-      return bypassedRoute;
+      if (bypassedRoute) {
+        for (surf::Link* link : *bypassedRoute) {
+          links->push_back(link);
+          if (latency)
+            *latency += link->latency();
+        }
+        return true;
+      }
+      return false;
     }
 
     /**
@@ -175,15 +232,8 @@ namespace simgrid {
           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<surf::Link*> *bypassed_route = common_ancestor->getBypassRoute(src, dst);
-      if (nullptr != bypassed_route) {
-        for (surf::Link *link : *bypassed_route) {
-          links->push_back(link);
-          if (latency)
-            *latency += link->getLatency();
-        }
+      if (common_ancestor->getBypassRoute(src, dst, links, latency))
         return;
-      }
 
       /* If src and dst are in the same AS, life is good */
       if (src_ancestor == dst_ancestor) {       /* SURF_ROUTING_BASE */