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);
82 namespace simgrid::kernel::resource {
84 NetworkCm02Model::NetworkCm02Model(const std::string& name) : NetworkModel(name)
86 std::string optim = config::get_value<std::string>("network/optim");
87 bool select = config::get_value<bool>("network/maxmin-selective-update");
89 if (optim == "Lazy") {
90 set_update_algorithm(Model::UpdateAlgo::LAZY);
91 xbt_assert(select || config::is_default("network/maxmin-selective-update"),
92 "You cannot disable network selective update when using the lazy update mechanism");
96 set_maxmin_system(lmm::System::build(cfg_network_solver, select));
98 loopback_.reset(create_link("__loopback__", {config::get_value<double>("network/loopback-bw")}));
99 loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE, {});
100 loopback_->set_latency(config::get_value<double>("network/loopback-lat"));
101 loopback_->get_iface()->seal();
104 void NetworkCm02Model::check_lat_factor_cb()
106 if (not simgrid::config::is_default("network/latency-factor")) {
107 throw std::invalid_argument(
108 "NetworkModelIntf: Cannot mix network/latency-factor and callback configuration. Choose only one of them.");
112 void NetworkCm02Model::check_bw_factor_cb()
114 if (not simgrid::config::is_default("network/bandwidth-factor")) {
115 throw std::invalid_argument(
116 "NetworkModelIntf: Cannot mix network/bandwidth-factor and callback configuration. Choose only one of them.");
120 void NetworkCm02Model::set_lat_factor_cb(const std::function<NetworkFactorCb>& cb)
123 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
124 check_lat_factor_cb();
129 void NetworkCm02Model::set_bw_factor_cb(const std::function<NetworkFactorCb>& cb)
132 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
133 check_bw_factor_cb();
138 StandardLinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
140 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
141 auto link = new NetworkCm02Link(name, bandwidths[0], get_maxmin_system());
142 link->set_model(this);
146 StandardLinkImpl* NetworkCm02Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
148 auto link = new WifiLinkImpl(name, bandwidths, get_maxmin_system());
149 link->set_model(this);
153 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
155 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
156 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
157 XBT_DEBUG("Something happened to action %p", action);
159 // if I am wearing a latency hat
160 if (action->get_type() == ActionHeap::Type::latency) {
161 XBT_DEBUG("Latency paid for action %p. Activating", action);
162 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
163 get_action_heap().remove(action);
164 action->set_last_update();
166 // if I am wearing a max_duration or normal hat
167 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
168 // no need to communicate anymore
169 // assume that flows that reached max_duration have remaining of 0
170 XBT_DEBUG("Action %p finished", action);
171 action->finish(Action::State::FINISHED);
172 get_action_heap().remove(action);
177 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
179 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
180 auto& action = static_cast<NetworkCm02Action&>(*it);
181 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
182 XBT_DEBUG("Something happened to action %p", &action);
183 if (action.latency_ > 0) {
184 if (action.latency_ > delta) {
185 double_update(&action.latency_, delta, sg_surf_precision);
187 action.latency_ = 0.0;
189 if (action.latency_ <= 0.0 && not action.is_suspended())
190 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
193 if (not action.get_variable()->get_number_of_constraint()) {
194 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
195 * vivaldi. In such case, just make sure that the action completes immediately.
197 action.update_remains(action.get_remains());
199 action.update_remains(action.get_rate() * delta);
201 if (action.get_max_duration() != NO_MAX_DURATION)
202 action.update_max_duration(delta);
204 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
205 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
206 action.finish(Action::State::FINISHED);
211 void NetworkCm02Model::comm_action_expand_constraints(const s4u::Host* src, const s4u::Host* dst,
212 const NetworkCm02Action* action,
213 const std::vector<StandardLinkImpl*>& route,
214 const std::vector<StandardLinkImpl*>& back_route) const
216 /* expand route links constraints for route and back_route */
217 const WifiLinkImpl* src_wifi_link = nullptr;
218 const WifiLinkImpl* dst_wifi_link = nullptr;
219 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
220 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
222 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
223 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
226 /* WI-FI links needs special treatment, do it here */
227 if (src_wifi_link != nullptr) {
228 if (src_wifi_link->get_host_rate(src) > 0)
229 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
230 1.0 / src_wifi_link->get_host_rate(src));
232 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
236 if (dst_wifi_link != nullptr) {
237 if (dst_wifi_link->get_host_rate(dst) > 0)
238 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
239 1.0 / dst_wifi_link->get_host_rate(dst));
241 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
246 for (auto const* link : route) {
247 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
248 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
251 if (cfg_crosstraffic) {
252 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
253 if (dst_wifi_link != nullptr)
254 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
255 .05 / dst_wifi_link->get_host_rate(dst));
256 if (src_wifi_link != nullptr)
257 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
258 .05 / src_wifi_link->get_host_rate(src));
260 for (auto const* link : back_route) {
261 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
262 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
267 NetworkCm02Action* NetworkCm02Model::comm_action_create(s4u::Host* src, s4u::Host* dst, double size,
268 const std::vector<StandardLinkImpl*>& route, bool failed)
270 WifiLinkImpl* src_wifi_link = nullptr;
271 WifiLinkImpl* dst_wifi_link = nullptr;
272 /* many checks related to Wi-Fi links */
273 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
274 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
275 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
276 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
277 "WIFI link. Did you call link->set_host_rate()?",
278 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
280 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
281 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
282 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
283 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
284 "WIFI link. Did you call link->set_host_rate()?",
285 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
287 if (route.size() > 2)
288 for (unsigned i = 1; i < route.size() - 1; i++)
289 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
290 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
291 "not in between (it is at position %u out of %zu). "
292 "Did you declare an access_point in your WIFI zones?",
293 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
295 for (auto const* link : route) {
296 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
297 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
298 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
299 "at its end (meaning that it's attached to the dst");
303 /* create action and do some initializations */
304 NetworkCm02Action* action;
305 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
306 action = new NetworkCm02Action(this, *src, *dst, size, failed);
308 action = new WifiLinkAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
310 if (is_update_lazy()) {
311 action->set_last_update();
317 bool NetworkCm02Model::comm_get_route_info(const s4u::Host* src, const s4u::Host* dst, double& latency,
318 std::vector<StandardLinkImpl*>& route,
319 std::vector<StandardLinkImpl*>& back_route,
320 std::unordered_set<kernel::routing::NetZoneImpl*>& netzones) const
322 kernel::routing::NetZoneImpl::get_global_route_with_netzones(src->get_netpoint(), dst->get_netpoint(), route,
325 xbt_assert(not route.empty() || latency > 0,
326 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
327 src->get_cname(), dst->get_cname());
329 bool failed = std::any_of(route.begin(), route.end(), [](const StandardLinkImpl* link) { return not link->is_on(); });
331 if (not failed && cfg_crosstraffic) {
332 dst->route_to(src, back_route, nullptr);
333 failed = std::any_of(back_route.begin(), back_route.end(),
334 [](const StandardLinkImpl* link) { return not link->is_on(); });
339 void NetworkCm02Model::comm_action_set_bounds(const s4u::Host* src, const s4u::Host* dst, double size,
340 NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
341 const std::unordered_set<kernel::routing::NetZoneImpl*>& netzones,
344 std::vector<s4u::Link*> s4u_route;
345 std::unordered_set<s4u::NetZone*> s4u_netzones;
347 /* transform data to user structures if necessary */
348 if (lat_factor_cb_ || bw_factor_cb_) {
349 std::for_each(route.begin(), route.end(),
350 [&s4u_route](StandardLinkImpl* l) { s4u_route.push_back(l->get_iface()); });
351 std::for_each(netzones.begin(), netzones.end(),
352 [&s4u_netzones](kernel::routing::NetZoneImpl* n) { s4u_netzones.insert(n->get_iface()); });
356 bw_factor = bw_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
358 bw_factor = get_bandwidth_factor(size);
360 xbt_assert(bw_factor != 0, "Invalid param for comm %s -> %s. Bandwidth factor cannot be 0", src->get_cname(),
362 action->set_rate_factor(bw_factor);
364 /* get mininum bandwidth among links in the route and multiply by correct factor
365 * ignore wi-fi links, they're not considered for bw_factors */
366 double bandwidth_bound = -1.0;
367 for (const auto* l : route) {
368 if (l->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI)
370 if (bandwidth_bound == -1.0 || l->get_bandwidth() < bandwidth_bound)
371 bandwidth_bound = l->get_bandwidth();
374 /* increase rate given by user considering the factor, since the actual rate will be
376 rate = rate / bw_factor;
377 /* the bandwidth is determined by the minimum between flow and user's defined rate */
378 if (rate >= 0 && rate < bandwidth_bound)
379 bandwidth_bound = rate;
380 action->set_user_bound(bandwidth_bound);
382 action->lat_current_ = action->latency_;
383 if (lat_factor_cb_) {
384 action->latency_ *= lat_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
386 action->latency_ *= get_latency_factor(size);
390 void NetworkCm02Model::comm_action_set_variable(NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
391 const std::vector<StandardLinkImpl*>& back_route)
393 size_t constraints_per_variable = route.size();
394 constraints_per_variable += back_route.size();
396 if (action->latency_ > 0) {
397 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
398 if (is_update_lazy()) {
399 // add to the heap the event when the latency is paid
400 double date = action->latency_ + action->get_last_update();
402 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
404 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
405 get_action_heap().insert(action, date, type);
408 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
410 /* after setting the variable, update the bounds depending on user configuration */
411 if (action->get_user_bound() < 0) {
412 get_maxmin_system()->update_variable_bound(
413 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
415 get_maxmin_system()->update_variable_bound(
416 action->get_variable(), (action->lat_current_ > 0)
417 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
418 : action->get_user_bound());
422 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
424 double latency = 0.0;
425 std::vector<StandardLinkImpl*> back_route;
426 std::vector<StandardLinkImpl*> route;
427 std::unordered_set<kernel::routing::NetZoneImpl*> netzones;
429 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
431 bool failed = comm_get_route_info(src, dst, latency, route, back_route, netzones);
433 NetworkCm02Action* action = comm_action_create(src, dst, size, route, failed);
434 action->sharing_penalty_ = latency;
435 action->latency_ = latency;
437 if (sg_weight_S_parameter > 0) {
438 action->sharing_penalty_ = std::accumulate(route.begin(), route.end(), action->sharing_penalty_,
439 [](double total, StandardLinkImpl* const& link) {
440 return total + sg_weight_S_parameter / link->get_bandwidth();
444 /* setting bandwidth and latency bounds considering route and configured bw/lat factors */
445 comm_action_set_bounds(src, dst, size, action, route, netzones, rate);
447 /* creating the maxmin variable associated to this action */
448 comm_action_set_variable(action, route, back_route);
450 /* expand maxmin system to consider this communication in bw constraint for each link in route and back_route */
451 comm_action_expand_constraints(src, dst, action, route, back_route);
460 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, kernel::lmm::System* system)
461 : StandardLinkImpl(name)
463 bandwidth_.scale = 1.0;
464 bandwidth_.peak = bandwidth;
465 this->set_constraint(system->constraint_new(this, bandwidth));
468 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
470 /* Find out which of my iterators was triggered, and react accordingly */
471 if (triggered == bandwidth_.event) {
472 set_bandwidth(value);
473 tmgr_trace_event_unref(&bandwidth_.event);
475 } else if (triggered == latency_.event) {
477 tmgr_trace_event_unref(&latency_.event);
479 } else if (triggered == get_state_event()) {
486 xbt_die("Unknown event!\n");
489 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
493 void NetworkCm02Link::set_bandwidth(double value)
495 double old_peak = bandwidth_.peak;
496 bandwidth_.peak = value;
498 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), (bandwidth_.peak * bandwidth_.scale));
500 StandardLinkImpl::on_bandwidth_change();
502 if (sg_weight_S_parameter > 0) {
503 double delta = sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale) -
504 sg_weight_S_parameter / (old_peak * bandwidth_.scale);
506 const kernel::lmm::Element* elem = nullptr;
507 const kernel::lmm::Element* nextelem = nullptr;
509 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
510 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
511 action->sharing_penalty_ += delta;
512 if (not action->is_suspended())
513 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
518 void NetworkCm02Link::set_latency(double value)
520 latency_check(value);
522 double delta = value - latency_.peak;
523 const kernel::lmm::Element* elem = nullptr;
524 const kernel::lmm::Element* nextelem = nullptr;
527 latency_.scale = 1.0;
528 latency_.peak = value;
530 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
531 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
532 action->lat_current_ += delta;
533 action->sharing_penalty_ += delta;
534 if (action->get_user_bound() < 0)
535 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
536 (2.0 * action->lat_current_));
538 get_model()->get_maxmin_system()->update_variable_bound(
539 action->get_variable(),
540 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
542 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
543 XBT_DEBUG("Flow is limited BYBANDWIDTH");
545 XBT_DEBUG("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
548 if (not action->is_suspended())
549 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
557 void NetworkCm02Action::update_remains_lazy(double now)
559 if (not is_running())
562 double delta = now - get_last_update();
564 if (get_remains_no_update() > 0) {
565 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
567 update_remains(get_last_value() * delta);
569 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
572 update_max_duration(delta);
574 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
575 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
576 finish(Action::State::FINISHED);
577 get_model()->get_action_heap().remove(this);
581 set_last_value(get_rate());
584 } // namespace simgrid::kernel::resource