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);
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(lmm::System::build("maxmin", select));
93 loopback_ = create_link("__loopback__", {config::get_value<double>("network/loopback-bw")});
94 loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE, {});
95 loopback_->set_latency(config::get_value<double>("network/loopback-lat"));
99 void NetworkCm02Model::check_lat_factor_cb()
101 if (not simgrid::config::is_default("network/latency-factor")) {
102 throw std::invalid_argument(
103 "NetworkModelIntf: Cannot mix network/latency-factor and callback configuration. Choose only one of them.");
107 void NetworkCm02Model::check_bw_factor_cb()
109 if (not simgrid::config::is_default("network/bandwidth-factor")) {
110 throw std::invalid_argument(
111 "NetworkModelIntf: Cannot mix network/bandwidth-factor and callback configuration. Choose only one of them.");
115 void NetworkCm02Model::set_lat_factor_cb(const std::function<NetworkFactorCb>& cb)
118 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
119 check_lat_factor_cb();
124 void NetworkCm02Model::set_bw_factor_cb(const std::function<NetworkFactorCb>& cb)
127 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
128 check_bw_factor_cb();
133 StandardLinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
135 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
136 auto link = new NetworkCm02Link(name, bandwidths[0], get_maxmin_system());
137 link->set_model(this);
141 StandardLinkImpl* NetworkCm02Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
143 auto link = new WifiLinkImpl(name, bandwidths, get_maxmin_system());
144 link->set_model(this);
148 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
150 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
151 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
152 XBT_DEBUG("Something happened to action %p", action);
154 // if I am wearing a latency hat
155 if (action->get_type() == ActionHeap::Type::latency) {
156 XBT_DEBUG("Latency paid for action %p. Activating", action);
157 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
158 get_action_heap().remove(action);
159 action->set_last_update();
161 // if I am wearing a max_duration or normal hat
162 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
163 // no need to communicate anymore
164 // assume that flows that reached max_duration have remaining of 0
165 XBT_DEBUG("Action %p finished", action);
166 action->finish(Action::State::FINISHED);
167 get_action_heap().remove(action);
172 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
174 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
175 auto& action = static_cast<NetworkCm02Action&>(*it);
176 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
177 XBT_DEBUG("Something happened to action %p", &action);
178 double deltap = delta;
179 if (action.latency_ > 0) {
180 if (action.latency_ > deltap) {
181 double_update(&action.latency_, deltap, sg_surf_precision);
184 double_update(&deltap, action.latency_, 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 /* In case of 0Mbps data rate, don't consider it in the LMM */
227 if (src_wifi_link->get_host_rate(src) > 0)
228 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
229 1.0 / src_wifi_link->get_host_rate(src));
231 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
233 if (dst_wifi_link != nullptr) {
234 if (dst_wifi_link->get_host_rate(dst) > 0)
235 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
236 1.0 / dst_wifi_link->get_host_rate(dst));
238 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
241 for (auto const* link : route) {
242 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
243 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
246 if (cfg_crosstraffic) {
247 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
248 if (dst_wifi_link != nullptr)
249 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
250 .05 / dst_wifi_link->get_host_rate(dst));
251 if (src_wifi_link != nullptr)
252 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
253 .05 / src_wifi_link->get_host_rate(src));
255 for (auto const* link : back_route) {
256 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
257 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
259 // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
260 // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
261 // action->getVariable()->set_concurrency_share(2)
265 NetworkCm02Action* NetworkCm02Model::comm_action_create(s4u::Host* src, s4u::Host* dst, double size,
266 const std::vector<StandardLinkImpl*>& route, bool failed)
268 WifiLinkImpl* src_wifi_link = nullptr;
269 WifiLinkImpl* dst_wifi_link = nullptr;
270 /* many checks related to Wi-Fi links */
271 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
272 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
273 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
274 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
275 "WIFI link. Did you call link->set_host_rate()?",
276 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
278 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
279 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
280 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
281 "The route from %s to %s ends 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(), dst_wifi_link->get_cname(), dst->get_cname());
285 if (route.size() > 2)
286 for (unsigned i = 1; i < route.size() - 1; i++)
287 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
288 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
289 "not in between (it is at position %u out of %zu). "
290 "Did you declare an access_point in your WIFI zones?",
291 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
293 for (auto const* link : route) {
294 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
295 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
296 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
297 "at its end (meaning that it's attached to the dst");
301 /* create action and do some initializations */
302 NetworkCm02Action* action;
303 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
304 action = new NetworkCm02Action(this, *src, *dst, size, failed);
306 action = new WifiLinkAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
308 if (is_update_lazy()) {
309 action->set_last_update();
315 bool NetworkCm02Model::comm_get_route_info(const s4u::Host* src, const s4u::Host* dst, double& latency,
316 std::vector<StandardLinkImpl*>& route,
317 std::vector<StandardLinkImpl*>& back_route,
318 std::unordered_set<kernel::routing::NetZoneImpl*>& netzones) const
320 kernel::routing::NetZoneImpl::get_global_route_with_netzones(src->get_netpoint(), dst->get_netpoint(), route,
323 xbt_assert(not route.empty() || latency > 0,
324 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
325 src->get_cname(), dst->get_cname());
327 bool failed = std::any_of(route.begin(), route.end(), [](const StandardLinkImpl* link) { return not link->is_on(); });
329 if (not failed && cfg_crosstraffic) {
330 dst->route_to(src, back_route, nullptr);
331 failed = std::any_of(back_route.begin(), back_route.end(),
332 [](const StandardLinkImpl* link) { return not link->is_on(); });
337 void NetworkCm02Model::comm_action_set_bounds(const s4u::Host* src, const s4u::Host* dst, double size,
338 NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
339 const std::unordered_set<kernel::routing::NetZoneImpl*>& netzones,
342 std::vector<s4u::Link*> s4u_route;
343 std::unordered_set<s4u::NetZone*> s4u_netzones;
345 /* transform data to user structures if necessary */
346 if (lat_factor_cb_ || bw_factor_cb_) {
347 std::for_each(route.begin(), route.end(),
348 [&s4u_route](StandardLinkImpl* l) { s4u_route.push_back(l->get_iface()); });
349 std::for_each(netzones.begin(), netzones.end(),
350 [&s4u_netzones](kernel::routing::NetZoneImpl* n) { s4u_netzones.insert(n->get_iface()); });
354 bw_factor = bw_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
356 bw_factor = get_bandwidth_factor(size);
358 xbt_assert(bw_factor != 0, "Invalid param for comm %s -> %s. Bandwidth factor cannot be 0", src->get_cname(),
360 action->set_rate_factor(bw_factor);
362 /* get mininum bandwidth among links in the route and multiply by correct factor
363 * ignore wi-fi links, they're not considered for bw_factors */
364 double bandwidth_bound = -1.0;
365 for (const auto* l : route) {
366 if (l->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI)
368 if (bandwidth_bound == -1.0 || l->get_bandwidth() < bandwidth_bound)
369 bandwidth_bound = l->get_bandwidth();
372 /* increase rate given by user considering the factor, since the actual rate will be
374 rate = rate / bw_factor;
375 /* the bandwidth is determined by the minimum between flow and user's defined rate */
376 if (rate >= 0 && rate < bandwidth_bound)
377 bandwidth_bound = rate;
378 action->set_user_bound(bandwidth_bound);
380 action->lat_current_ = action->latency_;
381 if (lat_factor_cb_) {
382 action->latency_ *= lat_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
384 action->latency_ *= get_latency_factor(size);
388 void NetworkCm02Model::comm_action_set_variable(NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
389 const std::vector<StandardLinkImpl*>& back_route)
391 size_t constraints_per_variable = route.size();
392 constraints_per_variable += back_route.size();
394 if (action->latency_ > 0) {
395 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
396 if (is_update_lazy()) {
397 // add to the heap the event when the latency is paid
398 double date = action->latency_ + action->get_last_update();
400 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
402 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
403 get_action_heap().insert(action, date, type);
406 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
408 /* after setting the variable, update the bounds depending on user configuration */
409 if (action->get_user_bound() < 0) {
410 get_maxmin_system()->update_variable_bound(
411 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
413 get_maxmin_system()->update_variable_bound(
414 action->get_variable(), (action->lat_current_ > 0)
415 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
416 : action->get_user_bound());
420 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
422 double latency = 0.0;
423 std::vector<StandardLinkImpl*> back_route;
424 std::vector<StandardLinkImpl*> route;
425 std::unordered_set<kernel::routing::NetZoneImpl*> netzones;
427 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
429 bool failed = comm_get_route_info(src, dst, latency, route, back_route, netzones);
431 NetworkCm02Action* action = comm_action_create(src, dst, size, route, failed);
432 action->sharing_penalty_ = latency;
433 action->latency_ = latency;
435 if (sg_weight_S_parameter > 0) {
436 action->sharing_penalty_ = std::accumulate(route.begin(), route.end(), action->sharing_penalty_,
437 [](double total, StandardLinkImpl* const& link) {
438 return total + sg_weight_S_parameter / link->get_bandwidth();
442 /* setting bandwidth and latency bounds considering route and configured bw/lat factors */
443 comm_action_set_bounds(src, dst, size, action, route, netzones, rate);
445 /* creating the maxmin variable associated to this action */
446 comm_action_set_variable(action, route, back_route);
448 /* expand maxmin system to consider this communication in bw constraint for each link in route and back_route */
449 comm_action_expand_constraints(src, dst, action, route, back_route);
458 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, kernel::lmm::System* system)
459 : StandardLinkImpl(name)
461 bandwidth_.scale = 1.0;
462 bandwidth_.peak = bandwidth;
463 this->set_constraint(system->constraint_new(this, bandwidth));
466 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
468 /* Find out which of my iterators was triggered, and react accordingly */
469 if (triggered == bandwidth_.event) {
470 set_bandwidth(value);
471 tmgr_trace_event_unref(&bandwidth_.event);
473 } else if (triggered == latency_.event) {
475 tmgr_trace_event_unref(&latency_.event);
477 } else if (triggered == get_state_event()) {
484 xbt_die("Unknown event!\n");
487 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
491 void NetworkCm02Link::set_bandwidth(double value)
493 double old_peak = bandwidth_.peak;
494 bandwidth_.peak = value;
496 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), (bandwidth_.peak * bandwidth_.scale));
498 StandardLinkImpl::on_bandwidth_change();
500 if (sg_weight_S_parameter > 0) {
501 double delta = sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale) -
502 sg_weight_S_parameter / (old_peak * bandwidth_.scale);
504 const kernel::lmm::Element* elem = nullptr;
505 const kernel::lmm::Element* nextelem = nullptr;
507 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
508 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
509 action->sharing_penalty_ += delta;
510 if (not action->is_suspended())
511 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
516 void NetworkCm02Link::set_latency(double value)
518 latency_check(value);
520 double delta = value - latency_.peak;
521 const kernel::lmm::Element* elem = nullptr;
522 const kernel::lmm::Element* nextelem = nullptr;
525 latency_.scale = 1.0;
526 latency_.peak = value;
528 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
529 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
530 action->lat_current_ += delta;
531 action->sharing_penalty_ += delta;
532 if (action->get_user_bound() < 0)
533 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
534 (2.0 * action->lat_current_));
536 get_model()->get_maxmin_system()->update_variable_bound(
537 action->get_variable(),
538 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
540 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
541 XBT_DEBUG("Flow is limited BYBANDWIDTH");
543 XBT_DEBUG("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
546 if (not action->is_suspended())
547 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
555 void NetworkCm02Action::update_remains_lazy(double now)
557 if (not is_running())
560 double delta = now - get_last_update();
562 if (get_remains_no_update() > 0) {
563 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
565 update_remains(get_last_value() * delta);
567 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
570 update_max_duration(delta);
572 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
573 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
574 finish(Action::State::FINISHED);
575 get_model()->get_action_heap().remove(this);
579 set_last_value(get_rate());
582 } // namespace resource
583 } // namespace kernel
584 } // namespace simgrid