src/s4u/s4u_Link.cpp

   1 /* Copyright (c) 2013-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 <algorithm>
   7
   8 #include "simgrid/Exception.hpp"
   9 #include "simgrid/s4u/Engine.hpp"
  10 #include "simgrid/s4u/Link.hpp"
  11 #include "simgrid/sg_config.hpp"
  12 #include "simgrid/simix.hpp"
  13 #include "src/surf/SplitDuplexLinkImpl.hpp"
  14 #include "src/surf/network_interface.hpp"
  15 #include "src/surf/network_wifi.hpp"
  16 #include "xbt/log.h"
  17 #include "xbt/parse_units.hpp"
  18
  19 namespace simgrid {
  20
  21 template class xbt::Extendable<s4u::Link>;
  22
  23 namespace s4u {
  24
  25 xbt::signal<void(Link&)> Link::on_creation;
  26 xbt::signal<void(Link const&)> Link::on_destruction;
  27 xbt::signal<void(Link const&)> Link::on_state_change;
  28 xbt::signal<void(Link const&)> Link::on_bandwidth_change;
  29 xbt::signal<void(kernel::resource::NetworkAction&)> Link::on_communicate;
  30 xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
  31     Link::on_communication_state_change;
  32
  33 Link* Link::by_name(const std::string& name)
  34 {
  35   return Engine::get_instance()->link_by_name(name);
  36 }
  37
  38 kernel::resource::LinkImpl* Link::get_impl() const
  39 {
  40   xbt_assert(
  41       get_sharing_policy() != SharingPolicy::SPLITDUPLEX,
  42       "Impossible to get a LinkImpl* from a Split-Duplex link. You should call this method to each UP/DOWN member");
  43   return dynamic_cast<kernel::resource::LinkImpl*>(pimpl_);
  44 }
  45
  46 Link* Link::by_name_or_null(const std::string& name)
  47 {
  48   return Engine::get_instance()->link_by_name_or_null(name);
  49 }
  50
  51 const std::string& Link::get_name() const
  52 {
  53   return this->pimpl_->get_name();
  54 }
  55 const char* Link::get_cname() const
  56 {
  57   return this->pimpl_->get_cname();
  58 }
  59 bool Link::is_used() const
  60 {
  61   return this->pimpl_->is_used();
  62 }
  63
  64 bool Link::is_shared() const
  65 {
  66   return this->pimpl_->get_sharing_policy() != SharingPolicy::FATPIPE;
  67 }
  68
  69 double Link::get_latency() const
  70 {
  71   return this->pimpl_->get_latency();
  72 }
  73
  74 Link* Link::set_latency(double value)
  75 {
  76   kernel::actor::simcall([this, value] { pimpl_->set_latency(value); });
  77   return this;
  78 }
  79
  80 Link* Link::set_latency(const std::string& value)
  81 {
  82   double d_value = 0.0;
  83   try {
  84     d_value = xbt_parse_get_time("", 0, value, "");
  85   } catch (const simgrid::ParseError&) {
  86     throw std::invalid_argument(std::string("Impossible to set latency for link: ") + get_name() +
  87                                 std::string(". Invalid value: ") + value);
  88   }
  89   return set_latency(d_value);
  90 }
  91
  92 double Link::get_bandwidth() const
  93 {
  94   return this->pimpl_->get_bandwidth();
  95 }
  96
  97 Link* Link::set_bandwidth(double value)
  98 {
  99   kernel::actor::simcall([this, value] { pimpl_->set_bandwidth(value); });
 100   return this;
 101 }
 102
 103 Link* Link::set_sharing_policy(Link::SharingPolicy policy)
 104 {
 105   if (policy == SharingPolicy::SPLITDUPLEX)
 106     throw std::invalid_argument(std::string("Impossible to set split-duplex for the link: ") + get_name() +
 107                                 std::string(". Use NetZone::create_split_duplex_link."));
 108
 109   kernel::actor::simcall([this, policy] { pimpl_->set_sharing_policy(policy); });
 110   return this;
 111 }
 112 Link::SharingPolicy Link::get_sharing_policy() const
 113 {
 114   return this->pimpl_->get_sharing_policy();
 115 }
 116
 117 void Link::set_host_wifi_rate(const s4u::Host* host, int level) const
 118 {
 119   auto* wlink = dynamic_cast<kernel::resource::NetworkWifiLink*>(pimpl_);
 120   xbt_assert(wlink != nullptr, "Link %s does not seem to be a wifi link.", get_cname());
 121   wlink->set_host_rate(host, level);
 122 }
 123
 124 Link* Link::set_concurrency_limit(int limit)
 125 {
 126   kernel::actor::simcall([this, limit] { pimpl_->set_concurrency_limit(limit); });
 127   return this;
 128 }
 129
 130 double Link::get_usage() const
 131 {
 132   return this->pimpl_->get_constraint()->get_usage();
 133 }
 134
 135 void Link::turn_on()
 136 {
 137   kernel::actor::simcall([this]() { this->pimpl_->turn_on(); });
 138 }
 139 void Link::turn_off()
 140 {
 141   kernel::actor::simcall([this]() { this->pimpl_->turn_off(); });
 142 }
 143 Link* Link::seal()
 144 {
 145   kernel::actor::simcall([this]() { this->pimpl_->seal(); });
 146   return this;
 147 }
 148
 149 bool Link::is_on() const
 150 {
 151   return this->pimpl_->is_on();
 152 }
 153
 154 Link* Link::set_state_profile(kernel::profile::Profile* profile)
 155 {
 156   xbt_assert(not pimpl_->is_sealed(), "Cannot set a state profile once the Link is sealed");
 157   kernel::actor::simcall([this, profile]() { this->pimpl_->set_state_profile(profile); });
 158   return this;
 159 }
 160
 161 Link* Link::set_bandwidth_profile(kernel::profile::Profile* profile)
 162 {
 163   xbt_assert(not pimpl_->is_sealed(), "Cannot set a bandwidth profile once the Link is sealed");
 164   kernel::actor::simcall([this, profile]() { this->pimpl_->set_bandwidth_profile(profile); });
 165   return this;
 166 }
 167
 168 Link* Link::set_latency_profile(kernel::profile::Profile* profile)
 169 {
 170   xbt_assert(not pimpl_->is_sealed(), "Cannot set a latency profile once the Link is sealed");
 171   kernel::actor::simcall([this, profile]() { this->pimpl_->set_latency_profile(profile); });
 172   return this;
 173 }
 174
 175 const char* Link::get_property(const std::string& key) const
 176 {
 177   return this->pimpl_->get_property(key);
 178 }
 179 Link* Link::set_property(const std::string& key, const std::string& value)
 180 {
 181   kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
 182   return this;
 183 }
 184
 185 const std::unordered_map<std::string, std::string>* Link::get_properties() const
 186 {
 187   return this->pimpl_->get_properties();
 188 }
 189
 190 Link* Link::set_properties(const std::unordered_map<std::string, std::string>& properties)
 191 {
 192   kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
 193   return this;
 194 }
 195
 196 Link* SplitDuplexLink::get_link_up() const
 197 {
 198   return dynamic_cast<kernel::resource::SplitDuplexLinkImpl*>(pimpl_)->get_link_up();
 199 }
 200
 201 Link* SplitDuplexLink::get_link_down() const
 202 {
 203   return dynamic_cast<kernel::resource::SplitDuplexLinkImpl*>(pimpl_)->get_link_down();
 204 }
 205
 206 SplitDuplexLink* SplitDuplexLink::by_name(const std::string& name)
 207 {
 208   return Engine::get_instance()->split_duplex_link_by_name(name);
 209 }
 210
 211 } // namespace s4u
 212 } // namespace simgrid
 213
 214 /* **************************** Public C interface *************************** */
 215
 216 const char* sg_link_get_name(const_sg_link_t link)
 217 {
 218   return link->get_cname();
 219 }
 220
 221 const char* sg_link_name(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
 222 {
 223   return sg_link_get_name(link);
 224 }
 225
 226 sg_link_t sg_link_by_name(const char* name)
 227 {
 228   return simgrid::s4u::Link::by_name(name);
 229 }
 230
 231 int sg_link_is_shared(const_sg_link_t link)
 232 {
 233   return link->is_shared();
 234 }
 235
 236 double sg_link_get_bandwidth(const_sg_link_t link)
 237 {
 238   return link->get_bandwidth();
 239 }
 240
 241 void sg_link_set_bandwidth(sg_link_t link, double value)
 242 {
 243   link->set_bandwidth(value);
 244 }
 245
 246 double sg_link_bandwidth(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
 247 {
 248   return sg_link_get_bandwidth(link);
 249 }
 250
 251 void sg_link_bandwidth_set(sg_link_t link, double value) // XBT_ATTRIB_DEPRECATED_v330
 252 {
 253   sg_link_set_bandwidth(link, value);
 254 }
 255
 256 double sg_link_get_latency(const_sg_link_t link)
 257 {
 258   return link->get_latency();
 259 }
 260
 261 void sg_link_set_latency(sg_link_t link, double value)
 262 {
 263   link->set_latency(value);
 264 }
 265
 266 double sg_link_latency(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
 267 {
 268   return sg_link_get_latency(link);
 269 }
 270
 271 void sg_link_latency_set(sg_link_t link, double value) // XBT_ATTRIB_DEPRECATED_v330
 272 {
 273   sg_link_set_latency(link, value);
 274 }
 275
 276 void* sg_link_get_data(const_sg_link_t link)
 277 {
 278   return link->get_data();
 279 }
 280
 281 void sg_link_set_data(sg_link_t link, void* data)
 282 {
 283   link->set_data(data);
 284 }
 285
 286 void* sg_link_data(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
 287 {
 288   return sg_link_get_data(link);
 289 }
 290
 291 void sg_link_data_set(sg_link_t link, void* data) // XBT_ATTRIB_DEPRECATED_v330
 292 {
 293   sg_link_set_data(link, data);
 294 }
 295
 296 size_t sg_link_count()
 297 {
 298   return simgrid::s4u::Engine::get_instance()->get_link_count();
 299 }
 300
 301 sg_link_t* sg_link_list()
 302 {
 303   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
 304
 305   auto* res = xbt_new(sg_link_t, links.size());
 306   std::copy(begin(links), end(links), res);
 307
 308   return res;
 309 }