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/kernel/lmm/maxmin.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 Link* Link::by_name_or_null(const std::string& name)
  39 {
  40   return Engine::get_instance()->link_by_name_or_null(name);
  41 }
  42
  43 const std::string& Link::get_name() const
  44 {
  45   return this->pimpl_->get_name();
  46 }
  47 const char* Link::get_cname() const
  48 {
  49   return this->pimpl_->get_cname();
  50 }
  51 bool Link::is_used() const
  52 {
  53   return this->pimpl_->is_used();
  54 }
  55
  56 bool Link::is_shared() const
  57 {
  58   return this->pimpl_->get_sharing_policy() != SharingPolicy::FATPIPE;
  59 }
  60
  61 double Link::get_latency() const
  62 {
  63   return this->pimpl_->get_latency();
  64 }
  65
  66 Link* Link::set_latency(double value)
  67 {
  68   kernel::actor::simcall([this, value] { pimpl_->set_latency(value); });
  69   return this;
  70 }
  71
  72 Link* Link::set_latency(const std::string& value)
  73 {
  74   double d_value = 0.0;
  75   try {
  76     d_value = xbt_parse_get_time("", 0, value.c_str(), nullptr, "");
  77   } catch (const simgrid::ParseError&) {
  78     throw std::invalid_argument(std::string("Impossible to set latency for link: ") + get_name() +
  79                                 std::string(". Invalid value: ") + value);
  80   }
  81   return set_latency(d_value);
  82 }
  83
  84 double Link::get_bandwidth() const
  85 {
  86   return this->pimpl_->get_bandwidth();
  87 }
  88
  89 Link* Link::set_bandwidth(double value)
  90 {
  91   kernel::actor::simcall([this, value] { pimpl_->set_bandwidth(value); });
  92   return this;
  93 }
  94
  95 Link::SharingPolicy Link::get_sharing_policy() const
  96 {
  97   return this->pimpl_->get_sharing_policy();
  98 }
  99
 100 void Link::set_host_wifi_rate(const s4u::Host* host, int level) const
 101 {
 102   xbt_assert(pimpl_->get_sharing_policy() == Link::SharingPolicy::WIFI, "Link %s does not seem to be a wifi link.",
 103              get_cname());
 104   auto* wlink = dynamic_cast<kernel::resource::NetworkWifiLink*>(pimpl_);
 105   xbt_assert(wlink != nullptr, "Cannot convert link %s into a wifi link.", get_cname());
 106   wlink->set_host_rate(host, level);
 107 }
 108
 109 double Link::get_usage() const
 110 {
 111   return this->pimpl_->get_constraint()->get_usage();
 112 }
 113
 114 void Link::turn_on()
 115 {
 116   kernel::actor::simcall([this]() { this->pimpl_->turn_on(); });
 117 }
 118 void Link::turn_off()
 119 {
 120   kernel::actor::simcall([this]() { this->pimpl_->turn_off(); });
 121 }
 122 void Link::seal()
 123 {
 124   kernel::actor::simcall([this]() { this->pimpl_->seal(); });
 125 }
 126
 127 bool Link::is_on() const
 128 {
 129   return this->pimpl_->is_on();
 130 }
 131
 132 Link* Link::set_state_profile(kernel::profile::Profile* profile)
 133 {
 134   xbt_assert(not pimpl_->is_sealed(), "Cannot set a state profile once the Link is sealed");
 135   kernel::actor::simcall([this, profile]() { this->pimpl_->set_state_profile(profile); });
 136   return this;
 137 }
 138
 139 Link* Link::set_bandwidth_profile(kernel::profile::Profile* profile)
 140 {
 141   xbt_assert(not pimpl_->is_sealed(), "Cannot set a bandwidth profile once the Link is sealed");
 142   kernel::actor::simcall([this, profile]() { this->pimpl_->set_bandwidth_profile(profile); });
 143   return this;
 144 }
 145
 146 Link* Link::set_latency_profile(kernel::profile::Profile* profile)
 147 {
 148   xbt_assert(not pimpl_->is_sealed(), "Cannot set a latency profile once the Link is sealed");
 149   kernel::actor::simcall([this, profile]() { this->pimpl_->set_latency_profile(profile); });
 150   return this;
 151 }
 152
 153 const char* Link::get_property(const std::string& key) const
 154 {
 155   return this->pimpl_->get_property(key);
 156 }
 157 Link* Link::set_property(const std::string& key, const std::string& value)
 158 {
 159   kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
 160   return this;
 161 }
 162
 163 const std::unordered_map<std::string, std::string>* Link::get_properties() const
 164 {
 165   return this->pimpl_->get_properties();
 166 }
 167
 168 Link* Link::set_properties(const std::unordered_map<std::string, std::string>& properties)
 169 {
 170   kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
 171   return this;
 172 }
 173
 174 } // namespace s4u
 175 } // namespace simgrid
 176
 177 /* **************************** Public C interface *************************** */
 178
 179 const char* sg_link_get_name(const_sg_link_t link)
 180 {
 181   return link->get_cname();
 182 }
 183
 184 const char* sg_link_name(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
 185 {
 186   return sg_link_get_name(link);
 187 }
 188
 189 sg_link_t sg_link_by_name(const char* name)
 190 {
 191   return simgrid::s4u::Link::by_name(name);
 192 }
 193
 194 int sg_link_is_shared(const_sg_link_t link)
 195 {
 196   return link->is_shared();
 197 }
 198
 199 double sg_link_get_bandwidth(const_sg_link_t link)
 200 {
 201   return link->get_bandwidth();
 202 }
 203
 204 void sg_link_set_bandwidth(sg_link_t link, double value)
 205 {
 206   link->set_bandwidth(value);
 207 }
 208
 209 double sg_link_bandwidth(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
 210 {
 211   return sg_link_get_bandwidth(link);
 212 }
 213
 214 void sg_link_bandwidth_set(sg_link_t link, double value) // XBT_ATTRIB_DEPRECATED_v330
 215 {
 216   sg_link_set_bandwidth(link, value);
 217 }
 218
 219 double sg_link_get_latency(const_sg_link_t link)
 220 {
 221   return link->get_latency();
 222 }
 223
 224 void sg_link_set_latency(sg_link_t link, double value)
 225 {
 226   link->set_latency(value);
 227 }
 228
 229 double sg_link_latency(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
 230 {
 231   return sg_link_get_latency(link);
 232 }
 233
 234 void sg_link_latency_set(sg_link_t link, double value) // XBT_ATTRIB_DEPRECATED_v330
 235 {
 236   sg_link_set_latency(link, value);
 237 }
 238
 239 void* sg_link_get_data(const_sg_link_t link)
 240 {
 241   return link->get_data();
 242 }
 243
 244 void sg_link_set_data(sg_link_t link, void* data)
 245 {
 246   link->set_data(data);
 247 }
 248
 249 void* sg_link_data(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
 250 {
 251   return sg_link_get_data(link);
 252 }
 253
 254 void sg_link_data_set(sg_link_t link, void* data) // XBT_ATTRIB_DEPRECATED_v330
 255 {
 256   sg_link_set_data(link, data);
 257 }
 258
 259 int sg_link_count()
 260 {
 261   return simgrid::s4u::Engine::get_instance()->get_link_count();
 262 }
 263
 264 sg_link_t* sg_link_list()
 265 {
 266   std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
 267
 268   sg_link_t* res = xbt_new(sg_link_t, links.size());
 269   memcpy(res, links.data(), sizeof(sg_link_t) * links.size());
 270
 271   return res;
 272 }