Logo AND Algorithmique Numérique Distribuée

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