Logo AND Algorithmique Numérique Distribuée

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