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. */
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/profile/Event.hpp"
13 #include "src/surf/network_wifi.hpp"
14 #include "src/surf/surf_interface.hpp"
15 #include "surf/surf.hpp"
20 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_network);
22 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
23 double sg_bandwidth_factor = 1.0; /* default value; can be set by model or from command line */
24 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
26 /************************************************************************/
27 /* New model based on optimizations discussed during Pedro Velho's thesis*/
28 /************************************************************************/
29 /* @techreport{VELHO:2011:HAL-00646896:1, */
30 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
31 /* title = {{Flow-level network models: have we reached the limits?}}, */
32 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
33 /* type = {Rapport de recherche}, */
34 /* institution = {INRIA}, */
35 /* number = {RR-7821}, */
38 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
40 void surf_network_model_init_LegrandVelho()
42 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_LegrandVelho");
43 auto* engine = simgrid::kernel::EngineImpl::get_instance();
44 engine->add_model(net_model);
45 engine->get_netzone_root()->set_network_model(net_model);
47 simgrid::config::set_default<double>("network/latency-factor", 13.01);
48 simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
49 simgrid::config::set_default<double>("network/weight-S", 20537);
52 /***************************************************************************/
53 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
54 /***************************************************************************/
55 /* @TechReport{ rr-lip2002-40, */
56 /* author = {Henri Casanova and Loris Marchal}, */
57 /* institution = {LIP}, */
58 /* title = {A Network Model for Simulation of Grid Application}, */
59 /* number = {2002-40}, */
63 void surf_network_model_init_CM02()
65 simgrid::config::set_default<double>("network/latency-factor", 1.0);
66 simgrid::config::set_default<double>("network/bandwidth-factor", 1.0);
67 simgrid::config::set_default<double>("network/weight-S", 0.0);
69 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_CM02");
70 auto* engine = simgrid::kernel::EngineImpl::get_instance();
71 engine->add_model(net_model);
72 engine->get_netzone_root()->set_network_model(net_model);
79 NetworkCm02Model::NetworkCm02Model(const std::string& name) : NetworkModel(name)
81 std::string optim = config::get_value<std::string>("network/optim");
82 bool select = config::get_value<bool>("network/maxmin-selective-update");
84 if (optim == "Lazy") {
85 set_update_algorithm(Model::UpdateAlgo::LAZY);
86 xbt_assert(select || config::is_default("network/maxmin-selective-update"),
87 "You cannot disable network selective update when using the lazy update mechanism");
91 set_maxmin_system(new lmm::System(select));
92 loopback_ = create_link("__loopback__", {config::get_value<double>("network/loopback-bw")});
93 loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE, {});
94 loopback_->set_latency(config::get_value<double>("network/loopback-lat"));
98 void NetworkCm02Model::check_lat_factor_cb()
100 if (not simgrid::config::is_default("network/latency-factor")) {
101 throw std::invalid_argument(
102 "NetworkModelIntf: Cannot mix network/latency-factor and callback configuration. Choose only one of them.");
106 void NetworkCm02Model::check_bw_factor_cb()
108 if (not simgrid::config::is_default("network/bandwidth-factor")) {
109 throw std::invalid_argument(
110 "NetworkModelIntf: Cannot mix network/bandwidth-factor and callback configuration. Choose only one of them.");
114 void NetworkCm02Model::set_lat_factor_cb(const std::function<NetworkFactorCb>& cb)
117 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
118 check_lat_factor_cb();
123 void NetworkCm02Model::set_bw_factor_cb(const std::function<NetworkFactorCb>& cb)
126 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
127 check_bw_factor_cb();
132 LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
134 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
135 auto link = new NetworkCm02Link(name, bandwidths[0], get_maxmin_system());
136 link->set_model(this);
140 LinkImpl* NetworkCm02Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
142 auto link = new NetworkWifiLink(name, bandwidths, get_maxmin_system());
143 link->set_model(this);
147 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
149 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
150 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
151 XBT_DEBUG("Something happened to action %p", action);
153 // if I am wearing a latency hat
154 if (action->get_type() == ActionHeap::Type::latency) {
155 XBT_DEBUG("Latency paid for action %p. Activating", action);
156 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
157 get_action_heap().remove(action);
158 action->set_last_update();
160 // if I am wearing a max_duration or normal hat
161 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
162 // no need to communicate anymore
163 // assume that flows that reached max_duration have remaining of 0
164 XBT_DEBUG("Action %p finished", action);
165 action->finish(Action::State::FINISHED);
166 get_action_heap().remove(action);
171 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
173 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
174 auto& action = static_cast<NetworkCm02Action&>(*it);
175 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
176 XBT_DEBUG("Something happened to action %p", &action);
177 double deltap = delta;
178 if (action.latency_ > 0) {
179 if (action.latency_ > deltap) {
180 double_update(&action.latency_, deltap, sg_surf_precision);
183 double_update(&deltap, action.latency_, sg_surf_precision);
184 action.latency_ = 0.0;
186 if (action.latency_ <= 0.0 && not action.is_suspended())
187 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
190 if (not action.get_variable()->get_number_of_constraint()) {
191 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
192 * vivaldi. In such case, just make sure that the action completes immediately.
194 action.update_remains(action.get_remains());
196 action.update_remains(action.get_rate() * delta);
198 if (action.get_max_duration() != NO_MAX_DURATION)
199 action.update_max_duration(delta);
201 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
202 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
203 action.finish(Action::State::FINISHED);
208 void NetworkCm02Model::comm_action_expand_constraints(const s4u::Host* src, const s4u::Host* dst,
209 const NetworkCm02Action* action,
210 const std::vector<LinkImpl*>& route,
211 const std::vector<LinkImpl*>& back_route) const
213 /* expand route links constraints for route and back_route */
214 const NetworkWifiLink* src_wifi_link = nullptr;
215 const NetworkWifiLink* dst_wifi_link = nullptr;
216 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
217 src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
219 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
220 dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
223 /* WI-FI links needs special treatment, do it here */
224 if (src_wifi_link != nullptr)
225 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
226 1.0 / src_wifi_link->get_host_rate(src));
227 if (dst_wifi_link != nullptr)
228 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
229 1.0 / dst_wifi_link->get_host_rate(dst));
231 for (auto const* link : route) {
232 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
233 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
236 if (cfg_crosstraffic) {
237 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
238 if (dst_wifi_link != nullptr)
239 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
240 .05 / dst_wifi_link->get_host_rate(dst));
241 if (src_wifi_link != nullptr)
242 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
243 .05 / src_wifi_link->get_host_rate(src));
245 for (auto const* link : back_route) {
246 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
247 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
249 // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
250 // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
251 // action->getVariable()->set_concurrency_share(2)
255 NetworkCm02Action* NetworkCm02Model::comm_action_create(s4u::Host* src, s4u::Host* dst, double size,
256 const std::vector<LinkImpl*>& route, bool failed)
258 NetworkWifiLink* src_wifi_link = nullptr;
259 NetworkWifiLink* dst_wifi_link = nullptr;
260 /* many checks related to Wi-Fi links */
261 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
262 src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
263 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
264 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
265 "WIFI link. Did you call link->set_host_rate()?",
266 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
268 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
269 dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
270 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
271 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
272 "WIFI link. Did you call link->set_host_rate()?",
273 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
275 if (route.size() > 2)
276 for (unsigned i = 1; i < route.size() - 1; i++)
277 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
278 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
279 "not in between (it is at position %u out of %zu). "
280 "Did you declare an access_point in your WIFI zones?",
281 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
283 for (auto const* link : route) {
284 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
285 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
286 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
287 "at its end (meaning that it's attached to the dst");
291 /* create action and do some initializations */
292 NetworkCm02Action* action;
293 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
294 action = new NetworkCm02Action(this, *src, *dst, size, failed);
296 action = new NetworkWifiAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
298 if (is_update_lazy()) {
299 action->set_last_update();
305 bool NetworkCm02Model::comm_get_route_info(const s4u::Host* src, const s4u::Host* dst, double& latency,
306 std::vector<LinkImpl*>& route, std::vector<LinkImpl*>& back_route,
307 std::unordered_set<kernel::routing::NetZoneImpl*>& netzones) const
309 kernel::routing::NetZoneImpl::get_global_route_with_netzones(src->get_netpoint(), dst->get_netpoint(), route,
312 xbt_assert(not route.empty() || latency > 0,
313 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
314 src->get_cname(), dst->get_cname());
316 bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
318 if (cfg_crosstraffic) {
319 dst->route_to(src, back_route, nullptr);
322 std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
327 void NetworkCm02Model::comm_action_set_bounds(const s4u::Host* src, const s4u::Host* dst, double size,
328 NetworkCm02Action* action, const std::vector<LinkImpl*>& route,
329 const std::unordered_set<kernel::routing::NetZoneImpl*>& netzones,
332 std::vector<s4u::Link*> s4u_route;
333 std::unordered_set<s4u::NetZone*> s4u_netzones;
335 /* transform data to user structures if necessary */
336 if (lat_factor_cb_ || bw_factor_cb_) {
337 std::for_each(route.begin(), route.end(), [&s4u_route](LinkImpl* l) { s4u_route.push_back(l->get_iface()); });
338 std::for_each(netzones.begin(), netzones.end(),
339 [&s4u_netzones](kernel::routing::NetZoneImpl* n) { s4u_netzones.insert(n->get_iface()); });
343 bw_factor = bw_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
345 bw_factor = get_bandwidth_factor(size);
347 xbt_assert(bw_factor != 0, "Invalid param for comm %s -> %s. Bandwidth factor cannot be 0", src->get_cname(),
349 action->set_rate_factor(bw_factor);
351 /* get mininum bandwidth among links in the route and multiply by correct factor
352 * ignore wi-fi links, they're not considered for bw_factors */
353 double bandwidth_bound = -1.0;
354 for (const auto* l : route) {
355 if (l->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI)
357 if (bandwidth_bound == -1.0 || l->get_bandwidth() < bandwidth_bound)
358 bandwidth_bound = l->get_bandwidth();
361 /* increase rate given by user considering the factor, since the actual rate will be
363 rate = rate / bw_factor;
364 /* the bandwidth is determined by the minimum between flow and user's defined rate */
365 if (rate >= 0 && rate < bandwidth_bound)
366 bandwidth_bound = rate;
367 action->set_user_bound(bandwidth_bound);
369 action->lat_current_ = action->latency_;
370 if (lat_factor_cb_) {
371 action->latency_ *= lat_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
373 action->latency_ *= get_latency_factor(size);
377 void NetworkCm02Model::comm_action_set_variable(NetworkCm02Action* action, const std::vector<LinkImpl*>& route,
378 const std::vector<LinkImpl*>& back_route)
380 size_t constraints_per_variable = route.size();
381 constraints_per_variable += back_route.size();
383 if (action->latency_ > 0) {
384 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
385 if (is_update_lazy()) {
386 // add to the heap the event when the latency is paid
387 double date = action->latency_ + action->get_last_update();
389 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
391 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
392 get_action_heap().insert(action, date, type);
395 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
397 /* after setting the variable, update the bounds depending on user configuration */
398 if (action->get_user_bound() < 0) {
399 get_maxmin_system()->update_variable_bound(
400 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
402 get_maxmin_system()->update_variable_bound(
403 action->get_variable(), (action->lat_current_ > 0)
404 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
405 : action->get_user_bound());
409 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
411 double latency = 0.0;
412 std::vector<LinkImpl*> back_route;
413 std::vector<LinkImpl*> route;
414 std::unordered_set<kernel::routing::NetZoneImpl*> netzones;
416 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
418 bool failed = comm_get_route_info(src, dst, latency, route, back_route, netzones);
420 NetworkCm02Action* action = comm_action_create(src, dst, size, route, failed);
421 action->sharing_penalty_ = latency;
422 action->latency_ = latency;
424 if (sg_weight_S_parameter > 0) {
425 action->sharing_penalty_ =
426 std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
427 return total + sg_weight_S_parameter / link->get_bandwidth();
431 /* setting bandwidth and latency bounds considering route and configured bw/lat factors */
432 comm_action_set_bounds(src, dst, size, action, route, netzones, rate);
434 /* creating the maxmin variable associated to this action */
435 comm_action_set_variable(action, route, back_route);
437 /* expand maxmin system to consider this communication in bw constraint for each link in route and back_route */
438 comm_action_expand_constraints(src, dst, action, route, back_route);
441 simgrid::s4u::Link::on_communicate(*action);
448 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, kernel::lmm::System* system)
451 bandwidth_.scale = 1.0;
452 bandwidth_.peak = bandwidth;
453 this->set_constraint(system->constraint_new(this, bandwidth));
456 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
458 /* Find out which of my iterators was triggered, and react accordingly */
459 if (triggered == bandwidth_.event) {
460 set_bandwidth(value);
461 tmgr_trace_event_unref(&bandwidth_.event);
463 } else if (triggered == latency_.event) {
465 tmgr_trace_event_unref(&latency_.event);
467 } else if (triggered == state_event_) {
472 tmgr_trace_event_unref(&state_event_);
474 xbt_die("Unknown event!\n");
477 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
481 void NetworkCm02Link::set_bandwidth(double value)
483 double old_peak = bandwidth_.peak;
484 bandwidth_.peak = value;
486 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), (bandwidth_.peak * bandwidth_.scale));
488 LinkImpl::on_bandwidth_change();
490 if (sg_weight_S_parameter > 0) {
491 double delta = sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale) -
492 sg_weight_S_parameter / (old_peak * bandwidth_.scale);
494 const kernel::lmm::Element* elem = nullptr;
495 const kernel::lmm::Element* nextelem = nullptr;
497 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
498 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
499 action->sharing_penalty_ += delta;
500 if (not action->is_suspended())
501 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
506 void NetworkCm02Link::set_latency(double value)
508 latency_check(value);
510 double delta = value - latency_.peak;
511 const kernel::lmm::Element* elem = nullptr;
512 const kernel::lmm::Element* nextelem = nullptr;
515 latency_.scale = 1.0;
516 latency_.peak = value;
518 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
519 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
520 action->lat_current_ += delta;
521 action->sharing_penalty_ += delta;
522 if (action->get_user_bound() < 0)
523 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
524 (2.0 * action->lat_current_));
526 get_model()->get_maxmin_system()->update_variable_bound(
527 action->get_variable(),
528 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
530 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
531 XBT_DEBUG("Flow is limited BYBANDWIDTH");
533 XBT_DEBUG("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
536 if (not action->is_suspended())
537 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
545 void NetworkCm02Action::update_remains_lazy(double now)
547 if (not is_running())
550 double delta = now - get_last_update();
552 if (get_remains_no_update() > 0) {
553 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
555 update_remains(get_last_value() * delta);
557 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
560 update_max_duration(delta);
562 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
563 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
564 finish(Action::State::FINISHED);
565 get_model()->get_action_heap().remove(this);
569 set_last_value(get_rate());
572 } // namespace resource
573 } // namespace kernel
574 } // namespace simgrid