1 /* Copyright (c) 2013-2022. 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. */
6 #include "src/surf/network_cm02.hpp"
7 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "simgrid/s4u/Host.hpp"
10 #include "simgrid/sg_config.hpp"
11 #include "src/kernel/EngineImpl.hpp"
12 #include "src/kernel/resource/StandardLinkImpl.hpp"
13 #include "src/kernel/resource/WifiLinkImpl.hpp"
14 #include "src/kernel/resource/profile/Event.hpp"
15 #include "src/surf/surf_interface.hpp"
20 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_network);
25 static simgrid::config::Flag<std::string> cfg_network_solver("network/solver",
26 "Set linear equations solver used by network model",
27 "maxmin", &simgrid::kernel::lmm::System::validate_solver);
29 /************************************************************************/
30 /* New model based on optimizations discussed during Pedro Velho's thesis*/
31 /************************************************************************/
32 /* @techreport{VELHO:2011:HAL-00646896:1, */
33 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
34 /* title = {{Flow-level network models: have we reached the limits?}}, */
35 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
36 /* type = {Rapport de recherche}, */
37 /* institution = {INRIA}, */
38 /* number = {RR-7821}, */
41 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
43 void surf_network_model_init_LegrandVelho()
45 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_LegrandVelho");
46 auto* engine = simgrid::kernel::EngineImpl::get_instance();
47 engine->add_model(net_model);
48 engine->get_netzone_root()->set_network_model(net_model);
50 simgrid::config::set_default<std::string>("network/latency-factor", "13.01");
51 simgrid::config::set_default<std::string>("network/bandwidth-factor", "0.97");
52 simgrid::config::set_default<double>("network/weight-S", 20537);
55 /***************************************************************************/
56 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
57 /***************************************************************************/
58 /* @TechReport{ rr-lip2002-40, */
59 /* author = {Henri Casanova and Loris Marchal}, */
60 /* institution = {LIP}, */
61 /* title = {A Network Model for Simulation of Grid Application}, */
62 /* number = {2002-40}, */
66 void surf_network_model_init_CM02()
68 simgrid::config::set_default<std::string>("network/latency-factor", "1.0");
69 simgrid::config::set_default<std::string>("network/bandwidth-factor", "1.0");
70 simgrid::config::set_default<double>("network/weight-S", 0.0);
72 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_CM02");
73 auto* engine = simgrid::kernel::EngineImpl::get_instance();
74 engine->add_model(net_model);
75 engine->get_netzone_root()->set_network_model(net_model);
78 /********************************************************************/
79 /* Model based on LV08 and experimental results of MPI ping-pongs */
80 /********************************************************************/
81 /* @Inproceedings{smpi_ipdps, */
82 /* author={Pierre-Nicolas Clauss and Mark Stillwell and Stéphane Genaud and Frédéric Suter and Henri Casanova and
84 /* title={Single Node On-Line Simulation of {MPI} Applications with SMPI}, */
85 /* booktitle={25th IEEE International Parallel and Distributed Processing Symposium (IPDPS'11)}, */
86 /* address={Anchorage (Alaska) USA}, */
90 void surf_network_model_init_SMPI()
92 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_SMPI");
93 auto* engine = simgrid::kernel::EngineImpl::get_instance();
94 engine->add_model(net_model);
95 engine->get_netzone_root()->set_network_model(net_model);
97 simgrid::config::set_default<double>("network/weight-S", 8775);
98 simgrid::config::set_default<std::string>("network/bandwidth-factor",
99 "65472:0.940694;15424:0.697866;9376:0.58729;5776:1.08739;3484:0.77493;"
100 "1426:0.608902;732:0.341987;257:0.338112;0:0.812084");
101 simgrid::config::set_default<std::string>("network/latency-factor",
102 "65472:11.6436;15424:3.48845;9376:2.59299;5776:2.18796;3484:1.88101;"
103 "1426:1.61075;732:1.9503;257:1.95341;0:2.01467");
106 namespace simgrid::kernel::resource {
108 NetworkCm02Model::NetworkCm02Model(const std::string& name) : NetworkModel(name)
110 std::string optim = config::get_value<std::string>("network/optim");
111 bool select = config::get_value<bool>("network/maxmin-selective-update");
113 if (optim == "Lazy") {
114 set_update_algorithm(Model::UpdateAlgo::LAZY);
115 xbt_assert(select || config::is_default("network/maxmin-selective-update"),
116 "You cannot disable network selective update when using the lazy update mechanism");
120 set_maxmin_system(lmm::System::build(cfg_network_solver.get(), select));
122 loopback_.reset(create_link("__loopback__", {config::get_value<double>("network/loopback-bw")}));
123 loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE, {});
124 loopback_->set_latency(config::get_value<double>("network/loopback-lat"));
125 loopback_->get_iface()->seal();
128 StandardLinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
130 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
131 auto link = new NetworkCm02Link(name, bandwidths[0], get_maxmin_system());
132 link->set_model(this);
136 StandardLinkImpl* NetworkCm02Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
138 auto link = new WifiLinkImpl(name, bandwidths, get_maxmin_system());
139 link->set_model(this);
143 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
145 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
146 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
147 XBT_DEBUG("Something happened to action %p", action);
149 // if I am wearing a latency hat
150 if (action->get_type() == ActionHeap::Type::latency) {
151 XBT_DEBUG("Latency paid for action %p. Activating", action);
152 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
153 get_action_heap().remove(action);
154 action->set_last_update();
156 // if I am wearing a max_duration or normal hat
157 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
158 // no need to communicate anymore
159 // assume that flows that reached max_duration have remaining of 0
160 XBT_DEBUG("Action %p finished", action);
161 action->finish(Action::State::FINISHED);
162 get_action_heap().remove(action);
167 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
169 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
170 auto& action = static_cast<NetworkCm02Action&>(*it);
171 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
172 XBT_DEBUG("Something happened to action %p", &action);
173 if (action.latency_ > 0) {
174 if (action.latency_ > delta) {
175 double_update(&action.latency_, delta, sg_surf_precision);
177 action.latency_ = 0.0;
179 if (action.latency_ <= 0.0 && not action.is_suspended())
180 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
183 if (not action.get_variable()->get_number_of_constraint()) {
184 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
185 * vivaldi. In such case, just make sure that the action completes immediately.
187 action.update_remains(action.get_remains());
189 action.update_remains(action.get_rate() * delta);
191 if (action.get_max_duration() != NO_MAX_DURATION)
192 action.update_max_duration(delta);
194 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
195 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
196 action.finish(Action::State::FINISHED);
201 void NetworkCm02Model::comm_action_expand_constraints(const s4u::Host* src, const s4u::Host* dst,
202 const NetworkCm02Action* action,
203 const std::vector<StandardLinkImpl*>& route,
204 const std::vector<StandardLinkImpl*>& back_route) const
206 /* expand route links constraints for route and back_route */
207 const WifiLinkImpl* src_wifi_link = nullptr;
208 const WifiLinkImpl* dst_wifi_link = nullptr;
209 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
210 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
212 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
213 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
216 /* WI-FI links needs special treatment, do it here */
217 if (src_wifi_link != nullptr) {
218 if (src_wifi_link->get_host_rate(src) > 0)
219 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
220 1.0 / src_wifi_link->get_host_rate(src));
222 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
226 if (dst_wifi_link != nullptr) {
227 if (dst_wifi_link->get_host_rate(dst) > 0)
228 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
229 1.0 / dst_wifi_link->get_host_rate(dst));
231 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
235 for (auto const* link : route) {
236 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
237 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
240 if (cfg_crosstraffic) {
241 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
242 if (dst_wifi_link != nullptr)
243 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
244 .05 / dst_wifi_link->get_host_rate(dst));
245 if (src_wifi_link != nullptr)
246 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
247 .05 / src_wifi_link->get_host_rate(src));
249 for (auto const* link : back_route) {
250 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
251 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
256 NetworkCm02Action* NetworkCm02Model::comm_action_create(s4u::Host* src, s4u::Host* dst, double size,
257 const std::vector<StandardLinkImpl*>& route, bool failed)
259 WifiLinkImpl* src_wifi_link = nullptr;
260 WifiLinkImpl* dst_wifi_link = nullptr;
261 /* many checks related to Wi-Fi links */
262 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
263 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
264 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
265 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
266 "WIFI link. Did you call link->set_host_rate()?",
267 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
269 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
270 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
271 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
272 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
273 "WIFI link. Did you call link->set_host_rate()?",
274 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
276 if (route.size() > 2)
277 for (unsigned i = 1; i < route.size() - 1; i++)
278 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
279 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
280 "not in between (it is at position %u out of %zu). "
281 "Did you declare an access_point in your WIFI zones?",
282 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
284 for (auto const* link : route) {
285 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
286 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
287 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
288 "at its end (meaning that it's attached to the dst");
292 /* create action and do some initializations */
293 NetworkCm02Action* action;
294 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
295 action = new NetworkCm02Action(this, *src, *dst, size, failed);
297 action = new WifiLinkAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
299 if (is_update_lazy()) {
300 action->set_last_update();
306 bool NetworkCm02Model::comm_get_route_info(const s4u::Host* src, const s4u::Host* dst, double& latency,
307 std::vector<StandardLinkImpl*>& route,
308 std::vector<StandardLinkImpl*>& back_route,
309 std::unordered_set<kernel::routing::NetZoneImpl*>& netzones) const
311 kernel::routing::NetZoneImpl::get_global_route_with_netzones(src->get_netpoint(), dst->get_netpoint(), route,
314 xbt_assert(not route.empty() || latency > 0,
315 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
316 src->get_cname(), dst->get_cname());
318 bool failed = std::any_of(route.begin(), route.end(), [](const StandardLinkImpl* link) { return not link->is_on(); });
320 if (not failed && cfg_crosstraffic) {
321 dst->route_to(src, back_route, nullptr);
322 failed = std::any_of(back_route.begin(), back_route.end(),
323 [](const StandardLinkImpl* link) { return not link->is_on(); });
328 void NetworkCm02Model::comm_action_set_bounds(const s4u::Host* src, const s4u::Host* dst, double size,
329 NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
330 const std::unordered_set<kernel::routing::NetZoneImpl*>& netzones,
333 std::vector<s4u::Link*> s4u_route;
334 std::unordered_set<s4u::NetZone*> s4u_netzones;
336 /* transform data to user structures if necessary */
337 if (has_network_factor_cb()) {
338 std::for_each(route.begin(), route.end(),
339 [&s4u_route](StandardLinkImpl* l) { s4u_route.push_back(l->get_iface()); });
340 std::for_each(netzones.begin(), netzones.end(),
341 [&s4u_netzones](kernel::routing::NetZoneImpl* n) { s4u_netzones.insert(n->get_iface()); });
344 double bw_factor = get_bandwidth_factor(size, src, dst, s4u_route, s4u_netzones);
345 xbt_assert(bw_factor != 0, "Invalid param for comm %s -> %s. Bandwidth factor cannot be 0", src->get_cname(),
347 action->set_rate_factor(bw_factor);
349 /* get mininum bandwidth among links in the route and multiply by correct factor
350 * ignore wi-fi links, they're not considered for bw_factors */
351 double bandwidth_bound = -1.0;
352 for (const auto* l : route) {
353 if (l->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI)
355 if (bandwidth_bound == -1.0 || l->get_bandwidth() < bandwidth_bound)
356 bandwidth_bound = l->get_bandwidth();
359 /* increase rate given by user considering the factor, since the actual rate will be
361 rate = rate / bw_factor;
362 /* the bandwidth is determined by the minimum between flow and user's defined rate */
363 if (rate >= 0 && rate < bandwidth_bound)
364 bandwidth_bound = rate;
365 action->set_user_bound(bandwidth_bound);
367 action->lat_current_ = action->latency_;
368 action->latency_ *= get_latency_factor(size, src, dst, s4u_route, s4u_netzones);
371 void NetworkCm02Model::comm_action_set_variable(NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
372 const std::vector<StandardLinkImpl*>& back_route)
374 size_t constraints_per_variable = route.size();
375 constraints_per_variable += back_route.size();
377 if (action->latency_ > 0) {
378 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
379 if (is_update_lazy()) {
380 // add to the heap the event when the latency is paid
381 double date = action->latency_ + action->get_last_update();
383 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
385 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
386 get_action_heap().insert(action, date, type);
389 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
391 /* after setting the variable, update the bounds depending on user configuration */
392 if (action->get_user_bound() < 0) {
393 get_maxmin_system()->update_variable_bound(
394 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
396 get_maxmin_system()->update_variable_bound(
397 action->get_variable(), (action->lat_current_ > 0)
398 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
399 : action->get_user_bound());
403 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
405 double latency = 0.0;
406 std::vector<StandardLinkImpl*> back_route;
407 std::vector<StandardLinkImpl*> route;
408 std::unordered_set<kernel::routing::NetZoneImpl*> netzones;
410 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
412 bool failed = comm_get_route_info(src, dst, latency, route, back_route, netzones);
414 NetworkCm02Action* action = comm_action_create(src, dst, size, route, failed);
415 action->sharing_penalty_ = latency;
416 action->latency_ = latency;
418 if (cfg_weight_S_parameter > 0) {
419 action->sharing_penalty_ = std::accumulate(route.begin(), route.end(), action->sharing_penalty_,
420 [](double total, StandardLinkImpl* const& link) {
421 return total + cfg_weight_S_parameter / link->get_bandwidth();
425 /* setting bandwidth and latency bounds considering route and configured bw/lat factors */
426 comm_action_set_bounds(src, dst, size, action, route, netzones, rate);
428 /* creating the maxmin variable associated to this action */
429 comm_action_set_variable(action, route, back_route);
431 /* expand maxmin system to consider this communication in bw constraint for each link in route and back_route */
432 comm_action_expand_constraints(src, dst, action, route, back_route);
441 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, kernel::lmm::System* system)
442 : StandardLinkImpl(name)
444 bandwidth_.scale = 1.0;
445 bandwidth_.peak = bandwidth;
446 this->set_constraint(system->constraint_new(this, bandwidth));
449 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
451 /* Find out which of my iterators was triggered, and react accordingly */
452 if (triggered == bandwidth_.event) {
453 set_bandwidth(value);
454 tmgr_trace_event_unref(&bandwidth_.event);
456 } else if (triggered == latency_.event) {
458 tmgr_trace_event_unref(&latency_.event);
460 } else if (triggered == get_state_event()) {
467 xbt_die("Unknown event!\n");
470 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
474 void NetworkCm02Link::set_bandwidth(double value)
476 double old_peak = bandwidth_.peak;
477 bandwidth_.peak = value;
479 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), (bandwidth_.peak * bandwidth_.scale));
481 StandardLinkImpl::on_bandwidth_change();
483 if (NetworkModel::cfg_weight_S_parameter > 0) {
484 double delta = NetworkModel::cfg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale) -
485 NetworkModel::cfg_weight_S_parameter / (old_peak * bandwidth_.scale);
487 const kernel::lmm::Element* elem = nullptr;
488 const kernel::lmm::Element* nextelem = nullptr;
490 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
491 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
492 action->sharing_penalty_ += delta;
493 if (not action->is_suspended())
494 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
499 void NetworkCm02Link::set_latency(double value)
501 latency_check(value);
503 double delta = value - latency_.peak;
504 const kernel::lmm::Element* elem = nullptr;
505 const kernel::lmm::Element* nextelem = nullptr;
508 latency_.scale = 1.0;
509 latency_.peak = value;
511 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
512 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
513 action->lat_current_ += delta;
514 action->sharing_penalty_ += delta;
515 if (action->get_user_bound() < 0)
516 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
517 (2.0 * action->lat_current_));
519 get_model()->get_maxmin_system()->update_variable_bound(
520 action->get_variable(),
521 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
523 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
524 XBT_DEBUG("Flow is limited BYBANDWIDTH");
526 XBT_DEBUG("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
529 if (not action->is_suspended())
530 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
538 void NetworkCm02Action::update_remains_lazy(double now)
540 if (not is_running())
543 double delta = now - get_last_update();
545 if (get_remains_no_update() > 0) {
546 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
548 update_remains(get_last_value() * delta);
550 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
553 update_max_duration(delta);
555 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
556 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
557 finish(Action::State::FINISHED);
558 get_model()->get_action_heap().remove(this);
562 set_last_value(get_rate());
565 } // namespace simgrid::kernel::resource