Logo AND Algorithmique Numérique Distribuée

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