Logo AND Algorithmique Numérique Distribuée

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