1 /* Copyright (c) 2013-2021. The SimGrid Team. All rights reserved. */
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. */
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"
17 #include "xbt/parse_units.hpp"
21 template class xbt::Extendable<s4u::Link>;
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;
33 Link* Link::by_name(const std::string& name)
35 return Engine::get_instance()->link_by_name(name);
38 Link* Link::by_name_or_null(const std::string& name)
40 return Engine::get_instance()->link_by_name_or_null(name);
43 const std::string& Link::get_name() const
45 return this->pimpl_->get_name();
47 const char* Link::get_cname() const
49 return this->pimpl_->get_cname();
51 bool Link::is_used() const
53 return this->pimpl_->is_used();
56 bool Link::is_shared() const
58 return this->pimpl_->get_sharing_policy() != SharingPolicy::FATPIPE;
61 double Link::get_latency() const
63 return this->pimpl_->get_latency();
66 Link* Link::set_latency(double value)
68 kernel::actor::simcall([this, value] { pimpl_->set_latency(value); });
72 Link* Link::set_latency(const std::string& value)
76 d_value = xbt_parse_get_time("", 0, value, "");
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);
81 return set_latency(d_value);
84 double Link::get_bandwidth() const
86 return this->pimpl_->get_bandwidth();
89 Link* Link::set_bandwidth(double value)
91 kernel::actor::simcall([this, value] { pimpl_->set_bandwidth(value); });
95 Link* Link::set_sharing_policy(Link::SharingPolicy policy)
97 if (policy == SharingPolicy::SPLITDUPLEX)
98 throw std::invalid_argument(std::string("Impossible to set split-duplex for the link: ") + get_name() +
99 std::string(". You should create a link-up and link-down to emulate this behavior"));
101 kernel::actor::simcall([this, policy] { pimpl_->set_sharing_policy(policy); });
104 Link::SharingPolicy Link::get_sharing_policy() const
106 return this->pimpl_->get_sharing_policy();
109 void Link::set_host_wifi_rate(const s4u::Host* host, int level) const
111 auto* wlink = dynamic_cast<kernel::resource::NetworkWifiLink*>(pimpl_);
112 xbt_assert(wlink != nullptr, "Link %s does not seem to be a wifi link.", get_cname());
113 wlink->set_host_rate(host, level);
116 Link* Link::set_concurrency_limit(int limit)
118 kernel::actor::simcall([this, limit] { pimpl_->set_concurrency_limit(limit); });
122 double Link::get_usage() const
124 return this->pimpl_->get_constraint()->get_usage();
129 kernel::actor::simcall([this]() { this->pimpl_->turn_on(); });
131 void Link::turn_off()
133 kernel::actor::simcall([this]() { this->pimpl_->turn_off(); });
137 kernel::actor::simcall([this]() { this->pimpl_->seal(); });
141 bool Link::is_on() const
143 return this->pimpl_->is_on();
146 Link* Link::set_state_profile(kernel::profile::Profile* profile)
148 xbt_assert(not pimpl_->is_sealed(), "Cannot set a state profile once the Link is sealed");
149 kernel::actor::simcall([this, profile]() { this->pimpl_->set_state_profile(profile); });
153 Link* Link::set_bandwidth_profile(kernel::profile::Profile* profile)
155 xbt_assert(not pimpl_->is_sealed(), "Cannot set a bandwidth profile once the Link is sealed");
156 kernel::actor::simcall([this, profile]() { this->pimpl_->set_bandwidth_profile(profile); });
160 Link* Link::set_latency_profile(kernel::profile::Profile* profile)
162 xbt_assert(not pimpl_->is_sealed(), "Cannot set a latency profile once the Link is sealed");
163 kernel::actor::simcall([this, profile]() { this->pimpl_->set_latency_profile(profile); });
167 const char* Link::get_property(const std::string& key) const
169 return this->pimpl_->get_property(key);
171 Link* Link::set_property(const std::string& key, const std::string& value)
173 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
177 const std::unordered_map<std::string, std::string>* Link::get_properties() const
179 return this->pimpl_->get_properties();
182 Link* Link::set_properties(const std::unordered_map<std::string, std::string>& properties)
184 kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
189 } // namespace simgrid
191 /* **************************** Public C interface *************************** */
193 const char* sg_link_get_name(const_sg_link_t link)
195 return link->get_cname();
198 const char* sg_link_name(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
200 return sg_link_get_name(link);
203 sg_link_t sg_link_by_name(const char* name)
205 return simgrid::s4u::Link::by_name(name);
208 int sg_link_is_shared(const_sg_link_t link)
210 return link->is_shared();
213 double sg_link_get_bandwidth(const_sg_link_t link)
215 return link->get_bandwidth();
218 void sg_link_set_bandwidth(sg_link_t link, double value)
220 link->set_bandwidth(value);
223 double sg_link_bandwidth(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
225 return sg_link_get_bandwidth(link);
228 void sg_link_bandwidth_set(sg_link_t link, double value) // XBT_ATTRIB_DEPRECATED_v330
230 sg_link_set_bandwidth(link, value);
233 double sg_link_get_latency(const_sg_link_t link)
235 return link->get_latency();
238 void sg_link_set_latency(sg_link_t link, double value)
240 link->set_latency(value);
243 double sg_link_latency(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
245 return sg_link_get_latency(link);
248 void sg_link_latency_set(sg_link_t link, double value) // XBT_ATTRIB_DEPRECATED_v330
250 sg_link_set_latency(link, value);
253 void* sg_link_get_data(const_sg_link_t link)
255 return link->get_data();
258 void sg_link_set_data(sg_link_t link, void* data)
260 link->set_data(data);
263 void* sg_link_data(const_sg_link_t link) // XBT_ATTRIB_DEPRECATED_v330
265 return sg_link_get_data(link);
268 void sg_link_data_set(sg_link_t link, void* data) // XBT_ATTRIB_DEPRECATED_v330
270 sg_link_set_data(link, data);
273 size_t sg_link_count()
275 return simgrid::s4u::Engine::get_instance()->get_link_count();
278 sg_link_t* sg_link_list()
280 std::vector<simgrid::s4u::Link*> links = simgrid::s4u::Engine::get_instance()->get_all_links();
282 auto* res = xbt_new(sg_link_t, links.size());
283 std::copy(begin(links), end(links), res);