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(const NetZone* src, const NetZone* dst, const std::vector<const Link*>& links)
  89 {
  90   std::vector<LinkInRoute> links_direct;
  91   std::vector<LinkInRoute> links_reverse;
  92   for (auto* l : links) {
  93     links_direct.emplace_back(LinkInRoute(l, LinkInRoute::Direction::UP));
  94     links_reverse.emplace_back(LinkInRoute(l, LinkInRoute::Direction::DOWN));
  95   }
  96   pimpl_->add_route(src ? src->get_netpoint() : nullptr, dst ? dst->get_netpoint(): nullptr,
  97                     src ? src->get_gateway() : nullptr, dst ? dst->get_gateway() : nullptr,
  98                     links_direct, false);
  99   pimpl_->add_route(dst ? dst->get_netpoint(): nullptr, src ? src->get_netpoint() : nullptr,
 100                     dst ? dst->get_gateway() : nullptr, src ? src->get_gateway() : nullptr,
 101                     links_reverse, false);
 102 }
 103
 104 void NetZone::add_route(const NetZone* src, const NetZone* dst, const std::vector<LinkInRoute>& link_list, bool symmetrical)
 105 {
 106   pimpl_->add_route(src ? src->get_netpoint() : nullptr, dst ? dst->get_netpoint(): nullptr,
 107                     src ? src->get_gateway() : nullptr, dst ? dst->get_gateway() : nullptr,
 108                     link_list, symmetrical);
 109 }
 110
 111 void NetZone::add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
 112                         kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
 113                         const std::vector<LinkInRoute>& link_list, bool symmetrical) //XBT_ATTRIB_DEPRECATED_v339
 114 {
 115   pimpl_->add_route(src, dst, gw_src, gw_dst, link_list, symmetrical);
 116 }
 117
 118 void NetZone::add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
 119                         kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
 120                         const std::vector<const Link*>& links) //XBT_ATTRIB_DEPRECATED_v339
 121 {
 122   std::vector<LinkInRoute> links_direct;
 123   std::vector<LinkInRoute> links_reverse;
 124   for (auto* l : links) {
 125     links_direct.emplace_back(LinkInRoute(l, LinkInRoute::Direction::UP));
 126     links_reverse.emplace_back(LinkInRoute(l, LinkInRoute::Direction::DOWN));
 127   }
 128   pimpl_->add_route(src, dst, gw_src, gw_dst, links_direct, false);
 129   pimpl_->add_route(dst, src, gw_dst, gw_src, links_reverse, false);
 130 }
 131
 132 void NetZone::add_route(const Host* src, const Host* dst, const std::vector<LinkInRoute>& link_list, bool symmetrical)
 133 {
 134   pimpl_->add_route(src ? src->get_netpoint(): nullptr, dst ? dst->get_netpoint(): nullptr, nullptr, nullptr,
 135                     link_list, symmetrical);
 136
 137 }
 138
 139 void NetZone::add_route(const Host* src, const Host* dst, const std::vector<const Link*>& links)
 140 {
 141   std::vector<LinkInRoute> links_direct;
 142   std::vector<LinkInRoute> links_reverse;
 143   for (auto* l : links) {
 144     links_direct.emplace_back(LinkInRoute(l, LinkInRoute::Direction::UP));
 145     links_reverse.emplace_back(LinkInRoute(l, LinkInRoute::Direction::DOWN));
 146   }
 147   pimpl_->add_route(src ? src->get_netpoint(): nullptr, dst ? dst->get_netpoint(): nullptr, nullptr, nullptr,
 148                     links_direct, false);
 149   pimpl_->add_route(dst ? dst->get_netpoint(): nullptr, src ? src->get_netpoint(): nullptr, nullptr, nullptr,
 150                     links_reverse, false);
 151 }
 152
 153 void NetZone::add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
 154                                kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
 155                                const std::vector<LinkInRoute>& link_list)
 156 {
 157   pimpl_->add_bypass_route(src, dst, gw_src, gw_dst, link_list);
 158 }
 159
 160 void NetZone::extract_xbt_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
 161                                 std::map<std::string, xbt_edge_t, std::less<>>* edges)
 162 {
 163   for (auto const& child : get_children())
 164     child->extract_xbt_graph(graph, nodes, edges);
 165
 166   pimpl_->get_graph(graph, nodes, edges);
 167 }
 168
 169 NetZone* NetZone::seal()
 170 {
 171   kernel::actor::simcall_answered([this] { pimpl_->seal(); });
 172   return this;
 173 }
 174 void NetZone::set_latency_factor_cb(
 175     std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
 176                          const std::vector<s4u::Link*>& /*links*/,
 177                          const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const
 178 {
 179   kernel::actor::simcall_answered([this, &cb]() { pimpl_->get_network_model()->set_lat_factor_cb(cb); });
 180 }
 181 void NetZone::set_bandwidth_factor_cb(
 182     std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
 183                          const std::vector<s4u::Link*>& /*links*/,
 184                          const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const
 185 {
 186   kernel::actor::simcall_answered([this, &cb]() { pimpl_->get_network_model()->set_bw_factor_cb(cb); });
 187 }
 188
 189 s4u::Host* NetZone::create_host(const std::string& name, double speed)
 190 {
 191   return create_host(name, std::vector<double>{speed});
 192 }
 193
 194 s4u::Host* NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
 195 {
 196   return kernel::actor::simcall_answered(
 197       [this, &name, &speed_per_pstate] { return pimpl_->create_host(name, speed_per_pstate); });
 198 }
 199
 200 s4u::Host* NetZone::create_host(const std::string& name, const std::string& speed)
 201 {
 202   return create_host(name, std::vector<std::string>{speed});
 203 }
 204
 205 s4u::Host* NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
 206 {
 207   return create_host(name, Host::convert_pstate_speed_vector(speed_per_pstate));
 208 }
 209
 210 s4u::Link* NetZone::create_link(const std::string& name, double bandwidth)
 211 {
 212   return create_link(name, std::vector<double>{bandwidth});
 213 }
 214
 215 s4u::Link* NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
 216 {
 217   return kernel::actor::simcall_answered([this, &name, &bandwidths] { return pimpl_->create_link(name, bandwidths); });
 218 }
 219
 220 s4u::Link* NetZone::create_link(const std::string& name, const std::string& bandwidth)
 221 {
 222   return create_link(name, std::vector<std::string>{bandwidth});
 223 }
 224
 225 s4u::SplitDuplexLink* NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
 226 {
 227   double speed;
 228   try {
 229     speed = xbt_parse_get_bandwidth("", 0, bandwidth, "");
 230   } catch (const simgrid::ParseError&) {
 231     throw std::invalid_argument("Impossible to create split-duplex link: " + name +
 232                                 ". Invalid bandwidth: " + bandwidth);
 233   }
 234   return create_split_duplex_link(name, speed);
 235 }
 236
 237 s4u::SplitDuplexLink* NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
 238 {
 239   return kernel::actor::simcall_answered(
 240       [this, &name, &bandwidth] { return pimpl_->create_split_duplex_link(name, std::vector<double>{bandwidth}); });
 241 }
 242
 243 s4u::Link* NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidths)
 244 {
 245   std::vector<double> bw;
 246   bw.reserve(bandwidths.size());
 247   for (const auto& speed_str : bandwidths) {
 248     try {
 249       double speed = xbt_parse_get_bandwidth("", 0, speed_str, "");
 250       bw.push_back(speed);
 251     } catch (const simgrid::ParseError&) {
 252       throw std::invalid_argument("Impossible to create link: " + name + ". Invalid bandwidth: " + speed_str);
 253     }
 254   }
 255   return create_link(name, bw);
 256 }
 257
 258 kernel::routing::NetPoint* NetZone::create_router(const std::string& name)
 259 {
 260   return kernel::actor::simcall_answered([this, &name] { return pimpl_->create_router(name); });
 261 }
 262
 263 kernel::routing::NetPoint* NetZone::get_netpoint() const
 264 {
 265   return pimpl_->get_netpoint();
 266 }
 267
 268 kernel::routing::NetPoint* NetZone::get_gateway() const
 269 {
 270   return pimpl_->get_gateway();
 271 }
 272
 273 kernel::routing::NetPoint* NetZone::get_gateway(const std::string& name) const
 274 {
 275   return pimpl_->get_gateway(name);
 276 }
 277
 278 void NetZone::set_gateway(kernel::routing::NetPoint* router)
 279 {
 280   set_gateway("default", router);
 281 }
 282
 283 void NetZone::set_gateway(const std::string& name, kernel::routing::NetPoint* router)
 284 {
 285   kernel::actor::simcall_answered([this, name, router] { pimpl_->set_gateway(name, router); });
 286 }
 287
 288 kernel::resource::NetworkModel* NetZone::get_network_model() const
 289 {
 290   return pimpl_->get_network_model().get();
 291 }
 292 } // namespace simgrid::s4u
 293
 294 /* **************************** Public C interface *************************** */
 295
 296 sg_netzone_t sg_zone_get_root()
 297 {
 298   return simgrid::s4u::Engine::get_instance()->get_netzone_root();
 299 }
 300
 301 const char* sg_zone_get_name(const_sg_netzone_t netzone)
 302 {
 303   return netzone->get_cname();
 304 }
 305
 306 sg_netzone_t sg_zone_get_by_name(const char* name)
 307 {
 308   return simgrid::s4u::Engine::get_instance()->netzone_by_name_or_null(name);
 309 }
 310
 311 void sg_zone_get_sons(const_sg_netzone_t netzone, xbt_dict_t whereto)
 312 {
 313   for (auto const& elem : netzone->get_children()) {
 314     xbt_dict_set(whereto, elem->get_cname(), elem);
 315   }
 316 }
 317
 318 const char* sg_zone_get_property_value(const_sg_netzone_t netzone, const char* name)
 319 {
 320   return netzone->get_property(name);
 321 }
 322
 323 void sg_zone_set_property_value(sg_netzone_t netzone, const char* name, const char* value)
 324 {
 325   netzone->set_property(name, value);
 326 }
 327
 328 void sg_zone_get_hosts(const_sg_netzone_t netzone, xbt_dynar_t whereto)
 329 {
 330   /* converts vector to dynar */
 331   std::vector<simgrid::s4u::Host*> hosts = netzone->get_all_hosts();
 332   for (auto const& host : hosts)
 333     xbt_dynar_push(whereto, &host);
 334 }