Logo AND Algorithmique Numérique Distribuée

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