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 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
31 /************************************************************************/
32 /* New model based on optimizations discussed during Pedro Velho's thesis*/
33 /************************************************************************/
34 /* @techreport{VELHO:2011:HAL-00646896:1, */
35 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
36 /* title = {{Flow-level network models: have we reached the limits?}}, */
37 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
38 /* type = {Rapport de recherche}, */
39 /* institution = {INRIA}, */
40 /* number = {RR-7821}, */
43 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
45 void surf_network_model_init_LegrandVelho()
47 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_LegrandVelho");
48 auto* engine = simgrid::kernel::EngineImpl::get_instance();
49 engine->add_model(net_model);
50 engine->get_netzone_root()->set_network_model(net_model);
52 simgrid::config::set_default<double>("network/latency-factor", 13.01);
53 simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
54 simgrid::config::set_default<double>("network/weight-S", 20537);
57 /***************************************************************************/
58 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
59 /***************************************************************************/
60 /* @TechReport{ rr-lip2002-40, */
61 /* author = {Henri Casanova and Loris Marchal}, */
62 /* institution = {LIP}, */
63 /* title = {A Network Model for Simulation of Grid Application}, */
64 /* number = {2002-40}, */
68 void surf_network_model_init_CM02()
70 simgrid::config::set_default<double>("network/latency-factor", 1.0);
71 simgrid::config::set_default<double>("network/bandwidth-factor", 1.0);
72 simgrid::config::set_default<double>("network/weight-S", 0.0);
74 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_CM02");
75 auto* engine = simgrid::kernel::EngineImpl::get_instance();
76 engine->add_model(net_model);
77 engine->get_netzone_root()->set_network_model(net_model);
80 namespace simgrid::kernel::resource {
82 NetworkCm02Model::NetworkCm02Model(const std::string& name) : NetworkModel(name)
84 std::string optim = config::get_value<std::string>("network/optim");
85 bool select = config::get_value<bool>("network/maxmin-selective-update");
87 if (optim == "Lazy") {
88 set_update_algorithm(Model::UpdateAlgo::LAZY);
89 xbt_assert(select || config::is_default("network/maxmin-selective-update"),
90 "You cannot disable network selective update when using the lazy update mechanism");
94 set_maxmin_system(lmm::System::build(cfg_network_solver.get(), select));
96 loopback_.reset(create_link("__loopback__", {config::get_value<double>("network/loopback-bw")}));
97 loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE, {});
98 loopback_->set_latency(config::get_value<double>("network/loopback-lat"));
99 loopback_->get_iface()->seal();
102 void NetworkCm02Model::check_lat_factor_cb()
104 if (not simgrid::config::is_default("network/latency-factor")) {
105 throw std::invalid_argument(
106 "NetworkModelIntf: Cannot mix network/latency-factor and callback configuration. Choose only one of them.");
110 void NetworkCm02Model::check_bw_factor_cb()
112 if (not simgrid::config::is_default("network/bandwidth-factor")) {
113 throw std::invalid_argument(
114 "NetworkModelIntf: Cannot mix network/bandwidth-factor and callback configuration. Choose only one of them.");
118 void NetworkCm02Model::set_lat_factor_cb(const std::function<NetworkFactorCb>& cb)
121 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
122 check_lat_factor_cb();
127 void NetworkCm02Model::set_bw_factor_cb(const std::function<NetworkFactorCb>& cb)
130 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
131 check_bw_factor_cb();
136 StandardLinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
138 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
139 auto link = new NetworkCm02Link(name, bandwidths[0], get_maxmin_system());
140 link->set_model(this);
144 StandardLinkImpl* NetworkCm02Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
146 auto link = new WifiLinkImpl(name, bandwidths, get_maxmin_system());
147 link->set_model(this);
151 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
153 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
154 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
155 XBT_DEBUG("Something happened to action %p", action);
157 // if I am wearing a latency hat
158 if (action->get_type() == ActionHeap::Type::latency) {
159 XBT_DEBUG("Latency paid for action %p. Activating", action);
160 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
161 get_action_heap().remove(action);
162 action->set_last_update();
164 // if I am wearing a max_duration or normal hat
165 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
166 // no need to communicate anymore
167 // assume that flows that reached max_duration have remaining of 0
168 XBT_DEBUG("Action %p finished", action);
169 action->finish(Action::State::FINISHED);
170 get_action_heap().remove(action);
175 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
177 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
178 auto& action = static_cast<NetworkCm02Action&>(*it);
179 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
180 XBT_DEBUG("Something happened to action %p", &action);
181 if (action.latency_ > 0) {
182 if (action.latency_ > delta) {
183 double_update(&action.latency_, delta, sg_surf_precision);
185 action.latency_ = 0.0;
187 if (action.latency_ <= 0.0 && not action.is_suspended())
188 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
191 if (not action.get_variable()->get_number_of_constraint()) {
192 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
193 * vivaldi. In such case, just make sure that the action completes immediately.
195 action.update_remains(action.get_remains());
197 action.update_remains(action.get_rate() * delta);
199 if (action.get_max_duration() != NO_MAX_DURATION)
200 action.update_max_duration(delta);
202 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
203 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
204 action.finish(Action::State::FINISHED);
209 void NetworkCm02Model::comm_action_expand_constraints(const s4u::Host* src, const s4u::Host* dst,
210 const NetworkCm02Action* action,
211 const std::vector<StandardLinkImpl*>& route,
212 const std::vector<StandardLinkImpl*>& back_route) const
214 /* expand route links constraints for route and back_route */
215 const WifiLinkImpl* src_wifi_link = nullptr;
216 const WifiLinkImpl* dst_wifi_link = nullptr;
217 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
218 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
220 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
221 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
224 /* WI-FI links needs special treatment, do it here */
225 if (src_wifi_link != nullptr) {
226 if (src_wifi_link->get_host_rate(src) > 0)
227 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
228 1.0 / src_wifi_link->get_host_rate(src));
230 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
234 if (dst_wifi_link != nullptr) {
235 if (dst_wifi_link->get_host_rate(dst) > 0)
236 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
237 1.0 / dst_wifi_link->get_host_rate(dst));
239 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
243 for (auto const* link : route) {
244 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
245 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
248 if (cfg_crosstraffic) {
249 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
250 if (dst_wifi_link != nullptr)
251 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
252 .05 / dst_wifi_link->get_host_rate(dst));
253 if (src_wifi_link != nullptr)
254 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
255 .05 / src_wifi_link->get_host_rate(src));
257 for (auto const* link : back_route) {
258 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
259 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
264 NetworkCm02Action* NetworkCm02Model::comm_action_create(s4u::Host* src, s4u::Host* dst, double size,
265 const std::vector<StandardLinkImpl*>& route, bool failed)
267 WifiLinkImpl* src_wifi_link = nullptr;
268 WifiLinkImpl* dst_wifi_link = nullptr;
269 /* many checks related to Wi-Fi links */
270 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
271 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
272 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
273 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
274 "WIFI link. Did you call link->set_host_rate()?",
275 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
277 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
278 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
279 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
280 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
281 "WIFI link. Did you call link->set_host_rate()?",
282 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
284 if (route.size() > 2)
285 for (unsigned i = 1; i < route.size() - 1; i++)
286 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
287 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
288 "not in between (it is at position %u out of %zu). "
289 "Did you declare an access_point in your WIFI zones?",
290 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
292 for (auto const* link : route) {
293 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
294 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
295 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
296 "at its end (meaning that it's attached to the dst");
300 /* create action and do some initializations */
301 NetworkCm02Action* action;
302 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
303 action = new NetworkCm02Action(this, *src, *dst, size, failed);
305 action = new WifiLinkAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
307 if (is_update_lazy()) {
308 action->set_last_update();
314 bool NetworkCm02Model::comm_get_route_info(const s4u::Host* src, const s4u::Host* dst, double& latency,
315 std::vector<StandardLinkImpl*>& route,
316 std::vector<StandardLinkImpl*>& back_route,
317 std::unordered_set<kernel::routing::NetZoneImpl*>& netzones) const
319 kernel::routing::NetZoneImpl::get_global_route_with_netzones(src->get_netpoint(), dst->get_netpoint(), route,
322 xbt_assert(not route.empty() || latency > 0,
323 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
324 src->get_cname(), dst->get_cname());
326 bool failed = std::any_of(route.begin(), route.end(), [](const StandardLinkImpl* link) { return not link->is_on(); });
328 if (not failed && cfg_crosstraffic) {
329 dst->route_to(src, back_route, nullptr);
330 failed = std::any_of(back_route.begin(), back_route.end(),
331 [](const StandardLinkImpl* link) { return not link->is_on(); });
336 void NetworkCm02Model::comm_action_set_bounds(const s4u::Host* src, const s4u::Host* dst, double size,
337 NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
338 const std::unordered_set<kernel::routing::NetZoneImpl*>& netzones,
341 std::vector<s4u::Link*> s4u_route;
342 std::unordered_set<s4u::NetZone*> s4u_netzones;
344 /* transform data to user structures if necessary */
345 if (lat_factor_cb_ || bw_factor_cb_) {
346 std::for_each(route.begin(), route.end(),
347 [&s4u_route](StandardLinkImpl* l) { s4u_route.push_back(l->get_iface()); });
348 std::for_each(netzones.begin(), netzones.end(),
349 [&s4u_netzones](kernel::routing::NetZoneImpl* n) { s4u_netzones.insert(n->get_iface()); });
353 bw_factor = bw_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
355 bw_factor = get_bandwidth_factor(size);
357 xbt_assert(bw_factor != 0, "Invalid param for comm %s -> %s. Bandwidth factor cannot be 0", src->get_cname(),
359 action->set_rate_factor(bw_factor);
361 /* get mininum bandwidth among links in the route and multiply by correct factor
362 * ignore wi-fi links, they're not considered for bw_factors */
363 double bandwidth_bound = -1.0;
364 for (const auto* l : route) {
365 if (l->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI)
367 if (bandwidth_bound == -1.0 || l->get_bandwidth() < bandwidth_bound)
368 bandwidth_bound = l->get_bandwidth();
371 /* increase rate given by user considering the factor, since the actual rate will be
373 rate = rate / bw_factor;
374 /* the bandwidth is determined by the minimum between flow and user's defined rate */
375 if (rate >= 0 && rate < bandwidth_bound)
376 bandwidth_bound = rate;
377 action->set_user_bound(bandwidth_bound);
379 action->lat_current_ = action->latency_;
380 if (lat_factor_cb_) {
381 action->latency_ *= lat_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
383 action->latency_ *= get_latency_factor(size);
387 void NetworkCm02Model::comm_action_set_variable(NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
388 const std::vector<StandardLinkImpl*>& back_route)
390 size_t constraints_per_variable = route.size();
391 constraints_per_variable += back_route.size();
393 if (action->latency_ > 0) {
394 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
395 if (is_update_lazy()) {
396 // add to the heap the event when the latency is paid
397 double date = action->latency_ + action->get_last_update();
399 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
401 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
402 get_action_heap().insert(action, date, type);
405 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
407 /* after setting the variable, update the bounds depending on user configuration */
408 if (action->get_user_bound() < 0) {
409 get_maxmin_system()->update_variable_bound(
410 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
412 get_maxmin_system()->update_variable_bound(
413 action->get_variable(), (action->lat_current_ > 0)
414 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
415 : action->get_user_bound());
419 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
421 double latency = 0.0;
422 std::vector<StandardLinkImpl*> back_route;
423 std::vector<StandardLinkImpl*> route;
424 std::unordered_set<kernel::routing::NetZoneImpl*> netzones;
426 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
428 bool failed = comm_get_route_info(src, dst, latency, route, back_route, netzones);
430 NetworkCm02Action* action = comm_action_create(src, dst, size, route, failed);
431 action->sharing_penalty_ = latency;
432 action->latency_ = latency;
434 if (sg_weight_S_parameter > 0) {
435 action->sharing_penalty_ = std::accumulate(route.begin(), route.end(), action->sharing_penalty_,
436 [](double total, StandardLinkImpl* const& link) {
437 return total + sg_weight_S_parameter / link->get_bandwidth();
441 /* setting bandwidth and latency bounds considering route and configured bw/lat factors */
442 comm_action_set_bounds(src, dst, size, action, route, netzones, rate);
444 /* creating the maxmin variable associated to this action */
445 comm_action_set_variable(action, route, back_route);
447 /* expand maxmin system to consider this communication in bw constraint for each link in route and back_route */
448 comm_action_expand_constraints(src, dst, action, route, back_route);
457 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, kernel::lmm::System* system)
458 : StandardLinkImpl(name)
460 bandwidth_.scale = 1.0;
461 bandwidth_.peak = bandwidth;
462 this->set_constraint(system->constraint_new(this, bandwidth));
465 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
467 /* Find out which of my iterators was triggered, and react accordingly */
468 if (triggered == bandwidth_.event) {
469 set_bandwidth(value);
470 tmgr_trace_event_unref(&bandwidth_.event);
472 } else if (triggered == latency_.event) {
474 tmgr_trace_event_unref(&latency_.event);
476 } else if (triggered == get_state_event()) {
483 xbt_die("Unknown event!\n");
486 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
490 void NetworkCm02Link::set_bandwidth(double value)
492 double old_peak = bandwidth_.peak;
493 bandwidth_.peak = value;
495 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), (bandwidth_.peak * bandwidth_.scale));
497 StandardLinkImpl::on_bandwidth_change();
499 if (sg_weight_S_parameter > 0) {
500 double delta = sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale) -
501 sg_weight_S_parameter / (old_peak * bandwidth_.scale);
503 const kernel::lmm::Element* elem = nullptr;
504 const kernel::lmm::Element* nextelem = nullptr;
506 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
507 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
508 action->sharing_penalty_ += delta;
509 if (not action->is_suspended())
510 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
515 void NetworkCm02Link::set_latency(double value)
517 latency_check(value);
519 double delta = value - latency_.peak;
520 const kernel::lmm::Element* elem = nullptr;
521 const kernel::lmm::Element* nextelem = nullptr;
524 latency_.scale = 1.0;
525 latency_.peak = value;
527 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
528 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
529 action->lat_current_ += delta;
530 action->sharing_penalty_ += delta;
531 if (action->get_user_bound() < 0)
532 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
533 (2.0 * action->lat_current_));
535 get_model()->get_maxmin_system()->update_variable_bound(
536 action->get_variable(),
537 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
539 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
540 XBT_DEBUG("Flow is limited BYBANDWIDTH");
542 XBT_DEBUG("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
545 if (not action->is_suspended())
546 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
554 void NetworkCm02Action::update_remains_lazy(double now)
556 if (not is_running())
559 double delta = now - get_last_update();
561 if (get_remains_no_update() > 0) {
562 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
564 update_remains(get_last_value() * delta);
566 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
569 update_max_duration(delta);
571 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
572 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
573 finish(Action::State::FINISHED);
574 get_model()->get_action_heap().remove(this);
578 set_last_value(get_rate());
581 } // namespace simgrid::kernel::resource