src/s4u/s4u_Netzone.cpp

   1 /* Copyright (c) 2006-2023. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/Exception.hpp"
   7 #include "simgrid/s4u/Host.hpp"
   8 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
   9 #include <simgrid/s4u/Engine.hpp>
  10 #include <simgrid/s4u/NetZone.hpp>
  11 #include <simgrid/simix.hpp>
  12 #include <simgrid/zone.h>
  13 #include <xbt/parse_units.hpp>
  14
  15 #include "src/kernel/resource/NetworkModel.hpp"
  16
  17 namespace simgrid::s4u {
  18
  19 xbt::signal<void(NetZone const&)> NetZone::on_creation;
  20 xbt::signal<void(NetZone const&)> NetZone::on_seal;
  21
  22 const std::unordered_map<std::string, std::string>* NetZone::get_properties() const
  23 {
  24   return pimpl_->get_properties();
  25 }
  26
  27 /** Retrieve the property value (or nullptr if not set) */
  28 const char* NetZone::get_property(const std::string& key) const
  29 {
  30   return pimpl_->get_property(key);
  31 }
  32
  33 void NetZone::set_property(const std::string& key, const std::string& value)
  34 {
  35   kernel::actor::simcall_answered([this, &key, &value] { pimpl_->set_property(key, value); });
  36 }
  37
  38 /** @brief Returns the list of direct children (no grand-children) */
  39 std::vector<NetZone*> NetZone::get_children() const
  40 {
  41   std::vector<NetZone*> res;
  42   for (auto* child : pimpl_->get_children())
  43     res.push_back(child->get_iface());
  44   return res;
  45 }
  46
  47 const std::string& NetZone::get_name() const
  48 {
  49   return pimpl_->get_name();
  50 }
  51
  52 const char* NetZone::get_cname() const
  53 {
  54   return pimpl_->get_cname();
  55 }
  56
  57 NetZone* NetZone::get_parent() const
  58 {
  59   return pimpl_->get_parent()->get_iface();
  60 }
  61
  62 NetZone* NetZone::set_parent(const NetZone* parent)
  63 {
  64   kernel::actor::simcall_answered([this, parent] { pimpl_->set_parent(parent->get_impl()); });
  65   return this;
  66 }
  67
  68 /** @brief Returns the list of the hosts found in this NetZone (not recursively)
  69  *
  70  * Only the hosts that are directly contained in this NetZone are retrieved,
  71  * not the ones contained in sub-netzones.
  72  */
  73 std::vector<Host*> NetZone::get_all_hosts() const
  74 {
  75   return pimpl_->get_all_hosts();
  76 }
  77
  78 size_t NetZone::get_host_count() const
  79 {
  80   return pimpl_->get_host_count();
  81 }
  82
  83 unsigned long NetZone::add_component(kernel::routing::NetPoint* elm)
  84 {
  85   return pimpl_->add_component(elm);
  86 }
  87
  88 void NetZone::add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  89                         kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  90                         const std::vector<LinkInRoute>& link_list, bool symmetrical)
  91 {
  92   pimpl_->add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
  93 }
  94 void NetZone::add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  95                         kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  96                         const std::vector<const Link*>& links)
  97 {
  98   std::vector<LinkInRoute> links_direct;
  99   std::vector<LinkInRoute> links_reverse;
 100   for (auto* l : links) {
 101     links_direct.emplace_back(LinkInRoute(l, LinkInRoute::Direction::UP));
 102     links_reverse.emplace_back(LinkInRoute(l, LinkInRoute::Direction::DOWN));
 103   }
 104   pimpl_->add_route(src, dst, gw_src, gw_dst, links_direct, false);
 105   pimpl_->add_route(dst, src, gw_dst, gw_src, links_reverse, false);
 106 }
 107
 108 void NetZone::add_route(const Host* src, const Host* dst, const std::vector<LinkInRoute>& link_list, bool symmetrical)
 109 {
 110   pimpl_->add_route(src->get_netpoint(), dst->get_netpoint(), nullptr, nullptr, link_list, symmetrical);
 111 }
 112 void NetZone::add_route(const Host* src, const Host* dst, const std::vector<const Link*>& links)
 113 {
 114   std::vector<LinkInRoute> links_direct;
 115   std::vector<LinkInRoute> links_reverse;
 116   for (auto* l : links) {
 117     links_direct.emplace_back(LinkInRoute(l, LinkInRoute::Direction::UP));
 118     links_reverse.emplace_back(LinkInRoute(l, LinkInRoute::Direction::DOWN));
 119   }
 120   pimpl_->add_route(src->get_netpoint(), dst->get_netpoint(), nullptr, nullptr, links_direct, false);
 121   pimpl_->add_route(dst->get_netpoint(), src->get_netpoint(), nullptr, nullptr, links_reverse, false);
 122 }
 123
 124 void NetZone::add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
 125                                kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
 126                                const std::vector<LinkInRoute>& link_list)
 127 {
 128   pimpl_->add_bypass_route(src, dst, gw_src, gw_dst, link_list);
 129 }
 130
 131 void NetZone::extract_xbt_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
 132                                 std::map<std::string, xbt_edge_t, std::less<>>* edges)
 133 {
 134   for (auto const& child : get_children())
 135     child->extract_xbt_graph(graph, nodes, edges);
 136
 137   pimpl_->get_graph(graph, nodes, edges);
 138 }
 139
 140 NetZone* NetZone::seal()
 141 {
 142   kernel::actor::simcall_answered([this] { pimpl_->seal(); });
 143   return this;
 144 }
 145 void NetZone::set_latency_factor_cb(
 146     std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
 147                          const std::vector<s4u::Link*>& /*links*/,
 148                          const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const
 149 {
 150   kernel::actor::simcall_answered([this, &cb]() { pimpl_->get_network_model()->set_lat_factor_cb(cb); });
 151 }
 152 void NetZone::set_bandwidth_factor_cb(
 153     std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
 154                          const std::vector<s4u::Link*>& /*links*/,
 155                          const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const
 156 {
 157   kernel::actor::simcall_answered([this, &cb]() { pimpl_->get_network_model()->set_bw_factor_cb(cb); });
 158 }
 159
 160 s4u::Host* NetZone::create_host(const std::string& name, double speed)
 161 {
 162   return create_host(name, std::vector<double>{speed});
 163 }
 164
 165 s4u::Host* NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
 166 {
 167   return kernel::actor::simcall_answered(
 168       [this, &name, &speed_per_pstate] { return pimpl_->create_host(name, speed_per_pstate); });
 169 }
 170
 171 s4u::Host* NetZone::create_host(const std::string& name, const std::string& speed)
 172 {
 173   return create_host(name, std::vector<std::string>{speed});
 174 }
 175
 176 s4u::Host* NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
 177 {
 178   return create_host(name, Host::convert_pstate_speed_vector(speed_per_pstate));
 179 }
 180
 181 s4u::Link* NetZone::create_link(const std::string& name, double bandwidth)
 182 {
 183   return create_link(name, std::vector<double>{bandwidth});
 184 }
 185
 186 s4u::Link* NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
 187 {
 188   return kernel::actor::simcall_answered([this, &name, &bandwidths] { return pimpl_->create_link(name, bandwidths); });
 189 }
 190
 191 s4u::Link* NetZone::create_link(const std::string& name, const std::string& bandwidth)
 192 {
 193   return create_link(name, std::vector<std::string>{bandwidth});
 194 }
 195
 196 s4u::SplitDuplexLink* NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
 197 {
 198   double speed;
 199   try {
 200     speed = xbt_parse_get_bandwidth("", 0, bandwidth, "");
 201   } catch (const simgrid::ParseError&) {
 202     throw std::invalid_argument("Impossible to create split-duplex link: " + name +
 203                                 ". Invalid bandwidth: " + bandwidth);
 204   }
 205   return create_split_duplex_link(name, speed);
 206 }
 207
 208 s4u::SplitDuplexLink* NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
 209 {
 210   return kernel::actor::simcall_answered(
 211       [this, &name, &bandwidth] { return pimpl_->create_split_duplex_link(name, std::vector<double>{bandwidth}); });
 212 }
 213
 214 s4u::Link* NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidths)
 215 {
 216   std::vector<double> bw;
 217   bw.reserve(bandwidths.size());
 218   for (const auto& speed_str : bandwidths) {
 219     try {
 220       double speed = xbt_parse_get_bandwidth("", 0, speed_str, "");
 221       bw.push_back(speed);
 222     } catch (const simgrid::ParseError&) {
 223       throw std::invalid_argument("Impossible to create link: " + name + ". Invalid bandwidth: " + speed_str);
 224     }
 225   }
 226   return create_link(name, bw);
 227 }
 228
 229 kernel::routing::NetPoint* NetZone::create_router(const std::string& name)
 230 {
 231   return kernel::actor::simcall_answered([this, &name] { return pimpl_->create_router(name); });
 232 }
 233
 234 kernel::routing::NetPoint* NetZone::get_netpoint()
 235 {
 236   return pimpl_->get_netpoint();
 237 }
 238
 239 kernel::resource::NetworkModel* NetZone::get_network_model() const
 240 {
 241   return pimpl_->get_network_model().get();
 242 }
 243 } // namespace simgrid::s4u
 244
 245 /* **************************** Public C interface *************************** */
 246
 247 sg_netzone_t sg_zone_get_root()
 248 {
 249   return simgrid::s4u::Engine::get_instance()->get_netzone_root();
 250 }
 251
 252 const char* sg_zone_get_name(const_sg_netzone_t netzone)
 253 {
 254   return netzone->get_cname();
 255 }
 256
 257 sg_netzone_t sg_zone_get_by_name(const char* name)
 258 {
 259   return simgrid::s4u::Engine::get_instance()->netzone_by_name_or_null(name);
 260 }
 261
 262 void sg_zone_get_sons(const_sg_netzone_t netzone, xbt_dict_t whereto)
 263 {
 264   for (auto const& elem : netzone->get_children()) {
 265     xbt_dict_set(whereto, elem->get_cname(), elem);
 266   }
 267 }
 268
 269 const char* sg_zone_get_property_value(const_sg_netzone_t netzone, const char* name)
 270 {
 271   return netzone->get_property(name);
 272 }
 273
 274 void sg_zone_set_property_value(sg_netzone_t netzone, const char* name, const char* value)
 275 {
 276   netzone->set_property(name, value);
 277 }
 278
 279 void sg_zone_get_hosts(const_sg_netzone_t netzone, xbt_dynar_t whereto)
 280 {
 281   /* converts vector to dynar */
 282   std::vector<simgrid::s4u::Host*> hosts = netzone->get_all_hosts();
 283   for (auto const& host : hosts)
 284     xbt_dynar_push(whereto, &host);
 285 }