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