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 /************************************************************************/
30 /* New model based on optimizations discussed during Pedro Velho's thesis*/
31 /************************************************************************/
32 /* @techreport{VELHO:2011:HAL-00646896:1, */
33 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
34 /* title = {{Flow-level network models: have we reached the limits?}}, */
35 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
36 /* type = {Rapport de recherche}, */
37 /* institution = {INRIA}, */
38 /* number = {RR-7821}, */
41 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
43 void surf_network_model_init_LegrandVelho()
45 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_LegrandVelho");
46 auto* engine = simgrid::kernel::EngineImpl::get_instance();
47 engine->add_model(net_model);
48 engine->get_netzone_root()->set_network_model(net_model);
50 simgrid::config::set_default<std::string>("network/latency-factor", "13.01");
51 simgrid::config::set_default<std::string>("network/bandwidth-factor", "0.97");
52 simgrid::config::set_default<double>("network/weight-S", 20537);
55 /***************************************************************************/
56 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
57 /***************************************************************************/
58 /* @TechReport{ rr-lip2002-40, */
59 /* author = {Henri Casanova and Loris Marchal}, */
60 /* institution = {LIP}, */
61 /* title = {A Network Model for Simulation of Grid Application}, */
62 /* number = {2002-40}, */
66 void surf_network_model_init_CM02()
68 simgrid::config::set_default<std::string>("network/latency-factor", "1.0");
69 simgrid::config::set_default<std::string>("network/bandwidth-factor", "1.0");
70 simgrid::config::set_default<double>("network/weight-S", 0.0);
72 auto net_model = std::make_shared<simgrid::kernel::resource::NetworkCm02Model>("Network_CM02");
73 auto* engine = simgrid::kernel::EngineImpl::get_instance();
74 engine->add_model(net_model);
75 engine->get_netzone_root()->set_network_model(net_model);
78 namespace simgrid::kernel::resource {
80 NetworkCm02Model::NetworkCm02Model(const std::string& name) : NetworkModel(name)
82 std::string optim = config::get_value<std::string>("network/optim");
83 bool select = config::get_value<bool>("network/maxmin-selective-update");
85 if (optim == "Lazy") {
86 set_update_algorithm(Model::UpdateAlgo::LAZY);
87 xbt_assert(select || config::is_default("network/maxmin-selective-update"),
88 "You cannot disable network selective update when using the lazy update mechanism");
92 set_maxmin_system(lmm::System::build(cfg_network_solver.get(), select));
94 loopback_.reset(create_link("__loopback__", {config::get_value<double>("network/loopback-bw")}));
95 loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE, {});
96 loopback_->set_latency(config::get_value<double>("network/loopback-lat"));
97 loopback_->get_iface()->seal();
100 void NetworkCm02Model::check_lat_factor_cb()
102 if (not simgrid::config::is_default("network/latency-factor")) {
103 throw std::invalid_argument(
104 "NetworkModelIntf: Cannot mix network/latency-factor and callback configuration. Choose only one of them.");
108 void NetworkCm02Model::check_bw_factor_cb()
110 if (not simgrid::config::is_default("network/bandwidth-factor")) {
111 throw std::invalid_argument(
112 "NetworkModelIntf: Cannot mix network/bandwidth-factor and callback configuration. Choose only one of them.");
116 StandardLinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
118 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
119 auto link = new NetworkCm02Link(name, bandwidths[0], get_maxmin_system());
120 link->set_model(this);
124 StandardLinkImpl* NetworkCm02Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
126 auto link = new WifiLinkImpl(name, bandwidths, get_maxmin_system());
127 link->set_model(this);
131 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
133 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
134 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
135 XBT_DEBUG("Something happened to action %p", action);
137 // if I am wearing a latency hat
138 if (action->get_type() == ActionHeap::Type::latency) {
139 XBT_DEBUG("Latency paid for action %p. Activating", action);
140 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
141 get_action_heap().remove(action);
142 action->set_last_update();
144 // if I am wearing a max_duration or normal hat
145 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
146 // no need to communicate anymore
147 // assume that flows that reached max_duration have remaining of 0
148 XBT_DEBUG("Action %p finished", action);
149 action->finish(Action::State::FINISHED);
150 get_action_heap().remove(action);
155 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
157 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
158 auto& action = static_cast<NetworkCm02Action&>(*it);
159 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
160 XBT_DEBUG("Something happened to action %p", &action);
161 if (action.latency_ > 0) {
162 if (action.latency_ > delta) {
163 double_update(&action.latency_, delta, sg_surf_precision);
165 action.latency_ = 0.0;
167 if (action.latency_ <= 0.0 && not action.is_suspended())
168 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
171 if (not action.get_variable()->get_number_of_constraint()) {
172 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
173 * vivaldi. In such case, just make sure that the action completes immediately.
175 action.update_remains(action.get_remains());
177 action.update_remains(action.get_rate() * delta);
179 if (action.get_max_duration() != NO_MAX_DURATION)
180 action.update_max_duration(delta);
182 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
183 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
184 action.finish(Action::State::FINISHED);
189 void NetworkCm02Model::comm_action_expand_constraints(const s4u::Host* src, const s4u::Host* dst,
190 const NetworkCm02Action* action,
191 const std::vector<StandardLinkImpl*>& route,
192 const std::vector<StandardLinkImpl*>& back_route) const
194 /* expand route links constraints for route and back_route */
195 const WifiLinkImpl* src_wifi_link = nullptr;
196 const WifiLinkImpl* dst_wifi_link = nullptr;
197 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
198 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
200 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
201 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
204 /* WI-FI links needs special treatment, do it here */
205 if (src_wifi_link != nullptr) {
206 if (src_wifi_link->get_host_rate(src) > 0)
207 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
208 1.0 / src_wifi_link->get_host_rate(src));
210 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
214 if (dst_wifi_link != nullptr) {
215 if (dst_wifi_link->get_host_rate(dst) > 0)
216 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
217 1.0 / dst_wifi_link->get_host_rate(dst));
219 get_maxmin_system()->update_variable_penalty(action->get_variable(), 0);
223 for (auto const* link : route) {
224 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
225 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
228 if (cfg_crosstraffic) {
229 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
230 if (dst_wifi_link != nullptr)
231 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
232 .05 / dst_wifi_link->get_host_rate(dst));
233 if (src_wifi_link != nullptr)
234 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
235 .05 / src_wifi_link->get_host_rate(src));
237 for (auto const* link : back_route) {
238 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
239 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
244 NetworkCm02Action* NetworkCm02Model::comm_action_create(s4u::Host* src, s4u::Host* dst, double size,
245 const std::vector<StandardLinkImpl*>& route, bool failed)
247 WifiLinkImpl* src_wifi_link = nullptr;
248 WifiLinkImpl* dst_wifi_link = nullptr;
249 /* many checks related to Wi-Fi links */
250 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
251 src_wifi_link = static_cast<WifiLinkImpl*>(route.front());
252 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
253 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
254 "WIFI link. Did you call link->set_host_rate()?",
255 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
257 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
258 dst_wifi_link = static_cast<WifiLinkImpl*>(route.back());
259 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
260 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
261 "WIFI link. Did you call link->set_host_rate()?",
262 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
264 if (route.size() > 2)
265 for (unsigned i = 1; i < route.size() - 1; i++)
266 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
267 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
268 "not in between (it is at position %u out of %zu). "
269 "Did you declare an access_point in your WIFI zones?",
270 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
272 for (auto const* link : route) {
273 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
274 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
275 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
276 "at its end (meaning that it's attached to the dst");
280 /* create action and do some initializations */
281 NetworkCm02Action* action;
282 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
283 action = new NetworkCm02Action(this, *src, *dst, size, failed);
285 action = new WifiLinkAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
287 if (is_update_lazy()) {
288 action->set_last_update();
294 bool NetworkCm02Model::comm_get_route_info(const s4u::Host* src, const s4u::Host* dst, double& latency,
295 std::vector<StandardLinkImpl*>& route,
296 std::vector<StandardLinkImpl*>& back_route,
297 std::unordered_set<kernel::routing::NetZoneImpl*>& netzones) const
299 kernel::routing::NetZoneImpl::get_global_route_with_netzones(src->get_netpoint(), dst->get_netpoint(), route,
302 xbt_assert(not route.empty() || latency > 0,
303 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
304 src->get_cname(), dst->get_cname());
306 bool failed = std::any_of(route.begin(), route.end(), [](const StandardLinkImpl* link) { return not link->is_on(); });
308 if (not failed && cfg_crosstraffic) {
309 dst->route_to(src, back_route, nullptr);
310 failed = std::any_of(back_route.begin(), back_route.end(),
311 [](const StandardLinkImpl* link) { return not link->is_on(); });
316 void NetworkCm02Model::comm_action_set_bounds(const s4u::Host* src, const s4u::Host* dst, double size,
317 NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
318 const std::unordered_set<kernel::routing::NetZoneImpl*>& netzones,
321 std::vector<s4u::Link*> s4u_route;
322 std::unordered_set<s4u::NetZone*> s4u_netzones;
324 /* transform data to user structures if necessary */
325 if (lat_factor_cb_ || bw_factor_cb_) {
326 std::for_each(route.begin(), route.end(),
327 [&s4u_route](StandardLinkImpl* l) { s4u_route.push_back(l->get_iface()); });
328 std::for_each(netzones.begin(), netzones.end(),
329 [&s4u_netzones](kernel::routing::NetZoneImpl* n) { s4u_netzones.insert(n->get_iface()); });
333 bw_factor = bw_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
335 bw_factor = get_bandwidth_factor(size);
337 xbt_assert(bw_factor != 0, "Invalid param for comm %s -> %s. Bandwidth factor cannot be 0", src->get_cname(),
339 action->set_rate_factor(bw_factor);
341 /* get mininum bandwidth among links in the route and multiply by correct factor
342 * ignore wi-fi links, they're not considered for bw_factors */
343 double bandwidth_bound = -1.0;
344 for (const auto* l : route) {
345 if (l->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI)
347 if (bandwidth_bound == -1.0 || l->get_bandwidth() < bandwidth_bound)
348 bandwidth_bound = l->get_bandwidth();
351 /* increase rate given by user considering the factor, since the actual rate will be
353 rate = rate / bw_factor;
354 /* the bandwidth is determined by the minimum between flow and user's defined rate */
355 if (rate >= 0 && rate < bandwidth_bound)
356 bandwidth_bound = rate;
357 action->set_user_bound(bandwidth_bound);
359 action->lat_current_ = action->latency_;
360 if (lat_factor_cb_) {
361 action->latency_ *= lat_factor_cb_(size, src, dst, s4u_route, s4u_netzones);
363 action->latency_ *= get_latency_factor(size);
367 void NetworkCm02Model::comm_action_set_variable(NetworkCm02Action* action, const std::vector<StandardLinkImpl*>& route,
368 const std::vector<StandardLinkImpl*>& back_route)
370 size_t constraints_per_variable = route.size();
371 constraints_per_variable += back_route.size();
373 if (action->latency_ > 0) {
374 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
375 if (is_update_lazy()) {
376 // add to the heap the event when the latency is paid
377 double date = action->latency_ + action->get_last_update();
379 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
381 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
382 get_action_heap().insert(action, date, type);
385 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
387 /* after setting the variable, update the bounds depending on user configuration */
388 if (action->get_user_bound() < 0) {
389 get_maxmin_system()->update_variable_bound(
390 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
392 get_maxmin_system()->update_variable_bound(
393 action->get_variable(), (action->lat_current_ > 0)
394 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
395 : action->get_user_bound());
399 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
401 double latency = 0.0;
402 std::vector<StandardLinkImpl*> back_route;
403 std::vector<StandardLinkImpl*> route;
404 std::unordered_set<kernel::routing::NetZoneImpl*> netzones;
406 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
408 bool failed = comm_get_route_info(src, dst, latency, route, back_route, netzones);
410 NetworkCm02Action* action = comm_action_create(src, dst, size, route, failed);
411 action->sharing_penalty_ = latency;
412 action->latency_ = latency;
414 if (cfg_weight_S_parameter > 0) {
415 action->sharing_penalty_ = std::accumulate(route.begin(), route.end(), action->sharing_penalty_,
416 [](double total, StandardLinkImpl* const& link) {
417 return total + cfg_weight_S_parameter / link->get_bandwidth();
421 /* setting bandwidth and latency bounds considering route and configured bw/lat factors */
422 comm_action_set_bounds(src, dst, size, action, route, netzones, rate);
424 /* creating the maxmin variable associated to this action */
425 comm_action_set_variable(action, route, back_route);
427 /* expand maxmin system to consider this communication in bw constraint for each link in route and back_route */
428 comm_action_expand_constraints(src, dst, action, route, back_route);
437 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, kernel::lmm::System* system)
438 : StandardLinkImpl(name)
440 bandwidth_.scale = 1.0;
441 bandwidth_.peak = bandwidth;
442 this->set_constraint(system->constraint_new(this, bandwidth));
445 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
447 /* Find out which of my iterators was triggered, and react accordingly */
448 if (triggered == bandwidth_.event) {
449 set_bandwidth(value);
450 tmgr_trace_event_unref(&bandwidth_.event);
452 } else if (triggered == latency_.event) {
454 tmgr_trace_event_unref(&latency_.event);
456 } else if (triggered == get_state_event()) {
463 xbt_die("Unknown event!\n");
466 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
470 void NetworkCm02Link::set_bandwidth(double value)
472 double old_peak = bandwidth_.peak;
473 bandwidth_.peak = value;
475 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), (bandwidth_.peak * bandwidth_.scale));
477 StandardLinkImpl::on_bandwidth_change();
479 if (NetworkModel::cfg_weight_S_parameter > 0) {
480 double delta = NetworkModel::cfg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale) -
481 NetworkModel::cfg_weight_S_parameter / (old_peak * bandwidth_.scale);
483 const kernel::lmm::Element* elem = nullptr;
484 const kernel::lmm::Element* nextelem = nullptr;
486 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
487 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
488 action->sharing_penalty_ += delta;
489 if (not action->is_suspended())
490 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
495 void NetworkCm02Link::set_latency(double value)
497 latency_check(value);
499 double delta = value - latency_.peak;
500 const kernel::lmm::Element* elem = nullptr;
501 const kernel::lmm::Element* nextelem = nullptr;
504 latency_.scale = 1.0;
505 latency_.peak = value;
507 while (const auto* var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem)) {
508 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
509 action->lat_current_ += delta;
510 action->sharing_penalty_ += delta;
511 if (action->get_user_bound() < 0)
512 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
513 (2.0 * action->lat_current_));
515 get_model()->get_maxmin_system()->update_variable_bound(
516 action->get_variable(),
517 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
519 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
520 XBT_DEBUG("Flow is limited BYBANDWIDTH");
522 XBT_DEBUG("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
525 if (not action->is_suspended())
526 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
534 void NetworkCm02Action::update_remains_lazy(double now)
536 if (not is_running())
539 double delta = now - get_last_update();
541 if (get_remains_no_update() > 0) {
542 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
544 update_remains(get_last_value() * delta);
546 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
549 update_max_duration(delta);
551 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
552 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
553 finish(Action::State::FINISHED);
554 get_model()->get_action_heap().remove(this);
558 set_last_value(get_rate());
561 } // namespace simgrid::kernel::resource