Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix empty #ifndef..#endif. Annotate helper function as deprecated.
[simgrid.git] / src / s4u / s4u_Netzone.cpp
index 5e1387a..4ca7bd7 100644 (file)
-/* 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. */
 
+#include "simgrid/Exception.hpp"
 #include "simgrid/kernel/routing/NetPoint.hpp"
 #include "simgrid/s4u/Engine.hpp"
 #include "simgrid/s4u/Host.hpp"
 #include "simgrid/s4u/NetZone.hpp"
+#include "simgrid/simix.hpp"
 #include "simgrid/zone.h"
-
-XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_netzone, "S4U Networking Zones");
+#include "src/surf/network_interface.hpp"
+#include "xbt/parse_units.hpp"
 
 namespace simgrid {
 namespace s4u {
 
-simgrid::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*>& link_list)>
-    NetZone::onRouteCreation;
-simgrid::xbt::signal<void(NetZone&)> NetZone::onCreation;
-simgrid::xbt::signal<void(NetZone&)> NetZone::onSeal;
+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(NetZone* father, std::string name) : father_(father), name_(name)
+const std::unordered_map<std::string, std::string>* NetZone::get_properties() const
 {
-  children_ = new std::vector<NetZone*>();
+  return pimpl_->get_properties();
 }
 
-void NetZone::seal()
+/** Retrieve the property value (or nullptr if not set) */
+const char* NetZone::get_property(const std::string& key) const
 {
-  sealed_ = true;
+  return pimpl_->get_property(key);
 }
 
-NetZone::~NetZone()
+void NetZone::set_property(const std::string& key, const std::string& value)
 {
-  for (auto const& nz : *children_)
-    delete nz;
-  delete children_;
+  kernel::actor::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
 }
 
-std::unordered_map<std::string, std::string>* NetZone::getProperties()
+/** @brief Returns the list of direct children (no grand-children) */
+std::vector<NetZone*> NetZone::get_children() const
 {
-  return simgrid::simix::simcall([this] { return &properties_; });
+  std::vector<NetZone*> res;
+  for (auto child : pimpl_->get_children())
+    res.push_back(child->get_iface());
+  return res;
 }
 
-/** Retrieve the property value (or nullptr if not set) */
-const char* NetZone::getProperty(const char* key)
+NetZone* NetZone::add_child(NetZone* new_zone)
+{
+  new_zone->set_parent(this);
+  return this;
+}
+
+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()
 {
-  return properties_.at(key).c_str();
+  return pimpl_->get_parent()->get_iface();
 }
-void NetZone::setProperty(const char* key, const char* value)
+
+NetZone* NetZone::get_parent() const
+{
+  return pimpl_->get_parent()->get_iface();
+}
+
+NetZone* NetZone::set_parent(const NetZone* parent)
 {
-  simgrid::simix::simcall([this, key, value] { properties_[key] = value; });
+  kernel::actor::simcall([this, parent] { pimpl_->set_parent(parent->get_impl()); });
+  return this;
 }
 
-/** @brief Returns the list of direct children (no grand-children)
+/** @brief Returns the list of the hosts found in this NetZone (not recursively)
  *
- * This function returns the internal copy of the children, not a copy. Don't mess with it!
+ * Only the hosts that are directly contained in this NetZone are retrieved,
+ * not the ones contained in sub-netzones.
  */
-std::vector<NetZone*>* NetZone::getChildren()
+std::vector<Host*> NetZone::get_all_hosts() const
 {
-  return children_;
+  return pimpl_->get_all_hosts();
 }
 
-const char* NetZone::get_cname() const
+int NetZone::get_host_count() const
 {
-  return name_.c_str();
+  return pimpl_->get_host_count();
 }
-NetZone* NetZone::get_father()
+
+int NetZone::add_component(kernel::routing::NetPoint* elm)
+{
+  return pimpl_->add_component(elm);
+}
+
+// XBT_ATTRIB_DEPRECATED_v332
+std::vector<LinkInRoute> NetZone::convert_to_linkInRoute(const std::vector<kernel::resource::LinkImpl*>& link_list)
+{
+  std::vector<LinkInRoute> links;
+  for (const auto* link : link_list) {
+    links.emplace_back(LinkInRoute(link->get_iface()));
+  }
+  return links;
+}
+
+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<LinkInRoute>& link_list, bool symmetrical)
+{
+  pimpl_->add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
+}
+
+// XBT_ATTRIB_DEPRECATED_v332
+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<kernel::resource::LinkImpl*>& link_list, bool symmetrical)
+{
+  pimpl_->add_route(src, dst, gw_src, gw_dst, convert_to_linkInRoute(link_list), symmetrical);
+}
+
+// XBT_ATTRIB_DEPRECATED_v332
+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*/)
+{
+  pimpl_->add_bypass_route(src, dst, gw_src, gw_dst, convert_to_linkInRoute(link_list));
+}
+
+void NetZone::add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
+                               kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
+                               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([this] { pimpl_->seal(); });
+  return this;
+}
+
+s4u::Host* NetZone::create_host(const std::string& name, double speed)
+{
+  return create_host(name, std::vector<double>{speed});
+}
+
+s4u::Host* NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
+{
+  return kernel::actor::simcall(
+      [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 father_;
+  return create_host(name, std::vector<std::string>{speed});
 }
 
-void NetZone::getHosts(std::vector<s4u::Host*>* whereto)
+s4u::Host* NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
 {
-  for (auto const& card : vertices_) {
-    s4u::Host* host = simgrid::s4u::Host::by_name_or_null(card->get_name());
-    if (host != nullptr)
-      whereto->push_back(host);
+  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([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(std::string("Impossible to create split-duplex link: ") + name +
+                                std::string(". 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(
+      [this, &name, &bandwidth] { return pimpl_->create_split_duplex_link(name, std::vector<double>{bandwidth}); });
 }
 
-int NetZone::getHostCount()
+s4u::Link* NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidths)
 {
-  int count = 0;
-  for (auto const& card : vertices_) {
-    s4u::Host* host = simgrid::s4u::Host::by_name_or_null(card->get_name());
-    if (host != nullptr)
-      count++;
+  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(std::string("Impossible to create link: ") + name +
+                                  std::string(". Invalid bandwidth: ") + speed_str);
+    }
   }
-  return count;
+  return create_link(name, bw);
 }
 
-int NetZone::addComponent(kernel::routing::NetPoint* elm)
+kernel::routing::NetPoint* NetZone::create_router(const std::string& name)
 {
-  vertices_.push_back(elm);
-  return vertices_.size() - 1; // The rank of the newly created object
+  return kernel::actor::simcall([this, &name] { return pimpl_->create_router(name); });
 }
 
-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*/)
+kernel::routing::NetPoint* NetZone::get_netpoint()
 {
-  xbt_die("NetZone '%s' does not accept new routes (wrong class).", name_.c_str());
+  return pimpl_->get_netpoint();
 }
 
+kernel::resource::NetworkModelIntf* NetZone::get_network_model() const
+{
+  kernel::resource::NetworkModelIntf* model = pimpl_->get_network_model().get();
+  return model;
+}
 } // namespace s4u
 } // namespace simgrid
 
@@ -114,7 +250,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();
 }
@@ -124,28 +260,27 @@ 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->getChildren()) {
-    xbt_dict_set(whereto, elem->get_cname(), static_cast<void*>(elem), nullptr);
+  for (auto const& elem : netzone->get_children()) {
+    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->getProperty(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->setProperty(name, 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->getHosts(&hosts);
+  std::vector<simgrid::s4u::Host*> hosts = netzone->get_all_hosts();
   for (auto const& host : hosts)
     xbt_dynar_push(whereto, &host);
 }