Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make Model::update_algo a constant field, set at initialization only
[simgrid.git] / src / surf / network_cm02.cpp
1 /* Copyright (c) 2013-2018. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include <algorithm>
7
8 #include "network_cm02.hpp"
9 #include "simgrid/s4u/Host.hpp"
10 #include "simgrid/sg_config.hpp"
11 #include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
12 #include "src/kernel/lmm/maxmin.hpp"
13
14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
15
16 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
17 double sg_bandwidth_factor = 1.0;       /* default value; can be set by model or from command line */
18 double sg_weight_S_parameter = 0.0;     /* default value; can be set by model or from command line */
19
20 double sg_tcp_gamma = 0.0;
21 int sg_network_crosstraffic = 0;
22
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}, */
33 /*      year = {2011}, */
34 /*      month = Nov, */
35 /*      pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
36 /*  } */
37 void surf_network_model_init_LegrandVelho()
38 {
39   if (surf_network_model)
40     return;
41
42   surf_network_model = new simgrid::surf::NetworkCm02Model();
43   all_existing_models->push_back(surf_network_model);
44
45   xbt_cfg_setdefault_double("network/latency-factor",      13.01);
46   xbt_cfg_setdefault_double("network/bandwidth-factor",     0.97);
47   xbt_cfg_setdefault_double("network/weight-S",         20537);
48 }
49
50 /***************************************************************************/
51 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
52 /***************************************************************************/
53 /* @TechReport{      rr-lip2002-40, */
54 /*   author        = {Henri Casanova and Loris Marchal}, */
55 /*   institution   = {LIP}, */
56 /*   title         = {A Network Model for Simulation of Grid Application}, */
57 /*   number        = {2002-40}, */
58 /*   month         = {oct}, */
59 /*   year          = {2002} */
60 /* } */
61 void surf_network_model_init_CM02()
62 {
63
64   if (surf_network_model)
65     return;
66
67   xbt_cfg_setdefault_double("network/latency-factor",   1.0);
68   xbt_cfg_setdefault_double("network/bandwidth-factor", 1.0);
69   xbt_cfg_setdefault_double("network/weight-S",         0.0);
70
71   surf_network_model = new simgrid::surf::NetworkCm02Model();
72   all_existing_models->push_back(surf_network_model);
73 }
74
75 /***************************************************************************/
76 /* The models from Steven H. Low                                           */
77 /***************************************************************************/
78 /* @article{Low03,                                                         */
79 /*   author={Steven H. Low},                                               */
80 /*   title={A Duality Model of {TCP} and Queue Management Algorithms},     */
81 /*   year={2003},                                                          */
82 /*   journal={{IEEE/ACM} Transactions on Networking},                      */
83 /*    volume={11}, number={4},                                             */
84 /*  }                                                                      */
85 void surf_network_model_init_Reno()
86 {
87   if (surf_network_model)
88     return;
89
90   using namespace simgrid::kernel;
91   lmm::Lagrange::set_default_protocol_function(lmm::func_reno_f, lmm::func_reno_fp, lmm::func_reno_fpi);
92
93   xbt_cfg_setdefault_double("network/latency-factor", 13.01);
94   xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
95   xbt_cfg_setdefault_double("network/weight-S", 20537);
96
97   surf_network_model = new simgrid::surf::NetworkCm02Model(&simgrid::kernel::lmm::make_new_lagrange_system);
98   all_existing_models->push_back(surf_network_model);
99 }
100
101
102 void surf_network_model_init_Reno2()
103 {
104   if (surf_network_model)
105     return;
106
107   using namespace simgrid::kernel;
108   lmm::Lagrange::set_default_protocol_function(lmm::func_reno2_f, lmm::func_reno2_fp, lmm::func_reno2_fpi);
109
110   xbt_cfg_setdefault_double("network/latency-factor", 13.01);
111   xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
112   xbt_cfg_setdefault_double("network/weight-S", 20537);
113
114   surf_network_model = new simgrid::surf::NetworkCm02Model(&simgrid::kernel::lmm::make_new_lagrange_system);
115   all_existing_models->push_back(surf_network_model);
116 }
117
118 void surf_network_model_init_Vegas()
119 {
120   if (surf_network_model)
121     return;
122
123   using namespace simgrid::kernel;
124   lmm::Lagrange::set_default_protocol_function(lmm::func_vegas_f, lmm::func_vegas_fp, lmm::func_vegas_fpi);
125
126   xbt_cfg_setdefault_double("network/latency-factor", 13.01);
127   xbt_cfg_setdefault_double("network/bandwidth-factor", 0.97);
128   xbt_cfg_setdefault_double("network/weight-S", 20537);
129
130   surf_network_model = new simgrid::surf::NetworkCm02Model(&simgrid::kernel::lmm::make_new_lagrange_system);
131   all_existing_models->push_back(surf_network_model);
132 }
133
134 namespace simgrid {
135 namespace surf {
136
137 NetworkCm02Model::NetworkCm02Model(kernel::lmm::System* (*make_new_lmm_system)(bool))
138     : NetworkModel(xbt_cfg_get_string("network/optim") == "Full" ? kernel::resource::Model::UpdateAlgo::Full
139                                                                  : kernel::resource::Model::UpdateAlgo::Lazy)
140 {
141   std::string optim = xbt_cfg_get_string("network/optim");
142   bool select = xbt_cfg_get_boolean("network/maxmin-selective-update");
143
144   if (optim == "Lazy") {
145     xbt_assert(select || xbt_cfg_is_default_value("network/maxmin-selective-update"),
146                "You cannot disable network selective update when using the lazy update mechanism");
147     select = true;
148   }
149
150   set_maxmin_system(make_new_lmm_system(select));
151   loopback_     = NetworkCm02Model::createLink("__loopback__", 498000000, 0.000015, SURF_LINK_FATPIPE);
152 }
153
154 LinkImpl* NetworkCm02Model::createLink(const std::string& name, double bandwidth, double latency,
155                                        e_surf_link_sharing_policy_t policy)
156 {
157   return new NetworkCm02Link(this, name, bandwidth, latency, policy, get_maxmin_system());
158 }
159
160 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
161 {
162   while (not actionHeapIsEmpty() && double_equals(actionHeapTopDate(), now, sg_surf_precision)) {
163
164     NetworkCm02Action* action = static_cast<NetworkCm02Action*>(actionHeapPop());
165     XBT_DEBUG("Something happened to action %p", action);
166     if (TRACE_is_enabled()) {
167       int n = action->get_variable()->get_number_of_constraint();
168
169       for (int i = 0; i < n; i++){
170         kernel::lmm::Constraint* constraint = action->get_variable()->get_constraint(i);
171         NetworkCm02Link* link       = static_cast<NetworkCm02Link*>(constraint->get_id());
172         double value = action->get_variable()->get_value() * action->get_variable()->get_constraint_weight(i);
173         TRACE_surf_link_set_utilization(link->getCname(), action->get_category(), value, action->get_last_update(),
174                                         now - action->get_last_update());
175       }
176     }
177
178     // if I am wearing a latency hat
179     if (action->get_type() == kernel::resource::Action::Type::LATENCY) {
180       XBT_DEBUG("Latency paid for action %p. Activating", action);
181       get_maxmin_system()->update_variable_weight(action->get_variable(), action->weight_);
182       action->heapRemove();
183       action->set_last_update();
184
185       // if I am wearing a max_duration or normal hat
186     } else if (action->get_type() == kernel::resource::Action::Type::MAX_DURATION ||
187                action->get_type() == kernel::resource::Action::Type::NORMAL) {
188       // no need to communicate anymore
189       // assume that flows that reached max_duration have remaining of 0
190       XBT_DEBUG("Action %p finished", action);
191       action->finish(kernel::resource::Action::State::done);
192       action->heapRemove();
193     }
194   }
195 }
196
197 void NetworkCm02Model::update_actions_state_full(double now, double delta)
198 {
199   for (auto it = std::begin(*get_running_action_set()); it != std::end(*get_running_action_set());) {
200     NetworkCm02Action& action = static_cast<NetworkCm02Action&>(*it);
201     ++it; // increment iterator here since the following calls to action.finish() may invalidate it
202     XBT_DEBUG("Something happened to action %p", &action);
203     double deltap = delta;
204     if (action.latency_ > 0) {
205       if (action.latency_ > deltap) {
206         double_update(&action.latency_, deltap, sg_surf_precision);
207         deltap = 0.0;
208       } else {
209         double_update(&deltap, action.latency_, sg_surf_precision);
210         action.latency_ = 0.0;
211       }
212       if (action.latency_ <= 0.0 && not action.is_suspended())
213         get_maxmin_system()->update_variable_weight(action.get_variable(), action.weight_);
214     }
215     if (TRACE_is_enabled()) {
216       int n = action.get_variable()->get_number_of_constraint();
217       for (int i = 0; i < n; i++) {
218         kernel::lmm::Constraint* constraint = action.get_variable()->get_constraint(i);
219         NetworkCm02Link* link = static_cast<NetworkCm02Link*>(constraint->get_id());
220         TRACE_surf_link_set_utilization(
221             link->getCname(), action.get_category(),
222             (action.get_variable()->get_value() * action.get_variable()->get_constraint_weight(i)),
223             action.get_last_update(), now - action.get_last_update());
224       }
225     }
226     if (not action.get_variable()->get_number_of_constraint()) {
227       /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
228        * vivaldi. In such case, just make sure that the action completes immediately.
229        */
230       action.update_remains(action.get_remains());
231     }
232     action.update_remains(action.get_variable()->get_value() * delta);
233
234     if (action.get_max_duration() > NO_MAX_DURATION)
235       action.update_max_duration(delta);
236
237     if (((action.get_remains() <= 0) && (action.get_variable()->get_weight() > 0)) ||
238         ((action.get_max_duration() > NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
239       action.finish(kernel::resource::Action::State::done);
240     }
241   }
242 }
243
244 kernel::resource::Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
245 {
246   int failed = 0;
247   double latency = 0.0;
248   std::vector<LinkImpl*> back_route;
249   std::vector<LinkImpl*> route;
250
251   XBT_IN("(%s,%s,%g,%g)", src->getCname(), dst->getCname(), size, rate);
252
253   src->routeTo(dst, route, &latency);
254   xbt_assert(not route.empty() || latency,
255              "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
256              src->getCname(), dst->getCname());
257
258   for (auto const& link : route)
259     if (link->isOff())
260       failed = 1;
261
262   if (sg_network_crosstraffic == 1) {
263     dst->routeTo(src, back_route, nullptr);
264     for (auto const& link : back_route)
265       if (link->isOff())
266         failed = 1;
267   }
268
269   NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
270   action->weight_ = latency;
271   action->latency_ = latency;
272   action->rate_ = rate;
273   if (getUpdateMechanism() == kernel::resource::Model::UpdateAlgo::Lazy) {
274     action->set_last_update();
275   }
276
277   double bandwidth_bound = -1.0;
278   if (sg_weight_S_parameter > 0)
279     for (auto const& link : route)
280       action->weight_ += sg_weight_S_parameter / link->bandwidth();
281
282   for (auto const& link : route) {
283     double bb       = bandwidthFactor(size) * link->bandwidth();
284     bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
285   }
286
287   action->latCurrent_ = action->latency_;
288   action->latency_ *= latencyFactor(size);
289   action->rate_ = bandwidthConstraint(action->rate_, bandwidth_bound, size);
290
291   int constraints_per_variable = route.size();
292   constraints_per_variable += back_route.size();
293
294   if (action->latency_ > 0) {
295     action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
296     if (getUpdateMechanism() == kernel::resource::Model::UpdateAlgo::Lazy) {
297       // add to the heap the event when the latency is payed
298       XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency_ + action->get_last_update());
299       action->heapInsert(action->latency_ + action->get_last_update(), route.empty()
300                                                                            ? kernel::resource::Action::Type::NORMAL
301                                                                            : kernel::resource::Action::Type::LATENCY);
302     }
303   } else
304     action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
305
306   if (action->rate_ < 0) {
307     get_maxmin_system()->update_variable_bound(
308         action->get_variable(), (action->latCurrent_ > 0) ? sg_tcp_gamma / (2.0 * action->latCurrent_) : -1.0);
309   } else {
310     get_maxmin_system()->update_variable_bound(action->get_variable(),
311                                                (action->latCurrent_ > 0)
312                                                    ? std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_))
313                                                    : action->rate_);
314   }
315
316   for (auto const& link : route)
317     get_maxmin_system()->expand(link->constraint(), action->get_variable(), 1.0);
318
319   if (not back_route.empty()) { //  sg_network_crosstraffic was activated
320     XBT_DEBUG("Crosstraffic active adding backward flow using 5%%");
321     for (auto const& link : back_route)
322       get_maxmin_system()->expand(link->constraint(), action->get_variable(), .05);
323
324     // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
325     // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
326     // action->getVariable()->set_concurrency_share(2)
327   }
328   XBT_OUT();
329
330   simgrid::s4u::Link::onCommunicate(action, src, dst);
331   return action;
332 }
333
334 /************
335  * Resource *
336  ************/
337 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
338                                  e_surf_link_sharing_policy_t policy, kernel::lmm::System* system)
339     : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
340 {
341   bandwidth_.scale = 1.0;
342   bandwidth_.peak  = bandwidth;
343
344   latency_.scale = 1.0;
345   latency_.peak  = latency;
346
347   if (policy == SURF_LINK_FATPIPE)
348     constraint()->unshare();
349
350   simgrid::s4u::Link::onCreation(this->piface_);
351 }
352
353 void NetworkCm02Link::apply_event(tmgr_trace_event_t triggered, double value)
354 {
355   /* Find out which of my iterators was triggered, and react accordingly */
356   if (triggered == bandwidth_.event) {
357     setBandwidth(value);
358     tmgr_trace_event_unref(&bandwidth_.event);
359
360   } else if (triggered == latency_.event) {
361     setLatency(value);
362     tmgr_trace_event_unref(&latency_.event);
363
364   } else if (triggered == stateEvent_) {
365     if (value > 0)
366       turnOn();
367     else {
368       kernel::lmm::Variable* var = nullptr;
369       const_lmm_element_t elem = nullptr;
370       double now               = surf_get_clock();
371
372       turnOff();
373       while ((var = constraint()->get_variable(&elem))) {
374         kernel::resource::Action* action = static_cast<kernel::resource::Action*>(var->get_id());
375
376         if (action->get_state() == kernel::resource::Action::State::running ||
377             action->get_state() == kernel::resource::Action::State::ready) {
378           action->set_finish_time(now);
379           action->set_state(kernel::resource::Action::State::failed);
380         }
381       }
382     }
383     tmgr_trace_event_unref(&stateEvent_);
384   } else {
385     xbt_die("Unknown event!\n");
386   }
387
388   XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)", constraint());
389 }
390
391 void NetworkCm02Link::setBandwidth(double value)
392 {
393   bandwidth_.peak = value;
394
395   model()->get_maxmin_system()->update_constraint_bound(constraint(),
396                                                         sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
397   TRACE_surf_link_set_bandwidth(surf_get_clock(), getCname(), sg_bandwidth_factor * bandwidth_.peak * bandwidth_.scale);
398
399   if (sg_weight_S_parameter > 0) {
400     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
401
402     kernel::lmm::Variable* var;
403     const_lmm_element_t elem     = nullptr;
404     const_lmm_element_t nextelem = nullptr;
405     int numelem                  = 0;
406     while ((var = constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
407       NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
408       action->weight_ += delta;
409       if (not action->is_suspended())
410         model()->get_maxmin_system()->update_variable_weight(action->get_variable(), action->weight_);
411     }
412   }
413 }
414
415 void NetworkCm02Link::setLatency(double value)
416 {
417   double delta                 = value - latency_.peak;
418   kernel::lmm::Variable* var   = nullptr;
419   const_lmm_element_t elem     = nullptr;
420   const_lmm_element_t nextelem = nullptr;
421   int numelem                  = 0;
422
423   latency_.peak = value;
424
425   while ((var = constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
426     NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
427     action->latCurrent_ += delta;
428     action->weight_ += delta;
429     if (action->rate_ < 0)
430       model()->get_maxmin_system()->update_variable_bound(action->get_variable(),
431                                                           sg_tcp_gamma / (2.0 * action->latCurrent_));
432     else {
433       model()->get_maxmin_system()->update_variable_bound(
434           action->get_variable(), std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)));
435
436       if (action->rate_ < sg_tcp_gamma / (2.0 * action->latCurrent_)) {
437         XBT_INFO("Flow is limited BYBANDWIDTH");
438       } else {
439         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->latCurrent_);
440       }
441     }
442     if (not action->is_suspended())
443       model()->get_maxmin_system()->update_variable_weight(action->get_variable(), action->weight_);
444   }
445 }
446
447 /**********
448  * Action *
449  **********/
450
451 void NetworkCm02Action::update_remains_lazy(double now)
452 {
453   if (suspended_ != Action::SuspendStates::not_suspended)
454     return;
455
456   double delta        = now - get_last_update();
457   double max_duration = get_max_duration();
458
459   if (get_remains_no_update() > 0) {
460     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
461               get_last_update());
462     update_remains(get_last_value() * delta);
463
464     XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
465   }
466
467   if (max_duration > NO_MAX_DURATION) {
468     double_update(&max_duration, delta, sg_surf_precision);
469     set_max_duration(max_duration);
470   }
471
472   if ((get_remains_no_update() <= 0 && (get_variable()->get_weight() > 0)) ||
473       ((max_duration > NO_MAX_DURATION) && (max_duration <= 0))) {
474     finish(Action::State::done);
475     heapRemove();
476   }
477
478   set_last_update();
479   set_last_value(get_variable()->get_value());
480 }
481
482 }
483 }