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"
19 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_network);
21 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
22 double sg_bandwidth_factor = 1.0; /* default value; can be set by model or from command line */
23 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
25 /************************************************************************/
26 /* New model based on optimizations discussed during Pedro Velho's thesis*/
27 /************************************************************************/
28 /* @techreport{VELHO:2011:HAL-00646896:1, */
29 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
30 /* title = {{Flow-level network models: have we reached the limits?}}, */
31 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
32 /* type = {Rapport de recherche}, */
33 /* institution = {INRIA}, */
34 /* number = {RR-7821}, */
37 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
39 void surf_network_model_init_LegrandVelho()
41 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_LegrandVelho");
42 auto* engine = simgrid::kernel::EngineImpl::get_instance();
43 engine->add_model(net_model);
44 engine->get_netzone_root()->set_network_model(net_model);
46 simgrid::config::set_default<double>("network/latency-factor", 13.01);
47 simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
48 simgrid::config::set_default<double>("network/weight-S", 20537);
51 /***************************************************************************/
52 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
53 /***************************************************************************/
54 /* @TechReport{ rr-lip2002-40, */
55 /* author = {Henri Casanova and Loris Marchal}, */
56 /* institution = {LIP}, */
57 /* title = {A Network Model for Simulation of Grid Application}, */
58 /* number = {2002-40}, */
62 void surf_network_model_init_CM02()
64 simgrid::config::set_default<double>("network/latency-factor", 1.0);
65 simgrid::config::set_default<double>("network/bandwidth-factor", 1.0);
66 simgrid::config::set_default<double>("network/weight-S", 0.0);
68 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_CM02");
69 auto* engine = simgrid::kernel::EngineImpl::get_instance();
70 engine->add_model(net_model);
71 engine->get_netzone_root()->set_network_model(net_model);
78 NetworkCm02Model::NetworkCm02Model(const std::string& name) : NetworkModel(name)
80 std::string optim = config::get_value<std::string>("network/optim");
81 bool select = config::get_value<bool>("network/maxmin-selective-update");
83 if (optim == "Lazy") {
84 set_update_algorithm(Model::UpdateAlgo::LAZY);
85 xbt_assert(select || config::is_default("network/maxmin-selective-update"),
86 "You cannot disable network selective update when using the lazy update mechanism");
90 set_maxmin_system(new lmm::System(select));
91 loopback_ = create_link("__loopback__", {config::get_value<double>("network/loopback-bw")});
92 loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE, {});
93 loopback_->set_latency(config::get_value<double>("network/loopback-lat"));
97 void NetworkCm02Model::check_lat_factor_cb()
99 if (not simgrid::config::is_default("network/latency-factor")) {
100 throw std::invalid_argument(
101 "NetworkModelIntf: Cannot mix network/latency-factor and callback configuration. Choose only one of them.");
105 void NetworkCm02Model::check_bw_factor_cb()
107 if (not simgrid::config::is_default("network/bandwidth-factor")) {
108 throw std::invalid_argument(
109 "NetworkModelIntf: Cannot mix network/bandwidth-factor and callback configuration. Choose only one of them.");
113 void NetworkCm02Model::set_lat_factor_cb(const std::function<NetworkFactorCb>& cb)
116 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
117 check_lat_factor_cb();
122 void NetworkCm02Model::set_bw_factor_cb(const std::function<NetworkFactorCb>& cb)
125 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
126 check_bw_factor_cb();
131 LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
133 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
134 auto link = new NetworkCm02Link(name, bandwidths[0], get_maxmin_system());
135 link->set_model(this);
139 LinkImpl* NetworkCm02Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
141 auto link = new NetworkWifiLink(name, bandwidths, get_maxmin_system());
142 link->set_model(this);
146 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
148 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
149 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
150 XBT_DEBUG("Something happened to action %p", action);
152 // if I am wearing a latency hat
153 if (action->get_type() == ActionHeap::Type::latency) {
154 XBT_DEBUG("Latency paid for action %p. Activating", action);
155 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
156 get_action_heap().remove(action);
157 action->set_last_update();
159 // if I am wearing a max_duration or normal hat
160 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
161 // no need to communicate anymore
162 // assume that flows that reached max_duration have remaining of 0
163 XBT_DEBUG("Action %p finished", action);
164 action->finish(Action::State::FINISHED);
165 get_action_heap().remove(action);
170 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
172 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
173 auto& action = static_cast<NetworkCm02Action&>(*it);
174 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
175 XBT_DEBUG("Something happened to action %p", &action);
176 double deltap = delta;
177 if (action.latency_ > 0) {
178 if (action.latency_ > deltap) {
179 double_update(&action.latency_, deltap, sg_surf_precision);
182 double_update(&deltap, action.latency_, sg_surf_precision);
183 action.latency_ = 0.0;
185 if (action.latency_ <= 0.0 && not action.is_suspended())
186 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
189 if (not action.get_variable()->get_number_of_constraint()) {
190 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
191 * vivaldi. In such case, just make sure that the action completes immediately.
193 action.update_remains(action.get_remains());
195 action.update_remains(action.get_rate() * delta);
197 if (action.get_max_duration() != NO_MAX_DURATION)
198 action.update_max_duration(delta);
200 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
201 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
202 action.finish(Action::State::FINISHED);
207 void NetworkCm02Model::comm_action_expand_constraints(const s4u::Host* src, const s4u::Host* dst,
208 const NetworkCm02Action* action,
209 const std::vector<LinkImpl*>& route,
210 const std::vector<LinkImpl*>& back_route) const
212 /* expand route links constraints for route and back_route */
213 const NetworkWifiLink* src_wifi_link = nullptr;
214 const NetworkWifiLink* dst_wifi_link = nullptr;
215 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
216 src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
218 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
219 dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
222 /* WI-FI links needs special treatment, do it here */
223 if (src_wifi_link != nullptr)
224 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
225 1.0 / src_wifi_link->get_host_rate(src));
226 if (dst_wifi_link != nullptr)
227 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
228 1.0 / dst_wifi_link->get_host_rate(dst));
230 for (auto const* link : route) {
231 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
232 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
235 if (cfg_crosstraffic) {
236 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
237 if (dst_wifi_link != nullptr)
238 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
239 .05 / dst_wifi_link->get_host_rate(dst));
240 if (src_wifi_link != nullptr)
241 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
242 .05 / src_wifi_link->get_host_rate(src));
244 for (auto const* link : back_route) {
245 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
246 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
248 // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
249 // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
250 // action->getVariable()->set_concurrency_share(2)
254 NetworkCm02Action* NetworkCm02Model::comm_action_create(s4u::Host* src, s4u::Host* dst, double size,
255 const std::vector<LinkImpl*>& route, bool failed)
257 NetworkWifiLink* src_wifi_link = nullptr;
258 NetworkWifiLink* dst_wifi_link = nullptr;
259 /* many checks related to Wi-Fi links */
260 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
261 src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
262 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
263 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
264 "WIFI link. Did you call link->set_host_rate()?",
265 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
267 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
268 dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
269 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
270 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
271 "WIFI link. Did you call link->set_host_rate()?",
272 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
274 if (route.size() > 2)
275 for (unsigned i = 1; i < route.size() - 1; i++)
276 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
277 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
278 "not in between (it is at position %u out of %zu). "
279 "Did you declare an access_point in your WIFI zones?",
280 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
282 for (auto const* link : route) {
283 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
284 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
285 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
286 "at its end (meaning that it's attached to the dst");
290 /* create action and do some initializations */
291 NetworkCm02Action* action;
292 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
293 action = new NetworkCm02Action(this, *src, *dst, size, failed);
295 action = new NetworkWifiAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
297 if (is_update_lazy()) {
298 action->set_last_update();
304 bool NetworkCm02Model::comm_get_route_info(const s4u::Host* src, const s4u::Host* dst, double& latency,
305 std::vector<LinkImpl*>& route, std::vector<LinkImpl*>& back_route,
306 std::unordered_set<kernel::routing::NetZoneImpl*>& netzones) const
308 kernel::routing::NetZoneImpl::get_global_route_with_netzones(src->get_netpoint(), dst->get_netpoint(), route,
311 xbt_assert(not route.empty() || latency > 0,
312 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
313 src->get_cname(), dst->get_cname());
315 bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
317 if (cfg_crosstraffic) {
318 dst->route_to(src, back_route, nullptr);
321 std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
326 void NetworkCm02Model::comm_action_set_bounds(const s4u::Host* src, const s4u::Host* dst, double size,
327 NetworkCm02Action* action, const std::vector<LinkImpl*>& route,
328 const std::unordered_set<kernel::routing::NetZoneImpl*>& netzones,
331 std::vector<s4u::Link*> s4u_route;
332 std::unordered_set<s4u::NetZone*> s4u_netzones;
334 /* transform data to user structures if necessary */
335 if (lat_factor_cb_ || bw_factor_cb_) {
336 std::for_each(route.begin(), route.end(), [&s4u_route](LinkImpl* l) { s4u_route.push_back(l->get_iface()); });
337 std::for_each(netzones.begin(), netzones.end(),
338 [&s4u_netzones](kernel::routing::NetZoneImpl* n) { s4u_netzones.insert(n->get_iface()); });
342 bw_factor = bw_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
344 bw_factor = get_bandwidth_factor(size);
346 xbt_assert(bw_factor != 0, "Invalid param for comm %s -> %s. Bandwidth factor cannot be 0", src->get_cname(),
348 action->set_rate_factor(bw_factor);
350 /* get mininum bandwidth among links in the route and multiply by correct factor
351 * ignore wi-fi links, they're not considered for bw_factors */
352 double bandwidth_bound = -1.0;
353 for (const auto* l : route) {
354 if (l->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI)
356 if (bandwidth_bound == -1.0 || l->get_bandwidth() < bandwidth_bound)
357 bandwidth_bound = l->get_bandwidth();
360 /* increase rate given by user considering the factor, since the actual rate will be
362 rate = rate / bw_factor;
363 /* the bandwidth is determined by the minimum between flow and user's defined rate */
364 if (rate >= 0 && rate < bandwidth_bound)
365 bandwidth_bound = rate;
366 action->set_user_bound(bandwidth_bound);
368 action->lat_current_ = action->latency_;
369 if (lat_factor_cb_) {
370 action->latency_ *= lat_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
372 action->latency_ *= get_latency_factor(size);
376 void NetworkCm02Model::comm_action_set_variable(NetworkCm02Action* action, const std::vector<LinkImpl*>& route,
377 const std::vector<LinkImpl*>& back_route)
379 size_t constraints_per_variable = route.size();
380 constraints_per_variable += back_route.size();
382 if (action->latency_ > 0) {
383 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
384 if (is_update_lazy()) {
385 // add to the heap the event when the latency is paid
386 double date = action->latency_ + action->get_last_update();
388 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
390 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
391 get_action_heap().insert(action, date, type);
394 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
396 /* after setting the variable, update the bounds depending on user configuration */
397 if (action->get_user_bound() < 0) {
398 get_maxmin_system()->update_variable_bound(
399 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
401 get_maxmin_system()->update_variable_bound(
402 action->get_variable(), (action->lat_current_ > 0)
403 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
404 : action->get_user_bound());
408 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
410 double latency = 0.0;
411 std::vector<LinkImpl*> back_route;
412 std::vector<LinkImpl*> route;
413 std::unordered_set<kernel::routing::NetZoneImpl*> netzones;
415 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
417 bool failed = comm_get_route_info(src, dst, latency, route, back_route, netzones);
419 NetworkCm02Action* action = comm_action_create(src, dst, size, route, failed);
420 action->sharing_penalty_ = latency;
421 action->latency_ = latency;
423 if (sg_weight_S_parameter > 0) {
424 action->sharing_penalty_ =
425 std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
426 return total + sg_weight_S_parameter / link->get_bandwidth();
430 /* setting bandwidth and latency bounds considering route and configured bw/lat factors */
431 comm_action_set_bounds(src, dst, size, action, route, netzones, rate);
433 /* creating the maxmin variable associated to this action */
434 comm_action_set_variable(action, route, back_route);
436 /* expand maxmin system to consider this communication in bw constraint for each link in route and back_route */
437 comm_action_expand_constraints(src, dst, action, route, back_route);
446 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, kernel::lmm::System* system)
449 bandwidth_.scale = 1.0;
450 bandwidth_.peak = bandwidth;
451 this->set_constraint(system->constraint_new(this, bandwidth));
454 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
456 /* Find out which of my iterators was triggered, and react accordingly */
457 if (triggered == bandwidth_.event) {
458 set_bandwidth(value);
459 tmgr_trace_event_unref(&bandwidth_.event);
461 } else if (triggered == latency_.event) {
463 tmgr_trace_event_unref(&latency_.event);
465 } else if (triggered == get_state_event()) {
472 xbt_die("Unknown event!\n");
475 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
479 void NetworkCm02Link::set_bandwidth(double value)
481 double old_peak = bandwidth_.peak;
482 bandwidth_.peak = value;
484 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), (bandwidth_.peak * bandwidth_.scale));
486 LinkImpl::on_bandwidth_change();
488 if (sg_weight_S_parameter > 0) {
489 double delta = sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale) -
490 sg_weight_S_parameter / (old_peak * bandwidth_.scale);
492 const kernel::lmm::Element* elem = nullptr;
493 const kernel::lmm::Element* nextelem = nullptr;
495 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
496 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
497 action->sharing_penalty_ += delta;
498 if (not action->is_suspended())
499 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
504 void NetworkCm02Link::set_latency(double value)
506 latency_check(value);
508 double delta = value - latency_.peak;
509 const kernel::lmm::Element* elem = nullptr;
510 const kernel::lmm::Element* nextelem = nullptr;
513 latency_.scale = 1.0;
514 latency_.peak = value;
516 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
517 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
518 action->lat_current_ += delta;
519 action->sharing_penalty_ += delta;
520 if (action->get_user_bound() < 0)
521 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
522 (2.0 * action->lat_current_));
524 get_model()->get_maxmin_system()->update_variable_bound(
525 action->get_variable(),
526 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
528 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
529 XBT_DEBUG("Flow is limited BYBANDWIDTH");
531 XBT_DEBUG("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
534 if (not action->is_suspended())
535 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
543 void NetworkCm02Action::update_remains_lazy(double now)
545 if (not is_running())
548 double delta = now - get_last_update();
550 if (get_remains_no_update() > 0) {
551 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
553 update_remains(get_last_value() * delta);
555 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
558 update_max_duration(delta);
560 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
561 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
562 finish(Action::State::FINISHED);
563 get_model()->get_action_heap().remove(this);
567 set_last_value(get_rate());
570 } // namespace resource
571 } // namespace kernel
572 } // namespace simgrid