Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
4065a0d31591f08abac537f4ca2a183771201d08
[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.h"
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   set_default_protocol_function(simgrid::kernel::lmm::func_reno_f, simgrid::kernel::lmm::func_reno_fp,
91                                 simgrid::kernel::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::lagrange_solve);
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   set_default_protocol_function(simgrid::kernel::lmm::func_reno2_f, simgrid::kernel::lmm::func_reno2_fp,
108                                 simgrid::kernel::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::lagrange_solve);
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   set_default_protocol_function(simgrid::kernel::lmm::func_vegas_f, simgrid::kernel::lmm::func_vegas_fp,
124                                 simgrid::kernel::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::lagrange_solve);
131   all_existing_models->push_back(surf_network_model);
132 }
133
134 namespace simgrid {
135 namespace surf {
136
137 NetworkCm02Model::NetworkCm02Model()
138   :NetworkModel()
139 {
140   std::string optim = xbt_cfg_get_string("network/optim");
141   bool select = xbt_cfg_get_boolean("network/maxmin-selective-update");
142
143   if (optim == "Full") {
144     setUpdateMechanism(UM_FULL);
145   } else if (optim == "Lazy") {
146     xbt_assert(select || xbt_cfg_is_default_value("network/maxmin-selective-update"),
147                "You cannot disable network selective update when using the lazy update mechanism");
148     select = true;
149     setUpdateMechanism(UM_LAZY);
150   } else {
151     xbt_die("Unsupported optimization (%s) for this model. Accepted: Full, Lazy.", optim.c_str());
152   }
153
154   set_maxmin_system(new simgrid::kernel::lmm::System(select));
155   loopback_     = NetworkCm02Model::createLink("__loopback__", 498000000, 0.000015, SURF_LINK_FATPIPE);
156
157   if (getUpdateMechanism() == UM_LAZY)
158     get_maxmin_system()->modified_set_ = new kernel::resource::Action::ModifiedSet();
159 }
160
161 NetworkCm02Model::NetworkCm02Model(void (*specificSolveFun)(kernel::lmm::System* self)) : NetworkCm02Model()
162 {
163   get_maxmin_system()->solve_fun = specificSolveFun;
164 }
165
166 LinkImpl* NetworkCm02Model::createLink(const std::string& name, double bandwidth, double latency,
167                                        e_surf_link_sharing_policy_t policy)
168 {
169   return new NetworkCm02Link(this, name, bandwidth, latency, policy, get_maxmin_system());
170 }
171
172 void NetworkCm02Model::update_actions_state_lazy(double now, double /*delta*/)
173 {
174   while (not actionHeapIsEmpty() && double_equals(actionHeapTopDate(), now, sg_surf_precision)) {
175
176     NetworkCm02Action* action = static_cast<NetworkCm02Action*>(actionHeapPop());
177     XBT_DEBUG("Something happened to action %p", action);
178     if (TRACE_is_enabled()) {
179       int n = action->get_variable()->get_number_of_constraint();
180
181       for (int i = 0; i < n; i++){
182         kernel::lmm::Constraint* constraint = action->get_variable()->get_constraint(i);
183         NetworkCm02Link* link       = static_cast<NetworkCm02Link*>(constraint->get_id());
184         double value = action->get_variable()->get_value() * action->get_variable()->get_constraint_weight(i);
185         TRACE_surf_link_set_utilization(link->getCname(), action->get_category(), value, action->get_last_update(),
186                                         now - action->get_last_update());
187       }
188     }
189
190     // if I am wearing a latency hat
191     if (action->get_type() == kernel::resource::Action::Type::LATENCY) {
192       XBT_DEBUG("Latency paid for action %p. Activating", action);
193       get_maxmin_system()->update_variable_weight(action->get_variable(), action->weight_);
194       action->heapRemove();
195       action->set_last_update();
196
197       // if I am wearing a max_duration or normal hat
198     } else if (action->get_type() == kernel::resource::Action::Type::MAX_DURATION ||
199                action->get_type() == kernel::resource::Action::Type::NORMAL) {
200       // no need to communicate anymore
201       // assume that flows that reached max_duration have remaining of 0
202       XBT_DEBUG("Action %p finished", action);
203       action->finish(kernel::resource::Action::State::done);
204       action->heapRemove();
205     }
206   }
207 }
208
209 void NetworkCm02Model::update_actions_state_full(double now, double delta)
210 {
211   for (auto it = std::begin(*get_running_action_set()); it != std::end(*get_running_action_set());) {
212     NetworkCm02Action& action = static_cast<NetworkCm02Action&>(*it);
213     ++it; // increment iterator here since the following calls to action.finish() may invalidate it
214     XBT_DEBUG("Something happened to action %p", &action);
215     double deltap = delta;
216     if (action.latency_ > 0) {
217       if (action.latency_ > deltap) {
218         double_update(&action.latency_, deltap, sg_surf_precision);
219         deltap = 0.0;
220       } else {
221         double_update(&deltap, action.latency_, sg_surf_precision);
222         action.latency_ = 0.0;
223       }
224       if (action.latency_ <= 0.0 && not action.is_suspended())
225         get_maxmin_system()->update_variable_weight(action.get_variable(), action.weight_);
226     }
227     if (TRACE_is_enabled()) {
228       int n = action.get_variable()->get_number_of_constraint();
229       for (int i = 0; i < n; i++) {
230         kernel::lmm::Constraint* constraint = action.get_variable()->get_constraint(i);
231         NetworkCm02Link* link = static_cast<NetworkCm02Link*>(constraint->get_id());
232         TRACE_surf_link_set_utilization(
233             link->getCname(), action.get_category(),
234             (action.get_variable()->get_value() * action.get_variable()->get_constraint_weight(i)),
235             action.get_last_update(), now - action.get_last_update());
236       }
237     }
238     if (not action.get_variable()->get_number_of_constraint()) {
239       /* There is actually no link used, hence an infinite bandwidth. This happens often when using models like
240        * vivaldi. In such case, just make sure that the action completes immediately.
241        */
242       action.update_remains(action.get_remains());
243     }
244     action.update_remains(action.get_variable()->get_value() * delta);
245
246     if (action.get_max_duration() > NO_MAX_DURATION)
247       action.update_max_duration(delta);
248
249     if (((action.get_remains() <= 0) && (action.get_variable()->get_weight() > 0)) ||
250         ((action.get_max_duration() > NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
251       action.finish(kernel::resource::Action::State::done);
252     }
253   }
254 }
255
256 kernel::resource::Action* NetworkCm02Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate)
257 {
258   int failed = 0;
259   double latency = 0.0;
260   std::vector<LinkImpl*> back_route;
261   std::vector<LinkImpl*> route;
262
263   XBT_IN("(%s,%s,%g,%g)", src->getCname(), dst->getCname(), size, rate);
264
265   src->routeTo(dst, route, &latency);
266   xbt_assert(not route.empty() || latency,
267              "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
268              src->getCname(), dst->getCname());
269
270   for (auto const& link : route)
271     if (link->isOff())
272       failed = 1;
273
274   if (sg_network_crosstraffic == 1) {
275     dst->routeTo(src, back_route, nullptr);
276     for (auto const& link : back_route)
277       if (link->isOff())
278         failed = 1;
279   }
280
281   NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
282   action->weight_ = latency;
283   action->latency_ = latency;
284   action->rate_ = rate;
285   if (getUpdateMechanism() == UM_LAZY) {
286     action->set_last_update();
287   }
288
289   double bandwidth_bound = -1.0;
290   if (sg_weight_S_parameter > 0)
291     for (auto const& link : route)
292       action->weight_ += sg_weight_S_parameter / link->bandwidth();
293
294   for (auto const& link : route) {
295     double bb       = bandwidthFactor(size) * link->bandwidth();
296     bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
297   }
298
299   action->latCurrent_ = action->latency_;
300   action->latency_ *= latencyFactor(size);
301   action->rate_ = bandwidthConstraint(action->rate_, bandwidth_bound, size);
302
303   int constraints_per_variable = route.size();
304   constraints_per_variable += back_route.size();
305
306   if (action->latency_ > 0) {
307     action->set_variable(get_maxmin_system()->variable_new(action, 0.0, -1.0, constraints_per_variable));
308     if (getUpdateMechanism() == UM_LAZY) {
309       // add to the heap the event when the latency is payed
310       XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency_ + action->get_last_update());
311       action->heapInsert(action->latency_ + action->get_last_update(), route.empty()
312                                                                            ? kernel::resource::Action::Type::NORMAL
313                                                                            : kernel::resource::Action::Type::LATENCY);
314     }
315   } else
316     action->set_variable(get_maxmin_system()->variable_new(action, 1.0, -1.0, constraints_per_variable));
317
318   if (action->rate_ < 0) {
319     get_maxmin_system()->update_variable_bound(
320         action->get_variable(), (action->latCurrent_ > 0) ? sg_tcp_gamma / (2.0 * action->latCurrent_) : -1.0);
321   } else {
322     get_maxmin_system()->update_variable_bound(action->get_variable(),
323                                                (action->latCurrent_ > 0)
324                                                    ? std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_))
325                                                    : action->rate_);
326   }
327
328   for (auto const& link : route)
329     get_maxmin_system()->expand(link->constraint(), action->get_variable(), 1.0);
330
331   if (not back_route.empty()) { //  sg_network_crosstraffic was activated
332     XBT_DEBUG("Crosstraffic active adding backward flow using 5%%");
333     for (auto const& link : back_route)
334       get_maxmin_system()->expand(link->constraint(), action->get_variable(), .05);
335
336     // Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
337     // (You would also have to change simgrid::kernel::lmm::Element::get_concurrency())
338     // action->getVariable()->set_concurrency_share(2)
339   }
340   XBT_OUT();
341
342   simgrid::s4u::Link::onCommunicate(action, src, dst);
343   return action;
344 }
345
346 /************
347  * Resource *
348  ************/
349 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model* model, const std::string& name, double bandwidth, double latency,
350                                  e_surf_link_sharing_policy_t policy, kernel::lmm::System* system)
351     : LinkImpl(model, name, system->constraint_new(this, sg_bandwidth_factor * bandwidth))
352 {
353   bandwidth_.scale = 1.0;
354   bandwidth_.peak  = bandwidth;
355
356   latency_.scale = 1.0;
357   latency_.peak  = latency;
358
359   if (policy == SURF_LINK_FATPIPE)
360     constraint()->unshare();
361
362   simgrid::s4u::Link::onCreation(this->piface_);
363 }
364
365 void NetworkCm02Link::apply_event(tmgr_trace_event_t triggered, double value)
366 {
367   /* Find out which of my iterators was triggered, and react accordingly */
368   if (triggered == bandwidth_.event) {
369     setBandwidth(value);
370     tmgr_trace_event_unref(&bandwidth_.event);
371
372   } else if (triggered == latency_.event) {
373     setLatency(value);
374     tmgr_trace_event_unref(&latency_.event);
375
376   } else if (triggered == stateEvent_) {
377     if (value > 0)
378       turnOn();
379     else {
380       kernel::lmm::Variable* var = nullptr;
381       const_lmm_element_t elem = nullptr;
382       double now               = surf_get_clock();
383
384       turnOff();
385       while ((var = constraint()->get_variable(&elem))) {
386         kernel::resource::Action* action = static_cast<kernel::resource::Action*>(var->get_id());
387
388         if (action->get_state() == kernel::resource::Action::State::running ||
389             action->get_state() == kernel::resource::Action::State::ready) {
390           action->set_finish_time(now);
391           action->set_state(kernel::resource::Action::State::failed);
392         }
393       }
394     }
395     tmgr_trace_event_unref(&stateEvent_);
396   } else {
397     xbt_die("Unknown event!\n");
398   }
399
400   XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)", constraint());
401 }
402
403 void NetworkCm02Link::setBandwidth(double value)
404 {
405   bandwidth_.peak = value;
406
407   model()->get_maxmin_system()->update_constraint_bound(constraint(),
408                                                         sg_bandwidth_factor * (bandwidth_.peak * bandwidth_.scale));
409   TRACE_surf_link_set_bandwidth(surf_get_clock(), getCname(), sg_bandwidth_factor * bandwidth_.peak * bandwidth_.scale);
410
411   if (sg_weight_S_parameter > 0) {
412     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (bandwidth_.peak * bandwidth_.scale);
413
414     kernel::lmm::Variable* var;
415     const_lmm_element_t elem     = nullptr;
416     const_lmm_element_t nextelem = nullptr;
417     int numelem                  = 0;
418     while ((var = constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
419       NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
420       action->weight_ += delta;
421       if (not action->is_suspended())
422         model()->get_maxmin_system()->update_variable_weight(action->get_variable(), action->weight_);
423     }
424   }
425 }
426
427 void NetworkCm02Link::setLatency(double value)
428 {
429   double delta                 = value - latency_.peak;
430   kernel::lmm::Variable* var   = nullptr;
431   const_lmm_element_t elem     = nullptr;
432   const_lmm_element_t nextelem = nullptr;
433   int numelem                  = 0;
434
435   latency_.peak = value;
436
437   while ((var = constraint()->get_variable_safe(&elem, &nextelem, &numelem))) {
438     NetworkCm02Action* action = static_cast<NetworkCm02Action*>(var->get_id());
439     action->latCurrent_ += delta;
440     action->weight_ += delta;
441     if (action->rate_ < 0)
442       model()->get_maxmin_system()->update_variable_bound(action->get_variable(),
443                                                           sg_tcp_gamma / (2.0 * action->latCurrent_));
444     else {
445       model()->get_maxmin_system()->update_variable_bound(
446           action->get_variable(), std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)));
447
448       if (action->rate_ < sg_tcp_gamma / (2.0 * action->latCurrent_)) {
449         XBT_INFO("Flow is limited BYBANDWIDTH");
450       } else {
451         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->latCurrent_);
452       }
453     }
454     if (not action->is_suspended())
455       model()->get_maxmin_system()->update_variable_weight(action->get_variable(), action->weight_);
456   }
457 }
458
459 /**********
460  * Action *
461  **********/
462
463 void NetworkCm02Action::update_remains_lazy(double now)
464 {
465   if (suspended_ != Action::SuspendStates::not_suspended)
466     return;
467
468   double delta        = now - get_last_update();
469   double max_duration = get_max_duration();
470
471   if (get_remains_no_update() > 0) {
472     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
473               get_last_update());
474     update_remains(get_last_value() * delta);
475
476     XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
477   }
478
479   if (max_duration > NO_MAX_DURATION) {
480     double_update(&max_duration, delta, sg_surf_precision);
481     set_max_duration(max_duration);
482   }
483
484   if ((get_remains_no_update() <= 0 && (get_variable()->get_weight() > 0)) ||
485       ((max_duration > NO_MAX_DURATION) && (max_duration <= 0))) {
486     finish(Action::State::done);
487     heapRemove();
488   }
489
490   set_last_update();
491   set_last_value(get_variable()->get_value());
492 }
493
494 }
495 }