1 /* Copyright (c) 2013-2019. 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__", std::vector<double>(1, 498000000), 0.000015,
91 s4u::Link::SharingPolicy::FATPIPE);
94 LinkImpl* NetworkCm02Model::create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
95 s4u::Link::SharingPolicy policy)
97 if (policy == s4u::Link::SharingPolicy::WIFI)
98 return new NetworkWifiLink(this, name, bandwidths, get_maxmin_system());
100 xbt_assert(bandwidths.size() == 1, "Non-WIFI links must use only 1 bandwidth.");
101 return new NetworkCm02Link(this, name, bandwidths[0], latency, policy, get_maxmin_system());
104 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
106 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
108 auto* action = static_cast<NetworkCm02Action*>(get_action_heap().pop());
109 XBT_DEBUG("Something happened to action %p", action);
111 // if I am wearing a latency hat
112 if (action->get_type() == ActionHeap::Type::latency) {
113 XBT_DEBUG("Latency paid for action %p. Activating", action);
114 get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
115 get_action_heap().remove(action);
116 action->set_last_update();
118 // if I am wearing a max_duration or normal hat
119 } else if (action->get_type() == ActionHeap::Type::max_duration || action->get_type() == ActionHeap::Type::normal) {
120 // no need to communicate anymore
121 // assume that flows that reached max_duration have remaining of 0
122 XBT_DEBUG("Action %p finished", action);
123 action->finish(Action::State::FINISHED);
124 get_action_heap().remove(action);
129 void NetworkCm02Model::update_actions_state_full(double /*now*/, double delta)
131 for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
132 NetworkCm02Action& action = static_cast<NetworkCm02Action&>(*it);
133 ++it; // increment iterator here since the following calls to action.finish() may invalidate it
134 XBT_DEBUG("Something happened to action %p", &action);
135 double deltap = delta;
136 if (action.latency_ > 0) {
137 if (action.latency_ > deltap) {
138 double_update(&action.latency_, deltap, sg_surf_precision);
141 double_update(&deltap, action.latency_, sg_surf_precision);
142 action.latency_ = 0.0;
144 if (action.latency_ <= 0.0 && not action.is_suspended())
145 get_maxmin_system()->update_variable_penalty(action.get_variable(), action.sharing_penalty_);
148 if (not action.get_variable()->get_number_of_constraint()) {
149 /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
150 * vivaldi. In such case, just make sure that the action completes immediately.
152 action.update_remains(action.get_remains());
154 action.update_remains(action.get_variable()->get_value() * delta);
156 if (action.get_max_duration() != NO_MAX_DURATION)
157 action.update_max_duration(delta);
159 if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
160 ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
161 action.finish(Action::State::FINISHED);
166 Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
168 double latency = 0.0;
169 std::vector<LinkImpl*> back_route;
170 std::vector<LinkImpl*> route;
172 XBT_IN("(%s,%s,%g,%g)", src->get_cname(), dst->get_cname(), size, rate);
174 src->route_to(dst, route, &latency);
175 xbt_assert(not route.empty() || latency > 0,
176 "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
177 src->get_cname(), dst->get_cname());
179 bool failed = std::any_of(route.begin(), route.end(), [](const LinkImpl* link) { return not link->is_on(); });
181 if (cfg_crosstraffic) {
182 dst->route_to(src, back_route, nullptr);
185 std::any_of(back_route.begin(), back_route.end(), [](const LinkImpl* link) { return not link->is_on(); });
188 auto* action = new NetworkCm02Action(this, size, failed);
189 action->sharing_penalty_ = latency;
190 action->latency_ = latency;
191 action->rate_ = rate;
193 if (get_update_algorithm() == Model::UpdateAlgo::LAZY) {
194 action->set_last_update();
197 if (sg_weight_S_parameter > 0) {
198 action->sharing_penalty_ =
199 std::accumulate(route.begin(), route.end(), action->sharing_penalty_, [](double total, LinkImpl* const& link) {
200 return total + sg_weight_S_parameter / link->get_bandwidth();
204 double bandwidth_bound = route.empty() ? -1.0 : get_bandwidth_factor(size) * route.front()->get_bandwidth();
206 for (auto const& link : route)
207 bandwidth_bound = std::min(bandwidth_bound, get_bandwidth_factor(size) * link->get_bandwidth());
209 action->lat_current_ = action->latency_;
210 action->latency_ *= get_latency_factor(size);
211 action->rate_ = get_bandwidth_constraint(action->rate_, bandwidth_bound, size);
213 size_t constraints_per_variable = route.size();
214 constraints_per_variable += back_route.size();
216 if (action->latency_ > 0) {
217 action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
218 if (get_update_algorithm() == Model::UpdateAlgo::LAZY) {
219 // add to the heap the event when the latency is payed
220 double date = action->latency_ + action->get_last_update();
222 ActionHeap::Type type = route.empty() ? ActionHeap::Type::normal : ActionHeap::Type::latency;
224 XBT_DEBUG("Added action (%p) one latency event at date %f", action, date);
225 get_action_heap().insert(action, date, type);
228 action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
230 if (action->rate_ < 0) {
231 get_maxmin_system()->update_variable_bound(
232 action->get_variable(), (action->lat_current_ > 0) ? cfg_tcp_gamma / (2.0 * action->lat_current_) : -1.0);
234 get_maxmin_system()->update_variable_bound(
235 action->get_variable(), (action->lat_current_ > 0)
236 ? std::min(action->rate_, cfg_tcp_gamma / (2.0 * action->lat_current_))
240 for (auto const& link : route) {
242 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
243 NetworkWifiLink* wifi_link = static_cast<NetworkWifiLink*>(link);
245 double wifi_rate = wifi_link->get_host_rate(src);
246 if (wifi_rate == -1.0)
247 wifi_rate = wifi_link->get_host_rate(dst);
248 xbt_assert(wifi_rate != -1.0,
249 "None of the source (%s) or destination (%s) is connected to the Access Point '%s'. "
250 "Please use set_host_rate() on all stations.",
251 src->get_cname(), dst->get_cname(), link->get_cname());
252 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0 / wifi_rate);
255 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), 1.0);
259 if (cfg_crosstraffic) {
260 XBT_DEBUG("Crosstraffic active: adding backward flow using 5%% of the available bandwidth");
261 bool wifi_dst_assigned = false; // Used by wifi crosstraffic
262 for (auto const& link : back_route) {
263 if (link->get_sharing_policy() == s4u::Link::SharingPolicy::WIFI) {
264 NetworkWifiLink* wifi_link = static_cast<NetworkWifiLink*>(link);
266 * For wifi links we should add 0.05/rate.
267 * However since we are using the "back_route" we should encounter in
268 * the first place the dst wifi link.
270 if (!wifi_dst_assigned && (wifi_link->get_host_rate(dst) != -1)) {
271 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(),
272 .05 / wifi_link->get_host_rate(dst));
273 wifi_dst_assigned = true;
275 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(),
276 .05 / wifi_link->get_host_rate(src));
279 get_maxmin_system()->expand(link->get_constraint(), action->get_variable(), .05);
283 // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
284 // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
285 // action->getVariable()->set_concurrency_share(2)
289 simgrid::s4u::Link::on_communicate(*action, src, dst);
296 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
297 s4u::Link::SharingPolicy policy, kernel::lmm::System* system)
298 : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
300 bandwidth_.scale = 1.0;
301 bandwidth_.peak = bandwidth;
303 latency_.scale = 1.0;
304 latency_.peak = latency;
306 if (policy == s4u::Link::SharingPolicy::FATPIPE)
307 get_constraint()->unshare();
309 simgrid::s4u::Link::on_creation(*get_iface());
312 void NetworkCm02Link::apply_event(kernel::profile::Event* triggered, double value)
314 /* Find out which of my iterators was triggered, and react accordingly */
315 if (triggered == bandwidth_.event) {
316 set_bandwidth(value);
317 tmgr_trace_event_unref(&bandwidth_.event);
319 } else if (triggered == latency_.event) {
321 tmgr_trace_event_unref(&latency_.event);
323 } else if (triggered == state_event_) {
328 tmgr_trace_event_unref(&state_event_);
330 xbt_die("Unknown event!\n");
333 XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
337 void NetworkCm02Link::set_bandwidth(double value)
339 bandwidth_.peak = value;
341 get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
342 sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
344 LinkImpl::on_bandwidth_change();
346 if (sg_weight_S_parameter > 0) {
347 double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
349 kernel::lmm::Variable* var;
350 const kernel::lmm::Element* elem = nullptr;
351 const kernel::lmm::Element* nextelem = nullptr;
353 while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
354 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
355 action->sharing_penalty_ += delta;
356 if (not action->is_suspended())
357 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
362 void NetworkCm02Link::set_latency(double value)
364 double delta = value - latency_.peak;
365 kernel::lmm::Variable* var = nullptr;
366 const kernel::lmm::Element* elem = nullptr;
367 const kernel::lmm::Element* nextelem = nullptr;
370 latency_.peak = value;
372 while ((var = get_constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
373 auto* action = static_cast<NetworkCm02Action*>(var->get_id());
374 action->lat_current_ += delta;
375 action->sharing_penalty_ += delta;
376 if (action->rate_ < 0)
377 get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), NetworkModel::cfg_tcp_gamma /
378 (2.0 * action->lat_current_));
380 get_model()->get_maxmin_system()->update_variable_bound(
381 action->get_variable(), std::min(action->rate_, NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)));
383 if (action->rate_ < NetworkModel::cfg_tcp_gamma / (2.0 * action->lat_current_)) {
384 XBT_INFO("Flow is limited BYBANDWIDTH");
386 XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->lat_current_);
389 if (not action->is_suspended())
390 get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), action->sharing_penalty_);
398 void NetworkCm02Action::update_remains_lazy(double now)
400 if (not is_running())
403 double delta = now - get_last_update();
405 if (get_remains_no_update() > 0) {
406 XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
408 update_remains(get_last_value() * delta);
410 XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
413 update_max_duration(delta);
415 if ((get_remains_no_update() <= 0 && (get_variable()->get_penalty() > 0)) ||
416 ((get_max_duration() != NO_MAX_DURATION) && (get_max_duration() <= 0))) {
417 finish(Action::State::FINISHED);
418 get_model()->get_action_heap().remove(this);
422 set_last_value(get_variable()->get_value());
425 } // namespace resource
426 } // namespace kernel
427 } // namespace simgrid