Logo AND Algorithmique Numérique Distribuée

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