Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add new entry in Release_Notes.
[simgrid.git] / src / s4u / s4u_Netzone.cpp
index cb45e8e..b62e620 100644 (file)
@@ -1,52 +1,45 @@
-/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2023. 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 "simgrid/kernel/routing/NetPoint.hpp"
-#include "simgrid/s4u/Engine.hpp"
+#include "simgrid/Exception.hpp"
 #include "simgrid/s4u/Host.hpp"
-#include "simgrid/s4u/NetZone.hpp"
-#include "simgrid/zone.h"
+#include <simgrid/kernel/routing/NetZoneImpl.hpp>
+#include <simgrid/s4u/Engine.hpp>
+#include <simgrid/s4u/NetZone.hpp>
+#include <simgrid/simix.hpp>
+#include <simgrid/zone.h>
+#include <xbt/parse_units.hpp>
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_netzone, "S4U Networking Zones");
+#include "src/kernel/resource/NetworkModel.hpp"
 
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
 
-xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
-                 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
-                 std::vector<kernel::resource::LinkImpl*> const& link_list)>
-    NetZone::on_route_creation;
 xbt::signal<void(NetZone const&)> NetZone::on_creation;
 xbt::signal<void(NetZone const&)> NetZone::on_seal;
 
-NetZone::NetZone(kernel::routing::NetZoneImpl* impl) : pimpl_(impl) {}
-
-NetZone::~NetZone()
-{
-}
-
-std::unordered_map<std::string, std::string>* NetZone::get_properties()
+const std::unordered_map<std::string, std::string>* NetZone::get_properties() const
 {
-  return simix::simcall([this] { return &properties_; });
+  return pimpl_->get_properties();
 }
 
 /** Retrieve the property value (or nullptr if not set) */
-const char* NetZone::get_property(const std::string& key)
+const char* NetZone::get_property(const std::string& key) const
 {
-  return properties_.at(key).c_str();
+  return pimpl_->get_property(key);
 }
+
 void NetZone::set_property(const std::string& key, const std::string& value)
 {
-  simix::simcall([this, &key, &value] { properties_[key] = value; });
+  kernel::actor::simcall_answered([this, &key, &value] { pimpl_->set_property(key, value); });
 }
 
 /** @brief Returns the list of direct children (no grand-children) */
-std::vector<NetZone*> NetZone::get_children()
+std::vector<NetZone*> NetZone::get_children() const
 {
   std::vector<NetZone*> res;
-  for (auto child : *(pimpl_->get_children()))
+  for (auto* child : pimpl_->get_children())
     res.push_back(child->get_iface());
   return res;
 }
@@ -55,13 +48,21 @@ const std::string& NetZone::get_name() const
 {
   return pimpl_->get_name();
 }
+
 const char* NetZone::get_cname() const
 {
   return pimpl_->get_cname();
 }
-NetZone* NetZone::get_father()
+
+NetZone* NetZone::get_parent() const
+{
+  return pimpl_->get_parent()->get_iface();
+}
+
+NetZone* NetZone::set_parent(const NetZone* parent)
 {
-  return pimpl_->get_father()->get_iface();
+  kernel::actor::simcall_answered([this, parent] { pimpl_->set_parent(parent->get_impl()); });
+  return this;
 }
 
 /** @brief Returns the list of the hosts found in this NetZone (not recursively)
@@ -69,48 +70,226 @@ NetZone* NetZone::get_father()
  * Only the hosts that are directly contained in this NetZone are retrieved,
  * not the ones contained in sub-netzones.
  */
-std::vector<Host*> NetZone::get_all_hosts()
+std::vector<Host*> NetZone::get_all_hosts() const
 {
   return pimpl_->get_all_hosts();
 }
 
-void NetZone::getHosts(std::vector<Host*>* whereto)
+size_t NetZone::get_host_count() const
 {
-  for (auto const& card : pimpl_->get_vertices()) {
-    Host* host = Host::by_name_or_null(card->get_name());
-    if (host != nullptr)
-      whereto->push_back(host);
-  }
+  return pimpl_->get_host_count();
 }
 
-int NetZone::get_host_count()
+unsigned long NetZone::add_component(kernel::routing::NetPoint* elm)
 {
-  return pimpl_->get_host_count();
+  return pimpl_->add_component(elm);
 }
 
-int NetZone::add_component(kernel::routing::NetPoint* elm)
+void NetZone::add_route(const NetZone* src, const NetZone* dst, const std::vector<const Link*>& links)
 {
-  return pimpl_->add_component(elm);
+  std::vector<LinkInRoute> links_direct;
+  std::vector<LinkInRoute> links_reverse;
+  for (auto* l : links) {
+    links_direct.emplace_back(LinkInRoute(l, LinkInRoute::Direction::UP));
+    links_reverse.emplace_back(LinkInRoute(l, LinkInRoute::Direction::DOWN));
+  }
+  pimpl_->add_route(src ? src->get_netpoint() : nullptr, dst ? dst->get_netpoint(): nullptr,
+                    src ? src->get_gateway() : nullptr, dst ? dst->get_gateway() : nullptr,
+                    links_direct, false);
+  pimpl_->add_route(dst ? dst->get_netpoint(): nullptr, src ? src->get_netpoint() : nullptr,
+                    dst ? dst->get_gateway() : nullptr, src ? src->get_gateway() : nullptr,
+                    links_reverse, false);
+}
+
+void NetZone::add_route(const NetZone* src, const NetZone* dst, const std::vector<LinkInRoute>& link_list, bool symmetrical)
+{
+  pimpl_->add_route(src ? src->get_netpoint() : nullptr, dst ? dst->get_netpoint(): nullptr,
+                    src ? src->get_gateway() : nullptr, dst ? dst->get_gateway() : nullptr,
+                    link_list, symmetrical);
 }
 
 void NetZone::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)
+                        const std::vector<LinkInRoute>& link_list, bool symmetrical) // XBT_ATTRIB_DEPRECATED_v339
 {
   pimpl_->add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
 }
+
+void NetZone::add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
+                        kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
+                        const std::vector<const Link*>& links) // XBT_ATTRIB_DEPRECATED_v339
+{
+  std::vector<LinkInRoute> links_direct;
+  std::vector<LinkInRoute> links_reverse;
+  for (auto* l : links) {
+    links_direct.emplace_back(LinkInRoute(l, LinkInRoute::Direction::UP));
+    links_reverse.emplace_back(LinkInRoute(l, LinkInRoute::Direction::DOWN));
+  }
+  pimpl_->add_route(src, dst, gw_src, gw_dst, links_direct, false);
+  pimpl_->add_route(dst, src, gw_dst, gw_src, links_reverse, false);
+}
+
+void NetZone::add_route(const Host* src, const Host* dst, const std::vector<LinkInRoute>& link_list, bool symmetrical)
+{
+  pimpl_->add_route(src ? src->get_netpoint(): nullptr, dst ? dst->get_netpoint(): nullptr, nullptr, nullptr,
+                    link_list, symmetrical);
+
+}
+
+void NetZone::add_route(const Host* src, const Host* dst, const std::vector<const Link*>& links)
+{
+  std::vector<LinkInRoute> links_direct;
+  std::vector<LinkInRoute> links_reverse;
+  for (auto* l : links) {
+    links_direct.emplace_back(LinkInRoute(l, LinkInRoute::Direction::UP));
+    links_reverse.emplace_back(LinkInRoute(l, LinkInRoute::Direction::DOWN));
+  }
+  pimpl_->add_route(src ? src->get_netpoint(): nullptr, dst ? dst->get_netpoint(): nullptr, nullptr, nullptr,
+                    links_direct, false);
+  pimpl_->add_route(dst ? dst->get_netpoint(): nullptr, src ? src->get_netpoint(): nullptr, nullptr, nullptr,
+                    links_reverse, false);
+}
+
 void NetZone::add_bypass_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)
+                               const std::vector<LinkInRoute>& link_list)
+{
+  pimpl_->add_bypass_route(src, dst, gw_src, gw_dst, link_list);
+}
+
+void NetZone::extract_xbt_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
+                                std::map<std::string, xbt_edge_t, std::less<>>* edges)
+{
+  for (auto const& child : get_children())
+    child->extract_xbt_graph(graph, nodes, edges);
+
+  pimpl_->get_graph(graph, nodes, edges);
+}
+
+NetZone* NetZone::seal()
+{
+  kernel::actor::simcall_answered([this] { pimpl_->seal(); });
+  return this;
+}
+void NetZone::set_latency_factor_cb(
+    std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
+                         const std::vector<s4u::Link*>& /*links*/,
+                         const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const
+{
+  kernel::actor::simcall_answered([this, &cb]() { pimpl_->get_network_model()->set_lat_factor_cb(cb); });
+}
+void NetZone::set_bandwidth_factor_cb(
+    std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
+                         const std::vector<s4u::Link*>& /*links*/,
+                         const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const
+{
+  kernel::actor::simcall_answered([this, &cb]() { pimpl_->get_network_model()->set_bw_factor_cb(cb); });
+}
+
+s4u::Host* NetZone::create_host(const std::string& name, double speed)
 {
-  pimpl_->add_bypass_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
+  return create_host(name, std::vector<double>{speed});
 }
-std::vector<kernel::routing::NetPoint*> NetZone::getVertices()
+
+s4u::Host* NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
+{
+  return kernel::actor::simcall_answered(
+      [this, &name, &speed_per_pstate] { return pimpl_->create_host(name, speed_per_pstate); });
+}
+
+s4u::Host* NetZone::create_host(const std::string& name, const std::string& speed)
+{
+  return create_host(name, std::vector<std::string>{speed});
+}
+
+s4u::Host* NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
+{
+  return create_host(name, Host::convert_pstate_speed_vector(speed_per_pstate));
+}
+
+s4u::Link* NetZone::create_link(const std::string& name, double bandwidth)
+{
+  return create_link(name, std::vector<double>{bandwidth});
+}
+
+s4u::Link* NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
+{
+  return kernel::actor::simcall_answered([this, &name, &bandwidths] { return pimpl_->create_link(name, bandwidths); });
+}
+
+s4u::Link* NetZone::create_link(const std::string& name, const std::string& bandwidth)
+{
+  return create_link(name, std::vector<std::string>{bandwidth});
+}
+
+s4u::SplitDuplexLink* NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
+{
+  double speed;
+  try {
+    speed = xbt_parse_get_bandwidth("", 0, bandwidth, "");
+  } catch (const simgrid::ParseError&) {
+    throw std::invalid_argument("Impossible to create split-duplex link: " + name +
+                                ". Invalid bandwidth: " + bandwidth);
+  }
+  return create_split_duplex_link(name, speed);
+}
+
+s4u::SplitDuplexLink* NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
+{
+  return kernel::actor::simcall_answered(
+      [this, &name, &bandwidth] { return pimpl_->create_split_duplex_link(name, std::vector<double>{bandwidth}); });
+}
+
+s4u::Link* NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidths)
+{
+  std::vector<double> bw;
+  bw.reserve(bandwidths.size());
+  for (const auto& speed_str : bandwidths) {
+    try {
+      double speed = xbt_parse_get_bandwidth("", 0, speed_str, "");
+      bw.push_back(speed);
+    } catch (const simgrid::ParseError&) {
+      throw std::invalid_argument("Impossible to create link: " + name + ". Invalid bandwidth: " + speed_str);
+    }
+  }
+  return create_link(name, bw);
+}
+
+kernel::routing::NetPoint* NetZone::create_router(const std::string& name)
+{
+  return kernel::actor::simcall_answered([this, &name] { return pimpl_->create_router(name); });
+}
+
+kernel::routing::NetPoint* NetZone::get_netpoint() const
+{
+  return pimpl_->get_netpoint();
+}
+
+kernel::routing::NetPoint* NetZone::get_gateway() const
+{
+  return pimpl_->get_gateway();
+}
+
+kernel::routing::NetPoint* NetZone::get_gateway(const std::string& name) const
+{
+  return pimpl_->get_gateway(name);
+}
+
+void NetZone::set_gateway(kernel::routing::NetPoint* router)
+{
+  set_gateway("default", router);
+}
+
+void NetZone::set_gateway(const std::string& name, kernel::routing::NetPoint* router)
+{
+  kernel::actor::simcall_answered([this, name, router] { pimpl_->set_gateway(name, router); });
+}
+
+kernel::resource::NetworkModel* NetZone::get_network_model() const
 {
-  return pimpl_->get_vertices();
+  return pimpl_->get_network_model().get();
 }
-} // namespace s4u
-} // namespace simgrid
+} // namespace simgrid::s4u
 
 /* **************************** Public C interface *************************** */
 
@@ -119,7 +298,7 @@ sg_netzone_t sg_zone_get_root()
   return simgrid::s4u::Engine::get_instance()->get_netzone_root();
 }
 
-const char* sg_zone_get_name(sg_netzone_t netzone)
+const char* sg_zone_get_name(const_sg_netzone_t netzone)
 {
   return netzone->get_cname();
 }
@@ -129,24 +308,24 @@ sg_netzone_t sg_zone_get_by_name(const char* name)
   return simgrid::s4u::Engine::get_instance()->netzone_by_name_or_null(name);
 }
 
-void sg_zone_get_sons(sg_netzone_t netzone, xbt_dict_t whereto)
+void sg_zone_get_sons(const_sg_netzone_t netzone, xbt_dict_t whereto)
 {
   for (auto const& elem : netzone->get_children()) {
-    xbt_dict_set(whereto, elem->get_cname(), static_cast<void*>(elem), nullptr);
+    xbt_dict_set(whereto, elem->get_cname(), elem);
   }
 }
 
-const char* sg_zone_get_property_value(sg_netzone_t netzone, const char* name)
+const char* sg_zone_get_property_value(const_sg_netzone_t netzone, const char* name)
 {
   return netzone->get_property(name);
 }
 
-void sg_zone_set_property_value(sg_netzone_t netzone, const char* name, char* value)
+void sg_zone_set_property_value(sg_netzone_t netzone, const char* name, const char* value)
 {
   netzone->set_property(name, value);
 }
 
-void sg_zone_get_hosts(sg_netzone_t netzone, xbt_dynar_t whereto)
+void sg_zone_get_hosts(const_sg_netzone_t netzone, xbt_dynar_t whereto)
 {
   /* converts vector to dynar */
   std::vector<simgrid::s4u::Host*> hosts = netzone->get_all_hosts();