Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
give a network_model to each NetZone (unused for now)
[simgrid.git] / src / kernel / routing / NetZoneImpl.cpp
index 4a2dd54..bdc9a7e 100644 (file)
@@ -1,16 +1,16 @@
-/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "src/kernel/routing/NetZoneImpl.hpp"
+#include "simgrid/kernel/routing/NetZoneImpl.hpp"
+#include "simgrid/kernel/routing/NetPoint.hpp"
 #include "simgrid/s4u/Engine.hpp"
 #include "simgrid/s4u/Host.hpp"
-#include "src/kernel/routing/NetPoint.hpp"
 #include "src/surf/cpu_interface.hpp"
 #include "src/surf/network_interface.hpp"
-
-#include "xbt/log.h"
+#include "src/surf/xml/platf_private.hpp"
+#include "surf/surf.hpp"
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_route);
 
@@ -23,27 +23,77 @@ public:
   explicit BypassRoute(NetPoint* gwSrc, NetPoint* gwDst) : gw_src(gwSrc), gw_dst(gwDst) {}
   NetPoint* gw_src;
   NetPoint* gw_dst;
-  std::vector<surf::LinkImpl*> links;
+  std::vector<resource::LinkImpl*> links;
 };
 
-NetZoneImpl::NetZoneImpl(NetZone* father, const char* name) : NetZone(father, name)
+NetZoneImpl::NetZoneImpl(NetZoneImpl* father, std::string name, resource::NetworkModel* network_model)
+    : network_model_(network_model), piface_(this), father_(father), name_(name)
 {
-  xbt_assert(nullptr == simgrid::s4u::Engine::instance()->netpointByNameOrNull(name),
-             "Refusing to create a second NetZone called '%s'.", name);
+  xbt_assert(nullptr == simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(name.c_str()),
+             "Refusing to create a second NetZone called '%s'.", name.c_str());
 
-  netpoint_ = new NetPoint(name, NetPoint::Type::NetZone, static_cast<NetZoneImpl*>(father));
-  XBT_DEBUG("NetZone '%s' created with the id '%d'", name, netpoint_->id());
+  netpoint_ = new NetPoint(name, NetPoint::Type::NetZone, father);
+  XBT_DEBUG("NetZone '%s' created with the id '%u'", name.c_str(), netpoint_->id());
 }
+
 NetZoneImpl::~NetZoneImpl()
 {
-  for (auto& kv : bypassRoutes_)
+  for (auto const& nz : children_)
+    delete nz;
+
+  for (auto const& kv : bypass_routes_)
     delete kv.second;
 
-  simgrid::s4u::Engine::instance()->netpointUnregister(netpoint_);
+  simgrid::s4u::Engine::get_instance()->netpoint_unregister(netpoint_);
+}
+const char* NetZoneImpl::get_cname() const
+{
+  return name_.c_str();
+}
+NetZoneImpl* NetZoneImpl::get_father()
+{
+  return father_;
+}
+void NetZoneImpl::seal()
+{
+  sealed_ = true;
+}
+/** @brief Returns the list of direct children (no grand-children)
+ *
+ * This returns the internal data, no copy. Don't mess with it.
+ */
+std::vector<NetZoneImpl*>* NetZoneImpl::get_children()
+{
+  return &children_;
+}
+/** @brief Returns the list of the hosts found in this NetZone (not recursively)
+ *
+ * Only the hosts that are directly contained in this NetZone are retrieved,
+ * not the ones contained in sub-netzones.
+ */
+std::vector<s4u::Host*> NetZoneImpl::get_all_hosts()
+{
+  std::vector<s4u::Host*> res;
+  for (auto const& card : get_vertices()) {
+    s4u::Host* host = simgrid::s4u::Host::by_name_or_null(card->get_name());
+    if (host != nullptr)
+      res.push_back(host);
+  }
+  return res;
+}
+int NetZoneImpl::get_host_count()
+{
+  int count = 0;
+  for (auto const& card : get_vertices()) {
+    s4u::Host* host = simgrid::s4u::Host::by_name_or_null(card->get_name());
+    if (host != nullptr)
+      count++;
+  }
+  return count;
 }
 
-simgrid::s4u::Host* NetZoneImpl::createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
-                                            std::unordered_map<std::string, std::string>* props)
+simgrid::s4u::Host* NetZoneImpl::create_host(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
+                                             std::map<std::string, std::string>* props)
 {
   simgrid::s4u::Host* res = new simgrid::s4u::Host(name);
 
@@ -52,43 +102,56 @@ simgrid::s4u::Host* NetZoneImpl::createHost(const char* name, std::vector<double
 
   res->pimpl_netpoint = new NetPoint(name, NetPoint::Type::Host, this);
 
-  surf_cpu_model_pm->createCpu(res, speedPerPstate, coreAmount);
+  surf_cpu_model_pm->create_cpu(res, speedPerPstate, coreAmount);
 
   if (props != nullptr)
-    for (auto kv : *props)
-      res->setProperty(kv.first.c_str(), kv.second.c_str());
+    for (auto const& kv : *props)
+      res->set_property(kv.first, kv.second);
 
-  simgrid::s4u::Host::onCreation(*res);
+  simgrid::s4u::Host::on_creation(*res); // notify the signal
 
   return res;
 }
 
-void NetZoneImpl::addBypassRoute(sg_platf_route_cbarg_t e_route)
+int NetZoneImpl::add_component(kernel::routing::NetPoint* elm)
+{
+  vertices_.push_back(elm);
+  return vertices_.size() - 1; // The rank of the newly created object
+}
+void NetZoneImpl::add_route(kernel::routing::NetPoint* /*src*/, kernel::routing::NetPoint* /*dst*/,
+                            kernel::routing::NetPoint* /*gw_src*/, kernel::routing::NetPoint* /*gw_dst*/,
+                            std::vector<kernel::resource::LinkImpl*>& /*link_list*/, bool /*symmetrical*/)
+{
+  xbt_die("NetZone '%s' does not accept new routes (wrong class).", name_.c_str());
+}
+
+void NetZoneImpl::add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
+                                   std::vector<resource::LinkImpl*>& link_list, bool symmetrical)
 {
   /* Argument validity checks */
-  if (e_route->gw_dst) {
-    XBT_DEBUG("Load bypassNetzoneRoute from %s@%s to %s@%s", e_route->src->cname(), e_route->gw_src->cname(),
-              e_route->dst->cname(), e_route->gw_dst->cname());
-    xbt_assert(!e_route->link_list->empty(), "Bypass route between %s@%s and %s@%s cannot be empty.",
-               e_route->src->cname(), e_route->gw_src->cname(), e_route->dst->cname(), e_route->gw_dst->cname());
-    xbt_assert(bypassRoutes_.find({e_route->src, e_route->dst}) == bypassRoutes_.end(),
-               "The bypass route between %s@%s and %s@%s already exists.", e_route->src->cname(),
-               e_route->gw_src->cname(), e_route->dst->cname(), e_route->gw_dst->cname());
+  if (gw_dst) {
+    XBT_DEBUG("Load bypassNetzoneRoute from %s@%s to %s@%s", src->get_cname(), gw_src->get_cname(), dst->get_cname(),
+              gw_dst->get_cname());
+    xbt_assert(not link_list.empty(), "Bypass route between %s@%s and %s@%s cannot be empty.", src->get_cname(),
+               gw_src->get_cname(), dst->get_cname(), gw_dst->get_cname());
+    xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
+               "The bypass route between %s@%s and %s@%s already exists.", src->get_cname(), gw_src->get_cname(),
+               dst->get_cname(), gw_dst->get_cname());
   } else {
-    XBT_DEBUG("Load bypassRoute from %s to %s", e_route->src->cname(), e_route->dst->cname());
-    xbt_assert(!e_route->link_list->empty(), "Bypass route between %s and %s cannot be empty.", e_route->src->cname(),
-               e_route->dst->cname());
-    xbt_assert(bypassRoutes_.find({e_route->src, e_route->dst}) == bypassRoutes_.end(),
-               "The bypass route between %s and %s already exists.", e_route->src->cname(), e_route->dst->cname());
+    XBT_DEBUG("Load bypassRoute from %s to %s", src->get_cname(), dst->get_cname());
+    xbt_assert(not link_list.empty(), "Bypass route between %s and %s cannot be empty.", src->get_cname(),
+               dst->get_cname());
+    xbt_assert(bypass_routes_.find({src, dst}) == bypass_routes_.end(),
+               "The bypass route between %s and %s already exists.", src->get_cname(), dst->get_cname());
   }
 
   /* Build a copy that will be stored in the dict */
-  kernel::routing::BypassRoute* newRoute = new kernel::routing::BypassRoute(e_route->gw_src, e_route->gw_dst);
-  for (auto link : *e_route->link_list)
+  kernel::routing::BypassRoute* newRoute = new kernel::routing::BypassRoute(gw_src, gw_dst);
+  for (auto const& link : link_list)
     newRoute->links.push_back(link);
 
   /* Store it */
-  bypassRoutes_.insert({{e_route->src, e_route->dst}, newRoute});
+  bypass_routes_.insert({{src, dst}, newRoute});
 }
 
 /** @brief Get the common ancestor and its first children in each line leading to src and dst
@@ -146,8 +209,8 @@ static void find_common_ancestors(NetPoint* src, NetPoint* dst,
                                   NetZoneImpl** dst_ancestor)
 {
   /* Deal with the easy base case */
-  if (src->netzone() == dst->netzone()) {
-    *common_ancestor = src->netzone();
+  if (src->get_englobing_zone() == dst->get_englobing_zone()) {
+    *common_ancestor = src->get_englobing_zone();
     *src_ancestor    = *common_ancestor;
     *dst_ancestor    = *common_ancestor;
     return;
@@ -156,24 +219,24 @@ static void find_common_ancestors(NetPoint* src, NetPoint* dst,
   /* engage the full recursive search */
 
   /* (1) find the path to root of src and dst*/
-  NetZoneImpl* src_as = src->netzone();
-  NetZoneImpl* dst_as = dst->netzone();
+  NetZoneImpl* src_as = src->get_englobing_zone();
+  NetZoneImpl* dst_as = dst->get_englobing_zone();
 
-  xbt_assert(src_as, "Host %s must be in a netzone", src->cname());
-  xbt_assert(dst_as, "Host %s must be in a netzone", dst->cname());
+  xbt_assert(src_as, "Host %s must be in a netzone", src->get_cname());
+  xbt_assert(dst_as, "Host %s must be in a netzone", dst->get_cname());
 
   /* (2) find the path to the root routing component */
   std::vector<NetZoneImpl*> path_src;
-  NetZoneImpl* current = src->netzone();
+  NetZoneImpl* current = src->get_englobing_zone();
   while (current != nullptr) {
     path_src.push_back(current);
-    current = static_cast<NetZoneImpl*>(current->father());
+    current = static_cast<NetZoneImpl*>(current->get_father());
   }
   std::vector<NetZoneImpl*> path_dst;
-  current = dst->netzone();
+  current = dst->get_englobing_zone();
   while (current != nullptr) {
     path_dst.push_back(current);
-    current = static_cast<NetZoneImpl*>(current->father());
+    current = static_cast<NetZoneImpl*>(current->get_father());
   }
 
   /* (3) find the common father.
@@ -201,23 +264,23 @@ static void find_common_ancestors(NetPoint* src, NetPoint* dst,
 }
 
 /* PRECONDITION: this is the common ancestor of src and dst */
-bool NetZoneImpl::getBypassRoute(routing::NetPoint* src, routing::NetPoint* dst,
-                                 /* OUT */ std::vector<surf::LinkImpl*>* links, double* latency)
+bool NetZoneImpl::get_bypass_route(routing::NetPoint* src, routing::NetPoint* dst,
+                                   /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
 {
   // If never set a bypass route return nullptr without any further computations
-  if (bypassRoutes_.empty())
+  if (bypass_routes_.empty())
     return false;
 
   /* Base case, no recursion is needed */
-  if (dst->netzone() == this && src->netzone() == this) {
-    if (bypassRoutes_.find({src, dst}) != bypassRoutes_.end()) {
-      BypassRoute* bypassedRoute = bypassRoutes_.at({src, dst});
-      for (surf::LinkImpl* link : bypassedRoute->links) {
-        links->push_back(link);
+  if (dst->get_englobing_zone() == this && src->get_englobing_zone() == this) {
+    if (bypass_routes_.find({src, dst}) != bypass_routes_.end()) {
+      BypassRoute* bypassedRoute = bypass_routes_.at({src, dst});
+      for (resource::LinkImpl* const& link : bypassedRoute->links) {
+        links.push_back(link);
         if (latency)
-          *latency += link->latency();
+          *latency += link->get_latency();
       }
-      XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links", src->cname(), dst->cname(),
+      XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links", src->get_cname(), dst->get_cname(),
                 bypassedRoute->links.size());
       return true;
     }
@@ -228,14 +291,14 @@ bool NetZoneImpl::getBypassRoute(routing::NetPoint* src, routing::NetPoint* dst,
 
   /* (1) find the path to the root routing component */
   std::vector<NetZoneImpl*> path_src;
-  NetZone* current = src->netzone();
+  NetZoneImpl* current = src->get_englobing_zone();
   while (current != nullptr) {
     path_src.push_back(static_cast<NetZoneImpl*>(current));
     current = current->father_;
   }
 
   std::vector<NetZoneImpl*> path_dst;
-  current = dst->netzone();
+  current = dst->get_englobing_zone();
   while (current != nullptr) {
     path_dst.push_back(static_cast<NetZoneImpl*>(current));
     current = current->father_;
@@ -260,15 +323,17 @@ bool NetZoneImpl::getBypassRoute(routing::NetPoint* src, routing::NetPoint* dst,
     for (int i = 0; i < max; i++) {
       if (i <= max_index_src && max <= max_index_dst) {
         key = {path_src.at(i)->netpoint_, path_dst.at(max)->netpoint_};
-        if (bypassRoutes_.find(key) != bypassRoutes_.end()) {
-          bypassedRoute = bypassRoutes_.at(key);
+        auto bpr = bypass_routes_.find(key);
+        if (bpr != bypass_routes_.end()) {
+          bypassedRoute = bpr->second;
           break;
         }
       }
       if (max <= max_index_src && i <= max_index_dst) {
         key = {path_src.at(max)->netpoint_, path_dst.at(i)->netpoint_};
-        if (bypassRoutes_.find(key) != bypassRoutes_.end()) {
-          bypassedRoute = bypassRoutes_.at(key);
+        auto bpr = bypass_routes_.find(key);
+        if (bpr != bypass_routes_.end()) {
+          bypassedRoute = bpr->second;
           break;
         }
       }
@@ -279,8 +344,9 @@ bool NetZoneImpl::getBypassRoute(routing::NetPoint* src, routing::NetPoint* dst,
 
     if (max <= max_index_src && max <= max_index_dst) {
       key = {path_src.at(max)->netpoint_, path_dst.at(max)->netpoint_};
-      if (bypassRoutes_.find(key) != bypassRoutes_.end()) {
-        bypassedRoute = bypassRoutes_.at(key);
+      auto bpr = bypass_routes_.find(key);
+      if (bpr != bypass_routes_.end()) {
+        bypassedRoute = bpr->second;
         break;
       }
     }
@@ -290,67 +356,64 @@ bool NetZoneImpl::getBypassRoute(routing::NetPoint* src, routing::NetPoint* dst,
   if (bypassedRoute) {
     XBT_DEBUG("Found a bypass route from '%s' to '%s' with %zu links. We may have to complete it with recursive "
               "calls to getRoute",
-              src->cname(), dst->cname(), bypassedRoute->links.size());
+              src->get_cname(), dst->get_cname(), bypassedRoute->links.size());
     if (src != key.first)
-      getGlobalRoute(src, bypassedRoute->gw_src, links, latency);
-    for (surf::LinkImpl* link : bypassedRoute->links) {
-      links->push_back(link);
+      get_global_route(src, bypassedRoute->gw_src, links, latency);
+    for (resource::LinkImpl* const& link : bypassedRoute->links) {
+      links.push_back(link);
       if (latency)
-        *latency += link->latency();
+        *latency += link->get_latency();
     }
     if (dst != key.second)
-      getGlobalRoute(bypassedRoute->gw_dst, dst, links, latency);
+      get_global_route(bypassedRoute->gw_dst, dst, links, latency);
     return true;
   }
-  XBT_DEBUG("No bypass route from '%s' to '%s'.", src->cname(), dst->cname());
+  XBT_DEBUG("No bypass route from '%s' to '%s'.", src->get_cname(), dst->get_cname());
   return false;
 }
 
-void NetZoneImpl::getGlobalRoute(routing::NetPoint* src, routing::NetPoint* dst,
-                                 /* OUT */ std::vector<surf::LinkImpl*>* links, double* latency)
+void NetZoneImpl::get_global_route(NetPoint* src, NetPoint* dst,
+                                   /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
 {
-  s_sg_platf_route_cbarg_t route;
-  memset(&route, 0, sizeof(route));
+  RouteCreationArgs route;
 
-  XBT_DEBUG("Resolve route from '%s' to '%s'", src->cname(), dst->cname());
+  XBT_DEBUG("Resolve route from '%s' to '%s'", src->get_cname(), dst->get_cname());
 
   /* Find how src and dst are interconnected */
   NetZoneImpl *common_ancestor;
   NetZoneImpl *src_ancestor;
   NetZoneImpl *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());
+  XBT_DEBUG("elements_father: common ancestor '%s' src ancestor '%s' dst ancestor '%s'", common_ancestor->get_cname(),
+            src_ancestor->get_cname(), dst_ancestor->get_cname());
 
   /* Check whether a direct bypass is defined. If so, use it and bail out */
-  if (common_ancestor->getBypassRoute(src, dst, links, latency))
+  if (common_ancestor->get_bypass_route(src, dst, links, latency))
     return;
 
   /* If src and dst are in the same netzone, life is good */
   if (src_ancestor == dst_ancestor) { /* SURF_ROUTING_BASE */
-    route.link_list = links;
-    common_ancestor->getLocalRoute(src, dst, &route, latency);
+    route.link_list = std::move(links);
+    common_ancestor->get_local_route(src, dst, &route, latency);
+    links = std::move(route.link_list);
     return;
   }
 
   /* Not in the same netzone, no bypass. We'll have to find our path between the netzones recursively */
 
-  route.link_list = new std::vector<surf::LinkImpl*>();
-
-  common_ancestor->getLocalRoute(src_ancestor->netpoint_, dst_ancestor->netpoint_, &route, latency);
+  common_ancestor->get_local_route(src_ancestor->netpoint_, dst_ancestor->netpoint_, &route, latency);
   xbt_assert((route.gw_src != nullptr) && (route.gw_dst != nullptr), "bad gateways for route from \"%s\" to \"%s\"",
-             src->cname(), dst->cname());
+             src->get_cname(), dst->get_cname());
 
   /* If source gateway is not our source, we have to recursively find our way up to this point */
   if (src != route.gw_src)
-    getGlobalRoute(src, route.gw_src, links, latency);
-  for (auto link : *route.link_list)
-    links->push_back(link);
-  delete route.link_list;
+    get_global_route(src, route.gw_src, links, latency);
+  for (auto const& 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)
-    getGlobalRoute(route.gw_dst, dst, links, latency);
+    get_global_route(route.gw_dst, dst, links, latency);
 }
 }
 }