Logo AND Algorithmique Numérique Distribuée

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