Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
A bool is OK in boolean context.
[simgrid.git] / src / kernel / routing / NetZoneImpl.cpp
index f70889a..6caa246 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2021. 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. */
@@ -7,6 +7,10 @@
 #include "simgrid/kernel/routing/NetPoint.hpp"
 #include "simgrid/s4u/Engine.hpp"
 #include "simgrid/s4u/Host.hpp"
+#include "src/include/simgrid/sg_config.hpp"
+#include "src/kernel/EngineImpl.hpp"
+#include "src/kernel/resource/DiskImpl.hpp"
+#include "src/surf/HostImpl.hpp"
 #include "src/surf/cpu_interface.hpp"
 #include "src/surf/network_interface.hpp"
 #include "src/surf/xml/platf_private.hpp"
@@ -18,54 +22,166 @@ namespace simgrid {
 namespace kernel {
 namespace routing {
 
-class BypassRoute {
-public:
-  explicit BypassRoute(NetPoint* gwSrc, NetPoint* gwDst) : gw_src(gwSrc), gw_dst(gwDst) {}
-  NetPoint* gw_src;
-  NetPoint* gw_dst;
-  std::vector<resource::LinkImpl*> links;
-};
+/* Pick the right models for CPU, net and host, and call their model_init_preparse */
+static void surf_config_models_setup()
+{
+  std::string host_model_name    = simgrid::config::get_value<std::string>("host/model");
+  std::string network_model_name = simgrid::config::get_value<std::string>("network/model");
+  std::string cpu_model_name     = simgrid::config::get_value<std::string>("cpu/model");
+  std::string disk_model_name    = simgrid::config::get_value<std::string>("disk/model");
+
+  /* The compound host model is needed when using non-default net/cpu models */
+  if ((not simgrid::config::is_default("network/model") || not simgrid::config::is_default("cpu/model")) &&
+      simgrid::config::is_default("host/model")) {
+    host_model_name = "compound";
+    simgrid::config::set_value("host/model", host_model_name);
+  }
+
+  XBT_DEBUG("host model: %s", host_model_name.c_str());
+  if (host_model_name == "compound") {
+    xbt_assert(not cpu_model_name.empty(), "Set a cpu model to use with the 'compound' host model");
+    xbt_assert(not network_model_name.empty(), "Set a network model to use with the 'compound' host model");
 
-NetZoneImpl::NetZoneImpl(NetZone* father, std::string name) : NetZone(father, name)
+    int cpu_id = find_model_description(surf_cpu_model_description, cpu_model_name);
+    surf_cpu_model_description[cpu_id].model_init_preparse();
+
+    int network_id = find_model_description(surf_network_model_description, network_model_name);
+    surf_network_model_description[network_id].model_init_preparse();
+  }
+
+  XBT_DEBUG("Call host_model_init");
+  int host_id = find_model_description(surf_host_model_description, host_model_name);
+  surf_host_model_description[host_id].model_init_preparse();
+
+  XBT_DEBUG("Call vm_model_init");
+  /* ideally we should get back the pointer to CpuModel from model_init_preparse(), but this
+   * requires changing the declaration of surf_cpu_model_description.
+   * To be reviewed in the future */
+  surf_vm_model_init_HL13(
+      simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->get_cpu_pm_model().get());
+
+  XBT_DEBUG("Call disk_model_init");
+  int disk_id = find_model_description(surf_disk_model_description, disk_model_name);
+  surf_disk_model_description[disk_id].model_init_preparse();
+}
+
+NetZoneImpl::NetZoneImpl(const std::string& name) : piface_(this), name_(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());
+  /* workaroud: first netzoneImpl will be the root netzone.
+   * Without globals and with current surf_*_model_description init functions, we need
+   * the root netzone to exist when creating the models.
+   * This was usually done at sg_platf.cpp, during XML parsing */
+  if (not s4u::Engine::get_instance()->get_netzone_root())
+    s4u::Engine::get_instance()->set_netzone_root(&piface_);
+
+  static bool surf_parse_models_setup_already_called = false;
+  if (not surf_parse_models_setup_already_called) {
+    simgrid::s4u::Engine::on_platform_creation();
+
+    /* Initialize the surf models. That must be done after we got all config, and before we need the models.
+     * That is, after the last <config> tag, if any, and before the first of cluster|peer|zone|trace|trace_connect
+     *
+     * I'm not sure for <trace> and <trace_connect>, there may be a bug here
+     * (FIXME: check it out by creating a file beginning with one of these tags)
+     * but cluster and peer come down to zone creations, so putting this verification here is correct.
+     */
+    surf_parse_models_setup_already_called = true;
+    surf_config_models_setup();
+  }
 
-  netpoint_ = new NetPoint(name, NetPoint::Type::NetZone, static_cast<NetZoneImpl*>(father));
-  XBT_DEBUG("NetZone '%s' created with the id '%u'", name.c_str(), netpoint_->id());
+  xbt_assert(nullptr == s4u::Engine::get_instance()->netpoint_by_name_or_null(get_name()),
+             "Refusing to create a second NetZone called '%s'.", get_cname());
+  netpoint_ = new NetPoint(name_, NetPoint::Type::NetZone);
+  XBT_DEBUG("NetZone '%s' created with the id '%u'", get_cname(), netpoint_->id());
 }
 
 NetZoneImpl::~NetZoneImpl()
 {
+  for (auto const& nz : children_)
+    delete nz;
+
   for (auto const& kv : bypass_routes_)
     delete kv.second;
 
-  simgrid::s4u::Engine::get_instance()->netpoint_unregister(netpoint_);
+  s4u::Engine::get_instance()->netpoint_unregister(netpoint_);
+}
+
+void NetZoneImpl::add_child(NetZoneImpl* new_zone)
+{
+  xbt_assert(not sealed_, "Cannot add a new child to the sealed zone %s", get_cname());
+  children_.push_back(new_zone);
+}
+
+/** @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() const
+{
+  std::vector<s4u::Host*> res;
+  for (auto const& card : get_vertices()) {
+    s4u::Host* host = s4u::Host::by_name_or_null(card->get_name());
+    if (host != nullptr)
+      res.push_back(host);
+  }
+  return res;
+}
+int NetZoneImpl::get_host_count() const
+{
+  int count = 0;
+  for (auto const& card : get_vertices()) {
+    const s4u::Host* host = s4u::Host::by_name_or_null(card->get_name());
+    if (host != nullptr)
+      count++;
+  }
+  return count;
 }
 
-simgrid::s4u::Host* NetZoneImpl::create_host(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
-                                             std::map<std::string, std::string>* props)
+s4u::Disk* NetZoneImpl::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
 {
-  simgrid::s4u::Host* res = new simgrid::s4u::Host(name);
+  auto* l = disk_model_->create_disk(name, read_bandwidth, write_bandwidth);
 
+  return l->get_iface();
+}
+
+s4u::Link* NetZoneImpl::create_link(const std::string& name, const std::vector<double>& bandwidths)
+{
+  return network_model_->create_link(name, bandwidths)->get_iface();
+}
+
+s4u::Link* NetZoneImpl::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
+{
+  return network_model_->create_wifi_link(name, bandwidths)->get_iface();
+}
+
+s4u::Host* NetZoneImpl::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
+{
   if (hierarchy_ == RoutingMode::unset)
     hierarchy_ = RoutingMode::base;
 
-  res->pimpl_netpoint = new NetPoint(name, NetPoint::Type::Host, this);
+  auto* res = (new surf::HostImpl(name))->get_iface();
+  res->set_netpoint((new NetPoint(name, NetPoint::Type::Host))->set_englobing_zone(this));
 
-  surf_cpu_model_pm->createCpu(res, speedPerPstate, coreAmount);
+  cpu_model_pm_->create_cpu(res, speed_per_pstate);
 
-  if (props != nullptr)
-    for (auto const& kv : *props)
-      res->set_property(kv.first, kv.second);
+  return res;
+}
 
-  simgrid::s4u::Host::on_creation(*res); // notify the signal
+int NetZoneImpl::add_component(NetPoint* elm)
+{
+  vertices_.push_back(elm);
+  return vertices_.size() - 1; // The rank of the newly created object
+}
 
-  return res;
+void NetZoneImpl::add_route(NetPoint* /*src*/, NetPoint* /*dst*/, NetPoint* /*gw_src*/, NetPoint* /*gw_dst*/,
+                            const std::vector<resource::LinkImpl*>& /*link_list*/, bool /*symmetrical*/)
+{
+  xbt_die("NetZone '%s' does not accept new routes (wrong class).", get_cname());
 }
 
 void NetZoneImpl::add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
-                                   std::vector<resource::LinkImpl*>& link_list, bool symmetrical)
+                                   std::vector<resource::LinkImpl*>& link_list, bool /* symmetrical */)
 {
   /* Argument validity checks */
   if (gw_dst) {
@@ -85,7 +201,7 @@ void NetZoneImpl::add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_sr
   }
 
   /* Build a copy that will be stored in the dict */
-  kernel::routing::BypassRoute* newRoute = new kernel::routing::BypassRoute(gw_src, gw_dst);
+  auto* newRoute = new BypassRoute(gw_src, gw_dst);
   for (auto const& link : link_list)
     newRoute->links.push_back(link);
 
@@ -158,8 +274,8 @@ 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->get_englobing_zone();
-  NetZoneImpl* dst_as = dst->get_englobing_zone();
+  const NetZoneImpl* src_as = src->get_englobing_zone();
+  const NetZoneImpl* dst_as = dst->get_englobing_zone();
 
   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());
@@ -169,13 +285,13 @@ static void find_common_ancestors(NetPoint* src, NetPoint* dst,
   NetZoneImpl* current = src->get_englobing_zone();
   while (current != nullptr) {
     path_src.push_back(current);
-    current = static_cast<NetZoneImpl*>(current->getFather());
+    current = current->get_parent();
   }
   std::vector<NetZoneImpl*> path_dst;
   current = dst->get_englobing_zone();
   while (current != nullptr) {
     path_dst.push_back(current);
-    current = static_cast<NetZoneImpl*>(current->getFather());
+    current = current->get_parent();
   }
 
   /* (3) find the common father.
@@ -203,7 +319,7 @@ static void find_common_ancestors(NetPoint* src, NetPoint* dst,
 }
 
 /* PRECONDITION: this is the common ancestor of src and dst */
-bool NetZoneImpl::get_bypass_route(routing::NetPoint* src, routing::NetPoint* dst,
+bool NetZoneImpl::get_bypass_route(NetPoint* src, NetPoint* dst,
                                    /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency)
 {
   // If never set a bypass route return nullptr without any further computations
@@ -213,11 +329,11 @@ bool NetZoneImpl::get_bypass_route(routing::NetPoint* src, routing::NetPoint* ds
   /* Base case, no recursion is needed */
   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});
+      const 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->get_cname(), dst->get_cname(),
                 bypassedRoute->links.size());
@@ -230,17 +346,17 @@ bool NetZoneImpl::get_bypass_route(routing::NetPoint* src, routing::NetPoint* ds
 
   /* (1) find the path to the root routing component */
   std::vector<NetZoneImpl*> path_src;
-  NetZone* current = src->get_englobing_zone();
+  NetZoneImpl* current = src->get_englobing_zone();
   while (current != nullptr) {
-    path_src.push_back(static_cast<NetZoneImpl*>(current));
-    current = current->father_;
+    path_src.push_back(current);
+    current = current->parent_;
   }
 
   std::vector<NetZoneImpl*> path_dst;
   current = dst->get_englobing_zone();
   while (current != nullptr) {
-    path_dst.push_back(static_cast<NetZoneImpl*>(current));
-    current = current->father_;
+    path_dst.push_back(current);
+    current = current->parent_;
   }
 
   /* (2) find the common father */
@@ -256,37 +372,31 @@ bool NetZoneImpl::get_bypass_route(routing::NetPoint* src, routing::NetPoint* ds
   int max_index = std::max(max_index_src, max_index_dst);
 
   /* (3) Search for a bypass making the path up to the ancestor useless */
-  BypassRoute* bypassedRoute = nullptr;
+  const BypassRoute* bypassedRoute = nullptr;
   std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*> key;
-  for (int max = 0; max <= max_index; max++) {
-    for (int i = 0; i < max; i++) {
+  for (int max = 0; max <= max_index && not bypassedRoute; max++) {
+    for (int i = 0; i < max && not bypassedRoute; i++) {
       if (i <= max_index_src && max <= max_index_dst) {
-        key = {path_src.at(i)->netpoint_, path_dst.at(max)->netpoint_};
+        key      = {path_src.at(i)->netpoint_, path_dst.at(max)->netpoint_};
         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 (not bypassedRoute && max <= max_index_src && i <= max_index_dst) {
+        key      = {path_src.at(max)->netpoint_, path_dst.at(i)->netpoint_};
         auto bpr = bypass_routes_.find(key);
         if (bpr != bypass_routes_.end()) {
           bypassedRoute = bpr->second;
-          break;
         }
       }
     }
 
-    if (bypassedRoute)
-      break;
-
-    if (max <= max_index_src && max <= max_index_dst) {
-      key = {path_src.at(max)->netpoint_, path_dst.at(max)->netpoint_};
+    if (not bypassedRoute && max <= max_index_src && max <= max_index_dst) {
+      key      = {path_src.at(max)->netpoint_, path_dst.at(max)->netpoint_};
       auto bpr = bypass_routes_.find(key);
       if (bpr != bypass_routes_.end()) {
         bypassedRoute = bpr->second;
-        break;
       }
     }
   }
@@ -301,7 +411,7 @@ bool NetZoneImpl::get_bypass_route(routing::NetPoint* src, routing::NetPoint* ds
     for (resource::LinkImpl* const& link : bypassedRoute->links) {
       links.push_back(link);
       if (latency)
-        *latency += link->latency();
+        *latency += link->get_latency();
     }
     if (dst != key.second)
       get_global_route(bypassedRoute->gw_dst, dst, links, latency);
@@ -319,9 +429,9 @@ void NetZoneImpl::get_global_route(NetPoint* src, NetPoint* dst,
   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;
+  NetZoneImplcommon_ancestor;
+  NetZoneImplsrc_ancestor;
+  NetZoneImpldst_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->get_cname(),
             src_ancestor->get_cname(), dst_ancestor->get_cname());
@@ -341,7 +451,7 @@ void NetZoneImpl::get_global_route(NetPoint* src, NetPoint* dst,
   /* Not in the same netzone, no bypass. We'll have to find our path between the netzones recursively */
 
   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\"",
+  xbt_assert((route.gw_src != nullptr) && (route.gw_dst != nullptr), "Bad gateways for route from '%s' to '%s'.",
              src->get_cname(), dst->get_cname());
 
   /* If source gateway is not our source, we have to recursively find our way up to this point */
@@ -354,6 +464,61 @@ void NetZoneImpl::get_global_route(NetPoint* src, NetPoint* dst,
   if (route.gw_dst != dst)
     get_global_route(route.gw_dst, dst, links, latency);
 }
+
+void NetZoneImpl::seal()
+{
+  /* already sealed netzone */
+  if (sealed_)
+    return;
+  do_seal(); // derived class' specific sealing procedure
+
+  /* seals sub-netzones and hosts */
+  for (auto* host : get_all_hosts()) {
+    host->seal();
+  }
+  for (auto* sub_net : *get_children()) {
+    sub_net->seal();
+  }
+  sealed_ = true;
+}
+
+void NetZoneImpl::set_parent(NetZoneImpl* parent)
+{
+  xbt_assert(not sealed_, "Impossible to set parent to an already sealed NetZone(%s)", this->get_cname());
+  parent_ = parent;
+  netpoint_->set_englobing_zone(parent_);
 }
+
+void NetZoneImpl::set_network_model(std::shared_ptr<resource::NetworkModel> netmodel)
+{
+  xbt_assert(not sealed_, "Impossible to set network model to an already sealed NetZone(%s)", this->get_cname());
+  network_model_ = std::move(netmodel);
 }
-} // namespace
+
+void NetZoneImpl::set_cpu_vm_model(std::shared_ptr<resource::CpuModel> cpu_model)
+{
+  xbt_assert(not sealed_, "Impossible to set CPU model to an already sealed NetZone(%s)", this->get_cname());
+  cpu_model_vm_ = std::move(cpu_model);
+}
+
+void NetZoneImpl::set_cpu_pm_model(std::shared_ptr<resource::CpuModel> cpu_model)
+{
+  xbt_assert(not sealed_, "Impossible to set CPU model to an already sealed NetZone(%s)", this->get_cname());
+  cpu_model_pm_ = std::move(cpu_model);
+}
+
+void NetZoneImpl::set_disk_model(std::shared_ptr<resource::DiskModel> disk_model)
+{
+  xbt_assert(not sealed_, "Impossible to set disk model to an already sealed NetZone(%s)", this->get_cname());
+  disk_model_ = std::move(disk_model);
+}
+
+void NetZoneImpl::set_host_model(std::shared_ptr<surf::HostModel> host_model)
+{
+  xbt_assert(not sealed_, "Impossible to set host model to an already sealed NetZone(%s)", this->get_cname());
+  host_model_ = std::move(host_model);
+}
+
+} // namespace routing
+} // namespace kernel
+} // namespace simgrid