Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
839cea34139a7c9ace89e5ff1f7d15b21e8d2974
[simgrid.git] / src / surf / network_cm02.cpp
1 /* Copyright (c) 2013-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include <algorithm>
8
9 #include "network_cm02.hpp"
10 #include "maxmin_private.hpp"
11 #include "simgrid/sg_config.h"
12 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
13
14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_network);
15
16 double sg_sender_gap = 0.0;
17 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
18 double sg_bandwidth_factor = 1.0;       /* default value; can be set by model or from command line */
19 double sg_weight_S_parameter = 0.0;     /* default value; can be set by model or from command line */
20
21 double sg_tcp_gamma = 0.0;
22 int sg_network_crosstraffic = 0;
23
24 /************************************************************************/
25 /* New model based on optimizations discussed during Pedro Velho's thesis*/
26 /************************************************************************/
27 /* @techreport{VELHO:2011:HAL-00646896:1, */
28 /*      url = {http://hal.inria.fr/hal-00646896/en/}, */
29 /*      title = {{Flow-level network models: have we reached the limits?}}, */
30 /*      author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
31 /*      type = {Rapport de recherche}, */
32 /*      institution = {INRIA}, */
33 /*      number = {RR-7821}, */
34 /*      year = {2011}, */
35 /*      month = Nov, */
36 /*      pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
37 /*  } */
38 void surf_network_model_init_LegrandVelho(void)
39 {
40   if (surf_network_model)
41     return;
42
43   surf_network_model = new simgrid::surf::NetworkCm02Model();
44   xbt_dynar_push(all_existing_models, &surf_network_model);
45
46   xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor",      13.01);
47   xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",     0.97);
48   xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S",         20537);
49 }
50
51 /***************************************************************************/
52 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
53 /***************************************************************************/
54 /* @TechReport{      rr-lip2002-40, */
55 /*   author        = {Henri Casanova and Loris Marchal}, */
56 /*   institution   = {LIP}, */
57 /*   title         = {A Network Model for Simulation of Grid Application}, */
58 /*   number        = {2002-40}, */
59 /*   month         = {oct}, */
60 /*   year          = {2002} */
61 /* } */
62 void surf_network_model_init_CM02(void)
63 {
64
65   if (surf_network_model)
66     return;
67
68   surf_network_model = new simgrid::surf::NetworkCm02Model();
69   xbt_dynar_push(all_existing_models, &surf_network_model);
70
71   xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor",   1.0);
72   xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor", 1.0);
73   xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S",         0.0);
74 }
75
76 /***************************************************************************/
77 /* The models from Steven H. Low                                           */
78 /***************************************************************************/
79 /* @article{Low03,                                                         */
80 /*   author={Steven H. Low},                                               */
81 /*   title={A Duality Model of {TCP} and Queue Management Algorithms},     */
82 /*   year={2003},                                                          */
83 /*   journal={{IEEE/ACM} Transactions on Networking},                      */
84 /*    volume={11}, number={4},                                             */
85 /*  }                                                                      */
86 void surf_network_model_init_Reno(void)
87 {
88   if (surf_network_model)
89     return;
90
91   surf_network_model = new simgrid::surf::NetworkCm02Model();
92   xbt_dynar_push(all_existing_models, &surf_network_model);
93
94   lmm_set_default_protocol_function(func_reno_f, func_reno_fp, func_reno_fpi);
95   surf_network_model->f_networkSolve = lagrange_solve;
96
97   xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor",     10.4);
98   xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",    0.92);
99   xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S",         8775);
100 }
101
102
103 void surf_network_model_init_Reno2(void)
104 {
105   if (surf_network_model)
106     return;
107
108   surf_network_model = new simgrid::surf::NetworkCm02Model();
109   xbt_dynar_push(all_existing_models, &surf_network_model);
110
111   lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp, func_reno2_fpi);
112   surf_network_model->f_networkSolve = lagrange_solve;
113
114   xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor",    10.4);
115   xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",   0.92);
116   xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S",        8775);
117 }
118
119 void surf_network_model_init_Vegas(void)
120 {
121   if (surf_network_model)
122     return;
123
124   surf_network_model = new simgrid::surf::NetworkCm02Model();
125   xbt_dynar_push(all_existing_models, &surf_network_model);
126
127   lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp, func_vegas_fpi);
128   surf_network_model->f_networkSolve = lagrange_solve;
129
130   xbt_cfg_setdefault_double(_sg_cfg_set, "network/latency_factor",    10.4);
131   xbt_cfg_setdefault_double(_sg_cfg_set, "network/bandwidth_factor",   0.92);
132   xbt_cfg_setdefault_double(_sg_cfg_set, "network/weight_S",        8775);
133 }
134
135 namespace simgrid {
136 namespace surf {
137
138 NetworkCm02Model::NetworkCm02Model()
139   :NetworkModel()
140 {
141   char *optim = xbt_cfg_get_string(_sg_cfg_set, "network/optim");
142   int select = xbt_cfg_get_boolean(_sg_cfg_set, "network/maxmin_selective_update");
143
144   if (!strcmp(optim, "Full")) {
145     updateMechanism_ = UM_FULL;
146     selectiveUpdate_ = select;
147   } else if (!strcmp(optim, "Lazy")) {
148     updateMechanism_ = UM_LAZY;
149     selectiveUpdate_ = 1;
150     xbt_assert((select == 1) || (xbt_cfg_is_default_value(_sg_cfg_set, "network/maxmin_selective_update")),
151                "Disabling selective update while using the lazy update mechanism is dumb!");
152   } else {
153     xbt_die("Unsupported optimization (%s) for this model", optim);
154   }
155
156   if (!maxminSystem_)
157     maxminSystem_ = lmm_system_new(selectiveUpdate_);
158
159   routing_model_create(createLink("__loopback__", 498000000, 0.000015, SURF_LINK_FATPIPE, NULL));
160
161   if (updateMechanism_ == UM_LAZY) {
162   actionHeap_ = xbt_heap_new(8, NULL);
163   xbt_heap_set_update_callback(actionHeap_, surf_action_lmm_update_index_heap);
164   modifiedSet_ = new ActionLmmList();
165   maxminSystem_->keep_track = modifiedSet_;
166   }
167 }
168
169 Link* NetworkCm02Model::createLink(const char *name, double bandwidth, double latency, e_surf_link_sharing_policy_t policy,
170     xbt_dict_t properties)
171 {
172   return new NetworkCm02Link(this, name, properties, bandwidth, latency, policy, maxminSystem_);
173 }
174
175 void NetworkCm02Model::updateActionsStateLazy(double now, double /*delta*/)
176 {
177   NetworkCm02Action *action;
178   while ((xbt_heap_size(actionHeap_) > 0)
179          && (double_equals(xbt_heap_maxkey(actionHeap_), now, sg_surf_precision))) {
180     action = static_cast<NetworkCm02Action*> (xbt_heap_pop(actionHeap_));
181     XBT_DEBUG("Something happened to action %p", action);
182     if (TRACE_is_enabled()) {
183       int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
184
185       for (int i = 0; i < n; i++){
186         lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
187         NetworkCm02Link *link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
188         TRACE_surf_link_set_utilization(link->getName(),
189                                         action->getCategory(),
190                                         (lmm_variable_getvalue(action->getVariable())*
191                                             lmm_get_cnst_weight_from_var(maxminSystem_,
192                                                 action->getVariable(),
193                                                 i)),
194                                         action->getLastUpdate(),
195                                         now - action->getLastUpdate());
196       }
197     }
198
199     // if I am wearing a latency hat
200     if (action->getHat() == LATENCY) {
201       XBT_DEBUG("Latency paid for action %p. Activating", action);
202       lmm_update_variable_weight(maxminSystem_, action->getVariable(), action->weight_);
203       action->heapRemove(actionHeap_);
204       action->refreshLastUpdate();
205
206         // if I am wearing a max_duration or normal hat
207     } else if (action->getHat() == MAX_DURATION ||
208         action->getHat() == NORMAL) {
209         // no need to communicate anymore
210         // assume that flows that reached max_duration have remaining of 0
211       XBT_DEBUG("Action %p finished", action);
212       action->setRemains(0);
213       action->finish();
214       action->setState(Action::State::done);
215       action->heapRemove(actionHeap_);
216
217       action->gapRemove();
218     }
219   }
220   return;
221 }
222
223
224 void NetworkCm02Model::updateActionsStateFull(double now, double delta)
225 {
226   NetworkCm02Action *action;
227   ActionList *running_actions = getRunningActionSet();
228
229   for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
230      ; it != itend ; it=itNext) {
231   ++itNext;
232
233     action = static_cast<NetworkCm02Action*> (&*it);
234     XBT_DEBUG("Something happened to action %p", action);
235       double deltap = delta;
236       if (action->latency_ > 0) {
237         if (action->latency_ > deltap) {
238           double_update(&(action->latency_), deltap, sg_surf_precision);
239           deltap = 0.0;
240         } else {
241           double_update(&(deltap), action->latency_, sg_surf_precision);
242           action->latency_ = 0.0;
243         }
244         if (action->latency_ == 0.0 && !(action->isSuspended()))
245           lmm_update_variable_weight(maxminSystem_, action->getVariable(),
246               action->weight_);
247       }
248       if (TRACE_is_enabled()) {
249         int n = lmm_get_number_of_cnst_from_var(maxminSystem_, action->getVariable());
250         for (int i = 0; i < n; i++){
251           lmm_constraint_t constraint = lmm_get_cnst_from_var(maxminSystem_, action->getVariable(), i);
252
253           NetworkCm02Link* link = static_cast<NetworkCm02Link*>(lmm_constraint_id(constraint));
254           TRACE_surf_link_set_utilization(link->getName(),
255                                         action->getCategory(),
256                                         (lmm_variable_getvalue(action->getVariable())*
257                                             lmm_get_cnst_weight_from_var(maxminSystem_,
258                                                 action->getVariable(),
259                                                 i)),
260                                         action->getLastUpdate(),
261                                         now - action->getLastUpdate());
262         }
263       }
264       if (!lmm_get_number_of_cnst_from_var (maxminSystem_, action->getVariable())) {
265         /* There is actually no link used, hence an infinite bandwidth.
266          * This happens often when using models like vivaldi.
267          * In such case, just make sure that the action completes immediately.
268          */
269         action->updateRemains(action->getRemains());
270       }
271     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
272                   
273     if (action->getMaxDuration() != NO_MAX_DURATION)
274       action->updateMaxDuration(delta);
275       
276     if ((action->getRemains() <= 0) &&
277         (lmm_get_variable_weight(action->getVariable()) > 0)) {
278       action->finish();
279       action->setState(Action::State::done);
280       action->gapRemove();
281     } else if (((action->getMaxDuration() != NO_MAX_DURATION)
282         && (action->getMaxDuration() <= 0))) {
283       action->finish();
284       action->setState(Action::State::done);
285       action->gapRemove();
286     }
287   }
288 }
289
290 Action *NetworkCm02Model::communicate(NetCard *src, NetCard *dst, double size, double rate)
291 {
292   int failed = 0;
293   double bandwidth_bound;
294   double latency = 0.0;
295   std::vector<Link*> * back_route = NULL;
296   int constraints_per_variable = 0;
297
298   std::vector<Link*> *route = new std::vector<Link*>();
299
300   XBT_IN("(%s,%s,%g,%g)", src->name(), dst->name(), size, rate);
301
302   routing_platf->getRouteAndLatency(src, dst, route, &latency);
303   xbt_assert(! route->empty() || latency,
304              "You're trying to send data from %s to %s but there is no connecting path between these two hosts.",
305              src->name(), dst->name());
306
307   for (auto link: *route)
308     if (link->isOff())
309       failed = 1;
310
311   if (sg_network_crosstraffic == 1) {
312     back_route = new std::vector<Link*>();
313     routing_platf->getRouteAndLatency(dst, src, back_route, NULL);
314     for (auto link: *back_route)
315       if (link->isOff())
316         failed = 1;
317   }
318
319   NetworkCm02Action *action = new NetworkCm02Action(this, size, failed);
320   action->weight_ = action->latency_ = latency;
321
322   action->rate_ = rate;
323   if (updateMechanism_ == UM_LAZY) {
324     action->indexHeap_ = -1;
325     action->lastUpdate_ = surf_get_clock();
326   }
327
328   bandwidth_bound = -1.0;
329   if (sg_weight_S_parameter > 0)
330     for (auto link : *route)
331       action->weight_ += sg_weight_S_parameter / link->getBandwidth();
332
333   for (auto link : *route) {
334     double bb = bandwidthFactor(size) * link->getBandwidth();
335     bandwidth_bound = (bandwidth_bound < 0.0) ? bb : std::min(bandwidth_bound, bb);
336   }
337
338   action->latCurrent_ = action->latency_;
339   action->latency_ *= latencyFactor(size);
340   action->rate_ = bandwidthConstraint(action->rate_, bandwidth_bound, size);
341   if (haveGap_) {
342     xbt_assert(! route->empty(),
343                "Using a model with a gap (e.g., SMPI) with a platform without links (e.g. vivaldi)!!!");
344
345     gapAppend(size, route->at(0), action);
346     XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)", action, src->name(), dst->name(), action->senderGap_, action->latency_);
347   }
348
349   constraints_per_variable = route->size();
350   if (back_route != NULL)
351     constraints_per_variable += back_route->size();
352
353   if (action->latency_ > 0) {
354     action->variable_ = lmm_variable_new(maxminSystem_, action, 0.0, -1.0, constraints_per_variable);
355     if (updateMechanism_ == UM_LAZY) {
356       // add to the heap the event when the latency is payed
357       XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency_ + action->lastUpdate_);
358       action->heapInsert(actionHeap_, action->latency_ + action->lastUpdate_, route->empty() ? NORMAL : LATENCY);
359     }
360   } else
361     action->variable_ = lmm_variable_new(maxminSystem_, action, 1.0, -1.0, constraints_per_variable);
362
363   if (action->rate_ < 0) {
364     lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? sg_tcp_gamma / (2.0 * action->latCurrent_) : -1.0);
365   } else {
366     lmm_update_variable_bound(maxminSystem_, action->getVariable(), (action->latCurrent_ > 0) ? std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)) : action->rate_);
367   }
368
369   for (auto link: *route)
370     lmm_expand(maxminSystem_, link->getConstraint(), action->getVariable(), 1.0);
371
372   if (sg_network_crosstraffic == 1) {
373     XBT_DEBUG("Fullduplex active adding backward flow using 5%%");
374     for (auto link : *back_route)
375       lmm_expand(maxminSystem_, link->getConstraint(), action->getVariable(), .05);
376      
377     //Change concurrency_share here, if you want that cross-traffic is included in the SURF concurrency
378     //(You would also have to change lmm_element_concurrency())
379     //lmm_variable_concurrency_share_set(action->getVariable(),2);
380   }
381
382   delete route;
383   XBT_OUT();
384
385   Link::onCommunicate(action, src, dst);
386   return action;
387 }
388
389 /************
390  * Resource *
391  ************/
392 NetworkCm02Link::NetworkCm02Link(NetworkCm02Model *model, const char *name, xbt_dict_t props,
393     double bandwidth,  double latency, e_surf_link_sharing_policy_t policy,
394     lmm_system_t system)
395 : Link(model, name, props, lmm_constraint_new(system, this, sg_bandwidth_factor * bandwidth))
396 {
397   m_bandwidth.scale = 1.0;
398   m_bandwidth.peak = bandwidth;
399
400   m_latency.scale = 1.0;
401   m_latency.peak = latency;
402
403   if (policy == SURF_LINK_FATPIPE)
404     lmm_constraint_shared(getConstraint());
405
406   Link::onCreation(this);
407 }
408
409
410
411 void NetworkCm02Link::apply_event(tmgr_trace_iterator_t triggered, double value)
412 {
413
414   /* Find out which of my iterators was triggered, and react accordingly */
415   if (triggered == m_bandwidth.event) {
416     updateBandwidth(value);
417     tmgr_trace_event_unref(&m_bandwidth.event);
418
419   } else if (triggered == m_latency.event) {
420     updateLatency(value);
421     tmgr_trace_event_unref(&m_latency.event);
422
423   } else if (triggered == m_stateEvent) {
424     if (value > 0)
425       turnOn();
426     else {
427       lmm_variable_t var = NULL;
428       lmm_element_t elem = NULL;
429       double now = surf_get_clock();
430
431       turnOff();
432       while ((var = lmm_get_var_from_cnst(getModel()->getMaxminSystem(), getConstraint(), &elem))) {
433         Action *action = static_cast<Action*>( lmm_variable_id(var) );
434
435         if (action->getState() == Action::State::running ||
436             action->getState() == Action::State::ready) {
437           action->setFinishTime(now);
438           action->setState(Action::State::failed);
439         }
440       }
441     }
442     tmgr_trace_event_unref(&m_stateEvent);
443   } else {
444     xbt_die("Unknown event!\n");
445   }
446
447   XBT_DEBUG("There was a resource state event, need to update actions related to the constraint (%p)",
448        getConstraint());
449 }
450
451 void NetworkCm02Link::updateBandwidth(double value) {
452
453   m_bandwidth.peak = value;
454
455   lmm_update_constraint_bound(getModel()->getMaxminSystem(), getConstraint(),
456       sg_bandwidth_factor * (m_bandwidth.peak * m_bandwidth.scale));
457   TRACE_surf_link_set_bandwidth(surf_get_clock(), getName(), sg_bandwidth_factor * m_bandwidth.peak * m_bandwidth.scale);
458
459   if (sg_weight_S_parameter > 0) {
460     double delta = sg_weight_S_parameter / value - sg_weight_S_parameter / (m_bandwidth.peak * m_bandwidth.scale);
461
462     lmm_variable_t var;
463     lmm_element_t elem = NULL, nextelem = NULL;
464     int numelem = 0;
465     while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
466       NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
467       action->weight_ += delta;
468       if (!action->isSuspended())
469         lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->weight_);
470     }
471   }
472 }
473
474 void NetworkCm02Link::updateLatency(double value){
475   double delta = value - m_latency.peak;
476   lmm_variable_t var = NULL;
477   lmm_element_t elem = NULL;
478   lmm_element_t nextelem = NULL;
479   int numelem = 0;
480
481   m_latency.peak = value;
482
483   while ((var = lmm_get_var_from_cnst_safe(getModel()->getMaxminSystem(), getConstraint(), &elem, &nextelem, &numelem))) {
484     NetworkCm02Action *action = (NetworkCm02Action*) lmm_variable_id(var);
485     action->latCurrent_ += delta;
486     action->weight_ += delta;
487     if (action->rate_ < 0)
488       lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(), sg_tcp_gamma / (2.0 * action->latCurrent_));
489     else {
490       lmm_update_variable_bound(getModel()->getMaxminSystem(), action->getVariable(),
491                                 std::min(action->rate_, sg_tcp_gamma / (2.0 * action->latCurrent_)));
492
493       if (action->rate_ < sg_tcp_gamma / (2.0 * action->latCurrent_)) {
494         XBT_INFO("Flow is limited BYBANDWIDTH");
495       } else {
496         XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f", action->latCurrent_);
497       }
498     }
499     if (!action->isSuspended())
500       lmm_update_variable_weight(getModel()->getMaxminSystem(), action->getVariable(), action->weight_);
501   }
502 }
503
504 /**********
505  * Action *
506  **********/
507 void NetworkCm02Action::updateRemainingLazy(double now)
508 {
509   double delta = 0.0;
510
511   if (suspended_ != 0)
512     return;
513
514   delta = now - lastUpdate_;
515
516   if (remains_ > 0) {
517     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
518     double_update(&(remains_), lastValue_ * delta, sg_maxmin_precision*sg_surf_precision);
519
520     XBT_DEBUG("Updating action(%p): remains is now %f", this, remains_);
521   }
522
523   if (maxDuration_ != NO_MAX_DURATION)
524     double_update(&maxDuration_, delta, sg_surf_precision);
525
526   if (remains_ <= 0 &&
527       (lmm_get_variable_weight(getVariable()) > 0)) {
528     finish();
529     setState(Action::State::done);
530
531     heapRemove(getModel()->getActionHeap());
532   } else if (((maxDuration_ != NO_MAX_DURATION)
533       && (maxDuration_ <= 0))) {
534     finish();
535     setState(Action::State::done);
536     heapRemove(getModel()->getActionHeap());
537   }
538
539   lastUpdate_ = now;
540   lastValue_ = lmm_variable_getvalue(getVariable());
541 }
542
543 }
544 }