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>();
43 simgrid::kernel::EngineImpl::get_instance()->add_model(simgrid::kernel::resource::Model::Type::NETWORK, net_model,
45 simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->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>();
70 simgrid::kernel::EngineImpl::get_instance()->add_model(simgrid::kernel::resource::Model::Type::NETWORK, net_model,
72 simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_network_model(net_model);
79 NetworkCm02Model::NetworkCm02Model()
80 : NetworkModel(config::get_value<std::string>("network/optim") == "Full" ? Model::UpdateAlgo::FULL
81 : Model::UpdateAlgo::LAZY)
83 std::string optim = config::get_value<std::string>("network/optim");
84 bool select = config::get_value<bool>("network/maxmin-selective-update");
86 if (optim == "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(new lmm::System(select));
93 loopback_ = NetworkCm02Model::create_link("__loopback__",
94 std::vector<double>{config::get_value<double>("network/loopback-bw")},
95 s4u::Link::SharingPolicy::FATPIPE)
96 ->set_latency(config::get_value<double>("network/loopback-lat"));
100 LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths,
101 s4u::Link::SharingPolicy policy)
104 if (policy == s4u::Link::SharingPolicy::WIFI) {
105 link = new NetworkWifiLink(name, bandwidths, get_maxmin_system());
107 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
108 link = new NetworkCm02Link(name, bandwidths[0], policy, get_maxmin_system());
111 link->set_model(this);
115 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
117 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
118 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
119 XBT_DEBUG("Something happened to action %p", action);
121 // if I am wearing a latency hat
122 if (action->get_type() == ActionHeap::Type::latency) {
123 XBT_DEBUG("Latency paid for action %p. Activating", action);
124 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
125 get_action_heap().remove(action);
126 action->set_last_update();
128 // if I am wearing a max_duration or normal hat
129 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
130 // no need to communicate anymore
131 // assume that flows that reached max_duration have remaining of 0
132 XBT_DEBUG("Action %p finished", action);
133 action->finish(Action::State::FINISHED);
134 get_action_heap().remove(action);
139 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
141 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
142 auto& action = static_cast<NetworkCm02Action&>(*it);
143 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
144 XBT_DEBUG("Something happened to action %p", &action);
145 double deltap = delta;
146 if (action.latency_ > 0) {
147 if (action.latency_ > deltap) {
148 double_update(&action.latency_, deltap, sg_surf_precision);
151 double_update(&deltap, action.latency_, sg_surf_precision);
152 action.latency_ = 0.0;
154 if (action.latency_ <= 0.0 && not action.is_suspended())
155 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
158 if (not action.get_variable()->get_number_of_constraint()) {
159 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
160 * vivaldi. In such case, just make sure that the action completes immediately.
162 action.update_remains(action.get_remains());
164 action.update_remains(action.get_variable()->get_value() * delta);
166 if (action.get_max_duration() != NO_MAX_DURATION)
167 action.update_max_duration(delta);
169 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
170 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
171 action.finish(Action::State::FINISHED);
176 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
178 double latency = 0.0;
179 std::vector<LinkImpl*> back_route;
180 std::vector<LinkImpl*> route;
182 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
184 src->route_to(dst, route, &latency);
185 xbt_assert(not route.empty() || latency > 0,
186 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
187 src->get_cname(), dst->get_cname());
189 bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
191 if (cfg_crosstraffic) {
192 dst->route_to(src, back_route, nullptr);
195 std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
198 NetworkWifiLink* src_wifi_link = nullptr;
199 NetworkWifiLink* dst_wifi_link = nullptr;
200 if (not route.empty() && route.front()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
201 src_wifi_link = static_cast<NetworkWifiLink*>(route.front());
202 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
203 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
204 "WIFI link. Did you call link->set_host_rate()?",
205 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
207 if (route.size() > 1 && route.back()->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
208 dst_wifi_link = static_cast<NetworkWifiLink*>(route.back());
209 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
210 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
211 "WIFI link. Did you call link->set_host_rate()?",
212 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
214 if (route.size() > 2)
215 for (unsigned i = 1; i < route.size() - 1; i++)
216 xbt_assert(route[i]->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI,
217 "Link '%s' is a WIFI link. It can only be at the beginning or the end of the route from '%s' to '%s', "
218 "not in between (it is at position %u out of %zu). "
219 "Did you declare an access_point in your WIFI zones?",
220 route[i]->get_cname(), src->get_cname(), dst->get_cname(), i + 1, route.size());
222 NetworkCm02Action* action;
223 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
224 action = new NetworkCm02Action(this, *src, *dst, size, failed);
226 action = new NetworkWifiAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
227 action->sharing_penalty_ = latency;
228 action->latency_ = latency;
229 action->set_user_bound(rate);
231 if (is_update_lazy()) {
232 action->set_last_update();
235 if (sg_weight_S_parameter > 0) {
236 action->sharing_penalty_ =
237 std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
238 return total + sg_weight_S_parameter / link->get_bandwidth();
242 double bandwidth_bound = route.empty() ? -1.0 : get_bandwidth_factor(size) * route.front()->get_bandwidth();
244 for (auto const& link : route)
245 bandwidth_bound = std::min(bandwidth_bound, get_bandwidth_factor(size) * link->get_bandwidth());
247 action->lat_current_ = action->latency_;
248 action->latency_ *= get_latency_factor(size);
249 action->set_user_bound(get_bandwidth_constraint(action->get_user_bound(), bandwidth_bound, size));
251 size_t constraints_per_variable = route.size();
252 constraints_per_variable += back_route.size();
254 if (action->latency_ > 0) {
255 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
256 if (is_update_lazy()) {
257 // add to the heap the event when the latency is paid
258 double date = action->latency_ + action->get_last_update();
260 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
262 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
263 get_action_heap().insert(action, date, type);
266 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
268 if (action->get_user_bound() < 0) {
269 get_maxmin_system()->update_variable_bound(
270 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
272 get_maxmin_system()->update_variable_bound(
273 action->get_variable(), (action->lat_current_ > 0)
274 ? std::min(action->get_user_bound(), cfg_tcp_gamma / (2.0 * action->lat_current_))
275 : action->get_user_bound());
278 if (src_wifi_link != nullptr)
279 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
280 1.0 / src_wifi_link->get_host_rate(src));
281 if (dst_wifi_link != nullptr)
282 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
283 1.0 / dst_wifi_link->get_host_rate(dst));
285 for (auto const* link : route) {
286 // WIFI links are handled manually just above, so skip them now
287 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
288 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
289 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
290 "at its end (meaning that it's attached to the dst");
292 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
296 if (cfg_crosstraffic) {
297 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
298 if (dst_wifi_link != nullptr)
299 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
300 .05 / dst_wifi_link->get_host_rate(dst));
301 if (src_wifi_link != nullptr)
302 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
303 .05 / src_wifi_link->get_host_rate(src));
304 for (auto const* link : back_route)
305 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
306 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
307 // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
308 // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
309 // action->getVariable()->set_concurrency_share(2)
313 simgrid::s4u::Link::on_communicate(*action);
320 NetworkCm02Link::NetworkCm02Link(const std::string& name, double bandwidth, s4u::Link::SharingPolicy policy,
321 kernel::lmm::System* system)
324 bandwidth_.scale = 1.0;
325 bandwidth_.peak = bandwidth;
326 this->set_constraint(system->constraint_new(this, sg_bandwidth_factor * bandwidth));
328 if (policy == s4u::Link::SharingPolicy::FATPIPE)
329 get_constraint()->unshare();
332 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
334 /* Find out which of my iterators was triggered, and react accordingly */
335 if (triggered == bandwidth_.event) {
336 set_bandwidth(value);
337 tmgr_trace_event_unref(&bandwidth_.event);
339 } else if (triggered == latency_.event) {
341 tmgr_trace_event_unref(&latency_.event);
343 } else if (triggered == state_event_) {
348 tmgr_trace_event_unref(&state_event_);
350 xbt_die("Unknown event!\n");
353 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
357 void NetworkCm02Link::set_bandwidth(double value)
359 bandwidth_.peak = value;
361 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
362 sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
364 LinkImpl::on_bandwidth_change();
366 if (sg_weight_S_parameter > 0) {
367 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
369 const kernel::lmm::Variable* var;
370 const kernel::lmm::Element* elem = nullptr;
371 const kernel::lmm::Element* nextelem = nullptr;
373 while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
374 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
375 action->sharing_penalty_ += delta;
376 if (not action->is_suspended())
377 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
382 LinkImpl* NetworkCm02Link::set_latency(double value)
384 latency_check(value);
386 double delta = value - latency_.peak;
387 const kernel::lmm::Variable* var;
388 const kernel::lmm::Element* elem = nullptr;
389 const kernel::lmm::Element* nextelem = nullptr;
392 latency_.scale = 1.0;
393 latency_.peak = value;
395 while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
396 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
397 action->lat_current_ += delta;
398 action->sharing_penalty_ += delta;
399 if (action->get_user_bound() < 0)
400 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
401 (2.0 * action->lat_current_));
403 get_model()->get_maxmin_system()->update_variable_bound(
404 action->get_variable(),
405 std::min(action->get_user_bound(), NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
407 if (action->get_user_bound() < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
408 XBT_INFO("Flow is limited BYBANDWIDTH");
410 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
413 if (not action->is_suspended())
414 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
423 void NetworkCm02Action::update_remains_lazy(double now)
425 if (not is_running())
428 double delta = now - get_last_update();
430 if (get_remains_no_update() > 0) {
431 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
433 update_remains(get_last_value() * delta);
435 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
438 update_max_duration(delta);
440 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
441 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
442 finish(Action::State::FINISHED);
443 get_model()->get_action_heap().remove(this);
447 set_last_value(get_variable()->get_value());
450 } // namespace resource
451 } // namespace kernel
452 } // namespace simgrid