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 simgrid::kernel::EngineImpl::get_instance()->add_model(net_model);
44 simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->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 simgrid::kernel::EngineImpl::get_instance()->add_model(net_model);
70 simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_network_model(net_model);
77 NetworkCm02Model::NetworkCm02Model(const std::string& name) : NetworkModel(name)
79 std::string optim = config::get_value<std::string>("network/optim");
80 bool select = config::get_value<bool>("network/maxmin-selective-update");
82 if (optim == "Lazy") {
83 set_update_algorithm(Model::UpdateAlgo::LAZY);
84 xbt_assert(select || config::is_default("network/maxmin-selective-update"),
85 "You cannot disable network selective update when using the lazy update mechanism");
89 set_maxmin_system(new lmm::System(select));
90 loopback_ = create_link("__loopback__", std::vector<double>{config::get_value<double>("network/loopback-bw")});
91 loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE);
92 loopback_->set_latency(config::get_value<double>("network/loopback-lat"));
96 void NetworkCm02Model::check_lat_factor_cb()
98 if (not simgrid::config::is_default("network/latency-factor")) {
99 throw std::invalid_argument(
100 "NetworkModelIntf: Cannot mix network/latency-factor and callback configuration. Choose only one of them.");
104 void NetworkCm02Model::check_bw_factor_cb()
106 if (not simgrid::config::is_default("network/bandwidth-factor")) {
107 throw std::invalid_argument(
108 "NetworkModelIntf: Cannot mix network/bandwidth-factor and callback configuration. Choose only one of them.");
112 void NetworkCm02Model::set_lat_factor_cb(const std::function<NetworkFactorCb>& cb)
115 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
116 check_lat_factor_cb();
121 void NetworkCm02Model::set_bw_factor_cb(const std::function<NetworkFactorCb>& cb)
124 throw std::invalid_argument("NetworkModelIntf: Invalid callback");
125 check_bw_factor_cb();
130 LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
132 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
133 auto link = new NetworkCm02Link(name, bandwidths[0], get_maxmin_system());
134 link->set_model(this);
138 LinkImpl* NetworkCm02Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
140 auto link = new NetworkWifiLink(name, bandwidths, get_maxmin_system());
141 link->set_model(this);
145 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
147 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
148 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
149 XBT_DEBUG("Something happened to action %p", action);
151 // if I am wearing a latency hat
152 if (action->get_type() == ActionHeap::Type::latency) {
153 XBT_DEBUG("Latency paid for action %p. Activating", action);
154 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
155 get_action_heap().remove(action);
156 action->set_last_update();
158 // if I am wearing a max_duration or normal hat
159 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
160 // no need to communicate anymore
161 // assume that flows that reached max_duration have remaining of 0
162 XBT_DEBUG("Action %p finished", action);
163 action->finish(Action::State::FINISHED);
164 get_action_heap().remove(action);
169 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
171 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
172 auto& action = static_cast<NetworkCm02Action&>(*it);
173 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
174 XBT_DEBUG("Something happened to action %p", &action);
175 double deltap = delta;
176 if (action.latency_ > 0) {
177 if (action.latency_ > deltap) {
178 double_update(&action.latency_, deltap, sg_surf_precision);
181 double_update(&deltap, action.latency_, sg_surf_precision);
182 action.latency_ = 0.0;
184 if (action.latency_ <= 0.0 && not action.is_suspended())
185 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
188 if (not action.get_variable()->get_number_of_constraint()) {
189 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
190 * vivaldi. In such case, just make sure that the action completes immediately.
192 action.update_remains(action.get_remains());
194 action.update_remains(action.get_rate() * delta);
196 if (action.get_max_duration() != NO_MAX_DURATION)
197 action.update_max_duration(delta);
199 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
200 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
201 action.finish(Action::State::FINISHED);
206 void NetworkCm02Model::comm_action_expand_constraints(const s4u::Host* src, const s4u::Host* dst,
207 const NetworkCm02Action* action,
208 const std::vector<LinkImpl*>& route,
209 const std::vector<LinkImpl*>& back_route) const
211 /* expand route links constraints for route and back_route */
212 const NetworkWifiLink* src_wifi_link = nullptr;
213 const NetworkWifiLink* dst_wifi_link = nullptr;
214 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
215 src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
217 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
218 dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
221 /* WI-FI links needs special treatment, do it here */
222 if (src_wifi_link != nullptr)
223 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
224 1.0 / src_wifi_link->get_host_rate(src));
225 if (dst_wifi_link != nullptr)
226 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
227 1.0 / dst_wifi_link->get_host_rate(dst));
229 for (auto const* link : route) {
230 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
231 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
234 if (cfg_crosstraffic) {
235 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
236 if (dst_wifi_link != nullptr)
237 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
238 .05 / dst_wifi_link->get_host_rate(dst));
239 if (src_wifi_link != nullptr)
240 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
241 .05 / src_wifi_link->get_host_rate(src));
243 for (auto const* link : back_route) {
244 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
245 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
247 // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
248 // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
249 // action->getVariable()->set_concurrency_share(2)
253 NetworkCm02Action* NetworkCm02Model::comm_action_create(s4u::Host* src, s4u::Host* dst, double size,
254 const std::vector<LinkImpl*>& route, bool failed)
256 NetworkWifiLink* src_wifi_link = nullptr;
257 NetworkWifiLink* dst_wifi_link = nullptr;
258 /* many checks related to Wi-Fi links */
259 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
260 src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
261 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
262 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
263 "WIFI link. Did you call link->set_host_rate()?",
264 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
266 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
267 dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
268 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
269 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
270 "WIFI link. Did you call link->set_host_rate()?",
271 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
273 if (route.size() > 2)
274 for (unsigned i = 1; i < route.size() - 1; i++)
275 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
276 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
277 "not in between (it is at position %u out of %zu). "
278 "Did you declare an access_point in your WIFI zones?",
279 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
281 for (auto const* link : route) {
282 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
283 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
284 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
285 "at its end (meaning that it's attached to the dst");
289 /* create action and do some initializations */
290 NetworkCm02Action* action;
291 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
292 action = new NetworkCm02Action(this, *src, *dst, size, failed);
294 action = new NetworkWifiAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
296 if (is_update_lazy()) {
297 action->set_last_update();
303 bool NetworkCm02Model::comm_get_route_info(const s4u::Host* src, const s4u::Host* dst, double& latency,
304 std::vector<LinkImpl*>& route, std::vector<LinkImpl*>& back_route,
305 std::unordered_set<kernel::routing::NetZoneImpl*>& netzones) const
307 kernel::routing::NetZoneImpl::get_global_route_with_netzones(src->get_netpoint(), dst->get_netpoint(), route,
310 xbt_assert(not route.empty() || latency > 0,
311 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
312 src->get_cname(), dst->get_cname());
314 bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
316 if (cfg_crosstraffic) {
317 dst->route_to(src, back_route, nullptr);
320 std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
325 void NetworkCm02Model::comm_action_set_bounds(const s4u::Host* src, const s4u::Host* dst, double size,
326 NetworkCm02Action* action, const std::vector<LinkImpl*>& route,
327 const std::unordered_set<kernel::routing::NetZoneImpl*>& netzones,
330 std::vector<s4u::Link*> s4u_route;
331 std::unordered_set<s4u::NetZone*> s4u_netzones;
333 /* transform data to user structures if necessary */
334 if (lat_factor_cb_ || bw_factor_cb_) {
335 std::for_each(route.begin(), route.end(), [&s4u_route](LinkImpl* l) { s4u_route.push_back(l->get_iface()); });
336 std::for_each(netzones.begin(), netzones.end(),
337 [&s4u_netzones](kernel::routing::NetZoneImpl* n) { s4u_netzones.insert(n->get_iface()); });
341 bw_factor = bw_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
343 bw_factor = get_bandwidth_factor(size);
345 xbt_assert(bw_factor != 0, "Invalid param for comm %s -> %s. Bandwidth factor cannot be 0", src->get_cname(),
347 action->set_rate_factor(bw_factor);
349 /* get mininum bandwidth among links in the route and multiply by correct factor
350 * ignore wi-fi links, they're not considered for bw_factors */
351 double bandwidth_bound = -1.0;
352 for (const auto* l : route) {
353 if (l->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI)
355 if (bandwidth_bound == -1.0 || l->get_bandwidth() < bandwidth_bound)
356 bandwidth_bound = l->get_bandwidth();
359 /* increase rate given by user considering the factor, since the actual rate will be
361 rate = rate / bw_factor;
362 /* the bandwidth is determined by the minimum between flow and user's defined rate */
363 if (rate >= 0 && rate < bandwidth_bound)
364 bandwidth_bound = rate;
365 action->set_user_bound(bandwidth_bound);
367 action->lat_current_ = action->latency_;
368 if (lat_factor_cb_) {
369 action->latency_ *= lat_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
371 action->latency_ *= get_latency_factor(size);
375 void NetworkCm02Model::comm_action_set_variable(NetworkCm02Action* action, const std::vector<LinkImpl*>& route,
376 const std::vector<LinkImpl*>& back_route)
378 size_t constraints_per_variable = route.size();
379 constraints_per_variable += back_route.size();
381 if (action->latency_ > 0) {
382 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
383 if (is_update_lazy()) {
384 // add to the heap the event when the latency is paid
385 double date = action->latency_ + action->get_last_update();
387 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
389 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
390 get_action_heap().insert(action, date, type);
393 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
395 /* after setting the variable, update the bounds depending on user configuration */
396 if (action->get_user_bound() < 0) {
397 get_maxmin_system()->update_variable_bound(
398 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
400 get_maxmin_system()->update_variable_bound(
401 action->get_variable(), (action->lat_current_ > 0)
402 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
403 : action->get_user_bound());
407 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
409 double latency = 0.0;
410 std::vector<LinkImpl*> back_route;
411 std::vector<LinkImpl*> route;
412 std::unordered_set<kernel::routing::NetZoneImpl*> netzones;
414 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
416 bool failed = comm_get_route_info(src, dst, latency, route, back_route, netzones);
418 NetworkCm02Action* action = comm_action_create(src, dst, size, route, failed);
419 action->sharing_penalty_ = latency;
420 action->latency_ = latency;
422 if (sg_weight_S_parameter > 0) {
423 action->sharing_penalty_ =
424 std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
425 return total + sg_weight_S_parameter / link->get_bandwidth();
429 /* setting bandwidth and latency bounds considering route and configured bw/lat factors */
430 comm_action_set_bounds(src, dst, size, action, route, netzones, rate);
432 /* creating the maxmin variable associated to this action */
433 comm_action_set_variable(action, route, back_route);
435 /* expand maxmin system to consider this communication in bw constraint for each link in route and back_route */
436 comm_action_expand_constraints(src, dst, action, route, back_route);
439 simgrid::s4u::Link::on_communicate(*action);
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 == state_event_) {
470 tmgr_trace_event_unref(&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 bandwidth_.peak = value;
483 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), (bandwidth_.peak * bandwidth_.scale));
485 LinkImpl::on_bandwidth_change();
487 if (sg_weight_S_parameter > 0) {
488 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
490 const kernel::lmm::Element* elem = nullptr;
491 const kernel::lmm::Element* nextelem = nullptr;
493 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
494 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
495 action->sharing_penalty_ += delta;
496 if (not action->is_suspended())
497 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
502 void NetworkCm02Link::set_latency(double value)
504 latency_check(value);
506 double delta = value - latency_.peak;
507 const kernel::lmm::Element* elem = nullptr;
508 const kernel::lmm::Element* nextelem = nullptr;
511 latency_.scale = 1.0;
512 latency_.peak = value;
514 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
515 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
516 action->lat_current_ += delta;
517 action->sharing_penalty_ += delta;
518 if (action->get_user_bound() < 0)
519 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
520 (2.0 * action->lat_current_));
522 get_model()->get_maxmin_system()->update_variable_bound(
523 action->get_variable(),
524 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
526 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
527 XBT_INFO("Flow is limited BYBANDWIDTH");
529 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
532 if (not action->is_suspended())
533 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
541 void NetworkCm02Action::update_remains_lazy(double now)
543 if (not is_running())
546 double delta = now - get_last_update();
548 if (get_remains_no_update() > 0) {
549 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
551 update_remains(get_last_value() * delta);
553 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
556 update_max_duration(delta);
558 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
559 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
560 finish(Action::State::FINISHED);
561 get_model()->get_action_heap().remove(this);
565 set_last_value(get_rate());
568 } // namespace resource
569 } // namespace kernel
570 } // namespace simgrid