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_latency_factor = 1.0; /* default value; can be set by model or from command line */
30 double sg_bandwidth_factor = 1.0; /* default value; can be set by model or from command line */
31 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
33 /************************************************************************/
34 /* New model based on optimizations discussed during Pedro Velho's thesis*/
35 /************************************************************************/
36 /* @techreport{VELHO:2011:HAL-00646896:1, */
37 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
38 /* title = {{Flow-level network models: have we reached the limits?}}, */
39 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
40 /* type = {Rapport de recherche}, */
41 /* institution = {INRIA}, */
42 /* number = {RR-7821}, */
45 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
47 void surf_network_model_init_LegrandVelho()
49 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_LegrandVelho");
50 auto* engine = simgrid::kernel::EngineImpl::get_instance();
51 engine->add_model(net_model);
52 engine->get_netzone_root()->set_network_model(net_model);
54 simgrid::config::set_default<double>("network/latency-factor", 13.01);
55 simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
56 simgrid::config::set_default<double>("network/weight-S", 20537);
59 /***************************************************************************/
60 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
61 /***************************************************************************/
62 /* @TechReport{ rr-lip2002-40, */
63 /* author = {Henri Casanova and Loris Marchal}, */
64 /* institution = {LIP}, */
65 /* title = {A Network Model for Simulation of Grid Application}, */
66 /* number = {2002-40}, */
70 void surf_network_model_init_CM02()
72 simgrid::config::set_default<double>("network/latency-factor", 1.0);
73 simgrid::config::set_default<double>("network/bandwidth-factor", 1.0);
74 simgrid::config::set_default<double>("network/weight-S", 0.0);
76 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_CM02");
77 auto* engine = simgrid::kernel::EngineImpl::get_instance();
78 engine->add_model(net_model);
79 engine->get_netzone_root()->set_network_model(net_model);
86 NetworkCm02Model::NetworkCm02Model(const std::string& name) : NetworkModel(name)
88 std::string optim = config::get_value<std::string>("network/optim");
89 bool select = config::get_value<bool>("network/maxmin-selective-update");
91 if (optim == "Lazy") {
92 set_update_algorithm(Model::UpdateAlgo::LAZY);
93 xbt_assert(select || config::is_default("network/maxmin-selective-update"),
94 "You cannot disable network selective update when using the lazy update mechanism");
98 set_maxmin_system(lmm::System::build(cfg_network_solver, select));
100 loopback_ = create_link("__loopback__", {config::get_value<double>("network/loopback-bw")});
101 loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE, {});
102 loopback_->set_latency(config::get_value<double>("network/loopback-lat"));
106 void NetworkCm02Model::check_lat_factor_cb()
108 if (not simgrid::config::is_default("network/latency-factor")) {
109 throw std::invalid_argument(
110 "NetworkModelIntf: Cannot mix network/latency-factor and callback configuration. Choose only one of them.");
114 void NetworkCm02Model::check_bw_factor_cb()
116 if (not simgrid::config::is_default("network/bandwidth-factor")) {
117 throw std::invalid_argument(
118 "NetworkModelIntf: Cannot mix network/bandwidth-factor and callback configuration. Choose only one of them.");
122 void NetworkCm02Model::set_lat_factor_cb(const std::function<NetworkFactorCb>& cb)
125 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
126 check_lat_factor_cb();
131 void NetworkCm02Model::set_bw_factor_cb(const std::function<NetworkFactorCb>& cb)
134 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
135 check_bw_factor_cb();
140 StandardLinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
142 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
143 auto link = new NetworkCm02Link(name, bandwidths[0], get_maxmin_system());
144 link->set_model(this);
148 StandardLinkImpl* NetworkCm02Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
150 auto link = new WifiLinkImpl(name, bandwidths, get_maxmin_system());
151 link->set_model(this);
155 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
157 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
158 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
159 XBT_DEBUG("Something happened to action %p", action);
161 // if I am wearing a latency hat
162 if (action->get_type() == ActionHeap::Type::latency) {
163 XBT_DEBUG("Latency paid for action %p. Activating", action);
164 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
165 get_action_heap().remove(action);
166 action->set_last_update();
168 // if I am wearing a max_duration or normal hat
169 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
170 // no need to communicate anymore
171 // assume that flows that reached max_duration have remaining of 0
172 XBT_DEBUG("Action %p finished", action);
173 action->finish(Action::State::FINISHED);
174 get_action_heap().remove(action);
179 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
181 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
182 auto& action = static_cast<NetworkCm02Action&>(*it);
183 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
184 XBT_DEBUG("Something happened to action %p", &action);
185 double deltap = delta;
186 if (action.latency_ > 0) {
187 if (action.latency_ > deltap) {
188 double_update(&action.latency_, deltap, sg_surf_precision);
191 double_update(&deltap, action.latency_, sg_surf_precision);
192 action.latency_ = 0.0;
194 if (action.latency_ <= 0.0 && not action.is_suspended())
195 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
198 if (not action.get_variable()->get_number_of_constraint()) {
199 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
200 * vivaldi. In such case, just make sure that the action completes immediately.
202 action.update_remains(action.get_remains());
204 action.update_remains(action.get_rate() * delta);
206 if (action.get_max_duration() != NO_MAX_DURATION)
207 action.update_max_duration(delta);
209 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
210 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
211 action.finish(Action::State::FINISHED);
216 void NetworkCm02Model::comm_action_expand_constraints(const s4u::Host* src, const s4u::Host* dst,
217 const NetworkCm02Action* action,
218 const std::vector<StandardLinkImpl*>& route,
219 const std::vector<StandardLinkImpl*>& back_route) const
221 /* expand route links constraints for route and back_route */
222 const WifiLinkImpl* src_wifi_link = nullptr;
223 const WifiLinkImpl* dst_wifi_link = nullptr;
224 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
225 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
227 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
228 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
231 /* WI-FI links needs special treatment, do it here */
232 if (src_wifi_link != nullptr) {
233 /* In case of 0Mbps data rate, don't consider it in the LMM */
234 if (src_wifi_link->get_host_rate(src) > 0)
235 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
236 1.0 / src_wifi_link->get_host_rate(src));
238 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
240 if (dst_wifi_link != nullptr) {
241 if (dst_wifi_link->get_host_rate(dst) > 0)
242 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
243 1.0 / dst_wifi_link->get_host_rate(dst));
245 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
248 for (auto const* link : route) {
249 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
250 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
253 if (cfg_crosstraffic) {
254 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
255 if (dst_wifi_link != nullptr)
256 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
257 .05 / dst_wifi_link->get_host_rate(dst));
258 if (src_wifi_link != nullptr)
259 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
260 .05 / src_wifi_link->get_host_rate(src));
262 for (auto const* link : back_route) {
263 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
264 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
266 // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
267 // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
268 // action->getVariable()->set_concurrency_share(2)
272 NetworkCm02Action* NetworkCm02Model::comm_action_create(s4u::Host* src, s4u::Host* dst, double size,
273 const std::vector<StandardLinkImpl*>& route, bool failed)
275 WifiLinkImpl* src_wifi_link = nullptr;
276 WifiLinkImpl* dst_wifi_link = nullptr;
277 /* many checks related to Wi-Fi links */
278 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
279 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
280 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
281 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
282 "WIFI link. Did you call link->set_host_rate()?",
283 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
285 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
286 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
287 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
288 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
289 "WIFI link. Did you call link->set_host_rate()?",
290 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
292 if (route.size() > 2)
293 for (unsigned i = 1; i < route.size() - 1; i++)
294 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
295 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
296 "not in between (it is at position %u out of %zu). "
297 "Did you declare an access_point in your WIFI zones?",
298 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
300 for (auto const* link : route) {
301 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
302 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
303 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
304 "at its end (meaning that it's attached to the dst");
308 /* create action and do some initializations */
309 NetworkCm02Action* action;
310 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
311 action = new NetworkCm02Action(this, *src, *dst, size, failed);
313 action = new WifiLinkAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
315 if (is_update_lazy()) {
316 action->set_last_update();
322 bool NetworkCm02Model::comm_get_route_info(const s4u::Host* src, const s4u::Host* dst, double& latency,
323 std::vector<StandardLinkImpl*>& route,
324 std::vector<StandardLinkImpl*>& back_route,
325 std::unordered_set<kernel::routing::NetZoneImpl*>& netzones) const
327 kernel::routing::NetZoneImpl::get_global_route_with_netzones(src->get_netpoint(), dst->get_netpoint(), route,
330 xbt_assert(not route.empty() || latency > 0,
331 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
332 src->get_cname(), dst->get_cname());
334 bool failed = std::any_of(route.begin(), route.end(), [](const StandardLinkImpl* link) { return not link->is_on(); });
336 if (not failed && cfg_crosstraffic) {
337 dst->route_to(src, back_route, nullptr);
338 failed = std::any_of(back_route.begin(), back_route.end(),
339 [](const StandardLinkImpl* link) { return not link->is_on(); });
344 void NetworkCm02Model::comm_action_set_bounds(const s4u::Host* src, const s4u::Host* dst, double size,
345 NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
346 const std::unordered_set<kernel::routing::NetZoneImpl*>& netzones,
349 std::vector<s4u::Link*> s4u_route;
350 std::unordered_set<s4u::NetZone*> s4u_netzones;
352 /* transform data to user structures if necessary */
353 if (lat_factor_cb_ || bw_factor_cb_) {
354 std::for_each(route.begin(), route.end(),
355 [&s4u_route](StandardLinkImpl* l) { s4u_route.push_back(l->get_iface()); });
356 std::for_each(netzones.begin(), netzones.end(),
357 [&s4u_netzones](kernel::routing::NetZoneImpl* n) { s4u_netzones.insert(n->get_iface()); });
361 bw_factor = bw_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
363 bw_factor = get_bandwidth_factor(size);
365 xbt_assert(bw_factor != 0, "Invalid param for comm %s -> %s. Bandwidth factor cannot be 0", src->get_cname(),
367 action->set_rate_factor(bw_factor);
369 /* get mininum bandwidth among links in the route and multiply by correct factor
370 * ignore wi-fi links, they're not considered for bw_factors */
371 double bandwidth_bound = -1.0;
372 for (const auto* l : route) {
373 if (l->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI)
375 if (bandwidth_bound == -1.0 || l->get_bandwidth() < bandwidth_bound)
376 bandwidth_bound = l->get_bandwidth();
379 /* increase rate given by user considering the factor, since the actual rate will be
381 rate = rate / bw_factor;
382 /* the bandwidth is determined by the minimum between flow and user's defined rate */
383 if (rate >= 0 && rate < bandwidth_bound)
384 bandwidth_bound = rate;
385 action->set_user_bound(bandwidth_bound);
387 action->lat_current_ = action->latency_;
388 if (lat_factor_cb_) {
389 action->latency_ *= lat_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
391 action->latency_ *= get_latency_factor(size);
395 void NetworkCm02Model::comm_action_set_variable(NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
396 const std::vector<StandardLinkImpl*>& back_route)
398 size_t constraints_per_variable = route.size();
399 constraints_per_variable += back_route.size();
401 if (action->latency_ > 0) {
402 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
403 if (is_update_lazy()) {
404 // add to the heap the event when the latency is paid
405 double date = action->latency_ + action->get_last_update();
407 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
409 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
410 get_action_heap().insert(action, date, type);
413 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
415 /* after setting the variable, update the bounds depending on user configuration */
416 if (action->get_user_bound() < 0) {
417 get_maxmin_system()->update_variable_bound(
418 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
420 get_maxmin_system()->update_variable_bound(
421 action->get_variable(), (action->lat_current_ > 0)
422 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
423 : action->get_user_bound());
427 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
429 double latency = 0.0;
430 std::vector<StandardLinkImpl*> back_route;
431 std::vector<StandardLinkImpl*> route;
432 std::unordered_set<kernel::routing::NetZoneImpl*> netzones;
434 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
436 bool failed = comm_get_route_info(src, dst, latency, route, back_route, netzones);
438 NetworkCm02Action* action = comm_action_create(src, dst, size, route, failed);
439 action->sharing_penalty_ = latency;
440 action->latency_ = latency;
442 if (sg_weight_S_parameter > 0) {
443 action->sharing_penalty_ = std::accumulate(route.begin(), route.end(), action->sharing_penalty_,
444 [](double total, StandardLinkImpl* const& link) {
445 return total + sg_weight_S_parameter / link->get_bandwidth();
449 /* setting bandwidth and latency bounds considering route and configured bw/lat factors */
450 comm_action_set_bounds(src, dst, size, action, route, netzones, rate);
452 /* creating the maxmin variable associated to this action */
453 comm_action_set_variable(action, route, back_route);
455 /* expand maxmin system to consider this communication in bw constraint for each link in route and back_route */
456 comm_action_expand_constraints(src, dst, action, route, back_route);
465 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, kernel::lmm::System* system)
466 : StandardLinkImpl(name)
468 bandwidth_.scale = 1.0;
469 bandwidth_.peak = bandwidth;
470 this->set_constraint(system->constraint_new(this, bandwidth));
473 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
475 /* Find out which of my iterators was triggered, and react accordingly */
476 if (triggered == bandwidth_.event) {
477 set_bandwidth(value);
478 tmgr_trace_event_unref(&bandwidth_.event);
480 } else if (triggered == latency_.event) {
482 tmgr_trace_event_unref(&latency_.event);
484 } else if (triggered == get_state_event()) {
491 xbt_die("Unknown event!\n");
494 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
498 void NetworkCm02Link::set_bandwidth(double value)
500 double old_peak = bandwidth_.peak;
501 bandwidth_.peak = value;
503 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), (bandwidth_.peak * bandwidth_.scale));
505 StandardLinkImpl::on_bandwidth_change();
507 if (sg_weight_S_parameter > 0) {
508 double delta = sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale) -
509 sg_weight_S_parameter / (old_peak * bandwidth_.scale);
511 const kernel::lmm::Element* elem = nullptr;
512 const kernel::lmm::Element* nextelem = nullptr;
514 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
515 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
516 action->sharing_penalty_ += delta;
517 if (not action->is_suspended())
518 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
523 void NetworkCm02Link::set_latency(double value)
525 latency_check(value);
527 double delta = value - latency_.peak;
528 const kernel::lmm::Element* elem = nullptr;
529 const kernel::lmm::Element* nextelem = nullptr;
532 latency_.scale = 1.0;
533 latency_.peak = value;
535 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
536 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
537 action->lat_current_ += delta;
538 action->sharing_penalty_ += delta;
539 if (action->get_user_bound() < 0)
540 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
541 (2.0 * action->lat_current_));
543 get_model()->get_maxmin_system()->update_variable_bound(
544 action->get_variable(),
545 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
547 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
548 XBT_DEBUG("Flow is limited BYBANDWIDTH");
550 XBT_DEBUG("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
553 if (not action->is_suspended())
554 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
562 void NetworkCm02Action::update_remains_lazy(double now)
564 if (not is_running())
567 double delta = now - get_last_update();
569 if (get_remains_no_update() > 0) {
570 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
572 update_remains(get_last_value() * delta);
574 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
577 update_max_duration(delta);
579 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
580 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
581 finish(Action::State::FINISHED);
582 get_model()->get_action_heap().remove(this);
586 set_last_value(get_rate());
589 } // namespace resource
590 } // namespace kernel
591 } // namespace simgrid