Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Get rid of all these nasty _im_.
[simgrid.git] / src / surf / network.c
1
2 /*
3  * Network with improved management of tasks, IM (Improved Management).
4  * Uses a heap to store actions so that the share_resources is faster.
5  * This model automatically sets the selective update flag to 1 and is
6  * highly dependent on the maxmin lmm module.
7  */
8
9 /* Copyright (c) 2009, 2010, 2011. The SimGrid Team.
10  * All rights reserved.                                                     */
11
12 /* This program is free software; you can redistribute it and/or modify it
13  * under the terms of the license (GNU LGPL) which comes with this package. */
14
15 #include "network_private.h"
16 #include "xbt/log.h"
17 #include "xbt/str.h"
18
19 #include "surf_private.h"
20 #include "xbt/dict.h"
21 #include "maxmin_private.h"
22 #include "surf/surfxml_parse_values.h"
23 #include "surf/surf_resource.h"
24 #include "surf/surf_resource_lmm.h"
25
26 #undef GENERIC_ACTION
27 #define GENERIC_ACTION(action) action->generic_action
28
29
30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_network, surf,
31                                 "Logging specific to the SURF network module");
32
33 surf_model_t surf_network_model = NULL;
34 static lmm_system_t network_maxmin_system = NULL;
35 static void (*network_solve) (lmm_system_t) = NULL;
36
37 double sg_sender_gap = 0.0;
38 double sg_latency_factor = 1.0; /* default value; can be set by model or from command line */
39 double sg_bandwidth_factor = 1.0;       /* default value; can be set by model or from command line */
40 double sg_weight_S_parameter = 0.0;     /* default value; can be set by model or from command line */
41
42 double sg_tcp_gamma = 0.0;
43 int sg_network_crosstraffic = 0;
44
45 xbt_dict_t gap_lookup = NULL;
46
47 e_UM_t network_update_mechanism = UM_UNDEFINED;
48 static int selective_update = 0;
49
50 static int net_action_is_suspended(surf_action_t action);
51 static void net_update_actions_state(double now, double delta);
52 static void update_action_remaining(double now);
53
54 static xbt_swag_t net_modified_set = NULL;
55 static xbt_heap_t net_action_heap = NULL;
56 xbt_swag_t keep_track = NULL;
57 extern int sg_maxmin_selective_update;
58
59 #ifdef HAVE_SMPI
60 static void gap_append(double size, const link_CM02_t link, surf_action_network_CM02_t action);
61 static void gap_unknown(surf_action_network_CM02_t action);
62 static void gap_remove(surf_action_network_CM02_t action);
63 #endif
64
65 /* added to manage the communication action's heap */
66 static void net_action_update_index_heap(void *action, int i)
67 {
68   ((surf_action_network_CM02_t) action)->index_heap = i;
69 }
70
71 /* insert action on heap using a given key and a hat (heap_action_type)
72  * a hat can be of three types for communications:
73  *
74  * NORMAL = this is a normal heap entry stating the date to finish transmitting
75  * LATENCY = this is a heap entry to warn us when the latency is payed
76  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
77  */
78 static void heap_insert(surf_action_network_CM02_t    action, double key, enum heap_action_type hat){
79   action->hat = hat;
80   xbt_heap_push(net_action_heap, action, key);
81 }
82
83 static void heap_remove(surf_action_network_CM02_t action){
84   action->hat = NONE;
85   if(((surf_action_network_CM02_t) action)->index_heap >= 0){
86       xbt_heap_remove(net_action_heap,action->index_heap);
87   }
88 }
89
90 /******************************************************************************/
91 /*                           Factors callbacks                                */
92 /******************************************************************************/
93 static double constant_latency_factor(double size)
94 {
95   return sg_latency_factor;
96 }
97
98 static double constant_bandwidth_factor(double size)
99 {
100   return sg_bandwidth_factor;
101 }
102
103 static double constant_bandwidth_constraint(double rate, double bound,
104                                             double size)
105 {
106   return rate;
107 }
108
109
110 /**********************/
111 /*   SMPI callbacks   */
112 /**********************/
113 static double smpi_latency_factor(double size)
114 {
115   /* 1 B <= size <= 1 KiB */
116   if (size <= 1024.0) {
117     return 1.0056;
118   }
119
120   /* 2 KiB <= size <= 32 KiB */
121   if (size <= 32768.0) {
122     return 1.8805;
123   }
124
125   /* 64 KiB <= size <= 4 MiB */
126   return 22.7111;
127 }
128
129 static double smpi_bandwidth_factor(double size)
130 {
131   /* 1 B <= size <= 1 KiB */
132   if (size <= 1024.0) {
133     return 0.2758;
134   }
135
136   /* 2 KiB <= size <= 32 KiB */
137   if (size <= 32768.0) {
138     return 0.5477;
139   }
140
141   /* 64 KiB <= size <= 4 MiB */
142   return 0.9359;
143 }
144
145 static double smpi_bandwidth_constraint(double rate, double bound,
146                                         double size)
147 {
148   return rate < 0 ? bound : min(bound, rate * smpi_bandwidth_factor(size));
149 }
150
151 static double (*latency_factor_callback) (double) =
152     &constant_latency_factor;
153 static double (*bandwidth_factor_callback) (double) =
154     &constant_bandwidth_factor;
155 static double (*bandwidth_constraint_callback) (double, double, double) =
156     &constant_bandwidth_constraint;
157
158
159 static void* net_create_resource(const char *name,
160                                 double bw_initial,
161                                 tmgr_trace_t bw_trace,
162                                 double lat_initial,
163                                 tmgr_trace_t lat_trace,
164                                 e_surf_resource_state_t
165                                 state_initial,
166                                 tmgr_trace_t state_trace,
167                                 e_surf_link_sharing_policy_t
168                                 policy, xbt_dict_t properties)
169 {
170   link_CM02_t nw_link = (link_CM02_t)
171       surf_resource_lmm_new(sizeof(s_link_CM02_t),
172                             surf_network_model, name, properties,
173                             network_maxmin_system,
174                             sg_bandwidth_factor * bw_initial,
175                             history,
176                             state_initial, state_trace,
177                             bw_initial, bw_trace);
178
179   xbt_assert(!xbt_lib_get_or_null(link_lib, name, SURF_LINK_LEVEL),
180               "Link '%s' declared several times in the platform file.",
181               name);
182
183   nw_link->lat_current = lat_initial;
184   if (lat_trace)
185     nw_link->lat_event =
186         tmgr_history_add_trace(history, lat_trace, 0.0, 0, nw_link);
187
188   if (policy == SURF_LINK_FATPIPE)
189     lmm_constraint_shared(nw_link->lmm_resource.constraint);
190
191   xbt_lib_set(link_lib, name, SURF_LINK_LEVEL, nw_link);
192
193   return nw_link;
194 }
195
196 static void net_parse_link_init(sg_platf_link_cbarg_t link)
197 {
198   if(link->policy == SURF_LINK_FULLDUPLEX){
199     char *link_id;
200     link_id = bprintf("%s_UP", link->id);
201           net_create_resource(link_id,
202                            link->bandwidth,
203                            link->bandwidth_trace,
204                            link->latency,
205                            link->latency_trace,
206                            link->state,
207                            link->state_trace,
208                            link->policy,
209                            link->properties);
210           xbt_free(link_id);
211     link_id = bprintf("%s_DOWN", link->id);
212     net_create_resource(link_id,
213                         link->bandwidth,
214                         link->bandwidth_trace,
215                         link->latency,
216                         link->latency_trace,
217                         link->state,
218                         link->state_trace,
219                         link->policy,
220                         link->properties);
221     xbt_free(link_id);
222   }
223   else{
224     net_create_resource(link->id,
225                         link->bandwidth,
226                         link->bandwidth_trace,
227                         link->latency,
228                         link->latency_trace,
229                         link->state,
230                         link->state_trace,
231                         link->policy,
232                         link->properties);
233   }
234 }
235
236 static void net_add_traces(void)
237 {
238   xbt_dict_cursor_t cursor = NULL;
239   char *trace_name, *elm;
240
241   static int called = 0;
242   if (called)
243     return;
244   called = 1;
245
246   /* connect all traces relative to network */
247   xbt_dict_foreach(trace_connect_list_link_avail, cursor, trace_name, elm) {
248     tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
249     link_CM02_t link =
250                 xbt_lib_get_or_null(link_lib, elm, SURF_LINK_LEVEL);
251
252     xbt_assert(link, "Cannot connect trace %s to link %s: link undefined",
253                 trace_name, elm);
254     xbt_assert(trace,
255                 "Cannot connect trace %s to link %s: trace undefined",
256                 trace_name, elm);
257
258     link->lmm_resource.state_event =
259         tmgr_history_add_trace(history, trace, 0.0, 0, link);
260   }
261
262   xbt_dict_foreach(trace_connect_list_bandwidth, cursor, trace_name, elm) {
263     tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
264     link_CM02_t link =
265                 xbt_lib_get_or_null(link_lib, elm, SURF_LINK_LEVEL);
266
267     xbt_assert(link, "Cannot connect trace %s to link %s: link undefined",
268                 trace_name, elm);
269     xbt_assert(trace,
270                 "Cannot connect trace %s to link %s: trace undefined",
271                 trace_name, elm);
272
273     link->lmm_resource.power.event =
274         tmgr_history_add_trace(history, trace, 0.0, 0, link);
275   }
276
277   xbt_dict_foreach(trace_connect_list_latency, cursor, trace_name, elm) {
278     tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
279     link_CM02_t link =
280                 xbt_lib_get_or_null(link_lib, elm, SURF_LINK_LEVEL);
281
282     xbt_assert(link, "Cannot connect trace %s to link %s: link undefined",
283                 trace_name, elm);
284     xbt_assert(trace,
285                 "Cannot connect trace %s to link %s: trace undefined",
286                 trace_name, elm);
287
288     link->lat_event = tmgr_history_add_trace(history, trace, 0.0, 0, link);
289   }
290 }
291
292 static void net_define_callbacks(void)
293 {
294   /* Figuring out the network links */
295   sg_platf_link_add_cb(net_parse_link_init);
296   sg_platf_postparse_add_cb(net_add_traces);
297 }
298
299 static int net_resource_used(void *resource_id)
300 {
301   return lmm_constraint_used(network_maxmin_system,
302                              ((surf_resource_lmm_t)
303                               resource_id)->constraint);
304 }
305
306 static int net_action_unref(surf_action_t action)
307 {
308   action->refcount--;
309   if (!action->refcount) {
310     xbt_swag_remove(action, action->state_set);
311     if (((surf_action_network_CM02_t) action)->variable){
312       lmm_variable_free(network_maxmin_system,
313                         ((surf_action_network_CM02_t) action)->variable);
314     }
315     if(network_update_mechanism == UM_LAZY){// remove action from the heap
316       heap_remove((surf_action_network_CM02_t) action);
317       xbt_swag_remove(action, net_modified_set);
318     }
319 #ifdef HAVE_TRACING
320     xbt_free(((surf_action_network_CM02_t) action)->src_name);
321     xbt_free(((surf_action_network_CM02_t) action)->dst_name);
322     xbt_free(action->category);
323 #endif
324     surf_action_free(&action);
325     return 1;
326   }
327   return 0;
328 }
329
330
331
332 static void net_action_cancel(surf_action_t action)
333 {
334   surf_network_model->action_state_set(action, SURF_ACTION_FAILED);
335   if(network_update_mechanism == UM_LAZY){// remove action from the heap
336     xbt_swag_remove(action, net_modified_set);
337     heap_remove((surf_action_network_CM02_t) action);
338   }
339 }
340
341 void net_action_recycle(surf_action_t action)
342 {
343   return;
344 }
345
346 #ifdef HAVE_LATENCY_BOUND_TRACKING
347 static int net_get_link_latency_limited(surf_action_t action)
348 {
349   return action->latency_limited;
350 }
351 #endif
352
353 double net_action_get_remains(surf_action_t action)
354 {
355   if(network_update_mechanism == UM_LAZY)/* update remains before return it */
356     update_action_remaining(surf_get_clock());
357   return action->remains;
358 }
359
360 static void update_action_remaining(double now){
361   surf_action_network_CM02_t action = NULL;
362   double delta = 0.0;
363
364   xbt_swag_foreach(action, net_modified_set) {
365
366     if(action->suspended != 0){
367         continue;
368     }
369
370     delta = now - action->last_update;
371
372     double_update(&(action->generic_action.remains),
373                   lmm_variable_getvalue(action->variable) * delta);
374
375     if (action->generic_action.max_duration != NO_MAX_DURATION)
376       double_update(&(action->generic_action.max_duration), delta);
377
378     if ((action->generic_action.remains <= 0) &&
379         (lmm_get_variable_weight(action->variable) > 0)) {
380       action->generic_action.finish = surf_get_clock();
381       surf_network_model->action_state_set((surf_action_t) action,
382                                            SURF_ACTION_DONE);
383       heap_remove(action);
384     } else if ((action->generic_action.max_duration != NO_MAX_DURATION)
385                && (action->generic_action.max_duration <= 0)) {
386       action->generic_action.finish = surf_get_clock();
387       surf_network_model->action_state_set((surf_action_t) action,
388                                            SURF_ACTION_DONE);
389       heap_remove(action);
390     }
391
392     action->last_update = now;
393   }
394 }
395
396 static double net_share_resources_full(double now)
397 {
398   s_surf_action_network_CM02_t s_action;
399   surf_action_network_CM02_t action = NULL;
400   xbt_swag_t running_actions =
401       surf_network_model->states.running_action_set;
402   double min;
403
404   min = generic_maxmin_share_resources(running_actions,
405                                        xbt_swag_offset(s_action,
406                                                        variable),
407                                        network_maxmin_system,
408                                        network_solve);
409
410 #define VARIABLE(action) (*((lmm_variable_t*)(((char *) (action)) + xbt_swag_offset(s_action, variable)  )))
411
412   xbt_swag_foreach(action, running_actions) {
413 #ifdef HAVE_LATENCY_BOUND_TRACKING
414     if (lmm_is_variable_limited_by_latency(action->variable)) {
415       (action->generic_action).latency_limited = 1;
416     } else {
417       (action->generic_action).latency_limited = 0;
418     }
419 #endif
420     if (action->latency > 0) {
421       if (min < 0)
422         min = action->latency;
423       else if (action->latency < min)
424         min = action->latency;
425     }
426   }
427
428   XBT_DEBUG("Min of share resources %f", min);
429
430   return min;
431 }
432
433 static double net_share_resources_lazy(double now)
434 {
435   surf_action_network_CM02_t action = NULL;
436   double min=-1;
437   double value;
438
439   XBT_DEBUG("Before share resources, the size of modified actions set is %d", xbt_swag_size(net_modified_set));
440   update_action_remaining(now);
441
442   keep_track = net_modified_set;
443   lmm_solve(network_maxmin_system);
444   keep_track = NULL;
445
446   XBT_DEBUG("After share resources, The size of modified actions set is %d", xbt_swag_size(net_modified_set));
447
448    xbt_swag_foreach(action, net_modified_set) {
449      if (GENERIC_ACTION(action).state_set != surf_network_model->states.running_action_set){
450        continue;
451      }
452
453      /* bogus priority, skip it */
454      if (GENERIC_ACTION(action).priority <= 0){
455          continue;
456      }
457
458      min = -1;
459      value = lmm_variable_getvalue(action->variable);
460      if (value > 0) {
461          if (GENERIC_ACTION(action).remains > 0) {
462              value = GENERIC_ACTION(action).remains / value;
463              min = now + value;
464          } else {
465              value = 0.0;
466              min = now;
467          }
468      }
469
470      if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION)
471          && (min == -1
472              || GENERIC_ACTION(action).start +
473              GENERIC_ACTION(action).max_duration < min)){
474        min =   GENERIC_ACTION(action).start +
475                GENERIC_ACTION(action).max_duration;
476      }
477
478      XBT_DEBUG("Action(%p) Start %lf Finish %lf Max_duration %lf", action,
479                 GENERIC_ACTION(action).start, now + value,
480                 GENERIC_ACTION(action).max_duration);
481
482
483
484      if (action->index_heap >= 0) {
485          heap_remove((surf_action_network_CM02_t) action);
486      }
487
488      if (min != -1) {
489          heap_insert((surf_action_network_CM02_t) action, min, NORMAL);
490          XBT_DEBUG("Insert at heap action(%p) min %lf now %lf", action, min, now);
491      }
492    }
493
494    //hereafter must have already the min value for this resource model
495    if(xbt_heap_size(net_action_heap) > 0 ){
496        min = xbt_heap_maxkey(net_action_heap) - now ;
497    }else{
498        min = -1;
499    }
500
501    XBT_DEBUG("The minimum with the HEAP %lf", min);
502
503
504   return min;
505 }
506
507 static void net_update_actions_state_full(double now, double delta)
508 {
509   double deltap = 0.0;
510   surf_action_network_CM02_t action = NULL;
511   surf_action_network_CM02_t next_action = NULL;
512   xbt_swag_t running_actions =
513       surf_network_model->states.running_action_set;
514   /*
515      xbt_swag_t failed_actions =
516      surf_network_model->states.failed_action_set;
517    */
518
519   xbt_swag_foreach_safe(action, next_action, running_actions) {
520     deltap = delta;
521     if (action->latency > 0) {
522       if (action->latency > deltap) {
523         double_update(&(action->latency), deltap);
524         deltap = 0.0;
525       } else {
526         double_update(&(deltap), action->latency);
527         action->latency = 0.0;
528       }
529       if ((action->latency == 0.0) && !(action->suspended))
530         lmm_update_variable_weight(network_maxmin_system, action->variable,
531                                    action->weight);
532     }
533 #ifdef HAVE_TRACING
534     if (TRACE_is_enabled()) {
535       xbt_dynar_t route=NULL;
536       routing_get_route_and_latency(action->src_name, action->dst_name,&route,NULL);
537       link_CM02_t link;
538       unsigned int i;
539       xbt_dynar_foreach(route, i, link) {
540         TRACE_surf_link_set_utilization(link->lmm_resource.generic_resource.name,
541                                         action->generic_action.data,
542                                         (surf_action_t) action,
543                                         lmm_variable_getvalue
544                                         (action->variable), now - delta,
545                                         delta);
546       }
547     }
548 #endif
549     if(!lmm_get_number_of_cnst_from_var(network_maxmin_system, action->variable)) {
550         /* There is actually no link used, hence an infinite bandwidth.
551          * This happens often when using models like vivaldi.
552          * In such case, just make sure that the action completes immediately.
553          */
554       double_update(&(action->generic_action.remains),
555           action->generic_action.remains);
556     }
557     double_update(&(action->generic_action.remains),
558                   lmm_variable_getvalue(action->variable) * deltap);
559     if (action->generic_action.max_duration != NO_MAX_DURATION)
560       double_update(&(action->generic_action.max_duration), delta);
561
562     if ((action->generic_action.remains <= 0) &&
563         (lmm_get_variable_weight(action->variable) > 0)) {
564       action->generic_action.finish = surf_get_clock();
565       surf_network_model->action_state_set((surf_action_t) action,
566                                            SURF_ACTION_DONE);
567 #ifdef HAVE_SMPI
568       gap_remove(action);
569 #endif
570     } else if ((action->generic_action.max_duration != NO_MAX_DURATION)
571                && (action->generic_action.max_duration <= 0)) {
572       action->generic_action.finish = surf_get_clock();
573       surf_network_model->action_state_set((surf_action_t) action,
574                                            SURF_ACTION_DONE);
575 #ifdef HAVE_SMPI
576       gap_remove(action);
577 #endif
578     }
579   }
580
581   return;
582 }
583
584 static void net_update_actions_state_lazy(double now, double delta)
585 {
586   surf_action_network_CM02_t action = NULL;
587
588   while ((xbt_heap_size(net_action_heap) > 0)
589          && (double_equals(xbt_heap_maxkey(net_action_heap), now))) {
590     action = xbt_heap_pop(net_action_heap);
591     XBT_DEBUG("Action %p: finish", action);
592     GENERIC_ACTION(action).finish = surf_get_clock();
593
594     // if I am wearing a latency heat
595     if( action->hat ==  LATENCY){
596         lmm_update_variable_weight(network_maxmin_system, action->variable,
597                                            action->weight);
598         heap_remove(action);
599         action->last_update = surf_get_clock();
600
601         XBT_DEBUG("Action (%p) is not limited by latency anymore", action);
602 #ifdef HAVE_LATENCY_BOUND_TRACKING
603           GENERIC_ACTION(action).latency_limited = 0;
604 #endif
605
606     // if I am wearing a max_duration or normal hat
607     }else if( action->hat == MAX_DURATION || action->hat == NORMAL ){
608         // no need to communicate anymore
609         // assume that flows that reached max_duration have remaining of 0
610         GENERIC_ACTION(action).remains = 0;
611         action->generic_action.finish = surf_get_clock();
612               surf_network_model->action_state_set((surf_action_t) action,
613                                                    SURF_ACTION_DONE);
614         heap_remove(action);
615     }
616   }
617   return;
618 }
619
620 static void net_update_resource_state(void *id,
621                                       tmgr_trace_event_t event_type,
622                                       double value, double date)
623 {
624   link_CM02_t nw_link = id;
625   /*   printf("[" "%lg" "] Asking to update network card \"%s\" with value " */
626   /*     "%lg" " for event %p\n", surf_get_clock(), nw_link->name, */
627   /*     value, event_type); */
628
629   if (event_type == nw_link->lmm_resource.power.event) {
630     double delta =
631         sg_weight_S_parameter / value - sg_weight_S_parameter /
632         (nw_link->lmm_resource.power.peak *
633          nw_link->lmm_resource.power.scale);
634     lmm_variable_t var = NULL;
635     lmm_element_t elem = NULL;
636     surf_action_network_CM02_t action = NULL;
637
638     nw_link->lmm_resource.power.peak = value;
639     lmm_update_constraint_bound(network_maxmin_system,
640                                 nw_link->lmm_resource.constraint,
641                                 sg_bandwidth_factor *
642                                 (nw_link->lmm_resource.power.peak *
643                                  nw_link->lmm_resource.power.scale));
644 #ifdef HAVE_TRACING
645     TRACE_surf_link_set_bandwidth(date, (char *)(((nw_link->lmm_resource).generic_resource).name),
646                                   sg_bandwidth_factor *
647                                   (nw_link->lmm_resource.power.peak *
648                                    nw_link->lmm_resource.power.scale));
649 #endif
650     if (sg_weight_S_parameter > 0) {
651       while ((var = lmm_get_var_from_cnst
652               (network_maxmin_system, nw_link->lmm_resource.constraint,
653                &elem))) {
654         action = lmm_variable_id(var);
655         action->weight += delta;
656         if (!(action->suspended))
657           lmm_update_variable_weight(network_maxmin_system,
658                                      action->variable, action->weight);
659       }
660     }
661     if (tmgr_trace_event_free(event_type))
662       nw_link->lmm_resource.power.event = NULL;
663   } else if (event_type == nw_link->lat_event) {
664     double delta = value - nw_link->lat_current;
665     lmm_variable_t var = NULL;
666     lmm_element_t elem = NULL;
667     surf_action_network_CM02_t action = NULL;
668
669     nw_link->lat_current = value;
670     while ((var = lmm_get_var_from_cnst
671             (network_maxmin_system, nw_link->lmm_resource.constraint,
672              &elem))) {
673       action = lmm_variable_id(var);
674       action->lat_current += delta;
675       action->weight += delta;
676       if (action->rate < 0)
677         lmm_update_variable_bound(network_maxmin_system, action->variable,
678                                   sg_tcp_gamma / (2.0 *
679                                                   action->lat_current));
680       else {
681         lmm_update_variable_bound(network_maxmin_system, action->variable,
682                                   min(action->rate,
683                                       sg_tcp_gamma / (2.0 *
684                                                       action->lat_current)));
685
686         if (action->rate < sg_tcp_gamma / (2.0 * action->lat_current)) {
687           XBT_INFO("Flow is limited BYBANDWIDTH");
688         } else {
689           XBT_INFO("Flow is limited BYLATENCY, latency of flow is %f",
690                 action->lat_current);
691         }
692       }
693       if (!(action->suspended))
694         lmm_update_variable_weight(network_maxmin_system, action->variable,
695                                    action->weight);
696
697     }
698     if (tmgr_trace_event_free(event_type))
699       nw_link->lat_event = NULL;
700   } else if (event_type == nw_link->lmm_resource.state_event) {
701     if (value > 0)
702       nw_link->lmm_resource.state_current = SURF_RESOURCE_ON;
703     else {
704       lmm_constraint_t cnst = nw_link->lmm_resource.constraint;
705       lmm_variable_t var = NULL;
706       lmm_element_t elem = NULL;
707
708       nw_link->lmm_resource.state_current = SURF_RESOURCE_OFF;
709       while ((var = lmm_get_var_from_cnst
710               (network_maxmin_system, cnst, &elem))) {
711         surf_action_t action = lmm_variable_id(var);
712
713         if (surf_action_state_get(action) == SURF_ACTION_RUNNING ||
714             surf_action_state_get(action) == SURF_ACTION_READY) {
715           action->finish = date;
716           surf_network_model->action_state_set(action, SURF_ACTION_FAILED);
717         }
718       }
719     }
720     if (tmgr_trace_event_free(event_type))
721       nw_link->lmm_resource.state_event = NULL;
722   } else {
723     XBT_CRITICAL("Unknown event ! \n");
724     xbt_abort();
725   }
726
727   XBT_DEBUG("There were a resource state event, need to update actions related to the constraint (%p)", nw_link->lmm_resource.constraint);
728   return;
729 }
730
731
732 static surf_action_t net_communicate(const char *src_name,
733                                      const char *dst_name, double size,
734                                      double rate)
735 {
736   unsigned int i;
737   link_CM02_t link;
738   int failed = 0;
739   surf_action_network_CM02_t action = NULL;
740   double bandwidth_bound;
741   double latency=0.0;
742   /* LARGE PLATFORMS HACK:
743      Add a link_CM02_t *link and a int link_nb to network_card_CM02_t. It will represent local links for this node
744      Use the cluster_id for ->id */
745
746   xbt_dynar_t back_route = NULL;
747   int constraints_per_variable = 0;
748   // I need to have the forward and backward routes at the same time, so allocate "route". That way, the routing wont clean it up
749   xbt_dynar_t route=xbt_dynar_new(global_routing->size_of_link,NULL);
750   routing_get_route_and_latency(src_name, dst_name, &route, &latency);
751
752   if (sg_network_crosstraffic == 1) {
753     // FIXME: fill route directly (unclear: check with blame who put the FIXME)
754     routing_get_route_and_latency(dst_name, src_name, &back_route,NULL);
755   }
756
757   /* LARGE PLATFORMS HACK:
758      total_route_size = route_size + src->link_nb + dst->nb */
759
760   XBT_IN("(%s,%s,%g,%g)", src_name, dst_name, size, rate);
761   /* LARGE PLATFORMS HACK:
762      assert on total_route_size */
763   xbt_assert(!xbt_dynar_is_empty(route) || latency,
764               "You're trying to send data from %s to %s but there is no connection at all between these two hosts.",
765               src_name, dst_name);
766
767   xbt_dynar_foreach(route, i, link) {
768     if (link->lmm_resource.state_current == SURF_RESOURCE_OFF) {
769       failed = 1;
770       break;
771     }
772   }
773   if (sg_network_crosstraffic == 1) {
774     xbt_dynar_foreach(back_route, i, link) {
775       if (link->lmm_resource.state_current == SURF_RESOURCE_OFF) {
776         failed = 1;
777         break;
778       }
779     }
780   }
781
782   action =
783       surf_action_new(sizeof(s_surf_action_network_CM02_t), size,
784                       surf_network_model, failed);
785 #ifdef HAVE_LATENCY_BOUND_TRACKING
786   (action->generic_action).latency_limited = 0;
787 #endif
788   action->weight = action->latency = latency;
789
790   xbt_swag_insert(action, action->generic_action.state_set);
791   action->rate = rate;
792   if(network_update_mechanism == UM_LAZY){
793     action->index_heap = -1;
794     action->latency = 0.0;
795     action->weight = 0.0;
796     action->last_update = surf_get_clock();
797   }
798
799   bandwidth_bound = -1.0;
800   xbt_dynar_foreach(route, i, link) {
801     action->weight +=
802         sg_weight_S_parameter /
803         (link->lmm_resource.power.peak * link->lmm_resource.power.scale);
804     if (bandwidth_bound < 0.0)
805       bandwidth_bound =
806           bandwidth_factor_callback(size) *
807           (link->lmm_resource.power.peak * link->lmm_resource.power.scale);
808     else
809       bandwidth_bound =
810           min(bandwidth_bound,
811               bandwidth_factor_callback(size) *
812               (link->lmm_resource.power.peak *
813                link->lmm_resource.power.scale));
814   }
815   /* LARGE PLATFORMS HACK:
816      Add src->link and dst->link latencies */
817   action->lat_current = action->latency;
818   action->latency *= latency_factor_callback(size);
819   action->rate =
820       bandwidth_constraint_callback(action->rate, bandwidth_bound,
821                                         size);
822 #ifdef HAVE_SMPI
823   if(!xbt_dynar_is_empty(route)) {
824     link = *(link_CM02_t*)xbt_dynar_get_ptr(route, 0);
825     gap_append(size, link, action);
826     XBT_DEBUG("Comm %p: %s -> %s gap=%f (lat=%f)",
827            action, src_name, dst_name, action->sender.gap, action->latency);
828   } else {
829     gap_unknown(action);
830   }
831 #endif
832
833   /* LARGE PLATFORMS HACK:
834      lmm_variable_new(..., total_route_size) */
835   if (back_route != NULL) {
836     constraints_per_variable =
837         xbt_dynar_length(route) + xbt_dynar_length(back_route);
838   } else {
839     constraints_per_variable = xbt_dynar_length(route);
840   }
841
842   if (action->latency > 0){
843       action->variable =
844         lmm_variable_new(network_maxmin_system, action, 0.0, -1.0,
845                          constraints_per_variable);
846     if(network_update_mechanism == UM_LAZY){
847       // add to the heap the event when the latency is payed
848       XBT_DEBUG("Added action (%p) one latency event at date %f", action, action->latency + action->last_update);
849       heap_insert(action, action->latency + action->last_update, LATENCY);
850     }
851 #ifdef HAVE_LATENCY_BOUND_TRACKING
852         (action->generic_action).latency_limited = 1;
853 #endif
854   }
855   else
856     action->variable =
857         lmm_variable_new(network_maxmin_system, action, 1.0, -1.0,
858                          constraints_per_variable);
859
860   if (action->rate < 0) {
861     if (action->lat_current > 0)
862       lmm_update_variable_bound(network_maxmin_system, action->variable,
863                                 sg_tcp_gamma / (2.0 *
864                                                 action->lat_current));
865     else
866       lmm_update_variable_bound(network_maxmin_system, action->variable,
867                                 -1.0);
868   } else {
869     if (action->lat_current > 0)
870       lmm_update_variable_bound(network_maxmin_system, action->variable,
871                                 min(action->rate,
872                                     sg_tcp_gamma / (2.0 *
873                                                     action->lat_current)));
874     else
875       lmm_update_variable_bound(network_maxmin_system, action->variable,
876                                 action->rate);
877   }
878
879   xbt_dynar_foreach(route, i, link) {
880     lmm_expand(network_maxmin_system, link->lmm_resource.constraint,
881                action->variable, 1.0);
882   }
883
884   if (sg_network_crosstraffic == 1) {
885     XBT_DEBUG("Fullduplex active adding backward flow using 5%c", '%');
886     xbt_dynar_foreach(back_route, i, link) {
887       lmm_expand(network_maxmin_system, link->lmm_resource.constraint,
888                  action->variable, .05);
889     }
890   }
891
892   /* LARGE PLATFORMS HACK:
893      expand also with src->link and dst->link */
894 #ifdef HAVE_TRACING
895   if (TRACE_is_enabled()) {
896     action->src_name = xbt_strdup(src_name);
897     action->dst_name = xbt_strdup(dst_name);
898   } else {
899     action->src_name = action->dst_name = NULL;
900   }
901 #endif
902
903   xbt_dynar_free(&route);
904   XBT_OUT();
905
906   return (surf_action_t) action;
907 }
908
909 static xbt_dynar_t net_get_route(const char *src, const char *dst)
910 {
911   xbt_dynar_t route=NULL;
912   routing_get_route_and_latency(src, dst,&route,NULL);
913   return route;
914 }
915
916 static double net_get_link_bandwidth(const void *link)
917 {
918   surf_resource_lmm_t lmm = (surf_resource_lmm_t) link;
919   return lmm->power.peak * lmm->power.scale;
920 }
921
922 static double net_get_link_latency(const void *link)
923 {
924   return ((link_CM02_t) link)->lat_current;
925 }
926
927 static int net_link_shared(const void *link)
928 {
929   return
930       lmm_constraint_is_shared(((surf_resource_lmm_t) link)->constraint);
931 }
932
933 static void net_action_suspend(surf_action_t action)
934 {
935   ((surf_action_network_CM02_t) action)->suspended = 1;
936   lmm_update_variable_weight(network_maxmin_system,
937                              ((surf_action_network_CM02_t)
938                               action)->variable, 0.0);
939
940   if(network_update_mechanism == UM_LAZY)// remove action from the heap
941     heap_remove((surf_action_network_CM02_t) action);
942 }
943
944 static void net_action_resume(surf_action_t action)
945 {
946   if (((surf_action_network_CM02_t) action)->suspended) {
947     lmm_update_variable_weight(network_maxmin_system,
948                                ((surf_action_network_CM02_t)
949                                 action)->variable,
950                                ((surf_action_network_CM02_t)
951                                 action)->weight);
952     ((surf_action_network_CM02_t) action)->suspended = 0;
953     if(network_update_mechanism == UM_LAZY)// remove action from the heap
954       heap_remove((surf_action_network_CM02_t) action);
955   }
956 }
957
958 static int net_action_is_suspended(surf_action_t action)
959 {
960   return ((surf_action_network_CM02_t) action)->suspended;
961 }
962
963 void net_action_set_max_duration(surf_action_t action, double duration)
964 {
965   action->max_duration = duration;
966   if(network_update_mechanism == UM_LAZY)// remove action from the heap
967     heap_remove((surf_action_network_CM02_t) action);
968 }
969
970 #ifdef HAVE_TRACING
971 static void net_action_set_category(surf_action_t action, const char *category)
972 {
973   action->category = xbt_strdup (category);
974 }
975 #endif
976
977 static void net_finalize(void)
978 {
979   surf_model_exit(surf_network_model);
980   surf_network_model = NULL;
981
982   lmm_system_free(network_maxmin_system);
983   network_maxmin_system = NULL;
984
985   if(network_update_mechanism == UM_LAZY){
986     xbt_heap_free(net_action_heap);
987     xbt_swag_free(net_modified_set);
988   }
989 }
990
991 #ifdef HAVE_SMPI
992 static void gap_append(double size, const link_CM02_t link, surf_action_network_CM02_t action) {
993    const char* src = link->lmm_resource.generic_resource.name;
994    xbt_fifo_t fifo;
995    surf_action_network_CM02_t last_action;
996    double bw;
997
998    if(sg_sender_gap > 0.0) {
999       if(!gap_lookup) {
1000          gap_lookup = xbt_dict_new();
1001       }
1002       fifo = (xbt_fifo_t)xbt_dict_get_or_null(gap_lookup, src);
1003       action->sender.gap = 0.0;
1004       if(fifo && xbt_fifo_size(fifo) > 0) {
1005          /* Compute gap from last send */
1006          last_action = (surf_action_network_CM02_t)xbt_fifo_get_item_content(xbt_fifo_get_last_item(fifo));
1007          bw = net_get_link_bandwidth(link);
1008          action->sender.gap = last_action->sender.gap + max(sg_sender_gap, last_action->sender.size / bw);
1009          action->latency += action->sender.gap;
1010       }
1011       /* Append action as last send */
1012       action->sender.link_name = link->lmm_resource.generic_resource.name;
1013       fifo = (xbt_fifo_t)xbt_dict_get_or_null(gap_lookup, action->sender.link_name);
1014       if(!fifo) {
1015          fifo = xbt_fifo_new();
1016          xbt_dict_set(gap_lookup, action->sender.link_name, fifo, NULL);
1017       }
1018       action->sender.fifo_item = xbt_fifo_push(fifo, action);
1019       action->sender.size = size;
1020    }
1021 }
1022
1023 static void gap_unknown(surf_action_network_CM02_t action) {
1024    action->sender.gap = 0.0;
1025    action->sender.link_name = NULL;
1026    action->sender.fifo_item = NULL;
1027    action->sender.size = 0.0;
1028 }
1029
1030 static void gap_remove(surf_action_network_CM02_t action) {
1031    xbt_fifo_t fifo;
1032    size_t size;
1033
1034    if(sg_sender_gap > 0.0 && action->sender.link_name && action->sender.fifo_item) {
1035       fifo = (xbt_fifo_t)xbt_dict_get_or_null(gap_lookup, action->sender.link_name);
1036       xbt_fifo_remove_item(fifo, action->sender.fifo_item);
1037       size = xbt_fifo_size(fifo);
1038       if(size == 0) {
1039          xbt_fifo_free(fifo);
1040          xbt_dict_remove(gap_lookup, action->sender.link_name);
1041          size = xbt_dict_length(gap_lookup);
1042          if(size == 0) {
1043             xbt_dict_free(&gap_lookup);
1044          }
1045       }
1046    }
1047 }
1048 #endif
1049
1050 static void surf_network_model_init_internal(void)
1051 {
1052   s_surf_action_network_CM02_t comm;
1053   surf_network_model = surf_model_init();
1054
1055   surf_network_model->name = "network";
1056   surf_network_model->action_unref = net_action_unref;
1057   surf_network_model->action_cancel = net_action_cancel;
1058   surf_network_model->action_recycle = net_action_recycle;
1059   surf_network_model->get_remains = net_action_get_remains;
1060 #ifdef HAVE_LATENCY_BOUND_TRACKING
1061   surf_network_model->get_latency_limited = net_get_link_latency_limited;
1062 #endif
1063
1064   surf_network_model->model_private->resource_used = net_resource_used;
1065   if(network_update_mechanism == UM_LAZY) {
1066     surf_network_model->model_private->share_resources = net_share_resources_lazy;
1067     surf_network_model->model_private->update_actions_state = net_update_actions_state_lazy;
1068   } else if(network_update_mechanism == UM_FULL) {
1069     surf_network_model->model_private->share_resources = net_share_resources_full;
1070     surf_network_model->model_private->update_actions_state = net_update_actions_state_full;
1071   }
1072
1073   surf_network_model->model_private->update_resource_state =
1074                   net_update_resource_state;
1075   surf_network_model->model_private->finalize = net_finalize;
1076
1077   surf_network_model->suspend = net_action_suspend;
1078   surf_network_model->resume = net_action_resume;
1079   surf_network_model->is_suspended = net_action_is_suspended;
1080   surf_cpu_model->set_max_duration = net_action_set_max_duration;
1081
1082   surf_network_model->extension.network.communicate = net_communicate;
1083   surf_network_model->extension.network.get_route = net_get_route;
1084   surf_network_model->extension.network.get_link_bandwidth =
1085                   net_get_link_bandwidth;
1086   surf_network_model->extension.network.get_link_latency =
1087                   net_get_link_latency;
1088   surf_network_model->extension.network.link_shared = net_link_shared;
1089   surf_network_model->extension.network.add_traces = net_add_traces;
1090   surf_network_model->extension.network.create_resource =
1091                   net_create_resource;
1092
1093  if (!network_maxmin_system)
1094     network_maxmin_system = lmm_system_new(selective_update);
1095
1096  routing_model_create(sizeof(link_CM02_t),
1097       net_create_resource("__loopback__",
1098           498000000, NULL, 0.000015, NULL,
1099           SURF_RESOURCE_ON, NULL,
1100           SURF_LINK_FATPIPE, NULL));
1101
1102   if(network_update_mechanism == UM_LAZY){
1103     net_action_heap = xbt_heap_new(8,NULL);
1104     xbt_heap_set_update_callback(net_action_heap, net_action_update_index_heap);
1105     net_modified_set =
1106         xbt_swag_new(xbt_swag_offset(comm, action_list_hookup));
1107   }
1108 }
1109
1110 static void set_update_mechanism(void) {
1111   char *optim = xbt_cfg_get_string(_surf_cfg_set, "network/optim");
1112   int select = xbt_cfg_get_int(_surf_cfg_set, "network/maxmin_selective_update");
1113
1114   if(!strcmp(optim,"Full")) {
1115     network_update_mechanism = UM_FULL;
1116     selective_update = select;
1117   } else if (!strcmp(optim,"Lazy")) {
1118     network_update_mechanism = UM_LAZY;
1119     selective_update = 1;
1120     xbt_assert((select==1) || (xbt_cfg_is_default_value(_surf_cfg_set,"network/maxmin_selective_update")),
1121         "Disabling selective update while using the lazy update mechanism is dumb!");
1122   } else {
1123     xbt_die("Unsupported optimization (%s) for this model",optim);
1124   }
1125 }
1126
1127 /************************************************************************/
1128 /* New model based on LV08 and experimental results of MPI ping-pongs   */
1129 /************************************************************************/
1130 /* @Inproceedings{smpi_ipdps, */
1131 /*  author={Pierre-Nicolas Clauss and Mark Stillwell and Stéphane Genaud and Frédéric Suter and Henri Casanova and Martin Quinson}, */
1132 /*  title={Single Node On-Line Simulation of {MPI} Applications with SMPI}, */
1133 /*  booktitle={25th IEEE International Parallel and Distributed Processing Symposium (IPDPS'11)}, */
1134 /*  address={Anchorage (Alaska) USA}, */
1135 /*  month=may, */
1136 /*  year={2011} */
1137 /*  } */
1138 void surf_network_model_init_SMPI(void)
1139 {
1140
1141   if (surf_network_model)
1142     return;
1143   set_update_mechanism();
1144
1145   surf_network_model_init_internal();
1146   latency_factor_callback = &smpi_latency_factor;
1147   bandwidth_factor_callback = &smpi_bandwidth_factor;
1148   bandwidth_constraint_callback = &smpi_bandwidth_constraint;
1149   net_define_callbacks();
1150   xbt_dynar_push(model_list, &surf_network_model);
1151   network_solve = lmm_solve;
1152
1153   xbt_cfg_setdefault_double(_surf_cfg_set, "network/sender_gap", 10e-6);
1154   xbt_cfg_setdefault_double(_surf_cfg_set, "network/weight_S", 8775);
1155 }
1156
1157 /************************************************************************/
1158 /* New model based on optimizations discussed during Pedro Velho's thesis*/
1159 /************************************************************************/
1160 /* @techreport{VELHO:2011:HAL-00646896:1, */
1161 /*      url = {http://hal.inria.fr/hal-00646896/en/}, */
1162 /*      title = {{Flow-level network models: have we reached the limits?}}, */
1163 /*      author = {Velho, Pedro and Schnorr, Lucas and Casanova, Henri and Legrand, Arnaud}, */
1164 /*      type = {Rapport de recherche}, */
1165 /*      institution = {INRIA}, */
1166 /*      number = {RR-7821}, */
1167 /*      year = {2011}, */
1168 /*      month = Nov, */
1169 /*      pdf = {http://hal.inria.fr/hal-00646896/PDF/rr-validity.pdf}, */
1170 /*  } */
1171 void surf_network_model_init_LegrandVelho(void)
1172 {
1173   char *model = xbt_cfg_get_string(_surf_cfg_set, "network/model");
1174
1175   if (surf_network_model)
1176     return;
1177
1178   if(!strcmp(model,"LV08_fullupdate")) {
1179     XBT_WARN("[*Deprecated*. Use --cfg=network/model:LV08 with option --cfg=network/optim:Full instead.]");
1180   }
1181   set_update_mechanism();
1182
1183   surf_network_model_init_internal();
1184   net_define_callbacks();
1185   xbt_dynar_push(model_list, &surf_network_model);
1186   network_solve = lmm_solve;
1187
1188   xbt_cfg_setdefault_double(_surf_cfg_set, "network/latency_factor", 10.4); // 13.01 when callibration is done without phase effects
1189   xbt_cfg_setdefault_double(_surf_cfg_set, "network/bandwidth_factor",0.92);// 0.97 when callibration is done without phase effects
1190   xbt_cfg_setdefault_double(_surf_cfg_set, "network/weight_S", 8775);       // 20537 when callibration is done without phase effects
1191 }
1192
1193 /***************************************************************************/
1194 /* The nice TCP sharing model designed by Loris Marchal and Henri Casanova */
1195 /***************************************************************************/
1196 /* @TechReport{      rr-lip2002-40, */
1197 /*   author        = {Henri Casanova and Loris Marchal}, */
1198 /*   institution   = {LIP}, */
1199 /*   title         = {A Network Model for Simulation of Grid Application}, */
1200 /*   number        = {2002-40}, */
1201 /*   month         = {oct}, */
1202 /*   year          = {2002} */
1203 /* } */
1204 void surf_network_model_init_CM02(void)
1205 {
1206
1207   if (surf_network_model)
1208     return;
1209
1210   set_update_mechanism();
1211   surf_network_model_init_internal();
1212   net_define_callbacks();
1213   xbt_dynar_push(model_list, &surf_network_model);
1214   network_solve = lmm_solve;
1215
1216   xbt_cfg_setdefault_double(_surf_cfg_set, "network/latency_factor", 1.0);
1217   xbt_cfg_setdefault_double(_surf_cfg_set, "network/bandwidth_factor", 1.0);
1218   xbt_cfg_setdefault_double(_surf_cfg_set, "network/weight_S", 0.0);
1219 }
1220
1221 /***************************************************************************/
1222 /* The models from Steven H. Low                                           */
1223 /***************************************************************************/
1224 /* @article{Low03,                                                         */
1225 /*   author={Steven H. Low},                                               */
1226 /*   title={A Duality Model of {TCP} and Queue Management Algorithms},     */
1227 /*   year={2003},                                                          */
1228 /*   journal={{IEEE/ACM} Transactions on Networking},                      */
1229 /*    volume={11}, number={4},                                             */
1230 /*  }                                                                      */
1231 void surf_network_model_init_Reno(void)
1232 {
1233   if (surf_network_model)
1234     return;
1235
1236   set_update_mechanism();
1237   surf_network_model_init_internal();
1238   net_define_callbacks();
1239
1240   xbt_dynar_push(model_list, &surf_network_model);
1241   lmm_set_default_protocol_function(func_reno_f, func_reno_fp,
1242                                     func_reno_fpi);
1243   network_solve = lagrange_solve;
1244
1245   xbt_cfg_setdefault_double(_surf_cfg_set, "network/latency_factor", 10.4);
1246   xbt_cfg_setdefault_double(_surf_cfg_set, "network/bandwidth_factor",
1247                             0.92);
1248   xbt_cfg_setdefault_double(_surf_cfg_set, "network/weight_S", 8775);
1249 }
1250
1251
1252 void surf_network_model_init_Reno2(void)
1253 {
1254   if (surf_network_model)
1255     return;
1256
1257   set_update_mechanism();
1258   surf_network_model_init_internal();
1259   net_define_callbacks();
1260
1261   xbt_dynar_push(model_list, &surf_network_model);
1262   lmm_set_default_protocol_function(func_reno2_f, func_reno2_fp,
1263                                     func_reno2_fpi);
1264   network_solve = lagrange_solve;
1265
1266   xbt_cfg_setdefault_double(_surf_cfg_set, "network/latency_factor", 10.4);
1267   xbt_cfg_setdefault_double(_surf_cfg_set, "network/bandwidth_factor",
1268                             0.92);
1269   xbt_cfg_setdefault_double(_surf_cfg_set, "network/weight_S_parameter",
1270                             8775);
1271 }
1272
1273 void surf_network_model_init_Vegas(void)
1274 {
1275   if (surf_network_model)
1276     return;
1277
1278   set_update_mechanism();
1279   surf_network_model_init_internal();
1280   net_define_callbacks();
1281
1282   xbt_dynar_push(model_list, &surf_network_model);
1283   lmm_set_default_protocol_function(func_vegas_f, func_vegas_fp,
1284                                     func_vegas_fpi);
1285   network_solve = lagrange_solve;
1286
1287   xbt_cfg_setdefault_double(_surf_cfg_set, "network/latency_factor", 10.4);
1288   xbt_cfg_setdefault_double(_surf_cfg_set, "network/bandwidth_factor",
1289                             0.92);
1290   xbt_cfg_setdefault_double(_surf_cfg_set, "network/weight_S", 8775);
1291 }