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
  95 void NetZone::add_route(const Host* src, const Host* dst, const std::vector<LinkInRoute>& link_list, bool symmetrical)
  96 {
  97   pimpl_->add_route(src->get_netpoint(), dst->get_netpoint(), nullptr, nullptr, link_list, symmetrical);
  98 }
  99
 100 void NetZone::add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
 101                                kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
 102                                const std::vector<LinkInRoute>& link_list)
 103 {
 104   pimpl_->add_bypass_route(src, dst, gw_src, gw_dst, link_list);
 105 }
 106
 107 void NetZone::extract_xbt_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
 108                                 std::map<std::string, xbt_edge_t, std::less<>>* edges)
 109 {
 110   for (auto const& child : get_children())
 111     child->extract_xbt_graph(graph, nodes, edges);
 112
 113   pimpl_->get_graph(graph, nodes, edges);
 114 }
 115
 116 NetZone* NetZone::seal()
 117 {
 118   kernel::actor::simcall_answered([this] { pimpl_->seal(); });
 119   return this;
 120 }
 121 void NetZone::set_latency_factor_cb(
 122     std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
 123                          const std::vector<s4u::Link*>& /*links*/,
 124                          const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const
 125 {
 126   kernel::actor::simcall_answered([this, &cb]() { pimpl_->get_network_model()->set_lat_factor_cb(cb); });
 127 }
 128 void NetZone::set_bandwidth_factor_cb(
 129     std::function<double(double size, const s4u::Host* src, const s4u::Host* dst,
 130                          const std::vector<s4u::Link*>& /*links*/,
 131                          const std::unordered_set<s4u::NetZone*>& /*netzones*/)> const& cb) const
 132 {
 133   kernel::actor::simcall_answered([this, &cb]() { pimpl_->get_network_model()->set_bw_factor_cb(cb); });
 134 }
 135
 136 s4u::Host* NetZone::create_host(const std::string& name, double speed)
 137 {
 138   return create_host(name, std::vector<double>{speed});
 139 }
 140
 141 s4u::Host* NetZone::create_host(const std::string& name, const std::vector<double>& speed_per_pstate)
 142 {
 143   return kernel::actor::simcall_answered(
 144       [this, &name, &speed_per_pstate] { return pimpl_->create_host(name, speed_per_pstate); });
 145 }
 146
 147 s4u::Host* NetZone::create_host(const std::string& name, const std::string& speed)
 148 {
 149   return create_host(name, std::vector<std::string>{speed});
 150 }
 151
 152 s4u::Host* NetZone::create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate)
 153 {
 154   return create_host(name, Host::convert_pstate_speed_vector(speed_per_pstate));
 155 }
 156
 157 s4u::Link* NetZone::create_link(const std::string& name, double bandwidth)
 158 {
 159   return create_link(name, std::vector<double>{bandwidth});
 160 }
 161
 162 s4u::Link* NetZone::create_link(const std::string& name, const std::vector<double>& bandwidths)
 163 {
 164   return kernel::actor::simcall_answered([this, &name, &bandwidths] { return pimpl_->create_link(name, bandwidths); });
 165 }
 166
 167 s4u::Link* NetZone::create_link(const std::string& name, const std::string& bandwidth)
 168 {
 169   return create_link(name, std::vector<std::string>{bandwidth});
 170 }
 171
 172 s4u::SplitDuplexLink* NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth)
 173 {
 174   double speed;
 175   try {
 176     speed = xbt_parse_get_bandwidth("", 0, bandwidth, "");
 177   } catch (const simgrid::ParseError&) {
 178     throw std::invalid_argument("Impossible to create split-duplex link: " + name +
 179                                 ". Invalid bandwidth: " + bandwidth);
 180   }
 181   return create_split_duplex_link(name, speed);
 182 }
 183
 184 s4u::SplitDuplexLink* NetZone::create_split_duplex_link(const std::string& name, double bandwidth)
 185 {
 186   return kernel::actor::simcall_answered(
 187       [this, &name, &bandwidth] { return pimpl_->create_split_duplex_link(name, std::vector<double>{bandwidth}); });
 188 }
 189
 190 s4u::Link* NetZone::create_link(const std::string& name, const std::vector<std::string>& bandwidths)
 191 {
 192   std::vector<double> bw;
 193   bw.reserve(bandwidths.size());
 194   for (const auto& speed_str : bandwidths) {
 195     try {
 196       double speed = xbt_parse_get_bandwidth("", 0, speed_str, "");
 197       bw.push_back(speed);
 198     } catch (const simgrid::ParseError&) {
 199       throw std::invalid_argument("Impossible to create link: " + name + ". Invalid bandwidth: " + speed_str);
 200     }
 201   }
 202   return create_link(name, bw);
 203 }
 204
 205 kernel::routing::NetPoint* NetZone::create_router(const std::string& name)
 206 {
 207   return kernel::actor::simcall_answered([this, &name] { return pimpl_->create_router(name); });
 208 }
 209
 210 kernel::routing::NetPoint* NetZone::get_netpoint()
 211 {
 212   return pimpl_->get_netpoint();
 213 }
 214
 215 kernel::resource::NetworkModel* NetZone::get_network_model() const
 216 {
 217   return pimpl_->get_network_model().get();
 218 }
 219 } // namespace simgrid::s4u
 220
 221 /* **************************** Public C interface *************************** */
 222
 223 sg_netzone_t sg_zone_get_root()
 224 {
 225   return simgrid::s4u::Engine::get_instance()->get_netzone_root();
 226 }
 227
 228 const char* sg_zone_get_name(const_sg_netzone_t netzone)
 229 {
 230   return netzone->get_cname();
 231 }
 232
 233 sg_netzone_t sg_zone_get_by_name(const char* name)
 234 {
 235   return simgrid::s4u::Engine::get_instance()->netzone_by_name_or_null(name);
 236 }
 237
 238 void sg_zone_get_sons(const_sg_netzone_t netzone, xbt_dict_t whereto)
 239 {
 240   for (auto const& elem : netzone->get_children()) {
 241     xbt_dict_set(whereto, elem->get_cname(), elem);
 242   }
 243 }
 244
 245 const char* sg_zone_get_property_value(const_sg_netzone_t netzone, const char* name)
 246 {
 247   return netzone->get_property(name);
 248 }
 249
 250 void sg_zone_set_property_value(sg_netzone_t netzone, const char* name, const char* value)
 251 {
 252   netzone->set_property(name, value);
 253 }
 254
 255 void sg_zone_get_hosts(const_sg_netzone_t netzone, xbt_dynar_t whereto)
 256 {
 257   /* converts vector to dynar */
 258   std::vector<simgrid::s4u::Host*> hosts = netzone->get_all_hosts();
 259   for (auto const& host : hosts)
 260     xbt_dynar_push(whereto, &host);
 261 }