1 /* Copyright (c) 2013-2020. 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/s4u/Host.hpp"
8 #include "simgrid/sg_config.hpp"
9 #include "src/kernel/resource/profile/Event.hpp"
10 #include "src/surf/network_wifi.hpp"
11 #include "src/surf/surf_interface.hpp"
12 #include "surf/surf.hpp"
17 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
19 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
20 double sg_bandwidth_factor = 1.0; /* default value; can be set by model or from command line */
21 double sg_weight_S_parameter = 0.0; /* default value; can be set by model or from command line */
23 /************************************************************************/
24 /* New model based on optimizations discussed during Pedro Velho's thesis*/
25 /************************************************************************/
26 /* @techreport{VELHO:2011:HAL-00646896:1, */
27 /* url = {http://hal.inria.fr/hal-00646896/en/}, */
28 /* title = {{Flow-level network models: have we reached the limits?}}, */
29 /* author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
30 /* type = {Rapport de recherche}, */
31 /* institution = {INRIA}, */
32 /* number = {RR-7821}, */
35 /* pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
37 void surf_network_model_init_LegrandVelho()
39 xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
41 surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
43 simgrid::config::set_default<double>("network/latency-factor", 13.01);
44 simgrid::config::set_default<double>("network/bandwidth-factor", 0.97);
45 simgrid::config::set_default<double>("network/weight-S", 20537);
48 /***************************************************************************/
49 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
50 /***************************************************************************/
51 /* @TechReport{ rr-lip2002-40, */
52 /* author = {Henri Casanova and Loris Marchal}, */
53 /* institution = {LIP}, */
54 /* title = {A Network Model for Simulation of Grid Application}, */
55 /* number = {2002-40}, */
59 void surf_network_model_init_CM02()
61 xbt_assert(surf_network_model == nullptr, "Cannot set the network model twice");
63 simgrid::config::set_default<double>("network/latency-factor", 1.0);
64 simgrid::config::set_default<double>("network/bandwidth-factor", 1.0);
65 simgrid::config::set_default<double>("network/weight-S", 0.0);
67 surf_network_model = new simgrid::kernel::resource::NetworkCm02Model();
74 NetworkCm02Model::NetworkCm02Model(kernel::lmm::System* (*make_new_lmm_system)(bool))
75 : NetworkModel(simgrid::config::get_value<std::string>("network/optim") == "Full" ? Model::UpdateAlgo::FULL
76 : Model::UpdateAlgo::LAZY)
78 all_existing_models.push_back(this);
80 std::string optim = simgrid::config::get_value<std::string>("network/optim");
81 bool select = simgrid::config::get_value<bool>("network/maxmin-selective-update");
83 if (optim == "Lazy") {
84 xbt_assert(select || simgrid::config::is_default("network/maxmin-selective-update"),
85 "You cannot disable network selective update when using the lazy update mechanism");
89 set_maxmin_system(make_new_lmm_system(select));
90 loopback_ = NetworkCm02Model::create_link("__loopback__",
91 std::vector<double>{simgrid::config::get_value<double>("network/loopback-bw")},
92 simgrid::config::get_value<double>("network/loopback-lat"),
93 s4u::Link::SharingPolicy::FATPIPE);
96 LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
97 s4u::Link::SharingPolicy policy)
99 if (policy == s4u::Link::SharingPolicy::WIFI)
100 return new NetworkWifiLink(this, name, bandwidths, get_maxmin_system());
102 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
103 return new NetworkCm02Link(this, name, bandwidths[0], latency, policy, get_maxmin_system());
106 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
108 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
109 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
110 XBT_DEBUG("Something happened to action %p", action);
112 // if I am wearing a latency hat
113 if (action->get_type() == ActionHeap::Type::latency) {
114 XBT_DEBUG("Latency paid for action %p. Activating", action);
115 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
116 get_action_heap().remove(action);
117 action->set_last_update();
119 // if I am wearing a max_duration or normal hat
120 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
121 // no need to communicate anymore
122 // assume that flows that reached max_duration have remaining of 0
123 XBT_DEBUG("Action %p finished", action);
124 action->finish(Action::State::FINISHED);
125 get_action_heap().remove(action);
130 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
132 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
133 NetworkCm02Action& action = static_cast<NetworkCm02Action&>(*it);
134 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
135 XBT_DEBUG("Something happened to action %p", &action);
136 double deltap = delta;
137 if (action.latency_ > 0) {
138 if (action.latency_ > deltap) {
139 double_update(&action.latency_, deltap, sg_surf_precision);
142 double_update(&deltap, action.latency_, sg_surf_precision);
143 action.latency_ = 0.0;
145 if (action.latency_ <= 0.0 && not action.is_suspended())
146 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
149 if (not action.get_variable()->get_number_of_constraint()) {
150 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
151 * vivaldi. In such case, just make sure that the action completes immediately.
153 action.update_remains(action.get_remains());
155 action.update_remains(action.get_variable()->get_value() * delta);
157 if (action.get_max_duration() != NO_MAX_DURATION)
158 action.update_max_duration(delta);
160 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
161 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
162 action.finish(Action::State::FINISHED);
167 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
169 double latency = 0.0;
170 std::vector<LinkImpl*> back_route;
171 std::vector<LinkImpl*> route;
173 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
175 src->route_to(dst, route, &latency);
176 xbt_assert(not route.empty() || latency > 0,
177 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
178 src->get_cname(), dst->get_cname());
180 bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
182 if (cfg_crosstraffic) {
183 dst->route_to(src, back_route, nullptr);
186 std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
189 NetworkWifiLink* src_wifi_link = nullptr;
190 NetworkWifiLink* dst_wifi_link = nullptr;
191 if (not route.empty() && route.at(0)->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
192 src_wifi_link = static_cast<NetworkWifiLink*>(route.at(0));
193 xbt_assert(src_wifi_link->get_host_rate(src) != -1,
194 "The route from %s to %s begins with the WIFI link %s, but the host %s does not seem attached to that "
195 "WIFI link. Did you call link->set_host_rate()?",
196 src->get_cname(), dst->get_cname(), src_wifi_link->get_cname(), src->get_cname());
198 if (route.size() > 1 && route.at(route.size() - 1)->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
199 dst_wifi_link = static_cast<NetworkWifiLink*>(route.at(route.size() - 1));
200 xbt_assert(dst_wifi_link->get_host_rate(dst) != -1,
201 "The route from %s to %s ends with the WIFI link %s, but the host %s does not seem attached to that "
202 "WIFI link. Did you call link->set_host_rate()?",
203 src->get_cname(), dst->get_cname(), dst_wifi_link->get_cname(), dst->get_cname());
206 NetworkCm02Action* action;
207 if (src_wifi_link == nullptr && dst_wifi_link == nullptr)
208 action = new NetworkCm02Action(this, *src, *dst, size, failed);
210 action = new NetworkWifiAction(this, *src, *dst, size, failed, src_wifi_link, dst_wifi_link);
211 action->sharing_penalty_ = latency;
212 action->latency_ = latency;
213 action->rate_ = rate;
215 if (is_update_lazy()) {
216 action->set_last_update();
219 if (sg_weight_S_parameter > 0) {
220 action->sharing_penalty_ =
221 std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
222 return total + sg_weight_S_parameter / link->get_bandwidth();
226 double bandwidth_bound = route.empty() ? -1.0 : get_bandwidth_factor(size) * route.front()->get_bandwidth();
228 for (auto const& link : route)
229 bandwidth_bound = std::min(bandwidth_bound, get_bandwidth_factor(size) * link->get_bandwidth());
231 action->lat_current_ = action->latency_;
232 action->latency_ *= get_latency_factor(size);
233 action->rate_ = get_bandwidth_constraint(action->rate_, bandwidth_bound, size);
235 size_t constraints_per_variable = route.size();
236 constraints_per_variable += back_route.size();
238 if (action->latency_ > 0) {
239 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
240 if (is_update_lazy()) {
241 // add to the heap the event when the latency is paid
242 double date = action->latency_ + action->get_last_update();
244 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
246 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
247 get_action_heap().insert(action, date, type);
250 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
252 if (action->rate_ < 0) {
253 get_maxmin_system()->update_variable_bound(
254 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
256 get_maxmin_system()->update_variable_bound(
257 action->get_variable(), (action->lat_current_ > 0)
258 ? std::min(action->rate_, cfg_tcp_gamma / (2.0 * action->lat_current_))
262 if (src_wifi_link != nullptr)
263 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
264 1.0 / src_wifi_link->get_host_rate(src));
265 if (dst_wifi_link != nullptr)
266 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
267 1.0 / dst_wifi_link->get_host_rate(dst));
269 for (auto const& link : route) {
270 // WIFI links are handled manually just above, so skip them now
271 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
272 xbt_assert(link == src_wifi_link || link == dst_wifi_link,
273 "Wifi links can only occur at the beginning of the route (meaning that it's attached to the src) or "
274 "at its end (meaning that it's attached to the dst");
276 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
280 if (cfg_crosstraffic) {
281 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
282 if (dst_wifi_link != nullptr)
283 get_maxmin_system()->expand(dst_wifi_link->get_constraint(), action->get_variable(),
284 .05 / dst_wifi_link->get_host_rate(dst));
285 if (src_wifi_link != nullptr)
286 get_maxmin_system()->expand(src_wifi_link->get_constraint(), action->get_variable(),
287 .05 / src_wifi_link->get_host_rate(src));
288 for (auto const& link : back_route)
289 if (link->get_sharing_policy() != s4u::Link::SharingPolicy::WIFI)
290 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
291 // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
292 // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
293 // action->getVariable()->set_concurrency_share(2)
297 simgrid::s4u::Link::on_communicate(*action);
304 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
305 s4u::Link::SharingPolicy policy, kernel::lmm::System* system)
306 : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
308 bandwidth_.scale = 1.0;
309 bandwidth_.peak = bandwidth;
311 latency_.scale = 1.0;
312 latency_.peak = latency;
314 if (policy == s4u::Link::SharingPolicy::FATPIPE)
315 get_constraint()->unshare();
317 simgrid::s4u::Link::on_creation(*get_iface());
320 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
322 /* Find out which of my iterators was triggered, and react accordingly */
323 if (triggered == bandwidth_.event) {
324 set_bandwidth(value);
325 tmgr_trace_event_unref(&bandwidth_.event);
327 } else if (triggered == latency_.event) {
329 tmgr_trace_event_unref(&latency_.event);
331 } else if (triggered == state_event_) {
336 tmgr_trace_event_unref(&state_event_);
338 xbt_die("Unknown event!\n");
341 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
345 void NetworkCm02Link::set_bandwidth(double value)
347 bandwidth_.peak = value;
349 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
350 sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
352 LinkImpl::on_bandwidth_change();
354 if (sg_weight_S_parameter > 0) {
355 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
357 const kernel::lmm::Variable* var;
358 const kernel::lmm::Element* elem = nullptr;
359 const kernel::lmm::Element* nextelem = nullptr;
361 while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
362 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
363 action->sharing_penalty_ += delta;
364 if (not action->is_suspended())
365 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
370 void NetworkCm02Link::set_latency(double value)
372 double delta = value - latency_.peak;
373 const kernel::lmm::Variable* var;
374 const kernel::lmm::Element* elem = nullptr;
375 const kernel::lmm::Element* nextelem = nullptr;
378 latency_.peak = value;
380 while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
381 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
382 action->lat_current_ += delta;
383 action->sharing_penalty_ += delta;
384 if (action->rate_ < 0)
385 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
386 (2.0 * action->lat_current_));
388 get_model()->get_maxmin_system()->update_variable_bound(
389 action->get_variable(), std::min(action->rate_, NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
391 if (action->rate_ < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
392 XBT_INFO("Flow is limited BYBANDWIDTH");
394 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
397 if (not action->is_suspended())
398 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
406 void NetworkCm02Action::update_remains_lazy(double now)
408 if (not is_running())
411 double delta = now - get_last_update();
413 if (get_remains_no_update() > 0) {
414 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
416 update_remains(get_last_value() * delta);
418 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
421 update_max_duration(delta);
423 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
424 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
425 finish(Action::State::FINISHED);
426 get_model()->get_action_heap().remove(this);
430 set_last_value(get_variable()->get_value());
433 } // namespace resource
434 } // namespace kernel
435 } // namespace simgrid