Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' into mc-process
[simgrid.git] / src / surf / surf_interface.cpp
1 /* Copyright (c) 2004-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "surf_private.h"
8 #include "surf_interface.hpp"
9 #include "network_interface.hpp"
10 #include "cpu_interface.hpp"
11 #include "workstation_interface.hpp"
12 #include "vm_workstation_interface.hpp"
13 #include "simix/smx_host_private.h"
14 #include "surf_routing.hpp"
15 #include "simgrid/sg_config.h"
16 #include "mc/mc.h"
17
18 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf,
20                                 "Logging specific to SURF (kernel)");
21
22 /*********
23  * Utils *
24  *********/
25
26 /* This function is a pimple that we ought to fix. But it won't be easy.
27  *
28  * The surf_solve() function does properly return the set of actions that
29  * changed. Instead, each model change a global data, and then the caller of
30  * surf_solve must pick into these sets of action_failed and action_done.
31  *
32  * This was not clean but ok as long as we didn't had to restart the processes
33  * when the resource comes back up.
34  * We worked by putting sentinel actions on every resources we are interested
35  * in, so that surf informs us if/when the corresponding resource fails.
36  *
37  * But this does not work to get Simix informed of when a resource comes back
38  * up, and this is where this pimple comes. We have a set of resources that are
39  * currently down and for which simix needs to know when it comes back up.
40  * And the current function is called *at every simulation step* to sweep over
41  * that set, searching for a resource that was turned back up in the meanwhile.
42  * This is UGLY and slow.
43  *
44  * The proper solution would be to not rely on globals for the action_failed and
45  * action_done swags. They must be passed as parameter by the caller (the
46  * handling of these actions in simix may let you think that these two sets can
47  * be merged, but their handling in SimDag induce the contrary unless this
48  * simdag code can check by itself whether the action is done of failed -- seems
49  * very doable, but yet more cleanup to do).
50  *
51  * Once surf_solve() is passed the set of actions that changed, you want to add
52  * a new set of resources back up as parameter to this function. You also want
53  * to add a boolean field "restart_watched" to each resource, and make sure that
54  * whenever a resource with this field enabled comes back up, it's added to that
55  * set so that Simix sees it and react accordingly. This would kill that need
56  * for surf to call simix.
57  *
58  */
59
60 /*static void remove_watched_host(void *key)
61 {
62   xbt_dict_remove(watched_hosts_lib, *(char**)key);
63 }*/
64
65 /*void surf_watched_hosts(void)
66 {
67   char *key;
68   void *host;
69   xbt_dict_cursor_t cursor;
70   xbt_dynar_t hosts = xbt_dynar_new(sizeof(char*), NULL);
71
72   XBT_DEBUG("Check for host SURF_RESOURCE_ON on watched_hosts_lib");
73   xbt_dict_foreach(watched_hosts_lib, cursor, key, host)
74   {
75     if(SIMIX_host_get_state((smx_host_t)host) == SURF_RESOURCE_ON){
76       XBT_INFO("Restart processes on host: %s", SIMIX_host_get_name((smx_host_t)host));
77       SIMIX_host_autorestart((smx_host_t)host);
78       xbt_dynar_push_as(hosts, char*, key);
79     }
80     else
81       XBT_DEBUG("See SURF_RESOURCE_OFF on host: %s",key);
82   }
83   xbt_dynar_map(hosts, remove_watched_host);
84   xbt_dynar_free(&hosts);
85 }*/
86
87 /* model_list_invoke contains only surf_workstation and surf_vm_workstation.
88  * The callback functions of cpu_model and network_model will be called from
89  * those of these workstation models. */
90 xbt_dynar_t model_list = NULL; /* for destroying all models correctly */
91 xbt_dynar_t model_list_invoke = NULL;  /* for invoking callbacks */
92
93 tmgr_history_t history = NULL;
94 lmm_system_t maxmin_system = NULL;
95 xbt_dynar_t surf_path = NULL;
96 xbt_dynar_t host_that_restart = NULL;
97 xbt_dict_t watched_hosts_lib;
98
99 surf_callback(void, void) surfExitCallbacks;
100
101 s_surf_model_description_t surf_plugin_description[] = {
102     {"Energy", "Cpu energy consumption.", sg_energy_plugin_init},
103      {NULL, NULL,  NULL}      /* this array must be NULL terminated */
104 };
105
106 /* Don't forget to update the option description in smx_config when you change
107    this */
108 s_surf_model_description_t surf_network_model_description[] = {
109   {"LV08",
110    "Realistic network analytic model (slow-start modeled by multiplying latency by 10.4, bandwidth by .92; bottleneck sharing uses a payload of S=8775 for evaluating RTT). ",
111    surf_network_model_init_LegrandVelho},
112   {"Constant",
113    "Simplistic network model where all communication take a constant time (one second). This model provides the lowest realism, but is (marginally) faster.",
114    surf_network_model_init_Constant},
115   {"SMPI",
116    "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
117    surf_network_model_init_SMPI},
118   {"IB",
119    "Realistic network model specifically tailored for HPC settings, with Infiniband contention model",
120    surf_network_model_init_IB},
121   {"CM02",
122    "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of small messages are thus poorly modeled).",
123    surf_network_model_init_CM02},
124 #ifdef HAVE_GTNETS
125   {"GTNets",
126    "Network pseudo-model using the GTNets simulator instead of an analytic model",
127    surf_network_model_init_GTNETS},
128 #endif
129 #ifdef HAVE_NS3
130   {"NS3",
131    "Network pseudo-model using the NS3 tcp model instead of an analytic model",
132   surf_network_model_init_NS3},
133 #endif
134   {"Reno",
135    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
136    surf_network_model_init_Reno},
137   {"Reno2",
138    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
139    surf_network_model_init_Reno2},
140   {"Vegas",
141    "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
142    surf_network_model_init_Vegas},
143   {NULL, NULL, NULL}      /* this array must be NULL terminated */
144 };
145
146 s_surf_model_description_t surf_cpu_model_description[] = {
147   {"Cas01",
148    "Simplistic CPU model (time=size/power).",
149    surf_cpu_model_init_Cas01},
150   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
151 };
152
153 s_surf_model_description_t surf_workstation_model_description[] = {
154   {"default",
155    "Default workstation model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
156    surf_workstation_model_init_current_default},
157   {"compound",
158    "Workstation model that is automatically chosen if you change the network and CPU models",
159    surf_workstation_model_init_compound},
160   {"ptask_L07", "Workstation model somehow similar to Cas01+CM02 but allowing parallel tasks",
161    surf_workstation_model_init_ptask_L07},
162   {NULL, NULL, NULL}      /* this array must be NULL terminated */
163 };
164
165 s_surf_model_description_t surf_vm_workstation_model_description[] = {
166   {"default",
167    "Default vm workstation model.",
168    surf_vm_workstation_model_init_HL13},
169   {NULL, NULL, NULL}      /* this array must be NULL terminated */
170 };
171
172 s_surf_model_description_t surf_optimization_mode_description[] = {
173   {"Lazy",
174    "Lazy action management (partial invalidation in lmm + heap in action remaining).",
175    NULL},
176   {"TI",
177    "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU model for now).",
178     NULL},
179   {"Full",
180    "Full update of remaining and variables. Slow but may be useful when debugging.",
181    NULL},
182   {NULL, NULL, NULL}      /* this array must be NULL terminated */
183 };
184
185 s_surf_model_description_t surf_storage_model_description[] = {
186   {"default",
187    "Simplistic storage model.",
188    surf_storage_model_init_default},
189   {NULL, NULL,  NULL}      /* this array must be NULL terminated */
190 };
191
192 #ifdef CONTEXT_THREADS
193 static xbt_parmap_t surf_parmap = NULL; /* parallel map on models */
194 #endif
195
196 double NOW = 0;
197 double *surf_mins = NULL; /* return value of share_resources for each model */
198 int surf_min_index;       /* current index in surf_mins */
199 double surf_min;               /* duration determined by surf_solve */
200
201 double surf_get_clock(void)
202 {
203   return NOW;
204 }
205
206 #ifdef _XBT_WIN32
207 # define FILE_DELIM "\\"
208 #else
209 # define FILE_DELIM "/"         /* FIXME: move to better location */
210 #endif
211
212 FILE *surf_fopen(const char *name, const char *mode)
213 {
214   unsigned int cpt;
215   char *path_elm = NULL;
216   char *buff;
217   FILE *file = NULL;
218
219   xbt_assert(name);
220
221   if (__surf_is_absolute_file_path(name))       /* don't mess with absolute file names */
222     return fopen(name, mode);
223
224   /* search relative files in the path */
225   xbt_dynar_foreach(surf_path, cpt, path_elm) {
226     buff = bprintf("%s" FILE_DELIM "%s", path_elm, name);
227     file = fopen(buff, mode);
228     free(buff);
229
230     if (file)
231       return file;
232   }
233   return NULL;
234 }
235
236
237 #ifndef MAX_DRIVE
238 #define MAX_DRIVE 26
239 #endif
240
241 #ifdef _XBT_WIN32
242 #include <windows.h>
243 static const char *disk_drives_letter_table[MAX_DRIVE] = {
244   "A:\\",
245   "B:\\",
246   "C:\\",
247   "D:\\",
248   "E:\\",
249   "F:\\",
250   "G:\\",
251   "H:\\",
252   "I:\\",
253   "J:\\",
254   "K:\\",
255   "L:\\",
256   "M:\\",
257   "N:\\",
258   "O:\\",
259   "P:\\",
260   "Q:\\",
261   "R:\\",
262   "S:\\",
263   "T:\\",
264   "U:\\",
265   "V:\\",
266   "W:\\",
267   "X:\\",
268   "Y:\\",
269   "Z:\\"
270 };
271 #endif
272
273 /*
274  * Returns the initial path. On Windows the initial path is
275  * the current directory for the current process in the other
276  * case the function returns "./" that represents the current
277  * directory on Unix/Linux platforms.
278  */
279
280 const char *__surf_get_initial_path(void)
281 {
282
283 #ifdef _XBT_WIN32
284   unsigned i;
285   char current_directory[MAX_PATH + 1] = { 0 };
286   unsigned int len = GetCurrentDirectory(MAX_PATH + 1, current_directory);
287   char root[4] = { 0 };
288
289   if (!len)
290     return NULL;
291
292   strncpy(root, current_directory, 3);
293
294   for (i = 0; i < MAX_DRIVE; i++) {
295     if (toupper(root[0]) == disk_drives_letter_table[i][0])
296       return disk_drives_letter_table[i];
297   }
298
299   return NULL;
300 #else
301   return "./";
302 #endif
303 }
304
305 /* The __surf_is_absolute_file_path() returns 1 if
306  * file_path is a absolute file path, in the other
307  * case the function returns 0.
308  */
309 int __surf_is_absolute_file_path(const char *file_path)
310 {
311 #ifdef _XBT_WIN32
312   WIN32_FIND_DATA wfd = { 0 };
313   HANDLE hFile = FindFirstFile(file_path, &wfd);
314
315   if (INVALID_HANDLE_VALUE == hFile)
316     return 0;
317
318   FindClose(hFile);
319   return 1;
320 #else
321   return (file_path[0] == '/');
322 #endif
323 }
324
325 /** Displays the long description of all registered models, and quit */
326 void model_help(const char *category, s_surf_model_description_t * table)
327 {
328   int i;
329   printf("Long description of the %s models accepted by this simulator:\n",
330          category);
331   for (i = 0; table[i].name; i++)
332     printf("  %s: %s\n", table[i].name, table[i].description);
333 }
334
335 int find_model_description(s_surf_model_description_t * table,
336                            const char *name)
337 {
338   int i;
339   char *name_list = NULL;
340
341   for (i = 0; table[i].name; i++)
342     if (!strcmp(name, table[i].name)) {
343       return i;
344     }
345   if (!table[0].name)
346     xbt_die("No model is valid! This is a bug.");
347   name_list = xbt_strdup(table[0].name);
348   for (i = 1; table[i].name; i++) {
349     name_list = (char *) xbt_realloc(name_list, strlen(name_list) + strlen(table[i].name) + 3);
350     strcat(name_list, ", ");
351     strcat(name_list, table[i].name);
352   }
353   xbt_die("Model '%s' is invalid! Valid models are: %s.", name, name_list);
354   return -1;
355 }
356
357 static XBT_INLINE void routing_asr_host_free(void *p)
358 {
359   delete ((RoutingEdgePtr) p);
360 }
361
362 static XBT_INLINE void routing_asr_prop_free(void *p)
363 {
364   xbt_dict_t elm = (xbt_dict_t) p;
365   xbt_dict_free(&elm);
366 }
367
368 static XBT_INLINE void surf_cpu_free(void *r)
369 {
370   delete static_cast<CpuPtr>(r);
371 }
372
373 static XBT_INLINE void surf_link_free(void *r)
374 {
375   delete static_cast<NetworkLinkPtr>(r);
376 }
377
378 static XBT_INLINE void surf_workstation_free(void *r)
379 {
380   delete static_cast<WorkstationPtr>(r);
381 }
382
383 static XBT_INLINE void surf_storage_free(void *r)
384 {
385   delete static_cast<StoragePtr>(r);
386 }
387
388
389 void sg_version(int *ver_major,int *ver_minor,int *ver_patch) {
390   *ver_major = SIMGRID_VERSION_MAJOR;
391   *ver_minor = SIMGRID_VERSION_MINOR;
392   *ver_patch = SIMGRID_VERSION_PATCH;
393 }
394
395 void surf_init(int *argc, char **argv)
396 {
397   XBT_DEBUG("Create all Libs");
398   host_lib = xbt_lib_new();
399   link_lib = xbt_lib_new();
400   as_router_lib = xbt_lib_new();
401   storage_lib = xbt_lib_new();
402   storage_type_lib = xbt_lib_new();
403   file_lib = xbt_lib_new();
404   watched_hosts_lib = xbt_dict_new_homogeneous(NULL);
405
406   XBT_DEBUG("Add routing levels");
407   ROUTING_HOST_LEVEL = xbt_lib_add_level(host_lib,routing_asr_host_free);
408   ROUTING_ASR_LEVEL  = xbt_lib_add_level(as_router_lib,routing_asr_host_free);
409   ROUTING_PROP_ASR_LEVEL = xbt_lib_add_level(as_router_lib,routing_asr_prop_free);
410
411   XBT_DEBUG("Add SURF levels");
412   SURF_CPU_LEVEL = xbt_lib_add_level(host_lib,surf_cpu_free);
413   SURF_WKS_LEVEL = xbt_lib_add_level(host_lib,surf_workstation_free);
414   SURF_LINK_LEVEL = xbt_lib_add_level(link_lib,surf_link_free);
415   SURF_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,surf_storage_free);
416
417   xbt_init(argc, argv);
418   if (!model_list)
419     model_list = xbt_dynar_new(sizeof(ModelPtr), NULL);
420   if (!model_list_invoke)
421     model_list_invoke = xbt_dynar_new(sizeof(ModelPtr), NULL);
422   if (!history)
423     history = tmgr_history_new();
424
425 #ifdef HAVE_TRACING
426   TRACE_add_start_function(TRACE_surf_alloc);
427   TRACE_add_end_function(TRACE_surf_release);
428 #endif
429
430   sg_config_init(argc, argv);
431
432   if (MC_is_active())
433     MC_memory_init();
434 }
435
436 void surf_exit(void)
437 {
438   unsigned int iter;
439   ModelPtr model = NULL;
440
441 #ifdef HAVE_TRACING
442   TRACE_end();                  /* Just in case it was not called by the upper
443                                  * layer (or there is no upper layer) */
444 #endif
445
446   sg_config_finalize();
447
448   xbt_dynar_free(&host_that_restart);
449   xbt_dynar_free(&surf_path);
450
451   xbt_lib_free(&host_lib);
452   xbt_lib_free(&link_lib);
453   xbt_lib_free(&as_router_lib);
454   xbt_lib_free(&storage_lib);
455   xbt_lib_free(&storage_type_lib);
456   xbt_lib_free(&file_lib);
457   xbt_dict_free(&watched_hosts_lib);
458
459   xbt_dynar_foreach(model_list, iter, model)
460     delete model;
461   xbt_dynar_free(&model_list);
462   xbt_dynar_free(&model_list_invoke);
463   routing_exit();
464
465   surf_callback_emit(surfExitCallbacks);
466
467   if (maxmin_system) {
468     lmm_system_free(maxmin_system);
469     maxmin_system = NULL;
470   }
471   if (history) {
472     tmgr_history_free(history);
473     history = NULL;
474   }
475
476 #ifdef CONTEXT_THREADS
477   xbt_parmap_destroy(surf_parmap);
478 #endif
479
480   xbt_free(surf_mins);
481   surf_mins = NULL;
482
483   tmgr_finalize();
484   surf_parse_lex_destroy();
485   surf_parse_free_callbacks();
486
487   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
488 }
489
490 /*********
491  * Model *
492  *********/
493
494 Model::Model(const char *name)
495   : p_maxminSystem(NULL)
496   , p_name(name)
497 {
498   p_readyActionSet = new ActionList();
499   p_runningActionSet = new ActionList();
500   p_failedActionSet = new ActionList();
501   p_doneActionSet = new ActionList();
502
503   p_modifiedSet = NULL;
504   p_actionHeap = NULL;
505   p_updateMechanism = UM_UNDEFINED;
506   m_selectiveUpdate = 0;
507 }
508
509 Model::~Model(){
510   delete p_readyActionSet;
511   delete p_runningActionSet;
512   delete p_failedActionSet;
513   delete p_doneActionSet;
514 }
515
516 double Model::shareResources(double now)
517 {
518   //FIXME: set the good function once and for all
519   if (p_updateMechanism == UM_LAZY)
520     return shareResourcesLazy(now);
521   else if (p_updateMechanism == UM_FULL)
522     return shareResourcesFull(now);
523   else
524     xbt_die("Invalid cpu update mechanism!");
525 }
526
527 double Model::shareResourcesLazy(double now)
528 {
529   ActionPtr action = NULL;
530   double min = -1;
531   double share;
532
533   XBT_DEBUG
534       ("Before share resources, the size of modified actions set is %zd",
535        p_modifiedSet->size());
536
537   lmm_solve(p_maxminSystem);
538
539   XBT_DEBUG
540       ("After share resources, The size of modified actions set is %zd",
541        p_modifiedSet->size());
542
543   while(!p_modifiedSet->empty()) {
544     action = &(p_modifiedSet->front());
545     p_modifiedSet->pop_front();
546     int max_dur_flag = 0;
547
548     if (action->getStateSet() != p_runningActionSet)
549       continue;
550
551     /* bogus priority, skip it */
552     if (action->getPriority() <= 0 || action->getHat()==LATENCY)
553       continue;
554
555     action->updateRemainingLazy(now);
556
557     min = -1;
558     share = lmm_variable_getvalue(action->getVariable());
559
560     if (share > 0) {
561       double time_to_completion;
562       if (action->getRemains() > 0) {
563         time_to_completion = action->getRemainsNoUpdate() / share;
564       } else {
565         time_to_completion = 0.0;
566       }
567       min = now + time_to_completion; // when the task will complete if nothing changes
568     }
569
570     if ((action->getMaxDuration() != NO_MAX_DURATION)
571         && (min == -1
572             || action->getStartTime() +
573             action->getMaxDuration() < min)) {
574       min = action->getStartTime() +
575           action->getMaxDuration();  // when the task will complete anyway because of the deadline if any
576       max_dur_flag = 1;
577     }
578
579
580     XBT_DEBUG("Action(%p) corresponds to variable %d", action, action->getVariable()->id_int);
581
582     XBT_DEBUG("Action(%p) Start %f. May finish at %f (got a share of %f). Max_duration %f", action,
583         action->getStartTime(), min, share,
584         action->getMaxDuration());
585
586     if (min != -1) {
587       action->heapUpdate(p_actionHeap, min, max_dur_flag ? MAX_DURATION : NORMAL);
588       XBT_DEBUG("Insert at heap action(%p) min %f now %f", action, min,
589                 now);
590     } else DIE_IMPOSSIBLE;
591   }
592
593   //hereafter must have already the min value for this resource model
594   if (xbt_heap_size(p_actionHeap) > 0)
595     min = xbt_heap_maxkey(p_actionHeap) - now;
596   else
597     min = -1;
598
599   XBT_DEBUG("The minimum with the HEAP %f", min);
600
601   return min;
602 }
603
604 double Model::shareResourcesFull(double /*now*/) {
605   THROW_UNIMPLEMENTED;
606 }
607
608 double Model::shareResourcesMaxMin(ActionListPtr running_actions,
609                           lmm_system_t sys,
610                           void (*solve) (lmm_system_t))
611 {
612   ActionPtr action = NULL;
613   double min = -1;
614   double value = -1;
615
616   solve(sys);
617
618   ActionList::iterator it(running_actions->begin()), itend(running_actions->end());
619   for(; it != itend ; ++it) {
620     action = &*it;
621     value = lmm_variable_getvalue(action->getVariable());
622     if ((value > 0) || (action->getMaxDuration() >= 0))
623       break;
624   }
625
626   if (!action)
627     return -1.0;
628
629   if (value > 0) {
630     if (action->getRemains() > 0)
631       min = action->getRemainsNoUpdate() / value;
632     else
633       min = 0.0;
634     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min))
635       min = action->getMaxDuration();
636   } else
637     min = action->getMaxDuration();
638
639
640   for (++it; it != itend; ++it) {
641         action = &*it;
642     value = lmm_variable_getvalue(action->getVariable());
643     if (value > 0) {
644       if (action->getRemains() > 0)
645         value = action->getRemainsNoUpdate() / value;
646       else
647         value = 0.0;
648       if (value < min) {
649         min = value;
650         XBT_DEBUG("Updating min (value) with %p: %f", action, min);
651       }
652     }
653     if ((action->getMaxDuration() >= 0) && (action->getMaxDuration() < min)) {
654       min = action->getMaxDuration();
655       XBT_DEBUG("Updating min (duration) with %p: %f", action, min);
656     }
657   }
658   XBT_DEBUG("min value : %f", min);
659
660   return min;
661 }
662
663 void Model::updateActionsState(double now, double delta)
664 {
665   if (p_updateMechanism == UM_FULL)
666         updateActionsStateFull(now, delta);
667   else if (p_updateMechanism == UM_LAZY)
668         updateActionsStateLazy(now, delta);
669   else
670         xbt_die("Invalid cpu update mechanism!");
671 }
672
673 void Model::updateActionsStateLazy(double /*now*/, double /*delta*/)
674 {
675  THROW_UNIMPLEMENTED;
676 }
677
678 void Model::updateActionsStateFull(double /*now*/, double /*delta*/)
679 {
680   THROW_UNIMPLEMENTED;
681 }
682
683 /************
684  * Resource *
685  ************/
686
687 Resource::Resource()
688 : p_name(NULL), p_properties(NULL), p_model(NULL)
689 {}
690
691 Resource::Resource(ModelPtr model, const char *name, xbt_dict_t props)
692   : p_name(xbt_strdup(name)), p_properties(props), p_model(model)
693   , m_running(true), m_stateCurrent(SURF_RESOURCE_ON)
694 {}
695
696 Resource::Resource(ModelPtr model, const char *name, xbt_dict_t props, lmm_constraint_t constraint)
697   : p_name(xbt_strdup(name)), p_properties(props), p_model(model)
698   , m_running(true), m_stateCurrent(SURF_RESOURCE_ON), p_constraint(constraint)
699 {}
700
701 Resource::Resource(ModelPtr model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit)
702   : p_name(xbt_strdup(name)), p_properties(props), p_model(model)
703   , m_running(true), m_stateCurrent(stateInit)
704 {}
705
706 Resource::~Resource() {
707   xbt_free((void*)p_name);
708   xbt_dict_free(&p_properties);
709 }
710
711 e_surf_resource_state_t Resource::getState()
712 {
713   return m_stateCurrent;
714 }
715
716 void Resource::setState(e_surf_resource_state_t state)
717 {
718   m_stateCurrent = state;
719 }
720
721 bool Resource::isOn()
722 {
723   return m_running;
724 }
725
726 void Resource::turnOn()
727 {
728   if (!m_running) {
729     m_running = true;
730   }
731 }
732
733 void Resource::turnOff()
734 {
735   if (m_running) {
736     m_running = false;
737   }
738 }
739
740 ModelPtr Resource::getModel() {
741   return p_model;
742 }
743
744 const char *Resource::getName() {
745   return p_name;
746 }
747
748 xbt_dict_t Resource::getProperties() {
749   if (p_properties==NULL)
750     p_properties = xbt_dict_new();
751   return p_properties;
752 }
753
754 lmm_constraint_t Resource::getConstraint() {
755   return p_constraint;
756 }
757
758 /**********
759  * Action *
760  **********/
761
762 const char *surf_action_state_names[6] = {
763   "SURF_ACTION_READY",
764   "SURF_ACTION_RUNNING",
765   "SURF_ACTION_FAILED",
766   "SURF_ACTION_DONE",
767   "SURF_ACTION_TO_FREE",
768   "SURF_ACTION_NOT_IN_THE_SYSTEM"
769 };
770
771 void Action::initialize(ModelPtr model, double cost, bool failed,
772                         lmm_variable_t var)
773 {
774   m_priority = 1.0;
775   m_refcount = 1;
776   m_remains = cost;
777   m_maxDuration = NO_MAX_DURATION;
778   m_finish = -1.0;
779   m_failed = failed;
780   m_start = surf_get_clock();
781   m_cost = cost;
782   p_model = model;
783   p_data = NULL;
784   p_variable = var;
785   m_lastValue = 0;
786   m_lastUpdate = 0;
787   m_suspended = false;
788   m_hat = NOTSET;
789 }
790
791 Action::Action(ModelPtr model, double cost, bool failed)
792 {
793   initialize(model, cost, failed);
794   #ifdef HAVE_TRACING
795     p_category = NULL;
796   #endif
797   p_stateHookup.prev = 0;
798   p_stateHookup.next = 0;
799   if (failed)
800     p_stateSet = getModel()->getFailedActionSet();
801   else
802     p_stateSet = getModel()->getRunningActionSet();
803
804   p_stateSet->push_back(*this);
805 }
806
807 Action::Action(ModelPtr model, double cost, bool failed, lmm_variable_t var)
808 {
809   initialize(model, cost, failed, var);
810   #ifdef HAVE_TRACING
811     p_category = NULL;
812   #endif
813   p_stateHookup.prev = 0;
814   p_stateHookup.next = 0;
815   if (failed)
816     p_stateSet = getModel()->getFailedActionSet();
817   else
818     p_stateSet = getModel()->getRunningActionSet();
819
820   p_stateSet->push_back(*this);
821 }
822
823 Action::~Action() {
824 #ifdef HAVE_TRACING
825   xbt_free(p_category);
826 #endif
827 }
828
829 void Action::finish() {
830     m_finish = surf_get_clock();
831 }
832
833 e_surf_action_state_t Action::getState()
834 {
835   if (p_stateSet ==  getModel()->getReadyActionSet())
836     return SURF_ACTION_READY;
837   if (p_stateSet ==  getModel()->getRunningActionSet())
838     return SURF_ACTION_RUNNING;
839   if (p_stateSet ==  getModel()->getFailedActionSet())
840     return SURF_ACTION_FAILED;
841   if (p_stateSet ==  getModel()->getDoneActionSet())
842     return SURF_ACTION_DONE;
843   return SURF_ACTION_NOT_IN_THE_SYSTEM;
844 }
845
846 void Action::setState(e_surf_action_state_t state)
847 {
848   //surf_action_state_t action_state = &(action->model_type->states);
849   XBT_IN("(%p,%s)", this, surf_action_state_names[state]);
850   p_stateSet->erase(p_stateSet->iterator_to(*this));
851   if (state == SURF_ACTION_READY)
852     p_stateSet = getModel()->getReadyActionSet();
853   else if (state == SURF_ACTION_RUNNING)
854     p_stateSet = getModel()->getRunningActionSet();
855   else if (state == SURF_ACTION_FAILED)
856     p_stateSet = getModel()->getFailedActionSet();
857   else if (state == SURF_ACTION_DONE)
858     p_stateSet = getModel()->getDoneActionSet();
859   else
860     p_stateSet = NULL;
861
862   if (p_stateSet)
863     p_stateSet->push_back(*this);
864   XBT_OUT();
865 }
866
867 double Action::getBound()
868 {
869   return (p_variable) ? lmm_variable_getbound(p_variable) : 0;
870 }
871
872 void Action::setBound(double bound)
873 {
874   XBT_IN("(%p,%g)", this, bound);
875   if (p_variable)
876     lmm_update_variable_bound(getModel()->getMaxminSystem(), p_variable, bound);
877
878   if (getModel()->getUpdateMechanism() == UM_LAZY && getLastUpdate()!=surf_get_clock())
879     heapRemove(getModel()->getActionHeap());
880   XBT_OUT();
881 }
882
883 double Action::getStartTime()
884 {
885   return m_start;
886 }
887
888 double Action::getFinishTime()
889 {
890   /* keep the function behavior, some models (cpu_ti) change the finish time before the action end */
891   return m_remains == 0 ? m_finish : -1;
892 }
893
894 void Action::setData(void* data)
895 {
896   p_data = data;
897 }
898
899 #ifdef HAVE_TRACING
900 void Action::setCategory(const char *category)
901 {
902   XBT_IN("(%p,%s)", this, category);
903   p_category = xbt_strdup(category);
904   XBT_OUT();
905 }
906 #endif
907
908 void Action::ref(){
909   m_refcount++;
910 }
911
912 void Action::setMaxDuration(double duration)
913 {
914   XBT_IN("(%p,%g)", this, duration);
915   m_maxDuration = duration;
916   if (getModel()->getUpdateMechanism() == UM_LAZY)      // remove action from the heap
917     heapRemove(getModel()->getActionHeap());
918   XBT_OUT();
919 }
920
921 void Action::gapRemove() {}
922
923 void Action::setPriority(double priority)
924 {
925   XBT_IN("(%p,%g)", this, priority);
926   m_priority = priority;
927   lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), priority);
928
929   if (getModel()->getUpdateMechanism() == UM_LAZY)
930         heapRemove(getModel()->getActionHeap());
931   XBT_OUT();
932 }
933
934 void Action::cancel(){
935   setState(SURF_ACTION_FAILED);
936   if (getModel()->getUpdateMechanism() == UM_LAZY) {
937     if (actionLmmHook::is_linked())
938       getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
939     heapRemove(getModel()->getActionHeap());
940   }
941 }
942
943 int Action::unref(){
944   m_refcount--;
945   if (!m_refcount) {
946     if (actionHook::is_linked())
947       p_stateSet->erase(p_stateSet->iterator_to(*this));
948     if (getVariable())
949       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
950     if (getModel()->getUpdateMechanism() == UM_LAZY) {
951       /* remove from heap */
952       heapRemove(getModel()->getActionHeap());
953       if (actionLmmHook::is_linked())
954         getModel()->getModifiedSet()->erase(getModel()->getModifiedSet()->iterator_to(*this));
955     }
956     delete this;
957     return 1;
958   }
959   return 0;
960 }
961
962 void Action::suspend()
963 {
964   XBT_IN("(%p)", this);
965   if (m_suspended != 2) {
966     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
967     m_suspended = 1;
968     if (getModel()->getUpdateMechanism() == UM_LAZY)
969       heapRemove(getModel()->getActionHeap());
970   }
971   XBT_OUT();
972 }
973
974 void Action::resume()
975 {
976   XBT_IN("(%p)", this);
977   if (m_suspended != 2) {
978     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), m_priority);
979     m_suspended = 0;
980     if (getModel()->getUpdateMechanism() == UM_LAZY)
981       heapRemove(getModel()->getActionHeap());
982   }
983   XBT_OUT();
984 }
985
986 bool Action::isSuspended()
987 {
988   return m_suspended == 1;
989 }
990 /* insert action on heap using a given key and a hat (heap_action_type)
991  * a hat can be of three types for communications:
992  *
993  * NORMAL = this is a normal heap entry stating the date to finish transmitting
994  * LATENCY = this is a heap entry to warn us when the latency is payed
995  * MAX_DURATION =this is a heap entry to warn us when the max_duration limit is reached
996  */
997 void Action::heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat)
998 {
999   m_hat = hat;
1000   xbt_heap_push(heap, this, key);
1001 }
1002
1003 void Action::heapRemove(xbt_heap_t heap)
1004 {
1005   m_hat = NOTSET;
1006   if (m_indexHeap >= 0) {
1007     xbt_heap_remove(heap, m_indexHeap);
1008   }
1009 }
1010
1011 void Action::heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat)
1012 {
1013   m_hat = hat;
1014   if (m_indexHeap >= 0) {
1015     xbt_heap_update(heap, m_indexHeap, key);
1016   }else{
1017     xbt_heap_push(heap, this, key);
1018   }
1019 }
1020
1021 /* added to manage the communication action's heap */
1022 void surf_action_lmm_update_index_heap(void *action, int i) {
1023   ((ActionPtr)action)->updateIndexHeap(i);
1024 }
1025
1026 void Action::updateIndexHeap(int i) {
1027   m_indexHeap = i;
1028 }
1029
1030 double Action::getRemains()
1031 {
1032   XBT_IN("(%p)", this);
1033   /* update remains before return it */
1034   if (getModel()->getUpdateMechanism() == UM_LAZY)      /* update remains before return it */
1035     updateRemainingLazy(surf_get_clock());
1036   XBT_OUT();
1037   return m_remains;
1038 }
1039
1040 double Action::getRemainsNoUpdate()
1041 {
1042   return m_remains;
1043 }
1044
1045 //FIXME split code in the right places
1046 void Action::updateRemainingLazy(double now)
1047 {
1048   double delta = 0.0;
1049
1050   if(getModel() == surf_network_model)
1051   {
1052     if (m_suspended != 0)
1053       return;
1054   }
1055   else
1056   {
1057     xbt_assert(p_stateSet == getModel()->getRunningActionSet(),
1058         "You're updating an action that is not running.");
1059
1060       /* bogus priority, skip it */
1061     xbt_assert(m_priority > 0,
1062         "You're updating an action that seems suspended.");
1063   }
1064
1065   delta = now - m_lastUpdate;
1066
1067   if (m_remains > 0) {
1068     XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
1069     double_update(&m_remains, m_lastValue * delta, sg_surf_precision*sg_maxmin_precision);
1070
1071 #ifdef HAVE_TRACING
1072     if (getModel() == surf_cpu_model_pm && TRACE_is_enabled()) {
1073       ResourcePtr cpu = static_cast<ResourcePtr>(lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
1074       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), m_lastValue, m_lastUpdate, now - m_lastUpdate);
1075     }
1076 #endif
1077     XBT_DEBUG("Updating action(%p): remains is now %f", this, m_remains);
1078   }
1079
1080   if(getModel() == surf_network_model)
1081   {
1082     if (m_maxDuration != NO_MAX_DURATION)
1083       double_update(&m_maxDuration, delta, sg_surf_precision);
1084
1085     //FIXME: duplicated code
1086     if ((m_remains <= 0) &&
1087         (lmm_get_variable_weight(getVariable()) > 0)) {
1088       finish();
1089       setState(SURF_ACTION_DONE);
1090       heapRemove(getModel()->getActionHeap());
1091     } else if (((m_maxDuration != NO_MAX_DURATION)
1092         && (m_maxDuration <= 0))) {
1093       finish();
1094       setState(SURF_ACTION_DONE);
1095       heapRemove(getModel()->getActionHeap());
1096     }
1097   }
1098
1099   m_lastUpdate = now;
1100   m_lastValue = lmm_variable_getvalue(getVariable());
1101 }