src/s4u/s4u_Netzone.cpp

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